@antelopejs/interface-dms 0.3.5 → 0.4.0

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

@@ -0,0 +1 @@
+{"version":3,"file":"auth.js","sourceRoot":"","sources":["../../../../src/base/table-view/internal/auth.ts"],"names":[],"mappings":";;;AA8DA,0CA0DC;AAGD,0CAiBC;AAGD,wDASC;AApJD,uEAA2E;AAC3E,+DAAyD;AACzD,gEAA6D;AAK7D,6FAAqE;AACrE,oCAA2D;AAC3D,sDAG8B;AAC9B,4DAA6D;AAC7D,0DAA4D;AAC5D,wCAAyC;AAEzC,kCAAwC;AAExC;;;;;;;GAOG;AACU,QAAA,WAAW,GAAG,MAAM,CAAC;AAClC,gBAAgB;AACH,QAAA,WAAW,GAAG,MAAM,CAAC;AAClC,gBAAgB;AACH,QAAA,aAAa,GAAG,QAAQ,CAAC;AAEtC;;;;;;;;;;GAUG;AACU,QAAA,uBAAuB,GAAG;IACrC,mBAAW;IACX,mBAAW;IACX,qBAAa;CACd,CAAC;AAEF,SAAS,sBAAsB,CAC7B,QAAgB,EAChB,aAAuB;IAEvB,OAAO,aAAa,CAAC,MAAM,GAAG,CAAC,IAAI,+BAAuB,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;AAChF,CAAC;AAED,gBAAgB;AACT,KAAK,UAAU,eAAe,CACnC,OAAgB,EAChB,QAAgB,EAChB,IAAU,EACV,QAAgB;IAEhB,MAAM,IAAI,GAAG,IAAA,4BAAW,EACrB,OAA4C,CAAC,WAAW,EACzD,oBAAa,CACd,CAAC;IACF,wEAAwE;IACxE,0EAA0E;IAC1E,qEAAqE;IACrE,qBAAqB;IACrB,EAAE;IACF,2EAA2E;IAC3E,wEAAwE;IACxE,0EAA0E;IAC1E,gCAAgC;IAChC,MAAM,aAAa,GAAG,IAAI,CAAC,mBAAmB,CAAC,QAAQ,CAAC,CAAC;IACzD,0EAA0E;IAC1E,uEAAuE;IACvE,0EAA0E;IAC1E,qEAAqE;IACrE,4EAA4E;IAC5E,iDAAiD;IACjD,IACE,CAAC,IAAI,CAAC,sBAAsB;QAC5B,CAAC,sBAAsB,CAAC,QAAQ,EAAE,aAAa,CAAC,EAChD,CAAC;QACD,IAAI,IAAI,CAAC,sBAAsB,EAAE,CAAC;YAChC,iBAAO,CAAC,KAAK,CACX,iBAAiB,QAAQ,mHAAmH,CAC7I,CAAC;QACJ,CAAC;QACD,MAAM,IAAA,kCAAkB,EAAC,IAAI,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC;IAC/C,CAAC;IACD,IAAI,aAAa,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC/B,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,MAAM,SAAS,GAAG,IAAA,wCAAQ,EAAC,cAAS,EAAE,QAAQ,CAAC,CAAC;IAChD,MAAM,WAAW,GAAG,IAAA,wCAAQ,EAAC,sBAAiB,EAAE,QAAQ,CAAC,CAAC;IAC1D,MAAM,MAAM,GAAG,MAAM,WAAW,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACrD,MAAM,OAAO,GAAG,MAAM,EAAE,OAAO,IAAI,EAAE,CAAC;IACtC,MAAM,WAAW,GAAG,MAAM,IAAA,yCAA2B,EACnD,IAAI,EACJ,QAAQ,EACR,OAAO,EACP,SAAS,CACV,CAAC;IACF,IAAI,MAAM,IAAA,8BAAgB,EAAC,WAAW,EAAE,aAAa,CAAC,EAAE,CAAC;QACvD,OAAO,WAAW,CAAC;IACrB,CAAC;IACD,IAAA,2BAAe,EACb,KAAK,EACL,GAAG,EACH,iCAAiC,aAAa,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAC9D,CAAC;AACJ,CAAC;AAED,gBAAgB;AAChB,SAAgB,eAAe,CAC7B,QAAgB,EAChB,SAAY;IAEZ,OAAO;QACL,MAAM,EAAE,SAAS,CAAC,MAAM;QACxB,IAAI,EAAE,CAAC,GAAG,SAAS,CAAC,IAAI,EAAE,IAAA,eAAQ,GAAE,CAAC;QACrC,IAAI,EAAE,KAAK,WAA0B,GAAG,OAAkB;YACxD,MAAM,IAAI,GAAG,OAAO,CAAC,GAAG,EAAU,CAAC;YACnC,MAAM,GAAG,GAAG,OAAO,CAAC,CAAC,CAAmB,CAAC;YACzC,MAAM,eAAe,CAAC,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,IAAA,mCAAkB,EAAC,GAAG,CAAC,CAAC,CAAC;YACrE,OAAQ,SAAS,CAAC,IAAqC,CAAC,KAAK,CAC3D,IAAI,EACJ,OAAO,CACR,CAAC;QACJ,CAAC;KACF,CAAC;AACJ,CAAC;AAED,gBAAgB;AAChB,SAAgB,sBAAsB,CACpC,QAAgB,EAChB,SAA4C;IAE5C,OAAO;QACL,QAAQ,EAAE,SAAS,CAAC,QAAQ;QAC5B,OAAO,EAAE,SAAS,CAAC,OAAO;QAC1B,QAAQ,EAAE,eAAe,CAAC,QAAQ,EAAE,SAAS,CAAC,QAAQ,CAAC;KACxD,CAAC;AACJ,CAAC"}

