@shopify/shopify-api 11.2.0 → 11.4.0

package/dist/esm/test-helpers/index.mjs

@@ -0,0 +1,7 @@
+export { setUpValidSession } from './setup-valid-session.mjs';
+export { RequestType, setUpValidRequest } from './setup-valid-request.mjs';
+export { getJwt } from './get-jwt.mjs';
+export { getHmac } from './get-hmac.mjs';
+export { getShopValue } from './get-shop-value.mjs';
+export { API_KEY, API_SECRET_KEY, APP_URL, BASE64_HOST, SHOPIFY_HOST, TEST_SHOP, TEST_SHOP_NAME, USER_ID } from './const.mjs';
+//# sourceMappingURL=index.mjs.map

package/dist/esm/test-helpers/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;"}

package/dist/esm/test-helpers/setup-valid-request.mjs

@@ -0,0 +1,86 @@
+import { HashFormat } from '../runtime/crypto/types.mjs';
+import '../runtime/crypto/crypto.mjs';
+import { createSHA256HMAC } from '../runtime/crypto/utils.mjs';
+import { getShopValue } from './get-shop-value.mjs';
+import { getHostValue } from './get-host-value.mjs';
+import { getJwt } from './get-jwt.mjs';
+import { getHmac } from './get-hmac.mjs';
+
+var RequestType;
+(function (RequestType) {
+    RequestType[RequestType["Admin"] = 0] = "Admin";
+    RequestType[RequestType["Bearer"] = 1] = "Bearer";
+    RequestType[RequestType["Extension"] = 2] = "Extension";
+    RequestType[RequestType["Public"] = 3] = "Public";
+})(RequestType || (RequestType = {}));
+/**
+ * Duplicates a Request object and decorates the duplicated object with fake authorization headers or query string parameters.
+ *
+ * @param {ValidRequestOptions} options Provides the type of authorization method to fake for the provided Request, and the inputs required to fake the authorization.
+ * @param {Request} request The Request object to be decorated with fake authorization headers or query string parameters.
+ * @returns {Request} A duplicate of the provided Request object with faked authorization headers or query string parameters.
+ */
+async function setUpValidRequest(options, request) {
+    let authenticatedRequest;
+    switch (options.type) {
+        case RequestType.Admin:
+            authenticatedRequest = adminRequest(request, options.store, options.apiKey, options.apiSecretKey);
+            break;
+        case RequestType.Bearer:
+            authenticatedRequest = bearerRequest(request, options.store, options.apiKey, options.apiSecretKey);
+            break;
+        case RequestType.Extension:
+            authenticatedRequest = extensionRequest(request, options.store, options.apiSecretKey, options.body, options.headers);
+            break;
+        case RequestType.Public:
+            authenticatedRequest = await publicRequest(request, options.store, options.apiSecretKey);
+            break;
+    }
+    return authenticatedRequest;
+}
+function adminRequest(request, store, apiKey, apiSecretKey) {
+    const { token } = getJwt(store, apiKey, apiSecretKey);
+    const url = new URL(request.url);
+    url.searchParams.set('embedded', '1');
+    url.searchParams.set('shop', getShopValue(store));
+    url.searchParams.set('host', getHostValue(store));
+    url.searchParams.set('id_token', token);
+    return new Request(url.href, request);
+}
+function bearerRequest(request, store, apiKey, apiSecretKey) {
+    const { token } = getJwt(store, apiKey, apiSecretKey);
+    const authenticatedRequest = new Request(request);
+    authenticatedRequest.headers.set('authorization', `Bearer ${token}`);
+    return authenticatedRequest;
+}
+function extensionRequest(request, store, apiSecretKey, body, headers) {
+    const bodyString = JSON.stringify(body);
+    const authenticatedRequest = new Request(request, {
+        method: 'POST',
+        body: bodyString,
+    });
+    authenticatedRequest.headers.set('X-Shopify-Hmac-Sha256', getHmac(bodyString, apiSecretKey));
+    authenticatedRequest.headers.set('X-Shopify-Shop-Domain', getShopValue(store));
+    if (headers) {
+        for (const [key, value] of Object.entries(headers)) {
+            authenticatedRequest.headers.set(key, value);
+        }
+    }
+    return authenticatedRequest;
+}
+async function publicRequest(request, store, apiSecretKey) {
+    const url = new URL(request.url);
+    url.searchParams.set('shop', getShopValue(store));
+    url.searchParams.set('timestamp', String(Math.trunc(Date.now() / 1000) - 1));
+    const params = Object.fromEntries(url.searchParams.entries());
+    const string = Object.entries(params)
+        .sort(([val1], [val2]) => val1.localeCompare(val2))
+        .reduce((acc, [key, value]) => {
+        return `${acc}${key}=${value}`;
+    }, '');
+    url.searchParams.set('signature', await createSHA256HMAC(apiSecretKey, string, HashFormat.Hex));
+    return new Request(url.href, request);
+}
+
+export { RequestType, setUpValidRequest };
+//# sourceMappingURL=setup-valid-request.mjs.map

