@adtrackify/at-service-common 2.2.0 → 3.0.2

package/dist/esm/clients/third-party/shopify-client.js

@@ -1,147 +1,147 @@
-import { axiosHttpService } from '../generic/http-client.js';
-import { Logger } from '../../index.js';
-export class ShopifyClient {
-    static _shopify_api_version = process.env.SHOPIFY_API_VERSION;
-    static client;
-    static getConfig = (shopifyDomain, accessToken) => {
-        const config = {
-            baseURL: `https://${shopifyDomain}/admin/api/${this._shopify_api_version}`,
-            headers: {
-                common: {
-                    'X-Shopify-Access-Token': accessToken,
-                },
-            },
-        };
-        return config;
-    };
-    static getClient = () => {
-        this.client = this.client ?? axiosHttpService();
-        return this.client;
-    };
-    static registerApp = async (shop, code, appKey, appSecret) => {
-        const client = this.getClient();
-        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, accessToken, eventBridgeArn, topic) => {
-        const client = this.getClient();
-        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) {
-            Logger.error('Failed to register Webhook Topic', { res, shop, accessToken, eventBridgeArn, topic, url, payload });
-        }
-        Logger.debug('Shopify Client Webhook Registration Response', { registrationResponse: res });
-        return res;
-    };
-    static updateShopifyAppMetafield = async (shop, accessToken, pixelId) => {
-        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) {
-            Logger.error('Failed to update Shopify app Metafield ', { shop, accessToken, url, payload });
-        }
-        return res;
-    };
-    static getShopifyStoreProperties = async (shop, accessToken) => {
-        const url = `https://${shop}/admin/api/${this._shopify_api_version}/shop.json`;
-        const res = await this.genericShopifyGet(url, accessToken);
-        if (res.status >= 400) {
-            Logger.error('Failed to get Shopify Store Properties', { shop, accessToken, url });
-        }
-        return res;
-    };
-    static createAppSubscription = async (shop, accessToken, planName, price, returnUrl, trialDays, test) => {
-        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) {
-            Logger.error('Failed to create App Subscription', { shop, accessToken, url });
-        }
-        return res;
-    };
-    static cancelAppSubscription = async (shop, accessToken, chargeId) => {
-        const url = `https://${shop}/admin/api/${this._shopify_api_version}/recurring_application_charges/${chargeId}.json`;
-        const client = this.getClient();
-        const res = await client.delete(url, { headers: { 'X-Shopify-Access-Token': accessToken } });
-        if (res.status !== 200) {
-            Logger.error('Failed to cancel recurring App billing', { shop, accessToken, url });
-        }
-        return res;
-    };
-    static listAppSubscriptions = async (shop, accessToken) => {
-        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) {
-            Logger.error('Failed to get App Subscriptions', { shop, accessToken, url });
-        }
-        return res;
-    };
-    static getOrder = async (shop, accessToken, orderId) => {
-        const url = `https://${shop}/admin/api/${this._shopify_api_version}/orders/${orderId}.json`;
-        const res = await this.genericShopifyGet(url, accessToken);
-        if (res.status >= 400) {
-            Logger.error('Failed to get Order', { res, shop, accessToken, url, orderId });
-        }
-        return res;
-    };
-    static getProduct = async (shop, accessToken, productId) => {
-        const url = `https://${shop}/admin/api/${this._shopify_api_version}/products/${productId}.json`;
-        const res = await this.genericShopifyGet(url, accessToken);
-        if (res.status >= 400) {
-            Logger.error('Failed to get Product', { res, shop, accessToken, url, productId });
-        }
-        return res;
-    };
-    static genericShopifyPost = async (url, accessToken, payload) => {
-        const client = this.getClient();
-        const res = await client.post(url, payload, { headers: { 'X-Shopify-Access-Token': accessToken, 'Content-Type': 'application/json' } });
-        Logger.debug('Shopify Client Response', { res });
-        return res;
-    };
-    static genericShopifyGet = async (url, accessToken) => {
-        const client = this.getClient();
-        const res = await client.get(url, { headers: { 'X-Shopify-Access-Token': accessToken } });
-        Logger.debug('Shopify Client Response', { res });
-        return res;
-    };
-    static genericShopifyPut = async (url, accessToken, payload) => {
-        const client = this.getClient();
-        const res = await client.put(url, payload, { headers: { 'X-Shopify-Access-Token': accessToken } });
-        Logger.debug('Shopify Client Response', { res });
-        return res;
-    };
-    static unregisterWebhook = async (shop, webhookId, accessToken) => {
-        const client = this.getClient();
-        const url = `https://${shop}/admin/api/${this._shopify_api_version}/webhooks/${webhookId}.json`;
-        const res = await client.delete(url, { headers: { 'X-Shopify-Access-Token': accessToken } });
-        Logger.debug('Shopify Client Response', { res });
-        return res;
-    };
-}
+import { axiosHttpService } from '../generic/http-client.js';
+import { Logger } from '../../index.js';
+export class ShopifyClient {
+    static _shopify_api_version = process.env.SHOPIFY_API_VERSION;
+    static client;
+    static getConfig = (shopifyDomain, accessToken) => {
+        const config = {
+            baseURL: `https://${shopifyDomain}/admin/api/${this._shopify_api_version}`,
+            headers: {
+                common: {
+                    'X-Shopify-Access-Token': accessToken,
+                },
+            },
+        };
+        return config;
+    };
+    static getClient = () => {
+        this.client = this.client ?? axiosHttpService();
+        return this.client;
+    };
+    static registerApp = async (shop, code, appKey, appSecret) => {
+        const client = this.getClient();
+        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, accessToken, eventBridgeArn, topic) => {
+        const client = this.getClient();
+        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) {
+            Logger.error('Failed to register Webhook Topic', { res, shop, accessToken, eventBridgeArn, topic, url, payload });
+        }
+        Logger.debug('Shopify Client Webhook Registration Response', { registrationResponse: res });
+        return res;
+    };
+    static updateShopifyAppMetafield = async (shop, accessToken, pixelId) => {
+        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) {
+            Logger.error('Failed to update Shopify app Metafield ', { shop, accessToken, url, payload });
+        }
+        return res;
+    };
+    static getShopifyStoreProperties = async (shop, accessToken) => {
+        const url = `https://${shop}/admin/api/${this._shopify_api_version}/shop.json`;
+        const res = await this.genericShopifyGet(url, accessToken);
+        if (res.status >= 400) {
+            Logger.error('Failed to get Shopify Store Properties', { shop, accessToken, url });
+        }
+        return res;
+    };
+    static createAppSubscription = async (shop, accessToken, planName, price, returnUrl, trialDays, test) => {
+        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) {
+            Logger.error('Failed to create App Subscription', { shop, accessToken, url });
+        }
+        return res;
+    };
+    static cancelAppSubscription = async (shop, accessToken, chargeId) => {
+        const url = `https://${shop}/admin/api/${this._shopify_api_version}/recurring_application_charges/${chargeId}.json`;
+        const client = this.getClient();
+        const res = await client.delete(url, { headers: { 'X-Shopify-Access-Token': accessToken } });
+        if (res.status !== 200) {
+            Logger.error('Failed to cancel recurring App billing', { shop, accessToken, url });
+        }
+        return res;
+    };
+    static listAppSubscriptions = async (shop, accessToken) => {
+        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) {
+            Logger.error('Failed to get App Subscriptions', { shop, accessToken, url });
+        }
+        return res;
+    };
+    static getOrder = async (shop, accessToken, orderId) => {
+        const url = `https://${shop}/admin/api/${this._shopify_api_version}/orders/${orderId}.json`;
+        const res = await this.genericShopifyGet(url, accessToken);
+        if (res.status >= 400) {
+            Logger.error('Failed to get Order', { res, shop, accessToken, url, orderId });
+        }
+        return res;
+    };
+    static getProduct = async (shop, accessToken, productId) => {
+        const url = `https://${shop}/admin/api/${this._shopify_api_version}/products/${productId}.json`;
+        const res = await this.genericShopifyGet(url, accessToken);
+        if (res.status >= 400) {
+            Logger.error('Failed to get Product', { res, shop, accessToken, url, productId });
+        }
+        return res;
+    };
+    static genericShopifyPost = async (url, accessToken, payload) => {
+        const client = this.getClient();
+        const res = await client.post(url, payload, { headers: { 'X-Shopify-Access-Token': accessToken, 'Content-Type': 'application/json' } });
+        Logger.debug('Shopify Client Response', { res });
+        return res;
+    };
+    static genericShopifyGet = async (url, accessToken) => {
+        const client = this.getClient();
+        const res = await client.get(url, { headers: { 'X-Shopify-Access-Token': accessToken } });
+        Logger.debug('Shopify Client Response', { res });
+        return res;
+    };
+    static genericShopifyPut = async (url, accessToken, payload) => {
+        const client = this.getClient();
+        const res = await client.put(url, payload, { headers: { 'X-Shopify-Access-Token': accessToken } });
+        Logger.debug('Shopify Client Response', { res });
+        return res;
+    };
+    static unregisterWebhook = async (shop, webhookId, accessToken) => {
+        const client = this.getClient();
+        const url = `https://${shop}/admin/api/${this._shopify_api_version}/webhooks/${webhookId}.json`;
+        const res = await client.delete(url, { headers: { 'X-Shopify-Access-Token': accessToken } });
+        Logger.debug('Shopify Client Response', { res });
+        return res;
+    };
+}
 //# sourceMappingURL=shopify-client.js.map

