@blux.ai/web-sdk 0.0.4-rc0 → 0.0.6-tommy0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (115) hide show
  1. package/README.md +6 -6
  2. package/demo/craco.config.js +2 -0
  3. package/demo/package.json +4 -2
  4. package/demo/public/index.html +1 -1
  5. package/demo/tailwind.config.js +2 -0
  6. package/dist/BluxClient.d.ts +16 -15
  7. package/dist/BluxClient.js +180 -320
  8. package/dist/BluxClient.js.map +1 -1
  9. package/dist/apis/createEvent.d.ts +4 -0
  10. package/dist/apis/createEvent.js +7 -0
  11. package/dist/apis/createEvent.js.map +1 -0
  12. package/dist/apis/getItemRecommendation.d.ts +4 -0
  13. package/dist/apis/getItemRecommendation.js +7 -0
  14. package/dist/apis/getItemRecommendation.js.map +1 -0
  15. package/dist/apis/initialize.d.ts +4 -0
  16. package/dist/apis/initialize.js +7 -0
  17. package/dist/apis/initialize.js.map +1 -0
  18. package/dist/apis/signIn.d.ts +4 -0
  19. package/dist/apis/signIn.js +7 -0
  20. package/dist/apis/signIn.js.map +1 -0
  21. package/dist/apis/signOut.d.ts +4 -0
  22. package/dist/apis/signOut.js +7 -0
  23. package/dist/apis/signOut.js.map +1 -0
  24. package/dist/apis/updateCustomUserProperties.d.ts +4 -0
  25. package/dist/apis/updateCustomUserProperties.js +7 -0
  26. package/dist/apis/updateCustomUserProperties.js.map +1 -0
  27. package/dist/apis/updateUserProperties.d.ts +4 -0
  28. package/dist/apis/updateUserProperties.js +7 -0
  29. package/dist/apis/updateUserProperties.js.map +1 -0
  30. package/dist/constants/URLS.d.ts +2 -6
  31. package/dist/constants/URLS.js +4 -14
  32. package/dist/constants/URLS.js.map +1 -1
  33. package/dist/events/AddCartaddEvent.d.ts +2 -2
  34. package/dist/events/AddCartaddEvent.js +9 -40
  35. package/dist/events/AddCartaddEvent.js.map +1 -1
  36. package/dist/events/AddCustomEvent.d.ts +2 -2
  37. package/dist/events/AddCustomEvent.js +11 -42
  38. package/dist/events/AddCustomEvent.js.map +1 -1
  39. package/dist/events/AddLikeEvent.d.ts +2 -2
  40. package/dist/events/AddLikeEvent.js +9 -40
  41. package/dist/events/AddLikeEvent.js.map +1 -1
  42. package/dist/events/AddPageViewEvent.d.ts +2 -2
  43. package/dist/events/AddPageViewEvent.js +9 -38
  44. package/dist/events/AddPageViewEvent.js.map +1 -1
  45. package/dist/events/AddProductDetailViewEvent.d.ts +2 -2
  46. package/dist/events/AddProductDetailViewEvent.js +11 -41
  47. package/dist/events/AddProductDetailViewEvent.js.map +1 -1
  48. package/dist/events/AddPurchaseEvent.d.ts +2 -2
  49. package/dist/events/AddPurchaseEvent.js +11 -39
  50. package/dist/events/AddPurchaseEvent.js.map +1 -1
  51. package/dist/events/AddRateEvent.d.ts +2 -2
  52. package/dist/events/AddRateEvent.js +9 -40
  53. package/dist/events/AddRateEvent.js.map +1 -1
  54. package/dist/events/AddRecommendationViewEvent.d.ts +2 -2
  55. package/dist/events/AddRecommendationViewEvent.js +8 -39
  56. package/dist/events/AddRecommendationViewEvent.js.map +1 -1
  57. package/dist/events/Event.d.ts +2 -2
  58. package/dist/events/Event.js +11 -25
  59. package/dist/events/Event.js.map +1 -1
  60. package/dist/events/VisitEvent.d.ts +5 -0
  61. package/dist/events/VisitEvent.js +11 -0
  62. package/dist/events/VisitEvent.js.map +1 -0
  63. package/dist/events/index.js +9 -28
  64. package/dist/events/index.js.map +1 -1
  65. package/dist/events/types.d.ts +6 -10
  66. package/dist/events/types.js +2 -6
  67. package/dist/events/types.js.map +1 -1
  68. package/dist/index.d.ts +3 -1
  69. package/dist/index.js +6 -23
  70. package/dist/index.js.map +1 -1
  71. package/dist/recommendations/ItemRecommendation.d.ts +5 -0
  72. package/dist/recommendations/ItemRecommendation.js +12 -0
  73. package/dist/recommendations/ItemRecommendation.js.map +1 -0
  74. package/dist/recommendations/Recommendation.d.ts +5 -0
  75. package/dist/recommendations/Recommendation.js +9 -0
  76. package/dist/recommendations/Recommendation.js.map +1 -0
  77. package/dist/recommendations/index.d.ts +1 -0
  78. package/dist/recommendations/index.js +2 -0
  79. package/dist/recommendations/index.js.map +1 -0
  80. package/dist/recommendations/types.d.ts +11 -0
  81. package/dist/recommendations/types.js +2 -0
  82. package/dist/recommendations/types.js.map +1 -0
  83. package/dist/utils/LocalStorage.js +14 -0
  84. package/dist/utils/LocalStorage.js.map +1 -0
  85. package/dist/{core → utils}/Logger.d.ts +1 -1
  86. package/dist/utils/Logger.js +49 -0
  87. package/dist/utils/Logger.js.map +1 -0
  88. package/dist/utils/getPath.d.ts +1 -0
  89. package/dist/utils/getPath.js +4 -0
  90. package/dist/utils/getPath.js.map +1 -0
  91. package/dist/utils/helper.js +2 -9
  92. package/dist/utils/helper.js.map +1 -1
  93. package/dist/utils/operators.d.ts +1 -1
  94. package/dist/utils/operators.js +5 -11
  95. package/dist/utils/operators.js.map +1 -1
  96. package/package.json +7 -6
  97. package/.prettierrc +0 -4
  98. package/.sentryclirc +0 -3
  99. package/demo/README.md +0 -46
  100. package/demo/src/App.test.tsx +0 -9
  101. package/demo/src/App.tsx +0 -158
  102. package/demo/src/index.css +0 -16
  103. package/demo/src/index.tsx +0 -19
  104. package/demo/src/react-app-env.d.ts +0 -1
  105. package/demo/src/reportWebVitals.ts +0 -15
  106. package/demo/src/setupTests.ts +0 -5
  107. package/demo/yarn.lock +0 -10120
  108. package/dist/core/LocalStorage.js +0 -21
  109. package/dist/core/LocalStorage.js.map +0 -1
  110. package/dist/core/Logger.js +0 -88
  111. package/dist/core/Logger.js.map +0 -1
  112. package/dist/utils/sentry.d.ts +0 -2
  113. package/dist/utils/sentry.js +0 -49
  114. package/dist/utils/sentry.js.map +0 -1
  115. /package/dist/{core → utils}/LocalStorage.d.ts +0 -0
