@zenstackhq/sdk 2.16.0 → 3.0.0-alpha.1

package/dist/index.d.ts

@@ -0,0 +1,196 @@
+import * as _zenstackhq_language_ast from '@zenstackhq/language/ast';
+import { DataModelField, DataModel, TypeDef, Enum, EnumField, FunctionDecl, Attribute, AttributeParam, TypeDefField, DataModelFieldAttribute, DataModelAttribute, AstNode, Model, Reference, InvocationExpr } from '@zenstackhq/language/ast';
+
+declare function isIdField(field: DataModelField): boolean;
+declare function hasAttribute(decl: DataModel | TypeDef | DataModelField | Enum | EnumField | FunctionDecl | Attribute | AttributeParam, name: string): boolean;
+declare function getAttribute(decl: DataModel | TypeDef | DataModelField | TypeDefField | Enum | EnumField | FunctionDecl | Attribute | AttributeParam, name: string): DataModelFieldAttribute | DataModelAttribute | undefined;
+/**
+ * Gets `@@id` fields declared at the data model level (including search in base models)
+ */
+declare function getModelIdFields(model: DataModel): DataModelField[];
+/**
+ * Gets `@@unique` fields declared at the data model level (including search in base models)
+ */
+declare function getModelUniqueFields(model: DataModel): DataModelField[];
+declare function getRecursiveBases(dataModel: DataModel, includeDelegate?: boolean, seen?: Set<DataModel>): DataModel[];
+declare function isDelegateModel(node: AstNode): boolean;
+declare function isUniqueField(field: DataModelField): boolean;
+declare function isFromStdlib(node: AstNode): boolean;
+declare function getContainingModel(node: AstNode | undefined): Model | null;
+declare function resolved<T extends AstNode>(ref: Reference<T>): T;
+declare function getAuthDecl(model: Model): _zenstackhq_language_ast.AbstractDeclaration | undefined;
+
+declare const modelUtils_getAttribute: typeof getAttribute;
+declare const modelUtils_getAuthDecl: typeof getAuthDecl;
+declare const modelUtils_getContainingModel: typeof getContainingModel;
+declare const modelUtils_getModelIdFields: typeof getModelIdFields;
+declare const modelUtils_getModelUniqueFields: typeof getModelUniqueFields;
+declare const modelUtils_getRecursiveBases: typeof getRecursiveBases;
+declare const modelUtils_hasAttribute: typeof hasAttribute;
+declare const modelUtils_isDelegateModel: typeof isDelegateModel;
+declare const modelUtils_isFromStdlib: typeof isFromStdlib;
+declare const modelUtils_isIdField: typeof isIdField;
+declare const modelUtils_isUniqueField: typeof isUniqueField;
+declare const modelUtils_resolved: typeof resolved;
+declare namespace modelUtils {
+  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 };
+}
+
+declare class FunctionCall {
+    func: string;
+    args: FunctionCallArg[];
+    constructor(func: string, args?: FunctionCallArg[]);
+    toString(): string;
+}
+declare class FunctionCallArg {
+    value: string;
+    constructor(value: string);
+    toString(): string;
+}
+
+/**
+ * Generates Prisma schema file
+ */
+declare class PrismaSchemaGenerator {
+    private readonly zmodel;
+    private readonly PRELUDE;
+    constructor(zmodel: Model);
+    generate(): Promise<string>;
+    private generateDataSource;
+    private configExprToText;
+    private configArrayToText;
+    private configInvocationArgToText;
+    private literalToText;
+    private generateGenerator;
+    private generateModel;
+    private isPrismaAttribute;
+    private getUnsupportedFieldType;
+    private getStringLiteral;
+    private generateModelField;
+    private isDefaultWithPluginInvocation;
+    private isFromPlugin;
+    private setDummyDefault;
+    private isInheritedFromDelegate;
+    private makeFieldAttribute;
+    private makeAttributeArg;
+    private makeAttributeArgValue;
+    private exprToText;
+    makeFunctionCall(node: InvocationExpr): FunctionCall;
+    private generateContainerAttribute;
+    private generateEnum;
+    private generateEnumField;
+}
+
+declare class TsSchemaGenerator {
+    generate(schemaFile: string, pluginModelFiles: string[], outputFile: string): Promise<{
+        model: Model;
+        warnings: string[];
+    }>;
+    private generateSchemaStatements;
+    private createSchemaObject;
+    private createProviderObject;
+    private createModelsObject;
+    private createDataModelObject;
+    private createComputedFieldsObject;
+    private mapTypeToTSSyntaxKeyword;
+    private createDataModelFieldObject;
+    private getDataSourceProvider;
+    private getMappedDefault;
+    private getMemberAccessChain;
+    private isAuthMemberAccess;
+    private isAuthInvocation;
+    private createRelationObject;
+    private getReferenceNames;
+    private getForeignKeyFor;
+    private getOppositeRelationField;
+    private getRelationName;
+    private getIdFields;
+    private createUniqueFieldsObject;
+    private createEnumObject;
+    private getLiteral;
+    private createLiteralNode;
+    private createDialectConfigProvider;
+    private createProceduresObject;
+    private createProcedureObject;
+    private generateBannerComments;
+    private createAttributeObject;
+    private createAttributeArg;
+    private createExpression;
+    private createThisExpression;
+    private createMemberExpression;
+    private createNullExpression;
+    private createBinaryExpression;
+    private createUnaryExpression;
+    private createArrayExpression;
+    private createRefExpression;
+    private createCallExpression;
+    private createLiteralExpression;
+}
+
+/**
+ * Options for the generator.
+ */
+interface ZModelCodeOptions {
+    binaryExprNumberOfSpaces: number;
+    unaryExprNumberOfSpaces: number;
+    indent: number;
+    quote: 'single' | 'double';
+}
+/**
+ * Generates ZModel source code from AST.
+ */
+declare class ZModelCodeGenerator {
+    private readonly options;
+    constructor(options?: Partial<ZModelCodeOptions>);
+    /**
+     * Generates ZModel source code from AST.
+     */
+    generate(ast: AstNode): string;
+    private _generateModel;
+    private _generateDataSource;
+    private _generateEnum;
+    private _generateEnumField;
+    private _generateGenerator;
+    private _generateConfigField;
+    private _generateConfigArrayExpr;
+    private _generateConfigInvocationExpr;
+    private _generatePlugin;
+    private _generatePluginField;
+    private _generateDataModel;
+    private _generateDataModelField;
+    private fieldType;
+    private _generateDataModelAttribute;
+    private _generateDataModelFieldAttribute;
+    private attribute;
+    private _generateAttributeArg;
+    private _generateObjectExpr;
+    private objectField;
+    private _generateArrayExpr;
+    private _generateLiteralExpr;
+    private _generateNumberLiteral;
+    private _generateBooleanLiteral;
+    private _generateUnaryExpr;
+    private _generateBinaryExpr;
+    private _generateReferenceExpr;
+    private _generateReferenceArg;
+    private _generateMemberExpr;
+    private _generateInvocationExpr;
+    private _generateNullExpr;
+    private _generateThisExpr;
+    private _generateAttribute;
+    private _generateAttributeParam;
+    private _generateAttributeParamType;
+    private _generateFunctionDecl;
+    private _generateFunctionParam;
+    private _generateFunctionParamType;
+    private _generateTypeDef;
+    private _generateTypeDefField;
+    private argument;
+    private get binaryExprSpace();
+    private get unaryExprSpace();
+    private get indent();
+    private isParenthesesNeededForBinaryExpr;
+    private isCollectionPredicateOperator;
+}
+
+export { modelUtils as ModelUtils, PrismaSchemaGenerator, TsSchemaGenerator, ZModelCodeGenerator, type ZModelCodeOptions };