@grainql/analytics-web 1.7.4 → 2.0.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 (104) hide show
  1. package/README.md +71 -718
  2. package/dist/cjs/react/GrainProvider.d.ts +11 -0
  3. package/dist/cjs/react/GrainProvider.d.ts.map +1 -0
  4. package/dist/cjs/react/GrainProvider.js +79 -0
  5. package/dist/cjs/react/GrainProvider.js.map +1 -0
  6. package/dist/cjs/react/context.d.ts +11 -0
  7. package/dist/cjs/react/context.d.ts.map +1 -0
  8. package/dist/cjs/react/context.js +43 -0
  9. package/dist/cjs/react/context.js.map +1 -0
  10. package/dist/cjs/react/hooks/useAllConfigs.d.ts +8 -0
  11. package/dist/cjs/react/hooks/useAllConfigs.d.ts.map +1 -0
  12. package/dist/cjs/react/hooks/useAllConfigs.js +112 -0
  13. package/dist/cjs/react/hooks/useAllConfigs.js.map +1 -0
  14. package/dist/cjs/react/hooks/useConfig.d.ts +9 -0
  15. package/dist/cjs/react/hooks/useConfig.d.ts.map +1 -0
  16. package/dist/cjs/react/hooks/useConfig.js +116 -0
  17. package/dist/cjs/react/hooks/useConfig.js.map +1 -0
  18. package/dist/cjs/react/hooks/useGrainAnalytics.d.ts +6 -0
  19. package/dist/cjs/react/hooks/useGrainAnalytics.d.ts.map +1 -0
  20. package/dist/cjs/react/hooks/useGrainAnalytics.js +50 -0
  21. package/dist/cjs/react/hooks/useGrainAnalytics.js.map +1 -0
  22. package/dist/cjs/react/hooks/useTrack.d.ts +9 -0
  23. package/dist/cjs/react/hooks/useTrack.d.ts.map +1 -0
  24. package/dist/cjs/react/hooks/useTrack.js +53 -0
  25. package/dist/cjs/react/hooks/useTrack.js.map +1 -0
  26. package/dist/cjs/react/index.d.ts +36 -0
  27. package/dist/cjs/react/index.d.ts.map +1 -0
  28. package/dist/cjs/react/index.js +45 -0
  29. package/dist/cjs/react/index.js.map +1 -0
  30. package/dist/cjs/react/types.d.ts +33 -0
  31. package/dist/cjs/react/types.d.ts.map +1 -0
  32. package/dist/cjs/react/types.js +6 -0
  33. package/dist/cjs/react/types.js.map +1 -0
  34. package/dist/esm/react/GrainProvider.d.ts +11 -0
  35. package/dist/esm/react/GrainProvider.d.ts.map +1 -0
  36. package/dist/esm/react/GrainProvider.js +43 -0
  37. package/dist/esm/react/GrainProvider.js.map +1 -0
  38. package/dist/esm/react/context.d.ts +11 -0
  39. package/dist/esm/react/context.d.ts.map +1 -0
  40. package/dist/esm/react/context.js +7 -0
  41. package/dist/esm/react/context.js.map +1 -0
  42. package/dist/esm/react/hooks/useAllConfigs.d.ts +8 -0
  43. package/dist/esm/react/hooks/useAllConfigs.d.ts.map +1 -0
  44. package/dist/esm/react/hooks/useAllConfigs.js +76 -0
  45. package/dist/esm/react/hooks/useAllConfigs.js.map +1 -0
  46. package/dist/esm/react/hooks/useConfig.d.ts +9 -0
  47. package/dist/esm/react/hooks/useConfig.d.ts.map +1 -0
  48. package/dist/esm/react/hooks/useConfig.js +80 -0
  49. package/dist/esm/react/hooks/useConfig.js.map +1 -0
  50. package/dist/esm/react/hooks/useGrainAnalytics.d.ts +6 -0
  51. package/dist/esm/react/hooks/useGrainAnalytics.d.ts.map +1 -0
  52. package/dist/esm/react/hooks/useGrainAnalytics.js +14 -0
  53. package/dist/esm/react/hooks/useGrainAnalytics.js.map +1 -0
  54. package/dist/esm/react/hooks/useTrack.d.ts +9 -0
  55. package/dist/esm/react/hooks/useTrack.d.ts.map +1 -0
  56. package/dist/esm/react/hooks/useTrack.js +17 -0
  57. package/dist/esm/react/hooks/useTrack.js.map +1 -0
  58. package/dist/esm/react/index.d.ts +36 -0
  59. package/dist/esm/react/index.d.ts.map +1 -0
  60. package/dist/esm/react/index.js +37 -0
  61. package/dist/esm/react/index.js.map +1 -0
  62. package/dist/esm/react/types.d.ts +33 -0
  63. package/dist/esm/react/types.d.ts.map +1 -0
  64. package/dist/esm/react/types.js +5 -0
  65. package/dist/esm/react/types.js.map +1 -0
  66. package/dist/index.global.dev.js +1 -1
  67. package/dist/index.global.js +1 -1
  68. package/dist/react/index.d.ts +405 -0
  69. package/dist/react/index.d.ts.map +1 -0
  70. package/dist/react/index.js +1181 -0
  71. package/dist/react/index.mjs +1176 -0
  72. package/dist/react/react/GrainProvider.d.ts +11 -0
  73. package/dist/react/react/GrainProvider.d.ts.map +1 -0
  74. package/dist/react/react/GrainProvider.js +45 -0
  75. package/dist/react/react/GrainProvider.mjs +42 -0
  76. package/dist/react/react/context.d.ts +11 -0
  77. package/dist/react/react/context.d.ts.map +1 -0
  78. package/dist/react/react/context.js +9 -0
  79. package/dist/react/react/context.mjs +6 -0
  80. package/dist/react/react/hooks/useAllConfigs.d.ts +8 -0
  81. package/dist/react/react/hooks/useAllConfigs.d.ts.map +1 -0
  82. package/dist/react/react/hooks/useAllConfigs.js +78 -0
  83. package/dist/react/react/hooks/useAllConfigs.mjs +75 -0
  84. package/dist/react/react/hooks/useConfig.d.ts +9 -0
  85. package/dist/react/react/hooks/useConfig.d.ts.map +1 -0
  86. package/dist/react/react/hooks/useConfig.js +82 -0
  87. package/dist/react/react/hooks/useConfig.mjs +79 -0
  88. package/dist/react/react/hooks/useGrainAnalytics.d.ts +6 -0
  89. package/dist/react/react/hooks/useGrainAnalytics.d.ts.map +1 -0
  90. package/dist/react/react/hooks/useGrainAnalytics.js +16 -0
  91. package/dist/react/react/hooks/useGrainAnalytics.mjs +13 -0
  92. package/dist/react/react/hooks/useTrack.d.ts +9 -0
  93. package/dist/react/react/hooks/useTrack.d.ts.map +1 -0
  94. package/dist/react/react/hooks/useTrack.js +19 -0
  95. package/dist/react/react/hooks/useTrack.mjs +16 -0
  96. package/dist/react/react/index.d.ts +36 -0
  97. package/dist/react/react/index.d.ts.map +1 -0
  98. package/dist/react/react/index.js +44 -0
  99. package/dist/react/react/index.mjs +36 -0
  100. package/dist/react/react/types.d.ts +33 -0
  101. package/dist/react/react/types.d.ts.map +1 -0
  102. package/dist/react/react/types.js +5 -0
  103. package/dist/react/react/types.mjs +4 -0
  104. package/package.json +20 -2
