@marinoscar/platform-api 0.1.0-next.19 → 0.1.0-next.21

package/dist/webhooks/webhooks.credentials.js

@@ -0,0 +1,51 @@
+"use strict";
+// =============================================================================
+// The signing-secret credential purpose (issue #1046)
+// =============================================================================
+//
+// `webhook_signing` in all three tiers of the credentials store: a user's own
+// store (user scope), the organization's (org scope) and the deployment's
+// (system scope). The app registers both definitions from its credential
+// manifest; the slice only declares them. A secret is addressed
+// `endpoint:<endpointId>:v<version>` (see `webhook-secrets.service.ts`).
+// =============================================================================
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WEBHOOK_SIGNING_USER_CREDENTIAL_PURPOSE_DEF = exports.WEBHOOK_SIGNING_CREDENTIAL_PURPOSE_DEF = void 0;
+const webhooks_constants_1 = require("./webhooks.constants");
+/**
+ * The organization and deployment tiers of `webhook_signing`, for
+ * `registerCredentialPurpose`.
+ *
+ * @example
+ * ```ts
+ * registerCredentialPurpose(WEBHOOK_SIGNING_CREDENTIAL_PURPOSE_DEF);
+ * ```
+ *
+ * @extensionPoint registry
+ * @stability experimental
+ */
+exports.WEBHOOK_SIGNING_CREDENTIAL_PURPOSE_DEF = Object.freeze({
+    purpose: webhooks_constants_1.WEBHOOK_SIGNING_PURPOSE,
+    owner: 'webhooks',
+    label: 'Webhook signing secrets',
+    tiers: ['system', 'org'],
+});
+/**
+ * The user tier of `webhook_signing`, for `registerUserCredentialPurpose`. No
+ * deployment or organization fallback: a member's secret is theirs alone.
+ *
+ * @example
+ * ```ts
+ * registerUserCredentialPurpose(WEBHOOK_SIGNING_USER_CREDENTIAL_PURPOSE_DEF);
+ * ```
+ *
+ * @extensionPoint registry
+ * @stability experimental
+ */
+exports.WEBHOOK_SIGNING_USER_CREDENTIAL_PURPOSE_DEF = Object.freeze({
+    purpose: webhooks_constants_1.WEBHOOK_SIGNING_PURPOSE,
+    label: 'Webhook signing secret',
+    description: 'Signs the webhooks this application sends to your endpoints, so your receiver can verify them.',
+    system: null,
+});
+//# sourceMappingURL=webhooks.credentials.js.map

package/dist/webhooks/webhooks.credentials.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"webhooks.credentials.js","sourceRoot":"","sources":["../../src/webhooks/webhooks.credentials.ts"],"names":[],"mappings":";AAAA,gFAAgF;AAChF,sDAAsD;AACtD,gFAAgF;AAChF,EAAE;AACF,8EAA8E;AAC9E,0EAA0E;AAC1E,yEAAyE;AACzE,gEAAgE;AAChE,yEAAyE;AACzE,gFAAgF;;;AAGhF,6DAA+D;AAE/D;;;;;;;;;;;GAWG;AACU,QAAA,sCAAsC,GAAyB,MAAM,CAAC,MAAM,CAAC;IACxF,OAAO,EAAE,4CAAuB;IAChC,KAAK,EAAE,UAAU;IACjB,KAAK,EAAE,yBAAyB;IAChC,KAAK,EAAE,CAAC,QAAQ,EAAE,KAAK,CAAU;CAClC,CAAC,CAAC;AAEH;;;;;;;;;;;GAWG;AACU,QAAA,2CAA2C,GAA6B,MAAM,CAAC,MAAM,CAAC;IACjG,OAAO,EAAE,4CAAuB;IAChC,KAAK,EAAE,wBAAwB;IAC/B,WAAW,EAAE,gGAAgG;IAC7G,MAAM,EAAE,IAAI;CACb,CAAC,CAAC"}

package/dist/webhooks/webhooks.errors.d.ts

@@ -0,0 +1,25 @@
+import { HttpException, NotFoundException, UnprocessableEntityException } from '@nestjs/common';
+import { type WebhookErrorCode } from '@marinoscar/platform-contract/webhooks';
+/**
+ * Registers the slice's error codes with the filter. Idempotent.
+ *
+ * @stability experimental
+ */
+export declare function registerWebhookErrorCodes(): void;
+/** The endpoint is not there, or not the caller's. @stability experimental */
+export declare class WebhookNotFoundError extends NotFoundException {
+    constructor();
+}
+/** The delivery is not there, or not the caller's. @stability experimental */
+export declare class WebhookDeliveryNotFoundError extends NotFoundException {
+    constructor();
+}
+/** A 422 with one of the slice's codes. @stability experimental */
+export declare class WebhookRequestError extends UnprocessableEntityException {
+    constructor(code: WebhookErrorCode, message: string);
+}
+/** The endpoint is switched off and the action needs it on. @stability experimental */
+export declare class WebhookDisabledError extends HttpException {
+    constructor();
+}
+//# sourceMappingURL=webhooks.errors.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"webhooks.errors.d.ts","sourceRoot":"","sources":["../../src/webhooks/webhooks.errors.ts"],"names":[],"mappings":"AAWA,OAAO,EAAE,aAAa,EAAc,iBAAiB,EAAE,4BAA4B,EAAE,MAAM,gBAAgB,CAAC;AAC5G,OAAO,EAAuB,KAAK,gBAAgB,EAAE,MAAM,wCAAwC,CAAC;AAcpG;;;;GAIG;AACH,wBAAgB,yBAAyB,IAAI,IAAI,CAEhD;AAED,8EAA8E;AAC9E,qBAAa,oBAAqB,SAAQ,iBAAiB;;CAI1D;AAED,8EAA8E;AAC9E,qBAAa,4BAA6B,SAAQ,iBAAiB;;CAIlE;AAED,mEAAmE;AACnE,qBAAa,mBAAoB,SAAQ,4BAA4B;gBACvD,IAAI,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM;CAGpD;AAED,uFAAuF;AACvF,qBAAa,oBAAqB,SAAQ,aAAa;;CAItD"}

package/dist/webhooks/webhooks.errors.js

