@w6w/sdk 0.4.0 → 0.6.0

package/dist/src/console/passkeys.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"passkeys.d.ts","sourceRoot":"","sources":["../../../src/console/passkeys.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsDG;AAEH,OAAO,EAAE,KAAK,YAAY,EAAQ,KAAK,cAAc,EAAE,MAAM,YAAY,CAAC;AAG1E;;;;;GAKG;AACH,MAAM,WAAW,YAAY;IAC3B,2BAA2B;IAC3B,OAAO,CAAC,CAAC,EAAE,OAAO,EAAE,cAAc,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC;CAC/D;AAED;;;;GAIG;AACH,MAAM,WAAW,OAAO;IACtB,wBAAwB;IACxB,EAAE,EAAE,MAAM,CAAC;IACX,8EAA8E;IAC9E,KAAK,EAAE,MAAM,CAAC;IACd,0BAA0B;IAC1B,SAAS,EAAE,MAAM,CAAC;IAClB,wFAAwF;IACxF,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,yFAAyF;IACzF,UAAU,EAAE,MAAM,EAAE,CAAC;CACtB;AAED;;;;;GAKG;AACH,MAAM,WAAW,sBAAsB;IACrC;;;;OAIG;IACH,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACjC,0EAA0E;IAC1E,cAAc,EAAE,MAAM,CAAC;CACxB;AAED,6FAA6F;AAC7F,MAAM,WAAW,uBAAuB;IACtC,qEAAqE;IACrE,cAAc,EAAE,MAAM,CAAC;IACvB;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAClC,+CAA+C;IAC/C,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,yGAAyG;AACzG,MAAM,WAAW,yBAAyB;IACxC,uEAAuE;IACvE,cAAc,EAAE,MAAM,CAAC;IACvB;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACnC;AAED;;;;;;GAMG;AACH,MAAM,WAAW,WAAW;IAC1B,kEAAkE;IAClE,QAAQ,EAAE,MAAM,CAAC;IACjB,uEAAuE;IACvE,IAAI,EAAE,MAAM,CAAC;IACb,2CAA2C;IAC3C,MAAM,EAAE,MAAM,CAAC;IACf,aAAa,EAAE,OAAO,CAAC;CACxB;AAED;;;;;GAKG;AACH,MAAM,WAAW,mCAAmC;IAClD,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,WAAW,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,qBAAa,WAAW;;IAGtB;;OAEG;gBACS,IAAI,EAAE,YAAY;IAI9B;;;;;;;OAOG;IACG,mBAAmB,IAAI,OAAO,CAAC,sBAAsB,CAAC;IAS5D;;;;;;;;;;OAUG;IACG,kBAAkB,CAAC,KAAK,EAAE,uBAAuB,GAAG,OAAO,CAAC,OAAO,CAAC;IAS1E;;;;;;;;;;;;;OAaG;IACG,qBAAqB,IAAI,OAAO,CAAC,sBAAsB,CAAC;IAU9D;;;;;;;;;;;;;;OAcG;IACG,oBAAoB,CACxB,KAAK,EAAE,yBAAyB,GAC/B,OAAO,CAAC,mCAAmC,CAAC;IAU/C;;;;;;;OAOG;IACG,IAAI,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;IAKhC;;;;;;;;OAQG;IACG,MAAM,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAGxC"}

package/dist/src/console/passkeys.js

