@antelopejs/interface-data-api 0.0.2

package/dist/index.js

@@ -0,0 +1,217 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DefaultRoutes = exports.RegisterDataController = void 0;
+exports.DataController = DataController;
+exports.GetDataControllerMeta = GetDataControllerMeta;
+const node_assert_1 = __importDefault(require("node:assert"));
+const interface_api_1 = require("@antelopejs/interface-api");
+const interface_api_util_1 = require("@antelopejs/interface-api-util");
+const interface_core_1 = require("@antelopejs/interface-core");
+const decorators_1 = require("@antelopejs/interface-core/decorators");
+const interface_database_decorators_1 = require("@antelopejs/interface-database-decorators");
+const common_1 = require("@antelopejs/interface-database-decorators/modifiers/common");
+const schema_1 = require("@antelopejs/interface-database-decorators/schema");
+const components_1 = require("./components");
+const metadata_1 = require("./metadata");
+class TableHolder {
+    table;
+}
+function DataController(tableClass, def, base) {
+    const c = class extends base {
+        table;
+    };
+    const meta = (0, interface_core_1.GetMetadata)(c, metadata_1.DataAPIMeta);
+    const tableMetadata = (0, interface_database_decorators_1.getMetadata)(tableClass, interface_database_decorators_1.DatumStaticMetadata);
+    meta.schemaName = tableMetadata.schemaName || "default";
+    const databaseSchema = (0, schema_1.getTablesForSchema)(meta.schemaName);
+    (0, node_assert_1.default)(databaseSchema, "Non-existent Database Schema");
+    const tableName = Object.entries(databaseSchema).find(([, table]) => table === tableClass)?.[0];
+    (0, node_assert_1.default)(tableName, "Unregistered Database Table");
+    meta.tableClass = tableClass;
+    meta.tableName = tableName;
+    for (const [key, val] of Object.entries(def)) {
+        const entry = "func" in val
+            ? { endpoint: key, callback: val }
+            : { endpoint: key, ...val };
+        meta.addEndpoint(key, entry);
+        // TODO?: should this go in addEndpoint?
+        c.prototype[key] = entry.callback.func;
+    }
+    return c;
+}
+exports.RegisterDataController = (0, decorators_1.MakeClassDecorator)((target) => {
+    const meta = (0, interface_core_1.GetMetadata)(target, metadata_1.DataAPIMeta);
+    for (const [key, entry] of Object.entries(meta.endpoints)) {
+        for (let i = 0; i < entry.callback.args.length; ++i) {
+            const arg = entry.callback.args[i];
+            if (Array.isArray(arg)) {
+                for (const step of arg) {
+                    step(target.prototype, key, i);
+                }
+            }
+            else {
+                arg(target.prototype, key, i);
+            }
+        }
+        const meta = (0, interface_core_1.GetMetadata)(target, interface_api_1.ControllerMeta);
+        const fullLocation = `${meta.location}/${entry.endpoint ?? key}`.replace(/\/+/g, "/");
+        (0, interface_api_1.RegisterRoute)({
+            callback: (ctx) => {
+                ctx.dataAPIEntry = entry;
+            },
+            location: fullLocation,
+            method: entry.callback.method,
+            mode: "prefix",
+            parameters: [{ provider: (ctx) => ctx, modifiers: [] }],
+            properties: meta.computed_props,
+            proto: target.prototype,
+        });
+        (0, interface_api_1.Route)("handler", entry.callback.method, entry.endpoint)(target.prototype, key, {
+            value: entry.callback.func,
+        });
+    }
+});
+function GetDataControllerMeta(thisObj) {
+    return (0, interface_core_1.GetMetadata)(Object.getPrototypeOf(thisObj).constructor, metadata_1.DataAPIMeta, true);
+}
+var DefaultRoutes;
+(function (DefaultRoutes) {
+    class Methods {
+        async get(_reqCtx, params) {
+            const meta = GetDataControllerMeta(this);
+            const model = components_1.Query.GetModel(this, meta);
+            let query = components_1.Query.Get(model.table, params.id, params.index);
+            if (!params.noForeign) {
+                query = components_1.Query.Foreign(model.database, meta, query);
+            }
+            const dbResult = model.constructor.fromDatabase(await query);
+            (0, interface_api_util_1.assert)(dbResult, 404, "Not Found");
+            components_1.Validation.Unlock(this, meta, dbResult);
+            const results = await components_1.Query.ReadProperties(this, meta, dbResult, "get");
+            components_1.Validation.ClearInternal(meta, results);
+            return results;
+        }
+        async list(reqCtx, params) {
+            const meta = GetDataControllerMeta(this);
+            const model = components_1.Query.GetModel(this, meta);
+            const sort = params?.sortKey
+                ? [params.sortKey, params.sortDirection]
+                : undefined;
+            let [query, queryTotal] = components_1.Query.List(this, meta, model.table, reqCtx, sort, params?.filters);
+            const pluck = meta.pluck[params.pluckMode ?? "list"];
+            (0, interface_api_util_1.assert)(params.noPluck || pluck, 400, `No fields found for pluckMode '${params.pluckMode ?? "list"}'`);
+            if (!params.noForeign) {
+                query = components_1.Query.Foreign(model.database, meta, query, params.noPluck ? undefined : pluck);
+            }
+            const offset = params.offset || 0;
+            const limit = params.limit || 10;
+            let queryPaged = query.slice(offset, limit);
+            if (!params.noPluck && pluck) {
+                queryPaged = queryPaged.pluck("_internal", ...pluck);
+            }
+            const [dbResult, dbTotal] = await Promise.all([queryPaged, queryTotal]);
+            const results = await Promise.all(dbResult.map((entry) => {
+                const entryInstance = model.constructor.fromDatabase(entry);
+                components_1.Validation.Unlock(this, meta, entryInstance);
+                return components_1.Query.ReadProperties(this, meta, entryInstance, "list");
+            }));
+            components_1.Validation.ClearInternal(meta, results);
+            return {
+                results,
+                total: dbTotal,
+                offset,
+                limit,
+            };
+        }
+        async new(_reqCtx, params, body) {
+            const meta = GetDataControllerMeta(this);
+            const data = JSON.parse(body.toString());
+            if (!params.noMandatory) {
+                components_1.Validation.MandatoryFields(meta, data, "new");
+            }
+            await components_1.Validation.ValidateTypes(meta, data);
+            const dbData = await components_1.Query.WriteProperties(this, meta, data, "new");
+            components_1.Validation.Lock(this, meta, dbData);
+            const model = components_1.Query.GetModel(this, meta);
+            (0, common_1.triggerEvent)(dbData, "insert");
+            const dbResult = await model.table.insert(dbData);
+            return dbResult;
+        }
+        async edit(_reqCtx, params, body) {
+            const meta = GetDataControllerMeta(this);
+            const data = JSON.parse(body.toString());
+            if (!params.noMandatory) {
+                components_1.Validation.MandatoryFields(meta, data, "edit");
+            }
+            await components_1.Validation.ValidateTypes(meta, data);
+            const model = components_1.Query.GetModel(this, meta);
+            const queryPrevious = components_1.Query.Get(model.table, params.id, params.index);
+            const dbResultPrevious = await queryPrevious;
+            const dbData = await components_1.Query.WriteProperties(this, meta, data, "edit", dbResultPrevious);
+            components_1.Validation.Lock(this, meta, dbData);
+            (0, common_1.triggerEvent)(dbData, "update");
+            await model.table.get(params.id).update(dbData);
+        }
+        async delete(_reqCtx, params) {
+            const meta = GetDataControllerMeta(this);
+            const model = components_1.Query.GetModel(this, meta);
+            const query = components_1.Query.Delete(model.table, params.id);
+            // Promise.all(ids.map(id => table.get(id).delete().then(() => true).catch(() => false)));
+            const dbResult = await query;
+            return dbResult;
+        }
+    }
+    DefaultRoutes.Get = {
+        func: Methods.prototype.get,
+        args: [(0, interface_api_1.Context)(), components_1.Parameters.Get()],
+        method: "get",
+    };
+    DefaultRoutes.List = {
+        func: Methods.prototype.list,
+        args: [(0, interface_api_1.Context)(), components_1.Parameters.List()],
+        method: "get",
+    };
+    DefaultRoutes.New = {
+        func: Methods.prototype.new,
+        args: [(0, interface_api_1.Context)(), components_1.Parameters.New(), (0, interface_api_1.RawBody)()],
+        method: "post",
+    };
+    DefaultRoutes.Edit = {
+        func: Methods.prototype.edit,
+        args: [(0, interface_api_1.Context)(), components_1.Parameters.Edit(), (0, interface_api_1.RawBody)()],
+        method: "put",
+    };
+    DefaultRoutes.Delete = {
+        func: Methods.prototype.delete,
+        args: [(0, interface_api_1.Context)(), components_1.Parameters.Delete()],
+        method: "delete",
+    };
+    DefaultRoutes.All = {
+        get: DefaultRoutes.Get,
+        list: DefaultRoutes.List,
+        new: DefaultRoutes.New,
+        edit: DefaultRoutes.Edit,
+        delete: DefaultRoutes.Delete,
+    };
+    function WithOptions(callback, options, endpoint) {
+        if ("func" in callback) {
+            return {
+                endpoint,
+                options,
+                callback,
+            };
+        }
+        else {
+            return {
+                endpoint: endpoint ?? callback.endpoint,
+                options: { ...(callback.options ?? {}), ...(options ?? {}) },
+                callback: callback.callback,
+            };
+        }
+    }
+    DefaultRoutes.WithOptions = WithOptions;
+})(DefaultRoutes || (exports.DefaultRoutes = DefaultRoutes = {}));
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;AAwDA,wCAqCC;AAyCD,sDAMC;AA5ID,8DAAkC;AAClC,6DAQmC;AACnC,uEAAwD;AACxD,+DAAyD;AACzD,sEAI+C;AAC/C,6FAGmD;AACnD,uFAA0F;AAC1F,6EAAsF;AACtF,6CAA6D;AAC7D,yCAAyC;AA4BzC,MAAe,WAAW;IACxB,KAAK,CAAmB;CACzB;AAED,SAAgB,cAAc,CAK5B,UAAa,EACb,GAAM,EACN,IAAU;IAEV,MAAM,CAAC,GAAG,KAAM,SAAQ,IAAI;QAC1B,KAAK,CAAmB;KACzB,CAAC;IACF,MAAM,IAAI,GAAG,IAAA,4BAAW,EAAC,CAAC,EAAE,sBAAW,CAAC,CAAC;IACzC,MAAM,aAAa,GAAG,IAAA,2CAAW,EAAC,UAAU,EAAE,mDAAmB,CAAC,CAAC;IACnE,IAAI,CAAC,UAAU,GAAG,aAAa,CAAC,UAAU,IAAI,SAAS,CAAC;IAExD,MAAM,cAAc,GAAG,IAAA,2BAAkB,EAAC,IAAI,CAAC,UAAU,CAAC,CAAC;IAC3D,IAAA,qBAAO,EAAC,cAAc,EAAE,8BAA8B,CAAC,CAAC;IAExD,MAAM,SAAS,GAAG,MAAM,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC,IAAI,CACnD,CAAC,CAAC,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,KAAK,KAAK,UAAU,CACpC,EAAE,CAAC,CAAC,CAAC,CAAC;IACP,IAAA,qBAAO,EAAC,SAAS,EAAE,6BAA6B,CAAC,CAAC;IAElD,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;IAC7B,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;IAE3B,KAAK,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC;QAC7C,MAAM,KAAK,GACT,MAAM,IAAI,GAAG;YACX,CAAC,CAAC,EAAE,QAAQ,EAAE,GAAG,EAAE,QAAQ,EAAE,GAAG,EAAE;YAClC,CAAC,CAAC,EAAE,QAAQ,EAAE,GAAG,EAAE,GAAG,GAAG,EAAE,CAAC;QAChC,IAAI,CAAC,WAAW,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;QAC7B,wCAAwC;QACxC,CAAC,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC;IACzC,CAAC;IACD,OAAO,CAAQ,CAAC;AAClB,CAAC;AAEY,QAAA,sBAAsB,GAAG,IAAA,+BAAkB,EAAC,CAAC,MAAM,EAAE,EAAE;IAClE,MAAM,IAAI,GAAG,IAAA,4BAAW,EAAC,MAAM,EAAE,sBAAW,CAAC,CAAC;IAC9C,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC;QAC1D,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE,CAAC;YACpD,MAAM,GAAG,GAAG,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;YACnC,IAAI,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC;gBACvB,KAAK,MAAM,IAAI,IAAI,GAAG,EAAE,CAAC;oBACvB,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC;gBACjC,CAAC;YACH,CAAC;iBAAM,CAAC;gBACN,GAAG,CAAC,MAAM,CAAC,SAAS,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC;YAChC,CAAC;QACH,CAAC;QACD,MAAM,IAAI,GAAG,IAAA,4BAAW,EAAM,MAAM,EAAE,8BAAc,CAAC,CAAC;QACtD,MAAM,YAAY,GAAG,GAAG,IAAI,CAAC,QAAQ,IAAI,KAAK,CAAC,QAAQ,IAAI,GAAG,EAAE,CAAC,OAAO,CACtE,MAAM,EACN,GAAG,CACJ,CAAC;QACF,IAAA,6BAAa,EAAC;YACZ,QAAQ,EAAE,CAAC,GAAG,EAAE,EAAE;gBAChB,GAAG,CAAC,YAAY,GAAG,KAAK,CAAC;YAC3B,CAAC;YACD,QAAQ,EAAE,YAAY;YACtB,MAAM,EAAE,KAAK,CAAC,QAAQ,CAAC,MAAM;YAC7B,IAAI,EAAE,QAAQ;YACd,UAAU,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,EAAE,SAAS,EAAE,EAAE,EAAE,CAAC;YACvD,UAAU,EAAE,IAAI,CAAC,cAAc;YAC/B,KAAK,EAAE,MAAM,CAAC,SAAS;SACxB,CAAC,CAAC;QACH,IAAA,qBAAK,EAAC,SAAS,EAAE,KAAK,CAAC,QAAQ,CAAC,MAAM,EAAE,KAAK,CAAC,QAAQ,CAAC,CACrD,MAAM,CAAC,SAAS,EAChB,GAAG,EACH;YACE,KAAK,EAAE,KAAK,CAAC,QAAQ,CAAC,IAAI;SAC3B,CACF,CAAC;IACJ,CAAC;AACH,CAAC,CAAC,CAAC;AAEH,SAAgB,qBAAqB,CAAC,OAAY;IAChD,OAAO,IAAA,4BAAW,EAChB,MAAM,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC,WAAW,EAC1C,sBAAW,EACX,IAAI,CACL,CAAC;AACJ,CAAC;AAED,IAAiB,aAAa,CA+M7B;AA/MD,WAAiB,aAAa;IAC5B,MAAM,OAAO;QACX,KAAK,CAAC,GAAG,CAAC,OAAuB,EAAE,MAAgC;YACjE,MAAM,IAAI,GAAG,qBAAqB,CAAC,IAAI,CAAC,CAAC;YAEzC,MAAM,KAAK,GAAG,kBAAK,CAAC,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;YACzC,IAAI,KAAK,GAAG,kBAAK,CAAC,GAAG,CAAC,KAAK,CAAC,KAAK,EAAE,MAAM,CAAC,EAAE,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC;YAE5D,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE,CAAC;gBACtB,KAAK,GAAG,kBAAK,CAAC,OAAO,CAAC,KAAK,CAAC,QAAQ,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC;YACrD,CAAC;YAED,MAAM,QAAQ,GAAG,KAAK,CAAC,WAAW,CAAC,YAAY,CAAC,MAAM,KAAK,CAAC,CAAC;YAC7D,IAAA,2BAAM,EAAC,QAAQ,EAAE,GAAG,EAAE,WAAW,CAAC,CAAC;YACnC,uBAAU,CAAC,MAAM,CAAC,IAAI,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAC;YAExC,MAAM,OAAO,GAAG,MAAM,kBAAK,CAAC,cAAc,CAAC,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE,KAAK,CAAC,CAAC;YAExE,uBAAU,CAAC,aAAa,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;YAExC,OAAO,OAAO,CAAC;QACjB,CAAC;QAED,KAAK,CAAC,IAAI,CAAC,MAAsB,EAAE,MAAiC;YAClE,MAAM,IAAI,GAAG,qBAAqB,CAAC,IAAI,CAAC,CAAC;YAEzC,MAAM,KAAK,GAAG,kBAAK,CAAC,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;YACzC,MAAM,IAAI,GAAG,MAAM,EAAE,OAAO;gBAC1B,CAAC,CAAE,CAAC,MAAM,CAAC,OAAO,EAAE,MAAM,CAAC,aAAa,CAGpC;gBACJ,CAAC,CAAC,SAAS,CAAC;YACd,IAAI,CAAC,KAAK,EAAE,UAAU,CAAC,GAAG,kBAAK,CAAC,IAAI,CAClC,IAAI,EACJ,IAAI,EACJ,KAAK,CAAC,KAAK,EACX,MAAM,EACN,IAAI,EACJ,MAAM,EAAE,OAAO,CAChB,CAAC;YAEF,MAAM,KAAK,GACT,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,SAAS,IAAI,MAAM,CAAC,CAAC;YACzC,IAAA,2BAAM,EACJ,MAAM,CAAC,OAAO,IAAI,KAAK,EACvB,GAAG,EACH,kCAAkC,MAAM,CAAC,SAAS,IAAI,MAAM,GAAG,CAChE,CAAC;YAEF,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE,CAAC;gBACtB,KAAK,GAAG,kBAAK,CAAC,OAAO,CACnB,KAAK,CAAC,QAAQ,EACd,IAAI,EACJ,KAAK,EACL,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,KAAK,CACnC,CAAC;YACJ,CAAC;YAED,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,IAAI,CAAC,CAAC;YAClC,MAAM,KAAK,GAAG,MAAM,CAAC,KAAK,IAAI,EAAE,CAAC;YACjC,IAAI,UAAU,GAAG,KAAK,CAAC,KAAK,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;YAE5C,IAAI,CAAC,MAAM,CAAC,OAAO,IAAI,KAAK,EAAE,CAAC;gBAC7B,UAAU,GAAG,UAAU,CAAC,KAAK,CAAC,WAAW,EAAE,GAAG,KAAK,CAAC,CAAC;YACvD,CAAC;YAED,MAAM,CAAC,QAAQ,EAAE,OAAO,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC,CAAC;YAExE,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,GAAG,CAC/B,QAAQ,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE;gBACrB,MAAM,aAAa,GAAG,KAAK,CAAC,WAAW,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;gBAC5D,uBAAU,CAAC,MAAM,CAAC,IAAI,EAAE,IAAI,EAAE,aAAa,CAAC,CAAC;gBAC7C,OAAO,kBAAK,CAAC,cAAc,CAAC,IAAI,EAAE,IAAI,EAAE,aAAa,EAAE,MAAM,CAAC,CAAC;YACjE,CAAC,CAAC,CACH,CAAC;YAEF,uBAAU,CAAC,aAAa,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;YAExC,OAAO;gBACL,OAAO;gBACP,KAAK,EAAE,OAAO;gBACd,MAAM;gBACN,KAAK;aACN,CAAC;QACJ,CAAC;QAED,KAAK,CAAC,GAAG,CACP,OAAuB,EACvB,MAAgC,EAChC,IAAY;YAEZ,MAAM,IAAI,GAAG,qBAAqB,CAAC,IAAI,CAAC,CAAC;YAEzC,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC;YACzC,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC;gBACxB,uBAAU,CAAC,eAAe,CAAC,IAAI,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC;YAChD,CAAC;YACD,MAAM,uBAAU,CAAC,aAAa,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;YAE3C,MAAM,MAAM,GAAG,MAAM,kBAAK,CAAC,eAAe,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC;YACpE,uBAAU,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;YAEpC,MAAM,KAAK,GAAG,kBAAK,CAAC,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;YACzC,IAAA,qBAAY,EAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;YAC/B,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;YAElD,OAAO,QAAQ,CAAC;QAClB,CAAC;QAED,KAAK,CAAC,IAAI,CACR,OAAuB,EACvB,MAAiC,EACjC,IAAY;YAEZ,MAAM,IAAI,GAAG,qBAAqB,CAAC,IAAI,CAAC,CAAC;YAEzC,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC;YACzC,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC;gBACxB,uBAAU,CAAC,eAAe,CAAC,IAAI,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;YACjD,CAAC;YACD,MAAM,uBAAU,CAAC,aAAa,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;YAE3C,MAAM,KAAK,GAAG,kBAAK,CAAC,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;YAEzC,MAAM,aAAa,GAAG,kBAAK,CAAC,GAAG,CAAC,KAAK,CAAC,KAAK,EAAE,MAAM,CAAC,EAAE,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC;YACtE,MAAM,gBAAgB,GAAG,MAAM,aAAa,CAAC;YAE7C,MAAM,MAAM,GAAG,MAAM,kBAAK,CAAC,eAAe,CACxC,IAAI,EACJ,IAAI,EACJ,IAAI,EACJ,MAAM,EACN,gBAAgB,CACjB,CAAC;YACF,uBAAU,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;YAEpC,IAAA,qBAAY,EAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;YAC/B,MAAM,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QAClD,CAAC;QAED,KAAK,CAAC,MAAM,CAAC,OAAuB,EAAE,MAAmC;YACvE,MAAM,IAAI,GAAG,qBAAqB,CAAC,IAAI,CAAC,CAAC;YAEzC,MAAM,KAAK,GAAG,kBAAK,CAAC,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;YAEzC,MAAM,KAAK,GAAG,kBAAK,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,EAAE,MAAM,CAAC,EAAE,CAAC,CAAC;YACnD,0FAA0F;YAE1F,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC;YAC7B,OAAO,QAAQ,CAAC;QAClB,CAAC;KACF;IAEY,iBAAG,GAAG;QACjB,IAAI,EAAE,OAAO,CAAC,SAAS,CAAC,GAAG;QAC3B,IAAI,EAAE,CAAC,IAAA,uBAAO,GAAE,EAAE,uBAAU,CAAC,GAAG,EAAE,CAAC;QACnC,MAAM,EAAE,KAAK;KACd,CAAC;IACW,kBAAI,GAAG;QAClB,IAAI,EAAE,OAAO,CAAC,SAAS,CAAC,IAAI;QAC5B,IAAI,EAAE,CAAC,IAAA,uBAAO,GAAE,EAAE,uBAAU,CAAC,IAAI,EAAE,CAAC;QACpC,MAAM,EAAE,KAAK;KACd,CAAC;IACW,iBAAG,GAAG;QACjB,IAAI,EAAE,OAAO,CAAC,SAAS,CAAC,GAAG;QAC3B,IAAI,EAAE,CAAC,IAAA,uBAAO,GAAE,EAAE,uBAAU,CAAC,GAAG,EAAE,EAAE,IAAA,uBAAO,GAAE,CAAC;QAC9C,MAAM,EAAE,MAAM;KACf,CAAC;IACW,kBAAI,GAAG;QAClB,IAAI,EAAE,OAAO,CAAC,SAAS,CAAC,IAAI;QAC5B,IAAI,EAAE,CAAC,IAAA,uBAAO,GAAE,EAAE,uBAAU,CAAC,IAAI,EAAE,EAAE,IAAA,uBAAO,GAAE,CAAC;QAC/C,MAAM,EAAE,KAAK;KACd,CAAC;IACW,oBAAM,GAAG;QACpB,IAAI,EAAE,OAAO,CAAC,SAAS,CAAC,MAAM;QAC9B,IAAI,EAAE,CAAC,IAAA,uBAAO,GAAE,EAAE,uBAAU,CAAC,MAAM,EAAE,CAAC;QACtC,MAAM,EAAE,QAAQ;KACjB,CAAC;IAEW,iBAAG,GAAG;QACjB,GAAG,EAAE,cAAA,GAAG;QACR,IAAI,EAAE,cAAA,IAAI;QACV,GAAG,EAAE,cAAA,GAAG;QACR,IAAI,EAAE,cAAA,IAAI;QACV,MAAM,EAAE,cAAA,MAAM;KACN,CAAC;IAEX,SAAgB,WAAW,CACzB,QAA0E,EAC1E,OAAoB,EACpB,QAAiB;QAEjB,IAAI,MAAM,IAAI,QAAQ,EAAE,CAAC;YACvB,OAAO;gBACL,QAAQ;gBACR,OAAO;gBACP,QAAQ;aACT,CAAC;QACJ,CAAC;aAAM,CAAC;YACN,OAAO;gBACL,QAAQ,EAAE,QAAQ,IAAI,QAAQ,CAAC,QAAQ;gBACvC,OAAO,EAAE,EAAE,GAAG,CAAC,QAAQ,CAAC,OAAO,IAAI,EAAE,CAAC,EAAE,GAAG,CAAC,OAAO,IAAI,EAAE,CAAC,EAAE;gBAC5D,QAAQ,EAAE,QAAQ,CAAC,QAAQ;aAC5B,CAAC;QACJ,CAAC;IACH,CAAC;IAlBe,yBAAW,cAkB1B,CAAA;AACH,CAAC,EA/MgB,aAAa,6BAAb,aAAa,QA+M7B"}

