@shopify/shop-minis-react 0.0.0-snapshot.20251222174301 → 0.0.0-snapshot.20251224113248

package/src/hooks/intents/useBarcodeScanner.ts

@@ -1,43 +0,0 @@
-import {
-  useHandleIntent,
-  HandleIntentOptions,
-} from '../../internal/useHandleIntent'
-import {useShopIntents} from '../../internal/useShopIntents'
-
-import type {
-  ScanBarcodeIntentParams,
-  ScanBarcodeIntentResult,
-} from '@shopify/shop-minis-platform'
-
-/**
- * Hook to scan barcodes or QR codes
- *
- * This intent opens the camera to scan barcodes or QR codes.
- *
- * @example
- * const scanBarcode = useBarcodeScanner({
- *   onCancel: () => console.log('User cancelled'),
- * })
- *
- * const result = await scanBarcode({
- *   types: ['qr', 'ean13'],
- *   instruction: 'Scan product barcode'
- * })
- *
- * if (result) {
- *   console.log('Scanned:', result.barcodes)
- * }
- */
-export const useBarcodeScanner = (
-  options?: HandleIntentOptions<ScanBarcodeIntentResult>
-) => {
-  const intents = useShopIntents()
-  return useHandleIntent(intents.scanBarcode, options)
-}
-
-/**
- * Type helper for the barcode scanner function
- */
-export type BarcodeScannerFunction = (
-  params: ScanBarcodeIntentParams
-) => Promise<ScanBarcodeIntentResult | void>

package/src/hooks/intents/useContentShare.ts

@@ -1,47 +0,0 @@
-import {
-  useHandleIntent,
-  HandleIntentOptions,
-} from '../../internal/useHandleIntent'
-import {useShopIntents} from '../../internal/useShopIntents'
-
-import type {
-  ShareContentIntentParams,
-  ShareContentIntentResult,
-} from '@shopify/shop-minis-platform'
-
-/**
- * Hook to share content via the Shop app's native share sheet
- *
- * This intent opens the native share sheet to let the user
- * share content to various platforms.
- *
- * @example
- * const shareContent = useContentShare({
- *   onCancel: () => console.log('User cancelled sharing'),
- * })
- *
- * const result = await shareContent({
- *   type: 'product',
- *   content: {
- *     title: 'Check out this product!',
- *     url: 'https://shop.app/products/123'
- *   }
- * })
- *
- * if (result?.shared) {
- *   console.log('Content shared to:', result.platform)
- * }
- */
-export const useContentShare = (
-  options?: HandleIntentOptions<ShareContentIntentResult>
-) => {
-  const intents = useShopIntents()
-  return useHandleIntent(intents.shareContent, options)
-}
-
-/**
- * Type helper for the content share function
- */
-export type ContentShareFunction = (
-  params: ShareContentIntentParams
-) => Promise<ShareContentIntentResult | void>

package/src/hooks/intents/useImageCapture.ts

@@ -1,45 +0,0 @@
-import {
-  useHandleIntent,
-  HandleIntentOptions,
-} from '../../internal/useHandleIntent'
-import {useShopIntents} from '../../internal/useShopIntents'
-
-import type {
-  CaptureImageIntentParams,
-  CaptureImageIntentResult,
-} from '@shopify/shop-minis-platform'
-
-/**
- * Hook to request user to capture or select images
- *
- * This intent opens the camera or photo gallery to let the user
- * capture or select one or more images.
- *
- * @example
- * const captureImage = useImageCapture({
- *   onCancel: () => console.log('User cancelled'),
- * })
- *
- * const result = await captureImage({
- *   source: 'camera',
- *   quality: 0.8,
- *   maxWidth: 1920
- * })
- *
- * if (result) {
- *   console.log('Captured images:', result.images)
- * }
- */
-export const useImageCapture = (
-  options?: HandleIntentOptions<CaptureImageIntentResult>
-) => {
-  const intents = useShopIntents()
-  return useHandleIntent(intents.captureImage, options)
-}
-
-/**
- * Type helper for the image capture function
- */
-export type ImageCaptureFunction = (
-  params: CaptureImageIntentParams
-) => Promise<CaptureImageIntentResult | void>

