@xyo-network/payment-plugin 4.1.0 → 4.2.0

package/dist/neutral/index.d.ts

@@ -1,88 +1,5 @@
-import { Address, Hash } from '@xylabs/hex';
-import { ArchivistInstance } from '@xyo-network/archivist-model';
-import { AbstractDiviner } from '@xyo-network/diviner-abstract';
-import { HashLeaseEstimate } from '@xyo-network/diviner-hash-lease';
-import { DivinerModuleEventData, DivinerInstance } from '@xyo-network/diviner-model';
-import { Payload } from '@xyo-network/payload-model';
-import { EscrowTerms, Coupon, PaymentDiscountDivinerParams, Discount, Condition, Invoice, PaymentSubtotalDivinerParams, Subtotal, PaymentTotalDivinerParams, Total, PaymentTotalDivinerConfigSchema } from '@xyo-network/payment-payload-plugins';
-
-type PaymentDiscountDivinerInputType = EscrowTerms | Coupon | HashLeaseEstimate | Payload;
-declare class PaymentDiscountDiviner<TParams extends PaymentDiscountDivinerParams = PaymentDiscountDivinerParams, TIn extends PaymentDiscountDivinerInputType = PaymentDiscountDivinerInputType, TOut extends Discount = Discount, TEventData extends DivinerModuleEventData<DivinerInstance<TParams, TIn, TOut>, TIn, TOut> = DivinerModuleEventData<DivinerInstance<TParams, TIn, TOut>, TIn, TOut>> extends AbstractDiviner<TParams, TIn, TOut, TEventData> {
-    static readonly configSchemas: string[];
-    static readonly defaultConfigSchema = "network.xyo.diviner.payments.discount.config";
-    protected get couponAuthorities(): Address[];
-    protected divineHandler(payloads?: TIn[]): Promise<TOut[]>;
-    /**
-     * Filters the supplied list of coupons to only those that are signed by
-     * addresses specified in the couponAuthorities
-     * @param coupons The list of coupons to filter
-     * @returns The filtered list of coupons that are signed by the couponAuthorities
-     */
-    protected filterToSigned(coupons: Coupon[]): Promise<Coupon[]>;
-    protected getDiscountsArchivist(): Promise<ArchivistInstance>;
-    protected getDiscountsBoundWitnessDiviner(): Promise<DivinerInstance>;
-    /**
-     * Finds the appraisals specified by the escrow terms from the supplied payloads
-     * @param terms The escrow terms
-     * @param payloads The payloads to search for the appraisals
-     * @returns The appraisals found in the payloads
-     */
-    protected getEscrowAppraisals(terms: EscrowTerms, hashMap: Record<Hash, Payload>): HashLeaseEstimate[];
-    /**
-     * Finds the discounts specified by the escrow terms from the supplied payloads
-     * @param terms The escrow terms
-     * @param hashMap The payloads to search for the discounts
-     * @returns A tuple containing all the escrow coupons and conditions referenced in those coupons
-     * that were found in the either the supplied payloads or the archivist
-     */
-    protected getEscrowDiscounts(terms: EscrowTerms, hashMap: Record<Hash, Payload>): Promise<[Coupon[], Condition[]]>;
-    protected isCouponCurrent(coupon: Coupon): boolean;
-}
-
-declare const applyCoupons: (appraisals: HashLeaseEstimate[], coupons: Coupon[]) => Discount;
-
-/**
- * Validates the conditions of a coupon against the provided payloads
- * @param coupon The coupon to check
- * @param conditions The conditions associated with the coupon
- * @param payloads The associated payloads (containing the conditions and data to validate the conditions against)
- * @returns True if all conditions are fulfilled, false otherwise
- */
-declare const areConditionsFulfilled: (coupon: Coupon, conditions?: Condition[], payloads?: Payload[]) => Promise<boolean>;
-/**
- * Validates the conditions of a coupon against the provided payloads
- * @param coupon The coupon to check
- * @param conditions The conditions associated with the coupon
- * @param payloads The associated payloads (containing the conditions and data to validate the conditions against)
- * @returns The unfulfilled condition hashes
- */
-declare const findUnfulfilledConditions: (coupon: Coupon, conditions?: Condition[], payloads?: Payload[]) => Promise<Hash[]>;
-
-/**
- * Validates the escrow terms to ensure they are valid for a purchase
- * @returns A payment if the terms are valid for a purchase, undefined otherwise
- */
-declare const getInvoiceForEscrow: (terms: EscrowTerms, dataHashMap: Record<Hash, Payload>, paymentTotalDiviner: DivinerInstance) => Promise<Invoice | undefined>;
-
-/**
- * Escrow terms that contain all the valid fields for calculating a subtotal
- */
-type PaymentSubtotalDivinerInputType = EscrowTerms | HashLeaseEstimate | Payload;
-declare class PaymentSubtotalDiviner<TParams extends PaymentSubtotalDivinerParams = PaymentSubtotalDivinerParams, TIn extends PaymentSubtotalDivinerInputType = PaymentSubtotalDivinerInputType, TOut extends Subtotal = Subtotal, TEventData extends DivinerModuleEventData<DivinerInstance<TParams, TIn, TOut>, TIn, TOut> = DivinerModuleEventData<DivinerInstance<TParams, TIn, TOut>, TIn, TOut>> extends AbstractDiviner<TParams, TIn, TOut, TEventData> {
-    static readonly configSchemas: string[];
-    static readonly defaultConfigSchema = "network.xyo.diviner.payments.subtotal.config";
-    protected divineHandler(payloads?: TIn[]): Promise<TOut[]>;
-}
-
-type InputType = PaymentDiscountDivinerInputType | PaymentSubtotalDivinerInputType;
-type OutputType = Subtotal | Discount | Total;
-declare class PaymentTotalDiviner<TParams extends PaymentTotalDivinerParams = PaymentTotalDivinerParams, TIn extends InputType = InputType, TOut extends OutputType = OutputType, TEventData extends DivinerModuleEventData<DivinerInstance<TParams, TIn, TOut>, TIn, TOut> = DivinerModuleEventData<DivinerInstance<TParams, TIn, TOut>, TIn, TOut>> extends AbstractDiviner<TParams, TIn, TOut, TEventData> {
-    static readonly configSchemas: string[];
-    static readonly defaultConfigSchema: PaymentTotalDivinerConfigSchema;
-    protected divineHandler(payloads?: TIn[]): Promise<TOut[]>;
-    protected getPaymentDiscountsDiviner(): Promise<PaymentDiscountDiviner>;
-    protected getPaymentSubtotalDiviner(): Promise<PaymentSubtotalDiviner>;
-}
-
-export { PaymentDiscountDiviner, PaymentSubtotalDiviner, PaymentTotalDiviner, applyCoupons, areConditionsFulfilled, findUnfulfilledConditions, getInvoiceForEscrow };
-export type { PaymentDiscountDivinerInputType, PaymentSubtotalDivinerInputType };
+export * from './Discount/index.ts';
+export * from './Invoice/index.ts';
+export * from './Subtotal/index.ts';
+export * from './Total/index.ts';
+//# sourceMappingURL=index.d.ts.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xyo-network/payment-plugin",
-  "version": "4.1.0",
+  "version": "4.2.0",
   "description": "Typescript/Javascript Plugins for XYO Platform",
   "homepage": "https://xyo.network",
   "bugs": {
@@ -29,35 +29,34 @@
   "module": "dist/neutral/index.mjs",
   "types": "dist/neutral/index.d.ts",
   "dependencies": {
-    "@xylabs/array": "^4.13.15",
-    "@xylabs/assert": "^4.13.15",
-    "@xylabs/exists": "^4.13.15",
-    "@xylabs/hex": "^4.13.15",
-    "@xyo-network/archivist-model": "^4.1.1",
-    "@xyo-network/diviner-abstract": "^4.1.1",
-    "@xyo-network/diviner-boundwitness-model": "^4.1.1",
-    "@xyo-network/diviner-hash-lease": "^4.1.1",
-    "@xyo-network/diviner-model": "^4.1.1",
-    "@xyo-network/module-model": "^4.1.1",
-    "@xyo-network/payload-builder": "^4.1.1",
-    "@xyo-network/payload-model": "^4.1.1",
-    "@xyo-network/payment-payload-plugins": "^4.1.0",
-    "@xyo-network/schema-payload-plugin": "^4.1.1",
-    "@xyo-network/xns-record-payload-plugins": "^4.1.0",
+    "@xylabs/array": "^4.15.1",
+    "@xylabs/assert": "^4.15.1",
+    "@xylabs/exists": "^4.15.1",
+    "@xylabs/hex": "^4.15.1",
+    "@xyo-network/archivist-model": "^4.3.0",
+    "@xyo-network/diviner-abstract": "^4.3.0",
+    "@xyo-network/diviner-boundwitness-model": "^4.3.0",
+    "@xyo-network/diviner-hash-lease": "^4.3.0",
+    "@xyo-network/diviner-model": "^4.3.0",
+    "@xyo-network/module-model": "^4.3.0",
+    "@xyo-network/payload-builder": "^4.3.0",
+    "@xyo-network/payload-model": "^4.3.0",
+    "@xyo-network/payment-payload-plugins": "^4.2.0",
+    "@xyo-network/schema-payload-plugin": "^4.3.0",
+    "@xyo-network/xns-record-payload-plugins": "^4.2.0",
     "ajv": "^8.17.1"
   },
   "devDependencies": {
-    "@xylabs/ts-scripts-yarn3": "^7.0.0-rc.24",
-    "@xylabs/tsconfig": "^7.0.0-rc.24",
-    "@xylabs/vitest-extended": "^4.13.15",
-    "@xyo-network/archivist-memory": "^4.1.1",
-    "@xyo-network/boundwitness-builder": "^4.1.1",
-    "@xyo-network/diviner-boundwitness-memory": "^4.1.1",
-    "@xyo-network/id-payload-plugin": "^4.1.1",
-    "@xyo-network/node-memory": "^4.1.1",
-    "@xyo-network/wallet": "^4.1.1",
-    "@xyo-network/wallet-model": "^4.1.1",
-    "knip": "^5.61.3",
+    "@xylabs/ts-scripts-yarn3": "^7.0.1",
+    "@xylabs/tsconfig": "^7.0.1",
+    "@xylabs/vitest-extended": "^4.15.1",
+    "@xyo-network/archivist-memory": "^4.3.0",
+    "@xyo-network/boundwitness-builder": "^4.3.0",
+    "@xyo-network/diviner-boundwitness-memory": "^4.3.0",
+    "@xyo-network/id-payload-plugin": "^4.3.0",
+    "@xyo-network/node-memory": "^4.3.0",
+    "@xyo-network/wallet": "^4.3.0",
+    "@xyo-network/wallet-model": "^4.3.0",
     "typescript": "^5.8.3",
     "vitest": "^3.2.4"
   },