@globus/sdk 1.0.0-alpha → 1.2.0-alpha

package/src/lib/services/groups/config.ts

@@ -1,20 +0,0 @@
-import type { Environment } from "../../core/global";
-
-export const ID = "GROUPS";
-export const HOSTS: Partial<Record<Environment, string>> = {
-  sandbox: "groups.api.sandbox.globuscs.info",
-  production: "groups.api.globus.org",
-  staging: "groups.api.staging.globuscs.info",
-  integration: "groups.api.integration.globuscs.info",
-  test: "groups.api.test.globuscs.info",
-  preview: "groups.api.preview.globuscs.info",
-};
-
-/**
- * @see https://docs.globus.org/api/groups/#scopes
- */
-export const SCOPES = {
-  ALL: "urn:globus:auth:scope:groups.api.globus.org:all",
-  VIEW_MY:
-    "urn:globus:auth:scope:groups.api.globus.org:view_my_groups_and_membership",
-};

package/src/lib/services/groups/service/groups.ts

@@ -1,67 +0,0 @@
-import { ID, SCOPES } from "../config";
-import { build } from "../../../core/url";
-import { fetchWithScope } from "../../../core/fetch";
-
-import type {
-  JSONFetchResponse,
-  ServiceMethod,
-  ServiceMethodDynamicSegments,
-} from "../../types";
-import type { operations, components } from "@globus/types/groups";
-
-/**
- * @see https://groups.api.globus.org/redoc#tag/groups/operation/get_my_groups_and_memberships_v2_groups_my_groups_get
- */
-export const getMyGroups = function (
-  options = {},
-  sdkOptions?
-): Promise<
-  JSONFetchResponse<
-    operations["get_my_groups_and_memberships_v2_groups_my_groups_get"]["responses"]["200"]["content"]["application/json"]
-  >
-> {
-  return fetchWithScope(
-    SCOPES.ALL,
-    build(ID, `/v2/groups/my_groups`, {
-      search: options.query,
-    }),
-    {
-      ...sdkOptions?.fetch?.options,
-    }
-  );
-} satisfies ServiceMethod<{
-  query?: {
-    /**
-     * @todo This should probably be replaced with a more specific type for the method's accepted query parameters once available.
-     */
-    statuses?: components["schemas"]["StatusEnum"][];
-  };
-}>;
-
-/**
- * @see https://groups.api.globus.org/redoc#tag/groups/operation/get_group_v2_groups__group_id__get
- */
-export const get = function (
-  group_id,
-  options = {},
-  sdkOptions?
-): Promise<
-  JSONFetchResponse<
-    operations["get_group_v2_groups__group_id__get"]["responses"]["200"]["content"]["application/json"]
-  >
-> {
-  return fetchWithScope(
-    SCOPES.ALL,
-    build(ID, `/v2/groups/${group_id}`, {
-      search: options.query,
-    }),
-    {
-      ...sdkOptions?.fetch?.options,
-    }
-  );
-} satisfies ServiceMethodDynamicSegments<
-  operations["get_group_v2_groups__group_id__get"]["parameters"]["path"]["group_id"],
-  {
-    query?: operations["get_group_v2_groups__group_id__get"]["parameters"]["query"];
-  }
->;

package/src/lib/services/groups/service/membership.ts

