Module: server

Mostly mirrors functions found in the Server class, but keeps the actual request logic out of that class.

Source: utilities/server_access.js, line 1

Methods

(static) _checkAudioReady(baseUrl, token, projectId) → {Promise.<boolean>}

Checks whether the audio.mp3 for a project is ready for transcription.

Parameters:

Name	Type	Description
`baseUrl`	string	base URL of the server
`token`	string	auth token for the current session
`projectId`	string	the project's unique identifier

Source: utilities/server_access.js, line 449

Returns:

true if audio.mp3 exists and is ready

Type:: Promise.<boolean>

(static) _compressProject(baseUrl, token, projectId) → {Promise.<object>}

Compress a project by deleting the original non-MP3 audio file.

Parameters:

Name	Type	Description
`baseUrl`	string	base URL of the server
`token`	string	auth token for the current session
`projectId`	string	the project's unique identifier

Source: utilities/server_access.js, line 190

Returns:

{ ok, audio_format }

Type:: Promise.<object>

(static) _createFolder(baseUrl, token, parentPath, name) → {Promise.<{name: string, path: string}>}

Creates a new folder on the server.

Parameters:

Name	Type	Description
`baseUrl`	string	base URL of the server
`token`	string	auth token for the current session
`parentPath`	string	path of the parent folder ('' for root)
`name`	string	name of the new folder

Source: utilities/server_access.js, line 367

Returns:

Type:: Promise.<{name: string, path: string}>

(static) _createProject(baseUrl, token, metadata, waveformData, audioFile, transcriptFile, sampleFiles) → {Promise.<object>}

Upload a brand-new project (first push from local).

Parameters:

Name	Type	Description
`baseUrl`	string	base URL of the server
`token`	string	auth token for the current session
`metadata`	object	general project metadata and speakers; no waveform details
`waveformData`	object \| null	{ sampleRate, duration, filename, peaks }
`audioFile`	File	the audio file to upload
`transcriptFile`	File \| null	the transcript CSV file, or null if none
`sampleFiles`	Object.<string, File>	speaker sample files keyed by speaker id

Source: utilities/server_access.js, line 206

Returns:

the newly created project object

Type:: Promise.<object>

(static) _deleteAudio(baseUrl, token, projectId) → {Promise.<void>}

Deletes the audio file for a project.

Parameters:

Name	Type	Description
`baseUrl`	string	base URL of the server
`token`	string	auth token for the current session
`projectId`	string	the project's unique identifier

Source: utilities/server_access.js, line 473

Returns:

Type:: Promise.<void>

(static) _deleteFolder(baseUrl, token, folderPath, merge) → {Promise.<{ok: boolean}>}

Deletes a folder on the server.

Parameters:

Name	Type	Description
`baseUrl`	string	base URL of the server
`token`	string	auth token for the current session
`folderPath`	string	path of the folder to delete
`merge`	boolean	if true, move contents to parent before deleting

Source: utilities/server_access.js, line 401

Returns:

Type:: Promise.<{ok: boolean}>

(static) _deleteProject(baseUrl, token, projectId) → {Promise.<object>}

Permanently delete a project from the server.

Parameters:

Name	Type	Description
`baseUrl`	string	base URL of the server
`token`	string	auth token for the current session
`projectId`	string	the project's unique identifier

Source: utilities/server_access.js, line 166

Returns:

server response object

Type:: Promise.<object>

(static) _deleteTranscript(baseUrl, token, projectId) → {Promise.<void>}

Deletes the transcript for a project.

Parameters:

Name	Type	Description
`baseUrl`	string	base URL of the server
`token`	string	auth token for the current session
`projectId`	string	the project's unique identifier

Source: utilities/server_access.js, line 462

Returns:

Type:: Promise.<void>

(static) _duplicateProject(baseUrl, token, projectId, folderPathopt) → {Promise.<object>}

Duplicate a project on the server and return the new project object.

