Merge branch 'epic/package-metadata' into chore/merge-master-into-package-metadata

Author: mcdurdin

common/schemas/keyboard_info/README.md

@@ -1,18 +1,19 @@
 # keyboard_info
 
-* **keyboard_info.source.json**
-* **keyboard_info.distribution.json**
+* **keyboard_info.schema.json**
 
 Documentation at https://help.keyman.com/developer/cloud/keyboard_info
 
 * Primary version:
-  * https://github.com/keymanapp/api.keyman.com/tree/master/schemas/keyboard_info.source
-  * https://github.com/keymanapp/api.keyman.com/tree/master/schemas/keyboard_info.distribution
+  * https://github.com/keymanapp/api.keyman.com/tree/master/schemas/keyboard_info
 * Synchronized copies at:
   * https://github.com/keymanapp/keyman/tree/master/common/schemas/keyboard_info
 
 # .keyboard_info version history
 
+## 2023-08-11 2.0 stable
+* Removed legacyId, documentationFilename, documentationFileSize. Source vs distribution keyboard_info distinction is removed.
+
 ## 2019-09-06 1.0.6 stable
 * No changes (see api.keyman.com#36 and api.keyman.com#59. Reverted in 2020-06-10.).
 

common/schemas/keyboard_info/keyboard_info.distribution.json

@@ -0,0 +1,121 @@
+{
+  "$schema": "http://json-schema.org/schema#",
+  "$ref": "#/definitions/KeyboardInfo",
+
+  "definitions": {
+    "KeyboardInfo": {
+      "type": "object",
+      "properties": {
+        "id": { "type": "string" },
+        "name": { "type": "string" },
+        "authorName": { "type": "string" },
+        "authorEmail": { "type": "string", "format": "email" },
+        "description": { "type": "string" },
+        "license": { "type": "string", "enum": ["freeware", "shareware", "commercial", "mit", "other"] },
+        "languages": { "anyOf": [
+          { "type": "array", "items": { "type": "string" }, "uniqueItems": true },
+          { "$ref": "#/definitions/KeyboardLanguageInfo" }
+        ]},
+        "lastModifiedDate": { "type": "string", "format": "date-time" },
+        "packageFilename": { "type": "string", "pattern": "\\.km[xp]$" },
+        "packageFileSize": { "type": "number" },
+        "jsFilename": { "type": "string", "pattern": "\\.js$" },
+        "jsFileSize": { "type": "number" },
+        "isRTL": { "type": "boolean" },
+        "encodings": { "type": "array", "items": { "type": "string", "enum": ["ansi", "unicode"] }, "additionalItems": false },
+        "packageIncludes": { "type": "array", "items": { "type": "string", "enum": ["welcome", "documentation", "fonts", "visualKeyboard"] }, "additionalItems": false },
+        "version": { "type": "string" },
+        "minKeymanVersion": { "type": "string", "pattern": "^\\d+\\.\\d$" },
+        "helpLink": { "type": "string", "pattern": "^https://help\\.keyman\\.com/keyboard/" },
+        "platformSupport": { "$ref": "#/definitions/KeyboardPlatformInfo" },
+        "sourcePath": { "type": "string", "pattern": "^(release|legacy|experimental)/.+/.+$" },
+        "related": { "type": "object", "patternProperties": {
+          ".": { "$ref": "#/definitions/KeyboardRelatedInfo" }
+          },
+          "additionalProperties": false
+        },
+        "deprecated": { "type": "boolean" }
+      },
+      "required": [ "id", "name", "license", "languages", "lastModifiedDate", "platformSupport" ]
+    },
+
+    "KeyboardLanguageInfo": {
+      "type": "object",
+      "patternProperties": {
+        ".": { "$ref": "#/definitions/KeyboardLanguageInfoItem" }
+      },
+      "additionalProperties": false
+    },
+
+    "KeyboardLanguageInfoItem": {
+      "type": "object",
+      "properties": {
+        "font": { "$ref": "#/definitions/KeyboardFontInfo" },
+        "oskFont": { "$ref": "#/definitions/KeyboardFontInfo" },
+        "examples": { "type": "array", "items": { "$ref": "#/definitions/KeyboardExampleInfo" } },
+        "displayName": { "type": "string" },
+        "languageName": { "type": "string" },
+        "scriptName": { "type": "string" },
+        "regionName": { "type": "string" }
+      },
+      "required": [],
+      "additionalProperties": false
+    },
+
+    "KeyboardFontInfo": {
+      "type": "object",
+      "properties": {
+        "family": { "type": "string" },
+        "source": { "type": "array", "items": { "type": "string" } }
+      },
+      "required": ["family", "source"],
+      "additionalProperties": false
+    },
+
+    "KeyboardExampleInfo": {
+      "type": "object",
+      "properties": {
+        "keys": {
+          "type": "array",
+          "items": { "$ref": "#/definitions/KeyboardExampleKeyInfo" }
+        },
+        "text": { "type": "string" },
+        "note": { "type": "string" }
+      },
+      "required": ["keys", "text"],
+      "additionalProperties": false
+    },
+
+    "KeyboardExampleKeyInfo": {
+      "type": "object",
+      "properties": {
+        "key": { "type": "string" },
+        "modifiers": {
+          "type": "array",
+          "items": { "type": "string" }
+        }
+      },
+      "required": ["key"],
+      "additionalProperties": false
+    },
+
+    "KeyboardPlatformInfo": {
+      "type": "object",
+      "patternProperties": {
+        "^(windows|macos|desktopWeb|ios|android|mobileWeb|linux)$": { "type": "string", "enum": ["dictionary", "full", "basic", "none"] }
+      },
+      "required": [],
+      "additionalProperties": false
+    },
+
+    "KeyboardRelatedInfo": {
+      "type": "object",
+      "properties": {
+        "deprecates": { "type": "boolean" },
+        "deprecatedBy": { "type": "boolean" }
+      },
+      "required": [],
+      "additionalProperties": false
+    }
+  }
+}

common/schemas/keyboard_info/keyboard_info.schema.json

@@ -6,6 +6,9 @@ always '1.0'. It will be required for version 2.0 and later of the format.
 **Note:** An additional schema file, kpj-9.0.schema.json, for supporting legacy
   versions of .kpj, from Keyman Developer 9.0 and earlier, is now available.
 
+## 2023-08-07 2.0.1
+* Add Options/SkipMetadataFiles, defaults to True for 1.0 projects.
+
 ## 2023-02-27 2.0
 * Version 2.0 makes 'Files' optional (internally, Files/File will be ignored,
   deleted on load and populated from folder structure). Adds Options/SourcePath,

common/schemas/keyboard_info/keyboard_info.source.json

@@ -45,6 +45,10 @@
           "type": "string",
           "pattern": "^(True|False)$"
         },
+        "SkipMetadataFiles": {
+          "type": "string",
+          "pattern": "^(True|False)$"
+        },
         "ProjectType": {
           "type": "string",
           "pattern": "^(keyboard|lexicalmodel)$"