@forklaunch/implementation-billing-base 0.1.4 → 0.1.5

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@forklaunch/implementation-billing-base",
-  "version": "0.1.4",
+  "version": "0.1.5",
   "description": "Billing basic implementation for forklaunch",
   "homepage": "https://github.com/forklaunch/forklaunch-js#readme",
   "bugs": {
@@ -12,23 +12,33 @@
   },
   "license": "MIT",
   "author": "Forklift Technologies, Inc.",
+  "exports": {
+    "./schemas": {
+      "types": "./lib/schemas/index.d.ts",
+      "import": "./lib/schemas/index.js"
+    },
+    "./services": {
+      "types": "./lib/services/index.d.ts",
+      "import": "./lib/services/index.js"
+    }
+  },
   "files": [
     "lib/**"
   ],
   "dependencies": {
-    "@forklaunch/common": "^0.2.5",
-    "@forklaunch/core": "^0.6.0",
-    "@forklaunch/validator": "^0.4.8",
-    "@mikro-orm/core": "^6.4.11",
+    "@forklaunch/common": "^0.2.6",
+    "@forklaunch/core": "^0.6.2",
+    "@forklaunch/validator": "^0.4.10",
+    "@mikro-orm/core": "^6.4.12",
     "@sinclair/typebox": "^0.34.33",
     "ajv": "^8.17.1",
     "zod": "^3.24.2",
-    "@forklaunch/interfaces-billing": "0.1.4"
+    "@forklaunch/interfaces-billing": "0.1.5"
   },
   "devDependencies": {
     "depcheck": "^1.4.7",
     "prettier": "^3.5.3",
-    "typedoc": "^0.28.1"
+    "typedoc": "^0.28.2"
   },
   "scripts": {
     "build": "tsc && pnpm package:eject",
@@ -37,7 +47,7 @@
     "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 schemas/zod lib/eject/schemas && cp -r services lib/eject/services",
+    "package:eject": "rm -rf lib/eject && mkdir -p lib/eject && cp -r schemas/zod lib/eject/schemas && cp schemas/index.ts lib/eject/schemas && cp -r services lib/eject/services && find lib/eject -type f -name '*.ts' -exec sed -i '' 's|@forklaunch/validator/zod|@{{app_name}}/core|g' {} +",
     "test": "vitest --passWithNoTests"
   }
 }

package/lib/eject/schemas/zod/billingPortal.schema.ts

@@ -1,29 +0,0 @@
-import {
-  date,
-  optional,
-  string,
-  unknown,
-  uuid
-} from '@forklaunch/validator/zod';
-
-export const CreateBillingPortalSchema = {
-  customerId: string,
-  uri: string,
-  expiresAt: date
-};
-
-export const UpdateBillingPortalSchema = (uuidId: boolean) => ({
-  id: uuidId ? uuid : string,
-  uri: optional(string),
-  expiresAt: optional(date)
-});
-
-export const BillingPortalSchema = (uuidId: boolean) => ({
-  id: uuidId ? uuid : string,
-  customerId: string,
-  uri: string,
-  expiresAt: date,
-  extraFields: optional(unknown),
-  createdAt: optional(date),
-  updatedAt: optional(date)
-});

package/lib/eject/schemas/zod/checkoutSession.schema.ts

@@ -1,46 +0,0 @@
-import { LiteralSchema } from '@forklaunch/validator';
-import {
-  array,
-  date,
-  enum_,
-  optional,
-  string,
-  unknown,
-  uuid
-} from '@forklaunch/validator/zod';
-
-export const CreateCheckoutSessionSchema = <
-  T extends Record<string, LiteralSchema>
->(
-  PaymentMethodEnum: T
-) => ({
-  customerId: string,
-  paymentMethods: array(enum_(PaymentMethodEnum)),
-  successRedirectUri: string,
-  cancelRedirectUri: string,
-  extraFields: optional(unknown)
-});
-
-export const UpdateCheckoutSessionSchema =
-  (uuidId: boolean) =>
-  <T extends Record<string, LiteralSchema>>(PaymentMethodEnum: T) => ({
-    id: uuidId ? uuid : string,
-    customerId: optional(string),
-    paymentMethods: optional(array(enum_(PaymentMethodEnum))),
-    successRedirectUri: optional(string),
-    cancelRedirectUri: optional(string),
-    extraFields: optional(unknown)
-  });
-
-export const CheckoutSessionSchema =
-  (uuidId: boolean) =>
-  <T extends Record<string, LiteralSchema>>(PaymentMethodEnum: T) => ({
-    id: uuidId ? uuid : string,
-    customerId: string,
-    paymentMethods: array(enum_(PaymentMethodEnum)),
-    successRedirectUri: string,
-    cancelRedirectUri: string,
-    extraFields: optional(unknown),
-    createdAt: optional(date),
-    updatedAt: optional(date)
-  });

