@objectql/cli 1.8.4 → 1.9.0

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 (80) hide show
  1. package/README.md +2 -2
  2. package/dist/commands/database-push.d.ts +5 -0
  3. package/dist/commands/database-push.js +15 -0
  4. package/dist/commands/database-push.js.map +1 -0
  5. package/dist/commands/dev.d.ts +2 -0
  6. package/dist/commands/dev.js +94 -6
  7. package/dist/commands/dev.js.map +1 -1
  8. package/dist/commands/doctor.d.ts +4 -0
  9. package/dist/commands/doctor.js +37 -0
  10. package/dist/commands/doctor.js.map +1 -0
  11. package/dist/commands/init.js +31 -30
  12. package/dist/commands/init.js.map +1 -1
  13. package/dist/commands/serve.d.ts +2 -0
  14. package/dist/commands/serve.js +122 -46
  15. package/dist/commands/serve.js.map +1 -1
  16. package/dist/commands/start.d.ts +1 -0
  17. package/dist/commands/start.js +15 -0
  18. package/dist/commands/start.js.map +1 -1
  19. package/dist/index.js +173 -210
  20. package/dist/index.js.map +1 -1
  21. package/package.json +13 -7
  22. package/templates/hello-world/.vscode/extensions.json +7 -0
  23. package/templates/hello-world/CHANGELOG.md +41 -0
  24. package/templates/hello-world/README.md +29 -0
  25. package/templates/hello-world/package.json +24 -0
  26. package/templates/hello-world/src/index.ts +58 -0
  27. package/templates/hello-world/tsconfig.json +10 -0
  28. package/templates/starter/.vscode/extensions.json +7 -0
  29. package/{CHANGELOG.md → templates/starter/CHANGELOG.md} +36 -42
  30. package/templates/starter/README.md +17 -0
  31. package/templates/starter/__tests__/projects-hooks-actions.test.ts +490 -0
  32. package/templates/starter/jest.config.js +16 -0
  33. package/templates/starter/package.json +52 -0
  34. package/templates/starter/src/README.pages.md +110 -0
  35. package/templates/starter/src/demo.app.yml +4 -0
  36. package/templates/starter/src/i18n/zh-CN/projects.json +22 -0
  37. package/templates/starter/src/modules/kitchen-sink/kitchen_sink.data.yml +18 -0
  38. package/templates/starter/src/modules/kitchen-sink/kitchen_sink.object.yml +156 -0
  39. package/templates/starter/src/modules/projects/project_approval.workflow.yml +51 -0
  40. package/templates/starter/src/modules/projects/projects.action.ts +472 -0
  41. package/templates/starter/src/modules/projects/projects.data.yml +13 -0
  42. package/templates/starter/src/modules/projects/projects.hook.ts +339 -0
  43. package/templates/starter/src/modules/projects/projects.object.yml +148 -0
  44. package/templates/starter/src/modules/projects/projects.permission.yml +141 -0
  45. package/templates/starter/src/modules/projects/projects.validation.yml +37 -0
  46. package/templates/starter/src/modules/tasks/tasks.data.yml +23 -0
  47. package/templates/starter/src/modules/tasks/tasks.object.yml +34 -0
  48. package/templates/starter/src/modules/tasks/tasks.permission.yml +167 -0
  49. package/templates/starter/src/seed.ts +55 -0
  50. package/templates/starter/src/types/index.ts +3 -0
  51. package/templates/starter/src/types/kitchen_sink.ts +101 -0
  52. package/templates/starter/src/types/projects.ts +49 -0
  53. package/templates/starter/src/types/tasks.ts +33 -0
  54. package/templates/starter/tsconfig.json +11 -0
  55. package/templates/starter/tsconfig.tsbuildinfo +1 -0
  56. package/AI_EXAMPLES.md +0 -154
  57. package/AI_IMPLEMENTATION_SUMMARY.md +0 -509
  58. package/AI_TUTORIAL.md +0 -144
  59. package/IMPLEMENTATION_SUMMARY.md +0 -437
  60. package/USAGE_EXAMPLES.md +0 -951
  61. package/__tests__/commands.test.ts +0 -426
  62. package/jest.config.js +0 -19
  63. package/src/commands/ai.ts +0 -509
  64. package/src/commands/build.ts +0 -98
  65. package/src/commands/dev.ts +0 -23
  66. package/src/commands/format.ts +0 -110
  67. package/src/commands/generate.ts +0 -135
  68. package/src/commands/i18n.ts +0 -303
  69. package/src/commands/init.ts +0 -191
  70. package/src/commands/lint.ts +0 -98
  71. package/src/commands/migrate.ts +0 -314
  72. package/src/commands/new.ts +0 -221
  73. package/src/commands/repl.ts +0 -120
  74. package/src/commands/serve.ts +0 -96
  75. package/src/commands/start.ts +0 -100
  76. package/src/commands/sync.ts +0 -328
  77. package/src/commands/test.ts +0 -98
  78. package/src/index.ts +0 -356
  79. package/tsconfig.json +0 -15
  80. package/tsconfig.tsbuildinfo +0 -1
