node-appwrite 16.0.0 → 17.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (92) hide show
  1. package/README.md +2 -2
  2. package/dist/client.js +3 -3
  3. package/dist/client.js.map +1 -1
  4. package/dist/client.mjs +3 -3
  5. package/dist/client.mjs.map +1 -1
  6. package/dist/enums/adapter.d.mts +6 -0
  7. package/dist/enums/adapter.d.ts +6 -0
  8. package/dist/enums/adapter.js +11 -0
  9. package/dist/enums/adapter.js.map +1 -0
  10. package/dist/enums/adapter.mjs +10 -0
  11. package/dist/enums/adapter.mjs.map +1 -0
  12. package/dist/enums/build-runtime.d.mts +67 -0
  13. package/dist/enums/build-runtime.d.ts +67 -0
  14. package/dist/enums/build-runtime.js +72 -0
  15. package/dist/enums/build-runtime.js.map +1 -0
  16. package/dist/enums/build-runtime.mjs +71 -0
  17. package/dist/enums/build-runtime.mjs.map +1 -0
  18. package/dist/enums/deployment-download-type.d.mts +6 -0
  19. package/dist/enums/deployment-download-type.d.ts +6 -0
  20. package/dist/enums/deployment-download-type.js +11 -0
  21. package/dist/enums/deployment-download-type.js.map +1 -0
  22. package/dist/enums/deployment-download-type.mjs +10 -0
  23. package/dist/enums/deployment-download-type.mjs.map +1 -0
  24. package/dist/enums/framework.d.mts +18 -0
  25. package/dist/enums/framework.d.ts +18 -0
  26. package/dist/enums/framework.js +23 -0
  27. package/dist/enums/framework.js.map +1 -0
  28. package/dist/enums/framework.mjs +22 -0
  29. package/dist/enums/framework.mjs.map +1 -0
  30. package/dist/enums/image-format.d.mts +0 -1
  31. package/dist/enums/image-format.d.ts +0 -1
  32. package/dist/enums/image-format.js +0 -1
  33. package/dist/enums/image-format.js.map +1 -1
  34. package/dist/enums/image-format.mjs +0 -1
  35. package/dist/enums/image-format.mjs.map +1 -1
  36. package/dist/enums/runtime.d.mts +5 -1
  37. package/dist/enums/runtime.d.ts +5 -1
  38. package/dist/enums/runtime.js +4 -0
  39. package/dist/enums/runtime.js.map +1 -1
  40. package/dist/enums/runtime.mjs +4 -0
  41. package/dist/enums/runtime.mjs.map +1 -1
  42. package/dist/enums/v-c-s-deployment-type.d.mts +7 -0
  43. package/dist/enums/v-c-s-deployment-type.d.ts +7 -0
  44. package/dist/enums/v-c-s-deployment-type.js +12 -0
  45. package/dist/enums/v-c-s-deployment-type.js.map +1 -0
  46. package/dist/enums/v-c-s-deployment-type.mjs +11 -0
  47. package/dist/enums/v-c-s-deployment-type.mjs.map +1 -0
  48. package/dist/index.d.mts +7 -0
  49. package/dist/index.d.ts +7 -0
  50. package/dist/index.js +35 -0
  51. package/dist/index.js.map +1 -1
  52. package/dist/index.mjs +7 -0
  53. package/dist/index.mjs.map +1 -1
  54. package/dist/models.d.mts +286 -48
  55. package/dist/models.d.ts +286 -48
  56. package/dist/services/databases.d.mts +44 -2
  57. package/dist/services/databases.d.ts +44 -2
  58. package/dist/services/databases.js +151 -12
  59. package/dist/services/databases.js.map +1 -1
  60. package/dist/services/databases.mjs +151 -12
  61. package/dist/services/databases.mjs.map +1 -1
  62. package/dist/services/functions.d.mts +56 -30
  63. package/dist/services/functions.d.ts +56 -30
  64. package/dist/services/functions.js +185 -87
  65. package/dist/services/functions.js.map +1 -1
  66. package/dist/services/functions.mjs +185 -87
  67. package/dist/services/functions.mjs.map +1 -1
  68. package/dist/services/sites.d.mts +286 -0
  69. package/dist/services/sites.d.ts +286 -0
  70. package/dist/services/sites.js +923 -0
  71. package/dist/services/sites.js.map +1 -0
  72. package/dist/services/sites.mjs +922 -0
  73. package/dist/services/sites.mjs.map +1 -0
  74. package/dist/services/storage.d.mts +6 -3
  75. package/dist/services/storage.d.ts +6 -3
  76. package/dist/services/storage.js +15 -3
  77. package/dist/services/storage.js.map +1 -1
  78. package/dist/services/storage.mjs +15 -3
  79. package/dist/services/storage.mjs.map +1 -1
  80. package/dist/services/tokens.d.mts +55 -0
  81. package/dist/services/tokens.d.ts +55 -0
  82. package/dist/services/tokens.js +149 -0
  83. package/dist/services/tokens.js.map +1 -0
  84. package/dist/services/tokens.mjs +148 -0
  85. package/dist/services/tokens.mjs.map +1 -0
  86. package/dist/services/users.d.mts +3 -1
  87. package/dist/services/users.d.ts +3 -1
  88. package/dist/services/users.js +9 -1
  89. package/dist/services/users.js.map +1 -1
  90. package/dist/services/users.mjs +9 -1
  91. package/dist/services/users.mjs.map +1 -1
  92. package/package.json +1 -1
