@shopify/shop-minis-react 0.0.14 → 0.0.17

package/src/components/ui/button.tsx

@@ -0,0 +1,77 @@
+import * as React from 'react'
+
+import {cva, type VariantProps} from 'class-variance-authority'
+import {Slot as SlotPrimitive} from 'radix-ui'
+
+import {cn} from '../../lib/utils'
+
+const buttonVariants = cva(
+  "inline-flex items-center justify-center gap-2 whitespace-nowrap rounded-md text-sm font-medium transition-all disabled:pointer-events-none disabled:bg-disabled disabled:text-disabled-foreground [&_svg]:pointer-events-none [&_svg:not([class*='size-'])]:size-4 shrink-0 [&_svg]:shrink-0 outline-none aria-invalid:border-destructive",
+  {
+    variants: {
+      variant: {
+        default: 'bg-primary text-primary-foreground',
+        secondary: 'bg-secondary text-secondary-foreground',
+        tertiary: 'bg-tertiary text-tertiary-foreground',
+        destructive: 'bg-destructive text-white dark:bg-destructive/60',
+        outline: 'border bg-background dark:bg-input/30 dark:border-input',
+        ghost: '',
+        link: 'text-primary underline-offset-4',
+        icon: 'flex rounded-full items-center justify-center p-0 aspect-square',
+      },
+      size: {
+        default:
+          'min-h-[32px] rounded-lg px-3 py-2 text-sm leading-[18px] has-[>svg]:px-3',
+        sm: 'min-h-[20px] rounded-lg gap-1.5 px-3 py-1 text-xs leading-4 has-[>svg]:px-2.5',
+        lg: 'min-h-[44px] rounded-xl px-3 py-3 text-base leading-6 has-[>svg]:px-4',
+      },
+    },
+    compoundVariants: [
+      {
+        variant: 'icon',
+        size: 'default',
+        className:
+          'size-8 min-h-0 p-0 rounded-full gap-0 px-0 py-0 has-[>svg]:px-0',
+      },
+      {
+        variant: 'icon',
+        size: 'sm',
+        className:
+          'size-6 min-h-0 p-0 rounded-full gap-0 px-0 py-0 has-[>svg]:px-0',
+      },
+      {
+        variant: 'icon',
+        size: 'lg',
+        className:
+          'size-10 min-h-0 p-0 rounded-full gap-0 px-0 py-0 has-[>svg]:px-0',
+      },
+    ],
+    defaultVariants: {
+      variant: 'default',
+      size: 'default',
+    },
+  }
+)
+
+function BaseButton({
+  className,
+  variant,
+  size,
+  asChild = false,
+  ...props
+}: React.ComponentProps<'button'> &
+  VariantProps<typeof buttonVariants> & {
+    asChild?: boolean
+  }) {
+  const Comp = asChild ? SlotPrimitive.Slot : 'button'
+
+  return (
+    <Comp
+      data-slot="button"
+      className={cn(buttonVariants({variant, size, className}))}
+      {...props}
+    />
+  )
+}
+
+export {BaseButton, buttonVariants}

package/src/components/ui/carousel.tsx

