@reflag/node-sdk 1.0.0-alpha.1

package/dist/package.json

@@ -0,0 +1,49 @@
+{
+    "name": "@reflag/node-sdk",
+    "version": "1.0.0-alpha.1",
+    "license": "MIT",
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/reflagcom/javascript.git"
+    },
+    "scripts": {
+        "dev": "vite",
+        "start": "vite",
+        "build": "tsc --project tsconfig.build.json",
+        "test": "vitest -c vite.config.js",
+        "test:ci": "vitest run -c vite.config.js --reporter=default --reporter=junit --outputFile=junit.xml",
+        "coverage": "vitest run --coverage",
+        "lint": "eslint .",
+        "lint:ci": "eslint --output-file eslint-report.json --format json .",
+        "prettier": "prettier --check .",
+        "format": "yarn lint --fix && yarn prettier --write",
+        "preversion": "yarn lint && yarn prettier && yarn vitest run -c vite.config.js && yarn build"
+    },
+    "files": [
+        "dist"
+    ],
+    "publishConfig": {
+        "access": "public"
+    },
+    "main": "./dist/src/index.js",
+    "types": "./dist/types/src/index.d.ts",
+    "devDependencies": {
+        "@babel/core": "~7.24.7",
+        "@reflag/eslint-config": "~0.0.2",
+        "@reflag/tsconfig": "~0.0.2",
+        "@types/node": "^22.12.0",
+        "@vitest/coverage-v8": "~1.6.0",
+        "c8": "~10.1.0",
+        "eslint": "^9.21.0",
+        "flush-promises": "~1.0.2",
+        "prettier": "^3.5.2",
+        "ts-node": "~10.9.2",
+        "typescript": "^5.7.3",
+        "vite": "~5.4.18",
+        "vite-plugin-dts": "~3.9.1",
+        "vitest": "~1.6.0"
+    },
+    "dependencies": {
+        "@reflag/flag-evaluation": "1.0.0"
+    }
+}

package/dist/src/batch-buffer.js

@@ -0,0 +1,85 @@
+"use strict";
+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) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const config_1 = require("./config");
+const utils_1 = require("./utils");
+/**
+ * A buffer that accumulates items and flushes them in batches.
+ * @typeparam T - The type of items to buffer.
+ */
+class BatchBuffer {
+    /**
+     * Creates a new `BatchBuffer` instance.
+     * @param options - The options to configure the buffer.
+     * @throws If the options are invalid.
+     */
+    constructor(options) {
+        var _a, _b;
+        this.buffer = [];
+        this.timer = null;
+        (0, utils_1.ok)((0, utils_1.isObject)(options), "options must be an object");
+        (0, utils_1.ok)(typeof options.flushHandler === "function", "flushHandler must be a function");
+        (0, utils_1.ok)((0, utils_1.isObject)(options.logger) || !options.logger, "logger must be an object");
+        (0, utils_1.ok)((typeof options.maxSize === "number" && options.maxSize > 0) ||
+            typeof options.maxSize !== "number", "maxSize must be greater than 0");
+        (0, utils_1.ok)((typeof options.intervalMs === "number" && options.intervalMs >= 0) ||
+            typeof options.intervalMs !== "number", "intervalMs must be greater than or equal to 0");
+        this.flushHandler = options.flushHandler;
+        this.logger = options.logger;
+        this.maxSize = (_a = options.maxSize) !== null && _a !== void 0 ? _a : config_1.BATCH_MAX_SIZE;
+        this.intervalMs = (_b = options.intervalMs) !== null && _b !== void 0 ? _b : config_1.BATCH_INTERVAL_MS;
+    }
+    /**
+     * Adds an item to the buffer.
+     *
+     * @param item - The item to add.
+     */
+    add(item) {
+        return __awaiter(this, void 0, void 0, function* () {
+            this.buffer.push(item);
+            if (this.buffer.length >= this.maxSize) {
+                yield this.flush();
+            }
+            else if (!this.timer && this.intervalMs > 0) {
+                this.timer = setTimeout(() => this.flush(), this.intervalMs).unref();
+            }
+        });
+    }
+    flush() {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c;
+            if (this.timer) {
+                clearTimeout(this.timer);
+                this.timer = null;
+            }
+            if (this.buffer.length === 0) {
+                (_a = this.logger) === null || _a === void 0 ? void 0 : _a.debug("buffer is empty. nothing to flush");
+                return;
+            }
+            const flushingBuffer = this.buffer;
+            this.buffer = [];
+            try {
+                yield this.flushHandler(flushingBuffer);
+                (_b = this.logger) === null || _b === void 0 ? void 0 : _b.info("flushed buffered items", {
+                    count: flushingBuffer.length,
+                });
+            }
+            catch (error) {
+                (_c = this.logger) === null || _c === void 0 ? void 0 : _c.error("flush of buffered items failed; discarding items", {
+                    error,
+                    count: flushingBuffer.length,
+                });
+            }
+        });
+    }
+}
+exports.default = BatchBuffer;
+//# sourceMappingURL=batch-buffer.js.map

