Skip to content

Commit dfa96f0

Browse files
cowboydcowboyd
committed
Add framework integrations and demos for @bomb.sh/dom
1 parent ca7eae0 commit dfa96f0

57 files changed

Lines changed: 2672 additions & 23 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ pnpm playground # returns an example selector
1212

1313
## Projects
1414

15-
[`@bomb.sh/dom`](packages/dom/README.md) is a headless interactive DOM.
15+
[`@bomb.sh/dom`](packages/dom/README.md) is a headless interactive DOM. Its framework integrations and demos live in `examples/preact`, `examples/react`, `examples/solid`, `examples/lit`, `examples/svelte`, and `examples/crank`.
1616

1717
## Support
1818

‎examples/crank/README.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Crank with @bomb.sh/dom
2+
3+
This example owns its framework adapter, framework dependencies, and acceptance tests. The core DOM package has no framework runtime dependencies. The adapter uses the public `@bomb.sh/dom` exports and the same tree and event implementation as ordinary DOM callers.
4+
5+
Run `pnpm --filter @bomb.sh/dom build`, then `pnpm --filter @examples/dom-crank test`, `pnpm --filter @examples/dom-crank typecheck`, or `pnpm --filter @examples/dom-crank demo`.
6+
7+
The tested scope covers mounting, native event handlers, text identity, asynchronous updates in independent documents, and cleanup. Browser styling, hydration, and framework-specific browser APIs are not implied. See [framework boundaries](../../packages/dom/docs/frameworks.md).
8+
9+
Crank’s own context-event declarations reference browser event interfaces. This fixture includes the DOM type library locally so those upstream declarations can be checked; its adapter still accepts only `@bomb.sh/dom` nodes and never casts them to browser Node. No DOM library is added to the core or workspace configuration.
10+
11+
The generic Crank adapter exercises generator refreshes and generator cleanup. Raw HTML, hydration, and SVG/MathML namespace propagation are not implemented by this example. Native custom event props can use `on:ExactCase`; JSX-style built-in prop spellings are translated only in the adapter.

‎examples/crank/package.json‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
{
2+
"name": "@examples/dom-crank",
3+
"private": true,
4+
"license": "MIT",
5+
"type": "module",
6+
"exports": {
7+
".": "./src/index.ts"
8+
},
9+
"scripts": {
10+
"demo": "node --experimental-transform-types src/demo.ts",
11+
"typecheck": "tsgo --noEmit -p tsconfig.json",
12+
"test": "vitest run",
13+
"format": "bsh format",
14+
"format:check": "bsh format --check",
15+
"lint": "bsh lint"
16+
},
17+
"dependencies": {
18+
"@b9g/crank": "0.7.12",
19+
"@bomb.sh/dom": "workspace:*"
20+
},
21+
"devDependencies": {
22+
"@bomb.sh/tools": "^0.6.1",
23+
"@types/node": "^22",
24+
"@typescript/native-preview": "7.0.0-dev.20260623.1",
25+
"vitest": "^4.1.2"
26+
}
27+
}

‎examples/crank/src/demo.ts‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
import { Document } from '@bomb.sh/dom';
2+
import { createElement as h } from '@b9g/crank';
3+
import { createRoot } from './index.ts';
4+
5+
const document = new Document();
6+
const container = document.appendChild(document.createElement('box'));
7+
const root = createRoot(container);
8+
await root.render(h('text', null, 'Hello from Crank'));
9+
console.info(container.textContent);
10+
await root.unmount();

‎examples/crank/src/index.ts‎

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
/* oxlint-disable bombshell-dev/no-generic-error -- Reject invalid host callback values with standard TypeError exceptions. */
2+
/* oxlint-disable bombshell-dev/exported-function-async -- Framework mounting and host factories are synchronous by contract. */
3+
import { Renderer, type Children, type ElementValue } from '@b9g/crank';
4+
import { Element, Text, type Node } from '@bomb.sh/dom';
5+
import { updateHostProperties } from './properties.ts';
6+
7+
/** Crank's generic reconciler using the same native tree as all other adapters. */
8+
const renderer = new Renderer<Node, null, Element>({
9+
create({ tag, root }) {
10+
if (!root) throw new TypeError('A Crank container is required');
11+
if (typeof tag !== 'string') throw new TypeError('Unsupported Crank host tag');
12+
return root.ownerDocument.createElement(tag);
13+
},
14+
text({ value, oldNode, root }) {
15+
if (oldNode instanceof Text) {
16+
oldNode.data = value;
17+
return oldNode;
18+
}
19+
if (!root) throw new TypeError('A Crank container is required');
20+
return root.ownerDocument.createTextNode(value);
21+
},
22+
patch({ node, props, oldProps }) {
23+
if (!(node instanceof Element)) throw new TypeError('Expected an Element');
24+
updateHostProperties(node, oldProps ?? {}, props);
25+
},
26+
arrange({ node, children }) {
27+
let anchor = node.firstChild;
28+
for (const child of children) {
29+
if (child === anchor) anchor = anchor.nextSibling;
30+
else node.insertBefore(child, anchor);
31+
}
32+
},
33+
remove({ node, parentNode, isNested }) {
34+
if (!isNested && node.parentNode === parentNode) parentNode.removeChild(node);
35+
},
36+
raw({ value }) {
37+
if (typeof value === 'string')
38+
throw new TypeError('Raw markup is not supported by this adapter');
39+
return value;
40+
},
41+
});
42+
43+
export interface Root extends AsyncDisposable {
44+
readonly element: Element;
45+
render(children: Children): Promise<ElementValue<Node>>;
46+
unmount(): Promise<void>;
47+
}
48+
49+
/** Mount Crank generator components into an existing native element. */
50+
export function createRoot(element: Element): Root {
51+
return {
52+
element,
53+
async render(children) {
54+
return renderer.render(children, element);
55+
},
56+
async unmount() {
57+
await renderer.render(null, element);
58+
},
59+
async [Symbol.asyncDispose]() {
60+
await this.unmount();
61+
},
62+
};
63+
}

