@contentful/optimization-api-client 0.1.0-alpha9 → 1.0.1

package/dist/index.mjs

@@ -1,7 +1,15 @@
-import { merge } from "es-toolkit/object";
-import { boolean as mini_boolean, extend, number, object, optional, partial, prefault, string } from "zod/mini";
 import { createScopedLogger } from "./649.mjs";
 import { __rspack_external__contentful_optimization_api_schemas_66dcf407 } from "./199.mjs";
+const fetchInputToString = (input)=>{
+    if ('string' == typeof input) return input;
+    return input.url;
+};
+const MISSING_FETCH_METHOD_MESSAGE = 'No fetch implementation available. Provide a fetchMethod.';
+function resolveFetchMethod(fetchMethod) {
+    if (fetchMethod) return fetchMethod;
+    if ('function' == typeof globalThis.fetch) return globalThis.fetch.bind(globalThis);
+    throw new Error(MISSING_FETCH_METHOD_MESSAGE);
+}
 const logger = createScopedLogger('ApiClient:Retry');
 const DEFAULT_INTERVAL_TIMEOUT = 0;
 const DEFAULT_RETRY_COUNT = 1;
@@ -15,22 +23,23 @@ class HttpError extends Error {
         this.status = status;
     }
 }
-function createRetryFetchCallback({ apiName = 'Optimization', controller, fetchMethod = fetch, init, url }) {
+function createRetryFetchCallback({ apiName = 'Optimization', controller, fetchMethod, init, url }) {
     return async ()=>{
+        const urlLabel = fetchInputToString(url);
         try {
             const response = await fetchMethod(url, init);
-            if (response.status === RETRY_RESPONSE_STATUS) throw new HttpError(`${apiName} API request to "${url.toString()}" failed with status: "[${response.status}] ${response.statusText}".`, RETRY_RESPONSE_STATUS);
+            if (response.status === RETRY_RESPONSE_STATUS) throw new HttpError(`${apiName} API request to "${urlLabel}" failed with status: "[${response.status}] ${response.statusText}".`, RETRY_RESPONSE_STATUS);
             if (!response.ok) {
-                const httpError = new Error(`Request to "${url.toString()}" failed with status: [${response.status}] ${response.statusText} - traceparent: ${response.headers.get('traceparent')}`);
+                const httpError = new Error(`Request to "${urlLabel}" failed with status: [${response.status}] ${response.statusText} - traceparent: ${response.headers.get('traceparent')}`);
                 logger.error('Request failed with non-OK status:', httpError);
                 controller.abort();
                 return;
             }
-            logger.debug(`Response from "${url.toString()}":`, response);
+            logger.debug(`Response from "${urlLabel}":`, response);
             return response;
         } catch (error) {
             if (error instanceof HttpError && error.status === RETRY_RESPONSE_STATUS) throw error;
-            logger.error(`Request to "${url.toString()}" failed:`, error);
+            logger.error(`Request to "${urlLabel}" failed:`, error);
             controller.abort();
         }
     };
@@ -43,14 +52,15 @@ async function delayRetry(intervalTimeout) {
     }, intervalTimeout);
     await promise;
 }