package/src/hooks/intents/useLocationSelection.ts

@@ -1,45 +0,0 @@
-import {
-  useHandleIntent,
-  HandleIntentOptions,
-} from '../../internal/useHandleIntent'
-import {useShopIntents} from '../../internal/useShopIntents'
-
-import type {
-  SelectLocationIntentParams,
-  SelectLocationIntentResult,
-} from '@shopify/shop-minis-platform'
-
-/**
- * Hook to request user to select a location
- *
- * This intent shows a map interface where the user can select
- * a location and optionally get address information.
- *
- * @example
- * const selectLocation = useLocationSelection({
- *   onCancel: () => console.log('User cancelled'),
- * })
- *
- * const result = await selectLocation({
- *   title: 'Select delivery location',
- *   locationType: 'address'
- * })
- *
- * if (result) {
- *   console.log('Selected location:', result.coordinates)
- *   console.log('Address:', result.address?.formattedAddress)
- * }
- */
-export const useLocationSelection = (
-  options?: HandleIntentOptions<SelectLocationIntentResult>
-) => {
-  const intents = useShopIntents()
-  return useHandleIntent(intents.selectLocation, options)
-}
-
-/**
- * Type helper for the location selection function
- */
-export type LocationSelectionFunction = (
-  params: SelectLocationIntentParams
-) => Promise<SelectLocationIntentResult | void>

package/src/hooks/intents/usePaymentRequest.ts

@@ -1,47 +0,0 @@
-import {
-  useHandleIntent,
-  HandleIntentOptions,
-} from '../../internal/useHandleIntent'
-import {useShopIntents} from '../../internal/useShopIntents'
-
-import type {
-  RequestPaymentIntentParams,
-  RequestPaymentIntentResult,
-} from '@shopify/shop-minis-platform'
-
-/**
- * Hook to request payment from user
- *
- * This intent opens the Shop app's payment flow to process a payment.
- *
- * **Note:** This intent requires special permissions and may have rate limits.
- *
- * @example
- * const requestPayment = usePaymentRequest({
- *   onCancel: () => console.log('User cancelled payment'),
- *   onError: (error) => console.error('Payment failed:', error)
- * })
- *
- * const result = await requestPayment({
- *   amount: 999, // $9.99 in cents
- *   currency: 'USD',
- *   description: 'Premium subscription'
- * })
- *
- * if (result) {
- *   console.log('Payment successful:', result.transactionId)
- * }
- */
-export const usePaymentRequest = (
-  options?: HandleIntentOptions<RequestPaymentIntentResult>
-) => {
-  const intents = useShopIntents()
-  return useHandleIntent(intents.requestPayment, options)
-}
-
-/**
- * Type helper for the payment request function
- */
-export type PaymentRequestFunction = (
-  params: RequestPaymentIntentParams
-) => Promise<RequestPaymentIntentResult | void>

package/src/hooks/intents/useProductSelection.ts

@@ -1,45 +0,0 @@
-import {
-  useHandleIntent,
-  HandleIntentOptions,
-} from '../../internal/useHandleIntent'
-import {useShopIntents} from '../../internal/useShopIntents'
-
-import type {
-  SelectProductIntentParams,
-  SelectProductIntentResult,
-} from '@shopify/shop-minis-platform'
-
-/**
- * Hook to request user to select products
- *
- * This intent shows a product selection screen where the user can browse
- * and select one or more products from the Shop catalog.
- *
- * @example
- * const selectProducts = useProductSelection({
- *   onCancel: () => console.log('User cancelled'),
- * })
- *
- * const result = await selectProducts({
- *   multiSelect: true,
- *   maxSelections: 5,
- *   title: 'Choose your favorites'
- * })
- *
- * if (result) {
- *   console.log('Selected products:', result.products)
- * }
- */
-export const useProductSelection = (
-  options?: HandleIntentOptions<SelectProductIntentResult>
-) => {
-  const intents = useShopIntents()
-  return useHandleIntent(intents.selectProduct, options)
-}
-
-/**
- * Type helper for the product selection function
- */
-export type ProductSelectionFunction = (
-  params: SelectProductIntentParams
-) => Promise<SelectProductIntentResult | void>

