@forklaunch/interfaces-billing 0.1.0 → 0.1.1

package/{interfaces → lib/eject/interfaces}/billingPortal.service.interface.ts

@@ -1,22 +1,4 @@
-import { IdDto, RecordTimingDto } from '@forklaunch/common';
-
-export type CreateBillingPortalDto = {
-  customerId: string;
-  uri: string;
-  expiresAt: Date;
-  extraFields?: unknown;
-};
-export type UpdateBillingPortalDto = IdDto & Partial<CreateBillingPortalDto>;
-export type BillingPortalDto = IdDto &
-  CreateBillingPortalDto &
-  Partial<RecordTimingDto>;
-
-export type BillingPortalServiceParameters = {
-  CreateBillingPortalDto: CreateBillingPortalDto;
-  UpdateBillingPortalDto: UpdateBillingPortalDto;
-  BillingPortalDto: BillingPortalDto;
-  IdDto: IdDto;
-};
+import { BillingPortalServiceParameters } from '../types/billingPortal.service.types';
 
 export interface BillingPortalService<
   Params extends BillingPortalServiceParameters = BillingPortalServiceParameters

package/lib/eject/interfaces/checkoutSession.service.interface.ts

@@ -0,0 +1,19 @@
+import { CheckoutSessionServiceParameters } from '../types/checkoutSession.service.types';
+export interface CheckoutSessionService<
+  PaymentMethodEnum,
+  Params extends
+    CheckoutSessionServiceParameters<PaymentMethodEnum> = CheckoutSessionServiceParameters<PaymentMethodEnum>
+> {
+  // for generating external links
+  // store in cache, for permissions
+  createCheckoutSession: (
+    checkoutSessionDto: Params['CreateCheckoutSessionDto']
+  ) => Promise<Params['CheckoutSessionDto']>;
+  getCheckoutSession: (
+    idDto: Params['IdDto']
+  ) => Promise<Params['CheckoutSessionDto']>;
+  expireCheckoutSession: (idDto: Params['IdDto']) => Promise<void>;
+
+  handleCheckoutSuccess: (idDto: Params['IdDto']) => Promise<void>;
+  handleCheckoutFailure: (idDto: Params['IdDto']) => Promise<void>;
+}

package/lib/eject/interfaces/index.ts

@@ -0,0 +1,5 @@
+export * from './billingPortal.service.interface';
+export * from './checkoutSession.service.interface';
+export * from './paymentLink.service.interface';
+export * from './plan.service.interface';
+export * from './subscription.service.interface';

package/lib/eject/interfaces/interfaces/billingPortal.service.interface.ts

@@ -0,0 +1,18 @@
+import { BillingPortalServiceParameters } from '../types/billingPortal.service.types';
+
+export interface BillingPortalService<
+  Params extends BillingPortalServiceParameters = BillingPortalServiceParameters
+> {
+  // for generating external links
+  // store in cache, for permissions
+  createBillingPortalSession: (
+    billingPortalDto: Params['CreateBillingPortalDto']
+  ) => Promise<Params['BillingPortalDto']>;
+  getBillingPortalSession: (
+    idDto: Params['IdDto']
+  ) => Promise<Params['BillingPortalDto']>;
+  updateBillingPortalSession: (
+    billingPortalDto: Params['UpdateBillingPortalDto']
+  ) => Promise<Params['BillingPortalDto']>;
+  expireBillingPortalSession: (idDto: Params['IdDto']) => Promise<void>;
+}

package/lib/eject/interfaces/interfaces/checkoutSession.service.interface.ts

@@ -0,0 +1,19 @@
+import { CheckoutSessionServiceParameters } from '../types/checkoutSession.service.types';
+export interface CheckoutSessionService<
+  PaymentMethodEnum,
+  Params extends
+    CheckoutSessionServiceParameters<PaymentMethodEnum> = CheckoutSessionServiceParameters<PaymentMethodEnum>
+> {
+  // for generating external links
+  // store in cache, for permissions
+  createCheckoutSession: (
+    checkoutSessionDto: Params['CreateCheckoutSessionDto']
+  ) => Promise<Params['CheckoutSessionDto']>;
+  getCheckoutSession: (
+    idDto: Params['IdDto']
+  ) => Promise<Params['CheckoutSessionDto']>;
+  expireCheckoutSession: (idDto: Params['IdDto']) => Promise<void>;
+
+  handleCheckoutSuccess: (idDto: Params['IdDto']) => Promise<void>;
+  handleCheckoutFailure: (idDto: Params['IdDto']) => Promise<void>;
+}

