@venizia/ignis-kernel 0.4.3 → 0.4.4

package/dist/cjs/base/controllers/factory/crud/readable.js

@@ -1,118 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ReadableCrudController = void 0;
-const common_1 = require("@venizia/ignis-helpers/common");
-const abstract_1 = require("./abstract");
-const common_2 = require("../../common");
-/** The one combination point of a base where and a request where; without a request side there is no `and` wrapper. */
-const withBaseWhere = (opts) => {
-    const { baseWhere, where } = opts;
-    if (!where) {
-        return baseWhere;
-    }
-    // `Pick` resolves the one key: a literal cannot be checked against `TWhere` over an unresolved type parameter.
-    const scoped = { and: [baseWhere, where] };
-    return scoped;
-};
-/** `id` is the primary key every entity family reads by; built at the default `TWhere` for the same unresolved-parameter reason. */
-const whereById = (opts) => {
-    const where = { id: opts.id };
-    return where;
-};
-/** Read tier: count / find / findById / findOne. Read-only controllers can extend this directly. */
-class ReadableCrudController extends abstract_1.AbstractCrudController {
-    /** Narrows EVERY read of this controller - override it to scope rows to a tenant, an owner or a status. Public because a generated controller's declaration cannot carry a protected member (TS4094). */
-    async getBaseWhere(_opts) {
-        return undefined;
-    }
-    /** GET /count */
-    async count(opts) {
-        const { context } = opts;
-        const { where } = context.req.valid('query');
-        const baseWhere = await this.getBaseWhere({ context });
-        const scopedWhere = baseWhere ? withBaseWhere({ baseWhere, where }) : where;
-        const rs = await this.measure({
-            scope: 'count',
-            args: { where: scopedWhere },
-            task: () => this.repository.count({ where: scopedWhere }),
-        });
-        return context.json(rs, common_1.HTTP.ResultCodes.RS_2.Ok);
-    }
-    /** GET / - paginated list with a Content-Range header. */
-    async find(opts) {
-        const { context } = opts;
-        const { filter = {} } = context.req.valid('query');
-        const baseWhere = await this.getBaseWhere({ context });
-        const scopedFilter = baseWhere
-            ? { ...filter, where: withBaseWhere({ baseWhere, where: filter.where }) }
-            : filter;
-        const rs = await this.measure({
-            scope: 'find',
-            args: scopedFilter,
-            task: async () => {
-                const { data, range } = await this.repository.find({
-                    filter: scopedFilter,
-                    options: { shouldQueryRange: true },
-                });
-                return this.respond({
-                    context,
-                    format: common_2.ResponseFormats.ARRAY,
-                    payload: { count: data.length, data },
-                    range,
-                });
-            },
-        });
-        return context.json(rs, common_1.HTTP.ResultCodes.RS_2.Ok);
-    }
-    /** GET /:id */
-    async findById(opts) {
-        const { context } = opts;
-        const { id } = context.req.valid('param');
-        const { filter } = context.req.valid('query');
-        const baseWhere = await this.getBaseWhere({ context });
-        // `repository.findById` takes no where, so a scoped read goes through `findOne` - the same
-        // substrate every family's findById delegates to - and answers null on an out-of-scope id.
-        const scopedWhere = baseWhere
-            ? withBaseWhere({ baseWhere, where: whereById({ id }) })
-            : undefined;
-        const rs = await this.measure({
-            scope: 'findById',
-            args: filter,
-            task: async () => {
-                const record = scopedWhere
-                    ? await this.repository.findOne({ filter: { ...filter, where: scopedWhere } })
-                    : await this.repository.findById({ id, filter });
-                return this.respond({
-                    context,
-                    format: common_2.ResponseFormats.OBJECT,
-                    payload: { count: record ? 1 : 0, data: record },
-                });
-            },
-        });
-        return context.json(rs, common_1.HTTP.ResultCodes.RS_2.Ok);
-    }
-    /** GET /find-one */
-    async findOne(opts) {
-        const { context } = opts;
-        const { filter = {} } = context.req.valid('query');
-        const baseWhere = await this.getBaseWhere({ context });
-        const scopedFilter = baseWhere
-            ? { ...filter, where: withBaseWhere({ baseWhere, where: filter.where }) }
-            : filter;
-        const rs = await this.measure({
-            scope: 'findOne',
-            args: scopedFilter,
-            task: async () => {
-                const record = await this.repository.findOne({ filter: scopedFilter });
-                return this.respond({
-                    context,
-                    format: common_2.ResponseFormats.OBJECT,
-                    payload: { count: record ? 1 : 0, data: record },
-                });
-            },
-        });
-        return context.json(rs, common_1.HTTP.ResultCodes.RS_2.Ok);
-    }
-}
-exports.ReadableCrudController = ReadableCrudController;
-//# sourceMappingURL=readable.js.map