package/src/internal/useHandleIntent.ts

@@ -1,101 +0,0 @@
-import {useCallback} from 'react'
-
-import {IntentResultCode} from '@shopify/shop-minis-platform'
-
-import type {ShopIntentResult} from '@shopify/shop-minis-platform'
-
-/**
- * Options for handling intent results
- */
-export interface HandleIntentOptions<T> {
-  /**
-   * Handler called when user cancels the intent
-   * If not provided, cancellation is treated as a no-op (returns undefined)
-   */
-  onCancel?: () => T | void
-  /**
-   * Handler called when intent fails
-   * If not provided, throws the error
-   */
-  onError?: (error: {message: string; code?: string}) => T | void
-}
-
-/**
- * Wrapper to handle intent results
- *
- * Unlike actions which can reject, intents ALWAYS resolve with a result code.
- * This hook provides a cleaner API for handling intent results:
- *
- * - SUCCESS: Returns the data
- * - CANCELLED: Calls onCancel or returns undefined
- * - FAILED: Calls onError or throws the error
- *
- * @example
- * const selectProduct = useHandleIntent(intents.selectProduct, {
- *   onCancel: () => console.log('User cancelled'),
- *   onError: (error) => console.error('Selection failed:', error)
- * })
- *
- * const result = await selectProduct({multiSelect: true})
- * // result is the data, or undefined if cancelled
- */
-export const useHandleIntent = <T, Args extends unknown[]>(
-  intent: (...args: Args) => Promise<ShopIntentResult<T>>,
-  options?: HandleIntentOptions<T>
-) => {
-  return useCallback(
-    async (...args: Args): Promise<T | void> => {
-      const result = await intent(...args)
-
-      switch (result.resultCode) {
-        case IntentResultCode.SUCCESS:
-          return result.data!
-
-        case IntentResultCode.CANCELLED:
-          if (options?.onCancel) {
-            return options.onCancel()
-          }
-          return undefined
-
-        case IntentResultCode.FAILED:
-          if (options?.onError) {
-            return options.onError(result.error!)
-          }
-
-          throw new Error(result.error?.message || 'Intent failed')
-
-        default: {
-          // Exhaustiveness check
-          const _exhaustive: never = result.resultCode
-          throw new Error(`Unhandled result code: ${_exhaustive}`)
-        }
-      }
-    },
-    [intent, options]
-  )
-}
-
-/**
- * Alternative: Manual result handling without throwing
- *
- * Use this when you want to handle all result codes explicitly
- * without throwing errors.
- *
- * @example
- * const selectProduct = useHandleIntentManual(intents.selectProduct)
- *
- * const result = await selectProduct({multiSelect: true})
- * if (result.resultCode === 'SUCCESS') {
- *   console.log(result.data)
- * }
- */
-export const useHandleIntentManual = <T, Args extends unknown[]>(
-  intent: (...args: Args) => Promise<ShopIntentResult<T>>
-) => {
-  return useCallback(
-    (...args: Args) => {
-      return intent(...args)
-    },
-    [intent]
-  )
-}

package/src/internal/useShopIntents.ts

@@ -1,13 +0,0 @@
-import type {ShopIntents} from '@shopify/shop-minis-platform'
-
-/**
- * Internal hook to access Shop Intents
- *
- * This provides direct access to window.minisIntents
- * Use specific intent hooks (like useProductSelection) instead of this hook directly
- *
- * @internal
- */
-export function useShopIntents(): ShopIntents {
-  return window.minisIntents
-}