ml-cache 1.0.0

package/dist/constants.d.ts

@@ -0,0 +1,184 @@
+/**
+ * @fileoverview Constants and default values for ml-cache SDK
+ * @module ml-cache/constants
+ */
+import type { BatchConfig, RetryConfig, LogConfig, S3StorageClass } from './types';
+/**
+ * Current SDK version
+ * @constant
+ */
+export declare const SDK_VERSION = "1.0.0";
+/**
+ * SDK name identifier
+ * @constant
+ */
+export declare const SDK_NAME = "ml-cache";
+/**
+ * Default batch configuration
+ * @constant
+ */
+export declare const DEFAULT_BATCH_CONFIG: BatchConfig;
+/**
+ * Default retry configuration
+ * @constant
+ */
+export declare const DEFAULT_RETRY_CONFIG: RetryConfig;
+/**
+ * Default logging configuration
+ * @constant
+ */
+export declare const DEFAULT_LOG_CONFIG: LogConfig;
+/**
+ * Default S3 storage class for long-term ML data storage
+ * @constant
+ */
+export declare const DEFAULT_S3_STORAGE_CLASS: S3StorageClass;
+/**
+ * Default Glacier account ID (uses current account)
+ * @constant
+ */
+export declare const DEFAULT_GLACIER_ACCOUNT_ID = "-";
+/**
+ * Maximum size of a single event payload in bytes (256 KB)
+ * @constant
+ */
+export declare const MAX_EVENT_SIZE_BYTES: number;
+/**
+ * Maximum size of a batch payload in bytes (5 MB for S3 PutObject)
+ * @constant
+ */
+export declare const MAX_BATCH_SIZE_BYTES: number;
+/**
+ * Minimum size for S3 multipart upload (5 MB)
+ * @constant
+ */
+export declare const S3_MULTIPART_THRESHOLD_BYTES: number;
+/**
+ * Glacier archive description prefix
+ * @constant
+ */
+export declare const GLACIER_ARCHIVE_PREFIX = "ml-cache-events";
+/**
+ * S3 object key date format
+ * @constant
+ */
+export declare const S3_KEY_DATE_FORMAT = "YYYY/MM/DD";
+/**
+ * Default S3 object prefix
+ * @constant
+ */
+export declare const DEFAULT_S3_PREFIX = "ml-cache-events";
+/**
+ * Reserved event property names that cannot be overwritten
+ * @constant
+ */
+export declare const RESERVED_EVENT_PROPERTIES: readonly string[];
+/**
+ * Valid event type pattern (alphanumeric with underscores)
+ * @constant
+ */
+export declare const EVENT_TYPE_PATTERN: RegExp;
+/**
+ * Maximum event type length
+ * @constant
+ */
+export declare const MAX_EVENT_TYPE_LENGTH = 128;
+/**
+ * Maximum property key length
+ * @constant
+ */
+export declare const MAX_PROPERTY_KEY_LENGTH = 256;
+/**
+ * Health check interval in milliseconds (5 minutes)
+ * @constant
+ */
+export declare const HEALTH_CHECK_INTERVAL_MS: number;
+/**
+ * Connection timeout in milliseconds (30 seconds)
+ * @constant
+ */
+export declare const CONNECTION_TIMEOUT_MS = 30000;
+/**
+ * Request timeout in milliseconds (2 minutes)
+ * @constant
+ */
+export declare const REQUEST_TIMEOUT_MS: number;
+/**
+ * Shutdown grace period in milliseconds (10 seconds)
+ * @constant
+ */
+export declare const SHUTDOWN_GRACE_PERIOD_MS = 10000;
+/**
+ * SDK error codes
+ * @constant
+ */
+export declare const ERROR_CODES: {
+    /** Configuration error */
+    readonly CONFIG_ERROR: "ML_CACHE_CONFIG_ERROR";
+    /** Validation error */
+    readonly VALIDATION_ERROR: "ML_CACHE_VALIDATION_ERROR";
+    /** S3 storage error */
+    readonly S3_ERROR: "ML_CACHE_S3_ERROR";
+    /** Glacier storage error */
+    readonly GLACIER_ERROR: "ML_CACHE_GLACIER_ERROR";
+    /** Network error */
+    readonly NETWORK_ERROR: "ML_CACHE_NETWORK_ERROR";
+    /** Timeout error */
+    readonly TIMEOUT_ERROR: "ML_CACHE_TIMEOUT_ERROR";
+    /** Queue full error */
+    readonly QUEUE_FULL_ERROR: "ML_CACHE_QUEUE_FULL_ERROR";
+    /** Event too large error */
+    readonly EVENT_TOO_LARGE_ERROR: "ML_CACHE_EVENT_TOO_LARGE_ERROR";
+    /** Batch error */
+    readonly BATCH_ERROR: "ML_CACHE_BATCH_ERROR";
+    /** Shutdown error */
+    readonly SHUTDOWN_ERROR: "ML_CACHE_SHUTDOWN_ERROR";
+    /** Unknown error */
+    readonly UNKNOWN_ERROR: "ML_CACHE_UNKNOWN_ERROR";
+};
+/**
+ * Error code type
+ * @typedef ErrorCode
+ */
+export type ErrorCode = (typeof ERROR_CODES)[keyof typeof ERROR_CODES];
+/**
+ * Maximum queue size (number of events)
+ * @constant
+ */
+export declare const MAX_QUEUE_SIZE = 10000;
+/**
+ * Queue warning threshold (80% of max)
+ * @constant
+ */
+export declare const QUEUE_WARNING_THRESHOLD = 0.8;
+/**
+ * Content type for stored events (NDJSON)
+ * @constant
+ */
+export declare const CONTENT_TYPE_NDJSON = "application/x-ndjson";
+/**
+ * Content type for compressed events
+ * @constant
+ */
+export declare const CONTENT_TYPE_GZIP = "application/gzip";
+/**
+ * Environment variable names for configuration
+ * @constant
+ */
+export declare const ENV_VARS: {
+    /** AWS access key ID */
+    readonly AWS_ACCESS_KEY_ID: "AWS_ACCESS_KEY_ID";
+    /** AWS secret access key */
+    readonly AWS_SECRET_ACCESS_KEY: "AWS_SECRET_ACCESS_KEY";
+    /** AWS session token */
+    readonly AWS_SESSION_TOKEN: "AWS_SESSION_TOKEN";
+    /** AWS region */
+    readonly AWS_REGION: "AWS_REGION";
+    /** S3 bucket name */
+    readonly ML_CACHE_S3_BUCKET: "ML_CACHE_S3_BUCKET";
+    /** Glacier vault name */
+    readonly ML_CACHE_GLACIER_VAULT: "ML_CACHE_GLACIER_VAULT";
+    /** Debug mode */
+    readonly ML_CACHE_DEBUG: "ML_CACHE_DEBUG";
+};
+//# sourceMappingURL=constants.d.ts.map

