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 * as _ from "lodash";
   6 import { CommonResourceService } from '~/services/common-service/common-resource-service';
   7 import { ListResults, ListArguments } from '~/services/common-service/common-service';
   8 import { AxiosInstance, AxiosRequestConfig } from "axios";
   9 import { CollectionResource } from "~/models/collection";
  10 import { ProjectResource } from "~/models/project";
  11 import { ProcessResource } from "~/models/process";
  12 import { ResourceKind } from '~/models/resource';
  13 import { TrashableResourceService } from "~/services/common-service/trashable-resource-service";
  14 import { ApiActions } from "~/services/api/api-actions";
  15 import { GroupResource } from "~/models/group";
  16 import { Session } from "~/models/session";
  17
  18 export interface ContentsArguments {
  19     limit?: number;
  20     offset?: number;
  21     order?: string;
  22     filters?: string;
  23     recursive?: boolean;
  24     includeTrash?: boolean;
  25     excludeHomeProject?: boolean;
  26 }
  27
  28 export interface SharedArguments extends ListArguments {
  29     include?: string;
  30 }
  31
  32 export type GroupContentsResource =
  33     CollectionResource |
  34     ProjectResource |
  35     ProcessResource;
  36
  37 export class GroupsService<T extends GroupResource = GroupResource> extends TrashableResourceService<T> {
  38
  39     constructor(serverApi: AxiosInstance, actions: ApiActions) {
  40         super(serverApi, "groups", actions);
  41     }
  42
  43     async contents(uuid: string, args: ContentsArguments = {}, session?: Session): Promise<ListResults<GroupContentsResource>> {
  44         const { filters, order, ...other } = args;
  45         const params = {
  46             ...other,
  47             filters: filters ? `[${filters}]` : undefined,
  48             order: order ? order : undefined
  49         };
  50
  51         const pathUrl = uuid ? `${uuid}/contents` : 'contents';
  52
  53         const cfg: AxiosRequestConfig = { params: CommonResourceService.mapKeys(_.snakeCase)(params) };
  54         if (session) {
  55             cfg.baseURL = session.baseUrl;
  56         }
  57
  58         const response = await CommonResourceService.defaultResponse(
  59             this.serverApi.get(this.resourceType + pathUrl, cfg), this.actions, false
  60         );
  61
  62         return { ...TrashableResourceService.mapKeys(_.camelCase)(response), clusterId: session && session.clusterId };
  63     }
  64
  65     shared(params: SharedArguments = {}): Promise<ListResults<GroupContentsResource>> {
  66         return CommonResourceService.defaultResponse(
  67             this.serverApi
  68                 .get(this.resourceType + 'shared', { params }),
  69             this.actions
  70         );
  71     }
  72 }
  73
  74 export enum GroupContentsResourcePrefix {
  75     COLLECTION = "collections",
  76     PROJECT = "groups",
  77     PROCESS = "container_requests"
  78 }