add validate-configs workflow

JGreenlee · shankari · commit ee29275c28dd · 2025-10-13T14:42:21.000-07:00
index.d.ts is based on appConfigTypes.ts from e-mission-phone https://github.com/e-mission/e-mission-phone/blob/30e4b78ff64596b20cea811000f6d5b11a6b6cae/www/js/types/appConfigTypes.ts, moved here to be the source of truth for supported config options. Added package.json so this functions as a minimal npm package and the types can be used downstream on e-mission-phone In a workflow, we can generate JSON schema from the typescript declarations and validate all the configs accordingly. This will help us catch mistakes in config creation or edits and will allow us to set up auto-merge for trusted PRs Adding this validation exposed several inconsistencies in the config, which I have also fixed in this commit: e-mission/op-admin-dashboard#167 (comment)
diff --git a/.github/workflows/validate-configs.yml b/.github/workflows/validate-configs.yml
@@ -0,0 +1,31 @@
+name: Validate Configs
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  validate_configs:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: '18'
+
+      - name: Generate JSON schema with typescript-json-schema
+        run: |
+          npm install -g typescript-json-schema
+          npx typescript-json-schema index.d.ts DeploymentConfig --noExtraProps --required --out config.schema.json
+
+      - name: Validate all configs against config.schema.json
+        uses: cardinalby/schema-validator-action@v3
+        with:
+          file: 'configs/*.json'
+          schema: 'config.schema.json'
diff --git a/configs/ccebikes.nrel-op.json b/configs/ccebikes.nrel-op.json
@@ -1,6 +1,6 @@
 {
+    "url_abbreviation": "ccebikes",
     "version": 1,
-    "name": "ccebikes",
     "ts": 1655143472,
     "server": {
         "connectUrl": "https://ccebikes-openpath.nrel.gov/api/",
diff --git a/configs/choose-your-ride.nrel-op.json b/configs/choose-your-ride.nrel-op.json
@@ -1,6 +1,6 @@
 {
+    "url_abbreviation": "choose-your-ride",
     "version": 1,
-    "name": "choose-your-ride",
     "ts": 1655143472,
     "server": {
         "connectUrl": "https://choose-your-ride-openpath.nrel.gov/api/",
diff --git a/configs/cortezebikes.nrel-op.json b/configs/cortezebikes.nrel-op.json
@@ -1,6 +1,6 @@
 {
+    "url_abbreviation": "cortezebikes",
     "version": 1,
-    "name": "cortezebikes",
     "ts": 1655143472,
     "server": {
         "connectUrl": "https://cortezebikes-openpath.nrel.gov/api/",
diff --git a/configs/dev-emulator-program.nrel-op.json b/configs/dev-emulator-program.nrel-op.json
@@ -18,9 +18,6 @@
                 "short_textual_description": "OpenPATH is the only open source platform for instrumenting mobility patterns. We welcome contributions and pull requests.",
                 "why_we_collect": "So that you can see how OpenPATH works",
                 "research_questions": ["Comparing the open-access group (no intervention) and programs that provide interventions.", "General monitoring of mobility trends for travel behavior, including shifts to travel behavior and the introduction of new mobility modes."]
-            },
-            "es":{
-                "deployment_partner_name": "Laboratorio Nacional de Energías Renovables (NREL)"
             }
         }
     },
diff --git a/configs/dev-emulator-study.nrel-op.json b/configs/dev-emulator-study.nrel-op.json
@@ -17,9 +17,6 @@
                 "short_textual_description": "OpenPATH is the only open source platform for instrumenting mobility patterns. We welcome contributions and pull requests.",
                 "why_we_collect": "So that you can see how OpenPATH works",
                 "research_questions": ["Comparing the open-access group (no intervention) and programs that provide interventions.", "General monitoring of mobility trends for travel behavior, including shifts to travel behavior and the introduction of new mobility modes."]
-            },
-            "es":{
-                "deployment_partner_name": "Laboratorio Nacional de Energías Renovables (NREL)"
             }
         }
     },
diff --git a/configs/dev-emulator-timeuse.nrel-op.json b/configs/dev-emulator-timeuse.nrel-op.json
@@ -18,9 +18,6 @@
                 "short_textual_description": "OpenPATH is the only open source platform for instrumenting mobility patterns. We welcome contributions and pull requests.",
                 "why_we_collect": "So that you can see how OpenPATH works",
                 "research_questions": ["Comparing the open-access group (no intervention) and programs that provide interventions.", "General monitoring of mobility trends for travel behavior, including shifts to travel behavior and the introduction of new mobility modes."]
