@webda/create 0.0.0-stage → 4.0.0-beta.5

package/lib/versions.js

@@ -0,0 +1,52 @@
+import { existsSync } from "node:fs";
+import { readdir, readFile } from "node:fs/promises";
+import { join } from "node:path";
+/** Tool versions taken from @webda/core devDependencies so apps build like the monorepo */
+export const EXTERNAL_TOOLS = ["typescript", "vite", "vitest", "sinon", "@types/node"];
+/**
+ * Replace template versions (`workspace:*` for @webda packages, `managed` for tools)
+ * @param pkg - package.json content, mutated
+ * @param resolve - version lookup
+ */
+export function applyVersions(pkg, resolve) {
+    for (const field of ["dependencies", "devDependencies"]) {
+        const deps = pkg[field] ?? {};
+        for (const [name, range] of Object.entries(deps)) {
+            if (range !== "workspace:*" && range !== "managed")
+                continue;
+            const version = resolve(name);
+            if (version === undefined) {
+                throw new Error(`No version available for ${name}`);
+            }
+            deps[name] = version;
+        }
+    }
+}
+/**
+ * Resolve versions from the `versions.json` written at build time
+ * @param versions - package name → version
+ * @returns the resolver
+ */
+export function fromVersionsFile(versions) {
+    return name => versions[name];
+}
+/**
+ * Resolve @webda packages to `link:` paths in a monorepo checkout, tools from @webda/core devDependencies
+ * @param root - monorepo root
+ * @returns the resolver
+ */
+export async function fromWorkspace(root) {
+    const links = {};
+    let tools = {};
+    for (const dir of await readdir(join(root, "packages"))) {
+        const file = join(root, "packages", dir, "package.json");
+        if (!existsSync(file))
+            continue;
+        const pkg = JSON.parse(await readFile(file, "utf8"));
+        links[pkg.name] = `link:${join(root, "packages", dir)}`;
+        if (pkg.name === "@webda/core")
+            tools = pkg.devDependencies ?? {};
+    }
+    return name => links[name] ?? (EXTERNAL_TOOLS.includes(name) ? tools[name] : undefined);
+}
+//# sourceMappingURL=versions.js.map

package/lib/versions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"versions.js","sourceRoot":"","sources":["../src/versions.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AACrC,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AACrD,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAIjC,2FAA2F;AAC3F,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,YAAY,EAAE,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,aAAa,CAAC,CAAC;AAEvF;;;;GAIG;AACH,MAAM,UAAU,aAAa,CAAC,GAAwB,EAAE,OAAwB;IAC9E,KAAK,MAAM,KAAK,IAAI,CAAC,cAAc,EAAE,iBAAiB,CAAC,EAAE,CAAC;QACxD,MAAM,IAAI,GAA2B,GAAG,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC;QACtD,KAAK,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;YACjD,IAAI,KAAK,KAAK,aAAa,IAAI,KAAK,KAAK,SAAS;gBAAE,SAAS;YAC7D,MAAM,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;YAC9B,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;gBAC1B,MAAM,IAAI,KAAK,CAAC,4BAA4B,IAAI,EAAE,CAAC,CAAC;YACtD,CAAC;YACD,IAAI,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC;QACvB,CAAC;IACH,CAAC;AACH,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,gBAAgB,CAAC,QAAgC;IAC/D,OAAO,IAAI,CAAC,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;AAChC,CAAC;AAED;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,aAAa,CAAC,IAAY;IAC9C,MAAM,KAAK,GAA2B,EAAE,CAAC;IACzC,IAAI,KAAK,GAA2B,EAAE,CAAC;IACvC,KAAK,MAAM,GAAG,IAAI,MAAM,OAAO,CAAC,IAAI,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC,EAAE,CAAC;QACxD,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,EAAE,UAAU,EAAE,GAAG,EAAE,cAAc,CAAC,CAAC;QACzD,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC;YAAE,SAAS;QAChC,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC;QACrD,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,QAAQ,IAAI,CAAC,IAAI,EAAE,UAAU,EAAE,GAAG,CAAC,EAAE,CAAC;QACxD,IAAI,GAAG,CAAC,IAAI,KAAK,aAAa;YAAE,KAAK,GAAG,GAAG,CAAC,eAAe,IAAI,EAAE,CAAC;IACpE,CAAC;IACD,OAAO,IAAI,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;AAC1F,CAAC"}

