@contentful/optimization-api-client 0.1.0-alpha

package/dist/experience/ExperienceApiClient.js

@@ -0,0 +1,324 @@
+import { BatchExperienceResponse, ExperienceEventArray, ExperienceResponse, } from '@contentful/optimization-api-schemas';
+import { createScopedLogger } from 'logger';
+import ApiClientBase from '../ApiClientBase';
+const logger = createScopedLogger('ApiClient:Experience');
+/**
+ * Default base URL for the Experience API.
+ *
+ * @public
+ */
+export const EXPERIENCE_BASE_URL = 'https://experience.ninetailed.co/';
+/**
+ * Client for interacting with the Experience API.
+ *
+ * @public
+ *
+ * @remarks
+ * This client is responsible for reading and mutating Ninetailed profiles
+ * using the Experience API.
+ *
+ * @example
+ * ```ts
+ * const client = new ExperienceApiClient({
+ *   clientId: 'org-id',
+ *   environment: 'main',
+ * })
+ *
+ * const profile = await client.getProfile('profile-id')
+ * ```
+ */
+export default class ExperienceApiClient extends ApiClientBase {
+    /**
+     * Base URL used for Experience API requests.
+     */
+    baseUrl;
+    enabledFeatures;
+    ip;
+    locale;
+    plainText;
+    preflight;
+    /**
+     * Creates a new {@link ExperienceApiClient} instance.
+     *
+     * @param config - Configuration for the Experience API client.
+     */
+    constructor(config) {
+        super('Experience', config);
+        const { baseUrl, enabledFeatures, ip, locale, plainText, preflight } = config;
+        // eslint-disable-next-line @typescript-eslint/prefer-nullish-coalescing -- Set default for anything falsey
+        this.baseUrl = baseUrl || EXPERIENCE_BASE_URL;
+        this.enabledFeatures = enabledFeatures;
+        this.ip = ip;
+        this.locale = locale;
+        this.plainText = plainText;
+        this.preflight = preflight;
+    }
+    /**
+     * Retrieves a profile by ID.
+     *
+     * @param id - The profile ID to retrieve.
+     * @param options - Optional request options. `preflight` and `plainText` are not allowed here.
+     * @returns The current optimization data for the profile.
+     *
+     * @throws {@link Error}
+     * Thrown if `id` is missing or the underlying request fails.
+     *
+     * @example
+     * ```ts
+     * const profile = await client.getProfile('profile-id', {
+     *   locale: 'en-US',
+     * })
+     * ```
+     */
+    async getProfile(id, options = {}) {
+        if (!id)
+            throw new Error('Valid profile ID required.');
+        const requestName = 'Get Profile';
+        logger.info(`Sending "${requestName}" request`);
+        try {
+            const response = await this.fetch(this.constructUrl(`v2/organizations/${this.clientId}/environments/${this.environment}/profiles/${id}`, options), {
+                method: 'GET',
+            });
+            const { data: { changes, experiences, profile }, } = ExperienceResponse.parse(await response.json());
+            const data = { changes, personalizations: experiences, profile };
+            logger.debug(`"${requestName}" request successfully completed`);
+            return data;
+        }
+        catch (error) {
+            this.logRequestError(error, { requestName });
+            throw error;
+        }
+    }
+    /**
+     * Sends a POST request to mutate a profile or profiles.
+     *
+     * @param request - Mutation request options including URL, body, and request options.
+     * @returns The raw {@link Response} from the underlying fetch.
+     *
+     * @internal
+     */
+    async makeProfileMutationRequest({ url, body, options, }) {
+        return await this.fetch(this.constructUrl(url, options), {
+            method: 'POST',
+            headers: this.constructHeaders(options),
+            body: JSON.stringify(body),
+            keepalive: true,
+        });
+    }
+    /**
+     * Creates a profile and returns the resulting optimization data.
+     *
+     * @param params - Parameters containing the events to aggregate into the profile.
+     * @param options - Optional request options.
+     * @returns The optimization data for the newly created profile.
+     *
+     * @remarks
+     * The returned profile ID can be used for subsequent update requests.
+     *
+     * @example
+     * ```ts
+     * const data = await client.createProfile({
+     *   events: [{ type: 'identify', userId: 'user-123' }],
+     * })
+     * ```
+     */
+    async createProfile({ events }, options = {}) {
+        const requestName = 'Create Profile';
+        logger.info(`Sending "${requestName}" request`);
+        const body = {
+            events: ExperienceEventArray.parse(events),
+            options: this.constructBodyOptions(options),
+        };
+        logger.debug(`"${requestName}" request body:`, body);
+        try {
+            const response = await this.makeProfileMutationRequest({
+                url: `v2/organizations/${this.clientId}/environments/${this.environment}/profiles`,
+                body,
+                options,
+            });
+            const { data: { changes, experiences, profile }, } = ExperienceResponse.parse(await response.json());
+            const data = { changes, personalizations: experiences, profile };
+            logger.debug(`"${requestName}" request successfully completed`);
+            return data;
+        }
+        catch (error) {
+            this.logRequestError(error, { requestName });
+            throw error;
+        }
+    }
+    /**
+     * Updates an existing profile with the given profile ID.
+     *
+     * @param params - Parameters including the profile ID and events.
+     * @param options - Optional request options.
+     * @returns The updated optimization data for the profile.
+     *
+     * @throws {@link Error}
+     * Thrown if `profileId` is missing or the underlying request fails.
+     *
+     * @example
+     * ```ts
+     * const data = await client.updateProfile({
+     *   profileId: 'profile-id',
+     *   events: [{ type: 'track', event: 'viewed_video' }],
+     * })
+     * ```
+     */
+    async updateProfile({ profileId, events }, options = {}) {
+        if (!profileId)
+            throw new Error('Valid profile ID required.');
+        const requestName = 'Update Profile';
+        logger.info(`Sending "${requestName}" request`);
+        const body = {
+            events: ExperienceEventArray.parse(events),
+            options: this.constructBodyOptions(options),
+        };
+        logger.debug(`"${requestName}" request body:`, body);
+        try {
+            const response = await this.makeProfileMutationRequest({
+                url: `v2/organizations/${this.clientId}/environments/${this.environment}/profiles/${profileId}`,
+                body,
+                options,
+            });
+            const { data: { changes, experiences, profile }, } = ExperienceResponse.parse(await response.json());
+            const data = { changes, personalizations: experiences, profile };
+            logger.debug(`"${requestName}" request successfully completed`);
+            return data;
+        }
+        catch (error) {
+            this.logRequestError(error, { requestName });
+            throw error;
+        }
+    }
+    /**
+     * Creates or updates a profile depending on whether a `profileId` is provided.
+     *
+     * @param params - Parameters including optional profile ID and events.
+     * @param options - Optional request options.
+     * @returns The resulting optimization data.
+     *
+     * @example
+     * ```ts
+     * // Create
+     * await client.upsertProfile({ events })
+     *
+     * // Update
+     * await client.upsertProfile({ profileId: 'profile-id', events })
+     * ```
+     */
+    async upsertProfile({ profileId, events }, options) {
+        if (!profileId) {
+            return await this.createProfile({ events }, options);
+        }
+        else {
+            return await this.updateProfile({ profileId, events }, options);
+        }
+    }
+    /**
+     * Sends multiple events to the Ninetailed Experience API to upsert many profiles.
+     *
+     * @param params - Parameters containing the batch of events.
+     * @param options - Optional request options.
+     * @returns The list of profiles affected by the batch operation.
+     *
+     * @remarks
+     * Every event must contain an anonymous ID. Profiles will be created or
+     * updated according to the anonymous ID.
+     *
+     * This method is intended to be used from server environments.
+     *
+     * @example
+     * ```ts
+     * const profiles = await client.upsertManyProfiles({
+     *   events: [
+     *     [{ type: 'identify', userId: 'user-1' }],
+     *     [{ type: 'identify', userId: 'user-2' }],
+     *   ],
+     * })
+     * ```
+     */
+    async upsertManyProfiles({ events }, options = {}) {
+        const requestName = 'Upsert Many Profiles';
+        logger.info(`Sending "${requestName}" request`);
+        const body = {
+            events: ExperienceEventArray.parse(events),
+            options: this.constructBodyOptions(options),
+        };
+        logger.debug(`"${requestName}" request body:`, body);
+        try {
+            const response = await this.makeProfileMutationRequest({
+                url: `v2/organizations/${this.clientId}/environments/${this.environment}/events`,
+                body,
+                options: { plainText: false, ...options },
+            });
+            const { data: { profiles }, } = BatchExperienceResponse.parse(await response.json());
+            logger.debug(`"${requestName}" request successfully completed`);
+            return profiles;
+        }
+        catch (error) {
+            this.logRequestError(error, { requestName });
+            throw error;
+        }
+    }
+    /**
+     * Constructs a request URL with query parameters derived from request options.
+     *
+     * @param path - Path relative to the Experience API base URL.
+     * @param options - Request options that may influence query parameters.
+     * @returns The fully constructed URL as a string.
+     *
+     * @internal
+     */
+    constructUrl(path, options) {
+        const url = new URL(path, this.baseUrl);
+        const locale = options.locale ?? this.locale;
+        const preflight = options.preflight ?? this.preflight;
+        if (locale) {
+            url.searchParams.set('locale', locale);
+        }
+        if (preflight) {
+            url.searchParams.set('type', 'preflight');
+        }
+        return url.toString();
+    }
+    /**
+     * Constructs request headers based on request options and default configuration.
+     *
+     * @param options - Request options that may influence headers.
+     * @returns A record of HTTP headers to send with the request.
+     *
+     * @internal
+     */
+    constructHeaders({ ip = this.ip, plainText = this.plainText, }) {
+        const headers = new Map();
+        if (ip) {
+            headers.set('X-Force-IP', ip);
+        }
+        if (plainText ?? this.plainText ?? true) {
+            headers.set('Content-Type', 'text/plain');
+        }
+        else {
+            headers.set('Content-Type', 'application/json');
+        }
+        return Object.fromEntries(headers);
+    }
+    /**
+     * Constructs the `options` section of the request body for profile mutations.
+     *
+     * @param options - Request options that may specify enabled features.
+     * @returns Experience API body options including feature flags.
+     *
+     * @internal
+     */
+    constructBodyOptions = ({ enabledFeatures = this.enabledFeatures, }) => {
+        const bodyOptions = {};
+        if (enabledFeatures && Array.isArray(enabledFeatures) && enabledFeatures.length > 0) {
+            bodyOptions.features = enabledFeatures;
+        }
+        else {
+            bodyOptions.features = ['ip-enrichment', 'location'];
+        }
+        return bodyOptions;
+    };
+}
+//# sourceMappingURL=ExperienceApiClient.js.map

