@grainql/analytics-web 1.7.4 → 2.1.0

package/dist/react/react/index.js

@@ -0,0 +1,58 @@
+"use strict";
+/**
+ * Grain Analytics React Hooks
+ *
+ * React integration for @grainql/analytics-web
+ *
+ * @example
+ * ```tsx
+ * import { GrainProvider, useConfig, useTrack } from '@grainql/analytics-web/react';
+ *
+ * // Pattern 1: Provider-managed client
+ * <GrainProvider config={{ tenantId: 'xxx' }}>
+ *   <App />
+ * </GrainProvider>
+ *
+ * // Pattern 2: External client
+ * const grain = new GrainAnalytics({ tenantId: 'xxx' });
+ * <GrainProvider client={grain}>
+ *   <App />
+ * </GrainProvider>
+ *
+ * // Use hooks in components
+ * function MyComponent() {
+ *   const { value } = useConfig('hero_variant');
+ *   const track = useTrack();
+ *
+ *   return <button onClick={() => track('clicked')}>Click</button>;
+ * }
+ * ```
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CookieNotice = exports.PrivacyPreferenceCenter = exports.ConsentBanner = exports.useDataDeletion = exports.usePrivacyPreferences = exports.useConsent = exports.useTrack = exports.useAllConfigs = exports.useConfig = exports.useGrainAnalytics = exports.GrainProvider = void 0;
+// Provider
+var GrainProvider_1 = require("./GrainProvider");
+Object.defineProperty(exports, "GrainProvider", { enumerable: true, get: function () { return GrainProvider_1.GrainProvider; } });
+// Hooks
+var useGrainAnalytics_1 = require("./hooks/useGrainAnalytics");
+Object.defineProperty(exports, "useGrainAnalytics", { enumerable: true, get: function () { return useGrainAnalytics_1.useGrainAnalytics; } });
+var useConfig_1 = require("./hooks/useConfig");
+Object.defineProperty(exports, "useConfig", { enumerable: true, get: function () { return useConfig_1.useConfig; } });
+var useAllConfigs_1 = require("./hooks/useAllConfigs");
+Object.defineProperty(exports, "useAllConfigs", { enumerable: true, get: function () { return useAllConfigs_1.useAllConfigs; } });
+var useTrack_1 = require("./hooks/useTrack");
+Object.defineProperty(exports, "useTrack", { enumerable: true, get: function () { return useTrack_1.useTrack; } });
+// Privacy hooks
+var useConsent_1 = require("./hooks/useConsent");
+Object.defineProperty(exports, "useConsent", { enumerable: true, get: function () { return useConsent_1.useConsent; } });
+var usePrivacyPreferences_1 = require("./hooks/usePrivacyPreferences");
+Object.defineProperty(exports, "usePrivacyPreferences", { enumerable: true, get: function () { return usePrivacyPreferences_1.usePrivacyPreferences; } });
+var useDataDeletion_1 = require("./hooks/useDataDeletion");
+Object.defineProperty(exports, "useDataDeletion", { enumerable: true, get: function () { return useDataDeletion_1.useDataDeletion; } });
+// Privacy components
+var ConsentBanner_1 = require("./components/ConsentBanner");
+Object.defineProperty(exports, "ConsentBanner", { enumerable: true, get: function () { return ConsentBanner_1.ConsentBanner; } });
+var PrivacyPreferenceCenter_1 = require("./components/PrivacyPreferenceCenter");
+Object.defineProperty(exports, "PrivacyPreferenceCenter", { enumerable: true, get: function () { return PrivacyPreferenceCenter_1.PrivacyPreferenceCenter; } });
+var CookieNotice_1 = require("./components/CookieNotice");
+Object.defineProperty(exports, "CookieNotice", { enumerable: true, get: function () { return CookieNotice_1.CookieNotice; } });

package/dist/react/react/index.mjs

@@ -0,0 +1,44 @@
+/**
+ * Grain Analytics React Hooks
+ *
+ * React integration for @grainql/analytics-web
+ *
+ * @example
+ * ```tsx
+ * import { GrainProvider, useConfig, useTrack } from '@grainql/analytics-web/react';
+ *
+ * // Pattern 1: Provider-managed client
+ * <GrainProvider config={{ tenantId: 'xxx' }}>
+ *   <App />
+ * </GrainProvider>
+ *
+ * // Pattern 2: External client
+ * const grain = new GrainAnalytics({ tenantId: 'xxx' });
+ * <GrainProvider client={grain}>
+ *   <App />
+ * </GrainProvider>
+ *
+ * // Use hooks in components
+ * function MyComponent() {
+ *   const { value } = useConfig('hero_variant');
+ *   const track = useTrack();
+ *
+ *   return <button onClick={() => track('clicked')}>Click</button>;
+ * }
+ * ```
+ */
+// Provider
+export { GrainProvider } from './GrainProvider';
+// Hooks
+export { useGrainAnalytics } from './hooks/useGrainAnalytics';
+export { useConfig } from './hooks/useConfig';
+export { useAllConfigs } from './hooks/useAllConfigs';
+export { useTrack } from './hooks/useTrack';
+// Privacy hooks
+export { useConsent } from './hooks/useConsent';
+export { usePrivacyPreferences } from './hooks/usePrivacyPreferences';
+export { useDataDeletion } from './hooks/useDataDeletion';
+// Privacy components
+export { ConsentBanner } from './components/ConsentBanner';
+export { PrivacyPreferenceCenter } from './components/PrivacyPreferenceCenter';
+export { CookieNotice } from './components/CookieNotice';

