@kywi-software/js 0.15.0 → 0.15.1

package/dist/audience/behavioral-collector.d.ts

@@ -1,3 +1,4 @@
+import { type ConsentGateOptions } from '../consent.js';
 export interface BehavioralResult {
     session: {
         pageViewCount: number;
@@ -11,5 +12,5 @@ export interface BehavioralResult {
         totalScore: number;
     };
 }
-export declare function collectBehavioral(currentPath: string, category?: string): BehavioralResult;
+export declare function collectBehavioral(currentPath: string, category?: string, gate?: ConsentGateOptions): BehavioralResult;
 //# sourceMappingURL=behavioral-collector.d.ts.map

package/dist/audience/behavioral-collector.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"behavioral-collector.d.ts","sourceRoot":"","sources":["../../src/audience/behavioral-collector.ts"],"names":[],"mappings":"AAQA,MAAM,WAAW,gBAAgB;IAC/B,OAAO,EAAE;QAAE,aAAa,EAAE,MAAM,CAAC;QAAC,cAAc,EAAE,MAAM,CAAC;QAAC,eAAe,EAAE,MAAM,CAAC;QAAC,SAAS,EAAE,MAAM,CAAC;QAAC,YAAY,EAAE,MAAM,EAAE,CAAA;KAAE,CAAA;IAC9H,UAAU,EAAE;QAAE,cAAc,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QAAC,UAAU,EAAE,MAAM,CAAA;KAAE,CAAA;CAC3E;AAsBD,wBAAgB,iBAAiB,CAAC,WAAW,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,gBAAgB,CAqB1F"}
+{"version":3,"file":"behavioral-collector.d.ts","sourceRoot":"","sources":["../../src/audience/behavioral-collector.ts"],"names":[],"mappings":"AAEA,OAAO,EAAc,KAAK,kBAAkB,EAAE,MAAM,eAAe,CAAA;AASnE,MAAM,WAAW,gBAAgB;IAC/B,OAAO,EAAE;QAAE,aAAa,EAAE,MAAM,CAAC;QAAC,cAAc,EAAE,MAAM,CAAC;QAAC,eAAe,EAAE,MAAM,CAAC;QAAC,SAAS,EAAE,MAAM,CAAC;QAAC,YAAY,EAAE,MAAM,EAAE,CAAA;KAAE,CAAA;IAC9H,UAAU,EAAE;QAAE,cAAc,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QAAC,UAAU,EAAE,MAAM,CAAA;KAAE,CAAA;CAC3E;AAsBD,wBAAgB,iBAAiB,CAC/B,WAAW,EAAE,MAAM,EACnB,QAAQ,CAAC,EAAE,MAAM,EACjB,IAAI,GAAE,kBAAuB,GAC5B,gBAAgB,CA+BlB"}

package/dist/audience/evaluate.d.ts

@@ -1,3 +1,11 @@
 import type { Audience, VisitorSignals, AudienceResult } from '@kywi-software/core/audiences/types';
-export declare function evaluateClientSide(audiences: Audience[], serverSignals: Partial<VisitorSignals>, currentPath: string, pageCategory?: string): AudienceResult;
+import type { ConsentGateOptions } from '../consent.js';
+export declare function evaluateClientSide(audiences: Audience[], serverSignals: Partial<VisitorSignals>, currentPath: string, pageCategory?: string, 
+/**
+ * `theme.personalization.requireConsent` (kywi-cms#91), passed through to the
+ * behavioral collector so what it REMEMBERS between page views follows the
+ * same rule the server's cookies do. Omitted, consent is required — the
+ * compliant default.
+ */
+gate?: ConsentGateOptions): AudienceResult;
 //# sourceMappingURL=evaluate.d.ts.map