package/dist/experience/ExperienceApiClient.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ExperienceApiClient.js","sourceRoot":"","sources":["../../src/experience/ExperienceApiClient.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,uBAAuB,EACvB,oBAAoB,EACpB,kBAAkB,GAMnB,MAAM,sCAAsC,CAAA;AAC7C,OAAO,EAAE,kBAAkB,EAAE,MAAM,QAAQ,CAAA;AAC3C,OAAO,aAAiC,MAAM,kBAAkB,CAAA;AAEhE,MAAM,MAAM,GAAG,kBAAkB,CAAC,sBAAsB,CAAC,CAAA;AAEzD;;;;GAIG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,mCAAmC,CAAA;AA+GtE;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,CAAC,OAAO,OAAO,mBAAoB,SAAQ,aAAa;IAC5D;;OAEG;IACgB,OAAO,CAAQ;IAEjB,eAAe,CAAoC;IACnD,EAAE,CAAuB;IACzB,MAAM,CAA2B;IACjC,SAAS,CAA8B;IACvC,SAAS,CAA8B;IAExD;;;;OAIG;IACH,YAAY,MAAiC;QAC3C,KAAK,CAAC,YAAY,EAAE,MAAM,CAAC,CAAA;QAE3B,MAAM,EAAE,OAAO,EAAE,eAAe,EAAE,EAAE,EAAE,MAAM,EAAE,SAAS,EAAE,SAAS,EAAE,GAAG,MAAM,CAAA;QAE7E,2GAA2G;QAC3G,IAAI,CAAC,OAAO,GAAG,OAAO,IAAI,mBAAmB,CAAA;QAC7C,IAAI,CAAC,eAAe,GAAG,eAAe,CAAA;QACtC,IAAI,CAAC,EAAE,GAAG,EAAE,CAAA;QACZ,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;QACpB,IAAI,CAAC,SAAS,GAAG,SAAS,CAAA;QAC1B,IAAI,CAAC,SAAS,GAAG,SAAS,CAAA;IAC5B,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACI,KAAK,CAAC,UAAU,CACrB,EAAU,EACV,UAA2D,EAAE;QAE7D,IAAI,CAAC,EAAE;YAAE,MAAM,IAAI,KAAK,CAAC,4BAA4B,CAAC,CAAA;QAEtD,MAAM,WAAW,GAAG,aAAa,CAAA;QAEjC,MAAM,CAAC,IAAI,CAAC,YAAY,WAAW,WAAW,CAAC,CAAA;QAE/C,IAAI,CAAC;YACH,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,KAAK,CAC/B,IAAI,CAAC,YAAY,CACf,oBAAoB,IAAI,CAAC,QAAQ,iBAAiB,IAAI,CAAC,WAAW,aAAa,EAAE,EAAE,EACnF,OAAO,CACR,EACD;gBACE,MAAM,EAAE,KAAK;aACd,CACF,CAAA;YAED,MAAM,EACJ,IAAI,EAAE,EAAE,OAAO,EAAE,WAAW,EAAE,OAAO,EAAE,GACxC,GAAG,kBAAkB,CAAC,KAAK,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAA;YAEnD,MAAM,IAAI,GAAG,EAAE,OAAO,EAAE,gBAAgB,EAAE,WAAW,EAAE,OAAO,EAAE,CAAA;YAEhE,MAAM,CAAC,KAAK,CAAC,IAAI,WAAW,kCAAkC,CAAC,CAAA;YAE/D,OAAO,IAAI,CAAA;QACb,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,CAAC,eAAe,CAAC,KAAK,EAAE,EAAE,WAAW,EAAE,CAAC,CAAA;YAE5C,MAAM,KAAK,CAAA;QACb,CAAC;IACH,CAAC;IAED;;;;;;;OAOG;IACK,KAAK,CAAC,0BAA0B,CAAC,EACvC,GAAG,EACH,IAAI,EACJ,OAAO,GACuB;QAC9B,OAAO,MAAM,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,YAAY,CAAC,GAAG,EAAE,OAAO,CAAC,EAAE;YACvD,MAAM,EAAE,MAAM;YACd,OAAO,EAAE,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC;YACvC,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;YAC1B,SAAS,EAAE,IAAI;SAChB,CAAC,CAAA;IACJ,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACI,KAAK,CAAC,aAAa,CACxB,EAAE,MAAM,EAAuB,EAC/B,UAA0B,EAAE;QAE5B,MAAM,WAAW,GAAG,gBAAgB,CAAA;QAEpC,MAAM,CAAC,IAAI,CAAC,YAAY,WAAW,WAAW,CAAC,CAAA;QAE/C,MAAM,IAAI,GAA0B;YAClC,MAAM,EAAE,oBAAoB,CAAC,KAAK,CAAC,MAAM,CAAC;YAC1C,OAAO,EAAE,IAAI,CAAC,oBAAoB,CAAC,OAAO,CAAC;SAC5C,CAAA;QAED,MAAM,CAAC,KAAK,CAAC,IAAI,WAAW,iBAAiB,EAAE,IAAI,CAAC,CAAA;QAEpD,IAAI,CAAC;YACH,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,0BAA0B,CAAC;gBACrD,GAAG,EAAE,oBAAoB,IAAI,CAAC,QAAQ,iBAAiB,IAAI,CAAC,WAAW,WAAW;gBAClF,IAAI;gBACJ,OAAO;aACR,CAAC,CAAA;YAEF,MAAM,EACJ,IAAI,EAAE,EAAE,OAAO,EAAE,WAAW,EAAE,OAAO,EAAE,GACxC,GAAG,kBAAkB,CAAC,KAAK,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAA;YAEnD,MAAM,IAAI,GAAG,EAAE,OAAO,EAAE,gBAAgB,EAAE,WAAW,EAAE,OAAO,EAAE,CAAA;YAEhE,MAAM,CAAC,KAAK,CAAC,IAAI,WAAW,kCAAkC,CAAC,CAAA;YAE/D,OAAO,IAAI,CAAA;QACb,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,CAAC,eAAe,CAAC,KAAK,EAAE,EAAE,WAAW,EAAE,CAAC,CAAA;YAE5C,MAAM,KAAK,CAAA;QACb,CAAC;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACI,KAAK,CAAC,aAAa,CACxB,EAAE,SAAS,EAAE,MAAM,EAAuB,EAC1C,UAA0B,EAAE;QAE5B,IAAI,CAAC,SAAS;YAAE,MAAM,IAAI,KAAK,CAAC,4BAA4B,CAAC,CAAA;QAE7D,MAAM,WAAW,GAAG,gBAAgB,CAAA;QAEpC,MAAM,CAAC,IAAI,CAAC,YAAY,WAAW,WAAW,CAAC,CAAA;QAE/C,MAAM,IAAI,GAA0B;YAClC,MAAM,EAAE,oBAAoB,CAAC,KAAK,CAAC,MAAM,CAAC;YAC1C,OAAO,EAAE,IAAI,CAAC,oBAAoB,CAAC,OAAO,CAAC;SAC5C,CAAA;QAED,MAAM,CAAC,KAAK,CAAC,IAAI,WAAW,iBAAiB,EAAE,IAAI,CAAC,CAAA;QAEpD,IAAI,CAAC;YACH,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,0BAA0B,CAAC;gBACrD,GAAG,EAAE,oBAAoB,IAAI,CAAC,QAAQ,iBAAiB,IAAI,CAAC,WAAW,aAAa,SAAS,EAAE;gBAC/F,IAAI;gBACJ,OAAO;aACR,CAAC,CAAA;YAEF,MAAM,EACJ,IAAI,EAAE,EAAE,OAAO,EAAE,WAAW,EAAE,OAAO,EAAE,GACxC,GAAG,kBAAkB,CAAC,KAAK,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAA;YAEnD,MAAM,IAAI,GAAG,EAAE,OAAO,EAAE,gBAAgB,EAAE,WAAW,EAAE,OAAO,EAAE,CAAA;YAEhE,MAAM,CAAC,KAAK,CAAC,IAAI,WAAW,kCAAkC,CAAC,CAAA;YAE/D,OAAO,IAAI,CAAA;QACb,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,CAAC,eAAe,CAAC,KAAK,EAAE,EAAE,WAAW,EAAE,CAAC,CAAA;YAE5C,MAAM,KAAK,CAAA;QACb,CAAC;IACH,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACI,KAAK,CAAC,aAAa,CACxB,EAAE,SAAS,EAAE,MAAM,EAAuB,EAC1C,OAAwB;QAExB,IAAI,CAAC,SAAS,EAAE,CAAC;YACf,OAAO,MAAM,IAAI,CAAC,aAAa,CAAC,EAAE,MAAM,EAAE,EAAE,OAAO,CAAC,CAAA;QACtD,CAAC;aAAM,CAAC;YACN,OAAO,MAAM,IAAI,CAAC,aAAa,CAAC,EAAE,SAAS,EAAE,MAAM,EAAE,EAAE,OAAO,CAAC,CAAA;QACjE,CAAC;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACI,KAAK,CAAC,kBAAkB,CAC7B,EAAE,MAAM,EAA4B,EACpC,UAA0B,EAAE;QAE5B,MAAM,WAAW,GAAG,sBAAsB,CAAA;QAE1C,MAAM,CAAC,IAAI,CAAC,YAAY,WAAW,WAAW,CAAC,CAAA;QAE/C,MAAM,IAAI,GAA0B;YAClC,MAAM,EAAE,oBAAoB,CAAC,KAAK,CAAC,MAAM,CAAC;YAC1C,OAAO,EAAE,IAAI,CAAC,oBAAoB,CAAC,OAAO,CAAC;SAC5C,CAAA;QAED,MAAM,CAAC,KAAK,CAAC,IAAI,WAAW,iBAAiB,EAAE,IAAI,CAAC,CAAA;QAEpD,IAAI,CAAC;YACH,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,0BAA0B,CAAC;gBACrD,GAAG,EAAE,oBAAoB,IAAI,CAAC,QAAQ,iBAAiB,IAAI,CAAC,WAAW,SAAS;gBAChF,IAAI;gBACJ,OAAO,EAAE,EAAE,SAAS,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE;aAC1C,CAAC,CAAA;YAEF,MAAM,EACJ,IAAI,EAAE,EAAE,QAAQ,EAAE,GACnB,GAAG,uBAAuB,CAAC,KAAK,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAA;YAExD,MAAM,CAAC,KAAK,CAAC,IAAI,WAAW,kCAAkC,CAAC,CAAA;YAE/D,OAAO,QAAQ,CAAA;QACjB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,CAAC,eAAe,CAAC,KAAK,EAAE,EAAE,WAAW,EAAE,CAAC,CAAA;YAE5C,MAAM,KAAK,CAAA;QACb,CAAC;IACH,CAAC;IAED;;;;;;;;OAQG;IACK,YAAY,CAAC,IAAY,EAAE,OAAuB;QACxD,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,CAAA;QACvC,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,IAAI,IAAI,CAAC,MAAM,CAAA;QAC5C,MAAM,SAAS,GAAG,OAAO,CAAC,SAAS,IAAI,IAAI,CAAC,SAAS,CAAA;QAErD,IAAI,MAAM,EAAE,CAAC;YACX,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAA;QACxC,CAAC;QAED,IAAI,SAAS,EAAE,CAAC;YACd,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,MAAM,EAAE,WAAW,CAAC,CAAA;QAC3C,CAAC;QAED,OAAO,GAAG,CAAC,QAAQ,EAAE,CAAA;IACvB,CAAC;IAED;;;;;;;OAOG;IACK,gBAAgB,CAAC,EACvB,EAAE,GAAG,IAAI,CAAC,EAAE,EACZ,SAAS,GAAG,IAAI,CAAC,SAAS,GACX;QACf,MAAM,OAAO,GAAG,IAAI,GAAG,EAAkB,CAAA;QAEzC,IAAI,EAAE,EAAE,CAAC;YACP,OAAO,CAAC,GAAG,CAAC,YAAY,EAAE,EAAE,CAAC,CAAA;QAC/B,CAAC;QAED,IAAI,SAAS,IAAI,IAAI,CAAC,SAAS,IAAI,IAAI,EAAE,CAAC;YACxC,OAAO,CAAC,GAAG,CAAC,cAAc,EAAE,YAAY,CAAC,CAAA;QAC3C,CAAC;aAAM,CAAC;YACN,OAAO,CAAC,GAAG,CAAC,cAAc,EAAE,kBAAkB,CAAC,CAAA;QACjD,CAAC;QAED,OAAO,MAAM,CAAC,WAAW,CAAC,OAAO,CAAC,CAAA;IACpC,CAAC;IAED;;;;;;;OAOG;IACc,oBAAoB,GAAG,CAAC,EACvC,eAAe,GAAG,IAAI,CAAC,eAAe,GACvB,EAA4B,EAAE;QAC7C,MAAM,WAAW,GAA6B,EAAE,CAAA;QAEhD,IAAI,eAAe,IAAI,KAAK,CAAC,OAAO,CAAC,eAAe,CAAC,IAAI,eAAe,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACpF,WAAW,CAAC,QAAQ,GAAG,eAAe,CAAA;QACxC,CAAC;aAAM,CAAC;YACN,WAAW,CAAC,QAAQ,GAAG,CAAC,eAAe,EAAE,UAAU,CAAC,CAAA;QACtD,CAAC;QAED,OAAO,WAAW,CAAA;IACpB,CAAC,CAAA;CACF"}

