Strapi Client

https://github.com/strapi/client
Admin
Strapi Client is an official JavaScript/TypeScript SDK that enables seamless integration between...
Tokens:36,777
Snippets:464
Trust Score:9.8
License:MIT
Update:2 months ago
Show doc for...
Tokens:
Raw
### Setup Demo Applications

Source: https://github.com/strapi/client/blob/main/CONTRIBUTING.md

Install dependencies, build, and set up the Strapi app for demo projects from the project's root directory.

```bash
pnpm demo setup
```

--------------------------------

### Setup Strapi App Environment File

Source: https://github.com/strapi/client/blob/main/README.md

Copies the example `.env.example` to `.env` for the main Strapi app if no `.env` file exists. Ensures appropriate environment configuration.

```bash
pnpm demo app:env:setup
```

--------------------------------

### Install Strapi Client with NPM

Source: https://github.com/strapi/client/blob/main/README.md

Install the Strapi client as a project dependency using NPM.

```bash
npm install @strapi/client
```

--------------------------------

### Install Strapi Client with pnpm

Source: https://github.com/strapi/client/blob/main/README.md

Install the Strapi client as a project dependency using pnpm.

```bash
pnpm add @strapi/client
```

--------------------------------

### Install Dependencies for Strapi App and Demos

Source: https://github.com/strapi/client/blob/main/README.md

Downloads and prepares all required packages for the main Strapi app and all demo applications. Ensures all necessary packages are installed.

```bash
pnpm demo install
```

--------------------------------

### Start Strapi App for Demos

Source: https://github.com/strapi/client/blob/main/CONTRIBUTING.md

Start the Strapi application which is used by the demo projects. This command should be run before testing individual demo applications.

```bash
pnpm demo app:start
```

--------------------------------

### Install Strapi Client with Yarn

Source: https://github.com/strapi/client/blob/main/README.md

Install the Strapi client as a project dependency using Yarn.

```bash
yarn add @strapi/client
```

--------------------------------

### Initialize HttpClient

Source: https://github.com/strapi/client/blob/main/_autodocs/5_http-client.md

Example of instantiating the client with a base URL, custom timeout, and headers.

```typescript
import { HttpClient } from '@strapi/client';

const client = new HttpClient({
  baseURL: 'http://localhost:1337/api',
  timeout: 5000,
  headers: { 'X-Custom-Header': 'value' }
});
```

--------------------------------

### Install Project Dependencies with pnpm

Source: https://github.com/strapi/client/blob/main/CONTRIBUTING.md

Install all necessary project dependencies using the pnpm package manager.

```bash
pnpm install
```

--------------------------------

### Instantiate CollectionTypeManager

Source: https://github.com/strapi/client/blob/main/_autodocs/2_collection-manager.md

Example showing how to initialize the manager with options and an HTTP client.

```typescript
import { CollectionTypeManager } from '@strapi/client';

const httpClient = new HttpClient({ baseURL: 'http://localhost:1337/api' });
const articlesManager = new CollectionTypeManager(
  { resource: 'articles' },
  httpClient
);
```

--------------------------------

### Initialize Strapi Client

Source: https://github.com/strapi/client/blob/main/_autodocs/9_configuration.md

Example of initializing the Strapi client with a base URL, authentication token, and custom headers.

```typescript
import { strapi } from '@strapi/client';

const client = strapi({
  baseURL: 'http://localhost:1337/api',
  auth: 'my-api-token-123',
  headers: {
    'X-Custom-Header': 'value',
    'Accept-Language': 'en-US'
  }
});
```

--------------------------------

### Configure Strapi Client Authentication

Source: https://github.com/strapi/client/blob/main/_autodocs/8_authentication.md

Example of initializing the Strapi client with an authentication strategy and options.

```typescript
const config: StrapiClientConfig = {
  baseURL: 'http://localhost:1337/api',
  auth: {
    strategy: 'api-token',
    options: { token: 'your-token-here' }
  }
};

const client = new StrapiClient(config);
```

--------------------------------

### Construct content type paths

Source: https://github.com/strapi/client/blob/main/_autodocs/9_configuration.md

Examples of how paths are generated based on resource, plugin, and custom overrides.

```typescript
// Regular collection
const articles = client.collection('articles');
// Path: /articles

// Single type
const settings = client.single('settings');
// Path: /settings

// Plugin collection (users-permissions)
const users = client.collection('users');
// Path: /users (auto-detected as plugin resource)

// Custom plugin with default prefix
const posts = client.collection('posts', {
  plugin: { name: 'my-plugin' }
});
// Path: /my-plugin/posts

// Custom plugin with no prefix
const pages = client.collection('pages', {
  plugin: { name: 'my-plugin', prefix: '' }
});
// Path: /pages

// Custom path override
const articles = client.collection('articles', {
  path: '/custom/articles/path'
});
// Path: /custom/articles/path
```

--------------------------------

### Files Find Example

Source: https://github.com/strapi/client/blob/main/_autodocs/6_types-and-interfaces.md

Demonstrates using FileQueryParams to filter and sort file results.

```typescript
const images = await client.files.find({
  filters: { mime: { $contains: 'image' } },
  sort: 'name:asc'
});
```

--------------------------------

### Run Development Server in Next.js

Source: https://github.com/strapi/client/blob/main/demo/next-server-components/README.md

Use these commands to start the Next.js development server. Open http://localhost:3000 in your browser to view the application.

```bash
npm run dev
# or
yarn dev
# or
pnpm dev
# or
bun dev
```

--------------------------------

### Example Commit Message

Source: https://github.com/strapi/client/blob/main/CONTRIBUTING.md

An example of a commit message following the Conventional Commits specification.

```text
feat: added a new example feature
```

--------------------------------

### Example: Using Custom Headers for Requests

Source: https://github.com/strapi/client/blob/main/README.md

Demonstrates initializing the client with custom headers and making a request. The specified headers will be automatically included in the 'articles.find()' call.

```typescript
// Initialize client with custom headers
const client = strapi({
  baseURL: 'http://localhost:1337/api',
  headers: {
    'X-Request-ID': '12345',
    'Accept-Language': 'en-US',
  },
});

// Headers will be included in all requests
const articles = await client.collection('articles').find();
```

--------------------------------

### get()

Source: https://github.com/strapi/client/blob/main/_autodocs/5_http-client.md

Sends an HTTP GET request to the specified path.