Parameters:

Name	Type	Attributes	Description
`baseUrl`	string		base URL of the server
`token`	string		auth token for the current session
`projectId`	string		the project's unique identifier
`folderPath`	string	<optional>	destination folder path for the duplicate

Source: utilities/server_access.js, line 150

Returns:

the newly created duplicate project object

Type:: Promise.<object>

(static) _fetch(baseUrl, path, optionsopt, tokenopt) → {Promise.<Response>}

Authenticated fetch wrapper. Attaches the auth token header and throws on non-2xx responses, parsing any JSON error body for the message.

Parameters:

Name	Type	Attributes	Description
`baseUrl`	string		server origin (e.g. "http://localhost:5000")
`path`	string		request path (e.g. "/api/projects")
`options`	object	<optional>	fetch init options (method, body, headers, etc.)
`token`	string	<optional>	optional auth token; added as X-Auth-Token header

Source: utilities/server_access.js, line 62

Returns:

resolved fetch Response

Type:: Promise.<Response>

(static) _getAnnotations(baseUrl, token, projectId) → {Promise.<object>}

Fetch the annotations (hyperlinks, etc.) for a project.

Parameters:

Name	Type	Description
`baseUrl`	string	base URL of the server
`token`	string	auth token for the current session
`projectId`	string	the project's unique identifier

Source: utilities/server_access.js, line 501

Returns:

annotations object with a 'hyperlinks' key

Type:: Promise.<object>

(static) _getCompressInfo(baseUrl, token, projectId) → {Promise.<object>}

Fetch storage size info for a project before/after compression.

Parameters:

Name	Type	Description
`baseUrl`	string	base URL of the server
`token`	string	auth token for the current session
`projectId`	string	the project's unique identifier

Source: utilities/server_access.js, line 178

Returns:

{ can_compress, before_bytes?, after_bytes?, audio_format?, reason? }

Type:: Promise.<object>

(static) _getFolderCount(baseUrl, token, folderPath) → {Promise.<{projects: number, folders: number}>}

Gets the count of projects and subfolders within a folder.

Parameters:

Name	Type	Description
`baseUrl`	string	base URL of the server
`token`	string	auth token for the current session
`folderPath`	string	path of the folder to count

Source: utilities/server_access.js, line 433

Returns:

Type:: Promise.<{projects: number, folders: number}>

(static) _getProject(baseUrl, token, projectId) → {Promise.<object>}

Fetch a single project by id.

Parameters:

Name	Type	Description
`baseUrl`	string	base URL of the server
`token`	string	auth token for the current session
`projectId`	string	the project's unique identifier

Source: utilities/server_access.js, line 137

Returns:

the project metadata object

Type:: Promise.<object>

(static) _getProjectList(baseUrl, token) → {Promise.<Array.<object>>}

Fetch the list of all server-side projects.

Parameters:

Name	Type	Description
`baseUrl`	string	the base url of the server
`token`	string	the access token of the server

Source: utilities/server_access.js, line 103

Returns:

array of project metadata objects

Type:: Promise.<Array.<object>>

(static) _getSharedFolders(baseUrl, token) → {Promise.<Array.<object>>}

Fetch folders shared with the current user.

Parameters:

Name	Type	Description
`baseUrl`	string	Base URL of the server.
`token`	string	Auth token for the current session.

Source: utilities/server_access.js, line 125

Returns:

Array of shared folder metadata objects.

Type:: Promise.<Array.<object>>

(static) _getSharedProjects(baseUrl, token) → {Promise.<Array.<object>>}

Fetch projects shared with the current user.

Parameters:

Name	Type	Description
`baseUrl`	string	Base URL of the server.
`token`	string	Auth token for the current session.

Source: utilities/server_access.js, line 114

Returns:

Array of shared project metadata objects.

Type:: Promise.<Array.<object>>

