@globus/sdk 1.0.0-alpha → 1.1.0-alpha

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">;
-  }
->;

package/src/lib/services/transfer/service/task-submission.ts

@@ -1,68 +0,0 @@
-import { build } from "../../../core/url";
-import { fetchWithScope } from "../../../core/fetch";
-import { HTTP_METHODS } from "../../shared";
-
-import type { SDKOptions, ServiceMethod } from "../../types";
-
-import { getHeadersForService } from "../shared";
-import { ID } from "../config";
-
-import type { Transfer } from "../types";
-
-/**
- * Submit a delete task. A delete submission contains a single endpoint and a
- * list of paths to delete.
- *
- * @see https://docs.globus.org/api/transfer/task_submit/#submit_delete_task
- */
-export const submitDelete = function (options, sdkOptions?: SDKOptions) {
-  return fetchWithScope(
-    "urn:globus:auth:scope:transfer.api.globus.org:all",
-    build(ID, `/v0.10/delete`),
-    {
-      method: HTTP_METHODS.POST,
-      body: JSON.stringify({
-        DATA_TYPE: "delete",
-        ...options?.payload,
-      }),
-      headers: getHeadersForService(HTTP_METHODS.POST),
-      ...sdkOptions?.fetch?.options,
-    }
-  );
-} satisfies ServiceMethod<{
-  payload: Omit<Transfer["Request"]["Delete"], "DATA_TYPE">;
-}>;
-
-export const submitTransfer = function (options, sdkOptions?: SDKOptions) {
-  return fetchWithScope(
-    "urn:globus:auth:scope:transfer.api.globus.org:all",
-    build(ID, `/v0.10/transfer`),
-    {
-      method: HTTP_METHODS.POST,
-      body: JSON.stringify({
-        DATA_TYPE: "transfer",
-        ...options?.payload,
-      }),
-      headers: getHeadersForService(HTTP_METHODS.POST),
-      ...sdkOptions?.fetch?.options,
-    }
-  );
-} satisfies ServiceMethod<{
-  payload: Omit<Transfer["Request"]["Transfer"], "DATA_TYPE">;
-}>;
-
-/**
- * Get a submission id, required when submitting transfer and delete tasks.
- * Note that this is different than the task id returned by the submit operations.
- *
- * @see https://docs.globus.org/api/transfer/task_submit/#get_submission_id
- */
-export function submissionId(options?: SDKOptions) {
-  return fetchWithScope(
-    "urn:globus:auth:scope:transfer.api.globus.org:all",
-    build(ID, `/v0.10/submission_id`),
-    {
-      ...options?.fetch?.options,
-    }
-  );
-}

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

@@ -1,12 +0,0 @@
-import { HTTP_METHODS } from "../shared";
-
-export function getHeadersForService(
-  method: keyof typeof HTTP_METHODS
-): Record<string, any> {
-  if (method === HTTP_METHODS.GET) {
-    return {};
-  }
-  return {
-    "Content-Type": "application/json",
-  };
-}

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

@@ -1,42 +0,0 @@
-export interface Transfer {
-  /**
-   * @see https://docs.globus.org/api/transfer/file_operations/#list_directory_contents
-   */
-  DirectoryListingQuery: {
-    path?: string;
-    show_hidden?: "true" | "false";
-    limit?: `${number}`;
-    offset?: `${number}`;
-    orderby?: string;
-    filter?: string;
-  };
-
-  Request: {
-    Mkdir: {
-      path: string;
-    };
-    Rename: {
-      DATA_TYPE: "mkdir";
-      old_path: string;
-      new_path: string;
-    };
-    Symlink: {
-      DATA_TYPE: "symlink";
-      path: string;
-      symlink_target: string;
-    };
-
-    Delete: {
-      DATA_TYPE: "delete";
-      endpoint: string;
-      submission_id: string;
-      DATA: { DATA_TYPE: string; path: string }[];
-      ignore_missing?: boolean;
-      recursive?: boolean;
-    };
-
-    Transfer: {
-      DATA_TYPE: "transfer";
-    };
-  };
-}

package/src/lib/services/types.ts

@@ -1,67 +0,0 @@
-import type { FetchOverrides } from "../core/fetch";
-import { stringifyParameters } from "../core/url";
-
-export interface JSONFetchResponse<Res> extends Response {
-  json(): Promise<Res>;
-}
-
-export type SDKOptions = {
-  fetch?: {
-    options: FetchOverrides;
-  };
-};
-
-/**
- * This isn't used yet, but might be one day.
- * @private
- * @experimental
- */
-export type ServiceMethodResponse = {
-  /**
-   * The raw response from the upstream service.
-   */
-  _raw: Record<string, Record<string, unknown>>;
-  /**
-   * Information we deem worthwhile to augment responses with.
-   * - Timing information, debug information, etc.
-   */
-  _metadata: Record<string, unknown>;
-  data: Record<string, unknown>;
-};
-
-/**
- * Our `stringifyParameters` function defines what types of query parameters
- * can actually be serialized as part of the URL.
- */
-export type UnknownQueryParameters = Parameters<typeof stringifyParameters>[0];
-
-export type ServiceMethodOptions =
-  | {
-      query?: UnknownQueryParameters;
-      payload?: Record<string, unknown>;
-    }
-  | undefined
-  | never;
-
-export type Segment = string | Record<string, string>;
-export type ServiceMethod<
-  O extends ServiceMethodOptions,
-  R extends Response = Response
-> = (
-  methodOptions?: O & {
-    query?: UnknownQueryParameters;
-  },
-  sdkOptions?: SDKOptions
-) => Promise<R>;
-
-export type ServiceMethodDynamicSegments<
-  S extends Segment,
-  O extends ServiceMethodOptions,
-  R extends Response = Response
-> = (
-  segments: S,
-  methodOptions?: O & {
-    query?: UnknownQueryParameters;
-  },
-  sdkOptions?: SDKOptions
-) => Promise<R>;

package/tsconfig.json

@@ -1,19 +0,0 @@
-{
-  "extends": "../../../tsconfig.base.json",
-  "compilerOptions": {
-    "noImplicitOverride": true,
-    "noPropertyAccessFromIndexSignature": true,
-    "noImplicitReturns": true,
-    "declaration": true,
-    "declarationMap": true,
-    "types": ["jest", "node"],
-    "baseUrl": ".",
-    "outDir": "dist/esm",
-    "rootDir": "./src",
-  },
-  "files": [
-    "./src/index.ts"
-  ],
-  "include": ["./src/**/*.ts"],
-  "exclude": ["**/*.spec.ts", "**/*.test.ts", "**/__tests__/*", "**/__utils__/*", "**/__mocks__/*"]
-}

package/typedoc.json

@@ -1,10 +0,0 @@
-{
-  "$schema": "https://typedoc.org/schema.json",
-  "name": "Globus SDK for Javascript",
-  "entryPoints": [
-    "./src/index.ts",
-    "./src/lib/services/globus-connect-server/client.ts"
-  ],
-  "entryPointStrategy": "expand",
-  "out": "docs"
-}

package/webpack.config.cjs

@@ -1,14 +0,0 @@
-/* global __dirname */
-const path = require("node:path");
-
-module.exports = {
-  mode: "production",
-  entry: {
-    globus: path.resolve(__dirname, "./dist/esm/index.js"),
-  },
-  output: {
-    path: path.resolve(__dirname, "./dist/umd"),
-    filename: "[name].production.js",
-    library: "globus",
-  },
-};