@nocobase/cli 2.1.0-beta.14 → 2.1.0-beta.16

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 (132) hide show
  1. package/LICENSE.txt +107 -0
  2. package/README.md +307 -63
  3. package/README.zh-CN.md +332 -0
  4. package/bin/run.cmd +3 -0
  5. package/bin/run.js +114 -0
  6. package/dist/commands/api/resource/create.js +15 -0
  7. package/dist/commands/api/resource/destroy.js +15 -0
  8. package/dist/commands/api/resource/get.js +15 -0
  9. package/dist/commands/api/resource/index.js +20 -0
  10. package/dist/commands/api/resource/list.js +16 -0
  11. package/dist/commands/api/resource/query.js +15 -0
  12. package/dist/commands/api/resource/update.js +15 -0
  13. package/dist/commands/build.js +57 -0
  14. package/dist/commands/db/logs.js +85 -0
  15. package/dist/commands/db/ps.js +60 -0
  16. package/dist/commands/db/shared.js +81 -0
  17. package/dist/commands/db/start.js +70 -0
  18. package/dist/commands/db/stop.js +70 -0
  19. package/dist/commands/dev.js +149 -0
  20. package/dist/commands/down.js +193 -0
  21. package/dist/commands/download.js +743 -0
  22. package/dist/commands/env/add.js +327 -0
  23. package/dist/commands/env/auth.js +62 -0
  24. package/dist/commands/env/list.js +41 -0
  25. package/dist/commands/env/remove.js +65 -0
  26. package/dist/commands/env/update.js +73 -0
  27. package/dist/commands/env/use.js +36 -0
  28. package/dist/commands/init.js +806 -0
  29. package/dist/commands/install.js +1840 -0
  30. package/dist/commands/logs.js +90 -0
  31. package/dist/commands/pm/disable.js +63 -0
  32. package/dist/commands/pm/enable.js +63 -0
  33. package/dist/commands/pm/list.js +54 -0
  34. package/dist/commands/prompts-stages.js +150 -0
  35. package/dist/commands/prompts-test.js +181 -0
  36. package/dist/commands/ps.js +116 -0
  37. package/dist/commands/scaffold/migration.js +38 -0
  38. package/dist/commands/scaffold/plugin.js +37 -0
  39. package/dist/commands/start.js +211 -0
  40. package/dist/commands/stop.js +90 -0
  41. package/dist/commands/upgrade.js +583 -0
  42. package/dist/generated/command-registry.js +133 -0
  43. package/dist/help/runtime-help.js +20 -0
  44. package/dist/lib/api-client.js +243 -0
  45. package/dist/lib/app-runtime.js +142 -0
  46. package/dist/lib/auth-store.js +241 -0
  47. package/dist/lib/bootstrap.js +387 -0
  48. package/dist/lib/build-config.js +10 -0
  49. package/dist/lib/cli-home.js +30 -0
  50. package/dist/lib/cli-locale.js +115 -0
  51. package/dist/lib/command-discovery.js +39 -0
  52. package/dist/lib/env-auth.js +872 -0
  53. package/dist/lib/generated-command.js +142 -0
  54. package/dist/lib/naming.js +70 -0
  55. package/dist/lib/openapi.js +62 -0
  56. package/dist/lib/post-processors.js +23 -0
  57. package/dist/lib/prompt-catalog.js +574 -0
  58. package/dist/lib/prompt-validators.js +185 -0
  59. package/dist/lib/prompt-web-ui.js +2061 -0
  60. package/dist/lib/resource-command.js +335 -0
  61. package/dist/lib/resource-request.js +104 -0
  62. package/dist/lib/run-npm.js +123 -0
  63. package/dist/lib/runtime-generator.js +419 -0
  64. package/dist/lib/runtime-store.js +56 -0
  65. package/dist/lib/ui.js +175 -0
  66. package/dist/locale/en-US.json +282 -0
  67. package/dist/locale/zh-CN.json +282 -0
  68. package/dist/post-processors/data-modeling.js +66 -0
  69. package/dist/post-processors/data-source-manager.js +114 -0
  70. package/dist/post-processors/index.js +19 -0
  71. package/nocobase-ctl.config.json +287 -0
  72. package/package.json +52 -25
  73. package/LICENSE +0 -201
  74. package/bin/index.js +0 -39
  75. package/nocobase.conf.tpl +0 -95
  76. package/src/cli.js +0 -19
  77. package/src/commands/benchmark.js +0 -73
  78. package/src/commands/build.js +0 -49
  79. package/src/commands/clean.js +0 -30
  80. package/src/commands/client.js +0 -166
  81. package/src/commands/create-nginx-conf.js +0 -37
  82. package/src/commands/create-plugin.js +0 -33
  83. package/src/commands/dev.js +0 -200
  84. package/src/commands/doc.js +0 -76
  85. package/src/commands/e2e.js +0 -265
  86. package/src/commands/global.js +0 -43
  87. package/src/commands/index.js +0 -45
  88. package/src/commands/instance-id.js +0 -47
  89. package/src/commands/locale/cronstrue.js +0 -122
  90. package/src/commands/locale/react-js-cron/en-US.json +0 -75
  91. package/src/commands/locale/react-js-cron/index.js +0 -17
  92. package/src/commands/locale/react-js-cron/zh-CN.json +0 -33
  93. package/src/commands/locale/react-js-cron/zh-TW.json +0 -33
  94. package/src/commands/locale.js +0 -81
  95. package/src/commands/p-test.js +0 -88
  96. package/src/commands/perf.js +0 -63
  97. package/src/commands/pkg.js +0 -321
  98. package/src/commands/pm2.js +0 -37
  99. package/src/commands/postinstall.js +0 -88
  100. package/src/commands/start.js +0 -148
  101. package/src/commands/tar.js +0 -36
  102. package/src/commands/test-coverage.js +0 -55
  103. package/src/commands/test.js +0 -107
  104. package/src/commands/umi.js +0 -33
  105. package/src/commands/update-deps.js +0 -72
  106. package/src/commands/upgrade.js +0 -47
  107. package/src/commands/view-license-key.js +0 -44
  108. package/src/index.js +0 -14
  109. package/src/license.js +0 -76
  110. package/src/logger.js +0 -75
  111. package/src/plugin-generator.js +0 -80
  112. package/src/util.js +0 -517
  113. package/templates/bundle-status.html +0 -338
  114. package/templates/create-app-package.json +0 -39
  115. package/templates/plugin/.npmignore.tpl +0 -2
  116. package/templates/plugin/README.md.tpl +0 -1
  117. package/templates/plugin/client.d.ts +0 -2
  118. package/templates/plugin/client.js +0 -1
  119. package/templates/plugin/package.json.tpl +0 -11
  120. package/templates/plugin/server.d.ts +0 -2
  121. package/templates/plugin/server.js +0 -1
  122. package/templates/plugin/src/client/client.d.ts +0 -249
  123. package/templates/plugin/src/client/index.tsx.tpl +0 -1
  124. package/templates/plugin/src/client/locale.ts +0 -21
  125. package/templates/plugin/src/client/models/index.ts +0 -12
  126. package/templates/plugin/src/client/plugin.tsx.tpl +0 -10
  127. package/templates/plugin/src/index.ts +0 -2
  128. package/templates/plugin/src/locale/en-US.json +0 -1
  129. package/templates/plugin/src/locale/zh-CN.json +0 -1
  130. package/templates/plugin/src/server/collections/.gitkeep +0 -0
  131. package/templates/plugin/src/server/index.ts.tpl +0 -1
  132. package/templates/plugin/src/server/plugin.ts.tpl +0 -19