package/dist/experience/index.d.ts

@@ -0,0 +1,4 @@
+import ExperienceApiClient from './ExperienceApiClient';
+export * from './ExperienceApiClient';
+export default ExperienceApiClient;
+//# sourceMappingURL=index.d.ts.map

package/dist/experience/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/experience/index.ts"],"names":[],"mappings":"AAAA,OAAO,mBAAmB,MAAM,uBAAuB,CAAA;AAEvD,cAAc,uBAAuB,CAAA;AAErC,eAAe,mBAAmB,CAAA"}

package/dist/experience/index.js

@@ -0,0 +1,4 @@
+import ExperienceApiClient from './ExperienceApiClient';
+export * from './ExperienceApiClient';
+export default ExperienceApiClient;
+//# sourceMappingURL=index.js.map

package/dist/experience/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/experience/index.ts"],"names":[],"mappings":"AAAA,OAAO,mBAAmB,MAAM,uBAAuB,CAAA;AAEvD,cAAc,uBAAuB,CAAA;AAErC,eAAe,mBAAmB,CAAA"}

package/dist/fetch/Fetch.d.ts

@@ -0,0 +1,96 @@
+import { createProtectedFetchMethod } from './createProtectedFetchMethod';
+/**
+ * Signature of a fetch method used by the API clients.
+ *
+ * @param url - The request URL.
+ * @param init - Initialization options passed to `fetch`.
+ * @returns A promise that resolves with the {@link Response}.
+ *
+ * @public
+ *
+ * @remarks
+ * This abstraction allows the underlying implementation to be replaced,
+ * for example in tests or different runtime environments.
+ *
+ * @example
+ * ```ts
+ * const method: FetchMethod = async (url, init) => {
+ *   return fetch(url, init)
+ * }
+ * ```
+ */
+export type FetchMethod = (url: string | URL, init: RequestInit) => Promise<Response>;
+/**
+ * Base options shared across fetch method factories.
+ *
+ * @public
+ */
+export interface BaseFetchMethodOptions {
+    /**
+     * Human-readable name of the API being called.
+     *
+     * @remarks
+     * Used primarily for logging and error messages.
+     */
+    apiName?: string;
+    /**
+     * Custom fetch implementation to use instead of the global `fetch`.
+     *
+     * @remarks
+     * This is useful for providing polyfills, mocks, or instrumented fetch
+     * implementations.
+     */
+    fetchMethod?: FetchMethod;
+}
+/**
+ * Options passed to callback functions invoked by fetch wrappers.
+ *
+ * @public
+ *
+ * @remarks
+ * Not all fields are guaranteed to be present in all callback scenarios.
+ */
+export interface FetchMethodCallbackOptions {
+    /**
+     * Name of the API associated with the request.
+     */
+    apiName?: string;
+    /**
+     * Error that caused the callback to be invoked, if available.
+     */
+    error?: Error;
+    /**
+     * The current attempt number (for retry callbacks).
+     */
+    attemptNumber?: number;
+    /**
+     * Number of retry attempts remaining (for retry callbacks).
+     */
+    retriesLeft?: number;
+}
+/**
+ * Namespace-like object providing factory methods for protected fetch functions.
+ *
+ * @public
+ */
+declare const Fetch: {
+    /**
+     * Creates a fully protected fetch method with timeout and retry behavior.
+     *
+     * @example
+     * ```ts
+     * const fetchMethod = Fetch.create({
+     *   apiName: 'Optimization',
+     *   requestTimeout: 3000,
+     *   retries: 2,
+     * })
+     *
+     * const response = await fetchMethod('https://example.com', { method: 'GET' })
+     * ```
+     *
+     * @see createProtectedFetchMethod
+     */
+    create: typeof createProtectedFetchMethod;
+};
+export default Fetch;
+//# sourceMappingURL=Fetch.d.ts.map

