appwrite-utils-cli 0.10.85 → 1.0.1

package/.appwrite/.yaml_schemas/appwrite-config.schema.json

@@ -0,0 +1,380 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://appwrite-utils.dev/schemas/appwrite-config.schema.json",
+  "title": "Appwrite Configuration",
+  "description": "Schema for Appwrite project configuration in YAML",
+  "type": "object",
+  "properties": {
+    "appwrite": {
+      "type": "object",
+      "description": "Appwrite connection settings",
+      "properties": {
+        "endpoint": {
+          "type": "string",
+          "default": "https://cloud.appwrite.io/v1",
+          "description": "Appwrite server endpoint URL"
+        },
+        "project": {
+          "type": "string",
+          "description": "Appwrite project ID"
+        },
+        "key": {
+          "type": "string",
+          "description": "Appwrite API key with appropriate permissions"
+        }
+      },
+      "required": [
+        "project",
+        "key"
+      ],
+      "additionalProperties": false
+    },
+    "logging": {
+      "type": "object",
+      "description": "Logging configuration",
+      "properties": {
+        "enabled": {
+          "type": "boolean",
+          "default": false,
+          "description": "Enable file logging"
+        },
+        "level": {
+          "type": "string",
+          "enum": [
+            "error",
+            "warn",
+            "info",
+            "debug"
+          ],
+          "default": "info",
+          "description": "Logging level"
+        },
+        "directory": {
+          "type": "string",
+          "description": "Custom log directory path (optional)"
+        },
+        "console": {
+          "type": "boolean",
+          "default": false,
+          "description": "Enable console logging"
+        }
+      },
+      "additionalProperties": false
+    },
+    "backups": {
+      "type": "object",
+      "description": "Backup configuration",
+      "properties": {
+        "enabled": {
+          "type": "boolean",
+          "default": true,
+          "description": "Enable automatic backups"
+        },
+        "interval": {
+          "type": "number",
+          "default": 3600,
+          "description": "Backup interval in seconds"
+        },
+        "retention": {
+          "type": "number",
+          "default": 30,
+          "description": "Backup retention in days"
+        },
+        "cleanup": {
+          "type": "boolean",
+          "default": true,
+          "description": "Enable automatic backup cleanup"
+        }
+      },
+      "additionalProperties": false
+    },
+    "data": {
+      "type": "object",
+      "description": "Data management settings",
+      "properties": {
+        "enableMockData": {
+          "type": "boolean",
+          "default": false,
+          "description": "Enable mock data generation"
+        },
+        "documentBucketId": {
+          "type": "string",
+          "default": "documents",
+          "description": "Default bucket ID for document attachments"
+        },
+        "usersCollectionName": {
+          "type": "string",
+          "default": "Members",
+          "description": "Name of the users/members collection"
+        },
+        "importDirectory": {
+          "type": "string",
+          "default": "importData",
+          "description": "Directory containing import data files"
+        }
+      },
+      "additionalProperties": false
+    },
+    "schemas": {
+      "type": "object",
+      "description": "Schema generation settings",
+      "properties": {
+        "outputDirectory": {
+          "type": "string",
+          "default": "schemas",
+          "description": "Directory where generated schemas are saved"
+        },
+        "yamlSchemaDirectory": {
+          "type": "string",
+          "default": ".yaml_schemas",
+          "description": "Directory containing YAML validation schemas"
+        }
+      },
+      "additionalProperties": false
+    },
+    "migrations": {
+      "type": "object",
+      "description": "Migration settings",
+      "properties": {
+        "enabled": {
+          "type": "boolean",
+          "default": true,
+          "description": "Enable migration tracking database"
+        }
+      },
+      "additionalProperties": false
+    },
+    "databases": {
+      "type": "array",
+      "description": "Database configurations",
+      "items": {
+        "type": "object",
+        "properties": {
+          "id": {
+            "type": "string",
+            "description": "Database ID",
+            "pattern": "^[a-zA-Z0-9][a-zA-Z0-9._-]{0,35}$"
+          },
+          "name": {
+            "type": "string",
+            "description": "Database display name"
+          },
+          "bucket": {
+            "type": "object",
+            "description": "Associated storage bucket",
+            "properties": {
+              "id": {
+                "type": "string",
+                "description": "Bucket ID"
+              },
+              "name": {
+                "type": "string",
+                "description": "Bucket display name"
+              },
+              "permissions": {
+                "type": "array",
+                "items": {
+                  "type": "string"
+                },
+                "description": "Bucket permissions"
+              },
+              "fileSecurity": {
+                "type": "boolean",
+                "description": "Enable file-level security"
+              },
+              "enabled": {
+                "type": "boolean",
+                "default": true,
+                "description": "Enable the bucket"
+              },
+              "maximumFileSize": {
+                "type": "number",
+                "default": 30000000,
+                "description": "Maximum file size in bytes"
+              },
+              "allowedFileExtensions": {
+                "type": "array",
+                "items": {
+                  "type": "string"
+                },
+                "description": "Allowed file extensions (empty = all allowed)"
+              },
+              "compression": {
+                "type": "string",
+                "enum": [
+                  "none",
+                  "gzip",
+                  "zstd"
+                ],
+                "default": "none",
+                "description": "Compression algorithm"
+              },
+              "encryption": {
+                "type": "boolean",
+                "default": false,
+                "description": "Enable file encryption"
+              },
+              "antivirus": {
+                "type": "boolean",
+                "default": false,
+                "description": "Enable antivirus scanning"
+              }
+            },
+            "required": [
+              "id",
+              "name"
+            ],
+            "additionalProperties": false
+          }
+        },
+        "required": [
+          "id",
+          "name"
+        ],
+        "additionalProperties": false
+      }
+    },
+    "buckets": {
+      "type": "array",
+      "description": "Global storage buckets",
+      "items": {
+        "type": "object",
+        "properties": {
+          "id": {
+            "type": "string",
+            "description": "Bucket ID"
+          },
+          "name": {
+            "type": "string",
+            "description": "Bucket display name"
+          },
+          "permissions": {
+            "type": "array",
+            "items": {
+              "type": "string"
+            },
+            "description": "Bucket permissions"
+          },
+          "fileSecurity": {
+            "type": "boolean",
+            "description": "Enable file-level security"
+          },
+          "enabled": {
+            "type": "boolean",
+            "default": true,
+            "description": "Enable the bucket"
+          },
+          "maximumFileSize": {
+            "type": "number",
+            "default": 30000000,
+            "description": "Maximum file size in bytes"
+          },
+          "allowedFileExtensions": {
+            "type": "array",
+            "items": {
+              "type": "string"
+            },
+            "description": "Allowed file extensions (empty = all allowed)"
+          },
+          "compression": {
+            "type": "string",
+            "enum": [
+              "none",
+              "gzip",
+              "zstd"
+            ],
+            "default": "none",
+            "description": "Compression algorithm"
+          },
+          "encryption": {
+            "type": "boolean",
+            "default": false,
+            "description": "Enable file encryption"
+          },
+          "antivirus": {
+            "type": "boolean",
+            "default": false,
+            "description": "Enable antivirus scanning"
+          }
+        },
+        "required": [
+          "id",
+          "name"
+        ],
+        "additionalProperties": false
+      }
+    },
+    "functions": {
+      "type": "array",
+      "description": "Appwrite Functions",
+      "items": {
+        "type": "object",
+        "properties": {
+          "id": {
+            "type": "string",
+            "description": "Function ID"
+          },
+          "name": {
+            "type": "string",
+            "description": "Function name"
+          },
+          "runtime": {
+            "type": "string",
+            "description": "Runtime environment"
+          },
+          "execute": {
+            "type": "array",
+            "items": {
+              "type": "string"
+            },
+            "description": "Execution permissions"
+          },
+          "events": {
+            "type": "array",
+            "items": {
+              "type": "string"
+            },
+            "description": "Event triggers"
+          },
+          "schedule": {
+            "type": "string",
+            "description": "Cron schedule"
+          },
+          "timeout": {
+            "type": "number",
+            "default": 15,
+            "description": "Execution timeout in seconds"
+          },
+          "enabled": {
+            "type": "boolean",
+            "default": true,
+            "description": "Enable the function"
+          },
+          "logging": {
+            "type": "boolean",
+            "default": true,
+            "description": "Enable function logging"
+          },
+          "entrypoint": {
+            "type": "string",
+            "description": "Function entrypoint file"
+          },
+          "commands": {
+            "type": "string",
+            "description": "Build commands"
+          }
+        },
+        "required": [
+          "id",
+          "name",
+          "runtime"
+        ],
+        "additionalProperties": false
+      }
+    }
+  },
+  "required": [
+    "appwrite"
+  ],
+  "additionalProperties": false
+}

