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