@antelopejs/interface-dms 0.9.0 → 0.10.0

package/dist/base/table-view/internal/meta-helpers.js

@@ -0,0 +1,75 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.buildTableConfig = buildTableConfig;
+exports.decorateColumn = decorateColumn;
+/** @internal */
+const node_assert_1 = __importDefault(require("node:assert"));
+const interface_api_1 = require("@antelopejs/interface-api");
+const interface_core_1 = require("@antelopejs/interface-core");
+const metadata_1 = require("@antelopejs/interface-data-api/metadata");
+const interface_database_decorators_1 = require("@antelopejs/interface-database-decorators");
+const form_schema_1 = require("../../form-schema");
+const types_1 = require("../../types");
+const column_display_1 = require("./column-display");
+/** @internal */
+function buildTableConfig(view, serialize) {
+    // oxlint-disable-next-line anti-slop/require-safety-comment-for-type-assertion -- The published target constructor type does not establish ControllerClass.location; registration is assumed rather than validated here.
+    const apimeta = (0, interface_core_1.GetMetadata)(view.target, interface_api_1.ControllerMeta);
+    const datameta = (0, interface_core_1.GetMetadata)(view.target, metadata_1.DataAPIMeta);
+    return {
+        location: apimeta.location,
+        columns: Object.entries(view.columns)
+            .sort((a, b) => (a[1].order ?? 0) - (b[1].order ?? 0))
+            .map(([key, options]) => {
+            const meta = datameta.fields[key];
+            return {
+                id: key,
+                header: options.name ?? key,
+                isVisible: options.isVisible,
+                type: serialize(options.type),
+                accessorKey: key,
+                listable: !!meta.listable?.list,
+                enableSorting: meta.sortable !== undefined,
+                enableColumnFilter: !!options.filterable,
+                cellWrap: options.cellWrap,
+                size: options.size,
+                display: (0, column_display_1.serializeColumnDisplay)(options.display),
+                defaultValue: options.defaultValue,
+                accessMode: meta.mode,
+                readonlyBehavior: options.readonlyBehavior ?? types_1.ReadonlyBehaviorType.default,
+            };
+        }),
+    };
+}
+/** @internal */
+function decorateColumn(target, key, descriptor, options, meta) {
+    // oxlint-disable-next-line anti-slop/require-safety-comment-for-type-assertion -- The decorator accepts PropertyKey while the column registry, the localization lookup and Filter take string keys; symbol and number inputs are not rejected or converted here.
+    const columnKey = key;
+    meta.setColumn(columnKey, options);
+    if (options.validate !== false) {
+        // oxlint-disable-next-line typescript/unbound-method -- This assertion checks method presence without calling it; getValidation is called through options.type below.
+        (0, node_assert_1.default)(options.type.getValidation, "Type has no getValidation method");
+        const dataMeta = (0, interface_core_1.GetMetadata)(target.constructor, metadata_1.DataAPIMeta);
+        const localizedFields = (0, interface_database_decorators_1.getModifiedFields)(dataMeta.tableClass.prototype, interface_database_decorators_1.LocalizationModifier);
+        const isLocalized = localizedFields.includes(key);
+        const baseSchema = options.type.getValidation();
+        const zodSchema = (0, form_schema_1.adaptFieldValidationSchema)(baseSchema, {
+            localized: isLocalized,
+            required: false,
+            fallbackLocale: isLocalized
+                ? interface_database_decorators_1.LocalizationModifier.fallbackLocaleOf(dataMeta.tableClass, columnKey)
+                : undefined,
+        });
+        (0, metadata_1.Validator)((value) => zodSchema.safeParseAsync(value))(target, key, descriptor ?? {});
+    }
+    if (options.filterable) {
+        (0, metadata_1.Filter)(options.type.filter.bind(options.type))(target, columnKey);
+    }
+    if (options.type.decorateField) {
+        options.type.decorateField(target, key, descriptor);
+    }
+}
+//# sourceMappingURL=meta-helpers.js.map

