@balena/abstract-sql-to-typescript 2.3.0 → 2.4.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/.versionbot/CHANGELOG.yml +13 -1
- package/CHANGELOG.md +4 -0
- package/out/index.js +4 -13
- package/out/index.js.map +1 -1
- package/package.json +2 -2
- package/src/index.ts +6 -22
- package/test/index.ts +6 -6
|
@@ -1,3 +1,15 @@
|
|
|
1
|
+
- commits:
|
|
2
|
+
- subject: Improve foreign key typings by referencing the appropriate interface
|
|
3
|
+
hash: 2be23a8ad8a051bac1c52c0ca0b99c30e8c114d1
|
|
4
|
+
body: ""
|
|
5
|
+
footer:
|
|
6
|
+
Change-type: minor
|
|
7
|
+
change-type: minor
|
|
8
|
+
author: Pagan Gazzard
|
|
9
|
+
nested: []
|
|
10
|
+
version: 2.4.0
|
|
11
|
+
title: ""
|
|
12
|
+
date: 2024-04-18T14:27:51.044Z
|
|
1
13
|
- commits:
|
|
2
14
|
- subject: Allow using `PickDeferred` with a single parameter to defer all keys
|
|
3
15
|
hash: 60b4233b03c1ec25165b800de1fd9bd31158cfca
|
|
@@ -17,7 +29,7 @@
|
|
|
17
29
|
nested: []
|
|
18
30
|
version: 2.3.0
|
|
19
31
|
title: ""
|
|
20
|
-
date: 2024-04-
|
|
32
|
+
date: 2024-04-17T23:02:53.473Z
|
|
21
33
|
- commits:
|
|
22
34
|
- subject: Add support for Big Serial
|
|
23
35
|
hash: b1d91eea5f28d2724be7c589fc6d6a9b446e9880
|
package/CHANGELOG.md
CHANGED
|
@@ -4,6 +4,10 @@ All notable changes to this project will be documented in this file
|
|
|
4
4
|
automatically by Versionist. DO NOT EDIT THIS FILE MANUALLY!
|
|
5
5
|
This project adheres to [Semantic Versioning](http://semver.org/).
|
|
6
6
|
|
|
7
|
+
## 2.4.0 - 2024-04-18
|
|
8
|
+
|
|
9
|
+
* Improve foreign key typings by referencing the appropriate interface [Pagan Gazzard]
|
|
10
|
+
|
|
7
11
|
## 2.3.0 - 2024-04-17
|
|
8
12
|
|
|
9
13
|
* Allow using `PickDeferred` with a single parameter to defer all keys [Pagan Gazzard]
|
package/out/index.js
CHANGED
|
@@ -29,15 +29,6 @@ const modelNameToCamelCaseName = (s) => s
|
|
|
29
29
|
.split(/[ -]/)
|
|
30
30
|
.map((p) => p[0].toLocaleUpperCase() + p.slice(1))
|
|
31
31
|
.join('');
|
|
32
|
-
const getReferencedDataType = (m, { references }, opts) => {
|
|
33
|
-
if (references != null) {
|
|
34
|
-
const referencedField = m.tables[references.resourceName].fields.find((f) => f.fieldName === references.fieldName);
|
|
35
|
-
if (referencedField != null) {
|
|
36
|
-
return sqlTypeToTypescriptType(m, referencedField, opts);
|
|
37
|
-
}
|
|
38
|
-
}
|
|
39
|
-
return 'number';
|
|
40
|
-
};
|
|
41
32
|
const sqlTypeToTypescriptType = (m, f, opts) => {
|
|
42
33
|
if (!['ForeignKey', 'ConceptType'].includes(f.dataType) && f.checks) {
|
|
43
34
|
const inChecks = f.checks.find((checkTuple) => checkTuple[0] === 'In');
|
|
@@ -66,13 +57,13 @@ const sqlTypeToTypescriptType = (m, f, opts) => {
|
|
|
66
57
|
return 'number';
|
|
67
58
|
case 'ConceptType':
|
|
68
59
|
case 'ForeignKey': {
|
|
69
|
-
const
|
|
60
|
+
const referencedInterface = modelNameToCamelCaseName(m.tables[f.references.resourceName].name);
|
|
61
|
+
const referencedFieldType = `${referencedInterface}['${f.references.fieldName}']`;
|
|
70
62
|
if (opts.mode === 'write') {
|
|
71
|
-
return
|
|
63
|
+
return referencedFieldType;
|
|
72
64
|
}
|
|
73
|
-
const referencedInterface = modelNameToCamelCaseName(m.tables[f.references.resourceName].name);
|
|
74
65
|
const nullable = f.required ? '' : '?';
|
|
75
|
-
return `{ __id: ${
|
|
66
|
+
return `{ __id: ${referencedFieldType} } | [${referencedInterface}${nullable}]`;
|
|
76
67
|
}
|
|
77
68
|
case 'File':
|
|
78
69
|
return 'Buffer';
|
package/out/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AASA,yEAGuC;AACvC,6CAAoE;AAOpE,MAAM,WAAW,GAAG;IACnB,IAAI,EAAE;;;;;;;;;;;;;;;;;CAiBN;IACA,KAAK,EAAE,EAAE;CACT,CAAC;AAEF,MAAM,MAAM,GAAG,IAAI,yBAAW,CAC7B,IAAA,sCAAwB,EAAC,oBAAoB,EAAE,EAAE,CAAC,CAClD,CAAC;AAEF,MAAM,wBAAwB,GAAG,CAAC,CAAS,EAAU,EAAE,CACtD,CAAC;KACC,KAAK,CAAC,MAAM,CAAC;KACb,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,iBAAiB,EAAE,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;KACjD,IAAI,CAAC,EAAE,CAAC,CAAC;AAEZ,MAAM,
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AASA,yEAGuC;AACvC,6CAAoE;AAOpE,MAAM,WAAW,GAAG;IACnB,IAAI,EAAE;;;;;;;;;;;;;;;;;CAiBN;IACA,KAAK,EAAE,EAAE;CACT,CAAC;AAEF,MAAM,MAAM,GAAG,IAAI,yBAAW,CAC7B,IAAA,sCAAwB,EAAC,oBAAoB,EAAE,EAAE,CAAC,CAClD,CAAC;AAEF,MAAM,wBAAwB,GAAG,CAAC,CAAS,EAAU,EAAE,CACtD,CAAC;KACC,KAAK,CAAC,MAAM,CAAC;KACb,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,iBAAiB,EAAE,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;KACjD,IAAI,CAAC,EAAE,CAAC,CAAC;AAEZ,MAAM,uBAAuB,GAAG,CAC/B,CAAsB,EACtB,CAAmB,EACnB,IAAqB,EACZ,EAAE;IACX,IAAI,CAAC,CAAC,YAAY,EAAE,aAAa,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,CAAC;QACrE,MAAM,QAAQ,GAAG,CAAC,CAAC,MAAM,CAAC,IAAI,CAC7B,CAAC,UAAU,EAAwB,EAAE,CAAC,UAAU,CAAC,CAAC,CAAC,KAAK,IAAI,CAC5D,CAAC;QACF,IAAI,QAAQ,EAAE,CAAC;YACd,MAAM,CAAC,EAAE,AAAD,EAAG,GAAG,aAAa,CAAC,GAAG,QAAQ,CAAC;YACxC,OAAO,aAAa;iBAClB,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,CAAC,IAAI,KAAK,MAAM,CAAC,CAAC,CAAC,IAAI,KAAK,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;iBAChE,IAAI,CAAC,KAAK,CAAC,CAAC;QACf,CAAC;IACF,CAAC;IAED,QAAQ,CAAC,CAAC,QAAQ,EAAE,CAAC;QACpB,KAAK,SAAS;YACb,OAAO,SAAS,CAAC;QAClB,KAAK,YAAY,CAAC;QAClB,KAAK,MAAM,CAAC;QACZ,KAAK,QAAQ;YACZ,OAAO,QAAQ,CAAC;QACjB,KAAK,MAAM,CAAC;QACZ,KAAK,WAAW;YACf,OAAO,IAAI,CAAC,IAAI,KAAK,MAAM,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,MAAM,CAAC;QACrD,KAAK,QAAQ,CAAC;QACd,KAAK,YAAY,CAAC;QAClB,KAAK,SAAS,CAAC;QACf,KAAK,aAAa,CAAC;QACnB,KAAK,MAAM;YACV,OAAO,QAAQ,CAAC;QACjB,KAAK,aAAa,CAAC;QACnB,KAAK,YAAY,CAAC,CAAC,CAAC;YACnB,MAAM,mBAAmB,GAAG,wBAAwB,CACnD,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,UAAW,CAAC,YAAY,CAAC,CAAC,IAAI,CACzC,CAAC;YACF,MAAM,mBAAmB,GAAG,GAAG,mBAAmB,KAAK,CAAC,CAAC,UAAW,CAAC,SAAS,IAAI,CAAC;YACnF,IAAI,IAAI,CAAC,IAAI,KAAK,OAAO,EAAE,CAAC;gBAC3B,OAAO,mBAAmB,CAAC;YAC5B,CAAC;YAED,MAAM,QAAQ,GAAG,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC;YACvC,OAAO,WAAW,mBAAmB,SAAS,mBAAmB,GAAG,QAAQ,GAAG,CAAC;QACjF,CAAC;QACD,KAAK,MAAM;YACV,OAAO,QAAQ,CAAC;QACjB,KAAK,MAAM;YACV,OAAO,QAAQ,CAAC;QACjB,KAAK,aAAa;YACjB,OAAO,aAAa,CAAC;QACtB;YACC,MAAM,IAAI,KAAK,CAAC,uBAAuB,CAAC,CAAC,QAAQ,GAAG,CAAC,CAAC;IACxD,CAAC;AACF,CAAC,CAAC;AAEF,MAAM,sBAAsB,GAAG,CAC9B,CAAsB,EACtB,MAA0B,EAC1B,IAAqB,EACV,EAAE,CACb,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE;IAChB,MAAM,QAAQ,GAAG,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;IAC7C,OAAO,GAAG,IAAA,0CAAkB,EAAC,CAAC,CAAC,SAAS,CAAC,KAAK,uBAAuB,CACpE,CAAC,EACD,CAAC,EACD,IAAI,CACJ,GAAG,QAAQ,GAAG,CAAC;AACjB,CAAC,CAAC,CAAC;AAEJ,MAAM,oBAAoB,GAAG,CAC5B,CAAsB,EACtB,aAA2B,EAC3B,eAAuC,EACvC,IAAqB,EACrB,YAA8B,EAC9B,SAAiB,EACN,EAAE,CACb,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;IAC1C,IAAI,GAAG,KAAK,GAAG,EAAE,CAAC;QACjB,MAAM,CAAC,UAAU,EAAE,eAAe,CAAC,GAClC,aACA,CAAC,CAAC,CAAC;QACJ,IAAI,YAAY,CAAC,OAAO,KAAK,UAAU,IAAI,eAAe,IAAI,IAAI,EAAE,CAAC;YACpE,MAAM,eAAe,GAAG,CAAC,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,CAAC;YACrD,IAAI,eAAe,IAAI,IAAI,EAAE,CAAC;gBAC7B,MAAM,mBAAmB,GAAG,wBAAwB,CACnD,eAAe,CAAC,IAAI,CACpB,CAAC;gBACF,MAAM,cAAc,GAAG,CAAC,GAAG,SAAS,MAAM,mBAAmB,KAAK,CAAC,CAAC;gBACpE,MAAM,OAAO,GAAG,eAAe,CAAC,IAAA,0CAAkB,EAAC,SAAS,CAAC,CAAC,CAAC;gBAC/D,IAAI,OAAO,IAAI,IAAI,EAAE,CAAC;oBACrB,cAAc,CAAC,IAAI,CAClB,GAAG,IAAA,0CAAkB,EAAC,OAAO,CAAC,MAAM,mBAAmB,KAAK,CAC5D,CAAC;gBACH,CAAC;gBACD,OAAO,cAAc,CAAC;YACvB,CAAC;QACF,CAAC;QACD,OAAO,EAAE,CAAC;IACX,CAAC;IACD,OAAO,oBAAoB,CAC1B,CAAC,EACA,aAA0C,CAAC,GAAG,CAAC,EAChD,eAAe,EACf,IAAI,EACJ,YAAY,EACZ,GAAG,SAAS,KAAK,GAAG,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,EAAE,CACzC,CAAC;AACH,CAAC,CAAC,CAAC;AAEJ,MAAM,6BAA6B,GAAG,CACrC,CAAsB,EACtB,KAAuB,EACvB,IAAqB,EACV,EAAE;IACb,MAAM,aAAa,GAAG,CAAC,CAAC,aAAa,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;IAC1D,IAAI,aAAa,IAAI,IAAI,EAAE,CAAC;QAC3B,OAAO,EAAE,CAAC;IACX,CAAC;IACD,OAAO,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;QAEjD,IAAI,GAAG,KAAK,KAAK,EAAE,CAAC;YACnB,OAAO,EAAE,CAAC;QACX,CAAC;QACD,MAAM,eAAe,GAAG,MAAM,CAAC,WAAW,CACzC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,QAAQ,EAAE,QAAQ,CAAC,EAAE,EAAE,CAAC;YACxD,QAAQ;YACR,QAAQ;SACR,CAAC,CACF,CAAC;QACF,OAAO,oBAAoB,CAC1B,CAAC,EACD,aAAa,CAAC,GAAG,CAAC,EAClB,eAAe,EACf,IAAI,EACJ,KAAK,EACL,GAAG,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,CACtB,CAAC;IACH,CAAC,CAAC,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,gBAAgB,GAAG,CACxB,CAAsB,EACtB,KAAuB,EACvB,IAAqB,EACpB,EAAE;IACH,MAAM,iBAAiB,GACtB,IAAI,CAAC,IAAI,KAAK,MAAM,CAAC,CAAC,CAAC,6BAA6B,CAAC,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IAE3E,OAAO,MAAM,CAAA;mBACK,wBAAwB,CAAC,KAAK,CAAC,IAAI,CAAC;GACpD,CAAC,GAAG,sBAAsB,CAAC,CAAC,EAAE,KAAK,CAAC,MAAM,EAAE,IAAI,CAAC,EAAE,GAAG,iBAAiB,CAAC,CAAC,IAAI,CAC9E,MAAM,CACN;;CAED,CAAC;AACF,CAAC,CAAC;AAOK,MAAM,4BAA4B,GAAG,CAC3C,CAAsB,EACtB,OAAgB,EAAE,EACT,EAAE;IACX,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,IAAI,MAAM,CAAC;IACjC,MAAM,eAAe,GAAoB;QACxC,GAAG,IAAI;QACP,IAAI;KACJ,CAAC;IACF,OAAO,MAAM,CAAA;EACZ,WAAW,CAAC,IAAI,CAAC;EACjB,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC;SACrB,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE;QAClB,MAAM,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;QAC9B,OAAO,gBAAgB,CAAC,CAAC,EAAE,CAAC,EAAE,eAAe,CAAC,CAAC;IAChD,CAAC,CAAC;SACD,IAAI,CAAC,MAAM,CAAC;CACb,CAAC;AACF,CAAC,CAAC;AAlBW,QAAA,4BAA4B,gCAkBvC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@balena/abstract-sql-to-typescript",
|
|
3
|
-
"version": "2.
|
|
3
|
+
"version": "2.4.0",
|
|
4
4
|
"description": "A translator for abstract sql into typescript types.",
|
|
5
5
|
"main": "out/index.js",
|
|
6
6
|
"types": "out/index.d.ts",
|
|
@@ -45,6 +45,6 @@
|
|
|
45
45
|
"_": "test/**/*.ts"
|
|
46
46
|
},
|
|
47
47
|
"versionist": {
|
|
48
|
-
"publishedAt": "2024-04-
|
|
48
|
+
"publishedAt": "2024-04-18T14:27:51.263Z"
|
|
49
49
|
}
|
|
50
50
|
}
|
package/src/index.ts
CHANGED
|
@@ -50,22 +50,6 @@ const modelNameToCamelCaseName = (s: string): string =>
|
|
|
50
50
|
.map((p) => p[0].toLocaleUpperCase() + p.slice(1))
|
|
51
51
|
.join('');
|
|
52
52
|
|
|
53
|
-
const getReferencedDataType = (
|
|
54
|
-
m: RequiredModelSubset,
|
|
55
|
-
{ references }: AbstractSqlField,
|
|
56
|
-
opts: RequiredOptions,
|
|
57
|
-
): string => {
|
|
58
|
-
if (references != null) {
|
|
59
|
-
const referencedField = m.tables[references.resourceName].fields.find(
|
|
60
|
-
(f) => f.fieldName === references.fieldName,
|
|
61
|
-
);
|
|
62
|
-
if (referencedField != null) {
|
|
63
|
-
return sqlTypeToTypescriptType(m, referencedField, opts);
|
|
64
|
-
}
|
|
65
|
-
}
|
|
66
|
-
return 'number';
|
|
67
|
-
};
|
|
68
|
-
|
|
69
53
|
const sqlTypeToTypescriptType = (
|
|
70
54
|
m: RequiredModelSubset,
|
|
71
55
|
f: AbstractSqlField,
|
|
@@ -101,16 +85,16 @@ const sqlTypeToTypescriptType = (
|
|
|
101
85
|
return 'number';
|
|
102
86
|
case 'ConceptType':
|
|
103
87
|
case 'ForeignKey': {
|
|
104
|
-
const referencedDataType = getReferencedDataType(m, f, opts);
|
|
105
|
-
if (opts.mode === 'write') {
|
|
106
|
-
return referencedDataType;
|
|
107
|
-
}
|
|
108
|
-
|
|
109
88
|
const referencedInterface = modelNameToCamelCaseName(
|
|
110
89
|
m.tables[f.references!.resourceName].name,
|
|
111
90
|
);
|
|
91
|
+
const referencedFieldType = `${referencedInterface}['${f.references!.fieldName}']`;
|
|
92
|
+
if (opts.mode === 'write') {
|
|
93
|
+
return referencedFieldType;
|
|
94
|
+
}
|
|
95
|
+
|
|
112
96
|
const nullable = f.required ? '' : '?';
|
|
113
|
-
return `{ __id: ${
|
|
97
|
+
return `{ __id: ${referencedFieldType} } | [${referencedInterface}${nullable}]`;
|
|
114
98
|
}
|
|
115
99
|
case 'File':
|
|
116
100
|
return 'Buffer';
|
package/test/index.ts
CHANGED
|
@@ -321,8 +321,8 @@ test(
|
|
|
321
321
|
id: number;
|
|
322
322
|
a_date: DateString;
|
|
323
323
|
a_file: WebResource;
|
|
324
|
-
parent: { __id:
|
|
325
|
-
references__other: { __id:
|
|
324
|
+
parent: { __id: Parent['id'] } | [Parent];
|
|
325
|
+
references__other: { __id: Other['id'] } | [Other];
|
|
326
326
|
test__has__tag_key?: TestTag[];
|
|
327
327
|
test_tag?: TestTag[];
|
|
328
328
|
}
|
|
@@ -330,7 +330,7 @@ test(
|
|
|
330
330
|
export interface TestTag {
|
|
331
331
|
created_at: DateString;
|
|
332
332
|
modified_at: DateString;
|
|
333
|
-
test: { __id:
|
|
333
|
+
test: { __id: Test['id'] } | [Test];
|
|
334
334
|
tag_key: string;
|
|
335
335
|
id: number;
|
|
336
336
|
}
|
|
@@ -359,14 +359,14 @@ test(
|
|
|
359
359
|
id: number;
|
|
360
360
|
a_date: Date;
|
|
361
361
|
a_file: WebResource;
|
|
362
|
-
parent:
|
|
363
|
-
references__other:
|
|
362
|
+
parent: Parent['id'];
|
|
363
|
+
references__other: Other['id'];
|
|
364
364
|
}
|
|
365
365
|
|
|
366
366
|
export interface TestTag {
|
|
367
367
|
created_at: Date;
|
|
368
368
|
modified_at: Date;
|
|
369
|
-
test:
|
|
369
|
+
test: Test['id'];
|
|
370
370
|
tag_key: string;
|
|
371
371
|
id: number;
|
|
372
372
|
}
|