backend-manager 3.1.12 → 3.2.0

package/CHANGELOG.md

@@ -15,6 +15,11 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 - `Security` in case of vulnerabilities.
 
 ---
+## [3.2.0] - 2023-12-19
+### Added
+- Added `.settings()` API. Put your settings in `./schema/*.js` and access them with `assistant.settings.*`.
+
+
 ## [3.1.0] - 2023-12-19
 ### Added
 - Added `.analytics()` API GA4 support.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "backend-manager",
-  "version": "3.1.12",
+  "version": "3.2.0",
   "description": "Quick tools for developing Firebase functions",
   "main": "src/manager/index.js",
   "bin": {
@@ -40,7 +40,7 @@
     "busboy": "^1.6.0",
     "chalk": "^4.1.2",
     "cors": "^2.8.5",
-    "dotenv": "^16.3.1",
+    "dotenv": "^16.3.2",
     "firebase-admin": "^11.11.1",
     "firebase-functions": "^4.6.0",
     "fs-jetpack": "^5.1.0",
@@ -55,7 +55,7 @@
     "moment": "^2.30.1",
     "nanoid": "^3.3.7",
     "node-fetch": "^2.7.0",
-    "node-powertools": "^1.1.1",
+    "node-powertools": "^1.1.2",
     "npm-api": "^1.0.1",
     "paypal-server-api": "^1.0.3",
     "pushid": "^1.0.0",
@@ -70,4 +70,4 @@
     "wonderful-log": "^1.0.5",
     "yargs": "^17.7.2"
   }
-}
+}

package/src/manager/helpers/assistant.js

