@shopify/shopify-app-remix 4.2.0 → 5.0.0

package/src/server/authenticate/public/appProxy/authenticate.public.app-proxy.doc.ts

@@ -1,55 +0,0 @@
-import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs';
-
-const data: ReferenceEntityTemplateSchema = {
-  name: 'App proxy',
-  description:
-    '[App proxies](/docs/apps/online-store/app-proxies) take requests to Shopify links, and redirect them to external links.' +
-    '\nThe `authenticate.public.appProxy` function validates requests made to app proxies, and returns a context to enable querying Shopify APIs.' +
-    '\n\n> Note: If the store has not installed the app, store-related properties such as `admin` or `storefront` will be `undefined`',
-  category: 'Authenticate',
-  subCategory: 'Public',
-  type: 'object',
-  isVisualComponent: false,
-  definitions: [
-    {
-      title: 'authenticate.public.appProxy',
-      description:
-        'Authenticates requests coming to the app from Shopify app proxies.',
-      type: 'AuthenticateAppProxy',
-    },
-  ],
-  defaultExample: {
-    description: 'Authenticate and fetch product information',
-    codeblock: {
-      title: 'Authenticate and fetch product information',
-      tabs: [
-        {
-          title: '/app/routes/**.ts',
-          language: 'typescript',
-          code: './authenticate.public.app-proxy.doc.example.ts',
-        },
-      ],
-    },
-  },
-  jsDocTypeExamples: ['AppProxyContextWithSession'],
-  related: [
-    {
-      name: 'Admin API context',
-      subtitle: 'Interact with the Admin API.',
-      url: '/docs/api/shopify-app-remix/apis/admin-api',
-    },
-    {
-      name: 'Storefront API context',
-      subtitle: 'Interact with the Storefront API.',
-      url: '/docs/api/shopify-app-remix/apis/storefront-api',
-    },
-    {
-      name: 'Liquid reference',
-      subtitle: "Use the shop's theme to render a template.",
-      url: '/docs/api/liquid',
-      type: 'liquid',
-    },
-  ],
-};
-
-export default data;

package/src/server/authenticate/public/checkout/authenticate.public.checkout.doc.ts

@@ -1,49 +0,0 @@
-import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs';
-
-const data: ReferenceEntityTemplateSchema = {
-  name: 'Checkout',
-  description:
-    'The `authenticate.public.checkout` function ensures that checkout extension requests are coming from Shopify, and returns helpers to respond with the correct headers.',
-  category: 'Authenticate',
-  subCategory: 'Public',
-  type: 'object',
-  isVisualComponent: false,
-  definitions: [
-    {
-      title: 'authenticate.public.checkout',
-      description:
-        'Authenticates requests coming from Shopify checkout extensions.',
-      type: 'AuthenticateCheckout',
-    },
-  ],
-  defaultExample: {
-    description: 'Authenticate and return offers for the shop',
-    codeblock: {
-      title: 'Authenticate and return offers for the shop',
-      tabs: [
-        {
-          title: '/app/routes/**.ts',
-          language: 'typescript',
-          code: './authenticate.public.checkout.doc.example.ts',
-        },
-        {
-          title: '/app/offers.server.ts',
-          language: 'typescript',
-          code: './authenticate.public.checkout.doc.example.offers.ts',
-        },
-      ],
-    },
-  },
-  jsDocTypeExamples: ['CheckoutContext'],
-  related: [
-    {
-      name: 'Session token API',
-      subtitle:
-        'Checkout UI extension API for interacting with session tokens.',
-      url: '/docs/api/checkout-ui-extensions/latest/apis/session-token',
-      type: 'shopify',
-    },
-  ],
-};
-
-export default data;

package/src/server/authenticate/public/customer-account/authenticate.public.customerAccount.doc.ts

