@icure/api 6.4.0 → 7.0.0-beta.1

package/icc-x-api/utils/lru-temporised-async-cache.js

@@ -0,0 +1,120 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LruTemporisedAsyncCache = void 0;
+class LruTemporisedAsyncCache {
+    /**
+     * @param maxCacheSize Maximum size of the cache. Any value <= 0 is considered as no limit.
+     * @param lifetimeForValue Get the maximum lifetime for an entry given its value.
+     */
+    constructor(maxCacheSize, lifetimeForValue) {
+        this.nodesMap = new Map();
+        this.firstNode = null;
+        this.lastNode = null;
+        this.maxCacheSize = maxCacheSize;
+        this.lifetimeForValue = lifetimeForValue;
+    }
+    /**
+     * Gets a cached value or retrieves it and caches it if the value is not available or if it is available but expired. A value will never be expired
+     * if it was not yet retrieved, even if the retrieved value would be expired according to the {@link additionalExpirationCondition}
+     * @param key key of the entry
+     * @param retrieve given the previous value (if available, expired but not yet removed) of the entry retrieves an updated value.
+     * @param additionalExpirationCondition an expiration condition for already cached values to consider in addition to time-based expiration. Returns
+     * always false by default, meaning the value is not expired if its lifetime didn't already surpass the maximum lifetime.
+     * @return the cached value if present and not expired, else the retrieved value.
+     */
+    get(key, retrieve, additionalExpirationCondition = () => false) {
+        const retrieved = this.nodesMap.get(key);
+        if (retrieved !== undefined) {
+            this.markUsed(retrieved);
+            const cachedValue = retrieved.cachedValue;
+            if (retrieved.expired((x) => this.lifetimeForValue(x)) || (cachedValue !== undefined && additionalExpirationCondition(cachedValue))) {
+                retrieved.value = this.registerJob(key, () => retrieve(cachedValue));
+            }
+            return retrieved.valuePromise();
+        }
+        else {
+            const newNode = new CacheNode(key, this.lastNode, null, this.registerJob(key, () => retrieve(undefined)));
+            this.addToTail(key, newNode);
+            if (this.maxCacheSize > 0 && this.nodesMap.size > this.maxCacheSize)
+                this.evict(this.firstNode.key, this.firstNode);
+            return newNode.valuePromise();
+        }
+    }
+    clear() {
+        this.firstNode = null;
+        this.lastNode = null;
+        this.nodesMap.clear();
+    }
+    addToTail(key, node) {
+        node.previous = this.lastNode;
+        node.next = null;
+        if (this.lastNode)
+            this.lastNode.next = node;
+        this.lastNode = node;
+        if (this.firstNode === null)
+            this.firstNode = node;
+        if (key != null)
+            this.nodesMap.set(key, node);
+    }
+    evict(key, node) {
+        if (node.previous)
+            node.previous.next = node.next;
+        if (node.next)
+            node.next.previous = node.previous;
+        if (this.firstNode === node)
+            this.firstNode = node.next;
+        if (this.lastNode === node)
+            this.lastNode = node.previous;
+        if (key !== null)
+            this.nodesMap.delete(key);
+    }
+    markUsed(node) {
+        if (node !== this.lastNode) {
+            // No need to modify the nodes map
+            this.evict(null, node);
+            this.addToTail(null, node);
+        }
+    }
+    registerJob(key, retrieve) {
+        // The node may have already been evicted by the time the promise completed if the cached surpassed the maximum size.
+        return retrieve()
+            .then((v) => {
+            const node = this.nodesMap.get(key);
+            if (node) {
+                node.value = { cached: v, timestamp: Date.now() };
+            }
+            return v;
+        })
+            .catch((e) => {
+            const node = this.nodesMap.get(key);
+            if (node) {
+                this.evict(key, node);
+            }
+            throw e;
+        });
+    }
+}
+exports.LruTemporisedAsyncCache = LruTemporisedAsyncCache;
+class CacheNode {
+    constructor(key, previous, next, value) {
+        this.key = key;
+        this.previous = previous;
+        this.next = next;
+        this.value = value;
+    }
+    expired(lifetimeForValue) {
+        if ('timestamp' in this.value) {
+            const maxLifetime = lifetimeForValue(this.value.cached);
+            return maxLifetime > 0 && Date.now() - this.value.timestamp > maxLifetime;
+        }
+        else
+            return false;
+    }
+    valuePromise() {
+        return 'timestamp' in this.value ? Promise.resolve(this.value.cached) : this.value;
+    }
+    get cachedValue() {
+        return 'timestamp' in this.value ? this.value.cached : undefined;
+    }
+}
+//# sourceMappingURL=lru-temporised-async-cache.js.map

