@gathertown/webhook-object-sdk 0.1.1

package/LICENSE-APACHE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/LICENSE-MIT

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) Gather Presence, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,92 @@
+# @gathertown/webhook-object-sdk
+
+Typed client for emitting events to Gather webhook objects (Smart Objects). Handles the
+fiddly parts of the wire protocol (Standard Webhooks v1 signing, retries, rate limits, and
+error decoding) behind a fully type-safe `send`.
+
+Event types and payload shapes come from
+[`@gathertown/webhook-object-types`](https://www.npmjs.com/package/@gathertown/webhook-object-types),
+generated from the same definitions the Gather server enforces. When new capabilities ship,
+this SDK picks them up via a types-package bump, no SDK release needed.
+
+## Usage
+
+Each Smart Object is one `(url, secret)` pair, copied from the object's ⋮ menu in Gather.
+Secrets are per-object: a key for one object never authenticates another.
+
+```ts
+import { createWebhookObjectClient, secretFromEnv } from "@gathertown/webhook-object-sdk"
+
+const counter = createWebhookObjectClient({
+  url: process.env.GATHER_COUNTER_URL!,
+  secret: secretFromEnv("GATHER_COUNTER_SECRET"), // whsec_…, read from the environment
+})
+
+await counter.send("counter.increment", { by: 2 }) // data type inferred from the event type
+await counter.send("counter.reset") // empty-payload events take no data argument
+await counter.ping() // verify url + secret; returns the object's declared capabilities
+```
+
+`secret` accepts the raw `whsec_…` string, so it plugs straight into whatever secret
+management you already have. The opaque handles are the recommended hardening on top:
+`secretFromEnv(name)` reads the variable itself, and a handle redacts itself if it ever
+reaches a log or `JSON.stringify`, a bare string can't. For values from elsewhere (a
+secret manager, a non-Node runtime), `unsafeSecretLiteral(value)` wraps them; the name
+makes hardcoded secrets easy to catch in review.
+
+Every event is also available as capability-namespaced sugar with the same typing; snake_case
+wire names become camelCase methods:
+
+```ts
+await counter.counter.increment({ by: 2 })
+await counter.counter.reset()
+await lamp.switch.setState({ on: true }) // → switch.set_state
+```
+
+The fluent surface is derived from the generated event union and backed by a `Proxy`, so new
+capabilities appear via a types-package bump with zero SDK changes.
+
+### Object catalog
+
+To keep several objects at hand (inboxes, lamps, counters, …), build a named catalog. An
+entry's optional `preset` narrows its `send` at compile time to the events that preset
+declares, so wiring the lamp's events to the inbox is a type error, not a runtime 404.
+
+```ts
+import { createWebhookObjectCatalog } from "@gathertown/webhook-object-sdk"
+
+const office = createWebhookObjectCatalog({
+  supportInbox: { url: INBOX_URL, secret: secretFromEnv("GATHER_INBOX_SECRET"), preset: "inbox" },
+  buildLamp: { url: LAMP_URL, secret: secretFromEnv("GATHER_LAMP_SECRET"), preset: "switch" },
+})
+
+await office.supportInbox.send("activity.add", { id: "pr-142", text: "PR #142 merged" })
+await office.buildLamp.send("switch.toggle")
+```
+
+## Wire behavior
+
+- Signs with the `standardwebhooks` reference library: HMAC-SHA256 over
+  `${webhook-id}.${webhook-timestamp}.${body}`, sent as the `webhook-id` /
+  `webhook-timestamp` / `webhook-signature` headers. The exact serialized body is signed and
+  sent unchanged.
+- One `webhook-id` (UUID) per event, reused across retries; the server dedups the last 10
+  ids per object, so retries are idempotent. Each retry is re-signed with a fresh timestamp.
+- Retries transient failures only (429, 5xx, network errors), honoring `RateLimit-Reset` /
+  `Retry-After`, with exponential backoff + jitter otherwise. 4xx failures never retry.
+- Cancelable via a `signal` (`AbortSignal`) in config: aborting cancels the in-flight request
+  and any pending backoff, rejecting with an `aborted` error.
+- Rejects payloads over the server's 4 KB body cap client-side, with a clear error instead of
+  the receiver's uniform `404`.
+- Refuses non-`https` URLs at construction (signing authenticates but does not encrypt), with
+  an `http` carve-out for `localhost` so local development keeps working.
+- Never exposes the secret: error messages never contain it, and the opaque-handle form
+  additionally redacts itself when logged or serialized.
+- Failures throw `WebhookObjectError` with a `code` mirroring the server's error bodies
+  (`not_found`, `capability_not_declared`, `token_revoked`, …) plus client-side codes
+  (`payload_too_large`, `invalid_secret`, `invalid_url`, `network_error`, `aborted`,
+  `unexpected_response`).
+
+Uses global `fetch` and `crypto.randomUUID` by default (Node 19+, modern browsers, Deno,
+workers). Both are overridable via config. Inject `fetch` and/or `newWebhookId` for other
+runtimes, proxies, or deterministic tests.

package/dist/src/catalog.d.ts

@@ -0,0 +1,39 @@
+import type { WebhookObjectPreset } from "@gathertown/webhook-object-types";
+import { WebhookObjectClient, WebhookObjectClientConfig } from "./client";
+/** Runtime options that apply to every client in the catalog rather than a single object. */
+type SharedClientOption = "maxAttempts" | "fetch" | "newWebhookId";
+/** Per-object entry: the (url, secret) pair plus optional compile-time preset scoping. */
+export type WebhookObjectCatalogEntry = Omit<WebhookObjectClientConfig, SharedClientOption>;
+/** Options shared by every client in the catalog. */
+export type WebhookObjectCatalogOptions = Pick<WebhookObjectClientConfig, SharedClientOption>;
+/** The preset literal declared on an entry, or `undefined` when the entry has none. */
+type PresetOf<Entry extends WebhookObjectCatalogEntry> = Entry extends {
+    preset: infer Preset extends WebhookObjectPreset;
+} ? Preset : undefined;
+/**
+ * The value returned by `createWebhookObjectCatalog`: each entry name maps to a client whose
+ * `send` is narrowed to that entry's declared preset (or unconstrained when it has none).
+ */
+export type WebhookObjectCatalog<Entries extends Record<string, WebhookObjectCatalogEntry>> = {
+    [Name in keyof Entries]: WebhookObjectClient<PresetOf<Entries[Name]>>;
+};
+/**
+ * Build a named catalog of webhook-object clients so multiple Smart Objects (inboxes,
+ * lamps, counters, …) stay at hand behind one value. Each entry is just its (url, secret)
+ * pair, each secret authenticates only its own object.
+ *
+ * Entries with a `preset` get a compile-time-narrowed `send`: an `inbox` client only
+ * accepts inbox event types, so wiring the lamp's events to the inbox is a type error.
+ *
+ * ```ts
+ * const office = createWebhookObjectCatalog({
+ *   supportInbox: { url: INBOX_URL, secret: secretFromEnv("GATHER_INBOX_SECRET"), preset: "inbox" },
+ *   buildLamp: { url: LAMP_URL, secret: secretFromEnv("GATHER_LAMP_SECRET"), preset: "switch" },
+ * })
+ * await office.supportInbox.send("activity.add", { id: "pr-142", text: "PR #142 merged" })
+ * await office.buildLamp.send("switch.toggle")
+ * ```
+ */
+export declare const createWebhookObjectCatalog: <const Entries extends Record<string, WebhookObjectCatalogEntry>>(entries: Entries, options?: WebhookObjectCatalogOptions) => WebhookObjectCatalog<Entries>;
+export {};
+//# sourceMappingURL=catalog.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"catalog.d.ts","sourceRoot":"","sources":["../../src/catalog.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,kCAAkC,CAAA;AAC3E,OAAO,EAA6B,mBAAmB,EAAE,yBAAyB,EAAE,MAAM,UAAU,CAAA;AAEpG,6FAA6F;AAC7F,KAAK,kBAAkB,GAAG,aAAa,GAAG,OAAO,GAAG,cAAc,CAAA;AAElE,0FAA0F;AAC1F,MAAM,MAAM,yBAAyB,GAAG,IAAI,CAAC,yBAAyB,EAAE,kBAAkB,CAAC,CAAA;AAE3F,qDAAqD;AACrD,MAAM,MAAM,2BAA2B,GAAG,IAAI,CAAC,yBAAyB,EAAE,kBAAkB,CAAC,CAAA;AAE7F,uFAAuF;AACvF,KAAK,QAAQ,CAAC,KAAK,SAAS,yBAAyB,IAAI,KAAK,SAAS;IACrE,MAAM,EAAE,MAAM,MAAM,SAAS,mBAAmB,CAAA;CACjD,GACG,MAAM,GACN,SAAS,CAAA;AAEb;;;GAGG;AACH,MAAM,MAAM,oBAAoB,CAAC,OAAO,SAAS,MAAM,CAAC,MAAM,EAAE,yBAAyB,CAAC,IAAI;KAC3F,IAAI,IAAI,MAAM,OAAO,GAAG,mBAAmB,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC;CACtE,CAAA;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,0BAA0B,GACrC,KAAK,CAAC,OAAO,SAAS,MAAM,CAAC,MAAM,EAAE,yBAAyB,CAAC,EAE/D,SAAS,OAAO,EAChB,UAAS,2BAAgC,KACxC,oBAAoB,CAAC,OAAO,CASgB,CAAA"}