@@ -1,49 +0,0 @@
-import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs';
-
-const data: ReferenceEntityTemplateSchema = {
-  name: 'Customer account',
-  description:
-    'The `authenticate.public.customerAccount` function ensures that customer account extension requests are coming from Shopify, and returns helpers to respond with the correct headers.',
-  category: 'Authenticate',
-  subCategory: 'Public',
-  type: 'object',
-  isVisualComponent: false,
-  definitions: [
-    {
-      title: 'authenticate.public.customerAccount',
-      description:
-        'Authenticates requests coming from Shopify customer account extensions.',
-      type: 'AuthenticateCustomerAccount',
-    },
-  ],
-  defaultExample: {
-    description: 'Authenticate and return offers for the customer',
-    codeblock: {
-      title: 'Authenticate and return offers for the customer',
-      tabs: [
-        {
-          title: '/app/routes/**.ts',
-          language: 'typescript',
-          code: './authenticate.public.customerAccount.doc.example.ts',
-        },
-        {
-          title: '/app/offers.server.ts',
-          language: 'typescript',
-          code: './authenticate.public.customerAccount.doc.example.offers.ts',
-        },
-      ],
-    },
-  },
-  jsDocTypeExamples: ['CustomerAccountContext'],
-  related: [
-    {
-      name: 'Session token API',
-      subtitle:
-        'Customer account UI extensions API for interacting with session tokens.',
-      url: '/docs/api/customer-account-ui-extensions/latest/apis/session-token',
-      type: 'shopify',
-    },
-  ],
-};
-
-export default data;

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

@@ -1,39 +0,0 @@
-import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs';
-
-const data: ReferenceEntityTemplateSchema = {
-  name: 'Webhook',
-  description: 'Contains functions for verifying Shopify webhooks.',
-  category: 'Authenticate',
-  type: 'object',
-  isVisualComponent: false,
-  definitions: [
-    {
-      title: 'authenticate.webhook',
-      description: 'Verifies requests coming from Shopify webhooks.',
-      type: 'AuthenticateWebhook',
-    },
-  ],
-  defaultExample: {
-    description: 'Update a metafield when a product is updated',
-    codeblock: {
-      title: 'Update a metafield when a product is updated',
-      tabs: [
-        {
-          title: '/app/routes/**.ts',
-          language: 'typescript',
-          code: './authenticate.webhooks.doc.example.ts',
-        },
-      ],
-    },
-  },
-  jsDocTypeExamples: ['WebhookContextWithSession'],
-  related: [
-    {
-      name: 'Admin API context',
-      subtitle: 'Interact with the Admin API.',
-      url: '/docs/api/shopify-app-remix/apis/admin-api',
-    },
-  ],
-};
-
-export default data;

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

@@ -1,34 +0,0 @@
-import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs';
-
-const data: ReferenceEntityTemplateSchema = {
-  name: 'Admin API',
-  description:
-    'Contains objects used to interact with the Admin API.' +
-    '\n\nThis object is returned as part of different contexts, such as [`admin`](/docs/api/shopify-app-remix/authenticate/admin), [`unauthenticated.admin`](/docs/api/shopify-app-remix/unauthenticated/unauthenticated-admin), and [`webhook`](/docs/api/shopify-app-remix/authenticate/webhook).',
-  category: 'APIs',
-  type: 'object',
-  isVisualComponent: false,
-  definitions: [
-    {
-      title: 'admin',
-      description:
-        'Provides utilities that apps can use to make requests to the Admin API.',
-      type: 'AdminApiContext',
-    },
-  ],
-  jsDocTypeExamples: ['AdminApiContext'],
-  related: [
-    {
-      name: 'Authenticated context',
-      subtitle: 'Authenticate requests from Shopify Admin.',
-      url: '/docs/api/shopify-app-remix/authenticate/admin',
-    },
-    {
-      name: 'Unauthenticated context',
-      subtitle: 'Interact with the Admin API on non-Shopify requests.',
-      url: '/docs/api/shopify-app-remix/unauthenticated/unauthenticated-admin',
-    },
-  ],
-};
-
-export default data;

package/src/server/clients/storefront/authenticate.storefront.api.doc.ts

