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

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

@@ -0,0 +1,25 @@
+import {
+  type FixedAmountCoupon, type FixedPercentageCoupon, isFixedAmountCoupon, isFixedAmountCouponWithMeta, isFixedAmountCouponWithSources, isFixedPercentageCoupon,
+  isFixedPercentageCouponWithMeta,
+  isFixedPercentageCouponWithSources,
+} from './Coupons/index.ts'
+
+/**
+ * The result of a discount
+ */
+export type Coupon = FixedAmountCoupon | FixedPercentageCoupon
+
+/**
+ * Identity function for determining if an object is an Coupon
+ */
+export const isCoupon = (x?: unknown | null) => isFixedAmountCoupon(x) || isFixedPercentageCoupon(x)
+
+/**
+ * Identity function for determining if an object is an Coupon with sources
+ */
+export const isCouponWithSources = (x?: unknown | null) => isFixedAmountCouponWithSources(x) || isFixedPercentageCouponWithSources(x)
+
+/**
+ * Identity function for determining if an object is an Coupon with meta
+ */
+export const isCouponWithMeta = (x?: unknown | null) => isFixedAmountCouponWithMeta(x) || isFixedPercentageCouponWithMeta(x)

package/src/Discount/Payload/Coupon/Schema.ts

@@ -0,0 +1,2 @@
+export const CouponSchema = 'network.xyo.payments.coupon' as const
+export type CouponSchema = typeof CouponSchema

package/src/Discount/Payload/Coupon/index.ts

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

package/src/Discount/Payload/Coupon/types/CouponFields.ts

@@ -0,0 +1,11 @@
+import type { DurationFields } from '@xyo-network/xns-record-payload-plugins'
+
+/**
+ * The fields that are common across all coupons
+ */
+export interface CouponFields extends DurationFields {
+  /**
+   * Whether or not this discount can be stacked with other discounts
+   */
+  stackable?: boolean
+}

package/src/Discount/Payload/Coupon/types/index.ts

@@ -0,0 +1,2 @@
+export * from './CouponFields.ts'
+export * from './isStackable.ts'

package/src/Discount/Payload/Coupon/types/isStackable.ts

@@ -0,0 +1,6 @@
+import type { CouponFields } from './CouponFields.ts'
+
+/**
+ * Identity function for determining if coupon is stackable
+ */
+export const isStackable = (x?: unknown | null) => (x as CouponFields ?? { stackable: false })?.stackable

package/src/Discount/Payload/Discount.ts

@@ -0,0 +1,33 @@
+import type { PayloadWithSources } from '@xyo-network/payload-model'
+import {
+  isPayloadOfSchemaType,
+  isPayloadOfSchemaTypeWithMeta,
+  isPayloadOfSchemaTypeWithSources,
+} from '@xyo-network/payload-model'
+
+import type { AmountFields } from '../../Amount/index.ts'
+
+export const DiscountSchema = 'network.xyo.payments.discount' as const
+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 const isDiscount = isPayloadOfSchemaType<Discount>(DiscountSchema)
+
+/**
+ * Identity function for determining if an object is an Discount with sources
+ */
+export const isDiscountWithSources = isPayloadOfSchemaTypeWithSources<Discount>(DiscountSchema)
+
+/**
+ * Identity function for determining if an object is an Discount with meta
+ */
+export const isDiscountWithMeta = isPayloadOfSchemaTypeWithMeta<Discount>(DiscountSchema)

package/src/Discount/Payload/NoDiscount.ts

@@ -0,0 +1,8 @@
+import type { Discount } from './Discount.ts'
+import { DiscountSchema } from './Discount.ts'
+
+export const NO_DISCOUNT: Discount = {
+  schema: DiscountSchema,
+  amount: 0,
+  currency: 'USD',
+}

package/src/Discount/Payload/index.ts

@@ -0,0 +1,3 @@
+export * from './Coupon/index.ts'
+export * from './Discount.ts'
+export * from './NoDiscount.ts'

package/src/Discount/index.ts

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

package/src/Invoice/Invoice.ts

@@ -0,0 +1,19 @@
+import type { Discount } from '../Discount/index.ts'
+import type { Payment } from '../Payment/index.ts'
+import type { Subtotal } from '../Subtotal/index.ts'
+import type { Total } from '../Total/index.ts'
+
+/**
+ * A tuple containing the subtotal, total, and payment for an invoice.
+ */
+export type StandardInvoice = [Subtotal, Total, Payment]
+
+/**
+ * A tuple containing the subtotal, total, payment, and discount for an invoice.
+ */
+export type DiscountedInvoice = [...StandardInvoice, Discount]
+
+/**
+ * An invoice.
+ */
+export type Invoice = StandardInvoice | DiscountedInvoice

package/src/Invoice/index.ts

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

package/src/Subtotal/Diviner/Config.ts

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

package/src/Subtotal/Diviner/Params.ts

@@ -0,0 +1,8 @@
+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

@@ -0,0 +1,33 @@
+import type { PayloadWithSources } from '@xyo-network/payload-model'
+import {
+  isPayloadOfSchemaType,
+  isPayloadOfSchemaTypeWithMeta,
+  isPayloadOfSchemaTypeWithSources,
+} from '@xyo-network/payload-model'
+
+import type { AmountFields } from '../../Amount/index.ts'
+
+export const SubtotalSchema = 'network.xyo.payments.subtotal' as const
+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)
+
+/**
+ * Identity function for determining if an object is an Subtotal with sources
+ */
+export const isSubtotalWithSources = isPayloadOfSchemaTypeWithSources<Subtotal>(SubtotalSchema)
+
+/**
+ * Identity function for determining if an object is an Subtotal with meta
+ */
+export const isSubtotalWithMeta = isPayloadOfSchemaTypeWithMeta<Subtotal>(SubtotalSchema)

package/src/Subtotal/Diviner/index.ts

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

package/src/Subtotal/index.ts

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

package/src/Total/Diviner/Config.ts

@@ -0,0 +1,24 @@
+// import type { Hash } from '@xylabs/hex'
+import type { DivinerConfig } from '@xyo-network/diviner-model'
+import type { ModuleIdentifier } from '@xyo-network/module-model'
+
+export const PaymentTotalDivinerConfigSchema = 'network.xyo.diviner.payments.total.config'
+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

@@ -0,0 +1,8 @@
+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

@@ -0,0 +1,33 @@
+import type { PayloadWithSources } from '@xyo-network/payload-model'
+import {
+  isPayloadOfSchemaType,
+  isPayloadOfSchemaTypeWithMeta,
+  isPayloadOfSchemaTypeWithSources,
+} from '@xyo-network/payload-model'
+
+import type { AmountFields } from '../../Amount/index.ts'
+
+export const TotalSchema = 'network.xyo.payments.total' as const
+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)
+
+/**
+ * Identity function for determining if an object is an Total with sources
+ */
+export const isTotalWithSources = isPayloadOfSchemaTypeWithSources<Total>(TotalSchema)
+
+/**
+ * Identity function for determining if an object is an Total with meta
+ */
+export const isTotalWithMeta = isPayloadOfSchemaTypeWithMeta<Total>(TotalSchema)

package/src/Total/Diviner/index.ts

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

package/src/Total/index.ts

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

package/src/index.ts

@@ -1,6 +1,11 @@
+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'