@etsoo/appscript 1.3.2 → 1.3.4

package/src/erp/PublicApi.ts

@@ -0,0 +1,156 @@
+import { DataTypes, ListType, ListType1 } from '@etsoo/shared';
+import { Currency } from '../business/Currency';
+import { ProductUnit } from '../business/ProductUnit';
+import { RepeatOption } from '../business/RepeatOption';
+import { BaseApi } from './BaseApi';
+import { CurrencyDto } from './dto/CurrencyDto';
+import { ExchangeRateDto } from './dto/ExchangeRateDto';
+import { ExchangeRateHistoryDto } from './dto/ExchangeRateHistoryDto';
+import { PublicOrgProductDto, PublicProductDto } from './dto/PublicProductDto';
+
+/**
+ * Public API
+ */
+export class PublicApi extends BaseApi {
+    /**
+     * Get currencies
+     * @param currencyNames Limited currency names for local data, undefined will try to retrive remoately
+     * @returns Result
+     */
+    async currencies<T extends string[] | Currency[] | undefined>(
+        currencyNames?: T
+    ): Promise<T extends undefined ? CurrencyDto[] | undefined : ListType1[]> {
+        if (currencyNames == null)
+            return (await this.app.api.get<CurrencyDto[]>(
+                'Public/GetCurrencies'
+            )) as any;
+        else
+            return currencyNames.map((name) => ({
+                id: name,
+                label: this.app.get(`currency${name}`) ?? name
+            })) as any;
+    }
+
+    /**
+     * Get exchange rate
+     * @param currency Currency
+     * @returns Result
+     */
+    exchangeRate(currency: Currency) {
+        return this.app.api.get<ExchangeRateDto>(
+            `Public/ExchangeRate/${currency}`
+        );
+    }
+
+    /**
+     * Get exchange rate history
+     * @param currencies Currencies
+     * @param months Max months
+     * @returns Result
+     */
+    exchangeRateHistory(currencies: Currency[], months?: number) {
+        return this.app.api.post<ExchangeRateHistoryDto[]>(
+            'Public/ExchangeRateHistory',
+            { currencies, months },
+            { defaultValue: [] }
+        );
+    }
+
+    /**
+     * Get product unit's label
+     * Please define the label in culture with key 'unitPC' for ProductUnit.PC like that
+     * @param unit Unit
+     * @param isJoined Add the join label like 'per Kg' for Kg
+     * @returns Label
+     */
+    getUnitLabel(unit: ProductUnit, isJoined?: boolean | string) {
+        const key = ProductUnit[unit];
+        const label = this.app.get('unit' + key) ?? key;
+        const join = this.getUnitJoin(isJoined);
+        if (join) {
+            return join.format(label);
+        }
+        return label;
+    }
+
+    private getUnitJoin(isJoined: boolean | string | undefined) {
+        return typeof isJoined === 'string'
+            ? this.app.get(isJoined) ?? isJoined
+            : isJoined
+            ? this.app.get('unitJoin')
+            : undefined;
+    }
+
+    /**
+     * Get mobile base64 QRCode
+     * @param id User id
+     * @param host Host URL
+     */
+    mobileQRCode(id?: string, host?: string) {
+        return this.app.api.post<string>('Public/MobileQRCode', { id, host });
+    }
+
+    /**
+     * Get public and valid product data
+     * @param id Product/Service Id or Uid
+     * @param culture Language
+     * @returns Result
+     */
+    product<T extends number | string>(
+        id: T,
+        culture?: string
+    ): T extends number ? PublicProductDto : PublicOrgProductDto {
+        culture = this.app.checkLanguage(culture);
+        return this.app.api.post<PublicProductDto>(
+            `Public/Product/${id}/${culture}`
+        ) as any;
+    }
+
+    /**
+     *
+     * Get all repeat options
+     * @param options Define the order and limit the items
+     * @param isJoined Add the join label like 'per Kg' for Kg
+     * @returns Units
+     */
+    repeatOptions(options?: string[], isJoined: boolean = true): ListType[] {
+        options ??= DataTypes.getEnumKeys(RepeatOption);
+        return this.units(options, isJoined);
+    }
+
+    /**
+     * Get all product units
+     * @returns Units
+     */
+    units(): ListType[];
+
+    /**
+     *
+     * Get all product units
+     * @param options Define the order and limit the items
+     * @param isJoined Add the join label like 'per Kg' for Kg
+     * @returns Units
+     */
+    units(options?: string[], isJoined?: boolean): ListType[];
+
+    /**
+     *
+     * Get all product units
+     * @param options Define the order and limit the items
+     * @param isJoined Add the join label like 'per Kg' for Kg
+     * @returns Units
+     */
+    units(options?: string[], isJoined?: boolean | string): ListType[] {
+        options ??= DataTypes.getEnumKeys(ProductUnit);
+        return options.map((key) => {
+            const id = DataTypes.getEnumByKey(ProductUnit, key)! as number;
+            return {
+                id,
+                label: this.getUnitLabel(
+                    id,
+                    this.getUnitJoin(isJoined)
+                ).formatInitial(true)
+            };
+        });
+    }
+}

package/src/erp/dto/CurrencyDto.ts

