@xyo-network/payment-payload-plugins 5.3.2 → 5.3.3

package/src/Payment/Instrument/Card/Payload.ts

@@ -1,50 +0,0 @@
-import { AsObjectFactory } from '@xylabs/sdk-js'
-import type { Payload, WithSources } from '@xyo-network/payload-model'
-import { isPayloadOfSchemaType, isPayloadOfSchemaTypeWithSources } from '@xyo-network/payload-model'
-
-import { PaymentCardSchema } from './Schema.ts'
-
-/**
- * The fields describing a payment card.
- */
-export interface PaymentCardFields {
-  /**
-   * Card Number (PAN) of the payment card. This value is required to perform a payment.
-   */
-  cardNumber: string
-  /**
-   * The name as it appears on the payment card.
-   */
-  cardholderName?: string
-  /**
-   * Card Verification Value (CVV/CVC) of the payment card.
-   */
-  cvv: string
-  /**
-   * Expiration month of the payment card.
-   */
-  expMonth: number
-  /**
-   * Expiration year of the payment card.
-   */
-  expYear: number
-}
-
-/**
- * A PaymentCard Payload
- */
-export type PaymentCard = Payload<PaymentCardFields, PaymentCardSchema>
-
-/**
- * Identity function for determine if an object is a PaymentCard
- */
-export const isPaymentCard = isPayloadOfSchemaType<PaymentCard>(PaymentCardSchema)
-export const asPaymentCard = AsObjectFactory.create<PaymentCard>(isPaymentCard)
-export const asOptionalPaymentCard = AsObjectFactory.createOptional<PaymentCard>(isPaymentCard)
-
-/**
- * Identity function for determine if an object is a PaymentCard with sources
- */
-export const isPaymentCardWithSources = isPayloadOfSchemaTypeWithSources<PaymentCard>(PaymentCardSchema)
-export const asPaymentCardWithSources = AsObjectFactory.create<WithSources<PaymentCard>>(isPaymentCardWithSources)
-export const asOptionalPaymentCardWithSources = AsObjectFactory.createOptional<WithSources<PaymentCard>>(isPaymentCardWithSources)

package/src/Payment/Instrument/Card/Schema.ts

@@ -1,6 +0,0 @@
-import { asSchema } from '@xyo-network/payload-model'
-
-import { PaymentInstrumentSchema } from '../Schema.ts'
-
-export const PaymentCardSchema = asSchema(`${PaymentInstrumentSchema}.card`, true)
-export type PaymentCardSchema = typeof PaymentCardSchema

package/src/Payment/Instrument/Card/index.ts

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

package/src/Payment/Instrument/Schema.ts

@@ -1,6 +0,0 @@
-import { asSchema } from '@xyo-network/payload-model'
-
-import { PaymentSchema } from '../Schema.ts'
-
-export const PaymentInstrumentSchema = asSchema(`${PaymentSchema}.instrument`, true)
-export type PaymentInstrumentSchema = typeof PaymentInstrumentSchema

package/src/Payment/Instrument/index.ts

@@ -1,2 +0,0 @@
-export * from './Card/index.ts'
-export * from './Schema.ts'

package/src/Payment/Payload.ts

@@ -1,39 +0,0 @@
-import { AsObjectFactory } from '@xylabs/sdk-js'
-import type { PayloadWithSources, WithSources } from '@xyo-network/payload-model'
-import {
-  isPayloadOfSchemaType,
-  isPayloadOfSchemaTypeWithSources,
-} from '@xyo-network/payload-model'
-
-import type { SupportedCurrency } from '../Currency.ts'
-import { PaymentSchema } from './Schema.ts'
-
-export interface PaymentFields {
-  /**
-   * The amount paid
-   */
-  amount: number
-  /**
-   * The currency of the amount paid
-   */
-  currency: SupportedCurrency
-}
-
-/**
- * A payment is a record of an amount to be paid
- */
-export type Payment = PayloadWithSources<PaymentFields, PaymentSchema>
-
-/**
- * Identity function for determine if an object is a Payment
- */
-export const isPayment = isPayloadOfSchemaType<Payment>(PaymentSchema)
-export const asPayment = AsObjectFactory.create<Payment>(isPayment)
-export const asOptionalPayment = AsObjectFactory.createOptional<Payment>(isPayment)
-
-/**
- * Identity function for determine if an object is a Payment with sources
- */
-export const isPaymentWithSources = isPayloadOfSchemaTypeWithSources<Payment>(PaymentSchema)
-export const asPaymentWithSources = AsObjectFactory.create<WithSources<Payment>>(isPaymentWithSources)
-export const asOptionalPaymentWithSources = AsObjectFactory.createOptional<WithSources<Payment>>(isPaymentWithSources)

package/src/Payment/Schema.ts