@@ -0,0 +1,65 @@
+"use strict";
+// =============================================================================
+// The webhooks slice's errors (issue #1046)
+// =============================================================================
+//
+// Each is an `HttpException` carrying one of the contract's
+// `WEBHOOK_ERROR_CODES`. The filter publishes a payload `code` only when it is
+// registered for the response's own status, so `registerWebhookErrorCodes()`
+// (called by `WebhooksModule.forRoot()`) registers them. A not-found error is a
+// 404 for "does not exist" AND "is not yours": the id is never an oracle.
+// =============================================================================
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WebhookDisabledError = exports.WebhookRequestError = exports.WebhookDeliveryNotFoundError = exports.WebhookNotFoundError = void 0;
+exports.registerWebhookErrorCodes = registerWebhookErrorCodes;
+const common_1 = require("@nestjs/common");
+const webhooks_1 = require("@marinoscar/platform-contract/webhooks");
+const index_1 = require("../core/index");
+const CODES = [
+    { code: webhooks_1.WEBHOOK_ERROR_CODES.WEBHOOK_NOT_FOUND, status: 404, description: 'The webhook endpoint does not exist, or is not visible to the caller.' },
+    { code: webhooks_1.WEBHOOK_ERROR_CODES.WEBHOOK_DELIVERY_NOT_FOUND, status: 404, description: 'The webhook delivery does not exist, or is not visible to the caller.' },
+    { code: webhooks_1.WEBHOOK_ERROR_CODES.WEBHOOK_URL_INVALID, status: 422, description: 'The webhook URL is not a valid URL.' },
+    { code: webhooks_1.WEBHOOK_ERROR_CODES.WEBHOOK_URL_FORBIDDEN, status: 422, description: 'The webhook URL targets a scheme, port or address the server will not call.' },
+    { code: webhooks_1.WEBHOOK_ERROR_CODES.WEBHOOK_EVENT_UNKNOWN, status: 422, description: 'A subscription names no event an endpoint of this kind can receive.' },
+    { code: webhooks_1.WEBHOOK_ERROR_CODES.WEBHOOK_EVENT_NOT_PERMITTED, status: 422, description: 'The caller may not subscribe to a requested event.' },
+    { code: webhooks_1.WEBHOOK_ERROR_CODES.WEBHOOK_LIMIT_REACHED, status: 422, description: 'The owner already has the most webhook endpoints allowed.' },
+];
+/**
+ * Registers the slice's error codes with the filter. Idempotent.
+ *
+ * @stability experimental
+ */
+function registerWebhookErrorCodes() {
+    for (const def of CODES)
+        if (!index_1.errorCodeRegistry.has(def.code))
+            (0, index_1.registerErrorCode)(def);
+}
+/** The endpoint is not there, or not the caller's. @stability experimental */
+class WebhookNotFoundError extends common_1.NotFoundException {
+    constructor() {
+        super({ statusCode: 404, code: webhooks_1.WEBHOOK_ERROR_CODES.WEBHOOK_NOT_FOUND, message: 'Webhook endpoint not found' });
+    }
+}
+exports.WebhookNotFoundError = WebhookNotFoundError;
+/** The delivery is not there, or not the caller's. @stability experimental */
+class WebhookDeliveryNotFoundError extends common_1.NotFoundException {
+    constructor() {
+        super({ statusCode: 404, code: webhooks_1.WEBHOOK_ERROR_CODES.WEBHOOK_DELIVERY_NOT_FOUND, message: 'Webhook delivery not found' });
+    }
+}
+exports.WebhookDeliveryNotFoundError = WebhookDeliveryNotFoundError;
+/** A 422 with one of the slice's codes. @stability experimental */
+class WebhookRequestError extends common_1.UnprocessableEntityException {
+    constructor(code, message) {
+        super({ statusCode: 422, code, message });
+    }
+}
+exports.WebhookRequestError = WebhookRequestError;
+/** The endpoint is switched off and the action needs it on. @stability experimental */
+class WebhookDisabledError extends common_1.HttpException {
+    constructor() {
+        super({ statusCode: 409, message: 'The endpoint is disabled. Enable it first.' }, common_1.HttpStatus.CONFLICT);
+    }
+}
+exports.WebhookDisabledError = WebhookDisabledError;
+//# sourceMappingURL=webhooks.errors.js.map

package/dist/webhooks/webhooks.errors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"webhooks.errors.js","sourceRoot":"","sources":["../../src/webhooks/webhooks.errors.ts"],"names":[],"mappings":";AAAA,gFAAgF;AAChF,4CAA4C;AAC5C,gFAAgF;AAChF,EAAE;AACF,4DAA4D;AAC5D,+EAA+E;AAC/E,6EAA6E;AAC7E,gFAAgF;AAChF,0EAA0E;AAC1E,gFAAgF;;;AAsBhF,8DAEC;AAtBD,2CAA4G;AAC5G,qEAAoG;AAEpG,yCAAqE;AAErE,MAAM,KAAK,GAAmF;IAC5F,EAAE,IAAI,EAAE,8BAAmB,CAAC,iBAAiB,EAAE,MAAM,EAAE,GAAG,EAAE,WAAW,EAAE,uEAAuE,EAAE;IAClJ,EAAE,IAAI,EAAE,8BAAmB,CAAC,0BAA0B,EAAE,MAAM,EAAE,GAAG,EAAE,WAAW,EAAE,uEAAuE,EAAE;IAC3J,EAAE,IAAI,EAAE,8BAAmB,CAAC,mBAAmB,EAAE,MAAM,EAAE,GAAG,EAAE,WAAW,EAAE,qCAAqC,EAAE;IAClH,EAAE,IAAI,EAAE,8BAAmB,CAAC,qBAAqB,EAAE,MAAM,EAAE,GAAG,EAAE,WAAW,EAAE,6EAA6E,EAAE;IAC5J,EAAE,IAAI,EAAE,8BAAmB,CAAC,qBAAqB,EAAE,MAAM,EAAE,GAAG,EAAE,WAAW,EAAE,qEAAqE,EAAE;IACpJ,EAAE,IAAI,EAAE,8BAAmB,CAAC,2BAA2B,EAAE,MAAM,EAAE,GAAG,EAAE,WAAW,EAAE,oDAAoD,EAAE;IACzI,EAAE,IAAI,EAAE,8BAAmB,CAAC,qBAAqB,EAAE,MAAM,EAAE,GAAG,EAAE,WAAW,EAAE,2DAA2D,EAAE;CAC3I,CAAC;AAEF;;;;GAIG;AACH,SAAgB,yBAAyB;IACvC,KAAK,MAAM,GAAG,IAAI,KAAK;QAAE,IAAI,CAAC,yBAAiB,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC;YAAE,IAAA,yBAAiB,EAAC,GAAG,CAAC,CAAC;AACxF,CAAC;AAED,8EAA8E;AAC9E,MAAa,oBAAqB,SAAQ,0BAAiB;IACzD;QACE,KAAK,CAAC,EAAE,UAAU,EAAE,GAAG,EAAE,IAAI,EAAE,8BAAmB,CAAC,iBAAiB,EAAE,OAAO,EAAE,4BAA4B,EAAE,CAAC,CAAC;IACjH,CAAC;CACF;AAJD,oDAIC;AAED,8EAA8E;AAC9E,MAAa,4BAA6B,SAAQ,0BAAiB;IACjE;QACE,KAAK,CAAC,EAAE,UAAU,EAAE,GAAG,EAAE,IAAI,EAAE,8BAAmB,CAAC,0BAA0B,EAAE,OAAO,EAAE,4BAA4B,EAAE,CAAC,CAAC;IAC1H,CAAC;CACF;AAJD,oEAIC;AAED,mEAAmE;AACnE,MAAa,mBAAoB,SAAQ,qCAA4B;IACnE,YAAY,IAAsB,EAAE,OAAe;QACjD,KAAK,CAAC,EAAE,UAAU,EAAE,GAAG,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC;IAC5C,CAAC;CACF;AAJD,kDAIC;AAED,uFAAuF;AACvF,MAAa,oBAAqB,SAAQ,sBAAa;IACrD;QACE,KAAK,CAAC,EAAE,UAAU,EAAE,GAAG,EAAE,OAAO,EAAE,4CAA4C,EAAE,EAAE,mBAAU,CAAC,QAAQ,CAAC,CAAC;IACzG,CAAC;CACF;AAJD,oDAIC"}

