@tarangdb/generator 1.0.0-alpha.2 → 1.0.0-alpha.3
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 +13 -4
- package/dist/generate.d.ts +4 -0
- package/dist/generate.js +53 -5
- package/dist/generate.js.map +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# @tarangdb/generator
|
|
2
2
|
|
|
3
|
-
TarangDB JSON schema to TypeScript code generator.
|
|
3
|
+
TarangDB JSON schema to JavaScript/TypeScript code generator.
|
|
4
4
|
|
|
5
5
|
This package is primarily used by `@tarangdb/cli`, but can be used directly by tools that already have a Tarang schema response.
|
|
6
6
|
|
|
@@ -13,7 +13,7 @@ npm install @tarangdb/generator
|
|
|
13
13
|
## Usage
|
|
14
14
|
|
|
15
15
|
```ts
|
|
16
|
-
import { generateTypeScript } from "@tarangdb/generator";
|
|
16
|
+
import { generateJavaScript, generateTypeScript } from "@tarangdb/generator";
|
|
17
17
|
|
|
18
18
|
const source = await fetch("https://api.tarangdb.com/v1/projects/{projectId}/schema", {
|
|
19
19
|
headers: {
|
|
@@ -22,14 +22,23 @@ const source = await fetch("https://api.tarangdb.com/v1/projects/{projectId}/sch
|
|
|
22
22
|
});
|
|
23
23
|
|
|
24
24
|
const schema = await source.json();
|
|
25
|
-
const
|
|
25
|
+
const tsCode = generateTypeScript(schema);
|
|
26
|
+
const jsCode = generateJavaScript(schema);
|
|
26
27
|
```
|
|
27
28
|
|
|
28
|
-
Generated output includes:
|
|
29
|
+
Generated TypeScript output includes:
|
|
29
30
|
|
|
30
31
|
- row, insert, and update interfaces per table
|
|
31
32
|
- `TarangSchema` registry for `TarangClient<TarangSchema>`
|
|
32
33
|
- `tarangSchemaMetadata` with table and column mappings
|
|
34
|
+
- ready-to-use typed `tarang` client that loads `.env` with `dotenv/config`
|
|
35
|
+
|
|
36
|
+
Generated JavaScript output includes:
|
|
37
|
+
|
|
38
|
+
- `tarangSchemaMetadata` with table and column mappings
|
|
39
|
+
- ready-to-use `tarang` client
|
|
40
|
+
|
|
41
|
+
Use `generateJavaScript(schema, { module: "esm" })` to emit ESM JavaScript instead of CommonJS.
|
|
33
42
|
|
|
34
43
|
## Status
|
|
35
44
|
|
package/dist/generate.d.ts
CHANGED
|
@@ -1,2 +1,6 @@
|
|
|
1
1
|
import type { TarangProjectSchemaResponse } from "./schema";
|
|
2
|
+
export interface GenerateJavaScriptOptions {
|
|
3
|
+
module?: "commonjs" | "esm";
|
|
4
|
+
}
|
|
2
5
|
export declare function generateTypeScript(schema: TarangProjectSchemaResponse): string;
|
|
6
|
+
export declare function generateJavaScript(schema: TarangProjectSchemaResponse, options?: GenerateJavaScriptOptions): string;
|
package/dist/generate.js
CHANGED
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
exports.generateTypeScript = generateTypeScript;
|
|
4
|
+
exports.generateJavaScript = generateJavaScript;
|
|
4
5
|
const naming_1 = require("./naming");
|
|
5
6
|
const TYPE_MAP = {
|
|
6
7
|
string: "string",
|
|
@@ -19,10 +20,11 @@ function generateTypeScript(schema) {
|
|
|
19
20
|
if (!schema || !Array.isArray(schema.tables)) {
|
|
20
21
|
throw new Error("Invalid TarangProjectSchemaResponse: expected a tables array.");
|
|
21
22
|
}
|
|
22
|
-
const
|
|
23
|
-
const generatedTables = schema.tables.map((table, index) => buildGeneratedTable(table, tableSymbols[index]));
|
|
23
|
+
const generatedTables = buildGeneratedTables(schema);
|
|
24
24
|
const lines = [
|
|
25
25
|
"/* Auto-generated by @tarangdb/generator. Do not edit by hand. */",
|
|
26
|
+
'import "dotenv/config";',
|
|
27
|
+
'import { TarangClient } from "@tarangdb/sdk";',
|
|
26
28
|
"",
|
|
27
29
|
];
|
|
28
30
|
for (const generatedTable of generatedTables) {
|
|
@@ -30,8 +32,34 @@ function generateTypeScript(schema) {
|
|
|
30
32
|
}
|
|
31
33
|
lines.push(...renderSchemaRegistry(generatedTables));
|
|
32
34
|
lines.push(...renderSchemaMetadata(generatedTables));
|
|
35
|
+
lines.push(...renderTypeScriptClient());
|
|
36
|
+
return `${lines.join("\n")}\n`;
|
|
37
|
+
}
|
|
38
|
+
function generateJavaScript(schema, options = {}) {
|
|
39
|
+
if (!schema || !Array.isArray(schema.tables)) {
|
|
40
|
+
throw new Error("Invalid TarangProjectSchemaResponse: expected a tables array.");
|
|
41
|
+
}
|
|
42
|
+
const module = options.module ?? "commonjs";
|
|
43
|
+
const generatedTables = buildGeneratedTables(schema);
|
|
44
|
+
const lines = [
|
|
45
|
+
"/* Auto-generated by @tarangdb/generator. Do not edit by hand. */",
|
|
46
|
+
];
|
|
47
|
+
if (module === "esm") {
|
|
48
|
+
lines.push('import "dotenv/config";', 'import { TarangClient } from "@tarangdb/sdk";', "");
|
|
49
|
+
lines.push(...renderSchemaMetadata(generatedTables, "export const", false));
|
|
50
|
+
lines.push(...renderEsmJavaScriptClient());
|
|
51
|
+
}
|
|
52
|
+
else {
|
|
53
|
+
lines.push('require("dotenv/config");', 'const { TarangClient } = require("@tarangdb/sdk");', "");
|
|
54
|
+
lines.push(...renderSchemaMetadata(generatedTables, "const", false));
|
|
55
|
+
lines.push(...renderCommonJsClient());
|
|
56
|
+
}
|
|
33
57
|
return `${lines.join("\n")}\n`;
|
|
34
58
|
}
|
|
59
|
+
function buildGeneratedTables(schema) {
|
|
60
|
+
const tableSymbols = (0, naming_1.makeUniqueNames)(schema.tables.map((table) => (0, naming_1.ensureIdentifier)((0, naming_1.toPascalCase)(table.name || table.originalSheetName || "Table"))));
|
|
61
|
+
return schema.tables.map((table, index) => buildGeneratedTable(table, tableSymbols[index]));
|
|
62
|
+
}
|
|
35
63
|
function buildGeneratedTable(table, symbol) {
|
|
36
64
|
const columns = buildColumns(table.columns);
|
|
37
65
|
return {
|
|
@@ -105,8 +133,8 @@ function renderSchemaRegistry(generatedTables) {
|
|
|
105
133
|
lines.push("}", "");
|
|
106
134
|
return lines;
|
|
107
135
|
}
|
|
108
|
-
function renderSchemaMetadata(generatedTables) {
|
|
109
|
-
const lines = [
|
|
136
|
+
function renderSchemaMetadata(generatedTables, declaration = "export const", constAssertion = true) {
|
|
137
|
+
const lines = [`${declaration} tarangSchemaMetadata = {`, " tables: {"];
|
|
110
138
|
for (const generatedTable of generatedTables) {
|
|
111
139
|
lines.push(` ${(0, naming_1.escapeStringLiteral)(generatedTable.table.name)}: {`);
|
|
112
140
|
lines.push(` tableName: ${(0, naming_1.escapeStringLiteral)(generatedTable.table.name)},`);
|
|
@@ -118,7 +146,27 @@ function renderSchemaMetadata(generatedTables) {
|
|
|
118
146
|
lines.push(" ],");
|
|
119
147
|
lines.push(" },");
|
|
120
148
|
}
|
|
121
|
-
lines.push(" },", "} as const;", "");
|
|
149
|
+
lines.push(" },", constAssertion ? "} as const;" : "};", "");
|
|
122
150
|
return lines;
|
|
123
151
|
}
|
|
152
|
+
function renderTypeScriptClient() {
|
|
153
|
+
return [
|
|
154
|
+
"export const tarang = new TarangClient<TarangSchema>();",
|
|
155
|
+
];
|
|
156
|
+
}
|
|
157
|
+
function renderEsmJavaScriptClient() {
|
|
158
|
+
return [
|
|
159
|
+
"export const tarang = new TarangClient();",
|
|
160
|
+
];
|
|
161
|
+
}
|
|
162
|
+
function renderCommonJsClient() {
|
|
163
|
+
return [
|
|
164
|
+
"const tarang = new TarangClient();",
|
|
165
|
+
"",
|
|
166
|
+
"module.exports = {",
|
|
167
|
+
" tarang,",
|
|
168
|
+
" tarangSchemaMetadata,",
|
|
169
|
+
"};",
|
|
170
|
+
];
|
|
171
|
+
}
|
|
124
172
|
//# sourceMappingURL=generate.js.map
|
package/dist/generate.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"generate.js","sourceRoot":"","sources":["../src/generate.ts"],"names":[],"mappings":";;
|
|
1
|
+
{"version":3,"file":"generate.js","sourceRoot":"","sources":["../src/generate.ts"],"names":[],"mappings":";;AAoCA,gDAqBC;AAED,gDAyBC;AApFD,qCAA6G;AAsB7G,MAAM,QAAQ,GAAqC;IACjD,MAAM,EAAE,QAAQ;IAChB,MAAM,EAAE,QAAQ;IAChB,OAAO,EAAE,QAAQ;IACjB,OAAO,EAAE,SAAS;IAClB,IAAI,EAAE,QAAQ;IACd,QAAQ,EAAE,QAAQ;IAClB,KAAK,EAAE,QAAQ;IACf,GAAG,EAAE,QAAQ;IACb,IAAI,EAAE,SAAS;IACf,QAAQ,EAAE,QAAQ;IAClB,OAAO,EAAE,SAAS;CACnB,CAAC;AAEF,SAAgB,kBAAkB,CAAC,MAAmC;IACpE,IAAI,CAAC,MAAM,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC;QAC7C,MAAM,IAAI,KAAK,CAAC,+DAA+D,CAAC,CAAC;IACnF,CAAC;IAED,MAAM,eAAe,GAAG,oBAAoB,CAAC,MAAM,CAAC,CAAC;IACrD,MAAM,KAAK,GAAa;QACtB,mEAAmE;QACnE,yBAAyB;QACzB,+CAA+C;QAC/C,EAAE;KACH,CAAC;IAEF,KAAK,MAAM,cAAc,IAAI,eAAe,EAAE,CAAC;QAC7C,KAAK,CAAC,IAAI,CAAC,GAAG,WAAW,CAAC,cAAc,CAAC,CAAC,CAAC;IAC7C,CAAC;IACD,KAAK,CAAC,IAAI,CAAC,GAAG,oBAAoB,CAAC,eAAe,CAAC,CAAC,CAAC;IACrD,KAAK,CAAC,IAAI,CAAC,GAAG,oBAAoB,CAAC,eAAe,CAAC,CAAC,CAAC;IACrD,KAAK,CAAC,IAAI,CAAC,GAAG,sBAAsB,EAAE,CAAC,CAAC;IAExC,OAAO,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC;AACjC,CAAC;AAED,SAAgB,kBAAkB,CAChC,MAAmC,EACnC,UAAqC,EAAE;IAEvC,IAAI,CAAC,MAAM,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC;QAC7C,MAAM,IAAI,KAAK,CAAC,+DAA+D,CAAC,CAAC;IACnF,CAAC;IAED,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,IAAI,UAAU,CAAC;IAC5C,MAAM,eAAe,GAAG,oBAAoB,CAAC,MAAM,CAAC,CAAC;IACrD,MAAM,KAAK,GAAa;QACtB,mEAAmE;KACpE,CAAC;IAEF,IAAI,MAAM,KAAK,KAAK,EAAE,CAAC;QACrB,KAAK,CAAC,IAAI,CAAC,yBAAyB,EAAE,+CAA+C,EAAE,EAAE,CAAC,CAAC;QAC3F,KAAK,CAAC,IAAI,CAAC,GAAG,oBAAoB,CAAC,eAAe,EAAE,cAAc,EAAE,KAAK,CAAC,CAAC,CAAC;QAC5E,KAAK,CAAC,IAAI,CAAC,GAAG,yBAAyB,EAAE,CAAC,CAAC;IAC7C,CAAC;SAAM,CAAC;QACN,KAAK,CAAC,IAAI,CAAC,2BAA2B,EAAE,oDAAoD,EAAE,EAAE,CAAC,CAAC;QAClG,KAAK,CAAC,IAAI,CAAC,GAAG,oBAAoB,CAAC,eAAe,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC,CAAC;QACrE,KAAK,CAAC,IAAI,CAAC,GAAG,oBAAoB,EAAE,CAAC,CAAC;IACxC,CAAC;IAED,OAAO,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC;AACjC,CAAC;AAED,SAAS,oBAAoB,CAAC,MAAmC;IAC/D,MAAM,YAAY,GAAG,IAAA,wBAAe,EAClC,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,IAAA,yBAAgB,EAAC,IAAA,qBAAY,EAAC,KAAK,CAAC,IAAI,IAAI,KAAK,CAAC,iBAAiB,IAAI,OAAO,CAAC,CAAC,CAAC,CAC/G,CAAC;IACF,OAAO,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE,CAAC,mBAAmB,CAAC,KAAK,EAAE,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;AAC9F,CAAC;AAED,SAAS,mBAAmB,CAAC,KAAwB,EAAE,MAAc;IACnE,MAAM,OAAO,GAAG,YAAY,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IAC5C,OAAO;QACL,MAAM;QACN,OAAO;QACP,KAAK;KACN,CAAC;AACJ,CAAC;AAED,SAAS,YAAY,CAAC,OAA6B;IACjD,MAAM,oBAAoB,GAAG,IAAA,wBAAe,EAC1C,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,IAAA,yBAAgB,EAAC,IAAA,oBAAW,EAAC,MAAM,CAAC,IAAI,IAAI,MAAM,CAAC,cAAc,IAAI,OAAO,CAAC,CAAC,CAAC,CACxG,CAAC;IAEF,OAAO,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC;QACrC,cAAc,EAAE,MAAM,CAAC,cAAc;QACrC,WAAW,EAAE,oBAAoB,CAAC,KAAK,CAAC;QACxC,aAAa,EAAE,oBAAoB,CAAC,KAAK,CAAC;QAC1C,IAAI,EAAE,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC;QAC3B,QAAQ,EAAE,MAAM,CAAC,QAAQ;QACzB,QAAQ,EAAE,MAAM,CAAC,QAAQ;KAC1B,CAAC,CAAC,CAAC;AACN,CAAC;AAED,SAAS,WAAW,CAAC,cAA8B;IACjD,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,GAAG,cAAc,CAAC;IAClD,MAAM,YAAY,GAAG,GAAG,MAAM,KAAK,CAAC;IACpC,MAAM,eAAe,GAAG,GAAG,MAAM,QAAQ,CAAC;IAC1C,MAAM,eAAe,GAAG,GAAG,MAAM,QAAQ,CAAC;IAE1C,OAAO;QACL,oBAAoB,YAAY,IAAI;QACpC,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,iBAAiB,CAAC,MAAM,CAAC,CAAC;QACrD,GAAG;QACH,EAAE;QACF,oBAAoB,eAAe,IAAI;QACvC,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,mBAAmB,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;QAC9D,GAAG;QACH,EAAE;QACF,oBAAoB,eAAe,IAAI;QACvC,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,mBAAmB,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;QAC7D,GAAG;QACH,EAAE;KACH,CAAC;AACJ,CAAC;AAED,SAAS,iBAAiB,CAAC,MAAuB;IAChD,MAAM,IAAI,GAAG,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,IAAI,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC;IACrE,MAAM,QAAQ,GAAG,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC;IAC5C,OAAO,KAAK,IAAA,4BAAmB,EAAC,MAAM,CAAC,WAAW,CAAC,GAAG,QAAQ,KAAK,IAAI,GAAG,CAAC;AAC7E,CAAC;AAED,SAAS,mBAAmB,CAAC,MAAuB,EAAE,aAAsB;IAC1E,MAAM,IAAI,GAAG,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,IAAI,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC;IACrE,MAAM,QAAQ,GAAG,aAAa,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;IAC9D,OAAO,KAAK,MAAM,CAAC,aAAa,GAAG,QAAQ,KAAK,IAAI,GAAG,CAAC;AAC1D,CAAC;AAED,SAAS,sBAAsB,CAAC,MAAuB;IACrD,OAAO;QACL,WAAW;QACX,6BAA6B,IAAA,4BAAmB,EAAC,MAAM,CAAC,cAAc,CAAC,GAAG;QAC1E,0BAA0B,IAAA,4BAAmB,EAAC,MAAM,CAAC,WAAW,CAAC,GAAG;QACpE,4BAA4B,IAAA,4BAAmB,EAAC,MAAM,CAAC,aAAa,CAAC,GAAG;QACxE,mBAAmB,IAAA,4BAAmB,EAAC,MAAM,CAAC,IAAI,CAAC,GAAG;QACtD,uBAAuB,MAAM,CAAC,QAAQ,GAAG;QACzC,uBAAuB,MAAM,CAAC,QAAQ,GAAG;QACzC,YAAY;KACb,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AACf,CAAC;AAED,SAAS,oBAAoB,CAAC,eAAiC;IAC7D,MAAM,KAAK,GAAG,CAAC,iCAAiC,CAAC,CAAC;IAClD,KAAK,MAAM,cAAc,IAAI,eAAe,EAAE,CAAC;QAC7C,KAAK,CAAC,IAAI,CAAC,KAAK,IAAA,4BAAmB,EAAC,cAAc,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACrE,KAAK,CAAC,IAAI,CAAC,YAAY,cAAc,CAAC,MAAM,MAAM,CAAC,CAAC;QACpD,KAAK,CAAC,IAAI,CAAC,eAAe,cAAc,CAAC,MAAM,SAAS,CAAC,CAAC;QAC1D,KAAK,CAAC,IAAI,CAAC,eAAe,cAAc,CAAC,MAAM,SAAS,CAAC,CAAC;QAC1D,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IACrB,CAAC;IACD,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;IACpB,OAAO,KAAK,CAAC;AACf,CAAC;AAED,SAAS,oBAAoB,CAAC,eAAiC,EAAE,WAAW,GAAG,cAAc,EAAE,cAAc,GAAG,IAAI;IAClH,MAAM,KAAK,GAAG,CAAC,GAAG,WAAW,2BAA2B,EAAE,aAAa,CAAC,CAAC;IACzE,KAAK,MAAM,cAAc,IAAI,eAAe,EAAE,CAAC;QAC7C,KAAK,CAAC,IAAI,CAAC,OAAO,IAAA,4BAAmB,EAAC,cAAc,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACvE,KAAK,CAAC,IAAI,CAAC,oBAAoB,IAAA,4BAAmB,EAAC,cAAc,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAClF,KAAK,CAAC,IAAI,CAAC,4BAA4B,IAAA,4BAAmB,EAAC,cAAc,CAAC,KAAK,CAAC,iBAAiB,CAAC,GAAG,CAAC,CAAC;QACvG,KAAK,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;QAC/B,KAAK,MAAM,MAAM,IAAI,cAAc,CAAC,OAAO,EAAE,CAAC;YAC5C,KAAK,CAAC,IAAI,CAAC,GAAG,sBAAsB,CAAC,MAAM,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC;QAC5D,CAAC;QACD,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACvB,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACvB,CAAC;IACD,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;IAC9D,OAAO,KAAK,CAAC;AACf,CAAC;AAED,SAAS,sBAAsB;IAC7B,OAAO;QACL,yDAAyD;KAC1D,CAAC;AACJ,CAAC;AAED,SAAS,yBAAyB;IAChC,OAAO;QACL,2CAA2C;KAC5C,CAAC;AACJ,CAAC;AAED,SAAS,oBAAoB;IAC3B,OAAO;QACL,oCAAoC;QACpC,EAAE;QACF,oBAAoB;QACpB,WAAW;QACX,yBAAyB;QACzB,IAAI;KACL,CAAC;AACJ,CAAC"}
|