@revenexx/sdk 0.0.2

package/src/query.ts

@@ -0,0 +1,576 @@
+import JSONbigModule from 'json-bigint';
+const JSONbig = JSONbigModule({ useNativeBigInt: true });
+
+type QueryTypesSingle = string | number | bigint | boolean;
+export type QueryTypesList = string[] | number[] | bigint[] | boolean[] | Query[] | any[];
+export type QueryTypes = QueryTypesSingle | QueryTypesList;
+type AttributesTypes = string | string[];
+
+/**
+ * Helper class to generate query strings.
+ */
+export class Query {
+  method: string;
+  attribute: AttributesTypes | undefined;
+  values: QueryTypesList | undefined;
+
+  /**
+   * Constructor for Query class.
+   *
+   * @param {string} method
+   * @param {AttributesTypes} attribute
+   * @param {QueryTypes} values
+   */
+  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;
+      }
+    }
+  }
+
+  /**
+   * Convert the query object to a JSON string.
+   *
+   * @returns {string}
+   */
+  toString(): string {
+    return JSONbig.stringify({
+      method: this.method,
+      attribute: this.attribute,
+      values: this.values,
+    });
+  }
+
+  /**
+   * Filter resources where attribute is equal to value.
+   *
+   * @param {string} attribute
+   * @param {QueryTypes} value
+   * @returns {string}
+   */
+  static equal = (attribute: string, value: QueryTypes): string =>
+    new Query("equal", attribute, value).toString();
+
+  /**
+   * Filter resources where attribute is not equal to value.
+   *
+   * @param {string} attribute
+   * @param {QueryTypes} value
+   * @returns {string}
+   */
+  static notEqual = (attribute: string, value: QueryTypes): string =>
+    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}
+   */
+  static regex = (attribute: string, pattern: string): string =>
+    new Query("regex", attribute, pattern).toString();
+
+  /**
+   * Filter resources where attribute is less than value.
+   *
+   * @param {string} attribute
+   * @param {QueryTypes} value
+   * @returns {string}
+   */
+  static lessThan = (attribute: string, value: QueryTypes): string =>
+    new Query("lessThan", attribute, value).toString();
+
+  /**
+   * Filter resources where attribute is less than or equal to value.
+   *
+   * @param {string} attribute
+   * @param {QueryTypes} value
+   * @returns {string}
+   */
+  static lessThanEqual = (attribute: string, value: QueryTypes): string =>
+    new Query("lessThanEqual", attribute, value).toString();
+
+  /**
+   * Filter resources where attribute is greater than value.
+   *
+   * @param {string} attribute
+   * @param {QueryTypes} value
+   * @returns {string}
+   */
+  static greaterThan = (attribute: string, value: QueryTypes): string =>
+    new Query("greaterThan", attribute, value).toString();
+
+  /**
+   * Filter resources where attribute is greater than or equal to value.
+   *
+   * @param {string} attribute
+   * @param {QueryTypes} value
+   * @returns {string}
+   */
+  static greaterThanEqual = (attribute: string, value: QueryTypes): string =>
+    new Query("greaterThanEqual", attribute, value).toString();
+
+  /**
+   * Filter resources where attribute is null.
+   *
+   * @param {string} attribute
+   * @returns {string}
+   */
+  static isNull = (attribute: string): string =>
+    new Query("isNull", attribute).toString();
+
+  /**
+   * Filter resources where attribute is not null.
+   *
+   * @param {string} attribute
+   * @returns {string}
+   */
+  static isNotNull = (attribute: string): string =>
+    new Query("isNotNull", attribute).toString();
+
+  /**
+   * Filter resources where the specified attributes exist.
+   *
+   * @param {string[]} attributes The list of attributes that must exist.
+   * @returns {string}
+   */
+  static exists = (attributes: string[]): string =>
+    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}
+   */
+  static notExists = (attributes: string[]): string =>
+    new Query("notExists", undefined, attributes).toString();
+
+  /**
+   * Filter resources where attribute is between start and end (inclusive).
+   *
+   * @param {string} attribute
+   * @param {string | number | bigint} start
+   * @param {string | number | bigint} end
+   * @returns {string}
+   */
+  static between = (attribute: string, start: string | number | bigint, end: string | number | bigint): string =>
+    new Query("between", attribute, [start, end] as QueryTypesList).toString();
+
+  /**
+   * Filter resources where attribute starts with value.
+   *
+   * @param {string} attribute
+   * @param {string} value
+   * @returns {string}
+   */
+  static startsWith = (attribute: string, value: string): string =>
+    new Query("startsWith", attribute, value).toString();
+
+  /**
+   * Filter resources where attribute ends with value.
+   *
+   * @param {string} attribute
+   * @param {string} value
+   * @returns {string}
+   */
+  static endsWith = (attribute: string, value: string): string =>
+    new Query("endsWith", attribute, value).toString();
+
+  /**
+   * Specify which attributes should be returned by the API call.
+   *
+   * @param {string[]} attributes
+   * @returns {string}
+   */
+  static select = (attributes: string[]): string =>
+    new Query("select", undefined, attributes).toString();
+
+  /**
+   * Filter resources by searching attribute for value.
+   * A fulltext index on attribute is required for this query to work.
+   *
+   * @param {string} attribute
+   * @param {string} value
+   * @returns {string}
+   */
+  static search = (attribute: string, value: string): string =>
+    new Query("search", attribute, value).toString();
+
+  /**
+   * Sort results by attribute descending.
+   *
+   * @param {string} attribute
+   * @returns {string}
+   */
+  static orderDesc = (attribute: string): string =>
+    new Query("orderDesc", attribute).toString();
+
+  /**
+   * Sort results by attribute ascending.
+   *
+   * @param {string} attribute
+   * @returns {string}
+   */
+  static orderAsc = (attribute: string): string =>
+    new Query("orderAsc", attribute).toString();
+
+  /**
+   * Sort results randomly.
+   *
+   * @returns {string}
+   */
+  static orderRandom = (): string =>
+    new Query("orderRandom").toString();
+
+  /**
+   * Return results after documentId.
+   *
+   * @param {string} documentId
+   * @returns {string}
+   */
+  static cursorAfter = (documentId: string): string =>
+    new Query("cursorAfter", undefined, documentId).toString();
+
+  /**
+   * Return results before documentId.
+   *
+   * @param {string} documentId
+   * @returns {string}
+   */
+  static cursorBefore = (documentId: string): string =>
+    new Query("cursorBefore", undefined, documentId).toString();
+
+  /**
+   * Return only limit results.
+   *
+   * @param {number} limit
+   * @returns {string}
+   */
+  static limit = (limit: number): string =>
+    new Query("limit", undefined, limit).toString();
+
+  /**
+   * Filter resources by skipping the first offset results.
+   *
+   * @param {number} offset
+   * @returns {string}
+   */
+  static offset = (offset: number): string =>
+    new Query("offset", undefined, offset).toString();
+
+  /**
+   * Filter resources where attribute contains the specified value.
+   * For string attributes, checks if the string contains the substring.
+   *
+   * Note: For array attributes, use {@link containsAny} or {@link containsAll} instead.
+   * @param {string} attribute
+   * @param {string | string[]} value
+   * @returns {string}
+   */
+  static contains = (attribute: string, value: string | any[]): string =>
+    new Query("contains", attribute, value).toString();
+
+  /**
+   * Filter resources where attribute contains ANY of the specified values.
+   * For array and relationship attributes, matches documents where the attribute
+   * contains at least one of the given values.
+   *
+   * @param {string} attribute
+   * @param {any[]} value
+   * @returns {string}
+   */
+  static containsAny = (attribute: string, value: any[]): string =>
+    new Query("containsAny", attribute, value).toString();
+
+  /**
+   * Filter resources where attribute contains ALL of the specified values.
+   * For array and relationship attributes, matches documents where the attribute
+   * contains every one of the given values.
+   *
+   * @param {string} attribute
+   * @param {any[]} value
+   * @returns {string}
+   */
+  static containsAll = (attribute: string, value: any[]): string =>
+    new Query("containsAll", attribute, value).toString();
+
+  /**
+   * Filter resources where attribute does not contain the specified value.
+   *
+   * @param {string} attribute
+   * @param {string | any[]} value
+   * @returns {string}
+   */
+  static notContains = (attribute: string, value: string | any[]): string =>
+    new Query("notContains", attribute, value).toString();
+
+  /**
+   * Filter resources by searching attribute for value (inverse of search).
+   * A fulltext index on attribute is required for this query to work.
+   *
+   * @param {string} attribute
+   * @param {string} value
+   * @returns {string}
+   */
+  static notSearch = (attribute: string, value: string): string =>
+    new Query("notSearch", attribute, value).toString();
+
+  /**
+   * Filter resources where attribute is not between start and end (exclusive).
+   *
+   * @param {string} attribute
+   * @param {string | number | bigint} start
+   * @param {string | number | bigint} end
+   * @returns {string}
+   */
+  static notBetween = (attribute: string, start: string | number | bigint, end: string | number | bigint): string =>
+    new Query("notBetween", attribute, [start, end] as QueryTypesList).toString();
+
+  /**
+   * Filter resources where attribute does not start with value.
+   *
+   * @param {string} attribute
+   * @param {string} value
+   * @returns {string}
+   */
+  static notStartsWith = (attribute: string, value: string): string =>
+    new Query("notStartsWith", attribute, value).toString();
+
+  /**
+   * Filter resources where attribute does not end with value.
+   *
+   * @param {string} attribute
+   * @param {string} value
+   * @returns {string}
+   */
+  static notEndsWith = (attribute: string, value: string): string =>
+    new Query("notEndsWith", attribute, value).toString();
+
+  /**
+   * Filter resources where document was created before date.
+   *
+   * @param {string} value
+   * @returns {string}
+   */
+  static createdBefore = (value: string): string =>
+    Query.lessThan("$createdAt", value);
+
+  /**
+   * Filter resources where document was created after date.
+   *
+   * @param {string} value
+   * @returns {string}
+   */
+  static createdAfter = (value: string): string =>
+    Query.greaterThan("$createdAt", value);
+
+  /**
+   * Filter resources where document was created between dates.
+   *
+   * @param {string} start
+   * @param {string} end
+   * @returns {string}
+   */
+  static createdBetween = (start: string, end: string): string =>
+    Query.between("$createdAt", start, end);
+
+  /**
+   * Filter resources where document was updated before date.
+   *
+   * @param {string} value
+   * @returns {string}
+   */
+  static updatedBefore = (value: string): string =>
+    Query.lessThan("$updatedAt", value);
+
+  /**
+   * Filter resources where document was updated after date.
+   *
+   * @param {string} value
+   * @returns {string}
+   */
+  static updatedAfter = (value: string): string =>
+    Query.greaterThan("$updatedAt", value);
+
+  /**
+   * Filter resources where document was updated between dates.
+   *
+   * @param {string} start
+   * @param {string} end
+   * @returns {string}
+   */
+  static updatedBetween = (start: string, end: string): string =>
+    Query.between("$updatedAt", start, end);
+
+  /**
+   * Combine multiple queries using logical OR operator.
+   *
+   * @param {string[]} queries
+   * @returns {string}
+   */
+  static or = (queries: string[]) =>
+    new Query("or", undefined, queries.map((query) => JSONbig.parse(query))).toString();
+
+  /**
+   * Combine multiple queries using logical AND operator.
+   *
+   * @param {string[]} queries
+   * @returns {string}
+   */
+  static and = (queries: string[]) =>
+    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}
+   */
+  static elemMatch = (attribute: string, queries: string[]): string =>
+    new Query(
+      "elemMatch",
+      attribute,
+      queries.map((query) => JSONbig.parse(query))
+    ).toString();
+
+  /**
+   * Filter resources where attribute is at a specific distance from the given coordinates.
+   *
+   * @param {string} attribute
+   * @param {any[]} values
+   * @param {number} distance
+   * @param {boolean} meters
+   * @returns {string}
+   */
+  static distanceEqual = (attribute: string, values: any[], distance: number, meters: boolean = true): string =>
+    new Query("distanceEqual", attribute, [[values, distance, meters]] as QueryTypesList).toString();
+
+  /**
+   * Filter resources where attribute is not at a specific distance from the given coordinates.
+   *
+   * @param {string} attribute
+   * @param {any[]} values
+   * @param {number} distance
+   * @param {boolean} meters
+   * @returns {string}
+   */
+  static distanceNotEqual = (attribute: string, values: any[], distance: number, meters: boolean = true): string =>
+    new Query("distanceNotEqual", attribute, [[values, distance, meters]] as QueryTypesList).toString();
+
+  /**
+   * Filter resources where attribute is at a distance greater than the specified value from the given coordinates.
+   *
+   * @param {string} attribute
+   * @param {any[]} values
+   * @param {number} distance
+   * @param {boolean} meters
+   * @returns {string}
+   */
+  static distanceGreaterThan = (attribute: string, values: any[], distance: number, meters: boolean = true): string =>
+    new Query("distanceGreaterThan", attribute, [[values, distance, meters]] as QueryTypesList).toString();
+
+  /**
+   * Filter resources where attribute is at a distance less than the specified value from the given coordinates.
+   *
+   * @param {string} attribute
+   * @param {any[]} values
+   * @param {number} distance
+   * @param {boolean} meters
+   * @returns {string}
+   */
+  static distanceLessThan = (attribute: string, values: any[], distance: number, meters: boolean = true): string =>
+    new Query("distanceLessThan", attribute, [[values, distance, meters]] as QueryTypesList).toString();
+
+  /**
+   * Filter resources where attribute intersects with the given geometry.
+   *
+   * @param {string} attribute
+   * @param {any[]} values
+   * @returns {string}
+   */
+  static intersects = (attribute: string, values: any[]): string =>
+    new Query("intersects", attribute, [values]).toString();
+
+  /**
+   * Filter resources where attribute does not intersect with the given geometry.
+   *
+   * @param {string} attribute
+   * @param {any[]} values
+   * @returns {string}
+   */
+  static notIntersects = (attribute: string, values: any[]): string =>
+    new Query("notIntersects", attribute, [values]).toString();
+
+  /**
+   * Filter resources where attribute crosses the given geometry.
+   *
+   * @param {string} attribute
+   * @param {any[]} values
+   * @returns {string}
+   */
+  static crosses = (attribute: string, values: any[]): string =>
+    new Query("crosses", attribute, [values]).toString();
+
+  /**
+   * Filter resources where attribute does not cross the given geometry.
+   *
+   * @param {string} attribute
+   * @param {any[]} values
+   * @returns {string}
+   */
+  static notCrosses = (attribute: string, values: any[]): string =>
+    new Query("notCrosses", attribute, [values]).toString();
+
+  /**
+   * Filter resources where attribute overlaps with the given geometry.
+   *
+   * @param {string} attribute
+   * @param {any[]} values
+   * @returns {string}
+   */
+  static overlaps = (attribute: string, values: any[]): string =>
+    new Query("overlaps", attribute, [values]).toString();
+
+  /**
+   * Filter resources where attribute does not overlap with the given geometry.
+   *
+   * @param {string} attribute
+   * @param {any[]} values
+   * @returns {string}
+   */
+  static notOverlaps = (attribute: string, values: any[]): string =>
+    new Query("notOverlaps", attribute, [values]).toString();
+
+  /**
+   * Filter resources where attribute touches the given geometry.
+   *
+   * @param {string} attribute
+   * @param {any[]} values
+   * @returns {string}
+   */
+  static touches = (attribute: string, values: any[]): string =>
+    new Query("touches", attribute, [values]).toString();
+
+  /**
+   * Filter resources where attribute does not touch the given geometry.
+   *
+   * @param {string} attribute
+   * @param {any[]} values
+   * @returns {string}
+   */
+  static notTouches = (attribute: string, values: any[]): string =>
+    new Query("notTouches", attribute, [values]).toString();
+}

