filebackbone.com

FileBackboneApiError
FileBackboneClient ▸
- Static members
- .put_presigned_object
- .get_presigned_url

Need help reading this?

FileBackboneApiError

Error wrapper for non-2xx FileBackbone API responses.

new FileBackboneApiError(message: any, detail: any)

Extends Error

Parameters

message (any)

detail (any)

FileBackboneClient

HTTP client for FileBackbone JSON API (Authorization: Bearer <public_id>.<secret>). Node: uses undici with long timeouts (FBB_FETCH_TIMEOUT_MS, default 10 minutes). Browser: pass fetchImpl: window.fetch.bind(window) (no dispatcher / undici). Auth modes:

API token: set token (Bearer header added)
Session + CSRF: omit token, set csrfToken for mutating requests

new FileBackboneClient($0: Object)

Parameters

$0 (Object)

Name	Description
$0.baseUrl `any`
$0.token `any`
$0.csrfToken `any`
$0.fetchImpl `any`
$0.dispatcher `any`

Static Members

▸ put_presigned_object(opts)

PUT body to a presigned object URL (no FileBackbone auth header).

put_presigned_object(opts: any)

Parameters

opts (any)

▸ get_presigned_url(url, opt)

GET a presigned URL (e.g. download).

get_presigned_url(url: string, opt: any): Promise<Response>

Parameters

url (string)

opt

(any
            = {})

Returns

Promise<Response>:

Instance Members

▸ _resolve_fetch_and_dispatcher()

_resolve_fetch_and_dispatcher()

▸ request(method, pathname, opts)

request(method: string, pathname: string, opts: any)

Parameters

method (string)

pathname (string) absolute path starting with /

opts

(any
            = {})

▸ presign_blob_upload(body)

Request a presigned URL for uploading raw blob bytes. Use this when you already have file content and want to upload first, then commit later.

presign_blob_upload(body: any)

Parameters

body (any)

▸ blob_head(query)

Check whether a blob object id already exists in storage. Use this to skip uploads for content that is already present.

blob_head(query: any)

Parameters

query (any)

▸ create_credential(body)

Create an API credential from a browser-authenticated session. Use in internal admin flows where a signed-in user manages service credentials.

create_credential(body: any)

Parameters

body (any)

▸ create_repo(body)

Create a repository in a workspace. Use this for app UI flows that need a single API-based repo bootstrap path.

create_repo(body: any)

Parameters

body (any)

▸ list_branches(repo_id)

List branches for a repository. Use this to populate branch selectors and branch-aware UI flows.

list_branches(repo_id: any)

Parameters

repo_id (any)

▸ create_branch(repo_id, body)

Create a new branch from an existing branch/head. Use this before experimental edits or parallel work streams.

create_branch(repo_id: any, body: any)

Parameters

repo_id (any)

body (any)

▸ merge_branches(repo_id, body)

Merge one branch into another. Use this for normal integration; endpoint fast-forwards when possible.

merge_branches(repo_id: number, body: Object)

Parameters

repo_id (number)

body (Object)

Name	Description
body.into_branch `string`	Branch receiving the merge.
body.from_branch `string`	Branch being merged in.
body.expected_into_head `(string \| null)`	CAS guard: current into-branch head oid (or '' for empty).

▸ merge_branches_resolve(repo_id, body)

Resolve merge conflicts returned by merge_branches. Use this after a conflict response to submit per-path resolutions. Why: conflict paths must be resolved explicitly and atomically so the final merge commit is deterministic.

merge_branches_resolve(repo_id: number, body: Object)

Parameters

repo_id (number)

body (Object)

Name	Description
body.into_branch `string`	Branch receiving the merge.
body.from_branch `string`	Branch being merged in.
body.expected_into_head `(string \| null)`	CAS guard: current into-branch head oid.
body.resolutions `Object<string, ("ours" \| "theirs" \| {text: string})>`	Exact conflict-path map from merge conflict response. Keys are repo-relative conflict paths; each value is either: `'ours'` to keep into-branch content `'theirs'` to keep from-branch content `{ text: '...' }` to provide custom merged content