package/dist/fetch/Fetch.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Fetch.d.ts","sourceRoot":"","sources":["../../src/fetch/Fetch.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,0BAA0B,EAAE,MAAM,8BAA8B,CAAA;AAEzE;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,MAAM,WAAW,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,EAAE,IAAI,EAAE,WAAW,KAAK,OAAO,CAAC,QAAQ,CAAC,CAAA;AAErF;;;;GAIG;AACH,MAAM,WAAW,sBAAsB;IACrC;;;;;OAKG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;IAEhB;;;;;;OAMG;IACH,WAAW,CAAC,EAAE,WAAW,CAAA;CAC1B;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;IAEhB;;OAEG;IACH,KAAK,CAAC,EAAE,KAAK,CAAA;IAEb;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;IAEtB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB;AAED;;;;GAIG;AACH,QAAA,MAAM,KAAK;IACT;;;;;;;;;;;;;;;OAeG;;CAEJ,CAAA;AAED,eAAe,KAAK,CAAA"}

package/dist/fetch/Fetch.js

@@ -0,0 +1,27 @@
+import { createProtectedFetchMethod } from './createProtectedFetchMethod';
+/**
+ * Namespace-like object providing factory methods for protected fetch functions.
+ *
+ * @public
+ */
+const Fetch = {
+    /**
+     * Creates a fully protected fetch method with timeout and retry behavior.
+     *
+     * @example
+     * ```ts
+     * const fetchMethod = Fetch.create({
+     *   apiName: 'Optimization',
+     *   requestTimeout: 3000,
+     *   retries: 2,
+     * })
+     *
+     * const response = await fetchMethod('https://example.com', { method: 'GET' })
+     * ```
+     *
+     * @see createProtectedFetchMethod
+     */
+    create: createProtectedFetchMethod,
+};
+export default Fetch;
+//# sourceMappingURL=Fetch.js.map

