-
Notifications
You must be signed in to change notification settings - Fork 43
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
refactor: Create Interfaces for eCommerce (#964)
- Loading branch information
1 parent
c8340c3
commit 78a0cb2
Showing
10 changed files
with
238 additions
and
30 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,201 @@ | ||
| import { | ||
| ProductAction, | ||
| Product, | ||
| Promotion, | ||
| CommerceEvent, | ||
| } from '@mparticle/event-models'; | ||
| import { | ||
| SDKEventAttrs, | ||
| SDKEventOptions, | ||
| TransactionAttributes, | ||
| } from '@mparticle/web-sdk'; | ||
| import { valueof } from './utils'; | ||
| import { | ||
| ProductActionType, | ||
| PromotionActionType, | ||
| CommerceEventType, | ||
| EventType, | ||
| } from './types'; | ||
| import { | ||
| SDKEvent, | ||
| SDKEventCustomFlags, | ||
| SDKImpression, | ||
| SDKProduct, | ||
| SDKProductImpression, | ||
| SDKPromotion, | ||
| } from './sdkRuntimeModels'; | ||
|
|
||
| interface IECommerceShared { | ||
| createProduct( | ||
| name: string, | ||
| sku: string | number, | ||
| price: string | number, | ||
| quantity?: string | number, | ||
| variant?: string, | ||
| category?: string, | ||
| brand?: string, | ||
| position?: number, | ||
| couponCode?: string, | ||
| attributes?: SDKEventAttrs | ||
| ): SDKProduct | null; | ||
| createImpression(name: string, product: Product): SDKImpression | null; | ||
| createPromotion( | ||
| id: string | number, | ||
| creative?: string, | ||
| name?: string, | ||
| position?: number | ||
| ): SDKPromotion | null; | ||
| createTransactionAttributes( | ||
| id: string | number, | ||
| affiliation?: string, | ||
| couponCode?: string, | ||
| revenue?: string | number, | ||
| shipping?: string | number, | ||
| tax?: number | ||
| ): TransactionAttributes | null; | ||
| expandCommerceEvent(event: CommerceEvent): SDKEvent[] | null; | ||
| } | ||
|
|
||
| export interface SDKCart { | ||
| add(product: SDKProduct | SDKProduct[], logEvent?: boolean): void; | ||
| remove(product: SDKProduct | SDKProduct[], logEvent?: boolean): void; | ||
| clear(): void; | ||
| } | ||
|
|
||
| // Used for the public `eCommerce` namespace | ||
| export interface SDKECommerceAPI extends IECommerceShared { | ||
| logCheckout( | ||
| step: number, | ||
| option?: string, | ||
| attrs?: SDKEventAttrs, | ||
| customFlags?: SDKEventCustomFlags | ||
| ): void; | ||
| logImpression( | ||
| impression: SDKProductImpression, | ||
| attrs?: SDKEventAttrs, | ||
| customFlags?: SDKEventCustomFlags, | ||
| eventOptions?: SDKEventOptions | ||
| ): void; | ||
| logProductAction( | ||
| productActionType: valueof<typeof ProductActionType>, | ||
| product: SDKProduct | SDKProduct[], | ||
| attrs?: SDKEventAttrs, | ||
| customFlags?: SDKEventCustomFlags, | ||
| transactionAttributes?: TransactionAttributes, | ||
| eventOptions?: SDKEventOptions | ||
| ): void; | ||
| logPromotion( | ||
| type: valueof<typeof PromotionActionType>, | ||
| promotion: SDKPromotion, | ||
| attrs?: SDKEventAttrs, | ||
| customFlags?: SDKEventCustomFlags, | ||
| eventOptions?: SDKEventOptions | ||
| ): void; | ||
| setCurrencyCode(code: string): void; | ||
|
|
||
| /* | ||
| * @deprecated | ||
| */ | ||
| Cart: SDKCart; | ||
|
|
||
| /* | ||
| * @deprecated | ||
| */ | ||
| logPurchase( | ||
| transactionAttributes: TransactionAttributes, | ||
| product: SDKProduct | SDKProduct[], | ||
| clearCart?: boolean, | ||
| attrs?: SDKEventAttrs, | ||
| customFlags?: SDKEventCustomFlags | ||
| ): void; | ||
|
|
||
| /* | ||
| * @deprecated | ||
| */ | ||
| logRefund( | ||
| transactionAttributes: TransactionAttributes, | ||
| product: SDKProduct | SDKProduct[], | ||
| clearCart?: boolean, | ||
| attrs?: SDKEventAttrs, | ||
| customFlags?: SDKEventCustomFlags | ||
| ): void; | ||
| } | ||
|
|
||
| interface ExtractedActionAttributes { | ||
| Affiliation?: string; | ||
| 'Coupon Code'?: string; | ||
| 'Total Amount'?: number; | ||
| 'Shipping Amount'?: number; | ||
| 'Tax Amount'?: number; | ||
| 'Checkout Option'?: string; | ||
| 'Checkout Step'?: number; | ||
| 'Transaction ID'?: string; | ||
| } | ||
| interface ExtractedProductAttributes { | ||
| 'Coupon Code'?: string; | ||
| Brand?: string; | ||
| Category?: string; | ||
| Name?: string; | ||
| Id?: string; | ||
| 'Item Price'?: number; | ||
| Quantity?: number; | ||
| Position?: number; | ||
| Variant?: string; | ||
| 'Total Product Amount': number; | ||
| } | ||
| interface ExtractedPromotionAttributes { | ||
| Id?: string; | ||
| Creative?: string; | ||
| Name?: string; | ||
| Position?: number; | ||
| } | ||
| interface ExtractedTransactionId { | ||
| 'Transaction ID'?: string; | ||
| } | ||
|
|
||
| // Used for the private `_Ecommerce` namespace | ||
| export interface IECommerce extends IECommerceShared { | ||
| buildProductList(event: SDKEvent, product: Product | Product[]): Product[]; | ||
| convertProductActionToEventType( | ||
| productActionType: valueof<typeof ProductActionType> | ||
| ): // https://go.mparticle.com/work/SQDSDKS-4801 | ||
| typeof CommerceEventType | typeof EventType | null; | ||
| convertPromotionActionToEventType( | ||
| promotionActionType: valueof<typeof PromotionActionType> | ||
| ): typeof CommerceEventType | null; | ||
| convertTransactionAttributesToProductAction( | ||
| transactionAttributes: TransactionAttributes, | ||
| productAction: ProductAction | ||
| ): void; | ||
| createCommerceEventObject( | ||
| customFlags: SDKEventCustomFlags, | ||
| options?: SDKEventOptions | ||
| ): SDKEvent | null; | ||
| expandProductAction(commerceEvent: CommerceEvent): SDKEvent[]; | ||
| expandProductImpression(commerceEvent: CommerceEvent): SDKEvent[]; | ||
| expandPromotionAction(commerceEvent: CommerceEvent): SDKEvent[]; | ||
| extractActionAttributes( | ||
| attributes: ExtractedActionAttributes, | ||
| productAction: ProductAction | ||
| ): void; | ||
| extractProductAttributes( | ||
| attributes: ExtractedProductAttributes, | ||
| product: Product | ||
| ): void; | ||
| extractPromotionAttributes( | ||
| attributes: ExtractedPromotionAttributes, | ||
| promotion: Promotion | ||
| ): void; | ||
| extractTransactionId( | ||
| attributes: ExtractedTransactionId, | ||
| productAction: ProductAction | ||
| ): void; | ||
| generateExpandedEcommerceName(eventName: string, plusOne: boolean): string; | ||
| getProductActionEventName( | ||
| productActionType: valueof<typeof ProductActionType> | ||
| ): string; | ||
| getPromotionActionEventName( | ||
| promotionActionType: valueof<typeof PromotionActionType> | ||
| ): string; | ||
| sanitizeAmount(amount: string | number, category: string): number; | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.