package/dist/webhooks/webhooks.metrics.d.ts

@@ -0,0 +1,24 @@
+import type { AppMetricDef } from '../otel-core/index';
+/** What a delivery attempt ended as. @stability experimental */
+export declare const WEBHOOK_DELIVERY_OUTCOMES: readonly ["succeeded", "failed", "dead", "blocked"];
+/** What one emitted event ended as. @stability experimental */
+export declare const WEBHOOK_EMIT_OUTCOMES: readonly ["queued", "no_match", "invalid", "unknown"];
+/** Code key of `app.webhooks.deliveries`. @stability experimental */
+export declare const WEBHOOK_DELIVERIES_METRIC = "webhookDeliveries";
+/** Code key of `app.webhooks.delivery.duration`. @stability experimental */
+export declare const WEBHOOK_DELIVERY_DURATION_METRIC = "webhookDeliveryDuration";
+/** Code key of `app.webhooks.events`. @stability experimental */
+export declare const WEBHOOK_EVENTS_METRIC = "webhookEvents";
+/**
+ * The slice's metrics, for `registerPlatformHostAppMetrics`.
+ *
+ * @example
+ * ```ts
+ * registerPlatformHostAppMetrics(WEBHOOKS_APP_METRICS);
+ * ```
+ *
+ * @extensionPoint registry
+ * @stability experimental
+ */
+export declare const WEBHOOKS_APP_METRICS: readonly AppMetricDef[];
+//# sourceMappingURL=webhooks.metrics.d.ts.map

package/dist/webhooks/webhooks.metrics.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"webhooks.metrics.d.ts","sourceRoot":"","sources":["../../src/webhooks/webhooks.metrics.ts"],"names":[],"mappings":"AAUA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAEvD,gEAAgE;AAChE,eAAO,MAAM,yBAAyB,qDAAsD,CAAC;AAC7F,+DAA+D;AAC/D,eAAO,MAAM,qBAAqB,uDAAwD,CAAC;AAE3F,qEAAqE;AACrE,eAAO,MAAM,yBAAyB,sBAAsB,CAAC;AAC7D,4EAA4E;AAC5E,eAAO,MAAM,gCAAgC,4BAA4B,CAAC;AAC1E,iEAAiE;AACjE,eAAO,MAAM,qBAAqB,kBAAkB,CAAC;AAErD;;;;;;;;;;GAUG;AACH,eAAO,MAAM,oBAAoB,EAAE,SAAS,YAAY,EAmCvD,CAAC"}

package/dist/webhooks/webhooks.metrics.js

@@ -0,0 +1,70 @@
+"use strict";
+// =============================================================================
+// Webhook metrics (issue #1046)
+// =============================================================================
+//
+// Declared for the app's metric-name registry and emitted through
+// `MetricsHostService`. BOUNDED LABELS ONLY: `outcome` is a closed list and
+// `event_group` is the first segment of the event key when it is a registered
+// group, else `other`. Never an endpoint, URL, user or organization.
+// =============================================================================
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WEBHOOKS_APP_METRICS = exports.WEBHOOK_EVENTS_METRIC = exports.WEBHOOK_DELIVERY_DURATION_METRIC = exports.WEBHOOK_DELIVERIES_METRIC = exports.WEBHOOK_EMIT_OUTCOMES = exports.WEBHOOK_DELIVERY_OUTCOMES = void 0;
+/** What a delivery attempt ended as. @stability experimental */
+exports.WEBHOOK_DELIVERY_OUTCOMES = ['succeeded', 'failed', 'dead', 'blocked'];
+/** What one emitted event ended as. @stability experimental */
+exports.WEBHOOK_EMIT_OUTCOMES = ['queued', 'no_match', 'invalid', 'unknown'];
+/** Code key of `app.webhooks.deliveries`. @stability experimental */
+exports.WEBHOOK_DELIVERIES_METRIC = 'webhookDeliveries';
+/** Code key of `app.webhooks.delivery.duration`. @stability experimental */
+exports.WEBHOOK_DELIVERY_DURATION_METRIC = 'webhookDeliveryDuration';
+/** Code key of `app.webhooks.events`. @stability experimental */
+exports.WEBHOOK_EVENTS_METRIC = 'webhookEvents';
+/**
+ * The slice's metrics, for `registerPlatformHostAppMetrics`.
+ *
+ * @example
+ * ```ts
+ * registerPlatformHostAppMetrics(WEBHOOKS_APP_METRICS);
+ * ```
+ *
+ * @extensionPoint registry
+ * @stability experimental
+ */
+exports.WEBHOOKS_APP_METRICS = [
+    {
+        key: exports.WEBHOOK_DELIVERIES_METRIC,
+        name: 'app.webhooks.deliveries',
+        kind: 'counter',
+        unit: '{delivery}',
+        description: 'Webhook delivery attempts, by outcome and event group.',
+        attributes: {
+            outcome: { kind: 'enum', values: exports.WEBHOOK_DELIVERY_OUTCOMES },
+            event_group: { kind: 'free' },
+        },
+    },
+    {
+        key: exports.WEBHOOK_DELIVERY_DURATION_METRIC,
+        name: 'app.webhooks.delivery.duration',
+        kind: 'histogram',
+        unit: 's',
+        description: 'How long one webhook delivery attempt took, from connecting to the answer.',
+        buckets: [0.05, 0.1, 0.25, 0.5, 1, 2.5, 5, 10],
+        attributes: {
+            outcome: { kind: 'enum', values: exports.WEBHOOK_DELIVERY_OUTCOMES },
+            event_group: { kind: 'free' },
+        },
+    },
+    {
+        key: exports.WEBHOOK_EVENTS_METRIC,
+        name: 'app.webhooks.events',
+        kind: 'counter',
+        unit: '{event}',
+        description: 'Events emitted to the webhook fan-out, by outcome and event group.',
+        attributes: {
+            outcome: { kind: 'enum', values: exports.WEBHOOK_EMIT_OUTCOMES },
+            event_group: { kind: 'free' },
+        },
+    },
+];
+//# sourceMappingURL=webhooks.metrics.js.map

