posthog-js 1.48.2 → 1.50.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (33) hide show
  1. package/CHANGELOG.md +8 -0
  2. package/dist/array.full.js +1 -1
  3. package/dist/array.full.js.map +1 -1
  4. package/dist/array.js +1 -1
  5. package/dist/array.js.map +1 -1
  6. package/dist/es.js +1 -1
  7. package/dist/es.js.map +1 -1
  8. package/dist/module.d.ts +3 -2
  9. package/dist/module.js +1 -1
  10. package/dist/module.js.map +1 -1
  11. package/lib/package.json +3 -2
  12. package/package.json +3 -2
  13. package/react/dist/esm/index.js +80 -81
  14. package/react/dist/types/context/PostHogContext.d.ts +6 -4
  15. package/react/dist/types/context/PostHogContext.d.ts.map +1 -1
  16. package/react/dist/types/context/PostHogProvider.d.ts +8 -19
  17. package/react/dist/types/context/PostHogProvider.d.ts.map +1 -1
  18. package/react/dist/types/hooks/index.d.ts +5 -1
  19. package/react/dist/types/hooks/index.d.ts.map +1 -1
  20. package/react/dist/types/hooks/useActiveFeatureFlags.d.ts +2 -0
  21. package/react/dist/types/hooks/useActiveFeatureFlags.d.ts.map +1 -0
  22. package/react/dist/types/hooks/useFeatureFlagEnabled.d.ts +2 -0
  23. package/react/dist/types/hooks/useFeatureFlagEnabled.d.ts.map +1 -0
  24. package/react/dist/types/hooks/useFeatureFlagPayload.d.ts +3 -0
  25. package/react/dist/types/hooks/useFeatureFlagPayload.d.ts.map +1 -0
  26. package/react/dist/types/hooks/useFeatureFlagVariantKey.d.ts +2 -0
  27. package/react/dist/types/hooks/useFeatureFlagVariantKey.d.ts.map +1 -0
  28. package/react/dist/types/hooks/usePostHog.d.ts +3 -0
  29. package/react/dist/types/hooks/usePostHog.d.ts.map +1 -0
  30. package/react/dist/umd/index.js +108 -87
  31. package/react/package.json +2 -2
  32. package/react/dist/types/hooks/useFeatureFlags.d.ts +0 -6
  33. package/react/dist/types/hooks/useFeatureFlags.d.ts.map +0 -1
package/lib/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "posthog-js",
3
- "version": "1.48.2",
3
+ "version": "1.50.0",
4
4
  "description": "Posthog-js allows you to automatically capture usage and send events to PostHog.",
5
5
  "repository": "https://github.com/PostHog/posthog-js",
6
6
  "author": "hey@posthog.com",
@@ -35,7 +35,8 @@
35
35
  "files": [
36
36
  "lib/*",
37
37
  "dist/*",
38
- "react/dist/*"
38
+ "react/dist/*",
39
+ "react/package.json"
39
40
  ],
