flowdular 0.1.0 → 0.2.1

package/README.md

@@ -1,30 +1,86 @@
+[![Flowdular: Build your business platform](https://cdn.jsdelivr.net/npm/flowdular@latest/assets/flowdular-banner.png)](https://flowdular.com)
+
 # Flowdular CLI
 
-Manage a Flowdular workspace with the `flowdular` command (`fd` is an alias).
-Create an application first:
+[![npm version](https://img.shields.io/npm/v/flowdular?color=f59e0b)](https://www.npmjs.com/package/flowdular)
+[![Node.js](https://img.shields.io/badge/node-%3E%3D22.22.2-339933?logo=nodedotjs&logoColor=white)](https://nodejs.org/)
+[![License: MIT](https://img.shields.io/badge/license-MIT-blue)](https://github.com/Flowdular/flowdular/blob/main/LICENSE)
+
+Inspect, configure and extend a Flowdular application from your terminal. The CLI manages module validation, source installation, generated composition and workspace diagnostics.
+
+## Quick start
+
+Use Node.js **22.22.2 or newer**. Create a configured pnpm workspace:
 
 ```sh
 npm create flowdular@latest my-app
 cd my-app
 pnpm flowdular doctor
+pnpm flowdular help
+```
+
+The generator includes the CLI. To add it to an existing Flowdular workspace:
+
+```sh
+pnpm add -Dw flowdular
 ```
 
-The npm package is named `flowdular`. The shared platform API and UI are in
-`@flowdular/sdk`; the generator is `create-flowdular`. Internal packages in the
-Flowdular repository are private workspaces and do not require separate npm releases.
+The executable is `flowdular`; `fd` is also available as an alias. Run commands from your application workspace.
+
+## Everyday commands
+
+| Command                                   | Purpose                                         |
+| ----------------------------------------- | ----------------------------------------------- |
+| `pnpm flowdular doctor`                   | Inspect workspace configuration and diagnostics |
+| `pnpm flowdular help`                     | List commands and supported flags               |
+| `pnpm flowdular module search`            | Browse the configured source catalog            |
+| `pnpm flowdular module install <id>`      | Preview a source installation                   |
+| `pnpm flowdular module sync --apply`      | Regenerate application composition              |
+| `pnpm flowdular module validate --locked` | Validate modules against the installation lock  |
+
+## Install a business module
+
+For a catalog containing `expenses.core`:
 
 ```sh
-pnpm flowdular module search
+# Inspect the planned source installation.
 pnpm flowdular module install expenses.core
+
+# Download and unpack the module source.
 pnpm flowdular module install expenses.core --apply
+
+# Enable the module and grant its scopes in the configured application.
 pnpm flowdular module enable expenses.core --apply
+
+# Check the installed modules against their lock.
 pnpm flowdular module validate --locked
 ```
 
-Source installation previews by default and does not activate code or touch a
-database. Official source catalog downloads require access to the repository;
-an explicit local catalog can be supplied with `--registry /path/to/index.json`.
-Use `pnpm flowdular help` for commands, permissions and explicit apply flags.
+Source installation previews by default. Applying it writes source under `modules/`; activation is a separate step. Enabling a module updates application composition and can grant scopes against the configured database.
+
+[Official Modules](https://github.com/Flowdular/official-modules) requires repository access while private. For an accessible local catalog, pass `--registry /absolute/path/to/index.json` to the search or install command. Catalog availability is independent of npm package installation.
+
+## Automation
+
+Release tooling can import the source distribution API through `flowdular/distribution`. Command permissions and apply requirements are documented in the [CLI guide](https://github.com/Flowdular/flowdular/blob/main/docs/cli.md).
+
+## Packages and support
+
+- [@flowdular/sdk](https://www.npmjs.com/package/@flowdular/sdk): shared platform APIs, UI and core modules.
+- [create-flowdular](https://www.npmjs.com/package/create-flowdular): application generator.
+- [Documentation](https://github.com/Flowdular/flowdular/tree/main/docs) · [Source and issues](https://github.com/Flowdular/flowdular) · [Website](https://flowdular.com)
+
+Licensed under MIT. Repository documentation and source require repository access while the repositories are private.
+
+## Interactive setup
+
+Run `pnpm flowdular setup` in a terminal. The wizard offers a local demo, existing
+PostgreSQL connection settings, or a configuration check. Local resets require
+confirmation and a stopped application; custom or hosted databases are refused.
+PostgreSQL URLs are masked and saved to `.env` with TLS verification; this does
+not initialize, reset or connect to the hosted database.
 
-Release tooling can import the module distribution API from
-`flowdular/distribution`. See [Flowdular](https://github.com/Flowdular/flowdular).
+Without an interactive terminal, `setup` remains a configuration check. Use
+`setup check --json` for machine-readable results and
+`setup quick --apply --confirm reset-local-auth` for an explicitly authorized
+local reset in a script. Ctrl+C or declining confirmation leaves data unchanged.

package/dist/distribution.js

@@ -5,7 +5,11 @@ var __getOwnPropNames = Object.getOwnPropertyNames;
 var __getProtoOf = Object.getPrototypeOf;
 var __hasOwnProp = Object.prototype.hasOwnProperty;
 var __commonJS = (cb, mod) => function __require() {
-  return mod || (0, cb[__getOwnPropNames(cb)[0]])((mod = { exports: {} }).exports, mod), mod.exports;
+  try {
+    return mod || (0, cb[__getOwnPropNames(cb)[0]])((mod = { exports: {} }).exports, mod), mod.exports;
+  } catch (e) {
+    throw mod = 0, e;
+  }
 };
 var __copyProps = (to, from, except, desc) => {
   if (from && typeof from === "object" || typeof from === "function") {
@@ -2557,10 +2561,7 @@ var project_schema_default = {
     specs: {
       type: "object",
       additionalProperties: false,
-      required: [
-        "platformRoot",
-        "moduleDirectory"
-      ],
+      required: ["platformRoot", "moduleDirectory"],
       properties: {
         platformRoot: {
           type: "string",
@@ -2575,10 +2576,7 @@ var project_schema_default = {
     modules: {
       type: "object",
       additionalProperties: false,
-      required: [
-        "roots",
-        "enabled"
-      ],
+      required: ["roots", "enabled"],
       properties: {
         roots: {
           type: "array",
@@ -2611,11 +2609,7 @@ var project_schema_default = {
     agent: {
       type: "object",
       additionalProperties: false,
-      required: [
-        "policy",
-        "blueprints",
-        "modelRouting"
-      ],
+      required: ["policy", "blueprints", "modelRouting"],
       properties: {
         policy: {
           type: "string",
@@ -2667,17 +2661,10 @@ var project_schema_default = {
                   $ref: "#/$defs/gitName"
                 },
                 provider: {
-                  enum: [
-                    "github",
-                    "none"
-                  ]
+                  enum: ["github", "none"]
                 },
                 mode: {
-                  enum: [
-                    "auto",
-                    "direct",
-                    "fork"
-                  ]
+                  enum: ["auto", "direct", "fork"]
                 },
                 forkOwner: {
                   $ref: "#/$defs/githubAccount"
@@ -2703,9 +2690,7 @@ var project_schema_default = {
     web: {
       type: "object",
       additionalProperties: false,
-      required: [
-        "mounts"
-      ],
+      required: ["mounts"],
       properties: {
         mounts: {
           type: "array",
@@ -2713,13 +2698,7 @@ var project_schema_default = {
           items: {
             type: "object",
             additionalProperties: false,
-            required: [
-              "id",
-              "moduleId",
-              "surfaceId",
-              "path",
-              "tenantId"
-            ],
+            required: ["id", "moduleId", "surfaceId", "path", "tenantId"],
             properties: {
               id: {
                 type: "string",
@@ -2754,9 +2733,7 @@ var project_schema_default = {
     application: {
       type: "object",
       additionalProperties: false,
-      required: [
-        "path"
-      ],
+      required: ["path"],
       properties: {
         path: {
           type: "string",
@@ -2770,20 +2747,21 @@ var project_schema_default = {
               "/sign-up",
               "/forgot-password",
               "/reset-password",
-              "/accept-invitation"
+              "/accept-invitation",
+              "/setup",
+              "/health",
+              "/ready",
+              "/assets"
             ]
-          }
+          },
+          maxLength: 64
         }
       }
     }
   },
   $defs: {
     deliveryTarget: {
-      enum: [
-        "workspace",
-        "git-pr",
-        "official-modules"
-      ]
+      enum: ["workspace", "git-pr", "official-modules"]
     },
     gitName: {
       type: "string",
@@ -3005,6 +2983,7 @@ var ModuleDistributionError = class extends Error {
     super(message);
     this.code = code;
   }
+  code;
 };
 function distributionAssert(condition, code, message) {
   if (!condition) throw new ModuleDistributionError(code, message);
@@ -3426,7 +3405,7 @@ import { dirname as dirname6, join as join6, relative as relative5 } from "node:
 import { createRequire } from "node:module";
 import { readFile as readFile5 } from "node:fs/promises";
 import { dirname as dirname4, join as join3 } from "node:path";
-var SDK_VERSION = "0.1.0";
+var SDK_VERSION = "0.2.1";
 function npmPackage(specifier) {
   return specifier.startsWith("@") ? specifier.split("/").slice(0, 2).join("/") : specifier.split("/")[0];
 }
@@ -4285,9 +4264,10 @@ function generateServerComposition(modules, sdk = false, mounts = [], applicatio
 	PlatformServerComposition,
 	PlatformServerContext,
 } from '${sdk ? "@flowdular/sdk/modules/auth" : "@flowdular/module-auth"}/server';
+import type { WebMount } from '${sdk ? "@flowdular/sdk/server" : "@flowdular/server"}';
 `;
   if (server.length === 0) {
-    return GENERATED_HEADER + typeImport + "\nexport function composeModuleServer(\n	_context: PlatformServerContext,\n): readonly PlatformServerComposition[] {\n	return [];\n}\n\nexport const moduleWebMounts = " + JSON.stringify(mounts) + " as const;\nexport const applicationBasePath = " + JSON.stringify(applicationPath) + ";\n";
+    return GENERATED_HEADER + typeImport + "\nexport function composeModuleServer(\n	_context: PlatformServerContext,\n): readonly PlatformServerComposition[] {\n	return [];\n}\n\nexport const moduleWebMounts: readonly WebMount[] = " + JSON.stringify(mounts) + " as const;\nexport const applicationBasePath = " + JSON.stringify(applicationPath) + ";\n";
   }
   const imports = server.map(
     (module) => platformImport(module.id, module.package, "createServerComposition")
@@ -4298,7 +4278,7 @@ function generateServerComposition(modules, sdk = false, mounts = [], applicatio
 			agentDefinitions: context.agentDefinitions.forModule('${module.id}'),
 		}), moduleId: '${module.id}' },`
   ).join("\n");
-  return GENERATED_HEADER + typeImport + imports + "\n\nexport function composeModuleServer(\n	context: PlatformServerContext,\n): readonly PlatformServerComposition[] {\n	return [\n" + calls + "\n	];\n}\n\nexport const moduleWebMounts = " + JSON.stringify(mounts) + " as const;\nexport const applicationBasePath = " + JSON.stringify(applicationPath) + ";\n";
+  return GENERATED_HEADER + typeImport + imports + "\n\nexport function composeModuleServer(\n	context: PlatformServerContext,\n): readonly PlatformServerComposition[] {\n	return [\n" + calls + "\n	];\n}\n\nexport const moduleWebMounts: readonly WebMount[] = " + JSON.stringify(mounts) + " as const;\nexport const applicationBasePath = " + JSON.stringify(applicationPath) + ";\n";
 }
 function generateClientComposition(modules, sdk = false, applicationPath = "/app") {
   const client = modules.filter((module) => module.client);
@@ -4425,7 +4405,8 @@ async function restoreSnapshots(snapshots) {
 async function syncPlatformModules(workspace, apply, enabledOverride) {
   if (workspace.config.web !== void 0 && !validators.web(workspace.config.web))
     throw new Error("Invalid web mount configuration in flowdular.json.");
-  if (workspace.config.application !== void 0 && !validators.application(workspace.config.application)) throw new Error("Invalid application path in flowdular.json.");
+  if (workspace.config.application !== void 0 && !validators.application(workspace.config.application))
+    throw new Error("Invalid application path in flowdular.json.");
   const applicationPath = workspace.config.application?.path ?? "/app";
   const enabled = enabledOverride ?? enabledModules(workspace);
   const sdk = (await sdkModules(workspace)).size > 0;
@@ -4438,7 +4419,8 @@ async function syncPlatformModules(workspace, apply, enabledOverride) {
         content: generateServerComposition(
           modules,
           sdk,
-          workspace.config.web?.mounts ?? []
+          workspace.config.web?.mounts ?? [],
+          applicationPath
         )
       },
       {