@appwrite.io/console 8.0.0 → 8.1.0

package/types/operator.d.ts

@@ -1,180 +0,0 @@
-type OperatorValuesSingle = string | number | boolean;
-export type OperatorValuesList = string[] | number[] | boolean[] | any[];
-export type OperatorValues = OperatorValuesSingle | OperatorValuesList;
-export declare enum Condition {
-    Equal = "equal",
-    NotEqual = "notEqual",
-    GreaterThan = "greaterThan",
-    GreaterThanEqual = "greaterThanEqual",
-    LessThan = "lessThan",
-    LessThanEqual = "lessThanEqual",
-    Contains = "contains",
-    IsNull = "isNull",
-    IsNotNull = "isNotNull"
-}
-/**
- * Helper class to generate operator strings for atomic operations.
- */
-export declare class Operator {
-    method: string;
-    values: OperatorValuesList | undefined;
-    /**
-     * Constructor for Operator class.
-     *
-     * @param {string} method
-     * @param {OperatorValues} values
-     */
-    constructor(method: string, values?: OperatorValues);
-    /**
-     * Convert the operator object to a JSON string.
-     *
-     * @returns {string}
-     */
-    toString(): string;
-    /**
-     * Increment a numeric attribute by a specified value.
-     *
-     * @param {number} value
-     * @param {number} max
-     * @returns {string}
-     */
-    static increment: (value?: number, max?: number) => string;
-    /**
-     * Decrement a numeric attribute by a specified value.
-     *
-     * @param {number} value
-     * @param {number} min
-     * @returns {string}
-     */
-    static decrement: (value?: number, min?: number) => string;
-    /**
-     * Multiply a numeric attribute by a specified factor.
-     *
-     * @param {number} factor
-     * @param {number} max
-     * @returns {string}
-     */
-    static multiply: (factor: number, max?: number) => string;
-    /**
-     * Divide a numeric attribute by a specified divisor.
-     *
-     * @param {number} divisor
-     * @param {number} min
-     * @returns {string}
-     */
-    static divide: (divisor: number, min?: number) => string;
-    /**
-     * Apply modulo operation on a numeric attribute.
-     *
-     * @param {number} divisor
-     * @returns {string}
-     */
-    static modulo: (divisor: number) => string;
-    /**
-     * Raise a numeric attribute to a specified power.
-     *
-     * @param {number} exponent
-     * @param {number} max
-     * @returns {string}
-     */
-    static power: (exponent: number, max?: number) => string;
-    /**
-     * Append values to an array attribute.
-     *
-     * @param {any[]} values
-     * @returns {string}
-     */
-    static arrayAppend: (values: any[]) => string;
-    /**
-     * Prepend values to an array attribute.
-     *
-     * @param {any[]} values
-     * @returns {string}
-     */
-    static arrayPrepend: (values: any[]) => string;
-    /**
-     * Insert a value at a specific index in an array attribute.
-     *
-     * @param {number} index
-     * @param {any} value
-     * @returns {string}
-     */
-    static arrayInsert: (index: number, value: any) => string;
-    /**
-     * Remove a value from an array attribute.
-     *
-     * @param {any} value
-     * @returns {string}
-     */
-    static arrayRemove: (value: any) => string;
-    /**
-     * Remove duplicate values from an array attribute.
-     *
-     * @returns {string}
-     */
-    static arrayUnique: () => string;
-    /**
-     * Keep only values that exist in both the current array and the provided array.
-     *
-     * @param {any[]} values
-     * @returns {string}
-     */
-    static arrayIntersect: (values: any[]) => string;
-    /**
-     * Remove values from the array that exist in the provided array.
-     *
-     * @param {any[]} values
-     * @returns {string}
-     */
-    static arrayDiff: (values: any[]) => string;
-    /**
-     * Filter array values based on a condition.
-     *
-     * @param {Condition} condition
-     * @param {any} value
-     * @returns {string}
-     */
-    static arrayFilter: (condition: Condition, value?: any) => string;
-    /**
-     * Concatenate a value to a string or array attribute.
-     *
-     * @param {any} value
-     * @returns {string}
-     */
-    static stringConcat: (value: any) => string;
-    /**
-     * Replace occurrences of a search string with a replacement string.
-     *
-     * @param {string} search
-     * @param {string} replace
-     * @returns {string}
-     */
-    static stringReplace: (search: string, replace: string) => string;
-    /**
-     * Toggle a boolean attribute.
-     *
-     * @returns {string}
-     */
-    static toggle: () => string;
-    /**
-     * Add days to a date attribute.
-     *
-     * @param {number} days
-     * @returns {string}
-     */
-    static dateAddDays: (days: number) => string;
-    /**
-     * Subtract days from a date attribute.
-     *
-     * @param {number} days
-     * @returns {string}
-     */
-    static dateSubDays: (days: number) => string;
-    /**
-     * Set a date attribute to the current date and time.
-     *
-     * @returns {string}
-     */
-    static dateSetNow: () => string;
-}
-export {};

