@shopify/shopify-app-remix 1.0.0-rc.0

package/build/cjs/billing/request.js

@@ -0,0 +1,83 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var shopifyApi = require('@shopify/shopify-api');
+var serverRuntime = require('@remix-run/server-runtime');
+var redirectToAuthPage = require('../auth/helpers/redirect-to-auth-page.js');
+require('isbot');
+var redirectWithAppBridgeHeaders = require('../auth/helpers/redirect-with-app-bridge-headers.js');
+
+function requestBillingFactory(params, request, session) {
+  return async function requestBilling({
+    plan,
+    isTest,
+    returnUrl
+  }) {
+    const {
+      api,
+      logger
+    } = 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
+      });
+    } catch (error) {
+      if (error instanceof shopifyApi.HttpResponseError && error.response.code === 401) {
+        logger.debug('API token was invalid, redirecting to OAuth', {
+          shop: session.shop
+        });
+        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(params, url, shop)
+    });
+  } 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/billing/require.js

@@ -0,0 +1,47 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var shopifyApi = require('@shopify/shopify-api');
+var redirectToAuthPage = require('../auth/helpers/redirect-to-auth-page.js');
+require('@remix-run/server-runtime');
+require('isbot');
+
+function requireBillingFactory(params, request, session) {
+  const {
+    api,
+    logger
+  } = 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);
+        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/index.js

