@getaster/mock

中文文档
0.4.72发布于 2026/11/16Apache-2.0TypeScriptES Module构建来源已验证近 30 天下载 3346

Local OData mock service powered by WebAssembly for Aster UI tests and demos.

原始使用文档
文档目录6 节
  1. Install
  2. The WASM location and browser route
  3. Run a local service in Node.js
  4. Exercise application behaviour
  5. Documentation and support
  6. License

@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.

版本与发布记录

@getaster/mock 共发布 20 个版本,首次发布于 2026/10/21;过去 12 个月发布了 20 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
0.4.72latest2026/11/16今天
0.4.472026/11/141 天前
0.4.422026/11/133 天前
0.4.402026/11/133 天前
0.4.382026/11/123 天前
0.4.352026/11/123 天前

其他发布通道:next → 0.1.0-preview.1。

关于 @getaster/mock 的常见问题

@getaster/mock 是什么?

Local OData mock service powered by WebAssembly for Aster UI tests and demos.

如何安装 @getaster/mock?

在项目目录运行 npm install @getaster/mock,或使用 pnpm add / yarn add / bun add。

@getaster/mock 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@getaster/mock 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

@getaster/mock 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js >=22。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

@getaster/mock 可以商用吗?

@getaster/mock 使用 Apache-2.0 许可。宽松许可:允许商业使用、修改和再分发,并附带明确的专利授权;分发时需保留许可与 NOTICE 文件,修改过的文件要注明改动。以上为概括,不构成法律意见,请以许可原文为准。

@getaster/mock 的下载量有多少?

根据 npm 官方下载统计,@getaster/mock 在 2026/10/17 – 2026/11/15 这 30 天内被下载 3,346 次,日均约 112 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@getaster/mock 还在维护吗?

最新版本 0.4.72 发布于 2026/11/16(今天);至今共发布 20 个版本,其中过去 12 个月发布了 20 个;首次发布于 2026/10/21。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。