@xeplr/cli 0.2.0 → 0.3.0

package/README.md

@@ -77,6 +77,7 @@ These are architecture decisions, not defaults to tune — each one exists becau
 | **`REDIS_PREFIX` is required and unique per app** (`api/development.env`, set to `<name>:`). | `@xeplr/auth`, `@xeplr/utils` | Two apps on one Redis under the shared default serve each other's sessions, menus and API permissions. Sign-in refuses to start without it, or with `xeplr:`. |
 | **Designing, new forms and publishing are Super Admin only.** | `api/routes/access.js`, `@xeplr/auth` menu routes | Publishing changes database tables. Every other screen route checks the permission catalog. |
 | **The browser is not a security boundary.** Front-end hooks (`ui/src/pages/Edit<Form>.jsx`) shape what people see and send; anything that must hold goes in server hooks (`api/screens/<form>/<form>.hooks.js`); data shape in the model (`<form>.model.js`). | `@xeplr/ui-factory`, `@xeplr/factory` | |
+| **Anything every app would write identically lives in a package, not in the generated app.** A generated app is a starting point that then lives its own life — glue copied into it can never be fixed centrally, so an app made last month keeps that copy forever. When the flow designer needed this app's forms as its Screen steps, the wiring went into `@xeplr/ui-factory` (`useScreenSource`) and the generated page passes two props. | `@xeplr/ui-factory`, `@xeplr/ui-workflow` | A fix or a new control type has to reach apps that already exist, and it cannot reach code that was copied into them. `test/cli.test.js` fails if the glue reappears in the generated app. |
 | **Every data address is under `/api`.** | `api/routes`, `ui/vite.config.js` | A page path and a data path must never collide. |
 | **No guessed database names or connections.** | `api/development.env` | A wrong-but-present value starts cleanly and reads as empty data. |
 | **Email is checked at start, never fatal.** The sign-in banner shows `email ✓ …` or `✗ NOT WORKING — reason`. | `@xeplr/auth` | Sign-in works without email; activation, invite and reset links cannot be sent until `EMAIL_PROVIDER` is set. |

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xeplr/cli",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "description": "Creates a working xeplr application — API, sign-in and UI — from a few answers.",
   "license": "MIT",
   "author": "xeppie <admin@xeplr.com>",

package/templates/api/bin/workflow

@@ -7,7 +7,7 @@
 //
 // The SAME workflow as the embedded one (../workflow.js): this app's database,
 // this app's tenancy and membership gate, the same permission checks, and the
-// same path — /api/workflow/flows — so the browser cannot tell the two apart.
+// same path — /api/workflow — so the browser cannot tell the two apart.
 // What routes /api/workflow here: ui/.env WORKFLOW_URL for Vite's dev proxy,
 // nginx in production (README, "Production").
 require('dotenv').config({ path: require('path').join(__dirname, '..', (process.env.NODE_ENV || 'development') + '.env') });
@@ -28,7 +28,7 @@ async function start() {
   // This app's tenancy levels, registered exactly as the API registers them.
   await require('../db/setup');
   var app = require('../app');
-  var flowsRouter = await require('../workflow')(app.memberGate);
+  var workflowRouter = await require('../workflow')(app.memberGate);
 
   var health = express.Router();
   health.get('/', function(req, res) { res.json({ status: 'ok', service: 'workflow' }); });
@@ -41,7 +41,7 @@ async function start() {
     middleware: app.middleware(),
     routes: {
       '/health': health,
-      '/api/workflow/flows': flowsRouter
+      '/api/workflow': workflowRouter
     }
   });
 }

package/templates/api/package.json

@@ -21,10 +21,10 @@
     "@xeplr/auth": "^1.1.4",
     "@xeplr/base-apis": "^2.0.0",
     "@xeplr/db": "^1.0.6",
-    "@xeplr/factory": "^1.0.6",
-    "@xeplr/ui-factory": "^1.0.14",
+    "@xeplr/factory": "^1.1.0",
+    "@xeplr/ui-factory": "^1.1.0",
     "@xeplr/utils": "^1.0.11",
-    "@xeplr/workflow": "^1.1.0",
+    "@xeplr/workflow": "^1.2.0",
     "dotenv": "^17.4.2",
     "express": "^5.2.0",
     "multer": "^2.0.2"