package/dist/esm/test-helpers/setup-valid-request.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"setup-valid-request.mjs","sources":["../../../../../test-helpers/setup-valid-request.ts"],"sourcesContent":[null],"names":[],"mappings":";;;;;;;;IAOY,YAKX;AALD,CAAA,UAAY,WAAW,EAAA;AACrB,IAAA,WAAA,CAAA,WAAA,CAAA,OAAA,CAAA,GAAA,CAAA,CAAA,GAAA,OAAK,CAAA;AACL,IAAA,WAAA,CAAA,WAAA,CAAA,QAAA,CAAA,GAAA,CAAA,CAAA,GAAA,QAAM,CAAA;AACN,IAAA,WAAA,CAAA,WAAA,CAAA,WAAA,CAAA,GAAA,CAAA,CAAA,GAAA,WAAS,CAAA;AACT,IAAA,WAAA,CAAA,WAAA,CAAA,QAAA,CAAA,GAAA,CAAA,CAAA,GAAA,QAAM,CAAA;AACR,CAAC,EALW,WAAW,KAAX,WAAW,GAKtB,EAAA,CAAA,CAAA,CAAA;AA4BD;;;;;;AAMG;AACI,eAAe,iBAAiB,CACrC,OAA4B,EAC5B,OAAgB,EAAA;AAEhB,IAAA,IAAI,oBAA6B,CAAC;AAClC,IAAA,QAAQ,OAAO,CAAC,IAAI;QAClB,KAAK,WAAW,CAAC,KAAK;AACpB,YAAA,oBAAoB,GAAG,YAAY,CACjC,OAAO,EACP,OAAO,CAAC,KAAK,EACb,OAAO,CAAC,MAAM,EACd,OAAO,CAAC,YAAY,CACrB,CAAC;YACF,MAAM;QACR,KAAK,WAAW,CAAC,MAAM;AACrB,YAAA,oBAAoB,GAAG,aAAa,CAClC,OAAO,EACP,OAAO,CAAC,KAAK,EACb,OAAO,CAAC,MAAM,EACd,OAAO,CAAC,YAAY,CACrB,CAAC;YACF,MAAM;QACR,KAAK,WAAW,CAAC,SAAS;YACxB,oBAAoB,GAAG,gBAAgB,CACrC,OAAO,EACP,OAAO,CAAC,KAAK,EACb,OAAO,CAAC,YAAY,EACpB,OAAO,CAAC,IAAI,EACZ,OAAO,CAAC,OAAO,CAChB,CAAC;YACF,MAAM;QACR,KAAK,WAAW,CAAC,MAAM;AACrB,YAAA,oBAAoB,GAAG,MAAM,aAAa,CACxC,OAAO,EACP,OAAO,CAAC,KAAK,EACb,OAAO,CAAC,YAAY,CACrB,CAAC;YACF,MAAM;KACT;AAED,IAAA,OAAO,oBAAoB,CAAC;AAC9B,CAAC;AAED,SAAS,YAAY,CACnB,OAAgB,EAChB,KAAa,EACb,MAAc,EACd,YAAoB,EAAA;AAEpB,IAAA,MAAM,EAAC,KAAK,EAAC,GAAG,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,YAAY,CAAC,CAAC;IAEpD,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IACjC,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,UAAU,EAAE,GAAG,CAAC,CAAC;AACtC,IAAA,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,MAAM,EAAE,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC;AAClD,IAAA,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,MAAM,EAAE,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC;IAClD,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,UAAU,EAAE,KAAK,CAAC,CAAC;IACxC,OAAO,IAAI,OAAO,CAAC,GAAG,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;AACxC,CAAC;AAED,SAAS,aAAa,CACpB,OAAgB,EAChB,KAAa,EACb,MAAc,EACd,YAAoB,EAAA;AAEpB,IAAA,MAAM,EAAC,KAAK,EAAC,GAAG,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,YAAY,CAAC,CAAC;AAEpD,IAAA,MAAM,oBAAoB,GAAG,IAAI,OAAO,CAAC,OAAO,CAAC,CAAC;IAClD,oBAAoB,CAAC,OAAO,CAAC,GAAG,CAAC,eAAe,EAAE,CAAU,OAAA,EAAA,KAAK,CAAE,CAAA,CAAC,CAAC;AAErE,IAAA,OAAO,oBAAoB,CAAC;AAC9B,CAAC;AAED,SAAS,gBAAgB,CACvB,OAAgB,EAChB,KAAa,EACb,YAAoB,EACpB,IAAS,EACT,OAAgC,EAAA;IAEhC,MAAM,UAAU,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;AAExC,IAAA,MAAM,oBAAoB,GAAG,IAAI,OAAO,CAAC,OAAO,EAAE;AAChD,QAAA,MAAM,EAAE,MAAM;AACd,QAAA,IAAI,EAAE,UAAU;AACjB,KAAA,CAAC,CAAC;AACH,IAAA,oBAAoB,CAAC,OAAO,CAAC,GAAG,CAC9B,uBAAuB,EACvB,OAAO,CAAC,UAAU,EAAE,YAAY,CAAC,CAClC,CAAC;AACF,IAAA,oBAAoB,CAAC,OAAO,CAAC,GAAG,CAC9B,uBAAuB,EACvB,YAAY,CAAC,KAAK,CAAC,CACpB,CAAC;IACF,IAAI,OAAO,EAAE;AACX,QAAA,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE;YAClD,oBAAoB,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;SAC9C;KACF;AAED,IAAA,OAAO,oBAAoB,CAAC;AAC9B,CAAC;AAED,eAAe,aAAa,CAC1B,OAAgB,EAChB,KAAa,EACb,YAAoB,EAAA;IAEpB,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;AACjC,IAAA,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,MAAM,EAAE,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC;IAClD,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,WAAW,EAAE,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;AAE7E,IAAA,MAAM,MAAM,GAAG,MAAM,CAAC,WAAW,CAAC,GAAG,CAAC,YAAY,CAAC,OAAO,EAAE,CAAC,CAAC;AAC9D,IAAA,MAAM,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC;AAClC,SAAA,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;SAClD,MAAM,CAAC,CAAC,GAAG,EAAE,CAAC,GAAG,EAAE,KAAK,CAAC,KAAI;AAC5B,QAAA,OAAO,GAAG,GAAG,CAAA,EAAG,GAAG,CAAI,CAAA,EAAA,KAAK,EAAE,CAAC;KAChC,EAAE,EAAE,CAAC,CAAC;AAET,IAAA,GAAG,CAAC,YAAY,CAAC,GAAG,CAClB,WAAW,EACX,MAAM,gBAAgB,CAAC,YAAY,EAAE,MAAM,EAAE,UAAU,CAAC,GAAG,CAAC,CAC7D,CAAC;IAEF,OAAO,IAAI,OAAO,CAAC,GAAG,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;AACxC;;;;"}

