@getaster/mock 0.2.0 → 0.3.0

package/NOTICE

@@ -1,10 +1,9 @@
-Aster UI
+@getaster/mock
 Copyright 2026 Aster UI contributors
 
-Aster UI source and the separately supplied OData mock WebAssembly binary are
-licensed under the Apache License, Version 2.0. Third-party components retain
-their respective licenses. The binary's attribution inventory and license texts
-are supplied in packages/mock/wasm/; packages include those notices when shipped.
+Aster UI code in this package is licensed under the Apache License, Version 2.0.
+See LICENSE. Separately installed dependencies retain their respective licenses.
 
-Geist and IBM Plex Mono fonts retain their SIL Open Font License notices.
-ECharts is an optional separately loaded third-party runtime.
+The bundled OData mock WebAssembly binary includes third-party components.
+Their attribution inventory is in wasm/NOTICE and their license texts are in
+wasm/licenses/.

package/README.md

@@ -1,7 +1,90 @@
 # @getaster/mock
 
-Aster UI 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.
 
-Documentation: https://ui.getaster.now/docs/guide/library.html
+This is a development tool, not a production database or authorization boundary.
+Aster is pre-1.0; APIs may change.
 
-Licensed under Apache-2.0. See LICENSE and NOTICE.
+## Install
+
+```sh
+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.
+
+## Run a local service in Node.js
+
+TypeScript projects using this Node.js example also need `@types/node` as a
+development dependency.
+
+```ts
+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
+
+- [Installation and distribution](https://ui.getaster.now/docs/guide/library.html)
+- [Working browser example](https://ui.getaster.now/docs/guide/getting-started.html)
+- [API reference](https://ui.getaster.now/docs/reference/)
+- [Report a bug](https://github.com/GetAster/aster-ui/issues)
+
+## License
+
+Aster UI code is Apache-2.0; see `LICENSE` and `NOTICE`. The bundled WebAssembly
+binary includes third-party components: their attribution inventory is in
+`wasm/NOTICE`, with license texts in `wasm/licenses/`. Preserve these files when
+redistributing the binary.

package/dist/service.d.ts

@@ -21,11 +21,11 @@ export interface MockServiceOptions {
     /** How long a save waits for more writes to share it; 200 ms by default. */
     saveDelayMs?: number;
     /**
-     * Counts become estimates, as a database planner's would: the exact count
-     * times this factor, rounded up, marked `@AsterData.CountEstimated`. A
-     * set's `AsterData.CountThreshold` then makes its count exact below the
-     * threshold and leaves it out at or above it, as aster-server does.
-     * `Prefer: aster.count=exact` still gets the exact count.
+     * Test-only simulation for top-level entity-set reads: multiply the exact
+     * count by this positive factor, round up and mark CountEstimated.
+     * CountThreshold makes it exact below the threshold and absent at or above.
+     * Prefer: aster.count=exact bypasses simulation. Web Data itself returns
+     * exact counts; this option exercises clients of services with estimates.
      */
     countEstimate?: number;
 }

package/dist/service.js

@@ -2,6 +2,9 @@ import { instantiate, loadWasmBytes } from "./engine.js";
 const DEFAULT_WASM = new URL("../wasm/odata_mock.wasm", import.meta.url);
 const sleep = (ms) => new Promise((resolve) => setTimeout(resolve, ms));
 export async function createMockService(options) {
+    if (options.countEstimate !== undefined && (!Number.isFinite(options.countEstimate) || options.countEstimate <= 0)) {
+        throw new RangeError("countEstimate must be a positive finite factor");
+    }
     const now = options.now ?? (() => new Date().toISOString());
     const engine = await instantiate(await loadWasmBytes(options.wasm ?? DEFAULT_WASM), () => Date.parse(now()));
     const { storage } = options;
@@ -11,6 +14,7 @@ export async function createMockService(options) {
         maxPageSize: options.maxPageSize,
         countEstimate: options.countEstimate,
         data: from.data,
+        revisions: from.revisions,
     });
     init((await storage?.load()) ?? { data: options.data });
     // Storage holds the whole dataset, so writes close together share one

package/dist/storage.d.ts

@@ -1,5 +1,7 @@
 export interface Dump {
     data: Record<string, unknown[]>;
+    /** Internal concurrency counters, keyed by set and key predicate. Keep with data when persisting. */
+    revisions?: Record<string, Record<string, string>>;
 }
 export interface MockStorage {
     load(): Promise<Dump | undefined>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@getaster/mock",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "type": "module",
   "exports": {
     ".": {
@@ -11,7 +11,7 @@
     "./wasm/odata_mock.wasm": "./wasm/odata_mock.wasm"
   },
   "dependencies": {
-    "@getaster/data": "0.2.0"
+    "@getaster/data": "0.3.0"
   },
   "license": "Apache-2.0",
   "repository": {
@@ -19,6 +19,18 @@
     "url": "git+https://github.com/GetAster/aster-ui.git",
     "directory": "packages/mock"
   },
+  "description": "Local OData mock service powered by WebAssembly for Aster UI tests and demos.",
+  "homepage": "https://ui.getaster.now/docs/guide/library.html",
+  "bugs": {
+    "url": "https://github.com/GetAster/aster-ui/issues"
+  },
+  "keywords": [
+    "odata",
+    "mock",
+    "webassembly",
+    "testing",
+    "typescript"
+  ],
   "types": "./dist/index.d.ts",
   "publishConfig": {
     "access": "public"

package/wasm/ARTIFACT.json

@@ -1,7 +1,7 @@
 {
   "license": "Apache-2.0",
-  "sha256": "cbdab46f22434ac0a8caf59d089eb6f6c53a4fc677914cb7005696a5e95d738d",
-  "bytes": 4631621,
+  "sha256": "8aa8844f481eb34e4cdfe313bd62e3601333e61cb4e535100f9f52774e73ec6b",
+  "bytes": 5129972,
   "compiler": "rustc 1.96.0 (ac68faa20 2026-05-25)",
   "format": "wasm32-wasip1",
   "dependencies": [
@@ -742,6 +742,14 @@
         "licenses/cb5aedb296c5246d-LICENSE-MIT"
       ]
     },
+    {
+      "name": "xxhash-rust",
+      "version": "0.8.19",
+      "license": "BSL-1.0",
+      "notices": [
+        "licenses/c9bff75738922193-LICENSE"
+      ]
+    },
     {
       "name": "zerocopy",
       "version": "0.8.63",

package/wasm/licenses/c9bff75738922193-LICENSE

@@ -0,0 +1,23 @@
+Boost Software License - Version 1.0 - August 17th, 2003
+
+Permission is hereby granted, free of charge, to any person or organization
+obtaining a copy of the software and accompanying documentation covered by
+this license (the "Software") to use, reproduce, display, distribute,
+execute, and transmit the Software, and to prepare derivative works of the
+Software, and to permit third-parties to whom the Software is furnished to
+do so, all subject to the following:
+
+The copyright notices in the Software and this entire statement, including
+the above license grant, this restriction and the following disclaimer,
+must be included in all copies of the Software, in whole or in part, and
+all derivative works of the Software, unless such copies or derivative
+works are solely in the form of machine-executable object code generated by
+a source language processor.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
+SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
+FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
+ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+DEALINGS IN THE SOFTWARE.