Three defects on country-map/country-map, which is production -- DX Life's country pages. Found by auditing the element rather than from a report. 1. ANY profile-config change refetched all 2,106 records. The watch getter returned a NEW ARRAY literal, and Vue compares a watch value with Object.is, so a fresh array always reads as changed; both computeds read the injected cfg, so the effect re-ran on every config change and the callback then fired unconditionally. MEASURED with real Vue: flipping isDark refetched the whole endpoint and redrew the map, and so did a host adding pinHint. A joined STRING compares by value, so only a real language or country change refetches -- which must still refetch, because the API localises the names. This was latent waste until the composite re-forward made config writes routine. It is now on every upstream locale switch, so the two changes are complementary rather than independent. 2. A SLOW EARLIER RESPONSE OVERWROTE A NEWER ONE. loadPoints is async and had no sequencing at all -- 0 abort or generation tokens in the file -- so two runs could be in flight and the one that STARTED first could FINISH last. Both assigned points, so the map showed the previous country's pins with no error and nothing for the reader to notice. Every run now takes a ticket and a stale ticket writes nothing: not the points, not loadFailed, not the spinner the current run is still using. fetch is left to complete rather than aborted, because the response is cached for the next switch back. 3. `loading` WAS WRITE-ONLY: assigned in three places and read in none, zero template references. A reader on a country page waited on an empty map -- no outline, no pins, no message -- which is indistinguishable from a country that genuinely has no people groups, and this element fetches the whole list before it can draw one pin. "Loading results..." was already in the catalogue in all eleven locales, so saying so cost no new string and no parity debt. check:country-map-refetch guards all three. It drives the REAL reactive chain with real Vue and takes the watch key expression OUT OF THE SHIPPED SFC, because bug 1 is entirely a question of what Vue considers changed and is invisible to any test that fakes reactivity or re-types the watch. Mutation-tested, 5 mutations, all caught by name. The first version of the gate MISSED one: a bare /if \(!current\(\)\) return/ grep matched the guard in the catch block, so removing only the guard before the points write still passed. The assertions are positional now -- the guard must sit immediately before the assignment it protects -- and the catch guard is asserted separately. That hole existed because the behavioural half of the test reproduced the guard's shape inside the gate instead of reading the component, which is the self-consistent oracle this repo's other geometry gate explicitly warns against. Registered in scripts and gates:pre, verified by re-parsing: one key, 107 checks. Bundle rebuilt (BUNDLE=country-map), then tree, then fix:sri. |
||
|---|---|---|
| .. | ||
| all-people-groups | ||
| big-picture | ||
| cities-internet | ||
| country-map | ||
| country-posters | ||
| dashboard-plus-grid | ||
| demo-map | ||
| doxa-maps-spa | ||
| doxa-research-map | ||
| doxa-simple-map | ||
| doxa-vision-card | ||
| golden-path-check | ||
| gospel-internet | ||
| gospel-resources | ||
| key-cities | ||
| my-upg-100-list | ||
| people-groups-grid | ||
| plugin-studio | ||
| pplr-data-maps | ||
| prayer-walk-planner | ||
| regions-dashboard | ||
| research-dashboard | ||
| research-map-plus-grid | ||
| rudder-voice | ||
| stack-demo | ||
| template-bundle | ||
| upg-neighbor | ||
| wall-of-people-groups | ||
| .gitkeep | ||
| 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.vueprofile is the Vue instance for that map) and that map's own non-reusable components (insrc/). Nothing here leaks to another map. - Many maps per bundle. The bundler bundles one map or many — add another flat
.vueand 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
profilefield — 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 inplugin-designs/<your-map>/src/colors/(start fromtemplate-bundle/src/colors/example-mode.js). Never edit@map/colors/to recolor your map. - API — your map reads its data from the
profile-configon the page, so the same bundle points at different data with no rebuild.DataSourceManageracceptscsv(bundled file),api(one JSON URL), orrest-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/. UseuseI18n()for strings andRTL_LOCALESfor 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
.vueper bundle (simplest). - Parameterized — one profile, behavior driven by
profile-configprops (e.g.tabs[]). - Nested — one profile that renders others (workbench-style, like
doxa-research-map).
See also
doxa-simple-map/index.js— fully commented reference bundle entrytemplate-bundle/— minimal two-profile skeleton to copy../library/colors/README.md— the color-strategy contract../README.md— repo overview & build pipeline ·../documentation/CONTRIBUTING.md— build vs dev, CDN modes