@@ -1,39 +0,0 @@
-import { ID, SCOPES } from "../config";
-import { build } from "../../../core/url";
-import { fetchWithScope } from "../../../core/fetch";
-
-import type {
-  JSONFetchResponse,
-  ServiceMethodDynamicSegments,
-} from "../../types";
-import type { operations } from "@globus/types/groups";
-
-/**
- * Perform actions on members of the group.
- * @see https://groups.api.globus.org/redoc#tag/groups/operation/group_membership_post_actions_v2_groups__group_id__post
- */
-export const act = function (
-  group_id,
-  options,
-  sdkOptions?
-): Promise<
-  JSONFetchResponse<
-    operations["group_membership_post_actions_v2_groups__group_id__post"]["responses"]["200"]["content"]["application/json"]
-  >
-> {
-  if (!options?.payload) throw new Error("payload is required.");
-  return fetchWithScope(
-    SCOPES.ALL,
-    build(ID, `/v2/groups/${group_id}/policies`),
-    {
-      method: "POST",
-      body: JSON.stringify(options.payload),
-      ...sdkOptions?.fetch?.options,
-    }
-  );
-} satisfies ServiceMethodDynamicSegments<
-  operations["update_group_v2_groups__group_id__put"]["parameters"]["path"]["group_id"],
-  {
-    payload: operations["group_membership_post_actions_v2_groups__group_id__post"]["requestBody"]["content"]["application/json"];
-  }
->;

package/src/lib/services/groups/service/policies.ts

@@ -1,33 +0,0 @@
-import { ID, SCOPES } from "../config";
-import { build } from "../../../core/url";
-import { fetchWithScope } from "../../../core/fetch";
-
-import type {
-  JSONFetchResponse,
-  ServiceMethodDynamicSegments,
-} from "../../types";
-import type { operations } from "@globus/types/groups";
-
-/**
- * @see https://groups.api.globus.org/redoc#tag/groups/operation/get_policies_v2_groups__group_id__policies_get
- */
-export const get = function (
-  group_id,
-  _options?,
-  sdkOptions?
-): Promise<
-  JSONFetchResponse<
-    operations["get_policies_v2_groups__group_id__policies_get"]["responses"]["200"]["content"]["application/json"]
-  >
-> {
-  return fetchWithScope(
-    SCOPES.ALL,
-    build(ID, `/v2/groups/${group_id}/policies`),
-    {
-      ...sdkOptions?.fetch?.options,
-    }
-  );
-} satisfies ServiceMethodDynamicSegments<
-  operations["get_policies_v2_groups__group_id__policies_get"]["parameters"]["path"]["group_id"],
-  never
->;

package/src/lib/services/search/__tests__/query.spec.ts

@@ -1,35 +0,0 @@
-import { createStorage } from "../../../../lib/core/storage";
-import { query } from "..";
-
-import type { MirroredRequest } from "../../../../../mocks/handlers";
-
-describe("search – query", () => {
-  test("get", async () => {
-    createStorage("memory");
-    const result = await query.get("524de2f6-d1a6-4b49-9286-d8dccb4196ae", {
-      query: {
-        q: "test",
-      },
-    });
-    const {
-      req: { url, method, headers },
-    } = (await result.json()) as MirroredRequest;
-    expect({
-      url,
-      method,
-      headers,
-    }).toMatchInlineSnapshot(`
-      {
-        "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/524de2f6-d1a6-4b49-9286-d8dccb4196ae/search?q=test",
-      }
-    `);
-  });
-});

package/src/lib/services/search/config.ts

@@ -1,20 +0,0 @@
-import type { Environment } from "../../core/global";
-
-export const ID = "SEARCH";
-export const HOSTS: Partial<Record<Environment, string>> = {
-  sandbox: "search.api.sandbox.globuscs.info",
-  production: "search.api.globus.org",
-  staging: "search.api.staging.globuscs.info",
-  integration: "search.api.integration.globuscs.info",
-  test: "search.api.test.globuscs.info",
-  preview: "search.api.preview.globus.org",
-};
-
-/**
- * @see https://docs.globus.org/api/search/api_usage/#scopes
- */
-export const SCOPES = {
-  ALL: "urn:globus:auth:scope:search.api.globus.org:all",
-  INGEST: "urn:globus:auth:scope:search.api.globus.org:ingest",
-  SEARCH: "urn:globus:auth:scope:search.api.globus.org:search",
-};

package/src/lib/services/search/service/query.ts

