Implement a schema for the measurement field

Author: k-yle

.github/workflows/build.yml

@@ -24,5 +24,6 @@ jobs:
       with:
         node-version: ${{ matrix.node-version }}
     - run: npm install
+    - run: npm run build
     - run: npm run lint
     - run: npm run test

.gitignore

@@ -10,3 +10,4 @@ npm-debug.log
 /tests/workspace
 
 transifex.auth
+schemas/generated

README.md

@@ -473,8 +473,7 @@ A string specifying the UI and behavior of the field. Must be one of the followi
 
 * `access` - Block of dropdowns for defining the `access=*` tags on a highway
 * `address` - Block of text and dropdown fields for entering address information (localized for editing location)
-* `roadspeed` - Numeric text field for speed and dropdown for "mph" / "km/h", defaulting to the speed unit used for roads in the feature's region
-* `roadheight` - Numeric text field for height and dropdowns for "m" / "ft" and "in", defaulting to the height unit used for roads in the feature's region
+* `measurement` - Numeric text field for dimensional numbers that have a unit of measurement, such as inches or kilometres-per-hour. The field defaults to the unit of measurement used in the feature's region. See [#measurement](#measurement) for details.
 * `restrictions` - Graphical field for editing turn restrictions
 * `wikidata` - Search field for selecting a Wikidata entity
 * `wikipedia` - Block of fields for selecting a wiki language and Wikipedia page
