@workleap/logrocket 2.1.3 → 2.1.4

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @workleap/logrocket
 
+## 2.1.4
+
+### Patch Changes
+
+- [#115](https://github.com/workleap/wl-telemetry/pull/115) [`97f3f76`](https://github.com/workleap/wl-telemetry/commit/97f3f76199231d43a56d78209e8193a781df490d) Thanks [@patricklafrance](https://github.com/patricklafrance)! - Renamed `dontThrowOnUndefined` to `throwOnUndefined` for the hooks to retrieve the telemetry clients.
+
 ## 2.1.3
 
 ### Patch Changes

package/dist/react/LogRocketInstrumentationContext.d.ts

@@ -14,11 +14,11 @@ export interface UseLogRocketInstrumentationClientOptions {
     /**
      * Whether or not an exception should be thrown if the client hasn't been provided.
      */
-    dontThrowOnUndefined?: boolean;
+    throwOnUndefined?: boolean;
 }
 export declare function useLogRocketInstrumentationClient(options?: {
-    dontThrowOnUndefined?: false;
+    throwOnUndefined?: true;
 }): LogRocketInstrumentationClient;
 export declare function useLogRocketInstrumentationClient(options: {
-    dontThrowOnUndefined: true;
+    throwOnUndefined: false;
 }): LogRocketInstrumentationClient | undefined;

package/dist/react/LogRocketInstrumentationContext.js

@@ -22,9 +22,9 @@ const LogRocketInstrumentationContext = /*#__PURE__*/ createContext(undefined);
  * Retrieve the LogRocket instrumentation client.
  * @see {@link https://workleap.github.io/wl-telemetry}
  */ function useLogRocketInstrumentationClient(options = {}) {
-    const { dontThrowOnUndefined = false } = options;
+    const { throwOnUndefined = true } = options;
     const client = useContext(LogRocketInstrumentationContext);
-    if (!client && !dontThrowOnUndefined) {
+    if (!client && throwOnUndefined) {
         throw new Error("[logrocket] The useLogRocketInstrumentationClient function is called before an LogRocketInstrumentationClient instance has been provided.");
     }
     return client;

package/dist/react/LogRocketInstrumentationContext.js.map

@@ -1 +1 @@
-{"version":3,"file":"react/LogRocketInstrumentationContext.js","sources":["webpack://@workleap/logrocket/./src/react/LogRocketInstrumentationContext.tsx"],"sourcesContent":["import { createContext, type PropsWithChildren, useContext } from \"react\";\nimport type { LogRocketInstrumentationClient } from \"../js/LogRocketInstrumentationClient.ts\";\n\nconst LogRocketInstrumentationContext = createContext<LogRocketInstrumentationClient | undefined>(undefined);\n\n/**\n * @see {@link https://workleap.github.io/wl-telemetry}\n */\nexport interface LogRocketInstrumentationProviderProps extends PropsWithChildren {\n    client: LogRocketInstrumentationClient;\n}\n\n/**\n * @see {@link https://workleap.github.io/wl-telemetry}\n */\nexport function LogRocketInstrumentationProvider(props: LogRocketInstrumentationProviderProps) {\n    const {\n        client,\n        children\n    } = props;\n\n    return (\n        <LogRocketInstrumentationContext.Provider value={client}>\n            {children}\n        </LogRocketInstrumentationContext.Provider>\n    );\n}\n\nexport interface UseLogRocketInstrumentationClientOptions {\n    /**\n     * Whether or not an exception should be thrown if the client hasn't been provided.\n     */\n    dontThrowOnUndefined?: boolean;\n}\n\nexport function useLogRocketInstrumentationClient(options?: { dontThrowOnUndefined?: false }): LogRocketInstrumentationClient;\nexport function useLogRocketInstrumentationClient(options: { dontThrowOnUndefined: true }): LogRocketInstrumentationClient | undefined;\n\n/**\n * Retrieve the LogRocket instrumentation client.\n * @see {@link https://workleap.github.io/wl-telemetry}\n */\nexport function useLogRocketInstrumentationClient(options: UseLogRocketInstrumentationClientOptions = {}) {\n    const {\n        dontThrowOnUndefined = false\n    } = options;\n\n    const client = useContext(LogRocketInstrumentationContext);\n\n    if (!client && !dontThrowOnUndefined) {\n        throw new Error(\"[logrocket] The useLogRocketInstrumentationClient function is called before an LogRocketInstrumentationClient instance has been provided.\");\n    }\n\n    return client;\n}\n"],"names":["createContext","useContext","LogRocketInstrumentationContext","undefined","LogRocketInstrumentationProvider","props","client","children","useLogRocketInstrumentationClient","options","dontThrowOnUndefined","Error"],"mappings":";;;;;;;;;AAA0E;AAG1E,MAAME,gDAAkCF,aAAaA,CAA6CG;AASlG;;CAEC,GACM,SAASC,iCAAiCC,KAA4C;IACzF,MAAM,EACFC,MAAM,EACNC,QAAQ,EACX,GAAGF;IAEJ,qBACI,IAACH,gCAAgC,QAAQ;QAAC,OAAOI;kBAC5CC;;AAGb;AAYA;;;CAGC,GACM,SAASC,kCAAkCC,UAAoD,CAAC,CAAC;IACpG,MAAM,EACFC,uBAAuB,KAAK,EAC/B,GAAGD;IAEJ,MAAMH,SAASL,UAAUA,CAACC;IAE1B,IAAI,CAACI,UAAU,CAACI,sBAAsB;QAClC,MAAM,IAAIC,MAAM;IACpB;IAEA,OAAOL;AACX"}
+{"version":3,"file":"react/LogRocketInstrumentationContext.js","sources":["webpack://@workleap/logrocket/./src/react/LogRocketInstrumentationContext.tsx"],"sourcesContent":["import { createContext, type PropsWithChildren, useContext } from \"react\";\nimport type { LogRocketInstrumentationClient } from \"../js/LogRocketInstrumentationClient.ts\";\n\nconst LogRocketInstrumentationContext = createContext<LogRocketInstrumentationClient | undefined>(undefined);\n\n/**\n * @see {@link https://workleap.github.io/wl-telemetry}\n */\nexport interface LogRocketInstrumentationProviderProps extends PropsWithChildren {\n    client: LogRocketInstrumentationClient;\n}\n\n/**\n * @see {@link https://workleap.github.io/wl-telemetry}\n */\nexport function LogRocketInstrumentationProvider(props: LogRocketInstrumentationProviderProps) {\n    const {\n        client,\n        children\n    } = props;\n\n    return (\n        <LogRocketInstrumentationContext.Provider value={client}>\n            {children}\n        </LogRocketInstrumentationContext.Provider>\n    );\n}\n\nexport interface UseLogRocketInstrumentationClientOptions {\n    /**\n     * Whether or not an exception should be thrown if the client hasn't been provided.\n     */\n    throwOnUndefined?: boolean;\n}\n\nexport function useLogRocketInstrumentationClient(options?: { throwOnUndefined?: true }): LogRocketInstrumentationClient;\nexport function useLogRocketInstrumentationClient(options: { throwOnUndefined: false }): LogRocketInstrumentationClient | undefined;\n\n/**\n * Retrieve the LogRocket instrumentation client.\n * @see {@link https://workleap.github.io/wl-telemetry}\n */\nexport function useLogRocketInstrumentationClient(options: UseLogRocketInstrumentationClientOptions = {}) {\n    const {\n        throwOnUndefined = true\n    } = options;\n\n    const client = useContext(LogRocketInstrumentationContext);\n\n    if (!client && throwOnUndefined) {\n        throw new Error(\"[logrocket] The useLogRocketInstrumentationClient function is called before an LogRocketInstrumentationClient instance has been provided.\");\n    }\n\n    return client;\n}\n"],"names":["createContext","useContext","LogRocketInstrumentationContext","undefined","LogRocketInstrumentationProvider","props","client","children","useLogRocketInstrumentationClient","options","throwOnUndefined","Error"],"mappings":";;;;;;;;;AAA0E;AAG1E,MAAME,gDAAkCF,aAAaA,CAA6CG;AASlG;;CAEC,GACM,SAASC,iCAAiCC,KAA4C;IACzF,MAAM,EACFC,MAAM,EACNC,QAAQ,EACX,GAAGF;IAEJ,qBACI,IAACH,gCAAgC,QAAQ;QAAC,OAAOI;kBAC5CC;;AAGb;AAYA;;;CAGC,GACM,SAASC,kCAAkCC,UAAoD,CAAC,CAAC;IACpG,MAAM,EACFC,mBAAmB,IAAI,EAC1B,GAAGD;IAEJ,MAAMH,SAASL,UAAUA,CAACC;IAE1B,IAAI,CAACI,UAAUI,kBAAkB;QAC7B,MAAM,IAAIC,MAAM;IACpB;IAEA,OAAOL;AACX"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@workleap/logrocket",
   "author": "Workleap",
-  "version": "2.1.3",
+  "version": "2.1.4",
   "description": "A package containing utilities for LogRocket.",
   "license": "Apache-2.0",
   "repository": {

package/src/react/LogRocketInstrumentationContext.tsx

@@ -30,11 +30,11 @@ export interface UseLogRocketInstrumentationClientOptions {
     /**
      * Whether or not an exception should be thrown if the client hasn't been provided.
      */
-    dontThrowOnUndefined?: boolean;
+    throwOnUndefined?: boolean;
 }
 
-export function useLogRocketInstrumentationClient(options?: { dontThrowOnUndefined?: false }): LogRocketInstrumentationClient;
-export function useLogRocketInstrumentationClient(options: { dontThrowOnUndefined: true }): LogRocketInstrumentationClient | undefined;
+export function useLogRocketInstrumentationClient(options?: { throwOnUndefined?: true }): LogRocketInstrumentationClient;
+export function useLogRocketInstrumentationClient(options: { throwOnUndefined: false }): LogRocketInstrumentationClient | undefined;
 
 /**
  * Retrieve the LogRocket instrumentation client.
@@ -42,12 +42,12 @@ export function useLogRocketInstrumentationClient(options: { dontThrowOnUndefine
  */
 export function useLogRocketInstrumentationClient(options: UseLogRocketInstrumentationClientOptions = {}) {
     const {
-        dontThrowOnUndefined = false
+        throwOnUndefined = true
     } = options;
 
     const client = useContext(LogRocketInstrumentationContext);
 
-    if (!client && !dontThrowOnUndefined) {
+    if (!client && throwOnUndefined) {
         throw new Error("[logrocket] The useLogRocketInstrumentationClient function is called before an LogRocketInstrumentationClient instance has been provided.");
     }