Get the file folder tree

import { createSiteClient } from '@fetchski/attract-cms-sdk';

const site = createSiteClient();
const folderTree = await site.fileFolders().getFileFolderTree();

{
  "results": [
    {
      "_id": "clx8m2k4p0000a1b2c3d4e5f6",
      "title": "Example title",
      "folderPath": "Example folder path",
      "level": 1,
      "parentId": "clx8m2k4p0000a1b2c3d4e5f6",
      "linkedAlbumId": "clx8m2k4p0000a1b2c3d4e5f6",
      "linkedFeedId": "clx8m2k4p0000a1b2c3d4e5f6",
      "referenceOnly": true,
      "reference": true,
      "count": 1,
      "children": []
    }
  ]
}

import { createSiteClient } from '@fetchski/attract-cms-sdk';

const site = createSiteClient();
const folderTree = await site.fileFolders().getFileFolderTree();

{
  "results": [
    {
      "_id": "clx8m2k4p0000a1b2c3d4e5f6",
      "title": "Example title",
      "folderPath": "Example folder path",
      "level": 1,
      "parentId": "clx8m2k4p0000a1b2c3d4e5f6",
      "linkedAlbumId": "clx8m2k4p0000a1b2c3d4e5f6",
      "linkedFeedId": "clx8m2k4p0000a1b2c3d4e5f6",
      "referenceOnly": true,
      "reference": true,
      "count": 1,
      "children": []
    }
  ]
}

In your app

A function makes the call on the client it is given, so your code passes the real one and a test passes a fake.

Add the function

src/attract/get-file-folder-tree.ts

import type { SiteClient } from '@fetchski/attract-cms-sdk';

export async function getFileFolderTree(site: SiteClient) {
  return site.fileFolders().getFileFolderTree();
}

Call it

A script makes the client once and calls the function:

scripts/get-file-folder-tree.ts

import { createSiteClient } from '@fetchski/attract-cms-sdk';
import { getFileFolderTree } from '../src/attract/get-file-folder-tree.ts';

const site = createSiteClient();
console.log(await getFileFolderTree(site));

Terminal

node --env-file=.env scripts/get-file-folder-tree.ts

A route handler, a job or a queue worker calls it the same way.

For someone who may edit the file library (and the management key); everyone else gets 404.

Parameters

None: call it with no arguments.

Returns

A FolderTree. The folder tree: the root folders by title, each with its subfolders. Read its properties (folderTree.results): each says whether the site always sends it. The example answer is the site’s wire JSON: one key differs from the property names (_id → id).

readonly FolderTreeNode[]

Always sent. A list of FolderTreeNode.

Show FolderTreeNode

A folder, with its subfolders. Every field is always sent.

string

Always sent. The folder’s aposDocId.

string

Always sent.

string

Always sent. Its path, e.g. events/summer.

number

Always sent. Its depth: 0 at the root.

string | null

Always sent, can be null. Its parent folder’s _id; null at the root.

string | null

Always sent, can be null. The photo album it belongs to, if it is an album’s folder.

string | null

Always sent, can be null. The photo feed it belongs to, if it is a feed’s folder.

boolean

Always sent. Flagged as a reference folder itself (its files are never offered for use).

boolean

Always sent. Inside a reference tree (itself included).

number

Always sent. Files directly in it (not in its subfolders).

readonly FolderTreeNode[]

Always sent. A list of FolderTreeNode. Its fields are listed under the first FolderTreeNode above.

Errors

Nothing to catch: the SDK retries what is safe, and throws the rest as the classes below; catch only what you want to react to (see Errors and testing).

400

The site refused what was sent: errors lists each field’s problem, siteMessage the first.Retried first: No. Read: errors (field → messages), siteMessage.

401

The API key is missing or refused (malformed, revoked, expired), or a signature its signing mode needs is missing or stale.Retried first: No. Read: siteMessage, errorName, data.

403

