@monimesl/dot-runtime 0.1.0-alpha.10 → 0.1.0-alpha.12

package/README.md

@@ -1 +1,11 @@
 # @monimesl/dot-runtime
+
+Everything a dot needs: `defineDot`, `definePage`, the `dash` calls, and the renderer that draws its
+pages. It also ships `dot.schema.json`, the schema editors use to check and complete `dot.json`.
+
+## Which Dash opens a dot
+
+The build writes the runtime's version into the dot's `manifest.json`. Dash opens the dot unless it
+was built with a newer major version than the runtime Dash has. A newer minor version can add Dash
+calls that an older Dash doesn't have yet. There, such a call fails with a `HostError` whose `code`
+is `unsupported`, so catch it and carry on without the feature.

package/dot.schema.json

@@ -4,16 +4,21 @@
   "description": "Settings for a dot, a mini app that runs inside Dash. Pages are listed in dot.ts, with defineDot({ pages }).",
   "type": "object",
   "properties": {
+    "id": {
+      "description": "The ID Monime gives the dot when you register it. Only publishing needs it.",
+      "type": "string",
+      "minLength": 1
+    },
     "$schema": {
       "description": "The schema editors use to check and complete this file.",
       "type": "string"
     },
-    "id": {
-      "description": "The dot's unique identifier, as a reverse domain name, such as \"com.example.counter\". It never changes once the dot is published.",
+    "package": {
+      "description": "The dot's package name: a reverse domain name you own, such as \"com.mysalone.thing\". It never changes once the dot is published.",
       "type": "string",
       "pattern": "^(?=[a-z])[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?(?:\\.[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?)+$",
       "maxLength": 128,
-      "patternErrorMessage": "Use a reverse domain name, such as \"com.example.counter\": lowercase words of letters, digits and hyphens, joined by dots. A word can't start or end with a hyphen, or be longer than 63 characters."
+      "patternErrorMessage": "Use lowercase words joined by dots, such as \"com.mysalone.thing\"."
     },
     "name": {
       "description": "The dot's display name, which Dash shows.",
@@ -27,65 +32,6 @@
       "patternErrorMessage": "Use a semantic version, such as \"1.0.0\".",
       "examples": ["1.0.0", "1.1.0-beta.1"]
     },
-    "description": {
-      "description": "One line about what the dot does, shown in Dash's listing.",
-      "type": "string",
-      "minLength": 1
-    },
-    "categories": {
-      "description": "Where Dash lists the dot: one or more, such as [\"finance\", \"savings\"].",
-      "type": "array",
-      "items": {
-        "type": "string",
-        "enum": [
-          "agriculture",
-          "asset_finance",
-          "donations",
-          "education",
-          "electricity",
-          "entertainment",
-          "events",
-          "finance",
-          "food_and_drink",
-          "gambling",
-          "games",
-          "government",
-          "health",
-          "insurance",
-          "internet_service_provider",
-          "investments",
-          "jobs",
-          "lifestyle",
-          "loans",
-          "micro_credit",
-          "microfinance",
-          "news",
-          "other",
-          "productivity",
-          "real_estate",
-          "religion",
-          "remittances",
-          "savings",
-          "shopping",
-          "social",
-          "sports",
-          "telecom",
-          "television",
-          "transport",
-          "travel",
-          "utilities",
-          "water"
-        ]
-      },
-      "minItems": 1,
-      "uniqueItems": true
-    },
-    "icon": {
-      "description": "The dot's icon: a square PNG file, relative to this file, such as \"icon.png\".",
-      "type": "string",
-      "pattern": "\\.png$",
-      "patternErrorMessage": "Use a PNG file, such as \"icon.png\"."
-    },
     "permissions": {
       "description": "What the dot may ask the person for, each with the reason Dash shows before granting it.",
       "type": "object",
@@ -118,22 +64,8 @@
       },
       "required": ["hosts"],
       "additionalProperties": false
-    },
-    "dash": {
-      "description": "What the dot needs from Dash, the app it runs in.",
-      "type": "object",
-      "properties": {
-        "minVersion": {
-          "description": "The oldest Dash version the dot runs in, such as \"2.4.0\". Older versions of Dash should not open it.",
-          "type": "string",
-          "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)\\.(0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$",
-          "patternErrorMessage": "Use a semantic version, such as \"2.4.0\".",
-          "examples": ["2.4.0"]
-        }
-      },
-      "additionalProperties": false
     }
   },
-  "required": ["id", "name", "version"],
+  "required": ["package", "name", "version"],
   "additionalProperties": false
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@monimesl/dot-runtime",
-  "version": "0.1.0-alpha.10",
+  "version": "0.1.0-alpha.12",
   "description": "A composer of the service and webview runtimes and the default React renderer",
   "type": "module",
   "repository": {
@@ -54,10 +54,10 @@
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "dependencies": {
-    "@monimesl/dot-dash": "0.1.0-alpha.10",
-    "@monimesl/dot-renderer-react": "0.1.0-alpha.10",
-    "@monimesl/dot-webview": "0.1.0-alpha.10",
-    "@monimesl/dot-service": "0.1.0-alpha.10"
+    "@monimesl/dot-renderer-react": "0.1.0-alpha.12",
+    "@monimesl/dot-dash": "0.1.0-alpha.12",
+    "@monimesl/dot-webview": "0.1.0-alpha.12",
+    "@monimesl/dot-service": "0.1.0-alpha.12"
   },
   "devDependencies": {
     "publint": "^0.3.24",