@kollors/deep-json-server 0.6.0 → 0.8.0

package/src/server.js

@@ -1,248 +0,0 @@
-import Fastify from 'fastify';
-import { normalizeServerConfig } from './config.js';
-import { DEFAULT_HOST, DEFAULT_MAX_FILE_SIZE, DEFAULT_PORT, MAX_PAGE_SIZE } from './constants.js';
-import { createDatabaseStore, createId, findItem, getCollection } from './database.js';
-import { createFileStore, registerFileRoutes } from './files.js';
-import { resolveSchemaConfig } from './openapi/config.js';
-import { buildOpenapiDocument } from './openapi/document.js';
-import { createOpenapi, writeOpenapi } from './openapi/index.js';
-import { matchesWhere, paginateItems, parsePagination, parseWhere, sortItems, validateWhere } from './query/index.js';
-import { embedItem, parseEmbedPaths, validateEmbedPaths } from './relations.js';
-import { createHttpError, getResourceNames, isObject } from './utils.js';
-
-/** @typedef {Record<string, unknown>} OpenapiDocument */
-
-const CORS_HEADERS = {
-  'Access-Control-Allow-Headers': 'Content-Name, Content-Type',
-  'Access-Control-Allow-Methods': 'DELETE, GET, OPTIONS, PATCH, POST, PUT',
-  'Access-Control-Allow-Origin': '*',
-};
-
-const getRequestBody = (body) => {
-  if (!isObject(body)) {
-    throw createHttpError(400, 'Тело запроса должно быть JSON-объектом');
-  }
-
-  return body;
-};
-
-const getSchemaName = (reference) => reference.split('/').at(-1);
-
-const addRequestSchemas = (server, document, resources) => {
-  const requestSchemaNames = new Set(
-    resources.flatMap((resource) => {
-      const resourcePath = document.paths[`/${resource}`];
-      const itemPath = document.paths[`/${resource}/{id}`];
-
-      return [getSchemaName(resourcePath.post.requestBody.content['application/json'].schema.$ref), getSchemaName(itemPath.patch.requestBody.content['application/json'].schema.$ref)];
-    }),
-  );
-
-  requestSchemaNames.forEach((schemaName) => {
-    server.addSchema({ $id: schemaName, ...document.components.schemas[schemaName] });
-  });
-};
-
-const registerResourceRoutes = (server, store, resource, document, maxPageSize) => {
-  const resourcePath = `/${resource}`;
-  const itemPath = `/${resource}/:id`;
-  const createSchemaName = getSchemaName(document.paths[resourcePath].post.requestBody.content['application/json'].schema.$ref);
-  const updateSchemaName = getSchemaName(document.paths[`/${resource}/{id}`].patch.requestBody.content['application/json'].schema.$ref);
-
-  server.get(resourcePath, async (request) => {
-    const collection = getCollection(store.database, resource);
-    const where = parseWhere(request.query);
-    const embedPaths = parseEmbedPaths(request.query._embed);
-    const pagination = parsePagination(request.query, maxPageSize);
-
-    validateEmbedPaths(store.database, resource, collection, embedPaths);
-
-    const relationIndexes = new Map();
-    const embeddedItems = collection.map((item) => embedItem(store.database, item, resource, embedPaths, relationIndexes));
-
-    validateWhere(where, embeddedItems);
-
-    const filteredItems = embeddedItems.filter((item) => matchesWhere(item, where));
-    const sortedItems = sortItems(filteredItems, request.query._sort, embeddedItems);
-
-    return paginateItems(sortedItems, pagination.page, pagination.pageSize);
-  });
-
-  server.get(itemPath, async (request) => {
-    const collection = getCollection(store.database, resource);
-    const item = findItem(collection, request.params.id);
-    const embedPaths = parseEmbedPaths(request.query._embed);
-
-    if (item == null) {
-      throw createHttpError(404, 'Запись не найдена');
-    }
-
-    validateEmbedPaths(store.database, resource, collection, embedPaths);
-
-    return embedItem(store.database, item, resource, embedPaths);
-  });
-
-  server.post(resourcePath, { schema: { body: { $ref: `${createSchemaName}#` } } }, async (request, reply) => {
-    const item = await store.update((database) => {
-      const collection = getCollection(database, resource);
-      const createdItem = { ...getRequestBody(request.body), id: createId(collection) };
-
-      collection.push(createdItem);
-
-      return createdItem;
-    });
-
-    return reply.code(201).send(item);
-  });
-
-  server.put(itemPath, { schema: { body: { $ref: `${createSchemaName}#` } } }, async (request) =>
-    store.update((database) => {
-      const collection = getCollection(database, resource);
-      const currentItem = findItem(collection, request.params.id);
-
-      if (currentItem == null) {
-        throw createHttpError(404, 'Запись не найдена');
-      }
-
-      const item = { ...getRequestBody(request.body), id: currentItem.id };
-
-      collection.splice(collection.indexOf(currentItem), 1, item);
-
-      return item;
-    }),
-  );
-
-  server.patch(itemPath, { schema: { body: { $ref: `${updateSchemaName}#` } } }, async (request) =>
-    store.update((database) => {
-      const collection = getCollection(database, resource);
-      const currentItem = findItem(collection, request.params.id);
-
-      if (currentItem == null) {
-        throw createHttpError(404, 'Запись не найдена');
-      }
-
-      const item = { ...currentItem, ...getRequestBody(request.body), id: currentItem.id };
-
-      collection.splice(collection.indexOf(currentItem), 1, item);
-
-      return item;
-    }),
-  );
-
-  server.delete(itemPath, async (request) =>
-    store.update((database) => {
-      const collection = getCollection(database, resource);
-      const currentItem = findItem(collection, request.params.id);
-
-      if (currentItem == null) {
-        throw createHttpError(404, 'Запись не найдена');
-      }
-
-      collection.splice(collection.indexOf(currentItem), 1);
-
-      return currentItem;
-    }),
-  );
-};
-
-/**
- * Creates a Deep JSON Server facade.
- * @param {import('./config.js').DeepJsonServerConfig} options Server options.
- * @param {{ files?: boolean }} [features] Optional feature switches.
- * @returns {Promise<{ fastify: () => import('fastify').FastifyInstance, openapi: () => Promise<OpenapiDocument> }>} Server facade.
- */
-export async function createServer(options, features = {}) {
-  const config = normalizeServerConfig(options);
-  const filesEnabled = features.files ?? config.files != null;
-  const { logger = true, maxFileSize = DEFAULT_MAX_FILE_SIZE, maxPageSize = MAX_PAGE_SIZE } = config.server;
-  const store = await createDatabaseStore(config.database);
-  const schema = await resolveSchemaConfig(config.database.schema);
-  const fileStore = filesEnabled && config.files != null ? await createFileStore(config.files) : undefined;
-  let fastifyInstance;
-
-  if (filesEnabled && config.files == null) {
-    throw new Error('Для файловых маршрутов укажите секцию config.files');
-  }
-
-  const buildDocument = () =>
-    buildOpenapiDocument({
-      database: store.database.data,
-      files: filesEnabled,
-      maxPageSize,
-      schema,
-    });
-
-  const fastify = () => {
-    if (fastifyInstance != null) {
-      return fastifyInstance;
-    }
-
-    const document = buildDocument();
-    const resources = getResourceNames(store.database.data);
-    const server = Fastify({ logger });
-    const listen = server.listen.bind(server);
-
-    server.listen = (...args) => listen(...(args.length === 0 ? [{ host: config.server.host ?? DEFAULT_HOST, port: config.server.port ?? DEFAULT_PORT }] : args));
-
-    addRequestSchemas(server, document, resources);
-
-    server.addHook('onRequest', async (_request, reply) => {
-      Object.entries(CORS_HEADERS).forEach(([header, value]) => {
-        reply.header(header, value);
-      });
-    });
-
-    server.addHook('preHandler', async (request) => {
-      if (request.method === 'GET') {
-        await store.read();
-      }
-    });
-
-    server.options('/', async (_request, reply) => reply.code(204).send());
-    server.options('/*', async (_request, reply) => reply.code(204).send());
-    server.get('/', async () => ({ resources }));
-
-    resources.forEach((resource) => {
-      registerResourceRoutes(server, store, resource, document, maxPageSize);
-    });
-
-    if (fileStore != null) {
-      registerFileRoutes(server, { maxFileSize, store: fileStore });
-    }
-
-    server.setErrorHandler((error, request, reply) => {
-      const statusCode = Number.isInteger(error.statusCode) ? error.statusCode : 500;
-
-      if (statusCode === 500) {
-        request.log.error(error);
-      }
-
-      return reply.code(statusCode).send({ error: error.message });
-    });
-
-    fastifyInstance = server;
-
-    return fastifyInstance;
-  };
-
-  const openapi = async () => {
-    await store.read();
-
-    const document = createOpenapi({
-      database: store.database.data,
-      files: filesEnabled,
-      host: config.server.host,
-      maxPageSize,
-      port: config.server.port,
-      schema,
-    });
-
-    if (config.openapi.path != null) {
-      await writeOpenapi(document, config.openapi.path);
-    }
-
-    return document;
-  };
-
-  return { fastify, openapi };
-}

