@shopify/shopify-app-remix 1.0.0-rc.1 → 1.0.0

package/build/ts/config-types.d.ts

@@ -23,10 +23,11 @@ export interface AppConfigArg<Resources extends ShopifyRestResources = ShopifyRe
      *
      * import prisma from "~/db.server";
      *
-     * export const shopify = shopifyApp({
+     * const shopify = shopifyApp({
      *   // ... etc
      *   sessionStorage: new PrismaSessionStorage(prisma),
      * });
+     * export default shopify;
      * ```
      */
     sessionStorage: Storage;
@@ -53,7 +54,7 @@ export interface AppConfigArg<Resources extends ShopifyRestResources = ShopifyRe
      * // app/shopify.server.ts
      * import { DeliveryMethod, shopifyApp } from "@shopify/shopify-app-remix";
      *
-     * export const shopify = shopifyApp({
+     * const shopify = shopifyApp({
      *   webhooks: {
      *     APP_UNINSTALLED: {
      *       deliveryMethod: DeliveryMethod.Http,
@@ -67,15 +68,17 @@ export interface AppConfigArg<Resources extends ShopifyRestResources = ShopifyRe
      *   },
      *   // ...etc
      * });
+     * export default shopify;
+     * export const authenticate = shopify.authenticate;
      *
      * // app/routes/webhooks.jsx
      * import { ActionArgs } from "@remix-run/node";
      *
-     * import { shopify } from "../shopify.server";
+     * import { authenticate } from "../shopify.server";
      * import db from "../db.server";
      *
      * export const action = async ({ request }: ActionArgs) => {
-     *   const { topic, shop } = await shopify.authenticate.webhook(request);
+     *   const { topic, shop } = await authenticate.webhook(request);
      *
      *   switch (topic) {
      *     case "APP_UNINSTALLED":
@@ -103,7 +106,7 @@ export interface AppConfigArg<Resources extends ShopifyRestResources = ShopifyRe
      * import { DeliveryMethod, shopifyApp } from "@shopify/shopify-app-remix";
      * import { seedStoreData } from "~/db/seeds"
      *
-     * export const shopify = shopifyApp({
+     * const shopify = shopifyApp({
      *   hooks: {
      *     afterAuth: async ({ session }) => {
      *       seedStoreData({session})
@@ -140,7 +143,7 @@ export interface AppConfigArg<Resources extends ShopifyRestResources = ShopifyRe
      * ```ts
      * import { LATEST_API_VERSION, shopifyApp } from "@shopify/shopify-app-remix";
      *
-     * export const shopify = shopifyApp({
+     * const shopify = shopifyApp({
      *   // ...etc
      *   apiVersion: LATEST_API_VERSION,
      * });
@@ -160,17 +163,19 @@ export interface AppConfigArg<Resources extends ShopifyRestResources = ShopifyRe
      * // app/shopify.server.ts
      * import { LATEST_API_VERSION, shopifyApp } from "@shopify/shopify-app-remix";
      *
-     * export const shopify = shopifyApp({
+     * const shopify = shopifyApp({
      *   // ...etc
      *   apiVersion: LATEST_API_VERSION,
      * });
+     * export default shopify;
+     * export const authenticate = shopify.authenticate;
      *
      * // app/routes/auth/$.jsx
      * import { LoaderArgs } from "@remix-run/node";
-     * import { shopify } from "../../shopify.server";
+     * import { authenticate } from "../../shopify.server";
      *
      * export async function loader({ request }: LoaderArgs) {
-     *   await shopify.authenticate.admin(request);
+     *   await authenticate.admin(request);
      *
      *   return null
      * }
@@ -210,7 +215,7 @@ interface HooksConfig {
      * import { DeliveryMethod, shopifyApp } from "@shopify/shopify-app-remix";
      * import { seedStoreData } from "~/db/seeds"
      *
-     * export const shopify = shopifyApp({
+     * const shopify = shopifyApp({
      *   hooks: {
      *     afterAuth: async ({ session }) => {
      *       shopify.registerWebhooks({ session });
@@ -246,19 +251,21 @@ export interface AdminApiContext<Resources extends ShopifyRestResources = Shopif
      * ```ts
      * // app/shopify.server.ts
      * import { shopifyApp } from "@shopify/shopify-app-remix";
-     * import { restResources } from "@shopify/shopify-api/rest/admin/2023-04";
+     * import { restResources } from "@shopify/shopify-api/rest/admin/2023-07";
      *
-     * export const shopify = shopifyApp({
+     * const shopify = shopifyApp({
      *   restResources,
      *   // ...etc
      * });
+     * export default shopify;
+     * export const authenticate = shopify.authenticate;
      *
      * // app/routes/**\/.ts
      * import { LoaderArgs, json } from "@remix-run/node";
-     * import { shopify } from "../shopify.server";
+     * import { authenticate } from "../shopify.server";
      *
      * export const loader = async ({ request }: LoaderArgs) => {
-     *   const { admin, session } = await shopify.authenticate.admin(request);
+     *   const { admin, session } = await authenticate.admin(request);
      *   return json(admin.rest.resources.Order.count({ session }));
      * };
      * ```
@@ -270,16 +277,19 @@ export interface AdminApiContext<Resources extends ShopifyRestResources = Shopif
      * import { shopifyApp } from "@shopify/shopify-app-remix";
      * import { restResources } from "@shopify/shopify-api/rest/admin/2023-04";
      *
-     * export const shopify = shopifyApp({
+     * const shopify = shopifyApp({
      *   restResources,
      *   // ...etc
      * });
+     * export default shopify;
+     * export const authenticate = shopify.authenticate;
      *
      * // app/routes/**\/.ts
      * import { LoaderArgs, json } from "@remix-run/node";
-     * import { shopify } from "../shopify.server";
+     * import { authenticate } from "../shopify.server";
      *
      * export const loader = async ({ request }: LoaderArgs) => {
+     *   const { admin, session } = await authenticate.admin(request);
      *   const response = await admin.rest.get({ path: "/customers/count.json" });
      *   const customers = await response.json();
      *   return json({ customers });
@@ -297,10 +307,10 @@ export interface AdminApiContext<Resources extends ShopifyRestResources = Shopif
      * Creating a new product
      * ```ts
      * import { ActionArgs } from "@remix-run/node";
-     * import { shopify } from "../shopify.server";
+     * import { authenticate } from "../shopify.server";
      *
      * export async function action({ request }: ActionArgs) {
-     *   const { admin } = await shopify.authenticate.admin(request);
+     *   const { admin } = await authenticate.admin(request);
      *
      *   const response = await admin.graphql(
      *     `#graphql

package/build/ts/config-types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"config-types.d.ts","sourceRoot":"","sources":["../../src/config-types.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,YAAY,IAAI,YAAY,EAC5B,eAAe,IAAI,SAAS,EAC5B,oBAAoB,EACpB,OAAO,EACP,UAAU,EACV,cAAc,EACf,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAC,cAAc,EAAC,MAAM,sCAAsC,CAAC;AAEpE,OAAO,KAAK,EAAC,oBAAoB,EAAC,MAAM,6BAA6B,CAAC;AACtE,OAAO,KAAK,EAAC,eAAe,EAAC,MAAM,0BAA0B,CAAC;AAC9D,OAAO,EAAC,eAAe,EAAC,MAAM,SAAS,CAAC;AAExC,MAAM,WAAW,YAAY,CAC3B,SAAS,SAAS,oBAAoB,GAAG,oBAAoB,EAC7D,OAAO,SAAS,cAAc,GAAG,cAAc,CAC/C,SAAQ,IAAI,CACV,YAAY,CAAC,SAAS,CAAC,EACrB,UAAU,GACV,YAAY,GACZ,eAAe,GACf,YAAY,GACZ,kBAAkB,CACrB;IACD;;;;OAIG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;;;;;;;;;;;;;;;;OAkBG;IACH,cAAc,EAAE,OAAO,CAAC;IAExB;;;;;;;;OAQG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAE1B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkDG;IACH,QAAQ,CAAC,EAAE,aAAa,CAAC;IAEzB;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,KAAK,CAAC,EAAE,WAAW,CAAC;IAEpB;;;;;;OAMG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IAExB;;;;OAIG;IACH,YAAY,CAAC,EAAE,eAAe,CAAC;IAE/B;;;;;;;;;;;;;;;;;OAiBG;IACH,UAAU,CAAC,EAAE,UAAU,CAAC;IAExB;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,SAAS,CAAC,OAAO,SAAS,cAAc,GAAG,cAAc,CACxE,SAAQ,SAAS;IACjB,eAAe,EAAE,OAAO,CAAC;IACzB,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,UAAU,CAAC;IACjB,cAAc,EAAE,OAAO,CAAC;IACxB,eAAe,EAAE,OAAO,CAAC;IACzB,KAAK,EAAE,WAAW,CAAC;CACpB;AAED,UAAU,UAAU;IAClB,IAAI,EAAE,MAAM,CAAC;IACb,YAAY,EAAE,MAAM,CAAC;IACrB,cAAc,EAAE,MAAM,CAAC;IACvB,qBAAqB,EAAE,MAAM,CAAC;IAC9B,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,aAAa;IAC5B,CAAC,GAAG,EAAE,MAAM,GAAG,cAAc,GAAG,cAAc,EAAE,CAAC;CAClD;AAED,UAAU,WAAW;IACnB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACH,SAAS,CAAC,EAAE,CAAC,OAAO,EAAE,gBAAgB,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CACjE;AAED,MAAM,WAAW,gBAAgB,CAC/B,CAAC,SAAS,oBAAoB,GAAG,oBAAoB;IAErD,OAAO,EAAE,OAAO,CAAC;IACjB,KAAK,EAAE,eAAe,CAAC,CAAC,CAAC,CAAC;CAC3B;AAED,MAAM,WAAW,eAAe,CAC9B,SAAS,SAAS,oBAAoB,GAAG,oBAAoB;IAE7D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmDG;IACH,IAAI,EAAE,eAAe,CAAC,SAAS,CAAC,CAAC;IAEjC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACH,OAAO,EAAE,oBAAoB,CAAC;CAC/B"}
+{"version":3,"file":"config-types.d.ts","sourceRoot":"","sources":["../../src/config-types.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,YAAY,IAAI,YAAY,EAC5B,eAAe,IAAI,SAAS,EAC5B,oBAAoB,EACpB,OAAO,EACP,UAAU,EACV,cAAc,EACf,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAC,cAAc,EAAC,MAAM,sCAAsC,CAAC;AAEpE,OAAO,KAAK,EAAC,oBAAoB,EAAC,MAAM,6BAA6B,CAAC;AACtE,OAAO,KAAK,EAAC,eAAe,EAAC,MAAM,0BAA0B,CAAC;AAC9D,OAAO,EAAC,eAAe,EAAC,MAAM,SAAS,CAAC;AAExC,MAAM,WAAW,YAAY,CAC3B,SAAS,SAAS,oBAAoB,GAAG,oBAAoB,EAC7D,OAAO,SAAS,cAAc,GAAG,cAAc,CAC/C,SAAQ,IAAI,CACV,YAAY,CAAC,SAAS,CAAC,EACrB,UAAU,GACV,YAAY,GACZ,eAAe,GACf,YAAY,GACZ,kBAAkB,CACrB;IACD;;;;OAIG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;;;;;;;;;;;;;;;;;OAmBG;IACH,cAAc,EAAE,OAAO,CAAC;IAExB;;;;;;;;OAQG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAE1B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAoDG;IACH,QAAQ,CAAC,EAAE,aAAa,CAAC;IAEzB;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,KAAK,CAAC,EAAE,WAAW,CAAC;IAEpB;;;;;;OAMG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IAExB;;;;OAIG;IACH,YAAY,CAAC,EAAE,eAAe,CAAC;IAE/B;;;;;;;;;;;;;;;;;OAiBG;IACH,UAAU,CAAC,EAAE,UAAU,CAAC;IAExB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,SAAS,CAAC,OAAO,SAAS,cAAc,GAAG,cAAc,CACxE,SAAQ,SAAS;IACjB,eAAe,EAAE,OAAO,CAAC;IACzB,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,UAAU,CAAC;IACjB,cAAc,EAAE,OAAO,CAAC;IACxB,eAAe,EAAE,OAAO,CAAC;IACzB,KAAK,EAAE,WAAW,CAAC;CACpB;AAED,UAAU,UAAU;IAClB,IAAI,EAAE,MAAM,CAAC;IACb,YAAY,EAAE,MAAM,CAAC;IACrB,cAAc,EAAE,MAAM,CAAC;IACvB,qBAAqB,EAAE,MAAM,CAAC;IAC9B,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,aAAa;IAC5B,CAAC,GAAG,EAAE,MAAM,GAAG,cAAc,GAAG,cAAc,EAAE,CAAC;CAClD;AAED,UAAU,WAAW;IACnB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACH,SAAS,CAAC,EAAE,CAAC,OAAO,EAAE,gBAAgB,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CACjE;AAED,MAAM,WAAW,gBAAgB,CAC/B,CAAC,SAAS,oBAAoB,GAAG,oBAAoB;IAErD,OAAO,EAAE,OAAO,CAAC;IACjB,KAAK,EAAE,eAAe,CAAC,CAAC,CAAC,CAAC;CAC3B;AAED,MAAM,WAAW,eAAe,CAC9B,SAAS,SAAS,oBAAoB,GAAG,oBAAoB;IAE7D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAwDG;IACH,IAAI,EAAE,eAAe,CAAC,SAAS,CAAC,CAAC;IAEjC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACH,OAAO,EAAE,oBAAoB,CAAC;CAC/B"}

package/build/ts/index.d.ts

@@ -3,6 +3,8 @@ import { ShopifyRestResources } from '@shopify/shopify-api';
 import { SessionStorage } from '@shopify/shopify-app-session-storage';
 import { type AppConfigArg } from './config-types';
 import { type ShopifyApp } from './types';
+import { headersBoundary } from './boundary/headers';
+import { errorBoundary } from './boundary/error';
 export type { ShopifyApp, LoginError } from './types';
 export { LoginErrorType, AppDistribution } from './types';
 export { LATEST_API_VERSION, LogSeverity, DeliveryMethod, BillingInterval, } from '@shopify/shopify-api';
@@ -17,13 +19,49 @@ export { LATEST_API_VERSION, LogSeverity, DeliveryMethod, BillingInterval, } fro
  * ```ts
  * import { shopifyApp } from "@shopify/shopify-app-remix";
  *
- * export const shopify = shopifyApp({
+ * 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;
  * ```
  */
 export declare function shopifyApp<Config extends AppConfigArg<Resources, Storage>, Resources extends ShopifyRestResources, Storage extends SessionStorage>(appConfig: Config): ShopifyApp<Config>;
+/**
+ * A collection of functions that handle the necessary code for error boundaries in routes using authenticate.admin.
+ */
+export declare const boundary: {
+    /**
+     * A function that handles errors or thrown responses.
+     *
+     * @example
+     * Catching errors in a route
+     * ```ts
+     * // app/routes/admin/widgets.ts
+     * import { boundary } from "@shopify/shopify-app-remix";
+     *
+     * export function ErrorBoundary() {
+     *   return boundary.error(useRouteError());
+     * }
+     * ```
+     */
+    error: typeof errorBoundary;
+    /**
+     * A function that sets the appropriate document repsonse headers.
+     *
+     * @example
+     * Catching errors in a route
+     * ```ts
+     * // app/routes/admin/widgets.ts
+     * import { boundary } from "@shopify/shopify-app-remix";
+     *
+     * export const headers = (headersArgs) => {
+     *   return boundary.headers(headersArgs);
+     * };
+     * ```
+     */
+    headers: typeof headersBoundary;
+};
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,uCAAuC,CAAC;AAC/C,OAAO,EAML,oBAAoB,EAErB,MAAM,sBAAsB,CAAC;AAE9B,OAAO,EAAC,cAAc,EAAC,MAAM,sCAAsC,CAAC;AAEpE,OAAO,EAAiB,KAAK,YAAY,EAAC,MAAM,gBAAgB,CAAC;AACjE,OAAO,EAIL,KAAK,UAAU,EAChB,MAAM,SAAS,CAAC;AAajB,YAAY,EAAC,UAAU,EAAE,UAAU,EAAC,MAAM,SAAS,CAAC;AACpD,OAAO,EAAC,cAAc,EAAE,eAAe,EAAC,MAAM,SAAS,CAAC;AAExD,OAAO,EACL,kBAAkB,EAClB,WAAW,EACX,cAAc,EACd,eAAe,GAChB,MAAM,sBAAsB,CAAC;AAM9B;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAgB,UAAU,CACxB,MAAM,SAAS,YAAY,CAAC,SAAS,EAAE,OAAO,CAAC,EAC/C,SAAS,SAAS,oBAAoB,EACtC,OAAO,SAAS,cAAc,EAC9B,SAAS,EAAE,MAAM,GAAG,UAAU,CAAC,MAAM,CAAC,CA6BvC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,uCAAuC,CAAC;AAC/C,OAAO,EAML,oBAAoB,EAErB,MAAM,sBAAsB,CAAC;AAE9B,OAAO,EAAC,cAAc,EAAC,MAAM,sCAAsC,CAAC;AAEpE,OAAO,EAAiB,KAAK,YAAY,EAAC,MAAM,gBAAgB,CAAC;AACjE,OAAO,EAIL,KAAK,UAAU,EAKhB,MAAM,SAAS,CAAC;AASjB,OAAO,EAAC,eAAe,EAAC,MAAM,oBAAoB,CAAC;AACnD,OAAO,EAAC,aAAa,EAAC,MAAM,kBAAkB,CAAC;AAE/C,YAAY,EAAC,UAAU,EAAE,UAAU,EAAC,MAAM,SAAS,CAAC;AACpD,OAAO,EAAC,cAAc,EAAE,eAAe,EAAC,MAAM,SAAS,CAAC;AAExD,OAAO,EACL,kBAAkB,EAClB,WAAW,EACX,cAAc,EACd,eAAe,GAChB,MAAM,sBAAsB,CAAC;AAM9B;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,UAAU,CACxB,MAAM,SAAS,YAAY,CAAC,SAAS,EAAE,OAAO,CAAC,EAC/C,SAAS,SAAS,oBAAoB,EACtC,OAAO,SAAS,cAAc,EAC9B,SAAS,EAAE,MAAM,GAAG,UAAU,CAAC,MAAM,CAAC,CAqCvC;AAED;;GAEG;AACH,eAAO,MAAM,QAAQ;IACnB;;;;;;;;;;;;;OAaG;;IAGH;;;;;;;;;;;;;OAaG;;CAEJ,CAAC"}

package/build/ts/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.shopifyApp = exports.BillingInterval = exports.DeliveryMethod = exports.LogSeverity = exports.LATEST_API_VERSION = exports.AppDistribution = exports.LoginErrorType = void 0;
+exports.boundary = exports.shopifyApp = exports.BillingInterval = exports.DeliveryMethod = exports.LogSeverity = exports.LATEST_API_VERSION = exports.AppDistribution = exports.LoginErrorType = void 0;
 var tslib_1 = require("tslib");
 require("@shopify/shopify-api/adapters/web-api");
 var shopify_api_1 = require("@shopify/shopify-api");
@@ -12,8 +12,10 @@ var authenticate_1 = require("./auth/admin/authenticate");
 var authenticate_2 = require("./auth/webhooks/authenticate");
 var authenticate_3 = require("./auth/public/authenticate");
 var override_logger_1 = require("./override-logger");
-var add_response_headers_1 = require("./auth/helpers/add-response-headers");
+var helpers_1 = require("./auth/helpers");
 var login_1 = require("./auth/login/login");
+var headers_1 = require("./boundary/headers");
+var error_1 = require("./boundary/error");
 var types_2 = require("./types");
 Object.defineProperty(exports, "LoginErrorType", { enumerable: true, get: function () { return types_2.LoginErrorType; } });
 Object.defineProperty(exports, "AppDistribution", { enumerable: true, get: function () { return types_2.AppDistribution; } });
@@ -36,38 +38,82 @@ Object.defineProperty(exports, "BillingInterval", { enumerable: true, get: funct
  * ```ts
  * import { shopifyApp } from "@shopify/shopify-app-remix";
  *
- * export const shopify = shopifyApp({
+ * 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) {
     var api = deriveApi(appConfig);
     var config = deriveConfig(appConfig, api.config);
     var logger = (0, override_logger_1.overrideLogger)(api.logger);
-    (0, add_response_headers_1.installGlobalResponseHeaders)(config.isEmbeddedApp);
     if (appConfig.webhooks) {
         api.webhooks.addHandlers(appConfig.webhooks);
     }
     var params = { api: api, config: config, logger: logger };
     var oauth = new authenticate_1.AuthStrategy(params);
-    return {
+    var shopify = {
         sessionStorage: config.sessionStorage,
-        canUseLoginForm: config.canUseLoginForm,
-        addResponseHeaders: (0, add_response_headers_1.addResponseHeadersFactory)(params),
+        addDocumentResponseHeaders: (0, helpers_1.addDocumentResponseHeadersFactory)(params),
         registerWebhooks: (0, webhooks_1.registerWebhooksFactory)(params),
-        login: (0, login_1.loginFactory)(params),
         authenticate: {
             admin: oauth.authenticateAdmin.bind(oauth),
             public: (0, authenticate_3.authenticatePublicFactory)(params),
             webhook: (0, authenticate_2.authenticateWebhookFactory)(params),
         },
     };
+    if (isAppStoreApp(shopify, appConfig) ||
+        isSingleMerchantApp(shopify, appConfig)) {
+        shopify.login = (0, login_1.loginFactory)(params);
+    }
+    return shopify;
 }
 exports.shopifyApp = shopifyApp;
+/**
+ * A collection of functions that handle the necessary code for error boundaries in routes using authenticate.admin.
+ */
+exports.boundary = {
+    /**
+     * A function that handles errors or thrown responses.
+     *
+     * @example
+     * Catching errors in a route
+     * ```ts
+     * // app/routes/admin/widgets.ts
+     * import { boundary } from "@shopify/shopify-app-remix";
+     *
+     * export function ErrorBoundary() {
+     *   return boundary.error(useRouteError());
+     * }
+     * ```
+     */
+    error: error_1.errorBoundary,
+    /**
+     * A function that sets the appropriate document repsonse headers.
+     *
+     * @example
+     * Catching errors in a route
+     * ```ts
+     * // app/routes/admin/widgets.ts
+     * import { boundary } from "@shopify/shopify-app-remix";
+     *
+     * export const headers = (headersArgs) => {
+     *   return boundary.headers(headersArgs);
+     * };
+     * ```
+     */
+    headers: headers_1.headersBoundary,
+};
+function isAppStoreApp(_shopify, config) {
+    return config.distribution === types_1.AppDistribution.AppStore;
+}
+function isSingleMerchantApp(_shopify, config) {
+    return config.distribution === types_1.AppDistribution.SingleMerchant;
+}
 function deriveApi(appConfig) {
     var _a, _b;
     var appUrl;
@@ -96,8 +142,8 @@ function deriveConfig(appConfig, apiConfig) {
         throw new shopify_api_1.ShopifyError('Please provide a valid session storage. See https://github.com/Shopify/shopify-app-js/blob/main/README.md#session-storage-options for options.');
     }
     var authPathPrefix = appConfig.authPathPrefix || '/auth';
-    var distribution = (_a = appConfig.distribution) !== null && _a !== void 0 ? _a : types_1.AppDistribution.AppStore;
-    return tslib_1.__assign(tslib_1.__assign(tslib_1.__assign({}, appConfig), apiConfig), { canUseLoginForm: distribution !== types_1.AppDistribution.ShopifyAdmin, useOnlineTokens: (_b = appConfig.useOnlineTokens) !== null && _b !== void 0 ? _b : false, hooks: (_c = appConfig.hooks) !== null && _c !== void 0 ? _c : {}, sessionStorage: appConfig.sessionStorage, auth: {
+    appConfig.distribution = (_a = appConfig.distribution) !== null && _a !== void 0 ? _a : types_1.AppDistribution.AppStore;
+    return tslib_1.__assign(tslib_1.__assign(tslib_1.__assign({}, appConfig), apiConfig), { canUseLoginForm: appConfig.distribution !== types_1.AppDistribution.ShopifyAdmin, useOnlineTokens: (_b = appConfig.useOnlineTokens) !== null && _b !== void 0 ? _b : false, hooks: (_c = appConfig.hooks) !== null && _c !== void 0 ? _c : {}, sessionStorage: appConfig.sessionStorage, auth: {
             path: authPathPrefix,
             callbackPath: "".concat(authPathPrefix, "/callback"),
             patchSessionTokenPath: "".concat(authPathPrefix, "/session-token"),

package/build/ts/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;;AAAA,iDAA+C;AAC/C,oDAQ8B;AAC9B,wDAAsE;AAItE,iCAKiB;AACjB,qCAAwD;AACxD,4CAAwD;AACxD,0DAAuD;AACvD,6DAAwE;AACxE,2DAAqE;AACrE,qDAAiD;AACjD,4EAG6C;AAC7C,4CAAgD;AAGhD,iCAAwD;AAAhD,uGAAA,cAAc,OAAA;AAAE,wGAAA,eAAe,OAAA;AAEvC,oDAK8B;AAJ5B,iHAAA,kBAAkB,OAAA;AAClB,0GAAA,WAAW,OAAA;AACX,6GAAA,cAAc,OAAA;AACd,8GAAA,eAAe,OAAA;AAGjB,IAAA,kCAAwB,EAAC;IACvB,OAAO,OAAO,CAAC;AACjB,CAAC,CAAC,CAAC;AAEH;;;;;;;;;;;;;;;;;;GAkBG;AACH,SAAgB,UAAU,CAIxB,SAAiB;IACjB,IAAM,GAAG,GAAG,SAAS,CAAY,SAAS,CAAC,CAAC;IAC5C,IAAM,MAAM,GAAG,YAAY,CAAU,SAAS,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;IAC5D,IAAM,MAAM,GAAG,IAAA,gCAAc,EAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IAE1C,IAAA,mDAA4B,EAAC,MAAM,CAAC,aAAa,CAAC,CAAC;IAEnD,IAAI,SAAS,CAAC,QAAQ,EAAE;QACtB,GAAG,CAAC,QAAQ,CAAC,WAAW,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;KAC9C;IAED,IAAM,MAAM,GAAgB,EAAC,GAAG,KAAA,EAAE,MAAM,QAAA,EAAE,MAAM,QAAA,EAAC,CAAC;IAClD,IAAM,KAAK,GAAG,IAAI,2BAAY,CAAoB,MAAM,CAAC,CAAC;IAE1D,OAAO;QACL,cAAc,EAAE,MAAM,CAAC,cAAc;QACrC,eAAe,EAAE,MAAM,CAAC,eAAe;QACvC,kBAAkB,EAAE,IAAA,gDAAyB,EAAC,MAAM,CAAC;QACrD,gBAAgB,EAAE,IAAA,kCAAuB,EAAC,MAAM,CAAC;QACjD,KAAK,EAAE,IAAA,oBAAY,EAAC,MAAM,CAAC;QAC3B,YAAY,EAAE;YACZ,KAAK,EAAE,KAAK,CAAC,iBAAiB,CAAC,IAAI,CAAC,KAAK,CAAC;YAC1C,MAAM,EAAE,IAAA,wCAAyB,EAAC,MAAM,CAAC;YACzC,OAAO,EAAE,IAAA,yCAA0B,EAGjC,MAAM,CAAC;SACV;KACF,CAAC;AACJ,CAAC;AAjCD,gCAiCC;AAED,SAAS,SAAS,CAChB,SAAuB;;IAEvB,IAAI,MAAW,CAAC;IAChB,IAAI;QACF,MAAM,GAAG,IAAI,GAAG,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;KACpC;IAAC,OAAO,KAAK,EAAE;QACd,MAAM,IAAI,0BAAY,CACpB,sDAAsD,CACvD,CAAC;KACH;IAED,mCAAmC;IACnC,IAAI,MAAM,CAAC,QAAQ,KAAK,WAAW,IAAI,CAAC,MAAM,CAAC,IAAI,IAAI,OAAO,CAAC,GAAG,CAAC,IAAI,EAAE;QACvE,MAAM,CAAC,IAAI,GAAG,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC;KAChC;IACD,kCAAkC;IAClC,SAAS,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC;IAEjC,IAAI,eAAe,GAAG,iCAA0B,uCAA6B,CAAE,CAAC;IAChF,IAAI,SAAS,CAAC,eAAe,EAAE;QAC7B,eAAe,GAAG,UAAG,SAAS,CAAC,eAAe,gBAAM,eAAe,CAAE,CAAC;KACvE;IAED,IAAM,cAAc,yCACf,SAAS,KACZ,QAAQ,EAAE,MAAM,CAAC,IAAI,EACrB,UAAU,EAAE,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,CAAqB,EAChE,eAAe,iBAAA,EACf,aAAa,EAAE,MAAA,SAAS,CAAC,aAAa,mCAAI,IAAI,EAC9C,UAAU,EAAE,MAAA,SAAS,CAAC,UAAU,mCAAI,gCAAkB,EACtD,gBAAgB,EAAE,SAAS,CAAC,YAAY,KAAK,uBAAe,CAAC,YAAY,GAC1E,CAAC;IAEF,OAAO,IAAA,wBAAU,EAAY,cAAc,CAAC,CAAC;AAC/C,CAAC;AAED,SAAS,YAAY,CACnB,SAAuB,EACvB,SAAoB;;IAEpB,IAAI,CAAC,SAAS,CAAC,cAAc,EAAE;QAC7B,MAAM,IAAI,0BAAY,CACpB,gJAAgJ,CACjJ,CAAC;KACH;IAED,IAAM,cAAc,GAAG,SAAS,CAAC,cAAc,IAAI,OAAO,CAAC;IAC3D,IAAM,YAAY,GAAG,MAAA,SAAS,CAAC,YAAY,mCAAI,uBAAe,CAAC,QAAQ,CAAC;IAExE,8DACK,SAAS,GACT,SAAS,KACZ,eAAe,EAAE,YAAY,KAAK,uBAAe,CAAC,YAAY,EAC9D,eAAe,EAAE,MAAA,SAAS,CAAC,eAAe,mCAAI,KAAK,EACnD,KAAK,EAAE,MAAA,SAAS,CAAC,KAAK,mCAAI,EAAE,EAC5B,cAAc,EAAE,SAAS,CAAC,cAAyB,EACnD,IAAI,EAAE;YACJ,IAAI,EAAE,cAAc;YACpB,YAAY,EAAE,UAAG,cAAc,cAAW;YAC1C,qBAAqB,EAAE,UAAG,cAAc,mBAAgB;YACxD,cAAc,EAAE,UAAG,cAAc,iBAAc;YAC/C,SAAS,EAAE,UAAG,cAAc,WAAQ;SACrC,IACD;AACJ,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;;AAAA,iDAA+C;AAC/C,oDAQ8B;AAC9B,wDAAsE;AAItE,iCASiB;AACjB,qCAAwD;AACxD,4CAAwD;AACxD,0DAAuD;AACvD,6DAAwE;AACxE,2DAAqE;AACrE,qDAAiD;AACjD,0CAAiE;AACjE,4CAAgD;AAChD,8CAAmD;AACnD,0CAA+C;AAG/C,iCAAwD;AAAhD,uGAAA,cAAc,OAAA;AAAE,wGAAA,eAAe,OAAA;AAEvC,oDAK8B;AAJ5B,iHAAA,kBAAkB,OAAA;AAClB,0GAAA,WAAW,OAAA;AACX,6GAAA,cAAc,OAAA;AACd,8GAAA,eAAe,OAAA;AAGjB,IAAA,kCAAwB,EAAC;IACvB,OAAO,OAAO,CAAC;AACjB,CAAC,CAAC,CAAC;AAEH;;;;;;;;;;;;;;;;;;;GAmBG;AACH,SAAgB,UAAU,CAIxB,SAAiB;IACjB,IAAM,GAAG,GAAG,SAAS,CAAY,SAAS,CAAC,CAAC;IAC5C,IAAM,MAAM,GAAG,YAAY,CAAU,SAAS,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;IAC5D,IAAM,MAAM,GAAG,IAAA,gCAAc,EAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IAE1C,IAAI,SAAS,CAAC,QAAQ,EAAE;QACtB,GAAG,CAAC,QAAQ,CAAC,WAAW,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;KAC9C;IAED,IAAM,MAAM,GAAgB,EAAC,GAAG,KAAA,EAAE,MAAM,QAAA,EAAE,MAAM,QAAA,EAAC,CAAC;IAClD,IAAM,KAAK,GAAG,IAAI,2BAAY,CAAoB,MAAM,CAAC,CAAC;IAE1D,IAAM,OAAO,GAGmB;QAC9B,cAAc,EAAE,MAAM,CAAC,cAAc;QACrC,0BAA0B,EAAE,IAAA,2CAAiC,EAAC,MAAM,CAAC;QACrE,gBAAgB,EAAE,IAAA,kCAAuB,EAAC,MAAM,CAAC;QACjD,YAAY,EAAE;YACZ,KAAK,EAAE,KAAK,CAAC,iBAAiB,CAAC,IAAI,CAAC,KAAK,CAAC;YAC1C,MAAM,EAAE,IAAA,wCAAyB,EAAC,MAAM,CAAC;YACzC,OAAO,EAAE,IAAA,yCAA0B,EAGjC,MAAM,CAAC;SACV;KACF,CAAC;IAEF,IACE,aAAa,CAAC,OAAO,EAAE,SAAS,CAAC;QACjC,mBAAmB,CAAC,OAAO,EAAE,SAAS,CAAC,EACvC;QACA,OAAO,CAAC,KAAK,GAAG,IAAA,oBAAY,EAAC,MAAM,CAAC,CAAC;KACtC;IAED,OAAO,OAA6B,CAAC;AACvC,CAAC;AAzCD,gCAyCC;AAED;;GAEG;AACU,QAAA,QAAQ,GAAG;IACtB;;;;;;;;;;;;;OAaG;IACH,KAAK,EAAE,qBAAa;IAEpB;;;;;;;;;;;;;OAaG;IACH,OAAO,EAAE,yBAAe;CACzB,CAAC;AAEF,SAAS,aAAa,CACpB,QAAgC,EAChC,MAAc;IAEd,OAAO,MAAM,CAAC,YAAY,KAAK,uBAAe,CAAC,QAAQ,CAAC;AAC1D,CAAC;AAED,SAAS,mBAAmB,CAC1B,QAAgC,EAChC,MAAc;IAEd,OAAO,MAAM,CAAC,YAAY,KAAK,uBAAe,CAAC,cAAc,CAAC;AAChE,CAAC;AAED,SAAS,SAAS,CAChB,SAAuB;;IAEvB,IAAI,MAAW,CAAC;IAChB,IAAI;QACF,MAAM,GAAG,IAAI,GAAG,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;KACpC;IAAC,OAAO,KAAK,EAAE;QACd,MAAM,IAAI,0BAAY,CACpB,sDAAsD,CACvD,CAAC;KACH;IAED,mCAAmC;IACnC,IAAI,MAAM,CAAC,QAAQ,KAAK,WAAW,IAAI,CAAC,MAAM,CAAC,IAAI,IAAI,OAAO,CAAC,GAAG,CAAC,IAAI,EAAE;QACvE,MAAM,CAAC,IAAI,GAAG,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC;KAChC;IACD,kCAAkC;IAClC,SAAS,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC;IAEjC,IAAI,eAAe,GAAG,iCAA0B,uCAA6B,CAAE,CAAC;IAChF,IAAI,SAAS,CAAC,eAAe,EAAE;QAC7B,eAAe,GAAG,UAAG,SAAS,CAAC,eAAe,gBAAM,eAAe,CAAE,CAAC;KACvE;IAED,IAAM,cAAc,yCACf,SAAS,KACZ,QAAQ,EAAE,MAAM,CAAC,IAAI,EACrB,UAAU,EAAE,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,CAAqB,EAChE,eAAe,iBAAA,EACf,aAAa,EAAE,MAAA,SAAS,CAAC,aAAa,mCAAI,IAAI,EAC9C,UAAU,EAAE,MAAA,SAAS,CAAC,UAAU,mCAAI,gCAAkB,EACtD,gBAAgB,EAAE,SAAS,CAAC,YAAY,KAAK,uBAAe,CAAC,YAAY,GAC1E,CAAC;IAEF,OAAO,IAAA,wBAAU,EAAY,cAAc,CAAC,CAAC;AAC/C,CAAC;AAED,SAAS,YAAY,CACnB,SAAuB,EACvB,SAAoB;;IAEpB,IAAI,CAAC,SAAS,CAAC,cAAc,EAAE;QAC7B,MAAM,IAAI,0BAAY,CACpB,gJAAgJ,CACjJ,CAAC;KACH;IAED,IAAM,cAAc,GAAG,SAAS,CAAC,cAAc,IAAI,OAAO,CAAC;IAC3D,SAAS,CAAC,YAAY,GAAG,MAAA,SAAS,CAAC,YAAY,mCAAI,uBAAe,CAAC,QAAQ,CAAC;IAE5E,8DACK,SAAS,GACT,SAAS,KACZ,eAAe,EAAE,SAAS,CAAC,YAAY,KAAK,uBAAe,CAAC,YAAY,EACxE,eAAe,EAAE,MAAA,SAAS,CAAC,eAAe,mCAAI,KAAK,EACnD,KAAK,EAAE,MAAA,SAAS,CAAC,KAAK,mCAAI,EAAE,EAC5B,cAAc,EAAE,SAAS,CAAC,cAAyB,EACnD,IAAI,EAAE;YACJ,IAAI,EAAE,cAAc;YACpB,YAAY,EAAE,UAAG,cAAc,cAAW;YAC1C,qBAAqB,EAAE,UAAG,cAAc,mBAAgB;YACxD,cAAc,EAAE,UAAG,cAAc,iBAAc;YAC/C,SAAS,EAAE,UAAG,cAAc,WAAQ;SACrC,IACD;AACJ,CAAC"}