@@ -740,6 +739,34 @@ Combo field types can accept key-label pairs in the `options` value of the `stri
 
 An optional property to reference to the icons of another field, indicated  by using that field's name contained in brackets, like `{field}`. This is for example useful when there are multiple variants of fields for the same tag, which should all use the same icons.
 
+##### `measurement`
+
+Used when `type = measurement`. Defines the unit of measurements that are supported by this field. For example:
+
+```json
+{
+  "key": "diameter",
+  "type": "measurement",
+  "measurement": {
+     // The dimension being measured. This constrains the permitted units.
+     // The ID id defined by CLDR.
+    "dimension": "length",
+
+    "units": {
+      // The key defines the ID of the of the unit, as defined by CLDR.
+      // The values define the suffix used in the OSM tag value. If there
+      // are multiple values, then the first one is the preferred value.
+      "meter": ["m"],
+      "centimeter": ["cm"],
+      "millimeter": [""], // mm is the default unit in OSM, so the tag value should have no suffix.
+      "yard": ["yd"]
+    }
+  }
+}
+```
+
+Translations for the `narrow` and `long` form of each unit are bundled into iD-tagging-schema's locale files.
+
 ### Deprecations
 
 Use `deprecated.json` ([Example](https://github.com/openstreetmap/id-tagging-schema/blob/main/data/deprecated.json), [Schema](https://github.com/ideditor/schema-builder/blob/main/schemas/deprecated.json)) to specify tag deprecations.

lib/build.js

@@ -20,8 +20,25 @@ const defaultsSchema = require('../schemas/preset_defaults.json');
 const deprecatedSchema = require('../schemas/deprecated.json');
 const discardedSchema = require('../schemas/discarded.json');
 
+/** @import { TranslationOptions } from "./translations.js" */
+
+/** @typedef {{
+  inDirectory: string;
+  interimDirectory: string;
+  outDirectory: string;
+  sourceLocale: string;
+  taginfoProjectInfo: unknown,
+  processCategories: null | unknown;
+  processFields: null | unknown;
+  processPresets: null | unknown;
+  listReusedIcons: boolean;
+}} BuildOptions */
+
+/** @typedef {Partial<BuildOptions & TranslationOptions>} Options */
+
 let _currBuild = null;
 
+/** @param {Options} options */
 function validateData(options) {
   const START = '🔬  ' + styleText('yellow', 'Validating schema...');
   const END = '👍  ' + styleText('green', 'schema okay');
@@ -36,6 +53,7 @@ function validateData(options) {
   process.stdout.write('\n');
 }
 
+/** @param {Options} options */
 function buildDev(options) {
 
   if (_currBuild) return _currBuild;
@@ -53,6 +71,7 @@ function buildDev(options) {
   process.stdout.write('\n');
 }
 
+/** @param {Options} options */
 function buildDist(options) {
 
   if (_currBuild) return _currBuild;
@@ -78,7 +97,8 @@ function buildDist(options) {
     });
 }
 
-function processData(options, type) {
+/** @internal @param {Options} options @returns {Options} */
+export function getDefaultOptions(options) {
   if (!options) options = {};
   options = Object.assign({
     inDirectory: 'data',
@@ -91,7 +111,15 @@ function processData(options, type) {
     processPresets: null,
     listReusedIcons: false
   }, options);
+  return options;
+}
 
+/**
+ * @param {Options} options
+ * @param {'build-interim' | 'build-dist' | 'validate'} type
+ */
+function processData(options, type) {
+  options = getDefaultOptions(options);
   const dataDir = './' + options.inDirectory;
 
   // Translation strings
@@ -241,8 +269,8 @@ function generateCategories(dataDir, tstrings) {
   return categories;
 }
 
-
-function generateFields(dataDir, tstrings, searchableFieldIDs) {
+/** @internal */
+export function generateFields(dataDir, tstrings, searchableFieldIDs) {
   let fields = {};
 
   fs.globSync(dataDir + '/fields/**/*.json', {

lib/translations.js

@@ -3,8 +3,20 @@ import fs from 'fs';
 import fetch from 'node-fetch';
 import YAML from 'js-yaml';
 import { transifexApi } from '@transifex/api';
+import { getExternalTranslations } from './units.js';
 
 
+/** @typedef {{
+  translOrgId: string;
+  translProjectId: string;
+  translResourceIds: string[];
+  translReviewedOnly: false | string[];
+  inDirectory: string;
+  outDirectory: string;
+  sourceLocale: string;
+}} TranslationOptions */
+
+/** @param {Partial<TranslationOptions>} options */
 function fetchTranslations(options) {
 
   // Transifex doesn't allow anonymous downloading
@@ -202,6 +214,8 @@ function fetchTranslations(options) {
     for (let code in allStrings) {
       let obj = {};
       obj[code] = allStrings[code] || {};
+      Object.assign(obj[code], getExternalTranslations(code, options));
+
       fs.writeFileSync(`${outDir}/${code}.json`, JSON.stringify(obj, null, 4));
       fs.writeFileSync(`${outDir}/${code}.min.json`, JSON.stringify(obj));
     }

lib/units.js

@@ -0,0 +1,60 @@
+// @ts-check
+import { createRequire } from 'node:module';
+import { generateFields, getDefaultOptions } from './build.js';
+
+const require = createRequire(import.meta.url);
+
+let cachedFields;
+
+/**
+ * @param {string} locale
+ * @param {Partial<import('./translations.js').TranslationOptions>} options
+ */
+export function getExternalTranslations(locale, options) {
+  options = getDefaultOptions(options);
+  const language = locale.split('-')[0];
+
+  cachedFields ||= generateFields(options.inDirectory, { fields: {} }, {});
+
+  let localeData;
+  let languageData;
+  try {
+    localeData = require(`cldr-units-full/main/${locale}/units.json`);
+  } catch {
+    // ignore
+  }
+  try {
+    languageData = require(`cldr-units-full/main/${language}/units.json`);
+  } catch {
+    // ignore
+  }
+
+  if (!localeData && !languageData) {
+    // eslint-disable-next-line no-console
+    console.warn(`No CLDR data for ${language}`);
+  }
+
+  const output = {};
+
+  for (const field of Object.values(cachedFields)) {
+    if (!field.measurement) continue;
+
+    const { dimension, units } = field.measurement;
+
+    for (const unit in units) {
+      for (const type of ['long', 'narrow']) {
+        const translation =
+          localeData?.main[locale].units[type][`${dimension}-${unit}`]
+            .displayName ||
+          languageData?.main[language].units[type][`${dimension}-${unit}`]
+            .displayName;
+
+        output[dimension] ||= {};
+        output[dimension][unit] ||= {};
+        output[dimension][unit][type] = translation;
+      }
+    }
+  }
+
+  return { units: output };
+}

package-lock.json

@@ -13,6 +13,8 @@
   "exports": "./lib/index.js",
   "dependencies": {
     "@transifex/api": "^7.1.0",
+    "cldr-core": "^47.0.0",
+    "cldr-units-full": "^47.0.0",
     "js-yaml": "^4.0.0",
     "json-schema-to-typescript-lite": "^15.0.0",
     "jsonschema": "^1.1.0",
@@ -31,6 +33,7 @@
     "node": ">=22"
   },
   "scripts": {
+    "build": "node scripts/build-schema.js",
     "lint": "eslint lib",
     "lint:fix": "eslint lib --fix",
     "test": "NODE_OPTIONS=--experimental-vm-modules jest schema-builder.test.js"

package.json

@@ -1,6 +1,6 @@
 {
     "$schema": "http://json-schema.org/draft-07/schema#",
-    "$id": "https://github.com/ideditor/schema-builder/raw/main/schemas/field.json",
+    "$id": "https://cdn.jsdelivr.net/npm/@ideditor/schema-builder/schemas/field.json",
     "title": "Field",
     "description": "A reusable form element for presets",
     "type": "object",
@@ -67,14 +67,13 @@
                 "lanes",
                 "localized",
                 "manyCombo",
+                "measurement",
                 "multiCombo",
                 "networkCombo",
                 "number",
                 "onewayCheck",
                 "radio",
                 "restrictions",
-                "roadheight",
-                "roadspeed",
                 "schedule",
                 "semiCombo",
                 "structureRadio",
@@ -340,11 +339,11 @@
             },
             "additionalProperties": false
         },
-        "urlFormat":  {
+        "urlFormat": {
             "description": "Permalink URL for `identifier` fields. Must contain a {value} placeholder",
             "type": "string"
         },
-        "pattern":  {
+        "pattern": {
             "description": "Regular expression that a valid `identifier` value is expected to match",
             "type": "string"
         },
@@ -364,6 +363,32 @@
         "iconsCrossReference": {
             "description": "A field can reference icons of another by using that field's identifier contained in brackets, like {field}.",
             "type": "string"
+        },
+        "measurement": {
+            "type": "object",
+            "description": "defines the units of measurement that this field uses. Only supported by the 'measurement' field type.",
+            "properties": {
+                "dimension": {
+                    "type": "string",
+                    "description": "The corresponding 'dimension' from CLDR",
+                    "$ref": "./generated/dimension.json"
+                },
+                "units": {
+                    "type": "object",
+                    "description": "Defines the permitted units. The key is the ID used by CLDR. The value is the value used in the OSM tag. If there are multiple values, the first one will be preferred. Use an empty string if the unit is not included in the OSM tag.",
+                    "additionalProperties": {
+                      "type": "array",
+                      "items": {
+                        "type": "string"
+                      },
+                      "minItems": 1
+                    },
+                    "minProperties": 1
+                }
+            },
+            "allOf": [{ "$ref": "./generated/units.json" }],
+            "additionalItems": false,
+            "required": ["dimension", "units"]
         }
     },
     "additionalProperties": false,