src/models/resource.ts

   1 // Copyright (C) The Arvados Authors. All rights reserved.
   2 //
   3 // SPDX-License-Identifier: AGPL-3.0
   4
   5 export interface Resource {
   6     uuid: string;
   7     ownerUuid: string;
   8     createdAt: string;
   9     modifiedByClientUuid: string;
  10     modifiedByUserUuid: string;
  11     modifiedAt: string;
  12     href: string;
  13     kind: ResourceKind;
  14     etag: string;
  15 }
  16
  17 export interface TrashableResource extends Resource {
  18     trashAt: string;
  19     deleteAt: string;
  20     isTrashed: boolean;
  21 }
  22
  23 export enum ResourceKind {
  24     API_CLIENT_AUTHORIZATION = "arvados#apiClientAuthorization",
  25     COLLECTION = "arvados#collection",
  26     CONTAINER = "arvados#container",
  27     CONTAINER_REQUEST = "arvados#containerRequest",
  28     GROUP = "arvados#group",
  29     LINK = "arvados#link",
  30     LOG = "arvados#log",
  31     NODE = "arvados#node",
  32     PROCESS = "arvados#containerRequest",
  33     PROJECT = "arvados#group",
  34     REPOSITORY = "arvados#repository",
  35     SSH_KEY = "arvados#authorizedKeys",
  36     KEEP_SERVICE = "arvados#keepService",
  37     USER = "arvados#user",
  38     VIRTUAL_MACHINE = "arvados#virtualMachine",
  39     WORKFLOW = "arvados#workflow",
  40     NONE = "arvados#none"
  41 }
  42
  43 export enum ResourceObjectType {
  44     API_CLIENT_AUTHORIZATION = 'gj3su',
  45     COLLECTION = '4zz18',
  46     CONTAINER = 'dz642',
  47     CONTAINER_REQUEST = 'xvhdp',
  48     GROUP = 'j7d0g',
  49     LINK = 'o0j2j',
  50     LOG = '57u5n',
  51     REPOSITORY = 's0uqq',
  52     USER = 'tpzed',
  53     VIRTUAL_MACHINE = '2x53u',
  54     WORKFLOW = '7fd4e',
  55     SSH_KEY = 'fngyi',
  56     KEEP_SERVICE = 'bi6l4',
  57     NODE = '7ekkf'
  58 }
  59
  60 export const RESOURCE_UUID_PATTERN = '[a-z0-9]{5}-[a-z0-9]{5}-[a-z0-9]{15}';
  61 export const RESOURCE_UUID_REGEX = new RegExp("^" + RESOURCE_UUID_PATTERN + "$");
  62 export const COLLECTION_PDH_REGEX = /^[a-f0-9]{32}\+\d+$/;
  63
  64 export const isResourceUuid = (uuid: string) =>
  65     RESOURCE_UUID_REGEX.test(uuid);
  66
  67 export const extractUuidObjectType = (uuid: string) => {
  68     const match = RESOURCE_UUID_REGEX.exec(uuid);
  69     return match
  70         ? match[0].split('-')[1]
  71         : undefined;
  72 };
  73
  74 export const extractUuidKind = (uuid: string = '') => {
  75     const objectType = extractUuidObjectType(uuid);
  76     switch (objectType) {
  77         case ResourceObjectType.USER:
  78             return ResourceKind.USER;
  79         case ResourceObjectType.GROUP:
  80             return ResourceKind.GROUP;
  81         case ResourceObjectType.COLLECTION:
  82             return ResourceKind.COLLECTION;
  83         case ResourceObjectType.CONTAINER_REQUEST:
  84             return ResourceKind.CONTAINER_REQUEST;
  85         case ResourceObjectType.CONTAINER:
  86             return ResourceKind.CONTAINER;
  87         case ResourceObjectType.LOG:
  88             return ResourceKind.LOG;
  89         case ResourceObjectType.WORKFLOW:
  90             return ResourceKind.WORKFLOW;
  91         case ResourceObjectType.VIRTUAL_MACHINE:
  92             return ResourceKind.VIRTUAL_MACHINE;
  93         case ResourceObjectType.REPOSITORY:
  94             return ResourceKind.REPOSITORY;
  95         case ResourceObjectType.SSH_KEY:
  96             return ResourceKind.SSH_KEY;
  97         case ResourceObjectType.KEEP_SERVICE:
  98             return ResourceKind.KEEP_SERVICE;
  99         case ResourceObjectType.NODE:
 100             return ResourceKind.NODE;
 101         case ResourceObjectType.API_CLIENT_AUTHORIZATION:
 102             return ResourceKind.API_CLIENT_AUTHORIZATION;
 103         case ResourceObjectType.LINK:
 104             return ResourceKind.LINK;
 105         default:
 106             const match = COLLECTION_PDH_REGEX.exec(uuid);
 107             return match ? ResourceKind.COLLECTION : undefined;
 108     }
 109 };