@jmruthers/pace-core 0.6.11 → 0.6.12

package/docs/api/interfaces/InvalidScopeError.md

@@ -0,0 +1,37 @@
+[**@jmruthers/pace-core v0.6.12**](../README.md)
+
+***
+
+[@jmruthers/pace-core](../globals.md) / InvalidScopeError
+
+# Interface: InvalidScopeError
+
+Defined in: [rbac/types.ts:359](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/types.ts#L359)
+
+## Extends
+
+- [`RBACError`](RBACError.md)
+
+## Properties
+
+### code
+
+> **code**: `string`
+
+Defined in: [rbac/types.ts:310](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/types.ts#L310)
+
+#### Inherited from
+
+[`RBACError`](RBACError.md).[`code`](RBACError.md#code)
+
+***
+
+### context?
+
+> `optional` **context**: `Record`\<`string`, `unknown`\>
+
+Defined in: [rbac/types.ts:311](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/types.ts#L311)
+
+#### Inherited from
+
+[`RBACError`](RBACError.md).[`context`](RBACError.md#context)

package/docs/api/interfaces/LabelProps.md

@@ -0,0 +1,85 @@
+[**@jmruthers/pace-core v0.6.12**](../README.md)
+
+***
+
+[@jmruthers/pace-core](../globals.md) / LabelProps
+
+# Interface: LabelProps
+
+Defined in: [components/Label/Label.tsx:86](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/Label/Label.tsx#L86)
+
+Props for the Label component
+
+## Extends
+
+- `ComponentPropsWithoutRef`\<*typeof* `LabelPrimitive.Root`\>
+
+## Properties
+
+### required?
+
+> `optional` **required**: `boolean`
+
+Defined in: [components/Label/Label.tsx:89](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/Label/Label.tsx#L89)
+
+Whether the field is required
+
+***
+
+### requiredIndicator?
+
+> `optional` **requiredIndicator**: `ReactNode`
+
+Defined in: [components/Label/Label.tsx:91](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/Label/Label.tsx#L91)
+
+Custom required indicator (default: '*')
+
+***
+
+### hideRequiredIndicator?
+
+> `optional` **hideRequiredIndicator**: `boolean`
+
+Defined in: [components/Label/Label.tsx:93](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/Label/Label.tsx#L93)
+
+Whether to hide the required indicator visually
+
+***
+
+### helperText?
+
+> `optional` **helperText**: `string`
+
+Defined in: [components/Label/Label.tsx:95](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/Label/Label.tsx#L95)
+
+Helper text to display below the label
+
+***
+
+### helperTextClassName?
+
+> `optional` **helperTextClassName**: `string`
+
+Defined in: [components/Label/Label.tsx:97](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/Label/Label.tsx#L97)
+
+CSS classes for helper text styling
+
+***
+
+### error?
+
+> `optional` **error**: `string`
+
+Defined in: [components/Label/Label.tsx:99](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/Label/Label.tsx#L99)
+
+Error message to display
+
+***
+
+### errorClassName?
+
+> `optional` **errorClassName**: `string`
+
+Defined in: [components/Label/Label.tsx:101](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/Label/Label.tsx#L101)
+
+CSS classes for error message styling

package/docs/api/interfaces/LoggerConfig.md

@@ -0,0 +1,51 @@
+[**@jmruthers/pace-core v0.6.12**](../README.md)
+
+***
+
+[@jmruthers/pace-core](../globals.md) / LoggerConfig
+
+# Interface: LoggerConfig
+
+Defined in: [utils/core/logger.ts:21](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/utils/core/logger.ts#L21)
+
+Logger configuration interface
+
+## Properties
+
+### level
+
+> **level**: [`LogLevel`](../enumerations/LogLevel.md)
+
+Defined in: [utils/core/logger.ts:23](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/utils/core/logger.ts#L23)
+
+Minimum log level to output
+
+***
+
+### includeTimestamp
+
+> **includeTimestamp**: `boolean`
+
+Defined in: [utils/core/logger.ts:25](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/utils/core/logger.ts#L25)
+
+Whether to include timestamps
+
+***
+
+### includeComponent
+
+> **includeComponent**: `boolean`
+
+Defined in: [utils/core/logger.ts:27](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/utils/core/logger.ts#L27)
+
+Whether to include component names
+
+***
+
+### prefix?
+
+> `optional` **prefix**: `string`
+
+Defined in: [utils/core/logger.ts:29](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/utils/core/logger.ts#L29)
+
+Custom prefix for all log messages

package/docs/api/interfaces/LoginFormProps.md

@@ -0,0 +1,146 @@
+[**@jmruthers/pace-core v0.6.12**](../README.md)
+
+***
+
+[@jmruthers/pace-core](../globals.md) / LoginFormProps
+
+# Interface: LoginFormProps
+
+Defined in: [components/LoginForm/LoginForm.tsx:113](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/LoginForm/LoginForm.tsx#L113)
+
+Props for the LoginForm component.
+Configures login form behavior, validation, and callbacks.
+
+## Properties
+
+### onSignIn()
+
+> **onSignIn**: (`data`) => `Promise`\<`void`\>
+
+Defined in: [components/LoginForm/LoginForm.tsx:115](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/LoginForm/LoginForm.tsx#L115)
+
+Callback invoked when the form is submitted
+
+#### Parameters
+
+##### data
+
+###### email
+
+`string`
+
+###### password
+
+`string`
+
+#### Returns
+
+`Promise`\<`void`\>
+
+***
+
+### onSuccess()?
+
+> `optional` **onSuccess**: () => `void`
+
+Defined in: [components/LoginForm/LoginForm.tsx:117](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/LoginForm/LoginForm.tsx#L117)
+
+Callback invoked on successful sign-in
+
+#### Returns
+
+`void`
+
+***
+
+### onError()?
+
+> `optional` **onError**: (`error`) => `void`
+
+Defined in: [components/LoginForm/LoginForm.tsx:119](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/LoginForm/LoginForm.tsx#L119)
+
+Callback invoked if sign-in fails
+
+#### Parameters
+
+##### error
+
+`Error`
+
+#### Returns
+
+`void`
+
+***
+
+### isLoading?
+
+> `optional` **isLoading**: `boolean`
+
+Defined in: [components/LoginForm/LoginForm.tsx:121](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/LoginForm/LoginForm.tsx#L121)
+
+Show loading spinner and disable form while true
+
+***
+
+### appName?
+
+> `optional` **appName**: `string`
+
+Defined in: [components/LoginForm/LoginForm.tsx:123](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/LoginForm/LoginForm.tsx#L123)
+
+Application name for display in the form
+
+***
+
+### title?
+
+> `optional` **title**: `string`
+
+Defined in: [components/LoginForm/LoginForm.tsx:125](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/LoginForm/LoginForm.tsx#L125)
+
+Custom title for the form
+
+***
+
+### subtitle?
+
+> `optional` **subtitle**: `string`
+
+Defined in: [components/LoginForm/LoginForm.tsx:127](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/LoginForm/LoginForm.tsx#L127)
+
+Custom subtitle for the form
+
+***
+
+### showSignUp?
+
+> `optional` **showSignUp**: `boolean`
+
+Defined in: [components/LoginForm/LoginForm.tsx:129](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/LoginForm/LoginForm.tsx#L129)
+
+Show a sign-up link or button
+
+***
+
+### onSignUp()?
+
+> `optional` **onSignUp**: () => `void`
+
+Defined in: [components/LoginForm/LoginForm.tsx:131](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/LoginForm/LoginForm.tsx#L131)
+
+Optional callback for sign-up button
+
+#### Returns
+
+`void`
+
+***
+
+### className?
+
+> `optional` **className**: `string`
+
+Defined in: [components/LoginForm/LoginForm.tsx:133](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/LoginForm/LoginForm.tsx#L133)
+
+Additional CSS classes

package/docs/api/interfaces/MissingUserContextError.md

@@ -0,0 +1,37 @@
+[**@jmruthers/pace-core v0.6.12**](../README.md)
+
+***
+
+[@jmruthers/pace-core](../globals.md) / MissingUserContextError
+
+# Interface: MissingUserContextError
+
+Defined in: [rbac/types.ts:370](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/types.ts#L370)
+
+## Extends
+
+- [`RBACError`](RBACError.md)
+
+## Properties
+
+### code
+
+> **code**: `string`
+
+Defined in: [rbac/types.ts:310](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/types.ts#L310)
+
+#### Inherited from
+
+[`RBACError`](RBACError.md).[`code`](RBACError.md#code)
+
+***
+
+### context?
+
+> `optional` **context**: `Record`\<`string`, `unknown`\>
+
+Defined in: [rbac/types.ts:311](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/types.ts#L311)
+
+#### Inherited from
+
+[`RBACError`](RBACError.md).[`context`](RBACError.md#context)

package/docs/api/interfaces/NavigationGuardProps.md

@@ -0,0 +1,109 @@
+[**@jmruthers/pace-core v0.6.12**](../README.md)
+
+***
+
+[@jmruthers/pace-core](../globals.md) / NavigationGuardProps
+
+# Interface: NavigationGuardProps
+
+Defined in: [rbac/components/NavigationGuard.tsx:78](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/NavigationGuard.tsx#L78)
+
+## Properties
+
+### navigationItem
+
+> **navigationItem**: [`NavigationItem`](NavigationItem.md)
+
+Defined in: [rbac/components/NavigationGuard.tsx:80](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/NavigationGuard.tsx#L80)
+
+Navigation item being protected
+
+***
+
+### children
+
+> **children**: `ReactNode`
+
+Defined in: [rbac/components/NavigationGuard.tsx:83](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/NavigationGuard.tsx#L83)
+
+Content to render when user has permission
+
+***
+
+### fallback?
+
+> `optional` **fallback**: `ReactNode`
+
+Defined in: [rbac/components/NavigationGuard.tsx:86](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/NavigationGuard.tsx#L86)
+
+Content to render when user lacks permission
+
+***
+
+### strictMode?
+
+> `optional` **strictMode**: `boolean`
+
+Defined in: [rbac/components/NavigationGuard.tsx:89](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/NavigationGuard.tsx#L89)
+
+Enable strict mode to prevent bypassing (default: true)
+
+***
+
+### auditLog?
+
+> `optional` **auditLog**: `boolean`
+
+Defined in: [rbac/components/NavigationGuard.tsx:92](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/NavigationGuard.tsx#L92)
+
+Force audit logging for this navigation access (default: true)
+
+***
+
+### scope?
+
+> `optional` **scope**: [`Scope`](../type-aliases/Scope.md)
+
+Defined in: [rbac/components/NavigationGuard.tsx:95](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/NavigationGuard.tsx#L95)
+
+Custom scope for permission checking
+
+***
+
+### onDenied()?
+
+> `optional` **onDenied**: (`item`) => `void`
+
+Defined in: [rbac/components/NavigationGuard.tsx:98](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/NavigationGuard.tsx#L98)
+
+Callback when access is denied
+
+#### Parameters
+
+##### item
+
+[`NavigationItem`](NavigationItem.md)
+
+#### Returns
+
+`void`
+
+***
+
+### loading?
+
+> `optional` **loading**: `ReactNode`
+
+Defined in: [rbac/components/NavigationGuard.tsx:101](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/NavigationGuard.tsx#L101)
+
+Loading state content
+
+***
+
+### requireAll?
+
+> `optional` **requireAll**: `boolean`
+
+Defined in: [rbac/components/NavigationGuard.tsx:104](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/NavigationGuard.tsx#L104)
+
+Require all permissions (AND) or any permission (OR)

package/docs/api/interfaces/NavigationItem.md

@@ -0,0 +1,91 @@
+[**@jmruthers/pace-core v0.6.12**](../README.md)
+
+***
+
+[@jmruthers/pace-core](../globals.md) / NavigationItem
+
+# Interface: NavigationItem
+
+Defined in: [components/NavigationMenu/types.ts:20](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/NavigationMenu/types.ts#L20)
+
+Navigation item interface
+
+## Properties
+
+### id
+
+> **id**: `string`
+
+Defined in: [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: [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: [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: [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`[]
+
+Defined in: [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: [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: [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: [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: [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: [components/NavigationMenu/types.ts:30](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/NavigationMenu/types.ts#L30)