@zenstackhq/sdk 3.0.0-alpha.3 → 3.0.0-alpha.31

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/dist/index.d.cts CHANGED
@@ -1,31 +1,28 @@
1
1
  import * as _zenstackhq_language_ast from '@zenstackhq/language/ast';
2
- import { DataModelField, DataModel, TypeDef, Enum, EnumField, FunctionDecl, Attribute, AttributeParam, TypeDefField, DataModelFieldAttribute, DataModelAttribute, AstNode, Model, Reference, InvocationExpr } from '@zenstackhq/language/ast';
2
+ import { DataField, DataModel, TypeDef, Enum, EnumField, FunctionDecl, Attribute, AttributeParam, DataFieldAttribute, DataModelAttribute, AstNode, Model, Reference, InvocationExpr } from '@zenstackhq/language/ast';
3
+ import { AttributeTarget } from '@zenstackhq/language/utils';
4
+ import { MaybePromise } from 'langium';
3
5
 
4
- declare function isIdField(field: DataModelField): boolean;
5
- declare function hasAttribute(decl: DataModel | TypeDef | DataModelField | Enum | EnumField | FunctionDecl | Attribute | AttributeParam, name: string): boolean;
6
- declare function getAttribute(decl: DataModel | TypeDef | DataModelField | TypeDefField | Enum | EnumField | FunctionDecl | Attribute | AttributeParam, name: string): DataModelFieldAttribute | DataModelAttribute | undefined;
7
- /**
8
- * Gets `@@id` fields declared at the data model level (including search in base models)
9
- */
10
- declare function getModelIdFields(model: DataModel): DataModelField[];
11
- /**
12
- * Gets `@@unique` fields declared at the data model level (including search in base models)
13
- */
14
- declare function getModelUniqueFields(model: DataModel): DataModelField[];
15
- declare function getRecursiveBases(dataModel: DataModel, includeDelegate?: boolean, seen?: Set<DataModel>): DataModel[];
6
+ declare function isIdField(field: DataField, contextModel: DataModel): boolean;
7
+ declare function hasAttribute(decl: DataModel | TypeDef | DataField | Enum | EnumField | FunctionDecl | Attribute | AttributeParam, name: string): boolean;
8
+ declare function getAttribute(decl: AttributeTarget, name: string): DataFieldAttribute | DataModelAttribute | undefined;
16
9
  declare function isDelegateModel(node: AstNode): boolean;
17
- declare function isUniqueField(field: DataModelField): boolean;
10
+ declare function isUniqueField(field: DataField): boolean;
18
11
  declare function isFromStdlib(node: AstNode): boolean;
19
12
  declare function getContainingModel(node: AstNode | undefined): Model | null;
20
13
  declare function resolved<T extends AstNode>(ref: Reference<T>): T;
21
14
  declare function getAuthDecl(model: Model): _zenstackhq_language_ast.AbstractDeclaration | undefined;
15
+ declare function getIdFields(dm: DataModel): string[];
16
+ /**
17
+ * Prefix for auxiliary relation fields generated for delegated models
18
+ */
19
+ declare const DELEGATE_AUX_RELATION_PREFIX = "delegate_aux";
22
20
 
21
+ declare const modelUtils_DELEGATE_AUX_RELATION_PREFIX: typeof DELEGATE_AUX_RELATION_PREFIX;
23
22
  declare const modelUtils_getAttribute: typeof getAttribute;
24
23
  declare const modelUtils_getAuthDecl: typeof getAuthDecl;
25
24
  declare const modelUtils_getContainingModel: typeof getContainingModel;
26
- declare const modelUtils_getModelIdFields: typeof getModelIdFields;
27
- declare const modelUtils_getModelUniqueFields: typeof getModelUniqueFields;
28
- declare const modelUtils_getRecursiveBases: typeof getRecursiveBases;
25
+ declare const modelUtils_getIdFields: typeof getIdFields;
29
26
  declare const modelUtils_hasAttribute: typeof hasAttribute;
30
27
  declare const modelUtils_isDelegateModel: typeof isDelegateModel;
31
28
  declare const modelUtils_isFromStdlib: typeof isFromStdlib;
@@ -33,7 +30,46 @@ declare const modelUtils_isIdField: typeof isIdField;
33
30
  declare const modelUtils_isUniqueField: typeof isUniqueField;
34
31
  declare const modelUtils_resolved: typeof resolved;
