History

Doxa Maps 1eae8ed80d Every unmounted map stayed in memory, held by one line on window rega's heap snapshots (leak-722ac7789): Simple Research and All People Groups mounted twice went 54.2 MB to 65.1 MB, with live Vue apps 6 to 8. Every unmounted application was still there, one copy per mount, and the retainers were all the same shape -- a window key set during setup and never cleared. The closure keeps its component, the component keeps its shadow root, and a whole app survives its own unmount. An element property dies with the element; a window key does not. The named one was window.__doxaLogoOwner -> Map -> div.rm-map-canvas -> ShadowRoot -> app, released only when the map's 'remove' event fires. That listener cannot be the guarantee the global is cleared, because it only runs if remove() is reached; it is a consequence of the guarantee, not the guarantee itself. useMapInstance now drops the claim inside destroy(), before removing, so it goes even if remove() throws part-way. As for why remove() was never reached: research-map's unmount hook ran ten teardown steps and called destroy() last, and two of those steps were unguarded calls into other composables. A single throw anywhere above stranded the map, and with it the app. I could not reproduce which step threw without a browser, so the fix does not depend on knowing: each step is isolated and destroy() runs from a finally, where nothing above it can skip it. Ordering teardown so the most important step is last, behind nine chances to fail, was the real defect. The globals themselves are released by the components that set them -- four verify hooks in research-map, three in the dashboard map panel, the vocabulary hook in the grid, which had no unmount hook at all. Released as SETS: __rdashPinAt was the one the snapshot named, but __rdashMap holds the map and retains strictly more, so clearing only the reported one would have looked fixed and leaked nearly as much. The deletes are written one per line instead of looped over an array of names, so that the check can read them. A release a checker cannot see is worth no more than no release, the day someone removes three of the four. The check flags only values that actually retain. A warn-once boolean latch and a page-wide cache keyed off itself are deliberate and must not be reported, or it becomes noise and gets switched off. It is NOT in gates:pre: 19 sites remain in other owners' plugins, and this is a fleet pattern rather than one plugin's bug.		2026-09-29 00:06:52 +00:00
..
all-people-groups	Map errors in every language, and print buttons that show they are busy (UPG Neighbor, All People Groups, Prayer Walk Planner, Wall)	2026-09-28 18:34:16 +00:00
big-picture	min-height clamps height, so the pane could not hold the plugin it was pinning	2026-09-28 15:01:19 +00:00
cities-internet	The embedded map drew 340px below its card, and said nothing for the 30s it took	2026-09-28 23:43:44 +00:00
country-posters	Country Posters: Export poster opens its dialog again, and two legend calls that did nothing are gone (the legend's rows are called items)	2026-09-28 20:40:50 +00:00
dashboard-plus-grid	A relative share link works when you click it, which is why nobody caught it	2026-09-28 17:40:34 +00:00
demo-map	Five plugins were silently monolingual, because the bootstrap was copied sixteen times	2026-09-28 17:40:34 +00:00
doxa-maps-spa	The pin hint only answers to a map canvas; the Experimental "?" moves to the top centre	2026-09-28 21:59:29 +00:00
doxa-research-map	Every unmounted map stayed in memory, held by one line on window	2026-09-29 00:06:52 +00:00
doxa-simple-map	Five plugins were silently monolingual, because the bootstrap was copied sixteen times	2026-09-28 17:40:34 +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 finds its manifest from its own script, so it answers when embedded	2026-09-28 23:23:58 +00:00
gospel-internet	Release the test hooks on unmount, all twelve of them	2026-09-28 20:32:59 +00:00
gospel-resources	Arabic readers get the language code, the link gap and the population column on the wrong side	2026-09-28 23:43:44 +00:00
key-cities	Eleven plugin entries import the element helper they call	2026-09-28 17:40:35 +00:00
my-upg-100-list	The wall-printed packet gets all five of its card pages	2026-09-28 23:13:47 +00:00
people-groups-grid	The grid's "controls off" preset did nothing, and nothing said so	2026-09-28 22:25:30 +00:00
plugin-studio	library: one embedScript for the app shells, replacing four private copies	2026-09-28 07:07:33 +00:00
pplr-data-maps	Pplr Data Maps: its verification hooks leave window when a view closes, so a closed view no longer keeps the whole app in memory	2026-09-28 20:40:50 +00:00
prayer-walk-planner	Map errors in every language, and print buttons that show they are busy (UPG Neighbor, All People Groups, Prayer Walk Planner, Wall)	2026-09-28 18:34:16 +00:00
regions-dashboard	CLDR plural selection, and the "N countries / N regions" keys it was blocking	2026-09-28 23:23:56 +00:00
research-dashboard	Every unmounted map stayed in memory, held by one line on window	2026-09-29 00:06:52 +00:00
research-map-plus-grid	A relative share link works when you click it, which is why nobody caught it	2026-09-28 17:40:34 +00:00
rudder-voice	Rudder: plain streaming by default; sentence detection only while the robot voice is on	2026-09-28 17:27:13 +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	Five plugins were silently monolingual, because the bootstrap was copied sixteen times	2026-09-28 17:40:34 +00:00
upg-neighbor	UPG Neighbor: a green group's unreached neighbours one E-level at a time, closest first, and green dots on Campaigns open them	2026-09-28 20:57:15 +00:00
wall-of-people-groups	Wall of People Groups: the poster's prayer-themes chart and closing line print in the reader's language	2026-09-28 23:01:29 +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).