@prostgles/prostgles 2.3.6-dev.1787077577 → 2.3.6-dev.1787160729
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/client/build/js/main.bundle.js +1 -1
- package/dist/server/package.json +5 -1
- package/dist/server/src/ConnectionManager/getHotReloadConfigs.d.ts.map +1 -1
- package/dist/server/src/ConnectionManager/getHotReloadConfigs.js +3 -3
- package/dist/server/src/ConnectionManager/getHotReloadConfigs.js.map +1 -1
- package/dist/server/src/McpHub/ProstglesMcpHub/ProstglesMCPServers/Web/getDocumentText.d.ts +2 -1
- package/dist/server/src/McpHub/ProstglesMcpHub/ProstglesMCPServers/Web/getDocumentText.d.ts.map +1 -1
- package/dist/server/src/McpHub/ProstglesMcpHub/ProstglesMCPServers/Web/getDocumentText.js.map +1 -1
- package/dist/server/src/McpHub/ProstglesMcpHub/ProstglesMCPServers/WebDev/tools/searchWebDevFiles.spec.js +1 -0
- package/dist/server/src/McpHub/ProstglesMcpHub/ProstglesMCPServers/WebDev/tools/searchWebDevFiles.spec.js.map +1 -1
- package/dist/server/src/ServiceManager/ServiceManager.d.ts +19 -11
- package/dist/server/src/ServiceManager/ServiceManager.d.ts.map +1 -1
- package/dist/server/src/ServiceManager/ServiceManager.js +13 -2
- package/dist/server/src/ServiceManager/ServiceManager.js.map +1 -1
- package/dist/server/src/ServiceManager/ServiceManager.spec.d.ts.map +1 -1
- package/dist/server/src/ServiceManager/ServiceManager.spec.js +5 -1
- package/dist/server/src/ServiceManager/ServiceManager.spec.js.map +1 -1
- package/dist/server/src/ServiceManager/ServiceManagerTypes.d.ts +7 -0
- package/dist/server/src/ServiceManager/ServiceManagerTypes.d.ts.map +1 -1
- package/dist/server/src/ServiceManager/ServiceManagerTypes.js.map +1 -1
- package/dist/server/src/ServiceManager/buildService.d.ts +3 -3
- package/dist/server/src/ServiceManager/buildService.d.ts.map +1 -1
- package/dist/server/src/ServiceManager/buildService.js +10 -6
- package/dist/server/src/ServiceManager/buildService.js.map +1 -1
- package/dist/server/src/ServiceManager/enableService.d.ts +1 -2
- package/dist/server/src/ServiceManager/enableService.d.ts.map +1 -1
- package/dist/server/src/ServiceManager/enableService.js.map +1 -1
- package/dist/server/src/ServiceManager/getSelectedConfigEnvs.d.ts +2 -3
- package/dist/server/src/ServiceManager/getSelectedConfigEnvs.d.ts.map +1 -1
- package/dist/server/src/ServiceManager/getSelectedConfigEnvs.js +3 -3
- package/dist/server/src/ServiceManager/getSelectedConfigEnvs.js.map +1 -1
- package/dist/server/src/ServiceManager/startService.d.ts +3 -3
- package/dist/server/src/ServiceManager/startService.d.ts.map +1 -1
- package/dist/server/src/ServiceManager/startService.js +9 -7
- package/dist/server/src/ServiceManager/startService.js.map +1 -1
- package/dist/server/src/ServiceManager/stopService.d.ts +1 -2
- package/dist/server/src/ServiceManager/stopService.d.ts.map +1 -1
- package/dist/server/src/ServiceManager/stopService.js +1 -1
- package/dist/server/src/ServiceManager/stopService.js.map +1 -1
- package/dist/server/src/cli/cli.js +4 -34
- package/dist/server/src/cli/cli.js.map +1 -1
- package/dist/server/src/cli/cliTemplateFiles.d.ts +8 -0
- package/dist/server/src/cli/cliTemplateFiles.d.ts.map +1 -0
- package/dist/server/src/cli/cliTemplateFiles.js +381 -0
- package/dist/server/src/cli/cliTemplateFiles.js.map +1 -0
- package/dist/server/src/init/prostglesOnReady.d.ts +677 -1
- package/dist/server/src/init/prostglesOnReady.d.ts.map +1 -1
- package/dist/server/src/init/prostglesOnReady.js +7 -1
- package/dist/server/src/init/prostglesOnReady.js.map +1 -1
- package/dist/server/src/services.d.ts +3 -0
- package/dist/server/src/services.d.ts.map +1 -0
- package/dist/server/src/services.js +6 -0
- package/dist/server/src/services.js.map +1 -0
- package/package.json +5 -1
- package/dist/server/src/cli/cliUtils.d.ts +0 -64
- package/dist/server/src/cli/cliUtils.d.ts.map +0 -1
- package/dist/server/src/cli/cliUtils.js +0 -201
- package/dist/server/src/cli/cliUtils.js.map +0 -1
- package/dist/server/src/testing/createTestDeployment.d.ts +0 -37
- package/dist/server/src/testing/createTestDeployment.d.ts.map +0 -1
- package/dist/server/src/testing/createTestDeployment.js +0 -393
- package/dist/server/src/testing/createTestDeployment.js.map +0 -1
- package/dist/server/src/testing/index.d.ts +0 -2
- package/dist/server/src/testing/index.d.ts.map +0 -1
- package/dist/server/src/testing/index.js +0 -6
- package/dist/server/src/testing/index.js.map +0 -1
|
@@ -2,13 +2,12 @@
|
|
|
2
2
|
"use strict";
|
|
3
3
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
4
|
const tslib_1 = require("tslib");
|
|
5
|
-
const utils_1 = require("../../../common/utils");
|
|
6
5
|
const child_process_1 = require("child_process");
|
|
7
6
|
const dotenv_1 = require("dotenv");
|
|
8
7
|
const fs_1 = require("fs");
|
|
9
8
|
const path_1 = tslib_1.__importDefault(require("path"));
|
|
10
9
|
const compileSchemaConfigProject_1 = require("../ConnectionManager/compileSchemaConfigProject");
|
|
11
|
-
const
|
|
10
|
+
const cliTemplateFiles_1 = require("./cliTemplateFiles");
|
|
12
11
|
const ensureCliDatabases_1 = require("./ensureCliDatabases");
|
|
13
12
|
const usage = `Usage:
|
|
14
13
|
prostgles create <directory> [--skip-install]
|
|
@@ -39,41 +38,12 @@ const createConfig = (targetPath, skipInstall) => {
|
|
|
39
38
|
if ((0, fs_1.existsSync)(targetPath) && (0, fs_1.readdirSync)(targetPath).length) {
|
|
40
39
|
throw new Error(`${targetPath} already exists and is not empty`);
|
|
41
40
|
}
|
|
42
|
-
(0, fs_1.mkdirSync)(path_1.default.join(targetPath, "src"), { recursive: true });
|
|
43
|
-
(0, fs_1.mkdirSync)(path_1.default.join(targetPath, "generated"), { recursive: true });
|
|
44
|
-
(0, fs_1.mkdirSync)(path_1.default.join(targetPath, cliUtils_1.testsFolderName), { recursive: true });
|
|
45
|
-
cliUtils_1.srcSubfolderNames.forEach((folderName) => {
|
|
46
|
-
(0, fs_1.mkdirSync)(path_1.default.join(targetPath, cliUtils_1.srcFolderName, folderName));
|
|
47
|
-
});
|
|
48
41
|
const packageName = path_1.default
|
|
49
42
|
.basename(targetPath)
|
|
50
43
|
.replace(/[^a-z0-9-]/gi, "-")
|
|
51
44
|
.toLowerCase();
|
|
52
45
|
const configId = packageName || "my-prostgles-app";
|
|
53
|
-
(0,
|
|
54
|
-
name: configId,
|
|
55
|
-
...cliUtils_1.cliTemplateFiles.package,
|
|
56
|
-
}, null, 2) + "\n");
|
|
57
|
-
(0, fs_1.writeFileSync)(path_1.default.join(targetPath, "tsconfig.json"), JSON.stringify(cliUtils_1.cliTemplateFiles.tsconfig, null, 2) + "\n");
|
|
58
|
-
(0, fs_1.writeFileSync)(path_1.default.join(targetPath, "eslint.config.mjs"), cliUtils_1.cliTemplateFiles.eslintConfig);
|
|
59
|
-
(0, fs_1.writeFileSync)(path_1.default.join(targetPath, cliUtils_1.generatedFolderName, "DBGeneratedSchema.ts"), cliUtils_1.cliTemplateFiles.DBGeneratedSchema);
|
|
60
|
-
(0, fs_1.writeFileSync)(path_1.default.join(targetPath, "AGENTS.md"), cliUtils_1.cliTemplateFiles.agents);
|
|
61
|
-
(0, fs_1.writeFileSync)(path_1.default.join(targetPath, cliUtils_1.testsFolderName, "deployment.test.ts"), cliUtils_1.cliTemplateFiles.deploymentTest({ configId }));
|
|
62
|
-
(0, fs_1.writeFileSync)(path_1.default.join(targetPath, cliUtils_1.srcFolderName, "index.ts"), (0, utils_1.fixIndent)(`
|
|
63
|
-
import { defineConfig } from "@prostgles/prostgles";
|
|
64
|
-
import type { DBGeneratedSchema } from "../${cliUtils_1.generatedFolderName}/DBGeneratedSchema";
|
|
65
|
-
|
|
66
|
-
const prostgles = defineConfig<DBGeneratedSchema>();
|
|
67
|
-
|
|
68
|
-
export default prostgles({
|
|
69
|
-
id: ${JSON.stringify(configId)},
|
|
70
|
-
connection: {
|
|
71
|
-
table_options: {},
|
|
72
|
-
},
|
|
73
|
-
tableConfig: {},
|
|
74
|
-
});`));
|
|
75
|
-
(0, fs_1.writeFileSync)(path_1.default.join(targetPath, ".env.example"), cliUtils_1.cliTemplateFiles.envExample({ configId }));
|
|
76
|
-
(0, fs_1.writeFileSync)(path_1.default.join(targetPath, ".gitignore"), cliUtils_1.cliTemplateFiles.gitignore);
|
|
46
|
+
(0, cliTemplateFiles_1.saveCliTemplateFiles)({ configId, targetPath });
|
|
77
47
|
if (skipInstall) {
|
|
78
48
|
console.log(`Created config project in ${targetPath}. Run npm install, copy .env.example to .env, configure both database URLs, then run npm run dev.`);
|
|
79
49
|
return;
|
|
@@ -122,12 +92,12 @@ const watchConfig = (configPath, onChange) => {
|
|
|
122
92
|
.filter((entry) => entry.isDirectory() && entry.name !== "node_modules")
|
|
123
93
|
.forEach((entry) => visit(path_1.default.join(directory, entry.name)));
|
|
124
94
|
};
|
|
125
|
-
visit(path_1.default.join(configPath,
|
|
95
|
+
visit(path_1.default.join(configPath, cliTemplateFiles_1.srcFolderName));
|
|
126
96
|
return () => watchers.forEach((watcher) => watcher.close());
|
|
127
97
|
};
|
|
128
98
|
const run = async (configPath, isDev) => {
|
|
129
99
|
const environment = validateEnvironmentSetup(configPath);
|
|
130
|
-
(0, fs_1.mkdirSync)(path_1.default.join(configPath,
|
|
100
|
+
(0, fs_1.mkdirSync)(path_1.default.join(configPath, cliTemplateFiles_1.generatedFolderName), { recursive: true });
|
|
131
101
|
await (0, compileSchemaConfigProject_1.compileSchemaConfigProject)(configPath);
|
|
132
102
|
await (0, ensureCliDatabases_1.ensureCliDatabases)(environment);
|
|
133
103
|
let server;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"cli.js","sourceRoot":"","sources":["../../../../src/cli/cli.ts"],"names":[],"mappings":";;;;AAEA,
|
|
1
|
+
{"version":3,"file":"cli.js","sourceRoot":"","sources":["../../../../src/cli/cli.ts"],"names":[],"mappings":";;;;AAEA,iDAAoE;AACpE,mCAA+B;AAC/B,2BAA6E;AAC7E,wDAAwB;AACxB,gGAA6F;AAC7F,yDAI4B;AAC5B,6DAA0D;AAE1D,MAAM,KAAK,GAAG;;;yCAG2B,CAAC;AAE1C,MAAM,aAAa,GAAG,CAAC,IAAc,EAAE,EAAE;IACvC,MAAM,WAAW,GAAG,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;IAC7C,IAAI,WAAW,KAAK,CAAC,CAAC;QAAE,OAAO,OAAO,CAAC,GAAG,EAAE,CAAC;IAC7C,MAAM,UAAU,GAAG,IAAI,CAAC,WAAW,GAAG,CAAC,CAAC,CAAC;IACzC,IAAI,CAAC,UAAU;QAAE,MAAM,IAAI,KAAK,CAAC,+BAA+B,CAAC,CAAC;IAClE,OAAO,cAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;AAClC,CAAC,CAAC;AAEF,MAAM,UAAU,GAAG,OAAO,CAAC,QAAQ,KAAK,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC;AAEpE,MAAM,yBAAyB,GAAG,CAAC,UAAkB,EAAE,EAAE;IACvD,MAAM,MAAM,GAAG,IAAA,yBAAS,EAAC,UAAU,EAAE,CAAC,SAAS,CAAC,EAAE;QAChD,GAAG,EAAE,UAAU;QACf,KAAK,EAAE,SAAS;KACjB,CAAC,CAAC;IACH,IAAI,MAAM,CAAC,KAAK;QAAE,MAAM,MAAM,CAAC,KAAK,CAAC;IACrC,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACxB,MAAM,IAAI,KAAK,CAAC,kCAAkC,MAAM,CAAC,MAAM,IAAI,CAAC,EAAE,CAAC,CAAC;IAC1E,CAAC;AACH,CAAC,CAAC;AAEF,MAAM,YAAY,GAAG,CAAC,UAAkB,EAAE,WAAoB,EAAE,EAAE;IAChE,IAAI,IAAA,eAAU,EAAC,UAAU,CAAC,IAAI,IAAA,gBAAW,EAAC,UAAU,CAAC,CAAC,MAAM,EAAE,CAAC;QAC7D,MAAM,IAAI,KAAK,CAAC,GAAG,UAAU,kCAAkC,CAAC,CAAC;IACnE,CAAC;IAED,MAAM,WAAW,GAAG,cAAI;SACrB,QAAQ,CAAC,UAAU,CAAC;SACpB,OAAO,CAAC,cAAc,EAAE,GAAG,CAAC;SAC5B,WAAW,EAAE,CAAC;IACjB,MAAM,QAAQ,GAAG,WAAW,IAAI,kBAAkB,CAAC;IACnD,IAAA,uCAAoB,EAAC,EAAE,QAAQ,EAAE,UAAU,EAAE,CAAC,CAAC;IAE/C,IAAI,WAAW,EAAE,CAAC;QAChB,OAAO,CAAC,GAAG,CACT,6BAA6B,UAAU,mGAAmG,CAC3I,CAAC;QACF,OAAO;IACT,CAAC;IAED,yBAAyB,CAAC,UAAU,CAAC,CAAC;IACtC,OAAO,CAAC,GAAG,CACT,wDAAwD,UAAU,kFAAkF,CACrJ,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,oBAAoB,GAAG,CAAC,UAAkB,EAAE,EAAE;IAClD,MAAM,eAAe,GAAG,cAAI,CAAC,IAAI,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC;IACtD,OAAO,IAAA,eAAU,EAAC,eAAe,CAAC,CAAC,CAAC;QAChC,IAAA,cAAK,EAAC,IAAA,iBAAY,EAAC,eAAe,CAAC,CAAC;QACtC,CAAC,CAAC,EAAE,CAAC;AACT,CAAC,CAAC;AAEF,MAAM,wBAAwB,GAAG,CAAC,UAAkB,EAAE,EAAE;IACtD,MAAM,eAAe,GAAG,cAAI,CAAC,IAAI,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC;IACtD,IAAI,CAAC,IAAA,eAAU,EAAC,eAAe,CAAC,EAAE,CAAC;QACjC,OAAO,CAAC,IAAI,CACV,kCAAkC,eAAe,+DAA+D,CACjH,CAAC;IACJ,CAAC;IAED,MAAM,WAAW,GAAG,EAAE,GAAG,OAAO,CAAC,GAAG,EAAE,GAAG,oBAAoB,CAAC,UAAU,CAAC,EAAE,CAAC;IAC5E,MAAM,QAAQ,GAAG,CAAC,KAAyB,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;IACvE,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,4BAA4B,CAAC,EAAE,CAAC;QACxD,MAAM,IAAI,KAAK,CACb,wFAAwF,CACzF,CAAC;IACJ,CAAC;IACD,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,sBAAsB,CAAC,EAAE,CAAC;QAClD,MAAM,IAAI,KAAK,CACb,0EAA0E,CAC3E,CAAC;IACJ,CAAC;IACD,OAAO,WAGN,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,eAAe,GAAG,cAAI,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,EAAE,cAAc,CAAC,CAAC;AACnE,MAAM,eAAe,GAAG,cAAI,CAAC,OAAO,CAAC,cAAI,CAAC,OAAO,CAAC,eAAe,CAAC,EAAE,UAAU,CAAC,CAAC;AAEhF,MAAM,SAAS,GAAG,CAAC,UAAkB,EAAE,IAAkC,EAAE,EAAE,CAC3E,IAAA,qBAAK,EAAC,OAAO,CAAC,QAAQ,EAAE,CAAC,eAAe,CAAC,EAAE;IACzC,GAAG,EAAE,eAAe;IACpB,KAAK,EAAE,SAAS;IAChB,GAAG,EAAE;QACH,GAAG,oBAAoB,CAAC,UAAU,CAAC;QACnC,GAAG,OAAO,CAAC,GAAG;QACd,QAAQ,EAAE,IAAI;QACd,mBAAmB,EAAE,UAAU;KAChC;CACF,CAAC,CAAC;AAEL,MAAM,WAAW,GAAG,CAAC,UAAkB,EAAE,QAAoB,EAAE,EAAE;IAC/D,MAAM,QAAQ,GAA+B,EAAE,CAAC;IAChD,MAAM,KAAK,GAAG,CAAC,SAAiB,EAAE,EAAE;QAClC,QAAQ,CAAC,IAAI,CAAC,IAAA,UAAK,EAAC,SAAS,EAAE,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC;QAClD,IAAA,gBAAW,EAAC,SAAS,EAAE,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC;aAC5C,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,WAAW,EAAE,IAAI,KAAK,CAAC,IAAI,KAAK,cAAc,CAAC;aACvE,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,cAAI,CAAC,IAAI,CAAC,SAAS,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IACjE,CAAC,CAAC;IACF,KAAK,CAAC,cAAI,CAAC,IAAI,CAAC,UAAU,EAAE,gCAAa,CAAC,CAAC,CAAC;IAC5C,OAAO,GAAG,EAAE,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC;AAC9D,CAAC,CAAC;AAEF,MAAM,GAAG,GAAG,KAAK,EAAE,UAAkB,EAAE,KAAc,EAAE,EAAE;IACvD,MAAM,WAAW,GAAG,wBAAwB,CAAC,UAAU,CAAC,CAAC;IACzD,IAAA,cAAS,EAAC,cAAI,CAAC,IAAI,CAAC,UAAU,EAAE,sCAAmB,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IAC3E,MAAM,IAAA,uDAA0B,EAAC,UAAU,CAAC,CAAC;IAC7C,MAAM,IAAA,uCAAkB,EAAC,WAAW,CAAC,CAAC;IACtC,IAAI,MAAgC,CAAC;IACrC,IAAI,UAAU,GAAG,KAAK,CAAC;IACvB,MAAM,KAAK,GAAG,GAAG,EAAE;QACjB,MAAM,GAAG,SAAS,CAAC,UAAU,EAAE,KAAK,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC;QACrE,MAAM,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE;YACnC,IAAI,CAAC,UAAU,IAAI,CAAC,IAAI,IAAI,MAAM,CAAC;gBAAE,OAAO,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC;QAC/D,CAAC,CAAC,CAAC;IACL,CAAC,CAAC;IACF,MAAM,IAAI,GAAG,KAAK,IAAI,EAAE;QACtB,MAAM,aAAa,GAAG,MAAM,CAAC;QAC7B,MAAM,GAAG,SAAS,CAAC;QACnB,IAAI,CAAC,aAAa,IAAI,aAAa,CAAC,MAAM;YAAE,OAAO;QACnD,aAAa,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAC9B,MAAM,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,EAAE,CAAC,aAAa,CAAC,IAAI,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;IAC5E,CAAC,CAAC;IACF,KAAK,EAAE,CAAC;IAER,IAAI,aAAa,GAAG,SAAqC,CAAC;IAC1D,MAAM,OAAO,GAAG,GAAG,EAAE;QACnB,aAAa,EAAE,EAAE,CAAC;QAClB,KAAK,IAAI,EAAE,CAAC;IACd,CAAC,CAAC;IACF,OAAO,CAAC,IAAI,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;IAChC,OAAO,CAAC,IAAI,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;IAEjC,IAAI,CAAC,KAAK;QAAE,OAAO;IACnB,IAAI,KAAiC,CAAC;IACtC,MAAM,OAAO,GAAG,GAAG,EAAE;QACnB,IAAI,KAAK;YAAE,YAAY,CAAC,KAAK,CAAC,CAAC;QAC/B,KAAK,GAAG,UAAU,CAAC,GAAG,EAAE;YACtB,KAAK,CAAC,KAAK,IAAI,EAAE;gBACf,IAAI,CAAC;oBACH,MAAM,IAAA,uDAA0B,EAAC,UAAU,CAAC,CAAC;oBAC7C,UAAU,GAAG,IAAI,CAAC;oBAClB,MAAM,IAAI,EAAE,CAAC;oBACb,UAAU,GAAG,KAAK,CAAC;oBACnB,KAAK,EAAE,CAAC;gBACV,CAAC;gBAAC,OAAO,KAAK,EAAE,CAAC;oBACf,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;gBACvB,CAAC;YACH,CAAC,CAAC,EAAE,CAAC;QACP,CAAC,EAAE,GAAG,CAAC,CAAC;IACV,CAAC,CAAC;IAEF,aAAa,GAAG,WAAW,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;AACnD,CAAC,CAAC;AAEF,MAAM,IAAI,GAAG,KAAK,IAAI,EAAE;IACtB,MAAM,CAAC,OAAO,EAAE,GAAG,IAAI,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IACjD,IAAI,OAAO,KAAK,QAAQ,EAAE,CAAC;QACzB,MAAM,MAAM,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;QACvB,IAAI,CAAC,MAAM,IAAI,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC;YAAE,MAAM,IAAI,KAAK,CAAC,KAAK,CAAC,CAAC;QAC9D,YAAY,CAAC,cAAI,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,IAAI,CAAC,QAAQ,CAAC,gBAAgB,CAAC,CAAC,CAAC;QACpE,OAAO;IACT,CAAC;IACD,IAAI,OAAO,KAAK,KAAK,IAAI,OAAO,KAAK,OAAO,EAAE,CAAC;QAC7C,MAAM,GAAG,CAAC,aAAa,CAAC,IAAI,CAAC,EAAE,OAAO,KAAK,KAAK,CAAC,CAAC;QAClD,OAAO;IACT,CAAC;IACD,MAAM,IAAI,KAAK,CAAC,KAAK,CAAC,CAAC;AACzB,CAAC,CAAC;AAEF,KAAK,IAAI,EAAE,CAAC,KAAK,CAAC,CAAC,KAAc,EAAE,EAAE;IACnC,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IACrB,OAAO,CAAC,QAAQ,GAAG,CAAC,CAAC;AACvB,CAAC,CAAC,CAAC"}
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
export declare const saveCliTemplateFiles: ({ configId, targetPath, }: {
|
|
2
|
+
configId: string;
|
|
3
|
+
targetPath: string;
|
|
4
|
+
}) => void;
|
|
5
|
+
export declare const srcFolderName = "src";
|
|
6
|
+
export declare const generatedFolderName = "generated";
|
|
7
|
+
export declare const srcSubfolderNames: readonly ["functions", "tableConfigs", "tableOptions", "tableHooks", "services"];
|
|
8
|
+
//# sourceMappingURL=cliTemplateFiles.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"cliTemplateFiles.d.ts","sourceRoot":"","sources":["../../../../src/cli/cliTemplateFiles.ts"],"names":[],"mappings":"AAQA,eAAO,MAAM,oBAAoB,GAAI,2BAGlC;IACD,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,MAAM,CAAC;CACpB,SAEA,CAAC;AAEF,eAAO,MAAM,aAAa,QAAQ,CAAC;AACnC,eAAO,MAAM,mBAAmB,cAAc,CAAC;AAI/C,eAAO,MAAM,iBAAiB,kFAMpB,CAAC"}
|
|
@@ -0,0 +1,381 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.srcSubfolderNames = exports.generatedFolderName = exports.srcFolderName = exports.saveCliTemplateFiles = void 0;
|
|
4
|
+
const tslib_1 = require("tslib");
|
|
5
|
+
const utils_1 = require("../../../common/utils");
|
|
6
|
+
const crypto_1 = require("crypto");
|
|
7
|
+
const package_json_1 = tslib_1.__importDefault(require("../../package.json"));
|
|
8
|
+
const prostgles_types_1 = require("prostgles-types");
|
|
9
|
+
const path_1 = require("path");
|
|
10
|
+
const fs_1 = require("fs");
|
|
11
|
+
const saveCliTemplateFiles = ({ configId, targetPath, }) => {
|
|
12
|
+
saveFolderFiles(targetPath, getCliTemplateFiles({ configId }));
|
|
13
|
+
};
|
|
14
|
+
exports.saveCliTemplateFiles = saveCliTemplateFiles;
|
|
15
|
+
exports.srcFolderName = "src";
|
|
16
|
+
exports.generatedFolderName = "generated";
|
|
17
|
+
const testsFolderName = "tests";
|
|
18
|
+
const servicesFolderName = "services";
|
|
19
|
+
exports.srcSubfolderNames = [
|
|
20
|
+
"functions",
|
|
21
|
+
"tableConfigs",
|
|
22
|
+
"tableOptions",
|
|
23
|
+
"tableHooks",
|
|
24
|
+
servicesFolderName,
|
|
25
|
+
];
|
|
26
|
+
const saveFolderFiles = (targetPath, folderFiles) => {
|
|
27
|
+
for (const [relativePath, content] of Object.entries(folderFiles)) {
|
|
28
|
+
const fullPath = (0, path_1.join)(targetPath, relativePath);
|
|
29
|
+
const fullPathDirectory = (0, path_1.dirname)(fullPath);
|
|
30
|
+
if (typeof content === "string") {
|
|
31
|
+
(0, fs_1.mkdirSync)(fullPathDirectory, { recursive: true });
|
|
32
|
+
(0, fs_1.writeFileSync)(fullPath, (0, utils_1.fixIndent)(content));
|
|
33
|
+
}
|
|
34
|
+
else {
|
|
35
|
+
(0, fs_1.mkdirSync)(fullPath, { recursive: true });
|
|
36
|
+
saveFolderFiles(fullPath, content);
|
|
37
|
+
}
|
|
38
|
+
}
|
|
39
|
+
};
|
|
40
|
+
const getCliTemplateFiles = ({ configId }) => ({
|
|
41
|
+
"package.json": JSON.stringify(getPackageJson(configId), null, 2) + "\n",
|
|
42
|
+
"tsconfig.json": JSON.stringify({
|
|
43
|
+
compilerOptions: {
|
|
44
|
+
target: "ES2022",
|
|
45
|
+
module: "Node16",
|
|
46
|
+
moduleResolution: "Node16",
|
|
47
|
+
rootDir: ".",
|
|
48
|
+
outDir: "build",
|
|
49
|
+
esModuleInterop: true,
|
|
50
|
+
forceConsistentCasingInFileNames: true,
|
|
51
|
+
noImplicitAny: true,
|
|
52
|
+
noUncheckedIndexedAccess: true,
|
|
53
|
+
skipLibCheck: true,
|
|
54
|
+
strict: true,
|
|
55
|
+
strictFunctionTypes: true,
|
|
56
|
+
},
|
|
57
|
+
include: [exports.srcFolderName, exports.generatedFolderName, testsFolderName],
|
|
58
|
+
exclude: [`${exports.srcFolderName}/services/**/src`],
|
|
59
|
+
}, null, 2) + "\n",
|
|
60
|
+
"AGENTS.md": getCliAgentsFile(),
|
|
61
|
+
[exports.generatedFolderName]: {
|
|
62
|
+
"DBGeneratedSchema.ts": "export type DBGeneratedSchema = Record<string, { columns: Record<string, unknown> }>\n",
|
|
63
|
+
},
|
|
64
|
+
[exports.srcFolderName]: {
|
|
65
|
+
...(0, prostgles_types_1.fromEntries)(exports.srcSubfolderNames.map((folderName) => [folderName, {}])),
|
|
66
|
+
"index.ts": `
|
|
67
|
+
import { defineConfig } from "@prostgles/prostgles";
|
|
68
|
+
import type { DBGeneratedSchema } from "../${exports.generatedFolderName}/DBGeneratedSchema";
|
|
69
|
+
|
|
70
|
+
const prostgles = defineConfig<DBGeneratedSchema>();
|
|
71
|
+
|
|
72
|
+
export default prostgles({
|
|
73
|
+
id: ${JSON.stringify(configId)},
|
|
74
|
+
connection: {
|
|
75
|
+
table_options: {},
|
|
76
|
+
},
|
|
77
|
+
tableConfig: {},
|
|
78
|
+
});`,
|
|
79
|
+
[servicesFolderName]: {
|
|
80
|
+
myService: {
|
|
81
|
+
"myService.service.ts": `
|
|
82
|
+
import type { ProstglesService } from "@prostgles/prostgles/services";
|
|
83
|
+
|
|
84
|
+
export const myService = {
|
|
85
|
+
buildContext: "myService",
|
|
86
|
+
icon: "Extension",
|
|
87
|
+
label: "My service",
|
|
88
|
+
description: "Example local Docker service.",
|
|
89
|
+
port: 8080,
|
|
90
|
+
healthCheck: { endpoint: "/health" },
|
|
91
|
+
endpoints: {},
|
|
92
|
+
} as const satisfies ProstglesService;`,
|
|
93
|
+
src: {
|
|
94
|
+
Dockerfile: `
|
|
95
|
+
FROM python:3.13-alpine
|
|
96
|
+
|
|
97
|
+
EXPOSE 8080
|
|
98
|
+
|
|
99
|
+
CMD ["python", "-m", "http.server", "8080", "--bind", "0.0.0.0"]`,
|
|
100
|
+
},
|
|
101
|
+
},
|
|
102
|
+
},
|
|
103
|
+
"serviceManager.ts": `
|
|
104
|
+
import { ServiceManager } from "@prostgles/prostgles/services";
|
|
105
|
+
import { myService } from "./services/myService/myService.service";
|
|
106
|
+
import path from "node:path";
|
|
107
|
+
|
|
108
|
+
export const serviceManager = new ServiceManager({
|
|
109
|
+
services: { myService },
|
|
110
|
+
serviceRoot: path.resolve(__dirname, "..", "..", "src", "services"),
|
|
111
|
+
});`,
|
|
112
|
+
},
|
|
113
|
+
[testsFolderName]: {
|
|
114
|
+
"deployment.test.ts": `
|
|
115
|
+
import assert from "node:assert/strict";
|
|
116
|
+
import { resolve } from "node:path";
|
|
117
|
+
import test from "node:test";
|
|
118
|
+
import { createTestDeployment } from "@prostgles/prostgles/testing";
|
|
119
|
+
import type { DBGeneratedSchema } from "../generated/DBGeneratedSchema";
|
|
120
|
+
|
|
121
|
+
void test("starts the configured app with an isolated database", async (context) => {
|
|
122
|
+
const deployment = await createTestDeployment<DBGeneratedSchema>({
|
|
123
|
+
configPath: resolve(__dirname, "../.."),
|
|
124
|
+
configId: ${JSON.stringify(configId)},
|
|
125
|
+
users: [
|
|
126
|
+
{ key: "admin", type: "admin" },
|
|
127
|
+
{ key: "member", type: "default" },
|
|
128
|
+
],
|
|
129
|
+
// Add deterministic rows with:
|
|
130
|
+
// seed: async ({ projectDatabase }) => {
|
|
131
|
+
// await projectDatabase.query("INSERT INTO ...");
|
|
132
|
+
// },
|
|
133
|
+
});
|
|
134
|
+
context.after(async () => await deployment.dispose());
|
|
135
|
+
|
|
136
|
+
const client = await deployment.connectProjectAs("admin");
|
|
137
|
+
|
|
138
|
+
assert.equal(client.socket.connected, true);
|
|
139
|
+
assert.equal(client.auth.user?.type, "admin");
|
|
140
|
+
assert.ok(client.db);
|
|
141
|
+
|
|
142
|
+
const memberClient = await deployment.connectProjectAs("member");
|
|
143
|
+
assert.equal(memberClient.socket.connected, true);
|
|
144
|
+
assert.equal(memberClient.auth.user?.type, "default");
|
|
145
|
+
});`,
|
|
146
|
+
},
|
|
147
|
+
"eslint.config.mjs": eslintConfig,
|
|
148
|
+
".gitignore": `
|
|
149
|
+
node_modules/
|
|
150
|
+
build/
|
|
151
|
+
.env
|
|
152
|
+
.prostgles/test-logs/
|
|
153
|
+
*.log`,
|
|
154
|
+
".env.example": `
|
|
155
|
+
# Fixed admin credentials for CLI development.
|
|
156
|
+
PRGL_USERNAME=admin
|
|
157
|
+
PRGL_PASSWORD=${(0, crypto_1.randomBytes)(24).toString("base64url")}
|
|
158
|
+
|
|
159
|
+
# Prostgles UI state. Created automatically when missing.
|
|
160
|
+
PROSTGLES_STATE_DATABASE_URL=postgres://user:password@localhost:5432/prostgles_state_database
|
|
161
|
+
|
|
162
|
+
# Database exposed by this config. Must use the same server as the state database.
|
|
163
|
+
PROSTGLES_DATABASE_URL=postgres://user:password@localhost:5432/${configId}
|
|
164
|
+
|
|
165
|
+
# npm test starts an ephemeral PostgreSQL Docker container bound to 127.0.0.1 only.
|
|
166
|
+
# Override only when the app needs a different PostgreSQL/PostGIS version.
|
|
167
|
+
# PROSTGLES_TEST_POSTGRES_IMAGE=postgis/postgis:17-3.4`,
|
|
168
|
+
});
|
|
169
|
+
const getPackageJson = (configId) => ({
|
|
170
|
+
name: configId,
|
|
171
|
+
private: true,
|
|
172
|
+
version: "0.0.0",
|
|
173
|
+
main: "build/src/index.js",
|
|
174
|
+
scripts: {
|
|
175
|
+
build: "npm run lint && tsc --project tsconfig.json",
|
|
176
|
+
dev: "prostgles dev --config .",
|
|
177
|
+
lint: "eslint .",
|
|
178
|
+
"lint:fix": "eslint . --fix",
|
|
179
|
+
start: "prostgles start --config .",
|
|
180
|
+
test: 'npm run build && node --env-file-if-exists=.env --test "build/tests/**/*.test.js"',
|
|
181
|
+
},
|
|
182
|
+
dependencies: { [package_json_1.default.name]: `^${package_json_1.default.version}` },
|
|
183
|
+
devDependencies: {
|
|
184
|
+
...(0, prostgles_types_1.pickKeys)(package_json_1.default.dependencies, ["typescript"]),
|
|
185
|
+
...(0, prostgles_types_1.pickKeys)(package_json_1.default.devDependencies, [
|
|
186
|
+
"@eslint/js",
|
|
187
|
+
"eslint",
|
|
188
|
+
"eslint-plugin-security",
|
|
189
|
+
"typescript-eslint",
|
|
190
|
+
"@types/node",
|
|
191
|
+
]),
|
|
192
|
+
},
|
|
193
|
+
exports: {
|
|
194
|
+
"./generated": {
|
|
195
|
+
types: "./build/generated/index.d.ts",
|
|
196
|
+
default: "./build/generated/index.js",
|
|
197
|
+
},
|
|
198
|
+
},
|
|
199
|
+
});
|
|
200
|
+
const eslintConfig = `
|
|
201
|
+
import eslint from "@eslint/js";
|
|
202
|
+
import pluginSecurity from "eslint-plugin-security";
|
|
203
|
+
import path from "node:path";
|
|
204
|
+
import tseslint from "typescript-eslint";
|
|
205
|
+
import { defineConfig } from "eslint/config";
|
|
206
|
+
|
|
207
|
+
const semanticFilenameRule = {
|
|
208
|
+
meta: {
|
|
209
|
+
type: "problem",
|
|
210
|
+
schema: [{ type: "string" }],
|
|
211
|
+
messages: {
|
|
212
|
+
invalidSuffix: "Files in this folder must end in '{{suffix}}'.",
|
|
213
|
+
},
|
|
214
|
+
},
|
|
215
|
+
create(context) {
|
|
216
|
+
const suffix = context.options[0];
|
|
217
|
+
return {
|
|
218
|
+
Program(node) {
|
|
219
|
+
if (!path.basename(context.filename).endsWith(suffix)) {
|
|
220
|
+
context.report({
|
|
221
|
+
node,
|
|
222
|
+
messageId: "invalidSuffix",
|
|
223
|
+
data: { suffix },
|
|
224
|
+
});
|
|
225
|
+
}
|
|
226
|
+
},
|
|
227
|
+
};
|
|
228
|
+
},
|
|
229
|
+
};
|
|
230
|
+
|
|
231
|
+
const semanticFileConfig = (folder, suffix) => ({
|
|
232
|
+
files: [\`${exports.srcFolderName}/\${folder}/**/*.ts\`],
|
|
233
|
+
rules: {
|
|
234
|
+
"prostgles-config/semantic-filename": ["error", suffix],
|
|
235
|
+
},
|
|
236
|
+
});
|
|
237
|
+
|
|
238
|
+
export default defineConfig(
|
|
239
|
+
{
|
|
240
|
+
ignores: [
|
|
241
|
+
"build",
|
|
242
|
+
"${exports.generatedFolderName}",
|
|
243
|
+
"node_modules",
|
|
244
|
+
"eslint.config.mjs",
|
|
245
|
+
"src/${servicesFolderName}/*/src",
|
|
246
|
+
],
|
|
247
|
+
},
|
|
248
|
+
// eslint-disable-next-line @typescript-eslint/no-unsafe-argument
|
|
249
|
+
pluginSecurity.configs.recommended,
|
|
250
|
+
eslint.configs.recommended,
|
|
251
|
+
tseslint.configs.recommendedTypeChecked,
|
|
252
|
+
{
|
|
253
|
+
files: ["${exports.srcFolderName}/**/*.ts", "${testsFolderName}/**/*.ts"],
|
|
254
|
+
languageOptions: {
|
|
255
|
+
parserOptions: {
|
|
256
|
+
projectService: true,
|
|
257
|
+
tsconfigRootDir: import.meta.dirname,
|
|
258
|
+
},
|
|
259
|
+
},
|
|
260
|
+
plugins: {
|
|
261
|
+
"prostgles-config": {
|
|
262
|
+
rules: { "semantic-filename": semanticFilenameRule },
|
|
263
|
+
},
|
|
264
|
+
},
|
|
265
|
+
rules: {
|
|
266
|
+
"no-cond-assign": "error",
|
|
267
|
+
"no-unused-vars": "off",
|
|
268
|
+
"security/detect-object-injection": "off",
|
|
269
|
+
"@typescript-eslint/no-explicit-any": "off",
|
|
270
|
+
"@typescript-eslint/no-floating-promises": "error",
|
|
271
|
+
"@typescript-eslint/no-unnecessary-condition": "error",
|
|
272
|
+
"@typescript-eslint/no-unused-vars": [
|
|
273
|
+
"error",
|
|
274
|
+
{
|
|
275
|
+
argsIgnorePattern: "^_",
|
|
276
|
+
varsIgnorePattern: "^_",
|
|
277
|
+
caughtErrorsIgnorePattern: "^_",
|
|
278
|
+
},
|
|
279
|
+
],
|
|
280
|
+
},
|
|
281
|
+
},
|
|
282
|
+
${exports.srcSubfolderNames
|
|
283
|
+
.filter((f) => f !== "services")
|
|
284
|
+
.map((folderName) => `semanticFileConfig("${folderName}", ".${folderName.slice(0, -1)}.ts")`)
|
|
285
|
+
.join(",\n ")}
|
|
286
|
+
);`;
|
|
287
|
+
/**
|
|
288
|
+
* This exhaustive map keeps the generated guidance in step with SchemaConfig.
|
|
289
|
+
* Adding or removing a config property requires its guidance to be updated too.
|
|
290
|
+
*/
|
|
291
|
+
const schemaConfigGuidance = {
|
|
292
|
+
access_control: "Configure database permissions with `access_control` using the Prostgles `dbPermissions` shape.",
|
|
293
|
+
connection: "Keep non-secret connection presentation settings in `connection`; database URLs belong in `.env`.",
|
|
294
|
+
databaseConfig: "Use `databaseConfig` for host-managed database features such as file storage and REST access.",
|
|
295
|
+
functions: "Put privileged operations, cross-table workflows, and server-only business logic in top-level `functions`.",
|
|
296
|
+
id: "Keep `id` stable because it identifies the deployed configuration.",
|
|
297
|
+
joins: "Use `joins` only for relationships that cannot be inferred from foreign keys.",
|
|
298
|
+
onInitSQL: "Use `onInitSQL` only for SQL initialization that cannot be expressed by `tableConfig`.",
|
|
299
|
+
onMount: "Use `onMount` for startup integration work and return cleanup logic when resources are opened.",
|
|
300
|
+
tableConfig: "Define tables and columns in `tableConfig`, including constraints and indexes.",
|
|
301
|
+
tableConfigMigrations: "For schema changes that transform existing data, increment `tableConfigMigrations.version` and use `onMigrate`.",
|
|
302
|
+
tableHooks: "Define `tableHooks` as a separate top-level config property.",
|
|
303
|
+
watchSchemaType: "Set `watchSchemaType` only when schema watching must differ from the default.",
|
|
304
|
+
workspaces: "Define typed `workspaces` as useful default dashboards that bring related data together.",
|
|
305
|
+
};
|
|
306
|
+
const connectionGuidance = {
|
|
307
|
+
db_schema_filter: "Use `connection.db_schema_filter` only for connection-level schema visibility.",
|
|
308
|
+
display_options: "Use `connection.display_options` for connection-wide display behavior.",
|
|
309
|
+
table_options: "Populate `connection.table_options` for every user-facing table so data renders clearly. Add useful labels and icons, column renderers and styles, and a practical `card` layout with header, subheader, avatar, and visible columns where appropriate.",
|
|
310
|
+
};
|
|
311
|
+
const getCliAgentsFile = () => `
|
|
312
|
+
# Prostgles configuration
|
|
313
|
+
|
|
314
|
+
Build the application around the typed Prostgles schema config.
|
|
315
|
+
|
|
316
|
+
## Config structure
|
|
317
|
+
|
|
318
|
+
- Import \`DBGeneratedSchema\` from \`generated/DBGeneratedSchema\`, create the typed config helper with \`const prostgles = defineConfig<DBGeneratedSchema>()\`, and default-export \`prostgles({ ... })\`. Keep the helper name \`prostgles\` so function return types can be discovered during schema generation.
|
|
319
|
+
- Run \`npm run dev\` after schema or function changes. It rebuilds the config and refreshes \`generated/DBGeneratedSchema.ts\`, including \`GeneratedFunctionSchema\` for clients.
|
|
320
|
+
- ${schemaConfigGuidance.id}
|
|
321
|
+
- ${schemaConfigGuidance.connection} ${connectionGuidance.db_schema_filter} ${connectionGuidance.display_options}
|
|
322
|
+
- ${schemaConfigGuidance.databaseConfig}
|
|
323
|
+
- ${schemaConfigGuidance.access_control}
|
|
324
|
+
- ${schemaConfigGuidance.watchSchemaType}
|
|
325
|
+
- ${schemaConfigGuidance.onInitSQL} ${schemaConfigGuidance.onMount}
|
|
326
|
+
|
|
327
|
+
## Typed database object
|
|
328
|
+
|
|
329
|
+
- The Prostgles \`dbo\` object available in \`onMount\`, \`tableHooks\`, and server functions is \`DBOFullyTyped<DBGeneratedSchema>\`. Table names, columns, filters, selects, inserts, updates, and results are fully typed.
|
|
330
|
+
- Keep the schema generic connected when moving code into separate modules. Use \`ProstglesOnMount<DBGeneratedSchema>\` for \`onMount\`, \`TableHooks<DBGeneratedSchema>\` for hooks, and the typed function definers for functions.
|
|
331
|
+
- Prefer typed \`dbo\` table handlers and let TypeScript infer values. Casts should be very rare; before adding one, check the table definition, JSONB schema, generated schema, and helper generic.
|
|
332
|
+
- Every table and view handler supports realtime \`subscribe\` and \`subscribeOne\`, for example \`dbo.orders.subscribe(filter, params, onData)\`. Prefer subscriptions over polling the database. Keep the returned subscription handler and call \`unsubscribe()\` during cleanup; an \`onMount\` callback can return that cleanup function.
|
|
333
|
+
|
|
334
|
+
## Project structure
|
|
335
|
+
|
|
336
|
+
- Keep \`src/index.ts\` focused on composing and exporting the config.
|
|
337
|
+
- Put server functions in \`src/functions/\`, table definitions in \`src/tableConfigs/\`, display metadata in \`src/tableOptions/\`, and hooks in \`src/tableHooks/\`. Add domain subfolders when a folder becomes crowded.
|
|
338
|
+
- Use semantic names ending in \`*.function.ts\`, \`*.tableConfig.ts\`, \`*.tableOptions.ts\`, and \`*.tableHooks.ts\`. Examples: \`deployProject.function.ts\`, \`orders.tableConfig.ts\`, \`customers.tableOptions.ts\`, and \`users.tableHooks.ts\`.
|
|
339
|
+
- The generated ESLint config enforces these suffixes inside their corresponding folders. Run \`npm run lint\` before committing.
|
|
340
|
+
|
|
341
|
+
## Tests
|
|
342
|
+
|
|
343
|
+
- Run \`npm test\` before committing. Tests use \`@prostgles/prostgles/testing\` to start the real app against fresh state and project databases without opening the UI.
|
|
344
|
+
- Keep deployment tests in \`tests/\`. Each call to \`createTestDeployment\` starts a disposable PostgreSQL Docker container bound only to \`127.0.0.1\`, creates fresh state and project databases, and removes the container during cleanup.
|
|
345
|
+
- Deployment stdout and stderr remain available after cleanup in \`.prostgles/test-logs/\`. The exact file is returned as \`deployment.logPath\`.
|
|
346
|
+
- Test logs may be large. Inspect them with \`tail\` or search them with \`rg\`; do not read an entire log unless its size is known to be small.
|
|
347
|
+
- If the deployment fixture blocks a valid scenario, inspect \`deployment.logPath\` and report the issue against \`@prostgles/prostgles\`; do not weaken the app or its assertions to work around the fixture.
|
|
348
|
+
- Add test users through the fixture's \`users\` option and connect with \`connectProjectAs(userKey)\`. Sessions are seeded directly, so deployment tests do not need to exercise the login UI.
|
|
349
|
+
- Add deterministic database state with the fixture's \`seed\` callback. Never use development or production database URLs for test setup.
|
|
350
|
+
|
|
351
|
+
## Tables, display options, and hooks
|
|
352
|
+
|
|
353
|
+
- ${schemaConfigGuidance.tableConfig} ${schemaConfigGuidance.tableConfigMigrations}
|
|
354
|
+
- ${schemaConfigGuidance.tableHooks} Use hooks such as \`beforeEach\`, \`afterEach\`, and \`afterAll\` for application behavior instead of PostgreSQL triggers as this allows interaction with typescript and provides full type safety.
|
|
355
|
+
- ${connectionGuidance.table_options} Keep each table's options in its matching \`*.tableOptions.ts\` module and merge them under \`connection.table_options\`.
|
|
356
|
+
- Give every JSONB column a \`jsonbSchema\` or \`jsonbSchemaType\` so its contents are validated and typed.
|
|
357
|
+
- Follow PostgreSQL schema best practices: use primary and foreign keys, appropriate nullability, unique constraints, and indexes. Model fixed sets of values as lookup tables with \`isLookupTable\` and references instead of \`CHECK (value IN (...))\` constraints.
|
|
358
|
+
- ${schemaConfigGuidance.joins}
|
|
359
|
+
|
|
360
|
+
## Workspaces
|
|
361
|
+
|
|
362
|
+
- ${schemaConfigGuidance.workspaces} Include tables and, where useful, aggregate SQL results, bar charts, time charts, maps, and summary statistics.
|
|
363
|
+
- Keep window IDs stable and ensure every layout item references the matching window ID.
|
|
364
|
+
|
|
365
|
+
## File storage
|
|
366
|
+
|
|
367
|
+
- Enable managed file storage with \`databaseConfig.file_table_config\`. For local storage, use \`{ fileTable: "files", storageType: { type: "local" } }\`. Prostgles creates and manages the file table and serves its files.
|
|
368
|
+
- For S3 storage, use \`storageType: { type: "S3", credential_id }\`; configure the credential in Prostgles and never put access keys in this repository.
|
|
369
|
+
- Reference \`files.id\` from application tables with foreign keys rather than storing file URLs. Referencing tables must have a primary key. Use \`referencedTables\` when file type or size restrictions are required.
|
|
370
|
+
- Use \`delayedDelete\` when files should remain recoverable for a retention period. Enable \`extractText\` and provide an \`annotationsTable\` only when document extraction or annotations are needed.
|
|
371
|
+
- Local file data lives outside PostgreSQL. Use persistent storage and include it in deployment backups.
|
|
372
|
+
|
|
373
|
+
## Server-side functions
|
|
374
|
+
|
|
375
|
+
- ${schemaConfigGuidance.functions}
|
|
376
|
+
- Organize \`functions\` into groups shaped as \`{ userFilter, functions }\`. The group filter controls which authenticated users receive those functions.
|
|
377
|
+
- Create a schema-aware group helper with \`createFunctionGroupDefiner<DBGeneratedSchema>()\`. For function maps kept in separate modules, use \`createFunctionsDefiner<DBGeneratedSchema>()\` so names, database context, inputs, and return types remain inferred across imports.
|
|
378
|
+
- Define individual functions with \`defineFunction({ input, description, run })\`. Inputs use Prostgles JSONB field definitions and are validated before \`run\` executes.
|
|
379
|
+
- Functions have restricted database access by default. Set \`unrestrictedDbAccess: true\` only when the function needs raw SQL, transactions, or client DB-handler generation.
|
|
380
|
+
- Keep secrets on the server and use database transactions for multi-step writes.`;
|
|
381
|
+
//# sourceMappingURL=cliTemplateFiles.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"cliTemplateFiles.js","sourceRoot":"","sources":["../../../../src/cli/cliTemplateFiles.ts"],"names":[],"mappings":";;;;AAAA,yCAA0C;AAC1C,mCAAqC;AAErC,8EAA6C;AAC7C,qDAAwD;AACxD,+BAAqC;AACrC,2BAA8C;AAEvC,MAAM,oBAAoB,GAAG,CAAC,EACnC,QAAQ,EACR,UAAU,GAIX,EAAE,EAAE;IACH,eAAe,CAAC,UAAU,EAAE,mBAAmB,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC,CAAC;AACjE,CAAC,CAAC;AARW,QAAA,oBAAoB,wBAQ/B;AAEW,QAAA,aAAa,GAAG,KAAK,CAAC;AACtB,QAAA,mBAAmB,GAAG,WAAW,CAAC;AAC/C,MAAM,eAAe,GAAG,OAAO,CAAC;AAEhC,MAAM,kBAAkB,GAAG,UAAU,CAAC;AACzB,QAAA,iBAAiB,GAAG;IAC/B,WAAW;IACX,cAAc;IACd,cAAc;IACd,YAAY;IACZ,kBAAkB;CACV,CAAC;AAMX,MAAM,eAAe,GAAG,CAAC,UAAkB,EAAE,WAAwB,EAAE,EAAE;IACvE,KAAK,MAAM,CAAC,YAAY,EAAE,OAAO,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE,CAAC;QAClE,MAAM,QAAQ,GAAG,IAAA,WAAI,EAAC,UAAU,EAAE,YAAY,CAAC,CAAC;QAChD,MAAM,iBAAiB,GAAG,IAAA,cAAO,EAAC,QAAQ,CAAC,CAAC;QAC5C,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE,CAAC;YAChC,IAAA,cAAS,EAAC,iBAAiB,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;YAClD,IAAA,kBAAa,EAAC,QAAQ,EAAE,IAAA,iBAAS,EAAC,OAAO,CAAC,CAAC,CAAC;QAC9C,CAAC;aAAM,CAAC;YACN,IAAA,cAAS,EAAC,QAAQ,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;YACzC,eAAe,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;QACrC,CAAC;IACH,CAAC;AACH,CAAC,CAAC;AAEF,MAAM,mBAAmB,GAAG,CAAC,EAAE,QAAQ,EAAwB,EAAE,EAAE,CACjE,CAAC;IACC,cAAc,EAAE,IAAI,CAAC,SAAS,CAAC,cAAc,CAAC,QAAQ,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,GAAG,IAAI;IACxE,eAAe,EACb,IAAI,CAAC,SAAS,CACZ;QACE,eAAe,EAAE;YACf,MAAM,EAAE,QAAQ;YAChB,MAAM,EAAE,QAAQ;YAChB,gBAAgB,EAAE,QAAQ;YAC1B,OAAO,EAAE,GAAG;YACZ,MAAM,EAAE,OAAO;YACf,eAAe,EAAE,IAAI;YACrB,gCAAgC,EAAE,IAAI;YACtC,aAAa,EAAE,IAAI;YACnB,wBAAwB,EAAE,IAAI;YAC9B,YAAY,EAAE,IAAI;YAClB,MAAM,EAAE,IAAI;YACZ,mBAAmB,EAAE,IAAI;SAC1B;QACD,OAAO,EAAE,CAAC,qBAAa,EAAE,2BAAmB,EAAE,eAAe,CAAC;QAC9D,OAAO,EAAE,CAAC,GAAG,qBAAa,kBAAkB,CAAC;KAC9C,EACD,IAAI,EACJ,CAAC,CACF,GAAG,IAAI;IACV,WAAW,EAAE,gBAAgB,EAAE;IAC/B,CAAC,2BAAmB,CAAC,EAAE;QACrB,sBAAsB,EACpB,wFAAwF;KAC3F;IACD,CAAC,qBAAa,CAAC,EAAE;QACf,GAAG,IAAA,6BAAW,EAAC,yBAAiB,CAAC,GAAG,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC,CAAC;QACvE,UAAU,EAAE;;qDAEmC,2BAAmB;;;;;gBAKxD,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC;;;;;YAK5B;QACN,CAAC,kBAAkB,CAAC,EAAE;YACpB,SAAS,EAAE;gBACT,sBAAsB,EAAE;;;;;;;;;;;mDAWiB;gBACzC,GAAG,EAAE;oBACH,UAAU,EAAE;;;;;+EAKuD;iBACpE;aACF;SACF;QACD,mBAAmB,EAAE;;;;;;;;YAQf;KACP;IACD,CAAC,eAAe,CAAC,EAAE;QACjB,oBAAoB,EAAE;;;;;;;;;;wBAUJ,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC;;;;;;;;;;;;;;;;;;;;;YAqBpC;KACP;IACD,mBAAmB,EAAE,YAAY;IACjC,YAAY,EAAE;;;;;YAKN;IACR,cAAc,EAAE;;;sBAGE,IAAA,oBAAW,EAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,WAAW,CAAC;;;;;;uEAMY,QAAQ;;;;6DAIlB;CAC1D,CAAU,CAAC;AAEd,MAAM,cAAc,GAAG,CAAC,QAAgB,EAAE,EAAE,CAAC,CAAC;IAC5C,IAAI,EAAE,QAAQ;IACd,OAAO,EAAE,IAAI;IACb,OAAO,EAAE,OAAO;IAChB,IAAI,EAAE,oBAAoB;IAC1B,OAAO,EAAE;QACP,KAAK,EAAE,6CAA6C;QACpD,GAAG,EAAE,0BAA0B;QAC/B,IAAI,EAAE,UAAU;QAChB,UAAU,EAAE,gBAAgB;QAC5B,KAAK,EAAE,4BAA4B;QACnC,IAAI,EAAE,mFAAmF;KAC1F;IACD,YAAY,EAAE,EAAE,CAAC,sBAAW,CAAC,IAAI,CAAC,EAAE,IAAI,sBAAW,CAAC,OAAO,EAAE,EAAE;IAC/D,eAAe,EAAE;QACf,GAAG,IAAA,0BAAQ,EAAC,sBAAW,CAAC,YAAY,EAAE,CAAC,YAAY,CAAC,CAAC;QACrD,GAAG,IAAA,0BAAQ,EAAC,sBAAW,CAAC,eAAe,EAAE;YACvC,YAAY;YACZ,QAAQ;YACR,wBAAwB;YACxB,mBAAmB;YACnB,aAAa;SACd,CAAC;KACH;IACD,OAAO,EAAE;QACP,aAAa,EAAE;YACb,KAAK,EAAE,8BAA8B;YACrC,OAAO,EAAE,4BAA4B;SACtC;KACF;CACF,CAAC,CAAC;AACH,MAAM,YAAY,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;gBAgCL,qBAAa;;;;;;;;;;WAUlB,2BAAmB;;;eAGf,kBAAkB;;;;;;;;iBAQhB,qBAAa,eAAe,eAAe;;;;;;;;;;;;;;;;;;;;;;;;;;;;;MA6BtD,yBAAiB;KAChB,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,UAAU,CAAC;KAC/B,GAAG,CACF,CAAC,UAAU,EAAE,EAAE,CACb,uBAAuB,UAAU,QAAQ,UAAU,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,OAAO,CAC1E;KACA,IAAI,CAAC,SAAS,CAAC;KACjB,CAAC;AAUN;;;GAGG;AACH,MAAM,oBAAoB,GAAG;IAC3B,cAAc,EACZ,iGAAiG;IACnG,UAAU,EACR,mGAAmG;IACrG,cAAc,EACZ,+FAA+F;IACjG,SAAS,EACP,4GAA4G;IAC9G,EAAE,EAAE,oEAAoE;IACxE,KAAK,EACH,+EAA+E;IACjF,SAAS,EACP,wFAAwF;IAC1F,OAAO,EACL,gGAAgG;IAClG,WAAW,EACT,gFAAgF;IAClF,qBAAqB,EACnB,iHAAiH;IACnH,UAAU,EAAE,8DAA8D;IAC1E,eAAe,EACb,+EAA+E;IACjF,UAAU,EACR,0FAA0F;CAC9D,CAAC;AAEjC,MAAM,kBAAkB,GAAG;IACzB,gBAAgB,EACd,gFAAgF;IAClF,eAAe,EACb,wEAAwE;IAC1E,aAAa,EACX,yPAAyP;CAC/N,CAAC;AAE/B,MAAM,gBAAgB,GAAG,GAAG,EAAE,CAAC;;;;;;;;;MASzB,oBAAoB,CAAC,EAAE;MACvB,oBAAoB,CAAC,UAAU,IAAI,kBAAkB,CAAC,gBAAgB,IAAI,kBAAkB,CAAC,eAAe;MAC5G,oBAAoB,CAAC,cAAc;MACnC,oBAAoB,CAAC,cAAc;MACnC,oBAAoB,CAAC,eAAe;MACpC,oBAAoB,CAAC,SAAS,IAAI,oBAAoB,CAAC,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;MA4B9D,oBAAoB,CAAC,WAAW,IAAI,oBAAoB,CAAC,qBAAqB;MAC9E,oBAAoB,CAAC,UAAU;MAC/B,kBAAkB,CAAC,aAAa;;;MAGhC,oBAAoB,CAAC,KAAK;;;;MAI1B,oBAAoB,CAAC,UAAU;;;;;;;;;;;;;MAa/B,oBAAoB,CAAC,SAAS;;;;;oFAKgD,CAAC"}
|