@workleap/logrocket 2.1.3 → 2.1.5

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # @workleap/logrocket
 
+## 2.1.5
+
+### Patch Changes
+
+- [#117](https://github.com/workleap/wl-telemetry/pull/117) [`5bc65a7`](https://github.com/workleap/wl-telemetry/commit/5bc65a700b3b2066498456f470e1b914998c6bb8) Thanks [@patricklafrance](https://github.com/patricklafrance)! - Bumped dependency versions.
+
+- Updated dependencies [[`5bc65a7`](https://github.com/workleap/wl-telemetry/commit/5bc65a700b3b2066498456f470e1b914998c6bb8)]:
+  - @workleap-telemetry/core@1.0.4
+
+## 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/js/applyTransformers.js.map

@@ -1 +1 @@
-{"version":3,"file":"js/applyTransformers.js","sources":["webpack://@workleap/logrocket/./src/js/applyTransformers.ts"],"sourcesContent":["import type { RootLogger } from \"@workleap/logging\";\nimport type { LogRocketSdkOptions } from \"./logRocketTypes.ts\";\n\n/**\n * @see {@link https://workleap.github.io/wl-telemetry}\n */\nexport interface LogRocketSdkOptionsTransformerContext {\n    verbose: boolean;\n    logger: RootLogger;\n}\n\n/**\n * Hook to transform the resulting LogRocket SDK options.\n * @see {@link https://workleap.github.io/wl-telemetry}\n */\nexport type LogRocketSdkOptionsTransformer = (options: LogRocketSdkOptions, context: LogRocketSdkOptionsTransformerContext) => LogRocketSdkOptions;\n\n// The function return type is mandatory, otherwise we got an error TS4058.\nexport function applyTransformers(options: LogRocketSdkOptions, transformers: LogRocketSdkOptionsTransformer[], context: LogRocketSdkOptionsTransformerContext): LogRocketSdkOptions {\n    return transformers.reduce((acc, transformer) => transformer(acc, context), options);\n}\n\n\n"],"names":["applyTransformers","options","transformers","context","acc","transformer"],"mappings":";;AAiBA,2EAA2E;AACpE,SAASA,kBAAkBC,OAA4B,EAAEC,YAA8C,EAAEC,OAA8C;IAC1J,OAAOD,aAAa,MAAM,CAAC,CAACE,KAAKC,cAAgBA,YAAYD,KAAKD,UAAUF;AAChF"}
+{"version":3,"file":"js/applyTransformers.js","sources":["webpack://@workleap/logrocket/./src/js/applyTransformers.ts"],"sourcesContent":["import type { RootLogger } from \"@workleap/logging\";\nimport type { LogRocketSdkOptions } from \"./logRocketTypes.ts\";\n\n/**\n * @see {@link https://workleap.github.io/wl-telemetry}\n */\nexport interface LogRocketSdkOptionsTransformerContext {\n    verbose: boolean;\n    logger: RootLogger;\n}\n\n/**\n * Hook to transform the resulting LogRocket SDK options.\n * @see {@link https://workleap.github.io/wl-telemetry}\n */\nexport type LogRocketSdkOptionsTransformer = (options: LogRocketSdkOptions, context: LogRocketSdkOptionsTransformerContext) => LogRocketSdkOptions;\n\n// The function return type is mandatory, otherwise we got an error TS4058.\nexport function applyTransformers(options: LogRocketSdkOptions, transformers: LogRocketSdkOptionsTransformer[], context: LogRocketSdkOptionsTransformerContext): LogRocketSdkOptions {\n    return transformers.reduce((acc, transformer) => transformer(acc, context), options);\n}\n"],"names":["applyTransformers","options","transformers","context","acc","transformer"],"mappings":";;AAiBA,2EAA2E;AACpE,SAASA,kBAAkBC,OAA4B,EAAEC,YAA8C,EAAEC,OAA8C;IAC1J,OAAOD,aAAa,MAAM,CAAC,CAACE,KAAKC,cAAgBA,YAAYD,KAAKD,UAAUF;AAChF"}

package/dist/js/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"js/index.js","sources":["webpack://@workleap/logrocket/./src/js/index.ts"],"sourcesContent":["export { createTelemetryContext, type CreateTelemetryContextOptions, type TelemetryContext } from \"@workleap-telemetry/core\";\nexport type { LogRocketSdkOptionsTransformer } from \"./applyTransformers.ts\";\nexport type { GetLogRocketSessionUrlListener, LogRocketInstrumentationClient, LogRocketWorkleapPlatformIdentification, LogRocketWorkleapPlatformUserTraits } from \"./LogRocketInstrumentationClient.ts\";\nexport { LogRocketLogger, LogRocketLoggerScope } from \"./LogRocketLogger.ts\";\nexport type * from \"./logRocketTypes.ts\";\nexport { NoopLogRocketInstrumentationClient } from \"./NoopLogRocketInstrumentationClient.ts\";\nexport { registerLogRocketInstrumentation, type RegisterLogRocketInstrumentationOptions } from \"./registerLogRocketInstrumentation.ts\";\n\n\n"],"names":["createTelemetryContext","LogRocketLogger","LogRocketLoggerScope","NoopLogRocketInstrumentationClient","registerLogRocketInstrumentation"],"mappings":";;;;;;;;;;;;;;AAA6H;AAGhD;AAEgB;AAC0C"}
+{"version":3,"file":"js/index.js","sources":["webpack://@workleap/logrocket/./src/js/index.ts"],"sourcesContent":["export { createTelemetryContext, type CreateTelemetryContextOptions, type TelemetryContext } from \"@workleap-telemetry/core\";\nexport type { LogRocketSdkOptionsTransformer } from \"./applyTransformers.ts\";\nexport type { GetLogRocketSessionUrlListener, LogRocketInstrumentationClient, LogRocketWorkleapPlatformIdentification, LogRocketWorkleapPlatformUserTraits } from \"./LogRocketInstrumentationClient.ts\";\nexport { LogRocketLogger, LogRocketLoggerScope } from \"./LogRocketLogger.ts\";\nexport type * from \"./logRocketTypes.ts\";\nexport { NoopLogRocketInstrumentationClient } from \"./NoopLogRocketInstrumentationClient.ts\";\nexport { registerLogRocketInstrumentation, type RegisterLogRocketInstrumentationOptions } from \"./registerLogRocketInstrumentation.ts\";\n\n"],"names":["createTelemetryContext","LogRocketLogger","LogRocketLoggerScope","NoopLogRocketInstrumentationClient","registerLogRocketInstrumentation"],"mappings":";;;;;;;;;;;;;;AAA6H;AAGhD;AAEgB;AAC0C"}

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.5",
   "description": "A package containing utilities for LogRocket.",
   "license": "Apache-2.0",
   "repository": {
@@ -29,8 +29,7 @@
   "files": [
     "src",
     "dist",
-    "CHANGELOG.md",
-    "README.md"
+    "CHANGELOG.md"
   ],
   "peerDependencies": {
     "logrocket": "^10.1.0",
@@ -46,21 +45,24 @@
     }
   },
   "dependencies": {
-    "@workleap/logging": "^1.3.0",
+    "@workleap/logging": "^1.3.1",
     "logrocket-fuzzy-search-sanitizer": "0.0.2",
-    "@workleap-telemetry/core": "1.0.3"
+    "@workleap-telemetry/core": "1.0.4"
   },
   "devDependencies": {
-    "@rsbuild/core": "1.5.13",
-    "@rslib/core": "0.15.0",
-    "@types/react": "19.2.0",
-    "@workleap/eslint-plugin": "3.5.0",
-    "@workleap/rslib-configs": "1.1.0",
-    "@workleap/typescript-configs": "3.0.4",
-    "eslint": "8.57.1",
-    "happy-dom": "19.0.2",
+    "@eslint/js": "9.38.0",
+    "@rsbuild/core": "1.5.17",
+    "@rslib/core": "0.16.1",
+    "@types/react": "19.2.2",
+    "@typescript-eslint/parser": "8.46.2",
+    "@workleap/eslint-configs": "1.0.1",
+    "@workleap/rslib-configs": "1.1.3",
+    "@workleap/typescript-configs": "3.0.7",
+    "eslint": "9.38.0",
+    "happy-dom": "20.0.10",
     "typescript": "5.9.3",
-    "vitest": "3.2.4"
+    "typescript-eslint": "8.46.2",
+    "vitest": "4.0.4"
   },
   "sideEffects": false,
   "scripts": {

package/src/js/applyTransformers.ts

@@ -19,5 +19,3 @@ export type LogRocketSdkOptionsTransformer = (options: LogRocketSdkOptions, cont
 export function applyTransformers(options: LogRocketSdkOptions, transformers: LogRocketSdkOptionsTransformer[], context: LogRocketSdkOptionsTransformerContext): LogRocketSdkOptions {
     return transformers.reduce((acc, transformer) => transformer(acc, context), options);
 }
-
-

package/src/js/index.ts

@@ -6,4 +6,3 @@ export type * from "./logRocketTypes.ts";
 export { NoopLogRocketInstrumentationClient } from "./NoopLogRocketInstrumentationClient.ts";
 export { registerLogRocketInstrumentation, type RegisterLogRocketInstrumentationOptions } from "./registerLogRocketInstrumentation.ts";
 
-

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.");
     }