npm - @shopify/shopify-app-remix - Versions diffs - 4.1.1 → 4.2.1 - Mend

@shopify/shopify-app-remix 4.1.1 → 4.2.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (276) hide show

package/src/server/unauthenticated/storefront/types.ts ADDED Viewed

@@ -0,0 +1,109 @@
+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.
+   *
+   * @example
+   * <caption>Querying the GraphQL API.</caption>
+   * <description>Use `storefront.graphql` to make query / mutation requests.</description>
+   * ```ts
+   * // app/routes/**\/.ts
+   * import { json } from "@remix-run/node";
+   * import { authenticate } from "../shopify.server";
+   *
+   * export async function action({ request }: ActionFunctionArgs) {
+   *   const shop = getShopFromExternalRequest(request);
+   *   const { storefront } = await unauthenticated.storefront(shop);
+   *
+   *   const response = await storefront.graphql(`{blogs(first: 10) { edges { node { id } } } }`);
+   *
+   *   return json(await response.json());
+   * }
+   * ```
+   *
+   * @example
+   * <caption>Handling GraphQL errors.</caption>
+   * <description>Catch `GraphqlQueryError` errors to see error messages from the API.</description>
+   * ```ts
+   * // /app/routes/**\/*.ts
+   * import { ActionFunctionArgs } from "@remix-run/node";
+   * import { authenticate } from "../shopify.server";
+   *
+   * export const action = async ({ request }: ActionFunctionArgs) => {
+   *   const shop = getShopFromExternalRequest(request);
+   *   const { storefront } = await unauthenticated.storefront(shop);
+   *
+   *   try {
+   *     const response = await storefront.graphql(
+   *       `#graphql
+   *       query incorrectQuery {
+   *         products(first: 10) {
+   *           nodes {
+   *             not_a_field
+   *           }
+   *         }
+   *       }`,
+   *     );
+   *
+   *     return json({ data: await response.json() });
+   *   } catch (error) {
+   *     if (error instanceof GraphqlQueryError) {
+   *       // { errors: { graphQLErrors: [
+   *       //   { message: "Field 'not_a_field' doesn't exist on type 'Product'" }
+   *       // ] } }
+   *       return json({ errors: error.body?.errors }, { status: 500 });
+   *     }
+   *     return json({ message: "An error occurred" }, { status: 500 });
+   *   }
+   * }
+   * ```
+   *
+   * ```ts
+   * // /app/shopify.server.ts
+   * import { shopifyApp } from "@shopify/shopify-app-remix/server";
+   *
+   * const shopify = shopifyApp({
+   *   // ...
+   * });
+   * export default shopify;
+   * export const unauthenticated = shopify.unauthenticated;
+   * ```
+   */
+  storefront: StorefrontContext;
+}
+/**
+ * Creates an unauthenticated Storefront context.
+ * @publicDocs
+ */
+export type GetUnauthenticatedStorefrontContext = (
+  shop: string,
+) => Promise<UnauthenticatedStorefrontContext>;

package/src/server/unauthenticated/types.ts ADDED Viewed