package/lib/eject/schemas/zod/paymentLink.schema.ts

@@ -1,52 +0,0 @@
-import { LiteralSchema } from '@forklaunch/validator';
-import {
-  date,
-  enum_,
-  number,
-  optional,
-  string,
-  unknown,
-  uuid
-} from '@forklaunch/validator/zod';
-
-export const CreatePaymentLinkSchema = <
-  T extends Record<string, LiteralSchema>
->(
-  CurrencyEnum: T
-) => ({
-  amount: number,
-  currency: enum_(CurrencyEnum),
-  description: optional(string),
-  metadata: optional(unknown),
-  successRedirectUri: string,
-  cancelRedirectUri: string,
-  extraFields: optional(unknown)
-});
-
-export const UpdatePaymentLinkSchema =
-  (uuidId: boolean) =>
-  <T extends Record<string, LiteralSchema>>(CurrencyEnum: T) => ({
-    id: uuidId ? uuid : string,
-    amount: optional(number),
-    currency: optional(enum_(CurrencyEnum)),
-    description: optional(string),
-    metadata: optional(unknown),
-    successRedirectUri: optional(string),
-    cancelRedirectUri: optional(string),
-    extraFields: optional(unknown)
-  });
-
-export const PaymentLinkSchema =
-  (uuidId: boolean) =>
-  <T extends Record<string, LiteralSchema>>(CurrencyEnum: T) => ({
-    id: uuidId ? uuid : string,
-    amount: number,
-    currency: enum_(CurrencyEnum),
-    description: optional(string),
-    metadata: optional(unknown),
-    successRedirectUri: string,
-    cancelRedirectUri: string,
-    extraFields: optional(unknown),
-    createdAt: optional(date),
-    updatedAt: optional(date)
-  });

package/lib/eject/schemas/zod/plan.schema.ts

@@ -1,74 +0,0 @@
-import { LiteralSchema } from '@forklaunch/validator';
-import {
-  array,
-  boolean,
-  date,
-  enum_,
-  number,
-  optional,
-  string,
-  unknown,
-  uuid
-} from '@forklaunch/validator/zod';
-
-export const CreatePlanSchema = <
-  T extends Record<string, LiteralSchema>,
-  U extends Record<string, LiteralSchema>
->(
-  PlanCadenceEnum: T,
-  BillingProviderEnum: U
-) => ({
-  name: string,
-  description: optional(string),
-  price: number,
-  cadence: enum_(PlanCadenceEnum),
-  features: array(string),
-  extraFields: optional(unknown),
-  externalId: string,
-  billingProvider: optional(enum_(BillingProviderEnum)),
-  active: boolean
-});
-
-export const UpdatePlanSchema =
-  (uuidId: boolean) =>
-  <
-    T extends Record<string, LiteralSchema>,
-    U extends Record<string, LiteralSchema>
-  >(
-    PlanCadenceEnum: T,
-    BillingProviderEnum: U
-  ) => ({
-    id: uuidId ? uuid : string,
-    name: optional(string),
-    description: optional(string),
-    price: optional(number),
-    cadence: optional(enum_(PlanCadenceEnum)),
-    features: optional(array(string)),
-    extraFields: optional(unknown),
-    externalId: optional(string),
-    billingProvider: optional(enum_(BillingProviderEnum)),
-    active: optional(boolean)
-  });
-
-export const PlanSchema =
-  (uuidId: boolean) =>
-  <
-    T extends Record<string, LiteralSchema>,
-    U extends Record<string, LiteralSchema>
-  >(
-    PlanCadenceEnum: T,
-    BillingProviderEnum: U
-  ) => ({
-    id: uuidId ? uuid : string,
-    name: string,
-    description: optional(string),
-    price: number,
-    cadence: enum_(PlanCadenceEnum),
-    features: optional(array(string)),
-    extraFields: optional(unknown),
-    externalId: string,
-    billingProvider: optional(enum_(BillingProviderEnum)),
-    active: boolean,
-    createdAt: optional(date),
-    updatedAt: optional(date)
-  });

package/lib/eject/schemas/zod/subscription.schema.ts