@@ -0,0 +1,192 @@
+/**
+ * `client.console.passkeys.*` — WebAuthn passkey management and login for
+ * self-serve Studio users (T1.1.5).
+ *
+ * **Studio-internal, not the published partner contract.** This namespace
+ * lives under the `console` subpath export (`@w6w/sdk/console`), excluded from
+ * `endpoints.json` and from the root barrel (`mod.ts`) — see `docs/console.md`
+ * and HITL-1 in this task's contract. `@w6w/sdk`'s instance-state mechanism
+ * pin still applies here exactly as it does to every other namespace
+ * (`docs/implementation.md` §MECHANISM PIN — instance state, never globals):
+ * this class holds no state of its own beyond the injected host, so two
+ * clients in one process never share a credential.
+ *
+ * **Who this is for (HITL-3).** Passkeys belong to self-serve Studio users
+ * only; a partner-tenant user's IdP owns its identity. No eligibility logic
+ * lives here — the server enforces it (`PasskeyNotEligibleError`), and this
+ * module is a plain transport shim over whatever it decides.
+ *
+ * **Two routes, four methods, split by who is authenticated.** The management
+ * quartet (`registrationOptions`, `registrationVerify`, `list`, `revoke`) is
+ * GUARDED, mirroring `packages/server/packages/api/data/passkeys.ts`'s own
+ * doc comment ("Registered BELOW the auth guard"). The login pair
+ * (`authenticationOptions`, `authenticationVerify`) is PUBLIC, mirroring
+ * `packages/server/packages/api/id/passkey-login.ts`'s own doc comment ("BOTH
+ * routes are PUBLIC and UNAUTHENTICATED by construction") — discoverable
+ * credentials, no identifier in the request body (P1). Each of those two
+ * methods passes `requireAuth: false`, the same mechanism
+ * `console.auth.login`/`signup`/`checkAccountSlug` rely on: without it a
+ * tokenless client (the normal case at the login screen, before any session
+ * exists) would hit `requireToken`'s `ConfigError` before `fetch` is ever
+ * called.
+ *
+ * **`authenticationVerify` mints a session, the same way `login` does
+ * (HITL-5).** A verified passkey assertion is a standalone alternative to a
+ * password, not a second factor — so its response is token-bearing, exactly
+ * like `console.auth.login`'s. It is a SEPARATE type from `LoginResponse`
+ * (`./auth.ts`), not a reuse: the server route is byte-shape-identical to
+ * `user-login.ts`'s login body (`id/passkey-login.ts`'s own doc comment) which
+ * carries `role`, `tenant` and `emailVerified` on `user` — fields
+ * `console.auth`'s `LoginResponse.user` does not declare.
+ *
+ * **WebAuthn ceremony payloads (`options`/`response`) are opaque JSON, typed
+ * as `Record<string, unknown>`, never as `@simplewebauthn/*` types.** This
+ * package has no dependency on `@simplewebauthn` (browser or server) and
+ * adding one only to type two pass-through fields would be a new dependency
+ * for zero behavioural gain — `inputs.touch` for this task explicitly
+ * excludes `package.json`. A caller passes the browser's own
+ * `PublicKeyCredentialCreationOptionsJSON`/`...RequestOptionsJSON` (from
+ * `options`) into `navigator.credentials.create()`/`.get()` (or a helper such
+ * as `@simplewebauthn/browser`'s `startRegistration`/`startAuthentication`)
+ * and forwards what comes back as `response` — this module never inspects
+ * either shape, only relays it.
+ *
+ * @module
+ */
+import { path } from "../http.js";
+import { unwrap } from "../types.js";
+/**
+ * The `console.passkeys` namespace on a `W6WClient`.
+ *
+ * @example
+ * ```ts
+ * // Registration (authenticated).
+ * const { options, challengeToken } = await client.console.passkeys.registrationOptions();
+ * const response = await startRegistration({ optionsJSON: options }); // e.g. @simplewebauthn/browser
+ * const passkey = await client.console.passkeys.registrationVerify({ challengeToken, response });
+ *
+ * // Login (public — works on a tokenless client).
+ * const opts = await client.console.passkeys.authenticationOptions();
+ * const assertion = await startAuthentication({ optionsJSON: opts.options });
+ * const { token } = await client.console.passkeys.authenticationVerify({
+ *   challengeToken: opts.challengeToken,
+ *   response: assertion,
+ * });
+ * ```
+ */
+export class PasskeysApi {
+    #host;
+    /**
+     * @param host - The client this namespace issues requests through.
+     */
+    constructor(host) {
+        this.#host = host;
+    }
+    /**
+     * A fresh registration challenge, scoped to the caller's own identity.
+     *
+     * AUTHENTICATED — the default `requireAuth` applies.
+     *
+     * @returns The ceremony options and a single-use challenge token.
+     * @throws {ApiError} `400 passkey_not_configured`, `403 passkey_not_eligible`.
+     */
+    async registrationOptions() {
+        const res = await this.#host.request({
+            method: "POST",
+            path: "/me/passkeys/options",
+            body: {},
+        });
+        return res.body;
+    }
+    /**
+     * Verify a registration ceremony and store the credential.
+     *
+     * AUTHENTICATED — the default `requireAuth` applies.
+     *
+     * @param input - The challenge token from `registrationOptions()`, the browser's ceremony
+     *   response, and an optional caller-chosen label.
+     * @returns The stored passkey's metadata, unwrapped from the `passkey` envelope.
+     * @throws {ApiError} `400 passkey_registration_failed`, `403 passkey_not_eligible`,
+     *   `409 passkey_already_registered`.
+     */
+    async registrationVerify(input) {
+        const res = await this.#host.request({
+            method: "POST",
+            path: "/me/passkeys",
+            body: input,
+        });
+        return unwrap(res, "passkey");
+    }
+    /**
+     * A fresh authentication challenge. No identifier is sent or accepted —
+     * discoverable credentials only (P1): the owner is resolved server-side
+     * from the assertion itself, never from anything this call sends.
+     *
+     * PUBLIC — sends no bearer, even on a client that already holds one
+     * (`requireAuth: false`). Without it, the login screen (the normal case:
+     * no session exists yet) could never call this method at all — a tokenless
+     * client would hit `requireToken`'s `ConfigError` before `fetch` is ever
+     * called.
+     *
+     * @returns The ceremony options and a single-use challenge token.
+     * @throws {ApiError} `400 passkey_not_configured`.
+     */
+    async authenticationOptions() {
+        const res = await this.#host.request({
+            method: "POST",
+            path: "/auth/passkey/options",
+            body: {},
+            requireAuth: false,
+        });
+        return res.body;
+    }
+    /**
+     * Verify an authentication (login) ceremony and mint a session — the same
+     * way `console.auth.login` does (HITL-5).
+     *
+     * PUBLIC — sends no bearer, even on a client that already holds one
+     * (`requireAuth: false`). Every failure mode past a malformed body is the
+     * same `401 passkey_rejected` (P9): unknown credential, revoked credential,
+     * wrong kind, bad signature, counter regression, and a spent/invalid
+     * challenge are indistinguishable to the caller.
+     *
+     * @param input - The challenge token from `authenticationOptions()` and the browser's ceremony
+     *   response.
+     * @returns The token, the caller's identity, and the token's lifetime.
+     * @throws {ApiError} `401 passkey_rejected` on any verification failure.
+     */
+    async authenticationVerify(input) {
+        const res = await this.#host.request({
+            method: "POST",
+            path: "/auth/passkey/verify",
+            body: input,
+            requireAuth: false,
+        });
+        return res.body;
+    }
+    /**
+     * List the caller's own passkeys.
+     *
+     * AUTHENTICATED — the default `requireAuth` applies.
+     *
+     * @returns The caller's passkeys, unwrapped from the `passkeys` envelope. Never the empty array
+     *   collapsed to `undefined` — an empty account gets `[]`.
+     */
+    async list() {
+        const res = await this.#host.request({ method: "GET", path: "/me/passkeys" });
+        return unwrap(res, "passkeys");
+    }
+    /**
+     * Revoke (delete) one of the caller's own passkeys.
+     *
+     * AUTHENTICATED — the default `requireAuth` applies.
+     *
+     * @param id - The passkey id.
+     * @returns Nothing: the server answers `204` with no body.
+     * @throws {ApiError} `404 passkey_not_found`.
+     */
+    async revoke(id) {
+        await this.#host.request({ method: "DELETE", path: path `/me/passkeys/${id}` });
+    }
+}
+//# sourceMappingURL=passkeys.js.map

