@skmtc/core 0.16.1 → 0.16.2

package/esm/oas/webhook/Webhook.d.ts

@@ -2,6 +2,8 @@ import "../../_dnt.polyfills.js";
 import type { Method } from '../../types/Method.js';
 import type { OasPathItem } from '../pathItem/PathItem.js';
 import type { OasParameter } from '../parameter/Parameter.js';
+import type { OasParameterLocation } from '../parameter/parameter-types.js';
+import type { OasSchema } from '../schema/Schema.js';
 import type { OasRequestBody } from '../requestBody/RequestBody.js';
 import type { OasResponse } from '../response/Response.js';
 import type { OasRef } from '../ref/Ref.js';
@@ -63,9 +65,12 @@ export type WebhookFields = {
  * receive one: webhook code generation is a *receiver/handler* concern,
  * not a client-call concern.
  *
- * This is intentionally a parse-only data class. Webhook-semantic helpers
- * (payload schema, ack response, signature verification) accrue when a
- * webhook generator needs them (Phase 4), not preemptively.
+ * Carries webhook-semantic accessors named for the RECEIVER —
+ * `toPayload`/`toPayloadSchema` (the received payload), `toParams` (inbound
+ * params), `toAckResponse`/`toAckResponseCode` (the ack the handler returns).
+ * These deliberately avoid the client-framed {@link OasOperation} names
+ * (`toRequestBody`, `toSuccessResponse`) so the inversion stays explicit in
+ * generator code. (Signature-verification helpers still accrue on demand.)
  */
 export declare class OasWebhook extends OasBase {
     /** Type identifier for OAS webhook objects */
@@ -101,6 +106,38 @@ export declare class OasWebhook extends OasBase {
     /** Servers for this webhook */
     servers: OasServer[] | undefined;
     constructor(fields: WebhookFields, context?: ParseContextType);
+    /**
+     * The received-payload body — the request body the API delivers TO the
+     * consumer's handler. Webhook semantics are inverted: this is what the
+     * handler RECEIVES, not what a client sends. A `$ref` body is resolved.
+     */
+    toPayload(): OasRequestBody | undefined;
+    /**
+     * The schema of the received payload for `mediaType` (default
+     * `application/json`) — the inbound body shape a handler generator emits a
+     * type for. `undefined` when there is no body or no schema for that media
+     * type.
+     */
+    toPayloadSchema(mediaType?: string): OasSchema | OasRef<'schema'> | undefined;
+    /**
+     * Resolve the inbound parameters (e.g. the signature/headers a handler
+     * receives), optionally filtered by location. Mirrors
+     * {@link OasOperation.toParams}; the parameters carry the same shape, only
+     * their direction is inbound.
+     */
+    toParams(filter?: OasParameterLocation[]): OasParameter[];
+    /**
+     * The status code of the primary acknowledgement response — the lowest 2xx
+     * the handler returns to ack the delivery, falling back to `default`. Named
+     * for the receiver: a webhook's `responses` are what the handler RETURNS,
+     * not what a client receives (cf. {@link OasOperation.toSuccessResponseCode}).
+     */
+    toAckResponseCode(): string | undefined;
+    /**
+     * The primary acknowledgement response definition (the body/headers the
+     * handler returns), or `undefined` when none is declared.
+     */
+    toAckResponse(): OasResponse | OasRef<'response'> | undefined;
     /**
      * Serializes the webhook to a plain JavaScript object.
      */

package/esm/oas/webhook/Webhook.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Webhook.d.ts","sourceRoot":"","sources":["../../../src/oas/webhook/Webhook.ts"],"names":[],"mappings":"AAAA,OAAO,yBAAyB,CAAC;AACjC,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,uBAAuB,CAAA;AACnD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAA;AAC1D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAA;AAC7D,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,+BAA+B,CAAA;AACnE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAA;AAC1D,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,eAAe,CAAA;AAC3C,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,+CAA+C,CAAA;AAC3F,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,iCAAiC,CAAA;AACtE,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAA;AACpD,OAAO,EAAE,OAAO,EAAE,MAAM,wBAAwB,CAAA;AAChD,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,6BAA6B,CAAA;AAEnE;;;;;;;;;;;GAWG;AACH,MAAM,MAAM,aAAa,GAAG;IAC1B,iEAAiE;IACjE,IAAI,EAAE,MAAM,CAAA;IACZ,uCAAuC;IACvC,MAAM,EAAE,MAAM,CAAA;IACd,mDAAmD;IACnD,QAAQ,EAAE,WAAW,GAAG,SAAS,CAAA;IACjC,kDAAkD;IAClD,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAChC,mCAAmC;IACnC,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAC5B,oDAAoD;IACpD,IAAI,CAAC,EAAE,MAAM,EAAE,GAAG,SAAS,CAAA;IAC3B,0CAA0C;IAC1C,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAChC,iEAAiE;IACjE,UAAU,CAAC,EAAE,CAAC,YAAY,GAAG,MAAM,CAAC,WAAW,CAAC,CAAC,EAAE,GAAG,SAAS,CAAA;IAC/D,wDAAwD;IACxD,WAAW,CAAC,EAAE,cAAc,GAAG,MAAM,CAAC,aAAa,CAAC,GAAG,SAAS,CAAA;IAChE,2EAA2E;IAC3E,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,WAAW,GAAG,MAAM,CAAC,UAAU,CAAC,CAAC,CAAA;IAC3D,6CAA6C;IAC7C,QAAQ,CAAC,EAAE,sBAAsB,EAAE,GAAG,SAAS,CAAA;IAC/C,yCAAyC;IACzC,UAAU,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;IAChC,8CAA8C;IAC9C,YAAY,CAAC,EAAE,eAAe,GAAG,SAAS,CAAA;IAC1C,uCAAuC;IACvC,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IACzC,+BAA+B;IAC/B,OAAO,CAAC,EAAE,SAAS,EAAE,GAAG,SAAS,CAAA;CAClC,CAAA;AAED;;;;;;;;;;;;GAYG;AACH,qBAAa,UAAW,SAAQ,OAAO;IACrC,8CAA8C;IAC9C,OAAO,EAAE,SAAS,CAAY;IAE9B,iEAAiE;IACjE,IAAI,EAAE,MAAM,CAAA;IACZ,uCAAuC;IACvC,MAAM,EAAE,MAAM,CAAA;IACd,mDAAmD;IACnD,QAAQ,EAAE,WAAW,GAAG,SAAS,CAAA;IACjC,kDAAkD;IAClD,WAAW,EAAE,MAAM,GAAG,SAAS,CAAA;IAC/B,mCAAmC;IACnC,OAAO,EAAE,MAAM,GAAG,SAAS,CAAA;IAC3B,oDAAoD;IACpD,IAAI,EAAE,MAAM,EAAE,GAAG,SAAS,CAAA;IAC1B,0CAA0C;IAC1C,WAAW,EAAE,MAAM,GAAG,SAAS,CAAA;IAC/B,0CAA0C;IAC1C,UAAU,EAAE,CAAC,YAAY,GAAG,MAAM,CAAC,WAAW,CAAC,CAAC,EAAE,GAAG,SAAS,CAAA;IAC9D,wDAAwD;IACxD,WAAW,EAAE,cAAc,GAAG,MAAM,CAAC,aAAa,CAAC,GAAG,SAAS,CAAA;IAC/D,sDAAsD;IACtD,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,WAAW,GAAG,MAAM,CAAC,UAAU,CAAC,CAAC,CAAA;IAC3D,6CAA6C;IAC7C,QAAQ,EAAE,sBAAsB,EAAE,GAAG,SAAS,CAAA;IAC9C,yCAAyC;IACzC,UAAU,EAAE,OAAO,GAAG,SAAS,CAAA;IAC/B,8CAA8C;IAC9C,YAAY,EAAE,eAAe,GAAG,SAAS,CAAA;IACzC,uCAAuC;IACvC,eAAe,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAAA;IACpD,+BAA+B;IAC/B,OAAO,EAAE,SAAS,EAAE,GAAG,SAAS,CAAA;gBAEpB,MAAM,EAAE,aAAa,EAAE,OAAO,CAAC,EAAE,gBAAgB;IAmB7D;;OAEG;IACH,MAAM,IAAI,MAAM;CAgBjB"}
+{"version":3,"file":"Webhook.d.ts","sourceRoot":"","sources":["../../../src/oas/webhook/Webhook.ts"],"names":[],"mappings":"AAAA,OAAO,yBAAyB,CAAC;AACjC,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,uBAAuB,CAAA;AACnD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAA;AAC1D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAA;AAC7D,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,iCAAiC,CAAA;AAC3E,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAA;AACpD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,+BAA+B,CAAA;AACnE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAA;AAC1D,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,eAAe,CAAA;AAC3C,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,+CAA+C,CAAA;AAC3F,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,iCAAiC,CAAA;AACtE,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAA;AACpD,OAAO,EAAE,OAAO,EAAE,MAAM,wBAAwB,CAAA;AAChD,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,6BAA6B,CAAA;AAEnE;;;;;;;;;;;GAWG;AACH,MAAM,MAAM,aAAa,GAAG;IAC1B,iEAAiE;IACjE,IAAI,EAAE,MAAM,CAAA;IACZ,uCAAuC;IACvC,MAAM,EAAE,MAAM,CAAA;IACd,mDAAmD;IACnD,QAAQ,EAAE,WAAW,GAAG,SAAS,CAAA;IACjC,kDAAkD;IAClD,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAChC,mCAAmC;IACnC,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAC5B,oDAAoD;IACpD,IAAI,CAAC,EAAE,MAAM,EAAE,GAAG,SAAS,CAAA;IAC3B,0CAA0C;IAC1C,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAChC,iEAAiE;IACjE,UAAU,CAAC,EAAE,CAAC,YAAY,GAAG,MAAM,CAAC,WAAW,CAAC,CAAC,EAAE,GAAG,SAAS,CAAA;IAC/D,wDAAwD;IACxD,WAAW,CAAC,EAAE,cAAc,GAAG,MAAM,CAAC,aAAa,CAAC,GAAG,SAAS,CAAA;IAChE,2EAA2E;IAC3E,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,WAAW,GAAG,MAAM,CAAC,UAAU,CAAC,CAAC,CAAA;IAC3D,6CAA6C;IAC7C,QAAQ,CAAC,EAAE,sBAAsB,EAAE,GAAG,SAAS,CAAA;IAC/C,yCAAyC;IACzC,UAAU,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;IAChC,8CAA8C;IAC9C,YAAY,CAAC,EAAE,eAAe,GAAG,SAAS,CAAA;IAC1C,uCAAuC;IACvC,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IACzC,+BAA+B;IAC/B,OAAO,CAAC,EAAE,SAAS,EAAE,GAAG,SAAS,CAAA;CAClC,CAAA;AAED;;;;;;;;;;;;;;;GAeG;AACH,qBAAa,UAAW,SAAQ,OAAO;IACrC,8CAA8C;IAC9C,OAAO,EAAE,SAAS,CAAY;IAE9B,iEAAiE;IACjE,IAAI,EAAE,MAAM,CAAA;IACZ,uCAAuC;IACvC,MAAM,EAAE,MAAM,CAAA;IACd,mDAAmD;IACnD,QAAQ,EAAE,WAAW,GAAG,SAAS,CAAA;IACjC,kDAAkD;IAClD,WAAW,EAAE,MAAM,GAAG,SAAS,CAAA;IAC/B,mCAAmC;IACnC,OAAO,EAAE,MAAM,GAAG,SAAS,CAAA;IAC3B,oDAAoD;IACpD,IAAI,EAAE,MAAM,EAAE,GAAG,SAAS,CAAA;IAC1B,0CAA0C;IAC1C,WAAW,EAAE,MAAM,GAAG,SAAS,CAAA;IAC/B,0CAA0C;IAC1C,UAAU,EAAE,CAAC,YAAY,GAAG,MAAM,CAAC,WAAW,CAAC,CAAC,EAAE,GAAG,SAAS,CAAA;IAC9D,wDAAwD;IACxD,WAAW,EAAE,cAAc,GAAG,MAAM,CAAC,aAAa,CAAC,GAAG,SAAS,CAAA;IAC/D,sDAAsD;IACtD,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,WAAW,GAAG,MAAM,CAAC,UAAU,CAAC,CAAC,CAAA;IAC3D,6CAA6C;IAC7C,QAAQ,EAAE,sBAAsB,EAAE,GAAG,SAAS,CAAA;IAC9C,yCAAyC;IACzC,UAAU,EAAE,OAAO,GAAG,SAAS,CAAA;IAC/B,8CAA8C;IAC9C,YAAY,EAAE,eAAe,GAAG,SAAS,CAAA;IACzC,uCAAuC;IACvC,eAAe,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAAA;IACpD,+BAA+B;IAC/B,OAAO,EAAE,SAAS,EAAE,GAAG,SAAS,CAAA;gBAEpB,MAAM,EAAE,aAAa,EAAE,OAAO,CAAC,EAAE,gBAAgB;IAmB7D;;;;OAIG;IACH,SAAS,IAAI,cAAc,GAAG,SAAS;IAIvC;;;;;OAKG;IACH,eAAe,CAAC,SAAS,SAAqB,GAAG,SAAS,GAAG,MAAM,CAAC,QAAQ,CAAC,GAAG,SAAS;IAIzF;;;;;OAKG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,oBAAoB,EAAE,GAAG,YAAY,EAAE;IAQzD;;;;;OAKG;IACH,iBAAiB,IAAI,MAAM,GAAG,SAAS;IAiBvC;;;OAGG;IACH,aAAa,IAAI,WAAW,GAAG,MAAM,CAAC,UAAU,CAAC,GAAG,SAAS;IAM7D;;OAEG;IACH,MAAM,IAAI,MAAM;CAgBjB"}

package/esm/oas/webhook/Webhook.js

@@ -9,9 +9,12 @@ import { OasBase } from '../../types/OasBase.js';
  * receive one: webhook code generation is a *receiver/handler* concern,
  * not a client-call concern.
  *
- * This is intentionally a parse-only data class. Webhook-semantic helpers
- * (payload schema, ack response, signature verification) accrue when a
- * webhook generator needs them (Phase 4), not preemptively.
+ * Carries webhook-semantic accessors named for the RECEIVER —
+ * `toPayload`/`toPayloadSchema` (the received payload), `toParams` (inbound
+ * params), `toAckResponse`/`toAckResponseCode` (the ack the handler returns).
+ * These deliberately avoid the client-framed {@link OasOperation} names
+ * (`toRequestBody`, `toSuccessResponse`) so the inversion stays explicit in
+ * generator code. (Signature-verification helpers still accrue on demand.)
  */
 export class OasWebhook extends OasBase {
     constructor(fields, context) {
@@ -144,6 +147,61 @@ export class OasWebhook extends OasBase {
         this.extensionFields = fields.extensionFields;
         this.servers = fields.servers;
     }
+    /**
+     * The received-payload body — the request body the API delivers TO the
+     * consumer's handler. Webhook semantics are inverted: this is what the
+     * handler RECEIVES, not what a client sends. A `$ref` body is resolved.
+     */
+    toPayload() {
+        return this.requestBody?.resolve();
+    }
+    /**
+     * The schema of the received payload for `mediaType` (default
+     * `application/json`) — the inbound body shape a handler generator emits a
+     * type for. `undefined` when there is no body or no schema for that media
+     * type.
+     */
+    toPayloadSchema(mediaType = 'application/json') {
+        return this.toPayload()?.content[mediaType]?.schema;
+    }
+    /**
+     * Resolve the inbound parameters (e.g. the signature/headers a handler
+     * receives), optionally filtered by location. Mirrors
+     * {@link OasOperation.toParams}; the parameters carry the same shape, only
+     * their direction is inbound.
+     */
+    toParams(filter) {
+        return (this.parameters
+            ?.map(param => param.resolve())
+            .filter(param => (filter?.length ? filter.includes(param.location) : true)) ?? []);
+    }
+    /**
+     * The status code of the primary acknowledgement response — the lowest 2xx
+     * the handler returns to ack the delivery, falling back to `default`. Named
+     * for the receiver: a webhook's `responses` are what the handler RETURNS,
+     * not what a client receives (cf. {@link OasOperation.toSuccessResponseCode}).
+     */
+    toAckResponseCode() {
+        const ackCode = Object.keys(this.responses)
+            .map(httpCode => parseInt(httpCode))
+            .sort((a, b) => a - b)
+            .find(httpCode => httpCode >= 200 && httpCode < 300);
+        if (ackCode) {
+            return ackCode.toString();
+        }
+        if (this.responses.default) {
+            return 'default';
+        }
+        return undefined;
+    }
+    /**
+     * The primary acknowledgement response definition (the body/headers the
+     * handler returns), or `undefined` when none is declared.
+     */
+    toAckResponse() {
+        const ackCode = this.toAckResponseCode();
+        return ackCode ? this.responses[ackCode] : undefined;
+    }
     /**
      * Serializes the webhook to a plain JavaScript object.
      */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@skmtc/core",
-  "version": "0.16.1",
+  "version": "0.16.2",
   "description": "Skmtc is a declarative code generation framework",
   "keywords": [
     "openapi",

package/script/oas/webhook/Webhook.d.ts

@@ -2,6 +2,8 @@ import "../../_dnt.polyfills.js";
 import type { Method } from '../../types/Method.js';
 import type { OasPathItem } from '../pathItem/PathItem.js';
 import type { OasParameter } from '../parameter/Parameter.js';
+import type { OasParameterLocation } from '../parameter/parameter-types.js';
+import type { OasSchema } from '../schema/Schema.js';
 import type { OasRequestBody } from '../requestBody/RequestBody.js';
 import type { OasResponse } from '../response/Response.js';
 import type { OasRef } from '../ref/Ref.js';
@@ -63,9 +65,12 @@ export type WebhookFields = {
  * receive one: webhook code generation is a *receiver/handler* concern,
  * not a client-call concern.
  *
- * This is intentionally a parse-only data class. Webhook-semantic helpers
- * (payload schema, ack response, signature verification) accrue when a
- * webhook generator needs them (Phase 4), not preemptively.
+ * Carries webhook-semantic accessors named for the RECEIVER —
+ * `toPayload`/`toPayloadSchema` (the received payload), `toParams` (inbound
+ * params), `toAckResponse`/`toAckResponseCode` (the ack the handler returns).
+ * These deliberately avoid the client-framed {@link OasOperation} names
+ * (`toRequestBody`, `toSuccessResponse`) so the inversion stays explicit in
+ * generator code. (Signature-verification helpers still accrue on demand.)
  */
 export declare class OasWebhook extends OasBase {
     /** Type identifier for OAS webhook objects */
@@ -101,6 +106,38 @@ export declare class OasWebhook extends OasBase {
     /** Servers for this webhook */
     servers: OasServer[] | undefined;
     constructor(fields: WebhookFields, context?: ParseContextType);
+    /**
+     * The received-payload body — the request body the API delivers TO the
+     * consumer's handler. Webhook semantics are inverted: this is what the
+     * handler RECEIVES, not what a client sends. A `$ref` body is resolved.
+     */
+    toPayload(): OasRequestBody | undefined;
+    /**
+     * The schema of the received payload for `mediaType` (default
+     * `application/json`) — the inbound body shape a handler generator emits a
+     * type for. `undefined` when there is no body or no schema for that media
+     * type.
+     */
+    toPayloadSchema(mediaType?: string): OasSchema | OasRef<'schema'> | undefined;
+    /**
+     * Resolve the inbound parameters (e.g. the signature/headers a handler
+     * receives), optionally filtered by location. Mirrors
+     * {@link OasOperation.toParams}; the parameters carry the same shape, only
+     * their direction is inbound.
+     */
+    toParams(filter?: OasParameterLocation[]): OasParameter[];
+    /**
+     * The status code of the primary acknowledgement response — the lowest 2xx
+     * the handler returns to ack the delivery, falling back to `default`. Named
+     * for the receiver: a webhook's `responses` are what the handler RETURNS,
+     * not what a client receives (cf. {@link OasOperation.toSuccessResponseCode}).
+     */
+    toAckResponseCode(): string | undefined;
+    /**
+     * The primary acknowledgement response definition (the body/headers the
+     * handler returns), or `undefined` when none is declared.
+     */
+    toAckResponse(): OasResponse | OasRef<'response'> | undefined;
     /**
      * Serializes the webhook to a plain JavaScript object.
      */

package/script/oas/webhook/Webhook.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Webhook.d.ts","sourceRoot":"","sources":["../../../src/oas/webhook/Webhook.ts"],"names":[],"mappings":"AAAA,OAAO,yBAAyB,CAAC;AACjC,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,uBAAuB,CAAA;AACnD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAA;AAC1D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAA;AAC7D,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,+BAA+B,CAAA;AACnE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAA;AAC1D,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,eAAe,CAAA;AAC3C,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,+CAA+C,CAAA;AAC3F,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,iCAAiC,CAAA;AACtE,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAA;AACpD,OAAO,EAAE,OAAO,EAAE,MAAM,wBAAwB,CAAA;AAChD,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,6BAA6B,CAAA;AAEnE;;;;;;;;;;;GAWG;AACH,MAAM,MAAM,aAAa,GAAG;IAC1B,iEAAiE;IACjE,IAAI,EAAE,MAAM,CAAA;IACZ,uCAAuC;IACvC,MAAM,EAAE,MAAM,CAAA;IACd,mDAAmD;IACnD,QAAQ,EAAE,WAAW,GAAG,SAAS,CAAA;IACjC,kDAAkD;IAClD,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAChC,mCAAmC;IACnC,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAC5B,oDAAoD;IACpD,IAAI,CAAC,EAAE,MAAM,EAAE,GAAG,SAAS,CAAA;IAC3B,0CAA0C;IAC1C,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAChC,iEAAiE;IACjE,UAAU,CAAC,EAAE,CAAC,YAAY,GAAG,MAAM,CAAC,WAAW,CAAC,CAAC,EAAE,GAAG,SAAS,CAAA;IAC/D,wDAAwD;IACxD,WAAW,CAAC,EAAE,cAAc,GAAG,MAAM,CAAC,aAAa,CAAC,GAAG,SAAS,CAAA;IAChE,2EAA2E;IAC3E,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,WAAW,GAAG,MAAM,CAAC,UAAU,CAAC,CAAC,CAAA;IAC3D,6CAA6C;IAC7C,QAAQ,CAAC,EAAE,sBAAsB,EAAE,GAAG,SAAS,CAAA;IAC/C,yCAAyC;IACzC,UAAU,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;IAChC,8CAA8C;IAC9C,YAAY,CAAC,EAAE,eAAe,GAAG,SAAS,CAAA;IAC1C,uCAAuC;IACvC,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IACzC,+BAA+B;IAC/B,OAAO,CAAC,EAAE,SAAS,EAAE,GAAG,SAAS,CAAA;CAClC,CAAA;AAED;;;;;;;;;;;;GAYG;AACH,qBAAa,UAAW,SAAQ,OAAO;IACrC,8CAA8C;IAC9C,OAAO,EAAE,SAAS,CAAY;IAE9B,iEAAiE;IACjE,IAAI,EAAE,MAAM,CAAA;IACZ,uCAAuC;IACvC,MAAM,EAAE,MAAM,CAAA;IACd,mDAAmD;IACnD,QAAQ,EAAE,WAAW,GAAG,SAAS,CAAA;IACjC,kDAAkD;IAClD,WAAW,EAAE,MAAM,GAAG,SAAS,CAAA;IAC/B,mCAAmC;IACnC,OAAO,EAAE,MAAM,GAAG,SAAS,CAAA;IAC3B,oDAAoD;IACpD,IAAI,EAAE,MAAM,EAAE,GAAG,SAAS,CAAA;IAC1B,0CAA0C;IAC1C,WAAW,EAAE,MAAM,GAAG,SAAS,CAAA;IAC/B,0CAA0C;IAC1C,UAAU,EAAE,CAAC,YAAY,GAAG,MAAM,CAAC,WAAW,CAAC,CAAC,EAAE,GAAG,SAAS,CAAA;IAC9D,wDAAwD;IACxD,WAAW,EAAE,cAAc,GAAG,MAAM,CAAC,aAAa,CAAC,GAAG,SAAS,CAAA;IAC/D,sDAAsD;IACtD,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,WAAW,GAAG,MAAM,CAAC,UAAU,CAAC,CAAC,CAAA;IAC3D,6CAA6C;IAC7C,QAAQ,EAAE,sBAAsB,EAAE,GAAG,SAAS,CAAA;IAC9C,yCAAyC;IACzC,UAAU,EAAE,OAAO,GAAG,SAAS,CAAA;IAC/B,8CAA8C;IAC9C,YAAY,EAAE,eAAe,GAAG,SAAS,CAAA;IACzC,uCAAuC;IACvC,eAAe,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAAA;IACpD,+BAA+B;IAC/B,OAAO,EAAE,SAAS,EAAE,GAAG,SAAS,CAAA;gBAEpB,MAAM,EAAE,aAAa,EAAE,OAAO,CAAC,EAAE,gBAAgB;IAmB7D;;OAEG;IACH,MAAM,IAAI,MAAM;CAgBjB"}
+{"version":3,"file":"Webhook.d.ts","sourceRoot":"","sources":["../../../src/oas/webhook/Webhook.ts"],"names":[],"mappings":"AAAA,OAAO,yBAAyB,CAAC;AACjC,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,uBAAuB,CAAA;AACnD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAA;AAC1D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAA;AAC7D,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,iCAAiC,CAAA;AAC3E,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAA;AACpD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,+BAA+B,CAAA;AACnE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAA;AAC1D,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,eAAe,CAAA;AAC3C,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,+CAA+C,CAAA;AAC3F,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,iCAAiC,CAAA;AACtE,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAA;AACpD,OAAO,EAAE,OAAO,EAAE,MAAM,wBAAwB,CAAA;AAChD,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,6BAA6B,CAAA;AAEnE;;;;;;;;;;;GAWG;AACH,MAAM,MAAM,aAAa,GAAG;IAC1B,iEAAiE;IACjE,IAAI,EAAE,MAAM,CAAA;IACZ,uCAAuC;IACvC,MAAM,EAAE,MAAM,CAAA;IACd,mDAAmD;IACnD,QAAQ,EAAE,WAAW,GAAG,SAAS,CAAA;IACjC,kDAAkD;IAClD,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAChC,mCAAmC;IACnC,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAC5B,oDAAoD;IACpD,IAAI,CAAC,EAAE,MAAM,EAAE,GAAG,SAAS,CAAA;IAC3B,0CAA0C;IAC1C,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAChC,iEAAiE;IACjE,UAAU,CAAC,EAAE,CAAC,YAAY,GAAG,MAAM,CAAC,WAAW,CAAC,CAAC,EAAE,GAAG,SAAS,CAAA;IAC/D,wDAAwD;IACxD,WAAW,CAAC,EAAE,cAAc,GAAG,MAAM,CAAC,aAAa,CAAC,GAAG,SAAS,CAAA;IAChE,2EAA2E;IAC3E,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,WAAW,GAAG,MAAM,CAAC,UAAU,CAAC,CAAC,CAAA;IAC3D,6CAA6C;IAC7C,QAAQ,CAAC,EAAE,sBAAsB,EAAE,GAAG,SAAS,CAAA;IAC/C,yCAAyC;IACzC,UAAU,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;IAChC,8CAA8C;IAC9C,YAAY,CAAC,EAAE,eAAe,GAAG,SAAS,CAAA;IAC1C,uCAAuC;IACvC,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IACzC,+BAA+B;IAC/B,OAAO,CAAC,EAAE,SAAS,EAAE,GAAG,SAAS,CAAA;CAClC,CAAA;AAED;;;;;;;;;;;;;;;GAeG;AACH,qBAAa,UAAW,SAAQ,OAAO;IACrC,8CAA8C;IAC9C,OAAO,EAAE,SAAS,CAAY;IAE9B,iEAAiE;IACjE,IAAI,EAAE,MAAM,CAAA;IACZ,uCAAuC;IACvC,MAAM,EAAE,MAAM,CAAA;IACd,mDAAmD;IACnD,QAAQ,EAAE,WAAW,GAAG,SAAS,CAAA;IACjC,kDAAkD;IAClD,WAAW,EAAE,MAAM,GAAG,SAAS,CAAA;IAC/B,mCAAmC;IACnC,OAAO,EAAE,MAAM,GAAG,SAAS,CAAA;IAC3B,oDAAoD;IACpD,IAAI,EAAE,MAAM,EAAE,GAAG,SAAS,CAAA;IAC1B,0CAA0C;IAC1C,WAAW,EAAE,MAAM,GAAG,SAAS,CAAA;IAC/B,0CAA0C;IAC1C,UAAU,EAAE,CAAC,YAAY,GAAG,MAAM,CAAC,WAAW,CAAC,CAAC,EAAE,GAAG,SAAS,CAAA;IAC9D,wDAAwD;IACxD,WAAW,EAAE,cAAc,GAAG,MAAM,CAAC,aAAa,CAAC,GAAG,SAAS,CAAA;IAC/D,sDAAsD;IACtD,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,WAAW,GAAG,MAAM,CAAC,UAAU,CAAC,CAAC,CAAA;IAC3D,6CAA6C;IAC7C,QAAQ,EAAE,sBAAsB,EAAE,GAAG,SAAS,CAAA;IAC9C,yCAAyC;IACzC,UAAU,EAAE,OAAO,GAAG,SAAS,CAAA;IAC/B,8CAA8C;IAC9C,YAAY,EAAE,eAAe,GAAG,SAAS,CAAA;IACzC,uCAAuC;IACvC,eAAe,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAAA;IACpD,+BAA+B;IAC/B,OAAO,EAAE,SAAS,EAAE,GAAG,SAAS,CAAA;gBAEpB,MAAM,EAAE,aAAa,EAAE,OAAO,CAAC,EAAE,gBAAgB;IAmB7D;;;;OAIG;IACH,SAAS,IAAI,cAAc,GAAG,SAAS;IAIvC;;;;;OAKG;IACH,eAAe,CAAC,SAAS,SAAqB,GAAG,SAAS,GAAG,MAAM,CAAC,QAAQ,CAAC,GAAG,SAAS;IAIzF;;;;;OAKG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,oBAAoB,EAAE,GAAG,YAAY,EAAE;IAQzD;;;;;OAKG;IACH,iBAAiB,IAAI,MAAM,GAAG,SAAS;IAiBvC;;;OAGG;IACH,aAAa,IAAI,WAAW,GAAG,MAAM,CAAC,UAAU,CAAC,GAAG,SAAS;IAM7D;;OAEG;IACH,MAAM,IAAI,MAAM;CAgBjB"}

package/script/oas/webhook/Webhook.js

@@ -12,9 +12,12 @@ const OasBase_js_1 = require("../../types/OasBase.js");
  * receive one: webhook code generation is a *receiver/handler* concern,
  * not a client-call concern.
  *
- * This is intentionally a parse-only data class. Webhook-semantic helpers
- * (payload schema, ack response, signature verification) accrue when a
- * webhook generator needs them (Phase 4), not preemptively.
+ * Carries webhook-semantic accessors named for the RECEIVER —
+ * `toPayload`/`toPayloadSchema` (the received payload), `toParams` (inbound
+ * params), `toAckResponse`/`toAckResponseCode` (the ack the handler returns).
+ * These deliberately avoid the client-framed {@link OasOperation} names
+ * (`toRequestBody`, `toSuccessResponse`) so the inversion stays explicit in
+ * generator code. (Signature-verification helpers still accrue on demand.)
  */
 class OasWebhook extends OasBase_js_1.OasBase {
     constructor(fields, context) {
@@ -147,6 +150,61 @@ class OasWebhook extends OasBase_js_1.OasBase {
         this.extensionFields = fields.extensionFields;
         this.servers = fields.servers;
     }
+    /**
+     * The received-payload body — the request body the API delivers TO the
+     * consumer's handler. Webhook semantics are inverted: this is what the
+     * handler RECEIVES, not what a client sends. A `$ref` body is resolved.
+     */
+    toPayload() {
+        return this.requestBody?.resolve();
+    }
+    /**
+     * The schema of the received payload for `mediaType` (default
+     * `application/json`) — the inbound body shape a handler generator emits a
+     * type for. `undefined` when there is no body or no schema for that media
+     * type.
+     */
+    toPayloadSchema(mediaType = 'application/json') {
+        return this.toPayload()?.content[mediaType]?.schema;
+    }
+    /**
+     * Resolve the inbound parameters (e.g. the signature/headers a handler
+     * receives), optionally filtered by location. Mirrors
+     * {@link OasOperation.toParams}; the parameters carry the same shape, only
+     * their direction is inbound.
+     */
+    toParams(filter) {
+        return (this.parameters
+            ?.map(param => param.resolve())
+            .filter(param => (filter?.length ? filter.includes(param.location) : true)) ?? []);
+    }
+    /**
+     * The status code of the primary acknowledgement response — the lowest 2xx
+     * the handler returns to ack the delivery, falling back to `default`. Named
+     * for the receiver: a webhook's `responses` are what the handler RETURNS,
+     * not what a client receives (cf. {@link OasOperation.toSuccessResponseCode}).
+     */
+    toAckResponseCode() {
+        const ackCode = Object.keys(this.responses)
+            .map(httpCode => parseInt(httpCode))
+            .sort((a, b) => a - b)
+            .find(httpCode => httpCode >= 200 && httpCode < 300);
+        if (ackCode) {
+            return ackCode.toString();
+        }
+        if (this.responses.default) {
+            return 'default';
+        }
+        return undefined;
+    }
+    /**
+     * The primary acknowledgement response definition (the body/headers the
+     * handler returns), or `undefined` when none is declared.
+     */
+    toAckResponse() {
+        const ackCode = this.toAckResponseCode();
+        return ackCode ? this.responses[ackCode] : undefined;
+    }
     /**
      * Serializes the webhook to a plain JavaScript object.
      */