@@ -0,0 +1,11 @@
1
+ /**
2
+ * GrainProvider - Context provider for Grain Analytics
3
+ *
4
+ * Supports two patterns:
5
+ * 1. Provider-managed: Pass `config` prop, provider creates and manages client lifecycle
6
+ * 2. External client: Pass `client` prop, user manages lifecycle
7
+ */
8
+ import * as React from 'react';
9
+ import type { GrainProviderProps } from './types';
10
+ export declare function GrainProvider({ children, client, config }: GrainProviderProps): React.JSX.Element;
11
+ //# sourceMappingURL=GrainProvider.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"GrainProvider.d.ts","sourceRoot":"","sources":["../../../src/react/GrainProvider.tsx"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAG/B,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,SAAS,CAAC;AAElD,wBAAgB,aAAa,CAAC,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,EAAE,kBAAkB,qBA8C7E"}
@@ -0,0 +1,45 @@
1
+ "use strict";
2
+ /**
3
+ * GrainProvider - Context provider for Grain Analytics
4
+ *
5
+ * Supports two patterns:
6
+ * 1. Provider-managed: Pass `config` prop, provider creates and manages client lifecycle
7
+ * 2. External client: Pass `client` prop, user manages lifecycle
8
+ */
9
+ Object.defineProperty(exports, "__esModule", { value: true });
10
+ exports.GrainProvider = GrainProvider;
11
+ const React = require("react");
12
+ const index_1 = require("../index");
13
+ const context_1 = require("./context");
14
+ function GrainProvider({ children, client, config }) {
15
+ // Validate props
16
+ if (client && config) {
17
+ throw new Error('GrainProvider: Cannot provide both "client" and "config" props. ' +
18
+ 'Use "client" for external management or "config" for provider-managed client.');
19
+ }
20
+ if (!client && !config) {
21
+ throw new Error('GrainProvider: Must provide either "client" or "config" prop. ' +
22
+ 'Use "client" to pass an existing GrainAnalytics instance, or "config" to create one automatically.');
23
+ }
24
+ const isProviderManaged = Boolean(config);
25
+ const clientRef = React.useRef(null);
26
+ // Initialize client if config is provided
27
+ if (isProviderManaged && !clientRef.current && config) {
28
+ clientRef.current = new index_1.GrainAnalytics(config);
29
+ }
30
+ // Use external client if provided
31
+ const activeClient = client || clientRef.current;
32
+ if (!activeClient) {
33
+ throw new Error('GrainProvider: Failed to initialize client');
34
+ }
35
+ // Cleanup on unmount (only for provider-managed clients)
36
+ React.useEffect(() => {
37
+ return () => {
38
+ if (isProviderManaged && clientRef.current) {
39
+ clientRef.current.destroy();
40
+ clientRef.current = null;
41
+ }
42
+ };
43
+ }, [isProviderManaged]);
44
+ return (React.createElement(context_1.GrainContext.Provider, { value: { client: activeClient, isProviderManaged } }, children));
45
+ }
@@ -0,0 +1,42 @@
1
+ /**
2
+ * GrainProvider - Context provider for Grain Analytics
3
+ *
4
+ * Supports two patterns:
5
+ * 1. Provider-managed: Pass `config` prop, provider creates and manages client lifecycle
6
+ * 2. External client: Pass `client` prop, user manages lifecycle
7
+ */
8
+ import * as React from 'react';
9
+ import { GrainAnalytics } from '../index';
10
+ import { GrainContext } from './context';
11
+ export function GrainProvider({ children, client, config }) {
12
+ // Validate props
13
+ if (client && config) {
14
+ throw new Error('GrainProvider: Cannot provide both "client" and "config" props. ' +
15
+ 'Use "client" for external management or "config" for provider-managed client.');
16
+ }
17
+ if (!client && !config) {
18
+ throw new Error('GrainProvider: Must provide either "client" or "config" prop. ' +
19
+ 'Use "client" to pass an existing GrainAnalytics instance, or "config" to create one automatically.');
20
+ }
21
+ const isProviderManaged = Boolean(config);
22
+ const clientRef = React.useRef(null);
23
+ // Initialize client if config is provided
24
+ if (isProviderManaged && !clientRef.current && config) {
25
+ clientRef.current = new GrainAnalytics(config);
26
+ }
27
+ // Use external client if provided
28
+ const activeClient = client || clientRef.current;
29
+ if (!activeClient) {
30
+ throw new Error('GrainProvider: Failed to initialize client');
31
+ }
32
+ // Cleanup on unmount (only for provider-managed clients)
33
+ React.useEffect(() => {
34
+ return () => {
35
+ if (isProviderManaged && clientRef.current) {
36
+ clientRef.current.destroy();
37
+ clientRef.current = null;
38
+ }
39
+ };
40
+ }, [isProviderManaged]);
41
+ return (React.createElement(GrainContext.Provider, { value: { client: activeClient, isProviderManaged } }, children));
42
+ }
@@ -0,0 +1,11 @@
1
+ /**
2
+ * React context for Grain Analytics
3
+ */
4
+ import * as React from 'react';
5
+ import type { GrainAnalytics } from '../index';
6
+ export interface GrainContextValue {
7
+ client: GrainAnalytics;
8
+ isProviderManaged: boolean;
9
+ }
10
+ export declare const GrainContext: React.Context<GrainContextValue>;
11
+ //# sourceMappingURL=context.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"context.d.ts","sourceRoot":"","sources":["../../../src/react/context.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,UAAU,CAAC;AAE/C,MAAM,WAAW,iBAAiB;IAChC,MAAM,EAAE,cAAc,CAAC;IACvB,iBAAiB,EAAE,OAAO,CAAC;CAC5B;AAED,eAAO,MAAM,YAAY,kCAAsD,CAAC"}
@@ -0,0 +1,9 @@
1
+ "use strict";
2
+ /**
3
+ * React context for Grain Analytics
4
+ */
5
+ Object.defineProperty(exports, "__esModule", { value: true });
6
+ exports.GrainContext = void 0;
7
+ const React = require("react");
8
+ exports.GrainContext = React.createContext(null);
9
+ exports.GrainContext.displayName = 'GrainContext';
@@ -0,0 +1,6 @@
1
+ /**
2
+ * React context for Grain Analytics
3
+ */
4
+ import * as React from 'react';
5
+ export const GrainContext = React.createContext(null);
6
+ GrainContext.displayName = 'GrainContext';
@@ -0,0 +1,8 @@
1
+ /**
2
+ * useAllConfigs - Get all configurations with automatic updates
3
+ *
4
+ * Returns all configs as a reactive object with cache-first strategy.
5
+ */
6
+ import type { UseAllConfigsOptions, UseAllConfigsResult } from '../types';
7
+ export declare function useAllConfigs(options?: UseAllConfigsOptions): UseAllConfigsResult;
8
+ //# sourceMappingURL=useAllConfigs.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"useAllConfigs.d.ts","sourceRoot":"","sources":["../../../../src/react/hooks/useAllConfigs.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAIH,OAAO,KAAK,EAAE,oBAAoB,EAAE,mBAAmB,EAAE,MAAM,UAAU,CAAC;AAE1E,wBAAgB,aAAa,CAAC,OAAO,GAAE,oBAAyB,GAAG,mBAAmB,CA4ErF"}
@@ -0,0 +1,78 @@
1
+ "use strict";
2
+ /**
3
+ * useAllConfigs - Get all configurations with automatic updates
4
+ *
5
+ * Returns all configs as a reactive object with cache-first strategy.
6
+ */
7
+ Object.defineProperty(exports, "__esModule", { value: true });
8
+ exports.useAllConfigs = useAllConfigs;
9
+ const React = require("react");
10
+ const useGrainAnalytics_1 = require("./useGrainAnalytics");
11
+ function useAllConfigs(options = {}) {
12
+ const client = (0, useGrainAnalytics_1.useGrainAnalytics)();
13
+ // Get initial configs from cache/defaults (synchronous, instant)
14
+ const [configs, setConfigs] = React.useState(() => client.getAllConfigs());
15
+ const [isRefreshing, setIsRefreshing] = React.useState(false);
16
+ const [error, setError] = React.useState(null);
17
+ const isMountedRef = React.useRef(true);
18
+ // Fetch fresh configs from API
19
+ const fetchConfigs = React.useCallback(async () => {
20
+ if (!isMountedRef.current)
21
+ return;
22
+ setIsRefreshing(true);
23
+ setError(null);
24
+ try {
25
+ const response = await client.fetchConfig({
26
+ immediateKeys: options.immediateKeys || [],
27
+ properties: options.properties,
28
+ forceRefresh: options.forceRefresh,
29
+ });
30
+ if (isMountedRef.current && response) {
31
+ setConfigs(response.configurations);
32
+ }
33
+ }
34
+ catch (err) {
35
+ if (isMountedRef.current) {
36
+ setError(err instanceof Error ? err : new Error(String(err)));
37
+ }
38
+ }
39
+ finally {
40
+ if (isMountedRef.current) {
41
+ setIsRefreshing(false);
42
+ }
43
+ }
44
+ }, [client, options.immediateKeys, options.properties, options.forceRefresh]);
45
+ // Manual refresh function
46
+ const refresh = React.useCallback(async () => {
47
+ await fetchConfigs();
48
+ }, [fetchConfigs]);
49
+ // Background fetch on mount and when options change
50
+ React.useEffect(() => {
51
+ fetchConfigs();
52
+ }, [fetchConfigs]);
53
+ // Subscribe to config changes
54
+ React.useEffect(() => {
55
+ const listener = (configurations) => {
56
+ if (isMountedRef.current) {
57
+ setConfigs(configurations);
58
+ }
59
+ };
60
+ client.addConfigChangeListener(listener);
61
+ return () => {
62
+ client.removeConfigChangeListener(listener);
63
+ };
64
+ }, [client]);
65
+ // Track mount state
66
+ React.useEffect(() => {
67
+ isMountedRef.current = true;
68
+ return () => {
69
+ isMountedRef.current = false;
70
+ };
71
+ }, []);
72
+ return {
73
+ configs,
74
+ isRefreshing,
75
+ error,
76
+ refresh,
77
+ };
78
+ }
@@ -0,0 +1,75 @@
1
+ /**
2
+ * useAllConfigs - Get all configurations with automatic updates
3
+ *
4
+ * Returns all configs as a reactive object with cache-first strategy.
5
+ */
6
+ import * as React from 'react';
7
+ import { useGrainAnalytics } from './useGrainAnalytics';
8
+ export function useAllConfigs(options = {}) {
9
+ const client = useGrainAnalytics();
10
+ // Get initial configs from cache/defaults (synchronous, instant)
11
+ const [configs, setConfigs] = React.useState(() => client.getAllConfigs());
12
+ const [isRefreshing, setIsRefreshing] = React.useState(false);
13
+ const [error, setError] = React.useState(null);
14
+ const isMountedRef = React.useRef(true);
15
+ // Fetch fresh configs from API
16
+ const fetchConfigs = React.useCallback(async () => {
17
+ if (!isMountedRef.current)
18
+ return;
19
+ setIsRefreshing(true);
20
+ setError(null);
21
+ try {
22
+ const response = await client.fetchConfig({
23
+ immediateKeys: options.immediateKeys || [],
24
+ properties: options.properties,
25
+ forceRefresh: options.forceRefresh,
26
+ });
27
+ if (isMountedRef.current && response) {
28
+ setConfigs(response.configurations);
29
+ }
30
+ }
31
+ catch (err) {
32
+ if (isMountedRef.current) {
33
+ setError(err instanceof Error ? err : new Error(String(err)));
34
+ }
35
+ }
36
+ finally {
37
+ if (isMountedRef.current) {
38
+ setIsRefreshing(false);
39
+ }
40
+ }
41
+ }, [client, options.immediateKeys, options.properties, options.forceRefresh]);
42
+ // Manual refresh function
43
+ const refresh = React.useCallback(async () => {
44
+ await fetchConfigs();
45
+ }, [fetchConfigs]);
46
+ // Background fetch on mount and when options change
47
+ React.useEffect(() => {
48
+ fetchConfigs();
49
+ }, [fetchConfigs]);
50
+ // Subscribe to config changes
51
+ React.useEffect(() => {
52
+ const listener = (configurations) => {
53
+ if (isMountedRef.current) {
54
+ setConfigs(configurations);
55
+ }
56
+ };
57
+ client.addConfigChangeListener(listener);
58
+ return () => {
59
+ client.removeConfigChangeListener(listener);
60
+ };
61
+ }, [client]);
62
+ // Track mount state
63
+ React.useEffect(() => {
64
+ isMountedRef.current = true;
65
+ return () => {
66
+ isMountedRef.current = false;
67
+ };
68
+ }, []);
69
+ return {
70
+ configs,
71
+ isRefreshing,
72
+ error,
73
+ refresh,
74
+ };
75
+ }
@@ -0,0 +1,9 @@
1
+ /**
2
+ * useConfig - Cache-first config access with automatic background refresh
3
+ *
4
+ * Returns cached/default value immediately, fetches fresh data in background,
5
+ * and automatically updates when configuration changes.
6
+ */
7
+ import type { UseConfigOptions, UseConfigResult } from '../types';
8
+ export declare function useConfig(key: string, options?: UseConfigOptions): UseConfigResult;
9
+ //# sourceMappingURL=useConfig.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"useConfig.d.ts","sourceRoot":"","sources":["../../../../src/react/hooks/useConfig.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAIH,OAAO,KAAK,EAAE,gBAAgB,EAAE,eAAe,EAAE,MAAM,UAAU,CAAC;AAElE,wBAAgB,SAAS,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,GAAE,gBAAqB,GAAG,eAAe,CA+EtF"}
@@ -0,0 +1,82 @@
1
+ "use strict";
2
+ /**
3
+ * useConfig - Cache-first config access with automatic background refresh
4
+ *
5
+ * Returns cached/default value immediately, fetches fresh data in background,
6
+ * and automatically updates when configuration changes.
7
+ */
8
+ Object.defineProperty(exports, "__esModule", { value: true });
9
+ exports.useConfig = useConfig;
10
+ const React = require("react");
11
+ const useGrainAnalytics_1 = require("./useGrainAnalytics");
12
+ function useConfig(key, options = {}) {
13
+ const client = (0, useGrainAnalytics_1.useGrainAnalytics)();
14
+ // Get initial value from cache/defaults (synchronous, instant)
15
+ const [value, setValue] = React.useState(() => client.getConfig(key));
16
+ const [isRefreshing, setIsRefreshing] = React.useState(false);
17
+ const [error, setError] = React.useState(null);
18
+ const isMountedRef = React.useRef(true);
19
+ // Fetch fresh config from API
20
+ const fetchConfig = React.useCallback(async () => {
21
+ if (!isMountedRef.current)
22
+ return;
23
+ setIsRefreshing(true);
24
+ setError(null);
25
+ try {
26
+ const response = await client.fetchConfig({
27
+ immediateKeys: options.immediateKeys || [key],
28
+ properties: options.properties,
29
+ forceRefresh: options.forceRefresh,
30
+ });
31
+ if (isMountedRef.current && response) {
32
+ const newValue = response.configurations[key];
33
+ if (newValue !== undefined) {
34
+ setValue(newValue);
35
+ }
36
+ }
37
+ }
38
+ catch (err) {
39
+ if (isMountedRef.current) {
40
+ setError(err instanceof Error ? err : new Error(String(err)));
41
+ }
42
+ }
43
+ finally {
44
+ if (isMountedRef.current) {
45
+ setIsRefreshing(false);
46
+ }
47
+ }
48
+ }, [client, key, options.immediateKeys, options.properties, options.forceRefresh]);
49
+ // Manual refresh function
50
+ const refresh = React.useCallback(async () => {
51
+ await fetchConfig();
52
+ }, [fetchConfig]);
53
+ // Background fetch on mount and when key/options change
54
+ React.useEffect(() => {
55
+ fetchConfig();
56
+ }, [fetchConfig]);
57
+ // Subscribe to config changes
58
+ React.useEffect(() => {
59
+ const listener = (configurations) => {
60
+ if (isMountedRef.current && configurations[key] !== undefined) {
61
+ setValue(configurations[key]);
62
+ }
63
+ };
64
+ client.addConfigChangeListener(listener);
65
+ return () => {
66
+ client.removeConfigChangeListener(listener);
67
+ };
68
+ }, [client, key]);
69
+ // Track mount state
70
+ React.useEffect(() => {
71
+ isMountedRef.current = true;
72
+ return () => {
73
+ isMountedRef.current = false;
74
+ };
75
+ }, []);
76
+ return {
77
+ value,
78
+ isRefreshing,
79
+ error,
80
+ refresh,
81
+ };
82
+ }
@@ -0,0 +1,79 @@
1
+ /**
2
+ * useConfig - Cache-first config access with automatic background refresh
3
+ *
4
+ * Returns cached/default value immediately, fetches fresh data in background,
5
+ * and automatically updates when configuration changes.
6
+ */
7
+ import * as React from 'react';
8
+ import { useGrainAnalytics } from './useGrainAnalytics';
9
+ export function useConfig(key, options = {}) {
10
+ const client = useGrainAnalytics();
11
+ // Get initial value from cache/defaults (synchronous, instant)
12
+ const [value, setValue] = React.useState(() => client.getConfig(key));
13
+ const [isRefreshing, setIsRefreshing] = React.useState(false);
14
+ const [error, setError] = React.useState(null);
15
+ const isMountedRef = React.useRef(true);
16
+ // Fetch fresh config from API
17
+ const fetchConfig = React.useCallback(async () => {
18
+ if (!isMountedRef.current)
19
+ return;
20
+ setIsRefreshing(true);
21
+ setError(null);
22
+ try {
23
+ const response = await client.fetchConfig({
24
+ immediateKeys: options.immediateKeys || [key],
25
+ properties: options.properties,
26
+ forceRefresh: options.forceRefresh,
27
+ });
28
+ if (isMountedRef.current && response) {
29
+ const newValue = response.configurations[key];
30
+ if (newValue !== undefined) {
31
+ setValue(newValue);
32
+ }
33
+ }
34
+ }
35
+ catch (err) {
36
+ if (isMountedRef.current) {
37
+ setError(err instanceof Error ? err : new Error(String(err)));
38
+ }
39
+ }
40
+ finally {
41
+ if (isMountedRef.current) {
42
+ setIsRefreshing(false);
43
+ }
44
+ }
45
+ }, [client, key, options.immediateKeys, options.properties, options.forceRefresh]);
46
+ // Manual refresh function
47
+ const refresh = React.useCallback(async () => {
48
+ await fetchConfig();
49
+ }, [fetchConfig]);
50
+ // Background fetch on mount and when key/options change
51
+ React.useEffect(() => {
52
+ fetchConfig();
53
+ }, [fetchConfig]);
54
+ // Subscribe to config changes
55
+ React.useEffect(() => {
56
+ const listener = (configurations) => {
57
+ if (isMountedRef.current && configurations[key] !== undefined) {
58
+ setValue(configurations[key]);
59
+ }
60
+ };
61
+ client.addConfigChangeListener(listener);
62
+ return () => {
63
+ client.removeConfigChangeListener(listener);
64
+ };
65
+ }, [client, key]);
66
+ // Track mount state
67
+ React.useEffect(() => {
68
+ isMountedRef.current = true;
69
+ return () => {
70
+ isMountedRef.current = false;
71
+ };
72
+ }, []);
73
+ return {
74
+ value,
75
+ isRefreshing,
76
+ error,
77
+ refresh,
78
+ };
79
+ }
@@ -0,0 +1,6 @@
1
+ /**
2
+ * useGrainAnalytics - Access the GrainAnalytics client from context
3
+ */
4
+ import type { GrainAnalytics } from '../../index';
5
+ export declare function useGrainAnalytics(): GrainAnalytics;
6
+ //# sourceMappingURL=useGrainAnalytics.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"useGrainAnalytics.d.ts","sourceRoot":"","sources":["../../../../src/react/hooks/useGrainAnalytics.ts"],"names":[],"mappings":"AAAA;;GAEG;AAIH,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAElD,wBAAgB,iBAAiB,IAAI,cAAc,CAWlD"}
@@ -0,0 +1,16 @@
1
+ "use strict";
2
+ /**
3
+ * useGrainAnalytics - Access the GrainAnalytics client from context
4
+ */
5
+ Object.defineProperty(exports, "__esModule", { value: true });
6
+ exports.useGrainAnalytics = useGrainAnalytics;
7
+ const React = require("react");
8
+ const context_1 = require("../context");
9
+ function useGrainAnalytics() {
10
+ const context = React.useContext(context_1.GrainContext);
11
+ if (!context) {
12
+ throw new Error('useGrainAnalytics must be used within a GrainProvider. ' +
13
+ 'Wrap your component tree with <GrainProvider client={client}> or <GrainProvider config={{...}}>');
14
+ }
15
+ return context.client;
16
+ }
@@ -0,0 +1,13 @@
1
+ /**
2
+ * useGrainAnalytics - Access the GrainAnalytics client from context
3
+ */
4
+ import * as React from 'react';
5
+ import { GrainContext } from '../context';
6
+ export function useGrainAnalytics() {
7
+ const context = React.useContext(GrainContext);
8
+ if (!context) {
9
+ throw new Error('useGrainAnalytics must be used within a GrainProvider. ' +
10
+ 'Wrap your component tree with <GrainProvider client={client}> or <GrainProvider config={{...}}>');
11
+ }
12
+ return context.client;
13
+ }
@@ -0,0 +1,9 @@
1
+ /**
2
+ * useTrack - Get a stable, memoized track function
3
+ *
4
+ * Returns a track function that doesn't cause re-renders when passed to child components.
5
+ * Prevents unnecessary re-renders compared to using useCallback.
6
+ */
7
+ import type { TrackFunction } from '../types';
8
+ export declare function useTrack(): TrackFunction;
9
+ //# sourceMappingURL=useTrack.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"useTrack.d.ts","sourceRoot":"","sources":["../../../../src/react/hooks/useTrack.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAIH,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAE9C,wBAAgB,QAAQ,IAAI,aAAa,CAYxC"}
@@ -0,0 +1,19 @@
1
+ "use strict";
2
+ /**
3
+ * useTrack - Get a stable, memoized track function
4
+ *
5
+ * Returns a track function that doesn't cause re-renders when passed to child components.
6
+ * Prevents unnecessary re-renders compared to using useCallback.
7
+ */
8
+ Object.defineProperty(exports, "__esModule", { value: true });
9
+ exports.useTrack = useTrack;
10
+ const React = require("react");
11
+ const useGrainAnalytics_1 = require("./useGrainAnalytics");
12
+ function useTrack() {
13
+ const client = (0, useGrainAnalytics_1.useGrainAnalytics)();
14
+ // Create stable track function that won't change across renders
15
+ const track = React.useCallback(async (eventName, properties, options) => {
16
+ await client.track(eventName, properties, options);
17
+ }, [client]);
18
+ return track;
19
+ }
@@ -0,0 +1,16 @@
1
+ /**
2
+ * useTrack - Get a stable, memoized track function
3
+ *
4
+ * Returns a track function that doesn't cause re-renders when passed to child components.
5
+ * Prevents unnecessary re-renders compared to using useCallback.
6
+ */
7
+ import * as React from 'react';
8
+ import { useGrainAnalytics } from './useGrainAnalytics';
9
+ export function useTrack() {
10
+ const client = useGrainAnalytics();
11
+ // Create stable track function that won't change across renders
12
+ const track = React.useCallback(async (eventName, properties, options) => {
13
+ await client.track(eventName, properties, options);
14
+ }, [client]);
15
+ return track;
16
+ }
@@ -0,0 +1,36 @@
1
+ /**
2
+ * Grain Analytics React Hooks
3
+ *
4
+ * React integration for @grainql/analytics-web
5
+ *
6
+ * @example
7
+ * ```tsx
8
+ * import { GrainProvider, useConfig, useTrack } from '@grainql/analytics-web/react';
9
+ *
10
+ * // Pattern 1: Provider-managed client
11
+ * <GrainProvider config={{ tenantId: 'xxx' }}>
12
+ * <App />
13
+ * </GrainProvider>
14
+ *
15
+ * // Pattern 2: External client
16
+ * const grain = new GrainAnalytics({ tenantId: 'xxx' });
17
+ * <GrainProvider client={grain}>
18
+ * <App />
19
+ * </GrainProvider>
20
+ *
21
+ * // Use hooks in components
22
+ * function MyComponent() {
23
+ * const { value } = useConfig('hero_variant');
24
+ * const track = useTrack();
25
+ *
26
+ * return <button onClick={() => track('clicked')}>Click</button>;
27
+ * }
28
+ * ```
29
+ */
30
+ export { GrainProvider } from './GrainProvider';
31
+ export { useGrainAnalytics } from './hooks/useGrainAnalytics';
32
+ export { useConfig } from './hooks/useConfig';
33
+ export { useAllConfigs } from './hooks/useAllConfigs';
34
+ export { useTrack } from './hooks/useTrack';
35
+ export type { GrainProviderProps, UseConfigOptions, UseConfigResult, UseAllConfigsOptions, UseAllConfigsResult, TrackFunction, } from './types';
36
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/react/index.tsx"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AAGH,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAGhD,OAAO,EAAE,iBAAiB,EAAE,MAAM,2BAA2B,CAAC;AAC9D,OAAO,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAC;AAC9C,OAAO,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAC;AACtD,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAG5C,YAAY,EACV,kBAAkB,EAClB,gBAAgB,EAChB,eAAe,EACf,oBAAoB,EACpB,mBAAmB,EACnB,aAAa,GACd,MAAM,SAAS,CAAC"}
@@ -0,0 +1,44 @@
1
+ "use strict";
2
+ /**
3
+ * Grain Analytics React Hooks
4
+ *
5
+ * React integration for @grainql/analytics-web
6
+ *
7
+ * @example
8
+ * ```tsx
9
+ * import { GrainProvider, useConfig, useTrack } from '@grainql/analytics-web/react';
10
+ *
11
+ * // Pattern 1: Provider-managed client
12
+ * <GrainProvider config={{ tenantId: 'xxx' }}>
13
+ * <App />
14
+ * </GrainProvider>
15
+ *
16
+ * // Pattern 2: External client
17
+ * const grain = new GrainAnalytics({ tenantId: 'xxx' });
18
+ * <GrainProvider client={grain}>
19
+ * <App />
20
+ * </GrainProvider>
21
+ *
22
+ * // Use hooks in components
23
+ * function MyComponent() {
24
+ * const { value } = useConfig('hero_variant');
25
+ * const track = useTrack();
26
+ *
27
+ * return <button onClick={() => track('clicked')}>Click</button>;
28
+ * }
29
+ * ```
30
+ */
31
+ Object.defineProperty(exports, "__esModule", { value: true });
32
+ exports.useTrack = exports.useAllConfigs = exports.useConfig = exports.useGrainAnalytics = exports.GrainProvider = void 0;
33
+ // Provider
34
+ var GrainProvider_1 = require("./GrainProvider");
35
+ Object.defineProperty(exports, "GrainProvider", { enumerable: true, get: function () { return GrainProvider_1.GrainProvider; } });
36
+ // Hooks
37
+ var useGrainAnalytics_1 = require("./hooks/useGrainAnalytics");
38
+ Object.defineProperty(exports, "useGrainAnalytics", { enumerable: true, get: function () { return useGrainAnalytics_1.useGrainAnalytics; } });
39
+ var useConfig_1 = require("./hooks/useConfig");
40
+ Object.defineProperty(exports, "useConfig", { enumerable: true, get: function () { return useConfig_1.useConfig; } });
41
+ var useAllConfigs_1 = require("./hooks/useAllConfigs");
42
+ Object.defineProperty(exports, "useAllConfigs", { enumerable: true, get: function () { return useAllConfigs_1.useAllConfigs; } });
43
+ var useTrack_1 = require("./hooks/useTrack");
44
+ Object.defineProperty(exports, "useTrack", { enumerable: true, get: function () { return useTrack_1.useTrack; } });