@owlmeans/payment 0.1.18-rc.8 → 0.1.18

package/src/model/consumer.ts

@@ -0,0 +1,294 @@
+import type { JSONSchemaType } from 'ajv'
+import { IdValueSchema, ResourceValueSchema } from '@owlmeans/auth'
+import { schema } from '@owlmeans/entrypoint'
+import { CancellationKindSchema, CancellationStatusSchema, WithdrawalStatusSchema, CountrySchema } from '../consts.js'
+import { AmountCheckoutPolicySchema } from './pricing.js'
+import type { AmountPolicyQuery, AmountPolicyView, BillingProfileView, CancellationBody, CancellationReceipt, ConsumerRightsPolicy, ConsumerRightsPublicView, DeclarationReceipt, PerformanceConsentBody, PerformanceConsentResponse, PerformanceConsentView, PlanPriceList, PlanPricesQuery, PurchaseList, SubscriptionStartBody, SubscriptionStartQuery, SubscriptionStartResponse, SubscriptionStartView, WithdrawalBody, WithdrawalCandidateList, WithdrawalReceipt } from '../types.js'
+import { AcknowledgedSchema, ConsentContextSchema, CurrencySchema, declarationReceiptProperties, EmailSchema, HoneypotSchema, IsoDateSchema, KeySchema, LanguageSchema, MinorSchema, NameSchema, VersionSchema } from './consts.local.js'
+import { CheckoutLimitViewSchema, ConsumerRightsLinksSchema, ConsumerRightsMechanismsSchema, PlanPriceViewSchema, PurchaseViewSchema, WithdrawalCandidateSchema } from './consts.js'
+import { NullableRegionSchema } from './consts.local.js'
+
+export const ConsumerRightsPolicySchema = schema<ConsumerRightsPolicy>({
+  type: 'object',
+  properties: {
+    textVersion: VersionSchema,
+    countries: { type: 'array', items: CountrySchema },
+    unknownCountry: { type: 'string', enum: ['protect', 'ignore'] },
+    withdrawalDays: { type: 'number', minimum: 14, multipleOf: 1 },
+    deadline: {
+      type: 'object',
+      properties: {
+        weekendRollover: { type: 'boolean' },
+        marginDays: { type: 'number', minimum: 0, maximum: 7, multipleOf: 1 },
+      },
+      required: ['weekendRollover', 'marginDays'],
+      additionalProperties: false,
+    },
+    mechanisms: ConsumerRightsMechanismsSchema,
+    currencies: {
+      type: 'object',
+      properties: {
+        eu: { ...CurrencySchema, nullable: true },
+        other: { ...CurrencySchema, nullable: true },
+      },
+      required: [],
+      additionalProperties: false,
+      nullable: true,
+    },
+    languages: { type: 'object', required: [], additionalProperties: LanguageSchema, nullable: true },
+    defaultLanguage: LanguageSchema,
+    links: { type: 'object', required: [], additionalProperties: ConsumerRightsLinksSchema },
+    renewalOpensWindow: { type: 'boolean', nullable: true },
+    startRequestTtlSeconds: { type: 'number', minimum: 1, multipleOf: 1, nullable: true },
+    exemptBusinesses: { type: 'boolean', nullable: true },
+    consentContext: { ...ConsentContextSchema, nullable: true },
+  },
+  required: [
+    'textVersion', 'countries', 'unknownCountry', 'withdrawalDays', 'deadline', 'mechanisms', 'defaultLanguage',
+    'links',
+  ],
+  additionalProperties: false,
+} as unknown as JSONSchemaType<ConsumerRightsPolicy>)
+
+export const BillingProfileViewSchema = schema<BillingProfileView>({
+  type: 'object',
+  properties: {
+    country: { ...CountrySchema, nullable: true },
+    region: NullableRegionSchema,
+    currency: { ...CurrencySchema, nullable: true },
+    locked: { type: 'boolean' },
+    lockedAt: { ...IsoDateSchema, nullable: true },
+    language: LanguageSchema,
+    inScope: { type: 'boolean' },
+  },
+  required: ['country', 'region', 'currency', 'locked', 'language', 'inScope'],
+  additionalProperties: false,
+} as unknown as JSONSchemaType<BillingProfileView>)
+
+export const PurchaseListSchema = schema<PurchaseList>({
+  type: 'object',
+  properties: { purchases: { type: 'array', items: PurchaseViewSchema } },
+  required: ['purchases'],
+  additionalProperties: false,
+})
+
+export const PerformanceConsentViewSchema = schema<PerformanceConsentView>({
+  type: 'object',
+  properties: {
+    required: { type: 'boolean' },
+    region: NullableRegionSchema,
+    country: { ...CountrySchema, nullable: true },
+    language: LanguageSchema,
+    trader: NameSchema,
+    context: { ...ConsentContextSchema, nullable: true },
+    textVersion: VersionSchema,
+    copyVersion: VersionSchema,
+    links: ConsumerRightsLinksSchema,
+    purchases: { type: 'array', items: PurchaseViewSchema },
+    deadline: { ...IsoDateSchema, nullable: true },
+    at: IsoDateSchema,
+  },
+  required: [
+    'required', 'region', 'country', 'language', 'trader', 'textVersion', 'copyVersion', 'links', 'purchases', 'at',
+  ],
+  additionalProperties: false,
+} as unknown as JSONSchemaType<PerformanceConsentView>)
+
+export const PerformanceConsentBodySchema = schema<PerformanceConsentBody>({
+  type: 'object',
+  properties: {
+    purchaseIds: { type: 'array', items: IdValueSchema, maxItems: 100, uniqueItems: true },
+    textVersion: VersionSchema,
+    language: LanguageSchema,
+    acknowledged: AcknowledgedSchema,
+    uiLanguage: { ...LanguageSchema, nullable: true },
+  },
+  required: ['purchaseIds', 'textVersion', 'language', 'acknowledged'],
+  additionalProperties: false,
+} as unknown as JSONSchemaType<PerformanceConsentBody>)
+
+export const PerformanceConsentResponseSchema = schema<PerformanceConsentResponse>({
+  type: 'object',
+  properties: {
+    consentId: IdValueSchema,
+    consentedAt: IsoDateSchema,
+    purchaseIds: { type: 'array', items: IdValueSchema },
+    mailed: { type: 'boolean' },
+  },
+  required: ['consentId', 'consentedAt', 'purchaseIds', 'mailed'],
+  additionalProperties: false,
+})
+
+export const SubscriptionStartQuerySchema = schema<SubscriptionStartQuery>({
+  type: 'object',
+  properties: { planSku: ResourceValueSchema },
+  required: ['planSku'],
+  additionalProperties: false,
+})
+
+export const SubscriptionStartViewSchema = schema<SubscriptionStartView>({
+  type: 'object',
+  properties: {
+    required: { type: 'boolean' },
+    planSku: KeySchema,
+    language: LanguageSchema,
+    trader: NameSchema,
+    context: { ...ConsentContextSchema, nullable: true },
+    textVersion: VersionSchema,
+    copyVersion: VersionSchema,
+    links: ConsumerRightsLinksSchema,
+    region: NullableRegionSchema,
+  },
+  required: ['required', 'planSku', 'language', 'trader', 'textVersion', 'copyVersion', 'links', 'region'],
+  additionalProperties: false,
+} as unknown as JSONSchemaType<SubscriptionStartView>)
+
+export const SubscriptionStartBodySchema = schema<SubscriptionStartBody>({
+  type: 'object',
+  properties: {
+    planSku: ResourceValueSchema,
+    textVersion: VersionSchema,
+    language: LanguageSchema,
+    acknowledged: AcknowledgedSchema,
+  },
+  required: ['planSku', 'textVersion', 'language', 'acknowledged'],
+  additionalProperties: false,
+} as unknown as JSONSchemaType<SubscriptionStartBody>)
+
+export const SubscriptionStartResponseSchema = schema<SubscriptionStartResponse>({
+  type: 'object',
+  properties: {
+    startRequestId: IdValueSchema,
+    requestedAt: IsoDateSchema,
+    expiresAt: IsoDateSchema,
+  },
+  required: ['startRequestId', 'requestedAt', 'expiresAt'],
+  additionalProperties: false,
+})
+
+export const WithdrawalCandidateListSchema = schema<WithdrawalCandidateList>({
+  type: 'object',
+  properties: {
+    candidates: { type: 'array', items: WithdrawalCandidateSchema },
+    language: LanguageSchema,
+    links: ConsumerRightsLinksSchema,
+    name: { ...NameSchema, nullable: true },
+    email: { ...EmailSchema, nullable: true },
+  },
+  required: ['candidates', 'language', 'links'],
+  additionalProperties: false,
+})
+
+export const WithdrawalBodySchema = schema<WithdrawalBody>({
+  type: 'object',
+  properties: {
+    purchaseId: { ...IdValueSchema, nullable: true },
+    contractRef: { ...IdValueSchema, nullable: true },
+    name: NameSchema,
+    email: EmailSchema,
+    language: { ...LanguageSchema, nullable: true },
+    honeypot: { ...HoneypotSchema, nullable: true },
+  },
+  required: ['name', 'email'],
+  additionalProperties: false,
+})
+
+export const DeclarationReceiptSchema = schema<DeclarationReceipt>({
+  type: 'object',
+  properties: declarationReceiptProperties,
+  required: ['declarationId', 'receivedAt', 'content', 'mailed'],
+  additionalProperties: false,
+} as unknown as JSONSchemaType<DeclarationReceipt>)
+
+export const WithdrawalReceiptSchema = schema<WithdrawalReceipt>({
+  type: 'object',
+  properties: {
+    ...declarationReceiptProperties,
+    status: WithdrawalStatusSchema,
+    refundMinor: { ...MinorSchema, nullable: true },
+    currency: { ...CurrencySchema, nullable: true },
+    subscriptionCanceled: { type: 'boolean', nullable: true },
+  },
+  required: ['declarationId', 'receivedAt', 'content', 'mailed', 'status'],
+  additionalProperties: false,
+} as unknown as JSONSchemaType<WithdrawalReceipt>)
+
+export const CancellationBodySchema = schema<CancellationBody>({
+  type: 'object',
+  properties: {
+    kind: CancellationKindSchema,
+    reason: { type: 'string', maxLength: 2000, nullable: true },
+    name: NameSchema,
+    contractRef: { ...IdValueSchema, nullable: true },
+    subscriptionId: { ...IdValueSchema, nullable: true },
+    effective: { type: 'string', enum: ['earliest', 'date'] },
+    date: { type: 'string', pattern: '^\\d{4}-\\d{2}-\\d{2}$', nullable: true },
+    email: EmailSchema,
+    language: { ...LanguageSchema, nullable: true },
+    honeypot: { ...HoneypotSchema, nullable: true },
+  },
+  required: ['kind', 'name', 'effective', 'email'],
+  additionalProperties: false,
+} as unknown as JSONSchemaType<CancellationBody>)
+
+export const CancellationReceiptSchema = schema<CancellationReceipt>({
+  type: 'object',
+  properties: {
+    ...declarationReceiptProperties,
+    status: CancellationStatusSchema,
+    effectiveAt: { ...IsoDateSchema, nullable: true },
+  },
+  required: ['declarationId', 'receivedAt', 'content', 'mailed', 'status'],
+  additionalProperties: false,
+} as unknown as JSONSchemaType<CancellationReceipt>)
+
+export const ConsumerRightsPublicViewSchema = schema<ConsumerRightsPublicView>({
+  type: 'object',
+  properties: {
+    mechanisms: {
+      type: 'object',
+      properties: { withdrawal: { type: 'boolean' }, cancellation: { type: 'boolean' } },
+      required: ['withdrawal', 'cancellation'],
+      additionalProperties: false,
+    },
+    languages: { type: 'array', items: LanguageSchema },
+    links: { type: 'object', required: [], additionalProperties: ConsumerRightsLinksSchema },
+    textVersion: VersionSchema,
+  },
+  required: ['mechanisms', 'languages', 'links', 'textVersion'],
+  additionalProperties: false,
+} as unknown as JSONSchemaType<ConsumerRightsPublicView>)
+
+export const AmountPolicyViewSchema = schema<AmountPolicyView>({
+  type: 'object',
+  properties: {
+    policy: AmountCheckoutPolicySchema,
+    limit: { ...CheckoutLimitViewSchema, nullable: true },
+  },
+  required: ['policy', 'limit'],
+  additionalProperties: false,
+} as unknown as JSONSchemaType<AmountPolicyView>)
+
+export const AmountPolicyQuerySchema = schema<AmountPolicyQuery>({
+  type: 'object',
+  properties: {
+    productSku: ResourceValueSchema,
+    planSku: { ...ResourceValueSchema, nullable: true },
+  },
+  required: ['productSku'],
+  additionalProperties: false,
+} as JSONSchemaType<AmountPolicyQuery>)
+
+export const PlanPriceListSchema = schema<PlanPriceList>({
+  type: 'object',
+  properties: { prices: { type: 'array', items: PlanPriceViewSchema } },
+  required: ['prices'],
+  additionalProperties: false,
+})
+
+export const PlanPricesQuerySchema = schema<PlanPricesQuery>({
+  type: 'object',
+  properties: { productSku: ResourceValueSchema },
+  required: ['productSku'],
+  additionalProperties: false,
+})