package/dist/src/catalog.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createWebhookObjectCatalog = void 0;
+const client_1 = require("./client");
+/**
+ * Build a named catalog of webhook-object clients so multiple Smart Objects (inboxes,
+ * lamps, counters, …) stay at hand behind one value. Each entry is just its (url, secret)
+ * pair, each secret authenticates only its own object.
+ *
+ * Entries with a `preset` get a compile-time-narrowed `send`: an `inbox` client only
+ * accepts inbox event types, so wiring the lamp's events to the inbox is a type error.
+ *
+ * ```ts
+ * const office = createWebhookObjectCatalog({
+ *   supportInbox: { url: INBOX_URL, secret: secretFromEnv("GATHER_INBOX_SECRET"), preset: "inbox" },
+ *   buildLamp: { url: LAMP_URL, secret: secretFromEnv("GATHER_LAMP_SECRET"), preset: "switch" },
+ * })
+ * await office.supportInbox.send("activity.add", { id: "pr-142", text: "PR #142 merged" })
+ * await office.buildLamp.send("switch.toggle")
+ * ```
+ */
+const createWebhookObjectCatalog = (entries, options = {}) => 
+// fromEntries can't see the per-entry preset literals, so it needs the double assertion to
+// reach the mapped catalog type; per-name correctness is covered by compile-time tests.
+// eslint-disable-next-line @typescript-eslint/consistent-type-assertions
+Object.fromEntries(Object.entries(entries).map(([name, entry]) => [
+    name,
+    (0, client_1.createWebhookObjectClient)({ ...entry, ...options }),
+]));
+exports.createWebhookObjectCatalog = createWebhookObjectCatalog;
+//# sourceMappingURL=catalog.js.map

package/dist/src/catalog.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"catalog.js","sourceRoot":"","sources":["../../src/catalog.ts"],"names":[],"mappings":";;;AACA,qCAAoG;AA0BpG;;;;;;;;;;;;;;;;GAgBG;AACI,MAAM,0BAA0B,GAAG,CAGxC,OAAgB,EAChB,UAAuC,EAAE,EACV,EAAE;AACjC,2FAA2F;AAC3F,wFAAwF;AACxF,yEAAyE;AACzE,MAAM,CAAC,WAAW,CAChB,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC;IAC7C,IAAI;IACJ,IAAA,kCAAyB,EAAC,EAAE,GAAG,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC;CACpD,CAAC,CACyC,CAAA;AAdlC,QAAA,0BAA0B,8BAcQ"}

package/dist/src/client.d.ts

@@ -0,0 +1,91 @@
+import type { DataFor, EventTypeForPreset, ReservedEventType, WebhookEventType, WebhookObjectPreset } from "@gathertown/webhook-object-types";
+import { WebhookObjectSecret } from "./secret";
+export type WebhookObjectClientConfig = {
+    /** The object's full webhook URL (copied from the object's ⋮ menu in Gather). */
+    url: string;
+    /**
+     * The object's signing secret (per-object; never shared between objects). Either the raw
+     * `whsec_…` string, or (recommended) an opaque handle from `secretFromEnv()` /
+     * `unsafeSecretLiteral()`, which redacts itself if the config is ever logged or serialized.
+     */
+    secret: WebhookObjectSecret | string;
+    /**
+     * Compile-time narrowing only: when set, `send` accepts only event types this preset
+     * declares (plus reserved `webhook.*`). The server enforces the same thing at runtime.
+     */
+    preset?: WebhookObjectPreset;
+    /** Total delivery attempts per event (initial + retries on 429/5xx/network). Default 3. */
+    maxAttempts?: number;
+    /** Custom fetch implementation (tests, proxies). Defaults to the global fetch (Node 18+). */
+    fetch?: typeof fetch;
+    /**
+     * Override the per-event `webhook-id` generator. Defaults to the global `crypto.randomUUID`;
+     * inject your own for runtimes without global `crypto`, or for deterministic tests. Must return
+     * a unique value per event (the server dedups by id, so reused ids would drop distinct events).
+     */
+    newWebhookId?: () => string;
+    /**
+     * Cancels an in-flight `send`/`ping`, including any pending retry backoff, when aborted.
+     * The call rejects with a `WebhookObjectError` whose `code` is `aborted`.
+     */
+    signal?: AbortSignal;
+};
+/**
+ * Event types a client scoped to preset `P` may send. Intersected with `WebhookEventType`
+ * so `DataFor<T>` stays applicable while `P` is still generic.
+ */
+export type AllowedEventType<P extends WebhookObjectPreset | undefined> = (P extends WebhookObjectPreset ? EventTypeForPreset<P> : WebhookEventType) & WebhookEventType;
+/** Empty-payload events take no `data` argument; everything else requires one. */
+type DataArgs<T extends WebhookEventType> = DataFor<T> extends Record<string, never> ? [] : [data: DataFor<T>];
+/** Both statuses mean "accepted": `space_idle` means the space wasn't live, and the event was persisted for it. */
+export type SendResult = {
+    status: "dispatched" | "space_idle";
+};
+/** The `webhook.ping` snapshot: what this object is and what it currently accepts. */
+export type PingResult = {
+    status: "pong";
+    objectId: string;
+    spaceId: string;
+    preset: WebhookObjectPreset | null;
+    capabilities: Record<string, unknown>;
+};
+/** `set_state` → `setState`: fluent method names are idiomatic camelCase versions of wire names. */
+type SnakeToCamel<S extends string> = S extends `${infer Head}_${infer Tail}` ? `${Head}${Capitalize<SnakeToCamel<Tail>>}` : S;
+/** The capability segment of an event type: `"counter.reset"` → `"counter"`. */
+type CapabilityNameOf<E extends string> = E extends `${infer Capability}.${string}` ? Capability : never;
+/**
+ * Capability-namespaced sugar over `send`: `client.counter.reset()`,
+ * `client.switch.setState({ on: true })`. Derived entirely from the generated event union, so
+ * new capabilities appear via a types-package bump; reserved `webhook.*` events are excluded
+ * (`ping()` is first-class). Backed by a `Proxy` at runtime: no codegen, no runtime catalog.
+ */
+export type CapabilityNamespaces<Events extends WebhookEventType> = {
+    [Capability in CapabilityNameOf<Exclude<Events, ReservedEventType>>]: {
+        [Event in Extract<Events, `${Capability}.${string}`> as Event extends `${Capability}.${infer Method}` ? SnakeToCamel<Method> : never]: (...args: DataArgs<Event>) => Promise<SendResult>;
+    };
+};
+/**
+ * A client bound to one webhook object. Exposes `send`/`ping` plus the capability-namespaced
+ * fluent sugar (`client.counter.increment(...)`). The optional preset `P` narrows every surface
+ * to the event types that preset declares.
+ */
+export type WebhookObjectClient<P extends WebhookObjectPreset | undefined = undefined> = {
+    /**
+     * Sign and POST one event. `data` is inferred from the event type and omitted entirely
+     * for empty-payload events (e.g. `send("counter.reset")`).
+     */
+    send<T extends AllowedEventType<P>>(type: T, ...args: DataArgs<T>): Promise<SendResult>;
+    /** Verify the URL + secret and fetch the object's declared capability state. */
+    ping(): Promise<PingResult>;
+} & CapabilityNamespaces<AllowedEventType<P>>;
+/**
+ * Create a client for one webhook object. Signing follows Standard Webhooks v1: HMAC over
+ * `${id}.${timestamp}.${body}` via the `standardwebhooks` reference library, sent as the
+ * `webhook-id` / `webhook-timestamp` / `webhook-signature` headers. The exact serialized
+ * body is signed and sent unchanged, so the two can never drift.
+ */
+export declare const createWebhookObjectClient: <P extends WebhookObjectPreset | undefined = undefined>(config: WebhookObjectClientConfig & {
+    preset?: P;
+}) => WebhookObjectClient<P>;
+export {};
+//# sourceMappingURL=client.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../src/client.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EACV,OAAO,EACP,kBAAkB,EAClB,iBAAiB,EACjB,gBAAgB,EAChB,mBAAmB,EACpB,MAAM,kCAAkC,CAAA;AAGzC,OAAO,EAAgB,mBAAmB,EAAE,MAAM,UAAU,CAAA;AAE5D,MAAM,MAAM,yBAAyB,GAAG;IACtC,iFAAiF;IACjF,GAAG,EAAE,MAAM,CAAA;IACX;;;;OAIG;IACH,MAAM,EAAE,mBAAmB,GAAG,MAAM,CAAA;IACpC;;;OAGG;IACH,MAAM,CAAC,EAAE,mBAAmB,CAAA;IAC5B,2FAA2F;IAC3F,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,6FAA6F;IAC7F,KAAK,CAAC,EAAE,OAAO,KAAK,CAAA;IACpB;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,MAAM,CAAA;IAC3B;;;OAGG;IACH,MAAM,CAAC,EAAE,WAAW,CAAA;CACrB,CAAA;AAED;;;GAGG;AACH,MAAM,MAAM,gBAAgB,CAAC,CAAC,SAAS,mBAAmB,GAAG,SAAS,IACpE,CAAC,CAAC,SAAS,mBAAmB,GAAG,kBAAkB,CAAC,CAAC,CAAC,GAAG,gBAAgB,CAAC,GAAG,gBAAgB,CAAA;AAE/F,kFAAkF;AAClF,KAAK,QAAQ,CAAC,CAAC,SAAS,gBAAgB,IACtC,OAAO,CAAC,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,GAAG,EAAE,GAAG,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,CAAA;AAEpE,mHAAmH;AACnH,MAAM,MAAM,UAAU,GAAG;IAAE,MAAM,EAAE,YAAY,GAAG,YAAY,CAAA;CAAE,CAAA;AAEhE,sFAAsF;AACtF,MAAM,MAAM,UAAU,GAAG;IACvB,MAAM,EAAE,MAAM,CAAA;IACd,QAAQ,EAAE,MAAM,CAAA;IAChB,OAAO,EAAE,MAAM,CAAA;IACf,MAAM,EAAE,mBAAmB,GAAG,IAAI,CAAA;IAClC,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CACtC,CAAA;AAED,oGAAoG;AACpG,KAAK,YAAY,CAAC,CAAC,SAAS,MAAM,IAAI,CAAC,SAAS,GAAG,MAAM,IAAI,IAAI,MAAM,IAAI,EAAE,GACzE,GAAG,IAAI,GAAG,UAAU,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,EAAE,GAC1C,CAAC,CAAA;AAEL,gFAAgF;AAChF,KAAK,gBAAgB,CAAC,CAAC,SAAS,MAAM,IAAI,CAAC,SAAS,GAAG,MAAM,UAAU,IAAI,MAAM,EAAE,GAC/E,UAAU,GACV,KAAK,CAAA;AAET;;;;;GAKG;AACH,MAAM,MAAM,oBAAoB,CAAC,MAAM,SAAS,gBAAgB,IAAI;KACjE,UAAU,IAAI,gBAAgB,CAAC,OAAO,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAAC,GAAG;SACnE,KAAK,IAAI,OAAO,CACf,MAAM,EACN,GAAG,UAAU,IAAI,MAAM,EAAE,CAC1B,IAAI,KAAK,SAAS,GAAG,UAAU,IAAI,MAAM,MAAM,EAAE,GAAG,YAAY,CAAC,MAAM,CAAC,GAAG,KAAK,GAAG,CAClF,GAAG,IAAI,EAAE,QAAQ,CAAC,KAAK,CAAC,KACrB,OAAO,CAAC,UAAU,CAAC;KACzB;CACF,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,mBAAmB,CAAC,CAAC,SAAS,mBAAmB,GAAG,SAAS,GAAG,SAAS,IAAI;IACvF;;;OAGG;IACH,IAAI,CAAC,CAAC,SAAS,gBAAgB,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,GAAG,IAAI,EAAE,QAAQ,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,UAAU,CAAC,CAAA;IACvF,gFAAgF;IAChF,IAAI,IAAI,OAAO,CAAC,UAAU,CAAC,CAAA;CAC5B,GAAG,oBAAoB,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,CAAA;AA4D7C;;;;;GAKG;AACH,eAAO,MAAM,yBAAyB,GAAI,CAAC,SAAS,mBAAmB,GAAG,SAAS,GAAG,SAAS,EAC7F,QAAQ,yBAAyB,GAAG;IAAE,MAAM,CAAC,EAAE,CAAC,CAAA;CAAE,KACjD,mBAAmB,CAAC,CAAC,CAyEvB,CAAA"}

