@shopify/shopify-app-remix 1.2.1 → 1.3.0

package/build/ts/server/authenticate/admin/types.d.ts

@@ -1,6 +1,7 @@
 import { JwtPayload, Session, ShopifyRestResources } from '@shopify/shopify-api';
 import { EnsureCORSFunction } from '../helpers/ensure-cors-headers';
-import type { AdminApiContext, AppConfigArg } from '../../config-types';
+import type { AppConfigArg } from '../../config-types';
+import type { AdminApiContext } from '../../clients';
 import type { BillingContext } from './billing/types';
 import { RedirectFunction } from './helpers/redirect';
 interface AdminContextInternal<Config extends AppConfigArg, Resources extends ShopifyRestResources = ShopifyRestResources> {
@@ -9,27 +10,39 @@ interface AdminContextInternal<Config extends AppConfigArg, Resources extends Sh
      *
      * This comes from the session storage which `shopifyApp` uses to store sessions in your database of choice.
      *
-     * Use this to get shop or user specific data.
+     * Use this to get shop or user-specific data.
      *
      * @example
-     * Getting your app's shop specific widget data using an offline session
+     * <caption>Using offline sessions.</caption>
+     * <description>Get your app's shop-specific data using an offline session.</description>
      * ```ts
-     * // app/routes/**\/.ts
+     * // shopify.server.ts
+     * import { shopifyApp } from "@shopify/shopify-app-remix/server";
+     *
+     * const shopify = shopifyApp({
+     *   // ...etc
+     * });
+     * export default shopify;
+     * export const authenticate = shopify.authenticate;
+     * ```
+     * ```ts
+     * // /app/routes/**\/*.ts
      * import { LoaderArgs, json } from "@remix-run/node";
      * import { authenticate } from "../shopify.server";
-     * import { getWidgets } from "~/db/widgets.server";
+     * import { getMyAppData } from "~/db/model.server";
      *
      * export const loader = async ({ request }: LoaderArgs) => {
      *   const { session } = await authenticate.admin(request);
-     *   return json(await getWidgets({shop: session.shop));
+     *   return json(await getMyAppData({shop: session.shop));
      * };
      * ```
      *
      * @example
-     * Getting your app's user specific widget data using an online session
+     * <caption>Using online sessions.</caption>
+     * <description>Get your app's user-specific data using an online session.</description>
      * ```ts
      * // shopify.server.ts
-     * import { shopifyApp } from "@shopify/shopify-app-remix";
+     * import { shopifyApp } from "@shopify/shopify-app-remix/server";
      *
      * const shopify = shopifyApp({
      *   // ...etc
@@ -37,21 +50,22 @@ interface AdminContextInternal<Config extends AppConfigArg, Resources extends Sh
      * });
      * export default shopify;
      * export const authenticate = shopify.authenticate;
-     *
-     * // app/routes/**\/.ts
+     * ```
+     * ```ts
+     * // /app/routes/**\/*.ts
      * import { LoaderArgs, json } from "@remix-run/node";
      * import { authenticate } from "../shopify.server";
-     * import { getWidgets } from "~/db/widgets.server";
+     * import { getMyAppData } from "~/db/model.server";
      *
      * export const loader = async ({ request }: LoaderArgs) => {
      *   const { session } = await authenticate.admin(request);
-     *   return json(await getWidgets({user: session.onlineAccessInfo!.id}));
+     *   return json(await getMyAppData({user: session.onlineAccessInfo!.id}));
      * };
      * ```
      */
     session: Session;
     /**
-     * Methods for interacting with the Shopify GraphQL / REST Admin APIs for the store that made the request
+     * Methods for interacting with the GraphQL / REST Admin APIs for the store that made the request.
      */
     admin: AdminApiContext<Resources>;
     /**
@@ -61,19 +75,20 @@ interface AdminContextInternal<Config extends AppConfigArg, Resources extends Sh
      */
     billing: BillingContext<Config>;
     /**
-     * A function that ensures the CORS headers are set correctly for the response
+     * A function that ensures the CORS headers are set correctly for the response.
      *
      * @example
-     * Setting CORS headers for a admin request
+     * <caption>Setting CORS headers for a admin request.</caption>
+     * <description>Use the `cors` helper to ensure your app can respond to requests from admin extensions.</description>
      * ```ts
-     * // app/routes/admin/widgets.ts
+     * // /app/routes/admin/my-route.ts
      * import { LoaderArgs, json } from "@remix-run/node";
      * import { authenticate } from "../shopify.server";
-     * import { getWidgets } from "~/db/widgets.server";
+     * import { getMyAppData } from "~/db/model.server";
      *
      * export const loader = async ({ request }: LoaderArgs) => {
      *   const { session, cors } = await authenticate.admin(request);
-     *   return cors(json(await getWidgets({user: session.onlineAccessInfo!.id})));
+     *   return cors(json(await getMyAppData({user: session.onlineAccessInfo!.id})));
      * };
      * ```
      */
@@ -81,15 +96,18 @@ interface AdminContextInternal<Config extends AppConfigArg, Resources extends Sh
 }
 export interface EmbeddedAdminContext<Config extends AppConfigArg, Resources extends ShopifyRestResources = ShopifyRestResources> extends AdminContextInternal<Config, Resources> {
     /**
-     * The decoded and validated session token for the request
+     * The decoded and validated session token for the request.
+     *
+     * Returned only if `isEmbeddedApp` is `true`.
      *
      * {@link https://shopify.dev/docs/apps/auth/oauth/session-tokens#payload}
      *
      * @example
-     * Getting your app's user specific widget data using the session token
+     * <caption>Using the decoded session token.</caption>
+     * <description>Get user-specific data using the `sessionToken` object.</description>
      * ```ts
      * // shopify.server.ts
-     * import { shopifyApp } from "@shopify/shopify-app-remix";
+     * import { shopifyApp } from "@shopify/shopify-app-remix/server";
      *
      * const shopify = shopifyApp({
      *   // ...etc
@@ -97,43 +115,61 @@ export interface EmbeddedAdminContext<Config extends AppConfigArg, Resources ext
      * });
      * export default shopify;
      * export const authenticate = shopify.authenticate;
-     *
-     * // app/routes/**\/.ts
+     * ```
+     * ```ts
+     * // /app/routes/**\/*.ts
      * import { LoaderArgs, json } from "@remix-run/node";
      * import { authenticate } from "../shopify.server";
-     * import { getWidgets } from "~/db/widgets.server";
+     * import { getMyAppData } from "~/db/model.server";
      *
      * export const loader = async ({ request }: LoaderArgs) => {
-     *   const { sessionToken } = await authenticate.public(
+     *   const { sessionToken } = await authenticate.public.checkout(
      *     request
      *   );
-     *   return json(await getWidgets({user: sessionToken.sub}));
+     *   return json(await getMyAppData({user: sessionToken.sub}));
      * };
      * ```
      */
     sessionToken: JwtPayload;
     /**
      * A function that redirects the user to a new page, ensuring that the appropriate parameters are set for embedded
-     * apps
+     * apps.
+     *
+     * Returned only if `isEmbeddedApp` is `true`.
      *
      * @example
-     * Redirecting the user to the app's home page
+     * <caption>Redirecting to an app route.</caption>
+     * <description>Use the `redirect` helper to safely redirect between pages.</description>
      * ```ts
-     * // app/routes/admin/widgets.ts
+     * // /app/routes/admin/my-route.ts
      * import { LoaderArgs, json } from "@remix-run/node";
      * import { authenticate } from "../shopify.server";
-     * import { getWidgets } from "~/db/widgets.server";
      *
      * export const loader = async ({ request }: LoaderArgs) => {
      *   const { session, redirect } = await authenticate.admin(request);
      *   return redirect("/");
      * };
      * ```
+     *
+     * @example
+     * <caption>Redirecting outside of Shopify admin.</caption>
+     * <description>Pass in a `target` option of `_top` or `_parent` to go to an external URL.</description>
+     * ```ts
+     * // /app/routes/admin/my-route.ts
+     * import { LoaderArgs, json } from "@remix-run/node";
+     * import { authenticate } from "../shopify.server";
+     *
+     * export const loader = async ({ request }: LoaderArgs) => {
+     *   const { session, redirect } = await authenticate.admin(request);
+     *   return redirect("/", { target: '_parent' });
+     * };
+     * ```
      */
     redirect: RedirectFunction;
 }
 export interface NonEmbeddedAdminContext<Config extends AppConfigArg, Resources extends ShopifyRestResources = ShopifyRestResources> extends AdminContextInternal<Config, Resources> {
 }
 export type AdminContext<Config extends AppConfigArg, Resources extends ShopifyRestResources = ShopifyRestResources> = Config['isEmbeddedApp'] extends false ? NonEmbeddedAdminContext<Config, Resources> : EmbeddedAdminContext<Config, Resources>;
