initial commit

Author: kerwanp

.gitignore

@@ -12,3 +12,4 @@ dist
 yarn.lock
 shrinkwrap.yaml
 package-lock.json
+tests/tmp

package.json

@@ -1,5 +1,5 @@
 {
-  "name": "adonis-shopkeeper",
+  "name": "@foadonis/shopkeeper",
   "description": "",
   "version": "0.0.0",
   "engines": {
@@ -17,11 +17,10 @@
   "exports": {
     ".": "./build/index.js",
     "./types": "./build/src/types.js",
-    "./fields": "./build/src/fields/main.js",
-    "./menu": "./build/src/menu/main.js",
     "./providers/*": "./build/providers/*.js",
     "./services/*": "./build/services/*.js",
-    "./commands": "./build/commands/main.js"
+    "./commands": "./build/commands/main.js",
+    "./errors": "./build/src/errors/main.js"
   },
   "scripts": {
     "clean": "del-cli build",
@@ -65,7 +64,7 @@
     "copyfiles": "^2.4.1",
     "del-cli": "^5.1.0",
     "edge.js": "^6.0.2",
-    "eslint": "^8.57.0",
+    "eslint": "^9.9.0",
     "html-entities": "^2.5.2",
     "np": "^10.0.6",
     "prettier": "^3.3.2",

providers/shopkeeper_provider.ts

@@ -5,21 +5,58 @@ import emitter from '@adonisjs/core/services/emitter'
 import { handleCustomerSubscriptionCreated } from '../src/handlers/handle_customer_subscription_created.js'
 import { handleCustomerSubscriptionUpdated } from '../src/handlers/handle_customer_subscription_updated.js'
 import { handleCustomerSubscriptionDeleted } from '../src/handlers/handle_customer_subscription_deleted.js'
+import { handleWebhook } from '../src/handlers/handle_webhooks.js'
+import { InvalidConfigurationError } from '../src/errors/invalid_configuration.js'
 
 export default class ShopkeeperProvider {
-  constructor(protected app: ApplicationService) {}
+  #config: Required<ShopkeeperConfig>
+
+  constructor(protected app: ApplicationService) {
+    this.#config = this.app.config.get<Required<ShopkeeperConfig>>('shopkeeper')
+  }
 
   register() {
     this.app.container.singleton(Shopkeeper, async () => {
-      const config = this.app.config.get<ShopkeeperConfig>('shopkeeper')
-      return new Shopkeeper(config)
+      const [customerModel, subscriptionModel, subscriptionItemModel] = await Promise.all([
+        this.#config.models.customerModel().then((i) => i.default),
+        this.#config.models.subscriptionModel().then((i) => i.default),
+        this.#config.models.subscriptionItemModel().then((i) => i.default),
+      ])
+
+      return new Shopkeeper(this.#config, customerModel, subscriptionModel, subscriptionItemModel)
     })
   }
 
-  start() {
+  async boot() {
+    await this.registerRoutes()
+  }
+
+  async start() {
     this.registerWebhookListeners()
   }
 
+  async registerRoutes() {
+    if (this.#config.registerRoutes) {
+      const router = await this.app.container.make('router')
+
+      const route = router
+        .post('/stripe/webhook', (ctx) => handleWebhook(ctx))
+        .as('shopkeeper.webhook')
+
+      if (this.#config.webhook.secret) {
+        if (this.app.inProduction) {
+          throw InvalidConfigurationError.webhookSecretInProduction()
+        }
+
+        const middleware = router.named({
+          stripeWebhook: () => import('../src/middlewares/stripe_webhook_middleware.js'),
+        })
+
+        route.middleware(middleware.stripeWebhook())
+      }
+    }
+  }
+
   registerWebhookListeners() {
     emitter.on('stripe:customer.subscription.created', handleCustomerSubscriptionCreated)
     emitter.on('stripe:customer.subscription.updated', handleCustomerSubscriptionUpdated)

src/checkout.ts

@@ -9,6 +9,7 @@ export class Checkout {
   /**
    * The Stripe model instance.
    */
+  // @ts-ignore -- Not used yet
   #owner: WithBillable['prototype'] | null
 
   /**

src/define_config.ts

@@ -1,12 +1,5 @@
 import { ShopkeeperConfig } from './types.js'
 
-export function defineConfig(
-  config: Omit<ShopkeeperConfig, 'calculateTaxes' | 'deactivatePastDue' | 'deactiveIncomplete'>
-): ShopkeeperConfig {
-  return {
-    calculateTaxes: false,
-    deactivatePastDue: false,
-    deactiveIncomplete: false,
-    ...config,
-  }
+export function defineConfig(config: ShopkeeperConfig): ShopkeeperConfig {
+  return config
 }

src/errors/invalid_argument.ts

@@ -0,0 +1,3 @@
+import { Exception } from '@adonisjs/core/exceptions'
+
+export class InvalidArgumentError extends Exception {}

src/errors/invalid_configuration.ts

@@ -0,0 +1,9 @@
+import { Exception } from '@adonisjs/core/exceptions'
+
+export class InvalidConfigurationError extends Exception {
+  static webhookSecretInProduction() {
+    return new InvalidConfigurationError(
+      'The webhook secret is mandatory in production. Make sure the `STRIPE_WEBHOOK_SECRET` is configured.'
+    )
+  }
+}

src/errors/main.ts

@@ -1,5 +1,15 @@
 import { CustomerAlreadyCreatedError } from './customer_already_created.js'
+import { IncompletePaymentError } from './incomplete_payment.js'
+import { InvalidArgumentError } from './invalid_argument.js'
 import { InvalidCustomerError } from './invalid_customer.js'
+import { InvalidInvoiceError } from './invalid_invoice.js'
+import { InvalidPaymentError } from './invalid_payment.js'
+import { SubscriptionUpdateFailureError } from './subscription_update_failure.js'
 
 export const E_CUSTOMER_ALREADY_CREATED = CustomerAlreadyCreatedError
+export const E_INCOMPLETE_PAYMENT = IncompletePaymentError
+export const E_INVALID_ARGUMENT = InvalidArgumentError
 export const E_INVALID_CUSTOMER = InvalidCustomerError
+export const E_INVALID_INVOICE = InvalidInvoiceError
+export const E_INVALID_PAYMENT = InvalidPaymentError
+export const E_SUBSCRIPTION_UPDATE_FAILURE = SubscriptionUpdateFailureError

src/errors/subscription_update_failure.ts

@@ -1,10 +1,16 @@
 import { Exception } from '@adonisjs/core/exceptions'
-import { Subscription } from '../models/subscription.js'
+import Subscription from '../models/subscription.js'
 
-export class SubscriptionUpdateError extends Exception {
+export class SubscriptionUpdateFailureError extends Exception {
   static incompleteSubscription(subscription: Subscription) {
-    return new SubscriptionUpdateError(
+    return new SubscriptionUpdateFailureError(
       `The subscription '${subscription.stripeId}' cannot be updated because its payment is incomplete.`
     )
   }
+
+  static duplicatePrice(subscription: Subscription, price: string) {
+    return new SubscriptionUpdateFailureError(
+      `The price "${price}" is already attached to subscription "${subscription.stripeId}".`
+    )
+  }
 }

src/handlers/handle_customer_subscription_updated.ts

@@ -1,7 +1,6 @@
 import Stripe from 'stripe'
 import shopkeeper from '../../services/shopkeeper.js'
 import { DateTime } from 'luxon'
-import { Subscription } from '../models/subscription.js'
 
 export async function handleCustomerSubscriptionUpdated(
   payload: Stripe.CustomerSubscriptionUpdatedEvent
@@ -13,7 +12,7 @@ export async function handleCustomerSubscriptionUpdated(
   const data = payload.data.object
   let subscription = await user.related('subscriptions').query().where('stripeId', data.id).first()
   if (!subscription) {
-    subscription = new Subscription()
+    subscription = new shopkeeper.subscriptionModel()
     subscription.stripeId = data.id
   }
 

src/invoice.ts

@@ -1,5 +1,5 @@
 import Stripe from 'stripe'
-import { ManagesInvoicesI, WithManagesInvoices } from './mixins/manages_invoices.js'
+import { WithManagesInvoices } from './mixins/manages_invoices.js'
 import { Tax } from './tax.js'
 import { Discount } from './discount.js'
 import { InvalidInvoiceError } from './errors/invalid_invoice.js'
@@ -216,8 +216,8 @@ export class Invoice {
     return (
       discounts.find((amount) =>
         typeof amount.discount === 'string'
-          ? amount.discount === discount.id
-          : amount.discount.id === discount.id
+          ? amount.discount === discount.asStripeDiscount().id
+          : amount.discount.id === discount.asStripeDiscount().id
       )?.amount ?? null
     )
   }
@@ -550,7 +550,7 @@ export class Invoice {
   /**
    * Get the Stripe model instance.
    */
-  owner(): ManagesInvoicesI {
+  owner(): WithManagesInvoices['prototype'] {
     return this.#owner
   }
 

src/middlewares/stripe_webhook_middleware.ts

@@ -0,0 +1,27 @@
+import { HttpContext } from '@adonisjs/core/http'
+import { NextFn } from '@adonisjs/core/types/http'
+import shopkeeper from '../../services/shopkeeper.js'
+
+export default class StripeWebhookMiddleware {
+  async handle({ request }: HttpContext, next: NextFn) {
+    const sig = request.header('stripe-signature')
+    const body = request.raw()
+
+    if (!body || !sig) {
+      throw new Error('') // TODO: Error
+    }
+
+    const valid = shopkeeper.stripe.webhooks.signature.verifyHeader(
+      body,
+      sig,
+      shopkeeper.config.webhook.secret!, // TODO: Error
+      shopkeeper.config.webhook.tolerance
+    )
+
+    if (!valid) {
+      throw new Error('') // TODO: Error
+    }
+
+    await next()
+  }
+}

src/mixins/handles_payment_failures.ts

@@ -1,5 +1,5 @@
 import Stripe from 'stripe'
-import { Subscription } from '../models/subscription.js'
+import Subscription from '../models/subscription.js'
 import { IncompletePaymentError } from '../errors/incomplete_payment.js'
 import { checkStripeError } from '../utils/errors.js'
 import { Payment } from '../payment.js'

src/mixins/handles_taxes.ts

@@ -3,66 +3,44 @@ import shopkeeper from '../../services/shopkeeper.js'
 
 type Constructor = new (...args: any[]) => {}
 
-export interface WithHandlesTaxes {
-  /**
-   * The IP address of the customer used to determine the tax location.
-   */
-  customerIpAddress: string | null
-
-  /**
-   * The pre-collected billing address used to estimate tax rates when performing "one-off" charges.
-   */
-  estimationBillingAddress: unknown[]
-
-  /**
-   * Indicates if Tax IDs should be collected during a Stripe Checkout session.
-   */
-  collectTaxIds: boolean
-
-  /**
-   * Set the The IP address of the customer used to determine the tax location.
-   */
-  withTaxIpAddress(ipAddress: string): void
-
-  /**
-   * Set a pre-collected billing address used to estimate tax rates when performing "one-off" charges.
-   */
-  withTaxAddress(country: string, postalCode?: string, state?: string): void
-
-  /**
-   * Get the payload for Stripe automatic tax calculation.
-   */
-  automaticTaxPayload(): unknown
-
-  /**
-   * Determine if automatic tax is enabled.
-   */
-  isAutomaticTaxEnabled(): boolean
-
-  /**
-   * Indicate that Tax IDs should be collected during a Stripe Checkout session.
-   */
-  withTaxIdsCollect(): void
-}
-
 export function HandlesTaxes<Model extends Constructor>(superclass: Model) {
   return class WithHandlesTaxes extends superclass implements WithHandlesTaxes {
+    /**
+     * The IP address of the customer used to determine the tax location.
+     */
     customerIpAddress: string | null = null
-    estimationBillingAddress: unknown[] = []
+
+    /**
+     * The pre-collected billing address used to estimate tax rates when performing "one-off" charges.
+     */
+    estimationBillingAddress: Partial<Stripe.Address> = {}
+
+    /**
+     * Indicates if Tax IDs should be collected during a Stripe Checkout session.
+     */
     collectTaxIds = false
 
+    /**
+     * Set the The IP address of the customer used to determine the tax location.
+     */
     withTaxIpAddress(ipAddress: string): void {
       this.customerIpAddress = ipAddress
     }
 
+    /**
+     * Set a pre-collected billing address used to estimate tax rates when performing "one-off" charges.
+     */
     withTaxAddress(country: string, postalCode?: string, state?: string): void {
       this.estimationBillingAddress = {
         country,
-        postalCode,
+        postal_code: postalCode,
         state,
       }
     }
 
+    /**
+     * Get the payload for Stripe automatic tax calculation.
+     */
     automaticTaxPayload(): Stripe.SubscriptionCreateParams.AutomaticTax {
       return {
         // TODO: Check if necessary
@@ -72,12 +50,20 @@ export function HandlesTaxes<Model extends Constructor>(superclass: Model) {
       }
     }
 
+    /**
+     * Determine if automatic tax is enabled.
+     */
     isAutomaticTaxEnabled(): boolean {
       return shopkeeper.calculateTaxes
     }
 
+    /**
+     * Indicate that Tax IDs should be collected during a Stripe Checkout session.
+     */
     withTaxIdsCollect(): void {
       this.collectTaxIds = true
     }
   }
 }
+
+export type WithHandlesTaxes = ReturnType<typeof HandlesTaxes>

src/mixins/manages_customer.ts

@@ -8,6 +8,7 @@ import { PromotionCode } from '../promotion_code.js'
 import { CustomerBalanceTransaction } from '../customer_balance_transaction.js'
 import { ManagesStripeI, WithManagesStripe } from './manages_stripe.js'
 import { NormalizeConstructor } from '@poppinss/utils/types'
+import { WithBillable } from './billable.js'
 
 export interface ManagesCustomerI extends ManagesStripeI<true> {
   /**
@@ -398,8 +399,10 @@ export function ManagesCustomer<Model extends Constructor>(superclass: Model) {
         ...params,
       })
 
+      // TODO: Fix as unknown
       return transactions.data.map(
-        (transaction) => new CustomerBalanceTransaction(this, transaction)
+        (transaction) =>
+          new CustomerBalanceTransaction(this as unknown as WithBillable['prototype'], transaction)
       )
     }
 
@@ -435,7 +438,8 @@ export function ManagesCustomer<Model extends Constructor>(superclass: Model) {
         ...params,
       })
 
-      return new CustomerBalanceTransaction(this, transaction)
+      // TODO: Fix as any
+      return new CustomerBalanceTransaction(this as any, transaction)
     }
 
     preferredCurrency(): string {