node-appwrite 22.1.3 → 23.0.0

package/dist/services/sites.d.ts

@@ -58,6 +58,7 @@ declare class Sites {
      * @param {number} params.timeout - Maximum request time in seconds.
      * @param {string} params.installCommand - Install Command.
      * @param {string} params.buildCommand - Build Command.
+     * @param {string} params.startCommand - Custom start command. Leave empty to use default.
      * @param {string} params.outputDirectory - Output Directory for site.
      * @param {Adapter} params.adapter - Framework adapter defining rendering strategy. Allowed values are: static, ssr
      * @param {string} params.installationId - Appwrite Installation ID for VCS (Version Control System) deployment.
@@ -66,7 +67,9 @@ declare class Sites {
      * @param {string} params.providerBranch - Production branch for the repo linked to the site.
      * @param {boolean} params.providerSilentMode - Is the VCS (Version Control System) connection in silent mode for the repo linked to the site? In silent mode, comments will not be made on commits and pull requests.
      * @param {string} params.providerRootDirectory - Path to site code in the linked repo.
-     * @param {string} params.specification - Framework specification for the site and builds.
+     * @param {string} params.buildSpecification - Build specification for the site deployments.
+     * @param {string} params.runtimeSpecification - Runtime specification for the SSR executions.
+     * @param {number} params.deploymentRetention - Days to keep non-active deployments before deletion. Value 0 means all deployments will be kept.
      * @throws {AppwriteException}
      * @returns {Promise<Models.Site>}
      */
@@ -80,6 +83,7 @@ declare class Sites {
         timeout?: number;
         installCommand?: string;
         buildCommand?: string;
+        startCommand?: string;
         outputDirectory?: string;
         adapter?: Adapter;
         installationId?: string;
@@ -88,7 +92,9 @@ declare class Sites {
         providerBranch?: string;
         providerSilentMode?: boolean;
         providerRootDirectory?: string;
-        specification?: string;
+        buildSpecification?: string;
+        runtimeSpecification?: string;
+        deploymentRetention?: number;
     }): Promise<Models.Site>;
     /**
      * Create a new site.
@@ -102,6 +108,7 @@ declare class Sites {
      * @param {number} timeout - Maximum request time in seconds.
      * @param {string} installCommand - Install Command.
      * @param {string} buildCommand - Build Command.
+     * @param {string} startCommand - Custom start command. Leave empty to use default.
      * @param {string} outputDirectory - Output Directory for site.
      * @param {Adapter} adapter - Framework adapter defining rendering strategy. Allowed values are: static, ssr
      * @param {string} installationId - Appwrite Installation ID for VCS (Version Control System) deployment.
@@ -110,12 +117,14 @@ declare class Sites {
      * @param {string} providerBranch - Production branch for the repo linked to the site.
      * @param {boolean} providerSilentMode - Is the VCS (Version Control System) connection in silent mode for the repo linked to the site? In silent mode, comments will not be made on commits and pull requests.
      * @param {string} providerRootDirectory - Path to site code in the linked repo.
-     * @param {string} specification - Framework specification for the site and builds.
+     * @param {string} buildSpecification - Build specification for the site deployments.
+     * @param {string} runtimeSpecification - Runtime specification for the SSR executions.
+     * @param {number} deploymentRetention - Days to keep non-active deployments before deletion. Value 0 means all deployments will be kept.
      * @throws {AppwriteException}
      * @returns {Promise<Models.Site>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    create(siteId: string, name: string, framework: Framework, buildRuntime: BuildRuntime, enabled?: boolean, logging?: boolean, timeout?: number, installCommand?: string, buildCommand?: string, outputDirectory?: string, adapter?: Adapter, installationId?: string, fallbackFile?: string, providerRepositoryId?: string, providerBranch?: string, providerSilentMode?: boolean, providerRootDirectory?: string, specification?: string): Promise<Models.Site>;
+    create(siteId: string, name: string, framework: Framework, buildRuntime: BuildRuntime, enabled?: boolean, logging?: boolean, timeout?: number, installCommand?: string, buildCommand?: string, startCommand?: string, outputDirectory?: string, adapter?: Adapter, installationId?: string, fallbackFile?: string, providerRepositoryId?: string, providerBranch?: string, providerSilentMode?: boolean, providerRootDirectory?: string, buildSpecification?: string, runtimeSpecification?: string, deploymentRetention?: number): Promise<Models.Site>;
     /**
      * Get a list of all frameworks that are currently available on the server instance.
      *
@@ -160,6 +169,7 @@ declare class Sites {
      * @param {number} params.timeout - Maximum request time in seconds.
      * @param {string} params.installCommand - Install Command.
      * @param {string} params.buildCommand - Build Command.
+     * @param {string} params.startCommand - Custom start command. Leave empty to use default.
      * @param {string} params.outputDirectory - Output Directory for site.
      * @param {BuildRuntime} params.buildRuntime - Runtime to use during build step.
      * @param {Adapter} params.adapter - Framework adapter defining rendering strategy. Allowed values are: static, ssr
@@ -169,7 +179,9 @@ declare class Sites {
      * @param {string} params.providerBranch - Production branch for the repo linked to the site.
      * @param {boolean} params.providerSilentMode - Is the VCS (Version Control System) connection in silent mode for the repo linked to the site? In silent mode, comments will not be made on commits and pull requests.
      * @param {string} params.providerRootDirectory - Path to site code in the linked repo.
-     * @param {string} params.specification - Framework specification for the site and builds.
+     * @param {string} params.buildSpecification - Build specification for the site deployments.
+     * @param {string} params.runtimeSpecification - Runtime specification for the SSR executions.
+     * @param {number} params.deploymentRetention - Days to keep non-active deployments before deletion. Value 0 means all deployments will be kept.
      * @throws {AppwriteException}
      * @returns {Promise<Models.Site>}
      */
@@ -182,6 +194,7 @@ declare class Sites {
         timeout?: number;
         installCommand?: string;
         buildCommand?: string;
+        startCommand?: string;
         outputDirectory?: string;
         buildRuntime?: BuildRuntime;
         adapter?: Adapter;
@@ -191,7 +204,9 @@ declare class Sites {
         providerBranch?: string;
         providerSilentMode?: boolean;
         providerRootDirectory?: string;
-        specification?: string;
+        buildSpecification?: string;
+        runtimeSpecification?: string;
+        deploymentRetention?: number;
     }): Promise<Models.Site>;
     /**
      * Update site by its unique ID.
@@ -204,6 +219,7 @@ declare class Sites {
      * @param {number} timeout - Maximum request time in seconds.
      * @param {string} installCommand - Install Command.
      * @param {string} buildCommand - Build Command.
+     * @param {string} startCommand - Custom start command. Leave empty to use default.
      * @param {string} outputDirectory - Output Directory for site.
      * @param {BuildRuntime} buildRuntime - Runtime to use during build step.
      * @param {Adapter} adapter - Framework adapter defining rendering strategy. Allowed values are: static, ssr
@@ -213,12 +229,14 @@ declare class Sites {
      * @param {string} providerBranch - Production branch for the repo linked to the site.
      * @param {boolean} providerSilentMode - Is the VCS (Version Control System) connection in silent mode for the repo linked to the site? In silent mode, comments will not be made on commits and pull requests.
      * @param {string} providerRootDirectory - Path to site code in the linked repo.
-     * @param {string} specification - Framework specification for the site and builds.
+     * @param {string} buildSpecification - Build specification for the site deployments.
+     * @param {string} runtimeSpecification - Runtime specification for the SSR executions.
+     * @param {number} deploymentRetention - Days to keep non-active deployments before deletion. Value 0 means all deployments will be kept.
      * @throws {AppwriteException}
      * @returns {Promise<Models.Site>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    update(siteId: string, name: string, framework: Framework, enabled?: boolean, logging?: boolean, timeout?: number, installCommand?: string, buildCommand?: string, outputDirectory?: string, buildRuntime?: BuildRuntime, adapter?: Adapter, fallbackFile?: string, installationId?: string, providerRepositoryId?: string, providerBranch?: string, providerSilentMode?: boolean, providerRootDirectory?: string, specification?: string): Promise<Models.Site>;
+    update(siteId: string, name: string, framework: Framework, enabled?: boolean, logging?: boolean, timeout?: number, installCommand?: string, buildCommand?: string, startCommand?: string, outputDirectory?: string, buildRuntime?: BuildRuntime, adapter?: Adapter, fallbackFile?: string, installationId?: string, providerRepositoryId?: string, providerBranch?: string, providerSilentMode?: boolean, providerRootDirectory?: string, buildSpecification?: string, runtimeSpecification?: string, deploymentRetention?: number): Promise<Models.Site>;
     /**
      * Delete a site by its unique ID.
      *

package/dist/services/sites.js

@@ -55,15 +55,18 @@ class Sites {
         timeout: rest[5],
         installCommand: rest[6],
         buildCommand: rest[7],
-        outputDirectory: rest[8],
-        adapter: rest[9],
-        installationId: rest[10],
-        fallbackFile: rest[11],
-        providerRepositoryId: rest[12],
-        providerBranch: rest[13],
-        providerSilentMode: rest[14],
-        providerRootDirectory: rest[15],
-        specification: rest[16]
+        startCommand: rest[8],
+        outputDirectory: rest[9],
+        adapter: rest[10],
+        installationId: rest[11],
+        fallbackFile: rest[12],
+        providerRepositoryId: rest[13],
+        providerBranch: rest[14],
+        providerSilentMode: rest[15],
+        providerRootDirectory: rest[16],
+        buildSpecification: rest[17],
+        runtimeSpecification: rest[18],
+        deploymentRetention: rest[19]
       };
     }
     const siteId = params.siteId;
@@ -75,6 +78,7 @@ class Sites {
     const timeout = params.timeout;
     const installCommand = params.installCommand;
     const buildCommand = params.buildCommand;
+    const startCommand = params.startCommand;
     const outputDirectory = params.outputDirectory;
     const adapter = params.adapter;
     const installationId = params.installationId;
@@ -83,7 +87,9 @@ class Sites {
     const providerBranch = params.providerBranch;
     const providerSilentMode = params.providerSilentMode;
     const providerRootDirectory = params.providerRootDirectory;
-    const specification = params.specification;
+    const buildSpecification = params.buildSpecification;
+    const runtimeSpecification = params.runtimeSpecification;
+    const deploymentRetention = params.deploymentRetention;
     if (typeof siteId === "undefined") {
       throw new client.AppwriteException('Missing required parameter: "siteId"');
     }
@@ -122,6 +128,9 @@ class Sites {
     if (typeof buildCommand !== "undefined") {
       payload["buildCommand"] = buildCommand;
     }
+    if (typeof startCommand !== "undefined") {
+      payload["startCommand"] = startCommand;
+    }
     if (typeof outputDirectory !== "undefined") {
       payload["outputDirectory"] = outputDirectory;
     }
@@ -149,8 +158,14 @@ class Sites {
     if (typeof providerRootDirectory !== "undefined") {
       payload["providerRootDirectory"] = providerRootDirectory;
     }
-    if (typeof specification !== "undefined") {
-      payload["specification"] = specification;
+    if (typeof buildSpecification !== "undefined") {
+      payload["buildSpecification"] = buildSpecification;
+    }
+    if (typeof runtimeSpecification !== "undefined") {
+      payload["runtimeSpecification"] = runtimeSpecification;
+    }
+    if (typeof deploymentRetention !== "undefined") {
+      payload["deploymentRetention"] = deploymentRetention;
     }
     const uri = new URL(this.client.config.endpoint + apiPath);
     const apiHeaders = {
@@ -237,16 +252,19 @@ class Sites {
         timeout: rest[4],
         installCommand: rest[5],
         buildCommand: rest[6],
-        outputDirectory: rest[7],
-        buildRuntime: rest[8],
-        adapter: rest[9],
-        fallbackFile: rest[10],
-        installationId: rest[11],
-        providerRepositoryId: rest[12],
-        providerBranch: rest[13],
-        providerSilentMode: rest[14],
-        providerRootDirectory: rest[15],
-        specification: rest[16]
+        startCommand: rest[7],
+        outputDirectory: rest[8],
+        buildRuntime: rest[9],
+        adapter: rest[10],
+        fallbackFile: rest[11],
+        installationId: rest[12],
+        providerRepositoryId: rest[13],
+        providerBranch: rest[14],
+        providerSilentMode: rest[15],
+        providerRootDirectory: rest[16],
+        buildSpecification: rest[17],
+        runtimeSpecification: rest[18],
+        deploymentRetention: rest[19]
       };
     }
     const siteId = params.siteId;
@@ -257,6 +275,7 @@ class Sites {
     const timeout = params.timeout;
     const installCommand = params.installCommand;
     const buildCommand = params.buildCommand;
+    const startCommand = params.startCommand;
     const outputDirectory = params.outputDirectory;
     const buildRuntime = params.buildRuntime;
     const adapter = params.adapter;
@@ -266,7 +285,9 @@ class Sites {
     const providerBranch = params.providerBranch;
     const providerSilentMode = params.providerSilentMode;
     const providerRootDirectory = params.providerRootDirectory;
-    const specification = params.specification;
+    const buildSpecification = params.buildSpecification;
+    const runtimeSpecification = params.runtimeSpecification;
+    const deploymentRetention = params.deploymentRetention;
     if (typeof siteId === "undefined") {
       throw new client.AppwriteException('Missing required parameter: "siteId"');
     }
@@ -299,6 +320,9 @@ class Sites {
     if (typeof buildCommand !== "undefined") {
       payload["buildCommand"] = buildCommand;
     }
+    if (typeof startCommand !== "undefined") {
+      payload["startCommand"] = startCommand;
+    }
     if (typeof outputDirectory !== "undefined") {
       payload["outputDirectory"] = outputDirectory;
     }
@@ -326,8 +350,14 @@ class Sites {
     if (typeof providerRootDirectory !== "undefined") {
       payload["providerRootDirectory"] = providerRootDirectory;
     }
-    if (typeof specification !== "undefined") {
-      payload["specification"] = specification;
+    if (typeof buildSpecification !== "undefined") {
+      payload["buildSpecification"] = buildSpecification;
+    }
+    if (typeof runtimeSpecification !== "undefined") {
+      payload["runtimeSpecification"] = runtimeSpecification;
+    }
+    if (typeof deploymentRetention !== "undefined") {
+      payload["deploymentRetention"] = deploymentRetention;
     }
     const uri = new URL(this.client.config.endpoint + apiPath);
     const apiHeaders = {