package/dist/webhooks/webhooks.metrics.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"webhooks.metrics.js","sourceRoot":"","sources":["../../src/webhooks/webhooks.metrics.ts"],"names":[],"mappings":";AAAA,gFAAgF;AAChF,gCAAgC;AAChC,gFAAgF;AAChF,EAAE;AACF,kEAAkE;AAClE,4EAA4E;AAC5E,8EAA8E;AAC9E,qEAAqE;AACrE,gFAAgF;;;AAIhF,gEAAgE;AACnD,QAAA,yBAAyB,GAAG,CAAC,WAAW,EAAE,QAAQ,EAAE,MAAM,EAAE,SAAS,CAAU,CAAC;AAC7F,+DAA+D;AAClD,QAAA,qBAAqB,GAAG,CAAC,QAAQ,EAAE,UAAU,EAAE,SAAS,EAAE,SAAS,CAAU,CAAC;AAE3F,qEAAqE;AACxD,QAAA,yBAAyB,GAAG,mBAAmB,CAAC;AAC7D,4EAA4E;AAC/D,QAAA,gCAAgC,GAAG,yBAAyB,CAAC;AAC1E,iEAAiE;AACpD,QAAA,qBAAqB,GAAG,eAAe,CAAC;AAErD;;;;;;;;;;GAUG;AACU,QAAA,oBAAoB,GAA4B;IAC3D;QACE,GAAG,EAAE,iCAAyB;QAC9B,IAAI,EAAE,yBAAyB;QAC/B,IAAI,EAAE,SAAS;QACf,IAAI,EAAE,YAAY;QAClB,WAAW,EAAE,wDAAwD;QACrE,UAAU,EAAE;YACV,OAAO,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,iCAAyB,EAAE;YAC5D,WAAW,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE;SAC9B;KACF;IACD;QACE,GAAG,EAAE,wCAAgC;QACrC,IAAI,EAAE,gCAAgC;QACtC,IAAI,EAAE,WAAW;QACjB,IAAI,EAAE,GAAG;QACT,WAAW,EAAE,4EAA4E;QACzF,OAAO,EAAE,CAAC,IAAI,EAAE,GAAG,EAAE,IAAI,EAAE,GAAG,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC;QAC9C,UAAU,EAAE;YACV,OAAO,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,iCAAyB,EAAE;YAC5D,WAAW,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE;SAC9B;KACF;IACD;QACE,GAAG,EAAE,6BAAqB;QAC1B,IAAI,EAAE,qBAAqB;QAC3B,IAAI,EAAE,SAAS;QACf,IAAI,EAAE,SAAS;QACf,WAAW,EAAE,oEAAoE;QACjF,UAAU,EAAE;YACV,OAAO,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,6BAAqB,EAAE;YACxD,WAAW,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE;SAC9B;KACF;CACF,CAAC"}

package/dist/webhooks/webhooks.module.d.ts

@@ -0,0 +1,29 @@
+import { type DynamicModule } from '@nestjs/common';
+import { type WebhooksModuleOptions } from './webhooks.options';
+/**
+ * The webhooks slice for one app.
+ *
+ * @stability experimental
+ */
+export declare class WebhooksModule {
+    /**
+     * The slice for one app. Call once, before bootstrap. Registers the platform's
+     * webhook events, the slice's error codes and (when the app's manifest has not
+     * already) the `webhook` notification channel; each registration is
+     * idempotent.
+     *
+     * @param options - see {@link WebhooksModuleOptions}; all optional.
+     * @returns the dynamic module. It exports `WebhooksService`, `WebhookEndpointsService` and `WEBHOOKS_OPTIONS`.
+     * @throws Error when an option is invalid.
+     *
+     * @example
+     * ```ts
+     * export const webhooksModule = WebhooksModule.forRoot({ appName: APP_NAME, imports: [WebhooksHostModule] });
+     * ```
+     *
+     * @extensionPoint option
+     * @stability experimental
+     */
+    static forRoot(options?: WebhooksModuleOptions): DynamicModule;
+}
+//# sourceMappingURL=webhooks.module.d.ts.map

package/dist/webhooks/webhooks.module.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"webhooks.module.d.ts","sourceRoot":"","sources":["../../src/webhooks/webhooks.module.ts"],"names":[],"mappings":"AAAA,OAAO,EAAU,KAAK,aAAa,EAAE,MAAM,gBAAgB,CAAC;AAoB5D,OAAO,EAAkD,KAAK,qBAAqB,EAAE,MAAM,oBAAoB,CAAC;AAsBhH;;;;GAIG;AACH,qBACa,cAAc;IACzB;;;;;;;;;;;;;;;;;OAiBG;IACH,MAAM,CAAC,OAAO,CAAC,OAAO,GAAE,qBAA0B,GAAG,aAAa;CA6BnE"}

package/dist/webhooks/webhooks.module.js

