@evershop/evershop 1.0.0-beta

package/src/modules/auth/migration/Version-1.0.0.js

@@ -0,0 +1,31 @@
+const { execute } = require('@evershop/mysql-query-builder');
+const { pool } = require('../../../lib/mysql/connection');
+
+// eslint-disable-next-line no-multi-assign
+module.exports = exports = async () => {
+  await execute(pool, `DROP TABLE IF EXISTS \`admin_user\``);
+  await execute(pool, `CREATE TABLE \`admin_user\` (
+  \`admin_user_id\` int(10) unsigned NOT NULL AUTO_INCREMENT,
+  \`uuid\` varchar(255) DEFAULT replace(uuid(),'-',''),
+  \`status\` smallint(5) unsigned NOT NULL,
+  \`email\` varchar(255) NOT NULL,
+  \`password\` varchar(255) NOT NULL,
+  \`full_name\` varchar(255) DEFAULT NULL,
+  \`created_at\` timestamp NOT NULL DEFAULT current_timestamp(),
+  \`updated_at\` timestamp NOT NULL DEFAULT current_timestamp() ON UPDATE current_timestamp(),
+  PRIMARY KEY (\`admin_user_id\`),
+  UNIQUE KEY \`EMAIL_UNIQUE\` (\`email\`)
+) ENGINE=InnoDB DEFAULT CHARSET=utf8 COMMENT='Admin user';
+`);
+
+  await execute(pool, `CREATE TABLE \`user_token_secret\` (
+  \`user_token_secret_id\` int(10) unsigned NOT NULL AUTO_INCREMENT,
+  \`user_id\` varchar(255) NOT NULL,
+  \`secret\` varchar(255) NOT NULL,
+  \`created_at\` timestamp NOT NULL DEFAULT current_timestamp(),
+  \`updated_at\` timestamp NOT NULL DEFAULT current_timestamp() ON UPDATE current_timestamp(),
+  PRIMARY KEY (\`user_token_secret_id\`),
+  UNIQUE KEY \`USER_TOKEN_USER_ID\` (\`user_id\`)
+) ENGINE=InnoDB DEFAULT CHARSET=utf8 COMMENT='User token secret';
+`);
+};

package/src/modules/auth/pages/admin/adminLogin/LoginForm.js

@@ -0,0 +1,58 @@
+import React from 'react';
+import { Field } from '../../../../../lib/components/form/Field';
+import { Form } from '../../../../../lib/components/form/Form';
+import './LoginForm.scss';
+import UserCircleIcon from '@heroicons/react/solid/esm/UserCircleIcon';
+
+export default function LoginForm({ authUrl, dashboardUrl }) {
+  const [error, setError] = React.useState(null);
+
+  const onSuccess = (response) => {
+    if (response.success) {
+      window.location.href = dashboardUrl;
+    } else {
+      setError(response.message);
+    }
+  }
+  return <div className='admin-login-form'>
+    <div className='flex items-center justify-center mb-2'>
+      <UserCircleIcon width={60} height={60} fill="var(--primary)" />
+    </div>
+    {error && <div className="text-critical py-1">{error}</div>}
+    <Form
+      action={authUrl}
+      method="POST"
+      id="adminLoginForm"
+      isJSON={true}
+      onSuccess={onSuccess}
+      btnText="Login"
+    >
+      <Field
+        name="email"
+        type="email"
+        label="Email"
+        placeholder="Email"
+        validationRules={['notEmpty', 'email']}
+      />
+      <Field
+        name="password"
+        type="password"
+        label="Password"
+        placeholder="Password"
+        validationRules={['notEmpty']}
+      />
+    </Form>
+  </div>
+}
+
+export const layout = {
+  areaId: 'content',
+  sortOrder: 10
+}
+
+export const query = `
+  query Query {
+    authUrl: url(routeId: "adminAuth")
+    dashboardUrl: url(routeId: "dashboard")
+  }
+`

package/src/modules/auth/pages/admin/adminLogin/LoginForm.scss