package/dist/constants.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,WAAW,EAAE,WAAW,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,SAAS,CAAC;AAMnF;;;GAGG;AACH,eAAO,MAAM,WAAW,UAAU,CAAC;AAEnC;;;GAGG;AACH,eAAO,MAAM,QAAQ,aAAa,CAAC;AAMnC;;;GAGG;AACH,eAAO,MAAM,oBAAoB,EAAE,WAOlC,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,oBAAoB,EAAE,WASlC,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,kBAAkB,EAAE,SAOhC,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,wBAAwB,EAAE,cAA0B,CAAC;AAElE;;;GAGG;AACH,eAAO,MAAM,0BAA0B,MAAM,CAAC;AAM9C;;;GAGG;AACH,eAAO,MAAM,oBAAoB,QAAa,CAAC;AAE/C;;;GAGG;AACH,eAAO,MAAM,oBAAoB,QAAkB,CAAC;AAEpD;;;GAGG;AACH,eAAO,MAAM,4BAA4B,QAAkB,CAAC;AAE5D;;;GAGG;AACH,eAAO,MAAM,sBAAsB,oBAAoB,CAAC;AAExD;;;GAGG;AACH,eAAO,MAAM,kBAAkB,eAAe,CAAC;AAE/C;;;GAGG;AACH,eAAO,MAAM,iBAAiB,oBAAoB,CAAC;AAMnD;;;GAGG;AACH,eAAO,MAAM,yBAAyB,EAAE,SAAS,MAAM,EAK7C,CAAC;AAEX;;;GAGG;AACH,eAAO,MAAM,kBAAkB,QAA4B,CAAC;AAE5D;;;GAGG;AACH,eAAO,MAAM,qBAAqB,MAAM,CAAC;AAEzC;;;GAGG;AACH,eAAO,MAAM,uBAAuB,MAAM,CAAC;AAM3C;;;GAGG;AACH,eAAO,MAAM,wBAAwB,QAAgB,CAAC;AAEtD;;;GAGG;AACH,eAAO,MAAM,qBAAqB,QAAQ,CAAC;AAE3C;;;GAGG;AACH,eAAO,MAAM,kBAAkB,QAAgB,CAAC;AAEhD;;;GAGG;AACH,eAAO,MAAM,wBAAwB,QAAQ,CAAC;AAM9C;;;GAGG;AACH,eAAO,MAAM,WAAW;IACtB,0BAA0B;;IAE1B,uBAAuB;;IAEvB,uBAAuB;;IAEvB,4BAA4B;;IAE5B,oBAAoB;;IAEpB,oBAAoB;;IAEpB,uBAAuB;;IAEvB,4BAA4B;;IAE5B,kBAAkB;;IAElB,qBAAqB;;IAErB,oBAAoB;;CAEZ,CAAC;AAEX;;;GAGG;AACH,MAAM,MAAM,SAAS,GAAG,CAAC,OAAO,WAAW,CAAC,CAAC,MAAM,OAAO,WAAW,CAAC,CAAC;AAMvE;;;GAGG;AACH,eAAO,MAAM,cAAc,QAAQ,CAAC;AAEpC;;;GAGG;AACH,eAAO,MAAM,uBAAuB,MAAM,CAAC;AAM3C;;;GAGG;AACH,eAAO,MAAM,mBAAmB,yBAAyB,CAAC;AAE1D;;;GAGG;AACH,eAAO,MAAM,iBAAiB,qBAAqB,CAAC;AAMpD;;;GAGG;AACH,eAAO,MAAM,QAAQ;IACnB,wBAAwB;;IAExB,4BAA4B;;IAE5B,wBAAwB;;IAExB,iBAAiB;;IAEjB,qBAAqB;;IAErB,yBAAyB;;IAEzB,iBAAiB;;CAET,CAAC"}

