@contentful/optimization-web 0.1.0-alpha

package/dist/Optimization.d.ts

@@ -0,0 +1,146 @@
+import { type App, CoreStateful, type CoreStatefulConfig } from '@contentful/optimization-core';
+import { type ElementViewElementOptions, type ElementViewObserverOptions } from './observers';
+declare global {
+    interface Window {
+        /** Global Optimization class constructor attached by the Web SDK. */
+        Optimization?: typeof Optimization;
+        /** Singleton instance created by the Web SDK initializer. */
+        optimization?: Optimization;
+    }
+}
+interface CookieAttributes {
+    domain?: string;
+    /**
+     * Determines the expiration date of the cookie as the number of days until the cookie expires.
+     */
+    expires?: number;
+}
+/**
+ * Configuration options for the Optimization Web SDK.
+ *
+ * @public
+ * @remarks
+ * Extends {@link CoreStatefulConfig} with Web-specific options such as the
+ * application descriptor and automatic entry view tracking.
+ */
+export interface OptimizationWebConfig extends CoreStatefulConfig {
+    /**
+     * Application metadata used to identify the Web app in downstream events.
+     */
+    app?: App;
+    /**
+     * Whether the SDK should automatically track entry views based on DOM
+     * attributes and observers.
+     *
+     * @defaultValue `false`
+     */
+    autoTrackEntryViews?: boolean;
+    cookie?: CookieAttributes;
+}
+/**
+ * Stateful Web SDK built on top of {@link CoreStateful}.
+ *
+ * @public
+ * @remarks
+ * Provides browser-specific wiring:
+ * - automatic persistence of consent, profile, and personalizations,
+ * - cookie-based anonymous ID handling,
+ * - automatic entry view tracking via IntersectionObserver and MutationObserver,
+ * - online-change based flushing of events,
+ * - and visibility-change based flushing of events.
+ *
+ * A singleton instance is attached to `window.optimization` when constructed
+ * in a browser environment.
+ */
+declare class Optimization extends CoreStateful {
+    private elementViewObserver?;
+    private elementExistenceObserver?;
+    private autoTrackEntryViews;
+    private readonly cookieAttributes?;
+    /**
+     * Create a new Optimization Web SDK instance.
+     *
+     * @param config - Web SDK configuration.
+     *
+     * @throws If an `Optimization` instance has already been initialized on
+     * `window.optimization`.
+     *
+     * @example
+     * ```ts
+     * import Optimization from '@contentful/optimization-web'
+     *
+     * const optimization = new Optimization({
+     *   clientId: 'abc-123',
+     *   environment: 'main',
+     *   autoTrackEntryViews: true,
+     * })
+     * ```
+     */
+    constructor(config: OptimizationWebConfig);
+    private setAnonymousId;
+    /**
+     * Enable automatic entry view tracking for elements with `data-ctfl-*`
+     * attributes and start observing the document.
+     *
+     * @param options - Optional per-element observer defaults for dwell time,
+     *   retries, and backoff behavior.
+     *
+     * @example
+     * ```ts
+     * optimization.startAutoTrackingEntryViews({ dwellTimeMs: 1000 })
+     * ```
+     */
+    startAutoTrackingEntryViews(options?: ElementViewObserverOptions): void;
+    /**
+     * Disable automatic entry view tracking and disconnect underlying observers.
+     *
+     * @example
+     * ```ts
+     * optimization.stopAutoTrackingEntryViews()
+     * ```
+     */
+    stopAutoTrackingEntryViews(): void;
+    /**
+     * Begin tracking entry views for a specific element, using the Web SDK’s
+     * dwell-time and retry logic.
+     *
+     * @param element - Element to observe.
+     * @param options - Per-element observer options and callback data.
+     *
+     * @example
+     * ```ts
+     * const element = document.querySelector('#hero')!
+     * optimization.trackEntryViewForElement(element, {
+     *   dwellTimeMs: 1500,
+     *   data: { entryId: 'xyz' },
+     * })
+     * ```
+     */
+    trackEntryViewForElement(element: Element, options: ElementViewElementOptions): void;
+    /**
+     * Stop tracking entry views for a specific element.
+     *
+     * @param element - Element to stop observing.
+     *
+     * @example
+     * ```ts
+     * optimization.untrackEntryViewForElement(element)
+     * ```
+     */
+    untrackEntryViewForElement(element: Element): void;
+    /**
+     * Reset all Web SDK state:
+     * - stops auto-tracking entry views,
+     * - clears the anonymous ID cookie,
+     * - clears LocalStore caches,
+     * - and delegates to {@link CoreStateful.reset} for underlying state reset.
+     *
+     * @example
+     * ```ts
+     * optimization.reset()
+     * ```
+     */
+    reset(): void;
+}
+export default Optimization;
+//# sourceMappingURL=Optimization.d.ts.map

package/dist/Optimization.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Optimization.d.ts","sourceRoot":"","sources":["../src/Optimization.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,GAAG,EACR,YAAY,EACZ,KAAK,kBAAkB,EAIxB,MAAM,+BAA+B,CAAA;AAetC,OAAO,EAEL,KAAK,yBAAyB,EAE9B,KAAK,0BAA0B,EAChC,MAAM,aAAa,CAAA;AAKpB,OAAO,CAAC,MAAM,CAAC;IACb,UAAU,MAAM;QACd,qEAAqE;QACrE,YAAY,CAAC,EAAE,OAAO,YAAY,CAAA;QAClC,6DAA6D;QAC7D,YAAY,CAAC,EAAE,YAAY,CAAA;KAC5B;CACF;AAED,UAAU,gBAAgB;IACxB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB;AAID;;;;;;;GAOG;AACH,MAAM,WAAW,qBAAsB,SAAQ,kBAAkB;IAC/D;;OAEG;IACH,GAAG,CAAC,EAAE,GAAG,CAAA;IAET;;;;;OAKG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAA;IAE7B,MAAM,CAAC,EAAE,gBAAgB,CAAA;CAC1B;AAsDD;;;;;;;;;;;;;;GAcG;AACH,cAAM,YAAa,SAAQ,YAAY;IACrC,OAAO,CAAC,mBAAmB,CAAC,CAAiC;IAC7D,OAAO,CAAC,wBAAwB,CAAC,CAAsC;IACvE,OAAO,CAAC,mBAAmB,CAAQ;IACnC,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAC,CAA8B;IAEhE;;;;;;;;;;;;;;;;;;OAkBG;gBACS,MAAM,EAAE,qBAAqB;IAwEzC,OAAO,CAAC,cAAc;IAUtB;;;;;;;;;;;OAWG;IACH,2BAA2B,CAAC,OAAO,CAAC,EAAE,0BAA0B,GAAG,IAAI;IAuBvE;;;;;;;OAOG;IACH,0BAA0B,IAAI,IAAI;IAKlC;;;;;;;;;;;;;;;OAeG;IACH,wBAAwB,CAAC,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,yBAAyB,GAAG,IAAI;IAKpF;;;;;;;;;OASG;IACH,0BAA0B,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI;IAKlD;;;;;;;;;;;OAWG;IACH,KAAK,IAAI,IAAI;CAMd;AAID,eAAe,YAAY,CAAA"}