@shopify/shopify-app-remix 2.7.0 → 2.8.1

package/build/cjs/server/clients/admin/graphql.js

@@ -1,40 +0,0 @@
-'use strict';
-
-Object.defineProperty(exports, '__esModule', { value: true });
-
-// eslint-disable-next-line no-warning-comments
-// TODO: This is actually just a call through to the Shopify API client, but with a different API. We should eventually
-// move this over to the library layer. While doing that, we should also allow the apiVersion to be passed into the REST
-// client request calls.
-function graphqlClientFactory({
-  params,
-  handleClientError,
-  session
-}) {
-  return async function query(operation, options) {
-    const client = new params.api.clients.Graphql({
-      session,
-      apiVersion: options === null || options === void 0 ? void 0 : options.apiVersion
-    });
-    try {
-      // We convert the incoming response to a Response object to bring this client closer to the Remix client.
-      const apiResponse = await client.request(operation, {
-        variables: options === null || options === void 0 ? void 0 : options.variables,
-        retries: options !== null && options !== void 0 && options.tries ? options.tries - 1 : 0,
-        headers: options === null || options === void 0 ? void 0 : options.headers
-      });
-      return new Response(JSON.stringify(apiResponse));
-    } catch (error) {
-      if (handleClientError) {
-        throw await handleClientError({
-          error,
-          params,
-          session
-        });
-      }
-      throw error;
-    }
-  };
-}
-
-exports.graphqlClientFactory = graphqlClientFactory;

package/build/cjs/server/clients/admin/rest.js

@@ -1,145 +0,0 @@
-'use strict';
-
-Object.defineProperty(exports, '__esModule', { value: true });
-
-function restClientFactory({
-  params,
-  handleClientError,
-  session
-}) {
-  const {
-    api
-  } = params;
-  const client = new RemixRestClient({
-    params,
-    handleClientError,
-    session
-  });
-  if (api.rest) {
-    client.resources = {};
-    const RestResourceClient = restResourceClientFactory({
-      params,
-      handleClientError,
-      session
-    });
-    Object.entries(api.rest).forEach(([name, resource]) => {
-      class RemixResource extends resource {}
-      RemixResource.Client = RestResourceClient;
-      Reflect.defineProperty(RemixResource, 'name', {
-        value: name
-      });
-      Reflect.set(client.resources, name, RemixResource);
-    });
-  }
-  return client;
-}
-class RemixRestClient {
-  constructor({
-    params,
-    session,
-    handleClientError
-  }) {
-    this.session = void 0;
-    this.params = void 0;
-    this.handleClientError = void 0;
-    this.params = params;
-    this.handleClientError = handleClientError;
-    this.session = session;
-  }
-
-  /**
-   * Performs a GET request on the given path.
-   */
-  async get(params) {
-    return this.makeRequest({
-      method: 'GET',
-      ...params
-    });
-  }
-
-  /**
-   * Performs a POST request on the given path.
-   */
-  async post(params) {
-    return this.makeRequest({
-      method: 'POST',
-      ...params
-    });
-  }
-
-  /**
-   * Performs a PUT request on the given path.
-   */
-  async put(params) {
-    return this.makeRequest({
-      method: 'PUT',
-      ...params
-    });
-  }
-
-  /**
-   * Performs a DELETE request on the given path.
-   */
-  async delete(params) {
-    return this.makeRequest({
-      method: 'DELETE',
-      ...params
-    });
-  }
-  async makeRequest(params) {
-    const originalClient = new this.params.api.clients.Rest({
-      session: this.session
-    });
-    const originalRequest = Reflect.get(originalClient, 'request');
-    try {
-      const apiResponse = await originalRequest.call(originalClient, params);
-
-      // We use a separate client for REST requests and REST resources because we want to override the API library
-      // client class to return a Response object instead.
-      return new Response(JSON.stringify(apiResponse.body), {
-        headers: apiResponse.headers
-      });
-    } catch (error) {
-      if (this.handleClientError) {
-        throw await this.handleClientError({
-          error,
-          session: this.session,
-          params: this.params
-        });
-      } else throw new Error(error);
-    }
-  }
-}
-function restResourceClientFactory({
-  params,
-  handleClientError,
-  session
-}) {
-  const {
-    api
-  } = params;
-  const ApiClient = api.clients.Rest;
-  return class RestResourceClient extends ApiClient {
-    async request(requestParams) {
-      const originalClient = new api.clients.Rest({
-        session
-      });
-      const originalRequest = Reflect.get(originalClient, 'request');
-      try {
-        // We just call through to the API library client, and handle the error response here, so that data parsing
-        // behaves the same way.
-        return await originalRequest.call(originalClient, requestParams);
-      } catch (error) {
-        if (handleClientError) {
-          throw await handleClientError({
-            error,
-            params,
-            session
-          });
-        } else throw new Error(error);
-      }
-    }
-  };
-}
-
-exports.restClientFactory = restClientFactory;

