@kollors/deep-json-server 0.2.3 → 0.2.5

package/README.md

@@ -224,6 +224,16 @@ deep-json-server mock/database.json --generate mock/database-schema.json mock/op
 
 The generator infers resources and field types from all database records. Fields present in every record are required unless listed in `optional`; `formats` adds OpenAPI formats such as `date` and `uri`. Nested fields use dot paths, for example `actors.id`.
 
+Use `modelName` when a resource needs an explicit schema name instead of the automatically singularized name:
+
+```json
+{
+  "equipment": {
+    "modelName": "Equipment"
+  }
+}
+```
+
 The generated document describes CRUD endpoints, pagination, sorting, deep filters, `_embed`, and response relations inferred from `...Id` and `...Ids` fields. It can be used as input for tools such as RTK Query OpenAPI Codegen. OpenAPI is generated only when `--generate` is passed; normal server startup does not rewrite the file.
 
 ## Programmatic API

package/README.ru.md

@@ -224,6 +224,16 @@ deep-json-server mock/database.json --generate mock/database-schema.json mock/op
 
 Генератор определяет ресурсы и типы полей по всем записям базы. Поля, присутствующие в каждой записи, считаются обязательными, если они не перечислены в `optional`; `formats` добавляет форматы OpenAPI, например `date` и `uri`. Для вложенных полей используются пути через точку, например `actors.id`.
 
