@blux.ai/web-sdk 1.2.2 → 2.0.0

package/README.md

@@ -17,12 +17,12 @@ yarn add @blux.ai/web-sdk
 
 ---
 
-- 필요 변수 : `클라이언트 ID`, `API 키`
+- 필요 변수 : `Application ID`, `API 키`
 
 ```typescript
 const bluxClient = new BluxClient({
-  applicationId: "{blux_client_id}",
-  bluxApiKey: "{blux_api_key}",
+  bluxApplicationId: "BLUX_APPLICATION_ID",
+  bluxAPIKey: "BLUX_API_KEY",
 });
 bluxClient.setLogLevel("warning");
 ```
@@ -42,7 +42,7 @@ bluxClient.setLogLevel("warning");
 - 회원 유저가 앱을 실행하는 시점에도 `initialize` 메소드 호출 이후에 실행되어야 합니다.
 
 ```typescript
-bluxClient.signIn("USER ID");
+bluxClient.signIn({ userId: "USER ID" });
 ```
 
 ### setUserProperties
@@ -51,8 +51,10 @@ bluxClient.signIn("USER ID");
 
 ```typescript
 bluxClient.setUserProperties({
-  phone_number: "01011112222",
-  email_address: "test@example.com",
+  userProperties: {
+    phone_number: "01011112222",
+    email_address: "test@example.com",
+  },
 });
 ```
 
