@microphi/list 2.4.0 → 2.6.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Davide Cavaliere
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -2,7 +2,8 @@
 
 > Simple and fast list-like class
 
-It combines internally a map and an array of ids. The combination give this class the flexibility of an array and the ability to access directly to an element from its id.
+It combines internally a javascrript map and an array of ids. The combination give this class the flexibility of an array and the ability to access directly to an element from its id.
+
 
 ## Install
 With your preferred package manager install
@@ -15,7 +16,7 @@ With your preferred package manager install
 
 interface Entity {
   id: string;
-user: {
+  user: {
     email: string;
     name: string;
   };

package/lib/index.js

@@ -1,2 +1,4 @@
-export * from './lib/list/list';
-//# sourceMappingURL=index.js.map
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./lib/list/list"), exports);

package/lib/lib/list/list.js

@@ -1,5 +1,8 @@
-import { Subject } from 'rxjs';
-export class List {
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.List = void 0;
+const rxjs_1 = require("rxjs");
+class List {
     get size() {
         if (this.ids.length !== this.entities.size) {
             throw new Error(`Size Mismatch ${this.ids.length} !== ${this.entities.size}`);
@@ -17,7 +20,7 @@ export class List {
     }
     constructor(IDField, entities = []) {
         this.IDField = IDField;
-        this.operations$ = new Subject();
+        this.operations$ = new rxjs_1.Subject();
         this.entities = new Map();
         /**
          * maps entities position from the original array to their ids
@@ -94,4 +97,4 @@ export class List {
         this.operations$.next({ op: 'append', payload: entities, timestamp: new Date() });
     }
 }
-//# sourceMappingURL=list.js.map
+exports.List = List;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@microphi/list",
-  "version": "2.4.0",
+  "version": "2.6.0",
   "description": "Simple and fast list-like class",
   "main": "lib/index.js",
   "typings": "lib/index.d.ts",
@@ -29,7 +29,7 @@
     "lint": "eslint ./src"
   },
   "dependencies": {
-    "@microphi/debug": "^2.3.0"
+    "@microphi/debug": "^2.6.0"
   },
   "devDependencies": {
     "@babel/plugin-transform-modules-commonjs": "^7.23.3",
@@ -38,5 +38,6 @@
   },
   "peerDependencies": {
     "rxjs": "~7.8.0"
-  }
+  },
+  "gitHead": "6239637f38d555081da1647b962184616010146e"
 }

package/lib/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,iBAAiB,CAAC","sourcesContent":["export * from './lib/list/list';\n"]}

package/lib/lib/list/list.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"list.js","sourceRoot":"","sources":["../../../src/lib/list/list.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,MAAM,CAAC;AAW/B,MAAM,OAAO,IAAI;IAWf,IAAW,IAAI;QACb,IAAI,IAAI,CAAC,GAAG,CAAC,MAAM,KAAK,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC;YAE3C,MAAM,IAAI,KAAK,CAAC,iBAAiB,IAAI,CAAC,GAAG,CAAC,MAAM,QAAQ,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC;QAChF,CAAC;QAED,OAAO,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC;IAC5B,CAAC;IAEM,GAAG,CAAC,EAAU;QACnB,OAAO,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;IAC/B,CAAC;IAEM,GAAG,CAAC,EAAU;QACnB,OAAO,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;IAC/B,CAAC;IAEO,KAAK,CAAC,MAAkB;QAC9B,OAAO,MAAM,CAAC,IAAI,CAAC,OAAO,CAAW,CAAC;IACxC,CAAC;IAED,YAAoB,OAA0B,EAAE,WAAyB,EAAE;QAAvD,YAAO,GAAP,OAAO,CAAmB;QA9BvC,gBAAW,GAAG,IAAI,OAAO,EAAa,CAAC;QAE9B,aAAQ,GAAG,IAAI,GAAG,EAAsB,CAAC;QAEzD;;WAEG;QACc,QAAG,GAAa,EAAE,CAAC;QAyBlC,IAAI,CAAC,GAAG,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;QAE9C,QAAQ;aACL,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;YAChB,MAAM,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;YAC5B,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC;QAC9B,CAAC,CAAC,CAAC;IACP,CAAC;IAED,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC;QAChB,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,GAAG,EAAE,CAAC;YAC3B,MAAM,EAAE,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;YAEzB,MAAM,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;YACrC,IAAI,MAAM,EAAE,CAAC;gBACX,MAAM,MAAM,CAAC;YACf,CAAC;iBAAM,CAAC;gBACN,MAAM,IAAI,KAAK,CAAC,6BAA6B,EAAE,EAAE,CAAC,CAAC;YACrD,CAAC;QACH,CAAC;IACH,CAAC;IAED;;QAEI;IACG,MAAM,CAAC,GAAG,QAAsB;QACrC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE;YACrB,MAAM,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;YAEzB,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC;gBAC3B,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;YACpB,CAAC;YAED,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC;QAE3B,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,EAAE,EAAE,QAAQ,EAAE,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,IAAI,IAAI,EAAE,EAAE,CAAC,CAAC;IACpF,CAAC;IAEM,OAAO,CAAC,GAAG,QAAsB;QACtC,QAAQ,CAAC,OAAO,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE;YAC/B,MAAM,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;YAEzB,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC;gBAC1B,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;YACjB,CAAC;YAED,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;YAErB,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC;QAE3B,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,EAAE,EAAE,SAAS,EAAE,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,IAAI,IAAI,EAAE,EAAE,CAAC,CAAC;IACrF,CAAC;IAEM,KAAK;QAEV,IAAI,CAAC,GAAG,CAAC,MAAM,GAAG,CAAC,CAAC;QACpB,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC;QACtB,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,EAAE,EAAE,OAAO,EAAE,SAAS,EAAE,IAAI,IAAI,EAAE,EAAE,CAAC,CAAC;IAEhE,CAAC;IAEM,MAAM,CAAC,GAAG,QAAsB;QAErC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE;YACrB,MAAM,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;YACzB,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,KAAK,EAAE,CAAC,CAAC;YAE1D,IAAI,SAAS,IAAI,CAAC,EAAE,CAAC;gBACnB,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC;gBAC9B,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;YAC3B,CAAC;QACH,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,EAAE,EAAE,QAAQ,EAAE,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,IAAI,IAAI,EAAE,EAAE,CAAC,CAAC;IACpF,CAAC;IAEM,MAAM,CAAC,GAAG,QAAsB;QACrC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE;YACrB,MAAM,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;YAEzB,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC;gBAC1B,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;YACjB,CAAC;YAED,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;YAClB,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC;QAC3B,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,EAAE,EAAE,QAAQ,EAAE,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,IAAI,IAAI,EAAE,EAAE,CAAC,CAAC;IACpF,CAAC;CAGF","sourcesContent":["import { Subject } from 'rxjs';\nimport { $Keys, FunctionKeys } from 'utility-types';\n\n\nexport interface Operation {\n  // eslint-disable-next-line @typescript-eslint/no-explicit-any\n  op: FunctionKeys<List<any>>;\n  payload?: unknown;\n  timestamp: Date;\n}\n\nexport class List<EntityType extends object> implements Iterable<EntityType> {\n\n  public operations$ = new Subject<Operation>();\n\n  public readonly entities = new Map<string, EntityType>();\n\n  /**\n   * maps entities position from the original array to their ids\n   */\n  private readonly ids: string[] = [];\n\n  public get size() {\n    if (this.ids.length !== this.entities.size) {\n\n      throw new Error(`Size Mismatch ${this.ids.length} !== ${this.entities.size}`);\n    }\n\n    return this.entities.size;\n  }\n\n  public has(id: string) {\n    return this.entities.has(id);\n  }\n\n  public get(id: string) {\n    return this.entities.get(id);\n  }\n\n  private getId(entity: EntityType): string {\n    return entity[this.IDField] as string;\n  }\n\n  constructor(private IDField: $Keys<EntityType>, entities: EntityType[] = []) {\n\n    this.ids = entities.map((e) => this.getId(e));\n\n    entities\n      .forEach((item) => {\n        const id = this.getId(item);\n        this.entities.set(id, item);\n      });\n  }\n\n  *[Symbol.iterator](): IterableIterator<EntityType> {\n    for (const idx in this.ids) {\n      const id = this.ids[idx];\n\n      const entity = this.entities.get(id);\n      if (entity) {\n        yield entity;\n      } else {\n        throw new Error(`Cannot get entity with id ${id}`);\n      }\n    }\n  }\n\n  /**\n  * Upsert one or more items. I.e.: append if new update otherwise\n  * */\n  public upsert(...entities: EntityType[]) {\n    entities.forEach((e) => {\n      const id = this.getId(e);\n\n      if (!this.entities.has(id)) {\n        this.ids.push(id);\n      }\n\n      this.entities.set(id, e);\n\n    });\n\n    this.operations$.next({ op: 'upsert', payload: entities, timestamp: new Date() });\n  }\n\n  public prepend(...entities: EntityType[]) {\n    entities.reverse().forEach((e) => {\n      const id = this.getId(e);\n\n      if (this.entities.has(id)) {\n        this.delete(e);\n      }\n\n      this.ids.unshift(id);\n\n      this.entities.set(id, e);\n\n    });\n    this.operations$.next({ op: 'prepend', payload: entities, timestamp: new Date() });\n  }\n\n  public clear() {\n\n    this.ids.length = 0;\n    this.entities.clear();\n    this.operations$.next({ op: 'clear', timestamp: new Date() });\n\n  }\n\n  public delete(...entities: EntityType[]) {\n\n    entities.forEach((e) => {\n      const id = this.getId(e);\n      const indexOfId = this.ids.findIndex((_id) => _id === id);\n\n      if (indexOfId >= 0) {\n        this.ids.splice(indexOfId, 1);\n        this.entities.delete(id);\n      }\n    });\n\n    this.operations$.next({ op: 'delete', payload: entities, timestamp: new Date() });\n  }\n\n  public append(...entities: EntityType[]) {\n    entities.forEach((e) => {\n      const id = this.getId(e);\n\n      if (this.entities.has(id)) {\n        this.delete(e);\n      }\n\n      this.ids.push(id);\n      this.entities.set(id, e);\n    });\n\n    this.operations$.next({ op: 'append', payload: entities, timestamp: new Date() });\n  }\n\n\n}\n"]}