@adtrackify/at-service-common 1.0.39 → 1.0.41

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adtrackify/at-service-common",
-  "version": "1.0.39",
+  "version": "1.0.41",
   "description": "",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -38,7 +38,7 @@
     "@types/axios": "^0.14.0"
   },
   "devDependencies": {
-    "@adtrackify/at-tracking-event-types": "^1.0.21",
+    "@adtrackify/at-tracking-event-types": "^1.0.22",
     "@babel/cli": "^7.13.16",
     "@babel/core": "^7.13.10",
     "@babel/plugin-proposal-optional-chaining": "^7.13.8",

package/src/clients/internal-api/users-auth-client.ts

@@ -1,5 +1,12 @@
-import { axiosHttpService } from '../generic/http-client';
+import { User } from '@adtrackify/at-tracking-event-types';
 import * as log from 'lambda-log';
+import { ApiResponse } from '../../types/api-response';
+import { axiosHttpService } from '../generic/http-client';
+
+export interface UserResponseData {
+  user: User;
+  [ key: string ]: any;
+}
 
 export class UsersAuthClient {
 
@@ -33,7 +40,7 @@ export class UsersAuthClient {
     return signupUserResponse;
   };
 
-  getUserByEmail = async (email: string) => {
+  getUserByEmail = async (email: string): Promise<ApiResponse<UserResponseData>> => {
     const client = await this.getClient();
     const getUserResponse = await client.get('/lookup', {
       headers: {

package/src/helpers/index.ts

@@ -1,3 +1,4 @@
 export * from './input-validation-helper';
 export * from './logging-helper';
-export * from './response-helper'
+export * from './response-helper';
+export * from './shopify-helper';

package/src/helpers/input-validation-helper.ts

@@ -1,13 +1,13 @@
-import { HttpError } from '../libs/http-error';
-import * as log from 'lambda-log';
 import Joi from 'joi';
+import * as log from 'lambda-log';
+import { HttpError } from '../libs/http-error';
 
 export const validateInput = (schema: Joi.ObjectSchema<any>, input: any) => {
   const { error, value } = schema.validate(input);
   if (error) {
     log.info('', { error });
 
-    const httperr = HttpError.badRequest('Input Validation Failure', {
+    const httperr = HttpError.badRequest('Bad Request', {
       errors: error.details.map(detail => ({
         message: detail?.message,
         key: detail?.context?.key,

package/src/helpers/shopify-helper.ts

@@ -0,0 +1,39 @@
+import { createHmac } from 'crypto';
+import * as log from 'lambda-log';
+import { HttpError } from '../libs';
+import { mapObjectToQueryString } from '../libs/url';
+export interface ShopifyRequestValidationParameters {
+  code: string,
+  hmac?: string,
+  shop: string,
+  state: string,
+  timestamp: string;
+}
+
+export const isShopifyRequestValid = (validationParams: ShopifyRequestValidationParameters, validationHmac: string, shopifyAppApiSecret: string): boolean => {
+  // remove hmac if it exists
+  // map input to query string
+  // generate hash using api secret key and validate it matches hmac
+  delete validationParams.hmac;
+  const hmacString = mapObjectToQueryString(validationParams);
+
+
+  const generatedHash = createHmac('sha256', shopifyAppApiSecret)
+    .update(hmacString)
+    .digest('hex');
+
+  return generatedHash === validationHmac;
+};
+
+export const validateShopifyRequest = (validationParams: ShopifyRequestValidationParameters, validationHmac: string, shopifyAppApiSecret: string) => {
+  log.info('Validating shopify request is authentic', { validationParams });
+  const isValid = isShopifyRequestValid(validationParams, validationHmac as string, shopifyAppApiSecret);
+  if (!isValid) {
+    const message = 'Failed: Shopify Request hmac validation';
+    log.error(message);
+    throw HttpError.badRequest(message);
+  }
+  log.info('Sucess: Shopify Request hmac validation');
+  return true;
+}
+

package/src/libs/index.ts

@@ -1,7 +1,7 @@
+export * from '../helpers/shopify-helper';
 export * from './crypto';
 export * from './dates';
 export * from './http-error';
 export * from './http-status-codes';
-export * from './shopify';
 export * from './url';
 

package/src/libs/shopify.ts

@@ -1,25 +0,0 @@
-import { createHmac } from 'crypto';
-import { mapObjectToQueryString } from './url';
-
-export interface ShopifyRequestValidationParameters {
-  code: string,
-  hmac?: string,
-  shop: string,
-  state: string,
-  timestamp: string;
-}
-
-export const validateShopifyAppParameters = (validationParams: ShopifyRequestValidationParameters, validationHmac: string, shopifyAppApiSecret: string) => {
-  // remove hmac if it exists
-  // map input to query string
-  // generate hash using api secret key and validate it matches hmac
-  delete validationParams.hmac;
-  const hmacString = mapObjectToQueryString(validationParams);
-
-
-  const generatedHash = createHmac('sha256', shopifyAppApiSecret)
-    .update(hmacString)
-    .digest('hex');
-
-  return generatedHash === validationHmac;
-};