@njdamstra/appwrite-utils-cli 1.8.9 → 1.10.1

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 (285) hide show
  1. package/CHANGELOG.md +16 -0
  2. package/CONFIG_TODO.md +1189 -0
  3. package/SELECTION_DIALOGS.md +146 -0
  4. package/SERVICE_IMPLEMENTATION_REPORT.md +462 -0
  5. package/dist/adapters/index.d.ts +7 -8
  6. package/dist/adapters/index.js +7 -9
  7. package/dist/backups/operations/bucketBackup.js +2 -2
  8. package/dist/backups/operations/collectionBackup.d.ts +1 -1
  9. package/dist/backups/operations/collectionBackup.js +3 -3
  10. package/dist/backups/operations/comprehensiveBackup.d.ts +1 -1
  11. package/dist/backups/operations/comprehensiveBackup.js +2 -2
  12. package/dist/backups/tracking/centralizedTracking.d.ts +1 -1
  13. package/dist/backups/tracking/centralizedTracking.js +2 -2
  14. package/dist/cli/commands/configCommands.js +51 -7
  15. package/dist/cli/commands/databaseCommands.d.ts +1 -0
  16. package/dist/cli/commands/databaseCommands.js +119 -9
  17. package/dist/cli/commands/functionCommands.js +3 -3
  18. package/dist/cli/commands/importFileCommands.d.ts +7 -0
  19. package/dist/cli/commands/importFileCommands.js +674 -0
  20. package/dist/cli/commands/schemaCommands.js +3 -3
  21. package/dist/cli/commands/storageCommands.js +2 -3
  22. package/dist/cli/commands/transferCommands.js +3 -5
  23. package/dist/collections/attributes.d.ts +1 -1
  24. package/dist/collections/attributes.js +85 -35
  25. package/dist/collections/indexes.js +2 -4
  26. package/dist/collections/methods.d.ts +1 -1
  27. package/dist/collections/methods.js +111 -192
  28. package/dist/collections/tableOperations.d.ts +1 -0
  29. package/dist/collections/tableOperations.js +90 -23
  30. package/dist/collections/transferOperations.d.ts +1 -1
  31. package/dist/collections/transferOperations.js +3 -4
  32. package/dist/collections/wipeOperations.d.ts +4 -3
  33. package/dist/collections/wipeOperations.js +112 -39
  34. package/dist/databases/methods.js +2 -2
  35. package/dist/databases/setup.js +2 -2
  36. package/dist/examples/yamlTerminologyExample.js +2 -2
  37. package/dist/functions/deployments.d.ts +1 -1
  38. package/dist/functions/deployments.js +5 -5
  39. package/dist/functions/fnConfigDiscovery.js +2 -2
  40. package/dist/functions/methods.js +16 -4
  41. package/dist/init.js +1 -1
  42. package/dist/interactiveCLI.d.ts +6 -1
  43. package/dist/interactiveCLI.js +64 -10
  44. package/dist/main.js +130 -177
  45. package/dist/migrations/afterImportActions.js +2 -3
  46. package/dist/migrations/appwriteToX.d.ts +97 -1
  47. package/dist/migrations/appwriteToX.js +9 -7
  48. package/dist/migrations/comprehensiveTransfer.js +3 -5
  49. package/dist/migrations/dataLoader.d.ts +194 -2
  50. package/dist/migrations/dataLoader.js +2 -5
  51. package/dist/migrations/importController.js +3 -4
  52. package/dist/migrations/importDataActions.js +3 -3
  53. package/dist/migrations/relationships.js +1 -2
  54. package/dist/migrations/services/DataTransformationService.js +2 -2
  55. package/dist/migrations/services/FileHandlerService.js +1 -1
  56. package/dist/migrations/services/ImportOrchestrator.js +4 -4
  57. package/dist/migrations/services/RateLimitManager.js +1 -1
  58. package/dist/migrations/services/RelationshipResolver.js +1 -1
  59. package/dist/migrations/services/UserMappingService.js +1 -1
  60. package/dist/migrations/services/ValidationService.js +1 -1
  61. package/dist/migrations/transfer.d.ts +8 -4
  62. package/dist/migrations/transfer.js +106 -55
  63. package/dist/migrations/yaml/YamlImportConfigLoader.js +1 -1
  64. package/dist/migrations/yaml/YamlImportIntegration.js +2 -2
  65. package/dist/migrations/yaml/generateImportSchemas.js +1 -1
  66. package/dist/setupCommands.d.ts +1 -1
  67. package/dist/setupCommands.js +5 -6
  68. package/dist/setupController.js +1 -1
  69. package/dist/shared/backupTracking.d.ts +1 -1
  70. package/dist/shared/backupTracking.js +2 -2
  71. package/dist/shared/confirmationDialogs.js +1 -1
  72. package/dist/shared/migrationHelpers.d.ts +1 -1
  73. package/dist/shared/migrationHelpers.js +3 -3
  74. package/dist/shared/operationQueue.d.ts +1 -1
  75. package/dist/shared/operationQueue.js +2 -3
  76. package/dist/shared/operationsTable.d.ts +1 -1
  77. package/dist/shared/operationsTable.js +2 -2
  78. package/dist/shared/progressManager.js +1 -1
  79. package/dist/shared/selectionDialogs.js +9 -8
  80. package/dist/storage/methods.js +4 -4
  81. package/dist/storage/schemas.d.ts +386 -2
  82. package/dist/tables/indexManager.d.ts +65 -0
  83. package/dist/tables/indexManager.js +294 -0
  84. package/dist/types.d.ts +2 -2
  85. package/dist/types.js +1 -1
  86. package/dist/users/methods.js +2 -3
  87. package/dist/utils/configMigration.js +1 -1
  88. package/dist/utils/index.d.ts +1 -1
  89. package/dist/utils/index.js +1 -1
  90. package/dist/utils/loadConfigs.d.ts +2 -2
  91. package/dist/utils/loadConfigs.js +6 -7
  92. package/dist/utils/setupFiles.js +5 -7
  93. package/dist/utilsController.d.ts +15 -8
  94. package/dist/utilsController.js +57 -28
  95. package/package.json +8 -4
  96. package/src/adapters/index.ts +8 -34
  97. package/src/backups/operations/bucketBackup.ts +2 -2
  98. package/src/backups/operations/collectionBackup.ts +4 -4
  99. package/src/backups/operations/comprehensiveBackup.ts +3 -3
  100. package/src/backups/tracking/centralizedTracking.ts +3 -3
  101. package/src/cli/commands/configCommands.ts +72 -8
  102. package/src/cli/commands/databaseCommands.ts +161 -9
  103. package/src/cli/commands/functionCommands.ts +4 -3
  104. package/src/cli/commands/importFileCommands.ts +815 -0
  105. package/src/cli/commands/schemaCommands.ts +3 -3
  106. package/src/cli/commands/storageCommands.ts +2 -3
  107. package/src/cli/commands/transferCommands.ts +3 -6
  108. package/src/collections/attributes.ts +155 -39
  109. package/src/collections/indexes.ts +5 -7
  110. package/src/collections/methods.ts +115 -150
  111. package/src/collections/tableOperations.ts +92 -21
  112. package/src/collections/transferOperations.ts +4 -5
  113. package/src/collections/wipeOperations.ts +154 -51
  114. package/src/databases/methods.ts +2 -2
  115. package/src/databases/setup.ts +2 -2
  116. package/src/examples/yamlTerminologyExample.ts +2 -2
  117. package/src/functions/deployments.ts +6 -5
  118. package/src/functions/fnConfigDiscovery.ts +2 -2
  119. package/src/functions/methods.ts +19 -6
  120. package/src/init.ts +1 -1
  121. package/src/interactiveCLI.ts +78 -13
  122. package/src/main.ts +143 -287
  123. package/src/migrations/afterImportActions.ts +2 -3
  124. package/src/migrations/appwriteToX.ts +12 -8
  125. package/src/migrations/comprehensiveTransfer.ts +6 -6
  126. package/src/migrations/dataLoader.ts +2 -5
  127. package/src/migrations/importController.ts +3 -4
  128. package/src/migrations/importDataActions.ts +3 -3
  129. package/src/migrations/relationships.ts +1 -2
  130. package/src/migrations/services/DataTransformationService.ts +2 -2
  131. package/src/migrations/services/FileHandlerService.ts +1 -1
  132. package/src/migrations/services/ImportOrchestrator.ts +4 -4
  133. package/src/migrations/services/RateLimitManager.ts +1 -1
  134. package/src/migrations/services/RelationshipResolver.ts +1 -1
  135. package/src/migrations/services/UserMappingService.ts +1 -1
  136. package/src/migrations/services/ValidationService.ts +1 -1
  137. package/src/migrations/transfer.ts +126 -83
  138. package/src/migrations/yaml/YamlImportConfigLoader.ts +1 -1
  139. package/src/migrations/yaml/YamlImportIntegration.ts +2 -2
  140. package/src/migrations/yaml/generateImportSchemas.ts +1 -1
  141. package/src/setupCommands.ts +5 -6
  142. package/src/setupController.ts +1 -1
  143. package/src/shared/backupTracking.ts +3 -3
  144. package/src/shared/confirmationDialogs.ts +1 -1
  145. package/src/shared/migrationHelpers.ts +4 -4
  146. package/src/shared/operationQueue.ts +3 -4
  147. package/src/shared/operationsTable.ts +3 -3
  148. package/src/shared/progressManager.ts +1 -1
  149. package/src/shared/selectionDialogs.ts +9 -8
  150. package/src/storage/methods.ts +4 -4
  151. package/src/tables/indexManager.ts +409 -0
  152. package/src/types.ts +2 -2
  153. package/src/users/methods.ts +2 -3
  154. package/src/utils/configMigration.ts +1 -1
  155. package/src/utils/index.ts +1 -1
  156. package/src/utils/loadConfigs.ts +15 -7
  157. package/src/utils/setupFiles.ts +5 -7
  158. package/src/utilsController.ts +86 -32
  159. package/dist/adapters/AdapterFactory.d.ts +0 -94
  160. package/dist/adapters/AdapterFactory.js +0 -405
  161. package/dist/adapters/DatabaseAdapter.d.ts +0 -233
  162. package/dist/adapters/DatabaseAdapter.js +0 -50
  163. package/dist/adapters/LegacyAdapter.d.ts +0 -50
  164. package/dist/adapters/LegacyAdapter.js +0 -612
  165. package/dist/adapters/TablesDBAdapter.d.ts +0 -45
  166. package/dist/adapters/TablesDBAdapter.js +0 -571
  167. package/dist/config/ConfigManager.d.ts +0 -445
  168. package/dist/config/ConfigManager.js +0 -625
  169. package/dist/config/configMigration.d.ts +0 -87
  170. package/dist/config/configMigration.js +0 -390
  171. package/dist/config/configValidation.d.ts +0 -66
  172. package/dist/config/configValidation.js +0 -358
  173. package/dist/config/index.d.ts +0 -8
  174. package/dist/config/index.js +0 -7
  175. package/dist/config/services/ConfigDiscoveryService.d.ts +0 -126
  176. package/dist/config/services/ConfigDiscoveryService.js +0 -374
  177. package/dist/config/services/ConfigLoaderService.d.ts +0 -129
  178. package/dist/config/services/ConfigLoaderService.js +0 -540
  179. package/dist/config/services/ConfigMergeService.d.ts +0 -208
  180. package/dist/config/services/ConfigMergeService.js +0 -308
  181. package/dist/config/services/ConfigValidationService.d.ts +0 -214
  182. package/dist/config/services/ConfigValidationService.js +0 -310
  183. package/dist/config/services/SessionAuthService.d.ts +0 -225
  184. package/dist/config/services/SessionAuthService.js +0 -456
  185. package/dist/config/services/__tests__/ConfigMergeService.test.d.ts +0 -1
  186. package/dist/config/services/__tests__/ConfigMergeService.test.js +0 -271
  187. package/dist/config/services/index.d.ts +0 -13
  188. package/dist/config/services/index.js +0 -10
  189. package/dist/config/yamlConfig.d.ts +0 -722
  190. package/dist/config/yamlConfig.js +0 -702
  191. package/dist/functions/pathResolution.d.ts +0 -37
  192. package/dist/functions/pathResolution.js +0 -185
  193. package/dist/shared/attributeMapper.d.ts +0 -20
  194. package/dist/shared/attributeMapper.js +0 -203
  195. package/dist/shared/errorUtils.d.ts +0 -54
  196. package/dist/shared/errorUtils.js +0 -95
  197. package/dist/shared/functionManager.d.ts +0 -48
  198. package/dist/shared/functionManager.js +0 -336
  199. package/dist/shared/indexManager.d.ts +0 -24
  200. package/dist/shared/indexManager.js +0 -151
  201. package/dist/shared/jsonSchemaGenerator.d.ts +0 -50
  202. package/dist/shared/jsonSchemaGenerator.js +0 -290
  203. package/dist/shared/logging.d.ts +0 -61
  204. package/dist/shared/logging.js +0 -116
  205. package/dist/shared/messageFormatter.d.ts +0 -39
  206. package/dist/shared/messageFormatter.js +0 -162
  207. package/dist/shared/pydanticModelGenerator.d.ts +0 -17
  208. package/dist/shared/pydanticModelGenerator.js +0 -615
  209. package/dist/shared/schemaGenerator.d.ts +0 -40
  210. package/dist/shared/schemaGenerator.js +0 -556
  211. package/dist/utils/ClientFactory.d.ts +0 -87
  212. package/dist/utils/ClientFactory.js +0 -212
  213. package/dist/utils/configDiscovery.d.ts +0 -78
  214. package/dist/utils/configDiscovery.js +0 -472
  215. package/dist/utils/constantsGenerator.d.ts +0 -31
  216. package/dist/utils/constantsGenerator.js +0 -321
  217. package/dist/utils/dataConverters.d.ts +0 -46
  218. package/dist/utils/dataConverters.js +0 -139
  219. package/dist/utils/directoryUtils.d.ts +0 -22
  220. package/dist/utils/directoryUtils.js +0 -59
  221. package/dist/utils/getClientFromConfig.d.ts +0 -39
  222. package/dist/utils/getClientFromConfig.js +0 -199
  223. package/dist/utils/helperFunctions.d.ts +0 -63
  224. package/dist/utils/helperFunctions.js +0 -156
  225. package/dist/utils/pathResolvers.d.ts +0 -53
  226. package/dist/utils/pathResolvers.js +0 -72
  227. package/dist/utils/projectConfig.d.ts +0 -119
  228. package/dist/utils/projectConfig.js +0 -171
  229. package/dist/utils/retryFailedPromises.d.ts +0 -2
  230. package/dist/utils/retryFailedPromises.js +0 -23
  231. package/dist/utils/sessionAuth.d.ts +0 -48
  232. package/dist/utils/sessionAuth.js +0 -164
  233. package/dist/utils/typeGuards.d.ts +0 -35
  234. package/dist/utils/typeGuards.js +0 -57
  235. package/dist/utils/validationRules.d.ts +0 -43
  236. package/dist/utils/validationRules.js +0 -42
  237. package/dist/utils/versionDetection.d.ts +0 -58
  238. package/dist/utils/versionDetection.js +0 -251
  239. package/dist/utils/yamlConverter.d.ts +0 -100
  240. package/dist/utils/yamlConverter.js +0 -428
  241. package/dist/utils/yamlLoader.d.ts +0 -70
  242. package/dist/utils/yamlLoader.js +0 -267
  243. package/src/adapters/AdapterFactory.ts +0 -510
  244. package/src/adapters/DatabaseAdapter.ts +0 -306
  245. package/src/adapters/LegacyAdapter.ts +0 -841
  246. package/src/adapters/TablesDBAdapter.ts +0 -773
  247. package/src/config/ConfigManager.ts +0 -808
  248. package/src/config/README.md +0 -274
  249. package/src/config/configMigration.ts +0 -575
  250. package/src/config/configValidation.ts +0 -445
  251. package/src/config/index.ts +0 -10
  252. package/src/config/services/ConfigDiscoveryService.ts +0 -463
  253. package/src/config/services/ConfigLoaderService.ts +0 -740
  254. package/src/config/services/ConfigMergeService.ts +0 -388
  255. package/src/config/services/ConfigValidationService.ts +0 -394
  256. package/src/config/services/SessionAuthService.ts +0 -565
  257. package/src/config/services/__tests__/ConfigMergeService.test.ts +0 -351
  258. package/src/config/services/index.ts +0 -29
  259. package/src/config/yamlConfig.ts +0 -761
  260. package/src/functions/pathResolution.ts +0 -227
  261. package/src/shared/attributeMapper.ts +0 -229
  262. package/src/shared/errorUtils.ts +0 -110
  263. package/src/shared/functionManager.ts +0 -525
  264. package/src/shared/indexManager.ts +0 -254
  265. package/src/shared/jsonSchemaGenerator.ts +0 -383
  266. package/src/shared/logging.ts +0 -149
  267. package/src/shared/messageFormatter.ts +0 -208
  268. package/src/shared/pydanticModelGenerator.ts +0 -618
  269. package/src/shared/schemaGenerator.ts +0 -644
  270. package/src/utils/ClientFactory.ts +0 -240
  271. package/src/utils/configDiscovery.ts +0 -557
  272. package/src/utils/constantsGenerator.ts +0 -369
  273. package/src/utils/dataConverters.ts +0 -159
  274. package/src/utils/directoryUtils.ts +0 -61
  275. package/src/utils/getClientFromConfig.ts +0 -257
  276. package/src/utils/helperFunctions.ts +0 -228
  277. package/src/utils/pathResolvers.ts +0 -81
  278. package/src/utils/projectConfig.ts +0 -299
  279. package/src/utils/retryFailedPromises.ts +0 -29
  280. package/src/utils/sessionAuth.ts +0 -230
  281. package/src/utils/typeGuards.ts +0 -65
  282. package/src/utils/validationRules.ts +0 -88
  283. package/src/utils/versionDetection.ts +0 -292
  284. package/src/utils/yamlConverter.ts +0 -542
  285. package/src/utils/yamlLoader.ts +0 -371
