@ordius/adonisjs-currencyx 1.4.9

package/build/stubs/config/currency.stub

@@ -0,0 +1,97 @@
+{{{
+  exports({ to: app.configPath('currency.ts') })
+}}}
+import env from '#start/env'
+import { defineConfig, exchanges } from '@ordius/adonisjs-currencyx'
+
+const currencyConfig = defineConfig({
+  /*
+  |--------------------------------------------------------------------------
+  | Default Exchange
+  |--------------------------------------------------------------------------
+  |
+  | The default currency provider to use. You can switch between exchanges
+  | at runtime using the currency.use() method.
+  |
+  */
+  default: env.get('CURRENCY_EXCHANGE_PROVIDER', 'database') as typeof currencyConfig,
+
+  /*
+  |--------------------------------------------------------------------------
+  | Exchange Configurations
+  |--------------------------------------------------------------------------
+  |
+  | Configure each currency provider. You can enable/disable exchanges by
+  | commenting out their configuration.
+  |
+  */
+  exchanges: {
+    /*
+    |--------------------------------------------------------------------------
+    | Database Exchange
+    |--------------------------------------------------------------------------
+    |
+    | Uses your local database to store and retrieve exchange rates.
+    | Requires a Currency model and proper database setup.
+    |
+    */
+    database: exchanges.database({
+      model: () => import('#models/currency'),
+      base: 'USD',    // Base currency for all exchange rates
+      columns: {
+        code: 'code',             // Currency code column (USD, EUR, etc.)
+        rate: 'exchange_rate',    // Exchange rate column (relative to base currency)
+        updated_at: 'updated_at', // Updated at column
+      },
+      cache: {
+        service: () => import('@adonisjs/cache/services/main'),
+        ttl: '1h',          // Number of time to live in milliseconds, or a human-readable string
+        prefix: 'currency', // Cache key prefix
+      },
+    }),
+
+    /*
+    |--------------------------------------------------------------------------
+    | Google Finance Exchange
+    |--------------------------------------------------------------------------
+    |
+    | Free exchange using Google Finance API. No API key required.
+    | Good for development and testing.
+    |
+    */
+    google: exchanges.google({
+      base: env.get('CURRENCY_BASE', 'USD'),
+      timeout: 5000,
+    }),
+
+    /*
+    |--------------------------------------------------------------------------
+    | Fixer.io Exchange
+    |--------------------------------------------------------------------------
+    |
+    | Requires API key from fixer.io. Provides accurate and up-to-date
+    | exchange rates. Uncomment and configure if you have an API key.
+    |
+    */
+    fixer: exchanges.fixer({
+      accessKey: env.get('FIXER_API_KEY', 'your_api_key'),
+      base: env.get('CURRENCY_BASE', 'EUR'),
+      timeout: 10000,
+    }),
+  },
+})
+
+export default currencyConfig
+
+/*
+|--------------------------------------------------------------------------
+| Type Augmentation
+|--------------------------------------------------------------------------
+|
+| Augment the container types to include the currency service.
+| This provides better IntelliSense and type safety.
+|
+*/
+declare module '@ordius/adonisjs-currencyx/types' {
+  interface CurrencyExchanges extends InferExchanges<typeof currencyConfig> {}
+}

package/build/stubs/main.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Path to the root directory where the stubs are stored. We use
+ * this path within commands and the configure hook
+ */
+export declare const stubsRoot: string;

package/build/stubs/main.js

@@ -0,0 +1,7 @@
+import { dirname } from 'node:path';
+import { fileURLToPath } from 'node:url';
+/**
+ * Path to the root directory where the stubs are stored. We use
+ * this path within commands and the configure hook
+ */
+export const stubsRoot = dirname(fileURLToPath(import.meta.url));

package/build/stubs/migrations/create_currencies_table.stub