package/lib/eject/interfaces/interfaces/index.ts

@@ -0,0 +1,5 @@
+export * from './billingPortal.service.interface';
+export * from './checkoutSession.service.interface';
+export * from './paymentLink.service.interface';
+export * from './plan.service.interface';
+export * from './subscription.service.interface';

package/{interfaces → lib/eject/interfaces/interfaces}/paymentLink.service.interface.ts

@@ -1,26 +1,4 @@
-import { IdDto, IdsDto, RecordTimingDto } from '@forklaunch/common';
-
-export type CreatePaymentLinkDto<CurrencyEnum> = {
-  amount: number;
-  currency: CurrencyEnum[keyof CurrencyEnum];
-  metadata?: unknown;
-  successRedirectUri: string;
-  cancelRedirectUri: string;
-  extraFields?: unknown;
-};
-export type UpdatePaymentLinkDto<CurrencyEnum> = IdDto &
-  Partial<CreatePaymentLinkDto<CurrencyEnum>>;
-export type PaymentLinkDto<CurrencyEnum> = IdDto &
-  CreatePaymentLinkDto<CurrencyEnum> &
-  Partial<RecordTimingDto>;
-
-export type PaymentLinkServiceParameters<CurrencyEnum> = {
-  CreatePaymentLinkDto: CreatePaymentLinkDto<CurrencyEnum>;
-  UpdatePaymentLinkDto: UpdatePaymentLinkDto<CurrencyEnum>;
-  PaymentLinkDto: PaymentLinkDto<CurrencyEnum>;
-  IdDto: IdDto;
-  IdsDto: IdsDto;
-};
+import { PaymentLinkServiceParameters } from '../types/paymentLink.service.types';
 
 export interface PaymentLinkService<
   CurrencyEnum,

package/lib/eject/interfaces/interfaces/plan.service.interface.ts

@@ -0,0 +1,29 @@
+import { EntityManager } from '@mikro-orm/core';
+import { PlanServiceParameters } from '../types/plan.service.types';
+
+export interface PlanService<
+  PlanCadenceEnum,
+  BillingProviderEnum,
+  Params extends PlanServiceParameters<
+    PlanCadenceEnum,
+    BillingProviderEnum
+  > = PlanServiceParameters<PlanCadenceEnum, BillingProviderEnum>
+> {
+  createPlan: (
+    planDto: Params['CreatePlanDto'],
+    em?: EntityManager
+  ) => Promise<Params['PlanDto']>;
+  getPlan: (
+    idDto: Params['IdDto'],
+    em?: EntityManager
+  ) => Promise<Params['PlanDto']>;
+  updatePlan: (
+    planDto: Params['UpdatePlanDto'],
+    em?: EntityManager
+  ) => Promise<Params['PlanDto']>;
+  deletePlan: (idDto: Params['IdDto'], em?: EntityManager) => Promise<void>;
+  listPlans: (
+    idsDto?: Params['IdsDto'],
+    em?: EntityManager
+  ) => Promise<Params['PlanDto'][]>;
+}

package/{interfaces → lib/eject/interfaces/interfaces}/subscription.service.interface.ts

@@ -1,32 +1,5 @@
-import { IdDto, IdsDto, RecordTimingDto } from '@forklaunch/common';
 import { EntityManager } from '@mikro-orm/core';
