@bespokeagentics/microdots-host 0.1.0

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/package.json

@@ -0,0 +1,25 @@
+{
+  "name": "@bespokeagentics/microdots-host",
+  "version": "0.1.0",
+  "description": "MicroDots host shell — registry, loader, slot manifest and placement checks for mounting MicroDot custom elements. Raw TypeScript source; consume with Bun or Vite.",
+  "type": "module",
+  "license": "Apache-2.0",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/qdhenry/BespokeAgenticsEffectfulMicroApps.git",
+    "directory": "packages/microdots-host"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "main": "./src/index.ts",
+  "exports": {
+    ".": "./src/index.ts"
+  },
+  "dependencies": {
+    "@bespokeagentics/microdots-element": "0.1.0"
+  },
+  "peerDependencies": {
+    "effect": "4.0.0-rc.108"
+  }
+}

package/src/index.ts

@@ -0,0 +1,144 @@
+/**
+ * `@bespokeagentics/microdots-host` — the half of a host that is not specific to any host.
+ *
+ * A host is a **role**, not an app: any page that mounts MicroDots. Three of
+ * them exist in this repo (`apps/host`, `apps/cross-origin-demo`,
+ * `apps/embedding-demo`) and the interesting one is a page outside it
+ * altogether. What they share is here; what makes each of them a particular
+ * demo — its registry rows, its route table, its markup — stays with the app.
+ *
+ * Extracted 2026-08-17 by
+ * `wiki/plans/shipped/microdots-framework-and-platform-separation.md`
+ * Phase D1. Before that, every function here closed over the demo host's own
+ * module-level data, which is why `apps/cross-origin-demo` had grown a
+ * registry-free re-implementation rather than importing one.
+ *
+ * Relative imports in this package carry explicit `.ts` extensions: since
+ * Phase 4 the workbench export pipeline value-imports this package, which puts
+ * it on a vite CONFIG's import chain — esbuild externalizes the bare
+ * specifier, so plain node loads these files via type-stripping, and node
+ * resolves relative TS imports only with the extension spelled out.
+ */
+export {
+  type MicroDotEntry,
+  type MicroDotRegistry,
+  apiUrlFor,
+  findEntry,
+} from './registry.ts'
+
+export {
+  type Placement,
+  type RouteDefinition,
+  type RouteTable,
+  allSectionIds,
+  findPlacement,
+  findRoute,
+  hrefFor,
+  makeRouteTable,
+  parseRoutePath,
+  routeForHash,
+  unroutedTags,
+} from './routes.ts'
+
+export {
+  createMicroDot,
+  createMicroDotFromEntry,
+  loadMicroDot,
+  mountMicroDot,
+  setMicroDotAttribute,
+} from './loader.ts'
+
+/**
+ * The wire record and its derivations — Phase 4 of
+ * `wiki/plans/active/microdots-platform-phase-programme.md`.
+ * The schema consts (`Wire`, `HostTopology`, …) carry their decoded Types
+ * under the same names. `PlacementCondition`, `PlacementSpan` and `RouteRule`
+ * are the Phase-5 widening — work items 2 and 3 of
+ * `wiki/plans/shipped/microdots-platform-phase-5-pages-design.md`.
+ */
+export {
+  type WireState,
+  deriveWireState,
+  HostTopology,
+  PlacementCondition,
+  PlacementSpan,
+  RouteRule,
+  TopologyHost,
+  TopologyOverview,
+  TopologyPlacement,
+  TopologyRoute,
+  topologyRouteTable,
+  Wire,
+  WireEnv,
+  WireTransform,
+  WireValueType,
+} from './wire.ts'
+
+/**
+ * The host slot manifest — Phase 5 work item 1: a host declaring, as data and
+ * versioned by theme, where MicroDots may go. Lives inside
+ * `host-topology.json` as `HostTopology.slotManifest`.
+ */
+export { HostSlotManifest, SlotKind, SlotSpec } from './slots.ts'
+
+/**
+ * Rules, THE matcher, and the reading-B resolution — Phase 5 work item 3.
+ * `ruleMatches` is the one matcher (ruling 1): the runtime resolution and the
+ * Pages screen's match counts both call it, and nothing else may reimplement
+ * it. `resolvePlacements` is the reading-B override resolution.
+ */
+export {
+  type PlacementOverride,
+  type PlacementSource,
+  type ResolvedCondition,
+  type ResolvedPlacement,
+  type ResolvedState,
+  conditionIntersection,
+  conditionLabel,
+  conditionsOverlap,
+  resolveCondition,
+  resolvePlacements,
+  ruleMatches,
+} from './rules.ts'
+
+/**
+ * The two steps between the resolution and the DOM, shared because both shells
+ * need both and apps must not import each other: `pendingMounts` (dedupe by
+ * tag as the pending list is built, never after) and `mountOverridesFor`
+ * (resume overrides dropped when empty BEFORE the merge).
+ */
+export { mountOverridesFor, pendingMounts } from './mounting.ts'
+
+/**
+ * The placement checks engine — Phase 5 work item 4: six of the spec's seven
+ * checks as a pure lint over the resolution's output (check 5 defers with
+ * anchors). Unverifiable checks are reported, never silently skipped.
+ */
+export {
+  type PlacementCheckContext,
+  type PlacementCheckId,
+  type PlacementCheckReport,
+  type PlacementCheckSeverity,
+  type PlacementIssue,
+  type UnverifiableCheck,
+  checkPlacements,
+} from './placementChecks.ts'
+
+/**
+ * The wire engine — the pure planner and its DOM adapter, also Phase 4.
+ * `attachWireEngine` writes only through `setMicroDotAttribute`.
+ */
+export {
+  type WireDelivery,
+  type WireEngine,
+  type WireEngineOptions,
+  type WireEventInput,
+  type WireOutcome,
+  type WirePlan,
+  type WireSkipReason,
+  type WireTrace,
+  type WireWrite,
+  applyTransform,
+  attachWireEngine,
+  planWires,
+} from './wireEngine.ts'