@@ -1,328 +0,0 @@
1
- import * as fs from 'fs';
2
- import * as path from 'path';
3
- import chalk from 'chalk';
4
- import * as yaml from 'js-yaml';
5
- import { IntrospectedSchema, IntrospectedTable, IntrospectedColumn, ObjectConfig, IObjectQL, FieldConfig, FieldType } from '@objectql/types';
6
-
7
- interface SyncOptions {
8
- config?: string;
9
- output?: string;
10
- tables?: string[];
11
- force?: boolean;
12
- app?: IObjectQL; // Allow passing app instance directly for testing
13
- }
14
-
15
- /**
16
- * Sync database schema to ObjectQL .object.yml files
17
- * Introspects existing SQL database and generates object definitions
18
- */
19
- export async function syncDatabase(options: SyncOptions) {
20
- const outputDir = path.resolve(process.cwd(), options.output || './src/objects');
21
-
22
- console.log(chalk.blue('šŸ”„ Syncing database schema to ObjectQL...'));
23
- console.log(chalk.gray(`Output directory: ${outputDir}\n`));
24
-
25
- let app: IObjectQL | undefined = options.app;
26
- const shouldClose = !options.app; // Only close if we loaded it ourselves
27
-
28
- try {
29
- // Load ObjectQL instance from config if not provided
30
- if (!app) {
31
- app = await loadObjectQLInstance(options.config);
32
- }
33
-
34
- // Check if driver supports introspection
35
- const driver = app.datasource('default');
36
- if (!driver || !driver.introspectSchema) {
37
- const errorMsg = 'The configured driver does not support schema introspection. Only SQL drivers (PostgreSQL, MySQL, SQLite) support this feature.';
38
- console.error(chalk.red(`āŒ ${errorMsg}`));
39
- throw new Error(errorMsg);
40
- }
41
-
42
- // Introspect database schema
43
- console.log(chalk.blue('šŸ“Š Introspecting database schema...'));
44
- const schema: IntrospectedSchema = await driver.introspectSchema();
45
-
46
- const tableNames = Object.keys(schema.tables);
47
- if (tableNames.length === 0) {
48
- console.log(chalk.yellow('⚠ No tables found in database'));
49
- return;
50
- }
51
-
52
- console.log(chalk.green(`āœ“ Found ${tableNames.length} table(s)\n`));
53
-
54
- // Filter tables if specified
55
- let tablesToSync = tableNames;
56
- if (options.tables && options.tables.length > 0) {
57
- tablesToSync = tableNames.filter(t => options.tables!.includes(t));
58
- if (tablesToSync.length === 0) {
59
- console.log(chalk.yellow('⚠ No matching tables found'));
60
- return;
61
- }
62
- }
63
-
64
- // Create output directory if it doesn't exist
65
- if (!fs.existsSync(outputDir)) {
66
- fs.mkdirSync(outputDir, { recursive: true });
67
- console.log(chalk.gray(`Created directory: ${outputDir}\n`));
68
- }
69
-
70
- // Generate .object.yml files
71
- let createdCount = 0;
72
- let skippedCount = 0;
73
-
74
- for (const tableName of tablesToSync) {
75
- const table = schema.tables[tableName];
76
- const filename = `${tableName}.object.yml`;
77
- const filePath = path.join(outputDir, filename);
78
-
79
- // Check if file already exists
80
- if (fs.existsSync(filePath) && !options.force) {
81
- console.log(chalk.yellow(`⊘ ${tableName} (file exists, use --force to overwrite)`));
82
- skippedCount++;
83
- continue;
84
- }
85
-
86
- // Generate object definition
87
- const objectDef = generateObjectDefinition(table, schema);
88
-
89
- // Write to file
90
- const yamlContent = yaml.dump(objectDef, {
91
- indent: 2,
92
- lineWidth: -1,
93
- noRefs: true,
94
- sortKeys: false
95
- });
96
-
97
- fs.writeFileSync(filePath, yamlContent, 'utf-8');
98
-
99
- console.log(chalk.green(`āœ“ ${tableName} → ${filename}`));
100
- createdCount++;
101
- }
102
-
103
- console.log(chalk.blue('\nšŸ“Š Summary:'));
104
- console.log(chalk.gray(`Total tables: ${tablesToSync.length}`));
105
- console.log(chalk.gray(`Created: ${createdCount}`));
106
- console.log(chalk.gray(`Skipped: ${skippedCount}`));
107
-
108
- if (createdCount > 0) {
109
- console.log(chalk.green(`\nāœ… Successfully synced ${createdCount} table(s) to ${outputDir}`));
110
- }
111
-
112
- } catch (error: any) {
113
- console.error(chalk.red(`āŒ Sync failed: ${error.message}`));
114
- if (error.stack) {
115
- console.error(chalk.gray(error.stack));
116
- }
117
- throw error;
118
- } finally {
119
- // Ensure connection is closed if we opened it
120
- if (shouldClose && app) {
121
- if (app.close) {
122
- await app.close();
123
- } else {
124
- // Fallback for older versions if close isn't available
125
- const driver = app.datasource('default');
126
- if (driver && (driver as any).disconnect) {
127
- await (driver as any).disconnect();
128
- }
129
- }
130
- }
131
- }
132
- }
133
-
134
- /**
135
- * Generate ObjectQL object definition from introspected table
136
- */
137
- function generateObjectDefinition(table: IntrospectedTable, schema: IntrospectedSchema): ObjectConfig {
138
- const obj: ObjectConfig = {
139
- name: table.name,
140
- label: formatLabel(table.name),
141
- fields: {}
142
- };
143
-
144
- // Process each column
145
- for (const column of table.columns) {
146
- // Skip system fields (id, created_at, updated_at) - they're automatic
147
- if (['id', 'created_at', 'updated_at'].includes(column.name)) {
148
- continue;
149
- }
150
-
151
- const field: Partial<FieldConfig> = {};
152
-
153
- // Check if this is a foreign key
154
- const fk = table.foreignKeys.find(fk => fk.columnName === column.name);
155
- if (fk) {
156
- // This is a lookup/relationship field
157
- field.type = 'lookup';
158
- field.reference_to = fk.referencedTable;
159
-
160
- // Add label
161
- field.label = formatLabel(column.name);
162
-
163
- // Add required constraint
164
- if (!column.nullable) {
165
- field.required = true;
166
- }
167
- } else {
168
- // Regular field - map SQL type to ObjectQL type
169
- const fieldType = mapSqlTypeToObjectQL(column.type, column);
170
- field.type = fieldType;
171
-
172
- // Add label
173
- field.label = formatLabel(column.name);
174
-
175
- // Add constraints
176
- if (!column.nullable) {
177
- field.required = true;
178
- }
179
-
180
- if (column.isUnique) {
181
- field.unique = true;
182
- }
183
-
184
- // Add max_length for text-based fields
185
- if (column.maxLength && (fieldType === 'text' || fieldType === 'textarea')) {
186
- field.max_length = column.maxLength;
187
- }
188
-
189
- if (column.defaultValue !== undefined && column.defaultValue !== null) {
190
- // Only include simple default values
191
- if (typeof column.defaultValue === 'string' ||
192
- typeof column.defaultValue === 'number' ||
193
- typeof column.defaultValue === 'boolean') {
194
- field.defaultValue = column.defaultValue;
195
- }
196
- }
197
- }
198
-
199
- obj.fields[column.name] = field as FieldConfig;
200
- }
201
-
202
- return obj;
203
- }
204
-
205
- /**
206
- * Map SQL native type to ObjectQL field type
207
- */
208
- function mapSqlTypeToObjectQL(sqlType: string, column: IntrospectedColumn): FieldType {
209
- const type = sqlType.toLowerCase();
210
-
211
- // Integer types - map to 'number'
212
- if (type.includes('int') || type.includes('serial') || type.includes('bigserial')) {
213
- return 'number';
214
- }
215
-
216
- // Float/Decimal types
217
- if (type.includes('float') || type.includes('double') ||
218
- type.includes('decimal') || type.includes('numeric') || type.includes('real')) {
219
- return 'number';
220
- }
221
-
222
- // Boolean
223
- if (type.includes('bool') || type === 'bit') {
224
- return 'boolean';
225
- }
226
-
227
- // Date/Time types
228
- if (type.includes('timestamp') || type.includes('datetime')) {
229
- return 'datetime';
230
- }
231
- if (type === 'date') {
232
- return 'date';
233
- }
234
- if (type === 'time') {
235
- return 'time';
236
- }
237
-
238
- // Text types
239
- if (type.includes('text') || type.includes('clob') || type.includes('long')) {
240
- return 'textarea';
241
- }
242
-
243
- // JSON types - map to 'object'
244
- if (type.includes('json') || type.includes('jsonb')) {
245
- return 'object';
246
- }
247
-
248
- // Binary/Blob types
249
- if (type.includes('blob') || type.includes('binary') || type.includes('bytea')) {
250
- return 'file';
251
- }
252
-
253
- // String types (varchar, char, etc.)
254
- // Default to 'text' for general string fields
255
- return 'text';
256
- }
257
-
258
- /**
259
- * Format table/column name to human-readable label
260
- * e.g., "user_profile" -> "User Profile"
261
- */
262
- function formatLabel(name: string): string {
263
- return name
264
- .split('_')
265
- .map(word => word.charAt(0).toUpperCase() + word.slice(1))
266
- .join(' ');
267
- }
268
-
269
- /**
270
- * Load ObjectQL instance from config file
271
- */
272
- async function loadObjectQLInstance(configPath?: string): Promise<IObjectQL> {
273
- const cwd = process.cwd();
274
-
275
- // Try to load from config file
276
- let configFile = configPath;
277
- if (!configFile) {
278
- const potentialFiles = ['objectql.config.ts', 'objectql.config.js'];
279
- for (const file of potentialFiles) {
280
- if (fs.existsSync(path.join(cwd, file))) {
281
- configFile = path.join(cwd, file);
282
- break;
283
- }
284
- }
285
- } else if (!path.isAbsolute(configFile)) {
286
- // If configPath is provided but relative, make it absolute
287
- configFile = path.join(cwd, configFile);
288
- }
289
-
290
- if (!configFile) {
291
- throw new Error('No configuration file found (objectql.config.ts/js). Please create one with database connection.');
292
- }
293
-
294
- // Register ts-node for TypeScript support
295
- if (configFile.endsWith('.ts')) {
296
- try {
297
- require('ts-node').register({
298
- transpileOnly: true,
299
- compilerOptions: {
300
- module: 'commonjs'
301
- }
302
- });
303
- } catch (err) {
304
- throw new Error('TypeScript config file detected but ts-node is not installed. Please run: npm install --save-dev ts-node');
305
- }
306
- }
307
-
308
- const configModule = require(configFile);
309
-
310
- // Clear cache to support multiple runs in same process (e.g. tests)
311
- try {
312
- const resolvedPath = require.resolve(configFile);
313
- delete require.cache[resolvedPath];
314
- } catch (e) {
315
- // Ignore resolution errors
316
- }
317
-
318
- // Support multiple export patterns: default, app, objectql, or db (in order of precedence)
319
- const app = configModule.default || configModule.app || configModule.objectql || configModule.db;
320
-
321
- if (!app) {
322
- throw new Error('Config file must export an ObjectQL instance as default export or named export (app/objectql/db)');
323
- }
324
-
325
- // Initialize app (but don't sync schema - we're reading it)
326
- await app.init();
327
- return app;
328
- }
@@ -1,98 +0,0 @@
1
- import * as path from 'path';
2
- import * as fs from 'fs';
3
- import chalk from 'chalk';
4
- import { spawn } from 'child_process';
5
-
6
- interface TestOptions {
7
- dir?: string;
8
- watch?: boolean;
9
- coverage?: boolean;
10
- }
11
-
12
- /**
13
- * Test command - runs tests for the ObjectQL project
14
- */
15
- export async function test(options: TestOptions) {
16
- console.log(chalk.blue('🧪 Running tests...\n'));
17
-
18
- const rootDir = path.resolve(process.cwd(), options.dir || '.');
19
-
20
- // Look for package.json to determine test runner
21
- const packageJsonPath = path.join(rootDir, 'package.json');
22
- let testCommand = 'npm test';
23
-
24
- try {
25
- if (fs.existsSync(packageJsonPath)) {
26
- try {
27
- const packageJson = JSON.parse(fs.readFileSync(packageJsonPath, 'utf-8'));
28
-
29
- // Check if jest is configured
30
- if (packageJson.devDependencies?.jest || packageJson.dependencies?.jest || packageJson.jest) {
31
- const jestArgs = ['jest'];
32
-
33
- if (options.watch) {
34
- jestArgs.push('--watch');
35
- }
36
-
37
- if (options.coverage) {
38
- jestArgs.push('--coverage');
39
- }
40
-
41
- console.log(chalk.cyan(`Running: ${jestArgs.join(' ')}\n`));
42
-
43
- const jestProcess = spawn('npx', jestArgs, {
44
- cwd: rootDir,
45
- stdio: 'inherit',
46
- shell: true
47
- });
48
-
49
- jestProcess.on('exit', (code) => {
50
- if (code !== 0) {
51
- console.error(chalk.red(`\nāŒ Tests failed with exit code ${code}`));
52
- process.exit(code || 1);
53
- } else {
54
- console.log(chalk.green('\nāœ… All tests passed!'));
55
- }
56
- });
57
-
58
- return;
59
- }
60
-
61
- // Fall back to package.json test script
62
- if (packageJson.scripts?.test) {
63
- console.log(chalk.cyan(`Running: npm test\n`));
64
-
65
- const npmProcess = spawn('npm', ['test'], {
66
- cwd: rootDir,
67
- stdio: 'inherit',
68
- shell: true
69
- });
70
-
71
- npmProcess.on('exit', (code) => {
72
- if (code !== 0) {
73
- console.error(chalk.red(`\nāŒ Tests failed with exit code ${code}`));
74
- process.exit(code || 1);
75
- } else {
76
- console.log(chalk.green('\nāœ… All tests passed!'));
77
- }
78
- });
79
-
80
- return;
81
- }
82
- } catch (parseError: any) {
83
- console.error(chalk.yellow(`āš ļø Failed to parse package.json: ${parseError.message}`));
84
- }
85
- }
86
-
87
- // No test configuration found
88
- console.log(chalk.yellow('āš ļø No test configuration found'));
89
- console.log(chalk.gray('To add tests to your project:'));
90
- console.log(chalk.gray(' 1. Install jest: npm install --save-dev jest @types/jest ts-jest'));
91
- console.log(chalk.gray(' 2. Create a jest.config.js file'));
92
- console.log(chalk.gray(' 3. Add a test script to package.json'));
93
-
94
- } catch (e: any) {
95
- console.error(chalk.red('āŒ Test execution failed:'), e.message);
96
- process.exit(1);
97
- }
98
- }