doxa-maps/plugin-designs
doxa-maps-88655c70 39b9a4cca9 Regions: port DX-life's map on our map library, and clone the country page
Completes the clone. Two things were missing: the map both their pages render,
and the fact that a COUNTRY is a different page from a region.

THE MAP — plugin-designs/regions-dashboard/src/RegionCountryMap.vue.
Layers are DX-life's, expression for expression (CountryMap.vue:186-240): the
country-boundaries fill at 0.12, the 2px outline, the single-worldview filter
that stops the highlight drawing three times, the prayer / in-country colour
cases, the circle-sort-key that puts better-covered pins on top, the
zoom-interpolated radius, 0.75 opacity on neighbours, their seven colours.
The machinery is ours: theirs does `new mapboxgl.Map` in a Nuxt page, which
cannot work in a shadow root — container-by-id does not cross the boundary, the
async CSS link gives a first-initialising map a 0-height canvas, and the
wordmark duplicates per instance. @map/composables/useMapInstance.js already
solves all three, so this supplies only the layers. Points come down from the
parent instead of a second fetch, so the pins and the figures above them
provably describe the same rows.

THE COUNTRY PAGE — CountryDetail.vue is head + map note + map + the people-group
list, with NO stat cards and no goal cards. It now renders that, not the region
page wearing a country's numbers. Its map passes no color-by-prayer, so pins
read in-country vs surrounding, which is what its own note tells you to look
for. The list uses @map/components/tables/DataTable.vue rather than a third copy
of their 662-line UupgsList — this repo already ships that as people-groups-grid,
and nesting the real element is a cap-4 composition question.

Four defects found by measuring, not by reading:

1. A CANVAS AT THE RIGHT SIZE IS NOT A MAP. With a <template> branch per subject
   kind, region -> country unmounted one map and mounted another into a
   zero-size container: 1200x780 canvas, correct centre and zoom, layers [],
   nothing drawn, a blank white card — and every assertion passed. One instance
   driven by props now, and the suite asserts queryRenderedFeatures (934 pins /
   51 outline for Africa, 61 / 5 for Cameroon) instead of canvas dimensions.

2. isStyleLoaded() IS THE WRONG GATE for adding layers. It also waits for the
   style's sources, which never arrive at zoom 6 on this box because the local
   token is URL-restricted and its high-zoom tiles 403. Same code drew a region
   and drew nothing for a country. Keyed on 'style.load' — the style being
   PARSED is what makes addSource/addLayer legal — with a parsed-style fallback.

3. THE PIN MODE WAS FROZEN at whatever it was when the layer was created, so a
   country page painted prayer colours. Caught in a screenshot by one yellow
   "1+ praying" pin; invisible to every assertion, because the pins were
   rendered and the legend was correctly absent. applySubject now re-applies
   circle-color and circle-sort-key.

4. THE PROFILE CONFIG ARRIVES BY INJECT, NOT AS A PROP. The element this bundle
   registers IS ProfileLoader, which parses the profile-config attribute and
   provides the parsed object (ProfileLoader.vue:195). Both tabs read it off
   their own string prop, which is always empty — prayBaseUrl, languageCode,
   instanceId and assetsBase all silently defaulted. Nothing looked broken until
   assetsBase mattered: the vendored Tabulator 404'd twice with no error and the
   country list just never drew. Fixed in both tabs, prop kept as a fallback.

Token delivery needs no wiring: the generator detects a map under the bundle and
bakes the ladder itself, so all three leaves now carry it and
check:nested-token passes.
2026-09-24 00:10:27 +00:00
..
all-people-groups light the remaining unconditional loading overlays and the copy-me starter 2026-09-21 16:40:53 +00:00
big-picture Stop Big Picture showing the same total twice 2026-09-23 15:32:28 +00:00
cities-internet Resolve a composite's child bundles against the tree root, not a guessed depth 2026-09-23 19:34:28 +00:00
country-posters Resolve the shared asset base per bundle, so nested tabs stop 404ing 2026-09-23 12:14:52 +00:00
dashboard-plus-grid Add the Gospel Access filter, the ladder the binary flag was flattening 2026-09-23 13:19:22 +00:00
demo-map consolidate docs into documentation/ and deployment shells into deployment/ 2026-09-21 23:23:23 +00:00
doxa-maps-spa Regions mounts its cap-4 composite; UPG-100 drops its duplicate share and shrinks its dots 2026-09-23 19:37:55 +00:00
doxa-research-map Widen the red ramp, add a greyscale ramp, and gate cap-4 interoperability 2026-09-23 14:53:51 +00:00
doxa-simple-map Describe every plugin: 15 of 26 profiles shipped with no description 2026-09-22 03:11:07 +00:00
doxa-vision-card Brand-neutral shared VerticalTabsLayout with lazy nested-element hosting; fix cap-5 prayer tab leaf path; neutralize library identifiers; add Forgejo CI build-gate workflow 2026-09-19 17:24:30 +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 Resolve a composite's child bundles against the tree root, not a guessed depth 2026-09-23 19:34:28 +00:00
key-cities Resolve the shared asset base per bundle, so nested tabs stop 404ing 2026-09-23 12:14:52 +00:00
my-upg-100-list Regions mounts its cap-4 composite; UPG-100 drops its duplicate share and shrinks its dots 2026-09-23 19:37:55 +00:00
people-groups-grid Add the Gospel Access filter, the ladder the binary flag was flattening 2026-09-23 13:19:22 +00:00
plugin-studio Plugin studio: show what a composite is made of, in one panel 2026-09-23 20:21:48 +00:00
prayer-walk-planner Add prayer-walk-planner: experimental polygon prayer-walking map 2026-09-23 16:22:56 +00:00
regions-dashboard Regions: port DX-life's map on our map library, and clone the country page 2026-09-24 00:10:27 +00:00
research-dashboard Full table headers via horizontal scroll, and a full-screen table 2026-09-23 20:25:08 +00:00
research-map-plus-grid Share the mobile composite too, and make the url absolute so the embed works 2026-09-23 08:32:50 +00:00
stack-demo Let a stacked composite find its siblings in either tree 2026-09-22 15:37:41 +00:00
template-bundle consolidate docs into documentation/ and deployment shells into deployment/ 2026-09-21 23:23:23 +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 consolidate docs into documentation/ and deployment shells into deployment/ 2026-09-21 23:23:23 +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/doxa-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="/doxa-maps/<your-map>/<your-map>.js"></script>
<doxa-map profile-config='{"profile":"overview","tk":"pk.eyJ..."}'></doxa-map>
<doxa-map profile-config='{"profile":"detail","tk":"pk.eyJ..."}'></doxa-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/doxa-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