@decohere/scaffold 0.0.1-dev.18 → 0.0.1-dev.81

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.
Files changed (240) hide show
  1. package/commonjs/src/add-api.action.js +39 -0
  2. package/commonjs/src/add-api.command.js +41 -0
  3. package/commonjs/src/add.command.js +24 -0
  4. package/commonjs/src/add.module.js +26 -0
  5. package/commonjs/src/cli.js +9 -0
  6. package/commonjs/src/create.command.js +24 -0
  7. package/commonjs/src/create.module.js +26 -0
  8. package/commonjs/src/domain/prompt.js +64 -0
  9. package/commonjs/src/index.js +38 -0
  10. package/commonjs/src/models/compose.model.js +150 -0
  11. package/commonjs/src/models/config-yaml.model.js +88 -0
  12. package/commonjs/src/models/const.js +32 -0
  13. package/commonjs/src/models/dev-container.model.js +116 -0
  14. package/commonjs/src/models/docker-image.model.js +259 -0
  15. package/commonjs/src/models/env-file.model.js +50 -0
  16. package/commonjs/src/models/gitignore.model.js +43 -0
  17. package/commonjs/src/models/launch-json.model.js +74 -0
  18. package/commonjs/src/models/package-json.model.js +149 -0
  19. package/commonjs/src/models/project.model.js +134 -0
  20. package/commonjs/src/models/source-file.js +6 -0
  21. package/commonjs/src/models/tsconfig.model.js +34 -0
  22. package/commonjs/src/models/vitest-config.model.js +35 -0
  23. package/commonjs/src/models/vscode-settings.model.js +31 -0
  24. package/commonjs/src/program.js +57 -0
  25. package/commonjs/src/resolve-target-dir.js +19 -0
  26. package/commonjs/src/services/scaffold.service.js +62 -0
  27. package/commonjs/src/version.js +57 -0
  28. package/commonjs/src/webapi/api-name.js +95 -0
  29. package/commonjs/src/webapi/cli-options.js +101 -0
  30. package/commonjs/src/webapi/const.js +50 -0
  31. package/commonjs/src/webapi/create-api.js +237 -0
  32. package/commonjs/src/webapi/devcontainer/codebase-rag-mcp.js +166 -0
  33. package/commonjs/src/webapi/devcontainer/codebase-rag-mcp.ts +182 -0
  34. package/commonjs/src/webapi/devcontainer/host-scripts.js +52 -0
  35. package/commonjs/src/webapi/devcontainer/templates/codebase-rag.env.example +3 -0
  36. package/commonjs/src/webapi/devcontainer/templates/initialize.sh +169 -0
  37. package/commonjs/src/webapi/devcontainer/templates/post-create.sh +35 -0
  38. package/commonjs/src/webapi/devcontainer/templates/post-start.sh +65 -0
  39. package/commonjs/src/webapi/devcontainer/templates/tty-prompt.sh +38 -0
  40. package/commonjs/src/webapi/features/auth.feature.js +441 -0
  41. package/commonjs/src/webapi/features/auth0-cli.js +435 -0
  42. package/commonjs/src/webapi/features/biome-format.js +49 -0
  43. package/commonjs/src/webapi/features/database.feature.js +433 -0
  44. package/commonjs/src/webapi/features/finalize.feature.js +95 -0
  45. package/commonjs/src/webapi/features/postman.feature.js +324 -0
  46. package/commonjs/src/webapi/models/api-package-json.model.js +60 -0
  47. package/commonjs/src/webapi/models/auth-config.model.js +26 -0
  48. package/commonjs/src/webapi/models/controller-source-file.model.js +193 -0
  49. package/commonjs/src/webapi/models/github-ci.model.js +193 -0
  50. package/commonjs/src/webapi/models/main-source-file.model.js +167 -0
  51. package/commonjs/src/webapi/models/production-dockerfile.model.js +157 -0
  52. package/commonjs/src/webapi/models/sample-files.model.js +60 -0
  53. package/commonjs/src/webapi/models/webapi-image.model.js +27 -0
  54. package/commonjs/src/webapi/postman/hello-openapi.js +175 -0
  55. package/commonjs/src/webapi/postman/local-view.js +184 -0
  56. package/commonjs/src/webapi/postman/openapi-to-postman.js +202 -0
  57. package/commonjs/src/webapi/workspace-readme.js +110 -0
  58. package/commonjs/src/webapi.action.js +30 -0
  59. package/commonjs/src/webapi.command.js +45 -0
  60. package/es6/src/add-api.action.js +29 -0
  61. package/es6/src/add-api.command.js +31 -0
  62. package/es6/src/add.command.js +14 -0
  63. package/es6/src/add.module.js +16 -0
  64. package/es6/src/cli.js +5 -0
  65. package/es6/src/create.command.js +14 -0
  66. package/es6/src/create.module.js +16 -0
  67. package/es6/src/domain/prompt.js +43 -0
  68. package/es6/src/index.js +8 -0
  69. package/es6/src/models/compose.model.js +144 -0
  70. package/es6/src/models/config-yaml.model.js +76 -0
  71. package/es6/src/models/const.js +22 -0
  72. package/es6/src/models/dev-container.model.js +106 -0
  73. package/es6/src/models/docker-image.model.js +217 -0
  74. package/es6/src/models/env-file.model.js +46 -0
  75. package/es6/src/models/gitignore.model.js +33 -0
  76. package/es6/src/models/launch-json.model.js +64 -0
  77. package/es6/src/models/package-json.model.js +137 -0
  78. package/es6/src/models/project.model.js +119 -0
  79. package/es6/src/models/source-file.js +3 -0
  80. package/es6/src/models/tsconfig.model.js +24 -0
  81. package/es6/src/models/vitest-config.model.js +25 -0
  82. package/es6/src/models/vscode-settings.model.js +21 -0
  83. package/es6/src/program.js +39 -0
  84. package/es6/src/resolve-target-dir.js +9 -0
  85. package/es6/src/services/scaffold.service.js +52 -0
  86. package/es6/src/version.js +36 -0
  87. package/es6/src/webapi/api-name.js +59 -0
  88. package/es6/src/webapi/cli-options.js +36 -0
  89. package/es6/src/webapi/const.js +20 -0
  90. package/es6/src/webapi/create-api.js +217 -0
  91. package/es6/src/webapi/devcontainer/codebase-rag-mcp.js +156 -0
  92. package/es6/src/webapi/devcontainer/codebase-rag-mcp.ts +182 -0
  93. package/es6/src/webapi/devcontainer/host-scripts.js +31 -0
  94. package/es6/src/webapi/devcontainer/templates/codebase-rag.env.example +3 -0
  95. package/es6/src/webapi/devcontainer/templates/initialize.sh +169 -0
  96. package/es6/src/webapi/devcontainer/templates/post-create.sh +35 -0
  97. package/es6/src/webapi/devcontainer/templates/post-start.sh +65 -0
  98. package/es6/src/webapi/devcontainer/templates/tty-prompt.sh +38 -0
  99. package/es6/src/webapi/features/auth.feature.js +390 -0
  100. package/es6/src/webapi/features/auth0-cli.js +375 -0
  101. package/es6/src/webapi/features/biome-format.js +42 -0
  102. package/es6/src/webapi/features/database.feature.js +423 -0
  103. package/es6/src/webapi/features/finalize.feature.js +85 -0
  104. package/es6/src/webapi/features/postman.feature.js +258 -0
  105. package/es6/src/webapi/models/api-package-json.model.js +55 -0
  106. package/es6/src/webapi/models/auth-config.model.js +22 -0
  107. package/es6/src/webapi/models/controller-source-file.model.js +184 -0
  108. package/es6/src/webapi/models/github-ci.model.js +186 -0
  109. package/es6/src/webapi/models/main-source-file.model.js +163 -0
  110. package/es6/src/webapi/models/production-dockerfile.model.js +148 -0
  111. package/es6/src/webapi/models/sample-files.model.js +42 -0
  112. package/es6/src/webapi/models/webapi-image.model.js +20 -0
  113. package/es6/src/webapi/postman/hello-openapi.js +168 -0
  114. package/es6/src/webapi/postman/local-view.js +169 -0
  115. package/es6/src/webapi/postman/openapi-to-postman.js +179 -0
  116. package/es6/src/webapi/workspace-readme.js +89 -0
  117. package/es6/src/webapi.action.js +20 -0
  118. package/es6/src/webapi.command.js +35 -0
  119. package/package.json +8 -8
  120. package/types/src/add-api.action.d.ts +13 -0
  121. package/types/src/add-api.command.d.ts +7 -0
  122. package/types/src/add.command.d.ts +6 -0
  123. package/types/src/add.module.d.ts +14 -0
  124. package/types/src/cli.d.ts +2 -0
  125. package/types/src/create.command.d.ts +6 -0
  126. package/types/src/create.module.d.ts +14 -0
  127. package/types/src/domain/prompt.d.ts +4 -0
  128. package/types/src/models/compose.model.d.ts +64 -0
  129. package/types/src/models/config-yaml.model.d.ts +27 -0
  130. package/types/src/models/const.d.ts +20 -0
  131. package/types/src/models/dev-container.model.d.ts +37 -0
  132. package/types/src/models/docker-image.model.d.ts +84 -0
  133. package/types/src/models/env-file.model.d.ts +16 -0
  134. package/types/src/models/gitignore.model.d.ts +7 -0
  135. package/types/src/models/launch-json.model.d.ts +7 -0
  136. package/types/src/models/package-json.model.d.ts +35 -0
  137. package/types/src/models/project.model.d.ts +60 -0
  138. package/{src/models/source-file.ts → types/src/models/source-file.d.ts} +4 -6
  139. package/types/src/models/tsconfig.model.d.ts +5 -0
  140. package/types/src/models/vitest-config.model.d.ts +5 -0
  141. package/types/src/models/vscode-settings.model.d.ts +7 -0
  142. package/types/src/program.d.ts +3 -0
  143. package/{src/resolve-target-dir.ts → types/src/resolve-target-dir.d.ts} +1 -4
  144. package/types/src/services/scaffold.service.d.ts +22 -0
  145. package/types/src/version.d.ts +6 -0
  146. package/types/src/webapi/api-name.d.ts +14 -0
  147. package/types/src/webapi/cli-options.d.ts +6 -0
  148. package/{src/webapi/const.ts → types/src/webapi/const.d.ts} +7 -21
  149. package/types/src/webapi/create-api.d.ts +15 -0
  150. package/types/src/webapi/devcontainer/codebase-rag-mcp.d.ts +32 -0
  151. package/types/src/webapi/devcontainer/codebase-rag-mcp.ts +182 -0
  152. package/types/src/webapi/devcontainer/host-scripts.d.ts +7 -0
  153. package/types/src/webapi/devcontainer/templates/codebase-rag.env.example +3 -0
  154. package/types/src/webapi/devcontainer/templates/initialize.sh +169 -0
  155. package/types/src/webapi/devcontainer/templates/post-create.sh +35 -0
  156. package/types/src/webapi/devcontainer/templates/post-start.sh +65 -0
  157. package/types/src/webapi/devcontainer/templates/tty-prompt.sh +38 -0
  158. package/types/src/webapi/features/auth.feature.d.ts +10 -0
  159. package/types/src/webapi/features/auth0-cli.d.ts +80 -0
  160. package/types/src/webapi/features/biome-format.d.ts +5 -0
  161. package/types/src/webapi/features/database.feature.d.ts +7 -0
  162. package/types/src/webapi/features/finalize.feature.d.ts +2 -0
  163. package/types/src/webapi/features/postman.feature.d.ts +16 -0
  164. package/types/src/webapi/models/api-package-json.model.d.ts +18 -0
  165. package/types/src/webapi/models/auth-config.model.d.ts +26 -0
  166. package/types/src/webapi/models/controller-source-file.model.d.ts +46 -0
  167. package/types/src/webapi/models/github-ci.model.d.ts +9 -0
  168. package/types/src/webapi/models/main-source-file.model.d.ts +54 -0
  169. package/types/src/webapi/models/production-dockerfile.model.d.ts +23 -0
  170. package/types/src/webapi/models/sample-files.model.d.ts +7 -0
  171. package/types/src/webapi/models/webapi-image.model.d.ts +12 -0
  172. package/types/src/webapi/postman/hello-openapi.d.ts +19 -0
  173. package/types/src/webapi/postman/local-view.d.ts +17 -0
  174. package/types/src/webapi/postman/openapi-to-postman.d.ts +62 -0
  175. package/types/src/webapi/workspace-readme.d.ts +18 -0
  176. package/types/src/webapi.action.d.ts +14 -0
  177. package/types/src/webapi.command.d.ts +11 -0
  178. package/src/add-api.action.ts +0 -25
  179. package/src/add-api.command.ts +0 -31
  180. package/src/add.command.ts +0 -20
  181. package/src/add.module.ts +0 -11
  182. package/src/cli.ts +0 -4
  183. package/src/create.command.ts +0 -20
  184. package/src/create.module.ts +0 -11
  185. package/src/domain/prompt.ts +0 -50
  186. package/src/models/compose.model.ts +0 -205
  187. package/src/models/config-yaml.model.ts +0 -83
  188. package/src/models/const.ts +0 -20
  189. package/src/models/dev-container.model.ts +0 -136
  190. package/src/models/docker-image.model.ts +0 -343
  191. package/src/models/env-file.model.ts +0 -45
  192. package/src/models/gitignore.model.ts +0 -35
  193. package/src/models/launch-json.model.ts +0 -60
  194. package/src/models/package-json.model.ts +0 -169
  195. package/src/models/project.model.ts +0 -141
  196. package/src/models/tsconfig.model.ts +0 -29
  197. package/src/models/vitest-config.model.ts +0 -26
  198. package/src/models/vscode-settings.model.ts +0 -24
  199. package/src/program.ts +0 -63
  200. package/src/services/scaffold.service.ts +0 -89
  201. package/src/version.ts +0 -56
  202. package/src/webapi/api-name.ts +0 -73
  203. package/src/webapi/cli-options.ts +0 -56
  204. package/src/webapi/create-api.ts +0 -275
  205. package/src/webapi/devcontainer/host-scripts.ts +0 -35
  206. package/src/webapi/features/auth.feature.ts +0 -454
  207. package/src/webapi/features/auth0-cli.ts +0 -421
  208. package/src/webapi/features/biome-format.ts +0 -34
  209. package/src/webapi/features/database.feature.ts +0 -522
  210. package/src/webapi/features/finalize.feature.ts +0 -112
  211. package/src/webapi/features/postman.feature.ts +0 -287
  212. package/src/webapi/models/api-package-json.model.ts +0 -60
  213. package/src/webapi/models/auth-config.model.ts +0 -36
  214. package/src/webapi/models/controller-source-file.model.ts +0 -232
  215. package/src/webapi/models/github-ci.model.ts +0 -188
  216. package/src/webapi/models/main-source-file.model.ts +0 -208
  217. package/src/webapi/models/production-dockerfile.model.ts +0 -162
  218. package/src/webapi/models/sample-files.model.ts +0 -45
  219. package/src/webapi/models/webapi-image.model.ts +0 -21
  220. package/src/webapi/postman/hello-openapi.ts +0 -92
  221. package/src/webapi/postman/local-view.ts +0 -195
  222. package/src/webapi/postman/openapi-to-postman.ts +0 -208
  223. package/src/webapi/workspace-readme.ts +0 -192
  224. package/src/webapi.action.ts +0 -22
  225. package/src/webapi.command.ts +0 -41
  226. package/tests/auth-postman.wiring.spec.ts +0 -263
  227. package/tests/auth0-cli.spec.ts +0 -232
  228. package/tests/biome-format.spec.ts +0 -49
  229. package/tests/cli.integration.spec.ts +0 -658
  230. package/tests/compose.model.spec.ts +0 -51
  231. package/tests/container-image.model.spec.ts +0 -162
  232. package/tests/dev-container.model.spec.ts +0 -29
  233. package/tests/devcontainer-base-image.spec.ts +0 -32
  234. package/tests/hello-di-inject.scaffold.spec.ts +0 -18
  235. package/tests/hello-route.contract.spec.ts +0 -94
  236. package/tests/package-json.order.spec.ts +0 -59
  237. package/tests/postman-from-openapi.spec.ts +0 -197
  238. package/tests/seed-devcontainer-templates.ts +0 -40
  239. package/tests/webapi/devcontainer/codebase-rag-mcp.spec.ts +0 -96
  240. /package/{src/index.ts → types/src/index.d.ts} +0 -0
