@adobe/aio-commerce-lib-webhooks 1.2.1 → 1.2.2-alpha-20260914094901

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # @adobe/aio-commerce-lib-webhooks
 
+## 1.2.2-alpha-20260914094901
+
+### Patch Changes
+
+- Updated dependencies [[`1837df1`](https://github.com/adobe/aio-commerce-sdk/commit/1837df107bd2b8d2211f77438a07b6e7ee0af03e)]:
+  - @adobe/aio-commerce-lib-api@1.4.0-alpha-20260914094901
+
 ## 1.2.1
 
 ### Patch Changes

package/dist/cjs/api/index.d.cts

@@ -137,7 +137,7 @@ type CommerceSupportedWebhookManyResponse = CommerceSupportedWebhook[];
  * @param httpClient - The {@link AdobeCommerceHttpClient} to use to make the request.
  * @param fetchOptions - The {@link Options} to use to make the request.
  */
-declare function getWebhookList(httpClient: AdobeCommerceHttpClient, fetchOptions?: Options): Promise<CommerceWebhookManyResponse>;
+export declare function getWebhookList(httpClient: AdobeCommerceHttpClient, fetchOptions?: Options): Promise<CommerceWebhookManyResponse>;
 /**
  * Subscribes a webhook in the Commerce instance.
  * @see https://developer.adobe.com/commerce/extensibility/webhooks/api/#subscribe-a-webhook
@@ -149,7 +149,7 @@ declare function getWebhookList(httpClient: AdobeCommerceHttpClient, fetchOption
  * @throws A {@link CommerceSdkValidationError} If the parameters are in the wrong format.
  * @throws An {@link HTTPError} If the status code is not 2XX.
  */
-declare function subscribeWebhook(httpClient: AdobeCommerceHttpClient, params: WebhookSubscribeParams, fetchOptions?: Options): Promise<void>;
+export declare function subscribeWebhook(httpClient: AdobeCommerceHttpClient, params: WebhookSubscribeParams, fetchOptions?: Options): Promise<void>;
 /**
  * Unsubscribes a webhook from the Commerce instance.
  * @see https://developer.adobe.com/commerce/extensibility/webhooks/api/#unsubscribe-a-webhook
@@ -161,7 +161,7 @@ declare function subscribeWebhook(httpClient: AdobeCommerceHttpClient, params: W
  * @throws A {@link CommerceSdkValidationError} If the parameters are in the wrong format.
  * @throws An {@link HTTPError} If the status code is not 2XX.
  */
-declare function unsubscribeWebhook(httpClient: AdobeCommerceHttpClient, params: WebhookUnsubscribeParams, fetchOptions?: Options): Promise<void>;
+export declare function unsubscribeWebhook(httpClient: AdobeCommerceHttpClient, params: WebhookUnsubscribeParams, fetchOptions?: Options): Promise<void>;
 /**
  * Returns the list of webhooks supported in Adobe Commerce as a Cloud Service (SaaS only).
  * @see https://developer.adobe.com/commerce/extensibility/webhooks/api/#get-supported-webhooks-for-saas
@@ -169,14 +169,14 @@ declare function unsubscribeWebhook(httpClient: AdobeCommerceHttpClient, params:
  * @param httpClient - The {@link AdobeCommerceHttpClient} to use to make the request.
  * @param fetchOptions - The {@link Options} to use to make the request.
  */
-declare function getSupportedWebhookList(httpClient: AdobeCommerceHttpClient, fetchOptions?: Options): Promise<CommerceSupportedWebhookManyResponse>;
+export declare function getSupportedWebhookList(httpClient: AdobeCommerceHttpClient, fetchOptions?: Options): Promise<CommerceSupportedWebhookManyResponse>;
 //#endregion
 //#region source/lib/api-client.d.ts
 /**
  * Creates a new API client for the Commerce Webhooks API.
  * @param params - The parameters to build the Commerce HTTP client.
  */
-declare function createCommerceWebhooksApiClient(params: CommerceHttpClientParams): import("@adobe/aio-commerce-lib-api").ApiClientRecord<AdobeCommerceHttpClient, {
+export declare function createCommerceWebhooksApiClient(params: CommerceHttpClientParams): import("@adobe/aio-commerce-lib-api").ApiClientRecord<AdobeCommerceHttpClient, {
   getSupportedWebhookList: typeof getSupportedWebhookList;
   getWebhookList: typeof getWebhookList;
   subscribeWebhook: typeof subscribeWebhook;
@@ -192,6 +192,6 @@ type CommerceWebhooksApiClient = ReturnType<typeof createCommerceWebhooksApiClie
  * @param params - The parameters to build the Commerce HTTP client.
  * @param functions - The API functions to include in the client.
  */
-declare function createCustomCommerceWebhooksApiClient<TFunctions extends Record<string, ApiFunction<AdobeCommerceHttpClient, any[], any>>>(params: CommerceHttpClientParams, functions: TFunctions): import("@adobe/aio-commerce-lib-api").ApiClientRecord<AdobeCommerceHttpClient, TFunctions>;
+export declare function createCustomCommerceWebhooksApiClient<TFunctions extends Record<string, ApiFunction<AdobeCommerceHttpClient, any[], any>>>(params: CommerceHttpClientParams, functions: TFunctions): import("@adobe/aio-commerce-lib-api").ApiClientRecord<AdobeCommerceHttpClient, TFunctions>;
 //#endregion
-export { type CommerceSupportedWebhook, type CommerceSupportedWebhookManyResponse, type CommerceWebhook, type CommerceWebhookDeveloperConsoleOAuth, type CommerceWebhookField, type CommerceWebhookHeader, type CommerceWebhookManyResponse, type CommerceWebhookRule, type CommerceWebhooksApiClient, type WebhookSubscribeParams, type WebhookUnsubscribeParams, createCommerceWebhooksApiClient, createCustomCommerceWebhooksApiClient, getSupportedWebhookList, getWebhookList, subscribeWebhook, unsubscribeWebhook };
+export type { CommerceSupportedWebhook, CommerceSupportedWebhookManyResponse, CommerceWebhook, CommerceWebhookDeveloperConsoleOAuth, CommerceWebhookField, CommerceWebhookHeader, CommerceWebhookManyResponse, CommerceWebhookRule, CommerceWebhooksApiClient, WebhookSubscribeParams, WebhookUnsubscribeParams };

package/dist/cjs/responses/index.d.cts

@@ -32,7 +32,7 @@ import { HTTP_OK } from "@adobe/aio-commerce-lib-api/utils";
  * span.setStatus(isWebhookSuccessful(result) ? { code: SpanStatusCode.OK } : { code: SpanStatusCode.ERROR });
  * ```
  */
-declare function isWebhookSuccessful(result: unknown): boolean;
+export declare function isWebhookSuccessful(result: unknown): boolean;
 //#endregion
 //#region source/responses/operations/types.d.ts
 /**
@@ -107,7 +107,7 @@ type WebhookOperationResponse<TValue = unknown> = SuccessOperation | ExceptionOp
  * return successOperation();
  * ```
  */
-declare const successOperation: () => SuccessOperation;
+export declare const successOperation: () => SuccessOperation;
 /**
  * Creates an exception operation response with a message
  * Causes Commerce to terminate the process that triggered the original event.
@@ -125,7 +125,7 @@ declare const successOperation: () => SuccessOperation;
  * );
  * ```
  */
-declare const exceptionOperation: (message: string, exceptionClass?: string) => ExceptionOperation;
+export declare const exceptionOperation: (message: string, exceptionClass?: string) => ExceptionOperation;
 /**
  * Creates an add operation response
  * Causes Commerce to add the provided value to the provided path in the triggered event arguments.
@@ -144,7 +144,7 @@ declare const exceptionOperation: (message: string, exceptionClass?: string) =>
  * );
  * ```
  */
-declare const addOperation: <TValue = unknown>(path: string, value: TValue, instance?: string) => AddOperation<TValue>;
+export declare const addOperation: <TValue = unknown>(path: string, value: TValue, instance?: string) => AddOperation<TValue>;
 /**
  * Creates a replace operation response
  * Causes Commerce to replace a value in triggered event arguments for the provided path.
@@ -159,7 +159,7 @@ declare const addOperation: <TValue = unknown>(path: string, value: TValue, inst
  * return replaceOperation("result/shipping_methods/shipping_method_one/amount", 6);
  * ```
  */
-declare const replaceOperation: <TValue = unknown>(path: string, value: TValue, instance?: string) => ReplaceOperation<TValue>;
+export declare const replaceOperation: <TValue = unknown>(path: string, value: TValue, instance?: string) => ReplaceOperation<TValue>;
 /**
  * Creates a remove operation response
  * Causes Commerce to remove a value or node in triggered event arguments by the provided path.
@@ -171,7 +171,7 @@ declare const replaceOperation: <TValue = unknown>(path: string, value: TValue,
  * return removeOperation("result/key2");
  * ```
  */
-declare const removeOperation: (path: string) => RemoveOperation;
+export declare const removeOperation: (path: string) => RemoveOperation;
 //#endregion
 //#region source/responses/presets.d.ts
 /**
@@ -199,7 +199,7 @@ declare const removeOperation: (path: string) => RemoveOperation;
  * ]);
  * ```
  */
-declare function ok<TValue = unknown>(operations: WebhookOperationResponse<TValue> | WebhookOperationResponse[]): SuccessResponse;
+export declare function ok<TValue = unknown>(operations: WebhookOperationResponse<TValue> | WebhookOperationResponse[]): SuccessResponse;
 //#endregion
 //#region source/responses/types.d.ts
 /**
@@ -215,6 +215,6 @@ type WebhookSuccessResponse = Omit<SuccessResponse, "body" | "statusCode"> & {
  * @param response - Value to inspect.
  * @returns True when the value matches the webhook success response shape.
  */
-declare function isWebhookSuccessResponse(response: unknown): response is WebhookSuccessResponse;
+export declare function isWebhookSuccessResponse(response: unknown): response is WebhookSuccessResponse;
 //#endregion
-export { type AddOperation, type ExceptionOperation, type RemoveOperation, type ReplaceOperation, type SuccessOperation, type WebhookOperationResponse, type WebhookSuccessResponse, addOperation, exceptionOperation, isWebhookSuccessResponse, isWebhookSuccessful, ok, removeOperation, replaceOperation, successOperation };
+export type { AddOperation, ExceptionOperation, RemoveOperation, ReplaceOperation, SuccessOperation, WebhookOperationResponse, WebhookSuccessResponse };

package/dist/es/api/index.d.mts

@@ -137,7 +137,7 @@ type CommerceSupportedWebhookManyResponse = CommerceSupportedWebhook[];
  * @param httpClient - The {@link AdobeCommerceHttpClient} to use to make the request.
  * @param fetchOptions - The {@link Options} to use to make the request.
  */
-declare function getWebhookList(httpClient: AdobeCommerceHttpClient, fetchOptions?: Options): Promise<CommerceWebhookManyResponse>;
+export declare function getWebhookList(httpClient: AdobeCommerceHttpClient, fetchOptions?: Options): Promise<CommerceWebhookManyResponse>;
 /**
  * Subscribes a webhook in the Commerce instance.
  * @see https://developer.adobe.com/commerce/extensibility/webhooks/api/#subscribe-a-webhook
@@ -149,7 +149,7 @@ declare function getWebhookList(httpClient: AdobeCommerceHttpClient, fetchOption
  * @throws A {@link CommerceSdkValidationError} If the parameters are in the wrong format.
  * @throws An {@link HTTPError} If the status code is not 2XX.
  */
-declare function subscribeWebhook(httpClient: AdobeCommerceHttpClient, params: WebhookSubscribeParams, fetchOptions?: Options): Promise<void>;
+export declare function subscribeWebhook(httpClient: AdobeCommerceHttpClient, params: WebhookSubscribeParams, fetchOptions?: Options): Promise<void>;
 /**
  * Unsubscribes a webhook from the Commerce instance.
  * @see https://developer.adobe.com/commerce/extensibility/webhooks/api/#unsubscribe-a-webhook
@@ -161,7 +161,7 @@ declare function subscribeWebhook(httpClient: AdobeCommerceHttpClient, params: W
  * @throws A {@link CommerceSdkValidationError} If the parameters are in the wrong format.
  * @throws An {@link HTTPError} If the status code is not 2XX.
  */
-declare function unsubscribeWebhook(httpClient: AdobeCommerceHttpClient, params: WebhookUnsubscribeParams, fetchOptions?: Options): Promise<void>;
+export declare function unsubscribeWebhook(httpClient: AdobeCommerceHttpClient, params: WebhookUnsubscribeParams, fetchOptions?: Options): Promise<void>;
 /**
  * Returns the list of webhooks supported in Adobe Commerce as a Cloud Service (SaaS only).
  * @see https://developer.adobe.com/commerce/extensibility/webhooks/api/#get-supported-webhooks-for-saas
@@ -169,14 +169,14 @@ declare function unsubscribeWebhook(httpClient: AdobeCommerceHttpClient, params:
  * @param httpClient - The {@link AdobeCommerceHttpClient} to use to make the request.
  * @param fetchOptions - The {@link Options} to use to make the request.
  */
-declare function getSupportedWebhookList(httpClient: AdobeCommerceHttpClient, fetchOptions?: Options): Promise<CommerceSupportedWebhookManyResponse>;
+export declare function getSupportedWebhookList(httpClient: AdobeCommerceHttpClient, fetchOptions?: Options): Promise<CommerceSupportedWebhookManyResponse>;
 //#endregion
 //#region source/lib/api-client.d.ts
 /**
  * Creates a new API client for the Commerce Webhooks API.
  * @param params - The parameters to build the Commerce HTTP client.
  */
-declare function createCommerceWebhooksApiClient(params: CommerceHttpClientParams): import("@adobe/aio-commerce-lib-api").ApiClientRecord<AdobeCommerceHttpClient, {
+export declare function createCommerceWebhooksApiClient(params: CommerceHttpClientParams): import("@adobe/aio-commerce-lib-api").ApiClientRecord<AdobeCommerceHttpClient, {
   getSupportedWebhookList: typeof getSupportedWebhookList;
   getWebhookList: typeof getWebhookList;
   subscribeWebhook: typeof subscribeWebhook;
@@ -192,6 +192,6 @@ type CommerceWebhooksApiClient = ReturnType<typeof createCommerceWebhooksApiClie
  * @param params - The parameters to build the Commerce HTTP client.
  * @param functions - The API functions to include in the client.
  */
-declare function createCustomCommerceWebhooksApiClient<TFunctions extends Record<string, ApiFunction<AdobeCommerceHttpClient, any[], any>>>(params: CommerceHttpClientParams, functions: TFunctions): import("@adobe/aio-commerce-lib-api").ApiClientRecord<AdobeCommerceHttpClient, TFunctions>;
+export declare function createCustomCommerceWebhooksApiClient<TFunctions extends Record<string, ApiFunction<AdobeCommerceHttpClient, any[], any>>>(params: CommerceHttpClientParams, functions: TFunctions): import("@adobe/aio-commerce-lib-api").ApiClientRecord<AdobeCommerceHttpClient, TFunctions>;
 //#endregion
-export { type CommerceSupportedWebhook, type CommerceSupportedWebhookManyResponse, type CommerceWebhook, type CommerceWebhookDeveloperConsoleOAuth, type CommerceWebhookField, type CommerceWebhookHeader, type CommerceWebhookManyResponse, type CommerceWebhookRule, type CommerceWebhooksApiClient, type WebhookSubscribeParams, type WebhookUnsubscribeParams, createCommerceWebhooksApiClient, createCustomCommerceWebhooksApiClient, getSupportedWebhookList, getWebhookList, subscribeWebhook, unsubscribeWebhook };
+export type { CommerceSupportedWebhook, CommerceSupportedWebhookManyResponse, CommerceWebhook, CommerceWebhookDeveloperConsoleOAuth, CommerceWebhookField, CommerceWebhookHeader, CommerceWebhookManyResponse, CommerceWebhookRule, CommerceWebhooksApiClient, WebhookSubscribeParams, WebhookUnsubscribeParams };

package/dist/es/responses/index.d.mts

@@ -32,7 +32,7 @@ import { SuccessResponse } from "@adobe/aio-commerce-lib-core/responses";
  * span.setStatus(isWebhookSuccessful(result) ? { code: SpanStatusCode.OK } : { code: SpanStatusCode.ERROR });
  * ```
  */
-declare function isWebhookSuccessful(result: unknown): boolean;
+export declare function isWebhookSuccessful(result: unknown): boolean;
 //#endregion
 //#region source/responses/operations/types.d.ts
 /**
@@ -107,7 +107,7 @@ type WebhookOperationResponse<TValue = unknown> = SuccessOperation | ExceptionOp
  * return successOperation();
  * ```
  */
-declare const successOperation: () => SuccessOperation;
+export declare const successOperation: () => SuccessOperation;
 /**
  * Creates an exception operation response with a message
  * Causes Commerce to terminate the process that triggered the original event.
@@ -125,7 +125,7 @@ declare const successOperation: () => SuccessOperation;
  * );
  * ```
  */
-declare const exceptionOperation: (message: string, exceptionClass?: string) => ExceptionOperation;
+export declare const exceptionOperation: (message: string, exceptionClass?: string) => ExceptionOperation;
 /**
  * Creates an add operation response
  * Causes Commerce to add the provided value to the provided path in the triggered event arguments.
@@ -144,7 +144,7 @@ declare const exceptionOperation: (message: string, exceptionClass?: string) =>
  * );
  * ```
  */
-declare const addOperation: <TValue = unknown>(path: string, value: TValue, instance?: string) => AddOperation<TValue>;
+export declare const addOperation: <TValue = unknown>(path: string, value: TValue, instance?: string) => AddOperation<TValue>;
 /**
  * Creates a replace operation response
  * Causes Commerce to replace a value in triggered event arguments for the provided path.
@@ -159,7 +159,7 @@ declare const addOperation: <TValue = unknown>(path: string, value: TValue, inst
  * return replaceOperation("result/shipping_methods/shipping_method_one/amount", 6);
  * ```
  */
-declare const replaceOperation: <TValue = unknown>(path: string, value: TValue, instance?: string) => ReplaceOperation<TValue>;
+export declare const replaceOperation: <TValue = unknown>(path: string, value: TValue, instance?: string) => ReplaceOperation<TValue>;
 /**
  * Creates a remove operation response
  * Causes Commerce to remove a value or node in triggered event arguments by the provided path.
@@ -171,7 +171,7 @@ declare const replaceOperation: <TValue = unknown>(path: string, value: TValue,
  * return removeOperation("result/key2");
  * ```
  */
-declare const removeOperation: (path: string) => RemoveOperation;
+export declare const removeOperation: (path: string) => RemoveOperation;
 //#endregion
 //#region source/responses/presets.d.ts
 /**
@@ -199,7 +199,7 @@ declare const removeOperation: (path: string) => RemoveOperation;
  * ]);
  * ```
  */
-declare function ok<TValue = unknown>(operations: WebhookOperationResponse<TValue> | WebhookOperationResponse[]): SuccessResponse;
+export declare function ok<TValue = unknown>(operations: WebhookOperationResponse<TValue> | WebhookOperationResponse[]): SuccessResponse;
 //#endregion
 //#region source/responses/types.d.ts
 /**
@@ -215,6 +215,6 @@ type WebhookSuccessResponse = Omit<SuccessResponse, "body" | "statusCode"> & {
  * @param response - Value to inspect.
  * @returns True when the value matches the webhook success response shape.
  */
-declare function isWebhookSuccessResponse(response: unknown): response is WebhookSuccessResponse;
+export declare function isWebhookSuccessResponse(response: unknown): response is WebhookSuccessResponse;
 //#endregion
-export { type AddOperation, type ExceptionOperation, type RemoveOperation, type ReplaceOperation, type SuccessOperation, type WebhookOperationResponse, type WebhookSuccessResponse, addOperation, exceptionOperation, isWebhookSuccessResponse, isWebhookSuccessful, ok, removeOperation, replaceOperation, successOperation };
+export type { AddOperation, ExceptionOperation, RemoveOperation, ReplaceOperation, SuccessOperation, WebhookOperationResponse, WebhookSuccessResponse };

package/package.json

@@ -1,13 +1,7 @@
 {
   "name": "@adobe/aio-commerce-lib-webhooks",
-  "type": "module",
-  "author": "Adobe Inc.",
-  "version": "1.2.1",
+  "version": "1.2.2-alpha-20260914094901",
   "private": false,
-  "engines": {
-    "node": ">=22 <=24"
-  },
-  "license": "Apache-2.0",
   "description": "A library to interact with the Adobe Commerce Webhooks API",
   "keywords": [
     "aio",
@@ -24,9 +18,13 @@
     "url": "git+https://github.com/adobe/aio-commerce-sdk.git",
     "directory": "packages/aio-commerce-lib-webhooks"
   },
-  "publishConfig": {
-    "registry": "https://registry.npmjs.org",
-    "access": "public"
+  "license": "Apache-2.0",
+  "author": "Adobe Inc.",
+  "sideEffects": false,
+  "type": "module",
+  "imports": {
+    "#*": "./source/*.ts",
+    "#test/*": "./test/*.ts"
   },
   "exports": {
     "./api": {
@@ -51,10 +49,6 @@
     },
     "./package.json": "./package.json"
   },
-  "imports": {
-    "#*": "./source/*.ts",
-    "#test/*": "./test/*.ts"
-  },
   "files": [
     "dist",
     "package.json",
@@ -62,38 +56,44 @@
     "README.md"
   ],
   "dependencies": {
+    "@adobe/aio-commerce-lib-api": "1.4.0-alpha-20260914094901",
+    "@adobe/aio-commerce-lib-core": "1.2.0",
     "ky": "^1.9.0",
-    "valibot": "^1.1.0",
-    "@adobe/aio-commerce-lib-api": "1.3.1",
-    "@adobe/aio-commerce-lib-core": "1.2.0"
+    "valibot": "^1.1.0"
   },
   "devDependencies": {
-    "typescript": "^6.0.0",
-    "msw": "^2.11.1",
     "@aio-commerce-sdk/config-tsdown": "1.0.1",
     "@aio-commerce-sdk/config-typescript": "1.0.0",
     "@aio-commerce-sdk/config-vitest": "1.0.0",
     "@aio-commerce-sdk/scripting-utils": "0.3.5",
-    "@aio-commerce-sdk/scripts": "0.1.1"
+    "@aio-commerce-sdk/scripts": "0.1.1",
+    "msw": "^2.11.1",
+    "typescript": "^6.0.0"
+  },
+  "engines": {
+    "node": ">=22 <=24"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org"
   },
-  "sideEffects": false,
   "scripts": {
-    "build": "tsdown",
-    "pack": "pnpm pack",
-    "publint": "publint",
-    "docs": "typedoc && prettier --write '**/*.md'",
     "assist": "biome check --formatter-enabled=false --linter-enabled=false --assist-enabled=true --no-errors-on-unmatched",
     "assist:apply": "biome check --write --formatter-enabled=false --linter-enabled=false --assist-enabled=true --no-errors-on-unmatched",
+    "build": "tsdown",
     "check:ci": "biome ci --formatter-enabled=true --linter-enabled=true --assist-enabled=true --no-errors-on-unmatched",
     "code:fix": "pnpm run lint:fix && pnpm run assist:apply && pnpm run format && pnpm run format:markdown",
+    "docs": "typedoc && prettier --write '**/*.md'",
     "format": "biome format --write --no-errors-on-unmatched",
-    "format:markdown": "prettier --no-error-on-unmatched-pattern --write '**/*.md' \"!**/{CODE_OF_CONDUCT.md,COPYRIGHT,LICENSE,SECURITY.md,CONTRIBUTING.md}\"",
     "format:check": "biome format --no-errors-on-unmatched",
+    "format:markdown": "prettier --no-error-on-unmatched-pattern --write '**/*.md' \"!**/{CODE_OF_CONDUCT.md,COPYRIGHT,LICENSE,SECURITY.md,CONTRIBUTING.md}\"",
     "lint": "biome lint --no-errors-on-unmatched",
     "lint:fix": "biome lint --write --no-errors-on-unmatched",
-    "typecheck": "tsc --noEmit && echo '✅ No type errors found.'",
+    "pack": "pnpm pack",
+    "publint": "publint",
     "test": "vitest run --coverage",
     "test:ui": "vitest --ui --coverage",
-    "test:watch": "vitest --watch --coverage"
+    "test:watch": "vitest --watch --coverage",
+    "typecheck": "tsc --noEmit && echo '✅ No type errors found.'"
   }
 }