@blux.ai/web-sdk 0.0.7 → 1.0.0-rc0

package/README.md

@@ -20,11 +20,11 @@ yarn add @blux.ai/web-sdk
 - 필요 변수 : `클라이언트 ID`, `API 키`
 
 ```typescript
-BluxClient.setLogLevel("debug");
-BluxClient.init({
-  bluxClientId: "{blux_client_id}",
+const bluxClient = await BluxClient.init({
+  applicationId: "{blux_client_id}",
   bluxApiKey: "{blux_api_key}",
 });
+bluxClient.setLogLevel("debug");
 ```
 
 - **setLogLevel** : 연동 관련하여 디버깅을 하기 위해서 로깅을 활성화할 수 있습니다. 해당 설정은 정적이므로 BluxClient를 초기화하기 전에 호출하실 수 있습니다.
@@ -42,7 +42,7 @@ BluxClient.init({
 - 회원 유저가 앱을 실행하는 시점에도 `initialize` 메소드 호출 이후에 실행되어야 합니다.
 
 ```typescript
-BluxClient.signIn("USER ID");
+bluxClient.signIn("USER ID");
 ```
 
 ### setUserProperties
@@ -50,8 +50,8 @@ BluxClient.signIn("USER ID");
 - 유저에게 지정된 속성들을 부여합니다. 전화번호, 이메일 번호를 등록할 수 있습니다.
 
 ```typescript
-BluxClient.setUserProperties({
-  phone_number: "+821011112222",
+bluxClient.setUserProperties({
+  phone_number: "01011112222",
   email_address: "test@example.com",
 });
 ```
@@ -61,7 +61,7 @@ BluxClient.setUserProperties({
 - `setUserProperties`에서 설정할 수 있는 지정된 속성 외 임의의 속성을 부여할 수 있습니다.
 
 ```typescript
-BluxClient.setCustomUserProperties({
+bluxClient.setCustomUserProperties({
   custom_key1: "any_value",
   custom_key2: true,
   custom_key3: null,
@@ -75,7 +75,7 @@ BluxClient.setCustomUserProperties({
 - 유저들을 더 잘 식별하기위해 사용됩니다.
 
 ```typescript
-BluxClient.signOut();
+bluxClient.signOut();
 ```
 
 ### sendEvent
@@ -87,9 +87,9 @@ BluxClient.signOut();
 ---
 
 ```typescript
-BluxClient.sendEvent(
+bluxClient.sendEvent(
   new AddProductDetailViewEvent({
-    itemId: "ITEM_ID",
+    item_id: "ITEM_ID",
   }),
 );
 ```
@@ -101,9 +101,9 @@ BluxClient.sendEvent(
 ---
 
 ```typescript
-BluxClient.sendEvent(
+bluxClient.sendEvent(
   new AddLikeEvent({
-    itemId: "ITEM_ID",
+    item_id: "ITEM_ID",
   }),
 );
 ```
@@ -115,9 +115,9 @@ BluxClient.sendEvent(
 ---
 
 ```typescript
-BluxClient.sendEvent(
+bluxClient.sendEvent(
   new AddCartaddEvent({
-    itemId: "ITEM_ID",
+    item_id: "ITEM_ID",
   }),
 );
 ```
@@ -134,9 +134,9 @@ BluxClient.sendEvent(
   - `AddPurchaseEvent` 객체를 각 상품 구매건에 맞춰서 생성한 후 list 형태로 넘겨주시면 됩니다.
 
 ```typescript
-BluxClient.sendEvent(
+bluxClient.sendEvent(
   new AddPurchaseEvent({
-    itemId: "ITEM_ID",
+    item_id: "ITEM_ID",
     price: 1000,
   }),
 );
@@ -144,13 +144,13 @@ BluxClient.sendEvent(
 
 ```typescript
 // 복수 상품을 구매한 경우
-BluxClient.sendEvent([
+bluxClient.sendEvent([
   new AddPurchaseEvent({
-    itemId: "ITEM_ID_1",
+    item_id: "ITEM_ID_1",
     price: 1000,
   }),
   new AddPurchaseEvent({
-    itemId: "ITEM_ID_2",
+    item_id: "ITEM_ID_2",
     price: 2000,
   }),
 ]);

package/dist/package.json

@@ -0,0 +1,35 @@
+{
+    "name": "@blux.ai/web-sdk",
+    "version": "1.0.0-rc0",
+    "description": "The official Blux JavaScript browser client library",
+    "main": "dist/index.js",
+    "module": "dist/index.js",
+    "types": "dist/index.d.ts",
+    "license": "UNLICENSED",
+    "scripts": {
+        "test": "jest",
+        "build": "tsc",
+        "dev": "yarn build -w",
+        "prepack": "rm -rf dist && yarn build",
+        "deploy": "npm publish --access public"
+    },
+    "author": "Z.Ai Inc.",
+    "homepage": "https://www.blux.ai/",
+    "devDependencies": {
+        "@sentry/types": "^8.35.0",
+        "@types/uuid": "^10.0.0",
+        "typescript": "^4.6.3"
+    },
+    "dependencies": {
+        "axios": "1.7.7",
+        "bson-objectid": "^2.0.4",
+        "dayjs": "1.11.13",
+        "lodash": "4.17.21",
+        "rxjs": "^7.8.1",
+        "uuid": "^10.0.0",
+        "zod": "3.23.8"
+    },
+    "installConfig": {
+        "hoistingLimits": "workspaces"
+    }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@blux.ai/web-sdk",
-  "version": "0.0.7",
+  "version": "1.0.0-rc0",
   "description": "The official Blux JavaScript browser client library",
   "main": "dist/index.js",
   "module": "dist/index.js",
@@ -21,7 +21,7 @@
     "typescript": "^4.6.3"
   },
   "dependencies": {
-    "axios": "^1.7.2",
+    "axios": "1.7.7",
     "bson-objectid": "^2.0.4",
     "dayjs": "1.11.13",
     "lodash": "4.17.21",

package/demo/src/App.test.tsx

@@ -1,9 +0,0 @@
-import React from "react";
-import { render, screen } from "@testing-library/react";
-import App from "./App";
-
-test("renders learn react link", () => {
-  render(<App />);
-  const linkElement = screen.getByText(/learn react/i);
-  expect(linkElement).toBeInTheDocument();
-});

package/demo/src/App.tsx

@@ -1,252 +0,0 @@
-import { useState } from "react";
-import { AddCustomEvent, ItemRecommendation, BluxClient } from "@blux.ai/web-sdk";
-
-const bluxClient = new BluxClient("stg");
-bluxClient.setLogLevel("debug");
-
-const searchParams = new URL(window.location.href).searchParams;
-const APPLICATION_ID_FROM_QUERY_PARAMS = searchParams.get("application_id");
-const API_KEY_FROM_QUERY_PARAMS = searchParams.get("api_key");
-const PHONE_NUMBER_FROM_QUERY_PARAMS = searchParams.get("phone_number");
-const EMAIL_FROM_QUERY_PARAMS = searchParams.get("email");
-
-function App() {
-  const [applicationId, setApplicationId] = useState<string>(
-    APPLICATION_ID_FROM_QUERY_PARAMS ?? "",
-  );
-  const [bluxApiKey, setBluxApiKey] = useState<string>(
-    API_KEY_FROM_QUERY_PARAMS ?? "",
-  );
-
-  const [userId, signIn] = useState<string>(
-    `test_user_id_${Math.floor(Math.random() * 100)}`,
-  );
-
-  const [telNumber, setTelNumber] = useState<string>(
-    PHONE_NUMBER_FROM_QUERY_PARAMS ?? "",
-  );
-  const [email, setEmail] = useState<string>(EMAIL_FROM_QUERY_PARAMS ?? "");
-  const [customKey, setCustomKey] = useState<string>("custom_key");
-  const [customValue, setCustomValue] = useState<string>("custom_value");
-  const [eventType, setEventType] = useState<string>("custom_event_type");
-  const [itemId, setItemId] = useState<string>("item_id_3");
-
-  // Recommendation Related States
-  const [callType, setCallType] = useState<string>("");
-  const [limit, setLimit] = useState<number>(10);
-  const [offset, setOffset] = useState<number>(0);
-  const [recommendationItemIds, setRecommendationItemIds] = useState<string>("ITEM_ID_1, ITEM_ID_2, ITEM_ID_3");
-
-  const [isInitialized, setIsInitialized] = useState<boolean>(false);
-
-  return (
-    <div className="p-10">
-      <div className="input-container flex flex-col">
-        <div>BluxUser</div>
-        <div>
-          {bluxClient.bluxUser$.value
-            ? JSON.stringify(bluxClient.bluxUser$.value, null, 2)
-            : "not initialized"}
-        </div>
-        <div className="flex">
-          <div>
-            <div>ApplicationId</div>
-            <input
-              className="w-[500px] rounded-md border-black border-2"
-              type="text"
-              placeholder="Enter Application Id"
-              value={applicationId}
-              onChange={(e) => setApplicationId(e.target.value)}
-            />
-            <div className="mt-3">BluxApiKey</div>
-            <input
-              className="w-[500px] rounded-md border-black border-2"
-              type="text"
-              placeholder="Enter Blux API Key"
-              value={bluxApiKey}
-              onChange={(e) => setBluxApiKey(e.target.value)}
-            />
-            <div className="mt-3">User Id</div>
-            <input
-              className="w-[500px] rounded-md border-black border-2"
-              type="text"
-              placeholder="Enter User Id"
-              value={userId}
-              onChange={(e) => signIn(e.target.value)}
-            />
-            <div className="mt-3">Phone Number</div>
-            <input
-              className="w-[500px] rounded-md border-black border-2"
-              type="text"
-              placeholder="Enter phone number"
-              value={telNumber}
-              onChange={(e) => setTelNumber(e.target.value)}
-            />
-            <div className="mt-3">Email</div>
-            <input
-              className="w-[500px] rounded-md border-black border-2"
-              type="text"
-              placeholder="Enter email"
-              value={email}
-              onChange={(e) => setEmail(e.target.value)}
-            />
-            <div className="mt-3">CustomKey</div>
-            <input
-              className="w-[500px] rounded-md border-black border-2"
-              type="text"
-              placeholder="Enter custom key"
-              value={customKey}
-              onChange={(e) => setCustomKey(e.target.value)}
-            />
-            <div className="mt-3">CustomValue</div>
-            <input
-              className="w-[500px] rounded-md border-black border-2"
-              type="text"
-              placeholder="Enter custom value"
-              value={customValue}
-              onChange={(e) => setCustomValue(e.target.value)}
-            />
-            <div className="mt-3">CustomEventType</div>
-            <input
-              className="w-[500px] rounded-md border-black border-2"
-              type="text"
-              placeholder="Enter custom event type"
-              value={eventType}
-              onChange={(e) => setEventType(e.target.value)}
-            />
-            <div className="mt-3">CustomEvent ItemId</div>
-            <input
-              className="w-[500px] rounded-md border-black border-2"
-              type="text"
-              placeholder="Enter custom event item id"
-              value={itemId}
-              onChange={(e) => setItemId(e.target.value)}
-            />
-          </div>
-          <div>
-            <div className="mt-3 ml-10">RecommendationCallType</div>
-            <input
-              className="w-[500px] rounded-md border-black border-2 ml-10"
-              type="text"
-              placeholder="Enter call type for item recommendation"
-              value={callType}
-              onChange={(e) => setCallType(e.target.value)}
-            />
-            <div className="ml-10">RecommendationLimit</div>
-            <input
-              className="w-[500px] rounded-md border-black border-2 ml-10"
-              type="text"
-              placeholder="Enter recommendation limit"
-              value={limit}
-              onChange={(e) => setLimit(Number(e.target.value))}
-            />
-            <div className="mt-3 ml-10">RecommendationOffset</div>
-            <input
-              className="w-[500px] rounded-md border-black border-2 ml-10"
-              type="text"
-              placeholder="Enter recommendation offset"
-              value={offset}
-              onChange={(e) => setOffset(Number(e.target.value))}
-            />
-            <div className="mt-3 ml-10">RecommendationItemIds</div>
-            <input
-              className="w-[500px] rounded-md border-black border-2 ml-10"
-              type="text"
-              placeholder="Enter recommendation item ids (comma separated)"
-              value={recommendationItemIds}
-              onChange={(e) => setRecommendationItemIds(e.target.value)}
-            />
-          </div>
-        </div>
-      </div>
-      <div className="mt-10 flex gap-4 w-[1000px] flex-wrap">
-        <button
-          className="bg-blue-500 rounded-md p-4 disabled:bg-gray-300"
-          onClick={() =>
-            bluxClient
-              .init({ applicationId, bluxApiKey })
-              .then((isSuccess) => setIsInitialized(isSuccess))
-          }
-          disabled={applicationId === "" || bluxApiKey === ""}
-        >
-          init
-        </button>
-        <button
-          className="bg-blue-500 rounded-md p-4 disabled:bg-gray-300"
-          onClick={() => bluxClient.signIn(userId)}
-          disabled={!isInitialized}
-        >
-          signIn
-        </button>
-        <button
-          className="bg-blue-500 rounded-md p-4 disabled:bg-gray-300"
-          onClick={() => bluxClient.signOut()}
-          disabled={!isInitialized}
-        >
-          signOut
-        </button>
-        <button
-          className="bg-blue-500 rounded-md p-4 disabled:bg-gray-300"
-          onClick={() =>
-            bluxClient.setUserProperties({ phone_number: telNumber })
-          }
-          disabled={!isInitialized}
-        >
-          setUserProperties (phone number)
-        </button>
-        <button
-          className="bg-blue-500 rounded-md p-4 disabled:bg-gray-300"
-          onClick={() => bluxClient.setUserProperties({ email_address: email })}
-          disabled={!isInitialized}
-        >
-          setUserProperties (email)
-        </button>
-        <button
-          className="bg-blue-500 rounded-md p-4 disabled:bg-gray-300"
-          onClick={() =>
-            bluxClient.setCustomUserProperties({ [customKey]: customValue })
-          }
-          disabled={!isInitialized}
-        >
-          setCustomProperties
-        </button>
-        <button
-          className="bg-blue-500 rounded-md p-4 disabled:bg-gray-300"
-          onClick={() =>
-            bluxClient.sendEvent(
-              new AddCustomEvent({
-                item_id: itemId,
-                event_properties: { [customKey]: customValue },
-                event_type: eventType,
-              }),
-            )
-          }
-          disabled={!isInitialized}
-        >
-          sendCustomEvent
-        </button>
-        <button
-          className="bg-blue-500 rounded-md p-4 disabled:bg-gray-300"
-          onClick={async () =>
-            {
-              const recommendationResponse = await bluxClient.getItemRecommendation(
-                new ItemRecommendation({
-                  call_type: callType,
-                  limit,
-                  offset,
-                  item_ids: recommendationItemIds ? recommendationItemIds.split(","): undefined,
-                }),
-              )
-              console.log(recommendationResponse);
-            }
-          }
-          disabled={!isInitialized || callType === ""}
-        >
-          getItemRecommendation
-        </button>
-      </div>
-    </div>
-  );
-}
-
-export default App;

package/demo/src/index.css

@@ -1,16 +0,0 @@
-@tailwind base;
-@tailwind components;
-@tailwind utilities;
-body {
-  margin: 0;
-  font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", "Roboto", "Oxygen",
-    "Ubuntu", "Cantarell", "Fira Sans", "Droid Sans", "Helvetica Neue",
-    sans-serif;
-  -webkit-font-smoothing: antialiased;
-  -moz-osx-font-smoothing: grayscale;
-}
-
-code {
-  font-family: source-code-pro, Menlo, Monaco, Consolas, "Courier New",
-    monospace;
-}

package/demo/src/index.tsx

@@ -1,19 +0,0 @@
-import React from "react";
-import ReactDOM from "react-dom/client";
-import "./index.css";
-import App from "./App";
-import reportWebVitals from "./reportWebVitals";
-
-const root = ReactDOM.createRoot(
-  document.getElementById("root") as HTMLElement,
-);
-root.render(
-  <React.StrictMode>
-    <App />
-  </React.StrictMode>,
-);
-
-// If you want to start measuring performance in your app, pass a function
-// to log results (for example: reportWebVitals(console.log))
-// or send to an analytics endpoint. Learn more: https://bit.ly/CRA-vitals
-reportWebVitals();

package/demo/src/react-app-env.d.ts

@@ -1 +0,0 @@
-/// <reference types="react-scripts" />

package/demo/src/reportWebVitals.ts

@@ -1,15 +0,0 @@
-import { ReportHandler } from "web-vitals";
-
-const reportWebVitals = (onPerfEntry?: ReportHandler) => {
-  if (onPerfEntry && onPerfEntry instanceof Function) {
-    import("web-vitals").then(({ getCLS, getFID, getFCP, getLCP, getTTFB }) => {
-      getCLS(onPerfEntry);
-      getFID(onPerfEntry);
-      getFCP(onPerfEntry);
-      getLCP(onPerfEntry);
-      getTTFB(onPerfEntry);
-    });
-  }
-};
-
-export default reportWebVitals;

package/demo/src/setupTests.ts

@@ -1,5 +0,0 @@
-// jest-dom adds custom jest matchers for asserting on DOM nodes.
-// allows you to do things like:
-// expect(element).toHaveTextContent(/react/i)
-// learn more: https://github.com/testing-library/jest-dom
-import "@testing-library/jest-dom";

package/dist/BluxClient.d.ts

@@ -1,43 +0,0 @@
-import { BehaviorSubject } from "rxjs";
-import type { LogLevel } from "./utils/Logger";
-import type { EventRequest } from "./events/types";
-import type { Event } from "./events/Event";
-import type { Recommendation } from "./recommendations/Recommendation";
-import { type APIs } from "./apis/APIs";
-export type SdkInfo = {
-    type: string;
-    version: string;
-};
-type BluxUser = {
-    id: string;
-    bluxApiKey: string;
-    applicationId: string;
-    deviceId: string;
-    userId?: string;
-};
-export declare class BluxClient {
-    private readonly STAGE;
-    private readonly api;
-    private readonly sdkInfo;
-    readonly bluxUser$: BehaviorSubject<BluxUser | undefined>;
-    readonly requestQueue$: BehaviorSubject<EventRequest[]>;
-    constructor(STAGE?: "local" | "dev" | "stg" | "prod");
-    private generateApiHeader;
-    init({ applicationId, bluxApiKey, }: {
-        applicationId: string;
-        bluxApiKey: string;
-    }): Promise<boolean>;
-    setLogLevel(logLevel: LogLevel): void;
-    private getBluxUserWithTimeout;
-    signIn(userId: string): Promise<void>;
-    signOut(): Promise<void>;
-    setUserProperties(userProperties: {
-        phone_number?: string;
-        email_address?: string;
-    }): Promise<void>;
-    setCustomUserProperties(customUserProperties: Record<string, string | boolean | number | null>): Promise<void>;
-    sendEvent(event: Event | Event[]): void;
-    getItemRecommendation(recommendation: Recommendation): Promise<APIs.bluxUsersGetItemRecommendations.ResponseData>;
-}
-export declare const bluxClient: BluxClient;
-export {};