package/.appwrite/.yaml_schemas/collection.schema.json

@@ -0,0 +1,255 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://appwrite-utils.dev/schemas/collection.schema.json",
+  "title": "Appwrite Collection Definition",
+  "description": "Schema for defining Appwrite collections in YAML",
+  "type": "object",
+  "properties": {
+    "name": {
+      "type": "string",
+      "description": "The name of the collection"
+    },
+    "id": {
+      "type": "string",
+      "description": "The ID of the collection (optional, auto-generated if not provided)",
+      "pattern": "^[a-zA-Z0-9][a-zA-Z0-9._-]{0,35}$"
+    },
+    "documentSecurity": {
+      "type": "boolean",
+      "default": false,
+      "description": "Enable document-level permissions"
+    },
+    "enabled": {
+      "type": "boolean",
+      "default": true,
+      "description": "Whether the collection is enabled"
+    },
+    "permissions": {
+      "type": "array",
+      "description": "Collection-level permissions",
+      "items": {
+        "type": "object",
+        "properties": {
+          "permission": {
+            "type": "string",
+            "enum": [
+              "read",
+              "create",
+              "update",
+              "delete"
+            ],
+            "description": "The permission type"
+          },
+          "target": {
+            "type": "string",
+            "description": "Permission target (e.g., 'any', 'users', 'users/verified', 'label:admin')"
+          }
+        },
+        "required": [
+          "permission",
+          "target"
+        ],
+        "additionalProperties": false
+      }
+    },
+    "attributes": {
+      "type": "array",
+      "description": "Collection attributes (fields)",
+      "items": {
+        "type": "object",
+        "properties": {
+          "key": {
+            "type": "string",
+            "description": "Attribute name",
+            "pattern": "^[a-zA-Z][a-zA-Z0-9]*$"
+          },
+          "type": {
+            "type": "string",
+            "enum": [
+              "string",
+              "integer",
+              "float",
+              "boolean",
+              "datetime",
+              "email",
+              "ip",
+              "url",
+              "enum",
+              "relationship"
+            ],
+            "description": "Attribute data type"
+          },
+          "size": {
+            "type": "number",
+            "description": "Maximum size for string attributes",
+            "minimum": 1,
+            "maximum": 1073741824
+          },
+          "required": {
+            "type": "boolean",
+            "default": false,
+            "description": "Whether the attribute is required"
+          },
+          "array": {
+            "type": "boolean",
+            "default": false,
+            "description": "Whether the attribute is an array"
+          },
+          "default": {
+            "description": "Default value for the attribute"
+          },
+          "description": {
+            "type": "string",
+            "description": "Attribute description"
+          },
+          "min": {
+            "type": "number",
+            "description": "Minimum value for numeric attributes"
+          },
+          "max": {
+            "type": "number",
+            "description": "Maximum value for numeric attributes"
+          },
+          "elements": {
+            "type": "array",
+            "items": {
+              "type": "string"
+            },
+            "description": "Allowed values for enum attributes"
+          },
+          "relatedCollection": {
+            "type": "string",
+            "description": "Related collection name for relationship attributes"
+          },
+          "relationType": {
+            "type": "string",
+            "enum": [
+              "oneToOne",
+              "oneToMany",
+              "manyToOne",
+              "manyToMany"
+            ],
+            "description": "Type of relationship"
+          },
+          "twoWay": {
+            "type": "boolean",
+            "description": "Whether the relationship is bidirectional"
+          },
+          "twoWayKey": {
+            "type": "string",
+            "description": "Key name for the reverse relationship"
+          },
+          "onDelete": {
+            "type": "string",
+            "enum": [
+              "cascade",
+              "restrict",
+              "setNull"
+            ],
+            "description": "Action to take when related document is deleted"
+          },
+          "side": {
+            "type": "string",
+            "enum": [
+              "parent",
+              "child"
+            ],
+            "description": "Side of the relationship"
+          }
+        },
+        "required": [
+          "key",
+          "type"
+        ],
+        "additionalProperties": false,
+        "allOf": [
+          {
+            "if": {
+              "properties": {
+                "type": {
+                  "const": "enum"
+                }
+              }
+            },
+            "then": {
+              "required": [
+                "elements"
+              ]
+            }
+          },
+          {
+            "if": {
+              "properties": {
+                "type": {
+                  "const": "relationship"
+                }
+              }
+            },
+            "then": {
+              "required": [
+                "relatedCollection",
+                "relationType"
+              ]
+            }
+          }
+        ]
+      }
+    },
+    "indexes": {
+      "type": "array",
+      "description": "Database indexes for the collection",
+      "items": {
+        "type": "object",
+        "properties": {
+          "key": {
+            "type": "string",
+            "description": "Index name"
+          },
+          "type": {
+            "type": "string",
+            "enum": [
+              "key",
+              "fulltext",
+              "unique"
+            ],
+            "description": "Index type"
+          },
+          "attributes": {
+            "type": "array",
+            "items": {
+              "type": "string"
+            },
+            "description": "Attributes to index",
+            "minItems": 1
+          },
+          "orders": {
+            "type": "array",
+            "items": {
+              "type": "string",
+              "enum": [
+                "ASC",
+                "DESC"
+              ]
+            },
+            "description": "Sort order for each attribute"
+          }
+        },
+        "required": [
+          "key",
+          "type",
+          "attributes"
+        ],
+        "additionalProperties": false
+      }
+    },
+    "importDefs": {
+      "type": "array",
+      "description": "Import definitions for data migration",
+      "default": []
+    }
+  },
+  "required": [
+    "name"
+  ],
+  "additionalProperties": false
+}