@@ -0,0 +1,7 @@
+import { ListType1 } from '@etsoo/shared';
+import { ExchangeRateDto } from './ExchangeRateDto';
+
+/**
+ * Currency data
+ */
+export type CurrencyDto = ListType1 & ExchangeRateDto;

package/src/erp/dto/ExchangeRateDto.ts

@@ -0,0 +1,14 @@
+/**
+ * Exchange rate data
+ */
+export type ExchangeRateDto = {
+    /**
+     * Exchange rate
+     */
+    exchangeRate: number;
+
+    /**
+     * Update time
+     */
+    updateTime: string | Date;
+};

package/src/erp/dto/ExchangeRateHistoryDto.ts

@@ -0,0 +1,9 @@
+import { Currency } from '../../business/Currency';
+import { ExchangeRateDto } from './ExchangeRateDto';
+
+/**
+ * Exchange rate history data
+ */
+export type ExchangeRateHistoryDto = ExchangeRateDto & {
+    id: Currency;
+};

package/src/erp/dto/PublicProductDto.ts

@@ -0,0 +1,41 @@
+import { EntityStatus } from '../../business/EntityStatus';
+
+/**
+ * Public product data
+ */
+export type PublicProductDto = {
+    /**
+     * Id
+     */
+    id: number;
+
+    /**
+     * Name
+     */
+    name: string;
+
+    /**
+     * Logo
+     */
+    logo?: string;
+
+    /**
+     * Web URL for access
+     */
+    webUrl: string;
+};
+
+/**
+ * Public product with organization data
+ */
+export type PublicOrgProductDto = PublicProductDto & {
+    /**
+     * Purchased service status
+     */
+    serviceEntityStatus?: EntityStatus;
+
+    /**
+     * Purchased service expiry
+     */
+    serviceExpiry?: string | Date;
+};

package/src/i18n/address.en-US.json

@@ -0,0 +1,21 @@
+{
+    "continentAF": "Africa",
+    "continentAN": "Antarctica",
+    "continentAS": "Asia",
+    "continentEU": "Europe",
+    "continentNA": "North America",
+    "continentOC": "Oceania",
+    "continentSA": "South America",
+    "regionAU": "Australia",
+    "regionCA": "Canada",
+    "regionCN": "Mainland China",
+    "regionDE": "Germany",
+    "regionFR": "France",
+    "regionGB": "United Kingdom",
+    "regionHK": "Hong Kong, China",
+    "regionIE": "Ireland",
+    "regionJP": "Japan",
+    "regionNZ": "New Zealand",
+    "regionSG": "Singapore",
+    "regionUS": "United States"
+}

package/src/i18n/address.zh-CN.json

@@ -0,0 +1,21 @@
+{
+    "continentAF": "非洲",
+    "continentAN": "南极洲",
+    "continentAS": "亚洲",
+    "continentEU": "欧洲",
+    "continentNA": "北美洲",
+    "continentOC": "大洋洲",
+    "continentSA": "南美洲",
+    "regionAU": "澳大利亚",
+    "regionCA": "加拿大",
+    "regionCN": "中国大陆",
+    "regionDE": "德国",
+    "regionFR": "法国",
+    "regionGB": "英国",
+    "regionHK": "中国香港",
+    "regionIE": "爱尔兰",
+    "regionJP": "日本",
+    "regionNZ": "新西兰",
+    "regionSG": "新加坡",
+    "regionUS": "美国"
+}

package/src/i18n/address.zh-HK.json

@@ -0,0 +1,21 @@
+{
+    "continentAF": "非洲",
+    "continentAN": "南極洲",
+    "continentAS": "亞洲",
+    "continentEU": "歐洲",
+    "continentNA": "北美洲",
+    "continentOC": "大洋洲",
+    "continentSA": "南美洲",
+    "regionAU": "澳大利亞",
+    "regionCA": "加拿大",
+    "regionCN": "中國大陸",
+    "regionDE": "德國",
+    "regionFR": "法國",
+    "regionGB": "英國",
+    "regionHK": "中國香港",
+    "regionIE": "愛爾蘭",
+    "regionJP": "日本",
+    "regionNZ": "新西蘭",
+    "regionSG": "新加坡",
+    "regionUS": "美國"
+}

package/src/index.ts

@@ -1,6 +1,7 @@
 // address
 export * from './address/AddressContinent';
 export * from './address/AddressRegion';
+export * from './address/AddressState';
 export * from './address/AddressUtils';
 
 // app
@@ -17,6 +18,7 @@ export * from './bridges/IBridgeHost';
 // business
 export * from './business/BusinessTax';
 export * from './business/BusinessUtils';
+export * from './business/Currency';
 export * from './business/EntityStatus';
 export * from './business/ProductUnit';
 export * from './business/RepeatOption';
@@ -29,6 +31,12 @@ export * from './dto/IdLabelDto';
 export * from './dto/IdLabelPrimaryDto';
 export * from './dto/InitCallDto';
 
+// erp
+export * from './erp/AddressApi';
+export * from './erp/BaseApi';
+export * from './erp/OrgApi';
+export * from './erp/PublicApi';
+
 // i18n
 export * from './i18n/enUS';
 export * from './i18n/zhCN';