@@ -0,0 +1,241 @@
+'use client'
+
+import * as React from 'react'
+
+import useEmblaCarousel, {type UseEmblaCarouselType} from 'embla-carousel-react'
+import {ArrowLeft, ArrowRight} from 'lucide-react'
+
+import {cn} from '../../lib/utils'
+
+import {BaseButton} from './button'
+
+type CarouselApi = UseEmblaCarouselType[1]
+type UseCarouselParameters = Parameters<typeof useEmblaCarousel>
+type CarouselOptions = UseCarouselParameters[0]
+type CarouselPlugin = UseCarouselParameters[1]
+
+interface CarouselProps {
+  opts?: CarouselOptions
+  plugins?: CarouselPlugin
+  orientation?: 'horizontal' | 'vertical'
+  setApi?: (api: CarouselApi) => void
+}
+
+type CarouselContextProps = {
+  carouselRef: ReturnType<typeof useEmblaCarousel>[0]
+  api: ReturnType<typeof useEmblaCarousel>[1]
+  scrollPrev: () => void
+  scrollNext: () => void
+  canScrollPrev: boolean
+  canScrollNext: boolean
+} & CarouselProps
+
+const CarouselContext = React.createContext<CarouselContextProps | null>(null)
+
+function useCarousel() {
+  const context = React.useContext(CarouselContext)
+
+  if (!context) {
+    throw new Error('useCarousel must be used within a <Carousel />')
+  }
+
+  return context
+}
+
+function Carousel({
+  orientation = 'horizontal',
+  opts,
+  setApi,
+  plugins,
+  className,
+  children,
+  ...props
+}: React.ComponentProps<'div'> & CarouselProps) {
+  const [carouselRef, api] = useEmblaCarousel(
+    {
+      ...opts,
+      axis: orientation === 'horizontal' ? 'x' : 'y',
+    },
+    plugins
+  )
+  const [canScrollPrev, setCanScrollPrev] = React.useState(false)
+  const [canScrollNext, setCanScrollNext] = React.useState(false)
+
+  const onSelect = React.useCallback((api: CarouselApi) => {
+    if (!api) return
+    setCanScrollPrev(api.canScrollPrev())
+    setCanScrollNext(api.canScrollNext())
+  }, [])
+
+  const scrollPrev = React.useCallback(() => {
+    api?.scrollPrev()
+  }, [api])
+
+  const scrollNext = React.useCallback(() => {
+    api?.scrollNext()
+  }, [api])
+
+  const handleKeyDown = React.useCallback(
+    (event: React.KeyboardEvent<HTMLDivElement>) => {
+      if (event.key === 'ArrowLeft') {
+        event.preventDefault()
+        scrollPrev()
+      } else if (event.key === 'ArrowRight') {
+        event.preventDefault()
+        scrollNext()
+      }
+    },
+    [scrollPrev, scrollNext]
+  )
+
+  React.useEffect(() => {
+    if (!api || !setApi) return
+    setApi(api)
+  }, [api, setApi])
+
+  React.useEffect(() => {
+    if (!api) return
+    onSelect(api)
+    api.on('reInit', onSelect)
+    api.on('select', onSelect)
+
+    return () => {
+      api?.off('select', onSelect)
+    }
+  }, [api, onSelect])
+
+  return (
+    <CarouselContext.Provider
+      value={{
+        carouselRef,
+        api,
+        opts,
+        orientation:
+          orientation || (opts?.axis === 'y' ? 'vertical' : 'horizontal'),
+        scrollPrev,
+        scrollNext,
+        canScrollPrev,
+        canScrollNext,
+      }}
+    >
+      <div
+        onKeyDownCapture={handleKeyDown}
+        className={cn('relative', className)}
+        role="region"
+        aria-roledescription="carousel"
+        data-slot="carousel"
+        {...props}
+      >
+        {children}
+      </div>
+    </CarouselContext.Provider>
+  )
+}
+
+function CarouselContent({className, ...props}: React.ComponentProps<'div'>) {
+  const {carouselRef, orientation} = useCarousel()
+
+  return (
+    <div
+      ref={carouselRef}
+      className="overflow-hidden"
+      data-slot="carousel-content"
+    >
+      <div
+        className={cn(
+          'flex',
+          orientation === 'horizontal' ? '-ml-4' : '-mt-4 flex-col',
+          className
+        )}
+        {...props}
+      />
+    </div>
+  )
+}
+
+function CarouselItem({className, ...props}: React.ComponentProps<'div'>) {
+  const {orientation} = useCarousel()
+
+  return (
+    <div
+      role="group"
+      aria-roledescription="slide"
+      data-slot="carousel-item"
+      className={cn(
+        'min-w-0 shrink-0 grow-0 basis-full',
+        orientation === 'horizontal' ? 'pl-4' : 'pt-4',
+        className
+      )}
+      {...props}
+    />
+  )
+}
+
+function CarouselPrevious({
+  className,
+  variant = 'icon',
+  size = 'default',
+  ...props
+}: React.ComponentProps<typeof BaseButton>) {
+  const {orientation, scrollPrev, canScrollPrev} = useCarousel()
+
+  return (
+    <BaseButton
+      data-slot="carousel-previous"
+      variant={variant}
+      size={size}
+      className={cn(
+        'absolute size-8 rounded-full',
+        orientation === 'horizontal'
+          ? 'top-1/2 -left-12 -translate-y-1/2'
+          : '-top-12 left-1/2 -translate-x-1/2 rotate-90',
+        className
+      )}
+      disabled={!canScrollPrev}
+      onClick={scrollPrev}
+      {...props}
+    >
+      <ArrowLeft />
+      <span className="sr-only">Previous slide</span>
+    </BaseButton>
+  )
+}
+
+function CarouselNext({
+  className,
+  variant = 'icon',
+  size = 'default',
+  ...props
+}: React.ComponentProps<typeof BaseButton>) {
+  const {orientation, scrollNext, canScrollNext} = useCarousel()
+
+  return (
+    <BaseButton
+      data-slot="carousel-next"
+      variant={variant}
+      size={size}
+      className={cn(
+        'absolute size-8 rounded-full',
+        orientation === 'horizontal'
+          ? 'top-1/2 -right-12 -translate-y-1/2'
+          : '-bottom-12 left-1/2 -translate-x-1/2 rotate-90',
+        className
+      )}
+      disabled={!canScrollNext}
+      onClick={scrollNext}
+      {...props}
+    >
+      <ArrowRight />
+      <span className="sr-only">Next slide</span>
+    </BaseButton>
+  )
+}
+
+export {
+  type CarouselApi,
+  Carousel,
+  CarouselContent,
+  CarouselItem,
+  CarouselPrevious,
+  CarouselNext,
+}