@@ -0,0 +1,65 @@
+import type {GetUnauthenticatedAdminContext} from './admin/types';
+import type {GetUnauthenticatedStorefrontContext} from './storefront/types';
+export interface Unauthenticated {
+  /**
+   * 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 { ApiVersion, shopifyApp } from "@shopify/shopify-app-remix/server";
+   *
+   * const shopify = shopifyApp({
+   *   // ...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);
+   *   const response = await admin.graphql("{ shop { name} }")
+   *
+   *   return json(await response.json());
+   * }
+   * ```
+   */
+  admin: GetUnauthenticatedAdminContext;
+  /**
+   * 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;
+}

package/src/server/version.ts ADDED Viewed

	@@ -0,0 +1 @@
1	+ export const SHOPIFY_REMIX_LIBRARY_VERSION = '4.2.1';

package/dist/ts/react/components/AppProvider/AppProvider.doc.d.ts DELETED Viewed

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

package/dist/ts/react/components/AppProvider/AppProvider.doc.d.ts.map DELETED Viewed

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

package/dist/ts/react/components/AppProxyForm/AppProxyForm.doc.d.ts DELETED Viewed

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

package/dist/ts/react/components/AppProxyForm/AppProxyForm.doc.d.ts.map DELETED Viewed

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

package/dist/ts/react/components/AppProxyLink/AppProxyLink.doc.d.ts DELETED Viewed

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

package/dist/ts/react/components/AppProxyLink/AppProxyLink.doc.d.ts.map DELETED Viewed

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

package/dist/ts/react/components/AppProxyProvider/AppProxyProvider.doc.d.ts DELETED Viewed

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

package/dist/ts/react/components/AppProxyProvider/AppProxyProvider.doc.d.ts.map DELETED Viewed

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

package/dist/ts/server/authenticate/admin/authenticate.admin.doc.d.ts DELETED Viewed

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

package/dist/ts/server/authenticate/admin/authenticate.admin.doc.d.ts.map DELETED Viewed

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

package/dist/ts/server/authenticate/admin/billing/authenticate.admin.billing.doc.d.ts DELETED Viewed

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

package/dist/ts/server/authenticate/admin/billing/authenticate.admin.billing.doc.d.ts.map DELETED Viewed

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

package/dist/ts/server/authenticate/admin/scope/authenticate.admin.scopes.doc.d.ts DELETED Viewed

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

package/dist/ts/server/authenticate/admin/scope/authenticate.admin.scopes.doc.d.ts.map DELETED Viewed

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

package/dist/ts/server/authenticate/flow/authenticate.flow.doc.d.ts DELETED Viewed

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

package/dist/ts/server/authenticate/flow/authenticate.flow.doc.d.ts.map DELETED Viewed

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

package/dist/ts/server/authenticate/fulfillment-service/authenticate.fulfillment-service.doc.d.ts DELETED Viewed

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

package/dist/ts/server/authenticate/fulfillment-service/authenticate.fulfillment-service.doc.d.ts.map DELETED Viewed

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

package/dist/ts/server/authenticate/public/appProxy/authenticate.public.app-proxy.doc.d.ts DELETED Viewed

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

package/dist/ts/server/authenticate/public/appProxy/authenticate.public.app-proxy.doc.d.ts.map DELETED Viewed

	@@ -1 +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,6BAkDX,CAAC;AAEF,eAAe,IAAI,CAAC"}

package/dist/ts/server/authenticate/public/checkout/authenticate.public.checkout.doc.d.ts DELETED Viewed

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

package/dist/ts/server/authenticate/public/checkout/authenticate.public.checkout.doc.d.ts.map DELETED Viewed

	@@ -1 +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,6BA4CX,CAAC;AAEF,eAAe,IAAI,CAAC"}

package/dist/ts/server/authenticate/public/customer-account/authenticate.public.customerAccount.doc.d.ts DELETED Viewed

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

package/dist/ts/server/authenticate/public/customer-account/authenticate.public.customerAccount.doc.d.ts.map DELETED Viewed

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

package/dist/ts/server/authenticate/webhooks/authenticate.webhooks.doc.d.ts DELETED Viewed

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

package/dist/ts/server/authenticate/webhooks/authenticate.webhooks.doc.d.ts.map DELETED Viewed

	@@ -1 +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,6BAkCX,CAAC;AAEF,eAAe,IAAI,CAAC"}

package/dist/ts/server/clients/admin/authenticate.admin.api.doc.d.ts DELETED Viewed

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

package/dist/ts/server/clients/admin/authenticate.admin.api.doc.d.ts.map DELETED Viewed

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

package/dist/ts/server/clients/storefront/authenticate.storefront.api.doc.d.ts DELETED Viewed

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

package/dist/ts/server/clients/storefront/authenticate.storefront.api.doc.d.ts.map DELETED Viewed

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

package/dist/ts/server/shopify-app.doc.d.ts DELETED Viewed

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

package/dist/ts/server/shopify-app.doc.d.ts.map DELETED Viewed

	@@ -1 +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,6BAwCX,CAAC;AAEF,eAAe,IAAI,CAAC"}

package/dist/ts/server/unauthenticated/admin/unauthenticated.admin.doc.d.ts DELETED Viewed

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

package/dist/ts/server/unauthenticated/admin/unauthenticated.admin.doc.d.ts.map DELETED Viewed

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

package/dist/ts/server/unauthenticated/storefront/unauthenticated.storefront.doc.d.ts DELETED Viewed

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

package/dist/ts/server/unauthenticated/storefront/unauthenticated.storefront.doc.d.ts.map DELETED Viewed

	@@ -1 +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,6BAmCX,CAAC;AAEF,eAAe,IAAI,CAAC"}