@antelopejs/interface-dms 0.0.1

package/dist/base/table-view/routes.js

@@ -0,0 +1,147 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TableViewRoutes = void 0;
+const interface_api_1 = require("@antelopejs/interface-api");
+const interface_api_util_1 = require("@antelopejs/interface-api-util");
+const interface_data_api_1 = require("@antelopejs/interface-data-api");
+const components_1 = require("@antelopejs/interface-data-api/components");
+const request_tenant_1 = require("../../request-tenant");
+const auth_1 = require("../../auth");
+const auth_2 = require("./auth");
+const data_functions_1 = require("./data-functions");
+const files_1 = require("./files");
+const guards_1 = require("./guards");
+const realtime_1 = require("./realtime");
+const row_rules_1 = require("./row-rules");
+const MAX_BATCH_COUNT_QUERIES = 50;
+function parseBatchCountBody(body) {
+    (0, interface_api_util_1.assert)(body && typeof body === "object", 400, "Invalid count batch body.");
+    const queries = body.queries;
+    (0, interface_api_util_1.assert)(Array.isArray(queries), 400, "Invalid count batch queries.");
+    (0, interface_api_util_1.assert)(queries.length <= MAX_BATCH_COUNT_QUERIES, 400, "Too many count batch queries.");
+    for (const query of queries) {
+        (0, interface_api_util_1.assert)(query && typeof query.id === "string" && query.query, 400, "Invalid count batch query.");
+    }
+    return { queries };
+}
+function buildBatchCountContext(ctx, query) {
+    const url = new URL(ctx.url);
+    url.search = "";
+    for (const [key, value] of Object.entries(query)) {
+        if (value !== undefined)
+            url.searchParams.set(key, String(value));
+    }
+    return { ...ctx, url };
+}
+const createBulkOperationRoute = (operationFunc) => ({
+    func: function (ctx, ids) {
+        return operationFunc(this, ctx, ids);
+    },
+    args: [(0, interface_api_1.Context)(), (0, interface_api_1.Parameter)("ids", "query")],
+    method: "put",
+});
+function createListRoute(actionId) {
+    return {
+        func: async function (ctx, listParams, user) {
+            const permissions = await (0, auth_2.authorizeAction)(this, actionId, user, (0, request_tenant_1.getRequestTenantId)(ctx));
+            return (0, data_functions_1.listWithSearch)(this, ctx, listParams, user, permissions);
+        },
+        args: [(0, interface_api_1.Context)(), components_1.Parameters.List(), (0, auth_1.AuthUser)()],
+        method: "get",
+    };
+}
+function createCountRoute(actionId) {
+    return {
+        func: async function (ctx, listParams, user) {
+            const permissions = await (0, auth_2.authorizeAction)(this, actionId, user, (0, request_tenant_1.getRequestTenantId)(ctx));
+            return (0, data_functions_1.countWithSearch)(this, ctx, listParams, user, permissions);
+        },
+        args: [(0, interface_api_1.Context)(), components_1.Parameters.List(), (0, auth_1.AuthUser)()],
+        method: "get",
+    };
+}
+function createBatchCountRoute(actionId) {
+    return {
+        func: async function (ctx, body, user) {
+            const parsed = parseBatchCountBody(body);
+            const permissions = await (0, auth_2.authorizeAction)(this, actionId, user, (0, request_tenant_1.getRequestTenantId)(ctx));
+            const meta = (0, interface_data_api_1.GetDataControllerMeta)(this);
+            const entries = await Promise.all(parsed.queries.map(async ({ id, query }) => {
+                const queryContext = buildBatchCountContext(ctx, query);
+                const listParams = {
+                    filters: components_1.Parameters.ExtractFilters(queryContext, meta),
+                };
+                const result = await (0, data_functions_1.countWithSearch)(this, queryContext, listParams, user, permissions);
+                return [id, result.total];
+            }));
+            return Object.fromEntries(entries);
+        },
+        args: [(0, interface_api_1.Context)(), (0, interface_api_1.JSONBody)(), (0, auth_1.AuthUser)()],
+        method: "post",
+    };
+}
+var TableViewRoutes;
+(function (TableViewRoutes) {
+    TableViewRoutes.Get = (0, realtime_1.withPresenceAcquire)((0, auth_2.withActionCheck)(auth_2.VIEW_ACTION, guards_1.guardedGetRoute));
+    TableViewRoutes.List = createListRoute(auth_2.LIST_ACTION);
+    TableViewRoutes.Select = interface_data_api_1.DefaultRoutes.WithOptions(createListRoute(auth_2.SELECT_ACTION), {
+        pluckMode: "select",
+    });
+    TableViewRoutes.Count = createCountRoute(auth_2.LIST_ACTION);
+    TableViewRoutes.CountBatch = interface_data_api_1.DefaultRoutes.WithOptions(createBatchCountRoute(auth_2.LIST_ACTION), {}, "/count/batch");
+    TableViewRoutes.New = (0, realtime_1.withRealtimeMutation)({ eventType: "created", extractIds: realtime_1.extractFromResult }, (0, auth_2.withActionCheck)("add", (0, guards_1.createGuardedRoute)((0, files_1.withFilePromotion)(interface_data_api_1.DefaultRoutes.New), "new")));
+    TableViewRoutes.Edit = (0, realtime_1.withRealtimeMutation)({ eventType: "updated", extractIds: realtime_1.extractSingleParamId }, (0, auth_2.withActionCheck)("edit", (0, guards_1.createGuardedRoute)((0, row_rules_1.createValidatedRoute)((0, files_1.withFilePromotion)(interface_data_api_1.DefaultRoutes.Edit), "edit"), "edit")));
+    TableViewRoutes.Delete = (0, realtime_1.withRealtimeMutation)({ eventType: "deleted", extractIds: realtime_1.extractMultiParamId }, (0, auth_2.withActionCheck)("delete", (0, guards_1.createGuardedRoute)((0, row_rules_1.createValidatedRoute)((0, files_1.withFilePromotion)(interface_data_api_1.DefaultRoutes.Delete, "delete"), "delete"), "delete")));
+    TableViewRoutes.Archive = (0, realtime_1.withRealtimeMutation)({ eventType: "updated", extractIds: realtime_1.extractBulkArgIds }, (0, auth_2.withActionCheck)("archive", (0, guards_1.createGuardedRoute)((0, row_rules_1.createValidatedRoute)(createBulkOperationRoute(data_functions_1.archiveRows), "archive"), "archive")));
+    TableViewRoutes.Restore = (0, realtime_1.withRealtimeMutation)({ eventType: "updated", extractIds: realtime_1.extractBulkArgIds }, (0, auth_2.withActionCheck)("restore", (0, guards_1.createGuardedRoute)((0, row_rules_1.createValidatedRoute)(createBulkOperationRoute(data_functions_1.restoreRows), "restore"), "restore")));
+    TableViewRoutes.ExportRoutes = {
+        exportStart: (0, auth_2.withActionCheckOptions)("export", interface_data_api_1.DefaultRoutes.WithOptions({
+            func: function (ctx, listParams, format, delivery, ids, user) {
+                return (0, data_functions_1.startExport)(this, ctx, listParams, format, delivery, ids, user);
+            },
+            args: [
+                (0, interface_api_1.Context)(),
+                components_1.Parameters.List(),
+                (0, interface_api_1.Parameter)("format", "query"),
+                (0, interface_api_1.Parameter)("delivery", "query"),
+                (0, interface_api_1.MultiParameter)("ids", "query"),
+                (0, auth_1.AuthUser)(),
+            ],
+            method: "get",
+        }, { pluckMode: "export" }, "/export/start")),
+        exportStatus: (0, auth_2.withActionCheckOptions)("export", {
+            endpoint: "/export/status/:exportId",
+            callback: {
+                func: function (ctx, exportId, user) {
+                    return (0, data_functions_1.getExportStatus)(this, ctx, exportId, user);
+                },
+                args: [(0, interface_api_1.Context)(), (0, interface_api_1.Parameter)("exportId", "param"), (0, auth_1.AuthUser)()],
+                method: "get",
+            },
+        }),
+        exportDownload: (0, auth_2.withActionCheckOptions)("export", {
+            endpoint: "/export/download/:exportId",
+            callback: {
+                func: function (ctx, exportId, user) {
+                    return (0, data_functions_1.downloadExport)(this, ctx, exportId, user);
+                },
+                args: [(0, interface_api_1.Context)(), (0, interface_api_1.Parameter)("exportId", "param"), (0, auth_1.AuthUser)()],
+                method: "get",
+            },
+        }),
+    };
+    TableViewRoutes.All = {
+        get: TableViewRoutes.Get,
+        list: TableViewRoutes.List,
+        select: TableViewRoutes.Select,
+        count: TableViewRoutes.Count,
+        countBatch: TableViewRoutes.CountBatch,
+        new: TableViewRoutes.New,
+        edit: TableViewRoutes.Edit,
+        delete: TableViewRoutes.Delete,
+        archive: TableViewRoutes.Archive,
+        restore: TableViewRoutes.Restore,
+        ...TableViewRoutes.ExportRoutes,
+    };
+})(TableViewRoutes || (exports.TableViewRoutes = TableViewRoutes = {}));
+//# sourceMappingURL=routes.js.map

