AdonisJS Plus

https://plus.adonisjs.com/docs
Admin
AdonisJS Plus offers production-ready full-stack components, premium packages, and AI tooling that...
Tokens:44,793
Snippets:616
Trust Score:10
Update:3 months ago
Show doc for...
Tokens:
Raw
### Install Flow Harness for Copilot

Source: https://plus.adonisjs.com/docs/flow/agents/copilot

Run the harness installer to begin the setup process for GitHub Copilot integration.

```bash
node ace flow:install
```

--------------------------------

### Styling Prompt Example for Coding Agent

Source: https://plus.adonisjs.com/docs/kit/react/installation

An example prompt to guide a coding agent in re-designing a React page while preserving specific functional elements.

```bash
I want you to scan this codebase and understand how we have styled the application. Once, you have enough understanding:

Re-design the account activation page at `inertia/pages/account/activate.tsx`. Keep the following unchanged:

- All form field name attributes
- The Form component's route prop
- Current approach of handling and displaying server-side errors.
- The routeParams props on Form and Link components

```

--------------------------------

### Install TOTP Dependencies

Source: https://plus.adonisjs.com/docs/packages/persona/totp-management

Install the necessary npm packages for TOTP generation and QR code rendering. Ensure to install types for qrcode as a development dependency.

```bash
npm install otpauth qrcode
npm install -D @types/qrcode
```

--------------------------------

### Verify Kit CLI Installation

Source: https://plus.adonisjs.com/docs/kit/api/installation

Verify that the Kit CLI has been installed correctly by running the 'kit:list' command. This confirms the CLI is accessible and functional.

```bash
node ace kit:list
```

--------------------------------

### Verify Kit CLI Installation

Source: https://plus.adonisjs.com/docs/kit/hypermedia/installation

Checks if the Kit CLI was installed successfully by displaying its help information.

```bash
node ace kit:add --help
```

--------------------------------

### Install Flow Harness for Codex CLI

Source: https://plus.adonisjs.com/docs/flow/agents/codex

Run the harness installer. Select OpenAI Codex CLI when prompted or use the --agent flag to target it directly.

```bash
node ace flow:install
```

```bash
node ace flow:install --agent=codex
```

--------------------------------

### Run the Flow Installer Non-interactively

Source: https://plus.adonisjs.com/docs/flow/installation

Use this command for automated or scripted installations. Flags allow you to pre-select options like agent, stack, packages, and skills. The '*' wildcard installs all available options for packages and skills.

```bash
node ace flow:install --agent=claude --stack=api --package="*" --skill="*"
```

--------------------------------

### Flow Harness Docs Index and Project Facts

Source: https://plus.adonisjs.com/docs/flow/installation

This block is managed by the Flow installer and contains the index for harness documentation and project facts like stack and package manager. It guides the agent on where to find documentation and project specifics.

```markdown
<!-- FLOW-DOCS-INDEX-START -->

[AdonisJS Harness Docs Index]|root: ./.flow/docs|STOP. What you remember about
AdonisJS may be wrong for this project. Read the relevant harness doc first and
treat it as the primary working reference for framework and app tasks.|topics:{
routing.md: HTTP routing|controllers.md: Controllers|...}

<!-- FLOW-DOCS-INDEX-END -->
<!-- FLOW-PROJECT-FACTS-START -->

[Project Facts]|stack: api|packageManager: npm|appRoot: ./|node: >=24.0.0

<!-- FLOW-PROJECT-FACTS-END -->

```

--------------------------------

### Styling Prompt Example

Source: https://plus.adonisjs.com/docs/kit/hypermedia/installation

An example prompt for a coding agent to re-design a specific page while preserving critical form and error handling elements.

```text
I want you to scan this codebase and understand how we have styled the application. Once, you have enough understanding:

Re-design the account activation page at `pages/account/activate.edge`. Keep the following unchanged:

- All form field name attributes
- The `@form` component's route prop
- Current approach of handling and displaying server-side errors.
- The usage of form field components and the `@link` component.


```

--------------------------------

### Install Flow Harness Targeting OpenCode Directly

Source: https://plus.adonisjs.com/docs/flow/agents/opencode

To target OpenCode directly and skip the agent prompt, use the --agent flag with the installer.

