@slimlib/injector 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Konstantin Shutkin
+
+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

@@ -0,0 +1,78 @@
+# injector
+
+Parameter names based dependency injector for nodejs.
+
+*Limitations*
+
+- does not work with default parameters
+- minification of code is not supported
+- not typesafe
+- classes not supported
+- slower than normal function call
+
+## API
+
+### createInject()
+
+returns new instance of an injector function to work with.
+
+### injector(function, scope)
+
+injects arguments into function and invoke it
+
+`function` - *required*, function to inject parameters and call
+`scope` - *optional*, *default* = `{}`, this argument for the function
+
+### $provide(key, value)
+
+predefined injectable function
+
+`key` - string, required
+`value` - unknown
+
+to get it, inject it in the function
+
+```typescript
+inject(($provide: Provider) => {
+    $provide('service', service);
+});
+```
+
+## Example
+
+```typescript
+import createInject from '@slimlib/injector';
+
+const inject = createInject();
+
+inject(($provide: Provider) => {
+    $provide('config', {
+        url: 'http://example.com/json',
+        format: 'json'
+    });
+});
+
+inject(async (config: Json) => {
+    const data = await fetch(config.url);
+    const result = config.json ? await data.json() : data;
+    // and so on
+});
+```
+
+# FAQ
+
+1. Is it good solution to mock something in unit tests?
+
+- no, please use [jest](https://jestjs.io/), [vitest](https://vitest.dev/), [proxyquire](https://www.npmjs.com/package/proxyquire), [proxyrequire](https://www.npmjs.com/package/proxyrequire) and other similar approaches to mock modules.
+
+2. Is it good solution to use in frontend code?
+
+- no, it will not work after minification
+
+3. Is it good for nodejs applications?
+
+- only in some edge cases, please use singletones / factories / something else if possible
+
+# License
+
+[MIT](./LICENSE)

package/dist/index.cjs

@@ -0,0 +1,15 @@
+'use strict';
+
+var getParameterNames = require('get-parameter-names');
+
+var index = () => {
+    const dependencies = Object.create(null);
+    dependencies['$provide'] = (key, value) => {
+        dependencies[key] = value;
+    };
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    return (func, scope = {}) => func.apply(scope, getParameterNames(func)
+        .map((key) => dependencies[key]));
+};
+
+module.exports = index;

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+export declare type Provider = (key: string, value: unknown) => void;
+declare const _default: () => <F extends (...args: any[]) => any>(func: F, scope?: object) => ReturnType<F>;
+export default _default;

package/dist/index.mjs

@@ -0,0 +1,13 @@
+import getParameterNames from 'get-parameter-names';
+
+var index = () => {
+    const dependencies = Object.create(null);
+    dependencies['$provide'] = (key, value) => {
+        dependencies[key] = value;
+    };
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    return (func, scope = {}) => func.apply(scope, getParameterNames(func)
+        .map((key) => dependencies[key]));
+};
+
+export { index as default };

package/package.json

@@ -0,0 +1,61 @@
+{
+  "version": "1.0.0",
+  "license": "MIT",
+  "name": "@slimlib/injector",
+  "author": "Konstantin Shutkin",
+  "type": "module",
+  "exports": {
+    ".": {
+      "require": "./dist/index.cjs",
+      "default": "./dist/index.mjs"
+    },
+    "./package.json": "./package.json"
+  },
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.mjs",
+  "typings": "./dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "engines": {
+    "node": ">=15"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/kshutkin/slimlib.git"
+  },
+  "bugs": {
+    "url": "https://github.com/kshutkin/slimlib/issues"
+  },
+  "homepage": "https://github.com/kshutkin/slimlib/injector/README.md",
+  "readme": "README.md",
+  "description": "Parameter names based dependency injector for nodejs",
+  "scripts": {
+    "build": "pkgbld",
+    "test": "jest --collectCoverage",
+    "lint": "eslint ./src",
+    "semantic-release": "npx semantic-release"
+  },
+  "devDependencies": {
+    "@semantic-release/changelog": "6.0.1",
+    "@semantic-release/commit-analyzer": "9.0.2",
+    "@semantic-release/git": "10.0.1",
+    "@semantic-release/npm": "9.0.0",
+    "@semantic-release/release-notes-generator": "10.0.3",
+    "@types/jest": "27.4.0",
+    "@typescript-eslint/eslint-plugin": "5.11.0",
+    "@typescript-eslint/parser": "5.11.0",
+    "conventional-changelog-angular": "5.0.13",
+    "eslint": "8.8.0",
+    "jest": "27.5.1",
+    "semantic-release": "19.0.2",
+    "semantic-release-monorepo": "7.0.5",
+    "ts-jest": "27.1.3",
+    "typescript": "4.5.x",
+    "update-monorepo-package-json": "0.2.0",
+    "pkgbld": "1.7.1"
+  },
+  "dependencies": {
+    "get-parameter-names": "0.3.0"
+  }
+}