package/dist/fetch/Fetch.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Fetch.js","sourceRoot":"","sources":["../../src/fetch/Fetch.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,0BAA0B,EAAE,MAAM,8BAA8B,CAAA;AA8EzE;;;;GAIG;AACH,MAAM,KAAK,GAAG;IACZ;;;;;;;;;;;;;;;OAeG;IACH,MAAM,EAAE,0BAA0B;CACnC,CAAA;AAED,eAAe,KAAK,CAAA"}

package/dist/fetch/createProtectedFetchMethod.d.ts

@@ -0,0 +1,40 @@
+import { type RetryFetchMethodOptions } from './createRetryFetchMethod';
+import { type TimeoutFetchMethodOptions } from './createTimeoutFetchMethod';
+import type { FetchMethod } from './Fetch';
+/**
+ * Options for {@link createProtectedFetchMethod}, combining timeout and retry behavior.
+ */
+export interface ProtectedFetchMethodOptions extends RetryFetchMethodOptions, TimeoutFetchMethodOptions {
+}
+/**
+ * Creates a {@link FetchMethod} that combines timeout and retry protection.
+ *
+ * @param options - Configuration options for both timeout and retry behavior.
+ * @returns A {@link FetchMethod} that applies timeout and retry logic to requests.
+ *
+ * @remarks
+ * The resulting method first wraps the base fetch with a timeout (via
+ * {@link createTimeoutFetchMethod}), then applies retry behavior (via
+ * {@link createRetryFetchMethod}).
+ *
+ * If an error is thrown during configuration or request execution, it is logged
+ * using {@link logger}.
+ *
+ * @throws {@link Error}
+ * Rethrows the original error after logging, including abort errors.
+ *
+ * @example
+ * ```ts
+ * const fetchProtected = createProtectedFetchMethod({
+ *   apiName: 'Optimization',
+ *   requestTimeout: 4000,
+ *   retries: 2,
+ * })
+ *
+ * const response = await fetchProtected('https://example.com/experiences', {
+ *   method: 'GET',
+ * })
+ * ```
+ */
+export declare function createProtectedFetchMethod(options: ProtectedFetchMethodOptions): FetchMethod;
+//# sourceMappingURL=createProtectedFetchMethod.d.ts.map