package/dist/audience/evaluate.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"evaluate.d.ts","sourceRoot":"","sources":["../../src/audience/evaluate.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,QAAQ,EAAE,cAAc,EAAE,cAAc,EAAE,MAAM,qCAAqC,CAAA;AAenG,wBAAgB,kBAAkB,CAChC,SAAS,EAAE,QAAQ,EAAE,EAAE,aAAa,EAAE,OAAO,CAAC,cAAc,CAAC,EAAE,WAAW,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,MAAM,GACxG,cAAc,CAQhB"}
+{"version":3,"file":"evaluate.d.ts","sourceRoot":"","sources":["../../src/audience/evaluate.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,QAAQ,EAAE,cAAc,EAAE,cAAc,EAAE,MAAM,qCAAqC,CAAA;AAMnG,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,eAAe,CAAA;AAYvD,wBAAgB,kBAAkB,CAChC,SAAS,EAAE,QAAQ,EAAE,EAAE,aAAa,EAAE,OAAO,CAAC,cAAc,CAAC,EAAE,WAAW,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,MAAM;AACzG;;;;;GAKG;AACH,IAAI,GAAE,kBAAuB,GAC5B,cAAc,CAWhB"}

package/dist/audience/query-collector.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Every query parameter of the current URL. Repeated params keep the FIRST
+ * value, matching the server's `collectQuery`. Empty off the browser.
+ */
+export declare function collectQuery(): Record<string, string>;
+/**
+ * The entry page to record for a page view: the path the host handed us, with
+ * this page's query string appended when the path does not already carry one.
+ *
+ * The query is the interesting half of a campaign landing (`?from=marketer`),
+ * and the host passes a bare pathname — so without this the client's entry page
+ * and the server's would disagree on every campaign link.
+ */
+export declare function entryPageFor(currentPath: string): string;
+//# sourceMappingURL=query-collector.d.ts.map

package/dist/audience/query-collector.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"query-collector.d.ts","sourceRoot":"","sources":["../../src/audience/query-collector.ts"],"names":[],"mappings":"AAQA;;;GAGG;AACH,wBAAgB,YAAY,IAAI,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CASrD;AAED;;;;;;;GAOG;AACH,wBAAgB,YAAY,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,CAIxD"}

package/dist/audience/selfid-api.d.ts

@@ -0,0 +1,57 @@
+/** The audience the server resolved the visitor to, if any. */
+export interface SelfIdAudience {
+    id: string;
+    name: string;
+}
+export interface SelfIdResult {
+    /** The audience the answers resolved to, or null when nothing matched. */
+    audience: SelfIdAudience | null;
+    /**
+     * Whether the answers were stored SERVER-side. False for a visitor who has
+     * not consented to personalization — the audience is still pinned and this
+     * page still changes, the profile simply is not kept (kywi-cms#91).
+     */
+    persisted: boolean;
+    /** The answers now on record in the browser. */
+    fields: Record<string, string>;
+}
+export interface SelfIdOptions {
+    /** Mounted CMS API base. Defaults to the one `Kywi.boot()` derived. */
+    apiBase?: string;
+    csrfToken?: string | null;
+    /** Reload so the server can re-render with the new pin. Default true. */
+    reload?: boolean;
+    /**
+     * Pin this audience BY ID instead of resolving one from the answers — the id
+     * comes from `GET {apiBase}/kywi/audiences`, which lists the audiences an
+     * editor marked public (kywi-cms#200). Use it when the page renders the
+     * chooser FROM that list, so the visitor's pick lands exactly, and an
+     * audience with no rules of its own is still reachable. The server validates
+     * the id against the same public, site-scoped list.
+     */
+    audienceId?: string;
+}
+/**
+ * Record the visitor's self-identification and resolve their audience.
+ *
+ * Answers MERGE into whatever is already on record — two controls on the same
+ * page (a role picker and an industry picker) do not clobber each other — and a
+ * field submitted as `''` is removed, which is what a "Change" / "Clear"
+ * control sends.
+ *
+ * Pass `audienceId` to pin one of the site's PUBLIC audiences directly instead
+ * of resolving from the answers; see {@link SelfIdOptions}.
+ *
+ * Resolves once the server has answered, with the audience it resolved to.
+ * Never throws for a failed request: an offline visitor gets
+ * `{ audience: null, persisted: false }` and no reload, so the page is not
+ * dropped back onto itself with nothing changed.
+ */
+export declare function setSelfId(fields: Record<string, string>, options?: SelfIdOptions): Promise<SelfIdResult>;
+/**
+ * Forget the visitor's self-identification: clears the browser copy, the
+ * server-side copy and the audience pin, so resolution goes back to signals.
+ * The mirror of `setSelfId`, and what a "Change" control calls.
+ */
+export declare function clearSelfId(options?: SelfIdOptions): Promise<SelfIdResult>;
+//# sourceMappingURL=selfid-api.d.ts.map

