@anarchitects/nx-typeorm 0.4.4 → 0.5.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 +7 -4
- package/dist/executors/ensure-schema/executor.d.ts.map +1 -1
- package/dist/executors/ensure-schema/executor.js +1 -2
- package/dist/generators/bootstrap/files/app/env.example__tmpl__ +1 -4
- package/dist/generators/bootstrap/files/app/src/data-source.ts__tmpl__ +0 -4
- package/dist/generators/bootstrap/files/app/tools/typeorm/datasource.migrations.ts__tmpl__ +0 -4
- package/dist/generators/bootstrap/generator.d.ts +1 -1
- package/dist/generators/bootstrap/generator.d.ts.map +1 -1
- package/dist/generators/bootstrap/generator.js +2 -6
- package/dist/generators/bootstrap/schema.json +0 -1
- package/dist/generators/init/generator.js +1 -1
- package/dist/utils/shared.d.ts.map +1 -1
- package/dist/utils/shared.js +9 -2
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -29,6 +29,9 @@ nx g @anarchitects/nx-typeorm:init
|
|
|
29
29
|
|
|
30
30
|
## Generators
|
|
31
31
|
|
|
32
|
+
Compatibility: supports Nx `>=19 <24`, including Nx 23, TypeScript 5.9.x and
|
|
33
|
+
6.x, and TypeORM 1.x. See the [plugin support matrix](../../docs/support-matrix.md).
|
|
34
|
+
|
|
32
35
|
### `init`
|
|
33
36
|
|
|
34
37
|
```bash
|
|
@@ -65,12 +68,12 @@ For libraries:
|
|
|
65
68
|
- patches project metadata (`metadata.typeorm`) with schema/domain and paths.
|
|
66
69
|
|
|
67
70
|
Additional bootstrap dependencies are installed during bootstrap:
|
|
68
|
-
`ts-node`,
|
|
69
|
-
|
|
70
|
-
|
|
71
|
+
`ts-node`, the DB driver package for selected `--db`, and `@nestjs/typeorm`
|
|
72
|
+
only for Nest applications. TypeORM 1.x provides the
|
|
73
|
+
`typeorm-ts-node-commonjs` and `typeorm-ts-node-esm` CLI binaries directly.
|
|
71
74
|
|
|
72
75
|
Supported `--db` values: `postgres`, `postgresql` (normalized to `postgres`),
|
|
73
|
-
`mysql`, `mariadb`, `
|
|
76
|
+
`mysql`, `mariadb`, `better-sqlite3`, `mssql`.
|
|
74
77
|
|
|
75
78
|
Generated app datasources support two connection modes:
|
|
76
79
|
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"executor.d.ts","sourceRoot":"","sources":["../../../src/executors/ensure-schema/executor.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AAQlD,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,aAAa,CAAC;AAE/D,wBAA8B,YAAY,CACxC,OAAO,EAAE,2BAA2B,EACpC,OAAO,EAAE,eAAe;;
|
|
1
|
+
{"version":3,"file":"executor.d.ts","sourceRoot":"","sources":["../../../src/executors/ensure-schema/executor.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AAQlD,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,aAAa,CAAC;AAE/D,wBAA8B,YAAY,CACxC,OAAO,EAAE,2BAA2B,EACpC,OAAO,EAAE,eAAe;;GAsEzB"}
|
|
@@ -32,8 +32,7 @@ export default async function ensureSchema(options, context) {
|
|
|
32
32
|
]);
|
|
33
33
|
logger.info(`Ensured database "${schemaName}" exists.`);
|
|
34
34
|
}
|
|
35
|
-
else if (dataSource.options.type === '
|
|
36
|
-
dataSource.options.type === 'better-sqlite3') {
|
|
35
|
+
else if (dataSource.options.type === 'better-sqlite3') {
|
|
37
36
|
logger.info('SQLite does not support schemas; ensure-schema is a no-op.');
|
|
38
37
|
}
|
|
39
38
|
else {
|
|
@@ -7,7 +7,7 @@
|
|
|
7
7
|
<% if (database === 'postgres') { %>DATABASE_URL=postgresql://postgres:postgres@localhost:5432/<%= appDatabase %>
|
|
8
8
|
<% } %><% if (database === 'mysql' || database === 'mariadb') { %>DATABASE_URL=<%= database %>://root:root@localhost:3306/<%= appDatabase %>
|
|
9
9
|
<% } %><% if (database === 'mssql') { %>DATABASE_URL=sqlserver://sa:StrongPassword!123@localhost:1433;database=<%= appDatabase %>
|
|
10
|
-
<% } %><% if (database === '
|
|
10
|
+
<% } %><% if (database === 'better-sqlite3') { %>DATABASE_URL=./tmp/<%= appDatabase %>.sqlite
|
|
11
11
|
<% } %>
|
|
12
12
|
|
|
13
13
|
# Mode 2: TYPEORM_* variables
|
|
@@ -43,9 +43,6 @@ TYPEORM_REQUEST_TIMEOUT=15000
|
|
|
43
43
|
TYPEORM_ENCRYPT=false
|
|
44
44
|
TYPEORM_TRUST_SERVER_CERTIFICATE=true
|
|
45
45
|
TYPEORM_INSTANCE_NAME=
|
|
46
|
-
<% } %><% if (database === 'sqlite') { %>TYPEORM_DATABASE=./tmp/<%= appDatabase %>.sqlite
|
|
47
|
-
TYPEORM_BUSY_TIMEOUT=5000
|
|
48
|
-
TYPEORM_ENABLE_WAL=true
|
|
49
46
|
<% } %><% if (database === 'better-sqlite3') { %>TYPEORM_DATABASE=./tmp/<%= appDatabase %>.sqlite
|
|
50
47
|
TYPEORM_ENABLE_WAL=true
|
|
51
48
|
TYPEORM_TIMEOUT=5000
|
|
@@ -22,10 +22,6 @@ export const AppDataSource = new DataSource({
|
|
|
22
22
|
charset: process.env.TYPEORM_CHARSET ?? 'utf8mb4',
|
|
23
23
|
timezone: process.env.TYPEORM_TIMEZONE ?? 'Z',
|
|
24
24
|
connectTimeout: Number.parseInt(process.env.TYPEORM_CONNECT_TIMEOUT ?? '10000', 10) || 10000,
|
|
25
|
-
<% } %><% if (database === 'sqlite') { %> type: 'sqlite',
|
|
26
|
-
database: process.env.TYPEORM_DATABASE ?? './tmp/<%= appDatabase %>.sqlite',
|
|
27
|
-
busyTimeout: Number.parseInt(process.env.TYPEORM_BUSY_TIMEOUT ?? '5000', 10) || 5000,
|
|
28
|
-
enableWAL: process.env.TYPEORM_ENABLE_WAL === undefined ? true : process.env.TYPEORM_ENABLE_WAL === 'true',
|
|
29
25
|
<% } %><% if (database === 'better-sqlite3') { %> type: 'better-sqlite3',
|
|
30
26
|
database: process.env.TYPEORM_DATABASE ?? './tmp/<%= appDatabase %>.sqlite',
|
|
31
27
|
enableWAL: process.env.TYPEORM_ENABLE_WAL === undefined ? true : process.env.TYPEORM_ENABLE_WAL === 'true',
|
|
@@ -22,10 +22,6 @@ const MigrationDataSource = new DataSource({
|
|
|
22
22
|
charset: process.env.TYPEORM_CHARSET ?? 'utf8mb4',
|
|
23
23
|
timezone: process.env.TYPEORM_TIMEZONE ?? 'Z',
|
|
24
24
|
connectTimeout: Number.parseInt(process.env.TYPEORM_CONNECT_TIMEOUT ?? '10000', 10) || 10000,
|
|
25
|
-
<% } %><% if (database === 'sqlite') { %> type: 'sqlite',
|
|
26
|
-
database: process.env.TYPEORM_DATABASE ?? './tmp/<%= appDatabase %>.sqlite',
|
|
27
|
-
busyTimeout: Number.parseInt(process.env.TYPEORM_BUSY_TIMEOUT ?? '5000', 10) || 5000,
|
|
28
|
-
enableWAL: process.env.TYPEORM_ENABLE_WAL === undefined ? true : process.env.TYPEORM_ENABLE_WAL === 'true',
|
|
29
25
|
<% } %><% if (database === 'better-sqlite3') { %> type: 'better-sqlite3',
|
|
30
26
|
database: process.env.TYPEORM_DATABASE ?? './tmp/<%= appDatabase %>.sqlite',
|
|
31
27
|
enableWAL: process.env.TYPEORM_ENABLE_WAL === undefined ? true : process.env.TYPEORM_ENABLE_WAL === 'true',
|
|
@@ -10,7 +10,7 @@ interface BootstrapGeneratorSchema {
|
|
|
10
10
|
schemaPath?: string;
|
|
11
11
|
migrationsDir?: string;
|
|
12
12
|
}
|
|
13
|
-
declare const SUPPORTED_DATABASES: readonly ["postgres", "mysql", "mariadb", "
|
|
13
|
+
declare const SUPPORTED_DATABASES: readonly ["postgres", "mysql", "mariadb", "better-sqlite3", "mssql"];
|
|
14
14
|
type SupportedDatabase = (typeof SUPPORTED_DATABASES)[number];
|
|
15
15
|
export default function bootstrapGenerator(tree: Tree, options: BootstrapGeneratorSchema): Promise<GeneratorCallback>;
|
|
16
16
|
export {};
|
|
@@ -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;AAkBpB,UAAU,wBAAwB;IAChC,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,EAAE,CAAC,EAAE,iBAAiB,GAAG,YAAY,CAAC;IACtC,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAOD,QAAA,MAAM,mBAAmB,
|
|
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;AAkBpB,UAAU,wBAAwB;IAChC,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,EAAE,CAAC,EAAE,iBAAiB,GAAG,YAAY,CAAC;IACtC,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAOD,QAAA,MAAM,mBAAmB,sEAMf,CAAC;AAUX,KAAK,iBAAiB,GAAG,CAAC,OAAO,mBAAmB,CAAC,CAAC,MAAM,CAAC,CAAC;AAkB9D,wBAA8B,kBAAkB,CAC9C,IAAI,EAAE,IAAI,EACV,OAAO,EAAE,wBAAwB,8BA4ClC"}
|
|
@@ -11,7 +11,6 @@ const SUPPORTED_DATABASES = [
|
|
|
11
11
|
'postgres',
|
|
12
12
|
'mysql',
|
|
13
13
|
'mariadb',
|
|
14
|
-
'sqlite',
|
|
15
14
|
'better-sqlite3',
|
|
16
15
|
'mssql',
|
|
17
16
|
];
|
|
@@ -25,7 +24,6 @@ const DRIVER_DEPENDENCIES = {
|
|
|
25
24
|
postgres: { packageName: 'pg', version: '^8.20.0' },
|
|
26
25
|
mysql: { packageName: 'mysql2', version: '^3.20.0' },
|
|
27
26
|
mariadb: { packageName: 'mariadb', version: '^3.5.2' },
|
|
28
|
-
sqlite: { packageName: 'sqlite3', version: '^6.0.1' },
|
|
29
27
|
'better-sqlite3': { packageName: 'better-sqlite3', version: '^12.8.0' },
|
|
30
28
|
mssql: { packageName: 'mssql', version: '^12.2.1' },
|
|
31
29
|
};
|
|
@@ -55,21 +53,19 @@ export default async function bootstrapGenerator(tree, options) {
|
|
|
55
53
|
}
|
|
56
54
|
function buildRuntimeDependencies(database, isNestApplication) {
|
|
57
55
|
const dependencies = {
|
|
58
|
-
typeorm: '^0.
|
|
56
|
+
typeorm: '^1.0.0',
|
|
59
57
|
'reflect-metadata': '^0.2.2',
|
|
60
58
|
};
|
|
61
59
|
const driverDependency = DRIVER_DEPENDENCIES[database];
|
|
62
60
|
dependencies[driverDependency.packageName] = driverDependency.version;
|
|
63
61
|
if (isNestApplication) {
|
|
64
|
-
dependencies['@nestjs/typeorm'] = '^11.0.0';
|
|
62
|
+
dependencies['@nestjs/typeorm'] = '^11.0.1 || ^12.0.1';
|
|
65
63
|
}
|
|
66
64
|
return dependencies;
|
|
67
65
|
}
|
|
68
66
|
function buildToolDependencies() {
|
|
69
67
|
return {
|
|
70
68
|
'ts-node': '^10.9.2',
|
|
71
|
-
'typeorm-ts-node-commonjs': '^0.3.20',
|
|
72
|
-
'typeorm-ts-node-esm': '^0.3.20',
|
|
73
69
|
};
|
|
74
70
|
}
|
|
75
71
|
function prepareLibrary(tree, projectName, projectRoot, options) {
|
|
@@ -3,7 +3,7 @@ const TYPEORM_PLUGIN_NAME = '@anarchitects/nx-typeorm';
|
|
|
3
3
|
export default async function initGenerator(tree, options = {}) {
|
|
4
4
|
ensureNxPluginRegistration(tree);
|
|
5
5
|
const dependencyTask = addDependenciesToPackageJson(tree, {
|
|
6
|
-
typeorm: '^0.
|
|
6
|
+
typeorm: '^1.0.0',
|
|
7
7
|
'reflect-metadata': '^0.2.2',
|
|
8
8
|
}, {});
|
|
9
9
|
if (!options.skipFormat) {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"shared.d.ts","sourceRoot":"","sources":["../../src/utils/shared.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,eAAe,EAAwB,MAAM,YAAY,CAAC;AAExE,KAAK,YAAY,GAAG,MAAM,GAAG,UAAU,GAAG,KAAK,CAAC;AAChD,KAAK,gBAAgB,GAAG,0BAA0B,GAAG,qBAAqB,CAAC;AAE3E,KAAK,4BAA4B,GAAG;IAClC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF,KAAK,mBAAmB,GAAG;IACzB,YAAY,CAAC,EAAE,YAAY,CAAC;CAC7B,CAAC;AAEF,KAAK,oBAAoB,GAAG;IAC1B,WAAW,EAAE,MAAM,CAAC;IACpB,mBAAmB,EAAE,MAAM,CAAC;IAC5B,UAAU,EAAE,MAAM,CAAC;CACpB,CAAC;AA0BF,wBAAgB,iBAAiB,CAC/B,OAAO,EAAE,4BAA4B,EACrC,OAAO,EAAE,eAAe,GACvB,oBAAoB,CAStB;AAED,wBAAgB,uBAAuB,CACrC,OAAO,EAAE,mBAAmB,EAC5B,OAAO,EAAE,eAAe,EACxB,mBAAmB,EAAE,MAAM,GAC1B,gBAAgB,CAWlB;AAED,wBAAgB,kBAAkB,CAChC,cAAc,EAAE,MAAM,GAAG,SAAS,EAClC,OAAO,EAAE,eAAe,GACvB;IAAE,WAAW,EAAE,MAAM,CAAC;IAAC,mBAAmB,EAAE,MAAM,CAAA;CAAE,CActD;
|
|
1
|
+
{"version":3,"file":"shared.d.ts","sourceRoot":"","sources":["../../src/utils/shared.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,eAAe,EAAwB,MAAM,YAAY,CAAC;AAExE,KAAK,YAAY,GAAG,MAAM,GAAG,UAAU,GAAG,KAAK,CAAC;AAChD,KAAK,gBAAgB,GAAG,0BAA0B,GAAG,qBAAqB,CAAC;AAE3E,KAAK,4BAA4B,GAAG;IAClC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF,KAAK,mBAAmB,GAAG;IACzB,YAAY,CAAC,EAAE,YAAY,CAAC;CAC7B,CAAC;AAEF,KAAK,oBAAoB,GAAG;IAC1B,WAAW,EAAE,MAAM,CAAC;IACpB,mBAAmB,EAAE,MAAM,CAAC;IAC5B,UAAU,EAAE,MAAM,CAAC;CACpB,CAAC;AA0BF,wBAAgB,iBAAiB,CAC/B,OAAO,EAAE,4BAA4B,EACrC,OAAO,EAAE,eAAe,GACvB,oBAAoB,CAStB;AAED,wBAAgB,uBAAuB,CACrC,OAAO,EAAE,mBAAmB,EAC5B,OAAO,EAAE,eAAe,EACxB,mBAAmB,EAAE,MAAM,GAC1B,gBAAgB,CAWlB;AAED,wBAAgB,kBAAkB,CAChC,cAAc,EAAE,MAAM,GAAG,SAAS,EAClC,OAAO,EAAE,eAAe,GACvB;IAAE,WAAW,EAAE,MAAM,CAAC;IAAC,mBAAmB,EAAE,MAAM,CAAA;CAAE,CActD;AAkTD,wBAAgB,0BAA0B,CACxC,WAAW,EAAE,MAAM,EACnB,WAAW,EAAE,aAAa,GAAG,SAAS,GAAG,SAAS,GACjD,MAAM,CAMR;AAED,wBAAgB,cAAc,CAC5B,OAAO,EAAE,eAAe,GACvB,aAAa,GAAG,SAAS,GAAG,SAAS,CAKvC;AAED,wBAAgB,cAAc,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,CAE1D;AAED,wBAAgB,cAAc,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAGnE;AAED,wBAAgB,aAAa,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAElD;AAED,wBAAgB,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAKjD"}
|
package/dist/utils/shared.js
CHANGED
|
@@ -207,12 +207,19 @@ function isEsmModule(moduleValue) {
|
|
|
207
207
|
}
|
|
208
208
|
function assertRunnerInstalled(runner, workspaceRoot) {
|
|
209
209
|
try {
|
|
210
|
-
requireFromExecutor.resolve(
|
|
210
|
+
requireFromExecutor.resolve('typeorm/package.json', {
|
|
211
211
|
paths: [workspaceRoot],
|
|
212
212
|
});
|
|
213
213
|
}
|
|
214
214
|
catch {
|
|
215
|
-
|
|
215
|
+
try {
|
|
216
|
+
requireFromExecutor.resolve(`${runner}/package.json`, {
|
|
217
|
+
paths: [workspaceRoot],
|
|
218
|
+
});
|
|
219
|
+
}
|
|
220
|
+
catch {
|
|
221
|
+
throw new Error(`TypeORM CLI runner "${runner}" is unavailable because TypeORM is not installed. Install "typeorm" (or run @anarchitects/nx-typeorm:bootstrap) or set moduleSystem to a compatible value.`);
|
|
222
|
+
}
|
|
216
223
|
}
|
|
217
224
|
}
|
|
218
225
|
function isWithinOrEqual(pathValue, rootPath) {
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@anarchitects/nx-typeorm",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.5.0",
|
|
4
4
|
"description": "Nx plugin providing TypeORM executors, generators, and schema management utilities.",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "dist/index.js",
|
|
@@ -63,7 +63,7 @@
|
|
|
63
63
|
},
|
|
64
64
|
"peerDependencies": {
|
|
65
65
|
"ts-node": "^10.9.1",
|
|
66
|
-
"typeorm": "^0.
|
|
66
|
+
"typeorm": "^1.0.0"
|
|
67
67
|
},
|
|
68
68
|
"dependencies": {
|
|
69
69
|
"@nx/devkit": ">= 19 <24",
|