package/dist/fetch/createProtectedFetchMethod.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"createProtectedFetchMethod.d.ts","sourceRoot":"","sources":["../../src/fetch/createProtectedFetchMethod.ts"],"names":[],"mappings":"AACA,OAAO,EAA0B,KAAK,uBAAuB,EAAE,MAAM,0BAA0B,CAAA;AAC/F,OAAO,EAEL,KAAK,yBAAyB,EAC/B,MAAM,4BAA4B,CAAA;AACnC,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,SAAS,CAAA;AAI1C;;GAEG;AACH,MAAM,WAAW,2BACf,SAAQ,uBAAuB,EAC7B,yBAAyB;CAAG;AAEhC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,wBAAgB,0BAA0B,CAAC,OAAO,EAAE,2BAA2B,GAAG,WAAW,CAgB5F"}

package/dist/fetch/createProtectedFetchMethod.js

@@ -0,0 +1,53 @@
+import { createScopedLogger } from 'logger';
+import { createRetryFetchMethod } from './createRetryFetchMethod';
+import { createTimeoutFetchMethod, } from './createTimeoutFetchMethod';
+const logger = createScopedLogger('ApiClient:Fetch');
+/**
+ * Creates a {@link FetchMethod} that combines timeout and retry protection.
+ *
+ * @param options - Configuration options for both timeout and retry behavior.
+ * @returns A {@link FetchMethod} that applies timeout and retry logic to requests.
+ *
+ * @remarks
+ * The resulting method first wraps the base fetch with a timeout (via
+ * {@link createTimeoutFetchMethod}), then applies retry behavior (via
+ * {@link createRetryFetchMethod}).
+ *
+ * If an error is thrown during configuration or request execution, it is logged
+ * using {@link logger}.
+ *
+ * @throws {@link Error}
+ * Rethrows the original error after logging, including abort errors.
+ *
+ * @example
+ * ```ts
+ * const fetchProtected = createProtectedFetchMethod({
+ *   apiName: 'Optimization',
+ *   requestTimeout: 4000,
+ *   retries: 2,
+ * })
+ *
+ * const response = await fetchProtected('https://example.com/experiences', {
+ *   method: 'GET',
+ * })
+ * ```
+ */
+export function createProtectedFetchMethod(options) {
+    try {
+        const timeoutFetchMethod = createTimeoutFetchMethod(options);
+        const retryFetchMethod = createRetryFetchMethod({ ...options, fetchMethod: timeoutFetchMethod });
+        return retryFetchMethod;
+    }
+    catch (error) {
+        if (error instanceof Error) {
+            if (error.name === 'AbortError') {
+                logger.warn('Request aborted due to network issues. This request may not be retried.');
+            }
+            else {
+                logger.error('Request failed:', error);
+            }
+        }
+        throw error;
+    }
+}
+//# sourceMappingURL=createProtectedFetchMethod.js.map