package/dist/react/react/types.d.ts

@@ -0,0 +1,33 @@
+/**
+ * React-specific types for Grain Analytics
+ */
+import type { GrainAnalytics, GrainConfig, SendEventOptions } from '../index';
+export interface GrainProviderProps {
+    children: React.ReactNode;
+    client?: GrainAnalytics;
+    config?: GrainConfig;
+}
+export interface UseConfigOptions {
+    forceRefresh?: boolean;
+    immediateKeys?: string[];
+    properties?: Record<string, string>;
+}
+export interface UseConfigResult {
+    value: string | undefined;
+    isRefreshing: boolean;
+    error: Error | null;
+    refresh: () => Promise<void>;
+}
+export interface UseAllConfigsOptions {
+    forceRefresh?: boolean;
+    immediateKeys?: string[];
+    properties?: Record<string, string>;
+}
+export interface UseAllConfigsResult {
+    configs: Record<string, string>;
+    isRefreshing: boolean;
+    error: Error | null;
+    refresh: () => Promise<void>;
+}
+export type TrackFunction = (eventName: string, properties?: Record<string, unknown>, options?: SendEventOptions) => Promise<void>;
+//# sourceMappingURL=types.d.ts.map

package/dist/react/react/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/react/types.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,EAAE,cAAc,EAAE,WAAW,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAE9E,MAAM,WAAW,kBAAkB;IACjC,QAAQ,EAAE,KAAK,CAAC,SAAS,CAAC;IAC1B,MAAM,CAAC,EAAE,cAAc,CAAC;IACxB,MAAM,CAAC,EAAE,WAAW,CAAC;CACtB;AAED,MAAM,WAAW,gBAAgB;IAC/B,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;IACzB,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACrC;AAED,MAAM,WAAW,eAAe;IAC9B,KAAK,EAAE,MAAM,GAAG,SAAS,CAAC;IAC1B,YAAY,EAAE,OAAO,CAAC;IACtB,KAAK,EAAE,KAAK,GAAG,IAAI,CAAC;IACpB,OAAO,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;CAC9B;AAED,MAAM,WAAW,oBAAoB;IACnC,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;IACzB,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACrC;AAED,MAAM,WAAW,mBAAmB;IAClC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAChC,YAAY,EAAE,OAAO,CAAC;IACtB,KAAK,EAAE,KAAK,GAAG,IAAI,CAAC;IACpB,OAAO,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;CAC9B;AAED,MAAM,MAAM,aAAa,GAAG,CAC1B,SAAS,EAAE,MAAM,EACjB,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EACpC,OAAO,CAAC,EAAE,gBAAgB,KACvB,OAAO,CAAC,IAAI,CAAC,CAAC"}

package/dist/react/react/types.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * React-specific types for Grain Analytics
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/react/react/types.mjs

@@ -0,0 +1,4 @@
+/**
+ * React-specific types for Grain Analytics
+ */
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@grainql/analytics-web",
-  "version": "1.7.4",
+  "version": "2.1.0",
   "description": "Lightweight TypeScript SDK for sending analytics events and managing remote configurations via Grain's REST API",
   "main": "dist/index.js",
   "module": "dist/index.mjs",
@@ -10,16 +10,30 @@
       "import": "./dist/index.mjs",
       "require": "./dist/index.js",
       "types": "./dist/index.d.ts"
+    },
+    "./react": {
+      "import": "./dist/react/index.mjs",
+      "require": "./dist/react/index.js",
+      "types": "./dist/react/index.d.ts"
+    }
+  },
+  "peerDependencies": {
+    "react": ">=16.8.0"
+  },
+  "peerDependenciesMeta": {
+    "react": {
+      "optional": true
     }
   },
   "files": [
     "dist/"
   ],
   "scripts": {
-    "build": "npm run build:types && npm run build:esm && npm run build:cjs && npm run build:iife",
+    "build": "npm run build:types && npm run build:esm && npm run build:cjs && npm run build:react && npm run build:iife",
     "build:types": "tsc --declaration --emitDeclarationOnly --outDir dist",
     "build:esm": "tsc --module esnext --target es2020 --outDir dist/esm && mv dist/esm/index.js dist/index.mjs",
     "build:cjs": "tsc --module commonjs --target es2020 --outDir dist/cjs && mv dist/cjs/index.js dist/index.js",
+    "build:react": "node scripts/build-react.js",
     "build:iife": "node scripts/build-iife.js",
     "clean": "rm -rf dist",
     "test": "jest",
@@ -43,12 +57,16 @@
   "devDependencies": {
     "@jest/globals": "^30.0.5",
     "@size-limit/preset-small-lib": "^11.2.0",
+    "@testing-library/react": "^16.0.0",
     "@types/jest": "^30.0.0",
     "@types/jsdom": "^21.1.7",
+    "@types/react": "^18.0.0",
     "esbuild": "^0.19.0",
     "jest": "^30.0.5",
     "jest-environment-jsdom": "^30.0.5",
     "jsdom": "^26.1.0",
+    "react": "^18.0.0",
+    "react-dom": "^18.0.0",
     "size-limit": "^11.2.0",
     "ts-jest": "^29.4.1",
     "typescript": "^5.5.3"