@adobe/aio-commerce-lib-events 0.3.0 → 0.3.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +19 -0
- package/dist/cjs/commerce/index.d.cts +13 -13
- package/dist/cjs/io-events/index.cjs +1 -1
- package/dist/cjs/io-events/index.d.cts +15 -17
- package/dist/es/commerce/index.d.ts +13 -13
- package/dist/es/io-events/index.d.ts +15 -17
- package/dist/es/io-events/index.js +1 -1
- package/package.json +5 -5
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,24 @@
|
|
|
1
1
|
# @adobe/aio-commerce-lib-events
|
|
2
2
|
|
|
3
|
+
## 0.3.2
|
|
4
|
+
|
|
5
|
+
### Patch Changes
|
|
6
|
+
|
|
7
|
+
- Updated dependencies [[`9079402`](https://github.com/adobe/aio-commerce-sdk/commit/90794023b30ba749e2a1e8278584e4804ad45e1e), [`176bd0f`](https://github.com/adobe/aio-commerce-sdk/commit/176bd0f793de8dbd11b1704a82dd722158f48e81), [`176bd0f`](https://github.com/adobe/aio-commerce-sdk/commit/176bd0f793de8dbd11b1704a82dd722158f48e81), [`9079402`](https://github.com/adobe/aio-commerce-sdk/commit/90794023b30ba749e2a1e8278584e4804ad45e1e), [`9079402`](https://github.com/adobe/aio-commerce-sdk/commit/90794023b30ba749e2a1e8278584e4804ad45e1e), [`fd6a1b5`](https://github.com/adobe/aio-commerce-sdk/commit/fd6a1b531aaea399fea875c8e1e03002790cb1f4), [`493da95`](https://github.com/adobe/aio-commerce-sdk/commit/493da9595c06de304ecddbbc8295db124cb6fcba)]:
|
|
8
|
+
- @adobe/aio-commerce-lib-api@0.3.0
|
|
9
|
+
- @adobe/aio-commerce-lib-core@0.5.0
|
|
10
|
+
- @adobe/aio-commerce-lib-auth@0.6.0
|
|
11
|
+
|
|
12
|
+
## 0.3.1
|
|
13
|
+
|
|
14
|
+
### Patch Changes
|
|
15
|
+
|
|
16
|
+
- [#95](https://github.com/adobe/aio-commerce-sdk/pull/95) [`abd5012`](https://github.com/adobe/aio-commerce-sdk/commit/abd5012e5680f97abd150de6036b2225c7dc0277) Thanks [@iivvaannxx](https://github.com/apps/renovate)! - Fix automatic handling of expected Base64 format for `sample_event_template` during event metadata creation.
|
|
17
|
+
|
|
18
|
+
- Updated dependencies [[`abd5012`](https://github.com/adobe/aio-commerce-sdk/commit/abd5012e5680f97abd150de6036b2225c7dc0277)]:
|
|
19
|
+
- @adobe/aio-commerce-lib-auth@0.5.0
|
|
20
|
+
- @adobe/aio-commerce-lib-api@0.2.1
|
|
21
|
+
|
|
3
22
|
## 0.3.0
|
|
4
23
|
|
|
5
24
|
### Minor Changes
|
|
@@ -12,12 +12,12 @@
|
|
|
12
12
|
* governing permissions and limitations under the License.
|
|
13
13
|
*/
|
|
14
14
|
|
|
15
|
-
import * as
|
|
15
|
+
import * as _adobe_aio_commerce_lib_api1 from "@adobe/aio-commerce-lib-api";
|
|
16
16
|
import { AdobeCommerceHttpClient, ApiFunction, CommerceHttpClientParams } from "@adobe/aio-commerce-lib-api";
|
|
17
17
|
import { Options } from "@adobe/aio-commerce-lib-api/ky";
|
|
18
18
|
import * as v from "valibot";
|
|
19
19
|
import { CamelCasedPropertiesDeep } from "type-fest";
|
|
20
|
-
import * as
|
|
20
|
+
import * as ky9 from "ky";
|
|
21
21
|
|
|
22
22
|
//#region source/commerce/api/event-providers/schema.d.ts
|
|
23
23
|
declare const EventProviderGetByIdParamsSchema: v.ObjectSchema<{
|
|
@@ -229,9 +229,9 @@ declare const UpdateEventingConfigurationParamsSchema: Omit<v.ObjectSchema<{
|
|
|
229
229
|
merchantId?: string | undefined;
|
|
230
230
|
environmentId?: string | undefined;
|
|
231
231
|
workspaceConfiguration?: string | undefined;
|
|
232
|
-
}, v.
|
|
232
|
+
}, v.StringIssue | v.BooleanIssue | v.ObjectIssue | v.ParseJsonIssue<string> | v.RecordIssue | v.RegexIssue<string> | v.EmptyIssue<string> | v.StringifyJsonIssue<{
|
|
233
233
|
[x: string]: unknown;
|
|
234
|
-
}> | v.UnionIssue<v.StringIssue | v.
|
|
234
|
+
}> | v.UnionIssue<v.StringIssue | v.ParseJsonIssue<string> | v.RecordIssue | v.EmptyIssue<string> | v.StringifyJsonIssue<{
|
|
235
235
|
[x: string]: unknown;
|
|
236
236
|
}>>>;
|
|
237
237
|
readonly '~types'?: {
|
|
@@ -253,9 +253,9 @@ declare const UpdateEventingConfigurationParamsSchema: Omit<v.ObjectSchema<{
|
|
|
253
253
|
environmentId?: string | undefined;
|
|
254
254
|
workspaceConfiguration?: string | undefined;
|
|
255
255
|
};
|
|
256
|
-
readonly issue: v.
|
|
256
|
+
readonly issue: v.StringIssue | v.BooleanIssue | v.ObjectIssue | v.ParseJsonIssue<string> | v.RecordIssue | v.RegexIssue<string> | v.EmptyIssue<string> | v.StringifyJsonIssue<{
|
|
257
257
|
[x: string]: unknown;
|
|
258
|
-
}> | v.UnionIssue<v.StringIssue | v.
|
|
258
|
+
}> | v.UnionIssue<v.StringIssue | v.ParseJsonIssue<string> | v.RecordIssue | v.EmptyIssue<string> | v.StringifyJsonIssue<{
|
|
259
259
|
[x: string]: unknown;
|
|
260
260
|
}>>;
|
|
261
261
|
} | undefined;
|
|
@@ -285,12 +285,12 @@ declare function updateEventingConfiguration(httpClient: AdobeCommerceHttpClient
|
|
|
285
285
|
* Creates a new API client for the Commerce Events API client.
|
|
286
286
|
* @param params - The parameters to build the Commerce HTTP client that will communicate with the Commerce Events API.
|
|
287
287
|
*/
|
|
288
|
-
declare function createCommerceEventsApiClient(params: CommerceHttpClientParams):
|
|
288
|
+
declare function createCommerceEventsApiClient(params: CommerceHttpClientParams): _adobe_aio_commerce_lib_api1.ApiClientRecord<AdobeCommerceHttpClient, {
|
|
289
289
|
updateEventingConfiguration: typeof updateEventingConfiguration;
|
|
290
|
-
getAllEventSubscriptions(httpClient: AdobeCommerceHttpClient, fetchOptions?:
|
|
291
|
-
createEventSubscription(httpClient: AdobeCommerceHttpClient, params: EventSubscriptionCreateParams, fetchOptions?:
|
|
292
|
-
getAllEventProviders(httpClient: AdobeCommerceHttpClient, fetchOptions?:
|
|
293
|
-
getEventProviderById(httpClient: AdobeCommerceHttpClient, params: EventProviderGetByIdParams, fetchOptions?:
|
|
290
|
+
getAllEventSubscriptions(httpClient: AdobeCommerceHttpClient, fetchOptions?: ky9.Options): Promise<CommerceEventSubscriptionManyResponse>;
|
|
291
|
+
createEventSubscription(httpClient: AdobeCommerceHttpClient, params: EventSubscriptionCreateParams, fetchOptions?: ky9.Options): Promise<void>;
|
|
292
|
+
getAllEventProviders(httpClient: AdobeCommerceHttpClient, fetchOptions?: ky9.Options): Promise<CommerceEventProviderManyResponse>;
|
|
293
|
+
getEventProviderById(httpClient: AdobeCommerceHttpClient, params: EventProviderGetByIdParams, fetchOptions?: ky9.Options): Promise<{
|
|
294
294
|
id: string;
|
|
295
295
|
providerId: string;
|
|
296
296
|
instanceId?: string | undefined;
|
|
@@ -298,7 +298,7 @@ declare function createCommerceEventsApiClient(params: CommerceHttpClientParams)
|
|
|
298
298
|
description?: string | undefined;
|
|
299
299
|
workspaceConfiguration?: string | undefined;
|
|
300
300
|
}>;
|
|
301
|
-
createEventProvider(httpClient: AdobeCommerceHttpClient, params: EventProviderCreateParams, fetchOptions?:
|
|
301
|
+
createEventProvider(httpClient: AdobeCommerceHttpClient, params: EventProviderCreateParams, fetchOptions?: ky9.Options): Promise<{
|
|
302
302
|
id: string;
|
|
303
303
|
providerId: string;
|
|
304
304
|
instanceId?: string | undefined;
|
|
@@ -312,6 +312,6 @@ declare function createCommerceEventsApiClient(params: CommerceHttpClientParams)
|
|
|
312
312
|
* @param params - The parameters to build the Commerce HTTP client that will communicate with the Commerce Events API.
|
|
313
313
|
* @param functions - The API functions to include in the client.
|
|
314
314
|
*/
|
|
315
|
-
declare function createCustomCommerceEventsApiClient<TFunctions extends Record<string, ApiFunction<AdobeCommerceHttpClient, any[], any>>>(params: CommerceHttpClientParams, functions: TFunctions):
|
|
315
|
+
declare function createCustomCommerceEventsApiClient<TFunctions extends Record<string, ApiFunction<AdobeCommerceHttpClient, any[], any>>>(params: CommerceHttpClientParams, functions: TFunctions): _adobe_aio_commerce_lib_api1.ApiClientRecord<AdobeCommerceHttpClient, TFunctions>;
|
|
316
316
|
//#endregion
|
|
317
317
|
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 };
|
|
@@ -11,4 +11,4 @@
|
|
|
11
11
|
* OF ANY KIND, either express or implied. See the License for the specific language
|
|
12
12
|
* governing permissions and limitations under the License.
|
|
13
13
|
*/
|
|
14
|
-
const require_schemas=require(`../schemas-wR6n5bUK.cjs`);let __adobe_aio_commerce_lib_api_utils_transformations=require(`@adobe/aio-commerce-lib-api/utils/transformations`);__adobe_aio_commerce_lib_api_utils_transformations=require_schemas.s(__adobe_aio_commerce_lib_api_utils_transformations);let valibot=require(`valibot`);valibot=require_schemas.s(valibot);let __adobe_aio_commerce_lib_api=require(`@adobe/aio-commerce-lib-api`);__adobe_aio_commerce_lib_api=require_schemas.s(__adobe_aio_commerce_lib_api);const BASE64_ENCODED_STRING_REGEX=/^[A-Za-z0-9+/]*={0,2}$/,BASE64_ENCODED_STRING_LENGTH_REMAINDER=4;function isBase64EncodedString(value){return BASE64_ENCODED_STRING_REGEX.test(value)&&value.length%4==0}function encodeToBase64(value){return Buffer.from(value).toString(`base64`)}function tryDecodeFromBase64(value){return isBase64EncodedString(value)?Buffer.from(value,`base64`).toString(`utf-8`):value}function sampleEventTemplateSchema(fieldName){return valibot.pipe(valibot.union([valibot.pipe(require_schemas.i(fieldName),valibot.transform(tryDecodeFromBase64),valibot.parseJson(void 0,`Expected valid JSON string for property '${fieldName}'`),valibot.record(valibot.string(),valibot.unknown())
|
|
14
|
+
const require_schemas=require(`../schemas-wR6n5bUK.cjs`);let __adobe_aio_commerce_lib_api_utils_transformations=require(`@adobe/aio-commerce-lib-api/utils/transformations`);__adobe_aio_commerce_lib_api_utils_transformations=require_schemas.s(__adobe_aio_commerce_lib_api_utils_transformations);let valibot=require(`valibot`);valibot=require_schemas.s(valibot);let __adobe_aio_commerce_lib_api=require(`@adobe/aio-commerce-lib-api`);__adobe_aio_commerce_lib_api=require_schemas.s(__adobe_aio_commerce_lib_api);const BASE64_ENCODED_STRING_REGEX=/^[A-Za-z0-9+/]*={0,2}$/,BASE64_ENCODED_STRING_LENGTH_REMAINDER=4;function isBase64EncodedString(value){return BASE64_ENCODED_STRING_REGEX.test(value)&&value.length%4==0}function encodeToBase64(value){return Buffer.from(value).toString(`base64`)}function tryDecodeFromBase64(value){return isBase64EncodedString(value)?Buffer.from(value,`base64`).toString(`utf-8`):value}function sampleEventTemplateSchema(fieldName){return valibot.pipe(valibot.union([valibot.pipe(require_schemas.i(fieldName),valibot.transform(tryDecodeFromBase64),valibot.parseJson(void 0,`Expected valid JSON string for property '${fieldName}'`),valibot.record(valibot.string(),valibot.unknown())),valibot.record(valibot.string(),valibot.unknown()),valibot.array(valibot.unknown())]),valibot.stringifyJson(void 0,`Expected valid JSON data for property '${fieldName}'`),valibot.transform(encodeToBase64))}const GetAllEventMetadataForProviderSchema=valibot.object({providerId:require_schemas.i(`providerId`)}),GetEventMetadataForEventAndProviderSchema=valibot.object({eventCode:require_schemas.i(`eventCode`),providerId:require_schemas.i(`providerId`)}),CreateEventMetadataForProviderSchema=valibot.object({consumerOrgId:require_schemas.i(`consumerOrgId`),projectId:require_schemas.i(`projectId`),workspaceId:require_schemas.i(`workspaceId`),providerId:require_schemas.i(`providerId`),label:require_schemas.i(`label`),description:require_schemas.i(`description`),eventCode:require_schemas.i(`eventCode`),sampleEventTemplate:valibot.optional(sampleEventTemplateSchema(`sampleEventTemplate`))});var endpoints_exports=require_schemas.o({createEventMetadataForProvider:()=>createEventMetadataForProvider,getAllEventMetadataForProvider:()=>getAllEventMetadataForProvider,getEventMetadataForEventAndProvider:()=>getEventMetadataForEventAndProvider});async function getAllEventMetadataForProvider(httpClient,params,fetchOptions){let validatedParams=require_schemas.a(GetAllEventMetadataForProviderSchema,params);return httpClient.extend({hooks:{afterResponse:[(0,__adobe_aio_commerce_lib_api_utils_transformations.buildCamelCaseKeysResponseHook)()]}}).get(`providers/${validatedParams.providerId}/eventmetadata`,fetchOptions).json()}async function getEventMetadataForEventAndProvider(httpClient,params,fetchOptions){let validatedParams=require_schemas.a(GetEventMetadataForEventAndProviderSchema,params);return httpClient.extend({hooks:{afterResponse:[(0,__adobe_aio_commerce_lib_api_utils_transformations.buildCamelCaseKeysResponseHook)()]}}).get(`providers/${validatedParams.providerId}/eventmetadata/${validatedParams.eventCode}`,fetchOptions).json()}async function createEventMetadataForProvider(httpClient,params,fetchOptions){let validatedParams=require_schemas.a(CreateEventMetadataForProviderSchema,params);return httpClient.extend({hooks:{afterResponse:[(0,__adobe_aio_commerce_lib_api_utils_transformations.buildCamelCaseKeysResponseHook)()]}}).post(`${validatedParams.consumerOrgId}/${validatedParams.projectId}/${validatedParams.workspaceId}/providers/${validatedParams.providerId}/eventmetadata`,{...fetchOptions,json:{label:validatedParams.label,description:validatedParams.description,event_code:validatedParams.eventCode,sample_event_template:validatedParams.sampleEventTemplate}}).json()}function setQueryParamIfTruthy(queryParams,key,value){value&&queryParams.set(key,`${value}`)}function setArrayQueryParam(queryParams,key,values){if(values!==void 0&&values.length>0)for(let value of values)queryParams.set(key,`${value}`)}const VALID_EVENT_PROVIDER_TYPES=[`dx_commerce_events`,`3rd_party_custom_events`],VALID_DATA_RESIDENCY_REGIONS=[`va6`,`irl1`],EventProviderTypeSchema=valibot.picklist(VALID_EVENT_PROVIDER_TYPES),DataResidencyRegionSchema=valibot.picklist(VALID_DATA_RESIDENCY_REGIONS),EventProviderListAllParamsSchema=valibot.object({consumerOrgId:require_schemas.i(`consumerOrgId`),withEventMetadata:valibot.optional(require_schemas.r(`withEventMetadata`)),filterBy:valibot.optional(valibot.object({instanceId:valibot.optional(require_schemas.i(`instanceId`)),providerTypes:valibot.optional(valibot.union([valibot.array(EventProviderTypeSchema,`Expected an array of event provider types`)]))}))}),EventProviderGetByIdParamsSchema=valibot.object({providerId:require_schemas.i(`providerId`),withEventMetadata:valibot.optional(require_schemas.r(`withEventMetadata`))}),EventProviderCreateParamsSchema=valibot.object({consumerOrgId:require_schemas.i(`consumerOrgId`),projectId:require_schemas.i(`projectId`),workspaceId:require_schemas.i(`workspaceId`),label:require_schemas.i(`label`),description:valibot.optional(require_schemas.i(`description`)),docsUrl:valibot.optional(require_schemas.i(`docsUrl`)),instanceId:valibot.optional(require_schemas.i(`instanceId`)),providerType:valibot.optional(EventProviderTypeSchema),dataResidencyRegion:valibot.optional(DataResidencyRegionSchema)});var endpoints_exports$1=require_schemas.o({createEventProvider:()=>createEventProvider,getAllEventProviders:()=>getAllEventProviders,getEventProviderById:()=>getEventProviderById});async function getAllEventProviders(httpClient,params,fetchOptions){let validatedParams=require_schemas.a(EventProviderListAllParamsSchema,params),queryParams=new URLSearchParams,{providerTypes=[],instanceId}=validatedParams.filterBy??{};return setArrayQueryParam(queryParams,`providerMetadataIds`,providerTypes),setQueryParamIfTruthy(queryParams,`instanceId`,instanceId),setQueryParamIfTruthy(queryParams,`eventmetadata`,validatedParams.withEventMetadata),httpClient.extend({hooks:{afterResponse:[(0,__adobe_aio_commerce_lib_api_utils_transformations.buildCamelCaseKeysResponseHook)()]}}).get(`${validatedParams.consumerOrgId}/providers`,{...fetchOptions,searchParams:queryParams}).json()}async function getEventProviderById(httpClient,params,fetchOptions){let validatedParams=require_schemas.a(EventProviderGetByIdParamsSchema,params),searchParams=new URLSearchParams;return setQueryParamIfTruthy(searchParams,`eventmetadata`,validatedParams.withEventMetadata),httpClient.extend({hooks:{afterResponse:[(0,__adobe_aio_commerce_lib_api_utils_transformations.buildCamelCaseKeysResponseHook)()]}}).get(`providers/${params.providerId}`,{...fetchOptions,searchParams}).json()}async function createEventProvider(httpClient,params,fetchOptions){let validatedParams=require_schemas.a(EventProviderCreateParamsSchema,params);return httpClient.extend({hooks:{afterResponse:[(0,__adobe_aio_commerce_lib_api_utils_transformations.buildCamelCaseKeysResponseHook)()]}}).post(`${validatedParams.consumerOrgId}/${validatedParams.projectId}/${validatedParams.workspaceId}/providers`,{...fetchOptions,json:{...validatedParams,docs_url:validatedParams.docsUrl,provider_metadata:validatedParams.providerType,instance_id:validatedParams.instanceId,data_residency_region:validatedParams.dataResidencyRegion}}).json()}var shorthands_exports=require_schemas.o({create3rdPartyCustomEventProvider:()=>create3rdPartyCustomEventProvider,createCommerceEventProvider:()=>createCommerceEventProvider,getAll3rdPartyCustomEventProviders:()=>getAll3rdPartyCustomEventProviders,getAllCommerceEventProviders:()=>getAllCommerceEventProviders});async function getAllCommerceEventProviders(httpClient,params,fetchOptions){return getAllEventProviders(httpClient,{...params,filterBy:{...params.filterBy,providerTypes:[`dx_commerce_events`]}},fetchOptions)}async function getAll3rdPartyCustomEventProviders(httpClient,params,fetchOptions){return getAllEventProviders(httpClient,{...params,filterBy:{...params.filterBy,providerTypes:[`3rd_party_custom_events`]}},fetchOptions)}async function createCommerceEventProvider(httpClient,params,fetchOptions){return createEventProvider(httpClient,{...params,providerType:`dx_commerce_events`},fetchOptions)}async function create3rdPartyCustomEventProvider(httpClient,params,fetchOptions){return createEventProvider(httpClient,{...params,providerType:`3rd_party_custom_events`},fetchOptions)}function createAdobeIoEventsApiClient(params){return __adobe_aio_commerce_lib_api.ApiClient.create(new __adobe_aio_commerce_lib_api.AdobeIoEventsHttpClient(params),{...endpoints_exports$1,...endpoints_exports,...shorthands_exports})}function createCustomAdobeIoEventsApiClient(params,functions){return __adobe_aio_commerce_lib_api.ApiClient.create(new __adobe_aio_commerce_lib_api.AdobeIoEventsHttpClient(params),functions)}exports.create3rdPartyCustomEventProvider=create3rdPartyCustomEventProvider,exports.createAdobeIoEventsApiClient=createAdobeIoEventsApiClient,exports.createCommerceEventProvider=createCommerceEventProvider,exports.createCustomAdobeIoEventsApiClient=createCustomAdobeIoEventsApiClient,exports.createEventMetadataForProvider=createEventMetadataForProvider,exports.createEventProvider=createEventProvider,exports.getAll3rdPartyCustomEventProviders=getAll3rdPartyCustomEventProviders,exports.getAllCommerceEventProviders=getAllCommerceEventProviders,exports.getAllEventMetadataForProvider=getAllEventMetadataForProvider,exports.getAllEventProviders=getAllEventProviders,exports.getEventMetadataForEventAndProvider=getEventMetadataForEventAndProvider,exports.getEventProviderById=getEventProviderById;
|
|
@@ -12,13 +12,13 @@
|
|
|
12
12
|
* governing permissions and limitations under the License.
|
|
13
13
|
*/
|
|
14
14
|
|
|
15
|
-
import * as
|
|
15
|
+
import * as _adobe_aio_commerce_lib_api0 from "@adobe/aio-commerce-lib-api";
|
|
16
16
|
import { AdobeIoEventsHttpClient, ApiFunction, IoEventsHttpClientParams } from "@adobe/aio-commerce-lib-api";
|
|
17
17
|
import { Options } from "@adobe/aio-commerce-lib-api/ky";
|
|
18
18
|
import * as v from "valibot";
|
|
19
19
|
import * as type_fest0 from "type-fest";
|
|
20
20
|
import { CamelCasedPropertiesDeep, OmitDeep } from "type-fest";
|
|
21
|
-
import * as
|
|
21
|
+
import * as ky0 from "ky";
|
|
22
22
|
|
|
23
23
|
//#region source/io-events/api/event-metadata/schema.d.ts
|
|
24
24
|
/** The schema of the parameters received by the GET `providers/:id/eventmetadata` Adobe I/O Events API endpoint. */
|
|
@@ -39,9 +39,7 @@ declare const CreateEventMetadataForProviderSchema: v.ObjectSchema<{
|
|
|
39
39
|
readonly label: v.StringSchema<`Expected a string value for property '${string}'`>;
|
|
40
40
|
readonly description: v.StringSchema<`Expected a string value for property '${string}'`>;
|
|
41
41
|
readonly eventCode: v.StringSchema<`Expected a string value for property '${string}'`>;
|
|
42
|
-
readonly sampleEventTemplate: v.OptionalSchema<v.SchemaWithPipe<readonly [v.UnionSchema<[v.SchemaWithPipe<readonly [v.StringSchema<`Expected a string value for property '${string}'`>, v.TransformAction<string, string>, v.ParseJsonAction<string, undefined, `Expected valid JSON string for property '${string}'`>, v.RecordSchema<v.StringSchema<undefined>, v.UnknownSchema, undefined>, v.StringifyJsonAction<{
|
|
43
|
-
[x: string]: unknown;
|
|
44
|
-
}, undefined, undefined>]>, v.RecordSchema<v.StringSchema<undefined>, v.UnknownSchema, undefined>, v.ArraySchema<v.UnknownSchema, undefined>], undefined>, v.StringifyJsonAction<string | unknown[] | {
|
|
42
|
+
readonly sampleEventTemplate: v.OptionalSchema<v.SchemaWithPipe<readonly [v.UnionSchema<[v.SchemaWithPipe<readonly [v.StringSchema<`Expected a string value for property '${string}'`>, v.TransformAction<string, string>, v.ParseJsonAction<string, undefined, `Expected valid JSON string for property '${string}'`>, v.RecordSchema<v.StringSchema<undefined>, v.UnknownSchema, undefined>]>, v.RecordSchema<v.StringSchema<undefined>, v.UnknownSchema, undefined>, v.ArraySchema<v.UnknownSchema, undefined>], undefined>, v.StringifyJsonAction<unknown[] | {
|
|
45
43
|
[x: string]: unknown;
|
|
46
44
|
}, undefined, `Expected valid JSON data for property '${string}'`>, v.TransformAction<string, string>]>, undefined>;
|
|
47
45
|
}, undefined>;
|
|
@@ -1121,8 +1119,8 @@ declare function create3rdPartyCustomEventProvider(httpClient: AdobeIoEventsHttp
|
|
|
1121
1119
|
* Creates a new API client for the Adobe I/O Events API client.
|
|
1122
1120
|
* @param params - The parameters to build the Adobe I/O Events HTTP client that will communicate with the Adobe I/O Events API.
|
|
1123
1121
|
*/
|
|
1124
|
-
declare function createAdobeIoEventsApiClient(params: IoEventsHttpClientParams):
|
|
1125
|
-
getAllCommerceEventProviders(httpClient: AdobeIoEventsHttpClient, params: type_fest0.OmitDeep<EventProviderListAllParams, "filterBy.providerType">, fetchOptions?:
|
|
1122
|
+
declare function createAdobeIoEventsApiClient(params: IoEventsHttpClientParams): _adobe_aio_commerce_lib_api0.ApiClientRecord<AdobeIoEventsHttpClient, {
|
|
1123
|
+
getAllCommerceEventProviders(httpClient: AdobeIoEventsHttpClient, params: type_fest0.OmitDeep<EventProviderListAllParams, "filterBy.providerType">, fetchOptions?: ky0.Options): Promise<{
|
|
1126
1124
|
embedded: {
|
|
1127
1125
|
providers: {
|
|
1128
1126
|
id: string;
|
|
@@ -1235,7 +1233,7 @@ declare function createAdobeIoEventsApiClient(params: IoEventsHttpClientParams):
|
|
|
1235
1233
|
};
|
|
1236
1234
|
};
|
|
1237
1235
|
}>;
|
|
1238
|
-
getAll3rdPartyCustomEventProviders(httpClient: AdobeIoEventsHttpClient, params: type_fest0.OmitDeep<EventProviderListAllParams, "filterBy.providerType">, fetchOptions?:
|
|
1236
|
+
getAll3rdPartyCustomEventProviders(httpClient: AdobeIoEventsHttpClient, params: type_fest0.OmitDeep<EventProviderListAllParams, "filterBy.providerType">, fetchOptions?: ky0.Options): Promise<{
|
|
1239
1237
|
embedded: {
|
|
1240
1238
|
providers: {
|
|
1241
1239
|
id: string;
|
|
@@ -1348,7 +1346,7 @@ declare function createAdobeIoEventsApiClient(params: IoEventsHttpClientParams):
|
|
|
1348
1346
|
};
|
|
1349
1347
|
};
|
|
1350
1348
|
}>;
|
|
1351
|
-
createCommerceEventProvider(httpClient: AdobeIoEventsHttpClient, params: type_fest0.OmitDeep<EventProviderCreateParams, "providerType">, fetchOptions?:
|
|
1349
|
+
createCommerceEventProvider(httpClient: AdobeIoEventsHttpClient, params: type_fest0.OmitDeep<EventProviderCreateParams, "providerType">, fetchOptions?: ky0.Options): Promise<{
|
|
1352
1350
|
id: string;
|
|
1353
1351
|
instanceId?: string | undefined;
|
|
1354
1352
|
label: string;
|
|
@@ -1444,7 +1442,7 @@ declare function createAdobeIoEventsApiClient(params: IoEventsHttpClientParams):
|
|
|
1444
1442
|
} | undefined;
|
|
1445
1443
|
};
|
|
1446
1444
|
}>;
|
|
1447
|
-
create3rdPartyCustomEventProvider(httpClient: AdobeIoEventsHttpClient, params: type_fest0.OmitDeep<EventProviderCreateParams, "providerType">, fetchOptions?:
|
|
1445
|
+
create3rdPartyCustomEventProvider(httpClient: AdobeIoEventsHttpClient, params: type_fest0.OmitDeep<EventProviderCreateParams, "providerType">, fetchOptions?: ky0.Options): Promise<{
|
|
1448
1446
|
id: string;
|
|
1449
1447
|
instanceId?: string | undefined;
|
|
1450
1448
|
label: string;
|
|
@@ -1540,7 +1538,7 @@ declare function createAdobeIoEventsApiClient(params: IoEventsHttpClientParams):
|
|
|
1540
1538
|
} | undefined;
|
|
1541
1539
|
};
|
|
1542
1540
|
}>;
|
|
1543
|
-
getAllEventMetadataForProvider(httpClient: AdobeIoEventsHttpClient, params: GetAllEventMetadataForProviderParams, fetchOptions?:
|
|
1541
|
+
getAllEventMetadataForProvider(httpClient: AdobeIoEventsHttpClient, params: GetAllEventMetadataForProviderParams, fetchOptions?: ky0.Options): Promise<{
|
|
1544
1542
|
embedded: {
|
|
1545
1543
|
description: string;
|
|
1546
1544
|
label: string;
|
|
@@ -1601,7 +1599,7 @@ declare function createAdobeIoEventsApiClient(params: IoEventsHttpClientParams):
|
|
|
1601
1599
|
};
|
|
1602
1600
|
}[];
|
|
1603
1601
|
}>;
|
|
1604
|
-
getEventMetadataForEventAndProvider(httpClient: AdobeIoEventsHttpClient, params: GetEventMetadataForEventAndProviderParams, fetchOptions?:
|
|
1602
|
+
getEventMetadataForEventAndProvider(httpClient: AdobeIoEventsHttpClient, params: GetEventMetadataForEventAndProviderParams, fetchOptions?: ky0.Options): Promise<{
|
|
1605
1603
|
description: string;
|
|
1606
1604
|
label: string;
|
|
1607
1605
|
eventCode: string;
|
|
@@ -1660,7 +1658,7 @@ declare function createAdobeIoEventsApiClient(params: IoEventsHttpClientParams):
|
|
|
1660
1658
|
};
|
|
1661
1659
|
};
|
|
1662
1660
|
}>;
|
|
1663
|
-
createEventMetadataForProvider(httpClient: AdobeIoEventsHttpClient, params: CreateEventMetadataForProviderParams, fetchOptions?:
|
|
1661
|
+
createEventMetadataForProvider(httpClient: AdobeIoEventsHttpClient, params: CreateEventMetadataForProviderParams, fetchOptions?: ky0.Options): Promise<{
|
|
1664
1662
|
description: string;
|
|
1665
1663
|
label: string;
|
|
1666
1664
|
eventCode: string;
|
|
@@ -1719,7 +1717,7 @@ declare function createAdobeIoEventsApiClient(params: IoEventsHttpClientParams):
|
|
|
1719
1717
|
};
|
|
1720
1718
|
};
|
|
1721
1719
|
}>;
|
|
1722
|
-
getAllEventProviders(httpClient: AdobeIoEventsHttpClient, params: EventProviderListAllParams, fetchOptions?:
|
|
1720
|
+
getAllEventProviders(httpClient: AdobeIoEventsHttpClient, params: EventProviderListAllParams, fetchOptions?: ky0.Options): Promise<{
|
|
1723
1721
|
embedded: {
|
|
1724
1722
|
providers: {
|
|
1725
1723
|
id: string;
|
|
@@ -1832,7 +1830,7 @@ declare function createAdobeIoEventsApiClient(params: IoEventsHttpClientParams):
|
|
|
1832
1830
|
};
|
|
1833
1831
|
};
|
|
1834
1832
|
}>;
|
|
1835
|
-
getEventProviderById(httpClient: AdobeIoEventsHttpClient, params: EventProviderGetByIdParams, fetchOptions?:
|
|
1833
|
+
getEventProviderById(httpClient: AdobeIoEventsHttpClient, params: EventProviderGetByIdParams, fetchOptions?: ky0.Options): Promise<{
|
|
1836
1834
|
id: string;
|
|
1837
1835
|
instanceId?: string | undefined;
|
|
1838
1836
|
label: string;
|
|
@@ -1928,7 +1926,7 @@ declare function createAdobeIoEventsApiClient(params: IoEventsHttpClientParams):
|
|
|
1928
1926
|
} | undefined;
|
|
1929
1927
|
};
|
|
1930
1928
|
}>;
|
|
1931
|
-
createEventProvider(httpClient: AdobeIoEventsHttpClient, params: EventProviderCreateParams, fetchOptions?:
|
|
1929
|
+
createEventProvider(httpClient: AdobeIoEventsHttpClient, params: EventProviderCreateParams, fetchOptions?: ky0.Options): Promise<{
|
|
1932
1930
|
id: string;
|
|
1933
1931
|
instanceId?: string | undefined;
|
|
1934
1932
|
label: string;
|
|
@@ -2030,7 +2028,7 @@ declare function createAdobeIoEventsApiClient(params: IoEventsHttpClientParams):
|
|
|
2030
2028
|
* @param params - The parameters to build the Adobe I/O Events HTTP client that will communicate with the Adobe I/O Events API.
|
|
2031
2029
|
* @param functions - The API functions to include in the client.
|
|
2032
2030
|
*/
|
|
2033
|
-
declare function createCustomAdobeIoEventsApiClient<TFunctions extends Record<string, ApiFunction<AdobeIoEventsHttpClient, any[], any>>>(params: IoEventsHttpClientParams, functions: TFunctions):
|
|
2031
|
+
declare function createCustomAdobeIoEventsApiClient<TFunctions extends Record<string, ApiFunction<AdobeIoEventsHttpClient, any[], any>>>(params: IoEventsHttpClientParams, functions: TFunctions): _adobe_aio_commerce_lib_api0.ApiClientRecord<AdobeIoEventsHttpClient, TFunctions>;
|
|
2034
2032
|
//#endregion
|
|
2035
2033
|
//#region source/io-events/types.d.ts
|
|
2036
2034
|
type HALLink = {
|
|
@@ -13,11 +13,11 @@
|
|
|
13
13
|
*/
|
|
14
14
|
|
|
15
15
|
import * as v from "valibot";
|
|
16
|
-
import * as
|
|
16
|
+
import * as _adobe_aio_commerce_lib_api1 from "@adobe/aio-commerce-lib-api";
|
|
17
17
|
import { AdobeCommerceHttpClient, ApiFunction, CommerceHttpClientParams } from "@adobe/aio-commerce-lib-api";
|
|
18
18
|
import { Options } from "@adobe/aio-commerce-lib-api/ky";
|
|
19
19
|
import { CamelCasedPropertiesDeep } from "type-fest";
|
|
20
|
-
import * as
|
|
20
|
+
import * as ky9 from "ky";
|
|
21
21
|
|
|
22
22
|
//#region source/commerce/api/event-providers/schema.d.ts
|
|
23
23
|
declare const EventProviderGetByIdParamsSchema: v.ObjectSchema<{
|
|
@@ -229,9 +229,9 @@ declare const UpdateEventingConfigurationParamsSchema: Omit<v.ObjectSchema<{
|
|
|
229
229
|
merchantId?: string | undefined;
|
|
230
230
|
environmentId?: string | undefined;
|
|
231
231
|
workspaceConfiguration?: string | undefined;
|
|
232
|
-
}, v.
|
|
232
|
+
}, v.StringIssue | v.BooleanIssue | v.ObjectIssue | v.ParseJsonIssue<string> | v.RecordIssue | v.RegexIssue<string> | v.EmptyIssue<string> | v.StringifyJsonIssue<{
|
|
233
233
|
[x: string]: unknown;
|
|
234
|
-
}> | v.UnionIssue<v.StringIssue | v.
|
|
234
|
+
}> | v.UnionIssue<v.StringIssue | v.ParseJsonIssue<string> | v.RecordIssue | v.EmptyIssue<string> | v.StringifyJsonIssue<{
|
|
235
235
|
[x: string]: unknown;
|
|
236
236
|
}>>>;
|
|
237
237
|
readonly '~types'?: {
|
|
@@ -253,9 +253,9 @@ declare const UpdateEventingConfigurationParamsSchema: Omit<v.ObjectSchema<{
|
|
|
253
253
|
environmentId?: string | undefined;
|
|
254
254
|
workspaceConfiguration?: string | undefined;
|
|
255
255
|
};
|
|
256
|
-
readonly issue: v.
|
|
256
|
+
readonly issue: v.StringIssue | v.BooleanIssue | v.ObjectIssue | v.ParseJsonIssue<string> | v.RecordIssue | v.RegexIssue<string> | v.EmptyIssue<string> | v.StringifyJsonIssue<{
|
|
257
257
|
[x: string]: unknown;
|
|
258
|
-
}> | v.UnionIssue<v.StringIssue | v.
|
|
258
|
+
}> | v.UnionIssue<v.StringIssue | v.ParseJsonIssue<string> | v.RecordIssue | v.EmptyIssue<string> | v.StringifyJsonIssue<{
|
|
259
259
|
[x: string]: unknown;
|
|
260
260
|
}>>;
|
|
261
261
|
} | undefined;
|
|
@@ -285,12 +285,12 @@ declare function updateEventingConfiguration(httpClient: AdobeCommerceHttpClient
|
|
|
285
285
|
* Creates a new API client for the Commerce Events API client.
|
|
286
286
|
* @param params - The parameters to build the Commerce HTTP client that will communicate with the Commerce Events API.
|
|
287
287
|
*/
|
|
288
|
-
declare function createCommerceEventsApiClient(params: CommerceHttpClientParams):
|
|
288
|
+
declare function createCommerceEventsApiClient(params: CommerceHttpClientParams): _adobe_aio_commerce_lib_api1.ApiClientRecord<AdobeCommerceHttpClient, {
|
|
289
289
|
updateEventingConfiguration: typeof updateEventingConfiguration;
|
|
290
|
-
getAllEventSubscriptions(httpClient: AdobeCommerceHttpClient, fetchOptions?:
|
|
291
|
-
createEventSubscription(httpClient: AdobeCommerceHttpClient, params: EventSubscriptionCreateParams, fetchOptions?:
|
|
292
|
-
getAllEventProviders(httpClient: AdobeCommerceHttpClient, fetchOptions?:
|
|
293
|
-
getEventProviderById(httpClient: AdobeCommerceHttpClient, params: EventProviderGetByIdParams, fetchOptions?:
|
|
290
|
+
getAllEventSubscriptions(httpClient: AdobeCommerceHttpClient, fetchOptions?: ky9.Options): Promise<CommerceEventSubscriptionManyResponse>;
|
|
291
|
+
createEventSubscription(httpClient: AdobeCommerceHttpClient, params: EventSubscriptionCreateParams, fetchOptions?: ky9.Options): Promise<void>;
|
|
292
|
+
getAllEventProviders(httpClient: AdobeCommerceHttpClient, fetchOptions?: ky9.Options): Promise<CommerceEventProviderManyResponse>;
|
|
293
|
+
getEventProviderById(httpClient: AdobeCommerceHttpClient, params: EventProviderGetByIdParams, fetchOptions?: ky9.Options): Promise<{
|
|
294
294
|
id: string;
|
|
295
295
|
providerId: string;
|
|
296
296
|
instanceId?: string | undefined;
|
|
@@ -298,7 +298,7 @@ declare function createCommerceEventsApiClient(params: CommerceHttpClientParams)
|
|
|
298
298
|
description?: string | undefined;
|
|
299
299
|
workspaceConfiguration?: string | undefined;
|
|
300
300
|
}>;
|
|
301
|
-
createEventProvider(httpClient: AdobeCommerceHttpClient, params: EventProviderCreateParams, fetchOptions?:
|
|
301
|
+
createEventProvider(httpClient: AdobeCommerceHttpClient, params: EventProviderCreateParams, fetchOptions?: ky9.Options): Promise<{
|
|
302
302
|
id: string;
|
|
303
303
|
providerId: string;
|
|
304
304
|
instanceId?: string | undefined;
|
|
@@ -312,6 +312,6 @@ declare function createCommerceEventsApiClient(params: CommerceHttpClientParams)
|
|
|
312
312
|
* @param params - The parameters to build the Commerce HTTP client that will communicate with the Commerce Events API.
|
|
313
313
|
* @param functions - The API functions to include in the client.
|
|
314
314
|
*/
|
|
315
|
-
declare function createCustomCommerceEventsApiClient<TFunctions extends Record<string, ApiFunction<AdobeCommerceHttpClient, any[], any>>>(params: CommerceHttpClientParams, functions: TFunctions):
|
|
315
|
+
declare function createCustomCommerceEventsApiClient<TFunctions extends Record<string, ApiFunction<AdobeCommerceHttpClient, any[], any>>>(params: CommerceHttpClientParams, functions: TFunctions): _adobe_aio_commerce_lib_api1.ApiClientRecord<AdobeCommerceHttpClient, TFunctions>;
|
|
316
316
|
//#endregion
|
|
317
317
|
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 };
|
|
@@ -13,12 +13,12 @@
|
|
|
13
13
|
*/
|
|
14
14
|
|
|
15
15
|
import * as v from "valibot";
|
|
16
|
-
import * as
|
|
16
|
+
import * as _adobe_aio_commerce_lib_api0 from "@adobe/aio-commerce-lib-api";
|
|
17
17
|
import { AdobeIoEventsHttpClient, ApiFunction, IoEventsHttpClientParams } from "@adobe/aio-commerce-lib-api";
|
|
18
18
|
import { Options } from "@adobe/aio-commerce-lib-api/ky";
|
|
19
19
|
import * as type_fest0 from "type-fest";
|
|
20
20
|
import { CamelCasedPropertiesDeep, OmitDeep } from "type-fest";
|
|
21
|
-
import * as
|
|
21
|
+
import * as ky0 from "ky";
|
|
22
22
|
|
|
23
23
|
//#region source/io-events/api/event-metadata/schema.d.ts
|
|
24
24
|
/** The schema of the parameters received by the GET `providers/:id/eventmetadata` Adobe I/O Events API endpoint. */
|
|
@@ -39,9 +39,7 @@ declare const CreateEventMetadataForProviderSchema: v.ObjectSchema<{
|
|
|
39
39
|
readonly label: v.StringSchema<`Expected a string value for property '${string}'`>;
|
|
40
40
|
readonly description: v.StringSchema<`Expected a string value for property '${string}'`>;
|
|
41
41
|
readonly eventCode: v.StringSchema<`Expected a string value for property '${string}'`>;
|
|
42
|
-
readonly sampleEventTemplate: v.OptionalSchema<v.SchemaWithPipe<readonly [v.UnionSchema<[v.SchemaWithPipe<readonly [v.StringSchema<`Expected a string value for property '${string}'`>, v.TransformAction<string, string>, v.ParseJsonAction<string, undefined, `Expected valid JSON string for property '${string}'`>, v.RecordSchema<v.StringSchema<undefined>, v.UnknownSchema, undefined>, v.StringifyJsonAction<{
|
|
43
|
-
[x: string]: unknown;
|
|
44
|
-
}, undefined, undefined>]>, v.RecordSchema<v.StringSchema<undefined>, v.UnknownSchema, undefined>, v.ArraySchema<v.UnknownSchema, undefined>], undefined>, v.StringifyJsonAction<string | unknown[] | {
|
|
42
|
+
readonly sampleEventTemplate: v.OptionalSchema<v.SchemaWithPipe<readonly [v.UnionSchema<[v.SchemaWithPipe<readonly [v.StringSchema<`Expected a string value for property '${string}'`>, v.TransformAction<string, string>, v.ParseJsonAction<string, undefined, `Expected valid JSON string for property '${string}'`>, v.RecordSchema<v.StringSchema<undefined>, v.UnknownSchema, undefined>]>, v.RecordSchema<v.StringSchema<undefined>, v.UnknownSchema, undefined>, v.ArraySchema<v.UnknownSchema, undefined>], undefined>, v.StringifyJsonAction<unknown[] | {
|
|
45
43
|
[x: string]: unknown;
|
|
46
44
|
}, undefined, `Expected valid JSON data for property '${string}'`>, v.TransformAction<string, string>]>, undefined>;
|
|
47
45
|
}, undefined>;
|
|
@@ -1121,8 +1119,8 @@ declare function create3rdPartyCustomEventProvider(httpClient: AdobeIoEventsHttp
|
|
|
1121
1119
|
* Creates a new API client for the Adobe I/O Events API client.
|
|
1122
1120
|
* @param params - The parameters to build the Adobe I/O Events HTTP client that will communicate with the Adobe I/O Events API.
|
|
1123
1121
|
*/
|
|
1124
|
-
declare function createAdobeIoEventsApiClient(params: IoEventsHttpClientParams):
|
|
1125
|
-
getAllCommerceEventProviders(httpClient: AdobeIoEventsHttpClient, params: type_fest0.OmitDeep<EventProviderListAllParams, "filterBy.providerType">, fetchOptions?:
|
|
1122
|
+
declare function createAdobeIoEventsApiClient(params: IoEventsHttpClientParams): _adobe_aio_commerce_lib_api0.ApiClientRecord<AdobeIoEventsHttpClient, {
|
|
1123
|
+
getAllCommerceEventProviders(httpClient: AdobeIoEventsHttpClient, params: type_fest0.OmitDeep<EventProviderListAllParams, "filterBy.providerType">, fetchOptions?: ky0.Options): Promise<{
|
|
1126
1124
|
embedded: {
|
|
1127
1125
|
providers: {
|
|
1128
1126
|
id: string;
|
|
@@ -1235,7 +1233,7 @@ declare function createAdobeIoEventsApiClient(params: IoEventsHttpClientParams):
|
|
|
1235
1233
|
};
|
|
1236
1234
|
};
|
|
1237
1235
|
}>;
|
|
1238
|
-
getAll3rdPartyCustomEventProviders(httpClient: AdobeIoEventsHttpClient, params: type_fest0.OmitDeep<EventProviderListAllParams, "filterBy.providerType">, fetchOptions?:
|
|
1236
|
+
getAll3rdPartyCustomEventProviders(httpClient: AdobeIoEventsHttpClient, params: type_fest0.OmitDeep<EventProviderListAllParams, "filterBy.providerType">, fetchOptions?: ky0.Options): Promise<{
|
|
1239
1237
|
embedded: {
|
|
1240
1238
|
providers: {
|
|
1241
1239
|
id: string;
|
|
@@ -1348,7 +1346,7 @@ declare function createAdobeIoEventsApiClient(params: IoEventsHttpClientParams):
|
|
|
1348
1346
|
};
|
|
1349
1347
|
};
|
|
1350
1348
|
}>;
|
|
1351
|
-
createCommerceEventProvider(httpClient: AdobeIoEventsHttpClient, params: type_fest0.OmitDeep<EventProviderCreateParams, "providerType">, fetchOptions?:
|
|
1349
|
+
createCommerceEventProvider(httpClient: AdobeIoEventsHttpClient, params: type_fest0.OmitDeep<EventProviderCreateParams, "providerType">, fetchOptions?: ky0.Options): Promise<{
|
|
1352
1350
|
id: string;
|
|
1353
1351
|
instanceId?: string | undefined;
|
|
1354
1352
|
label: string;
|
|
@@ -1444,7 +1442,7 @@ declare function createAdobeIoEventsApiClient(params: IoEventsHttpClientParams):
|
|
|
1444
1442
|
} | undefined;
|
|
1445
1443
|
};
|
|
1446
1444
|
}>;
|
|
1447
|
-
create3rdPartyCustomEventProvider(httpClient: AdobeIoEventsHttpClient, params: type_fest0.OmitDeep<EventProviderCreateParams, "providerType">, fetchOptions?:
|
|
1445
|
+
create3rdPartyCustomEventProvider(httpClient: AdobeIoEventsHttpClient, params: type_fest0.OmitDeep<EventProviderCreateParams, "providerType">, fetchOptions?: ky0.Options): Promise<{
|
|
1448
1446
|
id: string;
|
|
1449
1447
|
instanceId?: string | undefined;
|
|
1450
1448
|
label: string;
|
|
@@ -1540,7 +1538,7 @@ declare function createAdobeIoEventsApiClient(params: IoEventsHttpClientParams):
|
|
|
1540
1538
|
} | undefined;
|
|
1541
1539
|
};
|
|
1542
1540
|
}>;
|
|
1543
|
-
getAllEventMetadataForProvider(httpClient: AdobeIoEventsHttpClient, params: GetAllEventMetadataForProviderParams, fetchOptions?:
|
|
1541
|
+
getAllEventMetadataForProvider(httpClient: AdobeIoEventsHttpClient, params: GetAllEventMetadataForProviderParams, fetchOptions?: ky0.Options): Promise<{
|
|
1544
1542
|
embedded: {
|
|
1545
1543
|
description: string;
|
|
1546
1544
|
label: string;
|
|
@@ -1601,7 +1599,7 @@ declare function createAdobeIoEventsApiClient(params: IoEventsHttpClientParams):
|
|
|
1601
1599
|
};
|
|
1602
1600
|
}[];
|
|
1603
1601
|
}>;
|
|
1604
|
-
getEventMetadataForEventAndProvider(httpClient: AdobeIoEventsHttpClient, params: GetEventMetadataForEventAndProviderParams, fetchOptions?:
|
|
1602
|
+
getEventMetadataForEventAndProvider(httpClient: AdobeIoEventsHttpClient, params: GetEventMetadataForEventAndProviderParams, fetchOptions?: ky0.Options): Promise<{
|
|
1605
1603
|
description: string;
|
|
1606
1604
|
label: string;
|
|
1607
1605
|
eventCode: string;
|
|
@@ -1660,7 +1658,7 @@ declare function createAdobeIoEventsApiClient(params: IoEventsHttpClientParams):
|
|
|
1660
1658
|
};
|
|
1661
1659
|
};
|
|
1662
1660
|
}>;
|
|
1663
|
-
createEventMetadataForProvider(httpClient: AdobeIoEventsHttpClient, params: CreateEventMetadataForProviderParams, fetchOptions?:
|
|
1661
|
+
createEventMetadataForProvider(httpClient: AdobeIoEventsHttpClient, params: CreateEventMetadataForProviderParams, fetchOptions?: ky0.Options): Promise<{
|
|
1664
1662
|
description: string;
|
|
1665
1663
|
label: string;
|
|
1666
1664
|
eventCode: string;
|
|
@@ -1719,7 +1717,7 @@ declare function createAdobeIoEventsApiClient(params: IoEventsHttpClientParams):
|
|
|
1719
1717
|
};
|
|
1720
1718
|
};
|
|
1721
1719
|
}>;
|
|
1722
|
-
getAllEventProviders(httpClient: AdobeIoEventsHttpClient, params: EventProviderListAllParams, fetchOptions?:
|
|
1720
|
+
getAllEventProviders(httpClient: AdobeIoEventsHttpClient, params: EventProviderListAllParams, fetchOptions?: ky0.Options): Promise<{
|
|
1723
1721
|
embedded: {
|
|
1724
1722
|
providers: {
|
|
1725
1723
|
id: string;
|
|
@@ -1832,7 +1830,7 @@ declare function createAdobeIoEventsApiClient(params: IoEventsHttpClientParams):
|
|
|
1832
1830
|
};
|
|
1833
1831
|
};
|
|
1834
1832
|
}>;
|
|
1835
|
-
getEventProviderById(httpClient: AdobeIoEventsHttpClient, params: EventProviderGetByIdParams, fetchOptions?:
|
|
1833
|
+
getEventProviderById(httpClient: AdobeIoEventsHttpClient, params: EventProviderGetByIdParams, fetchOptions?: ky0.Options): Promise<{
|
|
1836
1834
|
id: string;
|
|
1837
1835
|
instanceId?: string | undefined;
|
|
1838
1836
|
label: string;
|
|
@@ -1928,7 +1926,7 @@ declare function createAdobeIoEventsApiClient(params: IoEventsHttpClientParams):
|
|
|
1928
1926
|
} | undefined;
|
|
1929
1927
|
};
|
|
1930
1928
|
}>;
|
|
1931
|
-
createEventProvider(httpClient: AdobeIoEventsHttpClient, params: EventProviderCreateParams, fetchOptions?:
|
|
1929
|
+
createEventProvider(httpClient: AdobeIoEventsHttpClient, params: EventProviderCreateParams, fetchOptions?: ky0.Options): Promise<{
|
|
1932
1930
|
id: string;
|
|
1933
1931
|
instanceId?: string | undefined;
|
|
1934
1932
|
label: string;
|
|
@@ -2030,7 +2028,7 @@ declare function createAdobeIoEventsApiClient(params: IoEventsHttpClientParams):
|
|
|
2030
2028
|
* @param params - The parameters to build the Adobe I/O Events HTTP client that will communicate with the Adobe I/O Events API.
|
|
2031
2029
|
* @param functions - The API functions to include in the client.
|
|
2032
2030
|
*/
|
|
2033
|
-
declare function createCustomAdobeIoEventsApiClient<TFunctions extends Record<string, ApiFunction<AdobeIoEventsHttpClient, any[], any>>>(params: IoEventsHttpClientParams, functions: TFunctions):
|
|
2031
|
+
declare function createCustomAdobeIoEventsApiClient<TFunctions extends Record<string, ApiFunction<AdobeIoEventsHttpClient, any[], any>>>(params: IoEventsHttpClientParams, functions: TFunctions): _adobe_aio_commerce_lib_api0.ApiClientRecord<AdobeIoEventsHttpClient, TFunctions>;
|
|
2034
2032
|
//#endregion
|
|
2035
2033
|
//#region source/io-events/types.d.ts
|
|
2036
2034
|
type HALLink = {
|
|
@@ -11,4 +11,4 @@
|
|
|
11
11
|
* OF ANY KIND, either express or implied. See the License for the specific language
|
|
12
12
|
* governing permissions and limitations under the License.
|
|
13
13
|
*/
|
|
14
|
-
import{a as parseOrThrow,i as stringValueSchema,o as __export,r as booleanValueSchema}from"../schemas-BLvngVRY.js";import{buildCamelCaseKeysResponseHook}from"@adobe/aio-commerce-lib-api/utils/transformations";import*as v from"valibot";import{AdobeIoEventsHttpClient,ApiClient}from"@adobe/aio-commerce-lib-api";const BASE64_ENCODED_STRING_REGEX=/^[A-Za-z0-9+/]*={0,2}$/;function isBase64EncodedString(value){return BASE64_ENCODED_STRING_REGEX.test(value)&&value.length%4==0}function encodeToBase64(value){return Buffer.from(value).toString(`base64`)}function tryDecodeFromBase64(value){return isBase64EncodedString(value)?Buffer.from(value,`base64`).toString(`utf-8`):value}function sampleEventTemplateSchema(fieldName){return v.pipe(v.union([v.pipe(stringValueSchema(fieldName),v.transform(tryDecodeFromBase64),v.parseJson(void 0,`Expected valid JSON string for property '${fieldName}'`),v.record(v.string(),v.unknown())
|
|
14
|
+
import{a as parseOrThrow,i as stringValueSchema,o as __export,r as booleanValueSchema}from"../schemas-BLvngVRY.js";import{buildCamelCaseKeysResponseHook}from"@adobe/aio-commerce-lib-api/utils/transformations";import*as v from"valibot";import{AdobeIoEventsHttpClient,ApiClient}from"@adobe/aio-commerce-lib-api";const BASE64_ENCODED_STRING_REGEX=/^[A-Za-z0-9+/]*={0,2}$/;function isBase64EncodedString(value){return BASE64_ENCODED_STRING_REGEX.test(value)&&value.length%4==0}function encodeToBase64(value){return Buffer.from(value).toString(`base64`)}function tryDecodeFromBase64(value){return isBase64EncodedString(value)?Buffer.from(value,`base64`).toString(`utf-8`):value}function sampleEventTemplateSchema(fieldName){return v.pipe(v.union([v.pipe(stringValueSchema(fieldName),v.transform(tryDecodeFromBase64),v.parseJson(void 0,`Expected valid JSON string for property '${fieldName}'`),v.record(v.string(),v.unknown())),v.record(v.string(),v.unknown()),v.array(v.unknown())]),v.stringifyJson(void 0,`Expected valid JSON data for property '${fieldName}'`),v.transform(encodeToBase64))}const GetAllEventMetadataForProviderSchema=v.object({providerId:stringValueSchema(`providerId`)}),GetEventMetadataForEventAndProviderSchema=v.object({eventCode:stringValueSchema(`eventCode`),providerId:stringValueSchema(`providerId`)}),CreateEventMetadataForProviderSchema=v.object({consumerOrgId:stringValueSchema(`consumerOrgId`),projectId:stringValueSchema(`projectId`),workspaceId:stringValueSchema(`workspaceId`),providerId:stringValueSchema(`providerId`),label:stringValueSchema(`label`),description:stringValueSchema(`description`),eventCode:stringValueSchema(`eventCode`),sampleEventTemplate:v.optional(sampleEventTemplateSchema(`sampleEventTemplate`))});var endpoints_exports=__export({createEventMetadataForProvider:()=>createEventMetadataForProvider,getAllEventMetadataForProvider:()=>getAllEventMetadataForProvider,getEventMetadataForEventAndProvider:()=>getEventMetadataForEventAndProvider});async function getAllEventMetadataForProvider(httpClient,params,fetchOptions){let validatedParams=parseOrThrow(GetAllEventMetadataForProviderSchema,params);return httpClient.extend({hooks:{afterResponse:[buildCamelCaseKeysResponseHook()]}}).get(`providers/${validatedParams.providerId}/eventmetadata`,fetchOptions).json()}async function getEventMetadataForEventAndProvider(httpClient,params,fetchOptions){let validatedParams=parseOrThrow(GetEventMetadataForEventAndProviderSchema,params);return httpClient.extend({hooks:{afterResponse:[buildCamelCaseKeysResponseHook()]}}).get(`providers/${validatedParams.providerId}/eventmetadata/${validatedParams.eventCode}`,fetchOptions).json()}async function createEventMetadataForProvider(httpClient,params,fetchOptions){let validatedParams=parseOrThrow(CreateEventMetadataForProviderSchema,params);return httpClient.extend({hooks:{afterResponse:[buildCamelCaseKeysResponseHook()]}}).post(`${validatedParams.consumerOrgId}/${validatedParams.projectId}/${validatedParams.workspaceId}/providers/${validatedParams.providerId}/eventmetadata`,{...fetchOptions,json:{label:validatedParams.label,description:validatedParams.description,event_code:validatedParams.eventCode,sample_event_template:validatedParams.sampleEventTemplate}}).json()}function setQueryParamIfTruthy(queryParams,key,value){value&&queryParams.set(key,`${value}`)}function setArrayQueryParam(queryParams,key,values){if(values!==void 0&&values.length>0)for(let value of values)queryParams.set(key,`${value}`)}const VALID_EVENT_PROVIDER_TYPES=[`dx_commerce_events`,`3rd_party_custom_events`],VALID_DATA_RESIDENCY_REGIONS=[`va6`,`irl1`],EventProviderTypeSchema=v.picklist(VALID_EVENT_PROVIDER_TYPES),DataResidencyRegionSchema=v.picklist(VALID_DATA_RESIDENCY_REGIONS),EventProviderListAllParamsSchema=v.object({consumerOrgId:stringValueSchema(`consumerOrgId`),withEventMetadata:v.optional(booleanValueSchema(`withEventMetadata`)),filterBy:v.optional(v.object({instanceId:v.optional(stringValueSchema(`instanceId`)),providerTypes:v.optional(v.union([v.array(EventProviderTypeSchema,`Expected an array of event provider types`)]))}))}),EventProviderGetByIdParamsSchema=v.object({providerId:stringValueSchema(`providerId`),withEventMetadata:v.optional(booleanValueSchema(`withEventMetadata`))}),EventProviderCreateParamsSchema=v.object({consumerOrgId:stringValueSchema(`consumerOrgId`),projectId:stringValueSchema(`projectId`),workspaceId:stringValueSchema(`workspaceId`),label:stringValueSchema(`label`),description:v.optional(stringValueSchema(`description`)),docsUrl:v.optional(stringValueSchema(`docsUrl`)),instanceId:v.optional(stringValueSchema(`instanceId`)),providerType:v.optional(EventProviderTypeSchema),dataResidencyRegion:v.optional(DataResidencyRegionSchema)});var endpoints_exports$1=__export({createEventProvider:()=>createEventProvider,getAllEventProviders:()=>getAllEventProviders,getEventProviderById:()=>getEventProviderById});async function getAllEventProviders(httpClient,params,fetchOptions){let validatedParams=parseOrThrow(EventProviderListAllParamsSchema,params),queryParams=new URLSearchParams,{providerTypes=[],instanceId}=validatedParams.filterBy??{};return setArrayQueryParam(queryParams,`providerMetadataIds`,providerTypes),setQueryParamIfTruthy(queryParams,`instanceId`,instanceId),setQueryParamIfTruthy(queryParams,`eventmetadata`,validatedParams.withEventMetadata),httpClient.extend({hooks:{afterResponse:[buildCamelCaseKeysResponseHook()]}}).get(`${validatedParams.consumerOrgId}/providers`,{...fetchOptions,searchParams:queryParams}).json()}async function getEventProviderById(httpClient,params,fetchOptions){let validatedParams=parseOrThrow(EventProviderGetByIdParamsSchema,params),searchParams=new URLSearchParams;return setQueryParamIfTruthy(searchParams,`eventmetadata`,validatedParams.withEventMetadata),httpClient.extend({hooks:{afterResponse:[buildCamelCaseKeysResponseHook()]}}).get(`providers/${params.providerId}`,{...fetchOptions,searchParams}).json()}async function createEventProvider(httpClient,params,fetchOptions){let validatedParams=parseOrThrow(EventProviderCreateParamsSchema,params);return httpClient.extend({hooks:{afterResponse:[buildCamelCaseKeysResponseHook()]}}).post(`${validatedParams.consumerOrgId}/${validatedParams.projectId}/${validatedParams.workspaceId}/providers`,{...fetchOptions,json:{...validatedParams,docs_url:validatedParams.docsUrl,provider_metadata:validatedParams.providerType,instance_id:validatedParams.instanceId,data_residency_region:validatedParams.dataResidencyRegion}}).json()}var shorthands_exports=__export({create3rdPartyCustomEventProvider:()=>create3rdPartyCustomEventProvider,createCommerceEventProvider:()=>createCommerceEventProvider,getAll3rdPartyCustomEventProviders:()=>getAll3rdPartyCustomEventProviders,getAllCommerceEventProviders:()=>getAllCommerceEventProviders});async function getAllCommerceEventProviders(httpClient,params,fetchOptions){return getAllEventProviders(httpClient,{...params,filterBy:{...params.filterBy,providerTypes:[`dx_commerce_events`]}},fetchOptions)}async function getAll3rdPartyCustomEventProviders(httpClient,params,fetchOptions){return getAllEventProviders(httpClient,{...params,filterBy:{...params.filterBy,providerTypes:[`3rd_party_custom_events`]}},fetchOptions)}async function createCommerceEventProvider(httpClient,params,fetchOptions){return createEventProvider(httpClient,{...params,providerType:`dx_commerce_events`},fetchOptions)}async function create3rdPartyCustomEventProvider(httpClient,params,fetchOptions){return createEventProvider(httpClient,{...params,providerType:`3rd_party_custom_events`},fetchOptions)}function createAdobeIoEventsApiClient(params){return ApiClient.create(new AdobeIoEventsHttpClient(params),{...endpoints_exports$1,...endpoints_exports,...shorthands_exports})}function createCustomAdobeIoEventsApiClient(params,functions){return ApiClient.create(new AdobeIoEventsHttpClient(params),functions)}export{create3rdPartyCustomEventProvider,createAdobeIoEventsApiClient,createCommerceEventProvider,createCustomAdobeIoEventsApiClient,createEventMetadataForProvider,createEventProvider,getAll3rdPartyCustomEventProviders,getAllCommerceEventProviders,getAllEventMetadataForProvider,getAllEventProviders,getEventMetadataForEventAndProvider,getEventProviderById};
|
package/package.json
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
"name": "@adobe/aio-commerce-lib-events",
|
|
3
3
|
"type": "module",
|
|
4
4
|
"author": "Adobe Inc.",
|
|
5
|
-
"version": "0.3.
|
|
5
|
+
"version": "0.3.2",
|
|
6
6
|
"private": false,
|
|
7
7
|
"engines": {
|
|
8
8
|
"node": ">=20 <=24"
|
|
@@ -62,14 +62,14 @@
|
|
|
62
62
|
],
|
|
63
63
|
"dependencies": {
|
|
64
64
|
"valibot": "^1.1.0",
|
|
65
|
-
"@adobe/aio-commerce-lib-auth": "0.
|
|
66
|
-
"@adobe/aio-commerce-lib-core": "0.
|
|
67
|
-
"@adobe/aio-commerce-lib-api": "0.
|
|
65
|
+
"@adobe/aio-commerce-lib-auth": "0.6.0",
|
|
66
|
+
"@adobe/aio-commerce-lib-core": "0.5.0",
|
|
67
|
+
"@adobe/aio-commerce-lib-api": "0.3.0"
|
|
68
68
|
},
|
|
69
69
|
"devDependencies": {
|
|
70
70
|
"msw": "^2.11.1",
|
|
71
|
-
"@aio-commerce-sdk/config-tsdown": "1.0.0",
|
|
72
71
|
"@aio-commerce-sdk/config-typedoc": "1.0.0",
|
|
72
|
+
"@aio-commerce-sdk/config-tsdown": "1.0.0",
|
|
73
73
|
"@aio-commerce-sdk/config-typescript": "1.0.0",
|
|
74
74
|
"@aio-commerce-sdk/config-vitest": "1.0.0"
|
|
75
75
|
},
|