Skip to content

feat: add types to respondWith #423

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
kieran-osgood-shopify wants to merge 1 commit into
base: prototype/development
Choose a base branch
from
+20 −3
Open

feat: add types to respondWith #423

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 10 additions & 3 deletions modules/@shopify/checkout-sheet-kit/src/ShopifyCheckoutEventProvider.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,15 @@ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SO

import React, {createContext, useContext, useRef, useCallback} from 'react';
import {UIManager, findNodeHandle} from 'react-native';
import type {CheckoutEventResponsePayload} from './events.d';

interface CheckoutEventContextType {
registerWebView: (webViewRef: React.RefObject<any>) => void;
unregisterWebView: () => void;
respondToEvent: (eventId: string, response: any) => Promise<boolean>;
respondToEvent: (
eventId: string,
response: CheckoutEventResponsePayload,
) => Promise<boolean>;
}

const CheckoutEventContext = createContext<CheckoutEventContextType | null>(
Expand Down Expand Up @@ -52,7 +56,10 @@ export const ShopifyCheckoutEventProvider = ({
}, []);

const respondToEvent = useCallback(
async (eventId: string, response: any): Promise<boolean> => {
async (
eventId: string,
response: CheckoutEventResponsePayload,
): Promise<boolean> => {
Comment on lines +59 to +62
Copy link
Contributor

@markmur markmur Jan 13, 2026

Choose a reason for hiding this comment

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

Does this function need to be async? The contents look synchronous to me, unless the UIManager calls are async but we're not awaiting them

Copy link
Contributor Author

@kieran-osgood-shopify kieran-osgood-shopify Jan 13, 2026

Choose a reason for hiding this comment

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

Good point - no longer needs async (previously did)
I'm used to eslint catching that I'm setting up another PR with typescript-eslint so I can add require-await to avoid this mistake in future

Image

if (!webViewRef.current?.current) {
return false;
}
Expand Down Expand Up @@ -112,7 +119,7 @@ export function useShopifyEvent(eventId: string) {
return {
id: eventId,
respondWith: useCallback(
async (response: any) => {
async (response: CheckoutEventResponsePayload) => {
if (!eventContext) {
return false;
}
Expand Down
9 changes: 9 additions & 0 deletions modules/@shopify/checkout-sheet-kit/src/events.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -596,3 +596,12 @@ export interface CheckoutSubmitStartResponsePayload {
*/
errors?: CheckoutResponseError[];
}

/**
* Union type of all checkout event response payloads.
* Use with ShopifyCheckoutEventProvider.respondToEvent() or useShopifyEvent().respondWith()
*/
export type CheckoutEventResponsePayload =
| CheckoutAddressChangeStartResponsePayload
| CheckoutPaymentMethodChangeStartResponsePayload
| CheckoutSubmitStartResponsePayload;
1 change: 1 addition & 0 deletions modules/@shopify/checkout-sheet-kit/src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -501,6 +501,7 @@ export type {
CheckoutAddressChangeStartEvent,
CheckoutAddressChangeStartResponsePayload,
CheckoutCompleteEvent,
CheckoutEventResponsePayload,
CheckoutPaymentMethodChangeStartEvent,
CheckoutPaymentMethodChangeStartResponsePayload,
CheckoutResponseError,
Expand Down
Loading