35
32
  declare namespace modelUtils {
36
- export { modelUtils_getAttribute as getAttribute, modelUtils_getAuthDecl as getAuthDecl, modelUtils_getContainingModel as getContainingModel, modelUtils_getModelIdFields as getModelIdFields, modelUtils_getModelUniqueFields as getModelUniqueFields, modelUtils_getRecursiveBases as getRecursiveBases, modelUtils_hasAttribute as hasAttribute, modelUtils_isDelegateModel as isDelegateModel, modelUtils_isFromStdlib as isFromStdlib, modelUtils_isIdField as isIdField, modelUtils_isUniqueField as isUniqueField, modelUtils_resolved as resolved };
33
+ export { modelUtils_DELEGATE_AUX_RELATION_PREFIX as DELEGATE_AUX_RELATION_PREFIX, modelUtils_getAttribute as getAttribute, modelUtils_getAuthDecl as getAuthDecl, modelUtils_getContainingModel as getContainingModel, modelUtils_getIdFields as getIdFields, modelUtils_hasAttribute as hasAttribute, modelUtils_isDelegateModel as isDelegateModel, modelUtils_isFromStdlib as isFromStdlib, modelUtils_isIdField as isIdField, modelUtils_isUniqueField as isUniqueField, modelUtils_resolved as resolved };
34
+ }
35
+
36
+ /**
37
+ * Context passed to CLI plugins when calling `generate`.
38
+ */
39
+ type CliGeneratorContext = {
40
+ /**
41
+ * ZModel file path.
42
+ */
43
+ schemaFile: string;
44
+ /**
45
+ * ZModel AST.
46
+ */
47
+ model: Model;
48
+ /**
49
+ * Default output path for code generation.
50
+ */
51
+ defaultOutputPath: string;
52
+ /**
53
+ * Plugin options provided by the user.
54
+ */
55
+ pluginOptions: Record<string, unknown>;
56
+ };
57
+ /**
58
+ * Contract for a CLI plugin.
59
+ */
60
+ interface CliPlugin {
61
+ /**
62
+ * Plugin's display name.
63
+ */
64
+ name: string;
65
+ /**
66
+ * Text to show during generation.
67
+ */
68
+ statusText?: string;
69
+ /**
70
+ * Code generation callback.
71
+ */
72
+ generate(context: CliGeneratorContext): MaybePromise<void>;
37
73
  }
38
74
 
