Skip to content

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

Open
Juanita-Dash wants to merge 1 commit into
mainfrom
rename-csk-to-checkout-kit
Open

Rename Checkout Sheet Kit to Checkout Kit (React Native)#483
Juanita-Dash wants to merge 1 commit into
mainfrom
rename-csk-to-checkout-kit

Conversation

@Juanita-Dash
Copy link
Copy Markdown
Contributor

@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)
  • Xcode project upstream-pod search paths in sample/ios/ReactNative.xcodeproj/project.pbxproj (libShopifyCheckoutSheetKit.a, ${PODS_CONFIGURATION_BUILD_DIR}/ShopifyCheckoutSheetKit, $(SRCROOT)/Pods/ShopifyCheckoutSheetKit/**, and the corresponding SWIFT_INCLUDE_PATHS entries) — kept aligned with the upstream pod's actual product name. The bridge pod paths (RNShopifyCheckoutKit) and renamed test file (ShopifyCheckoutKitTests.swift) in the same pbxproj are renamed in this PR.

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

Important

GitHub URLs and deep-links

All https://github.com/Shopify/checkout-kit/... references in this PR (package.json homepage/repository, podspec s.source, README badges, CONTRIBUTING/PR template links, etc.) currently point at a repo that doesn't exist publicly yet — they will 404 until the cross-platform monorepo migration completes (interim host: shopify-playground/checkout-kit; final: Shopify/checkout-kit once made public).

The npm repository.directory field in modules/@shopify/checkout-kit/package.json (react-native/modules/@shopify/checkout-kit) is anticipatory in the same way — it assumes the future monorepo layout where react-native/ is a sibling of swift/ and android/. npm's "View source" deep-link on the package page will resolve correctly once the monorepo lands.

This is the same anticipatory pattern used by the already-merged Swift and Android rename PRs (swift, android) — keeping the three rename PRs consistent.

A separate follow-up PR (cross-platform, coordinated with the monorepo restructure into swift/, android/, react-native/ subdirs) will fix the deep-links (/blob/main/..., /actions/...) once the file paths in the new monorepo layout are settled.

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
Contributor Author

Juanita-Dash commented May 6, 2026

@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
Comment thread .github/actions/install-cocoapods/action.yml Outdated
@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
@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
@Juanita-Dash Juanita-Dash force-pushed the rename-csk-to-checkout-kit branch from 1215b82 to b047936 Compare May 7, 2026 15:28
@Juanita-Dash Juanita-Dash marked this pull request as ready for review May 7, 2026 15:40
@Juanita-Dash Juanita-Dash requested a review from a team as a code owner May 7, 2026 15:40
@Juanita-Dash Juanita-Dash force-pushed the rename-csk-to-checkout-kit branch from b047936 to 7229059 Compare May 7, 2026 16:26
@Juanita-Dash Juanita-Dash requested a review from markmur May 7, 2026 16:48
Renames the React Native bridge surface (npm package, RN module name, TS
API, source files, internal symbols) from "Checkout Sheet Kit" to
"Checkout Kit".

Upstream native dependencies (`ShopifyCheckoutSheetKit` iOS pod and
`com.shopify:checkout-sheet-kit` Android Maven artifact) are intentionally
left on their current names since those artifacts have not been
republished under the new name yet — that's tracked as a follow-up.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@Juanita-Dash Juanita-Dash force-pushed the rename-csk-to-checkout-kit branch from 7229059 to 83e43ab Compare May 7, 2026 17:27
Juanita-Dash added a commit to Shopify/checkout-kit that referenced this pull request May 7, 2026
Imports the React Native bridge into the monorepo at `react-native/`,
already renamed from "Checkout Sheet Kit" to "Checkout Kit" — parallel to
`Shopify/checkout-sheet-kit-react-native#483`.

Renamed in this PR:
- npm package: `@shopify/checkout-sheet-kit` → `@shopify/checkout-kit`
- iOS bridge pod / podspec: `RNShopifyCheckoutSheetKit` → `RNShopifyCheckoutKit`
- Android Java package: `com.shopify.reactnative.checkoutsheetkit` → `com.shopify.reactnative.checkoutkit`
- Codegen spec name: `RNShopifyCheckoutSheetKitSpec` → `RNShopifyCheckoutKitSpec`
- TS public API: `ShopifyCheckoutSheet*` → `ShopifyCheckout*`,
  `useShopifyCheckoutSheet` → `useShopifyCheckout`,
  `ShopifyCheckoutSheetProvider` → `ShopifyCheckoutProvider`
- Source files: `ShopifyCheckoutSheetKit*.swift` → `ShopifyCheckoutKit*.swift`,
  `ShopifyCheckoutSheetKitModule.java` → `ShopifyCheckoutKitModule.java`

Intentionally NOT renamed (deferred — see callouts in the original PR
description on the old repo):
- iOS Pod dep `ShopifyCheckoutSheetKit ~> 3.8.0` (artifact not yet
  published under the new name)
- Android Maven artifact `com.shopify:checkout-sheet-kit` (same)
- Bridge Swift `import ShopifyCheckoutSheetKit` and framework calls
- Bridge Java `com.shopify.checkoutsheetkit.*` package and symbols
  (`ShopifyCheckoutSheetKit`, `CheckoutSheetKitDialog`, `CheckoutSheetKitException`)
- Xcode upstream-pod search paths in `project.pbxproj`
  (`libShopifyCheckoutSheetKit.a`, `${PODS_CONFIGURATION_BUILD_DIR}/ShopifyCheckoutSheetKit`,
  `$(SRCROOT)/Pods/ShopifyCheckoutSheetKit/**`)

Out of scope for this PR (migration plumbing, follow-up):
- React Native CI workflows (need to be re-authored at monorepo
  `.github/workflows/` with `react-native-*` prefix to match the Swift
  and Android conventions)
- Adding RN entries to monorepo `.github/dependabot.yml`
- Deep-link path-prefix fixes (`/blob/main/modules/...` →
  `/blob/main/react-native/modules/...`) — coordinated cross-platform
  follow-up

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@kyle-schellen kyle-schellen self-requested a review May 7, 2026 19:11
Juanita-Dash added a commit to Shopify/checkout-kit that referenced this pull request May 8, 2026
Renames the React Native bridge in react-native/ from Shopify Checkout
Sheet Kit to Shopify Checkout Kit. Mirrors the parallel rename in the
source repo (Shopify/checkout-sheet-kit-react-native#483) applied to the
v4.0.0 import (#31).

Stacked on rn-import-source-v4 (PR #31). When #31 merges, this will be
auto-retargeted onto main with the rename diff intact.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Juanita-Dash added a commit to Shopify/checkout-kit that referenced this pull request May 8, 2026
Renames the React Native bridge in react-native/ from Shopify Checkout
Sheet Kit to Shopify Checkout Kit. Mirrors the parallel rename in the
source repo (Shopify/checkout-sheet-kit-react-native#483) applied to the
v4.0.0 import (#31).

Stacked on rn-import-source-v4 (PR #31). When #31 merges, this will be
auto-retargeted onto main with the rename diff intact.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Juanita-Dash added a commit to Shopify/checkout-kit that referenced this pull request May 8, 2026
Renames the React Native bridge in react-native/ from Shopify Checkout
Sheet Kit to Shopify Checkout Kit. Mirrors the parallel rename in the
source repo (Shopify/checkout-sheet-kit-react-native#483) applied to the
v4.0.0 import (#31).

Stacked on rn-import-source-v4 (PR #31). When #31 merges, this will be
auto-retargeted onto main with the rename diff intact.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Juanita-Dash added a commit to Shopify/checkout-kit that referenced this pull request May 11, 2026
Renames the React Native bridge in react-native/ from Shopify Checkout
Sheet Kit to Shopify Checkout Kit. Mirrors the parallel rename in the
source repo (Shopify/checkout-sheet-kit-react-native#483) applied to the
v4.0.0 import (#31).

Stacked on rn-import-source-v4 (PR #31). When #31 merges, this will be
auto-retargeted onto main with the rename diff intact.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Juanita-Dash added a commit to Shopify/checkout-kit that referenced this pull request May 11, 2026
Renames the React Native bridge in react-native/ from Shopify Checkout
Sheet Kit to Shopify Checkout Kit. Mirrors the parallel rename in the
source repo (Shopify/checkout-sheet-kit-react-native#483) applied to the
v4.0.0 import (#31).

Stacked on rn-import-source-v4 (PR #31). When #31 merges, this will be
auto-retargeted onto main with the rename diff intact.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Juanita-Dash added a commit to Shopify/checkout-kit that referenced this pull request May 11, 2026
Renames the React Native bridge in react-native/ from Shopify Checkout
Sheet Kit to Shopify Checkout Kit. Mirrors the parallel rename in the
source repo (Shopify/checkout-sheet-kit-react-native#483) applied to the
v4.0.0 import (#31).

Stacked on rn-import-source-v4 (PR #31). When #31 merges, this will be
auto-retargeted onto main with the rename diff intact.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Juanita-Dash added a commit to Shopify/checkout-kit that referenced this pull request May 12, 2026
Renames the React Native bridge in react-native/ from Shopify Checkout
Sheet Kit to Shopify Checkout Kit. Mirrors the parallel rename in the
source repo (Shopify/checkout-sheet-kit-react-native#483) applied to the
v4.0.0 import (#31).

Stacked on rn-import-source-v4 (PR #31). When #31 merges, this will be
auto-retargeted onto main with the rename diff intact.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Juanita-Dash added a commit to Shopify/checkout-kit that referenced this pull request May 12, 2026
Renames the React Native bridge in react-native/ from Shopify Checkout
Sheet Kit to Shopify Checkout Kit. Mirrors the parallel rename in the
source repo (Shopify/checkout-sheet-kit-react-native#483) applied to the
v4.0.0 import (#31).

Stacked on rn-import-source-v4 (PR #31). When #31 merges, this will be
auto-retargeted onto main with the rename diff intact.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Juanita-Dash added a commit to Shopify/checkout-kit that referenced this pull request May 12, 2026
Renames the React Native bridge in react-native/ from Shopify Checkout
Sheet Kit to Shopify Checkout Kit. Mirrors the parallel rename in the
source repo (Shopify/checkout-sheet-kit-react-native#483) applied to the
v4.0.0 import (#31).

Stacked on rn-import-source-v4 (PR #31). When #31 merges, this will be
auto-retargeted onto main with the rename diff intact.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Juanita-Dash added a commit to Shopify/checkout-kit that referenced this pull request May 12, 2026
Renames the React Native bridge in react-native/ from Shopify Checkout
Sheet Kit to Shopify Checkout Kit. Mirrors the parallel rename in the
source repo (Shopify/checkout-sheet-kit-react-native#483) applied to the
v4.0.0 import (#31).

Stacked on rn-import-source-v4 (PR #31). When #31 merges, this will be
auto-retargeted onto main with the rename diff intact.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Juanita-Dash added a commit to Shopify/checkout-kit that referenced this pull request May 12, 2026
Renames the React Native bridge in react-native/ from Shopify Checkout
Sheet Kit to Shopify Checkout Kit. Mirrors the parallel rename in the
source repo (Shopify/checkout-sheet-kit-react-native#483) applied to the
v4.0.0 import (#31).

Stacked on rn-import-source-v4 (PR #31). When #31 merges, this will be
auto-retargeted onto main with the rename diff intact.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Juanita-Dash added a commit to Shopify/checkout-kit that referenced this pull request May 12, 2026
Renames the React Native bridge in react-native/ from Shopify Checkout
Sheet Kit to Shopify Checkout Kit. Mirrors the parallel rename in the
source repo (Shopify/checkout-sheet-kit-react-native#483) applied to the
v4.0.0 import (#31).

Stacked on rn-import-source-v4 (PR #31). When #31 merges, this will be
auto-retargeted onto main with the rename diff intact.

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