feat: add method to service

ChiragAgg5k · ChiragAgg5k · commit 28caebc0c48b · 2025-11-28T19:02:50.000Z
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,9 @@
 # Change Log
 
+## 21.5.0
+
+* Add `getScreenshot` method to `Avatars` service
+
 ## 21.4.0
 
 * Add `total` parameter to list queries allowing skipping counting rows in a table for improved performance
diff --git a/README.md b/README.md
@@ -33,7 +33,7 @@ import { Client, Account } from "appwrite";
 To install with a CDN (content delivery network) add the following scripts to the bottom of your <body> tag, but before you use any Appwrite services:
 
 ```html
-<script src="https://cdn.jsdelivr.net/npm/appwrite@21.4.0"></script>
+<script src="https://cdn.jsdelivr.net/npm/appwrite@21.5.0"></script>
 ```
 
 
diff --git a/docs/examples/avatars/get-screenshot.md b/docs/examples/avatars/get-screenshot.md
@@ -0,0 +1,32 @@
+import { Client, Avatars, Theme, Timezone, Output } from "appwrite";
+
+const client = new Client()
+    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
+
+const avatars = new Avatars(client);
+
+const result = avatars.getScreenshot({
+    url: 'https://example.com',
+    headers: {}, // optional
+    viewportWidth: 1, // optional
+    viewportHeight: 1, // optional
+    scale: 0.1, // optional
+    theme: Theme.Light, // optional
+    userAgent: '<USER_AGENT>', // optional
+    fullpage: false, // optional
+    locale: '<LOCALE>', // optional
+    timezone: Timezone.AfricaAbidjan, // optional
+    latitude: -90, // optional
+    longitude: -180, // optional
+    accuracy: 0, // optional
+    touch: false, // optional
+    permissions: [], // optional
+    sleep: 0, // optional
+    width: 0, // optional
+    height: 0, // optional
+    quality: -1, // optional
+    output: Output.Jpg // optional
+});
+
+console.log(result);
diff --git a/package.json b/package.json
@@ -2,7 +2,7 @@
   "name": "appwrite",
   "homepage": "https://appwrite.io/support",
   "description": "Appwrite is an open-source self-hosted backend server that abstract and simplify complex and repetitive development tasks behind a very simple REST API",
-  "version": "21.4.0",
+  "version": "21.5.0",
   "license": "BSD-3-Clause",
   "main": "dist/cjs/sdk.js",
   "exports": {
@@ -26,7 +26,7 @@
   },
   "devDependencies": {
     "@rollup/plugin-typescript": "8.3.2",
-    "playwright": "1.15.0",
+    "playwright": "1.56.1",
     "rollup": "2.79.2",
     "serve-handler": "6.1.0",
     "tslib": "2.4.0",
diff --git a/src/client.ts b/src/client.ts
@@ -320,7 +320,7 @@ class Client {
         'x-sdk-name': 'Web',
         'x-sdk-platform': 'client',
         'x-sdk-language': 'web',
-        'x-sdk-version': '21.4.0',
+        'x-sdk-version': '21.5.0',
         'X-Appwrite-Response-Format': '1.8.0',
     };
 
diff --git a/src/enums/output.ts b/src/enums/output.ts
@@ -0,0 +1,9 @@
+export enum Output {
+    Jpg = 'jpg',
+    Jpeg = 'jpeg',
+    Png = 'png',
+    Webp = 'webp',
+    Heic = 'heic',
+    Avif = 'avif',
+    Gif = 'gif',
+}
diff --git a/src/enums/theme.ts b/src/enums/theme.ts
@@ -0,0 +1,4 @@
+export enum Theme {
+    Light = 'light',
+    Dark = 'dark',
+}
diff --git a/src/enums/timezone.ts b/src/enums/timezone.ts
diff --git a/src/index.ts b/src/index.ts
diff --git a/src/services/avatars.ts b/src/services/avatars.ts