package/build/cjs/server/clients/storefront/factory.js

@@ -1,28 +0,0 @@
-'use strict';
-
-Object.defineProperty(exports, '__esModule', { value: true });
-
-function storefrontClientFactory({
-  params,
-  session
-}) {
-  const {
-    api
-  } = params;
-  return {
-    graphql: async (query, options = {}) => {
-      const client = new api.clients.Storefront({
-        session,
-        apiVersion: options.apiVersion
-      });
-      const apiResponse = await client.request(query, {
-        variables: options === null || options === void 0 ? void 0 : options.variables,
-        retries: options !== null && options !== void 0 && options.tries ? options.tries - 1 : 0,
-        headers: options === null || options === void 0 ? void 0 : options.headers
-      });
-      return new Response(JSON.stringify(apiResponse));
-    }
-  };
-}
-
-exports.storefrontClientFactory = storefrontClientFactory;

package/build/cjs/server/errors.js

@@ -1,9 +0,0 @@
-'use strict';
-
-Object.defineProperty(exports, '__esModule', { value: true });
-
-var shopifyApi = require('@shopify/shopify-api');
-
-class SessionNotFoundError extends shopifyApi.ShopifyError {}
-
-exports.SessionNotFoundError = SessionNotFoundError;

package/build/cjs/server/future/flags.js

@@ -1,28 +0,0 @@
-'use strict';
-
-Object.defineProperty(exports, '__esModule', { value: true });
-
-// When adding new flags, you should also add them to the `TEST_FUTURE_FLAGS` object in `test-config.ts` to ensure that
-
-// it doesn't cause regressions.
-
-// When adding new flags, use this format:
-// vX_myFutureFlag: Future extends FutureFlags ? Future['vX_myFutureFlag'] : false;
-
-function logDisabledFutureFlags(config, logger) {
-  const logFlag = (flag, message) => logger.info(`Future flag ${flag} is disabled.\n\n  ${message}\n`);
-  if (!config.future.v3_authenticatePublic) {
-    logFlag('v3_authenticatePublic', 'Enable this flag to allow appProxy and checkout in `shopify.authenticate.public`.');
-  }
-  if (!config.future.v3_lineItemBilling) {
-    logFlag('v3_lineItemBilling', 'Enable this flag to allow billing plans with multiple line items.');
-  }
-  if (!config.future.v3_webhookAdminContext) {
-    logFlag('v3_webhookAdminContext', 'Enable this flag to use the standard Admin context when calling `shopify.authenticate.webhook`.');
-  }
-  if (!config.future.unstable_newEmbeddedAuthStrategy) {
-    logFlag('unstable_newEmbeddedAuthStrategy', 'Enable this to use OAuth token exchange instead of auth code to generate API access tokens.' + '\n  Your app must be using Shopify managed install: https://shopify.dev/docs/apps/auth/installation');
-  }
-}
-
-exports.logDisabledFutureFlags = logDisabledFutureFlags;