package/dist/esm/test-helpers/setup-valid-session.mjs

@@ -0,0 +1,53 @@
+import { Session } from '../lib/session/session.mjs';
+import { USER_ID } from './const.mjs';
+
+/**
+ * Creates and returns a fake Session for the shop defined in sessionParams.
+ *
+ * @param sessionParams The Session parameters to use when creating the fake Session.
+ * @returns {Session} The fake Session created.
+ */
+function setUpValidSession(sessionParams) {
+    const overrides = { ...sessionParams };
+    const shop = sessionParams.shop;
+    let id = `offline_${shop}`;
+    if (sessionParams.isOnline) {
+        const onlineAccessInfo = sessionParams.onlineAccessInfo;
+        const associated_user = onlineAccessInfo?.associated_user;
+        delete sessionParams.onlineAccessInfo?.associated_user;
+        delete sessionParams.onlineAccessInfo;
+        id = `${shop}_${USER_ID}`;
+        // Expires one day from now
+        overrides.expires =
+            sessionParams.expires || new Date(Date.now() + 1000 * 3600 * 24);
+        overrides.onlineAccessInfo = {
+            associated_user_scope: 'testScope',
+            expires_in: 3600 * 24,
+            associated_user: {
+                id: USER_ID,
+                account_owner: true,
+                collaborator: true,
+                email: 'test@test.test',
+                email_verified: true,
+                first_name: 'Test',
+                last_name: 'User',
+                locale: 'en-US',
+                ...associated_user,
+            },
+            ...onlineAccessInfo,
+        };
+    }
+    const session = new Session({
+        id,
+        shop,
+        isOnline: Boolean(sessionParams.isOnline),
+        state: 'test',
+        accessToken: 'totally_real_token',
+        scope: 'testScope',
+        ...overrides,
+    });
+    return session;
+}
+
+export { setUpValidSession };
+//# sourceMappingURL=setup-valid-session.mjs.map