package/dist/base/table-view/internal/meta-helpers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"meta-helpers.js","sourceRoot":"","sources":["../../../../src/base/table-view/internal/meta-helpers.ts"],"names":[],"mappings":";;;;;AA4BA,4CAkCC;AAGD,wCA6CC;AA9GD,gBAAgB;AAChB,8DAAiC;AACjC,6DAGmC;AACnC,+DAAyD;AAEzD,sEAIiD;AACjD,6FAGmD;AAEnD,mDAA+D;AAC/D,uCAAmD;AAEnD,qDAA0D;AAM1D,gBAAgB;AAChB,SAAgB,gBAAgB,CAC9B,IAAmB,EACnB,SAA+B;IAE/B,yNAAyN;IACzN,MAAM,OAAO,GAAG,IAAA,4BAAW,EAAC,IAAI,CAAC,MAAyB,EAAE,8BAAc,CAAC,CAAC;IAC5E,MAAM,QAAQ,GAAG,IAAA,4BAAW,EAAC,IAAI,CAAC,MAAM,EAAE,sBAAW,CAAC,CAAC;IAEvD,OAAO;QACL,QAAQ,EAAE,OAAO,CAAC,QAAQ;QAC1B,OAAO,EAAE,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC;aAClC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC,CAAC,CAAC;aACrD,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,OAAO,CAAC,EAAE,EAAE;YACtB,MAAM,IAAI,GAAG,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;YAElC,OAAO;gBACL,EAAE,EAAE,GAAG;gBACP,MAAM,EAAE,OAAO,CAAC,IAAI,IAAI,GAAG;gBAC3B,SAAS,EAAE,OAAO,CAAC,SAAS;gBAC5B,IAAI,EAAE,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC;gBAC7B,WAAW,EAAE,GAAG;gBAChB,QAAQ,EAAE,CAAC,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI;gBAC/B,aAAa,EAAE,IAAI,CAAC,QAAQ,KAAK,SAAS;gBAC1C,kBAAkB,EAAE,CAAC,CAAC,OAAO,CAAC,UAAU;gBACxC,QAAQ,EAAE,OAAO,CAAC,QAAQ;gBAC1B,IAAI,EAAE,OAAO,CAAC,IAAI;gBAClB,OAAO,EAAE,IAAA,uCAAsB,EAAC,OAAO,CAAC,OAAO,CAAC;gBAChD,YAAY,EAAE,OAAO,CAAC,YAAY;gBAClC,UAAU,EAAE,IAAI,CAAC,IAAI;gBACrB,gBAAgB,EACd,OAAO,CAAC,gBAAgB,IAAI,4BAAoB,CAAC,OAAO;aAC3D,CAAC;QACJ,CAAC,CAAC;KACL,CAAC;AACJ,CAAC;AAED,gBAAgB;AAChB,SAAgB,cAAc,CAC5B,MAAkC,EAClC,GAA+B,EAC/B,UAAsC,EACtC,OAAsB,EACtB,IAAmB;IAEnB,iQAAiQ;IACjQ,MAAM,SAAS,GAAG,GAAa,CAAC;IAChC,IAAI,CAAC,SAAS,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;IAEnC,IAAI,OAAO,CAAC,QAAQ,KAAK,KAAK,EAAE,CAAC;QAC/B,sKAAsK;QACtK,IAAA,qBAAM,EAAC,OAAO,CAAC,IAAI,CAAC,aAAa,EAAE,kCAAkC,CAAC,CAAC;QAEvE,MAAM,QAAQ,GAAG,IAAA,4BAAW,EAAC,MAAM,CAAC,WAAW,EAAE,sBAAW,CAAC,CAAC;QAC9D,MAAM,eAAe,GAAG,IAAA,iDAAiB,EACvC,QAAQ,CAAC,UAAU,CAAC,SAAS,EAC7B,oDAAoB,CACrB,CAAC;QACF,MAAM,WAAW,GAAG,eAAe,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;QAElD,MAAM,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC,aAAa,EAAE,CAAC;QAChD,MAAM,SAAS,GAAG,IAAA,wCAA0B,EAAC,UAAU,EAAE;YACvD,SAAS,EAAE,WAAW;YACtB,QAAQ,EAAE,KAAK;YACf,cAAc,EAAE,WAAW;gBACzB,CAAC,CAAC,oDAAoB,CAAC,gBAAgB,CAAC,QAAQ,CAAC,UAAU,EAAE,SAAS,CAAC;gBACvE,CAAC,CAAC,SAAS;SACd,CAAC,CAAC;QAEH,IAAA,oBAAS,EAAC,CAAC,KAAK,EAAE,EAAE,CAAC,SAAS,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC,CACnD,MAAM,EACN,GAAG,EACH,UAAU,IAAI,EAAE,CACjB,CAAC;IACJ,CAAC;IAED,IAAI,OAAO,CAAC,UAAU,EAAE,CAAC;QACvB,IAAA,iBAAM,EAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;IACpE,CAAC;IAED,IAAI,OAAO,CAAC,IAAI,CAAC,aAAa,EAAE,CAAC;QAC/B,OAAO,CAAC,IAAI,CAAC,aAAa,CAAC,MAAM,EAAE,GAAG,EAAE,UAAU,CAAC,CAAC;IACtD,CAAC;AACH,CAAC"}

package/dist/base/table-view/internal/meta.js

@@ -5,9 +5,15 @@ const interface_api_1 = require("@antelopejs/interface-api");
 const interface_core_1 = require("@antelopejs/interface-core");
 const meta_1 = require("../meta");
 /** @internal */
-const getTableViewMetaFor = (target) => (0, interface_core_1.GetMetadata)(target.constructor, meta_1.TableViewMeta);
+// oxlint-disable-next-line anti-slop/no-unknown-parameters -- This published adapter accepts arbitrary controller receivers; the metadata lookup below assumes a registered constructor without validating it.
+const getTableViewMetaFor = (target) => (0, interface_core_1.GetMetadata)(
+// oxlint-disable-next-line anti-slop/require-safety-comment-for-type-assertion -- The published unknown receiver does not prove ControllerClass; controller route dispatch supplies it and this adapter preserves that unchecked boundary.
+target.constructor, meta_1.TableViewMeta);
 exports.getTableViewMetaFor = getTableViewMetaFor;
 /** @internal */
-const getControllerLocation = (target) => (0, interface_core_1.GetMetadata)(target.constructor, interface_api_1.ControllerMeta).location;
+// oxlint-disable-next-line anti-slop/no-unknown-parameters -- This published metadata adapter accepts arbitrary controller receivers; narrowing its input would change that contract.
+const getControllerLocation = (target) => (0, interface_core_1.GetMetadata)(
+// oxlint-disable-next-line anti-slop/require-safety-comment-for-type-assertion -- The published unknown receiver does not verify its constructor; route dispatch remains responsible for supplying a controller instance.
+target.constructor, interface_api_1.ControllerMeta).location;
 exports.getControllerLocation = getControllerLocation;
 //# sourceMappingURL=meta.js.map

package/dist/base/table-view/internal/meta.js.map