package/src/loader.ts

@@ -0,0 +1,119 @@
+import { type MicroDotEntry, apiUrlFor } from './registry.ts'
+
+/**
+ * Loads a MicroDot bundle and mounts an instance of its element.
+ *
+ * The bundle registers the custom element as a side effect of being imported,
+ * so a host only waits for the module and for `customElements.whenDefined`.
+ */
+export const loadMicroDot = async (
+  bundleUrl: string,
+  tag: string,
+): Promise<void> => {
+  if (customElements.get(tag) === undefined) {
+    await import(/* @vite-ignore */ bundleUrl)
+    await customElements.whenDefined(tag)
+  }
+}
+
+/**
+ * Creates a configured element WITHOUT a registry.
+ *
+ * The registry-free half, because a page that embeds exactly one MicroDot does
+ * not need a manifest — it needs the same two things every host needs: fetch the
+ * built bundle, then configure the element through attributes. `apps/host` uses
+ * `createMicroDotFromEntry` below; `apps/cross-origin-demo` uses this.
+ *
+ * `api-url` is set BEFORE the element enters the document: it is deliberately
+ * not an observed attribute, so `defineMicroDot` reads it once in
+ * `connectedCallback` and a later write goes nowhere.
+ *
+ * Every attribute given is written, blank ones included — a registry may
+ * deliberately declare `''`. Dropping blanks is a rule about OVERRIDES only; see
+ * `createMicroDotFromEntry`.
+ */
+export const createMicroDot = (
+  tag: string,
+  apiUrl: string,
+  attributes: Readonly<Record<string, string>> = {},
+): HTMLElement => {
+  const element = document.createElement(tag)
+  element.setAttribute('api-url', apiUrl)
+  Object.entries(attributes).forEach(([name, value]) => {
+    element.setAttribute(name, value)
+  })
+  return element
+}
+
+/**
+ * The registry-backed convenience: resolve the API URL from the entry, then
+ * apply the entry's attributes and any mount-time overrides.
+ *
+ * `overrides` is for attributes the host only knows at MOUNT time. The registry
+ * holds what a MicroDot always gets; this is for what depends on the browser it
+ * is being mounted into — a remembered interview id, say. Applied last so an
+ * override wins.
+ *
+ * **An EMPTY override is dropped before the merge, not after.** "I looked and
+ * found nothing" must leave the registry's value standing, and an override of
+ * `''` merged in first and filtered later would delete it instead. That
+ * distinction survived the D1 extraction only because
+ * `apps/host/src/loader.test.ts` asserts it — the first version of this function
+ * merged then filtered, and turned `symbol: 'FOLD'` into no symbol at all.
+ */
+export const createMicroDotFromEntry = (
+  entry: MicroDotEntry,
+  hostname: string = location.hostname,
+  overrides: Readonly<Record<string, string>> = {},
+): HTMLElement =>
+  createMicroDot(entry.tag, apiUrlFor(entry, hostname), {
+    ...entry.attributes,
+    ...Object.fromEntries(
+      Object.entries(overrides).filter(([, value]) => value !== ''),
+    ),
+  })
+
+/**
+ * Loads and mounts one MicroDot into a root a host already owns.
+ *
+ * `replaceChildren` rather than `appendChild`, because the root is a container
+ * the host handed over. **Never use this for a DOM anchor** — an anchored
+ * placement inserts adjacent to somebody else's element and must not own it.
+ * See `wiki/framework/mounting/anchor-mounting-into-host-owned-dom.md`.
+ */
+export const mountMicroDot = async ({
+  tag,
+  bundleUrl,
+  apiUrl,
+  root,
+}: {
+  readonly tag: string
+  readonly bundleUrl: string
+  readonly apiUrl: string
+  readonly root: HTMLElement
+}): Promise<HTMLElement> => {
+  await loadMicroDot(bundleUrl, tag)
+  const element = createMicroDot(tag, apiUrl)
+  root.replaceChildren(element)
+  return element
+}
+
+/**
+ * NOTE: `setAttribute` fires `attributeChangedCallback` even when the value is
+ * unchanged, so an unguarded write driven by a recurring event resets the
+ * MicroDot on every tick. **Always route host-driven writes through here.**
+ *
+ * This was the one function genuinely duplicated between `apps/host` and
+ * `apps/cross-origin-demo` — byte for byte, comment and all. Any wire-execution
+ * engine must keep the guard; see
+ * `wiki/framework/composition/wire-execution-and-transforms.md`.
+ */
+export const setMicroDotAttribute = (
+  element: Element,
+  name: string,
+  value: string,
+): void => {
+  if (element.getAttribute(name) !== value) {
+    element.setAttribute(name, value)
+  }
+}