@@ -0,0 +1,53 @@
+#app {
+  .header {
+    display: none;
+  }
+  .content-wrapper {
+    margin-top: 0;
+  }
+  .admin-navigation {
+    display: none;
+  }
+  .main-content {
+    margin-left: 0;
+  }
+
+  .main-content-inner {
+    display: flex;
+    justify-content: center;
+    justify-items: center;
+    align-items: center;
+  }
+  .admin-login-form {
+    width: 468px;
+    max-width: 80%;
+    background-color: white;
+    border-radius: 5px;
+    padding: 4rem;
+    -webkit-box-shadow: 6px 12px 60px rgb(0 0 0 / 20%);
+    box-shadow: 6px 12px 60px rgb(0 0 0 / 20%);
+
+    h1 {
+      font-size: 3rem;
+      margin-bottom: 1rem;
+      font-weight: 400;
+      text-align: center;
+    }
+        .form-submit-button {
+          button {
+            width: 100%;
+            padding: 1.2rem 1.6rem
+          }
+        }
+    
+        .form-field-container {
+          label {
+            color: #666
+          }
+        }
+        input[type=text], input[type=password] {
+          padding: 0.8rem 1.2rem
+        }
+  }
+  
+}

package/src/modules/auth/pages/admin/adminLogin/index.js

@@ -0,0 +1,16 @@
+const { getContextValue, setContextValue } = require("../../../../graphql/services/contextHelper");
+
+module.exports = (request, response, stack, next) => {
+  // Check if the user is logged in
+  const tokenPayload = getContextValue(request, 'tokenPayload');
+  if (tokenPayload && tokenPayload.isAdmin) {
+    // Redirect to admin dashboard
+    response.redirect(buildUrl('dashboard'));
+  } else {
+    setContextValue(request, 'pageInfo', {
+      title: 'Admin Login',
+      description: 'Admin Login'
+    });
+    next();
+  }
+}

package/src/modules/auth/pages/admin/adminLogin/route

@@ -0,0 +1,2 @@
+GET
+/login

package/src/modules/auth/pages/admin/all/AdminUser.js

@@ -0,0 +1,49 @@
+import React from 'react';
+import './AdminUser.scss';
+
+export default function AdminUser({ adminUser, logoutUrl }) {
+  const [showLogout, setShowLogout] = React.useState(false);
+
+  const show = (e) => {
+    e.preventDefault();
+    setShowLogout(!showLogout);
+  }
+
+  if (!adminUser) {
+    return null;
+  }
+  const { fullName, email } = adminUser;
+  return <div className='admin-user flex flex-grow justify-end items-center'>
+    <div className='flex justify-items-start gap-1 justify-center'>
+      <div className='relative'>
+        <a className='first-letter' href="#" onClick={(e) => show(e)}>{fullName[0]}</a>
+        {showLogout && <div className='logout bg-background shadow p-2'>
+          <div>
+            <div>
+              Hello <span className='text-primary'>{fullName}!</span>
+            </div>
+            <div className='mt-1'>
+              <a className='text-critical' href={logoutUrl}>Logout</a>
+            </div>
+          </div>
+        </div>}
+      </div>
+    </div>
+  </div>;
+}
+
+export const layout = {
+  areaId: 'header',
+  sortOrder: 50
+}
+
+export const query = `
+  query Query {
+    adminUser(id: getContextValue("userId", null)) {
+      adminUserId
+      fullName
+      email
+    },
+    logoutUrl: url(routeId: "adminLogout")
+  }
+`

package/src/modules/auth/pages/admin/all/AdminUser.scss

@@ -0,0 +1,20 @@
+.admin-user {
+  .first-letter {
+    width: 3.5rem;
+    height: 3.5rem;
+    display: flex;
+    align-items: center;
+    justify-content: center;
+    border-radius: 100%;
+    background-color: #82ca9d;
+    font-weight: 600;
+    border: 3px solid #4c8f65;
+  }
+  .logout {
+    position: absolute;
+    right: 0;
+    top: 115%;
+    width: 230px;
+    background-color: white
+  }
+}

package/src/modules/auth/pages/admin/all/[tokenVerify]auth.js