package/dist/esm/helpers/index.d.ts

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

package/dist/esm/helpers/index.js

@@ -1,5 +1,6 @@
-export * from './input-validation-helper.js';
-export * from './logging-helper.js';
-export * from './response-helper.js';
-export * from './shopify-helper.js';
+export * from './input-validation-helper.js';
+export * from './logging-helper.js';
+export * from './response-helper.js';
+export * from './shopify-helper.js';
+export * from './subscription-helper.js';
 //# sourceMappingURL=index.js.map

package/dist/esm/helpers/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/helpers/index.ts"],"names":[],"mappings":"AAAA,cAAc,8BAA8B,CAAC;AAC7C,cAAc,qBAAqB,CAAC;AACpC,cAAc,sBAAsB,CAAC;AACrC,cAAc,qBAAqB,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/helpers/index.ts"],"names":[],"mappings":"AAAA,cAAc,8BAA8B,CAAC;AAC7C,cAAc,qBAAqB,CAAC;AACpC,cAAc,sBAAsB,CAAC;AACrC,cAAc,qBAAqB,CAAC;AACpC,cAAc,0BAA0B,CAAC"}

package/dist/esm/helpers/input-validation-helper.d.ts

@@ -1,3 +1,3 @@
-import Joi from 'joi';
-export declare const validateInput: (schema: Joi.ObjectSchema<any>, input: any) => any;
-export declare const validateAndTransformInput: (schema: Joi.ObjectSchema<any>, input: any) => any;
+import Joi from 'joi';
+export declare const validateInput: (schema: Joi.ObjectSchema<any>, input: any) => any;
+export declare const validateAndTransformInput: (schema: Joi.ObjectSchema<any>, input: any) => any;

