zenstack 1.0.16 → 1.1.1

package/README.md

@@ -1,7 +1,11 @@
 <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://zenstack.dev">
+    <picture>
+    <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/zenstackhq/zenstack-docs/main/static/img/logo-dark.png">
+    <img src="https://raw.githubusercontent.com/zenstackhq/zenstack-docs/main/static/img/logo.png" height="128">
+    </picture>
+    </a>
+    <h1>ZenStack</h1>
     <a href="https://www.npmjs.com/package/zenstack">
         <img src="https://img.shields.io/npm/v/zenstack">
     </a>
@@ -19,13 +23,19 @@
 
 ## 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.
+ZenStack is a Node.js/TypeScript 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 full-stack 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.
+> Read full documentation at 👉🏻 [zenstack.dev](https://zenstack.dev).
+
+ZenStack incrementally extends Prisma's power with the following four layers:
+
+### 1. ZModel - an extended Prisma schema language
+
+ZenStack introduces a data modeling language called "ZModel" - a superset of Prisma schema language. It extended Prisma schema with custom attributes and functions and, based on that, implemented a flexible access control layer around Prisma.
 
 ```prisma
 // schema.zmodel
@@ -45,34 +55,58 @@ model Post {
 }
 ```
 
-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.
+The `zenstack` CLI transpiles the ZModel into a standard Prisma schema, which you can use with the regular Prisma workflows.
+
+### 2. Runtime enhancements to Prisma client
+
+At runtime, transparent proxies are created around Prisma clients for intercepting queries and mutations to enforce access policies.
+
+```ts
+import { enhance } from '@zenstackhq/runtime';
+
+// a regular Prisma client
+const prisma = new PrismaClient();
+
+async function getPosts(userId: string) {
+    // create an enhanced Prisma client that has access control enabled
+    const enhanced = enhance(prisma, { user: userId });
+
+    // only posts that're visible to the user will be returned
+    return enhanced.post.findMany();
+}
+```
+
+### 3. Automatic RESTful APIs through server adapters
+
+Server adapter packages help you wrap an access-control-enabled Prisma client into backend CRUD APIs that can be safely called from the frontend. Here's an example for Next.js:
 
 ```ts
-// Next.js example: pages/api/model/[...path].ts
+// pages/api/model/[...path].ts
 
 import { requestHandler } from '@zenstackhq/next';
-import { withPolicy } from '@zenstackhq/runtime';
+import { enhance } from '@zenstackhq/runtime';
 import { getSessionUser } from '@lib/auth';
 import { prisma } from '@lib/db';
 
+// Mount Prisma-style APIs: "/api/model/post/findMany", "/api/model/post/create", etc.
+// Can be configured to provide standard RESTful APIs (using JSON:API) instead.
 export default requestHandler({
-    getPrisma: (req, res) => withPolicy(prisma, { user: getSessionUser(req, res) }),
+    getPrisma: (req, res) => enhance(prisma, { user: getSessionUser(req, res) }),
 });
 ```
 
-Plugins can generate strong-typed client libraries that talk to the APIs:
+### 4. Generated client libraries (hooks) for data access
+
+Plugins can generate strong-typed client libraries that talk to the aforementioned APIs. Here's an example for React:
 
 ```tsx
-// React example: components/MyPosts.tsx
+// components/MyPosts.tsx
 
-import { usePost } from '@lib/hooks';
+import { useFindManyPost } 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({
+    const { data: posts } = useFindManyPost({
         include: { author: true },
         orderBy: { createdAt: 'desc' },
     });
@@ -89,7 +123,9 @@ const MyPosts = () => {
 };
 ```
 
-The following diagram gives a high-level overview of how it works.
+## Architecture
+
+The following diagram gives a high-level architecture overview of ZenStack.
 
 ![Architecture](https://zenstack.dev/img/architecture-light.png)
 
@@ -99,27 +135,60 @@ The following diagram gives a high-level overview of how it works.
 -   [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
 
 -   Access control and data validation rules right inside your Prisma schema
--   Auto-generated RESTful API and client library
+-   Auto-generated OpenAPI (RESTful) specifications, services, and client libraries
 -   End-to-end type safety
 -   Extensible: custom attributes, functions, and a plugin system
--   Framework agnostic
+-   A framework-agnostic core with framework-specific adapters
 -   Uncompromised performance
 
+### Plugins
+
+-   Prisma schema generator
+-   Zod schema generator
+-   [SWR](https://github.com/vercel/swr) and [TanStack Query](https://github.com/TanStack/query) 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) (including support for the new "app directory" in Next.js 13)
+-   [Nuxt](https://zenstack.dev/docs/reference/server-adapters/nuxt)
+-   [SvelteKit](https://zenstack.dev/docs/reference/server-adapters/sveltekit)
+-   [Fastify](https://zenstack.dev/docs/reference/server-adapters/fastify)
+-   [ExpressJS](https://zenstack.dev/docs/reference/server-adapters/express)
+-   🙋🏻 [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 and model inheritance](https://zenstack.dev/docs/guides/multiple-schema)
+-   Strong-typed JSON field (coming soon)
+-   Polymorphism (future)
+-   🙋🏻 [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 below:
+Check out the [Collaborative Todo App](https://zenstack-todo.vercel.app/) for a running example. You can find different implementations below:
 
--   [Next.js + React hooks implementation](https://github.com/zenstackhq/sample-todo-nextjs)
--   [Next.js + tRPC implementation](https://github.com/zenstackhq/sample-todo-trpc)
+-   [Next.js + SWR hooks](https://github.com/zenstackhq/sample-todo-nextjs)
+-   [Next.js + TanStack Query](https://github.com/zenstackhq/sample-todo-nextjs-tanstack)
+-   [Next.js + tRPC](https://github.com/zenstackhq/sample-todo-trpc)
+-   [Nuxt + TanStack Query](https://github.com/zenstackhq/sample-todo-nuxt)
+-   [SvelteKit + TanStack Query](https://github.com/zenstackhq/sample-todo-sveltekit)
 
 ## Community
 
-Join our [discord server](https://go.zenstack.dev/chat) for chat and updates!
+Join our [discord server](https://discord.gg/Ykhr738dUe) for chat and updates!
+
+## Contributing
+
+If you like ZenStack, join us to make it a better tool! Please use the [Contributing Guide](CONTRIBUTING.md) for details on how to get started, and don't hesitate to join [Discord](https://discord.gg/Ykhr738dUe) to share your thoughts.
 
 ## License
 

package/bin/post-install.js

@@ -7,7 +7,7 @@ try {
     const machineId = require('node-machine-id');
     const os = require('os');
 
-    const mixpanel = Mixpanel.init('', {
+    const mixpanel = Mixpanel.init('74944eb779d7d3b4ce185be843fde9fc', {
         geolocate: true,
     });
 

package/cli/actions/generate.d.ts

@@ -0,0 +1,13 @@
+declare type Options = {
+    schema: string;
+    output?: string;
+    dependencyCheck: boolean;
+    versionCheck: boolean;
+    compile: boolean;
+    defaultPlugins: boolean;
+};
+/**
+ * CLI action for generating code from schema
+ */
+export declare function generate(projectPath: string, options: Options): Promise<void>;
+export {};

package/cli/actions/generate.js

@@ -0,0 +1,71 @@
+"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.generate = void 0;
+const sdk_1 = require("@zenstackhq/sdk");
+const colors_1 = __importDefault(require("colors"));
+const path_1 = __importDefault(require("path"));
+const cli_error_1 = require("../cli-error");
+const cli_util_1 = require("../cli-util");
+const plugin_runner_1 = require("../plugin-runner");
+/**
+ * CLI action for generating code from schema
+ */
+function generate(projectPath, options) {
+    return __awaiter(this, void 0, void 0, function* () {
+        if (options.dependencyCheck) {
+            (0, cli_util_1.checkRequiredPackage)('prisma', cli_util_1.requiredPrismaVersion);
+            (0, cli_util_1.checkRequiredPackage)('@prisma/client', cli_util_1.requiredPrismaVersion);
+        }
+        // check for multiple versions of Zenstack packages
+        const packages = (0, cli_util_1.getZenStackPackages)(projectPath);
+        if (packages) {
+            const versions = new Set(packages.map((p) => p.version));
+            if (versions.size > 1) {
+                console.warn(colors_1.default.yellow('WARNING: Multiple versions of Zenstack packages detected. Run "zenstack info" to see details.'));
+            }
+        }
+        const tasks = [runPlugins(options)];
+        if (options.versionCheck) {
+            tasks.push((0, cli_util_1.checkNewVersion)());
+        }
+        yield Promise.all(tasks);
+    });
+}
+exports.generate = generate;
+function runPlugins(options) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const model = yield (0, cli_util_1.loadDocument)(options.schema);
+        const runnerOpts = {
+            schema: model,
+            schemaPath: path_1.default.resolve(options.schema),
+            defaultPlugins: options.defaultPlugins,
+            output: options.output,
+            compile: options.compile,
+        };
+        try {
+            yield new plugin_runner_1.PluginRunner().run(runnerOpts);
+        }
+        catch (err) {
+            if (err instanceof sdk_1.PluginError) {
+                console.error(colors_1.default.red(`${err.plugin}: ${err.message}`));
+                throw new cli_error_1.CliError(err.message);
+            }
+            else {
+                throw err;
+            }
+        }
+    });
+}
+//# sourceMappingURL=generate.js.map

package/cli/actions/generate.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"generate.js","sourceRoot":"","sources":["../../../src/cli/actions/generate.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,yCAA8C;AAC9C,oDAA4B;AAC5B,gDAAwB;AACxB,4CAAwC;AACxC,0CAMqB;AACrB,oDAAqE;AAWrE;;GAEG;AACH,SAAsB,QAAQ,CAAC,WAAmB,EAAE,OAAgB;;QAChE,IAAI,OAAO,CAAC,eAAe,EAAE;YACzB,IAAA,+BAAoB,EAAC,QAAQ,EAAE,gCAAqB,CAAC,CAAC;YACtD,IAAA,+BAAoB,EAAC,gBAAgB,EAAE,gCAAqB,CAAC,CAAC;SACjE;QAED,mDAAmD;QACnD,MAAM,QAAQ,GAAG,IAAA,8BAAmB,EAAC,WAAW,CAAC,CAAC;QAClD,IAAI,QAAQ,EAAE;YACV,MAAM,QAAQ,GAAG,IAAI,GAAG,CAAS,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC;YACjE,IAAI,QAAQ,CAAC,IAAI,GAAG,CAAC,EAAE;gBACnB,OAAO,CAAC,IAAI,CACR,gBAAM,CAAC,MAAM,CACT,+FAA+F,CAClG,CACJ,CAAC;aACL;SACJ;QAED,MAAM,KAAK,GAAG,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC;QAEpC,IAAI,OAAO,CAAC,YAAY,EAAE;YACtB,KAAK,CAAC,IAAI,CAAC,IAAA,0BAAe,GAAE,CAAC,CAAC;SACjC;QAED,MAAM,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;IAC7B,CAAC;CAAA;AA1BD,4BA0BC;AAED,SAAe,UAAU,CAAC,OAAgB;;QACtC,MAAM,KAAK,GAAG,MAAM,IAAA,uBAAY,EAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QAEjD,MAAM,UAAU,GAAwB;YACpC,MAAM,EAAE,KAAK;YACb,UAAU,EAAE,cAAI,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC;YACxC,cAAc,EAAE,OAAO,CAAC,cAAc;YACtC,MAAM,EAAE,OAAO,CAAC,MAAM;YACtB,OAAO,EAAE,OAAO,CAAC,OAAO;SAC3B,CAAC;QAEF,IAAI;YACA,MAAM,IAAI,4BAAY,EAAE,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;SAC5C;QAAC,OAAO,GAAG,EAAE;YACV,IAAI,GAAG,YAAY,iBAAW,EAAE;gBAC5B,OAAO,CAAC,KAAK,CAAC,gBAAM,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC,MAAM,KAAK,GAAG,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC;gBAC3D,MAAM,IAAI,oBAAQ,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;aACnC;iBAAM;gBACH,MAAM,GAAG,CAAC;aACb;SACJ;IACL,CAAC;CAAA"}

package/cli/actions/index.d.ts

@@ -0,0 +1,3 @@
+export * from './generate';
+export * from './info';
+export * from './init';

package/cli/actions/index.js

@@ -0,0 +1,20 @@
+"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 __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./generate"), exports);
+__exportStar(require("./info"), exports);
+__exportStar(require("./init"), exports);
+//# sourceMappingURL=index.js.map

package/cli/actions/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/cli/actions/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,6CAA2B;AAC3B,yCAAuB;AACvB,yCAAuB"}

package/cli/actions/info.d.ts

@@ -0,0 +1,4 @@
+/**
+ * CLI action for getting information about installed ZenStack packages
+ */
+export declare function info(projectPath: string): Promise<void>;

package/cli/actions/info.js

@@ -0,0 +1,63 @@
+"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.info = void 0;
+const colors_1 = __importDefault(require("colors"));
+const get_latest_version_1 = __importDefault(require("get-latest-version"));
+const ora_1 = __importDefault(require("ora"));
+const semver_1 = __importDefault(require("semver"));
+const cli_util_1 = require("../cli-util");
+/**
+ * CLI action for getting information about installed ZenStack packages
+ */
+function info(projectPath) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const packages = (0, cli_util_1.getZenStackPackages)(projectPath);
+        if (!packages) {
+            console.error('Unable to locate package.json. Are you in a valid project directory?');
+            return;
+        }
+        console.log('Installed ZenStack Packages:');
+        const versions = new Set();
+        for (const { pkg, version } of packages) {
+            versions.add(version);
+            console.log(`    ${colors_1.default.green(pkg.padEnd(20))}\t${version}`);
+        }
+        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.info = info;
+//# sourceMappingURL=info.js.map

package/cli/actions/info.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"info.js","sourceRoot":"","sources":["../../../src/cli/actions/info.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,oDAA4B;AAC5B,4EAAkD;AAClD,8CAAsB;AACtB,oDAA4B;AAC5B,0CAAkD;AAElD;;GAEG;AACH,SAAsB,IAAI,CAAC,WAAmB;;QAC1C,MAAM,QAAQ,GAAG,IAAA,8BAAmB,EAAC,WAAW,CAAC,CAAC;QAClD,IAAI,CAAC,QAAQ,EAAE;YACX,OAAO,CAAC,KAAK,CAAC,sEAAsE,CAAC,CAAC;YACtF,OAAO;SACV;QAED,OAAO,CAAC,GAAG,CAAC,8BAA8B,CAAC,CAAC;QAC5C,MAAM,QAAQ,GAAG,IAAI,GAAG,EAAU,CAAC;QACnC,KAAK,MAAM,EAAE,GAAG,EAAE,OAAO,EAAE,IAAI,QAAQ,EAAE;YACrC,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;YACtB,OAAO,CAAC,GAAG,CAAC,OAAO,gBAAM,CAAC,KAAK,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,KAAK,OAAO,EAAE,CAAC,CAAC;SAClE;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;IACL,CAAC;CAAA;AAlCD,oBAkCC"}

package/cli/actions/init.d.ts

@@ -0,0 +1,12 @@
+import { PackageManagers } from '../../utils/pkg-utils';
+declare type Options = {
+    prisma: string | undefined;
+    packageManager: PackageManagers | undefined;
+    versionCheck: boolean;
+    tag?: string;
+};
+/**
+ * CLI action for initializing an existing project
+ */
+export declare function init(projectPath: string, options: Options): Promise<void>;
+export {};

package/cli/actions/init.js

@@ -0,0 +1,83 @@
+"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.init = void 0;
+const colors_1 = __importDefault(require("colors"));
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+const pkg_utils_1 = require("../../utils/pkg-utils");
+const version_utils_1 = require("../../utils/version-utils");
+const cli_error_1 = require("../cli-error");
+const cli_util_1 = require("../cli-util");
+/**
+ * CLI action for initializing an existing project
+ */
+function init(projectPath, options) {
+    var _a;
+    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';
+        let prismaSchema = options.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, options.packageManager, 'latest', projectPath);
+        (0, pkg_utils_1.ensurePackage)('@prisma/client', false, options.packageManager, 'latest', projectPath);
+        const tag = (_a = options.tag) !== null && _a !== void 0 ? _a : (0, version_utils_1.getVersion)();
+        (0, pkg_utils_1.installPackage)('zenstack', true, options.packageManager, tag, projectPath);
+        (0, pkg_utils_1.installPackage)('@zenstackhq/runtime', false, options.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 if (prismaSchema) {
+            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!'));
+        if (options.versionCheck) {
+            yield (0, cli_util_1.checkNewVersion)();
+        }
+    });
+}
+exports.init = init;
+//# sourceMappingURL=init.js.map

package/cli/actions/init.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"init.js","sourceRoot":"","sources":["../../../src/cli/actions/init.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,oDAA4B;AAC5B,4CAAoB;AACpB,gDAAwB;AACxB,qDAAuF;AACvF,6DAAuD;AACvD,4CAAwC;AACxC,0CAA8C;AAS9C;;GAEG;AACH,SAAsB,IAAI,CAAC,WAAmB,EAAE,OAAgB;;;QAC5D,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,GAAG,OAAO,CAAC,MAAM,CAAC;QAClC,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,0BAA0B,CAAC,EAAE,OAAO,CAAC,CAAC;gBAClG,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,OAAO,CAAC,cAAc,EAAE,QAAQ,EAAE,WAAW,CAAC,CAAC;QAC7E,IAAA,yBAAa,EAAC,gBAAgB,EAAE,KAAK,EAAE,OAAO,CAAC,cAAc,EAAE,QAAQ,EAAE,WAAW,CAAC,CAAC;QAEtF,MAAM,GAAG,GAAG,MAAA,OAAO,CAAC,GAAG,mCAAI,IAAA,0BAAU,GAAE,CAAC;QACxC,IAAA,0BAAc,EAAC,UAAU,EAAE,IAAI,EAAE,OAAO,CAAC,cAAc,EAAE,GAAG,EAAE,WAAW,CAAC,CAAC;QAC3E,IAAA,0BAAc,EAAC,qBAAqB,EAAE,KAAK,EAAE,OAAO,CAAC,cAAc,EAAE,GAAG,EAAE,WAAW,CAAC,CAAC;QAEvF,IAAI,oBAAoB,EAAE;YACtB,OAAO,CAAC,GAAG,CAAC,8BAA8B,gBAAM,CAAC,IAAI,CAAC,UAAU,CAAC;;;8CAG3B,CAAC,CAAC;SAC3C;aAAM,IAAI,YAAY,EAAE;YACrB,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;QAEjE,IAAI,OAAO,CAAC,YAAY,EAAE;YACtB,MAAM,IAAA,0BAAe,GAAE,CAAC;SAC3B;;CACJ;AA1DD,oBA0DC"}

package/cli/cli-util.d.ts

@@ -1,18 +1,21 @@
 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>;
+import { LangiumDocument, LangiumDocuments } from 'langium';
+import { URI } from 'vscode-uri';
+import { ZModelServices } from '../language-server/zmodel-module';
+export declare const requiredPrismaVersion = "4.8.0";
 /**
  * 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>;
+export declare function loadDocument(fileName: string): Promise<Model>;
+export declare function eagerLoadAllImports(document: LangiumDocument, documents: LangiumDocuments, uris?: Set<string>): URI[];
+export declare function mergeImportsDeclarations(documents: LangiumDocuments, model: Model): void;
+export declare function getPluginDocuments(services: ZModelServices, fileName: string): Promise<LangiumDocument[]>;
+export declare function getZenStackPackages(projectPath: string): {
+    pkg: string;
+    version: any;
+}[] | undefined;
+export declare function checkRequiredPackage(packageName: string, minVersion?: string): void;
+export declare function checkNewVersion(): Promise<void>;