```bash
node ace flow:install --agent=opencode
```

--------------------------------

### Start a New Change with Brief Skill

Source: https://plus.adonisjs.com/docs/flow/spec-driven-development/brief

Invoke the 'brief' skill with a short name to start a new change. This name determines the folder under `.flow/changes/` where the skill's output will be stored.

```bash
/flow-brief project-archiving
```

--------------------------------

### Install Kit CLI

Source: https://plus.adonisjs.com/docs/kit/api/installation

Install the Kit CLI package using npm or yarn. This command adds the necessary package to your project's dependencies.

```bash
node ace add @adonisjs/kit
```

--------------------------------

### Install Kit CLI

Source: https://plus.adonisjs.com/docs/kit/hypermedia/installation

Installs the Kit CLI package using the AdonisJS package manager.

```bash
node ace add @adonisplus/kit
```

--------------------------------

### Install Permissions Package

Source: https://plus.adonisjs.com/docs/packages/permissions/quick-start

Install the @adonisplus/permissions package using npm.

```bash
npm i @adonisplus/permissions
```

--------------------------------

### Install Flow Harness Targeting Copilot Directly

Source: https://plus.adonisjs.com/docs/flow/agents/copilot

Use the --agent flag to specifically target Copilot during installation, bypassing the agent prompt.

```bash
node ace flow:install --agent=copilot
```

--------------------------------

### Install @adonisjs/ally

Source: https://plus.adonisjs.com/docs/packages/persona/social-identity

Install the @adonisjs/ally package as a peer dependency to enable social identity features.

```bash
node ace add @adonisjs/ally
```

--------------------------------

### Install Bouncer Package

Source: https://plus.adonisjs.com/docs/packages/permissions/quick-start

Install the AdonisJS Bouncer package, which is a prerequisite for the permissions package. This command also handles initial configuration and middleware setup.

```bash
node ace add @adonisjs/bouncer
```

--------------------------------

### Invoke Build Skill for a Project

Source: https://plus.adonisjs.com/docs/flow/spec-driven-development/build

Invoke the build skill with the project name to start the build process.

```bash
/flow-build project-archiving
```

--------------------------------

### Routing Documentation Structure

Source: https://plus.adonisjs.com/docs/flow/knowledge-base/introduction

This is an example of a cookbook-style documentation structure for routing. It includes a 'read when' trigger for quick relevance assessment, recommended defaults, valid alternatives, and patterns to avoid.

```markdown
# Routing

## Contents

Read when defining, organizing, or extending routes in `start/routes.ts`.

- Defining handlers and controller-backed routes
- Validating and shaping route params

## Recommended Defaults

- Define routes in `start/routes.ts`. Import the router via
  `import router from '@adonisjs/core/services/router'`.
- Wire controller-backed routes via `[controllers.<Name>, 'action']`.

## Valid Alternatives

- Use inline route handlers when route logic is small and does not
  justify a controller.

## Avoid By Default

- ...

```

--------------------------------

### Install Dependencies with Auth Token for Platforms without Docker

Source: https://plus.adonisjs.com/docs/packages/installation

Appends the auth token to .npmrc, installs dependencies, and then removes the .npmrc file to prevent token persistence. This is suitable for platforms like Railway or Render.

```bash
echo "//plus.adonisjs.com/registry/:_authToken=${NPM_TOKEN}" >> .npmrc && npm ci && rm -f .npmrc
```

--------------------------------

### Install Flow Harness Targeting Claude Code Directly

Source: https://plus.adonisjs.com/docs/flow/agents/claude-code

Use the --agent flag to specify Claude Code as the target agent, bypassing the agent selection prompt during installation.

```bash
node ace flow:install --agent=claude
```

--------------------------------

### Install Flow Harness Targeting Cursor Directly

Source: https://plus.adonisjs.com/docs/flow/agents/cursor

Use the --agent flag to specifically target Cursor during the Flow harness installation, bypassing the agent selection prompt.

```bash
node ace flow:install --agent=cursor
```

--------------------------------

### Defining Permissions with AdonisJS Plus

Source: https://plus.adonisjs.com/docs/packages/introduction

This example demonstrates defining permissions using a resource/action pattern with prefixes and custom descriptions in AdonisJS.

