@omer-x/next-openapi-scaffold-generator 0.1.0

package/bin/index.js

@@ -0,0 +1,166 @@
+// src/core/file.ts
+import fs from "node:fs/promises";
+import path from "node:path";
+async function saveFile(directory, fileName, content) {
+  const dirPath = path.resolve(process.cwd(), directory);
+  await fs.mkdir(dirPath, { recursive: true });
+  const filePath = path.resolve(dirPath, fileName);
+  await fs.writeFile(filePath, content, "utf8");
+}
+
+// src/core/string.ts
+import { camelCase, capitalCase, kebabCase, noCase, pascalCase } from "change-case";
+import pluralize from "pluralize";
+function capitalize(text) {
+  if (text.length === 0) return text;
+  return text.charAt(0).toUpperCase() + text.slice(1).toLowerCase();
+}
+function convertToCamelCase(text, plural) {
+  const properText = plural ? pluralize(text) : pluralize.singular(text);
+  return camelCase(properText);
+}
+function convertToKebabCase(text, plural) {
+  const properText = plural ? pluralize(text) : pluralize.singular(text);
+  return kebabCase(properText);
+}
+function convertToPascalCase(text, plural) {
+  const properText = plural ? pluralize(text) : pluralize.singular(text);
+  return pascalCase(properText);
+}
+function convertToNoCase(text, plural) {
+  const properText = plural ? pluralize(text) : pluralize.singular(text);
+  return noCase(properText);
+}
+function convertToCapitalCase(text, plural, onlyFirst) {
+  const properText = plural ? pluralize(text) : pluralize.singular(text);
+  if (onlyFirst) {
+    return capitalize(noCase(properText));
+  }
+  return capitalCase(properText);
+}
+
+// src/prompt.ts
+import { stdin as input, stdout as output } from "node:process";
+import * as readline from "node:readline/promises";
+var rl = readline.createInterface({ input, output });
+async function askQuestions(queries) {
+  const answers = await Promise.all(queries.map((query) => rl.question(query)));
+  rl.close();
+  return answers;
+}
+
+// src/core/template.ts
+import Handlebars from "handlebars";
+function getTemplate(input2) {
+  return Handlebars.compile(input2);
+}
+
+// _td9nf9mua:/home/omer/Projects/next-openapi-scaffold-generator/src/templates/api-route.hbs
+var api_route_default = 'import defineRoute from "@omer-x/next-openapi-route-handler";\nimport z from "zod";\nimport db from "~/database";\nimport { New{{ pascalCaseSingular }}DTO, {{ pascalCaseSingular }}DTO } from "~/models/{{ kebabCaseSingular }}";\nimport create{{ pascalCaseSingular }} from "~/operations/create-{{ kebabCaseSingular }}";\nimport get{{ pascalCasePlural }} from "~/operations/get-{{ kebabCasePlural }}";\n\n{{{ readAllOperation }}}\n\n{{{ createOperation }}}\n';
+
+// _td9nf9mua:/home/omer/Projects/next-openapi-scaffold-generator/src/templates/create.hbs
+var create_default = 'export const { POST } = defineRoute({\n  operationId: "create{{ pascalCaseSingular }}",\n  method: "POST",\n  summary: "Create {{ noCaseSingular }}",\n  description: "Create a new {{ noCaseSingular }}",\n  tags: ["{{ capitalCasePlural }}"],\n  requestBody: New{{ pascalCaseSingular }}DTO,\n  action: async ({ body }) => {\n    const {{ camelCaseSingular }} = await create{{ pascalCaseSingular }}(db, body);\n    return Response.json({{ camelCaseSingular }}, { status: 201 });\n  },\n  responses: {\n    201: { description: "{{ onlyFirstCapitalCaseSingular }} created successfully", content: {{ pascalCaseSingular }}DTO },\n  },\n});\n';
+
+// src/templates/create.ts
+function generateCreateOperation(modelName2) {
+  const template = getTemplate(create_default);
+  return template({
+    camelCaseSingular: convertToCamelCase(modelName2, false),
+    capitalCasePlural: convertToCapitalCase(modelName2, true, false),
+    noCaseSingular: convertToNoCase(modelName2, false),
+    onlyFirstCapitalCaseSingular: convertToCapitalCase(modelName2, false, true),
+    pascalCaseSingular: convertToPascalCase(modelName2, false)
+  });
+}
+
+// _td9nf9mua:/home/omer/Projects/next-openapi-scaffold-generator/src/templates/read-all.hbs
+var read_all_default = 'export const { GET } = defineRoute({\n  operationId: "get{{ pascalCasePlural }}",\n  method: "GET",\n  summary: "Get all {{ noCasePlural }}",\n  description: "Retrieve a list of {{ noCasePlural }}",\n  tags: ["{{ capitalCasePlural }}"],\n  queryParams: z.object({\n    select: {{ pascalCaseSingular }}DTO.keyof().array().default([])\n      .describe("List of the column names"),\n  }),\n  action: async ({ queryParams }) => {\n    return Response.json(await get{{ pascalCasePlural }}(db, queryParams.select));\n  },\n  responses: {\n    200: { description: "Returns a list of {{ noCasePlural }}", content: {{ pascalCaseSingular }}DTO, isArray: true },\n  },\n});\n';
+
+// src/templates/read-all.ts
+function generateReadAllOperation(modelName2) {
+  const template = getTemplate(read_all_default);
+  return template({
+    capitalCasePlural: convertToCapitalCase(modelName2, true, false),
+    noCasePlural: convertToNoCase(modelName2, true),
+    pascalCaseSingular: convertToPascalCase(modelName2, false),
+    pascalCasePlural: convertToPascalCase(modelName2, true)
+  });
+}
+
+// src/templates/api-route.ts
+function generateApiRoute(modelName2) {
+  const template = getTemplate(api_route_default);
+  return template({
+    kebabCasePlural: convertToKebabCase(modelName2, true),
+    kebabCaseSingular: convertToKebabCase(modelName2, false),
+    pascalCasePlural: convertToPascalCase(modelName2, true),
+    pascalCaseSingular: convertToPascalCase(modelName2, false),
+    readAllOperation: generateReadAllOperation(modelName2).slice(0, -1),
+    createOperation: generateCreateOperation(modelName2).slice(0, -1)
+  });
+}
+
+// _td9nf9mua:/home/omer/Projects/next-openapi-scaffold-generator/src/templates/api-route-with-id.hbs
+var api_route_with_id_default = 'import defineRoute from "@omer-x/next-openapi-route-handler";\nimport db from "~/database";\nimport { {{ pascalCaseSingular }}DTO, {{ pascalCaseSingular }}PatchDTO } from "~/models/{{ kebabCaseSingular }}";\nimport delete{{ pascalCaseSingular }} from "~/operations/delete-{{ kebabCaseSingular }}";\nimport get{{ pascalCaseSingular }} from "~/operations/get-{{ kebabCaseSingular }}";\nimport update{{ pascalCaseSingular }} from "~/operations/update-{{ kebabCaseSingular }}";\n\n{{{ readOperation }}}\n\n{{{ updateOperation }}}\n\n{{{ deleteOperation }}}\n';
+
+// _td9nf9mua:/home/omer/Projects/next-openapi-scaffold-generator/src/templates/delete.hbs
+var delete_default = 'export const { DELETE } = defineRoute({\n  operationId: "delete{{ pascalCaseSingular }}",\n  method: "DELETE",\n  summary: "Delete {{ noCaseSingular }}",\n  description: "Delete a specific {{ noCaseSingular }} by ID",\n  tags: ["{{ capitalCasePlural }}"],\n  pathParams: {{ pascalCaseSingular }}DTO.pick({ id: true }),\n  action: async ({ pathParams }) => {\n    const {{ camelCaseSingular }} = await delete{{ pascalCaseSingular }}(db, pathParams.id);\n    if ({{ camelCaseSingular }}?.id === pathParams.id) {\n      return new Response(null, { status: 204 });\n    }\n    return new Response(null, { status: 404 });\n  },\n  responses: {\n    204: { description: "{{ onlyFirstCapitalCaseSingular }} deleted successfully" },\n    404: { description: "{{ onlyFirstCapitalCaseSingular }} not found" },\n  },\n});\n';
+
+// src/templates/delete.ts
+function generateDeleteOperation(modelName2) {
+  const template = getTemplate(delete_default);
+  return template({
+    camelCaseSingular: convertToCamelCase(modelName2, false),
+    capitalCasePlural: convertToCapitalCase(modelName2, true, false),
+    noCaseSingular: convertToNoCase(modelName2, false),
+    onlyFirstCapitalCaseSingular: convertToCapitalCase(modelName2, false, true),
+    pascalCaseSingular: convertToPascalCase(modelName2, false)
+  });
+}
+
+// _td9nf9mua:/home/omer/Projects/next-openapi-scaffold-generator/src/templates/read.hbs
+var read_default = 'export const { GET } = defineRoute({\n  operationId: "get{{ pascalCaseSingular }}",\n  method: "GET",\n  summary: "Get {{ noCaseSingular }}",\n  description: "Get a specific {{ noCaseSingular }} by ID",\n  tags: ["{{ capitalCasePlural }}"],\n  pathParams: {{ pascalCaseSingular }}DTO.pick({ id: true }),\n  action: async ({ pathParams }) => {\n    const {{ camelCaseSingular }} = await get{{ pascalCaseSingular }}(db, pathParams.id);\n    if ({{ camelCaseSingular }}) {\n      return Response.json({{ camelCaseSingular }});\n    }\n    return new Response(null, { status: 404 });\n  },\n  responses: {\n    200: { description: "{{ onlyFirstCapitalCaseSingular }} found", content: {{ pascalCaseSingular }}DTO },\n    404: { description: "{{ onlyFirstCapitalCaseSingular }} not found" },\n  },\n});\n';
+
+// src/templates/read.ts
+function generateReadOperation(modelName2) {
+  const template = getTemplate(read_default);
+  return template({
+    camelCaseSingular: convertToCamelCase(modelName2, false),
+    capitalCasePlural: convertToCapitalCase(modelName2, true, false),
+    noCaseSingular: convertToNoCase(modelName2, false),
+    onlyFirstCapitalCaseSingular: convertToCapitalCase(modelName2, false, true),
+    pascalCaseSingular: convertToPascalCase(modelName2, false)
+  });
+}
+
+// _td9nf9mua:/home/omer/Projects/next-openapi-scaffold-generator/src/templates/update.hbs
+var update_default = 'export const { PATCH } = defineRoute({\n  operationId: "update{{ pascalCaseSingular }}",\n  method: "PATCH",\n  summary: "Update {{ noCaseSingular }}",\n  description: "Update a specific {{ noCaseSingular }} by ID",\n  tags: ["{{ capitalCasePlural }}"],\n  pathParams: {{ pascalCaseSingular }}DTO.pick({ id: true }),\n  requestBody: {{ pascalCaseSingular }}PatchDTO,\n  action: async ({ pathParams, body }) => {\n    const {{ camelCaseSingular }} = await update{{ pascalCaseSingular }}(db, pathParams.id, body);\n    if ({{ camelCaseSingular }}?.id === pathParams.id) {\n      return Response.json({{ camelCaseSingular }});\n    }\n    return new Response(null, { status: 404 });\n  },\n  responses: {\n    200: { description: "{{ onlyFirstCapitalCaseSingular }} updated successfully", content: {{ pascalCaseSingular }}DTO },\n    404: { description: "{{ onlyFirstCapitalCaseSingular }} not found" },\n  },\n});\n';
+
+// src/templates/update.ts
+function generateUpdateOperation(modelName2) {
+  const template = getTemplate(update_default);
+  return template({
+    camelCaseSingular: convertToCamelCase(modelName2, false),
+    capitalCasePlural: convertToCapitalCase(modelName2, true, false),
+    noCaseSingular: convertToNoCase(modelName2, false),
+    onlyFirstCapitalCaseSingular: convertToCapitalCase(modelName2, false, true),
+    pascalCaseSingular: convertToPascalCase(modelName2, false)
+  });
+}
+
+// src/templates/api-route-with-id.ts
+function generateApiRouteWithId(modelName2) {
+  const template = getTemplate(api_route_with_id_default);
+  return template({
+    kebabCaseSingular: convertToKebabCase(modelName2, false),
+    pascalCaseSingular: convertToPascalCase(modelName2, false),
+    readOperation: generateReadOperation(modelName2).slice(0, -1),
+    updateOperation: generateUpdateOperation(modelName2).slice(0, -1),
+    deleteOperation: generateDeleteOperation(modelName2).slice(0, -1)
+  });
+}
+
+// src/index.ts
+var [modelName] = await askQuestions(["Enter Model Name: "]);
+await saveFile(`src/app/${convertToKebabCase(modelName, true)}`, "route.ts", generateApiRoute(modelName));
+await saveFile(`src/app/${convertToKebabCase(modelName, true)}/[id]`, "route.ts", generateApiRouteWithId(modelName));

