zenstack 0.5.0 → 0.6.0-pre.2

package/src/language-server/zmodel.langium

@@ -1,207 +0,0 @@
-grammar ZModel
-
-entry Model:
-    (
-        declarations+=AbstractDeclaration
-    )*;
-
-AbstractDeclaration:
-    DataSource | DataModel | Enum | Function | Attribute;
-
-// datasource
-DataSource:
-    'datasource' name=ID '{' (fields+=DataSourceField)* '}';
-
-DataSourceField:
-    (name=ID '=' value=(LiteralExpr|InvocationExpr));
-
-// expression
-Expression:
-    LogicalExpr;
-
-LiteralExpr:
-    value=(BOOLEAN | NUMBER | STRING);
-
-ArrayExpr:
-    '[' (items+=Expression (',' items+=Expression)*)? ']';
-
-type ReferenceTarget = FunctionParam | DataModelField | EnumField;
-
-ThisExpr:
-    value=THIS;
-
-NullExpr:
-    value=NULL;
-
-ReferenceExpr:
-    target=[ReferenceTarget:ID] ('(' ReferenceArgList ')')?;
-
-fragment ReferenceArgList:
-    args+=ReferenceArg (',' args+=ReferenceArg)*;
-
-ReferenceArg:
-    name=('sort') ':' value=('Asc'| 'Desc');
-
-InvocationExpr:
-    function=[Function] '(' ArgumentList? ')';
-
-UnaryExpr:
-    operator=('!') operand=Expression;
-
-// binary operator precedence follow Javascript's rules:
-// https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Operator_Precedence#table
-
-MemberAccessExpr infers Expression:
-    PrimaryExpr (
-        {infer MemberAccessExpr.operand=current}
-        ('.' member=[DataModelField])
-    )*;
-
-CollectionPredicateExpr infers Expression:
-    MemberAccessExpr (
-        {infer BinaryExpr.left=current}
-        operator=('?'|'!'|'^')
-        '[' right=Expression ']'
-    )*;
-
-// TODO: support arithmetics?
-//
-// MultDivExpr infers Expression:
-//     CollectionPredicateExpr (
-//         {infer BinaryExpr.left=current}
-//         operator=('*'|'/')
-//         right=CollectionPredicateExpr
-//     )*;
-
-// AddSubExpr infers Expression:
-//     MultDivExpr (
-//         {infer BinaryExpr.left=current}
-//         operator=('+'|'-')
-//         right=MultDivExpr
-//     )*;
-
-ComparisonExpr infers Expression:
-    CollectionPredicateExpr (
-        {infer BinaryExpr.left=current}
-        operator=('>'|'<'|'>='|'<=')
-        right=CollectionPredicateExpr
-    )*;
-
-EqualityExpr infers Expression:
-    ComparisonExpr (
-        {infer BinaryExpr.left=current}
-        operator=('=='|'!=')
-        right=ComparisonExpr
-    )*;
-
-LogicalExpr infers Expression:
-    EqualityExpr (
-        {infer BinaryExpr.left=current}
-        operator=('&&'|'||')
-        right=EqualityExpr
-    )*;
-
-PrimaryExpr infers Expression:
-    '(' Expression ')' |
-    ThisExpr |
-    NullExpr |
-    LiteralExpr |
-    InvocationExpr |
-    ArrayExpr|
-    ReferenceExpr |
-    UnaryExpr;
-
-fragment ArgumentList:
-    args+=Argument (',' args+=Argument)*;
-
-Argument:
-    (name=ID ':')? value=Expression;
-
-// model
-DataModel:
-    'model' name=ID '{' (
-            fields+=DataModelField
-            | attributes+=DataModelAttribute
-        )+
-    '}';
-
-DataModelField:
-    name=ID type=DataModelFieldType (attributes+=DataModelFieldAttribute)*;
-
-DataModelFieldType:
-    (type=BuiltinType | reference=[TypeDeclaration:ID]) (array?='[]')? (optional?='?')?;
-
-// enum
-Enum:
-    'enum' name=ID '{' (fields+=EnumField)+ '}';
-
-EnumField:
-    name=ID;
-
-// function
-Function:
-    'function' name=ID '(' (params+=FunctionParam (',' params+=FunctionParam)*)? ')' ':' returnType=FunctionParamType '{' (expression=Expression)? '}';
-
-FunctionParam:
-    name=ID ':' type=FunctionParamType;
-
-FunctionParamType:
-    (type=ExpressionType | reference=[TypeDeclaration]) (array?='[]')?;
-
-// attribute-level attribute
-AttributeAttributeName returns string:
-    '@@@' ID;
-
-// model-level attribute
-DataModelAttributeName returns string:
-    '@@' ID;
-
-// field-level attribute
-DataModelFieldAttributeName returns string:
-    '@' ID;
-
-AttributeName returns string:
-    DataModelAttributeName | DataModelFieldAttributeName | AttributeAttributeName;
-
-// attribute
-Attribute:
-    'attribute' name=AttributeName '(' (params+=AttributeParam (',' params+=AttributeParam)*)? ')' (attributes+=AttributeAttribute)*;
-
-AttributeParam:
-    (default?='_')? name=ID ':' type=AttributeParamType;
-
-AttributeParamType:
-    (type=(ExpressionType | 'FieldReference' | 'ContextType') | reference=[TypeDeclaration:ID]) (array?='[]')? (optional?='?')?;
-
-type TypeDeclaration = DataModel | Enum;
-
-DataModelFieldAttribute:
-    decl=[Attribute:DataModelFieldAttributeName] ('(' AttributeArgList? ')')?;
-
-DataModelAttribute:
-    decl=[Attribute:DataModelAttributeName] ('(' AttributeArgList? ')')?;
-
-AttributeAttribute:
-    decl=[Attribute:AttributeAttributeName] ('(' AttributeArgList? ')')?;
-
-fragment AttributeArgList:
-    args+=AttributeArg (',' args+=AttributeArg)*;
-
-AttributeArg:
-    (name=ID ':')? value=Expression;
-
-ExpressionType returns string:
-    'String' | 'Int' | 'Float' | 'Boolean' | 'DateTime' | 'Null' | 'Any';
-
-BuiltinType returns string:
-    'String'|'Boolean'|'Int'|'BigInt'|'Float'|'Decimal'|'DateTime'|'Json'|'Bytes';
-
-hidden terminal WS: /\s+/;
-terminal BOOLEAN returns boolean: /true|false/;
-terminal NULL: 'null';
-terminal THIS: 'this';
-terminal ID: /[_a-zA-Z][\w_]*/;
-terminal STRING: /"[^"]*"|'[^']*'/;
-terminal NUMBER returns number: /[+-]?[0-9]+(\.[0-9]+)?/;
-hidden terminal ML_COMMENT: /\/\*[\s\S]*?\*\//;
-hidden terminal SL_COMMENT: /\/\/[^\n\r]*/;

