node-appwrite 13.0.0 → 14.0.0-rc.2

package/dist/models.d.mts

@@ -1,3 +1,6 @@
+/**
+ * Appwrite Models
+ */
 declare namespace Models {
     /**
      * Documents List
@@ -168,6 +171,19 @@ declare namespace Models {
          */
         functions: Function[];
     };
+    /**
+     * Function Templates List
+     */
+    type TemplateFunctionList = {
+        /**
+         * Total number of templates documents that matched your query.
+         */
+        total: number;
+        /**
+         * List of templates.
+         */
+        templates: TemplateFunction[];
+    };
     /**
      * Runtimes List
      */
@@ -1660,6 +1676,10 @@ declare namespace Models {
          * Function's active deployment ID.
          */
         deployment: string;
+        /**
+         * Allowed permission scopes.
+         */
+        scopes: string[];
         /**
          * Function variables.
          */
@@ -1709,6 +1729,129 @@ declare namespace Models {
          */
         providerSilentMode: boolean;
     };
+    /**
+     * Template Function
+     */
+    type TemplateFunction = {
+        /**
+         * Function Template Icon.
+         */
+        icon: string;
+        /**
+         * Function Template ID.
+         */
+        id: string;
+        /**
+         * Function Template Name.
+         */
+        name: string;
+        /**
+         * Function Template Tagline.
+         */
+        tagline: string;
+        /**
+         * Execution permissions.
+         */
+        permissions: string[];
+        /**
+         * Function trigger events.
+         */
+        events: string[];
+        /**
+         * Function execution schedult in CRON format.
+         */
+        cron: string;
+        /**
+         * Function execution timeout in seconds.
+         */
+        timeout: number;
+        /**
+         * Function use cases.
+         */
+        useCases: string[];
+        /**
+         * List of runtimes that can be used with this template.
+         */
+        runtimes: TemplateRuntime[];
+        /**
+         * Function Template Instructions.
+         */
+        instructions: string;
+        /**
+         * VCS (Version Control System) Provider.
+         */
+        vcsProvider: string;
+        /**
+         * VCS (Version Control System) Repository ID
+         */
+        providerRepositoryId: string;
+        /**
+         * VCS (Version Control System) Owner.
+         */
+        providerOwner: string;
+        /**
+         * VCS (Version Control System) branch version (tag).
+         */
+        providerVersion: string;
+        /**
+         * Function variables.
+         */
+        variables: TemplateVariable[];
+        /**
+         * Function scopes.
+         */
+        scopes: string[];
+    };
+    /**
+     * Template Runtime
+     */
+    type TemplateRuntime = {
+        /**
+         * Runtime Name.
+         */
+        name: string;
+        /**
+         * The build command used to build the deployment.
+         */
+        commands: string;
+        /**
+         * The entrypoint file used to execute the deployment.
+         */
+        entrypoint: string;
+        /**
+         * Path to function in VCS (Version Control System) repository
+         */
+        providerRootDirectory: string;
+    };
+    /**
+     * Template Variable
+     */
+    type TemplateVariable = {
+        /**
+         * Variable Name.
+         */
+        name: string;
+        /**
+         * Variable Description.
+         */
+        description: string;
+        /**
+         * Variable Value.
+         */
+        value: string;
+        /**
+         * Variable Placeholder.
+         */
+        placeholder: string;
+        /**
+         * Is the variable required?
+         */
+        required: boolean;
+        /**
+         * Variable Type.
+         */
+        type: string;
+    };
     /**
      * Runtime
      */
@@ -1717,6 +1860,10 @@ declare namespace Models {
          * Runtime ID.
          */
         $id: string;
+        /**
+         * Parent runtime key.
+         */
+        key: string;
         /**
          * Runtime Name.
          */
@@ -1907,6 +2054,51 @@ declare namespace Models {
          * Function execution duration in seconds.
          */
         duration: number;
+        /**
+         * The scheduled time for execution. If left empty, execution will be queued immediately.
+         */
+        scheduledAt?: string;
+    };
+    /**
+     * Build
+     */
+    type Build = {
+        /**
+         * Build ID.
+         */
+        $id: string;
+        /**
+         * The deployment that created this build.
+         */
+        deploymentId: string;
+        /**
+         * The build status. There are a few different types and each one means something different. \nFailed - The deployment build has failed. More details can usually be found in buildStderr\nReady - The deployment build was successful and the deployment is ready to be deployed\nProcessing - The deployment is currently waiting to have a build triggered\nBuilding - The deployment is currently being built
+         */
+        status: string;
+        /**
+         * The stdout of the build.
+         */
+        stdout: string;
+        /**
+         * The stderr of the build.
+         */
+        stderr: string;
+        /**
+         * The deployment creation date in ISO 8601 format.
+         */
+        startTime: string;
+        /**
+         * The time the build was finished in ISO 8601 format.
+         */
+        endTime: string;
+        /**
+         * The build duration in seconds.
+         */
+        duration: number;
+        /**
+         * The code size in bytes.
+         */
+        size: number;
     };
     /**
      * Variable

package/dist/models.d.ts

@@ -1,3 +1,6 @@
+/**
+ * Appwrite Models
+ */
 declare namespace Models {
     /**
      * Documents List
@@ -168,6 +171,19 @@ declare namespace Models {
          */
         functions: Function[];
     };
+    /**
+     * Function Templates List
+     */
+    type TemplateFunctionList = {
+        /**
+         * Total number of templates documents that matched your query.
+         */
+        total: number;
+        /**
+         * List of templates.
+         */
+        templates: TemplateFunction[];
+    };
     /**
      * Runtimes List
      */
@@ -1660,6 +1676,10 @@ declare namespace Models {
          * Function's active deployment ID.
          */
         deployment: string;
+        /**
+         * Allowed permission scopes.
+         */
+        scopes: string[];
         /**
          * Function variables.
          */
@@ -1709,6 +1729,129 @@ declare namespace Models {
          */
         providerSilentMode: boolean;
     };
+    /**
+     * Template Function
+     */
+    type TemplateFunction = {
+        /**
+         * Function Template Icon.
+         */
+        icon: string;
+        /**
+         * Function Template ID.
+         */
+        id: string;
+        /**
+         * Function Template Name.
+         */
+        name: string;
+        /**
+         * Function Template Tagline.
+         */
+        tagline: string;
+        /**
+         * Execution permissions.
+         */
+        permissions: string[];
+        /**
+         * Function trigger events.
+         */
+        events: string[];
+        /**
+         * Function execution schedult in CRON format.
+         */
+        cron: string;
+        /**
+         * Function execution timeout in seconds.
+         */
+        timeout: number;
+        /**
+         * Function use cases.
+         */
+        useCases: string[];
+        /**
+         * List of runtimes that can be used with this template.
+         */
+        runtimes: TemplateRuntime[];
+        /**
+         * Function Template Instructions.
+         */
+        instructions: string;
+        /**
+         * VCS (Version Control System) Provider.
+         */
+        vcsProvider: string;
+        /**
+         * VCS (Version Control System) Repository ID
+         */
+        providerRepositoryId: string;
+        /**
+         * VCS (Version Control System) Owner.
+         */
+        providerOwner: string;
+        /**
+         * VCS (Version Control System) branch version (tag).
+         */
+        providerVersion: string;
+        /**
+         * Function variables.
+         */
+        variables: TemplateVariable[];
+        /**
+         * Function scopes.
+         */
+        scopes: string[];
+    };
+    /**
+     * Template Runtime
+     */
+    type TemplateRuntime = {
+        /**
+         * Runtime Name.
+         */
+        name: string;
+        /**
+         * The build command used to build the deployment.
+         */
+        commands: string;
+        /**
+         * The entrypoint file used to execute the deployment.
+         */
+        entrypoint: string;
+        /**
+         * Path to function in VCS (Version Control System) repository
+         */
+        providerRootDirectory: string;
+    };
+    /**
+     * Template Variable
+     */
+    type TemplateVariable = {
+        /**
+         * Variable Name.
+         */
+        name: string;
+        /**
+         * Variable Description.
+         */
+        description: string;
+        /**
+         * Variable Value.
+         */
+        value: string;
+        /**
+         * Variable Placeholder.
+         */
+        placeholder: string;
+        /**
+         * Is the variable required?
+         */
+        required: boolean;
+        /**
+         * Variable Type.
+         */
+        type: string;
+    };
     /**
      * Runtime
      */
@@ -1717,6 +1860,10 @@ declare namespace Models {
          * Runtime ID.
          */
         $id: string;
+        /**
+         * Parent runtime key.
+         */
+        key: string;
         /**
          * Runtime Name.
          */
@@ -1907,6 +2054,51 @@ declare namespace Models {
          * Function execution duration in seconds.
          */
         duration: number;
+        /**
+         * The scheduled time for execution. If left empty, execution will be queued immediately.
+         */
+        scheduledAt?: string;
+    };
+    /**
+     * Build
+     */
+    type Build = {
+        /**
+         * Build ID.
+         */
+        $id: string;
+        /**
+         * The deployment that created this build.
+         */
+        deploymentId: string;
+        /**
+         * The build status. There are a few different types and each one means something different. \nFailed - The deployment build has failed. More details can usually be found in buildStderr\nReady - The deployment build was successful and the deployment is ready to be deployed\nProcessing - The deployment is currently waiting to have a build triggered\nBuilding - The deployment is currently being built
+         */
+        status: string;
+        /**
+         * The stdout of the build.
+         */
+        stdout: string;
+        /**
+         * The stderr of the build.
+         */
+        stderr: string;
+        /**
+         * The deployment creation date in ISO 8601 format.
+         */
+        startTime: string;
+        /**
+         * The time the build was finished in ISO 8601 format.
+         */
+        endTime: string;
+        /**
+         * The build duration in seconds.
+         */
+        duration: number;
+        /**
+         * The code size in bytes.
+         */
+        size: number;
     };
     /**
      * Variable

package/dist/permission.d.mts

@@ -1,8 +1,44 @@
+/**
+ * Helper class to generate permission strings for resources.
+ */
 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/dist/permission.d.ts

@@ -1,8 +1,44 @@
+/**
+ * Helper class to generate permission strings for resources.
+ */
 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/dist/permission.js

@@ -2,18 +2,51 @@
 
 class Permission {
 }
+/**
+ * Generate read permission string for the provided role.
+ *
+ * @param {string} role
+ * @returns {string}
+ */
 Permission.read = (role) => {
   return `read("${role}")`;
 };
+/**
+ * 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}
+ */
 Permission.write = (role) => {
   return `write("${role}")`;
 };
+/**
+ * Generate create permission string for the provided role.
+ *
+ * @param {string} role
+ * @returns {string}
+ */
 Permission.create = (role) => {
   return `create("${role}")`;
 };
+/**
+ * Generate update permission string for the provided role.
+ *
+ * @param {string} role
+ * @returns {string}
+ */
 Permission.update = (role) => {
   return `update("${role}")`;
 };
+/**
+ * Generate delete permission string for the provided role.
+ *
+ * @param {string} role
+ * @returns {string}
+ */
 Permission.delete = (role) => {
   return `delete("${role}")`;
 };

package/dist/permission.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/permission.ts"],"names":[],"mappings":"AAAO,MAAM,WAAW;AAqBxB;AArBa,WAEF,OAAO,CAAC,SAAyB;AACpC,SAAO,SAAS,IAAI;AACxB;AAJS,WAMF,QAAQ,CAAC,SAAyB;AACrC,SAAO,UAAU,IAAI;AACzB;AARS,WAUF,SAAS,CAAC,SAAyB;AACtC,SAAO,WAAW,IAAI;AAC1B;AAZS,WAcF,SAAS,CAAC,SAAyB;AACtC,SAAO,WAAW,IAAI;AAC1B;AAhBS,WAkBF,SAAS,CAAC,SAAyB;AACtC,SAAO,WAAW,IAAI;AAC1B","sourcesContent":["export class Permission {\n\n    static read = (role: string): string => {\n        return `read(\"${role}\")`\n    }\n\n    static write = (role: string): string => {\n        return `write(\"${role}\")`\n    }\n\n    static create = (role: string): string => {\n        return `create(\"${role}\")`\n    }\n\n    static update = (role: string): string => {\n        return `update(\"${role}\")`\n    }\n\n    static delete = (role: string): string => {\n        return `delete(\"${role}\")`\n    }\n}\n"]}
+{"version":3,"sources":["../src/permission.ts"],"names":[],"mappings":"AAGO,MAAM,WAAW;AAqDxB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AArDa,WAOF,OAAO,CAAC,SAAyB;AACpC,SAAO,SAAS,IAAI;AACxB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AATS,WAoBF,QAAQ,CAAC,SAAyB;AACrC,SAAO,UAAU,IAAI;AACzB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAtBS,WA8BF,SAAS,CAAC,SAAyB;AACtC,SAAO,WAAW,IAAI;AAC1B;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAhCS,WAwCF,SAAS,CAAC,SAAyB;AACtC,SAAO,WAAW,IAAI;AAC1B;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AA1CS,WAkDF,SAAS,CAAC,SAAyB;AACtC,SAAO,WAAW,IAAI;AAC1B","sourcesContent":["/**\n * Helper class to generate permission strings for resources.\n */\nexport class Permission {\n    /**\n     * Generate read permission string for the provided role.\n     *\n     * @param {string} role\n     * @returns {string}\n     */\n    static read = (role: string): string => {\n        return `read(\"${role}\")`;\n    }\n\n    /**\n     * Generate write permission string for the provided role.\n     *\n     * This is an alias of update, delete, and possibly create.\n     * Don't use write in combination with update, delete, or create.\n     *\n     * @param {string} role\n     * @returns {string}\n     */\n    static write = (role: string): string => {\n        return `write(\"${role}\")`;\n    }\n\n    /**\n     * Generate create permission string for the provided role.\n     *\n     * @param {string} role\n     * @returns {string}\n     */\n    static create = (role: string): string => {\n        return `create(\"${role}\")`;\n    }\n\n    /**\n     * Generate update permission string for the provided role.\n     *\n     * @param {string} role\n     * @returns {string}\n     */\n    static update = (role: string): string => {\n        return `update(\"${role}\")`;\n    }\n\n    /**\n     * Generate delete permission string for the provided role.\n     *\n     * @param {string} role\n     * @returns {string}\n     */\n    static delete = (role: string): string => {\n        return `delete(\"${role}\")`;\n    }\n}\n"]}

package/dist/permission.mjs

@@ -1,18 +1,51 @@
 // src/permission.ts
 var Permission = class {
 };
+/**
+ * Generate read permission string for the provided role.
+ *
+ * @param {string} role
+ * @returns {string}
+ */
 Permission.read = (role) => {
   return `read("${role}")`;
 };
+/**
+ * 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}
+ */
 Permission.write = (role) => {
   return `write("${role}")`;
 };
+/**
+ * Generate create permission string for the provided role.
+ *
+ * @param {string} role
+ * @returns {string}
+ */
 Permission.create = (role) => {
   return `create("${role}")`;
 };
+/**
+ * Generate update permission string for the provided role.
+ *
+ * @param {string} role
+ * @returns {string}
+ */
 Permission.update = (role) => {
   return `update("${role}")`;
 };
+/**
+ * Generate delete permission string for the provided role.
+ *
+ * @param {string} role
+ * @returns {string}
+ */
 Permission.delete = (role) => {
   return `delete("${role}")`;
 };

package/dist/permission.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/permission.ts"],"names":[],"mappings":";AAAO,IAAM,aAAN,MAAiB;AAqBxB;AArBa,WAEF,OAAO,CAAC,SAAyB;AACpC,SAAO,SAAS,IAAI;AACxB;AAJS,WAMF,QAAQ,CAAC,SAAyB;AACrC,SAAO,UAAU,IAAI;AACzB;AARS,WAUF,SAAS,CAAC,SAAyB;AACtC,SAAO,WAAW,IAAI;AAC1B;AAZS,WAcF,SAAS,CAAC,SAAyB;AACtC,SAAO,WAAW,IAAI;AAC1B;AAhBS,WAkBF,SAAS,CAAC,SAAyB;AACtC,SAAO,WAAW,IAAI;AAC1B","sourcesContent":["export class Permission {\n\n    static read = (role: string): string => {\n        return `read(\"${role}\")`\n    }\n\n    static write = (role: string): string => {\n        return `write(\"${role}\")`\n    }\n\n    static create = (role: string): string => {\n        return `create(\"${role}\")`\n    }\n\n    static update = (role: string): string => {\n        return `update(\"${role}\")`\n    }\n\n    static delete = (role: string): string => {\n        return `delete(\"${role}\")`\n    }\n}\n"]}
+{"version":3,"sources":["../src/permission.ts"],"names":[],"mappings":";AAGO,IAAM,aAAN,MAAiB;AAqDxB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AArDa,WAOF,OAAO,CAAC,SAAyB;AACpC,SAAO,SAAS,IAAI;AACxB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AATS,WAoBF,QAAQ,CAAC,SAAyB;AACrC,SAAO,UAAU,IAAI;AACzB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAtBS,WA8BF,SAAS,CAAC,SAAyB;AACtC,SAAO,WAAW,IAAI;AAC1B;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAhCS,WAwCF,SAAS,CAAC,SAAyB;AACtC,SAAO,WAAW,IAAI;AAC1B;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AA1CS,WAkDF,SAAS,CAAC,SAAyB;AACtC,SAAO,WAAW,IAAI;AAC1B","sourcesContent":["/**\n * Helper class to generate permission strings for resources.\n */\nexport class Permission {\n    /**\n     * Generate read permission string for the provided role.\n     *\n     * @param {string} role\n     * @returns {string}\n     */\n    static read = (role: string): string => {\n        return `read(\"${role}\")`;\n    }\n\n    /**\n     * Generate write permission string for the provided role.\n     *\n     * This is an alias of update, delete, and possibly create.\n     * Don't use write in combination with update, delete, or create.\n     *\n     * @param {string} role\n     * @returns {string}\n     */\n    static write = (role: string): string => {\n        return `write(\"${role}\")`;\n    }\n\n    /**\n     * Generate create permission string for the provided role.\n     *\n     * @param {string} role\n     * @returns {string}\n     */\n    static create = (role: string): string => {\n        return `create(\"${role}\")`;\n    }\n\n    /**\n     * Generate update permission string for the provided role.\n     *\n     * @param {string} role\n     * @returns {string}\n     */\n    static update = (role: string): string => {\n        return `update(\"${role}\")`;\n    }\n\n    /**\n     * Generate delete permission string for the provided role.\n     *\n     * @param {string} role\n     * @returns {string}\n     */\n    static delete = (role: string): string => {\n        return `delete(\"${role}\")`;\n    }\n}\n"]}