appwrite-utils-cli 1.9.7 → 1.11.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.
- package/CONFIG_TODO.md +1189 -1189
- package/README.md +1004 -1004
- package/SELECTION_DIALOGS.md +145 -145
- package/SERVICE_IMPLEMENTATION_REPORT.md +462 -462
- package/package.json +6 -3
- package/scripts/copy-templates.ts +23 -23
- package/src/adapters/index.ts +11 -37
- package/src/backups/operations/bucketBackup.ts +277 -277
- package/src/backups/operations/collectionBackup.ts +310 -310
- package/src/backups/operations/comprehensiveBackup.ts +342 -342
- package/src/backups/schemas/bucketManifest.ts +78 -78
- package/src/backups/schemas/comprehensiveManifest.ts +76 -76
- package/src/backups/tracking/centralizedTracking.ts +352 -352
- package/src/cli/commands/configCommands.ts +265 -201
- package/src/cli/commands/databaseCommands.ts +931 -879
- package/src/cli/commands/functionCommands.ts +333 -332
- package/src/cli/commands/importFileCommands.ts +815 -0
- package/src/cli/commands/schemaCommands.ts +141 -141
- package/src/cli/commands/storageCommands.ts +2 -3
- package/src/cli/commands/transferCommands.ts +454 -457
- package/src/collections/attributes.ts.backup +1555 -1555
- package/src/collections/{attributes.ts → columns.ts} +15 -10
- package/src/collections/indexes.ts +350 -352
- package/src/collections/methods.ts +714 -700
- package/src/collections/tableOperations.ts +29 -8
- package/src/collections/transferOperations.ts +376 -377
- package/src/collections/wipeOperations.ts +449 -346
- package/src/databases/methods.ts +49 -49
- package/src/databases/setup.ts +77 -77
- package/src/examples/yamlTerminologyExample.ts +346 -346
- package/src/functions/deployments.ts +221 -220
- package/src/functions/fnConfigDiscovery.ts +2 -2
- package/src/functions/methods.ts +284 -284
- package/src/functions/templates/count-docs-in-collection/README.md +53 -53
- package/src/functions/templates/count-docs-in-collection/src/main.ts +159 -159
- package/src/functions/templates/count-docs-in-collection/src/request.ts +8 -8
- package/src/functions/templates/hono-typescript/README.md +285 -285
- package/src/functions/templates/hono-typescript/src/adapters/request.ts +73 -73
- package/src/functions/templates/hono-typescript/src/adapters/response.ts +105 -105
- package/src/functions/templates/hono-typescript/src/app.ts +179 -179
- package/src/functions/templates/hono-typescript/src/context.ts +102 -102
- package/src/functions/templates/hono-typescript/src/{index.ts → main.ts} +53 -53
- package/src/functions/templates/hono-typescript/src/middleware/appwrite.ts +118 -118
- package/src/functions/templates/typescript-node/README.md +31 -31
- package/src/functions/templates/typescript-node/src/context.ts +102 -102
- package/src/functions/templates/typescript-node/src/{index.ts → main.ts} +29 -29
- package/src/functions/templates/uv/README.md +30 -30
- package/src/functions/templates/uv/pyproject.toml +29 -29
- package/src/functions/templates/uv/src/context.py +124 -124
- package/src/functions/templates/uv/src/{index.py → main.py} +45 -45
- package/src/init.ts +62 -62
- package/src/interactiveCLI.ts +1095 -1030
- package/src/main.ts +1517 -1670
- package/src/migrations/afterImportActions.ts +579 -580
- package/src/migrations/appwriteToX.ts +634 -630
- package/src/migrations/comprehensiveTransfer.ts +2149 -2149
- package/src/migrations/dataLoader.ts +1729 -1702
- package/src/migrations/importController.ts +440 -428
- package/src/migrations/importDataActions.ts +315 -315
- package/src/migrations/relationships.ts +333 -334
- package/src/migrations/services/DataTransformationService.ts +195 -195
- package/src/migrations/services/FileHandlerService.ts +310 -310
- package/src/migrations/services/ImportOrchestrator.ts +674 -665
- package/src/migrations/services/RateLimitManager.ts +362 -362
- package/src/migrations/services/RelationshipResolver.ts +460 -460
- package/src/migrations/services/UserMappingService.ts +344 -344
- package/src/migrations/services/ValidationService.ts +333 -333
- package/src/migrations/transfer.ts +987 -942
- package/src/migrations/yaml/YamlImportConfigLoader.ts +438 -438
- package/src/migrations/yaml/YamlImportIntegration.ts +438 -438
- package/src/migrations/yaml/generateImportSchemas.ts +1347 -1347
- package/src/schemas/authUser.ts +23 -23
- package/src/setup.ts +8 -8
- package/src/setupCommands.ts +5 -6
- package/src/setupController.ts +42 -42
- package/src/shared/backupMetadataSchema.ts +93 -93
- package/src/shared/backupTracking.ts +211 -211
- package/src/shared/confirmationDialogs.ts +326 -326
- package/src/shared/migrationHelpers.ts +232 -232
- package/src/shared/operationLogger.ts +20 -20
- package/src/shared/operationQueue.ts +326 -327
- package/src/shared/operationsTable.ts +338 -338
- package/src/shared/operationsTableSchema.ts +60 -60
- package/src/shared/progressManager.ts +277 -277
- package/src/shared/relationshipExtractor.ts +214 -214
- package/src/shared/selectionDialogs.ts +775 -722
- package/src/storage/backupCompression.ts +88 -88
- package/src/storage/methods.ts +695 -682
- package/src/storage/schemas.ts +205 -205
- package/src/tables/indexManager.ts +408 -408
- package/src/types/node-appwrite-tablesdb.d.ts +43 -43
- package/src/types.ts +9 -9
- package/src/users/methods.ts +358 -359
- package/src/utils/configMigration.ts +347 -347
- package/src/utils/index.ts +2 -2
- package/src/utils/loadConfigs.ts +457 -449
- package/src/utils/setupFiles.ts +1236 -1238
- package/src/utilsController.ts +1263 -1213
- package/tests/README.md +496 -496
- package/tests/adapters/AdapterFactory.test.ts +276 -276
- package/tests/integration/syncOperations.test.ts +462 -462
- package/tests/jest.config.js +24 -24
- package/tests/migration/configMigration.test.ts +545 -545
- package/tests/setup.ts +61 -61
- package/tests/testUtils.ts +339 -339
- package/tests/utils/loadConfigs.test.ts +349 -349
- package/tests/validation/configValidation.test.ts +411 -411
- package/tsconfig.json +44 -44
- package/.appwrite/.yaml_schemas/appwrite-config.schema.json +0 -380
- package/.appwrite/.yaml_schemas/collection.schema.json +0 -255
- package/.appwrite/collections/Categories.yaml +0 -182
- package/.appwrite/collections/ExampleCollection.yaml +0 -36
- package/.appwrite/collections/Posts.yaml +0 -227
- package/.appwrite/collections/Users.yaml +0 -149
- package/.appwrite/config.yaml +0 -109
- package/.appwrite/import/README.md +0 -148
- package/.appwrite/import/categories-import.yaml +0 -129
- package/.appwrite/import/posts-import.yaml +0 -208
- package/.appwrite/import/users-import.yaml +0 -130
- package/.appwrite/importData/categories.json +0 -194
- package/.appwrite/importData/posts.json +0 -270
- package/.appwrite/importData/users.json +0 -220
- package/.appwrite/schemas/categories.json +0 -128
- package/.appwrite/schemas/exampleCollection.json +0 -52
- package/.appwrite/schemas/posts.json +0 -173
- package/.appwrite/schemas/users.json +0 -125
- package/dist/adapters/AdapterFactory.d.ts +0 -94
- package/dist/adapters/AdapterFactory.js +0 -420
- package/dist/adapters/DatabaseAdapter.d.ts +0 -243
- package/dist/adapters/DatabaseAdapter.js +0 -50
- package/dist/adapters/LegacyAdapter.d.ts +0 -50
- package/dist/adapters/LegacyAdapter.js +0 -615
- package/dist/adapters/TablesDBAdapter.d.ts +0 -45
- package/dist/adapters/TablesDBAdapter.js +0 -611
- package/dist/adapters/index.d.ts +0 -11
- package/dist/adapters/index.js +0 -12
- package/dist/backups/operations/bucketBackup.d.ts +0 -19
- package/dist/backups/operations/bucketBackup.js +0 -197
- package/dist/backups/operations/collectionBackup.d.ts +0 -30
- package/dist/backups/operations/collectionBackup.js +0 -201
- package/dist/backups/operations/comprehensiveBackup.d.ts +0 -25
- package/dist/backups/operations/comprehensiveBackup.js +0 -238
- package/dist/backups/schemas/bucketManifest.d.ts +0 -93
- package/dist/backups/schemas/bucketManifest.js +0 -33
- package/dist/backups/schemas/comprehensiveManifest.d.ts +0 -108
- package/dist/backups/schemas/comprehensiveManifest.js +0 -32
- package/dist/backups/tracking/centralizedTracking.d.ts +0 -34
- package/dist/backups/tracking/centralizedTracking.js +0 -274
- package/dist/cli/commands/configCommands.d.ts +0 -8
- package/dist/cli/commands/configCommands.js +0 -166
- package/dist/cli/commands/databaseCommands.d.ts +0 -14
- package/dist/cli/commands/databaseCommands.js +0 -644
- package/dist/cli/commands/functionCommands.d.ts +0 -7
- package/dist/cli/commands/functionCommands.js +0 -330
- package/dist/cli/commands/schemaCommands.d.ts +0 -7
- package/dist/cli/commands/schemaCommands.js +0 -169
- package/dist/cli/commands/storageCommands.d.ts +0 -5
- package/dist/cli/commands/storageCommands.js +0 -143
- package/dist/cli/commands/transferCommands.d.ts +0 -5
- package/dist/cli/commands/transferCommands.js +0 -384
- package/dist/collections/attributes.d.ts +0 -13
- package/dist/collections/attributes.js +0 -1333
- package/dist/collections/indexes.d.ts +0 -12
- package/dist/collections/indexes.js +0 -217
- package/dist/collections/methods.d.ts +0 -19
- package/dist/collections/methods.js +0 -587
- package/dist/collections/tableOperations.d.ts +0 -86
- package/dist/collections/tableOperations.js +0 -447
- package/dist/collections/transferOperations.d.ts +0 -8
- package/dist/collections/transferOperations.js +0 -412
- package/dist/collections/wipeOperations.d.ts +0 -16
- package/dist/collections/wipeOperations.js +0 -233
- package/dist/config/ConfigManager.d.ts +0 -450
- package/dist/config/ConfigManager.js +0 -650
- package/dist/config/configMigration.d.ts +0 -87
- package/dist/config/configMigration.js +0 -390
- package/dist/config/configValidation.d.ts +0 -66
- package/dist/config/configValidation.js +0 -358
- package/dist/config/index.d.ts +0 -8
- package/dist/config/index.js +0 -7
- package/dist/config/services/ConfigDiscoveryService.d.ts +0 -122
- package/dist/config/services/ConfigDiscoveryService.js +0 -322
- package/dist/config/services/ConfigLoaderService.d.ts +0 -129
- package/dist/config/services/ConfigLoaderService.js +0 -535
- package/dist/config/services/ConfigMergeService.d.ts +0 -208
- package/dist/config/services/ConfigMergeService.js +0 -308
- package/dist/config/services/ConfigValidationService.d.ts +0 -214
- package/dist/config/services/ConfigValidationService.js +0 -310
- package/dist/config/services/SessionAuthService.d.ts +0 -225
- package/dist/config/services/SessionAuthService.js +0 -456
- package/dist/config/services/__tests__/ConfigMergeService.test.d.ts +0 -1
- package/dist/config/services/__tests__/ConfigMergeService.test.js +0 -271
- package/dist/config/services/index.d.ts +0 -13
- package/dist/config/services/index.js +0 -10
- package/dist/config/yamlConfig.d.ts +0 -722
- package/dist/config/yamlConfig.js +0 -702
- package/dist/databases/methods.d.ts +0 -6
- package/dist/databases/methods.js +0 -35
- package/dist/databases/setup.d.ts +0 -5
- package/dist/databases/setup.js +0 -45
- package/dist/examples/yamlTerminologyExample.d.ts +0 -42
- package/dist/examples/yamlTerminologyExample.js +0 -272
- package/dist/functions/deployments.d.ts +0 -4
- package/dist/functions/deployments.js +0 -146
- package/dist/functions/fnConfigDiscovery.d.ts +0 -3
- package/dist/functions/fnConfigDiscovery.js +0 -108
- package/dist/functions/methods.d.ts +0 -16
- package/dist/functions/methods.js +0 -174
- package/dist/functions/pathResolution.d.ts +0 -37
- package/dist/functions/pathResolution.js +0 -185
- package/dist/functions/templates/count-docs-in-collection/README.md +0 -54
- package/dist/functions/templates/count-docs-in-collection/package.json +0 -25
- package/dist/functions/templates/count-docs-in-collection/src/main.ts +0 -159
- package/dist/functions/templates/count-docs-in-collection/src/request.ts +0 -9
- package/dist/functions/templates/count-docs-in-collection/tsconfig.json +0 -28
- package/dist/functions/templates/hono-typescript/README.md +0 -286
- package/dist/functions/templates/hono-typescript/package.json +0 -26
- package/dist/functions/templates/hono-typescript/src/adapters/request.ts +0 -74
- package/dist/functions/templates/hono-typescript/src/adapters/response.ts +0 -106
- package/dist/functions/templates/hono-typescript/src/app.ts +0 -180
- package/dist/functions/templates/hono-typescript/src/context.ts +0 -103
- package/dist/functions/templates/hono-typescript/src/index.ts +0 -54
- package/dist/functions/templates/hono-typescript/src/middleware/appwrite.ts +0 -119
- package/dist/functions/templates/hono-typescript/tsconfig.json +0 -20
- package/dist/functions/templates/typescript-node/README.md +0 -32
- package/dist/functions/templates/typescript-node/package.json +0 -25
- package/dist/functions/templates/typescript-node/src/context.ts +0 -103
- package/dist/functions/templates/typescript-node/src/index.ts +0 -29
- package/dist/functions/templates/typescript-node/tsconfig.json +0 -28
- package/dist/functions/templates/uv/README.md +0 -31
- package/dist/functions/templates/uv/pyproject.toml +0 -30
- package/dist/functions/templates/uv/src/__init__.py +0 -0
- package/dist/functions/templates/uv/src/context.py +0 -125
- package/dist/functions/templates/uv/src/index.py +0 -46
- package/dist/init.d.ts +0 -2
- package/dist/init.js +0 -57
- package/dist/interactiveCLI.d.ts +0 -31
- package/dist/interactiveCLI.js +0 -898
- package/dist/main.d.ts +0 -2
- package/dist/main.js +0 -1180
- package/dist/migrations/afterImportActions.d.ts +0 -17
- package/dist/migrations/afterImportActions.js +0 -306
- package/dist/migrations/appwriteToX.d.ts +0 -211
- package/dist/migrations/appwriteToX.js +0 -491
- package/dist/migrations/comprehensiveTransfer.d.ts +0 -147
- package/dist/migrations/comprehensiveTransfer.js +0 -1317
- package/dist/migrations/dataLoader.d.ts +0 -753
- package/dist/migrations/dataLoader.js +0 -1250
- package/dist/migrations/importController.d.ts +0 -23
- package/dist/migrations/importController.js +0 -268
- package/dist/migrations/importDataActions.d.ts +0 -50
- package/dist/migrations/importDataActions.js +0 -230
- package/dist/migrations/relationships.d.ts +0 -29
- package/dist/migrations/relationships.js +0 -204
- package/dist/migrations/services/DataTransformationService.d.ts +0 -55
- package/dist/migrations/services/DataTransformationService.js +0 -158
- package/dist/migrations/services/FileHandlerService.d.ts +0 -75
- package/dist/migrations/services/FileHandlerService.js +0 -236
- package/dist/migrations/services/ImportOrchestrator.d.ts +0 -97
- package/dist/migrations/services/ImportOrchestrator.js +0 -485
- package/dist/migrations/services/RateLimitManager.d.ts +0 -138
- package/dist/migrations/services/RateLimitManager.js +0 -279
- package/dist/migrations/services/RelationshipResolver.d.ts +0 -120
- package/dist/migrations/services/RelationshipResolver.js +0 -332
- package/dist/migrations/services/UserMappingService.d.ts +0 -109
- package/dist/migrations/services/UserMappingService.js +0 -277
- package/dist/migrations/services/ValidationService.d.ts +0 -74
- package/dist/migrations/services/ValidationService.js +0 -260
- package/dist/migrations/transfer.d.ts +0 -26
- package/dist/migrations/transfer.js +0 -608
- package/dist/migrations/yaml/YamlImportConfigLoader.d.ts +0 -131
- package/dist/migrations/yaml/YamlImportConfigLoader.js +0 -383
- package/dist/migrations/yaml/YamlImportIntegration.d.ts +0 -93
- package/dist/migrations/yaml/YamlImportIntegration.js +0 -341
- package/dist/migrations/yaml/generateImportSchemas.d.ts +0 -30
- package/dist/migrations/yaml/generateImportSchemas.js +0 -1327
- package/dist/schemas/authUser.d.ts +0 -24
- package/dist/schemas/authUser.js +0 -17
- package/dist/setup.d.ts +0 -2
- package/dist/setup.js +0 -5
- package/dist/setupCommands.d.ts +0 -58
- package/dist/setupCommands.js +0 -490
- package/dist/setupController.d.ts +0 -9
- package/dist/setupController.js +0 -34
- package/dist/shared/attributeMapper.d.ts +0 -20
- package/dist/shared/attributeMapper.js +0 -203
- package/dist/shared/backupMetadataSchema.d.ts +0 -94
- package/dist/shared/backupMetadataSchema.js +0 -38
- package/dist/shared/backupTracking.d.ts +0 -18
- package/dist/shared/backupTracking.js +0 -176
- package/dist/shared/confirmationDialogs.d.ts +0 -75
- package/dist/shared/confirmationDialogs.js +0 -236
- package/dist/shared/errorUtils.d.ts +0 -54
- package/dist/shared/errorUtils.js +0 -95
- package/dist/shared/functionManager.d.ts +0 -48
- package/dist/shared/functionManager.js +0 -348
- package/dist/shared/jsonSchemaGenerator.d.ts +0 -50
- package/dist/shared/jsonSchemaGenerator.js +0 -290
- package/dist/shared/logging.d.ts +0 -61
- package/dist/shared/logging.js +0 -116
- package/dist/shared/messageFormatter.d.ts +0 -39
- package/dist/shared/messageFormatter.js +0 -162
- package/dist/shared/migrationHelpers.d.ts +0 -61
- package/dist/shared/migrationHelpers.js +0 -145
- package/dist/shared/operationLogger.d.ts +0 -10
- package/dist/shared/operationLogger.js +0 -12
- package/dist/shared/operationQueue.d.ts +0 -40
- package/dist/shared/operationQueue.js +0 -311
- package/dist/shared/operationsTable.d.ts +0 -26
- package/dist/shared/operationsTable.js +0 -286
- package/dist/shared/operationsTableSchema.d.ts +0 -48
- package/dist/shared/operationsTableSchema.js +0 -35
- package/dist/shared/progressManager.d.ts +0 -62
- package/dist/shared/progressManager.js +0 -215
- package/dist/shared/pydanticModelGenerator.d.ts +0 -17
- package/dist/shared/pydanticModelGenerator.js +0 -615
- package/dist/shared/relationshipExtractor.d.ts +0 -56
- package/dist/shared/relationshipExtractor.js +0 -138
- package/dist/shared/schemaGenerator.d.ts +0 -40
- package/dist/shared/schemaGenerator.js +0 -556
- package/dist/shared/selectionDialogs.d.ts +0 -214
- package/dist/shared/selectionDialogs.js +0 -544
- package/dist/storage/backupCompression.d.ts +0 -20
- package/dist/storage/backupCompression.js +0 -67
- package/dist/storage/methods.d.ts +0 -32
- package/dist/storage/methods.js +0 -472
- package/dist/storage/schemas.d.ts +0 -842
- package/dist/storage/schemas.js +0 -175
- package/dist/tables/indexManager.d.ts +0 -65
- package/dist/tables/indexManager.js +0 -294
- package/dist/types.d.ts +0 -4
- package/dist/types.js +0 -3
- package/dist/users/methods.d.ts +0 -16
- package/dist/users/methods.js +0 -277
- package/dist/utils/ClientFactory.d.ts +0 -87
- package/dist/utils/ClientFactory.js +0 -212
- package/dist/utils/configDiscovery.d.ts +0 -78
- package/dist/utils/configDiscovery.js +0 -472
- package/dist/utils/configMigration.d.ts +0 -1
- package/dist/utils/configMigration.js +0 -261
- package/dist/utils/constantsGenerator.d.ts +0 -31
- package/dist/utils/constantsGenerator.js +0 -321
- package/dist/utils/dataConverters.d.ts +0 -46
- package/dist/utils/dataConverters.js +0 -139
- package/dist/utils/directoryUtils.d.ts +0 -22
- package/dist/utils/directoryUtils.js +0 -59
- package/dist/utils/getClientFromConfig.d.ts +0 -39
- package/dist/utils/getClientFromConfig.js +0 -199
- package/dist/utils/helperFunctions.d.ts +0 -63
- package/dist/utils/helperFunctions.js +0 -156
- package/dist/utils/index.d.ts +0 -2
- package/dist/utils/index.js +0 -2
- package/dist/utils/loadConfigs.d.ts +0 -50
- package/dist/utils/loadConfigs.js +0 -358
- package/dist/utils/pathResolvers.d.ts +0 -53
- package/dist/utils/pathResolvers.js +0 -72
- package/dist/utils/projectConfig.d.ts +0 -122
- package/dist/utils/projectConfig.js +0 -206
- package/dist/utils/retryFailedPromises.d.ts +0 -2
- package/dist/utils/retryFailedPromises.js +0 -23
- package/dist/utils/sessionAuth.d.ts +0 -48
- package/dist/utils/sessionAuth.js +0 -164
- package/dist/utils/setupFiles.d.ts +0 -4
- package/dist/utils/setupFiles.js +0 -1192
- package/dist/utils/typeGuards.d.ts +0 -35
- package/dist/utils/typeGuards.js +0 -57
- package/dist/utils/validationRules.d.ts +0 -43
- package/dist/utils/validationRules.js +0 -42
- package/dist/utils/versionDetection.d.ts +0 -58
- package/dist/utils/versionDetection.js +0 -251
- package/dist/utils/yamlConverter.d.ts +0 -100
- package/dist/utils/yamlConverter.js +0 -428
- package/dist/utils/yamlLoader.d.ts +0 -70
- package/dist/utils/yamlLoader.js +0 -267
- package/dist/utilsController.d.ts +0 -107
- package/dist/utilsController.js +0 -873
- package/src/adapters/AdapterFactory.ts +0 -529
- package/src/adapters/DatabaseAdapter.ts +0 -319
- package/src/adapters/LegacyAdapter.ts +0 -844
- package/src/adapters/TablesDBAdapter.ts +0 -823
- package/src/config/ConfigManager.ts +0 -849
- package/src/config/README.md +0 -274
- package/src/config/configMigration.ts +0 -575
- package/src/config/configValidation.ts +0 -445
- package/src/config/index.ts +0 -10
- package/src/config/services/ConfigDiscoveryService.ts +0 -410
- package/src/config/services/ConfigLoaderService.ts +0 -732
- package/src/config/services/ConfigMergeService.ts +0 -388
- package/src/config/services/ConfigValidationService.ts +0 -394
- package/src/config/services/SessionAuthService.ts +0 -565
- package/src/config/services/__tests__/ConfigMergeService.test.ts +0 -351
- package/src/config/services/index.ts +0 -29
- package/src/config/yamlConfig.ts +0 -761
- package/src/functions/pathResolution.ts +0 -227
- package/src/functions/templates/count-docs-in-collection/package.json +0 -25
- package/src/functions/templates/count-docs-in-collection/tsconfig.json +0 -28
- package/src/functions/templates/hono-typescript/package.json +0 -26
- package/src/functions/templates/hono-typescript/tsconfig.json +0 -20
- package/src/functions/templates/typescript-node/package.json +0 -25
- package/src/functions/templates/typescript-node/tsconfig.json +0 -28
- package/src/shared/attributeMapper.ts +0 -229
- package/src/shared/errorUtils.ts +0 -110
- package/src/shared/functionManager.ts +0 -537
- package/src/shared/jsonSchemaGenerator.ts +0 -383
- package/src/shared/logging.ts +0 -149
- package/src/shared/messageFormatter.ts +0 -208
- package/src/shared/pydanticModelGenerator.ts +0 -618
- package/src/shared/schemaGenerator.ts +0 -644
- package/src/utils/ClientFactory.ts +0 -240
- package/src/utils/configDiscovery.ts +0 -557
- package/src/utils/constantsGenerator.ts +0 -369
- package/src/utils/dataConverters.ts +0 -159
- package/src/utils/directoryUtils.ts +0 -61
- package/src/utils/getClientFromConfig.ts +0 -257
- package/src/utils/helperFunctions.ts +0 -228
- package/src/utils/pathResolvers.ts +0 -81
- package/src/utils/projectConfig.ts +0 -340
- package/src/utils/retryFailedPromises.ts +0 -29
- package/src/utils/sessionAuth.ts +0 -230
- package/src/utils/typeGuards.ts +0 -65
- package/src/utils/validationRules.ts +0 -88
- package/src/utils/versionDetection.ts +0 -292
- package/src/utils/yamlConverter.ts +0 -542
- package/src/utils/yamlLoader.ts +0 -371
- package/tmp-sync-test/.appwrite/collections/TestCollection.yaml +0 -7
|
@@ -1,348 +0,0 @@
|
|
|
1
|
-
import { Client, Functions, Runtime } from "node-appwrite";
|
|
2
|
-
import { EventTypeSchema } from "appwrite-utils";
|
|
3
|
-
import { join, relative, resolve, basename } from "node:path";
|
|
4
|
-
import fs from "node:fs";
|
|
5
|
-
import chalk from "chalk";
|
|
6
|
-
import pLimit from "p-limit";
|
|
7
|
-
import { tryAwaitWithRetry } from "../utils/helperFunctions.js";
|
|
8
|
-
import { MessageFormatter } from "./messageFormatter.js";
|
|
9
|
-
/**
|
|
10
|
-
* Validates and filters events array for Appwrite functions
|
|
11
|
-
* - Filters out empty/invalid strings
|
|
12
|
-
* - Validates against EventTypeSchema
|
|
13
|
-
* - Limits to 100 items maximum (Appwrite limit)
|
|
14
|
-
* - Returns empty array if input is invalid
|
|
15
|
-
*/
|
|
16
|
-
const validateEvents = (events) => {
|
|
17
|
-
if (!events || !Array.isArray(events))
|
|
18
|
-
return [];
|
|
19
|
-
return events
|
|
20
|
-
.filter(event => {
|
|
21
|
-
if (!event || typeof event !== 'string' || event.trim().length === 0) {
|
|
22
|
-
return false;
|
|
23
|
-
}
|
|
24
|
-
// Validate against EventTypeSchema
|
|
25
|
-
const result = EventTypeSchema.safeParse(event);
|
|
26
|
-
if (!result.success) {
|
|
27
|
-
MessageFormatter.warning(`Invalid event type "${event}" will be filtered out`, { prefix: "Functions" });
|
|
28
|
-
return false;
|
|
29
|
-
}
|
|
30
|
-
return true;
|
|
31
|
-
})
|
|
32
|
-
.slice(0, 100);
|
|
33
|
-
};
|
|
34
|
-
// Concurrency limits
|
|
35
|
-
const functionLimit = pLimit(5); // Moderate limit for function operations
|
|
36
|
-
const queryLimit = pLimit(25); // Higher limit for read operations
|
|
37
|
-
export class FunctionManager {
|
|
38
|
-
client;
|
|
39
|
-
functions;
|
|
40
|
-
constructor(client) {
|
|
41
|
-
this.client = client;
|
|
42
|
-
this.functions = new Functions(client);
|
|
43
|
-
}
|
|
44
|
-
/**
|
|
45
|
-
* Improved function directory detection with multiple strategies
|
|
46
|
-
*/
|
|
47
|
-
async findFunctionDirectory(functionName, options = {}) {
|
|
48
|
-
const { searchPaths = [process.cwd()], caseSensitive = false, allowFuzzyMatch = true, verbose = false } = options;
|
|
49
|
-
if (verbose) {
|
|
50
|
-
MessageFormatter.info(`Searching for function: ${functionName}`, { prefix: "Functions" });
|
|
51
|
-
}
|
|
52
|
-
// Normalize function name for comparison
|
|
53
|
-
const normalizedName = caseSensitive ? functionName : functionName.toLowerCase();
|
|
54
|
-
const nameVariations = this.generateNameVariations(normalizedName);
|
|
55
|
-
// Strategy 1: Check standard locations first
|
|
56
|
-
const standardPaths = this.getStandardFunctionPaths(searchPaths, functionName);
|
|
57
|
-
for (const path of standardPaths) {
|
|
58
|
-
if (await this.isValidFunctionDirectory(path)) {
|
|
59
|
-
if (verbose) {
|
|
60
|
-
MessageFormatter.success(`Found function at standard location: ${path}`, { prefix: "Functions" });
|
|
61
|
-
}
|
|
62
|
-
return path;
|
|
63
|
-
}
|
|
64
|
-
}
|
|
65
|
-
// Strategy 2: Recursive directory search with fuzzy matching
|
|
66
|
-
if (allowFuzzyMatch) {
|
|
67
|
-
for (const searchPath of searchPaths) {
|
|
68
|
-
const foundPath = await this.recursiveDirectorySearch(searchPath, nameVariations, { caseSensitive, verbose });
|
|
69
|
-
if (foundPath) {
|
|
70
|
-
if (verbose) {
|
|
71
|
-
MessageFormatter.success(`Found function via fuzzy search: ${foundPath}`, { prefix: "Functions" });
|
|
72
|
-
}
|
|
73
|
-
return foundPath;
|
|
74
|
-
}
|
|
75
|
-
}
|
|
76
|
-
}
|
|
77
|
-
if (verbose) {
|
|
78
|
-
MessageFormatter.warning(`Function directory not found: ${functionName}`, { prefix: "Functions" });
|
|
79
|
-
}
|
|
80
|
-
return null;
|
|
81
|
-
}
|
|
82
|
-
generateNameVariations(name) {
|
|
83
|
-
const variations = new Set([
|
|
84
|
-
name,
|
|
85
|
-
name.toLowerCase(),
|
|
86
|
-
name.replace(/\s+/g, "-"),
|
|
87
|
-
name.replace(/\s+/g, "_"),
|
|
88
|
-
name.replace(/[^a-z0-9]/gi, ""),
|
|
89
|
-
name.replace(/[-_\s]+/g, ""),
|
|
90
|
-
name.replace(/[-_\s]+/g, "-").toLowerCase(),
|
|
91
|
-
name.replace(/[-_\s]+/g, "_").toLowerCase(),
|
|
92
|
-
]);
|
|
93
|
-
return variations;
|
|
94
|
-
}
|
|
95
|
-
getStandardFunctionPaths(searchPaths, functionName) {
|
|
96
|
-
const normalizedName = functionName.toLowerCase().replace(/\s+/g, "-");
|
|
97
|
-
const paths = [];
|
|
98
|
-
for (const basePath of searchPaths) {
|
|
99
|
-
paths.push(join(basePath, "functions", functionName), join(basePath, "functions", normalizedName), join(basePath, "src", "functions", functionName), join(basePath, "src", "functions", normalizedName), join(basePath, functionName), join(basePath, normalizedName), join(basePath, "appwrite", "functions", functionName), join(basePath, "appwrite", "functions", normalizedName));
|
|
100
|
-
}
|
|
101
|
-
return paths;
|
|
102
|
-
}
|
|
103
|
-
async recursiveDirectorySearch(searchPath, nameVariations, options) {
|
|
104
|
-
const { caseSensitive, verbose } = options;
|
|
105
|
-
try {
|
|
106
|
-
const stats = await fs.promises.stat(searchPath);
|
|
107
|
-
if (!stats.isDirectory())
|
|
108
|
-
return null;
|
|
109
|
-
const entries = await fs.promises.readdir(searchPath, { withFileTypes: true });
|
|
110
|
-
for (const entry of entries) {
|
|
111
|
-
if (!entry.isDirectory())
|
|
112
|
-
continue;
|
|
113
|
-
// Skip common directories that won't contain functions
|
|
114
|
-
if (this.shouldSkipDirectory(entry.name))
|
|
115
|
-
continue;
|
|
116
|
-
const entryPath = join(searchPath, entry.name);
|
|
117
|
-
// Check if this directory matches our function name
|
|
118
|
-
const entryNameToCheck = caseSensitive ? entry.name : entry.name.toLowerCase();
|
|
119
|
-
if (nameVariations.has(entryNameToCheck)) {
|
|
120
|
-
if (await this.isValidFunctionDirectory(entryPath)) {
|
|
121
|
-
return entryPath;
|
|
122
|
-
}
|
|
123
|
-
}
|
|
124
|
-
// Recursively search subdirectories
|
|
125
|
-
const result = await this.recursiveDirectorySearch(entryPath, nameVariations, options);
|
|
126
|
-
if (result)
|
|
127
|
-
return result;
|
|
128
|
-
}
|
|
129
|
-
}
|
|
130
|
-
catch (error) {
|
|
131
|
-
if (verbose) {
|
|
132
|
-
MessageFormatter.debug(`Skipping inaccessible directory: ${searchPath}`, undefined, { prefix: "Functions" });
|
|
133
|
-
}
|
|
134
|
-
}
|
|
135
|
-
return null;
|
|
136
|
-
}
|
|
137
|
-
shouldSkipDirectory(dirName) {
|
|
138
|
-
const skipDirs = new Set([
|
|
139
|
-
'node_modules',
|
|
140
|
-
'.git',
|
|
141
|
-
'.vscode',
|
|
142
|
-
'.idea',
|
|
143
|
-
'dist',
|
|
144
|
-
'build',
|
|
145
|
-
'coverage',
|
|
146
|
-
'.nyc_output',
|
|
147
|
-
'tmp',
|
|
148
|
-
'temp',
|
|
149
|
-
'.cache',
|
|
150
|
-
'__pycache__',
|
|
151
|
-
'.pytest_cache',
|
|
152
|
-
'venv',
|
|
153
|
-
'.venv',
|
|
154
|
-
'env',
|
|
155
|
-
'.env'
|
|
156
|
-
]);
|
|
157
|
-
return skipDirs.has(dirName) || dirName.startsWith('.');
|
|
158
|
-
}
|
|
159
|
-
async isValidFunctionDirectory(path) {
|
|
160
|
-
try {
|
|
161
|
-
const stats = await fs.promises.stat(path);
|
|
162
|
-
if (!stats.isDirectory())
|
|
163
|
-
return false;
|
|
164
|
-
const files = await fs.promises.readdir(path);
|
|
165
|
-
// Check for common function indicators
|
|
166
|
-
const hasPackageJson = files.includes('package.json');
|
|
167
|
-
const hasMainFile = files.some(file => file.match(/^(index|main|app)\.(js|ts|py)$/i) ||
|
|
168
|
-
file === 'src' ||
|
|
169
|
-
file === 'lib');
|
|
170
|
-
const hasRequirements = files.includes('requirements.txt');
|
|
171
|
-
const hasPyProject = files.includes('pyproject.toml');
|
|
172
|
-
return hasPackageJson || hasMainFile || hasRequirements || hasPyProject;
|
|
173
|
-
}
|
|
174
|
-
catch {
|
|
175
|
-
return false;
|
|
176
|
-
}
|
|
177
|
-
}
|
|
178
|
-
/**
|
|
179
|
-
* Enhanced function deployment with better error handling and validation
|
|
180
|
-
*/
|
|
181
|
-
async deployFunction(functionConfig, functionPath, options = {}) {
|
|
182
|
-
const { activate = true, entrypoint = functionConfig.entrypoint || "index.js", commands = functionConfig.commands || "npm install", ignored = ["node_modules", ".git", ".vscode", ".DS_Store", "__pycache__", ".venv"], verbose = false, forceRedeploy = false } = options;
|
|
183
|
-
return await functionLimit(async () => {
|
|
184
|
-
if (verbose) {
|
|
185
|
-
MessageFormatter.processing(`Deploying function: ${functionConfig.name}`, { prefix: "Functions" });
|
|
186
|
-
MessageFormatter.debug(`Path: ${functionPath}`, undefined, { prefix: "Functions" });
|
|
187
|
-
MessageFormatter.debug(`Entrypoint: ${entrypoint}`, undefined, { prefix: "Functions" });
|
|
188
|
-
}
|
|
189
|
-
// Validate function directory
|
|
190
|
-
if (!await this.isValidFunctionDirectory(functionPath)) {
|
|
191
|
-
throw new Error(`Invalid function directory: ${functionPath}`);
|
|
192
|
-
}
|
|
193
|
-
// Ensure function exists
|
|
194
|
-
let functionExists = false;
|
|
195
|
-
try {
|
|
196
|
-
await this.getFunction(functionConfig.$id);
|
|
197
|
-
functionExists = true;
|
|
198
|
-
}
|
|
199
|
-
catch (error) {
|
|
200
|
-
if (verbose) {
|
|
201
|
-
MessageFormatter.info(`Function ${functionConfig.$id} does not exist, creating...`, { prefix: "Functions" });
|
|
202
|
-
}
|
|
203
|
-
}
|
|
204
|
-
// Create function if it doesn't exist
|
|
205
|
-
if (!functionExists) {
|
|
206
|
-
await this.createFunction(functionConfig, { verbose });
|
|
207
|
-
}
|
|
208
|
-
else if (forceRedeploy) {
|
|
209
|
-
await this.updateFunction(functionConfig, { verbose });
|
|
210
|
-
}
|
|
211
|
-
// Execute pre-deploy commands if specified
|
|
212
|
-
if (functionConfig.predeployCommands?.length) {
|
|
213
|
-
await this.executePredeployCommands(functionConfig.predeployCommands, functionPath, { verbose });
|
|
214
|
-
}
|
|
215
|
-
// Deploy the function
|
|
216
|
-
const deployment = await this.createDeployment(functionConfig.$id, functionPath, { activate, entrypoint, commands, ignored, verbose });
|
|
217
|
-
if (verbose) {
|
|
218
|
-
MessageFormatter.success(`Function ${functionConfig.name} deployed successfully`, { prefix: "Functions" });
|
|
219
|
-
}
|
|
220
|
-
return deployment;
|
|
221
|
-
});
|
|
222
|
-
}
|
|
223
|
-
async createFunction(functionConfig, options = {}) {
|
|
224
|
-
const { verbose = false } = options;
|
|
225
|
-
if (verbose) {
|
|
226
|
-
MessageFormatter.processing(`Creating function: ${functionConfig.name}`, { prefix: "Functions" });
|
|
227
|
-
}
|
|
228
|
-
return await tryAwaitWithRetry(async () => {
|
|
229
|
-
return await this.functions.create(functionConfig.$id, functionConfig.name, functionConfig.runtime, functionConfig.execute || [], functionConfig.events || [], functionConfig.schedule || "", functionConfig.timeout || 15, functionConfig.enabled !== false, functionConfig.logging !== false, functionConfig.entrypoint, functionConfig.commands, functionConfig.scopes || [], functionConfig.installationId, functionConfig.providerRepositoryId, functionConfig.providerBranch, functionConfig.providerSilentMode, functionConfig.providerRootDirectory);
|
|
230
|
-
});
|
|
231
|
-
}
|
|
232
|
-
async updateFunction(functionConfig, options = {}) {
|
|
233
|
-
const { verbose = false } = options;
|
|
234
|
-
if (verbose) {
|
|
235
|
-
MessageFormatter.processing(`Updating function: ${functionConfig.name}`, { prefix: "Functions" });
|
|
236
|
-
}
|
|
237
|
-
return await tryAwaitWithRetry(async () => {
|
|
238
|
-
return await this.functions.update(functionConfig.$id, functionConfig.name, functionConfig.runtime, functionConfig.execute || [], functionConfig.events || [], functionConfig.schedule || "", functionConfig.timeout || 15, functionConfig.enabled !== false, functionConfig.logging !== false, functionConfig.entrypoint, functionConfig.commands, functionConfig.scopes || [], functionConfig.installationId, functionConfig.providerRepositoryId, functionConfig.providerBranch, functionConfig.providerSilentMode, functionConfig.providerRootDirectory, functionConfig.specification);
|
|
239
|
-
});
|
|
240
|
-
}
|
|
241
|
-
async executePredeployCommands(commands, workingDir, options = {}) {
|
|
242
|
-
const { verbose = false } = options;
|
|
243
|
-
const { execSync } = await import("child_process");
|
|
244
|
-
const { platform } = await import("node:os");
|
|
245
|
-
if (verbose) {
|
|
246
|
-
MessageFormatter.processing("Executing pre-deploy commands...", { prefix: "Functions" });
|
|
247
|
-
}
|
|
248
|
-
const isWindows = platform() === "win32";
|
|
249
|
-
for (const command of commands) {
|
|
250
|
-
if (verbose) {
|
|
251
|
-
MessageFormatter.debug(`$ ${command}`, undefined, { prefix: "Functions" });
|
|
252
|
-
}
|
|
253
|
-
try {
|
|
254
|
-
execSync(command, {
|
|
255
|
-
cwd: workingDir,
|
|
256
|
-
stdio: verbose ? "inherit" : "pipe",
|
|
257
|
-
shell: isWindows ? "cmd.exe" : "/bin/sh",
|
|
258
|
-
windowsHide: true,
|
|
259
|
-
});
|
|
260
|
-
}
|
|
261
|
-
catch (error) {
|
|
262
|
-
MessageFormatter.error(`Failed to execute command: ${command}`, error, { prefix: "Functions" });
|
|
263
|
-
throw error;
|
|
264
|
-
}
|
|
265
|
-
}
|
|
266
|
-
if (verbose) {
|
|
267
|
-
MessageFormatter.success("Pre-deploy commands completed", { prefix: "Functions" });
|
|
268
|
-
}
|
|
269
|
-
}
|
|
270
|
-
async createDeployment(functionId, codePath, options = {}) {
|
|
271
|
-
const { activate = true, entrypoint = "index.js", commands = "npm install", ignored = [], verbose = false } = options;
|
|
272
|
-
const { InputFile } = await import("node-appwrite/file");
|
|
273
|
-
const { create: createTarball } = await import("tar");
|
|
274
|
-
const tarPath = join(process.cwd(), `function-${functionId}-${Date.now()}.tar.gz`);
|
|
275
|
-
try {
|
|
276
|
-
if (verbose) {
|
|
277
|
-
MessageFormatter.processing("Creating deployment archive...", { prefix: "Functions" });
|
|
278
|
-
}
|
|
279
|
-
// Create tarball
|
|
280
|
-
await createTarball({
|
|
281
|
-
gzip: true,
|
|
282
|
-
file: tarPath,
|
|
283
|
-
cwd: codePath,
|
|
284
|
-
filter: (path) => {
|
|
285
|
-
const relativePath = relative(codePath, join(codePath, path)).toLowerCase();
|
|
286
|
-
const shouldIgnore = ignored.some(pattern => relativePath.startsWith(pattern.toLowerCase()) ||
|
|
287
|
-
relativePath.includes(`/${pattern.toLowerCase()}`) ||
|
|
288
|
-
relativePath.includes(`\\${pattern.toLowerCase()}`));
|
|
289
|
-
if (shouldIgnore && verbose) {
|
|
290
|
-
MessageFormatter.debug(`Ignoring: ${path}`, undefined, { prefix: "Functions" });
|
|
291
|
-
}
|
|
292
|
-
return !shouldIgnore;
|
|
293
|
-
},
|
|
294
|
-
}, ["."]);
|
|
295
|
-
// Read and upload
|
|
296
|
-
const fileBuffer = await fs.promises.readFile(tarPath);
|
|
297
|
-
const fileObject = InputFile.fromBuffer(new Uint8Array(fileBuffer), `function-${functionId}.tar.gz`);
|
|
298
|
-
if (verbose) {
|
|
299
|
-
MessageFormatter.processing("Uploading deployment...", { prefix: "Functions" });
|
|
300
|
-
}
|
|
301
|
-
const deployment = await tryAwaitWithRetry(async () => {
|
|
302
|
-
return await this.functions.createDeployment(functionId, fileObject, activate, entrypoint, commands);
|
|
303
|
-
});
|
|
304
|
-
return deployment;
|
|
305
|
-
}
|
|
306
|
-
finally {
|
|
307
|
-
// Clean up tarball
|
|
308
|
-
try {
|
|
309
|
-
await fs.promises.unlink(tarPath);
|
|
310
|
-
}
|
|
311
|
-
catch {
|
|
312
|
-
// Ignore cleanup errors
|
|
313
|
-
}
|
|
314
|
-
}
|
|
315
|
-
}
|
|
316
|
-
async getFunction(functionId) {
|
|
317
|
-
return await queryLimit(() => tryAwaitWithRetry(async () => await this.functions.get(functionId)));
|
|
318
|
-
}
|
|
319
|
-
async listFunctions() {
|
|
320
|
-
return await queryLimit(() => tryAwaitWithRetry(async () => await this.functions.list()));
|
|
321
|
-
}
|
|
322
|
-
async deleteFunction(functionId) {
|
|
323
|
-
await functionLimit(() => tryAwaitWithRetry(async () => await this.functions.delete(functionId)));
|
|
324
|
-
}
|
|
325
|
-
/**
|
|
326
|
-
* Validate function configuration
|
|
327
|
-
*/
|
|
328
|
-
validateFunctionConfig(functionConfig) {
|
|
329
|
-
const errors = [];
|
|
330
|
-
if (!functionConfig.$id) {
|
|
331
|
-
errors.push("Function ID is required");
|
|
332
|
-
}
|
|
333
|
-
if (!functionConfig.name) {
|
|
334
|
-
errors.push("Function name is required");
|
|
335
|
-
}
|
|
336
|
-
if (!functionConfig.runtime) {
|
|
337
|
-
errors.push("Function runtime is required");
|
|
338
|
-
}
|
|
339
|
-
if (!functionConfig.entrypoint) {
|
|
340
|
-
errors.push("Function entrypoint is required");
|
|
341
|
-
}
|
|
342
|
-
// Validate timeout
|
|
343
|
-
if (functionConfig.timeout && (functionConfig.timeout < 1 || functionConfig.timeout > 900)) {
|
|
344
|
-
errors.push("Function timeout must be between 1 and 900 seconds");
|
|
345
|
-
}
|
|
346
|
-
return { valid: errors.length === 0, errors };
|
|
347
|
-
}
|
|
348
|
-
}
|
|
@@ -1,50 +0,0 @@
|
|
|
1
|
-
import type { AppwriteConfig } from "appwrite-utils";
|
|
2
|
-
export interface JsonSchemaProperty {
|
|
3
|
-
type: string | string[];
|
|
4
|
-
format?: string;
|
|
5
|
-
minimum?: number;
|
|
6
|
-
maximum?: number;
|
|
7
|
-
minLength?: number;
|
|
8
|
-
maxLength?: number;
|
|
9
|
-
pattern?: string;
|
|
10
|
-
enum?: any[];
|
|
11
|
-
items?: JsonSchemaProperty;
|
|
12
|
-
$ref?: string;
|
|
13
|
-
properties?: Record<string, JsonSchemaProperty>;
|
|
14
|
-
additionalProperties?: boolean;
|
|
15
|
-
required?: string[];
|
|
16
|
-
default?: any;
|
|
17
|
-
oneOf?: JsonSchemaProperty[];
|
|
18
|
-
}
|
|
19
|
-
export interface JsonSchema {
|
|
20
|
-
$schema: string;
|
|
21
|
-
$id: string;
|
|
22
|
-
title: string;
|
|
23
|
-
type: "object";
|
|
24
|
-
properties: Record<string, JsonSchemaProperty>;
|
|
25
|
-
required: string[];
|
|
26
|
-
additionalProperties: boolean;
|
|
27
|
-
definitions?: Record<string, JsonSchemaProperty>;
|
|
28
|
-
}
|
|
29
|
-
export declare class JsonSchemaGenerator {
|
|
30
|
-
private config;
|
|
31
|
-
private appwriteFolderPath;
|
|
32
|
-
private relationshipMap;
|
|
33
|
-
constructor(config: AppwriteConfig, appwriteFolderPath: string);
|
|
34
|
-
private resolveCollectionName;
|
|
35
|
-
private extractRelationships;
|
|
36
|
-
private attributeToJsonSchemaProperty;
|
|
37
|
-
private getBaseTypeSchema;
|
|
38
|
-
private createJsonSchema;
|
|
39
|
-
generateJsonSchemas(options?: {
|
|
40
|
-
outputFormat?: "json" | "typescript" | "both";
|
|
41
|
-
outputDirectory?: string;
|
|
42
|
-
verbose?: boolean;
|
|
43
|
-
}): void;
|
|
44
|
-
private generateTypeScriptSchema;
|
|
45
|
-
private generateIndexFile;
|
|
46
|
-
validateSchema(schema: JsonSchema): {
|
|
47
|
-
valid: boolean;
|
|
48
|
-
errors: string[];
|
|
49
|
-
};
|
|
50
|
-
}
|
|
@@ -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
|
-
}
|