@xyo-network/payment-payload-plugins 3.0.17 → 3.0.19

package/src/Amount/Iso4217Currency.ts

@@ -0,0 +1,557 @@
+/* eslint-disable max-lines */
+/**
+ * ISO 4217 currency codes
+ */
+export type Iso4217AlphabeticalCode =
+  'AED' |
+  'AFN' |
+  'ALL' |
+  'AMD' |
+  'ANG' |
+  'AOA' |
+  'ARS' |
+  'AUD' |
+  'AWG' |
+  'AZN' |
+  'BAM' |
+  'BBD' |
+  'BDT' |
+  'BGN' |
+  'BHD' |
+  'BIF' |
+  'BMD' |
+  'BND' |
+  'BOB' |
+  'BOV' |
+  'BRL' |
+  'BSD' |
+  'BTN' |
+  'BWP' |
+  'BYN' |
+  'BZD' |
+  'CAD' |
+  'CDF' |
+  'CHE' |
+  'CHF' |
+  'CHW' |
+  'CLF' |
+  'CLP' |
+  'CNY' |
+  'COP' |
+  'COU' |
+  'CRC' |
+  'CUP' |
+  'CVE' |
+  'CZK' |
+  'DJF' |
+  'DKK' |
+  'DOP' |
+  'DZD' |
+  'EGP' |
+  'ERN' |
+  'ETB' |
+  'EUR' |
+  'FJD' |
+  'FKP' |
+  'GBP' |
+  'GEL' |
+  'GHS' |
+  'GIP' |
+  'GMD' |
+  'GNF' |
+  'GTQ' |
+  'GYD' |
+  'HKD' |
+  'HNL' |
+  'HTG' |
+  'HUF' |
+  'IDR' |
+  'ILS' |
+  'INR' |
+  'IQD' |
+  'IRR' |
+  'ISK' |
+  'JMD' |
+  'JOD' |
+  'JPY' |
+  'KES' |
+  'KGS' |
+  'KHR' |
+  'KMF' |
+  'KPW' |
+  'KRW' |
+  'KWD' |
+  'KYD' |
+  'KZT' |
+  'LAK' |
+  'LBP' |
+  'LKR' |
+  'LRD' |
+  'LSL' |
+  'LYD' |
+  'MAD' |
+  'MDL' |
+  'MGA' |
+  'MKD' |
+  'MMK' |
+  'MNT' |
+  'MOP' |
+  'MRU' |
+  'MUR' |
+  'MVR' |
+  'MWK' |
+  'MXN' |
+  'MXV' |
+  'MYR' |
+  'MZN' |
+  'NAD' |
+  'NGN' |
+  'NIO' |
+  'NOK' |
+  'NPR' |
+  'NZD' |
+  'OMR' |
+  'PAB' |
+  'PEN' |
+  'PGK' |
+  'PHP' |
+  'PKR' |
+  'PLN' |
+  'PYG' |
+  'QAR' |
+  'RON' |
+  'RSD' |
+  'RUB' |
+  'RWF' |
+  'SAR' |
+  'SBD' |
+  'SCR' |
+  'SDG' |
+  'SEK' |
+  'SGD' |
+  'SHP' |
+  'SLE' |
+  'SOS' |
+  'SRD' |
+  'SSP' |
+  'STN' |
+  'SVC' |
+  'SYP' |
+  'SZL' |
+  'THB' |
+  'TJS' |
+  'TMT' |
+  'TND' |
+  'TOP' |
+  'TRY' |
+  'TTD' |
+  'TWD' |
+  'TZS' |
+  'UAH' |
+  'UGX' |
+  'USD' |
+  'USN' |
+  'UYI' |
+  'UYU' |
+  'UYW' |
+  'UZS' |
+  'VED' |
+  'VES' |
+  'VND' |
+  'VUV' |
+  'WST' |
+  'XAF' |
+  'XAG' |
+  'XAU' |
+  'XBA' |
+  'XBB' |
+  'XBC' |
+  'XBD' |
+  'XCD' |
+  'XDR' |
+  'XOF' |
+  'XPD' |
+  'XPF' |
+  'XPT' |
+  'XSU' |
+  'XTS' |
+  'XUA' |
+  'XXX' |
+  'YER' |
+  'ZAR' |
+  'ZMW' |
+  'ZWG' |
+  'ZWL'
+
+// TODO: Technically, the values should be 3 digit numbers with leading
+// zeros, so we can padStart if we need to be strict
+/**
+ * ISO 4217 numeric currency number codes
+ */
+export type Iso4217NumericCode =
+  784 |
+  971 |
+  8 |
+  51 |
+  532 |
+  973 |
+  32 |
+  36 |
+  533 |
+  944 |
+  977 |
+  52 |
+  50 |
+  975 |
+  48 |
+  108 |
+  60 |
+  96 |
+  68 |
+  984 |
+  986 |
+  44 |
+  64 |
+  72 |
+  933 |
+  84 |
+  124 |
+  976 |
+  947 |
+  756 |
+  948 |
+  990 |
+  152 |
+  156 |
+  170 |
+  970 |
+  188 |
+  192 |
+  132 |
+  203 |
+  262 |
+  208 |
+  214 |
+  12 |
+  818 |
+  232 |
+  230 |
+  978 |
+  242 |
+  238 |
+  826 |
+  981 |
+  936 |
+  292 |
+  270 |
+  324 |
+  320 |
+  328 |
+  344 |
+  340 |
+  332 |
+  348 |
+  360 |
+  376 |
+  356 |
+  368 |
+  364 |
+  352 |
+  388 |
+  400 |
+  392 |
+  404 |
+  417 |
+  116 |
+  174 |
+  408 |
+  410 |
+  414 |
+  136 |
+  398 |
+  418 |
+  422 |
+  144 |
+  430 |
+  426 |
+  434 |
+  504 |
+  498 |
+  969 |
+  807 |
+  104 |
+  496 |
+  446 |
+  929 |
+  480 |
+  462 |
+  454 |
+  484 |
+  979 |
+  458 |
+  943 |
+  516 |
+  566 |
+  558 |
+  578 |
+  524 |
+  554 |
+  512 |
+  590 |
+  604 |
+  598 |
+  608 |
+  586 |
+  985 |
+  600 |
+  634 |
+  946 |
+  941 |
+  643 |
+  646 |
+  682 |
+  90 |
+  690 |
+  938 |
+  752 |
+  702 |
+  654 |
+  925 |
+  706 |
+  968 |
+  728 |
+  930 |
+  222 |
+  760 |
+  748 |
+  764 |
+  972 |
+  934 |
+  788 |
+  776 |
+  949 |
+  780 |
+  901 |
+  834 |
+  980 |
+  800 |
+  840 |
+  997 |
+  940 |
+  858 |
+  927 |
+  860 |
+  926 |
+  928 |
+  704 |
+  548 |
+  882 |
+  950 |
+  961 |
+  959 |
+  955 |
+  956 |
+  957 |
+  958 |
+  951 |
+  960 |
+  952 |
+  964 |
+  953 |
+  962 |
+  994 |
+  963 |
+  965 |
+  999 |
+  886 |
+  710 |
+  967 |
+  924 |
+  932
+
+/**
+ * Dictionary of ISO 4217 alphabetical currency codes to numeric currency number codes
+ */
+export const Iso4217CurrencyCodes: Record<Iso4217AlphabeticalCode, Iso4217NumericCode> = {
+  AED: 784,
+  AFN: 971,
+  ALL: 8,
+  AMD: 51,
+  ANG: 532,
+  AOA: 973,
+  ARS: 32,
+  AUD: 36,
+  AWG: 533,
+  AZN: 944,
+  BAM: 977,
+  BBD: 52,
+  BDT: 50,
+  BGN: 975,
+  BHD: 48,
+  BIF: 108,
+  BMD: 60,
+  BND: 96,
+  BOB: 68,
+  BOV: 984,
+  BRL: 986,
+  BSD: 44,
+  BTN: 64,
+  BWP: 72,
+  BYN: 933,
+  BZD: 84,
+  CAD: 124,
+  CDF: 976,
+  CHE: 947,
+  CHF: 756,
+  CHW: 948,
+  CLF: 990,
+  CLP: 152,
+  CNY: 156,
+  COP: 170,
+  COU: 970,
+  CRC: 188,
+  CUP: 192,
+  CVE: 132,
+  CZK: 203,
+  DJF: 262,
+  DKK: 208,
+  DOP: 214,
+  DZD: 12,
+  EGP: 818,
+  ERN: 232,
+  ETB: 230,
+  EUR: 978,
+  FJD: 242,
+  FKP: 238,
+  GBP: 826,
+  GEL: 981,
+  GHS: 936,
+  GIP: 292,
+  GMD: 270,
+  GNF: 324,
+  GTQ: 320,
+  GYD: 328,
+  HKD: 344,
+  HNL: 340,
+  HTG: 332,
+  HUF: 348,
+  IDR: 360,
+  ILS: 376,
+  INR: 356,
+  IQD: 368,
+  IRR: 364,
+  ISK: 352,
+  JMD: 388,
+  JOD: 400,
+  JPY: 392,
+  KES: 404,
+  KGS: 417,
+  KHR: 116,
+  KMF: 174,
+  KPW: 408,
+  KRW: 410,
+  KWD: 414,
+  KYD: 136,
+  KZT: 398,
+  LAK: 418,
+  LBP: 422,
+  LKR: 144,
+  LRD: 430,
+  LSL: 426,
+  LYD: 434,
+  MAD: 504,
+  MDL: 498,
+  MGA: 969,
+  MKD: 807,
+  MMK: 104,
+  MNT: 496,
+  MOP: 446,
+  MRU: 929,
+  MUR: 480,
+  MVR: 462,
+  MWK: 454,
+  MXN: 484,
+  MXV: 979,
+  MYR: 458,
+  MZN: 943,
+  NAD: 516,
+  NGN: 566,
+  NIO: 558,
+  NOK: 578,
+  NPR: 524,
+  NZD: 554,
+  OMR: 512,
+  PAB: 590,
+  PEN: 604,
+  PGK: 598,
+  PHP: 608,
+  PKR: 586,
+  PLN: 985,
+  PYG: 600,
+  QAR: 634,
+  RON: 946,
+  RSD: 941,
+  RUB: 643,
+  RWF: 646,
+  SAR: 682,
+  SBD: 90,
+  SCR: 690,
+  SDG: 938,
+  SEK: 752,
+  SGD: 702,
+  SHP: 654,
+  SLE: 925,
+  SOS: 706,
+  SRD: 968,
+  SSP: 728,
+  STN: 930,
+  SVC: 222,
+  SYP: 760,
+  SZL: 748,
+  THB: 764,
+  TJS: 972,
+  TMT: 934,
+  TND: 788,
+  TOP: 776,
+  TRY: 949,
+  TTD: 780,
+  TWD: 901,
+  TZS: 834,
+  UAH: 980,
+  UGX: 800,
+  USD: 840,
+  USN: 997,
+  UYI: 940,
+  UYU: 858,
+  UYW: 927,
+  UZS: 860,
+  VED: 926,
+  VES: 928,
+  VND: 704,
+  VUV: 548,
+  WST: 882,
+  XAF: 950,
+  XAG: 961,
+  XAU: 959,
+  XBA: 955,
+  XBB: 956,
+  XBC: 957,
+  XBD: 958,
+  XCD: 951,
+  XDR: 960,
+  XOF: 952,
+  XPD: 964,
+  XPF: 953,
+  XPT: 962,
+  XSU: 994,
+  XTS: 963,
+  XUA: 965,
+  XXX: 999,
+  YER: 886,
+  ZAR: 710,
+  ZMW: 967,
+  ZWG: 924,
+  ZWL: 932,
+}
+
+export const isIso4217CurrencyCode = (code: string): code is Iso4217AlphabeticalCode => Iso4217CurrencyCodes[code as Iso4217AlphabeticalCode] ? true : false

