@monimesl/dot-cli 1.0.0-beta.1 → 1.0.0-beta.3

package/dist/templates/showcase/pages/dash/system/view.dml

@@ -58,7 +58,7 @@
 
   <View gap="small">
     <Text variant="subtitle">openUrl</Text>
-    <Text variant="caption" tone="muted">Opens a web page in the phone's browser.</Text>
+    <Text variant="caption" tone="muted">Opens an https web page in the phone's browser.</Text>
     <View variant="card">
       <Button variant="secondary" onClick="openDrizilik">Open Drizilik's website</Button>
     </View>
@@ -66,7 +66,7 @@
 
   <View gap="small">
     <Text variant="subtitle">delay</Text>
-    <Text variant="caption" tone="muted">Waits for a number of milliseconds. Dash keeps time, so it's cancelled when the page closes.</Text>
+    <Text variant="caption" tone="muted">Waits for a number of milliseconds. Like any call still running, it stops when the page closes.</Text>
     <View variant="card">
       <Button variant="secondary" onClick="countDown" disabled="{{ showIn > 0 }}">{{ showIn > 0 ? 'Showtime in ' + showIn + 's' : 'Count down to showtime' }}</Button>
     </View>
@@ -74,7 +74,7 @@
 
   <View gap="small">
     <Text variant="subtitle">dial</Text>
-    <Text variant="caption" tone="muted">Opens the phone's dialer with a number ready, or a USSD code such as *715#. The person taps Call.</Text>
+    <Text variant="caption" tone="muted">Opens the phone's dialer with a number ready, or a USSD code such as *715#. The person taps Call. For a code, Dash asks them first.</Text>
     <View variant="card">
       <Input label="Number or code" type="phone" value="{{ number }}" onChange="setNumber" onSubmit="dialNumber" />
       <Button variant="secondary" onClick="dialNumber" disabled="{{ !number }}">Open the dialer</Button>
@@ -83,7 +83,7 @@
 
   <View gap="small">
     <Text variant="subtitle">torch</Text>
-    <Text variant="caption" tone="muted">Turns the camera's light on or off.</Text>
+    <Text variant="caption" tone="muted">Turns the camera's light on or off, on a phone that has one.</Text>
     <View variant="card">
       <Button variant="secondary" onClick="toggleTorch">{{ torchOn ? 'Turn the torch off' : 'Lights up for the slow song' }}</Button>
     </View>

package/dist/templates/showcase/pages/dash/ui/controller.ts

