@shopify/shop-minis-react 0.0.1 → 0.0.2

package/src/types/minisSDK.generated.d.ts

@@ -1,6 +1,6 @@
 /* eslint-disable @shopify/typescript/prefer-pascal-case-enums */
 // Auto-generated type definitions for MinisSDK
-// Generated on: 2025-06-05T16:20:27.728Z
+// Generated on: 2025-06-06T15:17:55.440Z
 // Do not edit this file manually - run the generation script instead
 // Source: useShopActionsImplementationV3.ts + shopActionsV3Definitions.ts + shopActionsV3Types.ts
 // Generated using TypeScript compiler API for reliable AST parsing
@@ -1114,81 +1114,9 @@ export interface PaginatedDataHookPageInfo {
   endCursor: string | null
 }
 
-// ============================================================================
-// MinisSDK Interface
-// ============================================================================
-
-interface MinisSDK {
-  getRecommendedProducts(): Promise<
-    ShopActionResult<GetRecommendedProductsResponse>
-  >
-  getRecommendedShops(): Promise<ShopActionResult<GetRecommendedShopsResponse>>
-  searchProductsByShop(): Promise<
-    ShopActionResult<SearchProductsByShopResponse>
-  >
-  getShopAppInformation(): Promise<ShopActionResult<void>>
-  getOrders(): Promise<ShopActionResult<GetOrdersResponse>>
-  getBuyerAttributes(): Promise<ShopActionResult<GetBuyerAttributesResponse>>
-  getCurrentUser(): Promise<ShopActionResult<GetCurrentUserResponse>>
-  getProductLists(): Promise<ShopActionResult<GetProductListsResponse>>
-  getDeeplinkPaths(): Promise<ShopActionResult<GetDeeplinkPathsResponse>>
-  getAllPersistedKeys(): Promise<ShopActionResult<string[]>>
-  getSecret(): Promise<ShopActionResult<string | null>>
-  closeMini(): Promise<ShopActionResult<void>>
-  getAllInternalPersistedKeys(): Promise<ShopActionResult<string[]>>
-  clearInternalPersistedItems(): Promise<ShopActionResult<void>>
-  getPopularProducts(): Promise<ShopActionResult<GetPopularProductsResponse>>
-  getProductList(params: any): Promise<ShopActionResult<GetProductListResponse>>
-  getPersistedItem(params: any): Promise<ShopActionResult<string | null>>
-  getAccountInformation(
-    params: any
-  ): Promise<ShopActionResult<GetAccountInformationResponse>>
-  navigateToProduct(params: any): Promise<ShopActionResult<void>>
-  navigateToCheckout(params: any): Promise<ShopActionResult<void>>
-  createOrderAttribution(params: any): Promise<ShopActionResult<void>>
-  addToCart(params: any): Promise<ShopActionResult<void>>
-  buyProduct(params: any): Promise<ShopActionResult<void>>
-  buyProducts(params: any): Promise<ShopActionResult<void>>
-  navigateToShop(params: any): Promise<ShopActionResult<void>>
-  showErrorScreen(params: any): Promise<ShopActionResult<void>>
-  showErrorToast(params: any): Promise<ShopActionResult<void>>
-  productRecommendationImpression(params: any): Promise<ShopActionResult<void>>
-  productRecommendationClick(params: any): Promise<ShopActionResult<void>>
-  followShop(params: any): Promise<ShopActionResult<boolean>>
-  unfollowShop(params: any): Promise<ShopActionResult<boolean>>
-  hideEntryPoint(params: any): Promise<ShopActionResult<void>>
-  navigateToOrder(params: any): Promise<ShopActionResult<void>>
-  navigateToDeeplink(params: any): Promise<ShopActionResult<void>>
-  createImageUploadLink(
-    params: any
-  ): Promise<ShopActionResult<CreateImageUploadLinkResponse>>
-  completeImageUpload(
-    params: any
-  ): Promise<ShopActionResult<CompleteImageUploadResponse>>
-  setPersistedItem(params: any): Promise<ShopActionResult<void>>
-  removePersistedItem(params: any): Promise<ShopActionResult<void>>
-  clearPersistedItems(params: any): Promise<ShopActionResult<void>>
-  setSecret(params: any): Promise<ShopActionResult<void>>
-  removeSecret(params: any): Promise<ShopActionResult<void>>
-  reportInteraction(params: any): Promise<ShopActionResult<void>>
-  reportImpression(params: any): Promise<ShopActionResult<void>>
-  reportContentImpression(params: any): Promise<ShopActionResult<void>>
-  addProductList(params: any): Promise<ShopActionResult<ProductList>>
-  removeProductList(params: any): Promise<ShopActionResult<void>>
-  renameProductList(params: any): Promise<ShopActionResult<ProductList>>
-  addProductListItem(params: any): Promise<ShopActionResult<void>>
-  removeProductListItem(params: any): Promise<ShopActionResult<void>>
-  showFeedbackSheet(params: any): Promise<ShopActionResult<void>>
-  getInternalPersistedItem(
-    params: any
-  ): Promise<ShopActionResult<string | null>>
-  setInternalPersistedItem(params: any): Promise<ShopActionResult<void>>
-  removeInternalPersistedItem(params: any): Promise<ShopActionResult<void>>
-}
-
 declare global {
   interface Window {
-    minisSDK: MinisSDK
+    minisSDK: ShopActions
   }
 }
 

package/src/utils/errors.ts

