zenstack 0.5.0 → 0.6.0-pre.2

package/bundle/res/package.template.json

@@ -1,9 +0,0 @@
-{
-    "name": ".zenstack",
-    "version": "1.0.0",
-    "description": "ZenStack generated code",
-    "main": "lib/index.js",
-    "types": "lib/index.d.ts",
-    "author": "ZenStack",
-    "license": "MIT"
-}

package/bundle/res/prism-zmodel.js

@@ -1,22 +0,0 @@
-// based on: https://github.com/prisma/docs/blob/c72eb087fcf57f3c00d153f86c549ef28b3d0f44/src/components/customMdx/prism/prism-prisma.js
-
-(function (Prism) {
-    Prism.languages.zmodel = Prism.languages.extend('clike', {
-        keyword:
-            /\b(?:datasource|enum|generator|model|attribute|function|null|this)\b/,
-        'type-class-name': /(\b()\s+)[\w.\\]+/,
-    });
-
-    Prism.languages.javascript['class-name'][0].pattern =
-        /(\b(?:model|datasource|enum|generator)\s+)[\w.\\]+/;
-
-    Prism.languages.insertBefore('zmodel', 'function', {
-        annotation: {
-            pattern: /(^|[^.])@+\w+/,
-            lookbehind: true,
-            alias: 'punctuation',
-        },
-    });
-
-    Prism.languages.json5 = Prism.languages.js;
-})(Prism);

package/bundle/res/stdlib.zmodel

@@ -1,218 +0,0 @@
-/*
- * Enum representing referential integrity related actions
- */
-enum ReferentialAction {
-    /*
-     * Used with "onDelete": deleting a referenced record will trigger the deletion of referencing record.
-     * Used with "onUpdate": updates the relation scalar fields if the referenced scalar fields of the dependent record are updated.
-     */
-    Cascade
-
-    /*
-     * Used with "onDelete": prevents the deletion if any referencing records exist.
-     * Used with "onUpdate": prevents the identifier of a referenced record from being changed.
-     */
-    Restrict
-
-    /*
-     * Similar to 'Restrict', the difference between the two is dependent on the database being used.
-     * See details: https://www.prisma.io/docs/concepts/components/prisma-schema/relations/referential-actions#noaction
-     */
-    NoAction
-
-    /*
-     * Used with "onDelete": the scalar field of the referencing object will be set to NULL.
-     * Used with "onUpdate": when updating the identifier of a referenced object, the scalar fields of the referencing objects will be set to NULL.
-     */
-    SetNull
-    
-    /*
-     * Used with "onDelete": the scalar field of the referencing object will be set to the fields default value.
-     * Used with "onUpdate": the scalar field of the referencing object will be set to the fields default value.
-     */
-    SetDefault
-}
-
-/*
- * Enum representing all possible field types
- */
-enum AttributeTargetField {
-    StringField
-    IntField
-    FloatField
-    DecimalField
-    BooleanField
-    DateTimeField
-    JsonField
-    BytesField
-    ModelField
-}
-
-/*
- * Reads value from an environment variable.
- */
-function env(name: String): String {}
-
-/*
- * Gets the current login user.
- */
-function auth(): Any {}
-
-/*
- * Gets current date-time (as DateTime type).
- */
-function now(): DateTime {}
-
-/*
- * Generates a globally unique identifier based on the UUID specs.
- */
-function uuid(): String {}
-
-/*
- * Generates a globally unique identifier based on the CUID spec.
- */
-function cuid(): String {}
-
-/*
- * Creates a sequence of integers in the underlying database and assign the incremented 
- * values to the ID values of the created records based on the sequence.
- */
-function autoincrement(): Int {}
-
-/*
- * Represents default values that cannot be expressed in the Prisma schema (such as random()).
- */
-function dbgenerated(expr: String): Any {}
-
-attribute @@@targetField(targetField: AttributeTargetField[])
-
-attribute @@@prisma()
-
-/*
- * Defines an ID on the model.
- */
-attribute @id(map: String?) @@@prisma
-
-/*
- * Defines a default value for a field.
- */
-attribute @default(_ value: ContextType) @@@prisma
-
-/*
- * Defines a unique constraint for this field.
- */
-attribute @unique(map: String?) @@@prisma
-
-/*
- * Defines a compound unique constraint for the specified fields.
- */
-attribute @@unique(_ fields: FieldReference[], name: String?, map: String?) @@@prisma
-
-/*
- * Defines an index in the database.
- */
-attribute @@index(_ fields: FieldReference[], map: String?) @@@prisma
-
-/*
- * Defines meta information about the relation.
- */
-attribute @relation(_ name: String?, fields: FieldReference[]?, references: FieldReference[]?, onDelete: ReferentialAction?, onUpdate: ReferentialAction?, map: String?) @@@prisma
-
-/*
- * Maps a field name or enum value from the schema to a column with a different name in the database.
- */
-attribute @map(_ name: String) @@@prisma
-
-/*
- * Maps the schema model name to a table with a different name, or an enum name to a different underlying enum in the database.
- */
-attribute @@map(_ name: String) @@@prisma
-
-/*
- * Automatically stores the time when a record was last updated.
- */
-attribute @updatedAt() @@@targetField([DateTimeField]) @@@prisma
-
-/*
- * Defines an access policy that allows a set of operations when the given condition is true.
- */
-attribute @@allow(_ operation: String, _ condition: Boolean)
-
-/*
- * Defines an access policy that denies a set of operations when the given condition is true.
- */
-attribute @@deny(_ operation: String, _ condition: Boolean)
-
-/*
- * Indicates that the field is a password field and needs to be hashed before persistence.
- * 
- * ZenStack uses `bcryptjs` library to hash password. You can use the `saltLength` parameter
- * to configure the cost of hashing, or use `salt` parameter to provide an explicit salt.
- * By default, salt length of 12 is used.
- *
- * @see https://www.npmjs.com/package/bcryptjs for details
- * 
- * @saltLength: length of salt to use (cost factor for the hash function)
- * @salt: salt to use (a pregenerated valid salt)
- */
-attribute @password(saltLength: Int?, salt: String?) @@@targetField([StringField])
-
-/*
- * Indicates that the field should be omitted when read from the generated services.
- */
-attribute @omit()
-
-/*
- * Validates length of a string field.
- */
-attribute @length(_ min: Int?, _ max: Int?) @@@targetField([StringField])
-
-/*
- * Validates a string field value matches a regex.
- */
-attribute @regex(_ regex: String) @@@targetField([StringField])
-
-/*
- * Validates a string field value starts with the given text.
- */
-attribute @startsWith(_ text: String) @@@targetField([StringField])
-
-/*
- * Validates a string field value ends with the given text.
- */
-attribute @endsWith(_ text: String) @@@targetField([StringField])
-
-/*
- * Validates a string field value is a valid email address.
- */
-attribute @email() @@@targetField([StringField])
-
-/*
- * Validates a string field value is a valid ISO datetime.
- */
-attribute @datetime() @@@targetField([StringField])
-
-/*
- * Validates a string field value is a valid url.
- */
-attribute @url() @@@targetField([StringField])
-
-/*
- * Validates a number field is greater than the given value.
- */
-attribute @gt(_ value: Int) @@@targetField([IntField, FloatField, DecimalField])
-
-/*
- * Validates a number field is greater than or equal to the given value.
- */
-attribute @gte(_ value: Int) @@@targetField([IntField, FloatField, DecimalField])
-
-/*
- * Validates a number field is less than the given value.
- */
-attribute @lt(_ value: Int) @@@targetField([IntField, FloatField, DecimalField])
-
-/*
- * Validates a number field is less than or equal to the given value.
- */
-attribute @lte(_ value: Int) @@@targetField([IntField, FloatField, DecimalField])

