@klime/node 1.0.3 → 1.2.1

package/dist/index.d.cts

@@ -0,0 +1,110 @@
+interface Logger {
+    debug(message: string, ...args: any[]): void;
+    info(message: string, ...args: any[]): void;
+    warn(message: string, ...args: any[]): void;
+    error(message: string, ...args: any[]): void;
+}
+interface KlimeConfig {
+    writeKey: string;
+    endpoint?: string;
+    flushInterval?: number;
+    maxBatchSize?: number;
+    maxQueueSize?: number;
+    retryMaxAttempts?: number;
+    retryInitialDelay?: number;
+    flushOnShutdown?: boolean;
+    logger?: Logger;
+    onError?: (error: Error, events: Event[]) => void;
+    onSuccess?: (response: BatchResponse) => void;
+}
+interface TrackOptions {
+    userId?: string;
+    groupId?: string;
+}
+interface IdentifyOptions {
+}
+interface GroupOptions {
+    userId?: string;
+}
+interface Event {
+    type: 'track' | 'identify' | 'group';
+    messageId: string;
+    event?: string;
+    userId?: string;
+    groupId?: string;
+    timestamp: string;
+    properties?: Record<string, any>;
+    traits?: Record<string, any>;
+    context?: EventContext;
+}
+interface EventContext {
+    library?: {
+        name: string;
+        version: string;
+    };
+}
+interface BatchResponse {
+    status: string;
+    accepted: number;
+    failed: number;
+    errors?: ValidationError[];
+}
+interface ValidationError {
+    index: number;
+    message: string;
+    code: string;
+}
+declare class SendError extends Error {
+    events: Event[];
+    constructor(message: string, events: Event[]);
+}
+
+declare class KlimeClient {
+    private config;
+    private queue;
+    private flushTimer;
+    private isShutdown;
+    private flushPromise;
+    private shutdownHandlers;
+    constructor(config: KlimeConfig);
+    track(event: string, properties?: Record<string, any>, options?: TrackOptions): void;
+    identify(userId: string, traits?: Record<string, any>, options?: IdentifyOptions): void;
+    group(groupId: string, traits?: Record<string, any>, options?: GroupOptions): void;
+    /**
+     * Track an event synchronously. Returns BatchResponse or throws SendError.
+     */
+    trackSync(event: string, properties?: Record<string, any>, options?: TrackOptions): Promise<BatchResponse>;
+    /**
+     * Identify a user synchronously. Returns BatchResponse or throws SendError.
+     */
+    identifySync(userId: string, traits?: Record<string, any>, options?: IdentifyOptions): Promise<BatchResponse>;
+    /**
+     * Associate a user with a group synchronously. Returns BatchResponse or throws SendError.
+     */
+    groupSync(groupId: string, traits?: Record<string, any>, options?: GroupOptions): Promise<BatchResponse>;
+    /**
+     * Return the number of events currently in the queue.
+     */
+    getQueueSize(): number;
+    flush(): Promise<void>;
+    shutdown(): Promise<void>;
+    private enqueue;
+    private doFlush;
+    private extractBatch;
+    private sendBatch;
+    private sendSync;
+    private doSend;
+    private doSendWithFetch;
+    private doSendWithHttps;
+    private invokeOnError;
+    private invokeOnSuccess;
+    private makeRequest;
+    private scheduleFlush;
+    private generateUUID;
+    private generateTimestamp;
+    private getContext;
+    private estimateEventSize;
+    private sleep;
+}
+
+export { type BatchResponse, type Event, type GroupOptions, type IdentifyOptions, KlimeClient, type KlimeConfig, type Logger, SendError, type TrackOptions };

package/dist/index.d.ts

@@ -1,5 +1,65 @@
-import { KlimeConfig, TrackOptions, IdentifyOptions, GroupOptions } from "./types";
-export declare class KlimeClient {
+interface Logger {
+    debug(message: string, ...args: any[]): void;
+    info(message: string, ...args: any[]): void;
+    warn(message: string, ...args: any[]): void;
+    error(message: string, ...args: any[]): void;
+}
+interface KlimeConfig {
+    writeKey: string;
+    endpoint?: string;
+    flushInterval?: number;
+    maxBatchSize?: number;
+    maxQueueSize?: number;
+    retryMaxAttempts?: number;
+    retryInitialDelay?: number;
+    flushOnShutdown?: boolean;
+    logger?: Logger;
+    onError?: (error: Error, events: Event[]) => void;
+    onSuccess?: (response: BatchResponse) => void;
+}
+interface TrackOptions {
+    userId?: string;
+    groupId?: string;
+}
+interface IdentifyOptions {
+}
+interface GroupOptions {
+    userId?: string;
+}
+interface Event {
+    type: 'track' | 'identify' | 'group';
+    messageId: string;
+    event?: string;
+    userId?: string;
+    groupId?: string;
+    timestamp: string;
+    properties?: Record<string, any>;
+    traits?: Record<string, any>;
+    context?: EventContext;
+}
+interface EventContext {
+    library?: {
+        name: string;
+        version: string;
+    };
+}
+interface BatchResponse {
+    status: string;
+    accepted: number;
+    failed: number;
+    errors?: ValidationError[];
+}
+interface ValidationError {
+    index: number;
+    message: string;
+    code: string;
+}
+declare class SendError extends Error {
+    events: Event[];
+    constructor(message: string, events: Event[]);
+}
+
+declare class KlimeClient {
     private config;
     private queue;
     private flushTimer;
@@ -10,14 +70,34 @@ export declare class KlimeClient {
     track(event: string, properties?: Record<string, any>, options?: TrackOptions): void;
     identify(userId: string, traits?: Record<string, any>, options?: IdentifyOptions): void;
     group(groupId: string, traits?: Record<string, any>, options?: GroupOptions): void;
+    /**
+     * Track an event synchronously. Returns BatchResponse or throws SendError.
+     */
+    trackSync(event: string, properties?: Record<string, any>, options?: TrackOptions): Promise<BatchResponse>;
+    /**
+     * Identify a user synchronously. Returns BatchResponse or throws SendError.
+     */
+    identifySync(userId: string, traits?: Record<string, any>, options?: IdentifyOptions): Promise<BatchResponse>;
+    /**
+     * Associate a user with a group synchronously. Returns BatchResponse or throws SendError.
+     */
+    groupSync(groupId: string, traits?: Record<string, any>, options?: GroupOptions): Promise<BatchResponse>;
+    /**
+     * Return the number of events currently in the queue.
+     */
+    getQueueSize(): number;
     flush(): Promise<void>;
     shutdown(): Promise<void>;
     private enqueue;
     private doFlush;
     private extractBatch;
     private sendBatch;
-    private sendBatchWithFetch;
-    private sendBatchWithHttps;
+    private sendSync;
+    private doSend;
+    private doSendWithFetch;
+    private doSendWithHttps;
+    private invokeOnError;
+    private invokeOnSuccess;
     private makeRequest;
     private scheduleFlush;
     private generateUUID;
@@ -26,3 +106,5 @@ export declare class KlimeClient {
     private estimateEventSize;
     private sleep;
 }
+
+export { type BatchResponse, type Event, type GroupOptions, type IdentifyOptions, KlimeClient, type KlimeConfig, type Logger, SendError, type TrackOptions };