@oddkin/workbench 0.0.0-stage → 1.0.0-beta.1

package/dist/testing/index.js

@@ -0,0 +1,145 @@
+/**
+ * `@oddkin/workbench/testing` — run examples and conformance suites inside the project's own
+ * browser test runner. The runner's `expect` and user-input API are passed in, so this entry
+ * depends on no test framework. Contract: change-impact-and-verification.md §3.
+ */
+import { createScope, scopeStats } from '@oddkin/core/scope';
+import { render } from '@oddkin/core/template';
+import { exampleId } from '../examples/index.js';
+/** Default adapter: anatomy roles are named parts (`part~="role"`) in the shadow root. */
+export const partAdapter = {
+    part: (host, role) => host.shadowRoot?.querySelector(`[part~="${role}"]`) ?? null,
+    settle: async (host) => {
+        await host.updateComplete;
+    },
+};
+/**
+ * Run every case of `suite` against `options.tag`. Each case gets a fresh container that is
+ * removed afterwards. Failures are recorded, not thrown.
+ */
+export async function runConformance(suite, options) {
+    if (!customElements.get(options.tag)) {
+        throw new Error(`runConformance: <${options.tag}> is not registered.`);
+    }
+    const adapter = options.adapter ?? partAdapter;
+    const results = [];
+    for (const testCase of suite.cases) {
+        if (options.only && !options.only.includes(testCase.id)) {
+            results.push({ case: testCase.id, state: 'not-executed' });
+            continue;
+        }
+        const container = document.createElement('div');
+        document.body.append(container);
+        const context = {
+            tag: options.tag,
+            expect: options.expect,
+            user: options.user,
+            adapter,
+            async mount(mount = {}) {
+                const element = document.createElement(options.tag);
+                for (const [name, value] of Object.entries(mount.attributes ?? {}))
+                    element.setAttribute(name, value);
+                if (mount.content)
+                    element.innerHTML = mount.content;
+                if (mount.within) {
+                    container.innerHTML = mount.within.replace('{{element}}', '<template data-slot></template>');
+                    container.querySelector('template[data-slot]').replaceWith(element);
+                }
+                else
+                    container.append(element);
+                await adapter.settle(element);
+                return element;
+            },
+            ownedWork: () => ({ ...scopeStats() }),
+            nextTask: () => new Promise((resolve) => setTimeout(resolve, 0)),
+        };
+        try {
+            await testCase.run(context);
+            results.push({ case: testCase.id, state: 'passed' });
+        }
+        catch (error) {
+            results.push({
+                case: testCase.id,
+                state: 'failed',
+                message: error instanceof Error ? error.message : String(error),
+            });
+        }
+        finally {
+            container.remove();
+        }
+    }
+    return {
+        schema: 'https://oddkin.dev/schemas/conformance-result/v1.json',
+        suite: { id: suite.id, version: suite.version },
+        implementation: { tag: options.tag, ...options.implementation },
+        configuration: { ...options.configuration },
+        environment: { userAgent: navigator.userAgent },
+        date: new Date().toISOString(),
+        results,
+    };
+}
+/**
+ * Mount one authored example the way a preview frame does: create the registered element, set
+ * its attributes, properties, and slot text, connect it, then run its fixture. The tag (and any
+ * element the fixture uses) must already be registered.
+ */
+export async function mountExample(set, name, container = document.body) {
+    const example = set.examples[name];
+    if (!example)
+        throw new Error(`mountExample: <${set.component}> has no example "${name}".`);
+    if (!customElements.get(set.component)) {
+        throw new Error(`mountExample: <${set.component}> is not registered.`);
+    }
+    const id = exampleId(set.component, name);
+    const root = document.createElement('div');
+    root.dataset['example'] = id;
+    container.append(root);
+    const element = document.createElement(set.component);
+    for (const [attribute, value] of Object.entries(example.attributes ?? {}))
+        if (value !== null)
+            element.setAttribute(attribute, value);
+    Object.assign(element, example.props ?? {});
+    for (const [slot, text] of Object.entries(example.slots ?? {})) {
+        if (slot === 'default')
+            element.append(text);
+        else {
+            const span = document.createElement('span');
+            span.slot = slot;
+            span.textContent = text;
+            element.append(span);
+        }
+    }
+    root.append(element);
+    const scope = createScope({ name: id });
+    const parts = [];
+    try {
+        await example.fixture?.({
+            scope,
+            element,
+            mount(content) {
+                const host = document.createElement('div');
+                root.append(host);
+                parts.push(render(content, host));
+                return host.firstElementChild ?? host;
+            },
+        });
+        await element.updateComplete;
+    }
+    catch (error) {
+        scope.dispose();
+        root.remove();
+        throw error;
+    }
+    return {
+        element,
+        root,
+        scope,
+        dispose() {
+            scope.dispose();
+            for (const part of parts)
+                part.dispose();
+            root.remove();
+        },
+    };
+}
+//# sourceMappingURL=index.js.map

