@shopify/shopify-app-remix 1.2.0 → 1.3.0

package/build/ts/server/clients/storefront/index.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+var tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./factory"), exports);
+tslib_1.__exportStar(require("./types"), exports);
+//# sourceMappingURL=index.js.map

package/build/ts/server/clients/storefront/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../src/server/clients/storefront/index.ts"],"names":[],"mappings":";;;AAAA,oDAA0B;AAC1B,kDAAwB"}

package/build/ts/server/clients/storefront/types.d.ts

@@ -0,0 +1,29 @@
+import { GraphQLClient } from '../types';
+export interface StorefrontContext {
+    /**
+     * Method for interacting with the Shopify Storefront GraphQL API
+     *
+     * If you're getting incorrect type hints in the Shopify template, follow [these instructions](https://github.com/Shopify/shopify-app-template-remix/tree/main#incorrect-graphql-hints).
+     *
+     * {@link https://shopify.dev/docs/api/storefront}
+     *
+     * @example
+     * <caption>Querying the GraphQL API.</caption>
+     * <description>Use `storefront.graphql` to make query / mutation requests.</description>
+     * ```ts
+     * import { ActionArgs } from "@remix-run/node";
+     * import { authenticate } from "../shopify.server";
+     *
+     * export async function action({ request }: ActionArgs) {
+     *   const { storefront } = await authenticate.storefront(request);
+     *
+     *   const response = await storefront.graphql(`{blogs(first: 10) { edges { node { id } } } }`);
+     *
+     *   const productData = await response.json();
+     *   return json({ data: productData.data });
+     * }
+     * ```
+     */
+    graphql: GraphQLClient;
+}
+//# sourceMappingURL=types.d.ts.map

package/build/ts/server/clients/storefront/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../../src/server/clients/storefront/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,aAAa,EAAC,MAAM,UAAU,CAAC;AAEvC,MAAM,WAAW,iBAAiB;IAChC;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,OAAO,EAAE,aAAa,CAAC;CACxB"}

package/build/ts/server/clients/storefront/types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=types.js.map

package/build/ts/server/clients/storefront/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../../src/server/clients/storefront/types.ts"],"names":[],"mappings":""}

package/build/ts/server/clients/types.d.ts

@@ -0,0 +1,15 @@
+import { ApiVersion } from '@shopify/shopify-api';
+interface QueryVariables {
+    [key: string]: any;
+}
+export interface GraphQLQueryOptions {
+    variables?: QueryVariables;
+    apiVersion?: ApiVersion;
+    headers?: {
+        [key: string]: any;
+    };
+    tries?: number;
+}
+export type GraphQLClient = (query: string, options?: GraphQLQueryOptions) => Promise<Response>;
+export {};
+//# sourceMappingURL=types.d.ts.map

package/build/ts/server/clients/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/server/clients/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,UAAU,EAAC,MAAM,sBAAsB,CAAC;AAEhD,UAAU,cAAc;IACtB,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB;AAED,MAAM,WAAW,mBAAmB;IAClC,SAAS,CAAC,EAAE,cAAc,CAAC;IAC3B,UAAU,CAAC,EAAE,UAAU,CAAC;IACxB,OAAO,CAAC,EAAE;QAAC,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAC,CAAC;IAC/B,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,MAAM,aAAa,GAAG,CAC1B,KAAK,EAAE,MAAM,EACb,OAAO,CAAC,EAAE,mBAAmB,KAC1B,OAAO,CAAC,QAAQ,CAAC,CAAC"}

package/build/ts/server/clients/types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=types.js.map

package/build/ts/server/clients/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../src/server/clients/types.ts"],"names":[],"mappings":""}

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

@@ -1,24 +1,26 @@
 import { ConfigParams as ApiConfigArg, ConfigInterface as ApiConfig, ShopifyRestResources, Session, ApiVersion, WebhookHandler } from '@shopify/shopify-api';
 import { SessionStorage } from '@shopify/shopify-app-session-storage';