```APIDOC
## get(path: string, init?: RequestInit)

### Description
Sends an HTTP GET request to the specified path.

### Parameters
#### Path Parameters
- **path** (string) - Required - Relative path appended to baseURL

#### Request Options
- **init** (RequestInit) - Optional - Additional fetch options

### Returns
- **Promise<Response>** - The HTTP response object.

### Throws
- **HTTPError** - For HTTP errors or network failures.
```

--------------------------------

### Collection Find Example

Source: https://github.com/strapi/client/blob/main/_autodocs/6_types-and-interfaces.md

Demonstrates using BaseQueryParams to filter, sort, and paginate collection results.

```typescript
const articles = await client.collection('articles').find({
  filters: { published: true },
  sort: 'createdAt:desc',
  pagination: { page: 1, pageSize: 20 },
  populate: { author: true, comments: true },
  fields: ['title', 'content', 'author'],
  locale: 'en'
});
```

--------------------------------

### Check Node.js Version

Source: https://github.com/strapi/client/blob/main/CONTRIBUTING.md

Use this command to verify your installed Node.js version. Ensure it meets the project's requirements.

```bash
node -v
```

--------------------------------

### Handle StrapiInitializationError

Source: https://github.com/strapi/client/blob/main/_autodocs/7_errors.md

Catch initialization errors to inspect the root cause of client setup failures.

```typescript
try {
  const client = strapi({
    baseURL: 'http://localhost:1337/api',
    auth: 'my-token'
  });
} catch (error) {
  if (error instanceof StrapiInitializationError) {
    console.log('Client initialization failed:', error.message);
    console.log('Root cause:', error.cause);
  }
}
```

--------------------------------

### Use find method for collection queries

Source: https://github.com/strapi/client/blob/main/_autodocs/2_collection-manager.md

Examples of fetching documents with various filters, sorting, pagination, and population options.

```typescript
const client = strapi({ baseURL: 'http://localhost:1337/api' });
const articles = client.collection('articles');

// Fetch all articles
const allArticles = await articles.find();
console.log(allArticles.data); // Array of article documents
console.log(allArticles.meta.pagination); // Pagination info

// With filters
const published = await articles.find({
  filters: { published: true }
});

// With sorting and pagination
const paginated = await articles.find({
  sort: 'title:asc',
  pagination: { page: 1, pageSize: 10 }
});

// With locale and population
const localized = await articles.find({
  locale: 'es',
  populate: { author: true, comments: true }
});

// Complex filtering
const filtered = await articles.find({
  filters: {
    $and: [
      { published: true },
      { category: { name: { $eq: 'Technology' } } }
    ]
  }
});
```

--------------------------------

### Token Header Format

Source: https://github.com/strapi/client/blob/main/_autodocs/8_authentication.md

Format for the Authorization header and an example of a bearer token.

```text
Authorization: Bearer {token}
```

```text
Authorization: Bearer 1234567890abcdefghijklmnop
```

--------------------------------

### Check pnpm Version

Source: https://github.com/strapi/client/blob/main/CONTRIBUTING.md

Verify that pnpm is installed and accessible in your environment. This is the required package manager for the project.

```bash
pnpm -v
```

--------------------------------

### Use generic types with documents

Source: https://github.com/strapi/client/blob/main/_autodocs/6_types-and-interfaces.md

Example of typing document responses using generics.

```typescript
interface Article extends Document {
  title: string;
  content: string;
  published: boolean;
}

const article: Article = (await articles.findOne('doc-id')).data;
const collection: Article[] = (await articles.find()).data;
```

--------------------------------

### Initialize Strapi Client

Source: https://github.com/strapi/client/blob/main/README.md

Initialize the Strapi client with the base URL of your Strapi API. This is the basic configuration required to start interacting with your backend.

```typescript
import { strapi } from '@strapi/client';

const client = strapi({ baseURL: 'http://localhost:1337/api' });
```

--------------------------------

### Use findOne method for single document retrieval

Source: https://github.com/strapi/client/blob/main/_autodocs/2_collection-manager.md

Examples of fetching a single document with population, locale, and field selection.

```typescript
const client = strapi({ baseURL: 'http://localhost:1337/api' });
const articles = client.collection('articles');

// Fetch a single article
const article = await articles.findOne('ebd74ca4-288f-41a2-974c-a4288fa1a24f');
console.log(article.data); // Article document

// With population
const withAuthor = await articles.findOne('doc-id-123', {
  populate: { author: true }
});

// With locale
const spanishVersion = await articles.findOne('doc-id-123', {
  locale: 'es'
});

// With specific fields
const fieldsOnly = await articles.findOne('doc-id-123', {
  fields: ['title', 'content']
});
```

--------------------------------

### Unit Test Structure Example

Source: https://github.com/strapi/client/blob/main/CONTRIBUTING.md

A template for writing unit tests in TypeScript using Jest. Follows the Arrange-Act-Assert pattern for clarity and maintainability.

```typescript
// example.test.ts
import { ExampleClass } from '../src/example';

describe('Example Class', () => {
  it('should return the expected result when calling action', () => {
    // Arrange
    const input = 'inputValue';
    const expected = 'smth';
    const instance = new ExampleClass();

    const spy = jest.spyOn(instance, 'sideEffect');

    // Act
    const result = instance.action(input);

    // Assert
    expect(result).toBe(expected);
    expect(spy).toHaveBeenCalledWith(input);
  });
});
```

--------------------------------

### Integrate React-X and React-DOM ESLint Plugins

Source: https://github.com/strapi/client/blob/main/demo/react-vite/README.md

Install and configure eslint-plugin-react-x and eslint-plugin-react-dom for React-specific linting rules. Enable their recommended TypeScript rules.

```javascript
// eslint.config.js
import reactX from 'eslint-plugin-react-x';
import reactDom from 'eslint-plugin-react-dom';

export default tseslint.config({
  plugins: {
    // Add the react-x and react-dom plugins
    'react-x': reactX,
    'react-dom': reactDom,
  },
  rules: {
    // other rules...
    // Enable its recommended typescript rules
    ...reactX.configs['recommended-typescript'].rules,
    ...reactDom.configs.recommended.rules,
  },
});
```

--------------------------------

### Manage Single Resources with Strapi Client

Source: https://github.com/strapi/client/blob/main/README.md

Use the `.single()` method to get a manager for single-type resources. This manager supports finding, updating, and deleting the single document. You can specify a locale to fetch or update specific language versions.

