@remkoj/optimizely-one-nextjs 6.0.0-pre9 → 6.0.0-rc.3

package/AGENTS.md

@@ -0,0 +1,130 @@
+# @remkoj/optimizely-one-nextjs — usage
+
+Optimizely One integration for Next.js — connects Optimizely Data Platform (ODP),
+Content Recommendations, and Web Experimentation to a Next.js application.
+
+## Install
+
+```bash
+npm install @remkoj/optimizely-one-nextjs
+```
+
+Requires Node `>=24.0.0 <25.0.0`. Import the stylesheet in your root layout.
+
+```typescript
+import '@remkoj/optimizely-one-nextjs/dist/styles.css'
+```
+
+## Environment variables
+
+| Variable | Description |
+| --- | --- |
+| `OPTIMIZELY_ONE_HELPER` | Enable/disable the Optimizely One helper (default: `false`) |
+| `ODP_API_KEY` | Optimizely Data Platform API key |
+| `ODP_SERVICE` | ODP service endpoint (default: `https://api.zaius.com/`) |
+| `CONTENT_RECS_CLIENT` | Content Recommendations client ID |
+| `CONTENT_RECS_DELIVERY_KEY` | Content Recommendations API key |
+| `WEB_EXPERIMENTATION_PROJECT` | Web Experimentation project ID |
+| `OPTIMIZELY_DEBUG` | Set to `"1"` for debug logging |
+
+## Subpath exports
+
+| Import path | Contents |
+| --- | --- |
+| `@remkoj/optimizely-one-nextjs` | Core types and configuration |
+| `@remkoj/optimizely-one-nextjs/api` | Next.js API route handlers for Optimizely One |
+| `@remkoj/optimizely-one-nextjs/client` | Client-side components and hooks |
+| `@remkoj/optimizely-one-nextjs/server` | Server-side utilities |
+
+## Configuration
+
+```typescript
+import { readConfigFromEnv } from '@remkoj/optimizely-one-nextjs'
+
+// Reads all Optimizely One config from environment variables
+const config = readConfigFromEnv()
+```
+
+## API routes
+
+Mount the Optimizely One API handler in `app/api/me/[[...path]]/route.ts`.
+The catch-all segment name must match `pathParameterName` (default: `'path'`).
+
+```typescript
+import { createOptimizelyOneApi } from '@remkoj/optimizely-one-nextjs/api'
+
+const handler = createOptimizelyOneApi()
+
+export const GET = handler
+export const POST = handler
+export const runtime = 'nodejs'
+export const dynamic = 'force-dynamic'
+```
+
+## Server-side product clients (import from `./api` or `./server`)
+
+`DataPlatform` and `ContentRecs` are available as named exports from both `./api` and `./server`.
+
+```typescript
+import { DataPlatform, ContentRecs } from '@remkoj/optimizely-one-nextjs/api'
+// or from '@remkoj/optimizely-one-nextjs/server'
+
+// Optimizely Data Platform
+if (DataPlatform.Tools.isEnabled()) {
+  const vuid = DataPlatform.Tools.getVisitorID(cookies())
+  const client = new DataPlatform.Client()
+  const terms = await client.getLastSearchTerms(vuid)
+}
+
+// Content Recommendations
+if (ContentRecs.Tools.isEnabled()) {
+  const visitorId = ContentRecs.Tools.getVisitorID(cookies())
+  const client = new ContentRecs.Client()
+  const topics = await client.getContentTopics(visitorId)
+}
+```
+
+## Client components (import from `./client`)
+
+```typescript
+import {
+  OptimizelyOneProvider,  // context provider — wrap around your root layout body
+  OptimizelyOneGadget,    // debug panel; render only in dev/preview
+  PageActivator,          // fires page-view events on route change
+  ContentRecsDelivery,    // renders personalised content recommendations
+} from '@remkoj/optimizely-one-nextjs/client'
+
+// In root layout:
+<OptimizelyOneProvider>
+  <PageActivator />
+  {children}
+  <OptimizelyOneGadget enabled={enableDemoTools} />
+</OptimizelyOneProvider>
+
+// In a component:
+<ContentRecsDelivery
+  apiKey={deliveryApiKey}
+  count={3}
+  template={ArticleTemplate}
+  className="grid grid-cols-3"
+/>
+```
+
+## Server utilities (import from `./server`)
+
+```typescript
+import { Scripts, OptimizelyOneGadget, EnvTools } from '@remkoj/optimizely-one-nextjs/server'
+
+// Inject required tracking scripts
+<Scripts nonce={nonce} />
+
+// Read environment-controlled feature flags
+const enabled = EnvTools.readValueAsBoolean('OPTIMIZELY_ONE_HELPER', false)
+const key = EnvTools.readValue('GA_TRACKING_ID')
+```
+
+## Constraints
+
+- `dist/styles.css` must be imported at the application root; it is not injected automatically.
+- Server utilities (`./server`) are server-only; do not import from client components.
+- The API route must be a catch-all (`[[...path]]`) so every sub-path is handled by the same handler.

package/README.md

@@ -1,4 +1,8 @@
 # Next.JS Optimizely One toolkit <!-- omit in toc -->