@@ -1 +1 @@
-{"version":3,"file":"meta.js","sourceRoot":"","sources":["../../../../src/base/table-view/internal/meta.ts"],"names":[],"mappings":";;;AAAA,6DAGmC;AACnC,+DAAyD;AACzD,kCAAwC;AAExC,gBAAgB;AACT,MAAM,mBAAmB,GAAG,CAAC,MAAe,EAAiB,EAAE,CACpE,IAAA,4BAAW,EACR,MAA2C,CAAC,WAAW,EACxD,oBAAa,CACd,CAAC;AAJS,QAAA,mBAAmB,uBAI5B;AAEJ,gBAAgB;AACT,MAAM,qBAAqB,GAAG,CAAC,MAAe,EAAU,EAAE,CAC/D,IAAA,4BAAW,EACR,MAA2C,CAAC,WAAW,EACxD,8BAAc,CACf,CAAC,QAAQ,CAAC;AAJA,QAAA,qBAAqB,yBAIrB"}
+{"version":3,"file":"meta.js","sourceRoot":"","sources":["../../../../src/base/table-view/internal/meta.ts"],"names":[],"mappings":";;;AAAA,6DAGmC;AACnC,+DAAyD;AACzD,kCAAwC;AAExC,gBAAgB;AAChB,+MAA+M;AACxM,MAAM,mBAAmB,GAAG,CAAC,MAAe,EAAiB,EAAE,CACpE,IAAA,4BAAW;AACT,2OAA2O;AAC1O,MAA2C,CAAC,WAAW,EACxD,oBAAa,CACd,CAAC;AALS,QAAA,mBAAmB,uBAK5B;AAEJ,gBAAgB;AAChB,sLAAsL;AAC/K,MAAM,qBAAqB,GAAG,CAAC,MAAe,EAAU,EAAE,CAC/D,IAAA,4BAAW;AACT,0NAA0N;AACzN,MAA2C,CAAC,WAAW,EACxD,8BAAc,CACf,CAAC,QAAQ,CAAC;AALA,QAAA,qBAAqB,yBAKrB"}

package/dist/base/table-view/internal/nav-badges.js

@@ -1,6 +1,4 @@
 "use strict";
-// The navigation badges a table view publishes: the counter of a tab declared
-// with `navBadge`, counted on the server when the menu loads.
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.declareTabNavBadges = declareTabNavBadges;
 const interface_api_1 = require("@antelopejs/interface-api");
@@ -37,11 +35,14 @@ async function countRows(controller, ctx, user, filter) {
     const permissions = await (0, auth_1.authorizeAction)(instance, auth_1.LIST_ACTION, user, (0, request_tenant_1.getRequestTenantId)(ctx));
     const queryContext = withQuery(ctx, tabFilterQuery(filter));
     const filters = components_1.Parameters.ExtractFilters(queryContext, (0, interface_data_api_1.GetDataControllerMeta)(instance));
-    const { total } = await (0, data_functions_1.countWithSearch)(instance, queryContext, { filters }, user, permissions);
+    const { total } = await (0, data_functions_1.countWithSearch)(
+    // oxlint-disable-next-line anti-slop/require-safety-comment-for-type-assertion -- GetControllerInstance returns an instance, while the published runtime proxy accepts DataControllerCallback as its receiver type; that mismatch is not validated here.
+    instance, queryContext, { filters }, user, permissions);
     return total;
 }
 /** The tab's count in the tone its `navBadge` declares; a bare count without one. */
 function withTabTone(tab) {
+    // oxlint-disable-next-line anti-slop/no-runtime-typeof -- The published navBadge option declares a boolean shorthand or an object with a tone; this selects the object variant.
     const tone = typeof tab.navBadge === "object" ? tab.navBadge.tone : undefined;
     return (count) => (tone ? { count, tone } : count);
 }
@@ -58,6 +59,7 @@ function navBadgeSourceOf(tab, controller) {
         };
     }
     const { to, countFrom } = tab;