```typescript
const homepage = client.single('homepage');

// Fetch the default version of the homepage
const defaultHomepage = await homepage.find();

// Fetch the spanish version of the homepage
const spanishHomepage = await homepage.find({ locale: 'es' });

// Update the homepage draft content
const updatedHomepage = await homepage.update(
  { title: 'Updated Homepage Title' },
  { status: 'draft' }
);

// Delete the homepage content
await homepage.delete();
```

```typescript
const homepage = client.single('homepage', { path: '/my-custom-path' });
```

--------------------------------

### Initialize Client with Multi-Environment Configuration

Source: https://github.com/strapi/client/blob/main/_autodocs/9_configuration.md

Uses environment variables to set base URLs and tokens, with conditional logic for development-specific headers.

```typescript
const config = {
  baseURL: process.env.STRAPI_URL,
  auth: process.env.STRAPI_TOKEN,
  headers: {
    'X-Client-Version': '1.0.0',
    'Accept-Language': 'en-US'
  }
};

if (process.env.NODE_ENV === 'development') {
  // Add request ID for debugging
  config.headers['X-Request-ID'] = Math.random().toString(36).substr(2, 9);
}

const client = strapi(config);
```

--------------------------------

### Initialize and use content type managers

Source: https://github.com/strapi/client/blob/main/_autodocs/9_configuration.md

Demonstrates client initialization and usage of collection and single-type managers with various configurations.

```typescript
const client = strapi({ baseURL: 'http://localhost:1337/api' });

// Standard collection
const articles = client.collection('articles');
const allArticles = await articles.find();

// Standard single type
const homepage = client.single('homepage');
const content = await homepage.find();

// Plugin resource (auto-detected)
const users = client.collection('users');  // users-permissions plugin

// Plugin with custom config
const blogPosts = client.collection('posts', {
  plugin: { name: 'blog-plugin' }
});

// Custom path
const legacyApi = client.collection('items', {
  path: '/old-api/items'
});
```

--------------------------------

### Perform HTTP GET request

Source: https://github.com/strapi/client/blob/main/_autodocs/5_http-client.md

Sends a GET request to the specified path. Throws an HTTPError on failure.

```typescript
const client = new HttpClient({ baseURL: 'https://api.example.com' });

const response = await client.get('/users');
const users = await response.json();
console.log(users);

// With query string
const filtered = await client.get('/users?role=admin');
const admins = await filtered.json();
```

--------------------------------

### Constructing Single-Type Resource Paths

Source: https://github.com/strapi/client/blob/main/_autodocs/3_single-type-manager.md

Demonstrates how to initialize single-type resources using default paths, plugin-specific paths, or custom endpoints.

```typescript
// Regular single-type
const homepage = client.single('homepage');
// API endpoint: /homepage

// Single-type from plugin
const settings = client.single('settings', {
  plugin: { name: 'my-plugin' }
});
// API endpoint: /my-plugin/settings

// Custom path
const custom = client.single('data', {
  path: '/custom-data-endpoint'
});
// API endpoint: /custom-data-endpoint
```

--------------------------------

### Handle URLParsingError

Source: https://github.com/strapi/client/blob/main/_autodocs/7_errors.md

Example of catching a URLParsingError when initializing the client with an invalid URL.

```typescript
try {
  const client = strapi({
    baseURL: 'not-a-valid-url'
  });
} catch (error) {
  if (error instanceof URLParsingError) {
    console.log('Invalid URL provided');
  }
}
```

--------------------------------

### Build Strapi Client Project

Source: https://github.com/strapi/client/blob/main/CONTRIBUTING.md

Run this command to compile the source code of the Strapi Client project.

```bash
pnpm build
```

--------------------------------

### Handle FileNotFoundError

Source: https://github.com/strapi/client/blob/main/_autodocs/7_errors.md

Example of catching a FileNotFoundError to access the missing file ID.

```typescript
try {
  const file = await client.files.findOne(999);
} catch (error) {
  if (error instanceof FileNotFoundError) {
    console.log(`File with ID ${error.fileId} not found`);
  }
}
```

--------------------------------

### Configure Strapi Client Instances

Source: https://github.com/strapi/client/blob/main/_autodocs/1_main-api.md

Demonstrates initializing the client with an API token and optional custom headers.

```typescript
import { strapi } from '@strapi/client';

// Basic usage with API token
const client = strapi({
  baseURL: 'https://api.example.com',
  auth: 'your-api-token-here'
});

// With custom headers
const client = strapi({
  baseURL: 'http://localhost:1337/api',
  auth: 'token123',
  headers: {
    'X-Request-ID': 'abc123',
    'Accept-Language': 'en-US'
  }
});
```

--------------------------------

### new HttpClient(config: HttpClientConfig)

Source: https://github.com/strapi/client/blob/main/_autodocs/9_configuration.md

Initializes a new HttpClient instance with specific configuration options.

```APIDOC
## new HttpClient(config: HttpClientConfig)

### Description
Creates a new instance of the internal HTTP client. This allows for granular control over request timeouts and headers.

### Parameters
- **baseURL** (string) - Required - Base URL for HTTP requests
- **timeout** (number) - Optional - Request timeout in milliseconds (Default: 30000)
- **headers** (Record<string, string>) - Optional - Custom headers for all requests

### Example
```typescript
import { HttpClient } from '@strapi/client';

const httpClient = new HttpClient({
  baseURL: 'http://localhost:1337/api',
  timeout: 5000,
  headers: { 'X-API-Key': 'secret' }
});
```
```

--------------------------------

### Build Strapi App and Demo Projects

Source: https://github.com/strapi/client/blob/main/README.md

Compiles the main Strapi app and all demo projects, preparing them for use. Ensures all components are compiled and ready.

```bash
pnpm demo build
```

--------------------------------

### Handle FileForbiddenError

Source: https://github.com/strapi/client/blob/main/_autodocs/7_errors.md

Example of catching a FileForbiddenError and accessing the error message and optional file ID.

```typescript
try {
  await client.files.delete(1);
} catch (error) {
  if (error instanceof FileForbiddenError) {
    console.log('Cannot delete file:', error.message);
    if (error.fileId) {
      console.log('File ID:', error.fileId);
    }
  }
}
```

--------------------------------

### client.single(resourceName, options)

Source: https://github.com/strapi/client/blob/main/_autodocs/3_single-type-manager.md

