@thg-agentic/hyper-personalisation-web 3.28.1 → 3.30.0

package/src/onsite/styles.js

@@ -136,7 +136,6 @@ legend{padding:0;margin-bottom:8px;font-size:13px;font-weight:600}
 .pg p{font-weight:600}
 .tr{height:6px;border-radius:99px;background:color-mix(in srgb,var(--t) 18%,var(--b));overflow:hidden}
 .tr i{display:block;height:100%;border-radius:inherit;background:var(--a);transform:scaleX(0);transform-origin:left;transition:transform .6s ${EASE}}
-.tm{font-size:40px;line-height:1;font-weight:800;letter-spacing:.02em;font-variant-numeric:tabular-nums;text-align:center}
 .bi{display:block;width:100%;height:auto}
 .bl{display:block;border-radius:var(--br)}
 hr{width:100%;margin:4px 0;border:0;border-top:1px solid var(--ln)}

package/src/onsite-facade.js

@@ -15,7 +15,7 @@ const LISTENERS = Symbol.for(
 const SUPPRESSED = Symbol.for(
 	'@thg-agentic/hyper-personalisation-web.onsite.suppressed',
 );
-const EVENTS = ['shown', 'submitted', 'apply', 'closed', 'held'];
+const EVENTS = ['shown', 'submitted', 'apply', 'closed', 'held', 'nothing'];
 const MAX_PENDING = 10;
 
 const page = () => (typeof window === 'undefined' ? null : window);
@@ -52,9 +52,13 @@ export const onsite = Object.freeze({
 	/**
 	 * Listen to the forms: `shown`, `submitted` (`{ coupon }`: the claimed code for a form that
 	 * spins, else null), `apply` (`{ coupon }`: a reminder's code to apply), `closed`
-	 * (`{ reason }`) and `held` (a held-out visitor's trigger fired: the site shows what it shows
-	 * without HP). Each detail carries the `slot`, `arm` and `format`. Returns a function that
-	 * stops listening.
+	 * (`{ reason }`), `held` (a held-out visitor's trigger fired: the site shows what it shows
+	 * without HP) and `nothing` (a covering form's trigger fired and HP will show nothing for it,
+	 * at most 3.05 s later: `{ code }` says why; only the highest of the forms that fire together,
+	 * and no other HP form shows after it on the page view; not for a form the site opened, a
+	 * suppressed page, or one another form showed or a holdout replaced). Each detail carries the `slot` and
+	 * `format`, and all but `nothing` the `arm`.
+	 * Returns a function that stops listening.
 	 */
 	on(name, fn) {
 		try {

package/src/spec-version.js

@@ -1,4 +1,4 @@
 // Generated from the spec by scripts/build-types.mjs. DO NOT EDIT: run `pnpm run build:types`.
 
 /** The event specification this SDK emits, stamped on every event as context.spec.version. */
-export const SPEC_VERSION = '1.21';
+export const SPEC_VERSION = '1.22';

package/src/version.js

@@ -1,2 +1,2 @@
-export const VERSION = '3.28.1';
+export const VERSION = '3.30.0';
 export const LIB = '@thg-agentic/hyper-personalisation-web';

package/types/events.d.ts

@@ -1,7 +1,7 @@
 // Generated from spec/registry.json by scripts/generate-sdk-models.mjs.
 // DO NOT EDIT. Change the schema and regenerate — the schema is the contract,
 // and a hand-edit here is an SDK that disagrees with the ingest.
-// Spec version: 1.21
+// Spec version: 1.22
 
 /** context.source.environment. Environment the producer runs in. */
 export type CdpSourceEnvironment = 'production' | 'staging' | 'development';
@@ -104,6 +104,7 @@ export interface RecommendationServed {
 	strategy?: string | null;
 	algorithm_version?: string | null;
 	candidate_algorithm_version?: string | null;
+	shadow_algorithm_version?: string | null;
 	ranked_by?: 'ranker' | 'blend' | 'session' | 'manual' | 'other' | null;
 	fusion?: string | null;
 	fast_weight?: number | null;
@@ -713,7 +714,7 @@ export interface SignUpRelayed {
 }
 
 /** The spec version these models implement. SDKs stamp it on context.spec.version. */
-export const SPEC_VERSION = '1.21';
+export const SPEC_VERSION = '1.22';
 
 /** Every event name the registry accepts. Anything else is rejected at the ingest. */
 export type CdpEventName =

package/types/onsite.d.ts

@@ -173,6 +173,43 @@ export interface OnsiteOptions {
 	fetch?: typeof fetch;
 }
 
+/**
+ * Why a form is in its state, stable across releases (`reasons` is for people and may be reworded).
+ * A form whose trigger fired and that HP has nothing to show for has an `OnsiteNothingCode`.
+ */
+export type OnsiteTraceCode =
+	| OnsiteNothingCode
+	| 'armed'
+	| 'waiting-for-open'
+	| 'deciding'
+	| 'shown'
+	| 'closed'
+	| 'held-out'
+	| 'invalid'
+	| 'not-eligible'
+	| 'overlay-gap'
+	| 'awaiting-consent'
+	| 'another-showing'
+	| 'allowance-spent'
+	| 'lower-priority'
+	| 'no-element'
+	| 'empty-basket'
+	| 'suppressed';
+
+/**
+ * Why HP shows nothing for a covering form whose trigger fired: the decision failed (a network
+ * error, any status but 200, a 200 without a list of decisions, or no answer within 3 s), the
+ * visitor has no creative, a reminder has no code, the renderer or a products block's chunk did not
+ * load within 3 s, or the form failed while it was being opened (`error`).
+ */
+export type OnsiteNothingCode =
+	| 'decision-failed'
+	| 'no-creative'
+	| 'no-code'
+	| 'renderer-failed'
+	| 'products-failed'
+	| 'error';
+
 /** One form's state on this page, and why. */
 export interface OnsiteTrace {
 	slot: string;
@@ -190,6 +227,8 @@ export interface OnsiteTrace {
 		| 'not eligible'
 		| 'not shown'
 		| 'invalid';
+	/** Since 3.29, always present. Match on this, not on `reasons`. */
+	code: OnsiteTraceCode;
 	reasons: string[];
 }
 
@@ -198,7 +237,7 @@ export interface OnsiteController {
 	open(slot: string): Promise<boolean>;
 	/** Each form's state on this page, and why. */
 	debug(): OnsiteTrace[];
-	/** Stop watching every trigger. A form on screen stays until it is closed. */
+	/** Stop watching every trigger, and say no `nothing` after. A form on screen stays until it is closed. */
 	stop(): void;
 	/** Take every form off the screen, quietly (`hp.onsite.suppress` calls it). */
 	suppress(): void;
@@ -226,6 +265,16 @@ export interface OnsiteEvents {
 	closed: OnsiteEventDetail & { reason: string };
 	/** A held-out visitor's trigger fired (not a form the site opened, whose `open` resolves false): show what the site shows without HP. */
 	held: OnsiteEventDetail;
+	/**
+	 * Since 3.29. A covering form's own trigger fired and HP will show nothing for it on this page
+	 * view: show what the site shows without HP. At most 3.05 s after the trigger, and only for the
+	 * highest of the forms that fire together. It spends the page view's allowance, as `held` does:
+	 * no other HP covering form shows after it on that page view.
+	 * Not said when another form that fired with it shows or the visitor is held out (`held`), for a
+	 * form the site opened (`open` resolves false), on a suppressed page, or when its caps, the gap,
+	 * the consent banner or a form on screen keep it away.
+	 */
+	nothing: { slot: string; format: string; code: OnsiteNothingCode };
 }
 
 /** `hp.onsite`, callable before the runtime has loaded. */