@adtrackify/at-service-common 1.1.21 → 1.2.0

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

@@ -1,139 +0,0 @@
-import { axiosHttpService } from '../generic/http-client.js';
-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/input-validation-helper.ts

@@ -1,22 +0,0 @@
-import Joi from 'joi';
-import * as log from 'lambda-log';
-import { HttpError } from '../libs/http-error.js';
-
-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/logging-helper.ts

@@ -1,10 +0,0 @@
-import * as log from 'lambda-log';
-const stage = process?.env?.STAGE;
-
-export const configureLogger = (event: any, context: any, debug = true) => {
-  log.options.meta.stage = stage;
-  log.options.meta.source_name = context?.functionName || 'unknown';
-  log.options.meta.awsRequestId = context?.awsRequestId || 'unknown';
-  log.options.meta.lambdaEvent = event;
-  log.options.debug = debug;
-}

package/src/helpers/response-helper.ts

@@ -1,40 +0,0 @@
-
-export const success = (body: any) => {
-  return buildResponse(200, body);
-}
-
-const defaultError = {
-  message: 'internalServerError'
-}
-
-export const failure = (error: any, statusCode = 500) => {
-  statusCode = error?.statusCode ?? statusCode;
-
-  let body = defaultError;
-  if (error?.body) {
-    body = error.body;
-  }
-  else if (error?.message) {
-    body = { message: error.message };
-  } else if (statusCode === 500) {
-    body = defaultError;
-  }
-  return buildResponse(statusCode, body);
-}
-
-export const buildResponse = (statusCode: number, body: any = {}) => {
-  delete body.stack;
-  return {
-    statusCode: statusCode,
-    headers: {
-      'Access-Control-Allow-Origin': '*',
-      'Access-Control-Allow-Credentials': true,
-      'cache-control': 'max-age=86400',
-      Date: new Date(),
-      'Last-Modified': new Date(),
-      'Access-Control-Allow-Headers':
-        'Content-Type, Content-Encoding'
-    },
-    body: JSON.stringify(body),
-  };
-}

package/src/helpers/shopify-helper.ts

@@ -1,39 +0,0 @@
-import { createHmac } from 'crypto';
-import * as log from 'lambda-log';
-import { HttpError } from '../libs/http-error.js';
-import { mapObjectToQueryString } from '../libs/url.js';
-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/helpers/subscription-helper.ts