@@ -0,0 +1,41 @@
+{{#var migrationFileName = migration.fileName}}
+{{{
+  exports({ to: app.migrationsPath(migrationFileName) })
+}}}
+import Currency from '#models/currency'
+import { BaseSchema } from '@adonisjs/lucid/schema'
+
+
+export default class extends BaseSchema {
+  protected tableName = Currency.table
+
+  async up() {
+    this.schema.createTable(this.tableName, (table) => {
+      table.increments('id')
+      table.string('code', 3).notNullable().unique().comment('The currency code in ISO 4217. E.g., USD, EUR')
+      table.string('name').notNullable().comment('The currency name. E.g., US Dollar, Euro')
+      table.string('symbol').notNullable().comment('The currency symbol. E.g., $, €, £')
+      table.jsonb('countries').nullable().comment('The countries that support this currency')
+
+      /**
+       * Exchange rate relative to base currency (e.g., USD)
+       * For USD itself, rate should be 1.0
+       */
+      table.decimal('exchange_rate', 15, 8).notNullable().comment('The currency exchange rate with should be respect to USD')
+
+      table.boolean('status').defaultTo(true).comment('The status of the currency')
+      table.timestamp('created_at')
+      table.timestamp('updated_at')
+
+      /**
+       * Indexes for better query performance
+       */
+      table.index(['code'])
+      table.index(['status'])
+    })
+  }
+
+  async down() {
+    this.schema.dropTable(this.tableName)
+  }
+}

package/build/stubs/models/currency.stub

@@ -0,0 +1,111 @@
+{{{
+  exports({ to: app.modelPath('currency.ts') })
+}}}
+import { BaseModel, column } from '@adonisjs/lucid/orm'
+import { DateTime } from 'luxon'
+
+/**
+ * Currency model for storing exchange rates
+ */
+export default class Currency extends BaseModel {
+  public static table = 'currencies'
+
+  @column({ isPrimary: true })
+  declare id: number
+
+  /**
+   * Currency code (e.g., USD, EUR, GBP)
+   */
+  @column()
+  declare code: string
+
+  /**
+   * Currency name (e.g., US Dollar, Euro)
+   */
+  @column()
+  declare name: string
+
+  /**
+   * Currency symbol (e.g., $, €, £)
+   */
+  @column()
+  declare symbol: string
+
+  /**
+   * Countries using this currency
+   */
+  @column({
+    prepare: (value) => (typeof value === 'object' ? JSON.stringify(value) : value),
+    consume: (value) => (typeof value === 'string' ? JSON.parse(value) : value),
+  })
+  declare countries: string[]
+
+  /**
+   * Exchange rate relative to base currency (e.g., USD)
+   * For the base currency itself (e.g., USD), this should be 1.0
+   */
+  @column({
+    columnName: 'exchange_rate',
+    prepare: (value) => (typeof value === 'string' ? Number.parseFloat(value) : value),
+    consume: (value) => (typeof value === 'string' ? Number.parseFloat(value) : value),
+  })
+  declare exchangeRate: number
+
+  /**
+   * Currency status (active/inactive)
+   */
+  @column()
+  declare status: boolean
+
+  @column.dateTime({ autoCreate: true })
+  declare createdAt: DateTime
+
+  @column.dateTime({ autoCreate: true, autoUpdate: true })
+  declare updatedAt: DateTime
+
+  /**
+   * Get exchange rate for a specific currency pair
+   * Logic: assumes all rates are relative to a common base (e.g., USD)
+   */
+  public static async getRate(from: string, to: string, baseCurrency: string = 'USD'): Promise<number | null> {
+    if (from === to) return 1
+
+    // Handle base currency conversions
+    if (from === baseCurrency && to === baseCurrency) return 1
+
+    if (from === baseCurrency) {
+      const toRate = await this.query().where('code', to).first()
+      return toRate ? toRate.exchangeRate : null
+    }
+
+    if (to === baseCurrency) {
+      const fromRate = await this.query().where('code', from).first()
+      return fromRate ? 1 / fromRate.exchangeRate : null
+    }
+
+    // Cross rate conversion
+    const fromRate = await this.query().where('code', from).first()
+    const toRate = await this.query().where('code', to).first()
+
+    if (!fromRate || !toRate) {
+      return null
+    }
+
+    // Calculate cross rate: to_rate / from_rate
+    return toRate.exchangeRate / fromRate.exchangeRate
+  }
+
+  /**
+   * Get all available exchange rates
+   */
+  public static async getAllRates() {
+    const rates = await this.query().where('status', true)
+
+    const result: Record<string, number> = {}
+    for (const rate of rates) {
+      result[rate.code] = rate.exchangeRate
+    }
+
+    return result
+  }
+}

package/package.json

@@ -0,0 +1,146 @@
+{
+  "name": "@ordius/adonisjs-currencyx",
+  "description": "AdonisJS integration for CurrencyX with database exchange provider and cache support",
+  "version": "1.4.9",
+  "engines": {
+    "node": ">=20.6.0"
+  },
+  "main": "build/index.js",
+  "type": "module",
+  "files": [
+    "build",
+    "!build/bin",
+    "!build/tests"
+  ],
+  "exports": {
+    ".": "./build/index.js",
+    "./types": "./build/src/types.js",
+    "./services/main": "./build/services/main.js",
+    "./currency_provider": "./build/providers/currency_provider.js"
+  },
+  "scripts": {
+    "clean": "del-cli build",
+    "copy:templates": "copyfiles \"stubs/**/*.stub\" build",
+    "typecheck": "tsc --noEmit",
+    "lint": "eslint .",
+    "format": "prettier --write .",
+    "quick:test": "node --import=./tsnode.esm.js --enable-source-maps bin/test.ts",
+    "pretest": "npm run lint",
+    "test": "c8 npm run quick:test",
+    "prebuild": "npm run lint && npm run clean",
+    "build": "tsc",
+    "postbuild": "npm run copy:templates",
+    "release": "release-it",
+    "release:patch": "release-it patch",
+    "release:minor": "release-it minor",
+    "release:major": "release-it major",
+    "release:beta": "release-it --preRelease=beta",
+    "release:alpha": "release-it --preRelease=alpha",
+    "release:dry": "release-it --dry-run",
+    "version": "npm run build",
+    "prepublishOnly": "npm run build"
+  },
+  "keywords": [
+    "adonisjs",
+    "currency",
+    "converter",
+    "exchange-rates",
+    "typescript",
+    "database",
+    "lucid",
+    "cache"
+  ],
+  "author": "Mixxtor",
+  "license": "MIT",
+  "devDependencies": {
+    "@adonisjs/assembler": "^7.8.2",
+    "@adonisjs/cache": "^1.3.1",
+    "@adonisjs/core": "^6.21.0",
+    "@adonisjs/eslint-config": "^3.0.0",
+    "@adonisjs/lucid": "^21.8.1",
+    "@adonisjs/prettier-config": "^1.4.5",
+    "@adonisjs/tsconfig": "^1.4.1",
+    "@japa/assert": "^4.2.0",
+    "@japa/runner": "^5.3.0",
+    "@release-it/conventional-changelog": "^10.0.6",
+    "@swc/core": "^1.15.21",
+    "@types/node": "^25.5.0",
+    "better-sqlite3": "^12.8.0",
+    "c8": "^11.0.0",
+    "copyfiles": "^2.4.1",
+    "cross-env": "^10.1.0",
+    "del-cli": "^7.0.0",
+    "dotenv": "^17.3.1",
+    "eslint": "^10.1.0",
+    "luxon": "^3.7.2",
+    "prettier": "^3.8.1",
+    "release-it": "^19.2.4",
+    "ts-node": "^10.9.2",
+    "tsup": "^8.5.1",
+    "typescript": "^5.9.3"
+  },
+  "peerDependencies": {
+    "@adonisjs/cache": "^1.3.1 || ^2.0.1",
+    "@adonisjs/core": "^6.21.0 || ^7.2.0",
+    "@adonisjs/lucid": "^21.8.1 || ^22.4.0"
+  },
+  "dependencies": {
+    "@mixxtor/currencyx-js": "^2.3.0"
+  },
+  "peerDependenciesMeta": {
+    "@adonisjs/cache": {
+      "optional": true
+    }
+  },
+  "homepage": "https://github.com/ordius/adonisjs-currencyx#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ordius/adonisjs-currencyx.git"
+  },
+  "bugs": {
+    "url": "https://github.com/ordius/adonisjs-currencyx/issues"
+  },
+  "publishConfig": {
+    "access": "public",
+    "tag": "latest"
+  },
+  "release-it": {
+    "git": {
+      "requireCleanWorkingDir": true,
+      "requireUpstream": true,
+      "commitMessage": "chore(release): ${version}",
+      "tagAnnotation": "v${version}",
+      "push": true,
+      "tagName": "v${version}"
+    },
+    "github": {
+      "release": true,
+      "releaseName": "Release v${version}",
+      "releaseNotes": null,
+      "autoGenerate": true,
+      "draft": false,
+      "preRelease": false
+    },
+    "npm": {
+      "publish": true,
+      "skipChecks": true
+    },
+    "plugins": {
+      "@release-it/conventional-changelog": {
+        "preset": {
+          "name": "angular"
+        }
+      }
+    }
+  },
+  "c8": {
+    "reporter": [
+      "text",
+      "html"
+    ],
+    "exclude": [
+      "tests/**"
+    ]
+  },
+  "prettier": "@adonisjs/prettier-config"
+}