Skip to main content

projectFolderHelper

Workspace API


Workspace API / helpers/projectFolderHelper

helpers/projectFolderHelper

Functions

createFolderForProject()

createFolderForProject(organizationId, projectId, log): Promise<{ success: boolean; folderPath?: string; error?: string; }>

Defined in: helpers/projectFolderHelper.ts:13

Create a GCS folder for a new project This is a wrapper function that handles errors and logging

Parameters

organizationId

string

projectId

string

log

Logger = logger

Returns

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


deleteFolderForProject()

deleteFolderForProject(organizationId, projectId, log): Promise<{ success: boolean; deletedFiles?: number; error?: string; }>

Defined in: helpers/projectFolderHelper.ts:48

Delete a GCS folder when a project is deleted This is a wrapper function that handles errors and logging

Parameters

organizationId

string

projectId

string

log

Logger = logger

Returns

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


validateProjectId()

validateProjectId(projectId): boolean

Defined in: helpers/projectFolderHelper.ts:99

Validate project ID format

Parameters

projectId

string

Returns

boolean


validateOrganizationId()

validateOrganizationId(organizationId): boolean

Defined in: helpers/projectFolderHelper.ts:108

Validate organization ID format

Parameters

organizationId

string

Returns

boolean


getProjectFolderPath()

getProjectFolderPath(projectId): string

Defined in: helpers/projectFolderHelper.ts:120

Get project folder path Note: Projects are deferred to future feature. Folders are now managed by users through the file management service. Returns empty string as there are no automatic project folders.

Parameters

projectId

string

Returns

string


isFolderOperationsEnabled()

isFolderOperationsEnabled(): boolean

Defined in: helpers/projectFolderHelper.ts:130

Check if folder operations are enabled

Returns

boolean


handleProjectFolderCreation()

handleProjectFolderCreation(organizationId, projectId, log): Promise<void>

Defined in: helpers/projectFolderHelper.ts:139

Handle project folder creation with fallback If folder creation fails, log the error but don't fail the project creation

Parameters

organizationId

string

projectId

string

log

Logger = logger

Returns

Promise<void>


handleProjectFolderDeletion()

handleProjectFolderDeletion(organizationId, projectId, log): Promise<void>

Defined in: helpers/projectFolderHelper.ts:180

Handle project folder deletion with fallback If folder deletion fails, log the error but don't fail the project deletion

Parameters

organizationId

string

projectId

string

log

Logger = logger

Returns

Promise<void>


getProjectFolderDetails()

getProjectFolderDetails(organizationId, projectId, log): Promise<{ exists: boolean; folderPath: string; fileCount: number; totalSize: number; files?: object[]; } | null>

Defined in: helpers/projectFolderHelper.ts:220

Get project folder information

Parameters

organizationId

string

projectId

string

log

Logger = logger

Returns

Promise<{ exists: boolean; folderPath: string; fileCount: number; totalSize: number; files?: object[]; } | null>


listOrganizationProjectFolders()

listOrganizationProjectFolders(organizationId, log): Promise<object[]>

Defined in: helpers/projectFolderHelper.ts:267

List all project folders in an organization

Parameters

organizationId

string

log

Logger = logger

Returns

Promise<object[]>