Merge pull request #1530 from Shopify/typ-osp-naming-ui-extensions

Typ osp naming

packages/ui-extensions-react/src/surfaces/checkout/hooks/buyer-journey.ts

@@ -31,7 +31,7 @@ export function useBuyerJourney<
 /**
  * Returns true if the buyer completed submitting their order.
  *
- * For example, when viewing the order status page after submitting payment, the buyer will have completed their order.
+ * For example, when viewing the **Order status** page after submitting payment, the buyer will have completed their order.
  */
 export function useBuyerJourneyCompleted<
   Target extends RenderExtensionTarget = RenderExtensionTarget,

packages/ui-extensions/docs/surfaces/checkout/reference/apis/buyer-journey.doc.ts

@@ -28,7 +28,7 @@ const data: ReferenceEntityTemplateSchema = {
       title: 'useBuyerJourneyCompleted',
       description: `
         Returns \`true\` if the buyer completed submitting their order.
-        For example, when viewing the order status page after submitting payment, the buyer will have completed their order.
+        For example, when viewing the **Order status** page after submitting payment, the buyer will have completed their order.
       `,
       type: 'UseBuyerJourneyCompletedGeneratedType',
     },

packages/ui-extensions/docs/surfaces/checkout/reference/apis/order.doc.ts

