@contentful/optimization-core 0.1.0-alpha11 → 0.1.0-alpha12

package/README.md

@@ -1,6 +1,6 @@
 <p align="center">
   <a href="https://www.contentful.com/developers/docs/personalization/">
-    <img alt="Contentful Logo" title="Contentful" src="https://raw.githubusercontent.com/contentful/optimization/v0.1.0-alpha11/contentful-icon.png" width="150">
+    <img alt="Contentful Logo" title="Contentful" src="https://raw.githubusercontent.com/contentful/optimization/v0.1.0-alpha12/contentful-icon.png" width="150">
   </a>
 </p>
 
@@ -11,7 +11,7 @@
 <div align="center">
 
 [Guides](https://contentful.github.io/optimization/documents/Guides.html) ·
-[Reference](https://contentful.github.io/optimization) · [Contributing](https://github.com/contentful/optimization/blob/v0.1.0-alpha11/CONTRIBUTING.md)
+[Reference](https://contentful.github.io/optimization) · [Contributing](https://github.com/contentful/optimization/blob/v0.1.0-alpha12/CONTRIBUTING.md)
 
 </div>
 
@@ -84,7 +84,9 @@ Configure and initialize the Core SDK:
 ```ts
 const statefulOptimization = new CoreStateful({ clientId: 'abc123' })
 const statelessOptimization = new CoreStateless({ clientId: 'abc123' })
-const requestOptimization = statelessOptimization.forRequest()
+const requestOptions = { locale: 'de-DE' }
+
+await statelessOptimization.page({}, requestOptions)
 ```
 
 ## Working with Stateless Core
@@ -97,8 +99,8 @@ In stateless environments, Core will not maintain any internal state, which incl
 These concerns should be handled by consumers to fit their specific architectural and design
 specifications.
 
-Request-emitting methods in `CoreStateless` are bound per request via
-`optimization.forRequest(...)`.
+Request-scoped Experience options in `CoreStateless` are passed as the final argument to each
+stateless event method.
 
 ## Working with Stateful Core
 
@@ -164,8 +166,8 @@ Configuration method signatures:
 
 - `beaconHandler`: `(url: string | URL, data: BatchInsightsEventArray) => boolean`
 
-In stateless environments, bind `ip`, `locale`, `plainText`, and `preflight` per request with
-`optimization.forRequest(...)` instead of constructor config.
+In stateless environments, pass `ip`, `locale`, `plainText`, and `preflight` as the final argument
+to stateless event methods instead of constructor config.
 
 ### Queue Policy Options
 
@@ -375,14 +377,19 @@ Arguments:
 ### Event Methods
 
 In `CoreStateful`, call these methods on the root instance. In `CoreStateless`, call them on the
-request scope returned by `optimization.forRequest(...)`:
+root instance and pass request-scoped Experience options as the final argument when needed:
 
 ```ts
-const requestOptimization = optimization.forRequest({
+const requestOptions = {
   locale: 'de-DE',
-})
+}
+
+await optimization.page({ ...requestContext, profile }, requestOptions)
 ```
 
+Request-scoped Experience options stay separate from the event payload. Event context data belongs
+in `payload`, while `ip`, `locale`, `plainText`, and `preflight` belong in `requestOptions`.
+
 Only the following methods may return an `OptimizationData` object:
 
 - `identify`
@@ -411,6 +418,7 @@ Arguments:
 
 - `payload`\*: Identify event builder arguments object, including an optional `profile` property
   with a `PartialProfile` value that requires only an `id`
+- `requestOptions`: Optional request-scoped Experience API options passed as the final argument
 
 #### `page`
 
@@ -420,6 +428,7 @@ Arguments:
 
 - `payload`\*: Page view event builder arguments object, including an optional `profile` property
   with a `PartialProfile` value that requires only an `id`
+- `requestOptions`: Optional request-scoped Experience API options passed as the final argument
 
 #### `screen`
 
@@ -429,6 +438,7 @@ Arguments:
 
 - `payload`\*: Screen view event builder arguments object, including an optional `profile` property
   with a `PartialProfile` value that requires only an `id`
+- `requestOptions`: Optional request-scoped Experience API options passed as the final argument
 
 #### `track`
 
@@ -438,6 +448,7 @@ Arguments:
 
 - `payload`\*: Track event builder arguments object, including an optional `profile` property with a
   `PartialProfile` value that requires only an `id`
+- `requestOptions`: Optional request-scoped Experience API options passed as the final argument
 
 #### `trackView`
 
@@ -450,6 +461,8 @@ Arguments:
 - `payload`\*: Entry view event builder arguments object. When `payload.sticky` is `true`, `profile`
   is optional and the returned Experience profile is reused for Insights delivery. Otherwise,
   `profile` is required and must contain at least an `id`
+- `requestOptions`: Optional request-scoped Experience API options passed as the final argument.
+  Only used when `payload.sticky` is `true`
 
 #### `trackClick`
 
@@ -463,6 +476,8 @@ Arguments:
 
 - `payload`\*: Entry click event builder arguments object, including a required `profile` property
   with a `PartialProfile` value that requires only an `id`
+- `requestOptions`: Optional request-scoped Experience API options accepted for signature
+  consistency; currently unused
 
 #### `trackHover`
 
@@ -476,6 +491,8 @@ Arguments:
 
 - `payload`\*: Entry hover event builder arguments object, including a required `profile` property
   with a `PartialProfile` value that requires only an `id`
+- `requestOptions`: Optional request-scoped Experience API options accepted for signature
+  consistency; currently unused
 
 #### `trackFlagView`
 
@@ -490,6 +507,8 @@ Arguments:
 
 - `payload`\*: Flag view event builder arguments object, including a required `profile` property
   with a `PartialProfile` value that requires only an `id`
+- `requestOptions`: Optional request-scoped Experience API options accepted for signature
+  consistency; currently unused
 
 ## Stateful-only Core Methods
 

package/dist/260.mjs

@@ -1,4 +1,4 @@
-const OPTIMIZATION_CORE_SDK_VERSION = "0.1.0-alpha11";
+const OPTIMIZATION_CORE_SDK_VERSION = "0.1.0-alpha12";
 const OPTIMIZATION_CORE_SDK_NAME = "@contentful/optimization-core";
 const ANONYMOUS_ID_COOKIE = 'ctfl-opt-aid';
 const ANONYMOUS_ID_KEY = '__ctfl_opt_anonymous_id__';

package/dist/constants.cjs

@@ -36,7 +36,7 @@ __webpack_require__.d(__webpack_exports__, {
     PROFILE_CACHE_KEY: ()=>PROFILE_CACHE_KEY,
     SELECTED_OPTIMIZATIONS_CACHE_KEY: ()=>SELECTED_OPTIMIZATIONS_CACHE_KEY
 });
-const OPTIMIZATION_CORE_SDK_VERSION = "0.1.0-alpha11";
+const OPTIMIZATION_CORE_SDK_VERSION = "0.1.0-alpha12";
 const OPTIMIZATION_CORE_SDK_NAME = "@contentful/optimization-core";
 const ANONYMOUS_ID_COOKIE = 'ctfl-opt-aid';
 const ANONYMOUS_ID_KEY = '__ctfl_opt_anonymous_id__';

package/dist/index.cjs

@@ -22,7 +22,7 @@ var __webpack_modules__ = {
             PROFILE_CACHE_KEY: ()=>PROFILE_CACHE_KEY,
             SELECTED_OPTIMIZATIONS_CACHE_KEY: ()=>SELECTED_OPTIMIZATIONS_CACHE_KEY
         });
-        const OPTIMIZATION_CORE_SDK_VERSION = "0.1.0-alpha11";
+        const OPTIMIZATION_CORE_SDK_VERSION = "0.1.0-alpha12";
         const OPTIMIZATION_CORE_SDK_NAME = "@contentful/optimization-core";
         const ANONYMOUS_ID_COOKIE = 'ctfl-opt-aid';
         const ANONYMOUS_ID_KEY = '__ctfl_opt_anonymous_id__';
@@ -124,7 +124,6 @@ var __webpack_exports__ = {};
         UniversalEventBuilderArgs: ()=>UniversalEventBuilderArgs,
         EntryInteractionBuilderArgsBase: ()=>EntryInteractionBuilderArgsBase,
         effect: ()=>signals_core_namespaceObject.effect,
-        CoreStatelessRequestScope: ()=>CoreStatelessRequestScope,
         PREVIEW_PANEL_SIGNALS_SYMBOL: ()=>symbols.PREVIEW_PANEL_SIGNALS_SYMBOL,
         guardedBy: ()=>guardedBy,
         CHANGES_CACHE_KEY: ()=>constants.CHANGES_CACHE_KEY,
@@ -1362,76 +1361,89 @@ var __webpack_exports__ = {};
     }
     const src_CoreStateful = CoreStateful;
     var api_schemas = __webpack_require__("./src/api-schemas.ts");
-    const TRACK_CLICK_PROFILE_ERROR = 'CoreStateless.forRequest().trackClick() requires `payload.profile.id` for Insights delivery.';
-    const TRACK_HOVER_PROFILE_ERROR = 'CoreStateless.forRequest().trackHover() requires `payload.profile.id` for Insights delivery.';
-    const TRACK_FLAG_VIEW_PROFILE_ERROR = 'CoreStateless.forRequest().trackFlagView() requires `payload.profile.id` for Insights delivery.';
-    const NON_STICKY_TRACK_VIEW_PROFILE_ERROR = 'CoreStateless.forRequest().trackView() requires `payload.profile.id` when `payload.sticky` is not `true`.';
-    const STICKY_TRACK_VIEW_PROFILE_ERROR = 'CoreStateless.forRequest().trackView() could not derive a profile from the sticky Experience response. Pass `payload.profile.id` explicitly if you need a fallback.';
+    const TRACK_CLICK_PROFILE_ERROR = 'CoreStateless.trackClick() requires `payload.profile.id` for Insights delivery.';
+    const TRACK_HOVER_PROFILE_ERROR = 'CoreStateless.trackHover() requires `payload.profile.id` for Insights delivery.';
+    const TRACK_FLAG_VIEW_PROFILE_ERROR = 'CoreStateless.trackFlagView() requires `payload.profile.id` for Insights delivery.';
+    const NON_STICKY_TRACK_VIEW_PROFILE_ERROR = 'CoreStateless.trackView() requires `payload.profile.id` when `payload.sticky` is not `true`.';
+    const STICKY_TRACK_VIEW_PROFILE_ERROR = 'CoreStateless.trackView() could not derive a profile from the sticky Experience response. Pass `payload.profile.id` explicitly if you need a fallback.';
+    const CoreStateless_hasDefinedValues = (record)=>Object.values(record).some((value)=>void 0 !== value);
     const requireInsightsProfile = (profile, errorMessage)=>{
         if (void 0 !== profile) return profile;
         throw new Error(errorMessage);
     };
-    class CoreStatelessRequestScope {
-        core;
-        options;
-        constructor(core, options = {}){
-            this.core = core;
-            this.options = Object.freeze({
-                ...options
+    const createStatelessExperienceApiConfig = (api)=>{
+        if (void 0 === api) return;
+        const experienceConfig = {
+            baseUrl: api.experienceBaseUrl,
+            enabledFeatures: api.enabledFeatures
+        };
+        return CoreStateless_hasDefinedValues(experienceConfig) ? experienceConfig : void 0;
+    };
+    const createStatelessInsightsApiConfig = (api)=>{
+        if (api?.insightsBaseUrl === void 0) return;
+        return {
+            baseUrl: api.insightsBaseUrl
+        };
+    };
+    class CoreStateless extends src_CoreBase {
+        constructor(config){
+            super(config, {
+                experience: createStatelessExperienceApiConfig(config.api),
+                insights: createStatelessInsightsApiConfig(config.api)
             });
         }
-        async identify(payload) {
+        async identify(payload, requestOptions) {
             const { profile, ...builderArgs } = payload;
-            return await this.sendExperienceEvent(this.core.eventBuilder.buildIdentify(builderArgs), profile);
+            return await this.sendExperienceEvent(this.eventBuilder.buildIdentify(builderArgs), profile, requestOptions);
         }
-        async page(payload = {}) {
+        async page(payload = {}, requestOptions) {
             const { profile, ...builderArgs } = payload;
-            return await this.sendExperienceEvent(this.core.eventBuilder.buildPageView(builderArgs), profile);
+            return await this.sendExperienceEvent(this.eventBuilder.buildPageView(builderArgs), profile, requestOptions);
         }
-        async screen(payload) {
+        async screen(payload, requestOptions) {
             const { profile, ...builderArgs } = payload;
-            return await this.sendExperienceEvent(this.core.eventBuilder.buildScreenView(builderArgs), profile);
+            return await this.sendExperienceEvent(this.eventBuilder.buildScreenView(builderArgs), profile, requestOptions);
         }
-        async track(payload) {
+        async track(payload, requestOptions) {
             const { profile, ...builderArgs } = payload;
-            return await this.sendExperienceEvent(this.core.eventBuilder.buildTrack(builderArgs), profile);
+            return await this.sendExperienceEvent(this.eventBuilder.buildTrack(builderArgs), profile, requestOptions);
         }
-        async trackView(payload) {
+        async trackView(payload, requestOptions) {
             const { profile, ...builderArgs } = payload;
             let result;
             let insightsProfile = profile;
             if (payload.sticky) {
-                result = await this.sendExperienceEvent(this.core.eventBuilder.buildView(builderArgs), profile);
+                result = await this.sendExperienceEvent(this.eventBuilder.buildView(builderArgs), profile, requestOptions);
                 const { profile: responseProfile } = result;
                 insightsProfile = responseProfile;
             }
-            await this.sendInsightsEvent(this.core.eventBuilder.buildView(builderArgs), requireInsightsProfile(insightsProfile, payload.sticky ? STICKY_TRACK_VIEW_PROFILE_ERROR : NON_STICKY_TRACK_VIEW_PROFILE_ERROR));
+            await this.sendInsightsEvent(this.eventBuilder.buildView(builderArgs), requireInsightsProfile(insightsProfile, payload.sticky ? STICKY_TRACK_VIEW_PROFILE_ERROR : NON_STICKY_TRACK_VIEW_PROFILE_ERROR));
             return result;
         }
-        async trackClick(payload) {
+        async trackClick(payload, _requestOptions) {
             const { profile, ...builderArgs } = payload;
-            await this.sendInsightsEvent(this.core.eventBuilder.buildClick(builderArgs), requireInsightsProfile(profile, TRACK_CLICK_PROFILE_ERROR));
+            await this.sendInsightsEvent(this.eventBuilder.buildClick(builderArgs), requireInsightsProfile(profile, TRACK_CLICK_PROFILE_ERROR));
         }
-        async trackHover(payload) {
+        async trackHover(payload, _requestOptions) {
             const { profile, ...builderArgs } = payload;
-            await this.sendInsightsEvent(this.core.eventBuilder.buildHover(builderArgs), requireInsightsProfile(profile, TRACK_HOVER_PROFILE_ERROR));
+            await this.sendInsightsEvent(this.eventBuilder.buildHover(builderArgs), requireInsightsProfile(profile, TRACK_HOVER_PROFILE_ERROR));
         }
-        async trackFlagView(payload) {
+        async trackFlagView(payload, _requestOptions) {
             const { profile, ...builderArgs } = payload;
-            await this.sendInsightsEvent(this.core.eventBuilder.buildFlagView(builderArgs), requireInsightsProfile(profile, TRACK_FLAG_VIEW_PROFILE_ERROR));
+            await this.sendInsightsEvent(this.eventBuilder.buildFlagView(builderArgs), requireInsightsProfile(profile, TRACK_FLAG_VIEW_PROFILE_ERROR));
         }
-        async sendExperienceEvent(event, profile) {
-            const intercepted = await this.core.interceptors.event.run(event);
+        async sendExperienceEvent(event, profile, requestOptions) {
+            const intercepted = await this.interceptors.event.run(event);
             const validEvent = (0, api_schemas_.parseWithFriendlyError)(api_schemas_.ExperienceEvent, intercepted);
-            return await this.core.api.experience.upsertProfile({
+            return await this.api.experience.upsertProfile({
                 profileId: profile?.id,
                 events: [
                     validEvent
                 ]
-            }, this.options);
+            }, requestOptions);
         }
         async sendInsightsEvent(event, profile) {
-            const intercepted = await this.core.interceptors.event.run(event);
+            const intercepted = await this.interceptors.event.run(event);
             const validEvent = (0, api_schemas_.parseWithFriendlyError)(api_schemas_.InsightsEvent, intercepted);
             const batchEvent = (0, api_schemas_.parseWithFriendlyError)(api_schemas_.BatchInsightsEventArray, [
                 {
@@ -1441,33 +1453,7 @@ var __webpack_exports__ = {};
                     ]
                 }
             ]);
-            await this.core.api.insights.sendBatchEvents(batchEvent);
-        }
-    }
-    const CoreStateless_hasDefinedValues = (record)=>Object.values(record).some((value)=>void 0 !== value);
-    const createStatelessExperienceApiConfig = (api)=>{
-        if (void 0 === api) return;
-        const experienceConfig = {
-            baseUrl: api.experienceBaseUrl,
-            enabledFeatures: api.enabledFeatures
-        };
-        return CoreStateless_hasDefinedValues(experienceConfig) ? experienceConfig : void 0;
-    };
-    const createStatelessInsightsApiConfig = (api)=>{
-        if (api?.insightsBaseUrl === void 0) return;
-        return {
-            baseUrl: api.insightsBaseUrl
-        };
-    };
-    class CoreStateless extends src_CoreBase {
-        constructor(config){
-            super(config, {
-                experience: createStatelessExperienceApiConfig(config.api),
-                insights: createStatelessInsightsApiConfig(config.api)
-            });
-        }
-        forRequest(options = {}) {
-            return new CoreStatelessRequestScope(this, options);
+            await this.api.insights.sendBatchEvents(batchEvent);
         }
     }
     const src_CoreStateless = CoreStateless;
@@ -1524,7 +1510,6 @@ exports.CONSENT_KEY = __webpack_exports__.CONSENT_KEY;
 exports.ClickBuilderArgs = __webpack_exports__.ClickBuilderArgs;
 exports.CoreStateful = __webpack_exports__.CoreStateful;
 exports.CoreStateless = __webpack_exports__.CoreStateless;
-exports.CoreStatelessRequestScope = __webpack_exports__.CoreStatelessRequestScope;
 exports.DEBUG_FLAG_KEY = __webpack_exports__.DEBUG_FLAG_KEY;
 exports.DEFAULT_PAGE_PROPERTIES = __webpack_exports__.DEFAULT_PAGE_PROPERTIES;
 exports.EntryInteractionBuilderArgsBase = __webpack_exports__.EntryInteractionBuilderArgsBase;
@@ -1564,7 +1549,6 @@ for(var __rspack_i in __webpack_exports__)if (-1 === [
     "ClickBuilderArgs",
     "CoreStateful",
     "CoreStateless",
-    "CoreStatelessRequestScope",
     "DEBUG_FLAG_KEY",
     "DEFAULT_PAGE_PROPERTIES",
     "EntryInteractionBuilderArgsBase",