abmp-npm 1.0.0 → 1.1.1

package/.husky/pre-commit

@@ -0,0 +1,22 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+echo "Running ESLint check..."
+npm run lint
+
+if [ $? -ne 0 ]; then
+  echo "❌ ESLint check failed. Please fix the linting errors before committing."
+  exit 1
+fi
+
+echo "Running Prettier check..."
+npm run format:check
+
+if [ $? -ne 0 ]; then
+  echo "❌ Prettier check failed. Please format your code before committing."
+  echo "Run 'npm run format' to automatically format your files."
+  exit 1
+fi
+
+echo "✅ All checks passed!"
+

package/.prettierignore

@@ -0,0 +1,7 @@
+node_modules
+dist
+build
+coverage
+*.min.js
+package-lock.json
+

package/.prettierrc.json

@@ -0,0 +1,16 @@
+{
+  "singleQuote": true,
+  "trailingComma": "es5",
+  "printWidth": 100,
+  "tabWidth": 2,
+  "semi": true,
+  "bracketSpacing": true,
+  "bracketSameLine": false,
+  "arrowParens": "avoid",
+  "endOfLine": "lf",
+  "quoteProps": "as-needed",
+  "jsxSingleQuote": false,
+  "requirePragma": false,
+  "insertPragma": false,
+  "proseWrap": "preserve"
+}

package/README.md

@@ -0,0 +1 @@
+# abmp-npm

package/backend/automations-methods.js

@@ -0,0 +1,13 @@
+const { customTrigger } = require('@wix/automations');
+const { auth } = require('@wix/essentials');
+const triggerMethod = auth.elevate(customTrigger.runTrigger);
+
+const triggerAutomation = async (triggerId, payload) =>
+  await triggerMethod({
+    triggerId,
+    payload,
+  });
+
+module.exports = {
+  triggerAutomation,
+};

package/backend/consts.js

@@ -0,0 +1,18 @@
+const ELEVATED_QUERY_OPTIONS = {
+  suppressAuth: true,
+};
+
+/**
+ * Valid configuration keys for getSiteConfigs function
+ * @readonly
+ * @enum {string}
+ */
+const CONFIG_KEYS = {
+  AUTOMATION_EMAIL_TRIGGER_ID: 'AUTOMATION_EMAIL_TRIGGER_ID',
+  SITE_ASSOCIATION: 'SITE_ASSOCIATION',
+};
+
+module.exports = {
+  ELEVATED_QUERY_OPTIONS,
+  CONFIG_KEYS,
+};

package/backend/forms-methods.web.js

@@ -0,0 +1,54 @@
+const { items: wixData } = require('@wix/data');
+const { webMethod, Permissions } = require('@wix/web-methods');
+
+const { COLLECTIONS } = require('../public');
+
+const { triggerAutomation } = require('./automations-methods');
+const { CONFIG_KEYS, ELEVATED_QUERY_OPTIONS } = require('./consts');
+const { findMemberByWixDataId, createContactAndMemberIfNew } = require('./members-data-methods');
+const { getSiteConfigs } = require('./utils');
+
+const contactSubmission = webMethod(Permissions.Anyone, async (data, memberDataId) => {
+  const { firstName, lastName, email, phone, message } = data;
+  const [memberData, automationEmailTriggerId] = await Promise.all([
+    findMemberByWixDataId(memberDataId),
+    getSiteConfigs(CONFIG_KEYS.AUTOMATION_EMAIL_TRIGGER_ID),
+  ]);
+  if (!memberData.showContactForm) {
+    console.log('Member contact form is not enabled for user, skipping contact submission!');
+    return;
+  }
+  let memberContactId = memberData.contactId;
+  if (!memberContactId) {
+    /**
+     * Create a member contact here since some members may have never logged in
+     * and therefore don’t have a contact ID. However, these members can still
+     * appear in the directory, and site visitors can reach out to them if they’ve
+     * enabled their contact form. To handle this, we ensure a contact is created for
+     * them during this flow if it doesn’t already exist.
+     */
+    console.info('Member contact id not found for user, creating new contact!');
+    const member = await createContactAndMemberIfNew(memberData);
+    memberContactId = member.contactId;
+  }
+  console.log('memberContactId', memberContactId);
+  const emailTriggered = await triggerAutomation(automationEmailTriggerId, {
+    contactId: memberContactId,
+    name: `${firstName} ${lastName}`,
+    email: email,
+    phone: phone,
+    message: message,
+  });
+  data = {
+    ...data,
+    phone: Number(data.phone),
+    memberContactId: memberContactId,
+    memberEmail: memberData.contactFormEmail,
+  };
+  await wixData.insert(COLLECTIONS.CONTACT_US_SUBMISSIONS, data, ELEVATED_QUERY_OPTIONS);
+  return emailTriggered;
+});
+
+module.exports = {
+  contactSubmission,
+};