@@ -0,0 +1,65 @@
1
+ #!/usr/bin/env bash
2
+ # Runs on every container start (devcontainer postStartCommand).
3
+ # Optional npm / gh login is y/N on a TTY. Install is post-create.sh.
4
+ # MCP merge also runs here for later reconnects; the Compose service command
5
+ # merges before Cursor attaches (postStart is too late for the first snapshot).
6
+ set -euo pipefail
7
+
8
+ here="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
9
+ root="$(cd "$here/.." && pwd)"
10
+ # shellcheck source=tty-prompt.sh
11
+ source "$here/tty-prompt.sh"
12
+
13
+ CODEBASE_RAG_WORKSPACE="$root" node --experimental-strip-types "$here/codebase-rag-mcp.ts" merge ||
14
+ echo "codebase-rag MCP: merge skipped" >&2
15
+
16
+ AUTH_REGISTRY="https://registry.npmjs.org"
17
+
18
+ ensure_npm_auth() {
19
+ if npm whoami --registry "$AUTH_REGISTRY" >/dev/null 2>&1; then
20
+ echo "npm: logged in as $(npm whoami --registry "$AUTH_REGISTRY")"
21
+ return 0
22
+ fi
23
+
24
+ if prompt_yn "Log in to npm?"; then
25
+ echo "npm: starting login..."
26
+ npm login --registry "$AUTH_REGISTRY" </dev/tty >/dev/tty
27
+ return 0
28
+ fi
29
+
30
+ echo "npm: skipped. Open a terminal and run: npm login" >&2
31
+ echo " (creds persist in .devcontainer/npm-auth/)" >&2
32
+ return 1
33
+ }
34
+
35
+ ensure_gh_auth() {
36
+ if ! command -v gh >/dev/null 2>&1; then
37
+ echo "gh: not installed in this container" >&2
38
+ return 1
39
+ fi
40
+
41
+ if gh auth status >/dev/null 2>&1; then
42
+ echo "gh: $(gh auth status 2>&1 | head -n1)"
43
+ return 0
44
+ fi
45
+
46
+ local token="${GH_TOKEN:-${GITHUB_TOKEN:-}}"
47
+ if [[ -n "$token" ]]; then
48
+ echo "gh: authenticating from GH_TOKEN..."
49
+ printf '%s\n' "$token" | gh auth login --with-token
50
+ return 0
51
+ fi
52
+
53
+ if prompt_yn "Log in to GitHub CLI (gh)?"; then
54
+ echo "gh: starting login..."
55
+ gh auth login </dev/tty >/dev/tty
56
+ return 0
57
+ fi
58
+
59
+ echo "gh: skipped. Open a terminal and run: gh auth login" >&2
60
+ echo " (creds persist in .devcontainer/gh-auth/; or set GH_TOKEN in .devcontainer/gh.env)" >&2
61
+ return 1
62
+ }
63
+
64
+ ensure_npm_auth || true
65
+ ensure_gh_auth || true
@@ -0,0 +1,38 @@
1
+ can_prompt() {
2
+ [[ -r /dev/tty && -w /dev/tty ]]
3
+ }
4
+
5
+ read_tty() {
6
+ local var="$1"
7
+ local hidden="${2:-}"
8
+ local value=""
9
+ if [[ -n "$hidden" ]]; then
10
+ read -r -s value </dev/tty || true
11
+ printf '\n' >/dev/tty
12
+ else
13
+ read -r value </dev/tty || true
14
+ fi
15
+ printf -v "$var" '%s' "$value"
16
+ }
17
+
18
+ # Returns 0 for yes. Default is n unless the second argument is y.
19
+ prompt_yn() {
20
+ local question="$1"
21
+ local default="${2:-n}"
22
+ local reply=""
23
+ if ! can_prompt; then
24
+ return 1
25
+ fi
26
+ local hint="y/N"
27
+ if [[ "$default" == "y" ]]; then
28
+ hint="Y/n"
29
+ fi
30
+ printf '%s [%s] ' "$question" "$hint" >/dev/tty
31
+ read_tty reply
32
+ reply="$(printf '%s' "$reply" | tr '[:upper:]' '[:lower:]' | sed 's/^[[:space:]]*//;s/[[:space:]]*$//')"
33
+ if [[ -z "$reply" ]]; then
34
+ [[ "$default" == "y" ]]
35
+ return
36
+ fi
37
+ [[ "$reply" == "y" || "$reply" == "yes" ]]
38
+ }
@@ -0,0 +1,10 @@
1
+ import type { Feature } from "../../services/scaffold.service.js";
2
+ export type AuthOptions = {
3
+ authProvider?: "auth0" | "none";
4
+ issuerBaseUrl?: string;
5
+ audience?: string;
6
+ databaseProvider?: "none" | "postgres/typeorm";
7
+ adminUsername?: string;
8
+ adminPassword?: string;
9
+ };
10
+ export declare const AuthFeature: Feature<AuthOptions>;
@@ -0,0 +1,80 @@
1
+ /** Management API scopes needed for API, SPA, connections, and admin users. */
2
+ declare const REQUIRED_SCOPES: string;
3
+ /** Default API scopes matching Hello CASL Authorize decorators. */
4
+ export declare const HELLO_API_SCOPES: readonly ["read:Hello", "create:Hello", "update:Hello", "delete:Hello"];
5
+ export declare const DB_CONNECTION_NAME = "Username-Password-Authentication";
6
+ export declare class Auth0AuthError extends Error {
7
+ constructor(message: string);
8
+ }
9
+ export interface Auth0Tenant {
10
+ name: string;
11
+ active?: boolean;
12
+ }
13
+ export declare function isInstalled(): boolean;
14
+ export declare function listTenants(): Auth0Tenant[];
15
+ export declare function login(): boolean;
16
+ export declare function listApis(): Array<{
17
+ identifier: string;
18
+ name: string;
19
+ }>;
20
+ export declare function createApi(name: string, identifier: string, scopes?: readonly string[]): {
21
+ identifier: string;
22
+ };
23
+ /**
24
+ * Replace an API's scopes and enable RBAC policy enforcement.
25
+ * Auth0 CLI `--scopes` replaces the full set.
26
+ */
27
+ export declare function updateApiScopes(identifier: string, scopes?: readonly string[]): void;
28
+ /** True when Auth0 refuses create because the tenant hit its Applications quota. */
29
+ export declare function isAuth0EntityLimitError(err: unknown): boolean;
30
+ /**
31
+ * Actionable message when Auth0 will not create another application.
32
+ * Does not suggest reusing unrelated apps — free tenants must delete unused ones.
33
+ */
34
+ export declare function formatSpaEntityLimitError(appName: string, apps: Auth0App[]): string;
35
+ export declare function createSpaApp(name: string, callbackUrls: string | readonly string[]): {
36
+ client_id: string;
37
+ };
38
+ export type Auth0App = {
39
+ client_id: string;
40
+ name: string;
41
+ };
42
+ export declare function listApps(): Auth0App[];
43
+ export declare function updateSpaCallbacks(clientId: string, callbackUrls: string | readonly string[]): void;
44
+ /**
45
+ * Create a Postman SPA, or reuse an existing app with the same name (re-scaffold).
46
+ * Always returns a client_id suitable for Postman auth0ClientId.
47
+ * On Auth0 application-quota errors, throws a clear delete-apps message (no cross-app reuse).
48
+ */
49
+ export declare function ensureSpaApp(name: string, callbackUrls: string | readonly string[]): {
50
+ client_id: string;
51
+ reused: boolean;
52
+ };
53
+ /** Enable a database connection for an application (required for username/password login). */
54
+ export declare function enableConnectionForClient(connectionName: string, clientId: string): void;
55
+ export type AdminDatabaseUser = {
56
+ user_id: string;
57
+ email: string;
58
+ password: string;
59
+ username: string;
60
+ };
61
+ /** Strong default password when the scaffolder caller leaves password blank. */
62
+ export declare function generateAdminPassword(): string;
63
+ /** Look up a user by email (Management API users-by-email). */
64
+ export declare function findUserByEmail(email: string): {
65
+ user_id: string;
66
+ email: string;
67
+ } | null;
68
+ /** Reset password so a re-scaffold can write a known password to .env. */
69
+ export declare function updateUserPassword(userId: string, password: string): void;
70
+ /**
71
+ * Create a DB connection root-admin user for local / Postman login.
72
+ * If the user already exists, look them up, reset password to `input.password`,
73
+ * and return that identity so callers can still write .env credentials.
74
+ */
75
+ export declare function createAdminDatabaseUser(input: {
76
+ email: string;
77
+ password: string;
78
+ username: string;
79
+ }): AdminDatabaseUser;
80
+ export { REQUIRED_SCOPES };
@@ -0,0 +1,5 @@
1
+ /**
2
+ * Format/lint-fix all files in the scaffolded workspace with Biome.
3
+ * Prefer a global `biome` binary (builder image); fall back to `npx`.
4
+ */
5
+ export declare function formatScaffoldedFiles(targetDir: string, paths?: string[]): void;
@@ -0,0 +1,7 @@
1
+ import type { Feature } from "../../services/scaffold.service.js";
2
+ export type DatabaseOptions = {
3
+ databaseProvider?: "none" | "postgres/typeorm";
4
+ /** When true, merge into an existing workspace (\`webapi add\`). */
5
+ add?: boolean;
6
+ };
7
+ export declare const DatabaseFeature: Feature<DatabaseOptions>;
@@ -0,0 +1,2 @@
1
+ import type { Feature } from "../../services/scaffold.service.js";
2
+ export declare const FinalizeFeature: Feature;
@@ -0,0 +1,16 @@
1
+ import type { Feature } from "../../services/scaffold.service.js";
2
+ import { type Auth0Env } from "../postman/openapi-to-postman.js";
3
+ /** Postman OAuth callback URLs (popup + "Authorize using browser"). */
4
+ declare const POSTMAN_CALLBACKS: readonly ["https://oauth.pstmn.io/v1/callback", "https://oauth.pstmn.io/v1/browser-callback"];
5
+ /** Scopes requested for Auth0 access tokens (OIDC + Hello CASL permissions). */
6
+ declare const POSTMAN_SCOPES: string;
7
+ export type PostmanOptions = {
8
+ postmanProvider?: "api" | "local" | "none";
9
+ apiKey?: string;
10
+ workspaceId?: string;
11
+ };
12
+ /** Build Postman collection: OpenAPI routes + Auth0 auth overlay. */
13
+ export declare function buildHybridPostmanCollection(projectName: string, auth?: Auth0Env): Promise<import("../postman/openapi-to-postman.js").PostmanCollection>;
14
+ export declare const PostmanFeature: Feature<PostmanOptions>;
15
+ export { buildHelloOpenApiDocument } from "../postman/hello-openapi.js";
16
+ export { POSTMAN_CALLBACKS, POSTMAN_SCOPES };
@@ -0,0 +1,18 @@
1
+ import type { KeyedModel, SourceFile } from "../../models/source-file.js";
2
+ /**
3
+ * Builder for `projects/<api>/package.json`.
4
+ *
5
+ * Starts with the core cortex + crucible deps. Features can call
6
+ * `addDependency` / `addDevDependency` to extend.
7
+ */
8
+ export declare class ApiPackageJson implements KeyedModel {
9
+ private readonly workspaceName;
10
+ private readonly apiName;
11
+ readonly key: string;
12
+ private readonly _dependencies;
13
+ private readonly _devDependencies;
14
+ constructor(workspaceName: string, apiName?: string);
15
+ addDependency(name: string, version: string): this;
16
+ addDevDependency(name: string, version: string): this;
17
+ files(): SourceFile[];
18
+ }
@@ -0,0 +1,26 @@
1
+ import type { KeyedModel, SourceFile } from "../../models/source-file.js";
2
+ export type AdminUserConfig = {
3
+ sub: string;
4
+ email: string;
5
+ password: string;
6
+ username: string;
7
+ };
8
+ export type AuthConfig = {
9
+ issuerBaseUrl: string;
10
+ audience: string;
11
+ adminUser?: AdminUserConfig;
12
+ };
13
+ /**
14
+ * Data-carrier model for auth configuration.
15
+ *
16
+ * Registered by AuthFeature when auth0 is configured. Other features (e.g.
17
+ * PostmanFeature) retrieve it via workspace.getModel(WELL_KNOWN_FILES.AUTH_CONFIG).
18
+ * Produces no files — exists solely so features can communicate auth details.
19
+ */
20
+ export declare class AuthConfigModel implements KeyedModel {
21
+ readonly config: AuthConfig;
22
+ readonly key: string;
23
+ constructor(config: AuthConfig);
24
+ setAdminUser(adminUser: AdminUserConfig): void;
25
+ files(): SourceFile[];
26
+ }
@@ -0,0 +1,46 @@
1
+ import type { KeyedModel, SourceFile } from "../../models/source-file.js";
2
+ /**
3
+ * A controller method. Features call `addDecorator()` to prepend decorators
4
+ * before the HTTP verb decorator (e.g. `@AllowAnonymous` before `@Get()`).
5
+ */
6
+ export declare class ControllerMethod {
7
+ readonly name: string;
8
+ private readonly _httpDecorator;
9
+ private readonly _params;
10
+ private readonly _extraDecorators;
11
+ private _body;
12
+ private _isAsync;
13
+ constructor(name: string, _httpDecorator: string, _params: string, isAsync: boolean, body: string[]);
14
+ addDecorator(decorator: string): this;
15
+ /** Replace the method body lines (used by features that extend generated behaviour). */
16
+ setBody(body: string[]): this;
17
+ setAsync(isAsync?: boolean): this;
18
+ render(): string[];
19
+ }
20
+ /**
21
+ * Model for `projects/api/src/controllers/hello.controller.ts`.
22
+ *
23
+ * Pre-initialised with all routes and their HTTP decorators. Features mutate
24
+ * the model via `getMethod(name).addDecorator(...)`, `addDecorator(...)` (class
25
+ * level), `addCortexImport(...)`, `addImport(...)`, and `addConstructorParam(...)`.
26
+ */
27
+ export declare class ControllerSourceFile implements KeyedModel {
28
+ readonly key: string;
29
+ private readonly _cortexImports;
30
+ private readonly _extraImportGroups;
31
+ private readonly _classDecorators;
32
+ /** Explicit @inject — design:paramtypes can collapse to Object under SWC when the class is still undefined at decorate time. */
33
+ private readonly _ctorParams;
34
+ private readonly _methods;
35
+ /** Retrieve a method by name to mutate its decorators. */
36
+ getMethod(name: string): ControllerMethod;
37
+ /** Add a class-level decorator (e.g. `@Authorize`). */
38
+ addDecorator(decorator: string): this;
39
+ /** Add a named import from `@decohere/cortex`. */
40
+ addCortexImport(name: string, typeOnly?: boolean): this;
41
+ /** Add a named import from any other module. */
42
+ addImport(name: string, from: string, typeOnly?: boolean): this;
43
+ /** Add a constructor parameter (e.g. an injected dependency). */
44
+ addConstructorParam(param: string): this;
45
+ files(): SourceFile[];
46
+ }
@@ -0,0 +1,9 @@
1
+ import type { KeyedModel, SourceFile } from "../../models/source-file.js";
2
+ /**
3
+ * Minimal GitHub Actions for scaffolded apps: lint ∥ test, build gate on default branch,
4
+ * npm publish after CI (skips private packages). No default forge docker --push.
5
+ */
6
+ export declare class GithubCiWorkflows implements KeyedModel {
7
+ readonly key: string;
8
+ files(): SourceFile[];
9
+ }
@@ -0,0 +1,54 @@
1
+ import type { KeyedModel, SourceFile } from "../../models/source-file.js";
2
+ export type TypeOrmImport = {
3
+ className: string;
4
+ importPath: string;
5
+ };
6
+ export type ServiceImport = TypeOrmImport & {
7
+ scope?: "singleton" | "request";
8
+ };
9
+ /**
10
+ * Model for `projects/api/src/main.ts`.
11
+ *
12
+ * Starts with the minimal HTTP + YAML config setup. Features mutate the model
13
+ * by calling addSideEffectImport / addImport / addBuilderCall / addEntity /
14
+ * addRepository. files() renders whatever has been accumulated.
15
+ */
16
+ export declare class MainSourceFile implements KeyedModel {
17
+ private readonly appName;
18
+ readonly key: string;
19
+ private readonly _sideEffectImports;
20
+ private readonly _extraImports;
21
+ private readonly _builderCalls;
22
+ private readonly _entities;
23
+ private readonly _repositories;
24
+ private readonly _services;
25
+ private _dataSourceName;
26
+ private _typeOrmSeed;
27
+ constructor(appName: string);
28
+ /** Adds a bare side-effect import, e.g. `@decohere/cortex/auth`. */
29
+ addSideEffectImport(path: string): this;
30
+ /** Adds a named import, e.g. `import { Foo } from "bar"`. */
31
+ addImport(name: string, from: string, typeOnly?: boolean): this;
32
+ /**
33
+ * Adds a builder call inserted after `.withConfiguration()` and before
34
+ * `.withServices()`. Pass the call without leading dot, e.g. `.withAuth()`.
35
+ */
36
+ addBuilderCall(call: string): this;
37
+ /** Adds a TypeORM entity — import and entry in `withTypeOrm({ entities })`. */
38
+ addEntity(entity: TypeOrmImport): this;
39
+ /** Adds a TypeORM repository — import and entry in `withTypeOrm({ repositories })`. */
40
+ addRepository(repo: TypeOrmImport): this;
41
+ /** Adds a service registered in `.withServices()`. */
42
+ addService(service: ServiceImport): this;
43
+ /**
44
+ * Datasource name passed to `withTypeOrm({ name })`. Must match
45
+ * `database.dataSources[].name` in config.yaml.
46
+ */
47
+ setDataSourceName(name: string): this;
48
+ /**
49
+ * Inline seed callback body for `withTypeOrm({ seed })`.
50
+ * Receives `dataSource` in scope. Example: `await dataSource.getRepository(User).save(...)`.
51
+ */
52
+ setTypeOrmSeed(seedBody: string): this;
53
+ files(): SourceFile[];
54
+ }
@@ -0,0 +1,23 @@
1
+ import type { KeyedModel, SourceFile } from "../../models/source-file.js";
2
+ export type ProductionDockerfileOptions = {
3
+ /** When true, only write `Dockerfile.<name>` (existing workspace — do not replace root Dockerfile). */
4
+ namedOnly?: boolean;
5
+ };
6
+ /**
7
+ * Production Dockerfiles for PaaS (Railway/Fly) and local `docker build`.
8
+ *
9
+ * Context is always the **repo root** (`docker build -f Dockerfile.billing .`).
10
+ * Root `Dockerfile` is the first API (`pnpm start`). Extra or custom-named APIs
11
+ * also get `Dockerfile.<name>` so each service can be deployed on its own.
12
+ *
13
+ * Runtime `node_modules` come from a **prod-deps** stage (`pnpm install --prod`),
14
+ * not the full build install (Forge, TypeScript, Biome, Vitest).
15
+ */
16
+ export declare class WebapiProductionDockerfile implements KeyedModel {
17
+ private readonly apiNames;
18
+ private readonly options;
19
+ readonly key: string;
20
+ constructor(apiNames?: readonly string[], options?: ProductionDockerfileOptions);
21
+ files(): SourceFile[];
22
+ }
23
+ export declare function renderProductionDockerfile(apiName: string, startScript: string): string;
@@ -0,0 +1,7 @@
1
+ import type { SourceFile, SourceFileProvider } from "../../models/source-file.js";
2
+ export declare class SampleConfigModel implements SourceFileProvider {
3
+ files(): SourceFile[];
4
+ }
5
+ export declare class SampleServiceModel implements SourceFileProvider {
6
+ files(): SourceFile[];
7
+ }
@@ -0,0 +1,12 @@
1
+ import { DockerfileModel } from "../../models/docker-image.model.js";
2
+ /**
3
+ * Scaffolded app `.devcontainer/Dockerfile` — thin `FROM` the published base image.
4
+ * Optional feature layers (e.g. postgresql-client) append via `addLayer`.
5
+ */
6
+ export declare class WebapiDevContainer extends DockerfileModel {
7
+ constructor(baseImage?: string);
8
+ files(): {
9
+ filePath: string;
10
+ content: string;
11
+ }[];
12
+ }
@@ -0,0 +1,19 @@
1
+ /** Minimal OpenAPI 3 document shape used for Postman conversion. */
2
+ export type ScaffoldOpenApiDocument = {
3
+ openapi: "3.0.3";
4
+ info: {
5
+ title: string;
6
+ version: string;
7
+ description?: string;
8
+ };
9
+ servers?: Array<{
10
+ url: string;
11
+ description?: string;
12
+ }>;
13
+ paths: Record<string, Record<string, unknown>>;
14
+ };
15
+ /**
16
+ * Canonical Hello WebAPI OpenAPI document used to generate Postman requests.
17
+ * Keep paths aligned with scaffolded HelloController (`/hello`, `/hello/{id}`).
18
+ */
19
+ export declare function buildHelloOpenApiDocument(projectName: string): ScaffoldOpenApiDocument;
@@ -0,0 +1,17 @@
1
+ import { type Auth0Env, type PostmanCollection } from "./openapi-to-postman.js";
2
+ /** Local View / Native Git environment (YAML). */
3
+ export declare function buildEnvironmentYaml(name: string, auth: Auth0Env | undefined, options: {
4
+ callbacks: readonly string[];
5
+ scopes: string;
6
+ }): string;
7
+ /**
8
+ * Build Postman Local View multi-file YAML from a v2.1 collection (routes)
9
+ * plus hand-authored Auth0 overlay.
10
+ */
11
+ export declare function buildLocalViewFilesFromCollection(collection: PostmanCollection, projectName: string, auth: Auth0Env | undefined, options: {
12
+ callbacks: readonly string[];
13
+ scopes: string;
14
+ }): Array<{
15
+ filePath: string;
16
+ content: string;
17
+ }>;
@@ -0,0 +1,62 @@
1
+ import type { ScaffoldOpenApiDocument } from "./hello-openapi.js";
2
+ export type PostmanCollection = {
3
+ info: {
4
+ _postman_id?: string;
5
+ name: string;
6
+ schema: string;
7
+ description?: string;
8
+ };
9
+ auth?: unknown;
10
+ item?: PostmanItem[];
11
+ variable?: Array<{
12
+ key: string;
13
+ value: string;
14
+ }>;
15
+ [key: string]: unknown;
16
+ };
17
+ export type PostmanItem = {
18
+ name?: string;
19
+ item?: PostmanItem[];
20
+ request?: PostmanRequest;
21
+ [key: string]: unknown;
22
+ };
23
+ export type PostmanRequest = {
24
+ method?: string;
25
+ header?: Array<{
26
+ key: string;
27
+ value: string;
28
+ }>;
29
+ body?: {
30
+ mode?: string;
31
+ raw?: string;
32
+ };
33
+ url?: string | {
34
+ raw?: string;
35
+ host?: string[];
36
+ path?: string[];
37
+ variable?: unknown[];
38
+ };
39
+ auth?: {
40
+ type: string;
41
+ [key: string]: unknown;
42
+ };
43
+ [key: string]: unknown;
44
+ };
45
+ export type Auth0Env = {
46
+ auth0Domain?: string;
47
+ auth0Audience?: string;
48
+ auth0ClientId?: string;
49
+ };
50
+ /** Convert an OpenAPI document to a Postman Collection v2.1 via openapi-to-postmanv2. */
51
+ export declare function openApiToPostmanCollection(document: ScaffoldOpenApiDocument): Promise<PostmanCollection>;
52
+ /**
53
+ * Overlay Auth0 OAuth2 (PKCE) collection auth and fix Local View-friendly URLs.
54
+ * Route items come from OpenAPI; auth/env remain hand-authored.
55
+ */
56
+ export declare function applyPostmanAuthOverlay(collection: PostmanCollection, projectName: string, auth: Auth0Env | undefined, options: {
57
+ callbacks: readonly string[];
58
+ scopes: string;
59
+ description: string;
60
+ }): PostmanCollection;
61
+ /** OpenAPI `{id}` → Postman `:id`, without touching `{{variables}}`. */
62
+ export declare function openApiPathParamsToColon(url: string): string;
@@ -0,0 +1,18 @@
1
+ import type { WorkspaceScaffold } from "../models/project.model.js";
2
+ export type WorkspaceReadmeOptions = {
3
+ add?: boolean;
4
+ databaseProvider?: "none" | "postgres/typeorm";
5
+ authProvider?: "auth0" | "none";
6
+ postmanProvider?: "api" | "local" | "none";
7
+ };
8
+ export type WorkspaceReadmeInput = {
9
+ projectName: string;
10
+ apiNames: readonly string[];
11
+ hasPostgres: boolean;
12
+ hasAuth0: boolean;
13
+ hasPostman: boolean;
14
+ };
15
+ /** Pure renderer — keep feature sections short and copy-paste ready. */
16
+ export declare function renderWorkspaceReadme(input: WorkspaceReadmeInput): string;
17
+ export declare function resolveWorkspaceReadmeInput(workspace: WorkspaceScaffold, options: WorkspaceReadmeOptions): WorkspaceReadmeInput;
18
+ export declare function writeWorkspaceReadme(workspace: WorkspaceScaffold, options: WorkspaceReadmeOptions): void;
@@ -0,0 +1,14 @@
1
+ import { type Action, ActionResponse } from "@decohere/nexus/cli";
2
+ export type WebapiOptions = {
3
+ directory?: string;
4
+ d?: string;
5
+ name?: string | string[];
6
+ database?: string;
7
+ auth?: string;
8
+ postman?: string;
9
+ yes?: boolean;
10
+ install?: string;
11
+ };
12
+ export declare class WebapiAction implements Action<WebapiOptions> {
13
+ run(options: WebapiOptions): Promise<ActionResponse>;
14
+ }
@@ -0,0 +1,11 @@
1
+ import { DecohereCommand } from "@decohere/nexus/cli";
2
+ import { WebapiAction } from "./webapi.action.js";
3
+ export declare class WebapiCommand extends DecohereCommand {
4
+ get actions(): (typeof WebapiAction)[];
5
+ constructor(name: string);
6
+ /**
7
+ * Commander passes positional args before options when `[directory]` is declared.
8
+ * ModuleFactory expects `(opts, cmd)` — stash the directory on the command.
9
+ */
10
+ action(fn: (...args: unknown[]) => void | Promise<void>): this;
11
+ }
@@ -1,25 +0,0 @@
1
- import { injectable } from "@decohere/crucible/decorators";
2
- import { type Action, ActionResponse } from "@decohere/nexus/cli";
3
- import { runScaffoldApi, toApiOptions } from "./webapi/cli-options.js";
4
-
5
- export type AddApiOptions = {
6
- apiName?: string;
7
- d?: string;
8
- database?: string;
9
- auth?: string;
10
- postman?: string;
11
- yes?: boolean;
12
- install?: string;
13
- };
14
-
15
- @injectable()
16
- export class AddApiAction implements Action<AddApiOptions> {
17
- public async run(options: AddApiOptions): Promise<ActionResponse> {
18
- const name = options.apiName;
19
- if (name == null || name === "") {
20
- return ActionResponse.Error("api", "API name is required");
21
- }
22
- await runScaffoldApi(toApiOptions(undefined, options, { names: [name], add: true }));
23
- return ActionResponse.Success("api");
24
- }
25
- }
@@ -1,31 +0,0 @@
1
- import { DecohereCommand } from "@decohere/nexus/cli";
2
- import type { OptionValues } from "commander";
3
- import { AddApiAction } from "./add-api.action.js";
4
- import { addWebapiFeatureOptions } from "./webapi/cli-options.js";
5
-
6
- export class AddApiCommand extends DecohereCommand {
7
- public override get actions() {
8
- return [AddApiAction];
9
- }
10
-
11
- public constructor(name: string) {
12
- super(name);
13
- this.description("Add an API to an existing Decohere workspace");
14
- this.argument("<name>", "API name under projects/");
15
- this.option("-d <directory>", "Workspace directory (default: current directory)", ".");
16
- addWebapiFeatureOptions(this);
17
- }
18
-
19
- public override action(fn: (...args: unknown[]) => void | Promise<void>): this {
20
- return super.action((...args: unknown[]) => {
21
- const cmd = args.at(-1) as DecohereCommand;
22
- const first = args[0];
23
- const hasPositional = typeof first === "string" || first === undefined;
24
- const opts = hasPositional ? (args[1] as OptionValues) : (args[0] as OptionValues);
25
- if (typeof first === "string" && first !== "") {
26
- cmd.setOptionValue("apiName", first);
27
- }
28
- return fn(opts, cmd);
29
- });
30
- }
31
- }