node-appwrite 12.0.0 → 12.1.0-rc.4

package/src/permission.ts

@@ -0,0 +1,22 @@
+export class Permission {
+
+    static read = (role: string): string => {
+        return `read("${role}")`
+    }
+
+    static write = (role: string): string => {
+        return `write("${role}")`
+    }
+
+    static create = (role: string): string => {
+        return `create("${role}")`
+    }
+
+    static update = (role: string): string => {
+        return `update("${role}")`
+    }
+
+    static delete = (role: string): string => {
+        return `delete("${role}")`
+    }
+}

package/src/query.ts

@@ -0,0 +1,101 @@
+type QueryTypesSingle = string | number | boolean;
+export type QueryTypesList = string[] | number[] | boolean[] | Query[];
+export type QueryTypes = QueryTypesSingle | QueryTypesList;
+type AttributesTypes = string | string[];
+
+export class Query {
+  method: string;
+  attribute: AttributesTypes | undefined;
+  values: QueryTypesList | undefined;
+
+  constructor(
+    method: string,
+    attribute?: AttributesTypes,
+    values?: QueryTypes
+  ) {
+    this.method = method;
+    this.attribute = attribute;
+
+    if (values !== undefined) {
+      if (Array.isArray(values)) {
+        this.values = values;
+      } else {
+        this.values = [values] as QueryTypesList;
+      }
+    }
+  }
+
+  toString(): string {
+    return JSON.stringify({
+      method: this.method,
+      attribute: this.attribute,
+      values: this.values,
+    });
+  }
+
+  static equal = (attribute: string, value: QueryTypes): string =>
+    new Query("equal", attribute, value).toString();
+
+  static notEqual = (attribute: string, value: QueryTypes): string =>
+    new Query("notEqual", attribute, value).toString();
+
+  static lessThan = (attribute: string, value: QueryTypes): string =>
+    new Query("lessThan", attribute, value).toString();
+
+  static lessThanEqual = (attribute: string, value: QueryTypes): string =>
+    new Query("lessThanEqual", attribute, value).toString();
+
+  static greaterThan = (attribute: string, value: QueryTypes): string =>
+    new Query("greaterThan", attribute, value).toString();
+
+  static greaterThanEqual = (attribute: string, value: QueryTypes): string =>
+    new Query("greaterThanEqual", attribute, value).toString();
+
+  static isNull = (attribute: string): string =>
+    new Query("isNull", attribute).toString();
+
+  static isNotNull = (attribute: string): string =>
+    new Query("isNotNull", attribute).toString();
+
+  static between = (attribute: string, start: string | number, end: string | number) =>
+    new Query("between", attribute, [start, end] as QueryTypesList).toString();
+
+  static startsWith = (attribute: string, value: string): string =>
+    new Query("startsWith", attribute, value).toString();
+
+  static endsWith = (attribute: string, value: string): string =>
+    new Query("endsWith", attribute, value).toString();
+
+  static select = (attributes: string[]): string =>
+    new Query("select", undefined, attributes).toString();
+
+  static search = (attribute: string, value: string): string =>
+    new Query("search", attribute, value).toString();
+
+  static orderDesc = (attribute: string): string =>
+    new Query("orderDesc", attribute).toString();
+
+  static orderAsc = (attribute: string): string =>
+    new Query("orderAsc", attribute).toString();
+
+  static cursorAfter = (documentId: string): string =>
+    new Query("cursorAfter", undefined, documentId).toString();
+
+  static cursorBefore = (documentId: string): string =>
+    new Query("cursorBefore", undefined, documentId).toString();
+
+  static limit = (limit: number): string =>
+    new Query("limit", undefined, limit).toString();
+
+  static offset = (offset: number): string =>
+    new Query("offset", undefined, offset).toString();
+
+  static contains = (attribute: string, value: string | string[]): string =>
+    new Query("contains", attribute, value).toString();
+
+  static or = (queries: string[]) =>
+    new Query("or", undefined, queries.map((query) => JSON.parse(query))).toString();
+
+  static and = (queries: string[]) =>
+    new Query("and", undefined, queries.map((query) => JSON.parse(query))).toString();
+}

package/{lib/role.js → src/role.ts}

@@ -1,22 +1,22 @@
 /**
  * Helper class to generate role strings for `Permission`.
  */
-class Role {
+export class Role {
 
     /**
      * Grants access to anyone.
-     *
+     * 
      * This includes authenticated and unauthenticated users.
-     *
+     * 
      * @returns {string}
      */
-    static any = () => {
+    public static any(): string {
         return 'any'
     }
 
     /**
      * Grants access to a specific user by user ID.
-     *
+     * 
      * You can optionally pass verified or unverified for
      * `status` to target specific types of users.
      *
@@ -24,7 +24,7 @@ class Role {
      * @param {string} status 
      * @returns {string}
      */
-    static user = (id, status = '') => {
+    public static user(id: string, status: string = ''): string {
         if (status === '') {
             return `user:${id}`
         }
@@ -33,14 +33,14 @@ class Role {
 
     /**
      * Grants access to any authenticated or anonymous user.
-     *
+     * 
      * You can optionally pass verified or unverified for
      * `status` to target specific types of users.
-     *
+     * 
      * @param {string} status 
      * @returns {string}
      */
-    static users = (status = '') => {
+    public static users(status: string = ''): string {
         if (status === '') {
             return 'users'
         }
@@ -49,18 +49,18 @@ class Role {
 
     /**
      * Grants access to any guest user without a session.
-     *
+     * 
      * Authenticated users don't have access to this role.
-     *
+     * 
      * @returns {string}
      */
-    static guests = () => {
+    public static guests(): string {
         return 'guests'
     }
 
     /**
      * Grants access to a team by team ID.
-     *
+     * 
      * You can optionally pass a role for `role` to target
      * team members with the specified role.
      * 
@@ -68,35 +68,33 @@ class Role {
      * @param {string} role 
      * @returns {string}
      */
-    static team = (id, role = '') => {
+    public static team(id: string, role: string = ''): string {
         if (role === '') {
-            return 'team:' + id
+            return `team:${id}`
         }
-        return 'team:' + id + '/' + role
+        return `team:${id}/${role}`
     }
 
     /**
      * Grants access to a specific member of a team.
-     *
+     * 
      * When the member is removed from the team, they will
      * no longer have access.
      * 
      * @param {string} id 
      * @returns {string}
      */
-    static member = (id) => {
-        return 'member:' + id
+    public static member(id: string): string {
+        return `member:${id}`
     }
 
     /**
      * Grants access to a user with the specified label.
-     *
+     * 
      * @param {string} name 
      * @returns  {string}
      */
-    static label = (name) => {
-        return 'label:' + name;
+    public static label(name: string): string {
+        return `label:${name}`
     }
-}
-
-module.exports = Role;
+}