-
-export type CreateSubscriptionDto<PartyType, BillingProviderType> = {
-  partyId: string;
-  partyType: PartyType[keyof PartyType];
-  description?: string;
-  active: boolean;
-  productId: string;
-  extraFields?: unknown;
-  externalId: string;
-  billingProvider?: BillingProviderType[keyof BillingProviderType];
-  startDate: Date;
-  endDate: Date;
-  status: string;
-};
-export type UpdateSubscriptionDto<PartyType, BillingProviderType> = IdDto &
-  Partial<CreateSubscriptionDto<PartyType, BillingProviderType>>;
-export type SubscriptionDto<PartyType, BillingProviderType> = IdDto &
-  CreateSubscriptionDto<PartyType, BillingProviderType> &
-  Partial<RecordTimingDto>;
-
-export type SubscriptionServiceParameters<PartyType, BillingProviderType> = {
-  CreateSubscriptionDto: CreateSubscriptionDto<PartyType, BillingProviderType>;
-  UpdateSubscriptionDto: UpdateSubscriptionDto<PartyType, BillingProviderType>;
-  SubscriptionDto: SubscriptionDto<PartyType, BillingProviderType>;
-  IdDto: IdDto;
-  IdsDto: IdsDto;
-};
+import { SubscriptionServiceParameters } from '../types/subscription.service.types';
 
 export interface SubscriptionService<
   PartyType,

package/lib/eject/interfaces/paymentLink.service.interface.ts

@@ -0,0 +1,27 @@
+import { PaymentLinkServiceParameters } from '../types/paymentLink.service.types';
+
+export interface PaymentLinkService<
+  CurrencyEnum,
+  Params extends
+    PaymentLinkServiceParameters<CurrencyEnum> = PaymentLinkServiceParameters<CurrencyEnum>
+> {
+  // for one off products that are not part of a subscription
+  // think about how permissions work on payment links, but these should be ephemeral
+  // store in cache, for permissions
+  createPaymentLink: (
+    paymentLink: Params['CreatePaymentLinkDto']
+  ) => Promise<Params['PaymentLinkDto']>;
+  updatePaymentLink: (
+    paymentLink: Params['UpdatePaymentLinkDto']
+  ) => Promise<Params['PaymentLinkDto']>;
+  getPaymentLink: (idDto: Params['IdDto']) => Promise<Params['PaymentLinkDto']>;
+  expirePaymentLink: (idDto: Params['IdDto']) => Promise<void>;
+
+  handlePaymentSuccess: (idDto: Params['IdDto']) => Promise<void>;
+  handlePaymentFailure: (idDto: Params['IdDto']) => Promise<void>;
+
+  // admin API, make sure that permissions are correct here
+  listPaymentLinks: (
+    idsDto?: Params['IdsDto']
+  ) => Promise<Params['PaymentLinkDto'][]>;
+}

package/lib/eject/interfaces/plan.service.interface.ts

@@ -0,0 +1,29 @@
+import { EntityManager } from '@mikro-orm/core';
+import { PlanServiceParameters } from '../types/plan.service.types';
+
+export interface PlanService<
+  PlanCadenceEnum,
+  BillingProviderEnum,
+  Params extends PlanServiceParameters<
+    PlanCadenceEnum,
+    BillingProviderEnum
+  > = PlanServiceParameters<PlanCadenceEnum, BillingProviderEnum>
+> {
+  createPlan: (
+    planDto: Params['CreatePlanDto'],
+    em?: EntityManager
+  ) => Promise<Params['PlanDto']>;
+  getPlan: (
+    idDto: Params['IdDto'],
+    em?: EntityManager
+  ) => Promise<Params['PlanDto']>;
+  updatePlan: (
+    planDto: Params['UpdatePlanDto'],
+    em?: EntityManager
+  ) => Promise<Params['PlanDto']>;
+  deletePlan: (idDto: Params['IdDto'], em?: EntityManager) => Promise<void>;
+  listPlans: (
+    idsDto?: Params['IdsDto'],
+    em?: EntityManager
+  ) => Promise<Params['PlanDto'][]>;
+}

package/lib/eject/interfaces/subscription.service.interface.ts

