@altertable/altertable-react 0.4.0 → 0.5.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025-present Altertable
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,275 @@
+# @altertable/altertable-react
+
+React SDK for capturing and sending analytics events to Altertable with type-safe funnel tracking.
+
+## Installation
+
+```bash
+npm install @altertable/altertable-js @altertable/altertable-react
+# or
+pnpm add @altertable/altertable-js @altertable/altertable-react
+# or
+yarn add @altertable/altertable-js @altertable/altertable-react
+# or
+bun add @altertable/altertable-js @altertable/altertable-react
+```
+
+## Quick Start
+
+```tsx
+import {
+  AltertableProvider,
+  useAltertable,
+} from '@altertable/altertable-react';
+import { altertable } from '@altertable/altertable-js';
+
+// Initialize the core SDK
+altertable.init('YOUR_API_KEY');
+
+function App() {
+  return (
+    <AltertableProvider client={altertable}>
+      <SignupPage />
+    </AltertableProvider>
+  );
+}
+
+function SignupPage() {
+  const { track } = useAltertable();
+
+  function handleStart() {
+    track('Signup Started', { source: 'homepage' });
+  }
+
+  function handleSubmit(email: string) {
+    track('Signup Submitted', { email });
+  }
+
+  return (
+    <div>
+      <button onClick={() => handleStart()}>Start Signup</button>
+      <button onClick={() => handleSubmit('john.doe@example.com')}>
+        Submit
+      </button>
+    </div>
+  );
+}
+```
+
+> [!NOTE]
+>
+> For **server-side rendering** (SSR), initialize in a [`useEffect()`](https://react.dev/reference/react/useEffect):
+>
+> ```tsx
+> import { useEffect } from 'react';
+> import { altertable } from '@altertable/altertable-js';
+> import { AltertableProvider } from '@altertable/altertable-react';
+>
+> function App() {
+>   useEffect(() => {
+>     altertable.init('YOUR_API_KEY');
+>   }, []);
+>
+>   return (
+>     <AltertableProvider client={altertable}>
+>       <SignupPage />
+>     </AltertableProvider>
+>   );
+> }
+> ```
+
+## Features
+
+- **Automatic page view tracking** – Captures page views automatically
+- **Session management** – Handles visitor and session IDs automatically
+- **Event queuing** – Queues events when offline or consent is pending
+- **Privacy compliance** – Built-in tracking consent management
+- **Multiple storage options** – localStorage, cookies, or both
+- **Type-safe funnel tracking** – Define funnel steps with TypeScript for compile-time safety
+- **React Hooks** – Easy-to-use Hooks for tracking events and managing funnels
+- **Context provider** – Share Altertable instance across your React component tree
+- **Zero dependencies** – Only depends on React and the core Altertable SDK
+
+## API Reference
+
+### Components
+
+#### `<AltertableProvider>`
+
+Provides the Altertable client to the React component tree.
+
+**Props:**
+
+| Parameter  | Type                                                                                                                    | Required | Description                                                                                                                                                            |
+| ---------- | ----------------------------------------------------------------------------------------------------------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `client`   | [`Altertable`](https://github.com/altertable-ai/altertable-js/blob/main/packages/altertable-js/README.md#api-reference) | Yes      | The Altertable client instance (see core SDK [API Reference](https://github.com/altertable-ai/altertable-js/blob/main/packages/altertable-js/README.md#api-reference)) |
+| `children` | `ReactNode`                                                                                                             | Yes      | React children                                                                                                                                                         |
+
+**Example:**
+
+```tsx
+import { AltertableProvider } from '@altertable/altertable-react';
+import { altertable } from '@altertable/altertable-js';
+
+altertable.init('YOUR_API_KEY');
+
+function App() {
+  return (
+    <AltertableProvider client={altertable}>
+      <YourApp />
+    </AltertableProvider>
+  );
+}
+```
+
+### Hooks
+
+#### `useAltertable<TFunnelMapping>()`
+
+Returns an object with tracking methods and funnel utilities.
+
+**Type Parameters:**
+
+| Parameter        | Type                              | Required | Description                                            |
+| ---------------- | --------------------------------- | -------- | ------------------------------------------------------ |
+| `TFunnelMapping` | [`FunnelMapping`](#funnelmapping) | No       | Type mapping of funnel names to their step definitions |
+
+**Returns:**
+
+| Property             | Type                                                             | Description                 |
+| -------------------- | ---------------------------------------------------------------- | --------------------------- |
+| `track`              | `(event: string, properties?: EventProperties) => void`          | Track a custom event        |
+| `identify`           | `(userId: string, traits?: UserTraits) => void`                  | Identify a user             |
+| `updateTraits`       | `(traits: UserTraits) => void`                                   | Update user traits          |
+| `configure`          | `(updates: Partial<AltertableConfig>) => void`                   | Update configuration        |
+| `getTrackingConsent` | `() => TrackingConsentType`                                      | Get current consent state   |
+| `useFunnel`          | `(funnelName: keyof TFunnelMapping) => { track: FunnelTracker }` | Get funnel-specific tracker |
+
+**Example:**
+
+```tsx
+function MyComponent() {
+  const { track, identify, useFunnel } = useAltertable<MyFunnelMapping>();
+
+  function handleClick() {
+    track('Button Clicked', { button: 'signup' });
+  }
+
+  function handleLogin(userId: string) {
+    identify(userId, { email: 'user@example.com' });
+  }
+
+  return <button onClick={handleClick}>Click me</button>;
+}
+```
+
+#### `useFunnel(funnelName)`
+
+Returns a type-safe tracker for a specific funnel.
+
+**Parameters:**
+
+| Parameter    | Type                   | Required | Description                     |
+| ------------ | ---------------------- | -------- | ------------------------------- |
+| `funnelName` | `keyof TFunnelMapping` | Yes      | The name of the funnel to track |
+
+**Returns:**
+
+| Property | Type                                                                    | Description                   |
+| -------- | ----------------------------------------------------------------------- | ----------------------------- |
+| `track`  | `(stepName: FunnelStepName, properties?: FunnelStepProperties) => void` | Type-safe funnel step tracker |
+
+**Example:**
+
+```tsx
+type SignupFunnelMapping = {
+  signup: [
+    { name: 'signup_started'; properties: { source: string } },
+    { name: 'signup_completed'; properties: { userId: string } },
+  ];
+};
+
+function SignupPage() {
+  const { useFunnel } = useAltertable<SignupFunnelMapping>();
+  const { track } = useFunnel('signup');
+
+  function handleStart() {
+    track('Signup Started', { source: 'homepage' });
+  }
+
+  function handleComplete(userId: string) {
+    track('Signup Completed', { userId });
+  }
+
+  return (
+    <div>
+      <button onClick={() => handleStart()}>Start</button>
+      <button onClick={() => handleComplete('user123')}>Complete</button>
+    </div>
+  );
+}
+```
+
+## Types
+
+### `AltertableConfig`
+
+Configuration options for the Altertable SDK. See the [core SDK documentation](https://github.com/altertable-ai/altertable-js/blob/main/packages/altertable-js/README.md#altertableconfig) for full details.
+
+### `FunnelMapping`
+
+Type mapping of funnel names to their step definitions.
+
+```typescript
+type FunnelMapping = Record<FunnelName, readonly FunnelStep[]>;
+```
+
+**Example:**
+
+```typescript
+import { type FunnelMapping } from '@altertable/altertable-react';
+
+type MyFunnelMapping = {
+  signup: [
+    { name: 'signup_started'; properties: { source: string } },
+    { name: 'signup_completed'; properties: { userId: string } },
+  ];
+  checkout: [
+    { name: 'cart_viewed'; properties: { itemCount: number } },
+    {
+      name: 'purchase_completed';
+      properties: { orderId: string; amount: number };
+    },
+  ];
+} as const satisfies FunnelMapping;
+```
+
+### `FunnelStep`
+
+Definition of a single funnel step.
+
+```typescript
+type FunnelStep = {
+  name: string;
+  properties?: FunnelStepProperties;
+};
+```
+
+| Property     | Type                   | Required | Description                       |
+| ------------ | ---------------------- | -------- | --------------------------------- |
+| `name`       | `string`               | Yes      | The name of the funnel step       |
+| `properties` | `FunnelStepProperties` | No       | Expected properties for this step |
+
+### `FunnelTracker`
+
+Type-safe tracker for a specific funnel.
+
+```typescript
+type FunnelTracker = {
+  track: (stepName: FunnelStepName, properties?: FunnelStepProperties) => void;
+};
+```
+
+## License
+
+[MIT](./LICENSE)

package/dist/index.d.mts

@@ -7,22 +7,26 @@ interface AltertableProviderProps {
 }
 declare function AltertableProvider({ client, children, }: AltertableProviderProps): React.JSX.Element;
 
+type FunnelName = string;
 type FunnelStep = {
-    name: string;
-    properties: any;
+    name: FunnelName;
+    properties?: Record<string, any>;
 };
-type FunnelStepNames<T extends readonly FunnelStep[]> = T[number]['name'];
-type FunnelStepProperties<T extends readonly FunnelStep[], N extends FunnelStepNames<T>> = Extract<T[number], {
+type FunnelStepName<T extends readonly FunnelStep[]> = T[number]['name'];
+type FunnelStepProperties<T extends readonly FunnelStep[], N extends FunnelStepName<T>> = Extract<T[number], {
     name: N;
 }>['properties'];
-type FunnelMapping = Record<string, readonly FunnelStep[]>;
+type FunnelMapping = Record<FunnelName, readonly FunnelStep[]>;
 
 declare function useAltertable<T extends FunnelMapping>(): {
-    identify: (userId: string) => void;
-    track: <Steps extends T[keyof T] = T[keyof T]>(step: FunnelStepNames<Steps>, properties: FunnelStepProperties<Steps, typeof step>) => void;
+    configure: any;
+    getTrackingConsent: any;
+    identify: any;
+    track: <Steps extends T[keyof T] = T[keyof T]>(eventName: FunnelStepName<Steps>, properties?: FunnelStepProperties<Steps, typeof eventName>) => void;
+    updateTraits: any;
     useFunnel: <FunnelName extends keyof T>(_funnelName: FunnelName) => {
-        track: (step: FunnelStepNames<T[FunnelName]>, properties: FunnelStepProperties<T[FunnelName], FunnelStepNames<T[FunnelName]>>) => void;
+        track: (eventName: FunnelStepName<T[FunnelName]>, properties?: FunnelStepProperties<T[FunnelName], FunnelStepName<T[FunnelName]>>) => void;
     };
 };
 
-export { AltertableProvider, type FunnelMapping, type FunnelStep, type FunnelStepNames, type FunnelStepProperties, useAltertable };
+export { AltertableProvider, type FunnelMapping, type FunnelStep, type FunnelStepName, type FunnelStepProperties, useAltertable };

package/dist/index.d.ts

@@ -7,22 +7,26 @@ interface AltertableProviderProps {
 }
 declare function AltertableProvider({ client, children, }: AltertableProviderProps): React.JSX.Element;
 
+type FunnelName = string;
 type FunnelStep = {
-    name: string;
-    properties: any;
+    name: FunnelName;
+    properties?: Record<string, any>;
 };
-type FunnelStepNames<T extends readonly FunnelStep[]> = T[number]['name'];
-type FunnelStepProperties<T extends readonly FunnelStep[], N extends FunnelStepNames<T>> = Extract<T[number], {
+type FunnelStepName<T extends readonly FunnelStep[]> = T[number]['name'];
+type FunnelStepProperties<T extends readonly FunnelStep[], N extends FunnelStepName<T>> = Extract<T[number], {
     name: N;
 }>['properties'];
-type FunnelMapping = Record<string, readonly FunnelStep[]>;
+type FunnelMapping = Record<FunnelName, readonly FunnelStep[]>;
 
 declare function useAltertable<T extends FunnelMapping>(): {
-    identify: (userId: string) => void;
-    track: <Steps extends T[keyof T] = T[keyof T]>(step: FunnelStepNames<Steps>, properties: FunnelStepProperties<Steps, typeof step>) => void;
+    configure: any;
+    getTrackingConsent: any;
+    identify: any;
+    track: <Steps extends T[keyof T] = T[keyof T]>(eventName: FunnelStepName<Steps>, properties?: FunnelStepProperties<Steps, typeof eventName>) => void;
+    updateTraits: any;
     useFunnel: <FunnelName extends keyof T>(_funnelName: FunnelName) => {
-        track: (step: FunnelStepNames<T[FunnelName]>, properties: FunnelStepProperties<T[FunnelName], FunnelStepNames<T[FunnelName]>>) => void;
+        track: (eventName: FunnelStepName<T[FunnelName]>, properties?: FunnelStepProperties<T[FunnelName], FunnelStepName<T[FunnelName]>>) => void;
     };
 };
 
-export { AltertableProvider, type FunnelMapping, type FunnelStep, type FunnelStepNames, type FunnelStepProperties, useAltertable };
+export { AltertableProvider, type FunnelMapping, type FunnelStep, type FunnelStepName, type FunnelStepProperties, useAltertable };

package/dist/index.js

@@ -1,90 +1,3 @@
-var __create = Object.create;
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __getProtoOf = Object.getPrototypeOf;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __export = (target, all) => {
-  for (var name in all)
-    __defProp(target, name, { get: all[name], enumerable: true });
-};
-var __copyProps = (to, from, except, desc) => {
-  if (from && typeof from === "object" || typeof from === "function") {
-    for (let key of __getOwnPropNames(from))
-      if (!__hasOwnProp.call(to, key) && key !== except)
-        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
-  }
-  return to;
-};
-var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
-  // If the importer is in node compatibility mode or this is not an ESM
-  // file that has been converted to a CommonJS file using a Babel-
-  // compatible transform (i.e. "__esModule" has not been set), then set
-  // "default" to the CommonJS "module.exports" for node compatibility.
-  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
-  mod
-));
-var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-
-// src/index.ts
-var index_exports = {};
-__export(index_exports, {
-  AltertableProvider: () => AltertableProvider,
-  useAltertable: () => useAltertable
-});
-module.exports = __toCommonJS(index_exports);
-
-// src/AltertableProvider.tsx
-var import_altertable_js = require("@altertable/altertable-js");
-var import_react = __toESM(require("react"));
-var AltertableContext = (0, import_react.createContext)(import_altertable_js.altertable);
-AltertableContext.displayName = "AltertableContext";
-function AltertableProvider({
-  client,
-  children
-}) {
-  return /* @__PURE__ */ import_react.default.createElement(AltertableContext.Provider, { value: client }, children);
-}
-function useAltertableContext() {
-  return (0, import_react.useContext)(AltertableContext);
-}
-
-// src/useAltertable.ts
-var import_react2 = require("react");
-
-// src/constants.ts
-var PROPERTY_LIB = "$lib";
-var PROPERTY_LIB_VERSION = "$lib_version";
-
-// src/useAltertable.ts
-function useAltertable() {
-  const altertable2 = useAltertableContext();
-  const track = (0, import_react2.useCallback)(
-    (step, properties) => {
-      altertable2.track(step, {
-        ...properties,
-        // The React library needs to override the lib properties coming from
-        // the core library
-        [PROPERTY_LIB]: "@altertable/altertable-react",
-        [PROPERTY_LIB_VERSION]: "0.4.0"
-      });
-    },
-    [altertable2]
-  );
-  const useFunnel = (0, import_react2.useCallback)(
-    // eslint-disable-next-line @typescript-eslint/no-unused-vars
-    (_funnelName) => ({
-      track
-    }),
-    [track]
-  );
-  return (0, import_react2.useMemo)(
-    () => ({
-      identify: altertable2.identify,
-      track,
-      useFunnel
-    }),
-    [altertable2, track, useFunnel]
-  );
-}
+/*! @altertable/altertable-react 0.5.1 | MIT License | Altertable | https://github.com/altertable-ai/altertable-js */
+var x=Object.create;var i=Object.defineProperty;var P=Object.getOwnPropertyDescriptor;var _=Object.getOwnPropertyNames;var T=Object.getPrototypeOf,A=Object.prototype.hasOwnProperty;var N=(e,t)=>{for(var r in t)i(e,r,{get:t[r],enumerable:!0})},s=(e,t,r,l)=>{if(t&&typeof t=="object"||typeof t=="function")for(let n of _(t))!A.call(e,n)&&n!==r&&i(e,n,{get:()=>t[n],enumerable:!(l=P(t,n))||l.enumerable});return e};var R=(e,t,r)=>(r=e!=null?x(T(e)):{},s(t||!e||!e.__esModule?i(r,"default",{value:e,enumerable:!0}):r,e)),y=e=>s(i({},"__esModule",{value:!0}),e);var C={};N(C,{AltertableProvider:()=>m,useAltertable:()=>d});module.exports=y(C);var u=require("@altertable/altertable-js"),o=R(require("react")),p=(0,o.createContext)(u.altertable);p.displayName="AltertableContext";function m({client:e,children:t}){return o.default.createElement(p.Provider,{value:e},t)}function b(){return(0,o.useContext)(p)}var a=require("react");var c="$lib",f="$lib_version";function d(){let e=b(),t=(0,a.useCallback)((l,n={})=>{e.track(l,{...n,[c]:"@altertable/altertable-react",[f]:"0.5.1"})},[e]),r=(0,a.useCallback)(l=>({track:t}),[t]);return(0,a.useMemo)(()=>({configure:e.configure.bind(e),getTrackingConsent:e.getTrackingConsent.bind(e),identify:e.identify.bind(e),track:t,updateTraits:e.updateTraits.bind(e),useFunnel:r}),[e,t,r])}
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/index.ts","../src/AltertableProvider.tsx","../src/useAltertable.ts","../src/constants.ts"],"sourcesContent":["export { AltertableProvider } from './AltertableProvider';\nexport { useAltertable } from './useAltertable';\nexport type * from './types';\n","import { type Altertable, altertable } from '@altertable/altertable-js';\nimport React, { createContext, useContext, type ReactNode } from 'react';\n\nconst AltertableContext = createContext<Altertable>(altertable);\nAltertableContext.displayName = 'AltertableContext';\n\ninterface AltertableProviderProps {\n  client: Altertable;\n  children: ReactNode;\n}\n\nexport function AltertableProvider({\n  client,\n  children,\n}: AltertableProviderProps) {\n  // TODO: throw or warn when the client isn't initialized\n\n  return (\n    <AltertableContext.Provider value={client}>\n      {children}\n    </AltertableContext.Provider>\n  );\n}\n\nexport function useAltertableContext() {\n  return useContext(AltertableContext);\n}\n","import { useCallback, useMemo } from 'react';\n\nimport { useAltertableContext } from './AltertableProvider';\nimport { PROPERTY_LIB, PROPERTY_LIB_VERSION } from './constants';\nimport { FunnelMapping, FunnelStepNames, FunnelStepProperties } from './types';\n\nexport function useAltertable<T extends FunnelMapping>() {\n  const altertable = useAltertableContext();\n\n  const track = useCallback(\n    <Steps extends T[keyof T] = T[keyof T]>(\n      step: FunnelStepNames<Steps>,\n      properties: FunnelStepProperties<Steps, typeof step>\n    ) => {\n      altertable.track(step, {\n        ...properties,\n        // The React library needs to override the lib properties coming from\n        // the core library\n        [PROPERTY_LIB]: __LIB__,\n        [PROPERTY_LIB_VERSION]: __LIB_VERSION__,\n      });\n    },\n    [altertable]\n  );\n\n  const useFunnel = useCallback(\n    // eslint-disable-next-line @typescript-eslint/no-unused-vars\n    <FunnelName extends keyof T>(_funnelName: FunnelName) => ({\n      track: track<T[FunnelName]>,\n    }),\n    [track]\n  );\n\n  return useMemo(\n    () => ({\n      identify: altertable.identify,\n      track,\n      useFunnel,\n    }),\n    [altertable, track, useFunnel]\n  );\n}\n","export const PROPERTY_LIB = '$lib';\nexport const PROPERTY_LIB_VERSION = '$lib_version';\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACAA,2BAA4C;AAC5C,mBAAiE;AAEjE,IAAM,wBAAoB,4BAA0B,+BAAU;AAC9D,kBAAkB,cAAc;AAOzB,SAAS,mBAAmB;AAAA,EACjC;AAAA,EACA;AACF,GAA4B;AAG1B,SACE,6BAAAA,QAAA,cAAC,kBAAkB,UAAlB,EAA2B,OAAO,UAChC,QACH;AAEJ;AAEO,SAAS,uBAAuB;AACrC,aAAO,yBAAW,iBAAiB;AACrC;;;AC1BA,IAAAC,gBAAqC;;;ACA9B,IAAM,eAAe;AACrB,IAAM,uBAAuB;;;ADK7B,SAAS,gBAAyC;AACvD,QAAMC,cAAa,qBAAqB;AAExC,QAAM,YAAQ;AAAA,IACZ,CACE,MACA,eACG;AACH,MAAAA,YAAW,MAAM,MAAM;AAAA,QACrB,GAAG;AAAA;AAAA;AAAA,QAGH,CAAC,YAAY,GAAG;AAAA,QAChB,CAAC,oBAAoB,GAAG;AAAA,MAC1B,CAAC;AAAA,IACH;AAAA,IACA,CAACA,WAAU;AAAA,EACb;AAEA,QAAM,gBAAY;AAAA;AAAA,IAEhB,CAA6B,iBAA6B;AAAA,MACxD;AAAA,IACF;AAAA,IACA,CAAC,KAAK;AAAA,EACR;AAEA,aAAO;AAAA,IACL,OAAO;AAAA,MACL,UAAUA,YAAW;AAAA,MACrB;AAAA,MACA;AAAA,IACF;AAAA,IACA,CAACA,aAAY,OAAO,SAAS;AAAA,EAC/B;AACF;","names":["React","import_react","altertable"]}
+{"version":3,"sources":["../src/index.ts","../src/AltertableProvider.tsx","../src/useAltertable.ts","../src/constants.ts"],"sourcesContent":["export { AltertableProvider } from './AltertableProvider';\nexport type * from './types';\nexport { useAltertable } from './useAltertable';\n","import { type Altertable, altertable } from '@altertable/altertable-js';\nimport React, { createContext, type ReactNode, useContext } from 'react';\n\nconst AltertableContext = createContext<Altertable>(altertable);\nAltertableContext.displayName = 'AltertableContext';\n\ninterface AltertableProviderProps {\n  client: Altertable;\n  children: ReactNode;\n}\n\nexport function AltertableProvider({\n  client,\n  children,\n}: AltertableProviderProps) {\n  return (\n    <AltertableContext.Provider value={client}>\n      {children}\n    </AltertableContext.Provider>\n  );\n}\n\nexport function useAltertableContext() {\n  return useContext(AltertableContext);\n}\n","import { useCallback, useMemo } from 'react';\n\nimport { useAltertableContext } from './AltertableProvider';\nimport { PROPERTY_LIB, PROPERTY_LIB_VERSION } from './constants';\nimport { FunnelMapping, FunnelStepName, FunnelStepProperties } from './types';\n\nexport function useAltertable<T extends FunnelMapping>() {\n  const altertable = useAltertableContext();\n\n  const track = useCallback(\n    <Steps extends T[keyof T] = T[keyof T]>(\n      eventName: FunnelStepName<Steps>,\n      properties: FunnelStepProperties<Steps, typeof eventName> = {}\n    ) => {\n      altertable.track(eventName, {\n        ...properties,\n        // The React library needs to override the lib properties coming from\n        // the core library\n        [PROPERTY_LIB]: __LIB__,\n        [PROPERTY_LIB_VERSION]: __LIB_VERSION__,\n      });\n    },\n    [altertable]\n  );\n\n  const useFunnel = useCallback(\n    <FunnelName extends keyof T>(_funnelName: FunnelName) => ({\n      track: track<T[FunnelName]>,\n    }),\n    [track]\n  );\n\n  return useMemo(\n    () => ({\n      configure: altertable.configure.bind(altertable),\n      getTrackingConsent: altertable.getTrackingConsent.bind(altertable),\n      identify: altertable.identify.bind(altertable),\n      track,\n      updateTraits: altertable.updateTraits.bind(altertable),\n      useFunnel,\n    }),\n    [altertable, track, useFunnel]\n  );\n}\n","export const PROPERTY_LIB = '$lib';\nexport const PROPERTY_LIB_VERSION = '$lib_version';\n"],"mappings":";6iBAAA,IAAAA,EAAA,GAAAC,EAAAD,EAAA,wBAAAE,EAAA,kBAAAC,IAAA,eAAAC,EAAAJ,GCAA,IAAAK,EAA4C,qCAC5CC,EAAiE,oBAE3DC,KAAoB,iBAA0B,YAAU,EAC9DA,EAAkB,YAAc,oBAOzB,SAASC,EAAmB,CACjC,OAAAC,EACA,SAAAC,CACF,EAA4B,CAC1B,OACE,EAAAC,QAAA,cAACJ,EAAkB,SAAlB,CAA2B,MAAOE,GAChCC,CACH,CAEJ,CAEO,SAASE,GAAuB,CACrC,SAAO,cAAWL,CAAiB,CACrC,CCxBA,IAAAM,EAAqC,iBCA9B,IAAMC,EAAe,OACfC,EAAuB,eDK7B,SAASC,GAAyC,CACvD,IAAMC,EAAaC,EAAqB,EAElCC,KAAQ,eACZ,CACEC,EACAC,EAA4D,CAAC,IAC1D,CACHJ,EAAW,MAAMG,EAAW,CAC1B,GAAGC,EAGH,CAACC,CAAY,EAAG,+BAChB,CAACC,CAAoB,EAAG,OAC1B,CAAC,CACH,EACA,CAACN,CAAU,CACb,EAEMO,KAAY,eACaC,IAA6B,CACxD,MAAON,CACT,GACA,CAACA,CAAK,CACR,EAEA,SAAO,WACL,KAAO,CACL,UAAWF,EAAW,UAAU,KAAKA,CAAU,EAC/C,mBAAoBA,EAAW,mBAAmB,KAAKA,CAAU,EACjE,SAAUA,EAAW,SAAS,KAAKA,CAAU,EAC7C,MAAAE,EACA,aAAcF,EAAW,aAAa,KAAKA,CAAU,EACrD,UAAAO,CACF,GACA,CAACP,EAAYE,EAAOK,CAAS,CAC/B,CACF","names":["index_exports","__export","AltertableProvider","useAltertable","__toCommonJS","import_altertable_js","import_react","AltertableContext","AltertableProvider","client","children","React","useAltertableContext","import_react","PROPERTY_LIB","PROPERTY_LIB_VERSION","useAltertable","altertable","useAltertableContext","track","eventName","properties","PROPERTY_LIB","PROPERTY_LIB_VERSION","useFunnel","_funnelName"]}

package/dist/index.mjs

@@ -1,58 +1,3 @@
-// src/AltertableProvider.tsx
-import { altertable } from "@altertable/altertable-js";
-import React, { createContext, useContext } from "react";
-var AltertableContext = createContext(altertable);
-AltertableContext.displayName = "AltertableContext";
-function AltertableProvider({
-  client,
-  children
-}) {
-  return /* @__PURE__ */ React.createElement(AltertableContext.Provider, { value: client }, children);
-}
-function useAltertableContext() {
-  return useContext(AltertableContext);
-}
-
-// src/useAltertable.ts
-import { useCallback, useMemo } from "react";
-
-// src/constants.ts
-var PROPERTY_LIB = "$lib";
-var PROPERTY_LIB_VERSION = "$lib_version";
-
-// src/useAltertable.ts
-function useAltertable() {
-  const altertable2 = useAltertableContext();
-  const track = useCallback(
-    (step, properties) => {
-      altertable2.track(step, {
-        ...properties,
-        // The React library needs to override the lib properties coming from
-        // the core library
-        [PROPERTY_LIB]: "@altertable/altertable-react",
-        [PROPERTY_LIB_VERSION]: "0.4.0"
-      });
-    },
-    [altertable2]
-  );
-  const useFunnel = useCallback(
-    // eslint-disable-next-line @typescript-eslint/no-unused-vars
-    (_funnelName) => ({
-      track
-    }),
-    [track]
-  );
-  return useMemo(
-    () => ({
-      identify: altertable2.identify,
-      track,
-      useFunnel
-    }),
-    [altertable2, track, useFunnel]
-  );
-}
-export {
-  AltertableProvider,
-  useAltertable
-};
+/*! @altertable/altertable-react 0.5.1 | MIT License | Altertable | https://github.com/altertable-ai/altertable-js */
+import{altertable as u}from"@altertable/altertable-js";import m,{createContext as b,useContext as c}from"react";var r=b(u);r.displayName="AltertableContext";function f({client:e,children:t}){return m.createElement(r.Provider,{value:e},t)}function l(){return c(r)}import{useCallback as p,useMemo as d}from"react";var a="$lib",i="$lib_version";function x(){let e=l(),t=p((o,s={})=>{e.track(o,{...s,[a]:"@altertable/altertable-react",[i]:"0.5.1"})},[e]),n=p(o=>({track:t}),[t]);return d(()=>({configure:e.configure.bind(e),getTrackingConsent:e.getTrackingConsent.bind(e),identify:e.identify.bind(e),track:t,updateTraits:e.updateTraits.bind(e),useFunnel:n}),[e,t,n])}export{f as AltertableProvider,x as useAltertable};
 //# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/AltertableProvider.tsx","../src/useAltertable.ts","../src/constants.ts"],"sourcesContent":["import { type Altertable, altertable } from '@altertable/altertable-js';\nimport React, { createContext, useContext, type ReactNode } from 'react';\n\nconst AltertableContext = createContext<Altertable>(altertable);\nAltertableContext.displayName = 'AltertableContext';\n\ninterface AltertableProviderProps {\n  client: Altertable;\n  children: ReactNode;\n}\n\nexport function AltertableProvider({\n  client,\n  children,\n}: AltertableProviderProps) {\n  // TODO: throw or warn when the client isn't initialized\n\n  return (\n    <AltertableContext.Provider value={client}>\n      {children}\n    </AltertableContext.Provider>\n  );\n}\n\nexport function useAltertableContext() {\n  return useContext(AltertableContext);\n}\n","import { useCallback, useMemo } from 'react';\n\nimport { useAltertableContext } from './AltertableProvider';\nimport { PROPERTY_LIB, PROPERTY_LIB_VERSION } from './constants';\nimport { FunnelMapping, FunnelStepNames, FunnelStepProperties } from './types';\n\nexport function useAltertable<T extends FunnelMapping>() {\n  const altertable = useAltertableContext();\n\n  const track = useCallback(\n    <Steps extends T[keyof T] = T[keyof T]>(\n      step: FunnelStepNames<Steps>,\n      properties: FunnelStepProperties<Steps, typeof step>\n    ) => {\n      altertable.track(step, {\n        ...properties,\n        // The React library needs to override the lib properties coming from\n        // the core library\n        [PROPERTY_LIB]: __LIB__,\n        [PROPERTY_LIB_VERSION]: __LIB_VERSION__,\n      });\n    },\n    [altertable]\n  );\n\n  const useFunnel = useCallback(\n    // eslint-disable-next-line @typescript-eslint/no-unused-vars\n    <FunnelName extends keyof T>(_funnelName: FunnelName) => ({\n      track: track<T[FunnelName]>,\n    }),\n    [track]\n  );\n\n  return useMemo(\n    () => ({\n      identify: altertable.identify,\n      track,\n      useFunnel,\n    }),\n    [altertable, track, useFunnel]\n  );\n}\n","export const PROPERTY_LIB = '$lib';\nexport const PROPERTY_LIB_VERSION = '$lib_version';\n"],"mappings":";AAAA,SAA0B,kBAAkB;AAC5C,OAAO,SAAS,eAAe,kBAAkC;AAEjE,IAAM,oBAAoB,cAA0B,UAAU;AAC9D,kBAAkB,cAAc;AAOzB,SAAS,mBAAmB;AAAA,EACjC;AAAA,EACA;AACF,GAA4B;AAG1B,SACE,oCAAC,kBAAkB,UAAlB,EAA2B,OAAO,UAChC,QACH;AAEJ;AAEO,SAAS,uBAAuB;AACrC,SAAO,WAAW,iBAAiB;AACrC;;;AC1BA,SAAS,aAAa,eAAe;;;ACA9B,IAAM,eAAe;AACrB,IAAM,uBAAuB;;;ADK7B,SAAS,gBAAyC;AACvD,QAAMA,cAAa,qBAAqB;AAExC,QAAM,QAAQ;AAAA,IACZ,CACE,MACA,eACG;AACH,MAAAA,YAAW,MAAM,MAAM;AAAA,QACrB,GAAG;AAAA;AAAA;AAAA,QAGH,CAAC,YAAY,GAAG;AAAA,QAChB,CAAC,oBAAoB,GAAG;AAAA,MAC1B,CAAC;AAAA,IACH;AAAA,IACA,CAACA,WAAU;AAAA,EACb;AAEA,QAAM,YAAY;AAAA;AAAA,IAEhB,CAA6B,iBAA6B;AAAA,MACxD;AAAA,IACF;AAAA,IACA,CAAC,KAAK;AAAA,EACR;AAEA,SAAO;AAAA,IACL,OAAO;AAAA,MACL,UAAUA,YAAW;AAAA,MACrB;AAAA,MACA;AAAA,IACF;AAAA,IACA,CAACA,aAAY,OAAO,SAAS;AAAA,EAC/B;AACF;","names":["altertable"]}
+{"version":3,"sources":["../src/AltertableProvider.tsx","../src/useAltertable.ts","../src/constants.ts"],"sourcesContent":["import { type Altertable, altertable } from '@altertable/altertable-js';\nimport React, { createContext, type ReactNode, useContext } from 'react';\n\nconst AltertableContext = createContext<Altertable>(altertable);\nAltertableContext.displayName = 'AltertableContext';\n\ninterface AltertableProviderProps {\n  client: Altertable;\n  children: ReactNode;\n}\n\nexport function AltertableProvider({\n  client,\n  children,\n}: AltertableProviderProps) {\n  return (\n    <AltertableContext.Provider value={client}>\n      {children}\n    </AltertableContext.Provider>\n  );\n}\n\nexport function useAltertableContext() {\n  return useContext(AltertableContext);\n}\n","import { useCallback, useMemo } from 'react';\n\nimport { useAltertableContext } from './AltertableProvider';\nimport { PROPERTY_LIB, PROPERTY_LIB_VERSION } from './constants';\nimport { FunnelMapping, FunnelStepName, FunnelStepProperties } from './types';\n\nexport function useAltertable<T extends FunnelMapping>() {\n  const altertable = useAltertableContext();\n\n  const track = useCallback(\n    <Steps extends T[keyof T] = T[keyof T]>(\n      eventName: FunnelStepName<Steps>,\n      properties: FunnelStepProperties<Steps, typeof eventName> = {}\n    ) => {\n      altertable.track(eventName, {\n        ...properties,\n        // The React library needs to override the lib properties coming from\n        // the core library\n        [PROPERTY_LIB]: __LIB__,\n        [PROPERTY_LIB_VERSION]: __LIB_VERSION__,\n      });\n    },\n    [altertable]\n  );\n\n  const useFunnel = useCallback(\n    <FunnelName extends keyof T>(_funnelName: FunnelName) => ({\n      track: track<T[FunnelName]>,\n    }),\n    [track]\n  );\n\n  return useMemo(\n    () => ({\n      configure: altertable.configure.bind(altertable),\n      getTrackingConsent: altertable.getTrackingConsent.bind(altertable),\n      identify: altertable.identify.bind(altertable),\n      track,\n      updateTraits: altertable.updateTraits.bind(altertable),\n      useFunnel,\n    }),\n    [altertable, track, useFunnel]\n  );\n}\n","export const PROPERTY_LIB = '$lib';\nexport const PROPERTY_LIB_VERSION = '$lib_version';\n"],"mappings":";AAAA,OAA0B,cAAAA,MAAkB,4BAC5C,OAAOC,GAAS,iBAAAC,EAA+B,cAAAC,MAAkB,QAEjE,IAAMC,EAAoBF,EAA0BF,CAAU,EAC9DI,EAAkB,YAAc,oBAOzB,SAASC,EAAmB,CACjC,OAAAC,EACA,SAAAC,CACF,EAA4B,CAC1B,OACEN,EAAA,cAACG,EAAkB,SAAlB,CAA2B,MAAOE,GAChCC,CACH,CAEJ,CAEO,SAASC,GAAuB,CACrC,OAAOL,EAAWC,CAAiB,CACrC,CCxBA,OAAS,eAAAK,EAAa,WAAAC,MAAe,QCA9B,IAAMC,EAAe,OACfC,EAAuB,eDK7B,SAASC,GAAyC,CACvD,IAAMC,EAAaC,EAAqB,EAElCC,EAAQC,EACZ,CACEC,EACAC,EAA4D,CAAC,IAC1D,CACHL,EAAW,MAAMI,EAAW,CAC1B,GAAGC,EAGH,CAACC,CAAY,EAAG,+BAChB,CAACC,CAAoB,EAAG,OAC1B,CAAC,CACH,EACA,CAACP,CAAU,CACb,EAEMQ,EAAYL,EACaM,IAA6B,CACxD,MAAOP,CACT,GACA,CAACA,CAAK,CACR,EAEA,OAAOQ,EACL,KAAO,CACL,UAAWV,EAAW,UAAU,KAAKA,CAAU,EAC/C,mBAAoBA,EAAW,mBAAmB,KAAKA,CAAU,EACjE,SAAUA,EAAW,SAAS,KAAKA,CAAU,EAC7C,MAAAE,EACA,aAAcF,EAAW,aAAa,KAAKA,CAAU,EACrD,UAAAQ,CACF,GACA,CAACR,EAAYE,EAAOM,CAAS,CAC/B,CACF","names":["altertable","React","createContext","useContext","AltertableContext","AltertableProvider","client","children","useAltertableContext","useCallback","useMemo","PROPERTY_LIB","PROPERTY_LIB_VERSION","useAltertable","altertable","useAltertableContext","track","useCallback","eventName","properties","PROPERTY_LIB","PROPERTY_LIB_VERSION","useFunnel","_funnelName","useMemo"]}

package/package.json

@@ -1,65 +1,46 @@
 {
   "name": "@altertable/altertable-react",
-  "version": "0.4.0",
   "description": "React SDK to capture and send events to Altertable.",
-  "main": "dist/index.js",
-  "private": false,
-  "module": "dist/index.mjs",
-  "browser": "dist/index.global.js",
-  "typings": "dist/index.d.ts",
+  "version": "0.5.1",
+  "license": "MIT",
+  "homepage": "https://github.com/altertable-ai/altertable-js",
+  "repository": "altertable-ai/altertable-js",
+  "author": {
+    "name": "Altertable",
+    "url": "https://altertable.ai"
+  },
   "keywords": [
     "analytics",
     "track",
-    "react",
     "altertable"
   ],
-  "scripts": {
-    "dev": "rollup -c --configPlugin typescript --watch",
-    "clean": "rm -rf dist",
-    "lint": "eslint src --ext ts",
-    "build": "tsup",
-    "test": "vitest --environment=jsdom --watch=false",
-    "test:watch": "vitest --environment=jsdom"
-  },
   "files": [
     "dist"
   ],
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/altertable-ai/altertable-js"
+  "sideEffects": false,
+  "main": "dist/index.js",
+  "module": "dist/index.mjs",
+  "typings": "dist/index.d.ts",
+  "scripts": {
+    "dev": "tsup --watch --env.mode development",
+    "build": "tsup --env.mode production",
+    "clean": "rm -rf dist",
+    "typecheck": "tsc --noEmit",
+    "lint": "eslint src --ext ts",
+    "lint:fix": "bun run lint --fix",
+    "test": "vitest",
+    "test:watch": "vitest --watch"
   },
-  "author": "Altertable AI Team",
-  "license": "MIT",
-  "homepage": "https://github.com/altertable-ai/altertable-js#readme",
   "peerDependencies": {
     "react": "^16.8 || ^17.0 || ^18.0 || ^19.0"
   },
   "dependencies": {
-    "@altertable/altertable-js": "^0.4.0"
+    "@altertable/altertable-js": "^0.5.1"
   },
   "devDependencies": {
-    "@testing-library/dom": "^10.4.0",
-    "@testing-library/react": "^16.2.0",
-    "@types/node": "^22.13.0",
+    "@testing-library/react": "^16.3.0",
     "@types/react": "^19.0.8",
-    "@typescript-eslint/eslint-plugin": "^8.22.0",
-    "@typescript-eslint/parser": "^8.22.0",
-    "eslint": "^8.57.0",
-    "eslint-config-love": "^84.0.0",
-    "eslint-config-prettier": "^10.0.1",
-    "eslint-plugin-import": "^2.29.1",
-    "eslint-plugin-n": "^17.15.1",
-    "eslint-plugin-prettier": "^5.2.1",
-    "eslint-plugin-promise": "^7.2.1",
-    "jsdom": "^26.0.0",
-    "lint-staged": "^15.2.2",
-    "prettier": "3.5.0",
     "react": "^19.0.0",
-    "react-dom": "^19.0.0",
-    "ts-node": "^10.9.2",
-    "tslib": "^2.6.2",
-    "tsup": "^8.3.6",
-    "typescript": "^5.7.3",
-    "vitest": "^3.0.4"
+    "react-dom": "^19.0.0"
   }
 }