@anarchitects/nx-typeorm 0.0.3 → 0.2.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.
- package/README.md +203 -43
- package/dist/executors/cache-clear/executor.d.ts +6 -0
- package/dist/executors/cache-clear/executor.d.ts.map +1 -0
- package/dist/executors/cache-clear/executor.js +5 -0
- package/dist/executors/cache-clear/schema.json +28 -0
- package/dist/executors/ensure-schema/executor.d.ts +1 -5
- package/dist/executors/ensure-schema/executor.d.ts.map +1 -1
- package/dist/executors/ensure-schema/executor.js +1 -1
- package/dist/executors/entity-create/executor.d.ts +6 -0
- package/dist/executors/entity-create/executor.d.ts.map +1 -0
- package/dist/executors/entity-create/executor.js +15 -0
- package/dist/executors/entity-create/schema.json +23 -0
- package/dist/executors/generate/executor.d.ts +1 -7
- package/dist/executors/generate/executor.d.ts.map +1 -1
- package/dist/executors/generate/executor.js +12 -24
- package/dist/executors/generate/schema.json +11 -1
- package/dist/executors/init/executor.d.ts +6 -0
- package/dist/executors/init/executor.d.ts.map +1 -0
- package/dist/executors/init/executor.js +24 -0
- package/dist/executors/init/schema.json +40 -0
- package/dist/executors/migration-create/executor.d.ts +6 -0
- package/dist/executors/migration-create/executor.d.ts.map +1 -0
- package/dist/executors/migration-create/executor.js +19 -0
- package/dist/executors/migration-create/schema.json +31 -0
- package/dist/executors/migration-show/executor.d.ts +6 -0
- package/dist/executors/migration-show/executor.d.ts.map +1 -0
- package/dist/executors/migration-show/executor.js +5 -0
- package/dist/executors/migration-show/schema.json +28 -0
- package/dist/executors/query/executor.d.ts +6 -0
- package/dist/executors/query/executor.d.ts.map +1 -0
- package/dist/executors/query/executor.js +9 -0
- package/dist/executors/query/schema.json +33 -0
- package/dist/executors/revert/executor.d.ts +1 -5
- package/dist/executors/revert/executor.d.ts.map +1 -1
- package/dist/executors/revert/executor.js +8 -19
- package/dist/executors/revert/schema.json +7 -1
- package/dist/executors/run/executor.d.ts +1 -6
- package/dist/executors/run/executor.d.ts.map +1 -1
- package/dist/executors/run/executor.js +7 -18
- package/dist/executors/run/schema.json +6 -0
- package/dist/executors/schema-drop/executor.d.ts +6 -0
- package/dist/executors/schema-drop/executor.d.ts.map +1 -0
- package/dist/executors/schema-drop/executor.js +5 -0
- package/dist/executors/schema-drop/schema.json +28 -0
- package/dist/executors/schema-log/executor.d.ts +6 -0
- package/dist/executors/schema-log/executor.d.ts.map +1 -0
- package/dist/executors/schema-log/executor.js +5 -0
- package/dist/executors/schema-log/schema.json +28 -0
- package/dist/executors/schema-sync/executor.d.ts +6 -0
- package/dist/executors/schema-sync/executor.d.ts.map +1 -0
- package/dist/executors/schema-sync/executor.js +5 -0
- package/dist/executors/schema-sync/schema.json +28 -0
- package/dist/executors/seed/executor.d.ts +1 -7
- package/dist/executors/seed/executor.d.ts.map +1 -1
- package/dist/executors/seed/executor.js +1 -1
- package/dist/executors/subscriber-create/executor.d.ts +6 -0
- package/dist/executors/subscriber-create/executor.d.ts.map +1 -0
- package/dist/executors/subscriber-create/executor.js +13 -0
- package/dist/executors/subscriber-create/schema.json +23 -0
- package/dist/executors/version/executor.d.ts +6 -0
- package/dist/executors/version/executor.d.ts.map +1 -0
- package/dist/executors/version/executor.js +5 -0
- package/dist/executors/version/schema.json +14 -0
- package/dist/generators/bootstrap/files/app/env.example__tmpl__ +55 -1
- package/dist/generators/bootstrap/files/app/src/data-source.ts__tmpl__ +6 -0
- package/dist/generators/bootstrap/files/app/src/typeorm.datasource.ts__tmpl__ +1 -15
- package/dist/generators/bootstrap/files/app/tools/typeorm/connection-options.ts__tmpl__ +292 -0
- package/dist/generators/bootstrap/files/app/tools/typeorm/datasource.migrations.ts__tmpl__ +2 -7
- package/dist/generators/bootstrap/files/lib/project.json.partial__tmpl__ +3 -1
- package/dist/generators/bootstrap/generator.d.ts +5 -1
- package/dist/generators/bootstrap/generator.d.ts.map +1 -1
- package/dist/generators/bootstrap/generator.js +179 -31
- package/dist/generators/bootstrap/schema.json +18 -1
- package/dist/generators/entity-create/generator.d.ts +4 -0
- package/dist/generators/entity-create/generator.d.ts.map +1 -0
- package/dist/generators/entity-create/generator.js +70 -0
- package/dist/generators/entity-create/schema.json +28 -0
- package/dist/generators/init/generator.d.ts +4 -0
- package/dist/generators/init/generator.d.ts.map +1 -0
- package/dist/generators/init/generator.js +31 -0
- package/dist/generators/init/schema.json +18 -0
- package/dist/generators/migration-create/generator.d.ts +4 -0
- package/dist/generators/migration-create/generator.d.ts.map +1 -0
- package/dist/generators/migration-create/generator.js +72 -0
- package/dist/generators/migration-create/schema.json +40 -0
- package/dist/generators/subscriber-create/generator.d.ts +4 -0
- package/dist/generators/subscriber-create/generator.d.ts.map +1 -0
- package/dist/generators/subscriber-create/generator.js +70 -0
- package/dist/generators/subscriber-create/schema.json +28 -0
- package/dist/index.d.ts +19 -0
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +19 -0
- package/dist/index.json +72 -0
- package/dist/plugin/index.d.ts +9 -0
- package/dist/plugin/index.d.ts.map +1 -0
- package/dist/plugin/index.js +241 -0
- package/dist/plugins/typeorm.d.ts +1 -6
- package/dist/plugins/typeorm.d.ts.map +1 -1
- package/dist/plugins/typeorm.js +1 -161
- package/dist/utils/cli.d.ts +17 -0
- package/dist/utils/cli.d.ts.map +1 -0
- package/dist/utils/cli.js +55 -0
- package/dist/{executors → utils}/shared.d.ts +12 -9
- package/dist/utils/shared.d.ts.map +1 -0
- package/dist/utils/shared.js +260 -0
- package/package.json +6 -7
- package/dist/executors/shared.d.ts.map +0 -1
- package/dist/executors/shared.js +0 -71
- package/dist/generators/bootstrap/files/app/tools/typeorm/datasource.runtime.ts__tmpl__ +0 -9
|
@@ -0,0 +1,292 @@
|
|
|
1
|
+
import type { DataSourceOptions } from 'typeorm';
|
|
2
|
+
|
|
3
|
+
type ConnectionMode = 'url' | 'fields';
|
|
4
|
+
|
|
5
|
+
const DATABASE_URL_KEY = 'DATABASE_URL';
|
|
6
|
+
const URL_OR_FIELDS_ERROR =
|
|
7
|
+
'Invalid TypeORM connection configuration. Provide either DATABASE_URL or TYPEORM_* variables, not both.';
|
|
8
|
+
const TRUE_VALUES = new Set(['1', 'true', 'yes', 'on']);
|
|
9
|
+
const FALSE_VALUES = new Set(['0', 'false', 'no', 'off']);
|
|
10
|
+
<% if (database === 'postgres') { %>const DISCRETE_ENV_KEYS = [
|
|
11
|
+
'TYPEORM_HOST',
|
|
12
|
+
'TYPEORM_PORT',
|
|
13
|
+
'TYPEORM_USERNAME',
|
|
14
|
+
'TYPEORM_PASSWORD',
|
|
15
|
+
'TYPEORM_DATABASE',
|
|
16
|
+
'TYPEORM_SCHEMA',
|
|
17
|
+
'TYPEORM_SSL',
|
|
18
|
+
'TYPEORM_APPLICATION_NAME',
|
|
19
|
+
'TYPEORM_CONNECT_TIMEOUT_MS',
|
|
20
|
+
] as const;
|
|
21
|
+
|
|
22
|
+
type DatabaseConnectionOptions = Extract<DataSourceOptions, { type: 'postgres' }>;
|
|
23
|
+
<% } %><% if (database === 'mysql' || database === 'mariadb') { %>const DISCRETE_ENV_KEYS = [
|
|
24
|
+
'TYPEORM_HOST',
|
|
25
|
+
'TYPEORM_PORT',
|
|
26
|
+
'TYPEORM_USERNAME',
|
|
27
|
+
'TYPEORM_PASSWORD',
|
|
28
|
+
'TYPEORM_DATABASE',
|
|
29
|
+
'TYPEORM_SSL',
|
|
30
|
+
'TYPEORM_SOCKET_PATH',
|
|
31
|
+
'TYPEORM_CHARSET',
|
|
32
|
+
'TYPEORM_TIMEZONE',
|
|
33
|
+
'TYPEORM_CONNECT_TIMEOUT',
|
|
34
|
+
] as const;
|
|
35
|
+
|
|
36
|
+
type DatabaseConnectionOptions = Extract<DataSourceOptions, { type: '<%= database %>' }>;
|
|
37
|
+
<% } %><% if (database === 'mssql') { %>const DISCRETE_ENV_KEYS = [
|
|
38
|
+
'TYPEORM_HOST',
|
|
39
|
+
'TYPEORM_PORT',
|
|
40
|
+
'TYPEORM_USERNAME',
|
|
41
|
+
'TYPEORM_PASSWORD',
|
|
42
|
+
'TYPEORM_DATABASE',
|
|
43
|
+
'TYPEORM_DOMAIN',
|
|
44
|
+
'TYPEORM_CONNECTION_TIMEOUT',
|
|
45
|
+
'TYPEORM_REQUEST_TIMEOUT',
|
|
46
|
+
'TYPEORM_ENCRYPT',
|
|
47
|
+
'TYPEORM_TRUST_SERVER_CERTIFICATE',
|
|
48
|
+
'TYPEORM_INSTANCE_NAME',
|
|
49
|
+
] as const;
|
|
50
|
+
|
|
51
|
+
type DatabaseConnectionOptions = Extract<DataSourceOptions, { type: 'mssql' }>;
|
|
52
|
+
<% } %><% if (database === 'sqlite') { %>const DISCRETE_ENV_KEYS = [
|
|
53
|
+
'TYPEORM_DATABASE',
|
|
54
|
+
'TYPEORM_BUSY_TIMEOUT',
|
|
55
|
+
'TYPEORM_ENABLE_WAL',
|
|
56
|
+
] as const;
|
|
57
|
+
|
|
58
|
+
type DatabaseConnectionOptions = Extract<DataSourceOptions, { type: 'sqlite' }>;
|
|
59
|
+
<% } %><% if (database === 'better-sqlite3') { %>const DISCRETE_ENV_KEYS = [
|
|
60
|
+
'TYPEORM_DATABASE',
|
|
61
|
+
'TYPEORM_ENABLE_WAL',
|
|
62
|
+
'TYPEORM_TIMEOUT',
|
|
63
|
+
'TYPEORM_READONLY',
|
|
64
|
+
'TYPEORM_FILE_MUST_EXIST',
|
|
65
|
+
'TYPEORM_STATEMENT_CACHE_SIZE',
|
|
66
|
+
] as const;
|
|
67
|
+
|
|
68
|
+
type DatabaseConnectionOptions = Extract<DataSourceOptions, { type: 'better-sqlite3' }>;
|
|
69
|
+
<% } %>
|
|
70
|
+
|
|
71
|
+
export function createRuntimeDataSourceOptions(): DataSourceOptions {
|
|
72
|
+
return {
|
|
73
|
+
...createConnectionOptions(),
|
|
74
|
+
synchronize: false,
|
|
75
|
+
logging: false,
|
|
76
|
+
};
|
|
77
|
+
}
|
|
78
|
+
|
|
79
|
+
export function createMigrationDataSourceOptions(): DataSourceOptions {
|
|
80
|
+
return {
|
|
81
|
+
...createConnectionOptions(),
|
|
82
|
+
entities: [],
|
|
83
|
+
migrations: ['dist/tools/typeorm/migrations/*.js'],
|
|
84
|
+
synchronize: false,
|
|
85
|
+
logging: false,
|
|
86
|
+
};
|
|
87
|
+
}
|
|
88
|
+
|
|
89
|
+
function createConnectionOptions(): DatabaseConnectionOptions {
|
|
90
|
+
return resolveConnectionMode() === 'url'
|
|
91
|
+
? createOptionsFromUrl()
|
|
92
|
+
: createOptionsFromFields();
|
|
93
|
+
}
|
|
94
|
+
|
|
95
|
+
function resolveConnectionMode(): ConnectionMode {
|
|
96
|
+
const hasDatabaseUrl = optionalEnv(DATABASE_URL_KEY) !== undefined;
|
|
97
|
+
const hasDiscreteVariables = DISCRETE_ENV_KEYS.some(
|
|
98
|
+
(key) => optionalEnv(key) !== undefined
|
|
99
|
+
);
|
|
100
|
+
|
|
101
|
+
if (hasDatabaseUrl && hasDiscreteVariables) {
|
|
102
|
+
throw new Error(URL_OR_FIELDS_ERROR);
|
|
103
|
+
}
|
|
104
|
+
|
|
105
|
+
return hasDatabaseUrl ? 'url' : 'fields';
|
|
106
|
+
}
|
|
107
|
+
|
|
108
|
+
function requiredEnv(name: string): string {
|
|
109
|
+
const value = optionalEnv(name);
|
|
110
|
+
if (!value) {
|
|
111
|
+
throw new Error(`Missing required environment variable "${name}".`);
|
|
112
|
+
}
|
|
113
|
+
return value;
|
|
114
|
+
}
|
|
115
|
+
|
|
116
|
+
function optionalEnv(name: string): string | undefined {
|
|
117
|
+
const value = process.env[name];
|
|
118
|
+
if (!value) {
|
|
119
|
+
return undefined;
|
|
120
|
+
}
|
|
121
|
+
|
|
122
|
+
const trimmed = value.trim();
|
|
123
|
+
return trimmed.length > 0 ? trimmed : undefined;
|
|
124
|
+
}
|
|
125
|
+
|
|
126
|
+
function parseBooleanEnv(name: string): boolean | undefined {
|
|
127
|
+
const value = optionalEnv(name);
|
|
128
|
+
if (value === undefined) {
|
|
129
|
+
return undefined;
|
|
130
|
+
}
|
|
131
|
+
|
|
132
|
+
const normalized = value.toLowerCase();
|
|
133
|
+
if (TRUE_VALUES.has(normalized)) {
|
|
134
|
+
return true;
|
|
135
|
+
}
|
|
136
|
+
|
|
137
|
+
if (FALSE_VALUES.has(normalized)) {
|
|
138
|
+
return false;
|
|
139
|
+
}
|
|
140
|
+
|
|
141
|
+
throw new Error(
|
|
142
|
+
`Environment variable "${name}" must be a boolean value (true/false/1/0/yes/no/on/off).`
|
|
143
|
+
);
|
|
144
|
+
}
|
|
145
|
+
|
|
146
|
+
function parseIntegerEnv(name: string): number | undefined {
|
|
147
|
+
const value = optionalEnv(name);
|
|
148
|
+
if (value === undefined) {
|
|
149
|
+
return undefined;
|
|
150
|
+
}
|
|
151
|
+
|
|
152
|
+
if (!/^-?\d+$/.test(value)) {
|
|
153
|
+
throw new Error(`Environment variable "${name}" must be an integer.`);
|
|
154
|
+
}
|
|
155
|
+
|
|
156
|
+
const parsed = Number.parseInt(value, 10);
|
|
157
|
+
if (!Number.isSafeInteger(parsed)) {
|
|
158
|
+
throw new Error(`Environment variable "${name}" must be an integer.`);
|
|
159
|
+
}
|
|
160
|
+
return parsed;
|
|
161
|
+
}
|
|
162
|
+
|
|
163
|
+
function parseSslEnv(name: string): boolean | Record<string, unknown> | undefined {
|
|
164
|
+
const value = optionalEnv(name);
|
|
165
|
+
if (value === undefined) {
|
|
166
|
+
return undefined;
|
|
167
|
+
}
|
|
168
|
+
|
|
169
|
+
const normalized = value.toLowerCase();
|
|
170
|
+
if (TRUE_VALUES.has(normalized)) {
|
|
171
|
+
return true;
|
|
172
|
+
}
|
|
173
|
+
if (FALSE_VALUES.has(normalized)) {
|
|
174
|
+
return false;
|
|
175
|
+
}
|
|
176
|
+
|
|
177
|
+
try {
|
|
178
|
+
const parsed = JSON.parse(value) as unknown;
|
|
179
|
+
if (parsed && typeof parsed === 'object' && !Array.isArray(parsed)) {
|
|
180
|
+
return parsed as Record<string, unknown>;
|
|
181
|
+
}
|
|
182
|
+
} catch {
|
|
183
|
+
// Ignore and throw below with context.
|
|
184
|
+
}
|
|
185
|
+
|
|
186
|
+
throw new Error(
|
|
187
|
+
`Environment variable "${name}" must be a boolean or a JSON object.`
|
|
188
|
+
);
|
|
189
|
+
}
|
|
190
|
+
|
|
191
|
+
<% if (database === 'postgres') { %>function createOptionsFromUrl(): DatabaseConnectionOptions {
|
|
192
|
+
return {
|
|
193
|
+
type: 'postgres',
|
|
194
|
+
url: requiredEnv(DATABASE_URL_KEY),
|
|
195
|
+
};
|
|
196
|
+
}
|
|
197
|
+
|
|
198
|
+
function createOptionsFromFields(): DatabaseConnectionOptions {
|
|
199
|
+
return {
|
|
200
|
+
type: 'postgres',
|
|
201
|
+
host: requiredEnv('TYPEORM_HOST'),
|
|
202
|
+
port: parseIntegerEnv('TYPEORM_PORT') ?? 5432,
|
|
203
|
+
username: requiredEnv('TYPEORM_USERNAME'),
|
|
204
|
+
password: requiredEnv('TYPEORM_PASSWORD'),
|
|
205
|
+
database: requiredEnv('TYPEORM_DATABASE'),
|
|
206
|
+
schema: optionalEnv('TYPEORM_SCHEMA'),
|
|
207
|
+
ssl: parseSslEnv('TYPEORM_SSL'),
|
|
208
|
+
applicationName: optionalEnv('TYPEORM_APPLICATION_NAME'),
|
|
209
|
+
connectTimeoutMS: parseIntegerEnv('TYPEORM_CONNECT_TIMEOUT_MS'),
|
|
210
|
+
};
|
|
211
|
+
}
|
|
212
|
+
<% } %><% if (database === 'mysql' || database === 'mariadb') { %>function createOptionsFromUrl(): DatabaseConnectionOptions {
|
|
213
|
+
return {
|
|
214
|
+
type: '<%= database %>',
|
|
215
|
+
url: requiredEnv(DATABASE_URL_KEY),
|
|
216
|
+
};
|
|
217
|
+
}
|
|
218
|
+
|
|
219
|
+
function createOptionsFromFields(): DatabaseConnectionOptions {
|
|
220
|
+
return {
|
|
221
|
+
type: '<%= database %>',
|
|
222
|
+
host: requiredEnv('TYPEORM_HOST'),
|
|
223
|
+
port: parseIntegerEnv('TYPEORM_PORT') ?? 3306,
|
|
224
|
+
username: requiredEnv('TYPEORM_USERNAME'),
|
|
225
|
+
password: requiredEnv('TYPEORM_PASSWORD'),
|
|
226
|
+
database: requiredEnv('TYPEORM_DATABASE'),
|
|
227
|
+
ssl: parseSslEnv('TYPEORM_SSL'),
|
|
228
|
+
socketPath: optionalEnv('TYPEORM_SOCKET_PATH'),
|
|
229
|
+
charset: optionalEnv('TYPEORM_CHARSET'),
|
|
230
|
+
timezone: optionalEnv('TYPEORM_TIMEZONE'),
|
|
231
|
+
connectTimeout: parseIntegerEnv('TYPEORM_CONNECT_TIMEOUT'),
|
|
232
|
+
};
|
|
233
|
+
}
|
|
234
|
+
<% } %><% if (database === 'mssql') { %>function createOptionsFromUrl(): DatabaseConnectionOptions {
|
|
235
|
+
return {
|
|
236
|
+
type: 'mssql',
|
|
237
|
+
url: requiredEnv(DATABASE_URL_KEY),
|
|
238
|
+
};
|
|
239
|
+
}
|
|
240
|
+
|
|
241
|
+
function createOptionsFromFields(): DatabaseConnectionOptions {
|
|
242
|
+
return {
|
|
243
|
+
type: 'mssql',
|
|
244
|
+
host: requiredEnv('TYPEORM_HOST'),
|
|
245
|
+
port: parseIntegerEnv('TYPEORM_PORT') ?? 1433,
|
|
246
|
+
username: requiredEnv('TYPEORM_USERNAME'),
|
|
247
|
+
password: requiredEnv('TYPEORM_PASSWORD'),
|
|
248
|
+
database: requiredEnv('TYPEORM_DATABASE'),
|
|
249
|
+
domain: optionalEnv('TYPEORM_DOMAIN'),
|
|
250
|
+
connectionTimeout: parseIntegerEnv('TYPEORM_CONNECTION_TIMEOUT'),
|
|
251
|
+
requestTimeout: parseIntegerEnv('TYPEORM_REQUEST_TIMEOUT'),
|
|
252
|
+
options: {
|
|
253
|
+
encrypt: parseBooleanEnv('TYPEORM_ENCRYPT'),
|
|
254
|
+
trustServerCertificate: parseBooleanEnv('TYPEORM_TRUST_SERVER_CERTIFICATE'),
|
|
255
|
+
instanceName: optionalEnv('TYPEORM_INSTANCE_NAME'),
|
|
256
|
+
},
|
|
257
|
+
};
|
|
258
|
+
}
|
|
259
|
+
<% } %><% if (database === 'sqlite') { %>function createOptionsFromUrl(): DatabaseConnectionOptions {
|
|
260
|
+
return {
|
|
261
|
+
type: 'sqlite',
|
|
262
|
+
database: requiredEnv(DATABASE_URL_KEY),
|
|
263
|
+
};
|
|
264
|
+
}
|
|
265
|
+
|
|
266
|
+
function createOptionsFromFields(): DatabaseConnectionOptions {
|
|
267
|
+
return {
|
|
268
|
+
type: 'sqlite',
|
|
269
|
+
database: requiredEnv('TYPEORM_DATABASE'),
|
|
270
|
+
busyTimeout: parseIntegerEnv('TYPEORM_BUSY_TIMEOUT'),
|
|
271
|
+
enableWAL: parseBooleanEnv('TYPEORM_ENABLE_WAL'),
|
|
272
|
+
};
|
|
273
|
+
}
|
|
274
|
+
<% } %><% if (database === 'better-sqlite3') { %>function createOptionsFromUrl(): DatabaseConnectionOptions {
|
|
275
|
+
return {
|
|
276
|
+
type: 'better-sqlite3',
|
|
277
|
+
database: requiredEnv(DATABASE_URL_KEY),
|
|
278
|
+
};
|
|
279
|
+
}
|
|
280
|
+
|
|
281
|
+
function createOptionsFromFields(): DatabaseConnectionOptions {
|
|
282
|
+
return {
|
|
283
|
+
type: 'better-sqlite3',
|
|
284
|
+
database: requiredEnv('TYPEORM_DATABASE'),
|
|
285
|
+
enableWAL: parseBooleanEnv('TYPEORM_ENABLE_WAL'),
|
|
286
|
+
timeout: parseIntegerEnv('TYPEORM_TIMEOUT'),
|
|
287
|
+
readonly: parseBooleanEnv('TYPEORM_READONLY'),
|
|
288
|
+
fileMustExist: parseBooleanEnv('TYPEORM_FILE_MUST_EXIST'),
|
|
289
|
+
statementCacheSize: parseIntegerEnv('TYPEORM_STATEMENT_CACHE_SIZE'),
|
|
290
|
+
};
|
|
291
|
+
}
|
|
292
|
+
<% } %>
|
|
@@ -1,9 +1,4 @@
|
|
|
1
1
|
import { DataSource } from 'typeorm';
|
|
2
|
+
import { createMigrationDataSourceOptions } from './connection-options';
|
|
2
3
|
|
|
3
|
-
export default new DataSource(
|
|
4
|
-
type: '<%= database %>',
|
|
5
|
-
url: process.env.DATABASE_URL,
|
|
6
|
-
entities: [],
|
|
7
|
-
migrations: ['dist/tools/typeorm/migrations/*.js'],
|
|
8
|
-
synchronize: false,
|
|
9
|
-
});
|
|
4
|
+
export default new DataSource(createMigrationDataSourceOptions());
|
|
@@ -3,10 +3,14 @@ interface BootstrapGeneratorSchema {
|
|
|
3
3
|
project: string;
|
|
4
4
|
domain?: string;
|
|
5
5
|
schema?: string;
|
|
6
|
-
db?:
|
|
6
|
+
db?: SupportedDatabase | 'postgresql';
|
|
7
7
|
withCompose?: boolean;
|
|
8
8
|
skipInstall?: boolean;
|
|
9
|
+
schemaPath?: string;
|
|
10
|
+
migrationsDir?: string;
|
|
9
11
|
}
|
|
12
|
+
declare const SUPPORTED_DATABASES: readonly ["postgres", "mysql", "mariadb", "sqlite", "better-sqlite3", "mssql"];
|
|
13
|
+
type SupportedDatabase = (typeof SUPPORTED_DATABASES)[number];
|
|
10
14
|
export default function bootstrapGenerator(tree: Tree, options: BootstrapGeneratorSchema): Promise<GeneratorCallback>;
|
|
11
15
|
export {};
|
|
12
16
|
//# sourceMappingURL=generator.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"generator.d.ts","sourceRoot":"","sources":["../../../src/generators/bootstrap/generator.ts"],"names":[],"mappings":"AAAA,OAAO,EAQL,IAAI,EAEJ,KAAK,iBAAiB,EACvB,MAAM,YAAY,CAAC;AAiBpB,UAAU,wBAAwB;IAChC,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,EAAE,CAAC,
|
|
1
|
+
{"version":3,"file":"generator.d.ts","sourceRoot":"","sources":["../../../src/generators/bootstrap/generator.ts"],"names":[],"mappings":"AAAA,OAAO,EAQL,IAAI,EAEJ,KAAK,iBAAiB,EACvB,MAAM,YAAY,CAAC;AAiBpB,UAAU,wBAAwB;IAChC,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,EAAE,CAAC,EACC,iBAAiB,GACjB,YAAY,CAAC;IACjB,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAOD,QAAA,MAAM,mBAAmB,gFAOf,CAAC;AAWX,KAAK,iBAAiB,GAAG,CAAC,OAAO,mBAAmB,CAAC,CAAC,MAAM,CAAC,CAAC;AAiB9D,wBAA8B,kBAAkB,CAC9C,IAAI,EAAE,IAAI,EACV,OAAO,EAAE,wBAAwB,8BAyClC"}
|
|
@@ -1,77 +1,225 @@
|
|
|
1
|
-
import { addDependenciesToPackageJson, formatFiles, generateFiles, joinPathFragments, names, readProjectConfiguration, runTasksInSerial,
|
|
2
|
-
import { dirname,
|
|
1
|
+
import { addDependenciesToPackageJson, formatFiles, generateFiles, joinPathFragments, names, readProjectConfiguration, runTasksInSerial, updateProjectConfiguration, } from '@nx/devkit';
|
|
2
|
+
import { dirname, isAbsolute, relative } from 'node:path';
|
|
3
3
|
import { fileURLToPath } from 'node:url';
|
|
4
4
|
import { Node, Project, SyntaxKind, } from 'ts-morph';
|
|
5
5
|
const generatorDir = dirname(fileURLToPath(import.meta.url));
|
|
6
6
|
const DEFAULT_DATABASE = 'postgres';
|
|
7
|
-
const
|
|
7
|
+
const DATABASE_ALIAS_MAP = {
|
|
8
|
+
postgresql: 'postgres',
|
|
9
|
+
};
|
|
10
|
+
const SUPPORTED_DATABASES = [
|
|
11
|
+
'postgres',
|
|
12
|
+
'mysql',
|
|
13
|
+
'mariadb',
|
|
14
|
+
'sqlite',
|
|
15
|
+
'better-sqlite3',
|
|
16
|
+
'mssql',
|
|
17
|
+
];
|
|
18
|
+
const DEFAULT_SCHEMA_PATH = 'src/infrastructure-persistence/schema.ts';
|
|
19
|
+
const DEFAULT_MIGRATIONS_DIR = 'src/infrastructure-persistence/migrations';
|
|
20
|
+
const DEFAULT_MIGRATION_FILE = '1700000000000_init_schema.ts';
|
|
21
|
+
const APP_MIGRATIONS_DATASOURCE_PATH = 'tools/typeorm/datasource.migrations.ts';
|
|
22
|
+
const runtimeImportPath = './data-source';
|
|
23
|
+
const SUPPORTED_DATABASE_DISPLAY = [
|
|
24
|
+
...SUPPORTED_DATABASES,
|
|
25
|
+
'postgresql',
|
|
26
|
+
].join(', ');
|
|
27
|
+
const DRIVER_DEPENDENCIES = {
|
|
28
|
+
postgres: { packageName: 'pg', version: '^8.20.0' },
|
|
29
|
+
mysql: { packageName: 'mysql2', version: '^3.20.0' },
|
|
30
|
+
mariadb: { packageName: 'mariadb', version: '^3.5.2' },
|
|
31
|
+
sqlite: { packageName: 'sqlite3', version: '^6.0.1' },
|
|
32
|
+
'better-sqlite3': { packageName: 'better-sqlite3', version: '^12.8.0' },
|
|
33
|
+
mssql: { packageName: 'mssql', version: '^12.2.1' },
|
|
34
|
+
};
|
|
8
35
|
export default async function bootstrapGenerator(tree, options) {
|
|
36
|
+
const database = normalizeDatabase(options.db);
|
|
9
37
|
const project = readProjectConfiguration(tree, options.project);
|
|
38
|
+
const isNestApplication = project.projectType === 'application' &&
|
|
39
|
+
hasNestModuleFile(tree, project.root, project.sourceRoot);
|
|
10
40
|
const tasks = [];
|
|
11
|
-
const dependencyTask = addDependenciesToPackageJson(tree, {
|
|
12
|
-
typeorm: '^0.3.20',
|
|
13
|
-
pg: '^8.11.0',
|
|
14
|
-
'reflect-metadata': '^0.1.13',
|
|
15
|
-
'@nestjs/typeorm': '^10.0.0',
|
|
16
|
-
}, {
|
|
41
|
+
const dependencyTask = addDependenciesToPackageJson(tree, buildRuntimeDependencies(database, isNestApplication), {
|
|
17
42
|
'ts-node': '^10.9.2',
|
|
18
|
-
'typeorm-ts-node-commonjs': '^0.
|
|
43
|
+
'typeorm-ts-node-commonjs': '^0.3.20',
|
|
44
|
+
'typeorm-ts-node-esm': '^0.3.20',
|
|
19
45
|
});
|
|
20
46
|
if (!options.skipInstall) {
|
|
21
47
|
tasks.push(dependencyTask);
|
|
22
48
|
}
|
|
23
49
|
if (project.projectType === 'library') {
|
|
24
|
-
prepareLibrary(tree, project.root, options);
|
|
50
|
+
prepareLibrary(tree, options.project, project.root, options);
|
|
25
51
|
}
|
|
26
52
|
else {
|
|
27
|
-
prepareApplication(tree, project.root, project.sourceRoot,
|
|
53
|
+
prepareApplication(tree, project.root, project.sourceRoot, {
|
|
54
|
+
...options,
|
|
55
|
+
db: database,
|
|
56
|
+
}, isNestApplication);
|
|
28
57
|
}
|
|
29
58
|
await formatFiles(tree);
|
|
30
59
|
return tasks.length ? runTasksInSerial(...tasks) : () => undefined;
|
|
31
60
|
}
|
|
32
|
-
function
|
|
61
|
+
function buildRuntimeDependencies(database, isNestApplication) {
|
|
62
|
+
const dependencies = {
|
|
63
|
+
typeorm: '^0.3.28',
|
|
64
|
+
'reflect-metadata': '^0.2.2',
|
|
65
|
+
};
|
|
66
|
+
const driverDependency = DRIVER_DEPENDENCIES[database];
|
|
67
|
+
dependencies[driverDependency.packageName] = driverDependency.version;
|
|
68
|
+
if (isNestApplication) {
|
|
69
|
+
dependencies['@nestjs/typeorm'] = '^11.0.0';
|
|
70
|
+
}
|
|
71
|
+
return dependencies;
|
|
72
|
+
}
|
|
73
|
+
function prepareLibrary(tree, projectName, projectRoot, options) {
|
|
33
74
|
if (!options.domain) {
|
|
34
75
|
throw new Error('Domain option is required when targeting a library.');
|
|
35
76
|
}
|
|
36
77
|
const schemaName = (options.schema ?? options.domain).toLowerCase();
|
|
78
|
+
const schemaPathRelative = normalizeProjectRelative(options.schemaPath ?? DEFAULT_SCHEMA_PATH);
|
|
79
|
+
const migrationsDirRelative = normalizeProjectRelative(options.migrationsDir ?? DEFAULT_MIGRATIONS_DIR);
|
|
37
80
|
const templateOptions = {
|
|
38
81
|
tmpl: '',
|
|
39
82
|
schema: schemaName,
|
|
40
83
|
domain: options.domain,
|
|
84
|
+
schemaPath: schemaPathRelative,
|
|
85
|
+
migrationsDir: migrationsDirRelative,
|
|
41
86
|
...names(options.domain),
|
|
42
87
|
};
|
|
43
|
-
generateFiles(tree,
|
|
44
|
-
const
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
88
|
+
generateFiles(tree, joinPathFragments(generatorDir, 'files', 'lib'), projectRoot, templateOptions);
|
|
89
|
+
const defaultSchemaPath = joinPathFragments(projectRoot, DEFAULT_SCHEMA_PATH);
|
|
90
|
+
const defaultMigrationPath = joinPathFragments(projectRoot, DEFAULT_MIGRATIONS_DIR, DEFAULT_MIGRATION_FILE);
|
|
91
|
+
const targetSchemaPath = joinPathFragments(projectRoot, schemaPathRelative);
|
|
92
|
+
const targetMigrationPath = joinPathFragments(projectRoot, migrationsDirRelative, DEFAULT_MIGRATION_FILE);
|
|
93
|
+
moveGeneratedFile(tree, defaultSchemaPath, targetSchemaPath);
|
|
94
|
+
moveGeneratedFile(tree, defaultMigrationPath, targetMigrationPath);
|
|
95
|
+
patchMigrationSchemaImport(tree, targetSchemaPath, targetMigrationPath);
|
|
96
|
+
const partial = consumeProjectJsonPartial(tree, projectRoot);
|
|
97
|
+
const projectConfig = readProjectConfiguration(tree, projectName);
|
|
98
|
+
updateProjectConfiguration(tree, projectName, {
|
|
99
|
+
...projectConfig,
|
|
100
|
+
metadata: {
|
|
101
|
+
...(projectConfig.metadata ?? {}),
|
|
102
|
+
...(partial.metadata ?? {}),
|
|
103
|
+
typeorm: {
|
|
104
|
+
...(projectConfig.metadata
|
|
105
|
+
?.typeorm ?? {}),
|
|
106
|
+
...(partial.metadata
|
|
107
|
+
?.typeorm ?? {}),
|
|
53
108
|
schema: schemaName,
|
|
54
109
|
domain: options.domain,
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
110
|
+
schemaPath: schemaPathRelative,
|
|
111
|
+
migrationsDir: migrationsDirRelative,
|
|
112
|
+
},
|
|
113
|
+
},
|
|
114
|
+
});
|
|
59
115
|
}
|
|
60
|
-
function prepareApplication(tree, projectRoot, sourceRoot, options) {
|
|
61
|
-
const database = options.db
|
|
116
|
+
function prepareApplication(tree, projectRoot, sourceRoot, options, isNestApplication) {
|
|
117
|
+
const database = normalizeDatabase(options.db);
|
|
62
118
|
const projectName = names(options.project).fileName.replace(/-/g, '_');
|
|
63
|
-
|
|
119
|
+
const migrationsDatasourcePath = joinPathFragments(projectRoot, APP_MIGRATIONS_DATASOURCE_PATH);
|
|
120
|
+
const existingMigrationsDatasource = tree.exists(migrationsDatasourcePath)
|
|
121
|
+
? tree.read(migrationsDatasourcePath)
|
|
122
|
+
: null;
|
|
123
|
+
generateFiles(tree, joinPathFragments(generatorDir, 'files', 'app'), projectRoot, {
|
|
64
124
|
tmpl: '',
|
|
65
125
|
database,
|
|
66
126
|
appDatabase: projectName,
|
|
67
127
|
});
|
|
128
|
+
if (existingMigrationsDatasource) {
|
|
129
|
+
tree.write(migrationsDatasourcePath, existingMigrationsDatasource);
|
|
130
|
+
}
|
|
68
131
|
if (!options.withCompose) {
|
|
69
132
|
const composePath = joinPathFragments(projectRoot, 'docker-compose.yml');
|
|
70
133
|
if (tree.exists(composePath)) {
|
|
71
134
|
tree.delete(composePath);
|
|
72
135
|
}
|
|
73
136
|
}
|
|
74
|
-
|
|
137
|
+
if (isNestApplication) {
|
|
138
|
+
patchAppModule(tree, projectRoot, sourceRoot);
|
|
139
|
+
}
|
|
140
|
+
}
|
|
141
|
+
function normalizeDatabase(database) {
|
|
142
|
+
const normalized = (database ?? DEFAULT_DATABASE).trim().toLowerCase();
|
|
143
|
+
const aliased = DATABASE_ALIAS_MAP[normalized] ??
|
|
144
|
+
normalized;
|
|
145
|
+
if (SUPPORTED_DATABASES.includes(aliased)) {
|
|
146
|
+
return aliased;
|
|
147
|
+
}
|
|
148
|
+
throw new Error(`Unsupported database "${database ?? DEFAULT_DATABASE}". Supported values: ${SUPPORTED_DATABASE_DISPLAY}.`);
|
|
149
|
+
}
|
|
150
|
+
function consumeProjectJsonPartial(tree, projectRoot) {
|
|
151
|
+
const tempPartialPath = joinPathFragments(projectRoot, 'project.json.partial');
|
|
152
|
+
if (!tree.exists(tempPartialPath)) {
|
|
153
|
+
return {};
|
|
154
|
+
}
|
|
155
|
+
const contents = tree.read(tempPartialPath, 'utf-8');
|
|
156
|
+
tree.delete(tempPartialPath);
|
|
157
|
+
if (!contents) {
|
|
158
|
+
return {};
|
|
159
|
+
}
|
|
160
|
+
try {
|
|
161
|
+
return JSON.parse(contents);
|
|
162
|
+
}
|
|
163
|
+
catch {
|
|
164
|
+
return {};
|
|
165
|
+
}
|
|
166
|
+
}
|
|
167
|
+
function moveGeneratedFile(tree, from, to) {
|
|
168
|
+
if (from === to || !tree.exists(from)) {
|
|
169
|
+
return;
|
|
170
|
+
}
|
|
171
|
+
const contents = tree.read(from);
|
|
172
|
+
if (!contents) {
|
|
173
|
+
return;
|
|
174
|
+
}
|
|
175
|
+
tree.write(to, contents);
|
|
176
|
+
tree.delete(from);
|
|
177
|
+
}
|
|
178
|
+
function patchMigrationSchemaImport(tree, schemaPath, migrationPath) {
|
|
179
|
+
if (!tree.exists(schemaPath) || !tree.exists(migrationPath)) {
|
|
180
|
+
return;
|
|
181
|
+
}
|
|
182
|
+
const migrationContents = tree.read(migrationPath, 'utf-8');
|
|
183
|
+
if (!migrationContents) {
|
|
184
|
+
return;
|
|
185
|
+
}
|
|
186
|
+
const schemaImportPath = importPathFrom(migrationPath, schemaPath);
|
|
187
|
+
const updatedContents = migrationContents.replace(/from\s+['"][^'"]+['"];/, `from '${schemaImportPath}';`);
|
|
188
|
+
tree.write(migrationPath, updatedContents);
|
|
189
|
+
}
|
|
190
|
+
function importPathFrom(fromFile, targetFile) {
|
|
191
|
+
const relativePath = relative(dirname(fromFile), targetFile).replace(/\\/g, '/');
|
|
192
|
+
const withoutExtension = relativePath.replace(/\.ts$/, '');
|
|
193
|
+
if (withoutExtension.startsWith('.')) {
|
|
194
|
+
return withoutExtension;
|
|
195
|
+
}
|
|
196
|
+
return `./${withoutExtension}`;
|
|
197
|
+
}
|
|
198
|
+
function normalizeProjectRelative(pathValue) {
|
|
199
|
+
if (isAbsolute(pathValue)) {
|
|
200
|
+
throw new Error(`Path "${pathValue}" must be relative to the project root.`);
|
|
201
|
+
}
|
|
202
|
+
const forwardSlashes = pathValue.split('\\').join('/');
|
|
203
|
+
let start = 0;
|
|
204
|
+
if (forwardSlashes.startsWith('./')) {
|
|
205
|
+
start = 1;
|
|
206
|
+
while (start < forwardSlashes.length && forwardSlashes[start] === '/') {
|
|
207
|
+
start += 1;
|
|
208
|
+
}
|
|
209
|
+
}
|
|
210
|
+
let end = forwardSlashes.length;
|
|
211
|
+
while (end > start && forwardSlashes[end - 1] === '/') {
|
|
212
|
+
end -= 1;
|
|
213
|
+
}
|
|
214
|
+
const normalized = forwardSlashes.slice(start, end);
|
|
215
|
+
if (!normalized) {
|
|
216
|
+
throw new Error('Path options must not be empty.');
|
|
217
|
+
}
|
|
218
|
+
return normalized;
|
|
219
|
+
}
|
|
220
|
+
function hasNestModuleFile(tree, projectRoot, sourceRoot) {
|
|
221
|
+
const resolvedSourceRoot = sourceRoot ?? joinPathFragments(projectRoot, 'src');
|
|
222
|
+
return tree.exists(joinPathFragments(resolvedSourceRoot, 'app.module.ts'));
|
|
75
223
|
}
|
|
76
224
|
function patchAppModule(tree, projectRoot, sourceRoot) {
|
|
77
225
|
const resolvedSourceRoot = sourceRoot ?? joinPathFragments(projectRoot, 'src');
|
|
@@ -18,7 +18,16 @@
|
|
|
18
18
|
},
|
|
19
19
|
"db": {
|
|
20
20
|
"type": "string",
|
|
21
|
-
"description": "Database type
|
|
21
|
+
"description": "Database type used for generated datasource connection templates.",
|
|
22
|
+
"enum": [
|
|
23
|
+
"postgres",
|
|
24
|
+
"postgresql",
|
|
25
|
+
"mysql",
|
|
26
|
+
"mariadb",
|
|
27
|
+
"sqlite",
|
|
28
|
+
"better-sqlite3",
|
|
29
|
+
"mssql"
|
|
30
|
+
],
|
|
22
31
|
"default": "postgres"
|
|
23
32
|
},
|
|
24
33
|
"withCompose": {
|
|
@@ -30,6 +39,14 @@
|
|
|
30
39
|
"type": "boolean",
|
|
31
40
|
"description": "Skip running package installations after updating dependencies.",
|
|
32
41
|
"default": false
|
|
42
|
+
},
|
|
43
|
+
"schemaPath": {
|
|
44
|
+
"type": "string",
|
|
45
|
+
"description": "Relative path from the project root where schema.ts should be generated for library projects."
|
|
46
|
+
},
|
|
47
|
+
"migrationsDir": {
|
|
48
|
+
"type": "string",
|
|
49
|
+
"description": "Relative directory from the project root where the initial migration should be generated for library projects."
|
|
33
50
|
}
|
|
34
51
|
},
|
|
35
52
|
"required": ["project"],
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"generator.d.ts","sourceRoot":"","sources":["../../../src/generators/entity-create/generator.ts"],"names":[],"mappings":"AAAA,OAAO,EAKL,KAAK,IAAI,EACV,MAAM,YAAY,CAAC;AAIpB,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,aAAa,CAAC;AAE/D,wBAA8B,qBAAqB,CACjD,IAAI,EAAE,IAAI,EACV,OAAO,EAAE,2BAA2B,iBAuBrC"}
|