@shopify/shopify-app-remix 2.6.0 → 2.7.0

package/build/cjs/server/authenticate/fulfillment-service/authenticate.js

@@ -0,0 +1,70 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var shopifyApi = require('@shopify/shopify-api');
+var factory = require('../../clients/admin/factory.js');
+
+function authenticateFulfillmentServiceFactory(params) {
+  const {
+    api,
+    config,
+    logger
+  } = params;
+  return async function authenticate(request) {
+    logger.info('Authenticating fulfillment service request');
+    if (request.method !== 'POST') {
+      logger.debug('Received a non-POST request for fulfillment service. Only POST requests are allowed.', {
+        url: request.url,
+        method: request.method
+      });
+      throw new Response(undefined, {
+        status: 405,
+        statusText: 'Method not allowed'
+      });
+    }
+    const rawBody = await request.text();
+    const result = await api.fulfillmentService.validate({
+      rawBody,
+      rawRequest: request
+    });
+    if (!result.valid) {
+      logger.error('Received an invalid fulfillment service request', {
+        reason: result.reason
+      });
+      throw new Response(undefined, {
+        status: 400,
+        statusText: 'Bad Request'
+      });
+    }
+    const payload = JSON.parse(rawBody);
+    const shop = request.headers.get(shopifyApi.ShopifyHeader.Domain) || '';
+    logger.debug('Fulfillment service request is valid, looking for an offline session', {
+      shop
+    });
+    const sessionId = api.session.getOfflineId(shop);
+    const session = await config.sessionStorage.loadSession(sessionId);
+    if (!session) {
+      logger.info('Fulfillment service request could not find session', {
+        shop
+      });
+      throw new Response(undefined, {
+        status: 400,
+        statusText: 'Bad Request'
+      });
+    }
+    logger.debug('Found a session for the fulfillment service request', {
+      shop
+    });
+    return {
+      session,
+      payload,
+      admin: factory.adminClientFactory({
+        params,
+        session
+      })
+    };
+  };
+}
+
+exports.authenticateFulfillmentServiceFactory = authenticateFulfillmentServiceFactory;

package/build/cjs/server/future/flags.js

@@ -0,0 +1,28 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+// When adding new flags, you should also add them to the `TEST_FUTURE_FLAGS` object in `test-config.ts` to ensure that
+
+// it doesn't cause regressions.
+
+// When adding new flags, use this format:
+// vX_myFutureFlag: Future extends FutureFlags ? Future['vX_myFutureFlag'] : false;
+
+function logDisabledFutureFlags(config, logger) {
+  const logFlag = (flag, message) => logger.info(`Future flag ${flag} is disabled.\n\n  ${message}\n`);
+  if (!config.future.v3_authenticatePublic) {
+    logFlag('v3_authenticatePublic', 'Enable this flag to allow appProxy and checkout in `shopify.authenticate.public`.');
+  }
+  if (!config.future.v3_lineItemBilling) {
+    logFlag('v3_lineItemBilling', 'Enable this flag to allow billing plans with multiple line items.');
+  }
+  if (!config.future.v3_webhookAdminContext) {
+    logFlag('v3_webhookAdminContext', 'Enable this flag to use the standard Admin context when calling `shopify.authenticate.webhook`.');
+  }
+  if (!config.future.unstable_newEmbeddedAuthStrategy) {
+    logFlag('unstable_newEmbeddedAuthStrategy', 'Enable this to use OAuth token exchange instead of auth code to generate API access tokens.' + '\n  Your app must be using Shopify managed install: https://shopify.dev/docs/apps/auth/installation');
+  }
+}
+
+exports.logDisabledFutureFlags = logDisabledFutureFlags;

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

@@ -8,7 +8,7 @@ var types = require('./types.js');
 var version = require('./version.js');
 var register = require('./authenticate/webhooks/register.js');
 var authenticate = require('./authenticate/admin/authenticate.js');
-var authenticate$2 = require('./authenticate/webhooks/authenticate.js');
+var authenticate$3 = require('./authenticate/webhooks/authenticate.js');
 var overrideLogger = require('./override-logger.js');
 var addResponseHeaders = require('./authenticate/helpers/add-response-headers.js');
 require('isbot');
@@ -21,6 +21,8 @@ var authCodeFlow = require('./authenticate/admin/strategies/auth-code-flow.js');
 var tokenExchange = require('./authenticate/admin/strategies/token-exchange.js');
 var idempotentPromiseHandler = require('./authenticate/helpers/idempotent-promise-handler.js');
 var authenticate$1 = require('./authenticate/flow/authenticate.js');