@@ -0,0 +1,20 @@
+const { getContextValue, setContextValue } = require('../../../../graphql/services/contextHelper');
+const { buildUrl } = require('../../../../../lib/router/buildUrl');
+const { get } = require('../../../../../lib/util/get');
+
+module.exports = (request, response, stack, next) => {
+  // Get the token Payload
+  const tokenPayLoad = getContextValue(request, 'tokenPayload');
+  // If there is no token or is not admin, redirect to login page
+  if (!tokenPayLoad || !get(tokenPayLoad, 'user.isAdmin')) {
+    // Check if current route is adminLogin
+    if (request.currentRoute.id === 'adminLogin') {
+      next();
+    } else {
+      response.redirect(buildUrl('adminLogin'));
+    }
+  } else {
+    setContextValue(request, 'userId', parseInt(tokenPayLoad.user.adminUserId, 10));
+    next();
+  }
+};

package/src/modules/auth/pages/global/[context]tokenVerify.js

@@ -0,0 +1,60 @@
+const jwt = require('jsonwebtoken');
+const { setContextValue } = require('../../../graphql/services/contextHelper');
+const { v4: uuidv4 } = require('uuid');
+const { getTokenCookieId } = require('../../services/getTokenCookieId');
+const { getTokenSecret } = require('../../services/getTokenSecret');
+const { generateToken } = require('../../services/generateToken');
+const { get } = require('../../../../lib/util/get');
+const { buildUrl } = require('../../../../lib/router/buildUrl');
+const { getAdminTokenCookieId } = require('../../services/getAdminTokenCookieId');
+const { select } = require('@evershop/mysql-query-builder');
+const { pool } = require('../../../../lib/mysql/connection');
+
+module.exports = async (request, response, stack, next) => {
+  const cookieId = request.currentRoute.isAdmin ? getAdminTokenCookieId() : getTokenCookieId();
+  // Get the jwt token from the cookies
+  const token = request.cookies[cookieId];
+  // If there is no token, generate a new one for guest user
+  if (!token) {
+    // Issue a new token for guest user
+    const payload = { user: null, sid: uuidv4() };
+    const newToken = generateToken(payload);
+    // Set the new token in the cookies
+    response.cookie(cookieId, newToken, { maxAge: 172800000, httpOnly: true });
+    setContextValue(request, 'tokenPayload', payload);
+    // Continue to the next middleware
+    next();
+  } else {
+    // Get user from token
+    const tokenPayload = jwt.decode(token, { complete: true, json: true });
+    let secret;
+    // Get the secret from database
+    const check = await select()
+      .from('user_token_secret')
+      .where('user_id', '=', get(tokenPayload, 'payload.user.uuid', null))
+      .load(pool);
+
+    if (!check) { // This is guest user
+      secret = getTokenSecret();
+    } else {
+      secret = check.secret;
+    }
+
+    // Verify the token
+    jwt.verify(token, secret, (err, decoded) => {
+      if (err) {
+        const payload = { user: null, sid: uuidv4() };
+        // Issue a new token for guest user
+        const newToken = generateToken(payload);
+        setContextValue(request, 'tokenPayload', decoded);
+        // Set the new token in the cookies
+        response.cookie(cookieId, newToken, { maxAge: 172800000, httpOnly: true });
+        // Redirect to home page
+        response.redirect(buildUrl('homepage'));
+      } else {
+        setContextValue(request, 'tokenPayload', decoded);
+        next();
+      }
+    });
+  }
+};

package/src/modules/auth/services/TokenGenerator.js

