zenstack 0.1.12 → 0.1.13

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 (34) hide show
  1. package/out/generator/index.js +1 -3
  2. package/out/generator/index.js.map +1 -1
  3. package/package.json +2 -3
  4. package/src/cli/cli-util.ts +0 -80
  5. package/src/cli/index.ts +0 -52
  6. package/src/extension.ts +0 -76
  7. package/src/generator/constants.ts +0 -2
  8. package/src/generator/index.ts +0 -76
  9. package/src/generator/next-auth/index.ts +0 -183
  10. package/src/generator/package.template.json +0 -9
  11. package/src/generator/prisma/expression-writer.ts +0 -352
  12. package/src/generator/prisma/index.ts +0 -24
  13. package/src/generator/prisma/plain-expression-builder.ts +0 -91
  14. package/src/generator/prisma/prisma-builder.ts +0 -366
  15. package/src/generator/prisma/query-gard-generator.ts +0 -208
  16. package/src/generator/prisma/schema-generator.ts +0 -295
  17. package/src/generator/react-hooks/index.ts +0 -265
  18. package/src/generator/service/index.ts +0 -96
  19. package/src/generator/tsconfig.template.json +0 -17
  20. package/src/generator/types.ts +0 -16
  21. package/src/generator/utils.ts +0 -9
  22. package/src/language-server/generated/ast.ts +0 -603
  23. package/src/language-server/generated/grammar.ts +0 -2190
  24. package/src/language-server/generated/module.ts +0 -24
  25. package/src/language-server/main.ts +0 -12
  26. package/src/language-server/stdlib.zmodel +0 -21
  27. package/src/language-server/types.ts +0 -9
  28. package/src/language-server/zmodel-index.ts +0 -33
  29. package/src/language-server/zmodel-linker.ts +0 -407
  30. package/src/language-server/zmodel-module.ts +0 -90
  31. package/src/language-server/zmodel-scope.ts +0 -21
  32. package/src/language-server/zmodel-validator.ts +0 -35
  33. package/src/language-server/zmodel.langium +0 -186
  34. package/src/utils/indent-string.ts +0 -6
