@jmruthers/pace-core 0.6.2 → 0.6.4

package/docs/api/interfaces/NavigationItem.md

@@ -1,120 +0,0 @@
-[@jmruthers/pace-core - v0.6.2](../README.md) / [Exports](../modules.md) / NavigationItem
-
-# Interface: NavigationItem
-
-Navigation item interface
-
-## Table of contents
-
-### Properties
-
-- [id](NavigationItem.md#id)
-- [label](NavigationItem.md#label)
-- [href](NavigationItem.md#href)
-- [icon](NavigationItem.md#icon)
-- [children](NavigationItem.md#children)
-- [permissions](NavigationItem.md#permissions)
-- [roles](NavigationItem.md#roles)
-- [accessLevel](NavigationItem.md#accesslevel)
-- [meta](NavigationItem.md#meta)
-- [pageId](NavigationItem.md#pageid)
-
-## Properties
-
-### id
-
-• **id**: `string`
-
-#### Defined in
-
-[packages/core/src/components/NavigationMenu/types.ts:21](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/NavigationMenu/types.ts#L21)
-
-___
-
-### label
-
-• **label**: `string`
-
-#### Defined in
-
-[packages/core/src/components/NavigationMenu/types.ts:22](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/NavigationMenu/types.ts#L22)
-
-___
-
-### href
-
-• `Optional` **href**: `string`
-
-#### Defined in
-
-[packages/core/src/components/NavigationMenu/types.ts:23](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/NavigationMenu/types.ts#L23)
-
-___
-
-### icon
-
-• `Optional` **icon**: `string`
-
-#### Defined in
-
-[packages/core/src/components/NavigationMenu/types.ts:24](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/NavigationMenu/types.ts#L24)
-
-___
-
-### children
-
-• `Optional` **children**: [`NavigationItem`](NavigationItem.md)[]
-
-#### Defined in
-
-[packages/core/src/components/NavigationMenu/types.ts:25](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/NavigationMenu/types.ts#L25)
-
-___
-
-### permissions
-
-• `Optional` **permissions**: `string`[]
-
-#### Defined in
-
-[packages/core/src/components/NavigationMenu/types.ts:26](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/NavigationMenu/types.ts#L26)
-
-___
-
-### roles
-
-• `Optional` **roles**: `string`[]
-
-#### Defined in
-
-[packages/core/src/components/NavigationMenu/types.ts:27](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/NavigationMenu/types.ts#L27)
-
-___
-
-### accessLevel
-
-• `Optional` **accessLevel**: `string`
-
-#### Defined in
-
-[packages/core/src/components/NavigationMenu/types.ts:28](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/NavigationMenu/types.ts#L28)
-
-___
-
-### meta
-
-• `Optional` **meta**: `NavigationItemMeta`
-
-#### Defined in
-
-[packages/core/src/components/NavigationMenu/types.ts:29](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/NavigationMenu/types.ts#L29)
-
-___
-
-### pageId
-
-• `Optional` **pageId**: `string`
-
-#### Defined in
-
-[packages/core/src/components/NavigationMenu/types.ts:30](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/NavigationMenu/types.ts#L30)

package/docs/api/interfaces/NavigationMenuProps.md

@@ -1,221 +0,0 @@
-[@jmruthers/pace-core - v0.6.2](../README.md) / [Exports](../modules.md) / NavigationMenuProps
-
-# Interface: NavigationMenuProps
-
-Navigation menu component props
-
-## Hierarchy
-
-- `HTMLAttributes`\<`HTMLDivElement`\>
-
-  ↳ **`NavigationMenuProps`**
-
-## Table of contents
-
-### Properties
-
-- [items](NavigationMenuProps.md#items)
-- [mode](NavigationMenuProps.md#mode)
-- [currentPath](NavigationMenuProps.md#currentpath)
-- [onNavigate](NavigationMenuProps.md#onnavigate)
-- [className](NavigationMenuProps.md#classname)
-- [disabled](NavigationMenuProps.md#disabled)
-- [buttonText](NavigationMenuProps.md#buttontext)
-- [showIcons](NavigationMenuProps.md#showicons)
-- [navigationLabel](NavigationMenuProps.md#navigationlabel)
-- [strictMode](NavigationMenuProps.md#strictmode)
-- [auditLog](NavigationMenuProps.md#auditlog)
-- [onNavigationAccessDenied](NavigationMenuProps.md#onnavigationaccessdenied)
-- [onStrictModeViolation](NavigationMenuProps.md#onstrictmodeviolation)
-- [itemsPreFiltered](NavigationMenuProps.md#itemsprefiltered)
-
-## Properties
-
-### items
-
-• **items**: [`NavigationItem`](NavigationItem.md)[]
-
-#### Defined in
-
-[packages/core/src/components/NavigationMenu/types.ts:37](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/NavigationMenu/types.ts#L37)
-
-___
-
-### mode
-
-• `Optional` **mode**: [`NavigationMode`](../modules.md#navigationmode)
-
-#### Defined in
-
-[packages/core/src/components/NavigationMenu/types.ts:38](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/NavigationMenu/types.ts#L38)
-
-___
-
-### currentPath
-
-• `Optional` **currentPath**: `string`
-
-#### Defined in
-
-[packages/core/src/components/NavigationMenu/types.ts:39](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/NavigationMenu/types.ts#L39)
-
-___
-
-### onNavigate
-
-• `Optional` **onNavigate**: (`item`: [`NavigationItem`](NavigationItem.md)) => `void`
-
-#### Type declaration
-
-▸ (`item`): `void`
-
-##### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `item` | [`NavigationItem`](NavigationItem.md) |
-
-##### Returns
-
-`void`
-
-#### Defined in
-
-[packages/core/src/components/NavigationMenu/types.ts:40](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/NavigationMenu/types.ts#L40)
-
-___
-
-### className
-
-• `Optional` **className**: `string`
-
-#### Overrides
-
-React.HTMLAttributes.className
-
-#### Defined in
-
-[packages/core/src/components/NavigationMenu/types.ts:41](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/NavigationMenu/types.ts#L41)
-
-___
-
-### disabled
-
-• `Optional` **disabled**: `boolean`
-
-#### Defined in
-
-[packages/core/src/components/NavigationMenu/types.ts:42](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/NavigationMenu/types.ts#L42)
-
-___
-
-### buttonText
-
-• `Optional` **buttonText**: `string`
-
-#### Defined in
-
-[packages/core/src/components/NavigationMenu/types.ts:43](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/NavigationMenu/types.ts#L43)
-
-___
-
-### showIcons
-
-• `Optional` **showIcons**: `boolean`
-
-#### Defined in
-
-[packages/core/src/components/NavigationMenu/types.ts:44](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/NavigationMenu/types.ts#L44)
-
-___
-
-### navigationLabel
-
-• `Optional` **navigationLabel**: `string`
-
-#### Defined in
-
-[packages/core/src/components/NavigationMenu/types.ts:45](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/NavigationMenu/types.ts#L45)
-
-___
-
-### strictMode
-
-• `Optional` **strictMode**: `boolean`
-
-#### Defined in
-
-[packages/core/src/components/NavigationMenu/types.ts:46](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/NavigationMenu/types.ts#L46)
-
-___
-
-### auditLog
-
-• `Optional` **auditLog**: `boolean`
-
-#### Defined in
-
-[packages/core/src/components/NavigationMenu/types.ts:47](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/NavigationMenu/types.ts#L47)
-
-___
-
-### onNavigationAccessDenied
-
-• `Optional` **onNavigationAccessDenied**: (`item`: [`NavigationItem`](NavigationItem.md)) => `void`
-
-#### Type declaration
-
-▸ (`item`): `void`
-
-##### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `item` | [`NavigationItem`](NavigationItem.md) |
-
-##### Returns
-
-`void`
-
-#### Defined in
-
-[packages/core/src/components/NavigationMenu/types.ts:48](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/NavigationMenu/types.ts#L48)
-
-___
-
-### onStrictModeViolation
-
-• `Optional` **onStrictModeViolation**: (`item`: [`NavigationItem`](NavigationItem.md), `reason`: `string`) => `void`
-
-#### Type declaration
-
-▸ (`item`, `reason`): `void`
-
-##### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `item` | [`NavigationItem`](NavigationItem.md) |
-| `reason` | `string` |
-
-##### Returns
-
-`void`
-
-#### Defined in
-
-[packages/core/src/components/NavigationMenu/types.ts:49](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/NavigationMenu/types.ts#L49)
-
-___
-
-### itemsPreFiltered
-
-• `Optional` **itemsPreFiltered**: `boolean`
-
-If true, indicates that items have already been filtered by the parent component (e.g., PaceAppLayout).
-When true, NavigationMenu will skip expensive permission checks and trust the provided items.
-This significantly improves performance when items are pre-filtered.
-
-#### Defined in
-
-[packages/core/src/components/NavigationMenu/types.ts:55](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/NavigationMenu/types.ts#L55)

package/docs/api/interfaces/NavigationProviderProps.md

@@ -1,117 +0,0 @@
-[@jmruthers/pace-core - v0.6.2](../README.md) / [Exports](../modules.md) / NavigationProviderProps
-
-# Interface: NavigationProviderProps
-
-## Table of contents
-
-### Properties
-
-- [children](NavigationProviderProps.md#children)
-- [strictMode](NavigationProviderProps.md#strictmode)
-- [auditLog](NavigationProviderProps.md#auditlog)
-- [onNavigationAccess](NavigationProviderProps.md#onnavigationaccess)
-- [onStrictModeViolation](NavigationProviderProps.md#onstrictmodeviolation)
-- [maxHistorySize](NavigationProviderProps.md#maxhistorysize)
-
-## Properties
-
-### children
-
-• **children**: `ReactNode`
-
-Child components
-
-#### Defined in
-
-[packages/core/src/rbac/components/NavigationProvider.tsx:139](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/NavigationProvider.tsx#L139)
-
-___
-
-### strictMode
-
-• `Optional` **strictMode**: `boolean`
-
-Enable strict mode to prevent bypassing (default: true)
-
-#### Defined in
-
-[packages/core/src/rbac/components/NavigationProvider.tsx:142](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/NavigationProvider.tsx#L142)
-
-___
-
-### auditLog
-
-• `Optional` **auditLog**: `boolean`
-
-Enable audit logging (default: true)
-
-#### Defined in
-
-[packages/core/src/rbac/components/NavigationProvider.tsx:145](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/NavigationProvider.tsx#L145)
-
-___
-
-### onNavigationAccess
-
-• `Optional` **onNavigationAccess**: (`item`: `NavigationItem`, `allowed`: `boolean`, `record`: [`NavigationAccessRecord`](NavigationAccessRecord.md)) => `void`
-
-Callback when navigation access is attempted
-
-#### Type declaration
-
-▸ (`item`, `allowed`, `record`): `void`
-
-##### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `item` | `NavigationItem` |
-| `allowed` | `boolean` |
-| `record` | [`NavigationAccessRecord`](NavigationAccessRecord.md) |
-
-##### Returns
-
-`void`
-
-#### Defined in
-
-[packages/core/src/rbac/components/NavigationProvider.tsx:148](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/NavigationProvider.tsx#L148)
-
-___
-
-### onStrictModeViolation
-
-• `Optional` **onStrictModeViolation**: (`item`: `NavigationItem`, `record`: [`NavigationAccessRecord`](NavigationAccessRecord.md)) => `void`
-
-Callback when strict mode violation occurs
-
-#### Type declaration
-
-▸ (`item`, `record`): `void`
-
-##### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `item` | `NavigationItem` |
-| `record` | [`NavigationAccessRecord`](NavigationAccessRecord.md) |
-
-##### Returns
-
-`void`
-
-#### Defined in
-
-[packages/core/src/rbac/components/NavigationProvider.tsx:151](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/NavigationProvider.tsx#L151)
-
-___
-
-### maxHistorySize
-
-• `Optional` **maxHistorySize**: `number`
-
-Maximum number of access records to keep in history
-
-#### Defined in
-
-[packages/core/src/rbac/components/NavigationProvider.tsx:154](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/NavigationProvider.tsx#L154)

package/docs/api/interfaces/Organisation.md

@@ -1,140 +0,0 @@
-[@jmruthers/pace-core - v0.6.2](../README.md) / [Exports](../modules.md) / Organisation
-
-# Interface: Organisation
-
-## Table of contents
-
-### Properties
-
-- [id](Organisation.md#id)
-- [name](Organisation.md#name)
-- [display\_name](Organisation.md#display_name)
-- [description](Organisation.md#description)
-- [parent\_id](Organisation.md#parent_id)
-- [subscription\_tier](Organisation.md#subscription_tier)
-- [settings](Organisation.md#settings)
-- [is\_active](Organisation.md#is_active)
-- [created\_at](Organisation.md#created_at)
-- [updated\_at](Organisation.md#updated_at)
-- [created\_by](Organisation.md#created_by)
-- [updated\_by](Organisation.md#updated_by)
-
-## Properties
-
-### id
-
-• **id**: `string`
-
-#### Defined in
-
-[packages/core/src/types/organisation.ts:13](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/organisation.ts#L13)
-
-___
-
-### name
-
-• **name**: `string`
-
-#### Defined in
-
-[packages/core/src/types/organisation.ts:14](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/organisation.ts#L14)
-
-___
-
-### display\_name
-
-• **display\_name**: `string`
-
-#### Defined in
-
-[packages/core/src/types/organisation.ts:15](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/organisation.ts#L15)
-
-___
-
-### description
-
-• `Optional` **description**: `string`
-
-#### Defined in
-
-[packages/core/src/types/organisation.ts:16](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/organisation.ts#L16)
-
-___
-
-### parent\_id
-
-• `Optional` **parent\_id**: `string`
-
-#### Defined in
-
-[packages/core/src/types/organisation.ts:17](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/organisation.ts#L17)
-
-___
-
-### subscription\_tier
-
-• **subscription\_tier**: `string`
-
-#### Defined in
-
-[packages/core/src/types/organisation.ts:18](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/organisation.ts#L18)
-
-___
-
-### settings
-
-• **settings**: `Record`\<`string`, `unknown`\>
-
-#### Defined in
-
-[packages/core/src/types/organisation.ts:19](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/organisation.ts#L19)
-
-___
-
-### is\_active
-
-• **is\_active**: `boolean`
-
-#### Defined in
-
-[packages/core/src/types/organisation.ts:20](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/organisation.ts#L20)
-
-___
-
-### created\_at
-
-• **created\_at**: `string`
-
-#### Defined in
-
-[packages/core/src/types/organisation.ts:21](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/organisation.ts#L21)
-
-___
-
-### updated\_at
-
-• **updated\_at**: `string`
-
-#### Defined in
-
-[packages/core/src/types/organisation.ts:22](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/organisation.ts#L22)
-
-___
-
-### created\_by
-
-• `Optional` **created\_by**: `string`
-
-#### Defined in
-
-[packages/core/src/types/organisation.ts:23](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/organisation.ts#L23)
-
-___
-
-### updated\_by
-
-• `Optional` **updated\_by**: `string`
-
-#### Defined in
-
-[packages/core/src/types/organisation.ts:24](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/organisation.ts#L24)