-import { AppDistribution } from './types';
-import { RestClientWithResources } from './clients/admin/rest';
-import { GraphqlQueryFunction } from './clients/admin/graphql';
+import type { AppDistribution } from './types';
+import type { AdminApiContext } from './clients';
 export interface AppConfigArg<Resources extends ShopifyRestResources = ShopifyRestResources, Storage extends SessionStorage = SessionStorage> extends Omit<ApiConfigArg<Resources>, 'hostName' | 'hostScheme' | 'isEmbeddedApp' | 'apiVersion' | 'isCustomStoreApp'> {
     /**
      * The URL your app is running on.
      *
-     * The `@shopify/cli` provides this URL as `process.env.SHOPIFY_APP_URL`.  For development this is probably a tunnel URL that points to your local machine.  If production this is your production URL.
+     * The `@shopify/cli` provides this URL as `process.env.SHOPIFY_APP_URL`.  For development this is probably a tunnel URL that points to your local machine.  If this is a production app, this is your production URL.
      */
     appUrl: string;
     /**
      * An adaptor for storing sessions in your database of choice.
      *
-     * Shopify provides multiple session storage adaptors and you can create your own. {@link https://github.com/Shopify/shopify-app-js/blob/main/README.md#session-storage-options}
+     * Shopify provides multiple session storage adaptors and you can create your own.
+     *
+     * {@link https://github.com/Shopify/shopify-app-js/blob/main/README.md#session-storage-options}
      *
      * @example
-     * Using Prisma
+     * <caption>Storing sessions with Prisma.</caption>
+     * <description>Add the `@shopify/shopify-app-session-storage-prisma` package to use the Prisma session storage.</description>
      * ```ts
-     * import { shopifyApp } from "@shopify/shopify-app-remix";
+     * import { shopifyApp } from "@shopify/shopify-app-remix/server";
      * import { PrismaSessionStorage } from "@shopify/shopify-app-session-storage-prisma";
      *
      * import prisma from "~/db.server";
@@ -32,9 +34,9 @@ export interface AppConfigArg<Resources extends ShopifyRestResources = ShopifyRe
      */
     sessionStorage: Storage;
     /**
-     * Does your app use online or just offline tokens.
+     * Whether your app use online or offline tokens.
      *
-     * If your app uses online tokens both online and offline tokens will be saved to your database.  This ensures your app can perform background jobs
+     * If your app uses online tokens, then both online and offline tokens will be saved to your database.  This ensures your app can perform background jobs.
      *
      * {@link https://shopify.dev/docs/apps/auth/oauth/access-modes}
      *
@@ -49,10 +51,10 @@ export interface AppConfigArg<Resources extends ShopifyRestResources = ShopifyRe
      * This can be in used in conjunction with the afterAuth hook to register webhook topics when a user installs your app.  Or you can use this function in other processes such as background jobs.
      *
      * @example
-     * Registering for a webhook when a merchant uninstalls your app.
+     * <caption>Registering for a webhook when a merchant uninstalls your app.</caption>
      * ```ts
-     * // app/shopify.server.ts
-     * import { DeliveryMethod, shopifyApp } from "@shopify/shopify-app-remix";
+     * // /app/shopify.server.ts
+     * import { DeliveryMethod, shopifyApp } from "@shopify/shopify-app-remix/server";
      *
      * const shopify = shopifyApp({
      *   webhooks: {
@@ -71,7 +73,7 @@ export interface AppConfigArg<Resources extends ShopifyRestResources = ShopifyRe
      * export default shopify;
      * export const authenticate = shopify.authenticate;
      *
-     * // app/routes/webhooks.jsx
+     * // /app/routes/webhooks.jsx
      * import { ActionArgs } from "@remix-run/node";
      *
      * import { authenticate } from "../shopify.server";
@@ -101,9 +103,9 @@ export interface AppConfigArg<Resources extends ShopifyRestResources = ShopifyRe
      * These functions are called in the context of the request that triggered them.  This means you can access the session.
      *
      * @example
-     * Seeding your database custom data when a merchant installs your app.
+     * <caption>Seeding your database custom data when a merchant installs your app.</caption>
      * ```ts
-     * import { DeliveryMethod, shopifyApp } from "@shopify/shopify-app-remix";
+     * import { DeliveryMethod, shopifyApp } from "@shopify/shopify-app-remix/server";
      * import { seedStoreData } from "~/db/seeds"
      *
      * const shopify = shopifyApp({
@@ -126,7 +128,7 @@ export interface AppConfigArg<Resources extends ShopifyRestResources = ShopifyRe
      */
     isEmbeddedApp?: boolean;
     /**
-     * How your app is distributed. Defaults to app store.
+     * How your app is distributed. Default is `AppDistribution.AppStore`.
      *
      * {@link https://shopify.dev/docs/apps/distribution}
      */
@@ -139,9 +141,9 @@ export interface AppConfigArg<Resources extends ShopifyRestResources = ShopifyRe
      * @defaultValue `LATEST_API_VERSION` from `@shopify/shopify-app-remix`
      *
      * @example
-     * Using the latest API Version (Recommended)
+     * <caption>Using the latest API Version (Recommended)</caption>
      * ```ts
-     * import { LATEST_API_VERSION, shopifyApp } from "@shopify/shopify-app-remix";
+     * import { LATEST_API_VERSION, shopifyApp } from "@shopify/shopify-app-remix/server";
      *
      * const shopify = shopifyApp({
      *   // ...etc
@@ -158,10 +160,10 @@ export interface AppConfigArg<Resources extends ShopifyRestResources = ShopifyRe
      * @default `"/auth"`
      *
      * @example
-     * Using the latest API Version (Recommended)
+     * <caption>Using the latest API Version (Recommended)</caption>
      * ```ts
-     * // app/shopify.server.ts
-     * import { LATEST_API_VERSION, shopifyApp } from "@shopify/shopify-app-remix";
+     * // /app/shopify.server.ts
+     * import { LATEST_API_VERSION, shopifyApp } from "@shopify/shopify-app-remix/server";
      *
      * const shopify = shopifyApp({
      *   // ...etc
@@ -170,7 +172,7 @@ export interface AppConfigArg<Resources extends ShopifyRestResources = ShopifyRe
      * export default shopify;
      * export const authenticate = shopify.authenticate;
      *
-     * // app/routes/auth/$.jsx
+     * // /app/routes/auth/$.jsx
      * import { LoaderArgs } from "@remix-run/node";
      * import { authenticate } from "../../shopify.server";
      *
@@ -210,9 +212,9 @@ interface HooksConfig {
      * @param context.admin - An object with access to the Shopify Admin API's.
      *
      * @example
-     * Registering webhooks and seeding data when a merchant installs your app.
+     * <caption>Registering webhooks and seeding data when a merchant installs your app.</caption>
      * ```ts
-     * import { DeliveryMethod, shopifyApp } from "@shopify/shopify-app-remix";
+     * import { DeliveryMethod, shopifyApp } from "@shopify/shopify-app-remix/server";
      * import { seedStoreData } from "~/db/seeds"
      *
      * const shopify = shopifyApp({
@@ -238,98 +240,5 @@ export interface AfterAuthOptions<R extends ShopifyRestResources = ShopifyRestRe
     session: Session;
     admin: AdminApiContext<R>;
 }
-export interface AdminApiContext<Resources extends ShopifyRestResources = ShopifyRestResources> {
-    /**
-     * Methods for interacting with the Shopify Admin REST API
-     *
-     * There are methods for interacting with individual REST resources. You can also make plain `GET`, `POST`, `PUT` and `DELETE` requests should the REST resources not meet your needs.
-     *
-     * {@link https://shopify.dev/docs/api/admin-rest}
-     *
-     * @example
-     * Getting the number of orders in a store using rest resources
-     * ```ts
-     * // app/shopify.server.ts
-     * import { shopifyApp } from "@shopify/shopify-app-remix";
-     * import { restResources } from "@shopify/shopify-api/rest/admin/2023-07";
-     *
-     * const shopify = shopifyApp({
-     *   restResources,
-     *   // ...etc
-     * });
-     * export default shopify;
-     * export const authenticate = shopify.authenticate;
-     *
-     * // app/routes/**\/.ts
-     * import { LoaderArgs, json } from "@remix-run/node";
-     * import { authenticate } from "../shopify.server";
-     *
-     * export const loader = async ({ request }: LoaderArgs) => {
-     *   const { admin, session } = await authenticate.admin(request);
-     *   return json(admin.rest.resources.Order.count({ session }));
-     * };
-     * ```
-     *
-     * @example
-     * Making a GET request to the REST API
-     * ```ts
-     * // app/shopify.server.ts
-     * import { shopifyApp } from "@shopify/shopify-app-remix";
-     * import { restResources } from "@shopify/shopify-api/rest/admin/2023-04";
-     *
-     * const shopify = shopifyApp({
-     *   restResources,
-     *   // ...etc
-     * });
-     * export default shopify;
-     * export const authenticate = shopify.authenticate;
-     *
-     * // app/routes/**\/.ts
-     * import { LoaderArgs, json } from "@remix-run/node";
-     * 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 });
-     * };
-     * ```
-     */
-    rest: RestClientWithResources<Resources>;
-    /**
-     * Methods for interacting with the Shopify Admin GraphQL API
-     *
-     * {@link https://shopify.dev/docs/api/admin-graphql}
-     * {@link https://github.com/Shopify/shopify-api-js/blob/main/docs/reference/clients/Graphql.md}
-     *
-     * @example
-     * Creating a new product
-     * ```ts
-     * import { ActionArgs } from "@remix-run/node";
-     * import { authenticate } from "../shopify.server";
-     *
-     * export async function action({ request }: ActionArgs) {
-     *   const { admin } = await authenticate.admin(request);
-     *
-     *   const response = await admin.graphql(
-     *     `#graphql
-     *     mutation populateProduct($input: ProductInput!) {
-     *       productCreate(input: $input) {
-     *         product {
-     *           id
-     *         }
-     *       }
-     *     }`,
-     *     { variables: { input: { title: "Product Name" } } }
-     *   );
-     *
-     *   const productData = await response.json();
-     *   return json({ data: productData.data });
-     * }
-     * ```
-     */
-    graphql: GraphqlQueryFunction;
-}
 export {};
 //# sourceMappingURL=config-types.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"config-types.d.ts","sourceRoot":"","sources":["../../../src/server/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,EAAC,eAAe,EAAC,MAAM,SAAS,CAAC;AACxC,OAAO,EAAC,uBAAuB,EAAC,MAAM,sBAAsB,CAAC;AAC7D,OAAO,EAAC,oBAAoB,EAAC,MAAM,yBAAyB,CAAC;AAE7D,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,uBAAuB,CAAC,SAAS,CAAC,CAAC;IAEzC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACH,OAAO,EAAE,oBAAoB,CAAC;CAC/B"}
+{"version":3,"file":"config-types.d.ts","sourceRoot":"","sources":["../../../src/server/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,eAAe,EAAC,MAAM,SAAS,CAAC;AAC7C,OAAO,KAAK,EAAC,eAAe,EAAC,MAAM,WAAW,CAAC;AAE/C,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;;;;;;;;;;;;;;;;;;;;;;OAsBG;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"}

package/build/ts/server/shopify-app.d.ts

@@ -6,13 +6,13 @@ import { type ShopifyApp } from './types';
 /**
  * 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.
+ * @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
- * The minimum viable configuration
+ * <caption>The minimum viable configuration</caption>
  * ```ts
- * import { shopifyApp } from "@shopify/shopify-app-remix";
+ * import { shopifyApp } from "@shopify/shopify-app-remix/server";
  *
  * const shopify = shopifyApp({
  *   apiKey: process.env.SHOPIFY_API_KEY!,

package/build/ts/server/shopify-app.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"shopify-app.d.ts","sourceRoot":"","sources":["../../../src/server/shopify-app.ts"],"names":[],"mappings":"AAAA,OAAO,uCAAuC,CAAC;AAC/C,OAAO,EAML,oBAAoB,EAErB,MAAM,sBAAsB,CAAC;AAC9B,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;AAWjB;;;;;;;;;;;;;;;;;;;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,CAwCvC"}
+{"version":3,"file":"shopify-app.d.ts","sourceRoot":"","sources":["../../../src/server/shopify-app.ts"],"names":[],"mappings":"AAAA,OAAO,uCAAuC,CAAC;AAC/C,OAAO,EAML,oBAAoB,EAErB,MAAM,sBAAsB,CAAC;AAC9B,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;AAYjB;;;;;;;;;;;;;;;;;;;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,CAyCvC"}

package/build/ts/server/shopify-app.doc.d.ts

@@ -0,0 +1,4 @@
+import { ReferenceEntityTemplateSchema } from '@shopify/generate-docs';
+declare const data: ReferenceEntityTemplateSchema;
+export default data;
+//# sourceMappingURL=shopify-app.doc.d.ts.map

package/build/ts/server/shopify-app.doc.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"shopify-app.doc.d.ts","sourceRoot":"","sources":["../../../src/server/shopify-app.doc.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,6BAA6B,EAAC,MAAM,wBAAwB,CAAC;AAErE,QAAA,MAAM,IAAI,EAAE,6BAgCX,CAAC;AAEF,eAAe,IAAI,CAAC"}

package/build/ts/server/shopify-app.doc.js

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+var data = {
+    name: 'shopifyApp',
+    description: "Returns a set of functions that can be used by the app's backend to be able to respond to all Shopify requests." +
+        '\n\nThe shape of the returned object changes depending on the value of `distribution`. If it is `AppDistribution.ShopifyAdmin`, then only `ShopifyAppBase` objects are returned, otherwise `ShopifyAppLogin` objects are included.',
+    category: 'Entrypoints',
+    type: 'function',
+    isVisualComponent: false,
+    definitions: [
+        {
+            title: 'shopifyApp',
+            description: 'Function to create a new Shopify API object.',
+            type: 'ShopifyAppGeneratedType',
+        },
+    ],
+    jsDocTypeExamples: [
+        'ShopifyAppGeneratedType',
+        'ShopifyAppBase',
+        'ShopifyAppLogin',
+    ],
+    related: [
+        {
+            name: 'Authenticated contexts',
+            subtitle: 'Authenticate requests coming from Shopify.',
+            url: '/docs/api/shopify-app-remix/authenticate',
+        },
+        {
+            name: 'Unauthenticated contexts',
+            subtitle: 'Interact with the API on non-Shopify requests.',
+            url: '/docs/api/shopify-app-remix/unauthenticated',
+        },
+    ],
+};
+exports.default = data;
+//# sourceMappingURL=shopify-app.doc.js.map

package/build/ts/server/shopify-app.doc.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"shopify-app.doc.js","sourceRoot":"","sources":["../../../src/server/shopify-app.doc.ts"],"names":[],"mappings":";;AAEA,IAAM,IAAI,GAAkC;IAC1C,IAAI,EAAE,YAAY;IAClB,WAAW,EACT,iHAAiH;QACjH,oOAAoO;IACtO,QAAQ,EAAE,aAAa;IACvB,IAAI,EAAE,UAAU;IAChB,iBAAiB,EAAE,KAAK;IACxB,WAAW,EAAE;QACX;YACE,KAAK,EAAE,YAAY;YACnB,WAAW,EAAE,8CAA8C;YAC3D,IAAI,EAAE,yBAAyB;SAChC;KACF;IACD,iBAAiB,EAAE;QACjB,yBAAyB;QACzB,gBAAgB;QAChB,iBAAiB;KAClB;IACD,OAAO,EAAE;QACP;YACE,IAAI,EAAE,wBAAwB;YAC9B,QAAQ,EAAE,4CAA4C;YACtD,GAAG,EAAE,0CAA0C;SAChD;QACD;YACE,IAAI,EAAE,0BAA0B;YAChC,QAAQ,EAAE,gDAAgD;YAC1D,GAAG,EAAE,6CAA6C;SACnD;KACF;CACF,CAAC;AAEF,kBAAe,IAAI,CAAC"}

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

@@ -14,16 +14,17 @@ var helpers_1 = require("./authenticate/helpers");
 var login_1 = require("./authenticate/login/login");
 var admin_1 = require("./unauthenticated/admin");
 var public_1 = require("./authenticate/public");
+var storefront_1 = require("./unauthenticated/storefront");
 /**
  * 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.
+ * @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
- * The minimum viable configuration
+ * <caption>The minimum viable configuration</caption>
  * ```ts
- * import { shopifyApp } from "@shopify/shopify-app-remix";
+ * import { shopifyApp } from "@shopify/shopify-app-remix/server";
  *
  * const shopify = shopifyApp({
  *   apiKey: process.env.SHOPIFY_API_KEY!,
@@ -54,6 +55,7 @@ function shopifyApp(appConfig) {
         },
         unauthenticated: {
             admin: (0, admin_1.unauthenticatedAdminContextFactory)(params),
+            storefront: (0, storefront_1.unauthenticatedStorefrontContextFactory)(params),
         },
     };
     if (isAppStoreApp(shopify, appConfig) ||
@@ -94,7 +96,7 @@ function deriveApi(appConfig) {
 function deriveConfig(appConfig, apiConfig) {
     var _a, _b, _c;
     if (!appConfig.sessionStorage) {
-        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.');
+        throw new shopify_api_1.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.');
     }
     var authPathPrefix = appConfig.authPathPrefix || '/auth';
     appConfig.distribution = (_a = appConfig.distribution) !== null && _a !== void 0 ? _a : types_1.AppDistribution.AppStore;

package/build/ts/server/shopify-app.js.map

@@ -1 +1 @@
-{"version":3,"file":"shopify-app.js","sourceRoot":"","sources":["../../../src/server/shopify-app.ts"],"names":[],"mappings":";;;;AAAA,iDAA+C;AAC/C,oDAQ8B;AAI9B,iCASiB;AACjB,qCAAwD;AACxD,oDAAgE;AAChE,kEAA+D;AAC/D,qEAAgF;AAChF,qDAAiD;AACjD,kDAAyE;AACzE,oDAAwD;AACxD,iDAA2E;AAC3E,gDAAgE;AAEhE;;;;;;;;;;;;;;;;;;;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,kCAAyB,EAAY,MAAM,CAAC;YACpD,OAAO,EAAE,IAAA,yCAA0B,EAGjC,MAAM,CAAC;SACV;QACD,eAAe,EAAE;YACf,KAAK,EAAE,IAAA,0CAAkC,EAAC,MAAM,CAAC;SAClD;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;AA5CD,gCA4CC;AAED,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"}
+{"version":3,"file":"shopify-app.js","sourceRoot":"","sources":["../../../src/server/shopify-app.ts"],"names":[],"mappings":";;;;AAAA,iDAA+C;AAC/C,oDAQ8B;AAI9B,iCASiB;AACjB,qCAAwD;AACxD,oDAAgE;AAChE,kEAA+D;AAC/D,qEAAgF;AAChF,qDAAiD;AACjD,kDAAyE;AACzE,oDAAwD;AACxD,iDAA2E;AAC3E,gDAAgE;AAChE,2DAAqF;AAErF;;;;;;;;;;;;;;;;;;;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,kCAAyB,EAAY,MAAM,CAAC;YACpD,OAAO,EAAE,IAAA,yCAA0B,EAGjC,MAAM,CAAC;SACV;QACD,eAAe,EAAE;YACf,KAAK,EAAE,IAAA,0CAAkC,EAAC,MAAM,CAAC;YACjD,UAAU,EAAE,IAAA,oDAAuC,EAAC,MAAM,CAAC;SAC5D;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;AA7CD,gCA6CC;AAED,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,qJAAqJ,CACtJ,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"}