◇ Open Values Standardfor builders

Spec / ovs-node-load-plan

Open Values Node Load Plan v0.1

The order in which the app should load the generated node and search files, what each stage needs, and what to do when a file fails to load. The data build writes it, and the app and its tests read it. It is an internal file used while building the site.

Used while building the sites. Not meant for other apps. Data kept for tests, not for use.

Who writes it and who reads it

Written by pipeline/build_nodes.js. Read by future node loader, app-lane integration.

Fields

FieldWhat it meansType
format requiredNames this file's format, so a reader can check it before reading the rest of the file.always "ovs-node-load-plan"
version requiredThe version of the format this file follows, such as "0.1".see version
built requiredThe date of the source data this file was built from, as YYYY-MM-DD.see date
source requiredThe script and files this file was built from, as paths in the repository.see source
purpose requiredOne sentence on what this file is for.see nonEmptyString
appLaneNote requiredA note on which choices this file leaves to the app code that reads it, such as fetching, layout and wording.see nonEmptyString
integrityContract requiredThe rules for cache keys and hash checks.object
budgets requiredByte sizes and limits for loading, by name, such as "askCoreBytes" and "startupBudgetBytes".object
stages requiredThe load stages, in order.list
totals requiredHow many stages there are, how many run in the app, and how many are for testing only.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.

A file that passes

Load plans define integrity policy, budgets, stages, and fallback behavior.

{
  "format": "ovs-node-load-plan",
  "version": "0.1",
  "built": "2026-07-07",
  "source": [
    "pipeline/build_nodes.js"
  ],
  "purpose": "Runtime loading contract for app-owned integration.",
  "appLaneNote": "Data contract only.",
  "integrityContract": {
    "algorithm": "sha256",
    "cacheKey": "<file>:<sha256>",
    "validate": "Validate hashes when supported.",
    "retry": "Refetch once.",
    "fallback": "Do not fabricate results."
  },
  "budgets": {
    "startupBudgetBytes": 780000,
    "minimumHeadroomBytes": 50000
  },
  "stages": [
    {
      "id": "bootstrap-metadata",
      "label": "Bootstrap metadata",
      "loadHint": "eager-metadata",
      "files": [
        "manifest.json"
      ],
      "trigger": "App startup.",
      "acceptanceCriteria": [
        "Load metadata first."
      ],
      "failureMode": "Keep existing app paths usable."
    }
  ],
  "totals": {
    "stages": 1
  }
}

A file that must be rejected

Load plans must use sha256 integrity metadata.

{
  "format": "ovs-node-load-plan",
  "version": "0.1",
  "built": "2026-07-07",
  "source": [
    "pipeline/build_nodes.js"
  ],
  "purpose": "Runtime loading contract.",
  "appLaneNote": "Data contract only.",
  "integrityContract": {
    "algorithm": "md5",
    "cacheKey": "<file>:<hash>",
    "validate": "Validate hashes.",
    "retry": "Refetch once.",
    "fallback": "Do not fabricate results."
  },
  "budgets": {
    "startupBudgetBytes": 780000
  },
  "stages": [
    {
      "id": "bootstrap",
      "label": "Bootstrap",
      "loadHint": "eager",
      "files": [
        "manifest.json"
      ],
      "trigger": "Startup.",
      "acceptanceCriteria": [
        "Load."
      ],
      "failureMode": "Fallback."
    }
  ],
  "totals": {
    "stages": 1
  }
}

The schema

Its address is https://openvaluesstandard.org/schema/node-load-plan-v0.1.schema.json. Validators can fetch it there; the file is also in the repository at app/data/standard/schemas/node-load-plan.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.