package/dist/audience/selfid-api.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"selfid-api.d.ts","sourceRoot":"","sources":["../../src/audience/selfid-api.ts"],"names":[],"mappings":"AAiCA,+DAA+D;AAC/D,MAAM,WAAW,cAAc;IAC7B,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,MAAM,CAAA;CACb;AAED,MAAM,WAAW,YAAY;IAC3B,0EAA0E;IAC1E,QAAQ,EAAE,cAAc,GAAG,IAAI,CAAA;IAC/B;;;;OAIG;IACH,SAAS,EAAE,OAAO,CAAA;IAClB,gDAAgD;IAChD,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;CAC/B;AAED,MAAM,WAAW,aAAa;IAC5B,uEAAuE;IACvE,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB,yEAAyE;IACzE,MAAM,CAAC,EAAE,OAAO,CAAA;IAChB;;;;;;;OAOG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;CACpB;AAqBD;;;;;;;;;;;;;;;GAeG;AACH,wBAAsB,SAAS,CAC7B,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,EAC9B,OAAO,GAAE,aAAkB,GAC1B,OAAO,CAAC,YAAY,CAAC,CAYvB;AAED;;;;GAIG;AACH,wBAAsB,WAAW,CAAC,OAAO,GAAE,aAAkB,GAAG,OAAO,CAAC,YAAY,CAAC,CAKpF"}

package/dist/audience/selfid-collector.d.ts

@@ -1,3 +1,5 @@
 export declare function collectSelfId(): Record<string, string>;
 export declare function storeSelfId(responses: Record<string, string>): void;
+/** Forget the visitor's answers entirely (the browser half of clearSelfId). */
+export declare function clearStoredSelfId(): void;
 //# sourceMappingURL=selfid-collector.d.ts.map

package/dist/audience/selfid-collector.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"selfid-collector.d.ts","sourceRoot":"","sources":["../../src/audience/selfid-collector.ts"],"names":[],"mappings":"AAGA,wBAAgB,aAAa,IAAI,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAItD;AAED,wBAAgB,WAAW,CAAC,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,IAAI,CAEnE"}
+{"version":3,"file":"selfid-collector.d.ts","sourceRoot":"","sources":["../../src/audience/selfid-collector.ts"],"names":[],"mappings":"AAQA,wBAAgB,aAAa,IAAI,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAQtD;AAED,wBAAgB,WAAW,CAAC,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,IAAI,CAEnE;AAED,+EAA+E;AAC/E,wBAAgB,iBAAiB,IAAI,IAAI,CAExC"}