@@ -0,0 +1,27 @@
+const jwt = require('jsonwebtoken');
+
+function TokenGenerator(secretOrPrivateKey, secretOrPublicKey, options) {
+  this.secretOrPrivateKey = secretOrPrivateKey;
+  this.secretOrPublicKey = secretOrPublicKey;
+  this.options = options; //algorithm + keyid + noTimestamp + expiresIn + notBefore
+}
+
+TokenGenerator.prototype.sign = function (payload, signOptions) {
+  const jwtSignOptions = Object.assign({}, signOptions, this.options);
+  return jwt.sign(payload, this.secretOrPrivateKey, jwtSignOptions);
+}
+
+// refreshOptions.verify = options you would use with verify function
+// refreshOptions.jwtid = contains the id for the new token
+TokenGenerator.prototype.refresh = function (token, refreshOptions) {
+  const payload = jwt.verify(token, this.secretOrPublicKey, refreshOptions.verify);
+  delete payload.iat;
+  delete payload.exp;
+  delete payload.nbf;
+  delete payload.jti; //We are generating a new token, if you are using jwtid during signing, pass it in refreshOptions
+  const jwtSignOptions = Object.assign({}, this.options, { jwtid: refreshOptions.jwtid });
+  // The first signing converted all needed options into claims, they are already in the payload
+  return jwt.sign(payload, this.secretOrPrivateKey, jwtSignOptions);
+}
+
+module.exports = TokenGenerator;

package/src/modules/auth/services/generateToken.js

@@ -0,0 +1,13 @@
+const jwt = require('jsonwebtoken');
+const { getTokenLifeTime } = require('./getTokenLifeTime');
+const { getTokenSecret } = require('./getTokenSecret');
+
+module.exports.generateToken = (payload, options = {}, cb) => {
+  const { expiresIn = getTokenLifeTime(), secret = getTokenSecret() } = options;
+  const token = jwt.sign(payload, secret, { expiresIn });
+  if (cb) {
+    cb(token);
+  } else {
+    return token;
+  }
+}

package/src/modules/auth/services/getAdminTokenCookieId.js

@@ -0,0 +1,5 @@
+const { getConfig } = require("../../../lib/util/getConfig")
+
+module.exports.getAdminTokenCookieId = () => {
+  return getConfig("jwt.adminCookieId", "admin_token");
+}

package/src/modules/auth/services/getTokenCookieId.js

@@ -0,0 +1,5 @@
+const { getConfig } = require("../../../lib/util/getConfig")
+
+module.exports.getTokenCookieId = () => {
+  return getConfig("jwt.cookieId", "token");
+}

package/src/modules/auth/services/getTokenLifeTime.js

@@ -0,0 +1,5 @@
+const { getConfig } = require("../../../lib/util/getConfig");
+
+module.exports.getTokenLifeTime = () => {
+  return getConfig('jwt.web_token_life_time', '2d');
+}

package/src/modules/auth/services/getTokenSecret.js

@@ -0,0 +1,5 @@
+const { getConfig } = require("../../../lib/util/getConfig");
+
+module.exports.getTokenSecret = () => {
+  return getConfig("jwt.web_token_secret", "secret");
+}

package/src/modules/auth/services/refreshToken.js

@@ -0,0 +1,34 @@
+const jwt = require('jsonwebtoken');
+const { getTokenLifeTime } = require('./getTokenLifeTime');
+const { getTokenSecret } = require('./getTokenSecret');
+
+module.exports.refreshToken = function refreshToken(token, refreshOptions = {}, cb) {
+  const payload = jwt.verify(token, getTokenSecret(), refreshOptions.verify);
+  delete payload.iat;
+  delete payload.exp;
+  delete payload.nbf;
+  delete payload.jti; //We are generating a new token, if you are using jwtid during signing, pass it in refreshOptions
+  const jwtSignOptions = Object.assign({}, { expiresIn: getTokenLifeTime() }, { jwtid: refreshOptions.jwtid });
+  // The first signing converted all needed options into claims, they are already in the payload
+  const newToken = jwt.sign(payload, getTokenSecret(), jwtSignOptions);
+  if (cb) {
+    cb(newToken);
+  } else {
+    return newToken;
+  }
+}
+
+module.exports.signToken = (payload, options, cb) => {
+  const secretKey = options.secretKey || getTokenSecret();
+  delete payload.iat;
+  delete payload.exp;
+  delete payload.nbf;
+  delete payload.jti; //We are generating a new token, if you are using jwtid during signing, pass it in refreshOptions
+  const jwtSignOptions = Object.assign({}, { expiresIn: getTokenLifeTime() }, options);
+  const newToken = jwt.sign(payload, secretKey, jwtSignOptions);
+  if (cb) {
+    cb(newToken);
+  } else {
+    return newToken;
+  }
+}

