feat(Search): Add index roles CRUD

src/services/search/__tests__/__snapshots__/index.spec.ts.snap

@@ -20,6 +20,41 @@ exports[`search – index create 1`] = `
 }
 `;
 
+exports[`search – index create role 1`] = `
+{
+  "headers": {
+    "accept": "*/*",
+    "accept-encoding": "gzip,deflate",
+    "connection": "close",
+    "content-length": "82",
+    "content-type": "application/json",
+    "host": "search.api.globus.org",
+    "user-agent": "node-fetch/1.0 (+https://github.com/bitinn/node-fetch)",
+  },
+  "json": {
+    "principal": "some-principal-urn",
+    "principal_type": "identity",
+    "role_name": "admin",
+  },
+  "method": "POST",
+  "url": "https://search.api.globus.org/v1/index/some-uuid/role",
+}
+`;
+
+exports[`search – index delete role 1`] = `
+{
+  "headers": {
+    "accept": "*/*",
+    "accept-encoding": "gzip,deflate",
+    "connection": "close",
+    "host": "search.api.globus.org",
+    "user-agent": "node-fetch/1.0 (+https://github.com/bitinn/node-fetch)",
+  },
+  "method": "DELETE",
+  "url": "https://search.api.globus.org/v1/index/some-uuid/role/some-role-id",
+}
+`;
+
 exports[`search – index get 1`] = `
 {
   "headers": {
@@ -34,6 +69,20 @@ exports[`search – index get 1`] = `
 }
 `;
 
+exports[`search – index get roles 1`] = `
+{
+  "headers": {
+    "accept": "*/*",
+    "accept-encoding": "gzip,deflate",
+    "connection": "close",
+    "host": "search.api.globus.org",
+    "user-agent": "node-fetch/1.0 (+https://github.com/bitinn/node-fetch)",
+  },
+  "method": "GET",
+  "url": "https://search.api.globus.org/v1/index/some-uuid/role_list",
+}
+`;
+
 exports[`search – index getAll 1`] = `
 {
   "headers": {

src/services/search/__tests__/index.spec.ts

@@ -87,4 +87,48 @@ describe('search – index', () => {
       headers,
     }).toMatchSnapshot();
   });
+
+  test('get roles', async () => {
+    const request = await index.roles.getAll('some-uuid');
+    const {
+      req: { url, method, headers },
+    } = await mirror(request);
+    expect({
+      url,
+      method,
+      headers,
+    }).toMatchSnapshot();
+  });
+
+  test('create role', async () => {
+    const request = await index.roles.create('some-uuid', {
+      payload: {
+        role_name: 'admin',
+        principal: 'some-principal-urn',
+        principal_type: 'identity',
+      },
+    });
+
+    const {
+      req: { url, method, headers, json },
+    } = await mirror(request);
+    expect({
+      url,
+      method,
+      headers,
+      json,
+    }).toMatchSnapshot();
+  });
+
+  test('delete role', async () => {
+    const request = await index.roles.remove({ index_id: 'some-uuid', role_id: 'some-role-id' });
+    const {
+      req: { url, method, headers },
+    } = await mirror(request);
+    expect({
+      url,
+      method,
+      headers,
+    }).toMatchSnapshot();
+  });
 });

src/services/search/service/roles.ts

@@ -0,0 +1,111 @@
+import { HTTP_METHODS, serviceRequest } from '../../shared.js';
+import { ID, SCOPES } from '../config.js';
+
+import type { JSONFetchResponse, ServiceMethodDynamicSegments } from '../../types.js';
+
+/**
+ * Search Index Role document
+ *
+ * @see https://docs.globus.org/api/search/reference/role_list/#role
+ */
+export type IndexRole = {
+  id: string;
+  creation_date: string;
+  role_name: string;
+  index_id: string;
+  principal: string;
+  principal_type: string;
+};
+
+/**
+ * Search Index Role List document
+ *
+ * @see https://docs.globus.org/api/search/reference/role_list/#rolelist
+ */
+export type IndexRoleListResponse = {
+  role_list: IndexRole[];
+};
+
+/**
+ * Get role list for a search index as owner or admin only
+ *
+ * @see https://docs.globus.org/api/search/reference/role_list/
+ */
+export const getAll = function (
+  index_id,
+  options?,
+  sdkOptions?,
+): Promise<JSONFetchResponse<IndexRoleListResponse>> {
+  return serviceRequest(
+    {
+      service: ID,
+      scope: SCOPES.ALL,
+      path: `/v1/index/${index_id}/role_list`,
+    },
+    options,
+    sdkOptions,
+  );
+} satisfies ServiceMethodDynamicSegments<string, {}>;
+
+export type SearchIndexRoleCreate = Pick<IndexRole, 'role_name' | 'principal' | 'principal_type'>;
+
+/**
+ * Create a new role for a search index as owner or admin only
+ *
+ * @see https://docs.globus.org/api/search/reference/role_create/
+ */
+export const create = function (
+  index_id,
+  options,
+  sdkOptions?,
+): Promise<JSONFetchResponse<IndexRole>> {
+  return serviceRequest(
+    {
+      service: ID,
+      scope: SCOPES.ALL,
+      path: `/v1/index/${index_id}/role`,
+      method: HTTP_METHODS.POST,
+    },
+    options,
+    sdkOptions,
+  );
+} satisfies ServiceMethodDynamicSegments<
+  string,
+  {
+    payload: SearchIndexRoleCreate;
+  },
+  JSONFetchResponse<IndexRole>
+>;
+
+export type SearchIndexRoleDeleted = {
+  success: true;
+  deleted: IndexRole;
+};
+
+/**
+ * Delete a role for a search index as owner or admin only
+ *
+ * @see https://docs.globus.org/api/search/reference/role_delete/
+ */
+export const remove = function (
+  { index_id, role_id },
+  options?,
+  sdkOptions?,
+): Promise<JSONFetchResponse<SearchIndexRoleDeleted>> {
+  return serviceRequest(
+    {
+      service: ID,
+      scope: SCOPES.ALL,
+      path: `/v1/index/${index_id}/role/${role_id}`,
+      method: HTTP_METHODS.DELETE,
+    },
+    options,
+    sdkOptions,
+  );
+} satisfies ServiceMethodDynamicSegments<
+  { index_id: string; role_id: string },
+  {
+    query?: never;
+    payload?: never;
+  }
+>;

src/services/search/service/search-index.ts

@@ -7,6 +7,8 @@ import type {
   ServiceMethodDynamicSegments,
 } from '../../types.js';
 
+export * as roles from './roles.js';
+
 /**
  * @see https://docs.globus.org/api/search/reference/index_list/#indexwithpermissions
  */