@@ -1,78 +0,0 @@
-import { LiteralSchema } from '@forklaunch/validator';
-import {
-  boolean,
-  date,
-  enum_,
-  optional,
-  string,
-  unknown,
-  uuid
-} from '@forklaunch/validator/zod';
-
-export const CreateSubscriptionSchema = <
-  T extends Record<string, LiteralSchema>,
-  U extends Record<string, LiteralSchema>
->(
-  PartyEnum: T,
-  BillingProviderEnum: U
-) => ({
-  partyId: string,
-  partyType: enum_(PartyEnum),
-  productId: string,
-  description: optional(string),
-  active: boolean,
-  externalId: string,
-  startDate: date,
-  endDate: date,
-  status: string,
-  billingProvider: optional(enum_(BillingProviderEnum)),
-  extraFields: optional(unknown)
-});
-
-export const UpdateSubscriptionSchema =
-  (uuidId: boolean) =>
-  <
-    T extends Record<string, LiteralSchema>,
-    U extends Record<string, LiteralSchema>
-  >(
-    PartyEnum: T,
-    BillingProviderEnum: U
-  ) => ({
-    id: uuidId ? uuid : string,
-    partyId: optional(string),
-    partyType: optional(enum_(PartyEnum)),
-    productId: optional(string),
-    description: optional(string),
-    active: optional(boolean),
-    externalId: optional(string),
-    startDate: optional(date),
-    endDate: optional(date),
-    status: optional(string),
-    billingProvider: optional(enum_(BillingProviderEnum)),
-    extraFields: optional(unknown)
-  });
-
-export const SubscriptionSchema =
-  (uuidId: boolean) =>
-  <
-    T extends Record<string, LiteralSchema>,
-    U extends Record<string, LiteralSchema>
-  >(
-    PartyEnum: T,
-    BillingProviderEnum: U
-  ) => ({
-    id: uuidId ? uuid : string,
-    partyId: string,
-    partyType: enum_(PartyEnum),
-    productId: string,
-    description: optional(string),
-    active: boolean,
-    externalId: string,
-    startDate: date,
-    endDate: date,
-    status: string,
-    billingProvider: optional(enum_(BillingProviderEnum)),
-    extraFields: optional(unknown),
-    createdAt: optional(date),
-    updatedAt: optional(date)
-  });

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

