@shopify/shop-minis-platform 0.18.0 → 0.19.0

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@shopify/shop-minis-platform",
   "license": "SEE LICENSE IN LICENSE.txt",
-  "version": "0.18.0",
+  "version": "0.19.0",
   "description": "Shared type definitions for Shop Minis Platform",
   "main": "src/index.ts",
   "exports": {
@@ -21,13 +21,13 @@
   ],
   "scripts": {
     "test": "TZ=UTC jest",
-    "type-check": "tsc --noEmit",
+    "type-check": "tsgo --noEmit",
     "typecheck": "pnpm run type-check"
   },
   "dependencies": {},
   "peerDependencies": {},
   "devDependencies": {
-    "typescript": "^5.8.3"
+    "typescript": "^6.0.3"
   },
   "author": "Shopify",
   "repository": {

package/src/actions/actions.ts

@@ -71,6 +71,8 @@ import {
   GetRecentProductsResponse,
   GetProductSearchParams,
   GetProductSearchResponse,
+  GetSimilarProductsParams,
+  GetSimilarProductsResponse,
   GetProductsParams,
   GetProductsResponse,
   GetProductParams,
@@ -218,6 +220,10 @@ export interface ShopActionEvents {
     GetProductSearchParams,
     GetProductSearchResponse
   >
+  GET_SIMILAR_PRODUCTS: ShopAction<
+    GetSimilarProductsParams,
+    GetSimilarProductsResponse
+  >
   GET_PRODUCTS: ShopAction<GetProductsParams, GetProductsResponse>
   GET_PRODUCT: ShopAction<GetProductParams, GetProductResponse>
   GET_PRODUCT_VARIANTS: ShopAction<

package/src/actions/params.ts

@@ -695,6 +695,62 @@ export interface GetProductSearchResponse extends PaginatedResponse<
   Product[]
 > {}
 
+/**
+ * Image media used as the source for similar product search.
+ * The hook handles base64 encoding from a File — partners pass a File directly,
+ * not the encoded payload.
+ */
+export interface GetSimilarProductsMediaInput {
+  /**
+   * The image MIME type. Currently only `image/jpeg` is supported.
+   */
+  contentType: string
+  /**
+   * The base64-encoded image content (without `data:` prefix). Must be <= 4 MiB.
+   */
+  base64: string
+}
+
+/**
+ * The source for similar product search. Exactly one of `productId`,
+ * `productVariantId`, or `media` must be provided.
+ */
+export interface GetSimilarProductsSourceInput {
+  /**
+   * Shopify Product GID, e.g. `gid://shopify/Product/123`.
+   */
+  productId?: string
+  /**
+   * Shopify ProductVariant GID, e.g. `gid://shopify/ProductVariant/456`.
+   */
+  productVariantId?: string
+  /**
+   * JPEG image media to find similar products for.
+   */
+  media?: GetSimilarProductsMediaInput
+}
+
+export interface GetSimilarProductsParams {
+  /**
+   * Source for similar product search. Exactly one of `productId`,
+   * `productVariantId`, or `media` must be set.
+   */
+  similarTo: GetSimilarProductsSourceInput
+  /**
+   * Number of products to return. Must be 1..10.
+   */
+  first?: number
+  /**
+   * Cursor for pagination. Currently the backend returns only a first page,
+   * so this is effectively unused.
+   */
+  after?: string
+  fetchPolicy?: DataHookFetchPolicy
+}
+
+export interface GetSimilarProductsResponse
+  extends PaginatedResponse<Product[]> {}
+
 export interface GetProductVariantsParams {
   id: string
   first?: number