@workleap/mixpanel 4.0.3 → 4.0.4

package/CHANGELOG.md

@@ -1,5 +1,14 @@
 # @workleap/mixpanel
 
+## 4.0.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.
+
+- Updated dependencies [[`97f3f76`](https://github.com/workleap/wl-telemetry/commit/97f3f76199231d43a56d78209e8193a781df490d)]:
+  - @workleap/logrocket@2.1.4
+
 ## 4.0.3
 
 ### Patch Changes

package/dist/react/MixpanelContext.d.ts

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

package/dist/react/MixpanelContext.js

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

package/dist/react/MixpanelContext.js.map

@@ -1 +1 @@
-{"version":3,"file":"react/MixpanelContext.js","sources":["webpack://@workleap/mixpanel/./src/react/MixpanelContext.tsx"],"sourcesContent":["import { createContext, type PropsWithChildren, useContext } from \"react\";\nimport type { MixpanelClient } from \"../js/MixpanelClient.ts\";\n\nexport const MixpanelContext = createContext<MixpanelClient | undefined>(undefined);\n\n/**\n * @see {@link https://workleap.github.io/wl-telemetry}\n */\nexport interface MixpanelProviderProps extends PropsWithChildren {\n    client: MixpanelClient;\n}\n\n/**\n * @see {@link https://workleap.github.io/wl-telemetry}\n */\nexport function MixpanelProvider(props: MixpanelProviderProps) {\n    const {\n        client,\n        children\n    } = props;\n\n    return (\n        <MixpanelContext.Provider value={client}>\n            {children}\n        </MixpanelContext.Provider>\n    );\n}\n\nexport interface UseMixpanelClientOptions {\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 useMixpanelClient(options?: { dontThrowOnUndefined?: false }): MixpanelClient;\nexport function useMixpanelClient(options: { dontThrowOnUndefined: true }): MixpanelClient | undefined;\n\n/**\n * Retrieve the Mixpanel client.\n * @see {@link https://workleap.github.io/wl-telemetry}\n */\nexport function useMixpanelClient(options: UseMixpanelClientOptions = {}) {\n    const {\n        dontThrowOnUndefined = false\n    } = options;\n\n    const client = useContext(MixpanelContext);\n\n    if (!client && !dontThrowOnUndefined) {\n        throw new Error(\"[mixpanel] The useMixpanelClient function is called before a MixpanelClient instance has been provided.\");\n    }\n\n    return client;\n}\n"],"names":["createContext","useContext","MixpanelContext","undefined","MixpanelProvider","props","client","children","useMixpanelClient","options","dontThrowOnUndefined","Error"],"mappings":";;;;;;;;;AAA0E;AAGnE,MAAME,gCAAkBF,aAAaA,CAA6BG,WAAW;AASpF;;CAEC,GACM,SAASC,iBAAiBC,KAA4B;IACzD,MAAM,EACFC,MAAM,EACNC,QAAQ,EACX,GAAGF;IAEJ,qBACI,IAACH,gBAAgB,QAAQ;QAAC,OAAOI;kBAC5BC;;AAGb;AAYA;;;CAGC,GACM,SAASC,kBAAkBC,UAAoC,CAAC,CAAC;IACpE,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/MixpanelContext.js","sources":["webpack://@workleap/mixpanel/./src/react/MixpanelContext.tsx"],"sourcesContent":["import { createContext, type PropsWithChildren, useContext } from \"react\";\nimport type { MixpanelClient } from \"../js/MixpanelClient.ts\";\n\nexport const MixpanelContext = createContext<MixpanelClient | undefined>(undefined);\n\n/**\n * @see {@link https://workleap.github.io/wl-telemetry}\n */\nexport interface MixpanelProviderProps extends PropsWithChildren {\n    client: MixpanelClient;\n}\n\n/**\n * @see {@link https://workleap.github.io/wl-telemetry}\n */\nexport function MixpanelProvider(props: MixpanelProviderProps) {\n    const {\n        client,\n        children\n    } = props;\n\n    return (\n        <MixpanelContext.Provider value={client}>\n            {children}\n        </MixpanelContext.Provider>\n    );\n}\n\nexport interface UseMixpanelClientOptions {\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 useMixpanelClient(options?: { throwOnUndefined?: true }): MixpanelClient;\nexport function useMixpanelClient(options: { throwOnUndefined: false }): MixpanelClient | undefined;\n\n/**\n * Retrieve the Mixpanel client.\n * @see {@link https://workleap.github.io/wl-telemetry}\n */\nexport function useMixpanelClient(options: UseMixpanelClientOptions = {}) {\n    const {\n        throwOnUndefined = true\n    } = options;\n\n    const client = useContext(MixpanelContext);\n\n    if (!client && throwOnUndefined) {\n        throw new Error(\"[mixpanel] The useMixpanelClient function is called before a MixpanelClient instance has been provided.\");\n    }\n\n    return client;\n}\n"],"names":["createContext","useContext","MixpanelContext","undefined","MixpanelProvider","props","client","children","useMixpanelClient","options","throwOnUndefined","Error"],"mappings":";;;;;;;;;AAA0E;AAGnE,MAAME,gCAAkBF,aAAaA,CAA6BG,WAAW;AASpF;;CAEC,GACM,SAASC,iBAAiBC,KAA4B;IACzD,MAAM,EACFC,MAAM,EACNC,QAAQ,EACX,GAAGF;IAEJ,qBACI,IAACH,gBAAgB,QAAQ;QAAC,OAAOI;kBAC5BC;;AAGb;AAYA;;;CAGC,GACM,SAASC,kBAAkBC,UAAoC,CAAC,CAAC;IACpE,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/mixpanel",
   "author": "Workleap",
-  "version": "4.0.3",
+  "version": "4.0.4",
   "description": "A package containing utilities for Mixpanel telemetry.",
   "license": "Apache-2.0",
   "repository": {
@@ -35,7 +35,7 @@
   "peerDependencies": {
     "react": "^18.0.0 || ^19.0.0",
     "react-dom": "^18.0.0 || ^19.0.0",
-    "@workleap/logrocket": "2.1.3"
+    "@workleap/logrocket": "2.1.4"
   },
   "peerDependenciesMeta": {
     "@workleap/logrocket": {

package/src/react/MixpanelContext.tsx

@@ -30,11 +30,11 @@ export interface UseMixpanelClientOptions {
     /**
      * Whether or not an exception should be thrown if the client hasn't been provided.
      */
-    dontThrowOnUndefined?: boolean;
+    throwOnUndefined?: boolean;
 }
 
-export function useMixpanelClient(options?: { dontThrowOnUndefined?: false }): MixpanelClient;
-export function useMixpanelClient(options: { dontThrowOnUndefined: true }): MixpanelClient | undefined;
+export function useMixpanelClient(options?: { throwOnUndefined?: true }): MixpanelClient;
+export function useMixpanelClient(options: { throwOnUndefined: false }): MixpanelClient | undefined;
 
 /**
  * Retrieve the Mixpanel client.
@@ -42,12 +42,12 @@ export function useMixpanelClient(options: { dontThrowOnUndefined: true }): Mixp
  */
 export function useMixpanelClient(options: UseMixpanelClientOptions = {}) {
     const {
-        dontThrowOnUndefined = false
+        throwOnUndefined = true
     } = options;
 
     const client = useContext(MixpanelContext);
 
-    if (!client && !dontThrowOnUndefined) {
+    if (!client && throwOnUndefined) {
         throw new Error("[mixpanel] The useMixpanelClient function is called before a MixpanelClient instance has been provided.");
     }