package/build/cjs/server/index.js

@@ -1,41 +0,0 @@
-'use strict';
-
-Object.defineProperty(exports, '__esModule', { value: true });
-
-require('@shopify/shopify-api/adapters/web-api');
-var runtime = require('@shopify/shopify-api/runtime');
-var shopifyApi = require('@shopify/shopify-api');
-var types = require('./types.js');
-var index = require('./boundary/index.js');
-var shopifyApp = require('./shopify-app.js');
-var errors = require('./errors.js');
-
-runtime.setAbstractRuntimeString(() => {
-  return `Remix`;
-});
-
-Object.defineProperty(exports, 'ApiVersion', {
-  enumerable: true,
-  get: function () { return shopifyApi.ApiVersion; }
-});
-Object.defineProperty(exports, 'BillingInterval', {
-  enumerable: true,
-  get: function () { return shopifyApi.BillingInterval; }
-});
-Object.defineProperty(exports, 'DeliveryMethod', {
-  enumerable: true,
-  get: function () { return shopifyApi.DeliveryMethod; }
-});
-Object.defineProperty(exports, 'LATEST_API_VERSION', {
-  enumerable: true,
-  get: function () { return shopifyApi.LATEST_API_VERSION; }
-});
-Object.defineProperty(exports, 'LogSeverity', {
-  enumerable: true,
-  get: function () { return shopifyApi.LogSeverity; }
-});
-exports.AppDistribution = types.AppDistribution;
-exports.LoginErrorType = types.LoginErrorType;
-exports.boundary = index.boundary;
-exports.shopifyApp = shopifyApp.shopifyApp;
-exports.SessionNotFoundError = errors.SessionNotFoundError;

package/build/cjs/server/override-logger.js

@@ -1,55 +0,0 @@
-'use strict';
-
-Object.defineProperty(exports, '__esModule', { value: true });
-
-var semver = require('semver');
-var shopifyApi = require('@shopify/shopify-api');
-var version = require('./version.js');
-
-function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
-
-var semver__default = /*#__PURE__*/_interopDefaultLegacy(semver);
-
-// eslint-disable-next-line no-warning-comments
-// TODO This has been copied from shopify-app-express, it should be extracted into a shared package
-// https://github.com/orgs/Shopify/projects/6899/views/1?pane=issue&itemId=28358070
-function overrideLogger(logger) {
-  const baseContext = {
-    package: 'shopify-app'
-  };
-  const warningFunction = (message, context = {}) => logger.warning(message, {
-    ...baseContext,
-    ...context
-  });
-  function deprecated(warningFunction) {
-    return function (version$1, message) {
-      if (semver__default["default"].gte(version.SHOPIFY_REMIX_LIBRARY_VERSION, version$1)) {
-        throw new shopifyApi.FeatureDeprecatedError(`Feature was deprecated in version ${version$1}`);
-      }
-      return warningFunction(`[Deprecated | ${version$1}] ${message}`);
-    };
-  }
-  return {
-    ...logger,
-    log: (severity, message, context = {}) => logger.log(severity, message, {
-      ...baseContext,
-      ...context
-    }),
-    debug: (message, context = {}) => logger.debug(message, {
-      ...baseContext,
-      ...context
-    }),
-    info: (message, context = {}) => logger.info(message, {
-      ...baseContext,
-      ...context
-    }),
-    warning: warningFunction,
-    error: (message, context = {}) => logger.error(message, {
-      ...baseContext,
-      ...context
-    }),
-    deprecated: deprecated(warningFunction)
-  };
-}
-
-exports.overrideLogger = overrideLogger;

package/build/cjs/server/shopify-app.js

