@contentful/optimization-api-client 1.1.0 → 2.0.0

package/dist/guards.d.mts

@@ -0,0 +1,103 @@
+import * as z from 'zod/mini';
+
+/**
+ * Union of supported change types.
+ *
+ * @public
+ */
+declare const Change: z.ZodMiniDiscriminatedUnion<[z.ZodMiniObject<{
+    key: z.ZodMiniString<string>;
+    meta: z.ZodMiniObject<{
+        /**
+         * Identifier of the personalization or experiment experience.
+         */
+        experienceId: z.ZodMiniString<string>;
+        /**
+         * Index of the variant within the experience configuration.
+         *
+         * @remarks
+         * Typically corresponds to the array index in the experience's distribution.
+         */
+        variantIndex: z.ZodMiniNumber<number>;
+    }, z.core.$strip>;
+    type: z.ZodMiniLiteral<"Variable">;
+    value: z.ZodMiniUnion<readonly [z.ZodMiniString<string>, z.ZodMiniBoolean<boolean>, z.ZodMiniNull, z.ZodMiniNumber<number>, z.ZodMiniRecord<z.ZodMiniString<string>, z.ZodMiniJSONSchema>]>;
+}, z.core.$strip>, z.ZodMiniObject<{
+    id: z.ZodMiniString<string>;
+    variantId: z.ZodMiniString<string>;
+    meta: z.ZodMiniObject<{
+        /**
+         * Identifier of the optimization that produced this change.
+         */
+        optimizationId: z.ZodMiniString<string>;
+        /**
+         * Index of the variant within the optimization's distribution.
+         */
+        variantIndex: z.ZodMiniNumber<number>;
+    }, z.core.$strip>;
+    type: z.ZodMiniLiteral<"Experience">;
+}, z.core.$strip>, z.ZodMiniObject<{
+    id: z.ZodMiniString<string>;
+    variantId: z.ZodMiniString<string>;
+    meta: z.ZodMiniObject<{
+        /**
+         * Identifier of the optimization that produced this change.
+         */
+        optimizationId: z.ZodMiniString<string>;
+        /**
+         * Index of the variant within the optimization's distribution.
+         */
+        variantIndex: z.ZodMiniNumber<number>;
+    }, z.core.$strip>;
+    type: z.ZodMiniLiteral<"Fragment">;
+}, z.core.$strip>], "type">;
+
+/**
+ * TypeScript type inferred from {@link Change}.
+ *
+ * @public
+ */
+declare type Change = z.infer<typeof Change>;
+
+/**
+ * Determines whether a change represents a variable-backed optimization.
+ *
+ * @public
+ */
+export declare function isVariableChange(change: Change): change is VariableChange;
+
+/**
+ * Zod schema representing a change whose type is `'Variable'`.
+ *
+ * @remarks
+ * The `value` must conform to {@link VariableChangeValue}.
+ *
+ * @public
+ */
+declare const VariableChange: z.ZodMiniObject<{
+    key: z.ZodMiniString<string>;
+    meta: z.ZodMiniObject<{
+        /**
+         * Identifier of the personalization or experiment experience.
+         */
+        experienceId: z.ZodMiniString<string>;
+        /**
+         * Index of the variant within the experience configuration.
+         *
+         * @remarks
+         * Typically corresponds to the array index in the experience's distribution.
+         */
+        variantIndex: z.ZodMiniNumber<number>;
+    }, z.core.$strip>;
+    type: z.ZodMiniLiteral<"Variable">;
+    value: z.ZodMiniUnion<readonly [z.ZodMiniString<string>, z.ZodMiniBoolean<boolean>, z.ZodMiniNull, z.ZodMiniNumber<number>, z.ZodMiniRecord<z.ZodMiniString<string>, z.ZodMiniJSONSchema>]>;
+}, z.core.$strip>;
+
+/**
+ * TypeScript type inferred from {@link VariableChange}.
+ *
+ * @public
+ */
+declare type VariableChange = z.infer<typeof VariableChange>;
+
+export { }

package/dist/guards.d.ts