@@ -1,199 +0,0 @@
1
- import {} from "@njdamstra/appwrite-utils";
2
- import { Client } from "node-appwrite";
3
- import { AdapterFactory } from "../adapters/AdapterFactory.js";
4
- import { findSessionByEndpointAndProject, hasSessionAuth, isValidSessionCookie } from "./sessionAuth.js";
5
- import { MessageFormatter } from "../shared/messageFormatter.js";
6
- import { logger } from "../shared/logging.js";
7
- /**
8
- * Enhanced client creation from config with session authentication support
9
- * @deprecated Use getAdapterFromConfig for dual API support with session auth
10
- */
11
- export const getClientFromConfig = (config, sessionCookie) => {
12
- let appwriteClient;
13
- if (!config.appwriteClient) {
14
- appwriteClient = getClientWithAuth(config.appwriteEndpoint, config.appwriteProject, config.appwriteKey, sessionCookie);
15
- config.appwriteClient = appwriteClient;
16
- }
17
- return appwriteClient;
18
- };
19
- /**
20
- * Enhanced client creation with session authentication support
21
- * Priority: explicit session > session from prefs > API key
22
- */
23
- export const getClientWithAuth = (endpoint, project, key, sessionCookie) => {
24
- const client = new Client()
25
- .setEndpoint(endpoint)
26
- .setProject(project);
27
- const authAttempts = [];
28
- // Priority 1: Explicit session cookie provided
29
- if (sessionCookie) {
30
- if (isValidSessionCookie(sessionCookie)) {
31
- client.setSession(sessionCookie);
32
- logger.debug("Using explicit session authentication", { prefix: "Auth", project });
33
- return client;
34
- }
35
- else {
36
- authAttempts.push("explicit session cookie (invalid format)");
37
- MessageFormatter.warning(`Provided session cookie has invalid format`, { prefix: "Auth" });
38
- }
39
- }
40
- // Priority 2: Session from Appwrite CLI prefs
41
- const sessionAuth = findSessionByEndpointAndProject(endpoint, project);
42
- if (sessionAuth) {
43
- if (isValidSessionCookie(sessionAuth.sessionCookie)) {
44
- client.setSession(sessionAuth.sessionCookie);
45
- logger.debug("Using session authentication", { prefix: "Auth", project, email: sessionAuth.email || 'unknown user' });
46
- return client;
47
- }
48
- else {
49
- authAttempts.push("session from CLI prefs (invalid/expired)");
50
- MessageFormatter.warning(`Session cookie from CLI prefs is invalid or expired`, { prefix: "Auth" });
51
- }
52
- }
53
- // Priority 3: API key fallback
54
- if (key) {
55
- if (key.trim() === "") {
56
- authAttempts.push("API key (empty)");
57
- }
58
- else {
59
- client.setKey(key);
60
- logger.debug("Using API key authentication", { prefix: "Auth", project });
61
- return client;
62
- }
63
- }
64
- // Build detailed error message based on attempted methods
65
- const buildAuthError = () => {
66
- let errorMessage = `No valid authentication method available for project '${project}'.\n\n`;
67
- if (authAttempts.length > 0) {
68
- errorMessage += `Authentication methods attempted:\n`;
69
- authAttempts.forEach(attempt => {
70
- errorMessage += ` ✗ ${attempt}\n`;
71
- });
72
- errorMessage += `\n`;
73
- }
74
- errorMessage += `Available authentication options:\n`;
75
- errorMessage += ` 1. Session Authentication (Recommended):\n`;
76
- errorMessage += ` Run: appwrite login\n`;
77
- errorMessage += ` Then select your project and login with your account\n\n`;
78
- errorMessage += ` 2. API Key Authentication:\n`;
79
- errorMessage += ` - Set appwriteKey in your configuration\n`;
80
- errorMessage += ` - Or provide via --key command line option\n`;
81
- errorMessage += ` - Get your API key from: ${endpoint}/console/project-${project}/settings/keys\n\n`;
82
- errorMessage += ` 3. Environment Variables:\n`;
83
- errorMessage += ` Set APPWRITE_API_KEY environment variable\n\n`;
84
- errorMessage += `For more help, visit: https://appwrite.io/docs/tooling/command-line/installation`;
85
- return new Error(errorMessage);
86
- };
87
- throw buildAuthError();
88
- };
89
- /**
90
- * Legacy function - returns basic Client
91
- * @deprecated Use getClientWithAuth for session support or createDatabaseAdapter for dual API support
92
- */
93
- export const getClient = (endpoint, project, key) => {
94
- return getClientWithAuth(endpoint, project, key);
95
- };
96
- /**
97
- * Modern adapter-based client creation with dual API support and session authentication
98
- * Returns both adapter and legacy client for compatibility
99
- */
100
- export const getAdapterFromConfig = async (config, forceRefresh, sessionCookie) => {
101
- // Create enhanced config with session support
102
- const enhancedConfig = { ...config };
103
- // Check for session authentication if no explicit session provided
104
- if (!sessionCookie && !config.appwriteKey) {
105
- const sessionAuth = findSessionByEndpointAndProject(config.appwriteEndpoint, config.appwriteProject);
106
- if (sessionAuth && isValidSessionCookie(sessionAuth.sessionCookie)) {
107
- sessionCookie = sessionAuth.sessionCookie;
108
- }
109
- }
110
- // Override client creation in factory if session auth is available
111
- if (sessionCookie && isValidSessionCookie(sessionCookie)) {
112
- enhancedConfig.appwriteClient = getClientWithAuth(config.appwriteEndpoint, config.appwriteProject, config.appwriteKey, sessionCookie);
113
- }
114
- const result = await AdapterFactory.createFromConfig(enhancedConfig, forceRefresh);
115
- return {
116
- adapter: result.adapter,
117
- client: result.client,
118
- apiMode: result.apiMode
119
- };
120
- };
121
- /**
122
- * Create adapter from individual parameters with session authentication support
123
- */
124
- export const getAdapter = async (endpoint, project, key, apiMode = 'auto', sessionCookie) => {
125
- // Create config object with session support
126
- const config = {
127
- appwriteEndpoint: endpoint,
128
- appwriteProject: project,
129
- appwriteKey: key || "",
130
- apiMode
131
- };
132
- const authAttempts = [];
133
- // Use session auth if available, otherwise fall back to API key
134
- if (sessionCookie) {
135
- if (isValidSessionCookie(sessionCookie)) {
136
- config.appwriteClient = getClientWithAuth(endpoint, project, key, sessionCookie);
137
- }
138
- else {
139
- authAttempts.push("explicit session cookie (invalid format)");
140
- }
141
- }
142
- else if (!key) {
143
- // Try to find session auth if no API key provided
144
- const sessionAuth = findSessionByEndpointAndProject(endpoint, project);
145
- if (sessionAuth) {
146
- if (isValidSessionCookie(sessionAuth.sessionCookie)) {
147
- config.appwriteClient = getClientWithAuth(endpoint, project, key, sessionAuth.sessionCookie);
148
- }
149
- else {
150
- authAttempts.push("session from CLI prefs (invalid/expired)");
151
- }
152
- }
153
- else {
154
- authAttempts.push("session from CLI prefs (not found)");
155
- }
156
- // If no valid authentication found, build detailed error
157
- if (!config.appwriteClient) {
158
- const buildDetailedAuthError = () => {
159
- let errorMessage = `No valid authentication method available for project '${project}'.\n\n`;
160
- if (authAttempts.length > 0) {
161
- errorMessage += `Authentication methods attempted:\n`;
162
- authAttempts.forEach(attempt => {
163
- errorMessage += ` ✗ ${attempt}\n`;
164
- });
165
- errorMessage += `\n`;
166
- }
167
- errorMessage += `Available authentication options:\n`;
168
- errorMessage += ` 1. Session Authentication (Recommended):\n`;
169
- errorMessage += ` Run: appwrite login\n`;
170
- errorMessage += ` Then select your project and login with your account\n`;
171
- errorMessage += ` This will save session credentials to ~/.appwrite/prefs.json\n\n`;
172
- errorMessage += ` 2. API Key Authentication:\n`;
173
- errorMessage += ` - Provide API key via --key command line option\n`;
174
- errorMessage += ` - Or set appwriteKey in your configuration file\n`;
175
- errorMessage += ` - Get your API key from: ${endpoint}/console/project-${project}/settings/keys\n\n`;
176
- errorMessage += ` 3. Environment Variables:\n`;
177
- errorMessage += ` Set APPWRITE_API_KEY environment variable\n\n`;
178
- // Check if CLI is installed
179
- errorMessage += `Note: Ensure Appwrite CLI is installed:\n`;
180
- errorMessage += ` npm install -g appwrite-cli\n\n`;
181
- errorMessage += `For more help, visit: https://appwrite.io/docs/tooling/command-line/installation`;
182
- return new Error(errorMessage);
183
- };
184
- throw buildDetailedAuthError();
185
- }
186
- }
187
- const result = await AdapterFactory.create(config);
188
- return {
189
- adapter: result.adapter,
190
- client: result.client,
191
- apiMode: result.apiMode
192
- };
193
- };
194
- /**
195
- * Check if session authentication is available for a project
196
- */
197
- export const checkSessionAuth = (endpoint, project) => {
198
- return hasSessionAuth(endpoint, project);
199
- };
@@ -1,63 +0,0 @@
1
- import { type Models } from "node-appwrite";
2
- import type { CollectionImportData } from "../migrations/dataLoader.js";
3
- import type { ConfigCollection } from "@njdamstra/appwrite-utils";
4
- export declare const toPascalCase: (str: string) => string;
5
- export declare const toCamelCase: (str: string) => string;
6
- export declare const ensureDirectoryExistence: (filePath: string) => true | undefined;
7
- export declare const writeFileSync: (filePath: string, content: string, options: {
8
- flag: string;
9
- }) => void;
10
- export declare const readFileSync: (filePath: string) => string;
11
- export declare const existsSync: (filePath: string) => boolean;
12
- export declare const mkdirSync: (filePath: string) => void;
13
- export declare const readdirSync: (filePath: string) => string[];
14
- export declare const areCollectionNamesSame: (a: string, b: string) => boolean;
15
- /**
16
- * Generates the view URL for a specific file based on the provided endpoint, project ID, bucket ID, file ID, and optional JWT token.
17
- *
18
- * @param {string} endpoint - the base URL endpoint
19
- * @param {string} projectId - the ID of the project
20
- * @param {string} bucketId - the ID of the bucket
21
- * @param {string} fileId - the ID of the file
22
- * @param {Models.Jwt} [jwt] - optional JWT token generated via the Appwrite SDK
23
- * @return {string} the generated view URL for the file
24
- */
25
- export declare const getFileViewUrl: (endpoint: string, projectId: string, bucketId: string, fileId: string, jwt?: Models.Jwt) => string;
26
- /**
27
- * Generates a download URL for a file based on the provided endpoint, project ID, bucket ID, file ID, and optionally a JWT.
28
- *
29
- * @param {string} endpoint - The base URL endpoint.
30
- * @param {string} projectId - The ID of the project.
31
- * @param {string} bucketId - The ID of the bucket.
32
- * @param {string} fileId - The ID of the file.
33
- * @param {Models.Jwt} [jwt] - Optional JWT object for authentication with Appwrite.
34
- * @return {string} The complete download URL for the file.
35
- */
36
- export declare const getFileDownloadUrl: (endpoint: string, projectId: string, bucketId: string, fileId: string, jwt?: Models.Jwt) => string;
37
- export declare const finalizeByAttributeMap: (appwriteFolderPath: string, collection: ConfigCollection, item: CollectionImportData["data"][number]) => Promise<any>;
38
- export declare let numTimesFailedTotal: number;
39
- /**
40
- * Tries to execute the given createFunction and retries up to 5 times if it fails.
41
- * Only retries on transient errors (network failures, 5xx errors). Does NOT retry validation errors (4xx).
42
- *
43
- * @param {() => Promise<any>} createFunction - The function to be executed.
44
- * @param {number} [attemptNum=0] - The number of attempts made so far (default: 0).
45
- * @return {Promise<any>} - A promise that resolves to the result of the createFunction or rejects with an error if it fails after 5 attempts.
46
- */
47
- export declare const tryAwaitWithRetry: <T>(createFunction: () => Promise<T>, attemptNum?: number, throwError?: boolean) => Promise<T>;
48
- export declare const getAppwriteClient: (endpoint: string, projectId: string, apiKey: string) => import("node-appwrite").Client;
49
- export declare const delay: (ms: number) => Promise<unknown>;
50
- /**
51
- * Calculates exponential backoff delay with configurable base and maximum
52
- *
53
- * @param retryCount - Current retry attempt number (0-indexed)
54
- * @param baseDelay - Base delay in milliseconds (default: 2000)
55
- * @param maxDelay - Maximum delay cap in milliseconds (default: 30000)
56
- * @returns Calculated delay in milliseconds
57
- *
58
- * @example
59
- * calculateExponentialBackoff(0) // Returns 2000
60
- * calculateExponentialBackoff(1) // Returns 4000
61
- * calculateExponentialBackoff(5) // Returns 30000 (capped)
62
- */
63
- export declare const calculateExponentialBackoff: (retryCount: number, baseDelay?: number, maxDelay?: number) => number;
@@ -1,156 +0,0 @@
1
- import { AppwriteException, } from "node-appwrite";
2
- import fs from "node:fs";
3
- import path from "node:path";
4
- import { getClientWithAuth } from "./getClientFromConfig.js";
5
- export const toPascalCase = (str) => {
6
- return (str
7
- // Split the string into words on spaces or camelCase transitions
8
- .split(/(?:\s+)|(?:([A-Z][a-z]+))/g)
9
- // Filter out empty strings that can appear due to the split regex
10
- .filter(Boolean)
11
- // Capitalize the first letter of each word and join them together
12
- .map((word) => word.charAt(0).toUpperCase() + word.slice(1))
13
- .join(""));
14
- };
15
- export const toCamelCase = (str) => {
16
- return str
17
- .replace(/(?:^\w|[A-Z]|\b\w)/g, (word, index) => index === 0 ? word.toLowerCase() : word.toUpperCase())
18
- .replace(/\s+/g, "");
19
- };
20
- export const ensureDirectoryExistence = (filePath) => {
21
- const dirname = path.dirname(filePath);
22
- if (fs.existsSync(dirname)) {
23
- return true;
24
- }
25
- ensureDirectoryExistence(dirname);
26
- fs.mkdirSync(dirname);
27
- };
28
- export const writeFileSync = (filePath, content, options) => {
29
- ensureDirectoryExistence(filePath);
30
- fs.writeFileSync(filePath, content, options);
31
- };
32
- export const readFileSync = (filePath) => {
33
- return fs.readFileSync(filePath, "utf8");
34
- };
35
- export const existsSync = (filePath) => {
36
- return fs.existsSync(filePath);
37
- };
38
- export const mkdirSync = (filePath) => {
39
- ensureDirectoryExistence(filePath);
40
- fs.mkdirSync(filePath);
41
- };
42
- export const readdirSync = (filePath) => {
43
- return fs.readdirSync(filePath);
44
- };
45
- export const areCollectionNamesSame = (a, b) => {
46
- return (a.toLowerCase().trim().replace(" ", "") ===
47
- b.toLowerCase().trim().replace(" ", ""));
48
- };
49
- /**
50
- * Generates the view URL for a specific file based on the provided endpoint, project ID, bucket ID, file ID, and optional JWT token.
51
- *
52
- * @param {string} endpoint - the base URL endpoint
53
- * @param {string} projectId - the ID of the project
54
- * @param {string} bucketId - the ID of the bucket
55
- * @param {string} fileId - the ID of the file
56
- * @param {Models.Jwt} [jwt] - optional JWT token generated via the Appwrite SDK
57
- * @return {string} the generated view URL for the file
58
- */
59
- export const getFileViewUrl = (endpoint, projectId, bucketId, fileId, jwt) => {
60
- return `${endpoint}/storage/buckets/${bucketId}/files/${fileId}/view?project=${projectId}${jwt ? `&jwt=${jwt.jwt}` : ""}`;
61
- };
62
- /**
63
- * Generates a download URL for a file based on the provided endpoint, project ID, bucket ID, file ID, and optionally a JWT.
64
- *
65
- * @param {string} endpoint - The base URL endpoint.
66
- * @param {string} projectId - The ID of the project.
67
- * @param {string} bucketId - The ID of the bucket.
68
- * @param {string} fileId - The ID of the file.
69
- * @param {Models.Jwt} [jwt] - Optional JWT object for authentication with Appwrite.
70
- * @return {string} The complete download URL for the file.
71
- */
72
- export const getFileDownloadUrl = (endpoint, projectId, bucketId, fileId, jwt) => {
73
- return `${endpoint}/storage/buckets/${bucketId}/files/${fileId}/download?project=${projectId}${jwt ? `&jwt=${jwt.jwt}` : ""}`;
74
- };
75
- export const finalizeByAttributeMap = async (appwriteFolderPath, collection, item) => {
76
- const schemaFolderPath = path.join(appwriteFolderPath, "schemas");
77
- const zodSchema = await import(`${schemaFolderPath}/${toCamelCase(collection.name)}.ts`);
78
- return zodSchema.parse({
79
- ...item.context,
80
- ...item.finalData,
81
- });
82
- };
83
- export let numTimesFailedTotal = 0;
84
- /**
85
- * Tries to execute the given createFunction and retries up to 5 times if it fails.
86
- * Only retries on transient errors (network failures, 5xx errors). Does NOT retry validation errors (4xx).
87
- *
88
- * @param {() => Promise<any>} createFunction - The function to be executed.
89
- * @param {number} [attemptNum=0] - The number of attempts made so far (default: 0).
90
- * @return {Promise<any>} - A promise that resolves to the result of the createFunction or rejects with an error if it fails after 5 attempts.
91
- */
92
- export const tryAwaitWithRetry = async (createFunction, attemptNum = 0, throwError = false) => {
93
- try {
94
- return await createFunction();
95
- }
96
- catch (error) {
97
- const errorMessage = error instanceof Error ? error.message.toLowerCase() : String(error).toLowerCase();
98
- const errorCode = error.code;
99
- // Check if this is a validation error that should NOT be retried
100
- const isValidationError = errorCode === 400 || errorCode === 409 || errorCode === 422 ||
101
- errorMessage.includes("already exists") ||
102
- errorMessage.includes("attribute with the same key") ||
103
- errorMessage.includes("invalid") && !errorMessage.includes("fetch failed") ||
104
- errorMessage.includes("conflict") ||
105
- errorMessage.includes("bad request");
106
- // Check if this is a transient error that SHOULD be retried
107
- const isTransientError = errorCode === 522 || errorCode === "522" || // Cloudflare error
108
- errorCode >= 500 && errorCode < 600 || // 5xx server errors
109
- errorMessage.includes("fetch failed") || // Network failures
110
- errorMessage.includes("timeout") ||
111
- errorMessage.includes("econnrefused") ||
112
- errorMessage.includes("network error");
113
- // Only retry if it's a transient error AND not a validation error
114
- if (isTransientError && !isValidationError) {
115
- if (errorCode === 522 || errorCode === "522") {
116
- console.log("Cloudflare error. Retrying...");
117
- }
118
- else {
119
- console.log(`Fetch failed on attempt ${attemptNum}. Retrying...`);
120
- }
121
- numTimesFailedTotal++;
122
- if (attemptNum > 5) {
123
- throw error;
124
- }
125
- await delay(2500);
126
- return tryAwaitWithRetry(createFunction, attemptNum + 1);
127
- }
128
- // For validation errors or non-transient errors, throw immediately
129
- if (throwError) {
130
- throw error;
131
- }
132
- console.error("Error during retryAwait function: ", error);
133
- // @ts-ignore
134
- return Promise.resolve();
135
- }
136
- };
137
- export const getAppwriteClient = (endpoint, projectId, apiKey) => {
138
- return getClientWithAuth(endpoint, projectId, apiKey);
139
- };
140
- export const delay = (ms) => new Promise((resolve) => setTimeout(resolve, ms));
141
- /**
142
- * Calculates exponential backoff delay with configurable base and maximum
143
- *
144
- * @param retryCount - Current retry attempt number (0-indexed)
145
- * @param baseDelay - Base delay in milliseconds (default: 2000)
146
- * @param maxDelay - Maximum delay cap in milliseconds (default: 30000)
147
- * @returns Calculated delay in milliseconds
148
- *
149
- * @example
150
- * calculateExponentialBackoff(0) // Returns 2000
151
- * calculateExponentialBackoff(1) // Returns 4000
152
- * calculateExponentialBackoff(5) // Returns 30000 (capped)
153
- */
154
- export const calculateExponentialBackoff = (retryCount, baseDelay = 2000, maxDelay = 30000) => {
155
- return Math.min(baseDelay * Math.pow(2, retryCount), maxDelay);
156
- };
@@ -1,53 +0,0 @@
1
- /**
2
- * Path resolution utilities for Appwrite configuration and schema directories
3
- */
4
- /**
5
- * Resolves the schema output directory path
6
- * @param configPath - Base configuration directory path
7
- * @returns Full path to schemas directory
8
- */
9
- export declare function resolveSchemaDir(configPath: string): string;
10
- /**
11
- * Resolves the collections directory path
12
- * @param configPath - Base configuration directory path
13
- * @returns Full path to collections directory
14
- */
15
- export declare function resolveCollectionsDir(configPath: string): string;
16
- /**
17
- * Resolves the tables directory path
18
- * @param configPath - Base configuration directory path
19
- * @returns Full path to tables directory
20
- */
21
- export declare function resolveTablesDir(configPath: string): string;
22
- /**
23
- * Resolves the YAML schema directory path
24
- * @param configPath - Base configuration directory path
25
- * @returns Full path to .yaml_schemas directory
26
- */
27
- export declare function resolveYamlSchemaDir(configPath: string): string;
28
- /**
29
- * Resolves the import data directory path
30
- * @param configPath - Base configuration directory path
31
- * @returns Full path to importData directory
32
- */
33
- export declare function resolveImportDataDir(configPath: string): string;
34
- /**
35
- * Resolves the .appwrite configuration directory
36
- * @param startDir - Directory to start searching from
37
- * @returns Path to .appwrite directory or null if not found
38
- */
39
- export declare function resolveAppwriteDir(startDir: string): string | null;
40
- /**
41
- * Resolves a collection file path within the collections directory
42
- * @param configPath - Base configuration directory path
43
- * @param fileName - Name of the collection file (e.g., "User.ts" or "User.yaml")
44
- * @returns Full path to the collection file
45
- */
46
- export declare function resolveCollectionFile(configPath: string, fileName: string): string;
47
- /**
48
- * Resolves a table file path within the tables directory
49
- * @param configPath - Base configuration directory path
50
- * @param fileName - Name of the table file (e.g., "User.ts" or "User.yaml")
51
- * @returns Full path to the table file
52
- */
53
- export declare function resolveTableFile(configPath: string, fileName: string): string;
@@ -1,72 +0,0 @@
1
- import path from "path";
2
- /**
3
- * Path resolution utilities for Appwrite configuration and schema directories
4
- */
5
- /**
6
- * Resolves the schema output directory path
7
- * @param configPath - Base configuration directory path
8
- * @returns Full path to schemas directory
9
- */
10
- export function resolveSchemaDir(configPath) {
11
- return path.join(configPath, "schemas");
12
- }
13
- /**
14
- * Resolves the collections directory path
15
- * @param configPath - Base configuration directory path
16
- * @returns Full path to collections directory
17
- */
18
- export function resolveCollectionsDir(configPath) {
19
- return path.join(configPath, "collections");
20
- }
21
- /**
22
- * Resolves the tables directory path
23
- * @param configPath - Base configuration directory path
24
- * @returns Full path to tables directory
25
- */
26
- export function resolveTablesDir(configPath) {
27
- return path.join(configPath, "tables");
28
- }
29
- /**
30
- * Resolves the YAML schema directory path
31
- * @param configPath - Base configuration directory path
32
- * @returns Full path to .yaml_schemas directory
33
- */
34
- export function resolveYamlSchemaDir(configPath) {
35
- return path.join(configPath, ".yaml_schemas");
36
- }
37
- /**
38
- * Resolves the import data directory path
39
- * @param configPath - Base configuration directory path
40
- * @returns Full path to importData directory
41
- */
42
- export function resolveImportDataDir(configPath) {
43
- return path.join(configPath, "importData");
44
- }
45
- /**
46
- * Resolves the .appwrite configuration directory
47
- * @param startDir - Directory to start searching from
48
- * @returns Path to .appwrite directory or null if not found
49
- */
50
- export function resolveAppwriteDir(startDir) {
51
- const appwriteDir = path.join(startDir, ".appwrite");
52
- // Note: Actual existence check should be done by caller
53
- return appwriteDir;
54
- }
55
- /**
56
- * Resolves a collection file path within the collections directory
57
- * @param configPath - Base configuration directory path
58
- * @param fileName - Name of the collection file (e.g., "User.ts" or "User.yaml")
59
- * @returns Full path to the collection file
60
- */
61
- export function resolveCollectionFile(configPath, fileName) {
62
- return path.join(resolveCollectionsDir(configPath), fileName);
63
- }
64
- /**
65
- * Resolves a table file path within the tables directory
66
- * @param configPath - Base configuration directory path
67
- * @param fileName - Name of the table file (e.g., "User.ts" or "User.yaml")
68
- * @returns Full path to the table file
69
- */
70
- export function resolveTableFile(configPath, fileName) {
71
- return path.join(resolveTablesDir(configPath), fileName);
72
- }
@@ -1,119 +0,0 @@
1
- import type { AppwriteConfig } from "@njdamstra/appwrite-utils";
2
- export interface AppwriteProjectConfig {
3
- projectId: string;
4
- endpoint?: string;
5
- projectName?: string;
6
- settings?: {
7
- services?: Record<string, boolean>;
8
- auth?: {
9
- methods?: Record<string, boolean>;
10
- security?: Record<string, any>;
11
- };
12
- };
13
- functions?: Array<{
14
- $id: string;
15
- name: string;
16
- runtime: string;
17
- entrypoint?: string;
18
- path?: string;
19
- commands?: string;
20
- events?: string[];
21
- }>;
22
- databases?: Array<{
23
- $id: string;
24
- name: string;
25
- enabled?: boolean;
26
- }>;
27
- collections?: Array<{
28
- $id: string;
29
- $permissions?: string[];
30
- databaseId: string;
31
- name: string;
32
- enabled?: boolean;
33
- documentSecurity?: boolean;
34
- attributes: Array<{
35
- key: string;
36
- type: string;
37
- required?: boolean;
38
- array?: boolean;
39
- size?: number;
40
- default?: any;
41
- encrypt?: boolean;
42
- [key: string]: any;
43
- }>;
44
- indexes?: Array<{
45
- key: string;
46
- type: string;
47
- attributes: string[];
48
- orders?: string[];
49
- }>;
50
- }>;
51
- tablesDB?: Array<{
52
- $id: string;
53
- name: string;
54
- enabled?: boolean;
55
- }>;
56
- tables?: Array<{
57
- $id: string;
58
- $permissions?: string[];
59
- databaseId: string;
60
- name: string;
61
- enabled?: boolean;
62
- rowSecurity?: boolean;
63
- columns: Array<{
64
- key: string;
65
- type: string;
66
- required?: boolean;
67
- array?: boolean;
68
- size?: number;
69
- default?: any;
70
- encrypt?: boolean;
71
- unique?: boolean;
72
- [key: string]: any;
73
- }>;
74
- indexes?: Array<{
75
- key: string;
76
- type: string;
77
- attributes: string[];
78
- orders?: string[];
79
- }>;
80
- }>;
81
- buckets?: Array<{
82
- bucketId?: string;
83
- $id?: string;
84
- name: string;
85
- maximumFileSize?: number;
86
- allowedFileExtensions?: string[];
87
- encryption?: boolean;
88
- antiVirus?: boolean;
89
- [key: string]: any;
90
- }>;
91
- }
92
- /**
93
- * Find appwrite.json or appwrite.config.json in current directory or parents
94
- */
95
- export declare function findAppwriteProjectConfig(startDir?: string): string | null;
96
- /**
97
- * Load and parse appwrite project configuration
98
- */
99
- export declare function loadAppwriteProjectConfig(configPath?: string): AppwriteProjectConfig | null;
100
- /**
101
- * Detect API mode from project configuration
102
- */
103
- export declare function detectApiModeFromProject(projectConfig: AppwriteProjectConfig): "legacy" | "tablesdb" | "auto";
104
- /**
105
- * Convert project config to AppwriteConfig format
106
- */
107
- export declare function projectConfigToAppwriteConfig(projectConfig: AppwriteProjectConfig, existingConfig?: Partial<AppwriteConfig>): Partial<AppwriteConfig>;
108
- /**
109
- * Get collection/table definitions from project config
110
- */
111
- export declare function getCollectionsFromProject(projectConfig: AppwriteProjectConfig): any[];
112
- /**
113
- * Check if project config indicates TablesDB usage
114
- */
115
- export declare function isTablesDBProject(projectConfig: AppwriteProjectConfig): boolean;
116
- /**
117
- * Get the appropriate directory name based on project config
118
- */
119
- export declare function getProjectDirectoryName(projectConfig: AppwriteProjectConfig): "tables" | "collections";