package/src/modules/base/api/admin/all/[context]isAdmin[auth].js

@@ -0,0 +1,4 @@
+module.exports = (request, response) => {
+  request.isAdmin = true;
+  response.context.isAdmin = true;
+};

package/src/modules/base/api/global/[apiResponse]apiErrorHandler.js

@@ -0,0 +1,25 @@
+// eslint-disable-next-line no-unused-vars
+module.exports = async (err, request, response, stack, next) => {
+  console.log(err)
+  // Set this flag to make sure this middleware only be executed 1 time
+  response.locals.errorHandlerTriggered = true;
+  const promises = [];
+  Object.keys(stack).forEach((id) => {
+    // Check if middleware is async
+    if (stack[id] instanceof Promise) {
+      promises.push(stack[id]);
+    }
+  });
+
+  // Wait for all executing async middleware to be settled before sending response
+  await Promise.allSettled(promises);
+  // Check if the header is already sent or not.
+  if (response.headersSent) {
+    return; //TODO: Write a log message or next(error)?.
+  } else {
+    response.status(500).json({
+      success: false,
+      message: err.message
+    });
+  }
+};

package/src/modules/base/api/global/[auth]apiResponse[apiErrorHandler].js

@@ -0,0 +1,33 @@
+/* eslint-disable global-require */
+/* eslint-disable guard-for-in */
+/* eslint-disable import/no-import-module-exports */
+const isErrorHandlerTriggered = require('../../../../lib/middleware/isErrorHandlerTriggered');
+
+module.exports = async (request, response, delegate, next) => {
+  /** Get all promise delegate */
+  const promises = [];
+  Object.keys(delegate).forEach((id) => {
+    // Check if middleware is async
+    if (delegate[id] instanceof Promise) {
+      promises.push(delegate[id]);
+    }
+  });
+
+  try {
+    /** Wait for all async middleware to be completed */
+    await Promise.all(promises);
+
+    /** If a rejected middleware called next(error) without throwing an error */
+    if (isErrorHandlerTriggered(response)) {
+      return;
+    } else {
+      response.json(response.$body || {});
+    }
+  } catch (error) {
+    if (!isErrorHandlerTriggered(response)) {
+      next(error);
+    } else {
+      // Do nothing here since the next(error) is already called when the error is thrown on each middleware
+    }
+  }
+};

package/src/modules/base/api/global/context.js

@@ -0,0 +1,31 @@
+const { pool } = require("../../../../lib/mysql/connection");
+const { setContextValue, hasContextValue } = require("../../../graphql/services/contextHelper");
+
+module.exports = (request, response) => {
+  response.context = {};
+  /** Some default context value */
+  if (!hasContextValue(request, 'pool')) {
+    setContextValue(request.app, 'pool', pool);
+  }
+  setContextValue(request.app, 'homeUrl', `${request.protocol}://${request.get('host')}`);
+  setContextValue(request, 'currentUrl', `${request.protocol}://${request.get('host')}${request.originalUrl}`);
+  setContextValue(request, 'baseUrl', request.baseUrl)
+  setContextValue(request, 'body', request.body)
+  setContextValue(request, 'cookies', request.cookies)
+  setContextValue(request, 'fresh', request.fresh)
+  setContextValue(request.app, 'hostname', request.hostname)
+  setContextValue(request, 'ip', request.ip)
+  setContextValue(request, 'ips', request.ips)
+  setContextValue(request, 'method', request.method)
+  setContextValue(request, 'originalUrl', request.originalUrl)
+  setContextValue(request, 'params', request.params)
+  setContextValue(request, 'path', request.path)
+  setContextValue(request, 'protocol', request.protocol)
+  setContextValue(request, 'query', request.query)
+  setContextValue(request, 'route', request.route)
+  setContextValue(request, 'secure', request.secure)
+  setContextValue(request, 'signedCookies', request.signedCookies)
+  setContextValue(request, 'stale', request.stale)
+  setContextValue(request, 'subdomains', request.subdomains)
+  setContextValue(request, 'xhr', request.xhr)
+};

