mesh-decorators 1.0.0

package/README.md

@@ -0,0 +1,35 @@
+# Mesh Decorators
+
+Small framework for creating custom decorators for use with [Mesh IoC](https://github.com/MeshIoC/mesh-ioc).
+
+## Usage
+
+```ts
+import { createMemberDecorator, findMembers, invokeMethods } from 'mesh-decorators';
+
+// 1. Create a decorator to track "init" methods
+const init = createMemberDecorator('init');
+
+class FooService {
+
+    // 2. Decorate members of the classes (can apply to methods and/or properties)
+    @init()
+    async setup() { /* ... */}
+
+}
+
+// 3. Bind the service(s) to a mesh
+const mesh = new Mesh();
+mesh.service(FooService);
+
+// 4. Get all references to members decorated with @init
+const initHandlers = findMembers('init', mesh);
+// [{ target: <instance of FooService>, memberName: 'setup' }]
+
+// 5. Invoke all @inmit methods
+await Promise.all(invokeMethods('init', mesh));
+```
+
+## License
+
+[ISC](https://en.wikipedia.org/wiki/ISC_license) © Boris Okunskiy

package/out/main/index.d.ts

@@ -0,0 +1 @@
+export * from './member.js';

package/out/main/index.js

@@ -0,0 +1,2 @@
+export * from './member.js';
+//# sourceMappingURL=index.js.map

package/out/main/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/main/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAC"}

package/out/main/member.d.ts

@@ -0,0 +1,23 @@
+import { Mesh } from 'mesh-ioc';
+export interface MemberRef {
+    target: any;
+    memberName: string;
+}
+export declare const globalMemberRefMap: Map<string, MemberRef[]>;
+/**
+ * Creates a decorator that tracks references to a particular class property or method in a global map.
+ * These member references can be subsequently accessed via `findMembers`.
+ */
+export declare function createMemberDecorator(decoratorName: string): () => (target: any, memberName: string) => void;
+/**
+ * Obtains a list of member references decorated by specified `decoratorName`.
+ *
+ * For each reference, the `target` is the actual instance of the class created by specified `mesh`.
+ */
+export declare function findMembers(decoratorName: string, mesh: Mesh, recursive?: boolean): MemberRef[];
+/**
+ * Convenience method to call all methods decorated with specified `decoratorName`.
+ *
+ * The order of results is generally not defined as decorators are called in the order the modules are imported.
+ */
+export declare function invokeMethods(decoratorName: string, mesh: Mesh, recursive?: boolean, ...args: any[]): any[];

package/out/main/member.js

@@ -0,0 +1,51 @@
+export const globalMemberRefMap = new Map();
+/**
+ * Creates a decorator that tracks references to a particular class property or method in a global map.
+ * These member references can be subsequently accessed via `findMembers`.
+ */
+export function createMemberDecorator(decoratorName) {
+    return function decorator() {
+        return (target, memberName) => {
+            const handlers = globalMemberRefMap.get(decoratorName) || [];
+            globalMemberRefMap.set(decoratorName, handlers);
+            handlers.push({
+                target: target.constructor,
+                memberName,
+            });
+        };
+    };
+}
+/**
+ * Obtains a list of member references decorated by specified `decoratorName`.
+ *
+ * For each reference, the `target` is the actual instance of the class created by specified `mesh`.
+ */
+export function findMembers(decoratorName, mesh, recursive = true) {
+    const result = [];
+    const refs = globalMemberRefMap.get(decoratorName) || [];
+    const bindings = recursive ? mesh.allBindings() : mesh.bindings.entries();
+    for (const [key, binding] of bindings) {
+        if (binding.type === 'service') {
+            for (const { target, memberName } of refs) {
+                if (target === binding.class || target.isPrototypeOf(binding.class)) {
+                    result.push({
+                        target: mesh.resolve(key),
+                        memberName,
+                    });
+                }
+            }
+        }
+    }
+    return result;
+}
+/**
+ * Convenience method to call all methods decorated with specified `decoratorName`.
+ *
+ * The order of results is generally not defined as decorators are called in the order the modules are imported.
+ */
+export function invokeMethods(decoratorName, mesh, recursive = true, ...args) {
+    const members = findMembers(decoratorName, mesh, recursive);
+    const results = members.map(ref => ref.target[ref.memberName](...args));
+    return results;
+}
+//# sourceMappingURL=member.js.map

package/out/main/member.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"member.js","sourceRoot":"","sources":["../../src/main/member.ts"],"names":[],"mappings":"AAOA,MAAM,CAAC,MAAM,kBAAkB,GAAG,IAAI,GAAG,EAAuB,CAAC;AAEjE;;;GAGG;AACH,MAAM,UAAU,qBAAqB,CAAC,aAAqB;IACvD,OAAO,SAAS,SAAS;QACrB,OAAO,CAAC,MAAW,EAAE,UAAkB,EAAE,EAAE;YACvC,MAAM,QAAQ,GAAG,kBAAkB,CAAC,GAAG,CAAC,aAAa,CAAC,IAAI,EAAE,CAAC;YAC7D,kBAAkB,CAAC,GAAG,CAAC,aAAa,EAAE,QAAQ,CAAC,CAAC;YAChD,QAAQ,CAAC,IAAI,CAAC;gBACV,MAAM,EAAE,MAAM,CAAC,WAAW;gBAC1B,UAAU;aACb,CAAC,CAAC;QACP,CAAC,CAAC;IACN,CAAC,CAAC;AACN,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,WAAW,CAAC,aAAqB,EAAE,IAAU,EAAE,SAAS,GAAG,IAAI;IAC3E,MAAM,MAAM,GAAgB,EAAE,CAAC;IAC/B,MAAM,IAAI,GAAG,kBAAkB,CAAC,GAAG,CAAC,aAAa,CAAC,IAAI,EAAE,CAAC;IACzD,MAAM,QAAQ,GAAG,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAC;IAC1E,KAAK,MAAM,CAAC,GAAG,EAAE,OAAO,CAAC,IAAI,QAAQ,EAAE,CAAC;QACpC,IAAI,OAAO,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;YAC7B,KAAK,MAAM,EAAE,MAAM,EAAE,UAAU,EAAE,IAAI,IAAI,EAAE,CAAC;gBACxC,IAAI,MAAM,KAAK,OAAO,CAAC,KAAK,IAAI,MAAM,CAAC,aAAa,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;oBAClE,MAAM,CAAC,IAAI,CAAC;wBACR,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC;wBACzB,UAAU;qBACb,CAAC,CAAC;gBACP,CAAC;YACL,CAAC;QACL,CAAC;IACL,CAAC;IACD,OAAO,MAAM,CAAC;AAClB,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,aAAa,CAAC,aAAqB,EAAE,IAAU,EAAE,SAAS,GAAG,IAAI,EAAE,GAAG,IAAW;IAC7F,MAAM,OAAO,GAAG,WAAW,CAAC,aAAa,EAAE,IAAI,EAAE,SAAS,CAAC,CAAC;IAC5D,MAAM,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC;IACxE,OAAO,OAAO,CAAC;AACnB,CAAC"}

package/package.json

@@ -0,0 +1,53 @@
+{
+    "name": "mesh-decorators",
+    "version": "1.0.0",
+    "description": "Custom decorators for Mesh IoC",
+    "type": "module",
+    "sideEffects": false,
+    "exports": {
+        ".": "./out/main/index.js"
+    },
+    "main": "out/main/index.js",
+    "types": "out/main/index.d.ts",
+    "files": [
+        "out/main/**/*"
+    ],
+    "scripts": {
+        "clean": "rm -rf out *.tsbuildinfo",
+        "dev": "npm run clean && tsc -b -w",
+        "compile": "npm run clean && tsc -b",
+        "lint": "eslint --ext=.js,.ts,.vue --cache .",
+        "test": "NODE_ENV=test mocha",
+        "preversion": "npm run lint",
+        "version": "npm run compile",
+        "postversion": "npm publish --access=public && git push origin main --tags"
+    },
+    "pre-commit": [
+        "lint"
+    ],
+    "repository": {
+        "type": "git",
+        "url": "git+ssh://git@github.com/MeshIoc/mesh-decorators.git"
+    },
+    "keywords": [
+        "ioc",
+        "di",
+        "decorators"
+    ],
+    "author": "Boris Okunskiy",
+    "license": "ISC",
+    "devDependencies": {
+        "@nodescript/eslint-config": "^1.2.0",
+        "@types/mocha": "^8.2.3",
+        "@types/node": "^16.18.88",
+        "chalk": "^4.1.2",
+        "eslint": "^8.57.0",
+        "mocha": "^9.2.2",
+        "pre-commit": "^1.2.2",
+        "reflect-metadata": "^0.1.14",
+        "typescript": "^5.4.2"
+    },
+    "dependencies": {
+        "mesh-ioc": "^3.3.0"
+    }
+}