@@ -1,6 +0,0 @@
-import { asSchema } from '@xyo-network/payload-model'
-
-import { PaymentsSchema } from '../Schema.ts'
-
-export const PaymentSchema = asSchema(`${PaymentsSchema}.payment`, true)
-export type PaymentSchema = typeof PaymentSchema

package/src/Payment/Status/Payload.ts

@@ -1,39 +0,0 @@
-import { AsObjectFactory } from '@xylabs/sdk-js'
-import type { PayloadWithSources, WithSources } from '@xyo-network/payload-model'
-import {
-  isPayloadOfSchemaType,
-  isPayloadOfSchemaTypeWithSources,
-} from '@xyo-network/payload-model'
-
-import { PaymentStatusSchema } from './Schema.ts'
-
-export interface PaymentStatusFields {
-  /**
-   * The result of the payment (i.e. declined)
-   */
-  result?: string
-
-  /**
-   * The status of the payment (i.e. completed)
-   */
-  status: string
-}
-
-/**
- * A payment status is the outcome of a payment attempt
- */
-export type PaymentStatus = PayloadWithSources<PaymentStatusFields, PaymentStatusSchema>
-
-/**
- * Identity function for determine if an object is a PaymentStatus
- */
-export const isPaymentStatus = isPayloadOfSchemaType<PaymentStatus>(PaymentStatusSchema)
-export const asPaymentStatus = AsObjectFactory.create<PaymentStatus>(isPaymentStatus)
-export const asOptionalPaymentStatus = AsObjectFactory.createOptional<PaymentStatus>(isPaymentStatus)
-
-/**
- * Identity function for determine if an object is a PaymentStatus with sources
- */
-export const isPaymentStatusWithSources = isPayloadOfSchemaTypeWithSources<PaymentStatus>(PaymentStatusSchema)
-export const asPaymentStatusWithSources = AsObjectFactory.create<WithSources<PaymentStatus>>(isPaymentStatusWithSources)
-export const asOptionalPaymentStatusWithSources = AsObjectFactory.createOptional<WithSources<PaymentStatus>>(isPaymentStatusWithSources)

package/src/Payment/Status/Schema.ts

@@ -1,6 +0,0 @@
-import { asSchema } from '@xyo-network/payload-model'
-
-import { PaymentSchema } from '../Schema.ts'
-
-export const PaymentStatusSchema = asSchema(`${PaymentSchema}.status`, true)
-export type PaymentStatusSchema = typeof PaymentStatusSchema

package/src/Payment/Status/index.ts

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

package/src/Payment/index.ts

@@ -1,4 +0,0 @@
-export * from './Instrument/index.ts'
-export * from './Payload.ts'
-export * from './Schema.ts'
-export * from './Status/index.ts'

package/src/Purchase/Payload.ts

@@ -1,40 +0,0 @@
-import type { Hash } from '@xylabs/sdk-js'
-import { AsObjectFactory } from '@xylabs/sdk-js'
-import type { PayloadWithSources, WithSources } from '@xyo-network/payload-model'
-import {
-  isPayloadOfSchemaType,
-  isPayloadOfSchemaTypeWithSources,
-} from '@xyo-network/payload-model'
-
-import { PurchaseSchema } from './Schema.ts'
-
-export interface PurchaseFields {
-  /**
-   * The things that were purchased
-   */
-  assets: Hash[]
-  /**
-   * The receipts for payments for this purchase.  Array to allow for multiple payments
-   * for a single quote.
-   */
-  receipts: Hash[]
-}
-
-/**
- * A purchase ties a payment made to a quote
- */
-export type Purchase = PayloadWithSources<PurchaseFields, PurchaseSchema>
-
-/**
- * Identity function for determine if an object is a Purchase
- */
-export const isPurchase = isPayloadOfSchemaType<Purchase>(PurchaseSchema)
-export const asPurchase = AsObjectFactory.create<Purchase>(isPurchase)
-export const asOptionalPurchase = AsObjectFactory.createOptional<Purchase>(isPurchase)
-
-/**
- * Identity function for determine if an object is a Purchase with sources
- */
-export const isPurchaseWithSources = isPayloadOfSchemaTypeWithSources<Purchase>(PurchaseSchema)
-export const asPurchaseWithSources = AsObjectFactory.create<WithSources<Purchase>>(isPurchaseWithSources)
-export const asOptionalPurchaseWithSources = AsObjectFactory.createOptional<WithSources<Purchase>>(isPurchaseWithSources)

package/src/Purchase/Schema.ts

@@ -1,6 +0,0 @@
-import { asSchema } from '@xyo-network/payload-model'
-
-import { PaymentsSchema } from '../Schema.ts'
-
-export const PurchaseSchema = asSchema(`${PaymentsSchema}.purchase`, true)
-export type PurchaseSchema = typeof PurchaseSchema

