@forklaunch/interfaces-billing 0.1.4 → 0.1.6

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@forklaunch/interfaces-billing",
-  "version": "0.1.4",
+  "version": "0.1.6",
   "description": "Billing interfaces for forklaunch",
   "homepage": "https://github.com/forklaunch/forklaunch-js#readme",
   "bugs": {
@@ -12,17 +12,27 @@
   },
   "license": "MIT",
   "author": "Forklift Technologies, Inc.",
+  "exports": {
+    "./interfaces": {
+      "types": "./lib/interfaces/index.d.ts",
+      "import": "./lib/interfaces/index.js"
+    },
+    "./types": {
+      "types": "./lib/types/index.d.ts",
+      "import": "./lib/types/index.js"
+    }
+  },
   "files": [
     "lib/**"
   ],
   "dependencies": {
-    "@forklaunch/common": "^0.2.5",
-    "@mikro-orm/core": "^6.4.11"
+    "@forklaunch/common": "^0.2.6",
+    "@mikro-orm/core": "^6.4.12"
   },
   "devDependencies": {
     "depcheck": "^1.4.7",
     "prettier": "^3.5.3",
-    "typedoc": "^0.28.1"
+    "typedoc": "^0.28.2"
   },
   "scripts": {
     "build": "tsc && pnpm package:eject",
@@ -31,7 +41,8 @@
     "format": "prettier --ignore-path=.prettierignore --config .prettierrc '**/*.{ts,tsx,json}' --write",
     "lint": "eslint . -c eslint.config.mjs",
     "lint:fix": "eslint . -c eslint.config.mjs --fix",
-    "package:eject": "mkdir -p lib/eject && cp -r interfaces lib/eject/interfaces && cp -r types lib/eject/types",
+    "package:eject": "rm -rf lib/eject && mkdir -p lib/eject && cp -r interfaces lib/eject/interfaces && cp -r types lib/eject/types",
+    "publish:package": "./publish-package.bash",
     "test": "vitest --passWithNoTests"
   }
 }

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

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

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

@@ -1,5 +0,0 @@
-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/paymentLink.service.interface.ts

@@ -1,27 +0,0 @@
-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/interfaces/plan.service.interface.ts

@@ -1,29 +0,0 @@
-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/interfaces/subscription.service.interface.ts

@@ -1,49 +0,0 @@
-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/types/billingPortal.service.types.ts

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

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

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

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

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

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

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

package/lib/index.d.ts.map

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

package/lib/index.js

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