+var authenticate$2 = require('./authenticate/fulfillment-service/authenticate.js');
+var flags = require('./future/flags.js');
 
 /**
  * Creates an object your app will use to interact with Shopify.
@@ -67,7 +69,8 @@ function shopifyApp(appConfig) {
       admin: authStrategy,
       flow: authenticate$1.authenticateFlowFactory(params),
       public: factory.authenticatePublicFactory(params),
-      webhook: authenticate$2.authenticateWebhookFactory(params)
+      fulfillmentService: authenticate$2.authenticateFulfillmentServiceFactory(params),
+      webhook: authenticate$3.authenticateWebhookFactory(params)
     },
     unauthenticated: {
       admin: factory$1.unauthenticatedAdminContextFactory(params),
@@ -77,6 +80,7 @@ function shopifyApp(appConfig) {
   if (isAppStoreApp(shopify, appConfig) || isSingleMerchantApp(shopify, appConfig)) {
     shopify.login = login.loginFactory(params);
   }
+  flags.logDisabledFutureFlags(config, logger);
   return shopify;
 }
 function isAppStoreApp(_shopify, config) {
@@ -114,7 +118,8 @@ function deriveApi(appConfig) {
     isCustomStoreApp: appConfig.distribution === types.AppDistribution.ShopifyAdmin,
     future: {
       v10_lineItemBilling: (_appConfig$future = appConfig.future) === null || _appConfig$future === void 0 ? void 0 : _appConfig$future.v3_lineItemBilling
-    }
+    },
+    _logDisabledFutureFlags: false
   });
 }
 function deriveConfig(appConfig, apiConfig) {

package/build/cjs/server/types.js

@@ -10,10 +10,6 @@ let AppDistribution = /*#__PURE__*/function (AppDistribution) {
   AppDistribution["ShopifyAdmin"] = "shopify_admin";
   return AppDistribution;
 }({});
-
-// This can't be a type because it would reference itself
-// eslint-disable-next-line @typescript-eslint/consistent-indexed-object-style
-
 let LoginErrorType = /*#__PURE__*/function (LoginErrorType) {
   LoginErrorType["MissingShop"] = "MISSING_SHOP";
   LoginErrorType["InvalidShop"] = "INVALID_SHOP";

package/build/cjs/server/version.js

@@ -2,6 +2,6 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-const SHOPIFY_REMIX_LIBRARY_VERSION = '2.6.0';
+const SHOPIFY_REMIX_LIBRARY_VERSION = '2.7.0';
 
 exports.SHOPIFY_REMIX_LIBRARY_VERSION = SHOPIFY_REMIX_LIBRARY_VERSION;

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

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

package/build/ts/server/authenticate/admin/authenticate.admin.doc.js

@@ -13,6 +13,19 @@ var data = {
             type: 'AuthenticateAdmin',
         },
     ],