+export type AuthenticateAdmin<Config extends AppConfigArg, Resources extends ShopifyRestResources = ShopifyRestResources> = (request: Request) => Promise<AdminContext<Config, Resources>>;
 export {};
 //# sourceMappingURL=types.d.ts.map

package/build/ts/server/authenticate/admin/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../../src/server/authenticate/admin/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,UAAU,EAAE,OAAO,EAAE,oBAAoB,EAAC,MAAM,sBAAsB,CAAC;AAE/E,OAAO,EAAC,kBAAkB,EAAC,MAAM,gCAAgC,CAAC;AAClE,OAAO,KAAK,EAAC,eAAe,EAAE,YAAY,EAAC,MAAM,oBAAoB,CAAC;AAEtE,OAAO,KAAK,EAAC,cAAc,EAAC,MAAM,iBAAiB,CAAC;AACpD,OAAO,EAAC,gBAAgB,EAAC,MAAM,oBAAoB,CAAC;AAEpD,UAAU,oBAAoB,CAC5B,MAAM,SAAS,YAAY,EAC3B,SAAS,SAAS,oBAAoB,GAAG,oBAAoB;IAE7D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4CG;IACH,OAAO,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,KAAK,EAAE,eAAe,CAAC,SAAS,CAAC,CAAC;IAElC;;;;OAIG;IACH,OAAO,EAAE,cAAc,CAAC,MAAM,CAAC,CAAC;IAEhC;;;;;;;;;;;;;;;;OAgBG;IACH,IAAI,EAAE,kBAAkB,CAAC;CAC1B;AAED,MAAM,WAAW,oBAAoB,CACnC,MAAM,SAAS,YAAY,EAC3B,SAAS,SAAS,oBAAoB,GAAG,oBAAoB,CAC7D,SAAQ,oBAAoB,CAAC,MAAM,EAAE,SAAS,CAAC;IAC/C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACH,YAAY,EAAE,UAAU,CAAC;IAEzB;;;;;;;;;;;;;;;;;OAiBG;IACH,QAAQ,EAAE,gBAAgB,CAAC;CAC5B;AACD,MAAM,WAAW,uBAAuB,CACtC,MAAM,SAAS,YAAY,EAC3B,SAAS,SAAS,oBAAoB,GAAG,oBAAoB,CAC7D,SAAQ,oBAAoB,CAAC,MAAM,EAAE,SAAS,CAAC;CAAG;AAEpD,MAAM,MAAM,YAAY,CACtB,MAAM,SAAS,YAAY,EAC3B,SAAS,SAAS,oBAAoB,GAAG,oBAAoB,IAC3D,MAAM,CAAC,eAAe,CAAC,SAAS,KAAK,GACrC,uBAAuB,CAAC,MAAM,EAAE,SAAS,CAAC,GAC1C,oBAAoB,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../../src/server/authenticate/admin/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,UAAU,EAAE,OAAO,EAAE,oBAAoB,EAAC,MAAM,sBAAsB,CAAC;AAE/E,OAAO,EAAC,kBAAkB,EAAC,MAAM,gCAAgC,CAAC;AAClE,OAAO,KAAK,EAAC,YAAY,EAAC,MAAM,oBAAoB,CAAC;AACrD,OAAO,KAAK,EAAC,eAAe,EAAC,MAAM,eAAe,CAAC;AAEnD,OAAO,KAAK,EAAC,cAAc,EAAC,MAAM,iBAAiB,CAAC;AACpD,OAAO,EAAC,gBAAgB,EAAC,MAAM,oBAAoB,CAAC;AAEpD,UAAU,oBAAoB,CAC5B,MAAM,SAAS,YAAY,EAC3B,SAAS,SAAS,oBAAoB,GAAG,oBAAoB;IAE7D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAyDG;IACH,OAAO,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,KAAK,EAAE,eAAe,CAAC,SAAS,CAAC,CAAC;IAElC;;;;OAIG;IACH,OAAO,EAAE,cAAc,CAAC,MAAM,CAAC,CAAC;IAEhC;;;;;;;;;;;;;;;;;OAiBG;IACH,IAAI,EAAE,kBAAkB,CAAC;CAC1B;AAED,MAAM,WAAW,oBAAoB,CACnC,MAAM,SAAS,YAAY,EAC3B,SAAS,SAAS,oBAAoB,GAAG,oBAAoB,CAC7D,SAAQ,oBAAoB,CAAC,MAAM,EAAE,SAAS,CAAC;IAC/C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACH,YAAY,EAAE,UAAU,CAAC;IAEzB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;IACH,QAAQ,EAAE,gBAAgB,CAAC;CAC5B;AACD,MAAM,WAAW,uBAAuB,CACtC,MAAM,SAAS,YAAY,EAC3B,SAAS,SAAS,oBAAoB,GAAG,oBAAoB,CAC7D,SAAQ,oBAAoB,CAAC,MAAM,EAAE,SAAS,CAAC;CAAG;AAEpD,MAAM,MAAM,YAAY,CACtB,MAAM,SAAS,YAAY,EAC3B,SAAS,SAAS,oBAAoB,GAAG,oBAAoB,IAC3D,MAAM,CAAC,eAAe,CAAC,SAAS,KAAK,GACrC,uBAAuB,CAAC,MAAM,EAAE,SAAS,CAAC,GAC1C,oBAAoB,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;AAE5C,MAAM,MAAM,iBAAiB,CAC3B,MAAM,SAAS,YAAY,EAC3B,SAAS,SAAS,oBAAoB,GAAG,oBAAoB,IAC3D,CAAC,OAAO,EAAE,OAAO,KAAK,OAAO,CAAC,YAAY,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC,CAAC"}

