@adobe/aio-cli-plugin-app-storage 1.2.0 → 1.3.0-pre.2026-02-20.sha-df98265c

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

@@ -0,0 +1,82 @@
+/*
+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 List extends DBBaseCommand {
+  async run () {
+    const { collection } = this.args
+
+    try {
+      this.log(chalk.blue(`Getting indexes from collection '${collection}'...`))
+
+      const client = await this.db.connect()
+      const coll = await client.collection(collection)
+
+      const result = await coll.getIndexes()
+
+      this.debugLogger?.info?.('Indexes retrieved successfully:', result)
+
+      const response = {
+        collection,
+        namespace: this.rtNamespace,
+        timestamp: new Date().toISOString(),
+        indexes: result
+      }
+
+      this.log(chalk.green('Indexes retrieved successfully'))
+      this.log(chalk.dim(`   Namespace: ${this.rtNamespace}`))
+      this.log(chalk.dim(`   Retrieved: ${new Date().toLocaleString()}`))
+      if (result && Array.isArray(result) && result.length > 0) {
+        this.log(chalk.dim(`   Indexes:\n${prettyJson(result)}`))
+      } else {
+        this.log(chalk.dim('   No indexes found for this collection'))
+      }
+
+      return response
+    } catch (error) {
+      this.debugLogger?.error?.('Error getting indexes:', error)
+
+      this.log(chalk.red('Failed to retrieve indexes'))
+      this.log(chalk.dim(`   Collection: ${collection}`))
+      this.log(chalk.dim(`   Namespace: ${this.rtNamespace}`))
+      this.log(chalk.dim(`   Error: ${error.message}`))
+
+      this.error(`Failed to retrieve indexes from collection '${collection}': ${error.message}`)
+    }
+  }
+}
+
+List.description = 'Get the list of indexes from a collection in the database'
+
+List.examples = [
+  '$ aio app db index list users',
+  '$ aio app db index list products --json',
+  '$ aio app db idx list orders'
+]
+
+List.args = {
+  collection: Args.string({
+    name: 'collection',
+    description: 'The name of the collection to retrieve indexes from',
+    required: true,
+    parse: input => isNonEmptyString(input, 'Collection name')
+  })
+}
+
+List.flags = DBBaseCommand.flags
+
+List.aliases = ['app:db:idx:list']

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

@@ -0,0 +1,111 @@
+/*
+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 { prettyJson } from '../../../../utils/output.js'
+import { Flags } from '@oclif/core'
+
+export class OrgStats extends DBBaseCommand {
+  async run () {
+    const { scale } = this.flags
+    try {
+      this.log(chalk.blue('Fetching organization\'s database statistics...'))
+
+      const client = await this.db.connect()
+      const stats = await client.orgStats({ scale })
+
+      this.debugLogger?.info?.('Organization database statistics retrieved:', stats)
+
+      const result = {
+        ...stats,
+        timestamp: new Date().toISOString()
+      }
+
+      this.displayStats(stats)
+
+      return result
+    } catch (error) {
+      this.debugLogger?.error?.('OrgStats command error:', error)
+
+      this.log(chalk.red('Failed to retrieve organization database statistics'))
+      this.log(chalk.dim(`   Namespace: ${this.rtNamespace}`))
+      this.log(chalk.dim(`   Error: ${error.message}`))
+
+      this.error(`Failed to fetch organization database statistics: ${error.message}`)
+    }
+  }
+
+  displayStats (stats) {
+    const { ok, databaseStats, ...orgStats } = stats || {}
+
+    // Display combined stats first
+    this.log(chalk.green('Organization Totals:'))
+    if (orgStats && typeof orgStats === 'object' && Object.keys(orgStats).length > 0) {
+      Object.entries(orgStats).forEach(([key, value]) => {
+        this.log(chalk.dim(`   ${key}: ${this.formatValue(value)}`))
+      })
+    } else {
+      this.log(chalk.dim(`   Raw Stats: ${this.formatValue(orgStats)}`))
+    }
+
+    this.log('')
+    if (databaseStats && Array.isArray(databaseStats) && databaseStats.length > 0) {
+      this.log(chalk.green('Database Statistics:'))
+      databaseStats.forEach((dbStats) => {
+        const { namespace, ...otherStats } = dbStats
+        this.log(chalk.dim(`   Namespace '${namespace}':`))
+        Object.entries(otherStats).forEach(([key, value]) => {
+          this.log(chalk.dim(`      ${key}: ${this.formatValue(value, 3)}`))
+        })
+        this.log('')
+      })
+    }
+
+    this.log(chalk.dim(`   Retrieved: ${new Date().toISOString()}`))
+  }
+
+  formatValue (value) {
+    if (typeof value === 'number') {
+      // Format large numbers with commas
+      return value.toLocaleString()
+    }
+    if (value instanceof Date) {
+      return value.toISOString()
+    }
+    if (typeof value === 'object' && value !== null) {
+      return `\n${prettyJson(value)}`
+    }
+    return String(value)
+  }
+}
+
+OrgStats.description = 'Get combined statistics about the App Builder databases in your organization'
+
+OrgStats.examples = [
+  '$ aio app db org stats',
+  '$ aio app db org stats --scale 1024',
+  '$ aio app db org stats --json'
+]
+
+OrgStats.flags = {
+  ...DBBaseCommand.flags,
+  scale: Flags.integer({
+    char: 's',
+    description: 'Scale factor for size-related statistics (e.g. 1024 for KB, 1048576 for MB).',
+    required: false,
+    default: 1,
+    min: 1
+  })
+}
+
+OrgStats.args = {}

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

@@ -0,0 +1,77 @@
+/*
+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'
+
+export class Ping extends DBBaseCommand {
+  async run () {
+    try {
+      this.log(chalk.blue('Testing database connectivity...'))
+
+      const startTime = Date.now()
+      const pingResult = await this.db.ping()
+      const endTime = Date.now()
+      const responseTime = endTime - startTime
+
+      this.debugLogger?.info?.(`Database ping completed in ${responseTime}ms:`, pingResult)
+
+      this.log(chalk.green('Database connection successful'))
+      this.log(chalk.dim(`   Namespace: ${this.rtNamespace}`))
+      this.log(chalk.dim(`   Response time: ${responseTime}ms`))
+
+      if (typeof pingResult === 'string') {
+        this.log(chalk.dim(`   Response: ${pingResult}`))
+      }
+
+      const result = {
+        status: 'success',
+        namespace: this.rtNamespace,
+        responseTime,
+        response: pingResult,
+        timestamp: new Date().toISOString()
+      }
+
+      this.log(chalk.dim('Database is ready for operations'))
+
+      return result
+    } catch (error) {
+      this.debugLogger?.error?.('Ping command error:', error)
+
+      this.log(chalk.red('Database connection failed'))
+      this.log(chalk.dim(`   Namespace: ${this.rtNamespace}`))
+      this.log(chalk.dim(`   Error: ${error.message}`))
+
+      const result = {
+        status: 'failed',
+        namespace: this.rtNamespace,
+        error: error.message,
+        timestamp: new Date().toISOString()
+      }
+
+      return result
+    }
+  }
+}
+
+Ping.description = 'Test connectivity to your App Builder database'
+
+Ping.examples = [
+  '$ aio app db ping',
+  '$ aio app db ping --json'
+]
+
+Ping.flags = {
+  ...DBBaseCommand.flags
+}
+
+Ping.args = {}

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

@@ -0,0 +1,190 @@
+/*
+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 { DB_STATUS } from '../../../constants/db.js'
+import { Flags } from '@oclif/core'
+
+export class Provision extends DBBaseCommand {
+  async run () {
+    const region = this.db.region
+
+    try {
+      // First check if database is already provisioned
+      this.log(chalk.blue('Checking current provisioning status...'))
+
+      let provisionStatusResponse
+      try {
+        provisionStatusResponse = await this.db.provisionStatus()
+        this.debugLogger?.info?.('Provision status:', provisionStatusResponse)
+      } catch (error) {
+        this.debugLogger?.info?.('No existing provisioning status found:', error.message)
+        provisionStatusResponse = null
+      }
+
+      if (provisionStatusResponse) {
+        const currentStatus = provisionStatusResponse.status.toUpperCase()
+        const statusRegion = provisionStatusResponse.region
+
+        if (currentStatus === DB_STATUS.PROVISIONED) {
+          this.log(chalk.green('Database is already provisioned and ready for use'))
+          this.log(chalk.dim(`   Namespace: ${this.rtNamespace}`))
+          this.log(chalk.dim(`   Region: ${statusRegion}`))
+          this.log(chalk.dim(`   Status: ${currentStatus}`))
+
+          return {
+            status: 'already_provisioned',
+            namespace: this.rtNamespace,
+            details: provisionStatusResponse
+          }
+        } else if (currentStatus === DB_STATUS.REQUESTED) {
+          this.log(chalk.yellow('Database provisioning request has been submitted and is pending'))
+          this.log(chalk.dim(`   Namespace: ${this.rtNamespace}`))
+          this.log(chalk.dim(`   Region: ${statusRegion}`))
+          this.log(chalk.dim(`   Status: ${currentStatus}`))
+          this.log(chalk.dim('\nUse "aio app db status --watch" to monitor progress'))
+
+          return {
+            status: 'in_progress',
+            namespace: this.rtNamespace,
+            details: provisionStatusResponse
+          }
+        } else if (currentStatus === DB_STATUS.PROCESSING) {
+          this.log(chalk.yellow('Database is currently being provisioned'))
+          this.log(chalk.dim(`   Namespace: ${this.rtNamespace}`))
+          this.log(chalk.dim(`   Region: ${statusRegion}`))
+          this.log(chalk.dim(`   Status: ${currentStatus}`))
+          this.log(chalk.dim('\nUse "aio app db status --watch" to monitor progress'))
+          this.log(chalk.red('If provisioning takes unusually long, please contact the App Builder team'))
+
+          return {
+            status: 'in_progress',
+            namespace: this.rtNamespace,
+            details: provisionStatusResponse
+          }
+        } else if (currentStatus === DB_STATUS.FAILED) {
+          this.log(chalk.red('Previous database provisioning failed'))
+          this.log(chalk.dim(`   Namespace: ${this.rtNamespace}`))
+          this.log(chalk.dim(`   Status: ${currentStatus}`))
+          this.log(chalk.yellow('\nAttempting to provision again...'))
+          this.log(chalk.red('If the problem persists, please contact the App Builder team'))
+        } else if (currentStatus === DB_STATUS.REJECTED) {
+          this.log(chalk.red('Previous database provisioning request was rejected'))
+          this.log(chalk.dim(`   Namespace: ${this.rtNamespace}`))
+          this.log(chalk.dim(`   Status: ${currentStatus}`))
+          this.log(chalk.yellow('\nAttempting to provision again...'))
+          this.log(chalk.red('If the problem persists, please contact the App Builder team for assistance'))
+        } else if (currentStatus !== DB_STATUS.NOT_PROVISIONED) {
+          this.log(chalk.yellow(`Database status is '${currentStatus}' - attempting to provision...`))
+          this.log(chalk.dim(`   Namespace: ${this.rtNamespace}`))
+          this.log(chalk.dim(`   Status: ${currentStatus}`))
+          this.log(chalk.red('If you encounter issues, please contact the App Builder team'))
+        }
+      }
+
+      // Create a new database if not yet provisioned
+      this.warn('Database provisioning will create new database resources')
+
+      // Skip confirmation prompt if --yes flag is used
+      if (!this.flags.yes) {
+        // eslint-disable-next-line node/no-unsupported-features/es-syntax
+        const { confirm } = await import('@inquirer/prompts')
+
+        const confirmed = await confirm({
+          message: `Provision database for namespace '${this.rtNamespace}'?`,
+          default: false
+        })
+
+        if (!confirmed) {
+          this.log('Database provisioning cancelled')
+          return { status: 'cancelled' }
+        }
+      }
+
+      // Start provisioning
+      this.log(chalk.blue(`Submitting a request for a database to be provisioned for the '${this.rtNamespace}' namespace...`))
+      this.log(chalk.dim(`   Namespace: ${this.rtNamespace}`))
+      this.log(chalk.dim(`   Region: ${region}`))
+
+      const provisionResult = await this.db.provisionRequest()
+      this.debugLogger?.info?.('Provision request result:', provisionResult)
+
+      // Handle different provision result statuses
+      const resultStatus = provisionResult?.status?.toUpperCase() || DB_STATUS.UNKNOWN
+
+      if (resultStatus === DB_STATUS.PROVISIONED) {
+        this.log(chalk.green('Database provisioned successfully and ready for use!'))
+      } else if (resultStatus === DB_STATUS.REQUESTED) {
+        this.log(chalk.blue('Database provisioning request submitted successfully'))
+        this.log(chalk.dim('Provisioning is now pending...'))
+      } else if (resultStatus === DB_STATUS.PROCESSING) {
+        this.log(chalk.yellow('Database is being provisioned...'))
+      } else if (resultStatus === DB_STATUS.FAILED) {
+        this.error(`Database provisioning failed: ${provisionResult.message || 'Unknown error'}`)
+      } else if (resultStatus === DB_STATUS.REJECTED) {
+        this.error(`Database provisioning request was rejected: ${provisionResult.message || 'Unknown reason'}`)
+      } else if (resultStatus === DB_STATUS.UNKNOWN) {
+        this.warn(`Database provisioning request returned unrecognized status '${provisionResult.status || 'undefined'}', an update to the aio cli tool may be necessary.`)
+        this.warn('If the issue persists, please contact the App Builder team.')
+      } else {
+        this.warn(`Database provisioning request returned unexpected status '${resultStatus}', an update to the aio cli tool may be necessary.`)
+        this.warn('If the issue persists, please contact the App Builder team.')
+      }
+
+      const result = {
+        status: resultStatus.toLowerCase(),
+        namespace: this.rtNamespace,
+        timestamp: new Date().toISOString(),
+        details: provisionResult
+      }
+
+      // If region was specified as a CLI flag, include it in the output for next steps
+      const { region: regionFlag } = this.flags
+      const regionFlagString = regionFlag ? ` --region ${regionFlag}` : ''
+
+      if (resultStatus !== DB_STATUS.PROVISIONED) {
+        this.log(chalk.dim('\nNext steps:'))
+        this.log(chalk.dim(`   - Monitor progress: aio app db status${regionFlagString} --watch`))
+        this.log(chalk.dim(`   - Check status: aio app db status${regionFlagString}`))
+      } else {
+        this.log(chalk.dim('\nNext steps:'))
+        this.log(chalk.dim(`   - Test connection: aio app db ping${regionFlagString}`))
+      }
+
+      return result
+    } catch (error) {
+      this.debugLogger?.error?.('Provision command error:', error)
+      this.error(`Database provisioning failed: ${error.message}`)
+    }
+  }
+}
+
+Provision.description = 'Provision a new database for your App Builder application'
+
+Provision.examples = [
+  '$ aio app db provision',
+  '$ aio app db provision --region amer',
+  '$ aio app db provision --json',
+  '$ aio app db provision --yes'
+]
+
+Provision.flags = {
+  ...DBBaseCommand.flags,
+  yes: Flags.boolean({
+    char: 'y',
+    description: 'Skip confirmation prompt and provision automatically',
+    default: false
+  })
+}
+
+Provision.args = {}

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

@@ -0,0 +1,101 @@
+/*
+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 { prettyJson } from '../../../utils/output.js'
+import { Flags } from '@oclif/core'
+
+export class Stats extends DBBaseCommand {
+  async run () {
+    const { scale } = this.flags
+    try {
+      this.log(chalk.blue('Fetching database statistics...'))
+
+      const client = await this.db.connect()
+      const stats = await client.dbStats({ scale })
+
+      this.debugLogger?.info?.('Database statistics retrieved:', stats)
+
+      const result = {
+        ...stats,
+        namespace: this.rtNamespace,
+        timestamp: new Date().toISOString()
+      }
+
+      this.displayStats(stats)
+
+      return result
+    } catch (error) {
+      this.debugLogger?.error?.('Stats command error:', error)
+
+      this.log(chalk.red('Failed to retrieve database statistics'))
+      this.log(chalk.dim(`   Namespace: ${this.rtNamespace}`))
+      this.log(chalk.dim(`   Error: ${error.message}`))
+
+      this.error(`Failed to fetch database statistics: ${error.message}`)
+    }
+  }
+
+  displayStats (stats) {
+    this.log(chalk.green('Database Statistics:'))
+    this.log(chalk.dim(`   Namespace: ${this.rtNamespace}`))
+
+    if (stats && typeof stats === 'object') {
+      const { ok, ...statsWithoutOk } = stats
+      // Format and display stats in a readable way
+      Object.entries(statsWithoutOk).forEach(([key, value]) => {
+        this.log(chalk.dim(`   ${key}: ${this.formatValue(value)}`))
+      })
+    } else {
+      this.log(chalk.dim(`   Raw Stats: ${this.formatValue(stats)}`))
+    }
+
+    this.log('')
+    this.log(chalk.dim(`   Retrieved: ${new Date().toISOString()}`))
+  }
+
+  formatValue (value) {
+    if (typeof value === 'number') {
+      // Format large numbers with commas
+      return value.toLocaleString()
+    }
+    if (value instanceof Date) {
+      return value.toISOString()
+    }
+    if (typeof value === 'object' && value !== null) {
+      return `\n${prettyJson(value)}`
+    }
+    return String(value)
+  }
+}
+
+Stats.description = 'Get statistics about your App Builder database'
+
+Stats.examples = [
+  '$ aio app db stats',
+  '$ aio app db stats --scale 1024',
+  '$ aio app db stats --json'
+]
+
+Stats.flags = {
+  ...DBBaseCommand.flags,
+  scale: Flags.integer({
+    char: 's',
+    description: 'Scale factor for size-related statistics (e.g. 1024 for KB, 1048576 for MB).',
+    required: false,
+    default: 1,
+    min: 1
+  })
+}
+
+Stats.args = {}