@@ -0,0 +1,103 @@
+import * as z from 'zod/mini';
+
+/**
+ * Union of supported change types.
+ *
+ * @public
+ */
+declare const Change: z.ZodMiniDiscriminatedUnion<[z.ZodMiniObject<{
+    key: z.ZodMiniString<string>;
+    meta: z.ZodMiniObject<{
+        /**
+         * Identifier of the personalization or experiment experience.
+         */
+        experienceId: z.ZodMiniString<string>;
+        /**
+         * Index of the variant within the experience configuration.
+         *
+         * @remarks
+         * Typically corresponds to the array index in the experience's distribution.
+         */
+        variantIndex: z.ZodMiniNumber<number>;
+    }, z.core.$strip>;
+    type: z.ZodMiniLiteral<"Variable">;
+    value: z.ZodMiniUnion<readonly [z.ZodMiniString<string>, z.ZodMiniBoolean<boolean>, z.ZodMiniNull, z.ZodMiniNumber<number>, z.ZodMiniRecord<z.ZodMiniString<string>, z.ZodMiniJSONSchema>]>;
+}, z.core.$strip>, z.ZodMiniObject<{
+    id: z.ZodMiniString<string>;
+    variantId: z.ZodMiniString<string>;
+    meta: z.ZodMiniObject<{
+        /**
+         * Identifier of the optimization that produced this change.
+         */
+        optimizationId: z.ZodMiniString<string>;
+        /**
+         * Index of the variant within the optimization's distribution.
+         */
+        variantIndex: z.ZodMiniNumber<number>;
+    }, z.core.$strip>;
+    type: z.ZodMiniLiteral<"Experience">;
+}, z.core.$strip>, z.ZodMiniObject<{
+    id: z.ZodMiniString<string>;
+    variantId: z.ZodMiniString<string>;
+    meta: z.ZodMiniObject<{
+        /**
+         * Identifier of the optimization that produced this change.
+         */
+        optimizationId: z.ZodMiniString<string>;
+        /**
+         * Index of the variant within the optimization's distribution.
+         */
+        variantIndex: z.ZodMiniNumber<number>;
+    }, z.core.$strip>;
+    type: z.ZodMiniLiteral<"Fragment">;
+}, z.core.$strip>], "type">;
+
+/**
+ * TypeScript type inferred from {@link Change}.
+ *
+ * @public
+ */
+declare type Change = z.infer<typeof Change>;
+
+/**
+ * Determines whether a change represents a variable-backed optimization.
+ *
+ * @public
+ */
+export declare function isVariableChange(change: Change): change is VariableChange;
+
+/**
+ * Zod schema representing a change whose type is `'Variable'`.
+ *
+ * @remarks
+ * The `value` must conform to {@link VariableChangeValue}.
+ *
+ * @public
+ */
+declare const VariableChange: z.ZodMiniObject<{
+    key: z.ZodMiniString<string>;
+    meta: z.ZodMiniObject<{
+        /**
+         * Identifier of the personalization or experiment experience.
+         */
+        experienceId: z.ZodMiniString<string>;
+        /**
+         * Index of the variant within the experience configuration.
+         *
+         * @remarks
+         * Typically corresponds to the array index in the experience's distribution.
+         */
+        variantIndex: z.ZodMiniNumber<number>;
+    }, z.core.$strip>;
+    type: z.ZodMiniLiteral<"Variable">;
+    value: z.ZodMiniUnion<readonly [z.ZodMiniString<string>, z.ZodMiniBoolean<boolean>, z.ZodMiniNull, z.ZodMiniNumber<number>, z.ZodMiniRecord<z.ZodMiniString<string>, z.ZodMiniJSONSchema>]>;
+}, z.core.$strip>;
+
+/**
+ * TypeScript type inferred from {@link VariableChange}.
+ *
+ * @public
+ */
+declare type VariableChange = z.infer<typeof VariableChange>;
+
+export { }

package/dist/guards.mjs

@@ -0,0 +1 @@
+export { isVariableChange } from "./u~0.mjs";

package/dist/index.cjs

