# EienJS

Canonical Origin: https://eienjs.com/

## LLM Resources

- [Full Content](https://eienjs.com/llms-full.txt): Complete page content in markdown format.
- [sitemap.xml](https://eienjs.com/sitemap.xml): XML sitemap for search engines and crawlers.
- [robots.txt](https://eienjs.com/robots.txt): Crawler rules and permissions.

## Pages

- [EienJS](https://eienjs.com/index.md): Open source packages for the AdonisJS ecosystem, plus utilities and shared standards for clean, consistent code.
- [Introduction](https://eienjs.com/getting-started.md): Open source packages for the AdonisJS ecosystem, built with clean code standards in mind.
- [Contributing](https://eienjs.com/getting-started/contributing.md): Contributing Guide for EienJS
- [Manifest](https://eienjs.com/getting-started/manifest.md): EienJS is an open source organization that provides libraries to work with AdonisJS.
- [Overview](https://eienjs.com/packages.md): Explore open source packages provided by the EienJS organization.
- [Custom Filters, Sorts & Includes](https://eienjs.com/packages/adonisjs-api-query/advanced/custom-clauses.md): Build reusable filter, sort, and include classes implementing Filter, Sort, and Include interfaces.
- [Exceptions](https://eienjs.com/packages/adonisjs-api-query/advanced/exceptions.md): Handle exceptions thrown by @eienjs/adonisjs-api-query when invalid query parameters are requested.
- [Request & Delimiters](https://eienjs.com/packages/adonisjs-api-query/advanced/request-and-delimiters.md): Inspect parsed query parameters and customize array value delimiters with ApiQueryBuilderRequest.
- [Filterable Classes](https://eienjs.com/packages/adonisjs-api-query/features/filterable-classes.md): Encapsulate allowed filters, sorts, includes, setup hooks, and validation rules in dedicated classes.
- [Filtering](https://eienjs.com/packages/adonisjs-api-query/features/filtering.md): Filter Lucid queries using partial, exact, operator, scope, trashed, and callback filters.
- [Including Relationships](https://eienjs.com/packages/adonisjs-api-query/features/including-relationships.md): Eager-load Lucid relationships, nested relations, and relationship counts from API requests.
- [Sorting](https://eienjs.com/packages/adonisjs-api-query/features/sorting.md): Sort Lucid queries by single or multiple columns, aliases, default sorts, and custom callbacks.
- [Validation](https://eienjs.com/packages/adonisjs-api-query/features/validation.md): Validate API query parameters automatically or explicitly using VineJS.
- [Configuration](https://eienjs.com/packages/adonisjs-api-query/getting-started/configuration.md): Customize query parameter names, suffixes, and exception behavior in config/apiquery.ts.
- [Installation](https://eienjs.com/packages/adonisjs-api-query/getting-started/installation.md): Install and configure @eienjs/adonisjs-api-query in your AdonisJS application.
- [Introduction](https://eienjs.com/packages/adonisjs-api-query/getting-started/introduction.md): Easily build Lucid queries from API requests in AdonisJS v7.
- [Cache](https://eienjs.com/packages/adonisjs-permission/advanced/cache.md): In-memory cache of permissions and roles.
- [Events](https://eienjs.com/packages/adonisjs-permission/advanced/events.md): React to roles and permissions being attached or detached.
- [Super-Admin](https://eienjs.com/packages/adonisjs-permission/advanced/super-admin.md): Let a role bypass every permission check.
- [Teams](https://eienjs.com/packages/adonisjs-permission/advanced/teams.md): Scope roles and permissions per team or tenant.
- [Catalog & Sync](https://eienjs.com/packages/adonisjs-permission/basic-usage/catalog.md): Declare roles and permissions in config and sync them with the database.
- [Checking Access](https://eienjs.com/packages/adonisjs-permission/basic-usage/checking.md): Check roles and permissions on your models.
- [Middleware](https://eienjs.com/packages/adonisjs-permission/basic-usage/middleware.md): Protect routes with role and permission middlewares.
- [Roles & Permissions](https://eienjs.com/packages/adonisjs-permission/basic-usage/roles-and-permissions.md): Create roles and permissions and assign them to models.
- [Wildcard Permissions](https://eienjs.com/packages/adonisjs-permission/basic-usage/wildcard-permissions.md): Apache Shiro style wildcard permissions.
- [Configuration](https://eienjs.com/packages/adonisjs-permission/getting-started/configuration.md): Every option available in config/permissions.ts.
- [Installation](https://eienjs.com/packages/adonisjs-permission/getting-started/installation.md): Install and configure the package with a single Ace command.
- [Introduction](https://eienjs.com/packages/adonisjs-permission/getting-started/introduction.md): Associate Lucid models with roles and permissions in AdonisJS v7.
- [From adonis-lucid-permission](https://eienjs.com/packages/adonisjs-permission/upgrading/from-adonis-lucid-permission.md): Step by step migration from adonis-lucid-permission (AdonisJS v6) to @eienjs/adonisjs-permission (AdonisJS v7).
- [Custom Instrumentation](https://eienjs.com/packages/adonisjs-sentry/advanced/custom-instrumentation.md): Leverage the re-exported Sentry SDK to record custom spans, breadcrumbs, tags, and messages.
- [Early Preloading](https://eienjs.com/packages/adonisjs-sentry/advanced/early-preloading.md): Initialize Sentry before application dependencies load to enable full third-party auto-instrumentation.
- [Source Maps and Releases](https://eienjs.com/packages/adonisjs-sentry/advanced/source-maps-and-releases.md): Associate Sentry releases with source maps to display original TypeScript code in stack traces.
- [Functions and Classes](https://eienjs.com/packages/adonisjs-sentry/api-reference/functions-and-classes.md): API reference for defineConfig, reportException, SentryMiddleware, and SentryProvider.
- [Types](https://eienjs.com/packages/adonisjs-sentry/api-reference/types.md): TypeScript type definitions and interfaces exported by @eienjs/adonisjs-sentry.
- [Configuration](https://eienjs.com/packages/adonisjs-sentry/getting-started/configuration.md): Customize Sentry options, sampling rates, PII settings, and exception ignore lists in config/sentry.ts.
- [Installation](https://eienjs.com/packages/adonisjs-sentry/getting-started/installation.md): Install and configure @eienjs/adonisjs-sentry in your AdonisJS v7 application.
- [Introduction](https://eienjs.com/packages/adonisjs-sentry/getting-started/introduction.md): Official Sentry integration for AdonisJS applications with automatic exception capture, request context, and distributed tracing.
- [Exception Reporting](https://eienjs.com/packages/adonisjs-sentry/usage/exception-reporting.md): Capture, enrich, and filter exceptions with HTTP context, user details, and smart fingerprinting.
- [Tracing and Middleware](https://eienjs.com/packages/adonisjs-sentry/usage/tracing-and-middleware.md): Isolate request scopes, monitor performance traces, and set transaction names with SentryMiddleware.
- [Verify Command](https://eienjs.com/packages/adonisjs-sentry/usage/verify-command.md): Validate your Sentry configuration and ensure exceptions can be flushed and delivered.
- [API Reference](https://eienjs.com/packages/adonisjs-simple-auth/advanced/api-reference.md): Complete reference of classes, functions, types, and exports provided by @eienjs/adonisjs-simple-auth.
- [Testing with Japa](https://eienjs.com/packages/adonisjs-simple-auth/advanced/testing-with-japa.md): Authenticate functional HTTP tests effortlessly using the simpleAuthApiClient Japa plugin.
- [Configuration](https://eienjs.com/packages/adonisjs-simple-auth/getting-started/configuration.md): Configure the HTTP header name and API key value in config/simpleauth.ts.
- [Installation](https://eienjs.com/packages/adonisjs-simple-auth/getting-started/installation.md): Install and configure @eienjs/adonisjs-simple-auth in your AdonisJS v7 project.
- [Introduction](https://eienjs.com/packages/adonisjs-simple-auth/getting-started/introduction.md): Lightweight single API key authentication for AdonisJS v7 applications.
- [Error Handling & i18n](https://eienjs.com/packages/adonisjs-simple-auth/usage/error-handling.md): Understand how SimpleAuthException handles 401 Unauthorized responses and i18n translations.
- [Generating API Keys](https://eienjs.com/packages/adonisjs-simple-auth/usage/generating-api-keys.md): Generate cryptographically secure API keys with the generate:api-key Ace command.
- [Protecting Routes](https://eienjs.com/packages/adonisjs-simple-auth/usage/protecting-routes.md): Authenticate incoming HTTP requests using the apiKey middleware or ctx.simpleAuth.
- [Installation](https://eienjs.com/packages/adonisjs-soft-deletes/getting-started/installation.md): Install and configure @eienjs/adonisjs-soft-deletes in your AdonisJS application.
- [Introduction](https://eienjs.com/packages/adonisjs-soft-deletes/getting-started/introduction.md): Provider-based soft deletes for AdonisJS with full Lucid ORM integration.
- [API Reference](https://eienjs.com/packages/adonisjs-soft-deletes/usage/api-reference.md): Complete reference of mixins, methods, query builder macros, TypeScript types, and exceptions.
- [Usage](https://eienjs.com/packages/adonisjs-soft-deletes/usage/usage.md): Apply the SoftDeletes mixin to Lucid models, soft delete and restore instances, and query trashed records.
- [Factory & Presets](https://eienjs.com/packages/eslint-config/api-reference/factory-and-presets.md): API reference for the eienjs() factory function, configuration presets, and exported TypeScript types.
- [Sub-Configs](https://eienjs.com/packages/eslint-config/api-reference/sub-configs.md): Import and compose individual ESLint flat config factories from @eienjs/eslint-config/configs.
- [Utilities & Globs](https://eienjs.com/packages/eslint-config/api-reference/utilities-and-globs.md): Reference for helper utilities and file glob constants exported by @eienjs/eslint-config.
- [Composer & Overrides](https://eienjs.com/packages/eslint-config/customization/composer-and-overrides.md): Override rules per preset or compose custom flat config items using FlatConfigComposer.
- [Editor Integration](https://eienjs.com/packages/eslint-config/customization/editor-integration.md): Configure VS Code and other editors for seamless formatting and linting with @eienjs/eslint-config.
- [Ignores & Globs](https://eienjs.com/packages/eslint-config/customization/ignores-and-globs.md): Configure gitignore integration, custom ignore patterns, and built-in glob constants.
- [Configuration](https://eienjs.com/packages/eslint-config/getting-started/configuration.md): Configure @eienjs/eslint-config options, auto-detected features, and rule presets.
- [Installation](https://eienjs.com/packages/eslint-config/getting-started/installation.md): Install and set up @eienjs/eslint-config using the interactive CLI wizard or manual configuration.
- [Introduction](https://eienjs.com/packages/eslint-config/getting-started/introduction.md): Opinionated ESLint flat config preset for EienJS projects, TypeScript, AdonisJS, Vue, Nuxt, and Astro.
- [CLI Wizard](https://eienjs.com/packages/eslint-config/usage/cli-wizard.md): Automate project setup and migration using the @eienjs/eslint-config interactive CLI tool.
- [Frameworks](https://eienjs.com/packages/eslint-config/usage/frameworks.md): Configure first-class ESLint support for AdonisJS, Nuxt, Vue, and Astro projects.
- [Stylistic & Formatters](https://eienjs.com/packages/eslint-config/usage/stylistic-and-formatters.md): Format code using ESLint Stylistic rules and optional Prettier formatters for CSS, HTML, Markdown, XML, SVG, and Astro.
- [TypeScript & Node](https://eienjs.com/packages/eslint-config/usage/typescript.md): Configure TypeScript rules, type-aware linting, erasable syntax checks, Unicorn, and pnpm workspaces.