package/dist/constants.js

@@ -0,0 +1,236 @@
+"use strict";
+/**
+ * @fileoverview Constants and default values for ml-cache SDK
+ * @module ml-cache/constants
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ENV_VARS = exports.CONTENT_TYPE_GZIP = exports.CONTENT_TYPE_NDJSON = exports.QUEUE_WARNING_THRESHOLD = exports.MAX_QUEUE_SIZE = exports.ERROR_CODES = exports.SHUTDOWN_GRACE_PERIOD_MS = exports.REQUEST_TIMEOUT_MS = exports.CONNECTION_TIMEOUT_MS = exports.HEALTH_CHECK_INTERVAL_MS = exports.MAX_PROPERTY_KEY_LENGTH = exports.MAX_EVENT_TYPE_LENGTH = exports.EVENT_TYPE_PATTERN = exports.RESERVED_EVENT_PROPERTIES = exports.DEFAULT_S3_PREFIX = exports.S3_KEY_DATE_FORMAT = exports.GLACIER_ARCHIVE_PREFIX = exports.S3_MULTIPART_THRESHOLD_BYTES = exports.MAX_BATCH_SIZE_BYTES = exports.MAX_EVENT_SIZE_BYTES = exports.DEFAULT_GLACIER_ACCOUNT_ID = exports.DEFAULT_S3_STORAGE_CLASS = exports.DEFAULT_LOG_CONFIG = exports.DEFAULT_RETRY_CONFIG = exports.DEFAULT_BATCH_CONFIG = exports.SDK_NAME = exports.SDK_VERSION = void 0;
+/* ============================================================================
+ * SDK Information
+ * ============================================================================ */
+/**
+ * Current SDK version
+ * @constant
+ */
+exports.SDK_VERSION = '1.0.0';
+/**
+ * SDK name identifier
+ * @constant
+ */
+exports.SDK_NAME = 'ml-cache';
+/* ============================================================================
+ * Default Configurations
+ * ============================================================================ */
+/**
+ * Default batch configuration
+ * @constant
+ */
+exports.DEFAULT_BATCH_CONFIG = {
+    /** Maximum 100 events per batch */
+    maxSize: 100,
+    /** Flush every 30 seconds */
+    maxWaitMs: 30000,
+    /** Batching enabled by default */
+    enabled: true,
+};
+/**
+ * Default retry configuration
+ * @constant
+ */
+exports.DEFAULT_RETRY_CONFIG = {
+    /** Maximum 3 retry attempts */
+    maxRetries: 3,
+    /** Start with 1 second delay */
+    initialDelayMs: 1000,
+    /** Maximum 30 second delay */
+    maxDelayMs: 30000,
+    /** Use exponential backoff */
+    exponentialBackoff: true,
+};
+/**
+ * Default logging configuration
+ * @constant
+ */
+exports.DEFAULT_LOG_CONFIG = {
+    /** Default to info level */
+    level: 'info',
+    /** Logging enabled by default */
+    enabled: true,
+    /** No custom logger by default */
+    customLogger: undefined,
+};
+/**
+ * Default S3 storage class for long-term ML data storage
+ * @constant
+ */
+exports.DEFAULT_S3_STORAGE_CLASS = 'GLACIER';
+/**
+ * Default Glacier account ID (uses current account)
+ * @constant
+ */
+exports.DEFAULT_GLACIER_ACCOUNT_ID = '-';
+/* ============================================================================
+ * Storage Constants
+ * ============================================================================ */
+/**
+ * Maximum size of a single event payload in bytes (256 KB)
+ * @constant
+ */
+exports.MAX_EVENT_SIZE_BYTES = 256 * 1024;
+/**
+ * Maximum size of a batch payload in bytes (5 MB for S3 PutObject)
+ * @constant
+ */
+exports.MAX_BATCH_SIZE_BYTES = 5 * 1024 * 1024;
+/**
+ * Minimum size for S3 multipart upload (5 MB)
+ * @constant
+ */
+exports.S3_MULTIPART_THRESHOLD_BYTES = 5 * 1024 * 1024;
+/**
+ * Glacier archive description prefix
+ * @constant
+ */
+exports.GLACIER_ARCHIVE_PREFIX = 'ml-cache-events';
+/**
+ * S3 object key date format
+ * @constant
+ */
+exports.S3_KEY_DATE_FORMAT = 'YYYY/MM/DD';
+/**
+ * Default S3 object prefix
+ * @constant
+ */
+exports.DEFAULT_S3_PREFIX = 'ml-cache-events';
+/* ============================================================================
+ * Event Constants
+ * ============================================================================ */
+/**
+ * Reserved event property names that cannot be overwritten
+ * @constant
+ */
+exports.RESERVED_EVENT_PROPERTIES = [
+    'eventId',
+    'timestamp',
+    'eventType',
+    'metadata',
+];
+/**
+ * Valid event type pattern (alphanumeric with underscores)
+ * @constant
+ */
+exports.EVENT_TYPE_PATTERN = /^[a-zA-Z][a-zA-Z0-9_]*$/;
+/**
+ * Maximum event type length
+ * @constant
+ */
+exports.MAX_EVENT_TYPE_LENGTH = 128;
+/**
+ * Maximum property key length
+ * @constant
+ */
+exports.MAX_PROPERTY_KEY_LENGTH = 256;
+/* ============================================================================
+ * Timing Constants
+ * ============================================================================ */
+/**
+ * Health check interval in milliseconds (5 minutes)
+ * @constant
+ */
+exports.HEALTH_CHECK_INTERVAL_MS = 5 * 60 * 1000;
+/**
+ * Connection timeout in milliseconds (30 seconds)
+ * @constant
+ */
+exports.CONNECTION_TIMEOUT_MS = 30000;
+/**
+ * Request timeout in milliseconds (2 minutes)
+ * @constant
+ */
+exports.REQUEST_TIMEOUT_MS = 2 * 60 * 1000;
+/**
+ * Shutdown grace period in milliseconds (10 seconds)
+ * @constant
+ */
+exports.SHUTDOWN_GRACE_PERIOD_MS = 10000;
+/* ============================================================================
+ * Error Codes
+ * ============================================================================ */
+/**
+ * SDK error codes
+ * @constant
+ */
+exports.ERROR_CODES = {
+    /** Configuration error */
+    CONFIG_ERROR: 'ML_CACHE_CONFIG_ERROR',
+    /** Validation error */
+    VALIDATION_ERROR: 'ML_CACHE_VALIDATION_ERROR',
+    /** S3 storage error */
+    S3_ERROR: 'ML_CACHE_S3_ERROR',
+    /** Glacier storage error */
+    GLACIER_ERROR: 'ML_CACHE_GLACIER_ERROR',
+    /** Network error */
+    NETWORK_ERROR: 'ML_CACHE_NETWORK_ERROR',
+    /** Timeout error */
+    TIMEOUT_ERROR: 'ML_CACHE_TIMEOUT_ERROR',
+    /** Queue full error */
+    QUEUE_FULL_ERROR: 'ML_CACHE_QUEUE_FULL_ERROR',
+    /** Event too large error */
+    EVENT_TOO_LARGE_ERROR: 'ML_CACHE_EVENT_TOO_LARGE_ERROR',
+    /** Batch error */
+    BATCH_ERROR: 'ML_CACHE_BATCH_ERROR',
+    /** Shutdown error */
+    SHUTDOWN_ERROR: 'ML_CACHE_SHUTDOWN_ERROR',
+    /** Unknown error */
+    UNKNOWN_ERROR: 'ML_CACHE_UNKNOWN_ERROR',
+};
+/* ============================================================================
+ * Queue Constants
+ * ============================================================================ */
+/**
+ * Maximum queue size (number of events)
+ * @constant
+ */
+exports.MAX_QUEUE_SIZE = 10000;
+/**
+ * Queue warning threshold (80% of max)
+ * @constant
+ */
+exports.QUEUE_WARNING_THRESHOLD = 0.8;
+/* ============================================================================
+ * Content Types
+ * ============================================================================ */
+/**
+ * Content type for stored events (NDJSON)
+ * @constant
+ */
+exports.CONTENT_TYPE_NDJSON = 'application/x-ndjson';
+/**
+ * Content type for compressed events
+ * @constant
+ */
+exports.CONTENT_TYPE_GZIP = 'application/gzip';
+/* ============================================================================
+ * Environment Variables
+ * ============================================================================ */
+/**
+ * Environment variable names for configuration
+ * @constant
+ */
+exports.ENV_VARS = {
+    /** AWS access key ID */
+    AWS_ACCESS_KEY_ID: 'AWS_ACCESS_KEY_ID',
+    /** AWS secret access key */
+    AWS_SECRET_ACCESS_KEY: 'AWS_SECRET_ACCESS_KEY',
+    /** AWS session token */
+    AWS_SESSION_TOKEN: 'AWS_SESSION_TOKEN',
+    /** AWS region */
+    AWS_REGION: 'AWS_REGION',
+    /** S3 bucket name */
+    ML_CACHE_S3_BUCKET: 'ML_CACHE_S3_BUCKET',
+    /** Glacier vault name */
+    ML_CACHE_GLACIER_VAULT: 'ML_CACHE_GLACIER_VAULT',
+    /** Debug mode */
+    ML_CACHE_DEBUG: 'ML_CACHE_DEBUG',
+};
+//# sourceMappingURL=constants.js.map