package/dist/src/client.js

@@ -0,0 +1,118 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createWebhookObjectClient = void 0;
+const standardwebhooks_1 = require("standardwebhooks");
+const deliver_1 = require("./deliver");
+const errors_1 = require("./errors");
+const secret_1 = require("./secret");
+/** Hosts allowed to receive cleartext http, so local development keeps working. */
+const LOCAL_HOSTNAMES = new Set(["localhost", "127.0.0.1", "[::1]"]);
+/**
+ * Signing authenticates but does not encrypt: over plain http the payload, headers, and
+ * signature travel in cleartext. Refuse everything but https, except toward localhost.
+ */
+const assertValidUrl = (url) => {
+    let parsed;
+    try {
+        parsed = new URL(url);
+    }
+    catch (cause) {
+        throw new errors_1.WebhookObjectError("invalid_url", `webhook object URL is not a valid URL: ${url}`, {
+            cause,
+        });
+    }
+    if (parsed.protocol === "https:")
+        return;
+    if (parsed.protocol === "http:" && LOCAL_HOSTNAMES.has(parsed.hostname))
+        return;
+    throw new errors_1.WebhookObjectError("invalid_url", `webhook object URL must use https (got ${parsed.protocol}//); http is allowed only for localhost`);
+};
+/** Fluent method → wire method segment: `setState` → `set_state`. */
+const wireMethodName = (method) => method.replace(/[A-Z]/g, (char) => `_${char.toLowerCase()}`);
+/**
+ * Properties runtimes probe on arbitrary objects (`await` checks `then`, serializers check
+ * `toJSON`). The capability proxy must not answer these, or `await client.counter` would hang.
+ */
+const PROBED_PROPS = new Set(["then", "toJSON"]);
+/** Both "accepted" statuses; extra body fields (if the receiver ever adds any) pass through. */
+const isSendResult = (body) => body.status === "dispatched" || body.status === "space_idle";
+/** The pong snapshot, checked field by field: the wire is untrusted, so the shape is proven. */
+const isPingResult = (body) => body.status === "pong" &&
+    typeof body.objectId === "string" &&
+    typeof body.spaceId === "string" &&
+    (body.preset === null || typeof body.preset === "string") &&
+    typeof body.capabilities === "object" &&
+    body.capabilities !== null;
+const serializeEnvelope = (type, data) => {
+    const body = JSON.stringify({ type, timestamp: new Date().toISOString(), data });
+    const byteLength = new TextEncoder().encode(body).length;
+    if (byteLength > deliver_1.MAX_BODY_BYTES)
+        throw new errors_1.WebhookObjectError("payload_too_large", `webhook object payload is ${byteLength} bytes; the server caps bodies at ${deliver_1.MAX_BODY_BYTES} bytes`);
+    return body;
+};
+/**
+ * Create a client for one webhook object. Signing follows Standard Webhooks v1: HMAC over
+ * `${id}.${timestamp}.${body}` via the `standardwebhooks` reference library, sent as the
+ * `webhook-id` / `webhook-timestamp` / `webhook-signature` headers. The exact serialized
+ * body is signed and sent unchanged, so the two can never drift.
+ */
+const createWebhookObjectClient = (config) => {
+    assertValidUrl(config.url);
+    // Revealed once here and captured only by the standardwebhooks signer; the returned
+    // client never holds the raw value on an enumerable property.
+    const webhook = new standardwebhooks_1.Webhook((0, secret_1.revealSecret)(config.secret));
+    const fetchImpl = config.fetch ?? fetch;
+    const newWebhookId = config.newWebhookId ?? (() => crypto.randomUUID());
+    const maxAttempts = config.maxAttempts ?? deliver_1.DEFAULT_MAX_ATTEMPTS;
+    /**
+     * Sign, deliver, and narrow the response to the caller's expected shape. The caller controls
+     * the result type, but through a runtime guard rather than a cast: the wire is untrusted, so
+     * an off-contract 200 body throws `unexpected_response` instead of lying about its shape.
+     */
+    const dispatch = async (type, data, isExpectedBody) => {
+        const body = serializeEnvelope(type, data);
+        // One id per event, reused across retries: the server dedups the last 10 ids per
+        // object, so a retry can never double-apply.
+        const webhookId = newWebhookId();
+        const responseBody = await (0, deliver_1.deliver)({
+            url: config.url,
+            body,
+            webhookId,
+            sign: (timestampSeconds) => webhook.sign(webhookId, new Date(timestampSeconds * 1000), body),
+            fetchImpl,
+            maxAttempts,
+            signal: config.signal,
+        });
+        if (!isExpectedBody(responseBody))
+            throw new errors_1.WebhookObjectError("unexpected_response", `webhook object ${type} succeeded but returned an unrecognized body (status: ${String(responseBody.status)})`);
+        return responseBody;
+    };
+    const sendEvent = (type, data) => dispatch(type, data, isSendResult);
+    const base = {
+        send: (type, ...args) => sendEvent(type, args[0] ?? {}),
+        ping: () => dispatch("webhook.ping", {}, isPingResult),
+    };
+    /** `client.counter` → namespace whose method calls become `sendEvent("counter.<method>")`. */
+    const capabilityNamespace = (capability) => new Proxy({}, {
+        get: (_target, method) => {
+            if (typeof method !== "string" || PROBED_PROPS.has(method))
+                return undefined;
+            return (data) => sendEvent(`${capability}.${wireMethodName(method)}`, data ?? {});
+        },
+    });
+    // The fluent surface is type-driven (CapabilityNamespaces); the proxy only assembles wire
+    // names, so new capabilities work via a types-package bump with zero SDK changes.
+    // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
+    return new Proxy(base, {
+        get: (target, prop, receiver) => {
+            // Real members (send/ping) win over capability namespaces, as do symbol lookups.
+            if (prop in target || typeof prop !== "string")
+                return Reflect.get(target, prop, receiver);
+            if (PROBED_PROPS.has(prop))
+                return undefined;
+            return capabilityNamespace(prop);
+        },
+    });
+};
+exports.createWebhookObjectClient = createWebhookObjectClient;
+//# sourceMappingURL=client.js.map