@@ -1,39 +0,0 @@
-import { build } from "../../../core/url";
-import { fetchWithScope } from "../../../core/fetch";
-
-import type { ServiceMethodDynamicSegments } from "../../types";
-
-import { ID, SCOPES } from "../config";
-
-/**
- * @param index_id The UUID of the index to query.
- *
- * @see https://docs.globus.org/api/search/reference/get_query/
- */
-export const get = function (index_id, options?, sdkOptions?) {
-  return fetchWithScope(
-    SCOPES.SEARCH,
-    build(ID, `/v1/index/${index_id}/search`, {
-      search: options?.query,
-    }),
-    {
-      ...sdkOptions?.fetch?.options,
-    }
-  );
-} satisfies ServiceMethodDynamicSegments<
-  string,
-  {
-    /**
-     * @see https://docs.globus.org/api/search/reference/get_query/#parameters
-     */
-    query?: {
-      q: string;
-      offset?: `${number}`;
-      limit?: `${number}`;
-      advanced?: "true" | "false";
-      bypass_visible_to?: "true" | "false";
-      result_format_version?: string;
-      filter_principal_sets?: string;
-    };
-  }
->;

package/src/lib/services/shared.ts

@@ -1,6 +0,0 @@
-export enum HTTP_METHODS {
-  POST = "POST",
-  GET = "GET",
-  DELETE = "DELETE",
-  PUT = "PUT",
-}

package/src/lib/services/transfer/__tests__/endpoint-search.spec.ts

@@ -1,34 +0,0 @@
-import { endpointSearch } from "..";
-import { createStorage } from "../../../../lib/core/storage";
-
-import type { MirroredRequest } from "../../../../../mocks/handlers";
-
-test("endpointSearch", async () => {
-  createStorage("memory");
-  const result = await endpointSearch({
-    query: {
-      filter_fulltext: "my search string",
-      limit: 10,
-    },
-  });
-  const {
-    req: { url, method, headers },
-  } = (await result.json()) as MirroredRequest;
-  expect({
-    url,
-    method,
-    headers,
-  }).toMatchInlineSnapshot(`
-    {
-      "headers": {
-        "accept": "*/*",
-        "accept-encoding": "gzip,deflate",
-        "connection": "close",
-        "host": "transfer.api.globusonline.org",
-        "user-agent": "node-fetch/1.0 (+https://github.com/bitinn/node-fetch)",
-      },
-      "method": "GET",
-      "url": "https://transfer.api.globusonline.org/v0.10/endpoint_search?filter_fulltext=my+search+string&limit=10",
-    }
-  `);
-});

package/src/lib/services/transfer/__tests__/endpoint.spec.ts

@@ -1,17 +0,0 @@
-import serviceTestSuite from "../../../../__utils__/service-test-suite";
-import { endpoint } from "..";
-
-const ENDPOINT = "c591c905-2674-4227-9d31-1ff9485945a7";
-
-serviceTestSuite("transfer", "endpoint", (fetch) => {
-  test("get", async () => {
-    await endpoint.get(ENDPOINT);
-    expect(fetch).toHaveBeenCalled();
-    expect(fetch).toHaveBeenCalledWith(
-      `https://transfer.api.globusonline.org/v0.10/endpoint/${ENDPOINT}`,
-      {
-        headers: {},
-      }
-    );
-  });
-});

package/src/lib/services/transfer/__tests__/file-operations.spec.ts