package/dist/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAIH;;kFAEkF;AAElF;;;GAGG;AACU,QAAA,WAAW,GAAG,OAAO,CAAC;AAEnC;;;GAGG;AACU,QAAA,QAAQ,GAAG,UAAU,CAAC;AAEnC;;kFAEkF;AAElF;;;GAGG;AACU,QAAA,oBAAoB,GAAgB;IAC/C,mCAAmC;IACnC,OAAO,EAAE,GAAG;IACZ,6BAA6B;IAC7B,SAAS,EAAE,KAAK;IAChB,kCAAkC;IAClC,OAAO,EAAE,IAAI;CACd,CAAC;AAEF;;;GAGG;AACU,QAAA,oBAAoB,GAAgB;IAC/C,+BAA+B;IAC/B,UAAU,EAAE,CAAC;IACb,gCAAgC;IAChC,cAAc,EAAE,IAAI;IACpB,8BAA8B;IAC9B,UAAU,EAAE,KAAK;IACjB,8BAA8B;IAC9B,kBAAkB,EAAE,IAAI;CACzB,CAAC;AAEF;;;GAGG;AACU,QAAA,kBAAkB,GAAc;IAC3C,4BAA4B;IAC5B,KAAK,EAAE,MAAM;IACb,iCAAiC;IACjC,OAAO,EAAE,IAAI;IACb,kCAAkC;IAClC,YAAY,EAAE,SAAS;CACxB,CAAC;AAEF;;;GAGG;AACU,QAAA,wBAAwB,GAAmB,SAAS,CAAC;AAElE;;;GAGG;AACU,QAAA,0BAA0B,GAAG,GAAG,CAAC;AAE9C;;kFAEkF;AAElF;;;GAGG;AACU,QAAA,oBAAoB,GAAG,GAAG,GAAG,IAAI,CAAC;AAE/C;;;GAGG;AACU,QAAA,oBAAoB,GAAG,CAAC,GAAG,IAAI,GAAG,IAAI,CAAC;AAEpD;;;GAGG;AACU,QAAA,4BAA4B,GAAG,CAAC,GAAG,IAAI,GAAG,IAAI,CAAC;AAE5D;;;GAGG;AACU,QAAA,sBAAsB,GAAG,iBAAiB,CAAC;AAExD;;;GAGG;AACU,QAAA,kBAAkB,GAAG,YAAY,CAAC;AAE/C;;;GAGG;AACU,QAAA,iBAAiB,GAAG,iBAAiB,CAAC;AAEnD;;kFAEkF;AAElF;;;GAGG;AACU,QAAA,yBAAyB,GAAsB;IAC1D,SAAS;IACT,WAAW;IACX,WAAW;IACX,UAAU;CACF,CAAC;AAEX;;;GAGG;AACU,QAAA,kBAAkB,GAAG,yBAAyB,CAAC;AAE5D;;;GAGG;AACU,QAAA,qBAAqB,GAAG,GAAG,CAAC;AAEzC;;;GAGG;AACU,QAAA,uBAAuB,GAAG,GAAG,CAAC;AAE3C;;kFAEkF;AAElF;;;GAGG;AACU,QAAA,wBAAwB,GAAG,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC;AAEtD;;;GAGG;AACU,QAAA,qBAAqB,GAAG,KAAK,CAAC;AAE3C;;;GAGG;AACU,QAAA,kBAAkB,GAAG,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC;AAEhD;;;GAGG;AACU,QAAA,wBAAwB,GAAG,KAAK,CAAC;AAE9C;;kFAEkF;AAElF;;;GAGG;AACU,QAAA,WAAW,GAAG;IACzB,0BAA0B;IAC1B,YAAY,EAAE,uBAAuB;IACrC,uBAAuB;IACvB,gBAAgB,EAAE,2BAA2B;IAC7C,uBAAuB;IACvB,QAAQ,EAAE,mBAAmB;IAC7B,4BAA4B;IAC5B,aAAa,EAAE,wBAAwB;IACvC,oBAAoB;IACpB,aAAa,EAAE,wBAAwB;IACvC,oBAAoB;IACpB,aAAa,EAAE,wBAAwB;IACvC,uBAAuB;IACvB,gBAAgB,EAAE,2BAA2B;IAC7C,4BAA4B;IAC5B,qBAAqB,EAAE,gCAAgC;IACvD,kBAAkB;IAClB,WAAW,EAAE,sBAAsB;IACnC,qBAAqB;IACrB,cAAc,EAAE,yBAAyB;IACzC,oBAAoB;IACpB,aAAa,EAAE,wBAAwB;CAC/B,CAAC;AAQX;;kFAEkF;AAElF;;;GAGG;AACU,QAAA,cAAc,GAAG,KAAK,CAAC;AAEpC;;;GAGG;AACU,QAAA,uBAAuB,GAAG,GAAG,CAAC;AAE3C;;kFAEkF;AAElF;;;GAGG;AACU,QAAA,mBAAmB,GAAG,sBAAsB,CAAC;AAE1D;;;GAGG;AACU,QAAA,iBAAiB,GAAG,kBAAkB,CAAC;AAEpD;;kFAEkF;AAElF;;;GAGG;AACU,QAAA,QAAQ,GAAG;IACtB,wBAAwB;IACxB,iBAAiB,EAAE,mBAAmB;IACtC,4BAA4B;IAC5B,qBAAqB,EAAE,uBAAuB;IAC9C,wBAAwB;IACxB,iBAAiB,EAAE,mBAAmB;IACtC,iBAAiB;IACjB,UAAU,EAAE,YAAY;IACxB,qBAAqB;IACrB,kBAAkB,EAAE,oBAAoB;IACxC,yBAAyB;IACzB,sBAAsB,EAAE,wBAAwB;IAChD,iBAAiB;IACjB,cAAc,EAAE,gBAAgB;CACxB,CAAC"}

