configure.ts

/*
 * @adonisjs/limiter
 *
 * (c) AdonisJS
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

import string from '@adonisjs/core/helpers/string'
import type Configure from '@adonisjs/core/commands/configure'
import { stubsRoot } from './stubs/main.js'

/**
 * Available stores for selection
 */
const KNOWN_STORES = ['database', 'redis']

/**
 * Configures the limiter package
 */
export async function configure(command: Configure) {
  /**
   * Read store from the "--store" CLI flag
   */
  let selectedStore: string | undefined = command.parsedFlags.store

  /**
   * Display prompts when no store have been selected
   * via the CLI flag
   */
  if (!selectedStore) {
    selectedStore = await command.prompt.choice(
      'Select the storage layer you want to use',
      KNOWN_STORES,
      {
        validate(value) {
          return !value ? 'Please select a store' : true
        },
      }
    )
  }

  /**
   * Ensure the select store is valid
   */
  if (!KNOWN_STORES.includes(selectedStore!)) {
    command.exitCode = 1
    command.logger.logError(
      `Invalid limiter store "${selectedStore}". Supported stores are: ${string.sentence(
        KNOWN_STORES
      )}`
    )
    return
  }

  const codemods = await command.createCodemods()

  /**
   * Publish config file
   */
  await codemods.makeUsingStub(stubsRoot, 'config/limiter.stub', {
    store: selectedStore,
  })

  /**
   * Publish start/limiter file
   */
  await codemods.makeUsingStub(stubsRoot, 'start/limiter.stub', {})

  /**
   * Publish provider
   */
  await codemods.updateRcFile((rcFile) => {
    rcFile.addProvider('@adonisjs/limiter/limiter_provider')
  })

  /**
   * Publish migration when using database to store
   * rate limits
   */
  if (selectedStore === 'database') {
    await codemods.makeUsingStub(stubsRoot, 'make/migration/rate_limits.stub', {
      entity: command.app.generators.createEntity('rate_limits'),
      migration: {
        folder: 'database/migrations',
        fileName: `${new Date().getTime()}_create_rate_limits_table.ts`,
      },
    })
  }

  /**
   * Define env variables for the selected store
   */
  await codemods.defineEnvVariables({
    LIMITER_STORE: selectedStore!,
  })

  /**
   * Define env variables validation for the selected store
   */
  await codemods.defineEnvValidations({
    leadingComment: 'Variables for configuring the limiter package',
    variables: {
      LIMITER_STORE: `Env.schema.enum(['${selectedStore}', 'memory'] as const)`,
    },
  })
}