zenstack 0.3.10 → 0.3.12

package/package.json

@@ -3,7 +3,7 @@
   "publisher": "zenstack",
   "displayName": "ZenStack Language Tools",
   "description": "A toolkit for modeling data and access policies in full-stack development with Next.js and Typescript",
-  "version": "0.3.10",
+  "version": "0.3.12",
   "author": {
     "name": "ZenStack Team"
   },
@@ -65,7 +65,7 @@
   },
   "main": "./bundle/extension.js",
   "dependencies": {
-    "@zenstackhq/internal": "0.3.10",
+    "@zenstackhq/runtime": "0.3.12",
     "async-exit-hook": "^2.0.1",
     "change-case": "^4.1.2",
     "chevrotain": "^9.1.0",
@@ -118,7 +118,7 @@
     "vscode:prepublish": "cp ../../README.md ./ && pnpm lint && pnpm build",
     "vscode:package": "vsce package --no-dependencies",
     "clean": "rimraf bundle",
-    "build": "pnpm langium:generate && tsc --noEmit && pnpm bundle && cp -r src/res/* bundle/res/",
+    "build": "pnpm -C ../runtime build && pnpm langium:generate && tsc --noEmit && pnpm bundle && cp -r src/res/* bundle/res/",
     "bundle": "npm run clean && node build/bundle.js --minify",
     "bundle-watch": "node build/bundle.js --watch",
     "ts:watch": "tsc --watch --noEmit",

package/src/cli/cli-util.ts

@@ -6,8 +6,9 @@ import fs from 'fs';
 import { LangiumServices } from 'langium';
 import { NodeFileSystem } from 'langium/node';
 import path from 'path';
-import { ZenStackGenerator } from '../generator';
+import { installPackage, PackageManagers } from '../utils/pkg-utils';
 import { URI } from 'vscode-uri';
+import { ZenStackGenerator } from '../generator';
 import { GENERATED_CODE_PATH } from '../generator/constants';
 import { Context, GeneratorError } from '../generator/types';
 import { CliError } from './cli-error';
@@ -15,21 +16,24 @@ import { CliError } from './cli-error';
 /**
  * Initializes an existing project for ZenStack
  */
-export async function initProject(projectPath: string) {
+export async function initProject(
+    projectPath: string,
+    packageManager: PackageManagers | undefined
+) {
     const schema = path.join(projectPath, 'zenstack', 'schema.zmodel');
+    let schemaGenerated = false;
+
     if (fs.existsSync(schema)) {
         console.warn(colors.yellow(`Model already exists: ${schema}`));
-        throw new CliError(`schema file already exists`);
-    }
-
-    // create a default model
-    if (!fs.existsSync(path.join(projectPath, 'zenstack'))) {
-        fs.mkdirSync(path.join(projectPath, 'zenstack'));
-    }
+    } else {
+        // create a default model
+        if (!fs.existsSync(path.join(projectPath, 'zenstack'))) {
+            fs.mkdirSync(path.join(projectPath, 'zenstack'));
+        }
 
-    fs.writeFileSync(
-        schema,
-        `// This is a sample model to get you started.
+        fs.writeFileSync(
+            schema,
+            `// This is a sample model to get you started.
 // Learn how to model you app: https://zenstack.dev/#/modeling-your-app.
 
 /*
@@ -77,26 +81,34 @@ model Post {
     @@allow('all', author == auth())
 }
 `
-    );
+        );
 
-    // add zenstack/schema.prisma to .gitignore
-    const gitIgnorePath = path.join(projectPath, '.gitignore');
-    let gitIgnoreContent = '';
-    if (fs.existsSync(gitIgnorePath)) {
-        gitIgnoreContent =
-            fs.readFileSync(gitIgnorePath, { encoding: 'utf-8' }) + '\n';
-    }
+        // add zenstack/schema.prisma to .gitignore
+        const gitIgnorePath = path.join(projectPath, '.gitignore');
+        let gitIgnoreContent = '';
+        if (fs.existsSync(gitIgnorePath)) {
+            gitIgnoreContent =
+                fs.readFileSync(gitIgnorePath, { encoding: 'utf-8' }) + '\n';
+        }
 
-    if (!gitIgnoreContent.includes('zenstack/schema.prisma')) {
-        gitIgnoreContent += 'zenstack/schema.prisma\n';
-        fs.writeFileSync(gitIgnorePath, gitIgnoreContent);
+        if (!gitIgnoreContent.includes('zenstack/schema.prisma')) {
+            gitIgnoreContent += 'zenstack/schema.prisma\n';
+            fs.writeFileSync(gitIgnorePath, gitIgnoreContent);
+        }
+
+        schemaGenerated = true;
     }
 
-    console.log(`Sample model generated at: ${colors.green(schema)}
+    installPackage('zenstack', true, packageManager, projectPath);
+    installPackage('@zenstackhq/runtime', false, packageManager, projectPath);
 
-Please check the following guide on how to model your app:
-    https://zenstack.dev/#/modeling-your-app.
-`);
+    if (schemaGenerated) {
+        console.log(`Sample model generated at: ${colors.green(schema)}
+
+        Please check the following guide on how to model your app:
+            https://zenstack.dev/#/modeling-your-app.
+        `);
+    }
 }
 
 /**
@@ -164,7 +176,7 @@ export async function loadDocument(
 }
 
 export async function runGenerator(
-    options: { schema: string },
+    options: { schema: string; packageManager: string },
     includedGenerators?: string[],
     clearOutput = true
 ) {

package/src/cli/index.ts

@@ -3,24 +3,37 @@ import { paramCase } from 'change-case';
 import colors from 'colors';
 import { Command, Option } from 'commander';
 import path from 'path';
+import { PackageManagers } from '../utils/pkg-utils';
 import { ZModelLanguageMetaData } from '../language-server/generated/module';
 import telemetry from '../telemetry';
 import { execSync } from '../utils/exec-utils';
 import { CliError } from './cli-error';
 import { initProject, runGenerator } from './cli-util';
 
-export const initAction = async (projectPath: string): Promise<void> => {
+export const initAction = async (
+    projectPath: string,
+    options: {
+        packageManager: PackageManagers | 'auto detect';
+    }
+): Promise<void> => {
     await telemetry.trackSpan(
         'cli:command:start',
         'cli:command:complete',
         'cli:command:error',
         { command: 'init' },
-        () => initProject(projectPath)
+        () =>
+            initProject(
+                projectPath ?? '.',
+                options.packageManager === 'auto detect'
+                    ? undefined
+                    : options.packageManager
+            )
     );
 };
 
 export const generateAction = async (options: {
     schema: string;
+    packageManager: string;
 }): Promise<void> => {
     await telemetry.trackSpan(
         'cli:command:start',
@@ -116,12 +129,18 @@ export default async function (): Promise<void> {
                 `schema file (with extension ${schemaExtensions})`
             ).default('./zenstack/schema.zmodel');
 
+            const pmOption = new Option(
+                '--package-manager, -p',
+                'package manager to use: "npm", "yarn" or "pnpm"'
+            ).default('auto detect');
+
             //#region wraps Prisma commands
 
             program
                 .command('init')
                 .description('Set up a new ZenStack project.')
-                .argument('<path>', 'project path')
+                .addOption(pmOption)
+                .argument('[path]', 'project path')
                 .action(initAction);
 
             program
@@ -130,6 +149,7 @@ export default async function (): Promise<void> {
                     'Generates RESTful API and Typescript client for your data model.'
                 )
                 .addOption(schemaOption)
+                .addOption(pmOption)
                 .action(generateAction);
 
             const migrate = program

package/src/generator/constants.ts

@@ -1,4 +1,4 @@
-export const INTERNAL_PACKAGE = '@zenstackhq/internal';
+export const RUNTIME_PACKAGE = '@zenstackhq/runtime';
 export const GUARD_FIELD_NAME = 'zenstack_guard';
 export const TRANSACTION_FIELD_NAME = 'zenstack_transaction';
 export const API_ROUTE_NAME = 'zenstack';

package/src/generator/prisma/query-guard-generator.ts

@@ -10,12 +10,12 @@ import {
     PolicyKind,
     PolicyOperationKind,
     RuntimeAttribute,
-} from '@zenstackhq/internal';
+} from '@zenstackhq/runtime/server';
 import path from 'path';
 import { Project, SourceFile, VariableDeclarationKind } from 'ts-morph';
 import {
     GUARD_FIELD_NAME,
-    INTERNAL_PACKAGE,
+    RUNTIME_PACKAGE,
     UNKNOWN_USER_ID,
 } from '../constants';
 import { Context } from '../types';
@@ -38,7 +38,7 @@ export default class QueryGuardGenerator {
 
         sf.addImportDeclaration({
             namedImports: [{ name: 'QueryContext' }],
-            moduleSpecifier: INTERNAL_PACKAGE,
+            moduleSpecifier: `${RUNTIME_PACKAGE}/server`,
             isTypeOnly: true,
         });
 

package/src/generator/react-hooks/index.ts

@@ -5,7 +5,7 @@ import { paramCase } from 'change-case';
 import { DataModel } from '@lang/generated/ast';
 import colors from 'colors';
 import { extractDataModelsWithAllowRules } from '../ast-utils';
-import { API_ROUTE_NAME } from '../constants';
+import { API_ROUTE_NAME, RUNTIME_PACKAGE } from '../constants';
 
 /**
  * Generate react data query hooks code
@@ -51,7 +51,9 @@ export default class ReactHooksGenerator implements Generator {
             moduleSpecifier: '../../.prisma',
         });
         sf.addStatements([
-            `import { request, validate, ServerErrorCode, RequestOptions } from '@zenstackhq/runtime/client';`,
+            `import * as request from '${RUNTIME_PACKAGE}/lib/request';`,
+            `import { ServerErrorCode, RequestOptions } from '${RUNTIME_PACKAGE}/lib/types';`,
+            `import { validate } from '${RUNTIME_PACKAGE}/lib/validation';`,
             `import { type SWRResponse } from 'swr';`,
             `import { ${this.getValidator(
                 model,

package/src/generator/service/index.ts

@@ -2,7 +2,7 @@ import { Context, Generator } from '../types';
 import { Project } from 'ts-morph';
 import * as path from 'path';
 import colors from 'colors';
-import { INTERNAL_PACKAGE } from '../constants';
+import { RUNTIME_PACKAGE } from '../constants';
 
 /**
  * Generates ZenStack service code
@@ -22,7 +22,7 @@ export default class ServiceGenerator implements Generator {
 
         sf.addStatements([
             `import { PrismaClient } from "../.prisma";`,
-            `import { DefaultService } from "${INTERNAL_PACKAGE}";`,
+            `import { DefaultService } from "${RUNTIME_PACKAGE}/lib/service";`,
         ]);
 
         const cls = sf.addClass({

package/src/utils/pkg-utils.ts

@@ -0,0 +1,63 @@
+import fs from 'fs';
+import path from 'path';
+import { execSync } from './exec-utils';
+
+export type PackageManagers = 'npm' | 'yarn' | 'pnpm';
+
+function getPackageManager(projectPath = '.'): PackageManagers {
+    if (fs.existsSync(path.join(projectPath, 'yarn.lock'))) {
+        return 'yarn';
+    } else if (fs.existsSync(path.join(projectPath, 'pnpm-lock.yaml'))) {
+        return 'pnpm';
+    } else {
+        return 'npm';
+    }
+}
+
+export function installPackage(
+    pkg: string,
+    dev: boolean,
+    pkgManager: PackageManagers | undefined = undefined,
+    projectPath = '.'
+) {
+    const manager = pkgManager ?? getPackageManager(projectPath);
+    console.log(`Installing package "${pkg}@dev" with ${manager}`);
+    switch (manager) {
+        case 'yarn':
+            execSync(
+                `yarn --cwd "${projectPath}" add ${pkg} ${
+                    dev ? ' --save-dev' : ''
+                } --ignore-engines`
+            );
+            break;
+
+        case 'pnpm':
+            execSync(
+                `pnpm add -C "${projectPath}" ${
+                    dev ? ' --save-dev' : ''
+                } ${pkg}`
+            );
+            break;
+
+        default:
+            execSync(
+                `npm install --prefix "${projectPath}" ${
+                    dev ? ' --save-dev' : ''
+                } ${pkg}`
+            );
+            break;
+    }
+}
+
+export function ensurePackage(
+    pkg: string,
+    dev: boolean,
+    pkgManager: PackageManagers | undefined = undefined,
+    projectPath = '.'
+) {
+    try {
+        require(pkg);
+    } catch {
+        installPackage(pkg, dev, pkgManager, projectPath);
+    }
+}