(static) _getSpeakerSample(baseUrl, token, projectId, speakerId) → {Promise.<ArrayBuffer>}

Fetches a speaker's voice sample as an ArrayBuffer.

Parameters:

Name	Type	Description
`baseUrl`	string	base URL of the server
`token`	string	auth token for the current session
`projectId`	string	the project's unique identifier
`speakerId`	string	the speaker's unique identifier

Source: utilities/server_access.js, line 316

Returns:

raw audio data for the speaker's voice sample

Type:: Promise.<ArrayBuffer>

(static) _getSpeakers(baseUrl, token, projectId) → {Promise.<object>}

Fetches the speakers dictionary for a project.

Parameters:

Name	Type	Description
`baseUrl`	string	base URL of the server
`token`	string	auth token for the current session
`projectId`	string	the project's unique identifier

Source: utilities/server_access.js, line 303

Returns:

dictionary of speaker objects keyed by speaker id

Type:: Promise.<object>

(static) _getTranscript(baseUrl, token, projectId) → {Promise.<{contentType: string, text: string}>}

Fetches the transcript CSV text for a project.

Parameters:

Name	Type	Description
`baseUrl`	string	base URL of the server
`token`	string	auth token for the current session
`projectId`	string	the project's unique identifier

Source: utilities/server_access.js, line 328

Returns:

the content type and raw body text

Type:: Promise.<{contentType: string, text: string}>

(static) _getUserMe(baseUrl, token) → {Promise.<object>}

Fetches the current user's profile from the backend. Used to verify backend access after Firebase sign-in.

Parameters:

Name	Type	Description
`baseUrl`	string	base URL of the server
`token`	string	Firebase ID token

Source: utilities/server_access.js, line 92

Returns:

the user profile object

Type:: Promise.<object>

(static) _getWaveform(baseUrl, token, projectId) → {Promise.<object>}

Fetches the waveform metadata (sampleRate, duration, filename, peaks) for a project.

Parameters:

Name	Type	Description
`baseUrl`	string	base URL of the server
`token`	string	auth token for the current session
`projectId`	string	the project's unique identifier

Source: utilities/server_access.js, line 291

Returns:

waveform metadata object

Type:: Promise.<object>

(static) _listDirectory(baseUrl, token, folderPath) → {Promise.<{folders: Array.<object>, projects: Array.<object>}>}

Lists the immediate contents of a server folder.

Parameters:

Name	Type	Description
`baseUrl`	string	base URL of the server
`token`	string	auth token for the current session
`folderPath`	string	relative folder path ('' for root)

Source: utilities/server_access.js, line 353

Returns:

Type:: Promise.<{folders: Array.<object>, projects: Array.<object>}>

(static) _moveProjectToFolder(baseUrl, token, projectId, targetFolderPath) → {Promise.<object>}

Moves a project to a different folder on the server.

Parameters:

Name	Type	Description
`baseUrl`	string	base URL of the server
`token`	string	auth token for the current session
`projectId`	string	the project's unique identifier
`targetFolderPath`	string	destination folder path ('' for root)

Source: utilities/server_access.js, line 417

Returns:

updated project summary

Type:: Promise.<object>

(static) _renameFolder(baseUrl, token, folderPath, newName) → {Promise.<{name: string, path: string}>}

Renames a folder on the server.

Parameters:

Name	Type	Description
`baseUrl`	string	base URL of the server
`token`	string	auth token for the current session
`folderPath`	string	current path of the folder to rename
`newName`	string	new name for the folder

Source: utilities/server_access.js, line 384

Returns:

Type:: Promise.<{name: string, path: string}>

(static) _retranscribeSegments(baseUrl, token, projectId, segments, modelSizeopt) → {Promise.<{results: Array.<{idx: number, words: Array}>}>}

Retranscribes specific time-range segments and returns updated word-level timestamps.

Parameters:

