@bringg/dashboard-sdk 9.91.0 → 9.91.1

package/dist/utils/decorators/negative-cache.d.ts

@@ -0,0 +1,27 @@
+interface Identifiable {
+    id: number;
+}
+interface LoadManyOptions {
+    useCache?: boolean;
+}
+type LoadMany<TItem extends Identifiable> = (ids: number[], options?: LoadManyOptions) => Promise<TItem[]>;
+interface NegativeCacheOptions<TInstance> {
+    ttlMs: number;
+    hasItem: (instance: TInstance, id: number) => boolean;
+    maxSize?: number;
+}
+export declare const DEFAULT_NEGATIVE_CACHE_MAX_SIZE = 5000;
+/**
+ * Suppresses ids the server repeatedly fails to return.
+ *
+ * Decorates a `loadMany(ids, options?)` method: ids the previous response omitted are dropped from the
+ * next request until `ttlMs` elapses, so an id the backend cannot return (soft-deleted, scoped to another
+ * team, external, other company) is requested once per TTL instead of on every call.
+ *
+ * TODO(TS 5.x): written as a legacy decorator (`experimentalDecorators`, TS 4.9 here - standard Stage 3
+ * decorators need TS 5.0+). Upgrade when the repo moves to TS 5.x: a Stage 3 method decorator takes
+ * `(originalMethod, context)` and returns the replacement function, so the `PropertyDescriptor`
+ * plumbing below goes away. `./cached-promise.ts` needs the same treatment at that point.
+ */
+declare function withNegativeCache<TInstance extends object, TItem extends Identifiable>({ ttlMs, hasItem, maxSize }: NegativeCacheOptions<TInstance>): (target: TInstance, propertyName: string, propertyDescriptor: TypedPropertyDescriptor<LoadMany<TItem>>) => TypedPropertyDescriptor<LoadMany<TItem>>;
+export default withNegativeCache;

package/dist/utils/decorators/negative-cache.js