@@ -0,0 +1,49 @@
+import { EntityManager } from '@mikro-orm/core';
+import { SubscriptionServiceParameters } from '../types/subscription.service.types';
+
+export interface SubscriptionService<
+  PartyType,
+  BillingProviderType,
+  Params extends SubscriptionServiceParameters<
+    PartyType,
+    BillingProviderType
+  > = SubscriptionServiceParameters<PartyType, BillingProviderType>
+> {
+  // store this in a table
+  createSubscription: (
+    subscriptionDto: Params['CreateSubscriptionDto'],
+    em?: EntityManager
+  ) => Promise<Params['SubscriptionDto']>;
+  getSubscription: (
+    idDto: Params['IdDto'],
+    em?: EntityManager
+  ) => Promise<Params['SubscriptionDto']>;
+  getUserSubscription: (
+    idDto: Params['IdDto'],
+    em?: EntityManager
+  ) => Promise<Params['SubscriptionDto']>;
+  getOrganizationSubscription: (
+    idDto: Params['IdDto'],
+    em?: EntityManager
+  ) => Promise<Params['SubscriptionDto']>;
+  updateSubscription: (
+    subscriptionDto: Params['UpdateSubscriptionDto'],
+    em?: EntityManager
+  ) => Promise<Params['SubscriptionDto']>;
+  deleteSubscription: (
+    id: Params['IdDto'],
+    em?: EntityManager
+  ) => Promise<void>;
+  listSubscriptions: (
+    idsDto: Params['IdsDto'],
+    em?: EntityManager
+  ) => Promise<Params['SubscriptionDto'][]>;
+  cancelSubscription: (
+    idDto: Params['IdDto'],
+    em?: EntityManager
+  ) => Promise<void>;
+  resumeSubscription: (
+    idDto: Params['IdDto'],
+    em?: EntityManager
+  ) => Promise<void>;
+}

package/lib/eject/types/billingPortal.service.types.ts

@@ -0,0 +1,19 @@
+import { IdDto, RecordTimingDto } from '@forklaunch/common';
+
+export type CreateBillingPortalDto = {
+  customerId: string;
+  uri: string;
+  expiresAt: Date;
+  extraFields?: unknown;
+};
+export type UpdateBillingPortalDto = IdDto & Partial<CreateBillingPortalDto>;
+export type BillingPortalDto = IdDto &
+  CreateBillingPortalDto &
+  Partial<RecordTimingDto>;
+
+export type BillingPortalServiceParameters = {
+  CreateBillingPortalDto: CreateBillingPortalDto;
+  UpdateBillingPortalDto: UpdateBillingPortalDto;
+  BillingPortalDto: BillingPortalDto;
+  IdDto: IdDto;
+};

package/{interfaces/checkoutSession.service.interface.ts → lib/eject/types/checkoutSession.service.types.ts}

@@ -19,22 +19,3 @@ export type CheckoutSessionServiceParameters<PaymentMethodEnum> = {
   CheckoutSessionDto: CheckoutSessionDto<PaymentMethodEnum>;
   IdDto: IdDto;
 };
-
-export interface CheckoutSessionService<
-  PaymentMethodEnum,
-  Params extends
-    CheckoutSessionServiceParameters<PaymentMethodEnum> = CheckoutSessionServiceParameters<PaymentMethodEnum>
-> {
-  // for generating external links
-  // store in cache, for permissions
-  createCheckoutSession: (
-    checkoutSessionDto: Params['CreateCheckoutSessionDto']
-  ) => Promise<Params['CheckoutSessionDto']>;
-  getCheckoutSession: (
-    idDto: Params['IdDto']
-  ) => Promise<Params['CheckoutSessionDto']>;
-  expireCheckoutSession: (idDto: Params['IdDto']) => Promise<void>;
-
-  handleCheckoutSuccess: (idDto: Params['IdDto']) => Promise<void>;
-  handleCheckoutFailure: (idDto: Params['IdDto']) => Promise<void>;
-}

package/lib/eject/types/index.ts

@@ -0,0 +1,5 @@
+export * from './billingPortal.service.types';
+export * from './checkoutSession.service.types';
+export * from './paymentLink.service.types';
+export * from './plan.service.types';
+export * from './subscription.service.types';

package/lib/eject/types/paymentLink.service.types.ts