package/templates/api/routes/flows.js

@@ -20,24 +20,28 @@
 //                    "Start flow run"…), granted by @xeplr/workflow's
 //                    migrations-auth — in XEPLR_AUTH_MIGRATIONS.
 //
-// Mounted by routes/index.js at /api/workflow/flows, behind this app's auth gate.
+// Mounted by routes/index.js at /api/workflow, behind this app's auth gate.
+// Everything Workflow serves lives under it:
+//   /api/workflow/flows       the flows people walk through (Journey)
+//   /api/workflow/workflows   the designer's document API
+//   /api/workflow/actions     what a step can DO, for the palette
 var express = require('express');
 
 var router = express.Router();
-var flows = null;
+var workflow = null;
 
 router.use(function(req, res, next) {
   if (process.env.WORKFLOW_PORT) {
     return res.status(404).json({ message: 'Workflow runs on its own port (WORKFLOW_PORT) — route /api/workflow there (ui/.env WORKFLOW_URL, or nginx)' });
   }
   // Only before startup has finished — bin/www mounts it before listening.
-  if (!flows) return res.status(503).json({ message: 'Flows are still starting' });
-  return flows(req, res, next);
+  if (!workflow) return res.status(503).json({ message: 'Flows are still starting' });
+  return workflow(req, res, next);
 });
 
