@jmruthers/pace-core 0.6.2 → 0.6.3

package/docs/api/interfaces/AggregateConfig.md

@@ -1,43 +0,0 @@
-[@jmruthers/pace-core - v0.6.2](../README.md) / [Exports](../modules.md) / AggregateConfig
-
-# Interface: AggregateConfig
-
-Aggregate configuration
-
-## Table of contents
-
-### Properties
-
-- [field](AggregateConfig.md#field)
-- [function](AggregateConfig.md#function)
-- [label](AggregateConfig.md#label)
-
-## Properties
-
-### field
-
-• **field**: `string`
-
-#### Defined in
-
-[packages/core/src/components/DataTable/types.ts:455](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/DataTable/types.ts#L455)
-
-___
-
-### function
-
-• **function**: ``"count"`` \| ``"sum"`` \| ``"avg"`` \| ``"min"`` \| ``"max"``
-
-#### Defined in
-
-[packages/core/src/components/DataTable/types.ts:456](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/DataTable/types.ts#L456)
-
-___
-
-### label
-
-• **label**: `string`
-
-#### Defined in
-
-[packages/core/src/components/DataTable/types.ts:457](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/DataTable/types.ts#L457)

package/docs/api/interfaces/AutocompleteOptions.md

@@ -1,75 +0,0 @@
-[@jmruthers/pace-core - v0.6.2](../README.md) / [Exports](../modules.md) / AutocompleteOptions
-
-# Interface: AutocompleteOptions
-
-Options for Google Places Autocomplete API
-
-## Table of contents
-
-### Properties
-
-- [components](AutocompleteOptions.md#components)
-- [location](AutocompleteOptions.md#location)
-- [radius](AutocompleteOptions.md#radius)
-- [types](AutocompleteOptions.md#types)
-- [language](AutocompleteOptions.md#language)
-
-## Properties
-
-### components
-
-• `Optional` **components**: `string`
-
-Restrict results to specific countries (ISO 3166-1 Alpha-2 country codes)
-
-#### Defined in
-
-[packages/core/src/utils/google-places/types.ts:84](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/utils/google-places/types.ts#L84)
-
-___
-
-### location
-
-• `Optional` **location**: `string`
-
-Location bias (lat,lng)
-
-#### Defined in
-
-[packages/core/src/utils/google-places/types.ts:86](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/utils/google-places/types.ts#L86)
-
-___
-
-### radius
-
-• `Optional` **radius**: `number`
-
-Radius in meters for location bias
-
-#### Defined in
-
-[packages/core/src/utils/google-places/types.ts:88](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/utils/google-places/types.ts#L88)
-
-___
-
-### types
-
-• `Optional` **types**: `string`
-
-Restrict results to specific place types
-
-#### Defined in
-
-[packages/core/src/utils/google-places/types.ts:90](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/utils/google-places/types.ts#L90)
-
-___
-
-### language
-
-• `Optional` **language**: `string`
-
-Language code for results
-
-#### Defined in
-
-[packages/core/src/utils/google-places/types.ts:92](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/utils/google-places/types.ts#L92)

package/docs/api/interfaces/AvatarProps.md

@@ -1,128 +0,0 @@
-[@jmruthers/pace-core - v0.6.2](../README.md) / [Exports](../modules.md) / AvatarProps
-
-# Interface: AvatarProps
-
-## Hierarchy
-
-- `HTMLAttributes`\<`HTMLDivElement`\>
-
-  ↳ **`AvatarProps`**
-
-## Table of contents
-
-### Properties
-
-- [table\_name](AvatarProps.md#table_name)
-- [record\_id](AvatarProps.md#record_id)
-- [organisation\_id](AvatarProps.md#organisation_id)
-- [category](AvatarProps.md#category)
-- [fileId](AvatarProps.md#fileid)
-- [src](AvatarProps.md#src)
-- [alt](AvatarProps.md#alt)
-- [fallback](AvatarProps.md#fallback)
-- [className](AvatarProps.md#classname)
-- [size](AvatarProps.md#size)
-
-## Properties
-
-### table\_name
-
-• `Optional` **table\_name**: `string`
-
-#### Defined in
-
-[packages/core/src/components/Avatar/Avatar.tsx:76](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/Avatar/Avatar.tsx#L76)
-
-___
-
-### record\_id
-
-• `Optional` **record\_id**: `string`
-
-#### Defined in
-
-[packages/core/src/components/Avatar/Avatar.tsx:77](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/Avatar/Avatar.tsx#L77)
-
-___
-
-### organisation\_id
-
-• `Optional` **organisation\_id**: `string`
-
-#### Defined in
-
-[packages/core/src/components/Avatar/Avatar.tsx:78](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/Avatar/Avatar.tsx#L78)
-
-___
-
-### category
-
-• `Optional` **category**: [`FileCategory`](../enums/FileCategory.md)
-
-#### Defined in
-
-[packages/core/src/components/Avatar/Avatar.tsx:79](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/Avatar/Avatar.tsx#L79)
-
-___
-
-### fileId
-
-• `Optional` **fileId**: `string`
-
-#### Defined in
-
-[packages/core/src/components/Avatar/Avatar.tsx:82](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/Avatar/Avatar.tsx#L82)
-
-___
-
-### src
-
-• `Optional` **src**: `string`
-
-#### Defined in
-
-[packages/core/src/components/Avatar/Avatar.tsx:85](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/Avatar/Avatar.tsx#L85)
-
-___
-
-### alt
-
-• `Optional` **alt**: `string`
-
-#### Defined in
-
-[packages/core/src/components/Avatar/Avatar.tsx:86](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/Avatar/Avatar.tsx#L86)
-
-___
-
-### fallback
-
-• **fallback**: `string`
-
-#### Defined in
-
-[packages/core/src/components/Avatar/Avatar.tsx:89](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/Avatar/Avatar.tsx#L89)
-
-___
-
-### className
-
-• `Optional` **className**: `string`
-
-#### Overrides
-
-React.HTMLAttributes.className
-
-#### Defined in
-
-[packages/core/src/components/Avatar/Avatar.tsx:92](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/Avatar/Avatar.tsx#L92)
-
-___
-
-### size
-
-• `Optional` **size**: ``"sm"`` \| ``"lg"`` \| ``"md"`` \| ``"xl"`` \| ``"xs"`` \| ``"2xl"``
-
-#### Defined in
-
-[packages/core/src/components/Avatar/Avatar.tsx:93](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/Avatar/Avatar.tsx#L93)

package/docs/api/interfaces/BadgeProps.md

@@ -1,34 +0,0 @@
-[@jmruthers/pace-core - v0.6.2](../README.md) / [Exports](../modules.md) / BadgeProps
-
-# Interface: BadgeProps
-
-Badge component props
-Extends standard HTML span attributes with badge-specific styling options.
-
-**`Interface`**
-
-BadgeProps
-
-## Hierarchy
-
-- `HTMLAttributes`\<`HTMLSpanElement`\>
-
-  ↳ **`BadgeProps`**
-
-## Table of contents
-
-### Properties
-
-- [variant](BadgeProps.md#variant)
-
-## Properties
-
-### variant
-
-• `Optional` **variant**: [`BadgeVariant`](../modules.md#badgevariant)
-
-Visual variant of the badge (style-color-shade)
-
-#### Defined in
-
-[packages/core/src/components/Badge/Badge.tsx:79](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/Badge/Badge.tsx#L79)

package/docs/api/interfaces/ButtonProps.md

@@ -1,56 +0,0 @@
-[@jmruthers/pace-core - v0.6.2](../README.md) / [Exports](../modules.md) / ButtonProps
-
-# Interface: ButtonProps
-
-Props for the Button component.
-Extends standard button HTML attributes.
-
-## Hierarchy
-
-- `ButtonHTMLAttributes`\<`HTMLButtonElement`\>
-
-  ↳ **`ButtonProps`**
-
-## Table of contents
-
-### Properties
-
-- [variant](ButtonProps.md#variant)
-- [size](ButtonProps.md#size)
-- [asChild](ButtonProps.md#aschild)
-
-## Properties
-
-### variant
-
-• `Optional` **variant**: ``"link"`` \| ``"default"`` \| ``"destructive"`` \| ``"outline"`` \| ``"secondary"`` \| ``"ghost"``
-
-Visual variant of the button
-
-#### Defined in
-
-[packages/core/src/components/Button/Button.tsx:68](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/Button/Button.tsx#L68)
-
-___
-
-### size
-
-• `Optional` **size**: ``"default"`` \| ``"sm"`` \| ``"lg"`` \| ``"icon"``
-
-Size of the button
-
-#### Defined in
-
-[packages/core/src/components/Button/Button.tsx:70](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/Button/Button.tsx#L70)
-
-___
-
-### asChild
-
-• `Optional` **asChild**: `boolean`
-
-Whether to render as a different element using Radix Slot
-
-#### Defined in
-
-[packages/core/src/components/Button/Button.tsx:72](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/Button/Button.tsx#L72)

package/docs/api/interfaces/CalendarProps.md

@@ -1,73 +0,0 @@
-[@jmruthers/pace-core - v0.6.2](../README.md) / [Exports](../modules.md) / CalendarProps
-
-# Interface: CalendarProps
-
-Props for the Calendar component.
-Extends DayPickerProps with pace-core specific customizations.
-
-## Hierarchy
-
-- `Omit`\<`DayPickerProps`, ``"className"`` \| ``"classNames"`` \| ``"styles"`` \| ``"onSelect"``\>
-
-  ↳ **`CalendarProps`**
-
-## Table of contents
-
-### Properties
-
-- [className](CalendarProps.md#classname)
-- [classNames](CalendarProps.md#classnames)
-- [selected](CalendarProps.md#selected)
-- [onSelect](CalendarProps.md#onselect)
-
-## Properties
-
-### className
-
-• `Optional` **className**: `string`
-
-Additional CSS classes to apply to the calendar table
-
-#### Defined in
-
-[packages/core/src/components/Calendar/Calendar.tsx:100](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/Calendar/Calendar.tsx#L100)
-
-___
-
-### classNames
-
-• `Optional` **classNames**: `Partial`\<`ClassNames`\> & `Partial`\<`DeprecatedUI`\<`string`\>\>
-
-Custom classNames for DayPicker sub-components
-
-#### Defined in
-
-[packages/core/src/components/Calendar/Calendar.tsx:104](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/Calendar/Calendar.tsx#L104)
-
-___
-
-### selected
-
-• `Optional` **selected**: `Date` \| `Date`[] \| `DateRange`
-
-Currently selected value; mirrors DayPicker's `selected` prop so callers
-can control the selection state.
-
-#### Defined in
-
-[packages/core/src/components/Calendar/Calendar.tsx:109](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/Calendar/Calendar.tsx#L109)
-
-___
-
-### onSelect
-
-• `Optional` **onSelect**: (`date`: `undefined` \| `Date`) => `void` \| (`range`: `undefined` \| \{ `from`: `Date` ; `to?`: `Date`  }) => `void` \| (`dates`: `Date`[]) => `void`
-
-Date selection handler. Signature depends on mode:
-- mode="single": (date: Date | undefined) => void
-- mode="range": (range: { from: Date; to?: Date } | undefined) => void
-- mode="multiple": (dates: Date[]) => void
-
-#### Defined in
-
-[packages/core/src/components/Calendar/Calendar.tsx:116](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/Calendar/Calendar.tsx#L116)

package/docs/api/interfaces/CardProps.md

@@ -1,69 +0,0 @@
-[@jmruthers/pace-core - v0.6.2](../README.md) / [Exports](../modules.md) / CardProps
-
-# Interface: CardProps
-
-Props for the Card component.
-Extends standard HTML attributes for semantic HTML elements.
-
-## Hierarchy
-
-- `HTMLAttributes`\<`HTMLElement`\>
-
-  ↳ **`CardProps`**
-
-## Table of contents
-
-### Properties
-
-- [variant](CardProps.md#variant)
-- [size](CardProps.md#size)
-- [isLink](CardProps.md#islink)
-- [link](CardProps.md#link)
-
-## Properties
-
-### variant
-
-• `Optional` **variant**: ``"default"`` \| ``"outline"`` \| ``"ghost"``
-
-Visual variant of the card
-
-#### Defined in
-
-[packages/core/src/components/Card/Card.tsx:74](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/Card/Card.tsx#L74)
-
-___
-
-### size
-
-• `Optional` **size**: ``"default"`` \| ``"sm"`` \| ``"lg"``
-
-Size of the card
-
-#### Defined in
-
-[packages/core/src/components/Card/Card.tsx:76](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/Card/Card.tsx#L76)
-
-___
-
-### isLink
-
-• `Optional` **isLink**: `boolean`
-
-Whether the card should appear as a clickable link with hover effects
-
-#### Defined in
-
-[packages/core/src/components/Card/Card.tsx:78](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/Card/Card.tsx#L78)
-
-___
-
-### link
-
-• `Optional` **link**: `string`
-
-Path or URL to navigate to when the card is clicked
-
-#### Defined in
-
-[packages/core/src/components/Card/Card.tsx:80](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/Card/Card.tsx#L80)

package/docs/api/interfaces/ColorPalette.md

@@ -1,7 +0,0 @@
-[@jmruthers/pace-core - v0.6.2](../README.md) / [Exports](../modules.md) / ColorPalette
-
-# Interface: ColorPalette
-
-## Indexable
-
-▪ [shade: `string`]: [`ColorShade`](ColorShade.md)

package/docs/api/interfaces/ColorShade.md

@@ -1,66 +0,0 @@
-[@jmruthers/pace-core - v0.6.2](../README.md) / [Exports](../modules.md) / ColorShade
-
-# Interface: ColorShade
-
-**`Example`**
-
-```ts
-import { applyPalette, clearPalette } from '@jmruthers/pace-core/theming/runtime';
-
-// Apply organisation colors
-applyPalette({
-  main: { // main palette shades
-    50: { L: 0.95, C: 0.02, H: 0 },
-    500: { L: 0.5, C: 0.2, H: 0 }
-  },
-  sec: { // secondary palette shades
-    50: { L: 0.95, C: 0.02, H: 120 },
-    500: { L: 0.5, C: 0.2, H: 120 }
-  },
-  acc: { // accent palette shades
-    50: { L: 0.95, C: 0.02, H: 240 },
-    500: { L: 0.5, C: 0.2, H: 240 }
-  }
-});
-
-// Clear dynamic theming
-clearPalette();
-```
-
-## Table of contents
-
-### Properties
-
-- [L](ColorShade.md#l)
-- [C](ColorShade.md#c)
-- [H](ColorShade.md#h)
-
-## Properties
-
-### L
-
-• **L**: `number`
-
-#### Defined in
-
-[packages/core/src/theming/runtime.ts:42](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/theming/runtime.ts#L42)
-
-___
-
-### C
-
-• **C**: `number`
-
-#### Defined in
-
-[packages/core/src/theming/runtime.ts:43](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/theming/runtime.ts#L43)
-
-___
-
-### H
-
-• **H**: `number`
-
-#### Defined in
-
-[packages/core/src/theming/runtime.ts:44](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/theming/runtime.ts#L44)

package/docs/api/interfaces/ComplianceResult.md

@@ -1,30 +0,0 @@
-[@jmruthers/pace-core - v0.6.2](../README.md) / [Exports](../modules.md) / ComplianceResult
-
-# Interface: ComplianceResult
-
-## Table of contents
-
-### Properties
-
-- [isCompliant](ComplianceResult.md#iscompliant)
-- [issues](ComplianceResult.md#issues)
-
-## Properties
-
-### isCompliant
-
-• **isCompliant**: `boolean`
-
-#### Defined in
-
-[packages/core/src/rbac/compliance/setup-validator.ts:20](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/compliance/setup-validator.ts#L20)
-
-___
-
-### issues
-
-• **issues**: [`SetupIssue`](SetupIssue.md)[]
-
-#### Defined in
-
-[packages/core/src/rbac/compliance/setup-validator.ts:21](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/compliance/setup-validator.ts#L21)

package/docs/api/interfaces/DataAccessRecord.md

@@ -1,96 +0,0 @@
-[@jmruthers/pace-core - v0.6.2](../README.md) / [Exports](../modules.md) / DataAccessRecord
-
-# Interface: DataAccessRecord
-
-## Table of contents
-
-### Properties
-
-- [table](DataAccessRecord.md#table)
-- [operation](DataAccessRecord.md#operation)
-- [userId](DataAccessRecord.md#userid)
-- [scope](DataAccessRecord.md#scope)
-- [allowed](DataAccessRecord.md#allowed)
-- [timestamp](DataAccessRecord.md#timestamp)
-- [query](DataAccessRecord.md#query)
-- [filters](DataAccessRecord.md#filters)
-
-## Properties
-
-### table
-
-• **table**: `string`
-
-#### Defined in
-
-[packages/core/src/rbac/components/SecureDataProvider.tsx:68](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/SecureDataProvider.tsx#L68)
-
-___
-
-### operation
-
-• **operation**: `string`
-
-#### Defined in
-
-[packages/core/src/rbac/components/SecureDataProvider.tsx:69](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/SecureDataProvider.tsx#L69)
-
-___
-
-### userId
-
-• **userId**: `string`
-
-#### Defined in
-
-[packages/core/src/rbac/components/SecureDataProvider.tsx:70](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/SecureDataProvider.tsx#L70)
-
-___
-
-### scope
-
-• **scope**: [`Scope`](../modules.md#scope)
-
-#### Defined in
-
-[packages/core/src/rbac/components/SecureDataProvider.tsx:71](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/SecureDataProvider.tsx#L71)
-
-___
-
-### allowed
-
-• **allowed**: `boolean`
-
-#### Defined in
-
-[packages/core/src/rbac/components/SecureDataProvider.tsx:72](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/SecureDataProvider.tsx#L72)
-
-___
-
-### timestamp
-
-• **timestamp**: `string`
-
-#### Defined in
-
-[packages/core/src/rbac/components/SecureDataProvider.tsx:73](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/SecureDataProvider.tsx#L73)
-
-___
-
-### query
-
-• `Optional` **query**: `string`
-
-#### Defined in
-
-[packages/core/src/rbac/components/SecureDataProvider.tsx:74](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/SecureDataProvider.tsx#L74)
-
-___
-
-### filters
-
-• `Optional` **filters**: `Record`\<`string`, `any`\>
-
-#### Defined in
-
-[packages/core/src/rbac/components/SecureDataProvider.tsx:75](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/SecureDataProvider.tsx#L75)

package/docs/api/interfaces/DataRecord.md

@@ -1,11 +0,0 @@
-[@jmruthers/pace-core - v0.6.2](../README.md) / [Exports](../modules.md) / DataRecord
-
-# Interface: DataRecord
-
-Base data record type - all DataTable data must extend this
-This is a marker type that allows any object to be used as a data record
-Individual implementations should define more specific types
-
-## Indexable
-
-▪ [key: `string`]: `unknown`