package/src/Amount/Payload.ts

@@ -0,0 +1,36 @@
+import type { PayloadWithSources } from '@xyo-network/payload-model'
+import {
+  isPayloadOfSchemaType,
+  isPayloadOfSchemaTypeWithMeta,
+  isPayloadOfSchemaTypeWithSources,
+} from '@xyo-network/payload-model'
+
+import type { Iso4217AlphabeticalCode } from './Iso4217Currency.ts'
+
+export const AmountSchema = 'network.xyo.payments.amount' as const
+export type AmountSchema = typeof AmountSchema
+
+export interface AmountFields {
+  amount: number
+  currency: Iso4217AlphabeticalCode
+}
+
+/**
+ * The result of a amount
+ */
+export type Amount = PayloadWithSources<AmountFields, AmountSchema>
+
+/**
+ * Identity function for determining if an object is an Amount
+ */
+export const isAmount = isPayloadOfSchemaType<Amount>(AmountSchema)
+
+/**
+ * Identity function for determining if an object is an Amount with sources
+ */
+export const isAmountWithSources = isPayloadOfSchemaTypeWithSources<Amount>(AmountSchema)
+
+/**
+ * Identity function for determining if an object is an Amount with meta
+ */
+export const isAmountWithMeta = isPayloadOfSchemaTypeWithMeta<Amount>(AmountSchema)

