History

Doxa Maps 8ec207c662 My coalescing broke the echo guard it ran past rega, row 50: a region row click emitted {region:"asia"} and then an EMPTY event, identically on both engines. The grid stayed narrowed only because the composite's 1.2 second push window happened to swallow the second one — and a pass that depends on a swallow is not a pass. rega said so, and was right to refuse to score it green. THE CAUSE IS MINE AND IT IS NOT A TIMING QUIRK. emitFilterState has always opened with `if (applyingExternal) return`: when the HOST pushes state DOWN through externalFilters the store changes, and reporting that back up is an echo of the host's own instruction. That guard worked because the emit ran SYNCHRONOUSLY inside the watcher, while the flag was still set. My coalescing moved the emit 60ms later, and applyingExternal is released on nextTick — so by the time the emit ran the flag was false and the echo went out. I fixed a burst and broke a guard that depended on the burst's timing. Changing WHEN something runs is a change to everything that depended on when, and I did not re-read what else was standing on that synchrony. So the decision moves to schedule time, where the flag still means what it says: a change that arrived from the host is not a change the reader made, and is not reported back. The check inside emitFilterState stays as a second line of defence. This is the same shape as the dialect case on the branch below, and it is why that one is a guard rather than a longer timeout: both are "the emit is no longer where it thought it was". ★ AND THE GATE CAUGHT THE SAME HOLE IN ITSELF FOR THE THIRD TIME. The assertion searched the scheduler for `if (applyingExternal) return`, and the comment explaining the fix QUOTES that line — so deleting the code left the gate green. It strips comments before asserting now. A check its own documentation can satisfy is not a check, and I have now written that mistake three different ways: a probe that yields zero when its assumption is wrong, a mutation aimed at one of three identical bindings, and this. Source only, stacked on sr/dialect-empty-cascade. STUDIO: rebuild doxa-research-map (the same rebuild that branch already needs).		2026-09-26 22:06:58 +00:00
..
all-people-groups	Three maps asked the window which engine drew them; now they ask the map	2026-09-26 17:28:46 +00:00
big-picture	Big Picture: the live count speaks, and the locale reaches the children	2026-09-26 22:06:58 +00:00
cities-internet	Cities with Internet: the basemap's place names follow the reader's language	2026-09-26 18:26:38 +00:00
country-posters	Country posters: the map's loading and error lines speak the reader's language	2026-09-26 16:55:14 +00:00
dashboard-plus-grid	Decouple prose: no go-base / nuxtbase / nuxtinator / doxa-base names in plugin comments and docs	2026-09-26 17:28:45 +00:00
demo-map	C2: one library helper for per-engine projection, across 12 call sites in 9 plugins	2026-09-26 08:39:53 +00:00
doxa-maps-spa	Decouple prose: no go-base / nuxtbase / nuxtinator / doxa-base names in plugin comments and docs	2026-09-26 17:28:45 +00:00
doxa-research-map	My coalescing broke the echo guard it ran past	2026-09-26 22:06:58 +00:00
doxa-simple-map	Six entries hand-rolled the RTL text plugin; the library already installs it	2026-09-26 13:35:57 +00:00
doxa-vision-card	Doxa Vision Card: take the page language from profile-config lang as well as locale	2026-09-26 01:10:51 +00:00
golden-path-check	golden-path-check: walk the develop-a-plugin-and-see-it-live path end to end	2026-09-22 03:55:18 +00:00
gospel-resources	C4 wave 3a, gospel-resources: four guards share one, English unchanged	2026-09-26 22:06:58 +00:00
key-cities	Key Cities (gated): the map, list, tables and posters speak the reader's language	2026-09-26 03:34:30 +00:00
my-upg-100-list	The selection packet names the territories in the order the reader picked them	2026-09-26 18:43:38 +00:00
people-groups-grid	"Arabic" is 23 ISO codes, not 22	2026-09-26 18:38:20 +00:00
plugin-studio	Plugin Studio rail laid out like plugin-designs/: one folder per bundle, its elements inside	2026-09-26 12:23:49 +00:00
pplr-data-maps	One guarded translator, and the fallback catalogue nobody needed	2026-09-26 22:06:57 +00:00
prayer-walk-planner	Export gate reads the tree name from the build config	2026-09-25 21:32:35 +00:00
regions-dashboard	Register the embedder-key gate so it can actually run	2026-09-26 17:10:06 +00:00
research-dashboard	The legends mirror now, and their labels never became their values	2026-09-26 22:06:58 +00:00
research-map-plus-grid	"Arabic" is 23 ISO codes, not 22	2026-09-26 18:38:20 +00:00
stack-demo	Decouple prose: no go-base / nuxtbase / nuxtinator / doxa-base names in plugin comments and docs	2026-09-26 17:28:45 +00:00
template-bundle	template-bundle: the starter's first screen is now a real map	2026-09-26 04:38:12 +00:00
upg-neighbor	One guarded translator, and the fallback catalogue nobody needed	2026-09-26 22:06:57 +00:00
wall-of-people-groups	One pinned-UMD loader for PPLR and the Wall: library/utils/loadPinnedUmd.js	2026-09-26 07:24:25 +00:00
.gitkeep	Rename app-profiles -> plugin-designs; build green under new naming (load-bearing paths updated, guards pass)	2026-09-17 18:18:18 +00:00
README.md	plugin-designs/README: the tree is dx-maps, and a bundle's tag is its folder name	2026-09-26 01:19:53 +00:00

