Spec / open-values-map
Conscious Consuming Map v1
Every buying decision Conscious Consuming names, such as which plant-based milk or which bank, whether or not it has data yet, sorted into areas of life. pipeline/build_map.js writes it to app/data/map.json from the hand-edited list in content/taxonomy.json, and the zoomable map in the app (app/homelens.js) loads it when a reader zooms out to the widest levels, so the decisions with no answer yet show up as well as the ones that have one.
- Files built from other files
- Status: draft
- Version: 1.0.0
- Format name in the file:
open-values-map
Draft. It may still change before it is called stable. A file a build step makes from other files. Change the sources, not this file.
Who writes it and who reads it
Written by pipeline/build_map.js. Read by app/homelens.js.
Fields
| Field | What it means | Type |
|---|---|---|
format required | Always "open-values-map". Tells a reader which Open Values format this is. | always "open-values-map" |
version required | The version of the map format this file follows, such as "1.0.0". | string |
built required | The date the map was built from, as YYYY-MM-DD: the taxonomy's own built date when it has one, otherwise the date of its last committed change, or the build date if it has uncommitted changes or git is not available. | string |
purpose required | A sentence saying what this file is for. | string |
consumer required | Which code reads the file and when, such as "app/homelens.js wide rungs; lazily fetched, never part of the boot payload." | string |
source required | The file the map is built from, "content/taxonomy.json". | string |
states required | Every state a decision can be published in, described in the words a reader would meet. | map of string |
totals required | Counts across the map: areas, fields, families and decisions, and how many decisions are in each state. | map of integer |
realms required | The areas of life, such as "Food and drink", each holding its fields. Areas with no decisions are left out. | list of object |
A reader MUST ignore fields it does not know, so a file can carry more than this list and still be read. A writer MUST NOT change what a listed field means.
The schema
Its address is https://openvaluesstandard.org/schema/map-v1.schema.json. Validators can fetch it there; the file is also in the repository at app/data/standard/schemas/map.schema.json.
The key words MUST, MUST NOT, SHOULD, SHOULD NOT and MAY are used as described in RFC 2119 and RFC 8174 when, and only when, they appear in capitals.
Whether this format fits your app is your call. The spec says what a file MUST hold. Which formats you read and write, and what your app does with them, is yours to decide.