zenstack 1.0.0 → 1.0.16

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2022 zenstack-hq
+Copyright (c) 2022 ZenStack
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -1 +1,126 @@
-<h1>ZenStack</h1>
+<div align="center">
+    <img src="https://user-images.githubusercontent.com/104139426/214809937-4ed30485-a683-4fea-b737-928c48e86fd7.png" style="max-width: 512px; width: 100%; height: auto; margin-bottom: 1rem;"
+    >
+    <div></div>
+    <a href="https://www.npmjs.com/package/zenstack">
+        <img src="https://img.shields.io/npm/v/zenstack">
+    </a>
+    <img src="https://github.com/zenstackhq/zenstack/actions/workflows/build-test.yml/badge.svg">
+    <a href="https://twitter.com/zenstackhq">
+        <img src="https://img.shields.io/twitter/url?style=social&url=https%3A%2F%2Fgithub.com%2Fzenstackhq%2Fzenstack">
+    </a>
+    <a href="https://go.zenstack.dev/chat">
+        <img src="https://img.shields.io/discord/1035538056146595961">
+    </a>
+    <a href="https://github.com/zenstackhq/zenstack/blob/main/LICENSE">
+        <img src="https://img.shields.io/badge/license-MIT-green">
+    </a>
+</div>
+
+## What it is
+
+ZenStack is a toolkit that simplifies the development of a web app's backend. It supercharges [Prisma ORM](https://prisma.io) with a powerful access control layer and unleashes its full potential for web development.
+
+Our goal is to let you save time writing boilerplate code and focus on building real features!
+
+## How it works
+
+ZenStack extended Prisma schema language for supporting custom attributes and functions and, based on that, implemented a flexible access control layer around Prisma.
+
+```prisma
+// schema.zmodel
+
+model Post {
+    id String @id
+    title String
+    published Boolean @default(false)
+    author User @relation(fields: [authorId], references: [id])
+    authorId String
+
+    // 🔐 allow logged-in users to read published posts
+    @@allow('read', auth() != null && published)
+
+    // 🔐 allow full CRUD by author
+    @@allow('all', author == auth())
+}
+```
+
+At runtime, transparent proxies are created around Prisma clients for intercepting queries and mutations to enforce access policies. Moreover, framework integration packages help you wrap an access-control-enabled Prisma client into backend APIs that can be safely called from the frontend.
+
+```ts
+// Next.js example: pages/api/model/[...path].ts
+
+import { requestHandler } from '@zenstackhq/next';
+import { withPolicy } from '@zenstackhq/runtime';
+import { getSessionUser } from '@lib/auth';
+import { prisma } from '@lib/db';
+
+export default requestHandler({
+    getPrisma: (req, res) => withPolicy(prisma, { user: getSessionUser(req, res) }),
+});
+```
+
+Plugins can generate strong-typed client libraries that talk to the APIs:
+
+```tsx
+// React example: components/MyPosts.tsx
+
+import { usePost } from '@lib/hooks';
+
+const MyPosts = () => {
+    // Post CRUD hooks
+    const { findMany } = usePost();
+
+    // list all posts that're visible to the current user, together with their authors
+    const { data: posts } = findMany({
+        include: { author: true },
+        orderBy: { createdAt: 'desc' },
+    });
+
+    return (
+        <ul>
+            {posts?.map((post) => (
+                <li key={post.id}>
+                    {post.title} by {post.author.name}
+                </li>
+            ))}
+        </ul>
+    );
+};
+```
+
+The following diagram gives a high-level overview of how it works.
+
+![Architecture](https://zenstack.dev/img/architecture-light.png)
+
+## Links
+
+-   [Home](https://zenstack.dev)
+-   [Documentation](https://zenstack.dev/docs)
+-   [Community chat](https://go.zenstack.dev/chat)
+-   [Twitter](https://twitter.com/zenstackhq)
+-   [Blog](https://dev.to/zenstack)
+
+## Features
+
+-   Access control and data validation rules right inside your Prisma schema
+-   Auto-generated RESTful API and client library
+-   End-to-end type safety
+-   Extensible: custom attributes, functions, and a plugin system
+-   Framework agnostic
+-   Uncompromised performance
+
+## Examples
+
+Check out the [Collaborative Todo App](https://zenstack-todo.vercel.app/) for a running example. You can find the source code below:
+
+-   [Next.js + React hooks implementation](https://github.com/zenstackhq/sample-todo-nextjs)
+-   [Next.js + tRPC implementation](https://github.com/zenstackhq/sample-todo-trpc)
+
+## Community
+
+Join our [discord server](https://go.zenstack.dev/chat) for chat and updates!
+
+## License
+
+[MIT](LICENSE)

package/bin/cli

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+
+require('../cli').default();

package/bin/post-install.js

@@ -0,0 +1,24 @@
+try {
+    if (process.env.DO_NOT_TRACK == '1') {
+        process.exit(0);
+    }
+
+    const Mixpanel = require('mixpanel');
+    const machineId = require('node-machine-id');
+    const os = require('os');
+
+    const mixpanel = Mixpanel.init('', {
+        geolocate: true,
+    });
+
+    const version = require('../package.json').version;
+    const payload = {
+        distinct_id: machineId.machineIdSync(),
+        nodeVersion: process.version,
+        time: new Date(),
+        $os: os.platform(),
+        version,
+    };
+
+    mixpanel.track('npm:install', payload);
+} catch {}

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,10 @@
+"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","sourceRoot":"","sources":["../../src/cli/cli-error.ts"],"names":[],"mappings":";;;AAAA;;GAEG;AACH,MAAa,QAAS,SAAQ,KAAK;CAAG;AAAtC,4BAAsC"}

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,143 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.runPlugins = exports.loadDocument = exports.initProject = void 0;
+const sdk_1 = require("@zenstackhq/sdk");
+const colors_1 = __importDefault(require("colors"));
+const fs_1 = __importDefault(require("fs"));
+const node_1 = require("langium/node");
+const path_1 = __importDefault(require("path"));
+const vscode_uri_1 = require("vscode-uri");
+const constants_1 = require("../language-server/constants");
+const zmodel_module_1 = require("../language-server/zmodel-module");
+const pkg_utils_1 = require("../utils/pkg-utils");
+const cli_error_1 = require("./cli-error");
+const plugin_runner_1 = require("./plugin-runner");
+/**
+ * Initializes an existing project for ZenStack
+ */
+function initProject(projectPath, prismaSchema, packageManager, tag) {
+    return __awaiter(this, void 0, void 0, function* () {
+        if (!fs_1.default.existsSync(projectPath)) {
+            console.error(`Path does not exist: ${projectPath}`);
+            throw new cli_error_1.CliError('project path does not exist');
+        }
+        const defaultPrismaSchemaLocation = './prisma/schema.prisma';
+        if (prismaSchema) {
+            if (!fs_1.default.existsSync(prismaSchema)) {
+                console.error(`Prisma schema file does not exist: ${prismaSchema}`);
+                throw new cli_error_1.CliError('prisma schema does not exist');
+            }
+        }
+        else if (fs_1.default.existsSync(defaultPrismaSchemaLocation)) {
+            prismaSchema = defaultPrismaSchemaLocation;
+        }
+        const zmodelFile = path_1.default.join(projectPath, './schema.zmodel');
+        let sampleModelGenerated = false;
+        if (fs_1.default.existsSync(zmodelFile)) {
+            console.warn(`ZenStack model already exists at ${zmodelFile}, not generating a new one.`);
+        }
+        else {
+            if (prismaSchema) {
+                // copy over schema.prisma
+                fs_1.default.copyFileSync(prismaSchema, zmodelFile);
+            }
+            else {
+                // create a new model
+                const starterContent = fs_1.default.readFileSync(path_1.default.join(__dirname, '../res/starter.zmodel'), 'utf-8');
+                fs_1.default.writeFileSync(zmodelFile, starterContent);
+                sampleModelGenerated = true;
+            }
+        }
+        (0, pkg_utils_1.ensurePackage)('prisma', true, packageManager, 'latest', projectPath);
+        (0, pkg_utils_1.ensurePackage)('@prisma/client', false, packageManager, 'latest', projectPath);
+        (0, pkg_utils_1.installPackage)('zenstack', true, packageManager, tag, projectPath);
+        (0, pkg_utils_1.installPackage)('@zenstackhq/runtime', false, packageManager, tag, projectPath);
+        if (sampleModelGenerated) {
+            console.log(`Sample model generated at: ${colors_1.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_1.default.green('\nProject initialized successfully!'));
+    });
+}
+exports.initProject = initProject;
+/**
+ * Loads a zmodel document from a file.
+ * @param fileName File name
+ * @param services Language services
+ * @returns Parsed and validated AST
+ */
+function loadDocument(fileName, services) {
+    var _a;
+    return __awaiter(this, void 0, void 0, function* () {
+        const extensions = services.LanguageMetaData.fileExtensions;
+        if (!extensions.includes(path_1.default.extname(fileName))) {
+            console.error(colors_1.default.yellow(`Please choose a file with extension: ${extensions}.`));
+            throw new cli_error_1.CliError('invalid schema file');
+        }
+        if (!fs_1.default.existsSync(fileName)) {
+            console.error(colors_1.default.red(`File ${fileName} does not exist.`));
+            throw new cli_error_1.CliError('schema file does not exist');
+        }
+        // load standard library
+        const stdLib = services.shared.workspace.LangiumDocuments.getOrCreateDocument(vscode_uri_1.URI.file(path_1.default.resolve(path_1.default.join(__dirname, '../res', constants_1.STD_LIB_MODULE_NAME))));
+        // load the document
+        const document = services.shared.workspace.LangiumDocuments.getOrCreateDocument(vscode_uri_1.URI.file(path_1.default.resolve(fileName)));
+        // build the document together with standard library
+        yield services.shared.workspace.DocumentBuilder.build([stdLib, document], {
+            validationChecks: 'all',
+        });
+        const validationErrors = ((_a = document.diagnostics) !== null && _a !== void 0 ? _a : []).filter((e) => e.severity === 1);
+        if (validationErrors.length > 0) {
+            console.error(colors_1.default.red('Validation errors:'));
+            for (const validationError of validationErrors) {
+                console.error(colors_1.default.red(`line ${validationError.range.start.line + 1}: ${validationError.message} [${document.textDocument.getText(validationError.range)}]`));
+            }
+            throw new cli_error_1.CliError('schema validation errors');
+        }
+        return document.parseResult.value;
+    });
+}
+exports.loadDocument = loadDocument;
+function runPlugins(options) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const services = (0, zmodel_module_1.createZModelServices)(node_1.NodeFileSystem).ZModel;
+        const model = yield loadDocument(options.schema, services);
+        const context = {
+            schema: model,
+            schemaPath: path_1.default.resolve(options.schema),
+            outDir: path_1.default.dirname(options.schema),
+        };
+        try {
+            yield new plugin_runner_1.PluginRunner().run(context);
+        }
+        catch (err) {
+            if (err instanceof sdk_1.PluginError) {
+                console.error(colors_1.default.red(err.message));
+                throw new cli_error_1.CliError(err.message);
+            }
+            else {
+                throw err;
+            }
+        }
+    });
+}
+exports.runPlugins = runPlugins;
+//# sourceMappingURL=cli-util.js.map

package/cli/cli-util.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli-util.js","sourceRoot":"","sources":["../../src/cli/cli-util.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AACA,yCAA8C;AAC9C,oDAA4B;AAC5B,4CAAoB;AAEpB,uCAA8C;AAC9C,gDAAwB;AACxB,2CAAiC;AACjC,4DAAmE;AACnE,oEAAwE;AAExE,kDAAoF;AACpF,2CAAuC;AACvC,mDAA+C;AAE/C;;GAEG;AACH,SAAsB,WAAW,CAC7B,WAAmB,EACnB,YAAgC,EAChC,cAA2C,EAC3C,GAAW;;QAEX,IAAI,CAAC,YAAE,CAAC,UAAU,CAAC,WAAW,CAAC,EAAE;YAC7B,OAAO,CAAC,KAAK,CAAC,wBAAwB,WAAW,EAAE,CAAC,CAAC;YACrD,MAAM,IAAI,oBAAQ,CAAC,6BAA6B,CAAC,CAAC;SACrD;QAED,MAAM,2BAA2B,GAAG,wBAAwB,CAAC;QAC7D,IAAI,YAAY,EAAE;YACd,IAAI,CAAC,YAAE,CAAC,UAAU,CAAC,YAAY,CAAC,EAAE;gBAC9B,OAAO,CAAC,KAAK,CAAC,sCAAsC,YAAY,EAAE,CAAC,CAAC;gBACpE,MAAM,IAAI,oBAAQ,CAAC,8BAA8B,CAAC,CAAC;aACtD;SACJ;aAAM,IAAI,YAAE,CAAC,UAAU,CAAC,2BAA2B,CAAC,EAAE;YACnD,YAAY,GAAG,2BAA2B,CAAC;SAC9C;QAED,MAAM,UAAU,GAAG,cAAI,CAAC,IAAI,CAAC,WAAW,EAAE,iBAAiB,CAAC,CAAC;QAC7D,IAAI,oBAAoB,GAAG,KAAK,CAAC;QAEjC,IAAI,YAAE,CAAC,UAAU,CAAC,UAAU,CAAC,EAAE;YAC3B,OAAO,CAAC,IAAI,CAAC,oCAAoC,UAAU,6BAA6B,CAAC,CAAC;SAC7F;aAAM;YACH,IAAI,YAAY,EAAE;gBACd,0BAA0B;gBAC1B,YAAE,CAAC,YAAY,CAAC,YAAY,EAAE,UAAU,CAAC,CAAC;aAC7C;iBAAM;gBACH,qBAAqB;gBACrB,MAAM,cAAc,GAAG,YAAE,CAAC,YAAY,CAAC,cAAI,CAAC,IAAI,CAAC,SAAS,EAAE,uBAAuB,CAAC,EAAE,OAAO,CAAC,CAAC;gBAC/F,YAAE,CAAC,aAAa,CAAC,UAAU,EAAE,cAAc,CAAC,CAAC;gBAC7C,oBAAoB,GAAG,IAAI,CAAC;aAC/B;SACJ;QAED,IAAA,yBAAa,EAAC,QAAQ,EAAE,IAAI,EAAE,cAAc,EAAE,QAAQ,EAAE,WAAW,CAAC,CAAC;QACrE,IAAA,yBAAa,EAAC,gBAAgB,EAAE,KAAK,EAAE,cAAc,EAAE,QAAQ,EAAE,WAAW,CAAC,CAAC;QAC9E,IAAA,0BAAc,EAAC,UAAU,EAAE,IAAI,EAAE,cAAc,EAAE,GAAG,EAAE,WAAW,CAAC,CAAC;QACnE,IAAA,0BAAc,EAAC,qBAAqB,EAAE,KAAK,EAAE,cAAc,EAAE,GAAG,EAAE,WAAW,CAAC,CAAC;QAE/E,IAAI,oBAAoB,EAAE;YACtB,OAAO,CAAC,GAAG,CAAC,8BAA8B,gBAAM,CAAC,IAAI,CAAC,UAAU,CAAC;;;8CAG3B,CAAC,CAAC;SAC3C;aAAM;YACH,OAAO,CAAC,GAAG,CACP,+BAA+B,YAAY,yBAAyB,UAAU;8FACI,CACrF,CAAC;SACL;QAED,OAAO,CAAC,GAAG,CAAC,gBAAM,CAAC,KAAK,CAAC,qCAAqC,CAAC,CAAC,CAAC;IACrE,CAAC;CAAA;AAxDD,kCAwDC;AAED;;;;;GAKG;AACH,SAAsB,YAAY,CAAC,QAAgB,EAAE,QAAyB;;;QAC1E,MAAM,UAAU,GAAG,QAAQ,CAAC,gBAAgB,CAAC,cAAc,CAAC;QAC5D,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,cAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,EAAE;YAC9C,OAAO,CAAC,KAAK,CAAC,gBAAM,CAAC,MAAM,CAAC,wCAAwC,UAAU,GAAG,CAAC,CAAC,CAAC;YACpF,MAAM,IAAI,oBAAQ,CAAC,qBAAqB,CAAC,CAAC;SAC7C;QAED,IAAI,CAAC,YAAE,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE;YAC1B,OAAO,CAAC,KAAK,CAAC,gBAAM,CAAC,GAAG,CAAC,QAAQ,QAAQ,kBAAkB,CAAC,CAAC,CAAC;YAC9D,MAAM,IAAI,oBAAQ,CAAC,4BAA4B,CAAC,CAAC;SACpD;QAED,wBAAwB;QACxB,MAAM,MAAM,GAAG,QAAQ,CAAC,MAAM,CAAC,SAAS,CAAC,gBAAgB,CAAC,mBAAmB,CACzE,gBAAG,CAAC,IAAI,CAAC,cAAI,CAAC,OAAO,CAAC,cAAI,CAAC,IAAI,CAAC,SAAS,EAAE,QAAQ,EAAE,+BAAmB,CAAC,CAAC,CAAC,CAC9E,CAAC;QAEF,oBAAoB;QACpB,MAAM,QAAQ,GAAG,QAAQ,CAAC,MAAM,CAAC,SAAS,CAAC,gBAAgB,CAAC,mBAAmB,CAAC,gBAAG,CAAC,IAAI,CAAC,cAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;QAElH,oDAAoD;QACpD,MAAM,QAAQ,CAAC,MAAM,CAAC,SAAS,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC,MAAM,EAAE,QAAQ,CAAC,EAAE;YACtE,gBAAgB,EAAE,KAAK;SAC1B,CAAC,CAAC;QAEH,MAAM,gBAAgB,GAAG,CAAC,MAAA,QAAQ,CAAC,WAAW,mCAAI,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,KAAK,CAAC,CAAC,CAAC;QACtF,IAAI,gBAAgB,CAAC,MAAM,GAAG,CAAC,EAAE;YAC7B,OAAO,CAAC,KAAK,CAAC,gBAAM,CAAC,GAAG,CAAC,oBAAoB,CAAC,CAAC,CAAC;YAChD,KAAK,MAAM,eAAe,IAAI,gBAAgB,EAAE;gBAC5C,OAAO,CAAC,KAAK,CACT,gBAAM,CAAC,GAAG,CACN,QAAQ,eAAe,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,GAAG,CAAC,KACxC,eAAe,CAAC,OACpB,KAAK,QAAQ,CAAC,YAAY,CAAC,OAAO,CAAC,eAAe,CAAC,KAAK,CAAC,GAAG,CAC/D,CACJ,CAAC;aACL;YACD,MAAM,IAAI,oBAAQ,CAAC,0BAA0B,CAAC,CAAC;SAClD;QAED,OAAO,QAAQ,CAAC,WAAW,CAAC,KAAc,CAAC;;CAC9C;AAzCD,oCAyCC;AAED,SAAsB,UAAU,CAAC,OAAwE;;QACrG,MAAM,QAAQ,GAAG,IAAA,oCAAoB,EAAC,qBAAc,CAAC,CAAC,MAAM,CAAC;QAC7D,MAAM,KAAK,GAAG,MAAM,YAAY,CAAC,OAAO,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;QAE3D,MAAM,OAAO,GAAY;YACrB,MAAM,EAAE,KAAK;YACb,UAAU,EAAE,cAAI,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC;YACxC,MAAM,EAAE,cAAI,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC;SACvC,CAAC;QAEF,IAAI;YACA,MAAM,IAAI,4BAAY,EAAE,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;SACzC;QAAC,OAAO,GAAG,EAAE;YACV,IAAI,GAAG,YAAY,iBAAW,EAAE;gBAC5B,OAAO,CAAC,KAAK,CAAC,gBAAM,CAAC,GAAG,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC;gBACvC,MAAM,IAAI,oBAAQ,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;aACnC;iBAAM;gBACH,MAAM,GAAG,CAAC;aACb;SACJ;IACL,CAAC;CAAA;AApBD,gCAoBC"}

package/cli/index.d.ts

@@ -0,0 +1,15 @@
+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;
+    dependencyCheck: boolean;
+}) => Promise<void>;
+export declare function createProgram(): Command;
+export default function (): Promise<void>;

package/cli/index.js

@@ -0,0 +1,121 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createProgram = exports.generateAction = exports.initAction = exports.requiredPrismaVersion = void 0;
+/* eslint-disable @typescript-eslint/no-explicit-any */
+const module_1 = require("@zenstackhq/language/module");
+const colors_1 = __importDefault(require("colors"));
+const commander_1 = require("commander");
+const semver = __importStar(require("semver"));
+const telemetry_1 = __importDefault(require("../telemetry"));
+const version_utils_1 = require("../utils/version-utils");
+const cli_error_1 = require("./cli-error");
+const cli_util_1 = require("./cli-util");
+// required minimal version of Prisma
+exports.requiredPrismaVersion = '4.0.0';
+const initAction = (projectPath, options) => __awaiter(void 0, void 0, void 0, function* () {
+    yield telemetry_1.default.trackSpan('cli:command:start', 'cli:command:complete', 'cli:command:error', { command: 'init' }, () => (0, cli_util_1.initProject)(projectPath, options.prisma, options.packageManager, options.tag));
+});
+exports.initAction = initAction;
+const generateAction = (options) => __awaiter(void 0, void 0, void 0, function* () {
+    if (options.dependencyCheck) {
+        checkRequiredPackage('prisma', exports.requiredPrismaVersion);
+        checkRequiredPackage('@prisma/client', exports.requiredPrismaVersion);
+    }
+    yield telemetry_1.default.trackSpan('cli:command:start', 'cli:command:complete', 'cli:command:error', { command: 'generate' }, () => (0, cli_util_1.runPlugins)(options));
+});
+exports.generateAction = generateAction;
+const checkRequiredPackage = (packageName, minVersion) => {
+    let packageVersion;
+    try {
+        // eslint-disable-next-line @typescript-eslint/no-var-requires
+        packageVersion = require(`${packageName}/package.json`).version;
+    }
+    catch (error) {
+        console.error(colors_1.default.red(`${packageName} not found, please install it`));
+        throw new cli_error_1.CliError(`${packageName} not found`);
+    }
+    if (minVersion && semver.lt(packageVersion, minVersion)) {
+        console.error(colors_1.default.red(`${packageName} needs to be above ${minVersion}, the installed version is ${packageVersion}, please upgrade it`));
+        throw new cli_error_1.CliError(`${packageName} version is too low`);
+    }
+};
+function createProgram() {
+    const program = new commander_1.Command('zenstack');
+    program.version((0, version_utils_1.getVersion)(), '-v --version', 'display CLI version');
+    const schemaExtensions = module_1.ZModelLanguageMetaData.fileExtensions.join(', ');
+    program
+        .description(`${colors_1.default.bold.blue('ζ')} ZenStack is a Prisma power pack for building full-stack apps.\n\nDocumentation: https://zenstack.dev.`)
+        .showHelpAfterError()
+        .showSuggestionAfterError();
+    const schemaOption = new commander_1.Option('--schema <file>', `schema file (with extension ${schemaExtensions})`).default('./schema.zmodel');
+    const pmOption = new commander_1.Option('-p, --package-manager <pm>', 'package manager to use').choices([
+        'npm',
+        'yarn',
+        'pnpm',
+    ]);
+    const noDependencyCheck = new commander_1.Option('--no-dependency-check', 'do not check if dependencies are installed');
+    program
+        .command('init')
+        .description('Initialize an existing project for ZenStack.')
+        .addOption(pmOption)
+        .addOption(new commander_1.Option('--prisma <file>', 'location of Prisma schema file to bootstrap from'))
+        .addOption(new commander_1.Option('--tag <tag>', 'the NPM package tag to use when installing dependencies').default('latest'))
+        .argument('[path]', 'project path', '.')
+        .action(exports.initAction);
+    program
+        .command('generate')
+        .description('Run code generation.')
+        .addOption(schemaOption)
+        .addOption(pmOption)
+        .addOption(noDependencyCheck)
+        .action(exports.generateAction);
+    return program;
+}
+exports.createProgram = createProgram;
+function default_1() {
+    return __awaiter(this, void 0, void 0, function* () {
+        yield telemetry_1.default.trackSpan('cli:start', 'cli:complete', 'cli:error', { args: process.argv }, () => __awaiter(this, void 0, void 0, function* () {
+            const program = createProgram();
+            // handle errors explicitly to ensure telemetry
+            program.exitOverride();
+            yield program.parseAsync(process.argv);
+        }));
+    });
+}
+exports.default = default_1;
+//# sourceMappingURL=index.js.map

package/cli/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/cli/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,uDAAuD;AACvD,wDAAqE;AACrE,oDAA4B;AAC5B,yCAA4C;AAC5C,+CAAiC;AACjC,6DAAqC;AAErC,0DAAoD;AACpD,2CAAuC;AACvC,yCAAqD;AAErD,qCAAqC;AACxB,QAAA,qBAAqB,GAAG,OAAO,CAAC;AAEtC,MAAM,UAAU,GAAG,CACtB,WAAmB,EACnB,OAIC,EACY,EAAE;IACf,MAAM,mBAAS,CAAC,SAAS,CACrB,mBAAmB,EACnB,sBAAsB,EACtB,mBAAmB,EACnB,EAAE,OAAO,EAAE,MAAM,EAAE,EACnB,GAAG,EAAE,CAAC,IAAA,sBAAW,EAAC,WAAW,EAAE,OAAO,CAAC,MAAM,EAAE,OAAO,CAAC,cAAc,EAAE,OAAO,CAAC,GAAG,CAAC,CACtF,CAAC;AACN,CAAC,CAAA,CAAC;AAfW,QAAA,UAAU,cAerB;AAEK,MAAM,cAAc,GAAG,CAAO,OAIpC,EAAiB,EAAE;IAChB,IAAI,OAAO,CAAC,eAAe,EAAE;QACzB,oBAAoB,CAAC,QAAQ,EAAE,6BAAqB,CAAC,CAAC;QACtD,oBAAoB,CAAC,gBAAgB,EAAE,6BAAqB,CAAC,CAAC;KACjE;IACD,MAAM,mBAAS,CAAC,SAAS,CACrB,mBAAmB,EACnB,sBAAsB,EACtB,mBAAmB,EACnB,EAAE,OAAO,EAAE,UAAU,EAAE,EACvB,GAAG,EAAE,CAAC,IAAA,qBAAU,EAAC,OAAO,CAAC,CAC5B,CAAC;AACN,CAAC,CAAA,CAAC;AAhBW,QAAA,cAAc,kBAgBzB;AAEF,MAAM,oBAAoB,GAAG,CAAC,WAAmB,EAAE,UAAmB,EAAE,EAAE;IACtE,IAAI,cAAsB,CAAC;IAC3B,IAAI;QACA,8DAA8D;QAC9D,cAAc,GAAG,OAAO,CAAC,GAAG,WAAW,eAAe,CAAC,CAAC,OAAO,CAAC;KACnE;IAAC,OAAO,KAAK,EAAE;QACZ,OAAO,CAAC,KAAK,CAAC,gBAAM,CAAC,GAAG,CAAC,GAAG,WAAW,+BAA+B,CAAC,CAAC,CAAC;QACzE,MAAM,IAAI,oBAAQ,CAAC,GAAG,WAAW,YAAY,CAAC,CAAC;KAClD;IAED,IAAI,UAAU,IAAI,MAAM,CAAC,EAAE,CAAC,cAAc,EAAE,UAAU,CAAC,EAAE;QACrD,OAAO,CAAC,KAAK,CACT,gBAAM,CAAC,GAAG,CACN,GAAG,WAAW,sBAAsB,UAAU,8BAA8B,cAAc,qBAAqB,CAClH,CACJ,CAAC;QACF,MAAM,IAAI,oBAAQ,CAAC,GAAG,WAAW,qBAAqB,CAAC,CAAC;KAC3D;AACL,CAAC,CAAC;AAEF,SAAgB,aAAa;IACzB,MAAM,OAAO,GAAG,IAAI,mBAAO,CAAC,UAAU,CAAC,CAAC;IAExC,OAAO,CAAC,OAAO,CAAC,IAAA,0BAAU,GAAE,EAAE,cAAc,EAAE,qBAAqB,CAAC,CAAC;IAErE,MAAM,gBAAgB,GAAG,+BAAsB,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAE1E,OAAO;SACF,WAAW,CACR,GAAG,gBAAM,CAAC,IAAI,CAAC,IAAI,CACf,GAAG,CACN,wGAAwG,CAC5G;SACA,kBAAkB,EAAE;SACpB,wBAAwB,EAAE,CAAC;IAEhC,MAAM,YAAY,GAAG,IAAI,kBAAM,CAAC,iBAAiB,EAAE,+BAA+B,gBAAgB,GAAG,CAAC,CAAC,OAAO,CAC1G,iBAAiB,CACpB,CAAC;IAEF,MAAM,QAAQ,GAAG,IAAI,kBAAM,CAAC,4BAA4B,EAAE,wBAAwB,CAAC,CAAC,OAAO,CAAC;QACxF,KAAK;QACL,MAAM;QACN,MAAM;KACT,CAAC,CAAC;IAEH,MAAM,iBAAiB,GAAG,IAAI,kBAAM,CAAC,uBAAuB,EAAE,4CAA4C,CAAC,CAAC;IAE5G,OAAO;SACF,OAAO,CAAC,MAAM,CAAC;SACf,WAAW,CAAC,8CAA8C,CAAC;SAC3D,SAAS,CAAC,QAAQ,CAAC;SACnB,SAAS,CAAC,IAAI,kBAAM,CAAC,iBAAiB,EAAE,kDAAkD,CAAC,CAAC;SAC5F,SAAS,CACN,IAAI,kBAAM,CAAC,aAAa,EAAE,yDAAyD,CAAC,CAAC,OAAO,CACxF,mBAAmB,CACtB,CACJ;SACA,QAAQ,CAAC,QAAQ,EAAE,cAAc,EAAE,GAAG,CAAC;SACvC,MAAM,CAAC,kBAAU,CAAC,CAAC;IAExB,OAAO;SACF,OAAO,CAAC,UAAU,CAAC;SACnB,WAAW,CAAC,sBAAsB,CAAC;SACnC,SAAS,CAAC,YAAY,CAAC;SACvB,SAAS,CAAC,QAAQ,CAAC;SACnB,SAAS,CAAC,iBAAiB,CAAC;SAC5B,MAAM,CAAC,sBAAc,CAAC,CAAC;IAC5B,OAAO,OAAO,CAAC;AACnB,CAAC;AAjDD,sCAiDC;AAED;;QACI,MAAM,mBAAS,CAAC,SAAS,CAAC,WAAW,EAAE,cAAc,EAAE,WAAW,EAAE,EAAE,IAAI,EAAE,OAAO,CAAC,IAAI,EAAE,EAAE,GAAS,EAAE;YACnG,MAAM,OAAO,GAAG,aAAa,EAAE,CAAC;YAEhC,+CAA+C;YAC/C,OAAO,CAAC,YAAY,EAAE,CAAC;YAEvB,MAAM,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAC3C,CAAC,CAAA,CAAC,CAAC;IACP,CAAC;CAAA;AATD,4BASC"}

package/cli/plugin-runner.d.ts

@@ -0,0 +1,14 @@
+import { Context } from '../types';
+/**
+ * ZenStack code generator
+ */
+export declare class PluginRunner {
+    /**
+     * Runs a series of nested generators
+     */
+    run(context: Context): Promise<void>;
+    private getPluginName;
+    private getPluginProvider;
+    private runPlugin;
+    private getPluginModulePath;
+}