src/services/groups-service/groups-service.ts

   1 // Copyright (C) The Arvados Authors. All rights reserved.
   2 //
   3 // SPDX-License-Identifier: AGPL-3.0
   4
   5 import { CancelToken } from 'axios';
   6 import { snakeCase, camelCase } from "lodash";
   7 import { CommonResourceService } from 'services/common-service/common-resource-service';
   8 import {
   9   ListResults,
  10   ListArguments,
  11 } from 'services/common-service/common-service';
  12 import { AxiosInstance, AxiosRequestConfig } from 'axios';
  13 import { CollectionResource } from 'models/collection';
  14 import { ProjectResource } from 'models/project';
  15 import { ProcessResource } from 'models/process';
  16 import { WorkflowResource } from 'models/workflow';
  17 import { TrashableResourceService } from 'services/common-service/trashable-resource-service';
  18 import { ApiActions } from 'services/api/api-actions';
  19 import { GroupResource } from 'models/group';
  20 import { Session } from 'models/session';
  21
  22 export interface ContentsArguments {
  23   limit?: number;
  24   offset?: number;
  25   order?: string;
  26   filters?: string;
  27   recursive?: boolean;
  28   includeTrash?: boolean;
  29   excludeHomeProject?: boolean;
  30 }
  31
  32 export interface SharedArguments extends ListArguments {
  33   include?: string;
  34 }
  35
  36 export type GroupContentsResource =
  37   | CollectionResource
  38   | ProjectResource
  39   | ProcessResource
  40   | WorkflowResource;
  41
  42 export class GroupsService<
  43   T extends GroupResource = GroupResource
  44 > extends TrashableResourceService<T> {
  45   constructor(serverApi: AxiosInstance, actions: ApiActions) {
  46     super(serverApi, 'groups', actions);
  47   }
  48
  49 async contents(uuid: string, args: ContentsArguments = {}, session?: Session, cancelToken?: CancelToken): Promise<ListResults<GroupContentsResource>> {
  50     const { filters, order, ...other } = args;
  51     const params = {
  52         ...other,
  53         filters: filters ? `[${filters}]` : undefined,
  54         order: order ? order : undefined
  55     };
  56     const pathUrl = uuid ? `/${uuid}/contents` : '/contents';
  57     const cfg: AxiosRequestConfig = {
  58       params: CommonResourceService.mapKeys(snakeCase)(params),
  59     };
  60
  61     if (session) {
  62       cfg.baseURL = session.baseUrl;
  63       cfg.headers = { Authorization: 'Bearer ' + session.token };
  64     }
  65
  66     if (cancelToken) {
  67       cfg.cancelToken = cancelToken;
  68     }
  69
  70     const response = await CommonResourceService.defaultResponse(
  71       this.serverApi.get(this.resourceType + pathUrl, cfg),
  72       this.actions,
  73       false
  74     );
  75
  76     return {
  77       ...TrashableResourceService.mapKeys(camelCase)(response),
  78       clusterId: session && session.clusterId,
  79     };
  80   }
  81
  82   shared(
  83     params: SharedArguments = {}
  84   ): Promise<ListResults<GroupContentsResource>> {
  85     return CommonResourceService.defaultResponse(
  86       this.serverApi.get(this.resourceType + '/shared', { params }),
  87       this.actions
  88     );
  89   }
  90 }
  91
  92 export enum GroupContentsResourcePrefix {
  93   COLLECTION = 'collections',
  94   PROJECT = 'groups',
  95   PROCESS = 'container_requests',
  96   WORKFLOW = 'workflows',
  97 }