@@ -1,87 +0,0 @@
-import serviceTestSuite from "../../../../__utils__/service-test-suite";
-import { fileOperations } from "..";
-
-/**
- * random endpoint-like identifier (uuid)
- */
-const ENDPOINT = "c591c905-2674-4227-9d31-1ff9485945a7";
-
-serviceTestSuite("transfer", "file-operations", (fetch) => {
-  test("mkdir", async () => {
-    await fileOperations.mkdir(ENDPOINT, {
-      payload: {
-        path: "/~/new-directory",
-      },
-    });
-    expect(fetch).toHaveBeenCalled();
-    expect(fetch).toHaveBeenCalledWith(
-      `https://transfer.api.globusonline.org/v0.10/operation/endpoint/${ENDPOINT}/mkdir`,
-      expect.objectContaining({
-        body: expect.stringMatching(
-          '{"DATA_TYPE":"mkdir","path":"/~/new-directory"}'
-        ) as unknown,
-        headers: { "Content-Type": "application/json" },
-        method: "POST",
-      })
-    );
-  });
-
-  test("rename", async () => {
-    await fileOperations.rename(ENDPOINT, {
-      payload: {
-        old_path: "/~/old-directory",
-        new_path: "/new-path",
-      },
-    });
-    expect(fetch).toHaveBeenCalled();
-    expect(fetch).toHaveBeenCalledWith(
-      `https://transfer.api.globusonline.org/v0.10/operation/endpoint/${ENDPOINT}/rename`,
-      expect.objectContaining({
-        body: expect.stringMatching(
-          '{"DATA_TYPE":"rename","old_path":"/~/old-directory","new_path":"/new-path"}'
-        ) as unknown,
-        headers: {
-          "Content-Type": "application/json",
-        },
-        method: "POST",
-      })
-    );
-  });
-
-  test("symlink", async () => {
-    await fileOperations.symlink(ENDPOINT, {
-      payload: {
-        symlink_target: "/~/some/project/myfile.txt",
-        path: "/~/quick_link.txt",
-      },
-    });
-    expect(fetch).toHaveBeenCalled();
-    expect(fetch).toHaveBeenCalledWith(
-      `https://transfer.api.globusonline.org/v0.10/operation/endpoint/${ENDPOINT}/symlink`,
-      expect.objectContaining({
-        body: expect.stringMatching(
-          '{"DATA_TYPE":"symlink","symlink_target":"/~/some/project/myfile.txt","path":"/~/quick_link.txt"}'
-        ) as unknown,
-        headers: {
-          "Content-Type": "application/json",
-        },
-        method: "POST",
-      })
-    );
-  });
-
-  test("ls", async () => {
-    await fileOperations.ls(ENDPOINT, {
-      query: {
-        path: "/~/",
-      },
-    });
-    expect(fetch).toHaveBeenCalled();
-    expect(fetch).toHaveBeenCalledWith(
-      `https://transfer.api.globusonline.org/v0.10/operation/endpoint/${ENDPOINT}/ls?path=%2F%7E%2F`,
-      {
-        headers: {},
-      }
-    );
-  });
-});

package/src/lib/services/transfer/__tests__/task-submission.spec.ts

@@ -1,55 +0,0 @@
-import serviceTestSuite from "../../../../__utils__/service-test-suite";
-import { taskSubmission } from "..";
-
-serviceTestSuite("transfer", "task-submission", (fetch) => {
-  test("submissionId", async () => {
-    await taskSubmission.submissionId();
-    expect(fetch).toHaveBeenCalled();
-    expect(fetch).toHaveBeenCalledWith(
-      `https://transfer.api.globusonline.org/v0.10/submission_id`,
-      {
-        headers: {},
-      }
-    );
-  });
-
-  test("submitDelete", async () => {
-    const payload = {
-      endpoint: "e434fe90-591f-40d9-8d34-3016b6237046",
-      submission_id: "65d1dc8c-5ebb-487e-8990-e5a25e3cf1d4",
-      DATA: [{ DATA_TYPE: "delete_item", path: "/" }],
-    };
-
-    await taskSubmission.submitDelete({
-      payload,
-    });
-    expect(fetch).toHaveBeenCalled();
-    expect(fetch).toHaveBeenCalledWith(
-      `https://transfer.api.globusonline.org/v0.10/delete`,
-      expect.objectContaining({
-        body: expect.stringContaining(`"DATA_TYPE":"delete"`) as unknown,
-        headers: expect.objectContaining({
-          "Content-Type": "application/json",
-        }) as unknown,
-        method: "POST",
-      })
-    );
-  });
-
-  test("submitTransfer", async () => {
-    await taskSubmission.submitTransfer({
-      payload: {},
-    });
-    expect(fetch).toHaveBeenCalled();
-    expect(fetch).toHaveBeenCalledWith(
-      `https://transfer.api.globusonline.org/v0.10/transfer`,
-      expect.objectContaining({
-        body: expect.stringContaining(`"DATA_TYPE":"transfer"`) as unknown,
-        headers: expect.objectContaining({
-          "Content-Type": "application/json",
-        }) as unknown,
-        method: "POST",
-      })
-    );
-  });
-});

