@njdamstra/appwrite-utils-cli 1.8.9 → 1.10.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (284) 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 +2 -35
  25. package/dist/collections/indexes.js +1 -3
  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 +55 -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 +63 -9
  44. package/dist/main.js +130 -177
  45. package/dist/migrations/afterImportActions.js +2 -3
  46. package/dist/migrations/appwriteToX.d.ts +1 -1
  47. package/dist/migrations/appwriteToX.js +9 -7
  48. package/dist/migrations/comprehensiveTransfer.js +3 -5
  49. package/dist/migrations/dataLoader.js +2 -5
  50. package/dist/migrations/importController.js +3 -4
  51. package/dist/migrations/importDataActions.js +3 -3
  52. package/dist/migrations/relationships.js +1 -2
  53. package/dist/migrations/services/DataTransformationService.js +2 -2
  54. package/dist/migrations/services/FileHandlerService.js +1 -1
  55. package/dist/migrations/services/ImportOrchestrator.js +4 -4
  56. package/dist/migrations/services/RateLimitManager.js +1 -1
  57. package/dist/migrations/services/RelationshipResolver.js +1 -1
  58. package/dist/migrations/services/UserMappingService.js +1 -1
  59. package/dist/migrations/services/ValidationService.js +1 -1
  60. package/dist/migrations/transfer.d.ts +8 -4
  61. package/dist/migrations/transfer.js +106 -55
  62. package/dist/migrations/yaml/YamlImportConfigLoader.js +1 -1
  63. package/dist/migrations/yaml/YamlImportIntegration.js +2 -2
  64. package/dist/migrations/yaml/generateImportSchemas.js +1 -1
  65. package/dist/setupCommands.d.ts +1 -1
  66. package/dist/setupCommands.js +5 -6
  67. package/dist/setupController.js +1 -1
  68. package/dist/shared/backupTracking.d.ts +1 -1
  69. package/dist/shared/backupTracking.js +2 -2
  70. package/dist/shared/confirmationDialogs.js +1 -1
  71. package/dist/shared/migrationHelpers.d.ts +1 -1
  72. package/dist/shared/migrationHelpers.js +3 -3
  73. package/dist/shared/operationQueue.d.ts +1 -1
  74. package/dist/shared/operationQueue.js +2 -3
  75. package/dist/shared/operationsTable.d.ts +1 -1
  76. package/dist/shared/operationsTable.js +2 -2
  77. package/dist/shared/progressManager.js +1 -1
  78. package/dist/shared/selectionDialogs.js +9 -8
  79. package/dist/storage/methods.js +4 -4
  80. package/dist/storage/schemas.d.ts +2 -2
  81. package/dist/tables/indexManager.d.ts +65 -0
  82. package/dist/tables/indexManager.js +294 -0
  83. package/dist/types.d.ts +2 -2
  84. package/dist/types.js +1 -1
  85. package/dist/users/methods.js +2 -3
  86. package/dist/utils/configMigration.js +1 -1
  87. package/dist/utils/index.d.ts +1 -1
  88. package/dist/utils/index.js +1 -1
  89. package/dist/utils/loadConfigs.d.ts +2 -2
  90. package/dist/utils/loadConfigs.js +6 -7
  91. package/dist/utils/setupFiles.js +5 -7
  92. package/dist/utilsController.d.ts +15 -8
  93. package/dist/utilsController.js +57 -28
  94. package/package.json +7 -3
  95. package/src/adapters/index.ts +8 -34
  96. package/src/backups/operations/bucketBackup.ts +2 -2
  97. package/src/backups/operations/collectionBackup.ts +4 -4
  98. package/src/backups/operations/comprehensiveBackup.ts +3 -3
  99. package/src/backups/tracking/centralizedTracking.ts +3 -3
  100. package/src/cli/commands/configCommands.ts +72 -8
  101. package/src/cli/commands/databaseCommands.ts +161 -9
  102. package/src/cli/commands/functionCommands.ts +4 -3
  103. package/src/cli/commands/importFileCommands.ts +815 -0
  104. package/src/cli/commands/schemaCommands.ts +3 -3
  105. package/src/cli/commands/storageCommands.ts +2 -3
  106. package/src/cli/commands/transferCommands.ts +3 -6
  107. package/src/collections/attributes.ts +3 -39
  108. package/src/collections/indexes.ts +2 -4
  109. package/src/collections/methods.ts +115 -150
  110. package/src/collections/tableOperations.ts +57 -21
  111. package/src/collections/transferOperations.ts +4 -5
  112. package/src/collections/wipeOperations.ts +154 -51
  113. package/src/databases/methods.ts +2 -2
  114. package/src/databases/setup.ts +2 -2
  115. package/src/examples/yamlTerminologyExample.ts +2 -2
  116. package/src/functions/deployments.ts +6 -5
  117. package/src/functions/fnConfigDiscovery.ts +2 -2
  118. package/src/functions/methods.ts +17 -4
  119. package/src/init.ts +1 -1
  120. package/src/interactiveCLI.ts +75 -10
  121. package/src/main.ts +143 -287
  122. package/src/migrations/afterImportActions.ts +2 -3
  123. package/src/migrations/appwriteToX.ts +12 -8
  124. package/src/migrations/comprehensiveTransfer.ts +6 -6
  125. package/src/migrations/dataLoader.ts +2 -5
  126. package/src/migrations/importController.ts +3 -4
  127. package/src/migrations/importDataActions.ts +3 -3
  128. package/src/migrations/relationships.ts +1 -2
  129. package/src/migrations/services/DataTransformationService.ts +2 -2
  130. package/src/migrations/services/FileHandlerService.ts +1 -1
  131. package/src/migrations/services/ImportOrchestrator.ts +4 -4
  132. package/src/migrations/services/RateLimitManager.ts +1 -1
  133. package/src/migrations/services/RelationshipResolver.ts +1 -1
  134. package/src/migrations/services/UserMappingService.ts +1 -1
  135. package/src/migrations/services/ValidationService.ts +1 -1
  136. package/src/migrations/transfer.ts +126 -83
  137. package/src/migrations/yaml/YamlImportConfigLoader.ts +1 -1
  138. package/src/migrations/yaml/YamlImportIntegration.ts +2 -2
  139. package/src/migrations/yaml/generateImportSchemas.ts +1 -1
  140. package/src/setupCommands.ts +5 -6
  141. package/src/setupController.ts +1 -1
  142. package/src/shared/backupTracking.ts +3 -3
  143. package/src/shared/confirmationDialogs.ts +1 -1
  144. package/src/shared/migrationHelpers.ts +4 -4
  145. package/src/shared/operationQueue.ts +3 -4
  146. package/src/shared/operationsTable.ts +3 -3
  147. package/src/shared/progressManager.ts +1 -1
  148. package/src/shared/selectionDialogs.ts +9 -8
  149. package/src/storage/methods.ts +4 -4
  150. package/src/tables/indexManager.ts +409 -0
  151. package/src/types.ts +2 -2
  152. package/src/users/methods.ts +2 -3
  153. package/src/utils/configMigration.ts +1 -1
  154. package/src/utils/index.ts +1 -1
  155. package/src/utils/loadConfigs.ts +15 -7
  156. package/src/utils/setupFiles.ts +5 -7
  157. package/src/utilsController.ts +86 -32
  158. package/dist/adapters/AdapterFactory.d.ts +0 -94
  159. package/dist/adapters/AdapterFactory.js +0 -405
  160. package/dist/adapters/DatabaseAdapter.d.ts +0 -233
  161. package/dist/adapters/DatabaseAdapter.js +0 -50
  162. package/dist/adapters/LegacyAdapter.d.ts +0 -50
  163. package/dist/adapters/LegacyAdapter.js +0 -612
  164. package/dist/adapters/TablesDBAdapter.d.ts +0 -45
  165. package/dist/adapters/TablesDBAdapter.js +0 -571
  166. package/dist/config/ConfigManager.d.ts +0 -445
  167. package/dist/config/ConfigManager.js +0 -625
  168. package/dist/config/configMigration.d.ts +0 -87
  169. package/dist/config/configMigration.js +0 -390
  170. package/dist/config/configValidation.d.ts +0 -66
  171. package/dist/config/configValidation.js +0 -358
  172. package/dist/config/index.d.ts +0 -8
  173. package/dist/config/index.js +0 -7
  174. package/dist/config/services/ConfigDiscoveryService.d.ts +0 -126
  175. package/dist/config/services/ConfigDiscoveryService.js +0 -374
  176. package/dist/config/services/ConfigLoaderService.d.ts +0 -129
  177. package/dist/config/services/ConfigLoaderService.js +0 -540
  178. package/dist/config/services/ConfigMergeService.d.ts +0 -208
  179. package/dist/config/services/ConfigMergeService.js +0 -308
  180. package/dist/config/services/ConfigValidationService.d.ts +0 -214
  181. package/dist/config/services/ConfigValidationService.js +0 -310
  182. package/dist/config/services/SessionAuthService.d.ts +0 -225
  183. package/dist/config/services/SessionAuthService.js +0 -456
  184. package/dist/config/services/__tests__/ConfigMergeService.test.d.ts +0 -1
  185. package/dist/config/services/__tests__/ConfigMergeService.test.js +0 -271
  186. package/dist/config/services/index.d.ts +0 -13
  187. package/dist/config/services/index.js +0 -10
  188. package/dist/config/yamlConfig.d.ts +0 -722
  189. package/dist/config/yamlConfig.js +0 -702
  190. package/dist/functions/pathResolution.d.ts +0 -37
  191. package/dist/functions/pathResolution.js +0 -185
  192. package/dist/shared/attributeMapper.d.ts +0 -20
  193. package/dist/shared/attributeMapper.js +0 -203
  194. package/dist/shared/errorUtils.d.ts +0 -54
  195. package/dist/shared/errorUtils.js +0 -95
  196. package/dist/shared/functionManager.d.ts +0 -48
  197. package/dist/shared/functionManager.js +0 -336
  198. package/dist/shared/indexManager.d.ts +0 -24
  199. package/dist/shared/indexManager.js +0 -151
  200. package/dist/shared/jsonSchemaGenerator.d.ts +0 -50
  201. package/dist/shared/jsonSchemaGenerator.js +0 -290
  202. package/dist/shared/logging.d.ts +0 -61
  203. package/dist/shared/logging.js +0 -116
  204. package/dist/shared/messageFormatter.d.ts +0 -39
  205. package/dist/shared/messageFormatter.js +0 -162
  206. package/dist/shared/pydanticModelGenerator.d.ts +0 -17
  207. package/dist/shared/pydanticModelGenerator.js +0 -615
  208. package/dist/shared/schemaGenerator.d.ts +0 -40
  209. package/dist/shared/schemaGenerator.js +0 -556
  210. package/dist/utils/ClientFactory.d.ts +0 -87
  211. package/dist/utils/ClientFactory.js +0 -212
  212. package/dist/utils/configDiscovery.d.ts +0 -78
  213. package/dist/utils/configDiscovery.js +0 -472
  214. package/dist/utils/constantsGenerator.d.ts +0 -31
  215. package/dist/utils/constantsGenerator.js +0 -321
  216. package/dist/utils/dataConverters.d.ts +0 -46
  217. package/dist/utils/dataConverters.js +0 -139
  218. package/dist/utils/directoryUtils.d.ts +0 -22
  219. package/dist/utils/directoryUtils.js +0 -59
  220. package/dist/utils/getClientFromConfig.d.ts +0 -39
  221. package/dist/utils/getClientFromConfig.js +0 -199
  222. package/dist/utils/helperFunctions.d.ts +0 -63
  223. package/dist/utils/helperFunctions.js +0 -156
  224. package/dist/utils/pathResolvers.d.ts +0 -53
  225. package/dist/utils/pathResolvers.js +0 -72
  226. package/dist/utils/projectConfig.d.ts +0 -119
  227. package/dist/utils/projectConfig.js +0 -171
  228. package/dist/utils/retryFailedPromises.d.ts +0 -2
  229. package/dist/utils/retryFailedPromises.js +0 -23
  230. package/dist/utils/sessionAuth.d.ts +0 -48
  231. package/dist/utils/sessionAuth.js +0 -164
  232. package/dist/utils/typeGuards.d.ts +0 -35
  233. package/dist/utils/typeGuards.js +0 -57
  234. package/dist/utils/validationRules.d.ts +0 -43
  235. package/dist/utils/validationRules.js +0 -42
  236. package/dist/utils/versionDetection.d.ts +0 -58
  237. package/dist/utils/versionDetection.js +0 -251
  238. package/dist/utils/yamlConverter.d.ts +0 -100
  239. package/dist/utils/yamlConverter.js +0 -428
  240. package/dist/utils/yamlLoader.d.ts +0 -70
  241. package/dist/utils/yamlLoader.js +0 -267
  242. package/src/adapters/AdapterFactory.ts +0 -510
  243. package/src/adapters/DatabaseAdapter.ts +0 -306
  244. package/src/adapters/LegacyAdapter.ts +0 -841
  245. package/src/adapters/TablesDBAdapter.ts +0 -773
  246. package/src/config/ConfigManager.ts +0 -808
  247. package/src/config/README.md +0 -274
  248. package/src/config/configMigration.ts +0 -575
  249. package/src/config/configValidation.ts +0 -445
  250. package/src/config/index.ts +0 -10
  251. package/src/config/services/ConfigDiscoveryService.ts +0 -463
  252. package/src/config/services/ConfigLoaderService.ts +0 -740
  253. package/src/config/services/ConfigMergeService.ts +0 -388
  254. package/src/config/services/ConfigValidationService.ts +0 -394
  255. package/src/config/services/SessionAuthService.ts +0 -565
  256. package/src/config/services/__tests__/ConfigMergeService.test.ts +0 -351
  257. package/src/config/services/index.ts +0 -29
  258. package/src/config/yamlConfig.ts +0 -761
  259. package/src/functions/pathResolution.ts +0 -227
  260. package/src/shared/attributeMapper.ts +0 -229
  261. package/src/shared/errorUtils.ts +0 -110
  262. package/src/shared/functionManager.ts +0 -525
  263. package/src/shared/indexManager.ts +0 -254
  264. package/src/shared/jsonSchemaGenerator.ts +0 -383
  265. package/src/shared/logging.ts +0 -149
  266. package/src/shared/messageFormatter.ts +0 -208
  267. package/src/shared/pydanticModelGenerator.ts +0 -618
  268. package/src/shared/schemaGenerator.ts +0 -644
  269. package/src/utils/ClientFactory.ts +0 -240
  270. package/src/utils/configDiscovery.ts +0 -557
  271. package/src/utils/constantsGenerator.ts +0 -369
  272. package/src/utils/dataConverters.ts +0 -159
  273. package/src/utils/directoryUtils.ts +0 -61
  274. package/src/utils/getClientFromConfig.ts +0 -257
  275. package/src/utils/helperFunctions.ts +0 -228
  276. package/src/utils/pathResolvers.ts +0 -81
  277. package/src/utils/projectConfig.ts +0 -299
  278. package/src/utils/retryFailedPromises.ts +0 -29
  279. package/src/utils/sessionAuth.ts +0 -230
  280. package/src/utils/typeGuards.ts +0 -65
  281. package/src/utils/validationRules.ts +0 -88
  282. package/src/utils/versionDetection.ts +0 -292
  283. package/src/utils/yamlConverter.ts +0 -542
  284. package/src/utils/yamlLoader.ts +0 -371