package/lib/versions.json

@@ -0,0 +1,42 @@
+{
+  "@webda/amqp": "4.0.0-beta.5",
+  "@webda/async": "4.0.0-beta.5",
+  "@webda/auth": "4.0.0-beta.5",
+  "@webda/aws": "4.0.0-beta.5",
+  "@webda/cache": "4.0.0-beta.5",
+  "@webda/cloudevents": "4.0.0-beta.5",
+  "@webda/compiler": "4.0.0-beta.5",
+  "@webda/content-mapper": "4.0.0-beta.5",
+  "@webda/core": "4.0.0-beta.5",
+  "typescript": "7.1.0-dev.20260929.1",
+  "vite": "^6.0.0",
+  "vitest": "^4.1.2",
+  "sinon": "^21.0.3",
+  "@types/node": "25.5.0",
+  "@webda/create": "4.0.0-beta.5",
+  "@webda/debug": "4.0.0-beta.5",
+  "@webda/decorators": "4.0.0-beta.5",
+  "@webda/elasticsearch": "4.0.0-beta.5",
+  "@webda/fs": "4.0.0-beta.5",
+  "@webda/gcp": "4.0.0-beta.5",
+  "@webda/google-auth": "4.0.0-beta.5",
+  "@webda/graphql": "4.0.0-beta.5",
+  "@webda/grpc": "4.0.0-beta.5",
+  "@webda/hawk": "4.0.0-beta.5",
+  "@webda/kubernetes": "4.0.0-beta.5",
+  "@webda/mcp": "4.0.0-beta.5",
+  "@webda/mock": "4.0.0-beta.5",
+  "@webda/models": "4.0.0-beta.5",
+  "@webda/mongo": "4.0.0-beta.5",
+  "@webda/oci": "4.0.0-beta.5",
+  "@webda/otel": "4.0.0-beta.5",
+  "@webda/postgres": "4.0.0-beta.5",
+  "@webda/ql": "4.0.0-beta.5",
+  "@webda/runtime": "4.0.0-beta.5",
+  "@webda/serialize": "4.0.0-beta.5",
+  "@webda/test": "4.0.0-beta.5",
+  "@webda/tsc-esm": "4.0.0-beta.5",
+  "@webda/utils": "4.0.0-beta.5",
+  "@webda/versioning": "4.0.0-beta.5",
+  "@webda/workout": "4.0.0-beta.5"
+}

package/package.json

