bysquare 2.0.0 → 2.1.0

package/lib/mjs/types.d.ts

@@ -0,0 +1,379 @@
+/**
+ * Selection of one or more months on which payment occurs. This is enabled
+ * only if periodicity is set to one of the following value: “Weekly,
+ * Biweekly, Monthly, Bimonthly”. Otherwise it must not be specified.
+ */
+export declare enum MonthClassifier {
+    January = 1,
+    February = 2,
+    March = 4,
+    April = 8,
+    May = 16,
+    June = 32,
+    July = 64,
+    August = 128,
+    September = 256,
+    October = 512,
+    November = 1024,
+    December = 2048
+}
+/**
+ * Periodicity of the payment. All valid options are „Daily“, „Weekly“,
+ * „Biweekly“, „Monthly“, „Bimonthly“, „Quarterly“, „Annually“,
+ * „Semiannually“. To find out which periodicity types are supported by the
+ * banks see the following web site: http://www.sbaonline.sk/sk/
+ */
+export declare enum Periodicity {
+    Daily = "d",
+    Weekly = "w",
+    Biweekly = "b",
+    Monthly = "m",
+    Bimonthly = "B",
+    Quarterly = "q",
+    Semiannually = "s",
+    Annually = "a"
+}
+/**
+ * This is the payment day. It‘s meaning depends on the periodicity, meaning
+ * either day of the month (number between 1 and 31) or day of the week
+ * (1=Monday,2=Tuesday, …, 7=Sunday).
+ *
+ * Max length 2
+ */
+export type Day = 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31;
+export declare enum PaymentOptions {
+    PaymentOrder = 1,
+    StandingOrder = 2,
+    DirectDebit = 4
+}
+/**
+ * In section „encoding BankAccounts“ we provide further recommendations for
+ * encoding bank account
+ */
+export type BankAccount = {
+    /**
+     * Max length 34
+     */
+    iban: string;
+    /**
+     * Format ISO 9362 (swift)
+     * 8 or 11 characters long
+     */
+    bic?: string;
+};
+/**
+ * If DirectDebitScheme value is 1, which is „SEPA“ than encoded direct
+ * debit follows SEPA direct debit scheme which means that fields MandateID,
+ * CreditorID and optional ContractID are used. If direct debit scheme is 0,
+ * which is „OTHER“ this means no specific direct debit scheme and following
+ * rules do apply:
+ *
+ * a. Creditor is identified via bank accounts
+ *
+ * b. Contract between debtor and creditor is identified using one of the
+ *    following two ways: 1. by two optional fields SpecificSymbol and
+ *    VariableSymbol. 2. by one optional field OriginatorsReferenceInformation.
+ *    If SpecificSymbol and VariableSymbol fields or
+ *    OriginatorsReferenceInformation field is filled in DirectDebitExt then
+ *    these fields do apply for the direct debit.
+ */
+export declare enum DirectDebitScheme {
+    Other = 0,
+    Sepa = 1
+}
+/**
+ * Can be „one­off“ for one time debit or „recurrent“ for repeated debit
+ * until cancelled.
+ *
+ * Max length 1
+ */
+export declare enum DirectDebitType {
+    OneOff = 0,
+    Recurrent = 1
+}
+export type Beneficiary = {
+    /**
+     * Belongs to the N-th payment
+     *
+     * Max length 70
+     */
+    name?: string;
+    /**
+     * Belongs to the N-th payment
+     * Commonly used street and street number
+     *
+     * Max length 70
+     */
+    street?: string;
+    /**
+     * Belongs to the N-th payment
+     * Commonly used for City
+     *
+     * Max length 70
+     */
+    city?: string;
+};
+export type SimplePayment = {
+    /**
+     * Encoded with amount payable. This field is not required and can be left
+     * blank in cases payment amount is not known ­such as donations.
+     *
+     * Decimal, max length 15
+     */
+    amount?: number;
+    /**
+     * 3 letter, payment currency code according to ISO-4217
+     */
+    currencyCode: keyof typeof CurrencyCodeEnum;
+    /**
+     * Format YYYYMMDD
+     */
+    paymentDueDate?: string;
+    /**
+     * Max length 10
+     */
+    variableSymbol?: string;
+    /**
+     * Max length 4
+     */
+    constantSymbol?: string;
+    /**
+     * Max length 10
+     */
+    specificSymbol?: string;
+    /**
+     * Max length 35
+     */
+    originatorRefInfo?: string;
+    /**
+     * Optional field. In previous section we provide further recommendations
+     * for encoding payment note.
+     *
+     * Max length 140
+     */
+    paymentNote?: string;
+    bankAccounts: BankAccount[];
+    beneficiary?: Beneficiary;
+};
+export type PaymentOrder = SimplePayment & {
+    type: PaymentOptions.PaymentOrder;
+};
+export type StandingOrder = SimplePayment & {
+    type: PaymentOptions.StandingOrder;
+    day?: Day;
+    month?: MonthClassifier;
+    periodicity?: Periodicity;
+    /**
+     * Defines the day of the last payment of the standing order. After this
+     * date, standing order is cancelled.
+     *
+     * Format YYYYMMDD
+     */
+    lastDate?: string;
+};
+export type DirectDebit = SimplePayment & {
+    type: PaymentOptions.DirectDebit;
+    directDebitScheme?: DirectDebitScheme;
+    directDebitType?: DirectDebitType;
+    /**
+     * Max length 35
+     */
+    mandateId?: string;
+    /**
+     * Max length 35
+     */
+    creditorId?: string;
+    /**
+     * Max length 35
+     */
+    contractId?: string;
+    /**
+     * Optional field. As most users prefer to set up some maximum amount for
+     * the direct debit, this can be pre­-filled for them.
+     *
+     * Decimal, max length 15
+     */
+    maxAmount?: number;
+    /**
+     * Defines the day after which direct debit is cancelled.
+     *
+     * Max length 8
+     * Format YYYYMMDD
+     */
+    validTillDate?: string;
+};
+export type Payment = PaymentOrder | StandingOrder | DirectDebit;
+export type DataModel = {
+    /**
+     * Max length 10
+     */
+    invoiceId?: string;
+    payments: Payment[];
+};
+/**
+ * Currency codes based on ISO-4217
+ */
+export declare enum CurrencyCodeEnum {
+    AED = "United Arab Emirates Dirham",
+    AFN = "Afghanistan Afghani",
+    ALL = "Albania Lek",
+    AMD = "Armenia Dram",
+    ANG = "Netherlands Antilles Guilder",
+    AOA = "Angola Kwanza",
+    ARS = "Argentina Peso",
+    AUD = "Australia Dollar",
+    AWG = "Aruba Guilder",
+    AZN = "Azerbaijan New Manat",
+    BAM = "Bosnia and Herzegovina Convertible Marka",
+    BBD = "Barbados Dollar",
+    BDT = "Bangladesh Taka",
+    BGN = "Bulgaria Lev",
+    BHD = "Bahrain Dinar",
+    BIF = "Burundi Franc",
+    BMD = "Bermuda Dollar",
+    BND = "Brunei Darussalam Dollar",
+    BOB = "Bolivia Bol\u00EDviano",
+    BRL = "Brazil Real",
+    BSD = "Bahamas Dollar",
+    BTN = "Bhutan Ngultrum",
+    BWP = "Botswana Pula",
+    BYR = "Belarus Ruble",
+    BZD = "Belize Dollar",
+    CAD = "Canada Dollar",
+    CDF = "Congo/Kinshasa Franc",
+    CHF = "Switzerland Franc",
+    CLP = "Chile Peso",
+    CNY = "China Yuan Renminbi",
+    COP = "Colombia Peso",
+    CRC = "Costa Rica Colon",
+    CUC = "Cuba Convertible Peso",
+    CUP = "Cuba Peso",
+    CVE = "Cape Verde Escudo",
+    CZK = "Czech Republic Koruna",
+    DJF = "Djibouti Franc",
+    DKK = "Denmark Krone",
+    DOP = "Dominican Republic Peso",
+    DZD = "Algeria Dinar",
+    EGP = "Egypt Pound",
+    ERN = "Eritrea Nakfa",
+    ETB = "Ethiopia Birr",
+    EUR = "Euro Member Countries",
+    FJD = "Fiji Dollar",
+    FKP = "Falkland Islands  = Malvinas Pound",
+    GBP = "United Kingdom Pound",
+    GEL = "Georgia Lari",
+    GGP = "Guernsey Pound",
+    GHS = "Ghana Cedi",
+    GIP = "Gibraltar Pound",
+    GMD = "Gambia Dalasi",
+    GNF = "Guinea Franc",
+    GTQ = "Guatemala Quetzal",
+    GYD = "Guyana Dollar",
+    HKD = "Hong Kong Dollar",
+    HNL = "Honduras Lempira",
+    HRK = "Croatia Kuna",
+    HTG = "Haiti Gourde",
+    HUF = "Hungary Forint",
+    IDR = "Indonesia Rupiah",
+    ILS = "Israel Shekel",
+    IMP = "Isle of Man Pound",
+    INR = "India Rupee",
+    IQD = "Iraq Dinar",
+    IRR = "Iran Rial",
+    ISK = "Iceland Krona",
+    JEP = "Jersey Pound",
+    JMD = "Jamaica Dollar",
+    JOD = "Jordan Dinar",
+    JPY = "Japan Yen",
+    KES = "Kenya Shilling",
+    KGS = "Kyrgyzstan Som",
+    KHR = "Cambodia Riel",
+    KMF = "Comoros Franc",
+    KPW = "Korea  = North Won",
+    KRW = "Korea  = South Won",
+    KWD = "Kuwait Dinar",
+    KYD = "Cayman Islands Dollar",
+    KZT = "Kazakhstan Tenge",
+    LAK = "Laos Kip",
+    LBP = "Lebanon Pound",
+    LKR = "Sri Lanka Rupee",
+    LRD = "Liberia Dollar",
+    LSL = "Lesotho Loti",
+    LYD = "Libya Dinar",
+    MAD = "Morocco Dirham",
+    MDL = "Moldova Leu",
+    MGA = "Madagascar Ariary",
+    MKD = "Macedonia Denar",
+    MMK = "Myanmar  = Burma Kyat",
+    MNT = "Mongolia Tughrik",
+    MOP = "Macau Pataca",
+    MRO = "Mauritania Ouguiya",
+    MUR = "Mauritius Rupee",
+    MVR = "Maldives  = Maldive Islands Rufiyaa",
+    MWK = "Malawi Kwacha",
+    MXN = "Mexico Peso",
+    MYR = "Malaysia Ringgit",
+    MZN = "Mozambique Metical",
+    NAD = "Namibia Dollar",
+    NGN = "Nigeria Naira",
+    NIO = "Nicaragua Cordoba",
+    NOK = "Norway Krone",
+    NPR = "Nepal Rupee",
+    NZD = "New Zealand Dollar",
+    OMR = "Oman Rial",
+    PAB = "Panama Balboa",
+    PEN = "Peru Sol",
+    PGK = "Papua New Guinea Kina",
+    PHP = "Philippines Peso",
+    PKR = "Pakistan Rupee",
+    PLN = "Poland Zloty",
+    PYG = "Paraguay Guarani",
+    QAR = "Qatar Riyal",
+    RON = "Romania New Leu",
+    RSD = "Serbia Dinar",
+    RUB = "Russia Ruble",
+    RWF = "Rwanda Franc",
+    SAR = "Saudi Arabia Riyal",
+    SBD = "Solomon Islands Dollar",
+    SCR = "Seychelles Rupee",
+    SDG = "Sudan Pound",
+    SEK = "Sweden Krona",
+    SGD = "Singapore Dollar",
+    SHP = "Saint Helena Pound",
+    SLL = "Sierra Leone Leone",
+    SOS = "Somalia Shilling",
+    SPL = "Seborga Luigino",
+    SRD = "Suriname Dollar",
+    STD = "S\u00E3o Tom\u00E9 and Pr\u00EDncipe Dobra",
+    SVC = "El Salvador Colon",
+    SYP = "Syria Pound",
+    SZL = "Swaziland Lilangeni",
+    THB = "Thailand Baht",
+    TJS = "Tajikistan Somoni",
+    TMT = "Turkmenistan Manat",
+    TND = "Tunisia Dinar",
+    TOP = "Tonga Pa'anga",
+    TRY = "Turkey Lira",
+    TTD = "Trinidad and Tobago Dollar",
+    TVD = "Tuvalu Dollar",
+    TWD = "Taiwan New Dollar",
+    TZS = "Tanzania Shilling",
+    UAH = "Ukraine Hryvnia",
+    UGX = "Uganda Shilling",
+    USD = "United States Dollar",
+    UYU = "Uruguay Peso",
+    UZS = "Uzbekistan Som",
+    VEF = "Venezuela Bolivar",
+    VND = "Viet Nam Dong",
+    VUV = "Vanuatu Vatu",
+    WST = "Samoa Tala",
+    XAF = "Communaut\u00E9 Financi\u00E8re Africaine  = BEAC CFA Franc BEAC",
+    XCD = "East Caribbean Dollar",
+    XDR = "International Monetary Fund  = IMF Special Drawing Rights",
+    XOF = "Communaut\u00E9 Financi\u00E8re Africaine  = BCEAO Franc",
+    XPF = "Comptoirs Fran\u00E7ais du Pacifique  = CFP Franc",
+    YER = "Yemen Rial",
+    ZAR = "South Africa Rand",
+    ZMW = "Zambia Kwacha",
+    ZWD = "Zimbabwe Dollar"
+}

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "bysquare",
 	"description": "It's a national standard for payment QR codes adopted by Slovak Banking Association (SBA)",
