@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,556 +0,0 @@
1
- import { toCamelCase, toPascalCase } from "../utils/index.js";
2
- import { getVersionAwareDirectory, resolveDirectoryForApiMode, getDualDirectoryPaths } from "@njdamstra/appwrite-utils";
3
- import { z } from "zod";
4
- import fs from "fs";
5
- import path from "path";
6
- import { dump } from "js-yaml";
7
- import { getDatabaseFromConfig } from "../migrations/afterImportActions.js";
8
- import { ulid } from "ulidx";
9
- import { JsonSchemaGenerator } from "./jsonSchemaGenerator.js";
10
- import { collectionToYaml, getCollectionYamlFilename } from "../utils/yamlConverter.js";
11
- import { extractTwoWayRelationships, resolveCollectionName } from "./relationshipExtractor.js";
12
- import { resolveSchemaDir } from "../utils/pathResolvers.js";
13
- import { MessageFormatter } from "./messageFormatter.js";
14
- export class SchemaGenerator {
15
- relationshipMap = new Map();
16
- config;
17
- appwriteFolderPath;
18
- constructor(config, appwriteFolderPath) {
19
- this.config = config;
20
- this.appwriteFolderPath = appwriteFolderPath;
21
- this.extractRelationships();
22
- }
23
- resolveCollectionName = (idOrName) => {
24
- return resolveCollectionName(this.config, idOrName);
25
- };
26
- updateYamlCollections() {
27
- const collections = this.config.collections;
28
- delete this.config.collections;
29
- // Determine output directory based on API mode/version detection
30
- const outputDir = this.getVersionAwareCollectionsDirectory();
31
- const collectionsDir = path.join(this.appwriteFolderPath, outputDir);
32
- if (!fs.existsSync(collectionsDir)) {
33
- fs.mkdirSync(collectionsDir, { recursive: true });
34
- }
35
- collections?.forEach((collection) => {
36
- // Determine schema path based on config and output directory
37
- const schemaDir = this.config.schemaConfig?.yamlSchemaDirectory || ".yaml_schemas";
38
- const isTablesMode = outputDir === "tables";
39
- const schemaPath = isTablesMode
40
- ? `../${schemaDir}/table.schema.json`
41
- : `../${schemaDir}/collection.schema.json`;
42
- const yamlConfig = {
43
- useTableTerminology: isTablesMode,
44
- entityType: isTablesMode ? 'table' : 'collection',
45
- schemaPath
46
- };
47
- const yamlContent = collectionToYaml(collection, yamlConfig);
48
- const filename = getCollectionYamlFilename(collection);
49
- const filePath = path.join(collectionsDir, filename);
50
- fs.writeFileSync(filePath, yamlContent, { encoding: "utf-8" });
51
- MessageFormatter.success(`${outputDir === "tables" ? "Table" : "Collection"} YAML written to ${filePath}`, { prefix: "Schema" });
52
- });
53
- }
54
- updateTsSchemas() {
55
- const collections = this.config.collections;
56
- const functions = this.config.functions || [];
57
- delete this.config.collections;
58
- delete this.config.functions;
59
- const configPath = path.join(this.appwriteFolderPath, "appwriteConfig.ts");
60
- const configContent = `import { type AppwriteConfig } from "@njdamstra/appwrite-utils";
61
-
62
- const appwriteConfig: AppwriteConfig = {
63
- appwriteEndpoint: "${this.config.appwriteEndpoint}",
64
- appwriteProject: "${this.config.appwriteProject}",
65
- appwriteKey: "${this.config.appwriteKey}",
66
- enableBackups: ${this.config.enableBackups},
67
- backupInterval: ${this.config.backupInterval},
68
- backupRetention: ${this.config.backupRetention},
69
- enableBackupCleanup: ${this.config.enableBackupCleanup},
70
- enableMockData: ${this.config.enableMockData},
71
- documentBucketId: "${this.config.documentBucketId}",
72
- usersCollectionName: "${this.config.usersCollectionName}",
73
- databases: ${JSON.stringify(this.config.databases, null, 4)},
74
- buckets: ${JSON.stringify(this.config.buckets, null, 4)},
75
- functions: ${JSON.stringify(functions.map((func) => ({
76
- functionId: func.$id || ulid(),
77
- name: func.name,
78
- runtime: func.runtime,
79
- path: func.dirPath || `functions/${func.name}`,
80
- entrypoint: func.entrypoint || "src/index.ts",
81
- execute: func.execute,
82
- events: func.events || [],
83
- schedule: func.schedule || "",
84
- timeout: func.timeout || 15,
85
- enabled: func.enabled !== false,
86
- logging: func.logging !== false,
87
- commands: func.commands || "npm install",
88
- scopes: func.scopes || [],
89
- installationId: func.installationId,
90
- providerRepositoryId: func.providerRepositoryId,
91
- providerBranch: func.providerBranch,
92
- providerSilentMode: func.providerSilentMode,
93
- providerRootDirectory: func.providerRootDirectory,
94
- specification: func.specification,
95
- ...(func.predeployCommands
96
- ? { predeployCommands: func.predeployCommands }
97
- : {}),
98
- ...(func.deployDir ? { deployDir: func.deployDir } : {}),
99
- })), null, 4)}
100
- };
101
-
102
- export default appwriteConfig;
103
- `;
104
- fs.writeFileSync(configPath, configContent, { encoding: "utf-8" });
105
- // Determine output directory based on API mode/version detection
106
- const outputDir = this.getVersionAwareCollectionsDirectory();
107
- const collectionsFolderPath = path.join(this.appwriteFolderPath, outputDir);
108
- if (!fs.existsSync(collectionsFolderPath)) {
109
- fs.mkdirSync(collectionsFolderPath, { recursive: true });
110
- }
111
- collections?.forEach((collection) => {
112
- const { databaseId, ...collectionWithoutDbId } = collection; // Destructure to exclude databaseId
113
- const collectionFilePath = path.join(collectionsFolderPath, `${collection.name}.ts`);
114
- // Determine if we're in tables mode for terminology
115
- const isTablesMode = outputDir === "tables";
116
- const securityField = isTablesMode ? "rowSecurity" : "documentSecurity";
117
- const collectionContent = `import { type CollectionCreate } from "@njdamstra/appwrite-utils";
118
-
119
- const ${collection.name}Config: Partial<CollectionCreate> = {
120
- name: "${collection.name}",
121
- $id: "${collection.$id}",
122
- enabled: ${collection.enabled},
123
- ${securityField}: ${collection.documentSecurity},
124
- $permissions: [
125
- ${collection.$permissions
126
- .map((permission) => `{ permission: "${permission.permission}", target: "${permission.target}" }`)
127
- .join(",\n ")}
128
- ],
129
- attributes: [
130
- ${collection.attributes
131
- .map((attr) => {
132
- return `{ ${Object.entries(attr)
133
- .map(([key, value]) => {
134
- // Handle table vs collection terminology for related fields
135
- let outputKey = key;
136
- let outputValue = value;
137
- if (isTablesMode) {
138
- // Convert collection terminology to table terminology
139
- if (key === "relatedCollection") {
140
- outputKey = "relatedTable";
141
- }
142
- }
143
- // Check the type of the value and format it accordingly
144
- if (typeof outputValue === "string") {
145
- // If the value is a string, wrap it in quotes
146
- return `${outputKey}: "${outputValue.replace(/"/g, '\\"')}"`; // Escape existing quotes in the string
147
- }
148
- else if (Array.isArray(outputValue)) {
149
- // If the value is an array, join it with commas
150
- if (outputValue.length > 0) {
151
- return `${outputKey}: [${outputValue
152
- .map((item) => `"${item}"`)
153
- .join(", ")}]`;
154
- }
155
- else {
156
- return `${outputKey}: []`;
157
- }
158
- }
159
- else {
160
- // If the value is not a string (e.g., boolean or number), output it directly
161
- return `${outputKey}: ${outputValue}`;
162
- }
163
- })
164
- .join(", ")} }`;
165
- })
166
- .join(",\n ")}
167
- ],
168
- indexes: [
169
- ${(collection.indexes?.map((index) => {
170
- // Use appropriate terminology for index attributes/columns
171
- const indexField = isTablesMode ? "columns" : "attributes";
172
- const formattedAttributes = index.attributes.map((attr) => `"${attr}"`).join(", ") ?? "";
173
- return `{ key: "${index.key}", type: "${index.type}", ${indexField}: [${formattedAttributes}], orders: [${index.orders
174
- ?.filter((order) => order !== null)
175
- .map((order) => `"${order}"`)
176
- .join(", ") ?? ""}] }`;
177
- }) ?? []).join(",\n ")}
178
- ]
179
- };
180
-
181
- export default ${collection.name}Config;
182
- `;
183
- fs.writeFileSync(collectionFilePath, collectionContent, {
184
- encoding: "utf-8",
185
- });
186
- MessageFormatter.success(`${outputDir === "tables" ? "Table" : "Collection"} schema written to ${collectionFilePath}`, { prefix: "Schema" });
187
- });
188
- }
189
- /**
190
- * Determines the appropriate directory for collections/tables based on API mode
191
- * Uses version detection or config hints to choose between 'collections' and 'tables'
192
- */
193
- getVersionAwareCollectionsDirectory() {
194
- return getVersionAwareDirectory(this.config, this.appwriteFolderPath);
195
- }
196
- /**
197
- * Get directory for a specific API mode (legacy or tablesdb)
198
- * @param apiMode - The API mode to get directory for
199
- * @returns The directory name for the specified API mode
200
- */
201
- getDirectoryForApiMode(apiMode) {
202
- return resolveDirectoryForApiMode(this.config, apiMode, this.appwriteFolderPath);
203
- }
204
- /**
205
- * Get both directory paths for dual API support
206
- * @returns Object with both collectionsDirectory and tablesDirectory paths
207
- */
208
- getDualDirectoryConfiguration() {
209
- return getDualDirectoryPaths(this.config);
210
- }
211
- async updateConfig(config, isYamlConfig = false) {
212
- if (isYamlConfig) {
213
- // User has YAML config - find the config file and update it + generate individual collection files
214
- const { findYamlConfig } = await import("../config/yamlConfig.js");
215
- const yamlConfigPath = findYamlConfig(this.appwriteFolderPath);
216
- if (yamlConfigPath) {
217
- await this.updateYamlConfig(config, yamlConfigPath);
218
- }
219
- else {
220
- MessageFormatter.warning("YAML config expected but not found, falling back to TypeScript", { prefix: "Schema" });
221
- this.updateTypeScriptConfig(config);
222
- }
223
- }
224
- else {
225
- // User has TypeScript config - update the TS file
226
- this.updateTypeScriptConfig(config);
227
- }
228
- }
229
- async updateYamlConfig(config, yamlConfigPath) {
230
- try {
231
- const { writeYamlConfig } = await import("../config/yamlConfig.js");
232
- // Write the main YAML config (without collections)
233
- await writeYamlConfig(yamlConfigPath, config);
234
- // Generate individual collection YAML files
235
- this.updateYamlCollections();
236
- MessageFormatter.success("Updated YAML configuration and collection files", { prefix: "Schema" });
237
- }
238
- catch (error) {
239
- MessageFormatter.error("Error updating YAML config", error, { prefix: "Schema" });
240
- throw error;
241
- }
242
- }
243
- updateTypeScriptConfig(config) {
244
- const configPath = path.join(this.appwriteFolderPath, "appwriteConfig.ts");
245
- const configContent = `import { type AppwriteConfig } from "@njdamstra/appwrite-utils";
246
-
247
- const appwriteConfig: AppwriteConfig = {
248
- appwriteEndpoint: "${config.appwriteEndpoint}",
249
- appwriteProject: "${config.appwriteProject}",
250
- appwriteKey: "${config.appwriteKey}",
251
- enableBackups: ${config.enableBackups},
252
- backupInterval: ${config.backupInterval},
253
- backupRetention: ${config.backupRetention},
254
- enableBackupCleanup: ${config.enableBackupCleanup},
255
- enableMockData: ${config.enableMockData},
256
- documentBucketId: "${config.documentBucketId}",
257
- usersCollectionName: "${config.usersCollectionName}",
258
- databases: ${JSON.stringify(config.databases, null, 4)},
259
- buckets: ${JSON.stringify(config.buckets, null, 4)},
260
- functions: ${JSON.stringify(config.functions?.map((func) => ({
261
- $id: func.$id || ulid(),
262
- name: func.name,
263
- runtime: func.runtime,
264
- dirPath: func.dirPath || "functions/" + func.name,
265
- entrypoint: func.entrypoint || "src/index.ts",
266
- execute: func.execute || [],
267
- events: func.events || [],
268
- schedule: func.schedule || "",
269
- timeout: func.timeout || 15,
270
- enabled: func.enabled !== false,
271
- logging: func.logging !== false,
272
- commands: func.commands || "npm install",
273
- scopes: func.scopes || [],
274
- installationId: func.installationId,
275
- providerRepositoryId: func.providerRepositoryId,
276
- providerBranch: func.providerBranch,
277
- providerSilentMode: func.providerSilentMode,
278
- providerRootDirectory: func.providerRootDirectory,
279
- specification: func.specification,
280
- })), null, 4)},
281
- collections: ${JSON.stringify(config.collections, null, 4)}
282
- };
283
-
284
- export default appwriteConfig;
285
- `;
286
- fs.writeFileSync(configPath, configContent, { encoding: "utf-8" });
287
- MessageFormatter.success("Updated TypeScript configuration file", { prefix: "Schema" });
288
- }
289
- extractRelationships() {
290
- this.relationshipMap = extractTwoWayRelationships(this.config);
291
- }
292
- async generateSchemas(options = {}) {
293
- const { format = "both", verbose = false, outputDir } = options;
294
- if (!this.config.collections) {
295
- return;
296
- }
297
- // Create schemas directory using config setting
298
- const configuredDir = outputDir || this.config.schemaConfig?.outputDirectory || "schemas";
299
- let schemasPath;
300
- if (path.isAbsolute(configuredDir)) {
301
- schemasPath = configuredDir;
302
- }
303
- else if (configuredDir === "schemas") {
304
- schemasPath = resolveSchemaDir(this.appwriteFolderPath);
305
- }
306
- else {
307
- schemasPath = path.join(this.appwriteFolderPath, configuredDir);
308
- }
309
- if (!fs.existsSync(schemasPath)) {
310
- fs.mkdirSync(schemasPath, { recursive: true });
311
- }
312
- // Generate Zod schemas (TypeScript)
313
- if (format === "zod" || format === "both" || format === "all") {
314
- this.config.collections.forEach((collection) => {
315
- const schemaString = this.createSchemaStringV4(collection.name, collection.attributes || []);
316
- const camelCaseName = toCamelCase(collection.name);
317
- const schemaPath = path.join(schemasPath, `${camelCaseName}.ts`);
318
- fs.writeFileSync(schemaPath, schemaString, { encoding: "utf-8" });
319
- if (verbose) {
320
- MessageFormatter.success(`Zod schema written to ${schemaPath}`, { prefix: "Schema" });
321
- }
322
- });
323
- }
324
- // Generate JSON schemas (all at once)
325
- if (format === "json" || format === "both" || format === "all") {
326
- const jsonSchemaGenerator = new JsonSchemaGenerator(this.config, this.appwriteFolderPath);
327
- jsonSchemaGenerator.generateJsonSchemas({
328
- outputFormat: format === "json" ? "json" : "both",
329
- outputDirectory: configuredDir,
330
- verbose: verbose
331
- });
332
- }
333
- // Generate Python Pydantic models
334
- if (format === "pydantic" || format === "all") {
335
- const mod = await import("./pydanticModelGenerator.js");
336
- const pgen = new mod.PydanticModelGenerator(this.config, this.appwriteFolderPath);
337
- pgen.generatePydanticModels({ baseOutputDirectory: schemasPath, verbose });
338
- }
339
- if (verbose) {
340
- MessageFormatter.success(`Schema generation completed (format: ${format})`, { prefix: "Schema" });
341
- }
342
- }
343
- // Zod v4 recursive getter-based schemas
344
- createSchemaStringV4 = (name, attributes) => {
345
- const pascalName = toPascalCase(name);
346
- let imports = `import { z } from "zod";\n`;
347
- // Use the relationshipMap to find related collections
348
- const relationshipDetails = this.relationshipMap.get(name) || [];
349
- let relatedCollections = relationshipDetails
350
- .filter((detail, index, self) => {
351
- const uniqueKey = `${detail.parentCollection}-${detail.childCollection}-${detail.parentKey}-${detail.childKey}`;
352
- return (index ===
353
- self.findIndex((obj) => `${obj.parentCollection}-${obj.childCollection}-${obj.parentKey}-${obj.childKey}` ===
354
- uniqueKey));
355
- })
356
- .map((detail) => {
357
- const relatedCollectionName = detail.isChild
358
- ? detail.parentCollection
359
- : detail.childCollection;
360
- const key = detail.isChild ? detail.childKey : detail.parentKey;
361
- const isArray = detail.isArray ? "array" : "";
362
- return [relatedCollectionName, key, isArray];
363
- });
364
- // Include one-way relationship attributes directly (no twoWayKey)
365
- const oneWayRels = [];
366
- for (const attr of attributes) {
367
- if (attr.type === "relationship" && attr.relatedCollection) {
368
- const relatedName = this.resolveCollectionName(attr.relatedCollection);
369
- const isArray = attr.relationType === "oneToMany" || attr.relationType === "manyToMany"
370
- ? "array"
371
- : "";
372
- oneWayRels.push([relatedName, attr.key, isArray]);
373
- }
374
- }
375
- // Merge and dedupe (by relatedName+key)
376
- relatedCollections = [...relatedCollections, ...oneWayRels].filter((item, idx, self) => idx === self.findIndex((o) => `${o[0]}::${o[1]}` === `${item[0]}::${item[1]}`));
377
- const hasRelationships = relatedCollections.length > 0;
378
- // Build imports for related collections
379
- if (hasRelationships) {
380
- const importLines = relatedCollections.map((rel) => {
381
- const relatedPascalName = toPascalCase(rel[0]);
382
- const relatedCamelName = toCamelCase(rel[0]);
383
- return `import { ${relatedPascalName}Schema } from "./${relatedCamelName}";`;
384
- });
385
- const unique = Array.from(new Set(importLines));
386
- imports += unique.join("\n") + (unique.length ? "\n" : "");
387
- }
388
- let schemaString = `${imports}\n`;
389
- // Single object schema with recursive getters (Zod v4)
390
- schemaString += `export const ${pascalName}Schema = z.object({\n`;
391
- schemaString += ` $id: z.string(),\n`;
392
- schemaString += ` $createdAt: z.string(),\n`;
393
- schemaString += ` $updatedAt: z.string(),\n`;
394
- schemaString += ` $permissions: z.array(z.string()),\n`;
395
- for (const attribute of attributes) {
396
- if (attribute.type === "relationship")
397
- continue;
398
- schemaString += ` ${attribute.key}: ${this.typeToZod(attribute)},\n`;
399
- }
400
- // Add recursive getters for relationships (respect required flag)
401
- relatedCollections.forEach((rel) => {
402
- const relatedPascalName = toPascalCase(rel[0]);
403
- const isArray = rel[2] === "array";
404
- const key = String(rel[1]);
405
- const attrMeta = attributes.find(a => a.key === key && a.type === "relationship");
406
- const isRequired = !!attrMeta?.required;
407
- let getterBody = "";
408
- if (isArray) {
409
- getterBody = isRequired
410
- ? `${relatedPascalName}Schema.array()`
411
- : `${relatedPascalName}Schema.array().nullish()`;
412
- }
413
- else {
414
- getterBody = isRequired
415
- ? `${relatedPascalName}Schema`
416
- : `${relatedPascalName}Schema.nullish()`;
417
- }
418
- schemaString += ` get ${key}(){\n return ${getterBody}\n },\n`;
419
- });
420
- schemaString += `});\n\n`;
421
- schemaString += `export type ${pascalName} = z.infer<typeof ${pascalName}Schema>;\n\n`;
422
- return schemaString;
423
- };
424
- typeToZod = (attribute) => {
425
- let baseSchemaCode = "";
426
- const finalAttribute = (attribute.type === "string" &&
427
- attribute.format &&
428
- attribute.format === "enum" &&
429
- attribute.type === "string"
430
- ? { ...attribute, type: attribute.format }
431
- : attribute);
432
- switch (finalAttribute.type) {
433
- case "string":
434
- baseSchemaCode = "z.string()";
435
- if (finalAttribute.size) {
436
- baseSchemaCode += `.max(${finalAttribute.size}, "Maximum length of ${finalAttribute.size} characters exceeded")`;
437
- }
438
- if (finalAttribute.xdefault !== undefined) {
439
- baseSchemaCode += `.default("${finalAttribute.xdefault}")`;
440
- }
441
- if (!attribute.required && !attribute.array) {
442
- baseSchemaCode += ".nullish()";
443
- }
444
- break;
445
- case "integer":
446
- baseSchemaCode = "z.number().int()";
447
- if (finalAttribute.min !== undefined) {
448
- if (BigInt(finalAttribute.min) === BigInt(-9223372036854776000)) {
449
- finalAttribute.min = undefined;
450
- }
451
- else {
452
- baseSchemaCode += `.min(${finalAttribute.min}, "Minimum value of ${finalAttribute.min} not met")`;
453
- }
454
- }
455
- if (finalAttribute.max !== undefined) {
456
- if (BigInt(finalAttribute.max) === BigInt(9223372036854776000)) {
457
- finalAttribute.max = undefined;
458
- }
459
- else {
460
- baseSchemaCode += `.max(${finalAttribute.max}, "Maximum value of ${finalAttribute.max} exceeded")`;
461
- }
462
- }
463
- if (finalAttribute.xdefault !== undefined) {
464
- baseSchemaCode += `.default(${finalAttribute.xdefault})`;
465
- }
466
- if (!finalAttribute.required && !finalAttribute.array) {
467
- baseSchemaCode += ".nullish()";
468
- }
469
- break;
470
- case "double":
471
- case "float": // Backward compatibility
472
- baseSchemaCode = "z.number()";
473
- if (finalAttribute.min !== undefined) {
474
- baseSchemaCode += `.min(${finalAttribute.min}, "Minimum value of ${finalAttribute.min} not met")`;
475
- }
476
- if (finalAttribute.max !== undefined) {
477
- baseSchemaCode += `.max(${finalAttribute.max}, "Maximum value of ${finalAttribute.max} exceeded")`;
478
- }
479
- if (finalAttribute.xdefault !== undefined) {
480
- baseSchemaCode += `.default(${finalAttribute.xdefault})`;
481
- }
482
- if (!finalAttribute.required && !finalAttribute.array) {
483
- baseSchemaCode += ".nullish()";
484
- }
485
- break;
486
- case "boolean":
487
- baseSchemaCode = "z.boolean()";
488
- if (finalAttribute.xdefault !== undefined) {
489
- baseSchemaCode += `.default(${finalAttribute.xdefault})`;
490
- }
491
- if (!finalAttribute.required && !finalAttribute.array) {
492
- baseSchemaCode += ".nullish()";
493
- }
494
- break;
495
- case "datetime":
496
- baseSchemaCode = "z.date()";
497
- if (finalAttribute.xdefault !== undefined) {
498
- baseSchemaCode += `.default(new Date("${finalAttribute.xdefault}"))`;
499
- }
500
- if (!finalAttribute.required && !finalAttribute.array) {
501
- baseSchemaCode += ".nullish()";
502
- }
503
- break;
504
- case "email":
505
- baseSchemaCode = "z.string().email()";
506
- if (finalAttribute.xdefault !== undefined) {
507
- baseSchemaCode += `.default("${finalAttribute.xdefault}")`;
508
- }
509
- if (!finalAttribute.required && !finalAttribute.array) {
510
- baseSchemaCode += ".nullish()";
511
- }
512
- break;
513
- case "ip":
514
- baseSchemaCode = "z.string()"; // Add custom validation as needed
515
- if (finalAttribute.xdefault !== undefined) {
516
- baseSchemaCode += `.default("${finalAttribute.xdefault}")`;
517
- }
518
- if (!finalAttribute.required && !finalAttribute.array) {
519
- baseSchemaCode += ".nullish()";
520
- }
521
- break;
522
- case "url":
523
- baseSchemaCode = "z.string().url()";
524
- if (finalAttribute.xdefault !== undefined) {
525
- baseSchemaCode += `.default("${finalAttribute.xdefault}")`;
526
- }
527
- if (!finalAttribute.required && !finalAttribute.array) {
528
- baseSchemaCode += ".nullish()";
529
- }
530
- break;
531
- case "enum":
532
- baseSchemaCode = `z.enum([${finalAttribute.elements
533
- .map((element) => `"${element}"`)
534
- .join(", ")}])`;
535
- if (finalAttribute.xdefault !== undefined) {
536
- baseSchemaCode += `.default("${finalAttribute.xdefault}")`;
537
- }
538
- if (!attribute.required && !attribute.array) {
539
- baseSchemaCode += ".nullish()";
540
- }
541
- break;
542
- case "relationship":
543
- break;
544
- default:
545
- baseSchemaCode = "z.any()";
546
- }
547
- // Handle arrays
548
- if (attribute.array) {
549
- baseSchemaCode = `z.array(${baseSchemaCode})`;
550
- }
551
- if (attribute.array && !attribute.required) {
552
- baseSchemaCode += ".nullish()";
553
- }
554
- return baseSchemaCode;
555
- };
556
- }
@@ -1,87 +0,0 @@
1
- import { Client } from "node-appwrite";
2
- import type { AppwriteConfig } from "@njdamstra/appwrite-utils";
3
- import type { DatabaseAdapter } from "../adapters/DatabaseAdapter.js";
4
- /**
5
- * Factory for creating authenticated Appwrite clients and database adapters.
6
- *
7
- * This factory provides a clean separation of concerns by taking pre-configured
8
- * AppwriteConfig objects (with authentication already resolved by ConfigManager)
9
- * and creating the necessary client and adapter instances.
10
- *
11
- * Key features:
12
- * - Takes pre-authenticated config from ConfigManager
13
- * - Creates client with appropriate authentication method
14
- * - Creates adapter with automatic version detection
15
- * - Leverages AdapterFactory's internal caching for performance
16
- *
17
- * @example
18
- * ```typescript
19
- * const configManager = ConfigManager.getInstance();
20
- * const config = await configManager.loadConfig();
21
- *
22
- * // Config already has session or API key resolved
23
- * const { client, adapter } = await ClientFactory.createFromConfig(config);
24
- * ```
25
- */
26
- export declare class ClientFactory {
27
- /**
28
- * Create authenticated client and database adapter from configuration.
29
- *
30
- * This method expects the config to have authentication already resolved:
31
- * - Either `sessionCookie` is set (from ConfigManager's session loading)
32
- * - Or `appwriteKey` is set (from config file or CLI overrides)
33
- *
34
- * The ConfigManager handles all session discovery and authentication priority,
35
- * so this factory simply applies the resolved authentication to the client.
36
- *
37
- * @param config - AppwriteConfig with resolved authentication
38
- * @returns Object containing authenticated client and database adapter
39
- * @throws Error if no authentication method is available in config
40
- *
41
- * @example
42
- * ```typescript
43
- * const config = await ConfigManager.getInstance().loadConfig();
44
- * const { client, adapter } = await ClientFactory.createFromConfig(config);
45
- *
46
- * // Client is now authenticated and ready to use
47
- * const databases = new Databases(client);
48
- * const collections = await adapter.listCollections(databaseId);
49
- * ```
50
- */
51
- static createFromConfig(config: AppwriteConfig): Promise<{
52
- client: Client;
53
- adapter: DatabaseAdapter;
54
- }>;
55
- /**
56
- * Create client and adapter from individual parameters.
57
- *
58
- * This is a lower-level method for cases where you don't have a full
59
- * AppwriteConfig object. For most use cases, prefer createFromConfig().
60
- *
61
- * @param endpoint - Appwrite endpoint URL
62
- * @param project - Appwrite project ID
63
- * @param options - Authentication and API mode options
64
- * @returns Object containing authenticated client and database adapter
65
- * @throws Error if no authentication method is provided
66
- *
67
- * @example
68
- * ```typescript
69
- * const { client, adapter } = await ClientFactory.create(
70
- * "https://cloud.appwrite.io/v1",
71
- * "my-project-id",
72
- * {
73
- * apiKey: "my-api-key",
74
- * apiMode: "auto"
75
- * }
76
- * );
77
- * ```
78
- */
79
- static create(endpoint: string, project: string, options?: {
80
- apiKey?: string;
81
- sessionCookie?: string;
82
- apiMode?: "auto" | "legacy" | "tablesdb";
83
- }): Promise<{
84
- client: Client;
85
- adapter: DatabaseAdapter;
86
- }>;
87
- }