@15gifts/sdk 0.6.3 → 0.7.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 +36 -11
- package/dist/index.d.ts +36 -11
- 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
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import * as openapi_fetch from 'openapi-fetch';
|
|
2
|
-
import { Client as Client$1, Middleware } from 'openapi-fetch';
|
|
2
|
+
import { ClientOptions, Client as Client$1, Middleware } from 'openapi-fetch';
|
|
3
3
|
|
|
4
4
|
/**
|
|
5
5
|
* This file was auto-generated by openapi-typescript.
|
|
@@ -1169,6 +1169,7 @@ interface paths {
|
|
|
1169
1169
|
* "quantity": 2
|
|
1170
1170
|
* }
|
|
1171
1171
|
* ],
|
|
1172
|
+
* "pageviewId": "3c06dccf-06cb-4ffe-a3c2-863f76dcc765",
|
|
1172
1173
|
* "saleRef": "34596872",
|
|
1173
1174
|
* "totalPrice": 100,
|
|
1174
1175
|
* "totalRecurring": 10
|
|
@@ -1198,6 +1199,8 @@ interface paths {
|
|
|
1198
1199
|
/** @description Recurring Price */
|
|
1199
1200
|
recurring?: number;
|
|
1200
1201
|
}[];
|
|
1202
|
+
/** @description Pageview ID */
|
|
1203
|
+
pageviewId?: string;
|
|
1201
1204
|
/** @description Sale Reference */
|
|
1202
1205
|
saleRef: string;
|
|
1203
1206
|
/** @description Total Price */
|
|
@@ -1259,7 +1262,8 @@ interface paths {
|
|
|
1259
1262
|
content: {
|
|
1260
1263
|
/** @example {
|
|
1261
1264
|
* "conversationId": "386d85d7-9daa-8a87-85d4-3f93c990b292",
|
|
1262
|
-
* "eventName": "
|
|
1265
|
+
* "eventName": "entry_point-shown",
|
|
1266
|
+
* "pageviewId": "3c06dccf-06cb-4ffe-a3c2-863f76dcc765",
|
|
1263
1267
|
* "url": "https://www.example.com/telco/"
|
|
1264
1268
|
* } */
|
|
1265
1269
|
'application/json': {
|
|
@@ -1280,6 +1284,19 @@ interface paths {
|
|
|
1280
1284
|
user_agent?: string;
|
|
1281
1285
|
/** @description A 32 character alphanumeric hash that uniquely identifies a tracking event */
|
|
1282
1286
|
event_id?: string;
|
|
1287
|
+
/** @description A 32 character alphanumeric hash that uniquely identifies a page view (page-shown event) */
|
|
1288
|
+
pageview_id?: string;
|
|
1289
|
+
/** @description The device screen width in pixels - window.screen.width in JS. This is a user level property that should never change. */
|
|
1290
|
+
screen_width?: number;
|
|
1291
|
+
/** @description The device screen height in pixels - window.screen.width in JS. This is a user level property that should never change. */
|
|
1292
|
+
screen_height?: number;
|
|
1293
|
+
/** @description The size of the device's screen, based off the actual user experience it will generate, assuming the browser window takes up the whole screen.
|
|
1294
|
+
*
|
|
1295
|
+
* Based off https://15gifts.atlassian.net/wiki/spaces/AI/pages/3981443139/Breakpoints+for+mobile+desktop
|
|
1296
|
+
*
|
|
1297
|
+
* screen_width <= 480px = 'mobile'
|
|
1298
|
+
* screen_width > 480px = 'large' */
|
|
1299
|
+
screen_size?: string;
|
|
1283
1300
|
/** @description The name of the system/service that the event originates from */
|
|
1284
1301
|
service?: string;
|
|
1285
1302
|
/** @description A JSON object containing the different versions of services directly used by the service that tracks an event. The version of the service that is firing any tracking event should ALWAYS be included, for example if the conversation_api is firing an event, service_versions should include conversation_api_version. It should also ideally include the version numbers of any other services used in the generation of the event that is being tracked. */
|
|
@@ -1330,7 +1347,7 @@ interface paths {
|
|
|
1330
1347
|
* @description Event Name
|
|
1331
1348
|
* @enum {string}
|
|
1332
1349
|
*/
|
|
1333
|
-
eventName: '
|
|
1350
|
+
eventName: 'entry_point-shown' | 'feedback_submit-clicked' | 'page-shown' | 'tool_ui-closed' | 'user_message-submitted' | 'user_message-submitted message' | 'user_message-submitted single_select' | 'user_message-submitted multi_select' | 'assistant_message-submitted' | 'assistant_message-submitted recommendation' | 'assistant_message-submitted message' | 'assistant_message-submitted single_select' | 'assistant_message-submitted multi_select' | 'assistant_message-submitted exit_to_chat' | 'assistant_message-submitted exit_to_purchase' | 'feedback-shown' | 'feedback_skip-clicked' | 'sale-completed' | 'entry_point-clicked' | 'tool_close-clicked' | 'exit_to_purchase-completed' | 'exit_to_chat-completed';
|
|
1334
1351
|
/** @description Pageview ID */
|
|
1335
1352
|
pageviewId?: string;
|
|
1336
1353
|
/** @description URL */
|
|
@@ -1387,11 +1404,6 @@ interface Config {
|
|
|
1387
1404
|
* The customer ID associated with the conversation.
|
|
1388
1405
|
*/
|
|
1389
1406
|
customerId: ApiIdentityRequest['customerId'];
|
|
1390
|
-
/**
|
|
1391
|
-
* Optional fetch function to use for making HTTP requests.
|
|
1392
|
-
* If not provided, the default `fetch` implementation will be used.
|
|
1393
|
-
*/
|
|
1394
|
-
fetch?: (input: Request) => Promise<Response>;
|
|
1395
1407
|
/**
|
|
1396
1408
|
* The base URL for the conversation API.
|
|
1397
1409
|
*/
|
|
@@ -1400,6 +1412,15 @@ interface Config {
|
|
|
1400
1412
|
* The base URL for the frontend API.
|
|
1401
1413
|
*/
|
|
1402
1414
|
frontendUrl: string;
|
|
1415
|
+
/**
|
|
1416
|
+
* Optional fetch function to use for making HTTP requests.
|
|
1417
|
+
* If not provided, the default `fetch` implementation will be used.
|
|
1418
|
+
*/
|
|
1419
|
+
fetch?: (input: Request) => Promise<Response>;
|
|
1420
|
+
/**
|
|
1421
|
+
* Optional headers to include in every request.
|
|
1422
|
+
*/
|
|
1423
|
+
headers?: ClientOptions['headers'];
|
|
1403
1424
|
}
|
|
1404
1425
|
/**
|
|
1405
1426
|
* The API endpoint interfaces outline what operations are available for each API.
|
|
@@ -1491,7 +1512,7 @@ declare class Client {
|
|
|
1491
1512
|
* const client = new Client({ customerId: 'YOUR_CUSTOMER_ID' })
|
|
1492
1513
|
* ```
|
|
1493
1514
|
*/
|
|
1494
|
-
constructor(
|
|
1515
|
+
constructor(config: Config);
|
|
1495
1516
|
/**
|
|
1496
1517
|
* 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.
|
|
1497
1518
|
* Ends the current conversation if a conversation ID is present before sending a request to update identity.
|
|
@@ -1577,7 +1598,7 @@ declare class Client {
|
|
|
1577
1598
|
*
|
|
1578
1599
|
* @example
|
|
1579
1600
|
* ```ts
|
|
1580
|
-
* await client.trackEvent('
|
|
1601
|
+
* await client.trackEvent('entry_point-shown')
|
|
1581
1602
|
* ```
|
|
1582
1603
|
*/
|
|
1583
1604
|
trackEvent(eventName: TrackingEvent['eventName'], properties?: TrackingEvent['additionalProperties']): Promise<openapi_fetch.FetchResponse<{
|
|
@@ -1599,6 +1620,10 @@ declare class Client {
|
|
|
1599
1620
|
customer_id?: string;
|
|
1600
1621
|
user_agent?: string;
|
|
1601
1622
|
event_id?: string;
|
|
1623
|
+
pageview_id?: string;
|
|
1624
|
+
screen_width?: number;
|
|
1625
|
+
screen_height?: number;
|
|
1626
|
+
screen_size?: string;
|
|
1602
1627
|
service?: string;
|
|
1603
1628
|
service_versions?: Record<string, never>;
|
|
1604
1629
|
environment?: string;
|
|
@@ -1618,7 +1643,7 @@ declare class Client {
|
|
|
1618
1643
|
};
|
|
1619
1644
|
conversationId?: string;
|
|
1620
1645
|
deviceType?: "desktop" | "mobile" | "tablet";
|
|
1621
|
-
eventName: "
|
|
1646
|
+
eventName: "entry_point-shown" | "feedback_submit-clicked" | "page-shown" | "tool_ui-closed" | "user_message-submitted" | "user_message-submitted message" | "user_message-submitted single_select" | "user_message-submitted multi_select" | "assistant_message-submitted" | "assistant_message-submitted recommendation" | "assistant_message-submitted message" | "assistant_message-submitted single_select" | "assistant_message-submitted multi_select" | "assistant_message-submitted exit_to_chat" | "assistant_message-submitted exit_to_purchase" | "feedback-shown" | "feedback_skip-clicked" | "sale-completed" | "entry_point-clicked" | "tool_close-clicked" | "exit_to_purchase-completed" | "exit_to_chat-completed";
|
|
1622
1647
|
pageviewId?: string;
|
|
1623
1648
|
url?: string;
|
|
1624
1649
|
userAgent?: string;
|
package/dist/index.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import * as openapi_fetch from 'openapi-fetch';
|
|
2
|
-
import { Client as Client$1, Middleware } from 'openapi-fetch';
|
|
2
|
+
import { ClientOptions, Client as Client$1, Middleware } from 'openapi-fetch';
|
|
3
3
|
|
|
4
4
|
/**
|
|
5
5
|
* This file was auto-generated by openapi-typescript.
|
|
@@ -1169,6 +1169,7 @@ interface paths {
|
|
|
1169
1169
|
* "quantity": 2
|
|
1170
1170
|
* }
|
|
1171
1171
|
* ],
|
|
1172
|
+
* "pageviewId": "3c06dccf-06cb-4ffe-a3c2-863f76dcc765",
|
|
1172
1173
|
* "saleRef": "34596872",
|
|
1173
1174
|
* "totalPrice": 100,
|
|
1174
1175
|
* "totalRecurring": 10
|
|
@@ -1198,6 +1199,8 @@ interface paths {
|
|
|
1198
1199
|
/** @description Recurring Price */
|
|
1199
1200
|
recurring?: number;
|
|
1200
1201
|
}[];
|
|
1202
|
+
/** @description Pageview ID */
|
|
1203
|
+
pageviewId?: string;
|
|
1201
1204
|
/** @description Sale Reference */
|
|
1202
1205
|
saleRef: string;
|
|
1203
1206
|
/** @description Total Price */
|
|
@@ -1259,7 +1262,8 @@ interface paths {
|
|
|
1259
1262
|
content: {
|
|
1260
1263
|
/** @example {
|
|
1261
1264
|
* "conversationId": "386d85d7-9daa-8a87-85d4-3f93c990b292",
|
|
1262
|
-
* "eventName": "
|
|
1265
|
+
* "eventName": "entry_point-shown",
|
|
1266
|
+
* "pageviewId": "3c06dccf-06cb-4ffe-a3c2-863f76dcc765",
|
|
1263
1267
|
* "url": "https://www.example.com/telco/"
|
|
1264
1268
|
* } */
|
|
1265
1269
|
'application/json': {
|
|
@@ -1280,6 +1284,19 @@ interface paths {
|
|
|
1280
1284
|
user_agent?: string;
|
|
1281
1285
|
/** @description A 32 character alphanumeric hash that uniquely identifies a tracking event */
|
|
1282
1286
|
event_id?: string;
|
|
1287
|
+
/** @description A 32 character alphanumeric hash that uniquely identifies a page view (page-shown event) */
|
|
1288
|
+
pageview_id?: string;
|
|
1289
|
+
/** @description The device screen width in pixels - window.screen.width in JS. This is a user level property that should never change. */
|
|
1290
|
+
screen_width?: number;
|
|
1291
|
+
/** @description The device screen height in pixels - window.screen.width in JS. This is a user level property that should never change. */
|
|
1292
|
+
screen_height?: number;
|
|
1293
|
+
/** @description The size of the device's screen, based off the actual user experience it will generate, assuming the browser window takes up the whole screen.
|
|
1294
|
+
*
|
|
1295
|
+
* Based off https://15gifts.atlassian.net/wiki/spaces/AI/pages/3981443139/Breakpoints+for+mobile+desktop
|
|
1296
|
+
*
|
|
1297
|
+
* screen_width <= 480px = 'mobile'
|
|
1298
|
+
* screen_width > 480px = 'large' */
|
|
1299
|
+
screen_size?: string;
|
|
1283
1300
|
/** @description The name of the system/service that the event originates from */
|
|
1284
1301
|
service?: string;
|
|
1285
1302
|
/** @description A JSON object containing the different versions of services directly used by the service that tracks an event. The version of the service that is firing any tracking event should ALWAYS be included, for example if the conversation_api is firing an event, service_versions should include conversation_api_version. It should also ideally include the version numbers of any other services used in the generation of the event that is being tracked. */
|
|
@@ -1330,7 +1347,7 @@ interface paths {
|
|
|
1330
1347
|
* @description Event Name
|
|
1331
1348
|
* @enum {string}
|
|
1332
1349
|
*/
|
|
1333
|
-
eventName: '
|
|
1350
|
+
eventName: 'entry_point-shown' | 'feedback_submit-clicked' | 'page-shown' | 'tool_ui-closed' | 'user_message-submitted' | 'user_message-submitted message' | 'user_message-submitted single_select' | 'user_message-submitted multi_select' | 'assistant_message-submitted' | 'assistant_message-submitted recommendation' | 'assistant_message-submitted message' | 'assistant_message-submitted single_select' | 'assistant_message-submitted multi_select' | 'assistant_message-submitted exit_to_chat' | 'assistant_message-submitted exit_to_purchase' | 'feedback-shown' | 'feedback_skip-clicked' | 'sale-completed' | 'entry_point-clicked' | 'tool_close-clicked' | 'exit_to_purchase-completed' | 'exit_to_chat-completed';
|
|
1334
1351
|
/** @description Pageview ID */
|
|
1335
1352
|
pageviewId?: string;
|
|
1336
1353
|
/** @description URL */
|
|
@@ -1387,11 +1404,6 @@ interface Config {
|
|
|
1387
1404
|
* The customer ID associated with the conversation.
|
|
1388
1405
|
*/
|
|
1389
1406
|
customerId: ApiIdentityRequest['customerId'];
|
|
1390
|
-
/**
|
|
1391
|
-
* Optional fetch function to use for making HTTP requests.
|
|
1392
|
-
* If not provided, the default `fetch` implementation will be used.
|
|
1393
|
-
*/
|
|
1394
|
-
fetch?: (input: Request) => Promise<Response>;
|
|
1395
1407
|
/**
|
|
1396
1408
|
* The base URL for the conversation API.
|
|
1397
1409
|
*/
|
|
@@ -1400,6 +1412,15 @@ interface Config {
|
|
|
1400
1412
|
* The base URL for the frontend API.
|
|
1401
1413
|
*/
|
|
1402
1414
|
frontendUrl: string;
|
|
1415
|
+
/**
|
|
1416
|
+
* Optional fetch function to use for making HTTP requests.
|
|
1417
|
+
* If not provided, the default `fetch` implementation will be used.
|
|
1418
|
+
*/
|
|
1419
|
+
fetch?: (input: Request) => Promise<Response>;
|
|
1420
|
+
/**
|
|
1421
|
+
* Optional headers to include in every request.
|
|
1422
|
+
*/
|
|
1423
|
+
headers?: ClientOptions['headers'];
|
|
1403
1424
|
}
|
|
1404
1425
|
/**
|
|
1405
1426
|
* The API endpoint interfaces outline what operations are available for each API.
|
|
@@ -1491,7 +1512,7 @@ declare class Client {
|
|
|
1491
1512
|
* const client = new Client({ customerId: 'YOUR_CUSTOMER_ID' })
|
|
1492
1513
|
* ```
|
|
1493
1514
|
*/
|
|
1494
|
-
constructor(
|
|
1515
|
+
constructor(config: Config);
|
|
1495
1516
|
/**
|
|
1496
1517
|
* 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.
|
|
1497
1518
|
* Ends the current conversation if a conversation ID is present before sending a request to update identity.
|
|
@@ -1577,7 +1598,7 @@ declare class Client {
|
|
|
1577
1598
|
*
|
|
1578
1599
|
* @example
|
|
1579
1600
|
* ```ts
|
|
1580
|
-
* await client.trackEvent('
|
|
1601
|
+
* await client.trackEvent('entry_point-shown')
|
|
1581
1602
|
* ```
|
|
1582
1603
|
*/
|
|
1583
1604
|
trackEvent(eventName: TrackingEvent['eventName'], properties?: TrackingEvent['additionalProperties']): Promise<openapi_fetch.FetchResponse<{
|
|
@@ -1599,6 +1620,10 @@ declare class Client {
|
|
|
1599
1620
|
customer_id?: string;
|
|
1600
1621
|
user_agent?: string;
|
|
1601
1622
|
event_id?: string;
|
|
1623
|
+
pageview_id?: string;
|
|
1624
|
+
screen_width?: number;
|
|
1625
|
+
screen_height?: number;
|
|
1626
|
+
screen_size?: string;
|
|
1602
1627
|
service?: string;
|
|
1603
1628
|
service_versions?: Record<string, never>;
|
|
1604
1629
|
environment?: string;
|
|
@@ -1618,7 +1643,7 @@ declare class Client {
|
|
|
1618
1643
|
};
|
|
1619
1644
|
conversationId?: string;
|
|
1620
1645
|
deviceType?: "desktop" | "mobile" | "tablet";
|
|
1621
|
-
eventName: "
|
|
1646
|
+
eventName: "entry_point-shown" | "feedback_submit-clicked" | "page-shown" | "tool_ui-closed" | "user_message-submitted" | "user_message-submitted message" | "user_message-submitted single_select" | "user_message-submitted multi_select" | "assistant_message-submitted" | "assistant_message-submitted recommendation" | "assistant_message-submitted message" | "assistant_message-submitted single_select" | "assistant_message-submitted multi_select" | "assistant_message-submitted exit_to_chat" | "assistant_message-submitted exit_to_purchase" | "feedback-shown" | "feedback_skip-clicked" | "sale-completed" | "entry_point-clicked" | "tool_close-clicked" | "exit_to_purchase-completed" | "exit_to_chat-completed";
|
|
1622
1647
|
pageviewId?: string;
|
|
1623
1648
|
url?: string;
|
|
1624
1649
|
userAgent?: string;
|
package/dist/index.js
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
"use strict";var b=Object.create;var a=Object.defineProperty;var
|
|
1
|
+
"use strict";var b=Object.create;var a=Object.defineProperty;var _=Object.getOwnPropertyDescriptor;var T=Object.getOwnPropertyNames;var D=Object.getPrototypeOf,P=Object.prototype.hasOwnProperty;var N=(t,e)=>{for(var s in e)a(t,s,{get:e[s],enumerable:!0})},C=(t,e,s,i)=>{if(e&&typeof e=="object"||typeof e=="function")for(let n of T(e))!P.call(t,n)&&n!==s&&a(t,n,{get:()=>e[n],enumerable:!(i=_(e,n))||i.enumerable});return t};var U=(t,e,s)=>(s=t!=null?b(D(t)):{},C(e||!t||!t.__esModule?a(s,"default",{value:t,enumerable:!0}):s,t)),k=t=>C(a({},"__esModule",{value:!0}),t);var V={};N(V,{CONVERSATION_ID:()=>d,Client:()=>E,SESSION_ID:()=>v,TTL:()=>M,USER_ID:()=>h,authMiddleware:()=>p,deleteConversationId:()=>g,getConversationId:()=>I,getSessionId:()=>f,getUserId:()=>y,setConversationId:()=>c,setSessionId:()=>u,setUserId:()=>x});module.exports=k(V);var S=U(require("openapi-fetch"));var d="__15gifts_conversation_id",g=()=>sessionStorage.removeItem(d),I=()=>sessionStorage.getItem(d),c=t=>sessionStorage.setItem(d,t);var v="__15gifts_session_id",f=()=>sessionStorage.getItem(v),u=t=>sessionStorage.setItem(v,t);var A=t=>{let e=localStorage.getItem(t);if(!e)return null;let s=JSON.parse(e);return Date.now()>s.expires?(localStorage.removeItem(t),null):s.value},m=A;var R=(t,e,s)=>{let i={expires:Date.now()+s,value:e};localStorage.setItem(t,JSON.stringify(i))},l=R;var h="__15gifts_user_id",M=1e3*60*60*24*30,y=()=>m(h),x=t=>l(h,t,M);var B=t=>({onRequest:async({request:e})=>(e.headers.set("Authorization",`Bearer ${t}`),e)}),p=B;var O="0.7.0";var E=class{endpoint;identity;constructor(e){let{conversationUrl:s,customerId:i,fetch:n,frontendUrl:r,headers:o}=e,w={...o,"X-SDK-VERSION":O};this.endpoint={conversation:(0,S.default)({baseUrl:s,fetch:n,headers:w}),frontend:(0,S.default)({baseUrl:r,fetch:n,headers:w})},this.identity={customerId:i,conversationId:I()??void 0,sessionId:f()??void 0,userId:y()??void 0}}async createIdentity(){let{customerId:e,pageviewId:s,sessionId:i,userId:n}=this.identity,{data:r}=await this.endpoint.frontend.POST("/api/tracking/identity/v2",{body:{customerId:e,sessionId:i,userId:n}});r&&(s||(this.identity.pageviewId=r.pageviewId),i||(this.identity.sessionId=r.sessionId,u(r.sessionId)),n||(this.identity.userId=r.userId,x(r.userId)),Object.values(this.endpoint).forEach(o=>{o.use(p(r.token))}))}endConversation(){g(),this.identity.conversationId=void 0}async startConversation(e){this.endConversation();let s={availableProductIds:[],...e},{data:i}=await this.endpoint.conversation.POST("/api/conversation/v3",{body:{type:"START_CONVERSATION",conversationContext:s}}),[n,r]=i,o=n.conversationId;if(!o)throw new Error("Conversation ID not received");return c(o),this.identity.conversationId=o,r}async sendMessage({userMessage:e}){let{data:s}=await this.endpoint.conversation.POST("/api/conversation/v3",{body:{conversationId:this.identity.conversationId,userMessage:e,type:"MESSAGE"}});if(!s)return;let i=s.filter(o=>o.type==="DEBUG");i.length&&console.info("Debug messages:",i);let n=s.find(o=>o.type==="CONVERSATION_ID")?.conversationId;return n&&(c(n),this.identity.conversationId=n),s.filter(o=>o.type!=="CONVERSATION_ID"&&o.type!=="DEBUG")}async trackEvent(e,s){let i={additionalProperties:s,conversationId:this.identity.conversationId,deviceType:void 0,eventName:e,pageviewId:this.identity.pageviewId,url:window.location.href,userAgent:window.navigator.userAgent};return this.endpoint.frontend.POST("/api/tracking/user/v2",{body:i})}};0&&(module.exports={CONVERSATION_ID,Client,SESSION_ID,TTL,USER_ID,authMiddleware,deleteConversationId,getConversationId,getSessionId,getUserId,setConversationId,setSessionId,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/middlewares/auth.ts","../package.json"],"sourcesContent":["export * from './client'\nexport * from './identity'\nexport * from './middlewares'\nexport * from './types'\n","import createClient from 'openapi-fetch'\n\nimport {\n deleteConversationId,\n getConversationId,\n getSessionId,\n getUserId,\n setConversationId,\n setSessionId,\n setUserId,\n} from './identity'\nimport { authMiddleware } from './middlewares'\nimport type { paths as conversationPaths } from './schemas/conversation'\nimport type { paths as frontendPaths } from './schemas/frontend'\nimport type {\n BasicMessage,\n Config,\n ConversationIdMessage,\n DebugMessage,\n Endpoint,\n Identity,\n Message,\n TrackingEvent,\n} from './types'\nimport { version } from '../package.json'\n\n/**\n * The `Client` class provides methods to manage 15gifts API.\n */\nexport class Client {\n /**\n * This can be used to interact with the APIs directly. It is recommended to use the [helper methods](/sdk/sdk-reference/classes/client/#methods) provided by the `Client` class instead.\n *\n * @example\n * ```ts\n * const client = new Client({ customerId: 'YOUR_CUSTOMER_ID' })\n * const { data } = await client.endpoint.conversation.POST('/api/conversation/v2')\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({ customerId, fetch, conversationUrl, frontendUrl }: Config) {\n const headers = {\n 'X-SDK-VERSION': version,\n }\n\n this.endpoint = {\n conversation: createClient<conversationPaths>({ baseUrl: conversationUrl, fetch, headers }),\n frontend: createClient<frontendPaths>({ baseUrl: frontendUrl, fetch, headers }),\n }\n this.identity = {\n customerId,\n conversationId: getConversationId() ?? undefined,\n sessionId: getSessionId() ?? undefined,\n userId: getUserId() ?? undefined,\n }\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 *\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, pageviewId, sessionId, userId } = this.identity\n\n const { data } = await this.endpoint.frontend.POST('/api/tracking/identity/v2', {\n body: {\n customerId,\n sessionId,\n userId,\n },\n })\n\n if (data) {\n if (!pageviewId) {\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 Object.values(this.endpoint).forEach((endpont) => {\n endpont.use(authMiddleware(data.token))\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.productOverrides Overrides for product details.\n *\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?: {\n eligibleProducts?: string[]\n productOverrides?: Record<string, { price: number; minSpeed?: number; maxSpeed?: number }>\n }): Promise<BasicMessage | undefined> {\n this.endConversation()\n\n const conversationContext = {\n availableProductIds: [],\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 const [conversationIdMessage, openingMessage] = data as [ConversationIdMessage, BasicMessage]\n\n const conversationId = conversationIdMessage.conversationId\n if (!conversationId) {\n throw new Error('Conversation ID not received')\n }\n\n setConversationId(conversationId)\n this.identity.conversationId = conversationId\n\n return openingMessage\n }\n\n /**\n * Sends a message in the conversation.\n *\n * @param options - An object containing the user message.\n * @returns A promise that resolves to an array of messages\n *\n * @example\n * ```ts\n * const newMessages = await client.sendMessage({\n * userMessage: 'How can I get support?',\n * })\n *\n * if (newMessages) {\n * console.log('Received messages:', newMessages)\n * } else {\n * console.log('No message received')\n * }\n * ```\n */\n async sendMessage({\n userMessage,\n }: {\n userMessage: string\n }): Promise<Exclude<Message, ConversationIdMessage | DebugMessage>[] | undefined> {\n const { data } = await this.endpoint.conversation.POST('/api/conversation/v3', {\n body: {\n conversationId: this.identity.conversationId,\n userMessage,\n type: 'MESSAGE',\n },\n })\n\n if (!data) return undefined\n\n // Log debug messages\n // These will only be in the response when used in internal testing\n const debugMessages = data.filter((message) => message.type === 'DEBUG')\n if (debugMessages.length) {\n console.info('Debug messages:', debugMessages)\n }\n\n // When a request does not contain a conversation ID, the API will return a new conversation ID as the first message\n const conversationId = data.find((message) => message.type === 'CONVERSATION_ID')?.conversationId\n if (conversationId) {\n setConversationId(conversationId)\n this.identity.conversationId = conversationId\n }\n\n const messages = data.filter((message) => message.type !== 'CONVERSATION_ID' && message.type !== 'DEBUG')\n return messages\n }\n\n /**\n * Sends an event to the tracking API, with the required properties already set.\n *\n * @param eventName - The name of the event to track.\n * @param properties - Additional properties to include in the event.\n * @returns A promise that resolves once the event is tracked.\n *\n * @example\n * ```ts\n * await client.trackEvent('tab-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 deviceType: undefined,\n eventName,\n pageviewId: this.identity.pageviewId,\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 * 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","const 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'\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 = 1000 * 60 * 60 * 24 * 30 // 30 days\n\n/**\n * Retrieves the user ID from `localStorage`.\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 = () => getItemWithExpiry(USER_ID)\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","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 request.headers.set('Authorization', `Bearer ${accessToken}`)\n\n return request\n },\n})\n\nexport default authMiddleware\n","{\n \"name\": \"@15gifts/sdk\",\n \"version\": \"0.6.3\",\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 \"dev\": \"tsup --watch\",\n \"format\": \"prettier . --write\",\n \"generate\": \"npx openapi-typescript\",\n \"lint\": \"eslint .\",\n \"test\": \"vitest run\",\n \"test:watch\": \"vitest\",\n \"typecheck\": \"tsc\"\n },\n \"dependencies\": {\n \"openapi-fetch\": \"^0.13.3\"\n },\n \"devDependencies\": {\n \"openapi-typescript\": \"^7.4.4\",\n \"tsup\": \"^8.3.5\"\n },\n \"sideEffects\": false,\n \"prettier\": \"prettier-config-custom\"\n}\n"],"mappings":"0jBAAA,IAAAA,EAAA,GAAAC,EAAAD,EAAA,qBAAAE,EAAA,WAAAC,EAAA,eAAAC,EAAA,QAAAC,EAAA,YAAAC,EAAA,mBAAAC,EAAA,yBAAAC,EAAA,sBAAAC,EAAA,iBAAAC,EAAA,cAAAC,EAAA,sBAAAC,EAAA,iBAAAC,EAAA,cAAAC,IAAA,eAAAC,EAAAf,GCAA,IAAAgB,EAAyB,4BCKlB,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,EChBf,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,ECFR,IAAMM,EAAU,oBAQVC,EAAM,IAAO,GAAK,GAAK,GAAK,GAkB5BC,EAAY,IAAMC,EAAkBH,CAAO,EAa3CI,EAAaC,GAAmBC,EAAkBN,EAASK,EAAQJ,CAAG,EC/BnF,IAAMM,EAAkBC,IAAqC,CAC3D,UAAW,MAAO,CAAE,QAAAC,CAAQ,KAC1BA,EAAQ,QAAQ,IAAI,gBAAiB,UAAUD,CAAW,EAAE,EAErDC,EAEX,GAEOC,EAAQH,ECrBb,IAAAI,EAAW,QP2BN,IAAMC,EAAN,KAAa,CAUlB,SAKA,SAYA,YAAY,CAAE,WAAAC,EAAY,MAAAC,EAAO,gBAAAC,EAAiB,YAAAC,CAAY,EAAW,CACvE,IAAMC,EAAU,CACd,gBAAiBC,CACnB,EAEA,KAAK,SAAW,CACd,gBAAc,EAAAC,SAAgC,CAAE,QAASJ,EAAiB,MAAAD,EAAO,QAAAG,CAAQ,CAAC,EAC1F,YAAU,EAAAE,SAA4B,CAAE,QAASH,EAAa,MAAAF,EAAO,QAAAG,CAAQ,CAAC,CAChF,EACA,KAAK,SAAW,CACd,WAAAJ,EACA,eAAgBO,EAAkB,GAAK,OACvC,UAAWC,EAAa,GAAK,OAC7B,OAAQC,EAAU,GAAK,MACzB,CACF,CAcA,MAAM,gBAAgC,CACpC,GAAM,CAAE,WAAAT,EAAY,WAAAU,EAAY,UAAAC,EAAW,OAAAC,CAAO,EAAI,KAAK,SAErD,CAAE,KAAAC,CAAK,EAAI,MAAM,KAAK,SAAS,SAAS,KAAK,4BAA6B,CAC9E,KAAM,CACJ,WAAAb,EACA,UAAAW,EACA,OAAAC,CACF,CACF,CAAC,EAEGC,IACGH,IACH,KAAK,SAAS,WAAaG,EAAK,YAE7BF,IACH,KAAK,SAAS,UAAYE,EAAK,UAC/BC,EAAaD,EAAK,SAAS,GAExBD,IACH,KAAK,SAAS,OAASC,EAAK,OAC5BE,EAAUF,EAAK,MAAM,GAGvB,OAAO,OAAO,KAAK,QAAQ,EAAE,QAASG,GAAY,CAChDA,EAAQ,IAAIC,EAAeJ,EAAK,KAAK,CAAC,CACxC,CAAC,EAEL,CAWA,iBAAwB,CACtBK,EAAqB,EACrB,KAAK,SAAS,eAAiB,MACjC,CAyBA,MAAM,kBAAkBC,EAGc,CACpC,KAAK,gBAAgB,EAErB,IAAMC,EAAsB,CAC1B,oBAAqB,CAAC,EACtB,GAAGD,CACL,EAEM,CAAE,KAAAN,CAAK,EAAI,MAAM,KAAK,SAAS,aAAa,KAAK,uBAAwB,CAC7E,KAAM,CACJ,KAAM,qBACN,oBAAAO,CACF,CACF,CAAC,EAEK,CAACC,EAAuBC,CAAc,EAAIT,EAE1CU,EAAiBF,EAAsB,eAC7C,GAAI,CAACE,EACH,MAAM,IAAI,MAAM,8BAA8B,EAGhD,OAAAC,EAAkBD,CAAc,EAChC,KAAK,SAAS,eAAiBA,EAExBD,CACT,CAqBA,MAAM,YAAY,CAChB,YAAAG,CACF,EAEkF,CAChF,GAAM,CAAE,KAAAZ,CAAK,EAAI,MAAM,KAAK,SAAS,aAAa,KAAK,uBAAwB,CAC7E,KAAM,CACJ,eAAgB,KAAK,SAAS,eAC9B,YAAAY,EACA,KAAM,SACR,CACF,CAAC,EAED,GAAI,CAACZ,EAAM,OAIX,IAAMa,EAAgBb,EAAK,OAAQc,GAAYA,EAAQ,OAAS,OAAO,EACnED,EAAc,QAChB,QAAQ,KAAK,kBAAmBA,CAAa,EAI/C,IAAMH,EAAiBV,EAAK,KAAMc,GAAYA,EAAQ,OAAS,iBAAiB,GAAG,eACnF,OAAIJ,IACFC,EAAkBD,CAAc,EAChC,KAAK,SAAS,eAAiBA,GAGhBV,EAAK,OAAQc,GAAYA,EAAQ,OAAS,mBAAqBA,EAAQ,OAAS,OAAO,CAE1G,CAcA,MAAM,WAAWC,EAAuCC,EAAoD,CAC1G,IAAMC,EAAsB,CAC1B,qBAAsBD,EACtB,eAAgB,KAAK,SAAS,eAC9B,WAAY,OACZ,UAAAD,EACA,WAAY,KAAK,SAAS,WAC1B,IAAK,OAAO,SAAS,KACrB,UAAW,OAAO,UAAU,SAC9B,EAEA,OAAO,KAAK,SAAS,SAAS,KAAK,wBAAyB,CAC1D,KAAAE,CACF,CAAC,CACH,CACF","names":["index_exports","__export","CONVERSATION_ID","Client","SESSION_ID","TTL","USER_ID","auth_default","deleteConversationId","getConversationId","getSessionId","getUserId","setConversationId","setSessionId","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","USER_ID","TTL","getUserId","getItemWithExpiry_default","setUserId","userId","setItemWithExpiry_default","authMiddleware","accessToken","request","auth_default","version","Client","customerId","fetch","conversationUrl","frontendUrl","headers","version","createClient","getConversationId","getSessionId","getUserId","pageviewId","sessionId","userId","data","setSessionId","setUserId","endpont","auth_default","deleteConversationId","context","conversationContext","conversationIdMessage","openingMessage","conversationId","setConversationId","userMessage","debugMessages","message","eventName","properties","body"]}
|
|
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/middlewares/auth.ts","../package.json"],"sourcesContent":["export * from './client'\nexport * from './identity'\nexport * from './middlewares'\nexport * from './types'\n","import createClient, { type ClientOptions } from 'openapi-fetch'\n\nimport {\n deleteConversationId,\n getConversationId,\n getSessionId,\n getUserId,\n setConversationId,\n setSessionId,\n setUserId,\n} from './identity'\nimport { authMiddleware } from './middlewares'\nimport type { paths as conversationPaths } from './schemas/conversation'\nimport type { paths as frontendPaths } from './schemas/frontend'\nimport type {\n BasicMessage,\n Config,\n ConversationIdMessage,\n DebugMessage,\n Endpoint,\n Identity,\n Message,\n TrackingEvent,\n} from './types'\nimport { version } from '../package.json'\n\n/**\n * The `Client` class provides methods to manage 15gifts API.\n */\nexport class Client {\n /**\n * This can be used to interact with the APIs directly. It is recommended to use the [helper methods](/sdk/sdk-reference/classes/client/#methods) provided by the `Client` class instead.\n *\n * @example\n * ```ts\n * const client = new Client({ customerId: 'YOUR_CUSTOMER_ID' })\n * const { data } = await client.endpoint.conversation.POST('/api/conversation/v2')\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>({ baseUrl: conversationUrl, fetch, headers }),\n frontend: createClient<frontendPaths>({ baseUrl: frontendUrl, fetch, headers }),\n }\n this.identity = {\n customerId,\n conversationId: getConversationId() ?? undefined,\n sessionId: getSessionId() ?? undefined,\n userId: getUserId() ?? undefined,\n }\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 *\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, pageviewId, sessionId, userId } = this.identity\n\n const { data } = await this.endpoint.frontend.POST('/api/tracking/identity/v2', {\n body: {\n customerId,\n sessionId,\n userId,\n },\n })\n\n if (data) {\n if (!pageviewId) {\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 Object.values(this.endpoint).forEach((endpont) => {\n endpont.use(authMiddleware(data.token))\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.productOverrides Overrides for product details.\n *\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?: {\n eligibleProducts?: string[]\n productOverrides?: Record<string, { price: number; minSpeed?: number; maxSpeed?: number }>\n }): Promise<BasicMessage | undefined> {\n this.endConversation()\n\n const conversationContext = {\n availableProductIds: [],\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 const [conversationIdMessage, openingMessage] = data as [ConversationIdMessage, BasicMessage]\n\n const conversationId = conversationIdMessage.conversationId\n if (!conversationId) {\n throw new Error('Conversation ID not received')\n }\n\n setConversationId(conversationId)\n this.identity.conversationId = conversationId\n\n return openingMessage\n }\n\n /**\n * Sends a message in the conversation.\n *\n * @param options - An object containing the user message.\n * @returns A promise that resolves to an array of messages\n *\n * @example\n * ```ts\n * const newMessages = await client.sendMessage({\n * userMessage: 'How can I get support?',\n * })\n *\n * if (newMessages) {\n * console.log('Received messages:', newMessages)\n * } else {\n * console.log('No message received')\n * }\n * ```\n */\n async sendMessage({\n userMessage,\n }: {\n userMessage: string\n }): Promise<Exclude<Message, ConversationIdMessage | DebugMessage>[] | undefined> {\n const { data } = await this.endpoint.conversation.POST('/api/conversation/v3', {\n body: {\n conversationId: this.identity.conversationId,\n userMessage,\n type: 'MESSAGE',\n },\n })\n\n if (!data) return undefined\n\n // Log debug messages\n // These will only be in the response when used in internal testing\n const debugMessages = data.filter((message) => message.type === 'DEBUG')\n if (debugMessages.length) {\n console.info('Debug messages:', debugMessages)\n }\n\n // When a request does not contain a conversation ID, the API will return a new conversation ID as the first message\n const conversationId = data.find((message) => message.type === 'CONVERSATION_ID')?.conversationId\n if (conversationId) {\n setConversationId(conversationId)\n this.identity.conversationId = conversationId\n }\n\n const messages = data.filter((message) => message.type !== 'CONVERSATION_ID' && message.type !== 'DEBUG')\n return messages\n }\n\n /**\n * Sends an event to the tracking API, with the required properties already set.\n *\n * @param eventName - The name of the event to track.\n * @param properties - Additional properties to include in the event.\n * @returns A promise that resolves once the event is tracked.\n *\n * @example\n * ```ts\n * await client.trackEvent('entry_point-shown')\n * ```\n */\n async trackEvent(eventName: TrackingEvent['eventName'], properties?: TrackingEvent['additionalProperties']) {\n const body: TrackingEvent = {\n additionalProperties: properties,\n conversationId: this.identity.conversationId,\n deviceType: undefined,\n eventName,\n pageviewId: this.identity.pageviewId,\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 * 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","const 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'\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 = 1000 * 60 * 60 * 24 * 30 // 30 days\n\n/**\n * Retrieves the user ID from `localStorage`.\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 = () => getItemWithExpiry(USER_ID)\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","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 request.headers.set('Authorization', `Bearer ${accessToken}`)\n\n return request\n },\n})\n\nexport default authMiddleware\n","{\n \"name\": \"@15gifts/sdk\",\n \"version\": \"0.7.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 \"dev\": \"tsup --watch\",\n \"format\": \"prettier . --write\",\n \"generate\": \"npx openapi-typescript\",\n \"lint\": \"eslint .\",\n \"test\": \"vitest run\",\n \"test:watch\": \"vitest\",\n \"typecheck\": \"tsc\"\n },\n \"dependencies\": {\n \"openapi-fetch\": \"^0.13.3\"\n },\n \"devDependencies\": {\n \"openapi-typescript\": \"^7.4.4\",\n \"tsup\": \"^8.3.5\"\n },\n \"sideEffects\": false,\n \"prettier\": \"prettier-config-custom\"\n}\n"],"mappings":"0jBAAA,IAAAA,EAAA,GAAAC,EAAAD,EAAA,qBAAAE,EAAA,WAAAC,EAAA,eAAAC,EAAA,QAAAC,EAAA,YAAAC,EAAA,mBAAAC,EAAA,yBAAAC,EAAA,sBAAAC,EAAA,iBAAAC,EAAA,cAAAC,EAAA,sBAAAC,EAAA,iBAAAC,EAAA,cAAAC,IAAA,eAAAC,EAAAf,GCAA,IAAAgB,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,EChBf,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,ECFR,IAAMM,EAAU,oBAQVC,EAAM,IAAO,GAAK,GAAK,GAAK,GAkB5BC,EAAY,IAAMC,EAAkBH,CAAO,EAa3CI,EAAaC,GAAmBC,EAAkBN,EAASK,EAAQJ,CAAG,EC/BnF,IAAMM,EAAkBC,IAAqC,CAC3D,UAAW,MAAO,CAAE,QAAAC,CAAQ,KAC1BA,EAAQ,QAAQ,IAAI,gBAAiB,UAAUD,CAAW,EAAE,EAErDC,EAEX,GAEOC,EAAQH,ECrBb,IAAAI,EAAW,QP2BN,IAAMC,EAAN,KAAa,CAUlB,SAKA,SAYA,YAAYC,EAAgB,CAC1B,GAAM,CAAE,gBAAAC,EAAiB,WAAAC,EAAY,MAAAC,EAAO,YAAAC,EAAa,QAASC,CAAe,EAAIL,EAE/EM,EAAoC,CACxC,GAAGD,EACH,gBAAiBE,CACnB,EAEA,KAAK,SAAW,CACd,gBAAc,EAAAC,SAAgC,CAAE,QAASP,EAAiB,MAAAE,EAAO,QAAAG,CAAQ,CAAC,EAC1F,YAAU,EAAAE,SAA4B,CAAE,QAASJ,EAAa,MAAAD,EAAO,QAAAG,CAAQ,CAAC,CAChF,EACA,KAAK,SAAW,CACd,WAAAJ,EACA,eAAgBO,EAAkB,GAAK,OACvC,UAAWC,EAAa,GAAK,OAC7B,OAAQC,EAAU,GAAK,MACzB,CACF,CAcA,MAAM,gBAAgC,CACpC,GAAM,CAAE,WAAAT,EAAY,WAAAU,EAAY,UAAAC,EAAW,OAAAC,CAAO,EAAI,KAAK,SAErD,CAAE,KAAAC,CAAK,EAAI,MAAM,KAAK,SAAS,SAAS,KAAK,4BAA6B,CAC9E,KAAM,CACJ,WAAAb,EACA,UAAAW,EACA,OAAAC,CACF,CACF,CAAC,EAEGC,IACGH,IACH,KAAK,SAAS,WAAaG,EAAK,YAE7BF,IACH,KAAK,SAAS,UAAYE,EAAK,UAC/BC,EAAaD,EAAK,SAAS,GAExBD,IACH,KAAK,SAAS,OAASC,EAAK,OAC5BE,EAAUF,EAAK,MAAM,GAGvB,OAAO,OAAO,KAAK,QAAQ,EAAE,QAASG,GAAY,CAChDA,EAAQ,IAAIC,EAAeJ,EAAK,KAAK,CAAC,CACxC,CAAC,EAEL,CAWA,iBAAwB,CACtBK,EAAqB,EACrB,KAAK,SAAS,eAAiB,MACjC,CAyBA,MAAM,kBAAkBC,EAGc,CACpC,KAAK,gBAAgB,EAErB,IAAMC,EAAsB,CAC1B,oBAAqB,CAAC,EACtB,GAAGD,CACL,EAEM,CAAE,KAAAN,CAAK,EAAI,MAAM,KAAK,SAAS,aAAa,KAAK,uBAAwB,CAC7E,KAAM,CACJ,KAAM,qBACN,oBAAAO,CACF,CACF,CAAC,EAEK,CAACC,EAAuBC,CAAc,EAAIT,EAE1CU,EAAiBF,EAAsB,eAC7C,GAAI,CAACE,EACH,MAAM,IAAI,MAAM,8BAA8B,EAGhD,OAAAC,EAAkBD,CAAc,EAChC,KAAK,SAAS,eAAiBA,EAExBD,CACT,CAqBA,MAAM,YAAY,CAChB,YAAAG,CACF,EAEkF,CAChF,GAAM,CAAE,KAAAZ,CAAK,EAAI,MAAM,KAAK,SAAS,aAAa,KAAK,uBAAwB,CAC7E,KAAM,CACJ,eAAgB,KAAK,SAAS,eAC9B,YAAAY,EACA,KAAM,SACR,CACF,CAAC,EAED,GAAI,CAACZ,EAAM,OAIX,IAAMa,EAAgBb,EAAK,OAAQc,GAAYA,EAAQ,OAAS,OAAO,EACnED,EAAc,QAChB,QAAQ,KAAK,kBAAmBA,CAAa,EAI/C,IAAMH,EAAiBV,EAAK,KAAMc,GAAYA,EAAQ,OAAS,iBAAiB,GAAG,eACnF,OAAIJ,IACFC,EAAkBD,CAAc,EAChC,KAAK,SAAS,eAAiBA,GAGhBV,EAAK,OAAQc,GAAYA,EAAQ,OAAS,mBAAqBA,EAAQ,OAAS,OAAO,CAE1G,CAcA,MAAM,WAAWC,EAAuCC,EAAoD,CAC1G,IAAMC,EAAsB,CAC1B,qBAAsBD,EACtB,eAAgB,KAAK,SAAS,eAC9B,WAAY,OACZ,UAAAD,EACA,WAAY,KAAK,SAAS,WAC1B,IAAK,OAAO,SAAS,KACrB,UAAW,OAAO,UAAU,SAC9B,EAEA,OAAO,KAAK,SAAS,SAAS,KAAK,wBAAyB,CAC1D,KAAAE,CACF,CAAC,CACH,CACF","names":["index_exports","__export","CONVERSATION_ID","Client","SESSION_ID","TTL","USER_ID","auth_default","deleteConversationId","getConversationId","getSessionId","getUserId","setConversationId","setSessionId","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","USER_ID","TTL","getUserId","getItemWithExpiry_default","setUserId","userId","setItemWithExpiry_default","authMiddleware","accessToken","request","auth_default","version","Client","config","conversationUrl","customerId","fetch","frontendUrl","defaultHeaders","headers","version","createClient","getConversationId","getSessionId","getUserId","pageviewId","sessionId","userId","data","setSessionId","setUserId","endpont","auth_default","deleteConversationId","context","conversationContext","conversationIdMessage","openingMessage","conversationId","setConversationId","userMessage","debugMessages","message","eventName","properties","body"]}
|
package/dist/index.mjs
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
import
|
|
1
|
+
import E from"openapi-fetch";var a="__15gifts_conversation_id",v=()=>sessionStorage.removeItem(a),f=()=>sessionStorage.getItem(a),d=n=>sessionStorage.setItem(a,n);var u="__15gifts_session_id",m=()=>sessionStorage.getItem(u),l=n=>sessionStorage.setItem(u,n);var C=n=>{let e=localStorage.getItem(n);if(!e)return null;let t=JSON.parse(e);return Date.now()>t.expires?(localStorage.removeItem(n),null):t.value},c=C;var M=(n,e,t)=>{let i={expires:Date.now()+t,value:e};localStorage.setItem(n,JSON.stringify(i))},p=M;var h="__15gifts_user_id",O=1e3*60*60*24*30,y=()=>c(h),x=n=>p(h,n,O);var b=n=>({onRequest:async({request:e})=>(e.headers.set("Authorization",`Bearer ${n}`),e)}),g=b;var S="0.7.0";var w=class{endpoint;identity;constructor(e){let{conversationUrl:t,customerId:i,fetch:r,frontendUrl:o,headers:s}=e,I={...s,"X-SDK-VERSION":S};this.endpoint={conversation:E({baseUrl:t,fetch:r,headers:I}),frontend:E({baseUrl:o,fetch:r,headers:I})},this.identity={customerId:i,conversationId:f()??void 0,sessionId:m()??void 0,userId:y()??void 0}}async createIdentity(){let{customerId:e,pageviewId:t,sessionId:i,userId:r}=this.identity,{data:o}=await this.endpoint.frontend.POST("/api/tracking/identity/v2",{body:{customerId:e,sessionId:i,userId:r}});o&&(t||(this.identity.pageviewId=o.pageviewId),i||(this.identity.sessionId=o.sessionId,l(o.sessionId)),r||(this.identity.userId=o.userId,x(o.userId)),Object.values(this.endpoint).forEach(s=>{s.use(g(o.token))}))}endConversation(){v(),this.identity.conversationId=void 0}async startConversation(e){this.endConversation();let t={availableProductIds:[],...e},{data:i}=await this.endpoint.conversation.POST("/api/conversation/v3",{body:{type:"START_CONVERSATION",conversationContext:t}}),[r,o]=i,s=r.conversationId;if(!s)throw new Error("Conversation ID not received");return d(s),this.identity.conversationId=s,o}async sendMessage({userMessage:e}){let{data:t}=await this.endpoint.conversation.POST("/api/conversation/v3",{body:{conversationId:this.identity.conversationId,userMessage:e,type:"MESSAGE"}});if(!t)return;let i=t.filter(s=>s.type==="DEBUG");i.length&&console.info("Debug messages:",i);let r=t.find(s=>s.type==="CONVERSATION_ID")?.conversationId;return r&&(d(r),this.identity.conversationId=r),t.filter(s=>s.type!=="CONVERSATION_ID"&&s.type!=="DEBUG")}async trackEvent(e,t){let i={additionalProperties:t,conversationId:this.identity.conversationId,deviceType:void 0,eventName:e,pageviewId:this.identity.pageviewId,url:window.location.href,userAgent:window.navigator.userAgent};return this.endpoint.frontend.POST("/api/tracking/user/v2",{body:i})}};export{a as CONVERSATION_ID,w as Client,u as SESSION_ID,O as TTL,h as USER_ID,g as authMiddleware,v as deleteConversationId,f as getConversationId,m as getSessionId,y as getUserId,d as setConversationId,l as setSessionId,x 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/middlewares/auth.ts","../package.json"],"sourcesContent":["import createClient from 'openapi-fetch'\n\nimport {\n deleteConversationId,\n getConversationId,\n getSessionId,\n getUserId,\n setConversationId,\n setSessionId,\n setUserId,\n} from './identity'\nimport { authMiddleware } from './middlewares'\nimport type { paths as conversationPaths } from './schemas/conversation'\nimport type { paths as frontendPaths } from './schemas/frontend'\nimport type {\n BasicMessage,\n Config,\n ConversationIdMessage,\n DebugMessage,\n Endpoint,\n Identity,\n Message,\n TrackingEvent,\n} from './types'\nimport { version } from '../package.json'\n\n/**\n * The `Client` class provides methods to manage 15gifts API.\n */\nexport class Client {\n /**\n * This can be used to interact with the APIs directly. It is recommended to use the [helper methods](/sdk/sdk-reference/classes/client/#methods) provided by the `Client` class instead.\n *\n * @example\n * ```ts\n * const client = new Client({ customerId: 'YOUR_CUSTOMER_ID' })\n * const { data } = await client.endpoint.conversation.POST('/api/conversation/v2')\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({ customerId, fetch, conversationUrl, frontendUrl }: Config) {\n const headers = {\n 'X-SDK-VERSION': version,\n }\n\n this.endpoint = {\n conversation: createClient<conversationPaths>({ baseUrl: conversationUrl, fetch, headers }),\n frontend: createClient<frontendPaths>({ baseUrl: frontendUrl, fetch, headers }),\n }\n this.identity = {\n customerId,\n conversationId: getConversationId() ?? undefined,\n sessionId: getSessionId() ?? undefined,\n userId: getUserId() ?? undefined,\n }\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 *\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, pageviewId, sessionId, userId } = this.identity\n\n const { data } = await this.endpoint.frontend.POST('/api/tracking/identity/v2', {\n body: {\n customerId,\n sessionId,\n userId,\n },\n })\n\n if (data) {\n if (!pageviewId) {\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 Object.values(this.endpoint).forEach((endpont) => {\n endpont.use(authMiddleware(data.token))\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.productOverrides Overrides for product details.\n *\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?: {\n eligibleProducts?: string[]\n productOverrides?: Record<string, { price: number; minSpeed?: number; maxSpeed?: number }>\n }): Promise<BasicMessage | undefined> {\n this.endConversation()\n\n const conversationContext = {\n availableProductIds: [],\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 const [conversationIdMessage, openingMessage] = data as [ConversationIdMessage, BasicMessage]\n\n const conversationId = conversationIdMessage.conversationId\n if (!conversationId) {\n throw new Error('Conversation ID not received')\n }\n\n setConversationId(conversationId)\n this.identity.conversationId = conversationId\n\n return openingMessage\n }\n\n /**\n * Sends a message in the conversation.\n *\n * @param options - An object containing the user message.\n * @returns A promise that resolves to an array of messages\n *\n * @example\n * ```ts\n * const newMessages = await client.sendMessage({\n * userMessage: 'How can I get support?',\n * })\n *\n * if (newMessages) {\n * console.log('Received messages:', newMessages)\n * } else {\n * console.log('No message received')\n * }\n * ```\n */\n async sendMessage({\n userMessage,\n }: {\n userMessage: string\n }): Promise<Exclude<Message, ConversationIdMessage | DebugMessage>[] | undefined> {\n const { data } = await this.endpoint.conversation.POST('/api/conversation/v3', {\n body: {\n conversationId: this.identity.conversationId,\n userMessage,\n type: 'MESSAGE',\n },\n })\n\n if (!data) return undefined\n\n // Log debug messages\n // These will only be in the response when used in internal testing\n const debugMessages = data.filter((message) => message.type === 'DEBUG')\n if (debugMessages.length) {\n console.info('Debug messages:', debugMessages)\n }\n\n // When a request does not contain a conversation ID, the API will return a new conversation ID as the first message\n const conversationId = data.find((message) => message.type === 'CONVERSATION_ID')?.conversationId\n if (conversationId) {\n setConversationId(conversationId)\n this.identity.conversationId = conversationId\n }\n\n const messages = data.filter((message) => message.type !== 'CONVERSATION_ID' && message.type !== 'DEBUG')\n return messages\n }\n\n /**\n * Sends an event to the tracking API, with the required properties already set.\n *\n * @param eventName - The name of the event to track.\n * @param properties - Additional properties to include in the event.\n * @returns A promise that resolves once the event is tracked.\n *\n * @example\n * ```ts\n * await client.trackEvent('tab-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 deviceType: undefined,\n eventName,\n pageviewId: this.identity.pageviewId,\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 * 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","const 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'\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 = 1000 * 60 * 60 * 24 * 30 // 30 days\n\n/**\n * Retrieves the user ID from `localStorage`.\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 = () => getItemWithExpiry(USER_ID)\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","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 request.headers.set('Authorization', `Bearer ${accessToken}`)\n\n return request\n },\n})\n\nexport default authMiddleware\n","{\n \"name\": \"@15gifts/sdk\",\n \"version\": \"0.6.3\",\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 \"dev\": \"tsup --watch\",\n \"format\": \"prettier . --write\",\n \"generate\": \"npx openapi-typescript\",\n \"lint\": \"eslint .\",\n \"test\": \"vitest run\",\n \"test:watch\": \"vitest\",\n \"typecheck\": \"tsc\"\n },\n \"dependencies\": {\n \"openapi-fetch\": \"^0.13.3\"\n },\n \"devDependencies\": {\n \"openapi-typescript\": \"^7.4.4\",\n \"tsup\": \"^8.3.5\"\n },\n \"sideEffects\": false,\n \"prettier\": \"prettier-config-custom\"\n}\n"],"mappings":"AAAA,OAAOA,MAAkB,gBCKlB,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,EChBf,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,ECFR,IAAMM,EAAU,oBAQVC,EAAM,IAAO,GAAK,GAAK,GAAK,GAkB5BC,EAAY,IAAMC,EAAkBH,CAAO,EAa3CI,EAAaC,GAAmBC,EAAkBN,EAASK,EAAQJ,CAAG,EC/BnF,IAAMM,EAAkBC,IAAqC,CAC3D,UAAW,MAAO,CAAE,QAAAC,CAAQ,KAC1BA,EAAQ,QAAQ,IAAI,gBAAiB,UAAUD,CAAW,EAAE,EAErDC,EAEX,GAEOC,EAAQH,ECrBb,IAAAI,EAAW,QP2BN,IAAMC,EAAN,KAAa,CAUlB,SAKA,SAYA,YAAY,CAAE,WAAAC,EAAY,MAAAC,EAAO,gBAAAC,EAAiB,YAAAC,CAAY,EAAW,CACvE,IAAMC,EAAU,CACd,gBAAiBC,CACnB,EAEA,KAAK,SAAW,CACd,aAAcC,EAAgC,CAAE,QAASJ,EAAiB,MAAAD,EAAO,QAAAG,CAAQ,CAAC,EAC1F,SAAUE,EAA4B,CAAE,QAASH,EAAa,MAAAF,EAAO,QAAAG,CAAQ,CAAC,CAChF,EACA,KAAK,SAAW,CACd,WAAAJ,EACA,eAAgBO,EAAkB,GAAK,OACvC,UAAWC,EAAa,GAAK,OAC7B,OAAQC,EAAU,GAAK,MACzB,CACF,CAcA,MAAM,gBAAgC,CACpC,GAAM,CAAE,WAAAT,EAAY,WAAAU,EAAY,UAAAC,EAAW,OAAAC,CAAO,EAAI,KAAK,SAErD,CAAE,KAAAC,CAAK,EAAI,MAAM,KAAK,SAAS,SAAS,KAAK,4BAA6B,CAC9E,KAAM,CACJ,WAAAb,EACA,UAAAW,EACA,OAAAC,CACF,CACF,CAAC,EAEGC,IACGH,IACH,KAAK,SAAS,WAAaG,EAAK,YAE7BF,IACH,KAAK,SAAS,UAAYE,EAAK,UAC/BC,EAAaD,EAAK,SAAS,GAExBD,IACH,KAAK,SAAS,OAASC,EAAK,OAC5BE,EAAUF,EAAK,MAAM,GAGvB,OAAO,OAAO,KAAK,QAAQ,EAAE,QAASG,GAAY,CAChDA,EAAQ,IAAIC,EAAeJ,EAAK,KAAK,CAAC,CACxC,CAAC,EAEL,CAWA,iBAAwB,CACtBK,EAAqB,EACrB,KAAK,SAAS,eAAiB,MACjC,CAyBA,MAAM,kBAAkBC,EAGc,CACpC,KAAK,gBAAgB,EAErB,IAAMC,EAAsB,CAC1B,oBAAqB,CAAC,EACtB,GAAGD,CACL,EAEM,CAAE,KAAAN,CAAK,EAAI,MAAM,KAAK,SAAS,aAAa,KAAK,uBAAwB,CAC7E,KAAM,CACJ,KAAM,qBACN,oBAAAO,CACF,CACF,CAAC,EAEK,CAACC,EAAuBC,CAAc,EAAIT,EAE1CU,EAAiBF,EAAsB,eAC7C,GAAI,CAACE,EACH,MAAM,IAAI,MAAM,8BAA8B,EAGhD,OAAAC,EAAkBD,CAAc,EAChC,KAAK,SAAS,eAAiBA,EAExBD,CACT,CAqBA,MAAM,YAAY,CAChB,YAAAG,CACF,EAEkF,CAChF,GAAM,CAAE,KAAAZ,CAAK,EAAI,MAAM,KAAK,SAAS,aAAa,KAAK,uBAAwB,CAC7E,KAAM,CACJ,eAAgB,KAAK,SAAS,eAC9B,YAAAY,EACA,KAAM,SACR,CACF,CAAC,EAED,GAAI,CAACZ,EAAM,OAIX,IAAMa,EAAgBb,EAAK,OAAQc,GAAYA,EAAQ,OAAS,OAAO,EACnED,EAAc,QAChB,QAAQ,KAAK,kBAAmBA,CAAa,EAI/C,IAAMH,EAAiBV,EAAK,KAAMc,GAAYA,EAAQ,OAAS,iBAAiB,GAAG,eACnF,OAAIJ,IACFC,EAAkBD,CAAc,EAChC,KAAK,SAAS,eAAiBA,GAGhBV,EAAK,OAAQc,GAAYA,EAAQ,OAAS,mBAAqBA,EAAQ,OAAS,OAAO,CAE1G,CAcA,MAAM,WAAWC,EAAuCC,EAAoD,CAC1G,IAAMC,EAAsB,CAC1B,qBAAsBD,EACtB,eAAgB,KAAK,SAAS,eAC9B,WAAY,OACZ,UAAAD,EACA,WAAY,KAAK,SAAS,WAC1B,IAAK,OAAO,SAAS,KACrB,UAAW,OAAO,UAAU,SAC9B,EAEA,OAAO,KAAK,SAAS,SAAS,KAAK,wBAAyB,CAC1D,KAAAE,CACF,CAAC,CACH,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","USER_ID","TTL","getUserId","getItemWithExpiry_default","setUserId","userId","setItemWithExpiry_default","authMiddleware","accessToken","request","auth_default","version","Client","customerId","fetch","conversationUrl","frontendUrl","headers","version","createClient","getConversationId","getSessionId","getUserId","pageviewId","sessionId","userId","data","setSessionId","setUserId","endpont","auth_default","deleteConversationId","context","conversationContext","conversationIdMessage","openingMessage","conversationId","setConversationId","userMessage","debugMessages","message","eventName","properties","body"]}
|
|
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/middlewares/auth.ts","../package.json"],"sourcesContent":["import createClient, { type ClientOptions } from 'openapi-fetch'\n\nimport {\n deleteConversationId,\n getConversationId,\n getSessionId,\n getUserId,\n setConversationId,\n setSessionId,\n setUserId,\n} from './identity'\nimport { authMiddleware } from './middlewares'\nimport type { paths as conversationPaths } from './schemas/conversation'\nimport type { paths as frontendPaths } from './schemas/frontend'\nimport type {\n BasicMessage,\n Config,\n ConversationIdMessage,\n DebugMessage,\n Endpoint,\n Identity,\n Message,\n TrackingEvent,\n} from './types'\nimport { version } from '../package.json'\n\n/**\n * The `Client` class provides methods to manage 15gifts API.\n */\nexport class Client {\n /**\n * This can be used to interact with the APIs directly. It is recommended to use the [helper methods](/sdk/sdk-reference/classes/client/#methods) provided by the `Client` class instead.\n *\n * @example\n * ```ts\n * const client = new Client({ customerId: 'YOUR_CUSTOMER_ID' })\n * const { data } = await client.endpoint.conversation.POST('/api/conversation/v2')\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>({ baseUrl: conversationUrl, fetch, headers }),\n frontend: createClient<frontendPaths>({ baseUrl: frontendUrl, fetch, headers }),\n }\n this.identity = {\n customerId,\n conversationId: getConversationId() ?? undefined,\n sessionId: getSessionId() ?? undefined,\n userId: getUserId() ?? undefined,\n }\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 *\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, pageviewId, sessionId, userId } = this.identity\n\n const { data } = await this.endpoint.frontend.POST('/api/tracking/identity/v2', {\n body: {\n customerId,\n sessionId,\n userId,\n },\n })\n\n if (data) {\n if (!pageviewId) {\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 Object.values(this.endpoint).forEach((endpont) => {\n endpont.use(authMiddleware(data.token))\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.productOverrides Overrides for product details.\n *\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?: {\n eligibleProducts?: string[]\n productOverrides?: Record<string, { price: number; minSpeed?: number; maxSpeed?: number }>\n }): Promise<BasicMessage | undefined> {\n this.endConversation()\n\n const conversationContext = {\n availableProductIds: [],\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 const [conversationIdMessage, openingMessage] = data as [ConversationIdMessage, BasicMessage]\n\n const conversationId = conversationIdMessage.conversationId\n if (!conversationId) {\n throw new Error('Conversation ID not received')\n }\n\n setConversationId(conversationId)\n this.identity.conversationId = conversationId\n\n return openingMessage\n }\n\n /**\n * Sends a message in the conversation.\n *\n * @param options - An object containing the user message.\n * @returns A promise that resolves to an array of messages\n *\n * @example\n * ```ts\n * const newMessages = await client.sendMessage({\n * userMessage: 'How can I get support?',\n * })\n *\n * if (newMessages) {\n * console.log('Received messages:', newMessages)\n * } else {\n * console.log('No message received')\n * }\n * ```\n */\n async sendMessage({\n userMessage,\n }: {\n userMessage: string\n }): Promise<Exclude<Message, ConversationIdMessage | DebugMessage>[] | undefined> {\n const { data } = await this.endpoint.conversation.POST('/api/conversation/v3', {\n body: {\n conversationId: this.identity.conversationId,\n userMessage,\n type: 'MESSAGE',\n },\n })\n\n if (!data) return undefined\n\n // Log debug messages\n // These will only be in the response when used in internal testing\n const debugMessages = data.filter((message) => message.type === 'DEBUG')\n if (debugMessages.length) {\n console.info('Debug messages:', debugMessages)\n }\n\n // When a request does not contain a conversation ID, the API will return a new conversation ID as the first message\n const conversationId = data.find((message) => message.type === 'CONVERSATION_ID')?.conversationId\n if (conversationId) {\n setConversationId(conversationId)\n this.identity.conversationId = conversationId\n }\n\n const messages = data.filter((message) => message.type !== 'CONVERSATION_ID' && message.type !== 'DEBUG')\n return messages\n }\n\n /**\n * Sends an event to the tracking API, with the required properties already set.\n *\n * @param eventName - The name of the event to track.\n * @param properties - Additional properties to include in the event.\n * @returns A promise that resolves once the event is tracked.\n *\n * @example\n * ```ts\n * await client.trackEvent('entry_point-shown')\n * ```\n */\n async trackEvent(eventName: TrackingEvent['eventName'], properties?: TrackingEvent['additionalProperties']) {\n const body: TrackingEvent = {\n additionalProperties: properties,\n conversationId: this.identity.conversationId,\n deviceType: undefined,\n eventName,\n pageviewId: this.identity.pageviewId,\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 * 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","const 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'\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 = 1000 * 60 * 60 * 24 * 30 // 30 days\n\n/**\n * Retrieves the user ID from `localStorage`.\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 = () => getItemWithExpiry(USER_ID)\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","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 request.headers.set('Authorization', `Bearer ${accessToken}`)\n\n return request\n },\n})\n\nexport default authMiddleware\n","{\n \"name\": \"@15gifts/sdk\",\n \"version\": \"0.7.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 \"dev\": \"tsup --watch\",\n \"format\": \"prettier . --write\",\n \"generate\": \"npx openapi-typescript\",\n \"lint\": \"eslint .\",\n \"test\": \"vitest run\",\n \"test:watch\": \"vitest\",\n \"typecheck\": \"tsc\"\n },\n \"dependencies\": {\n \"openapi-fetch\": \"^0.13.3\"\n },\n \"devDependencies\": {\n \"openapi-typescript\": \"^7.4.4\",\n \"tsup\": \"^8.3.5\"\n },\n \"sideEffects\": false,\n \"prettier\": \"prettier-config-custom\"\n}\n"],"mappings":"AAAA,OAAOA,MAA0C,gBCK1C,IAAMC,EAAkB,4BAalBC,EAAuB,IAAM,eAAe,WAAWD,CAAe,EAkBtEE,EAAoB,IAAM,eAAe,QAAQF,CAAe,EAahEG,EAAqBC,GAA2B,eAAe,QAAQJ,EAAiBI,CAAc,EC5C5G,IAAMC,EAAa,uBAkBbC,EAAe,IAAM,eAAe,QAAQD,CAAU,EAatDE,EAAgBC,GAAsB,eAAe,QAAQH,EAAYG,CAAS,ECpC/F,IAAMC,EAAqBC,GAAgB,CACzC,IAAMC,EAAa,aAAa,QAAQD,CAAG,EAE3C,GAAI,CAACC,EAAY,OAAO,KAExB,IAAMC,EAAO,KAAK,MAAMD,CAAU,EAElC,OAAI,KAAK,IAAI,EAAIC,EAAK,SACpB,aAAa,WAAWF,CAAG,EAEpB,MAGFE,EAAK,KACd,EAEOC,EAAQJ,EChBf,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,ECFR,IAAMM,EAAU,oBAQVC,EAAM,IAAO,GAAK,GAAK,GAAK,GAkB5BC,EAAY,IAAMC,EAAkBH,CAAO,EAa3CI,EAAaC,GAAmBC,EAAkBN,EAASK,EAAQJ,CAAG,EC/BnF,IAAMM,EAAkBC,IAAqC,CAC3D,UAAW,MAAO,CAAE,QAAAC,CAAQ,KAC1BA,EAAQ,QAAQ,IAAI,gBAAiB,UAAUD,CAAW,EAAE,EAErDC,EAEX,GAEOC,EAAQH,ECrBb,IAAAI,EAAW,QP2BN,IAAMC,EAAN,KAAa,CAUlB,SAKA,SAYA,YAAYC,EAAgB,CAC1B,GAAM,CAAE,gBAAAC,EAAiB,WAAAC,EAAY,MAAAC,EAAO,YAAAC,EAAa,QAASC,CAAe,EAAIL,EAE/EM,EAAoC,CACxC,GAAGD,EACH,gBAAiBE,CACnB,EAEA,KAAK,SAAW,CACd,aAAcC,EAAgC,CAAE,QAASP,EAAiB,MAAAE,EAAO,QAAAG,CAAQ,CAAC,EAC1F,SAAUE,EAA4B,CAAE,QAASJ,EAAa,MAAAD,EAAO,QAAAG,CAAQ,CAAC,CAChF,EACA,KAAK,SAAW,CACd,WAAAJ,EACA,eAAgBO,EAAkB,GAAK,OACvC,UAAWC,EAAa,GAAK,OAC7B,OAAQC,EAAU,GAAK,MACzB,CACF,CAcA,MAAM,gBAAgC,CACpC,GAAM,CAAE,WAAAT,EAAY,WAAAU,EAAY,UAAAC,EAAW,OAAAC,CAAO,EAAI,KAAK,SAErD,CAAE,KAAAC,CAAK,EAAI,MAAM,KAAK,SAAS,SAAS,KAAK,4BAA6B,CAC9E,KAAM,CACJ,WAAAb,EACA,UAAAW,EACA,OAAAC,CACF,CACF,CAAC,EAEGC,IACGH,IACH,KAAK,SAAS,WAAaG,EAAK,YAE7BF,IACH,KAAK,SAAS,UAAYE,EAAK,UAC/BC,EAAaD,EAAK,SAAS,GAExBD,IACH,KAAK,SAAS,OAASC,EAAK,OAC5BE,EAAUF,EAAK,MAAM,GAGvB,OAAO,OAAO,KAAK,QAAQ,EAAE,QAASG,GAAY,CAChDA,EAAQ,IAAIC,EAAeJ,EAAK,KAAK,CAAC,CACxC,CAAC,EAEL,CAWA,iBAAwB,CACtBK,EAAqB,EACrB,KAAK,SAAS,eAAiB,MACjC,CAyBA,MAAM,kBAAkBC,EAGc,CACpC,KAAK,gBAAgB,EAErB,IAAMC,EAAsB,CAC1B,oBAAqB,CAAC,EACtB,GAAGD,CACL,EAEM,CAAE,KAAAN,CAAK,EAAI,MAAM,KAAK,SAAS,aAAa,KAAK,uBAAwB,CAC7E,KAAM,CACJ,KAAM,qBACN,oBAAAO,CACF,CACF,CAAC,EAEK,CAACC,EAAuBC,CAAc,EAAIT,EAE1CU,EAAiBF,EAAsB,eAC7C,GAAI,CAACE,EACH,MAAM,IAAI,MAAM,8BAA8B,EAGhD,OAAAC,EAAkBD,CAAc,EAChC,KAAK,SAAS,eAAiBA,EAExBD,CACT,CAqBA,MAAM,YAAY,CAChB,YAAAG,CACF,EAEkF,CAChF,GAAM,CAAE,KAAAZ,CAAK,EAAI,MAAM,KAAK,SAAS,aAAa,KAAK,uBAAwB,CAC7E,KAAM,CACJ,eAAgB,KAAK,SAAS,eAC9B,YAAAY,EACA,KAAM,SACR,CACF,CAAC,EAED,GAAI,CAACZ,EAAM,OAIX,IAAMa,EAAgBb,EAAK,OAAQc,GAAYA,EAAQ,OAAS,OAAO,EACnED,EAAc,QAChB,QAAQ,KAAK,kBAAmBA,CAAa,EAI/C,IAAMH,EAAiBV,EAAK,KAAMc,GAAYA,EAAQ,OAAS,iBAAiB,GAAG,eACnF,OAAIJ,IACFC,EAAkBD,CAAc,EAChC,KAAK,SAAS,eAAiBA,GAGhBV,EAAK,OAAQc,GAAYA,EAAQ,OAAS,mBAAqBA,EAAQ,OAAS,OAAO,CAE1G,CAcA,MAAM,WAAWC,EAAuCC,EAAoD,CAC1G,IAAMC,EAAsB,CAC1B,qBAAsBD,EACtB,eAAgB,KAAK,SAAS,eAC9B,WAAY,OACZ,UAAAD,EACA,WAAY,KAAK,SAAS,WAC1B,IAAK,OAAO,SAAS,KACrB,UAAW,OAAO,UAAU,SAC9B,EAEA,OAAO,KAAK,SAAS,SAAS,KAAK,wBAAyB,CAC1D,KAAAE,CACF,CAAC,CACH,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","USER_ID","TTL","getUserId","getItemWithExpiry_default","setUserId","userId","setItemWithExpiry_default","authMiddleware","accessToken","request","auth_default","version","Client","config","conversationUrl","customerId","fetch","frontendUrl","defaultHeaders","headers","version","createClient","getConversationId","getSessionId","getUserId","pageviewId","sessionId","userId","data","setSessionId","setUserId","endpont","auth_default","deleteConversationId","context","conversationContext","conversationIdMessage","openingMessage","conversationId","setConversationId","userMessage","debugMessages","message","eventName","properties","body"]}
|