@worldlabsai/client 0.4.0 → 0.6.0

package/README.md

@@ -15,7 +15,7 @@ Methods marked `@beta` require beta access for your World Labs account.
 Use a World Labs Developer API key to authenticate API requests.
 
 Before choosing model inputs or combining tasks, read
-[How To Use Atlas](https://marble5.worldlabs.ai/docs/how-to-use-atlas).
+[How To Use Atlas](https://docs.atlas-beta.worldlabs.ai/how-to-use-atlas).
 
 ## Usage
 
@@ -105,6 +105,10 @@ API middleware and API-key authentication.
 | `baseUrl`    | API base URL. Defaults to `https://api.atlas-beta.worldlabs.ai`.                                                      |
 | `fetch`      | Custom Fetch implementation for API requests and uploads. Defaults to `globalThis.fetch`.                             |
 | `middleware` | Wrap API requests for logging or retries. The first supplied middleware runs outermost, after API-key authentication. |
+| `userAgent`  | Product tokens that name your app, such as `my-app/1.2.0`. They are sent before the client's own in `User-Agent`.     |
+
+In Node.js, API requests send `User-Agent: worldlabsai-client/<version> node/<version>`,
+after any `userAgent` tokens. In browsers the browser's own `User-Agent` is kept.
 
 An empty key or a rejected key provider stops the request before it is sent.
 Retry middleware must clone a request before sending it so its body can be

package/dist/client.d.ts

@@ -13,6 +13,8 @@ export interface ClientOptions {
     fetch?: Fetch;
     /** Wraps API requests after API-key auth, outermost first. Signed uploads bypass middleware. */
     middleware?: Middleware[];
+    /** Product tokens, such as `my-app/1.2.0`, sent before this client's own in `User-Agent`. */
+    userAgent?: string;
 }
 /** Client returned by {@link createClient}; reuse it across requests. */
 export interface WorldLabsClient {

package/dist/client.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAc,YAAY,EAAE,gBAAgB,EAAmB,MAAM,iBAAiB,CAAC;AAC9F,OAAO,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AACjE,OAAO,EAAc,WAAW,EAAiB,MAAM,0BAA0B,CAAC;AAElF,yEAAyE;AACzE,eAAO,MAAM,gBAAgB,wCAAwC,CAAC;AAEtE,mDAAmD;AACnD,MAAM,WAAW,aAAa;IAC5B,mGAAmG;IACnG,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,kEAAkE;IAClE,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,yFAAyF;IACzF,KAAK,CAAC,EAAE,KAAK,CAAC;IACd,gGAAgG;IAChG,UAAU,CAAC,EAAE,UAAU,EAAE,CAAC;CAC3B;AAED,yEAAyE;AACzE,MAAM,WAAW,eAAe;IAC9B,8CAA8C;IAC9C,MAAM,EAAE,UAAU,CAAC,OAAO,YAAY,CAAC,CAAC;IACxC,8CAA8C;IAC9C,UAAU,EAAE,UAAU,CAAC,OAAO,gBAAgB,CAAC,CAAC;IAChD,oDAAoD;IACpD,KAAK,EAAE,UAAU,CAAC,OAAO,WAAW,CAAC,CAAC;CACvC;AAED;;;;;;GAMG;AACH,eAAO,MAAM,YAAY,GAAI,SAAS,aAAa,KAAG,eAkBrD,CAAC"}
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,YAAY,EACZ,gBAAgB,EAGjB,MAAM,iBAAiB,CAAC;AACzB,OAAO,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AACjE,OAAO,EAAc,WAAW,EAAiB,MAAM,0BAA0B,CAAC;AAGlF,yEAAyE;AACzE,eAAO,MAAM,gBAAgB,wCAAwC,CAAC;AAEtE,mDAAmD;AACnD,MAAM,WAAW,aAAa;IAC5B,mGAAmG;IACnG,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,kEAAkE;IAClE,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,yFAAyF;IACzF,KAAK,CAAC,EAAE,KAAK,CAAC;IACd,gGAAgG;IAChG,UAAU,CAAC,EAAE,UAAU,EAAE,CAAC;IAC1B,6FAA6F;IAC7F,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,yEAAyE;AACzE,MAAM,WAAW,eAAe;IAC9B,8CAA8C;IAC9C,MAAM,EAAE,UAAU,CAAC,OAAO,YAAY,CAAC,CAAC;IACxC,8CAA8C;IAC9C,UAAU,EAAE,UAAU,CAAC,OAAO,gBAAgB,CAAC,CAAC;IAChD,oDAAoD;IACpD,KAAK,EAAE,UAAU,CAAC,OAAO,WAAW,CAAC,CAAC;CACvC;AAgBD;;;;;;GAMG;AACH,eAAO,MAAM,YAAY,GAAI,SAAS,aAAa,KAAG,eAkBrD,CAAC"}

package/dist/client.js

@@ -1,7 +1,22 @@
-import { apiKeyAuth, createAssets, createOperations, createTransport } from "./core/index.js";
+import { apiKeyAuth, createAssets, createOperations, createTransport, withHeader, } from "./core/index.js";
 import { assetsPath, createTasks, operationPath } from "./generated/tasks.gen.js";
+import { VERSION } from "./version.js";
 /** Developer API origin used when `ClientOptions.baseUrl` is omitted. */
 export const DEFAULT_BASE_URL = "https://api.atlas-beta.worldlabs.ai";
+/**
+ * Name the caller, this package, and Node in `User-Agent`. Browsers keep their
+ * own: Chrome drops a value set by the page and Firefox would preflight it.
+ */
+const userAgentMiddleware = (callerTokens) => {
+    const node = globalThis.process?.versions
+        ?.node;
+    if (node === undefined)
+        return [];
+    const value = [callerTokens, `worldlabsai-client/${VERSION}`, `node/${node}`]
+        .filter(Boolean)
+        .join(" ");
+    return [async (request, next) => await next(withHeader(request, "User-Agent", value))];
+};
 /**
  * Create a client for the World Labs Developer API.
  *
@@ -20,7 +35,7 @@ export const createClient = (options) => {
     const transport = createTransport({
         baseUrl: options.baseUrl ?? DEFAULT_BASE_URL,
         ...(options.fetch ? { fetch: options.fetch } : {}),
-        middleware,
+        middleware: [...userAgentMiddleware(options.userAgent), ...middleware],
     });
     return {
         assets: createAssets(transport, assetsPath),

package/dist/client.js.map

@@ -1 +1 @@
-{"version":3,"file":"client.js","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,gBAAgB,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAC;AAE9F,OAAO,EAAE,UAAU,EAAE,WAAW,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAC;AAElF,yEAAyE;AACzE,MAAM,CAAC,MAAM,gBAAgB,GAAG,qCAAqC,CAAC;AAwBtE;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,OAAsB,EAAmB,EAAE;IACtE,MAAM,UAAU,GAAG;QACjB,GAAG,CAAC,OAAO,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC;QACrE,GAAG,CAAC,OAAO,CAAC,UAAU,IAAI,EAAE,CAAC;KAC9B,CAAC;IACF,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC5B,MAAM,IAAI,KAAK,CAAC,wEAAwE,CAAC,CAAC;IAC5F,CAAC;IACD,MAAM,SAAS,GAAG,eAAe,CAAC;QAChC,OAAO,EAAE,OAAO,CAAC,OAAO,IAAI,gBAAgB;QAC5C,GAAG,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAClD,UAAU;KACX,CAAC,CAAC;IACH,OAAO;QACL,MAAM,EAAE,YAAY,CAAC,SAAS,EAAE,UAAU,CAAC;QAC3C,UAAU,EAAE,gBAAgB,CAAC,SAAS,EAAE,aAAa,CAAC;QACtD,KAAK,EAAE,WAAW,CAAC,SAAS,CAAC;KAC9B,CAAC;AACJ,CAAC,CAAC"}
+{"version":3,"file":"client.js","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,UAAU,EACV,YAAY,EACZ,gBAAgB,EAChB,eAAe,EACf,UAAU,GACX,MAAM,iBAAiB,CAAC;AAEzB,OAAO,EAAE,UAAU,EAAE,WAAW,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAC;AAClF,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AAEvC,yEAAyE;AACzE,MAAM,CAAC,MAAM,gBAAgB,GAAG,qCAAqC,CAAC;AA0BtE;;;GAGG;AACH,MAAM,mBAAmB,GAAG,CAAC,YAAgC,EAAgB,EAAE;IAC7E,MAAM,IAAI,GAAI,UAA6D,CAAC,OAAO,EAAE,QAAQ;QAC3F,EAAE,IAAI,CAAC;IACT,IAAI,IAAI,KAAK,SAAS;QAAE,OAAO,EAAE,CAAC;IAClC,MAAM,KAAK,GAAG,CAAC,YAAY,EAAE,sBAAsB,OAAO,EAAE,EAAE,QAAQ,IAAI,EAAE,CAAC;SAC1E,MAAM,CAAC,OAAO,CAAC;SACf,IAAI,CAAC,GAAG,CAAC,CAAC;IACb,OAAO,CAAC,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,EAAE,CAAC,MAAM,IAAI,CAAC,UAAU,CAAC,OAAO,EAAE,YAAY,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC;AACzF,CAAC,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,OAAsB,EAAmB,EAAE;IACtE,MAAM,UAAU,GAAG;QACjB,GAAG,CAAC,OAAO,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC;QACrE,GAAG,CAAC,OAAO,CAAC,UAAU,IAAI,EAAE,CAAC;KAC9B,CAAC;IACF,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC5B,MAAM,IAAI,KAAK,CAAC,wEAAwE,CAAC,CAAC;IAC5F,CAAC;IACD,MAAM,SAAS,GAAG,eAAe,CAAC;QAChC,OAAO,EAAE,OAAO,CAAC,OAAO,IAAI,gBAAgB;QAC5C,GAAG,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAClD,UAAU,EAAE,CAAC,GAAG,mBAAmB,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,GAAG,UAAU,CAAC;KACvE,CAAC,CAAC;IACH,OAAO;QACL,MAAM,EAAE,YAAY,CAAC,SAAS,EAAE,UAAU,CAAC;QAC3C,UAAU,EAAE,gBAAgB,CAAC,SAAS,EAAE,aAAa,CAAC;QACtD,KAAK,EAAE,WAAW,CAAC,SAAS,CAAC;KAC9B,CAAC;AACJ,CAAC,CAAC"}

package/dist/core/assets.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"assets.d.ts","sourceRoot":"","sources":["../../src/core/assets.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,KAAK,EACL,WAAW,EACX,qBAAqB,EAKrB,SAAS,EACV,MAAM,mCAAmC,CAAC;AAE3C,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAEhD,0CAA0C;AAC1C,MAAM,WAAW,aAAc,SAAQ,IAAI,CAAC,WAAW,EAAE,QAAQ,CAAC;IAChE,gCAAgC;IAChC,WAAW,EAAE,MAAM,CAAC;IACpB,kFAAkF;IAClF,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,+DAA+D;AAC/D,MAAM,WAAW,iBAAkB,SAAQ,IAAI,CAAC,WAAW,EAAE,QAAQ,CAAC;IACpE,0CAA0C;IAC1C,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,4DAA4D;IAC5D,KAAK,CAAC,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;IACvB,gFAAgF;IAChF,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,+DAA+D;AAC/D,eAAO,MAAM,OAAO,GAAI,OAAO,KAAK,KAAG,MAAkB,CAAC;AAE1D,6DAA6D;AAC7D,eAAO,MAAM,QAAQ,GAAI,OAAO,KAAK,KAAG,SAA0C,CAAC;AAWnF;;;;GAIG;AACH,eAAO,MAAM,YAAY,GAAI,WAAW,SAAS,EAAE,YAAY,MAAM;IAuBjE;;;;OAIG;yBAhBC,MAAM,SACJ,qBAAqB,YAClB,IAAI,CAAC,WAAW,EAAE,QAAQ,CAAC;;;;gBAoG+uJ,iEAAsB;;;;;;;gBAA2qC,iEAAsB;;;;qBAAkV,iEAAsB;;;;;IAnFl1M,2FAA2F;oBACrE,WAAW,YAAW,IAAI,CAAC,WAAW,EAAE,QAAQ,CAAC;;;;gBAkFux/C,iEAAsB;;;;;;;gBAA2qC,iEAAsB;;;;qBAAkV,iEAAsB;;;;kBAAq9C,iEAAsB;;IA/Ex4lD;;;OAGG;wBACuB,MAAM,YAAW,IAAI,CAAC,WAAW,EAAE,QAAQ,CAAC;;;;IAOtE;;;OAGG;iBACgB,MAAM,YAAW,IAAI,CAAC,WAAW,EAAE,QAAQ,CAAC;IAI/D;;;OAGG;cACa,MAAM,YAAW,IAAI,CAAC,WAAW,EAAE,QAAQ,CAAC;;;;gBAwDutJ,iEAAsB;;;;;;;gBAA2qC,iEAAsB;;;;qBAAkV,iEAAsB;;;;;IArDl1M,gGAAgG;wDACvC,iBAAiB;iBAoDm8jE,iEAAsB;iBAAsS,iEAAsB;;;IA9C/1kE;;;;;;;;OAQG;mBACkB,IAAI,GAAG,YAAY,qCAAqC,aAAa;;;;gBAqCyrJ,iEAAsB;;;;;;;gBAA2qC,iEAAsB;;;;qBAAkV,iEAAsB;;;;;CADr1M,CAAC"}
+{"version":3,"file":"assets.d.ts","sourceRoot":"","sources":["../../src/core/assets.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,KAAK,EACL,WAAW,EACX,qBAAqB,EAKrB,SAAS,EACV,MAAM,mCAAmC,CAAC;AAE3C,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAEhD,0CAA0C;AAC1C,MAAM,WAAW,aAAc,SAAQ,IAAI,CAAC,WAAW,EAAE,QAAQ,CAAC;IAChE,gCAAgC;IAChC,WAAW,EAAE,MAAM,CAAC;IACpB,kFAAkF;IAClF,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,+DAA+D;AAC/D,MAAM,WAAW,iBAAkB,SAAQ,IAAI,CAAC,WAAW,EAAE,QAAQ,CAAC;IACpE,0CAA0C;IAC1C,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,4DAA4D;IAC5D,KAAK,CAAC,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;IACvB,gFAAgF;IAChF,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,+DAA+D;AAC/D,eAAO,MAAM,OAAO,GAAI,OAAO,KAAK,KAAG,MAAkB,CAAC;AAE1D,6DAA6D;AAC7D,eAAO,MAAM,QAAQ,GAAI,OAAO,KAAK,KAAG,SAA0C,CAAC;AAWnF;;;;GAIG;AACH,eAAO,MAAM,YAAY,GAAI,WAAW,SAAS,EAAE,YAAY,MAAM;IAuBjE;;;;OAIG;yBAhBC,MAAM,SACJ,qBAAqB,YAClB,IAAI,CAAC,WAAW,EAAE,QAAQ,CAAC;;;;gBAoG2tK,iEAAsB;;;;;;;gBAA2qC,iEAAsB;;;;qBAAkV,iEAAsB;;;;;IAnF9zN,2FAA2F;oBACrE,WAAW,YAAW,IAAI,CAAC,WAAW,EAAE,QAAQ,CAAC;;;;gBAkF2ykD,iEAAsB;;;;;;;gBAA2qC,iEAAsB;;;;qBAAkV,iEAAsB;;;;kBAAq9C,iEAAsB;;IA/E55qD;;;OAGG;wBACuB,MAAM,YAAW,IAAI,CAAC,WAAW,EAAE,QAAQ,CAAC;;;;IAOtE;;;OAGG;iBACgB,MAAM,YAAW,IAAI,CAAC,WAAW,EAAE,QAAQ,CAAC;IAI/D;;;OAGG;cACa,MAAM,YAAW,IAAI,CAAC,WAAW,EAAE,QAAQ,CAAC;;;;gBAwDmsK,iEAAsB;;;;;;;gBAA2qC,iEAAsB;;;;qBAAkV,iEAAsB;;;;;IArD9zN,gGAAgG;wDACvC,iBAAiB;iBAoD86pE,iEAAsB;iBAAsS,iEAAsB;;;IA9C10qE;;;;;;;;OAQG;mBACkB,IAAI,GAAG,YAAY,qCAAqC,aAAa;;;;gBAqCqqK,iEAAsB;;;;;;;gBAA2qC,iEAAsB;;;;qBAAkV,iEAAsB;;;;;CADj0N,CAAC"}