package/src/lib/services/transfer/config.ts

@@ -1,11 +0,0 @@
-import type { Environment } from "../../core/global";
-
-export const ID = "TRANSFER";
-export const HOSTS: Partial<Record<Environment, string>> = {
-  sandbox: "transfer.sandbox.globuscs.info",
-  production: "transfer.api.globusonline.org",
-  staging: "transfer.api.staging.globuscs.info",
-  integration: "transfer.api.integration.globuscs.info",
-  test: "transfer.api.test.globuscs.info",
-  preview: "transfer.api.preview.globus.org",
-};

package/src/lib/services/transfer/service/endpoint-search.ts

@@ -1,38 +0,0 @@
-import { build } from "../../../core/url";
-import { fetchWithScope } from "../../../core/fetch";
-
-import type { SDKOptions } from "../../../services/types";
-
-import { ID } from "../config";
-
-/**
- * Get a list of endpoints matching the search filters in a given search scope.
- * @see https://docs.globus.org/api/transfer/endpoint_search/#endpoint_search
- */
-export const endpointSearch = function (
-  /**
-   * @see https://docs.globus.org/api/transfer/endpoint_search/#query_parameters
-   */
-  options?: {
-    /**
-     * @todo This type needs to be converted to a record and this method updated
-     * to `satisfies` `ServiceMethod`.
-     */
-    query?: Globus.Transfer.EndpointSearchQuery;
-  },
-  sdkOptions?: SDKOptions
-) {
-  return fetchWithScope(
-    "urn:globus:auth:scope:transfer.api.globus.org:all",
-    build(ID, `/v0.10/endpoint_search`, {
-      /**
-       * Since the exported type used here is an `interface`, we effectivley have to
-       * "seal" the type, otherwise the compiler will complain about potentially mismatching index types.
-       */
-      search: options?.query as Readonly<Globus.Transfer.EndpointSearchQuery>,
-    }),
-    sdkOptions?.fetch?.options
-  );
-};
-
-export default endpointSearch;

package/src/lib/services/transfer/service/endpoint.ts

@@ -1,26 +0,0 @@
-import { build } from "../../../core/url";
-import { fetchWithScope } from "../../../core/fetch";
-
-import { ID } from "../config";
-
-import type {
-  ServiceMethodDynamicSegments,
-  JSONFetchResponse,
-} from "../../../services/types";
-
-/**
- * Fetch an endpoint by its UUID.
- */
-export const get = function (endpoint_xid, _options?, sdkOptions?) {
-  return fetchWithScope(
-    "urn:globus:auth:scope:transfer.api.globus.org:all",
-    build(ID, `/v0.10/endpoint/${endpoint_xid}`),
-    {
-      ...sdkOptions?.fetch?.options,
-    }
-  );
-} satisfies ServiceMethodDynamicSegments<
-  string,
-  never,
-  JSONFetchResponse<Globus.Transfer.EndpointDocument>
->;

package/src/lib/services/transfer/service/file-operations.ts