package/package.json

@@ -0,0 +1,71 @@
+{
+  "name": "@omer-x/next-openapi-scaffold-generator",
+  "version": "0.1.0",
+  "description": "Generates model, schema and API routes for CRUD operations",
+  "keywords": [
+    "next",
+    "openapi",
+    "scaffold",
+    "generator",
+    "swagger",
+    "api",
+    "crud",
+    "schema",
+    "model",
+    "typescript",
+    "ts",
+    "nextjs"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/omermecitoglu/next-openapi-scaffold-generator.git"
+  },
+  "bugs": {
+    "url": "https://github.com/omermecitoglu/next-openapi-scaffold-generator/issues"
+  },
+  "homepage": "https://github.com/omermecitoglu/next-openapi-scaffold-generator#readme",
+  "private": false,
+  "publishConfig": {
+    "access": "public"
+  },
+  "author": {
+    "name": "Omer Mecitoglu",
+    "email": "omer.mecitoglu@gmail.com",
+    "url": "https://omermecitoglu.github.io"
+  },
+  "license": "MIT",
+  "main": "bin/index.js",
+  "bin": {
+    "generate-scaffold": "bin/index.js"
+  },
+  "files": [
+    "bin/"
+  ],
+  "type": "module",
+  "engines": {
+    "node": ">=14.8.0"
+  },
+  "scripts": {
+    "gh:release": "conventional-github-releaser -p angular",
+    "test": "jest",
+    "dev": "tsup --watch",
+    "build": "tsup"
+  },
+  "dependencies": {
+    "change-case": "^5.4.4",
+    "handlebars": "^4.7.8",
+    "pluralize": "^8.0.0"
+  },
+  "devDependencies": {
+    "@omer-x/eslint-config": "^1.0.7",
+    "@types/node": "^22.5.0",
+    "@types/pluralize": "^0.0.33",
+    "conventional-github-releaser": "^3.1.5",
+    "esbuild-plugin-inline-import": "^1.1.0",
+    "eslint": "^8.57.0",
+    "ts-jest": "^29.2.4",
+    "ts-node": "^10.9.2",
+    "tsup": "^8.2.4",
+    "typescript": "^5.5.4"
+  }
+}