backend-manager 3.2.100 → 3.2.102

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "backend-manager",
-  "version": "3.2.100",
+  "version": "3.2.102",
   "description": "Quick tools for developing Firebase functions",
   "main": "src/manager/index.js",
   "bin": {

package/src/manager/functions/core/actions/api/admin/create-post-new.js

@@ -0,0 +1,190 @@
+const fetch = require('wonderful-fetch');
+const moment = require('moment');
+const jetpack = require('fs-jetpack');
+const powertools = require('node-powertools');
+const uuidv4 = require('uuid').v4;
+
+const POST_TEMPLATE = jetpack.read(`${__dirname}/templates/post.html`);
+const IMAGE_TAG = `{%- include /master/helpers/blog-image.html name="{name}" alt="{alt}" -%}`;
+const IMAGE_PATH_SRC = `./assets/_src/images/blog/posts/post-{id}/`;
+const IMAGE_PATH_REG = `/assets/images/blog/posts/post-{id}/`;
+const AD_TAG = `{% include /master/modules/adunits/adsense-in-article.html index="{index}" %}`;
+
+const IMAGE_REGEX = /(?:!\[(.*?)\]\((.*?)\))/img;
+const LINK_REGEX = /(?:\[(.*?)\]\((.*?)\))/img;
+
+function Module() {
+
+}
+
+Module.prototype.main = function () {
+  const self = this;
+  const Manager = self.Manager;
+  const Api = self.Api;
+  const assistant = self.assistant;
+  const payload = self.payload;
+
+  return new Promise(async function(resolve, reject) {
+    // Perform checks
+    if (!payload.user.roles.admin && !payload.user.roles.blogger) {
+      return reject(assistant.errorify(`Admin required.`, {code: 401}));
+    }
+
+    // Log payload
+    assistant.log(`main(): payload.data`, payload.data);
+
+    // Set now
+    const now = assistant.meta.startTime.timestamp;
+    const bemRepo = assistant.parseRepo(Manager?.config?.github?.repo_website);
+
+    // Check for required values
+    if (!payload.data.payload.title) {
+      return reject(assistant.errorify(`Missing required parameter: title`, {code: 400}));
+    } else if (!payload.data.payload.url) {
+      return reject(assistant.errorify(`Missing required parameter: url`, {code: 400}));
+    } else if (!payload.data.payload.excerpt) {
+      return reject(assistant.errorify(`Missing required parameter: excerpt`, {code: 400}));
+    } else if (!payload.data.payload.headerImageURL) {
+      return reject(assistant.errorify(`Missing required parameter: headerImageURL`, {code: 400}));
+    } else if (!payload.data.payload.body) {
+      return reject(assistant.errorify(`Missing required parameter: body`, {code: 400}));
+    }
+
+    // Fix other values
+    payload.data.payload.author = payload.data.payload.author || 'alex';
+    payload.data.payload.affiliate = payload.data.payload.affiliate || '';
+    payload.data.payload.tags = payload.data.payload.tags || '';
+    payload.data.payload.categories = payload.data.payload.categories || '';
+
+    // Fix even more values
+    payload.data.payload.layout = payload.data.payload.layout || 'app/blog/post';
+    payload.data.payload.date = payload.data.payload.date || moment(now).format('YYYY-MM-DD');
+    payload.data.payload.id = payload.data.payload.id || Math.round(new Date(now).getTime() / 1000);
+    payload.data.payload.path = payload.data.payload.path || `./_posts/${moment(now).format('YYYY')}/guest`;
+    payload.data.payload.githubUser = payload.data.payload.githubUser || bemRepo.user;
+    payload.data.payload.githubRepo = payload.data.payload.githubRepo || bemRepo.name;
+
+    // Log
+    assistant.log(`main(): Creating post...`, payload.data.payload);
+
+    // Extract all images
+    await self.extractImages();
+
+    // Set defaults
+    const finalContent = powertools.template(POST_TEMPLATE, payload.data.payload);
+
+    // Log
+    assistant.log(`main(): finalContent`, finalContent);
+
+  });
+
+};
+
+// Extract images
+Module.prototype.extractImages = function () {
+  const self = this;
+  const Manager = self.Manager;
+  const Api = self.Api;
+  const assistant = self.assistant;
+  const payload = self.payload;
+
+  return new Promise(async function(resolve, reject) {
+    // Extract images
+    const matches = payload.data.payload.body.matchAll(IMAGE_REGEX);
+    const images = Array.from(matches).map(match => ({
+      src: match[2] || '',
+      alt: match[1] || uuidv4(),
+    }));
+
+    // Log
+    assistant.log(`extractImages(): images`, images);
+
+    if (!images) {
+      return resolve();
+    }
+
+    // Loop through images
+    for (let index = 0; index < images.length; index++) {
+      const image = images[index];
+
+      // download image
+      const download = await self.downloadImage(image.src, image.alt);
+
+      // Log
+      assistant.log(`extractImages(): download`, download);
+
+      // const src = image.src;
+      // const alt = image.alt;
+      // const hyphenated = hyphenate(alt);
+      // const tag = powertools.template(IMAGE_TAG, {name: hyphenate(alt), alt: alt});
+
+      // console.log(`Image ${index + 1}: src=${image.src}, alt='${image.alt}'`);
+    }
+
+      // const image = images[i];
+      // const src = image.match(LINK_REGEX)[2];
+      // const alt = image.match(LINK_REGEX)[1] || uuidv4();
+      // const name = hyphenate(alt);
+      // const tag = IMAGE_TAG.replace('{name}', name).replace('{alt}', alt);
+
+      // // Log
+      // assistant.log(`extractImages(): original`, image.match(LINK_REGEX));
+      // assistant.log(`extractImages(): image`, image);
+      // assistant.log(`extractImages(): src`, src);
+      // assistant.log(`extractImages(): alt`, alt);
+      // assistant.log(`extractImages(): name`, name);
+      // assistant.log(`extractImages(): tag`, tag);
+
+      // // Replace image
+      // payload.data.payload.body = payload.data.payload.body
+      //   .replace(image, tag);
+
+      // // Save image
+      // await self.saveImage(src, id, name);
+
+    // Resolve
+    return resolve();
+  });
+};
+
+// Downlaod image
+Module.prototype.downloadImage = function (src, alt) {
+  const self = this;
+  const Manager = self.Manager;
+  const Api = self.Api;
+  const assistant = self.assistant;
+  const payload = self.payload;
+
+  return new Promise(async function(resolve, reject) {
+    // Log
+    assistant.log(`downloadImage(): src=${src}, alt=${alt}`);
+
+    // Get image
+    const image = await fetch(src, {
+      method: 'GET',
+      download: true,
+    })
+    .then((r) => {
+      // Log
+      assistant.log(`downloadImage(): Result`, r);
+
+      // Save image
+      return resolve(r);
+    })
+    .catch((e) => reject(e));
+  });
+};
+
+function hyphenate(s) {
+  return s
+    // Remove everything that is not a letter or a number
+    .replace(/[^a-zA-Z0-9]/g, '-')
+    // Replace multiple hyphens with a single hyphen
+    .replace(/-+/g, '-')
+    // Remove leading and trailing hyphens
+    .replace(/^-|-$/g, '')
+    // Lowercase
+    .toLowerCase();
+}
+
+module.exports = Module;

package/src/manager/functions/core/actions/api/admin/templates/post.html

@@ -0,0 +1,15 @@
+---
+### ALL PAGES ###
+layout: {layout}
+
+### POST ONLY ###
+post:
+  title: "{title}"
+  excerpt: "{excerpt}"
+  author: {author}
+  id: {id}
+  tags: {tags}
+  categories: {categories}
+  affiliate-search-term: {affiliate}
+---
+{body}

package/src/manager/functions/core/events/auth/on-create.js

@@ -118,10 +118,12 @@ Module.prototype.main = function () {
     if (user.providerData.filter(function (item) {
       if (item.providerId !== 'anonymous') {
         analytics.event({
-          category: 'engagement',
-          action: 'signup',
-          label: item.providerId,
+          name: 'sign_up',
+          params: {
+            method: item.providerId,
+          },
         });
+
         return true
       }
     }).length < 1) {

package/src/manager/functions/core/events/auth/on-delete.js

@@ -33,9 +33,8 @@ Module.prototype.main = function () {
       uuid: user.uid,
     })
     .event({
-      category: 'engagement',
-      action: 'user-delete',
-      // label: 'regular',
+      name: 'user-delete',
+      params: {},
     });
 
     // Delete user record

package/src/manager/functions/core/events/firestore/on-subscription.js

@@ -57,9 +57,8 @@ Module.prototype.main = function () {
             uuid: _.get(dataBefore, 'link.user.data.uid', undefined),
           })
           .event({
-            category: 'engagement',
-            action: 'notification-unsubscribe',
-            // label: 'regular',
+            name: 'notification-unsubscribe',
+            params: {},
           });
 
           assistant.log('Notification subscription deleted:', dataBefore);
@@ -87,9 +86,8 @@ Module.prototype.main = function () {
             uuid: _.get(dataAfter, 'link.user.data.uid', undefined),
           })
           .event({
-            category: 'engagement',
-            action: 'notification-subscribe',
-            // label: 'regular',
+            name: 'notification-subscribe',
+            params: {},
           });
 
           assistant.log('Notification subscription created:', dataAfter);

