@adobe/aio-cli-plugin-app-storage 1.1.0 → 1.2.0-pre.2025-11-18.sha-9c4079ac

package/src/commands/app/db/collection/list.js

@@ -0,0 +1,100 @@
+/*
+Copyright 2025 Adobe. All rights reserved.
+This file is licensed to you under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License. You may obtain a copy
+of the License at http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed under
+the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+OF ANY KIND, either express or implied. See the License for the specific language
+governing permissions and limitations under the License.
+*/
+
+import { DBBaseCommand } from '../../../../DBBaseCommand.js'
+import chalk from 'chalk'
+import { Flags } from '@oclif/core'
+import { prettyJson } from '../../../../utils/output.js'
+import { makeTable } from '@oclif/table'
+
+export class List extends DBBaseCommand {
+  async run () {
+    const { info } = this.flags
+    try {
+      this.log(chalk.blue('Fetching collections...'))
+
+      const client = await this.db.connect()
+      const collectionInfo = await client.listCollections()
+
+      this.debugLogger?.info?.(`Retrieved ${collectionInfo.length} collections:`, collectionInfo)
+
+      this.log(chalk.green('Collection Information:'))
+      this.log(chalk.dim(`   Namespace: ${this.rtNamespace}`))
+
+      if (collectionInfo && collectionInfo.length > 0) {
+        this.log(chalk.dim(`   Total Collections: ${collectionInfo.length}`))
+
+        const formattedInfo = collectionInfo.map(col => {
+          const colInfo = {
+            name: col.name
+          }
+          if (info) {
+            colInfo.idIndex = `key: ${JSON.stringify(col.idIndex.key)}\nname: ${col.idIndex.name}`
+            colInfo.info = Object.entries(col.info).map(([key, value]) => {
+              return `${key}: ${JSON.stringify(value)}`
+            }).join('\n')
+
+            if (col.options?.validator) {
+              colInfo.validator = prettyJson(col.options.validator.$jsonSchema, 0)
+            }
+            if (col.options?.validationLevel) {
+              colInfo.validationLevel = prettyJson(col.options.validationLevel, 0)
+            }
+            if (col.options?.validationAction) {
+              colInfo.validationAction = prettyJson(col.options.validationAction, 0)
+            }
+          }
+
+          return colInfo
+        })
+        const table = makeTable({ data: formattedInfo, overflow: 'wrap', trimWhitespace: false })
+        this.log('   ' + table.replaceAll('\n', '\n   ').trimEnd())
+      } else {
+        this.log(chalk.dim('   No collections found'))
+      }
+
+      this.log(chalk.dim(`\n   Retrieved: ${new Date().toLocaleString()}`))
+
+      return info ? collectionInfo : collectionInfo.map(col => col.name)
+    } catch (error) {
+      this.debugLogger?.error?.('Error fetching collections', error)
+
+      this.log(chalk.red('Error fetching collections'))
+      this.log(chalk.dim(`   Namespace: ${this.rtNamespace}`))
+      this.log(chalk.dim(`   Error: ${error.message}`))
+
+      this.error(`Failed to fetch collections: ${error.message}`)
+    }
+  }
+}
+
+List.description = 'Get the list of collections in your App Builder database'
+
+List.examples = [
+  '$ aio app db collection list',
+  '$ aio app db collection list --info',
+  '$ aio app db collection list --json',
+  '$ aio app db col list --info --json'
+]
+
+List.flags = {
+  ...DBBaseCommand.flags,
+  info: Flags.boolean({
+    char: 'i',
+    description: 'Show detailed collection information instead of just names',
+    default: false
+  })
+}
+
+List.args = {}
+
+List.aliases = ['app:db:col:list', 'app:db:show:collections']

package/src/commands/app/db/collection/rename.js