package/dist/esm/helpers/input-validation-helper.js

@@ -1,20 +1,20 @@
-import { Logger } from './logging-helper.js';
-import { HttpError } from '../libs/http-error.js';
-export const validateInput = (schema, input) => {
-    const { error, value } = schema.validate(input);
-    if (error) {
-        Logger.info('', { error });
-        const httperr = HttpError.badRequest('Bad Request', {
-            errors: error.details.map((detail) => ({
-                message: detail?.message,
-                key: detail?.context?.key,
-                path: detail?.path,
-            })),
-        });
-        Logger.error('validation failure', { httperr });
-        throw httperr;
-    }
-    return value;
-};
-export const validateAndTransformInput = validateInput;
+import { Logger } from './logging-helper.js';
+import { HttpError } from '../libs/http-error.js';
+export const validateInput = (schema, input) => {
+    const { error, value } = schema.validate(input);
+    if (error) {
+        Logger.info('', { error });
+        const httperr = HttpError.badRequest('Bad Request', {
+            errors: error.details.map((detail) => ({
+                message: detail?.message,
+                key: detail?.context?.key,
+                path: detail?.path,
+            })),
+        });
+        Logger.error('validation failure', { httperr });
+        throw httperr;
+    }
+    return value;
+};
+export const validateAndTransformInput = validateInput;
 //# sourceMappingURL=input-validation-helper.js.map

package/dist/esm/helpers/logging-helper.d.ts