package/backend/members-area-methods.js

@@ -0,0 +1,36 @@
+const { auth } = require('@wix/essentials');
+const { members } = require('@wix/members');
+const elevatedCreateMember = auth.elevate(members.createMember);
+
+function prepareContactData(partner) {
+  const phones = Array.isArray(partner.phones) ? partner.phones : []; //some users don't have phones
+  const options = {
+    member: {
+      contact: {
+        ...partner,
+        phones,
+        emails: [partner.contactFormEmail || partner.email],
+      },
+      loginEmail: partner.email,
+    },
+  };
+  return options;
+}
+async function createMemberFunction(member) {
+  const newMember = await elevatedCreateMember(member);
+  return newMember._id;
+}
+const createSiteMember = async memberDetails => {
+  try {
+    const options = prepareContactData(memberDetails);
+    const contactId = await createMemberFunction(options);
+    return contactId;
+  } catch (error) {
+    console.error(`Error in createSiteMember ${error.message}`);
+    throw error;
+  }
+};
+
+module.exports = {
+  createSiteMember,
+};

package/backend/members-data-methods.js

@@ -0,0 +1,61 @@
+const { items: wixData } = require('@wix/data');
+
+const { COLLECTIONS } = require('../public');
+
+const { ELEVATED_QUERY_OPTIONS } = require('./consts');
+const { createSiteMember } = require('./members-area-methods');
+
+/**
+ * Retrieves member data by member ID
+ * @param {string} memberId - The member ID to search for
+ * @returns {Promise<Object|null>} - Member data or null if not found
+ */
+async function findMemberByWixDataId(memberId) {
+  if (!memberId) {
+    throw new Error('Member ID is required');
+  }
+  try {
+    const member = await wixData.get(COLLECTIONS.MEMBERS_DATA, memberId, ELEVATED_QUERY_OPTIONS);
+    return member;
+  } catch (error) {
+    throw new Error(`Failed to retrieve member data: ${error.message}`);
+  }
+}
+
+async function createContactAndMemberIfNew(memberData) {
+  if (!memberData) {
+    throw new Error('Member data is required');
+  }
+  try {
+    const toCreateMemberData = {
+      firstName: memberData.firstName,
+      lastName: memberData.lastName,
+      email: memberData.email,
+      phones: memberData.phones,
+      contactFormEmail: memberData.contactFormEmail || memberData.email,
+    };
+    const contactId = await createSiteMember(toCreateMemberData);
+    let memberDataWithContactId = {
+      ...memberData,
+      contactId,
+    };
+    const updatedResult = await wixData.update(
+      COLLECTIONS.MEMBERS_DATA,
+      memberDataWithContactId,
+      ELEVATED_QUERY_OPTIONS
+    );
+    memberDataWithContactId = {
+      ...memberDataWithContactId,
+      ...updatedResult,
+    };
+    return memberDataWithContactId;
+  } catch (error) {
+    console.error('Error creating contact and member if new:', error);
+    throw new Error(`Failed to create contact and member if new: ${error.message}`);
+  }
+}
+
+module.exports = {
+  findMemberByWixDataId,
+  createContactAndMemberIfNew,
+};

package/backend/utils.js