Initializes a manager for a single-type resource. The path is determined by the resource name, optional plugin configuration, or a custom path.

```APIDOC
## client.single(resourceName, options)

### Description
Initializes a manager for a single-type resource. The API endpoint is constructed based on the resource name, plugin configuration, or a custom path provided in the options.

### Parameters
- **resourceName** (string) - Required - The name of the single-type resource.
- **options** (object) - Optional - Configuration object.
  - **plugin** (object) - Optional - Plugin configuration containing the plugin name.
  - **path** (string) - Optional - A custom path for the resource endpoint.

### Usage Example
```typescript
// Regular single-type
const homepage = client.single('homepage');

// Single-type from plugin
const settings = client.single('settings', {
  plugin: { name: 'my-plugin' }
});

// Custom path
const custom = client.single('data', {
  path: '/custom-data-endpoint'
});
```
```

--------------------------------

### Multiple Clients with Different Tokens

Source: https://github.com/strapi/client/blob/main/_autodocs/8_authentication.md

Demonstrates how to manage multiple client instances with distinct authentication levels or tokens.

```typescript
const publicClient = strapi({
  baseURL: 'http://localhost:1337/api'
  // No auth - for public content
});

const adminClient = strapi({
  baseURL: 'http://localhost:1337/api',
  auth: process.env.ADMIN_TOKEN
});

const serviceClient = strapi({
  baseURL: 'http://localhost:1337/api',
  auth: process.env.SERVICE_TOKEN
});
```

--------------------------------

### Execute HTTP Requests

Source: https://github.com/strapi/client/blob/main/_autodocs/5_http-client.md

Perform GET and POST requests with support for custom headers, bodies, and timeout error handling.

```typescript
const client = new HttpClient({ baseURL: 'https://api.example.com' });

// GET request
const response = await client.request('/users', { method: 'GET' });
const data = await response.json();

// POST request
const response = await client.request('/users', {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({ name: 'John' })
});

// With timeout handling
try {
  const response = await client.request('/slow-endpoint');
} catch (error) {
  if (error.name === 'AbortError') {
    console.error('Request timed out');
  }
}
```

--------------------------------

### create()

Source: https://github.com/strapi/client/blob/main/_autodocs/5_http-client.md

Creates a new HttpClient instance with inherited or custom configuration.

```APIDOC
## create(config?: Partial<HttpClientConfig>, inheritInterceptors?: boolean)

### Description
Creates a new HttpClient instance with inherited or custom configuration and optional interceptor inheritance.

### Parameters
- **config** (Partial<HttpClientConfig>) - Optional - Partial config overrides (baseURL, timeout, headers)
- **inheritInterceptors** (boolean) - Optional - Whether to clone interceptors from current instance (Default: true)

### Returns
- **HttpClient** - A new HttpClient instance.
```

--------------------------------

### Initialize Strapi Client with Authentication

Source: https://github.com/strapi/client/blob/main/_autodocs/8_authentication.md

Configure the client instance using the strapi factory function with an API token.

```typescript
import { strapi } from '@strapi/client';

const client = strapi({
  baseURL: 'http://localhost:1337/api',
  auth: 'your-api-token-here'
});
```

--------------------------------

### Execute API Queries with Various Options

Source: https://github.com/strapi/client/blob/main/_autodocs/9_configuration.md

Demonstrates various ways to query collections using filters, sorting, pagination, and population.

```typescript
const articles = client.collection('articles');

// Simple query
const all = await articles.find();

// With filters
const published = await articles.find({
  filters: { status: 'published' }
});

// With sorting
const sorted = await articles.find({
  sort: 'createdAt:desc'
});

// With pagination
const paginated = await articles.find({
  pagination: { page: 1, pageSize: 20 }
});

// With population
const withRelations = await articles.find({
  populate: { author: true, comments: true }
});

// Complex query
const complex = await articles.find({
  filters: {
    $and: [
      { status: 'published' },
      { featured: true }
    ]
  },
  sort: 'createdAt:desc',
  pagination: { page: 1, pageSize: 10 },
  populate: {
    author: { fields: ['name', 'email'] },
    tags: true
  },
  fields: ['title', 'content', 'author', 'tags'],
  locale: 'en'
});
```

--------------------------------

### Initialize Strapi Client in Browser

Source: https://github.com/strapi/client/blob/main/README.md

Initialize the Strapi client in a browser environment using a script tag. Ensure the CDN URL is correct for your needs.

```html
<script src="https://cdn.jsdelivr.net/npm/@strapi/client"></script>

<script>
  const client = strapi.strapi({ baseURL: 'http://localhost:1337/api' });
</script>
```

--------------------------------

### Configure Environment Variables

Source: https://github.com/strapi/client/blob/main/_autodocs/9_configuration.md

Define configuration settings in a .env file to manage API connectivity and timeouts.

```bash
# .env
STRAPI_API_URL=http://localhost:1337/api
STRAPI_API_TOKEN=your-api-token-here
STRAPI_TIMEOUT=30000
```

--------------------------------

### Production Build Check

Source: https://github.com/strapi/client/blob/main/CONTRIBUTING.md

Check the production build process by cleaning and building the project.

```bash
NODE_ENV=production pnpm build:clean
```

--------------------------------

### Initialize Strapi Client

Source: https://github.com/strapi/client/blob/main/_autodocs/00_START_HERE.md

Use the strapi factory function to create a client instance with a base URL and authentication token.

```typescript
import { strapi } from '@strapi/client';

const client = strapi({
  baseURL: 'http://localhost:1337/api',
  auth: 'your-api-token'
});
```

--------------------------------

### Seed Strapi Demo App Database

Source: https://github.com/strapi/client/blob/main/README.md

Populates the Strapi app with sample data. Use this to add default content.

```bash
pnpm demo app:seed
```

--------------------------------

### Instantiate SingleTypeManager

Source: https://github.com/strapi/client/blob/main/_autodocs/3_single-type-manager.md

Demonstrates how to initialize the manager with a specific resource name and an HTTP client.

```typescript
import { SingleTypeManager } from '@strapi/client';

const httpClient = new HttpClient({ baseURL: 'http://localhost:1337/api' });
const homepageManager = new SingleTypeManager(
  { resource: 'homepage' },
  httpClient
);
```

--------------------------------

### Mock Flaky URL Validator

Source: https://github.com/strapi/client/blob/main/CONTRIBUTING.md