package/dist/esm/client.d.ts

@@ -0,0 +1,175 @@
+/**
+ * @fileoverview Main ML Cache SDK client
+ * @module ml-cache/client
+ */
+import type { MLCacheConfig, MLCacheEvent, TrackResult, FlushResult, HealthStatus, EventCallback, ErrorCallback, FlushCallback } from './types';
+/**
+ * ML Cache SDK client for collecting and storing events for future ML training
+ * @class MLCacheClient
+ * @example
+ * ```typescript
+ * const client = new MLCacheClient({
+ *   credentials: {
+ *     accessKeyId: 'YOUR_ACCESS_KEY',
+ *     secretAccessKey: 'YOUR_SECRET_KEY',
+ *   },
+ *   s3: {
+ *     bucket: 'my-ml-data-bucket',
+ *     region: 'us-east-1',
+ *   },
+ *   storageMode: 'S3',
+ * });
+ *
+ * await client.track({
+ *   eventType: 'purchase',
+ *   properties: {
+ *     productId: '12345',
+ *     amount: 99.99,
+ *   },
+ * });
+ * ```
+ */
+export declare class MLCacheClient {
+    /** @private */
+    private config;
+    /** @private */
+    private batchConfig;
+    /** @private */
+    private retryConfig;
+    /** @private */
+    private logger;
+    /** @private */
+    private s3Storage;
+    /** @private */
+    private glacierStorage;
+    /** @private */
+    private queue;
+    /** @private */
+    private isInitialized;
+    /** @private */
+    private isShuttingDown;
+    /** @private */
+    private lastFlush;
+    /** @private */
+    private lastError;
+    /** @private */
+    private eventCallbacks;
+    /** @private */
+    private errorCallbacks;
+    /** @private */
+    private flushCallbacks;
+    /**
+     * Creates a new MLCacheClient instance
+     * @param {MLCacheConfig} config - SDK configuration
+     * @throws {ValidationError} If configuration is invalid
+     */
+    constructor(config: MLCacheConfig);
+    /**
+     * Initializes storage providers based on configuration
+     * @private
+     */
+    private initializeStorage;
+    /**
+     * Handles a batch of events ready for storage
+     * @private
+     * @param {MLCacheEvent[]} events - Events to store
+     * @param {string} batchId - Batch identifier
+     */
+    private handleBatchReady;
+    /**
+     * Stores events with retry logic
+     * @private
+     * @param {MLCacheEvent[]} events - Events to store
+     * @param {string} batchId - Batch identifier
+     * @returns {Promise<FlushResult>} Flush result
+     */
+    private storeEventsWithRetry;
+    /**
+     * Tracks an event
+     * @param {MLCacheEvent} event - Event to track
+     * @returns {Promise<TrackResult>} Track result
+     * @example
+     * ```typescript
+     * const result = await client.track({
+     *   eventType: 'page_view',
+     *   properties: {
+     *     page: '/home',
+     *     referrer: 'google.com',
+     *   },
+     *   context: {
+     *     user: { userId: 'user123' },
+     *   },
+     * });
+     * ```
+     */
+    track(event: MLCacheEvent): Promise<TrackResult>;
+    /**
+     * Identifies a user with traits
+     * @param {string} userId - User identifier
+     * @param {Record<string, unknown>} [traits] - User traits
+     * @returns {Promise<TrackResult>} Track result
+     * @example
+     * ```typescript
+     * await client.identify('user123', {
+     *   email: 'user@example.com',
+     *   plan: 'premium',
+     * });
+     * ```
+     */
+    identify(userId: string, traits?: Record<string, unknown>): Promise<TrackResult>;
+    /**
+     * Tracks a page view
+     * @param {string} name - Page name
+     * @param {Record<string, unknown>} [properties] - Page properties
+     * @returns {Promise<TrackResult>} Track result
+     * @example
+     * ```typescript
+     * await client.page('Home', {
+     *   url: 'https://example.com',
+     *   title: 'Welcome Home',
+     * });
+     * ```
+     */
+    page(name: string, properties?: Record<string, unknown>): Promise<TrackResult>;
+    /**
+     * Flushes all queued events
+     * @returns {Promise<FlushResult>} Flush result
+     */
+    flush(): Promise<FlushResult>;
+    /**
+     * Gets the health status of the client
+     * @returns {Promise<HealthStatus>} Health status
+     */
+    getHealth(): Promise<HealthStatus>;
+    /**
+     * Registers an event callback
+     * @param {EventCallback} callback - Callback function
+     */
+    onEvent(callback: EventCallback): void;
+    /**
+     * Registers an error callback
+     * @param {ErrorCallback} callback - Callback function
+     */
+    onError(callback: ErrorCallback): void;
+    /**
+     * Registers a flush callback
+     * @param {FlushCallback} callback - Callback function
+     */
+    onFlush(callback: FlushCallback): void;
+    /**
+     * Gets the current queue size
+     * @returns {number} Queue size
+     */
+    getQueueSize(): number;
+    /**
+     * Gets the SDK version
+     * @returns {string} SDK version
+     */
+    getVersion(): string;
+    /**
+     * Shuts down the client gracefully
+     * @returns {Promise<void>}
+     */
+    shutdown(): Promise<void>;
+}
+//# sourceMappingURL=client.d.ts.map