package/dist/cjs/base/controllers/factory/crud/readable.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"readable.js","sourceRoot":"","sources":["../../../../../../src/base/controllers/factory/crud/readable.ts"],"names":[],"mappings":";;;AAGA,0DAAqD;AAGrD,yCAAoD;AACpD,yCAA+C;AAE/C,uHAAuH;AACvH,MAAM,aAAa,GAAG,CAA6B,IAGlD,EAAuB,EAAE;IACxB,MAAM,EAAE,SAAS,EAAE,KAAK,EAAE,GAAG,IAAI,CAAC;IAElC,IAAI,CAAC,KAAK,EAAE,CAAC;QACX,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,+GAA+G;IAC/G,MAAM,MAAM,GAAqC,EAAE,GAAG,EAAE,CAAC,SAAS,EAAE,KAAK,CAAC,EAAE,CAAC;IAC7E,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC;AAEF,oIAAoI;AACpI,MAAM,SAAS,GAAG,CAA6B,IAAoB,EAAuB,EAAE;IAC1F,MAAM,KAAK,GAAW,EAAE,EAAE,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC;IACtC,OAAO,KAAK,CAAC;AACf,CAAC,CAAC;AAEF,oGAAoG;AACpG,MAAsB,sBAQpB,SAAQ,iCAQT;IACC,yMAAyM;IACzM,KAAK,CAAC,YAAY,CAAC,KAElB;QACC,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,iBAAiB;IACjB,KAAK,CAAC,KAAK,CAAC,IAA0C;QACpD,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC;QACzB,MAAM,EAAE,KAAK,EAAE,GAAG,OAAO,CAAC,GAAG,CAAC,KAAK,CAAiC,OAAO,CAAC,CAAC;QAC7E,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,YAAY,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC;QACvD,MAAM,WAAW,GAAG,SAAS,CAAC,CAAC,CAAC,aAAa,CAAC,EAAE,SAAS,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;QAE5E,MAAM,EAAE,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC;YAC5B,KAAK,EAAE,OAAO;YACd,IAAI,EAAE,EAAE,KAAK,EAAE,WAAW,EAAE;YAC5B,IAAI,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,EAAE,KAAK,EAAE,WAAW,EAAE,CAAC;SAC1D,CAAC,CAAC;QAEH,OAAO,OAAO,CAAC,IAAI,CAAC,EAAE,EAAE,aAAI,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACpD,CAAC;IAED,0DAA0D;IAC1D,KAAK,CAAC,IAAI,CAAC,IAA0C;QACnD,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC;QACzB,MAAM,EAAE,MAAM,GAAG,EAAE,EAAE,GAAG,OAAO,CAAC,GAAG,CAAC,KAAK,CAAoC,OAAO,CAAC,CAAC;QACtF,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,YAAY,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC;QACvD,MAAM,YAAY,GAAG,SAAS;YAC5B,CAAC,CAAC,EAAE,GAAG,MAAM,EAAE,KAAK,EAAE,aAAa,CAAC,EAAE,SAAS,EAAE,KAAK,EAAE,MAAM,CAAC,KAAK,EAAE,CAAC,EAAE;YACzE,CAAC,CAAC,MAAM,CAAC;QAEX,MAAM,EAAE,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC;YAC5B,KAAK,EAAE,MAAM;YACb,IAAI,EAAE,YAAY;YAClB,IAAI,EAAE,KAAK,IAAI,EAAE;gBACf,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC;oBACjD,MAAM,EAAE,YAAY;oBACpB,OAAO,EAAE,EAAE,gBAAgB,EAAE,IAAI,EAAE;iBACpC,CAAC,CAAC;gBAEH,OAAO,IAAI,CAAC,OAAO,CAAqB;oBACtC,OAAO;oBACP,MAAM,EAAE,wBAAe,CAAC,KAAK;oBAC7B,OAAO,EAAE,EAAE,KAAK,EAAE,IAAI,CAAC,MAAM,EAAE,IAAI,EAAE;oBACrC,KAAK;iBACN,CAAC,CAAC;YACL,CAAC;SACF,CAAC,CAAC;QAEH,OAAO,OAAO,CAAC,IAAI,CAAC,EAAE,EAAE,aAAI,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACpD,CAAC;IAED,eAAe;IACf,KAAK,CAAC,QAAQ,CAAC,IAA0C;QACvD,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC;QACzB,MAAM,EAAE,EAAE,EAAE,GAAG,OAAO,CAAC,GAAG,CAAC,KAAK,CAAiB,OAAO,CAAC,CAAC;QAC1D,MAAM,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,GAAG,CAAC,KAAK,CAAmD,OAAO,CAAC,CAAC;QAChG,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,YAAY,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC;QAEvD,2FAA2F;QAC3F,2FAA2F;QAC3F,MAAM,WAAW,GAAG,SAAS;YAC3B,CAAC,CAAC,aAAa,CAAC,EAAE,SAAS,EAAE,KAAK,EAAE,SAAS,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC;YACxD,CAAC,CAAC,SAAS,CAAC;QAEd,MAAM,EAAE,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC;YAC5B,KAAK,EAAE,UAAU;YACjB,IAAI,EAAE,MAAM;YACZ,IAAI,EAAE,KAAK,IAAI,EAAE;gBACf,MAAM,MAAM,GAAG,WAAW;oBACxB,CAAC,CAAC,MAAM,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE,EAAE,GAAG,MAAM,EAAE,KAAK,EAAE,WAAW,EAAE,EAAE,CAAC;oBAC9E,CAAC,CAAC,MAAM,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;gBAEnD,OAAO,IAAI,CAAC,OAAO,CAAc;oBAC/B,OAAO;oBACP,MAAM,EAAE,wBAAe,CAAC,MAAM;oBAC9B,OAAO,EAAE,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE;iBACjD,CAAC,CAAC;YACL,CAAC;SACF,CAAC,CAAC;QAEH,OAAO,OAAO,CAAC,IAAI,CAAC,EAAE,EAAE,aAAI,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACpD,CAAC;IAED,oBAAoB;IACpB,KAAK,CAAC,OAAO,CAAC,IAA0C;QACtD,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC;QACzB,MAAM,EAAE,MAAM,GAAG,EAAE,EAAE,GAAG,OAAO,CAAC,GAAG,CAAC,KAAK,CAAoC,OAAO,CAAC,CAAC;QACtF,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,YAAY,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC;QACvD,MAAM,YAAY,GAAG,SAAS;YAC5B,CAAC,CAAC,EAAE,GAAG,MAAM,EAAE,KAAK,EAAE,aAAa,CAAC,EAAE,SAAS,EAAE,KAAK,EAAE,MAAM,CAAC,KAAK,EAAE,CAAC,EAAE;YACzE,CAAC,CAAC,MAAM,CAAC;QAEX,MAAM,EAAE,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC;YAC5B,KAAK,EAAE,SAAS;YAChB,IAAI,EAAE,YAAY;YAClB,IAAI,EAAE,KAAK,IAAI,EAAE;gBACf,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE,YAAY,EAAE,CAAC,CAAC;gBACvE,OAAO,IAAI,CAAC,OAAO,CAAc;oBAC/B,OAAO;oBACP,MAAM,EAAE,wBAAe,CAAC,MAAM;oBAC9B,OAAO,EAAE,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE;iBACjD,CAAC,CAAC;YACL,CAAC;SACF,CAAC,CAAC;QAEH,OAAO,OAAO,CAAC,IAAI,CAAC,EAAE,EAAE,aAAI,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACpD,CAAC;CACF;AA9HD,wDA8HC","sourcesContent":["import type { AbstractEntity, IdType } from '@/base/models';\nimport type { TFilter, TWhere } from '@venizia/ignis-filter';\nimport type { TAnyObjectSchema } from '@/base/controllers/common/schema-builders';\nimport { HTTP } from '@venizia/ignis-helpers/common';\nimport type { Env, Schema } from 'hono';\nimport type { TEntityDataObject, TEntityPersistObject, TRouteContext } from '../../common';\nimport { AbstractCrudController } from './abstract';\nimport { ResponseFormats } from '../../common';\n\n/** The one combination point of a base where and a request where; without a request side there is no `and` wrapper. */\nconst withBaseWhere = <TDataObject extends object>(opts: {\n  baseWhere: TWhere<TDataObject>;\n  where?: TWhere<TDataObject>;\n}): TWhere<TDataObject> => {\n  const { baseWhere, where } = opts;\n\n  if (!where) {\n    return baseWhere;\n  }\n\n  // `Pick` resolves the one key: a literal cannot be checked against `TWhere` over an unresolved type parameter.\n  const scoped: Pick<TWhere<TDataObject>, 'and'> = { and: [baseWhere, where] };\n  return scoped;\n};\n\n/** `id` is the primary key every entity family reads by; built at the default `TWhere` for the same unresolved-parameter reason. */\nconst whereById = <TDataObject extends object>(opts: { id: IdType }): TWhere<TDataObject> => {\n  const where: TWhere = { id: opts.id };\n  return where;\n};\n\n/** Read tier: count / find / findById / findOne. Read-only controllers can extend this directly. */\nexport abstract class ReadableCrudController<\n  TEntity extends AbstractEntity<TAnyObjectSchema> = AbstractEntity<TAnyObjectSchema>,\n  RouteEnv extends Env = Env,\n  RouteSchema extends Schema = {},\n  BasePath extends string = '/',\n  ConfigurableOptions extends object = {},\n  TDataObject extends object = TEntityDataObject<TEntity>,\n  TPersistObject extends object = TEntityPersistObject<TEntity>,\n> extends AbstractCrudController<\n  TEntity,\n  RouteEnv,\n  RouteSchema,\n  BasePath,\n  ConfigurableOptions,\n  TDataObject,\n  TPersistObject\n> {\n  /** Narrows EVERY read of this controller - override it to scope rows to a tenant, an owner or a status. Public because a generated controller's declaration cannot carry a protected member (TS4094). */\n  async getBaseWhere(_opts: {\n    context: TRouteContext<RouteEnv>;\n  }): Promise<TWhere<TDataObject> | undefined> {\n    return undefined;\n  }\n\n  /** GET /count */\n  async count(opts: { context: TRouteContext<RouteEnv> }) {\n    const { context } = opts;\n    const { where } = context.req.valid<{ where: TWhere<TDataObject> }>('query');\n    const baseWhere = await this.getBaseWhere({ context });\n    const scopedWhere = baseWhere ? withBaseWhere({ baseWhere, where }) : where;\n\n    const rs = await this.measure({\n      scope: 'count',\n      args: { where: scopedWhere },\n      task: () => this.repository.count({ where: scopedWhere }),\n    });\n\n    return context.json(rs, HTTP.ResultCodes.RS_2.Ok);\n  }\n\n  /** GET / - paginated list with a Content-Range header. */\n  async find(opts: { context: TRouteContext<RouteEnv> }) {\n    const { context } = opts;\n    const { filter = {} } = context.req.valid<{ filter?: TFilter<TDataObject> }>('query');\n    const baseWhere = await this.getBaseWhere({ context });\n    const scopedFilter = baseWhere\n      ? { ...filter, where: withBaseWhere({ baseWhere, where: filter.where }) }\n      : filter;\n\n    const rs = await this.measure({\n      scope: 'find',\n      args: scopedFilter,\n      task: async () => {\n        const { data, range } = await this.repository.find({\n          filter: scopedFilter,\n          options: { shouldQueryRange: true },\n        });\n\n        return this.respond<Array<TDataObject>>({\n          context,\n          format: ResponseFormats.ARRAY,\n          payload: { count: data.length, data },\n          range,\n        });\n      },\n    });\n\n    return context.json(rs, HTTP.ResultCodes.RS_2.Ok);\n  }\n\n  /** GET /:id */\n  async findById(opts: { context: TRouteContext<RouteEnv> }) {\n    const { context } = opts;\n    const { id } = context.req.valid<{ id: IdType }>('param');\n    const { filter } = context.req.valid<{ filter?: Omit<TFilter<TDataObject>, 'where'> }>('query');\n    const baseWhere = await this.getBaseWhere({ context });\n\n    // `repository.findById` takes no where, so a scoped read goes through `findOne` - the same\n    // substrate every family's findById delegates to - and answers null on an out-of-scope id.\n    const scopedWhere = baseWhere\n      ? withBaseWhere({ baseWhere, where: whereById({ id }) })\n      : undefined;\n\n    const rs = await this.measure({\n      scope: 'findById',\n      args: filter,\n      task: async () => {\n        const record = scopedWhere\n          ? await this.repository.findOne({ filter: { ...filter, where: scopedWhere } })\n          : await this.repository.findById({ id, filter });\n\n        return this.respond<TDataObject>({\n          context,\n          format: ResponseFormats.OBJECT,\n          payload: { count: record ? 1 : 0, data: record },\n        });\n      },\n    });\n\n    return context.json(rs, HTTP.ResultCodes.RS_2.Ok);\n  }\n\n  /** GET /find-one */\n  async findOne(opts: { context: TRouteContext<RouteEnv> }) {\n    const { context } = opts;\n    const { filter = {} } = context.req.valid<{ filter?: TFilter<TDataObject> }>('query');\n    const baseWhere = await this.getBaseWhere({ context });\n    const scopedFilter = baseWhere\n      ? { ...filter, where: withBaseWhere({ baseWhere, where: filter.where }) }\n      : filter;\n\n    const rs = await this.measure({\n      scope: 'findOne',\n      args: scopedFilter,\n      task: async () => {\n        const record = await this.repository.findOne({ filter: scopedFilter });\n        return this.respond<TDataObject>({\n          context,\n          format: ResponseFormats.OBJECT,\n          payload: { count: record ? 1 : 0, data: record },\n        });\n      },\n    });\n\n    return context.json(rs, HTTP.ResultCodes.RS_2.Ok);\n  }\n}\n"]}