@adobe/aio-commerce-lib-events 0.1.0

package/dist/cjs/ky-Rubdb7BL.cjs

@@ -0,0 +1,14 @@
+/**
+* @license
+* 
+* Copyright 2025 Adobe. All rights reserved.
+* This file is licensed to you under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License. You may obtain a copy
+* of the License at http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software distributed under
+* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+* OF ANY KIND, either express or implied. See the License for the specific language
+* governing permissions and limitations under the License.
+*/
+var __create=Object.create,__defProp=Object.defineProperty,__getOwnPropDesc=Object.getOwnPropertyDescriptor,__getOwnPropNames=Object.getOwnPropertyNames,__getProtoOf=Object.getPrototypeOf,__hasOwnProp=Object.prototype.hasOwnProperty,__export=(target,all)=>{for(var name in all)__defProp(target,name,{get:all[name],enumerable:!0})},__copyProps=(to,from,except,desc)=>{if(from&&typeof from==`object`||typeof from==`function`)for(var keys=__getOwnPropNames(from),i=0,n=keys.length,key;i<n;i++)key=keys[i],!__hasOwnProp.call(to,key)&&key!==except&&__defProp(to,key,{get:(k=>from[k]).bind(null,key),enumerable:!(desc=__getOwnPropDesc(from,key))||desc.enumerable});return to},__toESM=(mod,isNodeMode,target)=>(target=mod==null?{}:__create(__getProtoOf(mod)),__copyProps(isNodeMode||!mod||!mod.__esModule?__defProp(target,`default`,{value:mod,enumerable:!0}):target,mod));const __adobe_aio_commerce_lib_core_error=__toESM(require(`@adobe/aio-commerce-lib-core/error`)),valibot=__toESM(require(`valibot`)),__adobe_aio_commerce_lib_auth=__toESM(require(`@adobe/aio-commerce-lib-auth`)),UPPERCASE=/[\p{Lu}]/u,LOWERCASE=/[\p{Ll}]/u,LEADING_CAPITAL=/^[\p{Lu}](?![\p{Lu}])/gu,IDENTIFIER=/([\p{Alpha}\p{N}_]|$)/u,SEPARATORS=/[_.\- ]+/,LEADING_SEPARATORS=RegExp(`^`+SEPARATORS.source),SEPARATORS_AND_IDENTIFIER=new RegExp(SEPARATORS.source+IDENTIFIER.source,`gu`),NUMBERS_AND_IDENTIFIER=RegExp(`\\d+`+IDENTIFIER.source,`gu`),preserveCamelCase=(string,toLowerCase,toUpperCase,preserveConsecutiveUppercase$1)=>{let isLastCharLower=!1,isLastCharUpper=!1,isLastLastCharUpper=!1,isLastLastCharPreserved=!1;for(let index=0;index<string.length;index++){let character=string[index];isLastLastCharPreserved=index>2?string[index-3]===`-`:!0,isLastCharLower&&UPPERCASE.test(character)?(string=string.slice(0,index)+`-`+string.slice(index),isLastCharLower=!1,isLastLastCharUpper=isLastCharUpper,isLastCharUpper=!0,index++):isLastCharUpper&&isLastLastCharUpper&&LOWERCASE.test(character)&&(!isLastLastCharPreserved||preserveConsecutiveUppercase$1)?(string=string.slice(0,index-1)+`-`+string.slice(index-1),isLastLastCharUpper=isLastCharUpper,isLastCharUpper=!1,isLastCharLower=!0):(isLastCharLower=toLowerCase(character)===character&&toUpperCase(character)!==character,isLastLastCharUpper=isLastCharUpper,isLastCharUpper=toUpperCase(character)===character&&toLowerCase(character)!==character)}return string},preserveConsecutiveUppercase=(input,toLowerCase)=>(LEADING_CAPITAL.lastIndex=0,input.replaceAll(LEADING_CAPITAL,match=>toLowerCase(match))),postProcess=(input,toUpperCase)=>(SEPARATORS_AND_IDENTIFIER.lastIndex=0,NUMBERS_AND_IDENTIFIER.lastIndex=0,input.replaceAll(NUMBERS_AND_IDENTIFIER,(match,pattern,offset)=>[`_`,`-`].includes(input.charAt(offset+match.length))?match:toUpperCase(match)).replaceAll(SEPARATORS_AND_IDENTIFIER,(_,identifier)=>toUpperCase(identifier)));function camelCase(input,options){if(!(typeof input==`string`||Array.isArray(input)))throw TypeError("Expected the input to be `string | string[]`");if(options={pascalCase:!1,preserveConsecutiveUppercase:!1,...options},input=Array.isArray(input)?input.map(x=>x.trim()).filter(x=>x.length).join(`-`):input.trim(),input.length===0)return``;let toLowerCase=options.locale===!1?string=>string.toLowerCase():string=>string.toLocaleLowerCase(options.locale),toUpperCase=options.locale===!1?string=>string.toUpperCase():string=>string.toLocaleUpperCase(options.locale);if(input.length===1)return SEPARATORS.test(input)?``:options.pascalCase?toUpperCase(input):toLowerCase(input);let hasUpperCase=input!==toLowerCase(input);return hasUpperCase&&(input=preserveCamelCase(input,toLowerCase,toUpperCase,options.preserveConsecutiveUppercase)),input=input.replace(LEADING_SEPARATORS,``),input=options.preserveConsecutiveUppercase?preserveConsecutiveUppercase(input,toLowerCase):toLowerCase(input),options.pascalCase&&(input=toUpperCase(input.charAt(0))+input.slice(1)),postProcess(input,toUpperCase)}function buildObjectKeyTransformerResponseHook(transformer,recursive=!0){let transformObject=obj=>{if(typeof obj!=`object`||!obj)return obj;if(Array.isArray(obj))return recursive?obj.map(transformObject):obj;let transformedData=Object.fromEntries(Object.entries(obj).map(([key,value])=>{let transformedKey=transformer(key),transformedValue=recursive?transformObject(value):value;return[transformedKey,transformedValue]}));return transformedData};return(_req,_opt,response)=>response.json().then(data=>{let transformedData=transformObject(data);return new Response(JSON.stringify(transformedData),response)})}function buildCamelCaseKeysResponseHook(){return buildObjectKeyTransformerResponseHook(camelCase)}function parseOrThrow(schema,input){let result=valibot.safeParse(schema,input);if(!result.success)throw new __adobe_aio_commerce_lib_core_error.CommerceSdkValidationError(`Invalid input`,{issues:result.issues});return result.output}const ALPHANUMERIC_OR_UNDERSCORE_REGEX=/^[a-zA-Z0-9_]+$/,ALPHANUMERIC_OR_UNDERSCORE_OR_HYPHEN_REGEX=/^[a-zA-Z0-9_-]+$/;function stringValueSchema(propertyName){return valibot.string(`Expected a string value for property '${propertyName}'`)}function booleanValueSchema(propertyName){return valibot.boolean(`Expected a boolean value for property '${propertyName}'`)}function alphaNumericOrUnderscoreSchema(name){return valibot.pipe(stringValueSchema(name),valibot.regex(ALPHANUMERIC_OR_UNDERSCORE_REGEX,`Only alphanumeric characters and underscores are allowed for "${name}"`))}function alphaNumericOrUnderscoreOrHyphenSchema(name){return valibot.pipe(stringValueSchema(name),valibot.regex(ALPHANUMERIC_OR_UNDERSCORE_OR_HYPHEN_REGEX,`Only alphanumeric characters, underscores, and hyphens are allowed for property "${name}"`))}var ApiClient=class{static create(client,functions){let wrapped={};for(let key in functions)if(Object.hasOwn(functions,key)){let fn=functions[key];wrapped[key]=((...args)=>fn(client,...args))}return wrapped}},HttpClientBase=class HttpClientBase{#httpClient;constructor(config,httpClient){this.#httpClient=Object.freeze(httpClient),this.config=Object.freeze(config),this.get=this.#httpClient.get.bind(this.#httpClient),this.post=this.#httpClient.post.bind(this.#httpClient),this.put=this.#httpClient.put.bind(this.#httpClient),this.delete=this.#httpClient.delete.bind(this.#httpClient),this.patch=this.#httpClient.patch.bind(this.#httpClient),this.head=this.#httpClient.head.bind(this.#httpClient),this.stop=this.#httpClient.stop}extend(options){let client=Object.freeze(this.#httpClient.extend(options));return new HttpClientBase(this.config,client)}};function isAuthProvider(auth){return`getHeaders`in auth}function buildIntegrationAuthBeforeRequestHook(integrationAuth){let integrationAuthProvider=isAuthProvider(integrationAuth)?integrationAuth:(0,__adobe_aio_commerce_lib_auth.getIntegrationAuthProvider)(integrationAuth);return request=>{let headers=integrationAuthProvider.getHeaders(request.method.toUpperCase(),request.url);request.headers.set(`Authorization`,headers.Authorization)}}function buildImsAuthBeforeRequestHook(imsAuth){let imsAuthProvider=isAuthProvider(imsAuth)?imsAuth:(0,__adobe_aio_commerce_lib_auth.getImsAuthProvider)(imsAuth);return async request=>{let headers=await imsAuthProvider.getHeaders();request.headers.set(`Authorization`,headers.Authorization),request.headers.set(`x-api-key`,headers[`x-api-key`])}}function ensureImsScopes(imsAuth,requiredScopes){let scopes=new Set([...imsAuth.scopes??[],...requiredScopes]);return{...imsAuth,scopes:Array.from(scopes)}}function optionallyExtendKy(ky,options){return options?ky.extend(options):ky}Object.defineProperty(exports,`b`,{enumerable:!0,get:function(){return optionallyExtendKy}}),Object.defineProperty(exports,`c`,{enumerable:!0,get:function(){return ensureImsScopes}}),Object.defineProperty(exports,`d`,{enumerable:!0,get:function(){return buildImsAuthBeforeRequestHook}}),Object.defineProperty(exports,`e`,{enumerable:!0,get:function(){return buildIntegrationAuthBeforeRequestHook}}),Object.defineProperty(exports,`f`,{enumerable:!0,get:function(){return isAuthProvider}}),Object.defineProperty(exports,`g`,{enumerable:!0,get:function(){return HttpClientBase}}),Object.defineProperty(exports,`h`,{enumerable:!0,get:function(){return ApiClient}}),Object.defineProperty(exports,`i`,{enumerable:!0,get:function(){return alphaNumericOrUnderscoreOrHyphenSchema}}),Object.defineProperty(exports,`j`,{enumerable:!0,get:function(){return alphaNumericOrUnderscoreSchema}}),Object.defineProperty(exports,`k`,{enumerable:!0,get:function(){return booleanValueSchema}}),Object.defineProperty(exports,`l`,{enumerable:!0,get:function(){return stringValueSchema}}),Object.defineProperty(exports,`m`,{enumerable:!0,get:function(){return parseOrThrow}}),Object.defineProperty(exports,`n`,{enumerable:!0,get:function(){return buildCamelCaseKeysResponseHook}}),Object.defineProperty(exports,`o`,{enumerable:!0,get:function(){return __export}}),Object.defineProperty(exports,`p`,{enumerable:!0,get:function(){return __toESM}});

package/dist/es/commerce/index.d.ts

@@ -0,0 +1,316 @@
+/**
+ * @license
+ * 
+ * Copyright 2025 Adobe. All rights reserved.
+ * This file is licensed to you under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License. You may obtain a copy
+ * of the License at http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under
+ * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+ * OF ANY KIND, either express or implied. See the License for the specific language
+ * governing permissions and limitations under the License.
+ */
+
+import * as v from "valibot";
+import * as ky0 from "ky";
+import { Options } from "ky";
+import { CamelCasedPropertiesDeep } from "type-fest";
+
+//#region source/commerce/api/event-providers/schema.d.ts
+declare const EventProviderGetByIdParamsSchema: v.ObjectSchema<{
+  readonly providerId: v.StringSchema<`Expected a string value for property '${string}'`>;
+}, undefined>;
+declare const EventProviderCreateParamsSchema: v.ObjectSchema<{
+  readonly providerId: v.StringSchema<`Expected a string value for property '${string}'`>;
+  readonly instanceId: v.StringSchema<`Expected a string value for property '${string}'`>;
+  readonly label: v.OptionalSchema<v.StringSchema<`Expected a string value for property '${string}'`>, undefined>;
+  readonly description: v.OptionalSchema<v.StringSchema<`Expected a string value for property '${string}'`>, undefined>;
+  readonly associatedWorkspaceConfiguration: v.OptionalSchema<v.UnionSchema<[v.SchemaWithPipe<readonly [v.StringSchema<`Expected a string value for property '${string}'`>, v.EmptyAction<string, undefined>]>, v.SchemaWithPipe<readonly [v.StringSchema<`Expected a string value for property '${string}'`>, v.ParseJsonAction<string, undefined, `Expected valid JSON string for property '${string}'`>, v.RecordSchema<v.StringSchema<undefined>, v.UnknownSchema, undefined>, v.StringifyJsonAction<{
+    [x: string]: unknown;
+  }, undefined, undefined>]>, v.SchemaWithPipe<readonly [v.RecordSchema<v.StringSchema<undefined>, v.UnknownSchema, undefined>, v.StringifyJsonAction<{
+    [x: string]: unknown;
+  }, undefined, `Expected valid JSON data for property '${string}'`>]>], undefined>, undefined>;
+}, undefined>;
+/**
+ * The schema of the parameters received by the GET `eventing/eventProvider/:id` Commerce API endpoint.
+ * @see https://developer.adobe.com/commerce/extensibility/events/api/#get-event-provider-by-id
+ */
+type EventProviderGetByIdParams = v.InferInput<typeof EventProviderGetByIdParamsSchema>;
+/**
+ * The schema of the parameters received by the POST `eventing/eventProvider` Commerce API endpoint.
+ * @see https://developer.adobe.com/commerce/extensibility/events/api/#create-an-event-provider
+ */
+type EventProviderCreateParams = v.InferInput<typeof EventProviderCreateParamsSchema>;
+//#endregion
+//#region source/commerce/api/event-providers/types.d.ts
+/** Defines the structure of a Commerce event provider. */
+type CommerceEventProvider = {
+  id: string;
+  provider_id: string;
+  instance_id?: string;
+  label?: string;
+  description?: string;
+  workspace_configuration?: string;
+};
+/** Defines the fields of an event provider entity returned by the Commerce API. */
+type CommerceEventProviderOneResponse = CamelCasedPropertiesDeep<CommerceEventProvider>;
+/** Defines the fields of many event provider entities returned by the Commerce API. */
+type CommerceEventProviderManyResponse = CommerceEventProviderOneResponse[];
+//#endregion
+//#region source/commerce/api/event-providers/endpoints.d.ts
+/**
+ * Lists all event providers of the Commerce instance bound to the given {@link AdobeCommerceHttpClient}.
+ * @see https://developer.adobe.com/commerce/extensibility/events/api/#get-list-of-all-event-providers
+ *
+ * @param httpClient - The {@link AdobeCommerceHttpClient} to use to make the request.
+ * @param params - The parameters to list the event providers with.
+ * @param fetchOptions - The {@link Options} to use to make the request.
+ *
+ * @throws An {@link HTTPError} If the status code is not 2XX.
+ */
+declare function getAllEventProviders(httpClient: AdobeCommerceHttpClient$3, fetchOptions?: Options): Promise<CommerceEventProviderManyResponse>;
+/**
+ * Gets the info of the event provider with the given ID of the Commerce instance bound to the given {@link AdobeCommerceHttpClient}.
+ * @see https://developer.adobe.com/commerce/extensibility/events/api/#get-event-provider-by-id
+ *
+ * @param httpClient - The {@link AdobeCommerceHttpClient} to use to make the request.
+ * @param params - The parameters to get the event provider by.
+ * @param fetchOptions - The {@link Options} to use to make the request.
+ *
+ * @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 getEventProviderById(httpClient: AdobeCommerceHttpClient$3, params: EventProviderGetByIdParams, fetchOptions?: Options): Promise<{
+  id: string;
+  providerId: string;
+  instanceId?: string | undefined;
+  label?: string | undefined;
+  description?: string | undefined;
+  workspaceConfiguration?: string | undefined;
+}>;
+/**
+ * Creates an event provider in the Commerce instance bound to the given {@link AdobeCommerceHttpClient}.
+ * @see https://developer.adobe.com/commerce/extensibility/events/api/#create-an-event-provider
+ *
+ * @param httpClient - The {@link AdobeCommerceHttpClient} to use to make the request.
+ * @param params - The parameters to create the event provider with.
+ * @param fetchOptions - The {@link Options} to use to make the request.
+ *
+ * @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 createEventProvider(httpClient: AdobeCommerceHttpClient$3, params: EventProviderCreateParams, fetchOptions?: Options): Promise<{
+  id: string;
+  providerId: string;
+  instanceId?: string | undefined;
+  label?: string | undefined;
+  description?: string | undefined;
+  workspaceConfiguration?: string | undefined;
+}>;
+//#endregion
+//#region source/commerce/api/event-subscriptions/schema.d.ts
+declare const EventSubscriptionCreateParamsSchema: v.ObjectSchema<{
+  readonly name: v.StringSchema<`Expected a string value for property '${string}'`>;
+  readonly providerId: v.OptionalSchema<v.StringSchema<`Expected a string value for property '${string}'`>, undefined>;
+  readonly parent: v.OptionalSchema<v.StringSchema<`Expected a string value for property '${string}'`>, undefined>;
+  readonly fields: v.ArraySchema<v.ObjectSchema<{
+    readonly name: v.StringSchema<`Expected a string value for property '${string}'`>;
+  }, undefined>, `Expected an array of objects with a 'name' property for the property "${string}"`>;
+  readonly destination: v.OptionalSchema<v.StringSchema<`Expected a string value for property '${string}'`>, undefined>;
+  readonly hipaaAuditRequired: v.OptionalSchema<v.BooleanSchema<`Expected a boolean value for property '${string}'`>, undefined>;
+  readonly prioritary: v.OptionalSchema<v.BooleanSchema<`Expected a boolean value for property '${string}'`>, undefined>;
+  readonly force: v.OptionalSchema<v.BooleanSchema<`Expected a boolean value for property '${string}'`>, undefined>;
+}, undefined>;
+/**
+ * The schema of the parameters received by the POST `eventing/eventSubscribe` Commerce API endpoint.
+ * @see https://developer.adobe.com/commerce/extensibility/events/api/#subscribe-to-events
+ */
+type EventSubscriptionCreateParams = v.InferInput<typeof EventSubscriptionCreateParamsSchema>;
+//#endregion
+//#region source/commerce/api/event-subscriptions/types.d.ts
+/** Defines the structure of a field in a Commerce event subscription. */
+type CommerceEventSubscriptionField = {
+  name: string;
+  converter?: string;
+};
+/** Defines the structure of a filtering rule in a Commerce event subscription. */
+type CommerceEventSubscriptionRule = {
+  field: string;
+  value: string;
+  operator: string;
+};
+/** Defines the structure of a Commerce event subscription. */
+type CommerceEventSubscription = {
+  name: string;
+  parent: string;
+  provider_id: "default" | string;
+  fields: CommerceEventSubscriptionField[];
+  rules: CommerceEventSubscriptionRule[];
+  destination: "default" | string;
+  priority: boolean;
+  hipaa_audit_required: boolean;
+};
+/** Defines the fields of an event subscription entity returned by the Commerce API. */
+type CommerceEventSubscriptionOneResponse = CamelCasedPropertiesDeep<CommerceEventSubscription>;
+/** Defines the fields of many event subscription entities returned by the Commerce API. */
+type CommerceEventSubscriptionManyResponse = CommerceEventSubscriptionOneResponse[];
+//#endregion
+//#region source/commerce/api/event-subscriptions/endpoints.d.ts
+/**
+ * Gets all event subscriptions in the Commerce instance bound to the given {@link AdobeCommerceHttpClient}.
+ * @see https://developer.adobe.com/commerce/extensibility/events/api/#get-a-list-of-all-subscribed-events
+ *
+ * @param httpClient - The {@link AdobeCommerceHttpClient} to use to make the request.
+ * @param fetchOptions - The {@link Options} to use to make the request.
+ */
+declare function getAllEventSubscriptions(httpClient: AdobeCommerceHttpClient$2, fetchOptions?: Options): Promise<CommerceEventSubscriptionManyResponse>;
+/**
+ * Creates an event subscription in the Commerce instance bound to the given {@link AdobeCommerceHttpClient}.
+ * @see https://developer.adobe.com/commerce/extensibility/events/api/#subscribe-to-events
+ *
+ * @param httpClient - The {@link AdobeCommerceHttpClient} to use to make the request.
+ * @param params - The parameters to create the event subscription with.
+ * @param fetchOptions - The {@link Options} to use to make the request.
+ *
+ * @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 createEventSubscription(httpClient: AdobeCommerceHttpClient$2, params: EventSubscriptionCreateParams, fetchOptions?: Options): void;
+//#endregion
+//#region source/commerce/api/eventing-configuration/schema.d.ts
+/** The schema of the parameters received by the `updateConfiguration` Commerce Eventing API endpoint. */
+declare const UpdateEventingConfigurationParamsSchema: Omit<v.ObjectSchema<{
+  readonly enabled: v.BooleanSchema<`Expected a boolean value for property '${string}'`>;
+  readonly providerId: v.SchemaWithPipe<readonly [v.StringSchema<`Expected a string value for property '${string}'`>, v.RegexAction<string, `Only alphanumeric characters, underscores, and hyphens are allowed for property "${string}"`>]>;
+  readonly instanceId: v.SchemaWithPipe<readonly [v.StringSchema<`Expected a string value for property '${string}'`>, v.RegexAction<string, `Only alphanumeric characters, underscores, and hyphens are allowed for property "${string}"`>]>;
+  readonly merchantId: v.SchemaWithPipe<readonly [v.StringSchema<`Expected a string value for property '${string}'`>, v.RegexAction<string, `Only alphanumeric characters and underscores are allowed for "${string}"`>]>;
+  readonly environmentId: v.SchemaWithPipe<readonly [v.StringSchema<`Expected a string value for property '${string}'`>, v.RegexAction<string, `Only alphanumeric characters and underscores are allowed for "${string}"`>]>;
+  readonly workspaceConfiguration: v.UnionSchema<[v.SchemaWithPipe<readonly [v.StringSchema<`Expected a string value for property '${string}'`>, v.EmptyAction<string, undefined>]>, v.SchemaWithPipe<readonly [v.StringSchema<`Expected a string value for property '${string}'`>, v.ParseJsonAction<string, undefined, `Expected valid JSON string for property '${string}'`>, v.RecordSchema<v.StringSchema<undefined>, v.UnknownSchema, undefined>, v.StringifyJsonAction<{
+    [x: string]: unknown;
+  }, undefined, undefined>]>, v.SchemaWithPipe<readonly [v.RecordSchema<v.StringSchema<undefined>, v.UnknownSchema, undefined>, v.StringifyJsonAction<{
+    [x: string]: unknown;
+  }, undefined, `Expected valid JSON data for property '${string}'`>]>], undefined>;
+}, undefined>, "~types" | "~run" | "~standard" | "entries"> & {
+  readonly entries: {
+    readonly enabled: v.OptionalSchema<v.BooleanSchema<`Expected a boolean value for property '${string}'`>, undefined>;
+    readonly providerId: v.OptionalSchema<v.SchemaWithPipe<readonly [v.StringSchema<`Expected a string value for property '${string}'`>, v.RegexAction<string, `Only alphanumeric characters, underscores, and hyphens are allowed for property "${string}"`>]>, undefined>;
+    readonly instanceId: v.OptionalSchema<v.SchemaWithPipe<readonly [v.StringSchema<`Expected a string value for property '${string}'`>, v.RegexAction<string, `Only alphanumeric characters, underscores, and hyphens are allowed for property "${string}"`>]>, undefined>;
+    readonly merchantId: v.OptionalSchema<v.SchemaWithPipe<readonly [v.StringSchema<`Expected a string value for property '${string}'`>, v.RegexAction<string, `Only alphanumeric characters and underscores are allowed for "${string}"`>]>, undefined>;
+    readonly environmentId: v.OptionalSchema<v.SchemaWithPipe<readonly [v.StringSchema<`Expected a string value for property '${string}'`>, v.RegexAction<string, `Only alphanumeric characters and underscores are allowed for "${string}"`>]>, undefined>;
+    readonly workspaceConfiguration: v.OptionalSchema<v.UnionSchema<[v.SchemaWithPipe<readonly [v.StringSchema<`Expected a string value for property '${string}'`>, v.EmptyAction<string, undefined>]>, v.SchemaWithPipe<readonly [v.StringSchema<`Expected a string value for property '${string}'`>, v.ParseJsonAction<string, undefined, `Expected valid JSON string for property '${string}'`>, v.RecordSchema<v.StringSchema<undefined>, v.UnknownSchema, undefined>, v.StringifyJsonAction<{
+      [x: string]: unknown;
+    }, undefined, undefined>]>, v.SchemaWithPipe<readonly [v.RecordSchema<v.StringSchema<undefined>, v.UnknownSchema, undefined>, v.StringifyJsonAction<{
+      [x: string]: unknown;
+    }, undefined, `Expected valid JSON data for property '${string}'`>]>], undefined>, undefined>;
+  };
+  readonly '~standard': v.StandardProps<{
+    enabled?: boolean | undefined;
+    providerId?: string | undefined;
+    instanceId?: string | undefined;
+    merchantId?: string | undefined;
+    environmentId?: string | undefined;
+    workspaceConfiguration?: string | {
+      [x: string]: unknown;
+    } | undefined;
+  }, {
+    enabled?: boolean | undefined;
+    providerId?: string | undefined;
+    instanceId?: string | undefined;
+    merchantId?: string | undefined;
+    environmentId?: string | undefined;
+    workspaceConfiguration?: string | undefined;
+  }>;
+  readonly '~run': (dataset: v.UnknownDataset, config: v.Config<v.BaseIssue<unknown>>) => v.OutputDataset<{
+    enabled?: boolean | undefined;
+    providerId?: string | undefined;
+    instanceId?: string | undefined;
+    merchantId?: string | undefined;
+    environmentId?: string | undefined;
+    workspaceConfiguration?: string | undefined;
+  }, v.StringIssue | v.EmptyIssue<string> | v.ParseJsonIssue<string> | v.RecordIssue | v.StringifyJsonIssue<{
+    [x: string]: unknown;
+  }> | v.UnionIssue<v.StringIssue | v.EmptyIssue<string> | v.ParseJsonIssue<string> | v.RecordIssue | v.StringifyJsonIssue<{
+    [x: string]: unknown;
+  }>> | v.ObjectIssue | v.BooleanIssue | v.RegexIssue<string>>;
+  readonly '~types'?: {
+    readonly input: {
+      enabled?: boolean | undefined;
+      providerId?: string | undefined;
+      instanceId?: string | undefined;
+      merchantId?: string | undefined;
+      environmentId?: string | undefined;
+      workspaceConfiguration?: string | {
+        [x: string]: unknown;
+      } | undefined;
+    };
+    readonly output: {
+      enabled?: boolean | undefined;
+      providerId?: string | undefined;
+      instanceId?: string | undefined;
+      merchantId?: string | undefined;
+      environmentId?: string | undefined;
+      workspaceConfiguration?: string | undefined;
+    };
+    readonly issue: v.StringIssue | v.EmptyIssue<string> | v.ParseJsonIssue<string> | v.RecordIssue | v.StringifyJsonIssue<{
+      [x: string]: unknown;
+    }> | v.UnionIssue<v.StringIssue | v.EmptyIssue<string> | v.ParseJsonIssue<string> | v.RecordIssue | v.StringifyJsonIssue<{
+      [x: string]: unknown;
+    }>> | v.ObjectIssue | v.BooleanIssue | v.RegexIssue<string>;
+  } | undefined;
+};
+/**
+ * Defines the parameters received by the `updateConfiguration` Commerce Eventing API endpoint.
+ * @see https://developer.adobe.com/commerce/extensibility/events/api/#configure-commerce-eventing
+ */
+type UpdateEventingConfigurationParams = v.InferInput<typeof UpdateEventingConfigurationParamsSchema>;
+//#endregion
+//#region source/commerce/api/eventing-configuration/endpoints.d.ts
+/**
+ * Updates the configuration of the Commerce Eventing API.
+ * @see https://developer.adobe.com/commerce/extensibility/events/api/#configure-commerce-eventing
+ *
+ * @param httpClient - The {@link CommerceHttpClient} to use to make the request.
+ * @param params - The parameters to update the configuration with.
+ * @param fetchOptions - The {@link Options} to use to make the request.
+ *
+ * @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 updateEventingConfiguration(httpClient: AdobeCommerceHttpClient$1, params: UpdateEventingConfigurationParams, fetchOptions?: Options): Promise<boolean>;
+//#endregion
+//#region source/commerce/lib/api-client.d.ts
+/**
+ * Creates a new API client for the Commerce Events API client.
+ * @param params - The parameters to build the Commerce HTTP client that will communicate with the Commerce Events API.
+ */
+declare function createCommerceEventsApiClient(params: CommerceHttpClientParams): void 0<AdobeCommerceHttpClient, {
+  updateEventingConfiguration: typeof updateEventingConfiguration;
+  getAllEventSubscriptions(httpClient: AdobeCommerceHttpClient, fetchOptions?: ky0.Options): Promise<CommerceEventSubscriptionManyResponse>;
+  createEventSubscription(httpClient: AdobeCommerceHttpClient, params: EventSubscriptionCreateParams, fetchOptions?: ky0.Options): void;
+  getAllEventProviders(httpClient: AdobeCommerceHttpClient, fetchOptions?: ky0.Options): Promise<CommerceEventProviderManyResponse>;
+  getEventProviderById(httpClient: AdobeCommerceHttpClient, params: EventProviderGetByIdParams, fetchOptions?: ky0.Options): Promise<{
+    id: string;
+    providerId: string;
+    instanceId?: string | undefined;
+    label?: string | undefined;
+    description?: string | undefined;
+    workspaceConfiguration?: string | undefined;
+  }>;
+  createEventProvider(httpClient: AdobeCommerceHttpClient, params: EventProviderCreateParams, fetchOptions?: ky0.Options): Promise<{
+    id: string;
+    providerId: string;
+    instanceId?: string | undefined;
+    label?: string | undefined;
+    description?: string | undefined;
+    workspaceConfiguration?: string | undefined;
+  }>;
+}>;
+/**
+ * Creates a customized Commerce Events API client.
+ * @param params - The parameters to build the Commerce HTTP client that will communicate with the Commerce Events API.
+ * @param functions - The API functions to include in the client.
+ */
+declare function createCustomCommerceEventsApiClient<TFunctions extends Record<string, ApiFunction<AdobeCommerceHttpClient, unknown[], unknown>>>(params: CommerceHttpClientParams, functions: TFunctions): void 0<AdobeCommerceHttpClient, TFunctions>;
+//#endregion
+export { type CommerceEventProvider, type CommerceEventProviderManyResponse, type CommerceEventProviderOneResponse, type CommerceEventSubscription, type CommerceEventSubscriptionField, type CommerceEventSubscriptionManyResponse, type CommerceEventSubscriptionOneResponse, type CommerceEventSubscriptionRule, EventProviderCreateParams, EventProviderCreateParamsSchema, EventProviderGetByIdParams, EventProviderGetByIdParamsSchema, EventSubscriptionCreateParams, EventSubscriptionCreateParamsSchema, UpdateEventingConfigurationParams, UpdateEventingConfigurationParamsSchema, createCommerceEventsApiClient, createCustomCommerceEventsApiClient, createEventProvider, createEventSubscription, getAllEventProviders, getAllEventSubscriptions, getEventProviderById, updateEventingConfiguration };

package/dist/es/commerce/index.js

@@ -0,0 +1,14 @@
+/**
+* @license
+* 
+* Copyright 2025 Adobe. All rights reserved.
+* This file is licensed to you under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License. You may obtain a copy
+* of the License at http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software distributed under
+* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+* OF ANY KIND, either express or implied. See the License for the specific language
+* governing permissions and limitations under the License.
+*/
+import{b as optionallyExtendKy,c as ensureImsScopes,d as buildImsAuthBeforeRequestHook,e as buildIntegrationAuthBeforeRequestHook,f as isAuthProvider,g as HttpClientBase,h as ApiClient,i as alphaNumericOrUnderscoreOrHyphenSchema,j as alphaNumericOrUnderscoreSchema,k as booleanValueSchema,l as stringValueSchema,m as parseOrThrow,n as buildCamelCaseKeysResponseHook,o as __export}from"../ky-6HcrUVIg.js";import{CommerceSdkValidationError}from"@adobe/aio-commerce-lib-core/error";import*as v from"valibot";import ky from"ky";function workspaceConfigurationSchema(propertyName){return v.union([v.pipe(stringValueSchema(propertyName),v.empty()),v.pipe(stringValueSchema(propertyName),v.parseJson(void 0,`Expected valid JSON string for property '${propertyName}'`),v.record(v.string(),v.unknown()),v.stringifyJson()),v.pipe(v.record(v.string(),v.unknown()),v.stringifyJson(void 0,`Expected valid JSON data for property '${propertyName}'`))])}const EventProviderGetByIdParamsSchema=v.object({providerId:stringValueSchema(`providerId`)}),EventProviderCreateParamsSchema=v.object({providerId:stringValueSchema(`providerId`),instanceId:stringValueSchema(`instanceId`),label:v.optional(stringValueSchema(`label`)),description:v.optional(stringValueSchema(`description`)),associatedWorkspaceConfiguration:v.optional(workspaceConfigurationSchema(`associatedWorkspaceConfiguration`))});var endpoints_exports={};__export(endpoints_exports,{createEventProvider:()=>createEventProvider,getAllEventProviders:()=>getAllEventProviders,getEventProviderById:()=>getEventProviderById});function getAllEventProviders(httpClient,fetchOptions){let withHooksClient=httpClient.extend({hooks:{afterResponse:[buildCamelCaseKeysResponseHook()]}});return withHooksClient.get(`eventing/eventProvider`,fetchOptions).json()}function getEventProviderById(httpClient,params,fetchOptions){let validatedParams=parseOrThrow(EventProviderGetByIdParamsSchema,params),withHooksClient=httpClient.extend({hooks:{afterResponse:[buildCamelCaseKeysResponseHook()]}});return withHooksClient.get(`eventing/eventProvider/${validatedParams.providerId}`,fetchOptions).json()}function createEventProvider(httpClient,params,fetchOptions){let validatedParams=parseOrThrow(EventProviderCreateParamsSchema,params),withHooksClient=httpClient.extend({hooks:{afterResponse:[buildCamelCaseKeysResponseHook()]}});return withHooksClient.post(`eventing/eventProvider`,{...fetchOptions,json:{eventProvider:{provider_id:validatedParams.providerId,instance_id:validatedParams.instanceId,label:validatedParams.label,description:validatedParams.description,workspace_configuration:validatedParams.associatedWorkspaceConfiguration}}}).json()}function fieldsSchema(propertyName){return v.array(v.object({name:stringValueSchema(`${propertyName}[i].name`)}),`Expected an array of objects with a 'name' property for the property "${propertyName}"`)}const EventSubscriptionCreateParamsSchema=v.object({name:stringValueSchema(`name`),providerId:v.optional(stringValueSchema(`providerId`)),parent:v.optional(stringValueSchema(`parent`)),fields:fieldsSchema(`fields`),destination:v.optional(stringValueSchema(`destination`)),hipaaAuditRequired:v.optional(booleanValueSchema(`hipaaAuditRequired`)),prioritary:v.optional(booleanValueSchema(`prioritary`)),force:v.optional(booleanValueSchema(`force`))});var endpoints_exports$1={};__export(endpoints_exports$1,{createEventSubscription:()=>createEventSubscription,getAllEventSubscriptions:()=>getAllEventSubscriptions});function getAllEventSubscriptions(httpClient,fetchOptions){let withHooksClient=httpClient.extend({hooks:{afterResponse:[buildCamelCaseKeysResponseHook()]}});return withHooksClient.get(`eventing/getEventSubscriptions`,fetchOptions).json()}function createEventSubscription(httpClient,params,fetchOptions){let validatedParams=parseOrThrow(EventSubscriptionCreateParamsSchema,params),{force,...event}=validatedParams;httpClient.post(`eventing/eventSubscribe`,{...fetchOptions,json:{force,event:{name:event.name,parent:event.parent,fields:event.fields,destination:event.destination,hipaa_audit_required:event.hipaaAuditRequired,priority:event.prioritary,provider_id:event.providerId}}}).json()}const UpdateEventingConfigurationParamsSchema=v.partial(v.object({enabled:booleanValueSchema(`enabled`),providerId:alphaNumericOrUnderscoreOrHyphenSchema(`providerId`),instanceId:alphaNumericOrUnderscoreOrHyphenSchema(`instanceId`),merchantId:alphaNumericOrUnderscoreSchema(`merchantId`),environmentId:alphaNumericOrUnderscoreSchema(`environmentId`),workspaceConfiguration:workspaceConfigurationSchema(`workspaceConfiguration`)}));function updateEventingConfiguration(httpClient,params,fetchOptions){let validatedParams=parseOrThrow(UpdateEventingConfigurationParamsSchema,params);return httpClient.put(`eventing/updateConfiguration`,{...fetchOptions,json:{config:validatedParams}}).json()}const COMMERCE_SAAS_IMS_REQUIRED_SCOPES=[`openid`,`additional_info.projectedProductContext`,`commerce.accs`];function getCommerceUrl(config){let{baseUrl,storeViewCode,version}=config,commerceUrl=new URL(baseUrl),uppercasedVersion=version?.toUpperCase();return config.flavor===`paas`?commerceUrl.pathname+=`rest/${storeViewCode}/${uppercasedVersion}`:config.flavor===`saas`&&(commerceUrl.pathname+=`/${uppercasedVersion}`),commerceUrl.toString()}function buildCommerceHttpClientPaaS(params){let{auth,config,fetchOptions}=params,commerceUrl=getCommerceUrl(config),beforeRequestAuthHook=buildIntegrationAuthBeforeRequestHook(auth),httpClient=ky.create({prefixUrl:commerceUrl,hooks:{beforeRequest:[beforeRequestAuthHook]}});return optionallyExtendKy(httpClient,fetchOptions)}function buildCommerceHttpClientSaaS(params){let{auth,config,fetchOptions}=params,commerceUrl=getCommerceUrl(config),beforeRequestAuthHook=isAuthProvider(auth)?buildImsAuthBeforeRequestHook(auth):buildImsAuthBeforeRequestHook(ensureImsScopes(auth,COMMERCE_SAAS_IMS_REQUIRED_SCOPES)),httpClient=ky.create({prefixUrl:commerceUrl,hooks:{beforeRequest:[beforeRequestAuthHook,request=>{request.headers.set(`Store`,config.storeViewCode)}]}});return optionallyExtendKy(httpClient,fetchOptions)}function isPaaSParams(params){return params.config.flavor===`paas`}function isSaaSParams(params){return params.config.flavor===`saas`}function buildCommerceHttpClient(params){let flavor=params.config.flavor;if(isPaaSParams(params))return buildCommerceHttpClientPaaS(params);if(isSaaSParams(params))return buildCommerceHttpClientSaaS(params);throw Error(`Invalid Commerce configuration. Unknown flavor: ${flavor}`)}var AdobeCommerceHttpClient=class extends HttpClientBase{constructor(params){let config={...params.config,storeViewCode:params.config.storeViewCode??`all`,version:params.config.version??`V1`},requiredParams={...params,config},httpClient=buildCommerceHttpClient(requiredParams);super(config,httpClient)}};function createCommerceEventsApiClient(params){return ApiClient.create(new AdobeCommerceHttpClient(params),{...endpoints_exports,...endpoints_exports$1,updateEventingConfiguration})}function createCustomCommerceEventsApiClient(params,functions){return ApiClient.create(new AdobeCommerceHttpClient(params),functions)}export{createCommerceEventsApiClient,createCustomCommerceEventsApiClient,createEventProvider,createEventSubscription,getAllEventProviders,getAllEventSubscriptions,getEventProviderById,updateEventingConfiguration};