doxa-maps/plugin-designs
Doxa Maps 04630e1571 The zones seam: a list can have its own poster clusters, and today they all share UPG-100's
Part 2 of the pattern (dx-shepherd UPGPAT). Membership was already parameterised — lists.json registers
five lists, and four of them are the Driver's own project numbers (doxa = Project 2000, unreached = 7000,
frontier = 4700, frontier-500k = 700) — and resolvePeopleGroupList already picks one from config.list /
?list= / window.MAP_LIST. The gap was ZONES: a list says WHICH groups, nothing said how to cluster them
into the ~100-group printable zones a poster needs.

★ A REGISTRY, NOT A DYNAMIC IMPORT, and the reason is load-bearing. The two consumers do
`import { lists, asia_lists, uncovered_lists } from './data/clusters.json'`, and that NAMED import is
deliberate — its own comment says only the zone arrays ship while the file's eight bookkeeping fields are
tree-shaken out. `await import(path)` would ship the whole file in every bundle AND make the zone list
asynchronous in code that reads it synchronously at setup. So alternates are registered as static imports
and the bundler can still see which zone files a bundle reaches.

⚠ INERT UNTIL A SECOND LIST EXISTS, deliberately. Every list resolves to UPG-100's zones today, which is
exactly what every caller already gets — so this lands with zero behaviour change. That is the point: the
pattern has to exist BEFORE the second list, or it is not the thing the second list gets built against.
A list with no zones of its own warns ONCE, naming what it substituted, because showing UPG-100's zones
under another list's name is silent-wrong-data a reader cannot detect.

WHAT A NEW LIST SHIPS — the three-step recipe another agent follows:
  1. data/zones/<id>.json                 the four zone-bearing keys, clusters.json's shape
  2. data/zoning-declarations.<id>.json    bloc zones, expected orphans, known overlaps, page budget
  3. one line in ZONES_BY_LIST
then `check:zoning-declared --list <id>` grades it, and the legend, poster wall and packet all follow,
because all three already enumerate through leafZones(buildLegendNodes(zones)).

⚠ countZones COUNTS deaf_lists AS ONE, not as its two members — legend-tree collapses them into a single
unified leaf ("13 + 12 + 2 + 1 deaf = 28", legend-tree.js:106). Measured both ways: the naive four-key sum
gives 29 against a 28-leaf tree, which is a number that disagrees with every other count in the app.

⚠ AND THE MODULE IS BROWSER/VITE-ONLY, documented in it rather than discovered later. A bare
`import … from './x.json'` is a bundler feature: plain Node throws ERR_IMPORT_ASSERTION_TYPE_MISSING, which
is how I found it. That matches the existing convention — NO Node-side file imports clusters.json as a
module; packet.mjs and every gate read it with readFileSync + JSON.parse (packet.mjs:125) — so a Node
consumer should read the JSON and pass the object in.

Verified: Vite builds it, check:no-free-identifiers PASS, and the resolver's count agrees with
leafZones at 28. The two .vue call sites are NOT switched over yet — that is the behaviour-visible half
and it goes in its own commit so a regression there is bisectable to one change.

★ FOUND WHILE READING THE REGISTRY: the Driver named FIVE project lists (7000 / 4700 / 3000 / 2000 / 700)
and lists.json registers four. PROJECT 3000 IS NOT REGISTERED. Flagged, not invented — which list of groups
it denotes is his to say.
2026-09-27 03:51:22 +00:00
..
all-people-groups A bare-host embed under ?lang=ar now renders Arabic here too 2026-09-27 02:17:35 +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-internet takes the locale-honouring fallback, and drops its English copy 2026-09-26 22:06:59 +00:00
country-posters Country posters: a religion search names the family in the reader's language 2026-09-27 01:10:49 +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 The number's job was wrong, not its value 2026-09-27 02:17:35 +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 Every shipped link has evidence, and 1,412 of them did not 2026-09-27 01:26:50 +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 zones seam: a list can have its own poster clusters, and today they all share UPG-100's 2026-09-27 03:51:22 +00:00
people-groups-grid The second consumer drops its copy of the highlighter 2026-09-27 01:16:50 +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 A bare-host embed under ?lang=ar now renders Arabic here too 2026-09-27 02:17:35 +00:00
research-dashboard The layout drag was LTR-only, and my own migration was too eager 2026-09-27 02:17:35 +00:00
research-map-plus-grid D3: the bus can point at a record without choosing it 2026-09-27 02:17:35 +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

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).

See also

  • doxa-simple-map/index.js — fully commented reference bundle entry
  • template-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