# next-rocket-kit > > **Note πŸ§ͺ:** I will start the migration for next.js versions 15 and higher. Latest version **1.2.5** (published 2025-08-28) Β· MIT license Β· 0 weekly downloads ## Install ```sh npm install next-rocket-kit pnpm add next-rocket-kit yarn add next-rocket-kit bun add next-rocket-kit ``` ## Health **Score 40/100 (D)** β€” status: maintenance-mode. Positive: has types; esm support; no vulnerabilities; high quality score. Warnings: low downloads. Negative: stale; low maintenance score. ## Facts | | | |---|---| | Version | 1.2.5 | | Published | 2025-08-28 | | First published | 2023-08-28 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | bundled | | Module format | ESM + CommonJS | | Node | >=10 | | Dependencies | 2 | | Unpacked size | 39.1 KB | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 0 | | Author | Dimas MΓ©rida - gh: leomerida15 | | Maintainers | dimasmerida15 | | Keywords | next, zod, yup, http-status-codes, api, rest, nextjs, openapi3-ts | ## Links - npm: https://www.npmjs.com/package/next-rocket-kit - Repository: https://github.com/leomerida15/next-rocket-kit - Homepage: https://leomerida15.github.io/next-rocket-kit/ - Issues: https://github.com/leomerida15/next-rocket-kit/issues - npm.io page: https://npm.io/package/next-rocket-kit ## Dependencies (2) - [openapi3-ts](https://npm.io/package/openapi3-ts.md) ^4.1.2 - [http-status-codes](https://npm.io/package/http-status-codes.md) ^2.2.0 ## Alternatives - [launchdarkly-js-client-sdk](https://npm.io/package/launchdarkly-js-client-sdk.md) β€” 2.5M weekly downloads - [@elastic/elasticsearch](https://npm.io/package/@elastic/elasticsearch.md) β€” 2.1M weekly downloads - [@c8y/client](https://npm.io/package/@c8y/client.md) β€” 15.3K weekly downloads - [@signaldb/maverickjs](https://npm.io/package/@signaldb/maverickjs.md) β€” 1.7K weekly downloads - [@bbc/http-transport-cache](https://npm.io/package/@bbc/http-transport-cache.md) β€” 1.2K weekly downloads ## Recent versions - 1.2.5 (latest) β€” 2025-08-28 - 1.2.4 β€” 2025-08-28 - 1.2.0 β€” 2025-08-28 - 1.1.8 β€” 2024-10-28 - 1.1.7 β€” 2024-02-05 - 1.1.6 β€” 2024-02-04 - 1.1.5 β€” 2024-02-04 - 1.1.1 β€” 2024-02-04 - 1.0.0 β€” 2023-11-20 - 0.8.2 β€” 2023-10-29 - 0.8.1 β€” 2023-10-18 - 0.8.0 β€” 2023-10-18 - 0.7.12 β€” 2023-10-18 - 0.7.11 β€” 2023-10-18 - 0.7.10 β€” 2023-10-18 - … 53 more at https://npm.io/package/next-rocket-kit/versions ## README # next-rocket-kit πŸš€ > **Note πŸ§ͺ:** I will start the migration for next.js versions 15 and higher.
Migrate to @rocket-kit/next
New package available
> **🚨 URGENT:** This package is being migrated to [@rocket-kit/next](https://www.npmjs.com/package/@rocket-kit/next). **Migrate now** for better performance and continued support! I finally have version 2. It has the following important items: 1. It was migrated to the (@rocket-kit/next)[https://www.npmjs.com/package/@rocket-kit/next] package. 2. The API is not identical; some names were changed, such as getContext().params -> getPatams or getQuery -> getQueryParams. 3. The new version was split into two packages: resolver and rocket. 4. The Persian Zod resolver is less than 13 KB, and rocket is less than 25 KB. This is important; it went from 244 KB to less than 25 KB. 5. The http-code and openApi features were temporarily removed. The plan is to integrate them into version 2.5, which I plan to release soon. This addition is subject to your feedback. A survey will be created in the repository so you can give your opinion on whether these features are missing. # Index - [Configuration object πŸ”©πŸ”§.](#configuration-object-) - [Tools we offer πŸ”§πŸ”¨.](#tools-we-offer-) - [Route Module πŸ”ƒ.](#route-module-) - [Configuration object for Route.](#configuration-object-for-route) - [Prisma client creator πŸ”ƒ.](#prisma-client-creator-) - [Http Module πŸ“.](#http-module-) - [OpenAPI Module πŸ“.](#openapi-module-) - [OpenApi Example.](#openapi-example) - [Recommendations for use with third-party packages to OpeanApi.](#recommendations-for-use-with-third-party-packages-to-opeanapi) # Configuration object πŸ”©πŸ”§ This object is used to define types and versions of the tools. - Default object. In the event that the user does not place a configuration object, this will be the object that will be used by default in the kit. ````typescript import { ConfigObject } from "next-rocket-kit"; const configObjet: ConfigObject = { resolver: "zod", oas: "3.1" }; ``` ```` # Tools we offer πŸ”§πŸ”¨ > **Note πŸ§ͺ:** It is important to note that we will all be adding new tools to the kit in the future. ## Route Module πŸ”ƒ This tool helps to quickly create an endpoint using the **next.js** **API** folder. - We create the rocket to be able to access the tools in the kit. "path file" ~ ./libs/rocketKit/tools ```typescript import { createRocket } from 'next-rocket-kit'; export const { onRoute, http, OpenApi } = createRocket(); ``` - We define the router which should be used on the server side only, for this next.js gives us the comment function `use serve`. ```typescript // "path file" ~ ./libs/rocketKit/Route 'use serve'; import { onRoute } from './tools'; export const { Route } = onRoute(); ``` - We define barrel file. ```typescript // "path file" ~ ./libs/rocketKit/index export * from './tools'; export * from './Route'; ``` - We define a basic endPoint. ```typescript // "path file" ~ ./src/app/api/Route.ts import { Route } from '@/libs/rocketKit'; // End Point GET basic export const GET = Route({ Handler(req, reply, context) { return reply.json({ message: 'Hello World!' }, { status: 201 }); }, }); ``` ## Configuration object for Route - **Handler:** is the function that is executed when calling the end point. With the rocket **Route** it is much easier for us to create endpoints, such as a GET method endpoint. The handler function receives three parameters to handle and control the request video cycle, these parameters are as follows. - req: Everything that arrives from the client and gives access to all the native methods of **NextRequest**. Rocket functions in req. - req.getBody(): return body. - req.getQuery(): return queries. - req.getContext(): return context include path params. - req.getHeaders(): return headers. - reply: used to reply to the client and gives access to all the native methods of **NextResponse**. - context (The native context of **nextjs**) - **Schema (Schema valid):** The schemas attribute allows you to validate the type and format of the data that enters and leaves the **Route**, to handle these validations **Route** is compatible with two possible third party libraries, **"zod"** and **"yup"**. By default, `createRocketKit()` uses **"zod"** as the validation library. ```typescript // "path file" ~ ./src/app/api/route.ts import { Route } from '@/libs/Route'; // End Point GET basic export const POST = Route({ schemas: { body: Schema, query: Schema, context: Schema, headers: Schema, response: Schema, }, Handler(req, reply, context) { return reply.json({ message: 'Hello World!' }, { status: 201 }); }, }); ``` The Schemas attribute uses a life cycle to execute the validations, the order of that life cycle is as follows. ```mermaid graph LR A(headers) --> B(context) --> C(query) --> D(body) --> E(Handler) --> F(response) ``` ## Prisma client creator πŸ”ƒ This tool helps to quickly create an PrismaClient. "path file" ~ ./libs/rocketKit/tools ```typescript import { createRocket } from 'next-rocket-kit'; export const { onPrisma } = createRocket(); ``` ```typescript import { PrismaClient } from '@prisma/client'; import { onPrisma } from './rocket'; export const { prisma } = onPrisma(PrismaClient); ``` Global where in the select. ```typescript import { PrismaClient } from '@prisma/client'; import { onPrisma } from './rocket'; export const { prisma } = onPrisma(PrismaClient, { where: { delete_at: null }, }); ``` ## Http Module πŸ“ The Http tool will help you manage http status, to better manage and organize your request responses. > **Note πŸ“¦:** rocket-kit uses the [http-status-codes](https://www.npmjs.com/package/http-status-codes) package ```typescript const Http = { ReasonPhrases, StatusCodes, getReasonPhrase, getStatusCode, }; ``` ```typescript // "path file" ~ ./libs/rocketKit import { createRocket } from 'next-rocket-kit'; export const { Http } = createRocket(); ``` ```typescript // "path file" ~ ./src/app/api/route.ts import { Http } from '@/libs/rocketKit'; import { Route } from '@/libs/Route'; // End Point GET basic export const GET = Route({ Handler(req, reply, context) { return reply.json( { message: Http.ReasonPhrases.OK, // "OK" }, { status: Http.StatusCodes.OK, // 200 }, ); }, }); ``` ## OpenAPI Module πŸ“ OpenAPI allows you to create a json in openapi ["3.0"](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md) or ["3.1"](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md) format, compatible with tools like **swagger**, **postman** and anyone that receives the openapi format. > **Note πŸ“¦:** rocket-kit uses the [openapi3-ts](https://www.npmjs.com/package/openapi3-ts) package. To define the openapi version you must use the **oas** attribute in the kit configuration object. ```typescript // "path file" ~ ./libs/rocketKit import { createRocket } from 'next-rocket-kit'; export const { Http, OpenApi } = createRocket(); ``` ### OpenApi Example ```typescript // "path file" ~ ./libs/rocketKit import { createRocket } from 'next-rocket-kit'; export const { Http, OpenApi } = createRocket(); ``` ```typescript import { OpenApi } from './libs/rocketkt'; // declare info and openapi version. const openApi = OpenApi({ openapi: '3.0.3', // or 3.1.0 info: { title: 'example', description: 'string', termsOfService: 'string', contact: { name: 'Author', }, license: { name: 'MIT', }, version: '1.0.0', }, }); openApi.addSchema('User', { type: 'object', properties: { id: { type: 'string', }, name: { type: 'string', }, }, }); openApi.addPath('/items', { description: 'return item list', post: { description: 'get items', summary: 'get items', requestBody: { description: 'body', content: { 'application/json': { schema: { $ref: '#/components/schemas/User' }, }, }, }, responses: { 200: { description: 'ok', content: { 'application/json': { schema: { type: 'object', properties: { id: { type: 'string', }, }, }, }, }, }, }, }, }); // return json string openApi.getSpecAsJson(); // or return yml stirng openApi.getSpecAsYaml(); ``` ### Recommendations for use with third-party packages to OpeanApi How use OpenApi with "zod". - [@anatine/zod-openapi](https://www.npmjs.com/package/@anatine/zod-openapi): With this package we can reuse the "zod" validation schemas that you should already be using in the Route schema field to validate the body or some other field of the request. ```typescript import { OpenApi } from '@/libs/rocketKit'; import { generateSchema, extendZodWithOpenApi } from '@anatine/zod-openapi'; import { z } from 'zod'; // extend zod extendZodWithOpenApi(z); // declare info and openapi version. const openApi = OpenApi({ openapi: '3.0.3', // or 3.1.0 info: { title: 'example', description: 'string', termsOfService: 'string', version: '1.0.0', contact: { name: 'Author', }, license: { name: 'MIT', }, }, }); const ItemZodSchema = z .object({ id: z.string().uuid().nonempty().openapi({ title: 'Item ID', description: 'A UUID generated by the server', }), name: z.string().min(2), }) .openapi({ title: 'Item', description: 'A item schema', }); const ItemOpenAPiSchema = generateSchema(ItemZodSchema); openApi.addSchema('Item', ItemOpenAPiSchema); ``` > **Note πŸ§ͺ:** In the case of **Yup** we have not found a package that meets the standards we are looking for, we remain attentive to options proposed by the community. --- _Source: https://npm.io/package/next-rocket-kit Β· Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._