package/dist/base/table-view/internal/column-display.d.ts

@@ -0,0 +1,18 @@
+import type { Class } from "@antelopejs/interface-core/decorators";
+import type { ColumnDisplay, ColumnDisplaySerialized } from "../column-display";
+/** @internal */
+export declare const displayIds: WeakMap<Class<ColumnDisplay<object>>, string>;
+/**
+ * The id a display instance is registered under, if any.
+ *
+ * @internal
+ */
+export declare function getColumnDisplayId(display: ColumnDisplay<object>): string | undefined;
+/**
+ * A column display as the column metadata carries it. Throws for a display
+ * whose class was never registered: its cells would fall back to the column's
+ * type without a word.
+ *
+ * @internal
+ */
+export declare function serializeColumnDisplay(display: ColumnDisplay<object> | undefined): ColumnDisplaySerialized | undefined;

package/dist/base/table-view/internal/column-display.js

@@ -0,0 +1,37 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.displayIds = void 0;
+exports.getColumnDisplayId = getColumnDisplayId;
+exports.serializeColumnDisplay = serializeColumnDisplay;
+// Weak: a hot reload registers a module's displays again as new classes, and
+// the replaced ones must not stay reachable through this lookup.
+/** @internal */
+exports.displayIds = new WeakMap();
+/**
+ * The id a display instance is registered under, if any.
+ *
+ * @internal
+ */
+function getColumnDisplayId(display) {
+    return exports.displayIds.get(Object.getPrototypeOf(display).constructor);
+}
+/**
+ * A column display as the column metadata carries it. Throws for a display
+ * whose class was never registered: its cells would fall back to the column's
+ * type without a word.
+ *
+ * @internal
+ */
+function serializeColumnDisplay(display) {
+    if (!display)
+        return undefined;
+    const type = getColumnDisplayId(display);
+    if (!type) {
+        throw new Error(`Column display ${Object.getPrototypeOf(display).constructor.name} is not registered: decorate its class with @RegisterDisplay("<module>:<id>")`);
+    }
+    const { options } = display;
+    return options
+        ? { type, options: options }
+        : { type };
+}
+//# sourceMappingURL=column-display.js.map

package/dist/base/table-view/internal/column-display.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"column-display.js","sourceRoot":"","sources":["../../../../src/base/table-view/internal/column-display.ts"],"names":[],"mappings":";;;AAaA,gDAIC;AASD,wDAcC;AArCD,6EAA6E;AAC7E,iEAAiE;AACjE,gBAAgB;AACH,QAAA,UAAU,GAAG,IAAI,OAAO,EAAwC,CAAC;AAE9E;;;;GAIG;AACH,SAAgB,kBAAkB,CAChC,OAA8B;IAE9B,OAAO,kBAAU,CAAC,GAAG,CAAC,MAAM,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC,WAAW,CAAC,CAAC;AACpE,CAAC;AAED;;;;;;GAMG;AACH,SAAgB,sBAAsB,CACpC,OAA0C;IAE1C,IAAI,CAAC,OAAO;QAAE,OAAO,SAAS,CAAC;IAC/B,MAAM,IAAI,GAAG,kBAAkB,CAAC,OAAO,CAAC,CAAC;IACzC,IAAI,CAAC,IAAI,EAAE,CAAC;QACV,MAAM,IAAI,KAAK,CACb,kBAAkB,MAAM,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC,WAAW,CAAC,IAAI,+EAA+E,CACjJ,CAAC;IACJ,CAAC;IACD,MAAM,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC;IAC5B,OAAO,OAAO;QACZ,CAAC,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,OAAkC,EAAE;QACvD,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC;AACf,CAAC"}

package/dist/base/table-view/internal/data-functions.d.ts

