@kollors/deep-json-server 0.2.5 → 0.2.6

package/README.md

@@ -109,7 +109,7 @@ DELETE /movies/:id
 ## Pagination and sorting
 
 ```http
-GET /movies?_page=1&_per_page=10&_sort=-id,title
+GET /movies?_page=1&_perPage=10&_sort=-id,title
 ```
 
 Without `_page`, a GET collection returns an array. With `_page`, it returns:
@@ -224,12 +224,12 @@ 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:
+Use `name` when a resource needs an explicit schema name instead of the automatically singularized name:
 
 ```json
 {
   "equipment": {
-    "modelName": "Equipment"
+    "name": "Equipment"
   }
 }
 ```

package/README.ru.md

@@ -109,7 +109,7 @@ DELETE /movies/:id
 ## Пагинация и сортировка
 
 ```http
-GET /movies?_page=1&_per_page=10&_sort=-id,title
+GET /movies?_page=1&_perPage=10&_sort=-id,title
 ```
 
 Без `_page` GET-запрос к коллекции возвращает массив. С `_page` возвращается объект:
@@ -224,12 +224,12 @@ deep-json-server mock/database.json --generate mock/database-schema.json mock/op
 
 Генератор определяет ресурсы и типы полей по всем записям базы. Поля, присутствующие в каждой записи, считаются обязательными, если они не перечислены в `optional`; `formats` добавляет форматы OpenAPI, например `date` и `uri`. Для вложенных полей используются пути через точку, например `actors.id`.
 
-Используйте `modelName`, если ресурсу нужно явно задать имя схемы вместо автоматически полученного имени в единственном числе:
+Используйте `name`, если ресурсу нужно явно задать имя схемы вместо автоматически полученного имени в единственном числе:
 
 ```json
 {
   "equipment": {
-    "modelName": "Equipment"
+    "name": "Equipment"
   }
 }
 ```

package/package.json

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

package/src/openapi.js

@@ -134,7 +134,7 @@ const createParameters = () => ({
   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', required: true, schema: { minimum: 1, type: 'integer' } },
-  PerPage: { in: 'query', name: '_per_page', required: true, schema: { minimum: 1, type: 'integer' } },
+  PerPage: { in: 'query', name: '_perPage', 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' } },
 });
@@ -202,7 +202,7 @@ export function createOpenApiDocument(database, schemaConfig = {}) {
   const resources = getResourceNames(database);
   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));
+    const componentName = typeof resourceConfig.name === 'string' && resourceConfig.name !== '' ? resourceConfig.name : toPascalCase(singularize(resource));
 
     return [resource, componentName];
   }));

package/src/query.js

@@ -1,7 +1,7 @@
 import { createHttpError, isEqual, isObject, isSafeKey, toArray } from './utils.js';
 
 const FIELD_OPERATORS = new Set(['contains', 'endsWith', 'eq', 'every', 'gt', 'gte', 'in', 'lt', 'lte', 'ne', 'none', 'not', 'some', 'startsWith']);
-const RESERVED_QUERY_KEYS = new Set(['_embed', '_page', '_per_page', '_sort', '_where']);
+const RESERVED_QUERY_KEYS = new Set(['_embed', '_page', '_perPage', '_sort', '_where']);
 
 const compareValues = (left, right) => {
   if (Object.is(left, right)) {

package/src/server.js

@@ -56,7 +56,7 @@ export async function createServer({ databasePath, logger = true } = {}) {
     const sortedItems = sortItems(filteredItems, request.query._sort);
     const page = request.query._page == null ? undefined : Number(request.query._page);
 
-    return page == null ? sortedItems : paginateItems(sortedItems, page, Number(request.query._per_page));
+    return page == null ? sortedItems : paginateItems(sortedItems, page, Number(request.query._perPage));
   });
 
   server.get('/:resource/:id', async(request) => {