@quark-fw/entity 0.1.7 → 0.1.8

package/dist/index.js

@@ -1,310 +1 @@
-import { TRPCError } from "@trpc/server";
-import { z } from "zod";
-import { publicProcedure, router, } from "@quark-fw/plugin-trpc/src/trpc.js";
-const invoke = (m, data) => typeof m === "function" ? m(data) : m.handler(m.input.parse(data));
-// Сериализуемая сортировка: orderBy в Prisma 8 принимает СЕЛЕКТОР-функцию
-// (f) => f.field.asc(), поэтому по сети передаём {field, dir}, а функцию
-// собираем на сервере. Одно поле: цепочка/массив билдером не поддержаны.
-export const sortSchema = z.object({
-    field: z.string(),
-    dir: z.enum(["asc", "desc"]).default("asc"),
-});
-const listSchema = z.object({
-    where: z.record(z.string(), z.any()).optional(),
-    page: z.number().int().min(1).default(1),
-    limit: z.number().int().min(1).max(100).default(20),
-    sort: sortSchema.optional(),
-    /** поиск по подстроке; поле задаётся в createEntity (searchField) */
-    search: z.string().optional(),
-});
-/**
- * Модели контракта.
- *
- * Тип `quark.db` объявляет само приложение (аугментация Quark), поэтому
- * пакету он не виден — но форма, на которую пакет опирается, известна и
- * описана здесь. Заодно ловим ненастроенный prisma-плагин внятной ошибкой
- * вместо `Cannot read properties of undefined`.
- */
-const ormModels = () => {
-    const { db } = quark;
-    const models = db?.orm?.public;
-    if (!models) {
-        throw new Error("@quark-fw/entity: quark.db.orm.public недоступен — не подключён @quark/plugin-prisma?");
-    }
-    return models;
-};
-const modelByName = (name) => {
-    const model = ormModels()[name];
-    if (!model) {
-        throw new Error(`@quark-fw/entity: модели "${name}" нет в контракте`);
-    }
-    return model;
-};
-/**
- * Сущность поверх модели контракта.
- *
- * Тип строки берётся из самой модели по её имени, поэтому дженерик передавать
- * не нужно: `createEntity({ model: "Task", ... })`. Имена полей —
- * владельца, сортировки, поиска и связей — проверяются против этой модели.
- */
-export function createEntity(args) {
-    // в конфиге направление необязательно, схема сортировки требует его явно
-    const fallbackSort = args.defaultSort && {
-        field: args.defaultSort.field,
-        dir: args.defaultSort.dir ?? "asc",
-    };
-    // лениво: quark.db появляется после init prisma-плагина
-    const getModel = () => modelByName(args.model);
-    const chain = (where) => {
-        let q = getModel();
-        if (where && Object.keys(where).length)
-            q = q.where(where);
-        return q;
-    };
-    // {field, dir} -> селектор Prisma 8. Не все типы полей сортируемы
-    // (у boolean, например, нет asc/desc) — отвечаем понятной ошибкой.
-    const applySort = (q, sort) => {
-        if (!sort)
-            return q;
-        return q.orderBy((fields) => {
-            const direction = fields?.[sort.field]?.[sort.dir];
-            if (typeof direction !== "function") {
-                throw new TRPCError({
-                    code: "BAD_REQUEST",
-                    message: `Field "${sort.field}" of ${args.model} is not sortable`,
-                });
-            }
-            return direction.call(fields[sort.field]);
-        });
-    };
-    /**
-     * Поиск по подстроке, без учёта регистра (ilike).
-     *
-     * Условие добавляется отдельным where — они складываются по И, поэтому
-     * скоуп владельца и фильтры остаются в силе.
-     */
-    const applySearch = (q, search) => {
-        const term = search?.trim();
-        if (!term || !args.searchField)
-            return q;
-        // % и _ — служебные символы шаблона; экранируем, чтобы «50%» искалось
-        // как текст, а не как «что угодно после 50»
-        const escaped = term.replace(/[\\%_]/g, "\\$&");
-        return q.where((fields) => {
-            const field = fields?.[args.searchField];
-            const ilike = field?.ilike;
-            if (typeof ilike !== "function") {
-                throw new TRPCError({
-                    code: "BAD_REQUEST",
-                    message: `Field "${args.searchField}" of ${args.model} is not searchable`,
-                });
-            }
-            return ilike.call(field, `%${escaped}%`);
-        });
-    };
-    const baseController = (row) => ({
-        update: (data) => chain({ id: row.id }).update(data),
-        delete: () => chain({ id: row.id }).delete(),
-    });
-    const buildController = (row) => ({
-        ...baseController(row),
-        ...(args.extendController?.({ entity: row }) ?? {}),
-    });
-    const withController = (row) => {
-        if (!row || typeof row !== "object")
-            return row;
-        return Object.assign(row, buildController(row));
-    };
-    const methods = {
-        list: async (input) => {
-            const { where, page, limit, sort, search } = listSchema.parse(input ?? {});
-            const rows = (await applySort(applySearch(chain(where), search), sort ?? fallbackSort)
-                .skip(limit * (page - 1))
-                .take(limit)
-                .all());
-            return rows.map(withController);
-        },
-        getById: async (id) => withController((await chain({ id }).first())),
-        /** как getById, но по произвольному where (используется для скоупинга) */
-        getOne: async (where) => withController((await chain(where).first())),
-        create: async (data) => withController((await getModel().create(data))),
-        update: async (id, data) => withController((await chain({ id }).update(data))),
-        // Prisma 8 при непопадании во where возвращает null, а не бросает.
-        // Молчаливый null скрыл бы и опечатку в id, и попытку тронуть чужую
-        // запись — отвечаем NOT_FOUND (существование чужой не подтверждаем).
-        updateWhere: async (where, data) => {
-            const row = (await chain(where).update(data));
-            if (!row) {
-                throw new TRPCError({
-                    code: "NOT_FOUND",
-                    message: `${args.model} not found`,
-                });
-            }
-            return withController(row);
-        },
-        deleteById: (id) => chain({ id }).delete(),
-        deleteWhere: async (where) => {
-            const row = await chain(where).delete();
-            if (!row) {
-                throw new TRPCError({
-                    code: "NOT_FOUND",
-                    message: `${args.model} not found`,
-                });
-            }
-            return row;
-        },
-        // count() билдера доступен только внутри include-рефайнментов —
-        // счёт делается через aggregate
-        count: async (where) => {
-            const { n } = (await chain(where).aggregate((a) => ({
-                n: a.count(),
-            })));
-            return n;
-        },
-    };
-    const createRouter = () => {
-        const proc = args.procedure ?? publicProcedure;
-        // TRPCUser — пустой интерфейс-шов, его поля объявляет плагин
-        // авторизации, поэтому id читаем структурно
-        const ownerId = (ctx) => ctx.user?.id;
-        // where-скоуп владельца: {} если authField не задан
-        const scope = (ctx) => args.authField ? { [args.authField]: ownerId(ctx) } : {};
-        /**
-         * Убирает из присланных данных поля, которые клиент задавать не вправе.
-         *
-         * Колонка владельца проставляется только из контекста. Иначе владельца
-         * можно переписать на чужого: скоуп во where проверяет, что ЭТА запись
-         * твоя, но не мешает после этого отдать её другому — так в чужой
-         * аккаунт подкладывается запись.
-         *
-         * id при обновлении тоже не принимаем: подмена первичного ключа рвёт
-         * ссылки на запись и не имеет смысла как операция.
-         */
-        const stripProtected = (data, also = []) => {
-            const clean = { ...data };
-            if (args.authField)
-                delete clean[args.authField];
-            for (const field of also)
-                delete clean[field];
-            return clean;
-        };
-        // порт checkRelation: записать ссылку на родителя можно, только если
-        // этот родитель принадлежит вызывающему (иначе чужой id «подсунули»)
-        const checkRelations = async (data, ctx) => {
-            for (const relation of args.relations ?? []) {
-                const value = data[relation.field];
-                if (value === undefined || value === null)
-                    continue;
-                const parent = await modelByName(relation.model)
-                    .where({
-                    [relation.parentField ?? "id"]: value,
-                    [relation.authField]: ownerId(ctx),
-                })
-                    .first();
-                if (!parent) {
-                    // NOT_FOUND, а не FORBIDDEN: не подтверждаем существование
-                    // чужой записи
-                    throw new TRPCError({
-                        code: "NOT_FOUND",
-                        message: `${relation.model} ${String(value)} not found`,
-                    });
-                }
-            }
-        };
-        const custom = args.extendMethods?.({ model: getModel() }) ?? {};
-        const customProcedures = Object.fromEntries(Object.entries(custom).map(([name, m]) => [
-            name,
-            typeof m === "function"
-                ? proc
-                    .input(z.any().optional())
-                    .mutation(({ input }) => m(input))
-                : proc
-                    .input(m.input)
-                    .mutation(({ input }) => m.handler(input)),
-        ]));
-        return router({
-            ...customProcedures,
-            list: proc.input(listSchema.optional()).mutation(({ input, ctx }) => methods.list({
-                ...(input ?? {}),
-                where: { ...(input?.where ?? {}), ...scope(ctx) },
-            })),
-            getById: proc
-                .input(z.string())
-                .mutation(({ input, ctx }) => methods.getOne({ id: input, ...scope(ctx) })),
-            create: proc
-                .input(z.object({ data: z.record(z.string(), z.any()) }))
-                .mutation(async ({ input, ctx }) => {
-                const data = stripProtected(input.data);
-                await checkRelations(data, ctx);
-                return methods.create({ ...data, ...scope(ctx) });
-            }),
-            update: proc
-                .input(z.object({
-                id: z.string(),
-                data: z.record(z.string(), z.any()),
-            }))
-                .mutation(async ({ input, ctx }) => {
-                const data = stripProtected(input.data, ["id"]);
-                await checkRelations(data, ctx);
-                // скоуп во where: чужую запись обновить нельзя
-                const where = { id: input.id, ...scope(ctx) };
-                // после отсева могло не остаться ни одного поля —
-                // отвечаем самой записью, а не ложным NOT_FOUND
-                if (!Object.keys(data).length) {
-                    const row = await methods.getOne(where);
-                    if (!row) {
-                        throw new TRPCError({
-                            code: "NOT_FOUND",
-                            message: `${args.model} not found`,
-                        });
-                    }
-                    return row;
-                }
-                return methods.updateWhere(where, data);
-            }),
-            delete: proc
-                .input(z.object({ id: z.string() }))
-                .mutation(({ input, ctx }) => methods.deleteWhere({ id: input.id, ...scope(ctx) })),
-            count: proc
-                .input(z
-                .object({
-                where: z.record(z.string(), z.any()).optional(),
-            })
-                .optional())
-                .mutation(({ input, ctx }) => methods.count({ ...(input?.where ?? {}), ...scope(ctx) })),
-            controller: proc
-                .input(z.object({
-                id: z.string(),
-                method: z.string(),
-                data: z.any().optional(),
-            }))
-                .mutation(async ({ input, ctx }) => {
-                const row = (await chain({
-                    id: input.id,
-                    ...scope(ctx),
-                }).first());
-                if (!row)
-                    throw new TRPCError({ code: "NOT_FOUND" });
-                const controller = buildController(row);
-                // Только собственные методы контроллера: без этой проверки
-                // имя вроде "constructor" или "toString" дотягивается до
-                // прототипа объекта и вызывается как метод сущности.
-                const method = Object.hasOwn(controller, input.method)
-                    ? controller[input.method]
-                    : undefined;
-                if (!method)
-                    throw new TRPCError({
-                        code: "BAD_REQUEST",
-                        message: `Method ${input.method} not found on ${args.model}`,
-                    });
-                return invoke(method, input.data);
-            }),
-        });
-    };
-    return {
-        modelName: args.model,
-        getModel,
-        methods,
-        createRouter,
-    };
-}
+export { createEntity, sortSchema, } from "./createEntity.js";

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@quark-fw/entity",
-	"version": "0.1.7",
+	"version": "0.1.8",
 	"description": "Entity CRUD layer over tRPC and Prisma for the Quark framework",
 	"type": "module",
 	"main": "dist/index.js",
@@ -30,13 +30,13 @@
 		"access": "public"
 	},
 	"dependencies": {
-		"@quark-fw/plugin-trpc": "0.1.7",
-		"@quark-fw/store": "0.1.7",
+		"@quark-fw/plugin-trpc": "0.1.8",
+		"@quark-fw/store": "0.1.8",
 		"@trpc/server": "^11.0.0",
 		"zod": "^4.0.0"
 	},
 	"peerDependencies": {
-		"@quark-fw/core": "0.1.7",
+		"@quark-fw/core": "0.1.8",
 		"react": "^19.2.4"
 	},
 	"devDependencies": {