@@ -1,17 +1,14 @@
 "use strict";
 var __webpack_modules__ = {
     "./src/lib/logger/LogSink.ts" (__unused_rspack_module, __webpack_exports__, __webpack_require__) {
-        __webpack_require__.d(__webpack_exports__, {
-            A: ()=>__rspack_default_export
-        });
         class LogSink {
         }
         const __rspack_default_export = LogSink;
+        __webpack_require__.d(__webpack_exports__, {}, {
+            A: __rspack_default_export
+        });
     },
     "./src/lib/logger/logging.ts" (__unused_rspack_module, __webpack_exports__, __webpack_require__) {
-        __webpack_require__.d(__webpack_exports__, {
-            A: ()=>logLevelSeverity
-        });
         const logLevelSeverity = {
             fatal: 60,
             error: 50,
@@ -20,6 +17,9 @@ var __webpack_modules__ = {
             debug: 20,
             log: 10
         };
+        __webpack_require__.d(__webpack_exports__, {}, {
+            A: logLevelSeverity
+        });
     },
     "./src/logger.ts" (__unused_rspack_module, __webpack_exports__, __webpack_require__) {
         __webpack_require__.d(__webpack_exports__, {
@@ -124,11 +124,15 @@ function __webpack_require__(moduleId) {
     return module.exports;
 }
 (()=>{
-    __webpack_require__.d = (exports1, definition)=>{
-        for(var key in definition)if (__webpack_require__.o(definition, key) && !__webpack_require__.o(exports1, key)) Object.defineProperty(exports1, key, {
-            enumerable: true,
-            get: definition[key]
-        });
+    __webpack_require__.d = (exports1, getters, values)=>{
+        var define = (defs, kind)=>{
+            for(var key in defs)if (__webpack_require__.o(defs, key) && !__webpack_require__.o(exports1, key)) Object.defineProperty(exports1, key, {
+                enumerable: true,
+                [kind]: defs[key]
+            });
+        };
+        define(getters, "get");
+        define(values, "value");
     };
 })();
 (()=>{
@@ -148,16 +152,17 @@ var __webpack_exports__ = {};
 (()=>{
     __webpack_require__.r(__webpack_exports__);
     __webpack_require__.d(__webpack_exports__, {
-        createTimeoutFetchMethod: ()=>createTimeoutFetchMethod,
-        ExperienceApiClient: ()=>ExperienceApiClient,
-        createProtectedFetchMethod: ()=>createProtectedFetchMethod,
-        EXPERIENCE_BASE_URL: ()=>EXPERIENCE_BASE_URL,
         ApiClient: ()=>ApiClient,
+        EXPERIENCE_BASE_URL: ()=>EXPERIENCE_BASE_URL,
+        ExperienceApiClient: ()=>ExperienceApiClient,
         INSIGHTS_BASE_URL: ()=>INSIGHTS_BASE_URL,
+        InsightsApiClient: ()=>InsightsApiClient,
+        createProtectedFetchMethod: ()=>createProtectedFetchMethod,
         createRetryFetchMethod: ()=>createRetryFetchMethod,
-        InsightsApiClient: ()=>InsightsApiClient
+        createTimeoutFetchMethod: ()=>createTimeoutFetchMethod,
+        isVariableChange: ()=>isVariableChange
     });
-    const optimization_api_schemas_namespaceObject = require("@contentful/optimization-api-schemas");
+    const api_schemas_namespaceObject = require("@contentful/optimization-api-client/api-schemas");
     var logger = __webpack_require__("./src/logger.ts");
     const fetchInputToString = (input)=>{
         if ('string' == typeof input) return input;
@@ -290,14 +295,14 @@ var __webpack_exports__ = {};
     const fetch_Fetch = Fetch;
     const fetch = fetch_Fetch;
     const ApiClientBase_logger = (0, logger.createScopedLogger)('ApiClient');
-    const DEFAULT_ENVIRONMENT = 'main';
+    const DEFAULT_ENVIRONMENT = 'master';
     class ApiClientBase {
         name;
-        clientId;
+        spaceId;
         environment;
         fetch;
-        constructor(name, { fetchOptions, clientId, environment }){
-            this.clientId = clientId;
+        constructor(name, { fetchOptions, spaceId, environment }){
+            this.spaceId = spaceId;
             this.environment = environment ?? DEFAULT_ENVIRONMENT;
             this.name = name;
             this.fetch = fetch.create({
@@ -338,10 +343,10 @@ var __webpack_exports__ = {};
             const requestName = 'Get Profile';
             ExperienceApiClient_logger.info(`Sending "${requestName}" request`);
             try {
-                const response = await this.fetch(this.constructUrl(`v2/organizations/${this.clientId}/environments/${this.environment}/profiles/${id}`, options), {
+                const response = await this.fetch(this.constructUrl(`v3/spaces/${this.spaceId}/environments/${this.environment}/profiles/${id}`, options), {
                     method: 'GET'
                 });
-                const { data: { changes, experiences, profile } } = (0, optimization_api_schemas_namespaceObject.parseWithFriendlyError)(optimization_api_schemas_namespaceObject.ExperienceResponse, await response.json());
+                const { data: { changes, experiences, profile } } = (0, api_schemas_namespaceObject.parseWithFriendlyError)(api_schemas_namespaceObject.ExperienceResponse, await response.json());
                 const data = {
                     changes,
                     selectedOptimizations: experiences,
@@ -371,11 +376,11 @@ var __webpack_exports__ = {};
             ExperienceApiClient_logger.debug(`"${requestName}" request body:`, body);
             try {
                 const response = await this.makeProfileMutationRequest({
-                    url: `v2/organizations/${this.clientId}/environments/${this.environment}/profiles`,
+                    url: `v3/spaces/${this.spaceId}/environments/${this.environment}/profiles`,
                     body,
                     options
                 });
-                const { data: { changes, experiences, profile } } = (0, optimization_api_schemas_namespaceObject.parseWithFriendlyError)(optimization_api_schemas_namespaceObject.ExperienceResponse, await response.json());
+                const { data: { changes, experiences, profile } } = (0, api_schemas_namespaceObject.parseWithFriendlyError)(api_schemas_namespaceObject.ExperienceResponse, await response.json());
                 const data = {
                     changes,
                     selectedOptimizations: experiences,
@@ -398,11 +403,11 @@ var __webpack_exports__ = {};
             ExperienceApiClient_logger.debug(`"${requestName}" request body:`, body);
             try {
                 const response = await this.makeProfileMutationRequest({
-                    url: `v2/organizations/${this.clientId}/environments/${this.environment}/profiles/${profileId}`,
+                    url: `v3/spaces/${this.spaceId}/environments/${this.environment}/profiles/${profileId}`,
                     body,
                     options
                 });
-                const { data: { changes, experiences, profile } } = (0, optimization_api_schemas_namespaceObject.parseWithFriendlyError)(optimization_api_schemas_namespaceObject.ExperienceResponse, await response.json());
+                const { data: { changes, experiences, profile } } = (0, api_schemas_namespaceObject.parseWithFriendlyError)(api_schemas_namespaceObject.ExperienceResponse, await response.json());
                 const data = {
                     changes,
                     selectedOptimizations: experiences,
@@ -421,7 +426,7 @@ var __webpack_exports__ = {};
             if (!profileId) return await this.createProfile({
                 events
             }, options);
-            return await this.updateProfile({
+            else return await this.updateProfile({
                 profileId,
                 events
             }, options);
@@ -429,21 +434,21 @@ var __webpack_exports__ = {};
         async upsertManyProfiles({ events }, options = {}) {
             const requestName = 'Upsert Many Profiles';
             ExperienceApiClient_logger.info(`Sending "${requestName}" request`);
-            const body = (0, optimization_api_schemas_namespaceObject.parseWithFriendlyError)(optimization_api_schemas_namespaceObject.BatchExperienceRequestData, {
+            const body = (0, api_schemas_namespaceObject.parseWithFriendlyError)(api_schemas_namespaceObject.BatchExperienceRequestData, {
                 events,
                 options: this.constructBodyOptions(options)
             });
             ExperienceApiClient_logger.debug(`"${requestName}" request body:`, body);
             try {
                 const response = await this.makeProfileMutationRequest({
-                    url: `v2/organizations/${this.clientId}/environments/${this.environment}/events`,
+                    url: `v3/spaces/${this.spaceId}/environments/${this.environment}/events`,
                     body,
                     options: {
                         plainText: false,
                         ...options
                     }
                 });
-                const { data: { profiles } } = (0, optimization_api_schemas_namespaceObject.parseWithFriendlyError)(optimization_api_schemas_namespaceObject.BatchExperienceResponse, await response.json());
+                const { data: { profiles } } = (0, api_schemas_namespaceObject.parseWithFriendlyError)(api_schemas_namespaceObject.BatchExperienceResponse, await response.json());
                 ExperienceApiClient_logger.debug(`"${requestName}" request successfully completed`);
                 return profiles;
             } catch (error) {
@@ -478,8 +483,8 @@ var __webpack_exports__ = {};
             return bodyOptions;
         };
         constructExperienceRequestBody(events, options) {
-            return optimization_api_schemas_namespaceObject.ExperienceRequestData.parse({
-                events: (0, optimization_api_schemas_namespaceObject.parseWithFriendlyError)(optimization_api_schemas_namespaceObject.ExperienceEventArray, events),
+            return api_schemas_namespaceObject.ExperienceRequestData.parse({
+                events: (0, api_schemas_namespaceObject.parseWithFriendlyError)(api_schemas_namespaceObject.ExperienceEventArray, events),
                 options: this.constructBodyOptions(options)
             });
         }
@@ -496,9 +501,9 @@ var __webpack_exports__ = {};
         }
         async sendBatchEvents(batches, options = {}) {
             const { beacon } = options;
-            const url = new URL(`v1/organizations/${this.clientId}/environments/${this.environment}/events`, this.baseUrl);
+            const url = new URL(`v2/spaces/${this.spaceId}/environments/${this.environment}/events`, this.baseUrl);
             const urlString = url.toString();
-            const body = (0, optimization_api_schemas_namespaceObject.parseWithFriendlyError)(optimization_api_schemas_namespaceObject.BatchInsightsEventArray, batches);
+            const body = (0, api_schemas_namespaceObject.parseWithFriendlyError)(api_schemas_namespaceObject.BatchInsightsEventArray, batches);
             const serializedBody = JSON.stringify(body);
             if (beacon) {
                 InsightsApiClient_logger.debug('Queueing events via beacon');
@@ -537,9 +542,9 @@ var __webpack_exports__ = {};
         experience;
         insights;
         constructor(config){
-            const { experience, insights, clientId, environment, fetchOptions } = config;
+            const { experience, insights, spaceId, environment, fetchOptions } = config;
             const apiConfig = {
-                clientId,
+                spaceId,
                 environment,
                 fetchOptions
             };
@@ -554,6 +559,9 @@ var __webpack_exports__ = {};
             });
         }
     }
+    function isVariableChange(change) {
+        return 'Variable' === change.type;
+    }
 })();
 exports.ApiClient = __webpack_exports__.ApiClient;
 exports.EXPERIENCE_BASE_URL = __webpack_exports__.EXPERIENCE_BASE_URL;
@@ -563,6 +571,7 @@ exports.InsightsApiClient = __webpack_exports__.InsightsApiClient;
 exports.createProtectedFetchMethod = __webpack_exports__.createProtectedFetchMethod;
 exports.createRetryFetchMethod = __webpack_exports__.createRetryFetchMethod;
 exports.createTimeoutFetchMethod = __webpack_exports__.createTimeoutFetchMethod;
+exports.isVariableChange = __webpack_exports__.isVariableChange;
 for(var __rspack_i in __webpack_exports__)if (-1 === [
     "ApiClient",
     "EXPERIENCE_BASE_URL",
@@ -571,7 +580,8 @@ for(var __rspack_i in __webpack_exports__)if (-1 === [
     "InsightsApiClient",
     "createProtectedFetchMethod",
     "createRetryFetchMethod",
-    "createTimeoutFetchMethod"
+    "createTimeoutFetchMethod",
+    "isVariableChange"
 ].indexOf(__rspack_i)) exports[__rspack_i] = __webpack_exports__[__rspack_i];
 Object.defineProperty(exports, '__esModule', {
     value: true