# @rainbow-o23/n2 > o23 application base Latest version **1.0.67** (published 2026-05-28) · MIT license · 0 weekly downloads ## Install ```sh npm install @rainbow-o23/n2 pnpm add @rainbow-o23/n2 yarn add @rainbow-o23/n2 bun add @rainbow-o23/n2 ``` ## Health **Score 65/100 (B)** — status: active. Positive: has types; esm support; no vulnerabilities; high maintenance score; high quality score. Warnings: low downloads. ## Facts | | | |---|---| | Version | 1.0.67 | | Published | 2026-05-28 | | First published | 2024-01-08 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | bundled | | Module format | ESM + CommonJS | | Dependencies | 13 | | Unpacked size | 256.4 KB | | Known vulnerabilities | 0 (+1 in 1 direct dependencies) | | Install scripts | no | | GitHub stars | 5 | | Author | Rainbow Team | | Maintainers | build_admin | ## Links - npm: https://www.npmjs.com/package/@rainbow-o23/n2 - Repository: https://github.com/InsureMO/rainbow-o23 - Homepage: https://github.com/InsureMO/rainbow-o23#readme - Issues: https://github.com/InsureMO/rainbow-o23/issues - npm.io page: https://npm.io/package/@rainbow-o23/n2 ## Dependencies (13) - [cron](https://npm.io/package/cron.md) ^3.1.9 - [rxjs](https://npm.io/package/rxjs.md) ^7.8.1 - [dayjs](https://npm.io/package/dayjs.md) ^1.11.13 - [winston](https://npm.io/package/winston.md) ^3.16.0 - [@nestjs/core](https://npm.io/package/@nestjs/core.md) ^10.4.7 - [nest-winston](https://npm.io/package/nest-winston.md) ^1.9.7 - [@nestjs/common](https://npm.io/package/@nestjs/common.md) ^10.4.16 - [@rainbow-o23/n1](https://npm.io/package/@rainbow-o23/n1.md) 1.0.67 - [reflect-metadata](https://npm.io/package/reflect-metadata.md) ^0.2.2 - [@nestjs/websockets](https://npm.io/package/@nestjs/websockets.md) ^10.4.7 - [@nestjs/platform-express](https://npm.io/package/@nestjs/platform-express.md) ^10.4.7 - [winston-daily-rotate-file](https://npm.io/package/winston-daily-rotate-file.md) ^5.0.0 - [@nestjs/platform-socket.io](https://npm.io/package/@nestjs/platform-socket.io.md) ^10.4.7 ## Recent versions - 1.0.67 (latest) — 2026-05-28 - 1.0.58-alpha.3 (alpha) — 2025-04-21 - 1.0.66 — 2026-05-28 - 1.0.65 — 2026-05-15 - 1.0.64 — 2026-05-11 - 1.0.63 — 2026-05-11 - 1.0.62 — 2026-05-10 - 1.0.61 — 2026-04-14 - 1.0.60 — 2025-12-09 - 1.0.59 — 2025-04-22 - 1.0.58 — 2025-04-21 - 1.0.58-alpha.2 — 2025-04-21 - 1.0.57 — 2025-04-02 - 1.0.56 — 2024-12-17 - 1.0.55 — 2024-12-13 - … 59 more at https://npm.io/package/@rainbow-o23/n2/versions ## README ![Static Badge](https://img.shields.io/badge/InsureMO-777AF2.svg) ![Nest](https://img.shields.io/badge/nest-white.svg?logo=nestjs&logoColor=E0234E&style=social) ![Module Formats](https://img.shields.io/badge/module%20formats-cjs-green.svg) # o23/n2 In simple terms, `o23/n2` is a tool that publishes a given pipeline as a web application using [NestJS](https://nestjs.com/). In this module, we handle the following tasks: - Registering all pipelines and exposing the specified ones as REST APIs, - Redirecting logs to standard web log output, - Providing standard error handling, where all errors will be caught and processed uniformly, - Providing a health check API and a version API, - Providing a standard pipeline invocation API. Please note that this API is fully compatible with all data processing pipelines but not with file processing pipelines. ## Request Support request parsing as following: - API path, - Method, - Request headers, - Path parameters, - Query string parameters, - Files, - Json body. The thing to note is that when multiple types of request data are enabled, `o23/n2` will degrade and merge them into a single JSON object, and each part has its own naming conventions as follows: - Request headers: `headers`, or given names, - Path parameters: `pathParams`, or given names, - Query string parameters: `queryParams`, or given names, - Files: `file` for single file, `files` for multiple files, or given names, - Json body: `body`. ## Response Support response outputs as following: - Response headers, - Static exposed response headers, which pre-defined in pipeline, - Authorization related response headers, which returned by authentication pipeline, - Scoped trace ids, which pre-defined in configuration and created/gathered by pipeline steps, - File download, - Json body. ## APIs ### Health Check ```yaml - URL: / - Method: Get - Response: { up: true, message: 'Hello there, I am OK now.' } ``` ### App Version ```yaml - URL: /version - Method: Get - Response: { version: 'UNDOCUMENTED', builtAt: 'UNDOCUMENTED' } ``` ### Pipeline Trigger ```yaml - URL: /pipeline - Method: Post - Request: { code: 'string'; payload: 'any' } - Response: 'any' ``` > The specific data format for the request payload and response depends on the pipeline that needs to be executed. > Referring to the example in `o23/scaffold` on how to build an application based on `o23/n2`, won't go into detail here. ## Environment Parameters | Name | Type | Default Value | Comments | |-------------------------------------------------------|---------|------------------------------------|------------------------------------------------------------------------------------------------------| | `app.port` | number | 3100 | Application server port. | | `app.context` | string | /o23 | Application api context. | | `app.name` | string | O23-N99 | Application name. | | `app.provider` | string | Rainbow Team | Application provider. | | `app.version` | string | UNDOCUMENTED | Application build version. | | `app.built.at` | string | UNDOCUMENTED | Application build time. | | `app.auth.enabled` | boolean | false | Enable authentication. | | `app.auth.pipeline` | string | Authenticate | Pipeline code for authentication and authorization. | | `app.auth.authorization.expose` | boolean | false | Expose authorization token into response header or not. | | `app.auth.authorization.expose.name` | string | O23-Authorization | Expose authorization token header name. | | `app.auth.authentication.expose` | boolean | true | Expose authentication into response header or not. | | `app.auth.authentication.expose.name` | string | O23-Authentication | Expose authentication header name. | | `app.auth.roles.expose` | boolean | false | Expose authorized roles into response header or not. | | `app.auth.roles.expose.name` | string | O23-Authorized-Roles | Expose authorized roles header name. | | `app.body.json.max.size` | string | 50mb | Request maximum body size, for json body. | | `app.body.urlencoded.max.size` | string | 50mb | Request maximum body size, for urlencoded body. | | `app.cors.enabled` | boolean | false | Enable cors. | | `app.cors.options` | json | | `CorsOptions` of `@nestjs/common`. | | `logger.mdc.enabled` | boolean | false | Enable MDC. Register the MDCBuilder first if enabled. | | `logger.mdc.proxy.enabled` | boolean | true | Use MDC proxy. Turn disabled to enable ALS(AsyncLocalStorage) MDC. | | `logger.route.aspect.enabled` | boolean | false | Enable aspect logger for dynamic routes. Register the RequestLogger/ResponseLogger first if enabled. | | `logger.file.enabled` | boolean | false | Enable file log. | | `logger.file.rotate.enabled` | boolean | true | Enable rotate file log. | | `logger.error.file` | string | logs/error-%DATE%.log | Error log file. | | `logger.error.level` | string | error | Logger level for error log file. | | `logger.error.json` | boolean | true | Use json format. | | `logger.error.date.pattern` | string | YYYY-MM-DD | Error log file date pattern. | | `logger.error.zipped.archive` | boolean | false | Enabled zip for error log file. | | `logger.error.max.files` | string | 30d | Error log file keeping time. | | `logger.error.max.size` | string | 10m | Error log file maximum size. | | `logger.combined.file` | string | logs/combined-%DATE%.log | Standard log file. | | `logger.combined.level` | string | log | Logger level for standard log file. | | `logger.combined.json` | boolean | true | Use json format. | | `logger.combined.date.pattern` | string | YYYY-MM-DD | Standard log file date pattern. | | `logger.combined.zipped.archive` | boolean | false | Enabled zip for standard log file. | | `logger.combined.max.files` | string | 7d | Standard log file keeping time. | | `logger.combined.max.size` | string | 10m | Standard log file maximum size. | | `logger.console.enabled` | boolean | false | Enable console log. | | `logger.console.json` | boolean | false | Use json format. | | `logger.console.level` | string | debug | Logger level for console log. | | `app.schedule.enabled` | boolean | false | Enable schedule. | | `app.schedule.on.cluster` | boolean | false | Enable schedule on cluster, usually on production. | | `app.schedule.max.interval.no.cluster.lock` | number | 3600 | Maximum interval for schedule without cluster lock. | | `app.schedule.obtain.cluster.execution.lock.pipeline` | string | ScheduleObtainClusterExecutionLock | Pipeline code for obtaining cluster execution lock. | | `app.schedule.job.log.persist` | boolean | false | Enable scheduled job log persist. | | `app.schedule.job.create.pipeline` | string | ScheduleCreateJob | Pipeline code for creating scheduled job log. | | `app.schedule.job.result.write.pipeline` | string | ScheduleWriteJobResult | Pipeline code for writing scheduled job result. | --- _Source: https://npm.io/package/@rainbow-o23/n2 · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._