@@ -8,7 +8,7 @@ import {
 const data: ReferenceEntityTemplateSchema = {
   name: 'Order',
   description:
-    'The API for interacting with the order, available on the Order Status Page.',
+    'The API for interacting with the order, available on the **Order status** page.',
   isVisualComponent: false,
   category: 'APIs',
   type: 'API',
@@ -21,7 +21,7 @@ const data: ReferenceEntityTemplateSchema = {
     {
       title: 'useOrder',
       description:
-        "Returns the order information that's available on the Order Status Page.",
+        "Returns the order information that's available on the **Order status** page.",
       type: 'UseOrderGeneratedType',
     },
   ],

packages/ui-extensions/docs/surfaces/checkout/reference/targets/customer-account.order-status.block.render.doc.ts

@@ -9,7 +9,7 @@ import {
 
 const data: ReferenceEntityTemplateSchema = {
   name: 'customer-account.order-status.block.render',
-  description: `A [block extension target](/docs/api/checkout-ui-extensions/extension-targets-overview#block-extension-targets) that renders exclusively on the Order Status Page. Unlike static extension targets, block extension targets render where the merchant sets them using the [checkout editor](/apps/checkout/test-ui-extensions#test-the-extension-in-the-checkout-editor).
+  description: `A [block extension target](/docs/api/checkout-ui-extensions/extension-targets-overview#block-extension-targets) that renders exclusively on the **Order status** page. Unlike static extension targets, block extension targets render where the merchant sets them using the [checkout editor](/apps/checkout/test-ui-extensions#test-the-extension-in-the-checkout-editor).
 
   The [supported locations](/docs/api/checkout-ui-extensions/extension-targets-overview#supported-locations) for block extension targets can be previewed during development by [using a URL parameter](/docs/apps/checkout/best-practices/testing-ui-extensions#block-extension-targets).
 

packages/ui-extensions/docs/surfaces/checkout/reference/targets/customer-account.order-status.cart-line-item.render-after.doc.ts

@@ -10,7 +10,7 @@ import {
 const data: ReferenceEntityTemplateSchema = {
   name: 'customer-account.order-status.cart-line-item.render-after',
   description: `
-  A static extension target that renders on every line item, inside the details under the line item properties element on the Order Status Page.
+  A static extension target that renders on every line item, inside the details under the line item properties element on the **Order status** page.
 
   ${ORDER_STATUS_SURFACE_NOTE}
   `,

packages/ui-extensions/docs/surfaces/checkout/reference/targets/customer-account.order-status.cart-line-list.render-after.doc.ts

@@ -10,7 +10,7 @@ import {
 const data: ReferenceEntityTemplateSchema = {
   name: 'customer-account.order-status.cart-line-list.render-after',
   description: `
-  A static extension target that is rendered after all line items on the Order Status page.
+  A static extension target that is rendered after all line items on the **Order status** page.
 
   ${ORDER_STATUS_SURFACE_NOTE}
   `,

packages/ui-extensions/docs/surfaces/checkout/reference/targets/customer-account.order-status.customer-information.render-after.doc.ts

@@ -10,7 +10,7 @@ import {
 const data: ReferenceEntityTemplateSchema = {
   name: 'customer-account.order-status.customer-information.render-after',
   description: `
-  A static extension target that is rendered after a purchase below the customer information on the Order Status page.
+  A static extension target that is rendered after a purchase below the customer information on the **Order status** page.
 
   ${ORDER_STATUS_SURFACE_NOTE}
   `,

packages/ui-extensions/docs/surfaces/checkout/reference/targets/purchase.thank-you.block.render.doc.ts

@@ -4,7 +4,7 @@ import {getExample, getLinksByTag, STANDARD_API} from '../helper.docs';
 
 const data: ReferenceEntityTemplateSchema = {
   name: 'purchase.thank-you.block.render',
-  description: `A [block extension target](/docs/api/checkout-ui-extensions/extension-targets-overview#block-extension-targets) that renders exclusively on the Thank You Page. Unlike static extension targets, block extension targets render where the merchant sets them using the [checkout editor](/apps/checkout/test-ui-extensions#test-the-extension-in-the-checkout-editor).
+  description: `A [block extension target](/docs/api/checkout-ui-extensions/extension-targets-overview#block-extension-targets) that renders exclusively on the **Thank you** page. Unlike static extension targets, block extension targets render where the merchant sets them using the [checkout editor](/apps/checkout/test-ui-extensions#test-the-extension-in-the-checkout-editor).
 
   The [supported locations](/docs/api/checkout-ui-extensions/extension-targets-overview#supported-locations) for block extension targets can be previewed during development by [using a URL parameter](/docs/apps/checkout/best-practices/testing-ui-extensions#block-extension-targets).`,
   subCategory: 'Block',

packages/ui-extensions/docs/surfaces/checkout/reference/targets/purchase.thank-you.cart-line-item.render-after.doc.ts

@@ -5,7 +5,7 @@ import {getExample, getLinksByTag, CART_LINE_ITEM_API} from '../helper.docs';
 const data: ReferenceEntityTemplateSchema = {
   name: 'purchase.thank-you.cart-line-item.render-after',
   description:
-    'A static extension target that renders on every line item, inside the details under the line item properties element on the Thank You Page.',
+    'A static extension target that renders on every line item, inside the details under the line item properties element on the **Thank you** page.',
   defaultExample: getExample(
     'purchase.thank-you.cart-line-item.render-after/default',
     ['jsx', 'js'],

packages/ui-extensions/docs/surfaces/checkout/reference/targets/purchase.thank-you.cart-line-list.render-after.doc.ts

@@ -5,7 +5,7 @@ import {getExample, getLinksByTag, STANDARD_API} from '../helper.docs';
 const data: ReferenceEntityTemplateSchema = {
   name: 'purchase.thank-you.cart-line-list.render-after',
   description:
-    'A static extension target that is rendered after all line items on the Thank You page.',
+    'A static extension target that is rendered after all line items on the **Thank you** page.',
   subCategory: 'Order Summary',
   defaultExample: getExample(
     'purchase.thank-you.cart-line-list.render-after/default',

packages/ui-extensions/docs/surfaces/checkout/reference/targets/purchase.thank-you.customer-information.render-after.doc.ts

@@ -5,7 +5,7 @@ import {getExample, getLinksByTag, STANDARD_API} from '../helper.docs';
 const data: ReferenceEntityTemplateSchema = {
   name: 'purchase.thank-you.customer-information.render-after',
   description:
-    'A static extension target that is rendered after a purchase below the customer information on the Thank You page.',
+    'A static extension target that is rendered after a purchase below the customer information on the **Thank you** page.',
   subCategory: 'Information',
   defaultExample: getExample(
     'purchase.thank-you.customer-information.render-after/default',

packages/ui-extensions/docs/surfaces/checkout/reference/targets/purchase.thank-you.footer.render-after.doc.ts

@@ -5,7 +5,7 @@ import {STANDARD_API, getExample, getLinksByTag} from '../helper.docs';
 const data: ReferenceEntityTemplateSchema = {
   name: 'purchase.thank-you.footer.render-after',
   description:
-    'A static extension target that is rendered below the footer on the Thank You page.',
+    'A static extension target that is rendered below the footer on the **Thank you** page.',
   defaultExample: getExample('purchase.thank-you.footer.render-after/default', [
     'jsx',
     'js',

packages/ui-extensions/docs/surfaces/checkout/reference/targets/purchase.thank-you.header.render-after.doc.ts

@@ -5,7 +5,7 @@ import {STANDARD_API, getExample, getLinksByTag} from '../helper.docs';
 const data: ReferenceEntityTemplateSchema = {
   name: 'purchase.thank-you.header.render-after',
   description:
-    'A static extension target that is rendered below the header on the Thank You page.',
+    'A static extension target that is rendered below the header on the **Thank you** page.',
   defaultExample: getExample('purchase.thank-you.header.render-after/default', [
     'jsx',
     'js',

packages/ui-extensions/docs/surfaces/checkout/staticPages/extension-overview.doc.ts

@@ -102,14 +102,14 @@ Get started testing extensions on [one-page checkout](/docs/apps/checkout/best-p
       title: 'Thank you locations',
       anchorLink: 'supported-typ-locations',
       sectionContent:
-        'The thank you page is shown to buyers immediately after a checkout is successfully submitted. Learn more about building for [the thank you page](/docs/apps/checkout/thank-you-order-status).',
+        'The **Thank you** page is shown to buyers immediately after a checkout is successfully submitted. Learn more about building for [the **Thank you** page](/docs/apps/checkout/thank-you-order-status).',
       accordionContent: [
         {
           title: 'Order details',
           description: `
 Displays all order information to buyers.
 
-See [all thank you page extension targets](/docs/api/checkout-ui-extensions/targets).
+Review [all **Thank you** page extension targets](/docs/api/checkout-ui-extensions/targets).
 `,
           image: 'supported-locations-thank-you.png',
         },
@@ -118,7 +118,7 @@ See [all thank you page extension targets](/docs/api/checkout-ui-extensions/targ
           description: `
 Summary of the cart contents, discounts, and order totals.
 
-See [all thank you page extensions targets](/docs/api/checkout-ui-extensions/targets).
+Review [all **Thank you** page extensions targets](/docs/api/checkout-ui-extensions/targets).
 `,
           image: 'supported-locations-order-summary-thank-you.png',
         },
@@ -129,14 +129,14 @@ See [all thank you page extensions targets](/docs/api/checkout-ui-extensions/tar
       title: 'Order status locations',
       anchorLink: 'supported-osp-locations',
       sectionContent:
-        'The order status page is shown to buyers when they return to a completed checkout for order updates. Learn more about building for [the order status page](/docs/apps/checkout/thank-you-order-status).',
+        'The **Order status** page is shown to buyers when they return to a completed checkout for order updates. Learn more about building for [the **Order status** page](/docs/apps/checkout/thank-you-order-status).',
       accordionContent: [
         {
           title: 'Order details',
           description: `
 Displays all order information to buyers.
 
-See [all order status page extension targets](/docs/api/checkout-ui-extensions/targets).
+Review [all **Order status** page extension targets](/docs/api/checkout-ui-extensions/targets).
 `,
           image: 'supported-locations-order-status.png',
         },
@@ -145,7 +145,7 @@ See [all order status page extension targets](/docs/api/checkout-ui-extensions/t
           description: `
 Summary of the cart contents, discounts, and order totals.
 
-See [all order status page extensions targets](/docs/api/checkout-ui-extensions/targets).
+Review [all **Order status** page extensions targets](/docs/api/checkout-ui-extensions/targets).
 `,
           image: 'supported-locations-order-summary-order-status.png',
         },
@@ -176,7 +176,7 @@ See [all order status page extensions targets](/docs/api/checkout-ui-extensions/
       type: 'Generic',
       anchorLink: 'block-extension-targets',
       title: 'Block extension targets',
-      sectionContent: `Block extension targets render between core checkout features. Merchants can use the [checkout editor](/apps/checkout/test-ui-extensions#test-the-extension-in-the-checkout-editor) to place the extension in the [checkout](/docs/api/checkout-ui-extensions/extension-targets-overview#supported-locations), [thank you](/docs/api/checkout-ui-extensions/extension-targets-overview#supported-typ-locations), or [order status](/docs/api/checkout-ui-extensions/extension-targets-overview#supported-osp-locations) pages.
+      sectionContent: `Block extension targets render between core checkout features. Merchants can use the [checkout editor](/apps/checkout/test-ui-extensions#test-the-extension-in-the-checkout-editor) to place the extension in the [checkout](/docs/api/checkout-ui-extensions/extension-targets-overview#supported-locations), [**Thank you**](/docs/api/checkout-ui-extensions/extension-targets-overview#supported-typ-locations), or [**Order status**](/docs/api/checkout-ui-extensions/extension-targets-overview#supported-osp-locations) pages.
       \n\nBlock extensions are always rendered, regardless of what other elements of the checkout are present. For example, an extension placed above the shipping address will still render even for digital products which do not require a shipping address.\n\nChoose block extension targets when your content and functionality works independently of a core checkout feature. This is useful for custom content, like a field to capture order notes from the customer.`,
       image: 'block-extension-targets.png',
       sectionCard: [

packages/ui-extensions/src/surfaces/checkout/api/standard/standard.ts

@@ -424,7 +424,7 @@ export interface BuyerJourney {
   /**
    * This subscribable value will be true if the buyer completed submitting their order.
    *
-   * For example, when viewing the order status page after submitting payment, the buyer will have completed their order.
+   * For example, when viewing the **Order status** page after submitting payment, the buyer will have completed their order.
    */
   completed: StatefulRemoteSubscribable<boolean>;
 }