@@ -0,0 +1,108 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var WebhooksModule_1;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WebhooksModule = void 0;
+const common_1 = require("@nestjs/common");
+const index_1 = require("../credentials/index");
+const index_2 = require("../notifications/index");
+const egress_guard_1 = require("./egress/egress-guard");
+const transport_1 = require("./egress/transport");
+const webhook_deliver_handler_1 = require("./handlers/webhook-deliver.handler");
+const webhook_fanout_handler_1 = require("./handlers/webhook-fanout.handler");
+const webhook_purge_handler_1 = require("./handlers/webhook-purge.handler");
+const admin_webhooks_controller_1 = require("./http/admin-webhooks.controller");
+const org_webhooks_controller_1 = require("./http/org-webhooks.controller");
+const webhooks_controller_1 = require("./http/webhooks.controller");
+const webhook_event_listeners_1 = require("./listeners/webhook-event.listeners");
+const webhook_notification_channel_1 = require("./notifications/webhook-notification.channel");
+const webhook_notifications_1 = require("./notifications/webhook-notifications");
+const builtin_events_1 = require("./registry/builtin-events");
+const webhook_purge_task_1 = require("./tasks/webhook-purge.task");
+const webhook_endpoints_service_1 = require("./webhook-endpoints.service");
+const webhook_secrets_service_1 = require("./webhook-secrets.service");
+const webhooks_constants_1 = require("./webhooks.constants");
+const webhooks_options_1 = require("./webhooks.options");
+const webhooks_errors_1 = require("./webhooks.errors");
+const webhooks_repository_1 = require("./webhooks.repository");
+const webhooks_service_1 = require("./webhooks.service");
+// =============================================================================
+// WebhooksModule (issue #1046)
+// =============================================================================
+//
+// Outbound, signed webhooks: endpoints a member, an organization or the
+// deployment registers; an event catalog; a fan-out; one delivery job per
+// (event, endpoint) with retries and a circuit breaker; and a notification
+// channel that forwards a member's notifications to their own endpoints.
+//
+// `JobsModule.forRoot()` and `NotificationsModule.forRoot()` are GLOBAL, so
+// `JobsService`, `JobHandlerRegistry`, `NotificationsService` and
+// `NotificationChannelSenderRegistry` need no import; the core host module
+// provides `PLATFORM_PRISMA` and `AUDIT_SINK`; the three credential stores are
+// imported here (they are deliberately not global). The app binds
+// `WEBHOOKS_SYSTEM_PRISMA` (the bypass client) in a module it passes as `imports`.
+// =============================================================================
+/**
+ * The webhooks slice for one app.
+ *
+ * @stability experimental
+ */
+let WebhooksModule = WebhooksModule_1 = class WebhooksModule {
+    /**
+     * The slice for one app. Call once, before bootstrap. Registers the platform's
+     * webhook events, the slice's error codes and (when the app's manifest has not
+     * already) the `webhook` notification channel; each registration is
+     * idempotent.
+     *
+     * @param options - see {@link WebhooksModuleOptions}; all optional.
+     * @returns the dynamic module. It exports `WebhooksService`, `WebhookEndpointsService` and `WEBHOOKS_OPTIONS`.
+     * @throws Error when an option is invalid.
+     *
+     * @example
+     * ```ts
+     * export const webhooksModule = WebhooksModule.forRoot({ appName: APP_NAME, imports: [WebhooksHostModule] });
+     * ```
+     *
+     * @extensionPoint option
+     * @stability experimental
+     */
+    static forRoot(options = {}) {
+        const resolved = (0, webhooks_options_1.resolveWebhooksModuleOptions)(options);
+        (0, builtin_events_1.registerBuiltinWebhookEvents)();
+        (0, webhooks_errors_1.registerWebhookErrorCodes)();
+        (0, webhooks_constants_1.registerWebhooksSystemAccessReason)();
+        if (!(0, index_2.isRegisteredNotificationChannel)(webhook_notifications_1.WEBHOOK_NOTIFICATION_CHANNEL.id))
+            (0, index_2.registerNotificationChannel)(webhook_notifications_1.WEBHOOK_NOTIFICATION_CHANNEL);
+        return {
+            module: WebhooksModule_1,
+            imports: [index_1.CredentialsModule, index_1.UserCredentialsModule, index_1.OrgCredentialsModule, ...resolved.imports],
+            controllers: [webhooks_controller_1.WebhooksController, org_webhooks_controller_1.OrgWebhooksController, admin_webhooks_controller_1.AdminWebhooksController],
+            providers: [
+                { provide: webhooks_options_1.WEBHOOKS_OPTIONS, useValue: resolved },
+                { provide: transport_1.WEBHOOKS_TRANSPORT, useValue: resolved.transport ?? transport_1.nodeWebhookTransport },
+                { provide: transport_1.WEBHOOKS_RESOLVER, useValue: resolved.resolver ?? egress_guard_1.systemHostResolver },
+                { provide: webhooks_repository_1.WebhooksRepository, useClass: webhooks_repository_1.PrismaWebhooksRepository },
+                { provide: webhook_secrets_service_1.WebhookSecrets, useClass: webhook_secrets_service_1.CredentialsWebhookSecrets },
+                webhooks_service_1.WebhooksService,
+                webhook_endpoints_service_1.WebhookEndpointsService,
+                webhook_deliver_handler_1.WebhookDeliverHandler,
+                webhook_fanout_handler_1.WebhookFanoutHandler,
+                webhook_purge_handler_1.WebhookPurgeHandler,
+                webhook_event_listeners_1.WebhookEventListeners,
+                webhook_notification_channel_1.WebhookNotificationChannel,
+                ...(resolved.tasks.purge ? [webhook_purge_task_1.WebhookPurgeTask] : []),
+            ],
+            exports: [webhooks_options_1.WEBHOOKS_OPTIONS, webhooks_service_1.WebhooksService, webhook_endpoints_service_1.WebhookEndpointsService],
+        };
+    }
+};
+exports.WebhooksModule = WebhooksModule;
+exports.WebhooksModule = WebhooksModule = WebhooksModule_1 = __decorate([
+    (0, common_1.Module)({})
+], WebhooksModule);
+//# sourceMappingURL=webhooks.module.js.map

package/dist/webhooks/webhooks.module.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"webhooks.module.js","sourceRoot":"","sources":["../../src/webhooks/webhooks.module.ts"],"names":[],"mappings":";;;;;;;;;;AAAA,2CAA4D;AAE5D,gDAAsG;AACtG,kDAAsG;AACtG,wDAA2D;AAC3D,kDAAiG;AACjG,gFAA2E;AAC3E,8EAAyE;AACzE,4EAAuE;AACvE,gFAA2E;AAC3E,4EAAuE;AACvE,oEAAgE;AAChE,iFAA4E;AAC5E,+FAA0F;AAC1F,iFAAqF;AACrF,8DAAyE;AACzE,mEAA8D;AAC9D,2EAAsE;AACtE,uEAAsF;AACtF,6DAA0E;AAC1E,yDAAgH;AAChH,uDAA8D;AAC9D,+DAAqF;AACrF,yDAAqD;AAErD,gFAAgF;AAChF,+BAA+B;AAC/B,gFAAgF;AAChF,EAAE;AACF,wEAAwE;AACxE,0EAA0E;AAC1E,2EAA2E;AAC3E,yEAAyE;AACzE,EAAE;AACF,4EAA4E;AAC5E,kEAAkE;AAClE,2EAA2E;AAC3E,+EAA+E;AAC/E,kEAAkE;AAClE,mFAAmF;AACnF,gFAAgF;AAEhF;;;;GAIG;AAEI,IAAM,cAAc,sBAApB,MAAM,cAAc;IACzB;;;;;;;;;;;;;;;;;OAiBG;IACH,MAAM,CAAC,OAAO,CAAC,UAAiC,EAAE;QAChD,MAAM,QAAQ,GAAG,IAAA,+CAA4B,EAAC,OAAO,CAAC,CAAC;QACvD,IAAA,6CAA4B,GAAE,CAAC;QAC/B,IAAA,2CAAyB,GAAE,CAAC;QAC5B,IAAA,uDAAkC,GAAE,CAAC;QACrC,IAAI,CAAC,IAAA,uCAA+B,EAAC,oDAA4B,CAAC,EAAE,CAAC;YAAE,IAAA,mCAA2B,EAAC,oDAA4B,CAAC,CAAC;QAEjI,OAAO;YACL,MAAM,EAAE,gBAAc;YACtB,OAAO,EAAE,CAAC,yBAAiB,EAAE,6BAAqB,EAAE,4BAAoB,EAAE,GAAG,QAAQ,CAAC,OAAO,CAAC;YAC9F,WAAW,EAAE,CAAC,wCAAkB,EAAE,+CAAqB,EAAE,mDAAuB,CAAC;YACjF,SAAS,EAAE;gBACT,EAAE,OAAO,EAAE,mCAAgB,EAAE,QAAQ,EAAE,QAAQ,EAAE;gBACjD,EAAE,OAAO,EAAE,8BAAkB,EAAE,QAAQ,EAAE,QAAQ,CAAC,SAAS,IAAI,gCAAoB,EAAE;gBACrF,EAAE,OAAO,EAAE,6BAAiB,EAAE,QAAQ,EAAE,QAAQ,CAAC,QAAQ,IAAI,iCAAkB,EAAE;gBACjF,EAAE,OAAO,EAAE,wCAAkB,EAAE,QAAQ,EAAE,8CAAwB,EAAE;gBACnE,EAAE,OAAO,EAAE,wCAAc,EAAE,QAAQ,EAAE,mDAAyB,EAAE;gBAChE,kCAAe;gBACf,mDAAuB;gBACvB,+CAAqB;gBACrB,6CAAoB;gBACpB,2CAAmB;gBACnB,+CAAqB;gBACrB,yDAA0B;gBAC1B,GAAG,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,qCAAgB,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;aACpD;YACD,OAAO,EAAE,CAAC,mCAAgB,EAAE,kCAAe,EAAE,mDAAuB,CAAC;SACtE,CAAC;IACJ,CAAC;CACF,CAAA;AAhDY,wCAAc;yBAAd,cAAc;IAD1B,IAAA,eAAM,EAAC,EAAE,CAAC;GACE,cAAc,CAgD1B"}

