@chirpier/chirpier-js 0.1.1 → 0.1.2

package/dist/__tests__/sdk.test.d.ts

@@ -1,5 +1,2 @@
-/**
- * @jest-environment jsdom
- */
 export {};
 //# sourceMappingURL=sdk.test.d.ts.map

package/dist/__tests__/sdk.test.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"sdk.test.d.ts","sourceRoot":"","sources":["../../src/__tests__/sdk.test.ts"],"names":[],"mappings":"AAAA;;GAEG"}
+{"version":3,"file":"sdk.test.d.ts","sourceRoot":"","sources":["../../src/__tests__/sdk.test.ts"],"names":[],"mappings":""}

package/dist/__tests__/sdk.test.js

@@ -1,7 +1,4 @@
 "use strict";
-/**
- * @jest-environment jsdom
- */
 var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
     function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
     return new (P || (P = Promise))(function (resolve, reject) {
@@ -47,6 +44,8 @@ var constants_1 = require("../constants");
 var axios_mock_adapter_1 = __importDefault(require("axios-mock-adapter"));
 var axios_1 = __importDefault(require("axios"));
 var server_1 = require("./mocks/server");
+var uuid_1 = require("@lukeed/uuid");
+jest.mock("@lukeed/uuid");
 describe("Chirpier SDK", function () {
     var chirpier;
     afterEach(function () {
@@ -88,10 +87,17 @@ describe("Chirpier SDK", function () {
             mock.onPost(constants_1.DEFAULT_API_ENDPOINT).reply(200, { success: true });
             expect(function () { return new index_1.Chirpier({}); }).toThrow(index_1.ChirpierError);
         });
+        test("should throw error if key is not a valid JWT", function () {
+            expect(function () { return (0, index_1.initialize)({ key: "invalid_key" }); }).toThrow(index_1.ChirpierError);
+        });
+        test("should initialize successfully with a valid JWT", function () {
+            var validJWT = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c";
+            expect(function () { return (0, index_1.initialize)({ key: validJWT }); }).not.toThrow();
+        });
     });
     describe("monitor", function () {
         test("event should be sent", function () { return __awaiter(void 0, void 0, void 0, function () {
-            var mock, event;
+            var mock, validJWT, event;
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
@@ -100,6 +106,8 @@ describe("Chirpier SDK", function () {
                         });
                         mock = new axios_mock_adapter_1.default(axios_1.default);
                         mock.onPost(constants_1.DEFAULT_API_ENDPOINT).reply(200, { success: true });
+                        validJWT = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c";
+                        (0, index_1.initialize)({ key: validJWT });
                         event = {
                             group_id: "f3438ee9-b964-48aa-b938-a803df440a3c",
                             stream: "test-stream",
@@ -108,7 +116,9 @@ describe("Chirpier SDK", function () {
                         return [4 /*yield*/, chirpier.monitor(event)];
                     case 1:
                         _a.sent();
-                        // Verify that the event was sent successfully
+                        return [4 /*yield*/, new Promise(function (resolve) { return setTimeout(resolve, 1000); })];
+                    case 2:
+                        _a.sent(); // Wait for flush
                         expect(mock.history.post.length).toBe(1);
                         expect(mock.history.post[0].url).toBe(constants_1.DEFAULT_API_ENDPOINT);
                         expect(JSON.parse(mock.history.post[0].data)).toEqual([
@@ -116,7 +126,6 @@ describe("Chirpier SDK", function () {
                                 group_id: "f3438ee9-b964-48aa-b938-a803df440a3c",
                                 stream: "test-stream",
                                 value: 1,
-                                event_id: expect.any(String),
                             },
                         ]);
                         // Clean up the mock
@@ -125,11 +134,8 @@ describe("Chirpier SDK", function () {
                 }
             });
         }); });
-        // Setup mock server
-        var mock = new axios_mock_adapter_1.default(axios_1.default);
-        mock.onPost(constants_1.DEFAULT_API_ENDPOINT).reply(200, { success: true });
         test("should throw error for invalid event", function () { return __awaiter(void 0, void 0, void 0, function () {
-            var invalidEvent;
+            var invalidEvent, mock;
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
@@ -142,7 +148,110 @@ describe("Chirpier SDK", function () {
                         return [4 /*yield*/, expect(chirpier.monitor(invalidEvent)).rejects.toThrow(index_1.ChirpierError)];
                     case 1:
                         _a.sent();
-                        // Clean up the mock
+                        mock = new axios_mock_adapter_1.default(axios_1.default);
+                        mock.reset();
+                        return [2 /*return*/];
+                }
+            });
+        }); });
+        test("should batch events and flush when batch size is reached", function () { return __awaiter(void 0, void 0, void 0, function () {
+            var mock, validJWT, event;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        mock = new axios_mock_adapter_1.default(axios_1.default);
+                        mock.onPost(constants_1.DEFAULT_API_ENDPOINT).reply(200, { success: true });
+                        validJWT = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c";
+                        (0, index_1.initialize)({ key: validJWT, batchSize: 2 });
+                        event = {
+                            group_id: "f3438ee9-b964-48aa-b938-a803df440a3c",
+                            stream: "test-stream",
+                            value: 1,
+                        };
+                        (0, index_1.monitor)(event);
+                        (0, index_1.monitor)(event);
+                        return [4 /*yield*/, new Promise(function (resolve) { return setTimeout(resolve, 100); })];
+                    case 1:
+                        _a.sent(); // Wait for flush
+                        expect(mock.history.post.length).toBe(1);
+                        expect(JSON.parse(mock.history.post[0].data).length).toBe(2);
+                        mock.reset();
+                        return [2 /*return*/];
+                }
+            });
+        }); });
+        test("should flush events after interval", function () { return __awaiter(void 0, void 0, void 0, function () {
+            var mock, validJWT, event;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        mock = new axios_mock_adapter_1.default(axios_1.default);
+                        mock.onPost(constants_1.DEFAULT_API_ENDPOINT).reply(200, { success: true });
+                        validJWT = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c";
+                        (0, index_1.initialize)({ key: validJWT, flushInterval: 100 });
+                        event = {
+                            group_id: "f3438ee9-b964-48aa-b938-a803df440a3c",
+                            stream: "test-stream",
+                            value: 1,
+                        };
+                        (0, index_1.monitor)(event);
+                        return [4 /*yield*/, new Promise(function (resolve) { return setTimeout(resolve, 1000); })];
+                    case 1:
+                        _a.sent(); // Wait for flush
+                        expect(mock.history.post.length).toBe(1);
+                        expect(JSON.parse(mock.history.post[0].data).length).toBe(1);
+                        mock.reset();
+                        return [2 /*return*/];
+                }
+            });
+        }); });
+        test("should use provided event_id if available", function () { return __awaiter(void 0, void 0, void 0, function () {
+            var mock, validJWT, event;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        mock = new axios_mock_adapter_1.default(axios_1.default);
+                        mock.onPost(constants_1.DEFAULT_API_ENDPOINT).reply(200, { success: true });
+                        validJWT = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c";
+                        (0, index_1.initialize)({ key: validJWT });
+                        event = {
+                            group_id: "f3438ee9-b964-48aa-b938-a803df440a3c",
+                            stream: "test-stream",
+                            value: 1,
+                            event_id: "f3438ee9-b964-48aa-b938-a803df440a3c",
+                        };
+                        (0, index_1.monitor)(event);
+                        return [4 /*yield*/, new Promise(function (resolve) { return setTimeout(resolve, 1000); })];
+                    case 1:
+                        _a.sent(); // Wait for flush
+                        expect(mock.history.post.length).toBe(1);
+                        expect(JSON.parse(mock.history.post[0].data)[0].event_id).toBe("f3438ee9-b964-48aa-b938-a803df440a3c");
+                        mock.reset();
+                        return [2 /*return*/];
+                }
+            });
+        }); });
+        test("should generate event_id if not provided", function () { return __awaiter(void 0, void 0, void 0, function () {
+            var mock, validJWT, event;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        mock = new axios_mock_adapter_1.default(axios_1.default);
+                        mock.onPost(constants_1.DEFAULT_API_ENDPOINT).reply(200, { success: true });
+                        uuid_1.v4.mockReturnValue("generated-uuid");
+                        validJWT = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c";
+                        (0, index_1.initialize)({ key: validJWT });
+                        event = {
+                            group_id: "f3438ee9-b964-48aa-b938-a803df440a3c",
+                            stream: "test-stream",
+                            value: 1,
+                        };
+                        (0, index_1.monitor)(event);
+                        return [4 /*yield*/, new Promise(function (resolve) { return setTimeout(resolve, 1000); })];
+                    case 1:
+                        _a.sent(); // Wait for flush
+                        expect(mock.history.post.length).toBe(1);
+                        expect(JSON.parse(mock.history.post[0].data)[0].event_id).toBe("generated-uuid");
                         mock.reset();
                         return [2 /*return*/];
                 }

package/dist/index.d.ts

@@ -3,6 +3,8 @@ interface Options {
     apiEndpoint?: string;
     retries?: number;
     timeout?: number;
+    batchSize?: number;
+    flushInterval?: number;
 }
 export interface Event {
     group_id: string;
@@ -22,11 +24,15 @@ export declare class Chirpier {
     private readonly retries;
     private readonly timeout;
     private readonly axiosInstance;
+    private eventQueue;
+    private flushTimeout;
+    private readonly batchSize;
+    private readonly flushInterval;
     /**
      * Initializes a new instance of the Chirpier class.
      * @param options - Configuration options for the SDK.
      */
-    constructor({ key, apiEndpoint, retries, timeout, }: Options);
+    constructor({ key, apiEndpoint, retries, timeout, batchSize, flushInterval, }: Options);
     /**
      * Validates the event structure.
      * @param event - The event to validate.
@@ -34,15 +40,14 @@ export declare class Chirpier {
      */
     private isValidEvent;
     /**
-     * Monitors an event by sending it to the API or storing it for retry.
+     * Monitors an event by adding it to the queue and scheduling a flush if necessary.
      * @param event - The event to monitor.
      */
     monitor(event: Event): Promise<void>;
     /**
-     * Sends an event to the API.
-     * @param event - The event to send.
+     * Flushes the event queue by sending all events to the API.
      */
-    private sendEvent;
+    private flushQueue;
     /**
      * Sends multiple events to the API in a batch.
      * @param events - The array of events to send.

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAYA,UAAU,OAAO;IACf,GAAG,EAAE,MAAM,CAAC;IACZ,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAGD,MAAM,WAAW,KAAK;IACpB,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAGD,qBAAa,aAAc,SAAQ,KAAK;gBAC1B,OAAO,EAAE,MAAM;CAK5B;AAED;;GAEG;AACH,qBAAa,QAAQ;IACnB,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAS;IAChC,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAS;IACrC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAS;IACjC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAS;IACjC,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAgB;IAE9C;;;OAGG;gBACS,EACV,GAAG,EACH,WAAkC,EAClC,OAAyB,EACzB,OAAyB,GAC1B,EAAE,OAAO;IAuCV;;;;OAIG;IACH,OAAO,CAAC,YAAY;IAUpB;;;OAGG;IACU,OAAO,CAAC,KAAK,EAAE,KAAK,GAAG,OAAO,CAAC,IAAI,CAAC;IAkBjD;;;OAGG;YACW,SAAS;IAIvB;;;OAGG;YACW,UAAU;CAGzB;AAwCD;;;GAGG;AACH,wBAAgB,UAAU,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI,CAkBjD;AAED;;;GAGG;AACH,wBAAgB,OAAO,CAAC,KAAK,EAAE,KAAK,GAAG,IAAI,CAS1C"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAYA,UAAU,OAAO;IACf,GAAG,EAAE,MAAM,CAAC;IACZ,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAGD,MAAM,WAAW,KAAK;IACpB,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAGD,qBAAa,aAAc,SAAQ,KAAK;gBAC1B,OAAO,EAAE,MAAM;CAK5B;AAED;;GAEG;AACH,qBAAa,QAAQ;IACnB,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAS;IAChC,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAS;IACrC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAS;IACjC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAS;IACjC,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAgB;IAC9C,OAAO,CAAC,UAAU,CAAe;IACjC,OAAO,CAAC,YAAY,CAA+B;IACnD,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAS;IACnC,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAS;IAEvC;;;OAGG;gBACS,EACV,GAAG,EACH,WAAkC,EAClC,OAAyB,EACzB,OAAyB,EACzB,SAAe,EACf,aAAmB,GACpB,EAAE,OAAO;IAyCV;;;;OAIG;IACH,OAAO,CAAC,YAAY;IAapB;;;OAGG;IACU,OAAO,CAAC,KAAK,EAAE,KAAK,GAAG,OAAO,CAAC,IAAI,CAAC;IA0BjD;;OAEG;YACW,UAAU;IA6BxB;;;OAGG;YACW,UAAU;CAGzB;AAwCD;;;GAGG;AACH,wBAAgB,UAAU,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI,CAkBjD;AAED;;;GAGG;AACH,wBAAgB,OAAO,CAAC,KAAK,EAAE,KAAK,GAAG,IAAI,CAS1C"}

package/dist/index.js

@@ -61,6 +61,15 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
         if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
     }
 };
+var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
+    if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
+        if (ar || !(i in from)) {
+            if (!ar) ar = Array.prototype.slice.call(from, 0, i);
+            ar[i] = from[i];
+        }
+    }
+    return to.concat(ar || Array.prototype.slice.call(from));
+};
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
@@ -93,7 +102,9 @@ var Chirpier = /** @class */ (function () {
      * @param options - Configuration options for the SDK.
      */
     function Chirpier(_a) {
-        var key = _a.key, _b = _a.apiEndpoint, apiEndpoint = _b === void 0 ? constants_1.DEFAULT_API_ENDPOINT : _b, _c = _a.retries, retries = _c === void 0 ? constants_1.DEFAULT_RETRIES : _c, _d = _a.timeout, timeout = _d === void 0 ? constants_1.DEFAULT_TIMEOUT : _d;
+        var key = _a.key, _b = _a.apiEndpoint, apiEndpoint = _b === void 0 ? constants_1.DEFAULT_API_ENDPOINT : _b, _c = _a.retries, retries = _c === void 0 ? constants_1.DEFAULT_RETRIES : _c, _d = _a.timeout, timeout = _d === void 0 ? constants_1.DEFAULT_TIMEOUT : _d, _e = _a.batchSize, batchSize = _e === void 0 ? 100 : _e, _f = _a.flushInterval, flushInterval = _f === void 0 ? 500 : _f;
+        this.eventQueue = [];
+        this.flushTimeout = null;
         if (!key || typeof key !== "string") {
             throw new ChirpierError("API key is required and must be a string");
         }
@@ -101,6 +112,8 @@ var Chirpier = /** @class */ (function () {
         this.apiEndpoint = apiEndpoint;
         this.retries = retries;
         this.timeout = timeout;
+        this.batchSize = batchSize;
+        this.flushInterval = flushInterval;
         // Create axios instance with authorization header
         this.axiosInstance = axios_1.default.create({
             headers: { Authorization: "Bearer ".concat(this.apiKey) },
@@ -114,8 +127,8 @@ var Chirpier = /** @class */ (function () {
         // Apply axios-retry to your Axios instance
         (0, axios_retry_1.default)(this.axiosInstance, {
             retries: this.retries,
-            retryDelay: function (retryCount, error) {
-                return Math.pow(2, retryCount) * 2000; // Exponential backoff starting at 1 second
+            retryDelay: function (retryCount) {
+                return Math.pow(2, retryCount) * 1000; // Exponential backoff starting at 1 second
             },
             retryCondition: function (error) {
                 return (axios_retry_1.default.isNetworkError(error) || axios_retry_1.default.isRetryableError(error));
@@ -129,54 +142,76 @@ var Chirpier = /** @class */ (function () {
      * @returns True if valid, false otherwise.
      */
     Chirpier.prototype.isValidEvent = function (event) {
-        return (typeof event.group_id === "string" && /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/.test(event.group_id) &&
+        return (typeof event.group_id === "string" &&
+            /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/.test(event.group_id) &&
             event.group_id.trim().length > 0 &&
             typeof event.stream === "string" &&
             event.stream.trim().length > 0 &&
             typeof event.value === "number");
     };
     /**
-     * Monitors an event by sending it to the API or storing it for retry.
+     * Monitors an event by adding it to the queue and scheduling a flush if necessary.
      * @param event - The event to monitor.
      */
     Chirpier.prototype.monitor = function (event) {
         return __awaiter(this, void 0, void 0, function () {
-            var eventWithID, error_1;
+            var eventWithID;
+            var _this = this;
+            return __generator(this, function (_a) {
+                if (!this.apiKey) {
+                    throw new ChirpierError("Chirpier SDK must be initialized before calling monitor()");
+                }
+                if (!this.isValidEvent(event)) {
+                    throw new ChirpierError("Invalid event format. Must include group_id, stream, and numeric value.");
+                }
+                eventWithID = __assign(__assign({}, event), { event_id: event.event_id || (0, uuid_1.v4)() });
+                this.eventQueue.push(eventWithID);
+                if (this.eventQueue.length >= this.batchSize) {
+                    this.flushQueue();
+                }
+                else if (!this.flushTimeout) {
+                    this.flushTimeout = setTimeout(function () { return _this.flushQueue(); }, this.flushInterval);
+                }
+                return [2 /*return*/];
+            });
+        });
+    };
+    /**
+     * Flushes the event queue by sending all events to the API.
+     */
+    Chirpier.prototype.flushQueue = function () {
+        return __awaiter(this, void 0, void 0, function () {
+            var eventsToSend, error_1;
+            var _this = this;
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
-                        if (!this.isValidEvent(event)) {
-                            throw new ChirpierError("Invalid event format. Must include group_id, stream, and numeric value.");
+                        if (this.eventQueue.length === 0) {
+                            return [2 /*return*/];
                         }
-                        eventWithID = __assign(__assign({}, event), { event_id: event.event_id || (0, uuid_1.v4)() });
+                        if (this.flushTimeout) {
+                            clearTimeout(this.flushTimeout);
+                            this.flushTimeout = null;
+                        }
+                        eventsToSend = __spreadArray([], this.eventQueue, true);
+                        this.eventQueue = [];
                         _a.label = 1;
                     case 1:
                         _a.trys.push([1, 3, , 4]);
-                        return [4 /*yield*/, this.sendEvent(eventWithID)];
+                        return [4 /*yield*/, this.sendEvents(eventsToSend)];
                     case 2:
                         _a.sent();
-                        console.info("Event successfully sent:", eventWithID.event_id);
+                        console.info("Successfully sent ".concat(eventsToSend.length, " events"));
                         return [3 /*break*/, 4];
                     case 3:
                         error_1 = _a.sent();
-                        console.error("Failed to send event after retries:", error_1);
+                        console.error("Failed to send events:", error_1);
                         return [3 /*break*/, 4];
-                    case 4: return [2 /*return*/];
-                }
-            });
-        });
-    };
-    /**
-     * Sends an event to the API.
-     * @param event - The event to send.
-     */
-    Chirpier.prototype.sendEvent = function (event) {
-        return __awaiter(this, void 0, void 0, function () {
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0: return [4 /*yield*/, this.sendEvents([event])];
-                    case 1:
-                        _a.sent();
+                    case 4:
+                        // Schedule next flush if there are more events
+                        if (this.eventQueue.length > 0) {
+                            this.flushTimeout = setTimeout(function () { return _this.flushQueue(); }, this.flushInterval);
+                        }
                         return [2 /*return*/];
                 }
             });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@chirpier/chirpier-js",
-  "version": "0.1.1",
+  "version": "0.1.2",
   "description": "Chirpier SDK for JavaScript",
   "keywords": [
     "chirpier",
@@ -30,7 +30,6 @@
     "@lukeed/uuid": "^2.0.1",
     "axios": "^0.24.0",
     "axios-retry": "^4.5.0",
-    "jest-environment-jsdom": "^29.7.0",
     "js-base64": "^3.7.7",
     "ts-node": "^10.9.2",
     "tslib": "^2.3.0"
@@ -39,7 +38,7 @@
     "@jest/globals": "^29.7.0",
     "@types/jest": "^29.5.13",
     "@types/mocha": "^10.0.8",
-    "@types/node": "^22.5.0",
+    "@types/node": "^22.7.5",
     "@types/uuid": "^10.0.0",
     "axios-mock-adapter": "^2.0.0",
     "jest": "^29.7.0",

package/src/__tests__/sdk.test.ts

@@ -1,12 +1,11 @@
-/**
- * @jest-environment jsdom
- */
-
-import { Chirpier, ChirpierError, Event } from "../index";
+import { Chirpier, ChirpierError, Event, initialize, monitor } from "../index";
 import { DEFAULT_API_ENDPOINT, DEFAULT_RETRIES } from "../constants";
 import MockAdapter from "axios-mock-adapter";
 import axios from "axios";
 import { cleanupMockServer } from "./mocks/server";
+import { v4 as uuidv4 } from "@lukeed/uuid";
+
+jest.mock("@lukeed/uuid");
 
 describe("Chirpier SDK", () => {
   let chirpier: Chirpier;
@@ -60,6 +59,15 @@ describe("Chirpier SDK", () => {
 
       expect(() => new Chirpier({} as any)).toThrow(ChirpierError);
     });
+
+    test("should throw error if key is not a valid JWT", () => {
+      expect(() => initialize({ key: "invalid_key" })).toThrow(ChirpierError);
+    });
+
+    test("should initialize successfully with a valid JWT", () => {
+      const validJWT = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c";
+      expect(() => initialize({ key: validJWT })).not.toThrow();
+    });
   });
 
   describe("monitor", () => {
@@ -72,6 +80,9 @@ describe("Chirpier SDK", () => {
       const mock = new MockAdapter(axios);
       mock.onPost(DEFAULT_API_ENDPOINT).reply(200, { success: true });
 
+      const validJWT = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c";
+      initialize({ key: validJWT });
+  
       const event: Event = {
         group_id: "f3438ee9-b964-48aa-b938-a803df440a3c",
         stream: "test-stream",
@@ -80,7 +91,8 @@ describe("Chirpier SDK", () => {
 
       await chirpier.monitor(event);
 
-      // Verify that the event was sent successfully
+      await new Promise(resolve => setTimeout(resolve, 1000)); // Wait for flush
+
       expect(mock.history.post.length).toBe(1);
       expect(mock.history.post[0].url).toBe(DEFAULT_API_ENDPOINT);
       expect(JSON.parse(mock.history.post[0].data)).toEqual([
@@ -88,7 +100,6 @@ describe("Chirpier SDK", () => {
           group_id: "f3438ee9-b964-48aa-b938-a803df440a3c",
           stream: "test-stream",
           value: 1,
-          event_id: expect.any(String),
         },
       ]);
 
@@ -96,10 +107,6 @@ describe("Chirpier SDK", () => {
       mock.reset();
     });
 
-    // Setup mock server
-    const mock = new MockAdapter(axios);
-    mock.onPost(DEFAULT_API_ENDPOINT).reply(200, { success: true });
-
     test("should throw error for invalid event", async () => {
       chirpier = new Chirpier({
         key: "api_key",
@@ -112,7 +119,104 @@ describe("Chirpier SDK", () => {
       );
 
       // Clean up the mock
+      const mock = new MockAdapter(axios);
+      mock.reset();
+    });
+
+    test("should batch events and flush when batch size is reached", async () => {
+      const mock = new MockAdapter(axios);
+      mock.onPost(DEFAULT_API_ENDPOINT).reply(200, { success: true });
+
+      const validJWT = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c";
+      initialize({ key: validJWT, batchSize: 2 });
+
+      const event: Event = {
+        group_id: "f3438ee9-b964-48aa-b938-a803df440a3c",
+        stream: "test-stream",
+        value: 1,
+      };
+
+      monitor(event);
+      monitor(event);
+
+      await new Promise(resolve => setTimeout(resolve, 100)); // Wait for flush
+
+      expect(mock.history.post.length).toBe(1);
+      expect(JSON.parse(mock.history.post[0].data).length).toBe(2);
+
+      mock.reset();
+    });
+
+    test("should flush events after interval", async () => {
+      const mock = new MockAdapter(axios);
+      mock.onPost(DEFAULT_API_ENDPOINT).reply(200, { success: true });
+
+      const validJWT = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c";
+      initialize({ key: validJWT, flushInterval: 100 });
+
+      const event: Event = {
+        group_id: "f3438ee9-b964-48aa-b938-a803df440a3c",
+        stream: "test-stream",
+        value: 1,
+      };
+
+      monitor(event);
+
+      await new Promise(resolve => setTimeout(resolve, 1000)); // Wait for flush
+
+      expect(mock.history.post.length).toBe(1);
+      expect(JSON.parse(mock.history.post[0].data).length).toBe(1);
+
+      mock.reset();
+    });
+
+    test("should use provided event_id if available", async () => {
+      const mock = new MockAdapter(axios);
+      mock.onPost(DEFAULT_API_ENDPOINT).reply(200, { success: true });
+
+      const validJWT = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c";
+      initialize({ key: validJWT });
+
+      const event: Event = {
+        group_id: "f3438ee9-b964-48aa-b938-a803df440a3c",
+        stream: "test-stream",
+        value: 1,
+        event_id: "f3438ee9-b964-48aa-b938-a803df440a3c",
+      };
+
+      monitor(event);
+
+      await new Promise(resolve => setTimeout(resolve, 1000)); // Wait for flush
+
+      expect(mock.history.post.length).toBe(1);
+      expect(JSON.parse(mock.history.post[0].data)[0].event_id).toBe("f3438ee9-b964-48aa-b938-a803df440a3c");
+
+      mock.reset();
+    });
+
+    test("should generate event_id if not provided", async () => {
+      const mock = new MockAdapter(axios);
+      mock.onPost(DEFAULT_API_ENDPOINT).reply(200, { success: true });
+
+      (uuidv4 as jest.Mock).mockReturnValue("generated-uuid");
+
+      const validJWT = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c";
+      initialize({ key: validJWT });
+
+      const event: Event = {
+        group_id: "f3438ee9-b964-48aa-b938-a803df440a3c",
+        stream: "test-stream",
+        value: 1,
+      };
+
+      monitor(event);
+
+      await new Promise(resolve => setTimeout(resolve, 1000)); // Wait for flush
+
+      expect(mock.history.post.length).toBe(1);
+      expect(JSON.parse(mock.history.post[0].data)[0].event_id).toBe("generated-uuid");
+
       mock.reset();
     });
   });
-});
+});

package/src/index.ts

@@ -2,7 +2,7 @@
 import axios, { AxiosInstance } from "axios";
 import axiosRetry from "axios-retry";
 import { v4 as uuidv4 } from "@lukeed/uuid";
-import { Base64 } from 'js-base64';
+import { Base64 } from "js-base64";
 import {
   DEFAULT_API_ENDPOINT,
   DEFAULT_RETRIES,
@@ -15,6 +15,8 @@ interface Options {
   apiEndpoint?: string;
   retries?: number;
   timeout?: number;
+  batchSize?: number;
+  flushInterval?: number;
 }
 
 // Define the Event interface for monitoring
@@ -43,6 +45,10 @@ export class Chirpier {
   private readonly retries: number;
   private readonly timeout: number;
   private readonly axiosInstance: AxiosInstance;
+  private eventQueue: Event[] = [];
+  private flushTimeout: NodeJS.Timeout | null = null;
+  private readonly batchSize: number;
+  private readonly flushInterval: number;
 
   /**
    * Initializes a new instance of the Chirpier class.
@@ -53,6 +59,8 @@ export class Chirpier {
     apiEndpoint = DEFAULT_API_ENDPOINT,
     retries = DEFAULT_RETRIES,
     timeout = DEFAULT_TIMEOUT,
+    batchSize = 100,
+    flushInterval = 500,
   }: Options) {
     if (!key || typeof key !== "string") {
       throw new ChirpierError("API key is required and must be a string");
@@ -61,6 +69,8 @@ export class Chirpier {
     this.apiEndpoint = apiEndpoint;
     this.retries = retries;
     this.timeout = timeout;
+    this.batchSize = batchSize;
+    this.flushInterval = flushInterval;
 
     // Create axios instance with authorization header
     this.axiosInstance = axios.create({
@@ -80,8 +90,8 @@ export class Chirpier {
     // Apply axios-retry to your Axios instance
     axiosRetry(this.axiosInstance, {
       retries: this.retries,
-      retryDelay: (retryCount, error) => {
-        return Math.pow(2, retryCount) * 2000; // Exponential backoff starting at 1 second
+      retryDelay: (retryCount) => {
+        return Math.pow(2, retryCount) * 1000; // Exponential backoff starting at 1 second
       },
       retryCondition: (error) => {
         return (
@@ -99,7 +109,10 @@ export class Chirpier {
    */
   private isValidEvent(event: Event): boolean {
     return (
-      typeof event.group_id === "string" && /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/.test(event.group_id) &&
+      typeof event.group_id === "string" &&
+      /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/.test(
+        event.group_id
+      ) &&
       event.group_id.trim().length > 0 &&
       typeof event.stream === "string" &&
       event.stream.trim().length > 0 &&
@@ -108,10 +121,14 @@ export class Chirpier {
   }
 
   /**
-   * Monitors an event by sending it to the API or storing it for retry.
+   * Monitors an event by adding it to the queue and scheduling a flush if necessary.
    * @param event - The event to monitor.
    */
   public async monitor(event: Event): Promise<void> {
+    if (!this.apiKey) {
+      throw new ChirpierError("Chirpier SDK must be initialized before calling monitor()");
+    }
+
     if (!this.isValidEvent(event)) {
       throw new ChirpierError(
         "Invalid event format. Must include group_id, stream, and numeric value."
@@ -121,20 +138,48 @@ export class Chirpier {
     // Ensure event_id is only set once
     const eventWithID = { ...event, event_id: event.event_id || uuidv4() };
 
-    try {
-      await this.sendEvent(eventWithID);
-      console.info("Event successfully sent:", eventWithID.event_id);
-    } catch (error) {
-      console.error("Failed to send event after retries:", error);
+    this.eventQueue.push(eventWithID);
+
+    if (this.eventQueue.length >= this.batchSize) {
+      this.flushQueue();
+    } else if (!this.flushTimeout) {
+      this.flushTimeout = setTimeout(
+        () => this.flushQueue(),
+        this.flushInterval
+      );
     }
   }
 
   /**
-   * Sends an event to the API.
-   * @param event - The event to send.
+   * Flushes the event queue by sending all events to the API.
    */
-  private async sendEvent(event: Event): Promise<void> {
-    await this.sendEvents([event]);
+  private async flushQueue(): Promise<void> {
+    if (this.eventQueue.length === 0) {
+      return;
+    }
+    
+    if (this.flushTimeout) {
+      clearTimeout(this.flushTimeout);
+      this.flushTimeout = null;
+    }
+
+    const eventsToSend = [...this.eventQueue];
+    this.eventQueue = [];
+
+    try {
+      await this.sendEvents(eventsToSend);
+      console.info(`Successfully sent ${eventsToSend.length} events`);
+    } catch (error) {
+      console.error("Failed to send events:", error);
+    }
+
+    // Schedule next flush if there are more events
+    if (this.eventQueue.length > 0) {
+      this.flushTimeout = setTimeout(
+        () => this.flushQueue(),
+        this.flushInterval
+      );
+    }
   }
 
   /**

package/src/storage.ts

@@ -1,10 +0,0 @@
-export class LocalStorageStorage {
-    save(events: any[]): void {
-      localStorage.setItem('chirpier_events', JSON.stringify(events));
-    }
-  
-    load(): any[] {
-      const storedEvents = localStorage.getItem('chirpier_events');
-      return storedEvents ? JSON.parse(storedEvents) : [];
-    }
-  }