package/dist/consent.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"consent.d.ts","sourceRoot":"","sources":["../src/consent.ts"],"names":[],"mappings":"AAGA,eAAO,MAAM,cAAc,EAAG,cAAuB,CAAA;AAErD,2CAA2C;AAC3C,eAAO,MAAM,mBAAmB,EAAG,eAAwB,CAAA;AAE3D;;;;GAIG;AACH,eAAO,MAAM,mBAAmB,EAAG,WAAoB,CAAA;AAEvD,MAAM,MAAM,eAAe,GAAG,WAAW,GAAG,WAAW,GAAG,WAAW,GAAG,iBAAiB,CAAA;AAEzF;;;;;;;;GAQG;AACH,eAAO,MAAM,uBAAuB,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,CASnE,CAAA;AAED,qEAAqE;AACrE,MAAM,WAAW,kBAAkB;IACjC;;;;OAIG;IACH,cAAc,CAAC,EAAE,OAAO,CAAA;CACzB;AAED,MAAM,WAAW,YAAY;IAC3B,SAAS,EAAE,OAAO,CAAA;IAClB,SAAS,EAAE,OAAO,CAAA;IAClB,SAAS,EAAE,OAAO,CAAA;IAClB,eAAe,EAAE,OAAO,CAAA;CACzB;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,eAAe,IAAI,YAAY,GAAG,IAAI,CAmBrD;AAED;;;GAGG;AACH,wBAAgB,UAAU,CACxB,KAAK,EAAE,OAAO,CAAC,IAAI,CAAC,YAAY,EAAE,WAAW,CAAC,CAAC,GAC9C,IAAI,CAYN;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,YAAY,GAAG,IAAI,GAAG,MAAM,EAAE,CAYvE;AAyBD;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,UAAU,CAAC,QAAQ,EAAE,eAAe,EAAE,OAAO,GAAE,kBAAuB,GAAG,OAAO,CAM/F"}
+{"version":3,"file":"consent.d.ts","sourceRoot":"","sources":["../src/consent.ts"],"names":[],"mappings":"AAGA,eAAO,MAAM,cAAc,EAAG,cAAuB,CAAA;AAErD,2CAA2C;AAC3C,eAAO,MAAM,mBAAmB,EAAG,eAAwB,CAAA;AAE3D;;;;GAIG;AACH,eAAO,MAAM,mBAAmB,EAAG,WAAoB,CAAA;AAEvD,MAAM,MAAM,eAAe,GAAG,WAAW,GAAG,WAAW,GAAG,WAAW,GAAG,iBAAiB,CAAA;AAEzF;;;;;;;;GAQG;AACH,eAAO,MAAM,uBAAuB,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,CAWnE,CAAA;AAED,qEAAqE;AACrE,MAAM,WAAW,kBAAkB;IACjC;;;;OAIG;IACH,cAAc,CAAC,EAAE,OAAO,CAAA;CACzB;AAED,MAAM,WAAW,YAAY;IAC3B,SAAS,EAAE,OAAO,CAAA;IAClB,SAAS,EAAE,OAAO,CAAA;IAClB,SAAS,EAAE,OAAO,CAAA;IAClB,eAAe,EAAE,OAAO,CAAA;CACzB;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,eAAe,IAAI,YAAY,GAAG,IAAI,CAmBrD;AAED;;;GAGG;AACH,wBAAgB,UAAU,CACxB,KAAK,EAAE,OAAO,CAAC,IAAI,CAAC,YAAY,EAAE,WAAW,CAAC,CAAC,GAC9C,IAAI,CAYN;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,YAAY,GAAG,IAAI,GAAG,MAAM,EAAE,CAYvE;AAyBD;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,UAAU,CAAC,QAAQ,EAAE,eAAe,EAAE,OAAO,GAAE,kBAAuB,GAAG,OAAO,CAM/F"}

package/dist/index.d.ts

@@ -1,4 +1,5 @@
 import type { KywiContext, KywiModuleDefinition } from './types.js';
+import { setSelfId, clearSelfId } from './audience/selfid-api.js';
 type PreInitCallback = (kywi: typeof Kywi) => void;
 export declare const Kywi: {
     version: string;
@@ -14,12 +15,26 @@ export declare const Kywi: {
             extend(methods: Record<string, (...args: unknown[]) => unknown>): void;
         };
     };
+    /**
+     * Record who the visitor says they are, and resolve their audience
+     * (kywi-cms#200). Writes the browser-side answers, posts them to the
+     * consent-gated runtime endpoint, and reloads so the SERVER can re-render
+     * with the resolved audience pinned — which is the only way to reach a
+     * variant arm, since every losing arm is pruned server-side (#167).
+     *
+     * On the global because a site's own "What brings you here?" control needs
+     * it: the built-in widget's write path is module-private.
+     */
+    setSelfId: typeof setSelfId;
+    /** Forget the visitor's self-identification and un-pin their audience. */
+    clearSelfId: typeof clearSelfId;
     getEntity: (type: string) => any;
     getFeed: (type: string) => any;
     renderFeed: (options: any) => void;
     boot(): void;
 };
 export { bootAudienceEngine } from './audience/index.js';
