[TypeScript] Agnostic protocol

platforms/react-native/modules/@shopify/checkout-kit-react-native/api/checkout-kit-react-native.api.md

@@ -5,8 +5,7 @@
 ```ts
 
 import { Checkout } from '@shopify/checkout-kit-protocol';
-import { CheckoutProtocol } from '@shopify/checkout-kit-protocol';
-import { CheckoutProtocolPayloads } from '@shopify/checkout-kit-protocol';
+import { CheckoutProtocolCatalogPayloads } from '@shopify/checkout-kit-protocol';
 import { ErrorResponse } from '@shopify/checkout-kit-protocol';
 import type { PropsWithChildren } from 'react';
 import { default as React_2 } from 'react';
@@ -185,9 +184,21 @@ export enum CheckoutNativeErrorType {
     UnknownError = "UnknownError"
 }
 
-export { CheckoutProtocol }
+// @public (undocumented)
+export const CheckoutProtocol: {
+    readonly complete: "ec.complete";
+    readonly error: "ec.error";
+    readonly lineItemsChange: "ec.line_items.change";
+    readonly messagesChange: "ec.messages.change";
+    readonly start: "ec.start";
+    readonly totalsChange: "ec.totals.change";
+};
 
-export { CheckoutProtocolPayloads }
+// @public (undocumented)
+export type CheckoutProtocolMethod = (typeof CheckoutProtocol)[keyof typeof CheckoutProtocol];
+
+// @public (undocumented)
+export type CheckoutProtocolPayloads = Pick<CheckoutProtocolCatalogPayloads, CheckoutProtocolMethod>;
 
 // @public (undocumented)
 export enum ColorScheme {

platforms/react-native/modules/@shopify/checkout-kit-react-native/ios/ProtocolRelay.swift

@@ -2,58 +2,67 @@ import Foundation
 #if COCOAPODS
     import ShopifyCheckoutKit
 
-    extension CheckoutProtocol.Client: @retroactive CheckoutCommunicationProtocol {}
+    extension CheckoutTransport.Client: @retroactive CheckoutCommunicationProtocol {}
 #else
     import ShopifyCheckoutProtocol
 #endif
 
+private enum Relay {
+    static let complete = GeneratedProtocolCatalog.ecComplete
+    static let error = GeneratedProtocolCatalog.ecError
+    static let lineItemsChange = GeneratedProtocolCatalog.ecLineItemsChange
+    static let messagesChange = GeneratedProtocolCatalog.ecMessagesChange
+    static let start = GeneratedProtocolCatalog.ecStart
+    static let totalsChange = GeneratedProtocolCatalog.ecTotalsChange
+}
+
 struct DispatchEnvelope<Payload: Encodable>: Encodable {
     let type: String
     let payload: Payload
 }
 
-/// Bridges native CheckoutProtocol notifications to the React Native onDispatch
+/// Bridges native CheckoutTransport notifications to the React Native onDispatch
 /// event stream. Payloads are emitted in protocol wire casing; JS performs the
 /// schema-aware conversion to the public camelCase shape with QuickType.
 let supportedProtocolRelayMethods = [
-    CheckoutProtocol.complete.method,
-    CheckoutProtocol.error.method,
-    CheckoutProtocol.lineItemsChange.method,
-    CheckoutProtocol.messagesChange.method,
-    CheckoutProtocol.start.method,
-    CheckoutProtocol.totalsChange.method
+    Relay.complete.method,
+    Relay.error.method,
+    Relay.lineItemsChange.method,
+    Relay.messagesChange.method,
+    Relay.start.method,
+    Relay.totalsChange.method
 ]
 
 func makeRelayClient(
     subscribedMethods: [String],
     dispatch: @escaping @MainActor @Sendable (String) -> Void
-) -> CheckoutProtocol.Client {
-    var client = CheckoutProtocol.Client()
+) -> CheckoutTransport.Client {
+    var client = CheckoutTransport.Client()
 
     for method in subscribedMethods {
         switch method {
-        case CheckoutProtocol.complete.method:
-            client = client.on(CheckoutProtocol.complete) { checkout in
+        case Relay.complete.method:
+            client = client.on(Relay.complete) { checkout in
                 forwardEnvelope(type: method, payload: checkout, dispatch: dispatch)
             }
-        case CheckoutProtocol.error.method:
-            client = client.on(CheckoutProtocol.error) { error in
+        case Relay.error.method:
+            client = client.on(Relay.error) { error in
                 forwardEnvelope(type: method, payload: error, dispatch: dispatch)
             }
-        case CheckoutProtocol.lineItemsChange.method:
-            client = client.on(CheckoutProtocol.lineItemsChange) { checkout in
+        case Relay.lineItemsChange.method:
+            client = client.on(Relay.lineItemsChange) { checkout in
                 forwardEnvelope(type: method, payload: checkout, dispatch: dispatch)
             }
-        case CheckoutProtocol.messagesChange.method:
-            client = client.on(CheckoutProtocol.messagesChange) { checkout in
+        case Relay.messagesChange.method:
+            client = client.on(Relay.messagesChange) { checkout in
                 forwardEnvelope(type: method, payload: checkout, dispatch: dispatch)
             }
-        case CheckoutProtocol.start.method:
-            client = client.on(CheckoutProtocol.start) { checkout in
+        case Relay.start.method:
+            client = client.on(Relay.start) { checkout in
                 forwardEnvelope(type: method, payload: checkout, dispatch: dispatch)
             }
-        case CheckoutProtocol.totalsChange.method:
-            client = client.on(CheckoutProtocol.totalsChange) { checkout in
+        case Relay.totalsChange.method:
+            client = client.on(Relay.totalsChange) { checkout in
                 forwardEnvelope(type: method, payload: checkout, dispatch: dispatch)
             }
         default:

platforms/react-native/modules/@shopify/checkout-kit-react-native/package.snapshot.json

@@ -66,6 +66,7 @@
   "lib/module/specs/NativeShopifyCheckoutKit.js.map",
   "lib/module/specs/RCTAcceleratedCheckoutButtonsNativeComponent.js",
   "lib/module/specs/RCTAcceleratedCheckoutButtonsNativeComponent.js.map",
+  "lib/typescript/src/_types/index.d.ts",
   "lib/typescript/src/components/AcceleratedCheckoutButtons.d.ts",
   "lib/typescript/src/components/AcceleratedCheckoutButtons.d.ts.map",
   "lib/typescript/src/configuration.d.ts",
@@ -96,8 +97,6 @@
   "node_modules/@shopify/checkout-kit-protocol/src/generated/ProtocolNotifications.ts",
   "node_modules/@shopify/checkout-kit-protocol/src/index.d.ts",
   "node_modules/@shopify/checkout-kit-protocol/src/index.ts",
-  "node_modules/@shopify/checkout-kit-protocol/src/notifications.d.ts",
-  "node_modules/@shopify/checkout-kit-protocol/src/notifications.ts",
   "package.json",
   "RNShopifyCheckoutKit.podspec",
   "src/components/AcceleratedCheckoutButtons.tsx",

platforms/react-native/modules/@shopify/checkout-kit-react-native/src/index.ts

@@ -47,6 +47,7 @@ import type {
 import {CheckoutProtocol} from './protocol';
 import type {
   Checkout,
+  CheckoutProtocolMethod,
   CheckoutProtocolPayloads,
   ErrorResponse,
   ProtocolHandlers,
@@ -407,6 +408,7 @@ export type {
   AndroidColors,
   Checkout,
   CheckoutException,
+  CheckoutProtocolMethod,
   CheckoutProtocolPayloads,
   Configuration,
   ErrorResponse,

platforms/react-native/modules/@shopify/checkout-kit-react-native/src/protocol.ts

@@ -1,15 +1,80 @@
-import type {CheckoutProtocolPayloads} from '@shopify/checkout-kit-protocol';
-
-export {
-  CheckoutProtocol,
-  decodeCheckoutProtocolPayload as decodeProtocolPayload,
+import {
+  checkoutProtocolCatalog,
+  checkoutProtocolCatalogPayloadDecoders,
+  type CheckoutProtocolCatalogPayloads,
 } from '@shopify/checkout-kit-protocol';
 
-export type {
-  Checkout,
-  CheckoutProtocolPayloads,
-  ErrorResponse,
-} from '@shopify/checkout-kit-protocol';
+export type {Checkout, ErrorResponse} from '@shopify/checkout-kit-protocol';
+
+type PublicCheckoutProtocolKey =
+  | 'complete'
+  | 'error'
+  | 'lineItemsChange'
+  | 'messagesChange'
+  | 'start'
+  | 'totalsChange';
+
+export const CheckoutProtocol = {
+  complete: checkoutProtocolCatalog.complete,
+  error: checkoutProtocolCatalog.error,
+  lineItemsChange: checkoutProtocolCatalog.lineItemsChange,
+  messagesChange: checkoutProtocolCatalog.messagesChange,
+  start: checkoutProtocolCatalog.start,
+  totalsChange: checkoutProtocolCatalog.totalsChange,
+} as const satisfies Pick<
+  typeof checkoutProtocolCatalog,
+  PublicCheckoutProtocolKey
+>;
+
+export type CheckoutProtocolMethod =
+  (typeof CheckoutProtocol)[keyof typeof CheckoutProtocol];
+
+export type CheckoutProtocolPayloads = Pick<
+  CheckoutProtocolCatalogPayloads,
+  CheckoutProtocolMethod
+>;
+
+type CheckoutProtocolPayloadDecoder<K extends keyof CheckoutProtocolPayloads> =
+  (payload: unknown) => CheckoutProtocolPayloads[K];
+
+const checkoutProtocolPayloadDecoders = {
+  [CheckoutProtocol.complete]:
+    checkoutProtocolCatalogPayloadDecoders[CheckoutProtocol.complete],
+  [CheckoutProtocol.error]:
+    checkoutProtocolCatalogPayloadDecoders[CheckoutProtocol.error],
+  [CheckoutProtocol.lineItemsChange]:
+    checkoutProtocolCatalogPayloadDecoders[CheckoutProtocol.lineItemsChange],
+  [CheckoutProtocol.messagesChange]:
+    checkoutProtocolCatalogPayloadDecoders[CheckoutProtocol.messagesChange],
+  [CheckoutProtocol.start]:
+    checkoutProtocolCatalogPayloadDecoders[CheckoutProtocol.start],
+  [CheckoutProtocol.totalsChange]:
+    checkoutProtocolCatalogPayloadDecoders[CheckoutProtocol.totalsChange],
+} satisfies {
+  [K in keyof CheckoutProtocolPayloads]: CheckoutProtocolPayloadDecoder<K>;
+};
+
+export function decodeProtocolPayload<K extends keyof CheckoutProtocolPayloads>(
+  method: K,
+  payload: unknown,
+): CheckoutProtocolPayloads[K];
+export function decodeProtocolPayload(
+  method: string,
+  payload: unknown,
+): CheckoutProtocolPayloads[keyof CheckoutProtocolPayloads] | undefined;
+export function decodeProtocolPayload(
+  method: string,
+  payload: unknown,
+): CheckoutProtocolPayloads[keyof CheckoutProtocolPayloads] | undefined {
+  const decoder = checkoutProtocolPayloadDecoders[
+    method as keyof typeof checkoutProtocolPayloadDecoders
+  ] as
+    | ((
+        payload: unknown,
+      ) => CheckoutProtocolPayloads[keyof CheckoutProtocolPayloads])
+    | undefined;
+  return decoder?.(payload);
+}
 
 export type ProtocolHandlers = Partial<{
   [K in keyof CheckoutProtocolPayloads]: (

platforms/react-native/snapshot.json

@@ -0,0 +1,117 @@
+[
+  "android/build.gradle",
+  "android/gradle.properties",
+  "android/proguard-rules.pro",
+  "android/src/main/AndroidManifest.xml",
+  "android/src/main/AndroidManifestNew.xml",
+  "android/src/main/java/com/shopify/reactnative/checkoutkit/CustomCheckoutListener.java",
+  "android/src/main/java/com/shopify/reactnative/checkoutkit/DispatchEventTypes.java",
+  "android/src/main/java/com/shopify/reactnative/checkoutkit/DispatchHandle.java",
+  "android/src/main/java/com/shopify/reactnative/checkoutkit/ProtocolRelay.kt",
+  "android/src/main/java/com/shopify/reactnative/checkoutkit/ShopifyCheckoutKitModule.java",
+  "android/src/main/java/com/shopify/reactnative/checkoutkit/ShopifyCheckoutKitPackage.java",
+  "android/src/test/java/com/shopify/reactnative/checkoutkit/ProtocolRelayTest.kt",
+  "ios/AcceleratedCheckoutButtons.swift",
+  "ios/AcceleratedCheckoutButtons+Extensions.swift",
+  "ios/Package.swift",
+  "ios/ProtocolRelay.swift",
+  "ios/ShopifyCheckoutKit-Bridging-Header.h",
+  "ios/ShopifyCheckoutKit.mm",
+  "ios/ShopifyCheckoutKit.swift",
+  "ios/ShopifyCheckoutKit+EventSerialization.swift",
+  "ios/ShopifyCheckoutKit+Extensions.swift",
+  "ios/Tests/ProtocolRelayTests.swift",
+  "lib/commonjs/components/AcceleratedCheckoutButtons.js",
+  "lib/commonjs/components/AcceleratedCheckoutButtons.js.map",
+  "lib/commonjs/configuration.js",
+  "lib/commonjs/configuration.js.map",
+  "lib/commonjs/context.js",
+  "lib/commonjs/context.js.map",
+  "lib/commonjs/dispatch-events.js",
+  "lib/commonjs/dispatch-events.js.map",
+  "lib/commonjs/enums.js",
+  "lib/commonjs/enums.js.map",
+  "lib/commonjs/errors.js",
+  "lib/commonjs/errors.js.map",
+  "lib/commonjs/index.d.js",
+  "lib/commonjs/index.d.js.map",
+  "lib/commonjs/index.js",
+  "lib/commonjs/index.js.map",
+  "lib/commonjs/present-dispatcher.js",
+  "lib/commonjs/present-dispatcher.js.map",
+  "lib/commonjs/protocol.js",
+  "lib/commonjs/protocol.js.map",
+  "lib/commonjs/specs/NativeShopifyCheckoutKit.js",
+  "lib/commonjs/specs/NativeShopifyCheckoutKit.js.map",
+  "lib/commonjs/specs/RCTAcceleratedCheckoutButtonsNativeComponent.js",
+  "lib/commonjs/specs/RCTAcceleratedCheckoutButtonsNativeComponent.js.map",
+  "lib/module/components/AcceleratedCheckoutButtons.js",
+  "lib/module/components/AcceleratedCheckoutButtons.js.map",
+  "lib/module/configuration.js",
+  "lib/module/configuration.js.map",
+  "lib/module/context.js",
+  "lib/module/context.js.map",
+  "lib/module/dispatch-events.js",
+  "lib/module/dispatch-events.js.map",
+  "lib/module/enums.js",
+  "lib/module/enums.js.map",
+  "lib/module/errors.js",
+  "lib/module/errors.js.map",
+  "lib/module/index.d.js",
+  "lib/module/index.d.js.map",
+  "lib/module/index.js",
+  "lib/module/index.js.map",
+  "lib/module/present-dispatcher.js",
+  "lib/module/present-dispatcher.js.map",
+  "lib/module/protocol.js",
+  "lib/module/protocol.js.map",
+  "lib/module/specs/NativeShopifyCheckoutKit.js",
+  "lib/module/specs/NativeShopifyCheckoutKit.js.map",
+  "lib/module/specs/RCTAcceleratedCheckoutButtonsNativeComponent.js",
+  "lib/module/specs/RCTAcceleratedCheckoutButtonsNativeComponent.js.map",
+  "lib/typescript/src/_types/index.d.ts",
+  "lib/typescript/src/components/AcceleratedCheckoutButtons.d.ts",
+  "lib/typescript/src/components/AcceleratedCheckoutButtons.d.ts.map",
+  "lib/typescript/src/configuration.d.ts",
+  "lib/typescript/src/configuration.d.ts.map",
+  "lib/typescript/src/context.d.ts",
+  "lib/typescript/src/context.d.ts.map",
+  "lib/typescript/src/dispatch-events.d.ts",
+  "lib/typescript/src/dispatch-events.d.ts.map",
+  "lib/typescript/src/enums.d.ts",
+  "lib/typescript/src/enums.d.ts.map",
+  "lib/typescript/src/errors.d.ts",
+  "lib/typescript/src/errors.d.ts.map",
+  "lib/typescript/src/index.d.ts",
+  "lib/typescript/src/index.d.ts.map",
+  "lib/typescript/src/present-dispatcher.d.ts",
+  "lib/typescript/src/present-dispatcher.d.ts.map",
+  "lib/typescript/src/protocol.d.ts",
+  "lib/typescript/src/protocol.d.ts.map",
+  "lib/typescript/src/specs/NativeShopifyCheckoutKit.d.ts",
+  "lib/typescript/src/specs/NativeShopifyCheckoutKit.d.ts.map",
+  "lib/typescript/src/specs/RCTAcceleratedCheckoutButtonsNativeComponent.d.ts",
+  "lib/typescript/src/specs/RCTAcceleratedCheckoutButtonsNativeComponent.d.ts.map",
+  "LICENSE",
+  "node_modules/@shopify/checkout-kit-protocol/package.json",
+  "node_modules/@shopify/checkout-kit-protocol/src/generated/Models.d.ts",
+  "node_modules/@shopify/checkout-kit-protocol/src/generated/Models.ts",
+  "node_modules/@shopify/checkout-kit-protocol/src/generated/ProtocolNotifications.d.ts",
+  "node_modules/@shopify/checkout-kit-protocol/src/generated/ProtocolNotifications.ts",
+  "node_modules/@shopify/checkout-kit-protocol/src/index.d.ts",
+  "node_modules/@shopify/checkout-kit-protocol/src/index.ts",
+  "package.json",
+  "RNShopifyCheckoutKit.podspec",
+  "src/components/AcceleratedCheckoutButtons.tsx",
+  "src/configuration.ts",
+  "src/context.tsx",
+  "src/dispatch-events.ts",
+  "src/enums.ts",
+  "src/errors.ts",
+  "src/index.d.ts",
+  "src/index.ts",
+  "src/present-dispatcher.ts",
+  "src/protocol.ts",
+  "src/specs/NativeShopifyCheckoutKit.ts",
+  "src/specs/RCTAcceleratedCheckoutButtonsNativeComponent.ts"
+]