@antelopejs/dms 0.11.1 → 0.12.0

package/dist/implementations/dms/page/state.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ERROR_UNAUTHORIZED = exports.HTTP_FORBIDDEN = exports.nodeTargets = exports.nodeProviders = exports.dynamicMenuProviders = exports.moduleRegistry = exports.navigationTree = exports.categoriesByFullId = void 0;
+exports.categoriesByFullId = {};
+exports.navigationTree = {
+    displayName: "",
+    children: {},
+    childrenOrders: [],
+    id: "",
+    fullId: "",
+    fullSlug: "",
+    category: undefined,
+};
+exports.moduleRegistry = {};
+exports.dynamicMenuProviders = [];
+exports.nodeProviders = new WeakMap();
+exports.nodeTargets = new WeakMap();
+exports.HTTP_FORBIDDEN = 403;
+exports.ERROR_UNAUTHORIZED = "error.unauthorized";
+//# sourceMappingURL=state.js.map

package/dist/implementations/dms/page/state.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"state.js","sourceRoot":"","sources":["../../../../src/implementations/dms/page/state.ts"],"names":[],"mappings":";;;AAQa,QAAA,kBAAkB,GAAiC,EAAE,CAAC;AAEtD,QAAA,cAAc,GAAmB;IAC5C,WAAW,EAAE,EAAE;IACf,QAAQ,EAAE,EAAE;IACZ,cAAc,EAAE,EAAE;IAClB,EAAE,EAAE,EAAE;IACN,MAAM,EAAE,EAAE;IACV,QAAQ,EAAE,EAAE;IACZ,QAAQ,EAAE,SAAS;CACpB,CAAC;AAEW,QAAA,cAAc,GAA+B,EAAE,CAAC;AAEhD,QAAA,oBAAoB,GAA8B,EAAE,CAAC;AAErD,QAAA,aAAa,GAAG,IAAI,OAAO,EAAmC,CAAC;AAE/D,QAAA,WAAW,GAAG,IAAI,OAAO,EAAoB,CAAC;AAE9C,QAAA,cAAc,GAAG,GAAG,CAAC;AAErB,QAAA,kBAAkB,GAAG,oBAAoB,CAAC"}

package/dist/implementations/dms/page/types.d.ts

