@njdamstra/appwrite-utils-cli 1.8.9
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/CHANGELOG.md +19 -0
- package/README.md +1133 -0
- package/dist/adapters/AdapterFactory.d.ts +94 -0
- package/dist/adapters/AdapterFactory.js +405 -0
- package/dist/adapters/DatabaseAdapter.d.ts +233 -0
- package/dist/adapters/DatabaseAdapter.js +50 -0
- package/dist/adapters/LegacyAdapter.d.ts +50 -0
- package/dist/adapters/LegacyAdapter.js +612 -0
- package/dist/adapters/TablesDBAdapter.d.ts +45 -0
- package/dist/adapters/TablesDBAdapter.js +571 -0
- package/dist/adapters/index.d.ts +11 -0
- package/dist/adapters/index.js +12 -0
- package/dist/backups/operations/bucketBackup.d.ts +19 -0
- package/dist/backups/operations/bucketBackup.js +197 -0
- package/dist/backups/operations/collectionBackup.d.ts +30 -0
- package/dist/backups/operations/collectionBackup.js +201 -0
- package/dist/backups/operations/comprehensiveBackup.d.ts +25 -0
- package/dist/backups/operations/comprehensiveBackup.js +238 -0
- package/dist/backups/schemas/bucketManifest.d.ts +93 -0
- package/dist/backups/schemas/bucketManifest.js +33 -0
- package/dist/backups/schemas/comprehensiveManifest.d.ts +108 -0
- package/dist/backups/schemas/comprehensiveManifest.js +32 -0
- package/dist/backups/tracking/centralizedTracking.d.ts +34 -0
- package/dist/backups/tracking/centralizedTracking.js +274 -0
- package/dist/cli/commands/configCommands.d.ts +8 -0
- package/dist/cli/commands/configCommands.js +166 -0
- package/dist/cli/commands/databaseCommands.d.ts +13 -0
- package/dist/cli/commands/databaseCommands.js +554 -0
- package/dist/cli/commands/functionCommands.d.ts +7 -0
- package/dist/cli/commands/functionCommands.js +330 -0
- package/dist/cli/commands/schemaCommands.d.ts +7 -0
- package/dist/cli/commands/schemaCommands.js +169 -0
- package/dist/cli/commands/storageCommands.d.ts +5 -0
- package/dist/cli/commands/storageCommands.js +143 -0
- package/dist/cli/commands/transferCommands.d.ts +5 -0
- package/dist/cli/commands/transferCommands.js +384 -0
- package/dist/collections/attributes.d.ts +13 -0
- package/dist/collections/attributes.js +1364 -0
- package/dist/collections/indexes.d.ts +12 -0
- package/dist/collections/indexes.js +217 -0
- package/dist/collections/methods.d.ts +19 -0
- package/dist/collections/methods.js +682 -0
- package/dist/collections/tableOperations.d.ts +86 -0
- package/dist/collections/tableOperations.js +434 -0
- package/dist/collections/transferOperations.d.ts +8 -0
- package/dist/collections/transferOperations.js +412 -0
- package/dist/collections/wipeOperations.d.ts +16 -0
- package/dist/collections/wipeOperations.js +233 -0
- package/dist/config/ConfigManager.d.ts +445 -0
- package/dist/config/ConfigManager.js +625 -0
- package/dist/config/configMigration.d.ts +87 -0
- package/dist/config/configMigration.js +390 -0
- package/dist/config/configValidation.d.ts +66 -0
- package/dist/config/configValidation.js +358 -0
- package/dist/config/index.d.ts +8 -0
- package/dist/config/index.js +7 -0
- package/dist/config/services/ConfigDiscoveryService.d.ts +126 -0
- package/dist/config/services/ConfigDiscoveryService.js +374 -0
- package/dist/config/services/ConfigLoaderService.d.ts +129 -0
- package/dist/config/services/ConfigLoaderService.js +540 -0
- package/dist/config/services/ConfigMergeService.d.ts +208 -0
- package/dist/config/services/ConfigMergeService.js +308 -0
- package/dist/config/services/ConfigValidationService.d.ts +214 -0
- package/dist/config/services/ConfigValidationService.js +310 -0
- package/dist/config/services/SessionAuthService.d.ts +225 -0
- package/dist/config/services/SessionAuthService.js +456 -0
- package/dist/config/services/__tests__/ConfigMergeService.test.d.ts +1 -0
- package/dist/config/services/__tests__/ConfigMergeService.test.js +271 -0
- package/dist/config/services/index.d.ts +13 -0
- package/dist/config/services/index.js +10 -0
- package/dist/config/yamlConfig.d.ts +722 -0
- package/dist/config/yamlConfig.js +702 -0
- package/dist/databases/methods.d.ts +6 -0
- package/dist/databases/methods.js +35 -0
- package/dist/databases/setup.d.ts +5 -0
- package/dist/databases/setup.js +45 -0
- package/dist/examples/yamlTerminologyExample.d.ts +42 -0
- package/dist/examples/yamlTerminologyExample.js +272 -0
- package/dist/functions/deployments.d.ts +4 -0
- package/dist/functions/deployments.js +146 -0
- package/dist/functions/fnConfigDiscovery.d.ts +3 -0
- package/dist/functions/fnConfigDiscovery.js +108 -0
- package/dist/functions/methods.d.ts +16 -0
- package/dist/functions/methods.js +162 -0
- package/dist/functions/pathResolution.d.ts +37 -0
- package/dist/functions/pathResolution.js +185 -0
- package/dist/functions/templates/count-docs-in-collection/README.md +54 -0
- package/dist/functions/templates/count-docs-in-collection/src/main.ts +159 -0
- package/dist/functions/templates/count-docs-in-collection/src/request.ts +9 -0
- package/dist/functions/templates/hono-typescript/README.md +286 -0
- package/dist/functions/templates/hono-typescript/src/adapters/request.ts +74 -0
- package/dist/functions/templates/hono-typescript/src/adapters/response.ts +106 -0
- package/dist/functions/templates/hono-typescript/src/app.ts +180 -0
- package/dist/functions/templates/hono-typescript/src/context.ts +103 -0
- package/dist/functions/templates/hono-typescript/src/index.ts +54 -0
- package/dist/functions/templates/hono-typescript/src/middleware/appwrite.ts +119 -0
- package/dist/functions/templates/typescript-node/README.md +32 -0
- package/dist/functions/templates/typescript-node/src/context.ts +103 -0
- package/dist/functions/templates/typescript-node/src/index.ts +29 -0
- package/dist/functions/templates/uv/README.md +31 -0
- package/dist/functions/templates/uv/pyproject.toml +30 -0
- package/dist/functions/templates/uv/src/__init__.py +0 -0
- package/dist/functions/templates/uv/src/context.py +125 -0
- package/dist/functions/templates/uv/src/index.py +46 -0
- package/dist/init.d.ts +2 -0
- package/dist/init.js +57 -0
- package/dist/interactiveCLI.d.ts +31 -0
- package/dist/interactiveCLI.js +898 -0
- package/dist/main.d.ts +2 -0
- package/dist/main.js +1172 -0
- package/dist/migrations/afterImportActions.d.ts +17 -0
- package/dist/migrations/afterImportActions.js +306 -0
- package/dist/migrations/appwriteToX.d.ts +211 -0
- package/dist/migrations/appwriteToX.js +491 -0
- package/dist/migrations/comprehensiveTransfer.d.ts +147 -0
- package/dist/migrations/comprehensiveTransfer.js +1317 -0
- package/dist/migrations/dataLoader.d.ts +753 -0
- package/dist/migrations/dataLoader.js +1250 -0
- package/dist/migrations/importController.d.ts +23 -0
- package/dist/migrations/importController.js +268 -0
- package/dist/migrations/importDataActions.d.ts +50 -0
- package/dist/migrations/importDataActions.js +230 -0
- package/dist/migrations/relationships.d.ts +29 -0
- package/dist/migrations/relationships.js +204 -0
- package/dist/migrations/services/DataTransformationService.d.ts +55 -0
- package/dist/migrations/services/DataTransformationService.js +158 -0
- package/dist/migrations/services/FileHandlerService.d.ts +75 -0
- package/dist/migrations/services/FileHandlerService.js +236 -0
- package/dist/migrations/services/ImportOrchestrator.d.ts +97 -0
- package/dist/migrations/services/ImportOrchestrator.js +485 -0
- package/dist/migrations/services/RateLimitManager.d.ts +138 -0
- package/dist/migrations/services/RateLimitManager.js +279 -0
- package/dist/migrations/services/RelationshipResolver.d.ts +120 -0
- package/dist/migrations/services/RelationshipResolver.js +332 -0
- package/dist/migrations/services/UserMappingService.d.ts +109 -0
- package/dist/migrations/services/UserMappingService.js +277 -0
- package/dist/migrations/services/ValidationService.d.ts +74 -0
- package/dist/migrations/services/ValidationService.js +260 -0
- package/dist/migrations/transfer.d.ts +26 -0
- package/dist/migrations/transfer.js +608 -0
- package/dist/migrations/yaml/YamlImportConfigLoader.d.ts +131 -0
- package/dist/migrations/yaml/YamlImportConfigLoader.js +383 -0
- package/dist/migrations/yaml/YamlImportIntegration.d.ts +93 -0
- package/dist/migrations/yaml/YamlImportIntegration.js +341 -0
- package/dist/migrations/yaml/generateImportSchemas.d.ts +30 -0
- package/dist/migrations/yaml/generateImportSchemas.js +1327 -0
- package/dist/schemas/authUser.d.ts +24 -0
- package/dist/schemas/authUser.js +17 -0
- package/dist/setup.d.ts +2 -0
- package/dist/setup.js +5 -0
- package/dist/setupCommands.d.ts +58 -0
- package/dist/setupCommands.js +490 -0
- package/dist/setupController.d.ts +9 -0
- package/dist/setupController.js +34 -0
- package/dist/shared/attributeMapper.d.ts +20 -0
- package/dist/shared/attributeMapper.js +203 -0
- package/dist/shared/backupMetadataSchema.d.ts +94 -0
- package/dist/shared/backupMetadataSchema.js +38 -0
- package/dist/shared/backupTracking.d.ts +18 -0
- package/dist/shared/backupTracking.js +176 -0
- package/dist/shared/confirmationDialogs.d.ts +75 -0
- package/dist/shared/confirmationDialogs.js +236 -0
- package/dist/shared/errorUtils.d.ts +54 -0
- package/dist/shared/errorUtils.js +95 -0
- package/dist/shared/functionManager.d.ts +48 -0
- package/dist/shared/functionManager.js +336 -0
- package/dist/shared/indexManager.d.ts +24 -0
- package/dist/shared/indexManager.js +151 -0
- package/dist/shared/jsonSchemaGenerator.d.ts +50 -0
- package/dist/shared/jsonSchemaGenerator.js +290 -0
- package/dist/shared/logging.d.ts +61 -0
- package/dist/shared/logging.js +116 -0
- package/dist/shared/messageFormatter.d.ts +39 -0
- package/dist/shared/messageFormatter.js +162 -0
- package/dist/shared/migrationHelpers.d.ts +61 -0
- package/dist/shared/migrationHelpers.js +145 -0
- package/dist/shared/operationLogger.d.ts +10 -0
- package/dist/shared/operationLogger.js +12 -0
- package/dist/shared/operationQueue.d.ts +40 -0
- package/dist/shared/operationQueue.js +311 -0
- package/dist/shared/operationsTable.d.ts +26 -0
- package/dist/shared/operationsTable.js +286 -0
- package/dist/shared/operationsTableSchema.d.ts +48 -0
- package/dist/shared/operationsTableSchema.js +35 -0
- package/dist/shared/progressManager.d.ts +62 -0
- package/dist/shared/progressManager.js +215 -0
- package/dist/shared/pydanticModelGenerator.d.ts +17 -0
- package/dist/shared/pydanticModelGenerator.js +615 -0
- package/dist/shared/relationshipExtractor.d.ts +56 -0
- package/dist/shared/relationshipExtractor.js +138 -0
- package/dist/shared/schemaGenerator.d.ts +40 -0
- package/dist/shared/schemaGenerator.js +556 -0
- package/dist/shared/selectionDialogs.d.ts +214 -0
- package/dist/shared/selectionDialogs.js +544 -0
- package/dist/storage/backupCompression.d.ts +20 -0
- package/dist/storage/backupCompression.js +67 -0
- package/dist/storage/methods.d.ts +32 -0
- package/dist/storage/methods.js +472 -0
- package/dist/storage/schemas.d.ts +842 -0
- package/dist/storage/schemas.js +175 -0
- package/dist/types.d.ts +4 -0
- package/dist/types.js +3 -0
- package/dist/users/methods.d.ts +16 -0
- package/dist/users/methods.js +277 -0
- package/dist/utils/ClientFactory.d.ts +87 -0
- package/dist/utils/ClientFactory.js +212 -0
- package/dist/utils/configDiscovery.d.ts +78 -0
- package/dist/utils/configDiscovery.js +472 -0
- package/dist/utils/configMigration.d.ts +1 -0
- package/dist/utils/configMigration.js +261 -0
- package/dist/utils/constantsGenerator.d.ts +31 -0
- package/dist/utils/constantsGenerator.js +321 -0
- package/dist/utils/dataConverters.d.ts +46 -0
- package/dist/utils/dataConverters.js +139 -0
- package/dist/utils/directoryUtils.d.ts +22 -0
- package/dist/utils/directoryUtils.js +59 -0
- package/dist/utils/getClientFromConfig.d.ts +39 -0
- package/dist/utils/getClientFromConfig.js +199 -0
- package/dist/utils/helperFunctions.d.ts +63 -0
- package/dist/utils/helperFunctions.js +156 -0
- package/dist/utils/index.d.ts +2 -0
- package/dist/utils/index.js +2 -0
- package/dist/utils/loadConfigs.d.ts +50 -0
- package/dist/utils/loadConfigs.js +358 -0
- package/dist/utils/pathResolvers.d.ts +53 -0
- package/dist/utils/pathResolvers.js +72 -0
- package/dist/utils/projectConfig.d.ts +119 -0
- package/dist/utils/projectConfig.js +171 -0
- package/dist/utils/retryFailedPromises.d.ts +2 -0
- package/dist/utils/retryFailedPromises.js +23 -0
- package/dist/utils/sessionAuth.d.ts +48 -0
- package/dist/utils/sessionAuth.js +164 -0
- package/dist/utils/setupFiles.d.ts +4 -0
- package/dist/utils/setupFiles.js +1192 -0
- package/dist/utils/typeGuards.d.ts +35 -0
- package/dist/utils/typeGuards.js +57 -0
- package/dist/utils/validationRules.d.ts +43 -0
- package/dist/utils/validationRules.js +42 -0
- package/dist/utils/versionDetection.d.ts +58 -0
- package/dist/utils/versionDetection.js +251 -0
- package/dist/utils/yamlConverter.d.ts +100 -0
- package/dist/utils/yamlConverter.js +428 -0
- package/dist/utils/yamlLoader.d.ts +70 -0
- package/dist/utils/yamlLoader.js +267 -0
- package/dist/utilsController.d.ts +106 -0
- package/dist/utilsController.js +863 -0
- package/package.json +75 -0
- package/scripts/copy-templates.ts +23 -0
- package/src/adapters/AdapterFactory.ts +510 -0
- package/src/adapters/DatabaseAdapter.ts +306 -0
- package/src/adapters/LegacyAdapter.ts +841 -0
- package/src/adapters/TablesDBAdapter.ts +773 -0
- package/src/adapters/index.ts +37 -0
- package/src/backups/operations/bucketBackup.ts +277 -0
- package/src/backups/operations/collectionBackup.ts +310 -0
- package/src/backups/operations/comprehensiveBackup.ts +342 -0
- package/src/backups/schemas/bucketManifest.ts +78 -0
- package/src/backups/schemas/comprehensiveManifest.ts +76 -0
- package/src/backups/tracking/centralizedTracking.ts +352 -0
- package/src/cli/commands/configCommands.ts +201 -0
- package/src/cli/commands/databaseCommands.ts +749 -0
- package/src/cli/commands/functionCommands.ts +418 -0
- package/src/cli/commands/schemaCommands.ts +200 -0
- package/src/cli/commands/storageCommands.ts +152 -0
- package/src/cli/commands/transferCommands.ts +457 -0
- package/src/collections/attributes.ts +2054 -0
- package/src/collections/attributes.ts.backup +1555 -0
- package/src/collections/indexes.ts +352 -0
- package/src/collections/methods.ts +745 -0
- package/src/collections/tableOperations.ts +506 -0
- package/src/collections/transferOperations.ts +590 -0
- package/src/collections/wipeOperations.ts +346 -0
- package/src/config/ConfigManager.ts +808 -0
- package/src/config/README.md +274 -0
- package/src/config/configMigration.ts +575 -0
- package/src/config/configValidation.ts +445 -0
- package/src/config/index.ts +10 -0
- package/src/config/services/ConfigDiscoveryService.ts +463 -0
- package/src/config/services/ConfigLoaderService.ts +740 -0
- package/src/config/services/ConfigMergeService.ts +388 -0
- package/src/config/services/ConfigValidationService.ts +394 -0
- package/src/config/services/SessionAuthService.ts +565 -0
- package/src/config/services/__tests__/ConfigMergeService.test.ts +351 -0
- package/src/config/services/index.ts +29 -0
- package/src/config/yamlConfig.ts +761 -0
- package/src/databases/methods.ts +49 -0
- package/src/databases/setup.ts +77 -0
- package/src/examples/yamlTerminologyExample.ts +346 -0
- package/src/functions/deployments.ts +220 -0
- package/src/functions/fnConfigDiscovery.ts +103 -0
- package/src/functions/methods.ts +271 -0
- package/src/functions/pathResolution.ts +227 -0
- package/src/functions/templates/count-docs-in-collection/README.md +54 -0
- package/src/functions/templates/count-docs-in-collection/src/main.ts +159 -0
- package/src/functions/templates/count-docs-in-collection/src/request.ts +9 -0
- package/src/functions/templates/hono-typescript/README.md +286 -0
- package/src/functions/templates/hono-typescript/src/adapters/request.ts +74 -0
- package/src/functions/templates/hono-typescript/src/adapters/response.ts +106 -0
- package/src/functions/templates/hono-typescript/src/app.ts +180 -0
- package/src/functions/templates/hono-typescript/src/context.ts +103 -0
- package/src/functions/templates/hono-typescript/src/index.ts +54 -0
- package/src/functions/templates/hono-typescript/src/middleware/appwrite.ts +119 -0
- package/src/functions/templates/typescript-node/README.md +32 -0
- package/src/functions/templates/typescript-node/src/context.ts +103 -0
- package/src/functions/templates/typescript-node/src/index.ts +29 -0
- package/src/functions/templates/uv/README.md +31 -0
- package/src/functions/templates/uv/pyproject.toml +30 -0
- package/src/functions/templates/uv/src/__init__.py +0 -0
- package/src/functions/templates/uv/src/context.py +125 -0
- package/src/functions/templates/uv/src/index.py +46 -0
- package/src/init.ts +62 -0
- package/src/interactiveCLI.ts +1136 -0
- package/src/main.ts +1661 -0
- package/src/migrations/afterImportActions.ts +580 -0
- package/src/migrations/appwriteToX.ts +664 -0
- package/src/migrations/comprehensiveTransfer.ts +2285 -0
- package/src/migrations/dataLoader.ts +1702 -0
- package/src/migrations/importController.ts +428 -0
- package/src/migrations/importDataActions.ts +315 -0
- package/src/migrations/relationships.ts +334 -0
- package/src/migrations/services/DataTransformationService.ts +196 -0
- package/src/migrations/services/FileHandlerService.ts +311 -0
- package/src/migrations/services/ImportOrchestrator.ts +666 -0
- package/src/migrations/services/RateLimitManager.ts +363 -0
- package/src/migrations/services/RelationshipResolver.ts +461 -0
- package/src/migrations/services/UserMappingService.ts +345 -0
- package/src/migrations/services/ValidationService.ts +349 -0
- package/src/migrations/transfer.ts +1068 -0
- package/src/migrations/yaml/YamlImportConfigLoader.ts +439 -0
- package/src/migrations/yaml/YamlImportIntegration.ts +446 -0
- package/src/migrations/yaml/generateImportSchemas.ts +1354 -0
- package/src/schemas/authUser.ts +23 -0
- package/src/setup.ts +8 -0
- package/src/setupCommands.ts +603 -0
- package/src/setupController.ts +43 -0
- package/src/shared/attributeMapper.ts +229 -0
- package/src/shared/backupMetadataSchema.ts +93 -0
- package/src/shared/backupTracking.ts +211 -0
- package/src/shared/confirmationDialogs.ts +327 -0
- package/src/shared/errorUtils.ts +110 -0
- package/src/shared/functionManager.ts +525 -0
- package/src/shared/indexManager.ts +254 -0
- package/src/shared/jsonSchemaGenerator.ts +383 -0
- package/src/shared/logging.ts +149 -0
- package/src/shared/messageFormatter.ts +208 -0
- package/src/shared/migrationHelpers.ts +232 -0
- package/src/shared/operationLogger.ts +20 -0
- package/src/shared/operationQueue.ts +377 -0
- package/src/shared/operationsTable.ts +338 -0
- package/src/shared/operationsTableSchema.ts +60 -0
- package/src/shared/progressManager.ts +278 -0
- package/src/shared/pydanticModelGenerator.ts +618 -0
- package/src/shared/relationshipExtractor.ts +214 -0
- package/src/shared/schemaGenerator.ts +644 -0
- package/src/shared/selectionDialogs.ts +749 -0
- package/src/storage/backupCompression.ts +88 -0
- package/src/storage/methods.ts +698 -0
- package/src/storage/schemas.ts +205 -0
- package/src/types/node-appwrite-tablesdb.d.ts +44 -0
- package/src/types.ts +9 -0
- package/src/users/methods.ts +359 -0
- package/src/utils/ClientFactory.ts +240 -0
- package/src/utils/configDiscovery.ts +557 -0
- package/src/utils/configMigration.ts +348 -0
- package/src/utils/constantsGenerator.ts +369 -0
- package/src/utils/dataConverters.ts +159 -0
- package/src/utils/directoryUtils.ts +61 -0
- package/src/utils/getClientFromConfig.ts +257 -0
- package/src/utils/helperFunctions.ts +228 -0
- package/src/utils/index.ts +2 -0
- package/src/utils/loadConfigs.ts +449 -0
- package/src/utils/pathResolvers.ts +81 -0
- package/src/utils/projectConfig.ts +299 -0
- package/src/utils/retryFailedPromises.ts +29 -0
- package/src/utils/sessionAuth.ts +230 -0
- package/src/utils/setupFiles.ts +1238 -0
- package/src/utils/typeGuards.ts +65 -0
- package/src/utils/validationRules.ts +88 -0
- package/src/utils/versionDetection.ts +292 -0
- package/src/utils/yamlConverter.ts +542 -0
- package/src/utils/yamlLoader.ts +371 -0
- package/src/utilsController.ts +1203 -0
- package/tests/README.md +497 -0
- package/tests/adapters/AdapterFactory.test.ts +277 -0
- package/tests/integration/syncOperations.test.ts +463 -0
- package/tests/jest.config.js +25 -0
- package/tests/migration/configMigration.test.ts +546 -0
- package/tests/setup.ts +62 -0
- package/tests/testUtils.ts +340 -0
- package/tests/utils/loadConfigs.test.ts +350 -0
- package/tests/validation/configValidation.test.ts +412 -0
- package/tsconfig.json +44 -0
|
@@ -0,0 +1,139 @@
|
|
|
1
|
+
import { converterFunctions } from "@njdamstra/appwrite-utils";
|
|
2
|
+
import { cloneDeep, isPlainObject } from "es-toolkit";
|
|
3
|
+
/**
|
|
4
|
+
* Deeply converts all properties of an object (or array) to strings.
|
|
5
|
+
* @param data The input data to convert.
|
|
6
|
+
* @returns The data with all its properties converted to strings.
|
|
7
|
+
*/
|
|
8
|
+
export const deepAnyToString = (data) => {
|
|
9
|
+
if (Array.isArray(data)) {
|
|
10
|
+
return data.map((item) => deepAnyToString(item));
|
|
11
|
+
}
|
|
12
|
+
else if (isPlainObject(data)) {
|
|
13
|
+
return Object.keys(data).reduce((acc, key) => {
|
|
14
|
+
acc[key] = deepAnyToString(data[key]);
|
|
15
|
+
return acc;
|
|
16
|
+
}, {});
|
|
17
|
+
}
|
|
18
|
+
else {
|
|
19
|
+
return converterFunctions.anyToString(data);
|
|
20
|
+
}
|
|
21
|
+
};
|
|
22
|
+
/**
|
|
23
|
+
* Performs a deep conversion of all values in a nested structure to the specified type.
|
|
24
|
+
* Uses a conversion function like anyToString, anyToNumber, etc.
|
|
25
|
+
* @param data The data to convert.
|
|
26
|
+
* @param convertFn The conversion function to apply.
|
|
27
|
+
* @returns The converted data.
|
|
28
|
+
*/
|
|
29
|
+
export const deepConvert = (data, convertFn) => {
|
|
30
|
+
if (Array.isArray(data)) {
|
|
31
|
+
return data.map((item) => deepConvert(item, convertFn));
|
|
32
|
+
}
|
|
33
|
+
else if (isPlainObject(data)) {
|
|
34
|
+
return Object.keys(data).reduce((acc, key) => {
|
|
35
|
+
acc[key] = deepConvert(data[key], convertFn);
|
|
36
|
+
return acc;
|
|
37
|
+
}, {});
|
|
38
|
+
}
|
|
39
|
+
else {
|
|
40
|
+
return convertFn(data);
|
|
41
|
+
}
|
|
42
|
+
};
|
|
43
|
+
/**
|
|
44
|
+
* Converts an entire object's properties to different types based on a provided schema.
|
|
45
|
+
* @param obj The object to convert.
|
|
46
|
+
* @param schema A mapping of object keys to conversion functions.
|
|
47
|
+
* @returns The converted object.
|
|
48
|
+
*/
|
|
49
|
+
export const convertObjectBySchema = (obj, schema) => {
|
|
50
|
+
return Object.keys(obj).reduce((acc, key) => {
|
|
51
|
+
const convertFn = schema[key];
|
|
52
|
+
acc[key] = convertFn ? convertFn(obj[key]) : obj[key];
|
|
53
|
+
return acc;
|
|
54
|
+
}, {});
|
|
55
|
+
};
|
|
56
|
+
/**
|
|
57
|
+
* Converts the keys of an object based on a provided attributeMappings.
|
|
58
|
+
* Each key in the object is checked against attributeMappings; if a matching entry is found,
|
|
59
|
+
* the key is renamed to the targetKey specified in attributeMappings.
|
|
60
|
+
*
|
|
61
|
+
* @param obj The object to convert.
|
|
62
|
+
* @param attributeMappings The attributeMappings defining how keys in the object should be converted.
|
|
63
|
+
* @returns The converted object with keys renamed according to attributeMappings.
|
|
64
|
+
*/
|
|
65
|
+
export const convertObjectByAttributeMappings = (obj, attributeMappings) => {
|
|
66
|
+
const result = {};
|
|
67
|
+
// Correctly handle [any] notation by mapping or aggregating over all elements or keys
|
|
68
|
+
const resolveValue = (obj, path) => {
|
|
69
|
+
const parts = path.split(".");
|
|
70
|
+
let current = obj;
|
|
71
|
+
for (let i = 0; i < parts.length; i++) {
|
|
72
|
+
if (parts[i] === "[any]") {
|
|
73
|
+
if (Array.isArray(current)) {
|
|
74
|
+
// If current is an array, apply resolution to each item
|
|
75
|
+
return current.map((item) => resolveValue(item, parts.slice(i + 1).join(".")));
|
|
76
|
+
}
|
|
77
|
+
else if (typeof current === "object" && current !== null) {
|
|
78
|
+
// If current is an object, aggregate values from all keys
|
|
79
|
+
return Object.values(current).map((value) => resolveValue(value, parts.slice(i + 1).join(".")));
|
|
80
|
+
}
|
|
81
|
+
}
|
|
82
|
+
else {
|
|
83
|
+
current = current[parts[i]];
|
|
84
|
+
if (current === undefined)
|
|
85
|
+
return undefined;
|
|
86
|
+
}
|
|
87
|
+
}
|
|
88
|
+
return current;
|
|
89
|
+
};
|
|
90
|
+
for (const mapping of attributeMappings) {
|
|
91
|
+
if (mapping.valueToSet !== undefined) {
|
|
92
|
+
result[mapping.targetKey] = mapping.valueToSet;
|
|
93
|
+
}
|
|
94
|
+
else if (Array.isArray(mapping.oldKeys)) {
|
|
95
|
+
// Collect and flatten values from multiple oldKeys
|
|
96
|
+
const values = mapping.oldKeys
|
|
97
|
+
.map((oldKey) => resolveValue(obj, oldKey))
|
|
98
|
+
.flat(Infinity);
|
|
99
|
+
if (values.length > 0) {
|
|
100
|
+
result[mapping.targetKey] = values.filter((value) => value !== undefined);
|
|
101
|
+
}
|
|
102
|
+
else {
|
|
103
|
+
result[mapping.targetKey] = null;
|
|
104
|
+
}
|
|
105
|
+
}
|
|
106
|
+
else if (mapping.oldKey) {
|
|
107
|
+
// Resolve single oldKey
|
|
108
|
+
const value = resolveValue(obj, mapping.oldKey);
|
|
109
|
+
if (value !== undefined) {
|
|
110
|
+
result[mapping.targetKey] = Array.isArray(value)
|
|
111
|
+
? value.flat(Infinity)
|
|
112
|
+
: value;
|
|
113
|
+
}
|
|
114
|
+
else {
|
|
115
|
+
result[mapping.targetKey] = value ? value : null;
|
|
116
|
+
}
|
|
117
|
+
}
|
|
118
|
+
}
|
|
119
|
+
return result;
|
|
120
|
+
};
|
|
121
|
+
/**
|
|
122
|
+
* Ensures data conversion without mutating the original input.
|
|
123
|
+
* @param data The data to convert.
|
|
124
|
+
* @param convertFn The conversion function to apply.
|
|
125
|
+
* @returns The converted data.
|
|
126
|
+
*/
|
|
127
|
+
export const immutableConvert = (data, convertFn) => {
|
|
128
|
+
const clonedData = cloneDeep(data);
|
|
129
|
+
return convertFn(clonedData);
|
|
130
|
+
};
|
|
131
|
+
/**
|
|
132
|
+
* Validates a string against a regular expression and returns the string if valid, or null.
|
|
133
|
+
* @param value The string to validate.
|
|
134
|
+
* @param pattern The regex pattern to validate against.
|
|
135
|
+
* @returns The original string if valid, otherwise null.
|
|
136
|
+
*/
|
|
137
|
+
export const validateString = (value, pattern) => {
|
|
138
|
+
return pattern.test(value) ? value : null;
|
|
139
|
+
};
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Directory utility functions for filtering and managing directory traversal
|
|
3
|
+
*/
|
|
4
|
+
/**
|
|
5
|
+
* List of directories that should be ignored during recursive searches
|
|
6
|
+
* Includes common build outputs, dependencies, caches, and system folders
|
|
7
|
+
*/
|
|
8
|
+
export declare const IGNORED_DIRECTORIES: string[];
|
|
9
|
+
/**
|
|
10
|
+
* Determines if a directory should be ignored during recursive file operations
|
|
11
|
+
*
|
|
12
|
+
* @param dirName - The name of the directory to check
|
|
13
|
+
* @returns true if the directory should be ignored, false otherwise
|
|
14
|
+
*
|
|
15
|
+
* @remarks
|
|
16
|
+
* A directory is ignored if:
|
|
17
|
+
* - It matches one of the entries in IGNORED_DIRECTORIES
|
|
18
|
+
* - It starts with '.git' prefix
|
|
19
|
+
* - It starts with 'node_modules' prefix
|
|
20
|
+
* - It starts with '.' (hidden directory) except for '.appwrite'
|
|
21
|
+
*/
|
|
22
|
+
export declare const shouldIgnoreDirectory: (dirName: string) => boolean;
|
|
@@ -0,0 +1,59 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Directory utility functions for filtering and managing directory traversal
|
|
3
|
+
*/
|
|
4
|
+
/**
|
|
5
|
+
* List of directories that should be ignored during recursive searches
|
|
6
|
+
* Includes common build outputs, dependencies, caches, and system folders
|
|
7
|
+
*/
|
|
8
|
+
export const IGNORED_DIRECTORIES = [
|
|
9
|
+
'node_modules',
|
|
10
|
+
'dist',
|
|
11
|
+
'build',
|
|
12
|
+
'coverage',
|
|
13
|
+
'.next',
|
|
14
|
+
'.nuxt',
|
|
15
|
+
'.cache',
|
|
16
|
+
'.git',
|
|
17
|
+
'.svn',
|
|
18
|
+
'.hg',
|
|
19
|
+
'__pycache__',
|
|
20
|
+
'.pytest_cache',
|
|
21
|
+
'.mypy_cache',
|
|
22
|
+
'venv',
|
|
23
|
+
'.venv',
|
|
24
|
+
'env',
|
|
25
|
+
'.env',
|
|
26
|
+
'target',
|
|
27
|
+
'out',
|
|
28
|
+
'bin',
|
|
29
|
+
'obj',
|
|
30
|
+
'.vs',
|
|
31
|
+
'.vscode',
|
|
32
|
+
'.idea',
|
|
33
|
+
'temp',
|
|
34
|
+
'tmp',
|
|
35
|
+
'.tmp',
|
|
36
|
+
'logs',
|
|
37
|
+
'log',
|
|
38
|
+
'.DS_Store',
|
|
39
|
+
'Thumbs.db'
|
|
40
|
+
];
|
|
41
|
+
/**
|
|
42
|
+
* Determines if a directory should be ignored during recursive file operations
|
|
43
|
+
*
|
|
44
|
+
* @param dirName - The name of the directory to check
|
|
45
|
+
* @returns true if the directory should be ignored, false otherwise
|
|
46
|
+
*
|
|
47
|
+
* @remarks
|
|
48
|
+
* A directory is ignored if:
|
|
49
|
+
* - It matches one of the entries in IGNORED_DIRECTORIES
|
|
50
|
+
* - It starts with '.git' prefix
|
|
51
|
+
* - It starts with 'node_modules' prefix
|
|
52
|
+
* - It starts with '.' (hidden directory) except for '.appwrite'
|
|
53
|
+
*/
|
|
54
|
+
export const shouldIgnoreDirectory = (dirName) => {
|
|
55
|
+
return IGNORED_DIRECTORIES.includes(dirName) ||
|
|
56
|
+
dirName.startsWith('.git') ||
|
|
57
|
+
dirName.startsWith('node_modules') ||
|
|
58
|
+
(dirName.startsWith('.') && dirName !== '.appwrite');
|
|
59
|
+
};
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
import { type AppwriteConfig } from "@njdamstra/appwrite-utils";
|
|
2
|
+
import { Client } from "node-appwrite";
|
|
3
|
+
import type { DatabaseAdapter } from "../adapters/DatabaseAdapter.js";
|
|
4
|
+
/**
|
|
5
|
+
* Enhanced client creation from config with session authentication support
|
|
6
|
+
* @deprecated Use getAdapterFromConfig for dual API support with session auth
|
|
7
|
+
*/
|
|
8
|
+
export declare const getClientFromConfig: (config: AppwriteConfig, sessionCookie?: string) => Client | undefined;
|
|
9
|
+
/**
|
|
10
|
+
* Enhanced client creation with session authentication support
|
|
11
|
+
* Priority: explicit session > session from prefs > API key
|
|
12
|
+
*/
|
|
13
|
+
export declare const getClientWithAuth: (endpoint: string, project: string, key?: string, sessionCookie?: string) => Client;
|
|
14
|
+
/**
|
|
15
|
+
* Legacy function - returns basic Client
|
|
16
|
+
* @deprecated Use getClientWithAuth for session support or createDatabaseAdapter for dual API support
|
|
17
|
+
*/
|
|
18
|
+
export declare const getClient: (endpoint: string, project: string, key: string) => Client;
|
|
19
|
+
/**
|
|
20
|
+
* Modern adapter-based client creation with dual API support and session authentication
|
|
21
|
+
* Returns both adapter and legacy client for compatibility
|
|
22
|
+
*/
|
|
23
|
+
export declare const getAdapterFromConfig: (config: AppwriteConfig, forceRefresh?: boolean, sessionCookie?: string) => Promise<{
|
|
24
|
+
adapter: DatabaseAdapter;
|
|
25
|
+
client: Client;
|
|
26
|
+
apiMode: "legacy" | "tablesdb";
|
|
27
|
+
}>;
|
|
28
|
+
/**
|
|
29
|
+
* Create adapter from individual parameters with session authentication support
|
|
30
|
+
*/
|
|
31
|
+
export declare const getAdapter: (endpoint: string, project: string, key?: string, apiMode?: "auto" | "legacy" | "tablesdb", sessionCookie?: string) => Promise<{
|
|
32
|
+
adapter: DatabaseAdapter;
|
|
33
|
+
client: Client;
|
|
34
|
+
apiMode: "legacy" | "tablesdb";
|
|
35
|
+
}>;
|
|
36
|
+
/**
|
|
37
|
+
* Check if session authentication is available for a project
|
|
38
|
+
*/
|
|
39
|
+
export declare const checkSessionAuth: (endpoint: string, project: string) => boolean;
|
|
@@ -0,0 +1,199 @@
|
|
|
1
|
+
import {} from "@njdamstra/appwrite-utils";
|
|
2
|
+
import { Client } from "node-appwrite";
|
|
3
|
+
import { AdapterFactory } from "../adapters/AdapterFactory.js";
|
|
4
|
+
import { findSessionByEndpointAndProject, hasSessionAuth, isValidSessionCookie } from "./sessionAuth.js";
|
|
5
|
+
import { MessageFormatter } from "../shared/messageFormatter.js";
|
|
6
|
+
import { logger } from "../shared/logging.js";
|
|
7
|
+
/**
|
|
8
|
+
* Enhanced client creation from config with session authentication support
|
|
9
|
+
* @deprecated Use getAdapterFromConfig for dual API support with session auth
|
|
10
|
+
*/
|
|
11
|
+
export const getClientFromConfig = (config, sessionCookie) => {
|
|
12
|
+
let appwriteClient;
|
|
13
|
+
if (!config.appwriteClient) {
|
|
14
|
+
appwriteClient = getClientWithAuth(config.appwriteEndpoint, config.appwriteProject, config.appwriteKey, sessionCookie);
|
|
15
|
+
config.appwriteClient = appwriteClient;
|
|
16
|
+
}
|
|
17
|
+
return appwriteClient;
|
|
18
|
+
};
|
|
19
|
+
/**
|
|
20
|
+
* Enhanced client creation with session authentication support
|
|
21
|
+
* Priority: explicit session > session from prefs > API key
|
|
22
|
+
*/
|
|
23
|
+
export const getClientWithAuth = (endpoint, project, key, sessionCookie) => {
|
|
24
|
+
const client = new Client()
|
|
25
|
+
.setEndpoint(endpoint)
|
|
26
|
+
.setProject(project);
|
|
27
|
+
const authAttempts = [];
|
|
28
|
+
// Priority 1: Explicit session cookie provided
|
|
29
|
+
if (sessionCookie) {
|
|
30
|
+
if (isValidSessionCookie(sessionCookie)) {
|
|
31
|
+
client.setSession(sessionCookie);
|
|
32
|
+
logger.debug("Using explicit session authentication", { prefix: "Auth", project });
|
|
33
|
+
return client;
|
|
34
|
+
}
|
|
35
|
+
else {
|
|
36
|
+
authAttempts.push("explicit session cookie (invalid format)");
|
|
37
|
+
MessageFormatter.warning(`Provided session cookie has invalid format`, { prefix: "Auth" });
|
|
38
|
+
}
|
|
39
|
+
}
|
|
40
|
+
// Priority 2: Session from Appwrite CLI prefs
|
|
41
|
+
const sessionAuth = findSessionByEndpointAndProject(endpoint, project);
|
|
42
|
+
if (sessionAuth) {
|
|
43
|
+
if (isValidSessionCookie(sessionAuth.sessionCookie)) {
|
|
44
|
+
client.setSession(sessionAuth.sessionCookie);
|
|
45
|
+
logger.debug("Using session authentication", { prefix: "Auth", project, email: sessionAuth.email || 'unknown user' });
|
|
46
|
+
return client;
|
|
47
|
+
}
|
|
48
|
+
else {
|
|
49
|
+
authAttempts.push("session from CLI prefs (invalid/expired)");
|
|
50
|
+
MessageFormatter.warning(`Session cookie from CLI prefs is invalid or expired`, { prefix: "Auth" });
|
|
51
|
+
}
|
|
52
|
+
}
|
|
53
|
+
// Priority 3: API key fallback
|
|
54
|
+
if (key) {
|
|
55
|
+
if (key.trim() === "") {
|
|
56
|
+
authAttempts.push("API key (empty)");
|
|
57
|
+
}
|
|
58
|
+
else {
|
|
59
|
+
client.setKey(key);
|
|
60
|
+
logger.debug("Using API key authentication", { prefix: "Auth", project });
|
|
61
|
+
return client;
|
|
62
|
+
}
|
|
63
|
+
}
|
|
64
|
+
// Build detailed error message based on attempted methods
|
|
65
|
+
const buildAuthError = () => {
|
|
66
|
+
let errorMessage = `No valid authentication method available for project '${project}'.\n\n`;
|
|
67
|
+
if (authAttempts.length > 0) {
|
|
68
|
+
errorMessage += `Authentication methods attempted:\n`;
|
|
69
|
+
authAttempts.forEach(attempt => {
|
|
70
|
+
errorMessage += ` ✗ ${attempt}\n`;
|
|
71
|
+
});
|
|
72
|
+
errorMessage += `\n`;
|
|
73
|
+
}
|
|
74
|
+
errorMessage += `Available authentication options:\n`;
|
|
75
|
+
errorMessage += ` 1. Session Authentication (Recommended):\n`;
|
|
76
|
+
errorMessage += ` Run: appwrite login\n`;
|
|
77
|
+
errorMessage += ` Then select your project and login with your account\n\n`;
|
|
78
|
+
errorMessage += ` 2. API Key Authentication:\n`;
|
|
79
|
+
errorMessage += ` - Set appwriteKey in your configuration\n`;
|
|
80
|
+
errorMessage += ` - Or provide via --key command line option\n`;
|
|
81
|
+
errorMessage += ` - Get your API key from: ${endpoint}/console/project-${project}/settings/keys\n\n`;
|
|
82
|
+
errorMessage += ` 3. Environment Variables:\n`;
|
|
83
|
+
errorMessage += ` Set APPWRITE_API_KEY environment variable\n\n`;
|
|
84
|
+
errorMessage += `For more help, visit: https://appwrite.io/docs/tooling/command-line/installation`;
|
|
85
|
+
return new Error(errorMessage);
|
|
86
|
+
};
|
|
87
|
+
throw buildAuthError();
|
|
88
|
+
};
|
|
89
|
+
/**
|
|
90
|
+
* Legacy function - returns basic Client
|
|
91
|
+
* @deprecated Use getClientWithAuth for session support or createDatabaseAdapter for dual API support
|
|
92
|
+
*/
|
|
93
|
+
export const getClient = (endpoint, project, key) => {
|
|
94
|
+
return getClientWithAuth(endpoint, project, key);
|
|
95
|
+
};
|
|
96
|
+
/**
|
|
97
|
+
* Modern adapter-based client creation with dual API support and session authentication
|
|
98
|
+
* Returns both adapter and legacy client for compatibility
|
|
99
|
+
*/
|
|
100
|
+
export const getAdapterFromConfig = async (config, forceRefresh, sessionCookie) => {
|
|
101
|
+
// Create enhanced config with session support
|
|
102
|
+
const enhancedConfig = { ...config };
|
|
103
|
+
// Check for session authentication if no explicit session provided
|
|
104
|
+
if (!sessionCookie && !config.appwriteKey) {
|
|
105
|
+
const sessionAuth = findSessionByEndpointAndProject(config.appwriteEndpoint, config.appwriteProject);
|
|
106
|
+
if (sessionAuth && isValidSessionCookie(sessionAuth.sessionCookie)) {
|
|
107
|
+
sessionCookie = sessionAuth.sessionCookie;
|
|
108
|
+
}
|
|
109
|
+
}
|
|
110
|
+
// Override client creation in factory if session auth is available
|
|
111
|
+
if (sessionCookie && isValidSessionCookie(sessionCookie)) {
|
|
112
|
+
enhancedConfig.appwriteClient = getClientWithAuth(config.appwriteEndpoint, config.appwriteProject, config.appwriteKey, sessionCookie);
|
|
113
|
+
}
|
|
114
|
+
const result = await AdapterFactory.createFromConfig(enhancedConfig, forceRefresh);
|
|
115
|
+
return {
|
|
116
|
+
adapter: result.adapter,
|
|
117
|
+
client: result.client,
|
|
118
|
+
apiMode: result.apiMode
|
|
119
|
+
};
|
|
120
|
+
};
|
|
121
|
+
/**
|
|
122
|
+
* Create adapter from individual parameters with session authentication support
|
|
123
|
+
*/
|
|
124
|
+
export const getAdapter = async (endpoint, project, key, apiMode = 'auto', sessionCookie) => {
|
|
125
|
+
// Create config object with session support
|
|
126
|
+
const config = {
|
|
127
|
+
appwriteEndpoint: endpoint,
|
|
128
|
+
appwriteProject: project,
|
|
129
|
+
appwriteKey: key || "",
|
|
130
|
+
apiMode
|
|
131
|
+
};
|
|
132
|
+
const authAttempts = [];
|
|
133
|
+
// Use session auth if available, otherwise fall back to API key
|
|
134
|
+
if (sessionCookie) {
|
|
135
|
+
if (isValidSessionCookie(sessionCookie)) {
|
|
136
|
+
config.appwriteClient = getClientWithAuth(endpoint, project, key, sessionCookie);
|
|
137
|
+
}
|
|
138
|
+
else {
|
|
139
|
+
authAttempts.push("explicit session cookie (invalid format)");
|
|
140
|
+
}
|
|
141
|
+
}
|
|
142
|
+
else if (!key) {
|
|
143
|
+
// Try to find session auth if no API key provided
|
|
144
|
+
const sessionAuth = findSessionByEndpointAndProject(endpoint, project);
|
|
145
|
+
if (sessionAuth) {
|
|
146
|
+
if (isValidSessionCookie(sessionAuth.sessionCookie)) {
|
|
147
|
+
config.appwriteClient = getClientWithAuth(endpoint, project, key, sessionAuth.sessionCookie);
|
|
148
|
+
}
|
|
149
|
+
else {
|
|
150
|
+
authAttempts.push("session from CLI prefs (invalid/expired)");
|
|
151
|
+
}
|
|
152
|
+
}
|
|
153
|
+
else {
|
|
154
|
+
authAttempts.push("session from CLI prefs (not found)");
|
|
155
|
+
}
|
|
156
|
+
// If no valid authentication found, build detailed error
|
|
157
|
+
if (!config.appwriteClient) {
|
|
158
|
+
const buildDetailedAuthError = () => {
|
|
159
|
+
let errorMessage = `No valid authentication method available for project '${project}'.\n\n`;
|
|
160
|
+
if (authAttempts.length > 0) {
|
|
161
|
+
errorMessage += `Authentication methods attempted:\n`;
|
|
162
|
+
authAttempts.forEach(attempt => {
|
|
163
|
+
errorMessage += ` ✗ ${attempt}\n`;
|
|
164
|
+
});
|
|
165
|
+
errorMessage += `\n`;
|
|
166
|
+
}
|
|
167
|
+
errorMessage += `Available authentication options:\n`;
|
|
168
|
+
errorMessage += ` 1. Session Authentication (Recommended):\n`;
|
|
169
|
+
errorMessage += ` Run: appwrite login\n`;
|
|
170
|
+
errorMessage += ` Then select your project and login with your account\n`;
|
|
171
|
+
errorMessage += ` This will save session credentials to ~/.appwrite/prefs.json\n\n`;
|
|
172
|
+
errorMessage += ` 2. API Key Authentication:\n`;
|
|
173
|
+
errorMessage += ` - Provide API key via --key command line option\n`;
|
|
174
|
+
errorMessage += ` - Or set appwriteKey in your configuration file\n`;
|
|
175
|
+
errorMessage += ` - Get your API key from: ${endpoint}/console/project-${project}/settings/keys\n\n`;
|
|
176
|
+
errorMessage += ` 3. Environment Variables:\n`;
|
|
177
|
+
errorMessage += ` Set APPWRITE_API_KEY environment variable\n\n`;
|
|
178
|
+
// Check if CLI is installed
|
|
179
|
+
errorMessage += `Note: Ensure Appwrite CLI is installed:\n`;
|
|
180
|
+
errorMessage += ` npm install -g appwrite-cli\n\n`;
|
|
181
|
+
errorMessage += `For more help, visit: https://appwrite.io/docs/tooling/command-line/installation`;
|
|
182
|
+
return new Error(errorMessage);
|
|
183
|
+
};
|
|
184
|
+
throw buildDetailedAuthError();
|
|
185
|
+
}
|
|
186
|
+
}
|
|
187
|
+
const result = await AdapterFactory.create(config);
|
|
188
|
+
return {
|
|
189
|
+
adapter: result.adapter,
|
|
190
|
+
client: result.client,
|
|
191
|
+
apiMode: result.apiMode
|
|
192
|
+
};
|
|
193
|
+
};
|
|
194
|
+
/**
|
|
195
|
+
* Check if session authentication is available for a project
|
|
196
|
+
*/
|
|
197
|
+
export const checkSessionAuth = (endpoint, project) => {
|
|
198
|
+
return hasSessionAuth(endpoint, project);
|
|
199
|
+
};
|
|
@@ -0,0 +1,63 @@
|
|
|
1
|
+
import { type Models } from "node-appwrite";
|
|
2
|
+
import type { CollectionImportData } from "../migrations/dataLoader.js";
|
|
3
|
+
import type { ConfigCollection } from "@njdamstra/appwrite-utils";
|
|
4
|
+
export declare const toPascalCase: (str: string) => string;
|
|
5
|
+
export declare const toCamelCase: (str: string) => string;
|
|
6
|
+
export declare const ensureDirectoryExistence: (filePath: string) => true | undefined;
|
|
7
|
+
export declare const writeFileSync: (filePath: string, content: string, options: {
|
|
8
|
+
flag: string;
|
|
9
|
+
}) => void;
|
|
10
|
+
export declare const readFileSync: (filePath: string) => string;
|
|
11
|
+
export declare const existsSync: (filePath: string) => boolean;
|
|
12
|
+
export declare const mkdirSync: (filePath: string) => void;
|
|
13
|
+
export declare const readdirSync: (filePath: string) => string[];
|
|
14
|
+
export declare const areCollectionNamesSame: (a: string, b: string) => boolean;
|
|
15
|
+
/**
|
|
16
|
+
* Generates the view URL for a specific file based on the provided endpoint, project ID, bucket ID, file ID, and optional JWT token.
|
|
17
|
+
*
|
|
18
|
+
* @param {string} endpoint - the base URL endpoint
|
|
19
|
+
* @param {string} projectId - the ID of the project
|
|
20
|
+
* @param {string} bucketId - the ID of the bucket
|
|
21
|
+
* @param {string} fileId - the ID of the file
|
|
22
|
+
* @param {Models.Jwt} [jwt] - optional JWT token generated via the Appwrite SDK
|
|
23
|
+
* @return {string} the generated view URL for the file
|
|
24
|
+
*/
|
|
25
|
+
export declare const getFileViewUrl: (endpoint: string, projectId: string, bucketId: string, fileId: string, jwt?: Models.Jwt) => string;
|
|
26
|
+
/**
|
|
27
|
+
* Generates a download URL for a file based on the provided endpoint, project ID, bucket ID, file ID, and optionally a JWT.
|
|
28
|
+
*
|
|
29
|
+
* @param {string} endpoint - The base URL endpoint.
|
|
30
|
+
* @param {string} projectId - The ID of the project.
|
|
31
|
+
* @param {string} bucketId - The ID of the bucket.
|
|
32
|
+
* @param {string} fileId - The ID of the file.
|
|
33
|
+
* @param {Models.Jwt} [jwt] - Optional JWT object for authentication with Appwrite.
|
|
34
|
+
* @return {string} The complete download URL for the file.
|
|
35
|
+
*/
|
|
36
|
+
export declare const getFileDownloadUrl: (endpoint: string, projectId: string, bucketId: string, fileId: string, jwt?: Models.Jwt) => string;
|
|
37
|
+
export declare const finalizeByAttributeMap: (appwriteFolderPath: string, collection: ConfigCollection, item: CollectionImportData["data"][number]) => Promise<any>;
|
|
38
|
+
export declare let numTimesFailedTotal: number;
|
|
39
|
+
/**
|
|
40
|
+
* Tries to execute the given createFunction and retries up to 5 times if it fails.
|
|
41
|
+
* Only retries on transient errors (network failures, 5xx errors). Does NOT retry validation errors (4xx).
|
|
42
|
+
*
|
|
43
|
+
* @param {() => Promise<any>} createFunction - The function to be executed.
|
|
44
|
+
* @param {number} [attemptNum=0] - The number of attempts made so far (default: 0).
|
|
45
|
+
* @return {Promise<any>} - A promise that resolves to the result of the createFunction or rejects with an error if it fails after 5 attempts.
|
|
46
|
+
*/
|
|
47
|
+
export declare const tryAwaitWithRetry: <T>(createFunction: () => Promise<T>, attemptNum?: number, throwError?: boolean) => Promise<T>;
|
|
48
|
+
export declare const getAppwriteClient: (endpoint: string, projectId: string, apiKey: string) => import("node-appwrite").Client;
|
|
49
|
+
export declare const delay: (ms: number) => Promise<unknown>;
|
|
50
|
+
/**
|
|
51
|
+
* Calculates exponential backoff delay with configurable base and maximum
|
|
52
|
+
*
|
|
53
|
+
* @param retryCount - Current retry attempt number (0-indexed)
|
|
54
|
+
* @param baseDelay - Base delay in milliseconds (default: 2000)
|
|
55
|
+
* @param maxDelay - Maximum delay cap in milliseconds (default: 30000)
|
|
56
|
+
* @returns Calculated delay in milliseconds
|
|
57
|
+
*
|
|
58
|
+
* @example
|
|
59
|
+
* calculateExponentialBackoff(0) // Returns 2000
|
|
60
|
+
* calculateExponentialBackoff(1) // Returns 4000
|
|
61
|
+
* calculateExponentialBackoff(5) // Returns 30000 (capped)
|
|
62
|
+
*/
|
|
63
|
+
export declare const calculateExponentialBackoff: (retryCount: number, baseDelay?: number, maxDelay?: number) => number;
|
|
@@ -0,0 +1,156 @@
|
|
|
1
|
+
import { AppwriteException, } from "node-appwrite";
|
|
2
|
+
import fs from "node:fs";
|
|
3
|
+
import path from "node:path";
|
|
4
|
+
import { getClientWithAuth } from "./getClientFromConfig.js";
|
|
5
|
+
export const toPascalCase = (str) => {
|
|
6
|
+
return (str
|
|
7
|
+
// Split the string into words on spaces or camelCase transitions
|
|
8
|
+
.split(/(?:\s+)|(?:([A-Z][a-z]+))/g)
|
|
9
|
+
// Filter out empty strings that can appear due to the split regex
|
|
10
|
+
.filter(Boolean)
|
|
11
|
+
// Capitalize the first letter of each word and join them together
|
|
12
|
+
.map((word) => word.charAt(0).toUpperCase() + word.slice(1))
|
|
13
|
+
.join(""));
|
|
14
|
+
};
|
|
15
|
+
export const toCamelCase = (str) => {
|
|
16
|
+
return str
|
|
17
|
+
.replace(/(?:^\w|[A-Z]|\b\w)/g, (word, index) => index === 0 ? word.toLowerCase() : word.toUpperCase())
|
|
18
|
+
.replace(/\s+/g, "");
|
|
19
|
+
};
|
|
20
|
+
export const ensureDirectoryExistence = (filePath) => {
|
|
21
|
+
const dirname = path.dirname(filePath);
|
|
22
|
+
if (fs.existsSync(dirname)) {
|
|
23
|
+
return true;
|
|
24
|
+
}
|
|
25
|
+
ensureDirectoryExistence(dirname);
|
|
26
|
+
fs.mkdirSync(dirname);
|
|
27
|
+
};
|
|
28
|
+
export const writeFileSync = (filePath, content, options) => {
|
|
29
|
+
ensureDirectoryExistence(filePath);
|
|
30
|
+
fs.writeFileSync(filePath, content, options);
|
|
31
|
+
};
|
|
32
|
+
export const readFileSync = (filePath) => {
|
|
33
|
+
return fs.readFileSync(filePath, "utf8");
|
|
34
|
+
};
|
|
35
|
+
export const existsSync = (filePath) => {
|
|
36
|
+
return fs.existsSync(filePath);
|
|
37
|
+
};
|
|
38
|
+
export const mkdirSync = (filePath) => {
|
|
39
|
+
ensureDirectoryExistence(filePath);
|
|
40
|
+
fs.mkdirSync(filePath);
|
|
41
|
+
};
|
|
42
|
+
export const readdirSync = (filePath) => {
|
|
43
|
+
return fs.readdirSync(filePath);
|
|
44
|
+
};
|
|
45
|
+
export const areCollectionNamesSame = (a, b) => {
|
|
46
|
+
return (a.toLowerCase().trim().replace(" ", "") ===
|
|
47
|
+
b.toLowerCase().trim().replace(" ", ""));
|
|
48
|
+
};
|
|
49
|
+
/**
|
|
50
|
+
* Generates the view URL for a specific file based on the provided endpoint, project ID, bucket ID, file ID, and optional JWT token.
|
|
51
|
+
*
|
|
52
|
+
* @param {string} endpoint - the base URL endpoint
|
|
53
|
+
* @param {string} projectId - the ID of the project
|
|
54
|
+
* @param {string} bucketId - the ID of the bucket
|
|
55
|
+
* @param {string} fileId - the ID of the file
|
|
56
|
+
* @param {Models.Jwt} [jwt] - optional JWT token generated via the Appwrite SDK
|
|
57
|
+
* @return {string} the generated view URL for the file
|
|
58
|
+
*/
|
|
59
|
+
export const getFileViewUrl = (endpoint, projectId, bucketId, fileId, jwt) => {
|
|
60
|
+
return `${endpoint}/storage/buckets/${bucketId}/files/${fileId}/view?project=${projectId}${jwt ? `&jwt=${jwt.jwt}` : ""}`;
|
|
61
|
+
};
|
|
62
|
+
/**
|
|
63
|
+
* Generates a download URL for a file based on the provided endpoint, project ID, bucket ID, file ID, and optionally a JWT.
|
|
64
|
+
*
|
|
65
|
+
* @param {string} endpoint - The base URL endpoint.
|
|
66
|
+
* @param {string} projectId - The ID of the project.
|
|
67
|
+
* @param {string} bucketId - The ID of the bucket.
|
|
68
|
+
* @param {string} fileId - The ID of the file.
|
|
69
|
+
* @param {Models.Jwt} [jwt] - Optional JWT object for authentication with Appwrite.
|
|
70
|
+
* @return {string} The complete download URL for the file.
|
|
71
|
+
*/
|
|
72
|
+
export const getFileDownloadUrl = (endpoint, projectId, bucketId, fileId, jwt) => {
|
|
73
|
+
return `${endpoint}/storage/buckets/${bucketId}/files/${fileId}/download?project=${projectId}${jwt ? `&jwt=${jwt.jwt}` : ""}`;
|
|
74
|
+
};
|
|
75
|
+
export const finalizeByAttributeMap = async (appwriteFolderPath, collection, item) => {
|
|
76
|
+
const schemaFolderPath = path.join(appwriteFolderPath, "schemas");
|
|
77
|
+
const zodSchema = await import(`${schemaFolderPath}/${toCamelCase(collection.name)}.ts`);
|
|
78
|
+
return zodSchema.parse({
|
|
79
|
+
...item.context,
|
|
80
|
+
...item.finalData,
|
|
81
|
+
});
|
|
82
|
+
};
|
|
83
|
+
export let numTimesFailedTotal = 0;
|
|
84
|
+
/**
|
|
85
|
+
* Tries to execute the given createFunction and retries up to 5 times if it fails.
|
|
86
|
+
* Only retries on transient errors (network failures, 5xx errors). Does NOT retry validation errors (4xx).
|
|
87
|
+
*
|
|
88
|
+
* @param {() => Promise<any>} createFunction - The function to be executed.
|
|
89
|
+
* @param {number} [attemptNum=0] - The number of attempts made so far (default: 0).
|
|
90
|
+
* @return {Promise<any>} - A promise that resolves to the result of the createFunction or rejects with an error if it fails after 5 attempts.
|
|
91
|
+
*/
|
|
92
|
+
export const tryAwaitWithRetry = async (createFunction, attemptNum = 0, throwError = false) => {
|
|
93
|
+
try {
|
|
94
|
+
return await createFunction();
|
|
95
|
+
}
|
|
96
|
+
catch (error) {
|
|
97
|
+
const errorMessage = error instanceof Error ? error.message.toLowerCase() : String(error).toLowerCase();
|
|
98
|
+
const errorCode = error.code;
|
|
99
|
+
// Check if this is a validation error that should NOT be retried
|
|
100
|
+
const isValidationError = errorCode === 400 || errorCode === 409 || errorCode === 422 ||
|
|
101
|
+
errorMessage.includes("already exists") ||
|
|
102
|
+
errorMessage.includes("attribute with the same key") ||
|
|
103
|
+
errorMessage.includes("invalid") && !errorMessage.includes("fetch failed") ||
|
|
104
|
+
errorMessage.includes("conflict") ||
|
|
105
|
+
errorMessage.includes("bad request");
|
|
106
|
+
// Check if this is a transient error that SHOULD be retried
|
|
107
|
+
const isTransientError = errorCode === 522 || errorCode === "522" || // Cloudflare error
|
|
108
|
+
errorCode >= 500 && errorCode < 600 || // 5xx server errors
|
|
109
|
+
errorMessage.includes("fetch failed") || // Network failures
|
|
110
|
+
errorMessage.includes("timeout") ||
|
|
111
|
+
errorMessage.includes("econnrefused") ||
|
|
112
|
+
errorMessage.includes("network error");
|
|
113
|
+
// Only retry if it's a transient error AND not a validation error
|
|
114
|
+
if (isTransientError && !isValidationError) {
|
|
115
|
+
if (errorCode === 522 || errorCode === "522") {
|
|
116
|
+
console.log("Cloudflare error. Retrying...");
|
|
117
|
+
}
|
|
118
|
+
else {
|
|
119
|
+
console.log(`Fetch failed on attempt ${attemptNum}. Retrying...`);
|
|
120
|
+
}
|
|
121
|
+
numTimesFailedTotal++;
|
|
122
|
+
if (attemptNum > 5) {
|
|
123
|
+
throw error;
|
|
124
|
+
}
|
|
125
|
+
await delay(2500);
|
|
126
|
+
return tryAwaitWithRetry(createFunction, attemptNum + 1);
|
|
127
|
+
}
|
|
128
|
+
// For validation errors or non-transient errors, throw immediately
|
|
129
|
+
if (throwError) {
|
|
130
|
+
throw error;
|
|
131
|
+
}
|
|
132
|
+
console.error("Error during retryAwait function: ", error);
|
|
133
|
+
// @ts-ignore
|
|
134
|
+
return Promise.resolve();
|
|
135
|
+
}
|
|
136
|
+
};
|
|
137
|
+
export const getAppwriteClient = (endpoint, projectId, apiKey) => {
|
|
138
|
+
return getClientWithAuth(endpoint, projectId, apiKey);
|
|
139
|
+
};
|
|
140
|
+
export const delay = (ms) => new Promise((resolve) => setTimeout(resolve, ms));
|
|
141
|
+
/**
|
|
142
|
+
* Calculates exponential backoff delay with configurable base and maximum
|
|
143
|
+
*
|
|
144
|
+
* @param retryCount - Current retry attempt number (0-indexed)
|
|
145
|
+
* @param baseDelay - Base delay in milliseconds (default: 2000)
|
|
146
|
+
* @param maxDelay - Maximum delay cap in milliseconds (default: 30000)
|
|
147
|
+
* @returns Calculated delay in milliseconds
|
|
148
|
+
*
|
|
149
|
+
* @example
|
|
150
|
+
* calculateExponentialBackoff(0) // Returns 2000
|
|
151
|
+
* calculateExponentialBackoff(1) // Returns 4000
|
|
152
|
+
* calculateExponentialBackoff(5) // Returns 30000 (capped)
|
|
153
|
+
*/
|
|
154
|
+
export const calculateExponentialBackoff = (retryCount, baseDelay = 2000, maxDelay = 30000) => {
|
|
155
|
+
return Math.min(baseDelay * Math.pow(2, retryCount), maxDelay);
|
|
156
|
+
};
|