@@ -1,114 +0,0 @@
-import { build } from "../../../core/url";
-import { fetchWithScope } from "../../../core/fetch";
-import { HTTP_METHODS } from "../../shared";
-
-import type { ServiceMethodDynamicSegments } from "../../types";
-
-import { getHeadersForService } from "../shared";
-import { ID } from "../config";
-
-import type { Transfer } from "../types";
-
-/**
- * List the contents of the directory at the specified path on an endpoint’s filesystem.
- * The endpoint must be activated before performing this operation.
- *
- * @see https://docs.globus.org/api/transfer/file_operations/#list_directory_contents
- */
-export const ls = function (endpoint_xid, options?, sdkOptions?) {
-  return fetchWithScope(
-    "urn:globus:auth:scope:transfer.api.globus.org:all",
-    build(ID, `/v0.10/operation/endpoint/${endpoint_xid}/ls`, {
-      search: options?.query,
-    }),
-    sdkOptions?.fetch?.options
-  );
-} satisfies ServiceMethodDynamicSegments<
-  string,
-  {
-    query?: Transfer["DirectoryListingQuery"];
-  }
->;
-
-/**
- * Create a directory at the specified path on an endpoint filesystem.
- * The endpoint must be activated before performing this operation.
- *
- * @see https://docs.globus.org/api/transfer/file_operations/#make_directory
- */
-export const mkdir = function (endpoint_xid, options, sdkOptions?) {
-  return fetchWithScope(
-    "urn:globus:auth:scope:transfer.api.globus.org:all",
-    build(ID, `/v0.10/operation/endpoint/${endpoint_xid}/mkdir`),
-    {
-      method: HTTP_METHODS.POST,
-      body: JSON.stringify({
-        DATA_TYPE: "mkdir",
-        ...options?.payload,
-      }),
-      headers: getHeadersForService(HTTP_METHODS.POST),
-      ...sdkOptions?.fetch?.options,
-    }
-  );
-} satisfies ServiceMethodDynamicSegments<
-  string,
-  {
-    payload: Omit<Transfer["Request"]["Mkdir"], "DATA_TYPE">;
-  }
->;
-
-/**
- * Rename or move a file, directory, or symlink on an endpoint filesystem.
- * If the object is a symlink, the symlink itself is renamed, not its target
- * The endpoint must be activated before performing this operation.
- * When moving to a different parent directory, the parent directory of the new path must already exist.
- *
- * @see https://docs.globus.org/api/transfer/file_operations/#rename
- */
-export const rename = function (endpoint_xid, options, sdkOptions?) {
-  return fetchWithScope(
-    "urn:globus:auth:scope:transfer.api.globus.org:all",
-    build(ID, `/v0.10/operation/endpoint/${endpoint_xid}/rename`),
-    {
-      method: HTTP_METHODS.POST,
-      body: JSON.stringify({
-        DATA_TYPE: "rename",
-        ...options?.payload,
-      }),
-      headers: getHeadersForService(HTTP_METHODS.POST),
-      ...sdkOptions?.fetch?.options,
-    }
-  );
-} satisfies ServiceMethodDynamicSegments<
-  string,
-  {
-    payload: Omit<Transfer["Request"]["Rename"], "DATA_TYPE">;
-  }
->;
-
-/**
- * Create a directory at the specified path on an endpoint filesystem.
- * The endpoint must be activated before performing this operation.
- *
- * @see https://docs.globus.org/api/transfer/file_operations/#symlink
- */
-export const symlink = function (endpoint_xid, options, sdkOptions?) {
-  return fetchWithScope(
-    "urn:globus:auth:scope:transfer.api.globus.org:all",
-    build(ID, `/v0.10/operation/endpoint/${endpoint_xid}/symlink`),
-    {
-      method: HTTP_METHODS.POST,
-      body: JSON.stringify({
-        DATA_TYPE: "symlink",
-        ...options?.payload,
-      }),
-      headers: getHeadersForService(HTTP_METHODS.POST),
-      ...sdkOptions?.fetch?.options,
-    }
-  );
-} satisfies ServiceMethodDynamicSegments<
-  string,
-  {
-    payload: Omit<Transfer["Request"]["Symlink"], "DATA_TYPE">;
-  }
->;