@@ -0,0 +1,23 @@
+import { IdDto, IdsDto, RecordTimingDto } from '@forklaunch/common';
+
+export type CreatePaymentLinkDto<CurrencyEnum> = {
+  amount: number;
+  currency: CurrencyEnum[keyof CurrencyEnum];
+  metadata?: unknown;
+  successRedirectUri: string;
+  cancelRedirectUri: string;
+  extraFields?: unknown;
+};
+export type UpdatePaymentLinkDto<CurrencyEnum> = IdDto &
+  Partial<CreatePaymentLinkDto<CurrencyEnum>>;
+export type PaymentLinkDto<CurrencyEnum> = IdDto &
+  CreatePaymentLinkDto<CurrencyEnum> &
+  Partial<RecordTimingDto>;
+
+export type PaymentLinkServiceParameters<CurrencyEnum> = {
+  CreatePaymentLinkDto: CreatePaymentLinkDto<CurrencyEnum>;
+  UpdatePaymentLinkDto: UpdatePaymentLinkDto<CurrencyEnum>;
+  PaymentLinkDto: PaymentLinkDto<CurrencyEnum>;
+  IdDto: IdDto;
+  IdsDto: IdsDto;
+};

package/{interfaces/plan.service.interface.ts → lib/eject/types/plan.service.types.ts}

@@ -1,5 +1,4 @@
 import { IdDto, IdsDto, RecordTimingDto } from '@forklaunch/common';
