ketatlas 0.1.0

package/templates/basic/README.md

@@ -0,0 +1,14 @@
+# My KetAtlas project
+
+Run with Node.js 22 or newer:
+
+```sh
+npx ketatlas serve atlas.json
+npx ketatlas audit atlas.json --strict
+```
+
+Edit `atlas.json` to change nodes, edges, and screen URLs. Screen URLs are relative to that file. Refresh the browser after editing. No wrapper HTML or build step is needed.
+
+Edit the HTML files in screens/ to replace the sample product. styles/design-system.css is generated from the pinned KetJS design system; do not manually fork its tokens.
+
+Keep this directory in your own project repository. The schema provides editor completion. See https://github.com/ketvietlab/ketatlas for the full API, CLI, and configuration reference.

package/templates/basic/atlas.json

@@ -0,0 +1,45 @@
+{
+  "$schema": "./ketatlas.schema.json",
+  "version": 1,
+  "title": "My first atlas",
+  "viewport": {
+    "width": 390,
+    "height": 844
+  },
+  "screens": [
+    {
+      "id": "welcome",
+      "title": "Welcome",
+      "url": "./screens/welcome.html"
+    },
+    {
+      "id": "done",
+      "title": "Ready to go",
+      "url": "./screens/done.html"
+    }
+  ],
+  "flows": [
+    {
+      "id": "getting-started",
+      "title": "Get started",
+      "description": "A real HTML journey. Edit atlas.json to add your own screens and branches.",
+      "nodes": [
+        {
+          "id": "welcome",
+          "screen": "welcome"
+        },
+        {
+          "id": "done",
+          "screen": "done"
+        }
+      ],
+      "edges": [
+        {
+          "from": "welcome",
+          "to": "done",
+          "label": "Continue"
+        }
+      ]
+    }
+  ]
+}

package/templates/basic/ketatlas.schema.json

@@ -0,0 +1,187 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "KetAtlas configuration",
+  "type": "object",
+  "properties": {
+    "$schema": {
+      "type": "string"
+    },
+    "version": {
+      "const": 1
+    },
+    "title": {
+      "type": "string",
+      "pattern": "\\S"
+    },
+    "description": {
+      "type": "string"
+    },
+    "viewport": {
+      "type": "object",
+      "properties": {
+        "width": {
+          "type": "integer",
+          "minimum": 160,
+          "maximum": 4096
+        },
+        "height": {
+          "type": "integer",
+          "minimum": 160,
+          "maximum": 4096
+        }
+      },
+      "required": ["width", "height"],
+      "additionalProperties": false
+    },
+    "screens": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "id": {
+            "type": "string",
+            "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$"
+          },
+          "title": {
+            "type": "string",
+            "pattern": "\\S"
+          },
+          "url": {
+            "type": "string",
+            "pattern": "\\S"
+          },
+          "viewport": {
+            "type": "object",
+            "properties": {
+              "width": {
+                "type": "integer",
+                "minimum": 160,
+                "maximum": 4096
+              },
+              "height": {
+                "type": "integer",
+                "minimum": 160,
+                "maximum": 4096
+              }
+            },
+            "required": ["width", "height"],
+            "additionalProperties": false
+          },
+          "description": {
+            "type": "string"
+          },
+          "badge": {
+            "type": "string"
+          }
+        },
+        "required": ["id", "title", "url"],
+        "additionalProperties": false
+      }
+    },
+    "flows": {
+      "type": "array",
+      "minItems": 1,
+      "items": {
+        "type": "object",
+        "properties": {
+          "id": {
+            "type": "string",
+            "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$"
+          },
+          "title": {
+            "type": "string",
+            "pattern": "\\S"
+          },
+          "group": {
+            "type": "string"
+          },
+          "description": {
+            "type": "string"
+          },
+          "start": {
+            "type": "string",
+            "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$"
+          },
+          "ends": {
+            "type": "array",
+            "items": {
+              "type": "string",
+              "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$"
+            }
+          },
+          "nodes": {
+            "type": "array",
+            "minItems": 1,
+            "items": {
+              "type": "object",
+              "properties": {
+                "id": {
+                  "type": "string",
+                  "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$"
+                },
+                "screen": {
+                  "type": "string",
+                  "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$"
+                },
+                "type": {
+                  "enum": ["screen", "note", "external"]
+                },
+                "title": {
+                  "type": "string"
+                },
+                "description": {
+                  "type": "string"
+                },
+                "url": {
+                  "type": "string",
+                  "pattern": "\\S"
+                },
+                "column": {
+                  "type": "integer",
+                  "minimum": 0,
+                  "maximum": 100
+                },
+                "row": {
+                  "type": "integer",
+                  "minimum": 0,
+                  "maximum": 100
+                }
+              },
+              "required": ["id"],
+              "additionalProperties": false
+            }
+          },
+          "edges": {
+            "type": "array",
+            "items": {
+              "type": "object",
+              "properties": {
+                "from": {
+                  "type": "string",
+                  "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$"
+                },
+                "to": {
+                  "type": "string",
+                  "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$"
+                },
+                "label": {
+                  "type": "string",
+                  "pattern": "\\S"
+                },
+                "kind": {
+                  "enum": ["primary", "conditional", "recovery"]
+                }
+              },
+              "required": ["from", "to", "label"],
+              "additionalProperties": false
+            }
+          }
+        },
+        "required": ["id", "title", "nodes", "edges"],
+        "additionalProperties": false
+      }
+    }
+  },
+  "required": ["version", "title", "flows"],
+  "additionalProperties": false
+}