package/dist/src/console/passkeys.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"passkeys.js","sourceRoot":"","sources":["../../../src/console/passkeys.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsDG;AAEH,OAAO,EAAqB,IAAI,EAAuB,MAAM,YAAY,CAAC;AAC1E,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAqGrC;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,OAAO,WAAW;IACb,KAAK,CAAe;IAE7B;;OAEG;IACH,YAAY,IAAkB;QAC5B,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;IACpB,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,mBAAmB;QACvB,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,OAAO,CAAyB;YAC3D,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,sBAAsB;YAC5B,IAAI,EAAE,EAAE;SACT,CAAC,CAAC;QACH,OAAO,GAAG,CAAC,IAAI,CAAC;IAClB,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,kBAAkB,CAAC,KAA8B;QACrD,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,OAAO,CAAU;YAC5C,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,cAAc;YACpB,IAAI,EAAE,KAAK;SACZ,CAAC,CAAC;QACH,OAAO,MAAM,CAAU,GAAG,EAAE,SAAS,CAAC,CAAC;IACzC,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,KAAK,CAAC,qBAAqB;QACzB,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,OAAO,CAAyB;YAC3D,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,uBAAuB;YAC7B,IAAI,EAAE,EAAE;YACR,WAAW,EAAE,KAAK;SACnB,CAAC,CAAC;QACH,OAAO,GAAG,CAAC,IAAI,CAAC;IAClB,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,KAAK,CAAC,oBAAoB,CACxB,KAAgC;QAEhC,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,OAAO,CAAsC;YACxE,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,sBAAsB;YAC5B,IAAI,EAAE,KAAK;YACX,WAAW,EAAE,KAAK;SACnB,CAAC,CAAC;QACH,OAAO,GAAG,CAAC,IAAI,CAAC;IAClB,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,IAAI;QACR,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,OAAO,CAAU,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,cAAc,EAAE,CAAC,CAAC;QACvF,OAAO,MAAM,CAAY,GAAG,EAAE,UAAU,CAAC,CAAC;IAC5C,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,MAAM,CAAC,EAAU;QACrB,MAAM,IAAI,CAAC,KAAK,CAAC,OAAO,CAAU,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,IAAI,CAAA,gBAAgB,EAAE,EAAE,EAAE,CAAC,CAAC;IAC1F,CAAC;CACF"}

