zenstack 0.6.0-pre.8 → 1.0.0-alpha.100

package/README.md

@@ -1,6 +1,8 @@
 <div align="center">
-    <img src="https://user-images.githubusercontent.com/104139426/204459273-35c65630-9faf-42bb-bd2c-07c1580a0772.png" style="max-width: 512px; width: 100%; height: auto; margin-bottom: 1rem;"
+    <a href="https://zenstack.dev">
+    <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;"
     >
+    </a>
     <div></div>
     <a href="https://www.npmjs.com/package/zenstack">
         <img src="https://img.shields.io/npm/v/zenstack">
@@ -19,29 +21,128 @@
 
 ## What it is
 
-ZenStack is a toolkit for building secure CRUD apps with Next.js + Typescript. It lets you define data models, relations and access policies all in one place, and generates database schema, backend CRUD services and frontend React hooks for you automatically.
+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
 
--   [Documentation](https://zenstack.dev)
+-   [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)
+-   [Blog](https://zenstack.dev/blog)
 
 ## Features
 
--   Intuitive data & authorization modeling language
--   Generating RESTful CRUD services and React hooks
+-   Access control and data validation rules right inside your Prisma schema
+-   Auto-generated OpenAPI (RESTful) specifications, services, and client libraries
 -   End-to-end type safety
--   Support for all major relational databases
--   Integration with authentication libraries (like [NextAuth](https://next-auth.js.org/) and [iron-session](https://www.npmjs.com/package/iron-session))
--   [VSCode extension](https://marketplace.visualstudio.com/items?itemName=zenstack.zenstack) for model authoring
+-   Extensible: custom attributes, functions, and a plugin system
+-   A framework-agnostic core with framework-specific adapters
+-   Uncompromised performance
+
+### Plugins
+
+-   Prisma schema generator
+-   Zod schema generator
+-   React hooks generator
+-   OpenAPI specification generator
+-   [tRPC](https://trpc.io) router generator
+-   🙋🏻 [Request for a plugin](https://go.zenstack.dev/chat)
+
+### Framework adapters
+
+-   [Next.js](https://zenstack.dev/docs/reference/server-adapters/next)
+-   [Fastify](https://zenstack.dev/docs/reference/server-adapters/fastify)
+-   [ExpressJS](https://zenstack.dev/docs/reference/server-adapters/express)
+-   Nuxt.js (Future)
+-   SvelteKit (Future)
+-   🙋🏻 [Request for an adapter](https://go.zenstack.dev/chat)
+
+### Prisma schema extensions
+
+-   [Custom attributes and functions](https://zenstack.dev/docs/reference/zmodel-language#custom-attributes-and-functions)
+-   Multi-file schema (coming soon)
+-   String-typed JSON field (coming soon)
+-   🙋🏻 [Request for an extension](https://go.zenstack.dev/chat)
 
 ## Examples
 
-Check out the [Collaborative Todo App](https://zenstack-todo.vercel.app/) for a running example. You can find the source code [here](https://github.com/zenstackhq/zenstack/tree/main/samples/todo).
+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
 

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,21 @@
+import { Model } from '@zenstackhq/language/ast';
+import { LangiumDocument } from 'langium';
+import { ZModelServices } from '../language-server/zmodel-module';
+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): Promise<Model>;
+export declare function getPluginDocuments(services: ZModelServices, fileName: string): Promise<LangiumDocument[]>;
+export declare function runPlugins(options: {
+    schema: string;
+    packageManager: PackageManagers | undefined;
+}): Promise<void>;
+export declare function dumpInfo(projectPath: string): Promise<void>;

package/cli/cli-util.js

@@ -0,0 +1,239 @@
+"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.dumpInfo = exports.runPlugins = exports.getPluginDocuments = exports.loadDocument = exports.initProject = void 0;
+const ast_1 = require("@zenstackhq/language/ast");
+const sdk_1 = require("@zenstackhq/sdk");
+const colors_1 = __importDefault(require("colors"));
+const fs_1 = __importDefault(require("fs"));
+const get_latest_version_1 = __importDefault(require("get-latest-version"));
+const node_1 = require("langium/node");
+const ora_1 = __importDefault(require("ora"));
+const path_1 = __importDefault(require("path"));
+const semver_1 = __importDefault(require("semver"));
+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 version_utils_1 = require("../utils/version-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);
+        tag = tag !== null && tag !== void 0 ? tag : (0, version_utils_1.getVersion)();
+        (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) {
+    var _a;
+    return __awaiter(this, void 0, void 0, function* () {
+        const services = (0, zmodel_module_1.createZModelServices)(node_1.NodeFileSystem).ZModel;
+        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 documents provided by plugins
+        const pluginDocuments = yield getPluginDocuments(services, fileName);
+        // 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 and plugin modules
+        yield services.shared.workspace.DocumentBuilder.build([stdLib, ...pluginDocuments, 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 getPluginDocuments(services, fileName) {
+    return __awaiter(this, void 0, void 0, function* () {
+        // parse the user document (without validation)
+        const parseResult = services.parser.LangiumParser.parse(fs_1.default.readFileSync(fileName, { encoding: 'utf-8' }));
+        const parsed = parseResult.value;
+        // traverse plugins and collect "plugin.zmodel" documents
+        const result = [];
+        parsed.declarations.forEach((decl) => {
+            if ((0, ast_1.isPlugin)(decl)) {
+                const providerField = decl.fields.find((f) => f.name === 'provider');
+                if (providerField) {
+                    const provider = (0, sdk_1.getLiteral)(providerField.value);
+                    if (provider) {
+                        try {
+                            const pluginEntrance = require.resolve(`${provider}`);
+                            const pluginModelFile = path_1.default.join(path_1.default.dirname(pluginEntrance), constants_1.PLUGIN_MODULE_NAME);
+                            if (fs_1.default.existsSync(pluginModelFile)) {
+                                result.push(services.shared.workspace.LangiumDocuments.getOrCreateDocument(vscode_uri_1.URI.file(pluginModelFile)));
+                            }
+                        }
+                        catch (_a) {
+                            console.warn(`Unable to load plugin from ${provider}, skipping`);
+                        }
+                    }
+                }
+            }
+        });
+        return result;
+    });
+}
+exports.getPluginDocuments = getPluginDocuments;
+function runPlugins(options) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const model = yield loadDocument(options.schema);
+        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;
+function dumpInfo(projectPath) {
+    var _a, _b;
+    return __awaiter(this, void 0, void 0, function* () {
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        let pkgJson;
+        const resolvedPath = path_1.default.resolve(projectPath);
+        try {
+            pkgJson = require(path_1.default.join(resolvedPath, 'package.json'));
+        }
+        catch (_c) {
+            console.error('Unable to locate package.json. Are you in a valid project directory?');
+            return;
+        }
+        const packages = [
+            'zenstack',
+            ...Object.keys((_a = pkgJson.dependencies) !== null && _a !== void 0 ? _a : {}).filter((p) => p.startsWith('@zenstackhq/')),
+            ...Object.keys((_b = pkgJson.devDependencies) !== null && _b !== void 0 ? _b : {}).filter((p) => p.startsWith('@zenstackhq/')),
+        ];
+        const versions = new Set();
+        for (const pkg of packages) {
+            try {
+                const resolved = require.resolve(`${pkg}/package.json`, { paths: [resolvedPath] });
+                // eslint-disable-next-line @typescript-eslint/no-var-requires
+                const version = require(resolved).version;
+                versions.add(version);
+                console.log(`    ${colors_1.default.green(pkg.padEnd(20))}\t${version}`);
+            }
+            catch (_d) {
+                // noop
+            }
+        }
+        if (versions.size > 1) {
+            console.warn(colors_1.default.yellow('WARNING: Multiple versions of Zenstack packages detected. This may cause issues.'));
+        }
+        else if (versions.size > 0) {
+            const spinner = (0, ora_1.default)('Checking npm registry').start();
+            const latest = yield (0, get_latest_version_1.default)('zenstack');
+            if (!latest) {
+                spinner.fail('unable to check for latest version');
+            }
+            else {
+                spinner.succeed();
+                const version = [...versions][0];
+                if (semver_1.default.gt(latest, version)) {
+                    console.log(`A newer version of Zenstack is available: ${latest}.`);
+                }
+                else if (semver_1.default.gt(version, latest)) {
+                    console.log('You are using a pre-release version of Zenstack.');
+                }
+                else {
+                    console.log('You are using the latest version of Zenstack.');
+                }
+            }
+        }
+    });
+}
+exports.dumpInfo = dumpInfo;
+//# 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":";;;;;;;;;;;;;;;AAAA,kDAA2D;AAC3D,yCAA0D;AAC1D,oDAA4B;AAC5B,4CAAoB;AACpB,4EAAkD;AAElD,uCAA8C;AAC9C,8CAAsB;AACtB,gDAAwB;AACxB,oDAA4B;AAC5B,2CAAiC;AACjC,4DAAuF;AACvF,oEAAwF;AAExF,kDAAoF;AACpF,0DAAoD;AACpD,2CAAuC;AACvC,mDAA+C;AAE/C;;GAEG;AACH,SAAsB,WAAW,CAC7B,WAAmB,EACnB,YAAgC,EAChC,cAA2C,EAC3C,GAAY;;QAEZ,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;QAE9E,GAAG,GAAG,GAAG,aAAH,GAAG,cAAH,GAAG,GAAI,IAAA,0BAAU,GAAE,CAAC;QAC1B,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;AA1DD,kCA0DC;AAED;;;;;GAKG;AACH,SAAsB,YAAY,CAAC,QAAgB;;;QAC/C,MAAM,QAAQ,GAAG,IAAA,oCAAoB,EAAC,qBAAc,CAAC,CAAC,MAAM,CAAC;QAC7D,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,qCAAqC;QACrC,MAAM,eAAe,GAAG,MAAM,kBAAkB,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;QAErE,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,uEAAuE;QACvE,MAAM,QAAQ,CAAC,MAAM,CAAC,SAAS,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC,MAAM,EAAE,GAAG,eAAe,EAAE,QAAQ,CAAC,EAAE;YAC1F,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;AA7CD,oCA6CC;AAED,SAAsB,kBAAkB,CAAC,QAAwB,EAAE,QAAgB;;QAC/E,+CAA+C;QAC/C,MAAM,WAAW,GAAG,QAAQ,CAAC,MAAM,CAAC,aAAa,CAAC,KAAK,CAAC,YAAE,CAAC,YAAY,CAAC,QAAQ,EAAE,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC;QAC1G,MAAM,MAAM,GAAG,WAAW,CAAC,KAAc,CAAC;QAE1C,yDAAyD;QACzD,MAAM,MAAM,GAAsB,EAAE,CAAC;QACrC,MAAM,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;YACjC,IAAI,IAAA,cAAQ,EAAC,IAAI,CAAC,EAAE;gBAChB,MAAM,aAAa,GAAG,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,UAAU,CAAC,CAAC;gBACrE,IAAI,aAAa,EAAE;oBACf,MAAM,QAAQ,GAAG,IAAA,gBAAU,EAAS,aAAa,CAAC,KAAK,CAAC,CAAC;oBACzD,IAAI,QAAQ,EAAE;wBACV,IAAI;4BACA,MAAM,cAAc,GAAG,OAAO,CAAC,OAAO,CAAC,GAAG,QAAQ,EAAE,CAAC,CAAC;4BACtD,MAAM,eAAe,GAAG,cAAI,CAAC,IAAI,CAAC,cAAI,CAAC,OAAO,CAAC,cAAc,CAAC,EAAE,8BAAkB,CAAC,CAAC;4BACpF,IAAI,YAAE,CAAC,UAAU,CAAC,eAAe,CAAC,EAAE;gCAChC,MAAM,CAAC,IAAI,CACP,QAAQ,CAAC,MAAM,CAAC,SAAS,CAAC,gBAAgB,CAAC,mBAAmB,CAC1D,gBAAG,CAAC,IAAI,CAAC,eAAe,CAAC,CAC5B,CACJ,CAAC;6BACL;yBACJ;wBAAC,WAAM;4BACJ,OAAO,CAAC,IAAI,CAAC,8BAA8B,QAAQ,YAAY,CAAC,CAAC;yBACpE;qBACJ;iBACJ;aACJ;QACL,CAAC,CAAC,CAAC;QACH,OAAO,MAAM,CAAC;IAClB,CAAC;CAAA;AA/BD,gDA+BC;AAED,SAAsB,UAAU,CAAC,OAAwE;;QACrG,MAAM,KAAK,GAAG,MAAM,YAAY,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QAEjD,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;AAnBD,gCAmBC;AAED,SAAsB,QAAQ,CAAC,WAAmB;;;QAC9C,8DAA8D;QAC9D,IAAI,OAAY,CAAC;QACjB,MAAM,YAAY,GAAG,cAAI,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;QAC/C,IAAI;YACA,OAAO,GAAG,OAAO,CAAC,cAAI,CAAC,IAAI,CAAC,YAAY,EAAE,cAAc,CAAC,CAAC,CAAC;SAC9D;QAAC,WAAM;YACJ,OAAO,CAAC,KAAK,CAAC,sEAAsE,CAAC,CAAC;YACtF,OAAO;SACV;QACD,MAAM,QAAQ,GAAG;YACb,UAAU;YACV,GAAG,MAAM,CAAC,IAAI,CAAC,MAAA,OAAO,CAAC,YAAY,mCAAI,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,UAAU,CAAC,cAAc,CAAC,CAAC;YACtF,GAAG,MAAM,CAAC,IAAI,CAAC,MAAA,OAAO,CAAC,eAAe,mCAAI,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,UAAU,CAAC,cAAc,CAAC,CAAC;SAC5F,CAAC;QAEF,MAAM,QAAQ,GAAG,IAAI,GAAG,EAAU,CAAC;QACnC,KAAK,MAAM,GAAG,IAAI,QAAQ,EAAE;YACxB,IAAI;gBACA,MAAM,QAAQ,GAAG,OAAO,CAAC,OAAO,CAAC,GAAG,GAAG,eAAe,EAAE,EAAE,KAAK,EAAE,CAAC,YAAY,CAAC,EAAE,CAAC,CAAC;gBACnF,8DAA8D;gBAC9D,MAAM,OAAO,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC;gBAC1C,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;gBACtB,OAAO,CAAC,GAAG,CAAC,OAAO,gBAAM,CAAC,KAAK,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,KAAK,OAAO,EAAE,CAAC,CAAC;aAClE;YAAC,WAAM;gBACJ,OAAO;aACV;SACJ;QAED,IAAI,QAAQ,CAAC,IAAI,GAAG,CAAC,EAAE;YACnB,OAAO,CAAC,IAAI,CAAC,gBAAM,CAAC,MAAM,CAAC,kFAAkF,CAAC,CAAC,CAAC;SACnH;aAAM,IAAI,QAAQ,CAAC,IAAI,GAAG,CAAC,EAAE;YAC1B,MAAM,OAAO,GAAG,IAAA,aAAG,EAAC,uBAAuB,CAAC,CAAC,KAAK,EAAE,CAAC;YACrD,MAAM,MAAM,GAAG,MAAM,IAAA,4BAAgB,EAAC,UAAU,CAAC,CAAC;YAElD,IAAI,CAAC,MAAM,EAAE;gBACT,OAAO,CAAC,IAAI,CAAC,oCAAoC,CAAC,CAAC;aACtD;iBAAM;gBACH,OAAO,CAAC,OAAO,EAAE,CAAC;gBAClB,MAAM,OAAO,GAAG,CAAC,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;gBACjC,IAAI,gBAAM,CAAC,EAAE,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE;oBAC5B,OAAO,CAAC,GAAG,CAAC,6CAA6C,MAAM,GAAG,CAAC,CAAC;iBACvE;qBAAM,IAAI,gBAAM,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,CAAC,EAAE;oBACnC,OAAO,CAAC,GAAG,CAAC,kDAAkD,CAAC,CAAC;iBACnE;qBAAM;oBACH,OAAO,CAAC,GAAG,CAAC,+CAA+C,CAAC,CAAC;iBAChE;aACJ;SACJ;;CACJ;AAjDD,4BAiDC"}

package/cli/config.d.ts

@@ -0,0 +1,19 @@
+import z from 'zod';
+declare const schema: z.ZodObject<{
+    guardFieldName: z.ZodDefault<z.ZodString>;
+    transactionFieldName: z.ZodDefault<z.ZodString>;
+}, "strict", z.ZodTypeAny, {
+    guardFieldName: string;
+    transactionFieldName: string;
+}, {
+    guardFieldName?: string | undefined;
+    transactionFieldName?: string | undefined;
+}>;
+export declare type ConfigType = z.infer<typeof schema>;
+export declare let config: ConfigType;
+/**
+ * Loads and validates CLI configuration file.
+ * @returns
+ */
+export declare function loadConfig(filename: string): void;
+export {};

package/cli/config.js

@@ -0,0 +1,41 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.loadConfig = exports.config = void 0;
+const sdk_1 = require("@zenstackhq/sdk");
+const fs_1 = __importDefault(require("fs"));
+const zod_1 = __importDefault(require("zod"));
+const zod_validation_error_1 = require("zod-validation-error");
+const cli_error_1 = require("./cli-error");
+const schema = zod_1.default
+    .object({
+    guardFieldName: zod_1.default.string().default(sdk_1.GUARD_FIELD_NAME),
+    transactionFieldName: zod_1.default.string().default(sdk_1.TRANSACTION_FIELD_NAME),
+})
+    .strict();
+exports.config = schema.parse({});
+/**
+ * Loads and validates CLI configuration file.
+ * @returns
+ */
+function loadConfig(filename) {
+    if (!fs_1.default.existsSync(filename)) {
+        return;
+    }
+    let content;
+    try {
+        content = JSON.parse(fs_1.default.readFileSync(filename, 'utf-8'));
+    }
+    catch (_a) {
+        throw new cli_error_1.CliError(`Config is not a valid JSON file: ${filename}`);
+    }
+    const parsed = schema.safeParse(content);
+    if (!parsed.success) {
+        throw new cli_error_1.CliError(`Config file ${filename} is not valid: ${(0, zod_validation_error_1.fromZodError)(parsed.error)}`);
+    }
+    exports.config = parsed.data;
+}
+exports.loadConfig = loadConfig;
+//# sourceMappingURL=config.js.map

package/cli/config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.js","sourceRoot":"","sources":["../../src/cli/config.ts"],"names":[],"mappings":";;;;;;AAAA,yCAA2E;AAC3E,4CAAoB;AACpB,8CAAoB;AACpB,+DAAoD;AACpD,2CAAuC;AAEvC,MAAM,MAAM,GAAG,aAAC;KACX,MAAM,CAAC;IACJ,cAAc,EAAE,aAAC,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC,sBAAgB,CAAC;IACpD,oBAAoB,EAAE,aAAC,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC,4BAAsB,CAAC;CACnE,CAAC;KACD,MAAM,EAAE,CAAC;AAIH,QAAA,MAAM,GAAe,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;AAEjD;;;GAGG;AACH,SAAgB,UAAU,CAAC,QAAgB;IACvC,IAAI,CAAC,YAAE,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE;QAC1B,OAAO;KACV;IAED,IAAI,OAAgB,CAAC;IACrB,IAAI;QACA,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,YAAE,CAAC,YAAY,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC,CAAC;KAC5D;IAAC,WAAM;QACJ,MAAM,IAAI,oBAAQ,CAAC,oCAAoC,QAAQ,EAAE,CAAC,CAAC;KACtE;IAED,MAAM,MAAM,GAAG,MAAM,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;IACzC,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE;QACjB,MAAM,IAAI,oBAAQ,CAAC,eAAe,QAAQ,kBAAkB,IAAA,mCAAY,EAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;KAC7F;IAED,cAAM,GAAG,MAAM,CAAC,IAAI,CAAC;AACzB,CAAC;AAlBD,gCAkBC"}

package/cli/index.d.ts

@@ -0,0 +1,16 @@
+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 infoAction: (projectPath: 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>;