An example of a mock class extending a base validator, designed to simulate unexpected errors during validation. Useful for testing error handling scenarios.

```typescript
import { URLValidator } from '../../../src/validators';

/**
 * Class representing a FlakyURLValidator which extends URLValidator.
 *
 * This validator is designed to throw an error unexpectedly upon validation and should only be used in test suites.
 */
export class MockFlakyURLValidator extends URLValidator {
  validate() {
    throw new Error('Unexpected error');
  }
}
```

--------------------------------

### Initialize StrapiClient with Custom Strategy

Source: https://github.com/strapi/client/blob/main/_autodocs/8_authentication.md

Configure the StrapiClient instance to use a custom authentication strategy by passing the strategy name and options to the auth configuration.

```typescript
import { StrapiClient } from '@strapi/client';

const client = new StrapiClient({
  baseURL: 'http://localhost:1337/api',
  auth: {
    strategy: 'custom-auth',
    options: {
      refreshUrl: '/auth/token',
      credentials: btoa('user:pass')
    }
  }
});
```

--------------------------------

### Run All Unit Tests

Source: https://github.com/strapi/client/blob/main/CONTRIBUTING.md

Execute all unit tests in the project using pnpm. This command is the standard way to verify code changes.

```bash
pnpm test
```

--------------------------------

### Manage Collection Resources with Strapi Client

Source: https://github.com/strapi/client/blob/main/README.md

Use the `.collection()` method to get a manager for collection-type resources. This manager supports finding, creating, updating, and deleting entries. It can also handle special content-types like users from the users-permissions plugin.

```typescript
const articles = client.collection('articles');

// Fetch all english articles sorted by title
const allArticles = await articles.find({
  locale: 'en',
  sort: 'title',
});

// Fetch a single article
const singleArticle = await articles.findOne('article-document-id');

// Create a new article
const newArticle = await articles.create({ title: 'New Article', content: '...' });

// Update an existing article
const updatedArticle = await articles.update('article-document-id', { title: 'Updated Title' });

// Delete an article
await articles.delete('article-id');
```

```typescript
// Auto-detected as users-permissions - no configuration needed!
const users = client.collection('users');

// Create a new user
await users.create({
  username: 'john',
  email: 'john@example.com',
  password: 'SecurePass123!',
  role: 1,
});

// Find users
const allUsers = await users.find();

// Update a user
await users.update('user-id', { username: 'john_updated' });
```

```typescript
const articles = client.collection('articles', { path: '/my-custom-path' });
```

--------------------------------

### strapi(config: Config)

Source: https://github.com/strapi/client/blob/main/_autodocs/1_main-api.md

Creates a new Strapi Client instance with configuration for baseURL, authentication, and headers.

```APIDOC
## strapi(config: Config)

### Description
Creates a new Strapi Client instance with configuration for baseURL, authentication, and headers.

### Parameters
- **config** (Config) - Required - Configuration object containing baseURL and optional auth/headers
- **config.baseURL** (string) - Required - The base URL of the Strapi content API, must include protocol (http/https)
- **config.auth** (string) - Optional - API token for authentication, included as Bearer token in Authorization header
- **config.headers** (Record<string, string>) - Optional - Custom headers to include with every request

### Return Type
- **StrapiClient** - An instance of the Strapi Client configured with the provided settings.

### Throws
- **StrapiInitializationError** - If baseURL is invalid (not HTTP/HTTPS) or auth configuration is invalid.

### Example
```typescript
import { strapi } from '@strapi/client';

// Basic usage with API token
const client = strapi({
  baseURL: 'https://api.example.com',
  auth: 'your-api-token-here'
});

// With custom headers
const client = strapi({
  baseURL: 'http://localhost:1337/api',
  auth: 'token123',
  headers: {
    'X-Request-ID': 'abc123',
    'Accept-Language': 'en-US'
  }
});
```
```

--------------------------------

### Basic Usage of Strapi Client

Source: https://github.com/strapi/client/blob/main/_autodocs/README.md

Initialize the client and perform CRUD operations on collections, single-types, and files.

```typescript
import { strapi } from '@strapi/client';

// Create client
const client = strapi({
  baseURL: 'http://localhost:1337/api',
  auth: 'your-api-token'
});

// Fetch collections
const articles = await client.collection('articles').find();

// Fetch single entry
const article = await client.collection('articles').findOne('doc-id');

// Create entry
const newArticle = await client.collection('articles').create({
  title: 'New Article',
  content: '...'
});

// Update entry
await client.collection('articles').update('doc-id', {
  title: 'Updated Title'
});

// Delete entry
await client.collection('articles').delete('doc-id');

// Single-type resources
const homepage = await client.single('homepage').find();
await client.single('homepage').update({ title: 'New Title' });

// File management
const files = await client.files.find();
const file = await client.files.findOne(1);
await client.files.upload(blob, { fileInfo: { name: 'image.jpg' } });
```

--------------------------------

### Configure Strapi Client with Environment Variables

Source: https://github.com/strapi/client/blob/main/_autodocs/8_authentication.md

Use environment variables for configuration to avoid hardcoding sensitive credentials in source code.

```typescript
// ✅ Good - from environment
const client = strapi({
  baseURL: process.env.STRAPI_URL,
  auth: process.env.STRAPI_TOKEN
});

// ❌ Bad - hardcoded
const client = strapi({
  baseURL: 'http://localhost:1337/api',
  auth: 'hardcoded-token-12345'
});
```

--------------------------------

### Implement authenticate Method

Source: https://github.com/strapi/client/blob/main/_autodocs/8_authentication.md

Performs authentication steps such as token retrieval or session establishment.

```typescript
authenticate(httpClient: HttpClient): Promise<void>
```

--------------------------------

### Configure Feature Flags for Queries

Source: https://github.com/strapi/client/blob/main/_autodocs/9_configuration.md

Demonstrates passing configuration to the client and using a helper function to toggle query filters based on feature flags.

```typescript
const client = strapi({
  baseURL: 'http://localhost:1337/api',
  auth: process.env.API_TOKEN
});

// Use feature flags in queries
async function getArticles(includeUnpublished = false) {
  const filters = includeUnpublished ? {} : { status: 'published' };
  return client.collection('articles').find({ filters });
}
```

--------------------------------

### Watch for Changes and Rebuild Strapi Client Project

Source: https://github.com/strapi/client/blob/main/CONTRIBUTING.md