package/dist/base/table-view/routes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"routes.js","sourceRoot":"","sources":["../../../src/base/table-view/routes.ts"],"names":[],"mappings":";;;AAAA,6DAMmC;AACnC,uEAAwD;AACxD,uEAKwC;AACxC,0EAAuE;AACvE,yDAA0D;AAC1D,qCAAsC;AAEtC,iCAOgB;AAChB,qDAS0B;AAC1B,mCAA4C;AAC5C,qCAA+D;AAC/D,yCAOoB;AACpB,2CAAmD;AAEnD,MAAM,uBAAuB,GAAG,EAAE,CAAC;AAWnC,SAAS,mBAAmB,CAAC,IAAa;IACxC,IAAA,2BAAM,EAAC,IAAI,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,GAAG,EAAE,2BAA2B,CAAC,CAAC;IAC3E,MAAM,OAAO,GAAI,IAAgC,CAAC,OAAO,CAAC;IAC1D,IAAA,2BAAM,EAAC,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,GAAG,EAAE,8BAA8B,CAAC,CAAC;IACpE,IAAA,2BAAM,EACJ,OAAO,CAAC,MAAM,IAAI,uBAAuB,EACzC,GAAG,EACH,+BAA+B,CAChC,CAAC;IACF,KAAK,MAAM,KAAK,IAAI,OAAO,EAAE,CAAC;QAC5B,IAAA,2BAAM,EACJ,KAAK,IAAI,OAAO,KAAK,CAAC,EAAE,KAAK,QAAQ,IAAI,KAAK,CAAC,KAAK,EACpD,GAAG,EACH,4BAA4B,CAC7B,CAAC;IACJ,CAAC;IACD,OAAO,EAAE,OAAO,EAAE,CAAC;AACrB,CAAC;AAED,SAAS,sBAAsB,CAC7B,GAAmB,EACnB,KAA+B;IAE/B,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IAC7B,GAAG,CAAC,MAAM,GAAG,EAAE,CAAC;IAChB,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QACjD,IAAI,KAAK,KAAK,SAAS;YAAE,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,GAAG,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;IACpE,CAAC;IACD,OAAO,EAAE,GAAG,GAAG,EAAE,GAAG,EAAE,CAAC;AACzB,CAAC;AAED,MAAM,wBAAwB,GAAG,CAC/B,aAA2D,EACnC,EAAE,CAAC,CAAC;IAC5B,IAAI,EAAE,UAAU,GAAmB,EAAE,GAAsB;QACzD,OAAO,aAAa,CAAC,IAAI,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC;IACvC,CAAC;IACD,IAAI,EAAE,CAAC,IAAA,uBAAO,GAAE,EAAE,IAAA,yBAAS,EAAC,KAAK,EAAE,OAAO,CAAC,CAAC;IAC5C,MAAM,EAAE,KAAK;CACd,CAAC,CAAC;AAEH,SAAS,eAAe,CAAC,QAAgB;IACvC,OAAO;QACL,IAAI,EAAE,KAAK,WAET,GAAmB,EACnB,UAAqC,EACrC,IAAU;YAEV,MAAM,WAAW,GAAG,MAAM,IAAA,sBAAe,EACvC,IAAI,EACJ,QAAQ,EACR,IAAI,EACJ,IAAA,mCAAkB,EAAC,GAAG,CAAC,CACxB,CAAC;YACF,OAAO,IAAA,+BAAc,EACnB,IAA8B,EAC9B,GAAG,EACH,UAAU,EACV,IAAI,EACJ,WAAW,CACZ,CAAC;QACJ,CAAC;QACD,IAAI,EAAE,CAAC,IAAA,uBAAO,GAAE,EAAE,uBAAU,CAAC,IAAI,EAAE,EAAE,IAAA,eAAQ,GAAE,CAAC;QAChD,MAAM,EAAE,KAAc;KACvB,CAAC;AACJ,CAAC;AAED,SAAS,gBAAgB,CAAC,QAAgB;IACxC,OAAO;QACL,IAAI,EAAE,KAAK,WAET,GAAmB,EACnB,UAAqC,EACrC,IAAU;YAEV,MAAM,WAAW,GAAG,MAAM,IAAA,sBAAe,EACvC,IAAI,EACJ,QAAQ,EACR,IAAI,EACJ,IAAA,mCAAkB,EAAC,GAAG,CAAC,CACxB,CAAC;YACF,OAAO,IAAA,gCAAe,EACpB,IAA8B,EAC9B,GAAG,EACH,UAAU,EACV,IAAI,EACJ,WAAW,CACZ,CAAC;QACJ,CAAC;QACD,IAAI,EAAE,CAAC,IAAA,uBAAO,GAAE,EAAE,uBAAU,CAAC,IAAI,EAAE,EAAE,IAAA,eAAQ,GAAE,CAAC;QAChD,MAAM,EAAE,KAAc;KACvB,CAAC;AACJ,CAAC;AAED,SAAS,qBAAqB,CAAC,QAAgB;IAC7C,OAAO;QACL,IAAI,EAAE,KAAK,WAET,GAAmB,EACnB,IAAa,EACb,IAAU;YAEV,MAAM,MAAM,GAAG,mBAAmB,CAAC,IAAI,CAAC,CAAC;YACzC,MAAM,WAAW,GAAG,MAAM,IAAA,sBAAe,EACvC,IAAI,EACJ,QAAQ,EACR,IAAI,EACJ,IAAA,mCAAkB,EAAC,GAAG,CAAC,CACxB,CAAC;YACF,MAAM,IAAI,GAAG,IAAA,0CAAqB,EAAC,IAAI,CAAC,CAAC;YACzC,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,GAAG,CAC/B,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,EAAE,EAAE,EAAE,EAAE,KAAK,EAAE,EAAE,EAAE;gBACzC,MAAM,YAAY,GAAG,sBAAsB,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;gBACxD,MAAM,UAAU,GAAG;oBACjB,OAAO,EAAE,uBAAU,CAAC,cAAc,CAAC,YAAY,EAAE,IAAI,CAAC;iBACvD,CAAC;gBACF,MAAM,MAAM,GAAG,MAAM,IAAA,gCAAe,EAClC,IAA8B,EAC9B,YAAY,EACZ,UAAU,EACV,IAAI,EACJ,WAAW,CACZ,CAAC;gBACF,OAAO,CAAC,EAAE,EAAE,MAAM,CAAC,KAAK,CAAU,CAAC;YACrC,CAAC,CAAC,CACH,CAAC;YACF,OAAO,MAAM,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;QACrC,CAAC;QACD,IAAI,EAAE,CAAC,IAAA,uBAAO,GAAE,EAAE,IAAA,wBAAQ,GAAE,EAAE,IAAA,eAAQ,GAAE,CAAC;QACzC,MAAM,EAAE,MAAe;KACxB,CAAC;AACJ,CAAC;AAED,IAAiB,eAAe,CAmJ/B;AAnJD,WAAiB,eAAe;IACjB,mBAAG,GAAG,IAAA,8BAAmB,EACpC,IAAA,sBAAe,EAAC,kBAAW,EAAE,wBAAe,CAAC,CAC9C,CAAC;IACW,oBAAI,GAAG,eAAe,CAAC,kBAAW,CAAC,CAAC;IACpC,sBAAM,GAAG,kCAAa,CAAC,WAAW,CAC7C,eAAe,CAAC,oBAAa,CAAC,EAC9B;QACE,SAAS,EAAE,QAAQ;KACpB,CACF,CAAC;IACW,qBAAK,GAAG,gBAAgB,CAAC,kBAAW,CAAC,CAAC;IACtC,0BAAU,GAAG,kCAAa,CAAC,WAAW,CACjD,qBAAqB,CAAC,kBAAW,CAAC,EAClC,EAAE,EACF,cAAc,CACf,CAAC;IACW,mBAAG,GAAG,IAAA,+BAAoB,EACrC,EAAE,SAAS,EAAE,SAAS,EAAE,UAAU,EAAE,4BAAiB,EAAE,EACvD,IAAA,sBAAe,EACb,KAAK,EACL,IAAA,2BAAkB,EAAC,IAAA,yBAAiB,EAAC,kCAAa,CAAC,GAAG,CAAC,EAAE,KAAK,CAAC,CAChE,CACF,CAAC;IACW,oBAAI,GAAG,IAAA,+BAAoB,EACtC,EAAE,SAAS,EAAE,SAAS,EAAE,UAAU,EAAE,+BAAoB,EAAE,EAC1D,IAAA,sBAAe,EACb,MAAM,EACN,IAAA,2BAAkB,EAChB,IAAA,gCAAoB,EAAC,IAAA,yBAAiB,EAAC,kCAAa,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC,EACnE,MAAM,CACP,CACF,CACF,CAAC;IACW,sBAAM,GAAG,IAAA,+BAAoB,EACxC,EAAE,SAAS,EAAE,SAAS,EAAE,UAAU,EAAE,8BAAmB,EAAE,EACzD,IAAA,sBAAe,EACb,QAAQ,EACR,IAAA,2BAAkB,EAChB,IAAA,gCAAoB,EAClB,IAAA,yBAAiB,EAAC,kCAAa,CAAC,MAAM,EAAE,QAAQ,CAAC,EACjD,QAAQ,CACT,EACD,QAAQ,CACT,CACF,CACF,CAAC;IACW,uBAAO,GAAG,IAAA,+BAAoB,EACzC,EAAE,SAAS,EAAE,SAAS,EAAE,UAAU,EAAE,4BAAiB,EAAE,EACvD,IAAA,sBAAe,EACb,SAAS,EACT,IAAA,2BAAkB,EAChB,IAAA,gCAAoB,EAAC,wBAAwB,CAAC,4BAAW,CAAC,EAAE,SAAS,CAAC,EACtE,SAAS,CACV,CACF,CACF,CAAC;IACW,uBAAO,GAAG,IAAA,+BAAoB,EACzC,EAAE,SAAS,EAAE,SAAS,EAAE,UAAU,EAAE,4BAAiB,EAAE,EACvD,IAAA,sBAAe,EACb,SAAS,EACT,IAAA,2BAAkB,EAChB,IAAA,gCAAoB,EAAC,wBAAwB,CAAC,4BAAW,CAAC,EAAE,SAAS,CAAC,EACtE,SAAS,CACV,CACF,CACF,CAAC;IAEW,4BAAY,GAGrB;QACF,WAAW,EAAE,IAAA,6BAAsB,EACjC,QAAQ,EACR,kCAAa,CAAC,WAAW,CACvB;YAKE,IAAI,EAAE,UACJ,GAAmB,EACnB,UAAqC,EACrC,MAA0B,EAC1B,QAA4B,EAC5B,GAAa,EACb,IAAU;gBAEV,OAAO,IAAA,4BAAW,EAChB,IAAI,EACJ,GAAG,EACH,UAAU,EACV,MAAM,EACN,QAAQ,EACR,GAAG,EACH,IAAI,CACL,CAAC;YACJ,CAAC;YACD,IAAI,EAAE;gBACJ,IAAA,uBAAO,GAAE;gBACT,uBAAU,CAAC,IAAI,EAAE;gBACjB,IAAA,yBAAS,EAAC,QAAQ,EAAE,OAAO,CAAC;gBAC5B,IAAA,yBAAS,EAAC,UAAU,EAAE,OAAO,CAAC;gBAC9B,IAAA,8BAAc,EAAC,KAAK,EAAE,OAAO,CAAC;gBAC9B,IAAA,eAAQ,GAAE;aACX;YACD,MAAM,EAAE,KAAK;SACd,EACD,EAAE,SAAS,EAAE,QAAQ,EAAE,EACvB,eAAe,CAChB,CACF;QACD,YAAY,EAAE,IAAA,6BAAsB,EAAC,QAAQ,EAAE;YAC7C,QAAQ,EAAE,0BAA0B;YACpC,QAAQ,EAAE;gBACR,IAAI,EAAE,UAAU,GAAmB,EAAE,QAAgB,EAAE,IAAU;oBAC/D,OAAO,IAAA,gCAAe,EAAC,IAAI,EAAE,GAAG,EAAE,QAAQ,EAAE,IAAI,CAAC,CAAC;gBACpD,CAAC;gBACD,IAAI,EAAE,CAAC,IAAA,uBAAO,GAAE,EAAE,IAAA,yBAAS,EAAC,UAAU,EAAE,OAAO,CAAC,EAAE,IAAA,eAAQ,GAAE,CAAC;gBAC7D,MAAM,EAAE,KAAK;aACd;SACF,CAAC;QACF,cAAc,EAAE,IAAA,6BAAsB,EAAC,QAAQ,EAAE;YAC/C,QAAQ,EAAE,4BAA4B;YACtC,QAAQ,EAAE;gBACR,IAAI,EAAE,UAAU,GAAmB,EAAE,QAAgB,EAAE,IAAU;oBAC/D,OAAO,IAAA,+BAAc,EAAC,IAAI,EAAE,GAAG,EAAE,QAAQ,EAAE,IAAI,CAAC,CAAC;gBACnD,CAAC;gBACD,IAAI,EAAE,CAAC,IAAA,uBAAO,GAAE,EAAE,IAAA,yBAAS,EAAC,UAAU,EAAE,OAAO,CAAC,EAAE,IAAA,eAAQ,GAAE,CAAC;gBAC7D,MAAM,EAAE,KAAK;aACd;SACF,CAAC;KACH,CAAC;IAEW,mBAAG,GAAG;QACjB,GAAG,EAAE,gBAAA,GAAG;QACR,IAAI,EAAE,gBAAA,IAAI;QACV,MAAM,EAAE,gBAAA,MAAM;QACd,KAAK,EAAE,gBAAA,KAAK;QACZ,UAAU,EAAE,gBAAA,UAAU;QACtB,GAAG,EAAE,gBAAA,GAAG;QACR,IAAI,EAAE,gBAAA,IAAI;QACV,MAAM,EAAE,gBAAA,MAAM;QACd,OAAO,EAAE,gBAAA,OAAO;QAChB,OAAO,EAAE,gBAAA,OAAO;QAChB,GAAG,gBAAA,YAAY;KACP,CAAC;AACb,CAAC,EAnJgB,eAAe,+BAAf,eAAe,QAmJ/B"}

