@antelopejs/interface-dms 0.7.1 → 0.7.2

package/CHANGELOG.md

@@ -1,5 +1,61 @@
 # Changelog
 
+## v0.7.2
+
+[compare changes](https://github.com/AntelopeJS/dms/compare/interface-v0.7.1...v0.7.2)
+
+### 🚀 Enhancements
+
+- **preview:** Live block preview page, block catalog and screenshots for the docs ([#280](https://github.com/AntelopeJS/dms/pull/280))
+
+### 🔥 Performance
+
+- **layout:** Bundle the Geist fonts and preload only the text face ([#311](https://github.com/AntelopeJS/dms/pull/311))
+- **table:** Drag with SortableJS through useSortable instead of vuedraggable ([#312](https://github.com/AntelopeJS/dms/pull/312))
+- **table-view:** Share a source read between the list and a counter asking the same ([#313](https://github.com/AntelopeJS/dms/pull/313))
+
+### 🩹 Fixes
+
+- **deps:** Move to @antelopejs/core 1.15.2, @antelopejs/interface-core 0.2.3 and @antelopejs/interface-dms 0.7.1 ([#303](https://github.com/AntelopeJS/dms/pull/303))
+- **docs:** Regenerate the block catalog for dms 0.9.2 ([#315](https://github.com/AntelopeJS/dms/pull/315))
+- **form:** Leave a failed record read's toast to the browser ([#304](https://github.com/AntelopeJS/dms/pull/304))
+- **page:** Leave a page's layout out of the components its preload looks up ([#306](https://github.com/AntelopeJS/dms/pull/306))
+- **settings:** Suggest the reader's time zone in a server-rendered region page ([#308](https://github.com/AntelopeJS/dms/pull/308))
+- **frontend:** Set the async data scope before any module's plugin reads ([#305](https://github.com/AntelopeJS/dms/pull/305))
+- **blocks:** Have refreshPageBlocks() wait for the charts and tables it refreshes ([#307](https://github.com/AntelopeJS/dms/pull/307))
+
+### 📖 Documentation
+
+- **dms:** Restructure docs with per-block pages, live previews and an AI section ([#277](https://github.com/AntelopeJS/dms/pull/277))
+- Remove the DMS 0.9 upgrade page ([#316](https://github.com/AntelopeJS/dms/pull/316))
+- **dms:** Document running the DMS inside AdonisJS ([#318](https://github.com/AntelopeJS/dms/pull/318))
+- Make the DMS 0.9 upgrade notes accurate and complete ([#310](https://github.com/AntelopeJS/dms/pull/310))
+- Streamline agent guidance ([#317](https://github.com/AntelopeJS/dms/pull/317))
+- Colocate the DMS consumer reference with its interface ([#320](https://github.com/AntelopeJS/dms/pull/320))
+- Make dense guide sections easier to scan ([#321](https://github.com/AntelopeJS/dms/pull/321))
+
+### 📦 Build
+
+- **dms:** Leave tests and tooling out of the published package ([#314](https://github.com/AntelopeJS/dms/pull/314))
+
+### 🏡 Chore
+
+- **release:** @antelopejs/dms v0.9.2 ([beb09f9d](https://github.com/AntelopeJS/dms/commit/beb09f9d))
+- **release:** Propagate published dependency floors ([#323](https://github.com/AntelopeJS/dms/pull/323))
+
+### ✅ Tests
+
+- **live:** Hold the page's data refresh while paused, not a user's ([#309](https://github.com/AntelopeJS/dms/pull/309))
+
+### 🤖 CI
+
+- **docs:** Build and verify the hosted preview playground ([#319](https://github.com/AntelopeJS/dms/pull/319))
+
+### ❤️ Contributors
+
+- Antony Rizzitelli <rizzitelli.antony@pm.me>
+- Alessandro Aloisio
+
 ## v0.7.1
 
 [compare changes](https://github.com/AntelopeJS/dms/compare/interface-v0.7.0...v0.7.1)

package/README.md

@@ -1,76 +1,78 @@
-# `@antelopejs/interface-dms`
-
 <div align="center">
-<a href="./LICENSE"><img alt="License" src="https://img.shields.io/badge/license-Apache--2.0-blue?style=for-the-badge&labelColor=000000"></a>
-<a href="https://antelopejs.com"><img src="https://img.shields.io/badge/Docs-18181B?style=for-the-badge&color=000000" alt="Documentation"></a>
+
+# @antelopejs/interface-dms
+
+<a href="https://www.npmjs.com/package/@antelopejs/interface-dms"><img alt="npm" src="https://img.shields.io/npm/v/@antelopejs/interface-dms?style=for-the-badge&labelColor=000000&color=000000"></a>
+<a href="./LICENSE"><img alt="License" src="https://img.shields.io/npm/l/@antelopejs/interface-dms?style=for-the-badge&labelColor=000000&color=000000"></a>
+<a href="https://discord.gg/sjK28QHrA7"><img alt="Discord" src="https://img.shields.io/badge/Discord-18181B?logo=discord&style=for-the-badge&color=000000"></a>
+<a href="https://dms.antelopejs.com/docs/interfaces"><img alt="Documentation" src="https://img.shields.io/badge/Docs-18181B?style=for-the-badge&color=000000"></a>
+
+The public contracts of the AntelopeJS DMS: pages and components, permissions and tenancy, authentication, notifications and HTML rendering.
+
 </div>
 
-The public contracts of the AntelopeJS DMS: pages and components, permissions
-and tenancy, authentication, notifications and HTML rendering. A module that
-extends the DMS imports them from here and never from `@antelopejs/dms`, so it
-compiles against the contract rather than against the implementation.
+## What it does
+
+- Declares pages, categories, modules and page extensions (`/page`), and the blocks they carry: forms, tables, charts and layouts (`/base`).
+- Registers permissions, guards routes, and scopes data to a tenant (`/permissions`, `/guards`, `/tenant-scoped-model`…).
+- Authenticates requests and manages users, sessions and external identities (`/auth`).
+- Declares notification categories and sends notifications (`/notifications`), and renders HTML templates server-side (`/html-render`).
+- Lets a module compile against the contract rather than against the implementation, [`@antelopejs/dms`](https://www.npmjs.com/package/@antelopejs/dms).
+
+## Install
+
+Add the interface to the module that extends the DMS:
 
 ```bash
 pnpm add @antelopejs/interface-dms
 ```
 
-## Entry points
-
-| Import                                  | What it holds                                              |
-| --------------------------------------- | ---------------------------------------------------------- |
-| `@antelopejs/interface-dms`             | the `dms` interface itself: pages, permissions, tenancy, hooks |
-| `@antelopejs/interface-dms/<module>`    | one module of it -- `/page`, `/permissions`, `/hooks`, `/db`, ... |
-| `@antelopejs/interface-dms/auth`        | authentication: users, sessions, external identities        |
-| `@antelopejs/interface-dms/base`        | the component library: forms, tables, charts, layouts       |
-| `@antelopejs/interface-dms/notifications` | notification categories, subjects and delivery             |
-| `@antelopejs/interface-dms/html-render` | server-side HTML templates                                  |
-
-`/auth`, `/base` and `/notifications` take subpaths of their own
-(`/auth/db`, `/auth/password`, `/base/table-view`, `/base/data-types`, `/notifications/builder`,
-...). The reference documentation lives in the runtime package, under
-`docs/07.interfaces/`.
-
-## One copy, always
-
-Every AntelopeJS interface is a peer dependency, and so is this one in effect:
-the host and every module have to resolve **the same installed copy**.
-
-That is stricter here than the usual "duplicate dependencies waste space". This
-package holds live state, not just types -- the page, category and extension
-registries, the permission tree, the hook registry, the data-type and block
-registries, the component slot resolvers -- and the interface proxies a module
-registers into are identified per loaded instance. A second copy gets its own
-empty registries and its own proxies: pages register into a tree nobody reads,
-permissions never reach the roles form, and hooks never fire. Nothing throws.
-
-`@antelopejs/core` checks this before constructing modules and fails with
-`Incompatible interface package resolution` when a consumer resolves a copy
-other than the canonical one, so a mismatch is caught at startup rather than
-diagnosed later. Depend on it with a wide range -- `>=0.0.1 <1.0.0`, raising the lower bound
-to the version you actually need rather than pinning an upper one -- so package
-managers can deduplicate, and never vendor or bundle this package into a module.
-`@antelopejs/dms`, which implements this interface, is the exception: it caps its
-range below the next minor, so a breaking minor of this package never reaches an
-older DMS.
-
-One more consequence worth knowing when writing a module: the runtime hands a
-module a per-context view of the values it receives through an interface, so
-reference equality does not survive the round trip. Compare registrations on a
-field, never with `===`.
-
-The same goes for *finding* a registration again, not just comparing two. A
-view has to be resolved back to the registered object by its token before it can
-be used as a key: `RegisteringProxy` looks its entries up by object reference,
-so unregistering with the view a module holds matches nothing and leaves the
-registration live -- silently, exactly like a second copy would. `RegisterPage`
-and `RegisterCategory` resolve their argument through `RegistrationIdentity`
-(`page/internal/registry`) for that reason; anything else keyed on a value
-that crossed the boundary has to do the same. The same trap catches structural comparisons:
-`isDeepStrictEqual` and `assert.deepStrictEqual` both refuse two views that hold
-equal values, so compare plain data, field by field or after a JSON round trip.
-
-## Releasing
-
-Release this package before releasing a `@antelopejs/dms` version that needs it,
-and upgrade it first on the consumer side. It has its own workflow
-(`Release DMS interface`); releasing the runtime never releases it.
+Depend on it with a wide range, such as `>=0.7.0 <1.0.0`, and never bundle or vendor it: the host and every module must resolve the same installed copy, since the package holds live registries. `@antelopejs/core` fails at startup with `Incompatible interface package resolution` when a module resolves another copy.
+
+## Quick start
+
+```ts
+import { PageController, RegisterPage, pagesCategory } from "@antelopejs/interface-dms/page";
+import { KpiCard } from "@antelopejs/interface-dms/base/kpi-card";
+
+@RegisterPage()
+export class SalesPage extends PageController("sales", {
+  displayName: "Sales",
+  icon: "i-ph-chart-line",
+  category: pagesCategory,
+}) {
+  static revenue = KpiCard({ title: "Revenue", fetchUrl: "/api/sales/revenue" });
+}
+```
+
+| Import | What it holds |
+| --- | --- |
+| `@antelopejs/interface-dms` | the core surface: pages, permissions, tenancy, hooks |
+| `@antelopejs/interface-dms/<module>` | one module of it: `/page`, `/permissions`, `/hooks`, `/db`… |
+| `@antelopejs/interface-dms/auth` | authentication: users, sessions, external identities |
+| `@antelopejs/interface-dms/base` | the component library: forms, tables, charts, layouts |
+| `@antelopejs/interface-dms/notifications` | notification categories, subjects and delivery |
+| `@antelopejs/interface-dms/html-render` | server-side HTML templates |
+
+## Compatibility
+
+| `@antelopejs/interface-dms` | `@antelopejs/dms` (implementation) |
+| --- | --- |
+| 0.7 | 0.9 |
+| 0.6 | 0.8 |
+
+## Documentation
+
+- [The DMS interface](./docs/index.md): the canonical consumer reference, shipped with this package and published at [docs/interfaces](https://dms.antelopejs.com/docs/interfaces)
+- [Core](./docs/1.core/1.introduction.md), [Auth](./docs/2.auth/1.introduction.md), [Base](./docs/3.base/1.introduction.md), [Notifications](./docs/4.notifications/1.introduction.md), [HTML Render](./docs/5.html-render/1.introduction.md)
+- [Pages and components](https://dms.antelopejs.com/docs/building/pages-and-components): the task-by-task guide
+
+An importable file is not necessarily a supported API. Paths under `internal/`, symbols tagged `@internal`, and `internal` namespaces are implementation wiring, even when the wildcard export makes them reachable. Use the public declarations and contracts documented here.
+
+## Contributing
+
+This package lives in the [`AntelopeJS/dms`](https://github.com/AntelopeJS/dms) pnpm workspace, next to the runtime that implements it. Read [CONTRIBUTING.md](https://github.com/AntelopeJS/dms/blob/main/CONTRIBUTING.md), the [repository README](https://github.com/AntelopeJS/dms#contributing) and [AGENTS.md](https://github.com/AntelopeJS/dms/blob/main/AGENTS.md), which covers what is public and what is internal. Release this package (**Release DMS interface**) before a `@antelopejs/dms` version that needs it.
+
+## License
+
+[Apache-2.0](./LICENSE)

package/dist/auth/db/models/sessions.model.d.ts

@@ -20,6 +20,7 @@ declare const SessionModel_base: {
         delete(id: string): Promise<number>;
     };
     readonly schemaName: string;
+    readonly tableClass: import("@antelopejs/interface-database-decorators").Constructible<Session>;
     fromPlainData(obj: any): Session;
     fromDatabase(obj: any): Session | undefined;
     toDatabase(obj: any): Record<string, any>;

package/dist/auth/db/models/userExternalIdentities.model.d.ts

@@ -17,6 +17,7 @@ declare const UserExternalIdentityModel_base: {
         delete(id: string): Promise<number>;
     };
     readonly schemaName: string;
+    readonly tableClass: import("@antelopejs/interface-database-decorators").Constructible<UserExternalIdentity>;
     fromPlainData(obj: any): UserExternalIdentity;
     fromDatabase(obj: any): UserExternalIdentity | undefined;
     toDatabase(obj: any): Record<string, any>;

package/dist/auth/db/models/users.model.d.ts

@@ -20,6 +20,7 @@ declare const UserModel_base: {
         delete(id: string): Promise<number>;
     };
     readonly schemaName: string;
+    readonly tableClass: import("@antelopejs/interface-database-decorators").Constructible<User>;
     fromPlainData(obj: any): User;
     fromDatabase(obj: any): User | undefined;
     toDatabase(obj: any): Record<string, any>;

package/dist/base/block-types.d.ts

@@ -22,6 +22,7 @@ import "./grid";
 import "./guard";
 import "./key-value-list";
 import "./kpi-card";
+import "./live-toggle";
 import "./meter";
 import "./nav-card-grid";
 import "./period-selector";

package/dist/base/block-types.js

@@ -38,6 +38,7 @@ require("./grid");
 require("./guard");
 require("./key-value-list");
 require("./kpi-card");
+require("./live-toggle");
 require("./meter");
 require("./nav-card-grid");
 require("./period-selector");

package/dist/base/block-types.js.map

@@ -1 +1 @@
-{"version":3,"file":"block-types.js","sourceRoot":"","sources":["../../src/base/block-types.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA;;;;;;;;;;;GAWG;AACH,2BAAyB;AACzB,oBAAkB;AAClB,kBAAgB;AAChB,oCAAkC;AAClC,wBAAsB;AACtB,wBAAsB;AACtB,yBAAuB;AACvB,+BAA6B;AAC7B,kBAAgB;AAChB,mBAAiB;AACjB,4BAA0B;AAC1B,sBAAoB;AACpB,mBAAiB;AACjB,2BAAyB;AACzB,6BAA2B;AAC3B,yBAAuB;AACvB,kCAAgC;AAChC,qBAAmB;AACnB,mBAAiB;AACjB,wBAAsB;AACtB,iBAAe;AACf,+BAA6B;AAC7B,2BAAyB;AAEzB,2EAA2E;AAC3E,6DAA6D;AAC7D,iDAA+B;AAC/B,2DAAyC;AACzC,4DAA0C;AAC1C,yDAAuC"}
+{"version":3,"file":"block-types.js","sourceRoot":"","sources":["../../src/base/block-types.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA;;;;;;;;;;;GAWG;AACH,2BAAyB;AACzB,oBAAkB;AAClB,kBAAgB;AAChB,oCAAkC;AAClC,wBAAsB;AACtB,wBAAsB;AACtB,yBAAuB;AACvB,+BAA6B;AAC7B,kBAAgB;AAChB,mBAAiB;AACjB,4BAA0B;AAC1B,sBAAoB;AACpB,yBAAuB;AACvB,mBAAiB;AACjB,2BAAyB;AACzB,6BAA2B;AAC3B,yBAAuB;AACvB,kCAAgC;AAChC,qBAAmB;AACnB,mBAAiB;AACjB,wBAAsB;AACtB,iBAAe;AACf,+BAA6B;AAC7B,2BAAyB;AAEzB,2EAA2E;AAC3E,6DAA6D;AAC7D,iDAA+B;AAC/B,2DAAyC;AACzC,4DAA0C;AAC1C,yDAAuC"}

package/dist/base/live-toggle.d.ts

@@ -58,11 +58,11 @@ export declare const LiveToggleSchema: z.ZodObject<{
 }, "strip", z.ZodTypeAny, {
     variant?: "segmented" | "pill" | undefined;
     align?: "left" | "right" | "center" | undefined;
-    missedLabel?: string | undefined;
     showUpdatedAt?: boolean | undefined;
+    missedLabel?: string | undefined;
 }, {
     variant?: "segmented" | "pill" | undefined;
     align?: "left" | "right" | "center" | undefined;
-    missedLabel?: string | undefined;
     showUpdatedAt?: boolean | undefined;
+    missedLabel?: string | undefined;
 }>;

package/dist/base/period-selector.d.ts

@@ -141,13 +141,13 @@ export declare const PeriodSelectorSchema: z.ZodObject<{
     size?: "xs" | "sm" | "md" | "lg" | "xl" | undefined;
     variant?: "default" | "segmented" | undefined;
     rememberKey?: string | undefined;
+    align?: "left" | "right" | "center" | undefined;
     defaultPreset?: "custom" | "all" | "last-hour" | "last-24h" | "today" | "yesterday" | "last-7-days" | "last-30-days" | "last-90-days" | "this-month" | "last-month" | "this-quarter" | "last-quarter" | "ytd" | "last-year" | undefined;
     defaultComparison?: "custom" | "none" | "previous-period" | "previous-year" | undefined;
     presets?: ("custom" | "all" | "last-hour" | "last-24h" | "today" | "yesterday" | "last-7-days" | "last-30-days" | "last-90-days" | "this-month" | "last-month" | "this-quarter" | "last-quarter" | "ytd" | "last-year")[] | undefined;
     comparisons?: ("custom" | "none" | "previous-period" | "previous-year")[] | undefined;
     presetLabels?: Partial<Record<"custom" | "all" | "last-hour" | "last-24h" | "today" | "yesterday" | "last-7-days" | "last-30-days" | "last-90-days" | "this-month" | "last-month" | "this-quarter" | "last-quarter" | "ytd" | "last-year", string>> | undefined;
     comparisonLabels?: Partial<Record<"custom" | "none" | "previous-period" | "previous-year", string>> | undefined;
-    align?: "left" | "right" | "center" | undefined;
     showRangeLabel?: boolean | undefined;
     rangeLabel?: "relative" | "absolute" | undefined;
     comparisonControl?: "hidden" | "menu" | "toggle" | undefined;
@@ -157,13 +157,13 @@ export declare const PeriodSelectorSchema: z.ZodObject<{
     id?: string | undefined;
     variant?: "default" | "segmented" | undefined;
     rememberKey?: string | undefined;
+    align?: "left" | "right" | "center" | undefined;
     defaultPreset?: "custom" | "all" | "last-hour" | "last-24h" | "today" | "yesterday" | "last-7-days" | "last-30-days" | "last-90-days" | "this-month" | "last-month" | "this-quarter" | "last-quarter" | "ytd" | "last-year" | undefined;
     defaultComparison?: "custom" | "none" | "previous-period" | "previous-year" | undefined;
     presets?: ("custom" | "all" | "last-hour" | "last-24h" | "today" | "yesterday" | "last-7-days" | "last-30-days" | "last-90-days" | "this-month" | "last-month" | "this-quarter" | "last-quarter" | "ytd" | "last-year")[] | undefined;
     comparisons?: ("custom" | "none" | "previous-period" | "previous-year")[] | undefined;
     presetLabels?: Partial<Record<"custom" | "all" | "last-hour" | "last-24h" | "today" | "yesterday" | "last-7-days" | "last-30-days" | "last-90-days" | "this-month" | "last-month" | "this-quarter" | "last-quarter" | "ytd" | "last-year", string>> | undefined;
     comparisonLabels?: Partial<Record<"custom" | "none" | "previous-period" | "previous-year", string>> | undefined;
-    align?: "left" | "right" | "center" | undefined;
     showRangeLabel?: boolean | undefined;
     rangeLabel?: "relative" | "absolute" | undefined;
     comparisonControl?: "hidden" | "menu" | "toggle" | undefined;

package/dist/base/table-view/schema.d.ts

@@ -839,17 +839,17 @@ export declare const TableViewSchema: z.ZodObject<{
         whileSorted: z.ZodOptional<z.ZodBoolean>;
         missedLabel: z.ZodOptional<z.ZodString>;
     }, "strip", z.ZodTypeAny, {
+        missedLabel?: string | undefined;
         whileRowOpen?: boolean | undefined;
         whileScrolled?: boolean | undefined;
         whileSearching?: boolean | undefined;
         whileSorted?: boolean | undefined;
-        missedLabel?: string | undefined;
     }, {
+        missedLabel?: string | undefined;
         whileRowOpen?: boolean | undefined;
         whileScrolled?: boolean | undefined;
         whileSearching?: boolean | undefined;
         whileSorted?: boolean | undefined;
-        missedLabel?: string | undefined;
     }>]>>;
     kanban: z.ZodOptional<z.ZodObject<{
         groupByField: z.ZodString;
@@ -1137,11 +1137,11 @@ export declare const TableViewSchema: z.ZodObject<{
     strictRuleValidation?: boolean | undefined;
     realtimeTopic?: string | string[] | undefined;
     liveHold?: boolean | {
+        missedLabel?: string | undefined;
         whileRowOpen?: boolean | undefined;
         whileScrolled?: boolean | undefined;
         whileSearching?: boolean | undefined;
         whileSorted?: boolean | undefined;
-        missedLabel?: string | undefined;
     } | undefined;
     defaultDisplay?: string | undefined;
     guards?: TableViewGuards<Record<string, unknown>> | undefined;
@@ -1352,11 +1352,11 @@ export declare const TableViewSchema: z.ZodObject<{
     realtime?: boolean | undefined;
     realtimeTopic?: string | string[] | undefined;
     liveHold?: boolean | {
+        missedLabel?: string | undefined;
         whileRowOpen?: boolean | undefined;
         whileScrolled?: boolean | undefined;
         whileSearching?: boolean | undefined;
         whileSorted?: boolean | undefined;
-        missedLabel?: string | undefined;
     } | undefined;
     defaultDisplay?: string | undefined;
     guards?: TableViewGuards<Record<string, unknown>> | undefined;

package/dist/db/internal/exportJobs.model.d.ts

@@ -24,6 +24,7 @@ declare const ExportJobModel_base: {
         delete(id: string): Promise<number>;
     };
     readonly schemaName: string;
+    readonly tableClass: import("@antelopejs/interface-database-decorators").Constructible<ExportJob>;
     fromPlainData(obj: any): ExportJob;
     fromDatabase(obj: any): ExportJob | undefined;
     toDatabase(obj: any): Record<string, any>;

package/dist/db/internal/inviteResolutions.model.d.ts

@@ -13,6 +13,7 @@ declare const InviteResolutionsModel_base: {
         delete(id: string): Promise<number>;
     };
     readonly schemaName: string;
+    readonly tableClass: import("@antelopejs/interface-database-decorators").Constructible<InviteResolution>;
     fromPlainData(obj: any): InviteResolution;
     fromDatabase(obj: any): InviteResolution | undefined;
     toDatabase(obj: any): Record<string, any>;

package/dist/db/internal/tenantLifecycle.model.d.ts

@@ -12,6 +12,7 @@ declare const TenantLifecycleModel_base: {
         delete(id: string): Promise<number>;
     };
     readonly schemaName: string;
+    readonly tableClass: import("@antelopejs/interface-database-decorators").Constructible<TenantLifecycle>;
     fromPlainData(obj: any): TenantLifecycle;
     fromDatabase(obj: any): TenantLifecycle | undefined;
     toDatabase(obj: any): Record<string, any>;

package/dist/db/models/roles.model.d.ts

@@ -12,6 +12,7 @@ declare const RoleModel_base: {
         delete(id: string): Promise<number>;
     };
     readonly schemaName: string;
+    readonly tableClass: import("@antelopejs/interface-database-decorators").Constructible<Role>;
     fromPlainData(obj: any): Role;
     fromDatabase(obj: any): Role | undefined;
     toDatabase(obj: any): Record<string, any>;

package/dist/db/models/tenantMembers.model.d.ts

@@ -12,6 +12,7 @@ declare const TenantMemberModel_base: {
         delete(id: string): Promise<number>;
     };
     readonly schemaName: string;
+    readonly tableClass: import("@antelopejs/interface-database-decorators").Constructible<TenantMember>;
     fromPlainData(obj: any): TenantMember;
     fromDatabase(obj: any): TenantMember | undefined;
     toDatabase(obj: any): Record<string, any>;

package/dist/db/models/tenants.model.d.ts

@@ -12,6 +12,7 @@ declare const TenantModel_base: {
         delete(id: string): Promise<number>;
     };
     readonly schemaName: string;
+    readonly tableClass: import("@antelopejs/interface-database-decorators").Constructible<Tenant>;
     fromPlainData(obj: any): Tenant;
     fromDatabase(obj: any): Tenant | undefined;
     toDatabase(obj: any): Record<string, any>;

package/dist/db/models/user_invites.model.d.ts

@@ -16,6 +16,7 @@ declare const UserInviteModel_base: {
         delete(id: string): Promise<number>;
     };
     readonly schemaName: string;
+    readonly tableClass: import("@antelopejs/interface-database-decorators").Constructible<UserInvite>;
     fromPlainData(obj: any): UserInvite;
     fromDatabase(obj: any): UserInvite | undefined;
     toDatabase(obj: any): Record<string, any>;

package/docs/.navigation.yml

@@ -0,0 +1,2 @@
+title: Interfaces
+icon: i-lucide-file-code-2

package/docs/1.core/.navigation.yml

@@ -0,0 +1,2 @@
+title: Core
+icon: i-lucide-cpu

package/docs/1.core/1.introduction.md

@@ -0,0 +1,169 @@
+---
+title: "Introduction"
+description: "The core contract of the DMS: pages and modules, components, permissions, tenancy, invites, hooks, realtime, quick actions and layout banners."
+---
+
+# Introduction
+
+## Overview
+
+The root export of `@antelopejs/interface-dms` and the subpaths listed below are the core contract of the AntelopeJS DMS. It encodes one inversion: the backend declares the screen, as serializable data. A page is a controller class, its components are static fields holding builders, and the page's layout route returns the description a shared frontend renders. Adding an admin screen is a backend change.
+
+Around that core the interface carries what an admin backend needs to be more than a renderer: hierarchical permissions derived from the page tree, multi-tenant data access scoped by the model handle, lifecycle hooks, realtime topics, and command-palette entries.
+
+Everything here is imported from a subpath of `@antelopejs/interface-dms`. Two other domains of the same package complete the picture and are referenced throughout these pages: [Auth](/docs/interfaces/auth/introduction) (`/auth`) for authentication and the `User` table, and [Base](/docs/interfaces/base/introduction) (`/base`) for the concrete component vocabulary (`Form`, `TableView`, `Grid`, the chart family) built on the component types documented here.
+
+## Key Features
+
+- **Pages as controllers** — `PageController` builds a controller class bound to a URL; `@RegisterPage()` records it, registers its permissions, and serves its layout.
+- **Components that serialize** — a `ComponentBuilder` produces data, not a live component, so one frontend renders every module's screens.
+- **Categories and modules** — a sidebar tree of nested categories, plus modules that own a whole branch under `/modules`.
+- **Dynamic navigation** — providers that resolve extra menu entries per request, so one page can back an entry per project or workspace.
+- **Page extensions** — inject components into a page owned by another module, permissioned in that page's own tree.
+- **Hierarchical permissions** — ids derived from page, component and action, with a base set from roles and an effective set shaped by registered resolvers.
+- **Route guards** — permission, tenant-member and tenant-owner decorators usable as parameter or property decorators.
+- **Tenancy in the handle** — per-tenant schemas and model handles bound to one tenant, rather than a tenant column filtered on every query.
+- **Tenant access gates** — one binary check that denies a tenant at every authorization surface at once.
+- **Invites** — one call that either grants membership to an existing user or issues a token-bearing invite.
+- **Lifecycle hooks** — typed events for tenants, members, invites and registrations, dispatched either to notify or to collect contributions.
+- **Realtime topics** — bind a topic to a page, publish to whoever is on it, and subscribe from the backend to what others publish.
+- **Quick actions** — contribute grouped, permission-gated entries to the command palette.
+
+## Dependencies
+
+This interface relies on the following AntelopeJS packages:
+
+- [@antelopejs/interface-api](https://github.com/AntelopeJS/interface-api) - Controllers, route registration and request context.
+- [@antelopejs/interface-auth](https://github.com/AntelopeJS/interface-auth) - The authentication decorator machinery the guards build on.
+- [@antelopejs/interface-core](https://github.com/AntelopeJS/interface-core) - Interface functions, registering proxies and decorator helpers.
+- [@antelopejs/interface-database-decorators](https://github.com/AntelopeJS/interface-database-decorators) - Table definitions, data models and model injection.
+- [@antelopejs/interface-data-api](https://github.com/AntelopeJS/interface-data-api) - Used by the `/data-controllers` subpath for the built-in members and roles controllers.
+
+## Quick Start
+
+Declare the application's table and model first. `BookModel` is not a DMS export; this example defines it with the stock flag used by the KPI query.
+
+```typescript [db.ts]
+import {
+  BasicDataModel,
+  Field,
+  RegisterTable,
+  Table,
+} from "@antelopejs/interface-database-decorators";
+
+export const CATALOG_SCHEMA = "example_catalog";
+
+@RegisterTable("books", CATALOG_SCHEMA)
+export class Book extends Table {
+  @Field("string") declare _id: string;
+  @Field("string") declare title: string;
+  @Field("boolean") declare inStock: boolean;
+}
+
+export class BookModel extends BasicDataModel(Book, "books") {}
+```
+
+Then declare a category, a page with a component, and the route that component fetches from:
+
+```typescript [books-page.ts]
+import { Get } from "@antelopejs/interface-api";
+import { GetModel } from "@antelopejs/interface-database-decorators";
+import {
+  Category,
+  PageController,
+  RegisterPage,
+  pagesCategory,
+} from "@antelopejs/interface-dms/page";
+import { KpiCard } from "@antelopejs/interface-dms/base";
+import { BookModel } from "./db";
+
+export const catalog = Category("catalog", {
+  displayName: "Catalog",
+  icon: "i-ph-books",
+  category: pagesCategory,
+});
+
+@RegisterPage()
+export class BooksPage extends PageController("books", {
+  displayName: "Books",
+  description: "Everything currently in the catalog",
+  icon: "i-ph-book-open",
+  category: catalog,
+  order: 1,
+}) {
+  static inStockKpi = KpiCard({
+    title: "In stock",
+    icon: "i-ph-package",
+    fetchUrl: "/catalog/books/stats/in-stock",
+    valueFormat: "number",
+  });
+
+  @Get("/stats/in-stock")
+  async inStock() {
+    const value = await GetModel(BookModel).table
+      .filter((book) => book.key("inStock").eq(true)).count().run();
+    return { value };
+  }
+}
+```
+
+Import the page and register the schema from your module's entry file, merging this into an existing `start()` if necessary:
+
+```typescript [index.ts]
+import "./books-page";
+import { RegisterSchema } from "@antelopejs/interface-database-decorators";
+import { CATALOG_SCHEMA } from "./db";
+
+export async function start(): Promise<void> {
+  await RegisterSchema(CATALOG_SCHEMA);
+}
+```
+
+The page resolves at `/catalog/books` and its layout at `/dms/pages/catalog/books/pagelayout`: a page controller's routes live under `/dms/pages` (`pageRoutePath`), a prefix the frontend server proxies to the backend, since the page's own path is the page. Its permission id is the chain of ids down from the root category — `pages.catalog.books` — with `pages.catalog.books.inStockKpi` registered underneath it.
+
+## Subpath Map
+
+| Subpath | Contains | Documented in |
+| ------- | -------- | ------------- |
+| `/page` | Pages, categories, modules, layouts, page extensions, dynamic menus, frontend modules | [Pages and Modules](/docs/interfaces/core/pages-and-modules) |
+| `/component` | `Component`, `ComponentBuilder`, actions, watches | [Components](/docs/interfaces/core/components) |
+| `/component-slots` | `RegisterComponentSlot`, `ComponentSlotResolver`, `SlotOptions` | [Components](/docs/interfaces/core/components#registercomponentslot) |
+| `/attachments` | `SaveComponentFiles` and its request, field and result types | [Pages and Modules](/docs/interfaces/core/pages-and-modules#savecomponentfiles) |
+| `/permission-gate` | Shared `PermissionGate` fields | [Base types](/docs/interfaces/base/types#permissiongate) |
+| `/permissions` | The permission registry and the permission computation | [Permissions](/docs/interfaces/core/permissions) |
+| `/permissions-resolver` | Registering and running permission resolvers | [Permissions](/docs/interfaces/core/permissions) |
+| `/guards` | `AuthUserWithPermission`, `AuthTenantOwner`, `AuthTenantMember` | [Permissions](/docs/interfaces/core/permissions) |
+| `/constants` | Schema names and the default tenant | [Tenancy](/docs/interfaces/core/tenancy) |
+| `/db` | The `Tenant`, `TenantMember`, `Role` and `UserInvite` tables and models | [Tenancy](/docs/interfaces/core/tenancy), [Invites](/docs/interfaces/core/invites) |
+| `/request-tenant` | `getRequestTenantId` | [Tenancy](/docs/interfaces/core/tenancy) |
+| `/tenant-scoped-model` | `TenantScopedModel` | [Tenancy](/docs/interfaces/core/tenancy) |
+| `/tenant-access` | Tenant access gates | [Tenancy](/docs/interfaces/core/tenancy) |
+| `/tenant-ownership` | Membership and ownership writes | [Tenancy](/docs/interfaces/core/tenancy) |
+| `/tenant-lifecycle` | Producer admission and closure before tenant deletion | [Tenancy](/docs/interfaces/core/tenancy#tenant-lifecycle-admission) |
+| `/data-controllers` | The built-in members and roles data controllers | [Tenancy](/docs/interfaces/core/tenancy) |
+| `/invites` | Inviting a user into a tenant | [Invites](/docs/interfaces/core/invites) |
+| `/invite-extensions` | Invite form contributions, callbacks and availability | [Invites](/docs/interfaces/core/invites#registerinviteextension) |
+| `/invite-resolution` | Durable terminal decisions and retryable effects | [Invites](/docs/interfaces/core/invites#durable-invite-resolution) |
+| `/hooks` | The `Hook` enum, handlers and dispatch | [Hooks](/docs/interfaces/core/hooks) |
+| `/tenant-export` | The tenant data export archive, contribution and manifest types, re-exported from `/hooks` | [Hooks](/docs/interfaces/core/hooks) |
+| `/realtime` | Page topics, publishing and backend subscription | [Realtime](/docs/interfaces/core/realtime) |
+| `/quick-actions` | Command-palette entries | [Quick Actions](/docs/interfaces/core/quick-actions) |
+| `/layout-banners` | Global banners under the dashboard header | [Layout Banners](/docs/interfaces/core/layout-banners) |
+| `/uploads` | Signed upload tokens for the file and image fields of a serialized component | [Pages and Modules](/docs/interfaces/core/pages-and-modules) |
+| `/types` | `MaybePromise`, the one shared type alias | [Pages and Modules](/docs/interfaces/core/pages-and-modules) |
+| `/api-base-url`, `/client-base-url` | `GetApiBaseUrl`, `GetClientBaseUrl`: the public origins of the API and the dashboard | [Pages and Modules](/docs/interfaces/core/pages-and-modules#public-urls) |
+| `/client-ip` | `getClientIp`, `ResolveClientIp`: a request's client address behind the trusted proxies | [Pages and Modules](/docs/interfaces/core/pages-and-modules#client-address) |
+
+Paths under `internal/`, symbols tagged `@internal`, and `internal` namespaces are implementation wiring, not supported consumer APIs. The wildcard export does not change that boundary.
+
+## Documentation Sections
+
+- [Pages and Modules](/docs/interfaces/core/pages-and-modules) - Declare pages, group them into categories, own a branch of the sidebar with a module, and extend a page from another one
+- [Components](/docs/interfaces/core/components) - Build serializable components, declare actions and watches
+- [Permissions](/docs/interfaces/core/permissions) - Register permissions, compute a user's effective set, guard routes
+- [Tenancy](/docs/interfaces/core/tenancy) - Schemas, the tenancy tables, tenant-scoped models and access gates
+- [Invites](/docs/interfaces/core/invites) - Bring a user into a tenant by email
+- [Hooks](/docs/interfaces/core/hooks) - React to platform events and contribute to the tenant data export
+- [Realtime](/docs/interfaces/core/realtime) - Bind topics to pages, publish messages and subscribe to them
+- [Quick Actions](/docs/interfaces/core/quick-actions) - Contribute entries to the command palette
+- [Layout Banners](/docs/interfaces/core/layout-banners) - Show a global banner under the dashboard header, decided per request