@@ -1,243 +0,0 @@
-import { SubscriptionPlan, PLAN_BILLING_FREQUENCY } from '@adtrackify/at-tracking-event-types';
-
-export const StripeBillingMap: any = {
-  dev2: {
-    'free': 'price_1JzjbKK7krGh4037ezNbGJEm',
-    'starter_monthly': 'price_1JwzsGK7krGh4037Li0hPpsZ',
-    'starter_yearly': 'price_1JwzsGK7krGh4037Li0hPpsZ',
-    'scale_monthly': 'price_1JzjcSK7krGh4037yh34LPk3',
-    'scale_yearly': 'price_1JzjcSK7krGh4037QiBJYfnD',
-    'growth_monthly': 'price_1Jzje1K7krGh4037KErHBp5N',
-    'growth_yearly': 'price_1Jzje1K7krGh4037MhCUhTDh'
-  },
-  qa2: {
-    'free': 'price_1JzjbKK7krGh4037ezNbGJEm',
-    'starter_monthly': 'price_1JwzsGK7krGh4037Li0hPpsZ',
-    'starter_yearly': 'price_1JwzsGK7krGh4037Li0hPpsZ',
-    'scale_monthly': 'price_1JzjcSK7krGh4037yh34LPk3',
-    'scale_yearly': 'price_1JzjcSK7krGh4037QiBJYfnD',
-    'growth_monthly': 'price_1Jzje1K7krGh4037KErHBp5N',
-    'growth_yearly': 'price_1Jzje1K7krGh4037MhCUhTDh'
-  },
-  prod2: {
-    'free': 'price_1KAFsIK7krGh4037RsaAYMEl',
-    'starter_monthly': 'price_1KAFsMK7krGh4037Lz3P0ksU',
-    'starter_yearly': 'price_1KAFsMK7krGh4037Dj1WmSi8',
-    'scale_monthly': 'price_1KAFrxK7krGh4037zWCdaTly',
-    'scale_yearly': 'price_1KAFrxK7krGh40375fhymyWP',
-    'growth_monthly': 'price_1KAFs7K7krGh4037JChjz5Cr',
-    'growth_yearly': 'price_1KAFs7K7krGh4037rZElg12s'
-  },
-  dev: {
-    'free': 'price_1JzjbKK7krGh4037ezNbGJEm',
-    'starter_monthly': 'price_1JwzsGK7krGh4037Li0hPpsZ',
-    'starter_yearly': 'price_1JwzsGK7krGh4037Li0hPpsZ',
-    'scale_monthly': 'price_1JzjcSK7krGh4037yh34LPk3',
-    'scale_yearly': 'price_1JzjcSK7krGh4037QiBJYfnD',
-    'growth_monthly': 'price_1Jzje1K7krGh4037KErHBp5N',
-    'growth_yearly': 'price_1Jzje1K7krGh4037MhCUhTDh'
-  },
-  qa: {
-    'free': 'price_1JzjbKK7krGh4037ezNbGJEm',
-    'starter_monthly': 'price_1JwzsGK7krGh4037Li0hPpsZ',
-    'starter_yearly': 'price_1JwzsGK7krGh4037Li0hPpsZ',
-    'scale_monthly': 'price_1JzjcSK7krGh4037yh34LPk3',
-    'scale_yearly': 'price_1JzjcSK7krGh4037QiBJYfnD',
-    'growth_monthly': 'price_1Jzje1K7krGh4037KErHBp5N',
-    'growth_yearly': 'price_1Jzje1K7krGh4037MhCUhTDh'
-  },
-  prod: {
-    'free': 'price_1KAFsIK7krGh4037RsaAYMEl',
-    'starter_monthly': 'price_1KAFsMK7krGh4037Lz3P0ksU',
-    'starter_yearly': 'price_1KAFsMK7krGh4037Dj1WmSi8',
-    'scale_monthly': 'price_1KAFrxK7krGh4037zWCdaTly',
-    'scale_yearly': 'price_1KAFrxK7krGh40375fhymyWP',
-    'growth_monthly': 'price_1KAFs7K7krGh4037JChjz5Cr',
-    'growth_yearly': 'price_1KAFs7K7krGh4037rZElg12s'
-  }
-};
-
-export const CommonPlanInfo = [
-  //'60-day Risk Free Trial',
-  'Free Server Side Tracking & Conversion API',
-  'MultiPixel Support (Multiple facebook, tiktok, etc)',
-  'Corrects Facebook Conversion Tracking post IOS14',
-  'Increase ROAS & Attribution Data',
-  'Enhanced Fingerprinting & Identity Resolution',
-  'Unlimited Integrations',
-  'Advanced Integrations (Webhooks, Custom JS/HTML, Hubspot)'
-];
-
-export const SubscriptionPlanSeedItems: {
-  items: SubscriptionPlan[];
-} = {
-  items: [ {
-    id: 1,
-    planName: 'free',
-    displayName: 'Free',
-    sku: 'ADT-001',
-    description: 'Free Plan - Monthly',
-    price: '0',
-    displayPrice: '$0',
-    billingFrequency: PLAN_BILLING_FREQUENCY.MONTHLY,
-    trialLengthDays: 0,
-    trialRequiresCreditCard: false,
-    planDesc: [
-      ...CommonPlanInfo,
-      'Free Up to 500 orders/month (50,000 events)*'
-    ],
-    unitPriceText: 'try now - free forever',
-    isHighlighted: false,
-    isBanner: false
-  },
-  // STARTER PLANS
-  {
-    id: 2,
-    planName: 'starter_monthly',
-    displayName: 'Starter',
-    sku: 'ADT-002',
-    description: 'Starter Plan - Monthly',
-    price: '79.99',
-    displayPrice: '$79.99',
-    billingFrequency: PLAN_BILLING_FREQUENCY.MONTHLY,
-    trialLengthDays: 60,
-    trialRequiresCreditCard: false,
-    planDesc: [
-      '60-day Risk Free Trial',
-      ...CommonPlanInfo,
-      'Up to 2,000 orders/month (250,000 events)*'
-    ],
-    isHighlighted: true,
-    isBanner: true,
-    bannerColor: 'blue',
-    bannerText: 'MOST POPULAR'
-  }, {
-    id: 3,
-    planName: 'starter_yearly',
-    displayName: 'Starter',
-    sku: 'ADT-003',
-    description: 'Starter Plan - Yearly',
-    price: '767.90',
-    displayPrice: '$63.99',
-    billingFrequency: PLAN_BILLING_FREQUENCY.YEARLY,
-    trialLengthDays: 30,
-    trialRequiresCreditCard: false,
-    planDesc: [
-      '60-day Risk Free Trial',
-      ...CommonPlanInfo,
-      'Up to 2,000 orders/month (250,000 events)*'
-    ],
-    unitPriceText: 'billed yearly ($767.90) - 20% savings',
-    isHighlighted: true,
-    isBanner: true,
-    bannerColor: 'blue',
-    bannerText: 'MOST POPULAR'
-  },
-  // SCALE PLANS
-  {
-    id: 4,
-    planName: 'scale_monthly',
-    displayName: 'Scale',
-    sku: 'ADT-004',
-    description: 'Scale Plan - Monthly',
-    price: '199.99',
-    displayPrice: '$199.99',
-    billingFrequency: PLAN_BILLING_FREQUENCY.MONTHLY,
-    trialLengthDays: 60,
-    trialRequiresCreditCard: false,
-    planDesc: [
-      '60-day Risk Free Trial',
-      ...CommonPlanInfo,
-      'Up to 7,500 orders/month (750,000 events)*'
-    ],
-    unitPriceText: '',
-    isHighlighted: false,
-    isBanner: false
-  }, {
-    id: 5,
-    planName: 'scale_yearly',
-    displayName: 'Scale',
-    sku: 'ADT-005',
-    description: 'Scale Plan - Yearly',
-    price: '1823.91',
-    displayPrice: '$151.99',
-    billingFrequency: PLAN_BILLING_FREQUENCY.YEARLY,
-    trialLengthDays: 60,
-    trialRequiresCreditCard: false,
-    planDesc: [
-      '60-day Risk Free Trial',
-      ...CommonPlanInfo,
-      'Up to 7,500 orders/month (750,000 events)*'
-    ],
-    unitPriceText: 'billed yearly ($1823.91) - 24% savings',
-    isHighlighted: false,
-    isBanner: false
-  },
-    // // GROWTH PLANS
-    // {
-    //   id: 6,
-    //   planName: 'growth_monthly',
-    //   displayName: 'Growth',
-    //   sku: 'ADT-006',
-    //   description: 'Growth Plan - Monthly',
-    //   price: '199.99',
-    //   displayPrice: '$199.99',
-    //   billingFrequency: PLAN_BILLING_FREQUENCY.MONTHLY,
-    //   trialLengthDays: 60,
-    //   trialRequiresCreditCard: false,
-    //   planDesc: [
-    //     '60-day Risk Free Trial',
-    //     ...CommonPlanInfo,
-    //     '250,000 tracking events/mo'
-    //   ],
-    //   unitPriceText: 'billed yearly ($540) - 25% savings',
-    //   isHighlighted: false,
-    //   isBanner: true,
-    //   bannerColor: 'orange',
-    //   bannerText: 'BEST VALUE'
-    // }, {
-    //   id: 7,
-    //   planName: 'growth_yearly',
-    //   displayName: 'Growth',
-    //   sku: 'ADT-007',
-    //   description: 'Growth Plan - Yearly',
-    //   price: '1799.91',
-    //   displayPrice: '$149.99',
-    //   billingFrequency: PLAN_BILLING_FREQUENCY.YEARLY,
-    //   trialLengthDays: 60,
-    //   trialRequiresCreditCard: false,
-    //   planDesc: [
-    //     '30-day Risk Free Trial',
-    //     'Fixes IOS14.5 tracking',
-    //     'Multi Pixel Support',
-    //     'Enhanced Tracking / Attribution',
-    //     'Unlimited Facebook Conversion API',
-    //     'Unlimited Integrations',
-    //     'Easy no code setup',
-    //     '100,000 tracking events/mo'
-    //   ],
-    //   unitPriceText: 'billed yearly ($1799.91) - 25% savings',
-    //   isHighlighted: false,
-    //   isBanner: true,
-    //   bannerColor: 'orange',
-    //   bannerText: 'BEST VALUE'
-    // },
-  ]
-};
-
-
-export const getPlanDetails = (planId: number, stage: string) => {
-  const plan = SubscriptionPlanSeedItems.items.filter(x => x.id === planId)[ 0 ] as any;
-  plan.stripePriceId = StripeBillingMap[ stage ][ plan.planName ];
-  return plan as SubscriptionPlan;
-};
-
-export const getPlanByStripePriceId = (stripePriceId: string, stage: string) => {
-  const stripePriceIds = StripeBillingMap[ stage ];
-  const planName = Object.keys(stripePriceIds).find(key => stripePriceIds[ key ] === stripePriceId);
-
-  const plan = SubscriptionPlanSeedItems.items.filter(x => x.planName === planName)[ 0 ] as any;
-  plan.stripePriceId = stripePriceId;
-
-  return plan as SubscriptionPlan;
-};

