import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs';

const data: ReferenceEntityTemplateSchema = {
  name: 'shopifyApp',
  description:
    "Returns a set of functions that can be used by the app's backend to be able to respond to all Shopify requests." +
    '\n\nThe shape of the returned object changes depending on the value of `distribution`. If it is `AppDistribution.ShopifyAdmin`, then only `ShopifyAppBase` objects are returned, otherwise `ShopifyAppLogin` objects are included.',
  category: 'Entrypoints',
  type: 'function',
  isVisualComponent: false,
  definitions: [
    {
      title: 'shopifyApp',
      description: 'Function to create a new Shopify API object.',
      type: 'ShopifyAppGeneratedType',
    },
    {
      title: 'Future flags',
      description:
        'Set future flags using the `future` configuration field to opt in to upcoming breaking changes.' +
        '\n\nWith this feature, you can prepare for major releases ahead of time, as well as try out new features before they are released.',
      type: 'FutureFlags',
      filePath: 'src/server/future/flags.ts',
    },
  ],
  jsDocTypeExamples: [
    'ShopifyAppGeneratedType',
    'ShopifyAppBase',
    'ShopifyAppLogin',
  ],
  related: [
    {
      name: 'Authenticated contexts',
      subtitle: 'Authenticate requests coming from Shopify.',
      url: '/docs/api/shopify-app-react-router/authenticate',
    },
    {
      name: 'Unauthenticated contexts',
      subtitle: 'Interact with the API on non-Shopify requests.',
      url: '/docs/api/shopify-app-react-router/unauthenticated',
    },
  ],
};

export default data;