@faststore/sdk - npm Package Compare versions

Comparing version 1.4.13 to 1.4.14

CHANGELOG.md

@@ -6,2 +6,13 @@ # Change Log
 
+## 1.4.14 (2022-01-07)
+
+
+### Features
+
+* add item generics to analytics types for easy customization ([#1101](https://github.com/vtex/faststore/issues/1101)) ([51e9d96](https://github.com/vtex/faststore/commit/51e9d96b82062113a96a95159963ff85a22086fc))
+
+
+
+
+
 ## 1.4.13 (2022-01-07)
@@ -8,0 +19,0 @@

dist/analytics/events/add_payment_info.d.ts

 import type { CurrencyCode, Item } from './common';
-export interface AddPaymentInfoParams {
+export interface AddPaymentInfoParams<T extends Item = Item> {
     currency?: CurrencyCode;
@@ -7,7 +7,7 @@ value?: number;
     payment_type?: string;
-    items?: Item[];
+    items?: T[];
 }
-export interface AddPaymentInfoEvent {
+export interface AddPaymentInfoEvent<T extends Item = Item> {
     name: 'add_payment_info';
-    params: AddPaymentInfoParams;
+    params: AddPaymentInfoParams<T>;
 }

dist/analytics/events/add_shipping_info.d.ts

 import type { CurrencyCode, Item } from './common';
-export interface AddShippingInfoParams {
+export interface AddShippingInfoParams<T extends Item = Item> {
     currency?: CurrencyCode;
@@ -7,7 +7,7 @@ value?: number;
     shipping_tier?: string;
-    items?: Item[];
+    items?: T[];
 }
-export interface AddShippingInfoEvent {
+export interface AddShippingInfoEvent<T extends Item = Item> {
     name: 'add_shipping_info';
-    params: AddShippingInfoParams;
+    params: AddShippingInfoParams<T>;
 }

dist/analytics/events/add_to_cart.d.ts

 import type { CurrencyCode, Item } from './common';
-export interface AddToCartParams {
+export interface AddToCartParams<T extends Item = Item> {
     currency?: CurrencyCode;
     value?: number;
-    items?: Item[];
+    items?: T[];
 }
-export interface AddToCartEvent {
+export interface AddToCartEvent<T extends Item = Item> {
     name: 'add_to_cart';
-    params: AddToCartParams;
+    params: AddToCartParams<T>;
 }

dist/analytics/events/add_to_wishlist.d.ts

 import type { CurrencyCode, Item } from './common';
-export interface AddToWishlistParams {
+export interface AddToWishlistParams<T extends Item = Item> {
     currency?: CurrencyCode;
     value?: number;
-    items?: Item[];
+    items?: T[];
 }
-export interface AddToWishlistEvent {
+export interface AddToWishlistEvent<T extends Item = Item> {
     name: 'add_to_wishlist';
-    params: AddToWishlistParams;
+    params: AddToWishlistParams<T>;
 }

dist/analytics/events/begin_checkout.d.ts

 import type { CurrencyCode, Item } from './common';
-export interface BeginCheckoutParams {
+export interface BeginCheckoutParams<T extends Item = Item> {
     currency?: CurrencyCode;
     value?: number;
     coupon?: string;
-    items?: Item[];
+    items?: T[];
 }
-export interface BeginCheckoutEvent {
+export interface BeginCheckoutEvent<T extends Item = Item> {
     name: 'begin_checkout';
-    params: BeginCheckoutParams;
+    params: BeginCheckoutParams<T>;
 }

dist/analytics/events/purchase.d.ts

 import type { CurrencyCode, Item } from './common';
-export interface PurchaseParams {
+export interface PurchaseParams<T extends Item = Item> {
     currency?: CurrencyCode;
@@ -10,7 +10,7 @@ transaction_id?: string;
     tax?: number;
-    items?: Item[];
+    items?: T[];
 }
-export interface PurchaseEvent {
+export interface PurchaseEvent<T extends Item = Item> {
     name: 'purchase';
-    params: PurchaseParams;
+    params: PurchaseParams<T>;
 }

dist/analytics/events/refund.d.ts

 import type { CurrencyCode, Item } from './common';
-export interface RefundParams {
+export interface RefundParams<T extends Item = Item> {
     currency?: CurrencyCode;
@@ -10,7 +10,7 @@ transaction_id?: string;
     tax?: number;
-    items?: Item[];
+    items?: T[];
 }
-export interface RefundEvent {
+export interface RefundEvent<T extends Item = Item> {
     name: 'refund';
-    params: RefundParams;
+    params: RefundParams<T>;
 }

dist/analytics/events/remove_from_cart.d.ts

 import type { CurrencyCode, Item } from './common';
-export interface RemoveFromCartParams {
+export interface RemoveFromCartParams<T extends Item = Item> {
     currency?: CurrencyCode;
     value?: number;
-    items?: Item[];
+    items?: T[];
 }
-export interface RemoveFromCartEvent {
+export interface RemoveFromCartEvent<T extends Item = Item> {
     name: 'remove_from_cart';
-    params: RemoveFromCartParams;
+    params: RemoveFromCartParams<T>;
 }

dist/analytics/events/select_item.d.ts

 import type { Item } from './common';
-export interface SelectItemParams {
+export interface SelectItemParams<T extends Item = Item> {
     item_list_id?: string;
     item_list_name?: string;
-    items?: Item[];
+    items?: T[];
 }
-export interface SelectItemEvent {
+export interface SelectItemEvent<T extends Item = Item> {
     name: 'select_item';
-    params: SelectItemParams;
+    params: SelectItemParams<T>;
 }

dist/analytics/events/select_promotion.d.ts

 import type { PromotionItem, PromotionParams } from './common';
-export interface SelectPromotionItems {
-    items?: PromotionItem[];
+export interface SelectPromotionItems<T extends PromotionItem = PromotionItem> {
+    items?: T[];
 }
-export declare type SelectPromotionParams = PromotionParams & SelectPromotionItems;
-export interface SelectPromotionEvent {
+export declare type SelectPromotionParams<T extends PromotionItem = PromotionItem> = PromotionParams & SelectPromotionItems<T>;
+export interface SelectPromotionEvent<T extends PromotionItem = PromotionItem> {
     name: 'select_promotion';
-    params: SelectPromotionParams;
+    params: SelectPromotionParams<T>;
 }

dist/analytics/events/view_cart.d.ts

 import type { CurrencyCode, Item } from './common';
-export interface ViewCartParams {
+export interface ViewCartParams<T extends Item = Item> {
     currency?: CurrencyCode;
     value?: number;
-    items?: Item[];
+    items?: T[];
 }
-export interface ViewCartEvent {
+export interface ViewCartEvent<T extends Item = Item> {
     name: 'view_cart';
-    params: ViewCartParams;
+    params: ViewCartParams<T>;
 }

dist/analytics/events/view_item_list.d.ts

 import type { Item } from './common';
-export interface ViewItemListParams {
+export interface ViewItemListParams<T extends Item = Item> {
     item_list_id?: string;
     item_list_name?: string;
-    items?: Item[];
+    items?: T[];
 }
-export interface ViewItemListEvent {
+export interface ViewItemListEvent<T extends Item = Item> {
     name: 'view_item_list';
-    params: ViewItemListParams;
+    params: ViewItemListParams<T>;
 }

dist/analytics/events/view_item.d.ts

 import type { CurrencyCode, Item } from './common';
-export interface ViewItemParams {
+export interface ViewItemParams<T extends Item = Item> {
     currency?: CurrencyCode;
     value?: number;
-    items?: Item[];
+    items?: T[];
 }
-export interface ViewItemEvent {
+export interface ViewItemEvent<T extends Item = Item> {
     name: 'view_item';
-    params: ViewItemParams;
+    params: ViewItemParams<T>;
 }

dist/analytics/events/view_promotion.d.ts

 import type { PromotionItem, PromotionParams } from './common';
-export interface ViewPromotionItems {
-    items?: PromotionItem[];
+export interface ViewPromotionItems<T extends PromotionItem = PromotionItem> {
+    items?: T[];
 }
-export declare type ViewPromotionParams = PromotionParams & ViewPromotionItems;
-export interface ViewPromotionEvent {
+export declare type ViewPromotionParams<T extends PromotionItem = PromotionItem> = PromotionParams & ViewPromotionItems<T>;
+export interface ViewPromotionEvent<T extends PromotionItem = PromotionItem> {
     name: 'view_promotion';
-    params: ViewPromotionParams;
+    params: ViewPromotionParams<T>;
 }

package.json

 {
   "name": "@faststore/sdk",
-  "version": "1.4.13",
+  "version": "1.4.14",
   "description": "Hooks for creating your next component library",
@@ -57,3 +57,3 @@ "license": "MIT",
   },
-  "gitHead": "7fa44e9583d662c49b855f2097d00af2014a1851"
+  "gitHead": "c564e7176423f98a4de0165e9e622bc342e67c8d"
 }

src/analytics/events/add_payment_info.ts

 import type { CurrencyCode, Item } from './common'
 
-export interface AddPaymentInfoParams {
+export interface AddPaymentInfoParams<T extends Item = Item> {
   currency?: CurrencyCode
@@ -8,8 +8,8 @@ value?: number
   payment_type?: string
-  items?: Item[]
+  items?: T[]
 }
 
-export interface AddPaymentInfoEvent {
+export interface AddPaymentInfoEvent<T extends Item = Item> {
   name: 'add_payment_info'
-  params: AddPaymentInfoParams
+  params: AddPaymentInfoParams<T>
 }

src/analytics/events/add_shipping_info.ts

 import type { CurrencyCode, Item } from './common'
 
-export interface AddShippingInfoParams {
+export interface AddShippingInfoParams<T extends Item = Item> {
   currency?: CurrencyCode
@@ -8,8 +8,8 @@ value?: number
   shipping_tier?: string
-  items?: Item[]
+  items?: T[]
 }
 
-export interface AddShippingInfoEvent {
+export interface AddShippingInfoEvent<T extends Item = Item> {
   name: 'add_shipping_info'
-  params: AddShippingInfoParams
+  params: AddShippingInfoParams<T>
 }

src/analytics/events/add_to_cart.ts

 import type { CurrencyCode, Item } from './common'
 
-export interface AddToCartParams {
+export interface AddToCartParams<T extends Item = Item> {
   currency?: CurrencyCode
   value?: number
-  items?: Item[]
+  items?: T[]
 }
 
-export interface AddToCartEvent {
+export interface AddToCartEvent<T extends Item = Item> {
   name: 'add_to_cart'
-  params: AddToCartParams
+  params: AddToCartParams<T>
 }

src/analytics/events/add_to_wishlist.ts

 import type { CurrencyCode, Item } from './common'
 
-export interface AddToWishlistParams {
+export interface AddToWishlistParams<T extends Item = Item> {
   currency?: CurrencyCode
   value?: number
-  items?: Item[]
+  items?: T[]
 }
 
-export interface AddToWishlistEvent {
+export interface AddToWishlistEvent<T extends Item = Item> {
   name: 'add_to_wishlist'
-  params: AddToWishlistParams
+  params: AddToWishlistParams<T>
 }

src/analytics/events/begin_checkout.ts

 import type { CurrencyCode, Item } from './common'
 
-export interface BeginCheckoutParams {
+export interface BeginCheckoutParams<T extends Item = Item> {
   currency?: CurrencyCode
   value?: number
   coupon?: string
-  items?: Item[]
+  items?: T[]
 }
 
-export interface BeginCheckoutEvent {
+export interface BeginCheckoutEvent<T extends Item = Item> {
   name: 'begin_checkout'
-  params: BeginCheckoutParams
+  params: BeginCheckoutParams<T>
 }

src/analytics/events/purchase.ts

 import type { CurrencyCode, Item } from './common'
 
-export interface PurchaseParams {
+export interface PurchaseParams<T extends Item = Item> {
   currency?: CurrencyCode
@@ -11,8 +11,8 @@ transaction_id?: string
   tax?: number
-  items?: Item[]
+  items?: T[]
 }
 
-export interface PurchaseEvent {
+export interface PurchaseEvent<T extends Item = Item> {
   name: 'purchase'
-  params: PurchaseParams
+  params: PurchaseParams<T>
 }

src/analytics/events/refund.ts

 import type { CurrencyCode, Item } from './common'
 
-export interface RefundParams {
+export interface RefundParams<T extends Item = Item> {
   currency?: CurrencyCode
@@ -11,8 +11,8 @@ transaction_id?: string
   tax?: number
-  items?: Item[]
+  items?: T[]
 }
 
-export interface RefundEvent {
+export interface RefundEvent<T extends Item = Item> {
   name: 'refund'
-  params: RefundParams
+  params: RefundParams<T>
 }

src/analytics/events/remove_from_cart.ts

 import type { CurrencyCode, Item } from './common'
 
-export interface RemoveFromCartParams {
+export interface RemoveFromCartParams<T extends Item = Item> {
   currency?: CurrencyCode
   value?: number
-  items?: Item[]
+  items?: T[]
 }
 
-export interface RemoveFromCartEvent {
+export interface RemoveFromCartEvent<T extends Item = Item> {
   name: 'remove_from_cart'
-  params: RemoveFromCartParams
+  params: RemoveFromCartParams<T>
 }

src/analytics/events/select_item.ts

 import type { Item } from './common'
 
-export interface SelectItemParams {
+export interface SelectItemParams<T extends Item = Item> {
   item_list_id?: string
   item_list_name?: string
-  items?: Item[]
+  items?: T[]
 }
 
-export interface SelectItemEvent {
+export interface SelectItemEvent<T extends Item = Item> {
   name: 'select_item'
-  params: SelectItemParams
+  params: SelectItemParams<T>
 }

src/analytics/events/select_promotion.ts

 import type { PromotionItem, PromotionParams } from './common'
 
-export interface SelectPromotionItems {
-  items?: PromotionItem[]
+export interface SelectPromotionItems<T extends PromotionItem = PromotionItem> {
+  items?: T[]
 }
 
-export type SelectPromotionParams = PromotionParams & SelectPromotionItems
+export type SelectPromotionParams<
+  T extends PromotionItem = PromotionItem
+> = PromotionParams & SelectPromotionItems<T>
 
-export interface SelectPromotionEvent {
+export interface SelectPromotionEvent<T extends PromotionItem = PromotionItem> {
   name: 'select_promotion'
-  params: SelectPromotionParams
+  params: SelectPromotionParams<T>
 }

src/analytics/events/view_cart.ts

 import type { CurrencyCode, Item } from './common'
 
-export interface ViewCartParams {
+export interface ViewCartParams<T extends Item = Item> {
   currency?: CurrencyCode
   value?: number
-  items?: Item[]
+  items?: T[]
 }
 
-export interface ViewCartEvent {
+export interface ViewCartEvent<T extends Item = Item> {
   name: 'view_cart'
-  params: ViewCartParams
+  params: ViewCartParams<T>
 }

src/analytics/events/view_item_list.ts

 import type { Item } from './common'
 
-export interface ViewItemListParams {
+export interface ViewItemListParams<T extends Item = Item> {
   item_list_id?: string
   item_list_name?: string
-  items?: Item[]
+  items?: T[]
 }
 
-export interface ViewItemListEvent {
+export interface ViewItemListEvent<T extends Item = Item> {
   name: 'view_item_list'
-  params: ViewItemListParams
+  params: ViewItemListParams<T>
 }

src/analytics/events/view_item.ts

 import type { CurrencyCode, Item } from './common'
 
-export interface ViewItemParams {
+export interface ViewItemParams<T extends Item = Item> {
   currency?: CurrencyCode
   value?: number
-  items?: Item[]
+  items?: T[]
 }
 
-export interface ViewItemEvent {
+export interface ViewItemEvent<T extends Item = Item> {
   name: 'view_item'
-  params: ViewItemParams
+  params: ViewItemParams<T>
 }

src/analytics/events/view_promotion.ts

 import type { PromotionItem, PromotionParams } from './common'
 
-export interface ViewPromotionItems {
-  items?: PromotionItem[]
+export interface ViewPromotionItems<T extends PromotionItem = PromotionItem> {
+  items?: T[]
 }
 
-export type ViewPromotionParams = PromotionParams & ViewPromotionItems
+export type ViewPromotionParams<
+  T extends PromotionItem = PromotionItem
+> = PromotionParams & ViewPromotionItems<T>
 
-export interface ViewPromotionEvent {
+export interface ViewPromotionEvent<T extends PromotionItem = PromotionItem> {
   name: 'view_promotion'
-  params: ViewPromotionParams
+  params: ViewPromotionParams<T>
 }

No alert changes

Improved metrics

Total package byte prevSize

285956

increased by0.65%

Lines of code

3599

increased by0.11%

No dependency changes