@@ -0,0 +1,144 @@
+"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());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DEFAULT_NEGATIVE_CACHE_MAX_SIZE = void 0;
+exports.DEFAULT_NEGATIVE_CACHE_MAX_SIZE = 5000;
+var instanceCaches = new WeakMap();
+var getCache = function (instance) {
+    var cache = instanceCaches.get(instance);
+    if (!cache) {
+        cache = { misses: new Map(), lastSweptAt: Date.now() };
+        instanceCaches.set(instance, cache);
+    }
+    return cache;
+};
+// Entries are only ever added by the decorated method, so sweeping on call covers every growth path
+// without a timer that would pin the instance and defeat the WeakMap. An entry recorded just after a
+// sweep survives until the sweep after next, so worst-case lifetime is ~2x ttlMs.
+var sweep = function (cache, ttlMs, now) {
+    if (now - cache.lastSweptAt < ttlMs) {
+        return;
+    }
+    var expired = [];
+    cache.misses.forEach(function (missedAt, id) {
+        if (now - missedAt >= ttlMs) {
+            expired.push(id);
+        }
+    });
+    expired.forEach(function (id) { return cache.misses.delete(id); });
+    cache.lastSweptAt = now;
+};
+// A burst of distinct misses inside one ttl window has nothing to sweep - drop oldest first.
+// Map keeps insertion order and entries are inserted at miss time, so the front is the oldest.
+// Runs AFTER recording, so a single call that overshoots the cap is trimmed by that same call.
+var enforceCap = function (cache, maxSize) {
+    if (cache.misses.size <= maxSize) {
+        return;
+    }
+    var overflow = cache.misses.size - maxSize;
+    var oldestFirst = cache.misses.keys();
+    for (var i = 0; i < overflow; i++) {
+        cache.misses.delete(oldestFirst.next().value);
+    }
+};
+/**
+ * Suppresses ids the server repeatedly fails to return.
+ *
+ * Decorates a `loadMany(ids, options?)` method: ids the previous response omitted are dropped from the
+ * next request until `ttlMs` elapses, so an id the backend cannot return (soft-deleted, scoped to another
+ * team, external, other company) is requested once per TTL instead of on every call.
+ *
+ * TODO(TS 5.x): written as a legacy decorator (`experimentalDecorators`, TS 4.9 here - standard Stage 3
+ * decorators need TS 5.0+). Upgrade when the repo moves to TS 5.x: a Stage 3 method decorator takes
+ * `(originalMethod, context)` and returns the replacement function, so the `PropertyDescriptor`
+ * plumbing below goes away. `./cached-promise.ts` needs the same treatment at that point.
+ */
+function withNegativeCache(_a) {
+    var ttlMs = _a.ttlMs, hasItem = _a.hasItem, _b = _a.maxSize, maxSize = _b === void 0 ? exports.DEFAULT_NEGATIVE_CACHE_MAX_SIZE : _b;
+    return function (target, propertyName, propertyDescriptor) {
+        var method = propertyDescriptor.value;
+        propertyDescriptor.value = function (ids, options) {
+            return __awaiter(this, void 0, void 0, function () {
+                var instanceCache, cache, idsToLoad, items, returnedIds, now;
+                var _this = this;
+                return __generator(this, function (_a) {
+                    switch (_a.label) {
+                        case 0:
+                            // Nothing to load, and no instance to key the per-instance cache on when the method was
+                            // detached from it (`const { loadMany } = api`).
+                            if (!this || !(ids === null || ids === void 0 ? void 0 : ids.length)) {
+                                return [2 /*return*/, method.call(this, ids, options)];
+                            }
+                            instanceCache = getCache(this);
+                            cache = instanceCache.misses;
+                            sweep(instanceCache, ttlMs, Date.now());
+                            if ((options === null || options === void 0 ? void 0 : options.useCache) === false) {
+                                ids.forEach(function (id) { return cache.delete(id); });
+                            }
+                            idsToLoad = ids.filter(function (id) {
+                                var missedAt = cache.get(id);
+                                if (missedAt === undefined) {
+                                    return true;
+                                }
+                                // Expired, or the item showed up by another route - either way it is requestable again.
+                                if (Date.now() - missedAt >= ttlMs || hasItem(_this, id)) {
+                                    cache.delete(id);
+                                    return true;
+                                }
+                                return false;
+                            });
+                            if (!idsToLoad.length) {
+                                return [2 /*return*/, []];
+                            }
+                            return [4 /*yield*/, method.call(this, idsToLoad, options)];
+                        case 1:
+                            items = _a.sent();
+                            returnedIds = new Set(items.map(function (item) { return item.id; }));
+                            now = Date.now();
+                            idsToLoad.forEach(function (id) { return (returnedIds.has(id) ? cache.delete(id) : cache.set(id, now)); });
+                            enforceCap(instanceCache, maxSize);
+                            return [2 /*return*/, items];
+                    }
+                });
+            });
+        };
+        return propertyDescriptor;
+    };
+}
+exports.default = withNegativeCache;
+//# sourceMappingURL=negative-cache.js.map