package/src/utils.js

@@ -1,54 +0,0 @@
-import { resolve } from 'node:path';
-import pluralize from 'pluralize';
-
-const UNSAFE_KEYS = new Set(['__proto__', 'constructor', 'prototype']);
-
-export const createHttpError = (statusCode, message) => {
-  const error = new Error(message);
-
-  error.statusCode = statusCode;
-
-  return error;
-};
-
-export const getResourceNames = (data) => Object.keys(data);
-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]);
-
-export const isEqual = (left, right) => {
-  if (Object.is(left, right)) {
-    return true;
-  }
-
-  if (Array.isArray(left) && Array.isArray(right)) {
-    return left.length === right.length && left.every((value, index) => isEqual(value, right[index]));
-  }
-
-  if (isObject(left) && isObject(right)) {
-    const leftKeys = Object.keys(left);
-    const rightKeys = Object.keys(right);
-
-    return leftKeys.length === rightKeys.length && leftKeys.every((key) => isSafeKey(key) && Object.hasOwn(right, key) && isEqual(left[key], right[key]));
-  }
-
-  return false;
-};
-
-export const resolveDatabasePath = (databasePath) => {
-  if (typeof databasePath !== 'string' || databasePath === '') {
-    throw new Error('Укажите путь к JSON-базе данных');
-  }
-
-  return resolve(databasePath);
-};
-
-export const isIdEqual = (left, right) => left != null && right != null && String(left) === String(right);
-export const singularize = (value) => pluralize.singular(value);
-
-export const toPascalCase = (value) =>
-  value
-    .split(/[^a-zA-Z0-9]+/)
-    .filter(Boolean)
-    .map((part) => `${part.charAt(0).toUpperCase()}${part.slice(1)}`)
-    .join('');