@@ -1,6 +1,47 @@
 {
   "name": "@webda/create",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "version": "4.0.0-beta.5",
+  "description": "Create a Webda application with guidance for coding agents",
+  "type": "module",
+  "bin": {
+    "create": "./lib/bin.js"
+  },
+  "main": "lib/index.js",
+  "files": [
+    "lib",
+    "templates",
+    "agent"
+  ],
+  "devDependencies": {
+    "@types/node": "25.5.0",
+    "typescript": "7.1.0-dev.20260929.1",
+    "vite": "^6.0.0",
+    "vitest": "^4.1.2",
+    "@webda/test": "4.0.0-beta.5"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "engines": {
+    "node": ">=22.0.0"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/loopingz/webda.io.git",
+    "directory": "packages/create"
+  },
+  "license": "LGPL-3.0-only",
+  "dependencies": {
+    "@clack/prompts": "^1.8.1"
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.json && node scripts/write-versions.mjs",
+    "format": "prettier --check src/**/*",
+    "format:fix": "prettier --write src/**/*",
+    "lint": "eslint",
+    "lint:fix": "eslint --fix",
+    "pretest": "tsc -p tsconfig.json",
+    "test": "vitest run",
+    "test:templates": "node scripts/test-templates.mjs"
+  }
 }

package/templates/base/files/README.md

@@ -0,0 +1,16 @@
+# __APP_NAME__
+
+A [Webda](https://webda.io) v4 application.
+
+```bash
+npm run debug   # build, then dev server with the interactive debug console on http://localhost:18080
+npm run serve   # build, then HTTP server on http://localhost:18080
+npm run build   # compile and generate webda.module.json
+npm test        # build, then run the tests
+```
+
+- Models: `src/models/`
+- Services: `src/services/`
+- Configuration: `webda.config.json`
+
+Working with a coding agent? It reads `AGENTS.md`; skills are in `.agents/skills/`.

package/templates/base/files/_gitignore

@@ -0,0 +1,6 @@
+node_modules
+lib
+.webda
+.registry
+data/
+.env

package/templates/base/files/src/models/Project.model.ts

@@ -0,0 +1,19 @@
+import { OneToMany, UuidModel } from "@webda/models";
+import type { Task } from "./Task.model.js";
+
+/**
+ * A project groups tasks
+ */
+export class Project extends UuidModel {
+  /**
+   * Project name
+   * @minLength 1
+   * @maxLength 100
+   */
+  name!: string;
+
+  /**
+   * Tasks of the project
+   */
+  tasks!: OneToMany<Task, Project, "project">;
+}

package/templates/base/files/src/models/Task.model.ts

@@ -0,0 +1,24 @@
+import { BelongTo, UuidModel } from "@webda/models";
+import type { Project } from "./Project.model.js";
+
+/**
+ * A task to do in a project
+ */
+export class Task extends UuidModel {
+  /**
+   * What needs to be done
+   * @minLength 1
+   * @maxLength 200
+   */
+  title!: string;
+
+  /**
+   * Whether the task is finished
+   */
+  done!: boolean;
+
+  /**
+   * Project the task belongs to
+   */
+  project!: BelongTo<Project>;
+}

package/templates/base/files/src/services/task.service.ts

@@ -0,0 +1,29 @@
+import { Operation, Service, useLog } from "@webda/core";
+import { Task } from "../models/Task.model.js";
+
+/**
+ * Parameters of TaskService, set in webda.config.json
+ */
+export class TaskServiceParameters extends Service.Parameters {}
+
+/**
+ * Behaviour spanning several tasks
+ *
+ * @WebdaModda
+ */
+export class TaskService<T extends TaskServiceParameters = TaskServiceParameters> extends Service<T> {
+  static Parameters = TaskServiceParameters;
+
+  /**
+   * Count the open and finished tasks of a project
+   * @param project - project uuid
+   * @returns task counts
+   */
+  @Operation()
+  async summary(project: string): Promise<{ open: number; done: number }> {
+    const { results } = await Task.query("project = ?", [project]);
+    const done = results.filter(task => task.done).length;
+    useLog("INFO", "Summary of project", project);
+    return { open: results.length - done, done };
+  }
+}

package/templates/base/files/test/app.spec.ts

@@ -0,0 +1,57 @@
+import { suite, test } from "@webda/test";
+import * as assert from "node:assert";
+import { readFileSync } from "node:fs";
+import { resolve } from "node:path";
+import { TestApplication, WebdaApplicationTest } from "@webda/core/lib/test/index.js";
+import { useModel, useService } from "@webda/core";
+
+const appDir = resolve(import.meta.dirname, "..");
+
+/**
+ * Loads this application from its directory
+ */
+class AppTestApplication extends TestApplication {
+  getNamespace() {
+    return "__NAMESPACE__";
+  }
+
+  filterModule(_filename: string): boolean {
+    return true;
+  }
+}
+
+@suite
+class AppTest extends WebdaApplicationTest {
+  getTestConfiguration(): string {
+    return appDir;
+  }
+
+  getApplication() {
+    return new AppTestApplication(this.getTestConfiguration());
+  }
+
+  /**
+   * Keep webda.config.json as is: the default would replace the store with a MemoryStore
+   */
+  async tweakApp() {}
+
+  @test
+  async configuredServicesStart() {
+    const config = JSON.parse(readFileSync(resolve(appDir, "webda.config.json"), "utf8"));
+    const started = Object.keys(this.webda.getServices());
+    for (const name of Object.keys(config.services)) {
+      assert.ok(started.includes(name), `${name} should start`);
+    }
+  }
+
+  @test
+  async summarizesTheTasksOfAProject() {
+    const Project = useModel<any>("__NAMESPACE__/Project");
+    const Task = useModel<any>("__NAMESPACE__/Task");
+    const project = await Project.create({ name: "Launch" });
+    await Task.create({ title: "Write the docs", done: true, project: project.getUUID() });
+    await Task.create({ title: "Ship it", done: false, project: project.getUUID() });
+    const summary = await (useService("TaskService" as any) as any).summary(project.getUUID());
+    assert.deepStrictEqual(summary, { open: 1, done: 1 });
+  }
+}

package/templates/base/files/tsconfig.json

@@ -0,0 +1,18 @@
+{
+  "compilerOptions": {
+    "target": "es2022",
+    "module": "nodenext",
+    "moduleResolution": "nodenext",
+    "outDir": "./lib",
+    "rootDir": "./src",
+    "strict": false,
+    "sourceMap": true,
+    "declaration": true,
+    "experimentalDecorators": false,
+    "skipLibCheck": true,
+    "esModuleInterop": true,
+    "declarationMap": true
+  },
+  "include": ["src/**/*", ".webda/module.d.ts"],
+  "exclude": ["**/node_modules", "**/*.spec.ts"]
+}

package/templates/base/files/vitest.config.ts

@@ -0,0 +1,10 @@
+import { defineConfig, loadEnv } from "vite";
+
+export default defineConfig({
+  test: {
+    env: loadEnv("test", process.cwd(), ""),
+    testTimeout: 30000,
+    hookTimeout: 30000,
+    include: ["test/**/*.spec.ts"]
+  }
+});

package/templates/base/package.json

@@ -0,0 +1,35 @@
+{
+  "name": "__APP_NAME__",
+  "version": "0.1.0",
+  "private": true,
+  "type": "module",
+  "scripts": {
+    "build": "webdac build",
+    "predebug": "webdac build",
+    "debug": "webda debug",
+    "preserve": "webdac build",
+    "serve": "webda serve",
+    "pretest": "webdac build",
+    "test": "vitest run"
+  },
+  "dependencies": {
+    "@webda/core": "workspace:*",
+    "@webda/models": "workspace:*"
+  },
+  "devDependencies": {
+    "@types/node": "managed",
+    "@webda/compiler": "workspace:*",
+    "@webda/debug": "workspace:*",
+    "@webda/test": "workspace:*",
+    "sinon": "managed",
+    "typescript": "managed",
+    "vite": "managed",
+    "vitest": "managed"
+  },
+  "webda": {
+    "namespace": "__NAMESPACE__"
+  },
+  "engines": {
+    "node": ">=22.0.0"
+  }
+}

package/templates/base/webda.config.json

@@ -0,0 +1,19 @@
+{
+  "$schema": ".webda/config.schema.json",
+  "version": 4,
+  "parameters": {},
+  "services": {
+    "HttpServer": {
+      "type": "Webda/HttpServer"
+    },
+    "DomainService": {
+      "type": "Webda/DomainService"
+    },
+    "RESTService": {
+      "type": "Webda/RESTOperationsTransport"
+    },
+    "TaskService": {
+      "type": "TaskService"
+    }
+  }
+}

package/templates/features/graphql/agents.md

@@ -0,0 +1 @@
+GraphQL is generated from the models and operations and served by `GraphQLService` at `/graphql`.

package/templates/features/graphql/package.json

@@ -0,0 +1,5 @@
+{
+  "dependencies": {
+    "@webda/graphql": "workspace:*"
+  }
+}

package/templates/features/graphql/webda.config.json

@@ -0,0 +1 @@
+{ "services": { "GraphQLService": { "type": "Webda/GraphQLService" } } }

package/templates/features/grpc/agents.md

@@ -0,0 +1 @@
+gRPC is served on port 50051 (HTTP/2 cleartext) by `GRPCService`; its services are generated from the models and operations.

package/templates/features/grpc/package.json

@@ -0,0 +1,5 @@
+{
+  "dependencies": {
+    "@webda/grpc": "workspace:*"
+  }
+}

package/templates/features/grpc/webda.config.json

@@ -0,0 +1,6 @@
+{
+  "services": {
+    "GRPCService": { "type": "Webda/GrpcService" },
+    "HttpServerH2c": { "type": "Webda/HttpServer", "port": 50051, "h2c": true }
+  }
+}

package/templates/features/mcp/agents.md

@@ -0,0 +1 @@
+`MCP` is served at `/mcp` and exposes the operations as Model Context Protocol tools and the models as resources, with the same permissions as the other transports.

package/templates/features/mcp/package.json

@@ -0,0 +1,5 @@
+{
+  "dependencies": {
+    "@webda/mcp": "workspace:*"
+  }
+}

package/templates/features/mcp/webda.config.json

@@ -0,0 +1 @@
+{ "services": { "MCP": { "type": "Webda/McpService" } } }

package/templates/features/store-file/agents.md

@@ -0,0 +1 @@
+Each record is a JSON file in `./data` (ignored by git). Delete the folder to reset the data.

package/templates/features/store-file/package.json

@@ -0,0 +1,5 @@
+{
+  "dependencies": {
+    "@webda/fs": "workspace:*"
+  }
+}

package/templates/features/store-file/webda.config.json

@@ -0,0 +1 @@
+{ "services": { "Registry": { "type": "Webda/FileStore", "folder": "./data" } } }

package/templates/features/store-mongodb/agents.md

@@ -0,0 +1 @@
+MongoDB runs locally: `docker compose up -d`, then `cp .env.example .env`. The connection comes from `WEBDA_MONGO_URL` (see `.env.example`); tests load `.env` automatically; for `npm run debug` or `npm run serve`, export the variables first (`set -a; . ./.env; set +a`); never put credentials in `webda.config.json`.

package/templates/features/store-mongodb/files/.env.example

@@ -0,0 +1 @@
+WEBDA_MONGO_URL=mongodb://webda:webda@localhost:27017

package/templates/features/store-mongodb/files/docker-compose.yml

@@ -0,0 +1,8 @@
+services:
+  mongodb:
+    image: mongo:8
+    ports:
+      - "27017:27017"
+    environment:
+      MONGO_INITDB_ROOT_USERNAME: webda
+      MONGO_INITDB_ROOT_PASSWORD: webda

package/templates/features/store-mongodb/package.json

@@ -0,0 +1,5 @@
+{
+  "dependencies": {
+    "@webda/mongo": "workspace:*"
+  }
+}

package/templates/features/store-mongodb/webda.config.json

@@ -0,0 +1 @@
+{ "services": { "Registry": { "type": "Webda/MongoStore", "collection": "registry" } } }

package/templates/features/store-postgres/agents.md

@@ -0,0 +1 @@
+PostgreSQL runs locally: `docker compose up -d`, then `cp .env.example .env`. The connection comes from the standard `PG*` variables (see `.env.example`); tests load `.env` automatically; for `npm run debug` or `npm run serve`, export the variables first (`set -a; . ./.env; set +a`); never put credentials in `webda.config.json`. Tables are created automatically.

package/templates/features/store-postgres/files/.env.example

@@ -0,0 +1,5 @@
+PGHOST=localhost
+PGPORT=5432
+PGUSER=webda
+PGPASSWORD=webda
+PGDATABASE=webda

package/templates/features/store-postgres/files/docker-compose.yml

@@ -0,0 +1,9 @@
+services:
+  postgres:
+    image: postgres:17
+    ports:
+      - "5432:5432"
+    environment:
+      POSTGRES_USER: webda
+      POSTGRES_PASSWORD: webda
+      POSTGRES_DB: webda

package/templates/features/store-postgres/package.json

@@ -0,0 +1,5 @@
+{
+  "dependencies": {
+    "@webda/postgres": "workspace:*"
+  }
+}

package/templates/features/store-postgres/webda.config.json

@@ -0,0 +1 @@
+{ "services": { "Registry": { "type": "Webda/PostgresStore", "table": "registry" } } }