package/src/role.ts

@@ -0,0 +1,100 @@
+/**
+ * Helper class to generate role strings for `Permission`.
+ */
+export class Role {
+
+    /**
+     * Grants access to anyone.
+     * 
+     * This includes authenticated and unauthenticated users.
+     * 
+     * @returns {string}
+     */
+    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.
+     *
+     * @param {string} id 
+     * @param {string} status 
+     * @returns {string}
+     */
+    public static user(id: string, status: string = ''): string {
+        if (status === '') {
+            return `user:${id}`
+        }
+        return `user:${id}/${status}`
+    }
+
+    /**
+     * 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}
+     */
+    public static users(status: string = ''): string {
+        if (status === '') {
+            return 'users'
+        }
+        return `users/${status}`
+    }
+
+    /**
+     * Grants access to any guest user without a session.
+     * 
+     * Authenticated users don't have access to this role.
+     * 
+     * @returns {string}
+     */
+    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.
+     * 
+     * @param {string} id 
+     * @param {string} role 
+     * @returns {string}
+     */
+    public static team(id: string, role: string = ''): string {
+        if (role === '') {
+            return `team:${id}`
+        }
+        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}
+     */
+    public static member(id: string): string {
+        return `member:${id}`
+    }
+
+    /**
+     * Grants access to a user with the specified label.
+     * 
+     * @param {string} name 
+     * @returns  {string}
+     */
+    public static label(name: string): string {
+        return `label:${name}`
+    }
+}

package/src/service.ts

@@ -0,0 +1,30 @@
+import { Client } from './client';
+import type { Payload } from './client';
+
+export class Service {
+    /**
+     * The size for chunked uploads in bytes.
+     */
+    static CHUNK_SIZE = 5*1024*1024; // 5MB
+
+    client: Client;
+
+    constructor(client: Client) {
+        this.client = client;
+    }
+
+    static flatten(data: Payload, prefix = ''): Payload {
+        let output: Payload = {};
+
+        for (const [key, value] of Object.entries(data)) {
+            let finalKey = prefix ? prefix + '[' + key +']' : key;
+            if (Array.isArray(value)) {
+                output = { ...output, ...Service.flatten(value, finalKey) };
+            } else {
+                output[finalKey] = value;
+            }
+        }
+
+        return output;
+    }
+}