@globus/sdk 0.1.9-alpha.0 → 0.3.0-alpha.0

package/README.md

@@ -1,4 +1,4 @@
-![](https://github.com/globusonline/globus-js/actions/workflows/test-sdk.yml/badge.svg)
+![@globus/sdk - test](https://github.com/globusonline/globus-js/actions/workflows/test-sdk.yml/badge.svg?branch=main)
 
 The Globus SDK for JavaScript provides first class TypeScript support and makes it easy to call Globus services using idiomatic JavaScript APIs to build Node.js and web applications.
 
@@ -6,25 +6,41 @@ The Globus SDK for JavaScript provides first class TypeScript support and makes
 - [@globus/sdk API Documentation](https://globus-jb.s3.amazonaws.com/@globus/sdk/index.html)
 
 
+## Installation
+
+If you are not using Typescript, you can install the SDK with the following command:
+
+```sh
+npm install @globus/sdk
+```
+
+### Typescript
+
+`@globus/sdk` is written in Typescript and includes type definitions for it's internal types, Globus platform types (i.e. API responses) are provided by the `@globus/types` package and must be installed separately.
+
+```sh
+npm install @globus/sdk @globus/types
+```
+
 ## Supported Platforms
 
 ### Node.js
 
 Our goal is to support all Active LTS [Node.js releases](https://nodejs.org/en/about/releases/). We intend to support all Maintenance LTS versions until their official end-of-life.
 
-| Version    |         |
-|------------|---------|
-| Node.js 14 |    ✅    |
-| Node.js 16 |    ✅    |
-| Node.js 18 |    ✅    |
+| Version    |         |       |
+|------------|---------|-------|
+| Node.js 14 |    ✅    | **⚠️** Node.js 14 support is expected to be removed before v1.0.0 (EOL) |
+| Node.js 16 |    ✅    ||
+| Node.js 18 |    ✅    ||
 
 ### Browser Support
 
 Officially, the SDK supports widely adopted evergreen browsers: Edge, Chrome, Safari and Firefox.
 
-| Browser | Version |
-|---------|---------|
-| Google Chrome |   |
-| Mozilla Firefox | |
-| Microsoft Edge |  |
-| Apple Safari  |  |
+| Browser         | Version |
+|-----------------|---------|
+| Google Chrome   |         |
+| Mozilla Firefox |         |
+| Microsoft Edge  |         |
+| Apple Safari    |         |

package/dist/commonjs/src/index.d.ts

@@ -1,6 +1,10 @@
+/**
+ * @module @globus/sdk
+ */
 export * from "./lib/sdk";
 export * as authorization from "./lib/core/authorization";
 export * as auth from "./lib/services/auth";
 export * as transfer from "./lib/services/transfer";
 export * as search from "./lib/services/search";
+export * as gcs from "./lib/services/globus-connect-server";
 //# sourceMappingURL=index.d.ts.map

package/dist/commonjs/src/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/index.ts"],"names":[],"mappings":"AAIA,cAAc,WAAW,CAAC;AAC1B,OAAO,KAAK,aAAa,MAAM,0BAA0B,CAAC;AAC1D,OAAO,KAAK,IAAI,MAAM,qBAAqB,CAAC;AAC5C,OAAO,KAAK,QAAQ,MAAM,yBAAyB,CAAC;AACpD,OAAO,KAAK,MAAM,MAAM,uBAAuB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAKH,cAAc,WAAW,CAAC;AAC1B,OAAO,KAAK,aAAa,MAAM,0BAA0B,CAAC;AAC1D,OAAO,KAAK,IAAI,MAAM,qBAAqB,CAAC;AAC5C,OAAO,KAAK,QAAQ,MAAM,yBAAyB,CAAC;AACpD,OAAO,KAAK,MAAM,MAAM,uBAAuB,CAAC;AAChD,OAAO,KAAK,GAAG,MAAM,sCAAsC,CAAC"}

package/dist/commonjs/src/index.js

@@ -1,4 +1,7 @@
 "use strict";
+/**
+ * @module @globus/sdk
+ */
 /// <reference types="@globus/types" />
 /// <reference types="@globus/types/auth" />
 /// <reference types="@globus/types/transfer" />
@@ -17,10 +20,11 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.search = exports.transfer = exports.auth = exports.authorization = void 0;
+exports.gcs = exports.search = exports.transfer = exports.auth = exports.authorization = void 0;
 __exportStar(require("./lib/sdk"), exports);
 exports.authorization = require("./lib/core/authorization");
 exports.auth = require("./lib/services/auth");
 exports.transfer = require("./lib/services/transfer");
 exports.search = require("./lib/services/search");
+exports.gcs = require("./lib/services/globus-connect-server");
 //# sourceMappingURL=index.js.map

package/dist/commonjs/src/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/index.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,4CAA4C;AAC5C,gDAAgD;;;;;;;;;;;;;;;;;AAEhD,4CAA0B;AAC1B,4DAA0D;AAC1D,8CAA4C;AAC5C,sDAAoD;AACpD,kDAAgD"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/index.ts"],"names":[],"mappings":";AAAA;;GAEG;AACH,uCAAuC;AACvC,4CAA4C;AAC5C,gDAAgD;;;;;;;;;;;;;;;;;AAEhD,4CAA0B;AAC1B,4DAA0D;AAC1D,8CAA4C;AAC5C,sDAAoD;AACpD,kDAAgD;AAChD,8DAA4D"}

package/dist/commonjs/src/lib/core/url.d.ts

@@ -1,7 +1,31 @@
 import { Environment } from "./global";
 import type { Service } from "./global";
+import type { GCSConfiguration } from "../services/globus-connect-server";
+/**
+ * Return the base URL for a service (based on the environment).
+ * @param service The service to build the URL for.
+ * @param path The path to the resource.
+ * @param environment The environment to use.
+ */
 export declare function getServiceURL(service: Service, path?: string, environment?: Environment): URL;
-export declare function build(service: Service, path: string, options?: {
-    search?: ConstructorParameters<typeof URLSearchParams>[0];
+/**
+ * Build a URL for a service or GCSConfiguration.
+ *
+ * @param service The service identifier or GCSConfiguration object to build the URL for.
+ * @param path The path to the resource.
+ * @param options Additional options for the URL.
+ */
+export declare function build(serviceOrConfiguration: Service | GCSConfiguration, path: string, options?: {
+    search?: Parameters<typeof stringifyParameters>[0];
+}): string;
+/**
+ * An extremely simplified parameter serializer based on our current needs.
+ *
+ * **This is intended for internal @globus/sdk use only.**
+ *
+ * @private
+ */
+export declare function stringifyParameters(parameters: {
+    [key: string]: string | number | Array<string | number | null | undefined> | null | undefined;
 }): string;
 //# sourceMappingURL=url.d.ts.map

package/dist/commonjs/src/lib/core/url.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"url.d.ts","sourceRoot":"","sources":["../../../../../src/lib/core/url.ts"],"names":[],"mappings":"AAAA,OAAO,EAAqC,WAAW,EAAE,MAAM,UAAU,CAAC;AAC1E,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,UAAU,CAAC;AAExC,wBAAgB,aAAa,CAC3B,OAAO,EAAE,OAAO,EAChB,IAAI,SAAK,EACT,WAAW,GAAE,WAA8B,GAC1C,GAAG,CAGL;AAED,wBAAgB,KAAK,CACnB,OAAO,EAAE,OAAO,EAChB,IAAI,EAAE,MAAM,EACZ,OAAO,CAAC,EAAE;IACR,MAAM,CAAC,EAAE,qBAAqB,CAAC,OAAO,eAAe,CAAC,CAAC,CAAC,CAAC,CAAC;CAC3D,UAQF"}
+{"version":3,"file":"url.d.ts","sourceRoot":"","sources":["../../../../../src/lib/core/url.ts"],"names":[],"mappings":"AAAA,OAAO,EAAqC,WAAW,EAAE,MAAM,UAAU,CAAC;AAC1E,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,UAAU,CAAC;AACxC,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,mCAAmC,CAAC;AAE1E;;;;;GAKG;AACH,wBAAgB,aAAa,CAC3B,OAAO,EAAE,OAAO,EAChB,IAAI,SAAK,EACT,WAAW,GAAE,WAA8B,GAC1C,GAAG,CAGL;AAED;;;;;;GAMG;AACH,wBAAgB,KAAK,CACnB,sBAAsB,EAAE,OAAO,GAAG,gBAAgB,EAClD,IAAI,EAAE,MAAM,EACZ,OAAO,CAAC,EAAE;IACR,MAAM,CAAC,EAAE,UAAU,CAAC,OAAO,mBAAmB,CAAC,CAAC,CAAC,CAAC,CAAC;CACpD,UAYF;AAED;;;;;;GAMG;AACH,wBAAgB,mBAAmB,CAAC,UAAU,EAAE;IAC9C,CAAC,GAAG,EAAE,MAAM,GACR,MAAM,GACN,MAAM,GACN,KAAK,CAAC,MAAM,GAAG,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC,GACzC,IAAI,GACJ,SAAS,CAAC;CACf,UAaA"}

package/dist/commonjs/src/lib/core/url.js

@@ -1,19 +1,60 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.build = exports.getServiceURL = void 0;
+exports.stringifyParameters = exports.build = exports.getServiceURL = void 0;
 const global_1 = require("./global");
+/**
+ * Return the base URL for a service (based on the environment).
+ * @param service The service to build the URL for.
+ * @param path The path to the resource.
+ * @param environment The environment to use.
+ */
 function getServiceURL(service, path = "", environment = (0, global_1.getEnvironment)()) {
     const base = (0, global_1.getServiceBaseUrl)(service, environment);
     return new URL(path, base);
 }
 exports.getServiceURL = getServiceURL;
-function build(service, path, options) {
-    const url = getServiceURL(service, path);
+/**
+ * Build a URL for a service or GCSConfiguration.
+ *
+ * @param service The service identifier or GCSConfiguration object to build the URL for.
+ * @param path The path to the resource.
+ * @param options Additional options for the URL.
+ */
+function build(serviceOrConfiguration, path, options) {
+    let url;
+    if (typeof serviceOrConfiguration === "object") {
+        url = new URL(path, serviceOrConfiguration.host);
+    }
+    else {
+        url = getServiceURL(serviceOrConfiguration, path);
+    }
     if (options && options.search) {
-        const search = new URLSearchParams(options.search);
-        url.search = search.toString();
+        url.search = stringifyParameters(options.search);
     }
     return url.toString();
 }
 exports.build = build;
+/**
+ * An extremely simplified parameter serializer based on our current needs.
+ *
+ * **This is intended for internal @globus/sdk use only.**
+ *
+ * @private
+ */
+function stringifyParameters(parameters) {
+    const search = new URLSearchParams();
+    for (const [key, value] of Object.entries(parameters)) {
+        if (Array.isArray(value)) {
+            /**
+             * Arrays are converted to comma-separated strings.
+             */
+            search.set(key, value.join(","));
+        }
+        else if (value !== undefined) {
+            search.set(key, String(value));
+        }
+    }
+    return search.toString();
+}
+exports.stringifyParameters = stringifyParameters;
 //# sourceMappingURL=url.js.map

package/dist/commonjs/src/lib/core/url.js.map

@@ -1 +1 @@
-{"version":3,"file":"url.js","sourceRoot":"","sources":["../../../../../src/lib/core/url.ts"],"names":[],"mappings":";;;AAAA,qCAA0E;AAG1E,SAAgB,aAAa,CAC3B,OAAgB,EAChB,IAAI,GAAG,EAAE,EACT,cAA2B,IAAA,uBAAc,GAAE;IAE3C,MAAM,IAAI,GAAG,IAAA,0BAAiB,EAAC,OAAO,EAAE,WAAW,CAAC,CAAC;IACrD,OAAO,IAAI,GAAG,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;AAC7B,CAAC;AAPD,sCAOC;AAED,SAAgB,KAAK,CACnB,OAAgB,EAChB,IAAY,EACZ,OAEC;IAED,MAAM,GAAG,GAAG,aAAa,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;IACzC,IAAI,OAAO,IAAI,OAAO,CAAC,MAAM,EAAE;QAC7B,MAAM,MAAM,GAAG,IAAI,eAAe,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QACnD,GAAG,CAAC,MAAM,GAAG,MAAM,CAAC,QAAQ,EAAE,CAAC;KAChC;IACD,OAAO,GAAG,CAAC,QAAQ,EAAE,CAAC;AACxB,CAAC;AAbD,sBAaC"}
+{"version":3,"file":"url.js","sourceRoot":"","sources":["../../../../../src/lib/core/url.ts"],"names":[],"mappings":";;;AAAA,qCAA0E;AAI1E;;;;;GAKG;AACH,SAAgB,aAAa,CAC3B,OAAgB,EAChB,IAAI,GAAG,EAAE,EACT,cAA2B,IAAA,uBAAc,GAAE;IAE3C,MAAM,IAAI,GAAG,IAAA,0BAAiB,EAAC,OAAO,EAAE,WAAW,CAAC,CAAC;IACrD,OAAO,IAAI,GAAG,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;AAC7B,CAAC;AAPD,sCAOC;AAED;;;;;;GAMG;AACH,SAAgB,KAAK,CACnB,sBAAkD,EAClD,IAAY,EACZ,OAEC;IAED,IAAI,GAAG,CAAC;IACR,IAAI,OAAO,sBAAsB,KAAK,QAAQ,EAAE;QAC9C,GAAG,GAAG,IAAI,GAAG,CAAC,IAAI,EAAE,sBAAsB,CAAC,IAAI,CAAC,CAAC;KAClD;SAAM;QACL,GAAG,GAAG,aAAa,CAAC,sBAAsB,EAAE,IAAI,CAAC,CAAC;KACnD;IACD,IAAI,OAAO,IAAI,OAAO,CAAC,MAAM,EAAE;QAC7B,GAAG,CAAC,MAAM,GAAG,mBAAmB,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;KAClD;IACD,OAAO,GAAG,CAAC,QAAQ,EAAE,CAAC;AACxB,CAAC;AAjBD,sBAiBC;AAED;;;;;;GAMG;AACH,SAAgB,mBAAmB,CAAC,UAOnC;IACC,MAAM,MAAM,GAAG,IAAI,eAAe,EAAE,CAAC;IACrC,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE;QACrD,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;YACxB;;eAEG;YACH,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;SAClC;aAAM,IAAI,KAAK,KAAK,SAAS,EAAE;YAC9B,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;SAChC;KACF;IACD,OAAO,MAAM,CAAC,QAAQ,EAAE,CAAC;AAC3B,CAAC;AApBD,kDAoBC"}