History

Doxa Maps 35a4f58fc2 "Show on map" switched the view and the map never acted: retain the request rega measured two broken interop links and read them as one timing bug. They are two different bugs, and neither is the one hypothesised (that the event fires before the map pane has mounted -- both shells create and append their pane elements in their own onMounted, so the element exists at click time). country-posters: THE FORWARDING WAS NEVER WRITTEN. onShowOnMap() was a guard, go('map'), return. No dispatch, no attribute, no property -- nothing carried the selection to the map at all, which is why the camera stayed at world view. Not a race, and no amount of waiting would have fixed it. The shell also created its pane elements and dropped them on the same line, so there was no handle to address the map pane with even if it had wanted to. upg-100: forwarding existed but was fire-and-forget, losable two ways. The listener is attached at the END of an async onMounted, after 5 awaits and only `if (host)`, and an element dispatch has no replay. And once attached, the zone id was resolved against legendNodes and applied by `if (node) onLegendSelect(node)` with NO else -- so an id arriving before the data was discarded in silence. rega's second-click measurement settled which one fires: the first request dies before readiness. ONE PATTERN, and it is deliberately not "attach the listener sooner" -- that would fix one of the two losses and leave the other. The request is RECORDED as an attribute on the pane element and only then announced by event. An attribute is state: it survives custom-element upgrade, and it is still readable when the pane arrives, and when the pane's data arrives later still. The event remains the live path for a map that is already up. Both triggers end in one apply function, so there is one apply path with two triggers rather than two ways to select. Unreadiness is retained; an UNRESOLVABLE id is not. Retaining a typo'd id would spin on every readiness change forever, so it is dropped. The drain runs on nextTick, and that is not caution. upg100-plugin flagged from experience that watch([batchMode, isDark]) marks legend rows on nextTick, so a pre-flush drain would apply the selection against rows about to be replaced by the re-render, and the highlight could be stomped. That failure is invisible in the worst possible way: "the selection happened but you cannot see it" is indistinguishable at the rendered layer from "the selection never happened" -- the exact bug being fixed. The fix would have impersonated the defect. SOURCE ONLY, deliberately. Both bundles were built to prove the source compiles, then the built artifacts were reverted: these are not my bundles, and rule 5 keeps rebuilds with the build owner. country-posters and my-upg-100-list both need one. Verified by _chk-showonmap-selection-is-not-retained.mjs, 30 assertions. It asserts the ONE APPLY PATH property rather than just the functions' presence, on upg100-plugin's suggestion -- a later third trigger that bypassed the apply path would otherwise fail nothing and reproduce the invisible-selection symptom.		2026-09-26 04:21:49 +00:00
..
all-people-groups	All People Groups loads fast on a light map; the Vision Card becomes a true funnel from data	2026-09-25 07:18:30 +00:00
big-picture	Translate the eight strings that had no catalogue entry, keeping their English exactly	2026-09-26 03:34:42 +00:00
cities-internet	Cities list + tables: keep numbers in their previous format while numerals are held	2026-09-26 02:38:06 +00:00
country-posters	"Show on map" switched the view and the map never acted: retain the request	2026-09-26 04:21:49 +00:00
dashboard-plus-grid	Big Picture and Simple Research mount again: import the three locale names they use	2026-09-26 03:02:46 +00:00
demo-map	Move internal files out of the repo; fix five dead links; a fuller delegation diagram	2026-09-25 05:14:10 +00:00
doxa-maps-spa	Research Gallery: PPLR Data Maps and Wall of People Groups are named in all 11 languages	2026-09-25 23:41:17 +00:00
doxa-research-map	The map follows the list: filter the grid and the camera goes there	2026-09-25 23:28:53 +00:00
doxa-simple-map	Prayer Progress: no hardcoded English left in the map's own chrome	2026-09-26 03:34:16 +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	Gospel map: give the zero-access view an address, and say the way in on every row	2026-09-26 03:56:24 +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	"Show on map" switched the view and the map never acted: retain the request	2026-09-26 04:21:49 +00:00
people-groups-grid	Match the live page's wording where we differed only by case	2026-09-25 17:08:16 +00:00
plugin-studio	Engine and token props: a token-service URL is honoured, Clear clears, and a pending token is awaited	2026-09-26 03:34:15 +00:00
pplr-data-maps	PPLR data maps: tab labels and status lines speak the reader's language	2026-09-26 03:34:28 +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	Port their box-sizing reset into the shadow root, and delete the seven patches it replaces	2026-09-26 02:10:30 +00:00
research-dashboard	Translate the eight strings that had no catalogue entry, keeping their English exactly	2026-09-26 03:34:42 +00:00
research-map-plus-grid	Big Picture and Simple Research mount again: import the three locale names they use	2026-09-26 03:02:46 +00:00
stack-demo	Studio and stack-demo hand the host's language down to what they mount	2026-09-25 13:26:01 +00:00
template-bundle	Move internal files out of the repo; fix five dead links; a fuller delegation diagram	2026-09-25 05:14:10 +00:00
upg-neighbor	My UPG Neighbors: the lenses' chrome speaks the reader's language	2026-09-26 03:34:29 +00:00
wall-of-people-groups	Wall of People Groups: nothing leaks onto the host page (no Font Awesome, no window.d3)	2026-09-26 03:34:31 +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).