39
75
  declare class FunctionCall {
@@ -54,6 +90,7 @@ declare class FunctionCallArg {
54
90
  declare class PrismaSchemaGenerator {
55
91
  private readonly zmodel;
56
92
  private readonly PRELUDE;
93
+ private shortNameMap;
57
94
  constructor(zmodel: Model);
58
95
  generate(): Promise<string>;
59
96
  private generateDataSource;
@@ -69,7 +106,6 @@ declare class PrismaSchemaGenerator {
69
106
  private generateModelField;
70
107
  private isDefaultWithPluginInvocation;
71
108
  private isFromPlugin;
72
- private setDummyDefault;
73
109
  private isInheritedFromDelegate;
74
110
  private makeFieldAttribute;
75
111
  private makeAttributeArg;
@@ -79,23 +115,30 @@ declare class PrismaSchemaGenerator {
79
115
  private generateContainerAttribute;
80
116
  private generateEnum;
81
117
  private generateEnumField;
118
+ private generateDelegateRelationForBase;
119
+ private generateDelegateRelationForConcrete;
120
+ private getConcreteModels;
121
+ private truncate;
82
122
  }
83
123
 
84
124
  declare class TsSchemaGenerator {
85
- generate(schemaFile: string, pluginModelFiles: string[], outputFile: string): Promise<{
86
- model: Model;
87
- warnings: string[];
88
- }>;
125
+ generate(model: Model, outputDir: string): Promise<void>;
126
+ private generateSchema;
89
127
  private generateSchemaStatements;
90
128
  private createSchemaObject;
91
129
  private createProviderObject;
92
130
  private createModelsObject;
131
+ private createTypeDefsObject;
93
132
  private createDataModelObject;
133
+ private getSubModels;
134
+ private createTypeDefObject;
94
135
  private createComputedFieldsObject;
95
- private mapTypeToTSSyntaxKeyword;
96
- private createDataModelFieldObject;
136
+ private mapFieldTypeToTSType;
137
+ private createDataFieldObject;
138
+ private isDiscriminatorField;
97
139
  private getDataSourceProvider;
98
- private getMappedDefault;
140
+ private getFieldMappedDefault;
141
+ private getMappedValue;
99
142
  private getMemberAccessChain;
100
143
  private isAuthMemberAccess;
101
144
  private isAuthInvocation;
@@ -104,8 +147,8 @@ declare class TsSchemaGenerator {
104
147
  private getForeignKeyFor;
105
148
  private getOppositeRelationField;
106
149
  private getRelationName;
107
- private getIdFields;
108
150
  private createUniqueFieldsObject;
151
+ private generateFieldTypeLiteral;
109
152
  private createEnumObject;
110
153
  private getLiteral;
111
154
  private createLiteralNode;
@@ -124,6 +167,10 @@ declare class TsSchemaGenerator {
124
167
  private createRefExpression;
125
168
  private createCallExpression;
126
169
  private createLiteralExpression;
170
+ private generateModelsAndTypeDefs;
171
+ private generateSchemaImport;
172
+ private generateDocs;
173
+ private generateInputTypes;
127
174
  }
128
175
 
129
176
  /**
@@ -156,10 +203,10 @@ declare class ZModelCodeGenerator {
156
203
  private _generatePlugin;
157
204
  private _generatePluginField;
158
205
  private _generateDataModel;
159
- private _generateDataModelField;
206
+ private _generateDataField;
160
207
  private fieldType;
161
208
  private _generateDataModelAttribute;
162
- private _generateDataModelFieldAttribute;
209
+ private _generateDataFieldAttribute;
163
210
  private attribute;
164
211
  private _generateAttributeArg;
165
212
  private _generateObjectExpr;
@@ -183,7 +230,6 @@ declare class ZModelCodeGenerator {
183
230
  private _generateFunctionParam;
184
231
  private _generateFunctionParamType;
185
232
  private _generateTypeDef;
186
- private _generateTypeDefField;
187
233
  private argument;
188
234
  private get binaryExprSpace();
189
235
  private get unaryExprSpace();
@@ -192,4 +238,4 @@ declare class ZModelCodeGenerator {
192
238
  private isCollectionPredicateOperator;
193
239
  }
194
240
 
195
- export { modelUtils as ModelUtils, PrismaSchemaGenerator, TsSchemaGenerator, ZModelCodeGenerator, type ZModelCodeOptions };
241
+ export { type CliGeneratorContext, type CliPlugin, modelUtils as ModelUtils, PrismaSchemaGenerator, TsSchemaGenerator, ZModelCodeGenerator, type ZModelCodeOptions };
package/dist/index.d.ts CHANGED
@@ -1,31 +1,28 @@
1
1
  import * as _zenstackhq_language_ast from '@zenstackhq/language/ast';
2
- import { DataModelField, DataModel, TypeDef, Enum, EnumField, FunctionDecl, Attribute, AttributeParam, TypeDefField, DataModelFieldAttribute, DataModelAttribute, AstNode, Model, Reference, InvocationExpr } from '@zenstackhq/language/ast';
2
+ import { DataField, DataModel, TypeDef, Enum, EnumField, FunctionDecl, Attribute, AttributeParam, DataFieldAttribute, DataModelAttribute, AstNode, Model, Reference, InvocationExpr } from '@zenstackhq/language/ast';
3
+ import { AttributeTarget } from '@zenstackhq/language/utils';
4
+ import { MaybePromise } from 'langium';
3
5
 
4
- declare function isIdField(field: DataModelField): boolean;
5
- declare function hasAttribute(decl: DataModel | TypeDef | DataModelField | Enum | EnumField | FunctionDecl | Attribute | AttributeParam, name: string): boolean;
6
- declare function getAttribute(decl: DataModel | TypeDef | DataModelField | TypeDefField | Enum | EnumField | FunctionDecl | Attribute | AttributeParam, name: string): DataModelFieldAttribute | DataModelAttribute | undefined;
7
- /**
8
- * Gets `@@id` fields declared at the data model level (including search in base models)
9
- */
10
- declare function getModelIdFields(model: DataModel): DataModelField[];
11
- /**
12
- * Gets `@@unique` fields declared at the data model level (including search in base models)
13
- */
14
- declare function getModelUniqueFields(model: DataModel): DataModelField[];
15
- declare function getRecursiveBases(dataModel: DataModel, includeDelegate?: boolean, seen?: Set<DataModel>): DataModel[];
6
+ declare function isIdField(field: DataField, contextModel: DataModel): boolean;
7
+ declare function hasAttribute(decl: DataModel | TypeDef | DataField | Enum | EnumField | FunctionDecl | Attribute | AttributeParam, name: string): boolean;
8
+ declare function getAttribute(decl: AttributeTarget, name: string): DataFieldAttribute | DataModelAttribute | undefined;
16
9
  declare function isDelegateModel(node: AstNode): boolean;
17
- declare function isUniqueField(field: DataModelField): boolean;
10
+ declare function isUniqueField(field: DataField): boolean;
18
11
  declare function isFromStdlib(node: AstNode): boolean;
19
12
  declare function getContainingModel(node: AstNode | undefined): Model | null;
20
13
  declare function resolved<T extends AstNode>(ref: Reference<T>): T;
21
14
  declare function getAuthDecl(model: Model): _zenstackhq_language_ast.AbstractDeclaration | undefined;
15
+ declare function getIdFields(dm: DataModel): string[];
16
+ /**
17
+ * Prefix for auxiliary relation fields generated for delegated models
18
+ */
19
+ declare const DELEGATE_AUX_RELATION_PREFIX = "delegate_aux";
22
20
 
21
+ declare const modelUtils_DELEGATE_AUX_RELATION_PREFIX: typeof DELEGATE_AUX_RELATION_PREFIX;
23
22
  declare const modelUtils_getAttribute: typeof getAttribute;
24
23
  declare const modelUtils_getAuthDecl: typeof getAuthDecl;
25
24
  declare const modelUtils_getContainingModel: typeof getContainingModel;
26
- declare const modelUtils_getModelIdFields: typeof getModelIdFields;
27
- declare const modelUtils_getModelUniqueFields: typeof getModelUniqueFields;
28
- declare const modelUtils_getRecursiveBases: typeof getRecursiveBases;
25
+ declare const modelUtils_getIdFields: typeof getIdFields;
29
26
  declare const modelUtils_hasAttribute: typeof hasAttribute;
30
27
  declare const modelUtils_isDelegateModel: typeof isDelegateModel;
31
28
  declare const modelUtils_isFromStdlib: typeof isFromStdlib;
@@ -33,7 +30,46 @@ declare const modelUtils_isIdField: typeof isIdField;
33
30
  declare const modelUtils_isUniqueField: typeof isUniqueField;
34
31
  declare const modelUtils_resolved: typeof resolved;
35
32
  declare namespace modelUtils {
36
- export { modelUtils_getAttribute as getAttribute, modelUtils_getAuthDecl as getAuthDecl, modelUtils_getContainingModel as getContainingModel, modelUtils_getModelIdFields as getModelIdFields, modelUtils_getModelUniqueFields as getModelUniqueFields, modelUtils_getRecursiveBases as getRecursiveBases, modelUtils_hasAttribute as hasAttribute, modelUtils_isDelegateModel as isDelegateModel, modelUtils_isFromStdlib as isFromStdlib, modelUtils_isIdField as isIdField, modelUtils_isUniqueField as isUniqueField, modelUtils_resolved as resolved };
33
+ export { modelUtils_DELEGATE_AUX_RELATION_PREFIX as DELEGATE_AUX_RELATION_PREFIX, modelUtils_getAttribute as getAttribute, modelUtils_getAuthDecl as getAuthDecl, modelUtils_getContainingModel as getContainingModel, modelUtils_getIdFields as getIdFields, modelUtils_hasAttribute as hasAttribute, modelUtils_isDelegateModel as isDelegateModel, modelUtils_isFromStdlib as isFromStdlib, modelUtils_isIdField as isIdField, modelUtils_isUniqueField as isUniqueField, modelUtils_resolved as resolved };
34
+ }
35
+
36
+ /**
37
+ * Context passed to CLI plugins when calling `generate`.
38
+ */
39
+ type CliGeneratorContext = {
40
+ /**
41
+ * ZModel file path.
42
+ */
43
+ schemaFile: string;
44
+ /**
45
+ * ZModel AST.
46
+ */
47
+ model: Model;
48
+ /**
49
+ * Default output path for code generation.
50
+ */
51
+ defaultOutputPath: string;
52
+ /**
53
+ * Plugin options provided by the user.
54
+ */
55
+ pluginOptions: Record<string, unknown>;
56
+ };
57
+ /**
58
+ * Contract for a CLI plugin.
59
+ */
60
+ interface CliPlugin {
61
+ /**
62
+ * Plugin's display name.
63
+ */
64
+ name: string;
65
+ /**
66
+ * Text to show during generation.
67
+ */
68
+ statusText?: string;
69
+ /**
70
+ * Code generation callback.
71
+ */
72
+ generate(context: CliGeneratorContext): MaybePromise<void>;
37
73
  }
38
74
 
39
75
  declare class FunctionCall {
@@ -54,6 +90,7 @@ declare class FunctionCallArg {
54
90
  declare class PrismaSchemaGenerator {
55
91
  private readonly zmodel;
56
92
  private readonly PRELUDE;
93
+ private shortNameMap;
57
94
  constructor(zmodel: Model);
58
95
  generate(): Promise<string>;
59
96
  private generateDataSource;
@@ -69,7 +106,6 @@ declare class PrismaSchemaGenerator {
69
106
  private generateModelField;
70
107
  private isDefaultWithPluginInvocation;
71
108
  private isFromPlugin;
72
- private setDummyDefault;
73
109
  private isInheritedFromDelegate;
74
110
  private makeFieldAttribute;
75
111
  private makeAttributeArg;
@@ -79,23 +115,30 @@ declare class PrismaSchemaGenerator {
79
115
  private generateContainerAttribute;
80
116
  private generateEnum;
81
117
  private generateEnumField;
118
+ private generateDelegateRelationForBase;
119
+ private generateDelegateRelationForConcrete;
120
+ private getConcreteModels;
121
+ private truncate;
82
122
  }
83
123
 
84
124
  declare class TsSchemaGenerator {
85
- generate(schemaFile: string, pluginModelFiles: string[], outputFile: string): Promise<{
86
- model: Model;
87
- warnings: string[];
88
- }>;
125
+ generate(model: Model, outputDir: string): Promise<void>;
126
+ private generateSchema;
89
127
  private generateSchemaStatements;
90
128
  private createSchemaObject;
91
129
  private createProviderObject;
92
130
  private createModelsObject;
131
+ private createTypeDefsObject;
93
132
  private createDataModelObject;
133
+ private getSubModels;
134
+ private createTypeDefObject;
94
135
  private createComputedFieldsObject;
95
- private mapTypeToTSSyntaxKeyword;
96
- private createDataModelFieldObject;
136
+ private mapFieldTypeToTSType;
137
+ private createDataFieldObject;
138
+ private isDiscriminatorField;
97
139
  private getDataSourceProvider;
98
- private getMappedDefault;
140
+ private getFieldMappedDefault;
141
+ private getMappedValue;
99
142
  private getMemberAccessChain;
100
143
  private isAuthMemberAccess;
101
144
  private isAuthInvocation;
@@ -104,8 +147,8 @@ declare class TsSchemaGenerator {
104
147
  private getForeignKeyFor;
105
148
  private getOppositeRelationField;
106
149
  private getRelationName;
107
- private getIdFields;
108
150
  private createUniqueFieldsObject;
151
+ private generateFieldTypeLiteral;
109
152
  private createEnumObject;
110
153
  private getLiteral;
111
154
  private createLiteralNode;
@@ -124,6 +167,10 @@ declare class TsSchemaGenerator {
124
167
  private createRefExpression;
125
168
  private createCallExpression;
126
169
  private createLiteralExpression;
170
+ private generateModelsAndTypeDefs;
171
+ private generateSchemaImport;
172
+ private generateDocs;
173
+ private generateInputTypes;
127
174
  }
128
175
 
129
176
  /**
@@ -156,10 +203,10 @@ declare class ZModelCodeGenerator {
156
203
  private _generatePlugin;
157
204
  private _generatePluginField;
158
205
  private _generateDataModel;
159
- private _generateDataModelField;
206
+ private _generateDataField;
160
207
  private fieldType;
161
208
  private _generateDataModelAttribute;
162
- private _generateDataModelFieldAttribute;
209
+ private _generateDataFieldAttribute;
163
210
  private attribute;
164
211
  private _generateAttributeArg;
165
212
  private _generateObjectExpr;
@@ -183,7 +230,6 @@ declare class ZModelCodeGenerator {
183
230
  private _generateFunctionParam;
184
231
  private _generateFunctionParamType;
185
232
  private _generateTypeDef;
186
- private _generateTypeDefField;
187
233
  private argument;
188
234
  private get binaryExprSpace();
189
235
  private get unaryExprSpace();
@@ -192,4 +238,4 @@ declare class ZModelCodeGenerator {
192
238
  private isCollectionPredicateOperator;
193
239
  }
194
240
 
195
- export { modelUtils as ModelUtils, PrismaSchemaGenerator, TsSchemaGenerator, ZModelCodeGenerator, type ZModelCodeOptions };
241
+ export { type CliGeneratorContext, type CliPlugin, modelUtils as ModelUtils, PrismaSchemaGenerator, TsSchemaGenerator, ZModelCodeGenerator, type ZModelCodeOptions };