Execute this command to automatically rebuild the project whenever changes are detected in the `src` folder.

```bash
pnpm watch
```

--------------------------------

### Run Linting

Source: https://github.com/strapi/client/blob/main/CONTRIBUTING.md

Execute the linting command to fix code style issues.

```bash
pnpm lint:fix
```

--------------------------------

### strapi() factory function

Source: https://github.com/strapi/client/blob/main/_autodocs/8_authentication.md

Initializes the Strapi client with authentication credentials.

```APIDOC
## strapi(options)

### Description
Creates a new Strapi client instance with the specified base URL and authentication token.

### Parameters
- **options.baseURL** (string) - Required - The base URL of the Strapi API.
- **options.auth** (string) - Required - The API token used for Bearer authentication.
```

--------------------------------

### HttpClient Constructor Signature

Source: https://github.com/strapi/client/blob/main/_autodocs/5_http-client.md

Initializes a new client instance with configuration and optional URL validation.

```typescript
constructor(
  config: HttpClientConfig,
  urlValidator?: URLValidator
)
```

--------------------------------

### upload(file, options?)

Source: https://github.com/strapi/client/blob/main/_autodocs/4_files-manager.md

Uploads a new media file to the Strapi Media Library, supporting both Blob and Buffer inputs.

```APIDOC
## upload(file: Blob | Buffer, options?: BlobUploadOptions | BufferUploadOptions)

### Description
Uploads a new media file to the Strapi Media Library. Supports both Blob and Buffer inputs with overloaded signatures.

### Parameters
- **file** (Blob | Buffer) - Required - The file data to upload
- **options** (BlobUploadOptions | BufferUploadOptions) - Optional - Upload options and file metadata
- **options.fileInfo** (FileUpdateData) - Optional - Metadata for the file (name, alternativeText, caption)
- **options.filename** (string) - Required for Buffer - File name (required for Buffer uploads)
- **options.mimetype** (string) - Required for Buffer - MIME type (required for Buffer uploads)

### Returns
Promise<MediaUploadResponse> — An array containing the uploaded file(s).

### Throws
- FileForbiddenError if user lacks permission to upload
- HTTPError for connection or authentication failures
- Error if Buffer upload is missing required filename or mimetype
```

--------------------------------

### Handle client initialization errors

Source: https://github.com/strapi/client/blob/main/_autodocs/7_errors.md

Pattern for catching errors that occur during the client initialization process.

```typescript
try {
  const client = strapi({
    baseURL: userProvidedUrl,
    auth: userToken
  });
} catch (error) {
  if (error instanceof StrapiInitializationError) {
    console.error('Failed to initialize client:', error.message);
  } else if (error instanceof StrapiValidationError) {
    console.error('Invalid configuration:', error.message);
  } else if (error instanceof URLParsingError) {
    console.error('Invalid base URL:', error.message);
  }
}
```

--------------------------------

### Check Code Formatting

Source: https://github.com/strapi/client/blob/main/CONTRIBUTING.md

Verify if the code adheres to Prettier formatting rules by running this command.

```bash
pnpm format:check
```

--------------------------------

### Clone Strapi Client Repository with Git

Source: https://github.com/strapi/client/blob/main/CONTRIBUTING.md

Use this command to clone the Strapi Client repository using the standard Git command-line tool.

```bash
git clone https://github.com/strapi/client.git
cd client
```

--------------------------------

### Initialize FilesManager

Source: https://github.com/strapi/client/blob/main/_autodocs/4_files-manager.md

Instantiate the FilesManager by providing an HttpClient instance configured with the base API URL.

```typescript
import { FilesManager } from '@strapi/client';

const httpClient = new HttpClient({ baseURL: 'http://localhost:1337/api' });
const filesManager = new FilesManager(httpClient);
```

--------------------------------

### Create a document in a collection

Source: https://github.com/strapi/client/blob/main/_autodocs/2_collection-manager.md

Demonstrates creating new documents with basic fields, relations, and locale settings.

```typescript
const client = strapi({ baseURL: 'http://localhost:1337/api' });
const articles = client.collection('articles');

// Create a basic article
const newArticle = await articles.create({
  title: 'My First Article',
  content: 'This is the article content',
  published: true
});
console.log(newArticle.data.documentId); // Generated document ID

// Create with relations
const withAuthor = await articles.create({
  title: 'Article with Author',
  content: 'Content here',
  author: { connect: [1] }  // Connect to author with ID 1
});

// Create with specific locale
const inSpanish = await articles.create(
  { title: 'Mi Artículo', content: 'Contenido' },
  { locale: 'es' }
);
```

--------------------------------

### Initialize StrapiClient Constructor

Source: https://github.com/strapi/client/blob/main/_autodocs/1_main-api.md

The constructor accepts configuration, an optional validator, auth manager, and HTTP client factory. It is recommended to use the strapi() factory function instead of direct instantiation.

```typescript
constructor(
  config: StrapiClientConfig,
  validator?: StrapiConfigValidator,
  authManager?: AuthManager,
  httpClientFactory?: (config: HttpClientConfig) => HttpClient
)
```

--------------------------------

### Format Code

Source: https://github.com/strapi/client/blob/main/CONTRIBUTING.md

Run the code formatting command to ensure consistent code style.

```bash
pnpm format:write
```

--------------------------------

### Upload Files in Browser and Node.js

Source: https://github.com/strapi/client/blob/main/_autodocs/9_configuration.md

Demonstrates uploading files using Blob objects in the browser and Buffer objects in Node.js environments.

```typescript
const client = strapi({ baseURL: 'http://localhost:1337/api' });

// Upload Blob/File from browser
const fileInput = document.querySelector('input[type="file"]');
const file = fileInput.files[0];

const result = await client.files.upload(file, {
  fileInfo: {
    name: 'avatar.jpg',
    alternativeText: 'User avatar',
    caption: 'Profile picture'
  }
});

// Upload Buffer from Node.js
import fs from 'fs';
const buffer = fs.readFileSync('./image.png');

const result = await client.files.upload(buffer, {
  filename: 'image.png',
  mimetype: 'image/png',
  fileInfo: {
    alternativeText: 'Uploaded image'
  }
});
```

--------------------------------

### HttpClient Constructor

Source: https://github.com/strapi/client/blob/main/_autodocs/5_http-client.md

Initializes a new instance of the HttpClient with a base configuration and optional URL validator.