@@ -1,148 +0,0 @@
-import {
-  BillingPortalDto,
-  BillingPortalService,
-  CreateBillingPortalDto,
-  UpdateBillingPortalDto
-} from '@forklaunch/interfaces-billing';
-import { IdDto, InstanceTypeRecord } from '@forklaunch/common';
-import { createCacheKey, TtlCache } from '@forklaunch/core/cache';
-import {
-  InternalDtoMapper,
-  RequestDtoMapperConstructor,
-  ResponseDtoMapperConstructor,
-  transformIntoInternalDtoMapper
-} from '@forklaunch/core/dtoMapper';
-import {
-  MetricsDefinition,
-  OpenTelemetryCollector
-} from '@forklaunch/core/http';
-import { AnySchemaValidator } from '@forklaunch/validator';
-
-export class BaseBillingPortalService<
-  SchemaValidator extends AnySchemaValidator,
-  Metrics extends MetricsDefinition = MetricsDefinition,
-  Dto extends {
-    BillingPortalDtoMapper: BillingPortalDto;
-    CreateBillingPortalDtoMapper: CreateBillingPortalDto;
-    UpdateBillingPortalDtoMapper: UpdateBillingPortalDto;
-  } = {
-    BillingPortalDtoMapper: BillingPortalDto;
-    CreateBillingPortalDtoMapper: CreateBillingPortalDto;
-    UpdateBillingPortalDtoMapper: UpdateBillingPortalDto;
-  },
-  Entities extends {
-    BillingPortalDtoMapper: BillingPortalDto;
-    CreateBillingPortalDtoMapper: BillingPortalDto;
-    UpdateBillingPortalDtoMapper: BillingPortalDto;
-  } = {
-    BillingPortalDtoMapper: BillingPortalDto;
-    CreateBillingPortalDtoMapper: BillingPortalDto;
-    UpdateBillingPortalDtoMapper: BillingPortalDto;
-  }
-> implements BillingPortalService
-{
-  #dtoMappers: InternalDtoMapper<
-    InstanceTypeRecord<typeof this.dtoMappers>,
-    Entities,
-    Dto
-  >;
-
-  constructor(
-    protected cache: TtlCache,
-    protected openTelemetryCollector: OpenTelemetryCollector<Metrics>,
-    protected schemaValidator: SchemaValidator,
-    protected dtoMappers: {
-      BillingPortalDtoMapper: ResponseDtoMapperConstructor<
-        SchemaValidator,
-        Dto['BillingPortalDtoMapper'],
-        Entities['BillingPortalDtoMapper']
-      >;
-      CreateBillingPortalDtoMapper: RequestDtoMapperConstructor<
-        SchemaValidator,
-        Dto['CreateBillingPortalDtoMapper'],
-        Entities['CreateBillingPortalDtoMapper']
-      >;
-      UpdateBillingPortalDtoMapper: RequestDtoMapperConstructor<
-        SchemaValidator,
-        Dto['UpdateBillingPortalDtoMapper'],
-        Entities['UpdateBillingPortalDtoMapper']
-      >;
-    }
-  ) {
-    this.#dtoMappers = transformIntoInternalDtoMapper(
-      dtoMappers,
-      schemaValidator
-    );
-  }
-
-  protected createCacheKey = createCacheKey('billing_portal_session');
-
-  async createBillingPortalSession(
-    billingPortalDto: Dto['CreateBillingPortalDtoMapper']
-  ): Promise<Dto['BillingPortalDtoMapper']> {
-    const billingPortalSession =
-      this.#dtoMappers.CreateBillingPortalDtoMapper.deserializeDtoToEntity(
-        billingPortalDto
-      );
-
-    this.openTelemetryCollector.debug(
-      'Create billing portal session',
-      billingPortalSession
-    );
-
-    await this.cache.putRecord({
-      key: this.createCacheKey(billingPortalSession.id),
-      value: billingPortalSession,
-      ttlMilliseconds: this.cache.getTtlMilliseconds()
-    });
-
-    return this.#dtoMappers.BillingPortalDtoMapper.serializeEntityToDto(
-      billingPortalSession
-    );
-  }
-
-  async getBillingPortalSession(
-    idDto: IdDto
-  ): Promise<Dto['BillingPortalDtoMapper']> {
-    const billingPortalSessionDetails = await this.cache.readRecord<
-      Entities['BillingPortalDtoMapper']
-    >(this.createCacheKey(idDto.id));
-    if (!billingPortalSessionDetails) {
-      throw new Error('Session not found');
-    }
-
-    return this.#dtoMappers.BillingPortalDtoMapper.serializeEntityToDto(
-      billingPortalSessionDetails.value
-    );
-  }
-
-  async updateBillingPortalSession(
-    billingPortalDto: UpdateBillingPortalDto
-  ): Promise<Dto['BillingPortalDtoMapper']> {
-    const billingPortalSession =
-      this.#dtoMappers.UpdateBillingPortalDtoMapper.deserializeDtoToEntity(
-        billingPortalDto
-      );
-    // Save the updated session to your database or external service
-    await this.cache.putRecord({
-      key: this.createCacheKey(billingPortalSession.id),
-      value: billingPortalSession,
-      ttlMilliseconds: this.cache.getTtlMilliseconds()
-    });
-
-    return this.#dtoMappers.BillingPortalDtoMapper.serializeEntityToDto(
-      billingPortalSession
-    );
-  }
-
-  async expireBillingPortalSession(idDto: IdDto): Promise<void> {
-    const sessionExists = await this.cache.readRecord(
-      this.createCacheKey(idDto.id)
-    );
-    if (!sessionExists) {
-      throw new Error('Session not found');
-    }
-
-    await this.cache.deleteRecord(this.createCacheKey(idDto.id));
-  }
-}

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