package/build/ts/server/authenticate/helpers/add-response-headers.d.ts

@@ -1,4 +1,5 @@
 import type { BasicParams } from '../../types';
-export declare function addDocumentResponseHeadersFactory(params: BasicParams): (request: Request, headers: Headers) => void;
+export type AddDocumentResponseHeadersFunction = (request: Request, headers: Headers) => void;
+export declare function addDocumentResponseHeadersFactory(params: BasicParams): AddDocumentResponseHeadersFunction;
 export declare function addDocumentResponseHeaders(headers: Headers, isEmbeddedApp: boolean, shop: string | null | undefined): void;
 //# sourceMappingURL=add-response-headers.d.ts.map

package/build/ts/server/authenticate/helpers/add-response-headers.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"add-response-headers.d.ts","sourceRoot":"","sources":["../../../../../src/server/authenticate/helpers/add-response-headers.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,WAAW,EAAC,MAAM,aAAa,CAAC;AAE7C,wBAAgB,iCAAiC,CAAC,MAAM,EAAE,WAAW,aAGzC,OAAO,WAAW,OAAO,UAMpD;AAED,wBAAgB,0BAA0B,CACxC,OAAO,EAAE,OAAO,EAChB,aAAa,EAAE,OAAO,EACtB,IAAI,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,QAmBhC"}
+{"version":3,"file":"add-response-headers.d.ts","sourceRoot":"","sources":["../../../../../src/server/authenticate/helpers/add-response-headers.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,WAAW,EAAC,MAAM,aAAa,CAAC;AAE7C,MAAM,MAAM,kCAAkC,GAAG,CAC/C,OAAO,EAAE,OAAO,EAChB,OAAO,EAAE,OAAO,KACb,IAAI,CAAC;AAEV,wBAAgB,iCAAiC,CAC/C,MAAM,EAAE,WAAW,GAClB,kCAAkC,CASpC;AAED,wBAAgB,0BAA0B,CACxC,OAAO,EAAE,OAAO,EAChB,aAAa,EAAE,OAAO,EACtB,IAAI,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,QAmBhC"}

package/build/ts/server/authenticate/helpers/add-response-headers.js.map

@@ -1 +1 @@
-{"version":3,"file":"add-response-headers.js","sourceRoot":"","sources":["../../../../../src/server/authenticate/helpers/add-response-headers.ts"],"names":[],"mappings":";;;AAEA,SAAgB,iCAAiC,CAAC,MAAmB;IAC5D,IAAA,GAAG,GAAY,MAAM,IAAlB,EAAE,MAAM,GAAI,MAAM,OAAV,CAAW;IAE7B,OAAO,UAAU,OAAgB,EAAE,OAAgB;QAC1C,IAAA,YAAY,GAAI,IAAI,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,aAAxB,CAAyB;QAC5C,IAAM,IAAI,GAAG,GAAG,CAAC,KAAK,CAAC,YAAY,CAAC,YAAY,CAAC,GAAG,CAAC,MAAM,CAAE,CAAC,CAAC;QAE/D,0BAA0B,CAAC,OAAO,EAAE,MAAM,CAAC,aAAa,EAAE,IAAI,CAAC,CAAC;IAClE,CAAC,CAAC;AACJ,CAAC;AATD,8EASC;AAED,SAAgB,0BAA0B,CACxC,OAAgB,EAChB,aAAsB,EACtB,IAA+B;IAE/B,IAAI,IAAI,EAAE;QACR,OAAO,CAAC,GAAG,CACT,MAAM,EACN,mFAAmF,CACpF,CAAC;KACH;IAED,IAAI,aAAa,EAAE;QACjB,IAAI,IAAI,EAAE;YACR,OAAO,CAAC,GAAG,CACT,yBAAyB,EACzB,kCAA2B,IAAI,mDAAgD,CAChF,CAAC;SACH;KACF;SAAM;QACL,OAAO,CAAC,GAAG,CAAC,yBAAyB,EAAE,yBAAyB,CAAC,CAAC;KACnE;AACH,CAAC;AAtBD,gEAsBC"}
+{"version":3,"file":"add-response-headers.js","sourceRoot":"","sources":["../../../../../src/server/authenticate/helpers/add-response-headers.ts"],"names":[],"mappings":";;;AAOA,SAAgB,iCAAiC,CAC/C,MAAmB;IAEZ,IAAA,GAAG,GAAY,MAAM,IAAlB,EAAE,MAAM,GAAI,MAAM,OAAV,CAAW;IAE7B,OAAO,UAAU,OAAgB,EAAE,OAAgB;QAC1C,IAAA,YAAY,GAAI,IAAI,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,aAAxB,CAAyB;QAC5C,IAAM,IAAI,GAAG,GAAG,CAAC,KAAK,CAAC,YAAY,CAAC,YAAY,CAAC,GAAG,CAAC,MAAM,CAAE,CAAC,CAAC;QAE/D,0BAA0B,CAAC,OAAO,EAAE,MAAM,CAAC,aAAa,EAAE,IAAI,CAAC,CAAC;IAClE,CAAC,CAAC;AACJ,CAAC;AAXD,8EAWC;AAED,SAAgB,0BAA0B,CACxC,OAAgB,EAChB,aAAsB,EACtB,IAA+B;IAE/B,IAAI,IAAI,EAAE;QACR,OAAO,CAAC,GAAG,CACT,MAAM,EACN,mFAAmF,CACpF,CAAC;KACH;IAED,IAAI,aAAa,EAAE;QACjB,IAAI,IAAI,EAAE;YACR,OAAO,CAAC,GAAG,CACT,yBAAyB,EACzB,kCAA2B,IAAI,mDAAgD,CAChF,CAAC;SACH;KACF;SAAM;QACL,OAAO,CAAC,GAAG,CAAC,yBAAyB,EAAE,yBAAyB,CAAC,CAAC;KACnE;AACH,CAAC;AAtBD,gEAsBC"}

package/build/ts/server/authenticate/public/appProxy/authenticate.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"authenticate.d.ts","sourceRoot":"","sources":["../../../../../../src/server/authenticate/public/appProxy/authenticate.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,oBAAoB,EAAC,MAAM,sBAAsB,CAAC;AAG1D,OAAO,EAAC,WAAW,EAAC,MAAM,gBAAgB,CAAC;AAE3C,OAAO,EAGL,oBAAoB,EAErB,MAAM,SAAS,CAAC;AAEjB,wBAAgB,2BAA2B,CACzC,SAAS,SAAS,oBAAoB,EACtC,MAAM,EAAE,WAAW,GAAG,oBAAoB,CAmD3C"}
+{"version":3,"file":"authenticate.d.ts","sourceRoot":"","sources":["../../../../../../src/server/authenticate/public/appProxy/authenticate.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,oBAAoB,EAAC,MAAM,sBAAsB,CAAC;AAG1D,OAAO,EAAC,WAAW,EAAC,MAAM,gBAAgB,CAAC;AAE3C,OAAO,EAGL,oBAAoB,EAErB,MAAM,SAAS,CAAC;AAEjB,wBAAgB,2BAA2B,CACzC,SAAS,SAAS,oBAAoB,EACtC,MAAM,EAAE,WAAW,GAAG,oBAAoB,CAqD3C"}

package/build/ts/server/authenticate/public/appProxy/authenticate.js

@@ -2,7 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.authenticateAppProxyFactory = void 0;
 var tslib_1 = require("tslib");
-var admin_1 = require("../../../clients/admin");
+var clients_1 = require("../../../clients");
 function authenticateAppProxyFactory(params) {
     var api = params.api, config = params.config, logger = params.logger;
     return function authenticate(request) {
@@ -46,13 +46,15 @@ function authenticateAppProxyFactory(params) {
                                 liquid: liquid,
                                 session: undefined,
                                 admin: undefined,
+                                storefront: undefined,
                             };
                             return [2 /*return*/, context_1];
                         }
                         context = {
                             liquid: liquid,
                             session: session,
-                            admin: (0, admin_1.adminClientFactory)({ params: params, session: session }),
+                            admin: (0, clients_1.adminClientFactory)({ params: params, session: session }),
+                            storefront: (0, clients_1.storefrontClientFactory)({ params: params, session: session }),
                         };
                         return [2 /*return*/, context];
                 }

package/build/ts/server/authenticate/public/appProxy/authenticate.js.map

@@ -1 +1 @@
-{"version":3,"file":"authenticate.js","sourceRoot":"","sources":["../../../../../../src/server/authenticate/public/appProxy/authenticate.ts"],"names":[],"mappings":";;;;AAEA,gDAA0D;AAU1D,SAAgB,2BAA2B,CAEzC,MAAmB;IACZ,IAAA,GAAG,GAAoB,MAAM,IAA1B,EAAE,MAAM,GAAY,MAAM,OAAlB,EAAE,MAAM,GAAI,MAAM,OAAV,CAAW;IAErC,OAAO,SAAe,YAAY,CAChC,OAAO;;;;;;wBAEP,MAAM,CAAC,IAAI,CAAC,kCAAkC,CAAC,CAAC;wBAEzC,YAAY,GAAI,IAAI,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,aAAxB,CAAyB;wBACtC,KAAK,GAAG,MAAM,CAAC,WAAW,CAAC,YAAY,CAAC,OAAO,EAAE,CAAC,CAAC;wBACrD,OAAO,GAAG,KAAK,CAAC;;;;wBAGR,qBAAM,GAAG,CAAC,KAAK,CAAC,YAAY,CAAC,KAAK,EAAE;gCAC5C,QAAQ,EAAE,UAAU;6BACrB,CAAC,EAAA;;wBAFF,OAAO,GAAG,SAER,CAAC;;;;wBAEH,MAAM,CAAC,IAAI,CAAC,OAAK,CAAC,OAAO,CAAC,CAAC;wBAC3B,MAAM,IAAI,QAAQ,CAAC,SAAS,EAAE,EAAC,MAAM,EAAE,GAAG,EAAE,UAAU,EAAE,aAAa,EAAC,CAAC,CAAC;;wBAG1E,IAAI,CAAC,OAAO,EAAE;4BACZ,MAAM,CAAC,IAAI,CAAC,yCAAyC,CAAC,CAAC;4BACvD,MAAM,IAAI,QAAQ,CAAC,SAAS,EAAE;gCAC5B,MAAM,EAAE,GAAG;gCACX,UAAU,EAAE,aAAa;6BAC1B,CAAC,CAAC;yBACJ;wBAEK,IAAI,GAAG,YAAY,CAAC,GAAG,CAAC,MAAM,CAAE,CAAC;wBACjC,SAAS,GAAG,GAAG,CAAC,OAAO,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;wBACjC,qBAAM,MAAM,CAAC,cAAc,CAAC,WAAW,CAAC,SAAS,CAAC,EAAA;;wBAA5D,OAAO,GAAG,SAAkD;wBAElE,IAAI,CAAC,OAAO,EAAE;4BACN,YAA2B;gCAC/B,MAAM,QAAA;gCACN,OAAO,EAAE,SAAS;gCAClB,KAAK,EAAE,SAAS;6BACjB,CAAC;4BAEF,sBAAO,SAAO,EAAC;yBAChB;wBAEK,OAAO,GAA0C;4BACrD,MAAM,QAAA;4BACN,OAAO,SAAA;4BACP,KAAK,EAAE,IAAA,0BAAkB,EAAC,EAAC,MAAM,QAAA,EAAE,OAAO,SAAA,EAAC,CAAC;yBAC7C,CAAC;wBAEF,sBAAO,OAAO,EAAC;;;;KAChB,CAAC;AACJ,CAAC;AArDD,kEAqDC;AAED,IAAM,MAAM,GAA2B,UAAC,IAAI,EAAE,cAAc;IAC1D,IAAI,OAAO,cAAc,KAAK,QAAQ,EAAE;QACtC,OAAO,IAAI,QAAQ,CAAC,IAAI,EAAE;YACxB,MAAM,EAAE,cAAc,IAAI,GAAG;YAC7B,OAAO,EAAE;gBACP,cAAc,EAAE,oBAAoB;aACrC;SACF,CAAC,CAAC;KACJ;IAED,IAAM,KAA4B,cAAc,IAAI,EAAE,EAA/C,MAAM,YAAA,EAAK,YAAY,sBAAxB,UAAyB,CAAuB,CAAC;IACvD,IAAM,YAAY,GAAG,MAAM,KAAK,KAAK,CAAC,CAAC,CAAC,4BAAqB,IAAI,CAAE,CAAC,CAAC,CAAC,IAAI,CAAC;IAE3E,IAAM,OAAO,GAAG,IAAI,OAAO,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;IAClD,OAAO,CAAC,GAAG,CAAC,cAAc,EAAE,oBAAoB,CAAC,CAAC;IAElD,OAAO,IAAI,QAAQ,CAAC,YAAY,wCAC3B,YAAY,KACf,OAAO,SAAA,IACP,CAAC;AACL,CAAC,CAAC"}
+{"version":3,"file":"authenticate.js","sourceRoot":"","sources":["../../../../../../src/server/authenticate/public/appProxy/authenticate.ts"],"names":[],"mappings":";;;;AAEA,4CAA6E;AAU7E,SAAgB,2BAA2B,CAEzC,MAAmB;IACZ,IAAA,GAAG,GAAoB,MAAM,IAA1B,EAAE,MAAM,GAAY,MAAM,OAAlB,EAAE,MAAM,GAAI,MAAM,OAAV,CAAW;IAErC,OAAO,SAAe,YAAY,CAChC,OAAO;;;;;;wBAEP,MAAM,CAAC,IAAI,CAAC,kCAAkC,CAAC,CAAC;wBAEzC,YAAY,GAAI,IAAI,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,aAAxB,CAAyB;wBACtC,KAAK,GAAG,MAAM,CAAC,WAAW,CAAC,YAAY,CAAC,OAAO,EAAE,CAAC,CAAC;wBACrD,OAAO,GAAG,KAAK,CAAC;;;;wBAGR,qBAAM,GAAG,CAAC,KAAK,CAAC,YAAY,CAAC,KAAK,EAAE;gCAC5C,QAAQ,EAAE,UAAU;6BACrB,CAAC,EAAA;;wBAFF,OAAO,GAAG,SAER,CAAC;;;;wBAEH,MAAM,CAAC,IAAI,CAAC,OAAK,CAAC,OAAO,CAAC,CAAC;wBAC3B,MAAM,IAAI,QAAQ,CAAC,SAAS,EAAE,EAAC,MAAM,EAAE,GAAG,EAAE,UAAU,EAAE,aAAa,EAAC,CAAC,CAAC;;wBAG1E,IAAI,CAAC,OAAO,EAAE;4BACZ,MAAM,CAAC,IAAI,CAAC,yCAAyC,CAAC,CAAC;4BACvD,MAAM,IAAI,QAAQ,CAAC,SAAS,EAAE;gCAC5B,MAAM,EAAE,GAAG;gCACX,UAAU,EAAE,aAAa;6BAC1B,CAAC,CAAC;yBACJ;wBAEK,IAAI,GAAG,YAAY,CAAC,GAAG,CAAC,MAAM,CAAE,CAAC;wBACjC,SAAS,GAAG,GAAG,CAAC,OAAO,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;wBACjC,qBAAM,MAAM,CAAC,cAAc,CAAC,WAAW,CAAC,SAAS,CAAC,EAAA;;wBAA5D,OAAO,GAAG,SAAkD;wBAElE,IAAI,CAAC,OAAO,EAAE;4BACN,YAA2B;gCAC/B,MAAM,QAAA;gCACN,OAAO,EAAE,SAAS;gCAClB,KAAK,EAAE,SAAS;gCAChB,UAAU,EAAE,SAAS;6BACtB,CAAC;4BAEF,sBAAO,SAAO,EAAC;yBAChB;wBAEK,OAAO,GAA0C;4BACrD,MAAM,QAAA;4BACN,OAAO,SAAA;4BACP,KAAK,EAAE,IAAA,4BAAkB,EAAC,EAAC,MAAM,QAAA,EAAE,OAAO,SAAA,EAAC,CAAC;4BAC5C,UAAU,EAAE,IAAA,iCAAuB,EAAC,EAAC,MAAM,QAAA,EAAE,OAAO,SAAA,EAAC,CAAC;yBACvD,CAAC;wBAEF,sBAAO,OAAO,EAAC;;;;KAChB,CAAC;AACJ,CAAC;AAvDD,kEAuDC;AAED,IAAM,MAAM,GAA2B,UAAC,IAAI,EAAE,cAAc;IAC1D,IAAI,OAAO,cAAc,KAAK,QAAQ,EAAE;QACtC,OAAO,IAAI,QAAQ,CAAC,IAAI,EAAE;YACxB,MAAM,EAAE,cAAc,IAAI,GAAG;YAC7B,OAAO,EAAE;gBACP,cAAc,EAAE,oBAAoB;aACrC;SACF,CAAC,CAAC;KACJ;IAED,IAAM,KAA4B,cAAc,IAAI,EAAE,EAA/C,MAAM,YAAA,EAAK,YAAY,sBAAxB,UAAyB,CAAuB,CAAC;IACvD,IAAM,YAAY,GAAG,MAAM,KAAK,KAAK,CAAC,CAAC,CAAC,4BAAqB,IAAI,CAAE,CAAC,CAAC,CAAC,IAAI,CAAC;IAE3E,IAAM,OAAO,GAAG,IAAI,OAAO,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;IAClD,OAAO,CAAC,GAAG,CAAC,cAAc,EAAE,oBAAoB,CAAC,CAAC;IAElD,OAAO,IAAI,QAAQ,CAAC,YAAY,wCAC3B,YAAY,KACf,OAAO,SAAA,IACP,CAAC;AACL,CAAC,CAAC"}

package/build/ts/server/authenticate/public/appProxy/authenticate.public.app-proxy.doc.d.ts

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

package/build/ts/server/authenticate/public/appProxy/authenticate.public.app-proxy.doc.d.ts.map

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

package/build/ts/server/authenticate/public/appProxy/authenticate.public.app-proxy.doc.js

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+var data = {
+    name: 'App proxy',
+    description: 'The `authenticate.public.appProxy` function validates app proxy requests made by Shopify, and returns a context to enable querying Shopify APIs.',
+    category: 'Authenticate',
+    subCategory: 'Public',
+    type: 'object',
+    isVisualComponent: false,
+    definitions: [
+        {
+            title: 'authenticate.public.appProxy',
+            description: 'Authenticates requests coming from Shopify app proxies.',
+            type: 'AuthenticateAppProxy',
+        },
+    ],
+    jsDocTypeExamples: ['AppProxyContextWithSession'],
+    related: [
+        {
+            name: 'Admin API context',
+            subtitle: 'Interact with the Admin API.',
+            url: '/docs/api/shopify-app-remix/apis/admin-api',
+        },
+        {
+            name: 'Storefront API context',
+            subtitle: 'Interact with the Storefront API.',
+            url: '/docs/api/shopify-app-remix/apis/storefront-api',
+        },
+    ],
+};
+exports.default = data;
+//# sourceMappingURL=authenticate.public.app-proxy.doc.js.map

package/build/ts/server/authenticate/public/appProxy/authenticate.public.app-proxy.doc.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"authenticate.public.app-proxy.doc.js","sourceRoot":"","sources":["../../../../../../src/server/authenticate/public/appProxy/authenticate.public.app-proxy.doc.ts"],"names":[],"mappings":";;AAEA,IAAM,IAAI,GAAkC;IAC1C,IAAI,EAAE,WAAW;IACjB,WAAW,EACT,kJAAkJ;IACpJ,QAAQ,EAAE,cAAc;IACxB,WAAW,EAAE,QAAQ;IACrB,IAAI,EAAE,QAAQ;IACd,iBAAiB,EAAE,KAAK;IACxB,WAAW,EAAE;QACX;YACE,KAAK,EAAE,8BAA8B;YACrC,WAAW,EAAE,yDAAyD;YACtE,IAAI,EAAE,sBAAsB;SAC7B;KACF;IACD,iBAAiB,EAAE,CAAC,4BAA4B,CAAC;IACjD,OAAO,EAAE;QACP;YACE,IAAI,EAAE,mBAAmB;YACzB,QAAQ,EAAE,8BAA8B;YACxC,GAAG,EAAE,4CAA4C;SAClD;QACD;YACE,IAAI,EAAE,wBAAwB;YAC9B,QAAQ,EAAE,mCAAmC;YAC7C,GAAG,EAAE,iDAAiD;SACvD;KACF;CACF,CAAC;AAEF,kBAAe,IAAI,CAAC"}

package/build/ts/server/authenticate/public/appProxy/types.d.ts

@@ -1,5 +1,5 @@
 import { Session, ShopifyRestResources } from '@shopify/shopify-api';
-import { AdminApiContext } from '../../../config-types';
+import { AdminApiContext, StorefrontContext } from '../../../clients';
 export type AuthenticateAppProxy = (request: Request) => Promise<AppProxyContext | AppProxyContextWithSession>;
 interface Options {
     layout?: boolean;
@@ -10,7 +10,8 @@ interface Context {
      * A utility for creating a Liquid Response.
      *
      * @example
-     * <caption>Returning a Liquid Response from an app proxy route</caption>
+     * <caption>Rendering liquid content.</caption>
+     * <description>Use the `liquid` helper to render a `Response` with Liquid content.</description>
      * ```ts
      * // app/routes/**\/.ts
      * import {authenticate} from "~/shopify.server"
@@ -34,9 +35,14 @@ export interface AppProxyContext extends Context {
     session: undefined;
     /**
      * No session is available for the shop that made this request.
-     * Therefore no methods for interacting with the Shopify GraphQL / REST Admin APIs are available.
+     * Therefore no methods for interacting with the GraphQL / REST Admin APIs are available.
      */
     admin: undefined;
+    /**
+     * No session is available for the shop that made this request.
+     * Therefore no method for interacting with the Storefront API is available.
+     */
+    storefront: undefined;
 }
 export interface AppProxyContextWithSession<Resources extends ShopifyRestResources = ShopifyRestResources> extends Context {
     /**
@@ -44,27 +50,77 @@ export interface AppProxyContextWithSession<Resources extends ShopifyRestResourc
      *
      * This comes from the session storage which `shopifyApp` uses to store sessions in your database of choice.
      *
-     * Use this to get shop or user specific data.
+     * Use this to get shop or user-specific data.
      *
      * @example
-     * <caption>Getting your app's shop specific widget data using an offline session</caption>
+     * <caption>Using the session object.</caption>
+     * <description>Get your app's data using an offline session for the shop that made the request.</description>
      * ```ts
      * // app/routes/**\/.ts
      * import { json } from "@remix-run/node";
      * import { authenticate } from "../shopify.server";
-     * import { getWidgets } from "~/db/widgets.server";
+     * import { getMyAppModelData } from "~/db/model.server";
      *
      * export const loader = async ({ request }) => {
      *   const { session } = await authenticate.public.appProxy(request);
-     *   return json(await getWidgets({shop: session.shop));
+     *   return json(await getMyAppModelData({shop: session.shop));
      * };
      * ```
      */
     session: Session;
     /**
-     * Methods for interacting with the Shopify GraphQL / REST Admin APIs for the store that made the request
+     * Methods for interacting with the GraphQL / REST Admin APIs for the store that made the request.
+     *
+     * @example
+     * <caption>Interacting with the Admin API.</caption>
+     * <description>Use the `admin` object to interact with the REST or GraphQL APIs.</description>
+     * ```ts
+     * // app/routes/**\/.ts
+     * import { json } from "@remix-run/node";
+     * import { authenticate } from "../shopify.server";
+     *
+     * export async function action({ request }: ActionArgs) {
+     *   const { admin } = await authenticate.public.appProxy(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 });
+     * }
+     * ```
      */
     admin: AdminApiContext<Resources>;
+    /**
+     * Method for interacting with the Shopify Storefront Graphql API for the store that made the request.
+     *
+     * @example
+     * <caption>Interacting with the Storefront API.</caption>
+     * <description>Use the `storefront` object to interact with the GraphQL API.</description>
+     * ```ts
+     * // app/routes/**\/.ts
+     * import { json } from "@remix-run/node";
+     * import { authenticate } from "../shopify.server";
+     *
+     * export async function action({ request }: ActionArgs) {
+     *   const { admin } = await authenticate.public.appProxy(request);
+     *
+     *   const response = await storefront.graphql(`{blogs(first: 10) { edges { node { id } } } }`);
+     *
+     *   return json(await response.json());
+     * }
+     * ```
+     */
+    storefront: StorefrontContext;
 }
 export {};
 //# sourceMappingURL=types.d.ts.map

package/build/ts/server/authenticate/public/appProxy/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../../../src/server/authenticate/public/appProxy/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,OAAO,EAAE,oBAAoB,EAAC,MAAM,sBAAsB,CAAC;AAEnE,OAAO,EAAC,eAAe,EAAC,MAAM,uBAAuB,CAAC;AAEtD,MAAM,MAAM,oBAAoB,GAAG,CACjC,OAAO,EAAE,OAAO,KACb,OAAO,CAAC,eAAe,GAAG,0BAA0B,CAAC,CAAC;AAE3D,UAAU,OAAO;IACf,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,MAAM,sBAAsB,GAAG,CACnC,IAAI,EAAE,MAAM,EACZ,cAAc,CAAC,EAAE,MAAM,GAAG,CAAC,YAAY,GAAG,OAAO,CAAC,KAC/C,QAAQ,CAAC;AAEd,UAAU,OAAO;IACf;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,EAAE,sBAAsB,CAAC;CAChC;AAED,MAAM,WAAW,eAAgB,SAAQ,OAAO;IAC9C;;;;OAIG;IACH,OAAO,EAAE,SAAS,CAAC;IACnB;;;OAGG;IACH,KAAK,EAAE,SAAS,CAAC;CAClB;AAED,MAAM,WAAW,0BAA0B,CACzC,SAAS,SAAS,oBAAoB,GAAG,oBAAoB,CAC7D,SAAQ,OAAO;IACf;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,OAAO,EAAE,OAAO,CAAC;IACjB;;OAEG;IACH,KAAK,EAAE,eAAe,CAAC,SAAS,CAAC,CAAC;CACnC"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../../../src/server/authenticate/public/appProxy/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,OAAO,EAAE,oBAAoB,EAAC,MAAM,sBAAsB,CAAC;AAEnE,OAAO,EAAC,eAAe,EAAE,iBAAiB,EAAC,MAAM,kBAAkB,CAAC;AAEpE,MAAM,MAAM,oBAAoB,GAAG,CACjC,OAAO,EAAE,OAAO,KACb,OAAO,CAAC,eAAe,GAAG,0BAA0B,CAAC,CAAC;AAE3D,UAAU,OAAO;IACf,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,MAAM,sBAAsB,GAAG,CACnC,IAAI,EAAE,MAAM,EACZ,cAAc,CAAC,EAAE,MAAM,GAAG,CAAC,YAAY,GAAG,OAAO,CAAC,KAC/C,QAAQ,CAAC;AAEd,UAAU,OAAO;IACf;;;;;;;;;;;;;;;;;OAiBG;IACH,MAAM,EAAE,sBAAsB,CAAC;CAChC;AAED,MAAM,WAAW,eAAgB,SAAQ,OAAO;IAC9C;;;;OAIG;IACH,OAAO,EAAE,SAAS,CAAC;IAEnB;;;OAGG;IACH,KAAK,EAAE,SAAS,CAAC;IAEjB;;;OAGG;IACH,UAAU,EAAE,SAAS,CAAC;CACvB;AAED,MAAM,WAAW,0BAA0B,CACzC,SAAS,SAAS,oBAAoB,GAAG,oBAAoB,CAC7D,SAAQ,OAAO;IACf;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,OAAO,EAAE,OAAO,CAAC;IAEjB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACH,KAAK,EAAE,eAAe,CAAC,SAAS,CAAC,CAAC;IAElC;;;;;;;;;;;;;;;;;;;OAmBG;IACH,UAAU,EAAE,iBAAiB,CAAC;CAC/B"}

package/build/ts/server/authenticate/public/checkout/authenticate.public.checkout.doc.d.ts

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

package/build/ts/server/authenticate/public/checkout/authenticate.public.checkout.doc.d.ts.map

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

package/build/ts/server/authenticate/public/checkout/authenticate.public.checkout.doc.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+var data = {
+    name: 'Checkout',
+    description: 'The `authenticate.public.checkout` function ensures that checkout extension requests are coming from Shopify, and returns helpers to respond with the correct headers.',
+    category: 'Authenticate',
+    subCategory: 'Public',
+    type: 'object',
+    isVisualComponent: false,
+    definitions: [
+        {
+            title: 'authenticate.public.checkout',
+            description: 'Authenticates requests coming from Shopify checkout extensions.',
+            type: 'AuthenticateCheckout',
+        },
+    ],
+    jsDocTypeExamples: ['CheckoutContext'],
+    related: [],
+};
+exports.default = data;
+//# sourceMappingURL=authenticate.public.checkout.doc.js.map

package/build/ts/server/authenticate/public/checkout/authenticate.public.checkout.doc.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"authenticate.public.checkout.doc.js","sourceRoot":"","sources":["../../../../../../src/server/authenticate/public/checkout/authenticate.public.checkout.doc.ts"],"names":[],"mappings":";;AAEA,IAAM,IAAI,GAAkC;IAC1C,IAAI,EAAE,UAAU;IAChB,WAAW,EACT,wKAAwK;IAC1K,QAAQ,EAAE,cAAc;IACxB,WAAW,EAAE,QAAQ;IACrB,IAAI,EAAE,QAAQ;IACd,iBAAiB,EAAE,KAAK;IACxB,WAAW,EAAE;QACX;YACE,KAAK,EAAE,8BAA8B;YACrC,WAAW,EACT,iEAAiE;YACnE,IAAI,EAAE,sBAAsB;SAC7B;KACF;IACD,iBAAiB,EAAE,CAAC,iBAAiB,CAAC;IACtC,OAAO,EAAE,EAAE;CACZ,CAAC;AAEF,kBAAe,IAAI,CAAC"}

package/build/ts/server/authenticate/public/checkout/types.d.ts

@@ -11,43 +11,45 @@ export interface CheckoutContext {
     /**
      * The decoded and validated session token for the request
      *
-     * The payload of the Session Token is described here: {@link https://shopify.dev/docs/apps/auth/oauth/session-tokens#payload}
+     * Refer to the OAuth docs for the [session token payload](https://shopify.dev/docs/apps/auth/oauth/session-tokens#payload).
      *
      * @example
-     * <caption>Get store specific widget data using the session token</caption>
+     * <caption>Using the decoded session token.</caption>
+     * <description>Get store-specific data using the `sessionToken` object.</description>
      * ```ts
-     * // app/routes/public/widgets.ts
+     * // app/routes/public/my-route.ts
      * import { LoaderArgs, json } from "@remix-run/node";
      * import { authenticate } from "../shopify.server";
-     * import { getWidgets } from "~/db/widgets.server";
+     * import { getMyAppData } from "~/db/model.server";
      *
      * export const loader = async ({ request }: LoaderArgs) => {
-     *   const { sessionToken } = await authenticate.public(
+     *   const { sessionToken } = await authenticate.public.checkout(
      *     request
      *   );
-     *   return json(await getWidgets({shop: sessionToken.dest}));
+     *   return json(await getMyAppData({shop: sessionToken.dest}));
      * };
      * ```
      */
     sessionToken: JwtPayload;
     /**
-     * A function that ensures the CORS headers are set correctly for the response
+     * A function that ensures the CORS headers are set correctly for the response.
      *
      * @example
-     * <caption>Setting CORS headers for a public request</caption>
+     * <caption>Setting CORS headers for a public request.</caption>
+     * <description>Use the `cors` helper to ensure your app can respond to checkout extension requests.</description>
      * ```ts
-     * // app/routes/public/widgets.ts
+     * // app/routes/public/my-route.ts
      * import { LoaderArgs, json } from "@remix-run/node";
      * import { authenticate } from "../shopify.server";
-     * import { getWidgets } from "~/db/widgets.server";
+     * import { getMyAppData } from "~/db/model.server";
      *
      * export const loader = async ({ request }: LoaderArgs) => {
-     *   const { sessionToken, cors } = await authenticate.public(
+     *   const { sessionToken, cors } = await authenticate.public.checkout(
      *     request,
      *     { corsHeaders: ["X-My-Custom-Header"] }
      *   );
-     *   const widgets = await getWidgets({shop: sessionToken.dest});
-     *   return cors(json(widgets));
+     *   const data = await getMyAppData({shop: sessionToken.dest});
+     *   return cors(json(data));
      * };
      * ```
      */

package/build/ts/server/authenticate/public/checkout/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../../../src/server/authenticate/public/checkout/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,UAAU,EAAC,MAAM,sBAAsB,CAAC;AAEhD,OAAO,EAAC,kBAAkB,EAAC,MAAM,mCAAmC,CAAC;AAErE,MAAM,MAAM,oBAAoB,GAAG,CACjC,OAAO,EAAE,OAAO,EAChB,OAAO,CAAC,EAAE,2BAA2B,KAClC,OAAO,CAAC,eAAe,CAAC,CAAC;AAE9B,MAAM,WAAW,2BAA2B;IAC1C,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,YAAY,EAAE,UAAU,CAAC;IAEzB;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,IAAI,EAAE,kBAAkB,CAAC;CAC1B"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../../../src/server/authenticate/public/checkout/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,UAAU,EAAC,MAAM,sBAAsB,CAAC;AAEhD,OAAO,EAAC,kBAAkB,EAAC,MAAM,mCAAmC,CAAC;AAErE,MAAM,MAAM,oBAAoB,GAAG,CACjC,OAAO,EAAE,OAAO,EAChB,OAAO,CAAC,EAAE,2BAA2B,KAClC,OAAO,CAAC,eAAe,CAAC,CAAC;AAE9B,MAAM,WAAW,2BAA2B;IAC1C,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,YAAY,EAAE,UAAU,CAAC;IAEzB;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,IAAI,EAAE,kBAAkB,CAAC;CAC1B"}

package/build/ts/server/authenticate/public/types.d.ts

@@ -1,26 +1,13 @@
 import type { AuthenticateCheckout } from './checkout/types';
 import type { AuthenticateAppProxy } from './appProxy/types';
-/**
- * Methods for authenticating Requests from Shopify's public surfaces
- *
- * To maintain backwards compatability this is a function and an object.
- *
- * Do not use `authenticate.public()`. Use `authenticate.public.checkout()` instead.
- * `authenticate.public()` will be removed in v2.
- *
- * Methods are:
- *
- * - `authenticate.public.checkout()` for authenticating requests from checkout extensions
- * - `authenticate.public.appProxy()` for authenticating requests from app proxies
- */
-export type AuthenticatePublic = AuthenticateCheckout & {
+interface AuthenticatePublicObject {
     /**
      * Authenticate a request from a checkout extension
      *
      * @example
      * <caption>Authenticating a checkout extension request</caption>
      * ```ts
-     * // app/routes/public/widgets.ts
+     * // /app/routes/public/widgets.ts
      * import { LoaderArgs, json } from "@remix-run/node";
      * import { authenticate } from "../shopify.server";
      *
@@ -39,7 +26,7 @@ export type AuthenticatePublic = AuthenticateCheckout & {
      * @example
      * <caption>Authenticating an app proxy request</caption>
      * ```ts
-     * // app/routes/public/widgets.ts
+     * // /app/routes/public/widgets.ts
      * import { LoaderArgs, json } from "@remix-run/node";
      * import { authenticate } from "../shopify.server";
      *
@@ -57,5 +44,20 @@ export type AuthenticatePublic = AuthenticateCheckout & {
      * ```
      */
     appProxy: AuthenticateAppProxy;
-};
+}
+/**
+ * Methods for authenticating Requests from Shopify's public surfaces
+ *
+ * To maintain backwards compatability this is a function and an object.
+ *
+ * Do not use `authenticate.public()`. Use `authenticate.public.checkout()` instead.
+ * `authenticate.public()` will be removed in v2.
+ *
+ * Methods are:
+ *
+ * - `authenticate.public.checkout()` for authenticating requests from checkout extensions
+ * - `authenticate.public.appProxy()` for authenticating requests from app proxies
+ */
+export type AuthenticatePublic = AuthenticateCheckout & AuthenticatePublicObject;
+export {};
 //# sourceMappingURL=types.d.ts.map

package/build/ts/server/authenticate/public/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../../src/server/authenticate/public/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,oBAAoB,EAAC,MAAM,kBAAkB,CAAC;AAC3D,OAAO,KAAK,EAAC,oBAAoB,EAAC,MAAM,kBAAkB,CAAC;AAO3D;;;;;;;;;;;;GAYG;AACH,MAAM,MAAM,kBAAkB,GAAG,oBAAoB,GAAG;IACtD;;;;;;;;;;;;;;;;;OAiBG;IACH,QAAQ,EAAE,oBAAoB,CAAC;IAE/B;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,QAAQ,EAAE,oBAAoB,CAAC;CAChC,CAAC"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../../src/server/authenticate/public/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,oBAAoB,EAAC,MAAM,kBAAkB,CAAC;AAC3D,OAAO,KAAK,EAAC,oBAAoB,EAAC,MAAM,kBAAkB,CAAC;AAO3D,UAAU,wBAAwB;IAChC;;;;;;;;;;;;;;;;;OAiBG;IACH,QAAQ,EAAE,oBAAoB,CAAC;IAE/B;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,QAAQ,EAAE,oBAAoB,CAAC;CAChC;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,MAAM,kBAAkB,GAAG,oBAAoB,GACnD,wBAAwB,CAAC"}

package/build/ts/server/authenticate/webhooks/authenticate.webhooks.doc.d.ts

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

package/build/ts/server/authenticate/webhooks/authenticate.webhooks.doc.d.ts.map

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