@@ -0,0 +1,39 @@
+const { items: wixData } = require('@wix/data');
+
+const { COLLECTIONS } = require('../public/consts');
+
+const { ELEVATED_QUERY_OPTIONS, CONFIG_KEYS } = require('./consts');
+
+/**
+ * Retrieves site configuration values from the database
+ * @param {string} [configKey] - The configuration key to retrieve. Must be one of:
+ *   - 'AUTOMATION_EMAIL_TRIGGER_ID' - Email template ID for triggered emails
+ *   - 'SITE_ASSOCIATION' - Site association configuration
+ * @returns {Promise<any>} The configuration value for the specified key, or all configs if no key provided
+ * @example
+ * // Get specific config
+ * const emailTemplateId = await getSiteConfigs('AUTOMATION_EMAIL_TRIGGER_ID');
+ *
+ * // Get all configs
+ * const allConfigs = await getSiteConfigs();
+ */
+const getSiteConfigs = async configKey => {
+  if (configKey && !Object.values(CONFIG_KEYS).includes(configKey)) {
+    throw new Error(
+      `Invalid configKey: ${configKey}. Must be one of: ${Object.values(CONFIG_KEYS).join(', ')}`
+    );
+  }
+  const siteConfigs = await wixData.get(
+    COLLECTIONS.SITE_CONFIGS,
+    'SINGLE_ITEM_ID',
+    ELEVATED_QUERY_OPTIONS
+  );
+  if (configKey) {
+    return siteConfigs[configKey];
+  }
+  return siteConfigs;
+};
+
+module.exports = {
+  getSiteConfigs,
+};

package/eslint.config.js

@@ -0,0 +1,113 @@
+const js = require('@eslint/js');
+const prettierConfig = require('eslint-config-prettier');
+const importPlugin = require('eslint-plugin-import');
+const prettier = require('eslint-plugin-prettier');
+const promisePlugin = require('eslint-plugin-promise');
+const globals = require('globals');
+
+module.exports = [
+  // Recommended base configurations
+  js.configs.recommended,
+  prettierConfig,
+
+  // Main configuration
+  {
+    files: ['**/*.js'],
+    languageOptions: {
+      ecmaVersion: 2021,
+      sourceType: 'commonjs',
+      globals: {
+        ...globals.node,
+        ...globals.es2021,
+        ...globals.jest,
+      },
+    },
+    plugins: {
+      prettier,
+      import: importPlugin,
+      promise: promisePlugin,
+    },
+    rules: {
+      // Error prevention
+      'no-var': 'error',
+      'no-unused-vars': ['error', { argsIgnorePattern: '^_', varsIgnorePattern: '^_' }],
+      'no-console': ['warn', { allow: ['warn', 'error', 'log', 'info'] }],
+      'no-debugger': 'warn',
+      'no-duplicate-imports': 'error',
+      'no-unused-expressions': ['error', { allowShortCircuit: true, allowTernary: true }],
+      'no-use-before-define': ['error', { functions: false }],
+
+      // Best practices
+      'prefer-const': 'error',
+      'no-const-assign': 'error',
+      'prefer-arrow-callback': 'error',
+      'arrow-body-style': ['error', 'as-needed'],
+      'no-return-await': 'off',
+      'require-await': 'warn',
+
+      // Import rules
+      'import/order': [
+        'error',
+        {
+          groups: ['builtin', 'external', 'internal', 'parent', 'sibling', 'index'],
+          'newlines-between': 'always',
+          alphabetize: { order: 'asc', caseInsensitive: true },
+        },
+      ],
+      'import/no-unresolved': 'error',
+      'import/no-duplicates': 'error',
+      'import/no-commonjs': 'off',
+      'import/no-dynamic-require': 'off',
+
+      // Promise rules
+      'promise/always-return': 'off',
+      'promise/no-return-wrap': 'error',
+      'promise/param-names': 'error',
+      'promise/catch-or-return': 'error',
+      'promise/no-native': 'off',
+      'promise/no-callback-in-promise': 'warn',
+      'promise/no-promise-in-callback': 'warn',
+      'promise/no-nesting': 'warn',
+
+      // Prettier rules
+      'prettier/prettier': [
+        'error',
+        {
+          singleQuote: true,
+          trailingComma: 'es5',
+          printWidth: 100,
+          tabWidth: 2,
+          semi: true,
+          bracketSpacing: true,
+          arrowParens: 'avoid',
+          endOfLine: 'lf',
+        },
+      ],
+    },
+    settings: {
+      'import/resolver': {
+        node: {
+          extensions: ['.js', '.jsx', '.ts', '.tsx'],
+        },
+      },
+    },
+  },
+
+  // Test files override
+  {
+    files: ['**/*.test.js', '**/*.spec.js'],
+    languageOptions: {
+      globals: {
+        ...globals.jest,
+      },
+    },
+    rules: {
+      'no-console': 'off',
+    },
+  },
+
+  // Ignore patterns
+  {
+    ignores: ['node_modules/**', 'dist/**', 'build/**', 'coverage/**', '*.min.js'],
+  },
+];