```APIDOC
## Constructor

### Description
Creates a new HttpClient instance with configuration and optional dependency injection.

### Parameters
#### config (HttpClientConfig) - Required
- **baseURL** (string) - Required - The base URL for all requests (must be valid HTTP/HTTPS URL)
- **timeout** (number) - Optional - Request timeout in milliseconds (default: 30000)
- **headers** (Record<string, string>) - Optional - Custom headers included with every request

#### urlValidator (URLValidator) - Optional
- Custom URL validator instance (default: new URLValidator())

### Example
```typescript
import { HttpClient } from '@strapi/client';

const client = new HttpClient({
  baseURL: 'http://localhost:1337/api',
  timeout: 5000,
  headers: { 'X-Custom-Header': 'value' }
});
```
```

--------------------------------

### Clone Strapi Client Repository with GitHub CLI

Source: https://github.com/strapi/client/blob/main/CONTRIBUTING.md

Use this command to clone the Strapi Client repository using the GitHub command-line interface.

```bash
gh repo clone strapi/client
cd client
```

--------------------------------

### Enable Debug Logging for Authentication

Source: https://github.com/strapi/client/blob/main/_autodocs/8_authentication.md

Use the DEBUG environment variable to inspect authentication lifecycle events and provider operations.

```bash
# Enable all Strapi debug logs
DEBUG=strapi:* node app.js

# Enable only auth logs
DEBUG=strapi:auth:* node app.js

# Enable specific auth components
DEBUG=strapi:auth:provider:api-token node app.js
```

--------------------------------

### Initialize Strapi Client with Factory Function

Source: https://github.com/strapi/client/blob/main/_autodocs/1_main-api.md

Defines the signature for the strapi factory function used to create a new client instance.

```typescript
export const strapi = (config: Config): StrapiClient
```

--------------------------------

### Configure Strapi Client with API Token

Source: https://github.com/strapi/client/blob/main/README.md

Configure the Strapi client for API-Token authentication. Replace 'your-api-token-here' with your actual Strapi API token.

```typescript
const client = strapi({
  // Endpoint configuration
  baseURL: 'http://localhost:1337/api',
  // Auth configuration
  auth: 'your-api-token-here',
});
```

--------------------------------

### request()

Source: https://github.com/strapi/client/blob/main/_autodocs/5_http-client.md

Sends an HTTP request using the configured client settings.

```APIDOC
## request(path: string, init?: RequestInit)

### Description
Sends an HTTP request to the specified path with full interceptor and timeout support.

### Parameters
- **path** (string) - Required - Relative path/URL appended to baseURL
- **init** (RequestInit) - Optional - Fetch RequestInit options (method, headers, body, signal, etc.)

### Returns
- **Promise<Response>** - The HTTP response object.
```

--------------------------------

### single()

Source: https://github.com/strapi/client/blob/main/_autodocs/1_main-api.md

Returns a manager instance for interacting with single-type resources, which have only one document per locale.

```APIDOC
## single(resource, options)

### Description
Returns a manager instance for interacting with single-type resources. Single types have only one document per locale.

### Parameters
- **resource** (string) - Required - The singular name of the single-type resource as defined in Strapi
- **options** (SingleCollectionOptions) - Optional - Optional configuration (path override, plugin settings)
- **options.path** (string) - Optional - Custom root path override for requests
- **options.plugin** (PluginConfig) - Optional - Plugin configuration for plugin-based single types

### Returns
- **SingleTypeManager** - A manager for the specified single-type resource.
```

--------------------------------

### Enable All Debug Logs (Node.js)

Source: https://github.com/strapi/client/blob/main/README.md

Use this command to enable all debug logs for all namespaces. This is useful for comprehensive debugging.

```bash
DEBUG=*

```

--------------------------------

### Create Article

Source: https://github.com/strapi/client/blob/main/_autodocs/00_START_HERE.md

Creates a new entry in the specified collection.

```APIDOC
## client.collection('articles').create

### Description
Creates a new article entry in the collection.

### Parameters
- **data** (object) - Required - The article data (e.g., { title: 'My Article', content: '...', published: true })

### Response
- **data.documentId** (string) - The ID of the newly created document
```

--------------------------------

### Run Linting Checks

Source: https://github.com/strapi/client/blob/main/CONTRIBUTING.md

Execute this command to check for code style issues.

```bash
pnpm lint
```

--------------------------------

### fetch()

Source: https://github.com/strapi/client/blob/main/_autodocs/1_main-api.md

Performs a generic HTTP request to a custom endpoint using fetch-like syntax with automatic authentication handling.

```APIDOC
## fetch(url, init)

### Description
Performs a generic HTTP request to a custom endpoint using fetch-like syntax. Authentication is automatically handled.

### Parameters
- **url** (string) - Required - The endpoint path relative to baseURL
- **init** (RequestInit) - Optional - Optional fetch request options (headers, method, body, signal, etc.)

### Returns
- **Promise<Response>** - The HTTP response object.
```

--------------------------------

### Initialize CollectionTypeManager constructor

Source: https://github.com/strapi/client/blob/main/_autodocs/2_collection-manager.md

The constructor signature for creating a new instance.

```typescript
constructor(options: ContentTypeManagerOptions, httpClient: HttpClient)
```

--------------------------------

### create(data, queryParams?)

Source: https://github.com/strapi/client/blob/main/_autodocs/2_collection-manager.md

Creates a new document in the collection. Returns a promise containing the created document with its assigned ID.

```APIDOC
## create(data, queryParams?)

### Description
Creates a new document in the collection. The data must match the Strapi content-type schema.

### Parameters
- **data** (Record<string, any>) - Required - The document data to create.
- **queryParams** (BaseQueryParams) - Optional - Query parameters for metadata or operations.

### Returns
- **Promise<DocumentResponse>** - A response containing the created document with its assigned ID.
```

--------------------------------

### Implement Debugging in Client Initialization

Source: https://github.com/strapi/client/blob/main/_autodocs/8_authentication.md

Set the DEBUG environment variable programmatically before initializing the Strapi client to capture authentication lifecycle events.

```typescript
import { strapi } from '@strapi/client';

// Enable debug before creating client
process.env.DEBUG = 'strapi:auth:*';

const client = strapi({
  baseURL: 'http://localhost:1337/api',
  auth: 'your-token'
});

// Debug output will show:
// strapi:auth:manager authentication lifecycle events
// strapi:auth:provider:api-token token validation and usage
```

