@shopify/shopify-app-remix 1.2.1 → 2.0.0

package/build/ts/server/unauthenticated/helpers/index.js

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

package/build/ts/server/unauthenticated/helpers/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../src/server/unauthenticated/helpers/index.ts"],"names":[],"mappings":";;;AAAA,gEAAsC"}

package/build/ts/server/unauthenticated/storefront/factory.d.ts

@@ -0,0 +1,4 @@
+import { BasicParams } from '../../types';
+import { GetUnauthenticatedStorefrontContext } from './types';
+export declare function unauthenticatedStorefrontContextFactory(params: BasicParams): GetUnauthenticatedStorefrontContext;
+//# sourceMappingURL=factory.d.ts.map

package/build/ts/server/unauthenticated/storefront/factory.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"factory.d.ts","sourceRoot":"","sources":["../../../../../src/server/unauthenticated/storefront/factory.ts"],"names":[],"mappings":"AAEA,OAAO,EAAC,WAAW,EAAC,MAAM,aAAa,CAAC;AAIxC,OAAO,EAEL,mCAAmC,EACpC,MAAM,SAAS,CAAC;AAEjB,wBAAgB,uCAAuC,CACrD,MAAM,EAAE,WAAW,GAClB,mCAAmC,CAerC"}

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

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.unauthenticatedStorefrontContextFactory = void 0;
+var tslib_1 = require("tslib");
+var shopify_api_1 = require("@shopify/shopify-api");
+var storefront_1 = require("../../clients/storefront");
+var helpers_1 = require("../helpers");
+function unauthenticatedStorefrontContextFactory(params) {
+    var _this = this;
+    return function (shop) { return tslib_1.__awaiter(_this, void 0, void 0, function () {
+        var session;
+        return tslib_1.__generator(this, function (_a) {
+            switch (_a.label) {
+                case 0: return [4 /*yield*/, (0, helpers_1.getOfflineSession)(shop, params)];
+                case 1:
+                    session = _a.sent();
+                    if (!session) {
+                        throw new shopify_api_1.ShopifyError("Could not find a session for shop ".concat(shop, " when creating unauthenticated storefront context"));
+                    }
+                    return [2 /*return*/, {
+                            session: session,
+                            storefront: (0, storefront_1.storefrontClientFactory)({ params: params, session: session }),
+                        }];
+            }
+        });
+    }); };
+}
+exports.unauthenticatedStorefrontContextFactory = unauthenticatedStorefrontContextFactory;
+//# sourceMappingURL=factory.js.map

package/build/ts/server/unauthenticated/storefront/factory.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"factory.js","sourceRoot":"","sources":["../../../../../src/server/unauthenticated/storefront/factory.ts"],"names":[],"mappings":";;;;AAAA,oDAAkD;AAGlD,uDAAiE;AACjE,sCAA6C;AAO7C,SAAgB,uCAAuC,CACrD,MAAmB;IADrB,iBAiBC;IAdC,OAAO,UAAO,IAAY;;;;wBACR,qBAAM,IAAA,2BAAiB,EAAC,IAAI,EAAE,MAAM,CAAC,EAAA;;oBAA/C,OAAO,GAAG,SAAqC;oBAErD,IAAI,CAAC,OAAO,EAAE;wBACZ,MAAM,IAAI,0BAAY,CACpB,4CAAqC,IAAI,sDAAmD,CAC7F,CAAC;qBACH;oBAED,sBAAO;4BACL,OAAO,SAAA;4BACP,UAAU,EAAE,IAAA,oCAAuB,EAAC,EAAC,MAAM,QAAA,EAAE,OAAO,SAAA,EAAC,CAAC;yBACvD,EAAC;;;SACH,CAAC;AACJ,CAAC;AAjBD,0FAiBC"}

package/build/ts/server/unauthenticated/storefront/index.d.ts

@@ -0,0 +1,2 @@
+export * from './factory';
+//# sourceMappingURL=index.d.ts.map

package/build/ts/server/unauthenticated/storefront/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/server/unauthenticated/storefront/index.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAC"}

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

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

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

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

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