package/dist/src/client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.js","sourceRoot":"","sources":["../../src/client.ts"],"names":[],"mappings":";;;AAAA,uDAA0C;AAS1C,uCAAyE;AACzE,qCAA6C;AAC7C,qCAA4D;AAkG5D,mFAAmF;AACnF,MAAM,eAAe,GAAG,IAAI,GAAG,CAAC,CAAC,WAAW,EAAE,WAAW,EAAE,OAAO,CAAC,CAAC,CAAA;AAEpE;;;GAGG;AACH,MAAM,cAAc,GAAG,CAAC,GAAW,EAAQ,EAAE;IAC3C,IAAI,MAAW,CAAA;IACf,IAAI,CAAC;QACH,MAAM,GAAG,IAAI,GAAG,CAAC,GAAG,CAAC,CAAA;IACvB,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,IAAI,2BAAkB,CAAC,aAAa,EAAE,0CAA0C,GAAG,EAAE,EAAE;YAC3F,KAAK;SACN,CAAC,CAAA;IACJ,CAAC;IACD,IAAI,MAAM,CAAC,QAAQ,KAAK,QAAQ;QAAE,OAAM;IACxC,IAAI,MAAM,CAAC,QAAQ,KAAK,OAAO,IAAI,eAAe,CAAC,GAAG,CAAC,MAAM,CAAC,QAAQ,CAAC;QAAE,OAAM;IAC/E,MAAM,IAAI,2BAAkB,CAC1B,aAAa,EACb,0CAA0C,MAAM,CAAC,QAAQ,yCAAyC,CACnG,CAAA;AACH,CAAC,CAAA;AAED,qEAAqE;AACrE,MAAM,cAAc,GAAG,CAAC,MAAc,EAAU,EAAE,CAChD,MAAM,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,IAAI,CAAC,WAAW,EAAE,EAAE,CAAC,CAAA;AAE9D;;;GAGG;AACH,MAAM,YAAY,GAAG,IAAI,GAAG,CAAC,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC,CAAA;AAEhD,gGAAgG;AAChG,MAAM,YAAY,GAAG,CAAC,IAA6B,EAAsB,EAAE,CACzE,IAAI,CAAC,MAAM,KAAK,YAAY,IAAI,IAAI,CAAC,MAAM,KAAK,YAAY,CAAA;AAE9D,gGAAgG;AAChG,MAAM,YAAY,GAAG,CAAC,IAA6B,EAAsB,EAAE,CACzE,IAAI,CAAC,MAAM,KAAK,MAAM;IACtB,OAAO,IAAI,CAAC,QAAQ,KAAK,QAAQ;IACjC,OAAO,IAAI,CAAC,OAAO,KAAK,QAAQ;IAChC,CAAC,IAAI,CAAC,MAAM,KAAK,IAAI,IAAI,OAAO,IAAI,CAAC,MAAM,KAAK,QAAQ,CAAC;IACzD,OAAO,IAAI,CAAC,YAAY,KAAK,QAAQ;IACrC,IAAI,CAAC,YAAY,KAAK,IAAI,CAAA;AAE5B,MAAM,iBAAiB,GAAG,CAAC,IAAY,EAAE,IAAa,EAAU,EAAE;IAChE,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,EAAE,IAAI,EAAE,CAAC,CAAA;IAChF,MAAM,UAAU,GAAG,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,MAAM,CAAA;IACxD,IAAI,UAAU,GAAG,wBAAc;QAC7B,MAAM,IAAI,2BAAkB,CAC1B,mBAAmB,EACnB,6BAA6B,UAAU,qCAAqC,wBAAc,QAAQ,CACnG,CAAA;IACH,OAAO,IAAI,CAAA;AACb,CAAC,CAAA;AAED;;;;;GAKG;AACI,MAAM,yBAAyB,GAAG,CACvC,MAAkD,EAC1B,EAAE;IAC1B,cAAc,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;IAC1B,oFAAoF;IACpF,8DAA8D;IAC9D,MAAM,OAAO,GAAG,IAAI,0BAAO,CAAC,IAAA,qBAAY,EAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAA;IACxD,MAAM,SAAS,GAAG,MAAM,CAAC,KAAK,IAAI,KAAK,CAAA;IACvC,MAAM,YAAY,GAAG,MAAM,CAAC,YAAY,IAAI,CAAC,GAAG,EAAE,CAAC,MAAM,CAAC,UAAU,EAAE,CAAC,CAAA;IACvE,MAAM,WAAW,GAAG,MAAM,CAAC,WAAW,IAAI,8BAAoB,CAAA;IAE9D;;;;OAIG;IACH,MAAM,QAAQ,GAAG,KAAK,EACpB,IAAY,EACZ,IAAa,EACb,cAA4D,EAChD,EAAE;QACd,MAAM,IAAI,GAAG,iBAAiB,CAAC,IAAI,EAAE,IAAI,CAAC,CAAA;QAC1C,iFAAiF;QACjF,6CAA6C;QAC7C,MAAM,SAAS,GAAG,YAAY,EAAE,CAAA;QAChC,MAAM,YAAY,GAAG,MAAM,IAAA,iBAAO,EAAC;YACjC,GAAG,EAAE,MAAM,CAAC,GAAG;YACf,IAAI;YACJ,SAAS;YACT,IAAI,EAAE,CAAC,gBAAgB,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,IAAI,CAAC,gBAAgB,GAAG,IAAI,CAAC,EAAE,IAAI,CAAC;YAC5F,SAAS;YACT,WAAW;YACX,MAAM,EAAE,MAAM,CAAC,MAAM;SACtB,CAAC,CAAA;QACF,IAAI,CAAC,cAAc,CAAC,YAAY,CAAC;YAC/B,MAAM,IAAI,2BAAkB,CAC1B,qBAAqB,EACrB,kBAAkB,IAAI,yDAAyD,MAAM,CAAC,YAAY,CAAC,MAAM,CAAC,GAAG,CAC9G,CAAA;QACH,OAAO,YAAY,CAAA;IACrB,CAAC,CAAA;IAED,MAAM,SAAS,GAAG,CAAC,IAAY,EAAE,IAAa,EAAuB,EAAE,CACrE,QAAQ,CAAC,IAAI,EAAE,IAAI,EAAE,YAAY,CAAC,CAAA;IAEpC,MAAM,IAAI,GAAG;QACX,IAAI,EAAE,CAAgC,IAAO,EAAE,GAAG,IAAiB,EAAuB,EAAE,CAC1F,SAAS,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;QAChC,IAAI,EAAE,GAAwB,EAAE,CAAC,QAAQ,CAAC,cAAc,EAAE,EAAE,EAAE,YAAY,CAAC;KAC5E,CAAA;IAED,8FAA8F;IAC9F,MAAM,mBAAmB,GAAG,CAAC,UAAkB,EAAE,EAAE,CACjD,IAAI,KAAK,CACP,EAAE,EACF;QACE,GAAG,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACvB,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,YAAY,CAAC,GAAG,CAAC,MAAM,CAAC;gBAAE,OAAO,SAAS,CAAA;YAC5E,OAAO,CAAC,IAAc,EAAE,EAAE,CACxB,SAAS,CAAC,GAAG,UAAU,IAAI,cAAc,CAAC,MAAM,CAAC,EAAE,EAAE,IAAI,IAAI,EAAE,CAAC,CAAA;QACpE,CAAC;KACF,CACF,CAAA;IAEH,0FAA0F;IAC1F,kFAAkF;IAClF,yEAAyE;IACzE,OAAO,IAAI,KAAK,CAAC,IAAI,EAAE;QACrB,GAAG,EAAE,CAAC,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE;YAC9B,iFAAiF;YACjF,IAAI,IAAI,IAAI,MAAM,IAAI,OAAO,IAAI,KAAK,QAAQ;gBAAE,OAAO,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAA;YAC1F,IAAI,YAAY,CAAC,GAAG,CAAC,IAAI,CAAC;gBAAE,OAAO,SAAS,CAAA;YAC5C,OAAO,mBAAmB,CAAC,IAAI,CAAC,CAAA;QAClC,CAAC;KACF,CAA2B,CAAA;AAC9B,CAAC,CAAA;AA3EY,QAAA,yBAAyB,6BA2ErC"}

package/dist/src/deliver.d.ts