@@ -1,34 +0,0 @@
-import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs';
-
-const data: ReferenceEntityTemplateSchema = {
-  name: 'Storefront API',
-  description:
-    'Contains objects used to interact with the Storefront API.' +
-    '\n\nThis object is returned as part of different contexts, such as [`appProxy`](/docs/api/shopify-app-remix/authenticate/public/app-proxy), and [`unauthenticated.storefront`](/docs/api/shopify-app-remix/unauthenticated/unauthenticated-storefront).',
-  category: 'APIs',
-  type: 'object',
-  isVisualComponent: false,
-  definitions: [
-    {
-      title: 'storefront',
-      description:
-        'Provides utilities that apps can use to make requests to the Storefront API.',
-      type: 'StorefrontContext',
-    },
-  ],
-  jsDocTypeExamples: ['StorefrontContext'],
-  related: [
-    {
-      name: 'App proxy context',
-      subtitle: 'Authenticate requests from Shopify app proxies.',
-      url: '/docs/api/shopify-app-remix/authenticate/public/app-proxy',
-    },
-    {
-      name: 'Unauthenticated context',
-      subtitle: 'Interact with the Storefront API on non-Shopify requests.',
-      url: '/docs/api/shopify-app-remix/unauthenticated/unauthenticated-storefront',
-    },
-  ],
-};
-
-export default data;

package/src/server/shopify-app.doc.ts

@@ -1,45 +0,0 @@
-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-remix/authenticate',
-    },
-    {
-      name: 'Unauthenticated contexts',
-      subtitle: 'Interact with the API on non-Shopify requests.',
-      url: '/docs/api/shopify-app-remix/unauthenticated',
-    },
-  ],
-};
-
-export default data;

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

@@ -1,40 +0,0 @@
-import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs';
-
-const data: ReferenceEntityTemplateSchema = {
-  name: 'Unauthenticated admin',
-  description: `Allows interacting with the Admin API when working outside of Shopify requests.
-This enables apps to integrate with 3rd party services and perform background tasks.
-
-> Caution:
-> This function doesn't perform **any** validation and shouldn't rely on raw user input.
-
-When using this function, consider the following:
-
-#### Background tasks
-
-Apps should ensure that the shop domain is authenticated when enqueueing jobs.
-
-#### 3rd party service requests
-
-Apps must obtain the shop domain from the 3rd party service in a secure way.`,
-  category: 'Unauthenticated',
-  type: 'object',
-  isVisualComponent: false,
-  definitions: [
-    {
-      title: 'unauthenticated.admin',
-      description: 'Creates an unauthenticated Admin context.',
-      type: 'GetUnauthenticatedAdminContext',
-    },
-  ],
-  jsDocTypeExamples: ['UnauthenticatedAdminContext'],
-  related: [
-    {
-      name: 'API context',
-      subtitle: 'Interact with the Admin API.',
-      url: '/docs/api/shopify-app-remix/apis/admin-api',
-    },
-  ],
-};
-
-export default data;

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

@@ -1,40 +0,0 @@
-import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs';
-
-const data: ReferenceEntityTemplateSchema = {
-  name: 'Unauthenticated storefront',
-  description: `Allows interacting with the Storefront API when working outside of Shopify requests.
-This enables apps to integrate with 3rd party services and perform background tasks.
-
-> Caution:
-> This function doesn't perform **any** validation and shouldn't rely on raw user input.
-
-When using this function, consider the following:
-
-#### Background tasks
-
-Apps should ensure that the shop domain is authenticated when enqueueing jobs.
-
-#### 3rd party service requests
-
-Apps must obtain the shop domain from the 3rd party service in a secure way.`,
-  category: 'Unauthenticated',
-  type: 'object',
-  isVisualComponent: false,
-  definitions: [
-    {
-      title: 'unauthenticated.storefront',
-      description: 'Creates an unauthenticated Storefront context.',
-      type: 'GetUnauthenticatedStorefrontContext',
-    },
-  ],
-  jsDocTypeExamples: ['UnauthenticatedStorefrontContext'],
-  related: [
-    {
-      name: 'API context',
-      subtitle: 'Interact with the Storefront API.',
-      url: '/docs/api/shopify-app-remix/apis/storefront-api',
-    },
-  ],
-};
-
-export default data;