package/icc-x-api/utils/lru-temporised-async-cache.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"lru-temporised-async-cache.js","sourceRoot":"","sources":["../../../icc-x-api/utils/lru-temporised-async-cache.ts"],"names":[],"mappings":";;;AAAA,MAAa,uBAAuB;IAQlC;;;OAGG;IACH,YAAY,YAAoB,EAAE,gBAAsC;QARvD,aAAQ,GAA4B,IAAI,GAAG,EAAE,CAAA;QACtD,cAAS,GAA2B,IAAI,CAAA;QACxC,aAAQ,GAA2B,IAAI,CAAA;QAO7C,IAAI,CAAC,YAAY,GAAG,YAAY,CAAA;QAChC,IAAI,CAAC,gBAAgB,GAAG,gBAAgB,CAAA;IAC1C,CAAC;IAED;;;;;;;;OAQG;IACH,GAAG,CACD,GAAM,EACN,QAAsD,EACtD,gCAAuD,GAAG,EAAE,CAAC,KAAK;QAElE,MAAM,SAAS,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;QACxC,IAAI,SAAS,KAAK,SAAS,EAAE;YAC3B,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAA;YACxB,MAAM,WAAW,GAAG,SAAS,CAAC,WAAW,CAAA;YACzC,IAAI,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,KAAK,SAAS,IAAI,6BAA6B,CAAC,WAAW,CAAC,CAAC,EAAE;gBACnI,SAAS,CAAC,KAAK,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,EAAE,GAAG,EAAE,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC,CAAA;aACrE;YACD,OAAO,SAAS,CAAC,YAAY,EAAE,CAAA;SAChC;aAAM;YACL,MAAM,OAAO,GAAG,IAAI,SAAS,CAC3B,GAAG,EACH,IAAI,CAAC,QAAQ,EACb,IAAI,EACJ,IAAI,CAAC,WAAW,CAAC,GAAG,EAAE,GAAG,EAAE,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,CACjD,CAAA;YACD,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE,OAAO,CAAC,CAAA;YAC5B,IAAI,IAAI,CAAC,YAAY,GAAG,CAAC,IAAI,IAAI,CAAC,QAAQ,CAAC,IAAI,GAAG,IAAI,CAAC,YAAY;gBAAE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,SAAU,CAAC,GAAG,EAAE,IAAI,CAAC,SAAU,CAAC,CAAA;YACrH,OAAO,OAAO,CAAC,YAAY,EAAE,CAAA;SAC9B;IACH,CAAC;IAED,KAAK;QACH,IAAI,CAAC,SAAS,GAAG,IAAI,CAAA;QACrB,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAA;QACpB,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAA;IACvB,CAAC;IAEO,SAAS,CAAC,GAAa,EAAE,IAAqB;QACpD,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAA;QAC7B,IAAI,CAAC,IAAI,GAAG,IAAI,CAAA;QAChB,IAAI,IAAI,CAAC,QAAQ;YAAE,IAAI,CAAC,QAAQ,CAAC,IAAI,GAAG,IAAI,CAAA;QAC5C,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAA;QACpB,IAAI,IAAI,CAAC,SAAS,KAAK,IAAI;YAAE,IAAI,CAAC,SAAS,GAAG,IAAI,CAAA;QAClD,IAAI,GAAG,IAAI,IAAI;YAAE,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,CAAA;IAC/C,CAAC;IAEO,KAAK,CAAC,GAAa,EAAE,IAAqB;QAChD,IAAI,IAAI,CAAC,QAAQ;YAAE,IAAI,CAAC,QAAQ,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAA;QACjD,IAAI,IAAI,CAAC,IAAI;YAAE,IAAI,CAAC,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAA;QACjD,IAAI,IAAI,CAAC,SAAS,KAAK,IAAI;YAAE,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,IAAI,CAAA;QACvD,IAAI,IAAI,CAAC,QAAQ,KAAK,IAAI;YAAE,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAA;QACzD,IAAI,GAAG,KAAK,IAAI;YAAE,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;IAC7C,CAAC;IAEO,QAAQ,CAAC,IAAqB;QACpC,IAAI,IAAI,KAAK,IAAI,CAAC,QAAQ,EAAE;YAC1B,kCAAkC;YAClC,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAA;YACtB,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,IAAI,CAAC,CAAA;SAC3B;IACH,CAAC;IAEO,WAAW,CAAC,GAAM,EAAE,QAA0B;QACpD,qHAAqH;QACrH,OAAO,QAAQ,EAAE;aACd,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE;YACV,MAAM,IAAI,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;YACnC,IAAI,IAAI,EAAE;gBACR,IAAI,CAAC,KAAK,GAAG,EAAE,MAAM,EAAE,CAAC,EAAE,SAAS,EAAE,IAAI,CAAC,GAAG,EAAE,EAAE,CAAA;aAClD;YACD,OAAO,CAAC,CAAA;QACV,CAAC,CAAC;aACD,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE;YACX,MAAM,IAAI,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;YACnC,IAAI,IAAI,EAAE;gBACR,IAAI,CAAC,KAAK,CAAC,GAAG,EAAE,IAAI,CAAC,CAAA;aACtB;YACD,MAAM,CAAC,CAAA;QACT,CAAC,CAAC,CAAA;IACN,CAAC;CACF;AArGD,0DAqGC;AAID,MAAM,SAAS;IAMb,YAAY,GAAM,EAAE,QAAgC,EAAE,IAA4B,EAAE,KAAiB;QACnG,IAAI,CAAC,GAAG,GAAG,GAAG,CAAA;QACd,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAA;QACxB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAA;QAChB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAA;IACpB,CAAC;IAED,OAAO,CAAC,gBAAsC;QAC5C,IAAI,WAAW,IAAI,IAAI,CAAC,KAAK,EAAE;YAC7B,MAAM,WAAW,GAAG,gBAAgB,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAA;YACvD,OAAO,WAAW,GAAG,CAAC,IAAI,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,SAAS,GAAG,WAAW,CAAA;SAC1E;;YAAM,OAAO,KAAK,CAAA;IACrB,CAAC;IAED,YAAY;QACV,OAAO,WAAW,IAAI,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAA;IACpF,CAAC;IAED,IAAI,WAAW;QACb,OAAO,WAAW,IAAI,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAA;IAClE,CAAC;CACF","sourcesContent":["export class LruTemporisedAsyncCache<K, V> {\n  private readonly maxCacheSize: number\n  private readonly lifetimeForValue: (value: V) => number\n\n  private readonly nodesMap: Map<K, CacheNode<K, V>> = new Map()\n  private firstNode: CacheNode<K, V> | null = null\n  private lastNode: CacheNode<K, V> | null = null\n\n  /**\n   * @param maxCacheSize Maximum size of the cache. Any value <= 0 is considered as no limit.\n   * @param lifetimeForValue Get the maximum lifetime for an entry given its value.\n   */\n  constructor(maxCacheSize: number, lifetimeForValue: (value: V) => number) {\n    this.maxCacheSize = maxCacheSize\n    this.lifetimeForValue = lifetimeForValue\n  }\n\n  /**\n   * Gets a cached value or retrieves it and caches it if the value is not available or if it is available but expired. A value will never be expired\n   * if it was not yet retrieved, even if the retrieved value would be expired according to the {@link additionalExpirationCondition}\n   * @param key key of the entry\n   * @param retrieve given the previous value (if available, expired but not yet removed) of the entry retrieves an updated value.\n   * @param additionalExpirationCondition an expiration condition for already cached values to consider in addition to time-based expiration. Returns\n   * always false by default, meaning the value is not expired if its lifetime didn't already surpass the maximum lifetime.\n   * @return the cached value if present and not expired, else the retrieved value.\n   */\n  get(\n    key: K,\n    retrieve: (previousValue: V | undefined) => Promise<V>,\n    additionalExpirationCondition: (value: V) => boolean = () => false\n  ): Promise<V> {\n    const retrieved = this.nodesMap.get(key)\n    if (retrieved !== undefined) {\n      this.markUsed(retrieved)\n      const cachedValue = retrieved.cachedValue\n      if (retrieved.expired((x) => this.lifetimeForValue(x)) || (cachedValue !== undefined && additionalExpirationCondition(cachedValue))) {\n        retrieved.value = this.registerJob(key, () => retrieve(cachedValue))\n      }\n      return retrieved.valuePromise()\n    } else {\n      const newNode = new CacheNode(\n        key,\n        this.lastNode,\n        null,\n        this.registerJob(key, () => retrieve(undefined))\n      )\n      this.addToTail(key, newNode)\n      if (this.maxCacheSize > 0 && this.nodesMap.size > this.maxCacheSize) this.evict(this.firstNode!.key, this.firstNode!)\n      return newNode.valuePromise()\n    }\n  }\n\n  clear() {\n    this.firstNode = null\n    this.lastNode = null\n    this.nodesMap.clear()\n  }\n\n  private addToTail(key: K | null, node: CacheNode<K, V>) {\n    node.previous = this.lastNode\n    node.next = null\n    if (this.lastNode) this.lastNode.next = node\n    this.lastNode = node\n    if (this.firstNode === null) this.firstNode = node\n    if (key != null) this.nodesMap.set(key, node)\n  }\n\n  private evict(key: K | null, node: CacheNode<K, V>) {\n    if (node.previous) node.previous.next = node.next\n    if (node.next) node.next.previous = node.previous\n    if (this.firstNode === node) this.firstNode = node.next\n    if (this.lastNode === node) this.lastNode = node.previous\n    if (key !== null) this.nodesMap.delete(key)\n  }\n\n  private markUsed(node: CacheNode<K, V>) {\n    if (node !== this.lastNode) {\n      // No need to modify the nodes map\n      this.evict(null, node)\n      this.addToTail(null, node)\n    }\n  }\n\n  private registerJob(key: K, retrieve: () => Promise<V>): Promise<V> {\n    // The node may have already been evicted by the time the promise completed if the cached surpassed the maximum size.\n    return retrieve()\n      .then((v) => {\n        const node = this.nodesMap.get(key)\n        if (node) {\n          node.value = { cached: v, timestamp: Date.now() }\n        }\n        return v\n      })\n      .catch((e) => {\n        const node = this.nodesMap.get(key)\n        if (node) {\n          this.evict(key, node)\n        }\n        throw e\n      })\n  }\n}\n\ntype Cached<V> = { cached: V; timestamp: number }\n\nclass CacheNode<K, V> {\n  readonly key: K\n  previous: CacheNode<K, V> | null\n  next: CacheNode<K, V> | null\n  value: Promise<V> | Cached<V>\n\n  constructor(key: K, previous: CacheNode<K, V> | null, next: CacheNode<K, V> | null, value: Promise<V>) {\n    this.key = key\n    this.previous = previous\n    this.next = next\n    this.value = value\n  }\n\n  expired(lifetimeForValue: (value: V) => number): boolean {\n    if ('timestamp' in this.value) {\n      const maxLifetime = lifetimeForValue(this.value.cached)\n      return maxLifetime > 0 && Date.now() - this.value.timestamp > maxLifetime\n    } else return false\n  }\n\n  valuePromise(): Promise<V> {\n    return 'timestamp' in this.value ? Promise.resolve(this.value.cached) : this.value\n  }\n\n  get cachedValue(): V | undefined {\n    return 'timestamp' in this.value ? this.value.cached : undefined\n  }\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@icure/api",
-  "version": "6.4.0",
+  "version": "7.0.0-beta.1",
   "description": "Typescript version of iCure standalone API client",
   "main": "index.js",
   "types": "index.d.ts",