chore: update readme

Author: stfsy

README.md

@@ -46,15 +46,14 @@ npm install @discue/paddle-integration-mongodb
 ### Preparing a New Subscription
 For the webhooks integration to work and to be able to correlate incoming hooks with the correct subscription, a placeholder needs to be created **before the checkout** and - afterward - a specific value must be passed to the [Checkout API](https://developer.paddle.com/guides/ZG9jOjI1MzU0MDQz-pass-parameters-to-the-checkout) via the `passthrough` parameter. This value will be returned by the `addSubscriptionPlaceholder` method.
 
-You can see in the example below, the Subscriptions constructor is called with the name of the target `collection` and the id of the target document. The id could be your `user` or `api_client` id. Remember: the target document must exist before creating the placeholder.
-
 ```js
 'use strict'
 
 const readApiClient = require('./lib/your-application/read-api-client')
 const paddleIntegration = require('@discue/paddle-integration-mongodb')
-// pass the path to the collection here
-const subscriptions = new paddleIntegration.SubscriptionHooks('api_clients')
+
+const storage = paddleIntegration.subscriptionStorage({ url: 'mongodb://localhost:27017' })
+const subscriptions = new paddleIntegration.SubscriptionHooks({ storage })
 
 module.exports = async (req, res, next) => {
     // requires application to read api_client information 

README_HOOK_BODY_PARSER.md

@@ -11,13 +11,13 @@ const express = require('express')
 const app = express()
 const port = process.env.PORT || 3456
 
-const paddleIntegrationFirestore = require('@discue/paddle-firebase-integration')
-// pass the path to the collection here
-const subscriptions = new paddleIntegrationFirestore.SubscriptionHooks('api_clients')
+const paddleIntegration = require('@discue/paddle-integration-mongodb')
+const storage = paddleIntegration.subscriptionStorage({ url: 'mongodb://localhost:27017' })
+const subscriptions = new paddleIntegration.SubscriptionHooks({ storage })
 
 // register body parser first and middleware second
-app.use('/_/payments', paddleIntegrationFirestore.bodyparser())
-app.post('/_/payments', paddleIntegrationFirestore.middleware(subscriptions))
+app.use('/_/payments', paddleIntegration.bodyparser())
+app.post('/_/payments', paddleIntegration.middleware(subscriptions))
 
 module.exports = app.listen(port)
 ```

README_HOOK_MIDDLEWARE.md

@@ -18,8 +18,8 @@ const app = express()
 const port = process.env.PORT || 3456
 
 const paddleIntegration = require('@discue/paddle-firebase-integration')
-// pass the path to the collection here
-const subscriptions = new paddleIntegration.SubscriptionHooks('api_clients')
+const storage = paddleIntegration.subscriptionStorage({ url: 'mongodb://localhost:27017' })
+const subscriptions = new paddleIntegration.SubscriptionHooks({ storage })
 
 // register body parser first and middleware second
 app.use('/_/payments', paddleIntegration.bodyparser())

README_SUBSCRIPTION_API.md

@@ -19,7 +19,7 @@ Low level wrapper for Paddle API.
     - [List products](#list-products)
     - [Refund a payment](#refund-a-payment)
 
-:information_source: The API component will be loaded asynchronously to preserve backwards compatibility with commonjs. This is achieved by returning a proxy for the entire `paddle-integration-firestore` module. The reactivity a proxy provides allows us to add the API module then at a later point to the module instance. The drawback is, we do not return named exports and, therefore, cannot not enable destructuring in ES modules.
+:information_source: The API component will be loaded asynchronously to preserve backwards compatibility with commonjs. This is achieved by returning a proxy for the entire `paddle-integration-mongodb` module. The reactivity a proxy provides allows us to add the API module then at a later point to the module instance. The drawback is, we do not return named exports and, therefore, cannot not enable destructuring in ES modules.
 
 ## Creating a new instance
 To create a new instance, four parameters need to be passed to the constructor:

README_SUBSCRIPTION_HYDRATION.md

@@ -7,7 +7,7 @@ Due to limitations of the Paddle API some assumptions will be made, like derivin
   - [Hydrate subscription created](#hydrate-subscription-created)
   - [Hydrate subscription cancelled](#hydrate-subscription-cancelled)
 
-:information_source: The API component of this module will be loaded asynchronously to preserve backwards compatibility with commonjs. This is achieved by returning a proxy for the entire `paddle-integration-firestore` module. The reactivity a proxy provides allows us to add the API module then at a later point to the module instance. The drawback is, we do not return named exports and, therefore, cannot not enable destructuring in ES modules.
+:information_source: The API component of this module will be loaded asynchronously to preserve backwards compatibility with commonjs. This is achieved by returning a proxy for the entire `paddle-integration-mongodb` module. The reactivity a proxy provides allows us to add the API module then at a later point to the module instance. The drawback is, we do not return named exports and, therefore, cannot not enable destructuring in ES modules.
 
 ## Hydrate subscription created
 Fetches subscription-related information from Paddle API to initialize the local storage. Has various safety measures to ensure users **cannot** hydrate their own subscriptions from already existing ones. 
@@ -18,18 +18,21 @@ Uses the `subscription_id` to contact Paddle API and checks whether the given lo
 'use strict'
 
 const paddleIntegration = require('@discue/paddle-firebase-integration')
-// initialize api and subscription hooks first
+
 const api = new paddleIntegration.Api({ useSandbox: true, authCode: process.env.AUTH_CODE, vendorId: process.env.VENDOR_ID })
-const hookStorage = new paddleIntegration.SubscriptionHooks('api_clients')
-const subscriptions = new paddleIntegration.SubscriptionHydration('api_clients', { api, hookStorage })
+const storage = paddleIntegration.subscriptionStorage({ url: 'mongodb://localhost:27017' })
+const hookStorage = new paddleIntegration.SubscriptionHooks({ storage })
+const subscriptionInfo = new paddleIntegration.SubscriptionInfo({ api, storage })
+
+const subscriptions = new paddleIntegration.SubscriptionHydration('api_clients', { api, hookStorage, subscriptionInfo })
 
 router.post('/subscriptions/initialize', async (req, res) => {
     const { _dsq: { clientId } = {}, body } = req
     const { subscription_id, checkout_id } = body
 
     await errorHandler(res, async () => {
         try {
-            await subscriptionInfo.hydrateSubscriptionCreated([clientId], { subscription_id }, checkout_id)
+            await subscriptions.hydrateSubscriptionCreated([clientId], { subscription_id }, checkout_id)
             sendOkNoContent({ res })
         } catch (e) {
             console.error(`Hydration failed with ${e} at ${e.stack}}`)
@@ -42,7 +45,7 @@ router.post('/subscriptions/initialize', async (req, res) => {
 
 In your front end application, use the `customData` function of this module to create the validation object, that is required during hydration. The `usePaddleCheckout` below will populate the `checkoutOptions` object with necessary values and open the Paddle checkout.
 ```js
-import { customData as createCustomData } from '@discue/paddle-integration-firestore/client'
+import { customData as createCustomData } from '@discue/paddle-integration-mongodb/client'
 
 export const checkoutDefaults = {
     allowQuantity: false,
@@ -95,10 +98,13 @@ Uses the `subscription_id` to contact Paddle API and checks whether the given lo
 'use strict'
 
 const paddleIntegration = require('@discue/paddle-firebase-integration')
-// initialize api and subscription hooks first
+
 const api = new paddleIntegration.Api({ useSandbox: true, authCode: process.env.AUTH_CODE, vendorId: process.env.VENDOR_ID })
-const hookStorage = new paddleIntegration.SubscriptionHooks('api_clients')
-const subscriptions = new paddleIntegration.SubscriptionHydration('api_clients', { api, hookStorage })
+const storage = paddleIntegration.subscriptionStorage({ url: 'mongodb://localhost:27017' })
+const hookStorage = new paddleIntegration.SubscriptionHooks({ storage })
+const subscriptionInfo = new paddleIntegration.SubscriptionInfo({ api, storage })
+
+const subscriptions = new paddleIntegration.SubscriptionHydration('api_clients', { api, hookStorage, subscriptionInfo })
 
 router.post('/subscriptions/cancel', async (req, res) => {
     const { _dsq: { clientId } = {}, body } = req
@@ -109,7 +115,7 @@ router.post('/subscriptions/cancel', async (req, res) => {
             // cancel subscription
             // ..
             // then hydrate cancellation
-            await subscriptionInfo.hydrateSubscriptionCancelled([clientId], { subscription_id })
+            await subscriptions.hydrateSubscriptionCancelled([clientId], { subscription_id })
             sendOkNoContent({ res })
         } catch (e) {
             console.error(`Hydration failed with ${e} at ${e.stack}}`)

README_SUBSCRIPTION_INFO.md

@@ -9,7 +9,7 @@ High level wrapper for Paddle API. Manages locally stored data and interacts wit
   - [Cancel a subscription](#cancel-a-subscription)
   - [Update a subscription plan](#update-a-subscription-plan)
 
-:information_source: The API component of this module will be loaded asynchronously to preserve backwards compatibility with commonjs. This is achieved by returning a proxy for the entire `paddle-integration-firestore` module. The reactivity a proxy provides allows us to add the API module then at a later point to the module instance. The drawback is, we do not return named exports and, therefore, cannot not enable destructuring in ES modules.
+:information_source: The API component of this module will be loaded asynchronously to preserve backwards compatibility with commonjs. This is achieved by returning a proxy for the entire `paddle-integration-mongodb` module. The reactivity a proxy provides allows us to add the API module then at a later point to the module instance. The drawback is, we do not return named exports and, therefore, cannot not enable destructuring in ES modules.
 
 ## Get subscription infos
 Returns all available information about a subscription. Will include the `start` and (optionally) `end` date, the `status_trail`, and the `payments_trail` and a property indicating whether the subscription is currently `active`.
@@ -20,7 +20,8 @@ Returns all available information about a subscription. Will include the `start`
 const paddleIntegration = require('@discue/paddle-firebase-integration')
 const api = new paddleIntegration.Api({ useSandbox: true, authCode: process.env.AUTH_CODE, vendorId: process.env.VENDOR_ID })
 // pass the path to the collection here
-const subscriptions = new paddleIntegration.SubscriptionInfo('api_clients', { api })
+const storage = paddleIntegration.subscriptionStorage({ url: 'mongodb://localhost:27017' })
+const subscriptions = new paddleIntegration.SubscriptionInfo({ api, storage })
 
 const PREMIUM_SUBSCRIPTION_PLAN_ID = '123'
 
@@ -51,7 +52,8 @@ Returns list of payments for for all subscriptions associated with the given use
 const paddleIntegration = require('@discue/paddle-firebase-integration')
 const api = new paddleIntegration.Api({ useSandbox: true, authCode: process.env.AUTH_CODE, vendorId: process.env.VENDOR_ID })
 // pass the path to the collection here
-const subscriptions = new paddleIntegration.SubscriptionInfo('api_clients', { api })
+const storage = paddleIntegration.subscriptionStorage({ url: 'mongodb://localhost:27017' })
+const subscriptions = new paddleIntegration.SubscriptionInfo({ api, storage })
 
 const PREMIUM_SUBSCRIPTION_PLAN_ID = '123'
 
@@ -80,7 +82,8 @@ Returns list of payments for for all subscriptions associated with the given use
 const paddleIntegration = require('@discue/paddle-firebase-integration')
 const api = new paddleIntegration.Api({ useSandbox: true, authCode: process.env.AUTH_CODE, vendorId: process.env.VENDOR_ID })
 // pass the path to the collection here
-const subscriptions = new paddleIntegration.SubscriptionInfo('api_clients', { api })
+const storage = paddleIntegration.subscriptionStorage({ url: 'mongodb://localhost:27017' })
+const subscriptions = new paddleIntegration.SubscriptionInfo({ api, storage })
 
 const PREMIUM_SUBSCRIPTION_PLAN_ID = '123'
 
@@ -109,7 +112,8 @@ Will return the status for all subscriptions associated with the given user/api_
 const paddleIntegration = require('@discue/paddle-firebase-integration')
 const api = new paddleIntegration.Api({ useSandbox: true, authCode: process.env.AUTH_CODE, vendorId: process.env.VENDOR_ID })
 // pass the path to the collection here
-const subscriptions = new paddleIntegration.SubscriptionInfo('api_clients', { api })
+const storage = paddleIntegration.subscriptionStorage({ url: 'mongodb://localhost:27017' })
+const subscriptions = new paddleIntegration.SubscriptionInfo({ api, storage })
 
 const PREMIUM_SUBSCRIPTION_PLAN_ID = '123'
 
@@ -139,7 +143,8 @@ Cancels a specific subscription plan. The subscription plan id must be passed.
 const paddleIntegration = require('@discue/paddle-firebase-integration')
 const api = new paddleIntegration.Api({ useSandbox: true, authCode: process.env.AUTH_CODE, vendorId: process.env.VENDOR_ID })
 // pass the path to the collection here
-const subscriptions = new paddleIntegration.SubscriptionInfo('api_clients', { api })
+const storage = paddleIntegration.subscriptionStorage({ url: 'mongodb://localhost:27017' })
+const subscriptions = new paddleIntegration.SubscriptionInfo({ api, storage })
 
 const PREMIUM_SUBSCRIPTION_PLAN_ID = '123'
 
@@ -163,7 +168,8 @@ Updates a subscription plan. The previous one will be cancelled and the new one
 const paddleIntegration = require('@discue/paddle-firebase-integration')
 const api = new paddleIntegration.Api({ useSandbox: true, authCode: process.env.AUTH_CODE, vendorId: process.env.VENDOR_ID })
 // pass the path to the collection here
-const subscriptions = new paddleIntegration.SubscriptionInfo('api_clients', { api })
+const storage = paddleIntegration.subscriptionStorage({ url: 'mongodb://localhost:27017' })
+const subscriptions = new paddleIntegration.SubscriptionInfo({ api, storage })
 
 const PREMIUM_SUBSCRIPTION_PLAN_ID = '123'