package/bundle/res/tsconfig.template.json

@@ -1,17 +0,0 @@
-{
-    "compilerOptions": {
-        "target": "ES6",
-        "module": "CommonJS",
-        "lib": ["ESNext", "DOM"],
-        "sourceMap": true,
-        "outDir": "lib",
-        "strict": true,
-        "moduleResolution": "node",
-        "esModuleInterop": true,
-        "skipLibCheck": true,
-        "declaration": true,
-        "resolveJsonModule": true
-    },
-    "include": ["**/*.ts"],
-    "exclude": ["node_modules", ".prisma", "**/*.d.ts"]
-}

package/src/cli/cli-error.ts

@@ -1,4 +0,0 @@
-/**
- * Indicating an error during CLI execution
- */
-export class CliError extends Error {}

package/src/cli/cli-util.ts

@@ -1,214 +0,0 @@
-import { STD_LIB_MODULE_NAME } from '@lang/constants';
-import { Model } from '@lang/generated/ast';
-import { createZModelServices } from '@lang/zmodel-module';
-import colors from 'colors';
-import fs from 'fs';
-import { LangiumServices } from 'langium';
-import { NodeFileSystem } from 'langium/node';
-import path from 'path';
-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';
-
-/**
- * Initializes an existing project for ZenStack
- */
-export async function initProject(
-    projectPath: string,
-    packageManager: PackageManagers | undefined
-) {
-    if (!fs.existsSync(projectPath)) {
-        console.error(`Path does not exist: ${projectPath}`);
-        throw new CliError('project path does not exist');
-    }
-
-    const schema = path.join(projectPath, 'zenstack', 'schema.zmodel');
-    let schemaGenerated = false;
-
-    if (fs.existsSync(schema)) {
-        console.warn(colors.yellow(`Model already exists: ${schema}`));
-    } 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.
-// Learn how to model you app: https://zenstack.dev/#/modeling-your-app.
-
-/*
- * A sample data source using local sqlite db.
- * See how to use a different db: https://zenstack.dev/#/zmodel-data-source.
- */
-datasource db {
-    provider = 'sqlite'
-    url = 'file:./todo.db'
-}
-
-/*
- * User model
- */
-model User {
-    id String @id @default(cuid())
-    email String @unique @email
-    password String @password @omit @length(8, 16)
-    posts Post[]
-
-    // everybody can signup
-    @@allow('create', true)
-
-    // full access by self
-    @@allow('all', auth() == this)
-}
-
-/*
- * Post model
- */
-model Post {
-    id String @id @default(cuid())
-    createdAt DateTime @default(now())
-    updatedAt DateTime @updatedAt
-    title String @length(1, 256)
-    content String
-    published Boolean @default(false)
-    author User? @relation(fields: [authorId], references: [id])
-    authorId String?
-
-    // allow read for all signin users
-    @@allow('read', auth() != null && published)
-
-    // full access by author
-    @@allow('all', author == auth())
-}
-`
-        );
-
-        // add zenstack/schema.prisma to .gitignore
-        const gitIgnorePath = path.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);
-        }
-
-        schemaGenerated = true;
-    }
-
-    installPackage('zenstack', true, packageManager, projectPath);
-    installPackage('@zenstackhq/runtime', false, packageManager, projectPath);
-
-    if (schemaGenerated) {
-        console.log(`Sample model generated at: ${colors.blue(schema)}
-
-        Please check the following guide on how to model your app:
-            https://zenstack.dev/#/modeling-your-app.
-            `);
-    }
-
-    console.log(colors.green('\nProject initialized successfully!'));
-}
-
-/**
- * Loads a zmodel document from a file.
- * @param fileName File name
- * @param services Language services
- * @returns Parsed and validated AST
- */
-export async function loadDocument(
-    fileName: string,
-    services: LangiumServices
-): Promise<Model> {
-    const extensions = services.LanguageMetaData.fileExtensions;
-    if (!extensions.includes(path.extname(fileName))) {
-        console.error(
-            colors.yellow(`Please choose a file with extension: ${extensions}.`)
-        );
-        throw new CliError('invalid schema file');
-    }
-
-    if (!fs.existsSync(fileName)) {
-        console.error(colors.red(`File ${fileName} does not exist.`));
-        throw new CliError('schema file does not exist');
-    }
-
-    // load standard library
-    const stdLib =
-        services.shared.workspace.LangiumDocuments.getOrCreateDocument(
-            URI.file(
-                path.resolve(
-                    path.join(__dirname, '../res', STD_LIB_MODULE_NAME)
-                )
-            )
-        );
-
-    // load the document
-    const document =
-        services.shared.workspace.LangiumDocuments.getOrCreateDocument(
-            URI.file(path.resolve(fileName))
-        );
-
-    // build the document together with standard library
-    await services.shared.workspace.DocumentBuilder.build([stdLib, document], {
-        validationChecks: 'all',
-    });
-
-    const validationErrors = (document.diagnostics ?? []).filter(
-        (e) => e.severity === 1
-    );
-    if (validationErrors.length > 0) {
-        console.error(colors.red('Validation errors:'));
-        for (const validationError of validationErrors) {
-            console.error(
-                colors.red(
-                    `line ${validationError.range.start.line + 1}: ${
-                        validationError.message
-                    } [${document.textDocument.getText(validationError.range)}]`
-                )
-            );
-        }
-        throw new CliError('schema validation errors');
-    }
-
-    return document.parseResult.value as Model;
-}
-
-export async function runGenerator(
-    options: { schema: string; packageManager: PackageManagers | undefined },
-    includedGenerators?: string[],
-    clearOutput = true
-) {
-    const services = createZModelServices(NodeFileSystem).ZModel;
-    const model = await loadDocument(options.schema, services);
-
-    const context: Context = {
-        schema: model,
-        outDir: path.dirname(options.schema),
-        // TODO: make this configurable
-        generatedCodeDir: GENERATED_CODE_PATH,
-    };
-
-    try {
-        await new ZenStackGenerator().generate(
-            context,
-            includedGenerators,
-            clearOutput
-        );
-    } catch (err) {
-        if (err instanceof GeneratorError) {
-            console.error(colors.red(err.message));
-            throw new CliError(err.message);
-        } else {
-            throw err;
-        }
-    }
-}