package/src/Amount/index.ts

@@ -0,0 +1,2 @@
+export * from './Iso4217Currency.ts'
+export * from './Payload.ts'

package/src/Discount/Config.ts

@@ -0,0 +1,34 @@
+// import type { Hash } from '@xylabs/hex'
+import type { Address } from '@xylabs/hex'
+import type { DivinerConfig } from '@xyo-network/diviner-model'
+import type { ModuleIdentifier } from '@xyo-network/module-model'
+
+export const PaymentDiscountDivinerConfigSchema = 'network.xyo.diviner.payments.discount.config'
+export type PaymentDiscountDivinerConfigSchema = typeof PaymentDiscountDivinerConfigSchema
+
+/**
+ * The configuration for the Payment Discount Diviner
+ */
+export type PaymentDiscountDivinerConfig = DivinerConfig<
+  {
+    /**
+     * The boundwitness diviner used to query for payloads
+     */
+    boundWitnessDiviner?: ModuleIdentifier
+    /**
+     * The list of coupon authorities that can be used to get a discount
+     */
+    couponAuthorities?: Address[]
+
+    // /**
+    //  * The list of coupons that are supported by this diviner
+    //  */
+    // supportedCoupons?: Hash[]
+
+    /**
+     * The Diviner that can be used to determine the subtotal to apply discounts to
+     */
+    paymentSubtotalDiviner?: ModuleIdentifier
+  },
+  PaymentDiscountDivinerConfigSchema
+>

