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

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/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/client-types.d.ts

@@ -5,10 +5,31 @@ 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 = any, 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
@@ -27,11 +48,37 @@ export interface OptimizelyOneService<T = any> {
      * @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 = any, 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,9 +90,33 @@ 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;

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"}

package/dist/components/context.d.ts

@@ -1,102 +1,256 @@
-import { type FunctionComponent, type PropsWithChildren } from 'react';
-import WebExperimenationService from '../products/web-experimentation/client';
-import DataPlatformService from '../products/data-platform/client';
-import ContentRecsService from '../products/content-recs/client';
-import * as ClientApi from '../client-types';
+import { type PropsWithChildren, type Dispatch, type SetStateAction } from "react";
+import type * as ClientApi from '../client-types';
+import type { SupportedProductNames } from './types';
 /**
- * The data stored within the OptimizelyOne context
+ * Context contract for Optimizely One integrations.
+ *
+ * Provides runtime flags, active service management, event dispatching,
+ * and capability-specific service selectors used by consumers.
  */
-type OptimizelyOneContextType = {
+export type OptimizelyOneContextType = Readonly<{
     /**
      * With tracking completely disabled, all events will be stopped by
      * the OptimizelyOne hook. The "PageActivator" component will propagate
      * this instruction to all configured Optimizely One services
      */
-    disableTracking?: boolean;
+    disableTracking: Readonly<boolean>;
     /**
      * With auto-tracking disabled, the "PageActivator" component will not
      * automatically track a generic pageview for all configured Optimizely
      * One services.
      */
-    disableAutotracking?: boolean;
+    disableAutotracking: Readonly<boolean>;
     /**
-     * The list of services Optimizely One Services registered with the
-     * context. When creating the context, you may only add to the existing
-     * service.
+     * The list of the active Optimizely One Services registered with the
+     * context. Inactive services are filtered out and will not be part of
+     * this collection.
      */
-    services?: Readonly<ClientApi.OptimizelyOneService[]>;
+    services: ReadonlyArray<ClientApi.OptimizelyOneService>;
     /**
-     * Whether or not debug output ging must be enabled
+     * Whether debug output is enabled for registered services.
+     */
+    debug: Readonly<boolean>;
+    /**
+     * Updates debug mode for the context.
+     */
+    setDebug: Dispatch<SetStateAction<boolean>>;
+    /**
+     * Adds a service to the context.
+     *
+     * This allows dynamic service registration after initialization, but requires
+     * the full service definition, including `isActive`.
+     *
+     * @param service The service instance to add.
      */
-    debug?: boolean;
-    setDebug: (newDebug: boolean) => void;
     addService: (service: ClientApi.OptimizelyOneService) => void;
+    /**
+     * Removes a service from the context.
+     *
+     * The exact same service instance must be passed as was used during add.
+     * Built-in default services cannot be removed with this method.
+     *
+     * @param service The service instance to remove.
+     */
     removeService: (service: ClientApi.OptimizelyOneService) => void;
-};
-type OptimizelyOneProviderProps = PropsWithChildren<{
-    value?: Omit<OptimizelyOneContextType, 'setDebug' | 'addService' | 'removeService'>;
+    /**
+     * Tracks an event through the generic event API.
+     *
+     * All configured services that support event tracking receive this event.
+     *
+     * @param event The event payload to send.
+     */
+    track: (event: ClientApi.OptimizelyOneEvent) => void;
+    /**
+      * Discovers profile data from active discovery-capable services.
+      *
+      * @param signal Optional abort signal used to cancel discovery requests.
+      * @returns A promise that resolves when profile discovery and merge are complete.
+     */
+    discoverProfileData: (signal?: AbortSignal | null) => Promise<void>;
+    /**
+      * Merges the provided profile data into the current profile state.
+      *
+      * @param profileData Profile data patch to merge.
+     */
+    updateProfile: (profileData: Partial<ClientApi.OptimizelyOneProfileData>) => void;
+    /**
+     * Retrieves active services that support the page activation step.
+     *
+     * @returns A list of active services with `activatePage` capability.
+     */
+    getActivatePageServices: () => ClientApi.OptimizelyOneServiceWithCapability<any, string, 'activatePage'>[];
+    /**
+     * Retrieves active services that support page-view tracking.
+     *
+     * @returns A list of active services with `trackPage` capability.
+     */
+    getTrackPageServices: () => ClientApi.OptimizelyOneServiceWithCapability<any, string, 'trackPage'>[];
+    /**
+     * Retrieves active services that support profile updates.
+     *
+     * @returns A list of active services with `updateProfile` capability.
+     */
+    getProfileServices: () => ClientApi.OptimizelyOneServiceWithCapability<any, string, 'updateProfile'>[];
+    /**
+     * Retrieves active services that can discover profile data.
+     *
+     * @returns A list of active services with `discoverProfileData` capability.
+     */
+    getProfileDataSources: () => ClientApi.OptimizelyOneServiceWithCapability<any, string, 'discoverProfileData'>[];
+    /**
+     * Retrieves an individual active service by its code.
+     *
+     * @param code The service code.
+     * @returns The matching service, or `undefined` when not found.
+     */
+    getService: <SC extends string>(code: SC) => ClientApi.OptimizelyOneService<any, SC> | undefined;
+}>;
+/**
+ * Props accepted by `OptimizelyOneProvider`.
+ *
+ * `value` supplies initial context flags and optional additional services.
+ * `enabledOptimizelyServices` controls which built-in product services are enabled.
+ */
+export type ProviderProps = PropsWithChildren<{
+    /**
+     * Initial context values and optional custom services.
+     */
+    value?: {
+        /**
+         * Disables all event tracking when `true`.
+         */
+        disableTracking?: boolean | undefined;
+        /**
+         * Disables automatic page-view tracking when `true`.
+         */
+        disableAutotracking?: boolean | undefined;
+        /**
+         * Additional services to register alongside built-in services.
+         */
+        services?: readonly ClientApi.OptimizelyOneService[] | undefined;
+        /**
+         * Enables debug logging for service operations when `true`.
+         */
+        debug?: boolean;
+    };
+    /**
+     * Optional allow-list for built-in product services.
+     */
+    enabledOptimizelyServices?: Array<SupportedProductNames>;
 }>;
-type OptimizelyOneServiceMap = Record<string, ClientApi.OptimizelyOneService>;
-interface DefaultServiceMap extends OptimizelyOneServiceMap {
-    webex: InstanceType<typeof WebExperimenationService>;
-    odp: InstanceType<typeof DataPlatformService>;
-    crecs: InstanceType<typeof ContentRecsService>;
+/**
+ * Provides Optimizely One context values to descendant components.
+ *
+ * It composes built-in product services with optional additional services,
+ * filters active capabilities, and exposes tracking and service access APIs.
+ *
+ * @param props Provider configuration and children.
+ * @returns The Optimizely One context provider element.
+ */
+export declare function OptimizelyOneProvider({ value: { disableTracking, disableAutotracking, services, debug }, children, enabledOptimizelyServices }: ProviderProps): import("react/jsx-runtime").JSX.Element;
+export declare namespace OptimizelyOneProvider {
+    var displayName: string;
 }
 /**
- * The results of the invokation of the useOptimizelyOne
- * hook
+ * Retrieves the current Optimizely One context value.
+ *
+ * @returns The active `OptimizelyOneContextType` instance.
  */
-type OptimizelyOneHookResult<TM extends DefaultServiceMap = DefaultServiceMap> = OptimizelyOneContextType & {
+export declare function useOptimizelyOne(): Readonly<{
+    /**
+     * With tracking completely disabled, all events will be stopped by
+     * the OptimizelyOne hook. The "PageActivator" component will propagate
+     * this instruction to all configured Optimizely One services
+     */
+    disableTracking: Readonly<boolean>;
+    /**
+     * With auto-tracking disabled, the "PageActivator" component will not
+     * automatically track a generic pageview for all configured Optimizely
+     * One services.
+     */
+    disableAutotracking: Readonly<boolean>;
+    /**
+     * The list of the active Optimizely One Services registered with the
+     * context. Inactive services are filtered out and will not be part of
+     * this collection.
+     */
+    services: ReadonlyArray<ClientApi.OptimizelyOneService>;
+    /**
+     * Whether debug output is enabled for registered services.
+     */
+    debug: Readonly<boolean>;
+    /**
+     * Updates debug mode for the context.
+     */
+    setDebug: Dispatch<SetStateAction<boolean>>;
     /**
-     * Track an event using the generic events api, which allows all configured
-     * Optimizely One services to receive this event
+     * Adds a service to the context.
      *
-     * @param       event       The event data to send
-     * @returns
+     * This allows dynamic service registration after initialization, but requires
+     * the full service definition, including `isActive`.
+     *
+     * @param service The service instance to add.
+     */
+    addService: (service: ClientApi.OptimizelyOneService) => void;
+    /**
+     * Removes a service from the context.
+     *
+     * The exact same service instance must be passed as was used during add.
+     * Built-in default services cannot be removed with this method.
+     *
+     * @param service The service instance to remove.
+     */
+    removeService: (service: ClientApi.OptimizelyOneService) => void;
+    /**
+     * Tracks an event through the generic event API.
+     *
+     * All configured services that support event tracking receive this event.
+     *
+     * @param event The event payload to send.
      */
     track: (event: ClientApi.OptimizelyOneEvent) => void;
     /**
-     * Retrieve all services that must be invoked on the "activate page" step of
-     * the execution cycle
+      * Discovers profile data from active discovery-capable services.
+      *
+      * @param signal Optional abort signal used to cancel discovery requests.
+      * @returns A promise that resolves when profile discovery and merge are complete.
+     */
+    discoverProfileData: (signal?: AbortSignal | null) => Promise<void>;
+    /**
+      * Merges the provided profile data into the current profile state.
+      *
+      * @param profileData Profile data patch to merge.
+     */
+    updateProfile: (profileData: Partial<ClientApi.OptimizelyOneProfileData>) => void;
+    /**
+     * Retrieves active services that support the page activation step.
      *
-     * @returns     A list of active services
+     * @returns A list of active services with `activatePage` capability.
      */
-    getActivatePageServices: () => (Omit<ClientApi.OptimizelyOneService, 'activatePage' | 'isActive'> & {
-        activatePage: NonNullable<ClientApi.OptimizelyOneService['activatePage']>;
-        isActive: true;
-    })[];
+    getActivatePageServices: () => ClientApi.OptimizelyOneServiceWithCapability<any, string, "activatePage">[];
     /**
-     * Retrieve all services that must be invoked on the "track page view" step of
-     * the execution cycle
+     * Retrieves active services that support page-view tracking.
      *
-     * @returns     A list of active services
+     * @returns A list of active services with `trackPage` capability.
      */
-    getTrackPageServices: () => (Omit<ClientApi.OptimizelyOneService, 'trackPage' | 'isActive'> & {
-        trackPage: NonNullable<ClientApi.OptimizelyOneService['trackPage']>;
-        isActive: true;
-    })[];
+    getTrackPageServices: () => ClientApi.OptimizelyOneServiceWithCapability<any, string, "trackPage">[];
     /**
-     * Retrieve all services that must be invoked when new profile information has
-     * been discovered
+     * Retrieves active services that support profile updates.
      *
-     * @returns     A list of active services
+     * @returns A list of active services with `updateProfile` capability.
      */
-    getProfileServices: () => (Omit<ClientApi.OptimizelyOneService, 'updateProfile' | 'isActive'> & {
-        updateProfile: NonNullable<ClientApi.OptimizelyOneService['updateProfile']>;
-        isActive: true;
-    })[];
-    getProfileDataSources: () => (Omit<ClientApi.OptimizelyOneService, 'discoverProfileData' | 'isActive'> & {
-        discoverProfileData: NonNullable<ClientApi.OptimizelyOneService['discoverProfileData']>;
-        isActive: true;
-    })[];
+    getProfileServices: () => ClientApi.OptimizelyOneServiceWithCapability<any, string, "updateProfile">[];
     /**
-     * Retrieve an individual service by its code from the collection of services
+     * Retrieves active services that can discover profile data.
      *
-     * @param       code    The service code
-     * @returns     The service, or undefined if it's not part of the collection
+     * @returns A list of active services with `discoverProfileData` capability.
      */
-    getService: <SC extends keyof TM>(code: SC) => TM[SC] | undefined;
-};
-declare function useOptimizelyOne(): OptimizelyOneHookResult;
-declare const OptimizelyOneProvider: FunctionComponent<OptimizelyOneProviderProps>;
-export { OptimizelyOneProvider, useOptimizelyOne };
+    getProfileDataSources: () => ClientApi.OptimizelyOneServiceWithCapability<any, string, "discoverProfileData">[];
+    /**
+     * Retrieves an individual active service by its code.
+     *
+     * @param code The service code.
+     * @returns The matching service, or `undefined` when not found.
+     */
+    getService: <SC extends string>(code: SC) => ClientApi.OptimizelyOneService<any, SC> | undefined;
+}>;