package/dist/webhooks/webhooks.options.d.ts

@@ -0,0 +1,119 @@
+import type { ModuleMetadata } from '@nestjs/common';
+import type { HostResolver } from './egress/egress-guard';
+import type { WebhookTransport } from './egress/transport';
+/**
+ * Injection token of the resolved {@link WebhooksModuleOptions}.
+ *
+ * @stability experimental
+ */
+export declare const WEBHOOKS_OPTIONS: unique symbol;
+/**
+ * Options of `WebhooksModule.forRoot()`; every field is optional.
+ *
+ * @stability experimental
+ */
+export interface WebhooksModuleOptions {
+    /** The product name in the `User-Agent` (`<name>-Webhooks/1.0`); a function is read per request. Default `App`. */
+    appName?: string | (() => string);
+    /** Allow `http:` targets. Development only. Default `false`. */
+    allowInsecureHttp?: boolean;
+    /** Allow private, loopback and link-local targets and ports below 1024. On-premises and development only. Default `false`. */
+    allowPrivateTargets?: boolean;
+    /** Host names exempt from the private-address check (an internal receiver an operator vouches for). Default none. */
+    allowedHosts?: readonly string[];
+    /** Consecutive failed deliveries that switch an endpoint off. Default 20. */
+    circuitBreakerThreshold?: number;
+    /** Hours the previous secret keeps signing after a rotation. Default 24. */
+    rotationOverlapHours?: number;
+    /** Days a delivery row is kept. Default 30. */
+    deliveryRetentionDays?: number;
+    /** The most endpoints one owner may have, per scope. Defaults 20 user, 50 org, 50 system. */
+    limits?: {
+        /** The most endpoints one member may own. */
+        user?: number;
+        /** The most endpoints one organization may have. */
+        org?: number;
+        /** The most endpoints the deployment may have. */
+        system?: number;
+    };
+    /** The deadline of one delivery request, in milliseconds. Default 10000. */
+    requestTimeoutMs?: number;
+    /** Attempts before a delivery is `dead`. Default 10. */
+    maxDeliveryAttempts?: number;
+    /** The slice's cron tasks. */
+    tasks?: {
+        /** Register the daily retention purge cron. Default `true`. */
+        purge?: boolean;
+    };
+    /** Replace the HTTP transport (tests, a proxy). Default: Node's `http(s).request` to the pinned address. */
+    transport?: WebhookTransport;
+    /** Replace the DNS resolver (tests). Default: the operating system's. */
+    resolver?: HostResolver;
+    /** Modules imported next to the slice: the app's host module binding `WEBHOOKS_SYSTEM_PRISMA`. */
+    imports?: ModuleMetadata['imports'];
+}
+/**
+ * {@link WebhooksModuleOptions} with every default applied.
+ *
+ * @stability experimental
+ */
+export interface ResolvedWebhooksModuleOptions {
+    /** Reads the product name. */
+    readonly appName: () => string;
+    /** See the option. */
+    readonly allowInsecureHttp: boolean;
+    /** See the option. */
+    readonly allowPrivateTargets: boolean;
+    /** See the option. */
+    readonly allowedHosts: readonly string[];
+    /** See the option. */
+    readonly circuitBreakerThreshold: number;
+    /** See the option. */
+    readonly rotationOverlapHours: number;
+    /** See the option. */
+    readonly deliveryRetentionDays: number;
+    /** See the option. */
+    readonly limits: {
+        /** The most endpoints one member may own. */
+        readonly user: number;
+        /** The most endpoints one organization may have. */
+        readonly org: number;
+        /** The most endpoints the deployment may have. */
+        readonly system: number;
+    };
+    /** See the option. */
+    readonly requestTimeoutMs: number;
+    /** See the option. */
+    readonly maxDeliveryAttempts: number;
+    /** See the option. */
+    readonly tasks: {
+        /** Whether the daily purge cron is registered. */
+        readonly purge: boolean;
+    };
+    /** The transport override, when given. */
+    readonly transport: WebhookTransport | undefined;
+    /** The resolver override, when given. */
+    readonly resolver: HostResolver | undefined;
+    /** The modules imported next to the slice. */
+    readonly imports: NonNullable<ModuleMetadata['imports']>;
+}
+/**
+ * The product token of a `User-Agent`: letters, digits and `-`.
+ *
+ * @param name - the application name.
+ * @returns the token, `App` when nothing survives.
+ *
+ * @stability experimental
+ */
+export declare function userAgentToken(name: string): string;
+/**
+ * Validates `options` and applies the defaults.
+ *
+ * @param options - what the app passed.
+ * @returns the resolved options (frozen).
+ * @throws Error when a number is not a positive integer.
+ *
+ * @stability experimental
+ */
+export declare function resolveWebhooksModuleOptions(options?: WebhooksModuleOptions): ResolvedWebhooksModuleOptions;
+//# sourceMappingURL=webhooks.options.d.ts.map

