@thg-agentic/hyper-personalisation-web 0.0.0-stage → 3.18.0

package/types/segment.d.ts

@@ -0,0 +1,68 @@
+import type { ConsentAdapter } from './consent';
+import type {
+	AnalyticsContextSources,
+	AnonymousIdSource,
+	StorageNames,
+} from './index';
+
+export interface CdpPluginsOptions extends AnalyticsContextSources {
+	/** For a key scoped to several properties, or without settings: the settings' propertyId wins. */
+	propertyId?: string | number;
+	channel?: string | null;
+	market?: string | null;
+	environment?: string | null;
+	currency?: string | null;
+	locale?: string | null;
+	country?: string | null;
+	shipToCountry?: string | null;
+	getCurrency?(): string | null | undefined;
+	getShipToCountry?(): string | null | undefined;
+	getLocale?(): string | null | undefined;
+	consent?: ConsentAdapter;
+	consentTimeoutMs?: number;
+	consentCookieDomain?: string;
+	storageNames?: StorageNames;
+	/** Only without settings: the settings' allowlist wins. */
+	queryParamAllowlist?: string[];
+	queryParamBlocklist?: string[];
+	sensitiveParamAllowlist?: string[];
+	/**
+	 * Pin analytics-next's anonymousId to the site's own device id. The settings' `hp.anonymousId`
+	 * replaces it when it names a cookie or chooses Hyper-Personalisation's (since 3.6).
+	 */
+	getAnonymousId?(): string | null | undefined;
+	/** Only without settings: the settings' `hp.anonymousId` wins. */
+	anonymousIdSource?: AnonymousIdSource | null;
+	getPageType?(): string | null | undefined;
+	debug?: boolean;
+}
+
+/** An analytics-next plugin, structurally (so this file does not depend on analytics-next). */
+export interface CdpPlugin {
+	name: string;
+	type: 'before' | 'enrichment';
+	version: string;
+	isLoaded(): boolean;
+	load(ctx: unknown, analytics: unknown): Promise<void>;
+	[hook: string]: unknown;
+}
+
+/** Pass as `plugins` in the FIRST argument of AnalyticsBrowser.load. */
+export declare function cdpPlugins(options?: CdpPluginsOptions): CdpPlugin[];
+/** Pass as `disable` to AnalyticsBrowser.load: a key the settings do not enable is a no-op. */
+export declare function hpDisabled(cdnSettings: unknown): boolean;
+/**
+ * The second argument of AnalyticsBrowser.load when `cdnURL` is the apiHost: delivery to the
+ * settings' apiHost with the write key (the settings carry no Segment.io destination), telemetry
+ * off, and a disabled key a no-op. Spread it and add your own options.
+ */
+/** The HP API, used when the page names no proxy host: `cdnURL` for AnalyticsBrowser.load. */
+export declare const DEFAULT_API_HOST: string;
+
+export declare function hpLoadOptions(config: {
+	writeKey: string;
+	apiHost?: string;
+}): {
+	disable(cdnSettings: unknown): boolean;
+	updateCDNSettings<T extends Record<string, unknown>>(cdnSettings: T): T;
+};