zenstack 0.6.0-pre.3 → 0.6.0-pre.5

package/res/package.template.json

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

package/res/prism-zmodel.js

@@ -0,0 +1,22 @@
+// 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/res/stdlib.zmodel

@@ -0,0 +1,218 @@
+/*
+ * 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/res/tsconfig.template.json

@@ -0,0 +1,17 @@
+{
+    "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"]
+}