package/dist/webhooks/webhooks.options.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"webhooks.options.d.ts","sourceRoot":"","sources":["../../src/webhooks/webhooks.options.ts"],"names":[],"mappings":"AASA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAErD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AAC1D,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAG3D;;;;GAIG;AACH,eAAO,MAAM,gBAAgB,EAAE,OAAO,MAA4D,CAAC;AAEnG;;;;GAIG;AACH,MAAM,WAAW,qBAAqB;IACpC,mHAAmH;IACnH,OAAO,CAAC,EAAE,MAAM,GAAG,CAAC,MAAM,MAAM,CAAC,CAAC;IAClC,gEAAgE;IAChE,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,8HAA8H;IAC9H,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B,qHAAqH;IACrH,YAAY,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;IACjC,6EAA6E;IAC7E,uBAAuB,CAAC,EAAE,MAAM,CAAC;IACjC,4EAA4E;IAC5E,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B,+CAA+C;IAC/C,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAC/B,6FAA6F;IAC7F,MAAM,CAAC,EAAE;QACP,6CAA6C;QAC7C,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,oDAAoD;QACpD,GAAG,CAAC,EAAE,MAAM,CAAC;QACb,kDAAkD;QAClD,MAAM,CAAC,EAAE,MAAM,CAAC;KACjB,CAAC;IACF,4EAA4E;IAC5E,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,wDAAwD;IACxD,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,8BAA8B;IAC9B,KAAK,CAAC,EAAE;QACN,+DAA+D;QAC/D,KAAK,CAAC,EAAE,OAAO,CAAC;KACjB,CAAC;IACF,4GAA4G;IAC5G,SAAS,CAAC,EAAE,gBAAgB,CAAC;IAC7B,yEAAyE;IACzE,QAAQ,CAAC,EAAE,YAAY,CAAC;IACxB,kGAAkG;IAClG,OAAO,CAAC,EAAE,cAAc,CAAC,SAAS,CAAC,CAAC;CACrC;AAED;;;;GAIG;AACH,MAAM,WAAW,6BAA6B;IAC5C,8BAA8B;IAC9B,QAAQ,CAAC,OAAO,EAAE,MAAM,MAAM,CAAC;IAC/B,sBAAsB;IACtB,QAAQ,CAAC,iBAAiB,EAAE,OAAO,CAAC;IACpC,sBAAsB;IACtB,QAAQ,CAAC,mBAAmB,EAAE,OAAO,CAAC;IACtC,sBAAsB;IACtB,QAAQ,CAAC,YAAY,EAAE,SAAS,MAAM,EAAE,CAAC;IACzC,sBAAsB;IACtB,QAAQ,CAAC,uBAAuB,EAAE,MAAM,CAAC;IACzC,sBAAsB;IACtB,QAAQ,CAAC,oBAAoB,EAAE,MAAM,CAAC;IACtC,sBAAsB;IACtB,QAAQ,CAAC,qBAAqB,EAAE,MAAM,CAAC;IACvC,sBAAsB;IACtB,QAAQ,CAAC,MAAM,EAAE;QACf,6CAA6C;QAC7C,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;QACtB,oDAAoD;QACpD,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;QACrB,kDAAkD;QAClD,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;KACzB,CAAC;IACF,sBAAsB;IACtB,QAAQ,CAAC,gBAAgB,EAAE,MAAM,CAAC;IAClC,sBAAsB;IACtB,QAAQ,CAAC,mBAAmB,EAAE,MAAM,CAAC;IACrC,sBAAsB;IACtB,QAAQ,CAAC,KAAK,EAAE;QACd,kDAAkD;QAClD,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAC;KACzB,CAAC;IACF,0CAA0C;IAC1C,QAAQ,CAAC,SAAS,EAAE,gBAAgB,GAAG,SAAS,CAAC;IACjD,yCAAyC;IACzC,QAAQ,CAAC,QAAQ,EAAE,YAAY,GAAG,SAAS,CAAC;IAC5C,8CAA8C;IAC9C,QAAQ,CAAC,OAAO,EAAE,WAAW,CAAC,cAAc,CAAC,SAAS,CAAC,CAAC,CAAC;CAC1D;AASD;;;;;;;GAOG;AACH,wBAAgB,cAAc,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAGnD;AAED;;;;;;;;GAQG;AACH,wBAAgB,4BAA4B,CAAC,OAAO,GAAE,qBAA0B,GAAG,6BAA6B,CA8B/G"}

package/dist/webhooks/webhooks.options.js

@@ -0,0 +1,80 @@
+"use strict";
+// =============================================================================
+// WebhooksModule.forRoot() options (issue #1046)
+// =============================================================================
+//
+// CODE OPTIONS, not environment variables or system settings: a retry ceiling
+// or an endpoint limit is a product decision an app makes once. Nothing here
+// holds a secret; signing secrets live in the encrypted credentials store.
+// =============================================================================
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WEBHOOKS_OPTIONS = void 0;
+exports.userAgentToken = userAgentToken;
+exports.resolveWebhooksModuleOptions = resolveWebhooksModuleOptions;
+const webhooks_constants_1 = require("./webhooks.constants");
+/**
+ * Injection token of the resolved {@link WebhooksModuleOptions}.
+ *
+ * @stability experimental
+ */
+exports.WEBHOOKS_OPTIONS = Symbol.for('@marinoscar/platform/webhooks/OPTIONS');
+function positiveInt(name, value) {
+    if (value === undefined)
+        return;
+    if (typeof value !== 'number' || !Number.isInteger(value) || value < 1) {
+        throw new Error(`WebhooksModule.forRoot(): ${name} must be a positive integer (got ${String(value)})`);
+    }
+}
+/**
+ * The product token of a `User-Agent`: letters, digits and `-`.
+ *
+ * @param name - the application name.
+ * @returns the token, `App` when nothing survives.
+ *
+ * @stability experimental
+ */
+function userAgentToken(name) {
+    const token = name.replace(/[^A-Za-z0-9]+/g, '-').replace(/^-+|-+$/g, '').slice(0, 40);
+    return token || 'App';
+}
+/**
+ * Validates `options` and applies the defaults.
+ *
+ * @param options - what the app passed.
+ * @returns the resolved options (frozen).
+ * @throws Error when a number is not a positive integer.
+ *
+ * @stability experimental
+ */
+function resolveWebhooksModuleOptions(options = {}) {
+    positiveInt('circuitBreakerThreshold', options.circuitBreakerThreshold);
+    positiveInt('rotationOverlapHours', options.rotationOverlapHours);
+    positiveInt('deliveryRetentionDays', options.deliveryRetentionDays);
+    positiveInt('requestTimeoutMs', options.requestTimeoutMs);
+    positiveInt('maxDeliveryAttempts', options.maxDeliveryAttempts);
+    positiveInt('limits.user', options.limits?.user);
+    positiveInt('limits.org', options.limits?.org);
+    positiveInt('limits.system', options.limits?.system);
+    const name = options.appName;
+    return Object.freeze({
+        appName: typeof name === 'function' ? () => userAgentToken(name()) : () => userAgentToken(name ?? 'App'),
+        allowInsecureHttp: options.allowInsecureHttp ?? false,
+        allowPrivateTargets: options.allowPrivateTargets ?? false,
+        allowedHosts: Object.freeze([...(options.allowedHosts ?? [])]),
+        circuitBreakerThreshold: options.circuitBreakerThreshold ?? webhooks_constants_1.WEBHOOK_DEFAULTS.circuitBreakerThreshold,
+        rotationOverlapHours: options.rotationOverlapHours ?? webhooks_constants_1.WEBHOOK_DEFAULTS.rotationOverlapHours,
+        deliveryRetentionDays: options.deliveryRetentionDays ?? webhooks_constants_1.WEBHOOK_DEFAULTS.deliveryRetentionDays,
+        limits: Object.freeze({
+            user: options.limits?.user ?? webhooks_constants_1.WEBHOOK_DEFAULTS.limits.user,
+            org: options.limits?.org ?? webhooks_constants_1.WEBHOOK_DEFAULTS.limits.org,
+            system: options.limits?.system ?? webhooks_constants_1.WEBHOOK_DEFAULTS.limits.system,
+        }),
+        requestTimeoutMs: options.requestTimeoutMs ?? webhooks_constants_1.WEBHOOK_DEFAULTS.requestTimeoutMs,
+        maxDeliveryAttempts: options.maxDeliveryAttempts ?? webhooks_constants_1.WEBHOOK_DEFAULTS.maxDeliveryAttempts,
+        tasks: Object.freeze({ purge: options.tasks?.purge ?? true }),
+        transport: options.transport,
+        resolver: options.resolver,
+        imports: [...(options.imports ?? [])],
+    });
+}
+//# sourceMappingURL=webhooks.options.js.map