@@ -0,0 +1,98 @@
+/*
+Copyright 2025 Adobe. All rights reserved.
+This file is licensed to you under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License. You may obtain a copy
+of the License at http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed under
+the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+OF ANY KIND, either express or implied. See the License for the specific language
+governing permissions and limitations under the License.
+*/
+
+import { DBBaseCommand } from '../../../../DBBaseCommand.js'
+import { Args } from '@oclif/core'
+import chalk from 'chalk'
+import { isNonEmptyString } from '../../../../utils/inputValidation.js'
+import { prettyJson } from '../../../../utils/output.js'
+
+export class RenameCollection extends DBBaseCommand {
+  async run () {
+    const { currentName, newName } = this.args
+
+    try {
+      this.log(chalk.blue(`Renaming collection '${currentName}' to '${newName}'...`))
+
+      const client = await this.db.connect()
+
+      // Get the collection object
+      const collection = client.collection(currentName)
+
+      // Rename the collection
+      const result = await collection.renameCollection(newName)
+
+      this.debugLogger?.info?.('Collection renamed successfully:', result)
+
+      const response = {
+        currentName,
+        newName,
+        status: 'renamed',
+        namespace: this.rtNamespace,
+        timestamp: new Date().toISOString(),
+        result
+      }
+
+      this.log(chalk.green(`Collection '${currentName}' renamed to '${newName}' successfully`))
+      this.log(chalk.dim(`   Namespace: ${this.rtNamespace}`))
+
+      if (result && typeof result === 'object' && Object.keys(result).length > 0) {
+        this.log(chalk.dim(`   Details:\n${prettyJson(result)}`))
+      }
+
+      this.log(chalk.dim(`   Renamed: ${new Date().toLocaleString()}`))
+
+      return response
+    } catch (error) {
+      this.debugLogger?.error?.('Error renaming collection:', error)
+
+      const errorMessage = `Failed to rename collection '${currentName}': ${error.message}`
+
+      this.log(chalk.red('Failed to rename collection'))
+      this.log(chalk.dim(`   Current: ${currentName}`))
+      this.log(chalk.dim(`   New: ${newName}`))
+      this.log(chalk.dim(`   Namespace: ${this.rtNamespace}`))
+      this.log(chalk.dim(`   Error: ${error.message}`))
+
+      this.error(errorMessage)
+    }
+  }
+}
+
+RenameCollection.description = 'Rename a collection in the database'
+
+RenameCollection.examples = [
+  '$ aio app db collection rename users customers',
+  '$ aio app db collection rename old_products new_products --json',
+  '$ aio app db col rename inventory stock'
+]
+
+RenameCollection.args = {
+  currentName: Args.string({
+    name: 'currentName',
+    description: 'The current name of the collection to rename',
+    required: true,
+    parse: input => isNonEmptyString(input, 'Current collection name')
+  }),
+  newName: Args.string({
+    name: 'newName',
+    description: 'The new name for the collection',
+    required: true,
+    parse: input => isNonEmptyString(input, 'New collection name')
+  })
+}
+
+RenameCollection.flags = {
+  ...DBBaseCommand.flags
+}
+
+RenameCollection.aliases = ['app:db:col:rename']

package/src/commands/app/db/collection/stats.js

@@ -0,0 +1,94 @@
+/*
+Copyright 2025 Adobe. All rights reserved.
+This file is licensed to you under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License. You may obtain a copy
+of the License at http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed under
+the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+OF ANY KIND, either express or implied. See the License for the specific language
+governing permissions and limitations under the License.
+*/
+
+import { DBBaseCommand } from '../../../../DBBaseCommand.js'
+import { Args } from '@oclif/core'
+import chalk from 'chalk'
+import { isNonEmptyString } from '../../../../utils/inputValidation.js'
+import { prettyJson } from '../../../../utils/output.js'
+
+export class StatsCollection extends DBBaseCommand {
+  async run () {
+    const { collection } = this.args
+
+    try {
+      this.log(chalk.blue(`Getting stats for collection '${collection}'...`))
+
+      const client = await this.db.connect()
+
+      // Get the collection object
+      const coll = client.collection(collection)
+
+      // Get collection-level statistics
+      const stats = await coll.stats()
+
+      this.debugLogger?.info?.('Collection stats retrieved successfully:', stats)
+
+      const response = {
+        collection,
+        stats,
+        namespace: this.rtNamespace,
+        timestamp: new Date().toISOString()
+      }
+
+      this.log(chalk.green(`Stats for collection '${collection}':`))
+      this.log(chalk.dim(`   Namespace: ${this.rtNamespace}`))
+
+      // Display stats in a formatted way
+      Object.entries(stats).forEach(([key, value]) => {
+        if (typeof value === 'object' && value !== null) {
+          this.log(chalk.dim(`   ${key}:\n${prettyJson(value)}`))
+        } else {
+          this.log(chalk.dim(`   ${key}: ${value}`))
+        }
+      })
+
+      this.log(chalk.dim(`   Retrieved: ${new Date().toLocaleString()}`))
+
+      return response
+    } catch (error) {
+      this.debugLogger?.error?.('Error getting collection stats:', error)
+
+      const errorMessage = `Failed to get stats for collection '${collection}': ${error.message}`
+
+      this.log(chalk.red('Failed to get collection stats'))
+      this.log(chalk.dim(`   Collection: ${collection}`))
+      this.log(chalk.dim(`   Namespace: ${this.rtNamespace}`))
+      this.log(chalk.dim(`   Error: ${error.message}`))
+
+      this.error(errorMessage)
+    }
+  }
+}
+
+StatsCollection.description = 'Get statistics for a collection in the database'
+
+StatsCollection.examples = [
+  '$ aio app db collection stats users',
+  '$ aio app db collection stats products --json',
+  '$ aio app db col stats inventory'
+]
+
+StatsCollection.args = {
+  collection: Args.string({
+    name: 'collection',
+    description: 'The name of the collection to get stats for',
+    required: true,
+    parse: input => isNonEmptyString(input, 'Collection name')
+  })
+}
+
+StatsCollection.flags = {
+  ...DBBaseCommand.flags
+}
+
+StatsCollection.aliases = ['app:db:col:stats']