package/dist/src/console/projects.d.ts

@@ -30,7 +30,7 @@
  */
 import { type HttpResponse, type RequestOptions } from "../http.ts";
 /**
- * The slice of `W6wClient` this namespace needs: the transport, and nothing
+ * The slice of `W6WClient` this namespace needs: the transport, and nothing
  * else. Structural rather than a concrete client type, so the namespace stays
  * independently constructible in a test and this module never imports the
  * client back — mirrors `VarsHost` in `../vars.ts`.
@@ -55,7 +55,7 @@ export interface Project {
     updatedAt: string;
 }
 /**
- * The `console.projects` namespace on a `W6wClient`.
+ * The `console.projects` namespace on a `W6WClient`.
  *
  * @example
  * ```ts

package/dist/src/console/projects.js

@@ -31,7 +31,7 @@
 import { path } from "../http.js";
 import { unwrap } from "../types.js";
 /**
- * The `console.projects` namespace on a `W6wClient`.
+ * The `console.projects` namespace on a `W6WClient`.
  *
  * @example
  * ```ts

package/dist/src/console/reliability.d.ts

@@ -22,7 +22,7 @@
  */
 import type { HttpResponse, RequestOptions } from "../http.ts";
 /**
- * The slice of `W6wClient` this namespace needs: the transport, and nothing
+ * The slice of `W6WClient` this namespace needs: the transport, and nothing
  * else. Structural rather than a concrete client type, so the namespace stays
  * independently constructible in a test and this module never imports the
  * client back — mirrors `VarsHost` in `../vars.ts`.
@@ -123,7 +123,7 @@ export interface ReliabilityServices {
     services: ReliabilityService[];
 }
 /**
- * The `console.reliability` namespace on a `W6wClient`.
+ * The `console.reliability` namespace on a `W6WClient`.
  *
  * @example
  * ```ts

package/dist/src/console/reliability.js

@@ -21,7 +21,7 @@
  * @module
  */
 /**
- * The `console.reliability` namespace on a `W6wClient`.
+ * The `console.reliability` namespace on a `W6WClient`.
  *
  * @example
  * ```ts

package/dist/src/console/saved-tests.d.ts

@@ -18,7 +18,7 @@
  *
  * **`recordTestRun` returns the REAL created row, not `void`.** Studio's
  * current `client.ts` discards it to `void` (`.then(() => {})`) only so its
- * `api` object stays assignable to `@w6w/ui`'s `W6wApi.recordTestRun`
+ * `api` object stays assignable to `@w6w/ui`'s `W6WApi.recordTestRun`
  * (typed `Promise<void>`, `packages/ui/src/provider.tsx:168-177`) — that is
  * STUDIO's constraint, not the SDK's. Mirrors T2.2.1's `deleteApp` precedent:
  * a "complete client" returns genuinely informative data and discards only
@@ -35,7 +35,7 @@
  */
 import { type HttpResponse, type RequestOptions } from "../http.ts";
 /**
- * The slice of `W6wClient` this namespace needs: the transport, and nothing
+ * The slice of `W6WClient` this namespace needs: the transport, and nothing
  * else. Structural rather than a concrete client type, so the namespace stays
  * independently constructible in a test and this module never imports the
  * client back — mirrors `ConnectionsHost` in `./connections.ts`.
@@ -89,7 +89,7 @@ export interface SavedTestRun {
     createdAt: string;
 }
 /**
- * The `console.savedTests` namespace on a `W6wClient`.
+ * The `console.savedTests` namespace on a `W6WClient`.
  *
  * @example
  * ```ts

package/dist/src/console/saved-tests.js

@@ -18,7 +18,7 @@
  *
  * **`recordTestRun` returns the REAL created row, not `void`.** Studio's
  * current `client.ts` discards it to `void` (`.then(() => {})`) only so its
- * `api` object stays assignable to `@w6w/ui`'s `W6wApi.recordTestRun`
+ * `api` object stays assignable to `@w6w/ui`'s `W6WApi.recordTestRun`
  * (typed `Promise<void>`, `packages/ui/src/provider.tsx:168-177`) — that is
  * STUDIO's constraint, not the SDK's. Mirrors T2.2.1's `deleteApp` precedent:
  * a "complete client" returns genuinely informative data and discards only
@@ -36,7 +36,7 @@
 import { path } from "../http.js";
 import { unwrap } from "../types.js";
 /**
- * The `console.savedTests` namespace on a `W6wClient`.
+ * The `console.savedTests` namespace on a `W6WClient`.
  *
  * @example
  * ```ts

package/dist/src/console/schedules.d.ts

@@ -34,7 +34,7 @@
  */
 import { type HttpResponse, type RequestOptions } from "../http.ts";
 /**
- * The slice of `W6wClient` this namespace needs: the transport, and nothing
+ * The slice of `W6WClient` this namespace needs: the transport, and nothing
  * else. Structural rather than a concrete client type, so the namespace stays
  * independently constructible in a test and this module never imports the
  * client back — mirrors `VarsHost` in `../vars.ts`.
@@ -72,7 +72,7 @@ export interface ScheduleUpsertInput {
     variables?: Record<string, unknown>;
 }
 /**
- * The `console.schedules` namespace on a `W6wClient`.
+ * The `console.schedules` namespace on a `W6WClient`.
  *
  * @example
  * ```ts

package/dist/src/console/schedules.js

@@ -36,7 +36,7 @@ import { path } from "../http.js";
 import { ApiError } from "../errors.js";
 import { unwrap } from "../types.js";
 /**
- * The `console.schedules` namespace on a `W6wClient`.
+ * The `console.schedules` namespace on a `W6WClient`.
  *
  * @example
  * ```ts

package/dist/src/console/step-tests.d.ts

@@ -28,7 +28,7 @@
  *
  * **`recordRun` returns the REAL created row, not `void`.** Studio's current
  * `client.ts` discards it to `void` (`.then(() => {})`) only so its `api`
- * object stays assignable to `@w6w/ui`'s `W6wApi.recordStepTestRun` (typed
+ * object stays assignable to `@w6w/ui`'s `W6WApi.recordStepTestRun` (typed
  * `Promise<void>`, `packages/ui/src/provider.tsx:211-221`) — that is
  * STUDIO's constraint, not the SDK's. Mirrors `./saved-tests.ts`'s
  * `recordTestRun` exactly; the void-discard happens at studio's own repo
@@ -43,7 +43,7 @@
  */
 import { type HttpResponse, type RequestOptions } from "../http.ts";
 /**
- * The slice of `W6wClient` this namespace needs: the transport, and nothing
+ * The slice of `W6WClient` this namespace needs: the transport, and nothing
  * else. Structural rather than a concrete client type, so the namespace stays
  * independently constructible in a test and this module never imports the
  * client back — mirrors `ConnectionsHost` in `./connections.ts`.
@@ -86,7 +86,7 @@ export interface StepTestRun {
     createdAt: string;
 }
 /**
- * The `console.stepTests` namespace on a `W6wClient`.
+ * The `console.stepTests` namespace on a `W6WClient`.
  *
  * @example
  * ```ts

package/dist/src/console/step-tests.js

@@ -28,7 +28,7 @@
  *
  * **`recordRun` returns the REAL created row, not `void`.** Studio's current
  * `client.ts` discards it to `void` (`.then(() => {})`) only so its `api`
- * object stays assignable to `@w6w/ui`'s `W6wApi.recordStepTestRun` (typed
+ * object stays assignable to `@w6w/ui`'s `W6WApi.recordStepTestRun` (typed
  * `Promise<void>`, `packages/ui/src/provider.tsx:211-221`) — that is
  * STUDIO's constraint, not the SDK's. Mirrors `./saved-tests.ts`'s
  * `recordTestRun` exactly; the void-discard happens at studio's own repo
@@ -44,7 +44,7 @@
 import { path } from "../http.js";
 import { unwrap } from "../types.js";
 /**
- * The `console.stepTests` namespace on a `W6wClient`.
+ * The `console.stepTests` namespace on a `W6WClient`.
  *
  * @example
  * ```ts

package/dist/src/console/subscriptions.d.ts

@@ -45,7 +45,7 @@
  */
 import { type HttpResponse, type RequestOptions } from "../http.ts";
 /**
- * The slice of `W6wClient` this namespace needs: the transport, and nothing
+ * The slice of `W6WClient` this namespace needs: the transport, and nothing
  * else. Structural rather than a concrete client type, so the namespace stays
  * independently constructible in a test and this module never imports the
  * client back — mirrors `VarsHost` in `../vars.ts`.
@@ -97,7 +97,7 @@ export interface TriggerEventSummary {
     runId: string | null;
 }
 /**
- * The `console.subscriptions` namespace on a `W6wClient`.
+ * The `console.subscriptions` namespace on a `W6WClient`.
  *
  * @example
  * ```ts

package/dist/src/console/subscriptions.js

@@ -46,7 +46,7 @@
 import { path } from "../http.js";
 import { unwrap } from "../types.js";
 /**
- * The `console.subscriptions` namespace on a `W6wClient`.
+ * The `console.subscriptions` namespace on a `W6WClient`.
  *
  * @example
  * ```ts

package/dist/src/console/tenant-oauth-apps.d.ts

@@ -48,7 +48,7 @@
  */
 import { type HttpResponse, type RequestOptions } from "../http.ts";
 /**
- * The slice of `W6wClient` this namespace needs: the transport, and nothing
+ * The slice of `W6WClient` this namespace needs: the transport, and nothing
  * else. Structural rather than a concrete client type, so the namespace stays
  * independently constructible in a test and this module never imports the
  * client back — mirrors `AuthHost` in `./auth.ts`.
@@ -131,7 +131,7 @@ export interface SetTenantOAuthAppInput {
     disabled?: boolean;
 }
 /**
- * The `console.tenantOAuthApps` namespace on a `W6wClient` — the caller's own
+ * The `console.tenantOAuthApps` namespace on a `W6WClient` — the caller's own
  * tenant, never a tenant of its choosing.
  *
  * @example

package/dist/src/console/tenant-oauth-apps.js

@@ -75,7 +75,7 @@ function toSetBody(input) {
     return body;
 }
 /**
- * The `console.tenantOAuthApps` namespace on a `W6wClient` — the caller's own
+ * The `console.tenantOAuthApps` namespace on a `W6WClient` — the caller's own
  * tenant, never a tenant of its choosing.
  *
  * @example

package/dist/src/console/tokens.d.ts

@@ -40,7 +40,7 @@
  */
 import { type HttpResponse, type RequestOptions } from "../http.ts";
 /**
- * The slice of `W6wClient` this namespace needs: the transport, and nothing
+ * The slice of `W6WClient` this namespace needs: the transport, and nothing
  * else. Structural rather than a concrete client type, so the namespace stays
  * independently constructible in a test and this module never imports the
  * client back — mirrors `ConnectionsHost` in `./connections.ts`.
@@ -88,7 +88,7 @@ export interface CreateTokenResponse {
     secret: string;
 }
 /**
- * The `console.tokens` namespace on a `W6wClient`.
+ * The `console.tokens` namespace on a `W6WClient`.
  *
  * @example
  * ```ts

package/dist/src/console/tokens.js

@@ -41,7 +41,7 @@
 import { path } from "../http.js";
 import { unwrap } from "../types.js";
 /**
- * The `console.tokens` namespace on a `W6wClient`.
+ * The `console.tokens` namespace on a `W6WClient`.
  *
  * @example
  * ```ts

package/dist/src/console/vault.d.ts

@@ -40,7 +40,7 @@
  */
 import { type HttpResponse, type RequestOptions } from "../http.ts";
 /**
- * The slice of `W6wClient` this namespace needs: the transport, and nothing
+ * The slice of `W6WClient` this namespace needs: the transport, and nothing
  * else. Structural rather than a concrete client type, so the namespace stays
  * independently constructible in a test and this module never imports the
  * client back — mirrors `ConnectionsHost` in `./connections.ts`.
@@ -85,7 +85,7 @@ export interface SecretValue {
     iv: string;
 }
 /**
- * The `console.vault` namespace on a `W6wClient`.
+ * The `console.vault` namespace on a `W6WClient`.
  *
  * @example
  * ```ts

package/dist/src/console/vault.js

@@ -41,7 +41,7 @@
 import { path } from "../http.js";
 import { unwrap } from "../types.js";
 /**
- * The `console.vault` namespace on a `W6wClient`.
+ * The `console.vault` namespace on a `W6WClient`.
  *
  * @example
  * ```ts

package/dist/src/console/workflows.d.ts

@@ -54,7 +54,7 @@
 import { type HttpResponse, type RequestOptions } from "../http.ts";
 import { type RunStatus, type StepError } from "../types.ts";
 /**
- * The slice of `W6wClient` this namespace needs: the transport, and nothing
+ * The slice of `W6WClient` this namespace needs: the transport, and nothing
  * else. Structural rather than a concrete client type, so the namespace stays
  * independently constructible in a test and this module never imports the
  * client back — mirrors `SchedulesHost` in `./schedules.ts`.
@@ -117,7 +117,7 @@ export interface RunSummary {
     finishedAt: string | null;
 }
 /**
- * The `console.workflows` namespace on a `W6wClient`.
+ * The `console.workflows` namespace on a `W6WClient`.
  *
  * @example
  * ```ts

package/dist/src/console/workflows.js

@@ -56,7 +56,7 @@ import { unwrap } from "../types.js";
 /** The precondition header `upsert` sends when `ifUnmodifiedSince` is given. */
 const PRECONDITION_HEADER = "x-w6w-if-unmodified-since";
 /**
- * The `console.workflows` namespace on a `W6wClient`.
+ * The `console.workflows` namespace on a `W6WClient`.
  *
  * @example
  * ```ts

package/dist/src/documents.d.ts

@@ -24,7 +24,7 @@ import type { ResolvedConfig } from "./config.ts";
 import { 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
+ * The slice of `W6WClient` this namespace needs: the transport, plus
  * the resolved configuration it reads the **default project** out of. Structural
  * rather than a concrete client type, so the namespace stays independently
  * constructible in a test and this module never imports the client back.
@@ -78,7 +78,7 @@ export interface DocumentPatch {
     description?: string;
 }
 /**
- * The `documents` namespace on a `W6wClient`.
+ * The `documents` namespace on a `W6WClient`.
  *
  * @example
  * ```ts

package/dist/src/documents.js

@@ -23,7 +23,7 @@
 import { path } from "./http.js";
 import { unwrap } from "./types.js";
 /**
- * The `documents` namespace on a `W6wClient`.
+ * The `documents` namespace on a `W6WClient`.
  *
  * @example
  * ```ts

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