package/src/components/ui/drawer.tsx

@@ -0,0 +1,133 @@
+import * as React from 'react'
+
+import {Drawer as DrawerPrimitive} from 'vaul'
+
+import {cn} from '../../lib/utils'
+
+function Drawer({...props}: React.ComponentProps<typeof DrawerPrimitive.Root>) {
+  return <DrawerPrimitive.Root data-slot="drawer" {...props} />
+}
+
+function DrawerTrigger({
+  ...props
+}: React.ComponentProps<typeof DrawerPrimitive.Trigger>) {
+  return <DrawerPrimitive.Trigger data-slot="drawer-trigger" {...props} />
+}
+
+function DrawerPortal({
+  ...props
+}: React.ComponentProps<typeof DrawerPrimitive.Portal>) {
+  return <DrawerPrimitive.Portal data-slot="drawer-portal" {...props} />
+}
+
+function DrawerClose({
+  ...props
+}: React.ComponentProps<typeof DrawerPrimitive.Close>) {
+  return <DrawerPrimitive.Close data-slot="drawer-close" {...props} />
+}
+
+function DrawerOverlay({
+  className,
+  ...props
+}: React.ComponentProps<typeof DrawerPrimitive.Overlay>) {
+  return (
+    <DrawerPrimitive.Overlay
+      data-slot="drawer-overlay"
+      className={cn(
+        'data-[state=open]:animate-in data-[state=closed]:animate-out data-[state=closed]:fade-out-0 data-[state=open]:fade-in-0 fixed inset-0 z-50 bg-black/50',
+        className
+      )}
+      {...props}
+    />
+  )
+}
+
+function DrawerContent({
+  className,
+  children,
+  ...props
+}: React.ComponentProps<typeof DrawerPrimitive.Content>) {
+  return (
+    // vaul's Portal type incorrectly excludes children
+    <DrawerPortal {...({} as any)}>
+      <DrawerOverlay />
+      <DrawerPrimitive.Content
+        data-slot="drawer-content"
+        className={cn(
+          'group/drawer-content bg-background fixed z-50 flex h-auto flex-col',
+          'data-[vaul-drawer-direction=top]:inset-x-0 data-[vaul-drawer-direction=top]:top-0 data-[vaul-drawer-direction=top]:mb-24 data-[vaul-drawer-direction=top]:max-h-[80vh] data-[vaul-drawer-direction=top]:rounded-b-lg data-[vaul-drawer-direction=top]:border-b',
+          'data-[vaul-drawer-direction=bottom]:inset-x-0 data-[vaul-drawer-direction=bottom]:bottom-0 data-[vaul-drawer-direction=bottom]:mt-24 data-[vaul-drawer-direction=bottom]:max-h-[80vh] data-[vaul-drawer-direction=bottom]:rounded-t-lg data-[vaul-drawer-direction=bottom]:border-t',
+          'data-[vaul-drawer-direction=right]:inset-y-0 data-[vaul-drawer-direction=right]:right-0 data-[vaul-drawer-direction=right]:w-3/4 data-[vaul-drawer-direction=right]:border-l data-[vaul-drawer-direction=right]:sm:max-w-sm',
+          'data-[vaul-drawer-direction=left]:inset-y-0 data-[vaul-drawer-direction=left]:left-0 data-[vaul-drawer-direction=left]:w-3/4 data-[vaul-drawer-direction=left]:border-r data-[vaul-drawer-direction=left]:sm:max-w-sm',
+          className
+        )}
+        {...props}
+      >
+        <div className="bg-muted mx-auto mt-4 hidden h-2 w-[100px] shrink-0 rounded-full group-data-[vaul-drawer-direction=bottom]/drawer-content:block" />
+        {children}
+      </DrawerPrimitive.Content>
+    </DrawerPortal>
+  )
+}
+
+function DrawerHeader({className, ...props}: React.ComponentProps<'div'>) {
+  return (
+    <div
+      data-slot="drawer-header"
+      className={cn(
+        'flex flex-col gap-0.5 p-4 group-data-[vaul-drawer-direction=bottom]/drawer-content:text-center group-data-[vaul-drawer-direction=top]/drawer-content:text-center md:gap-1.5 md:text-left',
+        className
+      )}
+      {...props}
+    />
+  )
+}
+
+function DrawerFooter({className, ...props}: React.ComponentProps<'div'>) {
+  return (
+    <div
+      data-slot="drawer-footer"
+      className={cn('mt-auto flex flex-col gap-2 p-4', className)}
+      {...props}
+    />
+  )
+}
+
+function DrawerTitle({
+  className,
+  ...props
+}: React.ComponentProps<typeof DrawerPrimitive.Title>) {
+  return (
+    <DrawerPrimitive.Title
+      data-slot="drawer-title"
+      className={cn('text-foreground font-semibold', className)}
+      {...props}
+    />
+  )
+}
+
+function DrawerDescription({
+  className,
+  ...props
+}: React.ComponentProps<typeof DrawerPrimitive.Description>) {
+  return (
+    <DrawerPrimitive.Description
+      data-slot="drawer-description"
+      className={cn('text-muted-foreground text-sm', className)}
+      {...props}
+    />
+  )
+}
+
+export {
+  Drawer,
+  DrawerPortal,
+  DrawerOverlay,
+  DrawerTrigger,
+  DrawerClose,
+  DrawerContent,
+  DrawerHeader,
+  DrawerFooter,
+  DrawerTitle,
+  DrawerDescription,
+}

