@xyo-network/payment-payload-plugins 3.1.0 → 3.1.2

package/dist/neutral/Amount/Iso4217Currency.d.ts

@@ -1,5 +1,14 @@
+/**
+ * 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';
+/**
+ * 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 declare const Iso4217CurrencyCodes: Record<Iso4217AlphabeticalCode, Iso4217NumericCode>;
 export declare const isIso4217CurrencyCode: (code: string) => code is Iso4217AlphabeticalCode;
 //# sourceMappingURL=Iso4217Currency.d.ts.map

package/dist/neutral/Amount/Iso4217Currency.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Iso4217Currency.d.ts","sourceRoot":"","sources":["../../../src/Amount/Iso4217Currency.ts"],"names":[],"mappings":"AAIA,MAAM,MAAM,uBAAuB,GACjC,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,CAAA;AAOP,MAAM,MAAM,kBAAkB,GAC5B,GAAG,GACH,GAAG,GACH,CAAC,GACD,EAAE,GACF,GAAG,GACH,GAAG,GACH,EAAE,GACF,EAAE,GACF,GAAG,GACH,GAAG,GACH,GAAG,GACH,EAAE,GACF,EAAE,GACF,GAAG,GACH,EAAE,GACF,GAAG,GACH,EAAE,GACF,EAAE,GACF,EAAE,GACF,GAAG,GACH,GAAG,GACH,EAAE,GACF,EAAE,GACF,EAAE,GACF,GAAG,GACH,EAAE,GACF,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,EAAE,GACF,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,EAAE,GACF,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,CAAA;AAKL,eAAO,MAAM,oBAAoB,EAAE,MAAM,CAAC,uBAAuB,EAAE,kBAAkB,CAoLpF,CAAA;AAED,eAAO,MAAM,qBAAqB,SAAU,MAAM,KAAG,IAAI,IAAI,uBAA+F,CAAA"}
+{"version":3,"file":"Iso4217Currency.d.ts","sourceRoot":"","sources":["../../../src/Amount/Iso4217Currency.ts"],"names":[],"mappings":"AACA;;GAEG;AACH,MAAM,MAAM,uBAAuB,GACjC,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,CAAA;AAIP;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAC5B,GAAG,GACH,GAAG,GACH,CAAC,GACD,EAAE,GACF,GAAG,GACH,GAAG,GACH,EAAE,GACF,EAAE,GACF,GAAG,GACH,GAAG,GACH,GAAG,GACH,EAAE,GACF,EAAE,GACF,GAAG,GACH,EAAE,GACF,GAAG,GACH,EAAE,GACF,EAAE,GACF,EAAE,GACF,GAAG,GACH,GAAG,GACH,EAAE,GACF,EAAE,GACF,EAAE,GACF,GAAG,GACH,EAAE,GACF,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,EAAE,GACF,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,EAAE,GACF,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,CAAA;AAEL;;GAEG;AACH,eAAO,MAAM,oBAAoB,EAAE,MAAM,CAAC,uBAAuB,EAAE,kBAAkB,CAoLpF,CAAA;AAED,eAAO,MAAM,qBAAqB,SAAU,MAAM,KAAG,IAAI,IAAI,uBAA+F,CAAA"}

package/dist/neutral/Amount/Payload.d.ts

@@ -6,8 +6,20 @@ 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 declare const isAmount: (x?: unknown | null) => x is Amount;
+/**
+ * Identity function for determining if an object is an Amount with sources
+ */
 export declare const isAmountWithSources: (x?: unknown | null) => x is import("@xyo-network/payload-model").WithSources<Amount>;
+/**
+ * Identity function for determining if an object is an Amount with meta
+ */
 export declare const isAmountWithMeta: (x?: unknown | null) => x is import("@xyo-network/payload-model").WithMeta<Amount>;
 //# sourceMappingURL=Payload.d.ts.map

