@zenstackhq/language 3.0.0-alpha.3 → 3.0.0-alpha.31

package/res/stdlib.zmodel

@@ -25,7 +25,7 @@ enum ReferentialAction {
      * 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.
@@ -104,7 +104,7 @@ function ulid(): String {
 } @@@expressionContext([DefaultValue])
 
 /**
- * Creates a sequence of integers in the underlying database and assign the incremented 
+ * 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 {
@@ -174,9 +174,9 @@ function isEmpty(field: Any[]): Boolean {
 /**
  * The name of the model for which the policy rule is defined. If the rule is
  * inherited to a sub model, this function returns the name of the sub model.
- * 
+ *
  * @param optional parameter to control the casing of the returned value. Valid
- * values are "original", "upper", "lower", "capitalize", "uncapitalize". Defaults 
+ * values are "original", "upper", "lower", "capitalize", "uncapitalize". Defaults
  * to "original".
  */
 function currentModel(casing: String?): String {
@@ -186,7 +186,7 @@ function currentModel(casing: String?): String {
  * The operation for which the policy rule is defined for. Note that a rule with
  * "all" operation is expanded to "create", "read", "update", and "delete" rules,
  * and the function returns corresponding value for each expanded version.
- * 
+ *
  * @param optional parameter to control the casing of the returned value. Valid
  * values are "original", "upper", "lower", "capitalize", "uncapitalize". Defaults
  * to "original".
@@ -199,11 +199,6 @@ function currentOperation(casing: String?): String {
  */
 attribute @@@targetField(_ targetField: AttributeTargetField[])
 
-/**
- * Marks an attribute to be applicable to type defs and fields.
- */
-attribute @@@supportTypeDef()
-
 /**
  * Marks an attribute to be used for data validation.
  */
@@ -224,6 +219,11 @@ attribute @@@prisma()
  */
 attribute @@@completionHint(_ values: String[])
 
+/**
+ * Indicates that the attribute can only be applied once to a declaration.
+ */
+attribute @@@once()
+
 /**
  * Defines a single-field ID on the model.
  *
@@ -232,13 +232,13 @@ attribute @@@completionHint(_ values: String[])
  * @param sort: Allows you to specify in what order the entries of the ID are stored in the database. The available options are Asc and Desc.
  * @param clustered: Defines whether the ID is clustered or non-clustered. Defaults to true.
  */
-attribute @id(map: String?, length: Int?, sort: SortOrder?, clustered: Boolean?) @@@prisma @@@supportTypeDef
+attribute @id(map: String?, length: Int?, sort: SortOrder?, clustered: Boolean?) @@@prisma @@@once
 
 /**
  * Defines a default value for a field.
  * @param value: An expression (e.g. 5, true, now(), auth()).
  */
-attribute @default(_ value: ContextType, map: String?) @@@prisma @@@supportTypeDef
+attribute @default(_ value: ContextType, map: String?) @@@prisma
 
 /**
  * Defines a unique constraint for this field.
@@ -247,7 +247,7 @@ attribute @default(_ value: ContextType, map: String?) @@@prisma @@@supportTypeD
  * @param sort: Allows you to specify in what order the entries of the constraint are stored in the database. The available options are Asc and Desc.
  * @param clustered: Boolean	Defines whether the constraint is clustered or non-clustered. Defaults to false.
  */
-attribute @unique(map: String?, length: Int?, sort: SortOrder?, clustered: Boolean?) @@@prisma
+attribute @unique(map: String?, length: Int?, sort: SortOrder?, clustered: Boolean?) @@@prisma @@@once
 
 /**
  * Defines a multi-field ID (composite ID) on the model.
@@ -259,7 +259,7 @@ attribute @unique(map: String?, length: Int?, sort: SortOrder?, clustered: Boole
  * @param sort: Allows you to specify in what order the entries of the ID are stored in the database. The available options are Asc and Desc.
  * @param clustered: Defines whether the ID is clustered or non-clustered. Defaults to true.
  */
-attribute @@id(_ fields: FieldReference[], name: String?, map: String?, length: Int?, sort: SortOrder?, clustered: Boolean?) @@@prisma
+attribute @@id(_ fields: FieldReference[], name: String?, map: String?, length: Int?, sort: SortOrder?, clustered: Boolean?) @@@prisma @@@once
 
 /**
  * Defines a compound unique constraint for the specified fields.
@@ -424,25 +424,12 @@ attribute @@fulltext(_ fields: FieldReference[], map: String?) @@@prisma
 
 // String type modifiers
 
-enum MSSQLServerTypes {
-    Max
-}
-
-attribute @db.String(_ x: Int?) @@@targetField([StringField]) @@@prisma
 attribute @db.Text() @@@targetField([StringField]) @@@prisma
-attribute @db.NText() @@@targetField([StringField]) @@@prisma
 attribute @db.Char(_ x: Int?) @@@targetField([StringField]) @@@prisma
-attribute @db.NChar(_ x: Int?) @@@targetField([StringField]) @@@prisma
 attribute @db.VarChar(_ x: Any?) @@@targetField([StringField]) @@@prisma
-attribute @db.NVarChar(_ x: Any?) @@@targetField([StringField]) @@@prisma
-attribute @db.CatalogSingleChar() @@@targetField([StringField]) @@@prisma
-attribute @db.TinyText() @@@targetField([StringField]) @@@prisma
-attribute @db.MediumText() @@@targetField([StringField]) @@@prisma
-attribute @db.LongText() @@@targetField([StringField]) @@@prisma
 attribute @db.Bit(_ x: Int?) @@@targetField([StringField, BooleanField, BytesField]) @@@prisma
 attribute @db.VarBit(_ x: Int?) @@@targetField([StringField]) @@@prisma
 attribute @db.Uuid() @@@targetField([StringField]) @@@prisma
-attribute @db.UniqueIdentifier() @@@targetField([StringField]) @@@prisma
 attribute @db.Xml() @@@targetField([StringField]) @@@prisma
 attribute @db.Inet() @@@targetField([StringField]) @@@prisma
 attribute @db.Citext() @@@targetField([StringField]) @@@prisma
@@ -450,8 +437,6 @@ attribute @db.Citext() @@@targetField([StringField]) @@@prisma
 // Boolean type modifiers
 
 attribute @db.Boolean() @@@targetField([BooleanField]) @@@prisma
-attribute @db.TinyInt(_ x: Int?) @@@targetField([BooleanField, IntField]) @@@prisma
-attribute @db.Bool() @@@targetField([BooleanField]) @@@prisma
 
 // Int type modifiers
 
@@ -459,38 +444,19 @@ attribute @db.Int() @@@targetField([IntField]) @@@prisma
 attribute @db.Integer() @@@targetField([IntField]) @@@prisma
 attribute @db.SmallInt() @@@targetField([IntField]) @@@prisma
 attribute @db.Oid() @@@targetField([IntField]) @@@prisma
-attribute @db.UnsignedInt() @@@targetField([IntField]) @@@prisma
-attribute @db.UnsignedSmallInt() @@@targetField([IntField]) @@@prisma
-attribute @db.MediumInt() @@@targetField([IntField]) @@@prisma
-attribute @db.UnsignedMediumInt() @@@targetField([IntField]) @@@prisma
-attribute @db.UnsignedTinyInt() @@@targetField([IntField]) @@@prisma
-attribute @db.Year() @@@targetField([IntField]) @@@prisma
-attribute @db.Int4() @@@targetField([IntField]) @@@prisma
-attribute @db.Int2() @@@targetField([IntField]) @@@prisma
 
 // BigInt type modifiers
 
 attribute @db.BigInt() @@@targetField([BigIntField]) @@@prisma
-attribute @db.UnsignedBigInt() @@@targetField([BigIntField]) @@@prisma
-attribute @db.Int8() @@@targetField([BigIntField]) @@@prisma
 
 // Float/Decimal type modifiers
 attribute @db.DoublePrecision() @@@targetField([FloatField, DecimalField]) @@@prisma
 attribute @db.Real() @@@targetField([FloatField, DecimalField]) @@@prisma
-attribute @db.Float() @@@targetField([FloatField, DecimalField]) @@@prisma
 attribute @db.Decimal(_ p: Int?, _ s: Int?) @@@targetField([FloatField, DecimalField]) @@@prisma
-attribute @db.Double() @@@targetField([FloatField, DecimalField]) @@@prisma
 attribute @db.Money() @@@targetField([FloatField, DecimalField]) @@@prisma
-attribute @db.SmallMoney() @@@targetField([FloatField, DecimalField]) @@@prisma
-attribute @db.Float8() @@@targetField([FloatField, DecimalField]) @@@prisma
-attribute @db.Float4() @@@targetField([FloatField, DecimalField]) @@@prisma
 
 // DateTime type modifiers
 
-attribute @db.DateTime(_ x: Int?) @@@targetField([DateTimeField]) @@@prisma
-attribute @db.DateTime2() @@@targetField([DateTimeField]) @@@prisma
-attribute @db.SmallDateTime() @@@targetField([DateTimeField]) @@@prisma
-attribute @db.DateTimeOffset() @@@targetField([DateTimeField]) @@@prisma
 attribute @db.Timestamp(_ x: Int?) @@@targetField([DateTimeField]) @@@prisma
 attribute @db.Timestamptz(_ x: Int?) @@@targetField([DateTimeField]) @@@prisma
 attribute @db.Date() @@@targetField([DateTimeField]) @@@prisma
@@ -504,49 +470,14 @@ attribute @db.JsonB() @@@targetField([JsonField]) @@@prisma
 
 // Bytes type modifiers
 
-attribute @db.Bytes() @@@targetField([BytesField]) @@@prisma
 attribute @db.ByteA() @@@targetField([BytesField]) @@@prisma
-attribute @db.LongBlob() @@@targetField([BytesField]) @@@prisma
-attribute @db.Binary() @@@targetField([BytesField]) @@@prisma
-attribute @db.VarBinary(_ x: Int?) @@@targetField([BytesField]) @@@prisma
-attribute @db.TinyBlob() @@@targetField([BytesField]) @@@prisma
-attribute @db.Blob() @@@targetField([BytesField]) @@@prisma
-attribute @db.MediumBlob() @@@targetField([BytesField]) @@@prisma
-attribute @db.Image() @@@targetField([BytesField]) @@@prisma
-
-/**
- * Specifies the schema to use in a multi-schema database. https://www.prisma.io/docs/guides/database/multi-schema.
- *
- * @param: The name of the database schema.
- */
-attribute @@schema(_ name: String) @@@prisma
-
-/**
- * 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
- * 
- * @param saltLength: length of salt to use (cost factor for the hash function)
- * @param salt: salt to use (a pregenerated valid salt)
- */
-attribute @password(saltLength: Int?, salt: String?) @@@targetField([StringField])
-
 
-/**
- * Indicates that the field is encrypted when storing in the DB and should be decrypted when read
- * 
- * ZenStack uses the Web Crypto API to encrypt and decrypt the field. 
- */
-attribute @encrypted() @@@targetField([StringField])
-
-/**
- * Indicates that the field should be omitted when read from the generated services.
- */
-attribute @omit()
+// /**
+//  * Specifies the schema to use in a multi-schema database. https://www.prisma.io/docs/guides/database/multi-schema.
+//  *
+//  * @param: The name of the database schema.
+//  */
+// attribute @@schema(_ name: String) @@@prisma
 
 //////////////////////////////////////////////
 // Begin validation attributes and functions
@@ -555,82 +486,82 @@ attribute @omit()
 /**
  * Validates length of a string field.
  */
-attribute @length(_ min: Int?, _ max: Int?, _ message: String?) @@@targetField([StringField]) @@@validation @@@supportTypeDef
+attribute @length(_ min: Int?, _ max: Int?, _ message: String?) @@@targetField([StringField]) @@@validation
 
 /**
  * Validates a string field value starts with the given text.
  */
-attribute @startsWith(_ text: String, _ message: String?) @@@targetField([StringField]) @@@validation @@@supportTypeDef
+attribute @startsWith(_ text: String, _ message: String?) @@@targetField([StringField]) @@@validation
 
 /**
  * Validates a string field value ends with the given text.
  */
-attribute @endsWith(_ text: String, _ message: String?) @@@targetField([StringField]) @@@validation @@@supportTypeDef
+attribute @endsWith(_ text: String, _ message: String?) @@@targetField([StringField]) @@@validation
 
 /**
  * Validates a string field value contains the given text.
  */
-attribute @contains(_ text: String, _ message: String?) @@@targetField([StringField]) @@@validation @@@supportTypeDef
+attribute @contains(_ text: String, _ message: String?) @@@targetField([StringField]) @@@validation
 
 /**
  * Validates a string field value matches a regex.
  */
-attribute @regex(_ regex: String, _ message: String?) @@@targetField([StringField]) @@@validation @@@supportTypeDef
+attribute @regex(_ regex: String, _ message: String?) @@@targetField([StringField]) @@@validation
 
 /**
  * Validates a string field value is a valid email address.
  */
-attribute @email(_ message: String?) @@@targetField([StringField]) @@@validation @@@supportTypeDef
+attribute @email(_ message: String?) @@@targetField([StringField]) @@@validation
 
 /**
  * Validates a string field value is a valid ISO datetime.
  */
-attribute @datetime(_ message: String?) @@@targetField([StringField]) @@@validation @@@supportTypeDef
+attribute @datetime(_ message: String?) @@@targetField([StringField]) @@@validation
 
 /**
  * Validates a string field value is a valid url.
  */
-attribute @url(_ message: String?) @@@targetField([StringField]) @@@validation @@@supportTypeDef
+attribute @url(_ message: String?) @@@targetField([StringField]) @@@validation
 
 /**
  * Trims whitespaces from the start and end of the string.
  */
-attribute @trim() @@@targetField([StringField]) @@@validation @@@supportTypeDef
+attribute @trim() @@@targetField([StringField]) @@@validation
 
 /**
  * Transform entire string toLowerCase.
  */
-attribute @lower() @@@targetField([StringField]) @@@validation @@@supportTypeDef
+attribute @lower() @@@targetField([StringField]) @@@validation
 
 /**
  * Transform entire string toUpperCase.
  */
-attribute @upper() @@@targetField([StringField]) @@@validation @@@supportTypeDef
+attribute @upper() @@@targetField([StringField]) @@@validation
 
 /**
  * Validates a number field is greater than the given value.
  */
-attribute @gt(_ value: Int, _ message: String?) @@@targetField([IntField, FloatField, DecimalField]) @@@validation @@@supportTypeDef
+attribute @gt(_ value: Int, _ message: String?) @@@targetField([IntField, FloatField, DecimalField]) @@@validation
 
 /**
  * Validates a number field is greater than or equal to the given value.
  */
-attribute @gte(_ value: Int, _ message: String?) @@@targetField([IntField, FloatField, DecimalField]) @@@validation @@@supportTypeDef
+attribute @gte(_ value: Int, _ message: String?) @@@targetField([IntField, FloatField, DecimalField]) @@@validation
 
 /**
  * Validates a number field is less than the given value.
  */
-attribute @lt(_ value: Int, _ message: String?) @@@targetField([IntField, FloatField, DecimalField]) @@@validation @@@supportTypeDef
+attribute @lt(_ value: Int, _ message: String?) @@@targetField([IntField, FloatField, DecimalField]) @@@validation
 
 /**
  * Validates a number field is less than or equal to the given value.
  */
-attribute @lte(_ value: Int, _ message: String?) @@@targetField([IntField, FloatField, DecimalField]) @@@validation @@@supportTypeDef
+attribute @lte(_ value: Int, _ message: String?) @@@targetField([IntField, FloatField, DecimalField]) @@@validation
 
 /**
  * Validates the entity with a complex condition.
  */
-attribute @@validate(_ value: Boolean, _ message: String?, _ path: String[]?) @@@validation @@@supportTypeDef
+attribute @@validate(_ value: Boolean, _ message: String?, _ path: String[]?) @@@validation
 
 /**
  * Validates length of a string field.
@@ -665,9 +596,9 @@ function url(field: String): Boolean {
 
 /**
  * Checks if the current user can perform the given operation on the given field.
- * 
+ *
  * @param field: The field to check access for
- * @param operation: The operation to check access for. Can be "read", "create", "update", or "delete". If the operation is not provided, 
+ * @param operation: The operation to check access for. Can be "read", "create", "update", or "delete". If the operation is not provided,
  * it defaults the operation of the containing policy rule.
  */
 function check(field: Any, operation: String?): Boolean {
@@ -718,4 +649,19 @@ function auth(): Any {
  * Used to specify the model for resolving `auth()` function call in access policies. A Zmodel
  * can have at most one model with this attribute. By default, the model named "User" is used.
  */
-attribute @@auth() @@@supportTypeDef
+attribute @@auth()
+
+/**
+ * Attaches arbitrary metadata to a model or type def.
+ */
+attribute @@meta(_ name: String, _ value: Any)
+
+/**
+ * Attaches arbitrary metadata to a field.
+ */
+attribute @meta(_ name: String, _ value: Any)
+
+/**
+ * Marks an attribute as deprecated.
+ */
+attribute @@@deprecated(_ message: String)