package/dist/base/table-view/row-rules.d.ts

@@ -0,0 +1,8 @@
+import type { DataControllerCallback } from "@antelopejs/interface-data-api";
+import type { RowActionRule } from "../types/row-action";
+import type { TableViewRowActionOptions } from "./options";
+type ValidatedActionName = "delete" | "edit" | "archive" | "restore";
+export declare const normalizeToArray: (value: string | string[]) => string[];
+export declare const extractRuleFromConfig: (controllerRules: TableViewRowActionOptions | undefined, actionName: ValidatedActionName) => RowActionRule | undefined;
+export declare const createValidatedRoute: (baseRoute: DataControllerCallback, actionName: ValidatedActionName) => DataControllerCallback;
+export {};

package/dist/base/table-view/row-rules.js

@@ -0,0 +1,95 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createValidatedRoute = exports.extractRuleFromConfig = exports.normalizeToArray = void 0;
+const interface_api_util_1 = require("@antelopejs/interface-api-util");
+const interface_core_1 = require("@antelopejs/interface-core");
+const data_functions_1 = require("./data-functions");
+const meta_1 = require("./meta");
+const options_1 = require("./options");
+var EmptyResultBehavior;
+(function (EmptyResultBehavior) {
+    EmptyResultBehavior[EmptyResultBehavior["Graceful"] = 0] = "Graceful";
+    EmptyResultBehavior[EmptyResultBehavior["Strict"] = 1] = "Strict";
+})(EmptyResultBehavior || (EmptyResultBehavior = {}));
+const normalizeToArray = (value) => Array.isArray(value) ? value : [value];
+exports.normalizeToArray = normalizeToArray;
+const ACTION_VALIDATION_CONFIGS = {
+    delete: {
+        extractIds: (params) => (0, exports.normalizeToArray)(params.id),
+        emptyResultBehavior: EmptyResultBehavior.Graceful,
+        emptyResult: { deleted: 0 },
+        transformParams: (params, eligibleIds) => ({
+            ...params,
+            id: eligibleIds,
+        }),
+    },
+    edit: {
+        extractIds: (params) => [params.id],
+        emptyResultBehavior: EmptyResultBehavior.Strict,
+    },
+    archive: {
+        extractIds: (_params, ids) => (0, exports.normalizeToArray)(ids),
+        emptyResultBehavior: EmptyResultBehavior.Graceful,
+        emptyResult: { success: true, archivedCount: 0 },
+        transformArgs: (_args, eligibleIds) => [eligibleIds],
+    },
+    restore: {
+        extractIds: (_params, ids) => (0, exports.normalizeToArray)(ids),
+        emptyResultBehavior: EmptyResultBehavior.Graceful,
+        emptyResult: { success: true, restoredCount: 0 },
+        transformArgs: (_args, eligibleIds) => [eligibleIds],
+    },
+};
+const getValidationContext = (controller) => {
+    const meta = (0, interface_core_1.GetMetadata)(controller.constructor, meta_1.TableViewMeta);
+    return {
+        rules: meta.controllerRowActionRules,
+        strictMode: meta.options.strictRuleValidation ?? false,
+        idField: meta.options.rowIdKey || options_1.DEFAULT_ROW_ID_FIELD,
+    };
+};
+const extractRuleFromConfig = (controllerRules, actionName) => {
+    const actionConfig = controllerRules?.[actionName];
+    if (typeof actionConfig === "object" && actionConfig !== null) {
+        return actionConfig.rule;
+    }
+    return undefined;
+};
+exports.extractRuleFromConfig = extractRuleFromConfig;
+const handleNoEligibleIds = (config, actionName) => {
+    if (config.emptyResultBehavior === EmptyResultBehavior.Strict) {
+        (0, interface_api_util_1.assert)(false, 403, `${actionName} not allowed: row does not satisfy action rules`);
+    }
+    return config.emptyResult;
+};
+const createValidatedRoute = (baseRoute, actionName) => {
+    const config = ACTION_VALIDATION_CONFIGS[actionName];
+    return {
+        func: async function (ctx, params, ...args) {
+            const validationCtx = getValidationContext(this);
+            if (!validationCtx.rules) {
+                return baseRoute.func.call(this, ctx, params, ...args);
+            }
+            const rule = (0, exports.extractRuleFromConfig)(validationCtx.rules, actionName);
+            if (!rule) {
+                return baseRoute.func.call(this, ctx, params, ...args);
+            }
+            const ids = config.extractIds(params, ...args);
+            const { eligibleIds } = await (0, data_functions_1.validateRowsAgainstRule)(this, ids, rule, validationCtx.strictMode, validationCtx.idField);
+            if (eligibleIds.length === 0) {
+                return handleNoEligibleIds(config, actionName);
+            }
+            const finalParams = config.transformParams
+                ? config.transformParams(params, eligibleIds)
+                : params;
+            const finalArgs = config.transformArgs
+                ? config.transformArgs(args, eligibleIds)
+                : args;
+            return baseRoute.func.call(this, ctx, finalParams, ...finalArgs);
+        },
+        args: baseRoute.args,
+        method: baseRoute.method,
+    };
+};
+exports.createValidatedRoute = createValidatedRoute;
+//# sourceMappingURL=row-rules.js.map