```typescript
import { definePermissions, prefix } from '@adonisplus/permissions'

export const permissions = definePermissions(
  prefix('admin', {
    product: { create: true, update: true, delete: true },
  }),
  {
    billing: { refund: 'Issue refunds' },
  }
)

```

--------------------------------

### Install AdonisJS Plus Packages

Source: https://plus.adonisjs.com/docs/packages/installation

Installs specific AdonisJS Plus packages like Persona and Permissions after configuring npm authentication.

```npm
npm install @adonisplus/persona

```

```npm
npm install @adonisplus/permissions

```

--------------------------------

### Start Development Server and Access Dashboard

Source: https://plus.adonisjs.com/docs/flow/dashboard

Start your Ace development server with the --hmr flag. Once the server is running, navigate to the /__dashboard route in your browser to access the Flow Dashboard. This command is used for local development purposes.

```bash
node ace serve --hmr
# Then visit http://localhost:3333/__dashboard
```

--------------------------------

### Authenticate with Plus Registry in GitHub Actions

Source: https://plus.adonisjs.com/docs/packages/installation

Appends the authentication token to the .npmrc file before installing dependencies. Ensure NPM_TOKEN is set as a repository secret.

```yaml
steps:
  - uses: actions/checkout@v4

  - uses: actions/setup-node@v4
    with:
      node-version: 22

  - name: Authenticate with Plus registry
    run: echo "//plus.adonisjs.com/registry/:_authToken=${NPM_TOKEN}" >> .npmrc
    env:
      NPM_TOKEN: ${{ secrets.NPM_TOKEN }}

  - name: Install dependencies
    run: npm ci
```

--------------------------------

### Invoke a Flow Skill in Copilot Chat

Source: https://plus.adonisjs.com/docs/flow/agents/copilot

Skills installed with Flow are surfaced as slash commands in Copilot Chat. Use the '/flow.<skill_name>' pattern to invoke them.

```bash
/flow.brief checkout-redesign
```

--------------------------------

### Route to Controller Method Mapping

Source: https://plus.adonisjs.com/docs/flow/engineering/cruddy-controllers

Examples of mapping HTTP routes to specific controller methods. A POST /login route maps to SessionsController.store, and a DELETE /logout route maps to SessionsController.destroy.

```text
POST   /login    → SessionsController.store
DELETE /logout   → SessionsController.destroy
```

--------------------------------

### Add Flow Package to AdonisJS Project

Source: https://plus.adonisjs.com/docs/flow/installation

Use this command to install the `@adonisplus/flow` package. It also configures Ace commands and registers the Flow Dashboard provider.

```bash
node ace add @adonisplus/flow
```

--------------------------------

### Resolve Social Identity with All Hooks

Source: https://plus.adonisjs.com/docs/packages/persona/social-identity

Handles social login/signup by resolving a provider identity. This example demonstrates using all available hooks (`onLinked`, `onNewUser`, `onLinkRequired`) within a transaction.

```typescript
const result = await User.resolveSocialIdentity(provider, socialUser, {
  onLinked: async (trx, event) => {
    // event: { status: 'linked', user }
    return { status: 'login' as const, user: event.user }
  },
  onNewUser: async (trx, event) => {
    // event: { status: 'new' }
    const user = await User.create({ email: socialUser.email }, { client: trx })
    await user.linkSocialIdentity(provider, socialUser)
    return { status: 'signup_verified' as const, user }
  },
  onLinkRequired: async (trx, event) => {
    // event: { status: 'link_required', email, provider, user }
    return { status: 'collision' as const, user: event.user }
  },
})
```

--------------------------------

### Get Enrollment Secret

Source: https://plus.adonisjs.com/docs/packages/persona/totp-management

Returns the decrypted pending TOTP secret. This is useful for manual entry when a user cannot scan a QR code. Throws an error if enrollment has not started.

```typescript
const secret = user.getEnrollmentSecret().release()
```

--------------------------------

### Configure Permissions Package

Source: https://plus.adonisjs.com/docs/packages/permissions/quick-start

Run the configure command to set up the permissions package. This creates necessary files, middleware, and registers the service provider.

```bash
node ace configure @adonisplus/permissions
```

