@zenstackhq/language 3.3.2 → 3.4.0-beta.1

package/dist/index.d.cts

@@ -2,24 +2,6 @@ import { Model, DataSource, GeneratorDecl, DataModel, TypeDef, Enum, Attribute,
 import { ValidationAcceptor, Module, DeepPartial, AstNode } from 'langium';
 import { LangiumServices, PartialLangiumServices, LangiumSharedServices, DefaultSharedModuleContext } from 'langium/lsp';
 
-/**
- * Loads ZModel document from the given file name. Include the additional document
- * files if given.
- */
-declare function loadDocument(fileName: string, additionalModelFiles?: string[]): Promise<{
-    success: true;
-    model: Model;
-    warnings: string[];
-} | {
-    success: false;
-    errors: string[];
-    warnings: string[];
-}>;
-/**
- * Formats the given ZModel content.
- */
-declare function formatDocument(content: string): Promise<string>;
-
 /******************************************************************************
  * This file was generated by langium-cli 3.5.0.
  * DO NOT EDIT MANUALLY!
@@ -96,6 +78,25 @@ declare function createZModelServices(logToConsole?: boolean): {
     ZModelLanguage: ZModelServices;
 };
 
+/**
+ * Loads ZModel document from the given file name. Include the additional document
+ * files if given.
+ */
+declare function loadDocument(fileName: string, additionalModelFiles?: string[], mergeImports?: boolean): Promise<{
+    success: true;
+    model: Model;
+    warnings: string[];
+    services: ZModelServices;
+} | {
+    success: false;
+    errors: string[];
+    warnings: string[];
+}>;
+/**
+ * Formats the given ZModel content.
+ */
+declare function formatDocument(content: string): Promise<string>;
+
 /**
  * Options for the generator.
  */
@@ -110,13 +111,16 @@ interface ZModelCodeOptions {
  */
 declare class ZModelCodeGenerator {
     private readonly options;
+    private readonly quote;
     constructor(options?: Partial<ZModelCodeOptions>);
     /**
      * Generates ZModel source code from AST.
      */
     generate(ast: AstNode): string;
+    private quotedStr;
     private _generateModel;
     private _generateDataSource;
+    private _generateModelImport;
     private _generateEnum;
     private _generateEnumField;
     private _generateGenerator;

package/dist/index.d.ts

@@ -2,24 +2,6 @@ import { Model, DataSource, GeneratorDecl, DataModel, TypeDef, Enum, Attribute,
 import { ValidationAcceptor, Module, DeepPartial, AstNode } from 'langium';
 import { LangiumServices, PartialLangiumServices, LangiumSharedServices, DefaultSharedModuleContext } from 'langium/lsp';
 
-/**
- * Loads ZModel document from the given file name. Include the additional document
- * files if given.
- */
-declare function loadDocument(fileName: string, additionalModelFiles?: string[]): Promise<{
-    success: true;
-    model: Model;
-    warnings: string[];
-} | {
-    success: false;
-    errors: string[];
-    warnings: string[];
-}>;
-/**
- * Formats the given ZModel content.
- */
-declare function formatDocument(content: string): Promise<string>;
-
 /******************************************************************************
  * This file was generated by langium-cli 3.5.0.
  * DO NOT EDIT MANUALLY!
@@ -96,6 +78,25 @@ declare function createZModelServices(logToConsole?: boolean): {
     ZModelLanguage: ZModelServices;
 };
 
+/**
+ * Loads ZModel document from the given file name. Include the additional document
+ * files if given.
+ */
+declare function loadDocument(fileName: string, additionalModelFiles?: string[], mergeImports?: boolean): Promise<{
+    success: true;
+    model: Model;
+    warnings: string[];
+    services: ZModelServices;
+} | {
+    success: false;
+    errors: string[];
+    warnings: string[];
+}>;
+/**
+ * Formats the given ZModel content.
+ */
+declare function formatDocument(content: string): Promise<string>;
+
 /**
  * Options for the generator.
  */
@@ -110,13 +111,16 @@ interface ZModelCodeOptions {
  */
 declare class ZModelCodeGenerator {
     private readonly options;
+    private readonly quote;
     constructor(options?: Partial<ZModelCodeOptions>);
     /**
      * Generates ZModel source code from AST.
      */
     generate(ast: AstNode): string;
+    private quotedStr;
     private _generateModel;
     private _generateDataSource;
+    private _generateModelImport;
     private _generateEnum;
     private _generateEnumField;
     private _generateGenerator;

package/dist/index.js

@@ -6421,7 +6421,8 @@ var DataModelValidator = class {
     const uniqueFields = allFields.filter((f) => f.attributes.find((attr) => attr.decl.ref?.name === "@unique"));
     const modelLevelIds = getModelIdFields(dm);
     const modelUniqueFields = getModelUniqueFields(dm);
-    if (!dm.isView && idFields.length === 0 && modelLevelIds.length === 0 && uniqueFields.length === 0 && modelUniqueFields.length === 0) {
+    const ignore = hasAttribute(dm, "@@ignore");
+    if (!dm.isView && idFields.length === 0 && modelLevelIds.length === 0 && uniqueFields.length === 0 && modelUniqueFields.length === 0 && !ignore) {
       accept("error", "Model must have at least one unique criteria. Either mark a single field with `@id`, `@unique` or add a multi field criterion with `@@id([])` or `@@unique([])` to the model.", {
         node: dm
       });
@@ -7711,6 +7712,7 @@ var ZModelCodeGenerator = class {
     __name(this, "ZModelCodeGenerator");
   }
   options;
+  quote;
   constructor(options) {
     this.options = {
       binaryExprNumberOfSpaces: options?.binaryExprNumberOfSpaces ?? 1,
@@ -7718,6 +7720,7 @@ var ZModelCodeGenerator = class {
       indent: options?.indent ?? 4,
       quote: options?.quote ?? "single"
     };
+    this.quote = this.options.quote === "double" ? '"' : "'";
   }
   /**
    * Generates ZModel source code from AST.
@@ -7729,17 +7732,28 @@ var ZModelCodeGenerator = class {
     }
     return handler.value.call(this, ast);
   }
+  quotedStr(val) {
+    const trimmedVal = val.replace(new RegExp(`(?<!\\\\)${this.quote}`, "g"), `\\${this.quote}`);
+    return `${this.quote}${trimmedVal}${this.quote}`;
+  }
   _generateModel(ast) {
-    return ast.declarations.map((d) => this.generate(d)).join("\n\n");
+    return `${ast.imports.map((d) => this.generate(d)).join("\n")}${ast.imports.length > 0 ? "\n\n" : ""}${ast.declarations.sort((a, b) => {
+      if (a.$type === "Enum" && b.$type !== "Enum") return 1;
+      if (a.$type !== "Enum" && b.$type === "Enum") return -1;
+      return 0;
+    }).map((d) => this.generate(d)).join("\n\n")}`;
   }
   _generateDataSource(ast) {
     return `datasource ${ast.name} {
 ${ast.fields.map((x) => this.indent + this.generate(x)).join("\n")}
 }`;
   }
+  _generateModelImport(ast) {
+    return `import ${this.quotedStr(ast.path)}`;
+  }
   _generateEnum(ast) {
     return `enum ${ast.name} {
-${ast.fields.map((x) => this.indent + this.generate(x)).join("\n")}
+${ast.fields.map((x) => this.indent + this.generate(x)).join("\n")}${ast.attributes.length > 0 ? "\n\n" + ast.attributes.map((x) => this.indent + this.generate(x)).join("\n") : ""}
 }`;
   }
   _generateEnumField(ast) {
@@ -7772,12 +7786,20 @@ ${ast.fields.map((x) => this.indent + this.generate(x)).join("\n")}
     return `${ast.name} = ${this.generate(ast.value)}`;
   }
   _generateDataModel(ast) {
-    return `${ast.isView ? "view" : "model"} ${ast.name}${ast.mixins.length > 0 ? " mixes " + ast.mixins.map((x) => x.$refText).join(", ") : ""} {
+    const comments = `${ast.comments.join("\n")}
+`;
+    return `${ast.comments.length > 0 ? comments : ""}${ast.isView ? "view" : "model"} ${ast.name}${ast.mixins.length > 0 ? " with " + ast.mixins.map((x) => x.$refText).join(", ") : ""} {
 ${ast.fields.map((x) => this.indent + this.generate(x)).join("\n")}${ast.attributes.length > 0 ? "\n\n" + ast.attributes.map((x) => this.indent + this.generate(x)).join("\n") : ""}
 }`;
   }
   _generateDataField(ast) {
-    return `${ast.name} ${this.fieldType(ast.type)}${ast.attributes.length > 0 ? " " + ast.attributes.map((x) => this.generate(x)).join(" ") : ""}`;
+    const fieldLine = `${ast.name} ${this.fieldType(ast.type)}${ast.attributes.length > 0 ? " " + ast.attributes.map((x) => this.generate(x)).join(" ") : ""}`;
+    if (ast.comments.length === 0) {
+      return fieldLine;
+    }
+    const commentLines = ast.comments.map((c, i) => i === 0 ? c : this.indent + c);
+    return `${commentLines.join("\n")}
+${this.indent}${fieldLine}`;
   }
   fieldType(type) {
     const baseType = type.type ? type.type : type.$type == "DataFieldType" && type.unsupported ? "Unsupported(" + this.generate(type.unsupported.value) + ")" : type.reference?.$refText;
@@ -7810,7 +7832,7 @@ ${ast.fields.map((x) => this.indent + this.generate(x)).join("\n")}${ast.attribu
     return `[${ast.items.map((item) => this.generate(item)).join(", ")}]`;
   }
   _generateLiteralExpr(ast) {
-    return this.options.quote === "single" ? `'${ast.value}'` : `"${ast.value}"`;
+    return this.quotedStr(ast.value);
   }
   _generateNumberLiteral(ast) {
     return ast.value.toString();
@@ -7834,7 +7856,7 @@ ${ast.fields.map((x) => this.indent + this.generate(x)).join("\n")}${ast.attribu
     return `${ast.target.$refText}${args}`;
   }
   _generateReferenceArg(ast) {
-    return `${ast.name}:${this.generate(ast.value)}`;
+    return `${ast.name}: ${this.generate(ast.value)}`;
   }
   _generateMemberExpr(ast) {
     return `${this.generate(ast.operand)}.${ast.member.$refText}`;
@@ -7923,6 +7945,14 @@ _ts_decorate3([
   ]),
   _ts_metadata3("design:returntype", void 0)
 ], ZModelCodeGenerator.prototype, "_generateDataSource", null);
+_ts_decorate3([
+  gen(ModelImport),
+  _ts_metadata3("design:type", Function),
+  _ts_metadata3("design:paramtypes", [
+    typeof ModelImport === "undefined" ? Object : ModelImport
+  ]),
+  _ts_metadata3("design:returntype", void 0)
+], ZModelCodeGenerator.prototype, "_generateModelImport", null);
 _ts_decorate3([
   gen(Enum),
   _ts_metadata3("design:type", Function),
@@ -9412,7 +9442,7 @@ function createZModelServices(logToConsole = false) {
 __name(createZModelServices, "createZModelServices");
 
 // src/document.ts
-async function loadDocument(fileName, additionalModelFiles = []) {
+async function loadDocument(fileName, additionalModelFiles = [], mergeImports = true) {
   const { ZModelLanguage: services } = createZModelServices(false);
   const extensions = services.LanguageMetaData.fileExtensions;
   if (!extensions.includes(path4.extname(fileName))) {
@@ -9479,12 +9509,14 @@ async function loadDocument(fileName, additionalModelFiles = []) {
     };
   }
   const model = document.parseResult.value;
-  const imported = mergeImportsDeclarations(langiumDocuments, model);
-  imported.forEach((model2) => {
-    langiumDocuments.deleteDocument(model2.$document.uri);
-    services.shared.workspace.IndexManager.remove(model2.$document.uri);
-  });
-  const additionalErrors = validationAfterImportMerge(model);
+  if (mergeImports) {
+    const imported = mergeImportsDeclarations(langiumDocuments, model);
+    imported.forEach((model2) => {
+      langiumDocuments.deleteDocument(model2.$document.uri);
+      services.shared.workspace.IndexManager.remove(model2.$document.uri);
+    });
+  }
+  const additionalErrors = mergeImports === true ? validationAfterImportMerge(model) : [];
   if (additionalErrors.length > 0) {
     return {
       success: false,
@@ -9495,6 +9527,7 @@ async function loadDocument(fileName, additionalModelFiles = []) {
   return {
     success: true,
     model: document.parseResult.value,
+    services,
     warnings
   };
 }