@@ -1,151 +0,0 @@
-'use strict';
-
-Object.defineProperty(exports, '__esModule', { value: true });
-
-require('@shopify/shopify-api/adapters/web-api');
-var shopifyApi = require('@shopify/shopify-api');
-var types = require('./types.js');
-var version = require('./version.js');
-var register = require('./authenticate/webhooks/register.js');
-var authenticate = require('./authenticate/admin/authenticate.js');
-var authenticate$3 = require('./authenticate/webhooks/authenticate.js');
-var overrideLogger = require('./override-logger.js');
-var addResponseHeaders = require('./authenticate/helpers/add-response-headers.js');
-require('isbot');
-require('@remix-run/server-runtime');
-var login = require('./authenticate/login/login.js');
-var factory$1 = require('./unauthenticated/admin/factory.js');
-var factory = require('./authenticate/public/factory.js');
-var factory$2 = require('./unauthenticated/storefront/factory.js');
-var authCodeFlow = require('./authenticate/admin/strategies/auth-code-flow.js');
-var tokenExchange = require('./authenticate/admin/strategies/token-exchange.js');
-var idempotentPromiseHandler = require('./authenticate/helpers/idempotent-promise-handler.js');
-var authenticate$1 = require('./authenticate/flow/authenticate.js');
-var authenticate$2 = require('./authenticate/fulfillment-service/authenticate.js');
-var flags = require('./future/flags.js');
-
-/**
- * Creates an object your app will use to interact with Shopify.
- *
- * @param appConfig Configuration options for your Shopify app, such as the scopes your app needs.
- * @returns `ShopifyApp` An object constructed using your appConfig.  It has methods for interacting with Shopify.
- *
- * @example
- * <caption>The minimum viable configuration</caption>
- * ```ts
- * // /shopify.server.ts
- * import { shopifyApp } from "@shopify/shopify-app-remix/server";
- *
- * const shopify = shopifyApp({
- *   apiKey: process.env.SHOPIFY_API_KEY!,
- *   apiSecretKey: process.env.SHOPIFY_API_SECRET!,
- *   scopes: process.env.SCOPES?.split(",")!,
- *   appUrl: process.env.SHOPIFY_APP_URL!,
- * });
- * export default shopify;
- * ```
- */
-function shopifyApp(appConfig) {
-  const api = deriveApi(appConfig);
-  const config = deriveConfig(appConfig, api.config);
-  const logger = overrideLogger.overrideLogger(api.logger);
-  if (appConfig.webhooks) {
-    api.webhooks.addHandlers(appConfig.webhooks);
-  }
-  const params = {
-    api,
-    config,
-    logger
-  };
-  const authStrategy = authenticate.authStrategyFactory({
-    ...params,
-    strategy: config.future.unstable_newEmbeddedAuthStrategy && config.isEmbeddedApp ? new tokenExchange.TokenExchangeStrategy(params) : new authCodeFlow.AuthCodeFlowStrategy(params)
-  });
-  const shopify = {
-    sessionStorage: config.sessionStorage,
-    addDocumentResponseHeaders: addResponseHeaders.addDocumentResponseHeadersFactory(params),
-    registerWebhooks: register.registerWebhooksFactory(params),
-    authenticate: {
-      admin: authStrategy,
-      flow: authenticate$1.authenticateFlowFactory(params),
-      public: factory.authenticatePublicFactory(params),
-      fulfillmentService: authenticate$2.authenticateFulfillmentServiceFactory(params),
-      webhook: authenticate$3.authenticateWebhookFactory(params)
-    },
-    unauthenticated: {
-      admin: factory$1.unauthenticatedAdminContextFactory(params),
-      storefront: factory$2.unauthenticatedStorefrontContextFactory(params)
-    }
-  };
-  if (isAppStoreApp(shopify, appConfig) || isSingleMerchantApp(shopify, appConfig)) {
-    shopify.login = login.loginFactory(params);
-  }
-  flags.logDisabledFutureFlags(config, logger);
-  return shopify;
-}
-function isAppStoreApp(_shopify, config) {
-  return config.distribution === types.AppDistribution.AppStore;
-}
-function isSingleMerchantApp(_shopify, config) {
-  return config.distribution === types.AppDistribution.SingleMerchant;
-}
-function deriveApi(appConfig) {
-  var _appConfig$isEmbedded, _appConfig$apiVersion, _appConfig$future;
-  let appUrl;
-  try {
-    appUrl = new URL(appConfig.appUrl);
-  } catch (error) {
-    throw new shopifyApi.ShopifyError('Invalid appUrl provided. Please provide a valid URL.');
-  }
-
-  /* eslint-disable no-process-env */
-  if (appUrl.hostname === 'localhost' && !appUrl.port && process.env.PORT) {
-    appUrl.port = process.env.PORT;
-  }
-  /* eslint-enable no-process-env */
-  appConfig.appUrl = appUrl.origin;
-  let userAgentPrefix = `Shopify Remix Library v${version.SHOPIFY_REMIX_LIBRARY_VERSION}`;
-  if (appConfig.userAgentPrefix) {
-    userAgentPrefix = `${appConfig.userAgentPrefix} | ${userAgentPrefix}`;
-  }
-  return shopifyApi.shopifyApi({
-    ...appConfig,
-    hostName: appUrl.host,
-    hostScheme: appUrl.protocol.replace(':', ''),
-    userAgentPrefix,
-    isEmbeddedApp: (_appConfig$isEmbedded = appConfig.isEmbeddedApp) !== null && _appConfig$isEmbedded !== void 0 ? _appConfig$isEmbedded : true,
-    apiVersion: (_appConfig$apiVersion = appConfig.apiVersion) !== null && _appConfig$apiVersion !== void 0 ? _appConfig$apiVersion : shopifyApi.LATEST_API_VERSION,
-    isCustomStoreApp: appConfig.distribution === types.AppDistribution.ShopifyAdmin,
-    future: {
-      v10_lineItemBilling: (_appConfig$future = appConfig.future) === null || _appConfig$future === void 0 ? void 0 : _appConfig$future.v3_lineItemBilling
-    },
-    _logDisabledFutureFlags: false
-  });
-}
-function deriveConfig(appConfig, apiConfig) {
-  var _appConfig$distributi, _appConfig$useOnlineT, _appConfig$hooks, _appConfig$future2;
-  if (!appConfig.sessionStorage) {
-    throw new shopifyApi.ShopifyError('Please provide a valid session storage. Refer to https://github.com/Shopify/shopify-app-js/blob/main/README.md#session-storage-options for options.');
-  }
-  const authPathPrefix = appConfig.authPathPrefix || '/auth';
-  appConfig.distribution = (_appConfig$distributi = appConfig.distribution) !== null && _appConfig$distributi !== void 0 ? _appConfig$distributi : types.AppDistribution.AppStore;
-  return {
-    ...appConfig,
-    ...apiConfig,
-    idempotentPromiseHandler: new idempotentPromiseHandler.IdempotentPromiseHandler(),
-    canUseLoginForm: appConfig.distribution !== types.AppDistribution.ShopifyAdmin,
-    useOnlineTokens: (_appConfig$useOnlineT = appConfig.useOnlineTokens) !== null && _appConfig$useOnlineT !== void 0 ? _appConfig$useOnlineT : false,
-    hooks: (_appConfig$hooks = appConfig.hooks) !== null && _appConfig$hooks !== void 0 ? _appConfig$hooks : {},
-    sessionStorage: appConfig.sessionStorage,
-    future: (_appConfig$future2 = appConfig.future) !== null && _appConfig$future2 !== void 0 ? _appConfig$future2 : {},
-    auth: {
-      path: authPathPrefix,
-      callbackPath: `${authPathPrefix}/callback`,
-      patchSessionTokenPath: `${authPathPrefix}/session-token`,
-      exitIframePath: `${authPathPrefix}/exit-iframe`,
-      loginPath: `${authPathPrefix}/login`
-    }
-  };
-}
-
-exports.shopifyApp = shopifyApp;