package/types/index.d.ts

@@ -1,11 +0,0 @@
-/** @typedef {import('./src/config.js').DeepJsonServerConfig} DeepJsonServerConfig */
-/** @typedef {import('./src/config.js').DatabaseConfig} DatabaseConfig */
-/** @typedef {import('./src/config.js').FilesConfig} FilesConfig */
-/** @typedef {import('./src/config.js').MemoryFile} MemoryFile */
-/** @typedef {import('./src/server.js').OpenapiDocument} OpenapiDocument */
-export type DeepJsonServerConfig = import('./src/config.js').DeepJsonServerConfig;
-export type DatabaseConfig = import('./src/config.js').DatabaseConfig;
-export type FilesConfig = import('./src/config.js').FilesConfig;
-export type MemoryFile = import('./src/config.js').MemoryFile;
-export type OpenapiDocument = import('./src/server.js').OpenapiDocument;
-export { createServer } from './src/server.js';

package/types/src/config.d.ts

@@ -1,86 +0,0 @@
-export type DatabaseData = Record<string, Array<Record<string, unknown>>>;
-export type DatabaseSchema = Record<string, unknown>;
-export type DatabaseConfig = {
-    data: DatabaseData;
-    path?: never;
-    schema?: DatabaseSchema | string;
-} | {
-    data?: never;
-    path: string;
-    schema?: DatabaseSchema | string;
-};
-export type MemoryFile = {
-    content: Uint8Array;
-    id: string;
-    mimeType: string;
-    name: string;
-};
-export type FilesConfig = {
-    data: MemoryFile[];
-    directory?: never;
-    metadata?: never;
-} | {
-    data?: never;
-    directory: string;
-    metadata: string;
-};
-export type DeepJsonServerConfig = {
-    /**
-     * Database source and optional schema.
-     */
-    database: DatabaseConfig;
-    /**
-     * Binary-file storage.
-     */
-    files?: FilesConfig;
-    /**
-     * Generated OpenAPI file.
-     */
-    openapi?: {
-        path?: string;
-    };
-    /**
-     * Runtime settings.
-     */
-    server?: {
-        host?: string;
-        logger?: boolean | Record<string, unknown>;
-        maxFileSize?: number;
-        maxPageSize?: number;
-        port?: number;
-    };
-};
-/**
- * @param {DeepJsonServerConfig} config Server configuration.
- * @param {string} [directoryPath] Base directory for relative paths.
- * @returns {{ database: DatabaseConfig, files?: FilesConfig, openapi: { path?: string }, server: { host?: string, logger?: boolean | Record<string, unknown>, maxFileSize?: number, maxPageSize?: number, port?: number } }} Normalized configuration.
- */
-export declare const normalizeServerConfig: (config: DeepJsonServerConfig, directoryPath?: string) => {
-    database: DatabaseConfig;
-    files?: FilesConfig;
-    openapi: {
-        path?: string;
-    };
-    server: {
-        host?: string;
-        logger?: boolean | Record<string, unknown>;
-        maxFileSize?: number;
-        maxPageSize?: number;
-        port?: number;
-    };
-};
-/** @param {string} configPath Configuration module path. */
-export declare function readServerConfig(configPath: string): Promise<{
-    database: DatabaseConfig;
-    files?: FilesConfig;
-    openapi: {
-        path?: string;
-    };
-    server: {
-        host?: string;
-        logger?: boolean | Record<string, unknown>;
-        maxFileSize?: number;
-        maxPageSize?: number;
-        port?: number;
-    };
-}>;