package/templates/basic/screens/done.html

@@ -0,0 +1,18 @@
+<!doctype html>
+<html lang="en" data-theme="light">
+  <head>
+    <meta charset="utf-8" />
+    <meta name="viewport" content="width=device-width,initial-scale=1" />
+    <title>Your first flow is ready.</title>
+    <link rel="stylesheet" href="screen.css" />
+  </head>
+  <body data-kv-design-system>
+    <header>Your project</header>
+    <main>
+      <small>MADE WITH KETATLAS</small>
+      <h1>Your first flow is ready.</h1>
+      <p>Add screens, connect decisions, and share the entire folder with your team.</p>
+    </main>
+    <footer><a href="welcome.html" data-ui="action" data-variant="primary">Start again</a></footer>
+  </body>
+</html>

package/templates/basic/screens/screen.css

@@ -0,0 +1,48 @@
+@import url("../styles/design-system.css");
+* {
+  box-sizing: border-box;
+}
+html,
+body {
+  margin: 0;
+  height: 100%;
+  font-family: var(--kv-font-sans);
+  color: var(--kv-text-main);
+  background: var(--kv-panel-bg);
+}
+body {
+  display: flex;
+  flex-direction: column;
+}
+header {
+  padding: 24px;
+  border-bottom: 1px solid var(--kv-panel-border);
+  font-weight: 600;
+}
+main {
+  flex: 1;
+  padding: 48px 28px;
+}
+h1 {
+  font-size: 34px;
+  letter-spacing: -0.04em;
+  line-height: 1.15;
+  margin: 0 0 20px;
+}
+p {
+  line-height: 1.7;
+  color: var(--kv-text-secondary);
+}
+footer {
+  padding: 20px;
+  border-top: 1px solid var(--kv-panel-border);
+}
+a[data-ui] {
+  width: 100%;
+  text-decoration: none;
+}
+small {
+  color: var(--kv-accent);
+  display: block;
+  margin-bottom: 20px;
+}

package/templates/basic/screens/welcome.html

@@ -0,0 +1,21 @@
+<!doctype html>
+<html lang="en" data-theme="light">
+  <head>
+    <meta charset="utf-8" />
+    <meta name="viewport" content="width=device-width,initial-scale=1" />
+    <title>Make the journey visible.</title>
+    <link rel="stylesheet" href="screen.css" />
+  </head>
+  <body data-kv-design-system>
+    <header>Your project</header>
+    <main>
+      <small>MADE WITH KETATLAS</small>
+      <h1>Make the journey visible.</h1>
+      <p>
+        This is a real HTML page. Replace it with your own prototype, then connect the next step in
+        atlas.json.
+      </p>
+    </main>
+    <footer><a href="done.html" data-ui="action" data-variant="primary">Continue</a></footer>
+  </body>
+</html>

package/templates/basic/styles/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 KETVIET JSC, Vietnam
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.