package/dist/testing/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/testing/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,OAAO,EAAE,WAAW,EAAE,UAAU,EAAc,MAAM,oBAAoB,CAAC;AACzE,OAAO,EAAE,MAAM,EAAkB,MAAM,uBAAuB,CAAC;AAW/D,OAAO,EAAE,SAAS,EAAmB,MAAM,sBAAsB,CAAC;AAElE,0FAA0F;AAC1F,MAAM,CAAC,MAAM,WAAW,GAAY;IAClC,IAAI,EAAE,CAAC,IAAI,EAAE,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,UAAU,EAAE,aAAa,CAAc,WAAW,IAAI,IAAI,CAAC,IAAI,IAAI;IAC9F,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE;QACrB,MAAO,IAAyD,CAAC,cAAc,CAAC;IAClF,CAAC;CACF,CAAC;AAeF;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,cAAc,CAClC,KAAuB,EACvB,OAA8B;IAE9B,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC;QACrC,MAAM,IAAI,KAAK,CAAC,oBAAoB,OAAO,CAAC,GAAG,sBAAsB,CAAC,CAAC;IACzE,CAAC;IACD,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,IAAI,WAAW,CAAC;IAC/C,MAAM,OAAO,GAAiB,EAAE,CAAC;IACjC,KAAK,MAAM,QAAQ,IAAI,KAAK,CAAC,KAAK,EAAE,CAAC;QACnC,IAAI,OAAO,CAAC,IAAI,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC,EAAE,CAAC;YACxD,OAAO,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,QAAQ,CAAC,EAAE,EAAE,KAAK,EAAE,cAAc,EAAE,CAAC,CAAC;YAC3D,SAAS;QACX,CAAC;QACD,MAAM,SAAS,GAAG,QAAQ,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;QAChD,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;QAChC,MAAM,OAAO,GAAuB;YAClC,GAAG,EAAE,OAAO,CAAC,GAAG;YAChB,MAAM,EAAE,OAAO,CAAC,MAAM;YACtB,IAAI,EAAE,OAAO,CAAC,IAAI;YAClB,OAAO;YACP,KAAK,CAAC,KAAK,CAAC,KAAK,GAAiB,EAAE;gBAClC,MAAM,OAAO,GAAG,QAAQ,CAAC,aAAa,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;gBACpD,KAAK,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,UAAU,IAAI,EAAE,CAAC;oBAChE,OAAO,CAAC,YAAY,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;gBACpC,IAAI,KAAK,CAAC,OAAO;oBAAE,OAAO,CAAC,SAAS,GAAG,KAAK,CAAC,OAAO,CAAC;gBACrD,IAAI,KAAK,CAAC,MAAM,EAAE,CAAC;oBACjB,SAAS,CAAC,SAAS,GAAG,KAAK,CAAC,MAAM,CAAC,OAAO,CACxC,aAAa,EACb,iCAAiC,CAClC,CAAC;oBACF,SAAS,CAAC,aAAa,CAAC,qBAAqB,CAAE,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;gBACvE,CAAC;;oBAAM,SAAS,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;gBACjC,MAAM,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;gBAC9B,OAAO,OAAO,CAAC;YACjB,CAAC;YACD,SAAS,EAAE,GAAG,EAAE,CAAC,CAAC,EAAE,GAAG,UAAU,EAAE,EAAE,CAAC;YACtC,QAAQ,EAAE,GAAG,EAAE,CAAC,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC;SACjE,CAAC;QACF,IAAI,CAAC;YACH,MAAM,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;YAC5B,OAAO,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,QAAQ,CAAC,EAAE,EAAE,KAAK,EAAE,QAAQ,EAAE,CAAC,CAAC;QACvD,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,OAAO,CAAC,IAAI,CAAC;gBACX,IAAI,EAAE,QAAQ,CAAC,EAAE;gBACjB,KAAK,EAAE,QAAQ;gBACf,OAAO,EAAE,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC;aAChE,CAAC,CAAC;QACL,CAAC;gBAAS,CAAC;YACT,SAAS,CAAC,MAAM,EAAE,CAAC;QACrB,CAAC;IACH,CAAC;IACD,OAAO;QACL,MAAM,EAAE,uDAAuD;QAC/D,KAAK,EAAE,EAAE,EAAE,EAAE,KAAK,CAAC,EAAE,EAAE,OAAO,EAAE,KAAK,CAAC,OAAO,EAAE;QAC/C,cAAc,EAAE,EAAE,GAAG,EAAE,OAAO,CAAC,GAAG,EAAE,GAAG,OAAO,CAAC,cAAc,EAAE;QAC/D,aAAa,EAAE,EAAE,GAAG,OAAO,CAAC,aAAa,EAAE;QAC3C,WAAW,EAAE,EAAE,SAAS,EAAE,SAAS,CAAC,SAAS,EAAE;QAC/C,IAAI,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;QAC9B,OAAO;KACR,CAAC;AACJ,CAAC;AAaD;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,YAAY,CAChC,GAAkB,EAClB,IAAY,EACZ,SAAS,GAAgB,QAAQ,CAAC,IAAI;IAEtC,MAAM,OAAO,GAAG,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;IACnC,IAAI,CAAC,OAAO;QAAE,MAAM,IAAI,KAAK,CAAC,kBAAkB,GAAG,CAAC,SAAS,qBAAqB,IAAI,IAAI,CAAC,CAAC;IAC5F,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,GAAG,CAAC,SAAS,CAAC,EAAE,CAAC;QACvC,MAAM,IAAI,KAAK,CAAC,kBAAkB,GAAG,CAAC,SAAS,sBAAsB,CAAC,CAAC;IACzE,CAAC;IACD,MAAM,EAAE,GAAG,SAAS,CAAC,GAAG,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC;IAC1C,MAAM,IAAI,GAAG,QAAQ,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;IAC3C,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,GAAG,EAAE,CAAC;IAC7B,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IACvB,MAAM,OAAO,GAAG,QAAQ,CAAC,aAAa,CAAC,GAAG,CAAC,SAAS,CAAiB,CAAC;IACtE,KAAK,MAAM,CAAC,SAAS,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,UAAU,IAAI,EAAE,CAAC;QACvE,IAAI,KAAK,KAAK,IAAI;YAAE,OAAO,CAAC,YAAY,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;IAC7D,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,OAAO,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC;IAC5C,KAAK,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,KAAK,IAAI,EAAE,CAAC,EAAE,CAAC;QAC/D,IAAI,IAAI,KAAK,SAAS;YAAE,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;aACxC,CAAC;YACJ,MAAM,IAAI,GAAG,QAAQ,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;YAC5C,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;YACjB,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC;YACxB,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QACvB,CAAC;IACH,CAAC;IACD,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IACrB,MAAM,KAAK,GAAG,WAAW,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,CAAC;IACxC,MAAM,KAAK,GAAgB,EAAE,CAAC;IAC9B,IAAI,CAAC;QACH,MAAM,OAAO,CAAC,OAAO,EAAE,CAAC;YACtB,KAAK;YACL,OAAO;YACP,KAAK,CAAC,OAAO;gBACX,MAAM,IAAI,GAAG,QAAQ,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;gBAC3C,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;gBAClB,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC,CAAC;gBAClC,OAAO,IAAI,CAAC,iBAAiB,IAAI,IAAI,CAAC;YACxC,CAAC;SACF,CAAC,CAAC;QACH,MAAO,OAAwD,CAAC,cAAc,CAAC;IACjF,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,KAAK,CAAC,OAAO,EAAE,CAAC;QAChB,IAAI,CAAC,MAAM,EAAE,CAAC;QACd,MAAM,KAAK,CAAC;IACd,CAAC;IACD,OAAO;QACL,OAAO;QACP,IAAI;QACJ,KAAK;QACL,OAAO;YACL,KAAK,CAAC,OAAO,EAAE,CAAC;YAChB,KAAK,MAAM,IAAI,IAAI,KAAK;gBAAE,IAAI,CAAC,OAAO,EAAE,CAAC;YACzC,IAAI,CAAC,MAAM,EAAE,CAAC;QAChB,CAAC;KACF,CAAC;AACJ,CAAC"}