package/src/model/estimate.ts

@@ -0,0 +1,73 @@
+import type { JSONSchemaType } from 'ajv'
+import type { PriceEstimate, PriceEstimateBody, PricingPolicy } from '../types.js'
+import { ResourceValueSchema } from '@owlmeans/auth'
+import { schema } from '@owlmeans/entrypoint'
+import { CountrySchema, ConsumerRegionSchema, TaxBehaviorSchema } from '../consts.js'
+import { TaxEstimateSchema } from './consts.local.js'
+
+export const PricingPolicySchema = schema<PricingPolicy>({
+  type: 'object',
+  properties: {
+    tax: {
+      type: 'object',
+      properties: {
+        automatic: { type: 'boolean' },
+        behavior: { ...TaxBehaviorSchema, nullable: true },
+        collectTaxId: { type: 'boolean' },
+        estimate: { type: 'boolean' },
+        estimateTtlSeconds: { type: 'number', minimum: 1, multipleOf: 1, nullable: true },
+      },
+      required: ['automatic', 'collectTaxId', 'estimate'],
+      additionalProperties: false,
+    },
+    currency: {
+      type: 'object',
+      properties: {
+        adaptive: { type: 'boolean', nullable: true },
+        adaptiveFeeRate: { type: 'number', minimum: 0, maximum: 1, nullable: true },
+        estimate: { type: 'boolean' },
+        estimateTtlSeconds: { type: 'number', minimum: 1, multipleOf: 1, nullable: true },
+      },
+      required: ['estimate'],
+      additionalProperties: false,
+    },
+  },
+  required: ['tax', 'currency'],
+  additionalProperties: false,
+} as JSONSchemaType<PricingPolicy>)
+
+export const PriceEstimateBodySchema = schema<PriceEstimateBody>({
+  type: 'object',
+  properties: {
+    planSku: { ...ResourceValueSchema, nullable: true },
+    country: { ...CountrySchema, nullable: true },
+  },
+  required: [],
+  additionalProperties: false,
+} as JSONSchemaType<PriceEstimateBody>)
+
+export const PriceEstimateSchema = schema<PriceEstimate>({
+  type: 'object',
+  properties: {
+    country: { ...CountrySchema, nullable: true },
+    source: { type: 'string', enum: ['request', 'customer', 'profile'], nullable: true },
+    locked: { type: 'boolean', nullable: true },
+    region: { ...ConsumerRegionSchema, nullable: true },
+    currency: { type: 'string', minLength: 3, maxLength: 3 },
+    behavior: TaxBehaviorSchema,
+    tax: TaxEstimateSchema,
+    local: {
+      type: 'object',
+      properties: {
+        currency: { type: 'string', minLength: 3, maxLength: 3 },
+        exchangeRate: { type: 'number', exclusiveMinimum: 0 },
+        fxFeeRate: { type: 'number', minimum: 0, nullable: true },
+      },
+      required: ['currency', 'exchangeRate'],
+      additionalProperties: false,
+      nullable: true,
+    },
+  },
+  required: ['currency', 'behavior', 'tax'],
+  additionalProperties: false,
+} as JSONSchemaType<PriceEstimate>)