package/src/commands/app/db/delete.js

@@ -0,0 +1,89 @@
+/*
+Copyright 2025 Adobe. All rights reserved.
+This file is licensed to you under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License. You may obtain a copy
+of the License at http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed under
+the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+OF ANY KIND, either express or implied. See the License for the specific language
+governing permissions and limitations under the License.
+*/
+
+import { DBBaseCommand } from '../../../DBBaseCommand.js'
+import chalk from 'chalk'
+import { Flags } from '@oclif/core'
+import { DB_STATUS } from '../../../constants/db.js'
+import { isProductionNamespace } from '../../../utils/inputValidation.js'
+
+export class DeleteDb extends DBBaseCommand {
+  async run () {
+    const namespace = this.rtNamespace
+
+    try {
+      // Check if the namespace is a production namespace
+      if (isProductionNamespace(namespace)) {
+        this.error('A production database may not be deleted directly. Please contact the App Builder team to have this database deleted.')
+      }
+
+      // eslint-disable-next-line node/no-unsupported-features/es-syntax
+      const { input } = await import('@inquirer/prompts')
+
+      if (!this.flags.force) {
+        process.stderr.write(chalk.red('❌ CAUTION, This action cannot be reverted and all stored data will be lost.') + '\n')
+
+        const res = await input({
+          message: chalk.yellow(`confirm deletion by typing: '${namespace}'`)
+        })
+        if (res !== namespace) {
+          return this.error('confirmation did not match, aborted')
+        }
+      }
+
+      this.log(chalk.blue(`Proceeding to delete the database for the namespace: '${namespace}'...`))
+
+      const deleteResult = await this.db.deleteDatabase()
+      this.debugLogger?.info?.('Delete request result:', deleteResult)
+
+      const deleteStatus = deleteResult?.status?.toUpperCase() || DB_STATUS.UNKNOWN
+
+      if (deleteStatus === DB_STATUS.DELETED) {
+        this.log(chalk.green('Database deleted successfully'))
+        this.log(chalk.dim('Check database status: aio app db status'))
+      } else {
+        this.warn(`Delete request returned status '${deleteStatus}'`)
+        this.warn('If the issue persists, please contact the App Builder team.')
+      }
+
+      const result = {
+        status: deleteStatus,
+        namespace,
+        timestamp: new Date().toISOString(),
+        details: deleteResult
+      }
+
+      return result
+    } catch (error) {
+      this.debugLogger?.error?.('Delete command error:', error)
+      this.error(`Database deletion failed: ${error.message}`)
+    }
+  }
+}
+
+DeleteDb.description = 'Delete the database for your App Builder application (non-production only)'
+
+DeleteDb.examples = [
+  '$ aio app db delete',
+  '$ aio app db delete --force',
+  '$ aio app db delete --json'
+]
+
+DeleteDb.flags = {
+  ...DBBaseCommand.flags,
+  force: Flags.boolean({
+    description: '[use with caution!] force delete, skips confirmation safety prompt',
+    default: false
+  })
+}
+
+DeleteDb.args = {}

package/src/commands/app/db/document/count.js

