appwrite-utils-cli 1.9.6 → 1.11.0

package/src/functions/templates/uv/pyproject.toml

@@ -1,30 +1,30 @@
-[project]
-name = "{{functionName}}"
-version = "0.1.0"
-description = "Appwrite Python function using UV"
-authors = [{name = "Your Name", email = "you@example.com"}]
-readme = "README.md"
-requires-python = ">=3.9"
-dependencies = [
-    "appwrite>=7.0.1",
-    "pydantic>=2.0.0",
-]
-
-[build-system]
-requires = ["hatchling"]
-build-backend = "hatchling.build"
-
-[tool.uv]
-dev-dependencies = [
-    "pytest>=7.0.0",
-    "black>=23.0.0",
-    "ruff>=0.1.0",
-]
-
-[tool.ruff]
-line-length = 88
-target-version = "py39"
-
-[tool.ruff.lint]
-select = ["E", "F", "W", "I"]
+[project]
+name = "{{functionName}}"
+version = "0.1.0"
+description = "Appwrite Python function using UV"
+authors = [{name = "Your Name", email = "you@example.com"}]
+readme = "README.md"
+requires-python = ">=3.9"
+dependencies = [
+    "appwrite>=7.0.1",
+    "pydantic>=2.0.0",
+]
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.uv]
+dev-dependencies = [
+    "pytest>=7.0.0",
+    "black>=23.0.0",
+    "ruff>=0.1.0",
+]
+
+[tool.ruff]
+line-length = 88
+target-version = "py39"
+
+[tool.ruff.lint]
+select = ["E", "F", "W", "I"]
 ignore = ["E501"]

package/src/functions/templates/uv/src/context.py