package/package.json

@@ -1,6 +1,120 @@
 {
   "name": "@oddkin/workbench",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "1.0.0-beta.1",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/brianchristopherbrady/oddkin.git",
+    "directory": "packages/workbench"
+  },
+  "description": "Metadata-driven documentation tooling. DOM-free example, configuration, page-registry, data-file, and conformance contracts; a test-runner integration.",
+  "type": "module",
+  "sideEffects": [
+    "./dist/app/define.js",
+    "./dist/frame/index.js",
+    "./dist/panels/component-define.js",
+    "./dist/panels/foundation-define.js",
+    "./dist/panels/catalog-define.js"
+  ],
+  "engines": {
+    "node": ">=24.12"
+  },
+  "bin": {
+    "oddkin": "dist/node/bin.js"
+  },
+  "exports": {
+    "./examples": {
+      "types": "./dist/examples/index.d.ts",
+      "default": "./dist/examples/index.js"
+    },
+    "./config": {
+      "types": "./dist/config/index.d.ts",
+      "default": "./dist/config/index.js"
+    },
+    "./pages": {
+      "types": "./dist/pages/index.d.ts",
+      "default": "./dist/pages/index.js"
+    },
+    "./data": {
+      "types": "./dist/data/index.d.ts",
+      "default": "./dist/data/index.js"
+    },
+    "./node": {
+      "types": "./dist/node/index.d.ts",
+      "default": "./dist/node/index.js"
+    },
+    "./app": {
+      "types": "./dist/app/index.d.ts",
+      "default": "./dist/app/index.js"
+    },
+    "./app/define": {
+      "types": "./dist/app/define.d.ts",
+      "default": "./dist/app/define.js"
+    },
+    "./conformance": {
+      "types": "./dist/conformance/index.d.ts",
+      "default": "./dist/conformance/index.js"
+    },
+    "./conformance/button": {
+      "types": "./dist/conformance/button.d.ts",
+      "default": "./dist/conformance/button.js"
+    },
+    "./testing": {
+      "types": "./dist/testing/index.d.ts",
+      "default": "./dist/testing/index.js"
+    },
+    "./preview": {
+      "types": "./dist/preview/index.d.ts",
+      "default": "./dist/preview/index.js"
+    },
+    "./protocol": {
+      "types": "./dist/protocol/index.d.ts",
+      "default": "./dist/protocol/index.js"
+    },
+    "./frame": {
+      "types": "./dist/frame/index.d.ts",
+      "default": "./dist/frame/index.js"
+    },
+    "./panels/component": {
+      "types": "./dist/panels/component.d.ts",
+      "default": "./dist/panels/component.js"
+    },
+    "./panels/component/define": {
+      "types": "./dist/panels/component-define.d.ts",
+      "default": "./dist/panels/component-define.js"
+    },
+    "./panels/foundation": {
+      "types": "./dist/panels/foundation.d.ts",
+      "default": "./dist/panels/foundation.js"
+    },
+    "./panels/foundation/define": {
+      "types": "./dist/panels/foundation-define.d.ts",
+      "default": "./dist/panels/foundation-define.js"
+    },
+    "./panels/catalog": {
+      "types": "./dist/panels/catalog.d.ts",
+      "default": "./dist/panels/catalog.js"
+    },
+    "./panels/catalog/define": {
+      "types": "./dist/panels/catalog-define.d.ts",
+      "default": "./dist/panels/catalog-define.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "dependencies": {
+    "@oddkin/analyzer": "^1.0.0-beta.1",
+    "@oddkin/app": "^1.0.0-beta.1",
+    "@oddkin/components": "^1.0.0-beta.1",
+    "@oddkin/core": "^1.0.0-beta.1",
+    "@oddkin/state": "^1.0.0-beta.1",
+    "@oddkin/tokens": "^1.0.0-beta.1"
+  },
+  "publishConfig": {
+    "access": "public",
+    "tag": "beta"
+  }
+}