package/src/model/index.ts

@@ -1,7 +1,12 @@
 
 export * from './product.js'
 export * from './localization.js'
-export * from './subscription.js'
 export * from './plan.js'
-export * from './utils.js'
 export * from './checkout.js'
+export * from './pricing.js'
+export * from './limit.js'
+export * from './view.js'
+export * from './consts.js'
+export * from './portal.js'
+export * from './estimate.js'
+export * from './consumer.js'

package/src/model/limit.ts

@@ -0,0 +1,36 @@
+import type { JSONSchemaType } from 'ajv'
+import type { LimitDeclaration, PlanCapability, PromoDeclaration } from '../types.js'
+import { DateSchema, PermissionSetSchema } from '@owlmeans/auth'
+import { LimitKindSchema, LimitWindowSchema } from '../consts.js'
+
+/** A promo on a plan declaration. Dates follow the record convention (`DateSchema`). */
+export const PromoDeclarationSchema: JSONSchemaType<PromoDeclaration> = {
+  type: 'object',
+  properties: {
+    until: DateSchema,
+    grandfather: { type: 'boolean', nullable: true },
+  },
+  required: ['until'],
+  additionalProperties: false,
+}
+
+export const LimitDeclarationSchema: JSONSchemaType<LimitDeclaration> = {
+  type: 'object',
+  properties: {
+    kind: LimitKindSchema,
+    limit: { type: 'number', minimum: 0 },
+    window: { ...LimitWindowSchema, nullable: true },
+    unit: { type: 'string', minLength: 1, maxLength: 16, nullable: true },
+    promo: { ...PromoDeclarationSchema, nullable: true },
+  },
+  required: ['kind', 'limit'],
+  additionalProperties: false,
+} as JSONSchemaType<LimitDeclaration>
+
+export const PlanCapabilitySchema: JSONSchemaType<PlanCapability> = {
+  ...PermissionSetSchema,
+  properties: {
+    ...PermissionSetSchema.properties,
+    promo: { ...PromoDeclarationSchema, nullable: true },
+  },
+} as JSONSchemaType<PlanCapability>