+    defaultExample: {
+        description: 'Authenticate, run API mutation, and redirect',
+        codeblock: {
+            title: 'Authenticate, run API mutation, and redirect',
+            tabs: [
+                {
+                    title: '/app/routes/**.ts',
+                    language: 'typescript',
+                    code: './authenticate.admin.doc.example.ts',
+                },
+            ],
+        },
+    },
     jsDocTypeExamples: [
         'EmbeddedAdminContext',
         'AdminApiContext',

package/build/ts/server/authenticate/admin/authenticate.admin.doc.js.map

@@ -1 +1 @@
-{"version":3,"file":"authenticate.admin.doc.js","sourceRoot":"","sources":["../../../../../src/server/authenticate/admin/authenticate.admin.doc.ts"],"names":[],"mappings":";;AAEA,IAAM,IAAI,GAAkC;IAC1C,IAAI,EAAE,OAAO;IACb,WAAW,EACT,wLAAwL;IAC1L,QAAQ,EAAE,cAAc;IACxB,IAAI,EAAE,QAAQ;IACd,iBAAiB,EAAE,KAAK;IACxB,WAAW,EAAE;QACX;YACE,KAAK,EAAE,oBAAoB;YAC3B,WAAW,EACT,4IAA4I;YAC9I,IAAI,EAAE,mBAAmB;SAC1B;KACF;IACD,iBAAiB,EAAE;QACjB,sBAAsB;QACtB,iBAAiB;QACjB,gBAAgB;KACjB;IACD,OAAO,EAAE;QACP;YACE,IAAI,EAAE,aAAa;YACnB,QAAQ,EAAE,8BAA8B;YACxC,GAAG,EAAE,4CAA4C;SAClD;QACD;YACE,IAAI,EAAE,iBAAiB;YACvB,QAAQ,EAAE,kDAAkD;YAC5D,GAAG,EAAE,0CAA0C;SAChD;KACF;CACF,CAAC;AAEF,kBAAe,IAAI,CAAC"}
+{"version":3,"file":"authenticate.admin.doc.js","sourceRoot":"","sources":["../../../../../src/server/authenticate/admin/authenticate.admin.doc.ts"],"names":[],"mappings":";;AAEA,IAAM,IAAI,GAAkC;IAC1C,IAAI,EAAE,OAAO;IACb,WAAW,EACT,wLAAwL;IAC1L,QAAQ,EAAE,cAAc;IACxB,IAAI,EAAE,QAAQ;IACd,iBAAiB,EAAE,KAAK;IACxB,WAAW,EAAE;QACX;YACE,KAAK,EAAE,oBAAoB;YAC3B,WAAW,EACT,4IAA4I;YAC9I,IAAI,EAAE,mBAAmB;SAC1B;KACF;IACD,cAAc,EAAE;QACd,WAAW,EAAE,8CAA8C;QAC3D,SAAS,EAAE;YACT,KAAK,EAAE,8CAA8C;YACrD,IAAI,EAAE;gBACJ;oBACE,KAAK,EAAE,mBAAmB;oBAC1B,QAAQ,EAAE,YAAY;oBACtB,IAAI,EAAE,qCAAqC;iBAC5C;aACF;SACF;KACF;IACD,iBAAiB,EAAE;QACjB,sBAAsB;QACtB,iBAAiB;QACjB,gBAAgB;KACjB;IACD,OAAO,EAAE;QACP;YACE,IAAI,EAAE,aAAa;YACnB,QAAQ,EAAE,8BAA8B;YACxC,GAAG,EAAE,4CAA4C;SAClD;QACD;YACE,IAAI,EAAE,iBAAiB;YACvB,QAAQ,EAAE,kDAAkD;YAC5D,GAAG,EAAE,0CAA0C;SAChD;KACF;CACF,CAAC;AAEF,kBAAe,IAAI,CAAC"}

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

@@ -16,16 +16,6 @@ interface AdminContextInternal<Config extends AppConfigArg, Resources extends Sh
      * <caption>Using offline sessions.</caption>
      * <description>Get your app's shop-specific data using an offline session.</description>
      * ```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 { LoaderFunctionArgs, json } from "@remix-run/node";
      * import { authenticate } from "../shopify.server";
@@ -36,21 +26,20 @@ interface AdminContextInternal<Config extends AppConfigArg, Resources extends Sh
      *   return json(await getMyAppData({shop: session.shop));
      * };
      * ```
-     *
-     * @example
-     * <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/server";
      *
      * const shopify = shopifyApp({
      *   // ...etc
-     *   useOnlineTokens: true,
      * });
      * export default shopify;
      * export const authenticate = shopify.authenticate;
      * ```
+     *
+     * @example
+     * <caption>Using online sessions.</caption>
+     * <description>Get your app's user-specific data using an online session.</description>
      * ```ts
      * // /app/routes/**\/*.ts
      * import { LoaderFunctionArgs, json } from "@remix-run/node";
@@ -62,6 +51,17 @@ interface AdminContextInternal<Config extends AppConfigArg, Resources extends Sh
      *   return json(await getMyAppData({user: session.onlineAccessInfo!.id}));
      * };
      * ```
+     * ```ts
+     * // shopify.server.ts
+     * import { shopifyApp } from "@shopify/shopify-app-remix/server";
+     *
+     * const shopify = shopifyApp({
+     *   // ...etc
+     *   useOnlineTokens: true,
+     * });
+     * export default shopify;
+     * export const authenticate = shopify.authenticate;
+     * ```
      */
     session: Session;
     /**
@@ -106,29 +106,29 @@ export interface EmbeddedAdminContext<Config extends AppConfigArg, Resources ext
      * <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/server";
-     *
-     * const shopify = shopifyApp({
-     *   // ...etc
-     *   useOnlineTokens: true,
-     * });
-     * export default shopify;
-     * export const authenticate = shopify.authenticate;
-     * ```
-     * ```ts
      * // /app/routes/**\/*.ts
      * import { LoaderFunctionArgs, json } from "@remix-run/node";
      * import { authenticate } from "../shopify.server";
      * import { getMyAppData } from "~/db/model.server";
      *
      * export const loader = async ({ request }: LoaderFunctionArgs) => {
-     *   const { sessionToken } = await authenticate.public.checkout(
+     *   const { sessionToken } = await authenticate.admin(
      *     request
      *   );
      *   return json(await getMyAppData({user: sessionToken.sub}));
      * };
      * ```