package/dist/webhooks/webhooks.options.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"webhooks.options.js","sourceRoot":"","sources":["../../src/webhooks/webhooks.options.ts"],"names":[],"mappings":";AAAA,gFAAgF;AAChF,iDAAiD;AACjD,gFAAgF;AAChF,EAAE;AACF,8EAA8E;AAC9E,6EAA6E;AAC7E,2EAA2E;AAC3E,gFAAgF;;;AA0HhF,wCAGC;AAWD,oEA8BC;AAhKD,6DAAwD;AAExD;;;;GAIG;AACU,QAAA,gBAAgB,GAAkB,MAAM,CAAC,GAAG,CAAC,uCAAuC,CAAC,CAAC;AA8FnG,SAAS,WAAW,CAAC,IAAY,EAAE,KAAyB;IAC1D,IAAI,KAAK,KAAK,SAAS;QAAE,OAAO;IAChC,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,KAAK,GAAG,CAAC,EAAE,CAAC;QACvE,MAAM,IAAI,KAAK,CAAC,6BAA6B,IAAI,oCAAoC,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACzG,CAAC;AACH,CAAC;AAED;;;;;;;GAOG;AACH,SAAgB,cAAc,CAAC,IAAY;IACzC,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,gBAAgB,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;IACvF,OAAO,KAAK,IAAI,KAAK,CAAC;AACxB,CAAC;AAED;;;;;;;;GAQG;AACH,SAAgB,4BAA4B,CAAC,UAAiC,EAAE;IAC9E,WAAW,CAAC,yBAAyB,EAAE,OAAO,CAAC,uBAAuB,CAAC,CAAC;IACxE,WAAW,CAAC,sBAAsB,EAAE,OAAO,CAAC,oBAAoB,CAAC,CAAC;IAClE,WAAW,CAAC,uBAAuB,EAAE,OAAO,CAAC,qBAAqB,CAAC,CAAC;IACpE,WAAW,CAAC,kBAAkB,EAAE,OAAO,CAAC,gBAAgB,CAAC,CAAC;IAC1D,WAAW,CAAC,qBAAqB,EAAE,OAAO,CAAC,mBAAmB,CAAC,CAAC;IAChE,WAAW,CAAC,aAAa,EAAE,OAAO,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IACjD,WAAW,CAAC,YAAY,EAAE,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAC/C,WAAW,CAAC,eAAe,EAAE,OAAO,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACrD,MAAM,IAAI,GAAG,OAAO,CAAC,OAAO,CAAC;IAC7B,OAAO,MAAM,CAAC,MAAM,CAAC;QACnB,OAAO,EAAE,OAAO,IAAI,KAAK,UAAU,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,cAAc,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,cAAc,CAAC,IAAI,IAAI,KAAK,CAAC;QACxG,iBAAiB,EAAE,OAAO,CAAC,iBAAiB,IAAI,KAAK;QACrD,mBAAmB,EAAE,OAAO,CAAC,mBAAmB,IAAI,KAAK;QACzD,YAAY,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,YAAY,IAAI,EAAE,CAAC,CAAC,CAAC;QAC9D,uBAAuB,EAAE,OAAO,CAAC,uBAAuB,IAAI,qCAAgB,CAAC,uBAAuB;QACpG,oBAAoB,EAAE,OAAO,CAAC,oBAAoB,IAAI,qCAAgB,CAAC,oBAAoB;QAC3F,qBAAqB,EAAE,OAAO,CAAC,qBAAqB,IAAI,qCAAgB,CAAC,qBAAqB;QAC9F,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC;YACpB,IAAI,EAAE,OAAO,CAAC,MAAM,EAAE,IAAI,IAAI,qCAAgB,CAAC,MAAM,CAAC,IAAI;YAC1D,GAAG,EAAE,OAAO,CAAC,MAAM,EAAE,GAAG,IAAI,qCAAgB,CAAC,MAAM,CAAC,GAAG;YACvD,MAAM,EAAE,OAAO,CAAC,MAAM,EAAE,MAAM,IAAI,qCAAgB,CAAC,MAAM,CAAC,MAAM;SACjE,CAAC;QACF,gBAAgB,EAAE,OAAO,CAAC,gBAAgB,IAAI,qCAAgB,CAAC,gBAAgB;QAC/E,mBAAmB,EAAE,OAAO,CAAC,mBAAmB,IAAI,qCAAgB,CAAC,mBAAmB;QACxF,KAAK,EAAE,MAAM,CAAC,MAAM,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,EAAE,KAAK,IAAI,IAAI,EAAE,CAAC;QAC7D,SAAS,EAAE,OAAO,CAAC,SAAS;QAC5B,QAAQ,EAAE,OAAO,CAAC,QAAQ;QAC1B,OAAO,EAAE,CAAC,GAAG,CAAC,OAAO,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC;KACtC,CAAC,CAAC;AACL,CAAC"}