-            },
-            "es":{
-                "deployment_partner_name": "Laboratorio Nacional de Energías Renovables (NREL)"
             }
         }
     },
diff --git a/configs/dfc-fermata.nrel-op.json b/configs/dfc-fermata.nrel-op.json
@@ -104,7 +104,7 @@
         "year": 2014,
         "color": "red",
         "engine": "ICE",
-        "mpg": 33
+        "mpge": 33
       }
     },
     {
@@ -122,7 +122,7 @@
         "year": 2011,
         "color": "silver",
         "engine": "HEV",
-        "mpg": 48
+        "mpge": 48
       }
     },
     {
@@ -208,7 +208,7 @@
         "year": 1999,
         "color": "red",
         "engine": "ICE",
-        "mpg": 21
+        "mpge": 21
       }
     },
     {
@@ -401,7 +401,7 @@
   "metrics": {
     "include_test_users": false,
     "phone_dashboard_ui": {
-      "sections": ["summary", "surveys", "engagement"],
+      "sections": ["footprint", "surveys", "travel"],
       "metric_list": {
         "count": [ "primary_ble_sensed_mode" ],
         "distance": [ "primary_ble_sensed_mode" ],
@@ -410,12 +410,6 @@
       },
       "footprint_options": {
         "unlabeled_uncertainty": false
-      },
-      "summary_options": {
-        "summary_metrics": ["distance", "count", "duration", "response_count"]
-      },
-      "engagement_options": {
-        "leaderboard_metric": ["distance", "e_car"]
       }
     }
   },
diff --git a/configs/ebikegj.nrel-op.json b/configs/ebikegj.nrel-op.json
@@ -1,6 +1,6 @@
 {
+    "url_abbreviation": "ebikegj",
     "version": 1,
-    "name": "ebikegj",
     "ts": 1655143472,
     "server": {
         "connectUrl": "https://ebikegj-openpath.nrel.gov/api/",
diff --git a/configs/ebikethere-garfield-county.nrel-op.json b/configs/ebikethere-garfield-county.nrel-op.json
@@ -1,6 +1,6 @@
 {
+    "url_abbreviation": "ebikethere-garfield-county",
     "version": 2,
-    "name": "ebikethere-garfield-county",
     "ts": 1655143472,
     "server": {
         "connectUrl": "https://ebikethere-garfield-county-openpath.nrel.gov/api/",
diff --git a/configs/nrel-commute.nrel-op.json b/configs/nrel-commute.nrel-op.json
@@ -21,9 +21,6 @@
                 "short_textual_description": "As commute schedules get increasingly complex in our “Future of Work”, NREL would like to experiment with an automated trip tracking solution for understanding travel behavior. This Commuting Study (“Study”) can allow NREL to understand variations in travel across centers, days of the week and months of the year without complex, time-consuming surveys.",
                 "why_we_collect": "NREL can use this information to understand how people get to work, what their constraints are, and how to better provide alternative options to driving alone. This comprehensive information will aid NREL in its goal to reduce carbon emissions from transportation.",
                 "research_questions": ["Travel behavior modeling to support cost-benefit analyses of potential commuting programs.", "Analysis of the impact of post-pandemic telework on transportation energy efficiency and greenhouse gas emissions."]
-            },
-            "es":{
-                "deployment_partner_name": "Laboratorio Nacional de Energías Renovables (NREL)"
             }
         }
     },
diff --git a/index.d.ts b/index.d.ts
@@ -0,0 +1,161 @@
+// examples of configs: https://github.com/e-mission/nrel-openpath-deploy-configs/tree/main/configs
+
+export type DeploymentConfig = {
+  url_abbreviation?: string; // TODO: this should probably be required; we could fill it in for old configs based on filename
+  version: number;
+  ts: number;
+  server?: ServerConnConfig; // TODO: this is required for any real deployments but missing for dev-emulator- configs, so I have to mark it as optional. Maybe the dev-emulator- configs should explicitly say localhost here so we can mark this as required
+  opcode?: OpcodeConfig;
+  intro: IntroConfig;
+  survey_info?: {
+    "trip-labels": "MULTILABEL" | "ENKETO";
+    surveys: EnketoSurveyConfig;
+    buttons?: SurveyButtonsConfig;
+  };
+  label_options?: `https://${string}`;
+  vehicle_identities?: VehicleIdentity[];
+  reminderSchemes?: ReminderSchemesConfig;
+  tracking?: {
+    bluetooth_only: boolean;
+  };
+  display_config: {
+    use_imperial: boolean;
+  };
+  metrics?: MetricsConfig;
+  push_notifications?: any; // TODO: fill in
+  profile_controls: any; // TODO: fill in
+  admin_dashboard?: any; // TODO: fill in and maybe this should be required; it's only missing from dev-emulator- and stage- configs
+};
+
+export type ServerConnConfig = {
+  connectUrl: `https://${string}`;
+  aggregate_call_auth: "no_auth" | "user_only" | "never";
+};
+
+export type OpcodeConfig = {
+  autogen: boolean;
+  subgroups?: string[];
+  suspended_subgroups?: string[];
+};
+
+export type IntroConfig = {
+  program_or_study: "program" | "study";
+  app_required?: boolean;
+  start_month: string; // might be "M" or "MM"; TODO maybe this should be a number
+  start_year: string; // "YYYY"; TODO maybe this should be a number
+  mode_studied?: string | string[];
+  program_admin_contact: string;
+  deployment_partner_name: string;
+  translated_text: {
+    [lang: string]: {
+      deployment_partner_name: string;
+      deployment_name: string;
+      summary_line_1: string;
+      summary_line_2: string;
+      summary_line_3: string;
+      short_textual_description: string;
+      why_we_collect: string;
+      why_we_collect_es?: string; // TODO this seems like it should be removed
+      raw_data_use?: string; // oddly, this is ONLY defined for denver-casr
+      research_questions: string[];
+    };
+  };
+};
+
+export type EnketoSurveyConfig = {
+  [surveyName: string]: {
+    formPath: string;
+    labelTemplate: { [lang: string]: string };
+    labelVars?: { [activity: string]: { [key: string]: string; type: string } };
+    version: number;
+    compatibleWith: number;
+    dataKey?: string;
+  };
+};
+export type SurveyButtonConfig = {
+  surveyName: string;
+  "not-filled-in-label": {
+    [lang: string]: string;
+  };
+  showsIf?: string; // a JS expression that evaluates to a boolean
+};
+export type SurveyButtonsConfig = {
+  [k in "trip-label" | "trip-notes" | "place-label" | "place-notes"]?:
+    | SurveyButtonConfig
+    | SurveyButtonConfig[];
+};
+
+export type VehicleIdentity = {
+  value: string;
+  bluetooth_major_minor: string[]; // e.g. ['aaaa:bbbb', 'cccc:dddd']
+  text: string;
+  baseMode: string;
+  met_equivalent: string;
+  kgCo2PerKm: number;
+  vehicle_info: {
+    type: string; // TODO what is the point of this if we already have base mode and engine type?
+    make: string;
+    model: string;
+    year: number;
+    engine: "ICE" | "HEV" | "PHEV" | "BEV" | "HYDROGENV" | "BIOV";
+    license?: string;
+    color?: string;
+    mpge?: number;
+  };
+};
+
+export type ReminderSchemesConfig = {
+  [schemeKey: string]: {
+    schedule: {
+      start: number;
+      end?: number;
+      intervalInDays: number;
+    }[];
+    title?: { [lang: string]: string };
+    text?: { [lang: string]: string };
+    defaultTime?: string; // format is HH:MM in 24 hour time
+  };
+};
+
+// the available metrics that can be displayed in the phone dashboard
+export type MetricName =
+  | "distance"
+  | "count"
+  | "duration"
+  | "response_count"
+  | "footprint";
+// the available trip / userinput properties that can be used to group the metrics
+export type GroupingField =
+  | "mode_confirm"
+  | "purpose_confirm"
+  | "replaced_mode_confirm"
+  | "primary_ble_sensed_mode"
+  | "survey";
+export type MetricList = { [k in MetricName]?: GroupingField[] };
+export type MetricsUiSection = "footprint" | "movement" | "surveys" | "travel";
+export type FootprintGoal = {
+  label: { [lang: string]: string };
+  value: number;
+  color?: string;
+};
+export type FootprintGoals = {
+  carbon: FootprintGoal[];
+  energy: FootprintGoal[];
+  goals_footnote?: { [lang: string]: string };
+};
+export type MetricsConfig = {
+  include_test_users: boolean;
+  phone_dashboard_ui?: {
+    sections: MetricsUiSection[];
+    metric_list: MetricList;
+    footprint_options?: {
+      unlabeled_uncertainty: boolean;
+      goals?: FootprintGoals;
+    };
+    movement_options?: {};
+    surveys_options?: {};
+    travel_options?: {};
+  };
+};
+
+export default DeploymentConfig;
diff --git a/package.json b/package.json
@@ -0,0 +1,4 @@
+{
+  "name": "nrel-openpath-deploy-configs",
+  "version": "1.0.0"
+}

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
	`2`	`+ "url_abbreviation": "ccebikes",`
`2`	`3`	`"version": 1,`
`3`		`- "name": "ccebikes",`
`4`	`4`	`"ts": 1655143472,`
`5`	`5`	`"server": {`
`6`	`6`	`"connectUrl": "https://ccebikes-openpath.nrel.gov/api/",`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
	`2`	`+ "url_abbreviation": "choose-your-ride",`
`2`	`3`	`"version": 1,`
`3`		`- "name": "choose-your-ride",`
`4`	`4`	`"ts": 1655143472,`
`5`	`5`	`"server": {`
`6`	`6`	`"connectUrl": "https://choose-your-ride-openpath.nrel.gov/api/",`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
	`2`	`+ "url_abbreviation": "cortezebikes",`
`2`	`3`	`"version": 1,`
`3`		`- "name": "cortezebikes",`
`4`	`4`	`"ts": 1655143472,`
`5`	`5`	`"server": {`
`6`	`6`	`"connectUrl": "https://cortezebikes-openpath.nrel.gov/api/",`
Original file line number	Diff line number	Diff line change
`@@ -18,9 +18,6 @@`
`18`	`18`	`"short_textual_description": "OpenPATH is the only open source platform for instrumenting mobility patterns. We welcome contributions and pull requests.",`
`19`	`19`	`"why_we_collect": "So that you can see how OpenPATH works",`
`20`	`20`	`"research_questions": ["Comparing the open-access group (no intervention) and programs that provide interventions.", "General monitoring of mobility trends for travel behavior, including shifts to travel behavior and the introduction of new mobility modes."]`
`21`		`- },`
`22`		`- "es":{`
`23`		`- "deployment_partner_name": "Laboratorio Nacional de Energías Renovables (NREL)"`
`24`	`21`	`}`
`25`	`22`	`}`
`26`	`23`	`},`
Original file line number	Diff line number	Diff line change
`@@ -17,9 +17,6 @@`
`17`	`17`	`"short_textual_description": "OpenPATH is the only open source platform for instrumenting mobility patterns. We welcome contributions and pull requests.",`
`18`	`18`	`"why_we_collect": "So that you can see how OpenPATH works",`
`19`	`19`	`"research_questions": ["Comparing the open-access group (no intervention) and programs that provide interventions.", "General monitoring of mobility trends for travel behavior, including shifts to travel behavior and the introduction of new mobility modes."]`
`20`		`- },`
`21`		`- "es":{`
`22`		`- "deployment_partner_name": "Laboratorio Nacional de Energías Renovables (NREL)"`
`23`	`20`	`}`
`24`	`21`	`}`
`25`	`22`	`},`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
	`2`	`+ "url_abbreviation": "ebikegj",`
`2`	`3`	`"version": 1,`
`3`		`- "name": "ebikegj",`
`4`	`4`	`"ts": 1655143472,`
`5`	`5`	`"server": {`
`6`	`6`	`"connectUrl": "https://ebikegj-openpath.nrel.gov/api/",`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
	`2`	`+ "url_abbreviation": "ebikethere-garfield-county",`
`2`	`3`	`"version": 2,`
`3`		`- "name": "ebikethere-garfield-county",`
`4`	`4`	`"ts": 1655143472,`
`5`	`5`	`"server": {`
`6`	`6`	`"connectUrl": "https://ebikethere-garfield-county-openpath.nrel.gov/api/",`