@getaster/mock
A local OData service for Aster UI development, examples and integration tests.
The service runs in WebAssembly and exposes the same transport interface used
by @getaster/data, so a test can exercise metadata, queries and writes without
starting an HTTP server.
Use it for development, examples and tests; a production application connects to its own OData service.
Install
npm install @getaster/data
npm install --save-dev @getaster/mock
The package includes its WebAssembly binary and license notices. No Rust compiler or install script is required. It provides ES modules and TypeScript declarations; Node.js use requires Node 22 or later. Browser builds must serve the WASM asset over HTTP or pass its bytes explicitly.
The WASM location and browser route
The engine is wasm/odata_mock.wasm inside the installed package. The package
exports the file, so import.meta.resolve('@getaster/mock/wasm/odata_mock.wasm')
returns its location in Node.js and Bun.
A browser page typically passes a URL and lets the development server serve it. The documented convention is the root-relative route:
const mock = await createMockService({
metadata, data,
wasm: new URL('odata_mock.wasm', document.baseURI),
});
The server must serve the installed file at /odata_mock.wasm:
import { fileURLToPath } from 'node:url';
const wasm = Bun.file(fileURLToPath(import.meta.resolve('@getaster/mock/wasm/odata_mock.wasm')));
Bun.serve({
port: 4200,
routes: {
'/odata_mock.wasm': () => new Response(wasm, { headers: { 'content-type': 'application/wasm' } }),
},
});
apps/showcase/serve.ts implements this route for the repository's demo, and
scripts/verify-wasm.ts checks the binary's checksum, module and attribution
files before distribution. Pass wasm bytes, a URL or a URL string instead
when the file lives elsewhere; its default is the package-relative file.
Run a local service in Node.js
TypeScript projects using this Node.js example also need @types/node as a
development dependency.
import { readFileSync } from 'node:fs';
import { DataContext } from '@getaster/data';
import { createMockService } from '@getaster/mock';
const metadata = {
$Version: '4.01',
$EntityContainer: 'Demo.Container',
Demo: {
Project: {
$Kind: 'EntityType', $Key: ['id'],
id: { $Type: 'Edm.Int32' },
name: { $Type: 'Edm.String' },
},
Container: {
$Kind: 'EntityContainer',
Projects: { $Collection: true, $Type: 'Demo.Project' },
},
},
};
const wasm = readFileSync(new URL(
import.meta.resolve('@getaster/mock/wasm/odata_mock.wasm')
));
const mock = await createMockService({
metadata, wasm,
data: { Projects: [{ id: 1, name: 'First project' }] },
});
const ctx = await DataContext.connect(mock.transport);
const projects = ctx.collection({ set: 'Projects' });
try {
await projects.view(0, 10);
if (projects.error.value) throw projects.error.value;
console.log(projects.items.value);
} finally {
ctx.release(projects);
}
Exercise application behaviour
mock.faults.latencyMs and writeLatencyMs simulate slow requests;
mock.faults.failNext(503) fails the next transport request. Use mock.external()
to simulate another user's write and test stale edits. ETags are opaque values:
preserve and return them rather than constructing them in tests.
Counts are exact by default. The optional countEstimate setting simulates an
estimate-producing service for client tests; it is not Web Data's normal count
behaviour. Optional storage supports persistence; dump(), flush() and
reset() let tests control state. Worker helpers are available for browser use.
Documentation and support
License
Aster UI is licensed under Apache-2.0; see LICENSE and NOTICE. The optional
mock engine is supplied as an Apache-2.0-licensed WebAssembly binary; its
implementation source is not included. Bundled third-party components retain
their respective licenses. Their attribution inventory is in wasm/NOTICE, with
license texts in wasm/licenses/. Preserve these files when redistributing the
binary.