@kollors/deep-json-server 0.9.0 → 1.0.0-alpha.10

package/dist/src/core/lifecycle/options.d.ts

@@ -0,0 +1,21 @@
+export interface RecordOptions {
+    timestamps?: boolean;
+    softDelete?: boolean;
+    auth?: boolean;
+}
+export interface Actor {
+    id: string;
+    isAdmin?: boolean;
+}
+export type ActorSource = Actor | (() => Actor);
+export type Authenticate = (authorization: unknown) => Actor;
+export declare const DELETION_META = "djsDeletion";
+export declare const AUDIT_FIELDS: readonly ['createdAt', 'updatedAt', 'deletedAt', 'createdById', 'updatedById', 'deletedById'];
+/** Проверяет логические флаги и заменяет отсутствующие значения на false.
+ * @example recordOptions({ softDelete: true }) → { timestamps: false, softDelete: true, auth: false }.
+ */
+export declare function recordOptions(options?: RecordOptions): Required<RecordOptions>;
+/** Ищет условие deletedAt на текущем уровне и в логических ветках, не заходя в поля связанных объектов.
+ * @example mentionsDeletedAt({ or: [{ deletedAt: { ne: null } }] }) → true; { user: { deletedAt: {} } } → false.
+ */
+export declare function mentionsDeletedAt(where: unknown): boolean;

package/dist/src/core/lifecycle/options.js

@@ -0,0 +1,19 @@
+import { getBoolean } from '../config-values.js';
+import { isObject } from '../utils.js';
+export const DELETION_META = 'djsDeletion';
+export const AUDIT_FIELDS = ['createdAt', 'updatedAt', 'deletedAt', 'createdById', 'updatedById', 'deletedById'];
+/** Проверяет логические флаги и заменяет отсутствующие значения на false.
+ * @example recordOptions({ softDelete: true }) → { timestamps: false, softDelete: true, auth: false }.
+ */
+export function recordOptions(options = {}) {
+    return { timestamps: getBoolean(options.timestamps, 'timestamps') ?? false, softDelete: getBoolean(options.softDelete, 'softDelete') ?? false, auth: getBoolean(options.auth, 'auth') ?? false };
+}
+/** Ищет условие deletedAt на текущем уровне и в логических ветках, не заходя в поля связанных объектов.
+ * @example mentionsDeletedAt({ or: [{ deletedAt: { ne: null } }] }) → true; { user: { deletedAt: {} } } → false.
+ */
+export function mentionsDeletedAt(where) {
+    if (!isObject(where))
+        return false;
+    return Object.hasOwn(where, 'deletedAt') || ['and', 'or'].some((key) => Array.isArray(where[key]) && where[key].some(mentionsDeletedAt)) || mentionsDeletedAt(where.not);
+}
+//# sourceMappingURL=options.js.map

package/dist/src/core/lifecycle/options.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"options.js","sourceRoot":"","sources":["../../../../src/core/lifecycle/options.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjD,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAavC,MAAM,CAAC,MAAM,aAAa,GAAG,aAAa,CAAC;AAC3C,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,WAAW,EAAE,WAAW,EAAE,WAAW,EAAE,aAAa,EAAE,aAAa,EAAE,aAAa,CAAU,CAAC;AAC1H;;GAEG;AACH,MAAM,UAAU,aAAa,CAAC,OAAO,GAAkB,EAAE;IACvD,OAAO,EAAE,UAAU,EAAE,UAAU,CAAC,OAAO,CAAC,UAAU,EAAE,YAAY,CAAC,IAAI,KAAK,EAAE,UAAU,EAAE,UAAU,CAAC,OAAO,CAAC,UAAU,EAAE,YAAY,CAAC,IAAI,KAAK,EAAE,IAAI,EAAE,UAAU,CAAC,OAAO,CAAC,IAAI,EAAE,MAAM,CAAC,IAAI,KAAK,EAAE,CAAC;AACnM,CAAC;AACD;;GAEG;AACH,MAAM,UAAU,iBAAiB,CAAC,KAAc;IAC9C,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC;QAAE,OAAO,KAAK,CAAC;IACnC,OAAO,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,WAAW,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC,IAAI,iBAAiB,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;AAC3K,CAAC"}

package/dist/src/core/model.d.ts