package/build/cjs/server/types.js

@@ -1,26 +0,0 @@
-'use strict';
-
-Object.defineProperty(exports, '__esModule', { value: true });
-
-// eslint-disable-next-line no-warning-comments
-// TODO: Use this enum to replace the isCustomStoreApp config option in shopify-api-js
-let AppDistribution = /*#__PURE__*/function (AppDistribution) {
-  AppDistribution["AppStore"] = "app_store";
-  AppDistribution["SingleMerchant"] = "single_merchant";
-  AppDistribution["ShopifyAdmin"] = "shopify_admin";
-  return AppDistribution;
-}({});
-let LoginErrorType = /*#__PURE__*/function (LoginErrorType) {
-  LoginErrorType["MissingShop"] = "MISSING_SHOP";
-  LoginErrorType["InvalidShop"] = "INVALID_SHOP";
-  return LoginErrorType;
-}({});
-
-/**
- * An object your app can use to interact with Shopify.
- *
- * By default, the app's distribution is `AppStore`.
- */
-
-exports.AppDistribution = AppDistribution;
-exports.LoginErrorType = LoginErrorType;

package/build/cjs/server/unauthenticated/admin/factory.js

@@ -1,25 +0,0 @@
-'use strict';
-
-Object.defineProperty(exports, '__esModule', { value: true });
-
-var errors = require('../../errors.js');
-var factory = require('../../clients/admin/factory.js');
-var getOfflineSession = require('../helpers/get-offline-session.js');
-
-function unauthenticatedAdminContextFactory(params) {
-  return async shop => {
-    const session = await getOfflineSession.getOfflineSession(shop, params);
-    if (!session) {
-      throw new errors.SessionNotFoundError(`Could not find a session for shop ${shop} when creating unauthenticated admin context`);
-    }
-    return {
-      session,
-      admin: factory.adminClientFactory({
-        params,
-        session
-      })
-    };
-  };
-}
-
-exports.unauthenticatedAdminContextFactory = unauthenticatedAdminContextFactory;