@@ -0,0 +1,140 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+require('@shopify/shopify-api/adapters/web-api');
+var shopifyApi = require('@shopify/shopify-api');
+var runtime = require('@shopify/shopify-api/runtime');
+var types = require('./types.js');
+var version = require('./version.js');
+var register = require('./auth/webhooks/register.js');
+var authenticate$2 = require('./auth/admin/authenticate.js');
+var authenticate$1 = require('./auth/webhooks/authenticate.js');
+var authenticate = require('./auth/public/authenticate.js');
+var overrideLogger = require('./override-logger.js');
+var addResponseHeaders = require('./auth/helpers/add-response-headers.js');
+var login = require('./auth/login/login.js');
+
+runtime.setAbstractRuntimeString(() => {
+  return `Remix`;
+});
+
+/**
+ * Creates an object your app will use to interact with Shopify.
+ *
+ * @param appConfig Configuration options for your shopify app.  For example, the scopes your app needs.
+ * @returns `ShopifyApp` An object constructed using your appConfig.  It has methods for interacting with Shopify.
+ *
+ * @example
+ * The minimum viable configuration
+ * ```ts
+ * import { shopifyApp } from "@shopify/shopify-app-remix";
+ *
+ * export 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!,
+ * });
+ * ```
+ */
+function shopifyApp(appConfig) {
+  const api = deriveApi(appConfig);
+  const config = deriveConfig(appConfig, api.config);
+  const logger = overrideLogger.overrideLogger(api.logger);
+  addResponseHeaders.installGlobalResponseHeaders(config.isEmbeddedApp);
+  if (appConfig.webhooks) {
+    api.webhooks.addHandlers(appConfig.webhooks);
+  }
+  const params = {
+    api,
+    config,
+    logger
+  };
+  const oauth = new authenticate$2.AuthStrategy(params);
+  return {
+    sessionStorage: config.sessionStorage,
+    canUseLoginForm: config.canUseLoginForm,
+    addResponseHeaders: addResponseHeaders.addResponseHeadersFactory(params),
+    registerWebhooks: register.registerWebhooksFactory(params),
+    login: login.loginFactory(params),
+    authenticate: {
+      admin: oauth.authenticateAdmin.bind(oauth),
+      public: authenticate.authenticatePublicFactory(params),
+      webhook: authenticate$1.authenticateWebhookFactory(params)
+    }
+  };
+}
+function deriveApi(appConfig) {
+  var _appConfig$isEmbedded, _appConfig$apiVersion;
+  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}`;
+  }
+  const cleanApiConfig = {
+    ...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
+  };
+  return shopifyApi.shopifyApi(cleanApiConfig);
+}
+function deriveConfig(appConfig, apiConfig) {
+  var _appConfig$distributi, _appConfig$useOnlineT, _appConfig$hooks;
+  if (!appConfig.sessionStorage) {
+    throw new shopifyApi.ShopifyError('Please provide a valid session storage. See https://github.com/Shopify/shopify-app-js/blob/main/README.md#session-storage-options for options.');
+  }
+  const authPathPrefix = appConfig.authPathPrefix || '/auth';
+  const distribution = (_appConfig$distributi = appConfig.distribution) !== null && _appConfig$distributi !== void 0 ? _appConfig$distributi : types.AppDistribution.AppStore;
+  return {
+    ...appConfig,
+    ...apiConfig,
+    canUseLoginForm: 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,
+    auth: {
+      path: authPathPrefix,
+      callbackPath: `${authPathPrefix}/callback`,
+      patchSessionTokenPath: `${authPathPrefix}/session-token`,
+      exitIframePath: `${authPathPrefix}/exit-iframe`,
+      loginPath: `${authPathPrefix}/login`
+    }
+  };
+}
+
+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.shopifyApp = shopifyApp;

package/build/cjs/override-logger.js

@@ -0,0 +1,55 @@
+'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/types.js

@@ -0,0 +1,25 @@
+'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.
+ *
+ */
+
+exports.AppDistribution = AppDistribution;
+exports.LoginErrorType = LoginErrorType;

package/build/cjs/version.js

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

package/build/ts/adapters/node/index.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=index.d.ts.map

package/build/ts/adapters/node/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/adapters/node/index.ts"],"names":[],"mappings":""}

package/build/ts/adapters/node/index.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+var tslib_1 = require("tslib");
+var crypto_1 = tslib_1.__importDefault(require("crypto"));
+var runtime_1 = require("@shopify/shopify-api/runtime");
+(0, runtime_1.setCrypto)(crypto_1.default);
+(0, runtime_1.setAbstractRuntimeString)(function () {
+    return "Remix (Node)";
+});
+//# sourceMappingURL=index.js.map

package/build/ts/adapters/node/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/adapters/node/index.ts"],"names":[],"mappings":";;;AAAA,0DAA4B;AAE5B,wDAGsC;AAEtC,IAAA,mBAAS,EAAC,gBAAa,CAAC,CAAC;AAEzB,IAAA,kCAAwB,EAAC;IACvB,OAAO,cAAc,CAAC;AACxB,CAAC,CAAC,CAAC"}

package/build/ts/auth/admin/authenticate.d.ts

@@ -0,0 +1,32 @@
+import { Shopify, ShopifyRestResources } from '@shopify/shopify-api';
+import type { BasicParams } from '../../types';
+import type { AppConfig, AppConfigArg } from '../../config-types';
+import type { AdminContext } from './types';
+export declare class AuthStrategy<Config extends AppConfigArg, Resources extends ShopifyRestResources = ShopifyRestResources> {
+    protected api: Shopify;
+    protected config: AppConfig;
+    protected logger: Shopify['logger'];
+    constructor({ api, config, logger }: BasicParams);
+    authenticateAdmin(request: Request): Promise<AdminContext<Config, Resources>>;
+    private authenticateAndGetSessionContext;
+    private handleAuthBeginRequest;
+    private handleAuthCallbackRequest;
+    private validateUrlParams;
+    private ensureInstalledOnShop;
+    private testSession;
+    private ensureValidShopParam;
+    private ensureAppIsEmbeddedIfRequired;
+    private ensureSessionTokenSearchParamIfRequired;
+    private ensureSessionExists;
+    private validateAuthenticatedSession;
+    private loadSession;
+    private redirectToShopifyOrAppRoot;
+    private redirectToBouncePage;
+    private renderAppBridge;
+    private respondToOptionsRequest;
+    private ensureResponseHeaders;
+    private overriddenRestClient;
+    private createBillingContext;
+    private createAdminApiContext;
+}
+//# sourceMappingURL=authenticate.d.ts.map

package/build/ts/auth/admin/authenticate.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"authenticate.d.ts","sourceRoot":"","sources":["../../../../src/auth/admin/authenticate.ts"],"names":[],"mappings":"AACA,OAAO,EAQL,OAAO,EACP,oBAAoB,EACrB,MAAM,sBAAsB,CAAC;AAE9B,OAAO,KAAK,EAAC,WAAW,EAAC,MAAM,aAAa,CAAC;AAC7C,OAAO,KAAK,EAEV,SAAS,EACT,YAAY,EACb,MAAM,oBAAoB,CAAC;AAkB5B,OAAO,KAAK,EAAC,YAAY,EAAC,MAAM,SAAS,CAAC;AAW1C,qBAAa,YAAY,CACvB,MAAM,SAAS,YAAY,EAC3B,SAAS,SAAS,oBAAoB,GAAG,oBAAoB;IAE7D,SAAS,CAAC,GAAG,EAAE,OAAO,CAAC;IACvB,SAAS,CAAC,MAAM,EAAE,SAAS,CAAC;IAC5B,SAAS,CAAC,MAAM,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC;gBAEjB,EAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAC,EAAE,WAAW;IAMxC,iBAAiB,CAC5B,OAAO,EAAE,OAAO,GACf,OAAO,CAAC,YAAY,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;YAiC7B,gCAAgC;YA6ChC,sBAAsB;YAqBtB,yBAAyB;YAsDzB,iBAAiB;YAuBjB,qBAAqB;YAyErB,WAAW;IAkBzB,OAAO,CAAC,oBAAoB;YAcd,6BAA6B;YAY7B,uCAAuC;YAgBvC,mBAAmB;YAsCnB,4BAA4B;YAoB5B,WAAW;YAwBX,0BAA0B;IAiBxC,OAAO,CAAC,oBAAoB;IAiB5B,OAAO,CAAC,eAAe;IAuBvB,OAAO,CAAC,uBAAuB;IAW/B,OAAO,CAAC,qBAAqB;IAS7B,OAAO,CAAC,oBAAoB;IAiC5B,OAAO,CAAC,oBAAoB;IAa5B,OAAO,CAAC,qBAAqB;CAe9B"}