> ## Documentation Index
> Fetch the complete documentation index at: https://alphaconsultings.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Package Docs Index

> Primary entry points for install, usage, upgrades, and policy documents.

# Package Documentation Index

Version: `1.3.0`

## Start here

* New consumer: [Installation and Quick Start](./installation)
* Upgrade path: [Upgrade Guide](./upgrade-guide)
* If you evaluate stability: [Support Policy](../support/support-policy), [Versioning Policy](../support/versioning-policy), [Release Cadence](../release/cadence)

## Installation and setup

* [Installation and Quick Start](./installation)
* [Usage guides](./usage-guides)
* [Common scenarios](./common-scenarios)
* [Cookbook](./cookbook)
* [Controller usage guide](./controllers)
* [Service usage guide](./services)
* [Runtime overview](../runtime/index)
* [Runtime CRUD](../runtime/crud)
* [Runtime querying](../runtime/querying)
* [Runtime models](../runtime/models)
* [Runtime controllers](../runtime/controllers)
* [Runtime services](../runtime/services)
* [Runtime transactions](../runtime/transactions)
* [Runtime cache](../runtime/cache)
* [Test overview](../test/index)
* [Jest and runtime tests](../test/jest-runtime)
* [Factories and seeds](../test/factories-seeds)
* [Scenarios](../test/scenarios)
* [CLI and pack smoke](../test/cli-pack-smoke)
* [API reference](../api/reference)

## SQL and Mongo usage

* [Usage guides](./usage-guides)
* [Database metadata](../orm/database-metadata)
* [Multi-connection strategy](../orm/multi-connection-strategy)
* [NoSQL (Mongo) usage](../orm/nosql)
* [Mixin scenarios](../orm/mixin-scenarios)
* [Soft deletes and restore](../orm/soft-deletes)

## Operations and safety

* [Production safety](../cli/production-safety)
* [Least-privilege environment contract](../database/least-privilege-env-contract)
* [Migration rollback runbook](../orm/migration-rollback)
* [Release Qualification checklist](../release/qualification-checklist)

## Stability and compatibility

* [Backward compatibility](../support/backward-compatibility)
* [Public API freeze policy](../support/public-api-freeze)
* [Versioning policy](../support/versioning-policy)
* [Support policy](../support/support-policy)

## Support and troubleshooting

* [Troubleshooting guide](../support/troubleshooting)
* [SECURITY.md](https://github.com/MetalDz/Eloquent-ORM.js/blob/ai_master/SECURITY.md)

## Published npm package notes

* The published npm package intentionally excludes `.map` files to reduce package size.
* This does not change ORM runtime behavior, CLI behavior, or the public API. It only removes published debug metadata.
* Reverse mapping from published JavaScript back to TypeScript source is therefore not shipped in the npm tarball.
* Full TypeScript source remains available in the GitHub repository for collaboration, source review, and deeper debugging.
* The package may be flagged for network-access and eval-like behavior by supply-chain scanners because it legitimately talks to databases/cache servers and because `mysql2` uses generated parser functions internally.
* The known `mysql2` `readCodeFor` issue affected versions earlier than `3.9.7`; this package's supported range is `^3.15.2`, which is above that fixed line.
* Hosted docs: [https://alphaconsultings.mintlify.app/](https://alphaconsultings.mintlify.app/)
* GitHub source: [https://github.com/MetalDz/Eloquent-ORM.js](https://github.com/MetalDz/Eloquent-ORM.js)
* npm docs command:
  * `npm docs @alpha.consultings/eloquent-orm.js`
* npm repository command:
  * `npm repo @alpha.consultings/eloquent-orm.js`
* npm issues command:
  * `npm bugs @alpha.consultings/eloquent-orm.js`