@@ -0,0 +1,14 @@
+import type { RequestContext } from "@antelopejs/interface-api";
+import type { DataControllerCallback, DataControllerCallbackWithOptions } from "@antelopejs/interface-data-api";
+/**
+ * The figures of a footer, by summary id.
+ *
+ * @internal
+ */
+export type FooterSummaryValues = Record<string, number>;
+/** @internal */
+export type RowBulkOperationParams = [
+    thisObj: DataControllerCallback | DataControllerCallbackWithOptions,
+    ctx: RequestContext,
+    ids: string | string[]
+];

package/dist/base/table-view/internal/data-functions.js

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

package/dist/base/table-view/internal/data-functions.js.map

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

package/dist/base/table-view/internal/factory-helpers.d.ts

@@ -0,0 +1,213 @@
+import { ComponentBuilder } from "../../../component";
+import { type FormBuilder } from "../../form-types";
+import type { CustomButton, CustomButtonSerialized } from "../../types/custom-button";
+import { TableViewMeta } from "../meta";
+import { type FormContainerPageConfig, type FormContainerPages, type FormContainerPageTexts, type GroupedOptions, type KanbanOptions, type QueryParamFilters, type RouteParamFilters, type TableViewCardOptions, type TableViewDisplayOption, type TableViewDisplayOptionSerialized, type TableViewExpandableOptions, type TableViewExpandableSerialized, type TableViewFormPageUrls, type TableViewRowActionOptions, type TableViewRowActionOptionsSerialized } from "../options";
+/** @internal */
+export type FormPageKind = keyof TableViewFormPageUrls;
+/** @internal */
+export declare function applyFormRedirect<T>(formBuilder: ComponentBuilder<T>, redirectUrl: string, preserveQuery?: string[]): void;
+/**
+ * Custom buttons as the options carry them: their permission and availability
+ * stay server-side, applied per request.
+ *
+ * @internal
+ */
+export declare function serializeCustomButtons(buttons: CustomButton[] | undefined): CustomButtonSerialized[] | undefined;
+/**
+ * The row actions as the options carry them to the client.
+ *
+ * @internal
+ */
+export declare function serializeRowActions<T extends Record<string, unknown>>(rowActions: TableViewRowActionOptions<T>): TableViewRowActionOptionsSerialized;
+/**
+ * What a table view can do, which decides the actions it declares.
+ *
+ * @internal
+ */
+export interface TableViewCapabilities {
+    hasNewForm: boolean;
+    hasEditForm: boolean;
+    hasViewForm: boolean;
+    hasDeleteEndpoint: boolean;
+    archiveMode: boolean;
+    isExportEnabled: boolean;
+}
+/**
+ * Declare the actions of a table view: list and select, which every table
+ * has, then one per form, delete, the archive trio and export, each only when
+ * the table view can perform it. A component standing in for a TableView over
+ * the same data routes (a custom editor) declares its actions here too, so
+ * the routes and the roles carry the same permission ids.
+ *
+ * @internal
+ */
+export declare function registerTableViewActions<T>(builder: ComponentBuilder<T>, capabilities: TableViewCapabilities): void;
+/**
+ * The detail band of expandable rows, with its fields normalized to objects
+ * or its component serialized. The band shows one or the other: an option
+ * giving both, or neither (an editor's schema can), is refused. Every field
+ * must name a declared column: its value renders through that column's data
+ * type.
+ *
+ * @internal
+ */
+export declare function serializeExpandable(controllerName: string, meta: Pick<TableViewMeta, "columns">, expandable: TableViewExpandableOptions | undefined): TableViewExpandableSerialized | undefined;
+/**
+ * What `TableView()` serializes its displays from.
+ *
+ * @internal
+ */
+export interface TableViewDisplaySources {
+    displays?: TableViewDisplayOption[];
+    kanban?: KanbanOptions;
+    grouped?: GroupedOptions;
+    card?: TableViewCardOptions;
+}
+/**
+ * The `kanban` and `grouped` options are transported to the frontend as
+ * `displays` entries (`{ id: "kanban", options }`), not as dedicated fields;
+ * those displays read their options from `context.options` like any other.
+ * The `card` joins the options of both card displays, kanban and cards.
+ *
+ * @internal
+ */
+export declare function serializeTableViewDisplays(sources: TableViewDisplaySources): TableViewDisplayOptionSerialized[] | undefined;
+/**
+ * What a page-mode form sub-page is, beyond the form it carries.
+ *
+ * @internal
+ */
+export interface FormPageDefinition {
+    /** Slug it takes below the key of its table view, when none is declared. */
+    defaultSlug: string;
+    displayName: string;
+    description: string;
+    /** Table view action whose permission guards the sub-page. */
+    action: string;
+    /** Whether submitting the form sends the user back to the table. */
+    redirectsOnSubmit: boolean;
+    /** Whether the form submits the fields the table view filters on. */
+    submitsFilterDefaults: boolean;
+}
+/** @internal */
+export declare const FORM_PAGE_DEFINITIONS: Record<FormPageKind, FormPageDefinition>;
+/**
+ * The `formContainer.pages` key of each form kind.
+ *
+ * @internal
+ */
+export declare const FORM_PAGE_CONFIG_KEYS: Record<FormPageKind, keyof FormContainerPages>;
+/**
+ * The `formContainer.pages` entry of a form kind.
+ *
+ * @internal
+ */
+export declare function formPageConfig(kind: FormPageKind, pages: FormContainerPages | undefined): FormContainerPageConfig | undefined;
+/**
+ * Title and description of a page-mode form sub-page: its
+ * `formContainer.pages` entry, else the generic "New entry" / "Edit entry" /
+ * "Entry details" texts.
+ *
+ * @internal
+ */
+export declare function resolveFormPageTexts(kind: FormPageKind, pages?: FormContainerPages): Required<FormContainerPageTexts>;
+/** @internal */
+export declare const FORM_PAGE_KINDS: FormPageKind[];
+/**
+ * Append a form page slug to the slug of the page carrying the table view.
+ *
+ * @internal
+ */
+export declare function joinPageSlug(pageSlug: string, slug: string): string;
+/**
+ * The key identifying a table view among the components of its page: the last
+ * segment of its permission id relative to the page's permission id.
+ *
+ * Relative to the permission id, not the `fullId`: component permission ids
+ * descend from the former, and a page declaring a custom `permission.id` has
+ * the two differ.
+ *
+ * Form routes are named after it rather than after the page, so two table views
+ * on one page get URLs of their own; the *simple* key rather than the whole
+ * component path, so the URL stays readable and survives the layout being
+ * reorganised around the table view.
+ *
+ * @param permissionId Permission id of the table view
+ * @param pagePermissionId Permission id of the page carrying it
+ *
+ * @internal
+ */
+export declare function formRouteKey(permissionId: string, pagePermissionId: string): string;
+/**
+ * The slug a page-mode form page takes, relative to the page carrying the table
+ * view.
+ *
+ * A declared `urlSlug` is full control — it is taken as it stands, no key
+ * segment inserted, which is both what every existing declaration already meant
+ * and the escape hatch for anyone wanting a specific URL.
+ *
+ * @internal
+ */
+export declare function formPageSlug(kind: FormPageKind, routeKey: string, pages?: FormContainerPages): string;
+/**
+ * The URL each page-mode form is reached at, whether or not the table view
+ * registers a page for it: a `customPage` entry points at a hand-written page
+ * and is navigated to all the same.
+ *
+ * @internal
+ */
+export declare function buildFormPageUrls(pageSlug: string, routeKey: string, pages?: FormContainerPages): TableViewFormPageUrls;
+/**
+ * The URL filters of a table view, which its forms submit as defaults.
+ *
+ * @internal
+ */
+export interface TableViewUrlFilters {
+    queryParamFilters?: QueryParamFilters;
+    routeParamFilters?: RouteParamFilters;
+}
+/**
+ * A form page route, and the slug of the page carrying its table view.
+ *
+ * @internal
+ */
+export interface FormRouteFrame {
+    pageSlug: string;
+    formSlug: string;
+}
+/**
+ * The URL a form page sends the user back to on submit: the slug of the page
+ * carrying the table view, each placeholder replaced by the token reading its
+ * value on the form route, which the frontend resolves before navigating
+ * (`/workspaces/:id` becomes `/workspaces/{{params.id:1}}` from
+ * `/workspaces/:id/invoiceTable/:id/edit`). A slug without placeholder is
+ * returned as is.
+ *
+ * @internal
+ */
+export declare function buildFormRedirectUrl(frame: FormRouteFrame): string;
+/**
+ * Default the filtered fields from the URL tokens that `queryParamFilters` /
+ * `routeParamFilters` apply to the table, so a form opened from a filtered view
+ * inherits that context. The form resolves these tokens at submit time and
+ * drops any that are absent.
+ *
+ * @param filters URL filters of the table view
+ * @param frame Route of the form page the form is registered under; without
+ * one, the form renders on the page carrying the table view
+ *
+ * @internal
+ */
+export declare function buildFilterSubmitDefaults(filters: TableViewUrlFilters, frame?: FormRouteFrame): Record<string, string> | undefined;
+/**
+ * Re-resolve the filter defaults of a form for the page it is registered as.
+ *
+ * The form was built for the page carrying the table view — where the table
+ * view embeds it, and where `{{params.<name>}}` is the parameter it filters
+ * on. On a form route repeating that name, the bare name is shadowed by the
+ * form's own placeholder.
+ *
+ * @internal
+ */
+export declare function applyFormPageSubmitDefaults(form: FormBuilder, filters: TableViewUrlFilters, frame: FormRouteFrame): void;