package/dist/src/batch-buffer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"batch-buffer.js","sourceRoot":"","sources":["../../src/batch-buffer.ts"],"names":[],"mappings":";;;;;;;;;;;AAAA,qCAA6D;AAE7D,mCAAuC;AAEvC;;;GAGG;AACH,MAAqB,WAAW;IAQ9B;;;;OAIG;IACH,YAAY,OAA8B;;QAZlC,WAAM,GAAQ,EAAE,CAAC;QAKjB,UAAK,GAA0B,IAAI,CAAC;QAQ1C,IAAA,UAAE,EAAC,IAAA,gBAAQ,EAAC,OAAO,CAAC,EAAE,2BAA2B,CAAC,CAAC;QACnD,IAAA,UAAE,EACA,OAAO,OAAO,CAAC,YAAY,KAAK,UAAU,EAC1C,iCAAiC,CAClC,CAAC;QACF,IAAA,UAAE,EAAC,IAAA,gBAAQ,EAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,0BAA0B,CAAC,CAAC;QAC5E,IAAA,UAAE,EACA,CAAC,OAAO,OAAO,CAAC,OAAO,KAAK,QAAQ,IAAI,OAAO,CAAC,OAAO,GAAG,CAAC,CAAC;YAC1D,OAAO,OAAO,CAAC,OAAO,KAAK,QAAQ,EACrC,gCAAgC,CACjC,CAAC;QACF,IAAA,UAAE,EACA,CAAC,OAAO,OAAO,CAAC,UAAU,KAAK,QAAQ,IAAI,OAAO,CAAC,UAAU,IAAI,CAAC,CAAC;YACjE,OAAO,OAAO,CAAC,UAAU,KAAK,QAAQ,EACxC,+CAA+C,CAChD,CAAC;QAEF,IAAI,CAAC,YAAY,GAAG,OAAO,CAAC,YAAY,CAAC;QACzC,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;QAC7B,IAAI,CAAC,OAAO,GAAG,MAAA,OAAO,CAAC,OAAO,mCAAI,uBAAc,CAAC;QACjD,IAAI,CAAC,UAAU,GAAG,MAAA,OAAO,CAAC,UAAU,mCAAI,0BAAiB,CAAC;IAC5D,CAAC;IAED;;;;OAIG;IACU,GAAG,CAAC,IAAO;;YACtB,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAEvB,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;gBACvC,MAAM,IAAI,CAAC,KAAK,EAAE,CAAC;YACrB,CAAC;iBAAM,IAAI,CAAC,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,UAAU,GAAG,CAAC,EAAE,CAAC;gBAC9C,IAAI,CAAC,KAAK,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,KAAK,EAAE,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC,KAAK,EAAE,CAAC;YACvE,CAAC;QACH,CAAC;KAAA;IAEY,KAAK;;;YAChB,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;gBACf,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;gBACzB,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;YACpB,CAAC;YAED,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBAC7B,MAAA,IAAI,CAAC,MAAM,0CAAE,KAAK,CAAC,mCAAmC,CAAC,CAAC;gBACxD,OAAO;YACT,CAAC;YAED,MAAM,cAAc,GAAG,IAAI,CAAC,MAAM,CAAC;YACnC,IAAI,CAAC,MAAM,GAAG,EAAE,CAAC;YAEjB,IAAI,CAAC;gBACH,MAAM,IAAI,CAAC,YAAY,CAAC,cAAc,CAAC,CAAC;gBAExC,MAAA,IAAI,CAAC,MAAM,0CAAE,IAAI,CAAC,wBAAwB,EAAE;oBAC1C,KAAK,EAAE,cAAc,CAAC,MAAM;iBAC7B,CAAC,CAAC;YACL,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,MAAA,IAAI,CAAC,MAAM,0CAAE,KAAK,CAAC,kDAAkD,EAAE;oBACrE,KAAK;oBACL,KAAK,EAAE,cAAc,CAAC,MAAM;iBAC7B,CAAC,CAAC;YACL,CAAC;QACH,CAAC;KAAA;CACF;AA/ED,8BA+EC"}

package/dist/src/cache.js