The key may not do this: a scope it lacks, or an address outside its allowlist. siteMessage names it.Retried first: No. Read: siteMessage, errorName, data.

404

Nothing matches, or the caller may not see it.Retried first: No. Read: siteMessage, errorName, data.

500

The site failed. Its logs say why.Retried first: No (only a 502, 503 or 504 is retried). Read: siteMessage, errorName, data.

no answer

No answer: DNS, a refused connection, TLS, or the timeout (15 s per attempt by default).Retried first: Yes, after 0.5 s then 1 s. Read: reason, neverConnected.

not sent

The client refused to send it (e.g. a path segment of ..); the site never saw it.Retried first: No. Read: reason (what to change).

any other

Any other status, or a success whose JSON doesn’t match this SDK version’s types (update the SDK).Retried first: No. Read: reason, status.

setup

sites.forSite('acme') named a slug your sites (createSiteClients()) don’t have.Retried first: No: nothing was sent. Read: message, slug.

setup

The client’s settings are wrong: no FETCHSKI_ATTRACT_URL (or baseUrl), or a malformed API key.Retried first: No: nothing was sent. Read: message (what to fix).

Behavior

Access: an API key with content:files:write (or a master above it: content:files:all, content:all, admin:all). A signed-in person may call it as far as their own permissions allow; anyone else gets 404.
Rate limit: the key’s own reads-per-minute limit, set when the key is created (default 600); over it, 429 with Retry-After. The client waits and retries for you; you see RateLimited only if that runs out.
Retries: a read is safe to repeat: the client retries it on no answer, a 502/503/504 and a 429.
Timeout: 15 s per attempt by default; raise timeout (milliseconds) on the client for longer.

Test it

It calls the function above with a fake client: the fake answers every call with a valid example, so nothing leaves your machine and no settings or key are needed. Run it with node --test.

tests/fileFolders-getFileFolderTree.test.ts

import { test } from 'node:test';
import { fakeSite } from '@fetchski/attract-cms-sdk/testing';
import { getFileFolderTree } from '../src/attract/get-file-folder-tree.ts';

test('fileFolders.getFileFolderTree', async () => {
  const site = fakeSite();
  await getFileFolderTree(site);
  site.assertCalled('fileFolders.getFileFolderTree');
});

List file folders

site.fileFolders().listFileFolders()

Create a file folder

site.fileFolders().createFileFolder()

Get a file folder

site.fileFolders().getFileFolder()

Replace a file folder

site.fileFolders().replaceFileFolder()

Delete a file folder

site.fileFolders().deleteFileFolder()

Update a file folder

site.fileFolders().updateFileFolder()

GET /file-folder/tree

The endpoint this calls, in the API reference: the HTTP request and answer, and every rule the site checks.

import { createSiteClient } from '@fetchski/attract-cms-sdk';

const site = createSiteClient();
const folderTree = await site.fileFolders().getFileFolderTree();

{
  "results": [
    {
      "_id": "clx8m2k4p0000a1b2c3d4e5f6",
      "title": "Example title",
      "folderPath": "Example folder path",
      "level": 1,
      "parentId": "clx8m2k4p0000a1b2c3d4e5f6",
      "linkedAlbumId": "clx8m2k4p0000a1b2c3d4e5f6",
      "linkedFeedId": "clx8m2k4p0000a1b2c3d4e5f6",
      "referenceOnly": true,
      "reference": true,
      "count": 1,
      "children": []
    }
  ]
}

Get started

Using the SDK

Going further

Pages & Site

Content

Media

Forms

Ads & Conversions

Analytics

In your app

Behavior

Test it

List file folders

Create a file folder

Get a file folder

Replace a file folder

Delete a file folder

Update a file folder

GET /file-folder/tree

In your app

Behavior

Test it

Related

List file folders

Create a file folder

Get a file folder

Replace a file folder

Delete a file folder

Update a file folder

GET /file-folder/tree