Name	Type	Attributes	Description
`baseUrl`	string		Base URL of the server
`token`	string		Auth token
`projectId`	string		The project ID
`segments`	Array.<{start: number, end: number, idx: number}>		Segments to retranscribe
`modelSize`	string	<optional>	Whisper model size to use

Source: utilities/server_access.js, line 578

Returns:

Type:: Promise.<{results: Array.<{idx: number, words: Array}>}>

(static) _saveAnnotations(baseUrl, token, projectId, data) → {Promise.<void>}

Save annotations (hyperlinks, etc.) for a project.

Parameters:

Name	Type	Description
`baseUrl`	string	base URL of the server
`token`	string	auth token for the current session
`projectId`	string	the project's unique identifier
`data`	object	annotations object with a 'hyperlinks' key

Source: utilities/server_access.js, line 514

Returns:

Type:: Promise.<void>

(static) _saveWaveform(baseUrl, token, projectId, waveformData) → {Promise.<void>}

Saves waveform metadata (peaks, duration, sampleRate) back to the server.

Parameters:

Name	Type	Description
`baseUrl`	string	base URL of the server
`token`	string	auth token for the current session
`projectId`	string	the project's unique identifier
`waveformData`	Object	Waveform peaks and audio metadata.

Source: utilities/server_access.js, line 485

Returns:

Type:: Promise.<void>

(static) _transcribeProject(baseUrl, token, projectId, options, onEvent, signalopt) → {Promise.<void>}

Starts transcription and streams SSE progress events via a callback. Resolves when the stream closes (after a 'result' or 'error' event). Each event object has a 'type' field: 'status', 'progress', 'result', or 'error'.

Parameters:

Name Type Attributes Description

baseUrl string base URL of the server

token string auth token for the current session

projectId string the project's unique identifier

options

object

transcription options

Properties

Name	Type	Attributes	Description
`modelSize`	string	<optional>	whisper model size (default 'medium')
`speakerCount`	number \| null	<optional>	number of speakers, or null for auto-detect

onEvent function called with each parsed SSE event object

signal AbortSignal <optional> optional abort signal

Source: utilities/server_access.js, line 536

Returns:

Type:: Promise.<void>

(static) _updateProject(baseUrl, token, projectId, id, metadata, speakersData, transcriptFile, sampleFiles) → {Promise.<object>}

Push updated data for an existing server project. Audio is immutable once uploaded — only metadata, speakers, and transcript can be updated.

Parameters:

Name	Type	Description
`baseUrl`	string	base URL of the server
`token`	string	auth token for the current session
`projectId`	string	the project's unique identifier
`id`	string	the project id (included in metadata)
`metadata`	object \| null	{ name, created, modified } (no speakers)
`speakersData`	object \| null	full speakers dict if speakers section is dirty
`transcriptFile`	File \| null	the updated transcript file, or null to leave unchanged
`sampleFiles`	Object.<string, File>	updated speaker sample files keyed by speaker id

Source: utilities/server_access.js, line 252

Returns:

the updated project object

Type:: Promise.<object>

(inner) _encodeFolderPath(folderPath) → {string}

Encode a folder path for use in a URL, preserving slashes between segments.

Parameters:

Name	Type	Description
`folderPath`	string	relative folder path ('' for root)

Source: utilities/server_access.js, line 342

Returns:

URL-encoded path with slashes preserved.

Type:: string

(inner) _xhrRequest(url, method, body, token, onProgress, signalopt) → {Promise.<object>}

XHR-based request with upload progress support. Returns parsed JSON.

Parameters:

Name	Type	Attributes	Description
`url`	string		Full URL to request
`method`	string		HTTP method
`body`	FormData		Request body
`token`	string \| null		Auth token
`onProgress`	function \| null		Called with fraction (0–1) as upload progresses
`signal`	AbortSignal	<optional>	Optional abort signal.

Source: utilities/server_access.js, line 26

Returns:

Type:: Promise.<object>