‎examples/crank/src/properties.ts‎

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
/* oxlint-disable bombshell-dev/max-params -- These callbacks match framework host property signatures. */
2+
/* oxlint-disable bombshell-dev/exported-function-async -- Framework property mutation must complete in the caller’s synchronous update. */
3+
/* oxlint-disable bombshell-dev/no-generic-error -- Unsupported prop values fail with TypeError at the adapter boundary. */
4+
import type { Element } from '@bomb.sh/dom';
5+
import type { Event } from '@bomb.sh/dom';
6+
7+
const handlers = new WeakMap<Element, Map<string, (event: Event) => void>>();
8+
9+
/** Translate framework prop spelling at the adapter boundary, never in the DOM. */
10+
export function setHostProperty(element: Element, name: string, value: unknown): void {
11+
if (name === 'children' || name === 'ref' || name === 'key') return;
12+
if (name.startsWith('on')) {
13+
let eventName = name.startsWith('on:') ? name.slice(3) : name.slice(2);
14+
const capture = !name.startsWith('on:') && eventName.endsWith('Capture');
15+
if (capture) eventName = eventName.slice(0, -7);
16+
if (!name.startsWith('on:') && /^[A-Z]/.test(eventName)) eventName = eventName.toLowerCase();
17+
let registered = handlers.get(element);
18+
const previous = registered?.get(name);
19+
if (previous) element.removeEventListener(eventName, previous, capture);
20+
registered?.delete(name);
21+
if (typeof value === 'function') {
22+
if (!registered) handlers.set(element, (registered = new Map()));
23+
const listener = (event: Event): void => {
24+
value.call(element, event);
25+
};
26+
registered.set(name, listener);
27+
element.addEventListener(eventName, listener, capture);
28+
}
29+
return;
30+
}
31+
if (name === 'style' || name === 'dangerouslySetInnerHTML') {
32+
throw new TypeError(`${name} is not supported by this framework adapter`);
33+
}
34+
if (name === 'className') name = 'class';
35+
if (name === 'value' && 'value' in element) {
36+
Reflect.set(element, 'value', value ?? '');
37+
return;
38+
}
39+
if (
40+
value === null ||
41+
value === undefined ||
42+
(value === false && !name.startsWith('data-') && !name.startsWith('aria-'))
43+
)
44+
element.removeAttribute(name);
45+
else element.setAttribute(name, value === true ? '' : String(value));
46+
}
47+
48+
/** Apply removed and changed framework props to a native element. */
49+
export function updateHostProperties(
50+
element: Element,
51+
previous: Readonly<Record<string, unknown>>,
52+
next: Readonly<Record<string, unknown>>,
53+
): void {
54+
for (const name of Object.keys(previous))
55+
if (!(name in next)) setHostProperty(element, name, undefined);
56+
for (const [name, value] of Object.entries(next)) {
57+
if (previous[name] !== value) setHostProperty(element, name, value);
58+
}
59+
}