package/dist/neutral/Amount/Payload.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Payload.d.ts","sourceRoot":"","sources":["../../../src/Amount/Payload.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAA;AAOpE,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,sBAAsB,CAAA;AAEnE,eAAO,MAAM,YAAY,+BAAyC,CAAA;AAClE,MAAM,MAAM,YAAY,GAAG,OAAO,YAAY,CAAA;AAE9C,MAAM,WAAW,YAAY;IAC3B,MAAM,EAAE,MAAM,CAAA;IACd,QAAQ,EAAE,uBAAuB,CAAA;CAClC;AAKD,MAAM,MAAM,MAAM,GAAG,kBAAkB,CAAC,YAAY,EAAE,YAAY,CAAC,CAAA;AAKnE,eAAO,MAAM,QAAQ,qCAA8C,CAAA;AAKnE,eAAO,MAAM,mBAAmB,uFAAyD,CAAA;AAKzF,eAAO,MAAM,gBAAgB,oFAAsD,CAAA"}
+{"version":3,"file":"Payload.d.ts","sourceRoot":"","sources":["../../../src/Amount/Payload.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAA;AAOpE,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,sBAAsB,CAAA;AAEnE,eAAO,MAAM,YAAY,EAAG,6BAAsC,CAAA;AAClE,MAAM,MAAM,YAAY,GAAG,OAAO,YAAY,CAAA;AAE9C,MAAM,WAAW,YAAY;IAC3B,MAAM,EAAE,MAAM,CAAA;IACd,QAAQ,EAAE,uBAAuB,CAAA;CAClC;AAED;;GAEG;AACH,MAAM,MAAM,MAAM,GAAG,kBAAkB,CAAC,YAAY,EAAE,YAAY,CAAC,CAAA;AAEnE;;GAEG;AACH,eAAO,MAAM,QAAQ,qCAA8C,CAAA;AAEnE;;GAEG;AACH,eAAO,MAAM,mBAAmB,uFAAyD,CAAA;AAEzF;;GAEG;AACH,eAAO,MAAM,gBAAgB,oFAAsD,CAAA"}

package/dist/neutral/Billing/Address/Address.d.ts

@@ -1,23 +1,47 @@
 import type { Payload } from '@xyo-network/payload-model';
 import { BillingAddressSchema } from './Schema.ts';
+/**
+ * The fields describing a billing address.
+ */
 export interface BillingAddressFields {
+    /** Street address line 1. */
     address?: string;
+    /** Street address line 2. */
     address2?: string | null;
+    /** City of the billing address. */
     city?: string;
+    /** Country code of the billing address, ISO 3166-1 alpha-2 code. */
     country?: string;
+    /** First name */
     firstName: string;
+    /** Last name */
     lastName: string;
+    /** Organization or company name associated with the billing address. */
     organization?: string | null;
+    /** Postal or ZIP code of the billing address. */
     postalCode?: string;
+    /** State or region of the billing address. */
     region?: string;
 }
+/**
+ * A BillingAddress Payload
+ */
 export type BillingAddress = Payload<BillingAddressFields, BillingAddressSchema>;
+/**
+ * Identity function for determine if an object is a BillingAddress
+ */
 export declare const isBillingAddress: (x?: unknown | null) => x is import("@xyo-network/payload-model").SchemaFields & import("@xyo-network/payload-model").PayloadFields & BillingAddressFields & {
     schema: "network.xyo.payments.billing.address";
 };
+/**
+ * Identity function for determine if an object is a BillingAddress with sources
+ */
 export declare const isBillingAddressWithSources: (x?: unknown | null) => x is import("@xyo-network/payload-model").WithSources<import("@xyo-network/payload-model").SchemaFields & import("@xyo-network/payload-model").PayloadFields & BillingAddressFields & {
     schema: "network.xyo.payments.billing.address";
 }>;
+/**
+ * Identity function for determine if an object is a BillingAddress with meta
+ */
 export declare const isBillingAddressWithMeta: (x?: unknown | null) => x is import("@xyo-network/payload-model").WithMeta<import("@xyo-network/payload-model").SchemaFields & import("@xyo-network/payload-model").PayloadFields & BillingAddressFields & {
     schema: "network.xyo.payments.billing.address";
 }>;

package/dist/neutral/Billing/Address/Address.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Address.d.ts","sourceRoot":"","sources":["../../../../src/Billing/Address/Address.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAA;AAKzD,OAAO,EAAE,oBAAoB,EAAE,MAAM,aAAa,CAAA;AAKlD,MAAM,WAAW,oBAAoB;IAEnC,OAAO,CAAC,EAAE,MAAM,CAAA;IAEhB,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAExB,IAAI,CAAC,EAAE,MAAM,CAAA;IAEb,OAAO,CAAC,EAAE,MAAM,CAAA;IAEhB,SAAS,EAAE,MAAM,CAAA;IAEjB,QAAQ,EAAE,MAAM,CAAA;IAEhB,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAE5B,UAAU,CAAC,EAAE,MAAM,CAAA;IAEnB,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB;AAKD,MAAM,MAAM,cAAc,GAAG,OAAO,CAAC,oBAAoB,EAAE,oBAAoB,CAAC,CAAA;AAKhF,eAAO,MAAM,gBAAgB;;CAA8D,CAAA;AAK3F,eAAO,MAAM,2BAA2B;;EAAyE,CAAA;AAKjH,eAAO,MAAM,wBAAwB;;EAAsE,CAAA"}
+{"version":3,"file":"Address.d.ts","sourceRoot":"","sources":["../../../../src/Billing/Address/Address.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAA;AAKzD,OAAO,EAAE,oBAAoB,EAAE,MAAM,aAAa,CAAA;AAElD;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,6BAA6B;IAC7B,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,6BAA6B;IAC7B,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACxB,mCAAmC;IACnC,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,oEAAoE;IACpE,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,iBAAiB;IACjB,SAAS,EAAE,MAAM,CAAA;IACjB,gBAAgB;IAChB,QAAQ,EAAE,MAAM,CAAA;IAChB,wEAAwE;IACxE,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC5B,iDAAiD;IACjD,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,8CAA8C;IAC9C,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB;AAED;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG,OAAO,CAAC,oBAAoB,EAAE,oBAAoB,CAAC,CAAA;AAEhF;;GAEG;AACH,eAAO,MAAM,gBAAgB;;CAA8D,CAAA;AAE3F;;GAEG;AACH,eAAO,MAAM,2BAA2B;;EAAyE,CAAA;AAEjH;;GAEG;AACH,eAAO,MAAM,wBAAwB;;EAAsE,CAAA"}

package/dist/neutral/Discount/Config.d.ts

@@ -3,9 +3,21 @@ import type { DivinerConfig } from '@xyo-network/diviner-model';
 import type { ModuleIdentifier } from '@xyo-network/module-model';
 export declare 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 Diviner that can be used to determine the subtotal to apply discounts to
+     */
     paymentSubtotalDiviner?: ModuleIdentifier;
 }, PaymentDiscountDivinerConfigSchema>;
 //# sourceMappingURL=Config.d.ts.map

package/dist/neutral/Discount/Config.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Config.d.ts","sourceRoot":"","sources":["../../../src/Discount/Config.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,aAAa,CAAA;AAC1C,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAA;AAC/D,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAA;AAEjE,eAAO,MAAM,kCAAkC,iDAAiD,CAAA;AAChG,MAAM,MAAM,kCAAkC,GAAG,OAAO,kCAAkC,CAAA;AAK1F,MAAM,MAAM,4BAA4B,GAAG,aAAa,CACtD;IAIE,mBAAmB,CAAC,EAAE,gBAAgB,CAAA;IAItC,iBAAiB,CAAC,EAAE,OAAO,EAAE,CAAA;IAU7B,sBAAsB,CAAC,EAAE,gBAAgB,CAAA;CAC1C,EACD,kCAAkC,CACnC,CAAA"}
+{"version":3,"file":"Config.d.ts","sourceRoot":"","sources":["../../../src/Discount/Config.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,aAAa,CAAA;AAC1C,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAA;AAC/D,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAA;AAEjE,eAAO,MAAM,kCAAkC,iDAAiD,CAAA;AAChG,MAAM,MAAM,kCAAkC,GAAG,OAAO,kCAAkC,CAAA;AAE1F;;GAEG;AACH,MAAM,MAAM,4BAA4B,GAAG,aAAa,CACtD;IACE;;OAEG;IACH,mBAAmB,CAAC,EAAE,gBAAgB,CAAA;IACtC;;OAEG;IACH,iBAAiB,CAAC,EAAE,OAAO,EAAE,CAAA;IAO7B;;OAEG;IACH,sBAAsB,CAAC,EAAE,gBAAgB,CAAA;CAC1C,EACD,kCAAkC,CACnC,CAAA"}

package/dist/neutral/Discount/Params.d.ts

@@ -3,6 +3,9 @@ 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[];
 }>;
 //# sourceMappingURL=Params.d.ts.map

package/dist/neutral/Discount/Params.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Params.d.ts","sourceRoot":"","sources":["../../../src/Discount/Params.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,aAAa,CAAA;AAC1C,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAA;AAC/D,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAA;AAEhE,OAAO,KAAK,EAAE,4BAA4B,EAAE,MAAM,aAAa,CAAA;AAE/D,MAAM,MAAM,4BAA4B,CACtC,OAAO,SAAS,eAAe,CAAC,4BAA4B,CAAC,GAAG,eAAe,CAAC,4BAA4B,CAAC,IAC3G,aAAa,CAAC,OAAO,EAAE;IAIzB,iBAAiB,CAAC,EAAE,OAAO,EAAE,CAAA;CAC9B,CAAC,CAAA"}
+{"version":3,"file":"Params.d.ts","sourceRoot":"","sources":["../../../src/Discount/Params.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,aAAa,CAAA;AAC1C,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAA;AAC/D,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAA;AAEhE,OAAO,KAAK,EAAE,4BAA4B,EAAE,MAAM,aAAa,CAAA;AAE/D,MAAM,MAAM,4BAA4B,CACtC,OAAO,SAAS,eAAe,CAAC,4BAA4B,CAAC,GAAG,eAAe,CAAC,4BAA4B,CAAC,IAC3G,aAAa,CAAC,OAAO,EAAE;IACzB;;SAEK;IACL,iBAAiB,CAAC,EAAE,OAAO,EAAE,CAAA;CAC9B,CAAC,CAAA"}

package/dist/neutral/Discount/Payload/Coupon/Conditions/AppraisalAmountCondition.d.ts

@@ -1,3 +1,8 @@
 import type { Condition } from '../types/index.ts';
+/**
+ * Creates a coupon condition that requires an appraisal amount below a certain value
+ * @param maximumAppraisalAmount The maximum appraisal amount
+ * @returns A condition that requires an appraisal amount below a certain value
+ */
 export declare const createConditionForMaximumAppraisalAmount: (maximumAppraisalAmount: number) => Condition;
 //# sourceMappingURL=AppraisalAmountCondition.d.ts.map

package/dist/neutral/Discount/Payload/Coupon/Conditions/AppraisalAmountCondition.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"AppraisalAmountCondition.d.ts","sourceRoot":"","sources":["../../../../../../src/Discount/Payload/Coupon/Conditions/AppraisalAmountCondition.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAA;AAOlD,eAAO,MAAM,wCAAwC,2BAA4B,MAAM,KAAG,SAgCzF,CAAA"}
+{"version":3,"file":"AppraisalAmountCondition.d.ts","sourceRoot":"","sources":["../../../../../../src/Discount/Payload/Coupon/Conditions/AppraisalAmountCondition.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAA;AAElD;;;;GAIG;AACH,eAAO,MAAM,wCAAwC,2BAA4B,MAAM,KAAG,SAgCzF,CAAA"}

package/dist/neutral/Discount/Payload/Coupon/Conditions/AssetQuantityCondition.d.ts

@@ -1,3 +1,8 @@
 import type { Condition } from '../types/index.ts';
+/**
+ * Returns a coupon condition that requires a minimum quantity of assets
+ * @param minimumAssetQuantity The minimum quantity of assets required
+ * @returns A condition that requires a minimum quantity of assets
+ */
 export declare const createConditionForMinimumAssetQuantity: (minimumAssetQuantity: number) => Condition;
 //# sourceMappingURL=AssetQuantityCondition.d.ts.map

package/dist/neutral/Discount/Payload/Coupon/Conditions/AssetQuantityCondition.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"AssetQuantityCondition.d.ts","sourceRoot":"","sources":["../../../../../../src/Discount/Payload/Coupon/Conditions/AssetQuantityCondition.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAA;AAOlD,eAAO,MAAM,sCAAsC,yBAA0B,MAAM,KAAG,SAerF,CAAA"}
+{"version":3,"file":"AssetQuantityCondition.d.ts","sourceRoot":"","sources":["../../../../../../src/Discount/Payload/Coupon/Conditions/AssetQuantityCondition.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAA;AAElD;;;;GAIG;AACH,eAAO,MAAM,sCAAsC,yBAA0B,MAAM,KAAG,SAerF,CAAA"}

package/dist/neutral/Discount/Payload/Coupon/Conditions/BuyerCondition.d.ts

@@ -25,5 +25,10 @@ export type BuyerCondition = Condition & {
     };
     schema: SchemaSchema;
 };
+/**
+ * Creates a coupon condition that requires a specific buyer
+ * @param buyer The buyer's address
+ * @returns A coupon condition that requires a specific buyer
+ */
 export declare const createConditionForRequiredBuyer: (buyer: Address) => BuyerCondition;
 //# sourceMappingURL=BuyerCondition.d.ts.map

package/dist/neutral/Discount/Payload/Coupon/Conditions/BuyerCondition.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"BuyerCondition.d.ts","sourceRoot":"","sources":["../../../../../../src/Discount/Payload/Coupon/Conditions/BuyerCondition.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,aAAa,CAAA;AAC1C,OAAO,EAAE,YAAY,EAAE,MAAM,oCAAoC,CAAA;AAEjE,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAA;AAElD,MAAM,MAAM,cAAc,GAAG,SAAS,GAAG;IACvC,UAAU,EAAE;QACV,QAAQ,EAAE;YACR,UAAU,EAAE;gBACV,KAAK,EAAE;oBACL,KAAK,EAAE;wBACL,KAAK,EAAE,OAAO,CAAA;wBACd,IAAI,EAAE,QAAQ,CAAA;qBACf,CAAA;oBACD,QAAQ,EAAE,CAAC,CAAA;oBACX,IAAI,EAAE,OAAO,CAAA;iBACd,CAAA;gBACD,MAAM,EAAE;oBAAE,KAAK,EAAE,0BAA0B,CAAC;oBAAC,IAAI,EAAE,QAAQ,CAAA;iBAAE,CAAA;aAC9D,CAAA;YACD,QAAQ,EAAE,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAA;YAC7B,IAAI,EAAE,QAAQ,CAAA;SACf,CAAA;QACD,IAAI,EAAE,OAAO,CAAA;KACd,CAAA;IACD,MAAM,EAAE,YAAY,CAAA;CACrB,CAAA;AAOD,eAAO,MAAM,+BAA+B,UAAW,OAAO,KAAG,cAiBhE,CAAA"}
+{"version":3,"file":"BuyerCondition.d.ts","sourceRoot":"","sources":["../../../../../../src/Discount/Payload/Coupon/Conditions/BuyerCondition.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,aAAa,CAAA;AAC1C,OAAO,EAAE,YAAY,EAAE,MAAM,oCAAoC,CAAA;AAEjE,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAA;AAElD,MAAM,MAAM,cAAc,GAAG,SAAS,GAAG;IACvC,UAAU,EAAE;QACV,QAAQ,EAAE;YACR,UAAU,EAAE;gBACV,KAAK,EAAE;oBACL,KAAK,EAAE;wBACL,KAAK,EAAE,OAAO,CAAA;wBACd,IAAI,EAAE,QAAQ,CAAA;qBACf,CAAA;oBACD,QAAQ,EAAE,CAAC,CAAA;oBACX,IAAI,EAAE,OAAO,CAAA;iBACd,CAAA;gBACD,MAAM,EAAE;oBAAE,KAAK,EAAE,0BAA0B,CAAC;oBAAC,IAAI,EAAE,QAAQ,CAAA;iBAAE,CAAA;aAC9D,CAAA;YACD,QAAQ,EAAE,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAA;YAC7B,IAAI,EAAE,QAAQ,CAAA;SACf,CAAA;QACD,IAAI,EAAE,OAAO,CAAA;KACd,CAAA;IACD,MAAM,EAAE,YAAY,CAAA;CACrB,CAAA;AAED;;;;GAIG;AACH,eAAO,MAAM,+BAA+B,UAAW,OAAO,KAAG,cAiBhE,CAAA"}

package/dist/neutral/Discount/Payload/Coupon/Coupons/FixedAmount.d.ts

@@ -5,8 +5,20 @@ export declare const FixedAmountCouponSchema: "network.xyo.payments.coupon.fixed
 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 declare const isFixedAmountCoupon: (x?: unknown | null) => x is FixedAmountCoupon;
+/**
+ * Identity function for determining if an object is an FixedAmountCoupon with sources
+ */
 export declare const isFixedAmountCouponWithSources: (x?: unknown | null) => x is import("@xyo-network/payload-model").WithSources<FixedAmountCoupon>;
+/**
+ * Identity function for determining if an object is an FixedAmountCoupon with meta
+ */
 export declare const isFixedAmountCouponWithMeta: (x?: unknown | null) => x is import("@xyo-network/payload-model").WithMeta<FixedAmountCoupon>;
 //# sourceMappingURL=FixedAmount.d.ts.map

package/dist/neutral/Discount/Payload/Coupon/Coupons/FixedAmount.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"FixedAmount.d.ts","sourceRoot":"","sources":["../../../../../../src/Discount/Payload/Coupon/Coupons/FixedAmount.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAA;AAOpE,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAA;AAE/D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AAErD,eAAO,MAAM,uBAAuB,4CAA0C,CAAA;AAC9E,MAAM,MAAM,uBAAuB,GAAG,OAAO,uBAAuB,CAAA;AAEpE,MAAM,WAAW,uBAAwB,SAAQ,YAAY,EAAE,YAAY;CAAG;AAK9E,MAAM,MAAM,iBAAiB,GAAG,kBAAkB,CAAC,uBAAuB,EAAE,uBAAuB,CAAC,CAAA;AAKpG,eAAO,MAAM,mBAAmB,gDAAoE,CAAA;AAKpG,eAAO,MAAM,8BAA8B,kGAA+E,CAAA;AAK1H,eAAO,MAAM,2BAA2B,+FAA4E,CAAA"}
+{"version":3,"file":"FixedAmount.d.ts","sourceRoot":"","sources":["../../../../../../src/Discount/Payload/Coupon/Coupons/FixedAmount.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAA;AAOpE,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAA;AAE/D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AAErD,eAAO,MAAM,uBAAuB,4CAA0C,CAAA;AAC9E,MAAM,MAAM,uBAAuB,GAAG,OAAO,uBAAuB,CAAA;AAEpE,MAAM,WAAW,uBAAwB,SAAQ,YAAY,EAAE,YAAY;CAAG;AAE9E;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG,kBAAkB,CAAC,uBAAuB,EAAE,uBAAuB,CAAC,CAAA;AAEpG;;GAEG;AACH,eAAO,MAAM,mBAAmB,gDAAoE,CAAA;AAEpG;;GAEG;AACH,eAAO,MAAM,8BAA8B,kGAA+E,CAAA;AAE1H;;GAEG;AACH,eAAO,MAAM,2BAA2B,+FAA4E,CAAA"}

package/dist/neutral/Discount/Payload/Coupon/Coupons/FixedPercentage.d.ts

@@ -5,8 +5,20 @@ 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 declare const isFixedPercentageCoupon: (x?: unknown | null) => x is FixedPercentageCoupon;
+/**
+ * Identity function for determining if an object is an FixedPercentageCoupon with sources
+ */
 export declare const isFixedPercentageCouponWithSources: (x?: unknown | null) => x is import("@xyo-network/payload-model").WithSources<FixedPercentageCoupon>;
+/**
+ * Identity function for determining if an object is an FixedPercentageCoupon with meta
+ */
 export declare const isFixedPercentageCouponWithMeta: (x?: unknown | null) => x is import("@xyo-network/payload-model").WithMeta<FixedPercentageCoupon>;
 //# sourceMappingURL=FixedPercentage.d.ts.map

package/dist/neutral/Discount/Payload/Coupon/Coupons/FixedPercentage.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"FixedPercentage.d.ts","sourceRoot":"","sources":["../../../../../../src/Discount/Payload/Coupon/Coupons/FixedPercentage.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAA;AAQpE,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AAErD,eAAO,MAAM,2BAA2B,gDAA8C,CAAA;AACtF,MAAM,MAAM,2BAA2B,GAAG,OAAO,2BAA2B,CAAA;AAE5E,MAAM,WAAW,2BAA4B,SAAQ,YAAY;IAC/D,UAAU,EAAE,MAAM,CAAA;CACnB;AAKD,MAAM,MAAM,qBAAqB,GAAG,kBAAkB,CAAC,2BAA2B,EAAE,2BAA2B,CAAC,CAAA;AAKhH,eAAO,MAAM,uBAAuB,oDAA4E,CAAA;AAKhH,eAAO,MAAM,kCAAkC,sGAAuF,CAAA;AAKtI,eAAO,MAAM,+BAA+B,mGAAoF,CAAA"}
+{"version":3,"file":"FixedPercentage.d.ts","sourceRoot":"","sources":["../../../../../../src/Discount/Payload/Coupon/Coupons/FixedPercentage.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAA;AAQpE,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AAErD,eAAO,MAAM,2BAA2B,gDAA8C,CAAA;AACtF,MAAM,MAAM,2BAA2B,GAAG,OAAO,2BAA2B,CAAA;AAE5E,MAAM,WAAW,2BAA4B,SAAQ,YAAY;IAC/D,UAAU,EAAE,MAAM,CAAA;CACnB;AAED;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG,kBAAkB,CAAC,2BAA2B,EAAE,2BAA2B,CAAC,CAAA;AAEhH;;GAEG;AACH,eAAO,MAAM,uBAAuB,oDAA4E,CAAA;AAEhH;;GAEG;AACH,eAAO,MAAM,kCAAkC,sGAAuF,CAAA;AAEtI;;GAEG;AACH,eAAO,MAAM,+BAA+B,mGAAoF,CAAA"}

package/dist/neutral/Discount/Payload/Coupon/Coupons/FixedPrice.d.ts

@@ -5,8 +5,20 @@ export declare const FixedPriceCouponSchema: "network.xyo.payments.coupon.fixed.
 export type FixedPriceCouponSchema = typeof FixedPriceCouponSchema;
 export interface FixedPriceCouponFields extends CouponFields, AmountFields {
 }
+/**
+ * A coupon that provides a fixed total price
+ */
 export type FixedPriceCoupon = PayloadWithSources<FixedPriceCouponFields, FixedPriceCouponSchema>;
+/**
+ * Identity function for determining if an object is an FixedPriceCoupon
+ */
 export declare const isFixedPriceCoupon: (x?: unknown | null) => x is FixedPriceCoupon;
+/**
+ * Identity function for determining if an object is an FixedPriceCoupon with sources
+ */
 export declare const isFixedPriceCouponWithSources: (x?: unknown | null) => x is import("@xyo-network/payload-model").WithSources<FixedPriceCoupon>;
+/**
+ * Identity function for determining if an object is an FixedPriceCoupon with meta
+ */
 export declare const isFixedPriceCouponWithMeta: (x?: unknown | null) => x is import("@xyo-network/payload-model").WithMeta<FixedPriceCoupon>;
 //# sourceMappingURL=FixedPrice.d.ts.map

package/dist/neutral/Discount/Payload/Coupon/Coupons/FixedPrice.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"FixedPrice.d.ts","sourceRoot":"","sources":["../../../../../../src/Discount/Payload/Coupon/Coupons/FixedPrice.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAA;AAOpE,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAA;AAE/D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AAErD,eAAO,MAAM,sBAAsB,2CAAyC,CAAA;AAC5E,MAAM,MAAM,sBAAsB,GAAG,OAAO,sBAAsB,CAAA;AAElE,MAAM,WAAW,sBAAuB,SAAQ,YAAY,EAAE,YAAY;CAAI;AAK9E,MAAM,MAAM,gBAAgB,GAAG,kBAAkB,CAAC,sBAAsB,EAAE,sBAAsB,CAAC,CAAA;AAKjG,eAAO,MAAM,kBAAkB,+CAAkE,CAAA;AAKjG,eAAO,MAAM,6BAA6B,iGAA6E,CAAA;AAKvH,eAAO,MAAM,0BAA0B,8FAA0E,CAAA"}
+{"version":3,"file":"FixedPrice.d.ts","sourceRoot":"","sources":["../../../../../../src/Discount/Payload/Coupon/Coupons/FixedPrice.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAA;AAOpE,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAA;AAE/D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AAErD,eAAO,MAAM,sBAAsB,2CAAyC,CAAA;AAC5E,MAAM,MAAM,sBAAsB,GAAG,OAAO,sBAAsB,CAAA;AAElE,MAAM,WAAW,sBAAuB,SAAQ,YAAY,EAAE,YAAY;CAAI;AAE9E;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG,kBAAkB,CAAC,sBAAsB,EAAE,sBAAsB,CAAC,CAAA;AAEjG;;GAEG;AACH,eAAO,MAAM,kBAAkB,+CAAkE,CAAA;AAEjG;;GAEG;AACH,eAAO,MAAM,6BAA6B,iGAA6E,CAAA;AAEvH;;GAEG;AACH,eAAO,MAAM,0BAA0B,8FAA0E,CAAA"}

package/dist/neutral/Discount/Payload/Coupon/Payload.d.ts

@@ -1,6 +1,18 @@
 import { type FixedAmountCoupon, type FixedPercentageCoupon, type FixedPriceCoupon } from './Coupons/index.ts';
+/**
+ * The type of coupons
+ */
 export type Coupon = FixedAmountCoupon | FixedPercentageCoupon | FixedPriceCoupon;
+/**
+ * Identity function for determining if an object is an Coupon
+ */
 export declare const isCoupon: (x?: unknown | null) => x is FixedAmountCoupon | FixedPercentageCoupon | FixedPriceCoupon;
+/**
+ * Identity function for determining if an object is an Coupon with sources
+ */
 export declare const isCouponWithSources: (x?: unknown | null) => x is import("@xyo-network/payload-model").WithSources<FixedAmountCoupon> | import("@xyo-network/payload-model").WithSources<FixedPercentageCoupon> | import("@xyo-network/payload-model").WithSources<FixedPriceCoupon>;
+/**
+ * Identity function for determining if an object is an Coupon with meta
+ */
 export declare const isCouponWithMeta: (x?: unknown | null) => x is import("@xyo-network/payload-model").WithMeta<FixedAmountCoupon> | import("@xyo-network/payload-model").WithMeta<FixedPercentageCoupon> | import("@xyo-network/payload-model").WithMeta<FixedPriceCoupon>;
 //# sourceMappingURL=Payload.d.ts.map

package/dist/neutral/Discount/Payload/Coupon/Payload.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Payload.d.ts","sourceRoot":"","sources":["../../../../../src/Discount/Payload/Coupon/Payload.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,iBAAiB,EAAE,KAAK,qBAAqB,EAAE,KAAK,gBAAgB,EAO1E,MAAM,oBAAoB,CAAA;AAK3B,MAAM,MAAM,MAAM,GAChB,iBAAiB,GACf,qBAAqB,GACrB,gBAAgB,CAAA;AAKpB,eAAO,MAAM,QAAQ,OAAQ,OAAO,GAAG,IAAI,sEAGjB,CAAA;AAK1B,eAAO,MAAM,mBAAmB,OAAQ,OAAO,GAAG,IAAI,4NAGjB,CAAA;AAKrC,eAAO,MAAM,gBAAgB,OAAQ,OAAO,GAAG,IAAI,mNAGjB,CAAA"}
+{"version":3,"file":"Payload.d.ts","sourceRoot":"","sources":["../../../../../src/Discount/Payload/Coupon/Payload.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,iBAAiB,EAAE,KAAK,qBAAqB,EAAE,KAAK,gBAAgB,EAO1E,MAAM,oBAAoB,CAAA;AAE3B;;GAEG;AACH,MAAM,MAAM,MAAM,GAChB,iBAAiB,GACf,qBAAqB,GACrB,gBAAgB,CAAA;AAEpB;;GAEG;AACH,eAAO,MAAM,QAAQ,OAAQ,OAAO,GAAG,IAAI,sEAGjB,CAAA;AAE1B;;GAEG;AACH,eAAO,MAAM,mBAAmB,OAAQ,OAAO,GAAG,IAAI,4NAGjB,CAAA;AAErC;;GAEG;AACH,eAAO,MAAM,gBAAgB,OAAQ,OAAO,GAAG,IAAI,mNAGjB,CAAA"}

package/dist/neutral/Discount/Payload/Coupon/Schema.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Schema.d.ts","sourceRoot":"","sources":["../../../../../src/Discount/Payload/Coupon/Schema.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,YAAY,+BAAyC,CAAA;AAClE,MAAM,MAAM,YAAY,GAAG,OAAO,YAAY,CAAA"}
+{"version":3,"file":"Schema.d.ts","sourceRoot":"","sources":["../../../../../src/Discount/Payload/Coupon/Schema.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,YAAY,EAAG,6BAAsC,CAAA;AAClE,MAAM,MAAM,YAAY,GAAG,OAAO,YAAY,CAAA"}

package/dist/neutral/Discount/Payload/Coupon/types/Condition.d.ts

@@ -1,7 +1,19 @@
 import { type WithMeta, type WithOptionalMeta } from '@xyo-network/payload-model';
 import { type SchemaPayload } from '@xyo-network/schema-payload-plugin';
+/**
+ * The payloads that can be used as conditions for a coupon
+ */
 export type Condition = SchemaPayload | WithOptionalMeta<SchemaPayload> | WithMeta<SchemaPayload>;
+/**
+ * Identity function for determining if an object is a Condition payload
+ */
 export declare const isCondition: (x?: unknown | null) => x is Condition;
+/**
+ * Identity function for determining if an object is a Condition payload with sources
+ */
 export declare const isConditionWithSources: (x?: unknown | null) => x is import("@xyo-network/payload-model").WithSources<Condition>;
+/**
+ * Identity function for determining if an object is a Condition payload with meta
+ */
 export declare const isConditionWithMeta: (x?: unknown | null) => x is WithMeta<Condition>;
 //# sourceMappingURL=Condition.d.ts.map

package/dist/neutral/Discount/Payload/Coupon/types/Condition.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Condition.d.ts","sourceRoot":"","sources":["../../../../../../src/Discount/Payload/Coupon/types/Condition.ts"],"names":[],"mappings":"AAAA,OAAO,EACmF,KAAK,QAAQ,EAAE,KAAK,gBAAgB,EAC7H,MAAM,4BAA4B,CAAA;AACnC,OAAO,EAAE,KAAK,aAAa,EAAgB,MAAM,oCAAoC,CAAA;AAKrF,MAAM,MAAM,SAAS,GAAG,aAAa,GAAG,gBAAgB,CAAC,aAAa,CAAC,GAAG,QAAQ,CAAC,aAAa,CAAC,CAAA;AAKjG,eAAO,MAAM,WAAW,wCAAiD,CAAA;AAKzE,eAAO,MAAM,sBAAsB,0FAA4D,CAAA;AAK/F,eAAO,MAAM,mBAAmB,kDAAyD,CAAA"}
+{"version":3,"file":"Condition.d.ts","sourceRoot":"","sources":["../../../../../../src/Discount/Payload/Coupon/types/Condition.ts"],"names":[],"mappings":"AAAA,OAAO,EACmF,KAAK,QAAQ,EAAE,KAAK,gBAAgB,EAC7H,MAAM,4BAA4B,CAAA;AACnC,OAAO,EAAE,KAAK,aAAa,EAAgB,MAAM,oCAAoC,CAAA;AAErF;;GAEG;AACH,MAAM,MAAM,SAAS,GAAG,aAAa,GAAG,gBAAgB,CAAC,aAAa,CAAC,GAAG,QAAQ,CAAC,aAAa,CAAC,CAAA;AAEjG;;GAEG;AACH,eAAO,MAAM,WAAW,wCAAiD,CAAA;AAEzE;;GAEG;AACH,eAAO,MAAM,sBAAsB,0FAA4D,CAAA;AAE/F;;GAEG;AACH,eAAO,MAAM,mBAAmB,kDAAyD,CAAA"}

package/dist/neutral/Discount/Payload/Coupon/types/CouponFields.d.ts

@@ -1,7 +1,16 @@
 import type { Hash } from '@xylabs/hex';
 import type { DurationFields } from '@xyo-network/xns-record-payload-plugins';
+/**
+ * The fields that are common across all coupons
+ */
 export interface CouponFields extends DurationFields {
+    /**
+     * The conditions that must be met in order for this coupon to be applied
+     */
     conditions?: Hash[];
+    /**
+     * Whether or not this discount can be stacked with other discounts
+     */
     stackable?: boolean;
 }
 //# sourceMappingURL=CouponFields.d.ts.map

package/dist/neutral/Discount/Payload/Coupon/types/CouponFields.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"CouponFields.d.ts","sourceRoot":"","sources":["../../../../../../src/Discount/Payload/Coupon/types/CouponFields.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,aAAa,CAAA;AACvC,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,yCAAyC,CAAA;AAK7E,MAAM,WAAW,YAAa,SAAQ,cAAc;IAIlD,UAAU,CAAC,EAAE,IAAI,EAAE,CAAA;IAInB,SAAS,CAAC,EAAE,OAAO,CAAA;CACpB"}
+{"version":3,"file":"CouponFields.d.ts","sourceRoot":"","sources":["../../../../../../src/Discount/Payload/Coupon/types/CouponFields.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,aAAa,CAAA;AACvC,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,yCAAyC,CAAA;AAE7E;;GAEG;AACH,MAAM,WAAW,YAAa,SAAQ,cAAc;IAClD;;OAEG;IACH,UAAU,CAAC,EAAE,IAAI,EAAE,CAAA;IACnB;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAA;CACpB"}

package/dist/neutral/Discount/Payload/Coupon/types/isStackable.d.ts

@@ -1,2 +1,5 @@
+/**
+ * Identity function for determining if coupon is stackable
+ */
 export declare const isStackable: (x?: unknown | null) => boolean | undefined;
 //# sourceMappingURL=isStackable.d.ts.map

package/dist/neutral/Discount/Payload/Coupon/types/isStackable.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"isStackable.d.ts","sourceRoot":"","sources":["../../../../../../src/Discount/Payload/Coupon/types/isStackable.ts"],"names":[],"mappings":"AAKA,eAAO,MAAM,WAAW,OAAQ,OAAO,GAAG,IAAI,wBAA2D,CAAA"}
+{"version":3,"file":"isStackable.d.ts","sourceRoot":"","sources":["../../../../../../src/Discount/Payload/Coupon/types/isStackable.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,eAAO,MAAM,WAAW,OAAQ,OAAO,GAAG,IAAI,wBAA2D,CAAA"}

package/dist/neutral/Discount/Payload/Discount.d.ts

@@ -4,8 +4,20 @@ export declare const DiscountSchema: "network.xyo.payments.discount";
 export type DiscountSchema = typeof DiscountSchema;
 export interface DiscountFields extends AmountFields {
 }
+/**
+ * The result of a discount
+ */
 export type Discount = PayloadWithSources<DiscountFields, DiscountSchema>;
+/**
+ * Identity function for determining if an object is an Discount
+ */
 export declare const isDiscount: (x?: unknown | null) => x is Discount;
+/**
+ * Identity function for determining if an object is an Discount with sources
+ */
 export declare const isDiscountWithSources: (x?: unknown | null) => x is import("@xyo-network/payload-model").WithSources<Discount>;
+/**
+ * Identity function for determining if an object is an Discount with meta
+ */
 export declare const isDiscountWithMeta: (x?: unknown | null) => x is import("@xyo-network/payload-model").WithMeta<Discount>;
 //# sourceMappingURL=Discount.d.ts.map

package/dist/neutral/Discount/Payload/Discount.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Discount.d.ts","sourceRoot":"","sources":["../../../../src/Discount/Payload/Discount.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAA;AAOpE,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAA;AAEzD,eAAO,MAAM,cAAc,iCAA2C,CAAA;AACtE,MAAM,MAAM,cAAc,GAAG,OAAO,cAAc,CAAA;AAElD,MAAM,WAAW,cAAe,SAAQ,YAAY;CAAI;AAKxD,MAAM,MAAM,QAAQ,GAAG,kBAAkB,CAAC,cAAc,EAAE,cAAc,CAAC,CAAA;AAKzE,eAAO,MAAM,UAAU,uCAAkD,CAAA;AAKzE,eAAO,MAAM,qBAAqB,yFAA6D,CAAA;AAK/F,eAAO,MAAM,kBAAkB,sFAA0D,CAAA"}
+{"version":3,"file":"Discount.d.ts","sourceRoot":"","sources":["../../../../src/Discount/Payload/Discount.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAA;AAOpE,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAA;AAEzD,eAAO,MAAM,cAAc,EAAG,+BAAwC,CAAA;AACtE,MAAM,MAAM,cAAc,GAAG,OAAO,cAAc,CAAA;AAElD,MAAM,WAAW,cAAe,SAAQ,YAAY;CAAI;AAExD;;GAEG;AACH,MAAM,MAAM,QAAQ,GAAG,kBAAkB,CAAC,cAAc,EAAE,cAAc,CAAC,CAAA;AAEzE;;GAEG;AACH,eAAO,MAAM,UAAU,uCAAkD,CAAA;AAEzE;;GAEG;AACH,eAAO,MAAM,qBAAqB,yFAA6D,CAAA;AAE/F;;GAEG;AACH,eAAO,MAAM,kBAAkB,sFAA0D,CAAA"}

package/dist/neutral/Escrow/Outcome.d.ts

@@ -2,13 +2,28 @@ import type { Hash } from '@xylabs/hex';
 import type { PayloadWithSources } from '@xyo-network/payload-model';
 export declare const EscrowOutcomeSchema: "network.xyo.escrow.outcome";
 export type EscrowOutcomeSchema = typeof EscrowOutcomeSchema;
+/**
+ * The possible outcomes for an escrow
+ */
 export type EscrowOutcomes = 'fulfilled' | 'expired';
 export interface EscrowOutcomeFields {
     outcome: EscrowOutcomes;
     terms: Hash;
 }
+/**
+ * The terms of an escrow
+ */
 export type EscrowOutcome = PayloadWithSources<EscrowOutcomeFields, EscrowOutcomeSchema>;
+/**
+ * Identity function for determining if an object is an EscrowOutcome
+ */
 export declare const isEscrowOutcome: (x?: unknown | null) => x is EscrowOutcome;
+/**
+ * Identity function for determining if an object is an EscrowOutcome with sources
+ */
 export declare const isEscrowOutcomeWithSources: (x?: unknown | null) => x is import("@xyo-network/payload-model").WithSources<EscrowOutcome>;
+/**
+ * Identity function for determining if an object is an EscrowOutcome with meta
+ */
 export declare const isEscrowOutcomeWithMeta: (x?: unknown | null) => x is import("@xyo-network/payload-model").WithMeta<EscrowOutcome>;
 //# sourceMappingURL=Outcome.d.ts.map

package/dist/neutral/Escrow/Outcome.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Outcome.d.ts","sourceRoot":"","sources":["../../../src/Escrow/Outcome.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,aAAa,CAAA;AACvC,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAA;AASpE,eAAO,MAAM,mBAAmB,8BAAqC,CAAA;AACrE,MAAM,MAAM,mBAAmB,GAAG,OAAO,mBAAmB,CAAA;AAK5D,MAAM,MAAM,cAAc,GAAG,WAAW,GAAG,SAAS,CAAA;AAEpD,MAAM,WAAW,mBAAmB;IAClC,OAAO,EAAE,cAAc,CAAA;IACvB,KAAK,EAAE,IAAI,CAAA;CACZ;AAKD,MAAM,MAAM,aAAa,GAAG,kBAAkB,CAAC,mBAAmB,EAAE,mBAAmB,CAAC,CAAA;AAKxF,eAAO,MAAM,eAAe,4CAA4D,CAAA;AAKxF,eAAO,MAAM,0BAA0B,8FAAuE,CAAA;AAK9G,eAAO,MAAM,uBAAuB,2FAAoE,CAAA"}
+{"version":3,"file":"Outcome.d.ts","sourceRoot":"","sources":["../../../src/Escrow/Outcome.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,aAAa,CAAA;AACvC,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAA;AASpE,eAAO,MAAM,mBAAmB,8BAAqC,CAAA;AACrE,MAAM,MAAM,mBAAmB,GAAG,OAAO,mBAAmB,CAAA;AAE5D;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG,WAAW,GAAG,SAAS,CAAA;AAEpD,MAAM,WAAW,mBAAmB;IAClC,OAAO,EAAE,cAAc,CAAA;IACvB,KAAK,EAAE,IAAI,CAAA;CACZ;AAED;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,kBAAkB,CAAC,mBAAmB,EAAE,mBAAmB,CAAC,CAAA;AAExF;;GAEG;AACH,eAAO,MAAM,eAAe,4CAA4D,CAAA;AAExF;;GAEG;AACH,eAAO,MAAM,0BAA0B,8FAAuE,CAAA;AAE9G;;GAEG;AACH,eAAO,MAAM,uBAAuB,2FAAoE,CAAA"}

package/dist/neutral/Escrow/Terms/Party.d.ts

@@ -1,3 +1,6 @@
 import type { EscrowTermsFields } from './Terms.ts';
+/**
+ * The party in an escrow transaction
+ */
 export type EscrowParty = keyof Pick<EscrowTermsFields, 'buyer' | 'seller'>;
 //# sourceMappingURL=Party.d.ts.map

package/dist/neutral/Escrow/Terms/Party.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Party.d.ts","sourceRoot":"","sources":["../../../../src/Escrow/Terms/Party.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAA;AAKnD,MAAM,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,iBAAiB,EAAE,OAAO,GAAG,QAAQ,CAAC,CAAA"}
+{"version":3,"file":"Party.d.ts","sourceRoot":"","sources":["../../../../src/Escrow/Terms/Party.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAA;AAEnD;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,iBAAiB,EAAE,OAAO,GAAG,QAAQ,CAAC,CAAA"}

package/dist/neutral/Escrow/Terms/PartySecret.d.ts

@@ -1,3 +1,6 @@
 import type { EscrowTermsFields } from './Terms.ts';
+/**
+ * The party's secret in an escrow transaction
+ */
 export type EscrowPartySecret = keyof Pick<EscrowTermsFields, 'buyerSecret' | 'sellerSecret'>;
 //# sourceMappingURL=PartySecret.d.ts.map

package/dist/neutral/Escrow/Terms/PartySecret.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"PartySecret.d.ts","sourceRoot":"","sources":["../../../../src/Escrow/Terms/PartySecret.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAA;AAKnD,MAAM,MAAM,iBAAiB,GAAG,MAAM,IAAI,CAAC,iBAAiB,EAAE,aAAa,GAAG,cAAc,CAAC,CAAA"}
+{"version":3,"file":"PartySecret.d.ts","sourceRoot":"","sources":["../../../../src/Escrow/Terms/PartySecret.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAA;AAEnD;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG,MAAM,IAAI,CAAC,iBAAiB,EAAE,aAAa,GAAG,cAAc,CAAC,CAAA"}

package/dist/neutral/Escrow/Terms/Terms.d.ts

@@ -3,26 +3,74 @@ import type { Payload } from '@xyo-network/payload-model';
 export declare const EscrowTermsSchema: "network.xyo.escrow.terms";
 export type EscrowTermsSchema = typeof EscrowTermsSchema;
 export interface EscrowTermsFields {
+    /**
+     * The trusted estimators for the worth of the things being sold
+     */
     appraisalAuthorities: Address[];
+    /**
+     * The estimated worths of the things being sold
+     */
     appraisals: Hash[];
+    /**
+     * The things being sold
+     */
     assets: Hash[];
+    /**
+     * The buyer
+     */
     buyer: Address[];
+    /**
+     * The buyer
+     */
     buyerSecret: Hash;
+    /**
+     * Any discounts (coupons, vouchers, credits, etc.) to be applied to the escrow
+     */
     discounts: Hash[];
+    /**
+     * The escrow agent responsible for the escrow
+     */
     escrowAgent: Address;
+    /**
+     * The time the escrow expires
+     */
     exp: number;
+    /**
+     * The time the escrow starts
+     */
     nbf: number;
+    /**
+     * The trusted payment authorities
+     */
     paymentAuthorities: Address[];
+    /**
+     * The seller
+     */
     seller: Address[];
+    /**
+     * The seller
+     */
     sellerSecret: Hash;
 }
+/**
+ * The terms of an escrow
+ */
 export type EscrowTerms = Payload<Partial<EscrowTermsFields>, EscrowTermsSchema>;
+/**
+ * Identity function for determining if an object is an EscrowTerms
+ */
 export declare const isEscrowTerms: (x?: unknown | null) => x is import("@xyo-network/payload-model").SchemaFields & import("@xyo-network/payload-model").PayloadFields & Partial<EscrowTermsFields> & {
     schema: "network.xyo.escrow.terms";
 };
+/**
+ * Identity function for determining if an object is an EscrowTerms with sources
+ */
 export declare const isEscrowTermsWithSources: (x?: unknown | null) => x is import("@xyo-network/payload-model").WithSources<import("@xyo-network/payload-model").SchemaFields & import("@xyo-network/payload-model").PayloadFields & Partial<EscrowTermsFields> & {
     schema: "network.xyo.escrow.terms";
 }>;
+/**
+ * Identity function for determining if an object is an EscrowTerms with meta
+ */
 export declare const isEscrowTermsWithMeta: (x?: unknown | null) => x is import("@xyo-network/payload-model").WithMeta<import("@xyo-network/payload-model").SchemaFields & import("@xyo-network/payload-model").PayloadFields & Partial<EscrowTermsFields> & {
     schema: "network.xyo.escrow.terms";
 }>;

package/dist/neutral/Escrow/Terms/Terms.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Terms.d.ts","sourceRoot":"","sources":["../../../../src/Escrow/Terms/Terms.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,aAAa,CAAA;AAChD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAA;AAOzD,eAAO,MAAM,iBAAiB,4BAAmC,CAAA;AACjE,MAAM,MAAM,iBAAiB,GAAG,OAAO,iBAAiB,CAAA;AAGxD,MAAM,WAAW,iBAAiB;IAIhC,oBAAoB,EAAE,OAAO,EAAE,CAAA;IAI/B,UAAU,EAAE,IAAI,EAAE,CAAA;IAIlB,MAAM,EAAE,IAAI,EAAE,CAAA;IAId,KAAK,EAAE,OAAO,EAAE,CAAA;IAIhB,WAAW,EAAE,IAAI,CAAA;IAIjB,SAAS,EAAE,IAAI,EAAE,CAAA;IAIjB,WAAW,EAAE,OAAO,CAAA;IAIpB,GAAG,EAAE,MAAM,CAAA;IAIX,GAAG,EAAE,MAAM,CAAA;IAIX,kBAAkB,EAAE,OAAO,EAAE,CAAA;IAI7B,MAAM,EAAE,OAAO,EAAE,CAAA;IAIjB,YAAY,EAAE,IAAI,CAAA;CACnB;AAKD,MAAM,MAAM,WAAW,GAAG,OAAO,CAAC,OAAO,CAAC,iBAAiB,CAAC,EAAE,iBAAiB,CAAC,CAAA;AAKhF,eAAO,MAAM,aAAa;;CAAwD,CAAA;AAKlF,eAAO,MAAM,wBAAwB;;EAAmE,CAAA;AAKxG,eAAO,MAAM,qBAAqB;;EAAgE,CAAA"}
+{"version":3,"file":"Terms.d.ts","sourceRoot":"","sources":["../../../../src/Escrow/Terms/Terms.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,aAAa,CAAA;AAChD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAA;AAOzD,eAAO,MAAM,iBAAiB,4BAAmC,CAAA;AACjE,MAAM,MAAM,iBAAiB,GAAG,OAAO,iBAAiB,CAAA;AAGxD,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,oBAAoB,EAAE,OAAO,EAAE,CAAA;IAC/B;;OAEG;IACH,UAAU,EAAE,IAAI,EAAE,CAAA;IAClB;;OAEG;IACH,MAAM,EAAE,IAAI,EAAE,CAAA;IACd;;OAEG;IACH,KAAK,EAAE,OAAO,EAAE,CAAA;IAChB;;OAEG;IACH,WAAW,EAAE,IAAI,CAAA;IACjB;;OAEG;IACH,SAAS,EAAE,IAAI,EAAE,CAAA;IACjB;;OAEG;IACH,WAAW,EAAE,OAAO,CAAA;IACpB;;OAEG;IACH,GAAG,EAAE,MAAM,CAAA;IACX;;OAEG;IACH,GAAG,EAAE,MAAM,CAAA;IACX;;OAEG;IACH,kBAAkB,EAAE,OAAO,EAAE,CAAA;IAC7B;;OAEG;IACH,MAAM,EAAE,OAAO,EAAE,CAAA;IACjB;;OAEG;IACH,YAAY,EAAE,IAAI,CAAA;CACnB;AAED;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG,OAAO,CAAC,OAAO,CAAC,iBAAiB,CAAC,EAAE,iBAAiB,CAAC,CAAA;AAEhF;;GAEG;AACH,eAAO,MAAM,aAAa;;CAAwD,CAAA;AAElF;;GAEG;AACH,eAAO,MAAM,wBAAwB;;EAAmE,CAAA;AAExG;;GAEG;AACH,eAAO,MAAM,qBAAqB;;EAAgE,CAAA"}

package/dist/neutral/Escrow/util/appraisal/getAppraisalsByAsset.d.ts

@@ -2,5 +2,11 @@ import type { Hash } from '@xylabs/hex';
 import { type HashLeaseEstimate } from '@xyo-network/diviner-hash-lease';
 import type { Payload, WithMeta, WithSources } from '@xyo-network/payload-model';
 import type { EscrowTerms } from '../../Terms/index.ts';
+/**
+ * Returns a dictionary of asset hashes and their associated appraisals
+ * @param terms The escrow terms
+ * @param dictionary The dictionary of payloads associated with the escrow terms
+ * @returns A dictionary of asset hashes and their associated appraisals
+ */
 export declare const getAppraisalsByAsset: (terms: EscrowTerms, dictionary: Record<Hash, WithMeta<Payload>>) => Record<Hash, WithSources<HashLeaseEstimate>[]>;
 //# sourceMappingURL=getAppraisalsByAsset.d.ts.map

package/dist/neutral/Escrow/util/appraisal/getAppraisalsByAsset.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"getAppraisalsByAsset.d.ts","sourceRoot":"","sources":["../../../../../src/Escrow/util/appraisal/getAppraisalsByAsset.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,aAAa,CAAA;AACvC,OAAO,EAAE,KAAK,iBAAiB,EAAkC,MAAM,iCAAiC,CAAA;AACxG,OAAO,KAAK,EACV,OAAO,EAAE,QAAQ,EAAE,WAAW,EAC/B,MAAM,4BAA4B,CAAA;AAEnC,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAA;AAQvD,eAAO,MAAM,oBAAoB,UAAW,WAAW,cAAc,MAAM,CAAC,IAAI,EAAE,QAAQ,CAAC,OAAO,CAAC,CAAC,KAAG,MAAM,CAAC,IAAI,EAAE,WAAW,CAAC,iBAAiB,CAAC,EAAE,CAkBnJ,CAAA"}
+{"version":3,"file":"getAppraisalsByAsset.d.ts","sourceRoot":"","sources":["../../../../../src/Escrow/util/appraisal/getAppraisalsByAsset.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,aAAa,CAAA;AACvC,OAAO,EAAE,KAAK,iBAAiB,EAAkC,MAAM,iCAAiC,CAAA;AACxG,OAAO,KAAK,EACV,OAAO,EAAE,QAAQ,EAAE,WAAW,EAC/B,MAAM,4BAA4B,CAAA;AAEnC,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAA;AAEvD;;;;;GAKG;AACH,eAAO,MAAM,oBAAoB,UAAW,WAAW,cAAc,MAAM,CAAC,IAAI,EAAE,QAAQ,CAAC,OAAO,CAAC,CAAC,KAAG,MAAM,CAAC,IAAI,EAAE,WAAW,CAAC,iBAAiB,CAAC,EAAE,CAkBnJ,CAAA"}