@@ -0,0 +1,86 @@
+interface MiniErrorSource {
+  component?: string
+  hook?: string
+  func?: string
+  callback?: string
+}
+
+interface MiniErrorParams extends MiniErrorSource {
+  message: string
+}
+
+// Base class for all Mini errors
+// We can give richer error messages by using this throughout the SDK
+// In future we could add instrumentation to track these errors too
+export class MiniError extends Error {
+  constructor({
+    component,
+    hook,
+    func,
+    callback,
+    message = 'Unknown Error',
+  }: MiniErrorParams) {
+    let formattedMessage = message
+
+    if (component || hook || func) {
+      if (component) {
+        formattedMessage = `<${component} />`
+      } else if (hook) {
+        formattedMessage = hook
+      } else if (func) {
+        formattedMessage = `${func}()`
+      }
+
+      if (callback) {
+        formattedMessage = `${formattedMessage} ${callback}()`
+      }
+
+      formattedMessage = `${formattedMessage}: ${message}`
+    }
+
+    super(formattedMessage)
+    this.name = 'MiniError'
+  }
+}
+
+export class MiniNetworkError extends MiniError {
+  constructor(params: Partial<MiniErrorParams>) {
+    super({message: 'Network Error', ...params})
+    this.name = 'MiniNetworkError'
+  }
+}
+
+export class MiniEntityNotFoundError extends MiniError {
+  constructor(params: Partial<MiniErrorParams>) {
+    super({message: 'Entity Not Found', ...params})
+    this.name = 'MiniEntityNotFoundError'
+  }
+}
+
+export const formatError = (
+  source: MiniErrorSource,
+  error: any
+): MiniError | MiniNetworkError | null => {
+  if (!error) {
+    return null
+  }
+
+  if (error.networkError) {
+    return new MiniNetworkError({
+      ...source,
+      message: error.networkError?.message,
+    })
+  }
+
+  if (error.code) {
+    return new MiniError({
+      ...source,
+      message: `${error.code}${error.message ? `: ${error.message}` : ''}`,
+    })
+  }
+
+  return new MiniError({
+    ...source,
+    message: error?.message,
+  })
+}

package/src/utils/index.ts

@@ -1,11 +1,2 @@
-import {type ClassValue, clsx} from 'clsx'
-import {twMerge} from 'tailwind-merge'
-
-/**
- * Utility function to merge Tailwind CSS classes with proper conflict resolution
- */
-export function cn(...inputs: ClassValue[]) {
-  return twMerge(clsx(inputs))
-}
-
-// Export other utility functions here as needed
+export * from './errors'
+export * from './parseUrl'

package/src/utils/parseUrl.ts

@@ -0,0 +1,5 @@
+import urlParse from 'url-parse'
+
+export function parseUrl(url: string) {
+  return urlParse(url, true)
+}

package/tailwind.config.js

@@ -0,0 +1,3 @@
+module.exports = {
+  content: ['./src/**/*.{js,ts,jsx,tsx}'],
+}

package/src/components/HelloWorld/HelloWorld.tsx

@@ -1,43 +0,0 @@
-import React from 'react'
-
-import {cn} from '../../utils'
-
-import type {BaseComponentProps} from '../../types'
-
-export interface HelloWorldProps extends BaseComponentProps {
-  /**
-   * The name to greet
-   */
-  name?: string
-  /**
-   * The size variant of the component
-   */
-  size?: 'sm' | 'md' | 'lg'
-}
-
-export const HelloWorld: React.FC<HelloWorldProps> = ({
-  name = 'World',
-  size = 'md',
-  className,
-  children,
-  ...props
-}) => {
-  const sizeClasses = {
-    sm: 'text-sm px-2 py-1',
-    md: 'text-base px-4 py-2',
-    lg: 'text-lg px-6 py-3',
-  }
-
-  return (
-    <div
-      className={cn(
-        'inline-flex items-center justify-center rounded-lg bg-primary-500 text-white font-medium shadow-sm hover:bg-primary-600 transition-colors',
-        sizeClasses[size],
-        className
-      )}
-      {...props}
-    >
-      {children || `Hello, ${name}!`}
-    </div>
-  )
-}

package/src/components/HelloWorld/index.ts

@@ -1,2 +0,0 @@
-export {HelloWorld} from './HelloWorld'
-export type {HelloWorldProps} from './HelloWorld'

package/src/tailwind-theme.css

@@ -1,39 +0,0 @@
-@import 'tailwindcss';
-
-@theme {
-  /* Primary colors */
-  --color-primary-50: #f0f9ff;
-  --color-primary-100: #e0f2fe;
-  --color-primary-200: #bae6fd;
-  --color-primary-300: #7dd3fc;
-  --color-primary-400: #38bdf8;
-  --color-primary-500: #0ea5e9;
-  --color-primary-600: #0284c7;
-  --color-primary-700: #0369a1;
-  --color-primary-800: #075985;
-  --color-primary-900: #0c4a6e;
-
-  /* Secondary colors */
-  --color-secondary-50: #fafafa;
-  --color-secondary-100: #f4f4f5;
-  --color-secondary-200: #e4e4e7;
-  --color-secondary-300: #d4d4d8;
-  --color-secondary-400: #a1a1aa;
-  --color-secondary-500: #71717a;
-  --color-secondary-600: #52525b;
-  --color-secondary-700: #3f3f46;
-  --color-secondary-800: #27272a;
-  --color-secondary-900: #18181b;
-
-  /* Typography */
-  --font-sans: 'Inter', 'ui-sans-serif', 'system-ui';
-
-  /* Spacing */
-  --spacing-18: 4.5rem;
-  --spacing-88: 22rem;
-
-  /* Border radius */
-  --radius-xl: 0.75rem;
-  --radius-2xl: 1rem;
-  --radius-3xl: 1.5rem;
-}