package/types/src/database.d.ts

@@ -1,11 +0,0 @@
-export declare const validateDatabase: (data: any) => any;
-export declare const readJsonObject: (path: any, label: any) => Promise<any>;
-export declare const readDatabaseFile: (databasePath: any) => Promise<any>;
-/**
- * @param {import('./config.js').DatabaseConfig} config Database source.
- * @returns {Promise<any>} Internal database store.
- */
-export declare const createDatabaseStore: (config: import('./config.js').DatabaseConfig) => Promise<any>;
-export declare const getCollection: (database: any, resource: any) => any[];
-export declare const findItem: (collection: any, id: any) => any;
-export declare const createId: (collection: any) => any;

package/types/src/files.d.ts

@@ -1,24 +0,0 @@
-/** @param {import('./config.js').FilesConfig} config File storage configuration. */
-export declare const createFileStore: (config: import('./config.js').FilesConfig) => Promise<{
-    get: (id: any) => Promise<void>;
-    remove: (id: any) => Promise<void>;
-    upload: ({ maxFileSize, mimeType, name, stream }: {
-        maxFileSize: any;
-        mimeType: any;
-        name: any;
-        stream: any;
-    }) => Promise<void>;
-} | {
-    get: (id: any) => Promise<void>;
-    remove: (id: any) => Promise<void>;
-    upload: ({ maxFileSize, mimeType, name, stream }: {
-        maxFileSize: any;
-        mimeType: any;
-        name: any;
-        stream: any;
-    }) => Promise<void>;
-}>;
-export declare const registerFileRoutes: (server: any, { maxFileSize, store }: {
-    maxFileSize: any;
-    store: any;
-}) => void;

package/types/src/openapi/config.d.ts

@@ -1,3 +0,0 @@
-export declare const validateSchemaConfig: (schemaConfig: any, resources: any) => any;
-export declare const applyConfiguredFields: (schema: any, resource: any, resourceConfig: any) => any;
-export declare const resolveSchemaConfig: (schema: any) => Promise<any>;

package/types/src/openapi/document.d.ts

@@ -1,11 +0,0 @@
-/**
- * Builds an OpenAPI 3.0 document from resolved server data.
- * @param {{ database: Record<string, Array<Record<string, unknown>>>, files?: boolean, maxPageSize?: number, schema?: Record<string, unknown> }} options Document options.
- * @returns {Record<string, unknown>} OpenAPI document.
- */
-export declare function buildOpenapiDocument(options: {
-    database: Record<string, Array<Record<string, unknown>>>;
-    files?: boolean;
-    maxPageSize?: number;
-    schema?: Record<string, unknown>;
-}): Record<string, unknown>;

