@nimbusnexus/webhooks-sdk 0.3.0 → 0.4.0

package/dist/index.d.cts

@@ -105,8 +105,12 @@ interface OutboxRecord {
     id: string;
     eventType: string;
     payload: Record<string, unknown>;
-    environment: string;
-    application: string;
+    /**
+     * The id of the project the event is published into (`prj_…`), or `null` for the workspace's default
+     * project. `null` means the `project_id` field is OMITTED from the publish body — the id is opaque
+     * and per-workspace, so only the server can resolve the default.
+     */
+    projectId: string | null;
     source: string | null;
     /** Epoch ms the record was first enqueued; `listPending` orders by this, oldest first. */
     createdAt: number;
@@ -190,8 +194,8 @@ interface WebhookdEvent {
     id: string;
     eventUid: string;
     eventType: string;
-    application: string;
-    environment: string;
+    /** The id of the project the event was published into (always resolved server-side). */
+    projectId: string;
     deliveriesCreated: number;
     source: string | null;
 }
@@ -208,8 +212,8 @@ interface Subscription {
 interface Endpoint {
     id: string;
     url: string;
-    environment: string;
-    application: string;
+    /** The id of the project the endpoint belongs to. */
+    project_id: string;
     status: string;
     subscriptions: Subscription[];
     /** The signing secret — returned ONCE, on create + rotate-secret only. */
@@ -253,7 +257,7 @@ interface Page<T> {
 }
 interface ClientOptions {
     baseUrl: string;
-    /** A per-tenant API key (`whsk_…`) or a service token. */
+    /** A per-workspace API key (`whsk_…`) or a service token. */
     apiKey: string;
     timeoutMs?: number;
     maxRetries?: number;
@@ -274,8 +278,11 @@ interface ClientOptions {
     onDrainError?: (error: unknown) => void;
 }
 interface EnqueueOptions {
-    environment?: string;
-    application?: string;
+    /**
+     * The id of the project to publish into (`prj_…`). Omit (or pass an empty string) to target the
+     * workspace's default project — the server resolves it, there is no client-side sentinel.
+     */
+    projectId?: string;
     source?: string;
     /** The Idempotency-Key / record id. Defaults to a generated UUID v4. Re-enqueuing the same key is a no-op overwrite. */
     idempotencyKey?: string;
@@ -295,16 +302,22 @@ interface DrainResult {
     remaining: number;
 }
 interface PublishOptions {
-    environment?: string;
-    application?: string;
+    /**
+     * The id of the project to publish into (`prj_…`). Omit (or pass an empty string) to target the
+     * workspace's default project — the server resolves it, there is no client-side sentinel.
+     */
+    projectId?: string;
     source?: string;
     /** Makes the publish safe to retry — a replay returns the original event without re-fanning-out. */
     idempotencyKey?: string;
 }
 interface CreateEndpointOptions {
-    environment?: string;
+    /**
+     * The id of the project to create the endpoint in (`prj_…`). Omit (or pass an empty string) for
+     * the workspace's default project.
+     */
+    projectId?: string;
     subscriptions?: Subscription[];
-    application?: string;
     secret?: string;
     maxAttempts?: number;
     retrySchedule?: number[];
@@ -313,7 +326,11 @@ interface CreateEndpointOptions {
     deliveryTimeoutMs?: number;
 }
 interface ListEndpointsOptions {
-    environment?: string;
+    /**
+     * The id of the project to list endpoints for (`prj_…`). Omit (or pass an empty string) for the
+     * workspace's default project.
+     */
+    projectId?: string;
     offset?: number;
     limit?: number;
 }
@@ -388,7 +405,7 @@ declare class WebhookdClient {
     private requireStore;
     /** Create an endpoint. The response includes the signing `secret` exactly once — persist it. */
     createEndpoint(url: string, opts?: CreateEndpointOptions): Promise<Endpoint>;
-    /** List endpoints for an environment (defaults to `prod`). */
+    /** List endpoints for a project. Omit `projectId` for the workspace's default project. */
     listEndpoints(opts?: ListEndpointsOptions): Promise<Page<Endpoint>>;
     /** Fetch a single endpoint by id. */
     getEndpoint(id: string): Promise<Endpoint>;
@@ -443,6 +460,6 @@ declare class WebhookdApiError extends WebhookdError {
  * - `WebhookdClient` — publish events to webhookd (for producers).
  */
 
-declare const VERSION = "0.3.0";
+declare const VERSION = "0.4.0";
 
 export { type ApiKey, type ClientOptions, type CreateApiKeyOptions, type CreateEndpointOptions, DEAD_NEXT_ATTEMPT_MS, DEFAULT_TOLERANCE_SECONDS, type Delivery, type DrainOptions, type DrainResult, type Endpoint, type EndpointPatch, type EnqueueOptions, FileStore, type ListDeliveriesOptions, type ListEndpointsOptions, MemoryStore, type OutboxRecord, type Page, PostgresStore, type PostgresStoreOptions, type PublishOptions, RedisStore, type RedisStoreOptions, SqliteStore, type Store, type Subscription, VERSION, type VerifyOptions, WebhookdApiError, WebhookdClient, WebhookdError, type WebhookdEvent, isDead, sign, verify };

package/dist/index.d.ts

@@ -105,8 +105,12 @@ interface OutboxRecord {
     id: string;
     eventType: string;
     payload: Record<string, unknown>;
-    environment: string;
-    application: string;
+    /**
+     * The id of the project the event is published into (`prj_…`), or `null` for the workspace's default
+     * project. `null` means the `project_id` field is OMITTED from the publish body — the id is opaque
+     * and per-workspace, so only the server can resolve the default.
+     */
+    projectId: string | null;
     source: string | null;
     /** Epoch ms the record was first enqueued; `listPending` orders by this, oldest first. */
     createdAt: number;
@@ -190,8 +194,8 @@ interface WebhookdEvent {
     id: string;
     eventUid: string;
     eventType: string;
-    application: string;
-    environment: string;
+    /** The id of the project the event was published into (always resolved server-side). */
+    projectId: string;
     deliveriesCreated: number;
     source: string | null;
 }
@@ -208,8 +212,8 @@ interface Subscription {
 interface Endpoint {
     id: string;
     url: string;
-    environment: string;
-    application: string;
+    /** The id of the project the endpoint belongs to. */
+    project_id: string;
     status: string;
     subscriptions: Subscription[];
     /** The signing secret — returned ONCE, on create + rotate-secret only. */
@@ -253,7 +257,7 @@ interface Page<T> {
 }
 interface ClientOptions {
     baseUrl: string;
-    /** A per-tenant API key (`whsk_…`) or a service token. */
+    /** A per-workspace API key (`whsk_…`) or a service token. */
     apiKey: string;
     timeoutMs?: number;
     maxRetries?: number;
@@ -274,8 +278,11 @@ interface ClientOptions {
     onDrainError?: (error: unknown) => void;
 }
 interface EnqueueOptions {
-    environment?: string;
-    application?: string;
+    /**
+     * The id of the project to publish into (`prj_…`). Omit (or pass an empty string) to target the
+     * workspace's default project — the server resolves it, there is no client-side sentinel.
+     */
+    projectId?: string;
     source?: string;
     /** The Idempotency-Key / record id. Defaults to a generated UUID v4. Re-enqueuing the same key is a no-op overwrite. */
     idempotencyKey?: string;
@@ -295,16 +302,22 @@ interface DrainResult {
     remaining: number;
 }
 interface PublishOptions {
-    environment?: string;
-    application?: string;
+    /**
+     * The id of the project to publish into (`prj_…`). Omit (or pass an empty string) to target the
+     * workspace's default project — the server resolves it, there is no client-side sentinel.
+     */
+    projectId?: string;
     source?: string;
     /** Makes the publish safe to retry — a replay returns the original event without re-fanning-out. */
     idempotencyKey?: string;
 }
 interface CreateEndpointOptions {
-    environment?: string;
+    /**
+     * The id of the project to create the endpoint in (`prj_…`). Omit (or pass an empty string) for
+     * the workspace's default project.
+     */
+    projectId?: string;
     subscriptions?: Subscription[];
-    application?: string;
     secret?: string;
     maxAttempts?: number;
     retrySchedule?: number[];
@@ -313,7 +326,11 @@ interface CreateEndpointOptions {
     deliveryTimeoutMs?: number;
 }
 interface ListEndpointsOptions {
-    environment?: string;
+    /**
+     * The id of the project to list endpoints for (`prj_…`). Omit (or pass an empty string) for the
+     * workspace's default project.
+     */
+    projectId?: string;
     offset?: number;
     limit?: number;
 }
@@ -388,7 +405,7 @@ declare class WebhookdClient {
     private requireStore;
     /** Create an endpoint. The response includes the signing `secret` exactly once — persist it. */
     createEndpoint(url: string, opts?: CreateEndpointOptions): Promise<Endpoint>;
-    /** List endpoints for an environment (defaults to `prod`). */
+    /** List endpoints for a project. Omit `projectId` for the workspace's default project. */
     listEndpoints(opts?: ListEndpointsOptions): Promise<Page<Endpoint>>;
     /** Fetch a single endpoint by id. */
     getEndpoint(id: string): Promise<Endpoint>;
@@ -443,6 +460,6 @@ declare class WebhookdApiError extends WebhookdError {
  * - `WebhookdClient` — publish events to webhookd (for producers).
  */
 
-declare const VERSION = "0.3.0";
+declare const VERSION = "0.4.0";
 
 export { type ApiKey, type ClientOptions, type CreateApiKeyOptions, type CreateEndpointOptions, DEAD_NEXT_ATTEMPT_MS, DEFAULT_TOLERANCE_SECONDS, type Delivery, type DrainOptions, type DrainResult, type Endpoint, type EndpointPatch, type EnqueueOptions, FileStore, type ListDeliveriesOptions, type ListEndpointsOptions, MemoryStore, type OutboxRecord, type Page, PostgresStore, type PostgresStoreOptions, type PublishOptions, RedisStore, type RedisStoreOptions, SqliteStore, type Store, type Subscription, VERSION, type VerifyOptions, WebhookdApiError, WebhookdClient, WebhookdError, type WebhookdEvent, isDead, sign, verify };

package/dist/index.js

@@ -159,8 +159,7 @@ function rowToRecord(row) {
     id: row.id,
     eventType: row.event_type,
     payload: row.payload,
-    environment: row.environment,
-    application: row.application,
+    projectId: row.project_id,
     source: row.source,
     createdAt: Number(row.created_at),
     attempts: row.attempts,
@@ -197,8 +196,7 @@ var PostgresStore = class {
           id TEXT PRIMARY KEY,
           event_type TEXT NOT NULL,
           payload JSONB NOT NULL,
-          environment TEXT NOT NULL,
-          application TEXT NOT NULL,
+          project_id TEXT,
           source TEXT,
           sent BOOLEAN NOT NULL DEFAULT FALSE,
           attempts INTEGER NOT NULL,
@@ -215,13 +213,12 @@ var PostgresStore = class {
     const pool = await this.ensure();
     await pool.query(
       `INSERT INTO ${this.table}
-        (id, event_type, payload, environment, application, source, sent, attempts, last_error, next_attempt_at, created_at)
-       VALUES ($1, $2, $3, $4, $5, $6, FALSE, $7, $8, $9, $10)
+        (id, event_type, payload, project_id, source, sent, attempts, last_error, next_attempt_at, created_at)
+       VALUES ($1, $2, $3, $4, $5, FALSE, $6, $7, $8, $9)
        ON CONFLICT (id) DO UPDATE SET
          event_type = EXCLUDED.event_type,
          payload = EXCLUDED.payload,
-         environment = EXCLUDED.environment,
-         application = EXCLUDED.application,
+         project_id = EXCLUDED.project_id,
          source = EXCLUDED.source,
          sent = EXCLUDED.sent,
          attempts = EXCLUDED.attempts,
@@ -232,8 +229,7 @@ var PostgresStore = class {
         record.id,
         record.eventType,
         JSON.stringify(record.payload),
-        record.environment,
-        record.application,
+        record.projectId,
         record.source,
         record.attempts,
         record.lastError,
@@ -389,8 +385,7 @@ function rowToRecord2(row) {
     id: row.id,
     eventType: row.event_type,
     payload: JSON.parse(row.payload),
-    environment: row.environment,
-    application: row.application,
+    projectId: row.project_id,
     source: row.source,
     createdAt: row.created_at,
     attempts: row.attempts,
@@ -417,12 +412,14 @@ var SqliteStore = class {
     }
     this.db = new DatabaseSync(path);
     this.db.exec(
+      // `project_id` is NULLABLE: NULL = the workspace's default project (the publish body simply
+      // omits the field). Renamed from the legacy `project` slug column — this store has no
+      // schema-versioning mechanism, so a table created by an older SDK build is not upgraded.
       `CREATE TABLE IF NOT EXISTS webhookd_outbox (
         id TEXT PRIMARY KEY,
         event_type TEXT NOT NULL,
         payload TEXT NOT NULL,
-        environment TEXT NOT NULL,
-        application TEXT NOT NULL,
+        project_id TEXT,
         source TEXT,
         created_at INTEGER NOT NULL,
         attempts INTEGER NOT NULL,
@@ -434,13 +431,12 @@ var SqliteStore = class {
   save(record) {
     this.db.prepare(
       `INSERT INTO webhookd_outbox
-          (id, event_type, payload, environment, application, source, created_at, attempts, last_error, next_attempt_at)
-         VALUES (?, ?, ?, ?, ?, ?, ?, ?, ?, ?)
+          (id, event_type, payload, project_id, source, created_at, attempts, last_error, next_attempt_at)
+         VALUES (?, ?, ?, ?, ?, ?, ?, ?, ?)
          ON CONFLICT(id) DO UPDATE SET
            event_type = excluded.event_type,
            payload = excluded.payload,
-           environment = excluded.environment,
-           application = excluded.application,
+           project_id = excluded.project_id,
            source = excluded.source,
            created_at = excluded.created_at,
            attempts = excluded.attempts,
@@ -450,8 +446,7 @@ var SqliteStore = class {
       record.id,
       record.eventType,
       JSON.stringify(record.payload),
-      record.environment,
-      record.application,
+      record.projectId,
       record.source,
       record.createdAt,
       record.attempts,
@@ -524,10 +519,10 @@ var WebhookdClient = class {
   async publish(eventType, payload, opts = {}) {
     const body = {
       event_type: eventType,
-      payload,
-      environment: opts.environment ?? "prod",
-      application: opts.application ?? "default"
+      payload
     };
+    const projectId = normalizeProjectId(opts.projectId);
+    if (projectId !== null) body.project_id = projectId;
     if (opts.source !== void 0) body.source = opts.source;
     const headers = {};
     if (opts.idempotencyKey !== void 0) headers["Idempotency-Key"] = opts.idempotencyKey;
@@ -537,8 +532,7 @@ var WebhookdClient = class {
       id: String(data.id),
       eventUid: String(data.event_uid),
       eventType: String(data.event_type),
-      application: String(data.application ?? "default"),
-      environment: String(data.environment ?? "prod"),
+      projectId: String(data.project_id),
       deliveriesCreated: Number(data.deliveries_created ?? 0),
       source: data.source ?? null
     };
@@ -556,8 +550,8 @@ var WebhookdClient = class {
       id: opts.idempotencyKey ?? randomUUID(),
       eventType,
       payload,
-      environment: opts.environment ?? "prod",
-      application: opts.application ?? "default",
+      // null = the workspace's default project (the field is omitted from the publish body on drain).
+      projectId: normalizeProjectId(opts.projectId),
       source: opts.source ?? null,
       createdAt: now,
       attempts: 0,
@@ -584,10 +578,9 @@ var WebhookdClient = class {
     for (const record of rows) {
       const body = {
         event_type: record.eventType,
-        payload: record.payload,
-        environment: record.environment,
-        application: record.application
+        payload: record.payload
       };
+      if (record.projectId !== null) body.project_id = record.projectId;
       if (record.source !== null) body.source = record.source;
       try {
         await this.request("POST", "/v1/events", {
@@ -654,11 +647,9 @@ var WebhookdClient = class {
   // ── Endpoints ──────────────────────────────────────────────────────────────
   /** Create an endpoint. The response includes the signing `secret` exactly once — persist it. */
   async createEndpoint(url, opts = {}) {
-    const body = {
-      url,
-      environment: opts.environment ?? "prod",
-      application: opts.application ?? "default"
-    };
+    const body = { url };
+    const projectId = normalizeProjectId(opts.projectId);
+    if (projectId !== null) body.project_id = projectId;
     if (opts.subscriptions !== void 0) body.subscriptions = opts.subscriptions;
     if (opts.secret !== void 0) body.secret = opts.secret;
     if (opts.maxAttempts !== void 0) body.max_attempts = opts.maxAttempts;
@@ -668,9 +659,11 @@ var WebhookdClient = class {
     if (opts.deliveryTimeoutMs !== void 0) body.delivery_timeout_ms = opts.deliveryTimeoutMs;
     return this.requestJson("POST", "/v1/endpoints", { body });
   }
-  /** List endpoints for an environment (defaults to `prod`). */
+  /** List endpoints for a project. Omit `projectId` for the workspace's default project. */
   async listEndpoints(opts = {}) {
-    const query = { environment: opts.environment ?? "prod" };
+    const query = {};
+    const projectId = normalizeProjectId(opts.projectId);
+    if (projectId !== null) query.project_id = projectId;
     if (opts.offset !== void 0) query.offset = opts.offset;
     if (opts.limit !== void 0) query.limit = opts.limit;
     return this.requestJson("GET", "/v1/endpoints", { query });
@@ -793,6 +786,9 @@ var WebhookdClient = class {
     throw new WebhookdError(`request failed after retries: ${String(lastErr)}`);
   }
 };
+function normalizeProjectId(projectId) {
+  return projectId === void 0 || projectId === null || projectId === "" ? null : projectId;
+}
 function backoffMs(attempt) {
   return Math.min(2e3, 200 * 2 ** attempt);
 }
@@ -818,7 +814,7 @@ function sleep(ms) {
 }
 
 // src/index.ts
-var VERSION = "0.3.0";
+var VERSION = "0.4.0";
 export {
   DEAD_NEXT_ATTEMPT_MS,
   DEFAULT_TOLERANCE_SECONDS,