package/src/modules/base/graphql/types/Country/Country.graphql

@@ -0,0 +1,8 @@
+type Country {
+  name: String!
+  code: String!
+}
+
+extend type Query {
+  countries (countries: [String]) : [Country]
+}

package/src/modules/base/graphql/types/Country/Country.resolvers.js

@@ -0,0 +1,31 @@
+const { contries } = require("../../../../../lib/locale/countries")
+
+module.exports = {
+  Query: {
+    countries: (_, argument) => {
+      let list = argument?.countries || [];
+      if (list.length === 0) {
+        return contries
+      } else {
+        return contries.filter((c) => list.includes(c.code));
+      }
+    }
+  },
+  Country: {
+    name: (country) => {
+      if (country.name) {
+        return country.name
+      } else {
+        const c = contries.find((p) => p.code === country);
+        return c.name;
+      }
+    },
+    code: (country) => {
+      if (country.code) {
+        return country.code
+      } else {
+        return country;
+      }
+    }
+  }
+}

package/src/modules/base/graphql/types/Currency/Currency.graphql

@@ -0,0 +1,8 @@
+type Currency {
+  name: String!
+  code: String!
+}
+
+extend type Query {
+  currencies: [Currency]!
+}

package/src/modules/base/graphql/types/Currency/Currency.resolvers.js

@@ -0,0 +1,9 @@
+const { currencies } = require("../../../../../lib/locale/currencies")
+
+module.exports = {
+  Query: {
+    currencies: () => {
+      return currencies;
+    }
+  }
+}

package/src/modules/base/graphql/types/DateTime/DateTime.graphql

@@ -0,0 +1,5 @@
+type DateTime {
+  value: String!
+  timezone: String!
+  text(format: String): String!
+}

package/src/modules/base/graphql/types/DateTime/DateTime.resolvers.js

@@ -0,0 +1,18 @@
+const { DateTime } = require('luxon');
+const { getSetting } = require("../../../../setting/services/setting");
+
+module.exports = {
+  DateTime: {
+    value: (dateTime) => dateTime,
+    timezone: async () => await getSetting('storeTimeZone', 'UTC'),
+    text: async (value, { format = 'LLL dd yyyy' }, context) => {
+      if (!DateTime.fromSQL(value).isValid) {
+        return null;
+      }
+      const timeZone = await getSetting('storeTimeZone', 'UTC');
+      const language = await getSetting('storeLanguage', 'en');
+      const date = DateTime.fromSQL(value, { zone: timeZone }).setLocale(language).setZone(timeZone).toFormat(format);
+      return date;
+    }
+  }
+}

package/src/modules/base/graphql/types/Province/Province.graphql

@@ -0,0 +1,9 @@
+type Province {
+  name: String!
+  code: String!
+  countryCode: String!
+}
+
+extend type Query {
+  provinces (countries: [String]) : [Province]
+}

package/src/modules/base/graphql/types/Province/Province.resolvers.js

@@ -0,0 +1,38 @@
+const { provinces } = require("../../../../../lib/locale/provinces");
+
+module.exports = {
+  Query: {
+    provinces: (_, { countries = [] }) => {
+      if (countries.length === 0) {
+        return provinces
+      } else {
+        return provinces.filter((p) => countries.includes(p.countryCode));
+      }
+    }
+  },
+  Province: {
+    name: (province) => {
+      if (province.name) {
+        return province.name
+      } else {
+        const p = provinces.find((p) => p.code === province);
+        return p.name;
+      }
+    },
+    countryCode: (province) => {
+      if (province.countryCode) {
+        return province.countryCode
+      } else {
+        const p = provinces.find((p) => p.code === province);
+        return p.countryCode;
+      }
+    },
+    code: (province) => {
+      if (province.code) {
+        return province.code
+      } else {
+        return province;
+      }
+    }
+  }
+}

package/src/modules/base/graphql/types/Timezone/Timezone.graphql

@@ -0,0 +1,8 @@
+type Timezone {
+  name: String!
+  code: String!
+}
+
+extend type Query {
+  timezones: [Timezone]!
+}