package/dist/esm/test-helpers/setup-valid-session.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"setup-valid-session.mjs","sources":["../../../../../test-helpers/setup-valid-session.ts"],"sourcesContent":[null],"names":[],"mappings":";;;AAUA;;;;;AAKG;AACG,SAAU,iBAAiB,CAC/B,aACyC,EAAA;AAEzC,IAAA,MAAM,SAAS,GAA2B,EAAC,GAAG,aAAa,EAAkB,CAAC;AAC9E,IAAA,MAAM,IAAI,GAAG,aAAa,CAAC,IAAI,CAAC;AAChC,IAAA,IAAI,EAAE,GAAG,CAAW,QAAA,EAAA,IAAI,EAAE,CAAC;AAC3B,IAAA,IAAI,aAAa,CAAC,QAAQ,EAAE;AAC1B,QAAA,MAAM,gBAAgB,GAAG,aAAa,CAAC,gBAAgB,CAAC;AACxD,QAAA,MAAM,eAAe,GAAG,gBAAgB,EAAE,eAAe,CAAC;AAC1D,QAAA,OAAO,aAAa,CAAC,gBAAgB,EAAE,eAAe,CAAC;QACvD,OAAO,aAAa,CAAC,gBAAgB,CAAC;AAEtC,QAAA,EAAE,GAAG,CAAG,EAAA,IAAI,CAAI,CAAA,EAAA,OAAO,EAAE,CAAC;;AAE1B,QAAA,SAAS,CAAC,OAAO;AACf,YAAA,aAAa,CAAC,OAAO,IAAI,IAAI,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,GAAG,IAAI,GAAG,EAAE,CAAC,CAAC;QACnE,SAAS,CAAC,gBAAgB,GAAG;AAC3B,YAAA,qBAAqB,EAAE,WAAW;YAClC,UAAU,EAAE,IAAI,GAAG,EAAE;AACrB,YAAA,eAAe,EAAE;AACf,gBAAA,EAAE,EAAE,OAAO;AACX,gBAAA,aAAa,EAAE,IAAI;AACnB,gBAAA,YAAY,EAAE,IAAI;AAClB,gBAAA,KAAK,EAAE,gBAAgB;AACvB,gBAAA,cAAc,EAAE,IAAI;AACpB,gBAAA,UAAU,EAAE,MAAM;AAClB,gBAAA,SAAS,EAAE,MAAM;AACjB,gBAAA,MAAM,EAAE,OAAO;AACf,gBAAA,GAAG,eAAe;AACnB,aAAA;AACD,YAAA,GAAG,gBAAgB;SACpB,CAAC;KACH;AAED,IAAA,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC;QAC1B,EAAE;QACF,IAAI;AACJ,QAAA,QAAQ,EAAE,OAAO,CAAC,aAAa,CAAC,QAAQ,CAAC;AACzC,QAAA,KAAK,EAAE,MAAM;AACb,QAAA,WAAW,EAAE,oBAAoB;AACjC,QAAA,KAAK,EAAE,WAAW;AAClB,QAAA,GAAG,SAAS;AACb,KAAA,CAAC,CAAC;AAEH,IAAA,OAAO,OAAO,CAAC;AACjB;;;;"}