@beworke/pixel 0.1.0-rc.1 → 0.1.0-rc.10

package/dist/url-context-Ck2LK18V.d.ts

@@ -0,0 +1,87 @@
+/**
+ * Contratos de Core UrlContext — captura, gestão e propagação de params de URL.
+ * `sid` público ≠ `session_id` interno do Pixel.
+ */
+type UrlContextMode = 'allowlist' | 'all_except';
+type UrlContextSource = 'url' | 'cookie' | 'storage' | 'generated'
+/** Valor definido após o init via API pública (ex.: oid no checkout). */
+ | 'manual';
+type UrlContextWriteStrategy = 'replaceState' | 'none';
+type UrlContextLinkDecorationStrategy = 'on_click' | 'on_init' | 'both';
+type UrlManagedParamMode = 'read_only' | 'write_only' | 'read_write';
+type UrlQueryParamsConfig = {
+    enabled?: boolean;
+    mode?: UrlContextMode;
+    allowlist?: string[];
+    denylist?: string[];
+    mergeDefaultDenylist?: boolean;
+};
+type UrlManagedParamGeneratorConfig = {
+    type: 'public_id';
+    prefix?: string;
+};
+type UrlManagedParamCookieConfig = {
+    enabled?: boolean;
+    name?: string;
+    domain?: 'auto' | string;
+    path?: string;
+    sameSite?: 'Lax' | 'Strict' | 'None';
+    secure?: boolean;
+    maxAgeMs?: number;
+};
+type UrlManagedParamPersistenceConfig = {
+    enabled?: boolean;
+    strategy?: 'storage' | 'cookie' | 'localStorage_cookie';
+    storageKey?: string;
+    cookie?: UrlManagedParamCookieConfig;
+};
+type UrlManagedParamConfig = {
+    key: string;
+    param: string;
+    mode?: UrlManagedParamMode;
+    writeStrategy?: UrlContextWriteStrategy;
+    generator?: UrlManagedParamGeneratorConfig;
+    persistence?: UrlManagedParamPersistenceConfig;
+    decorateLinks?: boolean;
+};
+type UrlForwardParamsConfig = {
+    enabled?: boolean;
+    mode?: UrlContextMode;
+    allowlist?: string[];
+    denylist?: string[];
+    mergeDefaultDenylist?: boolean;
+};
+type UrlLinkDecorationConfig = {
+    enabled?: boolean;
+    strategy?: UrlContextLinkDecorationStrategy;
+    selector?: string;
+    allowedDomains?: '*' | string[];
+    excludedDomains?: string[];
+    mergeDefaultExcludedDomains?: boolean;
+    excludeSelectors?: string[];
+    mergeDefaultExcludeSelectors?: boolean;
+    preserveExisting?: boolean;
+    overwriteExisting?: boolean;
+    decorateHashLinks?: boolean;
+    decorateMailto?: boolean;
+    decorateTel?: boolean;
+};
+type UrlContextConfig = {
+    enabled?: boolean;
+    queryParams?: UrlQueryParamsConfig;
+    managedParams?: UrlManagedParamConfig[];
+    forwardParams?: UrlForwardParamsConfig;
+    linkDecoration?: UrlLinkDecorationConfig;
+};
+/** Payload interno (camelCase) anexado pelo EventBuilder. */
+type UrlContextPayload = {
+    managed?: Record<string, string>;
+    forwarded?: Record<string, string>;
+    source?: Record<string, UrlContextSource>;
+};
+type UrlContextSnapshot = {
+    queryParams: Record<string, string>;
+    urlContext: UrlContextPayload;
+};
+
+export type { UrlContextConfig as U, UrlContextSnapshot as a, UrlContextLinkDecorationStrategy as b, UrlContextMode as c, UrlContextPayload as d, UrlContextSource as e, UrlContextWriteStrategy as f, UrlForwardParamsConfig as g, UrlLinkDecorationConfig as h, UrlManagedParamConfig as i, UrlManagedParamMode as j, UrlQueryParamsConfig as k };