@@ -0,0 +1,31 @@
+/** The receiver caps request bodies at 4 KB; oversized bodies get the uniform 404. */
+export declare const MAX_BODY_BYTES: number;
+export declare const DEFAULT_MAX_ATTEMPTS = 3;
+/**
+ * Runtime mirror of the generated `WebhookWireErrorCode` union (the types package is
+ * deliberately zero-runtime, so the value list lives here). `satisfies` rejects unknown
+ * codes; a compile-time exhaustiveness test catches missing ones. Either way, receiver
+ * drift fails the build instead of shipping.
+ */
+export declare const WIRE_ERROR_CODES: readonly ["invalid_request", "invalid_args", "not_found", "capability_not_found", "capability_not_declared", "method_not_found", "token_revoked", "unsupported_media_type", "internal_error", "service_unavailable"];
+export type DeliverArgs = {
+    url: string;
+    /** The exact serialized body, signed per attempt and sent unchanged. */
+    body: string;
+    /** Stable across retries: the server dedups the last 10 ids per object, making retries idempotent. */
+    webhookId: string;
+    /** Signs `webhookId`/timestamp/body; called per attempt so retries carry a fresh timestamp. */
+    sign: (timestampSeconds: number) => string;
+    fetchImpl: typeof fetch;
+    maxAttempts: number;
+    /** Aborts the in-flight fetch and any pending backoff sleep; surfaces as an `aborted` error. */
+    signal?: AbortSignal;
+};
+/**
+ * POST the signed event, retrying transient failures (429 honoring `RateLimit-Reset`,
+ * 5xx honoring `Retry-After`, network errors) with exponential backoff + jitter.
+ * Resolves with the parsed 200 body; throws `WebhookObjectError` otherwise. An aborted
+ * `signal` cancels the in-flight fetch and any pending backoff, throwing `aborted` at once.
+ */
+export declare const deliver: (args: DeliverArgs) => Promise<Record<string, unknown>>;
+//# sourceMappingURL=deliver.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"deliver.d.ts","sourceRoot":"","sources":["../../src/deliver.ts"],"names":[],"mappings":"AAGA,sFAAsF;AACtF,eAAO,MAAM,cAAc,QAAW,CAAA;AAEtC,eAAO,MAAM,oBAAoB,IAAI,CAAA;AAOrC;;;;;GAKG;AACH,eAAO,MAAM,gBAAgB,sNAWuB,CAAA;AAsFpD,MAAM,MAAM,WAAW,GAAG;IACxB,GAAG,EAAE,MAAM,CAAA;IACX,wEAAwE;IACxE,IAAI,EAAE,MAAM,CAAA;IACZ,sGAAsG;IACtG,SAAS,EAAE,MAAM,CAAA;IACjB,+FAA+F;IAC/F,IAAI,EAAE,CAAC,gBAAgB,EAAE,MAAM,KAAK,MAAM,CAAA;IAC1C,SAAS,EAAE,OAAO,KAAK,CAAA;IACvB,WAAW,EAAE,MAAM,CAAA;IACnB,gGAAgG;IAChG,MAAM,CAAC,EAAE,WAAW,CAAA;CACrB,CAAA;AAED;;;;;GAKG;AACH,eAAO,MAAM,OAAO,GAAU,MAAM,WAAW,KAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAMhF,CAAA"}

package/dist/src/deliver.js

@@ -0,0 +1,150 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.deliver = exports.WIRE_ERROR_CODES = exports.DEFAULT_MAX_ATTEMPTS = exports.MAX_BODY_BYTES = void 0;
+const errors_1 = require("./errors");
+/** The receiver caps request bodies at 4 KB; oversized bodies get the uniform 404. */
+exports.MAX_BODY_BYTES = 4 * 1024;
+exports.DEFAULT_MAX_ATTEMPTS = 3;
+const BACKOFF_BASE_MS = 500;
+const BACKOFF_CAP_MS = 30_000;
+/** Small buffer past `RateLimit-Reset` so the retry lands after the window actually rolls. */
+const RATE_LIMIT_GRACE_MS = 250;
+/**
+ * Runtime mirror of the generated `WebhookWireErrorCode` union (the types package is
+ * deliberately zero-runtime, so the value list lives here). `satisfies` rejects unknown
+ * codes; a compile-time exhaustiveness test catches missing ones. Either way, receiver
+ * drift fails the build instead of shipping.
+ */
+exports.WIRE_ERROR_CODES = [
+    "invalid_request",
+    "invalid_args",
+    "not_found",
+    "capability_not_found",
+    "capability_not_declared",
+    "method_not_found",
+    "token_revoked",
+    "unsupported_media_type",
+    "internal_error",
+    "service_unavailable",
+];
+const SERVER_ERROR_CODES = new Set(exports.WIRE_ERROR_CODES);
+const ERROR_HINTS = {
+    not_found: "uniform pre-auth failure: check the URL, the secret, clock skew (±5 min), and that the body was not re-serialized after signing",
+    capability_not_declared: "this object's preset doesn't accept that event type, run ping() to see what it accepts",
+    token_revoked: "the API key was regenerated, copy the new one from the object's ⋮ menu",
+    rate_limited: "rate limited (per space or per IP) and retries were exhausted",
+};
+const abortError = (signal) => new errors_1.WebhookObjectError("aborted", "webhook object delivery aborted", { cause: signal.reason });
+/** Sleep `ms`, but reject early (and clean up its listener) if `signal` aborts mid-wait. */
+const sleep = (ms, signal) => new Promise((resolve, reject) => {
+    if (signal?.aborted) {
+        reject(abortError(signal));
+        return;
+    }
+    if (!signal) {
+        setTimeout(resolve, ms);
+        return;
+    }
+    const onAbort = () => {
+        clearTimeout(timer);
+        reject(abortError(signal));
+    };
+    const timer = setTimeout(() => {
+        signal.removeEventListener("abort", onAbort);
+        resolve();
+    }, ms);
+    signal.addEventListener("abort", onAbort, { once: true });
+});
+const backoffDelayMs = (attempt) => Math.min(BACKOFF_BASE_MS * 2 ** attempt, BACKOFF_CAP_MS) * (0.5 + Math.random() * 0.5);
+const retryDelayMs = (response, attempt) => {
+    if (response.status === 429) {
+        // The receiver uses `express-rate-limit` with `standardHeaders: true` (IETF draft-6), which
+        // sets `RateLimit-Reset` to the number of SECONDS remaining until the window resets.
+        const resetHeader = response.headers.get("RateLimit-Reset");
+        const resetSeconds = resetHeader === null ? NaN : Number(resetHeader);
+        if (Number.isFinite(resetSeconds) && resetSeconds >= 0)
+            return resetSeconds * 1000 + RATE_LIMIT_GRACE_MS;
+    }
+    const retryAfterSeconds = Number(response.headers.get("Retry-After"));
+    if (Number.isFinite(retryAfterSeconds) && retryAfterSeconds > 0)
+        return retryAfterSeconds * 1000;
+    return backoffDelayMs(attempt);
+};
+/** Retry only what the receiver documents as transient: 429 and 5xx. 4xx means "fix the request". */
+const isRetryableStatus = (status) => status === 429 || status >= 500;
+const parseBody = async (response) => {
+    try {
+        // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
+        return (await response.json());
+    }
+    catch {
+        return undefined;
+    }
+};
+const isWireErrorCode = (code) => SERVER_ERROR_CODES.has(code);
+const errorFromResponse = (status, body) => {
+    const code = (() => {
+        if (status === 429)
+            return "rate_limited";
+        const bodyCode = body?.error;
+        if (typeof bodyCode === "string" && isWireErrorCode(bodyCode))
+            return bodyCode;
+        return "unexpected_response";
+    })();
+    const hint = ERROR_HINTS[code];
+    return new errors_1.WebhookObjectError(code, `webhook object delivery failed (${status}): ${code}${hint ? ` (${hint})` : ""}`, { status, body });
+};
+/**
+ * POST the signed event, retrying transient failures (429 honoring `RateLimit-Reset`,
+ * 5xx honoring `Retry-After`, network errors) with exponential backoff + jitter.
+ * Resolves with the parsed 200 body; throws `WebhookObjectError` otherwise. An aborted
+ * `signal` cancels the in-flight fetch and any pending backoff, throwing `aborted` at once.
+ */
+const deliver = async (args) => {
+    // Terminates because `attemptOnce` always throws on the last attempt.
+    for (let attempt = 0;; attempt++) {
+        const response = await attemptOnce(args, attempt);
+        if (response !== undefined)
+            return response;
+    }
+};
+exports.deliver = deliver;
+/** One attempt: returns the parsed success body, or undefined after sleeping off a transient failure. */
+const attemptOnce = async (args, attempt) => {
+    const isLastAttempt = attempt >= args.maxAttempts - 1;
+    const timestampSeconds = Math.floor(Date.now() / 1000);
+    if (args.signal?.aborted)
+        throw abortError(args.signal);
+    let response;
+    try {
+        response = await args.fetchImpl(args.url, {
+            method: "POST",
+            headers: {
+                "content-type": "application/json",
+                "webhook-id": args.webhookId,
+                "webhook-timestamp": String(timestampSeconds),
+                "webhook-signature": args.sign(timestampSeconds),
+            },
+            body: args.body,
+            signal: args.signal,
+        });
+    }
+    catch (cause) {
+        // An abort surfaces here as a fetch rejection; report it as `aborted` and never retry it.
+        if (args.signal?.aborted)
+            throw abortError(args.signal);
+        const error = new errors_1.WebhookObjectError("network_error", "webhook object delivery failed: network error", { cause });
+        if (isLastAttempt)
+            throw error;
+        await sleep(backoffDelayMs(attempt), args.signal);
+        return undefined;
+    }
+    if (response.ok)
+        return (await parseBody(response)) ?? {};
+    const error = errorFromResponse(response.status, await parseBody(response));
+    if (!isRetryableStatus(response.status) || isLastAttempt)
+        throw error;
+    await sleep(retryDelayMs(response, attempt), args.signal);
+    return undefined;
+};
+//# sourceMappingURL=deliver.js.map