package/dist/models.d.mts CHANGED
@@ -132,6 +132,19 @@ declare namespace Models {
132
132
  */
133
133
  buckets: Bucket[];
134
134
  };
135
+ /**
136
+ * Resource Tokens List
137
+ */
138
+ type ResourceTokenList = {
139
+ /**
140
+ * Total number of tokens documents that matched your query.
141
+ */
142
+ total: number;
143
+ /**
144
+ * List of tokens.
145
+ */
146
+ tokens: ResourceToken[];
147
+ };
135
148
  /**
136
149
  * Teams List
137
150
  */
@@ -158,6 +171,19 @@ declare namespace Models {
158
171
  */
159
172
  memberships: Membership[];
160
173
  };
174
+ /**
175
+ * Sites List
176
+ */
177
+ type SiteList = {
178
+ /**
179
+ * Total number of sites documents that matched your query.
180
+ */
181
+ total: number;
182
+ /**
183
+ * List of sites.
184
+ */
185
+ sites: Site[];
186
+ };
161
187
  /**
162
188
  * Functions List
163
189
  */
@@ -171,6 +197,19 @@ declare namespace Models {
171
197
  */
172
198
  functions: Function[];
173
199
  };
200
+ /**
201
+ * Frameworks List
202
+ */
203
+ type FrameworkList = {
204
+ /**
205
+ * Total number of frameworks documents that matched your query.
206
+ */
207
+ total: number;
208
+ /**
209
+ * List of frameworks.
210
+ */
211
+ frameworks: Framework[];
212
+ };
174
213
  /**
175
214
  * Runtimes List
176
215
  */
