zenstack 0.6.0-pre.10 → 0.6.0-pre.12

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, packageManager: PackageManagers | undefined): 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,168 @@
+"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, packageManager) {
+  if (!_fs.default.existsSync(projectPath)) {
+    console.error(`Path does not exist: ${projectPath}`);
+    throw new _cliError.CliError('project path does not exist');
+  }
+  const schema = _path.default.join(projectPath, 'zenstack', 'schema.zmodel');
+  let schemaGenerated = false;
+  if (_fs.default.existsSync(schema)) {
+    console.warn(_colors.default.yellow(`Model already exists: ${schema}`));
+  } else {
+    // create a default model
+    if (!_fs.default.existsSync(_path.default.join(projectPath, 'zenstack'))) {
+      _fs.default.mkdirSync(_path.default.join(projectPath, 'zenstack'));
+    }
+    _fs.default.writeFileSync(schema, `// This is a sample model to get you started.
+// Learn how to model you app: https://zenstack.dev/#/modeling-your-app.
+
+/*
+ * A sample data source using local sqlite db.
+ * See how to use a different db: https://zenstack.dev/#/zmodel-data-source.
+ */
+datasource db {
+    provider = 'sqlite'
+    url = 'file:./todo.db'
+}
+
+/*
+ * User model
+ */
+model User {
+    id String @id @default(cuid())
+    email String @unique @email
+    password String @password @omit @length(8, 16)
+    posts Post[]
+
+    // everybody can signup
+    @@allow('create', true)
+
+    // full access by self
+    @@allow('all', auth() == this)
+}
+
+/*
+ * Post model
+ */
+model Post {
+    id String @id @default(cuid())
+    createdAt DateTime @default(now())
+    updatedAt DateTime @updatedAt
+    title String @length(1, 256)
+    content String
+    published Boolean @default(false)
+    author User? @relation(fields: [authorId], references: [id])
+    authorId String?
+
+    // allow read for all signin users
+    @@allow('read', auth() != null && published)
+
+    // full access by author
+    @@allow('all', author == auth())
+}
+`);
+
+    // add zenstack/schema.prisma to .gitignore
+    const gitIgnorePath = _path.default.join(projectPath, '.gitignore');
+    let gitIgnoreContent = '';
+    if (_fs.default.existsSync(gitIgnorePath)) {
+      gitIgnoreContent = _fs.default.readFileSync(gitIgnorePath, {
+        encoding: 'utf-8'
+      }) + '\n';
+    }
+    if (!gitIgnoreContent.includes('zenstack/schema.prisma')) {
+      gitIgnoreContent += 'zenstack/schema.prisma\n';
+      _fs.default.writeFileSync(gitIgnorePath, gitIgnoreContent);
+    }
+    schemaGenerated = true;
+  }
+  (0, _pkgUtils.installPackage)('zenstack', true, packageManager, projectPath);
+  (0, _pkgUtils.installPackage)('@zenstackhq/runtime', false, packageManager, projectPath);
+  if (schemaGenerated) {
+    console.log(`Sample model generated at: ${_colors.default.blue(schema)}
+
+        Please check the following guide on how to model your app:
+            https://zenstack.dev/#/modeling-your-app.
+            `);
+  }
+  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","packageManager","fs","existsSync","console","error","CliError","schema","path","join","schemaGenerated","warn","colors","yellow","mkdirSync","writeFileSync","gitIgnorePath","gitIgnoreContent","readFileSync","encoding","includes","installPackage","log","blue","green","loadDocument","fileName","services","extensions","LanguageMetaData","fileExtensions","extname","red","stdLib","shared","workspace","LangiumDocuments","getOrCreateDocument","URI","file","resolve","__dirname","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","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(projectPath: string, packageManager: PackageManagers | undefined) {\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 schema = path.join(projectPath, 'zenstack', 'schema.zmodel');\n    let schemaGenerated = false;\n\n    if (fs.existsSync(schema)) {\n        console.warn(colors.yellow(`Model already exists: ${schema}`));\n    } else {\n        // create a default model\n        if (!fs.existsSync(path.join(projectPath, 'zenstack'))) {\n            fs.mkdirSync(path.join(projectPath, 'zenstack'));\n        }\n\n        fs.writeFileSync(\n            schema,\n            `// This is a sample model to get you started.\n// Learn how to model you app: https://zenstack.dev/#/modeling-your-app.\n\n/*\n * A sample data source using local sqlite db.\n * See how to use a different db: https://zenstack.dev/#/zmodel-data-source.\n */\ndatasource db {\n    provider = 'sqlite'\n    url = 'file:./todo.db'\n}\n\n/*\n * User model\n */\nmodel User {\n    id String @id @default(cuid())\n    email String @unique @email\n    password String @password @omit @length(8, 16)\n    posts Post[]\n\n    // everybody can signup\n    @@allow('create', true)\n\n    // full access by self\n    @@allow('all', auth() == this)\n}\n\n/*\n * Post model\n */\nmodel Post {\n    id String @id @default(cuid())\n    createdAt DateTime @default(now())\n    updatedAt DateTime @updatedAt\n    title String @length(1, 256)\n    content String\n    published Boolean @default(false)\n    author User? @relation(fields: [authorId], references: [id])\n    authorId String?\n\n    // allow read for all signin users\n    @@allow('read', auth() != null && published)\n\n    // full access by author\n    @@allow('all', author == auth())\n}\n`\n        );\n\n        // add zenstack/schema.prisma to .gitignore\n        const gitIgnorePath = path.join(projectPath, '.gitignore');\n        let gitIgnoreContent = '';\n        if (fs.existsSync(gitIgnorePath)) {\n            gitIgnoreContent = fs.readFileSync(gitIgnorePath, { encoding: 'utf-8' }) + '\\n';\n        }\n\n        if (!gitIgnoreContent.includes('zenstack/schema.prisma')) {\n            gitIgnoreContent += 'zenstack/schema.prisma\\n';\n            fs.writeFileSync(gitIgnorePath, gitIgnoreContent);\n        }\n\n        schemaGenerated = true;\n    }\n\n    installPackage('zenstack', true, packageManager, projectPath);\n    installPackage('@zenstackhq/runtime', false, packageManager, projectPath);\n\n    if (schemaGenerated) {\n        console.log(`Sample model generated at: ${colors.blue(schema)}\n\n        Please check the following guide on how to model your app:\n            https://zenstack.dev/#/modeling-your-app.\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,CAACC,WAAmB,EAAEC,cAA2C,EAAE;EAChG,IAAI,CAACC,WAAE,CAACC,UAAU,CAACH,WAAW,CAAC,EAAE;IAC7BI,OAAO,CAACC,KAAK,CAAE,wBAAuBL,WAAY,EAAC,CAAC;IACpD,MAAM,IAAIM,kBAAQ,CAAC,6BAA6B,CAAC;EACrD;EAEA,MAAMC,MAAM,GAAGC,aAAI,CAACC,IAAI,CAACT,WAAW,EAAE,UAAU,EAAE,eAAe,CAAC;EAClE,IAAIU,eAAe,GAAG,KAAK;EAE3B,IAAIR,WAAE,CAACC,UAAU,CAACI,MAAM,CAAC,EAAE;IACvBH,OAAO,CAACO,IAAI,CAACC,eAAM,CAACC,MAAM,CAAE,yBAAwBN,MAAO,EAAC,CAAC,CAAC;EAClE,CAAC,MAAM;IACH;IACA,IAAI,CAACL,WAAE,CAACC,UAAU,CAACK,aAAI,CAACC,IAAI,CAACT,WAAW,EAAE,UAAU,CAAC,CAAC,EAAE;MACpDE,WAAE,CAACY,SAAS,CAACN,aAAI,CAACC,IAAI,CAACT,WAAW,EAAE,UAAU,CAAC,CAAC;IACpD;IAEAE,WAAE,CAACa,aAAa,CACZR,MAAM,EACL;AACb;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,CAAC,CACQ;;IAED;IACA,MAAMS,aAAa,GAAGR,aAAI,CAACC,IAAI,CAACT,WAAW,EAAE,YAAY,CAAC;IAC1D,IAAIiB,gBAAgB,GAAG,EAAE;IACzB,IAAIf,WAAE,CAACC,UAAU,CAACa,aAAa,CAAC,EAAE;MAC9BC,gBAAgB,GAAGf,WAAE,CAACgB,YAAY,CAACF,aAAa,EAAE;QAAEG,QAAQ,EAAE;MAAQ,CAAC,CAAC,GAAG,IAAI;IACnF;IAEA,IAAI,CAACF,gBAAgB,CAACG,QAAQ,CAAC,wBAAwB,CAAC,EAAE;MACtDH,gBAAgB,IAAI,0BAA0B;MAC9Cf,WAAE,CAACa,aAAa,CAACC,aAAa,EAAEC,gBAAgB,CAAC;IACrD;IAEAP,eAAe,GAAG,IAAI;EAC1B;EAEA,IAAAW,wBAAc,EAAC,UAAU,EAAE,IAAI,EAAEpB,cAAc,EAAED,WAAW,CAAC;EAC7D,IAAAqB,wBAAc,EAAC,qBAAqB,EAAE,KAAK,EAAEpB,cAAc,EAAED,WAAW,CAAC;EAEzE,IAAIU,eAAe,EAAE;IACjBN,OAAO,CAACkB,GAAG,CAAE,8BAA6BV,eAAM,CAACW,IAAI,CAAChB,MAAM,CAAE;AACtE;AACA;AACA;AACA,aAAa,CAAC;EACV;EAEAH,OAAO,CAACkB,GAAG,CAACV,eAAM,CAACY,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,CAACR,QAAQ,CAACZ,aAAI,CAACuB,OAAO,CAACL,QAAQ,CAAC,CAAC,EAAE;IAC9CtB,OAAO,CAACC,KAAK,CAACO,eAAM,CAACC,MAAM,CAAE,wCAAuCe,UAAW,GAAE,CAAC,CAAC;IACnF,MAAM,IAAItB,kBAAQ,CAAC,qBAAqB,CAAC;EAC7C;EAEA,IAAI,CAACJ,WAAE,CAACC,UAAU,CAACuB,QAAQ,CAAC,EAAE;IAC1BtB,OAAO,CAACC,KAAK,CAACO,eAAM,CAACoB,GAAG,CAAE,QAAON,QAAS,kBAAiB,CAAC,CAAC;IAC7D,MAAM,IAAIpB,kBAAQ,CAAC,4BAA4B,CAAC;EACpD;;EAEA;EACA,MAAM2B,MAAM,GAAGN,QAAQ,CAACO,MAAM,CAACC,SAAS,CAACC,gBAAgB,CAACC,mBAAmB,CACzEC,cAAG,CAACC,IAAI,CAAC/B,aAAI,CAACgC,OAAO,CAAChC,aAAI,CAACC,IAAI,CAACgC,SAAS,EAAE,QAAQ,EAAEC,8BAAmB,CAAC,CAAC,CAAC,CAC9E;;EAED;EACA,MAAMC,QAAQ,GAAGhB,QAAQ,CAACO,MAAM,CAACC,SAAS,CAACC,gBAAgB,CAACC,mBAAmB,CAACC,cAAG,CAACC,IAAI,CAAC/B,aAAI,CAACgC,OAAO,CAACd,QAAQ,CAAC,CAAC,CAAC;;EAEjH;EACA,MAAMC,QAAQ,CAACO,MAAM,CAACC,SAAS,CAACS,eAAe,CAACC,KAAK,CAAC,CAACZ,MAAM,EAAEU,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;IAC7BhD,OAAO,CAACC,KAAK,CAACO,eAAM,CAACoB,GAAG,CAAC,oBAAoB,CAAC,CAAC;IAC/C,KAAK,MAAMqB,eAAe,IAAIN,gBAAgB,EAAE;MAC5C3C,OAAO,CAACC,KAAK,CACTO,eAAM,CAACoB,GAAG,CACL,QAAOqB,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,IAAIhD,kBAAQ,CAAC,0BAA0B,CAAC;EAClD;EAEA,OAAOqC,QAAQ,CAACiB,WAAW,CAACC,KAAK;AACrC;AAEO,eAAeC,UAAU,CAACC,OAAwE,EAAE;EACvG,MAAMpC,QAAQ,GAAG,IAAAqC,kCAAoB,EAACC,oBAAc,CAAC,CAACC,MAAM;EAC5D,MAAMC,KAAK,GAAG,MAAM1C,YAAY,CAACsC,OAAO,CAACxD,MAAM,EAAEoB,QAAQ,CAAC;EAE1D,MAAMyC,OAAgB,GAAG;IACrB7D,MAAM,EAAE4D,KAAK;IACbE,MAAM,EAAE7D,aAAI,CAAC8D,OAAO,CAACP,OAAO,CAACxD,MAAM;EACvC,CAAC;EAED,IAAI;IACA,MAAM,IAAIgE,0BAAY,EAAE,CAACC,GAAG,CAACJ,OAAO,CAAC;EACzC,CAAC,CAAC,OAAOK,GAAG,EAAE;IACV,IAAIA,GAAG,YAAYC,gBAAW,EAAE;MAC5BtE,OAAO,CAACC,KAAK,CAACO,eAAM,CAACoB,GAAG,CAACyC,GAAG,CAAChB,OAAO,CAAC,CAAC;MACtC,MAAM,IAAInD,kBAAQ,CAACmE,GAAG,CAAChB,OAAO,CAAC;IACnC,CAAC,MAAM;MACH,MAAMgB,GAAG;IACb;EACJ;AACJ"}

package/cli/index.d.ts

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