-	"version": "2.0.0",
+	"version": "2.1.0",
 	"license": "Apache-2.0",
 	"type": "module",
 	"funding": "https://github.com/sponsors/xseman",
@@ -12,8 +12,9 @@
 	},
 	"scripts": {
 		"prebuild": "rm -rf ./lib || :",
-		"build": "tsc",
-		"postbuild": "chmod +x ./lib/cli.js",
+		"build": "tsc --project ./tsconfig.json && tsc --project ./tsconfig.cjs.json",
+		"typecheck": "tsc --noEmit",
+		"postbuild": "bash -c 'chmod +x ./lib/{cjs,mjs}/cli.js' && cp package.json ./lib/mjs/ && jq '.type=\"commonjs\"' package.json > lib/cjs/package.json",
 		"test": "xv --loader=tsx ./src",
 		"test:watch": "find ./src/*.ts | entr xv --loader=tsx ./src",
 		"cli:local": "npm run build && npm link bysquare",
@@ -24,9 +25,10 @@
 		"postversion": ""
 	},
 	"dependencies": {
+		"crc-32": "~1.2.0",
 		"lodash.deburr": "~4.1.0",
-		"lzma-native": "7.0.1",
-		"rfc4648": "1.5.2"
+		"lzma": "~2.3.0",
+		"rfc4648": "~1.5.0"
 	},
 	"devDependencies": {
 		"@types/lodash.deburr": "~4.1.0",
@@ -36,9 +38,14 @@
 		"typescript": "~4.9.0",
 		"xv": "~2.1.0"
 	},
-	"bin": "lib/cli.js",
-	"main": "lib/index.js",
-	"types": "lib/index.d.ts",
+	"bin": "lib/mjs/cli.js",
+	"types": "lib/mjs/index.d.ts",
+	"exports": {
+		".": {
+			"require": "./lib/cjs/index.js",
+			"import": "./lib/mjs/index.js"
+		}
+	},
 	"files": [
 		"lib",
 		"!lib/*.test.*"