@barndoor-ai/sdk 1.2.0 → 1.3.0

package/dist/models/index.d.ts

@@ -113,4 +113,137 @@ export declare class AgentToken {
      */
     static fromApiResponse(data: unknown): AgentToken;
 }
+/**
+ * What kind of destination a channel delivers to.
+ *
+ * `in_app` and `user_email` are personal (owned by one user, always the caller);
+ * `email`, `webhook`, `slack` and `teams` are organization-wide.
+ */
+export type ChannelType = 'in_app' | 'user_email' | 'email' | 'webhook' | 'slack' | 'teams';
+/** One alert type a channel is subscribed to. */
+export interface ChannelSubscription {
+    /**
+     * The alert type delivered to the channel (e.g. `break_glass_used`). Read the live
+     * vocabulary from `getChannelOptions()` rather than hardcoding it — the set grows
+     * over time and is gated per organization.
+     */
+    alert_type: string;
+}
+/**
+ * A notification delivery destination.
+ *
+ * Only the destination field belonging to `type` is populated; the rest are null.
+ * Secrets are never returned — a webhook's signing secret and a Teams workflow URL
+ * surface only as the `has_signing_secret` / `has_workflow_url` flags.
+ */
+export interface Channel {
+    /** Server-assigned channel id. */
+    id: string;
+    type: ChannelType;
+    /** Whether the channel currently delivers. */
+    enabled: boolean;
+    /** Owning user for a personal channel; null for organization-wide types. */
+    user_id: string | null;
+    /** Destination for `type: 'email'`. */
+    email_address: string | null;
+    /** Destination for `type: 'webhook'`. */
+    url: string | null;
+    /** Human-readable name, set for `slack` and `teams`. */
+    label: string | null;
+    /** Slack channel id for `type: 'slack'`. */
+    slack_channel_id: string | null;
+    /** Alert types this channel delivers. Empty means it delivers nothing. */
+    subscriptions: ChannelSubscription[];
+    created_at?: string;
+    updated_at?: string;
+    /** Whether a webhook channel has a stored signing secret (never readable back). */
+    has_signing_secret: boolean;
+    /** Whether a teams channel has a stored Workflows URL (itself a secret). */
+    has_workflow_url: boolean;
+    /**
+     * One-time reveal of a newly generated webhook signing secret. Present ONLY on the
+     * response that created it, and null on every later read — store it when you receive
+     * it, or rotate with `regenerateChannelSecret()`.
+     */
+    signing_secret?: string | null;
+}
+/** Response envelope for the channel list endpoints. */
+export interface ChannelListResponse {
+    data: Channel[];
+}
+/** One subscribable alert type, with its intrinsic category and severity. */
+export interface AlertTypeOption {
+    /** What to send as a subscription's `alert_type`. */
+    value: string;
+    label: string;
+    /** Intrinsic to the type, not configurable. */
+    category: string;
+    /** Intrinsic to the type, not configurable. */
+    severity: string;
+}
+/** An enum value paired with its display label. */
+export interface LabeledOption {
+    value: string;
+    label: string;
+}
+/**
+ * The subscription vocabulary a channel's `subscriptions` may draw from.
+ *
+ * `alertTypes` is filtered to what the caller's organization is admitted to —
+ * subscribing to a type absent here is accepted but never delivers.
+ */
+export interface ChannelOptions {
+    alert_types: AlertTypeOption[];
+    /** The full category vocabulary, unfiltered. */
+    categories: LabeledOption[];
+    /** The full severity vocabulary, unfiltered. */
+    severities: LabeledOption[];
+}
+/**
+ * Result of sending a connectivity-test message through a channel.
+ *
+ * A transport failure is reported here as `ok: false` with a reason, not as a thrown
+ * error: the request to test succeeded, the delivery is what failed.
+ */
+export interface ChannelTestResult {
+    ok: boolean;
+    error?: string | null;
+}
+/** The one-time reveal of a webhook channel's signing secret. */
+export interface WebhookSecret {
+    /**
+     * Standard Webhooks secret (`whsec_` + base64), shown exactly once. Rotating
+     * invalidates the previous secret immediately, so deploy this value before the next
+     * alert fires.
+     */
+    signing_secret: string;
+}
+/** Arguments for {@link BarndoorSDK.upsertChannel}. */
+export interface UpsertChannelInput {
+    type: ChannelType;
+    /**
+     * Existing channel to edit authoritatively. Omit to create-or-dedup on the type's
+     * natural identity.
+     */
+    channelId?: string;
+    /** Defaults to true. `false` suspends delivery without deleting the channel. */
+    enabled?: boolean;
+    /** Required for `type: 'email'`. */
+    emailAddress?: string;
+    /** Required for `type: 'webhook'`. Must be https and resolve to a public address. */
+    url?: string;
+    /** Required for `slack` and `teams`. */
+    label?: string;
+    /** Required for `type: 'slack'` — the channel id, not its name. */
+    slackChannelId?: string;
+    /**
+     * Required on create for `type: 'teams'`. Write-only: never returned by any endpoint.
+     */
+    teamsWorkflowUrl?: string;
+    /**
+     * The complete set of alert types to deliver. **Replaces** the channel's existing
+     * set — omitting it unsubscribes the channel from everything.
+     */
+    subscriptions?: string[];
+}
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/models/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG,WAAW,GAAG,SAAS,GAAG,WAAW,CAAC;AAErE;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,8CAA8C;IAC9C,EAAE,EAAE,MAAM,CAAC;IACX,wCAAwC;IACxC,IAAI,EAAE,MAAM,CAAC;IACb,gDAAgD;IAChD,IAAI,EAAE,MAAM,CAAC;IACb,0DAA0D;IAC1D,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,gCAAgC;IAChC,iBAAiB,EAAE,gBAAgB,CAAC;CACrC;AAED;;;;;;GAMG;AACH,qBAAa,aAAa;IACxB,8CAA8C;IAC9C,SAAgB,EAAE,EAAE,MAAM,CAAC;IAC3B,wCAAwC;IACxC,SAAgB,IAAI,EAAE,MAAM,CAAC;IAC7B,gDAAgD;IAChD,SAAgB,IAAI,EAAE,MAAM,CAAC;IAC7B,0DAA0D;IAC1D,SAAgB,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACxC,gCAAgC;IAChC,SAAgB,iBAAiB,EAAE,gBAAgB,CAAC;IAEpD;;;OAGG;gBACS,IAAI,EAAE,iBAAiB;IAanC;;;;OAIG;WACW,eAAe,CAAC,IAAI,EAAE,OAAO,GAAG,aAAa;CAG5D;AAED;;GAEG;AACH,MAAM,WAAW,gBAAiB,SAAQ,iBAAiB;IACzD,6CAA6C;IAC7C,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACrB;AAED;;;;;GAKG;AACH,qBAAa,YAAa,SAAQ,aAAa;IAC7C,6CAA6C;IAC7C,SAAgB,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnC;;;OAGG;gBACS,IAAI,EAAE,gBAAgB;IAKlC;;;;OAIG;WACoB,eAAe,CAAC,IAAI,EAAE,OAAO,GAAG,YAAY;CAGpE;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,yDAAyD;IACzD,WAAW,EAAE,MAAM,CAAC;IACpB,gCAAgC;IAChC,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;;;;GAKG;AACH,qBAAa,UAAU;IACrB,yDAAyD;IACzD,SAAgB,WAAW,EAAE,MAAM,CAAC;IACpC,gCAAgC;IAChC,SAAgB,UAAU,EAAE,MAAM,CAAC;IAEnC;;;OAGG;gBACS,IAAI,EAAE,cAAc;IAUhC;;;;OAIG;WACW,eAAe,CAAC,IAAI,EAAE,OAAO,GAAG,UAAU;CAGzD"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/models/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG,WAAW,GAAG,SAAS,GAAG,WAAW,CAAC;AAErE;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,8CAA8C;IAC9C,EAAE,EAAE,MAAM,CAAC;IACX,wCAAwC;IACxC,IAAI,EAAE,MAAM,CAAC;IACb,gDAAgD;IAChD,IAAI,EAAE,MAAM,CAAC;IACb,0DAA0D;IAC1D,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,gCAAgC;IAChC,iBAAiB,EAAE,gBAAgB,CAAC;CACrC;AAED;;;;;;GAMG;AACH,qBAAa,aAAa;IACxB,8CAA8C;IAC9C,SAAgB,EAAE,EAAE,MAAM,CAAC;IAC3B,wCAAwC;IACxC,SAAgB,IAAI,EAAE,MAAM,CAAC;IAC7B,gDAAgD;IAChD,SAAgB,IAAI,EAAE,MAAM,CAAC;IAC7B,0DAA0D;IAC1D,SAAgB,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACxC,gCAAgC;IAChC,SAAgB,iBAAiB,EAAE,gBAAgB,CAAC;IAEpD;;;OAGG;gBACS,IAAI,EAAE,iBAAiB;IAanC;;;;OAIG;WACW,eAAe,CAAC,IAAI,EAAE,OAAO,GAAG,aAAa;CAG5D;AAED;;GAEG;AACH,MAAM,WAAW,gBAAiB,SAAQ,iBAAiB;IACzD,6CAA6C;IAC7C,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACrB;AAED;;;;;GAKG;AACH,qBAAa,YAAa,SAAQ,aAAa;IAC7C,6CAA6C;IAC7C,SAAgB,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnC;;;OAGG;gBACS,IAAI,EAAE,gBAAgB;IAKlC;;;;OAIG;WACoB,eAAe,CAAC,IAAI,EAAE,OAAO,GAAG,YAAY;CAGpE;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,yDAAyD;IACzD,WAAW,EAAE,MAAM,CAAC;IACpB,gCAAgC;IAChC,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;;;;GAKG;AACH,qBAAa,UAAU;IACrB,yDAAyD;IACzD,SAAgB,WAAW,EAAE,MAAM,CAAC;IACpC,gCAAgC;IAChC,SAAgB,UAAU,EAAE,MAAM,CAAC;IAEnC;;;OAGG;gBACS,IAAI,EAAE,cAAc;IAUhC;;;;OAIG;WACW,eAAe,CAAC,IAAI,EAAE,OAAO,GAAG,UAAU;CAGzD;AAWD;;;;;GAKG;AACH,MAAM,MAAM,WAAW,GAAG,QAAQ,GAAG,YAAY,GAAG,OAAO,GAAG,SAAS,GAAG,OAAO,GAAG,OAAO,CAAC;AAE5F,iDAAiD;AACjD,MAAM,WAAW,mBAAmB;IAClC;;;;OAIG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,OAAO;IACtB,kCAAkC;IAClC,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,WAAW,CAAC;IAClB,8CAA8C;IAC9C,OAAO,EAAE,OAAO,CAAC;IACjB,4EAA4E;IAC5E,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,uCAAuC;IACvC,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,yCAAyC;IACzC,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;IACnB,wDAAwD;IACxD,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,4CAA4C;IAC5C,gBAAgB,EAAE,MAAM,GAAG,IAAI,CAAC;IAChC,0EAA0E;IAC1E,aAAa,EAAE,mBAAmB,EAAE,CAAC;IACrC,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,mFAAmF;IACnF,kBAAkB,EAAE,OAAO,CAAC;IAC5B,4EAA4E;IAC5E,gBAAgB,EAAE,OAAO,CAAC;IAC1B;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAChC;AAED,wDAAwD;AACxD,MAAM,WAAW,mBAAmB;IAClC,IAAI,EAAE,OAAO,EAAE,CAAC;CACjB;AAED,6EAA6E;AAC7E,MAAM,WAAW,eAAe;IAC9B,qDAAqD;IACrD,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,+CAA+C;IAC/C,QAAQ,EAAE,MAAM,CAAC;IACjB,+CAA+C;IAC/C,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,mDAAmD;AACnD,MAAM,WAAW,aAAa;IAC5B,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;;;;GAKG;AACH,MAAM,WAAW,cAAc;IAC7B,WAAW,EAAE,eAAe,EAAE,CAAC;IAC/B,gDAAgD;IAChD,UAAU,EAAE,aAAa,EAAE,CAAC;IAC5B,gDAAgD;IAChD,UAAU,EAAE,aAAa,EAAE,CAAC;CAC7B;AAED;;;;;GAKG;AACH,MAAM,WAAW,iBAAiB;IAChC,EAAE,EAAE,OAAO,CAAC;IACZ,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB;AAED,iEAAiE;AACjE,MAAM,WAAW,aAAa;IAC5B;;;;OAIG;IACH,cAAc,EAAE,MAAM,CAAC;CACxB;AAED,uDAAuD;AACvD,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,WAAW,CAAC;IAClB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,gFAAgF;IAChF,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,oCAAoC;IACpC,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,qFAAqF;IACrF,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,wCAAwC;IACxC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,mEAAmE;IACnE,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;CAC1B"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@barndoor-ai/sdk",
-  "version": "1.2.0",
+  "version": "1.3.0",
   "description": "TypeScript/JavaScript client for the Barndoor Platform API",
   "author": "Barndoor AI, Inc. (https://barndoor.ai)",
   "homepage": "https://barndoor.ai",
@@ -86,6 +86,18 @@
     "type-coverage": "^2.29.7",
     "typescript": "^5.8.3"
   },
+  "overrides": {
+    "@babel/plugin-transform-modules-systemjs": "^7.29.4",
+    "@hono/node-server": "^1.19.17",
+    "body-parser": "^2.3.0",
+    "brace-expansion@1": "^1.1.16",
+    "brace-expansion@2": "^2.1.4",
+    "brace-expansion@5": "^5.0.9",
+    "fast-uri": "^3.1.5",
+    "hono": "^4.13.2",
+    "js-yaml@3": "^3.15.1",
+    "js-yaml@4": "^4.3.1"
+  },
   "typeCoverage": {
     "atLeast": 60,
     "strict": true,