@@ -1,15 +1,15 @@
-export declare const LogLevelId: {
-    trace: number;
-    debug: number;
-    info: number;
-    warn: number;
-    error: number;
-};
-export declare const configureLogger: (event: any, context: any, debug?: boolean) => void;
-export declare const Logger: {
-    log: (logLevel: string, msg: string | Error, meta?: object | undefined, tags?: string[] | undefined) => void;
-    debug: (msg: string, meta?: object | undefined, tags?: string[] | undefined) => void;
-    info: (msg: string, meta?: object | undefined, tags?: string[] | undefined) => void;
-    warn: (msg: string, meta?: object | undefined, tags?: string[] | undefined) => void;
-    error: (msg: string | Error, meta?: object | undefined, tags?: string[] | undefined) => void;
-};
+export declare const LogLevelId: {
+    trace: number;
+    debug: number;
+    info: number;
+    warn: number;
+    error: number;
+};
+export declare const configureLogger: (event: any, context: any, debug?: boolean) => void;
+export declare const Logger: {
+    log: (logLevel: string, msg: string | Error, meta?: object | undefined, tags?: string[] | undefined) => void;
+    debug: (msg: string, meta?: object | undefined, tags?: string[] | undefined) => void;
+    info: (msg: string, meta?: object | undefined, tags?: string[] | undefined) => void;
+    warn: (msg: string, meta?: object | undefined, tags?: string[] | undefined) => void;
+    error: (msg: string | Error, meta?: object | undefined, tags?: string[] | undefined) => void;
+};

package/dist/esm/helpers/logging-helper.js

@@ -1,54 +1,54 @@
-import * as _logger from 'lambda-log';
-const stage = process?.env?.STAGE;
-const LEVEL = process?.env?.LOG_LEVEL ?? 'info';
-export const LogLevelId = {
-    trace: 0,
-    debug: 1,
-    info: 2,
-    warn: 3,
-    error: 4,
-};
-export const configureLogger = (event, context, debug = LEVEL === 'debug') => {
-    _logger.options.meta.stage = stage;
-    _logger.options.meta.source_name = context?.functionName || 'unknown';
-    _logger.options.meta.awsRequestId = context?.awsRequestId || 'unknown';
-    _logger.options.meta.lambdaEvent = event;
-    _logger.options.debug = debug;
-};
-export const Logger = {
-    log: (logLevel, msg, meta = {}, tags) => {
-        if (logLevel === 'debug') {
-            Logger.debug(msg, meta, tags);
-        }
-        else if (logLevel === 'info') {
-            Logger.info(msg, meta, tags);
-        }
-        else if (logLevel === 'warn') {
-            Logger.warn(msg, meta, tags);
-        }
-        else if (logLevel === 'error') {
-            Logger.error(msg, meta, tags);
-        }
-    },
-    debug: (msg, meta, tags) => {
-        if (LogLevelId['debug'] >= LogLevelId[LEVEL]) {
-            _logger.debug(msg, meta, tags);
-        }
-    },
-    info: (msg, meta, tags) => {
-        if (LogLevelId['info'] >= LogLevelId[LEVEL]) {
-            _logger.info(msg, meta, tags);
-        }
-    },
-    warn: (msg, meta, tags) => {
-        if (LogLevelId['warn'] >= LogLevelId[LEVEL]) {
-            _logger.warn(msg, meta, tags);
-        }
-    },
-    error: (msg, meta, tags) => {
-        if (LogLevelId['error'] >= LogLevelId[LEVEL]) {
-            _logger.error(msg, meta, tags);
-        }
-    }
-};
+import * as _logger from 'lambda-log';
+const stage = process?.env?.STAGE;
+const LEVEL = process?.env?.LOG_LEVEL ?? 'info';
+export const LogLevelId = {
+    trace: 0,
+    debug: 1,
+    info: 2,
+    warn: 3,
+    error: 4,
+};
+export const configureLogger = (event, context, debug = LEVEL === 'debug') => {
+    _logger.options.meta.stage = stage;
+    _logger.options.meta.source_name = context?.functionName || 'unknown';
+    _logger.options.meta.awsRequestId = context?.awsRequestId || 'unknown';
+    _logger.options.meta.lambdaEvent = event;
+    _logger.options.debug = debug;
+};
+export const Logger = {
+    log: (logLevel, msg, meta = {}, tags) => {
+        if (logLevel === 'debug') {
+            Logger.debug(msg, meta, tags);
+        }
+        else if (logLevel === 'info') {
+            Logger.info(msg, meta, tags);
+        }
+        else if (logLevel === 'warn') {
+            Logger.warn(msg, meta, tags);
+        }
+        else if (logLevel === 'error') {
+            Logger.error(msg, meta, tags);
+        }
+    },
+    debug: (msg, meta, tags) => {
+        if (LogLevelId['debug'] >= LogLevelId[LEVEL]) {
+            _logger.debug(msg, meta, tags);
+        }
+    },
+    info: (msg, meta, tags) => {
+        if (LogLevelId['info'] >= LogLevelId[LEVEL]) {
+            _logger.info(msg, meta, tags);
+        }
+    },
+    warn: (msg, meta, tags) => {
+        if (LogLevelId['warn'] >= LogLevelId[LEVEL]) {
+            _logger.warn(msg, meta, tags);
+        }
+    },
+    error: (msg, meta, tags) => {
+        if (LogLevelId['error'] >= LogLevelId[LEVEL]) {
+            _logger.error(msg, meta, tags);
+        }
+    }
+};
 //# sourceMappingURL=logging-helper.js.map

