@adtrackify/at-service-common 1.0.73 → 1.0.75

package/src/clients/internal-api/shopify-app-install-client.ts

@@ -1,59 +1,59 @@
-import log from 'lambda-log';
-import { ApiResponse } from '../../types/api-response';
-import { axiosHttpService } from '../generic/http-client';
-import { ShopifyAppInstall, ShopifyAppSubscriptionStatus } from '@adtrackify/at-tracking-event-types';
-//const BASE_API_URL = process.env.BASE_API_URL;
-//const DESTINATIONS_API_KEY = process.env.DESTINATIONS_API_KEY;
-
-export interface ShopifyAppInstallResponseData {
-  shopifyAppInstall: ShopifyAppInstall;
-  [ key: string ]: any;
-}
-
-export interface UpdateShopifyAppInstallRequest {
-  appSubscriptionStatus?: ShopifyAppSubscriptionStatus,
-  pixelId?: string,
-  shopifyAppInstallId: string;
-  isAppEnabled?: boolean;
-}
-
-export class ShopifyAppInstallClient {
-
-  public BASE_API_URL: string;
-  public SHOPIFY_APP_INSTALL_API_KEY: string;
-
-  constructor (baseApiUrl: string, shopifyAppInstallApiKey: string) {
-    this.BASE_API_URL = baseApiUrl;
-    this.SHOPIFY_APP_INSTALL_API_KEY = shopifyAppInstallApiKey;
-  }
-
-  getConfig = () => {
-    const SERVICE_API_ROOT_URL = `${this.BASE_API_URL}/shopify-app-installs`;
-    return {
-      baseURL: SERVICE_API_ROOT_URL,
-      headers: {
-        common: {
-          'x-api-key': this.SHOPIFY_APP_INSTALL_API_KEY
-        }
-      }
-    };
-  };
-
-  getClient = async () => {
-    return axiosHttpService(this.getConfig());
-  };
-
-  updateShopifyAppInstall = async (shopifyAppInstallId: string, updateShopifyAppInstallRequest: UpdateShopifyAppInstallRequest): Promise<ApiResponse<ShopifyAppInstallResponseData>> => {
-    const client = await this.getClient();
-    const response = await client.put(`/${shopifyAppInstallId}`, updateShopifyAppInstallRequest);
-    log.info('updateShopifyAppInstall', { response });
-    return response as ApiResponse<ShopifyAppInstallResponseData>;
-  };
-
-  getShopifyAppInstall = async (shopifyAppInstallId: string): Promise<ApiResponse<ShopifyAppInstallResponseData>> => {
-    const client = await this.getClient();
-    const response = await client.get(`/${shopifyAppInstallId}`);
-    log.info('getShopifyAppInstall', { response });
-    return response as ApiResponse<ShopifyAppInstallResponseData>;
-  };
-}
+import log from 'lambda-log';
+import { ApiResponse } from '../../types/api-response';
+import { axiosHttpService } from '../generic/http-client';
+import { ShopifyAppInstall, ShopifyAppSubscriptionStatus } from '@adtrackify/at-tracking-event-types';
+//const BASE_API_URL = process.env.BASE_API_URL;
+//const DESTINATIONS_API_KEY = process.env.DESTINATIONS_API_KEY;
+
+export interface ShopifyAppInstallResponseData {
+  shopifyAppInstall: ShopifyAppInstall;
+  [ key: string ]: any;
+}
+
+export interface UpdateShopifyAppInstallRequest {
+  appSubscriptionStatus?: ShopifyAppSubscriptionStatus,
+  pixelId?: string,
+  shopifyAppInstallId: string;
+  isAppEnabled?: boolean;
+}
+
+export class ShopifyAppInstallClient {
+
+  public BASE_API_URL: string;
+  public SHOPIFY_APP_INSTALL_API_KEY: string;
+
+  constructor (baseApiUrl: string, shopifyAppInstallApiKey: string) {
+    this.BASE_API_URL = baseApiUrl;
+    this.SHOPIFY_APP_INSTALL_API_KEY = shopifyAppInstallApiKey;
+  }
+
+  getConfig = () => {
+    const SERVICE_API_ROOT_URL = `${this.BASE_API_URL}/shopify-app-installs`;
+    return {
+      baseURL: SERVICE_API_ROOT_URL,
+      headers: {
+        common: {
+          'x-api-key': this.SHOPIFY_APP_INSTALL_API_KEY
+        }
+      }
+    };
+  };
+
+  getClient = async () => {
+    return axiosHttpService(this.getConfig());
+  };
+
+  updateShopifyAppInstall = async (shopifyAppInstallId: string, updateShopifyAppInstallRequest: UpdateShopifyAppInstallRequest): Promise<ApiResponse<ShopifyAppInstallResponseData>> => {
+    const client = await this.getClient();
+    const response = await client.put(`/${shopifyAppInstallId}`, updateShopifyAppInstallRequest);
+    log.info('updateShopifyAppInstall', { response });
+    return response as ApiResponse<ShopifyAppInstallResponseData>;
+  };
+
+  getShopifyAppInstall = async (shopifyAppInstallId: string): Promise<ApiResponse<ShopifyAppInstallResponseData>> => {
+    const client = await this.getClient();
+    const response = await client.get(`/${shopifyAppInstallId}`);
+    log.info('getShopifyAppInstall', { response });
+    return response as ApiResponse<ShopifyAppInstallResponseData>;
+  };
+}

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

