@revturbine/sdk 0.2.40 → 0.2.41

package/dist/types/web-sdk/react/RevTurbineProvider.d.ts

@@ -1,5 +1,6 @@
 import React from 'react';
 import { type RevTurbineInitInputOptions, type RevTurbinePlacementConfig, type RevTurbinePlacementDecisionInput } from '../customer-side';
+import { type AnnotatedCaptureOptions } from '../telemetry';
 type BootstrapPlacementInput = Omit<RevTurbinePlacementDecisionInput, 'placementId'> & {
     placement: RevTurbinePlacementConfig;
 };
@@ -8,6 +9,16 @@ export type RevTurbineProviderProps = {
     options: RevTurbineInitInputOptions;
     /** Placements to bootstrap (preload decisions) on mount. */
     bootstrapPlacements?: BootstrapPlacementInput[];
+    /**
+     * Opt into annotated DOM capture (plan 144 TASK-15). When set, one delegated
+     * listener per event is installed at the document root; a click on an element
+     * with `data-rt-event` emits that event with its allowlisted `data-rt-prop-*`
+     * / `data-rt-ref` values — never text, input values, hrefs, or selectors, and
+     * never a password / file / hidden / payment control (REQ-14). `true` uses the
+     * defaults; pass {@link AnnotatedCaptureOptions} to configure events/caps.
+     * Omit to disable. Memoize an object value to avoid re-installing.
+     */
+    domCapture?: boolean | AnnotatedCaptureOptions;
     /** React children. */
     children: React.ReactNode;
 };
