react-native-appwrite 0.19.0 → 0.20.0

package/.github/workflows/publish.yml

@@ -5,6 +5,10 @@ on:
     types: [published]
   workflow_dispatch:
 
+permissions:
+  id-token: write
+  contents: read
+
 jobs:
   publish:
     runs-on: ubuntu-latest
@@ -12,14 +16,15 @@ jobs:
     steps:
     - uses: actions/checkout@v4
 
-    # Setup Node.js environment
     - name: Use Node.js
       uses: actions/setup-node@v4
       with:
-        node-version: '20.x'
+        node-version: '22'
         registry-url: 'https://registry.npmjs.org'
 
-    # Determine release tag based on the tag name
+    - name: Update npm to latest version for OIDC support
+      run: npm install -g npm@latest
+
     - name: Determine release tag
       id: release_tag
       run: |
@@ -29,14 +34,10 @@ jobs:
           echo "tag=latest" >> "$GITHUB_OUTPUT"
         fi
 
-    # Install dependencies (if any) and build your project (if necessary)
     - name: Install dependencies and build
       run: |
         npm install
         npm run build
 
-    # Publish to NPM with the appropriate tag
     - name: Publish
-      run: npm publish --tag ${{ steps.release_tag.outputs.tag }}
-      env:
-        NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN_NO_ORG }}
+      run: npm publish --provenance --access public --tag ${{ steps.release_tag.outputs.tag }}

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Change log
 
+## 0.20.0
+
+* Add array-based enum parameters (e.g., `permissions: BrowserPermission[]`).
+* Breaking change: `Output` enum has been removed; use `ImageFormat` instead.
+* Add `Channel` helpers for Realtime.
+
 ## 0.19.0
 
 * Add `getScreenshot` method to `Avatars` service