40
41
  "dependencies": {
41
42
  "fflate": "^0.4.1",
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "posthog-js",
3
- "version": "1.48.2",
3
+ "version": "1.50.0",
4
4
  "description": "Posthog-js allows you to automatically capture usage and send events to PostHog.",
5
5
  "repository": "https://github.com/PostHog/posthog-js",
6
6
  "author": "hey@posthog.com",
@@ -35,7 +35,8 @@
35
35
  "files": [
36
36
  "lib/*",
37
37
  "dist/*",
38
- "react/dist/*"
38
+ "react/dist/*",
39
+ "react/package.json"
39
40
  ],
40
41
  "dependencies": {
41
42
  "fflate": "^0.4.1",
@@ -1,94 +1,93 @@
1
- import React, { useContext, useState, useCallback, useEffect } from 'react';
1
+ import * as React from 'react';
2
+ import { createContext, useState, useEffect, useContext } from 'react';
3
+ import posthogJs from 'posthog-js';
2
4
 
3
- var cache = new Map();
4
- function getPostHogContext() {
5
- var context = cache.get(React.createContext);
6
- if (!context) {
7
- context = React.createContext({});
8
- cache.set(React.createContext, context);
9
- }
10
- return context;
11
- }
12
- function usePostHogContext() {
13
- var context = useContext(getPostHogContext());
14
- if (!context.client) {
15
- throw new Error('No PostHog client instance can be found. ' +
16
- 'Please ensure that your application is wrapped by `PostHogProvider`.');
17
- }
18
- return context;
19
- }
5
+ var PostHogContext = createContext({ client: undefined });
20
6
 
21
- /*! *****************************************************************************
22
- Copyright (c) Microsoft Corporation.
23
-
24
- Permission to use, copy, modify, and/or distribute this software for any
25
- purpose with or without fee is hereby granted.
26
-
27
- THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
28
- REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
29
- AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
30
- INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
31
- LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
32
- OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
33
- PERFORMANCE OF THIS SOFTWARE.
34
- ***************************************************************************** */
35
-
36
- var __assign = function() {
37
- __assign = Object.assign || function __assign(t) {
38
- for (var s, i = 1, n = arguments.length; i < n; i++) {
39
- s = arguments[i];
40
- for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p)) t[p] = s[p];
7
+ function PostHogProvider(_a) {
8
+ var children = _a.children, client = _a.client, apiKey = _a.apiKey, options = _a.options;
9
+ var _b = useState(client), posthog = _b[0], setPosthog = _b[1];
10
+ useEffect(function () {
11
+ if (client && apiKey) {
12
+ console.warn('You have provided both a client and an apiKey to PostHogProvider. The apiKey will be ignored in favour of the client.');
41
13
  }
42
- return t;
43
- };
44
- return __assign.apply(this, arguments);
45
- };
46
-
47
- var PostHogProvider = function (_a) {
48
- var client = _a.client, children = _a.children;
49
- var PostHogContext = getPostHogContext();
50
- var _b = useState({ enabled: {} }), featureFlags = _b[0], setFeatureFlags = _b[1];
51
- return (React.createElement(PostHogContext.Consumer, null, function (context) {
52
- if (client && context.client !== client) {
53
- context = Object.assign({}, context, { client: client });
14
+ if (client && options) {
15
+ console.warn('You have provided both a client and options to PostHogProvider. The options will be ignored in favour of the client.');
16
+ }
17
+ if (posthog) {
18
+ console.warn('This provider has already been initialized. You should only initialize it once at the root of your app.');
19
+ return;
54
20
  }
55
- if (!context.client) {
56
- throw new Error('PostHogProvider was not passed a client instance. ' +
57
- 'Make sure you pass in your PostHog client via the "client" prop.');
21
+ if (client) {
22
+ setPosthog(client);
58
23
  }
59
- var value = __assign(__assign({}, context), { featureFlags: featureFlags, setFeatureFlags: setFeatureFlags });
60
- return React.createElement(PostHogContext.Provider, { value: value }, children);
61
- }));
24
+ else if (apiKey) {
25
+ posthogJs.init(apiKey, options);
26
+ setPosthog(posthogJs);
27
+ }
28
+ }, [client, apiKey, options]);
29
+ return React.createElement(PostHogContext.Provider, { value: { client: posthog } }, children);
30
+ }
31
+
32
+ var usePostHog = function () {
33
+ var client = useContext(PostHogContext).client;
34
+ return client;
62
35
  };
63
36
 
64
- function useFeatureFlags(props) {
65
- if (props === void 0) { props = {}; }
66
- var _a = props.refreshInterval, refreshInterval = _a === void 0 ? 0 : _a, _b = props.sendEvent, sendEvent = _b === void 0 ? true : _b;
67
- var _c = usePostHogContext(), posthog = _c.client, featureFlags = _c.featureFlags, setFeatureFlags = _c.setFeatureFlags;
68
- var getEnabledFlags = useCallback(function (flags) {
69
- var enabled = flags.reduce(function (result, flag) {
70
- var flagValue = posthog === null || posthog === void 0 ? void 0 : posthog.getFeatureFlag(flag, {
71
- send_event: sendEvent,
72
- });
73
- if (typeof flagValue !== 'undefined') {
74
- result[flag] = flagValue;
75
- }
76
- return result;
77
- }, {});
78
- setFeatureFlags({ active: flags, enabled: enabled });
79
- }, [posthog, sendEvent, setFeatureFlags]);
37
+ function useFeatureFlagEnabled(flag) {
38
+ var client = usePostHog();
39
+ var _a = useState(), featureEnabled = _a[0], setFeatureEnabled = _a[1];
80
40
  useEffect(function () {
81
- if (posthog && refreshInterval > 0) {
82
- var interval_1 = setInterval(function () {
83
- posthog === null || posthog === void 0 ? void 0 : posthog.featureFlags.reloadFeatureFlags();
84
- }, refreshInterval * 1000);
85
- return function () { return clearInterval(interval_1); };
41
+ if (!client) {
42
+ return;
86
43
  }
87
- }, [posthog, refreshInterval, getEnabledFlags]);
44
+ return client.onFeatureFlags(function () {
45
+ setFeatureEnabled(client.isFeatureEnabled(flag));
46
+ });
47
+ }, [client, flag]);
48
+ return featureEnabled;
49
+ }
50
+
51
+ function useFeatureFlagPayload(flag) {
52
+ var client = usePostHog();
53
+ var _a = useState(), featureFlagPayload = _a[0], setFeatureFlagPayload = _a[1];
88
54
  useEffect(function () {
89
- posthog === null || posthog === void 0 ? void 0 : posthog.onFeatureFlags(getEnabledFlags);
90
- }, [posthog, getEnabledFlags]);
55
+ if (!client) {
56
+ return;
57
+ }
58
+ return client.onFeatureFlags(function () {
59
+ setFeatureFlagPayload(client.getFeatureFlagPayload(flag));
60
+ });
61
+ }, [client, flag]);
62
+ return featureFlagPayload;
63
+ }
64
+
65
+ function useActiveFeatureFlags(flag) {
66
+ var client = usePostHog();
67
+ var _a = useState(), featureFlags = _a[0], setFeatureFlags = _a[1];
68
+ useEffect(function () {
69
+ if (!client) {
70
+ return;
71
+ }
72
+ return client.onFeatureFlags(function (flags) {
73
+ setFeatureFlags(flags);
74
+ });
75
+ }, [client, flag]);
91
76
  return featureFlags;
92
77
  }
93
78
 
94
- export { PostHogProvider, getPostHogContext, useFeatureFlags, usePostHogContext };
79
+ function useFeatureFlagVariantKey(flag) {
80
+ var client = usePostHog();
81
+ var _a = useState(), featureFlagVariantKey = _a[0], setFeatureFlagVariantKey = _a[1];
82
+ useEffect(function () {
83
+ if (!client) {
84
+ return;
85
+ }
86
+ return client.onFeatureFlags(function () {
87
+ setFeatureFlagVariantKey(client.getFeatureFlag(flag));
88
+ });
89
+ }, [client, flag]);
90
+ return featureFlagVariantKey;
91
+ }
92
+
93
+ export { PostHogContext, PostHogProvider, useActiveFeatureFlags, useFeatureFlagEnabled, useFeatureFlagPayload, useFeatureFlagVariantKey, usePostHog };
@@ -1,5 +1,7 @@
1
- import React from 'react';
2
- import { PostHogProviderValue } from './PostHogProvider';
3
- export declare function getPostHogContext(): React.Context<any>;
4
- export declare function usePostHogContext(): PostHogProviderValue;
1
+ /// <reference types="react" />
2
+ import posthogJs from 'posthog-js';
3
+ export declare type PostHog = typeof posthogJs;
4
+ export declare const PostHogContext: import("react").Context<{
5
+ client?: import("posthog-js").PostHog | undefined;
6
+ }>;
5
7
  //# sourceMappingURL=PostHogContext.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"PostHogContext.d.ts","sourceRoot":"","sources":["../../../src/context/PostHogContext.ts"],"names":[],"mappings":"AAAA,OAAO,KAAqB,MAAM,OAAO,CAAA;AACzC,OAAO,EAAE,oBAAoB,EAAE,MAAM,mBAAmB,CAAA;AAUxD,wBAAgB,iBAAiB,IAAI,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAOtD;AAMD,wBAAgB,iBAAiB,IAAI,oBAAoB,CASxD"}
1
+ {"version":3,"file":"PostHogContext.d.ts","sourceRoot":"","sources":["../../../src/context/PostHogContext.ts"],"names":[],"mappings":";AAAA,OAAO,SAAS,MAAM,YAAY,CAAA;AAGlC,oBAAY,OAAO,GAAG,OAAO,SAAS,CAAA;AAEtC,eAAO,MAAM,cAAc;;EAA6D,CAAA"}
@@ -1,20 +1,9 @@
1
- import React, { Dispatch, SetStateAction } from 'react';
2
- import { PostHog } from 'posthog-js';
3
- export interface FeatureFlags {
4
- active?: string[];
5
- enabled: {
6
- [flag: string]: boolean | string;
7
- };
8
- }
9
- interface PostHogProviderProps {
10
- client: PostHog;
11
- children: React.ReactNode | React.ReactNode[] | null;
12
- }
13
- export interface PostHogProviderValue {
14
- client?: PostHog;
15
- featureFlags: FeatureFlags;
16
- setFeatureFlags: Dispatch<SetStateAction<FeatureFlags>>;
17
- }
18
- export declare const PostHogProvider: React.FC<PostHogProviderProps>;
19
- export {};
1
+ import * as React from 'react';
2
+ import { PostHog } from './PostHogContext';
3
+ export declare function PostHogProvider({ children, client, apiKey, options, }: {
4
+ children?: React.ReactNode;
5
+ client?: PostHog | undefined;
6
+ apiKey?: string | undefined;
7
+ options?: any | undefined;
8
+ }): JSX.Element;
20
9
  //# sourceMappingURL=PostHogProvider.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"PostHogProvider.d.ts","sourceRoot":"","sources":["../../../src/context/PostHogProvider.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,EAAY,QAAQ,EAAE,cAAc,EAAE,MAAM,OAAO,CAAA;AACjE,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAA;AAQpC,MAAM,WAAW,YAAY;IACzB,MAAM,CAAC,EAAE,MAAM,EAAE,CAAA;IACjB,OAAO,EAAE;QACL,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,GAAG,MAAM,CAAA;KACnC,CAAA;CACJ;AAOD,UAAU,oBAAoB;IAC1B,MAAM,EAAE,OAAO,CAAA;IACf,QAAQ,EAAE,KAAK,CAAC,SAAS,GAAG,KAAK,CAAC,SAAS,EAAE,GAAG,IAAI,CAAA;CACvD;AAQD,MAAM,WAAW,oBAAoB;IACjC,MAAM,CAAC,EAAE,OAAO,CAAA;IAChB,YAAY,EAAE,YAAY,CAAA;IAC1B,eAAe,EAAE,QAAQ,CAAC,cAAc,CAAC,YAAY,CAAC,CAAC,CAAA;CAC1D;AAQD,eAAO,MAAM,eAAe,EAAE,KAAK,CAAC,EAAE,CAAC,oBAAoB,CAuB1D,CAAA"}
1
+ {"version":3,"file":"PostHogProvider.d.ts","sourceRoot":"","sources":["../../../src/context/PostHogProvider.tsx"],"names":[],"mappings":"AAEA,OAAO,KAAK,KAAK,MAAM,OAAO,CAAA;AAG9B,OAAO,EAAE,OAAO,EAAkB,MAAM,kBAAkB,CAAA;AAE1D,wBAAgB,eAAe,CAAC,EAC5B,QAAQ,EACR,MAAM,EACN,MAAM,EACN,OAAO,GACV,EAAE;IACC,QAAQ,CAAC,EAAE,KAAK,CAAC,SAAS,CAAA;IAC1B,MAAM,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;IAC5B,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAC3B,OAAO,CAAC,EAAE,GAAG,GAAG,SAAS,CAAA;CAC5B,eAgCA"}
@@ -1,2 +1,6 @@
1
- export * from './useFeatureFlags';
1
+ export * from './useFeatureFlagEnabled';
2
+ export * from './useFeatureFlagPayload';
3
+ export * from './useActiveFeatureFlags';
4
+ export * from './useFeatureFlagVariantKey';
5
+ export * from './usePostHog';
2
6
  //# sourceMappingURL=index.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/hooks/index.ts"],"names":[],"mappings":"AAAA,cAAc,mBAAmB,CAAA"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/hooks/index.ts"],"names":[],"mappings":"AAAA,cAAc,yBAAyB,CAAA;AACvC,cAAc,yBAAyB,CAAA;AACvC,cAAc,yBAAyB,CAAA;AACvC,cAAc,4BAA4B,CAAA;AAC1C,cAAc,cAAc,CAAA"}
@@ -0,0 +1,2 @@
1
+ export declare function useActiveFeatureFlags(flag: string): string[] | undefined;
2
+ //# sourceMappingURL=useActiveFeatureFlags.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"useActiveFeatureFlags.d.ts","sourceRoot":"","sources":["../../../src/hooks/useActiveFeatureFlags.ts"],"names":[],"mappings":"AAGA,wBAAgB,qBAAqB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,SAAS,CAiBxE"}
@@ -0,0 +1,2 @@
1
+ export declare function useFeatureFlagEnabled(flag: string): boolean | undefined;
2
+ //# sourceMappingURL=useFeatureFlagEnabled.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"useFeatureFlagEnabled.d.ts","sourceRoot":"","sources":["../../../src/hooks/useFeatureFlagEnabled.ts"],"names":[],"mappings":"AAGA,wBAAgB,qBAAqB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,GAAG,SAAS,CAiBvE"}
@@ -0,0 +1,3 @@
1
+ import { JsonType } from 'posthog-js';
2
+ export declare function useFeatureFlagPayload(flag: string): JsonType | undefined;
3
+ //# sourceMappingURL=useFeatureFlagPayload.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"useFeatureFlagPayload.d.ts","sourceRoot":"","sources":["../../../src/hooks/useFeatureFlagPayload.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAA;AAGrC,wBAAgB,qBAAqB,CAAC,IAAI,EAAE,MAAM,GAAG,QAAQ,GAAG,SAAS,CAiBxE"}
@@ -0,0 +1,2 @@
1
+ export declare function useFeatureFlagVariantKey(flag: string): string | boolean | undefined;
2
+ //# sourceMappingURL=useFeatureFlagVariantKey.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"useFeatureFlagVariantKey.d.ts","sourceRoot":"","sources":["../../../src/hooks/useFeatureFlagVariantKey.ts"],"names":[],"mappings":"AAGA,wBAAgB,wBAAwB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,SAAS,CAiBnF"}
@@ -0,0 +1,3 @@
1
+ import { PostHog } from '../context';
2
+ export declare const usePostHog: () => PostHog | undefined;
3
+ //# sourceMappingURL=usePostHog.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"usePostHog.d.ts","sourceRoot":"","sources":["../../../src/hooks/usePostHog.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,OAAO,EAAkB,MAAM,YAAY,CAAA;AAEpD,eAAO,MAAM,UAAU,QAAO,OAAO,GAAG,SAGvC,CAAA"}
@@ -1,107 +1,128 @@
1
1
  (function (global, factory) {
2
- typeof exports === 'object' && typeof module !== 'undefined' ? factory(exports, require('react')) :
3
- typeof define === 'function' && define.amd ? define(['exports', 'react'], factory) :
4
- (global = typeof globalThis !== 'undefined' ? globalThis : global || self, factory(global.PosthogReact = {}, global.React));
5
- }(this, (function (exports, React) { 'use strict';
2
+ typeof exports === 'object' && typeof module !== 'undefined' ? factory(exports, require('react'), require('posthog-js')) :
3
+ typeof define === 'function' && define.amd ? define(['exports', 'react', 'posthog-js'], factory) :
4
+ (global = typeof globalThis !== 'undefined' ? globalThis : global || self, factory(global.PosthogReact = {}, global.React, global.posthogJs));
5
+ }(this, (function (exports, React, posthogJs) { 'use strict';
6
6
 
7
7
  function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
8
8
 
9
- var React__default = /*#__PURE__*/_interopDefaultLegacy(React);
10
-
11
- var cache = new Map();
12
- function getPostHogContext() {
13
- var context = cache.get(React__default['default'].createContext);
14
- if (!context) {
15
- context = React__default['default'].createContext({});
16
- cache.set(React__default['default'].createContext, context);
17
- }
18
- return context;
19
- }
20
- function usePostHogContext() {
21
- var context = React.useContext(getPostHogContext());
22
- if (!context.client) {
23
- throw new Error('No PostHog client instance can be found. ' +
24
- 'Please ensure that your application is wrapped by `PostHogProvider`.');
25
- }
26
- return context;
9
+ function _interopNamespace(e) {
10
+ if (e && e.__esModule) return e;
11
+ var n = Object.create(null);
12
+ if (e) {
13
+ Object.keys(e).forEach(function (k) {
14
+ if (k !== 'default') {
15
+ var d = Object.getOwnPropertyDescriptor(e, k);
16
+ Object.defineProperty(n, k, d.get ? d : {
17
+ enumerable: true,
18
+ get: function () {
19
+ return e[k];
20
+ }
21
+ });
22
+ }
23
+ });
24
+ }
25
+ n['default'] = e;
26
+ return Object.freeze(n);
27
27
  }
28
28
 
29
- /*! *****************************************************************************
30
- Copyright (c) Microsoft Corporation.
31
-
32
- Permission to use, copy, modify, and/or distribute this software for any
33
- purpose with or without fee is hereby granted.
34
-
35
- THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
36
- REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
37
- AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
38
- INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
39
- LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
40
- OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
41
- PERFORMANCE OF THIS SOFTWARE.
42
- ***************************************************************************** */
43
-
44
- var __assign = function() {
45
- __assign = Object.assign || function __assign(t) {
46
- for (var s, i = 1, n = arguments.length; i < n; i++) {
47
- s = arguments[i];
48
- for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p)) t[p] = s[p];
49
- }
50
- return t;
51
- };
52
- return __assign.apply(this, arguments);
53
- };
29
+ var React__namespace = /*#__PURE__*/_interopNamespace(React);
30
+ var posthogJs__default = /*#__PURE__*/_interopDefaultLegacy(posthogJs);
54
31
 
55
- var PostHogProvider = function (_a) {
56
- var client = _a.client, children = _a.children;
57
- var PostHogContext = getPostHogContext();
58
- var _b = React.useState({ enabled: {} }), featureFlags = _b[0], setFeatureFlags = _b[1];
59
- return (React__default['default'].createElement(PostHogContext.Consumer, null, function (context) {
60
- if (client && context.client !== client) {
61
- context = Object.assign({}, context, { client: client });
32
+ var PostHogContext = React.createContext({ client: undefined });
33
+
34
+ function PostHogProvider(_a) {
35
+ var children = _a.children, client = _a.client, apiKey = _a.apiKey, options = _a.options;
36
+ var _b = React.useState(client), posthog = _b[0], setPosthog = _b[1];
37
+ React.useEffect(function () {
38
+ if (client && apiKey) {
39
+ console.warn('You have provided both a client and an apiKey to PostHogProvider. The apiKey will be ignored in favour of the client.');
40
+ }
41
+ if (client && options) {
42
+ console.warn('You have provided both a client and options to PostHogProvider. The options will be ignored in favour of the client.');
62
43
  }
63
- if (!context.client) {
64
- throw new Error('PostHogProvider was not passed a client instance. ' +
65
- 'Make sure you pass in your PostHog client via the "client" prop.');
44
+ if (posthog) {
45
+ console.warn('This provider has already been initialized. You should only initialize it once at the root of your app.');
46
+ return;
66
47
  }
67
- var value = __assign(__assign({}, context), { featureFlags: featureFlags, setFeatureFlags: setFeatureFlags });
68
- return React__default['default'].createElement(PostHogContext.Provider, { value: value }, children);
69
- }));
48
+ if (client) {
49
+ setPosthog(client);
50
+ }
51
+ else if (apiKey) {
52
+ posthogJs__default['default'].init(apiKey, options);
53
+ setPosthog(posthogJs__default['default']);
54
+ }
55
+ }, [client, apiKey, options]);
56
+ return React__namespace.createElement(PostHogContext.Provider, { value: { client: posthog } }, children);
57
+ }
58
+
59
+ var usePostHog = function () {
60
+ var client = React.useContext(PostHogContext).client;
61
+ return client;
70
62
  };
71
63
 
72
- function useFeatureFlags(props) {
73
- if (props === void 0) { props = {}; }
74
- var _a = props.refreshInterval, refreshInterval = _a === void 0 ? 0 : _a, _b = props.sendEvent, sendEvent = _b === void 0 ? true : _b;
75
- var _c = usePostHogContext(), posthog = _c.client, featureFlags = _c.featureFlags, setFeatureFlags = _c.setFeatureFlags;
76
- var getEnabledFlags = React.useCallback(function (flags) {
77
- var enabled = flags.reduce(function (result, flag) {
78
- var flagValue = posthog === null || posthog === void 0 ? void 0 : posthog.getFeatureFlag(flag, {
79
- send_event: sendEvent,
80
- });
81
- if (typeof flagValue !== 'undefined') {
82
- result[flag] = flagValue;
83
- }
84
- return result;
85
- }, {});
86
- setFeatureFlags({ active: flags, enabled: enabled });
87
- }, [posthog, sendEvent, setFeatureFlags]);
64
+ function useFeatureFlagEnabled(flag) {
65
+ var client = usePostHog();
66
+ var _a = React.useState(), featureEnabled = _a[0], setFeatureEnabled = _a[1];
88
67
  React.useEffect(function () {
89
- if (posthog && refreshInterval > 0) {
90
- var interval_1 = setInterval(function () {
91
- posthog === null || posthog === void 0 ? void 0 : posthog.featureFlags.reloadFeatureFlags();
92
- }, refreshInterval * 1000);
93
- return function () { return clearInterval(interval_1); };
68
+ if (!client) {
69
+ return;
94
70
  }
95
- }, [posthog, refreshInterval, getEnabledFlags]);
71
+ return client.onFeatureFlags(function () {
72
+ setFeatureEnabled(client.isFeatureEnabled(flag));
73
+ });
74
+ }, [client, flag]);
75
+ return featureEnabled;
76
+ }
77
+
78
+ function useFeatureFlagPayload(flag) {
79
+ var client = usePostHog();
80
+ var _a = React.useState(), featureFlagPayload = _a[0], setFeatureFlagPayload = _a[1];
81
+ React.useEffect(function () {
82
+ if (!client) {
83
+ return;
84
+ }
85
+ return client.onFeatureFlags(function () {
86
+ setFeatureFlagPayload(client.getFeatureFlagPayload(flag));
87
+ });
88
+ }, [client, flag]);
89
+ return featureFlagPayload;
90
+ }
91
+
92
+ function useActiveFeatureFlags(flag) {
93
+ var client = usePostHog();
94
+ var _a = React.useState(), featureFlags = _a[0], setFeatureFlags = _a[1];
96
95
  React.useEffect(function () {
97
- posthog === null || posthog === void 0 ? void 0 : posthog.onFeatureFlags(getEnabledFlags);
98
- }, [posthog, getEnabledFlags]);
96
+ if (!client) {
97
+ return;
98
+ }
99
+ return client.onFeatureFlags(function (flags) {
100
+ setFeatureFlags(flags);
101
+ });
102
+ }, [client, flag]);
99
103
  return featureFlags;
100
104
  }
101
105
 
106
+ function useFeatureFlagVariantKey(flag) {
107
+ var client = usePostHog();
108
+ var _a = React.useState(), featureFlagVariantKey = _a[0], setFeatureFlagVariantKey = _a[1];
109
+ React.useEffect(function () {
110
+ if (!client) {
111
+ return;
112
+ }
113
+ return client.onFeatureFlags(function () {
114
+ setFeatureFlagVariantKey(client.getFeatureFlag(flag));
115
+ });
116
+ }, [client, flag]);
117
+ return featureFlagVariantKey;
118
+ }
119
+
120
+ exports.PostHogContext = PostHogContext;
102
121
  exports.PostHogProvider = PostHogProvider;
103
- exports.getPostHogContext = getPostHogContext;
104
- exports.useFeatureFlags = useFeatureFlags;
105
- exports.usePostHogContext = usePostHogContext;
122
+ exports.useActiveFeatureFlags = useActiveFeatureFlags;
123
+ exports.useFeatureFlagEnabled = useFeatureFlagEnabled;
124
+ exports.useFeatureFlagPayload = useFeatureFlagPayload;
125
+ exports.useFeatureFlagVariantKey = useFeatureFlagVariantKey;
126
+ exports.usePostHog = usePostHog;
106
127
 
107
128
  })));
@@ -1,8 +1,8 @@
1
1
  {
2
2
  "name": "posthog-js-react",
3
- "version": "1.0.0-alpha.1",
3
+ "version": "1.0.0",
4
4
  "private": false,
5
- "description": "Provides components and hooks for React integrations of PostHog.",
5
+ "description": "Provides components and hooks for React integrations of PostHog. It is not published to NPM, but is used in the main posthog-js package.",
6
6
  "repository": {
7
7
  "type": "git",
8
8
  "url": "https://github.com/PostHog/posthog-js",
@@ -1,6 +0,0 @@
1
- import { FeatureFlags } from '../context';
2
- export declare function useFeatureFlags(props?: {
3
- refreshInterval?: number;
4
- sendEvent?: boolean;
5
- }): FeatureFlags;
6
- //# sourceMappingURL=useFeatureFlags.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"useFeatureFlags.d.ts","sourceRoot":"","sources":["../../../src/hooks/useFeatureFlags.ts"],"names":[],"mappings":"AACA,OAAO,EAAqB,YAAY,EAAE,MAAM,YAAY,CAAA;AAQ5D,wBAAgB,eAAe,CAAC,KAAK,GAAE;IAAE,eAAe,CAAC,EAAE,MAAM,CAAC;IAAC,SAAS,CAAC,EAAE,OAAO,CAAA;CAAO,GAAG,YAAY,CAkC3G"}