fix: Using 3 letter ISO639 language codes (#173)

* fix: Using 3 letter ISO639 language codes * fix: Various PR comments resolved * fix: Typo and schemas path priority
rdkcentral · Aug 31, 2023 · b341dee · b341dee
1 parent 6c1487b
commit b341dee
Show file tree

Hide file tree

Showing 7 changed files with 129 additions and 10 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -15,7 +15,7 @@
     "validate:each": "npx firebolt-openrpc validate --input src/openrpc --schemas node_modules/@firebolt-js/schemas/src/schemas --schemas src/schemas --transformations",
     "validate:compiled": "npx firebolt-openrpc validate --input dist/firebolt-open-rpc.json && npm run validate --workspaces",
     "validate": "npm run validate:each && npm run validate:compiled ",
-    "compile": "npx firebolt-openrpc openrpc --input src --template src/template/openrpc/template.json --output ./dist/firebolt-open-rpc.json --schemas src/schemas --schemas node_modules/@firebolt-js/schemas/src/schemas",
+    "compile": "npx firebolt-openrpc openrpc --input src --template src/template/openrpc/template.json --output ./dist/firebolt-open-rpc.json --schemas node_modules/@firebolt-js/schemas/src/schemas --schemas src/schemas",
     "slice": "npm run slice --workspaces",
     "sdks": "npm run sdk --workspaces",
     "docs": "npm run docs --workspaces",

diff --git a/src/openrpc/accessibility.json b/src/openrpc/accessibility.json
@@ -51,7 +51,11 @@
                 "textAlignVertical": "middle",
                 "windowColor": "white",
                 "windowOpacity": 50
-              }
+              },
+              "preferredLanguages": [
+                "eng",
+                "spa"
+              ]              
             }
           }
         }
@@ -100,7 +104,11 @@
                 "textAlignVertical": "middle",
                 "windowColor": "white",
                 "windowOpacity": 50
-              }
+              },
+              "preferredLanguages": [
+                "eng",
+                "spa"
+              ]
             }
           }
         }

diff --git a/src/openrpc/closed_captions.json b/src/openrpc/closed_captions.json
@@ -621,6 +621,56 @@
                     }
                 }
             ]
+        },
+        {
+            "name": "preferredLanguages",
+            "summary": "A prioritized list of ISO 639-2/B codes for the preferred closed captions languages on this device.",
+            "params": [],
+            "tags": [
+                {
+                    "name": "property"
+                },
+                {
+                    "name": "capabilities",
+                    "x-uses": [
+                        "xrn:firebolt:capability:accessibility:closedcaptions"
+                    ]
+                }
+            ],
+            "result": {
+                "name": "languages",
+                "summary": "the preferred closed captions languages",
+                "schema": {
+                    "type": "array",
+                    "items": {
+                        "$ref": "https://meta.comcast.com/firebolt/localization#/definitions/ISO639_2Language"
+                    }
+                }
+            },
+            "examples": [
+                {
+                    "name": "Default Example",
+                    "params": [],
+                    "result": {
+                        "name": "Default Result",
+                        "value": [
+                            "spa",
+                            "eng"
+                        ]
+                    }
+                },
+                {
+                    "name": "Default Example #2",
+                    "params": [],
+                    "result": {
+                        "name": "Default Result",
+                        "value": [
+                            "eng",
+                            "spa"
+                        ]
+                    }
+                }
+            ]
         }
     ],
     "components": {

diff --git a/src/openrpc/localization.json b/src/openrpc/localization.json
@@ -99,7 +99,7 @@
           ]
         }
       ],
-      "summary": "Get the ISO 3166 code for the counrty device is located in",
+      "summary": "Get the ISO 3166-1 alpha-2 code for the country device is located in",
       "params": [],
       "result": {
         "name": "code",
@@ -132,6 +132,11 @@
       "summary": "Get the ISO 639 1/2 code for the preferred language",
       "params": [],
       "tags": [
+        {
+          "name": "deprecated",
+          "x-since": "0.17.0",
+          "x-alternative": "Localization.locale"
+        },
         {
           "name": "property"
         },
@@ -189,7 +194,7 @@
         "schema": {
           "type": "array",
           "items": {
-            "type": "string"
+            "$ref": "https://meta.comcast.com/firebolt/localization#/definitions/ISO639_2Language"
           }
         }
       },
@@ -199,15 +204,15 @@
           "params": [],
           "result": {
             "name": "Default Result",
-            "value": ["es", "en"]
+            "value": ["spa", "eng"]
           }
         }, 
         {
           "name": "Default Example #2",
           "params": [],
           "result": {
             "name": "Default Result",
-            "value": ["en", "es"]
+            "value": ["eng", "spa"]
           }
         }             
       ]

diff --git a/src/schemas/accessibility.json b/src/schemas/accessibility.json
@@ -91,6 +91,12 @@
                 },
                 "styles": {
                     "$ref": "#/definitions/ClosedCaptionsStyles"
+                },
+                "preferredLanguages": {
+                    "type": "array",
+                    "items": {
+                        "$ref": "https://meta.comcast.com/firebolt/localization#/definitions/ISO639_2Language"
+                    }
                 }
             },
             "examples": [
@@ -109,7 +115,11 @@
                         "textAlignVertical": "middle",
                         "windowColor": "white",
                         "windowOpacity": 50
-                    }
+                    },
+                    "preferredLanguages": [
+                        "eng",
+                        "spa"
+                      ]        
                 }
             ]
         },

diff --git a/src/schemas/localization.json b/src/schemas/localization.json
@@ -0,0 +1,46 @@
+{
+    "$id": "https://meta.comcast.com/firebolt/localization",
+    "title": "Localization",
+    "oneOf": [
+        {
+            "$ref": "#/definitions/Locality"
+        },
+        {
+            "$ref": "#/definitions/CountryCode"
+        },
+        {
+            "$ref": "#/definitions/Language"
+        },
+        {
+            "$ref": "#/definitions/Locale"
+        },
+        {
+            "$ref": "#/definitions/TimeZone"
+        }
+    ],
+    "definitions": {
+        "CountryCode": {
+            "type": "string",
+            "pattern": "^[A-Z]{2}$"
+        },
+        "Language": {
+            "type": "string",
+            "pattern": "^[A-Za-z]{2}$"
+        },
+        "ISO639_2Language": {
+            "type": "string",
+            "pattern": "^[a-z]{3}$"
+        },
+        "Locality": {
+            "type": "string"
+        },
+        "Locale": {
+            "type": "string",
+            "pattern": "^[a-zA-Z]+([a-zA-Z0-9\\-]*)$"
+        },
+        "TimeZone": {
+            "type": "string",
+            "pattern": "^[-+_\/ A-Za-z 0-9]*$"
+        }
+    }
+}