@@ -0,0 +1,71 @@
+"use strict";
+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) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = cache;
+/**
+ * Create a cached function that updates the value asynchronously.
+ *
+ * The value is updated every `ttl` milliseconds.
+ * If the value is older than `staleTtl` milliseconds, a warning is logged.
+ *
+ * @typeParam T - The type of the value.
+ * @param ttl - The time-to-live in milliseconds.
+ * @param staleTtl - The time-to-live after which a warning is logged.
+ * @param logger - The logger to use.
+ * @param fn - The function to call to get the value.
+ * @returns The cache object.
+ **/
+function cache(ttl, staleTtl, logger, fn) {
+    let cachedValue;
+    let lastUpdate;
+    let timeoutId;
+    let refreshPromise;
+    const update = () => __awaiter(this, void 0, void 0, function* () {
+        if (timeoutId) {
+            clearTimeout(timeoutId);
+        }
+        try {
+            const newValue = yield fn();
+            if (newValue === undefined) {
+                return;
+            }
+            cachedValue = newValue;
+            lastUpdate = Date.now();
+            logger === null || logger === void 0 ? void 0 : logger.debug("updated cached value", cachedValue);
+        }
+        catch (e) {
+            logger === null || logger === void 0 ? void 0 : logger.error("failed to update cached value", e);
+        }
+        finally {
+            refreshPromise = undefined;
+            timeoutId = setTimeout(update, ttl).unref();
+        }
+    });
+    const get = () => {
+        if (lastUpdate !== undefined) {
+            const age = Date.now() - lastUpdate;
+            if (age > staleTtl) {
+                logger === null || logger === void 0 ? void 0 : logger.warn("cached value is stale", { age, cachedValue });
+            }
+        }
+        return cachedValue;
+    };
+    const refresh = () => __awaiter(this, void 0, void 0, function* () {
+        if (!refreshPromise) {
+            refreshPromise = update();
+        }
+        yield refreshPromise;
+        logger === null || logger === void 0 ? void 0 : logger.info("refreshed cached features");
+        return get();
+    });
+    return { get, refresh };
+}
+//# sourceMappingURL=cache.js.map

package/dist/src/cache.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cache.js","sourceRoot":"","sources":["../../src/cache.ts"],"names":[],"mappings":";;;;;;;;;;;AAeA,wBAuDC;AApED;;;;;;;;;;;;IAYI;AACJ,SAAwB,KAAK,CAC3B,GAAW,EACX,QAAgB,EAChB,MAA0B,EAC1B,EAAgC;IAEhC,IAAI,WAA0B,CAAC;IAC/B,IAAI,UAA8B,CAAC;IACnC,IAAI,SAAqC,CAAC;IAC1C,IAAI,cAAyC,CAAC;IAE9C,MAAM,MAAM,GAAG,GAAS,EAAE;QACxB,IAAI,SAAS,EAAE,CAAC;YACd,YAAY,CAAC,SAAS,CAAC,CAAC;QAC1B,CAAC;QAED,IAAI,CAAC;YACH,MAAM,QAAQ,GAAG,MAAM,EAAE,EAAE,CAAC;YAC5B,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;gBAC3B,OAAO;YACT,CAAC;YACD,WAAW,GAAG,QAAQ,CAAC;YAEvB,UAAU,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;YAExB,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,KAAK,CAAC,sBAAsB,EAAE,WAAW,CAAC,CAAC;QACrD,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,KAAK,CAAC,+BAA+B,EAAE,CAAC,CAAC,CAAC;QACpD,CAAC;gBAAS,CAAC;YACT,cAAc,GAAG,SAAS,CAAC;YAC3B,SAAS,GAAG,UAAU,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,KAAK,EAAE,CAAC;QAC9C,CAAC;IACH,CAAC,CAAA,CAAC;IAEF,MAAM,GAAG,GAAG,GAAG,EAAE;QACf,IAAI,UAAU,KAAK,SAAS,EAAE,CAAC;YAC7B,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,UAAW,CAAC;YACrC,IAAI,GAAG,GAAG,QAAQ,EAAE,CAAC;gBACnB,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,IAAI,CAAC,uBAAuB,EAAE,EAAE,GAAG,EAAE,WAAW,EAAE,CAAC,CAAC;YAC9D,CAAC;QACH,CAAC;QAED,OAAO,WAAW,CAAC;IACrB,CAAC,CAAC;IAEF,MAAM,OAAO,GAAG,GAAS,EAAE;QACzB,IAAI,CAAC,cAAc,EAAE,CAAC;YACpB,cAAc,GAAG,MAAM,EAAE,CAAC;QAC5B,CAAC;QACD,MAAM,cAAc,CAAC;QACrB,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,IAAI,CAAC,2BAA2B,CAAC,CAAC;QAC1C,OAAO,GAAG,EAAE,CAAC;IACf,CAAC,CAAA,CAAC;IAEF,OAAO,EAAE,GAAG,EAAE,OAAO,EAAE,CAAC;AAC1B,CAAC"}