@imperium/layout 7.3.1 → 8.1.0

package/dist/content/types.d.ts

@@ -3,7 +3,7 @@ import type React from 'react';
 import type { SemanticCOLORS, SemanticICONS } from 'semantic-ui-react';
 import type { RouteItem, VisibilityItem, WeightedItem } from '../commonItems';
 import type { DataHookItem } from '../datahooks/types';
-import type { Data, StateSelectorHook } from '../types';
+import type { Data, PermissionSelectorHook, StateSelectorHook } from '../types';
 export declare type RouteParameters<T extends readonly string[] | undefined> = T extends readonly string[] ? ParametersFromAssertion<T> : never;
 export interface ContentData<T extends DefineRouteOptions, K extends keyof T> extends Data {
     params: RouteParameters<T[K]['params']>;
@@ -35,7 +35,7 @@ export interface ActionFormSidebarItem<T extends DefineRouteOptions, K extends k
 export interface CustomSidebarItem<T extends DefineRouteOptions, K extends keyof T> extends WeightedItem, VisibilityItem {
     render: (data: ContentData<T, K>) => JSX.Element | null;
 }
-export declare type SidebarItem<T extends DefineRouteOptions, K extends keyof T> = (BaseSidebarItem<T, K> & RouteItem) | ActionSidebarItem<T, K> | CustomSidebarItem<T, K> | ActionFormSidebarItem<T, K> | DividerSidebarItem<T, K>;
+export declare type SidebarItem<T extends DefineRouteOptions, K extends keyof T> = (BaseSidebarItem<T, K> & RouteItem<ContentData<T, K>>) | ActionSidebarItem<T, K> | CustomSidebarItem<T, K> | ActionFormSidebarItem<T, K> | DividerSidebarItem<T, K>;
 export declare type ContentHeader<T extends DefineRouteOptions, K extends keyof T> = string | {
     title: string;
     icon?: string;
@@ -46,13 +46,16 @@ export declare type ContentHeader<T extends DefineRouteOptions, K extends keyof
 export interface Page<T extends DefineRouteOptions, K extends keyof T> {
     dataHooks?: DataHookItem[];
     stateSelectorHook?: StateSelectorHook | StateSelectorHook[];
+    permissionSelectorHook?: PermissionSelectorHook | PermissionSelectorHook[];
     content: Content<T, K>;
     header?: ContentHeader<T, K>;
     sidebar?: SidebarItem<T, K>[];
+    full?: boolean;
 }
 export declare type Pages<T extends DefineRouteOptions> = {
-    [key in keyof T]: Page<T, key>;
+    [key in keyof T]: Page<T, key> | Content<T, key>;
 };
+export declare function isPage<T extends DefineRouteOptions, K extends keyof T>(value: any): value is Page<T, K>;
 export declare function isActionSidebarItem<T extends DefineRouteOptions, K extends keyof T>(value: any): value is ActionSidebarItem<T, K>;
 export declare function isActionFormSidebarItem<T extends DefineRouteOptions, K extends keyof T>(value: any): value is ActionFormSidebarItem<T, K>;
 export declare function isCustomSidebarItem<T extends DefineRouteOptions, K extends keyof T>(value: any): value is CustomSidebarItem<T, K>;

package/dist/content/utils.d.ts

@@ -4,6 +4,6 @@ import { SemanticCOLORS } from 'semantic-ui-react';
 import type { RouteItem } from '../commonItems';
 import type { BaseSidebarItem, ContentData } from './types';
 export declare function getIcon<T extends DefineRouteOptions, K extends keyof T>(item: BaseSidebarItem<T, K>, data: ContentData<T, K>): JSX.Element | null;
-export declare function getRouteTo<T extends DefineRouteOptions, K extends keyof T>(item: RouteItem, data: ContentData<T, K>): string;
+export declare function getRouteTo<T extends DefineRouteOptions, K extends keyof T>(item: RouteItem<ContentData<T, K>>, data: ContentData<T, K>): string;
 export declare function getText<T extends DefineRouteOptions, K extends keyof T>(item: BaseSidebarItem<T, K>, data: ContentData<T, K>): string;
 export declare function getColor<T extends DefineRouteOptions, K extends keyof T>(item: BaseSidebarItem<T, K>, data: ContentData<T, K>): SemanticCOLORS;

package/dist/datahooks/DataHooks.d.ts

@@ -4,7 +4,7 @@ interface DataHooksProps {
     dataHooks: DataHookItem[];
 }
 /**
- * Renders layout data hooks. These hooks should return nothing. All interaction should be in side-effects, usually retrieving data and setting Redux state.
+ * Renders layout data hooks. These hooks should return nothing. All interaction should be in side effects, usually retrieving data and setting Redux state.
  * @param dataHooks
  * @constructor
  */

package/dist/datahooks/ExecutePermissionHook.d.ts

@@ -0,0 +1,7 @@
+import type { PermissionSelectorHook } from '../types';
+interface ExecutePermissionHookProps {
+    permissionHook: PermissionSelectorHook;
+    routeParams?: any;
+}
+export declare function ExecutePermissionHook({ permissionHook, routeParams }: ExecutePermissionHookProps): null;
+export {};

package/dist/datahooks/PermissionHooks.d.ts

@@ -0,0 +1,7 @@
+/// <reference types="react" />
+import type { PermissionSelectorHook } from '../types';
+interface PermissionHooksProps {
+    permissionHooks: PermissionSelectorHook[];
+}
+export declare function PermissionHooks({ permissionHooks }: PermissionHooksProps): JSX.Element;
+export {};

package/dist/datahooks/types.d.ts

@@ -14,6 +14,6 @@ export declare type DataHookRoute = {
     dataHook: DataHook | DataHook[];
 };
 /**
- * A datahook can either be a simple hook, or one or more hooks dependant on one or more route match functions.
+ * A datahook can either be a simple hook, or one or more hooks dependent on one or more route match functions.
  */
 export declare type DataHookItem = DataHook | DataHookRoute;

package/dist/hooks/useBuildData.d.ts

@@ -1,7 +1,8 @@
-import type { Data, StateSelectorHook } from '../types';
+import type { Data, PermissionSelectorHook, StateSelectorHook } from '../types';
 export interface UseBuildDataParams {
     data?: Data;
     routeItem?: any;
     stateSelectorHook?: StateSelectorHook | StateSelectorHook[];
+    permissionSelectorHook?: PermissionSelectorHook | PermissionSelectorHook[];
 }
-export declare function useBuildData({ stateSelectorHook, data, routeItem }: UseBuildDataParams): Data;
+export declare function useBuildData({ stateSelectorHook, permissionSelectorHook, data, routeItem }: UseBuildDataParams): Data;

package/dist/hooks/useSelectPermission.d.ts

@@ -0,0 +1,2 @@
+import type { Data, PermissionSelectorHook } from '../types';
+export declare function useSelectPermission(data: Data, permissionSelectorHook?: PermissionSelectorHook | PermissionSelectorHook[]): import("../types").PermissionResults;

package/dist/layout/types.d.ts

@@ -2,7 +2,7 @@
 import type { SemanticICONS } from 'semantic-ui-react';
 import type { HorizontalPositionedItem, RouteItem, VisibilityItem, WeightedItem } from '../commonItems';
 import type { DataHookItem } from '../datahooks/types';
-import type { Data } from '../types';
+import type { Data, PermissionSelectorHook } from '../types';
 /**
  * Describes a basic weighted, possibly visible item
  */
@@ -19,21 +19,22 @@ export interface CustomLayoutItem extends WeightedItem, VisibilityItem {
  * Describes a menu that displays a dropdown list of items
  */
 export interface DropdownLayoutItem extends BaseLayoutItem {
-    dropdown: ((BaseLayoutItem & RouteItem) | CustomLayoutItem)[];
+    dropdown: ((BaseLayoutItem & RouteItem<Data>) | CustomLayoutItem)[];
     key?: string;
 }
 /**
  * Describes a menu that displays a sub menu (not a dropdown list)
  */
 export interface MenuLayoutItem extends BaseLayoutItem {
-    menu: ((BaseLayoutItem & RouteItem) | CustomLayoutItem)[];
+    menu: ((BaseLayoutItem & RouteItem<Data>) | CustomLayoutItem)[];
     key?: string;
 }
 /**
  * Describes a horizontal menu item which is either a route item or dropdown menu
  */
-export declare type LayoutItem = (BaseLayoutItem & RouteItem) | DropdownLayoutItem | MenuLayoutItem | CustomLayoutItem;
+export declare type LayoutItem = (BaseLayoutItem & RouteItem<Data>) | DropdownLayoutItem | MenuLayoutItem | CustomLayoutItem;
 export interface LayoutData {
+    permissionSelectorHooks?: PermissionSelectorHook[];
     dataHooks?: DataHookItem[];
     primaryMenu?: (LayoutItem & HorizontalPositionedItem)[];
     statusbar?: (LayoutItem & HorizontalPositionedItem)[];

package/dist/layout/utils.d.ts

@@ -11,7 +11,7 @@ export declare function splitPositionedItems<T extends LayoutItem>(items: T[]):
     leftItems: T[];
     rightItems: T[];
 };
-export declare function linkParameters(item: BaseLayoutItem & RouteItem, data: Data): {
+export declare function linkParameters(item: BaseLayoutItem & RouteItem<Data>, data: Data): {
     as: typeof Link;
     active: boolean;
     to: string;

package/dist/state.d.ts

@@ -1,20 +1,58 @@
 import { PayloadAction } from '@reduxjs/toolkit';
 export declare const state: import("@reduxjs/toolkit").Slice<{
     isMobile: boolean;
+    params: {};
+    permissions: Record<string, boolean>;
 }, {
     setMobile: (st: import("immer/dist/internal").WritableDraft<{
         isMobile: boolean;
+        params: {};
+        permissions: Record<string, boolean>;
     }>, action: PayloadAction<boolean>) => {
         isMobile: boolean;
+        params: import("immer/dist/internal").WritableDraft<{}>;
+        permissions: import("immer/dist/internal").WritableDraft<Record<string, boolean>>;
     };
+    setParams: (st: import("immer/dist/internal").WritableDraft<{
+        isMobile: boolean;
+        params: {};
+        permissions: Record<string, boolean>;
+    }>, action: PayloadAction<Record<string, string>>) => void;
+    setPermission: (st: import("immer/dist/internal").WritableDraft<{
+        isMobile: boolean;
+        params: {};
+        permissions: Record<string, boolean>;
+    }>, action: PayloadAction<{
+        permission: string;
+        result: boolean;
+    }>) => void;
 }, "imperiumLayout">;
 export declare const useLayoutState: () => {
     isMobile: boolean;
+    params: import("immer/dist/internal").WritableDraft<{}>;
+    permissions: import("immer/dist/internal").WritableDraft<Record<string, boolean>>;
 };
 export declare const actions: import("@reduxjs/toolkit").CaseReducerActions<{
     setMobile: (st: import("immer/dist/internal").WritableDraft<{
         isMobile: boolean;
+        params: {};
+        permissions: Record<string, boolean>;
     }>, action: PayloadAction<boolean>) => {
         isMobile: boolean;
+        params: import("immer/dist/internal").WritableDraft<{}>;
+        permissions: import("immer/dist/internal").WritableDraft<Record<string, boolean>>;
     };
+    setParams: (st: import("immer/dist/internal").WritableDraft<{
+        isMobile: boolean;
+        params: {};
+        permissions: Record<string, boolean>;
+    }>, action: PayloadAction<Record<string, string>>) => void;
+    setPermission: (st: import("immer/dist/internal").WritableDraft<{
+        isMobile: boolean;
+        params: {};
+        permissions: Record<string, boolean>;
+    }>, action: PayloadAction<{
+        permission: string;
+        result: boolean;
+    }>) => void;
 }>;

package/dist/types.d.ts

@@ -6,6 +6,8 @@ export declare type State = Record<string, any>;
  * A hook that selects from redux state.
  */
 export declare type StateSelectorHook = () => State;
+export declare type PermissionResults = Record<string, boolean>;
+export declare type PermissionSelectorHook = (data: Data) => PermissionResults;
 /**
  * The visibility query can either be a mingo query or a function that returns a boolean. The data is an object with the router path merged with any state selector hook data.
  */
@@ -19,6 +21,8 @@ export interface Data extends Record<string, unknown> {
     };
     state: State;
     active: boolean;
+    permissions: PermissionResults;
+    id?: string;
 }
 export interface ImperiumLayoutClientModule extends ImperiumClientModule {
     layout: LayoutData;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@imperium/layout",
-	"version": "7.3.1",
+	"version": "8.1.0",
 	"description": "Imperium Layout package",
 	"bugs": {
 		"url": "https://github.com/darkadept/imperium/issues"
@@ -32,10 +32,11 @@
 		}
 	},
 	"dependencies": {
-		"@imperium/client": "^7.1.0",
-		"@imperium/router": "^7.3.0",
-		"@imperium/state": "^7.3.0",
-		"@thx/controls": "^14.2.0",
+		"@imperium/auth-client": "^8.1.0",
+		"@imperium/client": "^8.1.0",
+		"@imperium/router": "^8.1.0",
+		"@imperium/state": "^8.1.0",
+		"@thx/controls": "^15.1.1",
 		"debug": "^4.3.2",
 		"history": "^5.0.1",
 		"lodash": "^4.17.21",
@@ -57,5 +58,5 @@
 	"publishConfig": {
 		"access": "public"
 	},
-	"gitHead": "7d605d23083343e60a8882520907999f40f28453"
+	"gitHead": "a61829b481e35a444a7257daf41eac61cfb83f7e"
 }

package/dist/content/components/ActionLinkSidebarItemComponent.d.ts

@@ -1,9 +0,0 @@
-/// <reference types="react" />
-import type { DefineRouteOptions } from '@imperium/router';
-import type { BaseSidebarItem, ContentData } from '../types';
-interface ActionLinkSidebarItemProps<T extends DefineRouteOptions, K extends keyof T> {
-    item: BaseSidebarItem<T, K>;
-    data: ContentData<T, K>;
-}
-export declare function ActionLinkSidebarItemComponent<T extends DefineRouteOptions, K extends keyof T>({ item, data }: ActionLinkSidebarItemProps<T, K>): JSX.Element;
-export {};

package/dist/content/components/ContentItemWrapper.d.ts

@@ -1,12 +0,0 @@
-import React from 'react';
-import type { DefineRouteOptions } from '@imperium/router';
-import type { ContentData, RouteParameters, SidebarItem } from '../types';
-interface ContentItemWrapperProps<T extends DefineRouteOptions, K extends keyof T> {
-    item: SidebarItem<T, K>;
-    as?: React.ComponentClass;
-    vertical?: boolean;
-    data?: ContentData<T, K>;
-    params: RouteParameters<T[K]['params']>;
-}
-export declare function ContentItemWrapper<T extends DefineRouteOptions, K extends keyof T>({ item, data: parentData, params }: ContentItemWrapperProps<T, K>): JSX.Element | null;
-export {};

package/dist/content/components/dividerSidebarItem.d.ts

@@ -1,2 +0,0 @@
-import type { DividerSidebarItem } from '../types';
-export declare const dividerSidebarItem: DividerSidebarItem<any, any>;

package/dist/hooks/DataHooks.d.ts

@@ -1,12 +0,0 @@
-/// <reference types="react" />
-import type { DataHookItem } from './types';
-interface DataHooksProps {
-    dataHooks: DataHookItem[];
-}
-/**
- * Renders layout data hooks. These hooks should return nothing. All interaction should be in side-effects, usually retrieving data and setting Redux state.
- * @param dataHooks
- * @constructor
- */
-export declare function DataHooks({ dataHooks }: DataHooksProps): JSX.Element;
-export {};

package/dist/hooks/ExecuteDataHook.d.ts

@@ -1,7 +0,0 @@
-import type { DataHook } from './types';
-interface ExecuteDataHookProps {
-    dataHook: DataHook;
-    routeParams?: any;
-}
-export declare function ExecuteDataHook({ dataHook, routeParams }: ExecuteDataHookProps): null;
-export {};

package/dist/hooks/types.d.ts

@@ -1,19 +0,0 @@
-/**
- * A simple hook, that doesn't return anything. If used together with a route match function, the returned route parameters are passed in.
- */
-export declare type DataHook = (routeParams?: any) => void;
-/**
- * A route match function that can be used by data hooks. Usually is the @imperium/router `routes.match.x()` functions.
- */
-export declare type DataHookRouteMatchFn = (route: string) => any;
-/**
- * An object that can specify one or more data hooks that can receive route parameters from one or more route match functions.
- */
-export declare type DataHookRoute = {
-    routeMatch: DataHookRouteMatchFn | DataHookRouteMatchFn[];
-    dataHook: DataHook | DataHook[];
-};
-/**
- * A datahook can either be a simple hook, or one or more hooks dependant on one or more route match functions.
- */
-export declare type DataHookItem = DataHook | DataHookRoute;

package/dist/layout/components/CustomItem.d.ts

@@ -1,7 +0,0 @@
-/// <reference types="react" />
-import type { CustomItem } from '../../commonItems';
-interface CustomItemComponentProps {
-    item: CustomItem;
-}
-export declare function CustomItemComponent({ item }: CustomItemComponentProps): JSX.Element | null;
-export {};

package/dist/layout/components/CustomItemComponent.d.ts

@@ -1,7 +0,0 @@
-/// <reference types="react" />
-import type { CustomLayoutItem } from '../types';
-interface CustomItemComponentProps {
-    item: CustomLayoutItem;
-}
-export declare function CustomItemComponent({ item }: CustomItemComponentProps): JSX.Element | null;
-export {};

package/dist/layout/components/ItemBar.d.ts

@@ -1,15 +0,0 @@
-/// <reference types="react" />
-import type { MenuProps } from 'semantic-ui-react';
-import type { LayoutItem } from '../types';
-interface ItemBarProps extends MenuProps {
-    items: LayoutItem[];
-}
-/**
- * Renders a horizontal or vertical bar of menu items.
- * @param name
- * @param items
- * @param rest
- * @constructor
- */
-export declare function ItemBar({ items, ...rest }: ItemBarProps): JSX.Element;
-export {};

package/dist/layout/components/ItemWrapper.d.ts

@@ -1,19 +0,0 @@
-import React from 'react';
-import type { LayoutItem } from '../types';
-import type { Data } from '../../types';
-interface ItemWrapperProps {
-    item: LayoutItem;
-    as?: React.ComponentClass;
-    vertical?: boolean;
-    data?: Data;
-}
-/**
- * Renders any type of Item. Gathers state, route and other data and checks for visibility.
- * @param item
- * @param as
- * @param vertical
- * @param parentData
- * @constructor
- */
-export declare function ItemWrapper({ item, as, vertical, data: parentData }: ItemWrapperProps): JSX.Element | null;
-export {};

package/dist/layout/components/SidebarToggleMenuItem.d.ts

@@ -1,7 +0,0 @@
-/// <reference types="react" />
-interface SidebarToggleMenuItemProps {
-    menuOpen: boolean;
-    setMenuOpen: (open: boolean) => void;
-}
-export declare function SidebarToggleMenuItem({ menuOpen, setMenuOpen }: SidebarToggleMenuItemProps): JSX.Element;
-export {};

package/dist/layout/hooks/useBuildData.d.ts

@@ -1,3 +0,0 @@
-import type { LayoutItem } from '../types';
-import type { Data } from '../../types';
-export declare function useBuildData(item: LayoutItem, data?: Data): Data;

package/dist/layout/hooks/useIsActiveRoute.d.ts

@@ -1,2 +0,0 @@
-import type { Data } from '../../types';
-export declare function useIsActiveRoute(data: Data, item?: any): boolean;

package/dist/layout/hooks/useSelectState.d.ts

@@ -1,2 +0,0 @@
-import type { StateSelectorHook } from '../../types';
-export declare function useSelectState(stateSelectorHook?: StateSelectorHook | StateSelectorHook[]): any;

package/dist/layout/mergeItems.d.ts

@@ -1,2 +0,0 @@
-import type { LayoutItem } from './types';
-export declare function mergeItems(items: LayoutItem[]): LayoutItem[];