@@ -0,0 +1,34 @@
+import { Session } from '@shopify/shopify-api';
+import type { StorefrontContext } from '../../clients';
+export interface UnauthenticatedStorefrontContext {
+    /**
+     * The session for the given shop.
+     *
+     * This comes from the session storage which `shopifyApp` uses to store sessions in your database of choice.
+     *
+     * This will always be an offline session. You can use this to get shop specific data.
+     *
+     * @example
+     * <caption>Using the offline session.</caption>
+     * <description>Get your app's shop-specific data using the returned offline `session` object.</description>
+     * ```ts
+     * // app/routes/**\/.ts
+     * import { LoaderFunctionArgs, json } from "@remix-run/node";
+     * import { unauthenticated } from "../shopify.server";
+     * import { getMyAppData } from "~/db/model.server";
+     *
+     * export const loader = async ({ request }: LoaderFunctionArgs) => {
+     *   const shop = getShopFromExternalRequest(request);
+     *   const { session } = await unauthenticated.storefront(shop);
+     *   return json(await getMyAppData({shop: session.shop));
+     * };
+     * ```
+     */
+    session: Session;
+    /**
+     * Method for interacting with the Shopify GraphQL Storefront API for the given store.
+     */
+    storefront: StorefrontContext;
+}
+export type GetUnauthenticatedStorefrontContext = (shop: string) => Promise<UnauthenticatedStorefrontContext>;
+//# sourceMappingURL=types.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../../src/server/unauthenticated/storefront/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,OAAO,EAAC,MAAM,sBAAsB,CAAC;AAE7C,OAAO,KAAK,EAAC,iBAAiB,EAAC,MAAM,eAAe,CAAC;AAErD,MAAM,WAAW,gCAAgC;IAC/C;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,OAAO,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,UAAU,EAAE,iBAAiB,CAAC;CAC/B;AAED,MAAM,MAAM,mCAAmC,GAAG,CAChD,IAAI,EAAE,MAAM,KACT,OAAO,CAAC,gCAAgC,CAAC,CAAC"}

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

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

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

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

package/build/ts/server/unauthenticated/storefront/unauthenticated.storefront.doc.d.ts

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

package/build/ts/server/unauthenticated/storefront/unauthenticated.storefront.doc.d.ts.map

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

package/build/ts/server/unauthenticated/storefront/unauthenticated.storefront.doc.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+var data = {
+    name: 'Unauthenticated storefront',
+    description: "Allows interacting with the Storefront API on requests that didn't come from Shopify." +
+        '\n\n> Caution: This should only be used for Requests that do not originate from Shopify.' +
+        '\n> You must do your own authentication before using this method.' +
+        "\n>This function doesn't perform **any** validation and shouldn't rely on unvalidated user input.",
+    category: 'Unauthenticated',
+    type: 'object',
+    isVisualComponent: false,
+    definitions: [
+        {
+            title: 'unauthenticated.storefront',
+            description: 'Creates an unauthenticated Storefront context.',
+            type: 'GetUnauthenticatedStorefrontContext',
+        },
+    ],
+    jsDocTypeExamples: ['UnauthenticatedStorefrontContext', 'StorefrontContext'],
+    related: [
+        {
+            name: 'API context',
+            subtitle: 'Interact with the Storefront API.',
+            url: '/docs/api/shopify-app-remix/apis/storefront-api',
+        },
+    ],
+};
+exports.default = data;
+//# sourceMappingURL=unauthenticated.storefront.doc.js.map

package/build/ts/server/unauthenticated/storefront/unauthenticated.storefront.doc.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"unauthenticated.storefront.doc.js","sourceRoot":"","sources":["../../../../../src/server/unauthenticated/storefront/unauthenticated.storefront.doc.ts"],"names":[],"mappings":";;AAEA,IAAM,IAAI,GAAkC;IAC1C,IAAI,EAAE,4BAA4B;IAClC,WAAW,EACT,uFAAuF;QACvF,0FAA0F;QAC1F,mEAAmE;QACnE,mGAAmG;IACrG,QAAQ,EAAE,iBAAiB;IAC3B,IAAI,EAAE,QAAQ;IACd,iBAAiB,EAAE,KAAK;IACxB,WAAW,EAAE;QACX;YACE,KAAK,EAAE,4BAA4B;YACnC,WAAW,EAAE,gDAAgD;YAC7D,IAAI,EAAE,qCAAqC;SAC5C;KACF;IACD,iBAAiB,EAAE,CAAC,kCAAkC,EAAE,mBAAmB,CAAC;IAC5E,OAAO,EAAE;QACP;YACE,IAAI,EAAE,aAAa;YACnB,QAAQ,EAAE,mCAAmC;YAC7C,GAAG,EAAE,iDAAiD;SACvD;KACF;CACF,CAAC;AAEF,kBAAe,IAAI,CAAC"}

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

