From 43f76a2289a972e91d19eae7d08aff97ea8a239f Mon Sep 17 00:00:00 2001 From: Steve Konves Date: Mon, 8 Sep 2025 19:00:18 -0700 Subject: [PATCH] Mark repository as deprecated and redirect users This repository has been moved to the basketry/typescript monorepo. No further updates will be made here. --- README.md | 180 ++---------------------------------------------------- 1 file changed, 5 insertions(+), 175 deletions(-) diff --git a/README.md b/README.md index e4174b5..190a57c 100644 --- a/README.md +++ b/README.md @@ -1,177 +1,7 @@ -[![main](https://github.com/basketry/express/workflows/build/badge.svg?branch=main&event=push)](https://github.com/basketry/express/actions?query=workflow%3Abuild+branch%3Amain+event%3Apush) -[![master](https://img.shields.io/npm/v/@basketry/express)](https://www.npmjs.com/package/@basketry/express) +# ⚠️ Deprecated Repository -# Typescript +This repository has been **moved** into the [basketry/typescript](https://github.com/basketry/typescript) monorepo. +No further updates will be made here. -[Basketry generator](https://github.com/basketry/basketry) for generating [ExpressJS routers](https://expressjs.com/en/guide/routing.html). This parser can be coupled with any Basketry parser. - -## Quick Start - -The following example generates ExpressJS routers from a "Swagger" doc: - -1. Save `https://petstore.swagger.io/v2/swagger.json` as `petstore.json` in the root of your project. -1. Install packages: `npm install -g basketry @basketry/swagger-2 @basketry/express @basketry/typescript @basketry/typescript-validators` -1. Generate code: `basketry --source petstore.json --parser @basketry/swagger-2 --generators @basketry/express @basketry/typescript @basketry/typescript-validators --output src` - -When the last step is run, basketry will parse the source file (`petstore.json`) using the specified parser (`@basketry/swagger-2`) and then run each specified generator (`@basketry/express`, `@basketry/typescript`, and `@basketry/typescript-validators`) writing the output folder (`src`). - -The routers can then be added to an Express server: - -```ts -import * as express from 'express'; - -import { - ApiKeyStrategy, - authentication, - OAuth2Strategy, - petRoutes, - storeRoutes, - userRoutes, -} from './v1/express-routers'; // Generated by @basketry/express -import { PetService, StoreService, UserService } from './v1/types'; // Generated by @basketry/typescript -import { DbPetService, DbStoreService, DbUserService } from './services'; // Your hand-written implementations of the generated service interfaces - -const app = express(); - -const apiKeyStrategy: ApiKeyStrategy = (key) => { - return Promise.resolve({ - isAuthenticated: key === 'abcdef', // TODO: verify API key - scopes: new Set(), - }); -}; - -const oauth2Strategy: OAuth2Strategy = (accessToken) => { - return Promise.resolve({ - isAuthenticated: accessToken === 'abcdef', // TODO: verify access token - scopes: new Set(), // TODO: parse scopes from token - }); -}; - -app.use('/v1', [ - authentication({ - api_key: apiKeyStrategy, - petstore_auth: oauth2Strategy, - }), - petRoutes(new DbPetService()), - storeRoutes(new DbStoreService()), - userRoutes(new DbUserService()), -]); - -// TODO: add global error handlers, etc - -app.listen(8000, () => { - console.log('listening on', 8000); -}); -``` - -Consider adding the following [Basketry config](https://github.com/basketry/basketry#config-file): - -```json -{ - "parser": "@basketry/swagger-2", - "generators": [ - "@basketry/typescript", - "@basketry/typescript-auth", - "@basketry/typescript-validators", - "@basketry/express" - ], - "source": "petstore.oas2.json", - "output": "src" -} -``` - -## Service Scopes - -The services passed to each route builder can have one of two different scopes. - -### Singleton Scoped - -When an instance of a service class is directly passed to a route builder, that same instance will be used for all requests. This means that any instance values within the class will be available across all calls to the service until the Express server is restarted. - -```ts -app.use('/v1', [ - petRoutes(new DbPetService()), - storeRoutes(new DbStoreService()), - userRoutes(new DbUserService()), -]); -``` - -### Request Scoped - -When a function that returns an instance of a service class is passed to a router builder, the function will be run _once_ for each request. This allows a new instance of a function to be created for each request. After the request is returns, the instance of the class will fall out of scope and may then be garbage collected by the Node process. - -```ts -app.use('/v1', [ - petRoutes(() => new DbPetService()), - storeRoutes(() => new DbStoreService()), - userRoutes(() => new DbUserService()), -]); -``` - -If needed, the Express Request object is passed as a parameter to the service initializer function. This allows for services to be constructed based on data from the request. - -```ts -app.use('/v1', [ - petRoutes(() => new DbPetService()), - storeRoutes(() => new DbStoreService()), - userRoutes((req) => new DbUserService(req.user)), -]); -``` - -## Authentication and Authorization - -Each route hander performs an authorization check prior to calling the service. If the current caller is not authenicated or is not authorized, the service method will not be called and the appropriate HTTP reponse will be returned instead. - -The auth context used to perform these checks (in the form of an `AuthService` instance) may be accessed from the request object: - -```ts -app.use('/v1', [ - // This middleware creates the auth context - authentication({ - // The following are defined using OpenAPI's security and securityDefinition specs - api_key: apiKeyStrategy, - petstore_auth: oauth2Strategy, - }), - petRoutes(new DbPetService()), - storeRoutes(new DbStoreService()), - userRoutes((req) => { - // Auth context may be accessed via the req object - const authService = req.basketry?.context; - return new DbUserService(authService); - }), -]); -``` - ---- - -## For contributors: - -### Run this project - -1. Install packages: `npm ci` -1. Build the code: `npm run build` -1. Run it! `npm start` - -Note that the `lint` script is run prior to `build`. Auto-fixable linting or formatting errors may be fixed by running `npm run fix`. - -### Create and run tests - -1. Add tests by creating files with the `.test.ts` suffix -1. Run the tests: `npm t` -1. Test coverage can be viewed at `/coverage/lcov-report/index.html` - -### Publish a new package version - -1. Ensure latest code is published on the `main` branch. -1. Create the new version number with `npm version {major|minor|patch}` -1. Push the branch and the version tag: `git push origin main --follow-tags` - -The [publish workflow](https://github.com/basketry/typescript/actions/workflows/publish.yml) will build and pack the new version then push the package to NPM. Note that publishing requires write access to the `main` branch. - ---- - -Generated with [generator-ts-console](https://www.npmjs.com/package/generator-ts-console) - -``` - -``` +Please use the new location going forward: +➡️ [packages/typescript](https://github.com/basketry/typescript/tree/main/packages/express)