--------------------------------

### Get TOTP Secret URI

Source: https://plus.adonisjs.com/docs/packages/persona/totp-management

Retrieves the `otpauth://` URI for the pending TOTP secret. This is used to generate QR codes or for manual entry into authenticator apps. Throws an error if enrollment has not started.

```typescript
const uri = user.getSecretUri()
```

--------------------------------

### Create Access Instances

Source: https://plus.adonisjs.com/docs/packages/permissions/defining-permissions

Instantiate `Access` objects using `createAccess` for an empty instance that you can populate later, or `createAccessFor` to pre-populate it with an entity's resolved permissions.

```javascript
const access = permissions.createAccess()

const access = await permissions.createAccessFor(user)
```

--------------------------------

### Add Hypermedia Component

Source: https://plus.adonisjs.com/docs/kit/hypermedia/installation

Adds a hypermedia component (e.g., 'login') to your project using the Kit CLI. Review terminal output for manual file modifications.

```bash
node ace kit:add login --hypermedia
```

--------------------------------

### Generate Roles Migration

Source: https://plus.adonisjs.com/docs/packages/permissions/managing-roles

Run this command to create the migration file for the roles table.

```bash
node ace make:migration roles
```

--------------------------------

### Generate Migration for Email Verification Tokens Table

Source: https://plus.adonisjs.com/docs/packages/persona/email-management

Use this command to create a migration file for the 'email_verification_tokens' table.

```bash
node ace make:migration create_email_verification_tokens
```

--------------------------------

### Add Login Component with API Variant

Source: https://plus.adonisjs.com/docs/kit/api/installation

Add a login component to your project using the 'kit:add' command with the '--api' flag. This command copies necessary files and modifies existing ones, printing manual instructions if needed.

```bash
node ace kit:add login --api
```

--------------------------------

### Run Database Migrations

Source: https://plus.adonisjs.com/docs/packages/permissions/managing-permissions

Executes all pending database migrations.

```bash
node ace migration:run
```

--------------------------------

### Invoke task skill with change name and description

Source: https://plus.adonisjs.com/docs/flow/spec-driven-development/task

Use this command to initiate the task skill, providing a change name and an optional description of the work to be done.

```bash
/flow-task lucid-v22-upgrade "migrate the app to Lucid v22"
```

--------------------------------

### Invoke Assert Skill

Source: https://plus.adonisjs.com/docs/flow/spec-driven-development/assert

Invoke the assert skill with the change name to start the test planning process.

```bash
/flow-assert project-archiving
```

--------------------------------

### Get Specific Social Identity

Source: https://plus.adonisjs.com/docs/packages/persona/social-identity

Fetches a single linked `SocialIdentity` row for the user by its primary key.

```typescript
const identity = await user.getSocialIdentity(identityId)
```

--------------------------------

### Add React Component using Kit CLI

Source: https://plus.adonisjs.com/docs/kit/react/installation

Add a new component, specifically for React, using the Kit CLI.

```bash
node ace kit:add login --react
```

--------------------------------

### Get Remaining Recovery Codes Count

Source: https://plus.adonisjs.com/docs/packages/persona/totp-management

Access the `remainingRecoveryCodesCount` property to check the number of available recovery codes for the user.

```typescript
user.remainingRecoveryCodesCount
```

--------------------------------

### Create Access Instance from User

Source: https://plus.adonisjs.com/docs/packages/permissions/access-control

Use `createAccessFor` to load a user's permissions and resolve them. The user must implement `getPermissions()`.

```typescript
import { permissions } from '#start/permissions'

const access = await permissions.createAccessFor(user)
access.allows('product.create') // true or false
```

--------------------------------

### Permissions Instance Methods

Source: https://plus.adonisjs.com/docs/packages/permissions/defining-permissions

Detailed explanations of the methods available on the Permissions instance for managing and querying permissions.