@@ -0,0 +1,148 @@
+import { type PageInfo, type CategoryInfo, type ModuleInfo, type PageLayout, PageMetadata, type ModuleStatus, type ModuleReadoutLine } from "@antelopejs/interface-dms/page";
+import type { WithCategoryRef, TreeWithCategoryRefs } from "../menu-categories";
+import type { LayoutBannerSerialized } from "../layout-banners";
+import type { QuickActionsPayload, QuickActionTargetSerialized } from "../quick-actions";
+import type { ResolvedNavBadges } from "@antelopejs/interface-dms/page/internal/nav-badges";
+import type { User } from "@antelopejs/interface-dms/auth/db";
+import { TenantMemberModel, RoleModel } from "@antelopejs/interface-dms/db";
+import type { RequestContext } from "@antelopejs/interface-api";
+import type { ServedQuickActions } from "../permission-preview";
+import type { QuickActionTarget } from "@antelopejs/interface-dms/quick-actions";
+import type { Component } from "@antelopejs/interface-dms/component";
+export type SiteLayoutTree = Omit<PageInfo, "layoutUrl"> & {
+    children: Record<string, SiteLayoutTree>;
+    childrenOrders: string[];
+    layoutUrl?: string;
+    hasAccess?: boolean;
+};
+export interface AccessContext {
+    permissions: Set<string>;
+    isOwner: boolean;
+    isAuthenticated: boolean;
+}
+export interface RequestAccessContext {
+    gated: AccessContext;
+    ungated: AccessContext;
+    client: AccessContext;
+    gateDenied: boolean;
+    entryAccess: Map<string, Promise<boolean>>;
+}
+export interface AccessFlag {
+    hasAccess: boolean;
+}
+export type ServedPage = WithCategoryRef<PageInfo & AccessFlag>;
+export interface SiteLayoutWithAccess {
+    pages: Record<string, ServedPage>;
+    categories: Record<string, WithCategoryRef<CategoryInfo & AccessFlag>>;
+    banners: LayoutBannerSerialized[];
+}
+export interface SiteLayoutPayload {
+    siteLayout: SiteLayoutWithAccess;
+    siteLayoutTree: TreeWithCategoryRefs<SiteLayoutTree>;
+    quickActions: QuickActionsPayload;
+    modules: Record<string, ModuleInfo & AccessFlag>;
+    isOwner: boolean;
+}
+export interface PagePayload {
+    route: ServedPage;
+    shared: SiteLayoutPayload;
+    layout: PageLayout;
+    navBadges: ResolvedNavBadges;
+}
+export interface PageResponsePayload extends Omit<PagePayload, "shared"> {
+    shared?: SiteLayoutPayload;
+}
+export type SharedPagePayloadArguments = [
+    slug: string,
+    user: User | undefined,
+    memberModel: TenantMemberModel,
+    roleModel: RoleModel,
+    tenantId: string
+];
+export type PageResponsePayloadArguments = [
+    ...SharedPagePayloadArguments,
+    includeShared: boolean,
+    requestContext?: RequestContext
+];
+export interface PermissionPreviewPage {
+    fullId: string;
+    displayName: string;
+    pagePermissionId: string;
+    filtersComponents: boolean;
+    hiddenInPreview: boolean;
+    components: PageLayout["components"];
+    hiddenHeaderActions: string[];
+}
+export interface PermissionPreviewGrants {
+    real: Set<string>;
+    preview: Set<string>;
+}
+export type PreviewPageLossCheck = (page: PermissionPreviewPage, grants: PermissionPreviewGrants) => Promise<boolean>;
+export interface PermissionPreviewAccess {
+    hiddenEntries: string[];
+    partialEntries: string[];
+    hiddenQuickActions: string[];
+    page: PermissionPreviewPage | null;
+}
+export interface PermissionPreviewRequest {
+    path?: string;
+    user: User;
+    memberModel: TenantMemberModel;
+    roleModel: RoleModel;
+    tenantId: string;
+    previewPermissions: Set<string>;
+    pageLoses?: PreviewPageLossCheck;
+}
+export type ViewerModelResult = Awaited<ReturnType<TenantMemberModel["getByUser"]>> | Awaited<ReturnType<RoleModel["getBy"]>>;
+export interface PreviewPageReading {
+    request: PermissionPreviewRequest;
+    hiddenInPreview: boolean;
+    quickActions: {
+        real: ServedQuickActions;
+        preview: ServedQuickActions;
+    };
+    layouts: Map<string, Promise<PageLayout>>;
+}
+export interface PreviewMenuReading {
+    request: PermissionPreviewRequest;
+    contexts: {
+        real: RequestAccessContext;
+        preview: RequestAccessContext;
+    };
+    quickActions: {
+        real: ServedQuickActions;
+        preview: ServedQuickActions;
+    };
+    served: DynamicChildren;
+    denied: Set<string>;
+}
+export interface NavigationEntry extends Partial<Pick<PageInfo, "permission" | "publicAccess" | "authOnly" | "module" | "category" | "isModuleRoot" | "bypassTenantAccessGate" | "layoutUrl">> {
+    fullId: string;
+}
+export type DynamicChildren = Map<string, SiteLayoutTree[]>;
+export interface ResolvedEntryTarget {
+    target: PageInfo;
+    link: string;
+}
+export interface QuickActionPage {
+    pageInfo: PageInfo;
+    meta: PageMetadata;
+    context: RequestAccessContext;
+}
+export type QuickActionTargetOf<K extends QuickActionTarget["type"]> = Extract<QuickActionTarget, {
+    type: K;
+}>;
+export type QuickActionTargetHandler<K extends QuickActionTarget["type"]> = (target: QuickActionTargetOf<K>, page: QuickActionPage) => Promise<QuickActionTargetSerialized | undefined>;
+export type QuickActionTargetHandlers = {
+    [K in QuickActionTarget["type"]]: QuickActionTargetHandler<K>;
+};
+export interface QuickActionComponentFilter {
+    accepts: (component: Component) => boolean;
+    description: string;
+}
+export type ModuleCatalogEntry = Omit<ModuleInfo, "status" | "readout"> & {
+    hasAccess: boolean;
+    landingSlug: string;
+    status: ModuleStatus;
+    readout: ModuleReadoutLine[];
+};