package/index.js

@@ -1,5 +1,5 @@
-function helloNpm() {
-    return "hello NPM"
-  }
-  
-  module.exports = helloNpm
+module.exports = {
+  ...require('./pages'),
+  ...require('./backend'),
+  ...require('./public'),
+};

package/package.json

@@ -1,11 +1,37 @@
 {
   "name": "abmp-npm",
-  "version": "1.0.0",
+  "version": "1.1.1",
   "main": "index.js",
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "lint": "eslint .",
+    "lint:fix": "eslint . --fix",
+    "format": "prettier --write \"**/*.{js,json,md}\"",
+    "format:check": "prettier --check \"**/*.{js,json,md}\"",
+    "prepare": "husky"
   },
   "author": "",
   "license": "ISC",
-  "description": ""
+  "description": "",
+  "devDependencies": {
+    "@eslint/js": "^9.12.0",
+    "eslint": "^9.12.0",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-plugin-import": "^2.30.0",
+    "eslint-plugin-prettier": "^5.2.1",
+    "eslint-plugin-promise": "^7.1.0",
+    "globals": "^15.10.0",
+    "husky": "^9.1.6",
+    "prettier": "^3.3.3"
+  },
+  "dependencies": {
+    "@wix/automations": "^1.0.261",
+    "@wix/crm": "^1.0.1061",
+    "@wix/data": "^1.0.303",
+    "@wix/essentials": "^0.1.28",
+    "@wix/members": "^1.0.330",
+    "@wix/site-window": "^1.44.0",
+    "@wix/web-methods": "^1.0.11",
+    "phone": "^3.1.67"
+  }
 }

package/pages/ContactUs.js