+     * ```ts
+     * // shopify.server.ts
+     * import { shopifyApp } from "@shopify/shopify-app-remix/server";
+     *
+     * const shopify = shopifyApp({
+     *   // ...etc
+     *   useOnlineTokens: true,
+     * });
+     * export default shopify;
+     * export const authenticate = shopify.authenticate;
+     * ```
      */
     sessionToken: JwtPayload;
     /**

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

@@ -1 +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,6BA6BX,CAAC;AAEF,eAAe,IAAI,CAAC"}
+{"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/build/ts/server/authenticate/flow/authenticate.flow.doc.js

@@ -14,6 +14,19 @@ var data = {
             type: 'AuthenticateFlow',
         },
     ],
+    defaultExample: {
+        description: 'Handle a flow action call',
+        codeblock: {
+            title: 'Set a metafield on a customer after a flow call',
+            tabs: [
+                {
+                    title: '/app/routes/**.ts',
+                    language: 'typescript',
+                    code: './authenticate.flow.doc.example.ts',
+                },
+            ],
+        },
+    },
     jsDocTypeExamples: ['FlowContext'],
     related: [
         {

package/build/ts/server/authenticate/flow/authenticate.flow.doc.js.map

@@ -1 +1 @@
-{"version":3,"file":"authenticate.flow.doc.js","sourceRoot":"","sources":["../../../../../src/server/authenticate/flow/authenticate.flow.doc.ts"],"names":[],"mappings":";;AAEA,IAAM,IAAI,GAAkC;IAC1C,IAAI,EAAE,MAAM;IACZ,WAAW,EACT,2DAA2D;QAC3D,8GAA8G;IAChH,QAAQ,EAAE,cAAc;IACxB,IAAI,EAAE,QAAQ;IACd,iBAAiB,EAAE,KAAK;IACxB,WAAW,EAAE;QACX;YACE,KAAK,EAAE,mBAAmB;YAC1B,WAAW,EAAE,wDAAwD;YACrE,IAAI,EAAE,kBAAkB;SACzB;KACF;IACD,iBAAiB,EAAE,CAAC,aAAa,CAAC;IAClC,OAAO,EAAE;QACP;YACE,IAAI,EAAE,mBAAmB;YACzB,QAAQ,EAAE,8BAA8B;YACxC,GAAG,EAAE,4CAA4C;SAClD;QACD;YACE,IAAI,EAAE,uBAAuB;YAC7B,QAAQ,EAAE,6BAA6B;YACvC,GAAG,EAAE,mCAAmC;YACxC,IAAI,EAAE,SAAS;SAChB;KACF;CACF,CAAC;AAEF,kBAAe,IAAI,CAAC"}
+{"version":3,"file":"authenticate.flow.doc.js","sourceRoot":"","sources":["../../../../../src/server/authenticate/flow/authenticate.flow.doc.ts"],"names":[],"mappings":";;AAEA,IAAM,IAAI,GAAkC;IAC1C,IAAI,EAAE,MAAM;IACZ,WAAW,EACT,2DAA2D;QAC3D,8GAA8G;IAChH,QAAQ,EAAE,cAAc;IACxB,IAAI,EAAE,QAAQ;IACd,iBAAiB,EAAE,KAAK;IACxB,WAAW,EAAE;QACX;YACE,KAAK,EAAE,mBAAmB;YAC1B,WAAW,EAAE,wDAAwD;YACrE,IAAI,EAAE,kBAAkB;SACzB;KACF;IACD,cAAc,EAAE;QACd,WAAW,EAAE,2BAA2B;QACxC,SAAS,EAAE;YACT,KAAK,EAAE,iDAAiD;YACxD,IAAI,EAAE;gBACJ;oBACE,KAAK,EAAE,mBAAmB;oBAC1B,QAAQ,EAAE,YAAY;oBACtB,IAAI,EAAE,oCAAoC;iBAC3C;aACF;SACF;KACF;IACD,iBAAiB,EAAE,CAAC,aAAa,CAAC;IAClC,OAAO,EAAE;QACP;YACE,IAAI,EAAE,mBAAmB;YACzB,QAAQ,EAAE,8BAA8B;YACxC,GAAG,EAAE,4CAA4C;SAClD;QACD;YACE,IAAI,EAAE,uBAAuB;YAC7B,QAAQ,EAAE,6BAA6B;YACvC,GAAG,EAAE,mCAAmC;YACxC,IAAI,EAAE,SAAS;SAChB;KACF;CACF,CAAC;AAEF,kBAAe,IAAI,CAAC"}

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

@@ -11,10 +11,10 @@ export interface FlowContext<Resources extends ShopifyRestResources = ShopifyRes
      * <description>Use the session associated with this request to use REST resources.</description>
      * ```ts
      * // /app/routes/flow.tsx
-     * import { ActionFunction } from "@remix-run/node";
+     * import { ActionFunctionArgs } from "@remix-run/node";
      * import { authenticate } from "../shopify.server";
      *
-     * export const action: ActionFunction = async ({ request }) => {
+     * export const action = async ({ request }: ActionFunctionArgs) => {
      *   const { session, admin } = await authenticate.flow(request);
      *
      *   const products = await admin?.rest.resources.Product.all({ session });
@@ -33,10 +33,10 @@ export interface FlowContext<Resources extends ShopifyRestResources = ShopifyRes
      * <description>Get the request's POST payload.</description>
      * ```ts
      * // /app/routes/flow.tsx
-     * import { ActionFunction } from "@remix-run/node";
+     * import { ActionFunctionArgs } from "@remix-run/node";
      * import { authenticate } from "../shopify.server";
      *
-     * export const action: ActionFunction = async ({ request }) => {
+     * export const action = async ({ request }: ActionFunctionArgs) => {
      *   const { payload } = await authenticate.flow(request);
      *   return new Response();
      * };

package/build/ts/server/authenticate/fulfillment-service/authenticate.d.ts

@@ -0,0 +1,5 @@
+import { ShopifyRestResources } from '@shopify/shopify-api';
+import { BasicParams } from '../../types';
+import type { AuthenticateFulfillmentService } from './types';
+export declare function authenticateFulfillmentServiceFactory<Resources extends ShopifyRestResources = ShopifyRestResources>(params: BasicParams): AuthenticateFulfillmentService<Resources>;
+//# sourceMappingURL=authenticate.d.ts.map

package/build/ts/server/authenticate/fulfillment-service/authenticate.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"authenticate.d.ts","sourceRoot":"","sources":["../../../../../src/server/authenticate/fulfillment-service/authenticate.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,oBAAoB,EAAgB,MAAM,sBAAsB,CAAC;AAGzE,OAAO,EAAC,WAAW,EAAC,MAAM,aAAa,CAAC;AAExC,OAAO,KAAK,EACV,8BAA8B,EAE/B,MAAM,SAAS,CAAC;AAEjB,wBAAgB,qCAAqC,CACnD,SAAS,SAAS,oBAAoB,GAAG,oBAAoB,EAC7D,MAAM,EAAE,WAAW,GAAG,8BAA8B,CAAC,SAAS,CAAC,CAqEhE"}

package/build/ts/server/authenticate/fulfillment-service/authenticate.fulfillment-service.doc.d.ts

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

package/build/ts/server/authenticate/fulfillment-service/authenticate.fulfillment-service.doc.d.ts.map

@@ -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/build/ts/server/authenticate/fulfillment-service/authenticate.fulfillment-service.doc.js

@@ -0,0 +1,46 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+var data = {
+    name: 'Fulfillment Service',
+    description: 'Contains functions for verifying fulfillment service requests.' +
+        '\n\nSee the [fulfillment service documentation](https://shopify.dev/docs/apps/fulfillment/fulfillment-service-apps) for more information.',
+    category: 'Authenticate',
+    type: 'object',
+    isVisualComponent: false,
+    definitions: [
+        {
+            title: 'authenticate.fulfillmentService',
+            description: 'Verifies requests coming from Shopify to fulfillment service apps',
+            type: 'AuthenticateFulfillmentService',
+        },
+    ],
+    defaultExample: {
+        description: 'Handle a fulfillment service notification call',
+        codeblock: {
+            title: 'Consume a fulfillment service notification request',
+            tabs: [
+                {
+                    title: '/app/routes/**.ts',
+                    language: 'typescript',
+                    code: './authenticate.fulfillment-service.doc.example.ts',
+                },
+            ],
+        },
+    },
+    jsDocTypeExamples: ['FulfillmentServiceContext'],
+    related: [
+        {
+            name: 'Admin API context',
+            subtitle: 'Interact with the Admin API.',
+            url: '/docs/api/shopify-app-remix/apis/admin-api',
+        },
+        {
+            name: 'Manage Fulfillments',
+            subtitle: 'Receive fulfillment requests and cancellations.',
+            url: '/docs/apps/fulfillment/fulfillment-service-apps/manage-fulfillments',
+            type: 'shopify',
+        },
+    ],
+};
+exports.default = data;
+//# sourceMappingURL=authenticate.fulfillment-service.doc.js.map

package/build/ts/server/authenticate/fulfillment-service/authenticate.fulfillment-service.doc.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"authenticate.fulfillment-service.doc.js","sourceRoot":"","sources":["../../../../../src/server/authenticate/fulfillment-service/authenticate.fulfillment-service.doc.ts"],"names":[],"mappings":";;AAEA,IAAM,IAAI,GAAkC;IAC1C,IAAI,EAAE,qBAAqB;IAC3B,WAAW,EACT,gEAAgE;QAChE,2IAA2I;IAC7I,QAAQ,EAAE,cAAc;IACxB,IAAI,EAAE,QAAQ;IACd,iBAAiB,EAAE,KAAK;IACxB,WAAW,EAAE;QACX;YACE,KAAK,EAAE,iCAAiC;YACxC,WAAW,EACT,mEAAmE;YACrE,IAAI,EAAE,gCAAgC;SACvC;KACF;IACD,cAAc,EAAE;QACd,WAAW,EAAE,gDAAgD;QAC7D,SAAS,EAAE;YACT,KAAK,EAAE,oDAAoD;YAC3D,IAAI,EAAE;gBACJ;oBACE,KAAK,EAAE,mBAAmB;oBAC1B,QAAQ,EAAE,YAAY;oBACtB,IAAI,EAAE,mDAAmD;iBAC1D;aACF;SACF;KACF;IACD,iBAAiB,EAAE,CAAC,2BAA2B,CAAC;IAChD,OAAO,EAAE;QACP;YACE,IAAI,EAAE,mBAAmB;YACzB,QAAQ,EAAE,8BAA8B;YACxC,GAAG,EAAE,4CAA4C;SAClD;QACD;YACE,IAAI,EAAE,qBAAqB;YAC3B,QAAQ,EAAE,iDAAiD;YAC3D,GAAG,EAAE,qEAAqE;YAC1E,IAAI,EAAE,SAAS;SAChB;KACF;CACF,CAAC;AAEF,kBAAe,IAAI,CAAC"}

package/build/ts/server/authenticate/fulfillment-service/authenticate.js

@@ -0,0 +1,73 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.authenticateFulfillmentServiceFactory = void 0;
+var tslib_1 = require("tslib");
+var shopify_api_1 = require("@shopify/shopify-api");
+var admin_1 = require("../../clients/admin");
+function authenticateFulfillmentServiceFactory(params) {
+    var api = params.api, config = params.config, logger = params.logger;
+    return function authenticate(request) {
+        return tslib_1.__awaiter(this, void 0, void 0, function () {
+            var rawBody, result, payload, shop, sessionId, session;
+            return tslib_1.__generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        logger.info('Authenticating fulfillment service request');
+                        if (request.method !== 'POST') {
+                            logger.debug('Received a non-POST request for fulfillment service. Only POST requests are allowed.', { url: request.url, method: request.method });
+                            throw new Response(undefined, {
+                                status: 405,
+                                statusText: 'Method not allowed',
+                            });
+                        }
+                        return [4 /*yield*/, request.text()];
+                    case 1:
+                        rawBody = _a.sent();
+                        return [4 /*yield*/, api.fulfillmentService.validate({
+                                rawBody: rawBody,
+                                rawRequest: request,
+                            })];
+                    case 2:
+                        result = _a.sent();
+                        if (!result.valid) {
+                            logger.error('Received an invalid fulfillment service request', {
+                                reason: result.reason,
+                            });
+                            throw new Response(undefined, {
+                                status: 400,
+                                statusText: 'Bad Request',
+                            });
+                        }
+                        payload = JSON.parse(rawBody);
+                        shop = request.headers.get(shopify_api_1.ShopifyHeader.Domain) || '';
+                        logger.debug('Fulfillment service request is valid, looking for an offline session', {
+                            shop: shop,
+                        });
+                        sessionId = api.session.getOfflineId(shop);
+                        return [4 /*yield*/, config.sessionStorage.loadSession(sessionId)];
+                    case 3:
+                        session = _a.sent();
+                        if (!session) {
+                            logger.info('Fulfillment service request could not find session', {
+                                shop: shop,
+                            });
+                            throw new Response(undefined, {
+                                status: 400,
+                                statusText: 'Bad Request',
+                            });
+                        }
+                        logger.debug('Found a session for the fulfillment service request', {
+                            shop: shop,
+                        });
+                        return [2 /*return*/, {
+                                session: session,
+                                payload: payload,
+                                admin: (0, admin_1.adminClientFactory)({ params: params, session: session }),
+                            }];
+                }
+            });
+        });
+    };
+}
+exports.authenticateFulfillmentServiceFactory = authenticateFulfillmentServiceFactory;
+//# sourceMappingURL=authenticate.js.map