package/types/permission.d.ts

@@ -1,43 +0,0 @@
-/**
- * Helper class to generate permission strings for resources.
- */
-export declare class Permission {
-    /**
-     * Generate read permission string for the provided role.
-     *
-     * @param {string} role
-     * @returns {string}
-     */
-    static read: (role: string) => string;
-    /**
-     * Generate write permission string for the provided role.
-     *
-     * This is an alias of update, delete, and possibly create.
-     * Don't use write in combination with update, delete, or create.
-     *
-     * @param {string} role
-     * @returns {string}
-     */
-    static write: (role: string) => string;
-    /**
-     * Generate create permission string for the provided role.
-     *
-     * @param {string} role
-     * @returns {string}
-     */
-    static create: (role: string) => string;
-    /**
-     * Generate update permission string for the provided role.
-     *
-     * @param {string} role
-     * @returns {string}
-     */
-    static update: (role: string) => string;
-    /**
-     * Generate delete permission string for the provided role.
-     *
-     * @param {string} role
-     * @returns {string}
-     */
-    static delete: (role: string) => string;
-}

package/types/query.d.ts

@@ -1,442 +0,0 @@
-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 declare 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);
-    /**
-     * Convert the query object to a JSON string.
-     *
-     * @returns {string}
-     */
-    toString(): string;
-    /**
-     * Filter resources where attribute is equal to value.
-     *
-     * @param {string} attribute
-     * @param {QueryTypes} value
-     * @returns {string}
-     */
-    static equal: (attribute: string, value: QueryTypes) => string;
-    /**
-     * Filter resources where attribute is not equal to value.
-     *
-     * @param {string} attribute
-     * @param {QueryTypes} value
-     * @returns {string}
-     */
-    static notEqual: (attribute: string, value: QueryTypes) => string;
-    /**
-     * 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;
-    /**
-     * Filter resources where attribute is less than value.
-     *
-     * @param {string} attribute
-     * @param {QueryTypes} value
-     * @returns {string}
-     */
-    static lessThan: (attribute: string, value: QueryTypes) => string;
-    /**
-     * 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;
-    /**
-     * Filter resources where attribute is greater than value.
-     *
-     * @param {string} attribute
-     * @param {QueryTypes} value
-     * @returns {string}
-     */
-    static greaterThan: (attribute: string, value: QueryTypes) => string;
-    /**
-     * 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;
-    /**
-     * Filter resources where attribute is null.
-     *
-     * @param {string} attribute
-     * @returns {string}
-     */
-    static isNull: (attribute: string) => string;
-    /**
-     * Filter resources where attribute is not null.
-     *
-     * @param {string} attribute
-     * @returns {string}
-     */
-    static isNotNull: (attribute: string) => string;
-    /**
-     * Filter resources where the specified attributes exist.
-     *
-     * @param {string[]} attributes The list of attributes that must exist.
-     * @returns {string}
-     */
-    static exists: (attributes: string[]) => string;
-    /**
-     * 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;
-    /**
-     * 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;
-    /**
-     * Filter resources where attribute starts with value.
-     *
-     * @param {string} attribute
-     * @param {string} value
-     * @returns {string}
-     */
-    static startsWith: (attribute: string, value: string) => string;
-    /**
-     * Filter resources where attribute ends with value.
-     *
-     * @param {string} attribute
-     * @param {string} value
-     * @returns {string}
-     */
-    static endsWith: (attribute: string, value: string) => string;
-    /**
-     * Specify which attributes should be returned by the API call.
-     *
-     * @param {string[]} attributes
-     * @returns {string}
-     */
-    static select: (attributes: string[]) => string;
-    /**
-     * 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;
-    /**
-     * Sort results by attribute descending.
-     *
-     * @param {string} attribute
-     * @returns {string}
-     */
-    static orderDesc: (attribute: string) => string;
-    /**
-     * Sort results by attribute ascending.
-     *
-     * @param {string} attribute
-     * @returns {string}
-     */
-    static orderAsc: (attribute: string) => string;
-    /**
-     * Sort results randomly.
-     *
-     * @returns {string}
-     */
-    static orderRandom: () => string;
-    /**
-     * Return results after documentId.
-     *
-     * @param {string} documentId
-     * @returns {string}
-     */
-    static cursorAfter: (documentId: string) => string;
-    /**
-     * Return results before documentId.
-     *
-     * @param {string} documentId
-     * @returns {string}
-     */
-    static cursorBefore: (documentId: string) => string;
-    /**
-     * Return only limit results.
-     *
-     * @param {number} limit
-     * @returns {string}
-     */
-    static limit: (limit: number) => string;
-    /**
-     * Filter resources by skipping the first offset results.
-     *
-     * @param {number} offset
-     * @returns {string}
-     */
-    static offset: (offset: number) => string;
-    /**
-     * 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;
-    /**
-     * 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;
-    /**
-     * 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;
-    /**
-     * 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;
-    /**
-     * 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;
-    /**
-     * 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;
-    /**
-     * Filter resources where attribute does not start with value.
-     *
-     * @param {string} attribute
-     * @param {string} value
-     * @returns {string}
-     */
-    static notStartsWith: (attribute: string, value: string) => string;
-    /**
-     * Filter resources where attribute does not end with value.
-     *
-     * @param {string} attribute
-     * @param {string} value
-     * @returns {string}
-     */
-    static notEndsWith: (attribute: string, value: string) => string;
-    /**
-     * Filter resources where document was created before date.
-     *
-     * @param {string} value
-     * @returns {string}
-     */
-    static createdBefore: (value: string) => string;
-    /**
-     * Filter resources where document was created after date.
-     *
-     * @param {string} value
-     * @returns {string}
-     */
-    static createdAfter: (value: string) => string;
-    /**
-     * Filter resources where document was created between dates.
-     *
-     * @param {string} start
-     * @param {string} end
-     * @returns {string}
-     */
-    static createdBetween: (start: string, end: string) => string;
-    /**
-     * Filter resources where document was updated before date.
-     *
-     * @param {string} value
-     * @returns {string}
-     */
-    static updatedBefore: (value: string) => string;
-    /**
-     * Filter resources where document was updated after date.
-     *
-     * @param {string} value
-     * @returns {string}
-     */
-    static updatedAfter: (value: string) => string;
-    /**
-     * Filter resources where document was updated between dates.
-     *
-     * @param {string} start
-     * @param {string} end
-     * @returns {string}
-     */
-    static updatedBetween: (start: string, end: string) => string;
-    /**
-     * Combine multiple queries using logical OR operator.
-     *
-     * @param {string[]} queries
-     * @returns {string}
-     */
-    static or: (queries: string[]) => string;
-    /**
-     * Combine multiple queries using logical AND operator.
-     *
-     * @param {string[]} queries
-     * @returns {string}
-     */
-    static and: (queries: string[]) => string;
-    /**
-     * 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;
-    /**
-     * 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) => string;
-    /**
-     * 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) => string;
-    /**
-     * 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) => string;
-    /**
-     * 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) => string;
-    /**
-     * Filter resources where attribute intersects with the given geometry.
-     *
-     * @param {string} attribute
-     * @param {any[]} values
-     * @returns {string}
-     */
-    static intersects: (attribute: string, values: any[]) => string;
-    /**
-     * 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;
-    /**
-     * Filter resources where attribute crosses the given geometry.
-     *
-     * @param {string} attribute
-     * @param {any[]} values
-     * @returns {string}
-     */
-    static crosses: (attribute: string, values: any[]) => string;
-    /**
-     * 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;
-    /**
-     * Filter resources where attribute overlaps with the given geometry.
-     *
-     * @param {string} attribute
-     * @param {any[]} values
-     * @returns {string}
-     */
-    static overlaps: (attribute: string, values: any[]) => string;
-    /**
-     * 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;
-    /**
-     * Filter resources where attribute touches the given geometry.
-     *
-     * @param {string} attribute
-     * @param {any[]} values
-     * @returns {string}
-     */
-    static touches: (attribute: string, values: any[]) => string;
-    /**
-     * 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;
-}
-export {};