package/README.md CHANGED
@@ -34,7 +34,7 @@ BluxClient.init({
34
34
  - `'error'`
35
35
  - `'fatal'`
36
36
 
37
- ### setUserId
37
+ ### signIn
38
38
 
39
39
  - 회원 유저에 대해서 부여하고 계시는 유저 ID를 넘겨주시면 됩니다.
40
40
  - Blux 서비스에서 같은 `UserId`를 가지는 유저는 같은 유저로 식별됩니다.
@@ -42,7 +42,7 @@ BluxClient.init({
42
42
  - 회원 유저가 앱을 실행하는 시점에도 `initialize` 메소드 호출 이후에 실행되어야 합니다.
43
43
 
44
44
  ```typescript
45
- BluxClient.setUserId("USER ID");
45
+ BluxClient.signIn("USER ID");
46
46
  ```
47
47
 
48
48
  ### setUserProperties
@@ -90,7 +90,7 @@ BluxClient.signOut();
90
90
  BluxClient.sendEvent(
91
91
  new AddProductDetailViewEvent({
92
92
  itemId: "ITEM_ID",
93
- })
93
+ }),
94
94
  );
95
95
  ```
96
96
 
@@ -104,7 +104,7 @@ BluxClient.sendEvent(
104
104
  BluxClient.sendEvent(
105
105
  new AddLikeEvent({
106
106
  itemId: "ITEM_ID",
107
- })
107
+ }),
108
108
  );
109
109
  ```
110
110
 
@@ -118,7 +118,7 @@ BluxClient.sendEvent(
118
118
  BluxClient.sendEvent(
119
119
  new AddCartaddEvent({
120
120
  itemId: "ITEM_ID",
121
- })
121
+ }),
122
122
  );
123
123
  ```
124
124
 
@@ -138,7 +138,7 @@ BluxClient.sendEvent(
138
138
  new AddPurchaseEvent({
139
139
  itemId: "ITEM_ID",
140
140
  price: 1000,
141
- })
141
+ }),
142
142
  );
143
143
  ```
144
144
 
package/demo/craco.config.js CHANGED
@@ -1,3 +1,5 @@
1
+ /* eslint-disable no-undef */
2
+
1
3
  module.exports = {
2
4
  webpack: {
3
5
  configure: (config) => {
package/demo/package.json CHANGED
@@ -3,10 +3,9 @@
3
3
  "version": "0.1.0",
4
4
  "private": true,
5
5
  "dependencies": {
6
- "@blux.ai/web-sdk": "../",
6
+ "@blux.ai/web-sdk": "workspace:*",
7
7
  "@testing-library/jest-dom": "^5.14.1",
8
8
  "@testing-library/react": "^13.0.0",
9
- "@testing-library/user-event": "^13.2.1",
10
9
  "@types/jest": "^27.0.1",
11
10
  "@types/node": "^16.7.13",
12
11
  "@types/react": "^18.0.0",
@@ -44,5 +43,8 @@
44
43
  "devDependencies": {
45
44
  "@craco/craco": "^7.1.0",
46
45
  "tailwindcss": "^3.4.4"
46
+ },
47
+ "installConfig": {
48
+ "hoistingLimits": "workspaces"
47
49
  }
48
50
  }
package/demo/public/index.html CHANGED
@@ -1,4 +1,4 @@
1
- <!DOCTYPE html>
1
+ <!doctype html>
2
2
  <html lang="en">
3
3
  <head>
4
4
  <meta charset="utf-8" />
package/demo/tailwind.config.js CHANGED
@@ -1,3 +1,5 @@
1
+ /* eslint-disable no-undef */
2
+
1
3
  /** @type {import('tailwindcss').Config} */
2
4
  module.exports = {
3
5
  content: ["./src/**/*.{js,jsx,ts,tsx}"],
package/dist/BluxClient.d.ts CHANGED
@@ -1,8 +1,9 @@
1
- import "./utils/sentry";
2
1
  import { BehaviorSubject } from "rxjs";
3
- import { LogLevel } from "./core/Logger";
4
- import { EventRequest } from "./events/types";
5
- import { Event } from "./events/Event";
2
+ import type { LogLevel } from "./utils/Logger";
3
+ import type { EventRequest } from "./events/types";
4
+ import type { Event } from "./events/Event";
5
+ import type { ItemRecommendationResponse } from "@blux.ai/common";
6
+ import type { Recommendation } from "./recommendations/Recommendation";
6
7
  export type SdkInfo = {
7
8
  type: string;
8
9
  version: string;
@@ -10,33 +11,33 @@ export type SdkInfo = {
10
11
  type BluxUser = {
11
12
  id: string;
12
13
  bluxApiKey: string;
13
- organizationId: string;
14
+ applicationId: string;
14
15
  deviceId: string;
15
16
  userId?: string;
16
17
  };
17
- declare class BluxClient {
18
+ export declare class BluxClient {
18
19
  private readonly STAGE;
19
- private readonly identifierApi;
20
- private readonly collectorApi;
20
+ private readonly api;
21
21
  private readonly sdkInfo;
22
22
  readonly bluxUser$: BehaviorSubject<BluxUser | undefined>;
23
23
  readonly requestQueue$: BehaviorSubject<EventRequest[]>;
24
- constructor(STAGE?: "local" | "dev" | "prod");
25
- private generateIdentifierHeader;
26
- init({ bluxClientId: organizationId, bluxApiKey, }: {
27
- bluxClientId: string;
24
+ constructor(STAGE?: "local" | "dev" | "stg" | "prod");
25
+ private generateApiHeader;
26
+ init({ applicationId, bluxApiKey, }: {
27
+ applicationId: string;
28
28
  bluxApiKey: string;
29
- }): Promise<void>;
29
+ }): Promise<boolean>;
30
30
  setLogLevel(logLevel: LogLevel): void;
31
31
  private getBluxUserWithTimeout;
32
- setUserId(userId: string): Promise<void>;
32
+ signIn(userId: string): Promise<void>;
33
33
  signOut(): Promise<void>;
34
34
  setUserProperties(userProperties: {
35
35
  phone_number?: string;
36
36
  email_address?: string;
37
37
  }): Promise<void>;
38
38
  setCustomUserProperties(customUserProperties: Record<string, string | boolean | number | null>): Promise<void>;
39
- sendEvent(event: Event | Event[]): Promise<void>;
39
+ sendEvent(event: Event | Event[]): void;
40
+ getItemRecommendation(recommendation: Recommendation): Promise<ItemRecommendationResponse>;
40
41
  }
41
42
  export declare const bluxClient: BluxClient;
42
43
  export {};