@@ -1,295 +0,0 @@
1
- import {
2
- AttributeArg,
3
- DataModel,
4
- DataModelAttribute,
5
- DataModelField,
6
- DataModelFieldAttribute,
7
- DataSource,
8
- Enum,
9
- Expression,
10
- InvocationExpr,
11
- isArrayExpr,
12
- isInvocationExpr,
13
- isLiteralExpr,
14
- isReferenceExpr,
15
- LiteralExpr,
16
- } from '@lang/generated/ast';
17
- import { writeFile } from 'fs/promises';
18
- import { AstNode } from 'langium';
19
- import path from 'path';
20
- import { GUARD_FIELD_NAME } from '../constants';
21
- import { Context, GeneratorError } from '../types';
22
- import {
23
- AttributeArg as PrismaAttributeArg,
24
- AttributeArgValue as PrismaAttributeArgValue,
25
- DataSourceUrl as PrismaDataSourceUrl,
26
- FieldAttribute as PrismaFieldAttribute,
27
- ModelAttribute as PrismaModelAttribute,
28
- Model as PrismaDataModel,
29
- FieldReference as PrismaFieldReference,
30
- FieldReferenceArg as PrismaFieldReferenceArg,
31
- FunctionCall as PrismaFunctionCall,
32
- FunctionCallArg as PrismaFunctionCallArg,
33
- PrismaModel,
34
- ModelFieldType,
35
- } from './prisma-builder';
36
-
37
- const supportedProviders = ['postgresql', 'mysql', 'sqlite', 'sqlserver'];
38
- const supportedAttrbutes = [
39
- 'id',
40
- 'index',
41
- 'relation',
42
- 'default',
43
- 'createdAt',
44
- 'updatedAt',
45
- 'unique',
46
- ];
47
-
48
- export default class PrismaSchemaGenerator {
49
- constructor(private readonly context: Context) {}
50
-
51
- async generate() {
52
- const { schema } = this.context;
53
- const prisma = new PrismaModel();
54
-
55
- for (const decl of schema.declarations) {
56
- switch (decl.$type) {
57
- case DataSource:
58
- this.generateDataSource(prisma, decl as DataSource);
59
- break;
60
-
61
- case Enum:
62
- this.generateEnum(prisma, decl as Enum);
63
- break;
64
-
65
- case DataModel:
66
- this.generateModel(prisma, decl as DataModel);
67
- break;
68
- }
69
- }
70
-
71
- this.generateGenerator(prisma);
72
-
73
- const outFile = path.join(this.context.outDir, 'schema.prisma');
74
- await writeFile(outFile, prisma.toString());
75
- return outFile;
76
- }
77
-
78
- private generateDataSource(prisma: PrismaModel, dataSource: DataSource) {
79
- let provider: string | undefined = undefined;
80
- let url: PrismaDataSourceUrl | undefined = undefined;
81
- let shadowDatabaseUrl: PrismaDataSourceUrl | undefined = undefined;
82
-
83
- for (const f of dataSource.fields) {
84
- switch (f.name) {
85
- case 'provider': {
86
- if (this.isStringLiteral(f.value)) {
87
- provider = f.value.value as string;
88
- } else {
89
- throw new GeneratorError(
90
- 'Datasource provider must be set to a string'
91
- );
92
- }
93
- if (!supportedProviders.includes(provider)) {
94
- throw new GeneratorError(
95
- `Provider ${provider} is not supported. Supported providers: ${supportedProviders.join(
96
- ', '
97
- )}`
98
- );
99
- }
100
- break;
101
- }
102
-
103
- case 'url': {
104
- const r = this.extractDataSourceUrl(f.value);
105
- if (!r) {
106
- throw new GeneratorError(
107
- 'Invalid value for datasource url'
108
- );
109
- }
110
- url = r;
111
- break;
112
- }
113
-
114
- case 'shadowDatabaseUrl': {
115
- const r = this.extractDataSourceUrl(f.value);
116
- if (!r) {
117
- throw new GeneratorError(
118
- 'Invalid value for datasource url'
119
- );
120
- }
121
- shadowDatabaseUrl = r;
122
- break;
123
- }
124
- }
125
- }
126
-
127
- if (!provider) {
128
- throw new GeneratorError('Datasource is missing "provider" field');
129
- }
130
- if (!url) {
131
- throw new GeneratorError('Datasource is missing "url" field');
132
- }
133
-
134
- prisma.addDataSource(dataSource.name, provider, url, shadowDatabaseUrl);
135
- }
136
-
137
- private extractDataSourceUrl(fieldValue: LiteralExpr | InvocationExpr) {
138
- if (this.isStringLiteral(fieldValue)) {
139
- return new PrismaDataSourceUrl(fieldValue.value as string, false);
140
- } else if (
141
- isInvocationExpr(fieldValue) &&
142
- fieldValue.function.ref?.name === 'env' &&
143
- fieldValue.args.length === 1 &&
144
- this.isStringLiteral(fieldValue.args[0].value)
145
- ) {
146
- return new PrismaDataSourceUrl(
147
- fieldValue.args[0].value.value as string,
148
- true
149
- );
150
- } else {
151
- return null;
152
- }
153
- }
154
-
155
- private generateGenerator(prisma: PrismaModel) {
156
- prisma.addGenerator('client', 'prisma-client-js', '.prisma', [
157
- 'fieldReference',
158
- 'interactiveTransactions',
159
- ]);
160
- }
161
-
162
- private generateModel(prisma: PrismaModel, decl: DataModel) {
163
- const model = prisma.addModel(decl.name);
164
- for (const field of decl.fields) {
165
- this.generateModelField(model, field);
166
- }
167
-
168
- // add an "zenstack_guard" field for dealing with pure auth() related conditions
169
- model.addField(GUARD_FIELD_NAME, 'Boolean', [
170
- new PrismaFieldAttribute('default', [
171
- new PrismaAttributeArg(
172
- undefined,
173
- new PrismaAttributeArgValue('Boolean', true)
174
- ),
175
- ]),
176
- ]);
177
-
178
- for (const attr of decl.attributes.filter((attr) =>
179
- supportedAttrbutes.includes(attr.decl.ref?.name!)
180
- )) {
181
- this.generateModelAttribute(model, attr);
182
- }
183
- }
184
-
185
- private generateModelField(model: PrismaDataModel, field: DataModelField) {
186
- const type = new ModelFieldType(
187
- (field.type.type || field.type.reference?.ref?.name)!,
188
- field.type.array,
189
- field.type.optional
190
- );
191
-
192
- const attributes = field.attributes
193
- .filter((attr) => supportedAttrbutes.includes(attr.decl.ref?.name!))
194
- .map((attr) => this.makeFieldAttribute(attr));
195
- model.addField(field.name, type, attributes);
196
- }
197
-
198
- private makeFieldAttribute(attr: DataModelFieldAttribute) {
199
- return new PrismaFieldAttribute(
200
- attr.decl.ref?.name!,
201
- attr.args.map((arg) => this.makeAttributeArg(arg))
202
- );
203
- }
204
-
205
- makeAttributeArg(arg: AttributeArg): PrismaAttributeArg {
206
- return new PrismaAttributeArg(
207
- arg.name,
208
- this.makeAttributeArgValue(arg.value)
209
- );
210
- }
211
-
212
- makeAttributeArgValue(node: Expression): PrismaAttributeArgValue {
213
- if (isLiteralExpr(node)) {
214
- switch (typeof node.value) {
215
- case 'string':
216
- return new PrismaAttributeArgValue('String', node.value);
217
- case 'number':
218
- return new PrismaAttributeArgValue('Number', node.value);
219
- case 'boolean':
220
- return new PrismaAttributeArgValue('Boolean', node.value);
221
- default:
222
- throw new GeneratorError(
223
- `Unexpected literal type: ${typeof node.value}`
224
- );
225
- }
226
- } else if (isArrayExpr(node)) {
227
- return new PrismaAttributeArgValue(
228
- 'Array',
229
- new Array(
230
- ...node.items.map((item) =>
231
- this.makeAttributeArgValue(item)
232
- )
233
- )
234
- );
235
- } else if (isReferenceExpr(node)) {
236
- return new PrismaAttributeArgValue(
237
- 'FieldReference',
238
- new PrismaFieldReference(
239
- node.target.ref?.name!,
240
- node.args.map(
241
- (arg) =>
242
- new PrismaFieldReferenceArg(arg.name, arg.value)
243
- )
244
- )
245
- );
246
- } else if (isInvocationExpr(node)) {
247
- // invocation
248
- return new PrismaAttributeArgValue(
249
- 'FunctionCall',
250
- this.makeFunctionCall(node)
251
- );
252
- } else {
253
- throw new GeneratorError(
254
- `Unsupported attribute argument expression type: ${node.$type}`
255
- );
256
- }
257
- }
258
-
259
- makeFunctionCall(node: InvocationExpr): PrismaFunctionCall {
260
- return new PrismaFunctionCall(
261
- node.function.ref?.name!,
262
- node.args.map((arg) => {
263
- if (!isLiteralExpr(arg.value)) {
264
- throw new GeneratorError(
265
- 'Function call argument must be literal'
266
- );
267
- }
268
- return new PrismaFunctionCallArg(arg.name, arg.value.value);
269
- })
270
- );
271
- }
272
-
273
- private generateModelAttribute(
274
- model: PrismaDataModel,
275
- attr: DataModelAttribute
276
- ) {
277
- model.attributes.push(
278
- new PrismaModelAttribute(
279
- attr.decl.ref?.name!,
280
- attr.args.map((arg) => this.makeAttributeArg(arg))
281
- )
282
- );
283
- }
284
-
285
- private generateEnum(prisma: PrismaModel, decl: Enum) {
286
- prisma.addEnum(
287
- decl.name,
288
- decl.fields.map((f) => f.name)
289
- );
290
- }
291
-
292
- private isStringLiteral(node: AstNode): node is LiteralExpr {
293
- return isLiteralExpr(node) && typeof node.value === 'string';
294
- }
295
- }
@@ -1,265 +0,0 @@
1
- import { Context, Generator } from '../types';
2
- import { Project } from 'ts-morph';
3
- import * as path from 'path';
4
- import { paramCase } from 'change-case';
5
- import { DataModel } from '@lang/generated/ast';
6
- import colors from 'colors';
7
- import { extractDataModelsWithAllowRules } from '../utils';
8
-
9
- export default class ReactHooksGenerator implements Generator {
10
- async generate(context: Context) {
11
- const project = new Project();
12
-
13
- const models = extractDataModelsWithAllowRules(context.schema);
14
-
15
- this.generateIndex(project, context, models);
16
- this.generateRequestRuntime(project, context);
17
-
18
- models.forEach((d) => this.generateModelHooks(project, context, d));
19
-
20
- await project.save();
21
-
22
- console.log(colors.blue(' ✔️ React hooks generated'));
23
- }
24
-
25
- private generateRequestRuntime(project: Project, context: Context) {
26
- const content = `
27
- import useSWR, { useSWRConfig } from 'swr';
28
- import type { ScopedMutator } from 'swr/dist/types';
29
-
30
- const fetcher = async (url: string, options?: RequestInit) => {
31
- const res = await fetch(url, options);
32
- if (!res.ok) {
33
- const error: Error & { info?: any; status?: number } = new Error(
34
- 'An error occurred while fetching the data.'
35
- );
36
- error.info = await res.json();
37
- error.status = res.status;
38
- throw error;
39
- }
40
- return res.json();
41
- };
42
-
43
- function makeUrl(url: string, args: unknown) {
44
- return args ? url + \`q=\${encodeURIComponent(JSON.stringify(args))}\` : url;
45
- }
46
-
47
- export function get<Data, Error = any>(url: string, args?: unknown) {
48
- return useSWR<Data, Error>(makeUrl(url, args), fetcher);
49
- }
50
-
51
- export async function post<Data, Result>(
52
- url: string,
53
- data: Data,
54
- mutate: ScopedMutator<any>
55
- ) {
56
- const r: Result = await fetcher(url, {
57
- method: 'POST',
58
- headers: {
59
- 'content-type': 'application/json',
60
- },
61
- body: JSON.stringify(data),
62
- });
63
- mutate(url);
64
- return r;
65
- }
66
-
67
- export async function put<Data, Result>(
68
- url: string,
69
- data: Data,
70
- mutate: ScopedMutator<any>
71
- ) {
72
- const r: Result = await fetcher(url, {
73
- method: 'PUT',
74
- headers: {
75
- 'content-type': 'application/json',
76
- },
77
- body: JSON.stringify(data),
78
- });
79
- mutate(url, r);
80
- return r;
81
- }
82
-
83
- export async function del<Result>(
84
- url: string,
85
- args: unknown,
86
- mutate: ScopedMutator<any>
87
- ) {
88
- const reqUrl = makeUrl(url, args);
89
- const r: Result = await fetcher(reqUrl, {
90
- method: 'DELETE',
91
- });
92
- const path = url.split('/');
93
- path.pop();
94
- mutate(path.join('/'));
95
- return r;
96
- }
97
-
98
- export function getMutate() {
99
- const { mutate } = useSWRConfig();
100
- return mutate;
101
- }
102
- `;
103
-
104
- const sf = project.createSourceFile(
105
- path.join(context.outDir, `hooks/request.ts`),
106
- content,
107
- { overwrite: true }
108
- );
109
- sf.formatText();
110
- }
111
-
112
- private generateModelHooks(
113
- project: Project,
114
- context: Context,
115
- model: DataModel
116
- ) {
117
- const fileName = paramCase(model.name);
118
- const sf = project.createSourceFile(
119
- path.join(context.outDir, `hooks/${fileName}.ts`),
120
- undefined,
121
- { overwrite: true }
122
- );
123
-
124
- sf.addImportDeclaration({
125
- namedImports: [{ name: 'Prisma', alias: 'P' }, model.name],
126
- isTypeOnly: true,
127
- moduleSpecifier: '../.prisma',
128
- });
129
-
130
- sf.addStatements([`import * as request from './request';`]);
131
-
132
- sf.addStatements(`const endpoint = '/api/zen/data/${model.name}';`);
133
-
134
- const useFuncBody = sf
135
- .addFunction({
136
- name: `use${model.name}`,
137
- isExported: true,
138
- })
139
- .addBody();
140
-
141
- useFuncBody.addStatements(['const mutate = request.getMutate();']);
142
-
143
- // create
144
- useFuncBody
145
- .addFunction({
146
- name: 'create',
147
- isAsync: true,
148
- typeParameters: [`T extends P.${model.name}CreateArgs`],
149
- parameters: [
150
- { name: 'args', type: `P.${model.name}CreateArgs` },
151
- ],
152
- })
153
- .addBody()
154
- .addStatements([
155
- `return request.post<P.${model.name}CreateArgs, P.CheckSelect<T, ${model.name}, P.${model.name}GetPayload<T>>>(endpoint, args, mutate);`,
156
- ]);
157
-
158
- // find
159
- useFuncBody
160
- .addFunction({
161
- name: 'find',
162
- typeParameters: [`T extends P.${model.name}FindManyArgs`],
163
- parameters: [
164
- {
165
- name: 'args?',
166
- type: `P.SelectSubset<T, P.${model.name}FindManyArgs>`,
167
- },
168
- ],
169
- })
170
- .addBody()
171
- .addStatements([
172
- `return request.get<P.CheckSelect<T, Array<${model.name}>, Array<P.${model.name}GetPayload<T>>>>(endpoint, args);`,
173
- ]);
174
-
175
- // get
176
- useFuncBody
177
- .addFunction({
178
- name: 'get',
179
- isAsync: true,
180
- typeParameters: [
181
- `T extends P.Subset<P.${model.name}FindFirstArgs, 'select' | 'include'>`,
182
- ],
183
- parameters: [
184
- {
185
- name: 'id',
186
- type: 'String',
187
- },
188
- {
189
- name: 'args?',
190
- type: `P.SelectSubset<T, P.Subset<P.${model.name}FindFirstArgs, 'select' | 'include'>>`,
191
- },
192
- ],
193
- })
194
- .addBody()
195
- .addStatements([
196
- `return request.get<P.CheckSelect<T, ${model.name}, P.${model.name}GetPayload<T>>>(\`\${endpoint}/\${id}\`, args);`,
197
- ]);
198
-
199
- // update
200
- useFuncBody
201
- .addFunction({
202
- name: 'update',
203
- isAsync: true,
204
- typeParameters: [
205
- `T extends Omit<P.${model.name}UpdateArgs, 'where'>`,
206
- ],
207
- parameters: [
208
- { name: 'id', type: 'String' },
209
- {
210
- name: 'args',
211
- type: `Omit<P.${model.name}UpdateArgs, 'where'>`,
212
- },
213
- ],
214
- })
215
- .addBody()
216
- .addStatements([
217
- `return request.put<Omit<P.${model.name}UpdateArgs, 'where'>, P.CheckSelect<T, ${model.name}, P.${model.name}GetPayload<T>>>(\`\${endpoint}/\${id}\`, args, mutate);`,
218
- ]);
219
-
220
- // del
221
- useFuncBody
222
- .addFunction({
223
- name: 'del',
224
- isAsync: true,
225
- typeParameters: [
226
- `T extends Omit<P.${model.name}DeleteArgs, 'where'>`,
227
- ],
228
- parameters: [
229
- { name: 'id', type: 'String' },
230
- {
231
- name: 'args?',
232
- type: `Omit<P.${model.name}DeleteArgs, 'where'>`,
233
- },
234
- ],
235
- })
236
- .addBody()
237
- .addStatements([
238
- `return request.del<P.CheckSelect<T, ${model.name}, P.${model.name}GetPayload<T>>>(\`\${endpoint}/\${id}\`, args, mutate);`,
239
- ]);
240
-
241
- useFuncBody.addStatements([
242
- 'return { create, find, get, update, del };',
243
- ]);
244
-
245
- sf.formatText();
246
- }
247
-
248
- private generateIndex(
249
- project: Project,
250
- context: Context,
251
- models: DataModel[]
252
- ) {
253
- const sf = project.createSourceFile(
254
- path.join(context.outDir, 'hooks/index.ts'),
255
- undefined,
256
- { overwrite: true }
257
- );
258
-
259
- sf.addStatements(
260
- models.map((d) => `export * from './${paramCase(d.name)}';`)
261
- );
262
-
263
- sf.formatText();
264
- }
265
- }
@@ -1,96 +0,0 @@
1
- import { Context, Generator } from '../types';
2
- import { Project, StructureKind } from 'ts-morph';
3
- import * as path from 'path';
4
- import colors from 'colors';
5
- import { RUNTIME_PACKAGE } from '../constants';
6
-
7
- export default class ServiceGenerator implements Generator {
8
- async generate(context: Context) {
9
- const project = new Project();
10
- const sf = project.createSourceFile(
11
- path.join(context.outDir, 'index.ts'),
12
- undefined,
13
- { overwrite: true }
14
- );
15
-
16
- sf.addImportDeclaration({
17
- namedImports: ['PrismaClient'],
18
- moduleSpecifier: './.prisma',
19
- });
20
-
21
- sf.addImportDeclaration({
22
- namedImports: ['Service', 'PolicyOperationKind', 'QueryContext'],
23
- moduleSpecifier: RUNTIME_PACKAGE,
24
- isTypeOnly: true,
25
- });
26
-
27
- const cls = sf.addClass({
28
- name: 'ZenStackService',
29
- isExported: true,
30
- implements: ['Service<PrismaClient>'],
31
- });
32
- cls.addMember({
33
- kind: StructureKind.Property,
34
- name: 'private readonly _prisma',
35
- initializer: 'new PrismaClient()',
36
- });
37
-
38
- cls.addGetAccessor({
39
- name: 'db',
40
- })
41
- .addBody()
42
- .setBodyText('return this._prisma;');
43
-
44
- cls
45
- .addMethod({
46
- name: 'resolveField',
47
- isAsync: true,
48
- parameters: [
49
- {
50
- name: 'model',
51
- type: 'string',
52
- },
53
- {
54
- name: 'field',
55
- type: 'string',
56
- },
57
- ],
58
- })
59
- .addBody().setBodyText(`
60
- const module: any = await import('./query/guard');
61
- return module._fieldMapping?.[model]?.[field];
62
- `);
63
-
64
- cls
65
- .addMethod({
66
- name: 'buildQueryGuard',
67
- isAsync: true,
68
- parameters: [
69
- {
70
- name: 'model',
71
- type: 'string',
72
- },
73
- {
74
- name: 'operation',
75
- type: 'PolicyOperationKind',
76
- },
77
- {
78
- name: 'context',
79
- type: 'QueryContext',
80
- },
81
- ],
82
- })
83
- .addBody().setBodyText(`
84
- const module: any = await import('./query/guard');
85
- const provider: (context: QueryContext) => any = module[model+ '_' + operation];
86
- return provider(context);
87
- `);
88
-
89
- sf.addStatements(['export default new ZenStackService();']);
90
-
91
- sf.formatText();
92
- await project.save();
93
-
94
- console.log(colors.blue(` ✔️ ZenStack service generated`));
95
- }
96
- }
@@ -1,17 +0,0 @@
1
- {
2
- "compilerOptions": {
3
- "target": "ES6",
4
- "module": "CommonJS",
5
- "lib": ["ESNext", "DOM"],
6
- "sourceMap": true,
7
- "outDir": ".",
8
- "strict": true,
9
- "moduleResolution": "node",
10
- "esModuleInterop": true,
11
- "skipLibCheck": true,
12
- "declaration": true,
13
- "resolveJsonModule": true
14
- },
15
- "include": ["**/*.ts"],
16
- "exclude": ["node_modules", ".prisma", "**/*.d.ts"]
17
- }
@@ -1,16 +0,0 @@
1
- import { Model } from '@lang/generated/ast';
2
-
3
- export interface Context {
4
- schema: Model;
5
- outDir: string;
6
- }
7
-
8
- export interface Generator {
9
- generate(context: Context): Promise<void>;
10
- }
11
-
12
- export class GeneratorError extends Error {
13
- constructor(message: string) {
14
- super(message);
15
- }
16
- }
@@ -1,9 +0,0 @@
1
- import { DataModel, isDataModel, Model } from '@lang/generated/ast';
2
-
3
- export function extractDataModelsWithAllowRules(model: Model) {
4
- return model.declarations.filter(
5
- (d) =>
6
- isDataModel(d) &&
7
- !!d.attributes.find((attr) => attr.decl.ref?.name === 'allow')
8
- ) as DataModel[];
9
- }