@@ -26,6 +37,6 @@ export type RevTurbineProviderProps = {
  * </RevTurbineProvider>
  * ```
  */
-export declare function RevTurbineProvider({ options, bootstrapPlacements, children }: RevTurbineProviderProps): React.JSX.Element;
+export declare function RevTurbineProvider({ options, bootstrapPlacements, domCapture, children }: RevTurbineProviderProps): React.JSX.Element;
 export {};
 //# sourceMappingURL=RevTurbineProvider.d.ts.map

package/dist/types/web-sdk/react/RevTurbineProvider.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"RevTurbineProvider.d.ts","sourceRoot":"","sources":["../../../../react/RevTurbineProvider.tsx"],"names":[],"mappings":"AAAA,OAAO,KAA4D,MAAM,OAAO,CAAC;AACjF,OAAO,EAGL,KAAK,0BAA0B,EAC/B,KAAK,yBAAyB,EAC9B,KAAK,gCAAgC,EAItC,MAAM,kBAAkB,CAAC;AAO1B,KAAK,uBAAuB,GAAG,IAAI,CAAC,gCAAgC,EAAE,aAAa,CAAC,GAAG;IACrF,SAAS,EAAE,yBAAyB,CAAC;CACtC,CAAC;AAEF,MAAM,MAAM,uBAAuB,GAAG;IACpC,wEAAwE;IACxE,OAAO,EAAE,0BAA0B,CAAC;IACpC,4DAA4D;IAC5D,mBAAmB,CAAC,EAAE,uBAAuB,EAAE,CAAC;IAChD,sBAAsB;IACtB,QAAQ,EAAE,KAAK,CAAC,SAAS,CAAC;CAC3B,CAAC;AAcF;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,kBAAkB,CAAC,EAAE,OAAO,EAAE,mBAAmB,EAAE,QAAQ,EAAE,EAAE,uBAAuB,qBAoIrG"}
+{"version":3,"file":"RevTurbineProvider.d.ts","sourceRoot":"","sources":["../../../../react/RevTurbineProvider.tsx"],"names":[],"mappings":"AAAA,OAAO,KAA4D,MAAM,OAAO,CAAC;AACjF,OAAO,EAGL,KAAK,0BAA0B,EAC/B,KAAK,yBAAyB,EAC9B,KAAK,gCAAgC,EAItC,MAAM,kBAAkB,CAAC;AAK1B,OAAO,EAA2B,KAAK,uBAAuB,EAAE,MAAM,cAAc,CAAC;AAGrF,KAAK,uBAAuB,GAAG,IAAI,CAAC,gCAAgC,EAAE,aAAa,CAAC,GAAG;IACrF,SAAS,EAAE,yBAAyB,CAAC;CACtC,CAAC;AAEF,MAAM,MAAM,uBAAuB,GAAG;IACpC,wEAAwE;IACxE,OAAO,EAAE,0BAA0B,CAAC;IACpC,4DAA4D;IAC5D,mBAAmB,CAAC,EAAE,uBAAuB,EAAE,CAAC;IAChD;;;;;;;;OAQG;IACH,UAAU,CAAC,EAAE,OAAO,GAAG,uBAAuB,CAAC;IAC/C,sBAAsB;IACtB,QAAQ,EAAE,KAAK,CAAC,SAAS,CAAC;CAC3B,CAAC;AAcF;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,kBAAkB,CAAC,EAAE,OAAO,EAAE,mBAAmB,EAAE,UAAU,EAAE,QAAQ,EAAE,EAAE,uBAAuB,qBAiJjH"}

package/dist/types/web-sdk/react/Track.d.ts

@@ -0,0 +1,51 @@
+import React from 'react';
+import { type TrackOptions } from './useTrack';
+import type { SdkEventProperties } from '../customer-side';
+/** Props for {@link Track}. */
+export interface TrackProps {
+    /** Event name to emit on click. */
+    event: string;
+    /** Event data (reserved names are dropped by {@link useTrack}). */
+    data?: SdkEventProperties;
+    /** Track options (area / action / purpose / once / dedupeKey / immediate). */
+    options?: TrackOptions;
+    /**
+     * Compose the telemetry onto the **single child element** instead of rendering
+     * a wrapper (Radix-Slot style). Preserves the child's accessible name, disabled
+     * state, and existing `onClick`.
+     */
+    asChild?: boolean;
+    /** Host element tag when not `asChild`. Default `'span'`. */
+    as?: keyof React.JSX.IntrinsicElements;
+    className?: string;
+    style?: React.CSSProperties;
+    children?: React.ReactNode;
+}
+/**
+ * Fire a telemetry event on click (plan 144 TASK-16 / REQ-22, AC-14).
+ *
+ * With `asChild`, it **composes onto the single child element** rather than
+ * wrapping it: the child's own `onClick` runs first, and the telemetry fires only
+ * if the child did **not** `preventDefault`. Because it clones the child (no
+ * wrapper element, no added `role`/`tabIndex`), the child's accessible name and
+ * disabled state are unchanged (REQ-19). Without `asChild` it renders a host
+ * element (default `<span>`).
+ */
+export declare function Track({ event, data, options, asChild, as, className, style, children, }: TrackProps): React.ReactElement;
+/**
+ * Telemetry props to spread onto a primitive that **cannot take a wrapper** and
+ * so can't use `<Track asChild>` (plan 144 TASK-16 / REQ-22). Returns an
+ * `onClick` bound to the enclosing {@link TelemetryScope}; the caller composes it
+ * with any handler of their own. Respects `preventDefault` — if a prior handler
+ * prevents default, the event does not fire.
+ *
+ * @example
+ * ```tsx
+ * const t = useTelemetryProps('cta_clicked', { plan: 'pro' });
+ * <button {...t}>Upgrade</button>
+ * ```
+ */
+export declare function useTelemetryProps(event: string, data?: SdkEventProperties, options?: TrackOptions): {
+    onClick: React.MouseEventHandler;
+};
+//# sourceMappingURL=Track.d.ts.map

package/dist/types/web-sdk/react/Track.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Track.d.ts","sourceRoot":"","sources":["../../../../react/Track.tsx"],"names":[],"mappings":"AAEA,OAAO,KAAsB,MAAM,OAAO,CAAC;AAC3C,OAAO,EAAY,KAAK,YAAY,EAAE,MAAM,YAAY,CAAC;AACzD,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,kBAAkB,CAAC;AAW3D,+BAA+B;AAC/B,MAAM,WAAW,UAAU;IACzB,mCAAmC;IACnC,KAAK,EAAE,MAAM,CAAC;IACd,mEAAmE;IACnE,IAAI,CAAC,EAAE,kBAAkB,CAAC;IAC1B,8EAA8E;IAC9E,OAAO,CAAC,EAAE,YAAY,CAAC;IACvB;;;;OAIG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,6DAA6D;IAC7D,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC,GAAG,CAAC,iBAAiB,CAAC;IACvC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,KAAK,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC;IAC5B,QAAQ,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC;CAC5B;AAID;;;;;;;;;GASG;AACH,wBAAgB,KAAK,CAAC,EACpB,KAAK,EACL,IAAI,EACJ,OAAO,EACP,OAAO,EACP,EAAW,EACX,SAAS,EACT,KAAK,EACL,QAAQ,GACT,EAAE,UAAU,GAAG,KAAK,CAAC,YAAY,CA4BjC;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,iBAAiB,CAC/B,KAAK,EAAE,MAAM,EACb,IAAI,CAAC,EAAE,kBAAkB,EACzB,OAAO,CAAC,EAAE,YAAY,GACrB;IAAE,OAAO,EAAE,KAAK,CAAC,iBAAiB,CAAA;CAAE,CAStC"}

package/dist/types/web-sdk/react/index.d.ts

@@ -12,6 +12,7 @@ export * from './TrackOnView';
 export * from './EngagementArea';
 export * from './useTrackedAction';
 export * from './useGatedAction';
+export * from './Track';
 export * from './useCan';
 export * from './useUsageSnapshot';
 export { useRevTurbineTheme } from '../theme/ThemeContext';

package/dist/types/web-sdk/react/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../react/index.ts"],"names":[],"mappings":"AAAA,cAAc,sBAAsB,CAAC;AACrC,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,cAAc,gBAAgB,CAAC;AAC/B,cAAc,aAAa,CAAC;AAC5B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,8BAA8B,CAAC;AAC7C,cAAc,eAAe,CAAC;AAC9B,cAAc,kBAAkB,CAAC;AACjC,cAAc,kBAAkB,CAAC;AACjC,cAAc,YAAY,CAAC;AAC3B,cAAc,eAAe,CAAC;AAC9B,cAAc,kBAAkB,CAAC;AACjC,cAAc,oBAAoB,CAAC;AACnC,cAAc,kBAAkB,CAAC;AACjC,cAAc,UAAU,CAAC;AACzB,cAAc,oBAAoB,CAAC;AACnC,OAAO,EAAE,kBAAkB,EAAE,MAAM,uBAAuB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../react/index.ts"],"names":[],"mappings":"AAAA,cAAc,sBAAsB,CAAC;AACrC,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,cAAc,gBAAgB,CAAC;AAC/B,cAAc,aAAa,CAAC;AAC5B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,8BAA8B,CAAC;AAC7C,cAAc,eAAe,CAAC;AAC9B,cAAc,kBAAkB,CAAC;AACjC,cAAc,kBAAkB,CAAC;AACjC,cAAc,YAAY,CAAC;AAC3B,cAAc,eAAe,CAAC;AAC9B,cAAc,kBAAkB,CAAC;AACjC,cAAc,oBAAoB,CAAC;AACnC,cAAc,kBAAkB,CAAC;AACjC,cAAc,SAAS,CAAC;AACxB,cAAc,UAAU,CAAC;AACzB,cAAc,oBAAoB,CAAC;AACnC,OAAO,EAAE,kBAAkB,EAAE,MAAM,uBAAuB,CAAC"}

package/dist/types/web-sdk/telemetry/dom-capture.d.ts

@@ -0,0 +1,42 @@
+/**
+ * Annotated DOM capture (plan 144 TASK-15 / REQ-14, REQ-23).
+ *
+ * `annotated` mode ONLY — hand-authored `data-rt-event` / `data-rt-ref` /
+ * `data-rt-prop-*` attributes. There is no `mapped` (selector-based) or
+ * `discovery` (auto) capture: those read arbitrary page content and are out of
+ * scope.
+ *
+ * PRIVACY INVARIANTS (REQ-14) — the collection layer NEVER reads:
+ *   - element text / `innerText` / `textContent`
+ *   - input `.value` / `name` / `label`
+ *   - `href` / URLs
+ *   - CSS selectors or the element path
+ *   - arbitrary attributes
+ * Only allowlisted `data-rt-prop-*` values are collected, capped in count and
+ * length, then handed to the caller which passes them through the existing PII
+ * redactor. Password / file / hidden / payment-autocomplete controls are always
+ * excluded, and a `data-rt-no-capture` ancestor opts an element and its whole
+ * subtree out.
+ */
+/** Options for {@link installAnnotatedCapture}. */
+export interface AnnotatedCaptureOptions {
+    /** DOM events to delegate. One listener is attached per event. Default `['click']`. */
+    events?: string[];
+    /** Max `data-rt-prop-*` values collected per element. Default 24. */
+    maxProps?: number;
+    /** Max length of each collected value. Default 256. */
+    maxValueLen?: number;
+}
+/**
+ * Install one delegated listener per supported event at `root` (plan 144
+ * TASK-15). On a matching interaction it emits the element's `data-rt-event` with
+ * its allowlisted `data-rt-prop-*` / `data-rt-ref` values — nothing else. Returns
+ * a cleanup function that removes every listener.
+ *
+ * @param root - the provider root (a DOM element or document)
+ * @param emit - receives `(eventName, props)`; the caller must pass `props`
+ *   through the SDK's redactor (e.g. `sdk.capture`)
+ * @param options - events + caps
+ */
+export declare function installAnnotatedCapture(root: Element | Document, emit: (eventName: string, props: Record<string, string>) => void, options?: AnnotatedCaptureOptions): () => void;
+//# sourceMappingURL=dom-capture.d.ts.map

package/dist/types/web-sdk/telemetry/dom-capture.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"dom-capture.d.ts","sourceRoot":"","sources":["../../../../telemetry/dom-capture.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;GAmBG;AA4EH,mDAAmD;AACnD,MAAM,WAAW,uBAAuB;IACtC,uFAAuF;IACvF,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAClB,qEAAqE;IACrE,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,uDAAuD;IACvD,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,uBAAuB,CACrC,IAAI,EAAE,OAAO,GAAG,QAAQ,EACxB,IAAI,EAAE,CAAC,SAAS,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,KAAK,IAAI,EAChE,OAAO,GAAE,uBAA4B,GACpC,MAAM,IAAI,CAkBZ"}

package/dist/types/web-sdk/telemetry/index.d.ts

@@ -14,4 +14,6 @@ export { createTelemetryCounters } from './counters';
 export type { TelemetryCounters } from './counters';
 export { createExposureManager, exposureManager } from './visibility';
 export type { ExposureBasis, ExposureManager, ExposureObserveOptions } from './visibility';
+export { installAnnotatedCapture } from './dom-capture';
+export type { AnnotatedCaptureOptions } from './dom-capture';
 //# sourceMappingURL=index.d.ts.map

package/dist/types/web-sdk/telemetry/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../telemetry/index.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AACH,OAAO,EAAE,sBAAsB,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAC9D,YAAY,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAC;AACnD,OAAO,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAC;AAC9C,YAAY,EAAE,cAAc,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AAClE,OAAO,EAAE,uBAAuB,EAAE,MAAM,YAAY,CAAC;AACrD,YAAY,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAC;AACpD,OAAO,EAAE,qBAAqB,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AACtE,YAAY,EAAE,aAAa,EAAE,eAAe,EAAE,sBAAsB,EAAE,MAAM,cAAc,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../telemetry/index.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AACH,OAAO,EAAE,sBAAsB,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAC9D,YAAY,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAC;AACnD,OAAO,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAC;AAC9C,YAAY,EAAE,cAAc,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AAClE,OAAO,EAAE,uBAAuB,EAAE,MAAM,YAAY,CAAC;AACrD,YAAY,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAC;AACpD,OAAO,EAAE,qBAAqB,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AACtE,YAAY,EAAE,aAAa,EAAE,eAAe,EAAE,sBAAsB,EAAE,MAAM,cAAc,CAAC;AAC3F,OAAO,EAAE,uBAAuB,EAAE,MAAM,eAAe,CAAC;AACxD,YAAY,EAAE,uBAAuB,EAAE,MAAM,eAAe,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@revturbine/sdk",
-  "version": "0.2.40",
+  "version": "0.2.41",
   "description": "RevTurbine customer-facing SDK — placement decisioning, entitlement checks, and usage tracking.",
   "type": "module",
   "packageManager": "pnpm@11.12.0",