@forklaunch/interfaces-billing 0.1.0 → 0.1.2

package/index.ts

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

package/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/interfaces/checkoutSession.service.interface.ts

@@ -1,25 +1,4 @@
-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;
-};
-
+import { CheckoutSessionServiceParameters } from '../types/checkoutSession.service.types';
 export interface CheckoutSessionService<
   PaymentMethodEnum,
   Params extends

package/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/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/interfaces/plan.service.interface.ts

@@ -1,30 +1,5 @@
-import { IdDto, IdsDto, RecordTimingDto } from '@forklaunch/common';
 import { EntityManager } from '@mikro-orm/core';
-
-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;
-};
+import { PlanServiceParameters } from '../types/plan.service.types';
 
 export interface PlanService<
   PlanCadenceEnum,

package/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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@forklaunch/interfaces-billing",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "description": "Billing interfaces for forklaunch",
   "homepage": "https://github.com/forklaunch/forklaunch-js#readme",
   "bugs": {
@@ -12,7 +12,7 @@
   },
   "license": "MIT",
   "author": "Forklift Technologies, Inc.",
-  "main": "server.ts",
+  "types": "./lib/index.d.ts",
   "dependencies": {
     "@forklaunch/common": "^0.2.5",
     "@mikro-orm/core": "^6.4.11"
@@ -22,21 +22,14 @@
     "prettier": "^3.5.3",
     "typedoc": "^0.28.1"
   },
-  "mikro-orm": {
-    "configPaths": [
-      "./mikro-orm.config.ts",
-      "./dist/mikro-orm.config.js"
-    ]
-  },
   "scripts": {
-    "build": "tsc",
-    "clean": "rm -rf dist pnpm.lock.yaml node_modules",
+    "build": "tsc && pnpm package:eject",
+    "clean": "rm -rf lib pnpm.lock.yaml node_modules",
     "docs": "typedoc --out docs *",
     "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",
-    "start": "ENV_FILE_PATH=.env.local NODE_OPTIONS='--import=tsx' node dist/server.js",
-    "start:bun": "bun run migrate:up && bun dist/server.js",
+    "package:eject": "mkdir -p lib/eject && cp -r interfaces lib/eject/interfaces && cp -r types lib/eject/types",
     "test": "vitest --passWithNoTests"
   }
 }

package/tsconfig.json

@@ -1,7 +1,7 @@
 {
   "extends": "../../tsconfig.base.json",
   "compilerOptions": {
-    "outDir": "dist"
+    "outDir": "lib"
   },
-  "exclude": ["node_modules", "dist", "eslint.config.mjs"]
+  "exclude": ["node_modules", "lib", "eslint.config.mjs"]
 }

package/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/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/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/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/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/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;
+};