package/src/Purchase/index.ts

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

package/src/Receipt/Payload.ts

@@ -1,39 +0,0 @@
-import { AsObjectFactory } from '@xylabs/sdk-js'
-import type { PayloadWithSources, WithSources } from '@xyo-network/payload-model'
-import {
-  isPayloadOfSchemaType,
-  isPayloadOfSchemaTypeWithSources,
-} from '@xyo-network/payload-model'
-
-import type { SupportedCurrency } from '../Currency.ts'
-import { ReceiptSchema } from './Schema.ts'
-
-export interface ReceiptFields {
-  /**
-   * The amount paid
-   */
-  amount: number
-  /**
-   * The currency of the amount paid
-   */
-  currency: SupportedCurrency
-}
-
-/**
- * A receipt is a record of a payment made
- */
-export type Receipt = PayloadWithSources<ReceiptFields, ReceiptSchema>
-
-/**
- * Identity function for determine if an object is a Receipt
- */
-export const isReceipt = isPayloadOfSchemaType<Receipt>(ReceiptSchema)
-export const asReceipt = AsObjectFactory.create<Receipt>(isReceipt)
-export const asOptionalReceipt = AsObjectFactory.createOptional<Receipt>(isReceipt)
-
-/**
- * Identity function for determine if an object is a Receipt with sources
- */
-export const isReceiptWithSources = isPayloadOfSchemaTypeWithSources<Receipt>(ReceiptSchema)
-export const asReceiptWithSources = AsObjectFactory.create<WithSources<Receipt>>(isReceiptWithSources)
-export const asOptionalReceiptWithSources = AsObjectFactory.createOptional<WithSources<Receipt>>(isReceiptWithSources)

package/src/Receipt/Schema.ts

@@ -1,6 +0,0 @@
-import { asSchema } from '@xyo-network/payload-model'
-
-import { PaymentsSchema } from '../Schema.ts'
-
-export const ReceiptSchema = asSchema(`${PaymentsSchema}.receipt`, true)
-export type ReceiptSchema = typeof ReceiptSchema

package/src/Receipt/index.ts

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

package/src/Schema.ts

@@ -1,4 +0,0 @@
-import { asSchema } from '@xyo-network/payload-model'
-
-export const PaymentsSchema = asSchema('network.xyo.payments', true)
-export type PaymentsSchema = typeof PaymentsSchema

package/src/Subtotal/Diviner/Config.ts

@@ -1,14 +0,0 @@
-// import type { Hash } from '@xylabs/sdk-js'
-import type { DivinerConfig } from '@xyo-network/diviner-model'
-import { asSchema } from '@xyo-network/payload-model'
-
-export const PaymentSubtotalDivinerConfigSchema = asSchema('network.xyo.diviner.payments.subtotal.config', true)
-export type PaymentSubtotalDivinerConfigSchema = typeof PaymentSubtotalDivinerConfigSchema
-
-/**
- * The configuration for the Coupon Subtotal Diviner
- */
-export type PaymentSubtotalDivinerConfig = DivinerConfig<
-  {},
-  PaymentSubtotalDivinerConfigSchema
->

package/src/Subtotal/Diviner/Params.ts

@@ -1,8 +0,0 @@
-import type { DivinerParams } from '@xyo-network/diviner-model'
-import type { AnyConfigSchema } from '@xyo-network/module-model'
-
-import type { PaymentSubtotalDivinerConfig } from './Config.ts'
-
-export type PaymentSubtotalDivinerParams<
-  TConfig extends AnyConfigSchema<PaymentSubtotalDivinerConfig> = AnyConfigSchema<PaymentSubtotalDivinerConfig>,
-> = DivinerParams<TConfig>

package/src/Subtotal/Diviner/Payload.ts

@@ -1,33 +0,0 @@
-import { AsObjectFactory } from '@xylabs/sdk-js'
-import type { PayloadWithSources, WithSources } from '@xyo-network/payload-model'
-import {
-  asSchema,
-  isPayloadOfSchemaType,
-  isPayloadOfSchemaTypeWithSources,
-} from '@xyo-network/payload-model'
-
-import type { AmountFields } from '../../Amount/index.ts'
-
-export const SubtotalSchema = asSchema('network.xyo.payments.subtotal', true)
-export type SubtotalSchema = typeof SubtotalSchema
-
-export interface SubtotalFields extends AmountFields {}
-
-/**
- * The result of a subtotal
- */
-export type Subtotal = PayloadWithSources<SubtotalFields, SubtotalSchema>
-
-/**
- * Identity function for determining if an object is an Subtotal
- */
-export const isSubtotal = isPayloadOfSchemaType<Subtotal>(SubtotalSchema)
-export const asSubtotal = AsObjectFactory.create<Subtotal>(isSubtotal)
-export const asOptionalSubtotal = AsObjectFactory.createOptional<Subtotal>(isSubtotal)
-
-/**
- * Identity function for determining if an object is an Subtotal with sources
- */
-export const isSubtotalWithSources = isPayloadOfSchemaTypeWithSources<Subtotal>(SubtotalSchema)
-export const asSubtotalWithSources = AsObjectFactory.create<WithSources<Subtotal>>(isSubtotalWithSources)
-export const asOptionalSubtotalWithSources = AsObjectFactory.createOptional<WithSources<Subtotal>>(isSubtotalWithSources)