@@ -1,125 +1,125 @@
-from collections.abc import Callable
-from typing import Any, Literal, Protocol
-
-from pydantic import BaseModel, Field
-
-
-class AppwriteHeaders(BaseModel):
-    """Appwrite request headers"""
-
-    x_appwrite_trigger: Literal["http", "schedule", "event"] | None = Field(
-        None, alias="x-appwrite-trigger"
-    )
-    x_appwrite_event: str | None = Field(None, alias="x-appwrite-event")
-    x_appwrite_key: str | None = Field(None, alias="x-appwrite-key")
-    x_appwrite_user_id: str | None = Field(None, alias="x-appwrite-user-id")
-    x_appwrite_user_jwt: str | None = Field(None, alias="x-appwrite-user-jwt")
-    x_appwrite_country_code: str | None = Field(None, alias="x-appwrite-country-code")
-    x_appwrite_continent_code: str | None = Field(
-        None, alias="x-appwrite-continent-code"
-    )
-    x_appwrite_continent_eu: str | None = Field(None, alias="x-appwrite-continent-eu")
-
-    # Allow additional headers
-    model_config = {"extra": "allow", "populate_by_name": True}
-
-
-class AppwriteEnv(BaseModel):
-    """Appwrite environment variables"""
-
-    APPWRITE_FUNCTION_API_ENDPOINT: str
-    APPWRITE_VERSION: str
-    APPWRITE_REGION: str
-    APPWRITE_FUNCTION_API_KEY: str | None = None
-    APPWRITE_FUNCTION_ID: str
-    APPWRITE_FUNCTION_NAME: str
-    APPWRITE_FUNCTION_DEPLOYMENT: str
-    APPWRITE_FUNCTION_PROJECT_ID: str
-    APPWRITE_FUNCTION_RUNTIME_NAME: str
-    APPWRITE_FUNCTION_RUNTIME_VERSION: str
-
-
-class AppwriteRequest(Protocol):
-    """Appwrite function request object with proper callable typing"""
-
-    bodyText: str | None
-    bodyJson: dict[str, Any] | str | None
-    body: Any
-    headers: dict[str, str]
-    scheme: Literal["http", "https"] | None
-    method: Literal["GET", "POST", "PUT", "DELETE", "PATCH", "OPTIONS", "HEAD"]
-    url: str | None
-    host: str | None
-    port: int | str | None
-    path: str | None
-    queryString: str | None
-    query: dict[str, str | list[str]] | None
-    variables: dict[str, str] | None
-    payload: str | None
-
-    async def text(self) -> str: ...
-
-
-class AppwriteResponse(Protocol):
-    """Appwrite function response object with proper callable typing"""
-
-    def json(
-        self,
-        data: Any,
-        status: int | None = None,
-        headers: dict[str, str] | None = None,
-    ) -> None: ...
-
-    def text(
-        self,
-        body: str,
-        status: int | None = None,
-        headers: dict[str, str] | None = None,
-    ) -> None: ...
-
-    def empty(self) -> None: ...
-
-    def binary(self, data: bytes) -> None: ...
-
-    def redirect(self, url: str, status: int | None = None) -> None: ...
-
-
-class AppwriteContext(Protocol):
-    """Complete Appwrite function context with proper typing"""
-
-    req: AppwriteRequest
-    res: AppwriteResponse
-
-    def log(self, message: str) -> None: ...
-
-    def error(self, message: str) -> None: ...
-
-
-# Alternative: BaseModel version for cases where you need Pydantic features
-# but want proper typing hints
-
-
-class AppwriteRequestModel(BaseModel):
-    """Pydantic model for request validation (if needed)"""
-
-    bodyText: str | None = None
-    bodyJson: dict[str, Any] | str | None = None
-    body: Any = None
-    headers: dict[str, str] = Field(default_factory=dict)
-    scheme: Literal["http", "https"] | None = None
-    method: Literal["GET", "POST", "PUT", "DELETE", "PATCH", "OPTIONS", "HEAD"]
-    url: str | None = None
-    host: str | None = None
-    port: int | str | None = None
-    path: str | None = None
-    queryString: str | None = None
-    query: dict[str, str | list[str]] | None = None
-    variables: dict[str, str] | None = None
-    payload: str | None = None
-
-    model_config = {"arbitrary_types_allowed": True}
-
-
-# Type alias for the log/error functions
-LogFunction = Callable[[str], None]
+from collections.abc import Callable
+from typing import Any, Literal, Protocol
+
+from pydantic import BaseModel, Field
+
+
+class AppwriteHeaders(BaseModel):
+    """Appwrite request headers"""
+
+    x_appwrite_trigger: Literal["http", "schedule", "event"] | None = Field(
+        None, alias="x-appwrite-trigger"
+    )
+    x_appwrite_event: str | None = Field(None, alias="x-appwrite-event")
+    x_appwrite_key: str | None = Field(None, alias="x-appwrite-key")
+    x_appwrite_user_id: str | None = Field(None, alias="x-appwrite-user-id")
+    x_appwrite_user_jwt: str | None = Field(None, alias="x-appwrite-user-jwt")
+    x_appwrite_country_code: str | None = Field(None, alias="x-appwrite-country-code")
+    x_appwrite_continent_code: str | None = Field(
+        None, alias="x-appwrite-continent-code"
+    )
+    x_appwrite_continent_eu: str | None = Field(None, alias="x-appwrite-continent-eu")
+
+    # Allow additional headers
+    model_config = {"extra": "allow", "populate_by_name": True}
+
+
+class AppwriteEnv(BaseModel):
+    """Appwrite environment variables"""
+
+    APPWRITE_FUNCTION_API_ENDPOINT: str
+    APPWRITE_VERSION: str
+    APPWRITE_REGION: str
+    APPWRITE_FUNCTION_API_KEY: str | None = None
+    APPWRITE_FUNCTION_ID: str
+    APPWRITE_FUNCTION_NAME: str
+    APPWRITE_FUNCTION_DEPLOYMENT: str
+    APPWRITE_FUNCTION_PROJECT_ID: str
+    APPWRITE_FUNCTION_RUNTIME_NAME: str
+    APPWRITE_FUNCTION_RUNTIME_VERSION: str
+
+
+class AppwriteRequest(Protocol):
+    """Appwrite function request object with proper callable typing"""
+
+    bodyText: str | None
+    bodyJson: dict[str, Any] | str | None
+    body: Any
+    headers: dict[str, str]
+    scheme: Literal["http", "https"] | None
+    method: Literal["GET", "POST", "PUT", "DELETE", "PATCH", "OPTIONS", "HEAD"]
+    url: str | None
+    host: str | None
+    port: int | str | None
+    path: str | None
+    queryString: str | None
+    query: dict[str, str | list[str]] | None
+    variables: dict[str, str] | None
+    payload: str | None
+
+    async def text(self) -> str: ...
+
+
+class AppwriteResponse(Protocol):
+    """Appwrite function response object with proper callable typing"""
+
+    def json(
+        self,
+        data: Any,
+        status: int | None = None,
+        headers: dict[str, str] | None = None,
+    ) -> None: ...
+
+    def text(
+        self,
+        body: str,
+        status: int | None = None,
+        headers: dict[str, str] | None = None,
+    ) -> None: ...
+
+    def empty(self) -> None: ...
+
+    def binary(self, data: bytes) -> None: ...
+
+    def redirect(self, url: str, status: int | None = None) -> None: ...
+
+
+class AppwriteContext(Protocol):
+    """Complete Appwrite function context with proper typing"""
+
+    req: AppwriteRequest
+    res: AppwriteResponse
+
+    def log(self, message: str) -> None: ...
+
+    def error(self, message: str) -> None: ...
+
+
+# Alternative: BaseModel version for cases where you need Pydantic features
+# but want proper typing hints
+
+
+class AppwriteRequestModel(BaseModel):
+    """Pydantic model for request validation (if needed)"""
+
+    bodyText: str | None = None
+    bodyJson: dict[str, Any] | str | None = None
+    body: Any = None
+    headers: dict[str, str] = Field(default_factory=dict)
+    scheme: Literal["http", "https"] | None = None
+    method: Literal["GET", "POST", "PUT", "DELETE", "PATCH", "OPTIONS", "HEAD"]
+    url: str | None = None
+    host: str | None = None
+    port: int | str | None = None
+    path: str | None = None
+    queryString: str | None = None
+    query: dict[str, str | list[str]] | None = None
+    variables: dict[str, str] | None = None
+    payload: str | None = None
+
+    model_config = {"arbitrary_types_allowed": True}
+
+
+# Type alias for the log/error functions
+LogFunction = Callable[[str], None]
 ErrorFunction = Callable[[str], None]