package/dist/fetch/createProtectedFetchMethod.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"createProtectedFetchMethod.js","sourceRoot":"","sources":["../../src/fetch/createProtectedFetchMethod.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,QAAQ,CAAA;AAC3C,OAAO,EAAE,sBAAsB,EAAgC,MAAM,0BAA0B,CAAA;AAC/F,OAAO,EACL,wBAAwB,GAEzB,MAAM,4BAA4B,CAAA;AAGnC,MAAM,MAAM,GAAG,kBAAkB,CAAC,iBAAiB,CAAC,CAAA;AASpD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,MAAM,UAAU,0BAA0B,CAAC,OAAoC;IAC7E,IAAI,CAAC;QACH,MAAM,kBAAkB,GAAG,wBAAwB,CAAC,OAAO,CAAC,CAAA;QAC5D,MAAM,gBAAgB,GAAG,sBAAsB,CAAC,EAAE,GAAG,OAAO,EAAE,WAAW,EAAE,kBAAkB,EAAE,CAAC,CAAA;QAEhG,OAAO,gBAAgB,CAAA;IACzB,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,KAAK,YAAY,KAAK,EAAE,CAAC;YAC3B,IAAI,KAAK,CAAC,IAAI,KAAK,YAAY,EAAE,CAAC;gBAChC,MAAM,CAAC,IAAI,CAAC,yEAAyE,CAAC,CAAA;YACxF,CAAC;iBAAM,CAAC;gBACN,MAAM,CAAC,KAAK,CAAC,iBAAiB,EAAE,KAAK,CAAC,CAAA;YACxC,CAAC;QACH,CAAC;QACD,MAAM,KAAK,CAAA;IACb,CAAC;AACH,CAAC"}