package/build/ts/server/authenticate/fulfillment-service/authenticate.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"authenticate.js","sourceRoot":"","sources":["../../../../../src/server/authenticate/fulfillment-service/authenticate.ts"],"names":[],"mappings":";;;;AAAA,oDAAyE;AAEzE,6CAAuD;AAQvD,SAAgB,qCAAqC,CAEnD,MAAmB;IACZ,IAAA,GAAG,GAAoB,MAAM,IAA1B,EAAE,MAAM,GAAY,MAAM,OAAlB,EAAE,MAAM,GAAI,MAAM,OAAV,CAAW;IAErC,OAAO,SAAe,YAAY,CAChC,OAAgB;;;;;;wBAEhB,MAAM,CAAC,IAAI,CAAC,4CAA4C,CAAC,CAAC;wBAE1D,IAAI,OAAO,CAAC,MAAM,KAAK,MAAM,EAAE,CAAC;4BAC9B,MAAM,CAAC,KAAK,CACV,sFAAsF,EACtF,EAAC,GAAG,EAAE,OAAO,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,MAAM,EAAC,CAC3C,CAAC;4BACF,MAAM,IAAI,QAAQ,CAAC,SAAS,EAAE;gCAC5B,MAAM,EAAE,GAAG;gCACX,UAAU,EAAE,oBAAoB;6BACjC,CAAC,CAAC;wBACL,CAAC;wBAEe,qBAAM,OAAO,CAAC,IAAI,EAAE,EAAA;;wBAA9B,OAAO,GAAG,SAAoB;wBACrB,qBAAM,GAAG,CAAC,kBAAkB,CAAC,QAAQ,CAAC;gCACnD,OAAO,SAAA;gCACP,UAAU,EAAE,OAAO;6BACpB,CAAC,EAAA;;wBAHI,MAAM,GAAG,SAGb;wBAEF,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC;4BAClB,MAAM,CAAC,KAAK,CAAC,iDAAiD,EAAE;gCAC9D,MAAM,EAAE,MAAM,CAAC,MAAM;6BACtB,CAAC,CAAC;4BAEH,MAAM,IAAI,QAAQ,CAAC,SAAS,EAAE;gCAC5B,MAAM,EAAE,GAAG;gCACX,UAAU,EAAE,aAAa;6BAC1B,CAAC,CAAC;wBACL,CAAC;wBAEK,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;wBAC9B,IAAI,GAAG,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,2BAAa,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;wBAE7D,MAAM,CAAC,KAAK,CACV,sEAAsE,EACtE;4BACE,IAAI,MAAA;yBACL,CACF,CAAC;wBAEI,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,CAAC;4BACb,MAAM,CAAC,IAAI,CAAC,oDAAoD,EAAE;gCAChE,IAAI,MAAA;6BACL,CAAC,CAAC;4BACH,MAAM,IAAI,QAAQ,CAAC,SAAS,EAAE;gCAC5B,MAAM,EAAE,GAAG;gCACX,UAAU,EAAE,aAAa;6BAC1B,CAAC,CAAC;wBACL,CAAC;wBAED,MAAM,CAAC,KAAK,CAAC,qDAAqD,EAAE;4BAClE,IAAI,MAAA;yBACL,CAAC,CAAC;wBAEH,sBAAO;gCACL,OAAO,SAAA;gCACP,OAAO,SAAA;gCACP,KAAK,EAAE,IAAA,0BAAkB,EAAY,EAAC,MAAM,QAAA,EAAE,OAAO,SAAA,EAAC,CAAC;6BACxD,EAAC;;;;KACH,CAAC;AACJ,CAAC;AAvED,sFAuEC"}

