humanbehavior-js 0.0.1

package/dist/types/index.d.ts

@@ -0,0 +1,63 @@
+declare global {
+    interface Window {
+        HumanBehaviorTracker: typeof HumanBehaviorTracker;
+    }
+}
+declare class HumanBehaviorTracker {
+    private eventIngestionQueue;
+    private queueSizeBytes;
+    private rejectedEvents;
+    private isProcessingRejectedEvents;
+    private sessionId;
+    private userProperties;
+    private isProcessing;
+    private flushInterval;
+    private readonly FLUSH_INTERVAL_MS;
+    private api;
+    private endUserId;
+    private apiKey;
+    private initialized;
+    initializationPromise: Promise<void> | null;
+    constructor(apiKey: string);
+    private init;
+    private ensureInitialized;
+    static logToStorage(message: string): void;
+    private setupPageUnloadHandler;
+    viewLogs(): void;
+    identifyUser(userProperties: Record<string, any>): Promise<void>;
+    customEvent(eventName: string, eventProperties?: Record<string, any>): Promise<void>;
+    start(): Promise<void>;
+    stop(): Promise<void>;
+    addEvent(event: any): Promise<void>;
+    private processRejectedEvents;
+    private flush;
+    private setCookie;
+    private getCookie;
+}
+
+declare const MAX_CHUNK_SIZE_BYTES: number;
+declare function isChunkSizeExceeded(currentChunk: any[], newEvent: any, sessionId: string): boolean;
+declare function validateSingleEventSize(event: any, sessionId: string): void;
+declare class HumanBehaviorAPI {
+    private apiKey;
+    private baseUrl;
+    constructor({ apiKey }: {
+        apiKey: string;
+    });
+    init(sessionId: string, userId: string | null): Promise<{
+        sessionId: any;
+        endUserId: any;
+    }>;
+    sendEvents(events: any[], sessionId: string, userId: string): Promise<void>;
+    sendEventsChunked(events: any[], sessionId: string): Promise<any[]>;
+    sendUserData(userId: string, userData: Record<string, any>, sessionId: string): Promise<any>;
+    sendSessionComplete(sessionId: string): Promise<void>;
+    sendCustomEvent(eventName: string, eventProperties: Record<string, any>, sessionId: string): Promise<any>;
+    sendCustomEvents(events: any[], sessionId: string): Promise<any>;
+    sendBeaconEvents(events: any[], sessionId: string, isSessionComplete?: boolean): void;
+    sendBeaconSessionComplete(sessionId: string): void;
+    sendBeaconCustomEvent(eventName: string, eventProperties: Record<string, any>, sessionId: string): boolean;
+    sendBeaconCustomEvents(events: any[], sessionId: string): boolean;
+}
+
+export { HumanBehaviorAPI, HumanBehaviorTracker, MAX_CHUNK_SIZE_BYTES, HumanBehaviorTracker as default, isChunkSizeExceeded, validateSingleEventSize };

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

@@ -0,0 +1,19 @@
+import React, { ReactNode } from 'react';
+import { HumanBehaviorTracker } from '..';
+
+interface HumanBehaviorInterface {
+    addEvent: (event: any) => void;
+    identifyUser: (userProperties: Record<string, any>) => Promise<void>;
+    start: () => void;
+    stop: () => void;
+    viewLogs: () => void;
+}
+interface HumanBehaviorProviderProps {
+    apiKey?: string;
+    client?: HumanBehaviorTracker;
+    children: ReactNode;
+}
+declare const HumanBehaviorProvider: ({ apiKey, client, children }: HumanBehaviorProviderProps) => React.JSX.Element;
+declare const useHumanBehavior: () => HumanBehaviorInterface;
+
+export { HumanBehaviorProvider, useHumanBehavior };

package/index.d.ts

@@ -0,0 +1,2 @@
+// This file is auto-generated. Do not edit directly.
+export * from "./dist/types/index";

package/index.js

@@ -0,0 +1,3 @@
+// This file is auto-generated. Do not edit directly.
+export * from './dist/esm/index.js';
+export { default } from './dist/esm/index.js'; 

package/package.json