-function createRetryFetchMethod({ apiName = 'Optimization', fetchMethod = fetch, intervalTimeout = DEFAULT_INTERVAL_TIMEOUT, onFailedAttempt, retries = DEFAULT_RETRY_COUNT } = {}) {
+function createRetryFetchMethod({ apiName = 'Optimization', fetchMethod, intervalTimeout = DEFAULT_INTERVAL_TIMEOUT, onFailedAttempt, retries = DEFAULT_RETRY_COUNT } = {}) {
+    const resolvedFetchMethod = resolveFetchMethod(fetchMethod);
     return async (url, init)=>{
         const controller = new AbortController();
         const maxAttempts = retries + 1;
         const attemptFetch = createRetryFetchCallback({
             apiName,
             controller,
-            fetchMethod,
+            fetchMethod: resolvedFetchMethod,
             init,
             url
         });
@@ -70,25 +80,32 @@ function createRetryFetchMethod({ apiName = 'Optimization', fetchMethod = fetch,
             if (0 === retriesLeft) throw error;
             await delayRetry(intervalTimeout);
         }
-        throw new Error(`${apiName} API request to "${url.toString()}" may not be retried.`);
+        throw new Error(`${apiName} API request to "${fetchInputToString(url)}" may not be retried.`);
     };
 }
 const createTimeoutFetchMethod_logger = createScopedLogger('ApiClient:Timeout');
 const DEFAULT_REQUEST_TIMEOUT = 3000;
-function createTimeoutFetchMethod({ apiName = 'Optimization', fetchMethod = fetch, onRequestTimeout, requestTimeout = DEFAULT_REQUEST_TIMEOUT } = {}) {
+function isFetchAbortSignal(signal) {
+    return 'object' == typeof signal && null !== signal;
+}
+function createTimeoutFetchMethod({ apiName = 'Optimization', fetchMethod, onRequestTimeout, requestTimeout = DEFAULT_REQUEST_TIMEOUT } = {}) {
+    const resolvedFetchMethod = resolveFetchMethod(fetchMethod);
     return async (url, init)=>{
         const controller = new AbortController();
         const id = setTimeout(()=>{
             if ('function' == typeof onRequestTimeout) onRequestTimeout({
                 apiName
             });
-            else createTimeoutFetchMethod_logger.error(`Request to "${url.toString()}" timed out`, new Error('Request timeout'));
+            else createTimeoutFetchMethod_logger.error(`Request to "${fetchInputToString(url)}" timed out`, new Error('Request timeout'));
             controller.abort();
         }, requestTimeout);
-        const response = await fetchMethod(url, {
+        const { signal } = controller;
+        if (!isFetchAbortSignal(signal)) throw new Error('AbortController signal is not compatible with fetch.');
+        const requestInit = {
             ...init,
-            signal: controller.signal
-        });
+            signal
+        };
+        const response = await resolvedFetchMethod(url, requestInit);
         clearTimeout(id);
         return response;
     };
@@ -112,7 +129,7 @@ const Fetch = {
     create: createProtectedFetchMethod
 };
 const fetch_Fetch = Fetch;
-const src_fetch = fetch_Fetch;
+const fetch = fetch_Fetch;
 const ApiClientBase_logger = createScopedLogger('ApiClient');
 const DEFAULT_ENVIRONMENT = 'main';
 class ApiClientBase {
@@ -124,7 +141,7 @@ class ApiClientBase {
         this.clientId = clientId;
         this.environment = environment ?? DEFAULT_ENVIRONMENT;
         this.name = name;
-        this.fetch = src_fetch.create({
+        this.fetch = fetch.create({
             ...fetchOptions ?? {},
             apiName: name
         });
@@ -154,6 +171,9 @@ class ExperienceApiClient extends src_ApiClientBase {
         this.plainText = plainText;
         this.preflight = preflight;
     }
+    setLocale(locale) {
+        this.locale = locale;
+    }
     async getProfile(id, options = {}) {
         if (!id) throw new Error('Valid profile ID required.');
         const requestName = 'Get Profile';
@@ -165,7 +185,7 @@ class ExperienceApiClient extends src_ApiClientBase {
             const { data: { changes, experiences, profile } } = (0, __rspack_external__contentful_optimization_api_schemas_66dcf407.parseWithFriendlyError)(__rspack_external__contentful_optimization_api_schemas_66dcf407.ExperienceResponse, await response.json());
             const data = {
                 changes,
-                personalizations: experiences,
+                selectedOptimizations: experiences,
                 profile
             };
             ExperienceApiClient_logger.debug(`"${requestName}" request successfully completed`);
@@ -199,7 +219,7 @@ class ExperienceApiClient extends src_ApiClientBase {
             const { data: { changes, experiences, profile } } = (0, __rspack_external__contentful_optimization_api_schemas_66dcf407.parseWithFriendlyError)(__rspack_external__contentful_optimization_api_schemas_66dcf407.ExperienceResponse, await response.json());
             const data = {
                 changes,
-                personalizations: experiences,
+                selectedOptimizations: experiences,
                 profile
             };
             ExperienceApiClient_logger.debug(`"${requestName}" request successfully completed`);
@@ -226,7 +246,7 @@ class ExperienceApiClient extends src_ApiClientBase {
             const { data: { changes, experiences, profile } } = (0, __rspack_external__contentful_optimization_api_schemas_66dcf407.parseWithFriendlyError)(__rspack_external__contentful_optimization_api_schemas_66dcf407.ExperienceResponse, await response.json());
             const data = {
                 changes,
-                personalizations: experiences,
+                selectedOptimizations: experiences,
                 profile
             };
             ExperienceApiClient_logger.debug(`"${requestName}" request successfully completed`);
@@ -305,39 +325,43 @@ class ExperienceApiClient extends src_ApiClientBase {
         });
     }
 }
-const experience = ExperienceApiClient;
 const InsightsApiClient_logger = createScopedLogger('ApiClient:Insights');
+const BEACON_FALLBACK_MESSAGE = 'beacon failed; falling back to fetch';
 const INSIGHTS_BASE_URL = 'https://ingest.insights.ninetailed.co/';
 class InsightsApiClient extends src_ApiClientBase {
     baseUrl;
-    beaconHandler;
     constructor(config){
         super('Insights', config);
-        const { baseUrl, beaconHandler } = config;
+        const { baseUrl } = config;
         this.baseUrl = baseUrl || INSIGHTS_BASE_URL;
-        this.beaconHandler = beaconHandler;
     }
     async sendBatchEvents(batches, options = {}) {
-        const { beaconHandler = this.beaconHandler } = options;
+        const { beacon } = options;
         const url = new URL(`v1/organizations/${this.clientId}/environments/${this.environment}/events`, this.baseUrl);
+        const urlString = url.toString();
         const body = (0, __rspack_external__contentful_optimization_api_schemas_66dcf407.parseWithFriendlyError)(__rspack_external__contentful_optimization_api_schemas_66dcf407.BatchInsightsEventArray, batches);
-        if ('function' == typeof beaconHandler) {
-            InsightsApiClient_logger.debug('Queueing events via beaconHandler');
-            const beaconSuccessfullyQueued = beaconHandler(url, body);
-            if (beaconSuccessfullyQueued) return true;
-            InsightsApiClient_logger.warn('beaconHandler failed to queue events; events will be emitted immediately via fetch');
+        const serializedBody = JSON.stringify(body);
+        if (beacon) {
+            InsightsApiClient_logger.debug('Queueing events via beacon');
+            try {
+                const beaconSuccessfullyQueued = beacon(urlString, serializedBody);
+                if (beaconSuccessfullyQueued) return true;
+                InsightsApiClient_logger.warn(BEACON_FALLBACK_MESSAGE);
+            } catch (error) {
+                InsightsApiClient_logger.warn(BEACON_FALLBACK_MESSAGE, error);
+            }
         }
         const requestName = 'Event Batches';
         InsightsApiClient_logger.info(`Sending "${requestName}" request`);
         InsightsApiClient_logger.debug(`"${requestName}" request body:`, body);
         try {
-            await this.fetch(url, {
+            await this.fetch(urlString, {
                 method: 'POST',
                 headers: {
                     'Content-Type': 'application/json'
                 },
-                body: JSON.stringify(body),
-                keepalive: true
+                body: serializedBody,
+                keepalive: !!beacon
             });
             InsightsApiClient_logger.debug(`"${requestName}" request successfully completed`);
             return true;
@@ -349,202 +373,28 @@ class InsightsApiClient extends src_ApiClientBase {
         }
     }
 }
-const insights = InsightsApiClient;
 class ApiClient {
     config;
     experience;
     insights;
     constructor(config){
-        const { personalization, analytics, clientId, environment, fetchOptions } = config;
+        const { experience, insights, clientId, environment, fetchOptions } = config;
         const apiConfig = {
             clientId,
             environment,
             fetchOptions
         };
         this.config = apiConfig;
-        this.experience = new experience({
+        this.experience = new ExperienceApiClient({
             ...apiConfig,
-            ...personalization
+            ...experience
         });
-        this.insights = new insights({
+        this.insights = new InsightsApiClient({
             ...apiConfig,
-            ...analytics
+            ...insights
         });
     }
 }
-const UniversalEventBuilderArgs = object({
-    campaign: optional(__rspack_external__contentful_optimization_api_schemas_66dcf407.Campaign),
-    locale: optional(string()),
-    location: optional(__rspack_external__contentful_optimization_api_schemas_66dcf407.GeoLocation),
-    page: optional(__rspack_external__contentful_optimization_api_schemas_66dcf407.Page),
-    screen: optional(__rspack_external__contentful_optimization_api_schemas_66dcf407.Screen),
-    userAgent: optional(string())
-});
-const ComponentInteractionBuilderArgsBase = extend(UniversalEventBuilderArgs, {
-    componentId: string(),
-    experienceId: optional(string()),
-    variantIndex: optional(number())
-});
-const ComponentViewBuilderArgs = extend(ComponentInteractionBuilderArgsBase, {
-    sticky: optional(mini_boolean()),
-    componentViewId: string(),
-    viewDurationMs: number()
-});
-const ComponentClickBuilderArgs = ComponentInteractionBuilderArgsBase;
-const ComponentHoverBuilderArgs = extend(ComponentInteractionBuilderArgsBase, {
-    componentHoverId: string(),
-    hoverDurationMs: number()
-});
-const IdentifyBuilderArgs = extend(UniversalEventBuilderArgs, {
-    traits: optional(__rspack_external__contentful_optimization_api_schemas_66dcf407.Traits),
-    userId: string()
-});
-const PageViewBuilderArgs = extend(UniversalEventBuilderArgs, {
-    properties: optional(partial(__rspack_external__contentful_optimization_api_schemas_66dcf407.Page))
-});
-const ScreenViewBuilderArgs = extend(UniversalEventBuilderArgs, {
-    name: string(),
-    properties: __rspack_external__contentful_optimization_api_schemas_66dcf407.Properties
-});
-const TrackBuilderArgs = extend(UniversalEventBuilderArgs, {
-    event: string(),
-    properties: optional(prefault(__rspack_external__contentful_optimization_api_schemas_66dcf407.Properties, {}))
-});
-const DEFAULT_PAGE_PROPERTIES = {
-    path: '',
-    query: {},
-    referrer: '',
-    search: '',
-    title: '',
-    url: ''
-};
-class EventBuilder {
-    app;
-    channel;
-    library;
-    getLocale;
-    getPageProperties;
-    getUserAgent;
-    constructor(config){
-        const { app, channel, library, getLocale, getPageProperties, getUserAgent } = config;
-        this.app = app;
-        this.channel = channel;
-        this.library = library;
-        this.getLocale = getLocale ?? (()=>'en-US');
-        this.getPageProperties = getPageProperties ?? (()=>DEFAULT_PAGE_PROPERTIES);
-        this.getUserAgent = getUserAgent ?? (()=>void 0);
-    }
-    buildUniversalEventProperties({ campaign = {}, locale, location, page, screen, userAgent }) {
-        const timestamp = new Date().toISOString();
-        return {
-            channel: this.channel,
-            context: {
-                app: this.app,
-                campaign,
-                gdpr: {
-                    isConsentGiven: true
-                },
-                library: this.library,
-                locale: locale ?? this.getLocale() ?? 'en-US',
-                location,
-                page: page ?? this.getPageProperties(),
-                screen,
-                userAgent: userAgent ?? this.getUserAgent()
-            },
-            messageId: crypto.randomUUID(),
-            originalTimestamp: timestamp,
-            sentAt: timestamp,
-            timestamp
-        };
-    }
-    buildEntryComponentBase(universal, componentId, experienceId, variantIndex) {
-        return {
-            ...this.buildUniversalEventProperties(universal),
-            componentType: 'Entry',
-            componentId,
-            experienceId,
-            variantIndex: variantIndex ?? 0
-        };
-    }
-    buildComponentView(args) {
-        const { componentId, componentViewId, experienceId, variantIndex, viewDurationMs, ...universal } = (0, __rspack_external__contentful_optimization_api_schemas_66dcf407.parseWithFriendlyError)(ComponentViewBuilderArgs, args);
-        return {
-            ...this.buildEntryComponentBase(universal, componentId, experienceId, variantIndex),
-            type: 'component',
-            componentViewId,
-            viewDurationMs
-        };
-    }
-    buildComponentClick(args) {
-        const { componentId, experienceId, variantIndex, ...universal } = (0, __rspack_external__contentful_optimization_api_schemas_66dcf407.parseWithFriendlyError)(ComponentClickBuilderArgs, args);
-        return {
-            ...this.buildEntryComponentBase(universal, componentId, experienceId, variantIndex),
-            type: 'component_click'
-        };
-    }
-    buildComponentHover(args) {
-        const { componentHoverId, componentId, experienceId, hoverDurationMs, variantIndex, ...universal } = (0, __rspack_external__contentful_optimization_api_schemas_66dcf407.parseWithFriendlyError)(ComponentHoverBuilderArgs, args);
-        return {
-            ...this.buildEntryComponentBase(universal, componentId, experienceId, variantIndex),
-            type: 'component_hover',
-            componentHoverId,
-            hoverDurationMs
-        };
-    }
-    buildFlagView(args) {
-        return {
-            ...this.buildComponentView(args),
-            componentType: 'Variable'
-        };
-    }
-    buildIdentify(args) {
-        const { traits = {}, userId, ...universal } = (0, __rspack_external__contentful_optimization_api_schemas_66dcf407.parseWithFriendlyError)(IdentifyBuilderArgs, args);
-        return {
-            ...this.buildUniversalEventProperties(universal),
-            type: 'identify',
-            traits,
-            userId
-        };
-    }
-    buildPageView(args = {}) {
-        const { properties = {}, ...universal } = (0, __rspack_external__contentful_optimization_api_schemas_66dcf407.parseWithFriendlyError)(PageViewBuilderArgs, args);
-        const pageProperties = this.getPageProperties();
-        const merged = merge({
-            ...pageProperties,
-            title: pageProperties.title ?? DEFAULT_PAGE_PROPERTIES.title
-        }, properties);
-        const { context: { screen: _, ...universalContext }, ...universalProperties } = this.buildUniversalEventProperties(universal);
-        const context = (0, __rspack_external__contentful_optimization_api_schemas_66dcf407.parseWithFriendlyError)(__rspack_external__contentful_optimization_api_schemas_66dcf407.PageEventContext, universalContext);
-        return {
-            ...universalProperties,
-            context,
-            type: 'page',
-            properties: merged
-        };
-    }
-    buildScreenView(args) {
-        const { name, properties, ...universal } = (0, __rspack_external__contentful_optimization_api_schemas_66dcf407.parseWithFriendlyError)(ScreenViewBuilderArgs, args);
-        const { context: { page: _, ...universalContext }, ...universalProperties } = this.buildUniversalEventProperties(universal);
-        const context = (0, __rspack_external__contentful_optimization_api_schemas_66dcf407.parseWithFriendlyError)(__rspack_external__contentful_optimization_api_schemas_66dcf407.ScreenEventContext, universalContext);
-        return {
-            ...universalProperties,
-            context,
-            type: 'screen',
-            name,
-            properties
-        };
-    }
-    buildTrack(args) {
-        const { event, properties = {}, ...universal } = (0, __rspack_external__contentful_optimization_api_schemas_66dcf407.parseWithFriendlyError)(TrackBuilderArgs, args);
-        return {
-            ...this.buildUniversalEventProperties(universal),
-            type: 'track',
-            event,
-            properties
-        };
-    }
-}
-const builders_EventBuilder = EventBuilder;
-export { ApiClient, DEFAULT_PAGE_PROPERTIES, EXPERIENCE_BASE_URL, INSIGHTS_BASE_URL, builders_EventBuilder as EventBuilder };
+export { ApiClient, EXPERIENCE_BASE_URL, ExperienceApiClient, INSIGHTS_BASE_URL, InsightsApiClient, createProtectedFetchMethod, createRetryFetchMethod, createTimeoutFetchMethod };
 
 //# sourceMappingURL=index.mjs.map