tsoa-next 7.1.0

package/README.MD

@@ -0,0 +1,57 @@
+<div align="center">
+  <a href="https://tsoa-community.github.io/docs/" target="blank">
+    <h1>tsoa-next</h1>
+  </a>
+Pronounced so·uh
+
+OpenAPI-compliant REST APIs using TypeScript and Node
+
+![build status](https://github.com/vannadii/tsoa-next/actions/workflows/runTestsOnPush.yml/badge.svg)
+[![npm version](https://img.shields.io/npm/v/tsoa-next/latest)](https://www.npmjs.com/package/tsoa-next)
+
+</div>
+
+## Goal
+
+- TypeScript controllers and models as the single source of truth for your API
+- A valid OpenAPI (formerly Swagger) spec (2.0 or 3.0 if you choose 😍) is generated from your controllers and models, including:
+  - Paths (e.g. GET /users)
+  - Definitions based on TypeScript interfaces (models)
+  - Parameters/model properties marked as required or optional based on TypeScript (e.g. myProperty?: string is optional in the OpenAPI spec)
+  - jsDoc supported for object descriptions (most other metadata can be inferred from TypeScript types)
+- Routes are generated for middleware of choice
+  - Express, Hapi, and Koa currently supported, other middleware can be supported using a simple handlebars template
+  - Validate request payloads
+
+## Philosophy
+
+- Rely on TypeScript type annotations to generate API metadata if possible
+- If regular type annotations aren't an appropriate way to express metadata, use decorators
+- Use jsdoc for pure text metadata (e.g. endpoint descriptions)
+- Minimize boilerplate
+- Models are best represented by interfaces (pure data structures), but can also be represented by classes
+- Runtime validation of tsoa-next should behave as closely as possible to the specifications that the generated OpenAPI 2/3 schema describes. Any differences in validation logic are clarified by logging warnings during the generation of the OpenAPI Specification (OAS) and/or the routes.
+  - Please note that by enabling OpenAPI 3 you minimize the chances of divergent validation logic since OpenAPI 3 has a more expressive schema syntax.
+
+## Getting Started
+
+- Requirements:
+  - Node.js 24.14 or newer
+  - npm 11 or newer
+- [Documentation](https://tsoa-community.github.io/docs/)
+- [API Reference](https://tsoa-community.github.io/reference/)
+- [Getting started guide](https://tsoa-community.github.io/docs/getting-started)
+
+## Examples
+
+Check out the [guides](https://tsoa-community.github.io/docs/getting-started)
+
+See example controllers in [the tests](tests/fixtures/controllers)
+
+See example models in [the tests](tests/fixtures/testModel.ts)
+
+## Help wanted
+
+### Contributing code
+
+To contribute (via a PR), please first see the [Contributing Guide](https://github.com/vannadii/tsoa-next/tree/master/docs/CONTRIBUTING.md)

package/dist/cli.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};

package/dist/cli.js

@@ -0,0 +1,7 @@
+#!/usr/bin/env node
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const cli_1 = require("@tsoa-next/cli");
+if (require.main === module)
+    void (0, cli_1.runCLI)();
+//# sourceMappingURL=cli.js.map

package/dist/cli.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli.js","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":";;;AACA,wCAAuC;AAEvC,IAAI,OAAO,CAAC,IAAI,KAAK,MAAM;IAAE,KAAK,IAAA,YAAM,GAAE,CAAA"}

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export * from '@tsoa-next/runtime';
+export * from '@tsoa-next/cli';

package/dist/index.js

@@ -0,0 +1,19 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("@tsoa-next/runtime"), exports);
+__exportStar(require("@tsoa-next/cli"), exports);
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,qDAAkC;AAClC,iDAA8B"}

package/package.json

@@ -0,0 +1,53 @@
+{
+  "name": "tsoa-next",
+  "version": "7.1.0",
+  "description": "Build swagger-compliant REST APIs using TypeScript and Node",
+  "main": "./dist/index.js",
+  "typings": "./dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "bin": {
+    "tsoa": "dist/cli.js"
+  },
+  "scripts": {
+    "build": "npm run tsc",
+    "tsc": "tsc -b",
+    "watch": "tsc -b -w"
+  },
+  "keywords": [
+    "codegen",
+    "express",
+    "generation",
+    "hapi.js",
+    "koa",
+    "node",
+    "node.js",
+    "openapi",
+    "server",
+    "swagger",
+    "typescript"
+  ],
+  "author": "Luke Autry <lukeautry@gmail.com> (http://www.lukeautry.com)",
+  "license": "MIT",
+  "dependencies": {
+    "@tsoa-next/cli": "7.1.0",
+    "@tsoa-next/runtime": "7.1.0"
+  },
+  "devDependencies": {
+    "@types/node": "24.12.0",
+    "typescript": "^5.9.3"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/VannaDii/tsoa-next.git"
+  },
+  "engines": {
+    "node": ">=24.14.0",
+    "npm": ">=11.0.0"
+  },
+  "engineStrict": true,
+  "publishConfig": {
+    "access": "public"
+  }
+}