package/dist/utils/decorators/negative-cache.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"negative-cache.js","sourceRoot":"","sources":["../../../src/utils/decorators/negative-cache.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAgBa,QAAA,+BAA+B,GAAG,IAAI,CAAC;AAOpD,IAAM,cAAc,GAAG,IAAI,OAAO,EAAyB,CAAC;AAE5D,IAAM,QAAQ,GAAG,UAAC,QAAgB;IACjC,IAAI,KAAK,GAAG,cAAc,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;IAEzC,IAAI,CAAC,KAAK,EAAE;QACX,KAAK,GAAG,EAAE,MAAM,EAAE,IAAI,GAAG,EAAE,EAAE,WAAW,EAAE,IAAI,CAAC,GAAG,EAAE,EAAE,CAAC;QACvD,cAAc,CAAC,GAAG,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;KACpC;IAED,OAAO,KAAK,CAAC;AACd,CAAC,CAAC;AAEF,oGAAoG;AACpG,qGAAqG;AACrG,kFAAkF;AAClF,IAAM,KAAK,GAAG,UAAC,KAAoB,EAAE,KAAa,EAAE,GAAW;IAC9D,IAAI,GAAG,GAAG,KAAK,CAAC,WAAW,GAAG,KAAK,EAAE;QACpC,OAAO;KACP;IAED,IAAM,OAAO,GAAa,EAAE,CAAC;IAE7B,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,UAAC,QAAQ,EAAE,EAAE;QACjC,IAAI,GAAG,GAAG,QAAQ,IAAI,KAAK,EAAE;YAC5B,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;SACjB;IACF,CAAC,CAAC,CAAC;IAEH,OAAO,CAAC,OAAO,CAAC,UAAA,EAAE,IAAI,OAAA,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,EAAvB,CAAuB,CAAC,CAAC;IAC/C,KAAK,CAAC,WAAW,GAAG,GAAG,CAAC;AACzB,CAAC,CAAC;AAEF,6FAA6F;AAC7F,+FAA+F;AAC/F,+FAA+F;AAC/F,IAAM,UAAU,GAAG,UAAC,KAAoB,EAAE,OAAe;IACxD,IAAI,KAAK,CAAC,MAAM,CAAC,IAAI,IAAI,OAAO,EAAE;QACjC,OAAO;KACP;IAED,IAAM,QAAQ,GAAG,KAAK,CAAC,MAAM,CAAC,IAAI,GAAG,OAAO,CAAC;IAC7C,IAAM,WAAW,GAAG,KAAK,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;IAExC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,QAAQ,EAAE,CAAC,EAAE,EAAE;QAClC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,CAAC;KAC9C;AACF,CAAC,CAAC;AAEF;;;;;;;;;;;GAWG;AACH,SAAS,iBAAiB,CAAuD,EAI/C;QAHjC,KAAK,WAAA,EACL,OAAO,aAAA,EACP,eAAyC,EAAzC,OAAO,mBAAG,uCAA+B,KAAA;IAEzC,OAAO,UACN,MAAiB,EACjB,YAAoB,EACpB,kBAA4D;QAE5D,IAAM,MAAM,GAAG,kBAAkB,CAAC,KAAK,CAAC;QAExC,kBAAkB,CAAC,KAAK,GAAG,UAE1B,GAAa,EACb,OAAyB;;;;;;;4BAEzB,wFAAwF;4BACxF,iDAAiD;4BACjD,IAAI,CAAC,IAAI,IAAI,CAAC,CAAA,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,MAAM,CAAA,EAAE;gCAC1B,sBAAO,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,GAAG,EAAE,OAAO,CAAC,EAAC;6BACvC;4BAEK,aAAa,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC;4BAC/B,KAAK,GAAG,aAAa,CAAC,MAAM,CAAC;4BAEnC,KAAK,CAAC,aAAa,EAAE,KAAK,EAAE,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC;4BAExC,IAAI,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,QAAQ,MAAK,KAAK,EAAE;gCAChC,GAAG,CAAC,OAAO,CAAC,UAAA,EAAE,IAAI,OAAA,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC,EAAhB,CAAgB,CAAC,CAAC;6BACpC;4BAEK,SAAS,GAAG,GAAG,CAAC,MAAM,CAAC,UAAA,EAAE;gCAC9B,IAAM,QAAQ,GAAG,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;gCAE/B,IAAI,QAAQ,KAAK,SAAS,EAAE;oCAC3B,OAAO,IAAI,CAAC;iCACZ;gCAED,wFAAwF;gCACxF,IAAI,IAAI,CAAC,GAAG,EAAE,GAAG,QAAQ,IAAI,KAAK,IAAI,OAAO,CAAC,KAAI,EAAE,EAAE,CAAC,EAAE;oCACxD,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;oCAEjB,OAAO,IAAI,CAAC;iCACZ;gCAED,OAAO,KAAK,CAAC;4BACd,CAAC,CAAC,CAAC;4BAEH,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE;gCACtB,sBAAO,EAAE,EAAC;6BACV;4BAEa,qBAAM,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,SAAS,EAAE,OAAO,CAAC,EAAA;;4BAAnD,KAAK,GAAG,SAA2C;4BACnD,WAAW,GAAG,IAAI,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,UAAA,IAAI,IAAI,OAAA,IAAI,CAAC,EAAE,EAAP,CAAO,CAAC,CAAC,CAAC;4BAClD,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;4BAEvB,SAAS,CAAC,OAAO,CAAC,UAAA,EAAE,IAAI,OAAA,CAAC,WAAW,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,EAAE,GAAG,CAAC,CAAC,EAA7D,CAA6D,CAAC,CAAC;4BAEvF,UAAU,CAAC,aAAa,EAAE,OAAO,CAAC,CAAC;4BAEnC,sBAAO,KAAK,EAAC;;;;SACb,CAAC;QAEF,OAAO,kBAAkB,CAAC;IAC3B,CAAC,CAAC;AACH,CAAC;AAED,kBAAe,iBAAiB,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@bringg/dashboard-sdk",
-	"version": "9.91.0",
+	"version": "9.91.1",
 	"description": "Bringg dashboard SDK",
 	"main": "dist/bringg-dashboard-sdk-cjs2.js",
 	"typings": "dist/index.d.ts",