zenstack 0.6.0-pre.9 → 1.0.0-alpha.19

package/cli/cli-error.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Indicating an error during CLI execution
+ */
+export declare class CliError extends Error {
+}

package/cli/cli-error.js

@@ -0,0 +1,12 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.CliError = void 0;
+/**
+ * Indicating an error during CLI execution
+ */
+class CliError extends Error {}
+exports.CliError = CliError;
+//# sourceMappingURL=cli-error.js.map

package/cli/cli-error.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli-error.js","names":["CliError","Error"],"sources":["../../src/cli/cli-error.ts"],"sourcesContent":["/**\n * Indicating an error during CLI execution\n */\nexport class CliError extends Error {}\n"],"mappings":";;;;;;AAAA;AACA;AACA;AACO,MAAMA,QAAQ,SAASC,KAAK,CAAC;AAAE"}

package/cli/cli-util.d.ts

@@ -0,0 +1,18 @@
+import { Model } from '@zenstackhq/language/ast';
+import { LangiumServices } from 'langium';
+import { PackageManagers } from '../utils/pkg-utils';
+/**
+ * Initializes an existing project for ZenStack
+ */
+export declare function initProject(projectPath: string, prismaSchema: string | undefined, packageManager: PackageManagers | undefined, tag: string): Promise<void>;
+/**
+ * Loads a zmodel document from a file.
+ * @param fileName File name
+ * @param services Language services
+ * @returns Parsed and validated AST
+ */
+export declare function loadDocument(fileName: string, services: LangiumServices): Promise<Model>;
+export declare function runPlugins(options: {
+    schema: string;
+    packageManager: PackageManagers | undefined;
+}): Promise<void>;

package/cli/cli-util.js