‎examples/crank/test/crank.test.ts‎

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
import assert from 'node:assert/strict';
2+
import { createElement as h, type Context, type Element as CrankElement } from '@b9g/crank';
3+
import { describe, expect, it } from 'vitest';
4+
import { Document, Element, Text } from '@bomb.sh/dom';
5+
import { Event } from '@bomb.sh/dom';
6+
import { createRoot } from '../src/index.ts';
7+
8+
describe('actual Crank', () => {
9+
it('runs generator components, refreshes asynchronously, and cleans up without globals', async () => {
10+
const documents = [new Document(), new Document()];
11+
await using first = createRoot(documents[0]!.createElement('box'));
12+
await using second = createRoot(documents[1]!.createElement('box'));
13+
const refreshes: Array<() => void> = [];
14+
const cleanups: number[] = [];
15+
function* Counter(
16+
this: Context<{ index: number }>,
17+
{ index }: { index: number },
18+
): Generator<CrankElement> {
19+
let count = 0;
20+
refreshes[index] = () => {
21+
count++;
22+
void this.refresh();
23+
};
24+
this.cleanup(() => {
25+
cleanups.push(index);
26+
});
27+
for (const _ of this) yield h('text', null, count);
28+
}
29+
await Promise.all([
30+
first.render(h(Counter, { index: 0 })),
31+
second.render(h(Counter, { index: 1 })),
32+
]);
33+
const original = first.element.firstChild;
34+
assert.ok(original instanceof Element);
35+
const content = original.firstChild;
36+
assert.ok(content instanceof Text);
37+
await Promise.resolve();
38+
refreshes[0]?.();
39+
refreshes[1]?.();
40+
await expect.poll(() => first.element.textContent).toBe('1');
41+
await expect.poll(() => second.element.textContent).toBe('1');
42+
expect(first.element.firstChild).toBe(original);
43+
expect(original.firstChild).toBe(content);
44+
expect(content.ownerDocument).toBe(documents[0]);
45+
expect(second.element.firstChild?.ownerDocument).toBe(documents[1]);
46+
await first.unmount();
47+
await second.unmount();
48+
expect(cleanups).toEqual([0, 1]);
49+
expect(first.element.childNodes).toHaveLength(0);
50+
expect(globalThis).not.toHaveProperty('document');
51+
});
52+
53+
it('reorders keyed nodes and replaces native event handlers', async () => {
54+
const document = new Document();
55+
await using root = createRoot(document.createElement('box'));
56+
const calls: string[] = [];
57+
const rows = (names: string[], label: string): CrankElement[] =>
58+
names.map((name) =>
59+
h(
60+
'text',
61+
{
62+
key: name,
63+
onClick: () => calls.push(label),
64+
},
65+
name,
66+
),
67+
);
68+
await root.render(rows(['a', 'b', 'c'], 'before'));
69+
const original = [...root.element.childNodes];
70+
await root.render(rows(['c', 'a'], 'after'));
71+
expect(root.element.childNodes).toEqual([original[2], original[0]]);
72+
root.element.firstChild?.dispatchEvent(new Event('click'));
73+
expect(calls).toEqual(['after']);
74+
});
75+
});

‎examples/crank/tsconfig.json‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
{
2+
"extends": "@bomb.sh/tools/tsconfig.json",
3+
"compilerOptions": {
4+
"composite": false,
5+
"types": ["node"],
6+
"lib": ["ESNext", "DOM"],
7+
"skipLibCheck": false
8+
},
9+
"include": ["src/**/*.ts", "test/**/*.ts"]
10+
}

‎examples/dom-realm/README.md‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Persistent framework fixture realms
2+
3+
This private example package supplies the explicit bootstrap boundary used by the Lit and Svelte examples. Each `FixtureRealm` receives an existing `@bomb.sh/dom` document and creates a persistent Node `vm` context. The context exposes that document's custom-element registry and HTMLElement constructor, the actual DOM node/event constructors, a window event target, timers, and microtasks. Parsing is explicitly installed for template creation.
4+
5+
`bundleFixture()` uses esbuild's browser export condition and bundles the framework together with the example entry. Running that bundle separately in each context gives every document its own framework module state. Promises and callbacks retain their original context during later updates. Nothing installs or swaps the host process's `document`, `window`, or constructors.
6+
7+
The context uses the same DOM nodes as the host; it creates no second tree. It is a bootstrap example for trusted local modules, not an untrusted-code sandbox, browser API implementation, or script execution facility exported by the DOM package. It does not supply layout, stylesheet rendering, navigation, networking, or browser default input actions.
8+
9+
The adapter's TypeScript API accepts the package's actual `Document`, and code evaluation returns `unknown`. Framework browser modules are bundled JavaScript. This boundary does not claim that the package's public types structurally implement the complete browser `HTMLElement` expected by Lit or Svelte declarations.
10+
11+
Dependencies: `@bomb.sh/dom` provides the one tree; esbuild selects and bundles the browser framework modules; Node's built-in `vm` retains their separate lexical environments. No worker, browser process, CommonJS output, or framework code is added to the core package.
12+
13+
See [Node VM contexts](https://nodejs.org/api/vm.html#vmcreatecontextcontextobject-options). The DOM `window` facade here is deliberately limited to the capabilities exposed in `src/index.ts`.

‎examples/dom-realm/package.json‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
{
2+
"name": "@examples/dom-realm",
3+
"private": true,
4+
"license": "MIT",
5+
"type": "module",
6+
"exports": {
7+
".": "./src/index.ts"
8+
},
9+
"scripts": {
10+
"typecheck": "tsgo --noEmit -p tsconfig.json",
11+
"format": "bsh format",
12+
"format:check": "bsh format --check",
13+
"lint": "bsh lint"
14+
},
15+
"dependencies": {
16+
"@bomb.sh/dom": "workspace:*",
17+
"esbuild": "^0.27.0"
18+
},
19+
"devDependencies": {
20+
"@bomb.sh/tools": "^0.6.1",
21+
"@types/node": "^22",
22+
"@typescript/native-preview": "7.0.0-dev.20260623.1"
23+
}
24+
}

0 commit comments

Comments
 (0)