@kollors/deep-json-server 0.2.0 → 0.2.1

package/README.md

@@ -31,37 +31,6 @@ npm run mock
 
 The default address is `http://127.0.0.1:4001`. You can also pass `--host` and `--port`, or set the `HOST` and `PORT` environment variables.
 
-## OpenAPI generation
-
-Create a small configuration file next to the database, for example `mock/database-schema.json`:
-
-```json
-{
-  "movies": {
-    "optional": ["description"],
-    "formats": {
-      "coverSrc": "uri"
-    }
-  },
-  "users": {
-    "formats": {
-      "avatarSrc": "uri",
-      "bornAt": "date"
-    }
-  }
-}
-```
-
-Generate an OpenAPI 3.0.3 file and exit:
-
-```bash
-deep-json-server mock/database.json --generate mock/database-schema.json mock/openapi-schema.yaml
-```
-
-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`.
-
-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.
-
 ## Example database
 
 This example is based on a movie catalog. It intentionally has no clothes resource. The genre names are real film genres, while `Gangster film` demonstrates a self-referencing subgenre.
@@ -226,6 +195,37 @@ Relations are inferred by convention:
 
 They are soft references: the server resolves them when requested but does not enforce referential integrity when data is written.
 
+## OpenAPI generation
+
+Create a small configuration file next to the database, for example `mock/database-schema.json`:
+
+```json
+{
+  "movies": {
+    "optional": ["description"],
+    "formats": {
+      "coverSrc": "uri"
+    }
+  },
+  "users": {
+    "formats": {
+      "avatarSrc": "uri",
+      "bornAt": "date"
+    }
+  }
+}
+```
+
+Generate an OpenAPI 3.0.3 file and exit:
+
+```bash
+deep-json-server mock/database.json --generate mock/database-schema.json mock/openapi-schema.yaml
+```
+
+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`.
+
+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
 
 ```js

package/README.ru.md

@@ -31,37 +31,6 @@ npm run mock
 
 По умолчанию сервер доступен по адресу `http://127.0.0.1:4001`. Адрес и порт можно задать через `--host` и `--port` либо переменные окружения `HOST` и `PORT`.
 
-## Генерация OpenAPI
-
-Создайте рядом с базой небольшой файл конфигурации, например `mock/database-schema.json`:
-
-```json
-{
-  "movies": {
-    "optional": ["description"],
-    "formats": {
-      "coverSrc": "uri"
-    }
-  },
-  "users": {
-    "formats": {
-      "avatarSrc": "uri",
-      "bornAt": "date"
-    }
-  }
-}
-```
-
-Сгенерируйте OpenAPI 3.0.3 и завершите работу:
-
-```bash
-deep-json-server mock/database.json --generate mock/database-schema.json mock/openapi-schema.yaml
-```
-
-Генератор определяет ресурсы и типы полей по всем записям базы. Поля, присутствующие в каждой записи, считаются обязательными, если они не перечислены в `optional`; `formats` добавляет форматы OpenAPI, например `date` и `uri`. Для вложенных полей используются пути через точку, например `actors.id`.
-
-В сгенерированном документе описаны CRUD, пагинация, сортировка, глубокие фильтры, `_embed` и связи в ответах, определённые по полям `...Id` и `...Ids`. Файл можно передать, например, в RTK Query OpenAPI Codegen. OpenAPI создаётся только с параметром `--generate`; обычный запуск сервера файл не перезаписывает.
-
 ## Пример базы данных
 
 Пример основан на каталоге фильмов. В нём намеренно нет сущности одежды. Используются реальные жанры фильмов, а `Гангстерский фильм` демонстрирует связь с родительским жанром.
@@ -226,6 +195,37 @@ GET /countries/1?_embed=users
 
 Это мягкие ссылки: сервер загружает их по запросу, но не проверяет ссылочную целостность при записи данных.
 
+## Генерация OpenAPI
+
+Создайте рядом с базой небольшой файл конфигурации, например `mock/database-schema.json`:
+
+```json
+{
+  "movies": {
+    "optional": ["description"],
+    "formats": {
+      "coverSrc": "uri"
+    }
+  },
+  "users": {
+    "formats": {
+      "avatarSrc": "uri",
+      "bornAt": "date"
+    }
+  }
+}
+```
+
+Сгенерируйте OpenAPI 3.0.3 и завершите работу:
+
+```bash
+deep-json-server mock/database.json --generate mock/database-schema.json mock/openapi-schema.yaml
+```
+
+Генератор определяет ресурсы и типы полей по всем записям базы. Поля, присутствующие в каждой записи, считаются обязательными, если они не перечислены в `optional`; `formats` добавляет форматы OpenAPI, например `date` и `uri`. Для вложенных полей используются пути через точку, например `actors.id`.
+
+В сгенерированном документе описаны CRUD, пагинация, сортировка, глубокие фильтры, `_embed` и связи в ответах, определённые по полям `...Id` и `...Ids`. Файл можно передать, например, в RTK Query OpenAPI Codegen. OpenAPI создаётся только с параметром `--generate`; обычный запуск сервера файл не перезаписывает.
+
 ## Программный API
 
 ```js

package/index.js

@@ -1,13 +1,12 @@
 #!/usr/bin/env node
 
-import { resolve } from 'node:path';
 import process from 'node:process';
-import { fileURLToPath } from 'node:url';
 import { runCli } from './src/cli.js';
+import { isMainModule } from './src/utils.js';
 
 export { createOpenApiDocument, generateOpenApi } from './src/openapi.js';
 export { createServer, startServer } from './src/server.js';
 
-if (process.argv[1] != null && resolve(process.argv[1]) === fileURLToPath(import.meta.url)) {
+if (isMainModule(process.argv[1], import.meta.url)) {
   await runCli();
 }

package/package.json

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

package/src/utils.js

@@ -1,4 +1,6 @@
+import { realpathSync } from 'node:fs';
 import { resolve } from 'node:path';
+import { fileURLToPath } from 'node:url';
 
 const UNSAFE_KEYS = new Set(['__proto__', 'constructor', 'prototype']);
 
@@ -11,6 +13,7 @@ export const createHttpError = (statusCode, message) => {
 };
 
 export const getResourceNames = (data) => Object.entries(data).filter(([, value]) => Array.isArray(value)).map(([resource]) => resource);
+export const isMainModule = (filePath, moduleUrl) => filePath != null && realpathSync(resolve(filePath)) === fileURLToPath(moduleUrl);
 export const isObject = (value) => typeof value === 'object' && value !== null && !Array.isArray(value);
 export const isSafeKey = (key) => !UNSAFE_KEYS.has(key);
 export const toArray = (value) => (Array.isArray(value) ? value : [value]);