@@ -960,6 +999,10 @@ declare namespace Models {
960
999
  * Index attributes.
961
1000
  */
962
1001
  attributes: string[];
1002
+ /**
1003
+ * Index attributes length.
1004
+ */
1005
+ lengths: number[];
963
1006
  /**
964
1007
  * Index orders.
965
1008
  */
@@ -1634,6 +1677,39 @@ declare namespace Models {
1634
1677
  */
1635
1678
  antivirus: boolean;
1636
1679
  };
1680
+ /**
1681
+ * ResourceToken
1682
+ */
1683
+ type ResourceToken = {
1684
+ /**
1685
+ * Token ID.
1686
+ */
1687
+ $id: string;
1688
+ /**
1689
+ * Token creation date in ISO 8601 format.
1690
+ */
1691
+ $createdAt: string;
1692
+ /**
1693
+ * Resource ID.
1694
+ */
1695
+ resourceId: string;
1696
+ /**
1697
+ * Resource type.
1698
+ */
1699
+ resourceType: string;
1700
+ /**
1701
+ * Token expiration date in ISO 8601 format.
1702
+ */
1703
+ expire: string;
1704
+ /**
1705
+ * JWT encoded string.
1706
+ */
1707
+ secret: string;
1708
+ /**
1709
+ * Most recent access date in ISO 8601 format. This attribute is only updated again after 24 hours.
1710
+ */
1711
+ accessedAt: string;
1712
+ };
1637
1713
  /**
1638
1714
  * Team
1639
1715
  */
@@ -1720,6 +1796,127 @@ declare namespace Models {
1720
1796
  */
1721
1797
  roles: string[];
1722
1798
  };
1799
+ /**
1800
+ * Site
1801
+ */
1802
+ type Site = {
1803
+ /**
1804
+ * Site ID.
1805
+ */
1806
+ $id: string;
1807
+ /**
1808
+ * Site creation date in ISO 8601 format.
1809
+ */
1810
+ $createdAt: string;
1811
+ /**
1812
+ * Site update date in ISO 8601 format.
1813
+ */
1814
+ $updatedAt: string;
1815
+ /**
1816
+ * Site name.
1817
+ */
1818
+ name: string;
1819
+ /**
1820
+ * Site enabled.
1821
+ */
1822
+ enabled: boolean;
1823
+ /**
1824
+ * Is the site deployed with the latest configuration? This is set to false if you've changed an environment variables, entrypoint, commands, or other settings that needs redeploy to be applied. When the value is false, redeploy the site to update it with the latest configuration.
1825
+ */
1826
+ live: boolean;
1827
+ /**
1828
+ * When disabled, request logs will exclude logs and errors, and site responses will be slightly faster.
1829
+ */
1830
+ logging: boolean;
1831
+ /**
1832
+ * Site framework.
1833
+ */
1834
+ framework: string;
1835
+ /**
1836
+ * Site's active deployment ID.
1837
+ */
1838
+ deploymentId: string;
1839
+ /**
1840
+ * Active deployment creation date in ISO 8601 format.
1841
+ */
1842
+ deploymentCreatedAt: string;
1843
+ /**
1844
+ * Screenshot of active deployment with light theme preference file ID.
1845
+ */
1846
+ deploymentScreenshotLight: string;
1847
+ /**
1848
+ * Screenshot of active deployment with dark theme preference file ID.
1849
+ */
1850
+ deploymentScreenshotDark: string;
1851
+ /**
1852
+ * Site's latest deployment ID.
1853
+ */
1854
+ latestDeploymentId: string;
1855
+ /**
1856
+ * Latest deployment creation date in ISO 8601 format.
1857
+ */
1858
+ latestDeploymentCreatedAt: string;
1859
+ /**
1860
+ * Status of latest deployment. Possible values are "waiting", "processing", "building", "ready", and "failed".
1861
+ */
1862
+ latestDeploymentStatus: string;
1863
+ /**
1864
+ * Site variables.
1865
+ */
1866
+ vars: Variable[];
1867
+ /**
1868
+ * Site request timeout in seconds.
1869
+ */
1870
+ timeout: number;
1871
+ /**
1872
+ * The install command used to install the site dependencies.
1873
+ */
1874
+ installCommand: string;
1875
+ /**
1876
+ * The build command used to build the site.
1877
+ */
1878
+ buildCommand: string;
1879
+ /**
1880
+ * The directory where the site build output is located.
1881
+ */
1882
+ outputDirectory: string;
1883
+ /**
1884
+ * Site VCS (Version Control System) installation id.
1885
+ */
1886
+ installationId: string;
1887
+ /**
1888
+ * VCS (Version Control System) Repository ID
1889
+ */
1890
+ providerRepositoryId: string;
1891
+ /**
1892
+ * VCS (Version Control System) branch name
1893
+ */
1894
+ providerBranch: string;
1895
+ /**
1896
+ * Path to site in VCS (Version Control System) repository
1897
+ */
1898
+ providerRootDirectory: string;
1899
+ /**
1900
+ * Is VCS (Version Control System) connection is in silent mode? When in silence mode, no comments will be posted on the repository pull or merge requests
1901
+ */
1902
+ providerSilentMode: boolean;
1903
+ /**
1904
+ * Machine specification for builds and executions.
1905
+ */
1906
+ specification: string;
1907
+ /**
1908
+ * Site build runtime.
1909
+ */
1910
+ buildRuntime: string;
1911
+ /**
1912
+ * Site framework adapter.
1913
+ */
1914
+ adapter: string;
1915
+ /**
1916
+ * Name of fallback file to use instead of 404 page. If null, Appwrite 404 page will be displayed.
1917
+ */
1918
+ fallbackFile: string;
1919
+ };
1723
1920
  /**
1724
1921
  * Function
1725
1922
  */
@@ -1753,17 +1950,33 @@ declare namespace Models {
1753
1950
  */
1754
1951
  live: boolean;
1755
1952
  /**
1756
- * Whether executions will be logged. When set to false, executions will not be logged, but will reduce resource used by your Appwrite project.
1953
+ * When disabled, executions will exclude logs and errors, and will be slightly faster.
1757
1954
  */
1758
1955
  logging: boolean;
1759
1956
  /**
1760
- * Function execution runtime.
1957
+ * Function execution and build runtime.
1761
1958
  */
1762
1959
  runtime: string;
1763
1960
  /**
1764
1961
  * Function's active deployment ID.
1765
1962
  */
1766
- deployment: string;
1963
+ deploymentId: string;
1964
+ /**
1965
+ * Active deployment creation date in ISO 8601 format.
1966
+ */
1967
+ deploymentCreatedAt: string;
1968
+ /**
1969
+ * Function's latest deployment ID.
1970
+ */
1971
+ latestDeploymentId: string;
1972
+ /**
1973
+ * Latest deployment creation date in ISO 8601 format.
1974
+ */
1975
+ latestDeploymentCreatedAt: string;
1976
+ /**
1977
+ * Status of latest deployment. Possible values are "waiting", "processing", "building", "ready", and "failed".
1978
+ */
1979
+ latestDeploymentStatus: string;
1767
1980
  /**
1768
1981
  * Allowed permission scopes.
1769
1982
  */
@@ -1858,6 +2071,56 @@ declare namespace Models {
1858
2071
  */
1859
2072
  supports: string[];
1860
2073
  };
2074
+ /**
2075
+ * Framework
2076
+ */
2077
+ type Framework = {
2078
+ /**
2079
+ * Framework key.
2080
+ */
2081
+ key: string;
2082
+ /**
2083
+ * Framework Name.
2084
+ */
2085
+ name: string;
2086
+ /**
2087
+ * Default runtime version.
2088
+ */
2089
+ buildRuntime: string;
2090
+ /**
2091
+ * List of supported runtime versions.
2092
+ */
2093
+ runtimes: string[];
2094
+ /**
2095
+ * List of supported adapters.
2096
+ */
2097
+ adapters: FrameworkAdapter[];
2098
+ };
2099
+ /**
2100
+ * Framework Adapter
2101
+ */
2102
+ type FrameworkAdapter = {
2103
+ /**
2104
+ * Adapter key.
2105
+ */
2106
+ key: string;
2107
+ /**
2108
+ * Default command to download dependencies.
2109
+ */
2110
+ installCommand: string;
2111
+ /**
2112
+ * Default command to build site into output directory.
2113
+ */
2114
+ buildCommand: string;
2115
+ /**
2116
+ * Default output directory of build.
2117
+ */
2118
+ outputDirectory: string;
2119
+ /**
2120
+ * Name of fallback file to use instead of 404 page. If null, Appwrite 404 page will be displayed.
2121
+ */
2122
+ fallbackFile: string;
2123
+ };
1861
2124
  /**
1862
2125
  * Deployment
1863
2126
  */
@@ -1893,11 +2156,15 @@ declare namespace Models {
1893
2156
  /**
1894
2157
  * The code size in bytes.
1895
2158
  */
1896
- size: number;
2159
+ sourceSize: number;
1897
2160
  /**
1898
2161
  * The build output size in bytes.
1899
2162
  */
1900
2163
  buildSize: number;
2164
+ /**
2165
+ * The total size in bytes (source and build output).
2166
+ */
2167
+ totalSize: number;
1901
2168
  /**
1902
2169
  * The current build ID.
1903
2170
  */
@@ -1907,7 +2174,15 @@ declare namespace Models {
1907
2174
  */
1908
2175
  activate: boolean;
1909
2176
  /**
1910
- * The deployment status. Possible values are "processing", "building", "waiting", "ready", and "failed".
2177
+ * Screenshot with light theme preference file ID.
2178
+ */
2179
+ screenshotLight: string;
2180
+ /**
2181
+ * Screenshot with dark theme preference file ID.
2182
+ */
2183
+ screenshotDark: string;
2184
+ /**
2185
+ * The deployment status. Possible values are "waiting", "processing", "building", "ready", and "failed".
1911
2186
  */
1912
2187
  status: string;
1913
2188
  /**
@@ -1917,7 +2192,7 @@ declare namespace Models {
1917
2192
  /**
1918
2193
  * The current build time in seconds.
1919
2194
  */
1920
- buildTime: number;
2195
+ buildDuration: number;
1921
2196
  /**
1922
2197
  * The name of the vcs provider repository
1923
2198
  */
@@ -2024,7 +2299,7 @@ declare namespace Models {
2024
2299
  */
2025
2300
  errors: string;
2026
2301
  /**
2027
- * Function execution duration in seconds.
2302
+ * Resource(function/site) execution duration in seconds.
2028
2303
  */
2029
2304
  duration: number;
2030
2305
  /**
@@ -2032,47 +2307,6 @@ declare namespace Models {
2032
2307
  */
2033
2308
  scheduledAt?: string;
2034
2309
  };
2035
- /**
2036
- * Build
2037
- */
2038
- type Build = {
2039
- /**
2040
- * Build ID.
2041
- */
2042
- $id: string;
2043
- /**
2044
- * The deployment that created this build.
2045
- */
2046
- deploymentId: string;
2047
- /**
2048
- * 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
2049
- */
2050
- status: string;
2051
- /**
2052
- * The stdout of the build.
2053
- */
2054
- stdout: string;
2055
- /**
2056
- * The stderr of the build.
2057
- */
2058
- stderr: string;
2059
- /**
2060
- * The deployment creation date in ISO 8601 format.
2061
- */
2062
- startTime: string;
2063
- /**
2064
- * The time the build was finished in ISO 8601 format.
2065
- */
2066
- endTime: string;
2067
- /**
2068
- * The build duration in seconds.
2069
- */
2070
- duration: number;
2071
- /**
2072
- * The code size in bytes.
2073
- */
2074
- size: number;
2075
- };
2076
2310
  /**
2077
2311
  * Variable
2078
2312
  */
@@ -2097,6 +2331,10 @@ declare namespace Models {
2097
2331
  * Variable value.
2098
2332
  */
2099
2333
  value: string;
2334
+ /**
2335
+ * Variable secret flag. Secret variables can only be updated or deleted, but never read.
2336
+ */
2337
+ secret: boolean;
2100
2338
  /**
2101
2339
  * Service to which the variable belongs. Possible values are "project", "function"
2102
2340
  */