Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mika-f/nextpida
nextpida is a package that TypeScript friendly apis path generator for Next.js
https://github.com/mika-f/nextpida
nextjs typescript
Last synced: 4 days ago
JSON representation
nextpida is a package that TypeScript friendly apis path generator for Next.js
- Host: GitHub
- URL: https://github.com/mika-f/nextpida
- Owner: mika-f
- License: mit
- Created: 2023-01-20T09:19:48.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-01-23T13:03:28.000Z (almost 2 years ago)
- Last Synced: 2024-05-02T02:21:27.955Z (7 months ago)
- Topics: nextjs, typescript
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/@natsuneko-laboratory/nextpida
- Size: 105 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# @natsuneko-laboratory/nextpida
nextpida is a package that TypeScript friendly apis path generator for Next.js
## Install
```bash
# required
$ yarn add @natsuneko-laboratory/nextpida --dev
# optional for using default type definitions
$ yarn add @natsuneko-laboratory/nextpida-handler-types --dev
# optional for using default `withMethods` handler
$ yarn add @natsuneko-laboratory/nextpida-method-handler
```
## Generate Type Definitions
```bash
# build
$ yarn run nextpida
# build with watch mode
$ yarn run nextpida --watch
$ yarn run nextpida --input ./src/
```
## Type Detection
Nextpida generates routes and type definitions for a default exported handler with a type definition of the following form:
```typescript
import type { NextApiRequest, NextApiResponse } from "next";
// default handler
type NextApiHandler = (req: NextApiRequest, res: NextApiResponse) => unknown;
// handler with request body
type NextApiRequestWithBody = Omit & { body: T };
type NextApiHandler = (req: NextApiRequestWithBody, res: NextApiResponse) => unknown;
// handler with request query params
type NextApiRequestWithQuery = Omit & { query: T };
type NextApiHandler = (req: NextApiRequestWithQuery, res: NextApiResponse) => unknown;
// handler with request body and query params
type NextApiRequestWithBodyAndQuery = Omit & { body: TRequestBody, query: TQueryParameter };
type NextApiHandler = (req: NextApiRequestWithBodyAndQuery, res: NextApiResponse) => unknown;
type HttpMethods = "GET" | "HEAD" | "POST" | "PUT" | "DELETE" | "CONNECT" | "OPTIONS" | "TRACE" | "PATCH";
type HttpHandlers = { [TMethod in HttpMethods]?: NextApiHandler };
type NextpidaSatisfiedFunctionSignature = (handlers: THandlers) => unknown | Promise;
const handler: NextpidaSatisfiedFunctionSignature = /* ... */;
export default handler;
```
You must:
- Response type must be specified in `T` of `NextApiResponse`
- Request body type must be replaced in `body: any` of `NextApiRequest`
- If it is not replaced and remains `any`, no type definitions is generated for the request body
- Request **additional** query params type must be replaced in `query: Partial<{ [key: string]: string | string[]; }>` of `NextApiRequest`
- If it is not replaced and remains `Partial<{ [key: string]: string | string[]; }>`, no **additional** type definitions is generated for the request query params
You can use official provided type definitions via `@natsuneko-laboratory/nextpida-handler-types`.
## Import Types
By default, nextpida write type definition file into `lib/$apis.ts`
```typescript
import type { GetRequest, PostRequest } from "lib/$apis";
// GET /api/v1/users request and response typings
// full typing
type RequestBodyAndQueryParams = GetRequest["api/v1/users"];
// request body only
type RequestBody = GetRequest["api/v1/users"].body;
// request query params only
type RequestQueryParams = GetRequest["api/v1/users"].query;
// response body
type Response = GetResponse["api/v1/users"];
// POST /api/v1/users request and response typings
type Response = PostResponse["api/v1/users"];
```
## Known Issues
- if optional parameter is used, `undefined` is not given
## License
MIT by [@6jz](https://twitter.com/6jz)