package/src/index.ts

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

package/src/libs/crypto.ts

@@ -1,6 +0,0 @@
-import crypto from 'crypto';
-
-export const generatePublicKey = (): string => {
-  const publicKey = crypto.randomBytes(26);
-  return publicKey.toString('utf8');
-};

package/src/libs/dates.ts

@@ -1,14 +0,0 @@
-
-import { DateTime } from 'luxon';
-
-export const getCurrentTimestamp = (): string => {
-  return DateTime.utc().toJSDate().toISOString();
-}
-
-export const getDateFromTimestamp = (timestamp: string) => {
-  return timestamp.split('T')[0];
-}
-
-export const getCurrentDate = (): string => {
-  return getDateFromTimestamp(getCurrentTimestamp());
-}

package/src/libs/http-error.ts

@@ -1,90 +0,0 @@
-/* eslint-disable no-dupe-class-members */
-import { strict as assert } from 'assert';
-
-const deepClone = (o = {}) => JSON.parse(JSON.stringify(o));
-const containsStackTrace = (text = '') => /at.+\.js:\d+:\d+/.test(text);
-const objectContainsStackTrace = (obj: any) =>
-  !obj ? false : containsStackTrace(JSON.stringify(obj));
-
-// may only be expanded by governance, never reduced
-const supportedStatusCodes: any = {
-  400: 'Bad Request',
-  401: 'Unauthorized',
-  403: 'Forbidden',
-  404: 'Not Found',
-  405: 'Method Not Allowed',
-  409: 'Conflict',
-  412: 'Precondition Failed',
-  413: 'Payload Too Large',
-  415: 'Unsupported Media Type',
-  428: 'Precondition Required',
-  429: 'Too Many Requests',
-  500: 'Internal Server Error',
-  501: 'Not Implemented',
-  502: 'Bad Gateway',
-  503: 'Service Unavailable',
-  504: 'Gateway Timeout'
-};
-
-const supportedStatusCodesMessage = `statusCode must be one of the following: ${JSON.stringify(Object.keys(supportedStatusCodes))}`;
-//const onlyStatusCodeMessage = 'Server errors may not specify any parameter except statusCode';
-
-//const isNullOrUndefined = (value: any) => value === null || value === undefined;
-
-export class HttpError extends Error {
-  body: {
-    [ key: string ]: any;
-  };
-  headers: object[];
-  statusCode: number;
-  isServerError: boolean;
-
-  constructor (statusCode: number,
-    message?: string,
-    body?: {
-      [ key: string ]: any;
-    },
-    headers?: object[]) {
-    assert(statusCode in supportedStatusCodes, supportedStatusCodesMessage);
-
-    const isServerError = statusCode > 499;
-
-    assert(
-      body === undefined || typeof body === 'object',
-      'body must be an object or omitted'
-    );
-    assert(
-      headers === undefined || typeof headers === 'object',
-      'headers must be an object or omitted'
-    );
-
-    message = message ?? supportedStatusCodes[ statusCode ];
-
-    assert(
-      !containsStackTrace(message) && !objectContainsStackTrace(body),
-      'the message or data parameters may not contain errors or stack traces'
-    );
-
-    super(message);
-
-    this.body = deepClone(body);
-    this.headers = deepClone(headers);
-    this.statusCode = statusCode;
-    this.isServerError = isServerError;
-    if (!this?.body?.message) {
-      this.body.message = this.message;
-    }
-  }
-
-
-  static get supportedStatusCodes() { return supportedStatusCodes; }
-  static badRequest = (message?: string, body?: object, headers?: object[]) => { return new HttpError(400, message, body, headers); };
-  static unauthorized = (message?: string, body?: object, headers?: object[]) => new HttpError(401, message, body, headers);
-  static forbidden = (message?: string, body?: object, headers?: object[]) => new HttpError(403, message, body, headers);
-  static notFound = (message?: string, body?: object, headers?: object[]) => new HttpError(404, message, body, headers);
-  static internal = (message?: string, body?: object, headers?: object[]) => new HttpError(500, message, body, headers);
-  static notImplemented = () => new HttpError(501);
-  static badGateway = () => new HttpError(502);
-  static serviceUnavailable = (headers: object[]) => new HttpError(503, undefined, undefined, headers);
-  static gatewayTimeout = () => new HttpError(504);
-}