package/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2025 Appwrite (https://appwrite.io) and individual contributors.
+Copyright (c) 2026 Appwrite (https://appwrite.io) and individual contributors.
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

package/README.md

@@ -1,14 +1,14 @@
 # Appwrite React Native SDK
 
 ![License](https://img.shields.io/github/license/appwrite/sdk-for-react-native.svg?style=flat-square)
-![Version](https://img.shields.io/badge/api%20version-1.8.0-blue.svg?style=flat-square)
+![Version](https://img.shields.io/badge/api%20version-1.8.1-blue.svg?style=flat-square)
 [![Build Status](https://img.shields.io/travis/com/appwrite/sdk-generator?style=flat-square)](https://travis-ci.com/appwrite/sdk-generator)
 [![Twitter Account](https://img.shields.io/twitter/follow/appwrite?color=00acee&label=twitter&style=flat-square)](https://twitter.com/appwrite)
 [![Discord](https://img.shields.io/discord/564160730845151244?label=discord&style=flat-square)](https://appwrite.io/discord)
 
 **This SDK is compatible with Appwrite server version 1.8.x. For older versions, please check [previous releases](https://github.com/appwrite/sdk-for-react-native/releases).**
 
-Appwrite is an open-source backend as a service server that abstract and simplify complex and repetitive development tasks behind a very simple to use REST API. Appwrite aims to help you develop your apps faster and in a more secure way. Use the React Native SDK to integrate your app with the Appwrite server to easily start interacting with all of Appwrite backend APIs and tools. For full API documentation and tutorials go to [https://appwrite.io/docs](https://appwrite.io/docs)
+Appwrite is an open-source backend as a service server that abstracts and simplifies complex and repetitive development tasks behind a very simple to use REST API. Appwrite aims to help you develop your apps faster and in a more secure way. Use the React Native SDK to integrate your app with the Appwrite server to easily start interacting with all of Appwrite backend APIs and tools. For full API documentation and tutorials go to [https://appwrite.io/docs](https://appwrite.io/docs)
 
 ![Appwrite](https://github.com/appwrite/appwrite/raw/main/public/images/github.png)
 

package/dist/cjs/sdk.js

@@ -1,8 +1,12 @@
 'use strict';
 
 var reactNative = require('react-native');
+var JSONbigModule = require('json-bigint');
+var BigNumber = require('bignumber.js');
 var FileSystem = require('expo-file-system');
 
+function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
+
 function _interopNamespace(e) {
     if (e && e.__esModule) return e;
     var n = Object.create(null);
@@ -21,6 +25,8 @@ function _interopNamespace(e) {
     return Object.freeze(n);
 }
 
+var JSONbigModule__default = /*#__PURE__*/_interopDefaultLegacy(JSONbigModule);
+var BigNumber__default = /*#__PURE__*/_interopDefaultLegacy(BigNumber);
 var FileSystem__namespace = /*#__PURE__*/_interopNamespace(FileSystem);
 
 /******************************************************************************
@@ -74,6 +80,28 @@ class Service {
 }
 Service.CHUNK_SIZE = 5 * 1024 * 1024; // 5MB
 
+const JSONbigParser = JSONbigModule__default["default"]({ storeAsString: false });
+const JSONbigSerializer = JSONbigModule__default["default"]({ useNativeBigInt: true });
+const MAX_SAFE = BigInt(Number.MAX_SAFE_INTEGER);
+const MIN_SAFE = BigInt(Number.MIN_SAFE_INTEGER);
+function reviver(_key, value) {
+    if (BigNumber__default["default"].isBigNumber(value)) {
+        if (value.isInteger()) {
+            const str = value.toFixed();
+            const bi = BigInt(str);
+            if (bi >= MIN_SAFE && bi <= MAX_SAFE) {
+                return Number(str);
+            }
+            return bi;
+        }
+        return value.toNumber();
+    }
+    return value;
+}
+const JSONbig$1 = {
+    parse: (text) => JSONbigParser.parse(text, reviver),
+    stringify: JSONbigSerializer.stringify
+};
 class AppwriteException extends Error {
     constructor(message, code = 0, type = '', response = '') {
         super(message);
@@ -100,7 +128,7 @@ class Client {
             'x-sdk-name': 'React Native',
             'x-sdk-platform': 'client',
             'x-sdk-language': 'reactnative',
-            'x-sdk-version': '0.19.0',
+            'x-sdk-version': '0.20.0',
             'X-Appwrite-Response-Format': '1.8.0',
         };
         this.realtime = {
@@ -138,7 +166,7 @@ class Client {
                 }
                 this.realtime.heartbeat = window === null || window === void 0 ? void 0 : window.setInterval(() => {
                     var _a;
-                    (_a = this.realtime.socket) === null || _a === void 0 ? void 0 : _a.send(JSON.stringify({
+                    (_a = this.realtime.socket) === null || _a === void 0 ? void 0 : _a.send(JSONbig$1.stringify({
                         type: 'ping'
                     }));
                 }, 20000);
@@ -198,7 +226,7 @@ class Client {
             },
             onMessage: (event) => {
                 try {
-                    const message = JSON.parse(event.data);
+                    const message = JSONbig$1.parse(event.data);
                     this.realtime.lastMessage = message;
                     switch (message.type) {
                         case 'event':
@@ -250,6 +278,9 @@ class Client {
      * @returns {this}
      */
     setEndpoint(endpoint) {
+        if (!endpoint || typeof endpoint !== 'string') {
+            throw new AppwriteException('Endpoint must be a valid string');
+        }
         if (!endpoint.startsWith('http://') && !endpoint.startsWith('https://')) {
             throw new AppwriteException('Invalid endpoint URL: ' + endpoint);
         }
@@ -265,6 +296,9 @@ class Client {
      * @returns {this}
      */
     setEndpointRealtime(endpointRealtime) {
+        if (!endpointRealtime || typeof endpointRealtime !== 'string') {
+            throw new AppwriteException('Endpoint must be a valid string');
+        }
         if (!endpointRealtime.startsWith('ws://') && !endpointRealtime.startsWith('wss://')) {
             throw new AppwriteException('Invalid realtime endpoint URL: ' + endpointRealtime);
         }
@@ -412,7 +446,7 @@ class Client {
             else {
                 switch (headers['content-type']) {
                     case 'application/json':
-                        options.body = JSON.stringify(params);
+                        options.body = JSONbig$1.stringify(params);
                         break;
                     case 'multipart/form-data':
                         let formData = new FormData();
@@ -439,7 +473,7 @@ class Client {
                     warnings.split(';').forEach((warning) => console.warn('Warning: ' + warning));
                 }
                 if ((_a = response.headers.get('content-type')) === null || _a === void 0 ? void 0 : _a.includes('application/json')) {
-                    data = yield response.json();
+                    data = JSONbig$1.parse(yield response.text());
                 }
                 else if (responseType === 'arrayBuffer') {
                     data = yield response.arrayBuffer();
@@ -452,7 +486,7 @@ class Client {
                 if (400 <= response.status) {
                     let responseText = '';
                     if ((_b = response.headers.get('content-type')) === null || _b === void 0 ? void 0 : _b.includes('application/json')) {
-                        responseText = JSON.stringify(data);
+                        responseText = JSONbig$1.stringify(data);
                     }
                     else {
                         responseText = data === null || data === void 0 ? void 0 : data.message;
@@ -614,15 +648,22 @@ class Account extends Service {
             'content-type': 'application/json',
         }, payload);
     }
-    /**
-     * Use this endpoint to create a JSON Web Token. You can use the resulting JWT to authenticate on behalf of the current user when working with the Appwrite server-side API and SDKs. The JWT secret is valid for 15 minutes from its creation and will be invalid if the user will logout in that time frame.
-     *
-     * @throws {AppwriteException}
-     * @returns {Promise}
-     */
-    createJWT() {
+    createJWT(paramsOrFirst) {
+        let params;
+        if (!paramsOrFirst || (paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
+            params = (paramsOrFirst || {});
+        }
+        else {
+            params = {
+                duration: paramsOrFirst
+            };
+        }
+        const duration = params.duration;
         const apiPath = '/account/jwts';
         const payload = {};
+        if (typeof duration !== 'undefined') {
+            payload['duration'] = duration;
+        }
         const uri = new URL(this.client.config.endpoint + apiPath);
         return this.client.call('post', uri, {
             'content-type': 'application/json',
@@ -2569,12 +2610,12 @@ class Avatars extends Service {
      * @param {number} longitude
      * @param {number} accuracy
      * @param {boolean} touch
-     * @param {string[]} permissions
+     * @param {BrowserPermission[]} permissions
      * @param {number} sleep
      * @param {number} width
      * @param {number} height
      * @param {number} quality
-     * @param {Output} output
+     * @param {ImageFormat} output
      * @throws {AppwriteException}
      * @returns {URL}
     */
@@ -2951,9 +2992,6 @@ class Databases extends Service {
         if (typeof documentId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "documentId"');
         }
-        if (typeof data === 'undefined') {
-            throw new AppwriteException('Missing required parameter: "data"');
-        }
         const apiPath = '/databases/{databaseId}/collections/{collectionId}/documents/{documentId}'.replace('{databaseId}', databaseId).replace('{collectionId}', collectionId).replace('{documentId}', documentId);
         const payload = {};
         if (typeof data !== 'undefined') {
@@ -4891,6 +4929,7 @@ class Teams extends Service {
     }
 }
 
+const JSONbig = JSONbigModule__default["default"]({ useNativeBigInt: true });
 class Query {
     constructor(method, attribute, values) {
         this.method = method;
@@ -4905,7 +4944,7 @@ class Query {
         }
     }
     toString() {
-        return JSON.stringify({
+        return JSONbig.stringify({
             method: this.method,
             attribute: this.attribute,
             values: this.values,
@@ -4914,12 +4953,34 @@ class Query {
 }
 Query.equal = (attribute, value) => new Query("equal", attribute, value).toString();
 Query.notEqual = (attribute, value) => new Query("notEqual", attribute, value).toString();
+/**
+ * Filter resources where attribute matches a regular expression pattern.
+ *
+ * @param {string} attribute The attribute to filter on.
+ * @param {string} pattern The regular expression pattern to match.
+ * @returns {string}
+ */
+Query.regex = (attribute, pattern) => new Query("regex", attribute, pattern).toString();
 Query.lessThan = (attribute, value) => new Query("lessThan", attribute, value).toString();
 Query.lessThanEqual = (attribute, value) => new Query("lessThanEqual", attribute, value).toString();
 Query.greaterThan = (attribute, value) => new Query("greaterThan", attribute, value).toString();
 Query.greaterThanEqual = (attribute, value) => new Query("greaterThanEqual", attribute, value).toString();
 Query.isNull = (attribute) => new Query("isNull", attribute).toString();
 Query.isNotNull = (attribute) => new Query("isNotNull", attribute).toString();
+/**
+ * Filter resources where the specified attributes exist.
+ *
+ * @param {string[]} attributes The list of attributes that must exist.
+ * @returns {string}
+ */
+Query.exists = (attributes) => new Query("exists", undefined, attributes).toString();
+/**
+ * Filter resources where the specified attributes do not exist.
+ *
+ * @param {string[]} attributes The list of attributes that must not exist.
+ * @returns {string}
+ */
+Query.notExists = (attributes) => new Query("notExists", undefined, attributes).toString();
 Query.between = (attribute, start, end) => new Query("between", attribute, [start, end]).toString();
 Query.startsWith = (attribute, value) => new Query("startsWith", attribute, value).toString();
 Query.endsWith = (attribute, value) => new Query("endsWith", attribute, value).toString();
@@ -4961,8 +5022,8 @@ Query.notSearch = (attribute, value) => new Query("notSearch", attribute, value)
  * Filter resources where attribute is not between start and end (exclusive).
  *
  * @param {string} attribute
- * @param {string | number} start
- * @param {string | number} end
+ * @param {string | number | bigint} start
+ * @param {string | number | bigint} end
  * @returns {string}
  */
 Query.notBetween = (attribute, start, end) => new Query("notBetween", attribute, [start, end]).toString();
@@ -5026,8 +5087,16 @@ Query.updatedAfter = (value) => Query.greaterThan("$updatedAt", value);
  * @returns {string}
  */
 Query.updatedBetween = (start, end) => Query.between("$updatedAt", start, end);
-Query.or = (queries) => new Query("or", undefined, queries.map((query) => JSON.parse(query))).toString();
-Query.and = (queries) => new Query("and", undefined, queries.map((query) => JSON.parse(query))).toString();
+Query.or = (queries) => new Query("or", undefined, queries.map((query) => JSONbig.parse(query))).toString();
+Query.and = (queries) => new Query("and", undefined, queries.map((query) => JSONbig.parse(query))).toString();
+/**
+ * Filter array elements where at least one element matches all the specified queries.
+ *
+ * @param {string} attribute The attribute containing the array to filter on.
+ * @param {string[]} queries The list of query strings to match against array elements.
+ * @returns {string}
+ */
+Query.elemMatch = (attribute, queries) => new Query("elemMatch", attribute, queries.map((query) => JSONbig.parse(query))).toString();
 /**
  * Filter resources where attribute is at a specific distance from the given coordinates.
  *
@@ -5270,6 +5339,96 @@ _a = ID, _ID_hexTimestamp = function _ID_hexTimestamp() {
     return hexTimestamp;
 };
 
+function normalize(id) {
+    const trimmed = id.trim();
+    return trimmed === "" ? "*" : trimmed;
+}
+class Channel {
+    constructor(segments) {
+        this.segments = segments;
+    }
+    next(segment, id = "*") {
+        return new Channel([...this.segments, segment, normalize(id)]);
+    }
+    resolve(action) {
+        return new Channel([...this.segments, action]);
+    }
+    toString() {
+        return this.segments.join(".");
+    }
+    // --- DATABASE ROUTE ---
+    // Only available on Channel<Database>
+    collection(id = "*") {
+        return this.next("collections", id);
+    }
+    // Only available on Channel<Collection>
+    document(id = "*") {
+        return this.next("documents", id);
+    }
+    // --- TABLESDB ROUTE ---
+    table(id = "*") {
+        return this.next("tables", id);
+    }
+    row(id = "*") {
+        return this.next("rows", id);
+    }
+    // --- BUCKET ROUTE ---
+    file(id = "*") {
+        return this.next("files", id);
+    }
+    // --- FUNCTION ROUTE ---
+    execution(id = "*") {
+        return this.next("executions", id);
+    }
+    // --- TERMINAL ACTIONS ---
+    // Restricted to the Actionable union
+    create() {
+        return this.resolve("create");
+    }
+    update() {
+        return this.resolve("update");
+    }
+    delete() {
+        return this.resolve("delete");
+    }
+    // --- ROOT FACTORIES ---
+    static database(id = "*") {
+        return new Channel(["databases", normalize(id)]);
+    }
+    static tablesdb(id = "*") {
+        return new Channel(["tablesdb", normalize(id)]);
+    }
+    static bucket(id = "*") {
+        return new Channel(["buckets", normalize(id)]);
+    }
+    static function(id = "*") {
+        return new Channel(["functions", normalize(id)]);
+    }
+    static team(id = "*") {
+        return new Channel(["teams", normalize(id)]);
+    }
+    static membership(id = "*") {
+        return new Channel(["memberships", normalize(id)]);
+    }
+    static account(userId = "") {
+        const id = normalize(userId);
+        return id === "*" ? "account" : `account.${id}`;
+    }
+    // Global events
+    static get documents() {
+        return "documents";
+    }
+    static get rows() {
+        return "rows";
+    }
+    static get files() {
+        return "files";
+    }
+    static get executions() {
+        return "executions";
+    }
+}
+
 exports.Condition = void 0;
 (function (Condition) {
     Condition["Equal"] = "equal";
@@ -5589,7 +5748,6 @@ exports.OAuthProvider = void 0;
     OAuthProvider["Yandex"] = "yandex";
     OAuthProvider["Zoho"] = "zoho";
     OAuthProvider["Zoom"] = "zoom";
-    OAuthProvider["Mock"] = "mock";
 })(exports.OAuthProvider || (exports.OAuthProvider = {}));
 
 exports.Browser = void 0;
@@ -6259,16 +6417,40 @@ exports.Timezone = void 0;
     Timezone["Utc"] = "utc";
 })(exports.Timezone || (exports.Timezone = {}));
 
-exports.Output = void 0;
-(function (Output) {
-    Output["Jpg"] = "jpg";
-    Output["Jpeg"] = "jpeg";
-    Output["Png"] = "png";
-    Output["Webp"] = "webp";
-    Output["Heic"] = "heic";
-    Output["Avif"] = "avif";
-    Output["Gif"] = "gif";
-})(exports.Output || (exports.Output = {}));
+exports.BrowserPermission = void 0;
+(function (BrowserPermission) {
+    BrowserPermission["Geolocation"] = "geolocation";
+    BrowserPermission["Camera"] = "camera";
+    BrowserPermission["Microphone"] = "microphone";
+    BrowserPermission["Notifications"] = "notifications";
+    BrowserPermission["Midi"] = "midi";
+    BrowserPermission["Push"] = "push";
+    BrowserPermission["ClipboardRead"] = "clipboard-read";
+    BrowserPermission["ClipboardWrite"] = "clipboard-write";
+    BrowserPermission["PaymentHandler"] = "payment-handler";
+    BrowserPermission["Usb"] = "usb";
+    BrowserPermission["Bluetooth"] = "bluetooth";
+    BrowserPermission["Accelerometer"] = "accelerometer";
+    BrowserPermission["Gyroscope"] = "gyroscope";
+    BrowserPermission["Magnetometer"] = "magnetometer";
+    BrowserPermission["AmbientLightSensor"] = "ambient-light-sensor";
+    BrowserPermission["BackgroundSync"] = "background-sync";
+    BrowserPermission["PersistentStorage"] = "persistent-storage";
+    BrowserPermission["ScreenWakeLock"] = "screen-wake-lock";
+    BrowserPermission["WebShare"] = "web-share";
+    BrowserPermission["XrSpatialTracking"] = "xr-spatial-tracking";
+})(exports.BrowserPermission || (exports.BrowserPermission = {}));
+
+exports.ImageFormat = void 0;
+(function (ImageFormat) {
+    ImageFormat["Jpg"] = "jpg";
+    ImageFormat["Jpeg"] = "jpeg";
+    ImageFormat["Png"] = "png";
+    ImageFormat["Webp"] = "webp";
+    ImageFormat["Heic"] = "heic";
+    ImageFormat["Avif"] = "avif";
+    ImageFormat["Gif"] = "gif";
+})(exports.ImageFormat || (exports.ImageFormat = {}));
 
 exports.ExecutionMethod = void 0;
 (function (ExecutionMethod) {
@@ -6294,16 +6476,12 @@ exports.ImageGravity = void 0;
     ImageGravity["BottomRight"] = "bottom-right";
 })(exports.ImageGravity || (exports.ImageGravity = {}));
 
-exports.ImageFormat = void 0;
-(function (ImageFormat) {
-    ImageFormat["Jpg"] = "jpg";
-    ImageFormat["Jpeg"] = "jpeg";
-    ImageFormat["Png"] = "png";
-    ImageFormat["Webp"] = "webp";
-    ImageFormat["Heic"] = "heic";
-    ImageFormat["Avif"] = "avif";
-    ImageFormat["Gif"] = "gif";
-})(exports.ImageFormat || (exports.ImageFormat = {}));
+exports.Roles = void 0;
+(function (Roles) {
+    Roles["Admin"] = "admin";
+    Roles["Developer"] = "developer";
+    Roles["Owner"] = "owner";
+})(exports.Roles || (exports.Roles = {}));
 
 exports.ExecutionTrigger = void 0;
 (function (ExecutionTrigger) {
@@ -6324,6 +6502,7 @@ exports.ExecutionStatus = void 0;
 exports.Account = Account;
 exports.AppwriteException = AppwriteException;
 exports.Avatars = Avatars;
+exports.Channel = Channel;
 exports.Client = Client;
 exports.Databases = Databases;
 exports.Functions = Functions;