@15gifts/sdk 0.24.1 → 0.24.2
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.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.js
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
"use strict";var R=Object.create;var d=Object.defineProperty;var P=Object.getOwnPropertyDescriptor;var O=Object.getOwnPropertyNames;var _=Object.getPrototypeOf,k=Object.prototype.hasOwnProperty;var U=(e,t)=>{for(var s in t)d(e,s,{get:t[s],enumerable:!0})},x=(e,t,s,o)=>{if(t&&typeof t=="object"||typeof t=="function")for(let n of O(t))!k.call(e,n)&&n!==s&&d(e,n,{get:()=>t[n],enumerable:!(o=P(t,n))||o.enumerable});return e};var N=(e,t,s)=>(s=e!=null?R(_(e)):{},x(t||!e||!e.__esModule?d(s,"default",{value:e,enumerable:!0}):s,e)),b=e=>x(d({},"__esModule",{value:!0}),e);var se={};U(se,{Client:()=>E,SDKError:()=>r,authMiddleware:()=>p,errorMiddleware:()=>g,headerMiddleware:()=>u});module.exports=b(se);var M=N(require("openapi-fetch"));var V=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},y=V;var L=(e,t,s)=>{let o={expires:Date.now()+s,value:t};localStorage.setItem(e,JSON.stringify(o))},m=L;var D=1e3*60*60*24,G=D*30,f="__15gifts_conversation_id",S="__15gifts_session_id",h="__15gifts_identity_token",T="__15gifts_user_id",j=()=>sessionStorage.removeItem(f),q=()=>sessionStorage.getItem(f),K=e=>sessionStorage.setItem(f,e),W=()=>sessionStorage.getItem(S),H=e=>sessionStorage.setItem(S,e),X=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}},B=()=>{let e=localStorage.getItem(h);return!e||X(e)?(localStorage.removeItem(h),null):e},$=e=>localStorage.setItem(h,e),F=()=>{let e=y(T);return e&&C(e),e},C=e=>m(T,e,G),c=(e,t,s)=>({enumerable:!0,configurable:!0,get:()=>e()??void 0,set:o=>{if(o){t(o);return}s?.()}}),w=e=>{let t={customerId:e},s={conversationId:c(q,K,j),sessionId:c(W,H),token:c(B,$),userId:c(F,C)};return Object.defineProperties(t,s),t};var J=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=J;var z={onResponse:async({response:e})=>{if(!e.ok){let t=await e.json();throw new Error(t.message)}return e}},g=z;var Q=(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)}),u=Q;var I=e=>{let{conversationId:t,...s}=e;return s},Y=(e,t)=>t?.assistantMessages.find(n=>n.type==="SINGLE_SELECT")?.options.find(n=>n.value===e.option)?.label||"",Z=(e,t)=>{let{userMessage:s}=e;switch(s.type){case"SINGLE_SELECT":return{...I(s),userMessage:Y(s,t)};case"START_CONVERSATION":return{type:"MESSAGE",userMessage:s.openingUserMessage?.option||""};case"MESSAGE":return I(s);case"MULTI_SELECT":return I(s)}},ee=(e,t)=>{let s=!!t;return e.assistantMessages.filter(o=>o.type!=="CONVERSATION_ID"&&!(s&&o.type==="SINGLE_SELECT"))},A=e=>e.map((t,s)=>{let o=s>0?e[s-1]:void 0,n=s<e.length-1?e[s+1]:void 0;return{id:`restored-turn-${s}`,userMessage:Z(t,o),assistantReply:ee(t,n)}});var l="0.24.
|
|
1
|
+
"use strict";var R=Object.create;var d=Object.defineProperty;var P=Object.getOwnPropertyDescriptor;var O=Object.getOwnPropertyNames;var _=Object.getPrototypeOf,k=Object.prototype.hasOwnProperty;var U=(e,t)=>{for(var s in t)d(e,s,{get:t[s],enumerable:!0})},x=(e,t,s,o)=>{if(t&&typeof t=="object"||typeof t=="function")for(let n of O(t))!k.call(e,n)&&n!==s&&d(e,n,{get:()=>t[n],enumerable:!(o=P(t,n))||o.enumerable});return e};var N=(e,t,s)=>(s=e!=null?R(_(e)):{},x(t||!e||!e.__esModule?d(s,"default",{value:e,enumerable:!0}):s,e)),b=e=>x(d({},"__esModule",{value:!0}),e);var se={};U(se,{Client:()=>E,SDKError:()=>r,authMiddleware:()=>p,errorMiddleware:()=>g,headerMiddleware:()=>u});module.exports=b(se);var M=N(require("openapi-fetch"));var V=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},y=V;var L=(e,t,s)=>{let o={expires:Date.now()+s,value:t};localStorage.setItem(e,JSON.stringify(o))},m=L;var D=1e3*60*60*24,G=D*30,f="__15gifts_conversation_id",S="__15gifts_session_id",h="__15gifts_identity_token",T="__15gifts_user_id",j=()=>sessionStorage.removeItem(f),q=()=>sessionStorage.getItem(f),K=e=>sessionStorage.setItem(f,e),W=()=>sessionStorage.getItem(S),H=e=>sessionStorage.setItem(S,e),X=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}},B=()=>{let e=localStorage.getItem(h);return!e||X(e)?(localStorage.removeItem(h),null):e},$=e=>localStorage.setItem(h,e),F=()=>{let e=y(T);return e&&C(e),e},C=e=>m(T,e,G),c=(e,t,s)=>({enumerable:!0,configurable:!0,get:()=>e()??void 0,set:o=>{if(o){t(o);return}s?.()}}),w=e=>{let t={customerId:e},s={conversationId:c(q,K,j),sessionId:c(W,H),token:c(B,$),userId:c(F,C)};return Object.defineProperties(t,s),t};var J=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=J;var z={onResponse:async({response:e})=>{if(!e.ok){let t=await e.json();throw new Error(t.message)}return e}},g=z;var Q=(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)}),u=Q;var I=e=>{let{conversationId:t,...s}=e;return s},Y=(e,t)=>t?.assistantMessages.find(n=>n.type==="SINGLE_SELECT")?.options.find(n=>n.value===e.option)?.label||"",Z=(e,t)=>{let{userMessage:s}=e;switch(s.type){case"SINGLE_SELECT":return{...I(s),userMessage:Y(s,t)};case"START_CONVERSATION":return{type:"MESSAGE",userMessage:s.openingUserMessage?.option||""};case"MESSAGE":return I(s);case"MULTI_SELECT":return I(s)}},ee=(e,t)=>{let s=!!t;return e.assistantMessages.filter(o=>o.type!=="CONVERSATION_ID"&&!(s&&o.type==="SINGLE_SELECT"))},A=e=>e.map((t,s)=>{let o=s>0?e[s-1]:void 0,n=s<e.length-1?e[s+1]:void 0;return{id:`restored-turn-${s}`,userMessage:Z(t,o),assistantReply:ee(t,n)}});var l="0.24.2";var r=class e extends Error{sdkVersion;cause;constructor(t,{cause:s}={}){super(t),this.name="SDKError",this.cause=s,this.sdkVersion=l,Object.setPrototypeOf(this,e.prototype)}};var E=class{endpoint;identity;constructor(t){let{conversationUrl:s,customerId:o,fetch:n,frontendUrl:i,headers:v}=t,a={...v,"X-SDK-VERSION":l};this.endpoint={conversation:(0,M.default)({baseUrl:s,fetch:n,headers:a,credentials:"include"}),frontend:(0,M.default)({baseUrl:i,fetch:n,headers:a})},this.identity=w(o),this.endpoint.conversation.use(g),this.endpoint.conversation.use(u(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 r("No data received from identity API");this.identity.pageviewId=n.pageviewId,s||(this.identity.sessionId=n.sessionId),o||(this.identity.userId=n.userId),this.identity.token=n.token,Object.values(this.endpoint).forEach(i=>{i.use(p(n.token))})}catch(n){throw Object.values(this.endpoint).forEach(i=>{i.use(p())}),new r("Failed to create identity",{cause:n})}}endConversation(){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 r("No data received from Conversation API");let[i,...v]=n,a=i.conversationId;if(!a)throw new r("Conversation ID not received in API response");return this.identity.conversationId=a,v}async sendMessage(t){let s=this.identity.conversationId;if(!s)throw new r("Conversation ID not set");let{data:o}=await this.endpoint.conversation.POST("/api/conversation/v3",{body:{conversationId:s,...t}});if(!o)throw new r("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 this.identity.token??null}async getConversation(t){if(!t)throw new r("Conversation ID not set");try{let{data:s}=await this.endpoint.conversation.GET("/api/conversation/{conversation_id}/v1",{params:{path:{conversation_id:t}}});if(this.identity.conversationId=t,!s)throw new r("No data received from conversation history API");return A(s)}catch(s){throw new r("Failed to get conversation history",{cause:s})}}};0&&(module.exports={Client,SDKError,authMiddleware,errorMiddleware,headerMiddleware});
|
|
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/utils/getItemWithExpiry.ts","../src/utils/setItemWithExpiry.ts","../src/identity/createIdentityStore.ts","../src/middlewares/auth.ts","../src/middlewares/error.ts","../src/middlewares/headers.ts","../src/restoreConversation/restoreConversation.ts","../package.json","../src/utils/SDKError.ts"],"sourcesContent":["export * from './client'\nexport * from './middlewares'\nexport * from './types'\n","import createClient, { type ClientOptions } from 'openapi-fetch'\n\nimport { createIdentityStore } from './identity/createIdentityStore'\nimport { authMiddleware, errorMiddleware, headerMiddleware } from './middlewares'\nimport { restoreConversation } from './restoreConversation/restoreConversation'\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 RestoredTurn,\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 = createIdentityStore(customerId)\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 }\n if (!userId) {\n this.identity.userId = data.userId\n }\n\n this.identity.token = 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 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 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): Promise<Message[]> {\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 * Use this method to retrieve the token for use in other parts of your system,\n * such as calling the Humara sales tracking API\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 this.identity.token ?? null\n }\n\n /**\n * Gets the conversation history for a given conversation ID.\n *\n * @param conversationId - The ID of the conversation to retrieve.\n * @returns A promise that resolves to the conversation history as an array of turns. Each turn contains a user message and its corresponding response.\n */\n async getConversation(conversationId: string): Promise<RestoredTurn[]> {\n if (!conversationId) {\n throw new SDKError('Conversation ID not set')\n }\n\n try {\n const { data } = await this.endpoint.conversation.GET('/api/conversation/{conversation_id}/v1', {\n params: {\n path: {\n conversation_id: conversationId,\n },\n },\n })\n\n // Sets the current conversation ID to the one just retrieved, so that subsequent calls to `sendMessage` and `trackEvent` will use this conversation ID.\n this.identity.conversationId = conversationId\n\n if (!data) throw new SDKError('No data received from conversation history API')\n\n return restoreConversation(data)\n } catch (error) {\n throw new SDKError('Failed to get conversation history', {\n cause: error as Error,\n })\n }\n }\n}\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 type { Config, Identity } from '../types'\nimport { getItemWithExpiry, setItemWithExpiry } from '../utils'\n\ntype IdentityKey = 'conversationId' | 'sessionId' | 'token' | 'userId'\n\nconst day = 1000 * 60 * 60 * 24\nconst userIdTtl = day * 30\n\nconst conversationIdKey = '__15gifts_conversation_id'\nconst sessionIdKey = '__15gifts_session_id'\nconst tokenKey = '__15gifts_identity_token'\nconst userIdKey = '__15gifts_user_id'\n\nconst deleteConversationId = () => sessionStorage.removeItem(conversationIdKey)\nconst getConversationId = () => sessionStorage.getItem(conversationIdKey)\nconst setConversationId = (conversationId: string) => sessionStorage.setItem(conversationIdKey, conversationId)\n\nconst getSessionId = () => sessionStorage.getItem(sessionIdKey)\nconst setSessionId = (sessionId: string) => sessionStorage.setItem(sessionIdKey, sessionId)\n\nconst 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\nconst getToken = (): string | null => {\n const token = localStorage.getItem(tokenKey)\n\n if (!token || isTokenExpired(token)) {\n localStorage.removeItem(tokenKey)\n return null\n }\n\n return token\n}\n\nconst setToken = (token: string) => localStorage.setItem(tokenKey, token)\n\nconst getUserId = () => {\n const userId = getItemWithExpiry(userIdKey)\n\n if (userId) {\n setUserId(userId)\n }\n\n return userId\n}\n\nconst setUserId = (userId: string) => setItemWithExpiry(userIdKey, userId, userIdTtl)\n\nconst createIdentityProperty = (\n getValue: () => string | null,\n setValue: (value: string) => void,\n clearValue?: () => void,\n): PropertyDescriptor => ({\n enumerable: true,\n configurable: true,\n get: () => getValue() ?? undefined,\n set: (value: string | undefined) => {\n if (value) {\n setValue(value)\n return\n }\n\n clearValue?.()\n },\n})\n\n/**\n * Creates an identity object backed by browser storage.\n *\n * The returned object exposes the public `Identity` shape while keeping\n * `conversationId`, `sessionId`, and `userId` synchronized with their\n * corresponding storage helpers.\n */\nexport const createIdentityStore = (customerId: Config['customerId']): Identity => {\n const identity: Identity = {\n customerId,\n }\n\n const properties: Record<IdentityKey, PropertyDescriptor> = {\n conversationId: createIdentityProperty(getConversationId, setConversationId, deleteConversationId),\n sessionId: createIdentityProperty(getSessionId, setSessionId),\n token: createIdentityProperty(getToken, setToken),\n userId: createIdentityProperty(getUserId, setUserId),\n }\n\n Object.defineProperties(identity, properties)\n\n return identity\n}\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 * The GET `/api/conversation/{conversation_id}` endpoint returns data as a historical record, but\n * it makes little sense when rendered.\n * We transform it so that the user doesn't see all single_select messages again, only the option\n * they selected.\n **/\n\nimport type { ConversationTurn, Message, SingleSelectMessage, UserSingleSelectMessage, RestoredTurn } from '../types'\n\n/**\n * Removes the conversationId from the user message, as this is not needed for rendering and would just add noise.\n */\nconst stripConversationId = <T extends { conversationId?: string }>(userMessage: T): Omit<T, 'conversationId'> => {\n // eslint-disable-next-line @typescript-eslint/no-unused-vars\n const { conversationId, ...rest } = userMessage\n\n return rest\n}\n\n// We have the string that was sent to the API, this finds the label for the option that it relates to.\nconst getSelectedOptionLabel = (userMessage: UserSingleSelectMessage, previousTurn?: ConversationTurn) => {\n const previousSingleSelect = previousTurn?.assistantMessages.find(\n (message): message is SingleSelectMessage => message.type === 'SINGLE_SELECT',\n )\n const selectedOption = previousSingleSelect?.options.find((option) => option.value === userMessage.option)\n\n return selectedOption?.label || ''\n}\n\n// Turns the user message back in to how the user would have seen it\nconst getRestoredUserMessage = (\n turn: ConversationTurn,\n previousTurn?: ConversationTurn,\n): RestoredTurn['userMessage'] => {\n const { userMessage } = turn\n\n switch (userMessage.type) {\n case 'SINGLE_SELECT':\n return {\n ...stripConversationId(userMessage),\n userMessage: getSelectedOptionLabel(userMessage, previousTurn),\n }\n\n case 'START_CONVERSATION':\n // There isn't anything we want to render from the START_CONVERSATION message except for the openingUserMessage,\n // which is what the user would have submitted to start the conversation.\n return {\n type: 'MESSAGE',\n userMessage: userMessage.openingUserMessage?.option || '',\n }\n\n case 'MESSAGE':\n return stripConversationId(userMessage)\n\n case 'MULTI_SELECT':\n return stripConversationId(userMessage)\n }\n}\n\n// Turns the assistant message back in to how the user would have seen it\nconst getRestoredAssistantReply = (turn: ConversationTurn, nextTurn?: ConversationTurn) => {\n const shouldHideSingleSelect = Boolean(nextTurn)\n\n return turn.assistantMessages.filter(\n (message): message is Message =>\n message.type !== 'CONVERSATION_ID' && !(shouldHideSingleSelect && message.type === 'SINGLE_SELECT'),\n )\n}\n\nexport const restoreConversation = (turns: ConversationTurn[]): RestoredTurn[] => {\n return turns.map((turn, index) => {\n const previousTurn = index > 0 ? turns[index - 1] : undefined\n const nextTurn = index < turns.length - 1 ? turns[index + 1] : undefined\n\n return {\n id: `restored-turn-${index}`,\n userMessage: getRestoredUserMessage(turn, previousTurn),\n assistantReply: getRestoredAssistantReply(turn, nextTurn),\n }\n })\n}\n","{\n \"name\": \"@15gifts/sdk\",\n \"version\": \"0.24.1\",\n \"files\": [\n \"dist\"\n ],\n \"main\": \"./dist/index.js\",\n \"module\": \"./dist/index.mjs\",\n \"types\": \"./dist/index.d.ts\",\n \"scripts\": {\n \"build\": \"tsup && npm run typecheck:dist\",\n \"coverage\": \"vitest run --coverage\",\n \"generate-types\": \"npx openapi-typescript\",\n \"dev\": \"tsup --watch\",\n \"format\": \"prettier . --write\",\n \"lint\": \"eslint .\",\n \"pact:publish:conversation\": \"tsx scripts/pact/publish-conversation.ts\",\n \"test\": \"vitest run\",\n \"test:consumer:conversation\": \"tsx scripts/pact/consumer-conversation.ts\",\n \"test:watch\": \"vitest\",\n \"typecheck:dist\": \"tsc --noEmit --skipLibCheck true dist/index.d.ts\",\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 \"@pact-foundation/pact\": \"^16.5.0\",\n \"@types/node\": \"^22.15.21\",\n \"call-bound\": \"^1.0.4\",\n \"openapi-typescript\": \"^7.6.0\",\n \"tsup\": \"^8.3.6\",\n \"tsx\": \"^4.20.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,GAAA,GAAAC,EAAAD,GAAA,YAAAE,EAAA,aAAAC,EAAA,mBAAAC,EAAA,oBAAAC,EAAA,qBAAAC,IAAA,eAAAC,EAAAP,ICAA,IAAAQ,EAAiD,4BCAjD,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,ECVf,IAAMM,EAAM,IAAO,GAAK,GAAK,GACvBC,EAAYD,EAAM,GAElBE,EAAoB,4BACpBC,EAAe,uBACfC,EAAW,2BACXC,EAAY,oBAEZC,EAAuB,IAAM,eAAe,WAAWJ,CAAiB,EACxEK,EAAoB,IAAM,eAAe,QAAQL,CAAiB,EAClEM,EAAqBC,GAA2B,eAAe,QAAQP,EAAmBO,CAAc,EAExGC,EAAe,IAAM,eAAe,QAAQP,CAAY,EACxDQ,EAAgBC,GAAsB,eAAe,QAAQT,EAAcS,CAAS,EAEpFC,EAAkBC,GAA2B,CACjD,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,EAEMC,EAAW,IAAqB,CACpC,IAAMJ,EAAQ,aAAa,QAAQV,CAAQ,EAE3C,MAAI,CAACU,GAASD,EAAeC,CAAK,GAChC,aAAa,WAAWV,CAAQ,EACzB,MAGFU,CACT,EAEMK,EAAYL,GAAkB,aAAa,QAAQV,EAAUU,CAAK,EAElEM,EAAY,IAAM,CACtB,IAAMC,EAASC,EAAkBjB,CAAS,EAE1C,OAAIgB,GACFE,EAAUF,CAAM,EAGXA,CACT,EAEME,EAAaF,GAAmBG,EAAkBnB,EAAWgB,EAAQpB,CAAS,EAE9EwB,EAAyB,CAC7BC,EACAC,EACAC,KACwB,CACxB,WAAY,GACZ,aAAc,GACd,IAAK,IAAMF,EAAS,GAAK,OACzB,IAAMG,GAA8B,CAClC,GAAIA,EAAO,CACTF,EAASE,CAAK,EACd,MACF,CAEAD,IAAa,CACf,CACF,GASaE,EAAuBC,GAA+C,CACjF,IAAMC,EAAqB,CACzB,WAAAD,CACF,EAEME,EAAsD,CAC1D,eAAgBR,EAAuBlB,EAAmBC,EAAmBF,CAAoB,EACjG,UAAWmB,EAAuBf,EAAcC,CAAY,EAC5D,MAAOc,EAAuBP,EAAUC,CAAQ,EAChD,OAAQM,EAAuBL,EAAWG,CAAS,CACrD,EAEA,cAAO,iBAAiBS,EAAUC,CAAU,EAErCD,CACT,ECrFA,IAAME,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,ECjBf,IAAMK,EAA8DC,GAA8C,CAEhH,GAAM,CAAE,eAAAC,EAAgB,GAAGC,CAAK,EAAIF,EAEpC,OAAOE,CACT,EAGMC,EAAyB,CAACH,EAAsCI,IACvCA,GAAc,kBAAkB,KAC1DC,GAA4CA,EAAQ,OAAS,eAChE,GAC6C,QAAQ,KAAMC,GAAWA,EAAO,QAAUN,EAAY,MAAM,GAElF,OAAS,GAI5BO,EAAyB,CAC7BC,EACAJ,IACgC,CAChC,GAAM,CAAE,YAAAJ,CAAY,EAAIQ,EAExB,OAAQR,EAAY,KAAM,CACxB,IAAK,gBACH,MAAO,CACL,GAAGD,EAAoBC,CAAW,EAClC,YAAaG,EAAuBH,EAAaI,CAAY,CAC/D,EAEF,IAAK,qBAGH,MAAO,CACL,KAAM,UACN,YAAaJ,EAAY,oBAAoB,QAAU,EACzD,EAEF,IAAK,UACH,OAAOD,EAAoBC,CAAW,EAExC,IAAK,eACH,OAAOD,EAAoBC,CAAW,CAC1C,CACF,EAGMS,GAA4B,CAACD,EAAwBE,IAAgC,CACzF,IAAMC,EAAyB,EAAQD,EAEvC,OAAOF,EAAK,kBAAkB,OAC3BH,GACCA,EAAQ,OAAS,mBAAqB,EAAEM,GAA0BN,EAAQ,OAAS,gBACvF,CACF,EAEaO,EAAuBC,GAC3BA,EAAM,IAAI,CAACL,EAAMM,IAAU,CAChC,IAAMV,EAAeU,EAAQ,EAAID,EAAMC,EAAQ,CAAC,EAAI,OAC9CJ,EAAWI,EAAQD,EAAM,OAAS,EAAIA,EAAMC,EAAQ,CAAC,EAAI,OAE/D,MAAO,CACL,GAAI,iBAAiBA,CAAK,GAC1B,YAAaP,EAAuBC,EAAMJ,CAAY,EACtD,eAAgBK,GAA0BD,EAAME,CAAQ,CAC1D,CACF,CAAC,EC7ED,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,ETIO,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,SAAWG,EAAoBP,CAAU,EAE9C,KAAK,SAAS,aAAa,IAAIQ,CAAe,EAC9C,KAAK,SAAS,aAAa,IAAIC,EAAiB,KAAK,SAAU,OAAO,SAAS,IAAI,CAAC,CACtF,CAeA,MAAM,gBAAgC,CACpC,GAAM,CAAE,WAAAT,EAAY,UAAAU,EAAW,OAAAC,CAAO,EAAI,KAAK,SAE/C,GAAI,CACF,GAAM,CAAE,KAAAC,CAAK,EAAI,MAAM,KAAK,SAAS,SAAS,KAAK,4BAA6B,CAC9E,KAAM,CACJ,WAAAZ,EACA,UAAAU,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,WAE5BD,IACH,KAAK,SAAS,OAASC,EAAK,QAG9B,KAAK,SAAS,MAAQA,EAAK,MAG3B,OAAO,OAAO,KAAK,QAAQ,EAAE,QAASE,GAAa,CACjDA,EAAS,IAAIC,EAAeH,EAAK,KAAK,CAAC,CACzC,CAAC,CACH,OAASI,EAAO,CAGd,aAAO,OAAO,KAAK,QAAQ,EAAE,QAASF,GAAa,CACjDA,EAAS,IAAIC,EAAe,CAAC,CAC/B,CAAC,EACK,IAAIF,EAAS,4BAA6B,CAC9C,MAAOG,CACT,CAAC,CACH,CACF,CAWA,iBAAwB,CACtB,KAAK,SAAS,eAAiB,MACjC,CA0BA,MAAM,kBACJC,EACAC,EACoB,CACpB,KAAK,gBAAgB,EAErB,IAAMC,EAAsB,CAC1B,GAAGF,CACL,EAEM,CAAE,KAAAL,CAAK,EAAI,MAAM,KAAK,SAAS,aAAa,KAAK,uBAAwB,CAC7E,KAAM,CACJ,KAAM,qBACN,oBAAAO,EACA,mBAAoBD,CACtB,CACF,CAAC,EAED,GAAI,CAACN,EAAM,MAAM,IAAIC,EAAS,wCAAwC,EAEtE,GAAM,CAACO,EAAuB,GAAGC,CAAI,EAAIT,EAEnCU,EAAiBF,EAAsB,eAC7C,GAAI,CAACE,EACH,MAAM,IAAIT,EAAS,8CAA8C,EAGnE,YAAK,SAAS,eAAiBS,EAExBD,CACT,CAqBA,MAAM,YAAYE,EAAiD,CACjE,IAAMD,EAAiB,KAAK,SAAS,eACrC,GAAI,CAACA,EACH,MAAM,IAAIT,EAAS,yBAAyB,EAG9C,GAAM,CAAE,KAAAD,CAAK,EAAI,MAAM,KAAK,SAAS,aAAa,KAAK,uBAAwB,CAC7E,KAAM,CACJ,eAAAU,EACA,GAAGC,CACL,CACF,CAAC,EAED,GAAI,CAACX,EAAM,MAAM,IAAIC,EAAS,wCAAwC,EAItE,OAAOD,EAAK,OAAQY,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,CAeA,kBAAkC,CAChC,OAAO,KAAK,SAAS,OAAS,IAChC,CAQA,MAAM,gBAAgBL,EAAiD,CACrE,GAAI,CAACA,EACH,MAAM,IAAIT,EAAS,yBAAyB,EAG9C,GAAI,CACF,GAAM,CAAE,KAAAD,CAAK,EAAI,MAAM,KAAK,SAAS,aAAa,IAAI,yCAA0C,CAC9F,OAAQ,CACN,KAAM,CACJ,gBAAiBU,CACnB,CACF,CACF,CAAC,EAKD,GAFA,KAAK,SAAS,eAAiBA,EAE3B,CAACV,EAAM,MAAM,IAAIC,EAAS,gDAAgD,EAE9E,OAAOe,EAAoBhB,CAAI,CACjC,OAASI,EAAO,CACd,MAAM,IAAIH,EAAS,qCAAsC,CACvD,MAAOG,CACT,CAAC,CACH,CACF,CACF","names":["index_exports","__export","Client","SDKError","auth_default","error_default","headers_default","__toCommonJS","import_openapi_fetch","getItemWithExpiry","key","itemString","item","getItemWithExpiry_default","setItemWithExpiry","key","value","ttl","item","setItemWithExpiry_default","day","userIdTtl","conversationIdKey","sessionIdKey","tokenKey","userIdKey","deleteConversationId","getConversationId","setConversationId","conversationId","getSessionId","setSessionId","sessionId","isTokenExpired","token","payloadBase64","payload","error","getToken","setToken","getUserId","userId","getItemWithExpiry_default","setUserId","setItemWithExpiry_default","createIdentityProperty","getValue","setValue","clearValue","value","createIdentityStore","customerId","identity","properties","authMiddleware","accessToken","request","auth_default","errorMiddleware","response","data","error_default","headerMiddleware","identity","url","request","headers_default","stripConversationId","userMessage","conversationId","rest","getSelectedOptionLabel","previousTurn","message","option","getRestoredUserMessage","turn","getRestoredAssistantReply","nextTurn","shouldHideSingleSelect","restoreConversation","turns","index","version","SDKError","_SDKError","userMessage","cause","version","Client","config","conversationUrl","customerId","fetch","frontendUrl","defaultHeaders","headers","version","createClient","createIdentityStore","error_default","headers_default","sessionId","userId","data","SDKError","endpoint","auth_default","error","context","userMessage","conversationContext","conversationIdMessage","rest","conversationId","payload","message","eventName","properties","body","restoreConversation"]}
|
|
1
|
+
{"version":3,"sources":["../src/index.ts","../src/client.ts","../src/utils/getItemWithExpiry.ts","../src/utils/setItemWithExpiry.ts","../src/identity/createIdentityStore.ts","../src/middlewares/auth.ts","../src/middlewares/error.ts","../src/middlewares/headers.ts","../src/restoreConversation/restoreConversation.ts","../package.json","../src/utils/SDKError.ts"],"sourcesContent":["export * from './client'\nexport * from './middlewares'\nexport * from './types'\n","import createClient, { type ClientOptions } from 'openapi-fetch'\n\nimport { createIdentityStore } from './identity/createIdentityStore'\nimport { authMiddleware, errorMiddleware, headerMiddleware } from './middlewares'\nimport { restoreConversation } from './restoreConversation/restoreConversation'\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 RestoredTurn,\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 = createIdentityStore(customerId)\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 }\n if (!userId) {\n this.identity.userId = data.userId\n }\n\n this.identity.token = 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 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 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): Promise<Message[]> {\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 * Use this method to retrieve the token for use in other parts of your system,\n * such as calling the Humara sales tracking API\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 this.identity.token ?? null\n }\n\n /**\n * Gets the conversation history for a given conversation ID.\n *\n * @param conversationId - The ID of the conversation to retrieve.\n * @returns A promise that resolves to the conversation history as an array of turns. Each turn contains a user message and its corresponding response.\n */\n async getConversation(conversationId: string): Promise<RestoredTurn[]> {\n if (!conversationId) {\n throw new SDKError('Conversation ID not set')\n }\n\n try {\n const { data } = await this.endpoint.conversation.GET('/api/conversation/{conversation_id}/v1', {\n params: {\n path: {\n conversation_id: conversationId,\n },\n },\n })\n\n // Sets the current conversation ID to the one just retrieved, so that subsequent calls to `sendMessage` and `trackEvent` will use this conversation ID.\n this.identity.conversationId = conversationId\n\n if (!data) throw new SDKError('No data received from conversation history API')\n\n return restoreConversation(data)\n } catch (error) {\n throw new SDKError('Failed to get conversation history', {\n cause: error as Error,\n })\n }\n }\n}\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 type { Config, Identity } from '../types'\nimport { getItemWithExpiry, setItemWithExpiry } from '../utils'\n\ntype IdentityKey = 'conversationId' | 'sessionId' | 'token' | 'userId'\n\nconst day = 1000 * 60 * 60 * 24\nconst userIdTtl = day * 30\n\nconst conversationIdKey = '__15gifts_conversation_id'\nconst sessionIdKey = '__15gifts_session_id'\nconst tokenKey = '__15gifts_identity_token'\nconst userIdKey = '__15gifts_user_id'\n\nconst deleteConversationId = () => sessionStorage.removeItem(conversationIdKey)\nconst getConversationId = () => sessionStorage.getItem(conversationIdKey)\nconst setConversationId = (conversationId: string) => sessionStorage.setItem(conversationIdKey, conversationId)\n\nconst getSessionId = () => sessionStorage.getItem(sessionIdKey)\nconst setSessionId = (sessionId: string) => sessionStorage.setItem(sessionIdKey, sessionId)\n\nconst 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\nconst getToken = (): string | null => {\n const token = localStorage.getItem(tokenKey)\n\n if (!token || isTokenExpired(token)) {\n localStorage.removeItem(tokenKey)\n return null\n }\n\n return token\n}\n\nconst setToken = (token: string) => localStorage.setItem(tokenKey, token)\n\nconst getUserId = () => {\n const userId = getItemWithExpiry(userIdKey)\n\n if (userId) {\n setUserId(userId)\n }\n\n return userId\n}\n\nconst setUserId = (userId: string) => setItemWithExpiry(userIdKey, userId, userIdTtl)\n\nconst createIdentityProperty = (\n getValue: () => string | null,\n setValue: (value: string) => void,\n clearValue?: () => void,\n): PropertyDescriptor => ({\n enumerable: true,\n configurable: true,\n get: () => getValue() ?? undefined,\n set: (value: string | undefined) => {\n if (value) {\n setValue(value)\n return\n }\n\n clearValue?.()\n },\n})\n\n/**\n * Creates an identity object backed by browser storage.\n *\n * The returned object exposes the public `Identity` shape while keeping\n * `conversationId`, `sessionId`, and `userId` synchronized with their\n * corresponding storage helpers.\n */\nexport const createIdentityStore = (customerId: Config['customerId']): Identity => {\n const identity: Identity = {\n customerId,\n }\n\n const properties: Record<IdentityKey, PropertyDescriptor> = {\n conversationId: createIdentityProperty(getConversationId, setConversationId, deleteConversationId),\n sessionId: createIdentityProperty(getSessionId, setSessionId),\n token: createIdentityProperty(getToken, setToken),\n userId: createIdentityProperty(getUserId, setUserId),\n }\n\n Object.defineProperties(identity, properties)\n\n return identity\n}\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 * The GET `/api/conversation/{conversation_id}` endpoint returns data as a historical record, but\n * it makes little sense when rendered.\n * We transform it so that the user doesn't see all single_select messages again, only the option\n * they selected.\n **/\n\nimport type { ConversationTurn, Message, SingleSelectMessage, UserSingleSelectMessage, RestoredTurn } from '../types'\n\n/**\n * Removes the conversationId from the user message, as this is not needed for rendering and would just add noise.\n */\nconst stripConversationId = <T extends { conversationId?: string }>(userMessage: T): Omit<T, 'conversationId'> => {\n // eslint-disable-next-line @typescript-eslint/no-unused-vars\n const { conversationId, ...rest } = userMessage\n\n return rest\n}\n\n// We have the string that was sent to the API, this finds the label for the option that it relates to.\nconst getSelectedOptionLabel = (userMessage: UserSingleSelectMessage, previousTurn?: ConversationTurn) => {\n const previousSingleSelect = previousTurn?.assistantMessages.find(\n (message): message is SingleSelectMessage => message.type === 'SINGLE_SELECT',\n )\n const selectedOption = previousSingleSelect?.options.find((option) => option.value === userMessage.option)\n\n return selectedOption?.label || ''\n}\n\n// Turns the user message back in to how the user would have seen it\nconst getRestoredUserMessage = (\n turn: ConversationTurn,\n previousTurn?: ConversationTurn,\n): RestoredTurn['userMessage'] => {\n const { userMessage } = turn\n\n switch (userMessage.type) {\n case 'SINGLE_SELECT':\n return {\n ...stripConversationId(userMessage),\n userMessage: getSelectedOptionLabel(userMessage, previousTurn),\n }\n\n case 'START_CONVERSATION':\n // There isn't anything we want to render from the START_CONVERSATION message except for the openingUserMessage,\n // which is what the user would have submitted to start the conversation.\n return {\n type: 'MESSAGE',\n userMessage: userMessage.openingUserMessage?.option || '',\n }\n\n case 'MESSAGE':\n return stripConversationId(userMessage)\n\n case 'MULTI_SELECT':\n return stripConversationId(userMessage)\n }\n}\n\n// Turns the assistant message back in to how the user would have seen it\nconst getRestoredAssistantReply = (turn: ConversationTurn, nextTurn?: ConversationTurn) => {\n const shouldHideSingleSelect = Boolean(nextTurn)\n\n return turn.assistantMessages.filter(\n (message): message is Message =>\n message.type !== 'CONVERSATION_ID' && !(shouldHideSingleSelect && message.type === 'SINGLE_SELECT'),\n )\n}\n\nexport const restoreConversation = (turns: ConversationTurn[]): RestoredTurn[] => {\n return turns.map((turn, index) => {\n const previousTurn = index > 0 ? turns[index - 1] : undefined\n const nextTurn = index < turns.length - 1 ? turns[index + 1] : undefined\n\n return {\n id: `restored-turn-${index}`,\n userMessage: getRestoredUserMessage(turn, previousTurn),\n assistantReply: getRestoredAssistantReply(turn, nextTurn),\n }\n })\n}\n","{\n \"name\": \"@15gifts/sdk\",\n \"version\": \"0.24.2\",\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 && npm run typecheck:dist\",\n \"coverage\": \"vitest run --coverage\",\n \"generate-types\": \"npx openapi-typescript\",\n \"dev\": \"tsup --watch\",\n \"format\": \"prettier . --write\",\n \"lint\": \"eslint .\",\n \"pact:publish:conversation\": \"tsx scripts/pact/publish-conversation.ts\",\n \"test\": \"vitest run\",\n \"test:consumer:conversation\": \"tsx scripts/pact/consumer-conversation.ts\",\n \"test:watch\": \"vitest\",\n \"typecheck:dist\": \"tsc --noEmit --skipLibCheck true dist/index.d.ts\",\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 \"@pact-foundation/pact\": \"^16.5.0\",\n \"@types/node\": \"^22.15.21\",\n \"call-bound\": \"^1.0.4\",\n \"openapi-typescript\": \"^7.6.0\",\n \"tsup\": \"^8.3.6\",\n \"tsx\": \"^4.20.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,GAAA,GAAAC,EAAAD,GAAA,YAAAE,EAAA,aAAAC,EAAA,mBAAAC,EAAA,oBAAAC,EAAA,qBAAAC,IAAA,eAAAC,EAAAP,ICAA,IAAAQ,EAAiD,4BCAjD,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,ECVf,IAAMM,EAAM,IAAO,GAAK,GAAK,GACvBC,EAAYD,EAAM,GAElBE,EAAoB,4BACpBC,EAAe,uBACfC,EAAW,2BACXC,EAAY,oBAEZC,EAAuB,IAAM,eAAe,WAAWJ,CAAiB,EACxEK,EAAoB,IAAM,eAAe,QAAQL,CAAiB,EAClEM,EAAqBC,GAA2B,eAAe,QAAQP,EAAmBO,CAAc,EAExGC,EAAe,IAAM,eAAe,QAAQP,CAAY,EACxDQ,EAAgBC,GAAsB,eAAe,QAAQT,EAAcS,CAAS,EAEpFC,EAAkBC,GAA2B,CACjD,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,EAEMC,EAAW,IAAqB,CACpC,IAAMJ,EAAQ,aAAa,QAAQV,CAAQ,EAE3C,MAAI,CAACU,GAASD,EAAeC,CAAK,GAChC,aAAa,WAAWV,CAAQ,EACzB,MAGFU,CACT,EAEMK,EAAYL,GAAkB,aAAa,QAAQV,EAAUU,CAAK,EAElEM,EAAY,IAAM,CACtB,IAAMC,EAASC,EAAkBjB,CAAS,EAE1C,OAAIgB,GACFE,EAAUF,CAAM,EAGXA,CACT,EAEME,EAAaF,GAAmBG,EAAkBnB,EAAWgB,EAAQpB,CAAS,EAE9EwB,EAAyB,CAC7BC,EACAC,EACAC,KACwB,CACxB,WAAY,GACZ,aAAc,GACd,IAAK,IAAMF,EAAS,GAAK,OACzB,IAAMG,GAA8B,CAClC,GAAIA,EAAO,CACTF,EAASE,CAAK,EACd,MACF,CAEAD,IAAa,CACf,CACF,GASaE,EAAuBC,GAA+C,CACjF,IAAMC,EAAqB,CACzB,WAAAD,CACF,EAEME,EAAsD,CAC1D,eAAgBR,EAAuBlB,EAAmBC,EAAmBF,CAAoB,EACjG,UAAWmB,EAAuBf,EAAcC,CAAY,EAC5D,MAAOc,EAAuBP,EAAUC,CAAQ,EAChD,OAAQM,EAAuBL,EAAWG,CAAS,CACrD,EAEA,cAAO,iBAAiBS,EAAUC,CAAU,EAErCD,CACT,ECrFA,IAAME,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,ECjBf,IAAMK,EAA8DC,GAA8C,CAEhH,GAAM,CAAE,eAAAC,EAAgB,GAAGC,CAAK,EAAIF,EAEpC,OAAOE,CACT,EAGMC,EAAyB,CAACH,EAAsCI,IACvCA,GAAc,kBAAkB,KAC1DC,GAA4CA,EAAQ,OAAS,eAChE,GAC6C,QAAQ,KAAMC,GAAWA,EAAO,QAAUN,EAAY,MAAM,GAElF,OAAS,GAI5BO,EAAyB,CAC7BC,EACAJ,IACgC,CAChC,GAAM,CAAE,YAAAJ,CAAY,EAAIQ,EAExB,OAAQR,EAAY,KAAM,CACxB,IAAK,gBACH,MAAO,CACL,GAAGD,EAAoBC,CAAW,EAClC,YAAaG,EAAuBH,EAAaI,CAAY,CAC/D,EAEF,IAAK,qBAGH,MAAO,CACL,KAAM,UACN,YAAaJ,EAAY,oBAAoB,QAAU,EACzD,EAEF,IAAK,UACH,OAAOD,EAAoBC,CAAW,EAExC,IAAK,eACH,OAAOD,EAAoBC,CAAW,CAC1C,CACF,EAGMS,GAA4B,CAACD,EAAwBE,IAAgC,CACzF,IAAMC,EAAyB,EAAQD,EAEvC,OAAOF,EAAK,kBAAkB,OAC3BH,GACCA,EAAQ,OAAS,mBAAqB,EAAEM,GAA0BN,EAAQ,OAAS,gBACvF,CACF,EAEaO,EAAuBC,GAC3BA,EAAM,IAAI,CAACL,EAAMM,IAAU,CAChC,IAAMV,EAAeU,EAAQ,EAAID,EAAMC,EAAQ,CAAC,EAAI,OAC9CJ,EAAWI,EAAQD,EAAM,OAAS,EAAIA,EAAMC,EAAQ,CAAC,EAAI,OAE/D,MAAO,CACL,GAAI,iBAAiBA,CAAK,GAC1B,YAAaP,EAAuBC,EAAMJ,CAAY,EACtD,eAAgBK,GAA0BD,EAAME,CAAQ,CAC1D,CACF,CAAC,EC7ED,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,ETIO,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,SAAWG,EAAoBP,CAAU,EAE9C,KAAK,SAAS,aAAa,IAAIQ,CAAe,EAC9C,KAAK,SAAS,aAAa,IAAIC,EAAiB,KAAK,SAAU,OAAO,SAAS,IAAI,CAAC,CACtF,CAeA,MAAM,gBAAgC,CACpC,GAAM,CAAE,WAAAT,EAAY,UAAAU,EAAW,OAAAC,CAAO,EAAI,KAAK,SAE/C,GAAI,CACF,GAAM,CAAE,KAAAC,CAAK,EAAI,MAAM,KAAK,SAAS,SAAS,KAAK,4BAA6B,CAC9E,KAAM,CACJ,WAAAZ,EACA,UAAAU,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,WAE5BD,IACH,KAAK,SAAS,OAASC,EAAK,QAG9B,KAAK,SAAS,MAAQA,EAAK,MAG3B,OAAO,OAAO,KAAK,QAAQ,EAAE,QAASE,GAAa,CACjDA,EAAS,IAAIC,EAAeH,EAAK,KAAK,CAAC,CACzC,CAAC,CACH,OAASI,EAAO,CAGd,aAAO,OAAO,KAAK,QAAQ,EAAE,QAASF,GAAa,CACjDA,EAAS,IAAIC,EAAe,CAAC,CAC/B,CAAC,EACK,IAAIF,EAAS,4BAA6B,CAC9C,MAAOG,CACT,CAAC,CACH,CACF,CAWA,iBAAwB,CACtB,KAAK,SAAS,eAAiB,MACjC,CA0BA,MAAM,kBACJC,EACAC,EACoB,CACpB,KAAK,gBAAgB,EAErB,IAAMC,EAAsB,CAC1B,GAAGF,CACL,EAEM,CAAE,KAAAL,CAAK,EAAI,MAAM,KAAK,SAAS,aAAa,KAAK,uBAAwB,CAC7E,KAAM,CACJ,KAAM,qBACN,oBAAAO,EACA,mBAAoBD,CACtB,CACF,CAAC,EAED,GAAI,CAACN,EAAM,MAAM,IAAIC,EAAS,wCAAwC,EAEtE,GAAM,CAACO,EAAuB,GAAGC,CAAI,EAAIT,EAEnCU,EAAiBF,EAAsB,eAC7C,GAAI,CAACE,EACH,MAAM,IAAIT,EAAS,8CAA8C,EAGnE,YAAK,SAAS,eAAiBS,EAExBD,CACT,CAqBA,MAAM,YAAYE,EAAiD,CACjE,IAAMD,EAAiB,KAAK,SAAS,eACrC,GAAI,CAACA,EACH,MAAM,IAAIT,EAAS,yBAAyB,EAG9C,GAAM,CAAE,KAAAD,CAAK,EAAI,MAAM,KAAK,SAAS,aAAa,KAAK,uBAAwB,CAC7E,KAAM,CACJ,eAAAU,EACA,GAAGC,CACL,CACF,CAAC,EAED,GAAI,CAACX,EAAM,MAAM,IAAIC,EAAS,wCAAwC,EAItE,OAAOD,EAAK,OAAQY,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,CAeA,kBAAkC,CAChC,OAAO,KAAK,SAAS,OAAS,IAChC,CAQA,MAAM,gBAAgBL,EAAiD,CACrE,GAAI,CAACA,EACH,MAAM,IAAIT,EAAS,yBAAyB,EAG9C,GAAI,CACF,GAAM,CAAE,KAAAD,CAAK,EAAI,MAAM,KAAK,SAAS,aAAa,IAAI,yCAA0C,CAC9F,OAAQ,CACN,KAAM,CACJ,gBAAiBU,CACnB,CACF,CACF,CAAC,EAKD,GAFA,KAAK,SAAS,eAAiBA,EAE3B,CAACV,EAAM,MAAM,IAAIC,EAAS,gDAAgD,EAE9E,OAAOe,EAAoBhB,CAAI,CACjC,OAASI,EAAO,CACd,MAAM,IAAIH,EAAS,qCAAsC,CACvD,MAAOG,CACT,CAAC,CACH,CACF,CACF","names":["index_exports","__export","Client","SDKError","auth_default","error_default","headers_default","__toCommonJS","import_openapi_fetch","getItemWithExpiry","key","itemString","item","getItemWithExpiry_default","setItemWithExpiry","key","value","ttl","item","setItemWithExpiry_default","day","userIdTtl","conversationIdKey","sessionIdKey","tokenKey","userIdKey","deleteConversationId","getConversationId","setConversationId","conversationId","getSessionId","setSessionId","sessionId","isTokenExpired","token","payloadBase64","payload","error","getToken","setToken","getUserId","userId","getItemWithExpiry_default","setUserId","setItemWithExpiry_default","createIdentityProperty","getValue","setValue","clearValue","value","createIdentityStore","customerId","identity","properties","authMiddleware","accessToken","request","auth_default","errorMiddleware","response","data","error_default","headerMiddleware","identity","url","request","headers_default","stripConversationId","userMessage","conversationId","rest","getSelectedOptionLabel","previousTurn","message","option","getRestoredUserMessage","turn","getRestoredAssistantReply","nextTurn","shouldHideSingleSelect","restoreConversation","turns","index","version","SDKError","_SDKError","userMessage","cause","version","Client","config","conversationUrl","customerId","fetch","frontendUrl","defaultHeaders","headers","version","createClient","createIdentityStore","error_default","headers_default","sessionId","userId","data","SDKError","endpoint","auth_default","error","context","userMessage","conversationContext","conversationIdMessage","rest","conversationId","payload","message","eventName","properties","body","restoreConversation"]}
|
package/dist/index.mjs
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
import T from"openapi-fetch";var w=t=>{let s=localStorage.getItem(t);if(!s)return null;let e=JSON.parse(s);return Date.now()>e.expires?(localStorage.removeItem(t),null):e.value},u=w;var A=(t,s,e)=>{let n={expires:Date.now()+e,value:s};localStorage.setItem(t,JSON.stringify(n))},l=A;var R=1e3*60*60*24,P=R*30,y="__15gifts_conversation_id",I="__15gifts_session_id",v="__15gifts_identity_token",M="__15gifts_user_id",O=()=>sessionStorage.removeItem(y),_=()=>sessionStorage.getItem(y),k=t=>sessionStorage.setItem(y,t),U=()=>sessionStorage.getItem(I),N=t=>sessionStorage.setItem(I,t),b=t=>{try{let[,s]=t.split(".");if(!s)throw new Error("Invalid token payload");let e=JSON.parse(atob(s));return e.exp&&Date.now()/1e3>e.exp}catch(s){return console.error("Invalid token format",s),!0}},V=()=>{let t=localStorage.getItem(v);return!t||b(t)?(localStorage.removeItem(v),null):t},L=t=>localStorage.setItem(v,t),D=()=>{let t=u(M);return t&&E(t),t},E=t=>l(M,t,P),p=(t,s,e)=>({enumerable:!0,configurable:!0,get:()=>t()??void 0,set:n=>{if(n){s(n);return}e?.()}}),x=t=>{let s={customerId:t},e={conversationId:p(_,k,O),sessionId:p(U,N),token:p(V,L),userId:p(D,E)};return Object.defineProperties(s,e),s};var G=t=>({onRequest:async({request:s})=>{if(s.url.includes("/identity/"))return s;if(!t)throw new Error("Access token is required for authentication.");return s.headers.set("Authorization",`Bearer ${t}`),s}}),d=G;var j={onResponse:async({response:t})=>{if(!t.ok){let s=await t.json();throw new Error(s.message)}return t}},m=j;var q=(t,s)=>({onRequest:async({request:e})=>(t.pageviewId&&e.headers.set("X-PAGEVIEW-ID",t.pageviewId),s&&e.headers.set("X-PAGE-URL",s),e)}),h=q;var f=t=>{let{conversationId:s,...e}=t;return e},K=(t,s)=>s?.assistantMessages.find(o=>o.type==="SINGLE_SELECT")?.options.find(o=>o.value===t.option)?.label||"",W=(t,s)=>{let{userMessage:e}=t;switch(e.type){case"SINGLE_SELECT":return{...f(e),userMessage:K(e,s)};case"START_CONVERSATION":return{type:"MESSAGE",userMessage:e.openingUserMessage?.option||""};case"MESSAGE":return f(e);case"MULTI_SELECT":return f(e)}},H=(t,s)=>{let e=!!s;return t.assistantMessages.filter(n=>n.type!=="CONVERSATION_ID"&&!(e&&n.type==="SINGLE_SELECT"))},S=t=>t.map((s,e)=>{let n=e>0?t[e-1]:void 0,o=e<t.length-1?t[e+1]:void 0;return{id:`restored-turn-${e}`,userMessage:W(s,n),assistantReply:H(s,o)}});var c="0.24.
|
|
1
|
+
import T from"openapi-fetch";var w=t=>{let s=localStorage.getItem(t);if(!s)return null;let e=JSON.parse(s);return Date.now()>e.expires?(localStorage.removeItem(t),null):e.value},u=w;var A=(t,s,e)=>{let n={expires:Date.now()+e,value:s};localStorage.setItem(t,JSON.stringify(n))},l=A;var R=1e3*60*60*24,P=R*30,y="__15gifts_conversation_id",I="__15gifts_session_id",v="__15gifts_identity_token",M="__15gifts_user_id",O=()=>sessionStorage.removeItem(y),_=()=>sessionStorage.getItem(y),k=t=>sessionStorage.setItem(y,t),U=()=>sessionStorage.getItem(I),N=t=>sessionStorage.setItem(I,t),b=t=>{try{let[,s]=t.split(".");if(!s)throw new Error("Invalid token payload");let e=JSON.parse(atob(s));return e.exp&&Date.now()/1e3>e.exp}catch(s){return console.error("Invalid token format",s),!0}},V=()=>{let t=localStorage.getItem(v);return!t||b(t)?(localStorage.removeItem(v),null):t},L=t=>localStorage.setItem(v,t),D=()=>{let t=u(M);return t&&E(t),t},E=t=>l(M,t,P),p=(t,s,e)=>({enumerable:!0,configurable:!0,get:()=>t()??void 0,set:n=>{if(n){s(n);return}e?.()}}),x=t=>{let s={customerId:t},e={conversationId:p(_,k,O),sessionId:p(U,N),token:p(V,L),userId:p(D,E)};return Object.defineProperties(s,e),s};var G=t=>({onRequest:async({request:s})=>{if(s.url.includes("/identity/"))return s;if(!t)throw new Error("Access token is required for authentication.");return s.headers.set("Authorization",`Bearer ${t}`),s}}),d=G;var j={onResponse:async({response:t})=>{if(!t.ok){let s=await t.json();throw new Error(s.message)}return t}},m=j;var q=(t,s)=>({onRequest:async({request:e})=>(t.pageviewId&&e.headers.set("X-PAGEVIEW-ID",t.pageviewId),s&&e.headers.set("X-PAGE-URL",s),e)}),h=q;var f=t=>{let{conversationId:s,...e}=t;return e},K=(t,s)=>s?.assistantMessages.find(o=>o.type==="SINGLE_SELECT")?.options.find(o=>o.value===t.option)?.label||"",W=(t,s)=>{let{userMessage:e}=t;switch(e.type){case"SINGLE_SELECT":return{...f(e),userMessage:K(e,s)};case"START_CONVERSATION":return{type:"MESSAGE",userMessage:e.openingUserMessage?.option||""};case"MESSAGE":return f(e);case"MULTI_SELECT":return f(e)}},H=(t,s)=>{let e=!!s;return t.assistantMessages.filter(n=>n.type!=="CONVERSATION_ID"&&!(e&&n.type==="SINGLE_SELECT"))},S=t=>t.map((s,e)=>{let n=e>0?t[e-1]:void 0,o=e<t.length-1?t[e+1]:void 0;return{id:`restored-turn-${e}`,userMessage:W(s,n),assistantReply:H(s,o)}});var c="0.24.2";var r=class t extends Error{sdkVersion;cause;constructor(s,{cause:e}={}){super(s),this.name="SDKError",this.cause=e,this.sdkVersion=c,Object.setPrototypeOf(this,t.prototype)}};var C=class{endpoint;identity;constructor(s){let{conversationUrl:e,customerId:n,fetch:o,frontendUrl:i,headers:g}=s,a={...g,"X-SDK-VERSION":c};this.endpoint={conversation:T({baseUrl:e,fetch:o,headers:a,credentials:"include"}),frontend:T({baseUrl:i,fetch:o,headers:a})},this.identity=x(n),this.endpoint.conversation.use(m),this.endpoint.conversation.use(h(this.identity,window.location.href))}async createIdentity(){let{customerId:s,sessionId:e,userId:n}=this.identity;try{let{data:o}=await this.endpoint.frontend.POST("/api/tracking/identity/v2",{body:{customerId:s,sessionId:e,userId:n,url:window.location.href,userAgent:window.navigator.userAgent}});if(!o)throw new r("No data received from identity API");this.identity.pageviewId=o.pageviewId,e||(this.identity.sessionId=o.sessionId),n||(this.identity.userId=o.userId),this.identity.token=o.token,Object.values(this.endpoint).forEach(i=>{i.use(d(o.token))})}catch(o){throw Object.values(this.endpoint).forEach(i=>{i.use(d())}),new r("Failed to create identity",{cause:o})}}endConversation(){this.identity.conversationId=void 0}async startConversation(s,e){this.endConversation();let n={...s},{data:o}=await this.endpoint.conversation.POST("/api/conversation/v3",{body:{type:"START_CONVERSATION",conversationContext:n,openingUserMessage:e}});if(!o)throw new r("No data received from Conversation API");let[i,...g]=o,a=i.conversationId;if(!a)throw new r("Conversation ID not received in API response");return this.identity.conversationId=a,g}async sendMessage(s){let e=this.identity.conversationId;if(!e)throw new r("Conversation ID not set");let{data:n}=await this.endpoint.conversation.POST("/api/conversation/v3",{body:{conversationId:e,...s}});if(!n)throw new r("No data received from conversation API");return n.filter(o=>o.type!=="CONVERSATION_ID")}async trackEvent(s,e){let n={additionalProperties:e,conversationId:this.identity.conversationId,eventName:s,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:n})}getIdentity(){return this.identity}getIdentityToken(){return this.identity.token??null}async getConversation(s){if(!s)throw new r("Conversation ID not set");try{let{data:e}=await this.endpoint.conversation.GET("/api/conversation/{conversation_id}/v1",{params:{path:{conversation_id:s}}});if(this.identity.conversationId=s,!e)throw new r("No data received from conversation history API");return S(e)}catch(e){throw new r("Failed to get conversation history",{cause:e})}}};export{C as Client,r as SDKError,d as authMiddleware,m as errorMiddleware,h as headerMiddleware};
|
|
2
2
|
//# sourceMappingURL=index.mjs.map
|
package/dist/index.mjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../src/client.ts","../src/utils/getItemWithExpiry.ts","../src/utils/setItemWithExpiry.ts","../src/identity/createIdentityStore.ts","../src/middlewares/auth.ts","../src/middlewares/error.ts","../src/middlewares/headers.ts","../src/restoreConversation/restoreConversation.ts","../package.json","../src/utils/SDKError.ts"],"sourcesContent":["import createClient, { type ClientOptions } from 'openapi-fetch'\n\nimport { createIdentityStore } from './identity/createIdentityStore'\nimport { authMiddleware, errorMiddleware, headerMiddleware } from './middlewares'\nimport { restoreConversation } from './restoreConversation/restoreConversation'\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 RestoredTurn,\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 = createIdentityStore(customerId)\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 }\n if (!userId) {\n this.identity.userId = data.userId\n }\n\n this.identity.token = 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 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 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): Promise<Message[]> {\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 * Use this method to retrieve the token for use in other parts of your system,\n * such as calling the Humara sales tracking API\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 this.identity.token ?? null\n }\n\n /**\n * Gets the conversation history for a given conversation ID.\n *\n * @param conversationId - The ID of the conversation to retrieve.\n * @returns A promise that resolves to the conversation history as an array of turns. Each turn contains a user message and its corresponding response.\n */\n async getConversation(conversationId: string): Promise<RestoredTurn[]> {\n if (!conversationId) {\n throw new SDKError('Conversation ID not set')\n }\n\n try {\n const { data } = await this.endpoint.conversation.GET('/api/conversation/{conversation_id}/v1', {\n params: {\n path: {\n conversation_id: conversationId,\n },\n },\n })\n\n // Sets the current conversation ID to the one just retrieved, so that subsequent calls to `sendMessage` and `trackEvent` will use this conversation ID.\n this.identity.conversationId = conversationId\n\n if (!data) throw new SDKError('No data received from conversation history API')\n\n return restoreConversation(data)\n } catch (error) {\n throw new SDKError('Failed to get conversation history', {\n cause: error as Error,\n })\n }\n }\n}\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 type { Config, Identity } from '../types'\nimport { getItemWithExpiry, setItemWithExpiry } from '../utils'\n\ntype IdentityKey = 'conversationId' | 'sessionId' | 'token' | 'userId'\n\nconst day = 1000 * 60 * 60 * 24\nconst userIdTtl = day * 30\n\nconst conversationIdKey = '__15gifts_conversation_id'\nconst sessionIdKey = '__15gifts_session_id'\nconst tokenKey = '__15gifts_identity_token'\nconst userIdKey = '__15gifts_user_id'\n\nconst deleteConversationId = () => sessionStorage.removeItem(conversationIdKey)\nconst getConversationId = () => sessionStorage.getItem(conversationIdKey)\nconst setConversationId = (conversationId: string) => sessionStorage.setItem(conversationIdKey, conversationId)\n\nconst getSessionId = () => sessionStorage.getItem(sessionIdKey)\nconst setSessionId = (sessionId: string) => sessionStorage.setItem(sessionIdKey, sessionId)\n\nconst 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\nconst getToken = (): string | null => {\n const token = localStorage.getItem(tokenKey)\n\n if (!token || isTokenExpired(token)) {\n localStorage.removeItem(tokenKey)\n return null\n }\n\n return token\n}\n\nconst setToken = (token: string) => localStorage.setItem(tokenKey, token)\n\nconst getUserId = () => {\n const userId = getItemWithExpiry(userIdKey)\n\n if (userId) {\n setUserId(userId)\n }\n\n return userId\n}\n\nconst setUserId = (userId: string) => setItemWithExpiry(userIdKey, userId, userIdTtl)\n\nconst createIdentityProperty = (\n getValue: () => string | null,\n setValue: (value: string) => void,\n clearValue?: () => void,\n): PropertyDescriptor => ({\n enumerable: true,\n configurable: true,\n get: () => getValue() ?? undefined,\n set: (value: string | undefined) => {\n if (value) {\n setValue(value)\n return\n }\n\n clearValue?.()\n },\n})\n\n/**\n * Creates an identity object backed by browser storage.\n *\n * The returned object exposes the public `Identity` shape while keeping\n * `conversationId`, `sessionId`, and `userId` synchronized with their\n * corresponding storage helpers.\n */\nexport const createIdentityStore = (customerId: Config['customerId']): Identity => {\n const identity: Identity = {\n customerId,\n }\n\n const properties: Record<IdentityKey, PropertyDescriptor> = {\n conversationId: createIdentityProperty(getConversationId, setConversationId, deleteConversationId),\n sessionId: createIdentityProperty(getSessionId, setSessionId),\n token: createIdentityProperty(getToken, setToken),\n userId: createIdentityProperty(getUserId, setUserId),\n }\n\n Object.defineProperties(identity, properties)\n\n return identity\n}\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 * The GET `/api/conversation/{conversation_id}` endpoint returns data as a historical record, but\n * it makes little sense when rendered.\n * We transform it so that the user doesn't see all single_select messages again, only the option\n * they selected.\n **/\n\nimport type { ConversationTurn, Message, SingleSelectMessage, UserSingleSelectMessage, RestoredTurn } from '../types'\n\n/**\n * Removes the conversationId from the user message, as this is not needed for rendering and would just add noise.\n */\nconst stripConversationId = <T extends { conversationId?: string }>(userMessage: T): Omit<T, 'conversationId'> => {\n // eslint-disable-next-line @typescript-eslint/no-unused-vars\n const { conversationId, ...rest } = userMessage\n\n return rest\n}\n\n// We have the string that was sent to the API, this finds the label for the option that it relates to.\nconst getSelectedOptionLabel = (userMessage: UserSingleSelectMessage, previousTurn?: ConversationTurn) => {\n const previousSingleSelect = previousTurn?.assistantMessages.find(\n (message): message is SingleSelectMessage => message.type === 'SINGLE_SELECT',\n )\n const selectedOption = previousSingleSelect?.options.find((option) => option.value === userMessage.option)\n\n return selectedOption?.label || ''\n}\n\n// Turns the user message back in to how the user would have seen it\nconst getRestoredUserMessage = (\n turn: ConversationTurn,\n previousTurn?: ConversationTurn,\n): RestoredTurn['userMessage'] => {\n const { userMessage } = turn\n\n switch (userMessage.type) {\n case 'SINGLE_SELECT':\n return {\n ...stripConversationId(userMessage),\n userMessage: getSelectedOptionLabel(userMessage, previousTurn),\n }\n\n case 'START_CONVERSATION':\n // There isn't anything we want to render from the START_CONVERSATION message except for the openingUserMessage,\n // which is what the user would have submitted to start the conversation.\n return {\n type: 'MESSAGE',\n userMessage: userMessage.openingUserMessage?.option || '',\n }\n\n case 'MESSAGE':\n return stripConversationId(userMessage)\n\n case 'MULTI_SELECT':\n return stripConversationId(userMessage)\n }\n}\n\n// Turns the assistant message back in to how the user would have seen it\nconst getRestoredAssistantReply = (turn: ConversationTurn, nextTurn?: ConversationTurn) => {\n const shouldHideSingleSelect = Boolean(nextTurn)\n\n return turn.assistantMessages.filter(\n (message): message is Message =>\n message.type !== 'CONVERSATION_ID' && !(shouldHideSingleSelect && message.type === 'SINGLE_SELECT'),\n )\n}\n\nexport const restoreConversation = (turns: ConversationTurn[]): RestoredTurn[] => {\n return turns.map((turn, index) => {\n const previousTurn = index > 0 ? turns[index - 1] : undefined\n const nextTurn = index < turns.length - 1 ? turns[index + 1] : undefined\n\n return {\n id: `restored-turn-${index}`,\n userMessage: getRestoredUserMessage(turn, previousTurn),\n assistantReply: getRestoredAssistantReply(turn, nextTurn),\n }\n })\n}\n","{\n \"name\": \"@15gifts/sdk\",\n \"version\": \"0.24.1\",\n \"files\": [\n \"dist\"\n ],\n \"main\": \"./dist/index.js\",\n \"module\": \"./dist/index.mjs\",\n \"types\": \"./dist/index.d.ts\",\n \"scripts\": {\n \"build\": \"tsup && npm run typecheck:dist\",\n \"coverage\": \"vitest run --coverage\",\n \"generate-types\": \"npx openapi-typescript\",\n \"dev\": \"tsup --watch\",\n \"format\": \"prettier . --write\",\n \"lint\": \"eslint .\",\n \"pact:publish:conversation\": \"tsx scripts/pact/publish-conversation.ts\",\n \"test\": \"vitest run\",\n \"test:consumer:conversation\": \"tsx scripts/pact/consumer-conversation.ts\",\n \"test:watch\": \"vitest\",\n \"typecheck:dist\": \"tsc --noEmit --skipLibCheck true dist/index.d.ts\",\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 \"@pact-foundation/pact\": \"^16.5.0\",\n \"@types/node\": \"^22.15.21\",\n \"call-bound\": \"^1.0.4\",\n \"openapi-typescript\": \"^7.6.0\",\n \"tsup\": \"^8.3.6\",\n \"tsx\": \"^4.20.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,gBCAjD,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,ECVf,IAAMM,EAAM,IAAO,GAAK,GAAK,GACvBC,EAAYD,EAAM,GAElBE,EAAoB,4BACpBC,EAAe,uBACfC,EAAW,2BACXC,EAAY,oBAEZC,EAAuB,IAAM,eAAe,WAAWJ,CAAiB,EACxEK,EAAoB,IAAM,eAAe,QAAQL,CAAiB,EAClEM,EAAqBC,GAA2B,eAAe,QAAQP,EAAmBO,CAAc,EAExGC,EAAe,IAAM,eAAe,QAAQP,CAAY,EACxDQ,EAAgBC,GAAsB,eAAe,QAAQT,EAAcS,CAAS,EAEpFC,EAAkBC,GAA2B,CACjD,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,EAEMC,EAAW,IAAqB,CACpC,IAAMJ,EAAQ,aAAa,QAAQV,CAAQ,EAE3C,MAAI,CAACU,GAASD,EAAeC,CAAK,GAChC,aAAa,WAAWV,CAAQ,EACzB,MAGFU,CACT,EAEMK,EAAYL,GAAkB,aAAa,QAAQV,EAAUU,CAAK,EAElEM,EAAY,IAAM,CACtB,IAAMC,EAASC,EAAkBjB,CAAS,EAE1C,OAAIgB,GACFE,EAAUF,CAAM,EAGXA,CACT,EAEME,EAAaF,GAAmBG,EAAkBnB,EAAWgB,EAAQpB,CAAS,EAE9EwB,EAAyB,CAC7BC,EACAC,EACAC,KACwB,CACxB,WAAY,GACZ,aAAc,GACd,IAAK,IAAMF,EAAS,GAAK,OACzB,IAAMG,GAA8B,CAClC,GAAIA,EAAO,CACTF,EAASE,CAAK,EACd,MACF,CAEAD,IAAa,CACf,CACF,GASaE,EAAuBC,GAA+C,CACjF,IAAMC,EAAqB,CACzB,WAAAD,CACF,EAEME,EAAsD,CAC1D,eAAgBR,EAAuBlB,EAAmBC,EAAmBF,CAAoB,EACjG,UAAWmB,EAAuBf,EAAcC,CAAY,EAC5D,MAAOc,EAAuBP,EAAUC,CAAQ,EAChD,OAAQM,EAAuBL,EAAWG,CAAS,CACrD,EAEA,cAAO,iBAAiBS,EAAUC,CAAU,EAErCD,CACT,ECrFA,IAAME,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,ECjBf,IAAMK,EAA8DC,GAA8C,CAEhH,GAAM,CAAE,eAAAC,EAAgB,GAAGC,CAAK,EAAIF,EAEpC,OAAOE,CACT,EAGMC,EAAyB,CAACH,EAAsCI,IACvCA,GAAc,kBAAkB,KAC1DC,GAA4CA,EAAQ,OAAS,eAChE,GAC6C,QAAQ,KAAMC,GAAWA,EAAO,QAAUN,EAAY,MAAM,GAElF,OAAS,GAI5BO,EAAyB,CAC7BC,EACAJ,IACgC,CAChC,GAAM,CAAE,YAAAJ,CAAY,EAAIQ,EAExB,OAAQR,EAAY,KAAM,CACxB,IAAK,gBACH,MAAO,CACL,GAAGD,EAAoBC,CAAW,EAClC,YAAaG,EAAuBH,EAAaI,CAAY,CAC/D,EAEF,IAAK,qBAGH,MAAO,CACL,KAAM,UACN,YAAaJ,EAAY,oBAAoB,QAAU,EACzD,EAEF,IAAK,UACH,OAAOD,EAAoBC,CAAW,EAExC,IAAK,eACH,OAAOD,EAAoBC,CAAW,CAC1C,CACF,EAGMS,EAA4B,CAACD,EAAwBE,IAAgC,CACzF,IAAMC,EAAyB,EAAQD,EAEvC,OAAOF,EAAK,kBAAkB,OAC3BH,GACCA,EAAQ,OAAS,mBAAqB,EAAEM,GAA0BN,EAAQ,OAAS,gBACvF,CACF,EAEaO,EAAuBC,GAC3BA,EAAM,IAAI,CAACL,EAAMM,IAAU,CAChC,IAAMV,EAAeU,EAAQ,EAAID,EAAMC,EAAQ,CAAC,EAAI,OAC9CJ,EAAWI,EAAQD,EAAM,OAAS,EAAIA,EAAMC,EAAQ,CAAC,EAAI,OAE/D,MAAO,CACL,GAAI,iBAAiBA,CAAK,GAC1B,YAAaP,EAAuBC,EAAMJ,CAAY,EACtD,eAAgBK,EAA0BD,EAAME,CAAQ,CAC1D,CACF,CAAC,EC7ED,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,ETIO,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,SAAWG,EAAoBP,CAAU,EAE9C,KAAK,SAAS,aAAa,IAAIQ,CAAe,EAC9C,KAAK,SAAS,aAAa,IAAIC,EAAiB,KAAK,SAAU,OAAO,SAAS,IAAI,CAAC,CACtF,CAeA,MAAM,gBAAgC,CACpC,GAAM,CAAE,WAAAT,EAAY,UAAAU,EAAW,OAAAC,CAAO,EAAI,KAAK,SAE/C,GAAI,CACF,GAAM,CAAE,KAAAC,CAAK,EAAI,MAAM,KAAK,SAAS,SAAS,KAAK,4BAA6B,CAC9E,KAAM,CACJ,WAAAZ,EACA,UAAAU,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,WAE5BD,IACH,KAAK,SAAS,OAASC,EAAK,QAG9B,KAAK,SAAS,MAAQA,EAAK,MAG3B,OAAO,OAAO,KAAK,QAAQ,EAAE,QAASE,GAAa,CACjDA,EAAS,IAAIC,EAAeH,EAAK,KAAK,CAAC,CACzC,CAAC,CACH,OAASI,EAAO,CAGd,aAAO,OAAO,KAAK,QAAQ,EAAE,QAASF,GAAa,CACjDA,EAAS,IAAIC,EAAe,CAAC,CAC/B,CAAC,EACK,IAAIF,EAAS,4BAA6B,CAC9C,MAAOG,CACT,CAAC,CACH,CACF,CAWA,iBAAwB,CACtB,KAAK,SAAS,eAAiB,MACjC,CA0BA,MAAM,kBACJC,EACAC,EACoB,CACpB,KAAK,gBAAgB,EAErB,IAAMC,EAAsB,CAC1B,GAAGF,CACL,EAEM,CAAE,KAAAL,CAAK,EAAI,MAAM,KAAK,SAAS,aAAa,KAAK,uBAAwB,CAC7E,KAAM,CACJ,KAAM,qBACN,oBAAAO,EACA,mBAAoBD,CACtB,CACF,CAAC,EAED,GAAI,CAACN,EAAM,MAAM,IAAIC,EAAS,wCAAwC,EAEtE,GAAM,CAACO,EAAuB,GAAGC,CAAI,EAAIT,EAEnCU,EAAiBF,EAAsB,eAC7C,GAAI,CAACE,EACH,MAAM,IAAIT,EAAS,8CAA8C,EAGnE,YAAK,SAAS,eAAiBS,EAExBD,CACT,CAqBA,MAAM,YAAYE,EAAiD,CACjE,IAAMD,EAAiB,KAAK,SAAS,eACrC,GAAI,CAACA,EACH,MAAM,IAAIT,EAAS,yBAAyB,EAG9C,GAAM,CAAE,KAAAD,CAAK,EAAI,MAAM,KAAK,SAAS,aAAa,KAAK,uBAAwB,CAC7E,KAAM,CACJ,eAAAU,EACA,GAAGC,CACL,CACF,CAAC,EAED,GAAI,CAACX,EAAM,MAAM,IAAIC,EAAS,wCAAwC,EAItE,OAAOD,EAAK,OAAQY,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,CAeA,kBAAkC,CAChC,OAAO,KAAK,SAAS,OAAS,IAChC,CAQA,MAAM,gBAAgBL,EAAiD,CACrE,GAAI,CAACA,EACH,MAAM,IAAIT,EAAS,yBAAyB,EAG9C,GAAI,CACF,GAAM,CAAE,KAAAD,CAAK,EAAI,MAAM,KAAK,SAAS,aAAa,IAAI,yCAA0C,CAC9F,OAAQ,CACN,KAAM,CACJ,gBAAiBU,CACnB,CACF,CACF,CAAC,EAKD,GAFA,KAAK,SAAS,eAAiBA,EAE3B,CAACV,EAAM,MAAM,IAAIC,EAAS,gDAAgD,EAE9E,OAAOe,EAAoBhB,CAAI,CACjC,OAASI,EAAO,CACd,MAAM,IAAIH,EAAS,qCAAsC,CACvD,MAAOG,CACT,CAAC,CACH,CACF,CACF","names":["createClient","getItemWithExpiry","key","itemString","item","getItemWithExpiry_default","setItemWithExpiry","key","value","ttl","item","setItemWithExpiry_default","day","userIdTtl","conversationIdKey","sessionIdKey","tokenKey","userIdKey","deleteConversationId","getConversationId","setConversationId","conversationId","getSessionId","setSessionId","sessionId","isTokenExpired","token","payloadBase64","payload","error","getToken","setToken","getUserId","userId","getItemWithExpiry_default","setUserId","setItemWithExpiry_default","createIdentityProperty","getValue","setValue","clearValue","value","createIdentityStore","customerId","identity","properties","authMiddleware","accessToken","request","auth_default","errorMiddleware","response","data","error_default","headerMiddleware","identity","url","request","headers_default","stripConversationId","userMessage","conversationId","rest","getSelectedOptionLabel","previousTurn","message","option","getRestoredUserMessage","turn","getRestoredAssistantReply","nextTurn","shouldHideSingleSelect","restoreConversation","turns","index","version","SDKError","_SDKError","userMessage","cause","version","Client","config","conversationUrl","customerId","fetch","frontendUrl","defaultHeaders","headers","version","createClient","createIdentityStore","error_default","headers_default","sessionId","userId","data","SDKError","endpoint","auth_default","error","context","userMessage","conversationContext","conversationIdMessage","rest","conversationId","payload","message","eventName","properties","body","restoreConversation"]}
|
|
1
|
+
{"version":3,"sources":["../src/client.ts","../src/utils/getItemWithExpiry.ts","../src/utils/setItemWithExpiry.ts","../src/identity/createIdentityStore.ts","../src/middlewares/auth.ts","../src/middlewares/error.ts","../src/middlewares/headers.ts","../src/restoreConversation/restoreConversation.ts","../package.json","../src/utils/SDKError.ts"],"sourcesContent":["import createClient, { type ClientOptions } from 'openapi-fetch'\n\nimport { createIdentityStore } from './identity/createIdentityStore'\nimport { authMiddleware, errorMiddleware, headerMiddleware } from './middlewares'\nimport { restoreConversation } from './restoreConversation/restoreConversation'\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 RestoredTurn,\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 = createIdentityStore(customerId)\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 }\n if (!userId) {\n this.identity.userId = data.userId\n }\n\n this.identity.token = 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 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 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): Promise<Message[]> {\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 * Use this method to retrieve the token for use in other parts of your system,\n * such as calling the Humara sales tracking API\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 this.identity.token ?? null\n }\n\n /**\n * Gets the conversation history for a given conversation ID.\n *\n * @param conversationId - The ID of the conversation to retrieve.\n * @returns A promise that resolves to the conversation history as an array of turns. Each turn contains a user message and its corresponding response.\n */\n async getConversation(conversationId: string): Promise<RestoredTurn[]> {\n if (!conversationId) {\n throw new SDKError('Conversation ID not set')\n }\n\n try {\n const { data } = await this.endpoint.conversation.GET('/api/conversation/{conversation_id}/v1', {\n params: {\n path: {\n conversation_id: conversationId,\n },\n },\n })\n\n // Sets the current conversation ID to the one just retrieved, so that subsequent calls to `sendMessage` and `trackEvent` will use this conversation ID.\n this.identity.conversationId = conversationId\n\n if (!data) throw new SDKError('No data received from conversation history API')\n\n return restoreConversation(data)\n } catch (error) {\n throw new SDKError('Failed to get conversation history', {\n cause: error as Error,\n })\n }\n }\n}\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 type { Config, Identity } from '../types'\nimport { getItemWithExpiry, setItemWithExpiry } from '../utils'\n\ntype IdentityKey = 'conversationId' | 'sessionId' | 'token' | 'userId'\n\nconst day = 1000 * 60 * 60 * 24\nconst userIdTtl = day * 30\n\nconst conversationIdKey = '__15gifts_conversation_id'\nconst sessionIdKey = '__15gifts_session_id'\nconst tokenKey = '__15gifts_identity_token'\nconst userIdKey = '__15gifts_user_id'\n\nconst deleteConversationId = () => sessionStorage.removeItem(conversationIdKey)\nconst getConversationId = () => sessionStorage.getItem(conversationIdKey)\nconst setConversationId = (conversationId: string) => sessionStorage.setItem(conversationIdKey, conversationId)\n\nconst getSessionId = () => sessionStorage.getItem(sessionIdKey)\nconst setSessionId = (sessionId: string) => sessionStorage.setItem(sessionIdKey, sessionId)\n\nconst 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\nconst getToken = (): string | null => {\n const token = localStorage.getItem(tokenKey)\n\n if (!token || isTokenExpired(token)) {\n localStorage.removeItem(tokenKey)\n return null\n }\n\n return token\n}\n\nconst setToken = (token: string) => localStorage.setItem(tokenKey, token)\n\nconst getUserId = () => {\n const userId = getItemWithExpiry(userIdKey)\n\n if (userId) {\n setUserId(userId)\n }\n\n return userId\n}\n\nconst setUserId = (userId: string) => setItemWithExpiry(userIdKey, userId, userIdTtl)\n\nconst createIdentityProperty = (\n getValue: () => string | null,\n setValue: (value: string) => void,\n clearValue?: () => void,\n): PropertyDescriptor => ({\n enumerable: true,\n configurable: true,\n get: () => getValue() ?? undefined,\n set: (value: string | undefined) => {\n if (value) {\n setValue(value)\n return\n }\n\n clearValue?.()\n },\n})\n\n/**\n * Creates an identity object backed by browser storage.\n *\n * The returned object exposes the public `Identity` shape while keeping\n * `conversationId`, `sessionId`, and `userId` synchronized with their\n * corresponding storage helpers.\n */\nexport const createIdentityStore = (customerId: Config['customerId']): Identity => {\n const identity: Identity = {\n customerId,\n }\n\n const properties: Record<IdentityKey, PropertyDescriptor> = {\n conversationId: createIdentityProperty(getConversationId, setConversationId, deleteConversationId),\n sessionId: createIdentityProperty(getSessionId, setSessionId),\n token: createIdentityProperty(getToken, setToken),\n userId: createIdentityProperty(getUserId, setUserId),\n }\n\n Object.defineProperties(identity, properties)\n\n return identity\n}\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 * The GET `/api/conversation/{conversation_id}` endpoint returns data as a historical record, but\n * it makes little sense when rendered.\n * We transform it so that the user doesn't see all single_select messages again, only the option\n * they selected.\n **/\n\nimport type { ConversationTurn, Message, SingleSelectMessage, UserSingleSelectMessage, RestoredTurn } from '../types'\n\n/**\n * Removes the conversationId from the user message, as this is not needed for rendering and would just add noise.\n */\nconst stripConversationId = <T extends { conversationId?: string }>(userMessage: T): Omit<T, 'conversationId'> => {\n // eslint-disable-next-line @typescript-eslint/no-unused-vars\n const { conversationId, ...rest } = userMessage\n\n return rest\n}\n\n// We have the string that was sent to the API, this finds the label for the option that it relates to.\nconst getSelectedOptionLabel = (userMessage: UserSingleSelectMessage, previousTurn?: ConversationTurn) => {\n const previousSingleSelect = previousTurn?.assistantMessages.find(\n (message): message is SingleSelectMessage => message.type === 'SINGLE_SELECT',\n )\n const selectedOption = previousSingleSelect?.options.find((option) => option.value === userMessage.option)\n\n return selectedOption?.label || ''\n}\n\n// Turns the user message back in to how the user would have seen it\nconst getRestoredUserMessage = (\n turn: ConversationTurn,\n previousTurn?: ConversationTurn,\n): RestoredTurn['userMessage'] => {\n const { userMessage } = turn\n\n switch (userMessage.type) {\n case 'SINGLE_SELECT':\n return {\n ...stripConversationId(userMessage),\n userMessage: getSelectedOptionLabel(userMessage, previousTurn),\n }\n\n case 'START_CONVERSATION':\n // There isn't anything we want to render from the START_CONVERSATION message except for the openingUserMessage,\n // which is what the user would have submitted to start the conversation.\n return {\n type: 'MESSAGE',\n userMessage: userMessage.openingUserMessage?.option || '',\n }\n\n case 'MESSAGE':\n return stripConversationId(userMessage)\n\n case 'MULTI_SELECT':\n return stripConversationId(userMessage)\n }\n}\n\n// Turns the assistant message back in to how the user would have seen it\nconst getRestoredAssistantReply = (turn: ConversationTurn, nextTurn?: ConversationTurn) => {\n const shouldHideSingleSelect = Boolean(nextTurn)\n\n return turn.assistantMessages.filter(\n (message): message is Message =>\n message.type !== 'CONVERSATION_ID' && !(shouldHideSingleSelect && message.type === 'SINGLE_SELECT'),\n )\n}\n\nexport const restoreConversation = (turns: ConversationTurn[]): RestoredTurn[] => {\n return turns.map((turn, index) => {\n const previousTurn = index > 0 ? turns[index - 1] : undefined\n const nextTurn = index < turns.length - 1 ? turns[index + 1] : undefined\n\n return {\n id: `restored-turn-${index}`,\n userMessage: getRestoredUserMessage(turn, previousTurn),\n assistantReply: getRestoredAssistantReply(turn, nextTurn),\n }\n })\n}\n","{\n \"name\": \"@15gifts/sdk\",\n \"version\": \"0.24.2\",\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 && npm run typecheck:dist\",\n \"coverage\": \"vitest run --coverage\",\n \"generate-types\": \"npx openapi-typescript\",\n \"dev\": \"tsup --watch\",\n \"format\": \"prettier . --write\",\n \"lint\": \"eslint .\",\n \"pact:publish:conversation\": \"tsx scripts/pact/publish-conversation.ts\",\n \"test\": \"vitest run\",\n \"test:consumer:conversation\": \"tsx scripts/pact/consumer-conversation.ts\",\n \"test:watch\": \"vitest\",\n \"typecheck:dist\": \"tsc --noEmit --skipLibCheck true dist/index.d.ts\",\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 \"@pact-foundation/pact\": \"^16.5.0\",\n \"@types/node\": \"^22.15.21\",\n \"call-bound\": \"^1.0.4\",\n \"openapi-typescript\": \"^7.6.0\",\n \"tsup\": \"^8.3.6\",\n \"tsx\": \"^4.20.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,gBCAjD,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,ECVf,IAAMM,EAAM,IAAO,GAAK,GAAK,GACvBC,EAAYD,EAAM,GAElBE,EAAoB,4BACpBC,EAAe,uBACfC,EAAW,2BACXC,EAAY,oBAEZC,EAAuB,IAAM,eAAe,WAAWJ,CAAiB,EACxEK,EAAoB,IAAM,eAAe,QAAQL,CAAiB,EAClEM,EAAqBC,GAA2B,eAAe,QAAQP,EAAmBO,CAAc,EAExGC,EAAe,IAAM,eAAe,QAAQP,CAAY,EACxDQ,EAAgBC,GAAsB,eAAe,QAAQT,EAAcS,CAAS,EAEpFC,EAAkBC,GAA2B,CACjD,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,EAEMC,EAAW,IAAqB,CACpC,IAAMJ,EAAQ,aAAa,QAAQV,CAAQ,EAE3C,MAAI,CAACU,GAASD,EAAeC,CAAK,GAChC,aAAa,WAAWV,CAAQ,EACzB,MAGFU,CACT,EAEMK,EAAYL,GAAkB,aAAa,QAAQV,EAAUU,CAAK,EAElEM,EAAY,IAAM,CACtB,IAAMC,EAASC,EAAkBjB,CAAS,EAE1C,OAAIgB,GACFE,EAAUF,CAAM,EAGXA,CACT,EAEME,EAAaF,GAAmBG,EAAkBnB,EAAWgB,EAAQpB,CAAS,EAE9EwB,EAAyB,CAC7BC,EACAC,EACAC,KACwB,CACxB,WAAY,GACZ,aAAc,GACd,IAAK,IAAMF,EAAS,GAAK,OACzB,IAAMG,GAA8B,CAClC,GAAIA,EAAO,CACTF,EAASE,CAAK,EACd,MACF,CAEAD,IAAa,CACf,CACF,GASaE,EAAuBC,GAA+C,CACjF,IAAMC,EAAqB,CACzB,WAAAD,CACF,EAEME,EAAsD,CAC1D,eAAgBR,EAAuBlB,EAAmBC,EAAmBF,CAAoB,EACjG,UAAWmB,EAAuBf,EAAcC,CAAY,EAC5D,MAAOc,EAAuBP,EAAUC,CAAQ,EAChD,OAAQM,EAAuBL,EAAWG,CAAS,CACrD,EAEA,cAAO,iBAAiBS,EAAUC,CAAU,EAErCD,CACT,ECrFA,IAAME,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,ECjBf,IAAMK,EAA8DC,GAA8C,CAEhH,GAAM,CAAE,eAAAC,EAAgB,GAAGC,CAAK,EAAIF,EAEpC,OAAOE,CACT,EAGMC,EAAyB,CAACH,EAAsCI,IACvCA,GAAc,kBAAkB,KAC1DC,GAA4CA,EAAQ,OAAS,eAChE,GAC6C,QAAQ,KAAMC,GAAWA,EAAO,QAAUN,EAAY,MAAM,GAElF,OAAS,GAI5BO,EAAyB,CAC7BC,EACAJ,IACgC,CAChC,GAAM,CAAE,YAAAJ,CAAY,EAAIQ,EAExB,OAAQR,EAAY,KAAM,CACxB,IAAK,gBACH,MAAO,CACL,GAAGD,EAAoBC,CAAW,EAClC,YAAaG,EAAuBH,EAAaI,CAAY,CAC/D,EAEF,IAAK,qBAGH,MAAO,CACL,KAAM,UACN,YAAaJ,EAAY,oBAAoB,QAAU,EACzD,EAEF,IAAK,UACH,OAAOD,EAAoBC,CAAW,EAExC,IAAK,eACH,OAAOD,EAAoBC,CAAW,CAC1C,CACF,EAGMS,EAA4B,CAACD,EAAwBE,IAAgC,CACzF,IAAMC,EAAyB,EAAQD,EAEvC,OAAOF,EAAK,kBAAkB,OAC3BH,GACCA,EAAQ,OAAS,mBAAqB,EAAEM,GAA0BN,EAAQ,OAAS,gBACvF,CACF,EAEaO,EAAuBC,GAC3BA,EAAM,IAAI,CAACL,EAAMM,IAAU,CAChC,IAAMV,EAAeU,EAAQ,EAAID,EAAMC,EAAQ,CAAC,EAAI,OAC9CJ,EAAWI,EAAQD,EAAM,OAAS,EAAIA,EAAMC,EAAQ,CAAC,EAAI,OAE/D,MAAO,CACL,GAAI,iBAAiBA,CAAK,GAC1B,YAAaP,EAAuBC,EAAMJ,CAAY,EACtD,eAAgBK,EAA0BD,EAAME,CAAQ,CAC1D,CACF,CAAC,EC7ED,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,ETIO,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,SAAWG,EAAoBP,CAAU,EAE9C,KAAK,SAAS,aAAa,IAAIQ,CAAe,EAC9C,KAAK,SAAS,aAAa,IAAIC,EAAiB,KAAK,SAAU,OAAO,SAAS,IAAI,CAAC,CACtF,CAeA,MAAM,gBAAgC,CACpC,GAAM,CAAE,WAAAT,EAAY,UAAAU,EAAW,OAAAC,CAAO,EAAI,KAAK,SAE/C,GAAI,CACF,GAAM,CAAE,KAAAC,CAAK,EAAI,MAAM,KAAK,SAAS,SAAS,KAAK,4BAA6B,CAC9E,KAAM,CACJ,WAAAZ,EACA,UAAAU,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,WAE5BD,IACH,KAAK,SAAS,OAASC,EAAK,QAG9B,KAAK,SAAS,MAAQA,EAAK,MAG3B,OAAO,OAAO,KAAK,QAAQ,EAAE,QAASE,GAAa,CACjDA,EAAS,IAAIC,EAAeH,EAAK,KAAK,CAAC,CACzC,CAAC,CACH,OAASI,EAAO,CAGd,aAAO,OAAO,KAAK,QAAQ,EAAE,QAASF,GAAa,CACjDA,EAAS,IAAIC,EAAe,CAAC,CAC/B,CAAC,EACK,IAAIF,EAAS,4BAA6B,CAC9C,MAAOG,CACT,CAAC,CACH,CACF,CAWA,iBAAwB,CACtB,KAAK,SAAS,eAAiB,MACjC,CA0BA,MAAM,kBACJC,EACAC,EACoB,CACpB,KAAK,gBAAgB,EAErB,IAAMC,EAAsB,CAC1B,GAAGF,CACL,EAEM,CAAE,KAAAL,CAAK,EAAI,MAAM,KAAK,SAAS,aAAa,KAAK,uBAAwB,CAC7E,KAAM,CACJ,KAAM,qBACN,oBAAAO,EACA,mBAAoBD,CACtB,CACF,CAAC,EAED,GAAI,CAACN,EAAM,MAAM,IAAIC,EAAS,wCAAwC,EAEtE,GAAM,CAACO,EAAuB,GAAGC,CAAI,EAAIT,EAEnCU,EAAiBF,EAAsB,eAC7C,GAAI,CAACE,EACH,MAAM,IAAIT,EAAS,8CAA8C,EAGnE,YAAK,SAAS,eAAiBS,EAExBD,CACT,CAqBA,MAAM,YAAYE,EAAiD,CACjE,IAAMD,EAAiB,KAAK,SAAS,eACrC,GAAI,CAACA,EACH,MAAM,IAAIT,EAAS,yBAAyB,EAG9C,GAAM,CAAE,KAAAD,CAAK,EAAI,MAAM,KAAK,SAAS,aAAa,KAAK,uBAAwB,CAC7E,KAAM,CACJ,eAAAU,EACA,GAAGC,CACL,CACF,CAAC,EAED,GAAI,CAACX,EAAM,MAAM,IAAIC,EAAS,wCAAwC,EAItE,OAAOD,EAAK,OAAQY,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,CAeA,kBAAkC,CAChC,OAAO,KAAK,SAAS,OAAS,IAChC,CAQA,MAAM,gBAAgBL,EAAiD,CACrE,GAAI,CAACA,EACH,MAAM,IAAIT,EAAS,yBAAyB,EAG9C,GAAI,CACF,GAAM,CAAE,KAAAD,CAAK,EAAI,MAAM,KAAK,SAAS,aAAa,IAAI,yCAA0C,CAC9F,OAAQ,CACN,KAAM,CACJ,gBAAiBU,CACnB,CACF,CACF,CAAC,EAKD,GAFA,KAAK,SAAS,eAAiBA,EAE3B,CAACV,EAAM,MAAM,IAAIC,EAAS,gDAAgD,EAE9E,OAAOe,EAAoBhB,CAAI,CACjC,OAASI,EAAO,CACd,MAAM,IAAIH,EAAS,qCAAsC,CACvD,MAAOG,CACT,CAAC,CACH,CACF,CACF","names":["createClient","getItemWithExpiry","key","itemString","item","getItemWithExpiry_default","setItemWithExpiry","key","value","ttl","item","setItemWithExpiry_default","day","userIdTtl","conversationIdKey","sessionIdKey","tokenKey","userIdKey","deleteConversationId","getConversationId","setConversationId","conversationId","getSessionId","setSessionId","sessionId","isTokenExpired","token","payloadBase64","payload","error","getToken","setToken","getUserId","userId","getItemWithExpiry_default","setUserId","setItemWithExpiry_default","createIdentityProperty","getValue","setValue","clearValue","value","createIdentityStore","customerId","identity","properties","authMiddleware","accessToken","request","auth_default","errorMiddleware","response","data","error_default","headerMiddleware","identity","url","request","headers_default","stripConversationId","userMessage","conversationId","rest","getSelectedOptionLabel","previousTurn","message","option","getRestoredUserMessage","turn","getRestoredAssistantReply","nextTurn","shouldHideSingleSelect","restoreConversation","turns","index","version","SDKError","_SDKError","userMessage","cause","version","Client","config","conversationUrl","customerId","fetch","frontendUrl","defaultHeaders","headers","version","createClient","createIdentityStore","error_default","headers_default","sessionId","userId","data","SDKError","endpoint","auth_default","error","context","userMessage","conversationContext","conversationIdMessage","rest","conversationId","payload","message","eventName","properties","body","restoreConversation"]}
|