package/dist/base/table-view/row-rules.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"row-rules.js","sourceRoot":"","sources":["../../../src/base/table-view/row-rules.ts"],"names":[],"mappings":";;;AAIA,uEAA2E;AAC3E,+DAAyD;AAIzD,qDAA2D;AAC3D,iCAAuC;AAEvC,uCAAiD;AAIjD,IAAK,mBAGJ;AAHD,WAAK,mBAAmB;IACtB,qEAAY,CAAA;IACZ,iEAAU,CAAA;AACZ,CAAC,EAHI,mBAAmB,KAAnB,mBAAmB,QAGvB;AAUM,MAAM,gBAAgB,GAAG,CAAC,KAAwB,EAAY,EAAE,CACrE,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;AAD5B,QAAA,gBAAgB,oBACY;AAEzC,MAAM,yBAAyB,GAG3B;IACF,MAAM,EAAE;QACN,UAAU,EAAE,CAAC,MAAM,EAAE,EAAE,CACrB,IAAA,wBAAgB,EAAE,MAAsC,CAAC,EAAE,CAAC;QAC9D,mBAAmB,EAAE,mBAAmB,CAAC,QAAQ;QACjD,WAAW,EAAE,EAAE,OAAO,EAAE,CAAC,EAAE;QAC3B,eAAe,EAAE,CAAC,MAAM,EAAE,WAAW,EAAE,EAAE,CAAC,CAAC;YACzC,GAAI,MAAiB;YACrB,EAAE,EAAE,WAAW;SAChB,CAAC;KACH;IACD,IAAI,EAAE;QACJ,UAAU,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,CAAE,MAAoC,CAAC,EAAE,CAAC;QAClE,mBAAmB,EAAE,mBAAmB,CAAC,MAAM;KAChD;IACD,OAAO,EAAE;QACP,UAAU,EAAE,CAAC,OAAO,EAAE,GAAG,EAAE,EAAE,CAAC,IAAA,wBAAgB,EAAC,GAAwB,CAAC;QACxE,mBAAmB,EAAE,mBAAmB,CAAC,QAAQ;QACjD,WAAW,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,aAAa,EAAE,CAAC,EAAE;QAChD,aAAa,EAAE,CAAC,KAAK,EAAE,WAAW,EAAE,EAAE,CAAC,CAAC,WAAW,CAAC;KACrD;IACD,OAAO,EAAE;QACP,UAAU,EAAE,CAAC,OAAO,EAAE,GAAG,EAAE,EAAE,CAAC,IAAA,wBAAgB,EAAC,GAAwB,CAAC;QACxE,mBAAmB,EAAE,mBAAmB,CAAC,QAAQ;QACjD,WAAW,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,aAAa,EAAE,CAAC,EAAE;QAChD,aAAa,EAAE,CAAC,KAAK,EAAE,WAAW,EAAE,EAAE,CAAC,CAAC,WAAW,CAAC;KACrD;CACF,CAAC;AAQF,MAAM,oBAAoB,GAAG,CAAC,UAAmB,EAAqB,EAAE;IACtE,MAAM,IAAI,GAAG,IAAA,4BAAW,EACrB,UAA+C,CAAC,WAAW,EAC5D,oBAAa,CACd,CAAC;IACF,OAAO;QACL,KAAK,EAAE,IAAI,CAAC,wBAAwB;QACpC,UAAU,EAAE,IAAI,CAAC,OAAO,CAAC,oBAAoB,IAAI,KAAK;QACtD,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,QAAQ,IAAI,8BAAoB;KACvD,CAAC;AACJ,CAAC,CAAC;AAEK,MAAM,qBAAqB,GAAG,CACnC,eAAsD,EACtD,UAA+B,EACJ,EAAE;IAC7B,MAAM,YAAY,GAAG,eAAe,EAAE,CAAC,UAAU,CAAC,CAAC;IACnD,IAAI,OAAO,YAAY,KAAK,QAAQ,IAAI,YAAY,KAAK,IAAI,EAAE,CAAC;QAC9D,OAAO,YAAY,CAAC,IAAI,CAAC;IAC3B,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC,CAAC;AATW,QAAA,qBAAqB,yBAShC;AAEF,MAAM,mBAAmB,GAAG,CAC1B,MAA8B,EAC9B,UAA+B,EACtB,EAAE;IACX,IAAI,MAAM,CAAC,mBAAmB,KAAK,mBAAmB,CAAC,MAAM,EAAE,CAAC;QAC9D,IAAA,2BAAe,EACb,KAAK,EACL,GAAG,EACH,GAAG,UAAU,iDAAiD,CAC/D,CAAC;IACJ,CAAC;IACD,OAAO,MAAM,CAAC,WAAW,CAAC;AAC5B,CAAC,CAAC;AAEK,MAAM,oBAAoB,GAAG,CAClC,SAAiC,EACjC,UAA+B,EACP,EAAE;IAC1B,MAAM,MAAM,GAAG,yBAAyB,CAAC,UAAU,CAAC,CAAC;IAErD,OAAO;QACL,IAAI,EAAE,KAAK,WAET,GAAmB,EACnB,MAAe,EACf,GAAG,IAAe;YAElB,MAAM,aAAa,GAAG,oBAAoB,CAAC,IAAI,CAAC,CAAC;YAEjD,IAAI,CAAC,aAAa,CAAC,KAAK,EAAE,CAAC;gBACzB,OAAO,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC,CAAC;YACzD,CAAC;YAED,MAAM,IAAI,GAAG,IAAA,6BAAqB,EAAC,aAAa,CAAC,KAAK,EAAE,UAAU,CAAC,CAAC;YAEpE,IAAI,CAAC,IAAI,EAAE,CAAC;gBACV,OAAO,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC,CAAC;YACzD,CAAC;YAED,MAAM,GAAG,GAAG,MAAM,CAAC,UAAU,CAAC,MAAM,EAAE,GAAG,IAAI,CAAC,CAAC;YAC/C,MAAM,EAAE,WAAW,EAAE,GAAG,MAAM,IAAA,wCAAuB,EACnD,IAA8B,EAC9B,GAAG,EACH,IAAI,EACJ,aAAa,CAAC,UAAU,EACxB,aAAa,CAAC,OAAO,CACtB,CAAC;YAEF,IAAI,WAAW,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBAC7B,OAAO,mBAAmB,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;YACjD,CAAC;YAED,MAAM,WAAW,GAAG,MAAM,CAAC,eAAe;gBACxC,CAAC,CAAC,MAAM,CAAC,eAAe,CAAC,MAAM,EAAE,WAAW,CAAC;gBAC7C,CAAC,CAAC,MAAM,CAAC;YAEX,MAAM,SAAS,GAAG,MAAM,CAAC,aAAa;gBACpC,CAAC,CAAC,MAAM,CAAC,aAAa,CAAC,IAAI,EAAE,WAAW,CAAC;gBACzC,CAAC,CAAC,IAAI,CAAC;YAET,OAAO,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,GAAG,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC;QACnE,CAAC;QACD,IAAI,EAAE,SAAS,CAAC,IAAI;QACpB,MAAM,EAAE,SAAS,CAAC,MAAM;KACzB,CAAC;AACJ,CAAC,CAAC;AAnDW,QAAA,oBAAoB,wBAmD/B"}