@@ -1,135 +0,0 @@
-import {
-  CheckoutSessionDto,
-  CheckoutSessionService,
-  CreateCheckoutSessionDto,
-  UpdateCheckoutSessionDto
-} from '@forklaunch/interfaces-billing';
-import { IdDto, InstanceTypeRecord } from '@forklaunch/common';
-import { createCacheKey, TtlCache } from '@forklaunch/core/cache';
-import {
-  InternalDtoMapper,
-  RequestDtoMapperConstructor,
-  ResponseDtoMapperConstructor,
-  transformIntoInternalDtoMapper
-} from '@forklaunch/core/dtoMapper';
-import {
-  MetricsDefinition,
-  OpenTelemetryCollector
-} from '@forklaunch/core/http';
-import { AnySchemaValidator } from '@forklaunch/validator';
-
-export class BaseCheckoutSessionService<
-  SchemaValidator extends AnySchemaValidator,
-  PaymentMethodEnum,
-  Metrics extends MetricsDefinition = MetricsDefinition,
-  Dto extends {
-    CheckoutSessionDtoMapper: CheckoutSessionDto<PaymentMethodEnum>;
-    CreateCheckoutSessionDtoMapper: CreateCheckoutSessionDto<PaymentMethodEnum>;
-    UpdateCheckoutSessionDtoMapper: UpdateCheckoutSessionDto<PaymentMethodEnum>;
-  } = {
-    CheckoutSessionDtoMapper: CheckoutSessionDto<PaymentMethodEnum>;
-    CreateCheckoutSessionDtoMapper: CreateCheckoutSessionDto<PaymentMethodEnum>;
-    UpdateCheckoutSessionDtoMapper: UpdateCheckoutSessionDto<PaymentMethodEnum>;
-  },
-  Entities extends {
-    CheckoutSessionDtoMapper: CheckoutSessionDto<PaymentMethodEnum>;
-    CreateCheckoutSessionDtoMapper: CheckoutSessionDto<PaymentMethodEnum>;
-    UpdateCheckoutSessionDtoMapper: CheckoutSessionDto<PaymentMethodEnum>;
-  } = {
-    CheckoutSessionDtoMapper: CheckoutSessionDto<PaymentMethodEnum>;
-    CreateCheckoutSessionDtoMapper: CheckoutSessionDto<PaymentMethodEnum>;
-    UpdateCheckoutSessionDtoMapper: CheckoutSessionDto<PaymentMethodEnum>;
-  }
-> implements CheckoutSessionService<PaymentMethodEnum>
-{
-  #dtoMappers: InternalDtoMapper<
-    InstanceTypeRecord<typeof this.dtoMappers>,
-    Entities,
-    Dto
-  >;
-
-  constructor(
-    protected readonly cache: TtlCache,
-    protected readonly openTelemetryCollector: OpenTelemetryCollector<Metrics>,
-    protected readonly schemaValidator: SchemaValidator,
-    protected readonly dtoMappers: {
-      CheckoutSessionDtoMapper: ResponseDtoMapperConstructor<
-        SchemaValidator,
-        Dto['CheckoutSessionDtoMapper'],
-        Entities['CheckoutSessionDtoMapper']
-      >;
-      CreateCheckoutSessionDtoMapper: RequestDtoMapperConstructor<
-        SchemaValidator,
-        Dto['CreateCheckoutSessionDtoMapper'],
-        Entities['CreateCheckoutSessionDtoMapper']
-      >;
-      UpdateCheckoutSessionDtoMapper: RequestDtoMapperConstructor<
-        SchemaValidator,
-        Dto['UpdateCheckoutSessionDtoMapper'],
-        Entities['UpdateCheckoutSessionDtoMapper']
-      >;
-    }
-  ) {
-    this.#dtoMappers = transformIntoInternalDtoMapper(
-      dtoMappers,
-      schemaValidator
-    );
-  }
-
-  protected createCacheKey = createCacheKey('checkout_session');
-
-  async createCheckoutSession(
-    checkoutSessionDto: Dto['CreateCheckoutSessionDtoMapper']
-  ): Promise<Dto['CheckoutSessionDtoMapper']> {
-    const checkoutSession =
-      this.#dtoMappers.CreateCheckoutSessionDtoMapper.deserializeDtoToEntity(
-        checkoutSessionDto
-      );
-
-    // Store the checkoutSession details in the cache
-    await this.cache.putRecord({
-      key: this.createCacheKey(checkoutSession.id),
-      value: checkoutSession,
-      ttlMilliseconds: this.cache.getTtlMilliseconds()
-    });
-
-    return this.#dtoMappers.CheckoutSessionDtoMapper.serializeEntityToDto(
-      checkoutSession
-    );
-  }
-
-  async getCheckoutSession({
-    id
-  }: IdDto): Promise<Dto['CheckoutSessionDtoMapper']> {
-    const checkoutSessionDetails = await this.cache.readRecord<
-      Entities['CheckoutSessionDtoMapper']
-    >(this.createCacheKey(id));
-    if (!checkoutSessionDetails) {
-      throw new Error('Session not found');
-    }
-
-    return this.#dtoMappers.CheckoutSessionDtoMapper.serializeEntityToDto(
-      checkoutSessionDetails.value
-    );
-  }
-
-  async expireCheckoutSession({ id }: IdDto): Promise<void> {
-    const checkoutSessionDetails = await this.cache.readRecord(
-      this.createCacheKey(id)
-    );
-    if (!checkoutSessionDetails) {
-      throw new Error('Session not found');
-    }
-    await this.cache.deleteRecord(this.createCacheKey(id));
-  }
-
-  async handleCheckoutSuccess({ id }: IdDto): Promise<void> {
-    this.openTelemetryCollector.info('Checkout success', { id });
-    await this.cache.deleteRecord(this.createCacheKey(id));
-  }
-
-  async handleCheckoutFailure({ id }: IdDto): Promise<void> {
-    this.openTelemetryCollector.info('Checkout failure', { id });
-    await this.cache.deleteRecord(this.createCacheKey(id));
-  }
-}