@shopify/shopify-app-remix 4.2.0 → 5.0.0

package/src/server/shopify-app.ts

@@ -39,6 +39,7 @@ import {FutureFlagOptions, logDisabledFutureFlags} from './future/flags';
  *
  * @param appConfig Configuration options for your Shopify app, such as the scopes your app needs.
  * @returns `ShopifyApp` An object constructed using your appConfig.  It has methods for interacting with Shopify.
+ * @publicDocs
  *
  * @example
  * <caption>The minimum viable configuration</caption>
@@ -88,9 +89,7 @@ export function shopifyApp<
   });
 
   const shopify:
-    | AdminApp<Config>
-    | AppStoreApp<Config>
-    | SingleMerchantApp<Config> = {
+    AdminApp<Config> | AppStoreApp<Config> | SingleMerchantApp<Config> = {
     sessionStorage: config.sessionStorage,
     addDocumentResponseHeaders: addDocumentResponseHeadersFactory(params),
     registerWebhooks: registerWebhooksFactory(params),
@@ -139,7 +138,7 @@ export function deriveApi(appConfig: AppConfigArg): BasicParams['api'] {
   let appUrl: URL;
   try {
     appUrl = new URL(appConfig.appUrl);
-  } catch (error) {
+  } catch (_error) {
     const message =
       appConfig.appUrl === ''
         ? `Detected an empty appUrl configuration, please make sure to set the necessary environment variables.\n` +

package/src/server/test-helpers/test-config.ts

@@ -51,9 +51,9 @@ export function testConfig<
  * the output being a const object.
  */
 type Modify<Type1, Type2> = {
-  [key in keyof Type2 as Type2[key] extends undefined
-    ? never
-    : key]: Type2[key];
+  [
+    key in keyof Type2 as Type2[key] extends undefined ? never : key
+  ]: Type2[key];
 } & {
   [key in keyof Type1 as key extends keyof Type2 ? never : key]: Type1[key];
 };

package/src/server/unauthenticated/admin/types.ts

@@ -74,6 +74,10 @@ export interface UnauthenticatedAdminContext {
   admin: AdminApiContext;
 }
 
+/**
+ * Creates an unauthenticated Admin context.
+ * @publicDocs
+ */
 export type GetUnauthenticatedAdminContext = (
   shop: string,
 ) => Promise<UnauthenticatedAdminContext>;

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

@@ -100,6 +100,10 @@ export interface UnauthenticatedStorefrontContext {
   storefront: StorefrontContext;
 }
 
+/**
+ * Creates an unauthenticated Storefront context.
+ * @publicDocs
+ */
 export type GetUnauthenticatedStorefrontContext = (
   shop: string,
 ) => Promise<UnauthenticatedStorefrontContext>;

package/src/server/version.ts

@@ -1 +1 @@
-export const SHOPIFY_REMIX_LIBRARY_VERSION = '4.2.0';
+export const SHOPIFY_REMIX_LIBRARY_VERSION = '5.0.0';

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

@@ -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

@@ -1 +0,0 @@
-{"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

@@ -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

@@ -1 +0,0 @@
-{"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

@@ -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

@@ -1 +0,0 @@
-{"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

@@ -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

@@ -1 +0,0 @@
-{"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

@@ -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

@@ -1 +0,0 @@
-{"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

@@ -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

@@ -1 +0,0 @@
-{"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

@@ -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

@@ -1 +0,0 @@
-{"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

@@ -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

@@ -1 +0,0 @@
-{"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

@@ -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

@@ -1 +0,0 @@
-{"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

@@ -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

@@ -1 +0,0 @@
-{"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

@@ -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

@@ -1 +0,0 @@
-{"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

@@ -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

@@ -1 +0,0 @@
-{"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

@@ -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

@@ -1 +0,0 @@
-{"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

@@ -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

@@ -1 +0,0 @@
-{"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

@@ -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

@@ -1 +0,0 @@
-{"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

@@ -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

@@ -1 +0,0 @@
-{"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

@@ -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

@@ -1 +0,0 @@
-{"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

@@ -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

@@ -1 +0,0 @@
-{"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"}

package/src/react/components/AppProvider/AppProvider.doc.ts

@@ -1,35 +0,0 @@
-import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs';
-
-const data: ReferenceEntityTemplateSchema = {
-  name: 'AppProvider',
-  descriptionType: 'AppProviderGeneratedType',
-  description: '',
-  category: 'Entrypoints',
-  type: 'component',
-  isVisualComponent: false,
-  definitions: [
-    {
-      title: 'AppProviderProps',
-      description: 'Props for the `AppProvider` component.',
-      type: 'AppProviderProps',
-      filePath: 'src/react/components/AppProvider/AppProvider.tsx',
-    },
-  ],
-  jsDocTypeExamples: ['AppProviderGeneratedType'],
-  related: [
-    {
-      name: 'App bridge',
-      subtitle: 'Learn more about App Bridge.',
-      url: '/docs/api/app-bridge-library',
-      type: 'shopify',
-    },
-    {
-      name: 'Polaris',
-      subtitle: 'Learn more about Polaris.',
-      url: '/docs/apps/tools/polaris',
-      type: 'shopify',
-    },
-  ],
-};
-
-export default data;

package/src/react/components/AppProxyForm/AppProxyForm.doc.ts

@@ -1,28 +0,0 @@
-import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs';
-
-const data: ReferenceEntityTemplateSchema = {
-  name: 'AppProxyForm',
-  descriptionType: 'AppProxyFormGeneratedType',
-  description: '',
-  category: 'App proxy components',
-  type: 'component',
-  isVisualComponent: false,
-  definitions: [],
-  jsDocTypeExamples: ['AppProxyFormGeneratedType'],
-  related: [
-    {
-      name: 'authenticate.public.appProxy',
-      subtitle: 'Authenticating app proxy requests.',
-      url: '/docs/api/shopify-app-remix/authenticate/public/app-proxy',
-      type: 'remix',
-    },
-    {
-      name: 'AppProxyProvider',
-      subtitle: 'Enable JavaScript in pages loaded through app proxies.',
-      url: '/docs/api/shopify-app-remix/app-proxy-components/appproxyprovider',
-      type: 'remix',
-    },
-  ],
-};
-
-export default data;

package/src/react/components/AppProxyLink/AppProxyLink.doc.ts

@@ -1,28 +0,0 @@
-import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs';
-
-const data: ReferenceEntityTemplateSchema = {
-  name: 'AppProxyLink',
-  descriptionType: 'AppProxyLinkGeneratedType',
-  description: '',
-  category: 'App proxy components',
-  type: 'component',
-  isVisualComponent: false,
-  definitions: [],
-  jsDocTypeExamples: ['AppProxyLinkGeneratedType'],
-  related: [
-    {
-      name: 'authenticate.public.appProxy',
-      subtitle: 'Authenticating app proxy requests.',
-      url: '/docs/api/shopify-app-remix/authenticate/public/app-proxy',
-      type: 'remix',
-    },
-    {
-      name: 'AppProxyProvider',
-      subtitle: 'Enable JavaScript in pages loaded through app proxies.',
-      url: '/docs/api/shopify-app-remix/app-proxy-components/appproxyprovider',
-      type: 'remix',
-    },
-  ],
-};
-
-export default data;

package/src/react/components/AppProxyProvider/AppProxyProvider.doc.ts

@@ -1,40 +0,0 @@
-import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs';
-
-const data: ReferenceEntityTemplateSchema = {
-  name: 'AppProxyProvider',
-  descriptionType: 'AppProxyProviderGeneratedType',
-  description: '',
-  category: 'Entrypoints',
-  type: 'component',
-  isVisualComponent: false,
-  definitions: [
-    {
-      title: 'AppProxyProviderProps',
-      description: 'Props for the `AppProxyProvider` component.',
-      type: 'AppProxyProviderProps',
-    },
-  ],
-  jsDocTypeExamples: ['AppProxyProviderGeneratedType'],
-  related: [
-    {
-      name: 'authenticate.public.appProxy',
-      subtitle: 'Authenticate app proxy requests.',
-      url: '/docs/api/shopify-app-remix/authenticate/public/app-proxy',
-      type: 'remix',
-    },
-    {
-      name: 'AppProxyForm',
-      subtitle: 'Render form elements in proxies.',
-      url: '/docs/api/shopify-app-remix/app-proxy-components/appproxyform',
-      type: 'remix',
-    },
-    {
-      name: 'AppProxyLink',
-      subtitle: 'Render link elements in proxies.',
-      url: '/docs/api/shopify-app-remix/app-proxy-components/appproxylink',
-      type: 'remix',
-    },
-  ],
-};
-
-export default data;

package/src/server/authenticate/admin/authenticate.admin.doc.ts

@@ -1,51 +0,0 @@
-import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs';
-
-const data: ReferenceEntityTemplateSchema = {
-  name: 'Admin',
-  description:
-    'Contains methods for authenticating and interacting with the Admin API.\n\nThis function can handle requests for apps embedded in the Admin, Admin extensions, or non-embedded apps.',
-  category: 'Authenticate',
-  type: 'object',
-  isVisualComponent: false,
-  definitions: [
-    {
-      title: 'authenticate.admin',
-      description:
-        'Authenticates requests coming from the Shopify admin.\n\nThe shape of the returned object changes depending on the `isEmbeddedApp` config.',
-      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',
-    'BillingContext',
-    'ScopesApiContext',
-  ],
-  related: [
-    {
-      name: 'API context',
-      subtitle: 'Interact with the Admin API.',
-      url: '/docs/api/shopify-app-remix/apis/admin-api',
-    },
-    {
-      name: 'Billing context',
-      subtitle: 'Bill merchants for your app using the Admin API.',
-      url: '/docs/api/shopify-app-remix/apis/billing',
-    },
-  ],
-};
-
-export default data;

package/src/server/authenticate/admin/billing/authenticate.admin.billing.doc.ts

@@ -1,29 +0,0 @@
-import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs';
-
-const data: ReferenceEntityTemplateSchema = {
-  name: 'Billing',
-  description:
-    'Contains function used to bill merchants for your app with the Billing API.\n\nThis object is returned on authenticated Admin requests.' +
-    '\n\n> Note: [Managed App Pricing](/docs/apps/launch/billing/managed-pricing) is now available. Define your app’s pricing plans directly in the Shopify Partner Dashboard, without needing to use the Billing API.',
-  category: 'APIs',
-  type: 'object',
-  isVisualComponent: false,
-  definitions: [
-    {
-      title: 'billing',
-      description:
-        'Provides utilities that apps can use to request billing for the app using the Admin API.',
-      type: 'BillingContext',
-    },
-  ],
-  jsDocTypeExamples: ['BillingContext'],
-  related: [
-    {
-      name: 'Admin context',
-      subtitle: 'Authenticate requests from Shopify Admin.',
-      url: '/docs/api/shopify-app-remix/authenticate/admin',
-    },
-  ],
-};
-
-export default data;

package/src/server/authenticate/admin/scope/authenticate.admin.scopes.doc.ts

@@ -1,28 +0,0 @@
-import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs';
-
-const data: ReferenceEntityTemplateSchema = {
-  name: 'Scopes',
-  description:
-    'Contains functions used to manage scopes for your app.\n\nThis object is returned on authenticated Admin requests.',
-  category: 'APIs',
-  type: 'object',
-  isVisualComponent: false,
-  definitions: [
-    {
-      title: 'scopes',
-      description:
-        'Provides utilities that apps can use to [manage scopes](https://shopify.dev/docs/apps/build/authentication-authorization/app-installation/manage-access-scopes) for the app using the Admin API.',
-      type: 'ScopesApiContext',
-    },
-  ],
-  jsDocTypeExamples: ['ScopesApiContext'],
-  related: [
-    {
-      name: 'Admin context',
-      subtitle: 'Authenticate requests from Shopify Admin.',
-      url: '/docs/api/shopify-app-remix/authenticate/admin',
-    },
-  ],
-};
-
-export default data;

package/src/server/authenticate/flow/authenticate.flow.doc.ts

@@ -1,47 +0,0 @@
-import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs';
-
-const data: ReferenceEntityTemplateSchema = {
-  name: 'Flow',
-  description:
-    'Contains functions for verifying Shopify Flow extensions.' +
-    '\n\nSee the [Flow documentation](https://shopify.dev/docs/apps/flow/actions/endpoints) for more information.',
-  category: 'Authenticate',
-  type: 'object',
-  isVisualComponent: false,
-  definitions: [
-    {
-      title: 'authenticate.flow',
-      description: 'Verifies requests coming from Shopify Flow extensions.',
-      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: [
-    {
-      name: 'Admin API context',
-      subtitle: 'Interact with the Admin API.',
-      url: '/docs/api/shopify-app-remix/apis/admin-api',
-    },
-    {
-      name: 'Flow action endpoints',
-      subtitle: 'Receive requests from Flow.',
-      url: '/docs/apps/flow/actions/endpoints',
-      type: 'shopify',
-    },
-  ],
-};
-
-export default data;

package/src/server/authenticate/fulfillment-service/authenticate.fulfillment-service.doc.ts

@@ -1,48 +0,0 @@
-import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs';
-
-const data: ReferenceEntityTemplateSchema = {
-  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',
-    },
-  ],
-};
-
-export default data;