package/dist/esm/helpers/response-helper.d.ts

@@ -1,15 +1,15 @@
-export declare const success: (body: any, additionalHeaders?: any) => {
-    statusCode: number;
-    headers: any;
-    body: string;
-};
-export declare const failure: (error: any, statusCode?: number) => {
-    statusCode: number;
-    headers: any;
-    body: string;
-};
-export declare const buildResponse: (statusCode: number, body?: any, additionalHeaders?: any) => {
-    statusCode: number;
-    headers: any;
-    body: string;
-};
+export declare const success: (body: any, additionalHeaders?: any) => {
+    statusCode: number;
+    headers: any;
+    body: string;
+};
+export declare const failure: (error: any, statusCode?: number) => {
+    statusCode: number;
+    headers: any;
+    body: string;
+};
+export declare const buildResponse: (statusCode: number, body?: any, additionalHeaders?: any) => {
+    statusCode: number;
+    headers: any;
+    body: string;
+};

package/dist/esm/helpers/response-helper.js

@@ -1,37 +1,37 @@
-export const success = (body, additionalHeaders = {}) => {
-    return buildResponse(200, body, additionalHeaders);
-};
-const defaultError = {
-    message: 'internalServerError'
-};
-export const failure = (error, 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, body = {}, additionalHeaders = {}) => {
-    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',
-            ...additionalHeaders
-        },
-        body: JSON.stringify(body),
-    };
-};
+export const success = (body, additionalHeaders = {}) => {
+    return buildResponse(200, body, additionalHeaders);
+};
+const defaultError = {
+    message: 'internalServerError'
+};
+export const failure = (error, 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, body = {}, additionalHeaders = {}) => {
+    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',
+            ...additionalHeaders
+        },
+        body: JSON.stringify(body),
+    };
+};
 //# sourceMappingURL=response-helper.js.map

package/dist/esm/helpers/shopify-helper.d.ts

@@ -1,9 +1,9 @@
-export interface ShopifyRequestValidationParameters {
-    code: string;
-    hmac?: string;
-    shop: string;
-    state: string;
-    timestamp: string;
-}
-export declare const isShopifyRequestValid: (validationParams: ShopifyRequestValidationParameters, validationHmac: string, shopifyAppApiSecret: string) => boolean;
-export declare const validateShopifyRequest: (validationParams: ShopifyRequestValidationParameters, validationHmac: string, shopifyAppApiSecret: string) => boolean;
+export interface ShopifyRequestValidationParameters {
+    code: string;
+    hmac?: string;
+    shop: string;
+    state: string;
+    timestamp: string;
+}
+export declare const isShopifyRequestValid: (validationParams: ShopifyRequestValidationParameters, validationHmac: string, shopifyAppApiSecret: string) => boolean;
+export declare const validateShopifyRequest: (validationParams: ShopifyRequestValidationParameters, validationHmac: string, shopifyAppApiSecret: string) => boolean;