@shopify/shopify-api 7.5.2 → 7.6.0
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/lib/utils/hmac-validator.d.ts +5 -2
- package/lib/utils/hmac-validator.d.ts.map +1 -1
- package/lib/utils/hmac-validator.js +19 -8
- package/lib/utils/hmac-validator.js.map +1 -1
- package/lib/utils/index.d.ts +3 -1
- package/lib/utils/index.d.ts.map +1 -1
- package/lib/version.d.ts +1 -1
- package/lib/version.js +1 -1
- package/package.json +1 -1
|
@@ -1,6 +1,9 @@
|
|
|
1
1
|
import { ConfigInterface } from '../base-types';
|
|
2
2
|
import { AuthQuery } from '../auth/oauth/types';
|
|
3
|
-
export declare
|
|
4
|
-
export declare function
|
|
3
|
+
export declare type HMACSignator = 'admin' | 'appProxy';
|
|
4
|
+
export declare function generateLocalHmac(config: ConfigInterface): (params: AuthQuery, signator?: HMACSignator) => Promise<string>;
|
|
5
|
+
export declare function validateHmac(config: ConfigInterface): (query: AuthQuery, { signator }?: {
|
|
6
|
+
signator: HMACSignator;
|
|
7
|
+
}) => Promise<boolean>;
|
|
5
8
|
export declare function getCurrentTimeInSec(): number;
|
|
6
9
|
//# sourceMappingURL=hmac-validator.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"hmac-validator.d.ts","sourceRoot":"","sources":["hmac-validator.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,eAAe,EAAC,MAAM,eAAe,CAAC;AAG9C,OAAO,EAAC,SAAS,EAAC,MAAM,qBAAqB,CAAC;
|
|
1
|
+
{"version":3,"file":"hmac-validator.d.ts","sourceRoot":"","sources":["hmac-validator.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,eAAe,EAAC,MAAM,eAAe,CAAC;AAG9C,OAAO,EAAC,SAAS,EAAC,MAAM,qBAAqB,CAAC;AAQ9C,oBAAY,YAAY,GAAG,OAAO,GAAG,UAAU,CAAC;AAmBhD,wBAAgB,iBAAiB,CAAC,MAAM,EAAE,eAAe,YAE7C,SAAS,aACP,YAAY,KACrB,QAAQ,MAAM,CAAC,CAUnB;AAED,wBAAgB,YAAY,CAAC,MAAM,EAAE,eAAe,WAEzC,SAAS;cACO,YAAY;MAClC,QAAQ,OAAO,CAAC,CAoBpB;AAED,wBAAgB,mBAAmB,WAElC"}
|
|
@@ -8,30 +8,41 @@ const ShopifyErrors = tslib_1.__importStar(require("../error"));
|
|
|
8
8
|
const safe_compare_1 = require("../auth/oauth/safe-compare");
|
|
9
9
|
const processed_query_1 = tslib_1.__importDefault(require("./processed-query"));
|
|
10
10
|
const HMAC_TIMESTAMP_PERMITTED_CLOCK_TOLERANCE_SEC = 90;
|
|
11
|
-
function
|
|
11
|
+
function stringifyQueryForAdmin(query) {
|
|
12
12
|
const processedQuery = new processed_query_1.default();
|
|
13
13
|
Object.keys(query)
|
|
14
14
|
.sort((val1, val2) => val1.localeCompare(val2))
|
|
15
15
|
.forEach((key) => processedQuery.put(key, query[key]));
|
|
16
16
|
return processedQuery.stringify(true);
|
|
17
17
|
}
|
|
18
|
+
function stringifyQueryForAppProxy(query) {
|
|
19
|
+
return Object.entries(query)
|
|
20
|
+
.sort(([val1], [val2]) => val1.localeCompare(val2))
|
|
21
|
+
.reduce((acc, [key, value]) => {
|
|
22
|
+
return `${acc}${key}=${Array.isArray(value) ? value.join(',') : value}`;
|
|
23
|
+
}, '');
|
|
24
|
+
}
|
|
18
25
|
function generateLocalHmac(config) {
|
|
19
|
-
return (params) => tslib_1.__awaiter(this, void 0, void 0, function* () {
|
|
20
|
-
// assumes that 'signature' (from Shopify) will only ever be a hmac value
|
|
26
|
+
return (params, signator = 'admin') => tslib_1.__awaiter(this, void 0, void 0, function* () {
|
|
21
27
|
const { hmac, signature } = params, query = tslib_1.__rest(params, ["hmac", "signature"]);
|
|
22
|
-
const queryString =
|
|
28
|
+
const queryString = signator === 'admin'
|
|
29
|
+
? stringifyQueryForAdmin(query)
|
|
30
|
+
: stringifyQueryForAppProxy(query);
|
|
23
31
|
return (0, crypto_1.createSHA256HMAC)(config.apiSecretKey, queryString, types_1.HashFormat.Hex);
|
|
24
32
|
});
|
|
25
33
|
}
|
|
26
34
|
exports.generateLocalHmac = generateLocalHmac;
|
|
27
35
|
function validateHmac(config) {
|
|
28
|
-
return (query) => tslib_1.__awaiter(this, void 0, void 0, function* () {
|
|
29
|
-
if (
|
|
36
|
+
return (query, { signator } = { signator: 'admin' }) => tslib_1.__awaiter(this, void 0, void 0, function* () {
|
|
37
|
+
if (signator === 'admin' && !query.hmac) {
|
|
30
38
|
throw new ShopifyErrors.InvalidHmacError('Query does not contain an HMAC value.');
|
|
31
39
|
}
|
|
40
|
+
if (signator === 'appProxy' && !query.signature) {
|
|
41
|
+
throw new ShopifyErrors.InvalidHmacError('Query does not contain a signature value.');
|
|
42
|
+
}
|
|
32
43
|
validateHmacTimestamp(query);
|
|
33
|
-
const hmac = query.signature
|
|
34
|
-
const localHmac = yield generateLocalHmac(config)(query);
|
|
44
|
+
const hmac = signator === 'appProxy' ? query.signature : query.hmac;
|
|
45
|
+
const localHmac = yield generateLocalHmac(config)(query, signator);
|
|
35
46
|
return (0, safe_compare_1.safeCompare)(hmac, localHmac);
|
|
36
47
|
});
|
|
37
48
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"hmac-validator.js","sourceRoot":"","sources":["hmac-validator.ts"],"names":[],"mappings":";;;;AACA,iDAAsD;AACtD,sDAAsD;AAEtD,gEAA0C;AAC1C,6DAAuD;AAEvD,gFAA+C;AAE/C,MAAM,4CAA4C,GAAG,EAAE,CAAC;
|
|
1
|
+
{"version":3,"file":"hmac-validator.js","sourceRoot":"","sources":["hmac-validator.ts"],"names":[],"mappings":";;;;AACA,iDAAsD;AACtD,sDAAsD;AAEtD,gEAA0C;AAC1C,6DAAuD;AAEvD,gFAA+C;AAE/C,MAAM,4CAA4C,GAAG,EAAE,CAAC;AAIxD,SAAS,sBAAsB,CAAC,KAAgB;IAC9C,MAAM,cAAc,GAAG,IAAI,yBAAc,EAAE,CAAC;IAC5C,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC;SACf,IAAI,CAAC,CAAC,IAAI,EAAE,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;SAC9C,OAAO,CAAC,CAAC,GAAW,EAAE,EAAE,CAAC,cAAc,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;IAEjE,OAAO,cAAc,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;AACxC,CAAC;AAED,SAAS,yBAAyB,CAAC,KAAgB;IACjD,OAAO,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC;SACzB,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;SAClD,MAAM,CAAC,CAAC,GAAG,EAAE,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;QAC5B,OAAO,GAAG,GAAG,GAAG,GAAG,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,EAAE,CAAC;IAC1E,CAAC,EAAE,EAAE,CAAC,CAAC;AACX,CAAC;AAED,SAAgB,iBAAiB,CAAC,MAAuB;IACvD,OAAO,CACL,MAAiB,EACjB,WAAyB,OAAO,EACf,EAAE;QACnB,MAAM,EAAC,IAAI,EAAE,SAAS,KAAc,MAAM,EAAf,KAAK,kBAAI,MAAM,EAApC,qBAA2B,CAAS,CAAC;QAE3C,MAAM,WAAW,GACf,QAAQ,KAAK,OAAO;YAClB,CAAC,CAAC,sBAAsB,CAAC,KAAK,CAAC;YAC/B,CAAC,CAAC,yBAAyB,CAAC,KAAK,CAAC,CAAC;QAEvC,OAAO,IAAA,yBAAgB,EAAC,MAAM,CAAC,YAAY,EAAE,WAAW,EAAE,kBAAU,CAAC,GAAG,CAAC,CAAC;IAC5E,CAAC,CAAA,CAAC;AACJ,CAAC;AAdD,8CAcC;AAED,SAAgB,YAAY,CAAC,MAAuB;IAClD,OAAO,CACL,KAAgB,EAChB,EAAC,QAAQ,KAA8B,EAAC,QAAQ,EAAE,OAAO,EAAC,EACxC,EAAE;QACpB,IAAI,QAAQ,KAAK,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE;YACvC,MAAM,IAAI,aAAa,CAAC,gBAAgB,CACtC,uCAAuC,CACxC,CAAC;SACH;QAED,IAAI,QAAQ,KAAK,UAAU,IAAI,CAAC,KAAK,CAAC,SAAS,EAAE;YAC/C,MAAM,IAAI,aAAa,CAAC,gBAAgB,CACtC,2CAA2C,CAC5C,CAAC;SACH;QAED,qBAAqB,CAAC,KAAK,CAAC,CAAC;QAE7B,MAAM,IAAI,GAAG,QAAQ,KAAK,UAAU,CAAC,CAAC,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC;QACpE,MAAM,SAAS,GAAG,MAAM,iBAAiB,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;QAEnE,OAAO,IAAA,0BAAW,EAAC,IAAc,EAAE,SAAS,CAAC,CAAC;IAChD,CAAC,CAAA,CAAC;AACJ,CAAC;AAxBD,oCAwBC;AAED,SAAgB,mBAAmB;IACjC,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,CAAC;AACvC,CAAC;AAFD,kDAEC;AAED,SAAS,qBAAqB,CAAC,KAAgB;IAC7C,IACE,IAAI,CAAC,GAAG,CAAC,mBAAmB,EAAE,GAAG,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QACzD,4CAA4C,EAC5C;QACA,MAAM,IAAI,aAAa,CAAC,gBAAgB,CACtC,kDAAkD,CACnD,CAAC;KACH;AACH,CAAC"}
|
package/lib/utils/index.d.ts
CHANGED
|
@@ -2,7 +2,9 @@ import { ConfigInterface } from '../base-types';
|
|
|
2
2
|
export declare function shopifyUtils(config: ConfigInterface): {
|
|
3
3
|
sanitizeShop: (shop: string, throwOnInvalid?: boolean) => string | null;
|
|
4
4
|
sanitizeHost: (host: string, throwOnInvalid?: boolean) => string | null;
|
|
5
|
-
validateHmac: (query: import("..").AuthQuery
|
|
5
|
+
validateHmac: (query: import("..").AuthQuery, { signator }?: {
|
|
6
|
+
signator: import("./hmac-validator").HMACSignator;
|
|
7
|
+
}) => Promise<boolean>;
|
|
6
8
|
versionCompatible: (referenceVersion: import("..").ApiVersion, currentVersion?: import("..").ApiVersion) => boolean;
|
|
7
9
|
versionPriorTo: (referenceVersion: import("..").ApiVersion, currentVersion?: import("..").ApiVersion) => boolean;
|
|
8
10
|
};
|
package/lib/utils/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,eAAe,EAAC,MAAM,eAAe,CAAC;AAM9C,wBAAgB,YAAY,CAAC,MAAM,EAAE,eAAe
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,eAAe,EAAC,MAAM,eAAe,CAAC;AAM9C,wBAAgB,YAAY,CAAC,MAAM,EAAE,eAAe;;;;;;;;EAQnD;AAED,oBAAY,YAAY,GAAG,UAAU,CAAC,OAAO,YAAY,CAAC,CAAC"}
|
package/lib/version.d.ts
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
export declare const SHOPIFY_API_LIBRARY_VERSION = "7.
|
|
1
|
+
export declare const SHOPIFY_API_LIBRARY_VERSION = "7.6.0";
|
|
2
2
|
//# sourceMappingURL=version.d.ts.map
|
package/lib/version.js
CHANGED
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@shopify/shopify-api",
|
|
3
|
-
"version": "7.
|
|
3
|
+
"version": "7.6.0",
|
|
4
4
|
"description": "Shopify API Library for Node - accelerate development with support for authentication, graphql proxy, webhooks",
|
|
5
5
|
"main": "./lib/index.js",
|
|
6
6
|
"types": "./lib/index.d.ts",
|