@specverse/engines 4.2.0 → 4.2.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/assets/templates/default/specs/main.specly +65 -0
- package/dist/libs/instance-factories/CURVED-INTERFACE.md +278 -0
- package/dist/libs/instance-factories/README.md +73 -0
- package/dist/libs/instance-factories/applications/README.md +51 -0
- package/dist/libs/instance-factories/applications/generic-app.yaml +52 -0
- package/dist/libs/instance-factories/applications/react-app-runtime.yaml +139 -0
- package/dist/libs/instance-factories/applications/react-app-starter.yaml +143 -0
- package/dist/libs/instance-factories/applications/templates/react/env-example-generator.js +24 -2
- package/dist/libs/instance-factories/applications/templates/react/vite-config-generator.js +54 -33
- package/dist/libs/instance-factories/applications/templates/react-starter/README.md +211 -0
- package/dist/libs/instance-factories/applications/templates/react-starter/api-types-starter-generator.js +69 -0
- package/dist/libs/instance-factories/applications/templates/react-starter/app-tsx-generator.js +1 -1
- package/dist/libs/instance-factories/applications/templates/react-starter/belongs-to.js +40 -0
- package/dist/libs/instance-factories/applications/templates/react-starter/dashboard-body-composer.js +11 -3
- package/dist/libs/instance-factories/applications/templates/react-starter/detail-body-composer.js +18 -16
- package/dist/libs/instance-factories/applications/templates/react-starter/form-body-composer.js +50 -23
- package/dist/libs/instance-factories/applications/templates/react-starter/helpers-emitter.js +9 -3
- package/dist/libs/instance-factories/applications/templates/react-starter/list-body-composer.js +17 -7
- package/dist/libs/instance-factories/applications/templates/react-starter/orchestrator.js +16 -5
- package/dist/libs/instance-factories/applications/templates/react-starter/skeletons/dashboard.tsx.template +49 -0
- package/dist/libs/instance-factories/applications/templates/react-starter/skeletons/detail.tsx.template +96 -0
- package/dist/libs/instance-factories/applications/templates/react-starter/skeletons/form.tsx.template +116 -0
- package/dist/libs/instance-factories/applications/templates/react-starter/skeletons/list.tsx.template +74 -0
- package/dist/libs/instance-factories/applications/templates/react-starter/use-api-hooks-starter-generator.js +95 -0
- package/dist/libs/instance-factories/applications/templates/react-starter/view-emitter.js +26 -1
- package/dist/libs/instance-factories/archived/fastify-prisma.yaml +104 -0
- package/dist/libs/instance-factories/cli/README.md +43 -0
- package/dist/libs/instance-factories/cli/commander-js.yaml +55 -0
- package/dist/libs/instance-factories/cli/templates/commander/command-generator.js +49 -1
- package/dist/libs/instance-factories/communication/README.md +47 -0
- package/dist/libs/instance-factories/communication/event-emitter.yaml +60 -0
- package/dist/libs/instance-factories/communication/rabbitmq-events.yaml +87 -0
- package/dist/libs/instance-factories/controllers/README.md +42 -0
- package/dist/libs/instance-factories/controllers/fastify.yaml +139 -0
- package/dist/libs/instance-factories/controllers/templates/fastify/server-generator.js +29 -2
- package/dist/libs/instance-factories/infrastructure/README.md +29 -0
- package/dist/libs/instance-factories/infrastructure/docker-k8s.yaml +61 -0
- package/dist/libs/instance-factories/orms/README.md +54 -0
- package/dist/libs/instance-factories/orms/prisma.yaml +89 -0
- package/dist/libs/instance-factories/orms/templates/prisma/schema-generator.js +2 -2
- package/dist/libs/instance-factories/scaffolding/README.md +49 -0
- package/dist/libs/instance-factories/scaffolding/generic-scaffold.yaml +65 -0
- package/dist/libs/instance-factories/sdks/README.md +28 -0
- package/dist/libs/instance-factories/sdks/python-sdk.yaml +66 -0
- package/dist/libs/instance-factories/sdks/typescript-sdk.yaml +59 -0
- package/dist/libs/instance-factories/services/README.md +55 -0
- package/dist/libs/instance-factories/services/prisma-services.yaml +71 -0
- package/dist/libs/instance-factories/storage/README.md +34 -0
- package/dist/libs/instance-factories/storage/mongodb.yaml +79 -0
- package/dist/libs/instance-factories/storage/postgresql.yaml +75 -0
- package/dist/libs/instance-factories/storage/redis.yaml +79 -0
- package/dist/libs/instance-factories/testing/README.md +40 -0
- package/dist/libs/instance-factories/testing/vitest-tests.yaml +63 -0
- package/dist/libs/instance-factories/tools/README.md +70 -0
- package/dist/libs/instance-factories/tools/mcp.yaml +36 -0
- package/dist/libs/instance-factories/tools/vscode.yaml +35 -0
- package/dist/libs/instance-factories/validation/README.md +38 -0
- package/dist/libs/instance-factories/validation/zod.yaml +56 -0
- package/dist/realize/engines/code-generator.d.ts.map +1 -1
- package/dist/realize/engines/code-generator.js +3 -0
- package/dist/realize/engines/code-generator.js.map +1 -1
- package/libs/instance-factories/applications/react-app-starter.yaml +10 -17
- package/libs/instance-factories/applications/templates/react/env-example-generator.ts +24 -2
- package/libs/instance-factories/applications/templates/react/vite-config-generator.ts +54 -33
- package/libs/instance-factories/applications/templates/react-starter/__tests__/detail-body-composer.test.ts +5 -4
- package/libs/instance-factories/applications/templates/react-starter/__tests__/form-body-composer.test.ts +18 -5
- package/libs/instance-factories/applications/templates/react-starter/__tests__/orchestrator.test.ts +83 -62
- package/libs/instance-factories/applications/templates/react-starter/api-types-starter-generator.ts +98 -0
- package/libs/instance-factories/applications/templates/react-starter/app-tsx-generator.ts +1 -1
- package/libs/instance-factories/applications/templates/react-starter/belongs-to.ts +82 -0
- package/libs/instance-factories/applications/templates/react-starter/dashboard-body-composer.ts +20 -5
- package/libs/instance-factories/applications/templates/react-starter/detail-body-composer.ts +33 -33
- package/libs/instance-factories/applications/templates/react-starter/form-body-composer.ts +107 -30
- package/libs/instance-factories/applications/templates/react-starter/helpers-emitter.ts +9 -3
- package/libs/instance-factories/applications/templates/react-starter/list-body-composer.ts +34 -8
- package/libs/instance-factories/applications/templates/react-starter/orchestrator.ts +41 -26
- package/libs/instance-factories/applications/templates/react-starter/skeletons/dashboard.tsx.template +2 -0
- package/libs/instance-factories/applications/templates/react-starter/skeletons/detail.tsx.template +2 -0
- package/libs/instance-factories/applications/templates/react-starter/skeletons/form.tsx.template +2 -0
- package/libs/instance-factories/applications/templates/react-starter/skeletons/list.tsx.template +2 -0
- package/libs/instance-factories/applications/templates/react-starter/use-api-hooks-starter-generator.ts +124 -0
- package/libs/instance-factories/applications/templates/react-starter/view-emitter.ts +58 -0
- package/libs/instance-factories/cli/templates/commander/command-generator.ts +49 -1
- package/libs/instance-factories/controllers/fastify.yaml +7 -0
- package/libs/instance-factories/controllers/templates/fastify/server-generator.ts +36 -2
- package/libs/instance-factories/orms/templates/prisma/schema-generator.ts +11 -4
- package/package.json +1 -1
|
@@ -0,0 +1,143 @@
|
|
|
1
|
+
name: ReactAppStarter
|
|
2
|
+
version: "1.0.0"
|
|
3
|
+
category: view
|
|
4
|
+
description: "Fully standalone React starter kit — pre-rendered view components the user can fork and extend. No @specverse/runtime dependency."
|
|
5
|
+
|
|
6
|
+
metadata:
|
|
7
|
+
author: "SpecVerse Team"
|
|
8
|
+
license: "MIT"
|
|
9
|
+
tags: [react, vite, spa, frontend, starter, editable]
|
|
10
|
+
mode: starter
|
|
11
|
+
|
|
12
|
+
compatibility:
|
|
13
|
+
specverse: ">=4.0.0"
|
|
14
|
+
node: ">=18.0.0"
|
|
15
|
+
|
|
16
|
+
capabilities:
|
|
17
|
+
provides:
|
|
18
|
+
- "app.frontend"
|
|
19
|
+
- "ui.scaffolding"
|
|
20
|
+
- "ui.router"
|
|
21
|
+
- "ui.staticviews"
|
|
22
|
+
- "ui.staticforms"
|
|
23
|
+
- "ui.staticcomponents"
|
|
24
|
+
requires: []
|
|
25
|
+
|
|
26
|
+
technology:
|
|
27
|
+
runtime: "browser"
|
|
28
|
+
language: "typescript"
|
|
29
|
+
framework: "react"
|
|
30
|
+
bundler: "vite"
|
|
31
|
+
version: "^18.2.0"
|
|
32
|
+
|
|
33
|
+
dependencies:
|
|
34
|
+
# Runtime deps baked into the generated package.json.
|
|
35
|
+
# Deliberately no @specverse/runtime — the starter kit is
|
|
36
|
+
# standalone by design.
|
|
37
|
+
runtime:
|
|
38
|
+
- name: "react"
|
|
39
|
+
version: "^18.2.0"
|
|
40
|
+
- name: "react-dom"
|
|
41
|
+
version: "^18.2.0"
|
|
42
|
+
- name: "@tanstack/react-query"
|
|
43
|
+
version: "^5.0.0"
|
|
44
|
+
|
|
45
|
+
dev:
|
|
46
|
+
- name: "@types/react"
|
|
47
|
+
version: "^18.2.0"
|
|
48
|
+
- name: "@types/react-dom"
|
|
49
|
+
version: "^18.2.0"
|
|
50
|
+
- name: "typescript"
|
|
51
|
+
version: "^5.2.0"
|
|
52
|
+
- name: "vite"
|
|
53
|
+
version: "^6.0.0"
|
|
54
|
+
- name: "@vitejs/plugin-react"
|
|
55
|
+
version: "^4.2.0"
|
|
56
|
+
- name: "tailwindcss"
|
|
57
|
+
version: "^3.4.13"
|
|
58
|
+
- name: "postcss"
|
|
59
|
+
version: "^8.4.47"
|
|
60
|
+
- name: "autoprefixer"
|
|
61
|
+
version: "^10.4.20"
|
|
62
|
+
|
|
63
|
+
codeTemplates:
|
|
64
|
+
# === Infrastructure reused from ReactAppRuntime ===
|
|
65
|
+
# Safe to share because these files don't embed any runtime-specific
|
|
66
|
+
# logic — just build config + entry points.
|
|
67
|
+
index-html:
|
|
68
|
+
engine: typescript
|
|
69
|
+
generator: "libs/instance-factories/applications/templates/react/index-html-generator.ts"
|
|
70
|
+
outputPattern: "{frontendDir}/index.html"
|
|
71
|
+
|
|
72
|
+
main-tsx:
|
|
73
|
+
engine: typescript
|
|
74
|
+
generator: "libs/instance-factories/applications/templates/react/main-tsx-generator.ts"
|
|
75
|
+
outputPattern: "{frontendDir}/src/main.tsx"
|
|
76
|
+
|
|
77
|
+
vite-config:
|
|
78
|
+
engine: typescript
|
|
79
|
+
generator: "libs/instance-factories/applications/templates/react/vite-config-generator.ts"
|
|
80
|
+
outputPattern: "{frontendDir}/vite.config.ts"
|
|
81
|
+
|
|
82
|
+
tsconfig:
|
|
83
|
+
engine: typescript
|
|
84
|
+
generator: "libs/instance-factories/applications/templates/react/tsconfig-generator.ts"
|
|
85
|
+
outputPattern: "{frontendDir}/tsconfig.json"
|
|
86
|
+
|
|
87
|
+
index-css:
|
|
88
|
+
engine: typescript
|
|
89
|
+
generator: "libs/instance-factories/applications/templates/react/index-css-generator.ts"
|
|
90
|
+
outputPattern: "{frontendDir}/src/index.css"
|
|
91
|
+
|
|
92
|
+
gitignore:
|
|
93
|
+
engine: typescript
|
|
94
|
+
generator: "libs/instance-factories/applications/templates/react/gitignore-generator.ts"
|
|
95
|
+
outputPattern: "{frontendDir}/.gitignore"
|
|
96
|
+
|
|
97
|
+
env-example:
|
|
98
|
+
engine: typescript
|
|
99
|
+
generator: "libs/instance-factories/applications/templates/react/env-example-generator.ts"
|
|
100
|
+
outputPattern: "{frontendDir}/.env.example"
|
|
101
|
+
|
|
102
|
+
# API wiring — starter-specific. The starter's hooks inline their
|
|
103
|
+
# own fetch transport so there is NO apiClient.ts (the runtime
|
|
104
|
+
# apiClient imports runtime-only types that this factory doesn't
|
|
105
|
+
# emit). Users wanting a shared transport layer can add one by
|
|
106
|
+
# hand; the hooks file is intentionally small enough to edit.
|
|
107
|
+
use-api-hooks:
|
|
108
|
+
engine: typescript
|
|
109
|
+
generator: "libs/instance-factories/applications/templates/react-starter/use-api-hooks-starter-generator.ts"
|
|
110
|
+
outputPattern: "{frontendDir}/src/hooks/useApi.ts"
|
|
111
|
+
|
|
112
|
+
api-types:
|
|
113
|
+
engine: typescript
|
|
114
|
+
generator: "libs/instance-factories/applications/templates/react-starter/api-types-starter-generator.ts"
|
|
115
|
+
outputPattern: "{frontendDir}/src/types/api.ts"
|
|
116
|
+
|
|
117
|
+
# === Starter-specific: emitted view components + helpers + App + package.json ===
|
|
118
|
+
# The orchestrator returns a map of {relativePath: content} covering:
|
|
119
|
+
# src/views/*.tsx one per (model, view-type) pair
|
|
120
|
+
# src/lib/entity-display.ts FK→name helper (standalone source)
|
|
121
|
+
# src/App.tsx simple internal-routing shell
|
|
122
|
+
# package.json no @specverse/runtime dep
|
|
123
|
+
# .specverse-gen/hashes.json content hashes for regeneration safety
|
|
124
|
+
#
|
|
125
|
+
# Regeneration safety is internal to the orchestrator: user-edited
|
|
126
|
+
# files are omitted from the returned map (so realize never sees
|
|
127
|
+
# them), and the hash manifest's per-file entries are preserved for
|
|
128
|
+
# those skipped files so a later un-edit restores regenerability.
|
|
129
|
+
starter-output:
|
|
130
|
+
engine: typescript
|
|
131
|
+
generator: "libs/instance-factories/applications/templates/react-starter/orchestrator.ts"
|
|
132
|
+
outputPattern: "{frontendDir}/"
|
|
133
|
+
|
|
134
|
+
configuration:
|
|
135
|
+
projectStructure: "monorepo"
|
|
136
|
+
frontendDir: "frontend"
|
|
137
|
+
backendDir: "backend"
|
|
138
|
+
|
|
139
|
+
vite:
|
|
140
|
+
port: 5173
|
|
141
|
+
host: "localhost"
|
|
142
|
+
proxy:
|
|
143
|
+
"/api": "http://localhost:3000"
|
|
@@ -2,8 +2,30 @@ import { getApiBaseUrl, getPathConfig } from "../../../shared/path-resolver.js";
|
|
|
2
2
|
function generateEnvExample(context) {
|
|
3
3
|
const pathConfig = getPathConfig(context);
|
|
4
4
|
const defaultApiUrl = getApiBaseUrl(pathConfig);
|
|
5
|
-
return `#
|
|
6
|
-
#
|
|
5
|
+
return `# \u2500\u2500\u2500 Ports \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500
|
|
6
|
+
# Running more than one SpecVerse project at once? Each project reads
|
|
7
|
+
# its own .env \u2014 copy this file to .env and bump the numbers so the
|
|
8
|
+
# projects don't collide.
|
|
9
|
+
#
|
|
10
|
+
# Suggested ranges (shared across the ecosystem):
|
|
11
|
+
# 3000-3049 : generated project backends (one per project)
|
|
12
|
+
# 3050-3099 : app-demo per-spec runtime backends
|
|
13
|
+
# 5173-5199 : vite frontends (one per project)
|
|
14
|
+
# 9000+ : app-demo Server Manager
|
|
15
|
+
|
|
16
|
+
# Backend (Fastify) port \u2014 read by \`npm run dev:backend\`.
|
|
17
|
+
PORT=3000
|
|
18
|
+
|
|
19
|
+
# Frontend (vite) port \u2014 read by \`npm run dev:frontend\`.
|
|
20
|
+
VITE_PORT=5173
|
|
21
|
+
|
|
22
|
+
# Frontend host \u2014 '0.0.0.0' if you want LAN access.
|
|
23
|
+
VITE_HOST=localhost
|
|
24
|
+
|
|
25
|
+
# \u2500\u2500\u2500 API wiring \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500
|
|
26
|
+
# Base URL for backend API. Used by the generated apiClient AND by
|
|
27
|
+
# vite's dev-server proxy (so /api and /ws requests from the browser
|
|
28
|
+
# are forwarded to your backend). Keep this in sync with PORT.
|
|
7
29
|
VITE_API_BASE_URL=${defaultApiUrl}
|
|
8
30
|
|
|
9
31
|
# API Path Prefix
|
|
@@ -6,45 +6,66 @@ function generateViteConfig(context) {
|
|
|
6
6
|
const viteHost = configuration?.vite?.host || "localhost";
|
|
7
7
|
const apiBaseUrl = getApiBaseUrl(pathConfig);
|
|
8
8
|
const apiProxy = configuration?.vite?.proxy?.["/api"] || apiBaseUrl;
|
|
9
|
-
return `import { defineConfig } from 'vite';
|
|
9
|
+
return `import { defineConfig, loadEnv } from 'vite';
|
|
10
10
|
import react from '@vitejs/plugin-react';
|
|
11
11
|
import path from 'path';
|
|
12
12
|
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
13
|
+
/**
|
|
14
|
+
* Ports and proxy targets are env-overridable via this project's
|
|
15
|
+
* .env (and .env.local). Lets you run several SpecVerse projects
|
|
16
|
+
* side-by-side without port collisions:
|
|
17
|
+
*
|
|
18
|
+
* # project-a/.env
|
|
19
|
+
* PORT=3001
|
|
20
|
+
* VITE_PORT=5174
|
|
21
|
+
* VITE_API_BASE_URL=http://localhost:3001
|
|
22
|
+
*
|
|
23
|
+
* # project-b/.env
|
|
24
|
+
* PORT=3002
|
|
25
|
+
* VITE_PORT=5175
|
|
26
|
+
* VITE_API_BASE_URL=http://localhost:3002
|
|
27
|
+
*/
|
|
28
|
+
export default defineConfig(({ mode }) => {
|
|
29
|
+
const env = loadEnv(mode, process.cwd(), '');
|
|
30
|
+
const port = Number(env.VITE_PORT ?? ${vitePort});
|
|
31
|
+
const host = env.VITE_HOST ?? '${viteHost}';
|
|
32
|
+
const apiTarget = env.VITE_API_BASE_URL ?? '${apiProxy}';
|
|
33
|
+
|
|
34
|
+
return {
|
|
35
|
+
plugins: [react()],
|
|
36
|
+
server: {
|
|
37
|
+
port,
|
|
38
|
+
host,
|
|
39
|
+
proxy: {
|
|
40
|
+
'/api': {
|
|
41
|
+
target: apiTarget,
|
|
42
|
+
changeOrigin: true,
|
|
43
|
+
},
|
|
44
|
+
// WebSocket proxy \u2014 the runtime's useEntitySync hook opens
|
|
45
|
+
// ws://<host>/ws to receive entity mutation events from the
|
|
46
|
+
// backend event bus. Without this proxy the socket tries to
|
|
47
|
+
// connect to the vite dev server on /ws and fails, forcing
|
|
48
|
+
// state-sync to fall back to React Query's refetchInterval
|
|
49
|
+
// polling (usable but slow).
|
|
50
|
+
'/ws': {
|
|
51
|
+
target: apiTarget.replace(/^http/, 'ws'),
|
|
52
|
+
ws: true,
|
|
53
|
+
changeOrigin: true,
|
|
54
|
+
},
|
|
34
55
|
},
|
|
35
56
|
},
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
57
|
+
build: {
|
|
58
|
+
outDir: 'dist',
|
|
59
|
+
sourcemap: true,
|
|
60
|
+
},
|
|
61
|
+
resolve: {
|
|
62
|
+
alias: {
|
|
63
|
+
'@': path.resolve(__dirname, './src'),
|
|
64
|
+
},
|
|
65
|
+
// Prevent React duplication when using local packages
|
|
66
|
+
dedupe: ['react', 'react-dom'],
|
|
44
67
|
},
|
|
45
|
-
|
|
46
|
-
dedupe: ['react', 'react-dom'],
|
|
47
|
-
},
|
|
68
|
+
};
|
|
48
69
|
});
|
|
49
70
|
`;
|
|
50
71
|
}
|
|
@@ -0,0 +1,211 @@
|
|
|
1
|
+
# ReactAppStarter — Emitter Architecture
|
|
2
|
+
|
|
3
|
+
**Audience**: anyone touching the view emitter for Factory B (the "starter-kit" React factory).
|
|
4
|
+
|
|
5
|
+
**Companion docs**:
|
|
6
|
+
- `specverse-self/docs/guides/VIEW-RENDERING-ARCHITECTURE.md` (the "one pattern library, three consumers" design)
|
|
7
|
+
- `specverse-self/docs/plans/2026-04-17-UNIFIED-VIEW-RENDERING.md` (the migration plan)
|
|
8
|
+
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
## The problem this solves
|
|
12
|
+
|
|
13
|
+
Factory B emits a standalone React codebase. For every view in the inferred spec (dev defaults + user-defined views), it writes a `.tsx` file the user can read, fork, and edit. The generated code:
|
|
14
|
+
|
|
15
|
+
- Has no `@specverse/runtime` dependency (fully standalone).
|
|
16
|
+
- Is idiomatic React with typed props, hooks, event handlers — not a big static HTML blob.
|
|
17
|
+
- Renders the **same** visual output as `@specverse/runtime` renders for the same spec (verified by Phase 3 parity test P3).
|
|
18
|
+
|
|
19
|
+
The tension: "idiomatic React structure" wants hand-crafted JSX. "Same visual output as runtime" wants a single rendering authority. Strategy 3 resolves this by splitting *structure* (hand-written skeleton templates) from *interior* (canonical Tailwind adapter rendering).
|
|
20
|
+
|
|
21
|
+
## The three pieces
|
|
22
|
+
|
|
23
|
+
```
|
|
24
|
+
┌─────────────────────────────────────────────────────────────┐
|
|
25
|
+
│ 1. view-emitter.ts — orchestrator │
|
|
26
|
+
│ Takes (viewSpec, modelSpec, expandedSpec) → .tsx string │
|
|
27
|
+
└──────────────┬───────────────────────────────┬──────────────┘
|
|
28
|
+
│ │
|
|
29
|
+
▼ ▼
|
|
30
|
+
┌──────────────────────────────┐ ┌─────────────────────────────────┐
|
|
31
|
+
│ 2. skeletons/*.tsx.template │ │ 3. html-to-jsx.ts — transformer│
|
|
32
|
+
│ One per view type: │ │ │
|
|
33
|
+
│ list.tsx.template │ │ Converts Tailwind-HTML │
|
|
34
|
+
│ detail.tsx.template │ │ strings from the runtime │
|
|
35
|
+
│ form.tsx.template │ │ adapter into JSX-safe source │
|
|
36
|
+
│ dashboard.tsx.template │ │ (class→className, self-close,│
|
|
37
|
+
│ + specialist types │ │ brace escape, attribute map) │
|
|
38
|
+
│ │ │ │
|
|
39
|
+
│ Each has a {{BODY}} │ │ ~50-150 LoC, bounded scope │
|
|
40
|
+
│ placeholder the emitter │ │ │
|
|
41
|
+
│ fills with transformed │ │ │
|
|
42
|
+
│ JSX. │ │ │
|
|
43
|
+
└──────────────────────────────┘ └─────────────────────────────────┘
|
|
44
|
+
▲
|
|
45
|
+
│
|
|
46
|
+
│ renders body as HTML
|
|
47
|
+
│
|
|
48
|
+
┌─────────────────────┴──────────────────────┐
|
|
49
|
+
│ @specverse/runtime/views/tailwind │
|
|
50
|
+
│ createUniversalTailwindAdapter() │
|
|
51
|
+
│ (the canonical build-time renderer — │
|
|
52
|
+
│ same code app-demo and Factory A │
|
|
53
|
+
│ transitively rely on at runtime) │
|
|
54
|
+
└────────────────────────────────────────────┘
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
## Data flow for ONE view
|
|
58
|
+
|
|
59
|
+
Given an inferred `PostListView` in the expanded spec:
|
|
60
|
+
|
|
61
|
+
1. **view-emitter.ts** receives `(view, model, expandedSpec)`.
|
|
62
|
+
2. Picks the correct skeleton based on `view.type`: `skeletons/list.tsx.template`.
|
|
63
|
+
3. Builds a render context for the pattern: `{ primaryModel: 'Post', modelSchemas: {...}, viewSpec: view, modelData: [] }` (empty data — structure only).
|
|
64
|
+
4. Calls `createUniversalTailwindAdapter()` and renders the composite pattern's interior → HTML string.
|
|
65
|
+
Example output: `<table class="w-full ..."><thead><tr><th class="...">Title</th>...`.
|
|
66
|
+
5. Passes that HTML through **html-to-jsx.ts** → JSX-safe source.
|
|
67
|
+
Example: `<table className="w-full ..."><thead><tr><th className="...">{/* data.map */}Title</th>...`.
|
|
68
|
+
6. Substitutes `{{BODY}}` in the skeleton with the transformed JSX.
|
|
69
|
+
7. Substitutes skeleton placeholders like `{{MODEL_NAME}}`, `{{PLURAL}}`, `{{PROPS_INTERFACE}}` with model-specific values.
|
|
70
|
+
8. Returns the complete `.tsx` source string.
|
|
71
|
+
|
|
72
|
+
The factory's realize pass calls this once per view, writes each to `frontend/src/views/{ViewName}.tsx`, updates `.specverse-gen/hashes.json`.
|
|
73
|
+
|
|
74
|
+
## Why this split works
|
|
75
|
+
|
|
76
|
+
- **Idiomatic outer structure** — skeletons are hand-written `.tsx.template` files, tweaked by the humans who maintain the factory. They define imports, props interfaces, hook placement, event wiring, loading states, empty states. Exactly what a human React author would write.
|
|
77
|
+
- **Pattern-driven interior** — the actual markup (table header cells, row templates, form fields, badge styling) comes from the canonical Tailwind adapter. When runtime improves the pattern rendering, Factory B inherits the fix automatically — because the adapter is the single source.
|
|
78
|
+
- **No full re-implementation** — we don't build a second renderer. The adapter already works for runtime; we reuse it at build time.
|
|
79
|
+
|
|
80
|
+
## The html-to-jsx transformer — scope
|
|
81
|
+
|
|
82
|
+
Input: HTML string with Tailwind classes. Single root element (always — the adapter always produces a containing element).
|
|
83
|
+
|
|
84
|
+
Output: A JSX-safe source string that can be dropped between JSX tags.
|
|
85
|
+
|
|
86
|
+
What it does:
|
|
87
|
+
1. `class="..."` → `className="..."`
|
|
88
|
+
2. Self-closing tags: `<img src="...">` → `<img src="..." />`
|
|
89
|
+
3. Escape `{` and `}` in text content by wrapping in `{'{'}` / `{'}'}` when they appear outside attribute values.
|
|
90
|
+
4. Convert `style="color: red"` to `style={{ color: 'red' }}`.
|
|
91
|
+
5. Convert `for="..."` to `htmlFor="..."`.
|
|
92
|
+
6. Strip any attributes that aren't valid in JSX.
|
|
93
|
+
|
|
94
|
+
What it explicitly does NOT do:
|
|
95
|
+
- Parse JavaScript inside the HTML (the adapter produces static HTML — no JS expressions).
|
|
96
|
+
- Insert React hooks or event handlers — those live in the skeleton, not the interior.
|
|
97
|
+
- Handle SVG / MathML nuances — only HTML+Tailwind.
|
|
98
|
+
|
|
99
|
+
Test coverage target: feed the transformer 50 pre-captured HTML snippets from the canonical adapter output, assert the JSX output parses as valid TSX via `typescript.transpileModule`.
|
|
100
|
+
|
|
101
|
+
## Skeleton template format
|
|
102
|
+
|
|
103
|
+
A skeleton is a `.tsx.template` file — syntactically valid TypeScript with substitution markers. Example (sketch for `list.tsx.template`):
|
|
104
|
+
|
|
105
|
+
```tsx
|
|
106
|
+
/**
|
|
107
|
+
* {{MODEL_NAME}}ListView — generated by @specverse/realize (ReactAppStarter)
|
|
108
|
+
*
|
|
109
|
+
* Safe to edit. Edits are preserved across regeneration (content-hashed).
|
|
110
|
+
* Regenerate with `spv realize` or, if this file was edited, delete the
|
|
111
|
+
* file first to opt back into regeneration.
|
|
112
|
+
*/
|
|
113
|
+
import { useState, useMemo } from 'react';
|
|
114
|
+
import { use{{PLURAL_MODEL}}Query, useDelete{{MODEL_NAME}}Mutation } from '../hooks/useApi';
|
|
115
|
+
import type { {{MODEL_NAME}} } from '../types/api';
|
|
116
|
+
|
|
117
|
+
interface {{MODEL_NAME}}ListViewProps {
|
|
118
|
+
onSelect?: (item: {{MODEL_NAME}}) => void;
|
|
119
|
+
onCreate?: () => void;
|
|
120
|
+
}
|
|
121
|
+
|
|
122
|
+
export function {{MODEL_NAME}}ListView({ onSelect, onCreate }: {{MODEL_NAME}}ListViewProps) {
|
|
123
|
+
const { data: items = [], isLoading, error } = use{{PLURAL_MODEL}}Query();
|
|
124
|
+
const deleteItem = useDelete{{MODEL_NAME}}Mutation();
|
|
125
|
+
const [searchTerm, setSearchTerm] = useState('');
|
|
126
|
+
|
|
127
|
+
const filtered = useMemo(
|
|
128
|
+
() => items.filter(item =>
|
|
129
|
+
Object.values(item).some(v => String(v).toLowerCase().includes(searchTerm.toLowerCase()))
|
|
130
|
+
),
|
|
131
|
+
[items, searchTerm]
|
|
132
|
+
);
|
|
133
|
+
|
|
134
|
+
if (isLoading) return <div className="p-4 text-gray-500">Loading…</div>;
|
|
135
|
+
if (error) return <div className="p-4 text-red-600">Error loading {{PLURAL_LOWER}}: {String(error)}</div>;
|
|
136
|
+
|
|
137
|
+
return (
|
|
138
|
+
<div className="p-6 space-y-4">
|
|
139
|
+
<div className="flex justify-between items-center">
|
|
140
|
+
<input
|
|
141
|
+
type="search"
|
|
142
|
+
placeholder="Search {{PLURAL_LOWER}}…"
|
|
143
|
+
value={searchTerm}
|
|
144
|
+
onChange={e => setSearchTerm(e.target.value)}
|
|
145
|
+
className="rounded border px-3 py-2 w-64"
|
|
146
|
+
/>
|
|
147
|
+
<button
|
|
148
|
+
onClick={onCreate}
|
|
149
|
+
className="rounded bg-blue-600 px-4 py-2 text-white hover:bg-blue-700"
|
|
150
|
+
>
|
|
151
|
+
+ New {{MODEL_NAME}}
|
|
152
|
+
</button>
|
|
153
|
+
</div>
|
|
154
|
+
|
|
155
|
+
{/* {{BODY}} — pattern-rendered table interior, JSX-transformed */}
|
|
156
|
+
{{BODY}}
|
|
157
|
+
|
|
158
|
+
{filtered.length === 0 && (
|
|
159
|
+
<div className="p-8 text-center text-gray-400">No {{PLURAL_LOWER}} yet.</div>
|
|
160
|
+
)}
|
|
161
|
+
</div>
|
|
162
|
+
);
|
|
163
|
+
}
|
|
164
|
+
```
|
|
165
|
+
|
|
166
|
+
Substitution contract:
|
|
167
|
+
- `{{MODEL_NAME}}` — PascalCase model name (e.g., `Post`).
|
|
168
|
+
- `{{PLURAL_MODEL}}` — PascalCase plural (e.g., `Posts`).
|
|
169
|
+
- `{{PLURAL_LOWER}}` — lowercase plural (e.g., `posts`).
|
|
170
|
+
- `{{BODY}}` — exactly one substitution per skeleton, where the pattern-rendered interior goes.
|
|
171
|
+
|
|
172
|
+
Substitution is plain string replacement — no template expression evaluation.
|
|
173
|
+
|
|
174
|
+
## File placement
|
|
175
|
+
|
|
176
|
+
```
|
|
177
|
+
engines/libs/instance-factories/applications/templates/react-starter/
|
|
178
|
+
├── README.md # this file
|
|
179
|
+
├── view-emitter.ts # orchestrator (step 1)
|
|
180
|
+
├── html-to-jsx.ts # transformer (step 3)
|
|
181
|
+
├── skeletons/
|
|
182
|
+
│ ├── list.tsx.template # list view
|
|
183
|
+
│ ├── detail.tsx.template # detail view
|
|
184
|
+
│ ├── form.tsx.template # form view (Phase 2e)
|
|
185
|
+
│ ├── dashboard.tsx.template # dashboard (Phase 2e)
|
|
186
|
+
│ └── specialist-*.tsx.template # board/timeline/calendar (Phase 2e)
|
|
187
|
+
└── __tests__/
|
|
188
|
+
├── html-to-jsx.test.ts # transformer unit tests
|
|
189
|
+
└── view-emitter.test.ts # end-to-end: (spec, view) → valid TSX
|
|
190
|
+
```
|
|
191
|
+
|
|
192
|
+
## Build order (Phase 2a in the migration plan)
|
|
193
|
+
|
|
194
|
+
1. Implement `html-to-jsx.ts` first (smallest, most testable, standalone).
|
|
195
|
+
2. Write `list.tsx.template` (one view type; production-quality).
|
|
196
|
+
3. Implement `view-emitter.ts` — orchestrator that wires html-to-jsx + canonical Tailwind adapter + skeleton.
|
|
197
|
+
4. Integration test: take a reference spec with one model + its list view, emit, assert the `.tsx` source parses and its JSX matches the expected shape.
|
|
198
|
+
5. Only after list works end-to-end: template out to detail + form + dashboard.
|
|
199
|
+
|
|
200
|
+
## Open questions (inside Phase 2a)
|
|
201
|
+
|
|
202
|
+
1. **Where do per-model hooks come from?** `use{{PLURAL_MODEL}}Query` and `useDelete{{MODEL_NAME}}Mutation` in the skeleton presume a generated hooks file (`src/hooks/useApi.ts`) that provides them. `ReactAppRuntime` already generates this file via `use-api-hooks-generator.ts` — Factory B should reuse that generator (shared between both factories as called out in the migration plan).
|
|
203
|
+
2. **How does the skeleton address auto-generated fields (id, createdAt, etc.)?** The view should skip them in the table/form. `isAutoGeneratedField()` logic needs to be available in the generated output. Plan: emit a `src/lib/field-helpers.ts` alongside the views (inlined from the pattern library's logic, same way the runtime has it).
|
|
204
|
+
3. **What happens when the view spec has `uiComponents` that the pattern library doesn't recognize?** Runtime gracefully falls back to a default table. Factory B should do the same — same fallback logic, same output.
|
|
205
|
+
4. **Should the skeleton expose a slot for user-added React nodes (e.g. `<Children />` or a `prepend` prop)?** Useful for extensibility without forcing users to edit the generated file. Defer to v2 of the emitter — start with fixed skeletons.
|
|
206
|
+
|
|
207
|
+
## Non-goals
|
|
208
|
+
|
|
209
|
+
- No JSX AST parsing or manipulation. `html-to-jsx.ts` is a string transformer, not a compiler.
|
|
210
|
+
- No server-side rendering of the React components. The emitter outputs source files; the user's Vite build bundles them.
|
|
211
|
+
- No runtime customization of skeletons. A project that wants different skeletons forks the factory or the generated code.
|
|
@@ -0,0 +1,69 @@
|
|
|
1
|
+
function mapAttrType(attr) {
|
|
2
|
+
const t = typeof attr === "string" ? attr.split(/\s+/)[0] : attr?.type;
|
|
3
|
+
const values = attr?.values;
|
|
4
|
+
if (Array.isArray(values) && values.length > 0) {
|
|
5
|
+
return values.map((v) => JSON.stringify(v)).join(" | ");
|
|
6
|
+
}
|
|
7
|
+
switch ((t || "").toLowerCase()) {
|
|
8
|
+
case "string":
|
|
9
|
+
case "text":
|
|
10
|
+
case "uuid":
|
|
11
|
+
case "email":
|
|
12
|
+
case "url":
|
|
13
|
+
return "string";
|
|
14
|
+
case "int":
|
|
15
|
+
case "integer":
|
|
16
|
+
case "float":
|
|
17
|
+
case "number":
|
|
18
|
+
case "decimal":
|
|
19
|
+
return "number";
|
|
20
|
+
case "boolean":
|
|
21
|
+
case "bool":
|
|
22
|
+
return "boolean";
|
|
23
|
+
case "datetime":
|
|
24
|
+
case "date":
|
|
25
|
+
case "time":
|
|
26
|
+
case "timestamp":
|
|
27
|
+
return "string";
|
|
28
|
+
case "json":
|
|
29
|
+
return "Record<string, unknown>";
|
|
30
|
+
default:
|
|
31
|
+
return "unknown";
|
|
32
|
+
}
|
|
33
|
+
}
|
|
34
|
+
function isRequired(attr) {
|
|
35
|
+
if (typeof attr === "string") return /\brequired\b/.test(attr);
|
|
36
|
+
return !!attr?.required;
|
|
37
|
+
}
|
|
38
|
+
async function generate(context) {
|
|
39
|
+
const models = context.spec.models ?? {};
|
|
40
|
+
const modelNames = Object.keys(models);
|
|
41
|
+
const header = `/**
|
|
42
|
+
* API types (ReactAppStarter)
|
|
43
|
+
*
|
|
44
|
+
* Per-model interfaces generated from the spec's model definitions.
|
|
45
|
+
* Safe to edit \u2014 extend these when your UI needs more than the spec
|
|
46
|
+
* describes (e.g. optimistic fields, denormalized joins).
|
|
47
|
+
*/
|
|
48
|
+
`;
|
|
49
|
+
const interfaces = modelNames.map((name) => {
|
|
50
|
+
const model = models[name] || {};
|
|
51
|
+
const attrs = model.attributes || {};
|
|
52
|
+
const attrKeys = Object.keys(attrs);
|
|
53
|
+
const fields = attrKeys.map((attrName) => {
|
|
54
|
+
const attr = attrs[attrName];
|
|
55
|
+
const tsType = mapAttrType(attr);
|
|
56
|
+
const optional = isRequired(attr) ? "" : "?";
|
|
57
|
+
return ` ${attrName}${optional}: ${tsType};`;
|
|
58
|
+
}).join("\n");
|
|
59
|
+
return `export interface ${name} {
|
|
60
|
+
${fields || " [key: string]: unknown;"}
|
|
61
|
+
}`;
|
|
62
|
+
}).join("\n\n");
|
|
63
|
+
return header + "\n" + interfaces + "\n";
|
|
64
|
+
}
|
|
65
|
+
var stdin_default = generate;
|
|
66
|
+
export {
|
|
67
|
+
stdin_default as default,
|
|
68
|
+
generate
|
|
69
|
+
};
|
package/dist/libs/instance-factories/applications/templates/react-starter/app-tsx-generator.js
CHANGED
|
@@ -79,7 +79,7 @@ function buildNavEntries(models) {
|
|
|
79
79
|
</div>
|
|
80
80
|
<button type="button" onClick={() => select('${m}', 'list')} className="${navButtonCls("list")}">List</button>
|
|
81
81
|
<button type="button" onClick={() => select('${m}', 'dashboard')} className="${navButtonCls("dashboard")}">Dashboard</button>
|
|
82
|
-
<button type="button" onClick={() => select('${m}', 'form')} className="${navButtonCls("form")}">
|
|
82
|
+
<button type="button" onClick={() => select('${m}', 'form')} className="${navButtonCls("form")}">Form</button>
|
|
83
83
|
</div>`).join("\n");
|
|
84
84
|
}
|
|
85
85
|
function navButtonCls(_view) {
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
function extractBelongsToTargets(model) {
|
|
2
|
+
const rels = model.relationships ?? {};
|
|
3
|
+
const out = [];
|
|
4
|
+
for (const [name, rawDef] of Object.entries(rels)) {
|
|
5
|
+
const parsed = parseBelongsTo(rawDef);
|
|
6
|
+
if (parsed) out.push({ name, target: parsed });
|
|
7
|
+
}
|
|
8
|
+
return out;
|
|
9
|
+
}
|
|
10
|
+
function parseBelongsTo(def) {
|
|
11
|
+
if (typeof def === "string") {
|
|
12
|
+
const parts = def.trim().split(/\s+/);
|
|
13
|
+
if (parts[0] === "belongsTo" && parts[1]) return parts[1];
|
|
14
|
+
return null;
|
|
15
|
+
}
|
|
16
|
+
if (def && typeof def === "object") {
|
|
17
|
+
const o = def;
|
|
18
|
+
if (o.type === "belongsTo") {
|
|
19
|
+
return o.target || o.to || o.model || o.targetModel || null;
|
|
20
|
+
}
|
|
21
|
+
}
|
|
22
|
+
return null;
|
|
23
|
+
}
|
|
24
|
+
function pluralize(s) {
|
|
25
|
+
if (/[^aeiou]y$/i.test(s)) return s.slice(0, -1) + "ies";
|
|
26
|
+
if (/(s|x|z|ch|sh)$/i.test(s)) return s + "es";
|
|
27
|
+
return s + "s";
|
|
28
|
+
}
|
|
29
|
+
function buildFKMap(model) {
|
|
30
|
+
const map = /* @__PURE__ */ new Map();
|
|
31
|
+
for (const rel of extractBelongsToTargets(model)) {
|
|
32
|
+
map.set(`${rel.name}Id`, rel);
|
|
33
|
+
}
|
|
34
|
+
return map;
|
|
35
|
+
}
|
|
36
|
+
export {
|
|
37
|
+
buildFKMap,
|
|
38
|
+
extractBelongsToTargets,
|
|
39
|
+
pluralize
|
|
40
|
+
};
|
package/dist/libs/instance-factories/applications/templates/react-starter/dashboard-body-composer.js
CHANGED
|
@@ -1,9 +1,11 @@
|
|
|
1
1
|
import { METADATA_FIELDS } from "@specverse/runtime/views/core";
|
|
2
|
+
import { buildFKMap } from "./belongs-to.js";
|
|
2
3
|
const METADATA_FIELD_NAMES = new Set(METADATA_FIELDS);
|
|
3
4
|
function composeDashboardBody(context) {
|
|
4
5
|
const modelName = context.model.name;
|
|
5
6
|
const previewColumns = inferPreviewColumns(context.model);
|
|
6
7
|
const enumFields = inferEnumFields(context.model);
|
|
8
|
+
const fkMap = buildFKMap(context.model);
|
|
7
9
|
const lines = [];
|
|
8
10
|
lines.push('<div className="grid grid-cols-1 gap-4 sm:grid-cols-2 lg:grid-cols-4">');
|
|
9
11
|
lines.push(...renderTotalCard(modelName));
|
|
@@ -32,8 +34,10 @@ function composeDashboardBody(context) {
|
|
|
32
34
|
lines.push(" <thead>");
|
|
33
35
|
lines.push(" <tr>");
|
|
34
36
|
for (const col of previewColumns) {
|
|
37
|
+
const fk = fkMap.get(col);
|
|
38
|
+
const headerLabel = humanize(fk ? fk.name : col);
|
|
35
39
|
lines.push(
|
|
36
|
-
` <th className="px-6 py-3 text-left text-xs font-medium text-gray-500 dark:text-gray-400 uppercase tracking-wider">` +
|
|
40
|
+
` <th className="px-6 py-3 text-left text-xs font-medium text-gray-500 dark:text-gray-400 uppercase tracking-wider">` + headerLabel + `</th>`
|
|
37
41
|
);
|
|
38
42
|
}
|
|
39
43
|
lines.push(" </tr>");
|
|
@@ -46,8 +50,10 @@ function composeDashboardBody(context) {
|
|
|
46
50
|
lines.push(' className="hover:bg-gray-50 dark:hover:bg-gray-800 cursor-pointer"');
|
|
47
51
|
lines.push(" >");
|
|
48
52
|
for (const col of previewColumns) {
|
|
53
|
+
const fk = fkMap.get(col);
|
|
54
|
+
const expr = fk ? `{resolveEntityDisplayName((item as any).${col}, ${fk.name}Options)}` : `{String((item as any).${col} ?? '')}`;
|
|
49
55
|
lines.push(
|
|
50
|
-
` <td className="px-6 py-4 text-sm text-gray-700 dark:text-gray-300"
|
|
56
|
+
` <td className="px-6 py-4 text-sm text-gray-700 dark:text-gray-300">${expr}</td>`
|
|
51
57
|
);
|
|
52
58
|
}
|
|
53
59
|
lines.push(" </tr>");
|
|
@@ -111,7 +117,9 @@ function inferEnumFields(model) {
|
|
|
111
117
|
}
|
|
112
118
|
function inferPreviewColumns(model) {
|
|
113
119
|
const attrs = model.attributes ?? {};
|
|
114
|
-
|
|
120
|
+
const attrCols = Object.keys(attrs).filter((n) => !METADATA_FIELD_NAMES.has(n));
|
|
121
|
+
const fkCols = [...buildFKMap(model).keys()].filter((k) => !attrCols.includes(k));
|
|
122
|
+
return [...fkCols, ...attrCols].slice(0, Math.max(5, fkCols.length + 1));
|
|
115
123
|
}
|
|
116
124
|
function humanize(name) {
|
|
117
125
|
return name.replace(/([A-Z])/g, " $1").replace(/^./, (c) => c.toUpperCase()).trim();
|