package/src/functions/templates/uv/src/{index.py → main.py}

@@ -1,46 +1,46 @@
-import os
-from appwrite.client import Client
-from context import AppwriteContext, AppwriteHeaders, AppwriteRequestModel
-
-def main(context: AppwriteContext):
-    req = context.req
-    res = context.res
-    log = context.log
-    error = context.error
-
-    # Optional: Validate request headers using Pydantic
-    try:
-        headers = AppwriteHeaders.model_validate(req.headers)
-        log("Headers validation successful")
-    except Exception as validation_error:
-        error(f"Headers validation failed: {validation_error}")
-
-    # Optional: Validate full request using Pydantic model
-    try:
-        request_model = AppwriteRequestModel.model_validate({
-            'method': req.method,
-            'headers': req.headers,
-            'path': req.path,
-            'url': req.url,
-            'body': req.body,
-            'bodyText': req.bodyText,
-            'bodyJson': req.bodyJson
-        })
-        log("Request validation successful")
-    except Exception as validation_error:
-        error(f"Request validation failed: {validation_error}")
-
-    client = Client()
-    client.set_endpoint(os.getenv('APPWRITE_FUNCTION_ENDPOINT'))
-    client.set_project(os.getenv('APPWRITE_FUNCTION_PROJECT_ID'))
-    client.set_key(os.getenv('APPWRITE_FUNCTION_API_KEY'))
-
-    log(f"Processing {req.method} request to {req.path}")
-
-    return res.json({
-        'message': 'Hello from Python function!',
-        'functionName': '{{functionName}}',
-        'method': req.method,
-        'path': req.path,
-        'headers': req.headers
+import os
+from appwrite.client import Client
+from context import AppwriteContext, AppwriteHeaders, AppwriteRequestModel
+
+def main(context: AppwriteContext):
+    req = context.req
+    res = context.res
+    log = context.log
+    error = context.error
+
+    # Optional: Validate request headers using Pydantic
+    try:
+        headers = AppwriteHeaders.model_validate(req.headers)
+        log("Headers validation successful")
+    except Exception as validation_error:
+        error(f"Headers validation failed: {validation_error}")
+
+    # Optional: Validate full request using Pydantic model
+    try:
+        request_model = AppwriteRequestModel.model_validate({
+            'method': req.method,
+            'headers': req.headers,
+            'path': req.path,
+            'url': req.url,
+            'body': req.body,
+            'bodyText': req.bodyText,
+            'bodyJson': req.bodyJson
+        })
+        log("Request validation successful")
+    except Exception as validation_error:
+        error(f"Request validation failed: {validation_error}")
+
+    client = Client()
+    client.set_endpoint(os.getenv('APPWRITE_FUNCTION_ENDPOINT'))
+    client.set_project(os.getenv('APPWRITE_FUNCTION_PROJECT_ID'))
+    client.set_key(os.getenv('APPWRITE_FUNCTION_API_KEY'))
+
+    log(f"Processing {req.method} request to {req.path}")
+
+    return res.json({
+        'message': 'Hello from Python function!',
+        'functionName': '{{functionName}}',
+        'method': req.method,
+        'path': req.path,
+        'headers': req.headers
     })

package/src/init.ts

@@ -1,62 +1,62 @@
-#!/usr/bin/env node
-import inquirer from "inquirer";
-import { createEmptyCollection, setupDirsFiles } from "./utils/setupFiles.js";
-import { MessageFormatter } from "./shared/messageFormatter.js";
-
-MessageFormatter.banner("Appwrite Utils CLI Tool by Zach Handley", "For more information, visit https://github.com/zachhandley/appwrite-utils");
-
-async function main() {
-  const answers = await inquirer.prompt([
-    {
-      type: "list",
-      name: "action",
-      message: "What would you like to do?",
-      choices: [
-        "Create collection config file",
-        "Create function (not available)",
-        "Setup directories and files",
-        "Setup directories and files with example data",
-        "Exit",
-      ],
-    },
-  ]);
-
-  switch (answers.action) {
-    case "Create collection config file":
-      const { collectionName } = await inquirer.prompt([
-        {
-          type: "input",
-          name: "collectionName",
-          message: "Enter the name of the collection:",
-          validate: (input) =>
-            input.trim() !== "" || "Collection name cannot be empty.",
-        },
-      ]);
-      MessageFormatter.progress(`Creating collection config file for '${collectionName}'...`, { prefix: "Init" });
-      createEmptyCollection(collectionName);
-      break;
-    case "Create function (not available)":
-      MessageFormatter.warning("This feature is not available yet.", { prefix: "Init" });
-      break;
-    case "Setup directories and files":
-      MessageFormatter.progress("Setting up directories and files...", { prefix: "Init" });
-      setupDirsFiles(false); // Assuming false means no example data
-      break;
-    case "Setup directories and files with example data":
-      MessageFormatter.progress("Setting up directories and files with example data...", { prefix: "Init" });
-      setupDirsFiles(true); // Assuming false means no example data
-      break;
-    case "Exit":
-      MessageFormatter.info("Exiting...", { prefix: "Init" });
-      process.exit(0);
-      break;
-    default:
-      MessageFormatter.warning("Invalid option, please try again.", { prefix: "Init" });
-      break;
-  }
-}
-
-main().catch((error) => {
-  MessageFormatter.error("An error occurred", error instanceof Error ? error : new Error(String(error)), { prefix: "Init" });
-  process.exit(1);
-});
+#!/usr/bin/env node
+import inquirer from "inquirer";
+import { createEmptyCollection, setupDirsFiles } from "./utils/setupFiles.js";
+import { MessageFormatter } from "appwrite-utils-helpers";
+
+MessageFormatter.banner("Appwrite Utils CLI Tool by Zach Handley", "For more information, visit https://github.com/zachhandley/appwrite-utils");
+
+async function main() {
+  const answers = await inquirer.prompt([
+    {
+      type: "list",
+      name: "action",
+      message: "What would you like to do?",
+      choices: [
+        "Create collection config file",
+        "Create function (not available)",
+        "Setup directories and files",
+        "Setup directories and files with example data",
+        "Exit",
+      ],
+    },
+  ]);
+
+  switch (answers.action) {
+    case "Create collection config file":
+      const { collectionName } = await inquirer.prompt([
+        {
+          type: "input",
+          name: "collectionName",
+          message: "Enter the name of the collection:",
+          validate: (input) =>
+            input.trim() !== "" || "Collection name cannot be empty.",
+        },
+      ]);
+      MessageFormatter.progress(`Creating collection config file for '${collectionName}'...`, { prefix: "Init" });
+      createEmptyCollection(collectionName);
+      break;
+    case "Create function (not available)":
+      MessageFormatter.warning("This feature is not available yet.", { prefix: "Init" });
+      break;
+    case "Setup directories and files":
+      MessageFormatter.progress("Setting up directories and files...", { prefix: "Init" });
+      setupDirsFiles(false); // Assuming false means no example data
+      break;
+    case "Setup directories and files with example data":
+      MessageFormatter.progress("Setting up directories and files with example data...", { prefix: "Init" });
+      setupDirsFiles(true); // Assuming false means no example data
+      break;
+    case "Exit":
+      MessageFormatter.info("Exiting...", { prefix: "Init" });
+      process.exit(0);
+      break;
+    default:
+      MessageFormatter.warning("Invalid option, please try again.", { prefix: "Init" });
+      break;
+  }
+}
+
+main().catch((error) => {
+  MessageFormatter.error("An error occurred", error instanceof Error ? error : new Error(String(error)), { prefix: "Init" });
+  process.exit(1);
+});