refactor: checkout.id -> sessionId

Author: kieran-osgood-shopify

modules/@shopify/checkout-sheet-kit/src/events.d.ts

@@ -636,14 +636,6 @@ export interface CheckoutPaymentMethodChangeStartResponse {
   errors?: CheckoutResponseError[];
 }
 
-/**
- * Checkout session information.
- */
-export interface CheckoutSession {
-  /** Globally unique identifier for the checkout session */
-  id: string;
-}
-
 /**
  * Event emitted when the buyer attempts to submit the checkout.
  *
@@ -670,7 +662,7 @@ export interface CheckoutSubmitStart {
   /**
    * The checkout session information.
    */
-  checkout: CheckoutSession;
+  sessionId: string;
 }
 
 /**

modules/@shopify/checkout-sheet-kit/src/index.ts

@@ -511,7 +511,6 @@ export type {
   CartPaymentInstrumentDisplayInput,
   CartPaymentInstrumentInput,
   PaymentTokenInput,
-  CheckoutSession,
   CheckoutAddressChangeStart,
   CheckoutAddressChangeStartResponse,
   CheckoutCompleteEvent,

modules/@shopify/checkout-sheet-kit/tests/CheckoutSubmitStart.test.tsx

@@ -23,7 +23,7 @@ jest.mock('react-native', () => {
 import React from 'react';
 import {render, act} from '@testing-library/react-native';
 import {ShopifyCheckout} from '../src/components/Checkout';
-import {createTestCart, createTestCheckout} from './testFixtures';
+import {createTestCart } from './testFixtures';
 
 describe('Checkout Component - Submit Start Events', () => {
   const mockCheckoutUrl = 'https://example.myshopify.com/checkout';
@@ -41,15 +41,14 @@ describe('Checkout Component - Submit Start Events', () => {
 
     const nativeComponent = getByTestId('checkout-webview');
     const testCart = createTestCart();
-    const testCheckout = createTestCheckout();
 
     act(() => {
       nativeComponent.props.onSubmitStart({
         nativeEvent: {
           id: 'test-event-123',
           method: 'checkout.submitStart',
           cart: testCart,
-          checkout: testCheckout,
+          sessionId: "checkout-session-123",
         },
       });
     });
@@ -59,7 +58,7 @@ describe('Checkout Component - Submit Start Events', () => {
       id: 'test-event-123',
       method: 'checkout.submitStart',
       cart: testCart,
-      checkout: testCheckout,
+      sessionId: "checkout-session-123",
     });
   });
 
@@ -77,7 +76,7 @@ describe('Checkout Component - Submit Start Events', () => {
             id: 'test-event',
             method: 'checkout.submitStart',
             cart: createTestCart(),
-            checkout: createTestCheckout(),
+            sessionId: "checkout-session-123",
           },
         });
       });

modules/@shopify/checkout-sheet-kit/tests/testFixtures.ts

@@ -21,7 +21,7 @@ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */
 
-import type {Cart, CheckoutSession} from '../src/events.d';
+import type {Cart} from '../src/events.d';
 
 /**
  * Shared test fixtures for creating test objects.
@@ -76,22 +76,3 @@ export function createTestCart(overrides?: Partial<Cart>): Cart {
   };
 }
 
-/**
- * Creates a test CheckoutSession instance with sensible defaults.
- *
- * @param overrides - Optional partial CheckoutSession object to override defaults
- * @returns A CheckoutSession instance suitable for testing
- *
- * @example
- * ```typescript
- * const checkout = createTestCheckout();
- * const checkoutWithCustomId = createTestCheckout({ id: 'custom-session-id' });
- * ```
- */
-export function createTestCheckout(overrides?: Partial<CheckoutSession>): CheckoutSession {
-  return {
-    id: 'checkout-session-123',
-    ...overrides,
-  };
-}
-