```APIDOC
## Permissions Instance Methods

### `all()`

**Description**: Returns all permissions as an array of objects with `key`, `description`, `inactive`, and `aliases` properties.

**Method**: `permissions.all()`

### `keys()`

**Description**: Returns all permission keys as strings, including inactive ones.

**Method**: `permissions.keys()`

### `active()`

**Description**: Returns only active permission keys.

**Method**: `permissions.active()`

### `getKey(key)`

**Description**: Returns the key as-is. Exists for compile-time type safety. Throws if the key is not defined.

**Method**: `permissions.getKey('product.create')`

### `filterKeys(rawKeys)`

**Description**: Takes raw permission strings (from the database or tokens), resolves aliases, removes inactive and unknown keys. Returns the filtered list of canonical keys.

**Method**: `permissions.filterKeys(rawKeys)`

### `createAccess()`

**Description**: Creates a new empty `Access` instance tied to this permission definition. Call `access.use(rawKeys)` to populate it.

**Method**: `const access = permissions.createAccess()`

### `createAccessFor(entity)`

**Description**: Creates an `Access` instance pre-populated with the entity's resolved permissions. The entity must implement `getPermissions()`.

**Method**: `const access = await permissions.createAccessFor(user)`

### `abilities()`

**Description**: Returns an object of Bouncer abilities, one per active permission key. See the Bouncer integration guide.

**Method**: `const abilities = permissions.abilities()`
```

--------------------------------

### Get TOTP Account Label

Source: https://plus.adonisjs.com/docs/packages/persona/totp-management

Returns the account label used by authenticator apps to identify the account. Defaults to the user's email, but can be customized.

```typescript
user.getTotpLabel()
```

--------------------------------

### Seed Roles and Assign Permissions

Source: https://plus.adonisjs.com/docs/packages/permissions/quick-start

Create roles and assign specific permissions using `givePermissions` or sync all available permissions using `syncPermissions` and `permissions.active()`.

```typescript
import { permissions } from '#start/permissions'
import Role from '#models/role'

const editor = await Role.create({ name: 'editor' })
await editor.givePermissions([
  permissions.getKey('product.create'),
  permissions.getKey('product.update'),
])

const admin = await Role.create({ name: 'admin' })
await admin.syncPermissions(permissions.active())
```

--------------------------------

### Get User's Roles

Source: https://plus.adonisjs.com/docs/packages/permissions/managing-roles

Retrieve all roles assigned to a user. If roles are preloaded, this method returns them directly without an additional database query.

```typescript
const roles = await user.getRoles()
```

--------------------------------

### Create Access Instance from Raw Keys

Source: https://plus.adonisjs.com/docs/packages/permissions/access-control

Manually populate an Access instance using the `use` method for lower-level control. The `use` method resolves aliases and filters keys.

```typescript
const access = permissions.createAccess()
access.use(['product.create', 'product.update', 'product.remove'])
```

--------------------------------

### Retrieve Bouncer Abilities

Source: https://plus.adonisjs.com/docs/packages/permissions/defining-permissions

Obtain an object containing Bouncer abilities, where each key corresponds to an active permission. Refer to the Bouncer integration guide for more details.

```javascript
const abilities = permissions.abilities()
```

--------------------------------

### Query All Permissions and Keys

Source: https://plus.adonisjs.com/docs/packages/permissions/defining-permissions

Use these methods to retrieve all defined permissions, including their metadata, or just their keys. This is helpful for displaying available permissions in UIs.

```javascript
permissions.all()

permissions.keys()

permissions.active()
```

--------------------------------

### Set npm Access Token

Source: https://plus.adonisjs.com/docs/kit/hypermedia/installation

Configure your global npm settings with your access token to authenticate with the private registry. Run this command once per machine.

```bash
npm config set "//plus.adonisjs.com/registry/:_authToken" your_token_here

```

--------------------------------

### Verify and Activate TOTP

Source: https://plus.adonisjs.com/docs/packages/persona/totp-management

Verifies the user-provided TOTP code against the pending secret and activates Two-Factor Authentication. Throws errors for invalid codes or if enrollment was not started.

```typescript
await user.enableTwoFactor(code)
```

--------------------------------

### Invoke Flow Skill in Codex CLI

Source: https://plus.adonisjs.com/docs/flow/agents/codex

Skills are invoked as slash commands using the pattern /flow-<skill-name>. For example, to invoke the 'brief' skill, use /flow-brief.

```bash
/flow-brief checkout-redesign
```

--------------------------------

### Access Instance `use` Method