package/src/manager/functions/test/authenticate.js

@@ -24,11 +24,10 @@ let Module = {
         uuid: user.auth.uid,
       })
       .event({
-        category: 'admin',
-        action: 'authenticate-test',
-        // label: '',
+        name: 'authenticate-test',
+        params: {},
       });
-            
+
       assistant.log('Request:', assistant.request.data);
       assistant.log('Result user:', user);
       return res.status(200).json({status: 200, user: user });

package/src/manager/functions/test/create-test-accounts.js

@@ -25,9 +25,8 @@ let Module = {
         uuid: user.auth.uid,
       })
       .event({
-        category: 'admin',
-        action: 'create-test-accounts',
-        // label: '',
+        name: 'create-test-accounts',
+        params: {},
       });
 
       let assistant = self.assistant;

package/src/manager/functions/test/webhook.js

@@ -24,9 +24,8 @@ let Module = {
         uuid: user.auth.uid,
       })
       .event({
-        category: 'admin',
-        action: 'webhook-test',
-        // label: '',
+        name: 'webhook-test',
+        params: {},
       });
 
       assistant.log(assistant.request);

package/src/manager/helpers/analytics.js

@@ -1,5 +1,6 @@
 const fetch = require('wonderful-fetch');
 const moment = require('moment');