+Используйте `modelName`, если ресурсу нужно явно задать имя схемы вместо автоматически полученного имени в единственном числе:
+
+```json
+{
+  "equipment": {
+    "modelName": "Equipment"
+  }
+}
+```
+
 В сгенерированном документе описаны CRUD, пагинация, сортировка, глубокие фильтры, `_embed` и связи в ответах, определённые по полям `...Id` и `...Ids`. Файл можно передать, например, в RTK Query OpenAPI Codegen. OpenAPI создаётся только с параметром `--generate`; обычный запуск сервера файл не перезаписывает.
 
 ## Программный API

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kollors/deep-json-server",
-  "version": "0.2.3",
+  "version": "0.2.5",
   "description": "JSON mock server with deep filters and recursive relationship embedding",
   "type": "module",
   "bin": {

package/src/openapi.js

@@ -131,10 +131,10 @@ const omitId = (schema, keepRequired) => {
 };
 
 const createParameters = () => ({
-  Embed: { description: 'Comma-separated relationship paths to embed', in: 'query', name: '_embed', schema: { type: 'string' } },
+  Embed: { description: 'Relationship paths to embed', explode: true, in: 'query', name: '_embed', schema: { items: { type: 'string' }, type: 'array' }, style: 'form' },
   Id: { in: 'path', name: 'id', required: true, schema: { type: 'string' } },
-  Page: { in: 'query', name: '_page', schema: { minimum: 1, type: 'integer' } },
-  PerPage: { in: 'query', name: '_per_page', schema: { minimum: 1, type: 'integer' } },
+  Page: { in: 'query', name: '_page', required: true, schema: { minimum: 1, type: 'integer' } },
+  PerPage: { in: 'query', name: '_per_page', required: true, schema: { minimum: 1, type: 'integer' } },
   Sort: { description: 'Comma-separated fields; prefix with - for descending order', in: 'query', name: '_sort', schema: { type: 'string' } },
   Where: { description: 'JSON-encoded deep filter', in: 'query', name: '_where', schema: { type: 'string' } },
 });
@@ -145,51 +145,50 @@ const reference = (name) => ({ $ref: `#/components/schemas/${name}` });
 const parameter = (name) => ({ $ref: `#/components/parameters/${name}` });
 
 const createResourcePaths = (resource, componentName) => {
-  const tag = componentName;
-  const listSchema = { oneOf: [{ items: reference(componentName), type: 'array' }, reference(`${componentName}Page`)] };
+  const resourceName = toPascalCase(resource);
   const body = (name) => ({ required: true, ...jsonContent(reference(name)) });
 
   return {
     [`/${resource}`]: {
       get: {
-        operationId: `get${toPascalCase(resource)}`,
+        operationId: `get${resourceName}`,
         parameters: ['Page', 'PerPage', 'Sort', 'Where', 'Embed'].map(parameter),
-        responses: { 200: response('Successful response', listSchema), 400: response('Invalid query', reference('Error')) },
-        tags: [tag],
+        responses: { 200: response('Successful response', reference(`${componentName}Page`)), 400: response('Invalid query', reference('Error')) },
+        tags: [resource],
       },
       post: {
-        operationId: `create${componentName}`,
+        operationId: `post${resourceName}`,
         requestBody: body(`${componentName}Create`),
         responses: { 201: response('Created', reference(componentName)), 400: response('Invalid request', reference('Error')) },
-        tags: [tag],
+        tags: [resource],
       },
     },
     [`/${resource}/{id}`]: {
       delete: {
-        operationId: `delete${componentName}`,
+        operationId: `delete${resourceName}ById`,
         parameters: [parameter('Id')],
         responses: { 200: response('Deleted', reference(componentName)), 404: response('Not found', reference('Error')) },
-        tags: [tag],
+        tags: [resource],
       },
       get: {
-        operationId: `get${componentName}ById`,
+        operationId: `get${resourceName}ById`,
         parameters: [parameter('Id'), parameter('Embed')],
         responses: { 200: response('Successful response', reference(componentName)), 404: response('Not found', reference('Error')) },
-        tags: [tag],
+        tags: [resource],
       },
       patch: {
-        operationId: `update${componentName}`,
+        operationId: `patch${resourceName}ById`,
         parameters: [parameter('Id')],
         requestBody: body(`${componentName}Update`),
         responses: { 200: response('Updated', reference(componentName)), 404: response('Not found', reference('Error')) },
-        tags: [tag],
+        tags: [resource],
       },
       put: {
-        operationId: `replace${componentName}`,
+        operationId: `put${resourceName}ById`,
         parameters: [parameter('Id')],
         requestBody: body(`${componentName}Create`),
         responses: { 200: response('Replaced', reference(componentName)), 404: response('Not found', reference('Error')) },
-        tags: [tag],
+        tags: [resource],
       },
     },
   };
@@ -201,7 +200,12 @@ export function createOpenApiDocument(database, schemaConfig = {}) {
   }
 
   const resources = getResourceNames(database);
-  const componentNames = Object.fromEntries(resources.map((resource) => [resource, toPascalCase(singularize(resource))]));
+  const componentNames = Object.fromEntries(resources.map((resource) => {
+    const resourceConfig = isObject(schemaConfig[resource]) ? schemaConfig[resource] : {};
+    const componentName = typeof resourceConfig.modelName === 'string' && resourceConfig.modelName !== '' ? resourceConfig.modelName : toPascalCase(singularize(resource));
+
+    return [resource, componentName];
+  }));
   const schemas = {
     Error: { properties: { error: { type: 'string' } }, required: ['error'], type: 'object' },
   };
@@ -241,7 +245,7 @@ export function createOpenApiDocument(database, schemaConfig = {}) {
     openapi: '3.0.3',
     paths: Object.assign({}, ...resources.map((resource) => createResourcePaths(resource, componentNames[resource]))),
     servers: Array.isArray(schemaConfig.$servers) ? schemaConfig.$servers : [{ url: 'http://127.0.0.1:4001' }],
-    tags: resources.map((resource) => ({ name: componentNames[resource] })),
+    tags: resources.map((resource) => ({ name: resource })),
   };
 }
 
@@ -252,7 +256,7 @@ export async function generateOpenApi({ databasePath, outputPath, schemaPath })
   const resolvedOutputPath = resolve(outputPath);
 
   await mkdir(dirname(resolvedOutputPath), { recursive: true });
-  await writeFile(resolvedOutputPath, stringify(document, { lineWidth: 0 }), 'utf8');
+  await writeFile(resolvedOutputPath, stringify(document, { aliasDuplicateObjects: false, lineWidth: 0 }), 'utf8');
 
   return document;
 }