package/src/hooks/navigation/useShopNavigation.ts

@@ -1,11 +1,12 @@
-import {useHandleAction} from '../../internal/useHandleAction'
-import {useShopActions} from '../../internal/useShopActions'
 import {
   NavigateToCheckoutParams,
   NavigateToOrderParams,
   NavigateToProductParams,
   NavigateToShopParams,
-} from '../../types'
+} from '@shopify/shop-minis-platform/actions'
+
+import {useHandleAction} from '../../internal/useHandleAction'
+import {useShopActions} from '../../internal/useShopActions'
 
 interface UseShopNavigationReturns {
   /**

package/src/hooks/product/useProductListActions.ts

@@ -1,13 +1,14 @@
-import {useHandleAction} from '../../internal/useHandleAction'
-import {useShopActions} from '../../internal/useShopActions'
 import {
   AddProductListParams,
   RemoveProductListParams,
   RenameProductListParams,
   AddProductListItemParams,
   RemoveProductListItemParams,
-  ProductList,
-} from '../../types'
+} from '@shopify/shop-minis-platform/actions'
+
+import {useHandleAction} from '../../internal/useHandleAction'
+import {useShopActions} from '../../internal/useShopActions'
+import {ProductList} from '../../types'
 
 interface UseProductListActionsReturns {
   /**

package/src/hooks/shop/useShopCartActions.ts

@@ -1,6 +1,10 @@
+import {
+  AddToCartParams,
+  BuyProductParams,
+} from '@shopify/shop-minis-platform/actions'
+
 import {useHandleAction} from '../../internal/useHandleAction'
 import {useShopActions} from '../../internal/useShopActions'
-import {AddToCartParams, BuyProductParams} from '../../types'
 
 interface UseShopCartActionsReturns {
   /**

package/src/hooks/storage/useAsyncStorage.ts

@@ -1,10 +1,11 @@
-import {useHandleAction} from '../../internal/useHandleAction'
-import {useShopActions} from '../../internal/useShopActions'
 import {
   GetAsyncStorageItemParams,
   SetAsyncStorageItemParams,
   RemoveAsyncStorageItemParams,
-} from '../../types'
+} from '@shopify/shop-minis-platform/actions'
+
+import {useHandleAction} from '../../internal/useHandleAction'
+import {useShopActions} from '../../internal/useShopActions'
 
 interface UseAsyncStorageReturns {
   /**

package/src/hooks/storage/useSecureStorage.ts

@@ -1,6 +1,7 @@
+import {SetSecretParams} from '@shopify/shop-minis-platform/actions'
+
 import {useHandleAction} from '../../internal/useHandleAction'
 import {useShopActions} from '../../internal/useShopActions'
-import {SetSecretParams} from '../../types'
 
 interface UseSecureStorageReturns {
   /**

package/src/hooks/user/useFollowedShopsActions.ts

@@ -1,6 +1,10 @@
+import {
+  FollowShopParams,
+  UnfollowShopParams,
+} from '@shopify/shop-minis-platform/actions'
+
 import {useHandleAction} from '../../internal/useHandleAction'
 import {useShopActions} from '../../internal/useShopActions'
-import {FollowShopParams, UnfollowShopParams} from '../../types'
 
 interface UseFollowedShopsActionsReturns {
   /**

package/src/hooks/user/useSavedProductsActions.ts

@@ -1,6 +1,10 @@
+import {
+  FavoriteParams,
+  UnfavoriteParams,
+} from '@shopify/shop-minis-platform/actions'
+
 import {useHandleAction} from '../../internal/useHandleAction'
 import {useShopActions} from '../../internal/useShopActions'
-import {FavoriteParams, UnfavoriteParams} from '../../types'
 
 interface UseSavedProductsActionsReturns {
   /**

package/src/hooks/util/useShare.ts

@@ -1,12 +1,13 @@
+import {ShareParams, ShareResponse} from '@shopify/shop-minis-platform/actions'
+
 import {useHandleAction} from '../../internal/useHandleAction'
 import {useShopActions} from '../../internal/useShopActions'
-import {ShareParams} from '../../types'
 
 interface UseShareReturns {
   /**
    * Closes the Mini viewer.
    */
-  share: (params: ShareParams) => void
+  share: (params: ShareParams) => Promise<ShareResponse>
 }
 
 export const useShare = (): UseShareReturns => {

package/src/index.css

@@ -1,2 +1,8 @@
-@import './base.css';
-@source '../node_modules/@shopify/shop-minis-react/src/**/*.{js,ts,jsx,tsx}';
+@import 'tailwindcss';
+@import 'tw-animate-css';
+
+@import './styles/theme.css';
+@import './styles/globals.css';
+
+/* When consumed as npm package, this path resolves from the consuming app's location */
+@source '../node_modules/@shopify/shop-minis-react/src';

package/src/internal/useHandleAction.ts

@@ -1,6 +1,6 @@
 import {useCallback} from 'react'
 
-import {ShopActionResult} from '../types'
+import {ShopActionResult} from '@shopify/shop-minis-platform/actions'
 
 // Wrapper to handle shop action results as regular promises (Reject on error)
 export const useHandleAction = <T, Args extends unknown[]>(

package/src/internal/useShopActionsDataFetching.ts

@@ -1,10 +1,8 @@
 import {useCallback, useEffect, useMemo, useState} from 'react'
 
-import {
-  DataHookFetchPolicy,
-  DataHookReturnsBase,
-  ShopActionResult,
-} from '../types'
+import {ShopActionResult} from '@shopify/shop-minis-platform/actions'
+
+import {DataHookFetchPolicy, DataHookReturnsBase} from '../types'
 import {formatError, MiniError} from '../utils/errors'
 
 export interface ShopActionsDataFetchingResult<R> extends DataHookReturnsBase {

package/src/internal/useShopActionsPaginatedDataFetching.ts

@@ -4,7 +4,7 @@ import {
   DataHookFetchPolicy,
   PaginatedDataHookReturnsBase,
   PaginationInfo,
-  ShopActionResult,
+  ShopAction,
 } from '../types'
 import {formatError, MiniError} from '../utils/errors'
 
@@ -20,9 +20,7 @@ export const useShopActionsPaginatedDataFetching = <
     fetchPolicy?: DataHookFetchPolicy
   },
 >(
-  action: (
-    params: P
-  ) => Promise<ShopActionResult<{data: S; pageInfo: PaginationInfo}>>,
+  action: ShopAction<P, {data: S; pageInfo: PaginationInfo}>,
   params: P,
   options: {
     skip?: boolean