@@ -1,111 +1,111 @@
-import { User } from '@adtrackify/at-tracking-event-types';
-import * as log from 'lambda-log';
-import { HttpError, HttpStatusCodes } from '../../libs';
-import { ApiResponse } from '../../types/api-response';
-import { axiosHttpService } from '../generic/http-client';
-
-export interface UserResponseData {
-  user: User;
-  [ key: string ]: any;
-}
-
-export interface UserSignupRequest {
-  email: string,
-  password: string,
-  givenName: string,
-  familyName: string;
-}
-
-export class UsersAuthClient {
-
-  public SERVICE_API_ROOT_URL: string;
-  public BASE_API_URL: string;
-  public USERS_AUTH_API_KEY: string;
-  constructor (baseApiUrl: string, usersAuthApiKey?: string) {
-    this.BASE_API_URL = baseApiUrl;
-    this.USERS_AUTH_API_KEY = usersAuthApiKey as string;
-    this.SERVICE_API_ROOT_URL = `${this.BASE_API_URL}/auth`;
-  }
-
-  getConfig = () => {
-    return {
-      baseURL: this.SERVICE_API_ROOT_URL,
-      headers: {
-        common: {
-        }
-      }
-    };
-  };
-
-  getClient = async () => {
-    return axiosHttpService(this.getConfig());
-  };
-
-  signupAndConfirmUser = async (userSignupRequest: any): Promise<any> => {
-    const user = await this.signupUser(userSignupRequest);
-    await this.adminConfirmUser(user.email);
-    // if fail - delete user and throw error
-    return user;
-  };
-
-  signupUser = async (userSignupRequest: UserSignupRequest): Promise<any> => {
-    log.info('Attempting to signup user', { email: userSignupRequest.email });
-
-    const client = await this.getClient();
-    const response = await client.post('/signup', userSignupRequest);
-
-    // Check if Successful or throw error
-    if (response.status !== 200 || !response?.data?.user) {
-      const message = 'User Signup Failed';
-      log.error(message, { response });
-      throw new HttpError(HttpStatusCodes.INTERNAL_SERVER_ERROR, message);
-    }
-
-    log.info('User Signup Successful', { response });
-    return response.data.user;
-  };
-
-  //userName is same as user id
-  adminConfirmUser = async (email: string) => {
-    //confirm user
-    //@TODO update user auth service with admin confirm user endpoint
-    log.info('Attempting to admin confirm user', { email });
-
-    const client = await this.getClient();
-    const response = await client.post('/admin/confirm',
-      {
-        email
-      }, {
-      headers: {
-        'x-api-key': this.USERS_AUTH_API_KEY
-      }
-    }
-    );
-
-    // Check if Successful or throw error
-    if (response.status !== 200) {
-      const message = 'Admin User Confirmation Failed';
-      log.error(message, { response });
-      throw new HttpError(HttpStatusCodes.INTERNAL_SERVER_ERROR, message);
-    }
-
-    log.info('Admin User Confirmation Successful', { response });
-    return response.data.user;
-  };
-
-  getUserByEmail = async (email: string): Promise<ApiResponse<UserResponseData>> => {
-    const client = await this.getClient();
-    const getUserResponse = await client.get('/lookup', {
-      headers: {
-        'x-api-key': this.USERS_AUTH_API_KEY
-      },
-      params: {
-        email
-      }
-    });
-    log.info('getUserResponse', { getUserResponse });
-    return getUserResponse;
-  };
-
-}
-
+import { User } from '@adtrackify/at-tracking-event-types';
+import * as log from 'lambda-log';
+import { HttpError, HttpStatusCodes } from '../../libs';
+import { ApiResponse } from '../../types/api-response';
+import { axiosHttpService } from '../generic/http-client';
+
+export interface UserResponseData {
+  user: User;
+  [ key: string ]: any;
+}
+
+export interface UserSignupRequest {
+  email: string,
+  password: string,
+  givenName: string,
+  familyName: string;
+}
+
+export class UsersAuthClient {
+
+  public SERVICE_API_ROOT_URL: string;
+  public BASE_API_URL: string;
+  public USERS_AUTH_API_KEY: string;
+  constructor (baseApiUrl: string, usersAuthApiKey?: string) {
+    this.BASE_API_URL = baseApiUrl;
+    this.USERS_AUTH_API_KEY = usersAuthApiKey as string;
+    this.SERVICE_API_ROOT_URL = `${this.BASE_API_URL}/auth`;
+  }
+
+  getConfig = () => {
+    return {
+      baseURL: this.SERVICE_API_ROOT_URL,
+      headers: {
+        common: {
+        }
+      }
+    };
+  };
+
+  getClient = async () => {
+    return axiosHttpService(this.getConfig());
+  };
+
+  signupAndConfirmUser = async (userSignupRequest: any): Promise<any> => {
+    const user = await this.signupUser(userSignupRequest);
+    await this.adminConfirmUser(user.email);
+    // if fail - delete user and throw error
+    return user;
+  };
+
+  signupUser = async (userSignupRequest: UserSignupRequest): Promise<any> => {
+    log.info('Attempting to signup user', { email: userSignupRequest.email });
+
+    const client = await this.getClient();
+    const response = await client.post('/signup', userSignupRequest);
+
+    // Check if Successful or throw error
+    if (response.status !== 200 || !response?.data?.user) {
+      const message = 'User Signup Failed';
+      log.error(message, { response });
+      throw new HttpError(HttpStatusCodes.INTERNAL_SERVER_ERROR, message);
+    }
+
+    log.info('User Signup Successful', { response });
+    return response.data.user;
+  };
+
+  //userName is same as user id
+  adminConfirmUser = async (email: string) => {
+    //confirm user
+    //@TODO update user auth service with admin confirm user endpoint
+    log.info('Attempting to admin confirm user', { email });
+
+    const client = await this.getClient();
+    const response = await client.post('/admin/confirm',
+      {
+        email
+      }, {
+      headers: {
+        'x-api-key': this.USERS_AUTH_API_KEY
+      }
+    }
+    );
+
+    // Check if Successful or throw error
+    if (response.status !== 200) {
+      const message = 'Admin User Confirmation Failed';
+      log.error(message, { response });
+      throw new HttpError(HttpStatusCodes.INTERNAL_SERVER_ERROR, message);
+    }
+
+    log.info('Admin User Confirmation Successful', { response });
+    return response.data.user;
+  };
+
+  getUserByEmail = async (email: string): Promise<ApiResponse<UserResponseData>> => {
+    const client = await this.getClient();
+    const getUserResponse = await client.get('/lookup', {
+      headers: {
+        'x-api-key': this.USERS_AUTH_API_KEY
+      },
+      params: {
+        email
+      }
+    });
+    log.info('getUserResponse', { getUserResponse });
+    return getUserResponse;
+  };
+
+}
+