package/dist/implementations/dms/page/types.js

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

package/dist/implementations/dms/page/types.js.map

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

package/dist/implementations/dms/page.d.ts

@@ -1,144 +1,38 @@
-import { type RequestContext } from "@antelopejs/interface-api";
-import { RoleModel, TenantMemberModel } from "@antelopejs/interface-dms/db";
-import { type CategoryInfo, type DynamicMenuProviderInfo, type ModuleInfo, type ModuleReadoutLine, type ModuleStatus, type PageExtensionInfo, type PageInfo, type PageLayout } from "@antelopejs/interface-dms/page";
-import type { User } from "@antelopejs/interface-dms/auth/db";
-import type { FrontendManifest, ManifestModuleEntry } from "./manifest";
-import { type QuickActionsPayload } from "./quick-actions";
-import { type LayoutBannerSerialized } from "./layout-banners";
-import { type TreeWithCategoryRefs, type WithCategoryRef } from "./menu-categories";
-import type { ResolvedNavBadges } from "@antelopejs/interface-dms/page/internal/nav-badges";
-export { AddFrontendModule, GetFrontendModules } from "./frontend-modules";
-type SiteLayoutTree = Omit<PageInfo, "layoutUrl"> & {
-    children: Record<string, SiteLayoutTree>;
-    childrenOrders: string[];
-    layoutUrl?: string;
-    hasAccess?: boolean;
-};
-export declare function isPlatformPage(fullId: string): boolean;
-export declare function userCanAccessPage(user: User | undefined, fullId: string, memberModel: TenantMemberModel, roleModel: RoleModel, tenantId: string): Promise<boolean>;
-export declare function reportMissingCategories(): void;
-export declare function cancelMissingCategoryCheck(): void;
-export declare function GetMenuOrder(): Map<string, number>;
-export declare function GetCategoryPermissionIds(): Set<string>;
-export declare function GetMenuEntryPermissionIds(): Set<string>;
-export declare function NotifyMenuChanged(tenantId?: string): void;
-export declare function notifyMenuAccessChanged(tenantId: string, userIds: Iterable<string>): void;
-export declare function cancelPendingMenuNotifications(): void;
-export declare namespace internal {
-    const RegisterCategory: {
-        register: (categoryInfo: CategoryInfo) => void;
-        unregister: (categoryInfo: CategoryInfo) => void;
-    };
-    const RegisterPage: {
-        register: (pageInfo: PageInfo) => void;
-        unregister: (pageInfo: PageInfo) => void;
-    };
-    const RegisterModule: {
-        register: (info: ModuleInfo) => void;
-        unregister: (info: ModuleInfo) => void;
-    };
-    const RegisterDynamicMenuProvider: {
-        register: (info: DynamicMenuProviderInfo) => void;
-        unregister: (info: DynamicMenuProviderInfo) => void;
-    };
-    const RegisterPageExtension: {
-        register: (info: PageExtensionInfo) => void;
-        unregister: (info: PageExtensionInfo) => void;
-    };
-}
-declare const DMSController_base: import("@antelopejs/interface-api").ControllerClass<object>;
-export declare class DMSController extends DMSController_base {
-    bootstrapHeader: string | undefined;
-    pagePath: string;
-    sharedPage: string | undefined;
-    authorization: string | undefined;
-    frontend(requestContext: RequestContext, clientUrl: string | undefined, renderer: string | undefined, rendererVersion: string | undefined): Promise<FrontendManifest<ManifestModuleEntry>>;
-    frontendReady(body: unknown): void;
-    userPermissions(requestContext: RequestContext, roleModel: RoleModel, memberModel: TenantMemberModel, user: User | undefined): Promise<string[]>;
-    siteLayout(requestContext: RequestContext, roleModel: RoleModel, memberModel: TenantMemberModel, user: User | undefined): Promise<SiteLayoutPayload>;
-    modulesListing(requestContext: RequestContext, roleModel: RoleModel, memberModel: TenantMemberModel, user: User | undefined): Promise<ModuleCatalogEntry[]>;
-    pageLayout(requestContext: RequestContext, roleModel: RoleModel, memberModel: TenantMemberModel, user: User | undefined, slug: string): Promise<PageLayout<unknown>>;
-    page(requestContext: RequestContext, roleModel: RoleModel, memberModel: TenantMemberModel, user: User | undefined): Promise<PageResponsePayload>;
-}
-interface AccessFlag {
-    hasAccess: boolean;
-}
-type ServedPage = WithCategoryRef<PageInfo & AccessFlag>;
-interface SiteLayoutWithAccess {
-    pages: Record<string, ServedPage>;
-    categories: Record<string, WithCategoryRef<CategoryInfo & AccessFlag>>;
-    banners: LayoutBannerSerialized[];
-}
-export interface SiteLayoutPayload {
-    siteLayout: SiteLayoutWithAccess;
-    siteLayoutTree: TreeWithCategoryRefs<SiteLayoutTree>;
-    quickActions: QuickActionsPayload;
-    modules: Record<string, ModuleInfo & AccessFlag>;
-    isOwner: boolean;
-}
-export interface PagePayload {
-    route: ServedPage;
-    shared: SiteLayoutPayload;
-    layout: PageLayout;
-    navBadges: ResolvedNavBadges;
-}
-export interface PageResponsePayload extends Omit<PagePayload, "shared"> {
-    shared?: SiteLayoutPayload;
-}
-export declare function pageParamsOf(pattern: string, path: string): Record<string, string>;
-type SharedPagePayloadArguments = [
-    slug: string,
-    user: User | undefined,
-    memberModel: TenantMemberModel,
-    roleModel: RoleModel,
-    tenantId: string
-];
-type PageResponsePayloadArguments = [
-    ...SharedPagePayloadArguments,
-    includeShared: boolean,
-    requestContext?: RequestContext
-];
-export declare function buildPagePayload(...arguments_: SharedPagePayloadArguments): Promise<PagePayload>;
-export declare function buildPagePayload(...arguments_: PageResponsePayloadArguments): Promise<PageResponsePayload>;
-export interface PermissionPreviewPage {
-    fullId: string;
-    displayName: string;
-    pagePermissionId: string;
-    filtersComponents: boolean;
-    hiddenInPreview: boolean;
-    components: PageLayout["components"];
-    hiddenHeaderActions: string[];
-}
-export interface PermissionPreviewGrants {
-    real: Set<string>;
-    preview: Set<string>;
-}
-export type PreviewPageLossCheck = (page: PermissionPreviewPage, grants: PermissionPreviewGrants) => Promise<boolean>;
-export interface PermissionPreviewAccess {
-    hiddenEntries: string[];
-    partialEntries: string[];
-    hiddenQuickActions: string[];
-    page: PermissionPreviewPage | null;
-}
-export interface PermissionPreviewRequest {
-    path?: string;
-    user: User;
-    memberModel: TenantMemberModel;
-    roleModel: RoleModel;
-    tenantId: string;
-    previewPermissions: Set<string>;
-    pageLoses?: PreviewPageLossCheck;
-}
-export declare function resolvePreviewPermissions(viewerId: string, tenantId: string, rolePermissions: Set<string>): Promise<Set<string>>;
-export declare function resolvePermissionPreviewAccess(request: PermissionPreviewRequest): Promise<PermissionPreviewAccess>;
-export declare function filterPermissionsForBypassedSurfaces(permissions: Set<string>, surfaces: Map<string, boolean>): Set<string>;
-export declare function resolveUserPermissions(user: User | undefined, memberModel: TenantMemberModel, roleModel: RoleModel, tenantId: string): Promise<string[]>;
-export declare function buildSiteLayoutPayload(user: User | undefined, memberModel: TenantMemberModel, roleModel: RoleModel, tenantId: string): Promise<SiteLayoutPayload>;
-export declare function buildNavBadges(user: User | undefined, memberModel: TenantMemberModel, roleModel: RoleModel, tenantId: string, requestContext: RequestContext | undefined): Promise<ResolvedNavBadges>;
-export declare function isPlatformOwner(user: User | undefined, memberModel: TenantMemberModel, roleModel: RoleModel, tenantId: string): Promise<boolean>;
-type ModuleCatalogEntry = Omit<ModuleInfo, "status" | "readout"> & {
-    hasAccess: boolean;
-    landingSlug: string;
-    status: ModuleStatus;
-    readout: ModuleReadoutLine[];
-};
+import { internal as pageInternal, reportMissingCategories as reportMissingCategoriesImplementation, cancelMissingCategoryCheck as cancelMissingCategoryCheckImplementation, GetMenuOrder as getMenuOrderImplementation, GetCategoryPermissionIds as getCategoryPermissionIdsImplementation, GetMenuEntryPermissionIds as getMenuEntryPermissionIdsImplementation } from "./page/registry";
+import { DMSController as PageDMSController } from "./page/controller";
+import { NotifyMenuChanged as notifyMenuChangedImplementation, notifyMenuAccessChanged as notifyMenuAccessChangedImplementation, cancelPendingMenuNotifications as cancelPendingMenuNotificationsImplementation } from "./page/notifications";
+import { pageParamsOf as pageParamsOfImplementation, buildPagePayload as buildPagePayloadImplementation, buildSiteLayoutPayload as buildSiteLayoutPayloadImplementation, buildNavBadges as buildNavBadgesImplementation } from "./page/payloads";
+import { resolvePreviewPermissions as resolvePreviewPermissionsImplementation } from "./page/preview-models";
+import { resolvePermissionPreviewAccess as resolvePermissionPreviewAccessImplementation } from "./page/preview-menu";
+import { isPlatformPage as isPlatformPageImplementation, userCanAccessPage as userCanAccessPageImplementation, filterPermissionsForBypassedSurfaces as filterPermissionsForBypassedSurfacesImplementation, resolveUserPermissions as resolveUserPermissionsImplementation, isPlatformOwner as isPlatformOwnerImplementation } from "./page/access";
+export { AddFrontendModule, GetFrontendModules } from "../../store/frontend";
+export declare const internal: typeof pageInternal;
+export declare const DMSController: typeof PageDMSController;
+export type DMSController = PageDMSController;
+export declare const isPlatformPage: typeof isPlatformPageImplementation;
+export declare const userCanAccessPage: typeof userCanAccessPageImplementation;
+export declare const reportMissingCategories: typeof reportMissingCategoriesImplementation;
+export declare const cancelMissingCategoryCheck: typeof cancelMissingCategoryCheckImplementation;
+export declare const GetMenuOrder: typeof getMenuOrderImplementation;
+export declare const GetCategoryPermissionIds: typeof getCategoryPermissionIdsImplementation;
+export declare const GetMenuEntryPermissionIds: typeof getMenuEntryPermissionIdsImplementation;
+export declare const NotifyMenuChanged: typeof notifyMenuChangedImplementation;
+export declare const notifyMenuAccessChanged: typeof notifyMenuAccessChangedImplementation;
+export declare const cancelPendingMenuNotifications: typeof cancelPendingMenuNotificationsImplementation;
+export type { SiteLayoutPayload } from "./page/types";
+export type { PagePayload } from "./page/types";
+export type { PageResponsePayload } from "./page/types";
+export declare const pageParamsOf: typeof pageParamsOfImplementation;
+export declare const buildPagePayload: typeof buildPagePayloadImplementation;
+export type { PermissionPreviewPage } from "./page/types";
+export type { PermissionPreviewGrants } from "./page/types";
+export type { PreviewPageLossCheck } from "./page/types";
+export type { PermissionPreviewAccess } from "./page/types";
+export type { PermissionPreviewRequest } from "./page/types";
+export declare const resolvePreviewPermissions: typeof resolvePreviewPermissionsImplementation;
+export declare const resolvePermissionPreviewAccess: typeof resolvePermissionPreviewAccessImplementation;
+export declare const filterPermissionsForBypassedSurfaces: typeof filterPermissionsForBypassedSurfacesImplementation;
+export declare const resolveUserPermissions: typeof resolveUserPermissionsImplementation;
+export declare const buildSiteLayoutPayload: typeof buildSiteLayoutPayloadImplementation;
+export declare const buildNavBadges: typeof buildNavBadgesImplementation;
+export declare const isPlatformOwner: typeof isPlatformOwnerImplementation;