@shopify/shop-minis-platform 0.0.0-snapshot.20250703092030

package/LICENSE.txt

@@ -0,0 +1,9 @@
+Copyright (c) 2023-present Shopify Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+The rights granted above may only be exercised to develop and distribute applications that integrate or interoperate with Shopify software or services, and, if applicable, to distribute, offer for sale or otherwise make available any such applications via the Shopify app store. All other uses of the Software are strictly prohibited.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,19 @@
+# @shopify/shop-minis-platform
+
+Shared type definitions for Shop Minis Platform.
+
+## Purpose
+
+This package provides shared type definitions that can be used across different parts of the Shop Minis Platform, particularly between `shop-minis-react` and the Shop app.
+
+## Installation
+
+```bash
+npm install @shopify/shop-minis-platform
+```
+
+## Usage
+
+```typescript
+import type {} from '@shopify/shop-minis-platform'
+```

package/package.json

@@ -0,0 +1,29 @@
+{
+  "name": "@shopify/shop-minis-platform",
+  "license": "SEE LICENSE IN LICENSE.txt",
+  "version": "0.0.0-snapshot.20250703092030",
+  "description": "Shared type definitions for Shop Minis Platform",
+  "main": "src/index.ts",
+  "publishConfig": {
+    "access": "public",
+    "@shopify:registry": "https://registry.npmjs.org/"
+  },
+  "files": [
+    "src/**/*.{ts,tsx,css}",
+    "README.md",
+    "LICENSE.txt"
+  ],
+  "dependencies": {},
+  "peerDependencies": {},
+  "devDependencies": {},
+  "author": "Shopify",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Shopify/shop-client.git",
+    "directory": "packages/minis/shop-minis-platform"
+  },
+  "scripts": {
+    "test": "TZ=UTC jest",
+    "tsc:build": "tsc --build ./tsconfig.json"
+  }
+}

package/src/actions/actions.ts

