@nymbalhq/contract-tests 1.2.0 → 1.4.0

package/dist/{chunk-ABEL44IM.js → chunk-KK53D2KL.js}

@@ -7,7 +7,6 @@ var CONTRACT_KINDS = [
   "analytics",
   "shipping",
   "tax",
-  "ai",
   "documentStore",
   "eventBus",
   "media"
@@ -16,4 +15,4 @@ var CONTRACT_KINDS = [
 export {
   CONTRACT_KINDS
 };
-//# sourceMappingURL=chunk-ABEL44IM.js.map
+//# sourceMappingURL=chunk-KK53D2KL.js.map

package/dist/{chunk-ABEL44IM.js.map → chunk-KK53D2KL.js.map}

@@ -1 +1 @@
-{"version":3,"sources":["../src/kinds.ts"],"sourcesContent":["import type { Slot } from '@nymbalhq/types'\n\n// Its own entry (`@nymbalhq/contract-tests/kinds`), free of vitest: the CLI reads it in its own process, where\n// importing vitest outside a test run throws.\n\n/** The kinds `contractSuites` has a suite for. */\nexport const CONTRACT_KINDS = [\n  'payments',\n  'email',\n  'reviews',\n  'search',\n  'analytics',\n  'shipping',\n  'tax',\n  'ai',\n  'documentStore',\n  'eventBus',\n  'media',\n] as const satisfies readonly Slot[]\n"],"mappings":";AAMO,IAAM,iBAAiB;AAAA,EAC5B;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACF;","names":[]}
+{"version":3,"sources":["../src/kinds.ts"],"sourcesContent":["import type { Slot } from '@nymbalhq/types'\n\n// Its own entry (`@nymbalhq/contract-tests/kinds`), free of vitest: the CLI reads it in its own process, where\n// importing vitest outside a test run throws.\n\n/** The kinds `contractSuites` has a suite for. */\nexport const CONTRACT_KINDS = [\n  'payments',\n  'email',\n  'reviews',\n  'search',\n  'analytics',\n  'shipping',\n  'tax',\n  'documentStore',\n  'eventBus',\n  'media',\n] as const satisfies readonly Slot[]\n"],"mappings":";AAMO,IAAM,iBAAiB;AAAA,EAC5B;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACF;","names":[]}

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { Slot, AdapterContext, DocumentStoreAdapter, EventBusAdapter, MediaStorage, PaymentsAdapter, EmailAdapter, ReviewsAdapter, SearchAdapter, SearchDocument, AnalyticsAdapter, ShippingAdapter, TaxAdapter, AiAdapter, SecurityAdapter, NymbalEvent } from '@nymbalhq/types';
+import { Slot, AdapterContext, DocumentStoreAdapter, EventBusAdapter, MediaStorage, PaymentsAdapter, EmailAdapter, ReviewsAdapter, SearchAdapter, SearchDocument, AnalyticsAdapter, ShippingAdapter, TaxAdapter, WebhookHeaders, CommerceAdapter, SecurityAdapter, NymbalEvent } from '@nymbalhq/types';
 export { CONTRACT_KINDS } from './kinds.js';
 
 /** How long a health check, or a call on an unreachable dependency, may take to settle. */
@@ -51,10 +51,11 @@ interface EventBusContractOptions extends ContractOptions<EventBusAdapter> {
 type Make = Build<EventBusAdapter>;
 /**
  * The event bus contract every implementation runs. `publish` resolves only after every matching subscription's
- * handler has finished (what a read straight after a command relies on); a throwing handler is logged and does not
- * reject it; `replay` reaches `derived` subscriptions only; each subscription takes its events in order. With `second`,
- * a named subscription is handled once across instances and an unnamed one on every instance. Then the delivery
- * contract's cases, and health (and, given `unreachable`, downtime).
+ * handler has finished (what a read straight after a command relies on); a throwing unnamed handler is logged and does
+ * not reject it, and a throwing named one rejects it with `handler_failed` once the rest have finished; `replay`
+ * reaches `derived` subscriptions only; each subscription takes its events in order. With `second`, a named
+ * subscription is handled once across instances and an unnamed one on every instance. Then the delivery contract's
+ * cases, the handler-failure cases, and health (and, given `unreachable`, downtime).
  */
 declare function runEventBusContract(name: string, make: Make, opts?: EventBusContractOptions): void;
 
@@ -121,7 +122,22 @@ declare function runShippingContract(name: string, build: Build<ShippingAdapter>
 
 declare function runTaxContract(name: string, build: Build<TaxAdapter>, options?: ContractOptions<TaxAdapter>): void;
 
-declare function runAiContract(name: string, build: Build<AiAdapter>, options?: ContractOptions<AiAdapter>): void;
+/** One delivery as the provider sends it: the exact bytes and the headers its signature is in. */
+interface WebhookRequest {
+    rawBody: Buffer;
+    headers: WebhookHeaders;
+}
+interface WebhookContractOptions {
+    /** One signed delivery carrying at least one event, as the provider would send it. */
+    delivery: () => WebhookRequest;
+    /** The same delivery with one byte of its body changed. Given, the suite checks it is not verified. */
+    tampered?: () => WebhookRequest;
+}
+/**
+ * Certifies an adapter's `receiveWebhook`: one delivery received twice is one delivery, a tampered one is refused,
+ * and every event it hands on is the adapter's own type with a plain JSON object payload.
+ */
+declare function runWebhookContract(name: string, build: Build<CommerceAdapter>, options: WebhookContractOptions): void;
 
 declare function runSecurityContract(name: string, build: Build<SecurityAdapter>, options?: ContractOptions<SecurityAdapter>): void;
 
@@ -145,5 +161,5 @@ type ContractSuite = (name: string, build: Build<unknown>, options?: Record<stri
 /** Each kind's suite, one for every kind in CONTRACT_KINDS. Each is typed here, at the CLI's boundary. */
 declare const contractSuites: Partial<Record<ContractKind, ContractSuite>>;
 
-export { BOUND_MS, adapterContext, contractSuites, matchesQuery, runAiContract, runAnalyticsContract, runDocumentStoreContract, runEmailContract, runEventBusContract, runMediaStorageContract, runPaymentsContract, runProjectionContract, runReviewsContract, runSearchContract, runSecurityContract, runShippingContract, runTaxContract, searchTerms, toSearchDocument };
-export type { Build, ContractKind, ContractOptions, ContractProduct, ContractSuite, DocumentStoreContractOptions, EventBusContractOptions, MediaStorageContractOptions, PaymentsContractOptions, ProjectionContractOptions, SearchContractOptions };
+export { BOUND_MS, adapterContext, contractSuites, matchesQuery, runAnalyticsContract, runDocumentStoreContract, runEmailContract, runEventBusContract, runMediaStorageContract, runPaymentsContract, runProjectionContract, runReviewsContract, runSearchContract, runSecurityContract, runShippingContract, runTaxContract, runWebhookContract, searchTerms, toSearchDocument };
+export type { Build, ContractKind, ContractOptions, ContractProduct, ContractSuite, DocumentStoreContractOptions, EventBusContractOptions, MediaStorageContractOptions, PaymentsContractOptions, ProjectionContractOptions, SearchContractOptions, WebhookContractOptions, WebhookRequest };