@@ -36,6 +36,7 @@ BackendAssistant.prototype.init = function (ref, options) {
   // Attached libraries - used in .errorify()
   self.analytics = null;
   self.usage = null;
+  self.settings = null;
 
   // Set meta
   self.meta = {};

package/src/manager/helpers/middleware.js

@@ -26,10 +26,11 @@ Middleware.prototype.run = function (library, req, res, options) {
 
     // Set options
     options = options || {};
+    options.authenticate = typeof options.authenticate === 'boolean' ? options.authenticate : true;
     options.setupAnalytics = typeof options.setupAnalytics === 'boolean' ? options.setupAnalytics : true;
     options.setupUsage = typeof options.setupUsage === 'boolean' ? options.setupUsage : true;
-    options.authenticate = typeof options.authenticate === 'boolean' ? options.authenticate : true;
     options.setupSettings = typeof options.setupSettings === 'undefined' ? true : options.setupSettings;
+    options.schema = typeof options.schema === 'undefined' ? '' : options.schema;
 
     // Log
     assistant.log(`Middleware.process(): Request (${geolocation.ip} @ ${geolocation.country}, ${geolocation.region}, ${geolocation.city})`, JSON.stringify(data));
@@ -44,16 +45,16 @@ Middleware.prototype.run = function (library, req, res, options) {
       return assistant.errorify(`Unable to load library @ (${library}): ${e.message}`, {sentry: true, send: true, log: true});
     }
 
-    // Setup usage
-    if (options.setupUsage) {
-      assistant.usage = await Manager.Usage().init(assistant);
-    }
-
     // Setup user
     if (!options.setupUsage && options.authenticate) {
       await assistant.authenticate();
     }
 
+    // Setup usage
+    if (options.setupUsage) {
+      assistant.usage = await Manager.Usage().init(assistant);
+    }
+
     // Setup analytics
     if (options.setupAnalytics) {
       const uuid = assistant?.usage?.user?.auth?.uid
@@ -63,19 +64,16 @@ Middleware.prototype.run = function (library, req, res, options) {
       assistant.analytics = Manager.Analytics({
         assistant: assistant,
         uuid: uuid,
-      })
+      });
     }
 
     // Resolve settings
     if (options.setupSettings) {
-      // try {
-      //   const planId = assistant.request.user.plan.id;
-      //   let settings = path.resolve(basePath, `settings.js`);
-      //   settings = require(settings)(assistant)[planId];
-      //   assistant.request.data = powertools.defaults(data, settings);
-      // } catch (e) {
-      //   return assistant.errorify(`Unable to resolve settings @ (${library}): ${e.message}`, {sentry: true, send: true, log: true});
-      // }
+      try {
+        assistant.settings = Manager.Settings().resolve(assistant, options.schema, assistant.request.data);
+      } catch (e) {
+        return assistant.errorify(`Unable to resolve settings @ (${options.schema}): ${e.message}`, {sentry: true, send: true, log: true});
+      }
     }
 
     // Process

package/src/manager/helpers/settings.js

@@ -2,31 +2,81 @@
  * Settings
  *
  */
+// const jetpack = require('fs-jetpack');
+const path = require('path');
+const powertools = require('node-powertools');
+const _ = require('lodash');
+const moment = require('moment');
+
 function Settings(m) {
   const self = this;
 
   self.Manager = m;
 
-  self.user = null;
-
-  self.initialized = false;
+  self.settings = null;
 }
 
-Settings.prototype.resolve = function (assistant, options) {
+Settings.prototype.resolve = function (assistant, schema, settings) {
   const self = this;
+  const Manager = self.Manager;
+
+  // Set settings
+  schema = schema || {};
+  settings = settings || {};
+
+  // Reset settings
+  self.settings = null;
+
+  assistant.log('Resolving settings for', schema, settings);
+
+  if (typeof schema === 'string') {
+    const schemaPath = path.resolve(process.cwd(), `schemas/${schema.replace('.js', '')}.js`);
+
+    schema = loadSchema(assistant, schemaPath, settings);
+  }
 
-  return new Promise(async function(resolve, reject) {
-    const Manager = self.Manager;
+  self.settings = powertools.defaults(settings, schema);
 
-    // Set options
-    options = options || {};
+  // Resolve
+  return self.settings;
+};
+
+Settings.prototype.constant = function (name, options) {
+  const self = this;
+  const Manager = self.Manager;
 
-    // Set initialized to true
-    self.initialized = true;
+  options = options || {};
+  options.date = typeof options.date === 'undefined' ? moment() : moment(options.date);
 
-    // Resolve
-    return resolve(self);
-  });
+  if (name === 'timestamp') {
+    return {
+      types: ['string'],
+      value: undefined,
+      default: options.date.toISOString(),
+    }
+  } else if (name === 'timestampUNIX') {
+    return {
+      types: ['number'],
+      value: undefined,
+      default: options.date.unix(),
+    }
+  } else if (name === 'timestampFULL') {
+    return {
+      timestamp: self.constant('timestamp', options),
+      timestampUNIX: self.constant('timestampUNIX', options),
+    }
+  }
 };
 
+function loadSchema(assistant, schema, settings) {
+  const planId = assistant.request.user.plan.id;
+
+  const lib = require(schema)(assistant);
+  const def = lib.defaults;
+  const plan = lib[planId];
+
+  // Merge
+  return _.merge({}, def, plan);
+}
+
 module.exports = Settings;

package/src/manager/helpers/subscription-resolver.js

@@ -224,8 +224,9 @@ SubscriptionResolver.prototype.resolve = function (options) {
     resolved.details.message = 'Pre-payment authorization failed because there is no working payment method on file.'
   }
 
-  // If they got a refund, set the expiration to 0
-  if (resolved.payment.refunded) {
+  // If they got a refund (AND cancelled), set the expiration to 0
+  // This allows for partial refunds without disabling the subscription
+  if (resolved.payment.refunded && resolved.status === 'cancelled') {
     resolved.expires.timestamp = moment(0);
     resolved.details.message = 'Refund was issued so subscription is inactive.'
   }

package/src/manager/helpers/usage.js

@@ -84,9 +84,7 @@ Usage.prototype.init = function (assistant, options) {
         // TODO: Make it request using .where() query so it doesnt use a read if it doesnt have to
         foundUsage = await Manager.libraries.admin.firestore().doc(`temporary/usage`)
           .get()
-          .then((r) => {
-            return r.data()?.[`${self.key}`];
-          })
+          .then((r) => _.get(r.data(), self.key))
           .catch((e) => {
             assistant.errorify(`Usage.init(): Error fetching usage data: ${e}`, {sentry: true, send: false, log: true});
           });