+
+> [!WARNING]
+> There'll be an update of Optimizely SaaS CMS that is incompatible with all SDK versions prior to 5.1.6. If you don't upgrade, you will see empty pages (main website) and "Component not found" messages (preview).
+
 React components (both client & server) to integrate the browser-side products from Optimizely (Web Experimentation, Data Platform & Content Analytics / Recommendations)
 
 ## Table of Contents <!-- omit in toc -->
@@ -161,4 +165,4 @@ Using the Optimizely One Gadget it is possible to demonstrate the in-session beh
 ### 3.2. Selecting the Web Experimentation project in browser
 When the `OPTIMIZELY_ONE_HELPER` is set to "1" - or the Scripts.Header component has been instructed to do so explicitly - it is possible to change the Optimizely Web Experimentation project on the fly. This is done by adding a query string parameter `?pid=`, with the new project id.
 
-The project id is persisted in localStorage with the key `_pid` and needs to be removed manually to revert back to the configured Web Experimentation project.
+The project id is persisted in localStorage with the key `_pid` and needs to be removed manually to revert back to the configured Web Experimentation project.

package/dist/api/graph-info-service.js

@@ -3,7 +3,7 @@ import createAdminApi from '@remkoj/optimizely-graph-client/admin';
 import getConfig from '../config';
 export const GraphInfoApiService = {
     for: { path: '/graph', verb: 'get' },
-    handler: async (query, cookies) => {
+    handler: async () => {
         const config = getConfig();
         // Check if the toolkit is enabled
         if (!config.HelperEnabled)

package/dist/api/graph-info-service.js.map

@@ -1 +1 @@
-{"version":3,"file":"graph-info-service.js","sourceRoot":"","sources":["../../src/api/graph-info-service.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,SAAS,MAAM,aAAa,CAAA;AACxC,OAAO,cAAc,MAAM,uCAAuC,CAAA;AAClE,OAAO,SAAS,MAAM,WAAW,CAAA;AAGjC,MAAM,CAAC,MAAM,mBAAmB,GAAsC;IAClE,GAAG,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,KAAK,EAAE;IACpC,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE;QAC9B,MAAM,MAAM,GAAG,SAAS,EAAE,CAAA;QAC1B,kCAAkC;QAClC,IAAI,CAAC,MAAM,CAAC,aAAa;YACrB,OAAO,SAAS,CAAC,QAAQ,CAAA;QAE7B,MAAM,QAAQ,GAAG,cAAc,EAAE,CAAA;QAEjC,MAAM,KAAK,GAAG,MAAM,QAAQ,CAAC,QAAQ,CAAC,kBAAkB,EAAE,CAAA;QAC1D,MAAM,SAAS,GAAG,MAAM,QAAQ,CAAC,YAAY,CAAC,yBAAyB,EAAE,CAAA;QACzE,MAAM,OAAO,GAAW,EAAE,CAAA;QAC1B,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE,CAAC;YAC/B,MAAM,MAAM,GAAG,SAAS,CAAC,QAAQ,CAAC,CAAA;YAClC,OAAO,CAAC,IAAI,CAAC;gBACT,KAAK,EAAE,MAAM,CAAC,KAAK;gBACnB,SAAS,EAAE,MAAM,CAAC,SAAS;aAC9B,CAAC,CAAA;QACN,CAAC;QAED,OAAO,CAAC;gBACJ,KAAK,EAAE,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE;oBACpB,MAAM,OAAO,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAA;oBACzC,MAAM,UAAU,GAAG,OAAO,CAAC,QAAQ,GAAG,IAAI,GAAG,OAAO,CAAC,IAAI,GAAG,OAAO,CAAC,QAAQ,CAAA;oBAC5E,OAAO;wBACH,GAAG,EAAE,UAAU;wBACf,cAAc,EAAE,IAAI,CAAC,OAAO,CAAC,GAAG,IAAI,UAAU;wBAC9C,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,MAAM;qBAC9B,CAAA;gBACL,CAAC,CAAC;gBACF,OAAO;aACV,EAAE,GAAG,CAAC,CAAA;IACX,CAAC;CACJ,CAAA;AAED,eAAe,mBAAmB,CAAA"}
+{"version":3,"file":"graph-info-service.js","sourceRoot":"","sources":["../../src/api/graph-info-service.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,SAAS,MAAM,aAAa,CAAA;AACxC,OAAO,cAAc,MAAM,uCAAuC,CAAA;AAClE,OAAO,SAAS,MAAM,WAAW,CAAA;AAGjC,MAAM,CAAC,MAAM,mBAAmB,GAAsC;IACpE,GAAG,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,KAAK,EAAE;IACpC,OAAO,EAAE,KAAK,IAAI,EAAE;QAClB,MAAM,MAAM,GAAG,SAAS,EAAE,CAAA;QAC1B,kCAAkC;QAClC,IAAI,CAAC,MAAM,CAAC,aAAa;YACvB,OAAO,SAAS,CAAC,QAAQ,CAAA;QAE3B,MAAM,QAAQ,GAAG,cAAc,EAAE,CAAA;QAEjC,MAAM,KAAK,GAAG,MAAM,QAAQ,CAAC,QAAQ,CAAC,kBAAkB,EAAE,CAAA;QAC1D,MAAM,SAAS,GAAG,MAAM,QAAQ,CAAC,YAAY,CAAC,yBAAyB,EAAE,CAAA;QACzE,MAAM,OAAO,GAA4C,EAAE,CAAA;QAC3D,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE,CAAC;YACjC,MAAM,MAAM,GAAG,SAAS,CAAC,QAAQ,CAAC,CAAA;YAClC,OAAO,CAAC,IAAI,CAAC;gBACX,KAAK,EAAE,MAAM,CAAC,KAAK;gBACnB,SAAS,EAAE,MAAM,CAAC,SAAS;aAC5B,CAAC,CAAA;QACJ,CAAC;QAED,OAAO,CAAC;gBACN,KAAK,EAAE,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE;oBACtB,MAAM,OAAO,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAA;oBACzC,MAAM,UAAU,GAAG,OAAO,CAAC,QAAQ,GAAG,IAAI,GAAG,OAAO,CAAC,IAAI,GAAG,OAAO,CAAC,QAAQ,CAAA;oBAC5E,OAAO;wBACL,GAAG,EAAE,UAAU;wBACf,cAAc,EAAE,IAAI,CAAC,OAAO,CAAC,GAAG,IAAI,UAAU;wBAC9C,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,MAAM;qBAC5B,CAAA;gBACH,CAAC,CAAC;gBACF,OAAO;aACR,EAAE,GAAG,CAAC,CAAA;IACT,CAAC;CACF,CAAA;AAED,eAAe,mBAAmB,CAAA"}

package/dist/api/index.js

@@ -1,11 +1,13 @@
 import 'server-only';
 import { NextResponse } from 'next/server';
 import { cookies } from 'next/headers';
+// General services
 import ProfileApiService from './profile-api-service';
 import GraphInfoApiService from './graph-info-service';
-import ExperimentationApiService from './experimentation-api';
-import ContentRecsApiService from './content-recs';
-import ContentRecsGoalsService from './content-goals';
+// Product specific services
+import ExperimentationApiService from '../products/web-experimentation/webservice';
+import ContentRecsApiService from '../products/content-recs/webservice';
+import ContentRecsGoalsService from '../products/content-recs/webservice-goals';
 export function createOptimizelyOneApi(config) {
     const pathParameterName = config?.pathParameterName ?? 'path';
     const services = [

package/dist/api/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/api/index.ts"],"names":[],"mappings":"AAAA,OAAO,aAAa,CAAA;AACpB,OAAO,EAAoB,YAAY,EAAE,MAAM,aAAa,CAAA;AAC5D,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAA;AAEtC,OAAO,iBAAiB,MAAM,uBAAuB,CAAA;AACrD,OAAO,mBAAmB,MAAM,sBAAsB,CAAA;AACtD,OAAO,yBAAyB,MAAM,uBAAuB,CAAA;AAC7D,OAAO,qBAAqB,MAAM,gBAAgB,CAAA;AAClD,OAAO,uBAAuB,MAAM,iBAAiB,CAAA;AAkBrD,MAAM,UAAU,sBAAsB,CAAC,MAAwC;IAC7E,MAAM,iBAAiB,GAAG,MAAM,EAAE,iBAAiB,IAAI,MAAM,CAAA;IAC7D,MAAM,QAAQ,GAAG;QACf,GAAG,CAAC,MAAM,EAAE,QAAQ,IAAI,EAAE,CAAC;QAC3B,iBAAiB;QACjB,mBAAmB;QACnB,yBAAyB;QACzB,qBAAqB;QACrB,uBAAuB;KACxB,CAAA;IAED,wDAAwD;IACxD,SAAS,YAAY,CAAC,IAAY,EAAE,IAAY,EAAE,UAA6B;QAC7E,OAAO,UAAU,CAAC,IAAI,CAAC,WAAW,EAAE,IAAI,IAAI,CAAC,WAAW,EAAE;YACxD,UAAU,CAAC,IAAI,CAAC,WAAW,EAAE,IAAI,IAAI,CAAC,WAAW,EAAE,CAAA;IACvD,CAAC;IAED,KAAK,UAAU,OAAO,CAAC,OAAoB,EAAE,EAAE,MAAM,EAAE,WAAW,EAAkB;QAClF,iEAAiE;QACjE,MAAM,MAAM,GAAG,MAAM,WAAW,CAAA;QAChC,IAAI,OAAO,GAAkC,MAAM,CAAC,iBAAiB,CAAC,CAAA;QACtE,IAAI,CAAC,OAAO;YAAE,OAAO,GAAG,GAAG,CAAA;aACtB,IAAI,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC;YAAE,OAAO,GAAG,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;aAC7D,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,GAAG,CAAC;YAAE,OAAO,GAAG,GAAG,GAAG,OAAO,CAAA;QAC1D,MAAM,IAAI,GAAW,OAAO,CAAA;QAC5B,qMAAqM;QACrM,MAAM,IAAI,GAAG,OAAO,CAAC,MAAM,CAAA;QAE3B,mBAAmB;QACnB,MAAM,UAAU,GAAG,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,YAAY,CAAC,IAAI,EAAE,IAAI,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC,CAAA;QAClF,IAAI,CAAC,UAAU;YACb,OAAO,YAAY,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,EAAE,MAAM,EAAE,GAAG,EAAE,OAAO,EAAE,WAAW,EAAE,EAAE,EAAE,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC,CAAA;QAE7F,qBAAqB;QACrB,MAAM,CAAC,GAAG,OAAO,EAAE,CAAA;QACnB,MAAM,CAAC,QAAQ,EAAE,UAAU,EAAE,WAAW,CAAC,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,YAAY,EAAE,CAAC,CAAC,CAAA;QAErG,MAAM,OAAO,GAAG,IAAI,OAAO,EAAE,CAAC;QAC9B,IAAI,WAAW;YACb,OAAO,CAAC,GAAG,CAAC,cAAc,EAAE,WAAW,CAAC,CAAA;QAE1C,qBAAqB;QACrB,IAAI,OAAO,QAAQ,IAAI,QAAQ;YAC7B,OAAO,IAAI,YAAY,CAAC,QAAQ,EAAE,EAAE,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,CAAC,CAAA;QACpE,OAAO,YAAY,CAAC,IAAI,CAAC,QAAQ,EAAE,EAAE,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,CAAC,CAAA;IACrE,CAAC;IACD,OAAO,OAAO,CAAA;AAChB,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/api/index.ts"],"names":[],"mappings":"AAAA,OAAO,aAAa,CAAA;AACpB,OAAO,EAAoB,YAAY,EAAE,MAAM,aAAa,CAAA;AAC5D,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAA;AAGtC,mBAAmB;AACnB,OAAO,iBAAiB,MAAM,uBAAuB,CAAA;AACrD,OAAO,mBAAmB,MAAM,sBAAsB,CAAA;AAEtD,4BAA4B;AAC5B,OAAO,yBAAyB,MAAM,4CAA4C,CAAA;AAClF,OAAO,qBAAqB,MAAM,qCAAqC,CAAA;AACvE,OAAO,uBAAuB,MAAM,2CAA2C,CAAA;AAkB/E,MAAM,UAAU,sBAAsB,CAAC,MAAwC;IAC7E,MAAM,iBAAiB,GAAG,MAAM,EAAE,iBAAiB,IAAI,MAAM,CAAA;IAC7D,MAAM,QAAQ,GAAG;QACf,GAAG,CAAC,MAAM,EAAE,QAAQ,IAAI,EAAE,CAAC;QAC3B,iBAAiB;QACjB,mBAAmB;QACnB,yBAAyB;QACzB,qBAAqB;QACrB,uBAAuB;KACxB,CAAA;IAED,wDAAwD;IACxD,SAAS,YAAY,CAAC,IAAY,EAAE,IAAY,EAAE,UAA6B;QAC7E,OAAO,UAAU,CAAC,IAAI,CAAC,WAAW,EAAE,IAAI,IAAI,CAAC,WAAW,EAAE;YACxD,UAAU,CAAC,IAAI,CAAC,WAAW,EAAE,IAAI,IAAI,CAAC,WAAW,EAAE,CAAA;IACvD,CAAC;IAED,KAAK,UAAU,OAAO,CAAC,OAAoB,EAAE,EAAE,MAAM,EAAE,WAAW,EAAkB;QAClF,iEAAiE;QACjE,MAAM,MAAM,GAAG,MAAM,WAAW,CAAA;QAChC,IAAI,OAAO,GAAkC,MAAM,CAAC,iBAAiB,CAAC,CAAA;QACtE,IAAI,CAAC,OAAO;YAAE,OAAO,GAAG,GAAG,CAAA;aACtB,IAAI,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC;YAAE,OAAO,GAAG,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;aAC7D,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,GAAG,CAAC;YAAE,OAAO,GAAG,GAAG,GAAG,OAAO,CAAA;QAC1D,MAAM,IAAI,GAAW,OAAO,CAAA;QAC5B,qMAAqM;QACrM,MAAM,IAAI,GAAG,OAAO,CAAC,MAAM,CAAA;QAE3B,mBAAmB;QACnB,MAAM,UAAU,GAAG,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,YAAY,CAAC,IAAI,EAAE,IAAI,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC,CAAA;QAClF,IAAI,CAAC,UAAU;YACb,OAAO,YAAY,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,EAAE,MAAM,EAAE,GAAG,EAAE,OAAO,EAAE,WAAW,EAAE,EAAE,EAAE,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC,CAAA;QAE7F,qBAAqB;QACrB,MAAM,CAAC,GAAG,OAAO,EAAE,CAAA;QACnB,MAAM,CAAC,QAAQ,EAAE,UAAU,EAAE,WAAW,CAAC,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,YAAY,EAAE,CAAC,CAAC,CAAA;QAErG,MAAM,OAAO,GAAG,IAAI,OAAO,EAAE,CAAC;QAC9B,IAAI,WAAW;YACb,OAAO,CAAC,GAAG,CAAC,cAAc,EAAE,WAAW,CAAC,CAAA;QAE1C,qBAAqB;QACrB,IAAI,OAAO,QAAQ,IAAI,QAAQ;YAC7B,OAAO,IAAI,YAAY,CAAC,QAAQ,EAAE,EAAE,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,CAAC,CAAA;QACpE,OAAO,YAAY,CAAC,IAAI,CAAC,QAAQ,EAAE,EAAE,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,CAAC,CAAA;IACrE,CAAC;IACD,OAAO,OAAO,CAAA;AAChB,CAAC"}

package/dist/api/profile-api-service.js

@@ -12,7 +12,7 @@ export const ProfileApiService = {
         if (!config.HelperEnabled)
             return Responses.NotFound;
         // Start timer
-        let start = Date.now();
+        const start = Date.now();
         // Read requested scopes
         const scopes = query.get('scope')?.toLowerCase()?.split(',')?.map(x => x.trim());
         const fetchContentTopics = !scopes || scopes.includes('topics');
@@ -83,7 +83,9 @@ function stringToInt(value, defaultValue) {
         const result = Number.parseInt(value ?? defaultValue.toString(), 10);
         return isNaN(result) ? defaultValue : result;
     }
-    catch { }
+    catch {
+        // Ingored on purpose
+    }
     return defaultValue;
 }
 //# sourceMappingURL=profile-api-service.js.map

package/dist/api/profile-api-service.js.map

@@ -1 +1 @@
-{"version":3,"file":"profile-api-service.js","sourceRoot":"","sources":["../../src/api/profile-api-service.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,SAAS,MAAM,aAAa,CAAA;AACxC,OAAO,OAAO,MAAM,kBAAkB,CAAA;AACtC,OAAO,SAAS,EAAE,EAAE,kBAAkB,EAAE,MAAM,WAAW,CAAA;AAEzD,OAAO,EAAE,YAAY,EAAE,WAAW,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAA;AAE3E,MAAM,KAAK,GAAG,KAAK,CAAA;AACnB,MAAM,CAAC,MAAM,iBAAiB,GAAmC;IAC/D,GAAG,EAAE,EAAE,IAAI,EAAE,GAAG,EAAE,IAAI,EAAE,KAAK,EAAE;IAC/B,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE;QAChC,MAAM,MAAM,GAAG,SAAS,EAAE,CAAA;QAC1B,MAAM,QAAQ,GAAG,kBAAkB,CAAC,MAAM,CAAC,CAAA;QAC3C,kCAAkC;QAClC,IAAI,CAAC,MAAM,CAAC,aAAa;YACvB,OAAO,SAAS,CAAC,QAAQ,CAAA;QAE3B,cAAc;QACd,IAAI,KAAK,GAAG,IAAI,CAAC,GAAG,EAAE,CAAA;QAEtB,wBAAwB;QACxB,MAAM,MAAM,GAAG,KAAK,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,WAAW,EAAE,EAAE,KAAK,CAAC,GAAG,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAA;QAChF,MAAM,kBAAkB,GAAG,CAAC,MAAM,IAAI,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAA;QAC/D,MAAM,iBAAiB,GAAG,CAAC,MAAM,IAAI,MAAM,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAA;QACjE,MAAM,gBAAgB,GAAG,CAAC,MAAM,IAAI,MAAM,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAA;QAE9D,eAAe;QACf,MAAM,UAAU,GAAG,MAAM,OAAO,CAAA;QAChC,MAAM,KAAK,GAAG,YAAY,CAAC,KAAK,CAAC,YAAY,CAAC,UAAU,CAAC,CAAA;QACzD,MAAM,IAAI,GAAG,WAAW,CAAC,KAAK,CAAC,YAAY,CAAC,UAAU,CAAC,CAAA;QACvD,MAAM,OAAO,GAAG,kBAAkB,CAAC,KAAK,CAAC,YAAY,CAAC,UAAU,CAAC,CAAA;QACjE,MAAM,UAAU,GAAG,OAAO,CAAC,YAAY,CAAC,UAAU,CAAC,CAAA;QAEnD,+BAA+B;QAC/B,MAAM,QAAQ,GAAG,MAAM,CAAC,oBAAoB,CAAA;QAC5C,MAAM,UAAU,GAAG,IAAI,CAAC,GAAG,CAAC,WAAW,CAAC,KAAK,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;QACjE,IAAI,kBAAkB,GAAG,CAAC,CAAA;QAC1B,IAAI,cAAc,GAAG,CAAC,CAAA;QAEtB,gCAAgC;QAChC,IAAI,SAAS,GAAmC,EAAE,CAAA;QAClD,MAAM,GAAG,GAAG,QAAQ,CAAC,YAAY,CAAC,CAAC,CAAC,IAAI,YAAY,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;QAC1E,IAAI,GAAG,IAAI,iBAAiB,IAAI,KAAK,EAAE,CAAC;YACtC,MAAM,YAAY,GAAG,MAAM,GAAG,CAAC,eAAe,EAAE,CAAA;YAChD,cAAc,GAAG,YAAY,CAAC,MAAM,CAAA;YAEpC,wCAAwC;YACxC,MAAM,MAAM,GAAe,EAAE,CAAA;YAC7B,YAAY,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,GAAG,EAAE,EAAE;gBACjC,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,GAAG,MAAM,CAAC,oBAAoB,CAAC,CAAC;gBAC9D,MAAM,CAAC,OAAO,CAAC,GAAG,MAAM,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC;gBACxC,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;YAC/B,CAAC,CAAC,CAAC;YACH,kBAAkB,GAAG,MAAM,CAAC,MAAM,CAAA;YAElC,mCAAmC;YACnC,MAAM,eAAe,GAAG;4GACwE,CAC9F,MAAM,GAAG,CAAC,eAAe,CAAC,KAAK,EAAE,MAAM,CAAC,UAAU,CAAC,CAAC,CAAA;YACtD,SAAS,GAAG,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,eAAe,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;QACtE,CAAC;QAED,8BAA8B;QAC9B,MAAM,OAAO,GAAG,GAAG,IAAI,gBAAgB,IAAI,KAAK,CAAC,CAAC,CAAC,MAAM,GAAG,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS,CAAA;QAE9F,6BAA6B;QAC7B,IAAI,MAAM,GAAa,EAAE,CAAA;QACzB,IAAI,kBAAkB,IAAI,IAAI,EAAE,CAAC;YAC/B,MAAM,WAAW,GAAG,IAAI,WAAW,CAAC,MAAM,EAAE,CAAC;YAC7C,MAAM,GAAG,MAAM,WAAW,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAA;QACnD,CAAC;QAED,MAAM,YAAY,GAAuB;YACvC,GAAG,EAAE;gBACH,YAAY,EAAE,KAAK,IAAI,KAAK;gBAC5B,QAAQ,EAAE,UAAU,IAAI,KAAK;gBAC7B,mBAAmB,EAAE,IAAI,IAAI,KAAK;gBAClC,kBAAkB,EAAE,OAAO,IAAI,KAAK;aACrC;YACD,GAAG,EAAE;gBACH,QAAQ;gBACR,UAAU;gBACV,SAAS;gBACT,kBAAkB;gBAClB,cAAc;aACf;YACD,OAAO,EAAE,OAAO,IAAI,IAAI;YACxB,aAAa,EAAE,MAAM;YACrB,QAAQ,EAAE,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,KAAK,IAAI;SACpC,CAAA;QACD,OAAO,CAAC,YAAY,EAAE,GAAG,CAAC,CAAA;IAC5B,CAAC;CACF,CAAA;AAID,eAAe,iBAAiB,CAAA;AAqBhC,SAAS,WAAW,CAAC,KAAgC,EAAE,YAAoB;IACzE,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,CAAC,QAAQ,CAAC,KAAK,IAAI,YAAY,CAAC,QAAQ,EAAE,EAAE,EAAE,CAAC,CAAA;QACpE,OAAO,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,MAAM,CAAA;IAC9C,CAAC;IAAC,MAAM,CAAC,CAAC,CAAC;IACX,OAAO,YAAY,CAAA;AACrB,CAAC"}
+{"version":3,"file":"profile-api-service.js","sourceRoot":"","sources":["../../src/api/profile-api-service.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,SAAS,MAAM,aAAa,CAAA;AACxC,OAAO,OAAO,MAAM,kBAAkB,CAAA;AACtC,OAAO,SAAS,EAAE,EAAE,kBAAkB,EAAE,MAAM,WAAW,CAAA;AAEzD,OAAO,EAAE,YAAY,EAAE,WAAW,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAA;AAE3E,MAAM,KAAK,GAAG,KAAK,CAAA;AACnB,MAAM,CAAC,MAAM,iBAAiB,GAAmC;IAC/D,GAAG,EAAE,EAAE,IAAI,EAAE,GAAG,EAAE,IAAI,EAAE,KAAK,EAAE;IAC/B,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE;QAChC,MAAM,MAAM,GAAG,SAAS,EAAE,CAAA;QAC1B,MAAM,QAAQ,GAAG,kBAAkB,CAAC,MAAM,CAAC,CAAA;QAC3C,kCAAkC;QAClC,IAAI,CAAC,MAAM,CAAC,aAAa;YACvB,OAAO,SAAS,CAAC,QAAQ,CAAA;QAE3B,cAAc;QACd,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,EAAE,CAAA;QAExB,wBAAwB;QACxB,MAAM,MAAM,GAAG,KAAK,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,WAAW,EAAE,EAAE,KAAK,CAAC,GAAG,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAA;QAChF,MAAM,kBAAkB,GAAG,CAAC,MAAM,IAAI,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAA;QAC/D,MAAM,iBAAiB,GAAG,CAAC,MAAM,IAAI,MAAM,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAA;QACjE,MAAM,gBAAgB,GAAG,CAAC,MAAM,IAAI,MAAM,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAA;QAE9D,eAAe;QACf,MAAM,UAAU,GAAG,MAAM,OAAO,CAAA;QAChC,MAAM,KAAK,GAAG,YAAY,CAAC,KAAK,CAAC,YAAY,CAAC,UAAU,CAAC,CAAA;QACzD,MAAM,IAAI,GAAG,WAAW,CAAC,KAAK,CAAC,YAAY,CAAC,UAAU,CAAC,CAAA;QACvD,MAAM,OAAO,GAAG,kBAAkB,CAAC,KAAK,CAAC,YAAY,CAAC,UAAU,CAAC,CAAA;QACjE,MAAM,UAAU,GAAG,OAAO,CAAC,YAAY,CAAC,UAAU,CAAC,CAAA;QAEnD,+BAA+B;QAC/B,MAAM,QAAQ,GAAG,MAAM,CAAC,oBAAoB,CAAA;QAC5C,MAAM,UAAU,GAAG,IAAI,CAAC,GAAG,CAAC,WAAW,CAAC,KAAK,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;QACjE,IAAI,kBAAkB,GAAG,CAAC,CAAA;QAC1B,IAAI,cAAc,GAAG,CAAC,CAAA;QAEtB,gCAAgC;QAChC,IAAI,SAAS,GAAmC,EAAE,CAAA;QAClD,MAAM,GAAG,GAAG,QAAQ,CAAC,YAAY,CAAC,CAAC,CAAC,IAAI,YAAY,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;QAC1E,IAAI,GAAG,IAAI,iBAAiB,IAAI,KAAK,EAAE,CAAC;YACtC,MAAM,YAAY,GAAG,MAAM,GAAG,CAAC,eAAe,EAAE,CAAA;YAChD,cAAc,GAAG,YAAY,CAAC,MAAM,CAAA;YAEpC,wCAAwC;YACxC,MAAM,MAAM,GAAe,EAAE,CAAA;YAC7B,YAAY,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,GAAG,EAAE,EAAE;gBACjC,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,GAAG,MAAM,CAAC,oBAAoB,CAAC,CAAC;gBAC9D,MAAM,CAAC,OAAO,CAAC,GAAG,MAAM,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC;gBACxC,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;YAC/B,CAAC,CAAC,CAAC;YACH,kBAAkB,GAAG,MAAM,CAAC,MAAM,CAAA;YAElC,mCAAmC;YACnC,MAAM,eAAe,GAAG;4GACwE,CAC9F,MAAM,GAAG,CAAC,eAAe,CAAC,KAAK,EAAE,MAAM,CAAC,UAAU,CAAC,CAAC,CAAA;YACtD,SAAS,GAAG,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,eAAe,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;QACtE,CAAC;QAED,8BAA8B;QAC9B,MAAM,OAAO,GAAG,GAAG,IAAI,gBAAgB,IAAI,KAAK,CAAC,CAAC,CAAC,MAAM,GAAG,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS,CAAA;QAE9F,6BAA6B;QAC7B,IAAI,MAAM,GAAa,EAAE,CAAA;QACzB,IAAI,kBAAkB,IAAI,IAAI,EAAE,CAAC;YAC/B,MAAM,WAAW,GAAG,IAAI,WAAW,CAAC,MAAM,EAAE,CAAC;YAC7C,MAAM,GAAG,MAAM,WAAW,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAA;QACnD,CAAC;QAED,MAAM,YAAY,GAAuB;YACvC,GAAG,EAAE;gBACH,YAAY,EAAE,KAAK,IAAI,KAAK;gBAC5B,QAAQ,EAAE,UAAU,IAAI,KAAK;gBAC7B,mBAAmB,EAAE,IAAI,IAAI,KAAK;gBAClC,kBAAkB,EAAE,OAAO,IAAI,KAAK;aACrC;YACD,GAAG,EAAE;gBACH,QAAQ;gBACR,UAAU;gBACV,SAAS;gBACT,kBAAkB;gBAClB,cAAc;aACf;YACD,OAAO,EAAE,OAAO,IAAI,IAAI;YACxB,aAAa,EAAE,MAAM;YACrB,QAAQ,EAAE,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,KAAK,IAAI;SACpC,CAAA;QACD,OAAO,CAAC,YAAY,EAAE,GAAG,CAAC,CAAA;IAC5B,CAAC;CACF,CAAA;AAID,eAAe,iBAAiB,CAAA;AAqBhC,SAAS,WAAW,CAAC,KAAgC,EAAE,YAAoB;IACzE,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,CAAC,QAAQ,CAAC,KAAK,IAAI,YAAY,CAAC,QAAQ,EAAE,EAAE,EAAE,CAAC,CAAA;QACpE,OAAO,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,MAAM,CAAA;IAC9C,CAAC;IAAC,MAAM,CAAC;QACP,qBAAqB;IACvB,CAAC;IACD,OAAO,YAAY,CAAA;AACrB,CAAC"}

package/dist/api/types.d.ts

@@ -7,8 +7,8 @@ export type ApiServiceErrorMessage = {
     };
 };
 export type ApiServiceErrorResponse = [ApiServiceErrorMessage, number] | [string, number, string];
-export type ApiServiceResponse<T extends {} = {}> = [T, 200 | undefined] | ApiServiceErrorResponse;
-export type ApiService<T extends {} = {}> = {
+export type ApiServiceResponse<T extends object = object> = [T, 200 | undefined] | ApiServiceErrorResponse;
+export type ApiService<T extends object = object> = {
     for: {
         path: string;
         verb: string;

package/dist/client-types.d.ts

@@ -5,33 +5,80 @@ declare global {
         optimizely?: OptimizelyWebExperimentationApi;
     }
 }
-export interface OptimizelyOneService<T = any> {
+/**
+ * Contract implemented by Optimizely One client services.
+ *
+ * A service can expose one or more optional capabilities (activation, tracking,
+ * profile updates/discovery) and provides access to an underlying browser API.
+ *
+ * @typeParam T The concrete browser API client type exposed by the service.
+ * @typeParam SC The service code type used to identify the service.
+ */
+export interface OptimizelyOneService<T = unknown, SC = string> {
+    /**
+       * Sort order for service execution. Lower values run first.
+       */
     order: Readonly<number>;
+    /**
+       * Indicates whether the service is currently active.
+       */
     isActive: Readonly<boolean>;
-    code: Readonly<string>;
+    /**
+       * Stable service identifier used to locate a service by code.
+       */
+    code: Readonly<SC>;
+    /**
+       * Enables or disables debug logging for this service instance.
+       */
     debug: boolean;
     /**
-     * Perform any actions that must be done to apply the capabilities of this
-     * service on the page. This function MUST NOT perform behaviour tracking of
-     * any kind.
-     *
-     * @param       path        The path for which to activate.
-     * @returns     void
-     */
+       * Perform any actions that must be done to apply the capabilities of this
+       * service on the page. This function MUST NOT perform behaviour tracking of
+       * any kind.
+       *
+       * @param       path        The path for which to activate.
+       * @returns     void
+       */
     activatePage?: (path: string) => void;
     /**
-     * Perform any actions that must be done to performt the pageview tracking
-     * needed for this service.
-     *
-     * @param       path        The path for which to activate.
-     * @returns     void
-     */
+       * Perform any actions that must be done to performt the pageview tracking
+       * needed for this service.
+       *
+       * @param       path        The path for which to activate.
+       * @returns     void
+       */
     trackPage?: (path: string) => void;
+    /**
+       * Tracks a custom event through this service.
+       *
+       * @param event The event payload.
+       * @returns void
+       */
     trackEvent?: (event: OptimizelyOneEvent) => void;
+    /**
+       * Updates profile data known to this service.
+       *
+       * @param profileData Complete new profile
+       * @returns void
+       */
     updateProfile?: (profileData: OptimizelyOneProfileData) => void;
-    discoverProfileData?: (signal?: AbortSignal | null) => Promise<OptimizelyOneProfileData>;
+    /**
+       * Discovers profile data from this service.
+       *
+       * @param signal Optional abort signal used to cancel discovery.
+       * @returns A partial profile payload discovered by this service.
+       */
+    discoverProfileData?: (signal?: AbortSignal | null) => Promise<Partial<OptimizelyOneProfileData>>;
+    /**
+       * Retrieves the underlying browser API client for this service.
+       *
+       * @returns The browser API instance, or `undefined` when unavailable.
+       */
     getBrowserApi: () => T | undefined;
 }
+export type OptimizelyOneServiceWithCapability<T = unknown, SC extends string = string, K extends keyof OptimizelyOneService = keyof OptimizelyOneService> = Omit<OptimizelyOneService<T, SC>, K | 'active'> & Required<Pick<OptimizelyOneService<T, SC>, K> & {
+    active: true;
+}>;
 export type OptimizelyOneEvent = NavigationSearchEvent | {
     event: string;
     action: string;
@@ -43,26 +90,50 @@ type NavigationSearchEvent = {
     search_term: string;
 };
 export type OptimizelyOneProfileData = {
+    /**
+     * The Pseudo ID used by Optimizely Feature experimentation
+     */
+    feature_experimentation_id?: string;
+    /**
+     * The Pseudo ID used by Optimizely Content Recommendations
+     * and intelligence
+     */
     content_intelligence_id?: string;
+    /**
+     * Any other ID tracked within the profile, these IDs are
+     * considered PII and thus should not be sent to systems
+     * that may not process PII.
+     */
+    ids: Record<string, string>;
+    /**
+     * Any custom field to be tracked within the profile, the
+     * values here may not be PII.
+     */
     custom: Record<string, string | number | boolean>;
+    /**
+     * Any custom field to be tracked within the profile, the
+     * values here may or may not be PII
+     */
+    customPII: Record<string, string | number | boolean>;
 };
+export declare const DefaultProfileData: OptimizelyOneProfileData;
 export type OptimizelyDataPlatformApi = {
     event: (name: string, data?: {
-        [param: string]: any;
+        [param: string]: unknown;
     }) => Promise<void>;
     dispatch: (group: string, action: string, params?: {
-        [param: string]: any;
+        [param: string]: unknown;
     }) => Promise<void>;
-    customer: (customerIds: Record<string, string | number>, customerAttributes?: Record<string, any>) => void;
+    customer: (customerIds: Record<string, string | number>, customerAttributes?: Record<string, unknown>) => void;
 };
 export type OptimizelyContentRecsApi = {
-    push: (command: [string, any]) => void;
+    push: (command: [string, unknown]) => void;
 };
 export type OptimizelyWebExperimentationApi = {
     initialized?: boolean;
     push: (data: {
         type: string;
-        [paramName: string]: any;
+        [paramName: string]: unknown;
     }) => void;
     get?: <T extends keyof OptlyWebGet>(what: T) => OptlyWebGet[T];
 };
@@ -82,7 +153,7 @@ export type OptlyWebGet = {
             isActive: boolean;
         }) => {
             [id: string]: {
-                audiences: any[];
+                audiences: unknown[];
                 experimentName: string | null;
                 id: string;
                 isActive: boolean;
@@ -116,7 +187,7 @@ export type OptlyWebGet = {
                 id: string;
                 isActive: boolean;
                 isInCampaignHoldback: boolean;
-                reason?: any;
+                reason?: unknown;
                 variation: {
                     id: string;
                     name: string;

package/dist/client-types.js

@@ -1,2 +1,6 @@
-export {};
+export const DefaultProfileData = {
+    custom: {},
+    customPII: {},
+    ids: {}
+};
 //# sourceMappingURL=client-types.js.map

package/dist/client-types.js.map

@@ -1 +1 @@
-{"version":3,"file":"client-types.js","sourceRoot":"","sources":["../src/client-types.ts"],"names":[],"mappings":""}
+{"version":3,"file":"client-types.js","sourceRoot":"","sources":["../src/client-types.ts"],"names":[],"mappings":"AAqIA,MAAM,CAAC,MAAM,kBAAkB,GAA8B;IAC3D,MAAM,EAAE,EAAE;IACV,SAAS,EAAE,EAAE;IACb,GAAG,EAAE,EAAE;CACR,CAAA"}