@adtrackify/at-service-common 1.1.13 → 1.1.16

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

@@ -1,139 +1,139 @@
-import { axiosHttpService } from '../generic/http-client';
-import * as log from 'lambda-log';
-
-export class ShopifyClient {
-  static _shopify_api_version = process.env.SHOPIFY_API_VERSION as string;
-  static getConfig = (shopifyDomain: string, accessToken: string) => {
-    const config = {
-      baseURL: `https://${shopifyDomain}/admin/api/${this._shopify_api_version}`,
-      headers: {
-        common: {
-          'X-Shopify-Access-Token': accessToken,
-        },
-      },
-    };
-    return config;
-  };
-
-  static getClient = (shopifyDomain: string, accessToken: string) => {
-    return axiosHttpService(
-      this.getConfig(shopifyDomain, accessToken)
-    );
-  };
-
-  static registerApp = async (shop: string, code: string, appKey: string, appSecret: string) => {
-    const client = axiosHttpService();
-    const url = 'https://' + shop + '/admin/oauth/access_token';
-    const payload = {
-      client_id: appKey,
-      client_secret: appSecret,
-      code
-    };
-    const res = await client.post(url, payload);
-    return res;
-  };
-
-  static registerWebhookTopic = async (shop: string, accessToken: string, eventBridgeArn: string, topic: string) => {
-    const client = axiosHttpService();
-    const url = `https://${shop}/admin/api/${this._shopify_api_version}/webhooks.json`;
-    const payload = {
-      webhook: {
-        topic,
-        address: eventBridgeArn,
-        format: 'json'
-      }
-    };
-    const res = await client.post(url, payload, { headers: { 'X-Shopify-Access-Token': accessToken } });
-    if (res.status >= 400) {
-      log.error('Failed to register Webhook Topic', { shop, accessToken, eventBridgeArn, topic, url, payload });
-    }
-    log.debug('Shopify Client Webhook Registration Response', { registrationResponse: res });
-    return res;
-  };
-
-  static updateShopifyAppMetafield = async (shop: string, accessToken: string, pixelId: string) => {
-    const url = `https://${shop}/admin/api/${this._shopify_api_version}/metafields.json`;
-    const payload = {
-      metafield: {
-        namespace: 'adtr',
-        key: 'adtr.config',
-        value: pixelId,
-        type: 'single_line_text_field'
-      }
-    };
-    const res = await this.genericShopifyPost(url, accessToken, payload);
-
-    if (res.status >= 400) {
-      log.error('Failed to update Shopify app Metafield ', { shop, accessToken, url, payload });
-    }
-    return res;
-  };
-
-  static getShopifyStoreProperties = async (shop: string, accessToken: string) => {
-    const url = `https://${shop}/admin/api/${this._shopify_api_version}/shop.json`;
-    const res = await this.genericShopifyGet(url, accessToken);
-
-    if (res.status >= 400) {
-      log.error('Failed to get Shopify Store Properties', { shop, accessToken, url });
-    }
-    return res;
-  };
-
-  static createAppSubscription = async (shop: string, accessToken: string,
-    planName: string, price: number, returnUrl: string, trialDays: number, test?: boolean) => {
-    const url = `https://${shop}/admin/api/${this._shopify_api_version}/recurring_application_charges.json`;
-    const recurring_application_charge = {
-      name: planName,
-      price,
-      return_url: returnUrl,
-      trial_days: trialDays,
-      test
-    };
-    const res = await this.genericShopifyPost(url, accessToken, { recurring_application_charge });
-    if (res.status >= 400) {
-      log.error('Failed to create App Subscription', { shop, accessToken, url });
-    }
-    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);
-    if (res.status >= 400) {
-      log.error('Failed to get App Subscriptions', { shop, accessToken, url });
-    }
-    return res;
-  };
-
-  static genericShopifyPost = async (url: string, accessToken: string, payload: any) => {
-    const client = axiosHttpService();
-    const res = await client.post(url, payload, { headers: { 'X-Shopify-Access-Token': accessToken, 'Content-Type': 'application/json' } });
-    log.debug('Shopify Client Response', { res });
-    return res;
-  };
-
-  static genericShopifyGet = async (url: string, accessToken: string) => {
-    const client = axiosHttpService();
-    const res = await client.get(url, { headers: { 'X-Shopify-Access-Token': accessToken } });
-    log.debug('Shopify Client Response', { res });
-    return res;
-  };
-
-  static genericShopifyPut = async (url: string, accessToken: string, payload: any) => {
-    const client = axiosHttpService();
-    const res = await client.put(url, payload, { headers: { 'X-Shopify-Access-Token': accessToken } });
-    log.debug('Shopify Client Response', { res });
-    return res;
-  };
-}
+import { axiosHttpService } from '../generic/http-client';
+import * as log from 'lambda-log';
+
+export class ShopifyClient {
+  static _shopify_api_version = process.env.SHOPIFY_API_VERSION as string;
+  static getConfig = (shopifyDomain: string, accessToken: string) => {
+    const config = {
+      baseURL: `https://${shopifyDomain}/admin/api/${this._shopify_api_version}`,
+      headers: {
+        common: {
+          'X-Shopify-Access-Token': accessToken,
+        },
+      },
+    };
+    return config;
+  };
+
+  static getClient = (shopifyDomain: string, accessToken: string) => {
+    return axiosHttpService(
+      this.getConfig(shopifyDomain, accessToken)
+    );
+  };
+
+  static registerApp = async (shop: string, code: string, appKey: string, appSecret: string) => {
+    const client = axiosHttpService();
+    const url = 'https://' + shop + '/admin/oauth/access_token';
+    const payload = {
+      client_id: appKey,
+      client_secret: appSecret,
+      code
+    };
+    const res = await client.post(url, payload);
+    return res;
+  };
+
+  static registerWebhookTopic = async (shop: string, accessToken: string, eventBridgeArn: string, topic: string) => {
+    const client = axiosHttpService();
+    const url = `https://${shop}/admin/api/${this._shopify_api_version}/webhooks.json`;
+    const payload = {
+      webhook: {
+        topic,
+        address: eventBridgeArn,
+        format: 'json'
+      }
+    };
+    const res = await client.post(url, payload, { headers: { 'X-Shopify-Access-Token': accessToken } });
+    if (res.status >= 400) {
+      log.error('Failed to register Webhook Topic', { shop, accessToken, eventBridgeArn, topic, url, payload });
+    }
+    log.debug('Shopify Client Webhook Registration Response', { registrationResponse: res });
+    return res;
+  };
+
+  static updateShopifyAppMetafield = async (shop: string, accessToken: string, pixelId: string) => {
+    const url = `https://${shop}/admin/api/${this._shopify_api_version}/metafields.json`;
+    const payload = {
+      metafield: {
+        namespace: 'adtr',
+        key: 'adtr.config',
+        value: pixelId,
+        type: 'single_line_text_field'
+      }
+    };
+    const res = await this.genericShopifyPost(url, accessToken, payload);
+
+    if (res.status >= 400) {
+      log.error('Failed to update Shopify app Metafield ', { shop, accessToken, url, payload });
+    }
+    return res;
+  };
+
+  static getShopifyStoreProperties = async (shop: string, accessToken: string) => {
+    const url = `https://${shop}/admin/api/${this._shopify_api_version}/shop.json`;
+    const res = await this.genericShopifyGet(url, accessToken);
+
+    if (res.status >= 400) {
+      log.error('Failed to get Shopify Store Properties', { shop, accessToken, url });
+    }
+    return res;
+  };
+
+  static createAppSubscription = async (shop: string, accessToken: string,
+    planName: string, price: number, returnUrl: string, trialDays: number, test?: boolean) => {
+    const url = `https://${shop}/admin/api/${this._shopify_api_version}/recurring_application_charges.json`;
+    const recurring_application_charge = {
+      name: planName,
+      price,
+      return_url: returnUrl,
+      trial_days: trialDays,
+      test
+    };
+    const res = await this.genericShopifyPost(url, accessToken, { recurring_application_charge });
+    if (res.status >= 400) {
+      log.error('Failed to create App Subscription', { shop, accessToken, url });
+    }
+    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);
+    if (res.status >= 400) {
+      log.error('Failed to get App Subscriptions', { shop, accessToken, url });
+    }
+    return res;
+  };
+
+  static genericShopifyPost = async (url: string, accessToken: string, payload: any) => {
+    const client = axiosHttpService();
+    const res = await client.post(url, payload, { headers: { 'X-Shopify-Access-Token': accessToken, 'Content-Type': 'application/json' } });
+    log.debug('Shopify Client Response', { res });
+    return res;
+  };
+
+  static genericShopifyGet = async (url: string, accessToken: string) => {
+    const client = axiosHttpService();
+    const res = await client.get(url, { headers: { 'X-Shopify-Access-Token': accessToken } });
+    log.debug('Shopify Client Response', { res });
+    return res;
+  };
+
+  static genericShopifyPut = async (url: string, accessToken: string, payload: any) => {
+    const client = axiosHttpService();
+    const res = await client.put(url, payload, { headers: { 'X-Shopify-Access-Token': accessToken } });
+    log.debug('Shopify Client Response', { res });
+    return res;
+  };
+}

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;
+}
+