@@ -0,0 +1,66 @@
+import type { ShopifyRestResources } from '@shopify/shopify-api';
+import type { GetUnauthenticatedAdminContext } from './admin/types';
+import type { GetUnauthenticatedStorefrontContext } from './storefront/types';
+export interface Unauthenticated<Resources extends ShopifyRestResources> {
+    /**
+     * Get an admin context by passing a shop
+     *
+     * **Warning** This should only be used for Requests that do not originate from Shopify.
+     * You must do your own authentication before using this method.
+     * This method throws an error if there is no session for the shop.
+     *
+     * @example
+     * <caption>Responding to a request not controlled by Shopify.</caption>
+     * ```ts
+     * // /app/shopify.server.ts
+     * import { LATEST_API_VERSION, shopifyApp } from "@shopify/shopify-app-remix/server";
+     * import { restResources } from "@shopify/shopify-api/rest/admin/2023-04";
+     *
+     * const shopify = shopifyApp({
+     *   restResources,
+     *   // ...etc
+     * });
+     * export default shopify;
+     * ```
+     * ```ts
+     * // /app/routes/**\/*.jsx
+     * import { LoaderFunctionArgs, json } from "@remix-run/node";
+     * import { authenticateExternal } from "~/helpers/authenticate"
+     * import shopify from "../../shopify.server";
+     *
+     * export async function loader({ request }: LoaderFunctionArgs) {
+     *   const shop = await authenticateExternal(request)
+     *   const {admin} = await shopify.unauthenticated.admin(shop);
+     *
+     *   return json(await admin.rest.resources.Product.count({ session }));
+     * }
+     * ```
+     */
+    admin: GetUnauthenticatedAdminContext<Resources>;
+    /**
+     * Get a storefront context by passing a shop
+     *
+     * **Warning** This should only be used for Requests that do not originate from Shopify.
+     * You must do your own authentication before using this method.
+     * This method throws an error if there is no session for the shop.
+     *
+     * @example
+     * <caption>Responding to a request not controlled by Shopify</caption>
+     * ```ts
+     * // /app/routes/**\/*.jsx
+     * import { LoaderFunctionArgs, json } from "@remix-run/node";
+     * import { authenticateExternal } from "~/helpers/authenticate"
+     * import shopify from "../../shopify.server";
+     *
+     * export async function loader({ request }: LoaderFunctionArgs) {
+     *   const shop = await authenticateExternal(request)
+     *   const {storefront} = await shopify.unauthenticated.storefront(shop);
+     *   const response = await storefront.graphql(`{blogs(first: 10) { edges { node { id } } } }`);
+     *
+     *   return json(await response.json());
+     * }
+     * ```
+     */
+    storefront: GetUnauthenticatedStorefrontContext;
+}
+//# sourceMappingURL=types.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/server/unauthenticated/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,oBAAoB,EAAC,MAAM,sBAAsB,CAAC;AAE/D,OAAO,KAAK,EAAC,8BAA8B,EAAC,MAAM,eAAe,CAAC;AAClE,OAAO,KAAK,EAAC,mCAAmC,EAAC,MAAM,oBAAoB,CAAC;AAE5E,MAAM,WAAW,eAAe,CAAC,SAAS,SAAS,oBAAoB;IACrE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;IACH,KAAK,EAAE,8BAA8B,CAAC,SAAS,CAAC,CAAC;IAEjD;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,UAAU,EAAE,mCAAmC,CAAC;CACjD"}

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

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

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

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

package/build/ts/server/version.d.ts

@@ -1,2 +1,2 @@
-export declare const SHOPIFY_REMIX_LIBRARY_VERSION = "1.2.1";
+export declare const SHOPIFY_REMIX_LIBRARY_VERSION = "2.0.0";
 //# sourceMappingURL=version.d.ts.map

package/build/ts/server/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SHOPIFY_REMIX_LIBRARY_VERSION = void 0;
-exports.SHOPIFY_REMIX_LIBRARY_VERSION = '1.2.1';
+exports.SHOPIFY_REMIX_LIBRARY_VERSION = '2.0.0';
 //# sourceMappingURL=version.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shopify/shopify-app-remix",
-  "version": "1.2.1",
+  "version": "2.0.0",
   "description": "Shopify Remix - to simplify the building of Shopify Apps with Remix",
   "repository": {
     "type": "git",
@@ -30,6 +30,10 @@
       "default": "./build/cjs/react/index.js"
     }
   },
+  "scripts": {
+    "build-docs": "sh docs/build-docs.sh",
+    "validate-docs": "sh ./docs/build-docs.sh isTest && yarn compare-docs"
+  },
   "publishConfig": {
     "access": "public"
   },
@@ -46,10 +50,11 @@
     "Storefront API"
   ],
   "devDependencies": {
-    "@remix-run/react": "^1.19.0",
+    "@remix-run/react": "^2.0.0",
+    "@shopify/generate-docs": "^0.11.1",
     "@shopify/polaris": "^11.8.0",
     "@shopify/react-testing": "^5.1.3",
-    "@shopify/shopify-app-session-storage-memory": "^1.0.12",
+    "@shopify/shopify-app-session-storage-memory": "^2.0.0",
     "@types/jest": "^29.5.1",
     "@types/jsonwebtoken": "^9.0.2",
     "@types/react": "^18.2.18",
@@ -62,9 +67,9 @@
     "ts-jest": "^29.1.0"
   },
   "dependencies": {
-    "@remix-run/server-runtime": "^1.17.1",
-    "@shopify/shopify-api": "7.6.0",
-    "@shopify/shopify-app-session-storage": "^1.1.9",
+    "@remix-run/server-runtime": "^2.0.0",
+    "@shopify/shopify-api": "^8.0.1",
+    "@shopify/shopify-app-session-storage": "^2.0.0",
     "isbot": "^3.6.5",
     "semver": "^7.5.0",
     "tslib": "^2.5.0"