Source: https://plus.adonisjs.com/docs/packages/permissions/access-control

Populate the Access instance with raw permission strings, resolving aliases and filtering inactive/unknown keys.

```typescript
access.use(['product.create', 'billing.refund'])
```

--------------------------------

### Implement task changes using the agent

Source: https://plus.adonisjs.com/docs/flow/spec-driven-development/task

Point your agent at the generated `workflow.md` file to execute the task's steps. The agent will process the steps sequentially, and upon completion, the change will be ready for syncing and archiving.

```bash
Implement changes/lucid-v22-upgrade/workflow.md

```

--------------------------------

### Check Billing Refund Permission in Controller

Source: https://plus.adonisjs.com/docs/packages/permissions/bouncer-integration

Use `bouncer.allows` to check if the user has the 'billing.refund' permission and get a boolean result. This is useful for conditionally rendering UI elements.

```typescript
import type { HttpContext } from '@adonisjs/core/http'

export default class BillingController {
  async index({ bouncer, view }: HttpContext) {
    const canRefund = await bouncer.allows('billing.refund')

    return view.render('billing/index', { canRefund })
  }
}
```

--------------------------------

### Generate User Roles Pivot Table Migration

Source: https://plus.adonisjs.com/docs/packages/permissions/managing-roles

Run this command to create the migration file for the pivot table linking users and roles.

```bash
node ace make:migration user_roles
```

--------------------------------

### Create User

Source: https://plus.adonisjs.com/docs/packages/persona/email-management

Creates a new user with an unverified email. Both `email` and `unverifiedEmail` should be set to the same value. Email addresses must be normalized to lowercase before submission.

```APIDOC
## POST /users

### Description
Creates a new user account. The email address provided will be set as both the primary and unverified email, marking the account as inactive until verification.

### Method
POST

### Endpoint
/users

### Parameters
#### Request Body
- **email** (string) - Required - The user's email address (must be lowercase).
- **password** (string) - Required - The user's password.

### Request Example
```json
{
  "email": "user@example.com",
  "password": "hashed_password"
}
```

### Response
#### Success Response (200)
- **user** (object) - The newly created user object.
- **token** (object) - The email verification token object.

#### Response Example
```json
{
  "user": {
    "id": "123",
    "email": "user@example.com",
    "unverifiedEmail": "user@example.com",
    "hasInactiveAccount": true,
    "hasActiveAccount": false
  },
  "token": {
    "value": "raw_token_value"
  }
}
```
```

--------------------------------

### Remove Flow Harness

Source: https://plus.adonisjs.com/docs/flow/installation

Execute this command to uninstall the Flow harness. It removes installed skills, strips the managed section from the context file, and deletes the .flow/docs/ directory, preserving your work in .flow/changes/.

```bash
node ace flow:uninstall
```

--------------------------------

### Generate Migration for Unverified Email Column

Source: https://plus.adonisjs.com/docs/packages/persona/email-management

Use this command to create a migration file for adding the 'unverified_email' column to the 'users' table.

```bash
node ace make:migration add_unverified_email_to_users --alter=users
```

--------------------------------

### Generate TOTP QR Code

Source: https://plus.adonisjs.com/docs/packages/persona/totp-management

Generates a QR code for TOTP enrollment as a base64-encoded data URL. This can be displayed to the user for easy scanning with authenticator apps. Throws an error if enrollment has not started.

```typescript
const dataUrl = await user.generateQRCode()
```

--------------------------------

### Build Docker Image Locally with BuildKit Secrets

Source: https://plus.adonisjs.com/docs/packages/installation

Command to build a Docker image locally, passing the NPM_TOKEN as a BuildKit secret. Avoid using ARG or --build-arg for tokens as they are saved in image history.

```bash
docker build --secret id=NPM_TOKEN,env=NPM_TOKEN -t your-app .
```

--------------------------------

### Register Social Auth Routes

Source: https://plus.adonisjs.com/docs/packages/persona/social-identity

Define POST and GET routes for social provider redirects and callbacks. The ':provider' segment allows a single route pair to serve all configured Ally drivers.