package/dist/metadata.d.ts

@@ -0,0 +1,290 @@
+import type { RequestContext } from "@antelopejs/interface-api";
+import { type Class } from "@antelopejs/interface-core/decorators";
+import type { ValueProxy, ValueProxyOrValue } from "@antelopejs/interface-database";
+import { type Table } from "@antelopejs/interface-database-decorators";
+import type { ContainerModifier } from "@antelopejs/interface-database-decorators/modifiers/common";
+import type { DataControllerCallbackWithOptions } from ".";
+/**
+ * Field access mode enum.
+ */
+export declare enum AccessMode {
+    ReadOnly = 1,
+    WriteOnly = 2,
+    ReadWrite = 3
+}
+/**
+ * DataAPI Metadata field information.
+ */
+export interface FieldData {
+    /**
+     * Field name in-database.
+     */
+    dbName?: string;
+    /**
+     * Field access mode.
+     *
+     * @see {@link AccessMode}
+     */
+    mode?: AccessMode;
+    /**
+     * Field access mode overrides per DataAPI action.
+     */
+    modeOverrides?: Record<string, AccessMode>;
+    /**
+     * DB Fields that should be selected for this field.
+     */
+    listable?: Record<string, string[]>;
+    /**
+     * Set of api methods for which the field must be set.
+     */
+    mandatory?: Set<string>;
+    /**
+     * Whether the DataAPI can be sorted using this field.
+     */
+    sortable?: {
+        indexed?: boolean;
+    };
+    /**
+     * Foreign key reference.
+     */
+    foreign?: [
+        table: string,
+        tableClass?: Class<Table>,
+        index?: string,
+        multi?: true,
+        pluck?: string[]
+    ];
+    /**
+     * Value validator callback.
+     */
+    validator?: (value: unknown) => boolean | Promise<boolean>;
+    /**
+     * Field property descriptor.
+     */
+    desc?: PropertyDescriptor;
+    /**
+     * Whether or not an `eq` filter with this field name can use an indexed lookup.
+     */
+    indexable?: boolean;
+}
+type Comparison = "eq" | "ne" | "gt" | "ge" | "lt" | "le";
+export type FilterValue = [value: string, mode: Comparison];
+/**
+ * Filter callback.
+ */
+export type FilterFunction<T extends Record<string, any>, U extends Record<string, any> = Record<string, any>> = (context: RequestContext & {
+    this: T;
+}, proxy: ValueProxy<any>, key: string, value: FilterValue[0], mode: FilterValue[1], row: ValueProxy<U>) => ValueProxyOrValue<boolean>;
+export interface ReadableAccessFields {
+    getters: [string, FieldData][];
+    props: [string, FieldData][];
+}
+export interface WritableAccessFields {
+    setters: [string, FieldData][];
+    props: [string, FieldData][];
+}
+/**
+ * Metadata Class containing the DataAPI information.
+ */
+export declare class DataAPIMeta {
+    readonly target: Class;
+    /**
+     * Key symbol.
+     */
+    static key: symbol;
+    readonly filters: Record<string, FilterFunction<any>>;
+    /**
+     * Fields information.
+     */
+    readonly fields: Record<string, FieldData>;
+    /**
+     * Fields to pluck in listing endpoints.
+     */
+    readonly pluck: Record<string, Set<string>>;
+    /**
+     * Key of the DataAPI class containing a database table instance.
+     */
+    modelKey?: string;
+    /**
+     * Keys of the DataAPI class containing database modifier keys.
+     */
+    modifierKeys: Map<typeof ContainerModifier<any>, string>;
+    /**
+     * Schema name where the table is registered.
+     */
+    schemaName: string;
+    /**
+     * Database Schema class.
+     */
+    tableClass: Class;
+    /**
+     * Database Schema table name.
+     */
+    tableName: string;
+    /**
+     * Readable fields.
+     */
+    readonly readable: Record<string, ReadableAccessFields>;
+    /**
+     * Writeable fields.
+     */
+    readonly writable: Record<string, WritableAccessFields>;
+    /**
+     * Registered DataAPI endpoints.
+     */
+    readonly endpoints: Record<string, DataControllerCallbackWithOptions>;
+    constructor(target: Class);
+    inherit(parent: DataAPIMeta): void;
+    private field;
+    private recomputeListable;
+    private recomputeAccess;
+    /**
+     * Sets the access mode of the given field.
+     *
+     * @param name Field name
+     * @param mode Access mode
+     */
+    setMode(name: string, mode: AccessMode, overrides?: Record<string, AccessMode>): this;
+    /**
+     * Sets whether a field should be included in list endpoints.
+     *
+     * @param name Field name
+     * @param requiredFields Boolean or table field list
+     * @param mode List mode (default: 'list')
+     */
+    setListable(name: string, requiredFields: boolean | string[], mode?: string): this;
+    /**
+     * Sets whether or not this field must be present in requests for the given method.
+     *
+     * @param name Field name
+     * @param modes DataAPI methods
+     */
+    setMandatory(name: string, modes: string[]): this;
+    /**
+     * Sets whether or not this field can be used to sort in list endpoints.
+     *
+     * @param name Field name
+     * @param active Sortable
+     * @param noIndex Ignore database indexes
+     * @returns
+     */
+    setSortable(name: string, active: boolean, noIndex?: boolean): this;
+    /**
+     * Declares a field to be a foreign key.
+     *
+     * @param name Field name
+     * @param table Other table
+     * @param index Other table index
+     * @param multi Index is a multi index
+     */
+    setForeign(name: string, table: string | Class<Table>, index?: string, multi?: boolean, pluck?: string[]): this;
+    /**
+     * Set the validation function of a field.
+     *
+     * @param name Field name
+     * @param validator Value validator callback
+     */
+    setValidator(name: string, validator?: (value: unknown) => boolean | Promise<boolean>): this;
+    /**
+     * Updates the known field descriptor of this field.
+     *
+     * @param name Field name
+     * @param desc Field descriptor
+     */
+    setDescriptor(name: string, desc?: PropertyDescriptor): this;
+    /**
+     * Creates a filter.
+     *
+     * @param name Filter name
+     * @param func Filter callback
+     * @param index
+     */
+    setFilter(name: string, func: FilterFunction<Record<string, any>, Record<string, any>>, useIndex?: boolean): this;
+    /**
+     * Sets the key containing the database table instance.
+     *
+     * @param name Field name
+     */
+    setModelKey(name: string): this;
+    /**
+     * Sets the key containing the key for the given database modifier.
+     *
+     * @param name Field name
+     * @param modifierClass Modifier
+     */
+    setModifierKey(name: string, modifierClass: typeof ContainerModifier<any>): this;
+    /**
+     * Adds the given endpoint to the DataAPI
+     *
+     * @param key field name
+     * @param endpoint callback information
+     */
+    addEndpoint(key: string, endpoint?: DataControllerCallbackWithOptions): void;
+}
+/**
+ * Sets the access mode of a DataAPI field.
+ *
+ * @param mode Access mode
+ */
+export declare const Access: (mode: AccessMode, overrides?: Record<string, AccessMode> | undefined) => import("@antelopejs/interface-core/decorators").PropertyDecorator & import("@antelopejs/interface-core/decorators").MethodDecorator;
+/**
+ * Sets the listable state of a DataAPI field.
+ *
+ * Listable fields will be included in list method calls.
+ *
+ * Listable getters must specificy the list of in-database field names they use.
+ *
+ * @param requiredFields Boolean or table field list
+ */
+export declare const Listable: (requiredFields?: boolean | string[] | undefined, mode?: string | undefined) => import("@antelopejs/interface-core/decorators").PropertyDecorator & import("@antelopejs/interface-core/decorators").MethodDecorator;
+/**
+ * Declares a field to be mandatory in calls to the given methods.
+ *
+ * @param modes DataAPI methods (ex: `new`, `edit`)
+ */
+export declare const Mandatory: (...args: string[]) => import("@antelopejs/interface-core/decorators").PropertyDecorator & import("@antelopejs/interface-core/decorators").MethodDecorator;
+/**
+ * Declares a field as being optional.
+ *
+ * This must be used on fields with no other decorators.
+ */
+export declare const Optional: () => import("@antelopejs/interface-core/decorators").PropertyDecorator & import("@antelopejs/interface-core/decorators").MethodDecorator;
+/**
+ * Declares a field to be useable as the sorting key.
+ *
+ * @param options Options
+ */
+export declare const Sortable: (options?: {
+    noIndex?: boolean;
+} | undefined) => import("@antelopejs/interface-core/decorators").PropertyDecorator & import("@antelopejs/interface-core/decorators").MethodDecorator;
+/**
+ * Declares a field to be a foreign key.
+ *
+ * @param table Other table
+ * @param index Other table index
+ * @param multi Index is a multi index
+ */
+export declare const Foreign: (table: string | Class<Table>, index?: string | undefined, multi?: boolean | undefined, pluck?: string[] | undefined) => import("@antelopejs/interface-core/decorators").PropertyDecorator & import("@antelopejs/interface-core/decorators").MethodDecorator;
+/**
+ * Set the validation function of a field.
+ *
+ * @param validator Value validator callback
+ */
+export declare const Validator: (validator: (val: unknown) => boolean | Promise<boolean>) => import("@antelopejs/interface-core/decorators").PropertyDecorator & import("@antelopejs/interface-core/decorators").MethodDecorator;
+/**
+ * Creates a field filter.
+ *
+ * @param func Custom filter function
+ */
+export declare const Filter: <T extends Record<string, any>>(func?: FilterFunction<T, T>, useIndex?: boolean) => (target: T, propertyKey: string | symbol) => void;
+/**
+ * Sets which field will contain the reference to the database model instance.
+ */
+export declare const ModelReference: () => import("@antelopejs/interface-core/decorators").PropertyDecorator;
+/**
+ * Sets which field will contain the key for the given database modifier.
+ *
+ * @param modifierClass Modifier
+ */
+export declare const ModifierKey: (modifierClass: typeof ContainerModifier<any>) => import("@antelopejs/interface-core/decorators").PropertyDecorator;
+export {};