@obsrviq/react 0.3.2 → 0.5.0

package/dist/index.d.ts

@@ -21,6 +21,10 @@ interface ObsrviqClient {
     /** Close a named sub-event span opened by startTask(name). */
     endTask(name: string, props?: Record<string, unknown>): void;
     setConsent(granted: boolean): void;
+    /** Begin recording now — the trigger for `autoStart: false` (manual) mode. */
+    startRecording(): void;
+    /** Stop recording + flush; stays off until startRecording() is called again. */
+    stopRecording(): void;
     flush(): Promise<boolean>;
     stop(): void;
 }

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/index.ts"],"sourcesContent":["import {\n  createContext,\n  createElement,\n  useContext,\n  useEffect,\n  useRef,\n  type ReactNode,\n} from 'react';\nimport { Obsrviq } from '@obsrviq/tracker';\nimport type { ObsrviqInitConfig } from '@obsrviq/types';\n\n/** The public surface of the Obsrviq client (the singleton structurally satisfies it). */\nexport interface ObsrviqClient {\n  readonly sessionId: string | null;\n  init(config: ObsrviqInitConfig): void;\n  identify(userId: string, traits?: Record<string, unknown>): void;\n  setMetadata(props: Record<string, unknown>): void;\n  reset(): void;\n  track(name: string, props?: Record<string, unknown>): void;\n  /** Mark a client-defined conversion by name (e.g. \"checkout\", \"signup\"). */\n  conversion(name: string, props?: Record<string, unknown>): void;\n  /** Attach free-form, searchable labels to the current session. */\n  tag(...names: string[]): void;\n  /** Open a named sub-event span; returns a handle whose end() closes it. */\n  startTask(name: string, props?: Record<string, unknown>): { end: (endProps?: Record<string, unknown>) => void };\n  /** Close a named sub-event span opened by startTask(name). */\n  endTask(name: string, props?: Record<string, unknown>): void;\n  setConsent(granted: boolean): void;\n  flush(): Promise<boolean>;\n  stop(): void;\n}\n\nconst client: ObsrviqClient = Obsrviq;\nconst ObsrviqContext = createContext<ObsrviqClient | null>(null);\n\nexport interface ObsrviqProviderProps extends Omit<ObsrviqInitConfig, 'userId' | 'metadata'> {\n  /** Raw application user id. Re-applied via identify() whenever it changes\n   *  (e.g. it resolves after login). */\n  userId?: string;\n  /** Session metadata. Re-merged via setMetadata() whenever it changes. */\n  metadata?: Record<string, unknown>;\n  children: ReactNode;\n}\n\n/**\n * Initialises the Obsrviq tracker once and keeps identity in sync with props.\n *\n * Late identity is first-class: pass `userId` once it resolves after login and\n * the provider calls Obsrviq.identify(), which retro-stamps the already-running\n * session. Safe under React 18 StrictMode (double-mount) and alongside a prior\n * script-tag init — Obsrviq.init() is idempotent, so the first init wins and any\n * later identity is applied via identify()/setMetadata().\n */\nexport function ObsrviqProvider({ children, userId, metadata, ...config }: ObsrviqProviderProps) {\n  // Init once (idempotent in the tracker; StrictMode double-invoke is harmless).\n  useEffect(() => {\n    Obsrviq.init(config as ObsrviqInitConfig);\n    if (userId != null) Obsrviq.identify(userId, metadata);\n    else if (metadata) Obsrviq.setMetadata(metadata);\n    // eslint-disable-next-line react-hooks/exhaustive-deps\n  }, []);\n\n  // Sync identity on subsequent changes (login, plan change, …).\n  const metaKey = metadata ? JSON.stringify(metadata) : '';\n  const mounted = useRef(false);\n  useEffect(() => {\n    if (!mounted.current) {\n      mounted.current = true;\n      return; // mount run already handled above\n    }\n    if (userId != null) Obsrviq.identify(userId, metadata);\n    else if (metadata) Obsrviq.setMetadata(metadata);\n    // eslint-disable-next-line react-hooks/exhaustive-deps\n  }, [userId, metaKey]);\n\n  return createElement(ObsrviqContext.Provider, { value: client }, children);\n}\n\n/** Access the Obsrviq client (identify / setMetadata / track / reset / setConsent). */\nexport function useObsrviq(): ObsrviqClient {\n  const ctx = useContext(ObsrviqContext);\n  if (!ctx) throw new Error('useObsrviq() must be used within a <ObsrviqProvider>.');\n  return ctx;\n}\n"],"mappings":";AAAA;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OAEK;AACP,SAAS,eAAe;AAwBxB,IAAM,SAAwB;AAC9B,IAAM,iBAAiB,cAAoC,IAAI;AAoBxD,SAAS,gBAAgB,EAAE,UAAU,QAAQ,UAAU,GAAG,OAAO,GAAyB;AAE/F,YAAU,MAAM;AACd,YAAQ,KAAK,MAA2B;AACxC,QAAI,UAAU,KAAM,SAAQ,SAAS,QAAQ,QAAQ;AAAA,aAC5C,SAAU,SAAQ,YAAY,QAAQ;AAAA,EAEjD,GAAG,CAAC,CAAC;AAGL,QAAM,UAAU,WAAW,KAAK,UAAU,QAAQ,IAAI;AACtD,QAAM,UAAU,OAAO,KAAK;AAC5B,YAAU,MAAM;AACd,QAAI,CAAC,QAAQ,SAAS;AACpB,cAAQ,UAAU;AAClB;AAAA,IACF;AACA,QAAI,UAAU,KAAM,SAAQ,SAAS,QAAQ,QAAQ;AAAA,aAC5C,SAAU,SAAQ,YAAY,QAAQ;AAAA,EAEjD,GAAG,CAAC,QAAQ,OAAO,CAAC;AAEpB,SAAO,cAAc,eAAe,UAAU,EAAE,OAAO,OAAO,GAAG,QAAQ;AAC3E;AAGO,SAAS,aAA4B;AAC1C,QAAM,MAAM,WAAW,cAAc;AACrC,MAAI,CAAC,IAAK,OAAM,IAAI,MAAM,uDAAuD;AACjF,SAAO;AACT;","names":[]}
+{"version":3,"sources":["../src/index.ts"],"sourcesContent":["import {\n  createContext,\n  createElement,\n  useContext,\n  useEffect,\n  useRef,\n  type ReactNode,\n} from 'react';\nimport { Obsrviq } from '@obsrviq/tracker';\nimport type { ObsrviqInitConfig } from '@obsrviq/types';\n\n/** The public surface of the Obsrviq client (the singleton structurally satisfies it). */\nexport interface ObsrviqClient {\n  readonly sessionId: string | null;\n  init(config: ObsrviqInitConfig): void;\n  identify(userId: string, traits?: Record<string, unknown>): void;\n  setMetadata(props: Record<string, unknown>): void;\n  reset(): void;\n  track(name: string, props?: Record<string, unknown>): void;\n  /** Mark a client-defined conversion by name (e.g. \"checkout\", \"signup\"). */\n  conversion(name: string, props?: Record<string, unknown>): void;\n  /** Attach free-form, searchable labels to the current session. */\n  tag(...names: string[]): void;\n  /** Open a named sub-event span; returns a handle whose end() closes it. */\n  startTask(name: string, props?: Record<string, unknown>): { end: (endProps?: Record<string, unknown>) => void };\n  /** Close a named sub-event span opened by startTask(name). */\n  endTask(name: string, props?: Record<string, unknown>): void;\n  setConsent(granted: boolean): void;\n  /** Begin recording now — the trigger for `autoStart: false` (manual) mode. */\n  startRecording(): void;\n  /** Stop recording + flush; stays off until startRecording() is called again. */\n  stopRecording(): void;\n  flush(): Promise<boolean>;\n  stop(): void;\n}\n\nconst client: ObsrviqClient = Obsrviq;\nconst ObsrviqContext = createContext<ObsrviqClient | null>(null);\n\nexport interface ObsrviqProviderProps extends Omit<ObsrviqInitConfig, 'userId' | 'metadata'> {\n  /** Raw application user id. Re-applied via identify() whenever it changes\n   *  (e.g. it resolves after login). */\n  userId?: string;\n  /** Session metadata. Re-merged via setMetadata() whenever it changes. */\n  metadata?: Record<string, unknown>;\n  children: ReactNode;\n}\n\n/**\n * Initialises the Obsrviq tracker once and keeps identity in sync with props.\n *\n * Late identity is first-class: pass `userId` once it resolves after login and\n * the provider calls Obsrviq.identify(), which retro-stamps the already-running\n * session. Safe under React 18 StrictMode (double-mount) and alongside a prior\n * script-tag init — Obsrviq.init() is idempotent, so the first init wins and any\n * later identity is applied via identify()/setMetadata().\n */\nexport function ObsrviqProvider({ children, userId, metadata, ...config }: ObsrviqProviderProps) {\n  // Init once (idempotent in the tracker; StrictMode double-invoke is harmless).\n  useEffect(() => {\n    Obsrviq.init(config as ObsrviqInitConfig);\n    if (userId != null) Obsrviq.identify(userId, metadata);\n    else if (metadata) Obsrviq.setMetadata(metadata);\n    // eslint-disable-next-line react-hooks/exhaustive-deps\n  }, []);\n\n  // Sync identity on subsequent changes (login, plan change, …).\n  const metaKey = metadata ? JSON.stringify(metadata) : '';\n  const mounted = useRef(false);\n  useEffect(() => {\n    if (!mounted.current) {\n      mounted.current = true;\n      return; // mount run already handled above\n    }\n    if (userId != null) Obsrviq.identify(userId, metadata);\n    else if (metadata) Obsrviq.setMetadata(metadata);\n    // eslint-disable-next-line react-hooks/exhaustive-deps\n  }, [userId, metaKey]);\n\n  return createElement(ObsrviqContext.Provider, { value: client }, children);\n}\n\n/** Access the Obsrviq client (identify / setMetadata / track / reset / setConsent). */\nexport function useObsrviq(): ObsrviqClient {\n  const ctx = useContext(ObsrviqContext);\n  if (!ctx) throw new Error('useObsrviq() must be used within a <ObsrviqProvider>.');\n  return ctx;\n}\n"],"mappings":";AAAA;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OAEK;AACP,SAAS,eAAe;AA4BxB,IAAM,SAAwB;AAC9B,IAAM,iBAAiB,cAAoC,IAAI;AAoBxD,SAAS,gBAAgB,EAAE,UAAU,QAAQ,UAAU,GAAG,OAAO,GAAyB;AAE/F,YAAU,MAAM;AACd,YAAQ,KAAK,MAA2B;AACxC,QAAI,UAAU,KAAM,SAAQ,SAAS,QAAQ,QAAQ;AAAA,aAC5C,SAAU,SAAQ,YAAY,QAAQ;AAAA,EAEjD,GAAG,CAAC,CAAC;AAGL,QAAM,UAAU,WAAW,KAAK,UAAU,QAAQ,IAAI;AACtD,QAAM,UAAU,OAAO,KAAK;AAC5B,YAAU,MAAM;AACd,QAAI,CAAC,QAAQ,SAAS;AACpB,cAAQ,UAAU;AAClB;AAAA,IACF;AACA,QAAI,UAAU,KAAM,SAAQ,SAAS,QAAQ,QAAQ;AAAA,aAC5C,SAAU,SAAQ,YAAY,QAAQ;AAAA,EAEjD,GAAG,CAAC,QAAQ,OAAO,CAAC;AAEpB,SAAO,cAAc,eAAe,UAAU,EAAE,OAAO,OAAO,GAAG,QAAQ;AAC3E;AAGO,SAAS,aAA4B;AAC1C,QAAM,MAAM,WAAW,cAAc;AACrC,MAAI,CAAC,IAAK,OAAM,IAAI,MAAM,uDAAuD;AACjF,SAAO;AACT;","names":[]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@obsrviq/react",
-  "version": "0.3.2",
+  "version": "0.5.0",
   "license": "MIT",
   "publishConfig": {
     "access": "public"
@@ -24,8 +24,8 @@
     "react": "^18.0.0"
   },
   "dependencies": {
-    "@obsrviq/tracker": "0.5.0",
-    "@obsrviq/types": "0.4.1"
+    "@obsrviq/tracker": "0.7.0",
+    "@obsrviq/types": "0.6.0"
   },
   "devDependencies": {
     "@types/react": "^18.3.17",

package/src/index.ts

@@ -26,6 +26,10 @@ export interface ObsrviqClient {
   /** Close a named sub-event span opened by startTask(name). */
   endTask(name: string, props?: Record<string, unknown>): void;
   setConsent(granted: boolean): void;
+  /** Begin recording now — the trigger for `autoStart: false` (manual) mode. */
+  startRecording(): void;
+  /** Stop recording + flush; stays off until startRecording() is called again. */
+  stopRecording(): void;
   flush(): Promise<boolean>;
   stop(): void;
 }