-/** bin/www hands over registerWorkflow's flowsRouter, already gated. */
-router.mount = function(flowsRouter) {
-  flows = flowsRouter;
+/** bin/www hands over registerWorkflow's router, already gated. */
+router.mount = function(workflowRouter) {
+  workflow = workflowRouter;
 };
 
 module.exports = router;

package/templates/api/routes/index.js

@@ -34,9 +34,9 @@ router.get('/whoami', function(req, res) {
 //   var { genericRoute } = require('@xeplr/base-apis');
 //   router.use('/api/things', genericRoute({ key: 'thing', model: require('../models').Thing }));
 
-// Flows: Xeplr Workflow, at /api/workflow/flows — inside this API, or on its
+// Flows: Xeplr Workflow, at /api/workflow — inside this API, or on its
 // own port with WORKFLOW_PORT (see routes/flows.js). The path is the same
 // either way: the browser never knows which.
-router.use('/api/workflow/flows', require('./flows'));
+router.use('/api/workflow', require('./flows'));
 
 module.exports = router;

package/templates/api/workflow.js

@@ -9,7 +9,14 @@
 // @xeplr/workflow's migrations-auth, which XEPLR_AUTH_MIGRATIONS loads.
 var { registerWorkflow } = require('@xeplr/workflow');
 
-/** Runs workflow's migrations, and returns its flows router — already gated. */
+/**
+ * Runs workflow's migrations and returns its ROUTER — already gated.
+ *
+ * The whole router, not just the flows facade: it carries `/flows` (the
+ * screens a person walks through) AND `/workflows` (the designer's own
+ * document API). One designer serves both — @xeplr/ui-workflow's canvas, the
+ * same one every xeplr product uses — so the app has to serve what it reads.
+ */
 module.exports = async function startWorkflow(memberGate) {
   var workflow = await registerWorkflow({
     applicationId: '__NAME__',
@@ -23,5 +30,5 @@ module.exports = async function startWorkflow(memberGate) {
     access: true,
     mtMembershipGate: memberGate
   });
-  return workflow.flowsRouter;
+  return workflow.router;
 };

package/templates/ui/package.json

@@ -11,12 +11,14 @@
   "dependencies": {
     "@tanstack/react-table": "^8.21.3",
     "@xeplr/ui-account": "^1.0.9",
-    "@xeplr/ui-canvas": "^1.0.2",
-    "@xeplr/ui-factory": "^1.0.14",
+    "@xeplr/ui-canvas": "^1.1.0",
+    "@xeplr/ui-factory": "^1.1.0",
     "@xeplr/ui-table": "^1.0.6",
     "react": "^19.2.4",
     "react-dom": "^19.2.4",
-    "react-router-dom": "^7.13.2"
+    "react-router-dom": "^7.13.2",
+    "@xeplr/ui-workflow": "^1.2.0",
+    "@xeplr/ui-utils": "^1.0.2"
   },
   "devDependencies": {
     "@vitejs/plugin-react": "^5.2.0",

package/templates/ui/src/pages/FlowDesigner.jsx

@@ -1,37 +1,54 @@
-// One flow, on the canvas: the published forms on the left, arrows between
-// them, and on the right what happens after the screen you picked. Saves
-// itself; Publish is what people then walk through.
-import { useEffect, useState } from 'react'
-import { useParams, Link } from 'react-router-dom'
-import { FlowBuilder } from '@xeplr/ui-factory'
-import { flows } from '../api/flows.js'
+// ONE FLOW, ON WORKFLOW'S OWN CANVAS.
+//
+// The designer is a component from @xeplr/ui-workflow — the same one BI and
+// every other xeplr product uses — dropped straight onto this page. It is not
+// a section mounted at URLs of its own: this app already has a page for it,
+// inside its own shell, and the designer renders where it is put.
+//
+// There used to be a second, screens-only builder here (@xeplr/ui-factory's
+// FlowBuilder). One designer over one engine is the point: the trigger box,
+// the condition boxes and the reference pickers are built once, and this app
+// gets them by upgrading a package.
+//
+// THIS APP'S FORMS ARE THE FLOW'S SCREENS. A step can show one and wait for
+// somebody to fill it in, and `useScreenSource` is @xeplr/ui-factory's answer
+// to the two things the designer asks its host: which screens exist (with
+// what each one hands back, so a later step can pick `title` by name) and how
+// to design one without leaving the flow. Two props, because the alternative
+// was the same twenty lines in every app — and a copy in your app could never
+// be fixed once.
+//
+// WHERE THE API IS: /api/workflow, always — the dev proxy (vite.config.js) or
+// nginx decides whether that is this API or Workflow on its own port.
+import { useParams, useNavigate } from 'react-router-dom'
+import { WorkflowDesigner } from '@xeplr/ui-workflow'
+import { useScreenSource, FactoryBuilder } from '@xeplr/ui-factory'
 import { factory } from '../api/factory.js'
 
 export default function FlowDesigner() {
   const { flow: key } = useParams()
-  const [flow, setFlow] = useState(null)
-  const [screens, setScreens] = useState([])
-  const [error, setError] = useState(null)
+  const navigate = useNavigate()
+  const { screens, screenEditor } = useScreenSource(factory, { Builder: FactoryBuilder })
 
-  useEffect(() => {
-    flows.loadFlow(key).then(setFlow, (e) => setError(e.message))
-    // A step is a FORM (an edit screen) that is published: what people will
-    // actually see, and something they can fill in.
-    factory.listScreens().then((rows) => setScreens(rows
-      .filter((s) => /_edit$/.test(s.screenKey) && s.version !== null)
-      .map((s) => ({ id: s.screenKey, name: s.name }))), () => {})
-  }, [key])
-
-  if (error) return <div className="app-page"><div className="app-error">{error}</div></div>
-  if (!flow) return null
   return (
     <div className="app-designer">
-      <div className="app-designer-bar">
-        <Link to="/configure?tab=flows">← All flows</Link>
-      </div>
-      <div className="app-designer-canvas">
-        <FlowBuilder {...flows.builderProps} flow={flow} screens={screens} loadScreen={factory.loadScreen} />
-      </div>
+      <WorkflowDesigner
+        apiBase="/api/workflow"
+        screens={screens}
+        screenEditor={screenEditor}
+        // BY KEY, because that is what this app's URLs carry:
+        // /configure/flows/leave_request. A flow is created on the Flows page
+        // with a key made from its name, and that key is how it is addressed
+        // for the rest of its life — a readable link that survives a rebuild
+        // minting new ids.
+        workflowKey={key === 'new' ? undefined : key}
+        newKind={key === 'new' ? 'workflow' : undefined}
+        // Only reachable from /configure/flows/new, which this app does not
+        // link to — the Flows page creates the flow first, so the designer
+        // always opens on one that exists.
+        onOpened={(saved) => navigate('/configure/flows/' + saved, { replace: true })}
+        onBack={() => navigate('/configure?tab=flows')}
+      />
     </div>
   )
 }

package/templates/ui/src/pages/Flows.jsx

@@ -1,15 +1,29 @@
 // CONFIGURE UI → FLOWS — every journey across the app's forms.
 //
-// A flow is screens one after another: what someone fills in on one decides
-// which comes next. It is run by Xeplr Workflow, so a journey can be left and
-// picked up later — by someone else, on another day. Design it here; open it
-// at /journey/<key>.
+// A flow is what someone is walked through: screens one after another, and
+// whatever has to happen between them. What they fill in on one decides which
+// comes next. Xeplr Workflow runs it, so a journey can be left and picked up
+// later — by someone else, on another day. Design it here; open it at
+// /journey/<key>.
 //
-// Run by @xeplr/workflow inside this app's own API and database — nothing to
-// connect.
+// A FLOW IS AN ORDINARY WORKFLOW, addressed by a key this page makes from its
+// name. It used to be created as kind 'screens', which is a workflow whose
+// steps are GENERATED from a design held in another app — and that app was
+// the screens-only builder this one replaced. The designer then had to refuse
+// to edit its own flows ("designed in Configure UI"), which is how a flow
+// became a page you could open and not change.
+//
+// So a flow is a workflow now, and every kind of step is available inside it:
+// a Screen for the part a person fills in, an Action for the email that goes
+// out after it, a Condition for where it goes next. Flows created the old way
+// still appear here and still run; the designer shows them read-only.
 import { useEffect, useState } from 'react'
 import { Link, useNavigate } from 'react-router-dom'
-import { flows } from '../api/flows.js'
+import { listWorkflows, saveWorkflow, configureWorkflowApi } from '@xeplr/ui-workflow'
+
+// The same mount the designer uses. Said here as well because this page can
+// be the first one to ask, and a base set after the first request is too late.
+configureWorkflowApi('/api/workflow')
 
 export default function Flows() {
   const [list, setList] = useState(null)
@@ -18,7 +32,7 @@ export default function Flows() {
   const [name, setName] = useState('')
   const navigate = useNavigate()
 
-  const load = () => flows.listFlows().then(setList, (e) => {
+  const load = () => listWorkflows().then(setList, (e) => {
     const off = flowsOffline(e)
     if (off) setOffline(off)
     else setError(e.message)
@@ -31,7 +45,9 @@ export default function Flows() {
     if (!label) return
     const key = label.toLowerCase().replace(/[^a-z0-9]+/g, '_').replace(/^_+|_+$/g, '')
     try {
-      await flows.createFlow({ key, name: label })
+      // No steps: the designer is where those come from, and it opens on the
+      // flow this creates. `key` is what every link to it uses from here on.
+      await saveWorkflow({ name: label, key, kind: 'workflow', status: 'draft' })
       navigate(`/configure/flows/${key}`)
     } catch (err) {
       setError(err.message)
@@ -62,14 +78,20 @@ export default function Flows() {
           <thead><tr><th>Flow</th><th>Key</th><th>Status</th><th>Screens</th><th /></tr></thead>
           <tbody>
             {list.map((f) => (
-              <tr key={f.key}>
+              <tr key={f.id || f.key}>
                 <td><strong>{f.name}</strong></td>
-                <td className="app-sub">{f.key}</td>
-                <td>{f.status}</td>
+                <td className="app-sub">{f.key || '—'}</td>
+                <td>{f.kind === 'screens' ? f.status + ' · read-only' : f.status}</td>
                 <td>{typeof f.steps === 'number' ? f.steps : (f.steps || []).length}</td>
                 <td className="app-row-actions">
-                  <Link to={`/configure/flows/${f.key}`}>Design</Link>
-                  {f.status === 'published' && <Link to={`/journey/${f.key}`}>Open</Link>}
+                  {f.key && <Link to={`/configure/flows/${f.key}`}>Design</Link>}
+                  {/* PUBLISHING IS A SCREENS-FLOW IDEA: there, publish is what
+                      checks the design before somebody is walked through it.
+                      A flow drawn in the designer has no such step, so it can
+                      be opened as soon as it has one. */}
+                  {(f.kind === 'screens' ? f.status === 'published' : (f.steps || []).length > 0) && f.key && (
+                    <Link to={`/journey/${f.key}`}>Open</Link>
+                  )}
                 </td>
               </tr>
             ))}