package/src/Discount/Params.ts

@@ -0,0 +1,14 @@
+import type { Address } from '@xylabs/hex'
+import type { DivinerParams } from '@xyo-network/diviner-model'
+import type { AnyConfigSchema } from '@xyo-network/module-model'
+
+import type { PaymentDiscountDivinerConfig } from './Config.ts'
+
+export type PaymentDiscountDivinerParams<
+  TConfig extends AnyConfigSchema<PaymentDiscountDivinerConfig> = AnyConfigSchema<PaymentDiscountDivinerConfig>,
+> = DivinerParams<TConfig, {
+  /**
+     * The list of coupon authorities that can be used to get a discount
+     */
+  couponAuthorities?: Address[]
+}>

package/src/Discount/Payload/Coupon/Coupons/FixedAmount.ts

@@ -0,0 +1,35 @@
+import type { PayloadWithSources } from '@xyo-network/payload-model'
+import {
+  isPayloadOfSchemaType,
+  isPayloadOfSchemaTypeWithMeta,
+  isPayloadOfSchemaTypeWithSources,
+} from '@xyo-network/payload-model'
+
+import type { AmountFields } from '../../../../Amount/index.ts'
+import { CouponSchema } from '../Schema.ts'
+import type { CouponFields } from '../types/index.ts'
+
+export const FixedAmountCouponSchema = `${CouponSchema}.fixed.amount` as const
+export type FixedAmountCouponSchema = typeof FixedAmountCouponSchema
+
+export interface FixedAmountCouponFields extends CouponFields, AmountFields {}
+
+/**
+ * A coupon that provides a fixed discount amount
+ */
+export type FixedAmountCoupon = PayloadWithSources<FixedAmountCouponFields, FixedAmountCouponSchema>
+
+/**
+ * Identity function for determining if an object is an FixedAmountCoupon
+ */
+export const isFixedAmountCoupon = isPayloadOfSchemaType<FixedAmountCoupon>(FixedAmountCouponSchema)
+
+/**
+ * Identity function for determining if an object is an FixedAmountCoupon with sources
+ */
+export const isFixedAmountCouponWithSources = isPayloadOfSchemaTypeWithSources<FixedAmountCoupon>(FixedAmountCouponSchema)
+
+/**
+ * Identity function for determining if an object is an FixedAmountCoupon with meta
+ */
+export const isFixedAmountCouponWithMeta = isPayloadOfSchemaTypeWithMeta<FixedAmountCoupon>(FixedAmountCouponSchema)

package/src/Discount/Payload/Coupon/Coupons/FixedPercentage.ts

@@ -0,0 +1,36 @@
+import type { PayloadWithSources } from '@xyo-network/payload-model'
+import {
+  isPayloadOfSchemaType,
+  isPayloadOfSchemaTypeWithMeta,
+  isPayloadOfSchemaTypeWithSources,
+} from '@xyo-network/payload-model'
+
+import { CouponSchema } from '../Schema.ts'
+import type { CouponFields } from '../types/index.ts'
+
+export const FixedPercentageCouponSchema = `${CouponSchema}.fixed.percentage` as const
+export type FixedPercentageCouponSchema = typeof FixedPercentageCouponSchema
+
+export interface FixedPercentageCouponFields extends CouponFields {
+  percentage: number
+}
+
+/**
+ * A coupon that provides a fixed discount amount
+ */
+export type FixedPercentageCoupon = PayloadWithSources<FixedPercentageCouponFields, FixedPercentageCouponSchema>
+
+/**
+ * Identity function for determining if an object is an FixedPercentageCoupon
+ */
+export const isFixedPercentageCoupon = isPayloadOfSchemaType<FixedPercentageCoupon>(FixedPercentageCouponSchema)
+
+/**
+ * Identity function for determining if an object is an FixedPercentageCoupon with sources
+ */
+export const isFixedPercentageCouponWithSources = isPayloadOfSchemaTypeWithSources<FixedPercentageCoupon>(FixedPercentageCouponSchema)
+
+/**
+ * Identity function for determining if an object is an FixedPercentageCoupon with meta
+ */
+export const isFixedPercentageCouponWithMeta = isPayloadOfSchemaTypeWithMeta<FixedPercentageCoupon>(FixedPercentageCouponSchema)