@geosdi/ngx-model 1.2.2 → 1.2.4

package/README.md

@@ -1,24 +1,81 @@
-# NgxModel
+# @geosdi/ngx-model
 
-This library was generated with [Angular CLI](https://github.com/angular/angular-cli) version 15.2.0.
+The building blocks of two design patterns, plus a base model: a **chain of responsibility**
+(`NgxChainHandler`) and a **mediator** with its colleagues (`NgxMediator`, `NgxColleague`). Plain
+TypeScript: no Angular, no dependencies.
 
-## Code scaffolding
+## Installation
 
-Run `ng generate component component-name --project ngx-model` to generate a new component. You can also use `ng generate directive|pipe|service|class|guard|interface|enum|module --project ngx-model`.
-> Note: Don't forget to add `--project ngx-model` or else it will be added to the default project in your `angular.json` file. 
+`npm i @geosdi/ngx-model --save`
 
-## Build
+It has no dependencies.
 
-Run `ng build ngx-model` to build the project. The build artifacts will be stored in the `dist/` directory.
+## Chain of responsibility
 
-## Publishing
+`NgxChainHandler<B>` holds the next handler of the chain. Each handler decides whether it handles the
+input or passes it on to `_successor`; the library gives the link, the method is yours.
 
-After building your library with `ng build ngx-model`, go to the dist folder `cd dist/ngx-model` and run `npm publish`.
+```typescript
+import { NgxChainHandler } from "@geosdi/ngx-model";
 
-## Running unit tests
+abstract class StyleHandler extends NgxChainHandler<StyleHandler> {
+  abstract style(feature: Feature): PathOptions;
 
-Run `ng test ngx-model` to execute the unit tests via [Karma](https://karma-runner.github.io).
+  protected forward(feature: Feature): PathOptions {
+    return this._successor ? this._successor.style(feature) : {};
+  }
+}
 
-## Further help
+class BuildingHandler extends StyleHandler {
+  style(feature: Feature): PathOptions {
+    return feature.properties.type === "building"
+      ? { color: "blue" }
+      : this.forward(feature);
+  }
+}
 
-To get more help on the Angular CLI use `ng help` or go check out the [Angular CLI Overview and Command Reference](https://angular.io/cli) page.
+const first = new BuildingHandler();
+first.successor = new AggregateHandler();
+first.style(feature);
+```
+
+- the type parameter is the handler's own base type, so `_successor` has the same methods as the
+  handler that calls it;
+- `successor` has only a setter: subclasses read `_successor`, which is `protected`;
+- the last handler of the chain has no successor, so decide what it returns when nothing matched.
+
+## Mediator
+
+`NgxMediator<C>` receives the colleagues and finds them by key. A colleague is anything that
+implements `INgxColleague` — a `getKey()` — or extends `NgxColleague`.
+
+```typescript
+import { NgxColleague, NgxMediator } from "@geosdi/ngx-model";
+
+class DeleteAction extends NgxColleague {
+  getKey(): string {
+    return "delete";
+  }
+}
+
+const mediator = new NgxMediator<NgxColleague>([
+  new DeleteAction(),
+  new SplitAction(),
+]);
+mediator.getColleague("delete"); // the DeleteAction
+mediator.getColleague("missing"); // null
+```
+
+- the colleagues are indexed once, in the constructor: to change them, build a new mediator;
+- **two colleagues with the same key**: the last one wins, with no warning;
+- `getColleague` returns `null` for an unknown key;
+- `NgxMediator` is a plain class, not an Angular service: to inject it, provide it yourself (for
+  instance with a `useFactory` that receives the colleagues).
+
+## Model
+
+`Model` is the base interface of an entity: an optional `id`, a string or a number.
+
+## Changes in 1.2.4
+
+- This README, which replaces the one generated by Angular CLI. The code is unchanged.

package/fesm2022/geosdi-ngx-model.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"geosdi-ngx-model.mjs","sources":["../../../../projects/geosdi/support/ngx-model/src/lib/ngx-chain-handler.ts","../../../../projects/geosdi/support/ngx-model/src/lib/ngx-colleague.ts","../../../../projects/geosdi/support/ngx-model/src/lib/ngx-mediator.service.ts","../../../../projects/geosdi/support/ngx-model/src/index.ts","../../../../projects/geosdi/support/ngx-model/src/geosdi-ngx-model.ts"],"sourcesContent":["/**\n * @author Vito Salvia - CNR IMAA geoSDI Group\n * @email vito.salvia@gmail.com\n */\nexport abstract class NgxChainHandler<B extends NgxChainHandler<B>> {\n    protected _successor: B;\n\n    /**\n     *\n     */\n    public set successor(_successor: B) {\n        this._successor = _successor;\n    }\n}\n","/**\n * @author Vito Salvia - CNR IMAA geoSDI Group\n * @email vito.salvia@gmail.com\n */\nexport interface INgxColleague {\n    /**\n     *\n     */\n    getKey(): any;\n}\n\nexport abstract class NgxColleague implements INgxColleague {\n    /**\n     *\n     */\n    abstract getKey(): any;\n}\n","import { INgxColleague } from \"./ngx-colleague\";\n\n/**\n * @author Vito Salvia - CNR IMAA geoSDI Group\n * @email vito.salvia@gmail.com\n */\nexport class NgxMediator<C extends INgxColleague> {\n    protected colleaguesMap: Map<string, C> = new Map();\n\n    constructor(private colleagues: ReadonlyArray<C>) {\n        this.initColleagues();\n    }\n\n    /**\n     *\n     */\n    initColleagues() {\n        this.colleagues.forEach((c) => {\n            this.colleaguesMap.set(c.getKey(), c);\n        });\n    }\n\n    /**\n     *\n     * @param key\n     */\n    getColleague(key: string) {\n        return this.colleaguesMap.has(key) ? this.colleaguesMap.get(key) : null;\n    }\n}\n","/*\n * Public API Surface of ngx-model\n */\n\nexport * from \"./lib/ngx-model\";\nexport * from \"./lib/ngx-chain-handler\";\nexport * from \"./lib/ngx-colleague\";\nexport * from \"./lib/ngx-mediator.service\";\n","/**\n * Generated bundle index. Do not edit.\n */\n\nexport * from './index';\n"],"names":[],"mappings":"AAAA;;;AAGG;MACmB,eAAe,CAAA;AAGjC;;AAEG;IACH,IAAW,SAAS,CAAC,UAAa,EAAA;AAC9B,QAAA,IAAI,CAAC,UAAU,GAAG,UAAU;;AAEnC;;MCFqB,YAAY,CAAA;AAKjC;;ACdD;;;AAGG;MACU,WAAW,CAAA;AAGpB,IAAA,WAAA,CAAoB,UAA4B,EAAA;QAA5B,IAAU,CAAA,UAAA,GAAV,UAAU;AAFpB,QAAA,IAAA,CAAA,aAAa,GAAmB,IAAI,GAAG,EAAE;QAG/C,IAAI,CAAC,cAAc,EAAE;;AAGzB;;AAEG;IACH,cAAc,GAAA;QACV,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC,KAAI;AAC1B,YAAA,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;AACzC,SAAC,CAAC;;AAGN;;;AAGG;AACH,IAAA,YAAY,CAAC,GAAW,EAAA;QACpB,OAAO,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,IAAI;;AAE9E;;AC7BD;;AAEG;;ACFH;;AAEG;;;;"}
+{"version":3,"file":"geosdi-ngx-model.mjs","sources":["../../../../projects/geosdi/support/ngx-model/src/lib/ngx-chain-handler.ts","../../../../projects/geosdi/support/ngx-model/src/lib/ngx-colleague.ts","../../../../projects/geosdi/support/ngx-model/src/lib/ngx-mediator.service.ts","../../../../projects/geosdi/support/ngx-model/src/index.ts","../../../../projects/geosdi/support/ngx-model/src/geosdi-ngx-model.ts"],"sourcesContent":["/**\n * @author Vito Salvia - CNR IMAA geoSDI Group\n * @email vito.salvia@gmail.com\n */\nexport abstract class NgxChainHandler<B extends NgxChainHandler<B>> {\n    protected _successor: B;\n\n    /**\n     *\n     */\n    public set successor(_successor: B) {\n        this._successor = _successor;\n    }\n}\n","/**\n * @author Vito Salvia - CNR IMAA geoSDI Group\n * @email vito.salvia@gmail.com\n */\nexport interface INgxColleague {\n    /**\n     *\n     */\n    getKey(): any;\n}\n\nexport abstract class NgxColleague implements INgxColleague {\n    /**\n     *\n     */\n    abstract getKey(): any;\n}\n","import { INgxColleague } from \"./ngx-colleague\";\n\n/**\n * @author Vito Salvia - CNR IMAA geoSDI Group\n * @email vito.salvia@gmail.com\n */\nexport class NgxMediator<C extends INgxColleague> {\n    protected colleaguesMap: Map<string, C> = new Map();\n\n    constructor(private colleagues: ReadonlyArray<C>) {\n        this.initColleagues();\n    }\n\n    /**\n     *\n     */\n    initColleagues() {\n        this.colleagues.forEach((c) => {\n            this.colleaguesMap.set(c.getKey(), c);\n        });\n    }\n\n    /**\n     *\n     * @param key\n     */\n    getColleague(key: string) {\n        return this.colleaguesMap.has(key) ? this.colleaguesMap.get(key) : null;\n    }\n}\n","/*\n * Public API Surface of ngx-model\n */\n\nexport * from \"./lib/ngx-model\";\nexport * from \"./lib/ngx-chain-handler\";\nexport * from \"./lib/ngx-colleague\";\nexport * from \"./lib/ngx-mediator.service\";\n","/**\n * Generated bundle index. Do not edit.\n */\n\nexport * from './index';\n"],"names":[],"mappings":"AAAA;;;AAGG;MACmB,eAAe,CAAA;AAGjC;;AAEG;IACH,IAAW,SAAS,CAAC,UAAa,EAAA;AAC9B,QAAA,IAAI,CAAC,UAAU,GAAG,UAAU;IAChC;AACH;;MCFqB,YAAY,CAAA;AAKjC;;ACdD;;;AAGG;MACU,WAAW,CAAA;AAGpB,IAAA,WAAA,CAAoB,UAA4B,EAAA;QAA5B,IAAA,CAAA,UAAU,GAAV,UAAU;AAFpB,QAAA,IAAA,CAAA,aAAa,GAAmB,IAAI,GAAG,EAAE;QAG/C,IAAI,CAAC,cAAc,EAAE;IACzB;AAEA;;AAEG;IACH,cAAc,GAAA;QACV,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC,KAAI;AAC1B,YAAA,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;AACzC,QAAA,CAAC,CAAC;IACN;AAEA;;;AAGG;AACH,IAAA,YAAY,CAAC,GAAW,EAAA;QACpB,OAAO,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,IAAI;IAC3E;AACH;;AC7BD;;AAEG;;ACFH;;AAEG;;;;"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@geosdi/ngx-model",
-  "version": "1.2.2",
+  "version": "1.2.4",
   "description": "Model class",
   "author": "Salvia Vito (vito.salvia@gmail.com)",
   "keywords": [
@@ -8,16 +8,17 @@
   ],
   "sideEffects": false,
   "module": "fesm2022/geosdi-ngx-model.mjs",
-  "typings": "index.d.ts",
+  "typings": "types/geosdi-ngx-model.d.ts",
   "exports": {
     "./package.json": {
       "default": "./package.json"
     },
     ".": {
-      "types": "./index.d.ts",
+      "types": "./types/geosdi-ngx-model.d.ts",
       "default": "./fesm2022/geosdi-ngx-model.mjs"
     }
   },
+  "type": "module",
   "dependencies": {
     "tslib": "^2.3.0"
   }

package/types/geosdi-ngx-model.d.ts

@@ -0,0 +1,58 @@
+/**
+ * @author Vito Salvia - CNR IMAA geoSDI Group
+ * @email vito.salvia@gmail.com
+ */
+interface Model {
+    id?: string | number | null;
+}
+
+/**
+ * @author Vito Salvia - CNR IMAA geoSDI Group
+ * @email vito.salvia@gmail.com
+ */
+declare abstract class NgxChainHandler<B extends NgxChainHandler<B>> {
+    protected _successor: B;
+    /**
+     *
+     */
+    set successor(_successor: B);
+}
+
+/**
+ * @author Vito Salvia - CNR IMAA geoSDI Group
+ * @email vito.salvia@gmail.com
+ */
+interface INgxColleague {
+    /**
+     *
+     */
+    getKey(): any;
+}
+declare abstract class NgxColleague implements INgxColleague {
+    /**
+     *
+     */
+    abstract getKey(): any;
+}
+
+/**
+ * @author Vito Salvia - CNR IMAA geoSDI Group
+ * @email vito.salvia@gmail.com
+ */
+declare class NgxMediator<C extends INgxColleague> {
+    private colleagues;
+    protected colleaguesMap: Map<string, C>;
+    constructor(colleagues: ReadonlyArray<C>);
+    /**
+     *
+     */
+    initColleagues(): void;
+    /**
+     *
+     * @param key
+     */
+    getColleague(key: string): C;
+}
+
+export { NgxChainHandler, NgxColleague, NgxMediator };
+export type { INgxColleague, Model };

package/index.d.ts

@@ -1,4 +0,0 @@
-export * from "./lib/ngx-model";
-export * from "./lib/ngx-chain-handler";
-export * from "./lib/ngx-colleague";
-export * from "./lib/ngx-mediator.service";

package/lib/ngx-chain-handler.d.ts

@@ -1,11 +0,0 @@
-/**
- * @author Vito Salvia - CNR IMAA geoSDI Group
- * @email vito.salvia@gmail.com
- */
-export declare abstract class NgxChainHandler<B extends NgxChainHandler<B>> {
-    protected _successor: B;
-    /**
-     *
-     */
-    set successor(_successor: B);
-}

package/lib/ngx-colleague.d.ts

@@ -1,16 +0,0 @@
-/**
- * @author Vito Salvia - CNR IMAA geoSDI Group
- * @email vito.salvia@gmail.com
- */
-export interface INgxColleague {
-    /**
-     *
-     */
-    getKey(): any;
-}
-export declare abstract class NgxColleague implements INgxColleague {
-    /**
-     *
-     */
-    abstract getKey(): any;
-}

package/lib/ngx-mediator.service.d.ts

@@ -1,19 +0,0 @@
-import { INgxColleague } from "./ngx-colleague";
-/**
- * @author Vito Salvia - CNR IMAA geoSDI Group
- * @email vito.salvia@gmail.com
- */
-export declare class NgxMediator<C extends INgxColleague> {
-    private colleagues;
-    protected colleaguesMap: Map<string, C>;
-    constructor(colleagues: ReadonlyArray<C>);
-    /**
-     *
-     */
-    initColleagues(): void;
-    /**
-     *
-     * @param key
-     */
-    getColleague(key: string): C;
-}

package/lib/ngx-model.d.ts

@@ -1,7 +0,0 @@
-/**
- * @author Vito Salvia - CNR IMAA geoSDI Group
- * @email vito.salvia@gmail.com
- */
-export interface Model {
-    id?: string | number | null;
-}