@@ -0,0 +1,131 @@
+const { lightbox } = require('@wix/site-window');
+const { phone } = require('phone');
+
+const { contactSubmission } = require('../backend/forms-methods.web.js');
+const { VALIDATION_MESSAGES, REGEX } = require('../public');
+
+async function contactUsOnReady(_$w) {
+  _$w('#submitButton').disable();
+  const receivedData = await lightbox.getContext();
+  const formFieldsSelectors = ['#firstName', '#lastName', '#email', '#phone', '#message'];
+  const inputOnCustomValidation = ({ value, reject, message, pattern }) => {
+    const isValid = typeof value === 'string' && pattern.test(value.trim());
+    if (!isValid) reject(message);
+  };
+  async function validateAllFields() {
+    let allValid = true;
+    for (const selector of formFieldsSelectors) {
+      const isValid = await _$w(selector).valid;
+      _$w(selector).updateValidityIndication();
+      if (!isValid) {
+        allValid = false;
+      }
+    }
+    return allValid;
+  }
+
+  function resetForm() {
+    formFieldsSelectors.forEach(selector => {
+      const field = _$w(selector);
+      if (field && field.reset) {
+        field.reset();
+      } else {
+        field.value = '';
+      }
+      if (field && field.resetValidityIndication) {
+        field.resetValidityIndication();
+      }
+    });
+  }
+
+  function setAlertMessage(message) {
+    const $message = _$w('#successMessage');
+    $message.text = message;
+    $message.expand();
+
+    setTimeout(() => {
+      $message.collapse();
+    }, 8000);
+  }
+  // First Name
+  _$w('#firstName').onCustomValidation((value, reject) => {
+    inputOnCustomValidation({
+      value,
+      reject,
+      message: VALIDATION_MESSAGES.CONTACT_US.FIRST_NAME,
+      pattern: REGEX.NAME,
+    });
+  });
+  // Last Name
+  _$w('#lastName').onCustomValidation((value, reject) => {
+    inputOnCustomValidation({
+      value,
+      reject,
+      message: VALIDATION_MESSAGES.CONTACT_US.LAST_NAME,
+      pattern: REGEX.NAME,
+    });
+  });
+  // Message
+  _$w('#message').onCustomValidation((value, reject) => {
+    inputOnCustomValidation({
+      value,
+      reject,
+      message: VALIDATION_MESSAGES.CONTACT_US.MESSAGE,
+      pattern: REGEX.MESSAGE,
+    });
+  });
+
+  // Email validation uses native input validation
+  // No custom validation needed as email input has built-in validation
+
+  // Phone (US format)
+  _$w('#phone').onCustomValidation((value, reject) => {
+    const { isValid } = phone(value, { country: 'US' });
+    if (!isValid) {
+      reject(VALIDATION_MESSAGES.CONTACT_US.PHONE);
+    }
+  });
+  _$w('#captchaInput').onVerified(async () => {
+    const allValid = await validateAllFields();
+    if (allValid) {
+      _$w('#submitButton').enable();
+      return;
+    }
+    _$w('#submitButton').disable();
+    setAlertMessage(VALIDATION_MESSAGES.CONTACT_US.CAPTCHA);
+    _$w('#captchaInput').reset();
+  });
+
+  _$w('#captchaInput').onTimeout(() => {
+    _$w('#submitButton').disable();
+  });
+  _$w('#submitButton').onClick(async () => {
+    const allValid = await validateAllFields();
+    if (!allValid) {
+      setAlertMessage(VALIDATION_MESSAGES.CONTACT_US.INVALID_FIELDS);
+      return;
+    }
+
+    try {
+      const formData = {
+        firstName: _$w('#firstName').value,
+        lastName: _$w('#lastName').value,
+        email: _$w('#email').value,
+        phone: _$w('#phone').value,
+        message: _$w('#message').value,
+      };
+
+      await contactSubmission(formData, receivedData._id);
+      await resetForm();
+
+      setAlertMessage(VALIDATION_MESSAGES.CONTACT_US.SUBMISSION_SUCCESS);
+    } catch (error) {
+      console.error('Submission failed:', error);
+      setAlertMessage(VALIDATION_MESSAGES.CONTACT_US.SUBMISSION_FAILED);
+    }
+  });
+}
+
+module.exports = {
+  contactUsOnReady,
+};

package/pages/index.js

@@ -0,0 +1,3 @@
+module.exports = {
+  ...require('./ContactUs.js'),
+};

package/public/consts.js

@@ -0,0 +1,15 @@
+const REGEX = {
+  NAME: /^[a-zA-Z\s'-]{2,}$/,
+  MESSAGE: /^[A-Za-z0-9\s.,!?'"-]{2,}$/,
+};
+
+const COLLECTIONS = {
+  MEMBERS_DATA: 'MembersDataLatest',
+  CONTACT_US_SUBMISSIONS: 'contactUsSubmissions',
+  SITE_CONFIGS: 'SiteConfigs',
+};
+
+module.exports = {
+  REGEX,
+  COLLECTIONS,
+};

package/public/index.js

@@ -0,0 +1,4 @@
+module.exports = {
+  ...require('./consts'),
+  ...require('./messages'),
+};

package/public/messages.js

@@ -0,0 +1,16 @@
+const VALIDATION_MESSAGES = {
+  CONTACT_US: {
+    FIRST_NAME: 'Please enter a valid first name.',
+    LAST_NAME: 'Please enter a valid last name.',
+    MESSAGE: 'Please enter a valid message.',
+    PHONE: 'Please enter a valid US phone number.',
+    CAPTCHA: 'Please fix the highlighted fields before captcha verification.',
+    INVALID_FIELDS: 'Please fix the highlighted fields before submitting.',
+    SUBMISSION_FAILED: 'An error occurred. Please try again.',
+    SUBMISSION_SUCCESS: 'Contact submitted successfully',
+  },
+};
+
+module.exports = {
+  VALIDATION_MESSAGES,
+};