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