package/build/cjs/server/unauthenticated/helpers/get-offline-session.js

@@ -1,14 +0,0 @@
-'use strict';
-
-Object.defineProperty(exports, '__esModule', { value: true });
-
-async function getOfflineSession(shop, {
-  api,
-  config
-}) {
-  const offlineSessionId = api.session.getOfflineId(shop);
-  const session = await config.sessionStorage.loadSession(offlineSessionId);
-  return session;
-}
-
-exports.getOfflineSession = getOfflineSession;

package/build/cjs/server/unauthenticated/storefront/factory.js

@@ -1,25 +0,0 @@
-'use strict';
-
-Object.defineProperty(exports, '__esModule', { value: true });
-
-var errors = require('../../errors.js');
-var factory = require('../../clients/storefront/factory.js');
-var getOfflineSession = require('../helpers/get-offline-session.js');
-
-function unauthenticatedStorefrontContextFactory(params) {
-  return async shop => {
-    const session = await getOfflineSession.getOfflineSession(shop, params);
-    if (!session) {
-      throw new errors.SessionNotFoundError(`Could not find a session for shop ${shop} when creating unauthenticated storefront context`);
-    }
-    return {
-      session,
-      storefront: factory.storefrontClientFactory({
-        params,
-        session
-      })
-    };
-  };
-}
-
-exports.unauthenticatedStorefrontContextFactory = unauthenticatedStorefrontContextFactory;

package/build/cjs/server/version.js

@@ -1,7 +0,0 @@
-'use strict';
-
-Object.defineProperty(exports, '__esModule', { value: true });
-
-const SHOPIFY_REMIX_LIBRARY_VERSION = '2.7.0';
-
-exports.SHOPIFY_REMIX_LIBRARY_VERSION = SHOPIFY_REMIX_LIBRARY_VERSION;