@@ -0,0 +1,96 @@
+/*
+Copyright 2025 Adobe. All rights reserved.
+This file is licensed to you under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License. You may obtain a copy
+of the License at http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed under
+the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+OF ANY KIND, either express or implied. See the License for the specific language
+governing permissions and limitations under the License.
+*/
+
+import { DBBaseCommand } from '../../../../DBBaseCommand.js'
+import { Args } from '@oclif/core'
+import chalk from 'chalk'
+import { asObject, isNonEmptyString } from '../../../../utils/inputValidation.js'
+
+export class Count extends DBBaseCommand {
+  async run () {
+    const { collection, query } = this.args
+
+    try {
+      this.log(chalk.blue(`Counting documents in collection '${collection}'...`))
+
+      if (query) {
+        this.log(chalk.dim(`   Using query filter: ${JSON.stringify(query)}`))
+      }
+
+      const client = await this.db.connect()
+      const coll = client.collection(collection)
+
+      // Count documents
+      const count = await coll.countDocuments(query || {}, {})
+
+      this.debugLogger?.info?.('Document count:', count)
+
+      const response = {
+        collection,
+        query: query || {},
+        count,
+        namespace: this.rtNamespace,
+        timestamp: new Date().toISOString()
+      }
+
+      this.log(chalk.green(`Found ${count} document(s) in collection '${collection}'`))
+      this.log(chalk.dim(`   Namespace: ${this.rtNamespace}`))
+
+      if (query && Object.keys(query).length > 0) {
+        this.log(chalk.dim('   Query filter applied: Yes'))
+      }
+
+      this.log(chalk.dim(`   Counted: ${new Date().toLocaleString()}`))
+
+      return response
+    } catch (error) {
+      this.debugLogger?.error?.('Error counting documents:', error)
+
+      const errorMessage = `Failed to count documents in collection '${collection}': ${error.message}`
+
+      this.log(chalk.red('Failed to count documents'))
+      this.log(chalk.dim(`   Collection: ${collection}`))
+      this.log(chalk.dim(`   Namespace: ${this.rtNamespace}`))
+      this.error(errorMessage)
+    }
+  }
+}
+
+Count.description = 'Count documents in a collection'
+
+Count.examples = [
+  '$ aio app db document countDocuments users',
+  '$ aio app db document countDocuments users \'{"age": {"$gte": 21}}\'',
+  '$ aio app db document countDocuments products \'{"category": "electronics"}\' --json',
+  '$ aio app db doc count orders \'{"status": "shipped"}\''
+]
+
+Count.args = {
+  collection: Args.string({
+    name: 'collection',
+    description: 'The name of the collection',
+    required: true,
+    parse: input => isNonEmptyString(input, 'Collection name')
+  }),
+  query: Args.string({
+    name: 'query',
+    description: 'The query filter document (JSON string). If not provided, counts all documents.',
+    required: false,
+    parse: input => asObject(input, 'Query')
+  })
+}
+
+Count.flags = {
+  ...DBBaseCommand.flags
+}
+
+Count.aliases = ['app:db:doc:count']

package/src/commands/app/db/document/delete.js

@@ -0,0 +1,95 @@
+/*
+Copyright 2025 Adobe. All rights reserved.
+This file is licensed to you under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License. You may obtain a copy
+of the License at http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed under
+the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+OF ANY KIND, either express or implied. See the License for the specific language
+governing permissions and limitations under the License.
+*/
+
+import { DBBaseCommand } from '../../../../DBBaseCommand.js'
+import { Args } from '@oclif/core'
+import chalk from 'chalk'
+import { asObject, isNonEmptyString } from '../../../../utils/inputValidation.js'
+
+export class Delete extends DBBaseCommand {
+  async run () {
+    const { collection, filter } = this.args
+
+    try {
+      this.log(chalk.blue(`Deleting document from collection '${collection}'...`))
+
+      const client = await this.db.connect()
+      const coll = client.collection(collection)
+
+      // Delete the document
+      const result = await coll.deleteOne(filter)
+
+      this.debugLogger?.info?.('Document deleted successfully:', result)
+
+      const response = {
+        collection,
+        filter,
+        deletedCount: result.deletedCount,
+        acknowledged: result.acknowledged,
+        namespace: this.rtNamespace,
+        timestamp: new Date().toISOString(),
+        result
+      }
+
+      if (result.deletedCount > 0) {
+        this.log(chalk.green(`Document deleted successfully from collection '${collection}'`))
+        this.log(chalk.dim(`   Namespace: ${this.rtNamespace}`))
+      } else {
+        this.log(chalk.yellow(`No document found in collection '${collection}' matching the filter`))
+        this.log(chalk.dim(`   Namespace: ${this.rtNamespace}`))
+      }
+
+      this.log(chalk.dim(`   Deleted: ${new Date().toLocaleString()}`))
+
+      return response
+    } catch (error) {
+      this.debugLogger?.error?.('Error deleting document:', error)
+
+      const errorMessage = `Failed to delete document from collection '${collection}': ${error.message}`
+
+      this.log(chalk.red('Failed to delete document'))
+      this.log(chalk.dim(`   Collection: ${collection}`))
+      this.log(chalk.dim(`   Namespace: ${this.rtNamespace}`))
+
+      this.error(errorMessage)
+    }
+  }
+}
+
+Delete.description = 'Delete a single document from a collection'
+
+Delete.examples = [
+  '$ aio app db document delete users \'{"name": "John"}\'',
+  '$ aio app db document delete products \'{"id": "123"}\' --json',
+  '$ aio app db doc delete posts \'{"status": "draft"}\''
+]
+
+Delete.args = {
+  collection: Args.string({
+    name: 'collection',
+    description: 'The name of the collection',
+    required: true,
+    parse: input => isNonEmptyString(input, 'Collection name')
+  }),
+  filter: Args.string({
+    name: 'filter',
+    description: 'The filter document (JSON string)',
+    required: true,
+    parse: input => asObject(input, 'Filter')
+  })
+}
+
+Delete.flags = {
+  ...DBBaseCommand.flags
+}
+
+Delete.aliases = ['app:db:doc:delete']