diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml new file mode 100644 index 0000000..e8c83bd --- /dev/null +++ b/.github/FUNDING.yml @@ -0,0 +1,15 @@ +# These are supported funding model platforms + +github: [angular-package] # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2] +patreon: angularpackage # Replace with a single Patreon username +open_collective: # Replace with a single Open Collective username +ko_fi: # Replace with a single Ko-fi username +tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel +community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry +liberapay: # Replace with a single Liberapay username +issuehunt: # Replace with a single IssueHunt username +otechie: # Replace with a single Otechie username +custom: [ + 'https://checkout.revolut.com/pay/048b10a3-0e10-42c8-a917-e3e9cb4c8e29', + 'https://donate.stripe.com/dR614hfDZcJE3wAcMM' +] # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2'] diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..3a183d6 --- /dev/null +++ b/.gitignore @@ -0,0 +1,45 @@ +# See https://docs.github.com/get-started/getting-started-with-git/ignoring-files for more about ignoring files. + +# Compiled output +/dist +/tmp +/out-tsc +/bazel-out + +# Node +/node_modules +npm-debug.log +yarn-error.log + +# IDEs and editors +.idea/ +.project +.classpath +.c9/ +*.launch +.settings/ +*.sublime-workspace + +# Visual Studio Code +.vscode/* +!.vscode/settings.json +!.vscode/tasks.json +!.vscode/launch.json +!.vscode/extensions.json +.history/* + +# Miscellaneous +/.angular/cache +.sass-cache/ +/connect.lock +/coverage +/libpeerconnection.log +testem.log +/typings + +# System files +.DS_Store +Thumbs.db + +*.ignore* +temp \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..9e16ae4 --- /dev/null +++ b/README.md @@ -0,0 +1,199 @@ + + + + + +## @typescript-package/middleware + + +[![npm version][typescript-package-npm-badge-svg]][typescript-package-npm-badge] +[![GitHub issues][typescript-package-badge-issues]][typescript-package-issues] +[![GitHub license][typescript-package-badge-license]][typescript-package-license] + +A **lightweight** TypeScript library for middleware. + +## Features + +## Table of contents + +- [Installation](#installation) +- [Api](#api) + - Class + - [`Middleware`](#middleware) +- [Contributing](#contributing) +- [Support](#support) +- [Code of Conduct](code-of-conduct) +- [Git](#git) + - [Commit](#commit) + - [Versioning](#versioning) +- [License](#license) +- [Related packages](#related-packages) + +## Installation + +### 1. Install the package + +```bash +npm install @typescript-package/middleware --save-peer +``` + +## Api + +### `Middleware` + +```typescript +import { Middleware } from '@typescript-package/middleware'; + +// Initialize. +const middleware = new Middleware(); + +// Add middleware. +middleware.use((args, next) => { + console.log('Middleware 1 executed with args:', args); + + // Modify args. + args[0].newKey = 'newValue'; + + // Execute next. + next(); +}); + +middleware.use((args, next) => { + console.log('Middleware 2 executed with args:', args); + + // Execute next. + next(); +}); + +// logs +// Middleware 1 executed with args: [ { key: 'value' } ] +// Middleware 2 executed with args: [ { key: 'value', newKey: 'newValue' } ] +middleware.execute({ key: 'value' }); + + +// Async +middleware.use(async (args, next) => { + console.log('Async middleware 1 start with args:', args); + args[0].newKey = 'newValue'; + await new Promise(resolve => setTimeout(resolve, 2000)); + console.log('Async middleware end'); + next(); +}); + +middleware.use(async (args, next) => { + console.log('Async middleware 2 start with args:', args); + next(); +}); + +middleware.onComplete((args) => { + console.log('All middlewares completed with args:', args); +}); + +middleware.executeAsync({ key: 'value' }); +``` + +## Contributing + +Your contributions are valued! If you'd like to contribute, please feel free to submit a pull request. Help is always appreciated. + +## Support + +If you find this package useful and would like to support its and general development, you can contribute through one of the following payment methods. Your support helps maintain the packages and continue adding new. + +Support via: + +- [Stripe](https://donate.stripe.com/dR614hfDZcJE3wAcMM) +- [Revolut](https://checkout.revolut.com/pay/048b10a3-0e10-42c8-a917-e3e9cb4c8e29) +- [GitHub](https://github.com/sponsors/angular-package/sponsorships?sponsor=sciborrudnicki&tier_id=83618) +- [DonorBox](https://donorbox.org/become-a-sponsor-to-the-angular-package?default_interval=o) +- [Patreon](https://www.patreon.com/checkout/angularpackage?rid=0&fan_landing=true&view_as=public) + +or via Trust Wallet + +- [XLM](https://link.trustwallet.com/send?coin=148&address=GAFFFB7H3LG42O6JA63FJDRK4PP4JCNEOPHLGLLFH625X2KFYQ4UYVM4) +- [USDT (BEP20)](https://link.trustwallet.com/send?coin=20000714&address=0xA0c22A2bc7E37C1d5992dFDFFeD5E6f9298E1b94&token_id=0x55d398326f99059fF775485246999027B3197955) +- [ETH](https://link.trustwallet.com/send?coin=60&address=0xA0c22A2bc7E37C1d5992dFDFFeD5E6f9298E1b94) +- [BTC](https://link.trustwallet.com/send?coin=0&address=bc1qnf709336tfl57ta5mfkf4t9fndhx7agxvv9svn) +- [BNB](https://link.trustwallet.com/send?coin=20000714&address=0xA0c22A2bc7E37C1d5992dFDFFeD5E6f9298E1b94) + +## Code of Conduct + +By participating in this project, you agree to follow **[Code of Conduct](https://www.contributor-covenant.org/version/2/1/code_of_conduct/)**. + +## GIT + +### Commit + +Please follow the following commit message conventions: + +- [AngularJS Git Commit Message Conventions][git-commit-angular] +- [Karma Git Commit Msg][git-commit-karma] +- [Conventional Commits][git-commit-conventional] + +### Versioning + +The package follows [Semantic Versioning 2.0.0][git-semver] for all releases. The versioning format is: + +**Given a version number MAJOR.MINOR.PATCH, increment the:** + +- MAJOR version when you make incompatible API changes, +- MINOR version when you add functionality in a backwards-compatible manner, and +- PATCH version when you make backwards-compatible bug fixes. + +Additional labels for pre-release and build metadata are available as extensions to the MAJOR.MINOR.PATCH format. + +**FAQ** +How should I deal with revisions in the 0.y.z initial development phase? + +> The simplest thing to do is start your initial development release at 0.1.0 and then increment the minor version for each subsequent release. + +How do I know when to release 1.0.0? + +> If your software is being used in production, it should probably already be 1.0.0. If you have a stable API on which users have come to depend, you should be 1.0.0. If you’re worrying a lot about backwards compatibility, you should probably already be 1.0.0. + +## License + +MIT © typescript-package ([license][typescript-package-license]) + +## Related packages + +- **[@typescript-package/chain-descriptor](https://github.com/typescript-package/chain-descriptor)**: A **TypeScript** library for chain property descriptor. +- **[@typescript-package/controller](https://github.com/typescript-package/controller)**: A **TypeScript** package with for various kind of controllers. +- **[@typescript-package/descriptor](https://github.com/typescript-package/descriptor)**: A **TypeScript** library for property descriptor. +- **[@typescript-package/descriptor-chain](https://github.com/typescript-package/descriptor-chain)**: A **TypeScript** library for property descriptor chain. +- **[@typescript-package/descriptors](https://github.com/typescript-package/descriptors)**: A **TypeScript** library for property descriptors. +- **[@typescript-package/property](https://github.com/typescript-package/property)**: A **TypeScript** package with features to handle object properties. +- **[@typescript-package/wrap-descriptor](https://github.com/typescript-package/wrap-descriptor)**: A **TypeScript** package for wrapping object descriptors. +- **[@typescript-package/wrap-property](https://github.com/typescript-package/wrap-property)**: A **TypeScript** package for wrapping object properties. +- **[@typescript-package/wrapped-descriptor](https://github.com/typescript-package/wrapped-descriptor)**: A **TypeScript** library for wrapped property descriptor. +- **[@xtypescript/property](https://github.com/xtypescript/property)** - A comprehensive, reactive **TypeScript** library for precise and extensible object property control. + + + + [typescript-package-badge-issues]: https://img.shields.io/github/issues/typescript-package/middleware + [isscript-package-badge-forks]: https://img.shields.io/github/forks/typescript-package/middleware + [typescript-package-badge-stars]: https://img.shields.io/github/stars/typescript-package/middleware + [typescript-package-badge-license]: https://img.shields.io/github/license/typescript-package/middleware + + [typescript-package-issues]: https://github.com/typescript-package/middleware/issues + [typescript-package-forks]: https://github.com/typescript-package/middleware/network + [typescript-package-license]: https://github.com/typescript-package/middleware/blob/master/LICENSE + [typescript-package-stars]: https://github.com/typescript-package/middleware/stargazers + + + + + [typescript-package-npm-badge-svg]: https://badge.fury.io/js/@typescript-package%2Fmiddleware.svg + [typescript-package-npm-badge]: https://badge.fury.io/js/@typescript-package%2Fmiddleware + + +[git-semver]: http://semver.org/ + + +[git-commit-angular]: https://gist.github.com/stephenparish/9941e89d80e2bc58a153 +[git-commit-karma]: http://karma-runner.github.io/0.10/dev/git-commit-msg.html +[git-commit-conventional]: https://www.conventionalcommits.org/en/v1.0.0/ diff --git a/ng-package.json b/ng-package.json new file mode 100644 index 0000000..6960ecb --- /dev/null +++ b/ng-package.json @@ -0,0 +1,8 @@ +{ + "$schema": "../../node_modules/ng-packagr/ng-package.schema.json", + "dest": "../../dist/middleware", + "lib": { + "entryFile": "src/public-api.ts" + }, + "keepLifecycleScripts": true +} \ No newline at end of file diff --git a/package.json b/package.json new file mode 100644 index 0000000..65b5092 --- /dev/null +++ b/package.json @@ -0,0 +1,36 @@ +{ + "name": "@typescript-package/middleware", + "version": "0.0.1", + "author": "wwwdev.io ", + "description": "A lightweight TypeScript library for middleware.", + "license": "MIT", + "publishConfig": { + "access": "public", + "registry": "https://registry.npmjs.org" + }, + "devDependencies": {}, + "peerDependencies": {}, + "scripts": { + "prepublishOnly": "npm run pkg && npm run clean", + "pkg": "npm pkg delete dependencies", + "clean": "npm pkg delete scripts" + }, + "repository": { + "type": "git", + "url": "git+https://github.com/typescript-package/middleware.git" + }, + "bugs": { + "url": "https://github.com/typescript-package/middleware/issues" + }, + "keywords": [ + "@typescript-package", + "@typescript-package/middleware" + ], + "funding": [ + { + "type": "individual", + "url": "https://checkout.revolut.com/pay/048b10a3-0e10-42c8-a917-e3e9cb4c8e29" + } + ], + "sideEffects": false +} diff --git a/src/lib/index.ts b/src/lib/index.ts new file mode 100644 index 0000000..419dfe4 --- /dev/null +++ b/src/lib/index.ts @@ -0,0 +1 @@ +export { Middleware } from './middleware.class'; \ No newline at end of file diff --git a/src/lib/middleware.class.ts b/src/lib/middleware.class.ts new file mode 100644 index 0000000..a3dc066 --- /dev/null +++ b/src/lib/middleware.class.ts @@ -0,0 +1,102 @@ +// Type. +import { MiddlewareFunction } from '../type'; +/** + * @description + * @export + * @class Middleware + * @template [T=any] + */ +export class Middleware { + /** + * @description + * @type {number} + */ + #index = 0; + + /** + * @description + * @type {MiddlewareFunction[]} + */ + #middleware: MiddlewareFunction[]; + + /** + * @description + * @type {() => void} + */ + #onComplete: (args: T[]) => void = () => {}; + + /** + * Creates an instance of `ListenersMiddleware`. + * @constructor + * @param {...MiddlewareFunction[]} middleware + */ + constructor(...middleware: MiddlewareFunction[]) { + this.#middleware = middleware; + } + + /** + * @description + * @public + * @param {...T[]} args + */ + public execute(...args: T[]) { + this.#index = 0; + this.#next(...args); + } + + /** + * @description + * @public + * @async + * @param {...T[]} args + * @returns {unknown} + */ + public async executeAsync(...args: T[]) { + this.#index = 0; + return new Promise(async resolve => ( + await this.#nextAsync(...args), + this.onComplete(() => resolve(args)) + )); + } + + /** + * @description + * @public + * @param {(args: T[]) => void} onComplete + */ + public onComplete(onComplete: (args: T[]) => void): void { + this.#onComplete = onComplete; + } + + /** + * @description + * @public + * @param {MiddlewareFunction} middleware + * @returns {this} + */ + public use(middleware: MiddlewareFunction): this { + return this.#middleware.push(middleware), this; + } + + /** + * @description + * @param {...T[]} args + */ + #next(...args: T[]) { + this.#index < this.#middleware.length + ? this.#middleware[this.#index++](args, () => this.#next(...args)) + : this.#onComplete(args); + } + + /** + * @description + * @async + * @param {...T[]} args + * @returns {*} + */ + async #nextAsync(...args: T[]) { + this.#index < this.#middleware.length + ? await this.#middleware[this.#index++](args, () => this.#nextAsync(...args)) + : this.#onComplete(args); + } +} \ No newline at end of file diff --git a/src/public-api.ts b/src/public-api.ts new file mode 100644 index 0000000..13006d9 --- /dev/null +++ b/src/public-api.ts @@ -0,0 +1,7 @@ +/* + * Public API Surface of middleware + */ + +export { + Middleware +} from './lib'; diff --git a/src/test/middleware.spec.ts b/src/test/middleware.spec.ts new file mode 100644 index 0000000..52ddfd6 --- /dev/null +++ b/src/test/middleware.spec.ts @@ -0,0 +1,47 @@ +import { Middleware } from "../lib"; + +const middleware = new Middleware(); + +middleware.use((args, next) => { + console.log('Middleware 1 executed with args:', args); + args[0].newKey = 'newValue'; + next(); +}); + + +middleware.use((args, next) => { + console.log('Middleware 2 executed with args:', args); + next(); +}); + +middleware.execute({ key: 'value' }); + +// Async +middleware.use(async (args, next) => { + console.log('Async middleware 1 start with args:', args); + args[0].newKey = 'newValue'; + await new Promise(resolve => setTimeout(resolve, 2000)); + console.log('Async middleware end'); + next(); +}); + +middleware.use(async (args, next) => { + console.log('Async middleware 2 start with args:', args); + next(); +}); + +middleware.onComplete((args) => { + console.log('All middlewares completed with args:', args); +}); + +middleware.executeAsync({ key: 'value' }); + +describe('Middleware', () => { + it('should be defined', () => { + expect(Middleware).toBeDefined(); + }); + + it('should create an instance', () => { + expect(middleware).toBeInstanceOf(Middleware); + }); +}); diff --git a/src/type/index.ts b/src/type/index.ts new file mode 100644 index 0000000..8f5e296 --- /dev/null +++ b/src/type/index.ts @@ -0,0 +1 @@ +export type { MiddlewareFunction } from './middleware-function.type'; \ No newline at end of file diff --git a/src/type/middleware-function.type.ts b/src/type/middleware-function.type.ts new file mode 100644 index 0000000..e05ba8b --- /dev/null +++ b/src/type/middleware-function.type.ts @@ -0,0 +1,5 @@ +/** + * @description + * @export + */ +export type MiddlewareFunction = (args: any[], next: () => void) => void; diff --git a/tsconfig.lib.json b/tsconfig.lib.json new file mode 100644 index 0000000..edb0551 --- /dev/null +++ b/tsconfig.lib.json @@ -0,0 +1,18 @@ +/* To learn more about Typescript configuration file: https://www.typescriptlang.org/docs/handbook/tsconfig-json.html. */ +/* To learn more about Angular compiler options: https://angular.dev/reference/configs/angular-compiler-options. */ +{ + "extends": "../../tsconfig.json", + "compilerOptions": { + "outDir": "../../out-tsc/lib", + "declaration": true, + "declarationMap": true, + "inlineSources": true, + "types": [] + }, + "include": [ + "src/**/*.ts" + ], + "exclude": [ + "**/*.spec.ts" + ] +} diff --git a/tsconfig.lib.prod.json b/tsconfig.lib.prod.json new file mode 100644 index 0000000..9215caa --- /dev/null +++ b/tsconfig.lib.prod.json @@ -0,0 +1,11 @@ +/* To learn more about Typescript configuration file: https://www.typescriptlang.org/docs/handbook/tsconfig-json.html. */ +/* To learn more about Angular compiler options: https://angular.dev/reference/configs/angular-compiler-options. */ +{ + "extends": "./tsconfig.lib.json", + "compilerOptions": { + "declarationMap": false + }, + "angularCompilerOptions": { + "compilationMode": "partial" + } +} diff --git a/tsconfig.spec.json b/tsconfig.spec.json new file mode 100644 index 0000000..769f8bf --- /dev/null +++ b/tsconfig.spec.json @@ -0,0 +1,16 @@ +/* To learn more about Typescript configuration file: https://www.typescriptlang.org/docs/handbook/tsconfig-json.html. */ +/* To learn more about Angular compiler options: https://angular.dev/reference/configs/angular-compiler-options. */ +{ + "extends": "../../tsconfig.json", + "compilerOptions": { + "outDir": "../../out-tsc/spec", + "types": [ + "vitest/globals" + ] + }, + "include": [ + "src/**/*.ts", + "src/**/*.d.ts", + "src/**/*.spec.ts" + ] +}