Skip to content

Rename Checkout Sheet Kit to Checkout Kit (React Native)#483

Draft
Juanita-Dash wants to merge 2 commits intomainfrom
rename-csk-to-checkout-kit
Draft

Rename Checkout Sheet Kit to Checkout Kit (React Native)#483
Juanita-Dash wants to merge 2 commits intomainfrom
rename-csk-to-checkout-kit

Conversation

@Juanita-Dash
Copy link
Copy Markdown

@Juanita-Dash Juanita-Dash commented May 6, 2026

Part of https://github.com/shop/issues-checkout-kit/issues/883

Important

Scope of this PR vs. follow-up work

This PR renames the React Native bridge (npm package, RN module, TS public API, source files, internal Java/Swift symbols). It intentionally does not rename the upstream native dependencies, because com.shopify:checkout-kit (Android Maven) and ShopifyCheckoutKit (iOS CocoaPod, 3.x) are not yet published — only com.shopify:checkout-sheet-kit and ShopifyCheckoutSheetKit exist today, so renaming them here would break CI with Could not find / None of your spec sources contain a spec satisfying the dependency errors.

A follow-up PR will rename:

  • iOS podspec dep: ShopifyCheckoutSheetKit ~> 3.8.0ShopifyCheckoutKit
  • Android gradle dep: com.shopify:checkout-sheet-kitcom.shopify:checkout-kit
  • Bridge Swift import ShopifyCheckoutSheetKit and all ShopifyCheckoutSheetKit.* framework calls (in modules/@shopify/checkout-kit/ios/*.swift and sample/ios/ReactNativeTests/*.swift)

...once those upstream artifacts are published under their new names.

What changes are you making?

Renames the React Native bridge from Shopify Checkout Sheet Kit to Shopify Checkout Kit.

Package and bridge (renamed in this PR)

  • npm package: @shopify/checkout-sheet-kit@shopify/checkout-kit
  • iOS pod / podspec: RNShopifyCheckoutSheetKitRNShopifyCheckoutKit
  • Android Java package: com.shopify.reactnative.checkoutsheetkitcom.shopify.reactnative.checkoutkit
  • Codegen spec name: RNShopifyCheckoutSheetKitSpecRNShopifyCheckoutKitSpec

TypeScript public API (renamed in this PR — drops "Sheet" everywhere)

  • Class: ShopifyCheckoutSheetShopifyCheckout
  • Provider: ShopifyCheckoutSheetProviderShopifyCheckoutProvider
  • Hook: useShopifyCheckoutSheetuseShopifyCheckout
  • Context: ShopifyCheckoutSheetContextShopifyCheckoutContext

Source files and directories (renamed in this PR)

  • modules/@shopify/checkout-sheet-kit/modules/@shopify/checkout-kit/
  • ShopifyCheckoutSheetKit*.swiftShopifyCheckoutKit*.swift
  • ShopifyCheckoutSheetKitModule.java / Package.javaShopifyCheckoutKitModule.java / Package.java
  • NativeShopifyCheckoutSheetKit.tsNativeShopifyCheckoutKit.ts

Upstream native deps (deferred to a follow-up PR — see callout above)

  • iOS Pod dep ShopifyCheckoutSheetKit ~> 3.8.0 → unchanged (would-be ShopifyCheckoutKit)
  • Android Maven artifact com.shopify:checkout-sheet-kit → unchanged (would-be com.shopify:checkout-kit)

Not changed (cross-team web checkout contracts)

  • ShopifyCheckoutSDK/<version> user-agent — parsed by web checkout
  • window.MobileCheckoutSdk JS bridge global — defined by web checkout
  • checkout-sdk.myshopify.com test fixture URLs — not a branding reference

How to test

  1. Lints + tests (all passing locally):

    pnpm module lint
    pnpm sample lint
    pnpm test
    ./scripts/lint_swift
  2. iOS sample: pnpm pod-install && pnpm ios

  3. Android sample: pnpm android

  4. Consumer migration check — apps importing the old library will need to:

    • Update package: @shopify/checkout-sheet-kit@shopify/checkout-kit
    • Update imports: ShopifyCheckoutSheetShopifyCheckout, useShopifyCheckoutSheetuseShopifyCheckout, ShopifyCheckoutSheetProviderShopifyCheckoutProvider

Copy link
Copy Markdown
Author

Juanita-Dash commented May 6, 2026

Warning

This pull request is not mergeable via GitHub because a downstack PR is open. Once all requirements are satisfied, merge this PR as a stack on Graphite.
Learn more

This stack of pull requests is managed by Graphite. Learn more about stacking.

@Juanita-Dash Juanita-Dash force-pushed the rename-csk-to-checkout-kit branch from fb2e013 to b3d5d4d Compare May 6, 2026 18:38
@Juanita-Dash Juanita-Dash self-assigned this May 6, 2026
@kieran-osgood-shopify kieran-osgood-shopify changed the base branch from cx-rn-new-arch-v4 to graphite-base/483 May 6, 2026 18:50
path: |
sample/ios/Pods
key: ${{ runner.os }}-cocoapods-${{ hashFiles('sample/ios/Podfile.lock', 'sample/Gemfile.lock', 'sample/Gemfile', 'package.json', 'sample/package.json', 'modules/@shopify/checkout-sheet-kit/package.json', 'pnpm-lock.yaml') }}
key: ${{ runner.os }}-cocoapods-${{ hashFiles('sample/ios/Podfile.lock', 'sample/Gemfile.lock', 'sample/Gemfile', 'package.json', 'sample/package.json', 'modules//checkout-kit/package.json', 'pnpm-lock.yaml') }}
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
key: ${{ runner.os }}-cocoapods-${{ hashFiles('sample/ios/Podfile.lock', 'sample/Gemfile.lock', 'sample/Gemfile', 'package.json', 'sample/package.json', 'modules//checkout-kit/package.json', 'pnpm-lock.yaml') }}
key: ${{ runner.os }}-cocoapods-${{ hashFiles('sample/ios/Podfile.lock', 'sample/Gemfile.lock', 'sample/Gemfile', 'package.json', 'sample/package.json', 'modules/@shopify/checkout-kit/package.json', 'pnpm-lock.yaml') }}

Copy link
Copy Markdown
Author

@Juanita-Dash Juanita-Dash May 6, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yea, saw this in a few places where the string replacement got messed up by claude and the /@shopify was dropped. Fixing as we speak

@Juanita-Dash Juanita-Dash force-pushed the rename-csk-to-checkout-kit branch from b3d5d4d to 3401bdf Compare May 6, 2026 19:28
@kieran-osgood-shopify kieran-osgood-shopify force-pushed the rename-csk-to-checkout-kit branch from 3401bdf to 0a48c04 Compare May 6, 2026 20:15
@graphite-app graphite-app Bot changed the base branch from graphite-base/483 to cx-rn-new-arch-v4 May 6, 2026 20:15
@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 6, 2026

Coverage Report

Lines Statements Branches Functions
Coverage: 99%
99.53% (214/215) 95.96% (119/124) 100% (64/64)

@kieran-osgood-shopify kieran-osgood-shopify force-pushed the rename-csk-to-checkout-kit branch from 0a48c04 to abde1c1 Compare May 6, 2026 20:16
@kieran-osgood-shopify kieran-osgood-shopify changed the base branch from cx-rn-new-arch-v4 to graphite-base/483 May 6, 2026 20:50
@kieran-osgood-shopify kieran-osgood-shopify force-pushed the rename-csk-to-checkout-kit branch from abde1c1 to 912d71b Compare May 6, 2026 20:50
@graphite-app graphite-app Bot changed the base branch from graphite-base/483 to main May 6, 2026 20:50
Mirrors the Swift (shopify-playground/checkout-kit#22) and Android
(shopify-playground/checkout-kit#10) renames. Drops "Sheet" from the
product name across the React Native bridge:

- Package: @shopify/checkout-sheet-kit -> @shopify/checkout-kit
- Native module: ShopifyCheckoutSheetKit -> ShopifyCheckoutKit
- iOS pod / spec: RNShopifyCheckoutSheetKit -> RNShopifyCheckoutKit
- Android Java pkg: com.shopify.reactnative.checkoutsheetkit ->
  com.shopify.reactnative.checkoutkit
- Android Gradle dep: com.shopify:checkout-sheet-kit ->
  com.shopify:checkout-kit (depends on Android PR #10 publishing)
- TS API: ShopifyCheckoutSheet -> ShopifyCheckout, useShopifyCheckoutSheet
  -> useShopifyCheckout, ShopifyCheckoutSheetProvider ->
  ShopifyCheckoutProvider
- Codegen spec: RNShopifyCheckoutSheetKitSpec -> RNShopifyCheckoutKitSpec
- Repo dir name (checkout-sheet-kit-react-native) is preserved for now;
  separate effort.

Carve-outs preserved: ShopifyCheckoutSDK user-agent,
window.MobileCheckoutSdk, checkout-sdk.myshopify.com.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@kieran-osgood-shopify kieran-osgood-shopify force-pushed the rename-csk-to-checkout-kit branch from 912d71b to 7fabb05 Compare May 6, 2026 20:50
…eet-kit)

Revert iOS Pod and Android Maven dependency names to their currently-published
upstream identifiers. The npm package, RN module names, and TS public API stay
renamed to "checkout kit". A follow-up PR will rename the upstream native deps
once those artifacts publish under com.shopify:checkout-kit and ShopifyCheckoutKit.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants