@globus/sdk 0.7.2 → 1.0.0-alpha

package/src/lib/services/globus-connect-server/__tests__/storage-gateways.spec.ts

@@ -0,0 +1,72 @@
+import { createStorage } from "../../../core/storage";
+import { storageGateways } from "..";
+
+import type { MirroredRequest } from "../../../../../mocks/handlers";
+
+const GCS_HOST = "https://fa5e.bd7c.data.globus.org";
+
+describe("gcs – storageGateways", () => {
+  createStorage("memory");
+
+  test("getAll", async () => {
+    const result = await storageGateways.getAll(
+      {
+        host: GCS_HOST,
+        endpoint_id: "ac9cb54b-fc48-4824-b801-1388baf0a909",
+      },
+      {
+        query: { include: ["accounts", "private_policies"] },
+      }
+    );
+    const {
+      req: { url, method, headers },
+    } = (await result.json()) as unknown as MirroredRequest;
+    expect({
+      url,
+      method,
+      headers,
+    }).toMatchInlineSnapshot(`
+      {
+        "headers": {
+          "accept": "*/*",
+          "accept-encoding": "gzip,deflate",
+          "connection": "close",
+          "host": "fa5e.bd7c.data.globus.org",
+          "user-agent": "node-fetch/1.0 (+https://github.com/bitinn/node-fetch)",
+        },
+        "method": "GET",
+        "url": "https://fa5e.bd7c.data.globus.org/api/storage_gateways?include=accounts%2Cprivate_policies",
+      }
+    `);
+  });
+
+  test("get", async () => {
+    const result = await storageGateways.get(
+      {
+        host: GCS_HOST,
+        endpoint_id: "ac9cb54b-fc48-4824-b801-1388baf0a909",
+      },
+      "some-uuid"
+    );
+    const {
+      req: { url, method, headers },
+    } = (await result.json()) as unknown as MirroredRequest;
+    expect({
+      url,
+      method,
+      headers,
+    }).toMatchInlineSnapshot(`
+      {
+        "headers": {
+          "accept": "*/*",
+          "accept-encoding": "gzip,deflate",
+          "connection": "close",
+          "host": "fa5e.bd7c.data.globus.org",
+          "user-agent": "node-fetch/1.0 (+https://github.com/bitinn/node-fetch)",
+        },
+        "method": "GET",
+        "url": "https://fa5e.bd7c.data.globus.org/api/storage_gateways/some-uuid",
+      }
+    `);
+  });
+});

package/src/lib/services/globus-connect-server/__tests__/user-credentials.spec.ts

@@ -0,0 +1,74 @@
+import { createStorage } from "../../../core/storage";
+import { userCredentials } from "..";
+
+import type { MirroredRequest } from "../../../../../mocks/handlers";
+
+const GCS_HOST = "https://fa5e.bd7c.data.globus.org";
+
+describe("gcs – user-credentials", () => {
+  createStorage("memory");
+
+  test("getAll", async () => {
+    const result = await userCredentials.getAll(
+      {
+        host: GCS_HOST,
+        endpoint_id: "ac9cb54b-fc48-4824-b801-1388baf0a909",
+      },
+      {
+        query: {
+          include: ["all"],
+        },
+      }
+    );
+    const {
+      req: { url, method, headers },
+    } = (await result.json()) as unknown as MirroredRequest;
+    expect({
+      url,
+      method,
+      headers,
+    }).toMatchInlineSnapshot(`
+      {
+        "headers": {
+          "accept": "*/*",
+          "accept-encoding": "gzip,deflate",
+          "connection": "close",
+          "host": "fa5e.bd7c.data.globus.org",
+          "user-agent": "node-fetch/1.0 (+https://github.com/bitinn/node-fetch)",
+        },
+        "method": "GET",
+        "url": "https://fa5e.bd7c.data.globus.org/api/user_credentials?include=all",
+      }
+    `);
+  });
+
+  test("get", async () => {
+    const result = await userCredentials.get(
+      {
+        host: GCS_HOST,
+        endpoint_id: "ac9cb54b-fc48-4824-b801-1388baf0a909",
+      },
+      "some-uuid"
+    );
+    const {
+      req: { url, method, headers },
+    } = (await result.json()) as unknown as MirroredRequest;
+    expect({
+      url,
+      method,
+      headers,
+    }).toMatchInlineSnapshot(`
+      {
+        "headers": {
+          "accept": "*/*",
+          "accept-encoding": "gzip,deflate",
+          "connection": "close",
+          "host": "fa5e.bd7c.data.globus.org",
+          "user-agent": "node-fetch/1.0 (+https://github.com/bitinn/node-fetch)",
+        },
+        "method": "GET",
+        "url": "https://fa5e.bd7c.data.globus.org/api/user_credentials/some-uuid",
+      }
+    `);
+  });
+});

package/src/lib/services/globus-connect-server/client.ts

@@ -0,0 +1,79 @@
+/**
+ * @module Client - Globus Connect Server Manager API
+ * @category Client
+ * @description A wrapper around the Globus Connect Server Manager API that binds various Globus Connect Server resources
+ * to a single configuration object (GCSConfiguration).
+ *
+ * @example
+ * import { getClient } from "@globus/sdk/lib/services/globus-connect-server/client";
+ *
+ * const client = getClient({
+ *   host: "https://fa5e.bd7c.data.globus.org",
+ *   endpoint_id: "ac9cb54b-fc48-4824-b801-1388baf0a909",
+ * });
+ *
+ * const result = await client.endpoint.get();
+ */
+import { type GCSConfiguration } from ".";
+
+import * as collections from "./service/collections";
+import * as endpoint from "./service/endpoint";
+import * as roles from "./service/roles";
+import * as storageGateways from "./service/storage-gateways";
+import * as userCredentials from "./service/user-credentials";
+import * as versioning from "./service/versioning";
+
+type TailOfTuple<T extends unknown[], Head extends unknown[]> = T extends [
+  ...Head,
+  ...infer Tail
+]
+  ? Tail
+  : never;
+
+/**
+ * Bind arguments to a method (partial application).
+ * @param method The method arguments will be bound to.
+ * @param bound The arguments to bind to the method.
+ */
+function bind<M extends (...args: any[]) => ReturnType<M>, Args extends any[]>(
+  method: M,
+  ...bound: Args
+) {
+  return function (...args: TailOfTuple<Parameters<M>, Args>) {
+    return method(...bound, ...args);
+  };
+}
+
+/**
+ * Create a Globus Connect Server Manager client. This client is used to
+ * create a SDK context that is bound to a specific Globus Connect Server.
+ */
+export function getClient(configuration: GCSConfiguration) {
+  return {
+    configuration,
+    endpoint: {
+      get: bind(endpoint.get, configuration),
+    },
+    versioning: {
+      info: bind(versioning.info, configuration),
+    },
+    collections: {
+      get: bind(collections.get, configuration),
+      getAll: bind(collections.getAll, configuration),
+    },
+    userCredentials: {
+      get: bind(userCredentials.get, configuration),
+      getAll: bind(userCredentials.getAll, configuration),
+    },
+    storageGateways: {
+      get: bind(storageGateways.get, configuration),
+      getAll: bind(storageGateways.getAll, configuration),
+    },
+    roles: {
+      get: bind(roles.get, configuration),
+      getAll: bind(roles.getAll, configuration),
+      create: bind(roles.create, configuration),
+      remove: bind(roles.remove, configuration),
+    },
+  };
+}

package/src/lib/services/globus-connect-server/index.ts

@@ -0,0 +1,85 @@
+/**
+ * @description A wrapper around the Globus Connect Server Manager API.
+ * @group Service
+ * @see [Globus Connect Server Manager API Documentation](https://docs.globus.org/globus-connect-server/v5.4/api/)
+ * @module
+ */
+
+import type {
+  Segment,
+  ServiceMethodOptions,
+  SDKOptions,
+  ServiceMethod,
+  ServiceMethodDynamicSegments,
+  UnknownQueryParameters,
+} from "../types";
+
+/**
+ * Service methods for the Globus Connect Server Manager API.
+ */
+export * as collections from "./service/collections";
+export * as endpoint from "./service/endpoint";
+export * as roles from "./service/roles";
+export * as storageGateways from "./service/storage-gateways";
+export * as userCredentials from "./service/user-credentials";
+export * as versioning from "./service/versioning";
+
+const SCOPES = {
+  HIGH_ASSURANCE: "urn:globus:auth:scope:<ENDPOINT_ID>:manage_collections",
+  NON_HIGH_ASSURANCE:
+    "urn:globus:auth:scope:<ENDPOINT_ID>:manage_collections[*https://auth.globus.org/scopes/<MAPPED_COLLECTION_ID>/data_access]",
+};
+
+export function getRequiredScopes(configuration: GCSConfiguration) {
+  return SCOPES.HIGH_ASSURANCE.replace(
+    "<ENDPOINT_ID>",
+    configuration.endpoint_id
+  );
+}
+
+/**
+ * The configuration object used by all Globus Connect Server Manager API methods.
+ */
+export type GCSConfiguration = {
+  /**
+   * The host (base URL) for the Globus Connect Server Manager API.
+   * @example https://fa5e.bd7c.data.globus.org
+   */
+  host: string;
+  /**
+   * The UUID
+   */
+  endpoint_id: Globus.UUID;
+};
+
+/**
+ * The GCSServiceMethod type is similar to the core ServiceMethod type, but
+ * the first parameter is always a GCSConfiguration object.
+ */
+export type GCSServiceMethod<
+  O extends ServiceMethodOptions,
+  R extends Response = Response
+> = (
+  configuration: GCSConfiguration,
+  methodOptions?: O & {
+    query?: UnknownQueryParameters;
+  },
+  sdkOptions?: SDKOptions
+) => ReturnType<ServiceMethod<O, R>>;
+
+/**
+ * The GCSServiceMethodDynamicSegments type is similar to the core ServiceMethodDynamicSegments type, but
+ * the first parameter is always a GCSConfiguration object.
+ */
+export type GCSServiceMethodDynamicSegments<
+  S extends Segment,
+  O extends ServiceMethodOptions,
+  R extends Response = Response
+> = (
+  configuration: GCSConfiguration,
+  segments: S,
+  methodOptions?: O & {
+    query?: UnknownQueryParameters;
+  },
+  sdkOptions?: SDKOptions
+) => ReturnType<ServiceMethodDynamicSegments<S, O, R>>;

package/src/lib/services/globus-connect-server/service/collections.ts

@@ -0,0 +1,63 @@
+import { getRequiredScopes } from "../index";
+import { build } from "../../../core/url";
+import { fetchWithScope } from "../../../core/fetch";
+
+import type {
+  GCSServiceMethod,
+  GCSServiceMethodDynamicSegments,
+} from "../index";
+
+import type { JSONFetchResponse } from "../../types";
+import type { operations } from "@globus/types/gcs-manager/api";
+
+/**
+ * @see https://docs.globus.org/globus-connect-server/v5.4/api/openapi_Collections/#listCollections
+ */
+export const getAll = function (
+  configuration,
+  options?,
+  sdkOptions?
+): Promise<
+  JSONFetchResponse<
+    operations["listCollections"]["responses"]["200"]["content"]["application/json"]
+  >
+> {
+  return fetchWithScope(
+    getRequiredScopes(configuration),
+    build(configuration, `/api/collections`, { search: options?.query }),
+    {
+      ...sdkOptions?.fetch?.options,
+    }
+  );
+} satisfies GCSServiceMethod<{
+  query?: operations["listCollections"]["parameters"]["query"];
+}>;
+
+/**
+ * @see https://docs.globus.org/globus-connect-server/v5.4/api/openapi_Collections/#getCollection
+ */
+export const get = function (
+  configuration,
+  collection_id,
+  options?,
+  sdkOptions?
+): Promise<
+  JSONFetchResponse<
+    operations["getCollection"]["responses"]["200"]["content"]["application/json"]
+  >
+> {
+  return fetchWithScope(
+    getRequiredScopes(configuration),
+    build(configuration, `/api/collections/${collection_id}`, {
+      search: options?.query,
+    }),
+    {
+      ...sdkOptions?.fetch?.options,
+    }
+  );
+} satisfies GCSServiceMethodDynamicSegments<
+  operations["getCollection"]["parameters"]["path"]["collection_id"],
+  {
+    query?: operations["getCollection"]["parameters"]["query"];
+  }
+>;

package/src/lib/services/globus-connect-server/service/endpoint.ts

@@ -0,0 +1,28 @@
+import { getRequiredScopes } from "../index";
+import { build } from "../../../core/url";
+import { fetchWithScope } from "../../../core/fetch";
+
+import type { GCSServiceMethod } from "../index";
+import type { JSONFetchResponse } from "../../types";
+
+import type { operations } from "@globus/types/gcs-manager/api";
+/**
+ * @see https://docs.globus.org/globus-connect-server/v5.4/api/openapi_Endpoint/#getEndpoint
+ */
+export const get = function (
+  configuration,
+  _options?,
+  sdkOptions?
+): Promise<
+  JSONFetchResponse<
+    operations["getEndpoint"]["responses"]["200"]["content"]["application/json"]
+  >
+> {
+  return fetchWithScope(
+    getRequiredScopes(configuration),
+    build(configuration, `/api/endpoint`),
+    {
+      ...sdkOptions?.fetch?.options,
+    }
+  );
+} satisfies GCSServiceMethod<never>;

package/src/lib/services/globus-connect-server/service/roles.ts

@@ -0,0 +1,113 @@
+import { getRequiredScopes } from "../index";
+import { build } from "../../../core/url";
+import { fetchWithScope } from "../../../core/fetch";
+
+import type {
+  GCSServiceMethod,
+  GCSServiceMethodDynamicSegments,
+} from "../index";
+
+import type { JSONFetchResponse } from "../../types";
+import type { operations } from "@globus/types/gcs-manager/api";
+
+/**
+ * @see https://docs.globus.org/globus-connect-server/v5.4/api/openapi_Roles/#listRoles
+ */
+export const getAll = function (
+  configuration,
+  options?,
+  sdkOptions?
+): Promise<
+  JSONFetchResponse<
+    operations["listRoles"]["responses"]["200"]["content"]["application/json"]
+  >
+> {
+  return fetchWithScope(
+    getRequiredScopes(configuration),
+    build(configuration, `/api/roles`, {
+      search: options?.query,
+    }),
+    {
+      ...sdkOptions?.fetch?.options,
+    }
+  );
+} satisfies GCSServiceMethod<{
+  query?: operations["listRoles"]["parameters"]["query"];
+}>;
+
+/**
+ * @see https://docs.globus.org/globus-connect-server/v5.4/api/openapi_Roles/#getRole
+ */
+export const get = function (
+  configuration,
+  role_id,
+  _options?,
+  sdkOptions?
+): Promise<
+  JSONFetchResponse<
+    operations["getRole"]["responses"]["200"]["content"]["application/json"]
+  >
+> {
+  return fetchWithScope(
+    getRequiredScopes(configuration),
+    build(configuration, `/api/roles/${role_id}`),
+    {
+      ...sdkOptions?.fetch?.options,
+    }
+  );
+} satisfies GCSServiceMethodDynamicSegments<
+  operations["getRole"]["parameters"]["path"]["role_id"],
+  never
+>;
+
+/**
+ * @see https://docs.globus.org/globus-connect-server/v5.4/api/openapi_Roles/#deleteRole
+ */
+export const remove = function (
+  configuration,
+  role_id,
+  _options?,
+  sdkOptions?
+): Promise<
+  JSONFetchResponse<
+    operations["deleteRole"]["responses"]["200"]["content"]["application/json"]
+  >
+> {
+  return fetchWithScope(
+    getRequiredScopes(configuration),
+    build(configuration, `/api/roles/${role_id}`),
+    {
+      method: "DELETE",
+      ...sdkOptions?.fetch?.options,
+    }
+  );
+} satisfies GCSServiceMethodDynamicSegments<
+  operations["deleteRole"]["parameters"]["path"]["role_id"],
+  never
+>;
+
+/**
+ * @see https://docs.globus.org/globus-connect-server/v5.4/api/openapi_Roles/#postRoles
+ */
+export const create = function (
+  configuration,
+  options,
+  sdkOptions?
+): Promise<
+  JSONFetchResponse<
+    operations["postRoles"]["responses"]["200"]["content"]["application/json"]
+  >
+> {
+  if (!options?.payload) throw new Error("payload is required.");
+  return fetchWithScope(
+    getRequiredScopes(configuration),
+    build(configuration, `/api/roles`),
+    {
+      method: "POST",
+      body: JSON.stringify(options.payload),
+      ...sdkOptions?.fetch?.options,
+    }
+  );
+} satisfies GCSServiceMethod<{
+  payload: operations["postRoles"]["requestBody"]["content"]["application/json"];
+}>;

package/src/lib/services/globus-connect-server/service/storage-gateways.ts

@@ -0,0 +1,65 @@
+import { getRequiredScopes } from "../index";
+import { build } from "../../../core/url";
+import { fetchWithScope } from "../../../core/fetch";
+
+import type {
+  GCSServiceMethod,
+  GCSServiceMethodDynamicSegments,
+} from "../index";
+
+import type { JSONFetchResponse } from "../../types";
+import type { operations } from "@globus/types/gcs-manager/api";
+
+/**
+ * @see https://docs.globus.org/globus-connect-server/v5.4/api/openapi_Storage_Gateways/#listStorageGateways
+ */
+export const getAll = function (
+  configuration,
+  options?,
+  sdkOptions?
+): Promise<
+  JSONFetchResponse<
+    operations["listStorageGateways"]["responses"]["200"]["content"]["application/json"]
+  >
+> {
+  return fetchWithScope(
+    getRequiredScopes(configuration),
+    build(configuration, `/api/storage_gateways`, {
+      search: options?.query,
+    }),
+    {
+      ...sdkOptions?.fetch?.options,
+    }
+  );
+} satisfies GCSServiceMethod<{
+  query?: operations["listStorageGateways"]["parameters"]["query"];
+}>;
+
+/**
+ * @see https://docs.globus.org/globus-connect-server/v5.4/api/openapi_Storage_Gateways/#getStorageGateway
+ */
+export const get = function (
+  configuration,
+  storage_gateway_id,
+  options?,
+  sdkOptions?
+): Promise<
+  JSONFetchResponse<
+    operations["getStorageGateway"]["responses"]["200"]["content"]["application/json"]
+  >
+> {
+  return fetchWithScope(
+    getRequiredScopes(configuration),
+    build(configuration, `/api/storage_gateways/${storage_gateway_id}`, {
+      search: options?.query,
+    }),
+    {
+      ...sdkOptions?.fetch?.options,
+    }
+  );
+} satisfies GCSServiceMethodDynamicSegments<
+  operations["getStorageGateway"]["parameters"]["path"]["storage_gateway_id"],
+  {
+    query?: operations["getStorageGateway"]["parameters"]["query"];
+  }
+>;

package/src/lib/services/globus-connect-server/service/user-credentials.ts

@@ -0,0 +1,61 @@
+import { getRequiredScopes } from "../index";
+import { build } from "../../../core/url";
+import { fetchWithScope } from "../../../core/fetch";
+
+import type {
+  GCSServiceMethod,
+  GCSServiceMethodDynamicSegments,
+} from "../index";
+
+import type { JSONFetchResponse } from "../../types";
+import type { operations } from "@globus/types/gcs-manager/api";
+
+/**
+ * @see https://docs.globus.org/globus-connect-server/v5.4/api/openapi_User_Credentials/#listUserCredentials
+ */
+export const getAll = function (
+  configuration,
+  options?,
+  sdkOptions?
+): Promise<
+  JSONFetchResponse<
+    operations["listUserCredentials"]["responses"]["200"]["content"]["application/json"]
+  >
+> {
+  return fetchWithScope(
+    getRequiredScopes(configuration),
+    build(configuration, `/api/user_credentials`, {
+      search: options?.query,
+    }),
+    {
+      ...sdkOptions?.fetch?.options,
+    }
+  );
+} satisfies GCSServiceMethod<{
+  query?: operations["listUserCredentials"]["parameters"]["query"];
+}>;
+
+/**
+ * @see https://docs.globus.org/globus-connect-server/v5.4/api/openapi_User_Credentials/#getUserCredential
+ */
+export const get = function (
+  configuration,
+  user_credential_id,
+  options?,
+  sdkOptions?
+): Promise<
+  JSONFetchResponse<
+    operations["getCollection"]["responses"]["200"]["content"]["application/json"]
+  >
+> {
+  return fetchWithScope(
+    getRequiredScopes(configuration),
+    build(configuration, `/api/user_credentials/${user_credential_id}`),
+    {
+      ...sdkOptions?.fetch?.options,
+    }
+  );
+} satisfies GCSServiceMethodDynamicSegments<
+  operations["getUserCredential"]["parameters"]["path"]["user_credential_id"],
+  never
+>;

package/src/lib/services/globus-connect-server/service/versioning.ts

@@ -0,0 +1,30 @@
+import { getRequiredScopes } from "../index";
+import { build } from "../../../core/url";
+import { fetchWithScope } from "../../../core/fetch";
+
+import type { GCSServiceMethod } from "../index";
+import type { JSONFetchResponse } from "../../types";
+
+import type { operations } from "@globus/types/gcs-manager/api";
+
+/**
+ *
+ * @see https://docs.globus.org/globus-connect-server/v5.4/api/openapi_Versioning/#getInfo
+ */
+export const info = function (
+  configuration,
+  _parameters?,
+  sdkOptions?
+): Promise<
+  JSONFetchResponse<
+    operations["getInfo"]["responses"]["200"]["content"]["application/json"]
+  >
+> {
+  return fetchWithScope(
+    getRequiredScopes(configuration),
+    build(configuration, `/api/info`),
+    {
+      ...sdkOptions?.fetch?.options,
+    }
+  );
+} satisfies GCSServiceMethod<never>;