README.md

plugin-designs/ — where YOUR maps live

The shared template lives in ../library/ (aliased @map) — you never edit it per-map. You build your map by making a folder here, plugin-designs/<your-map>/, and composing the template's building blocks. Your folder is yours (colors, API, i18n); the template is shared (Apache-2.0, propagated to every map on the next build).

Shared vs. yours — the balance

  library/  (@map)  ── SHARED, reusable, parameterized ──►  legend · map · map-controls
        │                                                    (every map reuses these)
        │  imported by
        ▼
  plugin-designs/<your-map>/  ── YOURS ──►  the map's "main" class (the .vue profile = the Vue
        │                                  instance for that map)
        └── src/            ── YOURS ──►  this map's OWN non-reusable components, colors, API, utils

  One bundle can hold as many maps as you want — add another .vue profile and rebuild.

Reusable → library/. The legend, the map, the map-controls are shared, parameterized components every map reuses. Fix once, every map benefits. Never edit it to customize one map.
This map's own → plugin-designs/<your-map>/. It holds two things: the map's "main" class (each .vue profile is the Vue instance for that map) and that map's own non-reusable components (in src/). Nothing here leaks to another map.
Many maps per bundle. The bundler bundles one map or many — add another flat .vue and rebuild.

Production or experimental — every profile declares itself

Every app profile is one of two things, and experimental profiles are unlimited and encouraged — create as many as you need:

Experimental, not built: prefix the folder with _ — the build skips it; it just sits in code. Zero cost, zero risk.
Experimental, built: builds normally, but it belongs in the Experimental section of the power app's layout (nav section) — never embedded on partner surfaces.
Production: a real product — main sections of the power app + individually embeddable.

(The power app = the SPA layout that composes all profiles into one application.)

The pattern in one picture

plugin-designs/<your-map>/     ← one FOLDER = one BUNDLE, named after the folder
   ├── index.js               ← entry: registers the custom element, finds the profiles
   ├── overview.vue           ← one .vue = one PROFILE (flat in the folder — no profiles/ subfolder)
   └── detail.vue             ← another profile in the SAME bundle

     builds to ─────────────► public/dx-maps/<your-map>/<your-map>.js   (one file)

Folder name = bundle name. Folders starting with _ or . are skipped (handy for WIP).
Each .vue = one profile (one map screen). One bundle can hold many.
Pick the profile at embed time with the profile field — every profile shares one bundle:

<script src="/dx-maps/<your-map>/<your-map>.js"></script>
<your-map profile-config='{"profile":"overview","tk":"pk.eyJ..."}'></your-map>
<your-map profile-config='{"profile":"detail","tk":"pk.eyJ..."}'></your-map>

Add a map — three steps

# 1. create the folder + one profile
mkdir -p plugin-designs/<your-map>
#    index.js   ← copy doxa-simple-map/index.js, rename the tag
#    <name>.vue ← your screen, built from @map/* blocks (flat in the folder)

# 2. build
npm run build            # → public/dx-maps/<your-map>/<your-map>.js
#    (just this one:  BUNDLE=<your-map> npm run build:bundle)

# 3. embed the script tag + element (dev staging at `npm run dev` shows a paste-ready snippet)

Your three things (everything else is shared)

Colors — how pins are colored. Pick one the template ships (getColorStrategy('language-family')), or drop your own in plugin-designs/<your-map>/src/colors/ (start from template-bundle/src/colors/example-mode.js). Never edit @map/colors/ to recolor your map.
API — your map reads its data from the profile-config on the page, so the same bundle points at different data with no rebuild. DataSourceManager accepts csv (bundled file), api (one JSON URL), or rest-api (a live REST endpoint, the default). Prefer the real API over inlined JSON.
i18n — the template ships 11 base locales in @map/i18n/locales/. Use useI18n() for strings and RTL_LOCALES for right-to-left; add or override strings from your own profile.

The one hosting variable

The only thing that changes between hosting modes is the <script src>: a relative path when your own site serves the file, or an absolute CDN URL when a partner site serves it. The bundle is identical either way. See ../documentation/CONTRIBUTING.md for the two CDN modes and partner-site embedding.

Profile patterns (mix freely)

Individual — one .vue per bundle (simplest).
Parameterized — one profile, behavior driven by profile-config props (e.g. tabs[]).
Nested — one profile that renders others (workbench-style, like doxa-research-map).