Skip to main content

bucketHelper

Workspace API


Workspace API / helpers/bucketHelper

helpers/bucketHelper

Functions

createBucketForOrganization()

createBucketForOrganization(organizationId, log): Promise<{ success: boolean; bucketName?: string; error?: string; }>

Defined in: helpers/bucketHelper.ts:13

Create a DigitalOcean Spaces bucket for a new organization This is a wrapper function that handles errors and logging

Parameters

organizationId

string

log

Logger = logger

Returns

Promise<{ success: boolean; bucketName?: string; error?: string; }>


deleteBucketForOrganization()

deleteBucketForOrganization(organizationId, log, deleteObjects): Promise<{ success: boolean; error?: string; }>

Defined in: helpers/bucketHelper.ts:50

Delete a DigitalOcean Spaces bucket when an organization is deleted This is a wrapper function that handles errors and logging

Parameters

organizationId

string

log

Logger = logger

deleteObjects

boolean = true

Returns

Promise<{ success: boolean; error?: string; }>


validateBucketName()

validateBucketName(organizationId): boolean

Defined in: helpers/bucketHelper.ts:92

Validate bucket name format

Parameters

organizationId

string

Returns

boolean


getBucketName()

getBucketName(organizationId): string

Defined in: helpers/bucketHelper.ts:101

Get bucket name for an organization

Parameters

organizationId

string

Returns

string


isBucketOperationsEnabled()

isBucketOperationsEnabled(): boolean

Defined in: helpers/bucketHelper.ts:111

Check if bucket operations are enabled

Returns

boolean


handleBucketCreation()

handleBucketCreation(organizationId, log): Promise<void>

Defined in: helpers/bucketHelper.ts:120

Handle bucket creation If bucket creation fails, throw an error to fail the organization creation

Parameters

organizationId

string

log

Logger = logger

Returns

Promise<void>


handleBucketDeletion()

handleBucketDeletion(organizationId, log): Promise<void>

Defined in: helpers/bucketHelper.ts:156

Handle bucket deletion with fallback If bucket deletion fails, log the error but don't fail the organization deletion

Parameters

organizationId

string

log

Logger = logger

Returns

Promise<void>