package/types/src/openapi/index.d.ts

@@ -1,9 +0,0 @@
-export declare const createOpenapi: ({ database, files, host, maxPageSize, port, schema }: {
-    database: any;
-    files: any;
-    host?: string | undefined;
-    maxPageSize: any;
-    port?: number | undefined;
-    schema: any;
-}) => Record<string, unknown>;
-export declare const writeOpenapi: (document: any, outputPath: any) => Promise<void>;

package/types/src/openapi/inference.d.ts

@@ -1,9 +0,0 @@
-export declare const mergeSchemas: (schemas: any) => any;
-export declare const mergeSchemaOverrides: (schema: any, overrides: any) => any;
-export declare const applyRequiredFields: (schema: any, path: any, requiredFields: any) => any;
-export declare const inferSchema: (values: any) => any;
-export declare function inferObjectSchema(values: any): any;
-export declare const ensureGeneratedIdSchema: (schema: any) => any;
-export declare const getSchemasAtPath: (schema: any, keys: any) => any;
-export declare const updateSchemasAtPath: (schema: any, keys: any, update: any) => any;
-export declare const omitId: (schema: any, keepRequired: any) => any;

package/types/src/query/filter.d.ts

@@ -1,3 +0,0 @@
-export declare function matchesWhere(value: any, where: any): any;
-export declare const parseWhere: (query: any) => any;
-export declare const validateWhere: (where: any, items: any, path?: string) => void;

package/types/src/query/pagination.d.ts

@@ -1,8 +0,0 @@
-export declare const parsePagination: (query: any, maxPageSize?: number) => {
-    page: any;
-    pageSize: any;
-};
-export declare const paginateItems: (items: any, page: any, pageSize: any) => {
-    data: any;
-    total: any;
-};

package/types/src/query/sort.d.ts

@@ -1 +0,0 @@
-export declare const sortItems: (items: any, sort: any, validationItems?: any) => any[];

package/types/src/relation-metadata.d.ts

@@ -1,9 +0,0 @@
-export declare const getRelationKeys: (...names: any[]) => string[];
-export declare const resolveRelationResource: (resourceNames: any, relation: any, sourceResource: any) => any;
-export declare const getRelationMetadata: (key: any, resourceNames: any, sourceResource: any) => {
-    isMany: boolean;
-    relationName: any;
-    reverseRelationName: any;
-    sourceResource: any;
-    targetResource: any;
-} | undefined;

package/types/src/relations.d.ts

@@ -1,3 +0,0 @@
-export declare const parseEmbedPaths: (embed: any) => any[];
-export declare const validateEmbedPaths: (database: any, resource: any, items: any, embedPaths: any) => void;
-export declare const embedItem: (database: any, item: any, resource: any, embedPaths: any, indexes?: Map<any, any>) => any;

package/types/src/server.d.ts

@@ -1,13 +0,0 @@
-export type OpenapiDocument = Record<string, unknown>;
-/**
- * Creates a Deep JSON Server facade.
- * @param {import('./config.js').DeepJsonServerConfig} options Server options.
- * @param {{ files?: boolean }} [features] Optional feature switches.
- * @returns {Promise<{ fastify: () => import('fastify').FastifyInstance, openapi: () => Promise<OpenapiDocument> }>} Server facade.
- */
-export declare function createServer(options: import('./config.js').DeepJsonServerConfig, features?: {
-    files?: boolean;
-}): Promise<{
-    fastify: () => import('fastify').FastifyInstance;
-    openapi: () => Promise<OpenapiDocument>;
-}>;

package/types/src/utils.d.ts

@@ -1,10 +0,0 @@
-export declare const createHttpError: (statusCode: any, message: any) => Error;
-export declare const getResourceNames: (data: any) => string[];
-export declare const isObject: (value: any) => boolean;
-export declare const isSafeKey: (key: any) => boolean;
-export declare const toArray: (value: any) => any[];
-export declare const isEqual: (left: any, right: any) => any;
-export declare const resolveDatabasePath: (databasePath: any) => any;
-export declare const isIdEqual: (left: any, right: any) => boolean;
-export declare const singularize: (value: any) => any;
-export declare const toPascalCase: (value: any) => any;