@jmruthers/pace-core 0.4.1 → 0.5.1

package/docs/api/interfaces/PublicPageHeaderProps.md

@@ -0,0 +1,138 @@
+[@jmruthers/pace-core - v0.5.1](../README.md) / [Exports](../modules.md) / PublicPageHeaderProps
+
+# Interface: PublicPageHeaderProps
+
+## Table of contents
+
+### Properties
+
+- [event](PublicPageHeaderProps.md#event)
+- [eventCode](PublicPageHeaderProps.md#eventcode)
+- [title](PublicPageHeaderProps.md#title)
+- [description](PublicPageHeaderProps.md#description)
+- [showEventLogo](PublicPageHeaderProps.md#showeventlogo)
+- [showAppLogo](PublicPageHeaderProps.md#showapplogo)
+- [className](PublicPageHeaderProps.md#classname)
+- [children](PublicPageHeaderProps.md#children)
+- [customAppLogo](PublicPageHeaderProps.md#customapplogo)
+- [customEventLogo](PublicPageHeaderProps.md#customeventlogo)
+
+## Properties
+
+### event
+
+• **event**: `Event`
+
+The event data for this public page
+
+#### Defined in
+
+[packages/core/src/components/PublicLayout/PublicPageHeader.tsx:55](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/PublicLayout/PublicPageHeader.tsx#L55)
+
+___
+
+### eventCode
+
+• **eventCode**: `string`
+
+The event code for this public page
+
+#### Defined in
+
+[packages/core/src/components/PublicLayout/PublicPageHeader.tsx:57](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/PublicLayout/PublicPageHeader.tsx#L57)
+
+___
+
+### title
+
+• `Optional` **title**: `string`
+
+Optional page title
+
+#### Defined in
+
+[packages/core/src/components/PublicLayout/PublicPageHeader.tsx:59](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/PublicLayout/PublicPageHeader.tsx#L59)
+
+___
+
+### description
+
+• `Optional` **description**: `string`
+
+Optional page description
+
+#### Defined in
+
+[packages/core/src/components/PublicLayout/PublicPageHeader.tsx:61](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/PublicLayout/PublicPageHeader.tsx#L61)
+
+___
+
+### showEventLogo
+
+• `Optional` **showEventLogo**: `boolean`
+
+Whether to show the event logo (default: true)
+
+#### Defined in
+
+[packages/core/src/components/PublicLayout/PublicPageHeader.tsx:63](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/PublicLayout/PublicPageHeader.tsx#L63)
+
+___
+
+### showAppLogo
+
+• `Optional` **showAppLogo**: `boolean`
+
+Whether to show the app logo (default: true)
+
+#### Defined in
+
+[packages/core/src/components/PublicLayout/PublicPageHeader.tsx:65](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/PublicLayout/PublicPageHeader.tsx#L65)
+
+___
+
+### className
+
+• `Optional` **className**: `string`
+
+Custom CSS classes for the header
+
+#### Defined in
+
+[packages/core/src/components/PublicLayout/PublicPageHeader.tsx:67](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/PublicLayout/PublicPageHeader.tsx#L67)
+
+___
+
+### children
+
+• `Optional` **children**: `ReactNode`
+
+Custom content to display in the header
+
+#### Defined in
+
+[packages/core/src/components/PublicLayout/PublicPageHeader.tsx:69](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/PublicLayout/PublicPageHeader.tsx#L69)
+
+___
+
+### customAppLogo
+
+• `Optional` **customAppLogo**: `ReactNode`
+
+Custom app logo component
+
+#### Defined in
+
+[packages/core/src/components/PublicLayout/PublicPageHeader.tsx:71](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/PublicLayout/PublicPageHeader.tsx#L71)
+
+___
+
+### customEventLogo
+
+• `Optional` **customEventLogo**: `ReactNode`
+
+Custom event logo component
+
+#### Defined in
+
+[packages/core/src/components/PublicLayout/PublicPageHeader.tsx:73](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/PublicLayout/PublicPageHeader.tsx#L73)

package/docs/api/interfaces/PublicPageLayoutProps.md

@@ -0,0 +1,138 @@
+[@jmruthers/pace-core - v0.5.1](../README.md) / [Exports](../modules.md) / PublicPageLayoutProps
+
+# Interface: PublicPageLayoutProps
+
+## Table of contents
+
+### Properties
+
+- [eventCode](PublicPageLayoutProps.md#eventcode)
+- [children](PublicPageLayoutProps.md#children)
+- [event](PublicPageLayoutProps.md#event)
+- [showFooter](PublicPageLayoutProps.md#showfooter)
+- [className](PublicPageLayoutProps.md#classname)
+- [errorFallback](PublicPageLayoutProps.md#errorfallback)
+- [loadingFallback](PublicPageLayoutProps.md#loadingfallback)
+- [customHeader](PublicPageLayoutProps.md#customheader)
+- [customFooter](PublicPageLayoutProps.md#customfooter)
+- [showValidationErrors](PublicPageLayoutProps.md#showvalidationerrors)
+
+## Properties
+
+### eventCode
+
+• **eventCode**: `string`
+
+The event code for this public page
+
+#### Defined in
+
+[packages/core/src/components/PublicLayout/PublicPageLayout.tsx:71](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/PublicLayout/PublicPageLayout.tsx#L71)
+
+___
+
+### children
+
+• **children**: `ReactNode`
+
+Child components to render
+
+#### Defined in
+
+[packages/core/src/components/PublicLayout/PublicPageLayout.tsx:73](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/PublicLayout/PublicPageLayout.tsx#L73)
+
+___
+
+### event
+
+• `Optional` **event**: ``null`` \| `Event`
+
+Optional event data - if not provided, will be fetched by parent component
+
+#### Defined in
+
+[packages/core/src/components/PublicLayout/PublicPageLayout.tsx:75](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/PublicLayout/PublicPageLayout.tsx#L75)
+
+___
+
+### showFooter
+
+• `Optional` **showFooter**: `boolean`
+
+Whether to show the footer (default: true)
+
+#### Defined in
+
+[packages/core/src/components/PublicLayout/PublicPageLayout.tsx:77](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/PublicLayout/PublicPageLayout.tsx#L77)
+
+___
+
+### className
+
+• `Optional` **className**: `string`
+
+Custom CSS classes for the layout
+
+#### Defined in
+
+[packages/core/src/components/PublicLayout/PublicPageLayout.tsx:79](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/PublicLayout/PublicPageLayout.tsx#L79)
+
+___
+
+### errorFallback
+
+• `Optional` **errorFallback**: `ComponentType`\<\{ `error`: `Error` ; `retry`: () => `void`  }\>
+
+Custom error fallback component
+
+#### Defined in
+
+[packages/core/src/components/PublicLayout/PublicPageLayout.tsx:81](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/PublicLayout/PublicPageLayout.tsx#L81)
+
+___
+
+### loadingFallback
+
+• `Optional` **loadingFallback**: `ComponentType`\<{}\>
+
+Custom loading fallback component
+
+#### Defined in
+
+[packages/core/src/components/PublicLayout/PublicPageLayout.tsx:83](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/PublicLayout/PublicPageLayout.tsx#L83)
+
+___
+
+### customHeader
+
+• `Optional` **customHeader**: `ReactNode`
+
+Custom header component
+
+#### Defined in
+
+[packages/core/src/components/PublicLayout/PublicPageLayout.tsx:85](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/PublicLayout/PublicPageLayout.tsx#L85)
+
+___
+
+### customFooter
+
+• `Optional` **customFooter**: `ReactNode`
+
+Custom footer component
+
+#### Defined in
+
+[packages/core/src/components/PublicLayout/PublicPageLayout.tsx:87](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/PublicLayout/PublicPageLayout.tsx#L87)
+
+___
+
+### showValidationErrors
+
+• `Optional` **showValidationErrors**: `boolean`
+
+Whether to show event validation errors (default: true)
+
+#### Defined in
+
+[packages/core/src/components/PublicLayout/PublicPageLayout.tsx:89](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/PublicLayout/PublicPageLayout.tsx#L89)

package/docs/api/interfaces/StorageConfig.md

@@ -0,0 +1,41 @@
+[@jmruthers/pace-core - v0.5.1](../README.md) / [Exports](../modules.md) / StorageConfig
+
+# Interface: StorageConfig
+
+## Table of contents
+
+### Properties
+
+- [bucketName](StorageConfig.md#bucketname)
+- [fileSizeLimits](StorageConfig.md#filesizelimits)
+- [defaultFileSizeLimit](StorageConfig.md#defaultfilesizelimit)
+
+## Properties
+
+### bucketName
+
+• **bucketName**: `string`
+
+#### Defined in
+
+[packages/core/src/utils/storage/types.ts:87](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/utils/storage/types.ts#L87)
+
+___
+
+### fileSizeLimits
+
+• **fileSizeLimits**: [`FileSizeLimits`](FileSizeLimits.md)
+
+#### Defined in
+
+[packages/core/src/utils/storage/types.ts:88](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/utils/storage/types.ts#L88)
+
+___
+
+### defaultFileSizeLimit
+
+• **defaultFileSizeLimit**: `number`
+
+#### Defined in
+
+[packages/core/src/utils/storage/types.ts:89](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/utils/storage/types.ts#L89)

package/docs/api/interfaces/StorageFileInfo.md

@@ -0,0 +1,74 @@
+[@jmruthers/pace-core - v0.5.1](../README.md) / [Exports](../modules.md) / StorageFileInfo
+
+# Interface: StorageFileInfo
+
+## Table of contents
+
+### Properties
+
+- [name](StorageFileInfo.md#name)
+- [path](StorageFileInfo.md#path)
+- [size](StorageFileInfo.md#size)
+- [mimeType](StorageFileInfo.md#mimetype)
+- [lastModified](StorageFileInfo.md#lastmodified)
+- [metadata](StorageFileInfo.md#metadata)
+
+## Properties
+
+### name
+
+• **name**: `string`
+
+#### Defined in
+
+[packages/core/src/utils/storage/types.ts:68](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/utils/storage/types.ts#L68)
+
+___
+
+### path
+
+• **path**: `string`
+
+#### Defined in
+
+[packages/core/src/utils/storage/types.ts:69](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/utils/storage/types.ts#L69)
+
+___
+
+### size
+
+• **size**: `number`
+
+#### Defined in
+
+[packages/core/src/utils/storage/types.ts:70](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/utils/storage/types.ts#L70)
+
+___
+
+### mimeType
+
+• **mimeType**: `string`
+
+#### Defined in
+
+[packages/core/src/utils/storage/types.ts:71](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/utils/storage/types.ts#L71)
+
+___
+
+### lastModified
+
+• **lastModified**: `string`
+
+#### Defined in
+
+[packages/core/src/utils/storage/types.ts:72](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/utils/storage/types.ts#L72)
+
+___
+
+### metadata
+
+• **metadata**: [`StorageFileMetadata`](StorageFileMetadata.md)
+
+#### Defined in
+
+[packages/core/src/utils/storage/types.ts:73](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/utils/storage/types.ts#L73)

package/docs/api/interfaces/StorageFileMetadata.md

@@ -0,0 +1,140 @@
+[@jmruthers/pace-core - v0.5.1](../README.md) / [Exports](../modules.md) / StorageFileMetadata
+
+# Interface: StorageFileMetadata
+
+## Table of contents
+
+### Properties
+
+- [mimeType](StorageFileMetadata.md#mimetype)
+- [size](StorageFileMetadata.md#size)
+- [width](StorageFileMetadata.md#width)
+- [height](StorageFileMetadata.md#height)
+- [hash](StorageFileMetadata.md#hash)
+- [orgId](StorageFileMetadata.md#orgid)
+- [appName](StorageFileMetadata.md#appname)
+- [uploadedBy](StorageFileMetadata.md#uploadedby)
+- [uploadedAt](StorageFileMetadata.md#uploadedat)
+- [tags](StorageFileMetadata.md#tags)
+- [isPublic](StorageFileMetadata.md#ispublic)
+- [customMetadata](StorageFileMetadata.md#custommetadata)
+
+## Properties
+
+### mimeType
+
+• **mimeType**: `string`
+
+#### Defined in
+
+[packages/core/src/utils/storage/types.ts:21](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/utils/storage/types.ts#L21)
+
+___
+
+### size
+
+• **size**: `number`
+
+#### Defined in
+
+[packages/core/src/utils/storage/types.ts:22](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/utils/storage/types.ts#L22)
+
+___
+
+### width
+
+• `Optional` **width**: `number`
+
+#### Defined in
+
+[packages/core/src/utils/storage/types.ts:23](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/utils/storage/types.ts#L23)
+
+___
+
+### height
+
+• `Optional` **height**: `number`
+
+#### Defined in
+
+[packages/core/src/utils/storage/types.ts:24](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/utils/storage/types.ts#L24)
+
+___
+
+### hash
+
+• `Optional` **hash**: `string`
+
+#### Defined in
+
+[packages/core/src/utils/storage/types.ts:25](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/utils/storage/types.ts#L25)
+
+___
+
+### orgId
+
+• **orgId**: `string`
+
+#### Defined in
+
+[packages/core/src/utils/storage/types.ts:26](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/utils/storage/types.ts#L26)
+
+___
+
+### appName
+
+• **appName**: `string`
+
+#### Defined in
+
+[packages/core/src/utils/storage/types.ts:27](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/utils/storage/types.ts#L27)
+
+___
+
+### uploadedBy
+
+• **uploadedBy**: `string`
+
+#### Defined in
+
+[packages/core/src/utils/storage/types.ts:28](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/utils/storage/types.ts#L28)
+
+___
+
+### uploadedAt
+
+• **uploadedAt**: `string`
+
+#### Defined in
+
+[packages/core/src/utils/storage/types.ts:29](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/utils/storage/types.ts#L29)
+
+___
+
+### tags
+
+• `Optional` **tags**: `string`[]
+
+#### Defined in
+
+[packages/core/src/utils/storage/types.ts:30](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/utils/storage/types.ts#L30)
+
+___
+
+### isPublic
+
+• **isPublic**: `boolean`
+
+#### Defined in
+
+[packages/core/src/utils/storage/types.ts:31](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/utils/storage/types.ts#L31)
+
+___
+
+### customMetadata
+
+• `Optional` **customMetadata**: `Record`\<`string`, `any`\>
+
+#### Defined in
+
+[packages/core/src/utils/storage/types.ts:32](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/utils/storage/types.ts#L32)

package/docs/api/interfaces/StorageListOptions.md

@@ -0,0 +1,86 @@
+[@jmruthers/pace-core - v0.5.1](../README.md) / [Exports](../modules.md) / StorageListOptions
+
+# Interface: StorageListOptions
+
+## Table of contents
+
+### Properties
+
+- [appName](StorageListOptions.md#appname)
+- [orgId](StorageListOptions.md#orgid)
+- [pathPrefix](StorageListOptions.md#pathprefix)
+- [tags](StorageListOptions.md#tags)
+- [limit](StorageListOptions.md#limit)
+- [offset](StorageListOptions.md#offset)
+
+## Properties
+
+### appName
+
+• **appName**: `string`
+
+The app name from rbac_apps
+
+#### Defined in
+
+[packages/core/src/utils/storage/types.ts:54](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/utils/storage/types.ts#L54)
+
+___
+
+### orgId
+
+• **orgId**: `string`
+
+Organisation ID for scoping
+
+#### Defined in
+
+[packages/core/src/utils/storage/types.ts:56](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/utils/storage/types.ts#L56)
+
+___
+
+### pathPrefix
+
+• `Optional` **pathPrefix**: `string`
+
+Optional path prefix to filter by
+
+#### Defined in
+
+[packages/core/src/utils/storage/types.ts:58](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/utils/storage/types.ts#L58)
+
+___
+
+### tags
+
+• `Optional` **tags**: `string`[]
+
+Optional tags to filter by
+
+#### Defined in
+
+[packages/core/src/utils/storage/types.ts:60](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/utils/storage/types.ts#L60)
+
+___
+
+### limit
+
+• `Optional` **limit**: `number`
+
+Maximum number of files to return
+
+#### Defined in
+
+[packages/core/src/utils/storage/types.ts:62](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/utils/storage/types.ts#L62)
+
+___
+
+### offset
+
+• `Optional` **offset**: `number`
+
+Offset for pagination
+
+#### Defined in
+
+[packages/core/src/utils/storage/types.ts:64](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/utils/storage/types.ts#L64)

package/docs/api/interfaces/StorageListResult.md

@@ -0,0 +1,41 @@
+[@jmruthers/pace-core - v0.5.1](../README.md) / [Exports](../modules.md) / StorageListResult
+
+# Interface: StorageListResult
+
+## Table of contents
+
+### Properties
+
+- [files](StorageListResult.md#files)
+- [totalCount](StorageListResult.md#totalcount)
+- [hasMore](StorageListResult.md#hasmore)
+
+## Properties
+
+### files
+
+• **files**: [`StorageFileInfo`](StorageFileInfo.md)[]
+
+#### Defined in
+
+[packages/core/src/utils/storage/types.ts:77](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/utils/storage/types.ts#L77)
+
+___
+
+### totalCount
+
+• **totalCount**: `number`
+
+#### Defined in
+
+[packages/core/src/utils/storage/types.ts:78](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/utils/storage/types.ts#L78)
+
+___
+
+### hasMore
+
+• **hasMore**: `boolean`
+
+#### Defined in
+
+[packages/core/src/utils/storage/types.ts:79](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/utils/storage/types.ts#L79)