@adtrackify/at-service-common 1.0.80 → 1.0.81

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/helpers/subscription-helper.ts

@@ -1,235 +1,235 @@
-import { SubscriptionPlan, PLAN_BILLING_FREQUENCY } from '@adtrackify/at-tracking-event-types';
-
-export const StripeBillingMap: any = {
-  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 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: 30,
-    trialRequiresCreditCard: false,
-    planDesc: [
-      'Fixes IOS14.5 tracking',
-      'Multi Pixel Support',
-      'Enhanced Tracking / Attribution',
-      'Unlimited Facebook Conversion API',
-      'Unlimited Integrations',
-      'Easy no code setup',
-      '1,000 tracking events/mo'
-    ],
-    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: '9.99',
-    displayPrice: '$9.99',
-    billingFrequency: PLAN_BILLING_FREQUENCY.MONTHLY,
-    trialLengthDays: 30,
-    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',
-      '2,500 tracking events/mo'
-    ],
-    unitPriceText: '',
-    isHighlighted: false,
-    isBanner: false,
-  }, {
-    id: 3,
-    planName: 'starter_yearly',
-    displayName: 'Starter',
-    sku: 'ADT-003',
-    description: 'Starter Plan - Yearly',
-    price: '96.00',
-    displayPrice: '$8',
-    billingFrequency: PLAN_BILLING_FREQUENCY.YEARLY,
-    trialLengthDays: 30,
-    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',
-      '2,500 tracking events/mo'
-    ],
-    unitPriceText: 'billed yearly ($96) - 20% savings',
-    isHighlighted: false,
-    isBanner: false
-  },
-  // SCALE PLANS
-  {
-    id: 4,
-    planName: 'scale_monthly',
-    displayName: 'Scale',
-    sku: 'ADT-004',
-    description: 'Scale Plan - Monthly',
-    price: '59.99',
-    displayPrice: '$59.99',
-    billingFrequency: PLAN_BILLING_FREQUENCY.MONTHLY,
-    trialLengthDays: 30,
-    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',
-      '25,000 tracking events/mo'
-    ],
-    unitPriceText: 'billed yearly ($96) - 20% savings',
-    isHighlighted: true,
-    isBanner: true,
-    bannerColor: 'blue',
-    bannerText: 'MOST POPULAR'
-  }, {
-    id: 5,
-    planName: 'scale_yearly',
-    displayName: 'Scale',
-    sku: 'ADT-005',
-    description: 'Scale Plan - Yearly',
-    price: '540.00',
-    displayPrice: '$45',
-    billingFrequency: PLAN_BILLING_FREQUENCY.YEARLY,
-    trialLengthDays: 30,
-    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',
-      '25,000 tracking events/mo'
-    ],
-    unitPriceText: 'billed yearly ($540) - 25% savings',
-    isHighlighted: true,
-    isBanner: true,
-    bannerColor: 'blue',
-    bannerText: 'MOST POPULAR'
-  },
-  // GROWTH PLANS
-  {
-    id: 6,
-    planName: 'growth_monthly',
-    displayName: 'Growth',
-    sku: 'ADT-006',
-    description: 'Growth Plan - Monthly',
-    price: '159.99',
-    displayPrice: '$159.99',
-    billingFrequency: PLAN_BILLING_FREQUENCY.MONTHLY,
-    trialLengthDays: 30,
-    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 ($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: '1344.00',
-    displayPrice: '$112',
-    billingFrequency: PLAN_BILLING_FREQUENCY.YEARLY,
-    trialLengthDays: 30,
-    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 ($1344) - 30% 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;
+import { SubscriptionPlan, PLAN_BILLING_FREQUENCY } from '@adtrackify/at-tracking-event-types';
+
+export const StripeBillingMap: any = {
+  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 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: 30,
+    trialRequiresCreditCard: false,
+    planDesc: [
+      'Fixes IOS14.5 tracking',
+      'Multi Pixel Support',
+      'Enhanced Tracking / Attribution',
+      'Unlimited Facebook Conversion API',
+      'Unlimited Integrations',
+      'Easy no code setup',
+      '1,000 tracking events/mo'
+    ],
+    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: '9.99',
+    displayPrice: '$9.99',
+    billingFrequency: PLAN_BILLING_FREQUENCY.MONTHLY,
+    trialLengthDays: 30,
+    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',
+      '2,500 tracking events/mo'
+    ],
+    unitPriceText: '',
+    isHighlighted: false,
+    isBanner: false,
+  }, {
+    id: 3,
+    planName: 'starter_yearly',
+    displayName: 'Starter',
+    sku: 'ADT-003',
+    description: 'Starter Plan - Yearly',
+    price: '96.00',
+    displayPrice: '$8',
+    billingFrequency: PLAN_BILLING_FREQUENCY.YEARLY,
+    trialLengthDays: 30,
+    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',
+      '2,500 tracking events/mo'
+    ],
+    unitPriceText: 'billed yearly ($96) - 20% savings',
+    isHighlighted: false,
+    isBanner: false
+  },
+  // SCALE PLANS
+  {
+    id: 4,
+    planName: 'scale_monthly',
+    displayName: 'Scale',
+    sku: 'ADT-004',
+    description: 'Scale Plan - Monthly',
+    price: '59.99',
+    displayPrice: '$59.99',
+    billingFrequency: PLAN_BILLING_FREQUENCY.MONTHLY,
+    trialLengthDays: 30,
+    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',
+      '25,000 tracking events/mo'
+    ],
+    unitPriceText: 'billed yearly ($96) - 20% savings',
+    isHighlighted: true,
+    isBanner: true,
+    bannerColor: 'blue',
+    bannerText: 'MOST POPULAR'
+  }, {
+    id: 5,
+    planName: 'scale_yearly',
+    displayName: 'Scale',
+    sku: 'ADT-005',
+    description: 'Scale Plan - Yearly',
+    price: '540.00',
+    displayPrice: '$45',
+    billingFrequency: PLAN_BILLING_FREQUENCY.YEARLY,
+    trialLengthDays: 30,
+    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',
+      '25,000 tracking events/mo'
+    ],
+    unitPriceText: 'billed yearly ($540) - 25% savings',
+    isHighlighted: true,
+    isBanner: true,
+    bannerColor: 'blue',
+    bannerText: 'MOST POPULAR'
+  },
+  // GROWTH PLANS
+  {
+    id: 6,
+    planName: 'growth_monthly',
+    displayName: 'Growth',
+    sku: 'ADT-006',
+    description: 'Growth Plan - Monthly',
+    price: '159.99',
+    displayPrice: '$159.99',
+    billingFrequency: PLAN_BILLING_FREQUENCY.MONTHLY,
+    trialLengthDays: 30,
+    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 ($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: '1344.00',
+    displayPrice: '$112',
+    billingFrequency: PLAN_BILLING_FREQUENCY.YEARLY,
+    trialLengthDays: 30,
+    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 ($1344) - 30% 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 +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;
 };