@15gifts/sdk 0.16.8 → 0.18.0
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 +122 -34
- package/dist/index.d.ts +122 -34
- 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
|
@@ -68,7 +68,7 @@ interface components {
|
|
|
68
68
|
* Conversationsummary
|
|
69
69
|
* @description A summary of the conversation so far
|
|
70
70
|
*/
|
|
71
|
-
conversationSummary
|
|
71
|
+
conversationSummary?: string | null;
|
|
72
72
|
/** @description Why have we been exited to chat? */
|
|
73
73
|
reason: components['schemas']['ExitToHumanReason'];
|
|
74
74
|
/**
|
|
@@ -77,6 +77,12 @@ interface components {
|
|
|
77
77
|
* @default []
|
|
78
78
|
*/
|
|
79
79
|
recommendations: components['schemas']['RecommendationV2'][];
|
|
80
|
+
/**
|
|
81
|
+
* Conversationid
|
|
82
|
+
* @description The conversation id
|
|
83
|
+
* @example 15630a82-0e3d-4d1b-ab7d-fb7481a7a344
|
|
84
|
+
*/
|
|
85
|
+
conversationId?: string | null;
|
|
80
86
|
};
|
|
81
87
|
/**
|
|
82
88
|
* AssistantExitToPhoneMessage
|
|
@@ -294,6 +300,30 @@ interface components {
|
|
|
294
300
|
*/
|
|
295
301
|
message: string;
|
|
296
302
|
};
|
|
303
|
+
/**
|
|
304
|
+
* BaseSingleSelectMessage
|
|
305
|
+
* @description A message from the end user that picks a single select item
|
|
306
|
+
*/
|
|
307
|
+
BaseSingleSelectMessage: {
|
|
308
|
+
/**
|
|
309
|
+
* Type
|
|
310
|
+
* @default SINGLE_SELECT
|
|
311
|
+
* @constant
|
|
312
|
+
*/
|
|
313
|
+
type: 'SINGLE_SELECT';
|
|
314
|
+
/**
|
|
315
|
+
* Usermessage
|
|
316
|
+
* @description The user message
|
|
317
|
+
* @example Hello
|
|
318
|
+
*/
|
|
319
|
+
userMessage?: string | null;
|
|
320
|
+
/**
|
|
321
|
+
* Option
|
|
322
|
+
* @description Which select option was picked?
|
|
323
|
+
* @example 12345
|
|
324
|
+
*/
|
|
325
|
+
option?: string | null;
|
|
326
|
+
};
|
|
297
327
|
/** Bundle */
|
|
298
328
|
Bundle: {
|
|
299
329
|
/**
|
|
@@ -486,6 +516,23 @@ interface components {
|
|
|
486
516
|
* @enum {string}
|
|
487
517
|
*/
|
|
488
518
|
ExitToHumanReason: 'WANT_TO_TALK_TO_HUMAN' | 'OUT_OF_SCOPE_QUESTIONS' | 'NOT_BEHAVING_CORRECTLY';
|
|
519
|
+
/** HeaderDetails */
|
|
520
|
+
HeaderDetails: {
|
|
521
|
+
/**
|
|
522
|
+
* Title
|
|
523
|
+
* @description The title to show in the header of the recommendation card
|
|
524
|
+
*/
|
|
525
|
+
title?: string | null;
|
|
526
|
+
/**
|
|
527
|
+
* Description
|
|
528
|
+
* @description The description to show in the header of the recommendation card
|
|
529
|
+
*/
|
|
530
|
+
description?: string | null;
|
|
531
|
+
/** @description The current price of the product or bundle */
|
|
532
|
+
priceDetails?: components['schemas']['ProductPriceDetails'] | null;
|
|
533
|
+
/** @description The original price of the product or bundle, only set if it's currently discounted. */
|
|
534
|
+
previousPriceDetails?: components['schemas']['ProductPriceDetails'] | null;
|
|
535
|
+
};
|
|
489
536
|
/**
|
|
490
537
|
* Offer
|
|
491
538
|
* @description Offer details
|
|
@@ -641,6 +688,11 @@ interface components {
|
|
|
641
688
|
* @description For example, `tv`, `internet`, `phone`. It can be used to show an icon in the UI.
|
|
642
689
|
*/
|
|
643
690
|
category?: string | null;
|
|
691
|
+
/**
|
|
692
|
+
* Type
|
|
693
|
+
* @description The type of product, eg: BroadbandProduct, RouterProduct etc
|
|
694
|
+
*/
|
|
695
|
+
type?: string | null;
|
|
644
696
|
/**
|
|
645
697
|
* Extras
|
|
646
698
|
* @description Extras are additional products that are bundled with the main product.
|
|
@@ -709,6 +761,8 @@ interface components {
|
|
|
709
761
|
* @description Information to include at the bottom of the recommendation card, e.g. CPI price data
|
|
710
762
|
*/
|
|
711
763
|
importantInformation?: string | null;
|
|
764
|
+
/** @description Details to populate the header of the recommendation card */
|
|
765
|
+
header?: components['schemas']['HeaderDetails'] | null;
|
|
712
766
|
};
|
|
713
767
|
/**
|
|
714
768
|
* UserMultiSelectMessage
|
|
@@ -744,10 +798,7 @@ interface components {
|
|
|
744
798
|
*/
|
|
745
799
|
options: string[];
|
|
746
800
|
};
|
|
747
|
-
/**
|
|
748
|
-
* UserSingleSelectMessage
|
|
749
|
-
* @description A message from the end user that picks a single select item
|
|
750
|
-
*/
|
|
801
|
+
/** UserSingleSelectMessage */
|
|
751
802
|
UserSingleSelectMessage: {
|
|
752
803
|
/**
|
|
753
804
|
* Type
|
|
@@ -755,13 +806,6 @@ interface components {
|
|
|
755
806
|
* @constant
|
|
756
807
|
*/
|
|
757
808
|
type: 'SINGLE_SELECT';
|
|
758
|
-
/**
|
|
759
|
-
* Conversationid
|
|
760
|
-
* Format: uuid
|
|
761
|
-
* @description The conversation id
|
|
762
|
-
* @example 15630a82-0e3d-4d1b-ab7d-fb7481a7a344
|
|
763
|
-
*/
|
|
764
|
-
conversationId: string;
|
|
765
809
|
/**
|
|
766
810
|
* Usermessage
|
|
767
811
|
* @description The user message
|
|
@@ -774,6 +818,13 @@ interface components {
|
|
|
774
818
|
* @example 12345
|
|
775
819
|
*/
|
|
776
820
|
option?: string | null;
|
|
821
|
+
/**
|
|
822
|
+
* Conversationid
|
|
823
|
+
* Format: uuid
|
|
824
|
+
* @description The conversation id
|
|
825
|
+
* @example 15630a82-0e3d-4d1b-ab7d-fb7481a7a344
|
|
826
|
+
*/
|
|
827
|
+
conversationId: string;
|
|
777
828
|
};
|
|
778
829
|
/**
|
|
779
830
|
* UserStartConversationMessage
|
|
@@ -788,11 +839,8 @@ interface components {
|
|
|
788
839
|
type: 'START_CONVERSATION';
|
|
789
840
|
/** @description Context information we'll be getting with the request */
|
|
790
841
|
conversationContext: components['schemas']['ConversationContext'];
|
|
791
|
-
/**
|
|
792
|
-
|
|
793
|
-
* @description An optional opening message sent by the user as the very first message, for things such as UI chips in the frontend to prepopulate the conversation
|
|
794
|
-
*/
|
|
795
|
-
openingUserMessage?: components['schemas']['UserTextMessage'] | components['schemas']['UserSingleSelectMessage'] | components['schemas']['UserMultiSelectMessage'] | null;
|
|
842
|
+
/** @description An optional opening message sent by the user as the very first message, for things such as UI chips in the frontend to prepopulate the conversation */
|
|
843
|
+
openingUserMessage?: components['schemas']['BaseSingleSelectMessage'] | null;
|
|
796
844
|
};
|
|
797
845
|
/**
|
|
798
846
|
* UserTextMessage
|
|
@@ -1308,19 +1356,50 @@ declare class SDKError extends Error {
|
|
|
1308
1356
|
* These are the types as defined in the OpenAPI schema.
|
|
1309
1357
|
* We don't use them directly, or export them here because of how they appear in the documentation site.
|
|
1310
1358
|
*/
|
|
1311
|
-
type
|
|
1312
|
-
type
|
|
1313
|
-
type
|
|
1314
|
-
type
|
|
1315
|
-
|
|
1316
|
-
type
|
|
1317
|
-
type
|
|
1318
|
-
|
|
1319
|
-
type
|
|
1320
|
-
type
|
|
1321
|
-
|
|
1322
|
-
type
|
|
1323
|
-
type
|
|
1359
|
+
type ApiConversationRequest = paths$1['/api/conversation/v3']['post']['requestBody']['content']['application/json'];
|
|
1360
|
+
type ApiConversationResponse = paths$1['/api/conversation/v3']['post']['responses'][200]['content']['application/json'][number];
|
|
1361
|
+
type ApiConversationIdMessage = Extract<ApiConversationResponse, {
|
|
1362
|
+
type: 'CONVERSATION_ID';
|
|
1363
|
+
}>;
|
|
1364
|
+
type ApiExitToChatMessage = Extract<ApiConversationResponse, {
|
|
1365
|
+
type: 'EXIT_TO_CHAT';
|
|
1366
|
+
}>;
|
|
1367
|
+
type ApiExitToPhoneMessage = Extract<ApiConversationResponse, {
|
|
1368
|
+
type: 'EXIT_TO_PHONE';
|
|
1369
|
+
}>;
|
|
1370
|
+
type ApiExitToPurchaseMessage = Extract<ApiConversationResponse, {
|
|
1371
|
+
type: 'EXIT_TO_PURCHASE';
|
|
1372
|
+
}>;
|
|
1373
|
+
type ApiExitToPurchaseV2Message = Extract<ApiConversationResponse, {
|
|
1374
|
+
type: 'EXIT_TO_PURCHASE_V2';
|
|
1375
|
+
}>;
|
|
1376
|
+
type ApiMultiSelectMessage = Extract<ApiConversationResponse, {
|
|
1377
|
+
type: 'MULTI_SELECT';
|
|
1378
|
+
}>;
|
|
1379
|
+
type ApiRecommendationMessage = Extract<ApiConversationResponse, {
|
|
1380
|
+
type: 'RECOMMENDATION';
|
|
1381
|
+
}>;
|
|
1382
|
+
type ApiRecommendationV2Message = Extract<ApiConversationResponse, {
|
|
1383
|
+
type: 'RECOMMENDATION_V2';
|
|
1384
|
+
}>;
|
|
1385
|
+
type ApiSingleSelectMessage = Extract<ApiConversationResponse, {
|
|
1386
|
+
type: 'SINGLE_SELECT';
|
|
1387
|
+
}>;
|
|
1388
|
+
type ApiTextMessage = Extract<ApiConversationResponse, {
|
|
1389
|
+
type: 'MESSAGE';
|
|
1390
|
+
}>;
|
|
1391
|
+
type UserTextMessage = Extract<ApiConversationRequest, {
|
|
1392
|
+
type: 'MESSAGE';
|
|
1393
|
+
}>;
|
|
1394
|
+
type UserSingleSelectMessage = Extract<ApiConversationRequest, {
|
|
1395
|
+
type: 'SINGLE_SELECT';
|
|
1396
|
+
}>;
|
|
1397
|
+
type UserMultiSelectMessage = Extract<ApiConversationRequest, {
|
|
1398
|
+
type: 'MULTI_SELECT';
|
|
1399
|
+
}>;
|
|
1400
|
+
type UserStartConversationMessage = Extract<ApiConversationRequest, {
|
|
1401
|
+
type: 'START_CONVERSATION';
|
|
1402
|
+
}>;
|
|
1324
1403
|
type SendMessagePayload = Omit<UserTextMessage, 'conversationId'> | Omit<UserSingleSelectMessage, 'conversationId'> | Omit<UserMultiSelectMessage, 'conversationId'>;
|
|
1325
1404
|
type ApiIdentityRequest = paths['/api/tracking/identity/v2']['post']['requestBody']['content']['application/json'];
|
|
1326
1405
|
type ApiTrackingUserRequest = paths['/api/tracking/user/v2']['post']['requestBody']['content']['application/json'];
|
|
@@ -1493,7 +1572,7 @@ declare class Client {
|
|
|
1493
1572
|
* console.log('Opening message:', openingMessage)
|
|
1494
1573
|
* ```
|
|
1495
1574
|
*/
|
|
1496
|
-
startConversation(context?: components['schemas']['ConversationContext']): Promise<Message[]>;
|
|
1575
|
+
startConversation(context?: components['schemas']['ConversationContext'], userMessage?: UserStartConversationMessage['openingUserMessage']): Promise<Message[]>;
|
|
1497
1576
|
/**
|
|
1498
1577
|
* Sends a message in the conversation.
|
|
1499
1578
|
*
|
|
@@ -1516,9 +1595,10 @@ declare class Client {
|
|
|
1516
1595
|
sendMessage(payload: SendMessagePayload): Promise<({
|
|
1517
1596
|
type: "EXIT_TO_CHAT";
|
|
1518
1597
|
fallbackMessage: string;
|
|
1519
|
-
conversationSummary
|
|
1598
|
+
conversationSummary?: string | null;
|
|
1520
1599
|
reason: components["schemas"]["ExitToHumanReason"];
|
|
1521
1600
|
recommendations: components["schemas"]["RecommendationV2"][];
|
|
1601
|
+
conversationId?: string | null;
|
|
1522
1602
|
} | {
|
|
1523
1603
|
type: "EXIT_TO_PHONE";
|
|
1524
1604
|
fallbackMessage: string;
|
|
@@ -1578,7 +1658,15 @@ declare class Client {
|
|
|
1578
1658
|
trackEvent(eventName: TrackingEvent['eventName'], properties?: TrackingEvent['additionalProperties']): Promise<openapi_fetch.FetchResponse<{
|
|
1579
1659
|
parameters: {
|
|
1580
1660
|
query?: never;
|
|
1581
|
-
header
|
|
1661
|
+
header? /**
|
|
1662
|
+
* Ends the current conversation by deleting the conversation ID.
|
|
1663
|
+
*
|
|
1664
|
+
* @example
|
|
1665
|
+
* ```ts
|
|
1666
|
+
* client.endConversation()
|
|
1667
|
+
* console.log('Conversation ended')
|
|
1668
|
+
* ```
|
|
1669
|
+
*/: never;
|
|
1582
1670
|
path?: never;
|
|
1583
1671
|
cookie?: never;
|
|
1584
1672
|
};
|
|
@@ -1881,4 +1969,4 @@ declare const errorMiddleware: Middleware;
|
|
|
1881
1969
|
*/
|
|
1882
1970
|
declare const headerMiddleware: (identity: Identity, url: string) => Middleware;
|
|
1883
1971
|
|
|
1884
|
-
export { CONVERSATION_ID, Client, type Config, type ConversationIdMessage, type Endpoint, type ExitToChatMessage, type ExitToPhoneMessage, type ExitToPurchaseMessage, type ExitToPurchaseV2Message, type Identity, JWT_TOKEN, type Message, type MultiSelectMessage, type RecommendationMessage, type RecommendationV2Message, SDKError, SESSION_ID, type SendMessagePayload, type SingleSelectMessage, TTL, type TextMessage, type TrackingEvent, USER_ID, authMiddleware, deleteConversationId, errorMiddleware, getConversationId, getSessionId, getToken, getUserId, headerMiddleware, isTokenExpired, setConversationId, setSessionId, setToken, setUserId };
|
|
1972
|
+
export { CONVERSATION_ID, Client, type Config, type ConversationIdMessage, type Endpoint, type ExitToChatMessage, type ExitToPhoneMessage, type ExitToPurchaseMessage, type ExitToPurchaseV2Message, type Identity, JWT_TOKEN, type Message, type MultiSelectMessage, type RecommendationMessage, type RecommendationV2Message, SDKError, SESSION_ID, type SendMessagePayload, type SingleSelectMessage, TTL, type TextMessage, type TrackingEvent, USER_ID, type UserStartConversationMessage, authMiddleware, deleteConversationId, errorMiddleware, getConversationId, getSessionId, getToken, getUserId, headerMiddleware, isTokenExpired, setConversationId, setSessionId, setToken, setUserId };
|
package/dist/index.d.ts
CHANGED
|
@@ -68,7 +68,7 @@ interface components {
|
|
|
68
68
|
* Conversationsummary
|
|
69
69
|
* @description A summary of the conversation so far
|
|
70
70
|
*/
|
|
71
|
-
conversationSummary
|
|
71
|
+
conversationSummary?: string | null;
|
|
72
72
|
/** @description Why have we been exited to chat? */
|
|
73
73
|
reason: components['schemas']['ExitToHumanReason'];
|
|
74
74
|
/**
|
|
@@ -77,6 +77,12 @@ interface components {
|
|
|
77
77
|
* @default []
|
|
78
78
|
*/
|
|
79
79
|
recommendations: components['schemas']['RecommendationV2'][];
|
|
80
|
+
/**
|
|
81
|
+
* Conversationid
|
|
82
|
+
* @description The conversation id
|
|
83
|
+
* @example 15630a82-0e3d-4d1b-ab7d-fb7481a7a344
|
|
84
|
+
*/
|
|
85
|
+
conversationId?: string | null;
|
|
80
86
|
};
|
|
81
87
|
/**
|
|
82
88
|
* AssistantExitToPhoneMessage
|
|
@@ -294,6 +300,30 @@ interface components {
|
|
|
294
300
|
*/
|
|
295
301
|
message: string;
|
|
296
302
|
};
|
|
303
|
+
/**
|
|
304
|
+
* BaseSingleSelectMessage
|
|
305
|
+
* @description A message from the end user that picks a single select item
|
|
306
|
+
*/
|
|
307
|
+
BaseSingleSelectMessage: {
|
|
308
|
+
/**
|
|
309
|
+
* Type
|
|
310
|
+
* @default SINGLE_SELECT
|
|
311
|
+
* @constant
|
|
312
|
+
*/
|
|
313
|
+
type: 'SINGLE_SELECT';
|
|
314
|
+
/**
|
|
315
|
+
* Usermessage
|
|
316
|
+
* @description The user message
|
|
317
|
+
* @example Hello
|
|
318
|
+
*/
|
|
319
|
+
userMessage?: string | null;
|
|
320
|
+
/**
|
|
321
|
+
* Option
|
|
322
|
+
* @description Which select option was picked?
|
|
323
|
+
* @example 12345
|
|
324
|
+
*/
|
|
325
|
+
option?: string | null;
|
|
326
|
+
};
|
|
297
327
|
/** Bundle */
|
|
298
328
|
Bundle: {
|
|
299
329
|
/**
|
|
@@ -486,6 +516,23 @@ interface components {
|
|
|
486
516
|
* @enum {string}
|
|
487
517
|
*/
|
|
488
518
|
ExitToHumanReason: 'WANT_TO_TALK_TO_HUMAN' | 'OUT_OF_SCOPE_QUESTIONS' | 'NOT_BEHAVING_CORRECTLY';
|
|
519
|
+
/** HeaderDetails */
|
|
520
|
+
HeaderDetails: {
|
|
521
|
+
/**
|
|
522
|
+
* Title
|
|
523
|
+
* @description The title to show in the header of the recommendation card
|
|
524
|
+
*/
|
|
525
|
+
title?: string | null;
|
|
526
|
+
/**
|
|
527
|
+
* Description
|
|
528
|
+
* @description The description to show in the header of the recommendation card
|
|
529
|
+
*/
|
|
530
|
+
description?: string | null;
|
|
531
|
+
/** @description The current price of the product or bundle */
|
|
532
|
+
priceDetails?: components['schemas']['ProductPriceDetails'] | null;
|
|
533
|
+
/** @description The original price of the product or bundle, only set if it's currently discounted. */
|
|
534
|
+
previousPriceDetails?: components['schemas']['ProductPriceDetails'] | null;
|
|
535
|
+
};
|
|
489
536
|
/**
|
|
490
537
|
* Offer
|
|
491
538
|
* @description Offer details
|
|
@@ -641,6 +688,11 @@ interface components {
|
|
|
641
688
|
* @description For example, `tv`, `internet`, `phone`. It can be used to show an icon in the UI.
|
|
642
689
|
*/
|
|
643
690
|
category?: string | null;
|
|
691
|
+
/**
|
|
692
|
+
* Type
|
|
693
|
+
* @description The type of product, eg: BroadbandProduct, RouterProduct etc
|
|
694
|
+
*/
|
|
695
|
+
type?: string | null;
|
|
644
696
|
/**
|
|
645
697
|
* Extras
|
|
646
698
|
* @description Extras are additional products that are bundled with the main product.
|
|
@@ -709,6 +761,8 @@ interface components {
|
|
|
709
761
|
* @description Information to include at the bottom of the recommendation card, e.g. CPI price data
|
|
710
762
|
*/
|
|
711
763
|
importantInformation?: string | null;
|
|
764
|
+
/** @description Details to populate the header of the recommendation card */
|
|
765
|
+
header?: components['schemas']['HeaderDetails'] | null;
|
|
712
766
|
};
|
|
713
767
|
/**
|
|
714
768
|
* UserMultiSelectMessage
|
|
@@ -744,10 +798,7 @@ interface components {
|
|
|
744
798
|
*/
|
|
745
799
|
options: string[];
|
|
746
800
|
};
|
|
747
|
-
/**
|
|
748
|
-
* UserSingleSelectMessage
|
|
749
|
-
* @description A message from the end user that picks a single select item
|
|
750
|
-
*/
|
|
801
|
+
/** UserSingleSelectMessage */
|
|
751
802
|
UserSingleSelectMessage: {
|
|
752
803
|
/**
|
|
753
804
|
* Type
|
|
@@ -755,13 +806,6 @@ interface components {
|
|
|
755
806
|
* @constant
|
|
756
807
|
*/
|
|
757
808
|
type: 'SINGLE_SELECT';
|
|
758
|
-
/**
|
|
759
|
-
* Conversationid
|
|
760
|
-
* Format: uuid
|
|
761
|
-
* @description The conversation id
|
|
762
|
-
* @example 15630a82-0e3d-4d1b-ab7d-fb7481a7a344
|
|
763
|
-
*/
|
|
764
|
-
conversationId: string;
|
|
765
809
|
/**
|
|
766
810
|
* Usermessage
|
|
767
811
|
* @description The user message
|
|
@@ -774,6 +818,13 @@ interface components {
|
|
|
774
818
|
* @example 12345
|
|
775
819
|
*/
|
|
776
820
|
option?: string | null;
|
|
821
|
+
/**
|
|
822
|
+
* Conversationid
|
|
823
|
+
* Format: uuid
|
|
824
|
+
* @description The conversation id
|
|
825
|
+
* @example 15630a82-0e3d-4d1b-ab7d-fb7481a7a344
|
|
826
|
+
*/
|
|
827
|
+
conversationId: string;
|
|
777
828
|
};
|
|
778
829
|
/**
|
|
779
830
|
* UserStartConversationMessage
|
|
@@ -788,11 +839,8 @@ interface components {
|
|
|
788
839
|
type: 'START_CONVERSATION';
|
|
789
840
|
/** @description Context information we'll be getting with the request */
|
|
790
841
|
conversationContext: components['schemas']['ConversationContext'];
|
|
791
|
-
/**
|
|
792
|
-
|
|
793
|
-
* @description An optional opening message sent by the user as the very first message, for things such as UI chips in the frontend to prepopulate the conversation
|
|
794
|
-
*/
|
|
795
|
-
openingUserMessage?: components['schemas']['UserTextMessage'] | components['schemas']['UserSingleSelectMessage'] | components['schemas']['UserMultiSelectMessage'] | null;
|
|
842
|
+
/** @description An optional opening message sent by the user as the very first message, for things such as UI chips in the frontend to prepopulate the conversation */
|
|
843
|
+
openingUserMessage?: components['schemas']['BaseSingleSelectMessage'] | null;
|
|
796
844
|
};
|
|
797
845
|
/**
|
|
798
846
|
* UserTextMessage
|
|
@@ -1308,19 +1356,50 @@ declare class SDKError extends Error {
|
|
|
1308
1356
|
* These are the types as defined in the OpenAPI schema.
|
|
1309
1357
|
* We don't use them directly, or export them here because of how they appear in the documentation site.
|
|
1310
1358
|
*/
|
|
1311
|
-
type
|
|
1312
|
-
type
|
|
1313
|
-
type
|
|
1314
|
-
type
|
|
1315
|
-
|
|
1316
|
-
type
|
|
1317
|
-
type
|
|
1318
|
-
|
|
1319
|
-
type
|
|
1320
|
-
type
|
|
1321
|
-
|
|
1322
|
-
type
|
|
1323
|
-
type
|
|
1359
|
+
type ApiConversationRequest = paths$1['/api/conversation/v3']['post']['requestBody']['content']['application/json'];
|
|
1360
|
+
type ApiConversationResponse = paths$1['/api/conversation/v3']['post']['responses'][200]['content']['application/json'][number];
|
|
1361
|
+
type ApiConversationIdMessage = Extract<ApiConversationResponse, {
|
|
1362
|
+
type: 'CONVERSATION_ID';
|
|
1363
|
+
}>;
|
|
1364
|
+
type ApiExitToChatMessage = Extract<ApiConversationResponse, {
|
|
1365
|
+
type: 'EXIT_TO_CHAT';
|
|
1366
|
+
}>;
|
|
1367
|
+
type ApiExitToPhoneMessage = Extract<ApiConversationResponse, {
|
|
1368
|
+
type: 'EXIT_TO_PHONE';
|
|
1369
|
+
}>;
|
|
1370
|
+
type ApiExitToPurchaseMessage = Extract<ApiConversationResponse, {
|
|
1371
|
+
type: 'EXIT_TO_PURCHASE';
|
|
1372
|
+
}>;
|
|
1373
|
+
type ApiExitToPurchaseV2Message = Extract<ApiConversationResponse, {
|
|
1374
|
+
type: 'EXIT_TO_PURCHASE_V2';
|
|
1375
|
+
}>;
|
|
1376
|
+
type ApiMultiSelectMessage = Extract<ApiConversationResponse, {
|
|
1377
|
+
type: 'MULTI_SELECT';
|
|
1378
|
+
}>;
|
|
1379
|
+
type ApiRecommendationMessage = Extract<ApiConversationResponse, {
|
|
1380
|
+
type: 'RECOMMENDATION';
|
|
1381
|
+
}>;
|
|
1382
|
+
type ApiRecommendationV2Message = Extract<ApiConversationResponse, {
|
|
1383
|
+
type: 'RECOMMENDATION_V2';
|
|
1384
|
+
}>;
|
|
1385
|
+
type ApiSingleSelectMessage = Extract<ApiConversationResponse, {
|
|
1386
|
+
type: 'SINGLE_SELECT';
|
|
1387
|
+
}>;
|
|
1388
|
+
type ApiTextMessage = Extract<ApiConversationResponse, {
|
|
1389
|
+
type: 'MESSAGE';
|
|
1390
|
+
}>;
|
|
1391
|
+
type UserTextMessage = Extract<ApiConversationRequest, {
|
|
1392
|
+
type: 'MESSAGE';
|
|
1393
|
+
}>;
|
|
1394
|
+
type UserSingleSelectMessage = Extract<ApiConversationRequest, {
|
|
1395
|
+
type: 'SINGLE_SELECT';
|
|
1396
|
+
}>;
|
|
1397
|
+
type UserMultiSelectMessage = Extract<ApiConversationRequest, {
|
|
1398
|
+
type: 'MULTI_SELECT';
|
|
1399
|
+
}>;
|
|
1400
|
+
type UserStartConversationMessage = Extract<ApiConversationRequest, {
|
|
1401
|
+
type: 'START_CONVERSATION';
|
|
1402
|
+
}>;
|
|
1324
1403
|
type SendMessagePayload = Omit<UserTextMessage, 'conversationId'> | Omit<UserSingleSelectMessage, 'conversationId'> | Omit<UserMultiSelectMessage, 'conversationId'>;
|
|
1325
1404
|
type ApiIdentityRequest = paths['/api/tracking/identity/v2']['post']['requestBody']['content']['application/json'];
|
|
1326
1405
|
type ApiTrackingUserRequest = paths['/api/tracking/user/v2']['post']['requestBody']['content']['application/json'];
|
|
@@ -1493,7 +1572,7 @@ declare class Client {
|
|
|
1493
1572
|
* console.log('Opening message:', openingMessage)
|
|
1494
1573
|
* ```
|
|
1495
1574
|
*/
|
|
1496
|
-
startConversation(context?: components['schemas']['ConversationContext']): Promise<Message[]>;
|
|
1575
|
+
startConversation(context?: components['schemas']['ConversationContext'], userMessage?: UserStartConversationMessage['openingUserMessage']): Promise<Message[]>;
|
|
1497
1576
|
/**
|
|
1498
1577
|
* Sends a message in the conversation.
|
|
1499
1578
|
*
|
|
@@ -1516,9 +1595,10 @@ declare class Client {
|
|
|
1516
1595
|
sendMessage(payload: SendMessagePayload): Promise<({
|
|
1517
1596
|
type: "EXIT_TO_CHAT";
|
|
1518
1597
|
fallbackMessage: string;
|
|
1519
|
-
conversationSummary
|
|
1598
|
+
conversationSummary?: string | null;
|
|
1520
1599
|
reason: components["schemas"]["ExitToHumanReason"];
|
|
1521
1600
|
recommendations: components["schemas"]["RecommendationV2"][];
|
|
1601
|
+
conversationId?: string | null;
|
|
1522
1602
|
} | {
|
|
1523
1603
|
type: "EXIT_TO_PHONE";
|
|
1524
1604
|
fallbackMessage: string;
|
|
@@ -1578,7 +1658,15 @@ declare class Client {
|
|
|
1578
1658
|
trackEvent(eventName: TrackingEvent['eventName'], properties?: TrackingEvent['additionalProperties']): Promise<openapi_fetch.FetchResponse<{
|
|
1579
1659
|
parameters: {
|
|
1580
1660
|
query?: never;
|
|
1581
|
-
header
|
|
1661
|
+
header? /**
|
|
1662
|
+
* Ends the current conversation by deleting the conversation ID.
|
|
1663
|
+
*
|
|
1664
|
+
* @example
|
|
1665
|
+
* ```ts
|
|
1666
|
+
* client.endConversation()
|
|
1667
|
+
* console.log('Conversation ended')
|
|
1668
|
+
* ```
|
|
1669
|
+
*/: never;
|
|
1582
1670
|
path?: never;
|
|
1583
1671
|
cookie?: never;
|
|
1584
1672
|
};
|
|
@@ -1881,4 +1969,4 @@ declare const errorMiddleware: Middleware;
|
|
|
1881
1969
|
*/
|
|
1882
1970
|
declare const headerMiddleware: (identity: Identity, url: string) => Middleware;
|
|
1883
1971
|
|
|
1884
|
-
export { CONVERSATION_ID, Client, type Config, type ConversationIdMessage, type Endpoint, type ExitToChatMessage, type ExitToPhoneMessage, type ExitToPurchaseMessage, type ExitToPurchaseV2Message, type Identity, JWT_TOKEN, type Message, type MultiSelectMessage, type RecommendationMessage, type RecommendationV2Message, SDKError, SESSION_ID, type SendMessagePayload, type SingleSelectMessage, TTL, type TextMessage, type TrackingEvent, USER_ID, authMiddleware, deleteConversationId, errorMiddleware, getConversationId, getSessionId, getToken, getUserId, headerMiddleware, isTokenExpired, setConversationId, setSessionId, setToken, setUserId };
|
|
1972
|
+
export { CONVERSATION_ID, Client, type Config, type ConversationIdMessage, type Endpoint, type ExitToChatMessage, type ExitToPhoneMessage, type ExitToPurchaseMessage, type ExitToPurchaseV2Message, type Identity, JWT_TOKEN, type Message, type MultiSelectMessage, type RecommendationMessage, type RecommendationV2Message, SDKError, SESSION_ID, type SendMessagePayload, type SingleSelectMessage, TTL, type TextMessage, type TrackingEvent, USER_ID, type UserStartConversationMessage, authMiddleware, deleteConversationId, errorMiddleware, getConversationId, getSessionId, getToken, getUserId, headerMiddleware, isTokenExpired, setConversationId, setSessionId, setToken, setUserId };
|
package/dist/index.js
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
"use strict";var
|
|
1
|
+
"use strict";var N=Object.create;var d=Object.defineProperty;var V=Object.getOwnPropertyDescriptor;var D=Object.getOwnPropertyNames;var b=Object.getPrototypeOf,q=Object.prototype.hasOwnProperty;var j=(e,t)=>{for(var s in t)d(e,s,{get:t[s],enumerable:!0})},_=(e,t,s,o)=>{if(t&&typeof t=="object"||typeof t=="function")for(let n of D(t))!q.call(e,n)&&n!==s&&d(e,n,{get:()=>t[n],enumerable:!(o=V(t,n))||o.enumerable});return e};var L=(e,t,s)=>(s=e!=null?N(b(e)):{},_(t||!e||!e.__esModule?d(s,"default",{value:e,enumerable:!0}):s,e)),W=e=>_(d({},"__esModule",{value:!0}),e);var K={};j(K,{CONVERSATION_ID:()=>c,Client:()=>O,JWT_TOKEN:()=>l,SDKError:()=>i,SESSION_ID:()=>y,TTL:()=>k,USER_ID:()=>A,authMiddleware:()=>p,deleteConversationId:()=>h,errorMiddleware:()=>u,getConversationId:()=>I,getSessionId:()=>E,getToken:()=>T,getUserId:()=>C,headerMiddleware:()=>f,isTokenExpired:()=>U,setConversationId:()=>x,setSessionId:()=>M,setToken:()=>R,setUserId:()=>g});module.exports=W(K);var P=L(require("openapi-fetch"));var c="__15gifts_conversation_id",h=()=>sessionStorage.removeItem(c),I=()=>sessionStorage.getItem(c),x=e=>sessionStorage.setItem(c,e);var y="__15gifts_session_id",E=()=>sessionStorage.getItem(y),M=e=>sessionStorage.setItem(y,e);var X=e=>{let t=localStorage.getItem(e);if(!t)return null;let s=JSON.parse(t);return Date.now()>s.expires?(localStorage.removeItem(e),null):s.value},S=X;var G=(e,t,s)=>{let o={expires:Date.now()+s,value:t};localStorage.setItem(e,JSON.stringify(o))},w=G;var H=1e3*60*60*24,A="__15gifts_user_id",k=H*30,C=()=>{let e=S(A);return e&&g(e),e},g=e=>w(A,e,k);var l="__15gifts_identity_token",U=e=>{try{let[,t]=e.split(".");if(!t)throw new Error("Invalid token payload");let s=JSON.parse(atob(t));return s.exp&&Date.now()/1e3>s.exp}catch(t){return console.error("Invalid token format",t),!0}},T=()=>{let e=localStorage.getItem(l);return!e||U(e)?(localStorage.removeItem(l),null):e},R=e=>localStorage.setItem(l,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}}),p=B;var $={onResponse:async({response:e})=>{if(!e.ok){let t=await e.json();throw new Error(t.message)}return e}},u=$;var F=(e,t)=>({onRequest:async({request:s})=>(e.pageviewId&&s.headers.set("X-PAGEVIEW-ID",e.pageviewId),t&&s.headers.set("X-PAGE-URL",t),s)}),f=F;var m="0.18.0";var i=class e extends Error{sdkVersion;cause;constructor(t,{cause:s}={}){super(t),this.name="SDKError",this.cause=s,this.sdkVersion=m,Object.setPrototypeOf(this,e.prototype)}};var O=class{endpoint;identity;constructor(t){let{conversationUrl:s,customerId:o,fetch:n,frontendUrl:r,headers:v}=t,a={...v,"X-SDK-VERSION":m};this.endpoint={conversation:(0,P.default)({baseUrl:s,fetch:n,headers:a,credentials:"include"}),frontend:(0,P.default)({baseUrl:r,fetch:n,headers:a})},this.identity={customerId:o,conversationId:I()??void 0,sessionId:E()??void 0,userId:C()??void 0},this.endpoint.conversation.use(u),this.endpoint.conversation.use(f(this.identity,window.location.href))}async createIdentity(){let{customerId:t,sessionId:s,userId:o}=this.identity;try{let{data:n}=await this.endpoint.frontend.POST("/api/tracking/identity/v2",{body:{customerId:t,sessionId:s,userId:o,url:window.location.href,userAgent:window.navigator.userAgent}});if(!n)throw new i("No data received from identity API");this.identity.pageviewId=n.pageviewId,s||(this.identity.sessionId=n.sessionId,M(n.sessionId)),o||(this.identity.userId=n.userId,g(n.userId)),R(n.token),Object.values(this.endpoint).forEach(r=>{r.use(p(n.token))})}catch(n){throw Object.values(this.endpoint).forEach(r=>{r.use(p())}),new i("Failed to create identity",{cause:n})}}endConversation(){h(),this.identity.conversationId=void 0}async startConversation(t,s){this.endConversation();let o={...t},{data:n}=await this.endpoint.conversation.POST("/api/conversation/v3",{body:{type:"START_CONVERSATION",conversationContext:o,openingUserMessage:s}});if(!n)throw new i("No data received from Conversation API");let[r,...v]=n,a=r.conversationId;if(!a)throw new i("Conversation ID not received in API response");return x(a),this.identity.conversationId=a,v}async sendMessage(t){let s=this.identity.conversationId;if(!s)throw new i("Conversation ID not set");let{data:o}=await this.endpoint.conversation.POST("/api/conversation/v3",{body:{conversationId:s,...t}});if(!o)throw new i("No data received from conversation API");return o.filter(n=>n.type!=="CONVERSATION_ID")}async trackEvent(t,s){let o={additionalProperties:s,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:o})}getIdentity(){return this.identity}getIdentityToken(){return T()}};0&&(module.exports={CONVERSATION_ID,Client,JWT_TOKEN,SDKError,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","../src/utils/SDKError.ts"],"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 {\n Config,\n ConversationIdMessage,\n Endpoint,\n Identity,\n Message,\n SendMessagePayload,\n TrackingEvent,\n} from './types'\nimport { version } from '../package.json'\nimport SDKError from './utils/SDKError'\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 SDKError('No data received from identity API')\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 next request, preventing unnecessary API calls / 401 responses.\n Object.values(this.endpoint).forEach((endpoint) => {\n endpoint.use(authMiddleware())\n })\n throw new SDKError('Failed to create identity', {\n cause: error as Error,\n })\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<Message[]> {\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) throw new SDKError('No data received from Conversation API')\n\n const [conversationIdMessage, ...rest] = data as [ConversationIdMessage, ...Message[]]\n\n const conversationId = conversationIdMessage.conversationId\n if (!conversationId) {\n throw new SDKError('Conversation ID not received in API response')\n }\n\n setConversationId(conversationId)\n this.identity.conversationId = conversationId\n\n return rest\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(payload: SendMessagePayload) {\n const conversationId = this.identity.conversationId\n if (!conversationId) {\n throw new SDKError('Conversation ID not set')\n }\n\n const { data } = await this.endpoint.conversation.POST('/api/conversation/v3', {\n body: {\n conversationId,\n ...payload,\n },\n })\n\n if (!data) throw new SDKError('No data received from conversation API')\n\n // Removes any `CONVERSATION_ID` messages from the API response. In reality, these messages will only\n // appear in the response to a `START_CONVERSATION` request.\n return data.filter((message) => message.type !== 'CONVERSATION_ID')\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.16.8\",\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\": \"tsup\",\n \"coverage\": \"vitest run --coverage\",\n \"generate-types\": \"npx openapi-typescript\",\n \"dev\": \"tsup --watch\",\n \"format\": \"prettier . --write\",\n \"lint\": \"eslint .\",\n \"test:watch\": \"vitest\",\n \"test\": \"vitest run\",\n \"typecheck\": \"tsc\",\n \"update-schemas\": \"node --experimental-strip-types update-schema.ts && npm run generate-types && npm run format\"\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","import { version } from '../../package.json'\n\n/**\n * Custom error class for SDK-related errors.\n * Includes the SDK version and an optional cause for better debugging.\n * NOTE: The error.message is intended for developers, not end-users.\n */\nexport default class SDKError extends Error {\n sdkVersion: string\n override cause?: Error\n\n constructor(userMessage: string, { cause }: { cause?: Error } = {}) {\n super(userMessage)\n this.name = 'SDKError'\n this.cause = cause\n this.sdkVersion = version\n\n // Set the prototype explicitly to maintain instanceof checks\n Object.setPrototypeOf(this, SDKError.prototype)\n }\n}\n"],"mappings":"0jBAAA,IAAAA,EAAA,GAAAC,EAAAD,EAAA,qBAAAE,EAAA,WAAAC,EAAA,cAAAC,EAAA,aAAAC,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,EAAAtB,GCAA,IAAAuB,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,SCKb,IAAqBC,EAArB,MAAqBC,UAAiB,KAAM,CAC1C,WACS,MAET,YAAYC,EAAqB,CAAE,MAAAC,CAAM,EAAuB,CAAC,EAAG,CAClE,MAAMD,CAAW,EACjB,KAAK,KAAO,WACZ,KAAK,MAAQC,EACb,KAAK,WAAaC,EAGlB,OAAO,eAAe,KAAMH,EAAS,SAAS,CAChD,CACF,EXWO,IAAMI,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,IAAIC,EAAS,oCAAoC,EAGzD,KAAK,SAAS,WAAaD,EAAK,WAE3BF,IACH,KAAK,SAAS,UAAYE,EAAK,UAC/BE,EAAaF,EAAK,SAAS,GAExBD,IACH,KAAK,SAAS,OAASC,EAAK,OAC5BG,EAAUH,EAAK,MAAM,GAGvBI,EAASJ,EAAK,KAAK,EAGnB,OAAO,OAAO,KAAK,QAAQ,EAAE,QAASK,GAAa,CACjDA,EAAS,IAAIC,EAAeN,EAAK,KAAK,CAAC,CACzC,CAAC,CACH,OAASO,EAAO,CAGd,aAAO,OAAO,KAAK,QAAQ,EAAE,QAASF,GAAa,CACjDA,EAAS,IAAIC,EAAe,CAAC,CAC/B,CAAC,EACK,IAAIL,EAAS,4BAA6B,CAC9C,MAAOM,CACT,CAAC,CACH,CACF,CAWA,iBAAwB,CACtBC,EAAqB,EACrB,KAAK,SAAS,eAAiB,MACjC,CA0BA,MAAM,kBAAkBC,EAA4E,CAClG,KAAK,gBAAgB,EAErB,IAAMC,EAAsB,CAC1B,GAAGD,CACL,EAEM,CAAE,KAAAT,CAAK,EAAI,MAAM,KAAK,SAAS,aAAa,KAAK,uBAAwB,CAC7E,KAAM,CACJ,KAAM,qBACN,oBAAAU,CACF,CACF,CAAC,EAED,GAAI,CAACV,EAAM,MAAM,IAAIC,EAAS,wCAAwC,EAEtE,GAAM,CAACU,EAAuB,GAAGC,CAAI,EAAIZ,EAEnCa,EAAiBF,EAAsB,eAC7C,GAAI,CAACE,EACH,MAAM,IAAIZ,EAAS,8CAA8C,EAGnE,OAAAa,EAAkBD,CAAc,EAChC,KAAK,SAAS,eAAiBA,EAExBD,CACT,CAqBA,MAAM,YAAYG,EAA6B,CAC7C,IAAMF,EAAiB,KAAK,SAAS,eACrC,GAAI,CAACA,EACH,MAAM,IAAIZ,EAAS,yBAAyB,EAG9C,GAAM,CAAE,KAAAD,CAAK,EAAI,MAAM,KAAK,SAAS,aAAa,KAAK,uBAAwB,CAC7E,KAAM,CACJ,eAAAa,EACA,GAAGE,CACL,CACF,CAAC,EAED,GAAI,CAACf,EAAM,MAAM,IAAIC,EAAS,wCAAwC,EAItE,OAAOD,EAAK,OAAQgB,GAAYA,EAAQ,OAAS,iBAAiB,CACpE,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","SDKError","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","SDKError","_SDKError","userMessage","cause","version","Client","config","conversationUrl","customerId","fetch","frontendUrl","defaultHeaders","headers","version","createClient","getConversationId","getSessionId","getUserId","error_default","headers_default","sessionId","userId","data","SDKError","setSessionId","setUserId","setToken","endpoint","auth_default","error","deleteConversationId","context","conversationContext","conversationIdMessage","rest","conversationId","setConversationId","payload","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","../src/utils/SDKError.ts"],"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 {\n Config,\n ConversationIdMessage,\n Endpoint,\n Identity,\n Message,\n SendMessagePayload,\n TrackingEvent,\n UserStartConversationMessage,\n} from './types'\nimport { version } from '../package.json'\nimport SDKError from './utils/SDKError'\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 SDKError('No data received from identity API')\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 next request, preventing unnecessary API calls / 401 responses.\n Object.values(this.endpoint).forEach((endpoint) => {\n endpoint.use(authMiddleware())\n })\n throw new SDKError('Failed to create identity', {\n cause: error as Error,\n })\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(\n context?: components['schemas']['ConversationContext'],\n userMessage?: UserStartConversationMessage['openingUserMessage'],\n ): Promise<Message[]> {\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 openingUserMessage: userMessage,\n },\n })\n\n if (!data) throw new SDKError('No data received from Conversation API')\n\n const [conversationIdMessage, ...rest] = data as [ConversationIdMessage, ...Message[]]\n\n const conversationId = conversationIdMessage.conversationId\n if (!conversationId) {\n throw new SDKError('Conversation ID not received in API response')\n }\n\n setConversationId(conversationId)\n this.identity.conversationId = conversationId\n\n return rest\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(payload: SendMessagePayload) {\n const conversationId = this.identity.conversationId\n if (!conversationId) {\n throw new SDKError('Conversation ID not set')\n }\n\n const { data } = await this.endpoint.conversation.POST('/api/conversation/v3', {\n body: {\n conversationId,\n ...payload,\n },\n })\n\n if (!data) throw new SDKError('No data received from conversation API')\n\n // Removes any `CONVERSATION_ID` messages from the API response. In reality, these messages will only\n // appear in the response to a `START_CONVERSATION` request.\n return data.filter((message) => message.type !== 'CONVERSATION_ID')\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.18.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\": \"tsup\",\n \"coverage\": \"vitest run --coverage\",\n \"generate-types\": \"npx openapi-typescript\",\n \"dev\": \"tsup --watch\",\n \"format\": \"prettier . --write\",\n \"lint\": \"eslint .\",\n \"test:watch\": \"vitest\",\n \"test\": \"vitest run\",\n \"typecheck\": \"tsc\",\n \"update-schemas\": \"node --experimental-strip-types update-schema.ts && npm run generate-types && npm run format\"\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","import { version } from '../../package.json'\n\n/**\n * Custom error class for SDK-related errors.\n * Includes the SDK version and an optional cause for better debugging.\n * NOTE: The error.message is intended for developers, not end-users.\n */\nexport default class SDKError extends Error {\n sdkVersion: string\n override cause?: Error\n\n constructor(userMessage: string, { cause }: { cause?: Error } = {}) {\n super(userMessage)\n this.name = 'SDKError'\n this.cause = cause\n this.sdkVersion = version\n\n // Set the prototype explicitly to maintain instanceof checks\n Object.setPrototypeOf(this, SDKError.prototype)\n }\n}\n"],"mappings":"0jBAAA,IAAAA,EAAA,GAAAC,EAAAD,EAAA,qBAAAE,EAAA,WAAAC,EAAA,cAAAC,EAAA,aAAAC,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,EAAAtB,GCAA,IAAAuB,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,SCKb,IAAqBC,EAArB,MAAqBC,UAAiB,KAAM,CAC1C,WACS,MAET,YAAYC,EAAqB,CAAE,MAAAC,CAAM,EAAuB,CAAC,EAAG,CAClE,MAAMD,CAAW,EACjB,KAAK,KAAO,WACZ,KAAK,MAAQC,EACb,KAAK,WAAaC,EAGlB,OAAO,eAAe,KAAMH,EAAS,SAAS,CAChD,CACF,EXYO,IAAMI,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,IAAIC,EAAS,oCAAoC,EAGzD,KAAK,SAAS,WAAaD,EAAK,WAE3BF,IACH,KAAK,SAAS,UAAYE,EAAK,UAC/BE,EAAaF,EAAK,SAAS,GAExBD,IACH,KAAK,SAAS,OAASC,EAAK,OAC5BG,EAAUH,EAAK,MAAM,GAGvBI,EAASJ,EAAK,KAAK,EAGnB,OAAO,OAAO,KAAK,QAAQ,EAAE,QAASK,GAAa,CACjDA,EAAS,IAAIC,EAAeN,EAAK,KAAK,CAAC,CACzC,CAAC,CACH,OAASO,EAAO,CAGd,aAAO,OAAO,KAAK,QAAQ,EAAE,QAASF,GAAa,CACjDA,EAAS,IAAIC,EAAe,CAAC,CAC/B,CAAC,EACK,IAAIL,EAAS,4BAA6B,CAC9C,MAAOM,CACT,CAAC,CACH,CACF,CAWA,iBAAwB,CACtBC,EAAqB,EACrB,KAAK,SAAS,eAAiB,MACjC,CA0BA,MAAM,kBACJC,EACAC,EACoB,CACpB,KAAK,gBAAgB,EAErB,IAAMC,EAAsB,CAC1B,GAAGF,CACL,EAEM,CAAE,KAAAT,CAAK,EAAI,MAAM,KAAK,SAAS,aAAa,KAAK,uBAAwB,CAC7E,KAAM,CACJ,KAAM,qBACN,oBAAAW,EACA,mBAAoBD,CACtB,CACF,CAAC,EAED,GAAI,CAACV,EAAM,MAAM,IAAIC,EAAS,wCAAwC,EAEtE,GAAM,CAACW,EAAuB,GAAGC,CAAI,EAAIb,EAEnCc,EAAiBF,EAAsB,eAC7C,GAAI,CAACE,EACH,MAAM,IAAIb,EAAS,8CAA8C,EAGnE,OAAAc,EAAkBD,CAAc,EAChC,KAAK,SAAS,eAAiBA,EAExBD,CACT,CAqBA,MAAM,YAAYG,EAA6B,CAC7C,IAAMF,EAAiB,KAAK,SAAS,eACrC,GAAI,CAACA,EACH,MAAM,IAAIb,EAAS,yBAAyB,EAG9C,GAAM,CAAE,KAAAD,CAAK,EAAI,MAAM,KAAK,SAAS,aAAa,KAAK,uBAAwB,CAC7E,KAAM,CACJ,eAAAc,EACA,GAAGE,CACL,CACF,CAAC,EAED,GAAI,CAAChB,EAAM,MAAM,IAAIC,EAAS,wCAAwC,EAItE,OAAOD,EAAK,OAAQiB,GAAYA,EAAQ,OAAS,iBAAiB,CACpE,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","SDKError","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","SDKError","_SDKError","userMessage","cause","version","Client","config","conversationUrl","customerId","fetch","frontendUrl","defaultHeaders","headers","version","createClient","getConversationId","getSessionId","getUserId","error_default","headers_default","sessionId","userId","data","SDKError","setSessionId","setUserId","setToken","endpoint","auth_default","error","deleteConversationId","context","userMessage","conversationContext","conversationIdMessage","rest","conversationId","setConversationId","payload","message","eventName","properties","body","getToken"]}
|
package/dist/index.mjs
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
import
|
|
1
|
+
import R from"openapi-fetch";var g="__15gifts_conversation_id",I=()=>sessionStorage.removeItem(g),x=()=>sessionStorage.getItem(g),y=e=>sessionStorage.setItem(g,e);var E="__15gifts_session_id",M=()=>sessionStorage.getItem(E),S=e=>sessionStorage.setItem(E,e);var O=e=>{let t=localStorage.getItem(e);if(!t)return null;let s=JSON.parse(t);return Date.now()>s.expires?(localStorage.removeItem(e),null):s.value},l=O;var _=(e,t,s)=>{let o={expires:Date.now()+s,value:t};localStorage.setItem(e,JSON.stringify(o))},u=_;var k=1e3*60*60*24,w="__15gifts_user_id",U=k*30,A=()=>{let e=l(w);return e&&f(e),e},f=e=>u(w,e,U);var m="__15gifts_identity_token",N=e=>{try{let[,t]=e.split(".");if(!t)throw new Error("Invalid token payload");let s=JSON.parse(atob(t));return s.exp&&Date.now()/1e3>s.exp}catch(t){return console.error("Invalid token format",t),!0}},C=()=>{let e=localStorage.getItem(m);return!e||N(e)?(localStorage.removeItem(m),null):e},T=e=>localStorage.setItem(m,e);var V=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}}),p=V;var D={onResponse:async({response:e})=>{if(!e.ok){let t=await e.json();throw new Error(t.message)}return e}},v=D;var b=(e,t)=>({onRequest:async({request:s})=>(e.pageviewId&&s.headers.set("X-PAGEVIEW-ID",e.pageviewId),t&&s.headers.set("X-PAGE-URL",t),s)}),h=b;var d="0.18.0";var i=class e extends Error{sdkVersion;cause;constructor(t,{cause:s}={}){super(t),this.name="SDKError",this.cause=s,this.sdkVersion=d,Object.setPrototypeOf(this,e.prototype)}};var P=class{endpoint;identity;constructor(t){let{conversationUrl:s,customerId:o,fetch:n,frontendUrl:r,headers:c}=t,a={...c,"X-SDK-VERSION":d};this.endpoint={conversation:R({baseUrl:s,fetch:n,headers:a,credentials:"include"}),frontend:R({baseUrl:r,fetch:n,headers:a})},this.identity={customerId:o,conversationId:x()??void 0,sessionId:M()??void 0,userId:A()??void 0},this.endpoint.conversation.use(v),this.endpoint.conversation.use(h(this.identity,window.location.href))}async createIdentity(){let{customerId:t,sessionId:s,userId:o}=this.identity;try{let{data:n}=await this.endpoint.frontend.POST("/api/tracking/identity/v2",{body:{customerId:t,sessionId:s,userId:o,url:window.location.href,userAgent:window.navigator.userAgent}});if(!n)throw new i("No data received from identity API");this.identity.pageviewId=n.pageviewId,s||(this.identity.sessionId=n.sessionId,S(n.sessionId)),o||(this.identity.userId=n.userId,f(n.userId)),T(n.token),Object.values(this.endpoint).forEach(r=>{r.use(p(n.token))})}catch(n){throw Object.values(this.endpoint).forEach(r=>{r.use(p())}),new i("Failed to create identity",{cause:n})}}endConversation(){I(),this.identity.conversationId=void 0}async startConversation(t,s){this.endConversation();let o={...t},{data:n}=await this.endpoint.conversation.POST("/api/conversation/v3",{body:{type:"START_CONVERSATION",conversationContext:o,openingUserMessage:s}});if(!n)throw new i("No data received from Conversation API");let[r,...c]=n,a=r.conversationId;if(!a)throw new i("Conversation ID not received in API response");return y(a),this.identity.conversationId=a,c}async sendMessage(t){let s=this.identity.conversationId;if(!s)throw new i("Conversation ID not set");let{data:o}=await this.endpoint.conversation.POST("/api/conversation/v3",{body:{conversationId:s,...t}});if(!o)throw new i("No data received from conversation API");return o.filter(n=>n.type!=="CONVERSATION_ID")}async trackEvent(t,s){let o={additionalProperties:s,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:o})}getIdentity(){return this.identity}getIdentityToken(){return C()}};export{g as CONVERSATION_ID,P as Client,m as JWT_TOKEN,i as SDKError,E as SESSION_ID,U as TTL,w as USER_ID,p as authMiddleware,I as deleteConversationId,v as errorMiddleware,x as getConversationId,M as getSessionId,C as getToken,A as getUserId,h as headerMiddleware,N as isTokenExpired,y as setConversationId,S 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","../src/utils/SDKError.ts"],"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 {\n Config,\n ConversationIdMessage,\n Endpoint,\n Identity,\n Message,\n SendMessagePayload,\n TrackingEvent,\n} from './types'\nimport { version } from '../package.json'\nimport SDKError from './utils/SDKError'\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 SDKError('No data received from identity API')\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 next request, preventing unnecessary API calls / 401 responses.\n Object.values(this.endpoint).forEach((endpoint) => {\n endpoint.use(authMiddleware())\n })\n throw new SDKError('Failed to create identity', {\n cause: error as Error,\n })\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<Message[]> {\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) throw new SDKError('No data received from Conversation API')\n\n const [conversationIdMessage, ...rest] = data as [ConversationIdMessage, ...Message[]]\n\n const conversationId = conversationIdMessage.conversationId\n if (!conversationId) {\n throw new SDKError('Conversation ID not received in API response')\n }\n\n setConversationId(conversationId)\n this.identity.conversationId = conversationId\n\n return rest\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(payload: SendMessagePayload) {\n const conversationId = this.identity.conversationId\n if (!conversationId) {\n throw new SDKError('Conversation ID not set')\n }\n\n const { data } = await this.endpoint.conversation.POST('/api/conversation/v3', {\n body: {\n conversationId,\n ...payload,\n },\n })\n\n if (!data) throw new SDKError('No data received from conversation API')\n\n // Removes any `CONVERSATION_ID` messages from the API response. In reality, these messages will only\n // appear in the response to a `START_CONVERSATION` request.\n return data.filter((message) => message.type !== 'CONVERSATION_ID')\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.16.8\",\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\": \"tsup\",\n \"coverage\": \"vitest run --coverage\",\n \"generate-types\": \"npx openapi-typescript\",\n \"dev\": \"tsup --watch\",\n \"format\": \"prettier . --write\",\n \"lint\": \"eslint .\",\n \"test:watch\": \"vitest\",\n \"test\": \"vitest run\",\n \"typecheck\": \"tsc\",\n \"update-schemas\": \"node --experimental-strip-types update-schema.ts && npm run generate-types && npm run format\"\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","import { version } from '../../package.json'\n\n/**\n * Custom error class for SDK-related errors.\n * Includes the SDK version and an optional cause for better debugging.\n * NOTE: The error.message is intended for developers, not end-users.\n */\nexport default class SDKError extends Error {\n sdkVersion: string\n override cause?: Error\n\n constructor(userMessage: string, { cause }: { cause?: Error } = {}) {\n super(userMessage)\n this.name = 'SDKError'\n this.cause = cause\n this.sdkVersion = version\n\n // Set the prototype explicitly to maintain instanceof checks\n Object.setPrototypeOf(this, SDKError.prototype)\n }\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,SCKb,IAAqBC,EAArB,MAAqBC,UAAiB,KAAM,CAC1C,WACS,MAET,YAAYC,EAAqB,CAAE,MAAAC,CAAM,EAAuB,CAAC,EAAG,CAClE,MAAMD,CAAW,EACjB,KAAK,KAAO,WACZ,KAAK,MAAQC,EACb,KAAK,WAAaC,EAGlB,OAAO,eAAe,KAAMH,EAAS,SAAS,CAChD,CACF,EXWO,IAAMI,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,IAAIC,EAAS,oCAAoC,EAGzD,KAAK,SAAS,WAAaD,EAAK,WAE3BF,IACH,KAAK,SAAS,UAAYE,EAAK,UAC/BE,EAAaF,EAAK,SAAS,GAExBD,IACH,KAAK,SAAS,OAASC,EAAK,OAC5BG,EAAUH,EAAK,MAAM,GAGvBI,EAASJ,EAAK,KAAK,EAGnB,OAAO,OAAO,KAAK,QAAQ,EAAE,QAASK,GAAa,CACjDA,EAAS,IAAIC,EAAeN,EAAK,KAAK,CAAC,CACzC,CAAC,CACH,OAASO,EAAO,CAGd,aAAO,OAAO,KAAK,QAAQ,EAAE,QAASF,GAAa,CACjDA,EAAS,IAAIC,EAAe,CAAC,CAC/B,CAAC,EACK,IAAIL,EAAS,4BAA6B,CAC9C,MAAOM,CACT,CAAC,CACH,CACF,CAWA,iBAAwB,CACtBC,EAAqB,EACrB,KAAK,SAAS,eAAiB,MACjC,CA0BA,MAAM,kBAAkBC,EAA4E,CAClG,KAAK,gBAAgB,EAErB,IAAMC,EAAsB,CAC1B,GAAGD,CACL,EAEM,CAAE,KAAAT,CAAK,EAAI,MAAM,KAAK,SAAS,aAAa,KAAK,uBAAwB,CAC7E,KAAM,CACJ,KAAM,qBACN,oBAAAU,CACF,CACF,CAAC,EAED,GAAI,CAACV,EAAM,MAAM,IAAIC,EAAS,wCAAwC,EAEtE,GAAM,CAACU,EAAuB,GAAGC,CAAI,EAAIZ,EAEnCa,EAAiBF,EAAsB,eAC7C,GAAI,CAACE,EACH,MAAM,IAAIZ,EAAS,8CAA8C,EAGnE,OAAAa,EAAkBD,CAAc,EAChC,KAAK,SAAS,eAAiBA,EAExBD,CACT,CAqBA,MAAM,YAAYG,EAA6B,CAC7C,IAAMF,EAAiB,KAAK,SAAS,eACrC,GAAI,CAACA,EACH,MAAM,IAAIZ,EAAS,yBAAyB,EAG9C,GAAM,CAAE,KAAAD,CAAK,EAAI,MAAM,KAAK,SAAS,aAAa,KAAK,uBAAwB,CAC7E,KAAM,CACJ,eAAAa,EACA,GAAGE,CACL,CACF,CAAC,EAED,GAAI,CAACf,EAAM,MAAM,IAAIC,EAAS,wCAAwC,EAItE,OAAOD,EAAK,OAAQgB,GAAYA,EAAQ,OAAS,iBAAiB,CACpE,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","SDKError","_SDKError","userMessage","cause","version","Client","config","conversationUrl","customerId","fetch","frontendUrl","defaultHeaders","headers","version","createClient","getConversationId","getSessionId","getUserId","error_default","headers_default","sessionId","userId","data","SDKError","setSessionId","setUserId","setToken","endpoint","auth_default","error","deleteConversationId","context","conversationContext","conversationIdMessage","rest","conversationId","setConversationId","payload","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","../src/utils/SDKError.ts"],"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 {\n Config,\n ConversationIdMessage,\n Endpoint,\n Identity,\n Message,\n SendMessagePayload,\n TrackingEvent,\n UserStartConversationMessage,\n} from './types'\nimport { version } from '../package.json'\nimport SDKError from './utils/SDKError'\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 SDKError('No data received from identity API')\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 next request, preventing unnecessary API calls / 401 responses.\n Object.values(this.endpoint).forEach((endpoint) => {\n endpoint.use(authMiddleware())\n })\n throw new SDKError('Failed to create identity', {\n cause: error as Error,\n })\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(\n context?: components['schemas']['ConversationContext'],\n userMessage?: UserStartConversationMessage['openingUserMessage'],\n ): Promise<Message[]> {\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 openingUserMessage: userMessage,\n },\n })\n\n if (!data) throw new SDKError('No data received from Conversation API')\n\n const [conversationIdMessage, ...rest] = data as [ConversationIdMessage, ...Message[]]\n\n const conversationId = conversationIdMessage.conversationId\n if (!conversationId) {\n throw new SDKError('Conversation ID not received in API response')\n }\n\n setConversationId(conversationId)\n this.identity.conversationId = conversationId\n\n return rest\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(payload: SendMessagePayload) {\n const conversationId = this.identity.conversationId\n if (!conversationId) {\n throw new SDKError('Conversation ID not set')\n }\n\n const { data } = await this.endpoint.conversation.POST('/api/conversation/v3', {\n body: {\n conversationId,\n ...payload,\n },\n })\n\n if (!data) throw new SDKError('No data received from conversation API')\n\n // Removes any `CONVERSATION_ID` messages from the API response. In reality, these messages will only\n // appear in the response to a `START_CONVERSATION` request.\n return data.filter((message) => message.type !== 'CONVERSATION_ID')\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.18.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\": \"tsup\",\n \"coverage\": \"vitest run --coverage\",\n \"generate-types\": \"npx openapi-typescript\",\n \"dev\": \"tsup --watch\",\n \"format\": \"prettier . --write\",\n \"lint\": \"eslint .\",\n \"test:watch\": \"vitest\",\n \"test\": \"vitest run\",\n \"typecheck\": \"tsc\",\n \"update-schemas\": \"node --experimental-strip-types update-schema.ts && npm run generate-types && npm run format\"\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","import { version } from '../../package.json'\n\n/**\n * Custom error class for SDK-related errors.\n * Includes the SDK version and an optional cause for better debugging.\n * NOTE: The error.message is intended for developers, not end-users.\n */\nexport default class SDKError extends Error {\n sdkVersion: string\n override cause?: Error\n\n constructor(userMessage: string, { cause }: { cause?: Error } = {}) {\n super(userMessage)\n this.name = 'SDKError'\n this.cause = cause\n this.sdkVersion = version\n\n // Set the prototype explicitly to maintain instanceof checks\n Object.setPrototypeOf(this, SDKError.prototype)\n }\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,SCKb,IAAqBC,EAArB,MAAqBC,UAAiB,KAAM,CAC1C,WACS,MAET,YAAYC,EAAqB,CAAE,MAAAC,CAAM,EAAuB,CAAC,EAAG,CAClE,MAAMD,CAAW,EACjB,KAAK,KAAO,WACZ,KAAK,MAAQC,EACb,KAAK,WAAaC,EAGlB,OAAO,eAAe,KAAMH,EAAS,SAAS,CAChD,CACF,EXYO,IAAMI,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,IAAIC,EAAS,oCAAoC,EAGzD,KAAK,SAAS,WAAaD,EAAK,WAE3BF,IACH,KAAK,SAAS,UAAYE,EAAK,UAC/BE,EAAaF,EAAK,SAAS,GAExBD,IACH,KAAK,SAAS,OAASC,EAAK,OAC5BG,EAAUH,EAAK,MAAM,GAGvBI,EAASJ,EAAK,KAAK,EAGnB,OAAO,OAAO,KAAK,QAAQ,EAAE,QAASK,GAAa,CACjDA,EAAS,IAAIC,EAAeN,EAAK,KAAK,CAAC,CACzC,CAAC,CACH,OAASO,EAAO,CAGd,aAAO,OAAO,KAAK,QAAQ,EAAE,QAASF,GAAa,CACjDA,EAAS,IAAIC,EAAe,CAAC,CAC/B,CAAC,EACK,IAAIL,EAAS,4BAA6B,CAC9C,MAAOM,CACT,CAAC,CACH,CACF,CAWA,iBAAwB,CACtBC,EAAqB,EACrB,KAAK,SAAS,eAAiB,MACjC,CA0BA,MAAM,kBACJC,EACAC,EACoB,CACpB,KAAK,gBAAgB,EAErB,IAAMC,EAAsB,CAC1B,GAAGF,CACL,EAEM,CAAE,KAAAT,CAAK,EAAI,MAAM,KAAK,SAAS,aAAa,KAAK,uBAAwB,CAC7E,KAAM,CACJ,KAAM,qBACN,oBAAAW,EACA,mBAAoBD,CACtB,CACF,CAAC,EAED,GAAI,CAACV,EAAM,MAAM,IAAIC,EAAS,wCAAwC,EAEtE,GAAM,CAACW,EAAuB,GAAGC,CAAI,EAAIb,EAEnCc,EAAiBF,EAAsB,eAC7C,GAAI,CAACE,EACH,MAAM,IAAIb,EAAS,8CAA8C,EAGnE,OAAAc,EAAkBD,CAAc,EAChC,KAAK,SAAS,eAAiBA,EAExBD,CACT,CAqBA,MAAM,YAAYG,EAA6B,CAC7C,IAAMF,EAAiB,KAAK,SAAS,eACrC,GAAI,CAACA,EACH,MAAM,IAAIb,EAAS,yBAAyB,EAG9C,GAAM,CAAE,KAAAD,CAAK,EAAI,MAAM,KAAK,SAAS,aAAa,KAAK,uBAAwB,CAC7E,KAAM,CACJ,eAAAc,EACA,GAAGE,CACL,CACF,CAAC,EAED,GAAI,CAAChB,EAAM,MAAM,IAAIC,EAAS,wCAAwC,EAItE,OAAOD,EAAK,OAAQiB,GAAYA,EAAQ,OAAS,iBAAiB,CACpE,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","SDKError","_SDKError","userMessage","cause","version","Client","config","conversationUrl","customerId","fetch","frontendUrl","defaultHeaders","headers","version","createClient","getConversationId","getSessionId","getUserId","error_default","headers_default","sessionId","userId","data","SDKError","setSessionId","setUserId","setToken","endpoint","auth_default","error","deleteConversationId","context","userMessage","conversationContext","conversationIdMessage","rest","conversationId","setConversationId","payload","message","eventName","properties","body","getToken"]}
|