@@ -0,0 +1,122 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.initProject = initProject;
+exports.loadDocument = loadDocument;
+exports.runPlugins = runPlugins;
+var _sdk = require("@zenstackhq/sdk");
+var _colors = _interopRequireDefault(require("colors"));
+var _fs = _interopRequireDefault(require("fs"));
+var _node = require("langium/node");
+var _path = _interopRequireDefault(require("path"));
+var _vscodeUri = require("vscode-uri");
+var _constants = require("../language-server/constants");
+var _zmodelModule = require("../language-server/zmodel-module");
+var _pkgUtils = require("../utils/pkg-utils");
+var _cliError = require("./cli-error");
+var _pluginRunner = require("./plugin-runner");
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+/**
+ * Initializes an existing project for ZenStack
+ */
+async function initProject(projectPath, prismaSchema, packageManager, tag) {
+  if (!_fs.default.existsSync(projectPath)) {
+    console.error(`Path does not exist: ${projectPath}`);
+    throw new _cliError.CliError('project path does not exist');
+  }
+  const defaultPrismaSchemaLocation = './prisma/schema.prisma';
+  if (prismaSchema) {
+    if (!_fs.default.existsSync(prismaSchema)) {
+      console.error(`Prisma schema file does not exist: ${prismaSchema}`);
+      throw new _cliError.CliError('prisma schema does not exist');
+    }
+  } else if (_fs.default.existsSync(defaultPrismaSchemaLocation)) {
+    prismaSchema = defaultPrismaSchemaLocation;
+  }
+  const zmodelFile = _path.default.join(projectPath, './schema.zmodel');
+  let sampleModelGenerated = false;
+  if (_fs.default.existsSync(zmodelFile)) {
+    console.warn(`ZenStack model already exists at ${zmodelFile}, not generating a new one.`);
+  } else {
+    if (prismaSchema) {
+      // copy over schema.prisma
+      _fs.default.copyFileSync(prismaSchema, zmodelFile);
+    } else {
+      // create a new model
+      const starterContent = _fs.default.readFileSync(_path.default.join(__dirname, '../res/starter.zmodel'), 'utf-8');
+      _fs.default.writeFileSync(zmodelFile, starterContent);
+      sampleModelGenerated = true;
+    }
+  }
+  (0, _pkgUtils.installPackage)('zenstack', true, packageManager, tag, projectPath);
+  (0, _pkgUtils.installPackage)('@zenstackhq/runtime', false, packageManager, tag, projectPath);
+  if (sampleModelGenerated) {
+    console.log(`Sample model generated at: ${_colors.default.blue(zmodelFile)}
+
+Please check the following guide on how to model your app:
+    https://zenstack.dev/#/modeling-your-app.`);
+  } else {
+    console.log(`Your current Prisma schema "${prismaSchema}" has been copied to "${zmodelFile}".
+Moving forward please edit this file and run "zenstack generate" to regenerate Prisma schema.`);
+  }
+  console.log(_colors.default.green('\nProject initialized successfully!'));
+}
+
+/**
+ * Loads a zmodel document from a file.
+ * @param fileName File name
+ * @param services Language services
+ * @returns Parsed and validated AST
+ */
+async function loadDocument(fileName, services) {
+  const extensions = services.LanguageMetaData.fileExtensions;
+  if (!extensions.includes(_path.default.extname(fileName))) {
+    console.error(_colors.default.yellow(`Please choose a file with extension: ${extensions}.`));
+    throw new _cliError.CliError('invalid schema file');
+  }
+  if (!_fs.default.existsSync(fileName)) {
+    console.error(_colors.default.red(`File ${fileName} does not exist.`));
+    throw new _cliError.CliError('schema file does not exist');
+  }
+
+  // load standard library
+  const stdLib = services.shared.workspace.LangiumDocuments.getOrCreateDocument(_vscodeUri.URI.file(_path.default.resolve(_path.default.join(__dirname, '../res', _constants.STD_LIB_MODULE_NAME))));
+
+  // load the document
+  const document = services.shared.workspace.LangiumDocuments.getOrCreateDocument(_vscodeUri.URI.file(_path.default.resolve(fileName)));
+
+  // build the document together with standard library
+  await services.shared.workspace.DocumentBuilder.build([stdLib, document], {
+    validationChecks: 'all'
+  });
+  const validationErrors = (document.diagnostics ?? []).filter(e => e.severity === 1);
+  if (validationErrors.length > 0) {
+    console.error(_colors.default.red('Validation errors:'));
+    for (const validationError of validationErrors) {
+      console.error(_colors.default.red(`line ${validationError.range.start.line + 1}: ${validationError.message} [${document.textDocument.getText(validationError.range)}]`));
+    }
+    throw new _cliError.CliError('schema validation errors');
+  }
+  return document.parseResult.value;
+}
+async function runPlugins(options) {
+  const services = (0, _zmodelModule.createZModelServices)(_node.NodeFileSystem).ZModel;
+  const model = await loadDocument(options.schema, services);
+  const context = {
+    schema: model,
+    outDir: _path.default.dirname(options.schema)
+  };
+  try {
+    await new _pluginRunner.PluginRunner().run(context);
+  } catch (err) {
+    if (err instanceof _sdk.PluginError) {
+      console.error(_colors.default.red(err.message));
+      throw new _cliError.CliError(err.message);
+    } else {
+      throw err;
+    }
+  }
+}
+//# sourceMappingURL=cli-util.js.map