-import { EntityManager } from '@mikro-orm/core';
 
 export type CreatePlanDto<PlanCadenceEnum, BillingProviderEnum> = {
   active: boolean;
@@ -25,30 +24,3 @@ export type PlanServiceParameters<PlanCadenceEnum, BillingProviderEnum> = {
   IdDto: IdDto;
   IdsDto: IdsDto;
 };
-
-export interface PlanService<
-  PlanCadenceEnum,
-  BillingProviderEnum,
-  Params extends PlanServiceParameters<
-    PlanCadenceEnum,
-    BillingProviderEnum
-  > = PlanServiceParameters<PlanCadenceEnum, BillingProviderEnum>
-> {
-  createPlan: (
-    planDto: Params['CreatePlanDto'],
-    em?: EntityManager
-  ) => Promise<Params['PlanDto']>;
-  getPlan: (
-    idDto: Params['IdDto'],
-    em?: EntityManager
-  ) => Promise<Params['PlanDto']>;
-  updatePlan: (
-    planDto: Params['UpdatePlanDto'],
-    em?: EntityManager
-  ) => Promise<Params['PlanDto']>;
-  deletePlan: (idDto: Params['IdDto'], em?: EntityManager) => Promise<void>;
-  listPlans: (
-    idsDto?: Params['IdsDto'],
-    em?: EntityManager
-  ) => Promise<Params['PlanDto'][]>;
-}

package/lib/eject/types/subscription.service.types.ts

@@ -0,0 +1,28 @@
+import { IdDto, IdsDto, RecordTimingDto } from '@forklaunch/common';
+
+export type CreateSubscriptionDto<PartyType, BillingProviderType> = {
+  partyId: string;
+  partyType: PartyType[keyof PartyType];
+  description?: string;
+  active: boolean;
+  productId: string;
+  extraFields?: unknown;
+  externalId: string;
+  billingProvider?: BillingProviderType[keyof BillingProviderType];
+  startDate: Date;
+  endDate: Date;
+  status: string;
+};
+export type UpdateSubscriptionDto<PartyType, BillingProviderType> = IdDto &
+  Partial<CreateSubscriptionDto<PartyType, BillingProviderType>>;
+export type SubscriptionDto<PartyType, BillingProviderType> = IdDto &
+  CreateSubscriptionDto<PartyType, BillingProviderType> &
+  Partial<RecordTimingDto>;
+
+export type SubscriptionServiceParameters<PartyType, BillingProviderType> = {
+  CreateSubscriptionDto: CreateSubscriptionDto<PartyType, BillingProviderType>;
+  UpdateSubscriptionDto: UpdateSubscriptionDto<PartyType, BillingProviderType>;
+  SubscriptionDto: SubscriptionDto<PartyType, BillingProviderType>;
+  IdDto: IdDto;
+  IdsDto: IdsDto;
+};

package/lib/eject/types/types/billingPortal.service.types.ts

@@ -0,0 +1,19 @@
+import { IdDto, RecordTimingDto } from '@forklaunch/common';
+
+export type CreateBillingPortalDto = {
+  customerId: string;
+  uri: string;
+  expiresAt: Date;
+  extraFields?: unknown;
+};
+export type UpdateBillingPortalDto = IdDto & Partial<CreateBillingPortalDto>;
+export type BillingPortalDto = IdDto &
+  CreateBillingPortalDto &
+  Partial<RecordTimingDto>;
+
+export type BillingPortalServiceParameters = {
+  CreateBillingPortalDto: CreateBillingPortalDto;
+  UpdateBillingPortalDto: UpdateBillingPortalDto;
+  BillingPortalDto: BillingPortalDto;
+  IdDto: IdDto;
+};

package/lib/eject/types/types/checkoutSession.service.types.ts

@@ -0,0 +1,21 @@
+import { IdDto, RecordTimingDto } from '@forklaunch/common';
+
+export type CreateCheckoutSessionDto<PaymentMethodEnum> = {
+  customerId: string;
+  paymentMethods: PaymentMethodEnum[keyof PaymentMethodEnum][];
+  metadata?: unknown;
+  successRedirectUri: string;
+  cancelRedirectUri: string;
+  extraFields?: unknown;
+};
+export type UpdateCheckoutSessionDto<PaymentMethodEnum> = IdDto &
+  Partial<CreateCheckoutSessionDto<PaymentMethodEnum>>;
+export type CheckoutSessionDto<PaymentMethodEnum> = IdDto &
+  CreateCheckoutSessionDto<PaymentMethodEnum> &
+  Partial<RecordTimingDto>;
+
+export type CheckoutSessionServiceParameters<PaymentMethodEnum> = {
+  CreateCheckoutSessionDto: CreateCheckoutSessionDto<PaymentMethodEnum>;
+  CheckoutSessionDto: CheckoutSessionDto<PaymentMethodEnum>;
+  IdDto: IdDto;
+};

package/lib/eject/types/types/index.ts

@@ -0,0 +1,5 @@
+export * from './billingPortal.service.types';
+export * from './checkoutSession.service.types';
+export * from './paymentLink.service.types';
+export * from './plan.service.types';
+export * from './subscription.service.types';

package/lib/eject/types/types/paymentLink.service.types.ts

@@ -0,0 +1,23 @@
+import { IdDto, IdsDto, RecordTimingDto } from '@forklaunch/common';
+
+export type CreatePaymentLinkDto<CurrencyEnum> = {
+  amount: number;
+  currency: CurrencyEnum[keyof CurrencyEnum];
+  metadata?: unknown;
+  successRedirectUri: string;
+  cancelRedirectUri: string;
+  extraFields?: unknown;
+};
+export type UpdatePaymentLinkDto<CurrencyEnum> = IdDto &
+  Partial<CreatePaymentLinkDto<CurrencyEnum>>;
+export type PaymentLinkDto<CurrencyEnum> = IdDto &
+  CreatePaymentLinkDto<CurrencyEnum> &
+  Partial<RecordTimingDto>;
+
+export type PaymentLinkServiceParameters<CurrencyEnum> = {
+  CreatePaymentLinkDto: CreatePaymentLinkDto<CurrencyEnum>;
+  UpdatePaymentLinkDto: UpdatePaymentLinkDto<CurrencyEnum>;
+  PaymentLinkDto: PaymentLinkDto<CurrencyEnum>;
+  IdDto: IdDto;
+  IdsDto: IdsDto;
+};

package/lib/eject/types/types/plan.service.types.ts

@@ -0,0 +1,26 @@
+import { IdDto, IdsDto, RecordTimingDto } from '@forklaunch/common';
+
+export type CreatePlanDto<PlanCadenceEnum, BillingProviderEnum> = {
+  active: boolean;
+  name: string;
+  description?: string;
+  price: number;
+  cadence: PlanCadenceEnum[keyof PlanCadenceEnum];
+  features?: string[];
+  extraFields?: unknown;
+  externalId: string;
+  billingProvider?: BillingProviderEnum[keyof BillingProviderEnum];
+};
+export type UpdatePlanDto<PlanCadenceEnum, BillingProviderEnum> = IdDto &
+  Partial<CreatePlanDto<PlanCadenceEnum, BillingProviderEnum>>;
+export type PlanDto<PlanCadenceEnum, BillingProviderEnum> = IdDto &
+  CreatePlanDto<PlanCadenceEnum, BillingProviderEnum> &
+  Partial<RecordTimingDto>;
+
+export type PlanServiceParameters<PlanCadenceEnum, BillingProviderEnum> = {
+  CreatePlanDto: CreatePlanDto<PlanCadenceEnum, BillingProviderEnum>;
+  UpdatePlanDto: UpdatePlanDto<PlanCadenceEnum, BillingProviderEnum>;
+  PlanDto: PlanDto<PlanCadenceEnum, BillingProviderEnum>;
+  IdDto: IdDto;
+  IdsDto: IdsDto;
+};

package/lib/eject/types/types/subscription.service.types.ts

@@ -0,0 +1,28 @@
+import { IdDto, IdsDto, RecordTimingDto } from '@forklaunch/common';
+
+export type CreateSubscriptionDto<PartyType, BillingProviderType> = {
+  partyId: string;
+  partyType: PartyType[keyof PartyType];
+  description?: string;
+  active: boolean;
+  productId: string;
+  extraFields?: unknown;
+  externalId: string;
+  billingProvider?: BillingProviderType[keyof BillingProviderType];
+  startDate: Date;
+  endDate: Date;
+  status: string;
+};
+export type UpdateSubscriptionDto<PartyType, BillingProviderType> = IdDto &
+  Partial<CreateSubscriptionDto<PartyType, BillingProviderType>>;
+export type SubscriptionDto<PartyType, BillingProviderType> = IdDto &
+  CreateSubscriptionDto<PartyType, BillingProviderType> &
+  Partial<RecordTimingDto>;
+
+export type SubscriptionServiceParameters<PartyType, BillingProviderType> = {
+  CreateSubscriptionDto: CreateSubscriptionDto<PartyType, BillingProviderType>;
+  UpdateSubscriptionDto: UpdateSubscriptionDto<PartyType, BillingProviderType>;
+  SubscriptionDto: SubscriptionDto<PartyType, BillingProviderType>;
+  IdDto: IdDto;
+  IdsDto: IdsDto;
+};

package/lib/index.d.ts

@@ -0,0 +1,3 @@
+export * from './interfaces';
+export * from './types';
+//# sourceMappingURL=index.d.ts.map

package/lib/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAC;AAC7B,cAAc,SAAS,CAAC"}

package/lib/index.js

@@ -0,0 +1,2 @@
+export * from './interfaces';
+export * from './types';

package/lib/interfaces/billingPortal.service.interface.d.ts

@@ -0,0 +1,8 @@
+import { BillingPortalServiceParameters } from '../types/billingPortal.service.types';
+export interface BillingPortalService<Params extends BillingPortalServiceParameters = BillingPortalServiceParameters> {
+    createBillingPortalSession: (billingPortalDto: Params['CreateBillingPortalDto']) => Promise<Params['BillingPortalDto']>;
+    getBillingPortalSession: (idDto: Params['IdDto']) => Promise<Params['BillingPortalDto']>;
+    updateBillingPortalSession: (billingPortalDto: Params['UpdateBillingPortalDto']) => Promise<Params['BillingPortalDto']>;
+    expireBillingPortalSession: (idDto: Params['IdDto']) => Promise<void>;
+}
+//# sourceMappingURL=billingPortal.service.interface.d.ts.map

package/lib/interfaces/billingPortal.service.interface.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"billingPortal.service.interface.d.ts","sourceRoot":"","sources":["../../interfaces/billingPortal.service.interface.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,8BAA8B,EAAE,MAAM,sCAAsC,CAAC;AAEtF,MAAM,WAAW,oBAAoB,CACnC,MAAM,SAAS,8BAA8B,GAAG,8BAA8B;IAI9E,0BAA0B,EAAE,CAC1B,gBAAgB,EAAE,MAAM,CAAC,wBAAwB,CAAC,KAC/C,OAAO,CAAC,MAAM,CAAC,kBAAkB,CAAC,CAAC,CAAC;IACzC,uBAAuB,EAAE,CACvB,KAAK,EAAE,MAAM,CAAC,OAAO,CAAC,KACnB,OAAO,CAAC,MAAM,CAAC,kBAAkB,CAAC,CAAC,CAAC;IACzC,0BAA0B,EAAE,CAC1B,gBAAgB,EAAE,MAAM,CAAC,wBAAwB,CAAC,KAC/C,OAAO,CAAC,MAAM,CAAC,kBAAkB,CAAC,CAAC,CAAC;IACzC,0BAA0B,EAAE,CAAC,KAAK,EAAE,MAAM,CAAC,OAAO,CAAC,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;CACvE"}

package/lib/interfaces/billingPortal.service.interface.js

@@ -0,0 +1 @@
+export {};

package/lib/interfaces/checkoutSession.service.interface.d.ts

@@ -0,0 +1,9 @@
+import { CheckoutSessionServiceParameters } from '../types/checkoutSession.service.types';
+export interface CheckoutSessionService<PaymentMethodEnum, Params extends CheckoutSessionServiceParameters<PaymentMethodEnum> = CheckoutSessionServiceParameters<PaymentMethodEnum>> {
+    createCheckoutSession: (checkoutSessionDto: Params['CreateCheckoutSessionDto']) => Promise<Params['CheckoutSessionDto']>;
+    getCheckoutSession: (idDto: Params['IdDto']) => Promise<Params['CheckoutSessionDto']>;
+    expireCheckoutSession: (idDto: Params['IdDto']) => Promise<void>;
+    handleCheckoutSuccess: (idDto: Params['IdDto']) => Promise<void>;
+    handleCheckoutFailure: (idDto: Params['IdDto']) => Promise<void>;
+}
+//# sourceMappingURL=checkoutSession.service.interface.d.ts.map

package/lib/interfaces/checkoutSession.service.interface.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"checkoutSession.service.interface.d.ts","sourceRoot":"","sources":["../../interfaces/checkoutSession.service.interface.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gCAAgC,EAAE,MAAM,wCAAwC,CAAC;AAC1F,MAAM,WAAW,sBAAsB,CACrC,iBAAiB,EACjB,MAAM,SACJ,gCAAgC,CAAC,iBAAiB,CAAC,GAAG,gCAAgC,CAAC,iBAAiB,CAAC;IAI3G,qBAAqB,EAAE,CACrB,kBAAkB,EAAE,MAAM,CAAC,0BAA0B,CAAC,KACnD,OAAO,CAAC,MAAM,CAAC,oBAAoB,CAAC,CAAC,CAAC;IAC3C,kBAAkB,EAAE,CAClB,KAAK,EAAE,MAAM,CAAC,OAAO,CAAC,KACnB,OAAO,CAAC,MAAM,CAAC,oBAAoB,CAAC,CAAC,CAAC;IAC3C,qBAAqB,EAAE,CAAC,KAAK,EAAE,MAAM,CAAC,OAAO,CAAC,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAEjE,qBAAqB,EAAE,CAAC,KAAK,EAAE,MAAM,CAAC,OAAO,CAAC,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IACjE,qBAAqB,EAAE,CAAC,KAAK,EAAE,MAAM,CAAC,OAAO,CAAC,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;CAClE"}

package/lib/interfaces/checkoutSession.service.interface.js

@@ -0,0 +1 @@
+export {};

package/lib/interfaces/index.d.ts

@@ -0,0 +1,6 @@
+export * from './billingPortal.service.interface';
+export * from './checkoutSession.service.interface';
+export * from './paymentLink.service.interface';
+export * from './plan.service.interface';
+export * from './subscription.service.interface';
+//# sourceMappingURL=index.d.ts.map

package/lib/interfaces/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../interfaces/index.ts"],"names":[],"mappings":"AAAA,cAAc,mCAAmC,CAAC;AAClD,cAAc,qCAAqC,CAAC;AACpD,cAAc,iCAAiC,CAAC;AAChD,cAAc,0BAA0B,CAAC;AACzC,cAAc,kCAAkC,CAAC"}

package/lib/interfaces/index.js

@@ -0,0 +1,5 @@
+export * from './billingPortal.service.interface';
+export * from './checkoutSession.service.interface';
+export * from './paymentLink.service.interface';
+export * from './plan.service.interface';
+export * from './subscription.service.interface';