+const crypto = require('crypto');
 let uuidv5;
 
 const UUID_REGEX = /[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}/;
@@ -25,6 +26,7 @@ function Analytics(Manager, options) {
     ip: self.assistant?.request?.geolocation?.ip || '127.0.0.1',
     country: self.assistant?.request?.geolocation?.country || '',
     city: self.assistant?.request?.geolocation?.city || '',
+    region: self.assistant?.request?.geolocation?.region || '',
     referrer: self.assistant?.request?.referrer || '',
     userAgent: self.assistant?.request?.client?.userAgent || '',
     language: (self.assistant?.request?.client?.language || '').split(',')[0],
@@ -45,13 +47,14 @@ function Analytics(Manager, options) {
   options.pageview = typeof options.pageview === 'undefined' ? true : options.pageview;
   options.version = options.version || Manager.package.version;
   options.userProperties = options.userProperties || {};
+  options.userData = options.userData || {};
 
   // Set user
   // https://www.optimizesmart.com/how-to-create-and-use-user-properties-in-ga4/
   // https://developers.google.com/analytics/devguides/collection/protocol/ga4/user-properties?client_type=gtag
   // https://support.google.com/analytics/answer/12980150?hl=en&co=GENIE.Platform%3DAndroid
   const authUser = self.assistant?.usage?.user;
-  self.user = {
+  self.userProperties = {
     app_version: {
       value: options.version,
     },
@@ -126,9 +129,33 @@ function Analytics(Manager, options) {
     // dr? (referrer)
   };
 
+  // Fix user data
+  // https://developers.google.com/analytics/devguides/collection/ga4/uid-data
+  self.userData = {
+    sha256_email_address: authUser?.auth?.email
+      ? toSHA256(authUser?.auth?.email)
+      : undefined,
+    sha256_phone_number: authUser?.personal?.telephone?.number
+      ? toSHA256(authUser?.personal?.telephone?.countryCode + authUser?.personal?.telephone?.number)
+      : undefined,
+    address: {
+      sha256_first_name: authUser?.personal?.name?.first
+        ? toSHA256(authUser?.personal?.name?.first)
+        : undefined,
+      sha256_last_name: authUser?.personal?.name?.last
+        ? toSHA256(authUser?.personal?.name?.last)
+        : undefined,
+      // sha256_street: TODO,
+      city: self.request.city || undefined,
+      region: self.request.region || undefined,
+      // postal_code: TODO,
+      country: self.request.country || undefined,
+    }
+  }
+
   // Merge user properties
-  self.user = {
-    ...self.user,
+  self.userProperties = {
+    ...self.userProperties,
     ...options.userProperties,
   };
 
@@ -169,7 +196,8 @@ Analytics.prototype.generateId = function (id) {
   const assistant = self.assistant;
   const options = self.options;
   const request = self.request;
-  const user = self.user;
+  const userProperties = self.userProperties;
+  const userData = self.userData;
 
   // Load uuidv5
   uuidv5 = uuidv5 || require('uuid').v5;
@@ -189,7 +217,8 @@ Analytics.prototype.event = function (payload) {
   const assistant = self.assistant;
   const options = self.options;
   const request = self.request;
-  const user = self.user;
+  const userProperties = self.userProperties;
+  const userData = self.userData;
 
   // Fix payload
   // https://support.google.com/analytics/answer/13316687?hl=en#zippy=%2Cweb
@@ -271,14 +300,14 @@ Analytics.prototype.event = function (payload) {
   //     ]
   // }
 
-
   // Build url and body
   const url = `https://www.google-analytics.com/mp/collect?measurement_id=${self.analyticsId}&api_secret=${self.analyticsSecret}`;
   const body = {
     client_id: self.options.uuid,
     user_id: self.options.uuid,
     // timestamp_micros: new Date().getTime() * 1000,
-    user_properties: user,
+    user_properties: userProperties,
+    user_data: userData,
     // consent: {},
     // non_personalized_ads: false,
     events: [payload],
@@ -422,4 +451,16 @@ Analytics.prototype.event = function (payload) {
 //   return self;
 // };
 
+/*
+Unlike gtag, which automatically hashes sensitive user-provided data, the Measurement Protocol requires a developer to hash sensitive user-provided data using a secure one-way hashing algorithm called SHA256 and encode it using hex string format prior to calling the API.
+
+All user data fields starting with the sha256 prefix in their name should be only populated with hashed and hex-encoded values.
+
+The following example code performs the necessary encryption and encoding steps:
+*/
+
+function toSHA256(value) {
+  return crypto.createHash('sha256').update(value).digest('hex');
+}
+
 module.exports = Analytics;

package/src/manager/index.js

@@ -450,46 +450,16 @@ Manager.prototype.init = function (exporter, options) {
   }
 
   // Send analytics
-  // self.Analytics({
-  //   assistant: self.assistant,
-  //   uuid: self.SERVER_UUID,
-  //   isDevelopment: false,
-  // })
-  // .event({
-  //   // category: 'admin',
-  //   // action: 'initialized',
-  //   // label: '',
-  //   // name: 'admin/initialized',
-  //   // name: 'screen_view',
-  //   // params: {
-  //   //   screen_class: 'MainActivity',
-  //   // },
-  // });
-
-  // self.Analytics({
-  //   assistant: self.assistant,
-  //   // uuid: '256675177.1692831448',
-  //   // uuid: self.SERVER_UUID,
-  //   uuid: 'a5b43c29-7bb3-514b-b7bb-33782cd8d802',
-  //   isDevelopment: false,
-  // })
-  // .event({
-  //   "name": "purchase",
-  //   "params": {
-  //     "transaction_id": "T12345",
-  //     "value": 123.45,
-  //     "currency": "USD",
-  //     "items": [
-  //       {
-  //         "item_id": "sku1234",
-  //         "item_name": "widget",
-  //         "quantity": 1,
-  //         "item_brand": "Google",
-  //         "price": 123.45
-  //       }
-  //     ]
-  //   }
-  // });
+  self.Analytics({
+    assistant: self.assistant,
+    uuid: self.SERVER_UUID,
+  })
+  .event({
+    name: 'admin/initialized',
+    params: {
+      // screen_class: 'MainActivity',
+    },
+  });
 
   // Return
   return self;