SDK mock backend

The SDK includes a second client with the same methods that keeps everything in memory. It is not a stub: records, queries, workflows, tasks and live events all work.

import { createMockClient } from '@devias/sdk/mock';

const client = createMockClient({
  workspaceId: 'demo',
  manifests: [manifest],
});

await client.records.create('person', { first_name: 'Ada' });

Both clients implement the same DeviasClient interface, so code written against one runs on the other.

Options

Option	What it does
`manifests`	Modules installed from the start.
`catalog`	More modules that can be installed later.
`latency`	A delay for every call, to see loading states.
`persist`	Keep the data between page loads, under a key.
`members`	The people notifications can go to.
`ai`	Scripted agent answers, for testing chat.

Call client.reset() to go back to a clean workspace.

Run the studio on the mock

To work on the studio with no server, run:

VITE_MOCK=1 pnpm dev:studio

Use the mock in tests

Create a fresh client in each test and assert on what is read back. Nothing is shared between clients, and there is nothing to start or stop. The mock does not serve files, so a module’s logo is not available. A module that needs server code, such as a payment provider, can be put in catalog to appear in the list without running. The mock has no workflow runner for queued runs: a run it starts completes immediately.

Records and queries: works the same on the mock.
What a module is: test a manifest against the mock.

SDK

CLI

HTTP API

SDK mock backend

Options

Run the studio on the mock

Use the mock in tests

​Options

​Run the studio on the mock

​Use the mock in tests

​Related

Options

Run the studio on the mock

Use the mock in tests

Related