@jmruthers/pace-core 0.6.1 → 0.6.3

package/docs/api/classes/StorageUtils.md

@@ -1,328 +0,0 @@
-[@jmruthers/pace-core - v0.5.192](../README.md) / [Exports](../modules.md) / StorageUtils
-
-# Class: StorageUtils
-
-StorageUtils class for convenient access to storage functions
-
-## Table of contents
-
-### Constructors
-
-- [constructor](StorageUtils.md#constructor)
-
-### Properties
-
-- [generateFilePath](StorageUtils.md#generatefilepath)
-- [generateUniqueFileName](StorageUtils.md#generateuniquefilename)
-- [extractFileMetadata](StorageUtils.md#extractfilemetadata)
-- [uploadFile](StorageUtils.md#uploadfile)
-- [getPublicUrl](StorageUtils.md#getpublicurl)
-- [getSignedUrl](StorageUtils.md#getsignedurl)
-- [deleteFile](StorageUtils.md#deletefile)
-- [downloadFile](StorageUtils.md#downloadfile)
-- [listFiles](StorageUtils.md#listfiles)
-- [archiveFile](StorageUtils.md#archivefile)
-
-## Constructors
-
-### constructor
-
-• **new StorageUtils**(): [`StorageUtils`](StorageUtils.md)
-
-#### Returns
-
-[`StorageUtils`](StorageUtils.md)
-
-## Properties
-
-### generateFilePath
-
-▪ `Static` **generateFilePath**: (`options`: [`StorageUploadOptions`](../interfaces/StorageUploadOptions.md), `fileName`: `string`) => `string` = `generateFilePath`
-
-#### Type declaration
-
-▸ (`options`, `fileName`): `string`
-
-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
-
-| Name | Type |
-| :------ | :------ |
-| `options` | [`StorageUploadOptions`](../interfaces/StorageUploadOptions.md) |
-| `fileName` | `string` |
-
-##### Returns
-
-`string`
-
-#### Defined in
-
-[packages/core/src/utils/storage/index.ts:57](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/utils/storage/index.ts#L57)
-
-___
-
-### generateUniqueFileName
-
-▪ `Static` **generateUniqueFileName**: (`originalName`: `string`) => `string` = `generateUniqueFileName`
-
-#### Type declaration
-
-▸ (`originalName`): `string`
-
-Generate a unique filename with timestamp and UUID
-Sanitizes the original filename to remove spaces and invalid characters for storage compatibility
-
-##### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `originalName` | `string` |
-
-##### Returns
-
-`string`
-
-#### Defined in
-
-[packages/core/src/utils/storage/index.ts:58](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/utils/storage/index.ts#L58)
-
-___
-
-### extractFileMetadata
-
-▪ `Static` **extractFileMetadata**: (`file`: `File`, `options`: [`StorageUploadOptions`](../interfaces/StorageUploadOptions.md), `uploadedBy`: `string`) => `Promise`\<[`StorageFileMetadata`](../interfaces/StorageFileMetadata.md)\> = `extractFileMetadata`
-
-#### Type declaration
-
-▸ (`file`, `options`, `uploadedBy`): `Promise`\<[`StorageFileMetadata`](../interfaces/StorageFileMetadata.md)\>
-
-Extract file metadata from a File object
-
-##### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `file` | `File` |
-| `options` | [`StorageUploadOptions`](../interfaces/StorageUploadOptions.md) |
-| `uploadedBy` | `string` |
-
-##### Returns
-
-`Promise`\<[`StorageFileMetadata`](../interfaces/StorageFileMetadata.md)\>
-
-#### Defined in
-
-[packages/core/src/utils/storage/index.ts:59](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/utils/storage/index.ts#L59)
-
-___
-
-### uploadFile
-
-▪ `Static` **uploadFile**: (`supabase`: `default`\<`any`, ``"public"``, ``"public"``, `any`, `any`\>, `file`: `File`, `options`: [`StorageUploadOptions`](../interfaces/StorageUploadOptions.md)) => `Promise`\<[`StorageUploadResult`](../interfaces/StorageUploadResult.md)\> = `uploadFile`
-
-#### Type declaration
-
-▸ (`supabase`, `file`, `options`): `Promise`\<[`StorageUploadResult`](../interfaces/StorageUploadResult.md)\>
-
-Upload a file to Supabase storage with app segregation
-
-##### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `supabase` | `default`\<`any`, ``"public"``, ``"public"``, `any`, `any`\> |
-| `file` | `File` |
-| `options` | [`StorageUploadOptions`](../interfaces/StorageUploadOptions.md) |
-
-##### Returns
-
-`Promise`\<[`StorageUploadResult`](../interfaces/StorageUploadResult.md)\>
-
-#### Defined in
-
-[packages/core/src/utils/storage/index.ts:60](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/utils/storage/index.ts#L60)
-
-___
-
-### getPublicUrl
-
-▪ `Static` **getPublicUrl**: (`supabase`: `default`\<`any`, ``"public"``, ``"public"``, `any`, `any`\>, `path`: `string`, `isPublic`: `boolean`) => `string` = `getPublicUrl`
-
-#### Type declaration
-
-▸ (`supabase`, `path`, `isPublic?`): `string`
-
-Get a public URL for a file
-
-##### Parameters
-
-| Name | Type | Default value | Description |
-| :------ | :------ | :------ | :------ |
-| `supabase` | `default`\<`any`, ``"public"``, ``"public"``, `any`, `any`\> | `undefined` | Supabase client instance |
-| `path` | `string` | `undefined` | 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
-
-#### Defined in
-
-[packages/core/src/utils/storage/index.ts:61](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/utils/storage/index.ts#L61)
-
-___
-
-### getSignedUrl
-
-▪ `Static` **getSignedUrl**: (`supabase`: `default`\<`any`, ``"public"``, ``"public"``, `any`, `any`\>, `path`: `string`, `options`: [`StorageUrlOptions`](../interfaces/StorageUrlOptions.md)) => `Promise`\<\{ `url`: `string` ; `expiresAt`: `string`  } \| ``null``\> = `getSignedUrl`
-
-#### Type declaration
-
-▸ (`supabase`, `path`, `options`): `Promise`\<\{ `url`: `string` ; `expiresAt`: `string`  } \| ``null``\>
-
-Get a signed URL for a protected file
-Private files are always in the 'files' bucket, so this always uses 'files' bucket
-
-##### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `supabase` | `default`\<`any`, ``"public"``, ``"public"``, `any`, `any`\> | Supabase client instance |
-| `path` | `string` | File path within the bucket |
-| `options` | [`StorageUrlOptions`](../interfaces/StorageUrlOptions.md) | URL options including expiry time |
-
-##### Returns
-
-`Promise`\<\{ `url`: `string` ; `expiresAt`: `string`  } \| ``null``\>
-
-Signed URL with expiration timestamp, or null if failed
-
-#### Defined in
-
-[packages/core/src/utils/storage/index.ts:62](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/utils/storage/index.ts#L62)
-
-___
-
-### deleteFile
-
-▪ `Static` **deleteFile**: (`supabase`: `default`\<`any`, ``"public"``, ``"public"``, `any`, `any`\>, `path`: `string`, `isPublic`: `boolean`) => `Promise`\<\{ `success`: `boolean` ; `error?`: `string`  }\> = `deleteFile`
-
-#### Type declaration
-
-▸ (`supabase`, `path`, `isPublic?`): `Promise`\<\{ `success`: `boolean` ; `error?`: `string`  }\>
-
-Delete a file from storage
-
-##### Parameters
-
-| Name | Type | Default value | Description |
-| :------ | :------ | :------ | :------ |
-| `supabase` | `default`\<`any`, ``"public"``, ``"public"``, `any`, `any`\> | `undefined` | Supabase client instance |
-| `path` | `string` | `undefined` | File path within the bucket |
-| `isPublic` | `boolean` | `false` | Whether the file is in the public-files bucket (default: false) |
-
-##### Returns
-
-`Promise`\<\{ `success`: `boolean` ; `error?`: `string`  }\>
-
-Success status and optional error message
-
-#### Defined in
-
-[packages/core/src/utils/storage/index.ts:63](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/utils/storage/index.ts#L63)
-
-___
-
-### downloadFile
-
-▪ `Static` **downloadFile**: (`supabase`: `default`\<`any`, ``"public"``, ``"public"``, `any`, `any`\>, `path`: `string`, `isPublic`: `boolean`) => `Promise`\<\{ `blob`: `Blob` ; `metadata`: \{ `name`: `string` ; `size`: `number` ; `type`: `string`  }  } \| ``null``\> = `downloadFile`
-
-#### Type declaration
-
-▸ (`supabase`, `path`, `isPublic?`): `Promise`\<\{ `blob`: `Blob` ; `metadata`: \{ `name`: `string` ; `size`: `number` ; `type`: `string`  }  } \| ``null``\>
-
-Download a file from storage
-
-##### Parameters
-
-| Name | Type | Default value | Description |
-| :------ | :------ | :------ | :------ |
-| `supabase` | `default`\<`any`, ``"public"``, ``"public"``, `any`, `any`\> | `undefined` | Supabase client instance |
-| `path` | `string` | `undefined` | File path within the bucket |
-| `isPublic` | `boolean` | `false` | Whether the file is in the public-files bucket (default: false) |
-
-##### Returns
-
-`Promise`\<\{ `blob`: `Blob` ; `metadata`: \{ `name`: `string` ; `size`: `number` ; `type`: `string`  }  } \| ``null``\>
-
-File blob with metadata, or null if failed
-
-#### Defined in
-
-[packages/core/src/utils/storage/index.ts:64](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/utils/storage/index.ts#L64)
-
-___
-
-### listFiles
-
-▪ `Static` **listFiles**: (`supabase`: `default`\<`any`, ``"public"``, ``"public"``, `any`, `any`\>, `options`: [`StorageListOptions`](../interfaces/StorageListOptions.md) & \{ `isPublic?`: `boolean`  }) => `Promise`\<[`StorageListResult`](../interfaces/StorageListResult.md)\> = `listFiles`
-
-#### Type declaration
-
-▸ (`supabase`, `options`): `Promise`\<[`StorageListResult`](../interfaces/StorageListResult.md)\>
-
-List files in an organization scope
-
-##### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `supabase` | `default`\<`any`, ``"public"``, ``"public"``, `any`, `any`\> | Supabase client instance |
-| `options` | [`StorageListOptions`](../interfaces/StorageListOptions.md) & \{ `isPublic?`: `boolean`  } | List options including bucket selection via isPublic |
-
-##### Returns
-
-`Promise`\<[`StorageListResult`](../interfaces/StorageListResult.md)\>
-
-List of files with metadata
-
-#### Defined in
-
-[packages/core/src/utils/storage/index.ts:65](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/utils/storage/index.ts#L65)
-
-___
-
-### archiveFile
-
-▪ `Static` **archiveFile**: (`supabase`: `default`\<`any`, ``"public"``, ``"public"``, `any`, `any`\>, `path`: `string`, `options`: \{ `appName`: `string` ; `orgId?`: `string` ; `userId?`: `string` ; `isPublic?`: `boolean`  }) => `Promise`\<\{ `success`: `boolean` ; `error?`: `string`  }\> = `archiveFile`
-
-#### Type declaration
-
-▸ (`supabase`, `path`, `options`): `Promise`\<\{ `success`: `boolean` ; `error?`: `string`  }\>
-
-Move a file to archived location (soft delete)
-
-##### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `supabase` | `default`\<`any`, ``"public"``, ``"public"``, `any`, `any`\> | Supabase client instance |
-| `path` | `string` | File path within the bucket |
-| `options` | `Object` | Archive options including bucket selection via isPublic |
-| `options.appName` | `string` | - |
-| `options.orgId?` | `string` | - |
-| `options.userId?` | `string` | - |
-| `options.isPublic?` | `boolean` | - |
-
-##### Returns
-
-`Promise`\<\{ `success`: `boolean` ; `error?`: `string`  }\>
-
-#### Defined in
-
-[packages/core/src/utils/storage/index.ts:66](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/utils/storage/index.ts#L66)

package/docs/api/enums/FileCategory.md

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

package/docs/api/enums/LogLevel.md

@@ -1,54 +0,0 @@
-[@jmruthers/pace-core - v0.5.192](../README.md) / [Exports](../modules.md) / LogLevel
-
-# Enumeration: LogLevel
-
-Logger levels for different types of messages
-
-## Table of contents
-
-### Enumeration Members
-
-- [DEBUG](LogLevel.md#debug)
-- [INFO](LogLevel.md#info)
-- [WARN](LogLevel.md#warn)
-- [ERROR](LogLevel.md#error)
-
-## Enumeration Members
-
-### DEBUG
-
-• **DEBUG** = ``0``
-
-#### Defined in
-
-[packages/core/src/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
-
-[packages/core/src/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
-
-[packages/core/src/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
-
-[packages/core/src/utils/core/logger.ts:15](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/utils/core/logger.ts#L15)