@tailor-platform/app-shell 0.20.1 → 0.21.0

package/dist/index.d.ts

@@ -2,6 +2,8 @@ import { AuthState } from '@tailor-platform/auth-browser-client';
 import { DocumentNode } from 'graphql';
 import { JSX } from 'react/jsx-runtime';
 import { Link } from 'react-router';
+import { LoaderFunctionArgs } from 'react-router';
+import { Params } from 'react-router';
 import { ReactNode } from 'react';
 import { useLocation } from 'react-router';
 import { useNavigate } from 'react-router';
@@ -9,13 +11,40 @@ import { useParams } from 'react-router';
 import { useRouteError } from 'react-router';
 import { useSearchParams } from 'react-router';
 
+/**
+ * Context provided to access control functions
+ */
+declare type AccessContext = {
+    params: Params;
+    searchParams: URLSearchParams;
+    signal: AbortSignal;
+};
+
+declare type AccessControl = (context: AccessContext) => Promise<AccessResult> | AccessResult;
+
+/**
+ * Result of access control evaluation
+ */
+declare type AccessResult = 
+/**
+* Resource is visible and accessible
+*/
+    {
+    state: "visible";
+}
+/**
+* Resource is hidden and not accessible
+*/
+| {
+    state: "hidden";
+};
+
 export declare const AppShell: (props: AppShellProps) => JSX.Element | null;
 
 declare type AppShellContextType = {
     title?: string;
     icon?: ReactNode;
     configurations: RootConfiguration;
-    navItems: Array<NavItem>;
 };
 
 export declare type AppShellProps = React.PropsWithChildren<{
@@ -212,6 +241,10 @@ declare type AuthProviderProps = {
 export declare interface AuthRegister {
 }
 
+/**
+ * CommandPalette component that uses navigation items with access control.
+ * Renders a searchable command palette UI triggered by Cmd+K / Ctrl+K.
+ */
 export declare function CommandPalette(): JSX.Element;
 
 declare type CommonModuleProps = {
@@ -246,6 +279,10 @@ declare type CommonProps = {
      * Metadata for the resource.
      */
     meta?: ResourceMetaProps;
+    /**
+     * Access guard to control visibility and access of this module and its resources.
+     */
+    accessControl?: AccessControl;
 };
 
 export declare const DefaultSidebar: (props: DefaultSidebarProps) => JSX.Element;
@@ -492,6 +529,8 @@ declare type LabelValue = string | ((props: any) => string);
 
 export { Link }
 
+declare type LoaderHandler = (args: LoaderFunctionArgs) => Promise<unknown> | unknown;
+
 declare type LocalizedString = string | ((locale: string) => string);
 
 /**
@@ -504,25 +543,13 @@ declare type Module = Omit<CommonPageResource, "meta"> & {
         menuItemClickable: boolean;
     };
     resources: Array<Resource>;
-    loader?: () => Response;
     errorBoundary: ErrorBoundaryComponent;
+    accessControl?: AccessControl;
+    loader?: LoaderHandler;
 };
 
 declare type Modules = Array<Module>;
 
-declare type NavChildItem = {
-    title: string;
-    url: string;
-};
-
-declare type NavItem = {
-    title: string;
-    url: string | undefined;
-    icon: ReactNode;
-    isActive?: boolean;
-    items?: Array<NavChildItem>;
-};
-
 declare type ReactResourceProps = {
     /**
      * React component to render.
@@ -565,6 +592,8 @@ declare type Resource = CommonPageResource & {
     _type: "resource";
     subResources?: Array<Resource>;
     errorBoundary: ErrorBoundaryComponent;
+    accessControl?: AccessControl;
+    loader?: LoaderHandler;
 };
 
 export declare type ResourceComponentProps = {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tailor-platform/app-shell",
-  "version": "0.20.1",
+  "version": "0.21.0",
   "type": "module",
   "exports": {
     "./styles": "./dist/app-shell.css",