@etsoo/appscript 1.3.37 → 1.3.38

package/__tests__/app/CoreApp.ts

@@ -249,7 +249,18 @@ test('Tests for publicApi', async () => {
     const currencies1 = app.publicApi.currencies(true);
     expect(currencies1.length >= 10).toBeTruthy();
 
+    expect(app.publicApi.getCurrencyLabel('USD')).toBe('美元$');
+
+    const defaultExchangeRate = await app.publicApi.exchangeRate('CNY', {
+        showLoading: false
+    });
+    expect(defaultExchangeRate?.exchangeRate).toBe(100);
+
     /*
+    const amount1 = await app.publicApi.exchangeAmount(1000, 'NZD', 'CNY');
+    const amount2 = await app.publicApi.exchangeAmount(100, 'NZD', 'USD');
+    console.log(amount1, amount2);
+
     const orgs = await app.orgApi.list();
     console.log(orgs);
 

package/lib/cjs/app/CoreApp.d.ts

@@ -34,6 +34,10 @@ export declare abstract class CoreApp<U extends IUser, S extends IAppSettings, N
      * Settings
      */
     readonly settings: S;
+    /**
+     * Default region
+     */
+    readonly defaultRegion: AddressRegion;
     /**
      * Fields
      */

package/lib/cjs/app/CoreApp.js

@@ -92,6 +92,7 @@ class CoreApp {
      * @param name Application name
      */
     constructor(settings, api, notifier, storage, name) {
+        var _a;
         this._authorized = false;
         this._isTryingLogin = false;
         /**
@@ -110,7 +111,15 @@ class CoreApp {
          * Passphrase for encryption
          */
         this.passphrase = '';
+        if (((_a = settings === null || settings === void 0 ? void 0 : settings.regions) === null || _a === void 0 ? void 0 : _a.length) === 0) {
+            throw new Error('No regions defined');
+        }
         this.settings = settings;
+        const region = AddressRegion_1.AddressRegion.getById(settings.regions[0]);
+        if (region == null) {
+            throw new Error('No default region defined');
+        }
+        this.defaultRegion = region;
         this.api = api;
         this.notifier = notifier;
         this.storage = storage;

package/lib/cjs/app/IApp.d.ts

@@ -64,6 +64,10 @@ export interface IApp {
      * Settings
      */
     readonly settings: IAppSettings;
+    /**
+     * Default region
+     */
+    readonly defaultRegion: AddressRegion;
     /**
      * Fields
      */

package/lib/cjs/erp/AddressApi.d.ts

@@ -27,6 +27,12 @@ export declare class AddressApi extends BaseApi {
      * @param rq Rquest data
      */
     getRegions(rq?: RegionsRQ): Promise<AddressRegionDb[] | undefined>;
+    /**
+     * Get region's currency, current region's currency as default
+     * @param regionId Region id
+     * @returns Result
+     */
+    regionCurrency(regionId?: string): "AUD" | "CAD" | "CNY" | "EUR" | "GBP" | "HKD" | "JPY" | "NZD" | "SGD" | "USD";
     /**
      * Get all local regions
      */

package/lib/cjs/erp/AddressApi.js

@@ -78,6 +78,18 @@ class AddressApi extends BaseApi_1.BaseApi {
         // Return the top items
         return regions.slice(0, items);
     }
+    /**
+     * Get region's currency, current region's currency as default
+     * @param regionId Region id
+     * @returns Result
+     */
+    regionCurrency(regionId) {
+        var _a;
+        const region = (_a = (regionId
+            ? this.regions().find((region) => region.id === regionId)
+            : null)) !== null && _a !== void 0 ? _a : this.app.settings.currentRegion;
+        return region.currency;
+    }
     regions(p) {
         const items = p == null || p.length === 0
             ? AddressRegion_1.AddressRegion.all

package/lib/cjs/erp/PublicApi.d.ts

@@ -11,20 +11,33 @@ import { PublicOrgProductDto, PublicProductDto } from './dto/PublicProductDto';
  * Public API
  */
 export declare class PublicApi extends BaseApi {
+    /**
+     * Default currency
+     */
+    defaultCurrency: string | Currency;
     /**
      * Get currencies
-     * @param currencyNames Limited currency names for local data, undefined will try to retrive remoately
+     * @param names Limited currency names for local data, undefined will try to retrive remoately
      * @returns Result
      */
     currencies(): Promise<CurrencyDto[] | undefined>;
     currencies(names: string[] | Currency[] | boolean): ListType1[];
+    /**
+     * Get exchange amount
+     * @param amount Amount
+     * @param sourceCurrency Source currency
+     * @param targetCurrency Target currency
+     * @returns Result
+     */
+    exchangeAmount(amount: number, sourceCurrency: Currency | string, targetCurrency?: Currency | string): Promise<number | undefined>;
     /**
      * Get exchange rate
      * @param currency Currency
      * @param payload Payload
+     * @param reload Reload data
      * @returns Result
      */
-    exchangeRate(currency: Currency | string, payload?: IApiPayload<ExchangeRateDto>): Promise<ExchangeRateDto | undefined>;
+    exchangeRate(currency: Currency | string, payload?: IApiPayload<ExchangeRateDto>, reload?: boolean): Promise<ExchangeRateDto | undefined>;
     /**
      * Get exchange rate history
      * @param currencies Currencies
@@ -33,6 +46,12 @@ export declare class PublicApi extends BaseApi {
      * @returns Result
      */
     exchangeRateHistory(currencies: (Currency | string)[], months?: number, payload?: IApiPayload<ExchangeRateHistoryDto[]>): Promise<ExchangeRateHistoryDto[] | undefined>;
+    /**
+     * Get currency label
+     * @param currency Currency
+     * @returns Label
+     */
+    getCurrencyLabel(currency: Currency | string): string;
     /**
      * Get product unit's label
      * Please define the label in culture with key 'unitPC' for ProductUnit.PC like that

package/lib/cjs/erp/PublicApi.js

@@ -6,10 +6,18 @@ const Currency_1 = require("../business/Currency");
 const ProductUnit_1 = require("../business/ProductUnit");
 const RepeatOption_1 = require("../business/RepeatOption");
 const BaseApi_1 = require("./BaseApi");
+const cachedCurrencyRates = {};
 /**
  * Public API
  */
 class PublicApi extends BaseApi_1.BaseApi {
+    constructor() {
+        super(...arguments);
+        /**
+         * Default currency
+         */
+        this.defaultCurrency = this.app.defaultRegion.currency;
+    }
     currencies(names) {
         if (typeof names === 'boolean' && names) {
             return Currency_1.Currencies.map((name) => {
@@ -34,14 +42,48 @@ class PublicApi extends BaseApi_1.BaseApi {
             showLoading: false
         });
     }
+    /**
+     * Get exchange amount
+     * @param amount Amount
+     * @param sourceCurrency Source currency
+     * @param targetCurrency Target currency
+     * @returns Result
+     */
+    async exchangeAmount(amount, sourceCurrency, targetCurrency) {
+        targetCurrency !== null && targetCurrency !== void 0 ? targetCurrency : (targetCurrency = this.app.defaultRegion.currency);
+        const [sourceRate, targetRate] = await Promise.all([
+            this.exchangeRate(sourceCurrency, {
+                showLoading: false
+            }),
+            this.exchangeRate(targetCurrency, {
+                showLoading: false
+            })
+        ]);
+        if (sourceRate == null || targetRate == null)
+            return undefined;
+        const result = Math.round((1000 * amount * sourceRate.exchangeRate) /
+            targetRate.exchangeRate) / 1000;
+        return result;
+    }
     /**
      * Get exchange rate
      * @param currency Currency
      * @param payload Payload
+     * @param reload Reload data
      * @returns Result
      */
-    exchangeRate(currency, payload) {
-        return this.api.get(`Public/ExchangeRate/${currency}`, undefined, payload);
+    async exchangeRate(currency, payload, reload = false) {
+        let rate = cachedCurrencyRates[currency];
+        if (rate == null || reload) {
+            rate =
+                currency === this.defaultCurrency
+                    ? { exchangeRate: 100, updateTime: new Date() }
+                    : await this.api.get(`Public/ExchangeRate/${currency}`, undefined, payload);
+            if (rate == null)
+                return undefined;
+            cachedCurrencyRates[currency] = rate;
+        }
+        return rate;
     }
     /**
      * Get exchange rate history
@@ -54,6 +96,16 @@ class PublicApi extends BaseApi_1.BaseApi {
         payload !== null && payload !== void 0 ? payload : (payload = { defaultValue: [] });
         return this.api.post('Public/ExchangeRateHistory', { currencies, months }, payload);
     }
+    /**
+     * Get currency label
+     * @param currency Currency
+     * @returns Label
+     */
+    getCurrencyLabel(currency) {
+        var _a;
+        const c = `currency${currency}`;
+        return (_a = this.app.get(c)) !== null && _a !== void 0 ? _a : c;
+    }
     /**
      * Get product unit's label
      * Please define the label in culture with key 'unitPC' for ProductUnit.PC like that

package/lib/mjs/app/CoreApp.d.ts

@@ -34,6 +34,10 @@ export declare abstract class CoreApp<U extends IUser, S extends IAppSettings, N
      * Settings
      */
     readonly settings: S;
+    /**
+     * Default region
+     */
+    readonly defaultRegion: AddressRegion;
     /**
      * Fields
      */

package/lib/mjs/app/CoreApp.js

@@ -89,6 +89,7 @@ export class CoreApp {
      * @param name Application name
      */
     constructor(settings, api, notifier, storage, name) {
+        var _a;
         this._authorized = false;
         this._isTryingLogin = false;
         /**
@@ -107,7 +108,15 @@ export class CoreApp {
          * Passphrase for encryption
          */
         this.passphrase = '';
+        if (((_a = settings === null || settings === void 0 ? void 0 : settings.regions) === null || _a === void 0 ? void 0 : _a.length) === 0) {
+            throw new Error('No regions defined');
+        }
         this.settings = settings;
+        const region = AddressRegion.getById(settings.regions[0]);
+        if (region == null) {
+            throw new Error('No default region defined');
+        }
+        this.defaultRegion = region;
         this.api = api;
         this.notifier = notifier;
         this.storage = storage;

package/lib/mjs/app/IApp.d.ts

@@ -64,6 +64,10 @@ export interface IApp {
      * Settings
      */
     readonly settings: IAppSettings;
+    /**
+     * Default region
+     */
+    readonly defaultRegion: AddressRegion;
     /**
      * Fields
      */

package/lib/mjs/erp/AddressApi.d.ts

@@ -27,6 +27,12 @@ export declare class AddressApi extends BaseApi {
      * @param rq Rquest data
      */
     getRegions(rq?: RegionsRQ): Promise<AddressRegionDb[] | undefined>;
+    /**
+     * Get region's currency, current region's currency as default
+     * @param regionId Region id
+     * @returns Result
+     */
+    regionCurrency(regionId?: string): "AUD" | "CAD" | "CNY" | "EUR" | "GBP" | "HKD" | "JPY" | "NZD" | "SGD" | "USD";
     /**
      * Get all local regions
      */

package/lib/mjs/erp/AddressApi.js

@@ -75,6 +75,18 @@ export class AddressApi extends BaseApi {
         // Return the top items
         return regions.slice(0, items);
     }
+    /**
+     * Get region's currency, current region's currency as default
+     * @param regionId Region id
+     * @returns Result
+     */
+    regionCurrency(regionId) {
+        var _a;
+        const region = (_a = (regionId
+            ? this.regions().find((region) => region.id === regionId)
+            : null)) !== null && _a !== void 0 ? _a : this.app.settings.currentRegion;
+        return region.currency;
+    }
     regions(p) {
         const items = p == null || p.length === 0
             ? AddressRegion.all

package/lib/mjs/erp/PublicApi.d.ts

@@ -11,20 +11,33 @@ import { PublicOrgProductDto, PublicProductDto } from './dto/PublicProductDto';
  * Public API
  */
 export declare class PublicApi extends BaseApi {
+    /**
+     * Default currency
+     */
+    defaultCurrency: string | Currency;
     /**
      * Get currencies
-     * @param currencyNames Limited currency names for local data, undefined will try to retrive remoately
+     * @param names Limited currency names for local data, undefined will try to retrive remoately
      * @returns Result
      */
     currencies(): Promise<CurrencyDto[] | undefined>;
     currencies(names: string[] | Currency[] | boolean): ListType1[];
+    /**
+     * Get exchange amount
+     * @param amount Amount
+     * @param sourceCurrency Source currency
+     * @param targetCurrency Target currency
+     * @returns Result
+     */
+    exchangeAmount(amount: number, sourceCurrency: Currency | string, targetCurrency?: Currency | string): Promise<number | undefined>;
     /**
      * Get exchange rate
      * @param currency Currency
      * @param payload Payload
+     * @param reload Reload data
      * @returns Result
      */
-    exchangeRate(currency: Currency | string, payload?: IApiPayload<ExchangeRateDto>): Promise<ExchangeRateDto | undefined>;
+    exchangeRate(currency: Currency | string, payload?: IApiPayload<ExchangeRateDto>, reload?: boolean): Promise<ExchangeRateDto | undefined>;
     /**
      * Get exchange rate history
      * @param currencies Currencies
@@ -33,6 +46,12 @@ export declare class PublicApi extends BaseApi {
      * @returns Result
      */
     exchangeRateHistory(currencies: (Currency | string)[], months?: number, payload?: IApiPayload<ExchangeRateHistoryDto[]>): Promise<ExchangeRateHistoryDto[] | undefined>;
+    /**
+     * Get currency label
+     * @param currency Currency
+     * @returns Label
+     */
+    getCurrencyLabel(currency: Currency | string): string;
     /**
      * Get product unit's label
      * Please define the label in culture with key 'unitPC' for ProductUnit.PC like that

package/lib/mjs/erp/PublicApi.js

@@ -3,10 +3,18 @@ import { Currencies } from '../business/Currency';
 import { ProductUnit } from '../business/ProductUnit';
 import { RepeatOption } from '../business/RepeatOption';
 import { BaseApi } from './BaseApi';
+const cachedCurrencyRates = {};
 /**
  * Public API
  */
 export class PublicApi extends BaseApi {
+    constructor() {
+        super(...arguments);
+        /**
+         * Default currency
+         */
+        this.defaultCurrency = this.app.defaultRegion.currency;
+    }
     currencies(names) {
         if (typeof names === 'boolean' && names) {
             return Currencies.map((name) => {
@@ -31,14 +39,48 @@ export class PublicApi extends BaseApi {
             showLoading: false
         });
     }
+    /**
+     * Get exchange amount
+     * @param amount Amount
+     * @param sourceCurrency Source currency
+     * @param targetCurrency Target currency
+     * @returns Result
+     */
+    async exchangeAmount(amount, sourceCurrency, targetCurrency) {
+        targetCurrency !== null && targetCurrency !== void 0 ? targetCurrency : (targetCurrency = this.app.defaultRegion.currency);
+        const [sourceRate, targetRate] = await Promise.all([
+            this.exchangeRate(sourceCurrency, {
+                showLoading: false
+            }),
+            this.exchangeRate(targetCurrency, {
+                showLoading: false
+            })
+        ]);
+        if (sourceRate == null || targetRate == null)
+            return undefined;
+        const result = Math.round((1000 * amount * sourceRate.exchangeRate) /
+            targetRate.exchangeRate) / 1000;
+        return result;
+    }
     /**
      * Get exchange rate
      * @param currency Currency
      * @param payload Payload
+     * @param reload Reload data
      * @returns Result
      */
-    exchangeRate(currency, payload) {
-        return this.api.get(`Public/ExchangeRate/${currency}`, undefined, payload);
+    async exchangeRate(currency, payload, reload = false) {
+        let rate = cachedCurrencyRates[currency];
+        if (rate == null || reload) {
+            rate =
+                currency === this.defaultCurrency
+                    ? { exchangeRate: 100, updateTime: new Date() }
+                    : await this.api.get(`Public/ExchangeRate/${currency}`, undefined, payload);
+            if (rate == null)
+                return undefined;
+            cachedCurrencyRates[currency] = rate;
+        }
+        return rate;
     }
     /**
      * Get exchange rate history
@@ -51,6 +93,16 @@ export class PublicApi extends BaseApi {
         payload !== null && payload !== void 0 ? payload : (payload = { defaultValue: [] });
         return this.api.post('Public/ExchangeRateHistory', { currencies, months }, payload);
     }
+    /**
+     * Get currency label
+     * @param currency Currency
+     * @returns Label
+     */
+    getCurrencyLabel(currency) {
+        var _a;
+        const c = `currency${currency}`;
+        return (_a = this.app.get(c)) !== null && _a !== void 0 ? _a : c;
+    }
     /**
      * Get product unit's label
      * Please define the label in culture with key 'unitPC' for ProductUnit.PC like that

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@etsoo/appscript",
-    "version": "1.3.37",
+    "version": "1.3.38",
     "description": "Applications shared TypeScript framework",
     "main": "lib/cjs/index.js",
     "module": "lib/mjs/index.js",
@@ -65,8 +65,8 @@
         "@babel/preset-env": "^7.20.2",
         "@babel/runtime-corejs3": "^7.20.1",
         "@types/jest": "^29.2.3",
-        "@typescript-eslint/eslint-plugin": "^5.43.0",
-        "@typescript-eslint/parser": "^5.43.0",
+        "@typescript-eslint/eslint-plugin": "^5.44.0",
+        "@typescript-eslint/parser": "^5.44.0",
         "eslint": "^8.28.0",
         "eslint-config-airbnb-base": "^15.0.0",
         "eslint-plugin-import": "^2.26.0",

package/src/app/CoreApp.ts

@@ -89,6 +89,11 @@ export abstract class CoreApp<
      */
     readonly settings: S;
 
+    /**
+     * Default region
+     */
+    readonly defaultRegion: AddressRegion;
+
     /**
      * Fields
      */
@@ -246,7 +251,17 @@ export abstract class CoreApp<
         storage: IStorage,
         name: string
     ) {
+        if (settings?.regions?.length === 0) {
+            throw new Error('No regions defined');
+        }
         this.settings = settings;
+
+        const region = AddressRegion.getById(settings.regions[0]);
+        if (region == null) {
+            throw new Error('No default region defined');
+        }
+        this.defaultRegion = region;
+
         this.api = api;
         this.notifier = notifier;
         this.storage = storage;

package/src/app/IApp.ts

@@ -89,6 +89,11 @@ export interface IApp {
      */
     readonly settings: IAppSettings;
 
+    /**
+     * Default region
+     */
+    readonly defaultRegion: AddressRegion;
+
     /**
      * Fields
      */

package/src/erp/AddressApi.ts

@@ -92,6 +92,19 @@ export class AddressApi extends BaseApi {
         return regions.slice(0, items);
     }
 
+    /**
+     * Get region's currency, current region's currency as default
+     * @param regionId Region id
+     * @returns Result
+     */
+    regionCurrency(regionId?: string) {
+        const region =
+            (regionId
+                ? this.regions().find((region) => region.id === regionId)
+                : null) ?? this.app.settings.currentRegion;
+        return region.currency;
+    }
+
     /**
      * Get all local regions
      */

package/src/erp/PublicApi.ts

@@ -9,13 +9,22 @@ import { ExchangeRateDto } from './dto/ExchangeRateDto';
 import { ExchangeRateHistoryDto } from './dto/ExchangeRateHistoryDto';
 import { PublicOrgProductDto, PublicProductDto } from './dto/PublicProductDto';
 
+const cachedCurrencyRates: {
+    [P: Currency | string]: ExchangeRateDto | undefined | null;
+} = {};
+
 /**
  * Public API
  */
 export class PublicApi extends BaseApi {
+    /**
+     * Default currency
+     */
+    defaultCurrency: string | Currency = this.app.defaultRegion.currency;
+
     /**
      * Get currencies
-     * @param currencyNames Limited currency names for local data, undefined will try to retrive remoately
+     * @param names Limited currency names for local data, undefined will try to retrive remoately
      * @returns Result
      */
     currencies(): Promise<CurrencyDto[] | undefined>;
@@ -41,21 +50,64 @@ export class PublicApi extends BaseApi {
         });
     }
 
+    /**
+     * Get exchange amount
+     * @param amount Amount
+     * @param sourceCurrency Source currency
+     * @param targetCurrency Target currency
+     * @returns Result
+     */
+    async exchangeAmount(
+        amount: number,
+        sourceCurrency: Currency | string,
+        targetCurrency?: Currency | string
+    ) {
+        targetCurrency ??= this.app.defaultRegion.currency;
+
+        const [sourceRate, targetRate] = await Promise.all([
+            this.exchangeRate(sourceCurrency, {
+                showLoading: false
+            }),
+            this.exchangeRate(targetCurrency, {
+                showLoading: false
+            })
+        ]);
+        if (sourceRate == null || targetRate == null) return undefined;
+
+        const result =
+            Math.round(
+                (1000 * amount * sourceRate.exchangeRate) /
+                    targetRate.exchangeRate
+            ) / 1000;
+        return result;
+    }
+
     /**
      * Get exchange rate
      * @param currency Currency
      * @param payload Payload
+     * @param reload Reload data
      * @returns Result
      */
-    exchangeRate(
+    async exchangeRate(
         currency: Currency | string,
-        payload?: IApiPayload<ExchangeRateDto>
+        payload?: IApiPayload<ExchangeRateDto>,
+        reload = false
     ) {
-        return this.api.get(
-            `Public/ExchangeRate/${currency}`,
-            undefined,
-            payload
-        );
+        let rate = cachedCurrencyRates[currency];
+        if (rate == null || reload) {
+            rate =
+                currency === this.defaultCurrency
+                    ? { exchangeRate: 100, updateTime: new Date() }
+                    : await this.api.get(
+                          `Public/ExchangeRate/${currency}`,
+                          undefined,
+                          payload
+                      );
+            if (rate == null) return undefined;
+            cachedCurrencyRates[currency] = rate;
+        }
+        return rate;
     }
 
     /**
@@ -78,6 +130,16 @@ export class PublicApi extends BaseApi {
         );
     }
 
+    /**
+     * Get currency label
+     * @param currency Currency
+     * @returns Label
+     */
+    getCurrencyLabel(currency: Currency | string) {
+        const c = `currency${currency}`;
+        return this.app.get(c) ?? c;
+    }
+
     /**
      * Get product unit's label
      * Please define the label in culture with key 'unitPC' for ProductUnit.PC like that