package/build/ts/server/authenticate/fulfillment-service/types.d.ts

@@ -0,0 +1,109 @@
+import { Session, ShopifyRestResources } from '@shopify/shopify-api';
+import type { AdminApiContext } from '../../clients';
+export interface FulfillmentServiceContext<Resources extends ShopifyRestResources = ShopifyRestResources> {
+    /**
+     * A session with an offline token for the shop.
+     *
+     * Returned only if there is a session for the shop.
+     * @example
+     * <caption>Shopify session for the fulfillment service notification request.</caption>
+     * <description>Use the session associated with this request to use REST resources.</description>
+     * ```ts
+     * // /app/routes/fulfillment_service_notification.tsx
+     * import { ActionFunctionArgs } from "@remix-run/node";
+     * import { authenticate } from "../shopify.server";
+     *
+     *   export const action = async ({ request }: ActionFunctionArgs) => {
+     *   const { session, admin } = await authenticate.fulfillmentService(request);
+     *
+     *   const products = await admin?.rest.resources.Product.all({ session });
+     *   // Use products
+     *
+     *   return new Response();
+     * };
+     * ```
+     * */
+    session: Session;
+    /**
+     *
+     * An admin context for the fulfillment service request.
+     *
+     * Returned only if there is a session for the shop.
+     * @example
+     * <caption>Shopify session for the fulfillment service request.</caption>
+     * <description>Use the session associated with this request to use the Admin GraphQL API </description>
+     * ```ts
+     * // /app/routes/fulfillment_order_notification.ts
+     * import { ActionFunctionArgs } from "@remix-run/node";
+     * import { authenticate } from "../shopify.server";
+     *
+     * export async function action({ request }: ActionFunctionArgs) {
+     *   const { admin } = await authenticate.fulfillmentService(request);
+     *   const response = await admin?.graphql(
+     *  `#graphql
+     *    query {
+     *      shop {
+     *        assignedFulfillmentOrders(first: 10, assignmentStatus: FULFILLMENT_REQUESTED) {
+     *          edges {
+     *            node {
+     *              id
+     *              destination {
+     *              firstName
+     *              lastName
+     *            }
+     *            lineItems(first: 10) {
+     *              edges {
+     *                node {
+     *                id
+     *                productTitle
+     *                sku
+     *                remainingQuantity
+     *              }
+     *            }
+     *          }
+     *          merchantRequests(first: 10, kind: FULFILLMENT_REQUEST) {
+     *            edges {
+     *              node {
+     *                message
+     *              }
+     *            }
+     *          }
+     *        }
+     *      }
+     *    }
+     *  }
+     * }`);
+     *
+     *   const fulfillments = await response.json();
+     *   return json({ data: fulfillments.data });
+     * }
+     * ```
+     */
+    admin: AdminApiContext<Resources>;
+    /**
+     * The payload from the fulfillment service request.
+     *
+     * @example
+     * <caption>Fulfillment service request payload.</caption>
+     * <description>Get the request's POST payload.</description>
+     * ```ts
+     * /app/routes/fulfillment_order_notification.ts
+     * import { ActionFunction } from "@remix-run/node";
+     * import { authenticate } from "../shopify.server";
+     *
+     * export const action: ActionFunction = async ({ request }) => {
+     *   const { payload } = await authenticate.fulfillmentService(request);
+     *   if(payload.kind === 'FULFILLMENT_REQUEST') {
+     *    // handle fulfillment request
+     *   } else if (payload.kind === 'CANCELLATION_REQUEST') {
+     *    // handle cancellation request
+     *   };
+     * return new Response();
+     * ```
+     */
+    payload: Record<string, any> & {
+        kind: string;
+    };
+}
+export type AuthenticateFulfillmentService<Resources extends ShopifyRestResources = ShopifyRestResources> = (request: Request) => Promise<FulfillmentServiceContext<Resources>>;
+//# sourceMappingURL=types.d.ts.map