package/src/model/plan.ts

@@ -1,22 +1,23 @@
 import type { JSONSchemaType } from 'ajv'
 import type { ProductPlan } from '../types.js'
-import { ResourceValueSchema, PermissionSetSchema, DateSchema } from '@owlmeans/auth'
+import { ResourceValueSchema, DateSchema, IdValueSchema } from '@owlmeans/auth'
 import {
-  PlanDurationSchema, ProductDescriptionSchema, ProductTitleSchema,
-  SubscriptionStatusSchema
+  CheckoutPricingModeSchema, PlanDurationSchema, PlanStatusSchema, ProductDescriptionSchema,
+  ProductTitleSchema
 } from '../consts.js'
-import { LimitConfigSchema } from './utils.js'
+import { LimitDeclarationSchema, PlanCapabilitySchema } from './limit.js'
+import { AmountCheckoutPolicySchema, QuantityCheckoutPolicySchema } from './pricing.js'
+import { PlanWithdrawalComponentSchema } from './consts.js'
 
 export const ProductPlanSchema: JSONSchemaType<ProductPlan> = {
   type: 'object',
   properties: {
     productSku: ResourceValueSchema,
     sku: ResourceValueSchema,
-    status: SubscriptionStatusSchema,
-    payagateAliases: {
-      type: 'object', required: [], nullable: true,
-      additionalProperties: { type: 'string' },
-    },
+    status: PlanStatusSchema,
+    rank: { type: 'number', minimum: 0, multipleOf: 1, nullable: true },
+    free: { type: 'boolean', nullable: true },
+    gateways: { type: 'array', items: IdValueSchema, nullable: true },
     duration: PlanDurationSchema,
     trial: { type: 'number', nullable: true },
     gatedTrial: { type: 'boolean', nullable: true },
@@ -35,12 +36,24 @@ export const ProductPlanSchema: JSONSchemaType<ProductPlan> = {
     createdAt: { ...DateSchema, nullable: true },
     archivedAt: { ...DateSchema, nullable: true },
     deprecatedAt: { ...DateSchema, nullable: true },
-    supsendedAt: { ...DateSchema, nullable: true },
+    suspendedAt: { ...DateSchema, nullable: true },
 
-    capabilities: { type: 'array', items: PermissionSetSchema, nullable: true },
+    capabilities: { type: 'array', items: PlanCapabilitySchema, nullable: true },
     limits: {
       type: 'object', required: [], nullable: true,
-      additionalProperties: LimitConfigSchema
+      additionalProperties: LimitDeclarationSchema
+    },
+    pricingMode: { ...CheckoutPricingModeSchema, nullable: true },
+    amountPolicy: { ...AmountCheckoutPolicySchema, nullable: true },
+    quantityPolicy: { ...QuantityCheckoutPolicySchema, nullable: true },
+    withdrawal: {
+      type: 'object',
+      properties: {
+        components: { type: 'array', items: PlanWithdrawalComponentSchema, minItems: 1 },
+      },
+      required: ['components'],
+      additionalProperties: false,
+      nullable: true,
     },
   },
   required: [

package/src/model/portal.ts

@@ -0,0 +1,25 @@
+import type { JSONSchemaType } from 'ajv'
+import type { PortalLinkBody, PortalLinkResponse } from '../types.js'
+import { ResourceValueSchema } from '@owlmeans/auth'
+import { schema } from '@owlmeans/entrypoint'
+import { PortalFlowSchema } from '../consts.js'
+
+export const PortalLinkBodySchema = schema<PortalLinkBody>({
+  type: 'object',
+  properties: {
+    flow: PortalFlowSchema,
+    planSku: { ...ResourceValueSchema, nullable: true },
+    returnUrl: { type: 'string', minLength: 1, maxLength: 2048, nullable: true },
+  },
+  required: ['flow'],
+  additionalProperties: false,
+} as JSONSchemaType<PortalLinkBody>)
+
+export const PortalLinkResponseSchema = schema<PortalLinkResponse>({
+  type: 'object',
+  properties: {
+    url: { type: 'string', minLength: 1 },
+  },
+  required: ['url'],
+  additionalProperties: false,
+} as JSONSchemaType<PortalLinkResponse>)

package/src/model/pricing.ts

@@ -0,0 +1,34 @@
+import type { JSONSchemaType } from 'ajv'
+import { schema } from '@owlmeans/entrypoint'
+import type { AmountCheckoutPolicy, QuantityCheckoutPolicy } from '../types.js'
+
+export const AmountCheckoutPolicySchema = schema<AmountCheckoutPolicy>({
+  type: 'object',
+  properties: {
+    currency: { type: 'string', minLength: 3, maxLength: 3 },
+    minimumMinor: { type: 'number', minimum: 0, multipleOf: 1 },
+    maximumMinor: { type: 'number', minimum: 0, multipleOf: 1 },
+    defaultMinor: { type: 'number', minimum: 0, multipleOf: 1 },
+    presetsMinor: {
+      type: 'array', items: { type: 'number', minimum: 0, multipleOf: 1 }, uniqueItems: true,
+    },
+    fixedMinor: { type: 'number', minimum: 0, multipleOf: 1 },
+    rateBps: { type: 'number', minimum: 0, maximum: 9999, multipleOf: 1 },
+  },
+  required: [
+    'currency', 'minimumMinor', 'maximumMinor', 'defaultMinor', 'presetsMinor',
+    'fixedMinor', 'rateBps',
+  ],
+  additionalProperties: false,
+} as JSONSchemaType<AmountCheckoutPolicy>)
+
+export const QuantityCheckoutPolicySchema = schema<QuantityCheckoutPolicy>({
+  type: 'object',
+  properties: {
+    minimum: { type: 'number', minimum: 1, multipleOf: 1 },
+    maximum: { type: 'number', minimum: 1, multipleOf: 1 },
+    default: { type: 'number', minimum: 1, multipleOf: 1 },
+  },
+  required: ['minimum', 'maximum', 'default'],
+  additionalProperties: false,
+} as JSONSchemaType<QuantityCheckoutPolicy>)

package/src/model/view.ts

@@ -0,0 +1,17 @@
+import type { JSONSchemaType } from 'ajv'
+import type { EntitlementView } from '../types.js'
+import { schema } from '@owlmeans/entrypoint'
+import { IsoDateSchema } from './consts.local.js'
+import { CapabilityViewSchema, EntitlementPlanViewSchema, LimitViewSchema } from './consts.js'
+
+export const EntitlementViewSchema = schema<EntitlementView>({
+  type: 'object',
+  properties: {
+    plan: EntitlementPlanViewSchema,
+    capabilities: { type: 'array', items: CapabilityViewSchema },
+    limits: { type: 'array', items: LimitViewSchema },
+    at: IsoDateSchema,
+  },
+  required: ['plan', 'capabilities', 'limits', 'at'],
+  additionalProperties: false,
+} as JSONSchemaType<EntitlementView>)

package/src/pricing/types.ts

@@ -0,0 +1,13 @@
+import type { AmountCheckoutPolicy, QuantityCheckoutPolicy } from '../types.js'
+
+/** The checkout policies' invariants and the charge an amount grosses up to. */
+export interface CheckoutPricingHelper {
+  /** @throws PaymentError (`checkout-policy:amount`, `checkout-policy:presets`) for an invalid policy. */
+  assertAmountCheckoutPolicy: (policy: AmountCheckoutPolicy) => AmountCheckoutPolicy
+  /** @throws PaymentError (`checkout-policy:quantity`) for an invalid policy. */
+  assertQuantityCheckoutPolicy: (policy: QuantityCheckoutPolicy) => QuantityCheckoutPolicy
+  /** @throws PaymentError (`checkout-amount:*`) for an amount the policy does not allow. */
+  assertCheckoutAmount: (policy: AmountCheckoutPolicy, amountMinor: number) => number
+  /** Gross up a net credit value so the configured adjustment remains outside the credit grant. */
+  chargeAmountMinor: (amountMinor: number, policy: Pick<AmountCheckoutPolicy, 'fixedMinor' | 'rateBps'>) => number
+}