package/dist/src/deliver.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"deliver.js","sourceRoot":"","sources":["../../src/deliver.ts"],"names":[],"mappings":";;;AACA,qCAAqE;AAErE,sFAAsF;AACzE,QAAA,cAAc,GAAG,CAAC,GAAG,IAAI,CAAA;AAEzB,QAAA,oBAAoB,GAAG,CAAC,CAAA;AAErC,MAAM,eAAe,GAAG,GAAG,CAAA;AAC3B,MAAM,cAAc,GAAG,MAAM,CAAA;AAC7B,8FAA8F;AAC9F,MAAM,mBAAmB,GAAG,GAAG,CAAA;AAE/B;;;;;GAKG;AACU,QAAA,gBAAgB,GAAG;IAC9B,iBAAiB;IACjB,cAAc;IACd,WAAW;IACX,sBAAsB;IACtB,yBAAyB;IACzB,kBAAkB;IAClB,eAAe;IACf,wBAAwB;IACxB,gBAAgB;IAChB,qBAAqB;CAC6B,CAAA;AAEpD,MAAM,kBAAkB,GAAwB,IAAI,GAAG,CAAC,wBAAgB,CAAC,CAAA;AAEzE,MAAM,WAAW,GAAoD;IACnE,SAAS,EACP,iIAAiI;IACnI,uBAAuB,EACrB,wFAAwF;IAC1F,aAAa,EAAE,wEAAwE;IACvF,YAAY,EAAE,+DAA+D;CAC9E,CAAA;AAED,MAAM,UAAU,GAAG,CAAC,MAAmB,EAAsB,EAAE,CAC7D,IAAI,2BAAkB,CAAC,SAAS,EAAE,iCAAiC,EAAE,EAAE,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,CAAC,CAAA;AAEhG,4FAA4F;AAC5F,MAAM,KAAK,GAAG,CAAC,EAAU,EAAE,MAAoB,EAAiB,EAAE,CAChE,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;IAC9B,IAAI,MAAM,EAAE,OAAO,EAAE,CAAC;QACpB,MAAM,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAA;QAC1B,OAAM;IACR,CAAC;IACD,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,UAAU,CAAC,OAAO,EAAE,EAAE,CAAC,CAAA;QACvB,OAAM;IACR,CAAC;IACD,MAAM,OAAO,GAAG,GAAS,EAAE;QACzB,YAAY,CAAC,KAAK,CAAC,CAAA;QACnB,MAAM,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAA;IAC5B,CAAC,CAAA;IACD,MAAM,KAAK,GAAG,UAAU,CAAC,GAAG,EAAE;QAC5B,MAAM,CAAC,mBAAmB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAA;QAC5C,OAAO,EAAE,CAAA;IACX,CAAC,EAAE,EAAE,CAAC,CAAA;IACN,MAAM,CAAC,gBAAgB,CAAC,OAAO,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAA;AAC3D,CAAC,CAAC,CAAA;AAEJ,MAAM,cAAc,GAAG,CAAC,OAAe,EAAU,EAAE,CACjD,IAAI,CAAC,GAAG,CAAC,eAAe,GAAG,CAAC,IAAI,OAAO,EAAE,cAAc,CAAC,GAAG,CAAC,GAAG,GAAG,IAAI,CAAC,MAAM,EAAE,GAAG,GAAG,CAAC,CAAA;AAExF,MAAM,YAAY,GAAG,CAAC,QAAkB,EAAE,OAAe,EAAU,EAAE;IACnE,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;QAC5B,4FAA4F;QAC5F,qFAAqF;QACrF,MAAM,WAAW,GAAG,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAA;QAC3D,MAAM,YAAY,GAAG,WAAW,KAAK,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,MAAM,CAAC,WAAW,CAAC,CAAA;QACrE,IAAI,MAAM,CAAC,QAAQ,CAAC,YAAY,CAAC,IAAI,YAAY,IAAI,CAAC;YACpD,OAAO,YAAY,GAAG,IAAI,GAAG,mBAAmB,CAAA;IACpD,CAAC;IACD,MAAM,iBAAiB,GAAG,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC,CAAA;IACrE,IAAI,MAAM,CAAC,QAAQ,CAAC,iBAAiB,CAAC,IAAI,iBAAiB,GAAG,CAAC;QAAE,OAAO,iBAAiB,GAAG,IAAI,CAAA;IAChG,OAAO,cAAc,CAAC,OAAO,CAAC,CAAA;AAChC,CAAC,CAAA;AAED,qGAAqG;AACrG,MAAM,iBAAiB,GAAG,CAAC,MAAc,EAAW,EAAE,CAAC,MAAM,KAAK,GAAG,IAAI,MAAM,IAAI,GAAG,CAAA;AAEtF,MAAM,SAAS,GAAG,KAAK,EACrB,QAAkB,EACM,EAAE;IAC1B,IAAI,CAAC;QACH,yEAAyE;QACzE,OAAO,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAM,CAAA;IACrC,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,SAAS,CAAA;IAClB,CAAC;AACH,CAAC,CAAA;AAED,MAAM,eAAe,GAAG,CAAC,IAAY,EAAgC,EAAE,CAAC,kBAAkB,CAAC,GAAG,CAAC,IAAI,CAAC,CAAA;AAEpG,MAAM,iBAAiB,GAAG,CAAC,MAAc,EAAE,IAAyC,EAAE,EAAE;IACtF,MAAM,IAAI,GAAG,CAAC,GAA2B,EAAE;QACzC,IAAI,MAAM,KAAK,GAAG;YAAE,OAAO,cAAc,CAAA;QACzC,MAAM,QAAQ,GAAG,IAAI,EAAE,KAAK,CAAA;QAC5B,IAAI,OAAO,QAAQ,KAAK,QAAQ,IAAI,eAAe,CAAC,QAAQ,CAAC;YAAE,OAAO,QAAQ,CAAA;QAC9E,OAAO,qBAAqB,CAAA;IAC9B,CAAC,CAAC,EAAE,CAAA;IACJ,MAAM,IAAI,GAAG,WAAW,CAAC,IAAI,CAAC,CAAA;IAC9B,OAAO,IAAI,2BAAkB,CAC3B,IAAI,EACJ,mCAAmC,MAAM,MAAM,IAAI,GAAG,IAAI,CAAC,CAAC,CAAC,KAAK,IAAI,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,EAChF,EAAE,MAAM,EAAE,IAAI,EAAE,CACjB,CAAA;AACH,CAAC,CAAA;AAgBD;;;;;GAKG;AACI,MAAM,OAAO,GAAG,KAAK,EAAE,IAAiB,EAAoC,EAAE;IACnF,sEAAsE;IACtE,KAAK,IAAI,OAAO,GAAG,CAAC,GAAI,OAAO,EAAE,EAAE,CAAC;QAClC,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,IAAI,EAAE,OAAO,CAAC,CAAA;QACjD,IAAI,QAAQ,KAAK,SAAS;YAAE,OAAO,QAAQ,CAAA;IAC7C,CAAC;AACH,CAAC,CAAA;AANY,QAAA,OAAO,WAMnB;AAED,yGAAyG;AACzG,MAAM,WAAW,GAAG,KAAK,EACvB,IAAiB,EACjB,OAAe,EAC+B,EAAE;IAChD,MAAM,aAAa,GAAG,OAAO,IAAI,IAAI,CAAC,WAAW,GAAG,CAAC,CAAA;IACrD,MAAM,gBAAgB,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,CAAA;IAEtD,IAAI,IAAI,CAAC,MAAM,EAAE,OAAO;QAAE,MAAM,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;IAEvD,IAAI,QAAkB,CAAA;IACtB,IAAI,CAAC;QACH,QAAQ,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,EAAE;YACxC,MAAM,EAAE,MAAM;YACd,OAAO,EAAE;gBACP,cAAc,EAAE,kBAAkB;gBAClC,YAAY,EAAE,IAAI,CAAC,SAAS;gBAC5B,mBAAmB,EAAE,MAAM,CAAC,gBAAgB,CAAC;gBAC7C,mBAAmB,EAAE,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC;aACjD;YACD,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,MAAM,EAAE,IAAI,CAAC,MAAM;SACpB,CAAC,CAAA;IACJ,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,0FAA0F;QAC1F,IAAI,IAAI,CAAC,MAAM,EAAE,OAAO;YAAE,MAAM,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;QACvD,MAAM,KAAK,GAAG,IAAI,2BAAkB,CAClC,eAAe,EACf,+CAA+C,EAC/C,EAAE,KAAK,EAAE,CACV,CAAA;QACD,IAAI,aAAa;YAAE,MAAM,KAAK,CAAA;QAC9B,MAAM,KAAK,CAAC,cAAc,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,MAAM,CAAC,CAAA;QACjD,OAAO,SAAS,CAAA;IAClB,CAAC;IAED,IAAI,QAAQ,CAAC,EAAE;QAAE,OAAO,CAAC,MAAM,SAAS,CAAC,QAAQ,CAAC,CAAC,IAAI,EAAE,CAAA;IAEzD,MAAM,KAAK,GAAG,iBAAiB,CAAC,QAAQ,CAAC,MAAM,EAAE,MAAM,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAA;IAC3E,IAAI,CAAC,iBAAiB,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,aAAa;QAAE,MAAM,KAAK,CAAA;IACrE,MAAM,KAAK,CAAC,YAAY,CAAC,QAAQ,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,MAAM,CAAC,CAAA;IACzD,OAAO,SAAS,CAAA;AAClB,CAAC,CAAA"}

