@jmruthers/pace-core 0.6.1 → 0.6.3

package/docs/api/interfaces/FileUploadOptions.md

@@ -1,139 +0,0 @@
-[@jmruthers/pace-core - v0.5.192](../README.md) / [Exports](../modules.md) / FileUploadOptions
-
-# Interface: FileUploadOptions
-
-Options for uploading a file with a file reference
-
-## Table of contents
-
-### Properties
-
-- [table\_name](FileUploadOptions.md#table_name)
-- [record\_id](FileUploadOptions.md#record_id)
-- [organisation\_id](FileUploadOptions.md#organisation_id)
-- [app\_id](FileUploadOptions.md#app_id)
-- [category](FileUploadOptions.md#category)
-- [folder](FileUploadOptions.md#folder)
-- [pageContext](FileUploadOptions.md#pagecontext)
-- [event\_id](FileUploadOptions.md#event_id)
-- [is\_public](FileUploadOptions.md#is_public)
-- [custom\_metadata](FileUploadOptions.md#custom_metadata)
-- [userId](FileUploadOptions.md#userid)
-
-## Properties
-
-### table\_name
-
-• **table\_name**: `string`
-
-#### Defined in
-
-[packages/core/src/types/file-reference.ts:63](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/file-reference.ts#L63)
-
-___
-
-### record\_id
-
-• **record\_id**: `string`
-
-#### Defined in
-
-[packages/core/src/types/file-reference.ts:64](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/file-reference.ts#L64)
-
-___
-
-### organisation\_id
-
-• **organisation\_id**: ``null`` \| `string`
-
-Optional organisation ID. If not provided, the file is user-owned (record_id must match user_id).
-                             For user-owned files, users can only access their own files.
-
-#### Defined in
-
-[packages/core/src/types/file-reference.ts:65](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/file-reference.ts#L65)
-
-___
-
-### app\_id
-
-• **app\_id**: `AppId`
-
-#### Defined in
-
-[packages/core/src/types/file-reference.ts:66](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/file-reference.ts#L66)
-
-___
-
-### category
-
-• **category**: [`FileCategory`](../enums/FileCategory.md)
-
-#### Defined in
-
-[packages/core/src/types/file-reference.ts:67](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/file-reference.ts#L67)
-
-___
-
-### folder
-
-• **folder**: `string`
-
-#### Defined in
-
-[packages/core/src/types/file-reference.ts:68](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/file-reference.ts#L68)
-
-___
-
-### pageContext
-
-• **pageContext**: `string`
-
-The page context where the file upload occurs (e.g., 'configuration', 'forms', 'applications')
-                         Used for context-aware permission checks. Required to check appropriate page-level permissions.
-
-#### Defined in
-
-[packages/core/src/types/file-reference.ts:69](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/file-reference.ts#L69)
-
-___
-
-### event\_id
-
-• `Optional` **event\_id**: `string`
-
-Optional event ID for event-scoped permission checks. Required for event-based apps.
-
-#### Defined in
-
-[packages/core/src/types/file-reference.ts:70](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/file-reference.ts#L70)
-
-___
-
-### is\_public
-
-• `Optional` **is\_public**: `boolean`
-
-#### Defined in
-
-[packages/core/src/types/file-reference.ts:71](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/file-reference.ts#L71)
-
-___
-
-### custom\_metadata
-
-• `Optional` **custom\_metadata**: `Record`\<`string`, `unknown`\>
-
-#### Defined in
-
-[packages/core/src/types/file-reference.ts:72](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/file-reference.ts#L72)
-
-___
-
-### userId
-
-• `Optional` **userId**: `string`
-
-#### Defined in
-
-[packages/core/src/types/file-reference.ts:73](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/file-reference.ts#L73)

package/docs/api/interfaces/FileUploadProps.md

@@ -1,293 +0,0 @@
-[@jmruthers/pace-core - v0.5.192](../README.md) / [Exports](../modules.md) / FileUploadProps
-
-# Interface: FileUploadProps
-
-## Table of contents
-
-### Properties
-
-- [supabase](FileUploadProps.md#supabase)
-- [table\_name](FileUploadProps.md#table_name)
-- [record\_id](FileUploadProps.md#record_id)
-- [organisation\_id](FileUploadProps.md#organisation_id)
-- [userId](FileUploadProps.md#userid)
-- [app\_id](FileUploadProps.md#app_id)
-- [category](FileUploadProps.md#category)
-- [folder](FileUploadProps.md#folder)
-- [pageContext](FileUploadProps.md#pagecontext)
-- [event\_id](FileUploadProps.md#event_id)
-- [accept](FileUploadProps.md#accept)
-- [maxSize](FileUploadProps.md#maxsize)
-- [multiple](FileUploadProps.md#multiple)
-- [disabled](FileUploadProps.md#disabled)
-- [isPublic](FileUploadProps.md#ispublic)
-- [className](FileUploadProps.md#classname)
-- [showPreview](FileUploadProps.md#showpreview)
-- [showProgress](FileUploadProps.md#showprogress)
-- [onUploadSuccess](FileUploadProps.md#onuploadsuccess)
-- [onUploadError](FileUploadProps.md#onuploaderror)
-- [onProgress](FileUploadProps.md#onprogress)
-- [children](FileUploadProps.md#children)
-
-## Properties
-
-### supabase
-
-• **supabase**: `default`\<`any`, ``"public"``, ``"public"``, `any`, `any`\>
-
-#### Defined in
-
-[packages/core/src/components/FileUpload/FileUpload.tsx:19](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/FileUpload/FileUpload.tsx#L19)
-
-___
-
-### table\_name
-
-• **table\_name**: `string`
-
-#### Defined in
-
-[packages/core/src/components/FileUpload/FileUpload.tsx:20](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/FileUpload/FileUpload.tsx#L20)
-
-___
-
-### record\_id
-
-• **record\_id**: `string`
-
-#### Defined in
-
-[packages/core/src/components/FileUpload/FileUpload.tsx:21](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/FileUpload/FileUpload.tsx#L21)
-
-___
-
-### organisation\_id
-
-• `Optional` **organisation\_id**: ``null`` \| `string`
-
-#### Defined in
-
-[packages/core/src/components/FileUpload/FileUpload.tsx:22](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/FileUpload/FileUpload.tsx#L22)
-
-___
-
-### userId
-
-• `Optional` **userId**: `string`
-
-#### Defined in
-
-[packages/core/src/components/FileUpload/FileUpload.tsx:23](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/FileUpload/FileUpload.tsx#L23)
-
-___
-
-### app\_id
-
-• `Optional` **app\_id**: `string`
-
-#### Defined in
-
-[packages/core/src/components/FileUpload/FileUpload.tsx:24](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/FileUpload/FileUpload.tsx#L24)
-
-___
-
-### category
-
-• **category**: [`FileCategory`](../enums/FileCategory.md)
-
-#### Defined in
-
-[packages/core/src/components/FileUpload/FileUpload.tsx:25](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/FileUpload/FileUpload.tsx#L25)
-
-___
-
-### folder
-
-• **folder**: `string`
-
-#### Defined in
-
-[packages/core/src/components/FileUpload/FileUpload.tsx:26](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/FileUpload/FileUpload.tsx#L26)
-
-___
-
-### pageContext
-
-• **pageContext**: `string`
-
-#### Defined in
-
-[packages/core/src/components/FileUpload/FileUpload.tsx:27](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/FileUpload/FileUpload.tsx#L27)
-
-___
-
-### event\_id
-
-• `Optional` **event\_id**: `string`
-
-#### Defined in
-
-[packages/core/src/components/FileUpload/FileUpload.tsx:28](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/FileUpload/FileUpload.tsx#L28)
-
-___
-
-### accept
-
-• `Optional` **accept**: `string`
-
-#### Defined in
-
-[packages/core/src/components/FileUpload/FileUpload.tsx:29](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/FileUpload/FileUpload.tsx#L29)
-
-___
-
-### maxSize
-
-• `Optional` **maxSize**: `number`
-
-#### Defined in
-
-[packages/core/src/components/FileUpload/FileUpload.tsx:30](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/FileUpload/FileUpload.tsx#L30)
-
-___
-
-### multiple
-
-• `Optional` **multiple**: `boolean`
-
-#### Defined in
-
-[packages/core/src/components/FileUpload/FileUpload.tsx:31](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/FileUpload/FileUpload.tsx#L31)
-
-___
-
-### disabled
-
-• `Optional` **disabled**: `boolean`
-
-#### Defined in
-
-[packages/core/src/components/FileUpload/FileUpload.tsx:32](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/FileUpload/FileUpload.tsx#L32)
-
-___
-
-### isPublic
-
-• `Optional` **isPublic**: `boolean`
-
-#### Defined in
-
-[packages/core/src/components/FileUpload/FileUpload.tsx:33](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/FileUpload/FileUpload.tsx#L33)
-
-___
-
-### className
-
-• `Optional` **className**: `string`
-
-#### Defined in
-
-[packages/core/src/components/FileUpload/FileUpload.tsx:34](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/FileUpload/FileUpload.tsx#L34)
-
-___
-
-### showPreview
-
-• `Optional` **showPreview**: `boolean`
-
-#### Defined in
-
-[packages/core/src/components/FileUpload/FileUpload.tsx:35](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/FileUpload/FileUpload.tsx#L35)
-
-___
-
-### showProgress
-
-• `Optional` **showProgress**: `boolean`
-
-#### Defined in
-
-[packages/core/src/components/FileUpload/FileUpload.tsx:36](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/FileUpload/FileUpload.tsx#L36)
-
-___
-
-### onUploadSuccess
-
-• `Optional` **onUploadSuccess**: (`result`: `FileUploadResult`) => `void`
-
-#### Type declaration
-
-▸ (`result`): `void`
-
-##### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `result` | `FileUploadResult` |
-
-##### Returns
-
-`void`
-
-#### Defined in
-
-[packages/core/src/components/FileUpload/FileUpload.tsx:37](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/FileUpload/FileUpload.tsx#L37)
-
-___
-
-### onUploadError
-
-• `Optional` **onUploadError**: (`error`: `string`, `file?`: `File`) => `void`
-
-#### Type declaration
-
-▸ (`error`, `file?`): `void`
-
-##### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `error` | `string` |
-| `file?` | `File` |
-
-##### Returns
-
-`void`
-
-#### Defined in
-
-[packages/core/src/components/FileUpload/FileUpload.tsx:38](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/FileUpload/FileUpload.tsx#L38)
-
-___
-
-### onProgress
-
-• `Optional` **onProgress**: (`progress`: `UploadProgress`) => `void`
-
-#### Type declaration
-
-▸ (`progress`): `void`
-
-##### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `progress` | `UploadProgress` |
-
-##### Returns
-
-`void`
-
-#### Defined in
-
-[packages/core/src/components/FileUpload/FileUpload.tsx:39](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/FileUpload/FileUpload.tsx#L39)
-
-___
-
-### children
-
-• `Optional` **children**: `ReactNode`
-
-#### Defined in
-
-[packages/core/src/components/FileUpload/FileUpload.tsx:40](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/FileUpload/FileUpload.tsx#L40)

package/docs/api/interfaces/FooterProps.md

@@ -1,105 +0,0 @@
-[@jmruthers/pace-core - v0.5.192](../README.md) / [Exports](../modules.md) / FooterProps
-
-# Interface: FooterProps
-
-## Table of contents
-
-### Properties
-
-- [companyName](FooterProps.md#companyname)
-- [year](FooterProps.md#year)
-- [links](FooterProps.md#links)
-- [className](FooterProps.md#classname)
-- [logo](FooterProps.md#logo)
-- [copyright](FooterProps.md#copyright)
-- [children](FooterProps.md#children)
-
-## Properties
-
-### companyName
-
-• `Optional` **companyName**: `string`
-
-Company or organization name
-
-#### Defined in
-
-[packages/core/src/components/Footer/Footer.tsx:94](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/Footer/Footer.tsx#L94)
-
-___
-
-### year
-
-• `Optional` **year**: `number`
-
-Current year or custom year for copyright
-
-**`Default`**
-
-```ts
-current year
-```
-
-#### Defined in
-
-[packages/core/src/components/Footer/Footer.tsx:100](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/Footer/Footer.tsx#L100)
-
-___
-
-### links
-
-• `Optional` **links**: \{ `label`: `string` ; `href`: `string`  }[]
-
-Optional array of navigation links to display
-
-#### Defined in
-
-[packages/core/src/components/Footer/Footer.tsx:105](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/Footer/Footer.tsx#L105)
-
-___
-
-### className
-
-• `Optional` **className**: `string`
-
-Optional CSS class name
-
-#### Defined in
-
-[packages/core/src/components/Footer/Footer.tsx:113](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/Footer/Footer.tsx#L113)
-
-___
-
-### logo
-
-• `Optional` **logo**: `string`
-
-Logo image URL (from UI version)
-
-#### Defined in
-
-[packages/core/src/components/Footer/Footer.tsx:118](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/Footer/Footer.tsx#L118)
-
-___
-
-### copyright
-
-• `Optional` **copyright**: `string`
-
-Copyright text (from UI version)
-
-#### Defined in
-
-[packages/core/src/components/Footer/Footer.tsx:123](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/Footer/Footer.tsx#L123)
-
-___
-
-### children
-
-• `Optional` **children**: `ReactNode`
-
-Footer content - children to render inside footer
-
-#### Defined in
-
-[packages/core/src/components/Footer/Footer.tsx:128](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/Footer/Footer.tsx#L128)

package/docs/api/interfaces/FormFieldProps.md

@@ -1,166 +0,0 @@
-[@jmruthers/pace-core - v0.5.192](../README.md) / [Exports](../modules.md) / FormFieldProps
-
-# Interface: FormFieldProps\<TFieldValues, TName\>
-
-Props for the FormField component
-
-## Type parameters
-
-| Name | Type |
-| :------ | :------ |
-| `TFieldValues` | extends `FieldValues` = `FieldValues` |
-| `TName` | extends `FieldPath`\<`TFieldValues`\> = `FieldPath`\<`TFieldValues`\> |
-
-## Table of contents
-
-### Properties
-
-- [name](FormFieldProps.md#name)
-- [label](FormFieldProps.md#label)
-- [type](FormFieldProps.md#type)
-- [placeholder](FormFieldProps.md#placeholder)
-- [inputProps](FormFieldProps.md#inputprops)
-- [validation](FormFieldProps.md#validation)
-- [render](FormFieldProps.md#render)
-- [data-testid](FormFieldProps.md#data-testid)
-- [className](FormFieldProps.md#classname)
-
-## Properties
-
-### name
-
-• **name**: `TName`
-
-Field name
-
-#### Defined in
-
-[packages/core/src/components/Form/Form.tsx:179](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/Form/Form.tsx#L179)
-
-___
-
-### label
-
-• `Optional` **label**: `string`
-
-Field label
-
-#### Defined in
-
-[packages/core/src/components/Form/Form.tsx:184](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/Form/Form.tsx#L184)
-
-___
-
-### type
-
-• `Optional` **type**: `string`
-
-Field type
-
-#### Defined in
-
-[packages/core/src/components/Form/Form.tsx:189](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/Form/Form.tsx#L189)
-
-___
-
-### placeholder
-
-• `Optional` **placeholder**: `string`
-
-Placeholder text
-
-#### Defined in
-
-[packages/core/src/components/Form/Form.tsx:194](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/Form/Form.tsx#L194)
-
-___
-
-### inputProps
-
-• `Optional` **inputProps**: `InputHTMLAttributes`\<`HTMLInputElement`\>
-
-Additional props for the input
-
-#### Defined in
-
-[packages/core/src/components/Form/Form.tsx:199](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/Form/Form.tsx#L199)
-
-___
-
-### validation
-
-• `Optional` **validation**: `Object`
-
-Validation rules
-
-#### Type declaration
-
-| Name | Type |
-| :------ | :------ |
-| `required?` | `boolean` |
-| `pattern?` | \{ `value`: `RegExp` ; `message`: `string`  } |
-| `pattern.value` | `RegExp` |
-| `pattern.message` | `string` |
-| `minLength?` | \{ `value`: `number` ; `message`: `string`  } |
-| `minLength.value` | `number` |
-| `minLength.message` | `string` |
-| `maxLength?` | \{ `value`: `number` ; `message`: `string`  } |
-| `maxLength.value` | `number` |
-| `maxLength.message` | `string` |
-
-#### Defined in
-
-[packages/core/src/components/Form/Form.tsx:204](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/Form/Form.tsx#L204)
-
-___
-
-### render
-
-• `Optional` **render**: (`props`: \{ `field`: `ControllerRenderProps`\<`TFieldValues`, `TName`\> ; `fieldState`: `ControllerFieldState` ; `formState`: `UseFormStateReturn`\<`TFieldValues`\>  }) => `ReactElement`\<`any`, `string` \| `JSXElementConstructor`\<`any`\>\>
-
-Custom render function
-
-#### Type declaration
-
-▸ (`props`): `ReactElement`\<`any`, `string` \| `JSXElementConstructor`\<`any`\>\>
-
-##### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `props` | `Object` |
-| `props.field` | `ControllerRenderProps`\<`TFieldValues`, `TName`\> |
-| `props.fieldState` | `ControllerFieldState` |
-| `props.formState` | `UseFormStateReturn`\<`TFieldValues`\> |
-
-##### Returns
-
-`ReactElement`\<`any`, `string` \| `JSXElementConstructor`\<`any`\>\>
-
-#### Defined in
-
-[packages/core/src/components/Form/Form.tsx:223](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/Form/Form.tsx#L223)
-
-___
-
-### data-testid
-
-• `Optional` **data-testid**: `string`
-
-Test ID
-
-#### Defined in
-
-[packages/core/src/components/Form/Form.tsx:232](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/Form/Form.tsx#L232)
-
-___
-
-### className
-
-• `Optional` **className**: `string`
-
-Class name
-
-#### Defined in
-
-[packages/core/src/components/Form/Form.tsx:237](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/Form/Form.tsx#L237)