@@ -0,0 +1,1840 @@
1
+ /**
2
+ * This file is part of the NocoBase (R) project.
3
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
4
+ * Authors: NocoBase Team.
5
+ *
6
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
7
+ * For more information, please refer to: https://www.nocobase.com/agreement.
8
+ */
9
+ import { Command, Flags } from '@oclif/core';
10
+ import * as p from '@clack/prompts';
11
+ import _ from 'lodash';
12
+ import { spawn } from 'node:child_process';
13
+ import crypto from 'node:crypto';
14
+ import { mkdir } from 'node:fs/promises';
15
+ import path from 'node:path';
16
+ import { exit } from 'node:process';
17
+ import { runPromptCatalog, } from "../lib/prompt-catalog.js";
18
+ import { applyCliLocale, localeText, translateCli, } from "../lib/cli-locale.js";
19
+ import { findAvailableTcpPort, validateAvailableTcpPort, validateTcpPort, validateEnvKey, } from "../lib/prompt-validators.js";
20
+ import { formatMissingManagedAppEnvMessage } from '../lib/app-runtime.js';
21
+ import { run, runNocoBaseCommand } from '../lib/run-npm.js';
22
+ import { startTask, stopTask, updateTask } from '../lib/ui.js';
23
+ import { ensureWorkspaceName, getEnv } from '../lib/auth-store.js';
24
+ import Download, { defaultDockerRegistryForLang, } from './download.js';
25
+ import EnvAdd from "./env/add.js";
26
+ const DEFAULT_INSTALL_ENV_NAME = 'local';
27
+ const DEFAULT_INSTALL_LANG = 'en-US';
28
+ const DEFAULT_INSTALL_APP_PORT = '13000';
29
+ const DEFAULT_INSTALL_DB_HOST = '127.0.0.1';
30
+ const DEFAULT_INSTALL_BUILTIN_DB_HOST = 'postgres';
31
+ const DEFAULT_INSTALL_DB_PORTS = {
32
+ postgres: '5432',
33
+ mysql: '3306',
34
+ mariadb: '3306',
35
+ kingbase: '54321',
36
+ };
37
+ const DEFAULT_INSTALL_BUILTIN_DB_IMAGES = {
38
+ postgres: 'postgres:16',
39
+ mysql: 'mysql:8',
40
+ mariadb: 'mariadb:11',
41
+ kingbase: 'registry.cn-shanghai.aliyuncs.com/nocobase/kingbase:v009r001c001b0030_single_x86',
42
+ };
43
+ const DEFAULT_INSTALL_DB_DATABASE = 'nocobase';
44
+ const DEFAULT_INSTALL_DB_USER = 'nocobase';
45
+ const DEFAULT_INSTALL_DB_PASSWORD = 'nocobase';
46
+ const DEFAULT_INSTALL_ROOT_USERNAME = 'nocobase';
47
+ const DEFAULT_INSTALL_ROOT_EMAIL = 'admin@nocobase.com';
48
+ const DEFAULT_INSTALL_ROOT_PASSWORD = 'admin123';
49
+ const DEFAULT_INSTALL_ROOT_NICKNAME = 'Super Admin';
50
+ const CONFIG_SCOPE = 'project';
51
+ const APP_HEALTH_CHECK_INTERVAL_MS = 2_000;
52
+ const APP_HEALTH_CHECK_TIMEOUT_MS = 600_000;
53
+ const APP_HEALTH_CHECK_REQUEST_TIMEOUT_MS = 5_000;
54
+ const INSTALL_DB_DIALECTS = ['postgres', 'mysql', 'mariadb', 'kingbase'];
55
+ const INSTALL_LANGUAGE_CODES = {
56
+ 'ar-EG': { label: 'العربية' },
57
+ 'az-AZ': { label: 'Azərbaycan dili' },
58
+ 'bg-BG': { label: 'Български' },
59
+ 'bn-BD': { label: 'Bengali' },
60
+ 'by-BY': { label: 'Беларускі' },
61
+ 'ca-ES': { label: 'Сatalà/Espanya' },
62
+ 'cs-CZ': { label: 'Česky' },
63
+ 'da-DK': { label: 'Dansk' },
64
+ 'de-DE': { label: 'Deutsch' },
65
+ 'el-GR': { label: 'Ελληνικά' },
66
+ 'en-GB': { label: 'English(GB)' },
67
+ 'en-US': { label: 'English' },
68
+ 'es-ES': { label: 'Español' },
69
+ 'et-EE': { label: 'Estonian (Eesti)' },
70
+ 'fa-IR': { label: 'فارسی' },
71
+ 'fi-FI': { label: 'Suomi' },
72
+ 'fr-BE': { label: 'Français(BE)' },
73
+ 'fr-CA': { label: 'Français(CA)' },
74
+ 'fr-FR': { label: 'Français' },
75
+ 'ga-IE': { label: 'Gaeilge' },
76
+ 'gl-ES': { label: 'Galego' },
77
+ 'he-IL': { label: 'עברית' },
78
+ 'hi-IN': { label: 'हिन्दी' },
79
+ 'hr-HR': { label: 'Hrvatski jezik' },
80
+ 'hu-HU': { label: 'Magyar' },
81
+ 'hy-AM': { label: 'Հայերեն' },
82
+ 'id-ID': { label: 'Bahasa Indonesia' },
83
+ 'is-IS': { label: 'Íslenska' },
84
+ 'it-IT': { label: 'Italiano' },
85
+ 'ja-JP': { label: '日本語' },
86
+ 'ka-GE': { label: 'ქართული' },
87
+ 'kk-KZ': { label: 'Қазақ тілі' },
88
+ 'km-KH': { label: 'ភាសាខ្មែរ' },
89
+ 'kn-IN': { label: 'ಕನ್ನಡ' },
90
+ 'ko-KR': { label: '한국어' },
91
+ 'ku-IQ': { label: 'کوردی' },
92
+ 'lt-LT': { label: 'lietuvių' },
93
+ 'lv-LV': { label: 'Latviešu valoda' },
94
+ 'mk-MK': { label: 'македонски јазик' },
95
+ 'ml-IN': { label: 'മലയാളം' },
96
+ 'mn-MN': { label: 'Монгол хэл' },
97
+ 'ms-MY': { label: 'بهاس ملايو' },
98
+ 'nb-NO': { label: 'Norsk bokmål' },
99
+ 'ne-NP': { label: 'नेपाली' },
100
+ 'nl-BE': { label: 'Vlaams' },
101
+ 'nl-NL': { label: 'Nederlands' },
102
+ 'pl-PL': { label: 'Polski' },
103
+ 'pt-BR': { label: 'Português brasileiro' },
104
+ 'pt-PT': { label: 'Português' },
105
+ 'ro-RO': { label: 'România' },
106
+ 'ru-RU': { label: 'Русский' },
107
+ 'si-LK': { label: 'සිංහල' },
108
+ 'sk-SK': { label: 'Slovenčina' },
109
+ 'sl-SI': { label: 'Slovenščina' },
110
+ 'sr-RS': { label: 'српски језик' },
111
+ 'sv-SE': { label: 'Svenska' },
112
+ 'ta-IN': { label: 'Tamil' },
113
+ 'th-TH': { label: 'ภาษาไทย' },
114
+ 'tk-TK': { label: 'Turkmen' },
115
+ 'tr-TR': { label: 'Türkçe' },
116
+ 'uk-UA': { label: 'Українська' },
117
+ 'ur-PK': { label: 'Oʻzbekcha' },
118
+ 'vi-VN': { label: 'Tiếng Việt' },
119
+ 'zh-CN': { label: '简体中文' },
120
+ 'zh-HK': { label: '繁體中文(香港)' },
121
+ 'zh-TW': { label: '繁體中文(台湾)' },
122
+ };
123
+ const INSTALL_LANGUAGE_OPTIONS = Object.entries(INSTALL_LANGUAGE_CODES).map(([value, { label }]) => ({
124
+ value,
125
+ label: `${label} (${value})`,
126
+ }));
127
+ const installText = (key, values) => localeText(`commands.install.${key}`, values);
128
+ function argvHasToken(argv, tokens) {
129
+ return tokens.some((t) => argv.includes(t));
130
+ }
131
+ function isInstallDbDialect(value) {
132
+ return INSTALL_DB_DIALECTS.includes(value);
133
+ }
134
+ function supportsBuiltinDbDialect(value) {
135
+ const dialect = String(value ?? '').trim();
136
+ return Object.prototype.hasOwnProperty.call(DEFAULT_INSTALL_BUILTIN_DB_IMAGES, dialect);
137
+ }
138
+ export function defaultDbPortForDialect(value) {
139
+ const dialect = String(value ?? 'postgres').trim();
140
+ return DEFAULT_INSTALL_DB_PORTS[isInstallDbDialect(dialect) ? dialect : 'postgres'];
141
+ }
142
+ function defaultBuiltinDbImageForDialect(value) {
143
+ const dialect = String(value ?? 'postgres').trim();
144
+ return supportsBuiltinDbDialect(dialect)
145
+ ? DEFAULT_INSTALL_BUILTIN_DB_IMAGES[dialect]
146
+ : DEFAULT_INSTALL_BUILTIN_DB_IMAGES.postgres;
147
+ }
148
+ function defaultDbDatabaseForDialect(value) {
149
+ return String(value ?? '').trim() === 'kingbase'
150
+ ? 'kingbase'
151
+ : DEFAULT_INSTALL_DB_DATABASE;
152
+ }
153
+ function defaultDbHostForBuiltinDb(values) {
154
+ return Boolean(values.builtinDb)
155
+ ? DEFAULT_INSTALL_BUILTIN_DB_HOST
156
+ : DEFAULT_INSTALL_DB_HOST;
157
+ }
158
+ function validateBuiltinDbEnabled(value, values) {
159
+ if (!Boolean(value)) {
160
+ return undefined;
161
+ }
162
+ const dialect = String(values.dbDialect ?? 'postgres').trim() || 'postgres';
163
+ if (supportsBuiltinDbDialect(dialect)) {
164
+ return undefined;
165
+ }
166
+ return translateCli('commands.install.validation.builtinDbUnsupported', { dialect });
167
+ }
168
+ function defaultInstallAppRootPath(envName) {
169
+ const name = String(envName ?? DEFAULT_INSTALL_ENV_NAME).trim() || DEFAULT_INSTALL_ENV_NAME;
170
+ return `./${name}/source/`;
171
+ }
172
+ function defaultInstallStoragePath(envName) {
173
+ const name = String(envName ?? DEFAULT_INSTALL_ENV_NAME).trim() || DEFAULT_INSTALL_ENV_NAME;
174
+ return `./${name}/storage/`;
175
+ }
176
+ function pickPresetKeys(source, keys) {
177
+ const out = {};
178
+ for (const k of keys) {
179
+ if (Object.prototype.hasOwnProperty.call(source, k)) {
180
+ out[k] = source[k];
181
+ }
182
+ }
183
+ return out;
184
+ }
185
+ async function commandSucceeds(command, args, options) {
186
+ return await new Promise((resolve) => {
187
+ const child = spawn(command, args, {
188
+ cwd: options?.cwd,
189
+ env: {
190
+ ...process.env,
191
+ ...options?.env,
192
+ },
193
+ stdio: 'ignore',
194
+ });
195
+ child.once('error', () => resolve(false));
196
+ child.once('close', (code) => resolve(code === 0));
197
+ });
198
+ }
199
+ async function commandOutput(command, args, options) {
200
+ return await new Promise((resolve, reject) => {
201
+ const child = spawn(command, args, {
202
+ cwd: options?.cwd,
203
+ env: {
204
+ ...process.env,
205
+ ...options?.env,
206
+ },
207
+ stdio: ['ignore', 'pipe', 'pipe'],
208
+ });
209
+ let stdout = '';
210
+ let stderr = '';
211
+ child.stdout.setEncoding('utf8');
212
+ child.stderr.setEncoding('utf8');
213
+ child.stdout.on('data', (chunk) => {
214
+ stdout += chunk;
215
+ });
216
+ child.stderr.on('data', (chunk) => {
217
+ stderr += chunk;
218
+ });
219
+ child.once('error', reject);
220
+ child.once('close', (code, signal) => {
221
+ if (code === 0) {
222
+ resolve(stdout);
223
+ return;
224
+ }
225
+ if (signal) {
226
+ reject(new Error(`${command} exited due to signal ${signal}`));
227
+ return;
228
+ }
229
+ reject(new Error(`${command} exited with code ${code}: ${stderr.trim()}`));
230
+ });
231
+ });
232
+ }
233
+ export default class Install extends Command {
234
+ static description = 'Install NocoBase: database, storage, admin user, and `nocobase-v1 install`. Optionally run `nb download` first; distribution and image details are configured on `nb download`, not here. Use `--resume` to continue an interrupted setup from the saved workspace env config.';
235
+ static examples = [
236
+ '<%= config.bin %> <%= command.id %>',
237
+ '<%= config.bin %> <%= command.id %> --env app1',
238
+ '<%= config.bin %> <%= command.id %> --env app1 --resume',
239
+ '<%= config.bin %> <%= command.id %> --env app1 -f',
240
+ '<%= config.bin %> <%= command.id %> --env app1 -l zh-CN',
241
+ '<%= config.bin %> <%= command.id %> --env app1 --root-username nocobase --root-email admin@nocobase.com --root-password admin123',
242
+ '<%= config.bin %> <%= command.id %> --env app1 --root-nickname "Super Admin"',
243
+ '<%= config.bin %> <%= command.id %> --env myenv --app-root-path=./myenv/source/ --storage-path=./myenv/storage/',
244
+ '<%= config.bin %> <%= command.id %> --env dev -y --app-root-path=./dev/source/',
245
+ '<%= config.bin %> <%= command.id %> --env dev -y --fetch-source --app-root-path=./dev/source/',
246
+ ];
247
+ static flags = {
248
+ yes: Flags.boolean({
249
+ char: 'y',
250
+ description: 'Skip interactive prompts; use flags and defaults only',
251
+ default: false,
252
+ }),
253
+ resume: Flags.boolean({
254
+ description: 'Resume a previous unfinished setup for this env using the saved workspace env config',
255
+ default: false,
256
+ }),
257
+ env: Flags.string({
258
+ char: 'e',
259
+ description: 'App/env name to create or update. Defaults app paths to ./<envName>/source/ and ./<envName>/storage/.',
260
+ }),
261
+ lang: Flags.string({ description: 'Language for the installed NocoBase app', char: 'l', required: false }),
262
+ force: Flags.boolean({
263
+ description: 'Reconfigure an existing env and replace conflicting runtime resources when needed',
264
+ char: 'f',
265
+ required: false,
266
+ }),
267
+ 'app-root-path': Flags.string({
268
+ description: 'Source directory for a local npm/git app (default: ./<envName>/source/)',
269
+ }),
270
+ 'app-port': Flags.string({
271
+ description: 'HTTP port for the local app (default: 13000, or an available port with --yes)',
272
+ }),
273
+ 'storage-path': Flags.string({
274
+ description: 'Storage directory for uploads and managed database data (default: ./<envName>/storage/)',
275
+ }),
276
+ 'root-username': Flags.string({
277
+ description: 'Initial admin username for the installed app',
278
+ required: false,
279
+ }),
280
+ 'root-email': Flags.string({
281
+ description: 'Initial admin email for the installed app',
282
+ required: false,
283
+ }),
284
+ 'root-password': Flags.string({
285
+ description: 'Initial admin password for the installed app',
286
+ required: false,
287
+ }),
288
+ 'root-nickname': Flags.string({
289
+ description: 'Initial admin display name for the installed app',
290
+ required: false,
291
+ }),
292
+ 'builtin-db': Flags.boolean({
293
+ description: 'Create and connect a CLI-managed built-in database for the app',
294
+ default: false,
295
+ }),
296
+ 'db-dialect': Flags.string({
297
+ description: 'Database dialect for the app',
298
+ options: ['postgres', 'mysql', 'mariadb', 'kingbase'],
299
+ }),
300
+ 'builtin-db-image': Flags.string({
301
+ description: 'Docker image for the built-in database container (default follows the selected database)',
302
+ }),
303
+ 'db-host': Flags.string({
304
+ description: 'Database host for the app',
305
+ }),
306
+ 'db-port': Flags.string({
307
+ description: 'Database port for the app',
308
+ }),
309
+ 'db-database': Flags.string({
310
+ description: 'Database name for the app',
311
+ }),
312
+ 'db-user': Flags.string({
313
+ description: 'Database username for the app',
314
+ }),
315
+ 'db-password': Flags.string({
316
+ description: 'Database password for the app',
317
+ }),
318
+ 'fetch-source': Flags.boolean({
319
+ description: 'Download NocoBase app files or pull a Docker image before installing',
320
+ default: false,
321
+ }),
322
+ ..._.omit(Download.flags, ['yes']),
323
+ };
324
+ /** Environment name only: run before {@link Install.prompts} (see `run`). */
325
+ static envPrompts = {
326
+ env: {
327
+ type: 'text',
328
+ message: installText('prompts.env.message'),
329
+ placeholder: installText('prompts.env.placeholder'),
330
+ required: true,
331
+ validate: validateEnvKey,
332
+ },
333
+ };
334
+ static appPrompts = {
335
+ lang: {
336
+ type: 'select',
337
+ message: installText('prompts.lang.message'),
338
+ options: INSTALL_LANGUAGE_OPTIONS,
339
+ initialValue: DEFAULT_INSTALL_LANG,
340
+ yesInitialValue: DEFAULT_INSTALL_LANG,
341
+ },
342
+ // force: {
343
+ // type: 'boolean',
344
+ // message: 'Reinstall the application by clearing the database? (-f / --force)',
345
+ // initialValue: false,
346
+ // yesInitialValue: false,
347
+ // },
348
+ appRootPath: {
349
+ type: 'text',
350
+ message: installText('prompts.appRootPath.message'),
351
+ placeholder: installText('prompts.appRootPath.placeholder'),
352
+ initialValue: (values) => defaultInstallAppRootPath(values.env ?? values.appName),
353
+ },
354
+ appPort: {
355
+ type: 'text',
356
+ message: installText('prompts.appPort.message'),
357
+ placeholder: installText('prompts.appPort.placeholder'),
358
+ validate: validateAvailableTcpPort,
359
+ },
360
+ storagePath: {
361
+ type: 'text',
362
+ message: installText('prompts.storagePath.message'),
363
+ placeholder: installText('prompts.storagePath.placeholder'),
364
+ initialValue: (values) => defaultInstallStoragePath(values.env ?? values.appName),
365
+ },
366
+ fetchSource: {
367
+ type: 'boolean',
368
+ message: installText('prompts.fetchSource.message'),
369
+ initialValue: true,
370
+ yesInitialValue: true,
371
+ },
372
+ };
373
+ static dbPrompts = {
374
+ dbDialect: {
375
+ type: 'select',
376
+ message: installText('prompts.dbDialect.message'),
377
+ options: [
378
+ { value: 'postgres', label: 'PostgreSQL' },
379
+ { value: 'mysql', label: 'MySQL' },
380
+ { value: 'mariadb', label: 'MariaDB' },
381
+ { value: 'kingbase', label: 'KingbaseES' },
382
+ ],
383
+ initialValue: 'postgres',
384
+ yesInitialValue: 'postgres',
385
+ required: true,
386
+ },
387
+ builtinDb: {
388
+ type: 'boolean',
389
+ message: installText('prompts.builtinDb.message'),
390
+ initialValue: true,
391
+ yesInitialValue: true,
392
+ validate: validateBuiltinDbEnabled,
393
+ },
394
+ builtinDbImage: {
395
+ type: 'text',
396
+ message: installText('prompts.builtinDbImage.message'),
397
+ placeholder: installText('prompts.builtinDbImage.placeholder'),
398
+ initialValue: (values) => defaultBuiltinDbImageForDialect(values.dbDialect),
399
+ hidden: (values) => !Boolean(values.builtinDb)
400
+ || !supportsBuiltinDbDialect(values.dbDialect),
401
+ required: true,
402
+ },
403
+ dbHost: {
404
+ type: 'text',
405
+ message: installText('prompts.dbHost.message'),
406
+ placeholder: installText('prompts.dbHost.placeholder'),
407
+ initialValue: (values) => defaultDbHostForBuiltinDb(values),
408
+ yesInitialValue: DEFAULT_INSTALL_BUILTIN_DB_HOST,
409
+ required: true,
410
+ hidden: (values) => Boolean(values.builtinDb),
411
+ },
412
+ dbPort: {
413
+ type: 'text',
414
+ message: installText('prompts.dbPort.message'),
415
+ placeholder: installText('prompts.dbPort.placeholder'),
416
+ initialValue: (values) => defaultDbPortForDialect(values.dbDialect),
417
+ required: true,
418
+ validate: validateTcpPort,
419
+ hidden: (values) => Boolean(values.builtinDb)
420
+ && String(values.source ?? '').trim() === 'docker',
421
+ },
422
+ dbDatabase: {
423
+ type: 'text',
424
+ message: installText('prompts.dbDatabase.message'),
425
+ initialValue: (values) => defaultDbDatabaseForDialect(values.dbDialect),
426
+ required: true,
427
+ },
428
+ dbUser: {
429
+ type: 'text',
430
+ message: installText('prompts.dbUser.message'),
431
+ initialValue: DEFAULT_INSTALL_DB_USER,
432
+ yesInitialValue: DEFAULT_INSTALL_DB_USER,
433
+ required: true,
434
+ },
435
+ dbPassword: {
436
+ type: 'password',
437
+ message: installText('prompts.dbPassword.message'),
438
+ initialValue: DEFAULT_INSTALL_DB_PASSWORD,
439
+ yesInitialValue: DEFAULT_INSTALL_DB_PASSWORD,
440
+ required: true,
441
+ },
442
+ };
443
+ static rootUserPrompts = {
444
+ rootUsername: {
445
+ type: 'text',
446
+ message: installText('prompts.rootUsername.message'),
447
+ placeholder: installText('prompts.rootUsername.placeholder'),
448
+ yesInitialValue: DEFAULT_INSTALL_ROOT_USERNAME,
449
+ required: true,
450
+ },
451
+ rootEmail: {
452
+ type: 'text',
453
+ message: installText('prompts.rootEmail.message'),
454
+ placeholder: installText('prompts.rootEmail.placeholder'),
455
+ yesInitialValue: DEFAULT_INSTALL_ROOT_EMAIL,
456
+ required: true,
457
+ },
458
+ rootPassword: {
459
+ type: 'password',
460
+ message: installText('prompts.rootPassword.message'),
461
+ yesInitialValue: DEFAULT_INSTALL_ROOT_PASSWORD,
462
+ required: true,
463
+ },
464
+ rootNickname: {
465
+ type: 'text',
466
+ message: installText('prompts.rootNickname.message'),
467
+ placeholder: installText('prompts.rootNickname.placeholder'),
468
+ yesInitialValue: DEFAULT_INSTALL_ROOT_NICKNAME,
469
+ required: true,
470
+ },
471
+ };
472
+ /**
473
+ * App catalog with `env` seeded into `out` first so `storagePath`’s `initialValue(values)`
474
+ * sees `values.env` (same iteration order as {@link runPromptCatalog}).
475
+ */
476
+ static buildAppPromptsCatalog(seedEnv) {
477
+ return {
478
+ seedEnv: {
479
+ type: 'run',
480
+ run: (values) => {
481
+ values.env = seedEnv;
482
+ },
483
+ },
484
+ ...Install.appPrompts,
485
+ };
486
+ }
487
+ static buildDbPromptsCatalog(downloadResults) {
488
+ const source = String(downloadResults.source ?? '').trim();
489
+ return {
490
+ seedDownloadSource: {
491
+ type: 'run',
492
+ run: (values) => {
493
+ if (source) {
494
+ values.source = source;
495
+ }
496
+ },
497
+ },
498
+ ...Install.dbPrompts,
499
+ };
500
+ }
501
+ /** Preset for {@link Install.envPrompts} only (`env` flag). */
502
+ static buildEnvPresetValuesFromFlags(flags) {
503
+ const preset = {};
504
+ if (flags.env !== undefined && String(flags.env).trim() !== '') {
505
+ preset.env = String(flags.env).trim();
506
+ }
507
+ return preset;
508
+ }
509
+ /**
510
+ * Preset `values` for `runPromptCatalog`: keys here skip that prompt and fix the result.
511
+ * Booleans with defaults are only preset when the user passed the flag on argv (see `download`).
512
+ * Does not include `env` — use {@link buildEnvPresetValuesFromFlags} for {@link Install.envPrompts}.
513
+ */
514
+ static buildPresetValuesFromFlags(flags) {
515
+ const preset = {};
516
+ const argv = process.argv.slice(2);
517
+ if (flags.lang !== undefined) {
518
+ const v = String(flags.lang).trim();
519
+ if (v) {
520
+ preset.lang = v;
521
+ }
522
+ }
523
+ if (argvHasToken(argv, ['--force', '-f'])) {
524
+ preset.force = flags.force;
525
+ }
526
+ if (flags['app-root-path'] !== undefined) {
527
+ const v = flags['app-root-path']?.trim();
528
+ if (v) {
529
+ preset.appRootPath = v;
530
+ }
531
+ }
532
+ if (flags['app-port'] !== undefined) {
533
+ const v = String(flags['app-port'] ?? '').trim();
534
+ if (v) {
535
+ preset.appPort = v;
536
+ }
537
+ }
538
+ if (flags['storage-path'] !== undefined) {
539
+ const v = flags['storage-path']?.trim();
540
+ if (v) {
541
+ preset.storagePath = v;
542
+ }
543
+ }
544
+ if (flags['root-username'] !== undefined) {
545
+ preset.rootUsername = String(flags['root-username'] ?? '').trim();
546
+ }
547
+ if (flags['root-email'] !== undefined) {
548
+ preset.rootEmail = String(flags['root-email'] ?? '').trim();
549
+ }
550
+ if (flags['root-password'] !== undefined) {
551
+ preset.rootPassword = String(flags['root-password'] ?? '');
552
+ }
553
+ if (flags['root-nickname'] !== undefined) {
554
+ preset.rootNickname = String(flags['root-nickname'] ?? '').trim();
555
+ }
556
+ if (argvHasToken(argv, ['--fetch-source'])) {
557
+ preset.fetchSource = flags['fetch-source'];
558
+ }
559
+ if (argvHasToken(argv, ['--builtin-db'])) {
560
+ preset.builtinDb = flags['builtin-db'];
561
+ }
562
+ if (flags['db-dialect'] !== undefined) {
563
+ const t = String(flags['db-dialect']).trim();
564
+ if (t && isInstallDbDialect(t)) {
565
+ preset.dbDialect = t;
566
+ }
567
+ }
568
+ if (flags['builtin-db-image'] !== undefined) {
569
+ const v = String(flags['builtin-db-image'] ?? '').trim();
570
+ if (v) {
571
+ preset.builtinDbImage = v;
572
+ }
573
+ }
574
+ if (flags['db-host'] !== undefined) {
575
+ const v = String(flags['db-host'] ?? '').trim();
576
+ if (v) {
577
+ preset.dbHost = v;
578
+ }
579
+ }
580
+ if (flags['db-port'] !== undefined) {
581
+ const v = String(flags['db-port'] ?? '').trim();
582
+ if (v) {
583
+ preset.dbPort = v;
584
+ }
585
+ }
586
+ if (flags['db-database'] !== undefined) {
587
+ const v = String(flags['db-database'] ?? '').trim();
588
+ if (v) {
589
+ preset.dbDatabase = v;
590
+ }
591
+ }
592
+ if (flags['db-user'] !== undefined) {
593
+ const v = String(flags['db-user'] ?? '').trim();
594
+ if (v) {
595
+ preset.dbUser = v;
596
+ }
597
+ }
598
+ if (flags['db-password'] !== undefined) {
599
+ preset.dbPassword = String(flags['db-password'] ?? '');
600
+ }
601
+ return preset;
602
+ }
603
+ static buildAppPresetValuesFromFlags(flags) {
604
+ return pickPresetKeys(Install.buildPresetValuesFromFlags(flags), [
605
+ 'lang',
606
+ 'force',
607
+ 'appRootPath',
608
+ 'appPort',
609
+ 'storagePath',
610
+ 'fetchSource',
611
+ ]);
612
+ }
613
+ static buildDbPresetValuesFromFlags(flags) {
614
+ return pickPresetKeys(Install.buildPresetValuesFromFlags(flags), [
615
+ 'builtinDb',
616
+ 'dbDialect',
617
+ 'builtinDbImage',
618
+ 'dbHost',
619
+ 'dbPort',
620
+ 'dbDatabase',
621
+ 'dbUser',
622
+ 'dbPassword',
623
+ ]);
624
+ }
625
+ static buildRootPresetValuesFromFlags(flags) {
626
+ return pickPresetKeys(Install.buildPresetValuesFromFlags(flags), [
627
+ 'rootUsername',
628
+ 'rootEmail',
629
+ 'rootPassword',
630
+ 'rootNickname',
631
+ ]);
632
+ }
633
+ static toOptionalPromptString(value) {
634
+ if (value === undefined || value === null) {
635
+ return undefined;
636
+ }
637
+ const text = String(value).trim();
638
+ return text || undefined;
639
+ }
640
+ static buildResumePresetValues(env) {
641
+ const envName = String(env.name ?? '').trim();
642
+ const config = env.config ?? {};
643
+ const source = Install.toOptionalPromptString(config.source);
644
+ const appRootPath = Install.toOptionalPromptString(config.appRootPath);
645
+ const appPort = Install.toOptionalPromptString(config.appPort);
646
+ const storagePath = Install.toOptionalPromptString(config.storagePath);
647
+ const downloadVersion = Install.toOptionalPromptString(config.downloadVersion);
648
+ const dockerRegistry = Install.toOptionalPromptString(config.dockerRegistry);
649
+ const dockerPlatform = Install.toOptionalPromptString(config.dockerPlatform);
650
+ const gitUrl = Install.toOptionalPromptString(config.gitUrl);
651
+ const npmRegistry = Install.toOptionalPromptString(config.npmRegistry);
652
+ const dbDialect = Install.toOptionalPromptString(config.dbDialect);
653
+ const dbHost = Install.toOptionalPromptString(config.dbHost);
654
+ const dbPort = Install.toOptionalPromptString(config.dbPort);
655
+ const dbDatabase = Install.toOptionalPromptString(config.dbDatabase);
656
+ const dbUser = Install.toOptionalPromptString(config.dbUser);
657
+ const dbPassword = Install.toOptionalPromptString(config.dbPassword);
658
+ const builtinDbImage = Install.toOptionalPromptString(config.builtinDbImage);
659
+ const auth = config.auth;
660
+ const appPreset = {
661
+ ...(appRootPath ? { appRootPath } : {}),
662
+ ...(appPort ? { appPort } : {}),
663
+ ...(storagePath ? { storagePath } : {}),
664
+ ...(source
665
+ ? { fetchSource: true }
666
+ : appRootPath
667
+ ? { fetchSource: false }
668
+ : {}),
669
+ };
670
+ const downloadPreset = {
671
+ ...(source ? { source } : {}),
672
+ ...(downloadVersion ? { version: downloadVersion } : {}),
673
+ ...(dockerRegistry ? { dockerRegistry } : {}),
674
+ ...(dockerPlatform ? { dockerPlatform } : {}),
675
+ ...(gitUrl ? { gitUrl } : {}),
676
+ ...(npmRegistry ? { npmRegistry } : {}),
677
+ ...(typeof config.devDependencies === 'boolean'
678
+ ? { devDependencies: config.devDependencies }
679
+ : {}),
680
+ ...(typeof config.build === 'boolean' ? { build: config.build } : {}),
681
+ ...(typeof config.buildDts === 'boolean' ? { buildDts: config.buildDts } : {}),
682
+ };
683
+ const dbPreset = {
684
+ ...(typeof config.builtinDb === 'boolean' ? { builtinDb: config.builtinDb } : {}),
685
+ ...(dbDialect ? { dbDialect } : {}),
686
+ ...(builtinDbImage ? { builtinDbImage } : {}),
687
+ ...(dbHost ? { dbHost } : {}),
688
+ ...(dbPort ? { dbPort } : {}),
689
+ ...(dbDatabase ? { dbDatabase } : {}),
690
+ ...(dbUser ? { dbUser } : {}),
691
+ ...(dbPassword ? { dbPassword } : {}),
692
+ };
693
+ const envAddPreset = {};
694
+ if (auth?.type === 'token') {
695
+ envAddPreset.authType = 'token';
696
+ if (Install.toOptionalPromptString(auth.accessToken)) {
697
+ envAddPreset.accessToken = String(auth.accessToken);
698
+ }
699
+ }
700
+ else if (auth?.type === 'oauth') {
701
+ envAddPreset.authType = 'oauth';
702
+ }
703
+ return {
704
+ envPreset: {
705
+ ...(envName ? { env: envName } : {}),
706
+ },
707
+ appPreset,
708
+ downloadPreset,
709
+ dbPreset,
710
+ envAddPreset,
711
+ };
712
+ }
713
+ static buildResumeMissingYesFlags(flags) {
714
+ const missing = [];
715
+ if (!Install.toOptionalPromptString(flags.lang)) {
716
+ missing.push('--lang');
717
+ }
718
+ if (!Install.toOptionalPromptString(flags['root-username'])) {
719
+ missing.push('--root-username');
720
+ }
721
+ if (!Install.toOptionalPromptString(flags['root-email'])) {
722
+ missing.push('--root-email');
723
+ }
724
+ if (!Install.toOptionalPromptString(flags['root-password'])) {
725
+ missing.push('--root-password');
726
+ }
727
+ if (!Install.toOptionalPromptString(flags['root-nickname'])) {
728
+ missing.push('--root-nickname');
729
+ }
730
+ return missing;
731
+ }
732
+ async resolveResumePresetValues(parsed, yes) {
733
+ if (!parsed.resume) {
734
+ return undefined;
735
+ }
736
+ const env = await getEnv(parsed.env, { scope: CONFIG_SCOPE });
737
+ if (!env) {
738
+ throw new Error(formatMissingManagedAppEnvMessage(parsed.env));
739
+ }
740
+ if (yes) {
741
+ const missingFlags = Install.buildResumeMissingYesFlags(parsed);
742
+ if (missingFlags.length > 0) {
743
+ throw new Error([
744
+ `Cannot continue setup for "${env.name}" in non-interactive resume mode yet.`,
745
+ `These setup-only flags are not saved in the env config: ${missingFlags.join(', ')}`,
746
+ `Run \`nb install --env ${env.name} --resume\` without \`--yes\`, or pass those flags again.`,
747
+ ].join('\n'));
748
+ }
749
+ }
750
+ return Install.buildResumePresetValues(env);
751
+ }
752
+ static async resolveAvailableDefaultPort(defaultPort, options) {
753
+ const normalized = String(defaultPort).trim();
754
+ const portError = await validateAvailableTcpPort(normalized);
755
+ if (!portError) {
756
+ return normalized;
757
+ }
758
+ const nextPort = await findAvailableTcpPort();
759
+ if (options?.warn) {
760
+ p.log.warn(`${options.label ?? 'Default port'} ${normalized} is already in use. Using available port ${nextPort} for this setup.`);
761
+ }
762
+ return nextPort;
763
+ }
764
+ static async buildAppPromptInitialValues(params) {
765
+ const initialValues = {};
766
+ const envName = params.envName ?? DEFAULT_INSTALL_ENV_NAME;
767
+ if (params.flags['app-root-path'] === undefined) {
768
+ initialValues.appRootPath = defaultInstallAppRootPath(envName);
769
+ }
770
+ if (params.flags['storage-path'] === undefined) {
771
+ initialValues.storagePath = defaultInstallStoragePath(envName);
772
+ }
773
+ if (params.flags['app-port'] === undefined) {
774
+ initialValues.appPort = await Install.resolveAvailableDefaultPort(DEFAULT_INSTALL_APP_PORT, {
775
+ label: 'Default app port',
776
+ warn: params.warnOnPortFallback ?? true,
777
+ });
778
+ }
779
+ return initialValues;
780
+ }
781
+ static shouldPublishBuiltinDbPortForValues(values) {
782
+ const builtinDb = values.builtinDb === undefined ? true : Boolean(values.builtinDb);
783
+ return builtinDb
784
+ && Install.shouldPublishBuiltinDbPort(values.source);
785
+ }
786
+ static async buildDbPromptInitialValues(params) {
787
+ if (params.flags['db-port'] !== undefined) {
788
+ return {};
789
+ }
790
+ const values = {
791
+ ...params.downloadResults,
792
+ ...params.dbPreset,
793
+ };
794
+ if (!Install.shouldPublishBuiltinDbPortForValues(values)) {
795
+ return {};
796
+ }
797
+ const dialect = String(values.dbDialect ?? 'postgres').trim() || 'postgres';
798
+ const defaultPort = defaultDbPortForDialect(dialect);
799
+ return {
800
+ dbPort: await Install.resolveAvailableDefaultPort(defaultPort, {
801
+ label: `Default ${dialect} port`,
802
+ warn: params.warnOnPortFallback ?? true,
803
+ }),
804
+ };
805
+ }
806
+ /**
807
+ * When install runs {@link Download.prompts} after app prompts, align language and
808
+ * output directory defaults with the app settings collected earlier in the flow.
809
+ */
810
+ static buildDownloadPromptOptionsForInstall(appResults, envName) {
811
+ const appRoot = String(appResults.appRootPath ?? '').trim() || defaultInstallAppRootPath(envName);
812
+ const lang = String(appResults.lang ?? DEFAULT_INSTALL_LANG).trim() || DEFAULT_INSTALL_LANG;
813
+ const initialValues = {
814
+ lang,
815
+ dockerRegistry: defaultDockerRegistryForLang(lang),
816
+ outputDir: appRoot,
817
+ };
818
+ const values = {
819
+ lang,
820
+ };
821
+ return {
822
+ initialValues,
823
+ values,
824
+ yes: false,
825
+ hooks: {
826
+ onCancel: () => {
827
+ p.cancel('Download cancelled.');
828
+ exit(0);
829
+ },
830
+ onMissingNonInteractive: (message) => {
831
+ console.error(message);
832
+ exit(1);
833
+ },
834
+ },
835
+ };
836
+ }
837
+ /**
838
+ * Resolve the effective preset `values` for the embedded download step.
839
+ * Explicit download flags win; otherwise `-y` falls back to the docker + alpha quickstart path.
840
+ */
841
+ static buildDownloadPresetValuesForInstall(flags, appResults, envName, yes) {
842
+ const preset = {};
843
+ const argv = process.argv.slice(2);
844
+ const appRoot = String(appResults.appRootPath ?? '').trim() || defaultInstallAppRootPath(envName);
845
+ const lang = String(appResults.lang ?? DEFAULT_INSTALL_LANG).trim() || DEFAULT_INSTALL_LANG;
846
+ preset.lang = lang;
847
+ if (flags.source !== undefined && String(flags.source).trim() !== '') {
848
+ preset.source = String(flags.source).trim();
849
+ }
850
+ if (flags.version !== undefined) {
851
+ preset.version = String(flags.version).trim() || 'latest';
852
+ }
853
+ if (flags['docker-registry'] !== undefined) {
854
+ const value = String(flags['docker-registry'] ?? '').trim();
855
+ if (value) {
856
+ preset.dockerRegistry = value;
857
+ }
858
+ }
859
+ if (flags['docker-platform'] !== undefined) {
860
+ const value = String(flags['docker-platform'] ?? '').trim();
861
+ if (value) {
862
+ preset.dockerPlatform = value;
863
+ }
864
+ }
865
+ if (flags['output-dir'] !== undefined) {
866
+ const value = String(flags['output-dir'] ?? '').trim();
867
+ if (value) {
868
+ preset.outputDir = value;
869
+ }
870
+ }
871
+ if (flags['git-url'] !== undefined) {
872
+ const value = String(flags['git-url'] ?? '').trim();
873
+ if (value) {
874
+ preset.gitUrl = value;
875
+ }
876
+ }
877
+ if (flags['npm-registry'] !== undefined) {
878
+ preset.npmRegistry =
879
+ typeof flags['npm-registry'] === 'string' ? flags['npm-registry'] : '';
880
+ }
881
+ if (argvHasToken(argv, ['--replace', '-r'])) {
882
+ preset.replace = flags.replace;
883
+ }
884
+ if (argvHasToken(argv, ['--dev-dependencies', '--no-dev-dependencies', '-D'])) {
885
+ preset.devDependencies = flags['dev-dependencies'];
886
+ }
887
+ if (argvHasToken(argv, ['--docker-save', '--no-docker-save'])) {
888
+ preset.dockerSave = flags['docker-save'];
889
+ }
890
+ if (argvHasToken(argv, ['--build', '--no-build'])) {
891
+ preset.build = flags.build;
892
+ }
893
+ if (argvHasToken(argv, ['--build-dts', '--no-build-dts'])) {
894
+ preset.buildDts = flags['build-dts'];
895
+ }
896
+ if (yes) {
897
+ preset.source ??= 'docker';
898
+ preset.version ??= 'alpha';
899
+ preset.outputDir ??= appRoot;
900
+ }
901
+ return preset;
902
+ }
903
+ static sanitizeDockerResourceName(value) {
904
+ const normalized = value
905
+ .trim()
906
+ .toLowerCase()
907
+ .replace(/[^a-z0-9_.-]+/g, '-')
908
+ .replace(/-+/g, '-')
909
+ .replace(/^-+|-+$/g, '');
910
+ return normalized || 'nocobase';
911
+ }
912
+ static defaultWorkspaceName() {
913
+ return Install.sanitizeDockerResourceName(`nb-${path.basename(process.cwd())}`);
914
+ }
915
+ static buildBuiltinDbResourcePrefix(envName, workspaceName) {
916
+ void envName;
917
+ const storedName = String(workspaceName ?? '').trim();
918
+ return storedName
919
+ ? Install.sanitizeDockerResourceName(storedName)
920
+ : Install.defaultWorkspaceName();
921
+ }
922
+ static async ensureWorkspaceName() {
923
+ return await ensureWorkspaceName(Install.defaultWorkspaceName(), { scope: CONFIG_SCOPE });
924
+ }
925
+ static buildBuiltinDbNetworkName(envName, workspaceName) {
926
+ return Install.buildBuiltinDbResourcePrefix(envName, workspaceName);
927
+ }
928
+ static buildBuiltinDbContainerName(envName, dbDialect, workspaceName) {
929
+ return Install.sanitizeDockerResourceName(`${Install.buildBuiltinDbResourcePrefix(envName, workspaceName)}-${envName}-${dbDialect}`);
930
+ }
931
+ static buildDockerAppContainerName(envName, workspaceName) {
932
+ return Install.sanitizeDockerResourceName(`${Install.buildBuiltinDbResourcePrefix(envName, workspaceName)}-${envName}-app`);
933
+ }
934
+ static buildInitAppEnvVars(params) {
935
+ const out = {};
936
+ const put = (key, value) => {
937
+ const text = String(value ?? '').trim();
938
+ if (!text) {
939
+ return;
940
+ }
941
+ out[key] = text;
942
+ };
943
+ put('INIT_APP_LANG', params.appResults.lang);
944
+ put('INIT_ROOT_USERNAME', params.rootResults.rootUsername);
945
+ put('INIT_ROOT_EMAIL', params.rootResults.rootEmail);
946
+ put('INIT_ROOT_PASSWORD', params.rootResults.rootPassword);
947
+ put('INIT_ROOT_NICKNAME', params.rootResults.rootNickname);
948
+ return out;
949
+ }
950
+ static shouldPublishBuiltinDbPort(source) {
951
+ return String(source ?? '').trim() !== 'docker';
952
+ }
953
+ static buildBuiltinDbPlan(params) {
954
+ const dbDialect = String(params.dbDialect ?? 'postgres').trim() || 'postgres';
955
+ const dbPort = String(params.dbPort ?? defaultDbPortForDialect(dbDialect)).trim()
956
+ || defaultDbPortForDialect(dbDialect);
957
+ const defaultDbDatabase = defaultDbDatabaseForDialect(dbDialect);
958
+ const networkName = Install.buildBuiltinDbNetworkName(params.envName, params.workspaceName);
959
+ const containerName = Install.buildBuiltinDbContainerName(params.envName, dbDialect, params.workspaceName);
960
+ const dbHostInput = String(params.dbHost ?? '').trim();
961
+ const dbHost = Install.shouldPublishBuiltinDbPort(params.source)
962
+ ? (dbHostInput
963
+ && dbHostInput !== DEFAULT_INSTALL_BUILTIN_DB_HOST
964
+ && dbHostInput !== containerName
965
+ ? dbHostInput
966
+ : DEFAULT_INSTALL_DB_HOST)
967
+ : (dbHostInput
968
+ && dbHostInput !== DEFAULT_INSTALL_DB_HOST
969
+ && dbHostInput !== 'localhost'
970
+ ? dbHostInput
971
+ : containerName);
972
+ if (dbDialect === 'postgres') {
973
+ const image = String(params.builtinDbImage ?? '').trim() || DEFAULT_INSTALL_BUILTIN_DB_IMAGES.postgres;
974
+ const dataDir = path.resolve(params.storagePath, 'db', 'postgres');
975
+ const args = [
976
+ 'run',
977
+ '-d',
978
+ '--name',
979
+ containerName,
980
+ '--restart',
981
+ 'always',
982
+ '--network',
983
+ networkName,
984
+ '-e',
985
+ `POSTGRES_USER=${String(params.dbUser ?? DEFAULT_INSTALL_DB_USER).trim() || DEFAULT_INSTALL_DB_USER}`,
986
+ '-e',
987
+ `POSTGRES_DB=${String(params.dbDatabase ?? DEFAULT_INSTALL_DB_DATABASE).trim() || DEFAULT_INSTALL_DB_DATABASE}`,
988
+ '-e',
989
+ `POSTGRES_PASSWORD=${String(params.dbPassword ?? DEFAULT_INSTALL_DB_PASSWORD) || DEFAULT_INSTALL_DB_PASSWORD}`,
990
+ '-v',
991
+ `${dataDir}:/var/lib/postgresql/data`,
992
+ ];
993
+ if (Install.shouldPublishBuiltinDbPort(params.source)) {
994
+ args.push('-p', `${dbPort}:5432`);
995
+ }
996
+ args.push(image, 'postgres', '-c', 'wal_level=logical');
997
+ return {
998
+ source: String(params.source ?? '').trim() || undefined,
999
+ dbDialect,
1000
+ dbHost,
1001
+ dbPort,
1002
+ dbDatabase: String(params.dbDatabase ?? defaultDbDatabase).trim()
1003
+ || defaultDbDatabase,
1004
+ dbUser: String(params.dbUser ?? DEFAULT_INSTALL_DB_USER).trim()
1005
+ || DEFAULT_INSTALL_DB_USER,
1006
+ dbPassword: String(params.dbPassword ?? DEFAULT_INSTALL_DB_PASSWORD)
1007
+ || DEFAULT_INSTALL_DB_PASSWORD,
1008
+ networkName,
1009
+ containerName,
1010
+ dataDir,
1011
+ builtinDbImage: image,
1012
+ image,
1013
+ args,
1014
+ };
1015
+ }
1016
+ if (dbDialect === 'mysql') {
1017
+ const image = String(params.builtinDbImage ?? '').trim() || DEFAULT_INSTALL_BUILTIN_DB_IMAGES.mysql;
1018
+ const dataDir = path.resolve(params.storagePath, 'db', 'mysql');
1019
+ const dbUser = String(params.dbUser ?? DEFAULT_INSTALL_DB_USER).trim() || DEFAULT_INSTALL_DB_USER;
1020
+ const dbDatabase = String(params.dbDatabase ?? defaultDbDatabase).trim() || defaultDbDatabase;
1021
+ const dbPassword = String(params.dbPassword ?? DEFAULT_INSTALL_DB_PASSWORD) || DEFAULT_INSTALL_DB_PASSWORD;
1022
+ const args = [
1023
+ 'run',
1024
+ '-d',
1025
+ '--name',
1026
+ containerName,
1027
+ '--restart',
1028
+ 'always',
1029
+ '--network',
1030
+ networkName,
1031
+ '-e',
1032
+ `MYSQL_USER=${dbUser}`,
1033
+ '-e',
1034
+ `MYSQL_DATABASE=${dbDatabase}`,
1035
+ '-e',
1036
+ `MYSQL_PASSWORD=${dbPassword}`,
1037
+ '-e',
1038
+ `MYSQL_ROOT_PASSWORD=${dbPassword}`,
1039
+ '-v',
1040
+ `${dataDir}:/var/lib/mysql`,
1041
+ ];
1042
+ if (Install.shouldPublishBuiltinDbPort(params.source)) {
1043
+ args.push('-p', `${dbPort}:3306`);
1044
+ }
1045
+ args.push(image);
1046
+ return {
1047
+ source: String(params.source ?? '').trim() || undefined,
1048
+ dbDialect,
1049
+ dbHost,
1050
+ dbPort,
1051
+ dbDatabase,
1052
+ dbUser,
1053
+ dbPassword,
1054
+ networkName,
1055
+ containerName,
1056
+ dataDir,
1057
+ builtinDbImage: image,
1058
+ image,
1059
+ args,
1060
+ };
1061
+ }
1062
+ if (dbDialect === 'mariadb') {
1063
+ const image = String(params.builtinDbImage ?? '').trim() || DEFAULT_INSTALL_BUILTIN_DB_IMAGES.mariadb;
1064
+ const dataDir = path.resolve(params.storagePath, 'db', 'mariadb');
1065
+ const dbUser = String(params.dbUser ?? DEFAULT_INSTALL_DB_USER).trim() || DEFAULT_INSTALL_DB_USER;
1066
+ const dbDatabase = String(params.dbDatabase ?? defaultDbDatabase).trim() || defaultDbDatabase;
1067
+ const dbPassword = String(params.dbPassword ?? DEFAULT_INSTALL_DB_PASSWORD) || DEFAULT_INSTALL_DB_PASSWORD;
1068
+ const args = [
1069
+ 'run',
1070
+ '-d',
1071
+ '--name',
1072
+ containerName,
1073
+ '--restart',
1074
+ 'always',
1075
+ '--network',
1076
+ networkName,
1077
+ '-e',
1078
+ `MARIADB_USER=${dbUser}`,
1079
+ '-e',
1080
+ `MARIADB_DATABASE=${dbDatabase}`,
1081
+ '-e',
1082
+ `MARIADB_PASSWORD=${dbPassword}`,
1083
+ '-e',
1084
+ `MARIADB_ROOT_PASSWORD=${dbPassword}`,
1085
+ '-v',
1086
+ `${dataDir}:/var/lib/mysql`,
1087
+ ];
1088
+ if (Install.shouldPublishBuiltinDbPort(params.source)) {
1089
+ args.push('-p', `${dbPort}:3306`);
1090
+ }
1091
+ args.push(image);
1092
+ return {
1093
+ source: String(params.source ?? '').trim() || undefined,
1094
+ dbDialect,
1095
+ dbHost,
1096
+ dbPort,
1097
+ dbDatabase,
1098
+ dbUser,
1099
+ dbPassword,
1100
+ networkName,
1101
+ containerName,
1102
+ dataDir,
1103
+ builtinDbImage: image,
1104
+ image,
1105
+ args,
1106
+ };
1107
+ }
1108
+ if (dbDialect === 'kingbase') {
1109
+ const image = String(params.builtinDbImage ?? '').trim() || DEFAULT_INSTALL_BUILTIN_DB_IMAGES.kingbase;
1110
+ const dataDir = path.resolve(params.storagePath, 'db', 'kingbase');
1111
+ const dbUser = String(params.dbUser ?? DEFAULT_INSTALL_DB_USER).trim() || DEFAULT_INSTALL_DB_USER;
1112
+ const dbDatabase = String(params.dbDatabase ?? defaultDbDatabase).trim() || defaultDbDatabase;
1113
+ const dbPassword = String(params.dbPassword ?? DEFAULT_INSTALL_DB_PASSWORD) || DEFAULT_INSTALL_DB_PASSWORD;
1114
+ const args = [
1115
+ 'run',
1116
+ '-d',
1117
+ '--name',
1118
+ containerName,
1119
+ '--restart',
1120
+ 'always',
1121
+ '--network',
1122
+ networkName,
1123
+ '--platform',
1124
+ 'linux/amd64',
1125
+ '--privileged',
1126
+ '-e',
1127
+ 'ENABLE_CI=no',
1128
+ '-e',
1129
+ `DB_USER=${dbUser}`,
1130
+ '-e',
1131
+ `DB_PASSWORD=${dbPassword}`,
1132
+ '-e',
1133
+ 'DB_MODE=pg',
1134
+ '-e',
1135
+ 'NEED_START=yes',
1136
+ '-v',
1137
+ `${dataDir}:/home/kingbase/userdata`,
1138
+ ];
1139
+ if (Install.shouldPublishBuiltinDbPort(params.source)) {
1140
+ args.push('-p', `${dbPort}:54321`);
1141
+ }
1142
+ args.push(image, '/usr/sbin/init');
1143
+ return {
1144
+ source: String(params.source ?? '').trim() || undefined,
1145
+ dbDialect,
1146
+ dbHost,
1147
+ dbPort,
1148
+ dbDatabase,
1149
+ dbUser,
1150
+ dbPassword,
1151
+ networkName,
1152
+ containerName,
1153
+ dataDir,
1154
+ builtinDbImage: image,
1155
+ image,
1156
+ args,
1157
+ };
1158
+ }
1159
+ throw new Error(`Built-in database does not support "${dbDialect}" yet. Please choose PostgreSQL, MySQL, MariaDB, or KingbaseES.`);
1160
+ }
1161
+ async ensureDockerNetwork(name) {
1162
+ p.log.step(`Checking Docker network: ${name}`);
1163
+ const exists = await commandSucceeds('docker', ['network', 'inspect', name]);
1164
+ if (exists) {
1165
+ p.log.info(`Docker network already exists: ${name}`);
1166
+ return;
1167
+ }
1168
+ p.log.step(`Creating Docker network: ${name}`);
1169
+ try {
1170
+ await run('docker', ['network', 'create', name], {
1171
+ errorName: 'docker network create',
1172
+ });
1173
+ p.log.info(`Docker network is ready: ${name}`);
1174
+ }
1175
+ catch (error) {
1176
+ const message = error instanceof Error ? error.message : String(error);
1177
+ if (/address pools have been fully subnetted/i.test(message)) {
1178
+ throw new Error([
1179
+ `Docker could not create network "${name}" because its address pools are exhausted.`,
1180
+ 'Remove unused Docker networks and try again, for example: docker network prune',
1181
+ `Original error: ${message}`,
1182
+ ].join('\n'));
1183
+ }
1184
+ throw error;
1185
+ }
1186
+ }
1187
+ async dockerContainerExists(name) {
1188
+ return await commandSucceeds('docker', [
1189
+ 'container',
1190
+ 'inspect',
1191
+ name,
1192
+ ]);
1193
+ }
1194
+ async removeDockerContainer(name) {
1195
+ await run('docker', ['rm', '-f', name], {
1196
+ errorName: 'docker rm',
1197
+ });
1198
+ }
1199
+ async removeDockerContainerIfForced(params) {
1200
+ const exists = await this.dockerContainerExists(params.containerName);
1201
+ if (!exists) {
1202
+ return false;
1203
+ }
1204
+ if (!params.force) {
1205
+ return true;
1206
+ }
1207
+ p.log.info(`Removing existing ${params.displayName}: ${params.containerName}`);
1208
+ await this.removeDockerContainer(params.containerName);
1209
+ return false;
1210
+ }
1211
+ async inspectDockerContainerEnv(name) {
1212
+ const output = await commandOutput('docker', [
1213
+ 'inspect',
1214
+ '--format',
1215
+ '{{range .Config.Env}}{{println .}}{{end}}',
1216
+ name,
1217
+ ]);
1218
+ const env = {};
1219
+ for (const line of output.split(/\r?\n/)) {
1220
+ const index = line.indexOf('=');
1221
+ if (index <= 0) {
1222
+ continue;
1223
+ }
1224
+ env[line.slice(0, index)] = line.slice(index + 1);
1225
+ }
1226
+ return env;
1227
+ }
1228
+ async ensureBuiltinDbContainer(plan) {
1229
+ const exists = await this.dockerContainerExists(plan.containerName);
1230
+ if (exists) {
1231
+ p.log.info(`Built-in ${plan.dbDialect} container already exists: ${plan.containerName}`);
1232
+ return;
1233
+ }
1234
+ await mkdir(plan.dataDir, { recursive: true });
1235
+ await run('docker', plan.args, {
1236
+ errorName: 'docker run',
1237
+ });
1238
+ }
1239
+ async startBuiltinDb(params) {
1240
+ const storagePath = String(params.appResults.storagePath ?? '').trim()
1241
+ || defaultInstallStoragePath(params.envName);
1242
+ const plan = Install.buildBuiltinDbPlan({
1243
+ envName: params.envName,
1244
+ workspaceName: params.workspaceName,
1245
+ storagePath,
1246
+ source: params.downloadResults.source,
1247
+ dbDialect: params.dbResults.dbDialect,
1248
+ dbHost: params.dbResults.dbHost,
1249
+ dbPort: params.dbResults.dbPort,
1250
+ dbDatabase: params.dbResults.dbDatabase,
1251
+ dbUser: params.dbResults.dbUser,
1252
+ dbPassword: params.dbResults.dbPassword,
1253
+ builtinDbImage: params.dbResults.builtinDbImage,
1254
+ });
1255
+ p.log.step(`Preparing built-in ${plan.dbDialect} database`);
1256
+ await this.ensureDockerNetwork(plan.networkName);
1257
+ await this.removeDockerContainerIfForced({
1258
+ containerName: plan.containerName,
1259
+ displayName: `built-in ${plan.dbDialect} container`,
1260
+ force: params.force,
1261
+ });
1262
+ if (Install.shouldPublishBuiltinDbPort(params.downloadResults.source)) {
1263
+ const portError = await validateAvailableTcpPort(plan.dbPort);
1264
+ if (portError) {
1265
+ throw new Error(`Built-in ${plan.dbDialect} needs host port ${plan.dbPort}, but ${portError}`);
1266
+ }
1267
+ }
1268
+ await this.ensureBuiltinDbContainer(plan);
1269
+ p.log.info(`Built-in ${plan.dbDialect} database is ready at ${plan.dbHost}:${plan.dbPort}`);
1270
+ return plan;
1271
+ }
1272
+ static buildDockerAppPlan(params) {
1273
+ const dockerRegistry = String(downloadResultsValue(params.downloadResults, 'dockerRegistry') ?? '').trim()
1274
+ || defaultDockerRegistryForLang(params.appResults.lang);
1275
+ const version = String(downloadResultsValue(params.downloadResults, 'version') ?? '').trim() || 'latest';
1276
+ const appPort = String(params.appResults.appPort ?? DEFAULT_INSTALL_APP_PORT).trim() || DEFAULT_INSTALL_APP_PORT;
1277
+ const storagePath = path.resolve(String(params.appResults.storagePath ?? '').trim()
1278
+ || defaultInstallStoragePath(params.envName));
1279
+ const dbDialect = String(params.dbResults.dbDialect ?? 'postgres').trim() || 'postgres';
1280
+ const dbHost = String(params.dbResults.dbHost ?? DEFAULT_INSTALL_DB_HOST).trim() || DEFAULT_INSTALL_DB_HOST;
1281
+ const dbPort = String(params.dbResults.dbPort ?? defaultDbPortForDialect(dbDialect)).trim()
1282
+ || defaultDbPortForDialect(dbDialect);
1283
+ const dbDatabase = String(params.dbResults.dbDatabase ?? DEFAULT_INSTALL_DB_DATABASE).trim()
1284
+ || DEFAULT_INSTALL_DB_DATABASE;
1285
+ const dbUser = String(params.dbResults.dbUser ?? DEFAULT_INSTALL_DB_USER).trim() || DEFAULT_INSTALL_DB_USER;
1286
+ const dbPassword = String(params.dbResults.dbPassword ?? DEFAULT_INSTALL_DB_PASSWORD) || DEFAULT_INSTALL_DB_PASSWORD;
1287
+ const appKey = crypto.randomBytes(32).toString('hex');
1288
+ const timeZone = Intl.DateTimeFormat().resolvedOptions().timeZone || 'UTC';
1289
+ const containerName = Install.buildDockerAppContainerName(params.envName, params.workspaceName);
1290
+ const initEnvVars = Install.buildInitAppEnvVars({
1291
+ appResults: params.appResults,
1292
+ rootResults: params.rootResults,
1293
+ });
1294
+ const args = [
1295
+ 'run',
1296
+ '-d',
1297
+ '--name',
1298
+ containerName,
1299
+ '--restart',
1300
+ 'always',
1301
+ '--network',
1302
+ params.networkName,
1303
+ '-p',
1304
+ `${appPort}:80`,
1305
+ ];
1306
+ for (const [key, value] of Object.entries(initEnvVars)) {
1307
+ args.push('-e', `${key}=${value}`);
1308
+ }
1309
+ args.push('-e', `APP_KEY=${appKey}`, '-e', `DB_DIALECT=${dbDialect}`, '-e', `DB_HOST=${dbHost}`, '-e', `DB_PORT=${dbPort}`, '-e', `DB_DATABASE=${dbDatabase}`, '-e', `DB_USER=${dbUser}`, '-e', `DB_PASSWORD=${dbPassword}`, '-e', `TZ=${timeZone}`, '-v', `${storagePath}:/app/nocobase/storage`, `${dockerRegistry}:${version}`);
1310
+ return {
1311
+ source: 'docker',
1312
+ networkName: params.networkName,
1313
+ containerName,
1314
+ imageRef: `${dockerRegistry}:${version}`,
1315
+ appPort,
1316
+ storagePath,
1317
+ appKey,
1318
+ timeZone,
1319
+ args,
1320
+ };
1321
+ }
1322
+ async ensureDockerAppContainer(plan) {
1323
+ const exists = await this.dockerContainerExists(plan.containerName);
1324
+ if (exists) {
1325
+ p.log.info(`App container already exists: ${plan.containerName}`);
1326
+ return 'existing';
1327
+ }
1328
+ await mkdir(plan.storagePath, { recursive: true });
1329
+ await run('docker', plan.args, {
1330
+ errorName: 'docker run',
1331
+ });
1332
+ return 'created';
1333
+ }
1334
+ async installDockerApp(params) {
1335
+ const networkName = params.builtinDbPlan?.networkName
1336
+ ?? Install.buildBuiltinDbNetworkName(params.envName, params.workspaceName);
1337
+ await this.ensureDockerNetwork(networkName);
1338
+ const plan = Install.buildDockerAppPlan({
1339
+ envName: params.envName,
1340
+ workspaceName: params.workspaceName,
1341
+ appResults: params.appResults,
1342
+ downloadResults: params.downloadResults,
1343
+ dbResults: params.dbResults,
1344
+ rootResults: params.rootResults,
1345
+ networkName,
1346
+ });
1347
+ p.log.step(`Starting Docker app ${plan.imageRef}`);
1348
+ await this.removeDockerContainerIfForced({
1349
+ containerName: plan.containerName,
1350
+ displayName: 'app container',
1351
+ force: params.force,
1352
+ });
1353
+ const containerState = await this.ensureDockerAppContainer(plan);
1354
+ if (containerState === 'existing') {
1355
+ const env = await this.inspectDockerContainerEnv(plan.containerName);
1356
+ plan.appKey = env.APP_KEY || plan.appKey;
1357
+ plan.timeZone = env.TZ || plan.timeZone;
1358
+ }
1359
+ p.log.info(`App container is ready at http://127.0.0.1:${plan.appPort}`);
1360
+ return plan;
1361
+ }
1362
+ static pushDownloadArgIfValue(argv, flag, value) {
1363
+ const text = String(value ?? '').trim();
1364
+ if (text) {
1365
+ argv.push(flag, text);
1366
+ }
1367
+ }
1368
+ static buildDownloadArgvFromResults(results) {
1369
+ const argv = ['-y', '--no-intro'];
1370
+ Install.pushDownloadArgIfValue(argv, '--source', results.source);
1371
+ Install.pushDownloadArgIfValue(argv, '--version', results.version);
1372
+ Install.pushDownloadArgIfValue(argv, '--output-dir', results.outputDir);
1373
+ Install.pushDownloadArgIfValue(argv, '--git-url', results.gitUrl);
1374
+ Install.pushDownloadArgIfValue(argv, '--docker-registry', results.dockerRegistry);
1375
+ Install.pushDownloadArgIfValue(argv, '--docker-platform', results.dockerPlatform);
1376
+ Install.pushDownloadArgIfValue(argv, '--npm-registry', results.npmRegistry);
1377
+ if (Boolean(results.replace)) {
1378
+ argv.push('--replace');
1379
+ }
1380
+ if (Boolean(results.devDependencies)) {
1381
+ argv.push('--dev-dependencies');
1382
+ }
1383
+ if (Boolean(results.dockerSave)) {
1384
+ argv.push('--docker-save');
1385
+ }
1386
+ if (results.build !== undefined && !Boolean(results.build)) {
1387
+ argv.push('--no-build');
1388
+ }
1389
+ if (Boolean(results.buildDts)) {
1390
+ argv.push('--build-dts');
1391
+ }
1392
+ return argv;
1393
+ }
1394
+ static resolveLocalProjectRoot(params) {
1395
+ const projectRoot = params.downloadCommandResult?.projectRoot;
1396
+ if (projectRoot) {
1397
+ return projectRoot;
1398
+ }
1399
+ const outputDir = String(params.downloadResults.outputDir ?? '').trim()
1400
+ || String(params.appResults.appRootPath ?? '').trim()
1401
+ || defaultInstallAppRootPath(params.envName);
1402
+ return path.resolve(process.cwd(), outputDir);
1403
+ }
1404
+ async downloadLocalApp(params) {
1405
+ const argv = Install.buildDownloadArgvFromResults(params.downloadResults);
1406
+ p.log.step('Downloading local NocoBase app files');
1407
+ const result = await this.config.runCommand('download', argv);
1408
+ const projectRoot = Install.resolveLocalProjectRoot({
1409
+ envName: params.envName,
1410
+ appResults: params.appResults,
1411
+ downloadResults: params.downloadResults,
1412
+ downloadCommandResult: result,
1413
+ });
1414
+ params.appResults.appRootPath = projectRoot;
1415
+ return projectRoot;
1416
+ }
1417
+ static buildLocalAppEnvVars(params) {
1418
+ const storagePath = path.resolve(String(params.appResults.storagePath ?? '').trim()
1419
+ || defaultInstallStoragePath(params.envName));
1420
+ const dbDialect = String(params.dbResults.dbDialect ?? 'postgres').trim()
1421
+ || 'postgres';
1422
+ const appKey = crypto.randomBytes(32).toString('hex');
1423
+ const timeZone = Intl.DateTimeFormat().resolvedOptions().timeZone || 'UTC';
1424
+ const env = {
1425
+ STORAGE_PATH: storagePath,
1426
+ APP_PORT: String(params.appResults.appPort ?? DEFAULT_INSTALL_APP_PORT).trim()
1427
+ || DEFAULT_INSTALL_APP_PORT,
1428
+ APP_KEY: appKey,
1429
+ TZ: timeZone,
1430
+ DB_DIALECT: dbDialect,
1431
+ DB_HOST: String(params.dbResults.dbHost ?? DEFAULT_INSTALL_DB_HOST).trim()
1432
+ || DEFAULT_INSTALL_DB_HOST,
1433
+ DB_PORT: String(params.dbResults.dbPort ?? defaultDbPortForDialect(dbDialect)).trim()
1434
+ || defaultDbPortForDialect(dbDialect),
1435
+ DB_DATABASE: String(params.dbResults.dbDatabase ?? DEFAULT_INSTALL_DB_DATABASE).trim()
1436
+ || DEFAULT_INSTALL_DB_DATABASE,
1437
+ DB_USER: String(params.dbResults.dbUser ?? DEFAULT_INSTALL_DB_USER).trim()
1438
+ || DEFAULT_INSTALL_DB_USER,
1439
+ DB_PASSWORD: String(params.dbResults.dbPassword ?? DEFAULT_INSTALL_DB_PASSWORD)
1440
+ || DEFAULT_INSTALL_DB_PASSWORD,
1441
+ ...Install.buildInitAppEnvVars({
1442
+ appResults: params.appResults,
1443
+ rootResults: params.rootResults,
1444
+ }),
1445
+ };
1446
+ return env;
1447
+ }
1448
+ async startLocalApp(params) {
1449
+ const env = Install.buildLocalAppEnvVars({
1450
+ envName: params.envName,
1451
+ appResults: params.appResults,
1452
+ dbResults: params.dbResults,
1453
+ rootResults: params.rootResults,
1454
+ });
1455
+ const args = ['start', '--quickstart', '--daemon'];
1456
+ p.log.step(`Stopping any existing local NocoBase process in ${params.projectRoot}`);
1457
+ try {
1458
+ await runNocoBaseCommand(['pm2', 'kill'], {
1459
+ cwd: params.projectRoot,
1460
+ env,
1461
+ });
1462
+ }
1463
+ catch (error) {
1464
+ const message = error instanceof Error ? error.message : String(error);
1465
+ p.log.info(`Skipped local process cleanup before start: ${message}`);
1466
+ }
1467
+ p.log.step(`Starting local NocoBase app from ${params.projectRoot}`);
1468
+ await runNocoBaseCommand(args, {
1469
+ cwd: params.projectRoot,
1470
+ env,
1471
+ });
1472
+ p.log.info(`Local app is starting at http://127.0.0.1:${env.APP_PORT}`);
1473
+ return {
1474
+ source: params.source,
1475
+ projectRoot: params.projectRoot,
1476
+ appPort: env.APP_PORT,
1477
+ storagePath: env.STORAGE_PATH,
1478
+ appKey: env.APP_KEY,
1479
+ timeZone: env.TZ,
1480
+ env,
1481
+ args,
1482
+ };
1483
+ }
1484
+ static resolveApiBaseUrl(params) {
1485
+ const appPort = String(params.appResults.appPort ?? DEFAULT_INSTALL_APP_PORT).trim()
1486
+ || DEFAULT_INSTALL_APP_PORT;
1487
+ return (String(params.envAddResults.apiBaseUrl ?? '').trim()
1488
+ || `http://127.0.0.1:${appPort}/api`);
1489
+ }
1490
+ static buildHealthCheckUrl(apiBaseUrl) {
1491
+ return `${apiBaseUrl.replace(/\/+$/, '')}/__health_check`;
1492
+ }
1493
+ static async sleep(ms) {
1494
+ await new Promise((resolve) => setTimeout(resolve, ms));
1495
+ }
1496
+ static formatHealthCheckMessage(message, maxLength = 120) {
1497
+ const text = message.replace(/\s+/g, ' ').trim();
1498
+ if (!text) {
1499
+ return 'No response yet';
1500
+ }
1501
+ return text.length > maxLength ? `${text.slice(0, maxLength - 3)}...` : text;
1502
+ }
1503
+ static async requestAppHealthCheck(params) {
1504
+ const controller = new AbortController();
1505
+ const timeout = setTimeout(() => {
1506
+ controller.abort();
1507
+ }, params.requestTimeoutMs);
1508
+ try {
1509
+ const response = await params.fetchImpl(params.healthCheckUrl, {
1510
+ method: 'GET',
1511
+ signal: controller.signal,
1512
+ });
1513
+ const text = await response.text().catch(() => '');
1514
+ const body = Install.formatHealthCheckMessage(text);
1515
+ return {
1516
+ ok: response.ok && text.trim().toLowerCase() === 'ok',
1517
+ message: response.ok
1518
+ ? `HTTP ${response.status}: ${body}`
1519
+ : `HTTP ${response.status}: ${body}`,
1520
+ };
1521
+ }
1522
+ catch (error) {
1523
+ if (error instanceof Error && error.name === 'AbortError') {
1524
+ return {
1525
+ ok: false,
1526
+ message: `No response within ${Math.ceil(params.requestTimeoutMs / 1000)}s`,
1527
+ };
1528
+ }
1529
+ return {
1530
+ ok: false,
1531
+ message: error instanceof Error ? error.message : String(error),
1532
+ };
1533
+ }
1534
+ finally {
1535
+ clearTimeout(timeout);
1536
+ }
1537
+ }
1538
+ async waitForAppHealthCheck(apiBaseUrl, options) {
1539
+ const healthCheckUrl = Install.buildHealthCheckUrl(apiBaseUrl);
1540
+ const timeoutMs = options?.timeoutMs ?? APP_HEALTH_CHECK_TIMEOUT_MS;
1541
+ const intervalMs = options?.intervalMs ?? APP_HEALTH_CHECK_INTERVAL_MS;
1542
+ const requestTimeoutMs = options?.requestTimeoutMs ?? APP_HEALTH_CHECK_REQUEST_TIMEOUT_MS;
1543
+ const fetchImpl = options?.fetchImpl ?? fetch;
1544
+ const startedAt = Date.now();
1545
+ let lastMessage = 'No response yet';
1546
+ let taskActive = true;
1547
+ startTask(`Waiting for application health check: ${healthCheckUrl}. NocoBase has started and is still booting...`);
1548
+ try {
1549
+ while (Date.now() - startedAt < timeoutMs) {
1550
+ const result = await Install.requestAppHealthCheck({
1551
+ healthCheckUrl,
1552
+ fetchImpl,
1553
+ requestTimeoutMs,
1554
+ });
1555
+ if (result.ok) {
1556
+ stopTask();
1557
+ taskActive = false;
1558
+ p.log.info(`Application health check passed: ${healthCheckUrl}`);
1559
+ return;
1560
+ }
1561
+ lastMessage = result.message;
1562
+ const elapsedSeconds = Math.max(1, Math.floor((Date.now() - startedAt) / 1000));
1563
+ updateTask(`Waiting for application health check: ${healthCheckUrl}. Still starting... (${elapsedSeconds}s elapsed, last status: ${Install.formatHealthCheckMessage(lastMessage)})`);
1564
+ const remainingMs = timeoutMs - (Date.now() - startedAt);
1565
+ if (remainingMs <= 0) {
1566
+ break;
1567
+ }
1568
+ await Install.sleep(Math.min(intervalMs, remainingMs));
1569
+ }
1570
+ }
1571
+ finally {
1572
+ if (taskActive) {
1573
+ stopTask();
1574
+ }
1575
+ }
1576
+ const logHint = options?.containerName
1577
+ ? ` You can inspect startup logs with: docker logs ${options.containerName}`
1578
+ : '';
1579
+ throw new Error(`The application did not become ready in time. Expected \`${healthCheckUrl}\` to respond with \`ok\`, but the last status was: ${Install.formatHealthCheckMessage(lastMessage)}.${logHint}`);
1580
+ }
1581
+ async saveInstalledEnv(params) {
1582
+ await this.config.runCommand('env:add', Install.buildEnvAddArgv(params));
1583
+ }
1584
+ static pushArgIfValue(argv, flag, value) {
1585
+ const text = String(value ?? '').trim();
1586
+ if (text) {
1587
+ argv.push(flag, text);
1588
+ }
1589
+ }
1590
+ static pushBooleanArgIfSet(argv, flag, value) {
1591
+ if (value === undefined) {
1592
+ return;
1593
+ }
1594
+ argv.push(Boolean(value) ? flag : `--no-${flag.replace(/^--/, '')}`);
1595
+ }
1596
+ static buildEnvAddArgv(params) {
1597
+ const appPort = String(params.appResults.appPort ?? DEFAULT_INSTALL_APP_PORT).trim()
1598
+ || DEFAULT_INSTALL_APP_PORT;
1599
+ const storagePath = String(params.appResults.storagePath ?? '').trim()
1600
+ || defaultInstallStoragePath(params.envName);
1601
+ const apiBaseUrl = Install.resolveApiBaseUrl({
1602
+ appResults: params.appResults,
1603
+ envAddResults: params.envAddResults,
1604
+ });
1605
+ const authType = String(params.envAddResults.authType ?? 'oauth').trim()
1606
+ || 'oauth';
1607
+ const argv = [
1608
+ params.envName,
1609
+ '--no-intro',
1610
+ '--scope',
1611
+ CONFIG_SCOPE,
1612
+ '--api-base-url',
1613
+ apiBaseUrl,
1614
+ '--auth-type',
1615
+ authType,
1616
+ '--app-port',
1617
+ appPort,
1618
+ '--storage-path',
1619
+ storagePath,
1620
+ ];
1621
+ Install.pushArgIfValue(argv, '--source', downloadResultsValue(params.downloadResults, 'source'));
1622
+ Install.pushArgIfValue(argv, '--download-version', downloadResultsValue(params.downloadResults, 'version'));
1623
+ Install.pushArgIfValue(argv, '--docker-registry', downloadResultsValue(params.downloadResults, 'dockerRegistry'));
1624
+ Install.pushArgIfValue(argv, '--docker-platform', downloadResultsValue(params.downloadResults, 'dockerPlatform'));
1625
+ Install.pushArgIfValue(argv, '--git-url', downloadResultsValue(params.downloadResults, 'gitUrl'));
1626
+ Install.pushArgIfValue(argv, '--npm-registry', downloadResultsValue(params.downloadResults, 'npmRegistry'));
1627
+ Install.pushBooleanArgIfSet(argv, '--dev-dependencies', downloadResultsValue(params.downloadResults, 'devDependencies'));
1628
+ Install.pushBooleanArgIfSet(argv, '--build', downloadResultsValue(params.downloadResults, 'build'));
1629
+ Install.pushBooleanArgIfSet(argv, '--build-dts', downloadResultsValue(params.downloadResults, 'buildDts'));
1630
+ Install.pushArgIfValue(argv, '--app-root-path', params.appResults.appRootPath);
1631
+ Install.pushArgIfValue(argv, '--app-key', params.appResults.appKey);
1632
+ Install.pushArgIfValue(argv, '--timezone', params.appResults.timeZone);
1633
+ Install.pushBooleanArgIfSet(argv, '--builtin-db', params.dbResults.builtinDb);
1634
+ Install.pushArgIfValue(argv, '--db-dialect', params.dbResults.dbDialect);
1635
+ Install.pushArgIfValue(argv, '--builtin-db-image', params.dbResults.builtinDbImage);
1636
+ Install.pushArgIfValue(argv, '--db-host', params.dbResults.dbHost);
1637
+ Install.pushArgIfValue(argv, '--db-port', params.dbResults.dbPort);
1638
+ Install.pushArgIfValue(argv, '--db-database', params.dbResults.dbDatabase);
1639
+ Install.pushArgIfValue(argv, '--db-user', params.dbResults.dbUser);
1640
+ Install.pushArgIfValue(argv, '--db-password', params.dbResults.dbPassword);
1641
+ if (authType === 'token') {
1642
+ argv.push('--access-token', String(params.envAddResults.accessToken ?? ''));
1643
+ }
1644
+ return argv;
1645
+ }
1646
+ async collectPromptResults(parsed, yes) {
1647
+ const resumePreset = await this.resolveResumePresetValues(parsed, yes);
1648
+ const envPreset = {
1649
+ ...(resumePreset?.envPreset ?? {}),
1650
+ ...Install.buildEnvPresetValuesFromFlags(parsed),
1651
+ };
1652
+ const envResults = await runPromptCatalog(Install.envPrompts, {
1653
+ initialValues: {
1654
+ env: DEFAULT_INSTALL_ENV_NAME,
1655
+ },
1656
+ values: envPreset,
1657
+ yes,
1658
+ });
1659
+ const envName = String(envResults.env ?? '').trim() || DEFAULT_INSTALL_ENV_NAME;
1660
+ const appPreset = {
1661
+ ...(resumePreset?.appPreset ?? {}),
1662
+ ...Install.buildAppPresetValuesFromFlags(parsed),
1663
+ };
1664
+ const appCatalog = Install.buildAppPromptsCatalog(envName);
1665
+ const appResults = await runPromptCatalog(appCatalog, {
1666
+ initialValues: await Install.buildAppPromptInitialValues({
1667
+ envName,
1668
+ flags: {
1669
+ ...parsed,
1670
+ 'app-root-path': parsed['app-root-path']
1671
+ ?? Install.toOptionalPromptString(appPreset.appRootPath),
1672
+ 'app-port': parsed['app-port']
1673
+ ?? Install.toOptionalPromptString(appPreset.appPort),
1674
+ 'storage-path': parsed['storage-path']
1675
+ ?? Install.toOptionalPromptString(appPreset.storagePath),
1676
+ },
1677
+ }),
1678
+ values: appPreset,
1679
+ yes,
1680
+ });
1681
+ let downloadResults = {};
1682
+ if (Boolean(appResults.fetchSource)) {
1683
+ const downloadOpts = Install.buildDownloadPromptOptionsForInstall(appResults, envName);
1684
+ downloadOpts.values = {
1685
+ ...(resumePreset?.downloadPreset ?? {}),
1686
+ ...downloadOpts.values,
1687
+ ...Install.buildDownloadPresetValuesForInstall(parsed, appResults, envName, yes),
1688
+ };
1689
+ downloadOpts.yes = yes;
1690
+ downloadResults = await runPromptCatalog(Download.prompts, downloadOpts);
1691
+ }
1692
+ const dbPreset = {
1693
+ ...(resumePreset?.dbPreset ?? {}),
1694
+ ...Install.buildDbPresetValuesFromFlags(parsed),
1695
+ };
1696
+ const dbResults = await runPromptCatalog(Install.buildDbPromptsCatalog(downloadResults), {
1697
+ initialValues: {
1698
+ ...downloadResults,
1699
+ ...await Install.buildDbPromptInitialValues({
1700
+ flags: {
1701
+ ...parsed,
1702
+ 'db-port': parsed['db-port']
1703
+ ?? Install.toOptionalPromptString(dbPreset.dbPort),
1704
+ },
1705
+ downloadResults,
1706
+ dbPreset,
1707
+ }),
1708
+ },
1709
+ values: dbPreset,
1710
+ yes,
1711
+ });
1712
+ const rootPreset = Install.buildRootPresetValuesFromFlags(parsed);
1713
+ const rootResults = await runPromptCatalog(Install.rootUserPrompts, {
1714
+ initialValues: {},
1715
+ values: rootPreset,
1716
+ yes,
1717
+ });
1718
+ const envAddResults = await runPromptCatalog(EnvAdd.prompts, {
1719
+ initialValues: {
1720
+ apiBaseUrl: `http://127.0.0.1:${appResults.appPort ?? DEFAULT_INSTALL_APP_PORT}/api`,
1721
+ },
1722
+ values: {
1723
+ name: envName,
1724
+ scope: 'project',
1725
+ ...(resumePreset?.envAddPreset ?? {}),
1726
+ },
1727
+ yes,
1728
+ });
1729
+ return {
1730
+ envName,
1731
+ envResults,
1732
+ appResults,
1733
+ downloadResults,
1734
+ dbResults,
1735
+ rootResults,
1736
+ envAddResults,
1737
+ };
1738
+ }
1739
+ async run() {
1740
+ const parsedResult = await this.parse(Install);
1741
+ applyCliLocale(parsedResult.flags.locale);
1742
+ const flags = parsedResult.flags;
1743
+ const parsed = {
1744
+ ...flags,
1745
+ };
1746
+ if (!parsed['no-intro']) {
1747
+ p.intro('Set Up NocoBase');
1748
+ }
1749
+ if (parsed.resume) {
1750
+ const envLabel = Install.toOptionalPromptString(parsed.env);
1751
+ p.log.step(envLabel
1752
+ ? `Resuming setup for env "${envLabel}" from the saved workspace config`
1753
+ : 'Resuming setup from the saved workspace config');
1754
+ }
1755
+ const promptResults = await this.collectPromptResults(parsed, flags.yes);
1756
+ const { envName, appResults, downloadResults, dbResults, rootResults, envAddResults, } = promptResults;
1757
+ const source = String(downloadResultsValue(downloadResults, 'source') ?? '').trim();
1758
+ const usesDockerResources = Boolean(dbResults.builtinDb)
1759
+ || (Boolean(appResults.fetchSource) && source === 'docker');
1760
+ const workspaceName = usesDockerResources
1761
+ ? await Install.ensureWorkspaceName()
1762
+ : undefined;
1763
+ let builtinDbPlan;
1764
+ if (Boolean(dbResults.builtinDb)) {
1765
+ builtinDbPlan = await this.startBuiltinDb({
1766
+ envName,
1767
+ workspaceName,
1768
+ appResults,
1769
+ downloadResults,
1770
+ dbResults,
1771
+ force: parsed.force,
1772
+ });
1773
+ dbResults.dbHost = builtinDbPlan.dbHost;
1774
+ dbResults.dbPort = builtinDbPlan.dbPort;
1775
+ dbResults.dbDialect = builtinDbPlan.dbDialect;
1776
+ dbResults.dbDatabase = builtinDbPlan.dbDatabase;
1777
+ dbResults.dbUser = builtinDbPlan.dbUser;
1778
+ dbResults.dbPassword = builtinDbPlan.dbPassword;
1779
+ }
1780
+ let dockerAppPlan;
1781
+ let localAppPlan;
1782
+ if (Boolean(appResults.fetchSource)) {
1783
+ if (source === 'docker') {
1784
+ dockerAppPlan = await this.installDockerApp({
1785
+ envName,
1786
+ workspaceName,
1787
+ appResults,
1788
+ downloadResults,
1789
+ dbResults,
1790
+ rootResults,
1791
+ builtinDbPlan,
1792
+ force: parsed.force,
1793
+ });
1794
+ appResults.appKey = dockerAppPlan.appKey;
1795
+ appResults.timeZone = dockerAppPlan.timeZone;
1796
+ }
1797
+ else if (source === 'npm' || source === 'git') {
1798
+ const projectRoot = await this.downloadLocalApp({
1799
+ envName,
1800
+ appResults,
1801
+ downloadResults,
1802
+ });
1803
+ localAppPlan = await this.startLocalApp({
1804
+ envName,
1805
+ source,
1806
+ projectRoot,
1807
+ appResults,
1808
+ dbResults,
1809
+ rootResults,
1810
+ });
1811
+ appResults.appKey = localAppPlan.appKey;
1812
+ appResults.timeZone = localAppPlan.timeZone;
1813
+ }
1814
+ }
1815
+ else {
1816
+ p.log.info('Skipped app download and install.');
1817
+ }
1818
+ if (dockerAppPlan || localAppPlan) {
1819
+ await this.waitForAppHealthCheck(Install.resolveApiBaseUrl({
1820
+ appResults,
1821
+ envAddResults,
1822
+ }), {
1823
+ containerName: dockerAppPlan?.containerName,
1824
+ });
1825
+ }
1826
+ await this.saveInstalledEnv({
1827
+ envName,
1828
+ appResults,
1829
+ downloadResults,
1830
+ dbResults,
1831
+ envAddResults,
1832
+ });
1833
+ p.outro(dockerAppPlan || localAppPlan
1834
+ ? `NocoBase is ready at http://127.0.0.1:${dockerAppPlan?.appPort ?? localAppPlan?.appPort}`
1835
+ : `Install config for "${envName}" has been saved.`);
1836
+ }
1837
+ }
1838
+ function downloadResultsValue(downloadResults, key) {
1839
+ return downloadResults[key];
1840
+ }