@jmruthers/pace-core 0.6.11 → 0.6.12

package/docs/api/classes/StorageUtils.md

@@ -0,0 +1,324 @@
+[**@jmruthers/pace-core v0.6.12**](../README.md)
+
+***
+
+[@jmruthers/pace-core](../globals.md) / StorageUtils
+
+# Class: StorageUtils
+
+Defined in: [utils/storage/storageUtils.ts:21](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/utils/storage/storageUtils.ts#L21)
+
+StorageUtils class for convenient access to storage functions
+
+## Constructors
+
+### Constructor
+
+> **new StorageUtils**(): `StorageUtils`
+
+#### Returns
+
+`StorageUtils`
+
+## Properties
+
+### generateFilePath()
+
+> `static` **generateFilePath**: (`options`, `fileName`) => `string`
+
+Defined in: [utils/storage/storageUtils.ts:22](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/utils/storage/storageUtils.ts#L22)
+
+Generate a file path based on organization-first or user-first structure
+- If orgId is provided: {orgId}/{folder}/filename
+- If userId is provided (and orgId is not): users/{userId}/{folder}/filename
+
+#### Parameters
+
+##### options
+
+[`StorageUploadOptions`](../interfaces/StorageUploadOptions.md)
+
+##### fileName
+
+`string`
+
+#### Returns
+
+`string`
+
+***
+
+### generateUniqueFileName()
+
+> `static` **generateUniqueFileName**: (`originalName`) => `string`
+
+Defined in: [utils/storage/storageUtils.ts:23](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/utils/storage/storageUtils.ts#L23)
+
+Generate a unique filename with timestamp and UUID
+Sanitizes the original filename to remove spaces and invalid characters for storage compatibility
+
+#### Parameters
+
+##### originalName
+
+`string`
+
+#### Returns
+
+`string`
+
+***
+
+### extractFileMetadata()
+
+> `static` **extractFileMetadata**: (`file`, `options`, `uploadedBy`) => `Promise`\<[`ApiResult`](../type-aliases/ApiResult.md)\<[`StorageFileMetadata`](../interfaces/StorageFileMetadata.md)\>\>
+
+Defined in: [utils/storage/storageUtils.ts:24](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/utils/storage/storageUtils.ts#L24)
+
+Extract file metadata from a File object.
+
+#### Parameters
+
+##### file
+
+`File`
+
+##### options
+
+[`StorageUploadOptions`](../interfaces/StorageUploadOptions.md)
+
+##### uploadedBy
+
+`string`
+
+#### Returns
+
+`Promise`\<[`ApiResult`](../type-aliases/ApiResult.md)\<[`StorageFileMetadata`](../interfaces/StorageFileMetadata.md)\>\>
+
+ApiResult with metadata on success; optional dimensions/hash are best-effort.
+
+***
+
+### uploadFile()
+
+> `static` **uploadFile**: (`supabase`, `file`, `options`) => `Promise`\<[`ApiResult`](../type-aliases/ApiResult.md)\<[`StorageUploadSuccess`](../interfaces/StorageUploadSuccess.md)\>\>
+
+Defined in: [utils/storage/storageUtils.ts:25](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/utils/storage/storageUtils.ts#L25)
+
+Upload a file to Supabase storage with app segregation.
+Returns ApiResult with path, optional publicUrl and metadata on success.
+
+#### Parameters
+
+##### supabase
+
+`SupabaseClient`
+
+##### file
+
+`File`
+
+##### options
+
+[`StorageUploadOptions`](../interfaces/StorageUploadOptions.md)
+
+#### Returns
+
+`Promise`\<[`ApiResult`](../type-aliases/ApiResult.md)\<[`StorageUploadSuccess`](../interfaces/StorageUploadSuccess.md)\>\>
+
+***
+
+### getPublicUrl()
+
+> `static` **getPublicUrl**: (`supabase`, `path`, `isPublic`) => `string`
+
+Defined in: [utils/storage/storageUtils.ts:26](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/utils/storage/storageUtils.ts#L26)
+
+Get a public URL for a file
+
+#### Parameters
+
+##### supabase
+
+`SupabaseClient`
+
+Supabase client instance
+
+##### path
+
+`string`
+
+File path within the bucket
+
+##### isPublic?
+
+`boolean` = `true`
+
+Whether the file is in the public-files bucket (default: true)
+
+#### Returns
+
+`string`
+
+Public URL for the file
+
+***
+
+### getSignedUrl()
+
+> `static` **getSignedUrl**: (`supabase`, `path`, `options`) => `Promise`\<[`ApiResult`](../type-aliases/ApiResult.md)\<\{ `url`: `string`; `expiresAt`: `string`; \}\>\>
+
+Defined in: [utils/storage/storageUtils.ts:27](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/utils/storage/storageUtils.ts#L27)
+
+Get a signed URL for a protected file.
+Private files are always in the 'files' bucket.
+
+#### Parameters
+
+##### supabase
+
+`SupabaseClient`
+
+##### path
+
+`string`
+
+##### options
+
+[`StorageUrlOptions`](../interfaces/StorageUrlOptions.md)
+
+#### Returns
+
+`Promise`\<[`ApiResult`](../type-aliases/ApiResult.md)\<\{ `url`: `string`; `expiresAt`: `string`; \}\>\>
+
+ApiResult with url and expiresAt on success.
+
+***
+
+### deleteFile()
+
+> `static` **deleteFile**: (`supabase`, `path`, `isPublic`) => `Promise`\<[`ApiResult`](../type-aliases/ApiResult.md)\<`void`\>\>
+
+Defined in: [utils/storage/storageUtils.ts:28](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/utils/storage/storageUtils.ts#L28)
+
+Delete a file from storage.
+
+#### Parameters
+
+##### supabase
+
+`SupabaseClient`
+
+##### path
+
+`string`
+
+##### isPublic?
+
+`boolean` = `false`
+
+#### Returns
+
+`Promise`\<[`ApiResult`](../type-aliases/ApiResult.md)\<`void`\>\>
+
+ApiResult<void> on success.
+
+***
+
+### downloadFile()
+
+> `static` **downloadFile**: (`supabase`, `path`, `isPublic`) => `Promise`\<[`ApiResult`](../type-aliases/ApiResult.md)\<\{ `blob`: `Blob`; `metadata`: \{ `name`: `string`; `size`: `number`; `type`: `string`; \}; \}\>\>
+
+Defined in: [utils/storage/storageUtils.ts:29](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/utils/storage/storageUtils.ts#L29)
+
+Download a file from storage.
+
+#### Parameters
+
+##### supabase
+
+`SupabaseClient`
+
+##### path
+
+`string`
+
+##### isPublic?
+
+`boolean` = `false`
+
+#### Returns
+
+`Promise`\<[`ApiResult`](../type-aliases/ApiResult.md)\<\{ `blob`: `Blob`; `metadata`: \{ `name`: `string`; `size`: `number`; `type`: `string`; \}; \}\>\>
+
+ApiResult with blob and metadata on success.
+
+***
+
+### listFiles()
+
+> `static` **listFiles**: (`supabase`, `options`) => `Promise`\<[`ApiResult`](../type-aliases/ApiResult.md)\<[`StorageListResult`](../interfaces/StorageListResult.md)\>\>
+
+Defined in: [utils/storage/storageUtils.ts:30](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/utils/storage/storageUtils.ts#L30)
+
+List files in an organization scope.
+
+#### Parameters
+
+##### supabase
+
+`SupabaseClient`
+
+##### options
+
+[`StorageListOptions`](../interfaces/StorageListOptions.md) & `object`
+
+#### Returns
+
+`Promise`\<[`ApiResult`](../type-aliases/ApiResult.md)\<[`StorageListResult`](../interfaces/StorageListResult.md)\>\>
+
+ApiResult with files, totalCount, hasMore on success.
+
+***
+
+### archiveFile()
+
+> `static` **archiveFile**: (`supabase`, `path`, `options`) => `Promise`\<[`ApiResult`](../type-aliases/ApiResult.md)\<`void`\>\>
+
+Defined in: [utils/storage/storageUtils.ts:31](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/utils/storage/storageUtils.ts#L31)
+
+Move a file to archived location (soft delete).
+
+#### Parameters
+
+##### supabase
+
+`SupabaseClient`
+
+##### path
+
+`string`
+
+##### options
+
+###### appName
+
+`string`
+
+###### orgId?
+
+`string`
+
+###### userId?
+
+`string`
+
+###### isPublic?
+
+`boolean`
+
+#### Returns
+
+`Promise`\<[`ApiResult`](../type-aliases/ApiResult.md)\<`void`\>\>
+
+ApiResult<void> on success.

package/docs/api/enumerations/FileCategory.md

@@ -0,0 +1,137 @@
+[**@jmruthers/pace-core v0.6.12**](../README.md)
+
+***
+
+[@jmruthers/pace-core](../globals.md) / FileCategory
+
+# Enumeration: FileCategory
+
+Defined in: [types/file-reference.ts:34](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/file-reference.ts#L34)
+
+## Enumeration Members
+
+### PROFILE\_PHOTOS
+
+> **PROFILE\_PHOTOS**: `"profile_photos"`
+
+Defined in: [types/file-reference.ts:35](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/file-reference.ts#L35)
+
+***
+
+### ID\_DOCUMENTS
+
+> **ID\_DOCUMENTS**: `"id_documents"`
+
+Defined in: [types/file-reference.ts:36](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/file-reference.ts#L36)
+
+***
+
+### QUALIFICATIONS
+
+> **QUALIFICATIONS**: `"qualifications"`
+
+Defined in: [types/file-reference.ts:37](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/file-reference.ts#L37)
+
+***
+
+### MEDICAL\_DOCUMENTS
+
+> **MEDICAL\_DOCUMENTS**: `"medical_documents"`
+
+Defined in: [types/file-reference.ts:38](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/file-reference.ts#L38)
+
+***
+
+### DISH\_IMAGES
+
+> **DISH\_IMAGES**: `"dish_images"`
+
+Defined in: [types/file-reference.ts:39](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/file-reference.ts#L39)
+
+***
+
+### EVENT\_LOGOS
+
+> **EVENT\_LOGOS**: `"event_logos"`
+
+Defined in: [types/file-reference.ts:40](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/file-reference.ts#L40)
+
+***
+
+### GENERAL\_DOCUMENTS
+
+> **GENERAL\_DOCUMENTS**: `"general_documents"`
+
+Defined in: [types/file-reference.ts:41](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/file-reference.ts#L41)
+
+***
+
+### IMAGES
+
+> **IMAGES**: `"images"`
+
+Defined in: [types/file-reference.ts:42](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/file-reference.ts#L42)
+
+***
+
+### AUDIO
+
+> **AUDIO**: `"audio"`
+
+Defined in: [types/file-reference.ts:43](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/file-reference.ts#L43)
+
+***
+
+### VIDEO
+
+> **VIDEO**: `"video"`
+
+Defined in: [types/file-reference.ts:44](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/file-reference.ts#L44)
+
+***
+
+### ARCHIVES
+
+> **ARCHIVES**: `"archives"`
+
+Defined in: [types/file-reference.ts:45](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/file-reference.ts#L45)
+
+***
+
+### CAKE\_DISH
+
+> **CAKE\_DISH**: `"cake_dish"`
+
+Defined in: [types/file-reference.ts:47](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/file-reference.ts#L47)
+
+***
+
+### TRAC\_ACCOMMODATION
+
+> **TRAC\_ACCOMMODATION**: `"trac_accommodation"`
+
+Defined in: [types/file-reference.ts:49](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/file-reference.ts#L49)
+
+***
+
+### TRAC\_ACTIVITY
+
+> **TRAC\_ACTIVITY**: `"trac_activity"`
+
+Defined in: [types/file-reference.ts:50](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/file-reference.ts#L50)
+
+***
+
+### TRAC\_JOURNAL
+
+> **TRAC\_JOURNAL**: `"trac_journal"`
+
+Defined in: [types/file-reference.ts:51](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/file-reference.ts#L51)
+
+***
+
+### TRAC\_TRANSPORT
+
+> **TRAC\_TRANSPORT**: `"trac_transport"`
+
+Defined in: [types/file-reference.ts:52](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/file-reference.ts#L52)

package/docs/api/enumerations/LogLevel.md

@@ -0,0 +1,43 @@
+[**@jmruthers/pace-core v0.6.12**](../README.md)
+
+***
+
+[@jmruthers/pace-core](../globals.md) / LogLevel
+
+# Enumeration: LogLevel
+
+Defined in: [utils/core/logger.ts:11](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/utils/core/logger.ts#L11)
+
+Logger levels for different types of messages
+
+## Enumeration Members
+
+### DEBUG
+
+> **DEBUG**: `0`
+
+Defined in: [utils/core/logger.ts:12](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/utils/core/logger.ts#L12)
+
+***
+
+### INFO
+
+> **INFO**: `1`
+
+Defined in: [utils/core/logger.ts:13](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/utils/core/logger.ts#L13)
+
+***
+
+### WARN
+
+> **WARN**: `2`
+
+Defined in: [utils/core/logger.ts:14](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/utils/core/logger.ts#L14)
+
+***
+
+### ERROR
+
+> **ERROR**: `3`
+
+Defined in: [utils/core/logger.ts:15](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/utils/core/logger.ts#L15)

package/docs/api/enumerations/RBACErrorCode.md

@@ -0,0 +1,169 @@
+[**@jmruthers/pace-core v0.6.12**](../README.md)
+
+***
+
+[@jmruthers/pace-core](../globals.md) / RBACErrorCode
+
+# Enumeration: RBACErrorCode
+
+Defined in: [rbac/types/functions.ts:200](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/types/functions.ts#L200)
+
+## Enumeration Members
+
+### USER\_NOT\_FOUND
+
+> **USER\_NOT\_FOUND**: `"USER_NOT_FOUND"`
+
+Defined in: [rbac/types/functions.ts:201](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/types/functions.ts#L201)
+
+***
+
+### INVALID\_ROLE\_TYPE
+
+> **INVALID\_ROLE\_TYPE**: `"INVALID_ROLE_TYPE"`
+
+Defined in: [rbac/types/functions.ts:202](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/types/functions.ts#L202)
+
+***
+
+### INVALID\_ROLE\_NAME
+
+> **INVALID\_ROLE\_NAME**: `"INVALID_ROLE_NAME"`
+
+Defined in: [rbac/types/functions.ts:203](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/types/functions.ts#L203)
+
+***
+
+### MISSING\_ORGANISATION\_ID
+
+> **MISSING\_ORGANISATION\_ID**: `"MISSING_ORGANISATION_ID"`
+
+Defined in: [rbac/types/functions.ts:204](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/types/functions.ts#L204)
+
+***
+
+### MISSING\_EVENT\_APP\_CONTEXT
+
+> **MISSING\_EVENT\_APP\_CONTEXT**: `"MISSING_EVENT_APP_CONTEXT"`
+
+Defined in: [rbac/types/functions.ts:205](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/types/functions.ts#L205)
+
+***
+
+### ORGANISATION\_NOT\_FOUND
+
+> **ORGANISATION\_NOT\_FOUND**: `"ORGANISATION_NOT_FOUND"`
+
+Defined in: [rbac/types/functions.ts:206](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/types/functions.ts#L206)
+
+***
+
+### EVENT\_NOT\_FOUND
+
+> **EVENT\_NOT\_FOUND**: `"EVENT_NOT_FOUND"`
+
+Defined in: [rbac/types/functions.ts:207](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/types/functions.ts#L207)
+
+***
+
+### APP\_NOT\_FOUND
+
+> **APP\_NOT\_FOUND**: `"APP_NOT_FOUND"`
+
+Defined in: [rbac/types/functions.ts:208](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/types/functions.ts#L208)
+
+***
+
+### INVALID\_SESSION\_TYPE
+
+> **INVALID\_SESSION\_TYPE**: `"INVALID_SESSION_TYPE"`
+
+Defined in: [rbac/types/functions.ts:209](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/types/functions.ts#L209)
+
+***
+
+### INVALID\_EVENT\_TYPE
+
+> **INVALID\_EVENT\_TYPE**: `"INVALID_EVENT_TYPE"`
+
+Defined in: [rbac/types/functions.ts:210](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/types/functions.ts#L210)
+
+***
+
+### DATABASE\_ERROR
+
+> **DATABASE\_ERROR**: `"DATABASE_ERROR"`
+
+Defined in: [rbac/types/functions.ts:211](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/types/functions.ts#L211)
+
+***
+
+### ROLE\_NOT\_FOUND
+
+> **ROLE\_NOT\_FOUND**: `"ROLE_NOT_FOUND"`
+
+Defined in: [rbac/types/functions.ts:212](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/types/functions.ts#L212)
+
+***
+
+### USER\_NOT\_AUTHENTICATED
+
+> **USER\_NOT\_AUTHENTICATED**: `"USER_NOT_AUTHENTICATED"`
+
+Defined in: [rbac/types/functions.ts:213](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/types/functions.ts#L213)
+
+***
+
+### INVALID\_GLOBAL\_ROLE
+
+> **INVALID\_GLOBAL\_ROLE**: `"INVALID_GLOBAL_ROLE"`
+
+Defined in: [rbac/types/functions.ts:214](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/types/functions.ts#L214)
+
+***
+
+### INVALID\_ORGANISATION\_ROLE
+
+> **INVALID\_ORGANISATION\_ROLE**: `"INVALID_ORGANISATION_ROLE"`
+
+Defined in: [rbac/types/functions.ts:215](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/types/functions.ts#L215)
+
+***
+
+### INVALID\_EVENT\_APP\_ROLE
+
+> **INVALID\_EVENT\_APP\_ROLE**: `"INVALID_EVENT_APP_ROLE"`
+
+Defined in: [rbac/types/functions.ts:216](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/types/functions.ts#L216)
+
+***
+
+### INVALID\_EVENT\_APP\_FORMAT
+
+> **INVALID\_EVENT\_APP\_FORMAT**: `"INVALID_EVENT_APP_FORMAT"`
+
+Defined in: [rbac/types/functions.ts:217](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/types/functions.ts#L217)
+
+***
+
+### MISSING\_CONTEXT
+
+> **MISSING\_CONTEXT**: `"MISSING_CONTEXT"`
+
+Defined in: [rbac/types/functions.ts:218](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/types/functions.ts#L218)
+
+***
+
+### INVALID\_CONTEXT
+
+> **INVALID\_CONTEXT**: `"INVALID_CONTEXT"`
+
+Defined in: [rbac/types/functions.ts:219](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/types/functions.ts#L219)
+
+***
+
+### GRANTED\_BY\_NOT\_FOUND
+
+> **GRANTED\_BY\_NOT\_FOUND**: `"GRANTED_BY_NOT_FOUND"`
+
+Defined in: [rbac/types/functions.ts:220](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/types/functions.ts#L220)