package/src/index.ts

@@ -1,5 +1,5 @@
-export * from './clients';
-export * from './helpers';
-export * from './libs';
-export * from './types';
+export * from './clients';
+export * from './helpers';
+export * from './libs';
+export * from './types';
 export * from './services';

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 './url';
-
+export * from '../helpers/shopify-helper';
+export * from './crypto';
+export * from './dates';
+export * from './http-error';
+export * from './http-status-codes';
+export * from './url';
+

package/src/libs/url.ts

@@ -1,10 +1,10 @@
-// Record<string, string> is any object
-export const mapObjectToQueryString = (inputObj: any): string => {
-  const qsp = Object.entries(inputObj).sort((a, b) => a[ 0 ] < b[ 0 ] ? -1 : 1);
-  const urlParams = new URLSearchParams();
-  qsp.map(p => {
-    urlParams.append(p[ 0 ], p[ 1 ] as string);
-  });
-  const qs = urlParams.toString();
-  return qs;
+// Record<string, string> is any object
+export const mapObjectToQueryString = (inputObj: any): string => {
+  const qsp = Object.entries(inputObj).sort((a, b) => a[ 0 ] < b[ 0 ] ? -1 : 1);
+  const urlParams = new URLSearchParams();
+  qsp.map(p => {
+    urlParams.append(p[ 0 ], p[ 1 ] as string);
+  });
+  const qs = urlParams.toString();
+  return qs;
 };

package/src/services/eventbridge-integration-service.ts

@@ -1,44 +1,44 @@
-import { EventBridgeClient } from '../clients';
-import { Message, TemplatedMessage } from 'postmark';
-
-export const enum PostmarkRequestType {
-  SINGLE_EMAIL = 'single_email',
-  TEMPLATE_EMAIL = 'template_email'
-}
-
-export enum ADTRACKIFY_EVENT_BRIDGE_EVENTS {
-  SEND_POSTMARK_EMAIL = 'integration.sendPostmarkEmail',
-}
-
-export class EventBridgeIntegrationService {
-  public eventBridgeClient: EventBridgeClient;
-  public EVENT_BUS_NAME: string;
-
-  constructor (eventBusName: string) {
-    this.eventBridgeClient = new EventBridgeClient(eventBusName);
-    this.EVENT_BUS_NAME = eventBusName;
-  }
-
-  public sendPostmarkEmailEvent = async (eventSource: string, postmarkMessage: Message, postmarkServerToken: string) => {
-    return await this.eventBridgeClient.buildAndSendEvent(
-      eventSource,
-      ADTRACKIFY_EVENT_BRIDGE_EVENTS.SEND_POSTMARK_EMAIL,
-      {
-        postmarkMessage,
-        postmarkRequestType: PostmarkRequestType.SINGLE_EMAIL,
-        postmarkServerToken
-      });
-  };
-
-  public sendPostmarkTemplatedEmailEvent = async (eventSource: string, postmarkMessage: TemplatedMessage, postmarkServerToken: string) => {
-    return await this.eventBridgeClient.buildAndSendEvent(
-      eventSource,
-      ADTRACKIFY_EVENT_BRIDGE_EVENTS.SEND_POSTMARK_EMAIL,
-      {
-        postmarkMessage,
-        postmarkRequestType: PostmarkRequestType.TEMPLATE_EMAIL,
-        postmarkServerToken
-      });
-  };
-
-}
+import { EventBridgeClient } from '../clients';
+import { Message, TemplatedMessage } from 'postmark';
+
+export const enum PostmarkRequestType {
+  SINGLE_EMAIL = 'single_email',
+  TEMPLATE_EMAIL = 'template_email'
+}
+
+export enum ADTRACKIFY_EVENT_BRIDGE_EVENTS {
+  SEND_POSTMARK_EMAIL = 'integration.sendPostmarkEmail',
+}
+
+export class EventBridgeIntegrationService {
+  public eventBridgeClient: EventBridgeClient;
+  public EVENT_BUS_NAME: string;
+
+  constructor (eventBusName: string) {
+    this.eventBridgeClient = new EventBridgeClient(eventBusName);
+    this.EVENT_BUS_NAME = eventBusName;
+  }
+
+  public sendPostmarkEmailEvent = async (eventSource: string, postmarkMessage: Message, postmarkServerToken: string) => {
+    return await this.eventBridgeClient.buildAndSendEvent(
+      eventSource,
+      ADTRACKIFY_EVENT_BRIDGE_EVENTS.SEND_POSTMARK_EMAIL,
+      {
+        postmarkMessage,
+        postmarkRequestType: PostmarkRequestType.SINGLE_EMAIL,
+        postmarkServerToken
+      });
+  };
+
+  public sendPostmarkTemplatedEmailEvent = async (eventSource: string, postmarkMessage: TemplatedMessage, postmarkServerToken: string) => {
+    return await this.eventBridgeClient.buildAndSendEvent(
+      eventSource,
+      ADTRACKIFY_EVENT_BRIDGE_EVENTS.SEND_POSTMARK_EMAIL,
+      {
+        postmarkMessage,
+        postmarkRequestType: PostmarkRequestType.TEMPLATE_EMAIL,
+        postmarkServerToken
+      });
+  };
+
+}

package/src/types/internal-events/event-detail-types.ts

@@ -1,10 +1,10 @@
-export enum ADTRACKIFY_EVENT_TYPES {
-  NOTIFY_SHOPIFY_SUBSCRIPTION_CREATED = 'shopifySubscriptionCreated',
-  NOTIFY_SUBSCRIPTION_SIGNUP_COMPLETED = 'subscription.signupCompleted',
-  REQUEST_SET_ACCOUNT_OWNER = 'setAccountOwner',
-  REQUEST_SET_ACCOUNT_SUBSCRIPTION_ID = 'setAccountSubscriptionId',
-}
-
-export enum ADTRACKIFY_EVENT_SOURCES {
-  SUBSCRIPTIONS = 'subscriptions',
+export enum ADTRACKIFY_EVENT_TYPES {
+  NOTIFY_SHOPIFY_SUBSCRIPTION_CREATED = 'shopifySubscriptionCreated',
+  NOTIFY_SUBSCRIPTION_SIGNUP_COMPLETED = 'subscription.signupCompleted',
+  REQUEST_SET_ACCOUNT_OWNER = 'setAccountOwner',
+  REQUEST_SET_ACCOUNT_SUBSCRIPTION_ID = 'setAccountSubscriptionId',
+}
+
+export enum ADTRACKIFY_EVENT_SOURCES {
+  SUBSCRIPTIONS = 'subscriptions',
 }