package/dist/src/errors.d.ts

@@ -0,0 +1,32 @@
+import type { WebhookWireErrorCode } from "@gathertown/webhook-object-types";
+/**
+ * Error codes surfaced by `WebhookObjectError.code`.
+ *
+ * Wire codes come verbatim from the generated `WebhookWireErrorCode` (the receiver's error
+ * bodies); the rest are client-side conditions the SDK detects before/around the HTTP exchange.
+ */
+export type WebhookObjectErrorCode = WebhookWireErrorCode | "rate_limited" | "payload_too_large" | "invalid_secret" | "invalid_url" | "network_error" | "aborted" | "unexpected_response";
+/**
+ * The single error type the SDK throws. `code` classifies the failure (see
+ * {@link WebhookObjectErrorCode}) and `status` carries the HTTP status when the error
+ * originated from a response.
+ */
+export declare class WebhookObjectError extends Error {
+    readonly code: WebhookObjectErrorCode;
+    readonly name = "WebhookObjectError";
+    constructor(code: WebhookObjectErrorCode, message: string, options?: {
+        /** HTTP status of the response, when the error came from one. */
+        status?: number;
+        /** Parsed response body, when the error came from one, for reading server-provided fields. */
+        body?: unknown;
+        cause?: unknown;
+    });
+    readonly status: number | undefined;
+    /**
+     * The parsed response body for errors that came from an HTTP response (e.g. `{ error: "…" }`),
+     * or `undefined` for client-side errors and unparseable bodies. Lets integrators read any
+     * extra fields the receiver returns beyond `code`/`status`.
+     */
+    readonly body: unknown;
+}
+//# sourceMappingURL=errors.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../../src/errors.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,kCAAkC,CAAA;AAE5E;;;;;GAKG;AACH,MAAM,MAAM,sBAAsB,GAC9B,oBAAoB,GAGpB,cAAc,GAEd,mBAAmB,GAEnB,gBAAgB,GAEhB,aAAa,GAEb,eAAe,GAEf,SAAS,GAET,qBAAqB,CAAA;AAEzB;;;;GAIG;AACH,qBAAa,kBAAmB,SAAQ,KAAK;IAIzC,QAAQ,CAAC,IAAI,EAAE,sBAAsB;IAHvC,SAAkB,IAAI,wBAAuB;gBAGlC,IAAI,EAAE,sBAAsB,EACrC,OAAO,EAAE,MAAM,EACf,OAAO,CAAC,EAAE;QACR,iEAAiE;QACjE,MAAM,CAAC,EAAE,MAAM,CAAA;QACf,8FAA8F;QAC9F,IAAI,CAAC,EAAE,OAAO,CAAA;QACd,KAAK,CAAC,EAAE,OAAO,CAAA;KAChB;IAOH,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAA;IAEnC;;;;OAIG;IACH,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAA;CACvB"}

package/dist/src/errors.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WebhookObjectError = void 0;
+/**
+ * The single error type the SDK throws. `code` classifies the failure (see
+ * {@link WebhookObjectErrorCode}) and `status` carries the HTTP status when the error
+ * originated from a response.
+ */
+class WebhookObjectError extends Error {
+    code;
+    name = "WebhookObjectError";
+    constructor(code, message, options) {
+        super(message, options?.cause === undefined ? undefined : { cause: options.cause });
+        this.code = code;
+        this.status = options?.status;
+        this.body = options?.body;
+    }
+    status;
+    /**
+     * The parsed response body for errors that came from an HTTP response (e.g. `{ error: "…" }`),
+     * or `undefined` for client-side errors and unparseable bodies. Lets integrators read any
+     * extra fields the receiver returns beyond `code`/`status`.
+     */
+    body;
+}
+exports.WebhookObjectError = WebhookObjectError;
+//# sourceMappingURL=errors.js.map

package/dist/src/errors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.js","sourceRoot":"","sources":["../../src/errors.ts"],"names":[],"mappings":";;;AA0BA;;;;GAIG;AACH,MAAa,kBAAmB,SAAQ,KAAK;IAIhC;IAHO,IAAI,GAAG,oBAAoB,CAAA;IAE7C,YACW,IAA4B,EACrC,OAAe,EACf,OAMC;QAED,KAAK,CAAC,OAAO,EAAE,OAAO,EAAE,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,EAAE,CAAC,CAAA;QAV1E,SAAI,GAAJ,IAAI,CAAwB;QAWrC,IAAI,CAAC,MAAM,GAAG,OAAO,EAAE,MAAM,CAAA;QAC7B,IAAI,CAAC,IAAI,GAAG,OAAO,EAAE,IAAI,CAAA;IAC3B,CAAC;IAEQ,MAAM,CAAoB;IAEnC;;;;OAIG;IACM,IAAI,CAAS;CACvB;AA3BD,gDA2BC"}

package/dist/src/index.d.ts

@@ -0,0 +1,5 @@
+export { createWebhookObjectCatalog, type WebhookObjectCatalog, type WebhookObjectCatalogEntry, type WebhookObjectCatalogOptions, } from "./catalog";
+export { type AllowedEventType, type CapabilityNamespaces, createWebhookObjectClient, type PingResult, type SendResult, type WebhookObjectClient, type WebhookObjectClientConfig, } from "./client";
+export { WebhookObjectError, type WebhookObjectErrorCode } from "./errors";
+export { secretFromEnv, unsafeSecretLiteral, type WebhookObjectSecret } from "./secret";
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,0BAA0B,EAC1B,KAAK,oBAAoB,EACzB,KAAK,yBAAyB,EAC9B,KAAK,2BAA2B,GACjC,MAAM,WAAW,CAAA;AAClB,OAAO,EACL,KAAK,gBAAgB,EACrB,KAAK,oBAAoB,EACzB,yBAAyB,EACzB,KAAK,UAAU,EACf,KAAK,UAAU,EACf,KAAK,mBAAmB,EACxB,KAAK,yBAAyB,GAC/B,MAAM,UAAU,CAAA;AACjB,OAAO,EAAE,kBAAkB,EAAE,KAAK,sBAAsB,EAAE,MAAM,UAAU,CAAA;AAC1E,OAAO,EAAE,aAAa,EAAE,mBAAmB,EAAE,KAAK,mBAAmB,EAAE,MAAM,UAAU,CAAA"}

package/dist/src/index.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.unsafeSecretLiteral = exports.secretFromEnv = exports.WebhookObjectError = exports.createWebhookObjectClient = exports.createWebhookObjectCatalog = void 0;
+var catalog_1 = require("./catalog");
+Object.defineProperty(exports, "createWebhookObjectCatalog", { enumerable: true, get: function () { return catalog_1.createWebhookObjectCatalog; } });
+var client_1 = require("./client");
+Object.defineProperty(exports, "createWebhookObjectClient", { enumerable: true, get: function () { return client_1.createWebhookObjectClient; } });
+var errors_1 = require("./errors");
+Object.defineProperty(exports, "WebhookObjectError", { enumerable: true, get: function () { return errors_1.WebhookObjectError; } });
+var secret_1 = require("./secret");
+Object.defineProperty(exports, "secretFromEnv", { enumerable: true, get: function () { return secret_1.secretFromEnv; } });
+Object.defineProperty(exports, "unsafeSecretLiteral", { enumerable: true, get: function () { return secret_1.unsafeSecretLiteral; } });
+//# sourceMappingURL=index.js.map

package/dist/src/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;AAAA,qCAKkB;AAJhB,qHAAA,0BAA0B,OAAA;AAK5B,mCAQiB;AALf,mHAAA,yBAAyB,OAAA;AAM3B,mCAA0E;AAAjE,4GAAA,kBAAkB,OAAA;AAC3B,mCAAuF;AAA9E,uGAAA,aAAa,OAAA;AAAE,6GAAA,mBAAmB,OAAA"}

package/dist/src/secret.d.ts