@@ -0,0 +1,71 @@
+{
+  "name": "humanbehavior-js",
+  "version": "0.0.1",
+  "description": "SDK for HumanBehavior session and event recording",
+  "type": "module",
+  "main": "./dist/cjs/index.js",
+  "module": "./dist/esm/index.js",
+  "types": "./dist/types/index.d.ts",
+  "unpkg": "dist/index.min.js",
+  "files": [
+    "dist",
+    "react.js",
+    "react.d.ts",
+    "index.js",
+    "index.d.ts"
+  ],
+  "exports": {
+    ".": {
+      "import": "./dist/esm/index.js",
+      "require": "./dist/cjs/index.js",
+      "types": "./dist/types/index.d.ts"
+    },
+    "./react": {
+      "import": "./dist/esm/react/index.js",
+      "require": "./dist/cjs/react/index.js",
+      "types": "./dist/types/react/index.d.ts"
+    }
+  },
+  "scripts": {
+    "build": "rollup -c",
+    "build:dev": "rollup -c --environment NODE_ENV:development",
+    "prepare": "npm run build",
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "author": "Chirag Kawediya, Skyler Ji, Amogh Chaturvedi",
+  "license": "ISC",
+  "dependencies": {
+    "@types/react": "^19.0.12",
+    "react": "^19.0.0",
+    "rrweb": "^2.0.0-alpha.4",
+    "uuid": "^11.1.0"
+  },
+  "devDependencies": {
+    "@rollup/plugin-commonjs": "^28.0.3",
+    "@rollup/plugin-node-resolve": "^16.0.1",
+    "@rollup/plugin-terser": "^0.4.4",
+    "@rollup/plugin-typescript": "^12.1.2",
+    "@types/cors": "^2.8.17",
+    "@types/express": "^5.0.1",
+    "rollup": "^4.36.0",
+    "rollup-plugin-dts": "^6.2.1",
+    "ts-loader": "^9.5.2",
+    "tslib": "^2.8.1",
+    "typescript": "^5.8.2",
+    "webpack": "^5.98.0",
+    "webpack-cli": "^6.0.1"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/humanbehavior-gh/HumanBehavior.git"
+  },
+  "keywords": [
+    "session-recording",
+    "analytics",
+    "rrweb",
+    "koalaware"
+  ]
+}

package/react.d.ts

@@ -0,0 +1,2 @@
+// This file is auto-generated. Do not edit directly.
+export * from "./dist/types/react/index";

package/react.js

@@ -0,0 +1,2 @@
+// This file is auto-generated. Do not edit directly.
+export * from './dist/esm/react/index.js'; 

package/readme.md

@@ -0,0 +1,57 @@
+To build, run `npm run build`
+
+
+Usage:
+
+NextJS
+
+Add the following to your `providers.tsx` file.
+```ts
+"use client"
+
+import { KoalawareTracker } from "koalaware-js";
+import { KoalawareProvider as KoalawareProviderJS } from "koalaware-js/react";
+import { useEffect, useState } from "react";
+
+export function KoalawareProvider({ children }: { children: React.ReactNode }) {
+    const [koalaware, setKoalaware] = useState<KoalawareTracker | null>(null);
+
+    useEffect(() => {
+        const apiKey = "kw_1c8969a408ea2eb333fd174a7684c7c943e82ea1df8349b43640e4b608f35e68";
+        const koalaware = new KoalawareTracker(apiKey);
+        setKoalaware(koalaware);
+    }, []);
+
+    return (
+        <KoalawareProviderJS client={koalaware}>
+            {children}
+        </KoalawareProviderJS>  
+    )
+}
+```
+
+Next, add the provider to your root app layout.
+```ts
+export default async function RootLayout({
+  children
+}: {
+  children: React.ReactNode;
+}) {
+  const session = await auth();
+  return (
+    <html lang='en' className={`${lato.className}`} suppressHydrationWarning>
+      <body className={'overflow-hidden'}>
+        <NextTopLoader showSpinner={false} />
+        <KoalawareProvider>
+          <NuqsAdapter>
+            <Providers session={session}>
+              <Toaster />
+              {children}
+            </Providers>
+          </NuqsAdapter>
+        </KoalawareProvider>
+      </body>
+    </html>
+  );
+}
+```