@revturbine/sdk 0.2.37 → 0.2.38

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

@@ -0,0 +1,35 @@
+import React from 'react';
+import { type TrackPurpose } from './TelemetryScope';
+/** Props for {@link EngagementArea}. */
+export interface EngagementAreaProps {
+    /** Logical area name — set as the telemetry scope for descendants and stamped on emitted events. */
+    area: string;
+    /** Event emitted once when the area is first qualified-viewed. Default `engagement_view`. */
+    viewEvent?: string;
+    /** Event emitted with accrued dwell (`dwell_ms`) when the area unmounts. Default `engagement_dwell`. */
+    dwellEvent?: string;
+    /** Event emitted when a descendant is clicked. Default `engagement_interaction`. */
+    interactionEvent?: string;
+    /** Advisory purpose applied to the scope and emitted events. */
+    purpose?: TrackPurpose;
+    /** Visible fraction required to count as viewed / dwelling (0–1). Default 0.5. */
+    threshold?: number;
+    /** Host element tag. Default `'div'`. */
+    as?: keyof React.JSX.IntrinsicElements;
+    className?: string;
+    style?: React.CSSProperties;
+    children?: React.ReactNode;
+}
+/**
+ * A qualified engagement region (plan 144 TASK-13 / REQ-21). It:
+ * - establishes a {@link TelemetryScope} (`area` / `purpose`) for its descendants;
+ * - emits `viewEvent` **once** when first viewport-qualified — one-shot across
+ *   React Strict Mode's double-mount (AC-12);
+ * - accrues dwell only while the region is **onscreen and the tab is visible**,
+ *   emitting `dwellEvent` with `dwell_ms` when it unmounts;
+ * - bubbles descendant clicks as `interactionEvent`.
+ *
+ * Renders its children and never throws without a provider (AC-13).
+ */
+export declare function EngagementArea({ area, viewEvent, dwellEvent, interactionEvent, purpose, threshold, as, className, style, children, }: EngagementAreaProps): React.ReactElement;
+//# sourceMappingURL=EngagementArea.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"EngagementArea.d.ts","sourceRoot":"","sources":["../../../../react/EngagementArea.tsx"],"names":[],"mappings":"AAEA,OAAO,KAAyC,MAAM,OAAO,CAAC;AAC9D,OAAO,EAAkB,KAAK,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAGrE,wCAAwC;AACxC,MAAM,WAAW,mBAAmB;IAClC,oGAAoG;IACpG,IAAI,EAAE,MAAM,CAAC;IACb,6FAA6F;IAC7F,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,wGAAwG;IACxG,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,oFAAoF;IACpF,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,gEAAgE;IAChE,OAAO,CAAC,EAAE,YAAY,CAAC;IACvB,kFAAkF;IAClF,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,yCAAyC;IACzC,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;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,cAAc,CAAC,EAC7B,IAAI,EACJ,SAA6B,EAC7B,UAA+B,EAC/B,gBAA2C,EAC3C,OAAO,EACP,SAAe,EACf,EAAU,EACV,SAAS,EACT,KAAK,EACL,QAAQ,GACT,EAAE,mBAAmB,GAAG,KAAK,CAAC,YAAY,CAuG1C"}

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

@@ -0,0 +1,31 @@
+import React from 'react';
+import { type TrackOptions } from './useTrack';
+import type { SdkEventProperties } from '../customer-side';
+/** Props for {@link TrackOnView}. */
+export interface TrackOnViewProps {
+    /** Event name emitted once when the element is qualified-viewed. */
+    event: string;
+    /** Event data (reserved names are dropped by {@link useTrack}). */
+    data?: SdkEventProperties;
+    /** Track options (area / action / purpose / immediate). */
+    options?: TrackOptions;
+    /** Visible fraction required (0–1). Default 0.5. */
+    threshold?: number;
+    /** Minimum visible dwell before it counts, in ms. Default 0. */
+    minVisibleMs?: number;
+    /** Host element tag. Default `'div'`. */
+    as?: keyof React.JSX.IntrinsicElements;
+    className?: string;
+    style?: React.CSSProperties;
+    children?: React.ReactNode;
+}
+/**
+ * Emits `event` exactly once, the first time its host element is
+ * viewport-qualified (plan 144 TASK-13 / REQ-21). Falls back to firing on render
+ * when `IntersectionObserver` is unavailable (AC-10 degradation). The one-shot
+ * guard is a ref that survives React Strict Mode's development double-mount, so
+ * the event fires once, not twice (AC-12). Renders its children in the host
+ * element and never throws without a provider (AC-13).
+ */
+export declare function TrackOnView({ event, data, options, threshold, minVisibleMs, as, className, style, children, }: TrackOnViewProps): React.ReactElement;
+//# sourceMappingURL=TrackOnView.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"TrackOnView.d.ts","sourceRoot":"","sources":["../../../../react/TrackOnView.tsx"],"names":[],"mappings":"AAEA,OAAO,KAAyC,MAAM,OAAO,CAAC;AAE9D,OAAO,EAAY,KAAK,YAAY,EAAE,MAAM,YAAY,CAAC;AACzD,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,kBAAkB,CAAC;AAE3D,qCAAqC;AACrC,MAAM,WAAW,gBAAgB;IAC/B,oEAAoE;IACpE,KAAK,EAAE,MAAM,CAAC;IACd,mEAAmE;IACnE,IAAI,CAAC,EAAE,kBAAkB,CAAC;IAC1B,2DAA2D;IAC3D,OAAO,CAAC,EAAE,YAAY,CAAC;IACvB,oDAAoD;IACpD,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,gEAAgE;IAChE,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,yCAAyC;IACzC,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;AAED;;;;;;;GAOG;AACH,wBAAgB,WAAW,CAAC,EAC1B,KAAK,EACL,IAAI,EACJ,OAAO,EACP,SAAS,EACT,YAAY,EACZ,EAAU,EACV,SAAS,EACT,KAAK,EACL,QAAQ,GACT,EAAE,gBAAgB,GAAG,KAAK,CAAC,YAAY,CAiCvC"}

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

@@ -8,6 +8,8 @@ export * from './UserProfile';
 export * from './useEntitlement';
 export * from './TelemetryScope';
 export * from './useTrack';
+export * from './TrackOnView';
+export * from './EngagementArea';
 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,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,UAAU,CAAC;AACzB,cAAc,oBAAoB,CAAC;AACnC,OAAO,EAAE,kBAAkB,EAAE,MAAM,uBAAuB,CAAC"}

package/package.json

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