@antelopejs/interface-dms 0.3.5 → 0.3.6

package/dist/hooks.d.ts

@@ -3,7 +3,37 @@ import type { TenantDataExportContribution, TenantExportArchive } from "./tenant
 export * from "./tenant-export";
 export type HookCallback = (...args: any[]) => any;
 export declare enum Hook {
+    /**
+     * The database schemas are registered and the DMS is about to serve.
+     *
+     * It behaves like an already-resolved promise: the DMS fires it once per
+     * start, and a handler registered after that — by a module loaded or
+     * reloaded while the DMS runs — runs at once, in the background. It fires
+     * again on every DMS start, and a reloaded module registers again, so a
+     * handler may run several times over the life of a process and must be
+     * safe to replay against a live database.
+     */
     DATABASE_INITIALIZED = "database:initialized",
+    /**
+     * A workspace is being provisioned, and nothing of it is final yet.
+     *
+     * Handlers run in series, each awaited before the next, and one that throws
+     * propagates to whoever is provisioning: that emitter must then unwind the
+     * workspace it was creating. That direction is the guarantee, and the reason
+     * to fire before the commit rather than after it — a workspace never ends up
+     * provisioned while the enrichment a consumer needed failed to be written.
+     *
+     * The other direction is not guaranteed and cannot be: there is no shared
+     * transaction to enlist in. A handler that already returned has committed
+     * its own rows, and neither a later handler throwing nor the emitter failing
+     * afterwards takes them back. Key that write on `tenantId` so it can be
+     * cleaned up along with the workspace, and make it idempotent so a retried
+     * signup does not double it.
+     *
+     * No DMS code fires this hook. Provisioning belongs to the signup flow of a
+     * SaaS module, and the contract above is what such an emitter owes its
+     * subscribers.
+     */
     TENANT_BEING_PROVISIONED = "tenant:being-provisioned",
     TENANT_DELETED = "tenant:deleted",
     TENANT_DATA_EXPORT = "tenant:data-export",
@@ -13,11 +43,37 @@ export declare enum Hook {
     MEMBER_BEING_ADDED = "member:being-added",
     MEMBER_ADDED = "member:added",
     MEMBER_REMOVED = "member:removed",
-    USER_REGISTERED = "user:registered"
+    USER_REGISTERED = "user:registered",
+    /**
+     * A user was deleted, by any path — today, deleting one's own account
+     * (`reason: "self"`). Fired once the DMS has removed what it keeps about
+     * them (memberships, sessions, notifications, sign-in links and the user
+     * row); a module keeping per-user or per-tenant rows of its own deletes
+     * them here, `tenantIds` naming the workspaces the user belonged to. A
+     * failing handler is logged and does not bring the account back.
+     */
+    USER_DELETED = "user:deleted"
 }
+/**
+ * The workspace being provisioned, and whatever the caller of the provisioning
+ * flow asked to carry along with it.
+ */
 export interface TenantProvisioningHookPayload {
     tenantId: string;
+    /** Account the workspace is being provisioned for. */
     userId: string;
+    /**
+     * Data the caller of the provisioning flow attached to the request — an
+     * acquisition source, a team size, a referral code, whatever that product
+     * collects at signup.
+     *
+     * It is opaque on purpose. The DMS never reads a key of it, never validates
+     * it and never stores it: it carries the object to the handlers, and a
+     * handler writes what it recognises into its own tables. The shape is a
+     * contract between the caller and the handler, one the DMS is deliberately
+     * not a party to — which is what lets a consumer collect new fields without
+     * a DMS release.
+     */
     extras: Record<string, unknown>;
 }
 export interface InviteHookPayload {
@@ -25,28 +81,40 @@ export interface InviteHookPayload {
     email: string;
     asTenantOwner: boolean;
     roleIds: string[];
+    /** Stable replacement decision identity; creation hooks may replay. */
     deliveryId?: string;
 }
 export interface InviteCreatedHookPayload extends InviteHookPayload {
     inviteId: string;
     token: string;
 }
+/**
+ * Why an invitation row went away. Two of them delete a row without the
+ * invitation ending: `accepted` means the invitee joined and it was consumed,
+ * `resent` that the same invitation was reissued under a fresh token. Only
+ * `cancelled` and `replaced` retire what the invitation stood for.
+ */
 export type InviteDeletedReason = "accepted" | "cancelled" | "replaced" | "expired" | "resent";
+/** Reasons under which creating an invitation displaces an existing one. */
 export type InviteReplacementReason = Extract<InviteDeletedReason, "replaced" | "resent">;
 export interface InviteDeletedHookPayload {
     tenantId: string;
     inviteId: string;
     email: string;
     reason: InviteDeletedReason;
+    /** Stable terminal decision identity. Handlers must tolerate concurrent replay. */
     deliveryId?: string;
+    /** Payloads the invitation carried, for handlers that must undo their work. */
     extensions?: InviteExtensionPayloads | null;
 }
 export interface MemberHookPayload {
     tenantId: string;
     userId: string;
     isTenantOwner: boolean;
+    /** Stable invite delivery identity when membership originates from a durable acceptance. */
     deliveryId?: string;
 }
+/** Tenant deletion hooks can repeat; deduplicate non-idempotent effects by operationId. */
 export interface TenantDeletionContext {
     operationId: string;
 }
@@ -54,6 +122,16 @@ export interface MemberRemovedHookPayload {
     tenantId: string;
     userIds: string[];
 }
+/** Why a user was deleted: `self`, the user deleted their own account. */
+export type UserDeletionReason = "self";
+/** What `Hook.USER_DELETED` hands its handlers. */
+export interface UserDeletedHookPayload {
+    userId: string;
+    email: string;
+    /** The workspaces the user was a member of, left before the deletion. */
+    tenantIds: string[];
+    reason: UserDeletionReason;
+}
 export interface UserRegisteredHookPayload {
     tenantId: string;
     userId: string;
@@ -101,6 +179,10 @@ export interface HookSignatures {
         args: [payload: MemberRemovedHookPayload];
         result: undefined;
     };
+    [Hook.USER_DELETED]: {
+        args: [payload: UserDeletedHookPayload];
+        result: undefined;
+    };
     [Hook.USER_REGISTERED]: {
         args: [payload: UserRegisteredHookPayload];
         result: undefined;
@@ -108,18 +190,68 @@ export interface HookSignatures {
 }
 export type HookHandler<H extends Hook> = (...args: HookSignatures[H]["args"]) => Promise<HookSignatures[H]["result"]> | HookSignatures[H]["result"];
 export interface HookRegistrationOptions {
+    /**
+     * Overrides the module id auto-detected from the registering call site. It
+     * only names the handler: the registration is released with the module
+     * generation that made it either way.
+     */
     moduleId?: string;
 }
 export interface RegisteredHook<H extends Hook> {
+    /** Owning module, undefined when it could not be resolved. */
     moduleId?: string;
     handler: HookHandler<H>;
 }
+/**
+ * Hooks whose firing is a state rather than an event: once settled with
+ * {@link SettleHook}, a handler registered afterwards runs at once.
+ */
 export type StickyHook = Hook.DATABASE_INITIALIZED;
+/**
+ * Run `callback` whenever `name` fires.
+ *
+ * The handler belongs to the module generation that registers it and is
+ * released when that generation is destroyed: a module reloaded in development
+ * registers again from its next generation, and its previous handler is gone
+ * rather than running beside the new one. Nothing has to be unregistered on
+ * the way out.
+ *
+ * A handler for a {@link StickyHook} that has already settled also runs at
+ * once, in the background; a failure is logged, never thrown here.
+ */
 export declare function RegisterHook<H extends Hook>(name: H, callback: HookHandler<H>, options?: HookRegistrationOptions): void;
+/**
+ * Drop a handler registered with {@link RegisterHook}, for a module that stops
+ * listening while it stays loaded.
+ */
 export declare function UnregisterHook<H extends Hook>(name: H, callback: HookHandler<H>): void;
+/**
+ * Exposes the registered handlers along with their owning module, for callers
+ * that must invoke each handler with its own arguments — the tenant export
+ * archive hands every contributor a differently namespaced archive.
+ */
 export declare function GetRegisteredHooks<H extends Hook>(name: H): RegisteredHook<H>[];
+/**
+ * Registers a tenant data export contributor with an explicit module id, used
+ * to namespace its archive entries. Prefer it over a bare `RegisterHook` when
+ * the contributor writes to the archive: the id then no longer depends on the
+ * call site the runtime attributes the registration to.
+ */
 export declare function RegisterTenantDataExportContributor(moduleId: string, handler: HookHandler<Hook.TENANT_DATA_EXPORT>): void;
 export declare function ExecuteHooks<H extends Hook>(name: H, ...args: HookSignatures[H]["args"]): Promise<void>;
+/**
+ * Fire a {@link StickyHook} and keep it settled: the handlers registered by
+ * then run in series, as {@link ExecuteHooks} runs them, along with any
+ * registered while they run, and every handler registered afterwards runs at
+ * once until {@link UnsettleHook}. A failure propagates and leaves the hook
+ * unsettled.
+ *
+ * The settled state belongs to the calling module generation and goes with it.
+ */
 export declare function SettleHook<H extends StickyHook>(name: H, ...args: HookSignatures[H]["args"]): Promise<void>;
+/**
+ * End what {@link SettleHook} started: later registrations wait for the hook
+ * to be settled again.
+ */
 export declare function UnsettleHook(name: StickyHook): void;
 export declare function CollectHooks<H extends Hook>(name: H, ...args: HookSignatures[H]["args"]): Promise<HookSignatures[H]["result"][]>;

package/dist/hooks.js

@@ -25,11 +25,41 @@ exports.UnsettleHook = UnsettleHook;
 exports.CollectHooks = CollectHooks;
 const interface_core_1 = require("@antelopejs/interface-core");
 const logging_1 = require("@antelopejs/interface-core/logging");
-const owned_registry_1 = require("./utils/owned-registry");
+const owned_registry_1 = require("./utils/internal/owned-registry");
 __exportStar(require("./tenant-export"), exports);
 var Hook;
 (function (Hook) {
+    /**
+     * The database schemas are registered and the DMS is about to serve.
+     *
+     * It behaves like an already-resolved promise: the DMS fires it once per
+     * start, and a handler registered after that — by a module loaded or
+     * reloaded while the DMS runs — runs at once, in the background. It fires
+     * again on every DMS start, and a reloaded module registers again, so a
+     * handler may run several times over the life of a process and must be
+     * safe to replay against a live database.
+     */
     Hook["DATABASE_INITIALIZED"] = "database:initialized";
+    /**
+     * A workspace is being provisioned, and nothing of it is final yet.
+     *
+     * Handlers run in series, each awaited before the next, and one that throws
+     * propagates to whoever is provisioning: that emitter must then unwind the
+     * workspace it was creating. That direction is the guarantee, and the reason
+     * to fire before the commit rather than after it — a workspace never ends up
+     * provisioned while the enrichment a consumer needed failed to be written.
+     *
+     * The other direction is not guaranteed and cannot be: there is no shared
+     * transaction to enlist in. A handler that already returned has committed
+     * its own rows, and neither a later handler throwing nor the emitter failing
+     * afterwards takes them back. Key that write on `tenantId` so it can be
+     * cleaned up along with the workspace, and make it idempotent so a retried
+     * signup does not double it.
+     *
+     * No DMS code fires this hook. Provisioning belongs to the signup flow of a
+     * SaaS module, and the contract above is what such an emitter owes its
+     * subscribers.
+     */
     Hook["TENANT_BEING_PROVISIONED"] = "tenant:being-provisioned";
     Hook["TENANT_DELETED"] = "tenant:deleted";
     Hook["TENANT_DATA_EXPORT"] = "tenant:data-export";
@@ -40,8 +70,19 @@ var Hook;
     Hook["MEMBER_ADDED"] = "member:added";
     Hook["MEMBER_REMOVED"] = "member:removed";
     Hook["USER_REGISTERED"] = "user:registered";
+    /**
+     * A user was deleted, by any path — today, deleting one's own account
+     * (`reason: "self"`). Fired once the DMS has removed what it keeps about
+     * them (memberships, sessions, notifications, sign-in links and the user
+     * row); a module keeping per-user or per-tenant rows of its own deletes
+     * them here, `tenantIds` naming the workspaces the user belonged to. A
+     * failing handler is logged and does not bring the account back.
+     */
+    Hook["USER_DELETED"] = "user:deleted";
 })(Hook || (exports.Hook = Hook = {}));
 const hooksRegistry = new Map();
+// Owned by the module generation that settles a hook, so a destroyed DMS
+// takes the settled state down with it even when `stop()` never ran.
 const settledHooks = new owned_registry_1.OwnedRegistry();
 function getHooks(name) {
     const existing = hooksRegistry.get(name);
@@ -57,6 +98,11 @@ function logHookFailure(name, error) {
 function findSettledHook(name) {
     return settledHooks.values().find((settled) => settled.name === name);
 }
+/**
+ * Runs a handler registered after its hook settled, without blocking the
+ * registration: the registering module's `construct()` or `start()` neither
+ * waits for it nor sees its failure.
+ */
 function runLateHandler(settled, callback, owner) {
     const run = async () => callback(...settled.args);
     const runAsOwner = async () => owner ? (0, interface_core_1.RunWithResponsibleModule)(owner, run) : run();
@@ -66,6 +112,18 @@ function runLateHandler(settled, callback, owner) {
         logging_1.Logging.Error(`Hook '${settled.name}' handler of module '${owner ?? "unknown"}' failed:`, error);
     });
 }
+/**
+ * Run `callback` whenever `name` fires.
+ *
+ * The handler belongs to the module generation that registers it and is
+ * released when that generation is destroyed: a module reloaded in development
+ * registers again from its next generation, and its previous handler is gone
+ * rather than running beside the new one. Nothing has to be unregistered on
+ * the way out.
+ *
+ * A handler for a {@link StickyHook} that has already settled also runs at
+ * once, in the background; a failure is logged, never thrown here.
+ */
 function RegisterHook(name, callback, options) {
     const owner = (0, interface_core_1.GetResponsibleModule)();
     getHooks(name).add({
@@ -76,9 +134,18 @@ function RegisterHook(name, callback, options) {
     if (settled)
         runLateHandler(settled, callback, owner);
 }
+/**
+ * Drop a handler registered with {@link RegisterHook}, for a module that stops
+ * listening while it stays loaded.
+ */
 function UnregisterHook(name, callback) {
     getHooks(name).remove((entry) => entry.callback === callback);
 }
+/**
+ * Exposes the registered handlers along with their owning module, for callers
+ * that must invoke each handler with its own arguments — the tenant export
+ * archive hands every contributor a differently namespaced archive.
+ */
 function GetRegisteredHooks(name) {
     return getHooks(name)
         .values()
@@ -87,6 +154,12 @@ function GetRegisteredHooks(name) {
         handler: entry.callback,
     }));
 }
+/**
+ * Registers a tenant data export contributor with an explicit module id, used
+ * to namespace its archive entries. Prefer it over a bare `RegisterHook` when
+ * the contributor writes to the archive: the id then no longer depends on the
+ * call site the runtime attributes the registration to.
+ */
 function RegisterTenantDataExportContributor(moduleId, handler) {
     RegisterHook(Hook.TENANT_DATA_EXPORT, handler, { moduleId });
 }
@@ -95,6 +168,15 @@ async function ExecuteHooks(name, ...args) {
         await hook.callback(...args);
     }
 }
+/**
+ * Fire a {@link StickyHook} and keep it settled: the handlers registered by
+ * then run in series, as {@link ExecuteHooks} runs them, along with any
+ * registered while they run, and every handler registered afterwards runs at
+ * once until {@link UnsettleHook}. A failure propagates and leaves the hook
+ * unsettled.
+ *
+ * The settled state belongs to the calling module generation and goes with it.
+ */
 async function SettleHook(name, ...args) {
     const ran = new Set();
     let pending = getHooks(name).values();
@@ -109,6 +191,10 @@ async function SettleHook(name, ...args) {
     }
     settledHooks.add({ name, args });
 }
+/**
+ * End what {@link SettleHook} started: later registrations wait for the hook
+ * to be settled again.
+ */
 function UnsettleHook(name) {
     const isSettled = (settled) => settled.name === name;
     while (settledHooks.has(isSettled))

package/dist/hooks.js.map

@@ -1 +1 @@
-{"version":3,"file":"hooks.js","sourceRoot":"","sources":["../src/hooks.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAuSA,oCAYC;AAMD,wCAKC;AAOD,gDASC;AAQD,kFAKC;AAED,oCAOC;AAWD,gCAgBC;AAMD,oCAGC;AAED,oCAgBC;AA1ZD,+DAGoC;AACpC,gEAA6D;AAM7D,2DAAuD;AAEvD,kDAAgC;AAMhC,IAAY,IA0CX;AA1CD,WAAY,IAAI;IAWd,qDAA6C,CAAA;IAqB7C,6DAAqD,CAAA;IACrD,yCAAiC,CAAA;IACjC,iDAAyC,CAAA;IACzC,qDAA6C,CAAA;IAC7C,yCAAiC,CAAA;IACjC,yCAAiC,CAAA;IACjC,iDAAyC,CAAA;IACzC,qCAA6B,CAAA;IAC7B,yCAAiC,CAAA;IACjC,2CAAmC,CAAA;AACrC,CAAC,EA1CW,IAAI,oBAAJ,IAAI,QA0Cf;AAkLD,MAAM,aAAa,GAAG,IAAI,GAAG,EAAkC,CAAC;AAIhE,MAAM,YAAY,GAAG,IAAI,8BAAa,EAAe,CAAC;AAEtD,SAAS,QAAQ,CAAC,IAAU;IAC1B,MAAM,QAAQ,GAAG,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IACzC,IAAI,QAAQ;QAAE,OAAO,QAAQ,CAAC;IAC9B,MAAM,KAAK,GAAG,IAAI,8BAAa,EAAa,CAAC;IAC7C,aAAa,CAAC,GAAG,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IAC/B,OAAO,KAAK,CAAC;AACf,CAAC;AAED,SAAS,cAAc,CAAC,IAAU,EAAE,KAAc;IAChD,iBAAO,CAAC,KAAK,CAAC,SAAS,IAAI,qBAAqB,EAAE,KAAK,CAAC,CAAC;AAC3D,CAAC;AAED,SAAS,eAAe,CAAC,IAAU;IACjC,OAAO,YAAY,CAAC,MAAM,EAAE,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC;AACxE,CAAC;AAOD,SAAS,cAAc,CACrB,OAAoB,EACpB,QAAsB,EACtB,KAAyB;IAEzB,MAAM,GAAG,GAAG,KAAK,IAAsB,EAAE,CAAC,QAAQ,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACpE,MAAM,UAAU,GAAG,KAAK,IAAsB,EAAE,CAC9C,KAAK,CAAC,CAAC,CAAC,IAAA,yCAAwB,EAAC,KAAK,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC;IACvD,KAAK,OAAO,CAAC,OAAO,EAAE;SACnB,IAAI,CAAC,UAAU,CAAC;SAChB,KAAK,CAAC,CAAC,KAAc,EAAE,EAAE;QACxB,iBAAO,CAAC,KAAK,CACX,SAAS,OAAO,CAAC,IAAI,wBAAwB,KAAK,IAAI,SAAS,WAAW,EAC1E,KAAK,CACN,CAAC;IACJ,CAAC,CAAC,CAAC;AACP,CAAC;AAcD,SAAgB,YAAY,CAC1B,IAAO,EACP,QAAwB,EACxB,OAAiC;IAEjC,MAAM,KAAK,GAAG,IAAA,qCAAoB,GAAE,CAAC;IACrC,QAAQ,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC;QACjB,QAAQ,EAAE,QAAwB;QAClC,QAAQ,EAAE,OAAO,EAAE,QAAQ,IAAI,KAAK;KACrC,CAAC,CAAC;IACH,MAAM,OAAO,GAAG,eAAe,CAAC,IAAI,CAAC,CAAC;IACtC,IAAI,OAAO;QAAE,cAAc,CAAC,OAAO,EAAE,QAAwB,EAAE,KAAK,CAAC,CAAC;AACxE,CAAC;AAMD,SAAgB,cAAc,CAC5B,IAAO,EACP,QAAwB;IAExB,QAAQ,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,QAAQ,KAAK,QAAQ,CAAC,CAAC;AAChE,CAAC;AAOD,SAAgB,kBAAkB,CAChC,IAAO;IAEP,OAAO,QAAQ,CAAC,IAAI,CAAC;SAClB,MAAM,EAAE;SACR,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;QACf,QAAQ,EAAE,KAAK,CAAC,QAAQ;QACxB,OAAO,EAAE,KAAK,CAAC,QAA0B;KAC1C,CAAC,CAAC,CAAC;AACR,CAAC;AAQD,SAAgB,mCAAmC,CACjD,QAAgB,EAChB,OAA6C;IAE7C,YAAY,CAAC,IAAI,CAAC,kBAAkB,EAAE,OAAO,EAAE,EAAE,QAAQ,EAAE,CAAC,CAAC;AAC/D,CAAC;AAEM,KAAK,UAAU,YAAY,CAChC,IAAO,EACP,GAAG,IAA+B;IAElC,KAAK,MAAM,IAAI,IAAI,QAAQ,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC;QAC3C,MAAM,IAAI,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC,CAAC;IAC/B,CAAC;AACH,CAAC;AAWM,KAAK,UAAU,UAAU,CAC9B,IAAO,EACP,GAAG,IAA+B;IAElC,MAAM,GAAG,GAAG,IAAI,GAAG,EAAa,CAAC;IACjC,IAAI,OAAO,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,CAAC;IACtC,OAAO,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC1B,KAAK,MAAM,IAAI,IAAI,OAAO,EAAE,CAAC;YAC3B,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;YACd,MAAM,IAAI,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC,CAAC;QAC/B,CAAC;QACD,OAAO,GAAG,QAAQ,CAAC,IAAI,CAAC;aACrB,MAAM,EAAE;aACR,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC;IACtC,CAAC;IACD,YAAY,CAAC,GAAG,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;AACnC,CAAC;AAMD,SAAgB,YAAY,CAAC,IAAgB;IAC3C,MAAM,SAAS,GAAG,CAAC,OAAoB,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,KAAK,IAAI,CAAC;IAClE,OAAO,YAAY,CAAC,GAAG,CAAC,SAAS,CAAC;QAAE,YAAY,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;AACrE,CAAC;AAEM,KAAK,UAAU,YAAY,CAChC,IAAO,EACP,GAAG,IAA+B;IAElC,MAAM,OAAO,GAAkC,EAAE,CAAC;IAClD,KAAK,MAAM,IAAI,IAAI,QAAQ,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC;QAC3C,IAAI,CAAC;YACH,MAAM,KAAK,GAAG,CAAC,MAAM,IAAI,CAAC,QAAQ,CAChC,GAAG,IAAI,CACR,CAAgC,CAAC;YAClC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACtB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,cAAc,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;QAC9B,CAAC;IACH,CAAC;IACD,OAAO,OAAO,CAAC;AACjB,CAAC"}
+{"version":3,"file":"hooks.js","sourceRoot":"","sources":["../src/hooks.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAgUA,oCAYC;AAMD,wCAKC;AAOD,gDASC;AAQD,kFAKC;AAED,oCAOC;AAWD,gCAgBC;AAMD,oCAGC;AAED,oCAgBC;AAnbD,+DAGoC;AACpC,gEAA6D;AAM7D,oEAAgE;AAEhE,kDAAgC;AAMhC,IAAY,IAmDX;AAnDD,WAAY,IAAI;IACd;;;;;;;;;OASG;IACH,qDAA6C,CAAA;IAC7C;;;;;;;;;;;;;;;;;;;OAmBG;IACH,6DAAqD,CAAA;IACrD,yCAAiC,CAAA;IACjC,iDAAyC,CAAA;IACzC,qDAA6C,CAAA;IAC7C,yCAAiC,CAAA;IACjC,yCAAiC,CAAA;IACjC,iDAAyC,CAAA;IACzC,qCAA6B,CAAA;IAC7B,yCAAiC,CAAA;IACjC,2CAAmC,CAAA;IACnC;;;;;;;OAOG;IACH,qCAA6B,CAAA;AAC/B,CAAC,EAnDW,IAAI,oBAAJ,IAAI,QAmDf;AAkMD,MAAM,aAAa,GAAG,IAAI,GAAG,EAAkC,CAAC;AAEhE,yEAAyE;AACzE,qEAAqE;AACrE,MAAM,YAAY,GAAG,IAAI,8BAAa,EAAe,CAAC;AAEtD,SAAS,QAAQ,CAAC,IAAU;IAC1B,MAAM,QAAQ,GAAG,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IACzC,IAAI,QAAQ;QAAE,OAAO,QAAQ,CAAC;IAC9B,MAAM,KAAK,GAAG,IAAI,8BAAa,EAAa,CAAC;IAC7C,aAAa,CAAC,GAAG,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IAC/B,OAAO,KAAK,CAAC;AACf,CAAC;AAED,SAAS,cAAc,CAAC,IAAU,EAAE,KAAc;IAChD,iBAAO,CAAC,KAAK,CAAC,SAAS,IAAI,qBAAqB,EAAE,KAAK,CAAC,CAAC;AAC3D,CAAC;AAED,SAAS,eAAe,CAAC,IAAU;IACjC,OAAO,YAAY,CAAC,MAAM,EAAE,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC;AACxE,CAAC;AAED;;;;GAIG;AACH,SAAS,cAAc,CACrB,OAAoB,EACpB,QAAsB,EACtB,KAAyB;IAEzB,MAAM,GAAG,GAAG,KAAK,IAAsB,EAAE,CAAC,QAAQ,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACpE,MAAM,UAAU,GAAG,KAAK,IAAsB,EAAE,CAC9C,KAAK,CAAC,CAAC,CAAC,IAAA,yCAAwB,EAAC,KAAK,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC;IACvD,KAAK,OAAO,CAAC,OAAO,EAAE;SACnB,IAAI,CAAC,UAAU,CAAC;SAChB,KAAK,CAAC,CAAC,KAAc,EAAE,EAAE;QACxB,iBAAO,CAAC,KAAK,CACX,SAAS,OAAO,CAAC,IAAI,wBAAwB,KAAK,IAAI,SAAS,WAAW,EAC1E,KAAK,CACN,CAAC;IACJ,CAAC,CAAC,CAAC;AACP,CAAC;AAED;;;;;;;;;;;GAWG;AACH,SAAgB,YAAY,CAC1B,IAAO,EACP,QAAwB,EACxB,OAAiC;IAEjC,MAAM,KAAK,GAAG,IAAA,qCAAoB,GAAE,CAAC;IACrC,QAAQ,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC;QACjB,QAAQ,EAAE,QAAwB;QAClC,QAAQ,EAAE,OAAO,EAAE,QAAQ,IAAI,KAAK;KACrC,CAAC,CAAC;IACH,MAAM,OAAO,GAAG,eAAe,CAAC,IAAI,CAAC,CAAC;IACtC,IAAI,OAAO;QAAE,cAAc,CAAC,OAAO,EAAE,QAAwB,EAAE,KAAK,CAAC,CAAC;AACxE,CAAC;AAED;;;GAGG;AACH,SAAgB,cAAc,CAC5B,IAAO,EACP,QAAwB;IAExB,QAAQ,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,QAAQ,KAAK,QAAQ,CAAC,CAAC;AAChE,CAAC;AAED;;;;GAIG;AACH,SAAgB,kBAAkB,CAChC,IAAO;IAEP,OAAO,QAAQ,CAAC,IAAI,CAAC;SAClB,MAAM,EAAE;SACR,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;QACf,QAAQ,EAAE,KAAK,CAAC,QAAQ;QACxB,OAAO,EAAE,KAAK,CAAC,QAA0B;KAC1C,CAAC,CAAC,CAAC;AACR,CAAC;AAED;;;;;GAKG;AACH,SAAgB,mCAAmC,CACjD,QAAgB,EAChB,OAA6C;IAE7C,YAAY,CAAC,IAAI,CAAC,kBAAkB,EAAE,OAAO,EAAE,EAAE,QAAQ,EAAE,CAAC,CAAC;AAC/D,CAAC;AAEM,KAAK,UAAU,YAAY,CAChC,IAAO,EACP,GAAG,IAA+B;IAElC,KAAK,MAAM,IAAI,IAAI,QAAQ,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC;QAC3C,MAAM,IAAI,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC,CAAC;IAC/B,CAAC;AACH,CAAC;AAED;;;;;;;;GAQG;AACI,KAAK,UAAU,UAAU,CAC9B,IAAO,EACP,GAAG,IAA+B;IAElC,MAAM,GAAG,GAAG,IAAI,GAAG,EAAa,CAAC;IACjC,IAAI,OAAO,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,CAAC;IACtC,OAAO,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC1B,KAAK,MAAM,IAAI,IAAI,OAAO,EAAE,CAAC;YAC3B,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;YACd,MAAM,IAAI,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC,CAAC;QAC/B,CAAC;QACD,OAAO,GAAG,QAAQ,CAAC,IAAI,CAAC;aACrB,MAAM,EAAE;aACR,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC;IACtC,CAAC;IACD,YAAY,CAAC,GAAG,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;AACnC,CAAC;AAED;;;GAGG;AACH,SAAgB,YAAY,CAAC,IAAgB;IAC3C,MAAM,SAAS,GAAG,CAAC,OAAoB,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,KAAK,IAAI,CAAC;IAClE,OAAO,YAAY,CAAC,GAAG,CAAC,SAAS,CAAC;QAAE,YAAY,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;AACrE,CAAC;AAEM,KAAK,UAAU,YAAY,CAChC,IAAO,EACP,GAAG,IAA+B;IAElC,MAAM,OAAO,GAAkC,EAAE,CAAC;IAClD,KAAK,MAAM,IAAI,IAAI,QAAQ,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC;QAC3C,IAAI,CAAC;YACH,MAAM,KAAK,GAAG,CAAC,MAAM,IAAI,CAAC,QAAQ,CAChC,GAAG,IAAI,CACR,CAAgC,CAAC;YAClC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACtB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,cAAc,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;QAC9B,CAAC;IACH,CAAC;IACD,OAAO,OAAO,CAAC;AACjB,CAAC"}

package/dist/html-render/index.d.ts

@@ -1,10 +1,25 @@
 import { RegisteringProxy } from "@antelopejs/interface-core";
 import type { HtmlTemplateInfo, HtmlTemplateRef } from "./types";
 export * from "./types";
+/**
+ * @internal
+ */
 export declare namespace internal {
     const RegisterHtmlTemplate: RegisteringProxy<(info: HtmlTemplateInfo) => void>;
 }
+/**
+ * Renders a template to HTML by calling the frontend render endpoint.
+ * @throws Error if the render endpoint is unreachable or returns an error
+ */
 export declare const GenerateHtml: (template: HtmlTemplateRef<unknown>, props: unknown, language?: string | undefined) => Promise<string>;
+/** Returns template info by name, or undefined if not registered. */
 export declare const GetHtmlTemplate: (key: string) => Promise<HtmlTemplateInfo | undefined>;
+/** Returns all registered templates as a Record<name, info>. */
 export declare const GetAllHtmlTemplates: () => Promise<Record<string, HtmlTemplateInfo>>;
+/**
+ * Registers an HTML template and returns a typed reference for use with GenerateHtml.
+ * @example
+ * const WelcomeEmail = RegisterHtmlTemplate<{ userName: string }>("welcome-email");
+ * const html = await GenerateHtml(WelcomeEmail, { userName: "John" });
+ */
 export declare function RegisterHtmlTemplate<TProps = unknown>(name: string): HtmlTemplateRef<TProps>;

package/dist/html-render/index.js

@@ -18,13 +18,28 @@ exports.GetAllHtmlTemplates = exports.GetHtmlTemplate = exports.GenerateHtml = e
 exports.RegisterHtmlTemplate = RegisterHtmlTemplate;
 const interface_core_1 = require("@antelopejs/interface-core");
 __exportStar(require("./types"), exports);
+/**
+ * @internal
+ */
 var internal;
 (function (internal) {
     internal.RegisterHtmlTemplate = new interface_core_1.RegisteringProxy();
 })(internal || (exports.internal = internal = {}));
+/**
+ * Renders a template to HTML by calling the frontend render endpoint.
+ * @throws Error if the render endpoint is unreachable or returns an error
+ */
 exports.GenerateHtml = (0, interface_core_1.InterfaceFunction)();
+/** Returns template info by name, or undefined if not registered. */
 exports.GetHtmlTemplate = (0, interface_core_1.InterfaceFunction)();
+/** Returns all registered templates as a Record<name, info>. */
 exports.GetAllHtmlTemplates = (0, interface_core_1.InterfaceFunction)();
+/**
+ * Registers an HTML template and returns a typed reference for use with GenerateHtml.
+ * @example
+ * const WelcomeEmail = RegisterHtmlTemplate<{ userName: string }>("welcome-email");
+ * const html = await GenerateHtml(WelcomeEmail, { userName: "John" });
+ */
 function RegisterHtmlTemplate(name) {
     internal.RegisterHtmlTemplate.register({
         name,

package/dist/html-render/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/html-render/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AA4CA,oDAQC;AApDD,+DAGoC;AAGpC,0CAAwB;AAKxB,IAAiB,QAAQ,CAIxB;AAJD,WAAiB,QAAQ;IACV,6BAAoB,GAAG,IAAI,iCAAgB,EAErD,CAAC;AACN,CAAC,EAJgB,QAAQ,wBAAR,QAAQ,QAIxB;AAMY,QAAA,YAAY,GACvB,IAAA,kCAAiB,GAMd,CAAC;AAGO,QAAA,eAAe,GAC1B,IAAA,kCAAiB,GAAiD,CAAC;AAGxD,QAAA,mBAAmB,GAC9B,IAAA,kCAAiB,GAA0C,CAAC;AAQ9D,SAAgB,oBAAoB,CAClC,IAAY;IAEZ,QAAQ,CAAC,oBAAoB,CAAC,QAAQ,CAAC;QACrC,IAAI;KACL,CAAC,CAAC;IAEH,OAAO,EAAE,IAAI,EAAE,CAAC;AAClB,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/html-render/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AA4CA,oDAQC;AApDD,+DAGoC;AAGpC,0CAAwB;AAExB;;GAEG;AACH,IAAiB,QAAQ,CAIxB;AAJD,WAAiB,QAAQ;IACV,6BAAoB,GAAG,IAAI,iCAAgB,EAErD,CAAC;AACN,CAAC,EAJgB,QAAQ,wBAAR,QAAQ,QAIxB;AAED;;;GAGG;AACU,QAAA,YAAY,GACvB,IAAA,kCAAiB,GAMd,CAAC;AAEN,qEAAqE;AACxD,QAAA,eAAe,GAC1B,IAAA,kCAAiB,GAAiD,CAAC;AAErE,gEAAgE;AACnD,QAAA,mBAAmB,GAC9B,IAAA,kCAAiB,GAA0C,CAAC;AAE9D;;;;;GAKG;AACH,SAAgB,oBAAoB,CAClC,IAAY;IAEZ,QAAQ,CAAC,oBAAoB,CAAC,QAAQ,CAAC;QACrC,IAAI;KACL,CAAC,CAAC;IAEH,OAAO,EAAE,IAAI,EAAE,CAAC;AAClB,CAAC"}

package/dist/html-render/types.d.ts

@@ -7,6 +7,10 @@ export interface HtmlTemplateRef<TProps = unknown> {
 }
 export interface HtmlRenderConfig {
     serviceSecret: string;
+    /**
+     * Lifetime of each render-service token, in milliseconds. The frontend
+     * render server rejects tokens valid for more than five minutes.
+     */
     serviceTokenLifetime: number;
     renderEndpoint: string;
 }

package/dist/index.d.ts

@@ -1,25 +1,24 @@
-export { AttachmentField, AttachmentSaveRequest, AttachmentSaveResult, GetAttachmentValidationMetadata, SaveComponentFiles, TableViewAttachmentSaveRequest, } from "./attachments";
+export { AttachmentField, AttachmentSaveRequest, AttachmentSaveResult, GetAttachmentValidationMetadata, SaveComponentFiles, } from "./attachments";
 export * from "./component";
 export * from "./component-slots";
 export * from "./constants";
 export { AuthTenantMember, AuthTenantOwner, AuthUserWithPermission, TenantGuardOptions, TenantRequestGuardOptions, authenticateTenantRequest, } from "./guards";
 export * from "./hooks";
-export { HTTP_BAD_REQUEST, INVITE_EDIT_FORM_SLOT_ID, INVITE_EXTENSION_FIELD_SEPARATOR, INVITE_FORM_SLOT_ID, InviteAcceptHandler, InviteCleanupContext, InviteCleanupHandler, InviteCleanupReason, InviteDeliveryOptions, InviteExtensionContext, InviteExtensionEntry, InviteExtensionFieldId, InviteExtensionInfo, InviteExtensionOptions, InviteExtensionPayloads, InviteExtensionPlacement, InviteFieldContribution, InviteUpdateHandler, RegisterInviteExtension, ResolvedInvitePlacement, getInviteExtension, inviteExtensionFieldId, listInviteExtensionEntries, listInviteExtensions, logInviteExtensionFailure, splitInviteExtensionFieldId, } from "./invite-extensions";
-export * from "./invite-membership";
-export * from "./invite-replacement";
+export { InviteAcceptHandler, InviteCleanupContext, InviteCleanupHandler, InviteCleanupReason, InviteExtensionContext, InviteExtensionOptions, InviteExtensionPayloads, InviteExtensionPlacement, InviteUpdateHandler, RegisterInviteExtension, } from "./invite-extensions";
 export * from "./invite-resolution";
 export { CreateUserInviteTokenOptions, CreateUserInviteTokenResult, INVITE_EXPIRY_DAYS, INVITE_TOKEN_LENGTH, InviteUserToTenantOptions, InviteUserToTenantResult, createUserInviteToken, inviteUserToTenant, inviteeDisplayName, } from "./invites";
 export { LayoutBannerComponentInfo, LayoutBannerContext, LayoutBannerInfo, LayoutBannerTextInfo, LayoutBannerVariant, LayoutBannerVisibility, RegisterLayoutBanner, } from "./layout-banners";
-export { AddFrontendModule, AddFrontendModuleOptions, Category, CategoryInfo, ClearPageLayoutBySlug, DynamicMenuItem, DynamicMenuProviderInfo, DynamicMenuResolver, FrontendModuleMetadata, FrontendModuleOptions, FrontendModuleValue, FrontendRendererMetadata, GetComponentPermissionIds, GetFrontendModules, GetPageLayoutBySlug, GetPendingPageExtensions, GetPermissionId, GetRegisteredPageIds, MODULE_URL_PREFIX, MaybePromise, MenuItemQuery, MenuItemStatus, MenuItemType, MenuItemVariant, MenuOptions, ModuleInfo, NotifyMenuChanged, PageController, PageExtensionComponent, PageExtensionInfo, PageInfo, PageLayout, PageLayoutHandler, PageMetadata, PageSetupCleanup, PageSetupContext, PageSetupFunction, PageValidation, PendingPageExtension, ROOT_SLUG, RegisterDynamicMenuProvider, RegisterModule, RegisterPage, RegisterPageExtension, RootCategory, RootPageController, isInsideModule, modulesCategory, pagesCategory, settingsCategory, } from "./page";
+export { AddFrontendModule, AddFrontendModuleOptions, Category, CategoryInfo, ClearPageLayoutBySlug, DynamicMenuItem, DynamicMenuProviderInfo, DynamicMenuResolver, FrontendModuleMetadata, FrontendModuleOptions, FrontendModuleValue, FrontendRendererMetadata, GetComponentPermissionIds, GetFrontendModules, GetPageLayoutBySlug, GetPermissionId, GetRegisteredPageIds, MODULE_URL_PREFIX, MaybePromise, MenuItemQuery, MenuItemStatus, MenuItemType, MenuItemVariant, MenuOptions, ModuleCatalogContext, ModuleInfo, ModuleReadoutLine, ModuleReadoutTone, ModuleStatus, NotifyMenuChanged, PageController, PageExtensionComponent, PageExtensionInfo, PageInfo, PageLayout, PageLayoutHandler, PageMetadata, PageSetupCleanup, PageSetupContext, PageSetupFunction, PageValidation, RegisterDynamicMenuProvider, RegisterModule, RegisterPage, RegisterPageExtension, RootCategory, RootPageController, isInsideModule, modulesCategory, pagesCategory, settingsCategory, } from "./page";
 export { GetEffectiveUserPermissions, GetPermission, GetPermissions, GetUserPermissions, HasAnyPermission, HasPermission, IsModuleScopedPermission, MarkModuleScopedPermission, Permission, PermissionTree, RegisterPermission, UnmarkModuleScopedPermission, UnregisterPermission, } from "./permissions";
 export { ApplyPermissionsResolvers, PermissionsResolverFn, PermissionsResolverInfo, RegisterPermissionsResolver, } from "./permissions-resolver";
 export { QuickAction, QuickActionCategory, QuickActionCategoryInfo, QuickActionInfo, QuickActionPageTarget, QuickActionTarget, } from "./quick-actions";
 export { PublishMessage, PublishMessageOptions, RealtimeMessage, RealtimeMessageHandler, RegisterPageTopic, SubscribeMessage, UnsubscribeMessage, } from "./realtime";
+export * from "./permission-gate";
 export * from "./request-tenant";
-export { AssertTenantAccess, CheckTenantAccess, GatedSurface, RegisterTenantAccessGate, TenantAccessGateFn, TenantAccessGateInfo, TenantAccessResult, gateAllowsSurface, } from "./tenant-access";
+export { AssertTenantAccess, CheckTenantAccess, RegisterTenantAccessGate, TenantAccessGateFn, TenantAccessGateInfo, TenantAccessResult, } from "./tenant-access";
 export * from "./tenant-export";
 export * from "./tenant-lifecycle";
 export * from "./tenant-ownership";
 export * from "./tenant-scoped-model";
 export * from "./types";
-export { NativeUploadFieldRegistration, SignUploadToken, StampUploadFieldTokens, UploadTokenClaims, } from "./uploads";
+export { SignUploadToken, StampUploadFieldTokens } from "./uploads";

package/dist/index.js

@@ -14,8 +14,17 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.GetPermission = exports.GetEffectiveUserPermissions = exports.settingsCategory = exports.pagesCategory = exports.modulesCategory = exports.isInsideModule = exports.RootPageController = exports.RootCategory = exports.RegisterPageExtension = exports.RegisterPage = exports.RegisterModule = exports.RegisterDynamicMenuProvider = exports.ROOT_SLUG = exports.PageMetadata = exports.PageController = exports.NotifyMenuChanged = exports.MODULE_URL_PREFIX = exports.GetRegisteredPageIds = exports.GetPermissionId = exports.GetPendingPageExtensions = exports.GetPageLayoutBySlug = exports.GetFrontendModules = exports.GetComponentPermissionIds = exports.ClearPageLayoutBySlug = exports.Category = exports.AddFrontendModule = exports.RegisterLayoutBanner = exports.LayoutBannerVariant = exports.inviteeDisplayName = exports.inviteUserToTenant = exports.createUserInviteToken = exports.INVITE_TOKEN_LENGTH = exports.INVITE_EXPIRY_DAYS = exports.splitInviteExtensionFieldId = exports.logInviteExtensionFailure = exports.listInviteExtensions = exports.listInviteExtensionEntries = exports.inviteExtensionFieldId = exports.getInviteExtension = exports.RegisterInviteExtension = exports.INVITE_FORM_SLOT_ID = exports.INVITE_EXTENSION_FIELD_SEPARATOR = exports.INVITE_EDIT_FORM_SLOT_ID = exports.HTTP_BAD_REQUEST = exports.authenticateTenantRequest = exports.AuthUserWithPermission = exports.AuthTenantOwner = exports.AuthTenantMember = exports.SaveComponentFiles = exports.GetAttachmentValidationMetadata = void 0;
-exports.StampUploadFieldTokens = exports.SignUploadToken = exports.gateAllowsSurface = exports.RegisterTenantAccessGate = exports.CheckTenantAccess = exports.AssertTenantAccess = exports.SubscribeMessage = exports.RegisterPageTopic = exports.PublishMessage = exports.QuickActionCategory = exports.QuickAction = exports.RegisterPermissionsResolver = exports.ApplyPermissionsResolvers = exports.UnregisterPermission = exports.UnmarkModuleScopedPermission = exports.RegisterPermission = exports.MarkModuleScopedPermission = exports.IsModuleScopedPermission = exports.HasPermission = exports.HasAnyPermission = exports.GetUserPermissions = exports.GetPermissions = void 0;
+exports.QuickAction = exports.RegisterPermissionsResolver = exports.ApplyPermissionsResolvers = exports.UnregisterPermission = exports.UnmarkModuleScopedPermission = exports.RegisterPermission = exports.MarkModuleScopedPermission = exports.IsModuleScopedPermission = exports.HasPermission = exports.HasAnyPermission = exports.GetUserPermissions = exports.GetPermissions = exports.GetPermission = exports.GetEffectiveUserPermissions = exports.settingsCategory = exports.pagesCategory = exports.modulesCategory = exports.isInsideModule = exports.RootPageController = exports.RootCategory = exports.RegisterPageExtension = exports.RegisterPage = exports.RegisterModule = exports.RegisterDynamicMenuProvider = exports.PageMetadata = exports.PageController = exports.NotifyMenuChanged = exports.MODULE_URL_PREFIX = exports.GetRegisteredPageIds = exports.GetPermissionId = exports.GetPageLayoutBySlug = exports.GetFrontendModules = exports.GetComponentPermissionIds = exports.ClearPageLayoutBySlug = exports.Category = exports.AddFrontendModule = exports.RegisterLayoutBanner = exports.LayoutBannerVariant = exports.inviteeDisplayName = exports.inviteUserToTenant = exports.createUserInviteToken = exports.INVITE_TOKEN_LENGTH = exports.INVITE_EXPIRY_DAYS = exports.RegisterInviteExtension = exports.authenticateTenantRequest = exports.AuthUserWithPermission = exports.AuthTenantOwner = exports.AuthTenantMember = exports.SaveComponentFiles = exports.GetAttachmentValidationMetadata = void 0;
+exports.StampUploadFieldTokens = exports.SignUploadToken = exports.RegisterTenantAccessGate = exports.CheckTenantAccess = exports.AssertTenantAccess = exports.SubscribeMessage = exports.RegisterPageTopic = exports.PublishMessage = exports.QuickActionCategory = void 0;
+// The DMS interface root. It re-exports the public surface of the `dms`
+// interface modules; the domain folders (`auth`, `base`, `notifications`,
+// `html-render`) and the database layer (`db`, `data-controllers`) keep their
+// own subpaths, since they register schemas and controllers as they evaluate.
+//
+// Modules that carry an `internal` implementation namespace are re-exported by
+// name: `internal` is the hook `ImplementInterface` binds, every module declares
+// its own, and merging them here would be both ambiguous and wrong. Reach it
+// through the module's own subpath.
 var attachments_1 = require("./attachments");
 Object.defineProperty(exports, "GetAttachmentValidationMetadata", { enumerable: true, get: function () { return attachments_1.GetAttachmentValidationMetadata; } });
 Object.defineProperty(exports, "SaveComponentFiles", { enumerable: true, get: function () { return attachments_1.SaveComponentFiles; } });
@@ -29,19 +38,7 @@ Object.defineProperty(exports, "AuthUserWithPermission", { enumerable: true, get
 Object.defineProperty(exports, "authenticateTenantRequest", { enumerable: true, get: function () { return guards_1.authenticateTenantRequest; } });
 __exportStar(require("./hooks"), exports);
 var invite_extensions_1 = require("./invite-extensions");
-Object.defineProperty(exports, "HTTP_BAD_REQUEST", { enumerable: true, get: function () { return invite_extensions_1.HTTP_BAD_REQUEST; } });
-Object.defineProperty(exports, "INVITE_EDIT_FORM_SLOT_ID", { enumerable: true, get: function () { return invite_extensions_1.INVITE_EDIT_FORM_SLOT_ID; } });
-Object.defineProperty(exports, "INVITE_EXTENSION_FIELD_SEPARATOR", { enumerable: true, get: function () { return invite_extensions_1.INVITE_EXTENSION_FIELD_SEPARATOR; } });
-Object.defineProperty(exports, "INVITE_FORM_SLOT_ID", { enumerable: true, get: function () { return invite_extensions_1.INVITE_FORM_SLOT_ID; } });
 Object.defineProperty(exports, "RegisterInviteExtension", { enumerable: true, get: function () { return invite_extensions_1.RegisterInviteExtension; } });
-Object.defineProperty(exports, "getInviteExtension", { enumerable: true, get: function () { return invite_extensions_1.getInviteExtension; } });
-Object.defineProperty(exports, "inviteExtensionFieldId", { enumerable: true, get: function () { return invite_extensions_1.inviteExtensionFieldId; } });
-Object.defineProperty(exports, "listInviteExtensionEntries", { enumerable: true, get: function () { return invite_extensions_1.listInviteExtensionEntries; } });
-Object.defineProperty(exports, "listInviteExtensions", { enumerable: true, get: function () { return invite_extensions_1.listInviteExtensions; } });
-Object.defineProperty(exports, "logInviteExtensionFailure", { enumerable: true, get: function () { return invite_extensions_1.logInviteExtensionFailure; } });
-Object.defineProperty(exports, "splitInviteExtensionFieldId", { enumerable: true, get: function () { return invite_extensions_1.splitInviteExtensionFieldId; } });
-__exportStar(require("./invite-membership"), exports);
-__exportStar(require("./invite-replacement"), exports);
 __exportStar(require("./invite-resolution"), exports);
 var invites_1 = require("./invites");
 Object.defineProperty(exports, "INVITE_EXPIRY_DAYS", { enumerable: true, get: function () { return invites_1.INVITE_EXPIRY_DAYS; } });
@@ -59,14 +56,12 @@ Object.defineProperty(exports, "ClearPageLayoutBySlug", { enumerable: true, get:
 Object.defineProperty(exports, "GetComponentPermissionIds", { enumerable: true, get: function () { return page_1.GetComponentPermissionIds; } });
 Object.defineProperty(exports, "GetFrontendModules", { enumerable: true, get: function () { return page_1.GetFrontendModules; } });
 Object.defineProperty(exports, "GetPageLayoutBySlug", { enumerable: true, get: function () { return page_1.GetPageLayoutBySlug; } });
-Object.defineProperty(exports, "GetPendingPageExtensions", { enumerable: true, get: function () { return page_1.GetPendingPageExtensions; } });
 Object.defineProperty(exports, "GetPermissionId", { enumerable: true, get: function () { return page_1.GetPermissionId; } });
 Object.defineProperty(exports, "GetRegisteredPageIds", { enumerable: true, get: function () { return page_1.GetRegisteredPageIds; } });
 Object.defineProperty(exports, "MODULE_URL_PREFIX", { enumerable: true, get: function () { return page_1.MODULE_URL_PREFIX; } });
 Object.defineProperty(exports, "NotifyMenuChanged", { enumerable: true, get: function () { return page_1.NotifyMenuChanged; } });
 Object.defineProperty(exports, "PageController", { enumerable: true, get: function () { return page_1.PageController; } });
 Object.defineProperty(exports, "PageMetadata", { enumerable: true, get: function () { return page_1.PageMetadata; } });
-Object.defineProperty(exports, "ROOT_SLUG", { enumerable: true, get: function () { return page_1.ROOT_SLUG; } });
 Object.defineProperty(exports, "RegisterDynamicMenuProvider", { enumerable: true, get: function () { return page_1.RegisterDynamicMenuProvider; } });
 Object.defineProperty(exports, "RegisterModule", { enumerable: true, get: function () { return page_1.RegisterModule; } });
 Object.defineProperty(exports, "RegisterPage", { enumerable: true, get: function () { return page_1.RegisterPage; } });
@@ -99,12 +94,12 @@ var realtime_1 = require("./realtime");
 Object.defineProperty(exports, "PublishMessage", { enumerable: true, get: function () { return realtime_1.PublishMessage; } });
 Object.defineProperty(exports, "RegisterPageTopic", { enumerable: true, get: function () { return realtime_1.RegisterPageTopic; } });
 Object.defineProperty(exports, "SubscribeMessage", { enumerable: true, get: function () { return realtime_1.SubscribeMessage; } });
+__exportStar(require("./permission-gate"), exports);
 __exportStar(require("./request-tenant"), exports);
 var tenant_access_1 = require("./tenant-access");
 Object.defineProperty(exports, "AssertTenantAccess", { enumerable: true, get: function () { return tenant_access_1.AssertTenantAccess; } });
 Object.defineProperty(exports, "CheckTenantAccess", { enumerable: true, get: function () { return tenant_access_1.CheckTenantAccess; } });
 Object.defineProperty(exports, "RegisterTenantAccessGate", { enumerable: true, get: function () { return tenant_access_1.RegisterTenantAccessGate; } });
-Object.defineProperty(exports, "gateAllowsSurface", { enumerable: true, get: function () { return tenant_access_1.gateAllowsSurface; } });
 __exportStar(require("./tenant-export"), exports);
 __exportStar(require("./tenant-lifecycle"), exports);
 __exportStar(require("./tenant-ownership"), exports);

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;AASA,6CAOuB;AAHrB,8HAAA,+BAA+B,OAAA;AAC/B,iHAAA,kBAAkB,OAAA;AAGpB,8CAA4B;AAC5B,oDAAkC;AAClC,8CAA4B;AAC5B,mCAOkB;AANhB,0GAAA,gBAAgB,OAAA;AAChB,yGAAA,eAAe,OAAA;AACf,gHAAA,sBAAsB,OAAA;AAGtB,mHAAA,yBAAyB,OAAA;AAE3B,0CAAwB;AACxB,yDA2B6B;AA1B3B,qHAAA,gBAAgB,OAAA;AAChB,6HAAA,wBAAwB,OAAA;AACxB,qIAAA,gCAAgC,OAAA;AAChC,wHAAA,mBAAmB,OAAA;AAenB,4HAAA,uBAAuB,OAAA;AAEvB,uHAAA,kBAAkB,OAAA;AAClB,2HAAA,sBAAsB,OAAA;AACtB,+HAAA,0BAA0B,OAAA;AAC1B,yHAAA,oBAAoB,OAAA;AACpB,8HAAA,yBAAyB,OAAA;AACzB,gIAAA,2BAA2B,OAAA;AAE7B,sDAAoC;AACpC,uDAAqC;AACrC,sDAAoC;AACpC,qCAUmB;AAPjB,6GAAA,kBAAkB,OAAA;AAClB,8GAAA,mBAAmB,OAAA;AAGnB,gHAAA,qBAAqB,OAAA;AACrB,6GAAA,kBAAkB,OAAA;AAClB,6GAAA,kBAAkB,OAAA;AAEpB,mDAQ0B;AAHxB,qHAAA,mBAAmB,OAAA;AAEnB,sHAAA,oBAAoB,OAAA;AAEtB,+BAmDgB;AAlDd,yGAAA,iBAAiB,OAAA;AAEjB,gGAAA,QAAQ,OAAA;AAER,6GAAA,qBAAqB,OAAA;AAQrB,iHAAA,yBAAyB,OAAA;AACzB,0GAAA,kBAAkB,OAAA;AAClB,2GAAA,mBAAmB,OAAA;AACnB,gHAAA,wBAAwB,OAAA;AACxB,uGAAA,eAAe,OAAA;AACf,4GAAA,oBAAoB,OAAA;AACpB,yGAAA,iBAAiB,OAAA;AAQjB,yGAAA,iBAAiB,OAAA;AACjB,sGAAA,cAAc,OAAA;AAMd,oGAAA,YAAY,OAAA;AAMZ,iGAAA,SAAS,OAAA;AACT,mHAAA,2BAA2B,OAAA;AAC3B,sGAAA,cAAc,OAAA;AACd,oGAAA,YAAY,OAAA;AACZ,6GAAA,qBAAqB,OAAA;AACrB,oGAAA,YAAY,OAAA;AACZ,0GAAA,kBAAkB,OAAA;AAClB,sGAAA,cAAc,OAAA;AACd,uGAAA,eAAe,OAAA;AACf,qGAAA,aAAa,OAAA;AACb,wGAAA,gBAAgB,OAAA;AAElB,6CAcuB;AAbrB,0HAAA,2BAA2B,OAAA;AAC3B,4GAAA,aAAa,OAAA;AACb,6GAAA,cAAc,OAAA;AACd,iHAAA,kBAAkB,OAAA;AAClB,+GAAA,gBAAgB,OAAA;AAChB,4GAAA,aAAa,OAAA;AACb,uHAAA,wBAAwB,OAAA;AACxB,yHAAA,0BAA0B,OAAA;AAG1B,iHAAA,kBAAkB,OAAA;AAClB,2HAAA,4BAA4B,OAAA;AAC5B,mHAAA,oBAAoB,OAAA;AAEtB,+DAKgC;AAJ9B,iIAAA,yBAAyB,OAAA;AAGzB,mIAAA,2BAA2B,OAAA;AAE7B,iDAOyB;AANvB,4GAAA,WAAW,OAAA;AACX,oHAAA,mBAAmB,OAAA;AAMrB,uCAQoB;AAPlB,0GAAA,cAAc,OAAA;AAId,6GAAA,iBAAiB,OAAA;AACjB,4GAAA,gBAAgB,OAAA;AAGlB,mDAAiC;AACjC,iDASyB;AARvB,mHAAA,kBAAkB,OAAA;AAClB,kHAAA,iBAAiB,OAAA;AAEjB,yHAAA,wBAAwB,OAAA;AAIxB,kHAAA,iBAAiB,OAAA;AAEnB,kDAAgC;AAChC,qDAAmC;AACnC,qDAAmC;AACnC,wDAAsC;AACtC,0CAAwB;AACxB,qCAKmB;AAHjB,0GAAA,eAAe,OAAA;AACf,iHAAA,sBAAsB,OAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;AAAA,wEAAwE;AACxE,0EAA0E;AAC1E,8EAA8E;AAC9E,8EAA8E;AAC9E,EAAE;AACF,+EAA+E;AAC/E,iFAAiF;AACjF,6EAA6E;AAC7E,oCAAoC;AACpC,6CAMuB;AAFrB,8HAAA,+BAA+B,OAAA;AAC/B,iHAAA,kBAAkB,OAAA;AAEpB,8CAA4B;AAC5B,oDAAkC;AAClC,8CAA4B;AAC5B,mCAOkB;AANhB,0GAAA,gBAAgB,OAAA;AAChB,yGAAA,eAAe,OAAA;AACf,gHAAA,sBAAsB,OAAA;AAGtB,mHAAA,yBAAyB,OAAA;AAE3B,0CAAwB;AACxB,yDAW6B;AAD3B,4HAAA,uBAAuB,OAAA;AAEzB,sDAAoC;AACpC,qCAUmB;AAPjB,6GAAA,kBAAkB,OAAA;AAClB,8GAAA,mBAAmB,OAAA;AAGnB,gHAAA,qBAAqB,OAAA;AACrB,6GAAA,kBAAkB,OAAA;AAClB,6GAAA,kBAAkB,OAAA;AAEpB,mDAQ0B;AAHxB,qHAAA,mBAAmB,OAAA;AAEnB,sHAAA,oBAAoB,OAAA;AAEtB,+BAoDgB;AAnDd,yGAAA,iBAAiB,OAAA;AAEjB,gGAAA,QAAQ,OAAA;AAER,6GAAA,qBAAqB,OAAA;AAQrB,iHAAA,yBAAyB,OAAA;AACzB,0GAAA,kBAAkB,OAAA;AAClB,2GAAA,mBAAmB,OAAA;AACnB,uGAAA,eAAe,OAAA;AACf,4GAAA,oBAAoB,OAAA;AACpB,yGAAA,iBAAiB,OAAA;AAYjB,yGAAA,iBAAiB,OAAA;AACjB,sGAAA,cAAc,OAAA;AAMd,oGAAA,YAAY,OAAA;AAKZ,mHAAA,2BAA2B,OAAA;AAC3B,sGAAA,cAAc,OAAA;AACd,oGAAA,YAAY,OAAA;AACZ,6GAAA,qBAAqB,OAAA;AACrB,oGAAA,YAAY,OAAA;AACZ,0GAAA,kBAAkB,OAAA;AAClB,sGAAA,cAAc,OAAA;AACd,uGAAA,eAAe,OAAA;AACf,qGAAA,aAAa,OAAA;AACb,wGAAA,gBAAgB,OAAA;AAElB,6CAcuB;AAbrB,0HAAA,2BAA2B,OAAA;AAC3B,4GAAA,aAAa,OAAA;AACb,6GAAA,cAAc,OAAA;AACd,iHAAA,kBAAkB,OAAA;AAClB,+GAAA,gBAAgB,OAAA;AAChB,4GAAA,aAAa,OAAA;AACb,uHAAA,wBAAwB,OAAA;AACxB,yHAAA,0BAA0B,OAAA;AAG1B,iHAAA,kBAAkB,OAAA;AAClB,2HAAA,4BAA4B,OAAA;AAC5B,mHAAA,oBAAoB,OAAA;AAEtB,+DAKgC;AAJ9B,iIAAA,yBAAyB,OAAA;AAGzB,mIAAA,2BAA2B,OAAA;AAE7B,iDAOyB;AANvB,4GAAA,WAAW,OAAA;AACX,oHAAA,mBAAmB,OAAA;AAMrB,uCAQoB;AAPlB,0GAAA,cAAc,OAAA;AAId,6GAAA,iBAAiB,OAAA;AACjB,4GAAA,gBAAgB,OAAA;AAGlB,oDAAkC;AAClC,mDAAiC;AACjC,iDAOyB;AANvB,mHAAA,kBAAkB,OAAA;AAClB,kHAAA,iBAAiB,OAAA;AACjB,yHAAA,wBAAwB,OAAA;AAK1B,kDAAgC;AAChC,qDAAmC;AACnC,qDAAmC;AACnC,wDAAsC;AACtC,0CAAwB;AACxB,qCAAoE;AAA3D,0GAAA,eAAe,OAAA;AAAE,iHAAA,sBAAsB,OAAA"}

package/dist/internal/attachments.d.ts

@@ -0,0 +1,16 @@
+import type { RequestContext } from "@antelopejs/interface-api";
+import type { DataControllerCallback } from "@antelopejs/interface-data-api";
+/**
+ * Trusted inputs used to wrap a table-view attachment write.
+ *
+ * @internal
+ */
+export interface TableViewAttachmentSaveRequest {
+    controller: unknown;
+    route: DataControllerCallback;
+    context: RequestContext;
+    params: unknown;
+    args: unknown[];
+    mode: "save" | "delete";
+    componentIds: string[];
+}

package/dist/internal/attachments.js

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

package/dist/internal/attachments.js.map

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