@@ -0,0 +1,30 @@
+declare const webhookObjectSecretBrand: unique symbol;
+/**
+ * An opaque handle to a `whsec_…` signing secret, obtained via {@link secretFromEnv} or
+ * {@link unsafeSecretLiteral}. Unlike a bare string (which the client also accepts), the
+ * handle redacts itself when logged or serialized, so it can't leak through console output,
+ * error reporters, or `JSON.stringify` of a config object.
+ */
+export type WebhookObjectSecret = {
+    readonly [webhookObjectSecretBrand]: true;
+};
+/**
+ * Read a `whsec_…` secret from the named environment variable. The recommended way to
+ * provide a secret: the value never appears in your source, and a missing or malformed
+ * variable fails fast with the variable's name (never its value).
+ */
+export declare const secretFromEnv: (name: string) => WebhookObjectSecret;
+/**
+ * Wrap a secret you already hold as a string (secret managers, non-Node runtimes without
+ * `process.env`). Named `unsafe` so hardcoded `whsec_…` literals are easy to grep for in
+ * review; never commit a literal secret to source control.
+ */
+export declare const unsafeSecretLiteral: (value: string) => WebhookObjectSecret;
+/**
+ * Internal: recover the raw secret for signing. Not re-exported from the package entry
+ * point. Bare strings are validated in place; anything else must be a handle minted by
+ * this module (an object that isn't one fails the WeakMap lookup and throws).
+ */
+export declare const revealSecret: (secret: WebhookObjectSecret | string) => string;
+export {};
+//# sourceMappingURL=secret.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"secret.d.ts","sourceRoot":"","sources":["../../src/secret.ts"],"names":[],"mappings":"AAKA,OAAO,CAAC,MAAM,wBAAwB,EAAE,OAAO,MAAM,CAAA;AAErD;;;;;GAKG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAAE,QAAQ,CAAC,CAAC,wBAAwB,CAAC,EAAE,IAAI,CAAA;CAAE,CAAA;AAyB/E;;;;GAIG;AACH,eAAO,MAAM,aAAa,GAAI,MAAM,MAAM,KAAG,mBACY,CAAA;AAEzD;;;;GAIG;AACH,eAAO,MAAM,mBAAmB,GAAI,OAAO,MAAM,KAAG,mBACZ,CAAA;AAExC;;;;GAIG;AACH,eAAO,MAAM,YAAY,GAAI,QAAQ,mBAAmB,GAAG,MAAM,KAAG,MAgBnE,CAAA"}

package/dist/src/secret.js

@@ -0,0 +1,55 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.revealSecret = exports.unsafeSecretLiteral = exports.secretFromEnv = void 0;
+const errors_1 = require("./errors");
+/** Fail fast on malformed secrets: `whsec_` + at least 20 chars of key material. */
+const SECRET_PATTERN = /^whsec_.{20,}/;
+/** Secret values live here, keyed by handle identity, so no property on the handle exposes them. */
+const secretValues = new WeakMap();
+const REDACTED = "[redacted webhook object secret]";
+const brandSecret = (value, source) => {
+    if (!SECRET_PATTERN.test(value))
+        throw new errors_1.WebhookObjectError("invalid_secret", `webhook object secret from ${source} is missing or malformed, expected a whsec_… key`);
+    const handle = {
+        toString: () => REDACTED,
+        toJSON: () => REDACTED,
+        [Symbol.for("nodejs.util.inspect.custom")]: () => REDACTED,
+    };
+    // The brand symbol exists only at the type level; the WeakMap entry is the runtime brand.
+    // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
+    const secret = handle;
+    secretValues.set(secret, value);
+    return secret;
+};
+/**
+ * Read a `whsec_…` secret from the named environment variable. The recommended way to
+ * provide a secret: the value never appears in your source, and a missing or malformed
+ * variable fails fast with the variable's name (never its value).
+ */
+const secretFromEnv = (name) => brandSecret(process.env[name] ?? "", `env var ${name}`);
+exports.secretFromEnv = secretFromEnv;
+/**
+ * Wrap a secret you already hold as a string (secret managers, non-Node runtimes without
+ * `process.env`). Named `unsafe` so hardcoded `whsec_…` literals are easy to grep for in
+ * review; never commit a literal secret to source control.
+ */
+const unsafeSecretLiteral = (value) => brandSecret(value, "a string literal");
+exports.unsafeSecretLiteral = unsafeSecretLiteral;
+/**
+ * Internal: recover the raw secret for signing. Not re-exported from the package entry
+ * point. Bare strings are validated in place; anything else must be a handle minted by
+ * this module (an object that isn't one fails the WeakMap lookup and throws).
+ */
+const revealSecret = (secret) => {
+    if (typeof secret === "string") {
+        if (!SECRET_PATTERN.test(secret))
+            throw new errors_1.WebhookObjectError("invalid_secret", "webhook object secret is malformed, expected a whsec_… key");
+        return secret;
+    }
+    const value = secretValues.get(secret);
+    if (value === undefined)
+        throw new errors_1.WebhookObjectError("invalid_secret", "webhook object secret must be a whsec_… string or created with secretFromEnv() / unsafeSecretLiteral()");
+    return value;
+};
+exports.revealSecret = revealSecret;
+//# sourceMappingURL=secret.js.map

package/dist/src/secret.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"secret.js","sourceRoot":"","sources":["../../src/secret.ts"],"names":[],"mappings":";;;AAAA,qCAA6C;AAE7C,oFAAoF;AACpF,MAAM,cAAc,GAAG,eAAe,CAAA;AAYtC,oGAAoG;AACpG,MAAM,YAAY,GAAG,IAAI,OAAO,EAA+B,CAAA;AAE/D,MAAM,QAAQ,GAAG,kCAAkC,CAAA;AAEnD,MAAM,WAAW,GAAG,CAAC,KAAa,EAAE,MAAc,EAAuB,EAAE;IACzE,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,KAAK,CAAC;QAC7B,MAAM,IAAI,2BAAkB,CAC1B,gBAAgB,EAChB,8BAA8B,MAAM,kDAAkD,CACvF,CAAA;IACH,MAAM,MAAM,GAAG;QACb,QAAQ,EAAE,GAAG,EAAE,CAAC,QAAQ;QACxB,MAAM,EAAE,GAAG,EAAE,CAAC,QAAQ;QACtB,CAAC,MAAM,CAAC,GAAG,CAAC,4BAA4B,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,QAAQ;KAC3D,CAAA;IACD,0FAA0F;IAC1F,yEAAyE;IACzE,MAAM,MAAM,GAAG,MAAwC,CAAA;IACvD,YAAY,CAAC,GAAG,CAAC,MAAM,EAAE,KAAK,CAAC,CAAA;IAC/B,OAAO,MAAM,CAAA;AACf,CAAC,CAAA;AAED;;;;GAIG;AACI,MAAM,aAAa,GAAG,CAAC,IAAY,EAAuB,EAAE,CACjE,WAAW,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,EAAE,EAAE,WAAW,IAAI,EAAE,CAAC,CAAA;AAD5C,QAAA,aAAa,iBAC+B;AAEzD;;;;GAIG;AACI,MAAM,mBAAmB,GAAG,CAAC,KAAa,EAAuB,EAAE,CACxE,WAAW,CAAC,KAAK,EAAE,kBAAkB,CAAC,CAAA;AAD3B,QAAA,mBAAmB,uBACQ;AAExC;;;;GAIG;AACI,MAAM,YAAY,GAAG,CAAC,MAAoC,EAAU,EAAE;IAC3E,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE,CAAC;QAC/B,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,MAAM,CAAC;YAC9B,MAAM,IAAI,2BAAkB,CAC1B,gBAAgB,EAChB,4DAA4D,CAC7D,CAAA;QACH,OAAO,MAAM,CAAA;IACf,CAAC;IACD,MAAM,KAAK,GAAG,YAAY,CAAC,GAAG,CAAC,MAAM,CAAC,CAAA;IACtC,IAAI,KAAK,KAAK,SAAS;QACrB,MAAM,IAAI,2BAAkB,CAC1B,gBAAgB,EAChB,wGAAwG,CACzG,CAAA;IACH,OAAO,KAAK,CAAA;AACd,CAAC,CAAA;AAhBY,QAAA,YAAY,gBAgBxB"}

package/package.json

@@ -0,0 +1,35 @@
+{
+  "name": "@gathertown/webhook-object-sdk",
+  "version": "0.1.1",
+  "description": "Typed client for emitting events to Gather webhook objects (Smart Objects): Standard Webhooks signing, retries, and a fully-inferred send API.",
+  "main": "dist/src/index.js",
+  "types": "dist/src/index.d.ts",
+  "sideEffects": false,
+  "files": [
+    "dist/src/**",
+    "!dist/src/__tests__/**",
+    "README.md",
+    "LICENSE-MIT",
+    "LICENSE-APACHE"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/gathertown/webhook-objects.git"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "engines": {
+    "node": ">=18"
+  },
+  "author": "Gather Presence, Inc.",
+  "license": "MIT OR Apache-2.0",
+  "dependencies": {
+    "@gathertown/webhook-object-types": "^0.1.1",
+    "standardwebhooks": "~1.0.0"
+  },
+  "devDependencies": {
+    "expect-type": "~0.20.0",
+    "typescript": "~6.0.3"
+  }
+}