+export { setSelfId, clearSelfId, type SelfIdAudience, type SelfIdOptions, type SelfIdResult, } from './audience/selfid-api.js';
 export { openTransparencyPanel, renderTransparencyPanel, type TransparencyState, type TransparencyAudience, } from './audience/transparency.js';
 export { bootExperiments, type ExperimentRuntime, type ConversionSignal } from './experiments/index.js';
 export { initNavMenus, enhanceNav, NAV_BREAKPOINT } from './nav/menu.js';

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,WAAW,EAAE,oBAAoB,EAAE,MAAM,YAAY,CAAA;AAUnE,KAAK,eAAe,GAAG,CAAC,IAAI,EAAE,OAAO,IAAI,KAAK,IAAI,CAAA;AAIlD,eAAO,MAAM,IAAI;;aAEa,WAAW;YACzB,MAAM,CAAC,MAAM,EAAE,oBAAoB,CAAC;gBACtC,eAAe,GAAG,IAAI;;2BAIb,oBAAoB,GAAG,oBAAoB;;;;oBAM9C,MAAM,CAAC,MAAM,EAAE,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,KAAK,OAAO,CAAC;4BAC7C,MAAM,CAAC,MAAM,EAAE,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,KAAK,OAAO,CAAC,GAAG,IAAI;;;eAK5C,CAAC,IAAI,EAAE,MAAM,KAAK,GAAG;aACvB,CAAC,IAAI,EAAE,MAAM,KAAK,GAAG;gBAClB,CAAC,OAAO,EAAE,GAAG,KAAK,IAAI;YAC7C,IAAI;CAkBb,CAAA;AAWD,OAAO,EAAE,kBAAkB,EAAE,MAAM,qBAAqB,CAAA;AACxD,OAAO,EACL,qBAAqB,EACrB,uBAAuB,EACvB,KAAK,iBAAiB,EACtB,KAAK,oBAAoB,GAC1B,MAAM,4BAA4B,CAAA;AACnC,OAAO,EAAE,eAAe,EAAE,KAAK,iBAAiB,EAAE,KAAK,gBAAgB,EAAE,MAAM,wBAAwB,CAAA;AACvG,OAAO,EAAE,YAAY,EAAE,UAAU,EAAE,cAAc,EAAE,MAAM,eAAe,CAAA;AAIxE,OAAO,EACL,eAAe,EACf,UAAU,EACV,UAAU,EACV,kBAAkB,EAClB,uBAAuB,EACvB,cAAc,EACd,mBAAmB,EACnB,mBAAmB,EACnB,KAAK,eAAe,EACpB,KAAK,kBAAkB,EACvB,KAAK,YAAY,GAClB,MAAM,cAAc,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,WAAW,EAAE,oBAAoB,EAAE,MAAM,YAAY,CAAA;AASnE,OAAO,EAAE,SAAS,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAA;AAEjE,KAAK,eAAe,GAAG,CAAC,IAAI,EAAE,OAAO,IAAI,KAAK,IAAI,CAAA;AAIlD,eAAO,MAAM,IAAI;;aAEa,WAAW;YACzB,MAAM,CAAC,MAAM,EAAE,oBAAoB,CAAC;gBACtC,eAAe,GAAG,IAAI;;2BAIb,oBAAoB,GAAG,oBAAoB;;;;oBAM9C,MAAM,CAAC,MAAM,EAAE,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,KAAK,OAAO,CAAC;4BAC7C,MAAM,CAAC,MAAM,EAAE,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,KAAK,OAAO,CAAC,GAAG,IAAI;;;IAK1E;;;;;;;;;OASG;;IAEH,0EAA0E;;eAE5C,CAAC,IAAI,EAAE,MAAM,KAAK,GAAG;aACvB,CAAC,IAAI,EAAE,MAAM,KAAK,GAAG;gBAClB,CAAC,OAAO,EAAE,GAAG,KAAK,IAAI;YAC7C,IAAI;CAkBb,CAAA;AAWD,OAAO,EAAE,kBAAkB,EAAE,MAAM,qBAAqB,CAAA;AACxD,OAAO,EACL,SAAS,EACT,WAAW,EACX,KAAK,cAAc,EACnB,KAAK,aAAa,EAClB,KAAK,YAAY,GAClB,MAAM,0BAA0B,CAAA;AACjC,OAAO,EACL,qBAAqB,EACrB,uBAAuB,EACvB,KAAK,iBAAiB,EACtB,KAAK,oBAAoB,GAC1B,MAAM,4BAA4B,CAAA;AACnC,OAAO,EAAE,eAAe,EAAE,KAAK,iBAAiB,EAAE,KAAK,gBAAgB,EAAE,MAAM,wBAAwB,CAAA;AACvG,OAAO,EAAE,YAAY,EAAE,UAAU,EAAE,cAAc,EAAE,MAAM,eAAe,CAAA;AAIxE,OAAO,EACL,eAAe,EACf,UAAU,EACV,UAAU,EACV,kBAAkB,EAClB,uBAAuB,EACvB,cAAc,EACd,mBAAmB,EACnB,mBAAmB,EACnB,KAAK,eAAe,EACpB,KAAK,kBAAkB,EACvB,KAAK,YAAY,GAClB,MAAM,cAAc,CAAA"}