@shopify/shopify-app-remix 2.8.0 → 2.8.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shopify/shopify-app-remix",
-  "version": "2.8.0",
+  "version": "2.8.2",
   "description": "Shopify Remix - to simplify the building of Shopify Apps with Remix",
   "repository": {
     "type": "git",
@@ -9,30 +9,56 @@
   "bugs": {
     "url": "https://github.com/Shopify/shopify-app-js/issues"
   },
-  "homepage": "https://github.com/Shopify/shopify-app-js/tree/main/packages/shopify-app-remix",
+  "homepage": "https://github.com/Shopify/shopify-app-js/tree/main/packages/apps/shopify-app-remix",
   "author": "Shopify Inc.",
   "license": "MIT",
-  "types": "./build/ts/server/index.d.ts",
-  "main": "./build/cjs/server/index.js",
+  "main": "./dist/cjs/server/index.js",
+  "module": "./dist/esm/server/index.mjs",
+  "types": "./dist/ts/server/index.d.ts",
   "exports": {
     ".": {
-      "types": "./build/ts/server/index.d.ts",
-      "default": "./build/cjs/server/index.js"
+      "types": "./dist/ts/server/index.d.ts",
+      "require": "./dist/cjs/server/index.js",
+      "import": "./dist/esm/server/index.mjs",
+      "default": "./dist/cjs/server/index.js"
+    },
+    "./adapters/*": {
+      "types": "./dist/ts/server/adapters/*/index.d.ts",
+      "require": "./dist/cjs/server/adapters/*/index.js",
+      "import": "./dist/esm/server/adapters/*/index.mjs",
+      "default": "./dist/cjs/server/adapters/*/index.js"
+    },
+    "./server/adapters/*": {
+      "types": "./dist/ts/server/adapters/*/index.d.ts",
+      "require": "./dist/cjs/server/adapters/*/index.js",
+      "import": "./dist/esm/server/adapters/*/index.mjs",
+      "default": "./dist/cjs/server/adapters/*/index.js"
     },
-    "./adapters/*": "./build/cjs/server/adapters/*/index.js",
     "./server": {
-      "types": "./build/ts/server/index.d.ts",
-      "default": "./build/cjs/server/index.js"
+      "types": "./dist/ts/server/index.d.ts",
+      "require": "./dist/cjs/server/index.js",
+      "import": "./dist/esm/server/index.mjs",
+      "default": "./dist/cjs/server/index.js"
     },
-    "./server/adapters/*": "./build/cjs/server/adapters/*/index.js",
     "./react": {
-      "types": "./build/ts/react/index.d.ts",
-      "default": "./build/cjs/react/index.js"
+      "types": "./dist/ts/react/index.d.ts",
+      "require": "./dist/cjs/react/index.js",
+      "import": "./dist/esm/react/index.mjs",
+      "default": "./dist/cjs/react/index.js"
     }
   },
   "scripts": {
     "build-docs": "sh docs/build-docs.sh",
-    "validate-docs": "sh ./docs/build-docs.sh isTest && yarn compare-docs"
+    "validate-docs": "sh ./docs/build-docs.sh isTest && yarn compare-docs",
+    "lint": "eslint . --ext .js,.ts",
+    "build": "yarn run rollup && yarn tsc -p ./tsconfig.build.json",
+    "test": "jest",
+    "test:ci": "yarn test",
+    "rollup": "rollup -c rollup.config.js --bundleConfigAsCjs",
+    "clean": "rimraf .rollup.cache dist",
+    "changeset": "changeset",
+    "version": "changeset version",
+    "release": "yarn build && changeset publish"
   },
   "publishConfig": {
     "access": "public"
@@ -50,11 +76,12 @@
     "Storefront API"
   ],
   "devDependencies": {
+    "@remix-run/node": "^2.6.0",
     "@remix-run/react": "^2.8.1",
-    "@shopify/generate-docs": "^0.13.2",
+    "@shopify/generate-docs": "^0.15.2",
     "@shopify/polaris": "^12.18.0",
     "@shopify/react-testing": "^5.1.3",
-    "@shopify/shopify-app-session-storage-memory": "^3.0.3",
+    "@shopify/shopify-app-session-storage-memory": "^3.0.5",
     "@types/jsonwebtoken": "^9.0.5",
     "@types/react": "^18.2.18",
     "@types/semver": "^7.5.8",
@@ -65,29 +92,31 @@
     "react-router-dom": "^6.22.3"
   },
   "dependencies": {
-    "@remix-run/node": "^2.6.0",
     "@remix-run/server-runtime": "^2.5.1",
-    "@shopify/admin-api-client": "^0.2.3",
-    "@shopify/shopify-api": "^9.7.1",
-    "@shopify/shopify-app-session-storage": "^2.1.3",
-    "@shopify/storefront-api-client": "^0.2.3",
-    "isbot": "^3.7.1",
+    "@shopify/admin-api-client": "^0.2.9",
+    "@shopify/shopify-api": "^10.0.0",
+    "@shopify/shopify-app-session-storage": "^2.1.5",
+    "@shopify/storefront-api-client": "^0.3.4",
+    "isbot": "^5.1.4",
     "semver": "^7.6.0"
   },
   "peerDependencies": {
     "@remix-run/react": "*",
+    "@remix-run/node": "*",
     "@shopify/polaris": "*",
     "react": "*"
   },
   "peerDependenciesMeta": {
     "@shopify/polaris": {
       "optional": true
+    },
+    "@remix-run/node": {
+      "optional": true
     }
   },
   "files": [
-    "build/*",
+    "dist/*",
     "!build/**/__tests__",
-    "!bundle/*",
     "!tsconfig.tsbuildinfo",
     "!node_modules"
   ]

package/build/cjs/react/components/RemixPolarisLink.js

@@ -1,22 +0,0 @@
-'use strict';
-
-Object.defineProperty(exports, '__esModule', { value: true });
-
-var React = require('react');
-var react = require('@remix-run/react');
-var jsxRuntime = require('react/jsx-runtime');
-
-function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
-
-var React__default = /*#__PURE__*/_interopDefaultLegacy(React);
-
-const RemixPolarisLink = /*#__PURE__*/React__default["default"].forwardRef((props, ref) => {
-  var _props$url;
-  return /*#__PURE__*/jsxRuntime.jsx(react.Link, {
-    ...props,
-    to: (_props$url = props.url) !== null && _props$url !== void 0 ? _props$url : props.to,
-    ref: ref
-  });
-});
-
-exports.RemixPolarisLink = RemixPolarisLink;

package/build/cjs/server/authenticate/admin/authenticate.js

@@ -1,170 +0,0 @@
-'use strict';
-
-Object.defineProperty(exports, '__esModule', { value: true });
-
-var ensureCorsHeaders = require('../helpers/ensure-cors-headers.js');
-var validateSessionToken = require('../helpers/validate-session-token.js');
-var getSessionTokenHeader = require('../helpers/get-session-token-header.js');
-var rejectBotRequest = require('../helpers/reject-bot-request.js');
-var respondToOptionsRequest = require('../helpers/respond-to-options-request.js');
-require('@remix-run/server-runtime');
-var cancel = require('./billing/cancel.js');
-var require$1 = require('./billing/require.js');
-var request = require('./billing/request.js');
-var check = require('./billing/check.js');
-var createAdminApiContext = require('./helpers/create-admin-api-context.js');
-var ensureAppIsEmbeddedIfRequired = require('./helpers/ensure-app-is-embedded-if-required.js');
-var ensureSessionTokenSearchParamIfRequired = require('./helpers/ensure-session-token-search-param-if-required.js');
-require('@shopify/shopify-api');
-var redirect = require('./helpers/redirect.js');
-var renderAppBridge = require('./helpers/render-app-bridge.js');
-var validateShopAndHostParams = require('./helpers/validate-shop-and-host-params.js');
-
-function authStrategyFactory({
-  strategy,
-  ...params
-}) {
-  const {
-    api,
-    logger,
-    config
-  } = params;
-  async function respondToBouncePageRequest(request) {
-    const url = new URL(request.url);
-    if (url.pathname === config.auth.patchSessionTokenPath) {
-      logger.debug('Rendering bounce page');
-      throw renderAppBridge.renderAppBridge({
-        config,
-        logger,
-        api
-      }, request);
-    }
-  }
-  async function respondToExitIframeRequest(request) {
-    const url = new URL(request.url);
-    if (url.pathname === config.auth.exitIframePath) {
-      const destination = url.searchParams.get('exitIframe');
-      logger.debug('Rendering exit iframe page', {
-        destination
-      });
-      throw renderAppBridge.renderAppBridge({
-        config,
-        logger,
-        api
-      }, request, {
-        url: destination
-      });
-    }
-  }
-  function createContext(request$1, session, authStrategy, sessionToken) {
-    const context = {
-      admin: createAdminApiContext.createAdminApiContext(session, params, authStrategy.handleClientError(request$1)),
-      billing: {
-        require: require$1.requireBillingFactory(params, request$1, session),
-        check: check.checkBillingFactory(params, request$1, session),
-        request: request.requestBillingFactory(params, request$1, session),
-        cancel: cancel.cancelBillingFactory(params, request$1, session)
-      },
-      session,
-      cors: ensureCorsHeaders.ensureCORSHeadersFactory(params, request$1)
-    };
-    if (config.isEmbeddedApp) {
-      return {
-        ...context,
-        sessionToken,
-        redirect: redirect.redirectFactory(params, request$1)
-      };
-    } else {
-      return context;
-    }
-  }
-  return async function authenticateAdmin(request) {
-    try {
-      rejectBotRequest.respondToBotRequest(params, request);
-      respondToOptionsRequest.respondToOptionsRequest(params, request);
-      await respondToBouncePageRequest(request);
-      await respondToExitIframeRequest(request);
-      await strategy.respondToOAuthRequests(request);
-
-      // If this is a valid request, but it doesn't have a session token header, this is a document request. We need to
-      // ensure we're embedded if needed and we have the information needed to load the session.
-      if (!getSessionTokenHeader.getSessionTokenHeader(request)) {
-        validateShopAndHostParams.validateShopAndHostParams(params, request);
-        await ensureAppIsEmbeddedIfRequired.ensureAppIsEmbeddedIfRequired(params, request);
-        await ensureSessionTokenSearchParamIfRequired.ensureSessionTokenSearchParamIfRequired(params, request);
-      }
-      logger.info('Authenticating admin request');
-      const {
-        payload,
-        shop,
-        sessionId,
-        sessionToken
-      } = await getSessionTokenContext(params, request);
-      logger.debug('Loading session from storage', {
-        sessionId
-      });
-      const existingSession = sessionId ? await config.sessionStorage.loadSession(sessionId) : undefined;
-      const session = await strategy.authenticate(request, {
-        session: existingSession,
-        sessionToken,
-        shop
-      });
-      logger.debug('Request is valid, loaded session from session token', {
-        shop: session.shop,
-        isOnline: session.isOnline
-      });
-      return createContext(request, session, strategy, payload);
-    } catch (errorOrResponse) {
-      if (errorOrResponse instanceof Response) {
-        ensureCorsHeaders.ensureCORSHeadersFactory(params, request)(errorOrResponse);
-      }
-      throw errorOrResponse;
-    }
-  };
-}
-async function getSessionTokenContext(params, request) {
-  const {
-    api,
-    config,
-    logger
-  } = params;
-  const headerSessionToken = getSessionTokenHeader.getSessionTokenHeader(request);
-  const searchParamSessionToken = getSessionTokenHeader.getSessionTokenFromUrlParam(request);
-  const sessionToken = headerSessionToken || searchParamSessionToken;
-  logger.debug('Attempting to authenticate session token', {
-    sessionToken: JSON.stringify({
-      header: headerSessionToken,
-      search: searchParamSessionToken
-    })
-  });
-  if (config.isEmbeddedApp) {
-    const payload = await validateSessionToken.validateSessionToken(params, request, sessionToken);
-    const dest = new URL(payload.dest);
-    const shop = dest.hostname;
-    logger.debug('Session token is valid', {
-      shop,
-      payload
-    });
-    const sessionId = config.useOnlineTokens ? api.session.getJwtSessionId(shop, payload.sub) : api.session.getOfflineId(shop);
-    return {
-      shop,
-      payload,
-      sessionId,
-      sessionToken
-    };
-  }
-  const url = new URL(request.url);
-  const shop = url.searchParams.get('shop');
-  const sessionId = await api.session.getCurrentId({
-    isOnline: config.useOnlineTokens,
-    rawRequest: request
-  });
-  return {
-    shop,
-    sessionId,
-    payload: undefined,
-    sessionToken
-  };
-}
-
-exports.authStrategyFactory = authStrategyFactory;

package/build/cjs/server/authenticate/admin/billing/cancel.js

@@ -1,41 +0,0 @@
-'use strict';
-
-Object.defineProperty(exports, '__esModule', { value: true });
-
-var shopifyApi = require('@shopify/shopify-api');
-require('@remix-run/server-runtime');
-var redirectToAuthPage = require('../helpers/redirect-to-auth-page.js');
-
-function cancelBillingFactory(params, request, session) {
-  return async function cancelBilling(options) {
-    const {
-      api,
-      logger,
-      config
-    } = params;
-    logger.debug('Cancelling billing', {
-      shop: session.shop,
-      ...options
-    });
-    try {
-      return await api.billing.cancel({
-        session,
-        subscriptionId: options.subscriptionId,
-        isTest: options.isTest,
-        prorate: options.prorate
-      });
-    } catch (error) {
-      if (error instanceof shopifyApi.HttpResponseError && error.response.code === 401) {
-        logger.debug('API token was invalid, redirecting to OAuth', {
-          shop: session.shop
-        });
-        await config.sessionStorage.deleteSession(session.id);
-        throw await redirectToAuthPage.redirectToAuthPage(params, request, session.shop);
-      } else {
-        throw error;
-      }
-    }
-  };
-}
-
-exports.cancelBillingFactory = cancelBillingFactory;

package/build/cjs/server/authenticate/admin/billing/check.js

@@ -1,41 +0,0 @@
-'use strict';
-
-Object.defineProperty(exports, '__esModule', { value: true });
-
-var shopifyApi = require('@shopify/shopify-api');
-require('@remix-run/server-runtime');
-var redirectToAuthPage = require('../helpers/redirect-to-auth-page.js');
-
-function checkBillingFactory(params, request, session) {
-  return async function checkBilling(options) {
-    const {
-      api,
-      logger,
-      config
-    } = params;
-    logger.debug('Checking billing plans', {
-      shop: session.shop,
-      ...options
-    });
-    try {
-      return await api.billing.check({
-        session,
-        plans: options.plans,
-        isTest: options.isTest,
-        returnObject: true
-      });
-    } catch (error) {
-      if (error instanceof shopifyApi.HttpResponseError && error.response.code === 401) {
-        logger.debug('API token was invalid, redirecting to OAuth', {
-          shop: session.shop
-        });
-        await config.sessionStorage.deleteSession(session.id);
-        throw await redirectToAuthPage.redirectToAuthPage(params, request, session.shop);
-      } else {
-        throw error;
-      }
-    }
-  };
-}
-
-exports.checkBillingFactory = checkBillingFactory;

package/build/cjs/server/authenticate/admin/billing/request.js

@@ -1,86 +0,0 @@
-'use strict';
-
-Object.defineProperty(exports, '__esModule', { value: true });
-
-var shopifyApi = require('@shopify/shopify-api');
-var serverRuntime = require('@remix-run/server-runtime');
-var redirectToAuthPage = require('../helpers/redirect-to-auth-page.js');
-var redirectWithAppBridgeHeaders = require('../helpers/redirect-with-app-bridge-headers.js');
-
-function requestBillingFactory(params, request, session) {
-  return async function requestBilling({
-    plan,
-    isTest,
-    returnUrl,
-    ...overrides
-  }) {
-    const {
-      api,
-      logger,
-      config
-    } = params;
-    logger.info('Requesting billing', {
-      shop: session.shop,
-      plan,
-      isTest,
-      returnUrl
-    });
-    let result;
-    try {
-      result = await api.billing.request({
-        plan: plan,
-        session,
-        isTest,
-        returnUrl,
-        returnObject: true,
-        ...overrides
-      });
-    } catch (error) {
-      if (error instanceof shopifyApi.HttpResponseError && error.response.code === 401) {
-        logger.debug('API token was invalid, redirecting to OAuth', {
-          shop: session.shop
-        });
-        await config.sessionStorage.deleteSession(session.id);
-        throw await redirectToAuthPage.redirectToAuthPage(params, request, session.shop);
-      } else {
-        throw error;
-      }
-    }
-    throw redirectOutOfApp(params, request, result.confirmationUrl, session.shop);
-  };
-}
-function redirectOutOfApp(params, request, url, shop) {
-  const {
-    config,
-    logger
-  } = params;
-  logger.debug('Redirecting out of app', {
-    url
-  });
-  const requestUrl = new URL(request.url);
-  const isEmbeddedRequest = requestUrl.searchParams.get('embedded') === '1';
-  const isXhrRequest = request.headers.get('authorization');
-  if (isXhrRequest) {
-    // eslint-disable-next-line no-warning-comments
-    // TODO Check this with the beta flag disabled (with the bounce page)
-    // Remix is not including the X-Shopify-API-Request-Failure-Reauthorize-Url when throwing a Response
-    // https://github.com/remix-run/remix/issues/5356
-    throw new Response(undefined, {
-      status: 401,
-      statusText: 'Unauthorized',
-      headers: redirectWithAppBridgeHeaders.getAppBridgeHeaders(url)
-    });
-  } else if (isEmbeddedRequest) {
-    const params = new URLSearchParams({
-      shop,
-      host: requestUrl.searchParams.get('host'),
-      exitIframe: url
-    });
-    throw serverRuntime.redirect(`${config.auth.exitIframePath}?${params.toString()}`);
-  } else {
-    // This will only ever happen for non-embedded apps, because the authenticator will stop before reaching this point
-    throw serverRuntime.redirect(url);
-  }
-}
-
-exports.requestBillingFactory = requestBillingFactory;

package/build/cjs/server/authenticate/admin/billing/require.js

@@ -1,48 +0,0 @@
-'use strict';
-
-Object.defineProperty(exports, '__esModule', { value: true });
-
-var shopifyApi = require('@shopify/shopify-api');
-require('@remix-run/server-runtime');
-var redirectToAuthPage = require('../helpers/redirect-to-auth-page.js');
-
-function requireBillingFactory(params, request, session) {
-  const {
-    api,
-    logger,
-    config
-  } = params;
-  return async function requireBilling(options) {
-    const logContext = {
-      shop: session.shop,
-      plans: options.plans,
-      isTest: options.isTest
-    };
-    logger.debug('Checking billing for the shop', logContext);
-    let data;
-    try {
-      data = await api.billing.check({
-        session,
-        plans: options.plans,
-        isTest: options.isTest,
-        returnObject: true
-      });
-    } catch (error) {
-      if (error instanceof shopifyApi.HttpResponseError && error.response.code === 401) {
-        logger.debug('API token was invalid, redirecting to OAuth', logContext);
-        await config.sessionStorage.deleteSession(session.id);
-        throw await redirectToAuthPage.redirectToAuthPage(params, request, session.shop);
-      } else {
-        throw error;
-      }
-    }
-    if (!data.hasActivePayment) {
-      logger.debug('Billing check failed', logContext);
-      throw await options.onFailure(new Error('Billing check failed'));
-    }
-    logger.debug('Billing check succeeded', logContext);
-    return data;
-  };
-}
-
-exports.requireBillingFactory = requireBillingFactory;

package/build/cjs/server/authenticate/admin/helpers/begin-auth.js

@@ -1,18 +0,0 @@
-'use strict';
-
-Object.defineProperty(exports, '__esModule', { value: true });
-
-async function beginAuth(params, request, isOnline, shop) {
-  const {
-    api,
-    config
-  } = params;
-  throw await api.auth.begin({
-    shop,
-    callbackPath: config.auth.callbackPath,
-    isOnline,
-    rawRequest: request
-  });
-}
-
-exports.beginAuth = beginAuth;

package/build/cjs/server/authenticate/admin/helpers/ensure-app-is-embedded-if-required.js

@@ -1,27 +0,0 @@
-'use strict';
-
-Object.defineProperty(exports, '__esModule', { value: true });
-
-var redirectToShopifyOrAppRoot = require('./redirect-to-shopify-or-app-root.js');
-
-const ensureAppIsEmbeddedIfRequired = async (params, request) => {
-  const {
-    api,
-    logger,
-    config
-  } = params;
-  const url = new URL(request.url);
-  const shop = url.searchParams.get('shop');
-  if (api.config.isEmbeddedApp && url.searchParams.get('embedded') !== '1') {
-    logger.debug('App is not embedded, redirecting to Shopify', {
-      shop
-    });
-    await redirectToShopifyOrAppRoot.redirectToShopifyOrAppRoot(request, {
-      api,
-      logger,
-      config
-    });
-  }
-};
-
-exports.ensureAppIsEmbeddedIfRequired = ensureAppIsEmbeddedIfRequired;

package/build/cjs/server/authenticate/admin/helpers/ensure-session-token-search-param-if-required.js

@@ -1,25 +0,0 @@
-'use strict';
-
-Object.defineProperty(exports, '__esModule', { value: true });
-
-var redirectToBouncePage = require('./redirect-to-bounce-page.js');
-
-const SESSION_TOKEN_PARAM = 'id_token';
-const ensureSessionTokenSearchParamIfRequired = async (params, request) => {
-  const {
-    api,
-    logger
-  } = params;
-  const url = new URL(request.url);
-  const shop = url.searchParams.get('shop');
-  const searchParamSessionToken = url.searchParams.get(SESSION_TOKEN_PARAM);
-  const isEmbedded = url.searchParams.get('embedded') === '1';
-  if (api.config.isEmbeddedApp && isEmbedded && !searchParamSessionToken) {
-    logger.debug('Missing session token in search params, going to bounce page', {
-      shop
-    });
-    redirectToBouncePage.redirectToBouncePage(params, url);
-  }
-};
-
-exports.ensureSessionTokenSearchParamIfRequired = ensureSessionTokenSearchParamIfRequired;

package/build/cjs/server/authenticate/admin/helpers/handle-client-error.js

@@ -1,43 +0,0 @@
-'use strict';
-
-Object.defineProperty(exports, '__esModule', { value: true });
-
-var shopifyApi = require('@shopify/shopify-api');
-
-function handleClientErrorFactory({
-  request,
-  onError
-}) {
-  return async function handleClientError({
-    error,
-    params,
-    session
-  }) {
-    if (error instanceof shopifyApi.HttpResponseError !== true) {
-      params.logger.debug(`Got a response error from the API: ${error.message}`);
-      throw error;
-    }
-    params.logger.debug(`Got an HTTP response error from the API: ${error.message}`, {
-      code: error.response.code,
-      statusText: error.response.statusText,
-      body: JSON.stringify(error.response.body)
-    });
-    if (onError) {
-      await onError({
-        request,
-        session,
-        error
-      });
-    }
-
-    // forward a minimal copy of the upstream HTTP response instead of an Error:
-    throw new Response(JSON.stringify(error.response.body), {
-      status: error.response.code,
-      headers: {
-        'Content-Type': error.response.headers['Content-Type']
-      }
-    });
-  };
-}
-
-exports.handleClientErrorFactory = handleClientErrorFactory;