@@ -0,0 +1,145 @@
+import { type RecordOptions } from './lifecycle/options.js';
+import type { WriteMode } from './operations.js';
+import type { DatabaseData, JsonValue } from './types.js';
+export interface Field {
+    type: string;
+    description?: string;
+    example?: JsonValue;
+    required?: boolean;
+    nullable?: boolean;
+    default?: JsonValue;
+    enum?: JsonValue[];
+    primary?: boolean;
+    generated?: 'uuid' | 'increment';
+    readOnly?: boolean;
+    writeOnly?: boolean;
+    minLength?: number;
+    maxLength?: number;
+    pattern?: string;
+    format?: 'date' | 'date-time' | 'email' | 'uri' | 'uuid';
+    minimum?: number;
+    maximum?: number;
+    source?: string;
+    target?: string;
+    onDelete?: 'restrict' | 'cascade';
+}
+export interface EntityDefinition {
+    timestamps?: boolean;
+    softDelete?: boolean;
+    collection: string;
+    api?: ('openapi' | 'graphql')[];
+    fields: Record<string, Field>;
+}
+export type ApiFormat = 'openapi' | 'graphql';
+export interface ModelSchema {
+    models: Record<string, EntityDefinition>;
+    api?: ApiFormat[];
+    timestamps?: boolean;
+    softDelete?: boolean;
+}
+export interface ModelOptions {
+    auth?: boolean;
+    api?: ApiFormat[];
+}
+/** Проверяет список форматов и возвращает его независимую копию.
+ * @example apiFormats(['graphql']) → ['graphql']; ['unknown'] → ошибка.
+ */
+export declare function apiFormats(value: unknown, fallback: ApiFormat[], label: string): ApiFormat[];
+export interface Node extends Field {
+    system?: boolean;
+    internal?: boolean;
+    softDelete?: boolean;
+    path: string;
+    base: string;
+    many: boolean;
+    children: Record<string, Node>;
+    relation?: Entity;
+    implicit?: boolean;
+    mixed?: boolean;
+    relationKey?: boolean;
+}
+export interface Entity {
+    timestamps: boolean;
+    softDelete: boolean;
+    name: string;
+    collection: string;
+    api: ('openapi' | 'graphql')[];
+    primary: string;
+    fields: Record<string, Node>;
+    root: Node;
+}
+export interface Model {
+    options: Required<RecordOptions>;
+    entities: Entity[];
+    byName: Map<string, Entity>;
+    byCollection: Map<string, Entity>;
+    explicit: boolean;
+}
+export type ValidationSchema = Record<string, unknown>;
+/** Разбивает путь по точкам и проверяет допустимость каждого имени.
+ * @example pathParts('profile.name') → ['profile', 'name']; pathParts('a..b') → ошибка.
+ */
+export declare const pathParts: (path: string) => string[];
+/** Находит самый длинный префикс пути среди ключей объекта, учитывая границы сегментов.
+ * @example bindingFor({ a: {}, 'a.b': {} }, 'a.b.id') → 'a.b'; bindingFor({ a: {} }, 'abc.id') → undefined.
+ */
+export declare function bindingFor(bindings: Record<string, unknown>, path: string): string | undefined;
+/** Проверяет, что все сегменты пути объявлены и доступны для записи, включая родительские объекты.
+ * @example Для поля name без ограничений canWriteKey(entity, 'name') → true; для первичного ключа → false.
+ */
+export declare function canWriteKey(entity: Entity, path: string): boolean;
+/** Распознаёт обратную связь: источник совпадает с первичным ключом, а целевой путь отличается от первичного ключа цели.
+ * @example При source = 'id', target = 'authorId' и первичных ключах id → true.
+ */
+export declare function isReverseRelation(entity: Entity, node: Node): boolean;
+/** Собирает значения по вложенному пути, проходя через массивы; отсутствующие значения и null пропускает.
+ * @example readPath({ rows: [{ id: 1 }, { id: 2 }] }, 'rows.id') → [1, 2].
+ */
+export declare const readPath: (value: unknown, path: string | string[]) => unknown[];
+/** Возвращает последний сегмент пути поля.
+ * @example childName({ path: 'profile.name', … }) → 'name'.
+ */
+export declare const childName: (node: Node) => string;
+/** Для связи возвращает целевую сущность и её корень; обычный узел сохраняет без изменений.
+ * @example canonicalNode(author, { relation: book }) → [book, book.root].
+ * @example canonicalNode(author, author.root) → [author, author.root].
+ */
+export declare const canonicalNode: (entity: Entity, node: Node) => [Entity, Node];
+/** Соединяет имя сущности и путь поля, заменяя точки подчёркиваниями.
+ * @example nodeName({ name: 'User', … }, { path: 'profile.name', … }) → 'User_profile_name'.
+ */
+export declare const nodeName: (entity: Entity, node: Node) => string;
+/** Переводит первую букву имени сущности в нижний регистр.
+ * @example operationName({ name: 'UserProfile', … }) → 'userProfile'.
+ */
+export declare const operationName: (entity: Entity) => string;
+/** Загружает описание из объекта или JSON-файла, проверяет поля и сопоставляет связи.
+ * @example loadModel(undefined) → Promise<undefined>; корректное описание → Promise<Model>.
+ */
+export declare function loadModel(source: unknown, settings?: ModelOptions): Promise<Model | undefined>;
+/** Определяет доступность поля для выбранного режима записи, учитывая защищённые дочерние поля.
+ * @example writable({ readOnly: true, … }, 'update') → false.
+ */
+export declare function writable(node: Node, mode: InputMode, relations?: boolean): boolean;
+/** Проверяет наличие явной модели и доступность выбранного формата для её связей.
+ * @example assertApi(undefined, 'graphql') → ошибка; согласованная модель → undefined.
+ */
+export declare function assertApi(model: Model | undefined, api: 'graphql' | 'openapi'): asserts model is Model;
+/** Строит схему проверки значения с ограничениями, массивом и допустимостью null.
+ * @example Для строкового узла без ограничений valueSchema(node) → { type: 'string' }.
+ */
+export declare function valueSchema(node: Node): ValidationSchema;
+export type InputMode = 'stored' | WriteMode;
+/** Строит схему объекта для выбранного режима; при частичном обновлении корневые поля необязательны.
+ * @example Для пустого узла → { type: 'object', properties: {}, additionalProperties: false }.
+ */
+export declare function objectSchema(node: Node, mode: InputMode, root?: boolean, relationSchema?: (node: Node) => ValidationSchema): ValidationSchema;
+export declare function relationInputSchema(node: Node, object?: ValidationSchema): ValidationSchema;
+/** Проверяет запись по схеме выбранного режима и выбрасывает исключение при несоответствии.
+ * @example Обязательное строковое name: { name: 'Анна' } → undefined; { name: 2 } → ошибка.
+ */
+export declare function validateRecord(entity: Entity, value: unknown, mode: InputMode, relations?: boolean): void;
+/** Выводит поля и связи из значений коллекций, не меняя переданные записи.
+ * @example inferModel({ users: [{ id: '1', name: 'Анна' }] }) → модель со строковыми id и name.
+ */
+export declare function inferModel(database: DatabaseData, settings?: RecordOptions): Model;