package/src/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/src/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/src/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/src/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/telemetry.ts

@@ -1,119 +0,0 @@
-import { Mixpanel, init } from 'mixpanel';
-import { TELEMETRY_TRACKING_TOKEN } from 'env';
-import { machineIdSync } from 'node-machine-id';
-import cuid from 'cuid';
-import * as os from 'os';
-import sleep from 'sleep-promise';
-import exitHook from 'async-exit-hook';
-import { CliError } from './cli/cli-error';
-import { CommanderError } from 'commander';
-
-/**
- * Telemetry events
- */
-export type TelemetryEvents =
-    | 'cli:start'
-    | 'cli:complete'
-    | 'cli:error'
-    | 'cli:command:start'
-    | 'cli:command:complete'
-    | 'cli:command:error'
-    | 'cli:generator:start'
-    | 'cli:generator:complete'
-    | 'cli:generator:error';
-
-/**
- * Utility class for sending telemetry
- */
-export class Telemetry {
-    private readonly mixpanel: Mixpanel | undefined;
-    private readonly hostId = machineIdSync();
-    private readonly sessionid = cuid();
-    private readonly trackingToken = TELEMETRY_TRACKING_TOKEN;
-    private readonly _os = os.platform();
-    // eslint-disable-next-line @typescript-eslint/no-var-requires
-    private readonly version = require('../package.json').version;
-    private exitWait = 200;
-
-    constructor() {
-        if (process.env.DO_NOT_TRACK !== '1' && this.trackingToken) {
-            this.mixpanel = init(this.trackingToken, {
-                geolocate: true,
-            });
-        }
-
-        exitHook(async (callback) => {
-            if (this.mixpanel) {
-                // a small delay to ensure telemetry is sent
-                await sleep(this.exitWait);
-            }
-            callback();
-        });
-
-        exitHook.uncaughtExceptionHandler(async (err) => {
-            this.track('cli:error', {
-                message: err.message,
-                stack: err.stack,
-            });
-            if (this.mixpanel) {
-                // a small delay to ensure telemetry is sent
-                await sleep(this.exitWait);
-            }
-
-            if (err instanceof CliError || err instanceof CommanderError) {
-                // error already handled
-            } else {
-                throw err;
-            }
-
-            process.exit(1);
-        });
-    }
-
-    track(event: TelemetryEvents, properties: Record<string, unknown> = {}) {
-        if (this.mixpanel) {
-            const payload = {
-                distinct_id: this.hostId,
-                session: this.sessionid,
-                time: new Date(),
-                $os: this._os,
-                nodeVersion: process.version,
-                version: this.version,
-                ...properties,
-            };
-            this.mixpanel.track(event, payload);
-        }
-    }
-
-    async trackSpan(
-        startEvent: TelemetryEvents,
-        completeEvent: TelemetryEvents,
-        errorEvent: TelemetryEvents,
-        properties: Record<string, unknown>,
-        action: () => Promise<unknown> | void
-    ) {
-        this.track(startEvent, properties);
-        const start = Date.now();
-        let success = true;
-        try {
-            await Promise.resolve(action());
-            // eslint-disable-next-line @typescript-eslint/no-explicit-any
-        } catch (err: any) {
-            this.track(errorEvent, {
-                message: err.message,
-                stack: err.stack,
-                ...properties,
-            });
-            success = false;
-            throw err;
-        } finally {
-            this.track(completeEvent, {
-                duration: Date.now() - start,
-                success,
-                ...properties,
-            });
-        }
-    }
-}
-
-export default new Telemetry();

package/src/utils/exec-utils.ts

@@ -1,8 +0,0 @@
-import { execSync as _exec } from 'child_process';
-
-/**
- * Utility for executing command synchronously and prints outputs on current console
- */
-export function execSync(cmd: string): void {
-    _exec(cmd, { encoding: 'utf-8', stdio: 'inherit' });
-}

package/src/utils/indent-string.ts

@@ -1,9 +0,0 @@
-// https://github.com/sindresorhus/indent-string
-
-/**
- * Utility for indenting strings
- */
-export default function indentString(string: string, count = 4): string {
-    const indent = ' ';
-    return string.replace(/^(?!\s*$)/gm, indent.repeat(count));
-}

package/src/utils/pkg-utils.ts

@@ -1,63 +0,0 @@
-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}" with ${manager}`);
-    switch (manager) {
-        case 'yarn':
-            execSync(
-                `yarn --cwd "${projectPath}" add ${pkg} ${
-                    dev ? ' --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);
-    }
-}