@w6w/sdk 0.5.0 → 0.9.8

package/dist/src/documents.d.ts

@@ -21,7 +21,7 @@
  * @module
  */
 import type { ResolvedConfig } from "./config.ts";
-import { type HttpResponse, type RequestOptions } from "./http.ts";
+import { type CallOptions, type HttpResponse, type RequestOptions } from "./http.ts";
 import { type Doc, type DocFormat } from "./types.ts";
 /**
  * The slice of `W6WClient` this namespace needs: the transport, plus
@@ -41,8 +41,12 @@ export interface DocumentsHost {
  * `project` overrides the client's default for this one call. Omitted
  * everywhere, the server resolves the account's default project; an unknown id
  * is `400 unknown_project`.
+ *
+ * Extends {@linkcode CallOptions}, so every document read also takes an
+ * optional `signal` (R-7) — forwarded by `list`/`get`/`getByKey`; carried on
+ * the mutation methods' options by type only, with no new behaviour there.
  */
-export interface DocumentOptions {
+export interface DocumentOptions extends CallOptions {
     /** Project id to scope this call to. */
     project?: string;
 }
@@ -96,7 +100,7 @@ export declare class DocumentsApi {
     /**
      * List the caller's documents.
      *
-     * @param options - Optional per-call project scope.
+     * @param options - Optional per-call project scope and/or `signal` to abort.
      * @returns The documents, unwrapped from the `documents` envelope.
      * @throws {ApiError} On any non-2xx, e.g. `400 unknown_project`.
      */
@@ -105,7 +109,7 @@ export declare class DocumentsApi {
      * Fetch one document by its server-issued id.
      *
      * @param id - The `doc_…` id.
-     * @param options - Optional per-call project scope.
+     * @param options - Optional per-call project scope and/or `signal` to abort.
      * @returns The document.
      * @throws {ApiError} `404 unknown_document` when there is no such id.
      */
@@ -125,7 +129,7 @@ export declare class DocumentsApi {
      * unreadable through this client.
      *
      * @param key - The document key, sent encoded and otherwise untouched.
-     * @param options - Optional per-call project scope.
+     * @param options - Optional per-call project scope and/or `signal` to abort.
      * @returns The document.
      * @throws {ApiError} `404 unknown_document` when there is no such key.
      */

package/dist/src/documents.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"documents.d.ts","sourceRoot":"","sources":["../../src/documents.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;AAEH,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAClD,OAAO,EAAE,KAAK,YAAY,EAAQ,KAAK,cAAc,EAAE,MAAM,WAAW,CAAC;AACzE,OAAO,EAAE,KAAK,GAAG,EAAE,KAAK,SAAS,EAAU,MAAM,YAAY,CAAC;AAE9D;;;;;GAKG;AACH,MAAM,WAAW,aAAa;IAC5B,0DAA0D;IAC1D,QAAQ,CAAC,MAAM,EAAE,cAAc,CAAC;IAChC,2BAA2B;IAC3B,OAAO,CAAC,CAAC,EAAE,OAAO,EAAE,cAAc,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC;CAC/D;AAED;;;;;;GAMG;AACH,MAAM,WAAW,eAAe;IAC9B,wCAAwC;IACxC,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;;;;GAIG;AACH,MAAM,WAAW,mBAAmB;IAClC,8FAA8F;IAC9F,GAAG,EAAE,MAAM,CAAC;IACZ,kDAAkD;IAClD,OAAO,EAAE,MAAM,CAAC;IAChB,uDAAuD;IACvD,MAAM,CAAC,EAAE,SAAS,CAAC;IACnB,iBAAiB;IACjB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,aAAa;IAC5B,2BAA2B;IAC3B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,+BAA+B;IAC/B,MAAM,CAAC,EAAE,SAAS,CAAC;IACnB,+BAA+B;IAC/B,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;;;;;;;;GASG;AACH,qBAAa,YAAY;;IAGvB;;OAEG;gBACS,IAAI,EAAE,aAAa;IAa/B;;;;;;OAMG;IACG,IAAI,CAAC,OAAO,CAAC,EAAE,eAAe,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC;IASrD;;;;;;;OAOG;IACG,GAAG,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,eAAe,GAAG,OAAO,CAAC,GAAG,CAAC;IAS9D;;;;;;;;;;;;;;;;;;OAkBG;IACG,QAAQ,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,eAAe,GAAG,OAAO,CAAC,GAAG,CAAC;IASpE;;;;;;;OAOG;IACG,MAAM,CAAC,KAAK,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,eAAe,GAAG,OAAO,CAAC,GAAG,CAAC;IAkBjF;;;;;;;;;;OAUG;IACG,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,aAAa,EAAE,OAAO,CAAC,EAAE,eAAe,GAAG,OAAO,CAAC,GAAG,CAAC;IAcvF;;;;;;;;;;;OAWG;IACG,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,eAAe,GAAG,OAAO,CAAC,IAAI,CAAC;CAOnE"}
+{"version":3,"file":"documents.d.ts","sourceRoot":"","sources":["../../src/documents.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;AAEH,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAClD,OAAO,EAAE,KAAK,WAAW,EAAE,KAAK,YAAY,EAAQ,KAAK,cAAc,EAAE,MAAM,WAAW,CAAC;AAC3F,OAAO,EAAE,KAAK,GAAG,EAAE,KAAK,SAAS,EAAU,MAAM,YAAY,CAAC;AAE9D;;;;;GAKG;AACH,MAAM,WAAW,aAAa;IAC5B,0DAA0D;IAC1D,QAAQ,CAAC,MAAM,EAAE,cAAc,CAAC;IAChC,2BAA2B;IAC3B,OAAO,CAAC,CAAC,EAAE,OAAO,EAAE,cAAc,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC;CAC/D;AAED;;;;;;;;;;GAUG;AACH,MAAM,WAAW,eAAgB,SAAQ,WAAW;IAClD,wCAAwC;IACxC,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;;;;GAIG;AACH,MAAM,WAAW,mBAAmB;IAClC,8FAA8F;IAC9F,GAAG,EAAE,MAAM,CAAC;IACZ,kDAAkD;IAClD,OAAO,EAAE,MAAM,CAAC;IAChB,uDAAuD;IACvD,MAAM,CAAC,EAAE,SAAS,CAAC;IACnB,iBAAiB;IACjB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,aAAa;IAC5B,2BAA2B;IAC3B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,+BAA+B;IAC/B,MAAM,CAAC,EAAE,SAAS,CAAC;IACnB,+BAA+B;IAC/B,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;;;;;;;;GASG;AACH,qBAAa,YAAY;;IAGvB;;OAEG;gBACS,IAAI,EAAE,aAAa;IAa/B;;;;;;OAMG;IACG,IAAI,CAAC,OAAO,CAAC,EAAE,eAAe,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC;IAUrD;;;;;;;OAOG;IACG,GAAG,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,eAAe,GAAG,OAAO,CAAC,GAAG,CAAC;IAU9D;;;;;;;;;;;;;;;;;;OAkBG;IACG,QAAQ,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,eAAe,GAAG,OAAO,CAAC,GAAG,CAAC;IAUpE;;;;;;;OAOG;IACG,MAAM,CAAC,KAAK,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,eAAe,GAAG,OAAO,CAAC,GAAG,CAAC;IAkBjF;;;;;;;;;;OAUG;IACG,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,aAAa,EAAE,OAAO,CAAC,EAAE,eAAe,GAAG,OAAO,CAAC,GAAG,CAAC;IAcvF;;;;;;;;;;;OAWG;IACG,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,eAAe,GAAG,OAAO,CAAC,IAAI,CAAC;CAOnE"}

package/dist/src/documents.js

@@ -51,7 +51,7 @@ export class DocumentsApi {
     /**
      * List the caller's documents.
      *
-     * @param options - Optional per-call project scope.
+     * @param options - Optional per-call project scope and/or `signal` to abort.
      * @returns The documents, unwrapped from the `documents` envelope.
      * @throws {ApiError} On any non-2xx, e.g. `400 unknown_project`.
      */
@@ -60,6 +60,7 @@ export class DocumentsApi {
             method: "GET",
             path: "/documents",
             query: { project: this.#project(options) },
+            signal: options?.signal,
         });
         return unwrap(res, "documents");
     }
@@ -67,7 +68,7 @@ export class DocumentsApi {
      * Fetch one document by its server-issued id.
      *
      * @param id - The `doc_…` id.
-     * @param options - Optional per-call project scope.
+     * @param options - Optional per-call project scope and/or `signal` to abort.
      * @returns The document.
      * @throws {ApiError} `404 unknown_document` when there is no such id.
      */
@@ -76,6 +77,7 @@ export class DocumentsApi {
             method: "GET",
             path: path `/documents/${id}`,
             query: { project: this.#project(options) },
+            signal: options?.signal,
         });
         return unwrap(res, "document");
     }
@@ -94,7 +96,7 @@ export class DocumentsApi {
      * unreadable through this client.
      *
      * @param key - The document key, sent encoded and otherwise untouched.
-     * @param options - Optional per-call project scope.
+     * @param options - Optional per-call project scope and/or `signal` to abort.
      * @returns The document.
      * @throws {ApiError} `404 unknown_document` when there is no such key.
      */
@@ -103,6 +105,7 @@ export class DocumentsApi {
             method: "GET",
             path: path `/documents/by-key/${key}`,
             query: { project: this.#project(options) },
+            signal: options?.signal,
         });
         return unwrap(res, "document");
     }

package/dist/src/documents.js.map

@@ -1 +1 @@
-{"version":3,"file":"documents.js","sourceRoot":"","sources":["../../src/documents.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;AAGH,OAAO,EAAqB,IAAI,EAAuB,MAAM,WAAW,CAAC;AACzE,OAAO,EAA4B,MAAM,EAAE,MAAM,YAAY,CAAC;AA4D9D;;;;;;;;;GASG;AACH,MAAM,OAAO,YAAY;IACd,KAAK,CAAgB;IAE9B;;OAEG;IACH,YAAY,IAAmB;QAC7B,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;IACpB,CAAC;IAED;;;;OAIG;IACH,QAAQ,CAAC,OAAyB;QAChC,OAAO,OAAO,EAAE,OAAO,IAAI,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,OAAO,IAAI,SAAS,CAAC;IACpE,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,IAAI,CAAC,OAAyB;QAClC,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,OAAO,CAAU;YAC5C,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,YAAY;YAClB,KAAK,EAAE,EAAE,OAAO,EAAE,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE;SAC3C,CAAC,CAAC;QACH,OAAO,MAAM,CAAQ,GAAG,EAAE,WAAW,CAAC,CAAC;IACzC,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,GAAG,CAAC,EAAU,EAAE,OAAyB;QAC7C,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,OAAO,CAAU;YAC5C,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,IAAI,CAAA,cAAc,EAAE,EAAE;YAC5B,KAAK,EAAE,EAAE,OAAO,EAAE,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE;SAC3C,CAAC,CAAC;QACH,OAAO,MAAM,CAAM,GAAG,EAAE,UAAU,CAAC,CAAC;IACtC,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,KAAK,CAAC,QAAQ,CAAC,GAAW,EAAE,OAAyB;QACnD,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,OAAO,CAAU;YAC5C,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,IAAI,CAAA,qBAAqB,GAAG,EAAE;YACpC,KAAK,EAAE,EAAE,OAAO,EAAE,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE;SAC3C,CAAC,CAAC;QACH,OAAO,MAAM,CAAM,GAAG,EAAE,UAAU,CAAC,CAAC;IACtC,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,MAAM,CAAC,KAA0B,EAAE,OAAyB;QAChE,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,OAAO,CAAU;YAC5C,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,YAAY;YAClB,KAAK,EAAE,EAAE,OAAO,EAAE,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE;YAC1C,0EAA0E;YAC1E,0EAA0E;YAC1E,0CAA0C;YAC1C,IAAI,EAAE;gBACJ,GAAG,EAAE,KAAK,CAAC,GAAG;gBACd,OAAO,EAAE,KAAK,CAAC,OAAO;gBACtB,MAAM,EAAE,KAAK,CAAC,MAAM;gBACpB,WAAW,EAAE,KAAK,CAAC,WAAW;aAC/B;SACF,CAAC,CAAC;QACH,OAAO,MAAM,CAAM,GAAG,EAAE,UAAU,CAAC,CAAC;IACtC,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,MAAM,CAAC,EAAU,EAAE,KAAoB,EAAE,OAAyB;QACtE,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,OAAO,CAAU;YAC5C,MAAM,EAAE,OAAO;YACf,IAAI,EAAE,IAAI,CAAA,cAAc,EAAE,EAAE;YAC5B,KAAK,EAAE,EAAE,OAAO,EAAE,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE;YAC1C,IAAI,EAAE;gBACJ,OAAO,EAAE,KAAK,CAAC,OAAO;gBACtB,MAAM,EAAE,KAAK,CAAC,MAAM;gBACpB,WAAW,EAAE,KAAK,CAAC,WAAW;aAC/B;SACF,CAAC,CAAC;QACH,OAAO,MAAM,CAAM,GAAG,EAAE,UAAU,CAAC,CAAC;IACtC,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,MAAM,CAAC,EAAU,EAAE,OAAyB;QAChD,MAAM,IAAI,CAAC,KAAK,CAAC,OAAO,CAAU;YAChC,MAAM,EAAE,QAAQ;YAChB,IAAI,EAAE,IAAI,CAAA,cAAc,EAAE,EAAE;YAC5B,KAAK,EAAE,EAAE,OAAO,EAAE,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE;SAC3C,CAAC,CAAC;IACL,CAAC;CACF"}
+{"version":3,"file":"documents.js","sourceRoot":"","sources":["../../src/documents.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;AAGH,OAAO,EAAuC,IAAI,EAAuB,MAAM,WAAW,CAAC;AAC3F,OAAO,EAA4B,MAAM,EAAE,MAAM,YAAY,CAAC;AAgE9D;;;;;;;;;GASG;AACH,MAAM,OAAO,YAAY;IACd,KAAK,CAAgB;IAE9B;;OAEG;IACH,YAAY,IAAmB;QAC7B,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;IACpB,CAAC;IAED;;;;OAIG;IACH,QAAQ,CAAC,OAAyB;QAChC,OAAO,OAAO,EAAE,OAAO,IAAI,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,OAAO,IAAI,SAAS,CAAC;IACpE,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,IAAI,CAAC,OAAyB;QAClC,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,OAAO,CAAU;YAC5C,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,YAAY;YAClB,KAAK,EAAE,EAAE,OAAO,EAAE,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE;YAC1C,MAAM,EAAE,OAAO,EAAE,MAAM;SACxB,CAAC,CAAC;QACH,OAAO,MAAM,CAAQ,GAAG,EAAE,WAAW,CAAC,CAAC;IACzC,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,GAAG,CAAC,EAAU,EAAE,OAAyB;QAC7C,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,OAAO,CAAU;YAC5C,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,IAAI,CAAA,cAAc,EAAE,EAAE;YAC5B,KAAK,EAAE,EAAE,OAAO,EAAE,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE;YAC1C,MAAM,EAAE,OAAO,EAAE,MAAM;SACxB,CAAC,CAAC;QACH,OAAO,MAAM,CAAM,GAAG,EAAE,UAAU,CAAC,CAAC;IACtC,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,KAAK,CAAC,QAAQ,CAAC,GAAW,EAAE,OAAyB;QACnD,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,OAAO,CAAU;YAC5C,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,IAAI,CAAA,qBAAqB,GAAG,EAAE;YACpC,KAAK,EAAE,EAAE,OAAO,EAAE,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE;YAC1C,MAAM,EAAE,OAAO,EAAE,MAAM;SACxB,CAAC,CAAC;QACH,OAAO,MAAM,CAAM,GAAG,EAAE,UAAU,CAAC,CAAC;IACtC,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,MAAM,CAAC,KAA0B,EAAE,OAAyB;QAChE,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,OAAO,CAAU;YAC5C,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,YAAY;YAClB,KAAK,EAAE,EAAE,OAAO,EAAE,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE;YAC1C,0EAA0E;YAC1E,0EAA0E;YAC1E,0CAA0C;YAC1C,IAAI,EAAE;gBACJ,GAAG,EAAE,KAAK,CAAC,GAAG;gBACd,OAAO,EAAE,KAAK,CAAC,OAAO;gBACtB,MAAM,EAAE,KAAK,CAAC,MAAM;gBACpB,WAAW,EAAE,KAAK,CAAC,WAAW;aAC/B;SACF,CAAC,CAAC;QACH,OAAO,MAAM,CAAM,GAAG,EAAE,UAAU,CAAC,CAAC;IACtC,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,MAAM,CAAC,EAAU,EAAE,KAAoB,EAAE,OAAyB;QACtE,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,OAAO,CAAU;YAC5C,MAAM,EAAE,OAAO;YACf,IAAI,EAAE,IAAI,CAAA,cAAc,EAAE,EAAE;YAC5B,KAAK,EAAE,EAAE,OAAO,EAAE,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE;YAC1C,IAAI,EAAE;gBACJ,OAAO,EAAE,KAAK,CAAC,OAAO;gBACtB,MAAM,EAAE,KAAK,CAAC,MAAM;gBACpB,WAAW,EAAE,KAAK,CAAC,WAAW;aAC/B;SACF,CAAC,CAAC;QACH,OAAO,MAAM,CAAM,GAAG,EAAE,UAAU,CAAC,CAAC;IACtC,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,MAAM,CAAC,EAAU,EAAE,OAAyB;QAChD,MAAM,IAAI,CAAC,KAAK,CAAC,OAAO,CAAU;YAChC,MAAM,EAAE,QAAQ;YAChB,IAAI,EAAE,IAAI,CAAA,cAAc,EAAE,EAAE;YAC5B,KAAK,EAAE,EAAE,OAAO,EAAE,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE;SAC3C,CAAC,CAAC;IACL,CAAC;CACF"}

package/dist/src/endpoints.d.ts

@@ -0,0 +1,75 @@
+/**
+ * `client.endpoints.*` — run an Endpoint by the key you gave it.
+ *
+ * An Endpoint is a callable entry point that dispatches to whatever it targets:
+ * an app action, a Function, or a Workflow. Before this namespace existed,
+ * calling one meant `client.run({ urn: "ep_…" })` — an opaque id, buried inside
+ * an object, for an Endpoint the user named `send-email`. Now:
+ *
+ * ```ts
+ * await client.endpoints.run("send-email", { payload: { to, subject } });
+ * ```
+ *
+ * The name is the FIRST argument, matching `workflows.run` and `functions.run`,
+ * so all three runnable kinds read alike.
+ *
+ * ID OR KEY, one argument: `/endpoints/{idOrKey}/invoke` accepts either, because
+ * an id carries a kind prefix (and so an underscore) while a key is kebab-case
+ * (which forbids one). No flag, no prefix — pass whichever you have.
+ *
+ * UNLIKE `functions.run`, THIS RETURNS AN ENVELOPE, and that asymmetry is the
+ * honest one: a Function's kind is settled by the method name, but an Endpoint
+ * dispatches to one of three things and the caller genuinely does not know which
+ * answered. The `kind` discriminant is information here, not ceremony — and the
+ * Workflow arm is asynchronous (`202`, a `runId`) where the other two are not.
+ */
+import type { ResolvedConfig } from "./config.ts";
+import { type HttpResponse, type RequestOptions } from "./http.ts";
+import type { RunEnvelope } from "./types.ts";
+/**
+ * What this namespace needs from the client — the same narrow seam
+ * `WorkflowsApi` and `FunctionsApi` take.
+ */
+export interface EndpointsHost {
+    /** The resolved configuration. */
+    readonly config: ResolvedConfig;
+    /** Perform one request. */
+    request<T>(options: RequestOptions): Promise<HttpResponse<T>>;
+}
+/** Per-call options for `endpoints.run`. */
+export interface EndpointRunOptions {
+    /**
+     * The Endpoint's input, by input key.
+     *
+     * Named `payload` for the same reason as `functions.run`: one word across
+     * every runnable kind, even though the wire spells this one `input`.
+     */
+    payload?: Record<string, unknown>;
+}
+/**
+ * The `endpoints` namespace on a `W6WClient`.
+ *
+ * @example
+ * ```ts
+ * const envelope = await client.endpoints.run("send-email", { payload: { to } });
+ * if (envelope.kind === "workflow") console.log(envelope.runId); // async arm
+ * ```
+ */
+export declare class EndpointsApi {
+    #private;
+    /**
+     * @param host - The client this namespace issues requests through.
+     */
+    constructor(host: EndpointsHost);
+    /**
+     * Run one Endpoint; the envelope's `kind` says which arm answered.
+     *
+     * @param name - The Endpoint's key (`"send-email"`) or its `ep_…` id. Percent-encoded into the path.
+     * @param options - `payload`, the Endpoint's input.
+     * @returns The `kind`-discriminated envelope, returned exactly as it arrived.
+     * @throws {ApiError} `404 unknown_endpoint` when no Endpoint of that name exists for the caller.
+     * @throws {ApiError} `bad_response` when a success body carries no string `kind`.
+     */
+    run(name: string, options?: EndpointRunOptions): Promise<RunEnvelope>;
+}
+//# sourceMappingURL=endpoints.d.ts.map

package/dist/src/endpoints.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"endpoints.d.ts","sourceRoot":"","sources":["../../src/endpoints.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAElD,OAAO,EAAE,KAAK,YAAY,EAAQ,KAAK,cAAc,EAAE,MAAM,WAAW,CAAC;AACzE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAE9C;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC5B,kCAAkC;IAClC,QAAQ,CAAC,MAAM,EAAE,cAAc,CAAC;IAChC,2BAA2B;IAC3B,OAAO,CAAC,CAAC,EAAE,OAAO,EAAE,cAAc,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC;CAC/D;AAED,4CAA4C;AAC5C,MAAM,WAAW,kBAAkB;IACjC;;;;;OAKG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACnC;AAED;;;;;;;;GAQG;AACH,qBAAa,YAAY;;IAGvB;;OAEG;gBACS,IAAI,EAAE,aAAa;IAI/B;;;;;;;;OAQG;IACG,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,WAAW,CAAC;CAyB5E"}

package/dist/src/endpoints.js

@@ -0,0 +1,47 @@
+import { ApiError } from "./errors.js";
+import { path } from "./http.js";
+/**
+ * The `endpoints` namespace on a `W6WClient`.
+ *
+ * @example
+ * ```ts
+ * const envelope = await client.endpoints.run("send-email", { payload: { to } });
+ * if (envelope.kind === "workflow") console.log(envelope.runId); // async arm
+ * ```
+ */
+export class EndpointsApi {
+    #host;
+    /**
+     * @param host - The client this namespace issues requests through.
+     */
+    constructor(host) {
+        this.#host = host;
+    }
+    /**
+     * Run one Endpoint; the envelope's `kind` says which arm answered.
+     *
+     * @param name - The Endpoint's key (`"send-email"`) or its `ep_…` id. Percent-encoded into the path.
+     * @param options - `payload`, the Endpoint's input.
+     * @returns The `kind`-discriminated envelope, returned exactly as it arrived.
+     * @throws {ApiError} `404 unknown_endpoint` when no Endpoint of that name exists for the caller.
+     * @throws {ApiError} `bad_response` when a success body carries no string `kind`.
+     */
+    async run(name, options) {
+        const res = await this.#host.request({
+            method: "POST",
+            path: path `/endpoints/${name}/invoke`,
+            body: { input: options?.payload ?? {} },
+        });
+        const body = res.body;
+        // The same guard `run.ts` applies, for the same reason: an object-only
+        // check lets `{}` and `[]` through and hands back an envelope whose `kind`
+        // is `undefined` at runtime — a lie the compiler cannot catch.
+        if (typeof body !== "object" || body === null ||
+            typeof body.kind !== "string") {
+            throw new ApiError(res.status, "bad_response", `Server returned a ${res.status} with no "kind" in the response body.`, body);
+        }
+        // Returned as it arrived — an unknown `kind` reaches the caller intact.
+        return body;
+    }
+}
+//# sourceMappingURL=endpoints.js.map

package/dist/src/endpoints.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"endpoints.js","sourceRoot":"","sources":["../../src/endpoints.ts"],"names":[],"mappings":"AA0BA,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AACvC,OAAO,EAAqB,IAAI,EAAuB,MAAM,WAAW,CAAC;AAyBzE;;;;;;;;GAQG;AACH,MAAM,OAAO,YAAY;IACd,KAAK,CAAgB;IAE9B;;OAEG;IACH,YAAY,IAAmB;QAC7B,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;IACpB,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,GAAG,CAAC,IAAY,EAAE,OAA4B;QAClD,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,OAAO,CAAU;YAC5C,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,IAAI,CAAA,cAAc,IAAI,SAAS;YACrC,IAAI,EAAE,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,IAAI,EAAE,EAAE;SACxC,CAAC,CAAC;QAEH,MAAM,IAAI,GAAG,GAAG,CAAC,IAAI,CAAC;QACtB,uEAAuE;QACvE,2EAA2E;QAC3E,+DAA+D;QAC/D,IACE,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,KAAK,IAAI;YACzC,OAAQ,IAA2B,CAAC,IAAI,KAAK,QAAQ,EACrD,CAAC;YACD,MAAM,IAAI,QAAQ,CAChB,GAAG,CAAC,MAAM,EACV,cAAc,EACd,qBAAqB,GAAG,CAAC,MAAM,uCAAuC,EACtE,IAAI,CACL,CAAC;QACJ,CAAC;QACD,wEAAwE;QACxE,OAAO,IAAmB,CAAC;IAC7B,CAAC;CACF"}

package/dist/src/functions.d.ts

@@ -0,0 +1,236 @@
+/**
+ * `client.functions.*` — run a Function by the name you gave it.
+ *
+ * A Function is a canonical, vendor-stable interface bound to one swappable app
+ * Action. Before this namespace existed, calling one meant the URN operation:
+ *
+ * ```ts
+ * await client.run({ urn: "fn_a9b39917-cd4e-4eea-ab89-c3d079684193", payload });
+ * ```
+ *
+ * — an opaque id, buried inside an object, for a Function the user named
+ * `send-email`. `client.run` is still the right tool when the caller is
+ * *dispatching* something whose kind it does not know; it is the wrong tool for
+ * "call my send-email Function", which is what this is:
+ *
+ * ```ts
+ * await client.functions.run("send-email", { payload: { to, subject, html } });
+ * ```
+ *
+ * The name is the FIRST argument, matching `workflows.run(id, opts?)` — the
+ * namespace already shaped this way — so all three runnable kinds read alike.
+ *
+ * ── The rest of the namespace ──
+ * `list`, `get`, `create`, `update` and `delete` complete the definition
+ * lifecycle, mirroring `client.workflows.*` op for op with two differences the
+ * server dictates, not this package: there is no `?project=` anywhere on this
+ * domain, and there is no archive step before `delete`.
+ *
+ * The server has ONE write route (`POST /functions`, an upsert), so `create`
+ * and `update` are the same request shaped differently — `create` mints the
+ * required `id`, `update` pins the one you addressed — and `update` is a full
+ * replacement rather than a patch.
+ *
+ * ID OR KEY, one argument. The server's `/functions/{idOrKey}/invoke` accepts
+ * either, because the two shapes cannot collide: an id carries a kind prefix and
+ * therefore an underscore, and a key is kebab-case, which forbids one. So this
+ * takes no flag and no prefix to say which you meant — pass whichever you have.
+ */
+import type { ResolvedConfig } from "./config.ts";
+import { type CallOptions, type HttpResponse, type RequestOptions } from "./http.ts";
+import { type FunctionSummary } from "./types.ts";
+/**
+ * What this namespace needs from the client — the same narrow seam
+ * `WorkflowsApi` takes, so it is constructible in a test and this module never
+ * imports the client back.
+ */
+export interface FunctionsHost {
+    /** The resolved configuration. */
+    readonly config: ResolvedConfig;
+    /** Perform one request. */
+    request<T>(options: RequestOptions): Promise<HttpResponse<T>>;
+}
+/** Per-call options for `functions.run`. */
+export interface FunctionRunOptions {
+    /**
+     * The Function's canonical inputs, by input key.
+     *
+     * Named `payload` rather than `inputs` so every runnable kind in this SDK
+     * takes the same word — the wire spells it `inputs` for a Function and
+     * `input` for an Endpoint, and reconciling that is exactly the job of a
+     * wrapper. Defaults to `{}` rather than being omitted: the server's parameter
+     * schemas are written against an object, and `{}` says "no input" where an
+     * absent key says "I forgot".
+     */
+    payload?: Record<string, unknown>;
+}
+/**
+ * A Function definition — kept OPAQUE, for the same reason `WorkflowDefinition`
+ * (`./workflows.ts`) is.
+ *
+ * The interesting field is `impl`, and it is a union the server extends: an app
+ * Action today, another Function or a Workflow since D-8 (`rfcs/function.md`).
+ * A wrapper that modelled it would reject an arm a newer server accepts, and
+ * the whole point of a Function is that `impl` is the part you swap. Callers
+ * bind to `inputs`/`output`; this package carries the definition, it does not
+ * interpret it.
+ *
+ * The one field read here is `id`, in {@linkcode FunctionsApi.create}.
+ */
+export type FunctionDefinition = Record<string, unknown>;
+/** What `functions.get` returns: the stored definition, plus the server's own verdict on it. */
+export interface FunctionDetail {
+    /** The stored definition, verbatim. */
+    function: FunctionDefinition;
+    /**
+     * Whether the Function can be run — **a top-level sibling, never a field
+     * inside `function`**, and this method keeps it there rather than splicing
+     * it in. It is computed per request, it is not part of the stored document
+     * (`rfcs/function.md`), and folding it into the definition would put it in
+     * the object a caller sends back to {@linkcode FunctionsApi.update}.
+     */
+    valid: boolean;
+}
+/**
+ * The `functions` namespace on a `W6WClient`.
+ *
+ * @example
+ * ```ts
+ * const output = await client.functions.run("send-email", {
+ *   payload: { to: "ada@example.com", subject: "Hi", html: "<p>Hello</p>" },
+ * });
+ *
+ * // The definition lifecycle.
+ * const fns = await client.functions.list();
+ * const { function: def } = await client.functions.get(fns[0].id);
+ * await client.functions.update(fns[0].id, { ...def, description: "Send an email" });
+ * ```
+ */
+export declare class FunctionsApi {
+    #private;
+    /**
+     * @param host - The client this namespace issues requests through.
+     */
+    constructor(host: FunctionsHost);
+    /**
+     * Run one Function and return its output.
+     *
+     * Returns the Function's OUTPUT, not an envelope. `client.run` returns a
+     * `kind`-discriminated envelope because the caller does not know what the URN
+     * will resolve to; here the kind is in the method name, so the discriminant
+     * would be a field the caller has to unwrap to learn nothing.
+     *
+     * @param name - The Function's key (`"send-email"`) or its `fn_…` id. Percent-encoded into the path.
+     * @param options - `payload`, the Function's canonical inputs.
+     * @returns The Function's output, unwrapped from the `output` envelope.
+     * @throws {ApiError} `404 unknown_function` when no Function of that name exists for the caller.
+     * @throws {ApiError} `422 function_incomplete` when the Function has no runnable `impl`.
+     * @throws {ApiError} `bad_response` when a success body carries no `output` key at all.
+     */
+    run(name: string, options?: FunctionRunOptions): Promise<unknown>;
+    /**
+     * List the caller's Function definitions.
+     *
+     * This is how a caller discovers a `key` to pass to {@linkcode run} — the
+     * same job `workflows.list` and `connections.list` do for their own ids (D4),
+     * and the reason a read-only integration needs no other write access.
+     *
+     * Each row already carries `valid`, computed server-side; there is no second
+     * call to make to find out whether a Function is runnable.
+     *
+     * **No `project` parameter.** Unlike workflows and documents, the route reads
+     * no `?project=` at all (`admin/functions.ts`) — sending one would be
+     * inventing a parameter, which is the failure mode `endpoints.json` warns
+     * about.
+     *
+     * @param options - Optional per-call transport options (`signal` to abort).
+     * @returns The Functions, unwrapped from the `functions` envelope.
+     * @throws {ApiError} On any non-2xx.
+     */
+    list(options?: CallOptions): Promise<FunctionSummary[]>;
+    /**
+     * Fetch one Function's stored definition.
+     *
+     * Returns the whole body — `{function, valid}` — rather than splicing `valid`
+     * into the definition. See {@linkcode FunctionDetail.valid} for why that
+     * placement matters on the way back OUT of this method.
+     *
+     * @param id - The `fn_…` id, or the Function's `key`. Percent-encoded into the path.
+     * @param options - Optional per-call transport options (`signal` to abort).
+     * @returns The definition and the server's runnability verdict.
+     * @throws {ApiError} `404 unknown_function` when there is no such Function for this caller.
+     */
+    get(id: string, options?: CallOptions): Promise<FunctionDetail>;
+    /**
+     * Create a Function.
+     *
+     * **The id is minted client-side when the definition does not carry one** —
+     * `POST /functions` requires `id` and never generates one, exactly as the
+     * workflow route does. `key` is NOT minted: it is the name the Function is
+     * called by, so it is the caller's to choose, and the server validates it on
+     * first save only (3–39 chars, lowercase, single hyphens, no `_`). That
+     * grammar is what keeps `/functions/{idOrKey}/invoke` unambiguous — a key
+     * containing `_` could be mistaken for an `fn_…` id.
+     *
+     * `create` and {@linkcode update} reach the SAME upsert route; posting a
+     * definition whose id already exists overwrites it.
+     *
+     * @param definition - The whole Function definition, forwarded verbatim apart from a minted `id`.
+     * @returns The new Function's id and key.
+     * @throws {ApiError} `400 invalid_function` — no `key`, no `inputs` array, or a malformed `impl`.
+     * @throws {ApiError} `409 function_conflict` — another `(tenant, subject)` already owns that id.
+     * @throws {ApiError} `409 function_key_conflict` — that `key` is already taken in this scope.
+     */
+    create(definition: FunctionDefinition): Promise<{
+        id: string;
+        key: string;
+    }>;
+    /**
+     * Overwrite a Function's stored definition.
+     *
+     * **A full replacement, not a patch** — the server has one write route and it
+     * stores what it is given, so read with {@linkcode get}, change what you mean
+     * to change, and send the whole thing back. There is no concurrency
+     * precondition on this route (workflows have one; Functions do not), so the
+     * write is last-write-wins.
+     *
+     * `id` comes from the FIRST ARGUMENT and is pinned into the body, overriding
+     * any `id` the definition carries — otherwise `update("fn_a", defOfB)` would
+     * quietly write to B.
+     *
+     * Do not send back the `valid` field: it is not part of the stored document,
+     * and {@linkcode get} deliberately leaves it outside the definition so that
+     * a read-modify-write round trip cannot pick it up by accident.
+     *
+     * @param id - The `fn_…` id to write to.
+     * @param definition - The whole replacement definition.
+     * @returns The Function's id and key.
+     * @throws {ApiError} `400 invalid_function` — structurally invalid body.
+     * @throws {ApiError} `409 function_conflict` — another `(tenant, subject)` owns this id.
+     * @throws {ApiError} `409 function_key_conflict` — the new `key` is already taken in this scope.
+     */
+    update(id: string, definition: FunctionDefinition): Promise<{
+        id: string;
+        key: string;
+    }>;
+    /**
+     * Delete a Function.
+     *
+     * Not idempotent, and deliberately so: deleting an id that is not there is
+     * `404 unknown_function`, not a silent success — the same pin
+     * `documents.delete` carries.
+     *
+     * **Nothing checks for callers first.** A Function may be referenced by an
+     * Endpoint, by a Workflow step, or by another Function's `impl` (D-8), and
+     * the server does not walk those references; they break at call time. Deleting
+     * a Function that something else calls is the caller's decision to get right.
+     *
+     * Returns nothing: the server's `{ok: true}` carries no information a caller
+     * can use (`docs/implementation.md` §5).
+     *
+     * @param id - The `fn_…` id, or the Function's `key`.
+     * @throws {ApiError} `404 unknown_function` when there is no such Function for this caller.
+     */
+    delete(id: string): Promise<void>;
+}
+//# sourceMappingURL=functions.d.ts.map

package/dist/src/functions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"functions.d.ts","sourceRoot":"","sources":["../../src/functions.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqCG;AACH,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAElD,OAAO,EAAE,KAAK,WAAW,EAAE,KAAK,YAAY,EAAQ,KAAK,cAAc,EAAE,MAAM,WAAW,CAAC;AAC3F,OAAO,EAAE,KAAK,eAAe,EAAkB,MAAM,YAAY,CAAC;AAElE;;;;GAIG;AACH,MAAM,WAAW,aAAa;IAC5B,kCAAkC;IAClC,QAAQ,CAAC,MAAM,EAAE,cAAc,CAAC;IAChC,2BAA2B;IAC3B,OAAO,CAAC,CAAC,EAAE,OAAO,EAAE,cAAc,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC;CAC/D;AAED,4CAA4C;AAC5C,MAAM,WAAW,kBAAkB;IACjC;;;;;;;;;OASG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACnC;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,MAAM,kBAAkB,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AAEzD,gGAAgG;AAChG,MAAM,WAAW,cAAc;IAC7B,uCAAuC;IACvC,QAAQ,EAAE,kBAAkB,CAAC;IAC7B;;;;;;OAMG;IACH,KAAK,EAAE,OAAO,CAAC;CAChB;AAED;;;;;;;;;;;;;;GAcG;AACH,qBAAa,YAAY;;IAGvB;;OAEG;gBACS,IAAI,EAAE,aAAa;IAI/B;;;;;;;;;;;;;;OAcG;IACG,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,OAAO,CAAC;IA0BvE;;;;;;;;;;;;;;;;;;OAkBG;IACG,IAAI,CAAC,OAAO,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,eAAe,EAAE,CAAC;IAS7D;;;;;;;;;;;OAWG;IACG,GAAG,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,cAAc,CAAC;IASrE;;;;;;;;;;;;;;;;;;;OAmBG;IACG,MAAM,CAAC,UAAU,EAAE,kBAAkB,GAAG,OAAO,CAAC;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,GAAG,EAAE,MAAM,CAAA;KAAE,CAAC;IAOlF;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACG,MAAM,CACV,EAAE,EAAE,MAAM,EACV,UAAU,EAAE,kBAAkB,GAC7B,OAAO,CAAC;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,GAAG,EAAE,MAAM,CAAA;KAAE,CAAC;IAIvC;;;;;;;;;;;;;;;;;OAiBG;IACG,MAAM,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAsBxC"}