package/dist/esm/client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../src/client.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EACV,aAAa,EACb,YAAY,EACZ,WAAW,EACX,WAAW,EACX,YAAY,EACZ,aAAa,EACb,aAAa,EACb,aAAa,EAId,MAAM,SAAS,CAAC;AAoBjB;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,qBAAa,aAAa;IACxB,eAAe;IACf,OAAO,CAAC,MAAM,CAAgB;IAE9B,eAAe;IACf,OAAO,CAAC,WAAW,CAAc;IAEjC,eAAe;IACf,OAAO,CAAC,WAAW,CAAc;IAEjC,eAAe;IACf,OAAO,CAAC,MAAM,CAAS;IAEvB,eAAe;IACf,OAAO,CAAC,SAAS,CAA0B;IAE3C,eAAe;IACf,OAAO,CAAC,cAAc,CAA+B;IAErD,eAAe;IACf,OAAO,CAAC,KAAK,CAAa;IAE1B,eAAe;IACf,OAAO,CAAC,aAAa,CAAS;IAE9B,eAAe;IACf,OAAO,CAAC,cAAc,CAAS;IAE/B,eAAe;IACf,OAAO,CAAC,SAAS,CAAqB;IAEtC,eAAe;IACf,OAAO,CAAC,SAAS,CAAuB;IAExC,eAAe;IACf,OAAO,CAAC,cAAc,CAAuB;IAE7C,eAAe;IACf,OAAO,CAAC,cAAc,CAAuB;IAE7C,eAAe;IACf,OAAO,CAAC,cAAc,CAAuB;IAE7C;;;;OAIG;gBACS,MAAM,EAAE,aAAa;IA2BjC;;;OAGG;IACH,OAAO,CAAC,iBAAiB;IAyBzB;;;;;OAKG;YACW,gBAAgB;IAa9B;;;;;;OAMG;YACW,oBAAoB;IAoGlC;;;;;;;;;;;;;;;;;OAiBG;IACG,KAAK,CAAC,KAAK,EAAE,YAAY,GAAG,OAAO,CAAC,WAAW,CAAC;IAwDtD;;;;;;;;;;;;OAYG;IACG,QAAQ,CACZ,MAAM,EAAE,MAAM,EACd,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAC/B,OAAO,CAAC,WAAW,CAAC;IAavB;;;;;;;;;;;;OAYG;IACG,IAAI,CACR,IAAI,EAAE,MAAM,EACZ,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GACnC,OAAO,CAAC,WAAW,CAAC;IAUvB;;;OAGG;IACG,KAAK,IAAI,OAAO,CAAC,WAAW,CAAC;IAuBnC;;;OAGG;IACG,SAAS,IAAI,OAAO,CAAC,YAAY,CAAC;IAwBxC;;;OAGG;IACH,OAAO,CAAC,QAAQ,EAAE,aAAa,GAAG,IAAI;IAItC;;;OAGG;IACH,OAAO,CAAC,QAAQ,EAAE,aAAa,GAAG,IAAI;IAItC;;;OAGG;IACH,OAAO,CAAC,QAAQ,EAAE,aAAa,GAAG,IAAI;IAItC;;;OAGG;IACH,YAAY,IAAI,MAAM;IAItB;;;OAGG;IACH,UAAU,IAAI,MAAM;IAIpB;;;OAGG;IACG,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC;CAmBhC"}