package/dist/fetch/createRetryFetchMethod.d.ts

@@ -0,0 +1,60 @@
+import type { BaseFetchMethodOptions, FetchMethod, FetchMethodCallbackOptions } from './Fetch';
+/**
+ * Configuration options for {@link createRetryFetchMethod}.
+ */
+export interface RetryFetchMethodOptions extends BaseFetchMethodOptions {
+    /**
+     * Delay (in milliseconds) between retry attempts.
+     *
+     * @remarks
+     * Defaults to {@link DEFAULT_INTERVAL_TIMEOUT}.
+     */
+    intervalTimeout?: number;
+    /**
+     * Callback invoked whenever a retry attempt fails.
+     *
+     * @param options - Information about the failed attempt.
+     *
+     * @remarks
+     * This callback is invoked with additional metadata such as the attempt
+     * number and the number of retries left.
+     */
+    onFailedAttempt?: (options: FetchMethodCallbackOptions) => void;
+    /**
+     * Maximum number of retry attempts.
+     *
+     * @remarks
+     * Defaults to {@link DEFAULT_RETRY_COUNT}.
+     */
+    retries?: number;
+}
+/**
+ * Creates a {@link FetchMethod} that retries failed requests according to the
+ * provided configuration.
+ *
+ * @param options - Configuration options that control retry behavior.
+ * @returns A {@link FetchMethod} that automatically retries qualifying failures.
+ *
+ * @remarks
+ * This wrapper integrates with `p-retry` and uses an {@link AbortController}
+ * to cancel pending requests when a non-retriable error occurs.
+ *
+ * @throws {@link Error}
+ * Thrown when the request cannot be retried and no successful response is obtained.
+ *
+ * @example
+ * ```ts
+ * const fetchWithRetry = createRetryFetchMethod({
+ *   apiName: 'Optimization',
+ *   retries: 3,
+ *   intervalTimeout: 200,
+ *   onFailedAttempt: ({ attemptNumber, retriesLeft }) => {
+ *     console.warn(`Attempt ${attemptNumber} failed. Retries left: ${retriesLeft}`)
+ *   },
+ * })
+ *
+ * const response = await fetchWithRetry('https://example.com', { method: 'GET' })
+ * ```
+ */
+export declare function createRetryFetchMethod({ apiName, fetchMethod, intervalTimeout, onFailedAttempt, retries, }?: RetryFetchMethodOptions): FetchMethod;
+//# sourceMappingURL=createRetryFetchMethod.d.ts.map

package/dist/fetch/createRetryFetchMethod.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"createRetryFetchMethod.d.ts","sourceRoot":"","sources":["../../src/fetch/createRetryFetchMethod.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,sBAAsB,EAAE,WAAW,EAAE,0BAA0B,EAAE,MAAM,SAAS,CAAA;AA2D9F;;GAEG;AACH,MAAM,WAAW,uBAAwB,SAAQ,sBAAsB;IACrE;;;;;OAKG;IACH,eAAe,CAAC,EAAE,MAAM,CAAA;IAExB;;;;;;;;OAQG;IACH,eAAe,CAAC,EAAE,CAAC,OAAO,EAAE,0BAA0B,KAAK,IAAI,CAAA;IAE/D;;;;;OAKG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB;AA4ED;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,wBAAgB,sBAAsB,CAAC,EACrC,OAAwB,EACxB,WAAmB,EACnB,eAA0C,EAC1C,eAAe,EACf,OAA6B,GAC9B,GAAE,uBAA4B,GAAG,WAAW,CA8B5C"}