package/cli/cli-util.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli-util.js","names":["initProject","projectPath","prismaSchema","packageManager","tag","fs","existsSync","console","error","CliError","defaultPrismaSchemaLocation","zmodelFile","path","join","sampleModelGenerated","warn","copyFileSync","starterContent","readFileSync","__dirname","writeFileSync","installPackage","log","colors","blue","green","loadDocument","fileName","services","extensions","LanguageMetaData","fileExtensions","includes","extname","yellow","red","stdLib","shared","workspace","LangiumDocuments","getOrCreateDocument","URI","file","resolve","STD_LIB_MODULE_NAME","document","DocumentBuilder","build","validationChecks","validationErrors","diagnostics","filter","e","severity","length","validationError","range","start","line","message","textDocument","getText","parseResult","value","runPlugins","options","createZModelServices","NodeFileSystem","ZModel","model","schema","context","outDir","dirname","PluginRunner","run","err","PluginError"],"sources":["../../src/cli/cli-util.ts"],"sourcesContent":["import { Model } from '@zenstackhq/language/ast';\nimport { PluginError } from '@zenstackhq/sdk';\nimport colors from 'colors';\nimport fs from 'fs';\nimport { LangiumServices } from 'langium';\nimport { NodeFileSystem } from 'langium/node';\nimport path from 'path';\nimport { URI } from 'vscode-uri';\nimport { STD_LIB_MODULE_NAME } from '../language-server/constants';\nimport { createZModelServices } from '../language-server/zmodel-module';\nimport { Context } from '../types';\nimport { installPackage, PackageManagers } from '../utils/pkg-utils';\nimport { CliError } from './cli-error';\nimport { PluginRunner } from './plugin-runner';\n\n/**\n * Initializes an existing project for ZenStack\n */\nexport async function initProject(\n    projectPath: string,\n    prismaSchema: string | undefined,\n    packageManager: PackageManagers | undefined,\n    tag: string\n) {\n    if (!fs.existsSync(projectPath)) {\n        console.error(`Path does not exist: ${projectPath}`);\n        throw new CliError('project path does not exist');\n    }\n\n    const defaultPrismaSchemaLocation = './prisma/schema.prisma';\n    if (prismaSchema) {\n        if (!fs.existsSync(prismaSchema)) {\n            console.error(`Prisma schema file does not exist: ${prismaSchema}`);\n            throw new CliError('prisma schema does not exist');\n        }\n    } else if (fs.existsSync(defaultPrismaSchemaLocation)) {\n        prismaSchema = defaultPrismaSchemaLocation;\n    }\n\n    const zmodelFile = path.join(projectPath, './schema.zmodel');\n    let sampleModelGenerated = false;\n\n    if (fs.existsSync(zmodelFile)) {\n        console.warn(`ZenStack model already exists at ${zmodelFile}, not generating a new one.`);\n    } else {\n        if (prismaSchema) {\n            // copy over schema.prisma\n            fs.copyFileSync(prismaSchema, zmodelFile);\n        } else {\n            // create a new model\n            const starterContent = fs.readFileSync(path.join(__dirname, '../res/starter.zmodel'), 'utf-8');\n            fs.writeFileSync(zmodelFile, starterContent);\n            sampleModelGenerated = true;\n        }\n    }\n\n    installPackage('zenstack', true, packageManager, tag, projectPath);\n    installPackage('@zenstackhq/runtime', false, packageManager, tag, projectPath);\n\n    if (sampleModelGenerated) {\n        console.log(`Sample model generated at: ${colors.blue(zmodelFile)}\n\nPlease check the following guide on how to model your app:\n    https://zenstack.dev/#/modeling-your-app.`);\n    } else {\n        console.log(\n            `Your current Prisma schema \"${prismaSchema}\" has been copied to \"${zmodelFile}\".\nMoving forward please edit this file and run \"zenstack generate\" to regenerate Prisma schema.`\n        );\n    }\n\n    console.log(colors.green('\\nProject initialized successfully!'));\n}\n\n/**\n * Loads a zmodel document from a file.\n * @param fileName File name\n * @param services Language services\n * @returns Parsed and validated AST\n */\nexport async function loadDocument(fileName: string, services: LangiumServices): Promise<Model> {\n    const extensions = services.LanguageMetaData.fileExtensions;\n    if (!extensions.includes(path.extname(fileName))) {\n        console.error(colors.yellow(`Please choose a file with extension: ${extensions}.`));\n        throw new CliError('invalid schema file');\n    }\n\n    if (!fs.existsSync(fileName)) {\n        console.error(colors.red(`File ${fileName} does not exist.`));\n        throw new CliError('schema file does not exist');\n    }\n\n    // load standard library\n    const stdLib = services.shared.workspace.LangiumDocuments.getOrCreateDocument(\n        URI.file(path.resolve(path.join(__dirname, '../res', STD_LIB_MODULE_NAME)))\n    );\n\n    // load the document\n    const document = services.shared.workspace.LangiumDocuments.getOrCreateDocument(URI.file(path.resolve(fileName)));\n\n    // build the document together with standard library\n    await services.shared.workspace.DocumentBuilder.build([stdLib, document], {\n        validationChecks: 'all',\n    });\n\n    const validationErrors = (document.diagnostics ?? []).filter((e) => e.severity === 1);\n    if (validationErrors.length > 0) {\n        console.error(colors.red('Validation errors:'));\n        for (const validationError of validationErrors) {\n            console.error(\n                colors.red(\n                    `line ${validationError.range.start.line + 1}: ${\n                        validationError.message\n                    } [${document.textDocument.getText(validationError.range)}]`\n                )\n            );\n        }\n        throw new CliError('schema validation errors');\n    }\n\n    return document.parseResult.value as Model;\n}\n\nexport async function runPlugins(options: { schema: string; packageManager: PackageManagers | undefined }) {\n    const services = createZModelServices(NodeFileSystem).ZModel;\n    const model = await loadDocument(options.schema, services);\n\n    const context: Context = {\n        schema: model,\n        outDir: path.dirname(options.schema),\n    };\n\n    try {\n        await new PluginRunner().run(context);\n    } catch (err) {\n        if (err instanceof PluginError) {\n            console.error(colors.red(err.message));\n            throw new CliError(err.message);\n        } else {\n            throw err;\n        }\n    }\n}\n"],"mappings":";;;;;;;;AACA;AACA;AACA;AAEA;AACA;AACA;AACA;AACA;AAEA;AACA;AACA;AAA+C;AAE/C;AACA;AACA;AACO,eAAeA,WAAW,CAC7BC,WAAmB,EACnBC,YAAgC,EAChCC,cAA2C,EAC3CC,GAAW,EACb;EACE,IAAI,CAACC,WAAE,CAACC,UAAU,CAACL,WAAW,CAAC,EAAE;IAC7BM,OAAO,CAACC,KAAK,CAAE,wBAAuBP,WAAY,EAAC,CAAC;IACpD,MAAM,IAAIQ,kBAAQ,CAAC,6BAA6B,CAAC;EACrD;EAEA,MAAMC,2BAA2B,GAAG,wBAAwB;EAC5D,IAAIR,YAAY,EAAE;IACd,IAAI,CAACG,WAAE,CAACC,UAAU,CAACJ,YAAY,CAAC,EAAE;MAC9BK,OAAO,CAACC,KAAK,CAAE,sCAAqCN,YAAa,EAAC,CAAC;MACnE,MAAM,IAAIO,kBAAQ,CAAC,8BAA8B,CAAC;IACtD;EACJ,CAAC,MAAM,IAAIJ,WAAE,CAACC,UAAU,CAACI,2BAA2B,CAAC,EAAE;IACnDR,YAAY,GAAGQ,2BAA2B;EAC9C;EAEA,MAAMC,UAAU,GAAGC,aAAI,CAACC,IAAI,CAACZ,WAAW,EAAE,iBAAiB,CAAC;EAC5D,IAAIa,oBAAoB,GAAG,KAAK;EAEhC,IAAIT,WAAE,CAACC,UAAU,CAACK,UAAU,CAAC,EAAE;IAC3BJ,OAAO,CAACQ,IAAI,CAAE,oCAAmCJ,UAAW,6BAA4B,CAAC;EAC7F,CAAC,MAAM;IACH,IAAIT,YAAY,EAAE;MACd;MACAG,WAAE,CAACW,YAAY,CAACd,YAAY,EAAES,UAAU,CAAC;IAC7C,CAAC,MAAM;MACH;MACA,MAAMM,cAAc,GAAGZ,WAAE,CAACa,YAAY,CAACN,aAAI,CAACC,IAAI,CAACM,SAAS,EAAE,uBAAuB,CAAC,EAAE,OAAO,CAAC;MAC9Fd,WAAE,CAACe,aAAa,CAACT,UAAU,EAAEM,cAAc,CAAC;MAC5CH,oBAAoB,GAAG,IAAI;IAC/B;EACJ;EAEA,IAAAO,wBAAc,EAAC,UAAU,EAAE,IAAI,EAAElB,cAAc,EAAEC,GAAG,EAAEH,WAAW,CAAC;EAClE,IAAAoB,wBAAc,EAAC,qBAAqB,EAAE,KAAK,EAAElB,cAAc,EAAEC,GAAG,EAAEH,WAAW,CAAC;EAE9E,IAAIa,oBAAoB,EAAE;IACtBP,OAAO,CAACe,GAAG,CAAE,8BAA6BC,eAAM,CAACC,IAAI,CAACb,UAAU,CAAE;AAC1E;AACA;AACA,8CAA8C,CAAC;EAC3C,CAAC,MAAM;IACHJ,OAAO,CAACe,GAAG,CACN,+BAA8BpB,YAAa,yBAAwBS,UAAW;AAC3F,8FAA8F,CACrF;EACL;EAEAJ,OAAO,CAACe,GAAG,CAACC,eAAM,CAACE,KAAK,CAAC,qCAAqC,CAAC,CAAC;AACpE;;AAEA;AACA;AACA;AACA;AACA;AACA;AACO,eAAeC,YAAY,CAACC,QAAgB,EAAEC,QAAyB,EAAkB;EAC5F,MAAMC,UAAU,GAAGD,QAAQ,CAACE,gBAAgB,CAACC,cAAc;EAC3D,IAAI,CAACF,UAAU,CAACG,QAAQ,CAACpB,aAAI,CAACqB,OAAO,CAACN,QAAQ,CAAC,CAAC,EAAE;IAC9CpB,OAAO,CAACC,KAAK,CAACe,eAAM,CAACW,MAAM,CAAE,wCAAuCL,UAAW,GAAE,CAAC,CAAC;IACnF,MAAM,IAAIpB,kBAAQ,CAAC,qBAAqB,CAAC;EAC7C;EAEA,IAAI,CAACJ,WAAE,CAACC,UAAU,CAACqB,QAAQ,CAAC,EAAE;IAC1BpB,OAAO,CAACC,KAAK,CAACe,eAAM,CAACY,GAAG,CAAE,QAAOR,QAAS,kBAAiB,CAAC,CAAC;IAC7D,MAAM,IAAIlB,kBAAQ,CAAC,4BAA4B,CAAC;EACpD;;EAEA;EACA,MAAM2B,MAAM,GAAGR,QAAQ,CAACS,MAAM,CAACC,SAAS,CAACC,gBAAgB,CAACC,mBAAmB,CACzEC,cAAG,CAACC,IAAI,CAAC9B,aAAI,CAAC+B,OAAO,CAAC/B,aAAI,CAACC,IAAI,CAACM,SAAS,EAAE,QAAQ,EAAEyB,8BAAmB,CAAC,CAAC,CAAC,CAC9E;;EAED;EACA,MAAMC,QAAQ,GAAGjB,QAAQ,CAACS,MAAM,CAACC,SAAS,CAACC,gBAAgB,CAACC,mBAAmB,CAACC,cAAG,CAACC,IAAI,CAAC9B,aAAI,CAAC+B,OAAO,CAAChB,QAAQ,CAAC,CAAC,CAAC;;EAEjH;EACA,MAAMC,QAAQ,CAACS,MAAM,CAACC,SAAS,CAACQ,eAAe,CAACC,KAAK,CAAC,CAACX,MAAM,EAAES,QAAQ,CAAC,EAAE;IACtEG,gBAAgB,EAAE;EACtB,CAAC,CAAC;EAEF,MAAMC,gBAAgB,GAAG,CAACJ,QAAQ,CAACK,WAAW,IAAI,EAAE,EAAEC,MAAM,CAAEC,CAAC,IAAKA,CAAC,CAACC,QAAQ,KAAK,CAAC,CAAC;EACrF,IAAIJ,gBAAgB,CAACK,MAAM,GAAG,CAAC,EAAE;IAC7B/C,OAAO,CAACC,KAAK,CAACe,eAAM,CAACY,GAAG,CAAC,oBAAoB,CAAC,CAAC;IAC/C,KAAK,MAAMoB,eAAe,IAAIN,gBAAgB,EAAE;MAC5C1C,OAAO,CAACC,KAAK,CACTe,eAAM,CAACY,GAAG,CACL,QAAOoB,eAAe,CAACC,KAAK,CAACC,KAAK,CAACC,IAAI,GAAG,CAAE,KACzCH,eAAe,CAACI,OACnB,KAAId,QAAQ,CAACe,YAAY,CAACC,OAAO,CAACN,eAAe,CAACC,KAAK,CAAE,GAAE,CAC/D,CACJ;IACL;IACA,MAAM,IAAI/C,kBAAQ,CAAC,0BAA0B,CAAC;EAClD;EAEA,OAAOoC,QAAQ,CAACiB,WAAW,CAACC,KAAK;AACrC;AAEO,eAAeC,UAAU,CAACC,OAAwE,EAAE;EACvG,MAAMrC,QAAQ,GAAG,IAAAsC,kCAAoB,EAACC,oBAAc,CAAC,CAACC,MAAM;EAC5D,MAAMC,KAAK,GAAG,MAAM3C,YAAY,CAACuC,OAAO,CAACK,MAAM,EAAE1C,QAAQ,CAAC;EAE1D,MAAM2C,OAAgB,GAAG;IACrBD,MAAM,EAAED,KAAK;IACbG,MAAM,EAAE5D,aAAI,CAAC6D,OAAO,CAACR,OAAO,CAACK,MAAM;EACvC,CAAC;EAED,IAAI;IACA,MAAM,IAAII,0BAAY,EAAE,CAACC,GAAG,CAACJ,OAAO,CAAC;EACzC,CAAC,CAAC,OAAOK,GAAG,EAAE;IACV,IAAIA,GAAG,YAAYC,gBAAW,EAAE;MAC5BtE,OAAO,CAACC,KAAK,CAACe,eAAM,CAACY,GAAG,CAACyC,GAAG,CAACjB,OAAO,CAAC,CAAC;MACtC,MAAM,IAAIlD,kBAAQ,CAACmE,GAAG,CAACjB,OAAO,CAAC;IACnC,CAAC,MAAM;MACH,MAAMiB,GAAG;IACb;EACJ;AACJ"}

package/cli/index.d.ts

@@ -0,0 +1,14 @@
+import { Command } from 'commander';
+import { PackageManagers } from '../utils/pkg-utils';
+export declare const requiredPrismaVersion = "4.0.0";
+export declare const initAction: (projectPath: string, options: {
+    prisma: string | undefined;
+    packageManager: PackageManagers | undefined;
+    tag: string;
+}) => Promise<void>;
+export declare const generateAction: (options: {
+    schema: string;
+    packageManager: PackageManagers | undefined;
+}) => Promise<void>;
+export declare function createProgram(): Command;
+export default function (): Promise<void>;