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