package/src/Subtotal/Diviner/index.ts

@@ -1,3 +0,0 @@
-export * from './Config.ts'
-export * from './Params.ts'
-export * from './Payload.ts'

package/src/Subtotal/index.ts

@@ -1 +0,0 @@
-export * from './Diviner/index.ts'

package/src/Total/Diviner/Config.ts

@@ -1,25 +0,0 @@
-// import type { Hash } from '@xylabs/sdk-js'
-import type { DivinerConfig } from '@xyo-network/diviner-model'
-import type { ModuleIdentifier } from '@xyo-network/module-model'
-import { asSchema } from '@xyo-network/payload-model'
-
-export const PaymentTotalDivinerConfigSchema = asSchema('network.xyo.diviner.payments.total.config', true)
-export type PaymentTotalDivinerConfigSchema = typeof PaymentTotalDivinerConfigSchema
-
-/**
- * The configuration for the Total Diviner
- */
-export type PaymentTotalDivinerConfig = DivinerConfig<
-  {
-    /**
-     * The Diviner that will be used to determine the discount
-     */
-    paymentDiscountDiviner?: ModuleIdentifier
-
-    /**
-     * The Diviner that will be used to determine the subtotal
-     */
-    paymentSubtotalDiviner?: ModuleIdentifier
-  },
-  PaymentTotalDivinerConfigSchema
->

package/src/Total/Diviner/Params.ts

@@ -1,8 +0,0 @@
-import type { DivinerParams } from '@xyo-network/diviner-model'
-import type { AnyConfigSchema } from '@xyo-network/module-model'
-
-import type { PaymentTotalDivinerConfig } from './Config.ts'
-
-export type PaymentTotalDivinerParams<
-  TConfig extends AnyConfigSchema<PaymentTotalDivinerConfig> = AnyConfigSchema<PaymentTotalDivinerConfig>,
-> = DivinerParams<TConfig>

package/src/Total/Diviner/Payload.ts

@@ -1,33 +0,0 @@
-import { AsObjectFactory } from '@xylabs/sdk-js'
-import type { PayloadWithSources, WithSources } from '@xyo-network/payload-model'
-import {
-  asSchema,
-  isPayloadOfSchemaType,
-  isPayloadOfSchemaTypeWithSources,
-} from '@xyo-network/payload-model'
-
-import type { AmountFields } from '../../Amount/index.ts'
-
-export const TotalSchema = asSchema('network.xyo.payments.total', true)
-export type TotalSchema = typeof TotalSchema
-
-export interface TotalFields extends AmountFields {}
-
-/**
- * The result of a total
- */
-export type Total = PayloadWithSources<TotalFields, TotalSchema>
-
-/**
- * Identity function for determining if an object is an Total
- */
-export const isTotal = isPayloadOfSchemaType<Total>(TotalSchema)
-export const asTotal = AsObjectFactory.create<Total>(isTotal)
-export const asOptionalTotal = AsObjectFactory.createOptional<Total>(isTotal)
-
-/**
- * Identity function for determining if an object is an Total with sources
- */
-export const isTotalWithSources = isPayloadOfSchemaTypeWithSources<Total>(TotalSchema)
-export const asTotalWithSources = AsObjectFactory.create<WithSources<Total>>(isTotalWithSources)
-export const asOptionalTotalWithSources = AsObjectFactory.createOptional<WithSources<Total>>(isTotalWithSources)

package/src/Total/Diviner/index.ts

@@ -1,3 +0,0 @@
-export * from './Config.ts'
-export * from './Params.ts'
-export * from './Payload.ts'

package/src/Total/index.ts

@@ -1 +0,0 @@
-export * from './Diviner/index.ts'

package/src/index.ts

@@ -1,11 +0,0 @@
-export * from './Amount/index.ts'
-export * from './Billing/index.ts'
-export * from './Currency.ts'
-export * from './Discount/index.ts'
-export * from './Escrow/index.ts'
-export * from './Invoice/index.ts'
-export * from './Payment/index.ts'
-export * from './Purchase/index.ts'
-export * from './Receipt/index.ts'
-export * from './Subtotal/index.ts'
-export * from './Total/index.ts'