@m3rcena/eco 0.0.0-stage → 14.28.1

package/LICENSE

@@ -0,0 +1,191 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2026 M3rcena Development
+
+   Licensed 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 CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+

package/README.md

@@ -1,3 +1,183 @@
-# Temporary Holding Version
+<div align="center">
+  <img src="./assets/logo.png" alt="Eco Logo" width="220" />
+  <h1>🪙 @m3rcena/eco</h1>
+  <p><strong>The ultimate enterprise-grade Discord.js v14 economy, progression, stock market, and casino engine.</strong></p>
+  <p>
+    <a href="https://www.npmjs.com/package/@m3rcena/eco"><img src="https://img.shields.io/npm/v/@m3rcena/eco.svg?style=flat-square" alt="NPM Version" /></a>
+    <img src="https://img.shields.io/badge/discord.js-v14.28.1-5865F2?style=flat-square&logo=discord" alt="discord.js v14.28.1" />
+    <img src="https://img.shields.io/badge/node-%3E%3D22.0.0-brightgreen.svg?style=flat-square&logo=node.js" alt="Node Support" />
+    <img src="https://img.shields.io/badge/TypeScript-7.0-blue?style=flat-square&logo=typescript" alt="TypeScript" />
+    <a href="https://github.com/M3rcena/m3rcena-eco/blob/main/LICENSE"><img src="https://img.shields.io/badge/license-Apache--2.0-blue.svg?style=flat-square" alt="License" /></a>
+    <a href="https://github.com/M3rcena/m3rcena-eco/wiki"><img src="https://img.shields.io/badge/Wiki-Documentation-purple.svg?style=flat-square" alt="Eco Wiki Documentation" /></a>
+  </p>
+</div>
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+> 📚 **Complete Documentation Wiki**: For detailed guides, bank vaults, credit score formulas, tax rates, and API reference, visit the **[@m3rcena/eco Official Wiki](https://github.com/M3rcena/m3rcena-eco/wiki)**:
+> - **[Real Economy: Bank Vaults, Loans, Bills & Taxes](https://github.com/M3rcena/m3rcena-eco/wiki/Real-Economy)**
+> - **[Careers, Jobs, Shop & Businesses](https://github.com/M3rcena/m3rcena-eco/wiki/Careers-and-Shop)**
+> - **[Casino & Gambling Suite](https://github.com/M3rcena/m3rcena-eco/wiki/Casino-Suite)**
+> - **[Stocks, Heists, Pets & Loot Crates](https://github.com/M3rcena/m3rcena-eco/wiki/Stocks-Heists-and-Pets)**
+> - **[Dashboard Bridge Integration](https://github.com/M3rcena/m3rcena-eco/wiki/Bridge-Integration)**
+
+---
+
+## 🌟 Highlights
+
+- 💳 **Visual Canvas Debit Cards & Financial Passports**: High-resolution (850x500) debit cards generated via `@napi-rs/canvas` with tier gradients (Bronze, Silver, Gold, Platinum, Obsidian, Mythic), laser chips, contactless arcs, user avatars, and interactive profile tabs (`Overview`, `Backpack`, `Businesses`, `Stocks`, `Pets`).
+- 📈 **Stock & Cryptocurrency Exchange**: Simulated market engine with real-time volatility, bull/bear trends, and 800x400 neon candlestick/sparkline charts (`RenderMarketChart`). Trade tech stocks and crypto ($AETH, $NEXU, $CORE, ₿BIT, ΞETH) with live PnL tracking.
+- 🏦 **Multiplayer Syndicate Bank Heists**: Assemble a crew in Discord with specialized roles (`💻 Hacker`, `🚗 Getaway Driver`, `💣 Demolitionist`, `💪 Heavy Muscle`), choose high-security targets (`Nightshift Mart Safe` to `Federal Reserve Sub-Basement`), and launch interactive vault breaches with synchronized loot sharing or SWAT bail fines!
+- 🐾 **Companion Pets & Foraging Expeditions**: Adopt cybernetic K9s, fortune cats, or obsidian dragons. Feed pets, level them up, and dispatch them on timed foraging expeditions to bring back randomized cash and XP!
+- 🎁 **Quantum Mystery Loot Crates**: Unbox mystery crates (`Common`, `Rare`, `Epic`, `Legendary`, `Mythic`) with suspenseful unboxing animations and drop table distributions.
+- 🛍️ **Interactive Shop & Backpack**: Filter categories (`Consumables`, `Upgrades`, `Collectibles`), inspect items, and purchase directly via Discord Components V2 select menus and buttons.
+- 🎰 **Casino & Gambling Suite**: Components V2 interactive Blackjack table (Hit, Stand, Double Down), Coinflip, Roulette, Crash multiplier rockets, Dice, and Slots.
+- 🏢 **Passive Business Enterprises**: Buy and upgrade companies (Lemonade Stands, Coffee Chains, Off-World Mining) with employee hiring and offline profit accumulation.
+- 🏆 **Interactive Leaderboards**: Paginated top rankings with metric selection (`Net Worth`, `Wallet`, `Bank`, `Level`, `Streaks`).
+- 💾 **Native SQLite & Enterprise Prisma Storage**: Built-in zero-dependency local SQLite (`node:sqlite` WAL mode via `SqliteEcoStorage`) and auto-migrating Prisma ORM adapter (`PrismaEcoStorage`).
+- 🦀 **Rust-Style Submodule Resolver**: Install and host via Git submodules locally with zero npm dependencies or transparently fall back to npm (`@m3rcena/eco/resolver`, `@m3rcena/eco/register`, `@m3rcena/eco/host`).
+- 🌐 **Dashboard Bridge**: Native integration with `@m3rcena/bridge` for real-time WebSocket syncing and presence-filtered audio cues (`coin_drop`, `win`, `purchase`, `rob_siren`).
+- 🤖 **Discord.js v14.28.1 Ready**: Fully compatible with the latest Discord.js updates and `clientReady` lifecycle.
+- ⚡ **Next-Gen Performance**: Dual ESM/CJS, TypeScript 7.0 definitions, zero bloat, and sub-millisecond execution.
+
+---
+
+## 📦 Installation
+
+### Option A: Standard NPM Installation
+
+```bash
+# npm
+npm install @m3rcena/eco @m3rcena/bridge @napi-rs/canvas discord.js
+
+# pnpm
+pnpm add @m3rcena/eco @m3rcena/bridge @napi-rs/canvas discord.js
+
+# yarn
+yarn add @m3rcena/eco @m3rcena/bridge @napi-rs/canvas discord.js
+```
+
+> **Note**: Requires Node.js **22.0.0+** (LTS 22, 24, 26). Node 20 is EOL and unsupported.
+
+### Option B: Local Git Submodule (Rust-Style Resolver)
+
+You can vendor and host `@m3rcena/eco` locally via Git submodules without needing to publish or pull from npm:
+
+```bash
+git submodule add https://github.com/M3rcena/m3rcena-eco.git submodules/m3rcena-eco
+```
+
+Add auto-registration at the top of your app entrypoint:
+```typescript
+import "@m3rcena/eco/register";
+```
+
+Or run standalone hosting:
+```bash
+npx tsx @m3rcena/eco/host --port 5124
+```
+
+---
+
+## 💾 Database Handlers & Persistence
+
+`@m3rcena/eco` supports native SQLite WAL mode, Prisma ORM, and JSON file storage:
+
+```typescript
+import {
+  EcoManager,
+  SqliteEcoStorage,   // Zero-dependency SQLite (WAL mode)
+  PrismaEcoStorage,   // PostgreSQL / MySQL / SQLite via Prisma ORM
+  JsonEcoStorage,     // Lightweight JSON file storage
+} from "@m3rcena/eco";
+
+// Zero-dependency SQLite with WAL journal mode:
+const eco = new EcoManager({
+  storage: new SqliteEcoStorage("./data/economy.sqlite"),
+});
+```
+
+---
+
+## 🚀 Quick Example
+
+```typescript
+import { Client, GatewayIntentBits } from "discord.js";
+import {
+  EcoManager,
+  JsonEcoStorage,
+  EcoProfileUI,
+  EcoStockMarketUI,
+  EcoHeistUI,
+  EcoBlackjackUI,
+  EcoShopUI,
+} from "@m3rcena/eco";
+
+const eco = new EcoManager({
+  currencySymbol: "🪙",
+  currencyName: "Coins",
+  storage: new JsonEcoStorage("./data/economy.json"),
+});
+
+const client = new Client({
+  intents: [GatewayIntentBits.Guilds, GatewayIntentBits.GuildMessages, GatewayIntentBits.MessageContent],
+});
+
+client.on("interactionCreate", async (interaction) => {
+  if (!interaction.isChatInputCommand()) return;
+
+  // 1. Visual Financial Passport with Canvas Debit Card
+  if (interaction.commandName === "profile") {
+    return new EcoProfileUI(eco, { context: interaction }).start();
+  }
+
+  // 2. Interactive Live Stock & Crypto Exchange Terminal
+  if (interaction.commandName === "stocks") {
+    return new EcoStockMarketUI(eco, { context: interaction }).start();
+  }
+
+  // 3. Multiplayer Syndicate Crew Bank Heist
+  if (interaction.commandName === "heist") {
+    return new EcoHeistUI(eco, { context: interaction }).start();
+  }
+
+  // 4. Interactive Components V2 Blackjack Table
+  if (interaction.commandName === "blackjack") {
+    const bet = interaction.options.getInteger("amount", true);
+    return new EcoBlackjackUI(eco, { context: interaction, betAmount: bet }).start();
+  }
+
+  // 5. Interactive Marketplace
+  if (interaction.commandName === "shop") {
+    return new EcoShopUI(eco, { context: interaction }).start();
+  }
+});
+
+client.login(process.env.DISCORD_TOKEN);
+```
+
+---
+
+## 🧩 Plug-and-Play Interactive Discord UI Modules
+
+Like `@m3rcena/weky`, `@m3rcena/eco` provides ready-to-run interactive Discord runners built with modern **Components V2** containers, select menus, and action rows. Developers can launch complete interactive interfaces in a single line of code:
+
+| UI Runner | Description | Features |
+|---|---|---|
+| `EcoProfileUI` | Financial Passport & Debit Card | High-res Canvas debit card, tabbed inspection (`Overview`, `Backpack`, `Businesses`, `Stocks`, `Pets`) |
+| `EcoStockMarketUI` | Stock & Crypto Exchange Terminal | Neon candlestick/sparkline charts, ticker selection, Buy 1x/10x, Sell All, live price refresh |
+| `EcoHeistUI` | Multiplayer Syndicate Bank Heist | Target vault selection, role recruitment (`Hacker`, `Driver`, `Demo`, `Muscle`), breach simulation |
+| `EcoBlackjackUI` | VIP Blackjack Table | Components V2 dealer table, Hit, Stand, Double Down, card totals |
+| `EcoCrateUI` | Mystery Loot Crate Unboxing | Crate tier picker, unboxing suspense sequence, item and coin reveal |
+| `EcoShopUI` | Marketplace Terminal | Category filter select menu, item cards, buy buttons, quantity picker |
+| `EcoLeaderboardUI` | Server Leaderboards | Metric select menu (`Net Worth`, `Wallet`, `Bank`, `Level`, `Streaks`), pagination |
+
+---
+
+## 📖 Complete Documentation
+
+For detailed guides, API reference, custom storage adapters, and bridge setup, see [DOCUMENTATION.md](./DOCUMENTATION.md).
+
+---
+
+## 🛡️ License
+
+Apache-2.0 © [M3rcena Development](https://github.com/M3rcena)