package/build/ts/server/authenticate/fulfillment-service/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../../src/server/authenticate/fulfillment-service/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,OAAO,EAAE,oBAAoB,EAAC,MAAM,sBAAsB,CAAC;AAEnE,OAAO,KAAK,EAAC,eAAe,EAAC,MAAM,eAAe,CAAC;AAEnD,MAAM,WAAW,yBAAyB,CACxC,SAAS,SAAS,oBAAoB,GAAG,oBAAoB;IAE7D;;;;;;;;;;;;;;;;;;;;;SAqBK;IACL,OAAO,EAAE,OAAO,CAAC;IACjB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAsDG;IACH,KAAK,EAAE,eAAe,CAAC,SAAS,CAAC,CAAC;IAElC;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG;QAC7B,IAAI,EAAE,MAAM,CAAC;KACd,CAAC;CACH;AAED,MAAM,MAAM,8BAA8B,CACxC,SAAS,SAAS,oBAAoB,GAAG,oBAAoB,IAC3D,CAAC,OAAO,EAAE,OAAO,KAAK,OAAO,CAAC,yBAAyB,CAAC,SAAS,CAAC,CAAC,CAAC"}

package/build/ts/server/authenticate/fulfillment-service/types.js

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

package/build/ts/server/authenticate/fulfillment-service/types.js.map

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

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

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