@amplitude/experiment-tag 0.23.4 → 0.25.0

package/dist/types/src/experiment.d.ts

@@ -1,6 +1,6 @@
 import { Plugin } from '@amplitude/analytics-types';
 import { ExperimentClient, Variants } from '@amplitude/experiment-js-client';
-import { MutationController } from 'dom-mutator';
+import type { MutationController } from 'dom-mutator/dist/types';
 import { BehavioralTargetingManager } from './behavioral-targeting';
 import { PageChangeEvent } from './subscriptions/subscriptions';
 import { InitConfigs, WebExperimentClient, WebExperimentConfig } from './types';
@@ -69,7 +69,7 @@ export declare class DefaultWebExperimentClient implements WebExperimentClient {
      * Apply evaluated variants to the page.
      * @param options
      */
-    applyVariants(options?: ApplyVariantsOptions): void;
+    applyVariants(options?: ApplyVariantsOptions): Promise<void>;
     /**
      * Revert variant actions applied by the experiment.
      * @param options
@@ -79,7 +79,7 @@ export declare class DefaultWebExperimentClient implements WebExperimentClient {
      * Preview the effect of a variant on the page.
      * @param options
      */
-    previewVariants(options: PreviewVariantsOptions): void;
+    previewVariants(options: PreviewVariantsOptions): Promise<void>;
     /**
      * Get all variants for the current web experiment user context.
      */

package/dist/types/src/types.d.ts

@@ -79,6 +79,19 @@ export type BehavioralTargetingRules = {
         [id: string]: BehavioralTargeting;
     };
 };
+export interface RedirectConfig {
+    /**
+     * When true, redirect impression data is stored in a cookie scoped to the root domain,
+     * enabling impression tracking across subdomains.
+     */
+    encodeRedirectInCookie?: boolean;
+    /**
+     * When true, redirect impression data is base64-encoded as an AMP_REDIRECT query
+     * parameter on the destination URL, enabling tracking in cross-domain redirects
+     * and cookie-blocked environments.
+     */
+    encodeRedirectInUrl?: boolean;
+}
 export interface WebExperimentConfig extends ExperimentConfig {
     /**
      * Determines whether the default implementation for handling navigation  will be used
@@ -87,6 +100,7 @@ export interface WebExperimentConfig extends ExperimentConfig {
      * 2. Custom handling of navigation {@link setRedirectHandler} should be implemented such that variant actions applied on the site reflect the latest context
      */
     useDefaultNavigationHandler?: boolean;
+    redirectConfig?: RedirectConfig;
 }
 export declare const Defaults: WebExperimentConfig;
 /**
@@ -108,6 +122,7 @@ export interface WebExperimentClient {
 }
 export type WebExperimentUser = {
     web_exp_id?: string;
+    web_exp_id_v2?: string;
 } & ExperimentUser;
 export type InitConfigs = {
     initialFlags: string;

package/dist/types/src/util/anti-flicker.d.ts

@@ -6,7 +6,8 @@
  */
 export declare const applyAntiFlickerCss: () => void;
 /**
- * Revert the anti-flicker stylesheet immediately. Idempotent — safe to call
- * even when no sheet is active.
+ * Revert the anti-flicker stylesheet immediately. Also removes any
+ * <style id="amp-exp-css"> element injected by customer snippets.
+ * Idempotent — safe to call even when no sheet is active.
  */
 export declare const removeAntiFlickerCss: () => void;

package/dist/types/src/util/cookie.d.ts

@@ -1,5 +1,11 @@
+import { CookieStorage } from '@amplitude/analytics-core';
+export declare function getTopLevelDomain(hostname: string): Promise<string>;
 /**
- * Utility function to generate and set marketing cookie
- * Parses current campaign data from URL and referrer, then stores it in the marketing cookie
+ * Resolves a cross-subdomain value using cookie storage as the authoritative
+ * source. Falls back to a provided localStorage value (migration path), then
+ * generates a new value if neither exists. Attempts to set the cookie when
+ * missing; cookie I/O failures fall back to localStorage / generateNew.
+ * Callers are responsible for syncing the returned value back to localStorage.
  */
-export declare function setMarketingCookie(apiKey: string): Promise<void>;
+export declare function resolveCrossSubdomainValue(cookieStorage: CookieStorage<string>, cookieKey: string, localStorageValue: string | undefined, generateNew: () => string): Promise<string>;
+export declare function setMarketingCookie(apiKey: string, hostname: string): Promise<void>;

package/dist/types/src/util/when-body-ready.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Runs `callback` once `document.body` is available.
+ *
+ * Polls via `requestAnimationFrame` instead of waiting on a
+ * `DOMContentLoaded` / `load` listener because third-party scripts that
+ * proxy global event listeners can swallow those events — see #299.
+ *
+ * In the (effectively impossible) case where `requestAnimationFrame` is
+ * unavailable, the callback is invoked immediately rather than never —
+ * callers that would crash on a null body should guard inside.
+ */
+export declare const whenBodyReady: (callback: () => void) => void;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@amplitude/experiment-tag",
-  "version": "0.23.4",
+  "version": "0.25.0",
   "description": "Amplitude Experiment Javascript Snippet",
   "author": "Amplitude",
   "homepage": "https://github.com/amplitude/experiment-js-client",
@@ -31,7 +31,7 @@
     "@amplitude/analytics-types": "^2.11.0",
     "@amplitude/experiment-core": "^0.13.1",
     "@amplitude/experiment-js-client": "^1.21.1",
-    "dom-mutator": "git+ssh://git@github.com/amplitude/dom-mutator#07a72dddbc2969ea826bdfe2b55d461d5d340992",
+    "dom-mutator": "git+ssh://git@github.com/amplitude/dom-mutator#bb5f4b52273e6a3de39dcf6db6f428d66d988a7b",
     "rollup-plugin-license": "^3.6.0"
   },
   "devDependencies": {
@@ -43,5 +43,5 @@
   "files": [
     "dist"
   ],
-  "gitHead": "bb39e4125884b7eaab4685d67e8cb719da6d0edf"
+  "gitHead": "59c9a47ae78137304e5b56520fd6955a103c2ffc"
 }