@15gifts/sdk 0.14.0 → 0.14.1
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.
- package/dist/index.d.mts +63 -55
- package/dist/index.d.ts +63 -55
- package/dist/index.js +1 -1
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +1 -1
- package/dist/index.mjs.map +1 -1
- package/package.json +1 -1
package/dist/index.d.mts
CHANGED
|
@@ -891,14 +891,6 @@ interface paths {
|
|
|
891
891
|
requestBody?: {
|
|
892
892
|
content: {
|
|
893
893
|
"application/json": {
|
|
894
|
-
/** @description A 36 character alphanumeric hash that uniquely identifies a session.
|
|
895
|
-
*
|
|
896
|
-
*
|
|
897
|
-
* This should match the UUID V4 as specified in RFC 9652:
|
|
898
|
-
* https://datatracker.ietf.org/doc/html/rfc9562#name-uuid-version-4
|
|
899
|
-
*
|
|
900
|
-
* e.g f81d4fae-7dec-41d0-a765-00a0c91e6bf6 */
|
|
901
|
-
sessionId?: string | null;
|
|
902
894
|
/** @description A 36 character alphanumeric hash that uniquely identifies a user.
|
|
903
895
|
*
|
|
904
896
|
*
|
|
@@ -907,7 +899,7 @@ interface paths {
|
|
|
907
899
|
*
|
|
908
900
|
* e.g f81d4fae-7dec-41d0-a765-00a0c91e6bf6 */
|
|
909
901
|
userId?: string;
|
|
910
|
-
/** @description A timestamp describing the time the event occurred. This should conform to ISO 8601 standards and be in UTC. Example:
|
|
902
|
+
/** @description A timestamp describing the time the event occurred. This should conform to ISO 8601 standards and be in UTC. Example: "2024-07-17T10:11:16.591Z" */
|
|
911
903
|
eventAt?: string;
|
|
912
904
|
/** @description The page url at the time the event is fired */
|
|
913
905
|
url?: string;
|
|
@@ -915,7 +907,7 @@ interface paths {
|
|
|
915
907
|
browser?: string;
|
|
916
908
|
/** @description The customer that the event occurred on */
|
|
917
909
|
customerId: string;
|
|
918
|
-
/** @description The user agent string e.g.
|
|
910
|
+
/** @description The user agent string e.g. "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.124 Safari/537.36" */
|
|
919
911
|
userAgent?: string;
|
|
920
912
|
/** @description A 36 character alphanumeric hash that uniquely identifies a tracking event
|
|
921
913
|
*
|
|
@@ -938,6 +930,15 @@ interface paths {
|
|
|
938
930
|
pageviewId?: string | null;
|
|
939
931
|
/** @description A unique user id native to our customers web analytics platforms (adobe, google analytics etc). Helps us & our customers align our data with what customers see in their platforms. */
|
|
940
932
|
webAnalyticsPlatformUserId?: string | null;
|
|
933
|
+
/** @description A 36 character alphanumeric hash that uniquely identifies a session.
|
|
934
|
+
*
|
|
935
|
+
*
|
|
936
|
+
* This should match the UUID V4 as specified in RFC 9652:
|
|
937
|
+
* https://datatracker.ietf.org/doc/html/rfc9562#name-uuid-version-4
|
|
938
|
+
*
|
|
939
|
+
* e.g f81d4fae-7dec-41d0-a765-00a0c91e6bf6
|
|
940
|
+
* */
|
|
941
|
+
browserSessionId?: string | null;
|
|
941
942
|
/** @description The device screen width in pixels - window.screen.width in JS. This is a user level property that should never change. */
|
|
942
943
|
screenWidth?: number;
|
|
943
944
|
/** @description The device screen height in pixels - window.screen.height in JS. This is a user level property that should never change. */
|
|
@@ -982,16 +983,6 @@ interface paths {
|
|
|
982
983
|
* @enum {string}
|
|
983
984
|
*/
|
|
984
985
|
language?: "de" | "en" | "es" | "fr" | "it";
|
|
985
|
-
/** @description This property is intended to replace session_id, but is being used in the meantime so that developers can switch over to using browser_session_id without different services needing to all update in sync.
|
|
986
|
-
*
|
|
987
|
-
* A 36 character alphanumeric hash that uniquely identifies a session.
|
|
988
|
-
*
|
|
989
|
-
*
|
|
990
|
-
* This should match the UUID V4 as specified in RFC 9652:
|
|
991
|
-
* https://datatracker.ietf.org/doc/html/rfc9562#name-uuid-version-4
|
|
992
|
-
*
|
|
993
|
-
* e.g f81d4fae-7dec-41d0-a765-00a0c91e6bf6 */
|
|
994
|
-
browserSessionId?: string | null;
|
|
995
986
|
/**
|
|
996
987
|
* @description The name of the system/service that the event originates from
|
|
997
988
|
* @enum {string}
|
|
@@ -1314,14 +1305,6 @@ interface paths {
|
|
|
1314
1305
|
* } */
|
|
1315
1306
|
"application/json": {
|
|
1316
1307
|
additionalProperties?: {
|
|
1317
|
-
/** @description A 36 character alphanumeric hash that uniquely identifies a session.
|
|
1318
|
-
*
|
|
1319
|
-
*
|
|
1320
|
-
* This should match the UUID V4 as specified in RFC 9652:
|
|
1321
|
-
* https://datatracker.ietf.org/doc/html/rfc9562#name-uuid-version-4
|
|
1322
|
-
*
|
|
1323
|
-
* e.g f81d4fae-7dec-41d0-a765-00a0c91e6bf6 */
|
|
1324
|
-
session_id?: string | null;
|
|
1325
1308
|
/** @description A 36 character alphanumeric hash that uniquely identifies a user.
|
|
1326
1309
|
*
|
|
1327
1310
|
*
|
|
@@ -1330,7 +1313,7 @@ interface paths {
|
|
|
1330
1313
|
*
|
|
1331
1314
|
* e.g f81d4fae-7dec-41d0-a765-00a0c91e6bf6 */
|
|
1332
1315
|
user_id?: string;
|
|
1333
|
-
/** @description A timestamp describing the time the event occurred. This should conform to ISO 8601 standards and be in UTC. Example:
|
|
1316
|
+
/** @description A timestamp describing the time the event occurred. This should conform to ISO 8601 standards and be in UTC. Example: "2024-07-17T10:11:16.591Z" */
|
|
1334
1317
|
event_at?: string;
|
|
1335
1318
|
/** @description The page url at the time the event is fired */
|
|
1336
1319
|
url?: string;
|
|
@@ -1338,7 +1321,7 @@ interface paths {
|
|
|
1338
1321
|
browser?: string;
|
|
1339
1322
|
/** @description The customer that the event occurred on */
|
|
1340
1323
|
customer_id?: string;
|
|
1341
|
-
/** @description The user agent string e.g.
|
|
1324
|
+
/** @description The user agent string e.g. "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.124 Safari/537.36" */
|
|
1342
1325
|
user_agent?: string;
|
|
1343
1326
|
/** @description A 36 character alphanumeric hash that uniquely identifies a tracking event
|
|
1344
1327
|
*
|
|
@@ -1358,6 +1341,15 @@ interface paths {
|
|
|
1358
1341
|
pageview_id?: string;
|
|
1359
1342
|
/** @description A unique user id native to our customers web analytics platforms (adobe, google analytics etc). Helps us & our customers align our data with what customers see in their platforms. */
|
|
1360
1343
|
web_analytics_platform_user_id?: string | null;
|
|
1344
|
+
/** @description A 36 character alphanumeric hash that uniquely identifies a session.
|
|
1345
|
+
*
|
|
1346
|
+
*
|
|
1347
|
+
* This should match the UUID V4 as specified in RFC 9652:
|
|
1348
|
+
* https://datatracker.ietf.org/doc/html/rfc9562#name-uuid-version-4
|
|
1349
|
+
*
|
|
1350
|
+
* e.g f81d4fae-7dec-41d0-a765-00a0c91e6bf6
|
|
1351
|
+
* */
|
|
1352
|
+
browser_session_id?: string | null;
|
|
1361
1353
|
/** @description The device screen width in pixels - window.screen.width in JS. This is a user level property that should never change. */
|
|
1362
1354
|
screen_width?: number;
|
|
1363
1355
|
/** @description The device screen height in pixels - window.screen.height in JS. This is a user level property that should never change. */
|
|
@@ -1369,18 +1361,15 @@ interface paths {
|
|
|
1369
1361
|
* screen_width <= 480px = 'mobile'
|
|
1370
1362
|
* screen_width > 480px = 'large' */
|
|
1371
1363
|
screen_size?: string;
|
|
1372
|
-
/** @description
|
|
1373
|
-
|
|
1374
|
-
|
|
1375
|
-
*
|
|
1364
|
+
/** @description The type of entry point the event refers to, e.g. engagement_button (previously named tab), engagement popup (previously named engagement bubble) etc */
|
|
1365
|
+
entry_point_type?: string;
|
|
1366
|
+
/** @description A 36 character alphanumeric hash that uniquely identifies a conversation.
|
|
1376
1367
|
*
|
|
1377
1368
|
* This should match the UUID V4 as specified in RFC 9652:
|
|
1378
1369
|
* https://datatracker.ietf.org/doc/html/rfc9562#name-uuid-version-4
|
|
1379
1370
|
*
|
|
1380
1371
|
* e.g f81d4fae-7dec-41d0-a765-00a0c91e6bf6 */
|
|
1381
|
-
|
|
1382
|
-
/** @description The type of entry point the event refers to, e.g. engagement_button (previously named tab), engagement popup (previously named engagement bubble) etc */
|
|
1383
|
-
entry_point_type?: string;
|
|
1372
|
+
conversation_id?: string;
|
|
1384
1373
|
/** @description The name of the system/service that the event originates from */
|
|
1385
1374
|
service?: string;
|
|
1386
1375
|
/** @description A JSON object containing the different versions of services directly used by the service that tracks an event. The version of the service that is firing any tracking event should ALWAYS be included, for example if the conversation_api is firing an event, service_versions should include conversation_api_version. It should also ideally include the version numbers of any other services used in the generation of the event that is being tracked. */
|
|
@@ -1389,20 +1378,20 @@ interface paths {
|
|
|
1389
1378
|
environment?: string;
|
|
1390
1379
|
/** @description The associated text based on the answer provided by the user at the end of the conversation when they are asked to provide feedback by clicking on one of the emojis */
|
|
1391
1380
|
feedback_score_text?: string;
|
|
1392
|
-
/** @description A 36 character alphanumeric hash that uniquely identifies a conversation.
|
|
1393
|
-
*
|
|
1394
|
-
* This should match the UUID V4 as specified in RFC 9652:
|
|
1395
|
-
* https://datatracker.ietf.org/doc/html/rfc9562#name-uuid-version-4
|
|
1396
|
-
*
|
|
1397
|
-
* e.g f81d4fae-7dec-41d0-a765-00a0c91e6bf6 */
|
|
1398
|
-
conversation_id?: string;
|
|
1399
1381
|
/** @description An integer representing the rank of the corresponding feedback score. It should always start at 0, even if the number of options changes. */
|
|
1400
1382
|
feedback_score_num?: number;
|
|
1401
1383
|
/** @description A hashed IP address for the user. Hashing Algorithm and Salt are in 1Password. */
|
|
1402
1384
|
ip_address_hashed?: string;
|
|
1403
1385
|
/** @description Describes the reason the tool ui was closed. When the value is 'customer_triggered' it's because it's been programmatically closed by the customer (by running window.axiom.integrations.hide() or window.axiom.integrations.minimise()). When it's 'user_close_click' it's because the actual end user has closed it manually by clicking. */
|
|
1404
1386
|
tool_ui_closed_reason?: string;
|
|
1405
|
-
/** @description
|
|
1387
|
+
/** @description The turn number in the conversation. This links each user message to a corresponding assistant response. If there is an opening message from the assistant, this would have a message_turn of 1. Then the first message a user sends would have a message_turn of 2. The first actual response the assistant sends would have a message_turn of 2.
|
|
1388
|
+
*
|
|
1389
|
+
* All message_turn values except for 1 (the opening message if it exists) should be expected to come in pairs.
|
|
1390
|
+
*
|
|
1391
|
+
* Here's an example sequence of message_turn values where the user is provided with an opening message at the beginning of a conversation, and then sends 5 separate messages themselves with 5 corresponding assistant responses:
|
|
1392
|
+
*
|
|
1393
|
+
* 1,2,2,3,3,4,4,5,5,6,6
|
|
1394
|
+
* */
|
|
1406
1395
|
conversation_turn_num?: number;
|
|
1407
1396
|
/** @description An alphanumeric hash that uniquely identifies a turn in a conversation
|
|
1408
1397
|
*
|
|
@@ -1431,7 +1420,7 @@ interface paths {
|
|
|
1431
1420
|
conversation_stage?: string | null;
|
|
1432
1421
|
/** @description A list of ids that each relate to a single recommendation that was shown in a set of recs */
|
|
1433
1422
|
recommendation_ids_recommended?: unknown[];
|
|
1434
|
-
/** @description Contains the fallback text provided by the conversation api to a frontend that non 'text' (single_select/multi_select etc) messages could revert to if they needed to. Described in the conversation api docs as:
|
|
1423
|
+
/** @description Contains the fallback text provided by the conversation api to a frontend that non 'text' (single_select/multi_select etc) messages could revert to if they needed to. Described in the conversation api docs as: "What should a client render if they do not have a native renderer for this message type?". */
|
|
1435
1424
|
fallback_text?: string;
|
|
1436
1425
|
/** @description Specifies if a free text response can be provided to an assistant single/multi-select message */
|
|
1437
1426
|
is_allow_free_text_message?: boolean;
|
|
@@ -1491,9 +1480,11 @@ interface paths {
|
|
|
1491
1480
|
slots?: unknown[];
|
|
1492
1481
|
/** @description Describes the reason the entry point was closed. When the value is 'customer_triggered' it's because it's been programmatically closed by the customer (by running window.axiom.integrations.hide()). When it's 'user_close_click' it's because the actual end user has closed it manually by clicking. */
|
|
1493
1482
|
entry_point_closed_reason?: string;
|
|
1494
|
-
/** @description A categorical property to denote which party was responsible for suppression. This is useful for accurately calculating control conversion rates, it allows us to count how many users were suppressed before humara loading, and how many were put in a control group.
|
|
1483
|
+
/** @description A categorical property to denote which party was responsible for suppression. This is useful for accurately calculating control conversion rates, it allows us to count how many users were suppressed before humara loading, and how many were put in a control group.
|
|
1484
|
+
* */
|
|
1495
1485
|
suppressed_by?: unknown[];
|
|
1496
|
-
/** @description
|
|
1486
|
+
/** @description A categorical property that describes the reason for the suppression. When the value is 'customer_triggered' it's because it's been programmatically closed by the customer (by running window.axiom.integrations.hide())
|
|
1487
|
+
* */
|
|
1497
1488
|
suppressed_reason?: unknown[];
|
|
1498
1489
|
/** @description A list of objects for recommendations sent in a conversation api message. */
|
|
1499
1490
|
recommendation_set?: unknown[];
|
|
@@ -1509,7 +1500,19 @@ interface paths {
|
|
|
1509
1500
|
* https://datatracker.ietf.org/doc/html/rfc9562#name-uuid-version-4
|
|
1510
1501
|
*
|
|
1511
1502
|
* e.g f81d4fae-7dec-41d0-a765-00a0c91e6bf6 */
|
|
1512
|
-
recommendation_id?: string;
|
|
1503
|
+
recommendation_id?: string | null;
|
|
1504
|
+
/** @description The number of tokens contained in the sequence of text sent in a request to an external service (from the user message) */
|
|
1505
|
+
external_request_input_token_count?: number;
|
|
1506
|
+
/** @description The number of tokens contained in the sequence of text received from sending a request to an external service. Should be null for embedding requests. */
|
|
1507
|
+
external_request_output_token_count?: number | null;
|
|
1508
|
+
/** @description The type of external request e.g. llm/embedding */
|
|
1509
|
+
external_request_type?: string;
|
|
1510
|
+
/** @description Describes the subcategory of the request for the purpose of bucketing the higher level request_category into different categories */
|
|
1511
|
+
external_request_subtype?: string;
|
|
1512
|
+
/** @description The provider an external request is sent to */
|
|
1513
|
+
external_request_provider?: string;
|
|
1514
|
+
/** @description The model ID is used to determine which exact model we use in an external request e.g. 'gpt-4o-mini' */
|
|
1515
|
+
external_request_model_id?: string;
|
|
1513
1516
|
};
|
|
1514
1517
|
/**
|
|
1515
1518
|
* @description A 36 character hash, 5 segments, separated by dashes that uniquely identifies a conversation
|
|
@@ -1520,7 +1523,7 @@ interface paths {
|
|
|
1520
1523
|
* @description Event Name
|
|
1521
1524
|
* @enum {string}
|
|
1522
1525
|
*/
|
|
1523
|
-
eventName: "entry_point-shown" | "feedback_submit-clicked" | "page-shown" | "tool_ui-closed" | "user_message-submitted" | "user_message-submitted message" | "user_message-submitted single_select" | "user_message-submitted multi_select" | "assistant_message-submitted" | "assistant_message-submitted recommendation" | "assistant_message-submitted message" | "assistant_message-submitted single_select" | "assistant_message-submitted multi_select" | "assistant_message-submitted exit_to_chat" | "assistant_message-submitted exit_to_purchase" | "assistant_message-submitted exit_to_human" | "feedback-shown" | "feedback_skip-clicked" | "sale-completed" | "sale-completed spectrum" | "sale-completed aidem" | "sale-completed spectrum-us-media-consumer-en" | "entry_point-clicked" | "tool_close-clicked" | "exit_to_chat-completed" | "exit_to_purchase-completed" | "conversation-started" | "user_qualification-identified" | "experiment_variation-assigned" | "slot_filling-completed" | "entry_point-closed" | "entry_point-suppressed" | "user-created" | "exit_to_human-completed" | "recommendation_set-returned" | "ww_rag_context-used" | "rec_card_feedback-clicked";
|
|
1526
|
+
eventName: "entry_point-shown" | "feedback_submit-clicked" | "page-shown" | "tool_ui-closed" | "user_message-submitted" | "user_message-submitted message" | "user_message-submitted single_select" | "user_message-submitted multi_select" | "assistant_message-submitted" | "assistant_message-submitted recommendation" | "assistant_message-submitted message" | "assistant_message-submitted single_select" | "assistant_message-submitted multi_select" | "assistant_message-submitted exit_to_chat" | "assistant_message-submitted exit_to_purchase" | "assistant_message-submitted exit_to_human" | "feedback-shown" | "feedback_skip-clicked" | "sale-completed" | "sale-completed spectrum" | "sale-completed aidem" | "sale-completed spectrum-us-media-consumer-en" | "entry_point-clicked" | "tool_close-clicked" | "exit_to_chat-completed" | "exit_to_purchase-completed" | "conversation-started" | "user_qualification-identified" | "experiment_variation-assigned" | "slot_filling-completed" | "entry_point-closed" | "entry_point-suppressed" | "user-created" | "exit_to_human-completed" | "recommendation_set-returned" | "ww_rag_context-used" | "ww_user_context-received" | "rec_card_feedback-clicked" | "external_request-submitted" | "external_request-submitted llm" | "external_request-submitted embedding" | "external_request-submitted embedding_service_level" | "ww_prompt_context-used" | "message_select_option-clicked";
|
|
1524
1527
|
/**
|
|
1525
1528
|
* @description A 36 character hash, 5 segments, separated by dashes that uniquely identifies a page view (page-shown event)
|
|
1526
1529
|
* @example 1a1a1a1a-1a1a-1a1a-1a1a-1a1a1a1a1a1a
|
|
@@ -1803,7 +1806,6 @@ declare class Client {
|
|
|
1803
1806
|
content: {
|
|
1804
1807
|
"application/json": {
|
|
1805
1808
|
additionalProperties?: {
|
|
1806
|
-
session_id?: string | null;
|
|
1807
1809
|
user_id?: string;
|
|
1808
1810
|
event_at?: string;
|
|
1809
1811
|
url?: string;
|
|
@@ -1814,16 +1816,16 @@ declare class Client {
|
|
|
1814
1816
|
event_name?: string;
|
|
1815
1817
|
pageview_id?: string;
|
|
1816
1818
|
web_analytics_platform_user_id?: string | null;
|
|
1819
|
+
browser_session_id?: string | null;
|
|
1817
1820
|
screen_width?: number;
|
|
1818
1821
|
screen_height?: number;
|
|
1819
1822
|
screen_size?: string;
|
|
1820
|
-
browser_session_id?: string | null;
|
|
1821
1823
|
entry_point_type?: string;
|
|
1824
|
+
conversation_id?: string;
|
|
1822
1825
|
service?: string;
|
|
1823
1826
|
service_versions?: Record<string, never>;
|
|
1824
1827
|
environment?: string;
|
|
1825
1828
|
feedback_score_text?: string;
|
|
1826
|
-
conversation_id?: string;
|
|
1827
1829
|
feedback_score_num?: number;
|
|
1828
1830
|
ip_address_hashed?: string;
|
|
1829
1831
|
tool_ui_closed_reason?: string;
|
|
@@ -1867,10 +1869,16 @@ declare class Client {
|
|
|
1867
1869
|
recommendation_set?: unknown[];
|
|
1868
1870
|
discovery_progress_score?: number;
|
|
1869
1871
|
rec_card_feedback_sentiment?: string;
|
|
1870
|
-
recommendation_id?: string;
|
|
1872
|
+
recommendation_id?: string | null;
|
|
1873
|
+
external_request_input_token_count?: number;
|
|
1874
|
+
external_request_output_token_count?: number | null;
|
|
1875
|
+
external_request_type?: string;
|
|
1876
|
+
external_request_subtype?: string;
|
|
1877
|
+
external_request_provider?: string;
|
|
1878
|
+
external_request_model_id?: string;
|
|
1871
1879
|
};
|
|
1872
1880
|
conversationId?: string;
|
|
1873
|
-
eventName: "entry_point-shown" | "feedback_submit-clicked" | "page-shown" | "tool_ui-closed" | "user_message-submitted" | "user_message-submitted message" | "user_message-submitted single_select" | "user_message-submitted multi_select" | "assistant_message-submitted" | "assistant_message-submitted recommendation" | "assistant_message-submitted message" | "assistant_message-submitted single_select" | "assistant_message-submitted multi_select" | "assistant_message-submitted exit_to_chat" | "assistant_message-submitted exit_to_purchase" | "assistant_message-submitted exit_to_human" | "feedback-shown" | "feedback_skip-clicked" | "sale-completed" | "sale-completed spectrum" | "sale-completed aidem" | "sale-completed spectrum-us-media-consumer-en" | "entry_point-clicked" | "tool_close-clicked" | "exit_to_chat-completed" | "exit_to_purchase-completed" | "conversation-started" | "user_qualification-identified" | "experiment_variation-assigned" | "slot_filling-completed" | "entry_point-closed" | "entry_point-suppressed" | "user-created" | "exit_to_human-completed" | "recommendation_set-returned" | "ww_rag_context-used" | "rec_card_feedback-clicked";
|
|
1881
|
+
eventName: "entry_point-shown" | "feedback_submit-clicked" | "page-shown" | "tool_ui-closed" | "user_message-submitted" | "user_message-submitted message" | "user_message-submitted single_select" | "user_message-submitted multi_select" | "assistant_message-submitted" | "assistant_message-submitted recommendation" | "assistant_message-submitted message" | "assistant_message-submitted single_select" | "assistant_message-submitted multi_select" | "assistant_message-submitted exit_to_chat" | "assistant_message-submitted exit_to_purchase" | "assistant_message-submitted exit_to_human" | "feedback-shown" | "feedback_skip-clicked" | "sale-completed" | "sale-completed spectrum" | "sale-completed aidem" | "sale-completed spectrum-us-media-consumer-en" | "entry_point-clicked" | "tool_close-clicked" | "exit_to_chat-completed" | "exit_to_purchase-completed" | "conversation-started" | "user_qualification-identified" | "experiment_variation-assigned" | "slot_filling-completed" | "entry_point-closed" | "entry_point-suppressed" | "user-created" | "exit_to_human-completed" | "recommendation_set-returned" | "ww_rag_context-used" | "ww_user_context-received" | "rec_card_feedback-clicked" | "external_request-submitted" | "external_request-submitted llm" | "external_request-submitted embedding" | "external_request-submitted embedding_service_level" | "ww_prompt_context-used" | "message_select_option-clicked";
|
|
1874
1882
|
pageviewId: string;
|
|
1875
1883
|
screenHeight?: number;
|
|
1876
1884
|
screenSize?: "mobile" | "large";
|
package/dist/index.d.ts
CHANGED
|
@@ -891,14 +891,6 @@ interface paths {
|
|
|
891
891
|
requestBody?: {
|
|
892
892
|
content: {
|
|
893
893
|
"application/json": {
|
|
894
|
-
/** @description A 36 character alphanumeric hash that uniquely identifies a session.
|
|
895
|
-
*
|
|
896
|
-
*
|
|
897
|
-
* This should match the UUID V4 as specified in RFC 9652:
|
|
898
|
-
* https://datatracker.ietf.org/doc/html/rfc9562#name-uuid-version-4
|
|
899
|
-
*
|
|
900
|
-
* e.g f81d4fae-7dec-41d0-a765-00a0c91e6bf6 */
|
|
901
|
-
sessionId?: string | null;
|
|
902
894
|
/** @description A 36 character alphanumeric hash that uniquely identifies a user.
|
|
903
895
|
*
|
|
904
896
|
*
|
|
@@ -907,7 +899,7 @@ interface paths {
|
|
|
907
899
|
*
|
|
908
900
|
* e.g f81d4fae-7dec-41d0-a765-00a0c91e6bf6 */
|
|
909
901
|
userId?: string;
|
|
910
|
-
/** @description A timestamp describing the time the event occurred. This should conform to ISO 8601 standards and be in UTC. Example:
|
|
902
|
+
/** @description A timestamp describing the time the event occurred. This should conform to ISO 8601 standards and be in UTC. Example: "2024-07-17T10:11:16.591Z" */
|
|
911
903
|
eventAt?: string;
|
|
912
904
|
/** @description The page url at the time the event is fired */
|
|
913
905
|
url?: string;
|
|
@@ -915,7 +907,7 @@ interface paths {
|
|
|
915
907
|
browser?: string;
|
|
916
908
|
/** @description The customer that the event occurred on */
|
|
917
909
|
customerId: string;
|
|
918
|
-
/** @description The user agent string e.g.
|
|
910
|
+
/** @description The user agent string e.g. "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.124 Safari/537.36" */
|
|
919
911
|
userAgent?: string;
|
|
920
912
|
/** @description A 36 character alphanumeric hash that uniquely identifies a tracking event
|
|
921
913
|
*
|
|
@@ -938,6 +930,15 @@ interface paths {
|
|
|
938
930
|
pageviewId?: string | null;
|
|
939
931
|
/** @description A unique user id native to our customers web analytics platforms (adobe, google analytics etc). Helps us & our customers align our data with what customers see in their platforms. */
|
|
940
932
|
webAnalyticsPlatformUserId?: string | null;
|
|
933
|
+
/** @description A 36 character alphanumeric hash that uniquely identifies a session.
|
|
934
|
+
*
|
|
935
|
+
*
|
|
936
|
+
* This should match the UUID V4 as specified in RFC 9652:
|
|
937
|
+
* https://datatracker.ietf.org/doc/html/rfc9562#name-uuid-version-4
|
|
938
|
+
*
|
|
939
|
+
* e.g f81d4fae-7dec-41d0-a765-00a0c91e6bf6
|
|
940
|
+
* */
|
|
941
|
+
browserSessionId?: string | null;
|
|
941
942
|
/** @description The device screen width in pixels - window.screen.width in JS. This is a user level property that should never change. */
|
|
942
943
|
screenWidth?: number;
|
|
943
944
|
/** @description The device screen height in pixels - window.screen.height in JS. This is a user level property that should never change. */
|
|
@@ -982,16 +983,6 @@ interface paths {
|
|
|
982
983
|
* @enum {string}
|
|
983
984
|
*/
|
|
984
985
|
language?: "de" | "en" | "es" | "fr" | "it";
|
|
985
|
-
/** @description This property is intended to replace session_id, but is being used in the meantime so that developers can switch over to using browser_session_id without different services needing to all update in sync.
|
|
986
|
-
*
|
|
987
|
-
* A 36 character alphanumeric hash that uniquely identifies a session.
|
|
988
|
-
*
|
|
989
|
-
*
|
|
990
|
-
* This should match the UUID V4 as specified in RFC 9652:
|
|
991
|
-
* https://datatracker.ietf.org/doc/html/rfc9562#name-uuid-version-4
|
|
992
|
-
*
|
|
993
|
-
* e.g f81d4fae-7dec-41d0-a765-00a0c91e6bf6 */
|
|
994
|
-
browserSessionId?: string | null;
|
|
995
986
|
/**
|
|
996
987
|
* @description The name of the system/service that the event originates from
|
|
997
988
|
* @enum {string}
|
|
@@ -1314,14 +1305,6 @@ interface paths {
|
|
|
1314
1305
|
* } */
|
|
1315
1306
|
"application/json": {
|
|
1316
1307
|
additionalProperties?: {
|
|
1317
|
-
/** @description A 36 character alphanumeric hash that uniquely identifies a session.
|
|
1318
|
-
*
|
|
1319
|
-
*
|
|
1320
|
-
* This should match the UUID V4 as specified in RFC 9652:
|
|
1321
|
-
* https://datatracker.ietf.org/doc/html/rfc9562#name-uuid-version-4
|
|
1322
|
-
*
|
|
1323
|
-
* e.g f81d4fae-7dec-41d0-a765-00a0c91e6bf6 */
|
|
1324
|
-
session_id?: string | null;
|
|
1325
1308
|
/** @description A 36 character alphanumeric hash that uniquely identifies a user.
|
|
1326
1309
|
*
|
|
1327
1310
|
*
|
|
@@ -1330,7 +1313,7 @@ interface paths {
|
|
|
1330
1313
|
*
|
|
1331
1314
|
* e.g f81d4fae-7dec-41d0-a765-00a0c91e6bf6 */
|
|
1332
1315
|
user_id?: string;
|
|
1333
|
-
/** @description A timestamp describing the time the event occurred. This should conform to ISO 8601 standards and be in UTC. Example:
|
|
1316
|
+
/** @description A timestamp describing the time the event occurred. This should conform to ISO 8601 standards and be in UTC. Example: "2024-07-17T10:11:16.591Z" */
|
|
1334
1317
|
event_at?: string;
|
|
1335
1318
|
/** @description The page url at the time the event is fired */
|
|
1336
1319
|
url?: string;
|
|
@@ -1338,7 +1321,7 @@ interface paths {
|
|
|
1338
1321
|
browser?: string;
|
|
1339
1322
|
/** @description The customer that the event occurred on */
|
|
1340
1323
|
customer_id?: string;
|
|
1341
|
-
/** @description The user agent string e.g.
|
|
1324
|
+
/** @description The user agent string e.g. "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.124 Safari/537.36" */
|
|
1342
1325
|
user_agent?: string;
|
|
1343
1326
|
/** @description A 36 character alphanumeric hash that uniquely identifies a tracking event
|
|
1344
1327
|
*
|
|
@@ -1358,6 +1341,15 @@ interface paths {
|
|
|
1358
1341
|
pageview_id?: string;
|
|
1359
1342
|
/** @description A unique user id native to our customers web analytics platforms (adobe, google analytics etc). Helps us & our customers align our data with what customers see in their platforms. */
|
|
1360
1343
|
web_analytics_platform_user_id?: string | null;
|
|
1344
|
+
/** @description A 36 character alphanumeric hash that uniquely identifies a session.
|
|
1345
|
+
*
|
|
1346
|
+
*
|
|
1347
|
+
* This should match the UUID V4 as specified in RFC 9652:
|
|
1348
|
+
* https://datatracker.ietf.org/doc/html/rfc9562#name-uuid-version-4
|
|
1349
|
+
*
|
|
1350
|
+
* e.g f81d4fae-7dec-41d0-a765-00a0c91e6bf6
|
|
1351
|
+
* */
|
|
1352
|
+
browser_session_id?: string | null;
|
|
1361
1353
|
/** @description The device screen width in pixels - window.screen.width in JS. This is a user level property that should never change. */
|
|
1362
1354
|
screen_width?: number;
|
|
1363
1355
|
/** @description The device screen height in pixels - window.screen.height in JS. This is a user level property that should never change. */
|
|
@@ -1369,18 +1361,15 @@ interface paths {
|
|
|
1369
1361
|
* screen_width <= 480px = 'mobile'
|
|
1370
1362
|
* screen_width > 480px = 'large' */
|
|
1371
1363
|
screen_size?: string;
|
|
1372
|
-
/** @description
|
|
1373
|
-
|
|
1374
|
-
|
|
1375
|
-
*
|
|
1364
|
+
/** @description The type of entry point the event refers to, e.g. engagement_button (previously named tab), engagement popup (previously named engagement bubble) etc */
|
|
1365
|
+
entry_point_type?: string;
|
|
1366
|
+
/** @description A 36 character alphanumeric hash that uniquely identifies a conversation.
|
|
1376
1367
|
*
|
|
1377
1368
|
* This should match the UUID V4 as specified in RFC 9652:
|
|
1378
1369
|
* https://datatracker.ietf.org/doc/html/rfc9562#name-uuid-version-4
|
|
1379
1370
|
*
|
|
1380
1371
|
* e.g f81d4fae-7dec-41d0-a765-00a0c91e6bf6 */
|
|
1381
|
-
|
|
1382
|
-
/** @description The type of entry point the event refers to, e.g. engagement_button (previously named tab), engagement popup (previously named engagement bubble) etc */
|
|
1383
|
-
entry_point_type?: string;
|
|
1372
|
+
conversation_id?: string;
|
|
1384
1373
|
/** @description The name of the system/service that the event originates from */
|
|
1385
1374
|
service?: string;
|
|
1386
1375
|
/** @description A JSON object containing the different versions of services directly used by the service that tracks an event. The version of the service that is firing any tracking event should ALWAYS be included, for example if the conversation_api is firing an event, service_versions should include conversation_api_version. It should also ideally include the version numbers of any other services used in the generation of the event that is being tracked. */
|
|
@@ -1389,20 +1378,20 @@ interface paths {
|
|
|
1389
1378
|
environment?: string;
|
|
1390
1379
|
/** @description The associated text based on the answer provided by the user at the end of the conversation when they are asked to provide feedback by clicking on one of the emojis */
|
|
1391
1380
|
feedback_score_text?: string;
|
|
1392
|
-
/** @description A 36 character alphanumeric hash that uniquely identifies a conversation.
|
|
1393
|
-
*
|
|
1394
|
-
* This should match the UUID V4 as specified in RFC 9652:
|
|
1395
|
-
* https://datatracker.ietf.org/doc/html/rfc9562#name-uuid-version-4
|
|
1396
|
-
*
|
|
1397
|
-
* e.g f81d4fae-7dec-41d0-a765-00a0c91e6bf6 */
|
|
1398
|
-
conversation_id?: string;
|
|
1399
1381
|
/** @description An integer representing the rank of the corresponding feedback score. It should always start at 0, even if the number of options changes. */
|
|
1400
1382
|
feedback_score_num?: number;
|
|
1401
1383
|
/** @description A hashed IP address for the user. Hashing Algorithm and Salt are in 1Password. */
|
|
1402
1384
|
ip_address_hashed?: string;
|
|
1403
1385
|
/** @description Describes the reason the tool ui was closed. When the value is 'customer_triggered' it's because it's been programmatically closed by the customer (by running window.axiom.integrations.hide() or window.axiom.integrations.minimise()). When it's 'user_close_click' it's because the actual end user has closed it manually by clicking. */
|
|
1404
1386
|
tool_ui_closed_reason?: string;
|
|
1405
|
-
/** @description
|
|
1387
|
+
/** @description The turn number in the conversation. This links each user message to a corresponding assistant response. If there is an opening message from the assistant, this would have a message_turn of 1. Then the first message a user sends would have a message_turn of 2. The first actual response the assistant sends would have a message_turn of 2.
|
|
1388
|
+
*
|
|
1389
|
+
* All message_turn values except for 1 (the opening message if it exists) should be expected to come in pairs.
|
|
1390
|
+
*
|
|
1391
|
+
* Here's an example sequence of message_turn values where the user is provided with an opening message at the beginning of a conversation, and then sends 5 separate messages themselves with 5 corresponding assistant responses:
|
|
1392
|
+
*
|
|
1393
|
+
* 1,2,2,3,3,4,4,5,5,6,6
|
|
1394
|
+
* */
|
|
1406
1395
|
conversation_turn_num?: number;
|
|
1407
1396
|
/** @description An alphanumeric hash that uniquely identifies a turn in a conversation
|
|
1408
1397
|
*
|
|
@@ -1431,7 +1420,7 @@ interface paths {
|
|
|
1431
1420
|
conversation_stage?: string | null;
|
|
1432
1421
|
/** @description A list of ids that each relate to a single recommendation that was shown in a set of recs */
|
|
1433
1422
|
recommendation_ids_recommended?: unknown[];
|
|
1434
|
-
/** @description Contains the fallback text provided by the conversation api to a frontend that non 'text' (single_select/multi_select etc) messages could revert to if they needed to. Described in the conversation api docs as:
|
|
1423
|
+
/** @description Contains the fallback text provided by the conversation api to a frontend that non 'text' (single_select/multi_select etc) messages could revert to if they needed to. Described in the conversation api docs as: "What should a client render if they do not have a native renderer for this message type?". */
|
|
1435
1424
|
fallback_text?: string;
|
|
1436
1425
|
/** @description Specifies if a free text response can be provided to an assistant single/multi-select message */
|
|
1437
1426
|
is_allow_free_text_message?: boolean;
|
|
@@ -1491,9 +1480,11 @@ interface paths {
|
|
|
1491
1480
|
slots?: unknown[];
|
|
1492
1481
|
/** @description Describes the reason the entry point was closed. When the value is 'customer_triggered' it's because it's been programmatically closed by the customer (by running window.axiom.integrations.hide()). When it's 'user_close_click' it's because the actual end user has closed it manually by clicking. */
|
|
1493
1482
|
entry_point_closed_reason?: string;
|
|
1494
|
-
/** @description A categorical property to denote which party was responsible for suppression. This is useful for accurately calculating control conversion rates, it allows us to count how many users were suppressed before humara loading, and how many were put in a control group.
|
|
1483
|
+
/** @description A categorical property to denote which party was responsible for suppression. This is useful for accurately calculating control conversion rates, it allows us to count how many users were suppressed before humara loading, and how many were put in a control group.
|
|
1484
|
+
* */
|
|
1495
1485
|
suppressed_by?: unknown[];
|
|
1496
|
-
/** @description
|
|
1486
|
+
/** @description A categorical property that describes the reason for the suppression. When the value is 'customer_triggered' it's because it's been programmatically closed by the customer (by running window.axiom.integrations.hide())
|
|
1487
|
+
* */
|
|
1497
1488
|
suppressed_reason?: unknown[];
|
|
1498
1489
|
/** @description A list of objects for recommendations sent in a conversation api message. */
|
|
1499
1490
|
recommendation_set?: unknown[];
|
|
@@ -1509,7 +1500,19 @@ interface paths {
|
|
|
1509
1500
|
* https://datatracker.ietf.org/doc/html/rfc9562#name-uuid-version-4
|
|
1510
1501
|
*
|
|
1511
1502
|
* e.g f81d4fae-7dec-41d0-a765-00a0c91e6bf6 */
|
|
1512
|
-
recommendation_id?: string;
|
|
1503
|
+
recommendation_id?: string | null;
|
|
1504
|
+
/** @description The number of tokens contained in the sequence of text sent in a request to an external service (from the user message) */
|
|
1505
|
+
external_request_input_token_count?: number;
|
|
1506
|
+
/** @description The number of tokens contained in the sequence of text received from sending a request to an external service. Should be null for embedding requests. */
|
|
1507
|
+
external_request_output_token_count?: number | null;
|
|
1508
|
+
/** @description The type of external request e.g. llm/embedding */
|
|
1509
|
+
external_request_type?: string;
|
|
1510
|
+
/** @description Describes the subcategory of the request for the purpose of bucketing the higher level request_category into different categories */
|
|
1511
|
+
external_request_subtype?: string;
|
|
1512
|
+
/** @description The provider an external request is sent to */
|
|
1513
|
+
external_request_provider?: string;
|
|
1514
|
+
/** @description The model ID is used to determine which exact model we use in an external request e.g. 'gpt-4o-mini' */
|
|
1515
|
+
external_request_model_id?: string;
|
|
1513
1516
|
};
|
|
1514
1517
|
/**
|
|
1515
1518
|
* @description A 36 character hash, 5 segments, separated by dashes that uniquely identifies a conversation
|
|
@@ -1520,7 +1523,7 @@ interface paths {
|
|
|
1520
1523
|
* @description Event Name
|
|
1521
1524
|
* @enum {string}
|
|
1522
1525
|
*/
|
|
1523
|
-
eventName: "entry_point-shown" | "feedback_submit-clicked" | "page-shown" | "tool_ui-closed" | "user_message-submitted" | "user_message-submitted message" | "user_message-submitted single_select" | "user_message-submitted multi_select" | "assistant_message-submitted" | "assistant_message-submitted recommendation" | "assistant_message-submitted message" | "assistant_message-submitted single_select" | "assistant_message-submitted multi_select" | "assistant_message-submitted exit_to_chat" | "assistant_message-submitted exit_to_purchase" | "assistant_message-submitted exit_to_human" | "feedback-shown" | "feedback_skip-clicked" | "sale-completed" | "sale-completed spectrum" | "sale-completed aidem" | "sale-completed spectrum-us-media-consumer-en" | "entry_point-clicked" | "tool_close-clicked" | "exit_to_chat-completed" | "exit_to_purchase-completed" | "conversation-started" | "user_qualification-identified" | "experiment_variation-assigned" | "slot_filling-completed" | "entry_point-closed" | "entry_point-suppressed" | "user-created" | "exit_to_human-completed" | "recommendation_set-returned" | "ww_rag_context-used" | "rec_card_feedback-clicked";
|
|
1526
|
+
eventName: "entry_point-shown" | "feedback_submit-clicked" | "page-shown" | "tool_ui-closed" | "user_message-submitted" | "user_message-submitted message" | "user_message-submitted single_select" | "user_message-submitted multi_select" | "assistant_message-submitted" | "assistant_message-submitted recommendation" | "assistant_message-submitted message" | "assistant_message-submitted single_select" | "assistant_message-submitted multi_select" | "assistant_message-submitted exit_to_chat" | "assistant_message-submitted exit_to_purchase" | "assistant_message-submitted exit_to_human" | "feedback-shown" | "feedback_skip-clicked" | "sale-completed" | "sale-completed spectrum" | "sale-completed aidem" | "sale-completed spectrum-us-media-consumer-en" | "entry_point-clicked" | "tool_close-clicked" | "exit_to_chat-completed" | "exit_to_purchase-completed" | "conversation-started" | "user_qualification-identified" | "experiment_variation-assigned" | "slot_filling-completed" | "entry_point-closed" | "entry_point-suppressed" | "user-created" | "exit_to_human-completed" | "recommendation_set-returned" | "ww_rag_context-used" | "ww_user_context-received" | "rec_card_feedback-clicked" | "external_request-submitted" | "external_request-submitted llm" | "external_request-submitted embedding" | "external_request-submitted embedding_service_level" | "ww_prompt_context-used" | "message_select_option-clicked";
|
|
1524
1527
|
/**
|
|
1525
1528
|
* @description A 36 character hash, 5 segments, separated by dashes that uniquely identifies a page view (page-shown event)
|
|
1526
1529
|
* @example 1a1a1a1a-1a1a-1a1a-1a1a-1a1a1a1a1a1a
|
|
@@ -1803,7 +1806,6 @@ declare class Client {
|
|
|
1803
1806
|
content: {
|
|
1804
1807
|
"application/json": {
|
|
1805
1808
|
additionalProperties?: {
|
|
1806
|
-
session_id?: string | null;
|
|
1807
1809
|
user_id?: string;
|
|
1808
1810
|
event_at?: string;
|
|
1809
1811
|
url?: string;
|
|
@@ -1814,16 +1816,16 @@ declare class Client {
|
|
|
1814
1816
|
event_name?: string;
|
|
1815
1817
|
pageview_id?: string;
|
|
1816
1818
|
web_analytics_platform_user_id?: string | null;
|
|
1819
|
+
browser_session_id?: string | null;
|
|
1817
1820
|
screen_width?: number;
|
|
1818
1821
|
screen_height?: number;
|
|
1819
1822
|
screen_size?: string;
|
|
1820
|
-
browser_session_id?: string | null;
|
|
1821
1823
|
entry_point_type?: string;
|
|
1824
|
+
conversation_id?: string;
|
|
1822
1825
|
service?: string;
|
|
1823
1826
|
service_versions?: Record<string, never>;
|
|
1824
1827
|
environment?: string;
|
|
1825
1828
|
feedback_score_text?: string;
|
|
1826
|
-
conversation_id?: string;
|
|
1827
1829
|
feedback_score_num?: number;
|
|
1828
1830
|
ip_address_hashed?: string;
|
|
1829
1831
|
tool_ui_closed_reason?: string;
|
|
@@ -1867,10 +1869,16 @@ declare class Client {
|
|
|
1867
1869
|
recommendation_set?: unknown[];
|
|
1868
1870
|
discovery_progress_score?: number;
|
|
1869
1871
|
rec_card_feedback_sentiment?: string;
|
|
1870
|
-
recommendation_id?: string;
|
|
1872
|
+
recommendation_id?: string | null;
|
|
1873
|
+
external_request_input_token_count?: number;
|
|
1874
|
+
external_request_output_token_count?: number | null;
|
|
1875
|
+
external_request_type?: string;
|
|
1876
|
+
external_request_subtype?: string;
|
|
1877
|
+
external_request_provider?: string;
|
|
1878
|
+
external_request_model_id?: string;
|
|
1871
1879
|
};
|
|
1872
1880
|
conversationId?: string;
|
|
1873
|
-
eventName: "entry_point-shown" | "feedback_submit-clicked" | "page-shown" | "tool_ui-closed" | "user_message-submitted" | "user_message-submitted message" | "user_message-submitted single_select" | "user_message-submitted multi_select" | "assistant_message-submitted" | "assistant_message-submitted recommendation" | "assistant_message-submitted message" | "assistant_message-submitted single_select" | "assistant_message-submitted multi_select" | "assistant_message-submitted exit_to_chat" | "assistant_message-submitted exit_to_purchase" | "assistant_message-submitted exit_to_human" | "feedback-shown" | "feedback_skip-clicked" | "sale-completed" | "sale-completed spectrum" | "sale-completed aidem" | "sale-completed spectrum-us-media-consumer-en" | "entry_point-clicked" | "tool_close-clicked" | "exit_to_chat-completed" | "exit_to_purchase-completed" | "conversation-started" | "user_qualification-identified" | "experiment_variation-assigned" | "slot_filling-completed" | "entry_point-closed" | "entry_point-suppressed" | "user-created" | "exit_to_human-completed" | "recommendation_set-returned" | "ww_rag_context-used" | "rec_card_feedback-clicked";
|
|
1881
|
+
eventName: "entry_point-shown" | "feedback_submit-clicked" | "page-shown" | "tool_ui-closed" | "user_message-submitted" | "user_message-submitted message" | "user_message-submitted single_select" | "user_message-submitted multi_select" | "assistant_message-submitted" | "assistant_message-submitted recommendation" | "assistant_message-submitted message" | "assistant_message-submitted single_select" | "assistant_message-submitted multi_select" | "assistant_message-submitted exit_to_chat" | "assistant_message-submitted exit_to_purchase" | "assistant_message-submitted exit_to_human" | "feedback-shown" | "feedback_skip-clicked" | "sale-completed" | "sale-completed spectrum" | "sale-completed aidem" | "sale-completed spectrum-us-media-consumer-en" | "entry_point-clicked" | "tool_close-clicked" | "exit_to_chat-completed" | "exit_to_purchase-completed" | "conversation-started" | "user_qualification-identified" | "experiment_variation-assigned" | "slot_filling-completed" | "entry_point-closed" | "entry_point-suppressed" | "user-created" | "exit_to_human-completed" | "recommendation_set-returned" | "ww_rag_context-used" | "ww_user_context-received" | "rec_card_feedback-clicked" | "external_request-submitted" | "external_request-submitted llm" | "external_request-submitted embedding" | "external_request-submitted embedding_service_level" | "ww_prompt_context-used" | "message_select_option-clicked";
|
|
1874
1882
|
pageviewId: string;
|
|
1875
1883
|
screenHeight?: number;
|
|
1876
1884
|
screenSize?: "mobile" | "large";
|
package/dist/index.js
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
"use strict";var A=Object.create;var d=Object.defineProperty;var D=Object.getOwnPropertyDescriptor;var R=Object.getOwnPropertyNames;var U=Object.getPrototypeOf,W=Object.prototype.hasOwnProperty;var V=(e,t)=>{for(var n in t)d(e,n,{get:t[n],enumerable:!0})},O=(e,t,n,i)=>{if(t&&typeof t=="object"||typeof t=="function")for(let o of R(t))!W.call(e,o)&&o!==n&&d(e,o,{get:()=>t[o],enumerable:!(i=D(t,o))||i.enumerable});return e};var j=(e,t,n)=>(n=e!=null?A(U(e)):{},O(t||!e||!e.__esModule?d(n,"default",{value:e,enumerable:!0}):n,e)),J=e=>O(d({},"__esModule",{value:!0}),e);var F={};V(F,{CONVERSATION_ID:()=>c,Client:()=>_,JWT_TOKEN:()=>f,SESSION_ID:()=>h,TTL:()=>N,USER_ID:()=>E,authMiddleware:()=>a,deleteConversationId:()=>u,errorMiddleware:()=>l,getConversationId:()=>m,getSessionId:()=>v,getToken:()=>M,getUserId:()=>S,headerMiddleware:()=>I,isTokenExpired:()=>P,setConversationId:()=>p,setSessionId:()=>y,setToken:()=>T,setUserId:()=>g});module.exports=J(F);var C=j(require("openapi-fetch"));var c="__15gifts_conversation_id",u=()=>sessionStorage.removeItem(c),m=()=>sessionStorage.getItem(c),p=e=>sessionStorage.setItem(c,e);var h="__15gifts_session_id",v=()=>sessionStorage.getItem(h),y=e=>sessionStorage.setItem(h,e);var G=e=>{let t=localStorage.getItem(e);if(!t)return null;let n=JSON.parse(t);return Date.now()>n.expires?(localStorage.removeItem(e),null):n.value},w=G;var X=(e,t,n)=>{let i={expires:Date.now()+n,value:t};localStorage.setItem(e,JSON.stringify(i))},x=X;var z=1e3*60*60*24,E="__15gifts_user_id",N=z*30,S=()=>{let e=w(E);return e&&g(e),e},g=e=>x(E,e,N);var f="__15gifts_identity_token",P=e=>{try{let[,t]=e.split(".");if(!t)throw new Error("Invalid token payload");let n=JSON.parse(atob(t));return n.exp&&Date.now()/1e3>n.exp}catch(t){return console.error("Invalid token format",t),!0}},M=()=>{let e=localStorage.getItem(f);return!e||P(e)?(localStorage.removeItem(f),null):e},T=e=>localStorage.setItem(f,e);var B=e=>({onRequest:async({request:t})=>{if(t.url.includes("/identity/"))return t;if(!e)throw new Error("Access token is required for authentication.");return t.headers.set("Authorization",`Bearer ${e}`),t}}),a=B;var H={onResponse:async({response:e})=>{if(!e.ok){let t=await e.json();throw new Error(t.message)}return e}},l=H;var K=(e,t)=>({onRequest:async({request:n})=>(e.pageviewId&&n.headers.set("X-PAGEVIEW-ID",e.pageviewId),t&&n.headers.set("X-PAGE-URL",t),n)}),I=K;var b="0.14.
|
|
1
|
+
"use strict";var A=Object.create;var d=Object.defineProperty;var D=Object.getOwnPropertyDescriptor;var R=Object.getOwnPropertyNames;var U=Object.getPrototypeOf,W=Object.prototype.hasOwnProperty;var V=(e,t)=>{for(var n in t)d(e,n,{get:t[n],enumerable:!0})},O=(e,t,n,i)=>{if(t&&typeof t=="object"||typeof t=="function")for(let o of R(t))!W.call(e,o)&&o!==n&&d(e,o,{get:()=>t[o],enumerable:!(i=D(t,o))||i.enumerable});return e};var j=(e,t,n)=>(n=e!=null?A(U(e)):{},O(t||!e||!e.__esModule?d(n,"default",{value:e,enumerable:!0}):n,e)),J=e=>O(d({},"__esModule",{value:!0}),e);var F={};V(F,{CONVERSATION_ID:()=>c,Client:()=>_,JWT_TOKEN:()=>f,SESSION_ID:()=>h,TTL:()=>N,USER_ID:()=>E,authMiddleware:()=>a,deleteConversationId:()=>u,errorMiddleware:()=>l,getConversationId:()=>m,getSessionId:()=>v,getToken:()=>M,getUserId:()=>S,headerMiddleware:()=>I,isTokenExpired:()=>P,setConversationId:()=>p,setSessionId:()=>y,setToken:()=>T,setUserId:()=>g});module.exports=J(F);var C=j(require("openapi-fetch"));var c="__15gifts_conversation_id",u=()=>sessionStorage.removeItem(c),m=()=>sessionStorage.getItem(c),p=e=>sessionStorage.setItem(c,e);var h="__15gifts_session_id",v=()=>sessionStorage.getItem(h),y=e=>sessionStorage.setItem(h,e);var G=e=>{let t=localStorage.getItem(e);if(!t)return null;let n=JSON.parse(t);return Date.now()>n.expires?(localStorage.removeItem(e),null):n.value},w=G;var X=(e,t,n)=>{let i={expires:Date.now()+n,value:t};localStorage.setItem(e,JSON.stringify(i))},x=X;var z=1e3*60*60*24,E="__15gifts_user_id",N=z*30,S=()=>{let e=w(E);return e&&g(e),e},g=e=>x(E,e,N);var f="__15gifts_identity_token",P=e=>{try{let[,t]=e.split(".");if(!t)throw new Error("Invalid token payload");let n=JSON.parse(atob(t));return n.exp&&Date.now()/1e3>n.exp}catch(t){return console.error("Invalid token format",t),!0}},M=()=>{let e=localStorage.getItem(f);return!e||P(e)?(localStorage.removeItem(f),null):e},T=e=>localStorage.setItem(f,e);var B=e=>({onRequest:async({request:t})=>{if(t.url.includes("/identity/"))return t;if(!e)throw new Error("Access token is required for authentication.");return t.headers.set("Authorization",`Bearer ${e}`),t}}),a=B;var H={onResponse:async({response:e})=>{if(!e.ok){let t=await e.json();throw new Error(t.message)}return e}},l=H;var K=(e,t)=>({onRequest:async({request:n})=>(e.pageviewId&&n.headers.set("X-PAGEVIEW-ID",e.pageviewId),t&&n.headers.set("X-PAGE-URL",t),n)}),I=K;var b="0.14.1";var _=class{endpoint;identity;constructor(t){let{conversationUrl:n,customerId:i,fetch:o,frontendUrl:r,headers:s}=t,k={...s,"X-SDK-VERSION":b};this.endpoint={conversation:(0,C.default)({baseUrl:n,fetch:o,headers:k,credentials:"include"}),frontend:(0,C.default)({baseUrl:r,fetch:o,headers:k})},this.identity={customerId:i,conversationId:m()??void 0,sessionId:v()??void 0,userId:S()??void 0},this.endpoint.conversation.use(l),this.endpoint.conversation.use(I(this.identity,window.location.href))}async createIdentity(){let{customerId:t,sessionId:n,userId:i}=this.identity;try{let{data:o}=await this.endpoint.frontend.POST("/api/tracking/identity/v2",{body:{customerId:t,sessionId:n,userId:i,url:window.location.href,userAgent:window.navigator.userAgent}});if(!o)throw new Error("No data received when creating identity");this.identity.pageviewId=o.pageviewId,n||(this.identity.sessionId=o.sessionId,y(o.sessionId)),i||(this.identity.userId=o.userId,g(o.userId)),T(o.token),Object.values(this.endpoint).forEach(r=>{r.use(a(o.token))})}catch(o){throw Object.values(this.endpoint).forEach(r=>{r.use(a())}),new Error("Failed to create identity. Please try again later.",{cause:o})}}endConversation(){u(),this.identity.conversationId=void 0}async startConversation(t){this.endConversation();let n={...t},{data:i}=await this.endpoint.conversation.POST("/api/conversation/v3",{body:{type:"START_CONVERSATION",conversationContext:n}});if(!i)return;let[o,r]=i,s=o.conversationId;if(!s)throw new Error("Conversation ID not received");return p(s),this.identity.conversationId=s,r}async sendMessage({userMessage:t}){let{data:n}=await this.endpoint.conversation.POST("/api/conversation/v3",{body:{conversationId:this.identity.conversationId,userMessage:t,type:"MESSAGE"}});if(!n)return;let i=n.find(r=>r.type==="CONVERSATION_ID")?.conversationId;return i&&(p(i),this.identity.conversationId=i),n.filter(r=>r.type!=="CONVERSATION_ID")}async trackEvent(t,n){let i={additionalProperties:n,conversationId:this.identity.conversationId,eventName:t,pageviewId:this.identity.pageviewId??"unknown",screenWidth:window.screen.width,screenHeight:window.screen.height,screenSize:window.screen.width<=480?"mobile":"large",url:window.location.href,userAgent:window.navigator.userAgent};return this.endpoint.frontend.POST("/api/tracking/user/v2",{body:i})}getIdentity(){return this.identity}getIdentityToken(){return M()}};0&&(module.exports={CONVERSATION_ID,Client,JWT_TOKEN,SESSION_ID,TTL,USER_ID,authMiddleware,deleteConversationId,errorMiddleware,getConversationId,getSessionId,getToken,getUserId,headerMiddleware,isTokenExpired,setConversationId,setSessionId,setToken,setUserId});
|
|
2
2
|
//# sourceMappingURL=index.js.map
|
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../src/index.ts","../src/client.ts","../src/identity/conversationId.ts","../src/identity/sessionId.ts","../src/utils/getItemWithExpiry.ts","../src/utils/setItemWithExpiry.ts","../src/identity/userId.ts","../src/identity/token.ts","../src/middlewares/auth.ts","../src/middlewares/error.ts","../src/middlewares/headers.ts","../package.json"],"sourcesContent":["export * from './client'\nexport * from './identity'\nexport * from './middlewares'\nexport * from './types'\n","import createClient, { type ClientOptions } from 'openapi-fetch'\n\nimport {\n deleteConversationId,\n getConversationId,\n getSessionId,\n getUserId,\n getToken,\n setConversationId,\n setSessionId,\n setUserId,\n setToken,\n} from './identity'\nimport { authMiddleware, errorMiddleware, headerMiddleware } from './middlewares'\nimport type { components, paths as conversationPaths } from './schemas/conversation'\nimport type { paths as frontendPaths } from './schemas/frontend'\nimport type { Config, ConversationIdMessage, Endpoint, Identity, Message, TextMessage, TrackingEvent } from './types'\nimport { version } from '../package.json'\n\n/**\n * The `Client` class provides methods to manage 15gifts API.\n */\nexport class Client {\n /**\n * This can be used to interact with the APIs directly. It is recommended to use the [helper methods](/sdk/sdk-reference/classes/client/#methods) provided by the `Client` class instead.\n *\n * @example\n * ```ts\n * const client = new Client({ customerId: 'YOUR_CUSTOMER_ID' })\n * const { data } = await client.endpoint.conversation.POST('/api/conversation/v3')\n * ```\n */\n endpoint: Endpoint\n\n /**\n * The identity information.\n */\n identity: Identity\n\n /**\n * Creates a new instance of the `Client` class.\n *\n * @param config - Configuration options for initializing the client.\n *\n * @example\n * ```ts\n * const client = new Client({ customerId: 'YOUR_CUSTOMER_ID' })\n * ```\n */\n constructor(config: Config) {\n const { conversationUrl, customerId, fetch, frontendUrl, headers: defaultHeaders } = config\n\n const headers: ClientOptions['headers'] = {\n ...defaultHeaders,\n 'X-SDK-VERSION': version,\n }\n\n this.endpoint = {\n conversation: createClient<conversationPaths>({\n baseUrl: conversationUrl,\n fetch,\n headers,\n credentials: 'include',\n }),\n frontend: createClient<frontendPaths>({ baseUrl: frontendUrl, fetch, headers }),\n }\n\n this.identity = {\n customerId,\n conversationId: getConversationId() ?? undefined,\n sessionId: getSessionId() ?? undefined,\n userId: getUserId() ?? undefined,\n }\n\n this.endpoint.conversation.use(errorMiddleware)\n this.endpoint.conversation.use(headerMiddleware(this.identity, window.location.href))\n }\n\n /**\n * Creates a new identity for the user by generating a session ID and user ID if they don't exist, and sets the access token for future API calls.\n * Ends the current conversation if a conversation ID is present before sending a request to update identity.\n * This should not be called more than once per page load.\n *\n * @returns A promise that resolves once the identity is created and the access token is set.\n *\n * @example\n * ```ts\n * await client.createIdentity()\n * console.log('Identity created:', client.identity)\n * ```\n */\n async createIdentity(): Promise<void> {\n const { customerId, sessionId, userId } = this.identity\n\n try {\n const { data } = await this.endpoint.frontend.POST('/api/tracking/identity/v2', {\n body: {\n customerId,\n sessionId,\n userId,\n url: window.location.href,\n userAgent: window.navigator.userAgent,\n },\n })\n\n if (!data) {\n throw new Error('No data received when creating identity')\n }\n\n this.identity.pageviewId = data.pageviewId\n\n if (!sessionId) {\n this.identity.sessionId = data.sessionId\n setSessionId(data.sessionId)\n }\n if (!userId) {\n this.identity.userId = data.userId\n setUserId(data.userId)\n }\n\n setToken(data.token)\n\n // Add the access token to the Authorization header for all endpoints\n Object.values(this.endpoint).forEach((endpoint) => {\n endpoint.use(authMiddleware(data.token))\n })\n } catch (error) {\n // Enable the auth middleware without a token so that it will throw an error before sending\n // the request, preventing unnecessary API calls / 401 responses.\n Object.values(this.endpoint).forEach((endpoint) => {\n endpoint.use(authMiddleware())\n })\n throw new Error('Failed to create identity. Please try again later.', { cause: error })\n }\n }\n\n /**\n * Ends the current conversation by deleting the conversation ID.\n *\n * @example\n * ```ts\n * client.endConversation()\n * console.log('Conversation ended')\n * ```\n */\n endConversation(): void {\n deleteConversationId()\n this.identity.conversationId = undefined\n }\n\n /**\n * Clears the existing conversation ID, then generates a new one and returns the opening message.\n *\n * @param context - Optional context to customize the conversation. It can include:\n * @param context.eligibleProducts An array of eligible product IDs.\n * @param context.eligibleBundles An array of eligible bundle IDs.\n * @param context.productOverrides Overrides for product details.\n * @param context.bundleOverrides Overrides for bundle details.\n *\n * @returns A promise that resolves to the opening message.\n *\n * @example\n * ##### Basic usage\n * ```ts\n * const openingMessage = await client.startConversation()\n * console.log('Opening message:', openingMessage)\n * ```\n *\n * ##### With context\n * ```ts\n * const openingMessage = await client.startConversation({ eligibleProducts: ['product-1', 'product-2'], productOverrides: { 'product-1': { price: 40 } })\n * console.log('Opening message:', openingMessage)\n * ```\n */\n async startConversation(context?: components['schemas']['ConversationContext']): Promise<TextMessage | undefined> {\n this.endConversation()\n\n const conversationContext = {\n ...context,\n }\n\n const { data } = await this.endpoint.conversation.POST(`/api/conversation/v3`, {\n body: {\n type: 'START_CONVERSATION',\n conversationContext,\n },\n })\n\n if (!data) return undefined\n\n const [conversationIdMessage, openingMessage] = data as [ConversationIdMessage, TextMessage]\n\n const conversationId = conversationIdMessage.conversationId\n if (!conversationId) {\n throw new Error('Conversation ID not received')\n }\n\n setConversationId(conversationId)\n this.identity.conversationId = conversationId\n\n return openingMessage\n }\n\n /**\n * Sends a message in the conversation.\n *\n * @param options - An object containing the user message.\n * @returns A promise that resolves to an array of messages\n *\n * @example\n * ```ts\n * const newMessages = await client.sendMessage({\n * userMessage: 'How can I get support?',\n * })\n *\n * if (newMessages) {\n * console.log('Received messages:', newMessages)\n * } else {\n * console.log('No message received')\n * }\n * ```\n */\n async sendMessage({\n userMessage,\n }: {\n userMessage: string\n }): Promise<Exclude<Message, ConversationIdMessage>[] | undefined> {\n const { data } = await this.endpoint.conversation.POST('/api/conversation/v3', {\n body: {\n conversationId: this.identity.conversationId,\n userMessage,\n type: 'MESSAGE',\n },\n })\n\n if (!data) return undefined\n\n // When a request does not contain a conversation ID, the API will return a new conversation ID as the first message\n const conversationId = data.find((message) => message.type === 'CONVERSATION_ID')?.conversationId\n if (conversationId) {\n setConversationId(conversationId)\n this.identity.conversationId = conversationId\n }\n\n const messages = data.filter((message) => message.type !== 'CONVERSATION_ID')\n return messages\n }\n\n /**\n * Sends an event to the tracking API, with the required properties already set.\n *\n * @param eventName - The name of the event to track.\n * @param properties - Additional properties to include in the event.\n * @returns A promise that resolves once the event is tracked.\n *\n * @example\n * ```ts\n * await client.trackEvent('entry_point-shown')\n * ```\n */\n async trackEvent(eventName: TrackingEvent['eventName'], properties?: TrackingEvent['additionalProperties']) {\n const body: TrackingEvent = {\n additionalProperties: properties,\n conversationId: this.identity.conversationId,\n eventName,\n pageviewId: this.identity.pageviewId ?? 'unknown',\n screenWidth: window.screen.width,\n screenHeight: window.screen.height,\n screenSize: window.screen.width <= 480 ? 'mobile' : 'large',\n url: window.location.href,\n userAgent: window.navigator.userAgent,\n }\n\n return this.endpoint.frontend.POST('/api/tracking/user/v2', {\n body,\n })\n }\n\n /**\n * Gets an existing identity of the user.\n *\n * @returns An Identity object containing `customerId`, `conversationId`, `sessionId`, `userId`.\n *\n * @example\n * ```ts\n * identity = client.getIdentity()\n * console.log('Identity retrieved:', identity)\n * ```\n */\n getIdentity(): Identity {\n return this.identity\n }\n\n /**\n * Gets the JWT from the localStorage.\n *\n * @returns {string | null} the JWT.\n *\n * @example\n * ```ts\n * token = client.getIdentityToken()\n * console.log('Identity token retrieved:', token)\n * ```\n */\n getIdentityToken(): string | null {\n return getToken()\n }\n}\n","/**\n * The key used to store the conversation ID in `sessionStorage`.\n *\n * @ignore\n */\nexport const CONVERSATION_ID = '__15gifts_conversation_id'\n\n/**\n * Deletes the conversation ID from `sessionStorage`.\n *\n * @example\n * ```ts\n * import { deleteConversationId } from '@15gifts/sdk'\n *\n * deleteConversationId()\n * // The conversation ID will be removed.\n * ```\n */\nexport const deleteConversationId = () => sessionStorage.removeItem(CONVERSATION_ID)\n\n/**\n * Retrieves the conversation ID from `sessionStorage`.\n *\n * @example\n * ```ts\n * import { getConversationId } from '@15gifts/sdk'\n *\n * const conversationId = getConversationId()\n *\n * if (conversationId) {\n * console.log(`Conversation ID: ${conversationId}`)\n * } else {\n * console.log('No conversation ID found.')\n * }\n * ```\n */\nexport const getConversationId = () => sessionStorage.getItem(CONVERSATION_ID)\n\n/**\n * Stores the given conversation ID in `sessionStorage`.\n *\n * @example\n * ```ts\n * import { setConversationId } from '@15gifts/sdk'\n *\n * setConversationId('ca0ab4ce-f697-41cc-8d0c-081762aace9b')\n * // The conversation ID 'ca0ab4ce-f697-41cc-8d0c-081762aace9b' will be stored.\n * ```\n */\nexport const setConversationId = (conversationId: string) => sessionStorage.setItem(CONVERSATION_ID, conversationId)\n","/**\n * The key used to store the session ID in `sessionStorage`.\n *\n * @ignore\n */\nexport const SESSION_ID = '__15gifts_session_id'\n\n/**\n * Retrieves the session ID from `sessionStorage`.\n *\n * @example\n * ```ts\n * import { getSessionId } from '@15gifts/sdk'\n *\n * const sessionId = getSessionId()\n *\n * if (sessionId) {\n * console.log(`Session ID: ${sessionId}`)\n * } else {\n * console.log('No session ID found.')\n * }\n * ```\n */\nexport const getSessionId = () => sessionStorage.getItem(SESSION_ID)\n\n/**\n * Stores the given session ID in `sessionStorage`.\n *\n * @example\n * ```ts\n * import { setSessionId } from '@15gifts/sdk'\n *\n * setSessionId('20b2bff6-64a0-4101-bed9-ff545326584a')\n * // The session ID '20b2bff6-64a0-4101-bed9-ff545326584a' will be stored.\n * ```\n */\nexport const setSessionId = (sessionId: string) => sessionStorage.setItem(SESSION_ID, sessionId)\n","const getItemWithExpiry = (key: string) => {\n const itemString = localStorage.getItem(key)\n\n if (!itemString) return null\n\n const item = JSON.parse(itemString) as { expires: number; value: string }\n\n if (Date.now() > item.expires) {\n localStorage.removeItem(key)\n\n return null\n }\n\n return item.value\n}\n\nexport default getItemWithExpiry\n","/**\n * Set an item in localStorage with an expiration time\n * @param key The key under which the value is stored in localStorage\n * @param value The value to be stored\n * @param ttl The time-to-live (TTL) in milliseconds\n */\nconst setItemWithExpiry = (key: string, value: string, ttl: number) => {\n const item = {\n expires: Date.now() + ttl,\n value,\n }\n\n localStorage.setItem(key, JSON.stringify(item))\n}\n\nexport default setItemWithExpiry\n","import { getItemWithExpiry, setItemWithExpiry } from '../utils'\nconst day = 1000 * 60 * 60 * 24\n\n/**\n * The key used to store the user ID in `localStorage`.\n *\n * @ignore\n */\nexport const USER_ID = '__15gifts_user_id'\n\n/**\n * Time-to-live (TTL) for the user ID in milliseconds.\n * Set to 30 days.\n *\n * @ignore\n */\nexport const TTL = day * 30\n\n/**\n * Retrieves the user ID from `localStorage` and updates its expiry time.\n *\n * @example\n * ```ts\n * import { getUserId } from '@15gifts/sdk'\n *\n * const userId = getUserId()\n *\n * if (userId) {\n * console.log(`User ID: ${userId}`)\n * } else {\n * console.log('No user ID found.')\n * }\n * ```\n */\nexport const getUserId = () => {\n const userId = getItemWithExpiry(USER_ID)\n\n // Update the userId with a new expiry time\n // So that it will be valid for another 30 days, rather than 30 days from when it was first set\n if (userId) {\n setUserId(userId)\n }\n\n return userId\n}\n\n/**\n * Stores the given user ID in `localStorage`.\n *\n * @example\n * ```ts\n * import { setUserId } from '@15gifts/sdk'\n *\n * setUserId('5b77656c-ea4c-492f-82bf-7129297c5873')\n * // The user ID '5b77656c-ea4c-492f-82bf-7129297c5873' will be stored with a 30-day expiry.\n * ```\n */\nexport const setUserId = (userId: string) => setItemWithExpiry(USER_ID, userId, TTL)\n","/**\n * The key used to store the JWT in `localStorage`.\n *\n * @ignore\n */\nexport const JWT_TOKEN = '__15gifts_identity_token'\n\n/**\n * Checks if the JWT is expired.\n *\n * @param {string} token - the JWT.\n * @returns {boolean} `true` if expired, `false` otherwise.\n */\nexport const isTokenExpired = (token: string): boolean => {\n try {\n const [, payloadBase64] = token.split('.')\n if (!payloadBase64) {\n throw new Error('Invalid token payload')\n }\n const payload = JSON.parse(atob(payloadBase64))\n\n return payload.exp && Date.now() / 1000 > payload.exp\n } catch (error) {\n console.error('Invalid token format', error)\n return true\n }\n}\n\n/**\n * Retrieves the JWT from `localStorage` and checks if it is expired.\n *\n * @returns {string | null} The JWT if valid, otherwise `null`.\n */\nexport const getToken = (): string | null => {\n const token = localStorage.getItem(JWT_TOKEN)\n\n if (!token || isTokenExpired(token)) {\n localStorage.removeItem(JWT_TOKEN)\n return null\n }\n\n return token\n}\n\n/**\n * Stores the given JWT in `localStorage`.\n *\n * @example\n * ```ts\n * import { setToken } from '@15gifts/sdk'\n *\n * setToken('ey...')\n * ```\n */\nexport const setToken = (token: string) => localStorage.setItem(JWT_TOKEN, token)\n","import type { Middleware } from 'openapi-fetch'\n\n/**\n * Middleware for adding an `Authorization` header to requests.\n *\n * @param accessToken - The token to be included in the `Authorization` header.\n * @returns A middleware object that attaches the access token to the request headers.\n *\n * @example\n * ```ts\n * import { authMiddleware } from '@15gifts/sdk';\n *\n * this.endpoint.conversation.use(authMiddleware(accessToken))\n * ```\n */\nconst authMiddleware = (accessToken?: string): Middleware => ({\n onRequest: async ({ request }) => {\n const isIdentityEndpoint = request.url.includes('/identity/')\n if (isIdentityEndpoint) {\n return request\n }\n\n // Throw an error because we know the API will return a 401 if the access token is not set.\n if (!accessToken) {\n throw new Error('Access token is required for authentication.')\n }\n\n request.headers.set('Authorization', `Bearer ${accessToken}`)\n\n return request\n },\n})\n\nexport default authMiddleware\n","import type { Middleware } from 'openapi-fetch'\n\n/**\n * Middleware for handling errors.\n *\n * @returns A middleware object that throws an error if the response is not ok.\n *\n * @example\n * ```ts\n * import { errorMiddleware } from '@15gifts/sdk';\n *\n * this.endpoint.conversation.use(errorMiddleware())\n * ```\n */\nconst errorMiddleware: Middleware = {\n // onError does not handle error responses with 4xx or 5xx HTTP status codes, since these are considered \"successful\" responses but with a bad status code.\n // In these cases we need to check the response's status property or ok() method via the onResponse callback.\n onResponse: async ({ response }) => {\n if (!response.ok) {\n const data = await response.json()\n\n throw new Error(data.message)\n }\n\n return response\n },\n}\n\nexport default errorMiddleware\n","import type { Middleware } from 'openapi-fetch'\n\nimport { Identity } from '../types'\n\n/**\n * Middleware for adding request headers that other services use for tracking.\n *\n * @returns A middleware object that throws an error if the response is not ok.\n *\n * @example\n * ```ts\n * import { pageViewId } from '@15gifts/sdk';\n *\n * this.endpoint.conversation.use(headerMiddleware('123', 'https://example.com'))\n * ```\n */\nconst headerMiddleware = (identity: Identity, url: string): Middleware => ({\n onRequest: async ({ request }) => {\n if (identity.pageviewId) {\n request.headers.set('X-PAGEVIEW-ID', identity.pageviewId)\n }\n if (url) {\n request.headers.set('X-PAGE-URL', url)\n }\n\n return request\n },\n})\n\nexport default headerMiddleware\n","{\n \"name\": \"@15gifts/sdk\",\n \"version\": \"0.14.0\",\n \"files\": [\n \"dist\"\n ],\n \"main\": \"./dist/index.js\",\n \"module\": \"./dist/index.mjs\",\n \"types\": \"./dist/index.d.ts\",\n \"scripts\": {\n \"build\": \"npm run generate && tsup\",\n \"coverage\": \"vitest run --coverage\",\n \"dev\": \"tsup --watch\",\n \"format\": \"prettier . --write\",\n \"generate\": \"npx openapi-typescript\",\n \"lint\": \"eslint .\",\n \"test\": \"vitest run\",\n \"test:watch\": \"vitest\",\n \"typecheck\": \"tsc\"\n },\n \"dependencies\": {\n \"openapi-fetch\": \"^0.13.4\"\n },\n \"devDependencies\": {\n \"openapi-typescript\": \"^7.6.0\",\n \"tsup\": \"^8.3.6\"\n },\n \"sideEffects\": false,\n \"prettier\": \"prettier-config-custom\"\n}\n"],"mappings":"0jBAAA,IAAAA,EAAA,GAAAC,EAAAD,EAAA,qBAAAE,EAAA,WAAAC,EAAA,cAAAC,EAAA,eAAAC,EAAA,QAAAC,EAAA,YAAAC,EAAA,mBAAAC,EAAA,yBAAAC,EAAA,oBAAAC,EAAA,sBAAAC,EAAA,iBAAAC,EAAA,aAAAC,EAAA,cAAAC,EAAA,qBAAAC,EAAA,mBAAAC,EAAA,sBAAAC,EAAA,iBAAAC,EAAA,aAAAC,EAAA,cAAAC,IAAA,eAAAC,EAAArB,GCAA,IAAAsB,EAAiD,4BCK1C,IAAMC,EAAkB,4BAalBC,EAAuB,IAAM,eAAe,WAAWD,CAAe,EAkBtEE,EAAoB,IAAM,eAAe,QAAQF,CAAe,EAahEG,EAAqBC,GAA2B,eAAe,QAAQJ,EAAiBI,CAAc,EC5C5G,IAAMC,EAAa,uBAkBbC,EAAe,IAAM,eAAe,QAAQD,CAAU,EAatDE,EAAgBC,GAAsB,eAAe,QAAQH,EAAYG,CAAS,ECpC/F,IAAMC,EAAqBC,GAAgB,CACzC,IAAMC,EAAa,aAAa,QAAQD,CAAG,EAE3C,GAAI,CAACC,EAAY,OAAO,KAExB,IAAMC,EAAO,KAAK,MAAMD,CAAU,EAElC,OAAI,KAAK,IAAI,EAAIC,EAAK,SACpB,aAAa,WAAWF,CAAG,EAEpB,MAGFE,EAAK,KACd,EAEOC,EAAQJ,ECVf,IAAMK,EAAoB,CAACC,EAAaC,EAAeC,IAAgB,CACrE,IAAMC,EAAO,CACX,QAAS,KAAK,IAAI,EAAID,EACtB,MAAAD,CACF,EAEA,aAAa,QAAQD,EAAK,KAAK,UAAUG,CAAI,CAAC,CAChD,EAEOC,EAAQL,ECdf,IAAMM,EAAM,IAAO,GAAK,GAAK,GAOhBC,EAAU,oBAQVC,EAAMF,EAAM,GAkBZG,EAAY,IAAM,CAC7B,IAAMC,EAASC,EAAkBJ,CAAO,EAIxC,OAAIG,GACFE,EAAUF,CAAM,EAGXA,CACT,EAaaE,EAAaF,GAAmBG,EAAkBN,EAASG,EAAQF,CAAG,ECpD5E,IAAMM,EAAY,2BAQZC,EAAkBC,GAA2B,CACxD,GAAI,CACF,GAAM,CAAC,CAAEC,CAAa,EAAID,EAAM,MAAM,GAAG,EACzC,GAAI,CAACC,EACH,MAAM,IAAI,MAAM,uBAAuB,EAEzC,IAAMC,EAAU,KAAK,MAAM,KAAKD,CAAa,CAAC,EAE9C,OAAOC,EAAQ,KAAO,KAAK,IAAI,EAAI,IAAOA,EAAQ,GACpD,OAASC,EAAO,CACd,eAAQ,MAAM,uBAAwBA,CAAK,EACpC,EACT,CACF,EAOaC,EAAW,IAAqB,CAC3C,IAAMJ,EAAQ,aAAa,QAAQF,CAAS,EAE5C,MAAI,CAACE,GAASD,EAAeC,CAAK,GAChC,aAAa,WAAWF,CAAS,EAC1B,MAGFE,CACT,EAYaK,EAAYL,GAAkB,aAAa,QAAQF,EAAWE,CAAK,ECvChF,IAAMM,EAAkBC,IAAsC,CAC5D,UAAW,MAAO,CAAE,QAAAC,CAAQ,IAAM,CAEhC,GAD2BA,EAAQ,IAAI,SAAS,YAAY,EAE1D,OAAOA,EAIT,GAAI,CAACD,EACH,MAAM,IAAI,MAAM,8CAA8C,EAGhE,OAAAC,EAAQ,QAAQ,IAAI,gBAAiB,UAAUD,CAAW,EAAE,EAErDC,CACT,CACF,GAEOC,EAAQH,ECnBf,IAAMI,EAA8B,CAGlC,WAAY,MAAO,CAAE,SAAAC,CAAS,IAAM,CAClC,GAAI,CAACA,EAAS,GAAI,CAChB,IAAMC,EAAO,MAAMD,EAAS,KAAK,EAEjC,MAAM,IAAI,MAAMC,EAAK,OAAO,CAC9B,CAEA,OAAOD,CACT,CACF,EAEOE,EAAQH,ECZf,IAAMI,EAAmB,CAACC,EAAoBC,KAA6B,CACzE,UAAW,MAAO,CAAE,QAAAC,CAAQ,KACtBF,EAAS,YACXE,EAAQ,QAAQ,IAAI,gBAAiBF,EAAS,UAAU,EAEtDC,GACFC,EAAQ,QAAQ,IAAI,aAAcD,CAAG,EAGhCC,EAEX,GAEOC,EAAQJ,EC3Bb,IAAAK,EAAW,SVoBN,IAAMC,EAAN,KAAa,CAUlB,SAKA,SAYA,YAAYC,EAAgB,CAC1B,GAAM,CAAE,gBAAAC,EAAiB,WAAAC,EAAY,MAAAC,EAAO,YAAAC,EAAa,QAASC,CAAe,EAAIL,EAE/EM,EAAoC,CACxC,GAAGD,EACH,gBAAiBE,CACnB,EAEA,KAAK,SAAW,CACd,gBAAc,EAAAC,SAAgC,CAC5C,QAASP,EACT,MAAAE,EACA,QAAAG,EACA,YAAa,SACf,CAAC,EACD,YAAU,EAAAE,SAA4B,CAAE,QAASJ,EAAa,MAAAD,EAAO,QAAAG,CAAQ,CAAC,CAChF,EAEA,KAAK,SAAW,CACd,WAAAJ,EACA,eAAgBO,EAAkB,GAAK,OACvC,UAAWC,EAAa,GAAK,OAC7B,OAAQC,EAAU,GAAK,MACzB,EAEA,KAAK,SAAS,aAAa,IAAIC,CAAe,EAC9C,KAAK,SAAS,aAAa,IAAIC,EAAiB,KAAK,SAAU,OAAO,SAAS,IAAI,CAAC,CACtF,CAeA,MAAM,gBAAgC,CACpC,GAAM,CAAE,WAAAX,EAAY,UAAAY,EAAW,OAAAC,CAAO,EAAI,KAAK,SAE/C,GAAI,CACF,GAAM,CAAE,KAAAC,CAAK,EAAI,MAAM,KAAK,SAAS,SAAS,KAAK,4BAA6B,CAC9E,KAAM,CACJ,WAAAd,EACA,UAAAY,EACA,OAAAC,EACA,IAAK,OAAO,SAAS,KACrB,UAAW,OAAO,UAAU,SAC9B,CACF,CAAC,EAED,GAAI,CAACC,EACH,MAAM,IAAI,MAAM,yCAAyC,EAG3D,KAAK,SAAS,WAAaA,EAAK,WAE3BF,IACH,KAAK,SAAS,UAAYE,EAAK,UAC/BC,EAAaD,EAAK,SAAS,GAExBD,IACH,KAAK,SAAS,OAASC,EAAK,OAC5BE,EAAUF,EAAK,MAAM,GAGvBG,EAASH,EAAK,KAAK,EAGnB,OAAO,OAAO,KAAK,QAAQ,EAAE,QAASI,GAAa,CACjDA,EAAS,IAAIC,EAAeL,EAAK,KAAK,CAAC,CACzC,CAAC,CACH,OAASM,EAAO,CAGd,aAAO,OAAO,KAAK,QAAQ,EAAE,QAASF,GAAa,CACjDA,EAAS,IAAIC,EAAe,CAAC,CAC/B,CAAC,EACK,IAAI,MAAM,qDAAsD,CAAE,MAAOC,CAAM,CAAC,CACxF,CACF,CAWA,iBAAwB,CACtBC,EAAqB,EACrB,KAAK,SAAS,eAAiB,MACjC,CA0BA,MAAM,kBAAkBC,EAA0F,CAChH,KAAK,gBAAgB,EAErB,IAAMC,EAAsB,CAC1B,GAAGD,CACL,EAEM,CAAE,KAAAR,CAAK,EAAI,MAAM,KAAK,SAAS,aAAa,KAAK,uBAAwB,CAC7E,KAAM,CACJ,KAAM,qBACN,oBAAAS,CACF,CACF,CAAC,EAED,GAAI,CAACT,EAAM,OAEX,GAAM,CAACU,EAAuBC,CAAc,EAAIX,EAE1CY,EAAiBF,EAAsB,eAC7C,GAAI,CAACE,EACH,MAAM,IAAI,MAAM,8BAA8B,EAGhD,OAAAC,EAAkBD,CAAc,EAChC,KAAK,SAAS,eAAiBA,EAExBD,CACT,CAqBA,MAAM,YAAY,CAChB,YAAAG,CACF,EAEmE,CACjE,GAAM,CAAE,KAAAd,CAAK,EAAI,MAAM,KAAK,SAAS,aAAa,KAAK,uBAAwB,CAC7E,KAAM,CACJ,eAAgB,KAAK,SAAS,eAC9B,YAAAc,EACA,KAAM,SACR,CACF,CAAC,EAED,GAAI,CAACd,EAAM,OAGX,IAAMY,EAAiBZ,EAAK,KAAMe,GAAYA,EAAQ,OAAS,iBAAiB,GAAG,eACnF,OAAIH,IACFC,EAAkBD,CAAc,EAChC,KAAK,SAAS,eAAiBA,GAGhBZ,EAAK,OAAQe,GAAYA,EAAQ,OAAS,iBAAiB,CAE9E,CAcA,MAAM,WAAWC,EAAuCC,EAAoD,CAC1G,IAAMC,EAAsB,CAC1B,qBAAsBD,EACtB,eAAgB,KAAK,SAAS,eAC9B,UAAAD,EACA,WAAY,KAAK,SAAS,YAAc,UACxC,YAAa,OAAO,OAAO,MAC3B,aAAc,OAAO,OAAO,OAC5B,WAAY,OAAO,OAAO,OAAS,IAAM,SAAW,QACpD,IAAK,OAAO,SAAS,KACrB,UAAW,OAAO,UAAU,SAC9B,EAEA,OAAO,KAAK,SAAS,SAAS,KAAK,wBAAyB,CAC1D,KAAAE,CACF,CAAC,CACH,CAaA,aAAwB,CACtB,OAAO,KAAK,QACd,CAaA,kBAAkC,CAChC,OAAOC,EAAS,CAClB,CACF","names":["index_exports","__export","CONVERSATION_ID","Client","JWT_TOKEN","SESSION_ID","TTL","USER_ID","auth_default","deleteConversationId","error_default","getConversationId","getSessionId","getToken","getUserId","headers_default","isTokenExpired","setConversationId","setSessionId","setToken","setUserId","__toCommonJS","import_openapi_fetch","CONVERSATION_ID","deleteConversationId","getConversationId","setConversationId","conversationId","SESSION_ID","getSessionId","setSessionId","sessionId","getItemWithExpiry","key","itemString","item","getItemWithExpiry_default","setItemWithExpiry","key","value","ttl","item","setItemWithExpiry_default","day","USER_ID","TTL","getUserId","userId","getItemWithExpiry_default","setUserId","setItemWithExpiry_default","JWT_TOKEN","isTokenExpired","token","payloadBase64","payload","error","getToken","setToken","authMiddleware","accessToken","request","auth_default","errorMiddleware","response","data","error_default","headerMiddleware","identity","url","request","headers_default","version","Client","config","conversationUrl","customerId","fetch","frontendUrl","defaultHeaders","headers","version","createClient","getConversationId","getSessionId","getUserId","error_default","headers_default","sessionId","userId","data","setSessionId","setUserId","setToken","endpoint","auth_default","error","deleteConversationId","context","conversationContext","conversationIdMessage","openingMessage","conversationId","setConversationId","userMessage","message","eventName","properties","body","getToken"]}
|
|
1
|
+
{"version":3,"sources":["../src/index.ts","../src/client.ts","../src/identity/conversationId.ts","../src/identity/sessionId.ts","../src/utils/getItemWithExpiry.ts","../src/utils/setItemWithExpiry.ts","../src/identity/userId.ts","../src/identity/token.ts","../src/middlewares/auth.ts","../src/middlewares/error.ts","../src/middlewares/headers.ts","../package.json"],"sourcesContent":["export * from './client'\nexport * from './identity'\nexport * from './middlewares'\nexport * from './types'\n","import createClient, { type ClientOptions } from 'openapi-fetch'\n\nimport {\n deleteConversationId,\n getConversationId,\n getSessionId,\n getUserId,\n getToken,\n setConversationId,\n setSessionId,\n setUserId,\n setToken,\n} from './identity'\nimport { authMiddleware, errorMiddleware, headerMiddleware } from './middlewares'\nimport type { components, paths as conversationPaths } from './schemas/conversation'\nimport type { paths as frontendPaths } from './schemas/frontend'\nimport type { Config, ConversationIdMessage, Endpoint, Identity, Message, TextMessage, TrackingEvent } from './types'\nimport { version } from '../package.json'\n\n/**\n * The `Client` class provides methods to manage 15gifts API.\n */\nexport class Client {\n /**\n * This can be used to interact with the APIs directly. It is recommended to use the [helper methods](/sdk/sdk-reference/classes/client/#methods) provided by the `Client` class instead.\n *\n * @example\n * ```ts\n * const client = new Client({ customerId: 'YOUR_CUSTOMER_ID' })\n * const { data } = await client.endpoint.conversation.POST('/api/conversation/v3')\n * ```\n */\n endpoint: Endpoint\n\n /**\n * The identity information.\n */\n identity: Identity\n\n /**\n * Creates a new instance of the `Client` class.\n *\n * @param config - Configuration options for initializing the client.\n *\n * @example\n * ```ts\n * const client = new Client({ customerId: 'YOUR_CUSTOMER_ID' })\n * ```\n */\n constructor(config: Config) {\n const { conversationUrl, customerId, fetch, frontendUrl, headers: defaultHeaders } = config\n\n const headers: ClientOptions['headers'] = {\n ...defaultHeaders,\n 'X-SDK-VERSION': version,\n }\n\n this.endpoint = {\n conversation: createClient<conversationPaths>({\n baseUrl: conversationUrl,\n fetch,\n headers,\n credentials: 'include',\n }),\n frontend: createClient<frontendPaths>({ baseUrl: frontendUrl, fetch, headers }),\n }\n\n this.identity = {\n customerId,\n conversationId: getConversationId() ?? undefined,\n sessionId: getSessionId() ?? undefined,\n userId: getUserId() ?? undefined,\n }\n\n this.endpoint.conversation.use(errorMiddleware)\n this.endpoint.conversation.use(headerMiddleware(this.identity, window.location.href))\n }\n\n /**\n * Creates a new identity for the user by generating a session ID and user ID if they don't exist, and sets the access token for future API calls.\n * Ends the current conversation if a conversation ID is present before sending a request to update identity.\n * This should not be called more than once per page load.\n *\n * @returns A promise that resolves once the identity is created and the access token is set.\n *\n * @example\n * ```ts\n * await client.createIdentity()\n * console.log('Identity created:', client.identity)\n * ```\n */\n async createIdentity(): Promise<void> {\n const { customerId, sessionId, userId } = this.identity\n\n try {\n const { data } = await this.endpoint.frontend.POST('/api/tracking/identity/v2', {\n body: {\n customerId,\n sessionId,\n userId,\n url: window.location.href,\n userAgent: window.navigator.userAgent,\n },\n })\n\n if (!data) {\n throw new Error('No data received when creating identity')\n }\n\n this.identity.pageviewId = data.pageviewId\n\n if (!sessionId) {\n this.identity.sessionId = data.sessionId\n setSessionId(data.sessionId)\n }\n if (!userId) {\n this.identity.userId = data.userId\n setUserId(data.userId)\n }\n\n setToken(data.token)\n\n // Add the access token to the Authorization header for all endpoints\n Object.values(this.endpoint).forEach((endpoint) => {\n endpoint.use(authMiddleware(data.token))\n })\n } catch (error) {\n // Enable the auth middleware without a token so that it will throw an error before sending\n // the request, preventing unnecessary API calls / 401 responses.\n Object.values(this.endpoint).forEach((endpoint) => {\n endpoint.use(authMiddleware())\n })\n throw new Error('Failed to create identity. Please try again later.', { cause: error })\n }\n }\n\n /**\n * Ends the current conversation by deleting the conversation ID.\n *\n * @example\n * ```ts\n * client.endConversation()\n * console.log('Conversation ended')\n * ```\n */\n endConversation(): void {\n deleteConversationId()\n this.identity.conversationId = undefined\n }\n\n /**\n * Clears the existing conversation ID, then generates a new one and returns the opening message.\n *\n * @param context - Optional context to customize the conversation. It can include:\n * @param context.eligibleProducts An array of eligible product IDs.\n * @param context.eligibleBundles An array of eligible bundle IDs.\n * @param context.productOverrides Overrides for product details.\n * @param context.bundleOverrides Overrides for bundle details.\n *\n * @returns A promise that resolves to the opening message.\n *\n * @example\n * ##### Basic usage\n * ```ts\n * const openingMessage = await client.startConversation()\n * console.log('Opening message:', openingMessage)\n * ```\n *\n * ##### With context\n * ```ts\n * const openingMessage = await client.startConversation({ eligibleProducts: ['product-1', 'product-2'], productOverrides: { 'product-1': { price: 40 } })\n * console.log('Opening message:', openingMessage)\n * ```\n */\n async startConversation(context?: components['schemas']['ConversationContext']): Promise<TextMessage | undefined> {\n this.endConversation()\n\n const conversationContext = {\n ...context,\n }\n\n const { data } = await this.endpoint.conversation.POST(`/api/conversation/v3`, {\n body: {\n type: 'START_CONVERSATION',\n conversationContext,\n },\n })\n\n if (!data) return undefined\n\n const [conversationIdMessage, openingMessage] = data as [ConversationIdMessage, TextMessage]\n\n const conversationId = conversationIdMessage.conversationId\n if (!conversationId) {\n throw new Error('Conversation ID not received')\n }\n\n setConversationId(conversationId)\n this.identity.conversationId = conversationId\n\n return openingMessage\n }\n\n /**\n * Sends a message in the conversation.\n *\n * @param options - An object containing the user message.\n * @returns A promise that resolves to an array of messages\n *\n * @example\n * ```ts\n * const newMessages = await client.sendMessage({\n * userMessage: 'How can I get support?',\n * })\n *\n * if (newMessages) {\n * console.log('Received messages:', newMessages)\n * } else {\n * console.log('No message received')\n * }\n * ```\n */\n async sendMessage({\n userMessage,\n }: {\n userMessage: string\n }): Promise<Exclude<Message, ConversationIdMessage>[] | undefined> {\n const { data } = await this.endpoint.conversation.POST('/api/conversation/v3', {\n body: {\n conversationId: this.identity.conversationId,\n userMessage,\n type: 'MESSAGE',\n },\n })\n\n if (!data) return undefined\n\n // When a request does not contain a conversation ID, the API will return a new conversation ID as the first message\n const conversationId = data.find((message) => message.type === 'CONVERSATION_ID')?.conversationId\n if (conversationId) {\n setConversationId(conversationId)\n this.identity.conversationId = conversationId\n }\n\n const messages = data.filter((message) => message.type !== 'CONVERSATION_ID')\n return messages\n }\n\n /**\n * Sends an event to the tracking API, with the required properties already set.\n *\n * @param eventName - The name of the event to track.\n * @param properties - Additional properties to include in the event.\n * @returns A promise that resolves once the event is tracked.\n *\n * @example\n * ```ts\n * await client.trackEvent('entry_point-shown')\n * ```\n */\n async trackEvent(eventName: TrackingEvent['eventName'], properties?: TrackingEvent['additionalProperties']) {\n const body: TrackingEvent = {\n additionalProperties: properties,\n conversationId: this.identity.conversationId,\n eventName,\n pageviewId: this.identity.pageviewId ?? 'unknown',\n screenWidth: window.screen.width,\n screenHeight: window.screen.height,\n screenSize: window.screen.width <= 480 ? 'mobile' : 'large',\n url: window.location.href,\n userAgent: window.navigator.userAgent,\n }\n\n return this.endpoint.frontend.POST('/api/tracking/user/v2', {\n body,\n })\n }\n\n /**\n * Gets an existing identity of the user.\n *\n * @returns An Identity object containing `customerId`, `conversationId`, `sessionId`, `userId`.\n *\n * @example\n * ```ts\n * identity = client.getIdentity()\n * console.log('Identity retrieved:', identity)\n * ```\n */\n getIdentity(): Identity {\n return this.identity\n }\n\n /**\n * Gets the JWT from the localStorage.\n *\n * @returns {string | null} the JWT.\n *\n * @example\n * ```ts\n * token = client.getIdentityToken()\n * console.log('Identity token retrieved:', token)\n * ```\n */\n getIdentityToken(): string | null {\n return getToken()\n }\n}\n","/**\n * The key used to store the conversation ID in `sessionStorage`.\n *\n * @ignore\n */\nexport const CONVERSATION_ID = '__15gifts_conversation_id'\n\n/**\n * Deletes the conversation ID from `sessionStorage`.\n *\n * @example\n * ```ts\n * import { deleteConversationId } from '@15gifts/sdk'\n *\n * deleteConversationId()\n * // The conversation ID will be removed.\n * ```\n */\nexport const deleteConversationId = () => sessionStorage.removeItem(CONVERSATION_ID)\n\n/**\n * Retrieves the conversation ID from `sessionStorage`.\n *\n * @example\n * ```ts\n * import { getConversationId } from '@15gifts/sdk'\n *\n * const conversationId = getConversationId()\n *\n * if (conversationId) {\n * console.log(`Conversation ID: ${conversationId}`)\n * } else {\n * console.log('No conversation ID found.')\n * }\n * ```\n */\nexport const getConversationId = () => sessionStorage.getItem(CONVERSATION_ID)\n\n/**\n * Stores the given conversation ID in `sessionStorage`.\n *\n * @example\n * ```ts\n * import { setConversationId } from '@15gifts/sdk'\n *\n * setConversationId('ca0ab4ce-f697-41cc-8d0c-081762aace9b')\n * // The conversation ID 'ca0ab4ce-f697-41cc-8d0c-081762aace9b' will be stored.\n * ```\n */\nexport const setConversationId = (conversationId: string) => sessionStorage.setItem(CONVERSATION_ID, conversationId)\n","/**\n * The key used to store the session ID in `sessionStorage`.\n *\n * @ignore\n */\nexport const SESSION_ID = '__15gifts_session_id'\n\n/**\n * Retrieves the session ID from `sessionStorage`.\n *\n * @example\n * ```ts\n * import { getSessionId } from '@15gifts/sdk'\n *\n * const sessionId = getSessionId()\n *\n * if (sessionId) {\n * console.log(`Session ID: ${sessionId}`)\n * } else {\n * console.log('No session ID found.')\n * }\n * ```\n */\nexport const getSessionId = () => sessionStorage.getItem(SESSION_ID)\n\n/**\n * Stores the given session ID in `sessionStorage`.\n *\n * @example\n * ```ts\n * import { setSessionId } from '@15gifts/sdk'\n *\n * setSessionId('20b2bff6-64a0-4101-bed9-ff545326584a')\n * // The session ID '20b2bff6-64a0-4101-bed9-ff545326584a' will be stored.\n * ```\n */\nexport const setSessionId = (sessionId: string) => sessionStorage.setItem(SESSION_ID, sessionId)\n","const getItemWithExpiry = (key: string) => {\n const itemString = localStorage.getItem(key)\n\n if (!itemString) return null\n\n const item = JSON.parse(itemString) as { expires: number; value: string }\n\n if (Date.now() > item.expires) {\n localStorage.removeItem(key)\n\n return null\n }\n\n return item.value\n}\n\nexport default getItemWithExpiry\n","/**\n * Set an item in localStorage with an expiration time\n * @param key The key under which the value is stored in localStorage\n * @param value The value to be stored\n * @param ttl The time-to-live (TTL) in milliseconds\n */\nconst setItemWithExpiry = (key: string, value: string, ttl: number) => {\n const item = {\n expires: Date.now() + ttl,\n value,\n }\n\n localStorage.setItem(key, JSON.stringify(item))\n}\n\nexport default setItemWithExpiry\n","import { getItemWithExpiry, setItemWithExpiry } from '../utils'\nconst day = 1000 * 60 * 60 * 24\n\n/**\n * The key used to store the user ID in `localStorage`.\n *\n * @ignore\n */\nexport const USER_ID = '__15gifts_user_id'\n\n/**\n * Time-to-live (TTL) for the user ID in milliseconds.\n * Set to 30 days.\n *\n * @ignore\n */\nexport const TTL = day * 30\n\n/**\n * Retrieves the user ID from `localStorage` and updates its expiry time.\n *\n * @example\n * ```ts\n * import { getUserId } from '@15gifts/sdk'\n *\n * const userId = getUserId()\n *\n * if (userId) {\n * console.log(`User ID: ${userId}`)\n * } else {\n * console.log('No user ID found.')\n * }\n * ```\n */\nexport const getUserId = () => {\n const userId = getItemWithExpiry(USER_ID)\n\n // Update the userId with a new expiry time\n // So that it will be valid for another 30 days, rather than 30 days from when it was first set\n if (userId) {\n setUserId(userId)\n }\n\n return userId\n}\n\n/**\n * Stores the given user ID in `localStorage`.\n *\n * @example\n * ```ts\n * import { setUserId } from '@15gifts/sdk'\n *\n * setUserId('5b77656c-ea4c-492f-82bf-7129297c5873')\n * // The user ID '5b77656c-ea4c-492f-82bf-7129297c5873' will be stored with a 30-day expiry.\n * ```\n */\nexport const setUserId = (userId: string) => setItemWithExpiry(USER_ID, userId, TTL)\n","/**\n * The key used to store the JWT in `localStorage`.\n *\n * @ignore\n */\nexport const JWT_TOKEN = '__15gifts_identity_token'\n\n/**\n * Checks if the JWT is expired.\n *\n * @param {string} token - the JWT.\n * @returns {boolean} `true` if expired, `false` otherwise.\n */\nexport const isTokenExpired = (token: string): boolean => {\n try {\n const [, payloadBase64] = token.split('.')\n if (!payloadBase64) {\n throw new Error('Invalid token payload')\n }\n const payload = JSON.parse(atob(payloadBase64))\n\n return payload.exp && Date.now() / 1000 > payload.exp\n } catch (error) {\n console.error('Invalid token format', error)\n return true\n }\n}\n\n/**\n * Retrieves the JWT from `localStorage` and checks if it is expired.\n *\n * @returns {string | null} The JWT if valid, otherwise `null`.\n */\nexport const getToken = (): string | null => {\n const token = localStorage.getItem(JWT_TOKEN)\n\n if (!token || isTokenExpired(token)) {\n localStorage.removeItem(JWT_TOKEN)\n return null\n }\n\n return token\n}\n\n/**\n * Stores the given JWT in `localStorage`.\n *\n * @example\n * ```ts\n * import { setToken } from '@15gifts/sdk'\n *\n * setToken('ey...')\n * ```\n */\nexport const setToken = (token: string) => localStorage.setItem(JWT_TOKEN, token)\n","import type { Middleware } from 'openapi-fetch'\n\n/**\n * Middleware for adding an `Authorization` header to requests.\n *\n * @param accessToken - The token to be included in the `Authorization` header.\n * @returns A middleware object that attaches the access token to the request headers.\n *\n * @example\n * ```ts\n * import { authMiddleware } from '@15gifts/sdk';\n *\n * this.endpoint.conversation.use(authMiddleware(accessToken))\n * ```\n */\nconst authMiddleware = (accessToken?: string): Middleware => ({\n onRequest: async ({ request }) => {\n const isIdentityEndpoint = request.url.includes('/identity/')\n if (isIdentityEndpoint) {\n return request\n }\n\n // Throw an error because we know the API will return a 401 if the access token is not set.\n if (!accessToken) {\n throw new Error('Access token is required for authentication.')\n }\n\n request.headers.set('Authorization', `Bearer ${accessToken}`)\n\n return request\n },\n})\n\nexport default authMiddleware\n","import type { Middleware } from 'openapi-fetch'\n\n/**\n * Middleware for handling errors.\n *\n * @returns A middleware object that throws an error if the response is not ok.\n *\n * @example\n * ```ts\n * import { errorMiddleware } from '@15gifts/sdk';\n *\n * this.endpoint.conversation.use(errorMiddleware())\n * ```\n */\nconst errorMiddleware: Middleware = {\n // onError does not handle error responses with 4xx or 5xx HTTP status codes, since these are considered \"successful\" responses but with a bad status code.\n // In these cases we need to check the response's status property or ok() method via the onResponse callback.\n onResponse: async ({ response }) => {\n if (!response.ok) {\n const data = await response.json()\n\n throw new Error(data.message)\n }\n\n return response\n },\n}\n\nexport default errorMiddleware\n","import type { Middleware } from 'openapi-fetch'\n\nimport { Identity } from '../types'\n\n/**\n * Middleware for adding request headers that other services use for tracking.\n *\n * @returns A middleware object that throws an error if the response is not ok.\n *\n * @example\n * ```ts\n * import { pageViewId } from '@15gifts/sdk';\n *\n * this.endpoint.conversation.use(headerMiddleware('123', 'https://example.com'))\n * ```\n */\nconst headerMiddleware = (identity: Identity, url: string): Middleware => ({\n onRequest: async ({ request }) => {\n if (identity.pageviewId) {\n request.headers.set('X-PAGEVIEW-ID', identity.pageviewId)\n }\n if (url) {\n request.headers.set('X-PAGE-URL', url)\n }\n\n return request\n },\n})\n\nexport default headerMiddleware\n","{\n \"name\": \"@15gifts/sdk\",\n \"version\": \"0.14.1\",\n \"files\": [\n \"dist\"\n ],\n \"main\": \"./dist/index.js\",\n \"module\": \"./dist/index.mjs\",\n \"types\": \"./dist/index.d.ts\",\n \"scripts\": {\n \"build\": \"npm run generate && tsup\",\n \"coverage\": \"vitest run --coverage\",\n \"dev\": \"tsup --watch\",\n \"format\": \"prettier . --write\",\n \"generate\": \"npx openapi-typescript\",\n \"lint\": \"eslint .\",\n \"test\": \"vitest run\",\n \"test:watch\": \"vitest\",\n \"typecheck\": \"tsc\"\n },\n \"dependencies\": {\n \"openapi-fetch\": \"^0.13.4\"\n },\n \"devDependencies\": {\n \"openapi-typescript\": \"^7.6.0\",\n \"tsup\": \"^8.3.6\"\n },\n \"sideEffects\": false,\n \"prettier\": \"prettier-config-custom\"\n}\n"],"mappings":"0jBAAA,IAAAA,EAAA,GAAAC,EAAAD,EAAA,qBAAAE,EAAA,WAAAC,EAAA,cAAAC,EAAA,eAAAC,EAAA,QAAAC,EAAA,YAAAC,EAAA,mBAAAC,EAAA,yBAAAC,EAAA,oBAAAC,EAAA,sBAAAC,EAAA,iBAAAC,EAAA,aAAAC,EAAA,cAAAC,EAAA,qBAAAC,EAAA,mBAAAC,EAAA,sBAAAC,EAAA,iBAAAC,EAAA,aAAAC,EAAA,cAAAC,IAAA,eAAAC,EAAArB,GCAA,IAAAsB,EAAiD,4BCK1C,IAAMC,EAAkB,4BAalBC,EAAuB,IAAM,eAAe,WAAWD,CAAe,EAkBtEE,EAAoB,IAAM,eAAe,QAAQF,CAAe,EAahEG,EAAqBC,GAA2B,eAAe,QAAQJ,EAAiBI,CAAc,EC5C5G,IAAMC,EAAa,uBAkBbC,EAAe,IAAM,eAAe,QAAQD,CAAU,EAatDE,EAAgBC,GAAsB,eAAe,QAAQH,EAAYG,CAAS,ECpC/F,IAAMC,EAAqBC,GAAgB,CACzC,IAAMC,EAAa,aAAa,QAAQD,CAAG,EAE3C,GAAI,CAACC,EAAY,OAAO,KAExB,IAAMC,EAAO,KAAK,MAAMD,CAAU,EAElC,OAAI,KAAK,IAAI,EAAIC,EAAK,SACpB,aAAa,WAAWF,CAAG,EAEpB,MAGFE,EAAK,KACd,EAEOC,EAAQJ,ECVf,IAAMK,EAAoB,CAACC,EAAaC,EAAeC,IAAgB,CACrE,IAAMC,EAAO,CACX,QAAS,KAAK,IAAI,EAAID,EACtB,MAAAD,CACF,EAEA,aAAa,QAAQD,EAAK,KAAK,UAAUG,CAAI,CAAC,CAChD,EAEOC,EAAQL,ECdf,IAAMM,EAAM,IAAO,GAAK,GAAK,GAOhBC,EAAU,oBAQVC,EAAMF,EAAM,GAkBZG,EAAY,IAAM,CAC7B,IAAMC,EAASC,EAAkBJ,CAAO,EAIxC,OAAIG,GACFE,EAAUF,CAAM,EAGXA,CACT,EAaaE,EAAaF,GAAmBG,EAAkBN,EAASG,EAAQF,CAAG,ECpD5E,IAAMM,EAAY,2BAQZC,EAAkBC,GAA2B,CACxD,GAAI,CACF,GAAM,CAAC,CAAEC,CAAa,EAAID,EAAM,MAAM,GAAG,EACzC,GAAI,CAACC,EACH,MAAM,IAAI,MAAM,uBAAuB,EAEzC,IAAMC,EAAU,KAAK,MAAM,KAAKD,CAAa,CAAC,EAE9C,OAAOC,EAAQ,KAAO,KAAK,IAAI,EAAI,IAAOA,EAAQ,GACpD,OAASC,EAAO,CACd,eAAQ,MAAM,uBAAwBA,CAAK,EACpC,EACT,CACF,EAOaC,EAAW,IAAqB,CAC3C,IAAMJ,EAAQ,aAAa,QAAQF,CAAS,EAE5C,MAAI,CAACE,GAASD,EAAeC,CAAK,GAChC,aAAa,WAAWF,CAAS,EAC1B,MAGFE,CACT,EAYaK,EAAYL,GAAkB,aAAa,QAAQF,EAAWE,CAAK,ECvChF,IAAMM,EAAkBC,IAAsC,CAC5D,UAAW,MAAO,CAAE,QAAAC,CAAQ,IAAM,CAEhC,GAD2BA,EAAQ,IAAI,SAAS,YAAY,EAE1D,OAAOA,EAIT,GAAI,CAACD,EACH,MAAM,IAAI,MAAM,8CAA8C,EAGhE,OAAAC,EAAQ,QAAQ,IAAI,gBAAiB,UAAUD,CAAW,EAAE,EAErDC,CACT,CACF,GAEOC,EAAQH,ECnBf,IAAMI,EAA8B,CAGlC,WAAY,MAAO,CAAE,SAAAC,CAAS,IAAM,CAClC,GAAI,CAACA,EAAS,GAAI,CAChB,IAAMC,EAAO,MAAMD,EAAS,KAAK,EAEjC,MAAM,IAAI,MAAMC,EAAK,OAAO,CAC9B,CAEA,OAAOD,CACT,CACF,EAEOE,EAAQH,ECZf,IAAMI,EAAmB,CAACC,EAAoBC,KAA6B,CACzE,UAAW,MAAO,CAAE,QAAAC,CAAQ,KACtBF,EAAS,YACXE,EAAQ,QAAQ,IAAI,gBAAiBF,EAAS,UAAU,EAEtDC,GACFC,EAAQ,QAAQ,IAAI,aAAcD,CAAG,EAGhCC,EAEX,GAEOC,EAAQJ,EC3Bb,IAAAK,EAAW,SVoBN,IAAMC,EAAN,KAAa,CAUlB,SAKA,SAYA,YAAYC,EAAgB,CAC1B,GAAM,CAAE,gBAAAC,EAAiB,WAAAC,EAAY,MAAAC,EAAO,YAAAC,EAAa,QAASC,CAAe,EAAIL,EAE/EM,EAAoC,CACxC,GAAGD,EACH,gBAAiBE,CACnB,EAEA,KAAK,SAAW,CACd,gBAAc,EAAAC,SAAgC,CAC5C,QAASP,EACT,MAAAE,EACA,QAAAG,EACA,YAAa,SACf,CAAC,EACD,YAAU,EAAAE,SAA4B,CAAE,QAASJ,EAAa,MAAAD,EAAO,QAAAG,CAAQ,CAAC,CAChF,EAEA,KAAK,SAAW,CACd,WAAAJ,EACA,eAAgBO,EAAkB,GAAK,OACvC,UAAWC,EAAa,GAAK,OAC7B,OAAQC,EAAU,GAAK,MACzB,EAEA,KAAK,SAAS,aAAa,IAAIC,CAAe,EAC9C,KAAK,SAAS,aAAa,IAAIC,EAAiB,KAAK,SAAU,OAAO,SAAS,IAAI,CAAC,CACtF,CAeA,MAAM,gBAAgC,CACpC,GAAM,CAAE,WAAAX,EAAY,UAAAY,EAAW,OAAAC,CAAO,EAAI,KAAK,SAE/C,GAAI,CACF,GAAM,CAAE,KAAAC,CAAK,EAAI,MAAM,KAAK,SAAS,SAAS,KAAK,4BAA6B,CAC9E,KAAM,CACJ,WAAAd,EACA,UAAAY,EACA,OAAAC,EACA,IAAK,OAAO,SAAS,KACrB,UAAW,OAAO,UAAU,SAC9B,CACF,CAAC,EAED,GAAI,CAACC,EACH,MAAM,IAAI,MAAM,yCAAyC,EAG3D,KAAK,SAAS,WAAaA,EAAK,WAE3BF,IACH,KAAK,SAAS,UAAYE,EAAK,UAC/BC,EAAaD,EAAK,SAAS,GAExBD,IACH,KAAK,SAAS,OAASC,EAAK,OAC5BE,EAAUF,EAAK,MAAM,GAGvBG,EAASH,EAAK,KAAK,EAGnB,OAAO,OAAO,KAAK,QAAQ,EAAE,QAASI,GAAa,CACjDA,EAAS,IAAIC,EAAeL,EAAK,KAAK,CAAC,CACzC,CAAC,CACH,OAASM,EAAO,CAGd,aAAO,OAAO,KAAK,QAAQ,EAAE,QAASF,GAAa,CACjDA,EAAS,IAAIC,EAAe,CAAC,CAC/B,CAAC,EACK,IAAI,MAAM,qDAAsD,CAAE,MAAOC,CAAM,CAAC,CACxF,CACF,CAWA,iBAAwB,CACtBC,EAAqB,EACrB,KAAK,SAAS,eAAiB,MACjC,CA0BA,MAAM,kBAAkBC,EAA0F,CAChH,KAAK,gBAAgB,EAErB,IAAMC,EAAsB,CAC1B,GAAGD,CACL,EAEM,CAAE,KAAAR,CAAK,EAAI,MAAM,KAAK,SAAS,aAAa,KAAK,uBAAwB,CAC7E,KAAM,CACJ,KAAM,qBACN,oBAAAS,CACF,CACF,CAAC,EAED,GAAI,CAACT,EAAM,OAEX,GAAM,CAACU,EAAuBC,CAAc,EAAIX,EAE1CY,EAAiBF,EAAsB,eAC7C,GAAI,CAACE,EACH,MAAM,IAAI,MAAM,8BAA8B,EAGhD,OAAAC,EAAkBD,CAAc,EAChC,KAAK,SAAS,eAAiBA,EAExBD,CACT,CAqBA,MAAM,YAAY,CAChB,YAAAG,CACF,EAEmE,CACjE,GAAM,CAAE,KAAAd,CAAK,EAAI,MAAM,KAAK,SAAS,aAAa,KAAK,uBAAwB,CAC7E,KAAM,CACJ,eAAgB,KAAK,SAAS,eAC9B,YAAAc,EACA,KAAM,SACR,CACF,CAAC,EAED,GAAI,CAACd,EAAM,OAGX,IAAMY,EAAiBZ,EAAK,KAAMe,GAAYA,EAAQ,OAAS,iBAAiB,GAAG,eACnF,OAAIH,IACFC,EAAkBD,CAAc,EAChC,KAAK,SAAS,eAAiBA,GAGhBZ,EAAK,OAAQe,GAAYA,EAAQ,OAAS,iBAAiB,CAE9E,CAcA,MAAM,WAAWC,EAAuCC,EAAoD,CAC1G,IAAMC,EAAsB,CAC1B,qBAAsBD,EACtB,eAAgB,KAAK,SAAS,eAC9B,UAAAD,EACA,WAAY,KAAK,SAAS,YAAc,UACxC,YAAa,OAAO,OAAO,MAC3B,aAAc,OAAO,OAAO,OAC5B,WAAY,OAAO,OAAO,OAAS,IAAM,SAAW,QACpD,IAAK,OAAO,SAAS,KACrB,UAAW,OAAO,UAAU,SAC9B,EAEA,OAAO,KAAK,SAAS,SAAS,KAAK,wBAAyB,CAC1D,KAAAE,CACF,CAAC,CACH,CAaA,aAAwB,CACtB,OAAO,KAAK,QACd,CAaA,kBAAkC,CAChC,OAAOC,EAAS,CAClB,CACF","names":["index_exports","__export","CONVERSATION_ID","Client","JWT_TOKEN","SESSION_ID","TTL","USER_ID","auth_default","deleteConversationId","error_default","getConversationId","getSessionId","getToken","getUserId","headers_default","isTokenExpired","setConversationId","setSessionId","setToken","setUserId","__toCommonJS","import_openapi_fetch","CONVERSATION_ID","deleteConversationId","getConversationId","setConversationId","conversationId","SESSION_ID","getSessionId","setSessionId","sessionId","getItemWithExpiry","key","itemString","item","getItemWithExpiry_default","setItemWithExpiry","key","value","ttl","item","setItemWithExpiry_default","day","USER_ID","TTL","getUserId","userId","getItemWithExpiry_default","setUserId","setItemWithExpiry_default","JWT_TOKEN","isTokenExpired","token","payloadBase64","payload","error","getToken","setToken","authMiddleware","accessToken","request","auth_default","errorMiddleware","response","data","error_default","headerMiddleware","identity","url","request","headers_default","version","Client","config","conversationUrl","customerId","fetch","frontendUrl","defaultHeaders","headers","version","createClient","getConversationId","getSessionId","getUserId","error_default","headers_default","sessionId","userId","data","setSessionId","setUserId","setToken","endpoint","auth_default","error","deleteConversationId","context","conversationContext","conversationIdMessage","openingMessage","conversationId","setConversationId","userMessage","message","eventName","properties","body","getToken"]}
|
package/dist/index.mjs
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
import _ from"openapi-fetch";var d="__15gifts_conversation_id",h=()=>sessionStorage.removeItem(d),v=()=>sessionStorage.getItem(d),c=e=>sessionStorage.setItem(d,e);var y="__15gifts_session_id",w=()=>sessionStorage.getItem(y),x=e=>sessionStorage.setItem(y,e);var O=e=>{let t=localStorage.getItem(e);if(!t)return null;let n=JSON.parse(t);return Date.now()>n.expires?(localStorage.removeItem(e),null):n.value},p=O;var N=(e,t,n)=>{let i={expires:Date.now()+n,value:t};localStorage.setItem(e,JSON.stringify(i))},g=N;var P=1e3*60*60*24,E="__15gifts_user_id",b=P*30,S=()=>{let e=p(E);return e&&f(e),e},f=e=>g(E,e,b);var l="__15gifts_identity_token",A=e=>{try{let[,t]=e.split(".");if(!t)throw new Error("Invalid token payload");let n=JSON.parse(atob(t));return n.exp&&Date.now()/1e3>n.exp}catch(t){return console.error("Invalid token format",t),!0}},M=()=>{let e=localStorage.getItem(l);return!e||A(e)?(localStorage.removeItem(l),null):e},T=e=>localStorage.setItem(l,e);var D=e=>({onRequest:async({request:t})=>{if(t.url.includes("/identity/"))return t;if(!e)throw new Error("Access token is required for authentication.");return t.headers.set("Authorization",`Bearer ${e}`),t}}),a=D;var R={onResponse:async({response:e})=>{if(!e.ok){let t=await e.json();throw new Error(t.message)}return e}},I=R;var U=(e,t)=>({onRequest:async({request:n})=>(e.pageviewId&&n.headers.set("X-PAGEVIEW-ID",e.pageviewId),t&&n.headers.set("X-PAGE-URL",t),n)}),u=U;var C="0.14.
|
|
1
|
+
import _ from"openapi-fetch";var d="__15gifts_conversation_id",h=()=>sessionStorage.removeItem(d),v=()=>sessionStorage.getItem(d),c=e=>sessionStorage.setItem(d,e);var y="__15gifts_session_id",w=()=>sessionStorage.getItem(y),x=e=>sessionStorage.setItem(y,e);var O=e=>{let t=localStorage.getItem(e);if(!t)return null;let n=JSON.parse(t);return Date.now()>n.expires?(localStorage.removeItem(e),null):n.value},p=O;var N=(e,t,n)=>{let i={expires:Date.now()+n,value:t};localStorage.setItem(e,JSON.stringify(i))},g=N;var P=1e3*60*60*24,E="__15gifts_user_id",b=P*30,S=()=>{let e=p(E);return e&&f(e),e},f=e=>g(E,e,b);var l="__15gifts_identity_token",A=e=>{try{let[,t]=e.split(".");if(!t)throw new Error("Invalid token payload");let n=JSON.parse(atob(t));return n.exp&&Date.now()/1e3>n.exp}catch(t){return console.error("Invalid token format",t),!0}},M=()=>{let e=localStorage.getItem(l);return!e||A(e)?(localStorage.removeItem(l),null):e},T=e=>localStorage.setItem(l,e);var D=e=>({onRequest:async({request:t})=>{if(t.url.includes("/identity/"))return t;if(!e)throw new Error("Access token is required for authentication.");return t.headers.set("Authorization",`Bearer ${e}`),t}}),a=D;var R={onResponse:async({response:e})=>{if(!e.ok){let t=await e.json();throw new Error(t.message)}return e}},I=R;var U=(e,t)=>({onRequest:async({request:n})=>(e.pageviewId&&n.headers.set("X-PAGEVIEW-ID",e.pageviewId),t&&n.headers.set("X-PAGE-URL",t),n)}),u=U;var C="0.14.1";var k=class{endpoint;identity;constructor(t){let{conversationUrl:n,customerId:i,fetch:o,frontendUrl:r,headers:s}=t,m={...s,"X-SDK-VERSION":C};this.endpoint={conversation:_({baseUrl:n,fetch:o,headers:m,credentials:"include"}),frontend:_({baseUrl:r,fetch:o,headers:m})},this.identity={customerId:i,conversationId:v()??void 0,sessionId:w()??void 0,userId:S()??void 0},this.endpoint.conversation.use(I),this.endpoint.conversation.use(u(this.identity,window.location.href))}async createIdentity(){let{customerId:t,sessionId:n,userId:i}=this.identity;try{let{data:o}=await this.endpoint.frontend.POST("/api/tracking/identity/v2",{body:{customerId:t,sessionId:n,userId:i,url:window.location.href,userAgent:window.navigator.userAgent}});if(!o)throw new Error("No data received when creating identity");this.identity.pageviewId=o.pageviewId,n||(this.identity.sessionId=o.sessionId,x(o.sessionId)),i||(this.identity.userId=o.userId,f(o.userId)),T(o.token),Object.values(this.endpoint).forEach(r=>{r.use(a(o.token))})}catch(o){throw Object.values(this.endpoint).forEach(r=>{r.use(a())}),new Error("Failed to create identity. Please try again later.",{cause:o})}}endConversation(){h(),this.identity.conversationId=void 0}async startConversation(t){this.endConversation();let n={...t},{data:i}=await this.endpoint.conversation.POST("/api/conversation/v3",{body:{type:"START_CONVERSATION",conversationContext:n}});if(!i)return;let[o,r]=i,s=o.conversationId;if(!s)throw new Error("Conversation ID not received");return c(s),this.identity.conversationId=s,r}async sendMessage({userMessage:t}){let{data:n}=await this.endpoint.conversation.POST("/api/conversation/v3",{body:{conversationId:this.identity.conversationId,userMessage:t,type:"MESSAGE"}});if(!n)return;let i=n.find(r=>r.type==="CONVERSATION_ID")?.conversationId;return i&&(c(i),this.identity.conversationId=i),n.filter(r=>r.type!=="CONVERSATION_ID")}async trackEvent(t,n){let i={additionalProperties:n,conversationId:this.identity.conversationId,eventName:t,pageviewId:this.identity.pageviewId??"unknown",screenWidth:window.screen.width,screenHeight:window.screen.height,screenSize:window.screen.width<=480?"mobile":"large",url:window.location.href,userAgent:window.navigator.userAgent};return this.endpoint.frontend.POST("/api/tracking/user/v2",{body:i})}getIdentity(){return this.identity}getIdentityToken(){return M()}};export{d as CONVERSATION_ID,k as Client,l as JWT_TOKEN,y as SESSION_ID,b as TTL,E as USER_ID,a as authMiddleware,h as deleteConversationId,I as errorMiddleware,v as getConversationId,w as getSessionId,M as getToken,S as getUserId,u as headerMiddleware,A as isTokenExpired,c as setConversationId,x as setSessionId,T as setToken,f as setUserId};
|
|
2
2
|
//# sourceMappingURL=index.mjs.map
|
package/dist/index.mjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../src/client.ts","../src/identity/conversationId.ts","../src/identity/sessionId.ts","../src/utils/getItemWithExpiry.ts","../src/utils/setItemWithExpiry.ts","../src/identity/userId.ts","../src/identity/token.ts","../src/middlewares/auth.ts","../src/middlewares/error.ts","../src/middlewares/headers.ts","../package.json"],"sourcesContent":["import createClient, { type ClientOptions } from 'openapi-fetch'\n\nimport {\n deleteConversationId,\n getConversationId,\n getSessionId,\n getUserId,\n getToken,\n setConversationId,\n setSessionId,\n setUserId,\n setToken,\n} from './identity'\nimport { authMiddleware, errorMiddleware, headerMiddleware } from './middlewares'\nimport type { components, paths as conversationPaths } from './schemas/conversation'\nimport type { paths as frontendPaths } from './schemas/frontend'\nimport type { Config, ConversationIdMessage, Endpoint, Identity, Message, TextMessage, TrackingEvent } from './types'\nimport { version } from '../package.json'\n\n/**\n * The `Client` class provides methods to manage 15gifts API.\n */\nexport class Client {\n /**\n * This can be used to interact with the APIs directly. It is recommended to use the [helper methods](/sdk/sdk-reference/classes/client/#methods) provided by the `Client` class instead.\n *\n * @example\n * ```ts\n * const client = new Client({ customerId: 'YOUR_CUSTOMER_ID' })\n * const { data } = await client.endpoint.conversation.POST('/api/conversation/v3')\n * ```\n */\n endpoint: Endpoint\n\n /**\n * The identity information.\n */\n identity: Identity\n\n /**\n * Creates a new instance of the `Client` class.\n *\n * @param config - Configuration options for initializing the client.\n *\n * @example\n * ```ts\n * const client = new Client({ customerId: 'YOUR_CUSTOMER_ID' })\n * ```\n */\n constructor(config: Config) {\n const { conversationUrl, customerId, fetch, frontendUrl, headers: defaultHeaders } = config\n\n const headers: ClientOptions['headers'] = {\n ...defaultHeaders,\n 'X-SDK-VERSION': version,\n }\n\n this.endpoint = {\n conversation: createClient<conversationPaths>({\n baseUrl: conversationUrl,\n fetch,\n headers,\n credentials: 'include',\n }),\n frontend: createClient<frontendPaths>({ baseUrl: frontendUrl, fetch, headers }),\n }\n\n this.identity = {\n customerId,\n conversationId: getConversationId() ?? undefined,\n sessionId: getSessionId() ?? undefined,\n userId: getUserId() ?? undefined,\n }\n\n this.endpoint.conversation.use(errorMiddleware)\n this.endpoint.conversation.use(headerMiddleware(this.identity, window.location.href))\n }\n\n /**\n * Creates a new identity for the user by generating a session ID and user ID if they don't exist, and sets the access token for future API calls.\n * Ends the current conversation if a conversation ID is present before sending a request to update identity.\n * This should not be called more than once per page load.\n *\n * @returns A promise that resolves once the identity is created and the access token is set.\n *\n * @example\n * ```ts\n * await client.createIdentity()\n * console.log('Identity created:', client.identity)\n * ```\n */\n async createIdentity(): Promise<void> {\n const { customerId, sessionId, userId } = this.identity\n\n try {\n const { data } = await this.endpoint.frontend.POST('/api/tracking/identity/v2', {\n body: {\n customerId,\n sessionId,\n userId,\n url: window.location.href,\n userAgent: window.navigator.userAgent,\n },\n })\n\n if (!data) {\n throw new Error('No data received when creating identity')\n }\n\n this.identity.pageviewId = data.pageviewId\n\n if (!sessionId) {\n this.identity.sessionId = data.sessionId\n setSessionId(data.sessionId)\n }\n if (!userId) {\n this.identity.userId = data.userId\n setUserId(data.userId)\n }\n\n setToken(data.token)\n\n // Add the access token to the Authorization header for all endpoints\n Object.values(this.endpoint).forEach((endpoint) => {\n endpoint.use(authMiddleware(data.token))\n })\n } catch (error) {\n // Enable the auth middleware without a token so that it will throw an error before sending\n // the request, preventing unnecessary API calls / 401 responses.\n Object.values(this.endpoint).forEach((endpoint) => {\n endpoint.use(authMiddleware())\n })\n throw new Error('Failed to create identity. Please try again later.', { cause: error })\n }\n }\n\n /**\n * Ends the current conversation by deleting the conversation ID.\n *\n * @example\n * ```ts\n * client.endConversation()\n * console.log('Conversation ended')\n * ```\n */\n endConversation(): void {\n deleteConversationId()\n this.identity.conversationId = undefined\n }\n\n /**\n * Clears the existing conversation ID, then generates a new one and returns the opening message.\n *\n * @param context - Optional context to customize the conversation. It can include:\n * @param context.eligibleProducts An array of eligible product IDs.\n * @param context.eligibleBundles An array of eligible bundle IDs.\n * @param context.productOverrides Overrides for product details.\n * @param context.bundleOverrides Overrides for bundle details.\n *\n * @returns A promise that resolves to the opening message.\n *\n * @example\n * ##### Basic usage\n * ```ts\n * const openingMessage = await client.startConversation()\n * console.log('Opening message:', openingMessage)\n * ```\n *\n * ##### With context\n * ```ts\n * const openingMessage = await client.startConversation({ eligibleProducts: ['product-1', 'product-2'], productOverrides: { 'product-1': { price: 40 } })\n * console.log('Opening message:', openingMessage)\n * ```\n */\n async startConversation(context?: components['schemas']['ConversationContext']): Promise<TextMessage | undefined> {\n this.endConversation()\n\n const conversationContext = {\n ...context,\n }\n\n const { data } = await this.endpoint.conversation.POST(`/api/conversation/v3`, {\n body: {\n type: 'START_CONVERSATION',\n conversationContext,\n },\n })\n\n if (!data) return undefined\n\n const [conversationIdMessage, openingMessage] = data as [ConversationIdMessage, TextMessage]\n\n const conversationId = conversationIdMessage.conversationId\n if (!conversationId) {\n throw new Error('Conversation ID not received')\n }\n\n setConversationId(conversationId)\n this.identity.conversationId = conversationId\n\n return openingMessage\n }\n\n /**\n * Sends a message in the conversation.\n *\n * @param options - An object containing the user message.\n * @returns A promise that resolves to an array of messages\n *\n * @example\n * ```ts\n * const newMessages = await client.sendMessage({\n * userMessage: 'How can I get support?',\n * })\n *\n * if (newMessages) {\n * console.log('Received messages:', newMessages)\n * } else {\n * console.log('No message received')\n * }\n * ```\n */\n async sendMessage({\n userMessage,\n }: {\n userMessage: string\n }): Promise<Exclude<Message, ConversationIdMessage>[] | undefined> {\n const { data } = await this.endpoint.conversation.POST('/api/conversation/v3', {\n body: {\n conversationId: this.identity.conversationId,\n userMessage,\n type: 'MESSAGE',\n },\n })\n\n if (!data) return undefined\n\n // When a request does not contain a conversation ID, the API will return a new conversation ID as the first message\n const conversationId = data.find((message) => message.type === 'CONVERSATION_ID')?.conversationId\n if (conversationId) {\n setConversationId(conversationId)\n this.identity.conversationId = conversationId\n }\n\n const messages = data.filter((message) => message.type !== 'CONVERSATION_ID')\n return messages\n }\n\n /**\n * Sends an event to the tracking API, with the required properties already set.\n *\n * @param eventName - The name of the event to track.\n * @param properties - Additional properties to include in the event.\n * @returns A promise that resolves once the event is tracked.\n *\n * @example\n * ```ts\n * await client.trackEvent('entry_point-shown')\n * ```\n */\n async trackEvent(eventName: TrackingEvent['eventName'], properties?: TrackingEvent['additionalProperties']) {\n const body: TrackingEvent = {\n additionalProperties: properties,\n conversationId: this.identity.conversationId,\n eventName,\n pageviewId: this.identity.pageviewId ?? 'unknown',\n screenWidth: window.screen.width,\n screenHeight: window.screen.height,\n screenSize: window.screen.width <= 480 ? 'mobile' : 'large',\n url: window.location.href,\n userAgent: window.navigator.userAgent,\n }\n\n return this.endpoint.frontend.POST('/api/tracking/user/v2', {\n body,\n })\n }\n\n /**\n * Gets an existing identity of the user.\n *\n * @returns An Identity object containing `customerId`, `conversationId`, `sessionId`, `userId`.\n *\n * @example\n * ```ts\n * identity = client.getIdentity()\n * console.log('Identity retrieved:', identity)\n * ```\n */\n getIdentity(): Identity {\n return this.identity\n }\n\n /**\n * Gets the JWT from the localStorage.\n *\n * @returns {string | null} the JWT.\n *\n * @example\n * ```ts\n * token = client.getIdentityToken()\n * console.log('Identity token retrieved:', token)\n * ```\n */\n getIdentityToken(): string | null {\n return getToken()\n }\n}\n","/**\n * The key used to store the conversation ID in `sessionStorage`.\n *\n * @ignore\n */\nexport const CONVERSATION_ID = '__15gifts_conversation_id'\n\n/**\n * Deletes the conversation ID from `sessionStorage`.\n *\n * @example\n * ```ts\n * import { deleteConversationId } from '@15gifts/sdk'\n *\n * deleteConversationId()\n * // The conversation ID will be removed.\n * ```\n */\nexport const deleteConversationId = () => sessionStorage.removeItem(CONVERSATION_ID)\n\n/**\n * Retrieves the conversation ID from `sessionStorage`.\n *\n * @example\n * ```ts\n * import { getConversationId } from '@15gifts/sdk'\n *\n * const conversationId = getConversationId()\n *\n * if (conversationId) {\n * console.log(`Conversation ID: ${conversationId}`)\n * } else {\n * console.log('No conversation ID found.')\n * }\n * ```\n */\nexport const getConversationId = () => sessionStorage.getItem(CONVERSATION_ID)\n\n/**\n * Stores the given conversation ID in `sessionStorage`.\n *\n * @example\n * ```ts\n * import { setConversationId } from '@15gifts/sdk'\n *\n * setConversationId('ca0ab4ce-f697-41cc-8d0c-081762aace9b')\n * // The conversation ID 'ca0ab4ce-f697-41cc-8d0c-081762aace9b' will be stored.\n * ```\n */\nexport const setConversationId = (conversationId: string) => sessionStorage.setItem(CONVERSATION_ID, conversationId)\n","/**\n * The key used to store the session ID in `sessionStorage`.\n *\n * @ignore\n */\nexport const SESSION_ID = '__15gifts_session_id'\n\n/**\n * Retrieves the session ID from `sessionStorage`.\n *\n * @example\n * ```ts\n * import { getSessionId } from '@15gifts/sdk'\n *\n * const sessionId = getSessionId()\n *\n * if (sessionId) {\n * console.log(`Session ID: ${sessionId}`)\n * } else {\n * console.log('No session ID found.')\n * }\n * ```\n */\nexport const getSessionId = () => sessionStorage.getItem(SESSION_ID)\n\n/**\n * Stores the given session ID in `sessionStorage`.\n *\n * @example\n * ```ts\n * import { setSessionId } from '@15gifts/sdk'\n *\n * setSessionId('20b2bff6-64a0-4101-bed9-ff545326584a')\n * // The session ID '20b2bff6-64a0-4101-bed9-ff545326584a' will be stored.\n * ```\n */\nexport const setSessionId = (sessionId: string) => sessionStorage.setItem(SESSION_ID, sessionId)\n","const getItemWithExpiry = (key: string) => {\n const itemString = localStorage.getItem(key)\n\n if (!itemString) return null\n\n const item = JSON.parse(itemString) as { expires: number; value: string }\n\n if (Date.now() > item.expires) {\n localStorage.removeItem(key)\n\n return null\n }\n\n return item.value\n}\n\nexport default getItemWithExpiry\n","/**\n * Set an item in localStorage with an expiration time\n * @param key The key under which the value is stored in localStorage\n * @param value The value to be stored\n * @param ttl The time-to-live (TTL) in milliseconds\n */\nconst setItemWithExpiry = (key: string, value: string, ttl: number) => {\n const item = {\n expires: Date.now() + ttl,\n value,\n }\n\n localStorage.setItem(key, JSON.stringify(item))\n}\n\nexport default setItemWithExpiry\n","import { getItemWithExpiry, setItemWithExpiry } from '../utils'\nconst day = 1000 * 60 * 60 * 24\n\n/**\n * The key used to store the user ID in `localStorage`.\n *\n * @ignore\n */\nexport const USER_ID = '__15gifts_user_id'\n\n/**\n * Time-to-live (TTL) for the user ID in milliseconds.\n * Set to 30 days.\n *\n * @ignore\n */\nexport const TTL = day * 30\n\n/**\n * Retrieves the user ID from `localStorage` and updates its expiry time.\n *\n * @example\n * ```ts\n * import { getUserId } from '@15gifts/sdk'\n *\n * const userId = getUserId()\n *\n * if (userId) {\n * console.log(`User ID: ${userId}`)\n * } else {\n * console.log('No user ID found.')\n * }\n * ```\n */\nexport const getUserId = () => {\n const userId = getItemWithExpiry(USER_ID)\n\n // Update the userId with a new expiry time\n // So that it will be valid for another 30 days, rather than 30 days from when it was first set\n if (userId) {\n setUserId(userId)\n }\n\n return userId\n}\n\n/**\n * Stores the given user ID in `localStorage`.\n *\n * @example\n * ```ts\n * import { setUserId } from '@15gifts/sdk'\n *\n * setUserId('5b77656c-ea4c-492f-82bf-7129297c5873')\n * // The user ID '5b77656c-ea4c-492f-82bf-7129297c5873' will be stored with a 30-day expiry.\n * ```\n */\nexport const setUserId = (userId: string) => setItemWithExpiry(USER_ID, userId, TTL)\n","/**\n * The key used to store the JWT in `localStorage`.\n *\n * @ignore\n */\nexport const JWT_TOKEN = '__15gifts_identity_token'\n\n/**\n * Checks if the JWT is expired.\n *\n * @param {string} token - the JWT.\n * @returns {boolean} `true` if expired, `false` otherwise.\n */\nexport const isTokenExpired = (token: string): boolean => {\n try {\n const [, payloadBase64] = token.split('.')\n if (!payloadBase64) {\n throw new Error('Invalid token payload')\n }\n const payload = JSON.parse(atob(payloadBase64))\n\n return payload.exp && Date.now() / 1000 > payload.exp\n } catch (error) {\n console.error('Invalid token format', error)\n return true\n }\n}\n\n/**\n * Retrieves the JWT from `localStorage` and checks if it is expired.\n *\n * @returns {string | null} The JWT if valid, otherwise `null`.\n */\nexport const getToken = (): string | null => {\n const token = localStorage.getItem(JWT_TOKEN)\n\n if (!token || isTokenExpired(token)) {\n localStorage.removeItem(JWT_TOKEN)\n return null\n }\n\n return token\n}\n\n/**\n * Stores the given JWT in `localStorage`.\n *\n * @example\n * ```ts\n * import { setToken } from '@15gifts/sdk'\n *\n * setToken('ey...')\n * ```\n */\nexport const setToken = (token: string) => localStorage.setItem(JWT_TOKEN, token)\n","import type { Middleware } from 'openapi-fetch'\n\n/**\n * Middleware for adding an `Authorization` header to requests.\n *\n * @param accessToken - The token to be included in the `Authorization` header.\n * @returns A middleware object that attaches the access token to the request headers.\n *\n * @example\n * ```ts\n * import { authMiddleware } from '@15gifts/sdk';\n *\n * this.endpoint.conversation.use(authMiddleware(accessToken))\n * ```\n */\nconst authMiddleware = (accessToken?: string): Middleware => ({\n onRequest: async ({ request }) => {\n const isIdentityEndpoint = request.url.includes('/identity/')\n if (isIdentityEndpoint) {\n return request\n }\n\n // Throw an error because we know the API will return a 401 if the access token is not set.\n if (!accessToken) {\n throw new Error('Access token is required for authentication.')\n }\n\n request.headers.set('Authorization', `Bearer ${accessToken}`)\n\n return request\n },\n})\n\nexport default authMiddleware\n","import type { Middleware } from 'openapi-fetch'\n\n/**\n * Middleware for handling errors.\n *\n * @returns A middleware object that throws an error if the response is not ok.\n *\n * @example\n * ```ts\n * import { errorMiddleware } from '@15gifts/sdk';\n *\n * this.endpoint.conversation.use(errorMiddleware())\n * ```\n */\nconst errorMiddleware: Middleware = {\n // onError does not handle error responses with 4xx or 5xx HTTP status codes, since these are considered \"successful\" responses but with a bad status code.\n // In these cases we need to check the response's status property or ok() method via the onResponse callback.\n onResponse: async ({ response }) => {\n if (!response.ok) {\n const data = await response.json()\n\n throw new Error(data.message)\n }\n\n return response\n },\n}\n\nexport default errorMiddleware\n","import type { Middleware } from 'openapi-fetch'\n\nimport { Identity } from '../types'\n\n/**\n * Middleware for adding request headers that other services use for tracking.\n *\n * @returns A middleware object that throws an error if the response is not ok.\n *\n * @example\n * ```ts\n * import { pageViewId } from '@15gifts/sdk';\n *\n * this.endpoint.conversation.use(headerMiddleware('123', 'https://example.com'))\n * ```\n */\nconst headerMiddleware = (identity: Identity, url: string): Middleware => ({\n onRequest: async ({ request }) => {\n if (identity.pageviewId) {\n request.headers.set('X-PAGEVIEW-ID', identity.pageviewId)\n }\n if (url) {\n request.headers.set('X-PAGE-URL', url)\n }\n\n return request\n },\n})\n\nexport default headerMiddleware\n","{\n \"name\": \"@15gifts/sdk\",\n \"version\": \"0.14.0\",\n \"files\": [\n \"dist\"\n ],\n \"main\": \"./dist/index.js\",\n \"module\": \"./dist/index.mjs\",\n \"types\": \"./dist/index.d.ts\",\n \"scripts\": {\n \"build\": \"npm run generate && tsup\",\n \"coverage\": \"vitest run --coverage\",\n \"dev\": \"tsup --watch\",\n \"format\": \"prettier . --write\",\n \"generate\": \"npx openapi-typescript\",\n \"lint\": \"eslint .\",\n \"test\": \"vitest run\",\n \"test:watch\": \"vitest\",\n \"typecheck\": \"tsc\"\n },\n \"dependencies\": {\n \"openapi-fetch\": \"^0.13.4\"\n },\n \"devDependencies\": {\n \"openapi-typescript\": \"^7.6.0\",\n \"tsup\": \"^8.3.6\"\n },\n \"sideEffects\": false,\n \"prettier\": \"prettier-config-custom\"\n}\n"],"mappings":"AAAA,OAAOA,MAA0C,gBCK1C,IAAMC,EAAkB,4BAalBC,EAAuB,IAAM,eAAe,WAAWD,CAAe,EAkBtEE,EAAoB,IAAM,eAAe,QAAQF,CAAe,EAahEG,EAAqBC,GAA2B,eAAe,QAAQJ,EAAiBI,CAAc,EC5C5G,IAAMC,EAAa,uBAkBbC,EAAe,IAAM,eAAe,QAAQD,CAAU,EAatDE,EAAgBC,GAAsB,eAAe,QAAQH,EAAYG,CAAS,ECpC/F,IAAMC,EAAqBC,GAAgB,CACzC,IAAMC,EAAa,aAAa,QAAQD,CAAG,EAE3C,GAAI,CAACC,EAAY,OAAO,KAExB,IAAMC,EAAO,KAAK,MAAMD,CAAU,EAElC,OAAI,KAAK,IAAI,EAAIC,EAAK,SACpB,aAAa,WAAWF,CAAG,EAEpB,MAGFE,EAAK,KACd,EAEOC,EAAQJ,ECVf,IAAMK,EAAoB,CAACC,EAAaC,EAAeC,IAAgB,CACrE,IAAMC,EAAO,CACX,QAAS,KAAK,IAAI,EAAID,EACtB,MAAAD,CACF,EAEA,aAAa,QAAQD,EAAK,KAAK,UAAUG,CAAI,CAAC,CAChD,EAEOC,EAAQL,ECdf,IAAMM,EAAM,IAAO,GAAK,GAAK,GAOhBC,EAAU,oBAQVC,EAAMF,EAAM,GAkBZG,EAAY,IAAM,CAC7B,IAAMC,EAASC,EAAkBJ,CAAO,EAIxC,OAAIG,GACFE,EAAUF,CAAM,EAGXA,CACT,EAaaE,EAAaF,GAAmBG,EAAkBN,EAASG,EAAQF,CAAG,ECpD5E,IAAMM,EAAY,2BAQZC,EAAkBC,GAA2B,CACxD,GAAI,CACF,GAAM,CAAC,CAAEC,CAAa,EAAID,EAAM,MAAM,GAAG,EACzC,GAAI,CAACC,EACH,MAAM,IAAI,MAAM,uBAAuB,EAEzC,IAAMC,EAAU,KAAK,MAAM,KAAKD,CAAa,CAAC,EAE9C,OAAOC,EAAQ,KAAO,KAAK,IAAI,EAAI,IAAOA,EAAQ,GACpD,OAASC,EAAO,CACd,eAAQ,MAAM,uBAAwBA,CAAK,EACpC,EACT,CACF,EAOaC,EAAW,IAAqB,CAC3C,IAAMJ,EAAQ,aAAa,QAAQF,CAAS,EAE5C,MAAI,CAACE,GAASD,EAAeC,CAAK,GAChC,aAAa,WAAWF,CAAS,EAC1B,MAGFE,CACT,EAYaK,EAAYL,GAAkB,aAAa,QAAQF,EAAWE,CAAK,ECvChF,IAAMM,EAAkBC,IAAsC,CAC5D,UAAW,MAAO,CAAE,QAAAC,CAAQ,IAAM,CAEhC,GAD2BA,EAAQ,IAAI,SAAS,YAAY,EAE1D,OAAOA,EAIT,GAAI,CAACD,EACH,MAAM,IAAI,MAAM,8CAA8C,EAGhE,OAAAC,EAAQ,QAAQ,IAAI,gBAAiB,UAAUD,CAAW,EAAE,EAErDC,CACT,CACF,GAEOC,EAAQH,ECnBf,IAAMI,EAA8B,CAGlC,WAAY,MAAO,CAAE,SAAAC,CAAS,IAAM,CAClC,GAAI,CAACA,EAAS,GAAI,CAChB,IAAMC,EAAO,MAAMD,EAAS,KAAK,EAEjC,MAAM,IAAI,MAAMC,EAAK,OAAO,CAC9B,CAEA,OAAOD,CACT,CACF,EAEOE,EAAQH,ECZf,IAAMI,EAAmB,CAACC,EAAoBC,KAA6B,CACzE,UAAW,MAAO,CAAE,QAAAC,CAAQ,KACtBF,EAAS,YACXE,EAAQ,QAAQ,IAAI,gBAAiBF,EAAS,UAAU,EAEtDC,GACFC,EAAQ,QAAQ,IAAI,aAAcD,CAAG,EAGhCC,EAEX,GAEOC,EAAQJ,EC3Bb,IAAAK,EAAW,SVoBN,IAAMC,EAAN,KAAa,CAUlB,SAKA,SAYA,YAAYC,EAAgB,CAC1B,GAAM,CAAE,gBAAAC,EAAiB,WAAAC,EAAY,MAAAC,EAAO,YAAAC,EAAa,QAASC,CAAe,EAAIL,EAE/EM,EAAoC,CACxC,GAAGD,EACH,gBAAiBE,CACnB,EAEA,KAAK,SAAW,CACd,aAAcC,EAAgC,CAC5C,QAASP,EACT,MAAAE,EACA,QAAAG,EACA,YAAa,SACf,CAAC,EACD,SAAUE,EAA4B,CAAE,QAASJ,EAAa,MAAAD,EAAO,QAAAG,CAAQ,CAAC,CAChF,EAEA,KAAK,SAAW,CACd,WAAAJ,EACA,eAAgBO,EAAkB,GAAK,OACvC,UAAWC,EAAa,GAAK,OAC7B,OAAQC,EAAU,GAAK,MACzB,EAEA,KAAK,SAAS,aAAa,IAAIC,CAAe,EAC9C,KAAK,SAAS,aAAa,IAAIC,EAAiB,KAAK,SAAU,OAAO,SAAS,IAAI,CAAC,CACtF,CAeA,MAAM,gBAAgC,CACpC,GAAM,CAAE,WAAAX,EAAY,UAAAY,EAAW,OAAAC,CAAO,EAAI,KAAK,SAE/C,GAAI,CACF,GAAM,CAAE,KAAAC,CAAK,EAAI,MAAM,KAAK,SAAS,SAAS,KAAK,4BAA6B,CAC9E,KAAM,CACJ,WAAAd,EACA,UAAAY,EACA,OAAAC,EACA,IAAK,OAAO,SAAS,KACrB,UAAW,OAAO,UAAU,SAC9B,CACF,CAAC,EAED,GAAI,CAACC,EACH,MAAM,IAAI,MAAM,yCAAyC,EAG3D,KAAK,SAAS,WAAaA,EAAK,WAE3BF,IACH,KAAK,SAAS,UAAYE,EAAK,UAC/BC,EAAaD,EAAK,SAAS,GAExBD,IACH,KAAK,SAAS,OAASC,EAAK,OAC5BE,EAAUF,EAAK,MAAM,GAGvBG,EAASH,EAAK,KAAK,EAGnB,OAAO,OAAO,KAAK,QAAQ,EAAE,QAASI,GAAa,CACjDA,EAAS,IAAIC,EAAeL,EAAK,KAAK,CAAC,CACzC,CAAC,CACH,OAASM,EAAO,CAGd,aAAO,OAAO,KAAK,QAAQ,EAAE,QAASF,GAAa,CACjDA,EAAS,IAAIC,EAAe,CAAC,CAC/B,CAAC,EACK,IAAI,MAAM,qDAAsD,CAAE,MAAOC,CAAM,CAAC,CACxF,CACF,CAWA,iBAAwB,CACtBC,EAAqB,EACrB,KAAK,SAAS,eAAiB,MACjC,CA0BA,MAAM,kBAAkBC,EAA0F,CAChH,KAAK,gBAAgB,EAErB,IAAMC,EAAsB,CAC1B,GAAGD,CACL,EAEM,CAAE,KAAAR,CAAK,EAAI,MAAM,KAAK,SAAS,aAAa,KAAK,uBAAwB,CAC7E,KAAM,CACJ,KAAM,qBACN,oBAAAS,CACF,CACF,CAAC,EAED,GAAI,CAACT,EAAM,OAEX,GAAM,CAACU,EAAuBC,CAAc,EAAIX,EAE1CY,EAAiBF,EAAsB,eAC7C,GAAI,CAACE,EACH,MAAM,IAAI,MAAM,8BAA8B,EAGhD,OAAAC,EAAkBD,CAAc,EAChC,KAAK,SAAS,eAAiBA,EAExBD,CACT,CAqBA,MAAM,YAAY,CAChB,YAAAG,CACF,EAEmE,CACjE,GAAM,CAAE,KAAAd,CAAK,EAAI,MAAM,KAAK,SAAS,aAAa,KAAK,uBAAwB,CAC7E,KAAM,CACJ,eAAgB,KAAK,SAAS,eAC9B,YAAAc,EACA,KAAM,SACR,CACF,CAAC,EAED,GAAI,CAACd,EAAM,OAGX,IAAMY,EAAiBZ,EAAK,KAAMe,GAAYA,EAAQ,OAAS,iBAAiB,GAAG,eACnF,OAAIH,IACFC,EAAkBD,CAAc,EAChC,KAAK,SAAS,eAAiBA,GAGhBZ,EAAK,OAAQe,GAAYA,EAAQ,OAAS,iBAAiB,CAE9E,CAcA,MAAM,WAAWC,EAAuCC,EAAoD,CAC1G,IAAMC,EAAsB,CAC1B,qBAAsBD,EACtB,eAAgB,KAAK,SAAS,eAC9B,UAAAD,EACA,WAAY,KAAK,SAAS,YAAc,UACxC,YAAa,OAAO,OAAO,MAC3B,aAAc,OAAO,OAAO,OAC5B,WAAY,OAAO,OAAO,OAAS,IAAM,SAAW,QACpD,IAAK,OAAO,SAAS,KACrB,UAAW,OAAO,UAAU,SAC9B,EAEA,OAAO,KAAK,SAAS,SAAS,KAAK,wBAAyB,CAC1D,KAAAE,CACF,CAAC,CACH,CAaA,aAAwB,CACtB,OAAO,KAAK,QACd,CAaA,kBAAkC,CAChC,OAAOC,EAAS,CAClB,CACF","names":["createClient","CONVERSATION_ID","deleteConversationId","getConversationId","setConversationId","conversationId","SESSION_ID","getSessionId","setSessionId","sessionId","getItemWithExpiry","key","itemString","item","getItemWithExpiry_default","setItemWithExpiry","key","value","ttl","item","setItemWithExpiry_default","day","USER_ID","TTL","getUserId","userId","getItemWithExpiry_default","setUserId","setItemWithExpiry_default","JWT_TOKEN","isTokenExpired","token","payloadBase64","payload","error","getToken","setToken","authMiddleware","accessToken","request","auth_default","errorMiddleware","response","data","error_default","headerMiddleware","identity","url","request","headers_default","version","Client","config","conversationUrl","customerId","fetch","frontendUrl","defaultHeaders","headers","version","createClient","getConversationId","getSessionId","getUserId","error_default","headers_default","sessionId","userId","data","setSessionId","setUserId","setToken","endpoint","auth_default","error","deleteConversationId","context","conversationContext","conversationIdMessage","openingMessage","conversationId","setConversationId","userMessage","message","eventName","properties","body","getToken"]}
|
|
1
|
+
{"version":3,"sources":["../src/client.ts","../src/identity/conversationId.ts","../src/identity/sessionId.ts","../src/utils/getItemWithExpiry.ts","../src/utils/setItemWithExpiry.ts","../src/identity/userId.ts","../src/identity/token.ts","../src/middlewares/auth.ts","../src/middlewares/error.ts","../src/middlewares/headers.ts","../package.json"],"sourcesContent":["import createClient, { type ClientOptions } from 'openapi-fetch'\n\nimport {\n deleteConversationId,\n getConversationId,\n getSessionId,\n getUserId,\n getToken,\n setConversationId,\n setSessionId,\n setUserId,\n setToken,\n} from './identity'\nimport { authMiddleware, errorMiddleware, headerMiddleware } from './middlewares'\nimport type { components, paths as conversationPaths } from './schemas/conversation'\nimport type { paths as frontendPaths } from './schemas/frontend'\nimport type { Config, ConversationIdMessage, Endpoint, Identity, Message, TextMessage, TrackingEvent } from './types'\nimport { version } from '../package.json'\n\n/**\n * The `Client` class provides methods to manage 15gifts API.\n */\nexport class Client {\n /**\n * This can be used to interact with the APIs directly. It is recommended to use the [helper methods](/sdk/sdk-reference/classes/client/#methods) provided by the `Client` class instead.\n *\n * @example\n * ```ts\n * const client = new Client({ customerId: 'YOUR_CUSTOMER_ID' })\n * const { data } = await client.endpoint.conversation.POST('/api/conversation/v3')\n * ```\n */\n endpoint: Endpoint\n\n /**\n * The identity information.\n */\n identity: Identity\n\n /**\n * Creates a new instance of the `Client` class.\n *\n * @param config - Configuration options for initializing the client.\n *\n * @example\n * ```ts\n * const client = new Client({ customerId: 'YOUR_CUSTOMER_ID' })\n * ```\n */\n constructor(config: Config) {\n const { conversationUrl, customerId, fetch, frontendUrl, headers: defaultHeaders } = config\n\n const headers: ClientOptions['headers'] = {\n ...defaultHeaders,\n 'X-SDK-VERSION': version,\n }\n\n this.endpoint = {\n conversation: createClient<conversationPaths>({\n baseUrl: conversationUrl,\n fetch,\n headers,\n credentials: 'include',\n }),\n frontend: createClient<frontendPaths>({ baseUrl: frontendUrl, fetch, headers }),\n }\n\n this.identity = {\n customerId,\n conversationId: getConversationId() ?? undefined,\n sessionId: getSessionId() ?? undefined,\n userId: getUserId() ?? undefined,\n }\n\n this.endpoint.conversation.use(errorMiddleware)\n this.endpoint.conversation.use(headerMiddleware(this.identity, window.location.href))\n }\n\n /**\n * Creates a new identity for the user by generating a session ID and user ID if they don't exist, and sets the access token for future API calls.\n * Ends the current conversation if a conversation ID is present before sending a request to update identity.\n * This should not be called more than once per page load.\n *\n * @returns A promise that resolves once the identity is created and the access token is set.\n *\n * @example\n * ```ts\n * await client.createIdentity()\n * console.log('Identity created:', client.identity)\n * ```\n */\n async createIdentity(): Promise<void> {\n const { customerId, sessionId, userId } = this.identity\n\n try {\n const { data } = await this.endpoint.frontend.POST('/api/tracking/identity/v2', {\n body: {\n customerId,\n sessionId,\n userId,\n url: window.location.href,\n userAgent: window.navigator.userAgent,\n },\n })\n\n if (!data) {\n throw new Error('No data received when creating identity')\n }\n\n this.identity.pageviewId = data.pageviewId\n\n if (!sessionId) {\n this.identity.sessionId = data.sessionId\n setSessionId(data.sessionId)\n }\n if (!userId) {\n this.identity.userId = data.userId\n setUserId(data.userId)\n }\n\n setToken(data.token)\n\n // Add the access token to the Authorization header for all endpoints\n Object.values(this.endpoint).forEach((endpoint) => {\n endpoint.use(authMiddleware(data.token))\n })\n } catch (error) {\n // Enable the auth middleware without a token so that it will throw an error before sending\n // the request, preventing unnecessary API calls / 401 responses.\n Object.values(this.endpoint).forEach((endpoint) => {\n endpoint.use(authMiddleware())\n })\n throw new Error('Failed to create identity. Please try again later.', { cause: error })\n }\n }\n\n /**\n * Ends the current conversation by deleting the conversation ID.\n *\n * @example\n * ```ts\n * client.endConversation()\n * console.log('Conversation ended')\n * ```\n */\n endConversation(): void {\n deleteConversationId()\n this.identity.conversationId = undefined\n }\n\n /**\n * Clears the existing conversation ID, then generates a new one and returns the opening message.\n *\n * @param context - Optional context to customize the conversation. It can include:\n * @param context.eligibleProducts An array of eligible product IDs.\n * @param context.eligibleBundles An array of eligible bundle IDs.\n * @param context.productOverrides Overrides for product details.\n * @param context.bundleOverrides Overrides for bundle details.\n *\n * @returns A promise that resolves to the opening message.\n *\n * @example\n * ##### Basic usage\n * ```ts\n * const openingMessage = await client.startConversation()\n * console.log('Opening message:', openingMessage)\n * ```\n *\n * ##### With context\n * ```ts\n * const openingMessage = await client.startConversation({ eligibleProducts: ['product-1', 'product-2'], productOverrides: { 'product-1': { price: 40 } })\n * console.log('Opening message:', openingMessage)\n * ```\n */\n async startConversation(context?: components['schemas']['ConversationContext']): Promise<TextMessage | undefined> {\n this.endConversation()\n\n const conversationContext = {\n ...context,\n }\n\n const { data } = await this.endpoint.conversation.POST(`/api/conversation/v3`, {\n body: {\n type: 'START_CONVERSATION',\n conversationContext,\n },\n })\n\n if (!data) return undefined\n\n const [conversationIdMessage, openingMessage] = data as [ConversationIdMessage, TextMessage]\n\n const conversationId = conversationIdMessage.conversationId\n if (!conversationId) {\n throw new Error('Conversation ID not received')\n }\n\n setConversationId(conversationId)\n this.identity.conversationId = conversationId\n\n return openingMessage\n }\n\n /**\n * Sends a message in the conversation.\n *\n * @param options - An object containing the user message.\n * @returns A promise that resolves to an array of messages\n *\n * @example\n * ```ts\n * const newMessages = await client.sendMessage({\n * userMessage: 'How can I get support?',\n * })\n *\n * if (newMessages) {\n * console.log('Received messages:', newMessages)\n * } else {\n * console.log('No message received')\n * }\n * ```\n */\n async sendMessage({\n userMessage,\n }: {\n userMessage: string\n }): Promise<Exclude<Message, ConversationIdMessage>[] | undefined> {\n const { data } = await this.endpoint.conversation.POST('/api/conversation/v3', {\n body: {\n conversationId: this.identity.conversationId,\n userMessage,\n type: 'MESSAGE',\n },\n })\n\n if (!data) return undefined\n\n // When a request does not contain a conversation ID, the API will return a new conversation ID as the first message\n const conversationId = data.find((message) => message.type === 'CONVERSATION_ID')?.conversationId\n if (conversationId) {\n setConversationId(conversationId)\n this.identity.conversationId = conversationId\n }\n\n const messages = data.filter((message) => message.type !== 'CONVERSATION_ID')\n return messages\n }\n\n /**\n * Sends an event to the tracking API, with the required properties already set.\n *\n * @param eventName - The name of the event to track.\n * @param properties - Additional properties to include in the event.\n * @returns A promise that resolves once the event is tracked.\n *\n * @example\n * ```ts\n * await client.trackEvent('entry_point-shown')\n * ```\n */\n async trackEvent(eventName: TrackingEvent['eventName'], properties?: TrackingEvent['additionalProperties']) {\n const body: TrackingEvent = {\n additionalProperties: properties,\n conversationId: this.identity.conversationId,\n eventName,\n pageviewId: this.identity.pageviewId ?? 'unknown',\n screenWidth: window.screen.width,\n screenHeight: window.screen.height,\n screenSize: window.screen.width <= 480 ? 'mobile' : 'large',\n url: window.location.href,\n userAgent: window.navigator.userAgent,\n }\n\n return this.endpoint.frontend.POST('/api/tracking/user/v2', {\n body,\n })\n }\n\n /**\n * Gets an existing identity of the user.\n *\n * @returns An Identity object containing `customerId`, `conversationId`, `sessionId`, `userId`.\n *\n * @example\n * ```ts\n * identity = client.getIdentity()\n * console.log('Identity retrieved:', identity)\n * ```\n */\n getIdentity(): Identity {\n return this.identity\n }\n\n /**\n * Gets the JWT from the localStorage.\n *\n * @returns {string | null} the JWT.\n *\n * @example\n * ```ts\n * token = client.getIdentityToken()\n * console.log('Identity token retrieved:', token)\n * ```\n */\n getIdentityToken(): string | null {\n return getToken()\n }\n}\n","/**\n * The key used to store the conversation ID in `sessionStorage`.\n *\n * @ignore\n */\nexport const CONVERSATION_ID = '__15gifts_conversation_id'\n\n/**\n * Deletes the conversation ID from `sessionStorage`.\n *\n * @example\n * ```ts\n * import { deleteConversationId } from '@15gifts/sdk'\n *\n * deleteConversationId()\n * // The conversation ID will be removed.\n * ```\n */\nexport const deleteConversationId = () => sessionStorage.removeItem(CONVERSATION_ID)\n\n/**\n * Retrieves the conversation ID from `sessionStorage`.\n *\n * @example\n * ```ts\n * import { getConversationId } from '@15gifts/sdk'\n *\n * const conversationId = getConversationId()\n *\n * if (conversationId) {\n * console.log(`Conversation ID: ${conversationId}`)\n * } else {\n * console.log('No conversation ID found.')\n * }\n * ```\n */\nexport const getConversationId = () => sessionStorage.getItem(CONVERSATION_ID)\n\n/**\n * Stores the given conversation ID in `sessionStorage`.\n *\n * @example\n * ```ts\n * import { setConversationId } from '@15gifts/sdk'\n *\n * setConversationId('ca0ab4ce-f697-41cc-8d0c-081762aace9b')\n * // The conversation ID 'ca0ab4ce-f697-41cc-8d0c-081762aace9b' will be stored.\n * ```\n */\nexport const setConversationId = (conversationId: string) => sessionStorage.setItem(CONVERSATION_ID, conversationId)\n","/**\n * The key used to store the session ID in `sessionStorage`.\n *\n * @ignore\n */\nexport const SESSION_ID = '__15gifts_session_id'\n\n/**\n * Retrieves the session ID from `sessionStorage`.\n *\n * @example\n * ```ts\n * import { getSessionId } from '@15gifts/sdk'\n *\n * const sessionId = getSessionId()\n *\n * if (sessionId) {\n * console.log(`Session ID: ${sessionId}`)\n * } else {\n * console.log('No session ID found.')\n * }\n * ```\n */\nexport const getSessionId = () => sessionStorage.getItem(SESSION_ID)\n\n/**\n * Stores the given session ID in `sessionStorage`.\n *\n * @example\n * ```ts\n * import { setSessionId } from '@15gifts/sdk'\n *\n * setSessionId('20b2bff6-64a0-4101-bed9-ff545326584a')\n * // The session ID '20b2bff6-64a0-4101-bed9-ff545326584a' will be stored.\n * ```\n */\nexport const setSessionId = (sessionId: string) => sessionStorage.setItem(SESSION_ID, sessionId)\n","const getItemWithExpiry = (key: string) => {\n const itemString = localStorage.getItem(key)\n\n if (!itemString) return null\n\n const item = JSON.parse(itemString) as { expires: number; value: string }\n\n if (Date.now() > item.expires) {\n localStorage.removeItem(key)\n\n return null\n }\n\n return item.value\n}\n\nexport default getItemWithExpiry\n","/**\n * Set an item in localStorage with an expiration time\n * @param key The key under which the value is stored in localStorage\n * @param value The value to be stored\n * @param ttl The time-to-live (TTL) in milliseconds\n */\nconst setItemWithExpiry = (key: string, value: string, ttl: number) => {\n const item = {\n expires: Date.now() + ttl,\n value,\n }\n\n localStorage.setItem(key, JSON.stringify(item))\n}\n\nexport default setItemWithExpiry\n","import { getItemWithExpiry, setItemWithExpiry } from '../utils'\nconst day = 1000 * 60 * 60 * 24\n\n/**\n * The key used to store the user ID in `localStorage`.\n *\n * @ignore\n */\nexport const USER_ID = '__15gifts_user_id'\n\n/**\n * Time-to-live (TTL) for the user ID in milliseconds.\n * Set to 30 days.\n *\n * @ignore\n */\nexport const TTL = day * 30\n\n/**\n * Retrieves the user ID from `localStorage` and updates its expiry time.\n *\n * @example\n * ```ts\n * import { getUserId } from '@15gifts/sdk'\n *\n * const userId = getUserId()\n *\n * if (userId) {\n * console.log(`User ID: ${userId}`)\n * } else {\n * console.log('No user ID found.')\n * }\n * ```\n */\nexport const getUserId = () => {\n const userId = getItemWithExpiry(USER_ID)\n\n // Update the userId with a new expiry time\n // So that it will be valid for another 30 days, rather than 30 days from when it was first set\n if (userId) {\n setUserId(userId)\n }\n\n return userId\n}\n\n/**\n * Stores the given user ID in `localStorage`.\n *\n * @example\n * ```ts\n * import { setUserId } from '@15gifts/sdk'\n *\n * setUserId('5b77656c-ea4c-492f-82bf-7129297c5873')\n * // The user ID '5b77656c-ea4c-492f-82bf-7129297c5873' will be stored with a 30-day expiry.\n * ```\n */\nexport const setUserId = (userId: string) => setItemWithExpiry(USER_ID, userId, TTL)\n","/**\n * The key used to store the JWT in `localStorage`.\n *\n * @ignore\n */\nexport const JWT_TOKEN = '__15gifts_identity_token'\n\n/**\n * Checks if the JWT is expired.\n *\n * @param {string} token - the JWT.\n * @returns {boolean} `true` if expired, `false` otherwise.\n */\nexport const isTokenExpired = (token: string): boolean => {\n try {\n const [, payloadBase64] = token.split('.')\n if (!payloadBase64) {\n throw new Error('Invalid token payload')\n }\n const payload = JSON.parse(atob(payloadBase64))\n\n return payload.exp && Date.now() / 1000 > payload.exp\n } catch (error) {\n console.error('Invalid token format', error)\n return true\n }\n}\n\n/**\n * Retrieves the JWT from `localStorage` and checks if it is expired.\n *\n * @returns {string | null} The JWT if valid, otherwise `null`.\n */\nexport const getToken = (): string | null => {\n const token = localStorage.getItem(JWT_TOKEN)\n\n if (!token || isTokenExpired(token)) {\n localStorage.removeItem(JWT_TOKEN)\n return null\n }\n\n return token\n}\n\n/**\n * Stores the given JWT in `localStorage`.\n *\n * @example\n * ```ts\n * import { setToken } from '@15gifts/sdk'\n *\n * setToken('ey...')\n * ```\n */\nexport const setToken = (token: string) => localStorage.setItem(JWT_TOKEN, token)\n","import type { Middleware } from 'openapi-fetch'\n\n/**\n * Middleware for adding an `Authorization` header to requests.\n *\n * @param accessToken - The token to be included in the `Authorization` header.\n * @returns A middleware object that attaches the access token to the request headers.\n *\n * @example\n * ```ts\n * import { authMiddleware } from '@15gifts/sdk';\n *\n * this.endpoint.conversation.use(authMiddleware(accessToken))\n * ```\n */\nconst authMiddleware = (accessToken?: string): Middleware => ({\n onRequest: async ({ request }) => {\n const isIdentityEndpoint = request.url.includes('/identity/')\n if (isIdentityEndpoint) {\n return request\n }\n\n // Throw an error because we know the API will return a 401 if the access token is not set.\n if (!accessToken) {\n throw new Error('Access token is required for authentication.')\n }\n\n request.headers.set('Authorization', `Bearer ${accessToken}`)\n\n return request\n },\n})\n\nexport default authMiddleware\n","import type { Middleware } from 'openapi-fetch'\n\n/**\n * Middleware for handling errors.\n *\n * @returns A middleware object that throws an error if the response is not ok.\n *\n * @example\n * ```ts\n * import { errorMiddleware } from '@15gifts/sdk';\n *\n * this.endpoint.conversation.use(errorMiddleware())\n * ```\n */\nconst errorMiddleware: Middleware = {\n // onError does not handle error responses with 4xx or 5xx HTTP status codes, since these are considered \"successful\" responses but with a bad status code.\n // In these cases we need to check the response's status property or ok() method via the onResponse callback.\n onResponse: async ({ response }) => {\n if (!response.ok) {\n const data = await response.json()\n\n throw new Error(data.message)\n }\n\n return response\n },\n}\n\nexport default errorMiddleware\n","import type { Middleware } from 'openapi-fetch'\n\nimport { Identity } from '../types'\n\n/**\n * Middleware for adding request headers that other services use for tracking.\n *\n * @returns A middleware object that throws an error if the response is not ok.\n *\n * @example\n * ```ts\n * import { pageViewId } from '@15gifts/sdk';\n *\n * this.endpoint.conversation.use(headerMiddleware('123', 'https://example.com'))\n * ```\n */\nconst headerMiddleware = (identity: Identity, url: string): Middleware => ({\n onRequest: async ({ request }) => {\n if (identity.pageviewId) {\n request.headers.set('X-PAGEVIEW-ID', identity.pageviewId)\n }\n if (url) {\n request.headers.set('X-PAGE-URL', url)\n }\n\n return request\n },\n})\n\nexport default headerMiddleware\n","{\n \"name\": \"@15gifts/sdk\",\n \"version\": \"0.14.1\",\n \"files\": [\n \"dist\"\n ],\n \"main\": \"./dist/index.js\",\n \"module\": \"./dist/index.mjs\",\n \"types\": \"./dist/index.d.ts\",\n \"scripts\": {\n \"build\": \"npm run generate && tsup\",\n \"coverage\": \"vitest run --coverage\",\n \"dev\": \"tsup --watch\",\n \"format\": \"prettier . --write\",\n \"generate\": \"npx openapi-typescript\",\n \"lint\": \"eslint .\",\n \"test\": \"vitest run\",\n \"test:watch\": \"vitest\",\n \"typecheck\": \"tsc\"\n },\n \"dependencies\": {\n \"openapi-fetch\": \"^0.13.4\"\n },\n \"devDependencies\": {\n \"openapi-typescript\": \"^7.6.0\",\n \"tsup\": \"^8.3.6\"\n },\n \"sideEffects\": false,\n \"prettier\": \"prettier-config-custom\"\n}\n"],"mappings":"AAAA,OAAOA,MAA0C,gBCK1C,IAAMC,EAAkB,4BAalBC,EAAuB,IAAM,eAAe,WAAWD,CAAe,EAkBtEE,EAAoB,IAAM,eAAe,QAAQF,CAAe,EAahEG,EAAqBC,GAA2B,eAAe,QAAQJ,EAAiBI,CAAc,EC5C5G,IAAMC,EAAa,uBAkBbC,EAAe,IAAM,eAAe,QAAQD,CAAU,EAatDE,EAAgBC,GAAsB,eAAe,QAAQH,EAAYG,CAAS,ECpC/F,IAAMC,EAAqBC,GAAgB,CACzC,IAAMC,EAAa,aAAa,QAAQD,CAAG,EAE3C,GAAI,CAACC,EAAY,OAAO,KAExB,IAAMC,EAAO,KAAK,MAAMD,CAAU,EAElC,OAAI,KAAK,IAAI,EAAIC,EAAK,SACpB,aAAa,WAAWF,CAAG,EAEpB,MAGFE,EAAK,KACd,EAEOC,EAAQJ,ECVf,IAAMK,EAAoB,CAACC,EAAaC,EAAeC,IAAgB,CACrE,IAAMC,EAAO,CACX,QAAS,KAAK,IAAI,EAAID,EACtB,MAAAD,CACF,EAEA,aAAa,QAAQD,EAAK,KAAK,UAAUG,CAAI,CAAC,CAChD,EAEOC,EAAQL,ECdf,IAAMM,EAAM,IAAO,GAAK,GAAK,GAOhBC,EAAU,oBAQVC,EAAMF,EAAM,GAkBZG,EAAY,IAAM,CAC7B,IAAMC,EAASC,EAAkBJ,CAAO,EAIxC,OAAIG,GACFE,EAAUF,CAAM,EAGXA,CACT,EAaaE,EAAaF,GAAmBG,EAAkBN,EAASG,EAAQF,CAAG,ECpD5E,IAAMM,EAAY,2BAQZC,EAAkBC,GAA2B,CACxD,GAAI,CACF,GAAM,CAAC,CAAEC,CAAa,EAAID,EAAM,MAAM,GAAG,EACzC,GAAI,CAACC,EACH,MAAM,IAAI,MAAM,uBAAuB,EAEzC,IAAMC,EAAU,KAAK,MAAM,KAAKD,CAAa,CAAC,EAE9C,OAAOC,EAAQ,KAAO,KAAK,IAAI,EAAI,IAAOA,EAAQ,GACpD,OAASC,EAAO,CACd,eAAQ,MAAM,uBAAwBA,CAAK,EACpC,EACT,CACF,EAOaC,EAAW,IAAqB,CAC3C,IAAMJ,EAAQ,aAAa,QAAQF,CAAS,EAE5C,MAAI,CAACE,GAASD,EAAeC,CAAK,GAChC,aAAa,WAAWF,CAAS,EAC1B,MAGFE,CACT,EAYaK,EAAYL,GAAkB,aAAa,QAAQF,EAAWE,CAAK,ECvChF,IAAMM,EAAkBC,IAAsC,CAC5D,UAAW,MAAO,CAAE,QAAAC,CAAQ,IAAM,CAEhC,GAD2BA,EAAQ,IAAI,SAAS,YAAY,EAE1D,OAAOA,EAIT,GAAI,CAACD,EACH,MAAM,IAAI,MAAM,8CAA8C,EAGhE,OAAAC,EAAQ,QAAQ,IAAI,gBAAiB,UAAUD,CAAW,EAAE,EAErDC,CACT,CACF,GAEOC,EAAQH,ECnBf,IAAMI,EAA8B,CAGlC,WAAY,MAAO,CAAE,SAAAC,CAAS,IAAM,CAClC,GAAI,CAACA,EAAS,GAAI,CAChB,IAAMC,EAAO,MAAMD,EAAS,KAAK,EAEjC,MAAM,IAAI,MAAMC,EAAK,OAAO,CAC9B,CAEA,OAAOD,CACT,CACF,EAEOE,EAAQH,ECZf,IAAMI,EAAmB,CAACC,EAAoBC,KAA6B,CACzE,UAAW,MAAO,CAAE,QAAAC,CAAQ,KACtBF,EAAS,YACXE,EAAQ,QAAQ,IAAI,gBAAiBF,EAAS,UAAU,EAEtDC,GACFC,EAAQ,QAAQ,IAAI,aAAcD,CAAG,EAGhCC,EAEX,GAEOC,EAAQJ,EC3Bb,IAAAK,EAAW,SVoBN,IAAMC,EAAN,KAAa,CAUlB,SAKA,SAYA,YAAYC,EAAgB,CAC1B,GAAM,CAAE,gBAAAC,EAAiB,WAAAC,EAAY,MAAAC,EAAO,YAAAC,EAAa,QAASC,CAAe,EAAIL,EAE/EM,EAAoC,CACxC,GAAGD,EACH,gBAAiBE,CACnB,EAEA,KAAK,SAAW,CACd,aAAcC,EAAgC,CAC5C,QAASP,EACT,MAAAE,EACA,QAAAG,EACA,YAAa,SACf,CAAC,EACD,SAAUE,EAA4B,CAAE,QAASJ,EAAa,MAAAD,EAAO,QAAAG,CAAQ,CAAC,CAChF,EAEA,KAAK,SAAW,CACd,WAAAJ,EACA,eAAgBO,EAAkB,GAAK,OACvC,UAAWC,EAAa,GAAK,OAC7B,OAAQC,EAAU,GAAK,MACzB,EAEA,KAAK,SAAS,aAAa,IAAIC,CAAe,EAC9C,KAAK,SAAS,aAAa,IAAIC,EAAiB,KAAK,SAAU,OAAO,SAAS,IAAI,CAAC,CACtF,CAeA,MAAM,gBAAgC,CACpC,GAAM,CAAE,WAAAX,EAAY,UAAAY,EAAW,OAAAC,CAAO,EAAI,KAAK,SAE/C,GAAI,CACF,GAAM,CAAE,KAAAC,CAAK,EAAI,MAAM,KAAK,SAAS,SAAS,KAAK,4BAA6B,CAC9E,KAAM,CACJ,WAAAd,EACA,UAAAY,EACA,OAAAC,EACA,IAAK,OAAO,SAAS,KACrB,UAAW,OAAO,UAAU,SAC9B,CACF,CAAC,EAED,GAAI,CAACC,EACH,MAAM,IAAI,MAAM,yCAAyC,EAG3D,KAAK,SAAS,WAAaA,EAAK,WAE3BF,IACH,KAAK,SAAS,UAAYE,EAAK,UAC/BC,EAAaD,EAAK,SAAS,GAExBD,IACH,KAAK,SAAS,OAASC,EAAK,OAC5BE,EAAUF,EAAK,MAAM,GAGvBG,EAASH,EAAK,KAAK,EAGnB,OAAO,OAAO,KAAK,QAAQ,EAAE,QAASI,GAAa,CACjDA,EAAS,IAAIC,EAAeL,EAAK,KAAK,CAAC,CACzC,CAAC,CACH,OAASM,EAAO,CAGd,aAAO,OAAO,KAAK,QAAQ,EAAE,QAASF,GAAa,CACjDA,EAAS,IAAIC,EAAe,CAAC,CAC/B,CAAC,EACK,IAAI,MAAM,qDAAsD,CAAE,MAAOC,CAAM,CAAC,CACxF,CACF,CAWA,iBAAwB,CACtBC,EAAqB,EACrB,KAAK,SAAS,eAAiB,MACjC,CA0BA,MAAM,kBAAkBC,EAA0F,CAChH,KAAK,gBAAgB,EAErB,IAAMC,EAAsB,CAC1B,GAAGD,CACL,EAEM,CAAE,KAAAR,CAAK,EAAI,MAAM,KAAK,SAAS,aAAa,KAAK,uBAAwB,CAC7E,KAAM,CACJ,KAAM,qBACN,oBAAAS,CACF,CACF,CAAC,EAED,GAAI,CAACT,EAAM,OAEX,GAAM,CAACU,EAAuBC,CAAc,EAAIX,EAE1CY,EAAiBF,EAAsB,eAC7C,GAAI,CAACE,EACH,MAAM,IAAI,MAAM,8BAA8B,EAGhD,OAAAC,EAAkBD,CAAc,EAChC,KAAK,SAAS,eAAiBA,EAExBD,CACT,CAqBA,MAAM,YAAY,CAChB,YAAAG,CACF,EAEmE,CACjE,GAAM,CAAE,KAAAd,CAAK,EAAI,MAAM,KAAK,SAAS,aAAa,KAAK,uBAAwB,CAC7E,KAAM,CACJ,eAAgB,KAAK,SAAS,eAC9B,YAAAc,EACA,KAAM,SACR,CACF,CAAC,EAED,GAAI,CAACd,EAAM,OAGX,IAAMY,EAAiBZ,EAAK,KAAMe,GAAYA,EAAQ,OAAS,iBAAiB,GAAG,eACnF,OAAIH,IACFC,EAAkBD,CAAc,EAChC,KAAK,SAAS,eAAiBA,GAGhBZ,EAAK,OAAQe,GAAYA,EAAQ,OAAS,iBAAiB,CAE9E,CAcA,MAAM,WAAWC,EAAuCC,EAAoD,CAC1G,IAAMC,EAAsB,CAC1B,qBAAsBD,EACtB,eAAgB,KAAK,SAAS,eAC9B,UAAAD,EACA,WAAY,KAAK,SAAS,YAAc,UACxC,YAAa,OAAO,OAAO,MAC3B,aAAc,OAAO,OAAO,OAC5B,WAAY,OAAO,OAAO,OAAS,IAAM,SAAW,QACpD,IAAK,OAAO,SAAS,KACrB,UAAW,OAAO,UAAU,SAC9B,EAEA,OAAO,KAAK,SAAS,SAAS,KAAK,wBAAyB,CAC1D,KAAAE,CACF,CAAC,CACH,CAaA,aAAwB,CACtB,OAAO,KAAK,QACd,CAaA,kBAAkC,CAChC,OAAOC,EAAS,CAClB,CACF","names":["createClient","CONVERSATION_ID","deleteConversationId","getConversationId","setConversationId","conversationId","SESSION_ID","getSessionId","setSessionId","sessionId","getItemWithExpiry","key","itemString","item","getItemWithExpiry_default","setItemWithExpiry","key","value","ttl","item","setItemWithExpiry_default","day","USER_ID","TTL","getUserId","userId","getItemWithExpiry_default","setUserId","setItemWithExpiry_default","JWT_TOKEN","isTokenExpired","token","payloadBase64","payload","error","getToken","setToken","authMiddleware","accessToken","request","auth_default","errorMiddleware","response","data","error_default","headerMiddleware","identity","url","request","headers_default","version","Client","config","conversationUrl","customerId","fetch","frontendUrl","defaultHeaders","headers","version","createClient","getConversationId","getSessionId","getUserId","error_default","headers_default","sessionId","userId","data","setSessionId","setUserId","setToken","endpoint","auth_default","error","deleteConversationId","context","conversationContext","conversationIdMessage","openingMessage","conversationId","setConversationId","userMessage","message","eventName","properties","body","getToken"]}
|