▸ list_commits(repo_id, query)

List commit history for a repo/branch. Use this for timeline views, audit trails, and debugging change lineage.

list_commits(repo_id: any, query: any)

Parameters

repo_id (any)

query (any)

▸ get_tree(repo_id, query)

Read a tree snapshot at a branch/commit/path. Use this to browse directories and files without downloading raw file bytes.

get_tree(repo_id: any, query: any)

Parameters

repo_id (any)

query (any)

▸ presign_file_upload(repo_id, body)

Request a presigned URL for uploading file content intended for a repo. Use this when ingesting large files through object-store direct upload.

presign_file_upload(repo_id: any, body: any)

Parameters

repo_id (any)

body (any)

▸ commit_file_upload(repo_id, body)

Commit a previously uploaded file into repo history. Use this after presign_file_upload + object PUT to finalize the change on a branch.

commit_file_upload(repo_id: any, body: any)

Parameters

repo_id (any)

body (any)

▸ create_directory(repo_id, body)

Create a directory entry in repo history. Use this for explicit folder scaffolding in branch workflows.

create_directory(repo_id: any, body: any)

Parameters

repo_id (any)

body (any)

▸ fs_delete(repo_id, body)

Delete a file or directory path and commit that change. Use this for controlled removals with full history retention.

fs_delete(repo_id: any, body: any)

Parameters

repo_id (any)

body (any)

▸ fs_move(repo_id, body)

Move or rename a file/directory path and commit the update. Use this for refactors or reorganizing project structures.

fs_move(repo_id: any, body: any)

Parameters

repo_id (any)

body (any)

▸ fs_symlink(repo_id, body)

Create a symlink entry in repo history. Use this when your workflow needs link semantics instead of copied content.

fs_symlink(repo_id: any, body: any)

Parameters

repo_id (any)

body (any)

▸ presign_file_download(repo_id, query)

Request a presigned URL to download a committed file. Use this for secure direct object-store downloads from app backends/clients.

presign_file_download(repo_id: any, query: any)

Parameters

repo_id (any)

query (any)

▸ get_file_raw(repo_id, query)

Retrieve raw file bytes through the API endpoint. Use this for small/inline reads when presigned download is unnecessary.

get_file_raw(repo_id: any, query: any)

Parameters

repo_id (any)

query (any)

▸ put_file_text(repo_id, body)

Write text content directly to a path and commit. Use this for editor-like text updates without presign upload steps.

put_file_text(repo_id: any, body: any)

Parameters

repo_id (any)

body (any)

▸ create_staging(repo_id, body)

Create a staging workspace for batched changes. Use this when a user is making multiple related edits and you do not want partial state on the branch. Why: you can keep draft changes isolated, review/validate them together, and commit atomically once they are coherent. This reduces half-applied updates, lowers merge/conflict noise, and gives UI flows a safer "draft then publish" model.

create_staging(repo_id: any, body: any)

Parameters

repo_id (any)

body (any)

▸ get_staging(repo_id, staging_id)

Read staged entries for a staging workspace. Use this to display draft changes before commit.

get_staging(repo_id: any, staging_id: any)

Parameters

repo_id (any)

staging_id (any)

▸ put_staging(repo_id, staging_id, body)

Add or update staged changes in a staging workspace. Use this repeatedly as users edit multiple files in a draft session.

put_staging(repo_id: any, staging_id: any, body: any)

Parameters

repo_id (any)

staging_id (any)

body (any)

▸ delete_staging(repo_id, staging_id)

Delete a staging workspace and discard draft edits. Use this when a draft is abandoned or reset.

delete_staging(repo_id: any, staging_id: any)

Parameters

repo_id (any)

staging_id (any)

▸ commit_staging(repo_id, staging_id, body)

Commit all staged changes to repo history in one operation. Use this to apply multi-file edits atomically with head checks.

commit_staging(repo_id: any, staging_id: any, body: any)

Parameters

repo_id (any)

staging_id (any)

body (any)