@@ -1,290 +0,0 @@
1
- import fs from "fs";
2
- import path from "path";
3
- import { toCamelCase, toPascalCase } from "../utils/index.js";
4
- import chalk from "chalk";
5
- import { extractSimpleRelationships, resolveCollectionName } from "./relationshipExtractor.js";
6
- import { MessageFormatter } from "./messageFormatter.js";
7
- export class JsonSchemaGenerator {
8
- config;
9
- appwriteFolderPath;
10
- relationshipMap = new Map();
11
- constructor(config, appwriteFolderPath) {
12
- this.config = config;
13
- this.appwriteFolderPath = appwriteFolderPath;
14
- this.extractRelationships();
15
- }
16
- resolveCollectionName = (idOrName) => {
17
- return resolveCollectionName(this.config, idOrName);
18
- };
19
- extractRelationships() {
20
- this.relationshipMap = extractSimpleRelationships(this.config);
21
- }
22
- attributeToJsonSchemaProperty(attribute) {
23
- const property = {
24
- type: "string" // Default type
25
- };
26
- // Handle array attributes
27
- if (attribute.array) {
28
- property.type = "array";
29
- property.items = this.getBaseTypeSchema(attribute);
30
- }
31
- else {
32
- Object.assign(property, this.getBaseTypeSchema(attribute));
33
- }
34
- // Set default value (only for attributes that support it)
35
- if (attribute.type !== "relationship" && "xdefault" in attribute &&
36
- attribute.xdefault !== undefined && attribute.xdefault !== null) {
37
- property.default = attribute.xdefault;
38
- }
39
- return property;
40
- }
41
- getBaseTypeSchema(attribute) {
42
- const schema = {
43
- type: "string" // Default type
44
- };
45
- switch (attribute.type) {
46
- case "string":
47
- schema.type = "string";
48
- if (attribute.size) {
49
- schema.maxLength = attribute.size;
50
- }
51
- break;
52
- case "integer":
53
- schema.type = "integer";
54
- if (attribute.min !== undefined) {
55
- schema.minimum = Number(attribute.min);
56
- }
57
- if (attribute.max !== undefined) {
58
- schema.maximum = Number(attribute.max);
59
- }
60
- break;
61
- case "double":
62
- case "float": // Backward compatibility
63
- schema.type = "number";
64
- if (attribute.min !== undefined) {
65
- schema.minimum = Number(attribute.min);
66
- }
67
- if (attribute.max !== undefined) {
68
- schema.maximum = Number(attribute.max);
69
- }
70
- break;
71
- case "boolean":
72
- schema.type = "boolean";
73
- break;
74
- case "datetime":
75
- schema.type = "string";
76
- schema.format = "date-time";
77
- break;
78
- case "email":
79
- schema.type = "string";
80
- schema.format = "email";
81
- break;
82
- case "ip":
83
- schema.type = "string";
84
- schema.format = "ipv4";
85
- break;
86
- case "url":
87
- schema.type = "string";
88
- schema.format = "uri";
89
- break;
90
- case "enum":
91
- schema.type = "string";
92
- if (attribute.elements) {
93
- schema.enum = attribute.elements;
94
- }
95
- break;
96
- case "relationship":
97
- if (attribute.relatedCollection) {
98
- // For relationships, reference the related collection schema
99
- schema.$ref = `#/definitions/${toPascalCase(this.resolveCollectionName(attribute.relatedCollection))}`;
100
- }
101
- else {
102
- schema.type = "string";
103
- }
104
- break;
105
- default:
106
- schema.type = "string";
107
- }
108
- return schema;
109
- }
110
- createJsonSchema(collection) {
111
- const pascalName = toPascalCase(collection.name);
112
- const schema = {
113
- $schema: "https://json-schema.org/draft/2020-12/schema",
114
- $id: `https://example.com/schemas/${toCamelCase(collection.name)}.json`,
115
- title: pascalName,
116
- type: "object",
117
- properties: {
118
- // Standard Appwrite document fields
119
- $id: {
120
- type: "string",
121
- pattern: "^[a-zA-Z0-9][a-zA-Z0-9._-]{0,35}$"
122
- },
123
- $createdAt: {
124
- type: "string",
125
- format: "date-time"
126
- },
127
- $updatedAt: {
128
- type: "string",
129
- format: "date-time"
130
- },
131
- $permissions: {
132
- type: "array",
133
- items: {
134
- type: "string"
135
- }
136
- }
137
- },
138
- required: ["$id", "$createdAt", "$updatedAt"],
139
- additionalProperties: false
140
- };
141
- // Add custom attributes
142
- const requiredFields = [...schema.required];
143
- if (collection.attributes) {
144
- collection.attributes.forEach((attribute) => {
145
- schema.properties[attribute.key] = this.attributeToJsonSchemaProperty(attribute);
146
- if (attribute.required) {
147
- requiredFields.push(attribute.key);
148
- }
149
- });
150
- }
151
- schema.required = requiredFields;
152
- // Add relationship definitions if any exist
153
- const relationships = this.relationshipMap.get(collection.name);
154
- if (relationships && relationships.length > 0) {
155
- schema.definitions = {};
156
- relationships.forEach((rel) => {
157
- const relatedPascalName = toPascalCase(rel.relatedCollection);
158
- schema.definitions[relatedPascalName] = {
159
- type: "object",
160
- properties: {
161
- $id: { type: "string" },
162
- $createdAt: { type: "string", format: "date-time" },
163
- $updatedAt: { type: "string", format: "date-time" }
164
- },
165
- additionalProperties: true
166
- };
167
- });
168
- }
169
- return schema;
170
- }
171
- generateJsonSchemas(options = {}) {
172
- const { outputFormat = "both", outputDirectory = "schemas", verbose = false } = options;
173
- if (!this.config.collections) {
174
- if (verbose) {
175
- MessageFormatter.warning("No collections found in config", { prefix: "Schema" });
176
- }
177
- return;
178
- }
179
- // Create JSON schemas directory using provided outputDirectory
180
- const jsonSchemasPath = path.isAbsolute(outputDirectory)
181
- ? outputDirectory
182
- : path.join(this.appwriteFolderPath, outputDirectory);
183
- if (!fs.existsSync(jsonSchemasPath)) {
184
- fs.mkdirSync(jsonSchemasPath, { recursive: true });
185
- }
186
- if (verbose) {
187
- MessageFormatter.processing(`Generating JSON schemas for ${this.config.collections.length} collections...`, { prefix: "Schema" });
188
- }
189
- this.config.collections.forEach((collection) => {
190
- const schema = this.createJsonSchema(collection);
191
- const camelCaseName = toCamelCase(collection.name);
192
- // Generate JSON file
193
- if (outputFormat === "json" || outputFormat === "both") {
194
- const jsonPath = path.join(jsonSchemasPath, `${camelCaseName}.json`);
195
- fs.writeFileSync(jsonPath, JSON.stringify(schema, null, 2), { encoding: "utf-8" });
196
- if (verbose) {
197
- MessageFormatter.success(`JSON schema written to ${jsonPath}`, { prefix: "Schema" });
198
- }
199
- }
200
- // Generate TypeScript file
201
- if (outputFormat === "typescript" || outputFormat === "both") {
202
- const tsContent = this.generateTypeScriptSchema(schema, collection.name);
203
- const tsPath = path.join(jsonSchemasPath, `${camelCaseName}.schema.ts`);
204
- fs.writeFileSync(tsPath, tsContent, { encoding: "utf-8" });
205
- if (verbose) {
206
- MessageFormatter.success(`TypeScript schema written to ${tsPath}`, { prefix: "Schema" });
207
- }
208
- }
209
- });
210
- // Generate index file only for TypeScript output
211
- if (outputFormat === "typescript" || outputFormat === "both") {
212
- this.generateIndexFile(outputFormat, jsonSchemasPath, verbose);
213
- }
214
- if (verbose) {
215
- MessageFormatter.success("JSON schema generation completed", { prefix: "Schema" });
216
- }
217
- }
218
- generateTypeScriptSchema(schema, collectionName) {
219
- const camelName = toCamelCase(collectionName);
220
- return `// Auto-generated JSON schema for ${collectionName}
221
- import type { JSONSchema7 } from "json-schema";
222
-
223
- export const ${camelName}JsonSchema: JSONSchema7 = ${JSON.stringify(schema, null, 2)} as const;
224
-
225
- export type ${toPascalCase(collectionName)}JsonSchema = typeof ${camelName}JsonSchema;
226
-
227
- export default ${camelName}JsonSchema;
228
- `;
229
- }
230
- generateIndexFile(outputFormat, jsonSchemasPath, verbose) {
231
- if (!this.config.collections)
232
- return;
233
- const indexPath = path.join(jsonSchemasPath, "index.ts");
234
- const imports = [];
235
- const exports = [];
236
- this.config.collections.forEach((collection) => {
237
- const camelName = toCamelCase(collection.name);
238
- const pascalName = toPascalCase(collection.name);
239
- if (outputFormat === "typescript" || outputFormat === "both") {
240
- imports.push(`import { ${camelName}JsonSchema } from "./${camelName}.schema.js";`);
241
- exports.push(` ${camelName}: ${camelName}JsonSchema,`);
242
- }
243
- });
244
- const indexContent = `// Auto-generated index for JSON schemas
245
- ${imports.join('\n')}
246
-
247
- export const jsonSchemas = {
248
- ${exports.join('\n')}
249
- };
250
-
251
- export type JsonSchemas = typeof jsonSchemas;
252
-
253
- // Individual schema exports
254
- ${this.config.collections.map(collection => {
255
- const camelName = toCamelCase(collection.name);
256
- return `export { ${camelName}JsonSchema } from "./${camelName}.schema.js";`;
257
- }).join('\n')}
258
-
259
- export default jsonSchemas;
260
- `;
261
- fs.writeFileSync(indexPath, indexContent, { encoding: "utf-8" });
262
- if (verbose) {
263
- MessageFormatter.success(`Index file written to ${indexPath}`, { prefix: "Schema" });
264
- }
265
- }
266
- validateSchema(schema) {
267
- const errors = [];
268
- // Basic validation
269
- if (!schema.$schema) {
270
- errors.push("Missing $schema property");
271
- }
272
- if (!schema.title) {
273
- errors.push("Missing title property");
274
- }
275
- if (!schema.properties) {
276
- errors.push("Missing properties");
277
- }
278
- if (!schema.required || !Array.isArray(schema.required)) {
279
- errors.push("Missing or invalid required array");
280
- }
281
- // Validate required Appwrite fields
282
- const requiredAppwriteFields = ["$id", "$createdAt", "$updatedAt"];
283
- requiredAppwriteFields.forEach((field) => {
284
- if (!schema.properties[field]) {
285
- errors.push(`Missing required Appwrite field: ${field}`);
286
- }
287
- });
288
- return { valid: errors.length === 0, errors };
289
- }
290
- }
@@ -1,61 +0,0 @@
1
- import winston from "winston";
2
- export interface LoggingConfig {
3
- enabled: boolean;
4
- level: string;
5
- logDirectory?: string;
6
- console: boolean;
7
- }
8
- /**
9
- * Predefined logging configurations for common debugging scenarios
10
- */
11
- export declare const LOGGING_PRESETS: {
12
- /** Minimal logging - errors only to console */
13
- readonly minimal: {
14
- readonly enabled: false;
15
- readonly level: "error";
16
- readonly console: true;
17
- };
18
- /** Standard logging - info level to file and console */
19
- readonly standard: {
20
- readonly enabled: true;
21
- readonly level: "info";
22
- readonly console: true;
23
- };
24
- /** Debug logging - verbose debug output for troubleshooting */
25
- readonly debug: {
26
- readonly enabled: true;
27
- readonly level: "debug";
28
- readonly console: true;
29
- };
30
- /** Silent - no logging output */
31
- readonly silent: {
32
- readonly enabled: false;
33
- readonly level: "error";
34
- readonly console: false;
35
- };
36
- };
37
- export declare const configureLogging: (config?: Partial<LoggingConfig>) => void;
38
- /**
39
- * Configure logging using a preset
40
- */
41
- export declare const configureLoggingPreset: (preset: keyof typeof LOGGING_PRESETS, logDirectory?: string) => void;
42
- export declare let logger: winston.Logger;
43
- export declare const updateLogger: () => void;
44
- /**
45
- * Enable debug logging for troubleshooting push process issues
46
- * This is a convenience function for quickly enabling comprehensive logging
47
- */
48
- export declare const enableDebugLogging: (logDirectory?: string) => void;
49
- /**
50
- * Disable logging (reset to default)
51
- */
52
- export declare const disableLogging: () => void;
53
- /**
54
- * Get current logging configuration
55
- */
56
- export declare const getLoggingConfig: () => {
57
- enabled: boolean;
58
- level: string;
59
- logDirectory?: string;
60
- console: boolean;
61
- };
@@ -1,116 +0,0 @@
1
- import winston from "winston";
2
- import fs from "fs";
3
- import path from "path";
4
- /**
5
- * Predefined logging configurations for common debugging scenarios
6
- */
7
- export const LOGGING_PRESETS = {
8
- /** Minimal logging - errors only to console */
9
- minimal: {
10
- enabled: false,
11
- level: 'error',
12
- console: true
13
- },
14
- /** Standard logging - info level to file and console */
15
- standard: {
16
- enabled: true,
17
- level: 'info',
18
- console: true
19
- },
20
- /** Debug logging - verbose debug output for troubleshooting */
21
- debug: {
22
- enabled: true,
23
- level: 'debug',
24
- console: true
25
- },
26
- /** Silent - no logging output */
27
- silent: {
28
- enabled: false,
29
- level: 'error',
30
- console: false
31
- }
32
- };
33
- const DEFAULT_LOGGING_CONFIG = {
34
- enabled: false,
35
- level: "info",
36
- console: false,
37
- };
38
- let loggingConfig = DEFAULT_LOGGING_CONFIG;
39
- export const configureLogging = (config = {}) => {
40
- loggingConfig = { ...DEFAULT_LOGGING_CONFIG, ...config };
41
- };
42
- /**
43
- * Configure logging using a preset
44
- */
45
- export const configureLoggingPreset = (preset, logDirectory) => {
46
- const presetConfig = LOGGING_PRESETS[preset];
47
- configureLogging({
48
- ...presetConfig,
49
- ...(logDirectory && { logDirectory })
50
- });
51
- updateLogger();
52
- };
53
- const createLogger = () => {
54
- const transports = [];
55
- // Add console transport if enabled
56
- if (loggingConfig.console) {
57
- transports.push(new winston.transports.Console({
58
- format: winston.format.combine(winston.format.colorize(), winston.format.simple())
59
- }));
60
- }
61
- // Add file transports if logging is enabled
62
- if (loggingConfig.enabled) {
63
- const logDir = loggingConfig.logDirectory || path.join(process.cwd(), "zlogs");
64
- if (!fs.existsSync(logDir)) {
65
- fs.mkdirSync(logDir, { recursive: true });
66
- }
67
- transports.push(new winston.transports.File({
68
- filename: path.join(logDir, "error.log"),
69
- level: "error",
70
- }), new winston.transports.File({
71
- filename: path.join(logDir, "combined.log"),
72
- }));
73
- }
74
- return winston.createLogger({
75
- level: loggingConfig.level,
76
- format: winston.format.combine(winston.format.timestamp(), winston.format.errors({ stack: true }), winston.format.json()),
77
- defaultMeta: { service: "@njdamstra/appwrite-utils-cli" },
78
- transports,
79
- silent: !loggingConfig.enabled && !loggingConfig.console,
80
- });
81
- };
82
- export let logger = createLogger();
83
- // Recreate logger when config changes
84
- export const updateLogger = () => {
85
- logger = createLogger();
86
- };
87
- /**
88
- * Enable debug logging for troubleshooting push process issues
89
- * This is a convenience function for quickly enabling comprehensive logging
90
- */
91
- export const enableDebugLogging = (logDirectory) => {
92
- configureLogging({
93
- enabled: true,
94
- level: 'debug',
95
- console: true,
96
- logDirectory
97
- });
98
- updateLogger();
99
- logger.info('Debug logging enabled for push process troubleshooting', {
100
- level: 'debug',
101
- console: true,
102
- logDirectory: logDirectory || 'zlogs',
103
- operation: 'enableDebugLogging'
104
- });
105
- };
106
- /**
107
- * Disable logging (reset to default)
108
- */
109
- export const disableLogging = () => {
110
- configureLogging(DEFAULT_LOGGING_CONFIG);
111
- updateLogger();
112
- };
113
- /**
114
- * Get current logging configuration
115
- */
116
- export const getLoggingConfig = () => ({ ...loggingConfig });
@@ -1,39 +0,0 @@
1
- export interface MessageOptions {
2
- prefix?: string;
3
- skipLogging?: boolean;
4
- logLevel?: "info" | "warn" | "error" | "debug";
5
- }
6
- export declare class MessageFormatter {
7
- static success(message: string, options?: MessageOptions): void;
8
- static error(message: string, error?: Error | string, options?: MessageOptions): void;
9
- static warning(message: string, options?: MessageOptions): void;
10
- static info(message: string, options?: MessageOptions): void;
11
- static step(step: number, total: number, message: string, options?: MessageOptions): void;
12
- static progress(message: string, options?: MessageOptions): void;
13
- static debug(message: string, data?: any, options?: MessageOptions): void;
14
- static processing(message: string, options?: MessageOptions): void;
15
- static divider(): void;
16
- static banner(title: string, subtitle?: string): void;
17
- static section(title: string): void;
18
- static list(items: string[], title?: string): void;
19
- static table(data: Record<string, string | number>[], headers?: string[]): void;
20
- static operationSummary(title: string, stats: Record<string, string | number>, duration?: number): void;
21
- static formatBytes(bytes: number): string;
22
- static formatDuration(ms: number): string;
23
- static formatNumber(num: number): string;
24
- }
25
- export declare const Messages: {
26
- readonly CONFIG_NOT_FOUND: "Appwrite configuration not found. Run 'appwrite-migrate setup' first.";
27
- readonly CONFIG_LOADED: (type: string, path: string) => string;
28
- readonly DATABASE_CONNECTION_FAILED: "Failed to connect to Appwrite. Check your endpoint and API key.";
29
- readonly OPERATION_CANCELLED: "Operation cancelled by user.";
30
- readonly OPERATION_COMPLETED: (operation: string) => string;
31
- readonly BACKUP_STARTED: (database: string) => string;
32
- readonly BACKUP_COMPLETED: (database: string, size: number) => string;
33
- readonly IMPORT_STARTED: (collections: number) => string;
34
- readonly IMPORT_COMPLETED: (documents: number) => string;
35
- readonly FUNCTION_DEPLOYED: (name: string) => string;
36
- readonly FUNCTION_DEPLOYMENT_FAILED: (name: string, error: string) => string;
37
- readonly TRANSFER_STARTED: (source: string, target: string) => string;
38
- readonly TRANSFER_COMPLETED: (items: number) => string;
39
- };
@@ -1,162 +0,0 @@
1
- import chalk from "chalk";
2
- import { logger } from "./logging.js";
3
- export class MessageFormatter {
4
- static success(message, options = {}) {
5
- const formatted = `${chalk.green("✅")} ${options.prefix ? `${options.prefix}: ` : ""}${message}`;
6
- console.log(formatted);
7
- if (!options.skipLogging) {
8
- logger.info(`SUCCESS: ${options.prefix ? `${options.prefix}: ` : ""}${message}`);
9
- }
10
- }
11
- static error(message, error, options = {}) {
12
- const errorDetails = error instanceof Error ? error.message : error;
13
- const formatted = `${chalk.red("❌")} ${options.prefix ? `${options.prefix}: ` : ""}${message}${errorDetails ? `\n ${chalk.gray(errorDetails)}` : ""}`;
14
- console.error(formatted);
15
- if (!options.skipLogging) {
16
- logger.error(`ERROR: ${options.prefix ? `${options.prefix}: ` : ""}${message}`, {
17
- error: errorDetails,
18
- stack: error instanceof Error ? error.stack : undefined,
19
- });
20
- }
21
- }
22
- static warning(message, options = {}) {
23
- const formatted = `${chalk.yellow("⚠️")} ${options.prefix ? `${options.prefix}: ` : ""}${message}`;
24
- console.log(formatted);
25
- if (!options.skipLogging) {
26
- logger.warn(`WARNING: ${options.prefix ? `${options.prefix}: ` : ""}${message}`);
27
- }
28
- }
29
- static info(message, options = {}) {
30
- const formatted = `${chalk.blue("ℹ️")} ${options.prefix ? `${options.prefix}: ` : ""}${message}`;
31
- console.log(formatted);
32
- if (!options.skipLogging) {
33
- logger.info(`INFO: ${options.prefix ? `${options.prefix}: ` : ""}${message}`);
34
- }
35
- }
36
- static step(step, total, message, options = {}) {
37
- const formatted = `${chalk.cyan(`[${step}/${total}]`)} ${options.prefix ? `${options.prefix}: ` : ""}${message}`;
38
- console.log(formatted);
39
- if (!options.skipLogging) {
40
- logger.info(`STEP ${step}/${total}: ${options.prefix ? `${options.prefix}: ` : ""}${message}`);
41
- }
42
- }
43
- static progress(message, options = {}) {
44
- const formatted = `${chalk.gray("⏳")} ${options.prefix ? `${options.prefix}: ` : ""}${message}`;
45
- console.log(formatted);
46
- if (!options.skipLogging) {
47
- logger.debug(`PROGRESS: ${options.prefix ? `${options.prefix}: ` : ""}${message}`);
48
- }
49
- }
50
- static debug(message, data, options = {}) {
51
- if (process.env.NODE_ENV === "development" || process.env.DEBUG) {
52
- const formatted = `${chalk.magenta("🔍")} ${options.prefix ? `${options.prefix}: ` : ""}${message}`;
53
- console.log(formatted);
54
- if (data) {
55
- console.log(chalk.gray(JSON.stringify(data, null, 2)));
56
- }
57
- }
58
- if (!options.skipLogging) {
59
- logger.debug(`DEBUG: ${options.prefix ? `${options.prefix}: ` : ""}${message}`, data);
60
- }
61
- }
62
- static processing(message, options = {}) {
63
- const formatted = `${chalk.cyan("⚙️")} ${options.prefix ? `${options.prefix}: ` : ""}${message}`;
64
- console.log(formatted);
65
- if (!options.skipLogging) {
66
- logger.info(`PROCESSING: ${options.prefix ? `${options.prefix}: ` : ""}${message}`);
67
- }
68
- }
69
- static divider() {
70
- console.log(chalk.gray("─".repeat(60)));
71
- }
72
- static banner(title, subtitle) {
73
- const divider = chalk.cyan("═".repeat(60));
74
- console.log(`\n${divider}`);
75
- console.log(chalk.cyan.bold(` ${title}`));
76
- if (subtitle) {
77
- console.log(chalk.gray(` ${subtitle}`));
78
- }
79
- console.log(`${divider}\n`);
80
- }
81
- static section(title) {
82
- console.log(`\n${chalk.bold.underline(title)}`);
83
- }
84
- static list(items, title) {
85
- if (title) {
86
- console.log(chalk.bold(title));
87
- }
88
- items.forEach((item, index) => {
89
- console.log(`${chalk.gray(` ${index + 1}.`)} ${item}`);
90
- });
91
- }
92
- static table(data, headers) {
93
- if (data.length === 0)
94
- return;
95
- const keys = headers || Object.keys(data[0]);
96
- const maxWidths = keys.map(key => Math.max(key.length, ...data.map(row => String(row[key]).length)));
97
- // Header
98
- const headerRow = keys.map((key, i) => chalk.bold(key.padEnd(maxWidths[i]))).join(" │ ");
99
- console.log(`┌─${keys.map((_, i) => "─".repeat(maxWidths[i])).join("─┼─")}─┐`);
100
- console.log(`│ ${headerRow} │`);
101
- console.log(`├─${keys.map((_, i) => "─".repeat(maxWidths[i])).join("─┼─")}─┤`);
102
- // Rows
103
- data.forEach(row => {
104
- const dataRow = keys.map((key, i) => String(row[key]).padEnd(maxWidths[i])).join(" │ ");
105
- console.log(`│ ${dataRow} │`);
106
- });
107
- console.log(`└─${keys.map((_, i) => "─".repeat(maxWidths[i])).join("─┴─")}─┘`);
108
- }
109
- static operationSummary(title, stats, duration) {
110
- this.section(`${title} Summary`);
111
- Object.entries(stats).forEach(([key, value]) => {
112
- const formattedKey = key.replace(/([A-Z])/g, ' $1').replace(/^./, str => str.toUpperCase());
113
- console.log(`${chalk.gray("●")} ${formattedKey}: ${chalk.cyan(String(value))}`);
114
- });
115
- if (duration) {
116
- console.log(`${chalk.gray("●")} Duration: ${chalk.cyan(this.formatDuration(duration))}`);
117
- }
118
- console.log();
119
- }
120
- static formatBytes(bytes) {
121
- const units = ['B', 'KB', 'MB', 'GB', 'TB'];
122
- let size = bytes;
123
- let unitIndex = 0;
124
- while (size >= 1024 && unitIndex < units.length - 1) {
125
- size /= 1024;
126
- unitIndex++;
127
- }
128
- return `${size.toFixed(1)} ${units[unitIndex]}`;
129
- }
130
- static formatDuration(ms) {
131
- const seconds = Math.floor(ms / 1000);
132
- const minutes = Math.floor(seconds / 60);
133
- const hours = Math.floor(minutes / 60);
134
- if (hours > 0) {
135
- return `${hours}h ${minutes % 60}m ${seconds % 60}s`;
136
- }
137
- else if (minutes > 0) {
138
- return `${minutes}m ${seconds % 60}s`;
139
- }
140
- else {
141
- return `${seconds}s`;
142
- }
143
- }
144
- static formatNumber(num) {
145
- return num.toLocaleString();
146
- }
147
- }
148
- export const Messages = {
149
- CONFIG_NOT_FOUND: "Appwrite configuration not found. Run 'appwrite-migrate setup' first.",
150
- CONFIG_LOADED: (type, path) => `Loaded ${type} configuration from ${path}`,
151
- DATABASE_CONNECTION_FAILED: "Failed to connect to Appwrite. Check your endpoint and API key.",
152
- OPERATION_CANCELLED: "Operation cancelled by user.",
153
- OPERATION_COMPLETED: (operation) => `${operation} completed successfully`,
154
- BACKUP_STARTED: (database) => `Starting backup for database: ${database}`,
155
- BACKUP_COMPLETED: (database, size) => `Backup completed for ${database} (${MessageFormatter.formatBytes(size)})`,
156
- IMPORT_STARTED: (collections) => `Starting import process for ${collections} collection(s)`,
157
- IMPORT_COMPLETED: (documents) => `Import completed. Processed ${MessageFormatter.formatNumber(documents)} documents`,
158
- FUNCTION_DEPLOYED: (name) => `Function '${name}' deployed successfully`,
159
- FUNCTION_DEPLOYMENT_FAILED: (name, error) => `Function '${name}' deployment failed: ${error}`,
160
- TRANSFER_STARTED: (source, target) => `Starting transfer from ${source} to ${target}`,
161
- TRANSFER_COMPLETED: (items) => `Transfer completed. Moved ${MessageFormatter.formatNumber(items)} items`,
162
- };
@@ -1,17 +0,0 @@
1
- import type { AppwriteConfig } from '@njdamstra/appwrite-utils';
2
- export declare class PydanticModelGenerator {
3
- private config;
4
- private appwriteFolderPath;
5
- constructor(config: AppwriteConfig, appwriteFolderPath: string);
6
- generatePydanticModels(options: {
7
- baseOutputDirectory: string;
8
- verbose?: boolean;
9
- }): void;
10
- private writeBase;
11
- private generateModel;
12
- private composeHeader;
13
- private defaultInitializer;
14
- private mapAttributeToPythonType;
15
- private toSnake;
16
- private toPascal;
17
- }