@heycatch/sdk 0.7.0 → 0.7.1-dev.1123

package/dist/server.d.cts

@@ -1,5 +1,25 @@
-import { a as HeyCatchPersonProperties, H as HeyCatchConfig, b as HeyCatchProperties, d as ServerTrackOptions } from './shared-B8y8fJCD.cjs';
-export { P as PersonPropertyUpdate, S as SDK_VERSION, c as STAGE } from './shared-B8y8fJCD.cjs';
+import { d as HeyCatchPersonProperties, b as HeyCatchConfig, e as HeyCatchProperties, i as ServerTrackOptions } from './shared-BFhHwsG8.cjs';
+export { H as HeyCatchBeforeSend, a as HeyCatchCapturedEvent, c as HeyCatchPersistence, f as HeyCatchSanitizeProperties, K as KNOWN_FRAMEWORKS, g as KNOWN_INSTALL_AGENTS, P as PersonPropertyUpdate, S as SDK_VERSION, h as STAGE, U as UNKNOWN_INSTALL_VALUE } from './shared-BFhHwsG8.cjs';
+
+/**
+ * The consent pair, present on the server namespace so the `analytics`
+ * object has the SAME shape under every `exports` condition - the
+ * invariant that lets isomorphic code call `analytics.optInCapturing()`
+ * from a file the bundler resolves for the browser and `tsc` resolves for
+ * Node. Omitting them here is what broke that: the call typechecked in the
+ * browser and failed under the `node` condition.
+ *
+ * Both are deliberate no-ops rather than a thrown error or a console
+ * warning. A server has no consent state to gate: there is no ambient
+ * person and no browser storage, every server write already names its
+ * `userId` explicitly, and it only happens because the app chose to call
+ * it. A warning would fire on every isomorphic boot and teach customers to
+ * ignore our console output.
+ */
+/** No-op on the server. See the note above. */
+declare function optInCapturing(): void;
+/** No-op on the server. See the note above. */
+declare function optOutCapturing(): void;
 
 /**
  * Update a user's person properties from the server - a payment webhook, a
@@ -30,7 +50,12 @@ declare function resetIdentity(): void;
  * Initialize the server entry. Call once at module scope; idempotent.
  * Takes the same config shape as the browser `init` - `install` metadata
  * is accepted for symmetry but not stamped: install facts describe the
- * client app, and the events they ride on are client events.
+ * client app, and the events they ride on are client events. Same for the
+ * privacy passthrough fields (`autocapture`, `maskAllText`, `persistence`,
+ * …, see `shared.ts`): they parse cleanly here, so one `HeyCatchConfig`
+ * object works under every `exports` condition, but none is read - a
+ * server has no DOM to autocapture from and no browser storage to gate.
+ * Deliberate, not a gap: only the web entry applies them.
  */
 declare function init(config: HeyCatchConfig): void;
 
@@ -69,6 +94,8 @@ declare function trackEvent(event: string, properties: HeyCatchProperties | unde
  */
 declare const analytics: {
     readonly init: typeof init;
+    readonly optInCapturing: typeof optInCapturing;
+    readonly optOutCapturing: typeof optOutCapturing;
     readonly resetIdentity: typeof resetIdentity;
     readonly setIdentity: typeof setIdentity;
     readonly setPersonProperties: typeof setPersonProperties;

package/dist/server.d.ts

@@ -1,5 +1,25 @@
-import { a as HeyCatchPersonProperties, H as HeyCatchConfig, b as HeyCatchProperties, d as ServerTrackOptions } from './shared-B8y8fJCD.js';
-export { P as PersonPropertyUpdate, S as SDK_VERSION, c as STAGE } from './shared-B8y8fJCD.js';
+import { d as HeyCatchPersonProperties, b as HeyCatchConfig, e as HeyCatchProperties, i as ServerTrackOptions } from './shared-BFhHwsG8.js';
+export { H as HeyCatchBeforeSend, a as HeyCatchCapturedEvent, c as HeyCatchPersistence, f as HeyCatchSanitizeProperties, K as KNOWN_FRAMEWORKS, g as KNOWN_INSTALL_AGENTS, P as PersonPropertyUpdate, S as SDK_VERSION, h as STAGE, U as UNKNOWN_INSTALL_VALUE } from './shared-BFhHwsG8.js';
+
+/**
+ * The consent pair, present on the server namespace so the `analytics`
+ * object has the SAME shape under every `exports` condition - the
+ * invariant that lets isomorphic code call `analytics.optInCapturing()`
+ * from a file the bundler resolves for the browser and `tsc` resolves for
+ * Node. Omitting them here is what broke that: the call typechecked in the
+ * browser and failed under the `node` condition.
+ *
+ * Both are deliberate no-ops rather than a thrown error or a console
+ * warning. A server has no consent state to gate: there is no ambient
+ * person and no browser storage, every server write already names its
+ * `userId` explicitly, and it only happens because the app chose to call
+ * it. A warning would fire on every isomorphic boot and teach customers to
+ * ignore our console output.
+ */
+/** No-op on the server. See the note above. */
+declare function optInCapturing(): void;
+/** No-op on the server. See the note above. */
+declare function optOutCapturing(): void;
 
 /**
  * Update a user's person properties from the server - a payment webhook, a
@@ -30,7 +50,12 @@ declare function resetIdentity(): void;
  * Initialize the server entry. Call once at module scope; idempotent.
  * Takes the same config shape as the browser `init` - `install` metadata
  * is accepted for symmetry but not stamped: install facts describe the
- * client app, and the events they ride on are client events.
+ * client app, and the events they ride on are client events. Same for the
+ * privacy passthrough fields (`autocapture`, `maskAllText`, `persistence`,
+ * …, see `shared.ts`): they parse cleanly here, so one `HeyCatchConfig`
+ * object works under every `exports` condition, but none is read - a
+ * server has no DOM to autocapture from and no browser storage to gate.
+ * Deliberate, not a gap: only the web entry applies them.
  */
 declare function init(config: HeyCatchConfig): void;
 
@@ -69,6 +94,8 @@ declare function trackEvent(event: string, properties: HeyCatchProperties | unde
  */
 declare const analytics: {
     readonly init: typeof init;
+    readonly optInCapturing: typeof optInCapturing;
+    readonly optOutCapturing: typeof optOutCapturing;
     readonly resetIdentity: typeof resetIdentity;
     readonly setIdentity: typeof setIdentity;
     readonly setPersonProperties: typeof setPersonProperties;