@@ -5,9 +5,13 @@ import state from './state';
 export default definePage({
   initialState: state,
   configs: { navigationBar: { title: 'Dialogs and pickers' } },
+  // A this.dash call goes to Dash and answers later, so await it. If it fails, it throws a
+  // DashError with a code that says why, such as 'cancelled' or 'denied'. errorMessage(error)
+  // gives text to show for any error. The Calls and errors page lists every code.
   actions: {
     async greet() {
       try {
+        // Resolves with { action }: the id of the button tapped.
         const { action } = await this.dash.ui.alert({
           title: 'Kushé',
           message: 'Kushé means hello in Krio, and tenki means thanks.',
@@ -36,7 +40,8 @@ export default definePage({
         this.setState({ note: errorMessage(error) });
       }
     },
-    // unlessCancelled gives undefined when the person closes the picker, which isn't a problem.
+    // Closing a picker rejects with 'cancelled'. That isn't a problem, so unlessCancelled turns it
+    // into undefined. Any other error still throws. A min after max rejects with 'invalid'.
     async chooseNight(state) {
       try {
         const night = await unlessCancelled(

package/dist/templates/showcase/pages/index/controller.ts

@@ -3,6 +3,7 @@ import state from './state';
 export default definePage({
   initialState: state,
   actions: {
+    // Each row's data-page names its page. The Events and Navigation pages show how this works.
     open(_state, event: DataEvent<{ page: PageId }>) {
       this.navigation.push(event.data.page);
     },

package/dist/templates/showcase/pages/index/state.ts

@@ -40,7 +40,7 @@ export default {
         {
           page: 'basics/events',
           title: 'Events',
-          covers: 'onTap, onChange, event.detail, data-*',
+          covers: 'onClick, onTap, onChange, event.detail, event.data',
           icon: 'bolt',
         },
         {
@@ -216,7 +216,7 @@ export default {
         {
           page: 'dash/files',
           title: 'dash.storage.file',
-          covers: 'write, read, list, move, copy, remove, save, stat, open, usage',
+          covers: 'write, read, list, createFolder, move, copy, remove, save, stat, open, usage',
           icon: 'file',
         },
         {
@@ -234,7 +234,7 @@ export default {
         {
           page: 'dash/calls',
           title: 'Calls and errors',
-          covers: 'timeout, cancel, DashError, isDashError',
+          covers: 'timeout, cancel, DashError, isDashError, supports, dash.dot.close',
           icon: 'warning',
         },
       ],

package/dist/templates/starter/.env

@@ -1,3 +1,3 @@
-# Public configuration for the dot. Anyone with the dot can read these variables: never put a
-# secret here. Read them in the service as `env.GREETING`.
+# Public settings for the dot. Code reads each one from `env`, such as `env.GREETING`.
+# They're built into the dot, so anyone who has it can read them. Never put a secret here.
 GREETING=Hello from your dot

package/dist/templates/starter/dot.ts

@@ -1,3 +1,4 @@
 export default defineDot({
+  // Each page is a folder under pages/. The dot opens on the first one.
   pages: ['index'],
 });

package/dist/templates/starter/pages/index/controller.ts

@@ -2,6 +2,8 @@ import state from './state';
 
 export default definePage({
   initialState: state,
+  // A mutation gets the state and returns the fields to change, and the view follows. For steps
+  // that wait, such as a Dash call, use actions instead.
   mutations: {
     increment: (state) => ({ count: state.count + 1 }),
     reset: () => ({ count: 0 }),

package/dist/templates/starter/pages/index/state.ts

@@ -1,4 +1,6 @@
+// The data the page starts with. view.dml shows it with bindings, such as {{ count }}.
 export default {
+  // env holds the values in .env.
   greeting: env.GREETING,
   count: 0,
 };

package/dist/templates/starter/pages/index/view.dml

@@ -3,11 +3,12 @@
     <Image src="statics/logo.png" alt="Logo" width="40" height="40" />
     <Text variant="title">{{ greeting }}</Text>
   </View>
-  <Text>Change pages/index/view.dml and save: the simulator shows it at once.</Text>
+  <Text>Change pages/index/view.dml and save. The simulator shows the change at once.</Text>
 
   <View variant="card" align="center" gap="medium">
     <Text variant="title">{{ count }}</Text>
     <Text tone="muted">{{ count === 1 ? 'tap' : 'taps' }} so far</Text>
+    <!-- onClick names the mutation or action in controller.ts to run. -->
     <View direction="row" gap="small">
       <Button variant="secondary" onClick="reset" disabled="{{ count === 0 }}">Reset</Button>
       <Button onClick="increment">Tap me</Button>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@monimesl/dot-cli",
-  "version": "1.0.0-beta.1",
+  "version": "1.0.0-beta.3",
   "description": "The dotctl command: build mini apps and run them in the simulator",
   "type": "module",
   "repository": {
@@ -24,11 +24,11 @@
   "dependencies": {
     "typescript": "^5.9.3",
     "uqr": "^0.1.3",
-    "@monimesl/dot-compiler": "1.0.0-beta.1",
-    "@monimesl/dot-core": "1.0.0-beta.1",
-    "@monimesl/dot-dml-parser": "1.0.0-beta.1",
-    "@monimesl/dot-script-parser": "1.0.0-beta.1",
-    "@monimesl/dot-simulator": "1.0.0-beta.1"
+    "@monimesl/dot-compiler": "1.0.0-beta.3",
+    "@monimesl/dot-core": "1.0.0-beta.3",
+    "@monimesl/dot-dml-parser": "1.0.0-beta.3",
+    "@monimesl/dot-script-parser": "1.0.0-beta.3",
+    "@monimesl/dot-simulator": "1.0.0-beta.3"
   },
   "devDependencies": {
     "@types/node": "^22.20.4",