```typescript
import router from '@adonisjs/core/services/router'
import { controllers } from '#generated/controllers'

router.post('oauth/:provider/redirect', [controllers.SocialAuth, 'redirect'])
router.get('oauth/:provider/callback', [controllers.SocialAuth, 'callback'])
```

--------------------------------

### Define Permissions in start/permissions.ts

Source: https://plus.adonisjs.com/docs/packages/permissions/quick-start

Define your application's permissions in the start/permissions.ts file using the definePermissions function. Permissions follow the resource.action pattern and are type-safe.

```typescript
import { definePermissions } from '@adonisplus/permissions'

export const permissions = definePermissions({
  product: {
    create: 'Create new products',
    update: 'Update existing products',
    delete: 'Delete products permanently',
  },
  billing: {
    refund: 'Issue refunds to customers',
  },
})
```

--------------------------------

### Create Email Verification Tokens Table

Source: https://plus.adonisjs.com/docs/packages/persona/email-management

This migration sets up the 'email_verification_tokens' table to store hashed verification tokens, their associated user IDs, emails, and expiration timestamps.

```typescript
import { BaseSchema } from '@adonisjs/lucid/schema'

export default class extends BaseSchema {
  protected tableName = 'email_verification_tokens'

  async up() {
    this.schema.createTable(this.tableName, (table) => {
      table.increments('id')
      table.integer('tokenable_id').notNullable().unsigned()
      table.string('email').notNullable()
      table.string('hash', 80).notNullable()
      table.timestamp('created_at', { precision: 6, useTz: true }).notNullable()
      table.timestamp('expires_at', { precision: 6, useTz: true }).nullable()
    })
  }

  async down() {
    this.schema.dropTable(this.tableName)
  }
}
```

--------------------------------

### Create Email Verification Token with Throttling (Shortened)

Source: https://plus.adonisjs.com/docs/packages/persona/email-management

Creates a verification token with throttling enabled for a duration of '1 min'. Returns `null` if a token was created within this window.

```typescript
const token = await user.createEmailVerificationToken(true, '1 min')
```

--------------------------------

### Authorize Product Creation with Scoped Token Abilities

Source: https://plus.adonisjs.com/docs/packages/permissions/team-permissions

This controller action demonstrates how to authorize a user to create a product within a team. It retrieves the user's current access token abilities and uses them to scope the Bouncer authorization, ensuring the user has the necessary permissions granted by both their team roles and the token.

```typescript
import type { HttpContext } from '@adonisjs/core/http'
import { Bouncer } from '@adonisjs/bouncer'
import { permissions } from '#start/permissions'
import TeamMember from '#models/team_member'

const permissionAbilities = permissions.abilities()

export default class ProductsController {
  async store({ auth, params }: HttpContext) {
    const user = auth.getUserOrFail()
    const tokenAbilities = user.currentAccessToken?.abilities

    const member = await TeamMember.query()
      .where('teamId', params.teamId)
      .where('userId', user.id)
      .firstOrFail()

    const bouncer = new Bouncer(member, permissionAbilities)
    await bouncer.authorize('product.create', tokenAbilities)
  }
}
```

--------------------------------

### Define Basic Permissions

Source: https://plus.adonisjs.com/docs/packages/permissions/defining-permissions

Use `definePermissions` to create a `Permissions` instance. Actions can be defined as booleans, strings for descriptions, or objects for more control.

```typescript
import { definePermissions } from '@adonisplus/permissions'

export const permissions = definePermissions({
  product: {
    create: true,
    update: 'Update existing products',
    delete: {
      description: 'Delete products permanently',
    },
  },
  billing: {
    refund: 'Issue refunds to customers',
  },
})
```

--------------------------------

### Generate Team Members Migration

Source: https://plus.adonisjs.com/docs/packages/permissions/team-permissions

Use this command to create the migration file for the team_members table.

```bash
node ace make:migration team_members
```

--------------------------------

### Deploy to Fly.io with Build Secrets

Source: https://plus.adonisjs.com/docs/packages/installation

Deploys an application to Fly.io, making the NPM_TOKEN available as a BuildKit secret during the build process. This is necessary because Fly.io does not pass secrets set with 'fly secrets set' into the Docker build by default.

```bash
flyctl deploy --build-secret "NPM_TOKEN=$NPM_TOKEN"
```
Tokens:
Raw