@contentful/optimization-core 0.1.0-alpha

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (C) 2026 Contentful Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,408 @@
+<p align="center">
+  <a href="https://www.contentful.com/developers/docs/personalization/">
+    <img alt="Contentful Logo" title="Contentful" src="../../contentful-icon.png" width="150">
+  </a>
+</p>
+
+<h1 align="center">Contentful Personalization & Analytics</h1>
+
+<h3 align="center">Optimization Core SDK</h3>
+
+<div align="center">
+
+[Readme](./README.md) · [Reference](https://contentful.github.io/optimization) ·
+[Contributing](/CONTRIBUTING.md)
+
+</div>
+
+> [!WARNING]
+>
+> The Optimization SDK Suite is currently ALPHA! Breaking changes may be published at any time.
+
+The Optimization Core SDK encapsulates all platform-agnostic functionality and business logic. All
+other SDKs descend from the Core SDK.
+
+<details>
+  <summary>Table of Contents</summary>
+<!-- mtoc-start -->
+
+- [Getting Started](#getting-started)
+- [Working with Stateless Core](#working-with-stateless-core)
+- [Working with Stateful Core](#working-with-stateful-core)
+- [Configuration](#configuration)
+  - [Top-level Configuration Options](#top-level-configuration-options)
+  - [Analytics Options](#analytics-options)
+  - [Event Builder Options](#event-builder-options)
+  - [Fetch Options](#fetch-options)
+  - [Personalization Options](#personalization-options)
+- [Core Methods](#core-methods)
+  - [Personalization Data Resolution Methods](#personalization-data-resolution-methods)
+    - [`getCustomFlag`](#getcustomflag)
+    - [`personalizeEntry`](#personalizeentry)
+    - [`getMergeTagValue`](#getmergetagvalue)
+  - [Personalization and Analytics Event Methods](#personalization-and-analytics-event-methods)
+    - [`identify`](#identify)
+    - [`page`](#page)
+    - [`track`](#track)
+    - [`trackComponentView`](#trackcomponentview)
+    - [`trackFlagView`](#trackflagview)
+- [Stateful-only Core Methods](#stateful-only-core-methods)
+  - [`consent`](#consent)
+  - [`reset`](#reset)
+- [Stateful-only Core Properties](#stateful-only-core-properties)
+- [Interceptors](#interceptors)
+  - [Life-cycle Interceptors](#life-cycle-interceptors)
+
+<!-- mtoc-end -->
+</details>
+
+## Getting Started
+
+Install using an NPM-compatible package manager, pnpm for example:
+
+```sh
+pnpm install @contentful/optimization-core
+```
+
+Import either the stateful or stateless Core class, depending on the target environment; both CJS
+and ESM module systems are supported, ESM preferred:
+
+```ts
+import { CoreStateful } from '@contentful/optimization-core'
+// or
+import { CoreStateless } from '@contentful/optimization-core'
+```
+
+Configure and initialize the Core SDK:
+
+```ts
+const optimization = new CoreStateful({ clientId: 'abc123' })
+// or
+const optimization = new CoreStateless({ clientId: 'abc123' })
+```
+
+## Working with Stateless Core
+
+The `CoreStateless` class is intended to be used as the basis for SDKs that would run in stateless
+environments such as Node-based servers and server-side functions in meta-frameworks such as
+Next.js.
+
+In stateless environments, Core will not maintain any internal state, which includes user consent.
+These concerns should be handled by consumers to fit their specific architectural and design
+specifications.
+
+## Working with Stateful Core
+
+The `CoreStateful` class is intended to be used as the basis for SDKs that would run in stateful
+environments such as Web front-ends and mobile applications (via JavaScript runtime containers).
+
+In stateful environments, Core maintains state internally for consent, an event stream, and
+profile-related data that is commonly obtained from requests to the Experience API. These states are
+exposed externally as read-only observables.
+
+## Configuration
+
+### Top-level Configuration Options
+
+| Option            | Required? | Default                       | Description                                                           |
+| ----------------- | --------- | ----------------------------- | --------------------------------------------------------------------- |
+| `analytics`       | No        | See "Analytics Options"       | Configuration specific to the Analytics/Insights API                  |
+| `clientId`        | Yes       | N/A                           | The Ninetailed API Key which can be found in the Ninetailed Admin app |
+| `environment`     | No        | `'main'`                      | The Ninetailed environment configured in the Ninetailed Admin app     |
+| `eventBuilder`    | No        | See "Event Builder Options"   | Event builder configuration (channel/library metadata, etc.)          |
+| `fetchOptions`    | No        | See "Fetch Options"           | Configuration for Fetch timeout and retry functionality               |
+| `logLevel`        | No        | `'error'`                     | Minimum log level for the default console sin                         |
+| `personalization` | No        | See "Personalization Options" | Configuration specific to the Personalization/Experience API          |
+
+The following configuration options apply only in stateful environments:
+
+| Option                     | Required? | Default                | Description                                                       |
+| -------------------------- | --------- | ---------------------- | ----------------------------------------------------------------- |
+| `allowedEventTypes`        | No        | `['identify', 'page']` | Allow-listed event types permitted when consent is not set        |
+| `defaults`                 | No        | `undefined`            | Set of default state values applied on initialization             |
+| `getAnonymousId`           | No        | `undefined`            | Function used to obtain an anonymous user identifier              |
+| `preventedComponentEvents` | No        | `undefined`            | Initial duplication prevention configuration for component events |
+
+Configuration method signatures:
+
+- `getAnonymousId`: `() => string | undefined`
+
+### Analytics Options
+
+| Option    | Required? | Default                                    | Description                   |
+| --------- | --------- | ------------------------------------------ | ----------------------------- |
+| `baseUrl` | No        | `'https://ingest.insights.ninetailed.co/'` | Base URL for the Insights API |
+
+The following configuration options apply only in stateful environments:
+
+| Option          | Required? | Default     | Description                                                              |
+| --------------- | --------- | ----------- | ------------------------------------------------------------------------ |
+| `beaconHandler` | No        | `undefined` | Handler used to enqueue events via the Beacon API or a similar mechanism |
+
+Configuration method signatures:
+
+- `beaconHandler`: `(url: string | URL, data: BatchInsightsEventArray) => boolean`
+
+### Event Builder Options
+
+Event builder options should only be supplied when building an SDK on top of Core or any of its
+descendent SDKs.
+
+| Option    | Required? | Default     | Description                                                                        |
+| --------- | --------- | ----------- | ---------------------------------------------------------------------------------- |
+| `app`     | No        | `undefined` | The application definition used to attribute events to a specific consumer app     |
+| `channel` | Yes       | N/A         | The channel that identifies where events originate from (e.g. `'web'`, `'mobile'`) |
+| `library` | Yes       | N/A         | The client library metadata that is attached to all events                         |
+
+The `channel` option may contain one of the following values:
+
+- `web`
+- `mobile`
+- `server`
+
+The following configuration options apply only in stateful environments:
+
+| Option              | Required? | Default                         | Description                                                           |
+| ------------------- | --------- | ------------------------------- | --------------------------------------------------------------------- |
+| `getLocale`         | No        | `() => 'en-US'`                 | Function used to resolve the locale for outgoing events               |
+| `getPageProperties` | No        | `() => DEFAULT_PAGE_PROPERTIES` | Function that returns the current page properties                     |
+| `getUserAgent`      | No        | `() => undefined`               | Function used to obtain the current user agent string when applicable |
+
+Configuration method signatures:
+
+- `getLocale`: `() => string | undefined`
+- `getPageProperties`:
+
+  ```ts
+  () => {
+    path: string,
+    query: Record<string, string>,
+    referrer: string,
+    search: string,
+    title?: string,
+    url: string
+  }
+  ```
+
+- `getUserAgent`: `() => string | undefined`
+
+### Fetch Options
+
+Fetch options allow for configuration of a Fetch API-compatible fetch method and the retry/timeout
+logic integrated into the Optimization API Client. Specify the `fetchMethod` when the host
+application environment does not offer a `fetch` method that is compatible with the standard Fetch
+API in its global scope.
+
+| Option             | Required? | Default     | Description                                                           |
+| ------------------ | --------- | ----------- | --------------------------------------------------------------------- |
+| `fetchMethod`      | No        | `undefined` | Signature of a fetch method used by the API clients                   |
+| `intervalTimeout`  | No        | `0`         | Delay (in milliseconds) between retry attempts                        |
+| `onFailedAttempt`  | No        | `undefined` | Callback invoked whenever a retry attempt fails                       |
+| `onRequestTimeout` | No        | `undefined` | Callback invoked when a request exceeds the configured timeout        |
+| `requestTimeout`   | No        | `3000`      | Maximum time (in milliseconds) to wait for a response before aborting |
+| `retries`          | No        | `1`         | Maximum number of retry attempts                                      |
+
+Configuration method signatures:
+
+- `fetchMethod`: `(url: string | URL, init: RequestInit) => Promise<Response>`
+- `onFailedAttempt` and `onRequestTimeout`: `(options: FetchMethodCallbackOptions) => void`
+
+### Personalization Options
+
+| Option            | Required? | Default                               | Description                                                         |
+| ----------------- | --------- | ------------------------------------- | ------------------------------------------------------------------- |
+| `baseUrl`         | No        | `'https://experience.ninetailed.co/'` | Base URL for the Experience API                                     |
+| `enabledFeatures` | No        | `['ip-enrichment', 'location']`       | Enabled features which the API may use for each request             |
+| `ip`              | No        | `undefined`                           | IP address to override the API behavior for IP analysis             |
+| `locale`          | No        | `'en-US'` (in API)                    | Locale used to translate `location.city` and `location.country`     |
+| `plainText`       | No        | `false`                               | Sends performance-critical endpoints in plain text                  |
+| `preflight`       | No        | `false`                               | Instructs the API to aggregate a new profile state but not store it |
+
+## Core Methods
+
+The methods in this section are available in both stateful and stateless Core classes. However, be
+aware that there are some minor differences in argument usage between stateful and stateless Core
+implementations.
+
+Arguments marked with an asterisk (\*) are always required.
+
+### Personalization Data Resolution Methods
+
+#### `getCustomFlag`
+
+Get the specified Custom Flag's value from the provided changes array, or from the current internal
+state in stateful implementations.
+
+Arguments:
+
+- `name`\*: The name/key of the Custom Flag
+- `changes`: Changes array
+
+Returns:
+
+- The resolved value for the specified Custom Flag, or `undefined` if it cannot be found.
+
+> [!NOTE]
+>
+> If the `changes` argument is omitted in stateless implementations, the method will return
+> `undefined`.
+
+#### `personalizeEntry`
+
+Resolve a baseline Contentful entry to a personalized variant using the provided selected
+personalizations, or from the current internal state in stateful implementations.
+
+Type arguments:
+
+- `S`: Entry skeleton type
+- `M`: Chain modifiers
+- `L`: Locale code
+
+Arguments:
+
+- `entry`\*: The entry to personalize
+- `personalizations`: Selected personalizations
+
+Returns:
+
+- The resolved personalized entry variant, or the supplied baseline entry if baseline is the
+  selected variant or a variant cannot be found.
+
+> [!NOTE]
+>
+> If the `personalizations` argument is omitted in stateless implementations, the method will return
+> the baseline entry.
+
+#### `getMergeTagValue`
+
+Resolve a "Merge Tag" to a value based on the current (or provided) profile. A "Merge Tag" is a
+special Rich Text fragment supported by Contentful that specifies a profile data member to be
+injected into the Rich Text when rendered.
+
+Arguments:
+
+- `embeddedNodeEntryTarget`\*: The merge tag entry node to resolve
+- `profile`: The user profile
+
+> [!NOTE]
+>
+> If the `profile` argument is omitted in stateless implementations, the method will return the
+> merge tag's fallback value.
+
+### Personalization and Analytics Event Methods
+
+Each method except `trackFlagView` may return an `OptimizationData` object containing:
+
+- `changes`: Currently used for Custom Flags
+- `personalizations`: Selected personalizations for the profile
+- `profile`: Profile associated with the evaluated events
+
+#### `identify`
+
+Identify the current profile/visitor to associate traits with a profile.
+
+Arguments:
+
+- `payload`\*: Identify event builder arguments object, including an optional `profile` property
+  with a `PartialProfile` value that requires only an `id`
+
+#### `page`
+
+Record a personalization page view.
+
+Arguments:
+
+- `payload`\*: Page view event builder arguments object, including an optional `profile` property
+  with a `PartialProfile` value that requires only an `id`
+
+#### `track`
+
+Record a personalization custom track event.
+
+Arguments:
+
+- `payload`\*: Track event builder arguments object, including an optional `profile` property with a
+  `PartialProfile` value that requires only an `id`
+
+#### `trackComponentView`
+
+Record an analytics component view event. When the payload marks the component as "sticky", an
+additional personalization component view is recorded. This method only returns `OptimizationData`
+when the component is marked as "sticky".
+
+Arguments:
+
+- `payload`\*: Component view event builder arguments object, including an optional `profile`
+  property with a `PartialProfile` value that requires only an `id`
+- `duplicationScope`: Arbitrary string that may be used to scope component view duplication; used in
+  Stateful implementations
+
+#### `trackFlagView`
+
+Track a feature flag view via analytics. This is functionally the same as a non-sticky component
+view event.
+
+Arguments:
+
+- `payload`\*: Component view event builder arguments object, including an optional `profile`
+  property with a `PartialProfile` value that requires only an `id`
+- `duplicationScope`: Arbitrary string that may be used to scope component view duplication; used in
+  Stateful implementations
+
+## Stateful-only Core Methods
+
+### `consent`
+
+Updates the user consent state.
+
+Arguments:
+
+- `accept`: A boolean value specifying whether the user has accepted (`true`) or denied (`false`). A
+  value of `undefined` implies that the user has not yet explicitly chosen whether to consent.
+
+### `reset`
+
+Resets all internal state _except_ consent. This method expects no arguments and returns no value.
+
+## Stateful-only Core Properties
+
+- `states`: Returns an object mapping of observables for all internal states
+  - `consent`: The current state of user consent
+  - `eventStream`: The latest event to be queued
+  - `flags`: All current resolved Custom Flags
+  - `profile`: The current user profile
+  - `personalizations`: The current collection of selected personalizations
+
+Each state except `consent` and `eventStream` is updated internally whenever a response from the
+Experience API contains a new or updated respective state.
+
+Example `states` observable usage:
+
+```ts
+optimization.states.profile.subscribe((profile) => {
+  console.log(`Profile ${profile.id} updated!`)
+})
+```
+
+## Interceptors
+
+Interceptors may be used to read and/or modify data flowing through the Core SDK.
+
+### Life-cycle Interceptors
+
+- `event`: Intercepts an event's data _before_ it is queued and/or emitted
+- `state`: Intercepts state data retrieved from an Experience API call _before_ updating the SDK's
+  internal state
+
+Example interceptor usage:
+
+```ts
+optimization.interceptors.event((event) => {
+  event.properties.timestamp = new Date().toISOString()
+})
+```
+
+> [!WARNING]
+>
+> Interceptors are intended to enable low-level interoperability; to simply read and react to
+> Optimization SDK events, use the `states` observables.

package/dist/Consent.d.ts

@@ -0,0 +1,44 @@
+/**
+ * Controller for updating the current consent state.
+ *
+ * @internal
+ * @remarks
+ * Intended for internal wiring between Core classes and the consent signal/store.
+ */
+export interface ConsentController {
+    /**
+     * Update the runtime consent state.
+     *
+     * @param accept - `true` when the user has granted consent; `false` otherwise.
+     */
+    consent: (accept: boolean) => void;
+}
+/**
+ * Contract implemented by classes that gate operations based on consent.
+ *
+ * @internal
+ * @remarks
+ * These methods are consumed by the `@guardedBy` decorator to decide whether to
+ * proceed with an operation and how to report blocked calls.
+ */
+export interface ConsentGuard {
+    /**
+     * Determine whether the named operation is permitted given current consent and
+     * any allow‑list configuration.
+     *
+     * @param name - Logical operation/method name (e.g., `'track'`, `'page'`).
+     * @returns `true` if the operation may proceed; otherwise `false`.
+     * @remarks
+     * The mapping between method names and event type strings may be product‑specific.
+     */
+    hasConsent: (name: string) => boolean;
+    /**
+     * Hook invoked when an operation is blocked due to missing consent.
+     *
+     * @param name - The blocked operation/method name.
+     * @param args - The original call arguments, provided for diagnostics/telemetry.
+     * @returns Nothing. Implementations typically log and/or emit diagnostics.
+     */
+    onBlockedByConsent: (name: string, args: unknown[]) => void;
+}
+//# sourceMappingURL=Consent.d.ts.map

package/dist/Consent.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Consent.d.ts","sourceRoot":"","sources":["../src/Consent.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,MAAM,WAAW,iBAAiB;IAChC;;;;OAIG;IACH,OAAO,EAAE,CAAC,MAAM,EAAE,OAAO,KAAK,IAAI,CAAA;CACnC;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,YAAY;IAC3B;;;;;;;;OAQG;IACH,UAAU,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,OAAO,CAAA;IAErC;;;;;;OAMG;IACH,kBAAkB,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,IAAI,CAAA;CAC5D"}

package/dist/Consent.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=Consent.js.map

package/dist/Consent.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Consent.js","sourceRoot":"","sources":["../src/Consent.ts"],"names":[],"mappings":""}

package/dist/CoreBase.d.ts

@@ -0,0 +1,161 @@
+import { ApiClient, EventBuilder, type InsightsEvent as AnalyticsEvent, type ApiClientConfig, type ChangeArray, type ComponentViewBuilderArgs, type EventBuilderConfig, type ExperienceApiClientConfig, type GlobalApiConfigProperties, type IdentifyBuilderArgs, type InsightsApiClientConfig, type Json, type MergeTagEntry, type OptimizationData, type PageViewBuilderArgs, type PartialProfile, type ExperienceEvent as PersonalizationEvent, type Profile, type ScreenViewBuilderArgs, type SelectedPersonalizationArray, type TrackBuilderArgs } from '@contentful/optimization-api-client';
+import type { ChainModifiers, Entry, EntrySkeletonType, LocaleCode } from 'contentful';
+import type { LogLevels } from 'logger';
+import type AnalyticsBase from './analytics/AnalyticsBase';
+import { InterceptorManager } from './lib/interceptor';
+import type { ResolvedData } from './personalization';
+import type PersonalizationBase from './personalization/PersonalizationBase';
+/**
+ * Lifecycle container for event and state interceptors.
+ *
+ * @public
+ */
+export interface LifecycleInterceptors {
+    /** Interceptors invoked for individual events prior to validation/sending. */
+    event: InterceptorManager<AnalyticsEvent | PersonalizationEvent>;
+    /** Interceptors invoked before optimization state updates. */
+    state: InterceptorManager<OptimizationData>;
+}
+/**
+ * Options for configuring the {@link CoreBase} runtime and underlying clients.
+ *
+ * @public
+ */
+export interface CoreConfig extends Pick<ApiClientConfig, GlobalApiConfigProperties> {
+    /**
+     * Configuration for the personalization (Experience) API client.
+     */
+    personalization?: Omit<ExperienceApiClientConfig, GlobalApiConfigProperties>;
+    /**
+     * Configuration for the analytics (Insights) API client.
+     */
+    analytics?: Omit<InsightsApiClientConfig, GlobalApiConfigProperties>;
+    /**
+     * Event builder configuration (channel/library metadata, etc.).
+     */
+    eventBuilder?: EventBuilderConfig;
+    /** Minimum log level for the default console sink. */
+    logLevel?: LogLevels;
+}
+/**
+ * Internal base that wires the API client, event builder, and logging.
+ *
+ * @internal
+ */
+declare abstract class CoreBase {
+    /** Product implementation for analytics. */
+    abstract readonly analytics: AnalyticsBase;
+    /** Product implementation for personalization. */
+    abstract readonly personalization: PersonalizationBase;
+    /** Shared Optimization API client instance. */
+    readonly api: ApiClient;
+    /** Shared event builder instance. */
+    readonly eventBuilder: EventBuilder;
+    /** Resolved core configuration (minus any name metadata). */
+    readonly config: Omit<CoreConfig, 'name'>;
+    readonly interceptors: LifecycleInterceptors;
+    /**
+     * Create the core with API client and logging preconfigured.
+     *
+     * @param config - Core configuration including API and builder options.
+     * @example
+     * ```ts
+     * const sdk = new CoreStateless({ clientId: 'abc123', environment: 'prod' })
+     * ```
+     */
+    constructor(config: CoreConfig);
+    /**
+     * Get the value of a custom flag derived from a set of optimization changes.
+     *
+     * @param name - The flag key to resolve.
+     * @param changes - Optional change list to resolve from
+     * @returns The resolved JSON value for the flag if available.
+     * @remarks
+     * This is a convenience wrapper around personalization’s flag resolution.
+     */
+    getCustomFlag(name: string, changes?: ChangeArray): Json;
+    /**
+     * Resolve a Contentful entry to the appropriate personalized variant (or
+     * return the baseline entry if no matching variant is selected).
+     *
+     * @typeParam S - Entry skeleton type.
+     * @typeParam M - Chain modifiers.
+     * @typeParam L - Locale code.
+     * @param entry - The baseline entry to resolve.
+     * @param personalizations - Optional selection array for the current profile.
+     * @returns {@link ResolvedData} containing the resolved entry and
+     *   personalization metadata (if any).
+     */
+    personalizeEntry<S extends EntrySkeletonType, M extends ChainModifiers = ChainModifiers, L extends LocaleCode = LocaleCode>(entry: Entry<S, M, L>, personalizations?: SelectedPersonalizationArray): ResolvedData<S, M, L>;
+    /**
+     * Resolve a merge-tag value from the given entry node and profile.
+     *
+     * @param embeddedEntryNodeTarget - The merge-tag entry node to resolve.
+     * @param profile - Optional profile used for value lookup.
+     * @returns The resolved value (typically a string) or `undefined` if not found.
+     */
+    getMergeTagValue(embeddedEntryNodeTarget: MergeTagEntry, profile?: Profile): unknown;
+    /**
+     * Convenience wrapper for sending an `identify` event via personalization.
+     *
+     * @param payload - Identify builder arguments.
+     * @returns The resulting {@link OptimizationData} for the identified user.
+     */
+    identify(payload: IdentifyBuilderArgs & {
+        profile?: PartialProfile;
+    }): Promise<OptimizationData | undefined>;
+    /**
+     * Convenience wrapper for sending a `page` event via personalization.
+     *
+     * @param payload - Page view builder arguments.
+     * @returns The evaluated {@link OptimizationData} for this page view.
+     */
+    page(payload: PageViewBuilderArgs & {
+        profile?: PartialProfile;
+    }): Promise<OptimizationData | undefined>;
+    /**
+     * Convenience wrapper for sending a `screen` event via personalization.
+     *
+     * @param payload - Screen view builder arguments.
+     * @returns The evaluated {@link OptimizationData} for this screen view.
+     */
+    screen(payload: ScreenViewBuilderArgs & {
+        profile?: PartialProfile;
+    }): Promise<OptimizationData | undefined>;
+    /**
+     * Convenience wrapper for sending a custom `track` event via personalization.
+     *
+     * @param payload - Track builder arguments.
+     * @returns The evaluated {@link OptimizationData} for this event.
+     */
+    track(payload: TrackBuilderArgs & {
+        profile?: PartialProfile;
+    }): Promise<OptimizationData | undefined>;
+    /**
+     * Track a component view in both personalization and analytics.
+     *
+     * @param payload - Component view builder arguments. When `payload.sticky` is
+     *   `true`, the event will also be sent via personalization as a sticky
+     *   component view.
+     * @param duplicationScope - Optional string used to scope duplication used in Stateful
+     * implementations
+     * @returns A promise that resolves when all delegated calls complete.
+     * @remarks
+     * The sticky behavior is delegated to personalization; analytics is always
+     * invoked regardless of `sticky`.
+     */
+    trackComponentView(payload: ComponentViewBuilderArgs & {
+        profile?: PartialProfile;
+    }, duplicationScope?: string): Promise<OptimizationData | undefined>;
+    /**
+     * Track a feature flag view via analytics.
+     *
+     * @param payload - Component view builder arguments used to build the flag view event.
+     * @param duplicationScope - Optional string used to scope duplication used in Stateful
+     * implementations
+     * @returns A promise that resolves when processing completes.
+     */
+    trackFlagView(payload: ComponentViewBuilderArgs, duplicationScope?: string): Promise<void>;
+}
+export default CoreBase;
+//# sourceMappingURL=CoreBase.d.ts.map

package/dist/CoreBase.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"CoreBase.d.ts","sourceRoot":"","sources":["../src/CoreBase.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,SAAS,EACT,YAAY,EACZ,KAAK,aAAa,IAAI,cAAc,EACpC,KAAK,eAAe,EACpB,KAAK,WAAW,EAChB,KAAK,wBAAwB,EAC7B,KAAK,kBAAkB,EACvB,KAAK,yBAAyB,EAC9B,KAAK,yBAAyB,EAC9B,KAAK,mBAAmB,EACxB,KAAK,uBAAuB,EAC5B,KAAK,IAAI,EACT,KAAK,aAAa,EAClB,KAAK,gBAAgB,EACrB,KAAK,mBAAmB,EACxB,KAAK,cAAc,EACnB,KAAK,eAAe,IAAI,oBAAoB,EAC5C,KAAK,OAAO,EACZ,KAAK,qBAAqB,EAC1B,KAAK,4BAA4B,EACjC,KAAK,gBAAgB,EACtB,MAAM,qCAAqC,CAAA;AAC5C,OAAO,KAAK,EAAE,cAAc,EAAE,KAAK,EAAE,iBAAiB,EAAE,UAAU,EAAE,MAAM,YAAY,CAAA;AACtF,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,QAAQ,CAAA;AAEvC,OAAO,KAAK,aAAa,MAAM,2BAA2B,CAAA;AAE1D,OAAO,EAAE,kBAAkB,EAAE,MAAM,mBAAmB,CAAA;AACtD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AACrD,OAAO,KAAK,mBAAmB,MAAM,uCAAuC,CAAA;AAE5E;;;;GAIG;AACH,MAAM,WAAW,qBAAqB;IACpC,8EAA8E;IAC9E,KAAK,EAAE,kBAAkB,CAAC,cAAc,GAAG,oBAAoB,CAAC,CAAA;IAChE,8DAA8D;IAC9D,KAAK,EAAE,kBAAkB,CAAC,gBAAgB,CAAC,CAAA;CAC5C;AAED;;;;GAIG;AACH,MAAM,WAAW,UAAW,SAAQ,IAAI,CAAC,eAAe,EAAE,yBAAyB,CAAC;IAClF;;OAEG;IACH,eAAe,CAAC,EAAE,IAAI,CAAC,yBAAyB,EAAE,yBAAyB,CAAC,CAAA;IAE5E;;OAEG;IACH,SAAS,CAAC,EAAE,IAAI,CAAC,uBAAuB,EAAE,yBAAyB,CAAC,CAAA;IAEpE;;OAEG;IACH,YAAY,CAAC,EAAE,kBAAkB,CAAA;IAEjC,sDAAsD;IACtD,QAAQ,CAAC,EAAE,SAAS,CAAA;CACrB;AAED;;;;GAIG;AACH,uBAAe,QAAQ;IACrB,4CAA4C;IAC5C,QAAQ,CAAC,QAAQ,CAAC,SAAS,EAAE,aAAa,CAAA;IAC1C,kDAAkD;IAClD,QAAQ,CAAC,QAAQ,CAAC,eAAe,EAAE,mBAAmB,CAAA;IAEtD,+CAA+C;IAC/C,QAAQ,CAAC,GAAG,EAAE,SAAS,CAAA;IACvB,qCAAqC;IACrC,QAAQ,CAAC,YAAY,EAAE,YAAY,CAAA;IACnC,6DAA6D;IAC7D,QAAQ,CAAC,MAAM,EAAE,IAAI,CAAC,UAAU,EAAE,MAAM,CAAC,CAAA;IAEzC,QAAQ,CAAC,YAAY,EAAE,qBAAqB,CAG3C;IAED;;;;;;;;OAQG;gBACS,MAAM,EAAE,UAAU;IAwB9B;;;;;;;;OAQG;IACH,aAAa,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,WAAW,GAAG,IAAI;IAIxD;;;;;;;;;;;OAWG;IACH,gBAAgB,CACd,CAAC,SAAS,iBAAiB,EAC3B,CAAC,SAAS,cAAc,GAAG,cAAc,EACzC,CAAC,SAAS,UAAU,GAAG,UAAU,EACjC,KAAK,EAAE,KAAK,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,gBAAgB,CAAC,EAAE,4BAA4B,GAAG,YAAY,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;IAIhG;;;;;;OAMG;IACH,gBAAgB,CAAC,uBAAuB,EAAE,aAAa,EAAE,OAAO,CAAC,EAAE,OAAO,GAAG,OAAO;IAIpF;;;;;OAKG;IACG,QAAQ,CACZ,OAAO,EAAE,mBAAmB,GAAG;QAAE,OAAO,CAAC,EAAE,cAAc,CAAA;KAAE,GAC1D,OAAO,CAAC,gBAAgB,GAAG,SAAS,CAAC;IAIxC;;;;;OAKG;IACG,IAAI,CACR,OAAO,EAAE,mBAAmB,GAAG;QAAE,OAAO,CAAC,EAAE,cAAc,CAAA;KAAE,GAC1D,OAAO,CAAC,gBAAgB,GAAG,SAAS,CAAC;IAIxC;;;;;OAKG;IACG,MAAM,CACV,OAAO,EAAE,qBAAqB,GAAG;QAAE,OAAO,CAAC,EAAE,cAAc,CAAA;KAAE,GAC5D,OAAO,CAAC,gBAAgB,GAAG,SAAS,CAAC;IAIxC;;;;;OAKG;IACG,KAAK,CACT,OAAO,EAAE,gBAAgB,GAAG;QAAE,OAAO,CAAC,EAAE,cAAc,CAAA;KAAE,GACvD,OAAO,CAAC,gBAAgB,GAAG,SAAS,CAAC;IAIxC;;;;;;;;;;;;OAYG;IACG,kBAAkB,CACtB,OAAO,EAAE,wBAAwB,GAAG;QAAE,OAAO,CAAC,EAAE,cAAc,CAAA;KAAE,EAChE,gBAAgB,CAAC,EAAE,MAAM,GACxB,OAAO,CAAC,gBAAgB,GAAG,SAAS,CAAC;IAQxC;;;;;;;OAOG;IACG,aAAa,CAAC,OAAO,EAAE,wBAAwB,EAAE,gBAAgB,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAGjG;AAED,eAAe,QAAQ,CAAA"}