+    // oxlint-disable-next-line anti-slop/no-runtime-typeof -- Published tab targets and count sources may be strings or controller classes; navigation badges require the class variants.
     if (typeof to === "string" || !countFrom || typeof countFrom === "string") {
         logging_1.Logging.Warn(`[DMS] TableView on "${controller.name}": tab "${tab.id}" sets navBadge but links to a path or counts from a location; a navigation badge needs a page controller \`to\` and a data controller \`countFrom\`. It publishes nothing.`);
         return undefined;

package/dist/base/table-view/internal/nav-badges.js.map

@@ -1 +1 @@
-{"version":3,"file":"nav-badges.js","sourceRoot":"","sources":["../../../../src/base/table-view/internal/nav-badges.ts"],"names":[],"mappings":";AAAA,8EAA8E;AAC9E,8DAA8D;;AA4H9D,kDAUC;AApID,6DAImC;AACnC,gEAA6D;AAC7D,uEAGwC;AACxC,0EAAuE;AAOvE,4DAA6D;AAC7D,iCAAsD;AACtD,sDAAoD;AAGpD,MAAM,mBAAmB,GAAG,SAAS,CAAC;AAEtC,qFAAqF;AACrF,SAAS,cAAc,CACrB,MAAsC;IAEtC,IAAI,CAAC,MAAM;QAAE,OAAO,EAAE,CAAC;IACvB,OAAO;QACL,CAAC,GAAG,mBAAmB,GAAG,MAAM,CAAC,WAAW,EAAE,CAAC,EAAE,GAAG,MAAM,CAAC,IAAI,IAAI,MAAM,CAAC,KAAK,IAAI,EAAE,EAAE;KACxF,CAAC;AACJ,CAAC;AAED,SAAS,SAAS,CAChB,GAAmB,EACnB,KAA6B;IAE7B,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,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;IACnC,CAAC;IACD,OAAO,EAAE,GAAG,GAAG,EAAE,GAAG,EAAE,CAAC;AACzB,CAAC;AAED;;;;GAIG;AACH,KAAK,UAAU,SAAS,CACtB,UAA2B,EAC3B,GAAmB,EACnB,IAAU,EACV,MAAsC;IAEtC,MAAM,QAAQ,GAAG,MAAM,IAAA,qCAAqB,EAAC,UAAU,EAAE,GAAG,CAAC,CAAC;IAC9D,MAAM,WAAW,GAAG,MAAM,IAAA,sBAAe,EACvC,QAAQ,EACR,kBAAW,EACX,IAAI,EACJ,IAAA,mCAAkB,EAAC,GAAG,CAAC,CACxB,CAAC;IACF,MAAM,YAAY,GAAG,SAAS,CAAC,GAAG,EAAE,cAAc,CAAC,MAAM,CAAC,CAAC,CAAC;IAC5D,MAAM,OAAO,GAAG,uBAAU,CAAC,cAAc,CACvC,YAAY,EACZ,IAAA,0CAAqB,EAAC,QAAQ,CAAC,CAChC,CAAC;IACF,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,IAAA,gCAAe,EACrC,QAAkC,EAClC,YAAY,EACZ,EAAE,OAAO,EAAE,EACX,IAAI,EACJ,WAAW,CACZ,CAAC;IACF,OAAO,KAAK,CAAC;AACf,CAAC;AAED,qFAAqF;AACrF,SAAS,WAAW,CAClB,GAAiB;IAEjB,MAAM,IAAI,GAAG,OAAO,GAAG,CAAC,QAAQ,KAAK,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;IAC9E,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;AACrD,CAAC;AAED;;;;;GAKG;AACH,SAAS,gBAAgB,CACvB,GAAiB,EACjB,UAA2B;IAE3B,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC;QACZ,OAAO;YACL,KAAK,EAAE,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE,CACnB,SAAS,CAAC,UAAU,EAAE,GAAG,EAAE,IAAI,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;SACtE,CAAC;IACJ,CAAC;IACD,MAAM,EAAE,EAAE,EAAE,SAAS,EAAE,GAAG,GAAG,CAAC;IAC9B,IAAI,OAAO,EAAE,KAAK,QAAQ,IAAI,CAAC,SAAS,IAAI,OAAO,SAAS,KAAK,QAAQ,EAAE,CAAC;QAC1E,iBAAO,CAAC,IAAI,CACV,uBAAuB,UAAU,CAAC,IAAI,WAAW,GAAG,CAAC,EAAE,6KAA6K,CACrO,CAAC;QACF,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,OAAO;QACL,IAAI,EAAE,EAAE;QACR,KAAK,EAAE,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE,CACnB,SAAS,CAAC,SAAS,EAAE,GAAG,EAAE,IAAI,EAAE,SAAS,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;KACpE,CAAC;AACJ,CAAC;AAED;;;;GAIG;AACH,SAAgB,mBAAmB,CACjC,OAA4B,EAC5B,IAAgC,EAChC,UAA2B;IAE3B,KAAK,MAAM,GAAG,IAAI,IAAI,IAAI,EAAE,EAAE,CAAC;QAC7B,IAAI,CAAC,GAAG,CAAC,QAAQ;YAAE,SAAS;QAC5B,MAAM,MAAM,GAAG,gBAAgB,CAAC,GAAG,EAAE,UAAU,CAAC,CAAC;QACjD,IAAI,MAAM;YAAE,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;IACvC,CAAC;AACH,CAAC"}
+{"version":3,"file":"nav-badges.js","sourceRoot":"","sources":["../../../../src/base/table-view/internal/nav-badges.ts"],"names":[],"mappings":";;AA2HA,kDAUC;AArID,6DAImC;AACnC,gEAA6D;AAC7D,uEAGwC;AACxC,0EAAuE;AAOvE,4DAA6D;AAC7D,iCAAsD;AACtD,sDAAoD;AAGpD,MAAM,mBAAmB,GAAG,SAAS,CAAC;AAEtC,qFAAqF;AACrF,SAAS,cAAc,CAAC,MAAsC;IAC5D,IAAI,CAAC,MAAM;QAAE,OAAO,EAAE,CAAC;IACvB,OAAO;QACL,CAAC,GAAG,mBAAmB,GAAG,MAAM,CAAC,WAAW,EAAE,CAAC,EAAE,GAAG,MAAM,CAAC,IAAI,IAAI,MAAM,CAAC,KAAK,IAAI,EAAE,EAAE;KACxF,CAAC;AACJ,CAAC;AAED,SAAS,SAAS,CAChB,GAAmB,EACnB,KAA6B;IAE7B,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,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;IACnC,CAAC;IACD,OAAO,EAAE,GAAG,GAAG,EAAE,GAAG,EAAE,CAAC;AACzB,CAAC;AAED;;;;GAIG;AACH,KAAK,UAAU,SAAS,CACtB,UAA2B,EAC3B,GAAmB,EACnB,IAAU,EACV,MAAsC;IAEtC,MAAM,QAAQ,GAAG,MAAM,IAAA,qCAAqB,EAAC,UAAU,EAAE,GAAG,CAAC,CAAC;IAC9D,MAAM,WAAW,GAAG,MAAM,IAAA,sBAAe,EACvC,QAAQ,EACR,kBAAW,EACX,IAAI,EACJ,IAAA,mCAAkB,EAAC,GAAG,CAAC,CACxB,CAAC;IACF,MAAM,YAAY,GAAG,SAAS,CAAC,GAAG,EAAE,cAAc,CAAC,MAAM,CAAC,CAAC,CAAC;IAC5D,MAAM,OAAO,GAAG,uBAAU,CAAC,cAAc,CACvC,YAAY,EACZ,IAAA,0CAAqB,EAAC,QAAQ,CAAC,CAChC,CAAC;IACF,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,IAAA,gCAAe;IACrC,yPAAyP;IACzP,QAAkC,EAClC,YAAY,EACZ,EAAE,OAAO,EAAE,EACX,IAAI,EACJ,WAAW,CACZ,CAAC;IACF,OAAO,KAAK,CAAC;AACf,CAAC;AAED,qFAAqF;AACrF,SAAS,WAAW,CAClB,GAAiB;IAEjB,gLAAgL;IAChL,MAAM,IAAI,GAAG,OAAO,GAAG,CAAC,QAAQ,KAAK,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;IAC9E,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;AACrD,CAAC;AAED;;;;;GAKG;AACH,SAAS,gBAAgB,CACvB,GAAiB,EACjB,UAA2B;IAE3B,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC;QACZ,OAAO;YACL,KAAK,EAAE,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE,CACnB,SAAS,CAAC,UAAU,EAAE,GAAG,EAAE,IAAI,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;SACtE,CAAC;IACJ,CAAC;IACD,MAAM,EAAE,EAAE,EAAE,SAAS,EAAE,GAAG,GAAG,CAAC;IAC9B,sLAAsL;IACtL,IAAI,OAAO,EAAE,KAAK,QAAQ,IAAI,CAAC,SAAS,IAAI,OAAO,SAAS,KAAK,QAAQ,EAAE,CAAC;QAC1E,iBAAO,CAAC,IAAI,CACV,uBAAuB,UAAU,CAAC,IAAI,WAAW,GAAG,CAAC,EAAE,6KAA6K,CACrO,CAAC;QACF,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,OAAO;QACL,IAAI,EAAE,EAAE;QACR,KAAK,EAAE,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE,CACnB,SAAS,CAAC,SAAS,EAAE,GAAG,EAAE,IAAI,EAAE,SAAS,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;KACpE,CAAC;AACJ,CAAC;AAED;;;;GAIG;AACH,SAAgB,mBAAmB,CACjC,OAA4B,EAC5B,IAAgC,EAChC,UAA2B;IAE3B,KAAK,MAAM,GAAG,IAAI,IAAI,IAAI,EAAE,EAAE,CAAC;QAC7B,IAAI,CAAC,GAAG,CAAC,QAAQ;YAAE,SAAS;QAC5B,MAAM,MAAM,GAAG,gBAAgB,CAAC,GAAG,EAAE,UAAU,CAAC,CAAC;QACjD,IAAI,MAAM;YAAE,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;IACvC,CAAC;AACH,CAAC"}

package/dist/base/table-view/internal/option-contract.d.ts

@@ -0,0 +1,403 @@
+/** @internal @packageDocumentation */
+import type { CustomButtonSerialized, CustomButton } from "../../types/custom-button";
+import type { TableViewRowActionOptionsSerialized, TableViewRowActionOptions } from "./option-row-actions";
+import type { ComponentInfoSerialized } from "../../../component";
+import type { FormPropsSerialized } from "../../form-types";
+import type { QueryParamFilters, RouteParamFilters, TableViewLayout, TableViewQuickFilter, TableViewPaginationMode, TableViewReorderOptions } from "./option-filtering";
+import type { TableViewTabSerialized, TableViewViewsSerialized, TableViewRowClick, TableViewColumnsOptions, TableViewTab, TableViewViewsOptions } from "./option-views";
+import type { TableViewDisplayOptionSerialized, KanbanOptions, GroupedOptions, TableViewCardOptions, TableViewDisplayOption } from "./option-displays";
+import type { TableViewFormPageUrls, FormContainer, TableViewFormSetup } from "./option-forms";
+import type { TableViewExpandableSerialized, TableViewExpandableOptions } from "./option-expandable";
+import type { TableViewFooterSerialized, TableViewFooterOptions } from "./option-footer";
+import type { TableViewEmptyStatesSerialized, TableViewEmptyStates } from "./option-empty-states";
+import type { TableViewSourceSerialized } from "../source";
+import type { RowActionRule } from "../../types/row-action";
+import type { TableViewGuards } from "../../types/guards";
+export interface TableViewOptionsSerialized extends Omit<TableViewOptions, "columns" | "customButtons" | "rowActions" | "kanban" | "displays" | "formSlots" | "forms" | "expandable" | "tabs" | "views" | "footer" | "emptyStates"> {
+    enableTableExport: boolean;
+    /** Whether the controller declares `@Searchable` fields to search in. */
+    searchable: boolean;
+    customButtons?: CustomButtonSerialized[];
+    defaultFilters?: Array<{
+        accessorKey: string;
+        value?: string;
+        mode: string;
+    }>;
+    rowActions?: TableViewRowActionOptionsSerialized;
+    formComponents: Record<string, ComponentInfoSerialized<FormPropsSerialized> | undefined>;
+    defaultSort?: {
+        field: string;
+        desc?: boolean;
+    };
+    queryParamFilters?: QueryParamFilters;
+    routeParamFilters?: RouteParamFilters;
+    tabs?: TableViewTabSerialized[];
+    displays?: TableViewDisplayOptionSerialized[];
+    /**
+     * Resolved page-mode form URLs. Server-computed, so the frontend navigates to
+     * the very URLs the form sub-pages were registered under instead of rebuilding
+     * them from the browser path. Absent when the container is not a page.
+     */
+    formPages?: TableViewFormPageUrls;
+    expandable?: TableViewExpandableSerialized;
+    views?: TableViewViewsSerialized;
+    footer?: TableViewFooterSerialized;
+    emptyStates?: TableViewEmptyStatesSerialized;
+    /** Where a `TableView.fromSource` table reads its rows. */
+    source?: TableViewSourceSerialized;
+    /**
+     * Key of the table view in its page, which prefixes its URL keys
+     * (`?<tableId>.view=`). Set per request.
+     */
+    tableId?: string;
+    /**
+     * The table view is the only one its page carries: the short URL keys
+     * (`?view=`, `?tab=`) are its own. Set per request.
+     */
+    isSoleTableView?: boolean;
+}
+/**
+ * When a `liveHold` table also holds its rows while its live page is in
+ * Direct: the table alone keeps them and counts its events into the
+ * "N new · Show" banner, the other blocks of the page staying live. The
+ * banner says why the table holds ("Table on hold · search active"). It reads
+ * the rows once again when the hold ends, if it missed any.
+ */
+export interface TableViewLiveHoldOptions {
+    /** While one of its rows is open in the side panel. Defaults to false. */
+    whileRowOpen?: boolean;
+    /** While the user has scrolled its first row out of view. Defaults to false. */
+    whileScrolled?: boolean;
+    /** While the user's search narrows the rows. Defaults to false. */
+    whileSearching?: boolean;
+    /**
+     * While the user sorts the rows otherwise than by the table's `defaultSort`
+     * (the newest first, for a log): new rows would land anywhere among them.
+     * Defaults to false.
+     */
+    whileSorted?: boolean;
+    /**
+     * What the strip calls the new rows, given `{count}`, as the `LiveToggle`'s
+     * own `missedLabel`: an i18n key prefixed with `$`
+     * (`"$api.live.new_requests"`, "12 new requests"), or a text. While the
+     * page is paused, the strip adds the breakdown a component gave with
+     * `usePageLive().setMissedDetail` ("12 new requests · 2 in 5xx").
+     * Defaults to "N new".
+     */
+    missedLabel?: string;
+}
+export interface TableViewOptions<T extends Record<string, unknown> = Record<string, unknown>> {
+    caption?: string;
+    /**
+     * Row density the table opens with: "compact" gives 36px rows under a 32px
+     * header. The user picks another from the "Density" entry of the ⋯ table
+     * menu, kept with the rest of the table's state.
+     */
+    density?: "default" | "compact";
+    /**
+     * Caps the rows in a scroll area of their own (any CSS length, e.g.
+     * "60vh"), under a column header that stays in view while they scroll.
+     */
+    maxHeight?: string;
+    /**
+     * What runs the row's click action: a double-click by default, a single
+     * click with `"single"`. See {@link TableViewRowClick}.
+     * @example "single"
+     */
+    rowClick?: TableViewRowClick;
+    /**
+     * Expandable rows: a caret column in front of the content opens a detail
+     * band under each row, listing `fields` or rendering `component`.
+     * @example { fields: ["address", "carrier"], defaultExpanded: "first" }
+     * @example { component: CustomComponent("OrderLines"), single: true }
+     */
+    expandable?: TableViewExpandableOptions;
+    /**
+     * How much the table draws around its rows: `"full"` (the default) or the
+     * `"compact"` list of a settings page. See {@link TableViewLayout}.
+     */
+    layout?: TableViewLayout;
+    /** Placeholder of the search field. `$`-prefixed: an i18n key. */
+    searchPlaceholder?: string;
+    /**
+     * The key that opens and focuses the search field, in Nuxt UI
+     * `defineShortcuts` notation: `"/"`, `"shift_f"`, `"meta_k"`. Defaults to
+     * `"shift_f"` (⇧F). Like every table shortcut, it does not fire while the
+     * user types in a field, so `"/"` stays a character there.
+     * @example "/"
+     */
+    searchShortcut?: string;
+    /** One-click dropdown filters drawn in the toolbar. */
+    quickFilters?: TableViewQuickFilter[];
+    /**
+     * Rows per page while the user has picked none, from 1 to 50 (registration
+     * throws otherwise). Defaults to 10. A size other than the standard 10, 25
+     * and 50 joins them in this table's page size picker.
+     */
+    pageSize?: number;
+    /**
+     * How the rows beyond the first page are reached. Defaults to `pages`.
+     * See {@link TableViewPaginationMode}.
+     */
+    pagination?: TableViewPaginationMode;
+    /**
+     * The footer band: the row count and a hint, figures computed over the
+     * listed rows (`summary`) and a legend of a select column's items.
+     */
+    footer?: TableViewFooterOptions<T>;
+    /**
+     * What the empty body of the grid and the `cards` display says when the
+     * table has no row yet, when its filters match nothing, or when the list
+     * failed. See {@link TableViewEmptyStates}.
+     */
+    emptyStates?: TableViewEmptyStates;
+    /**
+     * The key of the row id, default is _id
+     */
+    rowIdKey?: string;
+    /**
+     * The key of the field naming a row: it follows the title of the drawer or
+     * modal that edits or shows the row ("Edit task · Write the docs"), and
+     * ends the breadcrumb of its edit and details pages.
+     */
+    labelKey?: string;
+    rowActions?: TableViewRowActionOptions<T>;
+    /**
+     * The controller's columns as this table view shows them, when one page
+     * needs them otherwise than the controller declares: a related list on a
+     * record's page hides the column naming that record.
+     * @example { hidden: ["workspace"] }
+     */
+    columns?: TableViewColumnsOptions;
+    customButtons?: CustomButton[];
+    /**
+     * Where the add, edit and details forms open (a page by default) and their
+     * titles, in any container.
+     * @example { type: "drawer", pages: { new: { displayName: "$tasks.form.new_title" } } }
+     */
+    formContainer?: FormContainer;
+    /**
+     * Enable archive mode: replaces delete action with archive/restore
+     */
+    archiveMode?: boolean;
+    /**
+     * The count the caption shows while the archived rows are listed, naming
+     * them: an i18n key with `$` receiving `{ count }` and pluralized on it
+     * ("13 factures archivées"), or a text with `{count}`. Defaults to
+     * "Archived: {count}" ("Archives : {count}" in French), which agrees with
+     * no noun.
+     * @example "$invoices.archived_count"
+     */
+    archivedCountLabel?: string;
+    /**
+     * Default filters to apply when the table view is opened
+     */
+    defaultFilters?: Array<{
+        accessorKey: string;
+        value?: string;
+        mode: string;
+    }>;
+    /**
+     * Default sort configuration applied when no user preference exists, and
+     * the sort the table goes back to when the user clears theirs.
+     */
+    defaultSort?: {
+        field: string;
+        desc?: boolean;
+    };
+    /**
+     * Rows listed first, whatever the sort: those `pinnedRows` accepts, a rule
+     * on the row's fields as a row action's `rule`, in the order the sort gives
+     * them. The rest follows in the sort's order. A route answering every row
+     * (a `TableView.fromSource` without `paginate`) has its pinned rows on the
+     * first page; a route answering one page has them first within the page it
+     * answers. The `grouped` display keeps its groups and pins nothing;
+     * registration refuses it alongside `reorder`, whose rows keep their
+     * position.
+     * @example { field: "isBase", equals: true }
+     */
+    pinnedRows?: RowActionRule<T>;
+    /**
+     * Maps URL query parameters to hidden filters applied to the table data.
+     * These filters are not persisted in preferences, and not visible in the UI
+     * unless one sets `visible: true`: it then shows as a removable chip.
+     * @example { email: { field: "email", visible: true, label: "$app.email" } }
+     */
+    queryParamFilters?: QueryParamFilters;
+    /**
+     * Maps DMS route parameters (extracted from the page slug, e.g. `:id`) to
+     * hidden filters applied to the table data. Filters are not visible in the
+     * UI nor persisted in preferences. Useful for detail pages where the table
+     * must be scoped by a path param such as the parent entity id.
+     */
+    routeParamFilters?: RouteParamFilters;
+    /**
+     * When true, reject entire request if any row fails rule validation.
+     * When false (default), only process rows that pass rule validation.
+     */
+    strictRuleValidation?: boolean;
+    /**
+     * Tabs displayed above the table. Each tab filters the rows on one column,
+     * or links to another page. The implicit "all" tab (no filter) is shown
+     * automatically when at least one tab is configured here.
+     *
+     * Each tab shows a row counter, fetched in one request: filter tabs with
+     * counters require the controller to mount
+     * `countBatch: TableViewRoutes.CountBatch`. `TableView()` warns at
+     * registration when a table declares tabs without it.
+     */
+    tabs?: TableViewTab[];
+    /**
+     * When false, disables realtime broadcast/presence for this resource.
+     * Defaults to true (realtime is opt-out).
+     */
+    realtime?: boolean;
+    /**
+     * Topics the backend publishes on (`PublishMessage`) when the rows change
+     * without a write through this table's routes — a batch, a job, an import.
+     * The table reads its rows again on each event, keeping the current rows on
+     * screen until the answer lands. The page registers them, as for a chart's
+     * `realtimeTopic`. Independent of `realtime`, which covers the writes made
+     * through the controller.
+     */
+    realtimeTopic?: string | string[];
+    /**
+     * On a page declared with `live`, keeps the rows on screen while the page is
+     * paused, through the user's own search, sort and pagination too, and shows
+     * a "N new · Show" banner counting the rows the table would add since:
+     * how many more rows its tab, search and filters match now than it holds,
+     * asked of its count route (the events received, if that count fails).
+     * Show reads the rows once without leaving the pause. The page in Direct,
+     * the table also keeps its rows while they are on screen or scrolled past:
+     * a new row at the top would push down the rows the user reads, so new ones
+     * wait behind a "N new · Show" pill laid over the rows, which moves nothing.
+     * A table still below the screen follows the feed.
+     *
+     * A `TableView.fromSource` route receives the moment the rows were frozen
+     * as `liveHeldAt` (ISO 8601) on every list and count request made while
+     * paused, so it can answer the rows as they stood then; a data controller's
+     * rows are held against the realtime only. Ignored on a page without `live`.
+     *
+     * An object also names why the table holds, the rest of the page staying
+     * live, in more cases (see {@link TableViewLiveHoldOptions}); `true` and
+     * `{}` hold it while the page is paused or its rows are on screen.
+     *
+     * ```ts
+     * liveHold: { whileRowOpen: true, whileScrolled: true, whileSearching: true }
+     * ```
+     */
+    liveHold?: boolean | TableViewLiveHoldOptions;
+    /**
+     * Enable the kanban display mode for this collection. When set, users can
+     * switch between the table and a kanban board from the toolbar.
+     */
+    kanban?: KanbanOptions;
+    /**
+     * Lets the user order the rows by hand: the rows are listed sorted on
+     * `field`, a drag handle moves a row within its page — on the grid and on
+     * the `cards` display, whose custom `card.component` receives the handle
+     * as its `reorder` prop — and only the rows whose position changed are
+     * saved (a partial edit of `field`). Moving is off while a search, a
+     * filter or a tab narrows the rows. Needs the `edit` action.
+     */
+    reorder?: TableViewReorderOptions;
+    /**
+     * Offers the `grouped` display: the grid's columns with a header row per
+     * group of rows. A view may open in it (`display: "grouped"`).
+     * @example { groupByField: "createdAt", by: "day", count: true }
+     */
+    grouped?: GroupedOptions;
+    /**
+     * Named states of the table — filters, search, sort, columns, display and
+     * density — drawn as tabs, a strip of pills or a menu, opened from the URL
+     * (`?view=<id>`) and, with `userViews`, saved by users for themselves.
+     * Views and `tabs` coexist: a tab filters on one column, a view sets the
+     * whole table.
+     */
+    views?: TableViewViewsOptions;
+    /**
+     * The card the `kanban` and `cards` displays draw for each row: the columns
+     * it shows, or a component drawing it whole.
+     * @example { fields: ["email", "due_date"] }
+     * @example { component: CustomComponent("TaskCard") }
+     */
+    card?: TableViewCardOptions;
+    /**
+     * The displays this table view offers, in the switcher's order. Left out,
+     * the table view offers the built-in `table` alone; listed, it offers
+     * exactly these, so the grid is kept by listing `{ id: "table" }`. The
+     * `kanban` and `grouped` options add their display after the list unless it
+     * places them. Each `component` is a frontend component resolved by name on
+     * the client from the global registry (declare its directory with
+     * `global: true`); it receives the normalized `context` prop.
+     * `selfManagedData`/`capabilities` are the SSR source of truth for data
+     * fetching + chrome; the matching client plugin (`registerTableViewDisplay`)
+     * supplies the id, label, icon and component.
+     * @example [{ id: "table" }, { id: "cards" }]
+     */
+    displays?: TableViewDisplayOption[];
+    /**
+     * Display shown by default when the user has no saved preference. Defaults to
+     * the first display offered: `table` when `displays` is left out.
+     */
+    defaultDisplay?: string;
+    /**
+     * Display a phone opens on (a viewport narrower than 768px) when the user
+     * has no saved choice and the open view sets no `display` of its own (a
+     * `views.defaultView` without one opens on it too): `cards` gives a narrow screen a
+     * card per row instead of a grid cut after its first columns. One of the
+     * displays offered, so the switcher still leads back to the grid. Applied
+     * once mounted (the server cannot see the viewport) and not saved: the same
+     * user on a wide screen keeps `defaultDisplay`.
+     * @example { displays: [{ id: "table" }, { id: "cards" }], mobileDisplay: "cards" }
+     */
+    mobileDisplay?: string;
+    /**
+     * Server-side guards that run before mutating actions (edit/delete/archive/
+     * restore/new). Throw with `assert(...)` from `@antelopejs/interface-api-util`
+     * to abort the operation with an HTTP error and an i18n message key.
+     * `this` inside a guard is the data controller instance, so models declared
+     * with @Model are accessible.
+     */
+    guards?: TableViewGuards<T>;
+    /**
+     * Component slots the generated forms open, by form kind, so another module
+     * can extend them through `RegisterComponentSlot` — the pending-invite edit
+     * form opens one for the invite extensions. Values the slot adds to a form
+     * reach the data routes only if the controller reads them.
+     */
+    formSlots?: Partial<Record<"new" | "edit" | "view", string>>;
+    /**
+     * Settles the forms the table view generates, by form kind, for input
+     * comfort only: each callback receives the form's builder before the table
+     * view embeds it, and declares on it what a module's own `Form` would — a
+     * value filled in from another (`SET_FIELD_VALUE`), a field one table's
+     * forms leave out. No data rule here: the data routes never see these
+     * watches. A field shown, required or locked by the value of another is a
+     * column's `visibleWhen` / `disabledWhen`, which the routes enforce too.
+     * What it declares holds in a drawer, a modal or a form page alike; the
+     * `new` form's also on a duplicated row. A watch's `requirePermission` is
+     * checked per request, as on a page's own components.
+     *
+     * @example
+     * forms: {
+     *   new: (form) =>
+     *     form.watch(FormEvents.FIELD_CHANGE, FormFunctions.SET_FIELD_VALUE, {
+     *       params: { targetField: "probability", valueMap: { won: 100, lost: 0 } },
+     *       onParam: { key: "fieldId", value: "stage" },
+     *     }),
+     * }
+     */
+    forms?: Partial<Record<"new" | "edit" | "view", TableViewFormSetup>>;
+    /**
+     * Skip the tenant access gate on every data route of this table view, the
+     * table-view mirror of the guards' `bypassTenantAccessGate` option. Reserved
+     * for tables that must stay readable when a gate denies the tenant (e.g.
+     * invoices on the billing page of a suspended tenant) so it can regularize
+     * its situation. Data routes are registered independently of pages, so the
+     * opt-out is controller-level and latched: once any `TableView()` call on a
+     * controller declares it, the controller's routes bypass the gate wherever
+     * they are rendered. Permission checks still apply.
+     */
+    bypassTenantAccessGate?: boolean;
+}

package/dist/base/table-view/internal/option-contract.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=option-contract.js.map

package/dist/base/table-view/internal/option-contract.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"option-contract.js","sourceRoot":"","sources":["../../../../src/base/table-view/internal/option-contract.ts"],"names":[],"mappings":""}