--------------------------------

### Create HttpClient instance

Source: https://github.com/strapi/client/blob/main/_autodocs/5_http-client.md

Creates a new client instance with optional configuration overrides and interceptor inheritance.

```typescript
const client = new HttpClient({
  baseURL: 'https://api.example.com',
  timeout: 5000
});

// Add request interceptor
client.interceptors.request.use((payload) => {
  // Add auth header
  return payload;
});

// Create child client with inherited interceptors
const childClient = client.create();
// childClient has the same request interceptor

// Create isolated client without interceptors
const isolated = client.create({}, false);

// Create with custom config
const custom = client.create({
  baseURL: 'https://other-api.example.com',
  timeout: 10000
});
```

--------------------------------

### Configure global headers

Source: https://github.com/strapi/client/blob/main/_autodocs/5_http-client.md

Set default headers that will be included in every request made by the client instance.

```typescript
const client = new HttpClient({
  baseURL: 'https://api.example.com',
  headers: {
    'Authorization': 'Bearer token123',
    'X-Client-Version': '1.0.0',
    'Accept-Language': 'en-US'
  }
});

// These headers are automatically included with all requests
const response = await client.get('/users');
```

--------------------------------

### HttpClient

Source: https://github.com/strapi/client/blob/main/_autodocs/INDEX.md

Core HTTP transport methods and configuration.

```APIDOC
## HttpClient

### Methods
- `request(path, init?)`: Generic HTTP request.
- `get(path, init?)`: HTTP GET.
- `post(path, body?, init?)`: HTTP POST.
- `put(path, body?, init?)`: HTTP PUT.
- `delete(path, init?)`: HTTP DELETE.
- `create(config?, inheritInterceptors?)`: Clone with config.

### Configuration
- `setBaseURL(url)`: Set new base URL.
- `setTimeout(timeout)`: Set request timeout.
```

--------------------------------

### files

Source: https://github.com/strapi/client/blob/main/_autodocs/1_main-api.md

Provides access to the FilesManager for interacting with media library files.

```APIDOC
## Property: files

### Description
Provides access to the files manager for interacting with media library files.

### Type
- **FilesManager**

### Example
```typescript
const client = strapi({ baseURL: 'http://localhost:1337/api' });
const allFiles = await client.files.find();
const file = await client.files.findOne(1);
```
```

--------------------------------

### HttpClient Methods

Source: https://github.com/strapi/client/blob/main/_autodocs/00_START_HERE.md

Low-level HTTP request methods.

```APIDOC
## HttpClient Methods

- **request(path, init?)**: Promise<Response>
- **get(path, init?)**: Promise<Response>
- **post(path, body?, init?)**: Promise<Response>
- **put(path, body?, init?)**: Promise<Response>
- **delete(path, init?)**: Promise<Response>
- **create(config?, inheritInterceptors?)**: HttpClient
```

--------------------------------

### FilesManager Methods

Source: https://github.com/strapi/client/blob/main/_autodocs/00_START_HERE.md

Methods for managing file and media uploads.

```APIDOC
## FilesManager Methods

- **find(queryParams?)**: Promise<FileListResponse> - Lists files.
- **findOne(fileId)**: Promise<FileResponse> - Retrieves a file by ID.
- **update(fileId, fileInfo)**: Promise<FileResponse> - Updates file metadata.
- **delete(fileId)**: Promise<FileResponse> - Deletes a file.
- **upload(file: Blob | Buffer, options?)**: Promise<MediaUploadResponse> - Uploads a new file.
```

--------------------------------

### Client Methods

Source: https://github.com/strapi/client/blob/main/_autodocs/9_configuration.md

Methods available on the Strapi client instance to interact with content types.

```APIDOC
## client.collection(resource, options)

### Description
Initializes a collection type manager.

### Parameters
- **resource** (string) - Required - The name of the collection.
- **options** (ContentTypeManagerOptions) - Optional - Configuration object for the collection.

## client.single(resource, options)

### Description
Initializes a single type manager.

### Parameters
- **resource** (string) - Required - The name of the single type.
- **options** (ContentTypeManagerOptions) - Optional - Configuration object for the single type.
```

--------------------------------

### Clean and Re-seed Strapi Demo App Database

Source: https://github.com/strapi/client/blob/main/README.md

Resets the demo data to its initial state by cleaning the existing database and re-seeding it. Helpful for resetting demo content.

```bash
pnpm demo app:seed:clean
```

--------------------------------

### Enable Specific Namespace Debug Logs (Node.js)

Source: https://github.com/strapi/client/blob/main/README.md

Use this command to enable debug logs for a specific namespace, such as 'strapi:http'. This helps in focusing on particular modules.

```bash
DEBUG=strapi:http

```

--------------------------------

### Query Files with find()

Source: https://github.com/strapi/client/blob/main/_autodocs/4_files-manager.md

Retrieve lists of files using optional filters and sorting parameters.

```typescript
const client = strapi({ baseURL: 'http://localhost:1337/api' });

// Fetch all files
const allFiles = await client.files.find();
console.log(allFiles); // Array of FileResponse objects

// Fetch only image files
const images = await client.files.find({
  filters: { mime: { $contains: 'image' } }
});

// Fetch with specific name pattern
const pdfs = await client.files.find({
  filters: { mime: { $eq: 'application/pdf' } }
});

// Fetch with sorting
const sorted = await client.files.find({
  sort: 'name:asc'
});

// Complex filtering
const recent = await client.files.find({
  filters: {
    $and: [
      { mime: { $contains: 'image' } },
      { name: { $contains: 'avatar' } }
    ]
  },
  sort: 'createdAt:desc'
});
```

--------------------------------

### Retrieve a Single File with findOne()

Source: https://github.com/strapi/client/blob/main/_autodocs/4_files-manager.md

Fetch file metadata by ID, including error handling for missing files.

```typescript
const client = strapi({ baseURL: 'http://localhost:1337/api' });

// Fetch a single file
const file = await client.files.findOne(1);
console.log(file.name); // File name
console.log(file.url); // File URL
console.log(file.mime); // MIME type
console.log(file.size); // File size in bytes

// With error handling
try {
  const file = await client.files.findOne(999);
} catch (error) {
  if (error instanceof FileNotFoundError) {
    console.log(`File with ID ${error.fileId} not found`);
  }
}
```
Tokens:
Raw