@adtrackify/at-service-common 1.1.12 → 1.1.15
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.editorconfig +12 -12
- package/.vscode/settings.json +9 -9
- package/bitbucket-pipelines.yml +20 -20
- package/dist/index.d.ts +5 -5
- package/dist/index.js +27 -1
- package/dist/index.js.map +3 -3
- package/jest.config.ts +40 -40
- package/package.json +2 -2
- package/src/__tests__/helpers/subscription-helper.spec.ts +40 -40
- package/src/clients/generic/axios.d.ts +7 -7
- package/src/clients/generic/dynamodb-client.ts +2 -2
- package/src/clients/generic/s3-client.ts +1 -1
- package/src/clients/internal-api/destinations-client.ts +58 -58
- package/src/clients/internal-api/index.ts +4 -4
- package/src/clients/internal-api/shopify-app-install-client.ts +66 -66
- package/src/clients/third-party/shopify-client.ts +139 -139
- package/src/helpers/index.ts +5 -5
- package/src/helpers/input-validation-helper.ts +21 -21
- package/src/helpers/shopify-helper.ts +39 -39
- package/src/index.ts +4 -4
- package/src/libs/index.ts +7 -7
- package/src/libs/url.ts +9 -9
- package/src/services/eventbridge-integration-service.ts +44 -44
- package/src/types/internal-events/event-detail-types.ts +9 -9
package/src/helpers/index.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
export * from './input-validation-helper';
|
|
2
|
-
export * from './logging-helper';
|
|
3
|
-
export * from './response-helper';
|
|
4
|
-
export * from './shopify-helper';
|
|
5
|
-
export * from './subscription-helper';
|
|
1
|
+
export * from './input-validation-helper';
|
|
2
|
+
export * from './logging-helper';
|
|
3
|
+
export * from './response-helper';
|
|
4
|
+
export * from './shopify-helper';
|
|
5
|
+
export * from './subscription-helper';
|
|
@@ -1,22 +1,22 @@
|
|
|
1
|
-
import Joi from 'joi';
|
|
2
|
-
import * as log from 'lambda-log';
|
|
3
|
-
import { HttpError } from '../libs/http-error';
|
|
4
|
-
|
|
5
|
-
export const validateInput = (schema: Joi.ObjectSchema<any>, input: any) => {
|
|
6
|
-
const { error, value } = schema.validate(input);
|
|
7
|
-
if (error) {
|
|
8
|
-
log.info('', { error });
|
|
9
|
-
|
|
10
|
-
const httperr = HttpError.badRequest('Bad Request', {
|
|
11
|
-
errors: error.details.map(detail => ({
|
|
12
|
-
message: detail?.message,
|
|
13
|
-
key: detail?.context?.key,
|
|
14
|
-
path: detail?.path,
|
|
15
|
-
}))
|
|
16
|
-
});
|
|
17
|
-
|
|
18
|
-
log.info('', { httperr });
|
|
19
|
-
throw httperr;
|
|
20
|
-
}
|
|
21
|
-
return value;
|
|
1
|
+
import Joi from 'joi';
|
|
2
|
+
import * as log from 'lambda-log';
|
|
3
|
+
import { HttpError } from '../libs/http-error';
|
|
4
|
+
|
|
5
|
+
export const validateInput = (schema: Joi.ObjectSchema<any>, input: any) => {
|
|
6
|
+
const { error, value } = schema.validate(input);
|
|
7
|
+
if (error) {
|
|
8
|
+
log.info('', { error });
|
|
9
|
+
|
|
10
|
+
const httperr = HttpError.badRequest('Bad Request', {
|
|
11
|
+
errors: error.details.map(detail => ({
|
|
12
|
+
message: detail?.message,
|
|
13
|
+
key: detail?.context?.key,
|
|
14
|
+
path: detail?.path,
|
|
15
|
+
}))
|
|
16
|
+
});
|
|
17
|
+
|
|
18
|
+
log.info('', { httperr });
|
|
19
|
+
throw httperr;
|
|
20
|
+
}
|
|
21
|
+
return value;
|
|
22
22
|
};
|
|
@@ -1,39 +1,39 @@
|
|
|
1
|
-
import { createHmac } from 'crypto';
|
|
2
|
-
import * as log from 'lambda-log';
|
|
3
|
-
import { HttpError } from '../libs';
|
|
4
|
-
import { mapObjectToQueryString } from '../libs/url';
|
|
5
|
-
export interface ShopifyRequestValidationParameters {
|
|
6
|
-
code: string,
|
|
7
|
-
hmac?: string,
|
|
8
|
-
shop: string,
|
|
9
|
-
state: string,
|
|
10
|
-
timestamp: string;
|
|
11
|
-
}
|
|
12
|
-
|
|
13
|
-
export const isShopifyRequestValid = (validationParams: ShopifyRequestValidationParameters, validationHmac: string, shopifyAppApiSecret: string): boolean => {
|
|
14
|
-
// remove hmac if it exists
|
|
15
|
-
// map input to query string
|
|
16
|
-
// generate hash using api secret key and validate it matches hmac
|
|
17
|
-
delete validationParams.hmac;
|
|
18
|
-
const hmacString = mapObjectToQueryString(validationParams);
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
const generatedHash = createHmac('sha256', shopifyAppApiSecret)
|
|
22
|
-
.update(hmacString)
|
|
23
|
-
.digest('hex');
|
|
24
|
-
|
|
25
|
-
return generatedHash === validationHmac;
|
|
26
|
-
};
|
|
27
|
-
|
|
28
|
-
export const validateShopifyRequest = (validationParams: ShopifyRequestValidationParameters, validationHmac: string, shopifyAppApiSecret: string) => {
|
|
29
|
-
log.info('Validating shopify request is authentic', { validationParams });
|
|
30
|
-
const isValid = isShopifyRequestValid(validationParams, validationHmac as string, shopifyAppApiSecret);
|
|
31
|
-
if (!isValid) {
|
|
32
|
-
const message = 'Failed: Shopify Request hmac validation';
|
|
33
|
-
log.error(message);
|
|
34
|
-
throw HttpError.badRequest(message);
|
|
35
|
-
}
|
|
36
|
-
log.info('Sucess: Shopify Request hmac validation');
|
|
37
|
-
return true;
|
|
38
|
-
}
|
|
39
|
-
|
|
1
|
+
import { createHmac } from 'crypto';
|
|
2
|
+
import * as log from 'lambda-log';
|
|
3
|
+
import { HttpError } from '../libs';
|
|
4
|
+
import { mapObjectToQueryString } from '../libs/url';
|
|
5
|
+
export interface ShopifyRequestValidationParameters {
|
|
6
|
+
code: string,
|
|
7
|
+
hmac?: string,
|
|
8
|
+
shop: string,
|
|
9
|
+
state: string,
|
|
10
|
+
timestamp: string;
|
|
11
|
+
}
|
|
12
|
+
|
|
13
|
+
export const isShopifyRequestValid = (validationParams: ShopifyRequestValidationParameters, validationHmac: string, shopifyAppApiSecret: string): boolean => {
|
|
14
|
+
// remove hmac if it exists
|
|
15
|
+
// map input to query string
|
|
16
|
+
// generate hash using api secret key and validate it matches hmac
|
|
17
|
+
delete validationParams.hmac;
|
|
18
|
+
const hmacString = mapObjectToQueryString(validationParams);
|
|
19
|
+
|
|
20
|
+
|
|
21
|
+
const generatedHash = createHmac('sha256', shopifyAppApiSecret)
|
|
22
|
+
.update(hmacString)
|
|
23
|
+
.digest('hex');
|
|
24
|
+
|
|
25
|
+
return generatedHash === validationHmac;
|
|
26
|
+
};
|
|
27
|
+
|
|
28
|
+
export const validateShopifyRequest = (validationParams: ShopifyRequestValidationParameters, validationHmac: string, shopifyAppApiSecret: string) => {
|
|
29
|
+
log.info('Validating shopify request is authentic', { validationParams });
|
|
30
|
+
const isValid = isShopifyRequestValid(validationParams, validationHmac as string, shopifyAppApiSecret);
|
|
31
|
+
if (!isValid) {
|
|
32
|
+
const message = 'Failed: Shopify Request hmac validation';
|
|
33
|
+
log.error(message);
|
|
34
|
+
throw HttpError.badRequest(message);
|
|
35
|
+
}
|
|
36
|
+
log.info('Sucess: Shopify Request hmac validation');
|
|
37
|
+
return true;
|
|
38
|
+
}
|
|
39
|
+
|
package/src/index.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
export * from './clients';
|
|
2
|
-
export * from './helpers';
|
|
3
|
-
export * from './libs';
|
|
4
|
-
export * from './types';
|
|
1
|
+
export * from './clients';
|
|
2
|
+
export * from './helpers';
|
|
3
|
+
export * from './libs';
|
|
4
|
+
export * from './types';
|
|
5
5
|
export * from './services';
|
package/src/libs/index.ts
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
|
-
export * from '../helpers/shopify-helper';
|
|
2
|
-
export * from './crypto';
|
|
3
|
-
export * from './dates';
|
|
4
|
-
export * from './http-error';
|
|
5
|
-
export * from './http-status-codes';
|
|
6
|
-
export * from './url';
|
|
7
|
-
|
|
1
|
+
export * from '../helpers/shopify-helper';
|
|
2
|
+
export * from './crypto';
|
|
3
|
+
export * from './dates';
|
|
4
|
+
export * from './http-error';
|
|
5
|
+
export * from './http-status-codes';
|
|
6
|
+
export * from './url';
|
|
7
|
+
|
package/src/libs/url.ts
CHANGED
|
@@ -1,10 +1,10 @@
|
|
|
1
|
-
// Record<string, string> is any object
|
|
2
|
-
export const mapObjectToQueryString = (inputObj: any): string => {
|
|
3
|
-
const qsp = Object.entries(inputObj).sort((a, b) => a[ 0 ] < b[ 0 ] ? -1 : 1);
|
|
4
|
-
const urlParams = new URLSearchParams();
|
|
5
|
-
qsp.map(p => {
|
|
6
|
-
urlParams.append(p[ 0 ], p[ 1 ] as string);
|
|
7
|
-
});
|
|
8
|
-
const qs = urlParams.toString();
|
|
9
|
-
return qs;
|
|
1
|
+
// Record<string, string> is any object
|
|
2
|
+
export const mapObjectToQueryString = (inputObj: any): string => {
|
|
3
|
+
const qsp = Object.entries(inputObj).sort((a, b) => a[ 0 ] < b[ 0 ] ? -1 : 1);
|
|
4
|
+
const urlParams = new URLSearchParams();
|
|
5
|
+
qsp.map(p => {
|
|
6
|
+
urlParams.append(p[ 0 ], p[ 1 ] as string);
|
|
7
|
+
});
|
|
8
|
+
const qs = urlParams.toString();
|
|
9
|
+
return qs;
|
|
10
10
|
};
|
|
@@ -1,44 +1,44 @@
|
|
|
1
|
-
import { EventBridgeClient } from '../clients';
|
|
2
|
-
import { Message, TemplatedMessage } from 'postmark';
|
|
3
|
-
|
|
4
|
-
export const enum PostmarkRequestType {
|
|
5
|
-
SINGLE_EMAIL = 'single_email',
|
|
6
|
-
TEMPLATE_EMAIL = 'template_email'
|
|
7
|
-
}
|
|
8
|
-
|
|
9
|
-
export enum ADTRACKIFY_EVENT_BRIDGE_EVENTS {
|
|
10
|
-
SEND_POSTMARK_EMAIL = 'integration.sendPostmarkEmail',
|
|
11
|
-
}
|
|
12
|
-
|
|
13
|
-
export class EventBridgeIntegrationService {
|
|
14
|
-
public eventBridgeClient: EventBridgeClient;
|
|
15
|
-
public EVENT_BUS_NAME: string;
|
|
16
|
-
|
|
17
|
-
constructor (eventBusName: string) {
|
|
18
|
-
this.eventBridgeClient = new EventBridgeClient(eventBusName);
|
|
19
|
-
this.EVENT_BUS_NAME = eventBusName;
|
|
20
|
-
}
|
|
21
|
-
|
|
22
|
-
public sendPostmarkEmailEvent = async (eventSource: string, postmarkMessage: Message, postmarkServerToken: string) => {
|
|
23
|
-
return await this.eventBridgeClient.buildAndSendEvent(
|
|
24
|
-
eventSource,
|
|
25
|
-
ADTRACKIFY_EVENT_BRIDGE_EVENTS.SEND_POSTMARK_EMAIL,
|
|
26
|
-
{
|
|
27
|
-
postmarkMessage,
|
|
28
|
-
postmarkRequestType: PostmarkRequestType.SINGLE_EMAIL,
|
|
29
|
-
postmarkServerToken
|
|
30
|
-
});
|
|
31
|
-
};
|
|
32
|
-
|
|
33
|
-
public sendPostmarkTemplatedEmailEvent = async (eventSource: string, postmarkMessage: TemplatedMessage, postmarkServerToken: string) => {
|
|
34
|
-
return await this.eventBridgeClient.buildAndSendEvent(
|
|
35
|
-
eventSource,
|
|
36
|
-
ADTRACKIFY_EVENT_BRIDGE_EVENTS.SEND_POSTMARK_EMAIL,
|
|
37
|
-
{
|
|
38
|
-
postmarkMessage,
|
|
39
|
-
postmarkRequestType: PostmarkRequestType.TEMPLATE_EMAIL,
|
|
40
|
-
postmarkServerToken
|
|
41
|
-
});
|
|
42
|
-
};
|
|
43
|
-
|
|
44
|
-
}
|
|
1
|
+
import { EventBridgeClient } from '../clients';
|
|
2
|
+
import { Message, TemplatedMessage } from 'postmark';
|
|
3
|
+
|
|
4
|
+
export const enum PostmarkRequestType {
|
|
5
|
+
SINGLE_EMAIL = 'single_email',
|
|
6
|
+
TEMPLATE_EMAIL = 'template_email'
|
|
7
|
+
}
|
|
8
|
+
|
|
9
|
+
export enum ADTRACKIFY_EVENT_BRIDGE_EVENTS {
|
|
10
|
+
SEND_POSTMARK_EMAIL = 'integration.sendPostmarkEmail',
|
|
11
|
+
}
|
|
12
|
+
|
|
13
|
+
export class EventBridgeIntegrationService {
|
|
14
|
+
public eventBridgeClient: EventBridgeClient;
|
|
15
|
+
public EVENT_BUS_NAME: string;
|
|
16
|
+
|
|
17
|
+
constructor (eventBusName: string) {
|
|
18
|
+
this.eventBridgeClient = new EventBridgeClient(eventBusName);
|
|
19
|
+
this.EVENT_BUS_NAME = eventBusName;
|
|
20
|
+
}
|
|
21
|
+
|
|
22
|
+
public sendPostmarkEmailEvent = async (eventSource: string, postmarkMessage: Message, postmarkServerToken: string) => {
|
|
23
|
+
return await this.eventBridgeClient.buildAndSendEvent(
|
|
24
|
+
eventSource,
|
|
25
|
+
ADTRACKIFY_EVENT_BRIDGE_EVENTS.SEND_POSTMARK_EMAIL,
|
|
26
|
+
{
|
|
27
|
+
postmarkMessage,
|
|
28
|
+
postmarkRequestType: PostmarkRequestType.SINGLE_EMAIL,
|
|
29
|
+
postmarkServerToken
|
|
30
|
+
});
|
|
31
|
+
};
|
|
32
|
+
|
|
33
|
+
public sendPostmarkTemplatedEmailEvent = async (eventSource: string, postmarkMessage: TemplatedMessage, postmarkServerToken: string) => {
|
|
34
|
+
return await this.eventBridgeClient.buildAndSendEvent(
|
|
35
|
+
eventSource,
|
|
36
|
+
ADTRACKIFY_EVENT_BRIDGE_EVENTS.SEND_POSTMARK_EMAIL,
|
|
37
|
+
{
|
|
38
|
+
postmarkMessage,
|
|
39
|
+
postmarkRequestType: PostmarkRequestType.TEMPLATE_EMAIL,
|
|
40
|
+
postmarkServerToken
|
|
41
|
+
});
|
|
42
|
+
};
|
|
43
|
+
|
|
44
|
+
}
|
|
@@ -1,10 +1,10 @@
|
|
|
1
|
-
export enum ADTRACKIFY_EVENT_TYPES {
|
|
2
|
-
NOTIFY_SHOPIFY_SUBSCRIPTION_CREATED = 'shopifySubscriptionCreated',
|
|
3
|
-
NOTIFY_SUBSCRIPTION_SIGNUP_COMPLETED = 'subscription.signupCompleted',
|
|
4
|
-
REQUEST_SET_ACCOUNT_OWNER = 'setAccountOwner',
|
|
5
|
-
REQUEST_SET_ACCOUNT_SUBSCRIPTION_ID = 'setAccountSubscriptionId',
|
|
6
|
-
}
|
|
7
|
-
|
|
8
|
-
export enum ADTRACKIFY_EVENT_SOURCES {
|
|
9
|
-
SUBSCRIPTIONS = 'subscriptions',
|
|
1
|
+
export enum ADTRACKIFY_EVENT_TYPES {
|
|
2
|
+
NOTIFY_SHOPIFY_SUBSCRIPTION_CREATED = 'shopifySubscriptionCreated',
|
|
3
|
+
NOTIFY_SUBSCRIPTION_SIGNUP_COMPLETED = 'subscription.signupCompleted',
|
|
4
|
+
REQUEST_SET_ACCOUNT_OWNER = 'setAccountOwner',
|
|
5
|
+
REQUEST_SET_ACCOUNT_SUBSCRIPTION_ID = 'setAccountSubscriptionId',
|
|
6
|
+
}
|
|
7
|
+
|
|
8
|
+
export enum ADTRACKIFY_EVENT_SOURCES {
|
|
9
|
+
SUBSCRIPTIONS = 'subscriptions',
|
|
10
10
|
}
|