@@ -0,0 +1,211 @@
+import {ProductList} from '../types'
+
+import {
+  FollowShopParams,
+  UnfollowShopParams,
+  FavoriteParams,
+  UnfavoriteParams,
+  GetShopAppInformationResponse,
+  ProductRecommendationImpressionParams,
+  ProductRecommendationClickParams,
+  GetAccountInformationParams,
+  GetAccountInformationResponse,
+  GetCurrentUserParams,
+  GetCurrentUserResponse,
+  CreateOrderAttributionParams,
+  AddToCartParams,
+  BuyProductParams,
+  BuyProductsParams,
+  ShowErrorScreenParams,
+  ShowErrorToastParams,
+  GetDeeplinkPathsResponse,
+  NavigateToDeeplinkParams,
+  NavigateToShopParams,
+  NavigateToProductParams,
+  NavigateToOrderParams,
+  NavigateToCheckoutParams,
+  CreateImageUploadLinkParams,
+  CreateImageUploadLinkResponse,
+  CompleteImageUploadParams,
+  CompleteImageUploadResponse,
+  GetAsyncStorageItemParams,
+  SetAsyncStorageItemParams,
+  RemoveAsyncStorageItemParams,
+  SetSecretParams,
+  ReportInteractionParams,
+  ReportImpressionParams,
+  ReportContentImpressionParams,
+  GetProductListsParams,
+  GetProductListsResponse,
+  GetProductListParams,
+  GetProductListResponse,
+  AddProductListParams,
+  RemoveProductListParams,
+  RenameProductListParams,
+  AddProductListItemParams,
+  RemoveProductListItemParams,
+  GetRecommendedProductsParams,
+  GetRecommendedProductsResponse,
+  GetRecommendedShopsParams,
+  GetRecommendedShopsResponse,
+  SearchProductsByShopParams,
+  SearchProductsByShopResponse,
+  GetOrdersParams,
+  GetOrdersResponse,
+  GetBuyerAttributesParams,
+  GetBuyerAttributesResponse,
+  ShowFeedbackSheetParams,
+  GetPopularProductsParams,
+  GetPopularProductsResponse,
+  ShareParams,
+  ShareResponse,
+  GetCuratedProductsParams,
+  GetCuratedProductsResponse,
+  GetSavedProductsParams,
+  GetSavedProductsResponse,
+  GetRecentProductsParams,
+  GetRecentProductsResponse,
+  GetProductSearchParams,
+  GetProductSearchResponse,
+  GetProductsParams,
+  GetProductsResponse,
+  GetProductParams,
+  GetProductResponse,
+  GetProductVariantsParams,
+  GetProductVariantsResponse,
+  GetProductMediaParams,
+  GetProductMediaResponse,
+  GetShopParams,
+  GetShopResponse,
+  GetRecentShopsParams,
+  GetRecentShopsResponse,
+  GetFollowedShopsParams,
+  GetFollowedShopsResponse,
+  PreviewProductInARParams,
+} from './params'
+import {ShopAction, SnakeToCamelCase} from './shared'
+
+export type ShopActions = {
+  [K in keyof ShopActionEvents as SnakeToCamelCase<K>]: ShopActionEvents[K]
+}
+export interface ShopActionEvents {
+  FOLLOW_SHOP: ShopAction<FollowShopParams, boolean>
+  UNFOLLOW_SHOP: ShopAction<UnfollowShopParams, boolean>
+  FAVORITE: ShopAction<FavoriteParams, void>
+  UNFAVORITE: ShopAction<UnfavoriteParams, void>
+  GET_SHOP_APP_INFORMATION: ShopAction<void, GetShopAppInformationResponse>
+  PRODUCT_RECOMMENDATION_IMPRESSION: ShopAction<
+    ProductRecommendationImpressionParams,
+    void
+  >
+  PRODUCT_RECOMMENDATION_CLICK: ShopAction<
+    ProductRecommendationClickParams,
+    void
+  >
+  HIDE_ENTRY_POINT: ShopAction<void, void>
+  CLOSE_MINI: ShopAction<void, void>
+  GET_ACCOUNT_INFORMATION: ShopAction<
+    GetAccountInformationParams,
+    GetAccountInformationResponse
+  >
+  GET_CURRENT_USER: ShopAction<GetCurrentUserParams, GetCurrentUserResponse>
+  CREATE_ORDER_ATTRIBUTION: ShopAction<CreateOrderAttributionParams, void>
+  ADD_TO_CART: ShopAction<AddToCartParams, void>
+  BUY_PRODUCT: ShopAction<BuyProductParams, void>
+  BUY_PRODUCTS: ShopAction<BuyProductsParams, void>
+  SHOW_ERROR_SCREEN: ShopAction<ShowErrorScreenParams, void>
+  SHOW_ERROR_TOAST: ShopAction<ShowErrorToastParams, void>
+  GET_DEEPLINK_PATHS: ShopAction<void, GetDeeplinkPathsResponse>
+  NAVIGATE_TO_DEEPLINK: ShopAction<NavigateToDeeplinkParams, void>
+  NAVIGATE_TO_SHOP: ShopAction<NavigateToShopParams, void>
+  NAVIGATE_TO_PRODUCT: ShopAction<NavigateToProductParams, void>
+  NAVIGATE_TO_ORDER: ShopAction<NavigateToOrderParams, void>
+  NAVIGATE_TO_CHECKOUT: ShopAction<NavigateToCheckoutParams, void>
+  CREATE_IMAGE_UPLOAD_LINK: ShopAction<
+    CreateImageUploadLinkParams,
+    CreateImageUploadLinkResponse
+  >
+  COMPLETE_IMAGE_UPLOAD: ShopAction<
+    CompleteImageUploadParams,
+    CompleteImageUploadResponse
+  >
+  GET_PERSISTED_ITEM: ShopAction<GetAsyncStorageItemParams, string | null>
+  SET_PERSISTED_ITEM: ShopAction<SetAsyncStorageItemParams, void>
+  REMOVE_PERSISTED_ITEM: ShopAction<RemoveAsyncStorageItemParams, void>
+  GET_ALL_PERSISTED_KEYS: ShopAction<void, string[]>
+  CLEAR_PERSISTED_ITEMS: ShopAction<void, void>
+  GET_INTERNAL_PERSISTED_ITEM: ShopAction<
+    GetAsyncStorageItemParams,
+    string | null
+  >
+  SET_INTERNAL_PERSISTED_ITEM: ShopAction<SetAsyncStorageItemParams, void>
+  REMOVE_INTERNAL_PERSISTED_ITEM: ShopAction<RemoveAsyncStorageItemParams, void>
+  GET_ALL_INTERNAL_PERSISTED_KEYS: ShopAction<void, string[]>
+  CLEAR_INTERNAL_PERSISTED_ITEMS: ShopAction<void, void>
+  GET_SECRET: ShopAction<void, string | null>
+  SET_SECRET: ShopAction<SetSecretParams, void>
+  REMOVE_SECRET: ShopAction<void, void>
+  REPORT_INTERACTION: ShopAction<ReportInteractionParams, void>
+  REPORT_IMPRESSION: ShopAction<ReportImpressionParams, void>
+  REPORT_CONTENT_IMPRESSION: ShopAction<ReportContentImpressionParams, void>
+  GET_PRODUCT_LISTS: ShopAction<GetProductListsParams, GetProductListsResponse>
+  GET_PRODUCT_LIST: ShopAction<GetProductListParams, GetProductListResponse>
+  ADD_PRODUCT_LIST: ShopAction<AddProductListParams, ProductList>
+  REMOVE_PRODUCT_LIST: ShopAction<RemoveProductListParams, void>
+  RENAME_PRODUCT_LIST: ShopAction<RenameProductListParams, ProductList>
+  ADD_PRODUCT_LIST_ITEM: ShopAction<AddProductListItemParams, void>
+  REMOVE_PRODUCT_LIST_ITEM: ShopAction<RemoveProductListItemParams, void>
+  GET_RECOMMENDED_PRODUCTS: ShopAction<
+    GetRecommendedProductsParams,
+    GetRecommendedProductsResponse
+  >
+  GET_RECOMMENDED_SHOPS: ShopAction<
+    GetRecommendedShopsParams,
+    GetRecommendedShopsResponse
+  >
+  SEARCH_PRODUCTS_BY_SHOP: ShopAction<
+    SearchProductsByShopParams,
+    SearchProductsByShopResponse
+  >
+  GET_ORDERS: ShopAction<GetOrdersParams, GetOrdersResponse>
+  GET_BUYER_ATTRIBUTES: ShopAction<
+    GetBuyerAttributesParams,
+    GetBuyerAttributesResponse
+  >
+  SHOW_FEEDBACK_SHEET: ShopAction<ShowFeedbackSheetParams, void>
+  GET_POPULAR_PRODUCTS: ShopAction<
+    GetPopularProductsParams,
+    GetPopularProductsResponse
+  >
+  SHARE: ShopAction<ShareParams, ShareResponse>
+  GET_CURATED_PRODUCTS: ShopAction<
+    GetCuratedProductsParams,
+    GetCuratedProductsResponse
+  >
+  GET_SAVED_PRODUCTS: ShopAction<
+    GetSavedProductsParams,
+    GetSavedProductsResponse
+  >
+  GET_RECENT_PRODUCTS: ShopAction<
+    GetRecentProductsParams,
+    GetRecentProductsResponse
+  >
+  GET_PRODUCT_SEARCH: ShopAction<
+    GetProductSearchParams,
+    GetProductSearchResponse
+  >
+  GET_PRODUCTS: ShopAction<GetProductsParams, GetProductsResponse>
+  GET_PRODUCT: ShopAction<GetProductParams, GetProductResponse>
+  GET_PRODUCT_VARIANTS: ShopAction<
+    GetProductVariantsParams,
+    GetProductVariantsResponse
+  >
+  GET_PRODUCT_MEDIA: ShopAction<GetProductMediaParams, GetProductMediaResponse>
+  GET_SHOP: ShopAction<GetShopParams, GetShopResponse>
+  GET_RECENT_SHOPS: ShopAction<GetRecentShopsParams, GetRecentShopsResponse>
+  GET_FOLLOWED_SHOPS: ShopAction<
+    GetFollowedShopsParams,
+    GetFollowedShopsResponse
+  >
+  PREVIEW_PRODUCT_IN_AR: ShopAction<PreviewProductInARParams, void>
+}

package/src/actions/index.ts

@@ -0,0 +1,3 @@
+export * from './actions'
+export * from './shared'
+export * from './params'