package/src/clients/third-party/shopify-client.ts

@@ -64,7 +64,7 @@ export class ShopifyClient {
     const res = await this.genericShopifyPost(url, accessToken, payload);
 
     if (res.status >= 400) {
-      log.error('Failed to register Webhook Topic', { shop, accessToken, url, payload });
+      log.error('Failed to update Shopify app Metafield ', { shop, accessToken, url, payload });
     }
     return res;
   };
@@ -96,6 +96,17 @@ export class ShopifyClient {
     return res;
   };
 
+  static cancelAppSubscription = async (shop: string, accessToken: string, chargeId: string) => {
+    const url = `https://${shop}/admin/api/${this._shopify_api_version}/recurring_application_charges/${chargeId}.json`;
+    const client = axiosHttpService();
+    const res = await client.delete(url, { headers: { 'X-Shopify-Access-Token': accessToken } });
+
+    if (res.status !== 200) {
+      log.error('Failed to cancel recurring App billing', { shop, accessToken, url });
+    }
+    return res;
+  };
+
   static listAppSubscriptions = async (shop: string, accessToken: string) => {
     const url = `https://${shop}/admin/api/${this._shopify_api_version}/recurring_application_charges.json`;
     const res = await this.genericShopifyGet(url, accessToken);

package/src/helpers/index.ts

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

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

@@ -1,22 +1,22 @@
-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('Bad Request', {
-      errors: error.details.map(detail => ({
-        message: detail?.message,
-        key: detail?.context?.key,
-        path: detail?.path,
-      }))
-    });
-
-    log.info('', { httperr });
-    throw httperr;
-  }
-  return value;
+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('Bad Request', {
+      errors: error.details.map(detail => ({
+        message: detail?.message,
+        key: detail?.context?.key,
+        path: detail?.path,
+      }))
+    });
+
+    log.info('', { httperr });
+    throw httperr;
+  }
+  return value;
 };

package/src/helpers/shopify-helper.ts

@@ -1,39 +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;
-}
-
+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;
+}
+