@@ -62,10 +64,11 @@ bluxClient.setUserProperties({
 
 ```typescript
 bluxClient.setCustomUserProperties({
-  custom_key1: "any_value",
-  custom_key2: true,
-  custom_key3: null,
-  custom_key4: 3,
+  customUserProperties: {
+    custom_key1: "any_value",
+    custom_key2: true,
+    custom_key4: 3,
+  },
 });
 ```
 
@@ -89,7 +92,7 @@ bluxClient.signOut();
 ```typescript
 bluxClient.sendEvent(
   new AddProductDetailViewEvent({
-    item_id: "ITEM_ID",
+    itemId: "ITEM_ID",
   }),
 );
 ```
@@ -103,7 +106,7 @@ bluxClient.sendEvent(
 ```typescript
 bluxClient.sendEvent(
   new AddLikeEvent({
-    item_id: "ITEM_ID",
+    itemId: "ITEM_ID",
   }),
 );
 ```
@@ -117,41 +120,53 @@ bluxClient.sendEvent(
 ```typescript
 bluxClient.sendEvent(
   new AddCartaddEvent({
-    item_id: "ITEM_ID",
+    itemId: "ITEM_ID",
   }),
 );
 ```
 
 #### 상품 구매
 
-: 유저가 제품을 구매했을 때 사용 가능한 이벤트입니다. 추가 인풋으로 `price`가 요구되며, 제품의 구매 당시 가격을 기록하면 됩니다.
+: 유저가 제품을 구매했을 때 사용 가능한 이벤트입니다. paidAmount 파라미터의 경우, 캠페인을 통한 성과 집계에 사용되는 값입니다.
 
 ---
 
-- **_동일 상품 복수 구매_**
-  - price 파라미터의 경우, 해당 상품 판매를 통한 총 매출을 계산할 때 활용됩니다. 추천에 의한 매출 기여액 지표를 보여드릴 때 사용되는 값으로 만약 5,000원짜리 상품을 5개 구매하였다면, 25,000 을 입력하시면 됩니다.
-- **_복수 상품 구매_**
-  - `AddPurchaseEvent` 객체를 각 상품 구매건에 맞춰서 생성한 후 list 형태로 넘겨주시면 됩니다.
-
 ```typescript
 bluxClient.sendEvent(
-  new AddPurchaseEvent({
-    item_id: "ITEM_ID",
-    price: 1000,
+  new AddOrderEvent({
+    orderId: "ORDER_ID",
+    paidAmount: 1200,
+    orderAmount: 2000,
+    items: [
+      {
+        id: "ITEM_ID_1",
+        price: 1000,
+        quantity: 1,
+      },
+    ],
   }),
 );
 ```
 
 ```typescript
 // 복수 상품을 구매한 경우
-bluxClient.sendEvent([
-  new AddPurchaseEvent({
-    item_id: "ITEM_ID_1",
-    price: 1000,
-  }),
-  new AddPurchaseEvent({
-    item_id: "ITEM_ID_2",
-    price: 2000,
+bluxClient.sendEvent(
+  new AddOrderEvent({
+    orderId: "ORDER_ID",
+    paidAmount: 1200,
+    orderAmount: 2000,
+    items: [
+      {
+        id: "ITEM_ID_1",
+        price: 1000,
+        quantity: 1,
+      },
+      {
+        id: "ITEM_ID_2",
+        price: 2000,
+        quantity: 2,
+      },
+    ],
   }),
-]);
+);
 ```

package/dist/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@blux.ai/web-sdk",
-    "version": "1.2.2",
+    "version": "2.0.0",
     "description": "The official Blux JavaScript browser client library",
     "main": "dist/src/index.js",
     "module": "dist/src/index.js",

package/dist/src/BluxClient.d.ts

@@ -1,16 +1,16 @@
 import { BehaviorSubject } from "rxjs";
-import type { LogLevel } from "./utils/Logger";
+import { DevicePlatform, type APIs } from "./apis/APIs";
+import type { Event as BluxEvent } from "./events/Event";
 import type { EventRequest } from "./events/types";
-import type { Event } from "./events/Event";
-import { type APIs } from "./apis/APIs";
 import type { CategoryRec, ItemRec, ItemsRec, UserRec } from "./recs";
+import type { LogLevel } from "./utils/Logger";
 export type SdkInfo = {
-    type: string;
+    type: DevicePlatform;
     version: string;
 };
 type BluxUser = {
     id: string;
-    bluxApiKey: string;
+    bluxAPIKey: string;
     applicationId: string;
     deviceId?: string;
     userId?: string;
@@ -20,33 +20,46 @@ export declare class BluxClient {
     private readonly sdkInfo;
     readonly bluxUser$: BehaviorSubject<BluxUser | undefined>;
     readonly requestQueue$: BehaviorSubject<EventRequest[]>;
-    private readonly applicationId;
-    private readonly bluxApiKey;
-    private sectionViewCollectedSections;
-    private observingTargetElements;
-    private sectionViewObservers;
-    constructor({ applicationId, bluxApiKey, }: {
-        applicationId: string;
-        bluxApiKey: string;
+    readonly inappQueue$: BehaviorSubject<APIs.inappsDispatcher.ResponseData | undefined>;
+    private readonly bluxApplicationId;
+    private readonly bluxAPIKey;
+    private impressedElements;
+    private intersectionObservingElements;
+    private readonly intersectionObserver;
+    private readonly intersectionEntry$;
+    private hitElements;
+    constructor({ bluxApplicationId, bluxAPIKey, }: {
+        bluxApplicationId: string;
+        bluxAPIKey: string;
     }, completionCallback?: (args: {
         errorMessage?: string;
         success: boolean;
     }) => void);
     private generateApiHeader;
+    private handleSendRequest;
+    private handleInappEvent;
+    private displayInapp;
     private init;
     setLogLevel(logLevel: LogLevel): void;
     private getBluxUserWithTimeout;
-    signIn(userId: string): Promise<void>;
+    signIn({ userId }: {
+        userId: string;
+    }): Promise<void>;
     signOut(): Promise<void>;
-    setUserProperties(userProperties: {
-        phone_number?: string;
-        email_address?: string;
+    setUserProperties({ userProperties, }: {
+        userProperties: {
+            phone_number?: string;
+            email_address?: string;
+        };
+    }): Promise<void>;
+    setCustomUserProperties({ customUserProperties, }: {
+        customUserProperties: Record<string, string | boolean | number | null>;
     }): Promise<void>;
-    setCustomUserProperties(customUserProperties: Record<string, string | boolean | number | null>): Promise<void>;
-    sendEvent(event: Event | Event[]): void;
-    private handlePageTransition;
-    private registerSectionViewObserver;
-    private handleIntersection;
+    sendEvent(event: BluxEvent | BluxEvent[]): void;
+    private urlAndRef$;
+    private handleUrlAndRef;
+    private registerImpressionTracker;
+    private registerHitTracker;
     getUserRec(rec: UserRec): Promise<APIs.bluxUsersGetItemRecommendationsV2.ResponseData>;
     getItemRec(rec: ItemRec): Promise<APIs.bluxUsersGetItemRecommendationsV2.ResponseData>;
     getItemsRec(rec: ItemsRec): Promise<APIs.bluxUsersGetItemRecommendationsV2.ResponseData>;