@15gifts/sdk 0.11.6 → 0.11.8

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.mts CHANGED
@@ -1070,7 +1070,7 @@ interface paths {
1070
1070
  * @description The customer that the event occurred on
1071
1071
  * @enum {string}
1072
1072
  */
1073
- customerId: "spectrum-us-media-consumer-en";
1073
+ customerId: "spectrum";
1074
1074
  /** @description The timestamp describing the time the event occurred. This should conform to ISO 8601 standards and be in UTC */
1075
1075
  eventAt?: string;
1076
1076
  /** @description A JWT used to identify the user in the system, can be obtained from the identity endpoint */
@@ -1224,56 +1224,26 @@ interface paths {
1224
1224
  bundleId?: string;
1225
1225
  }[];
1226
1226
  } | {
1227
- /** @description A 36 character alphanumeric hash that uniquely identifies a session.
1228
- *
1229
- *
1230
- * This should match the UUID V4 as specified in RFC 9652:
1231
- * https://datatracker.ietf.org/doc/html/rfc9562#name-uuid-version-4
1232
- *
1233
- * e.g f81d4fae-7dec-41d0-a765-00a0c91e6bf6 */
1234
- sessionId?: string | null;
1235
- /** @description A 36 character alphanumeric hash that uniquely identifies a user.
1236
- *
1237
- *
1238
- * This should match the UUID V4 as specified in RFC 9652:
1239
- * https://datatracker.ietf.org/doc/html/rfc9562#name-uuid-version-4
1240
- *
1241
- * e.g f81d4fae-7dec-41d0-a765-00a0c91e6bf6 */
1242
- userId?: string;
1243
- /** @description A timestamp describing the time the event occurred. This should conform to ISO 8601 standards and be in UTC. Example: \"2024-07-17T10:11:16.591Z\" */
1244
- eventAt?: string;
1245
- /** @description The page url at the time the event is fired */
1246
- url?: string;
1247
- /** @description What web browser the user is using e.g. chrome/firefox/safari etc. */
1248
- browser?: string;
1249
1227
  /**
1250
1228
  * @description The customer that the event occurred on
1251
1229
  * @enum {string}
1252
1230
  */
1253
1231
  customerId: "spectrum-us-media-consumer-en";
1254
- /** @description The user agent string e.g. \"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.124 Safari/537.36\" */
1255
- userAgent?: string;
1256
- /** @description A 36 character alphanumeric hash that uniquely identifies a tracking event
1257
- *
1258
- * This should match the UUID V4 as specified in RFC 9652:
1259
- * https://datatracker.ietf.org/doc/html/rfc9562#name-uuid-version-4
1260
- *
1261
- * e.g f81d4fae-7dec-41d0-a765-00a0c91e6bf6 */
1262
- eventId?: string;
1232
+ /** @description The timestamp describing the time the event occurred. This should conform to ISO 8601 standards and be in UTC */
1233
+ eventAt?: string;
1234
+ /** @description A JWT used to identify the user in the system, can be obtained from the identity endpoint */
1235
+ identityToken: string;
1236
+ /** @description The ID for the sale, a unique value we can correlate with customer records. */
1237
+ saleId: string;
1263
1238
  /**
1264
- * @description The name of an event
1239
+ * @description The type of user, for example, existing or prospect.
1265
1240
  * @enum {string}
1266
1241
  */
1267
- eventName?: "sale-completed";
1268
- /** @description A 36 character alphanumeric hash that uniquely identifies a page view (page-shown event)
1269
- *
1270
- * This should match the UUID V4 as specified in RFC 9652:
1271
- * https://datatracker.ietf.org/doc/html/rfc9562#name-uuid-version-4
1272
- *
1273
- * e.g f81d4fae-7dec-41d0-a765-00a0c91e6bf6 */
1274
- pageviewId?: string | null;
1275
- /** @description A unique user id native to our customers web analytics platforms (adobe, google analytics etc). Helps us & our customers align our data with what customers see in their platforms. */
1276
- webAnalyticsPlatformUserId?: string | null;
1242
+ userType: "existing" | "prospect";
1243
+ /** @description The browser the user is using, e.g. Chrome, Firefox, Safari, etc. */
1244
+ browser?: string;
1245
+ /** @description The user agent string e.g. "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.124 Safari/537.36" */
1246
+ userAgent?: string;
1277
1247
  /** @description The device screen width in pixels - window.screen.width in JS. This is a user level property that should never change. */
1278
1248
  screenWidth?: number;
1279
1249
  /** @description The device screen height in pixels - window.screen.height in JS. This is a user level property that should never change. */
@@ -1287,21 +1257,30 @@ interface paths {
1287
1257
  * screen_width > 480px = 'large'
1288
1258
  * @enum {string}
1289
1259
  */
1290
- screenSize?: "large" | "mobile";
1291
- /** @description The ID for the sale, a unique, non-empty value we can correlate with customer records. */
1292
- saleId: string;
1293
- /**
1294
- * @description The type of user, for example, existing or prospect.
1295
- * @enum {string}
1296
- */
1297
- userType: "existing" | "prospect";
1298
- /**
1299
- * @description A code that represents what currency the product price is listed in e.g. USD, GBP. This should match the ISO 4217 standard - see https://www.iban.com/currency-codes.
1300
- * @enum {string}
1301
- */
1302
- currencyCode?: "AUD" | "CAD" | "EUR" | "GBP" | "MXN" | "USD";
1260
+ screenSize?: "mobile" | "large";
1261
+ /** @description "A code that represents what currency the product price is listed in e.g. USD, GBP. This should match the ISO 4217 standard - see https://www.iban.com/currency-codes. */
1262
+ currencyCode?: string;
1263
+ /** @description The host/domain of the URL at the time the event is fired */
1264
+ siteHost: string;
1265
+ /** @description The path of the URL (including an initial `/`) at the time the event is fired */
1266
+ sitePath?: string;
1267
+ /** @description The query string of the URL (including an initial `?`) at the time the event is fired */
1268
+ siteQueryString?: string;
1269
+ /** @description The language of the part of the site the sales data is coming from in ISO 639-1 format e.g. 'en-us', 'es-us' etc. */
1270
+ language?: string;
1271
+ /** @description The recurring payment due per payment period */
1272
+ priceRecurring: number;
1273
+ /** @description An ISO-8601 duration that represents the period of time that the priceRecurring payment recurs over */
1274
+ priceRecurringPeriod: string;
1275
+ /** @description The upfront price the user has to pay for the product. */
1276
+ priceUpfront?: number;
1303
1277
  /** @description The full basket value of the sale, inclusive of any offers. */
1304
- saleTotalValue?: number;
1278
+ totalValueOfSale?: number;
1279
+ /** @description The taxes the user has to pay relating to the priceUpfront of the product(s) */
1280
+ totalUpfrontTax?: number;
1281
+ /** @description The taxes the user has to pay relating to the priceRecurring of the product(s), due per payment period */
1282
+ totalRecurringTax?: number;
1283
+ totalTaxOnSale?: number;
1305
1284
  /** @description A list containing separate line items for each product sold. */
1306
1285
  productsSold: {
1307
1286
  /** @description The ID or SKU of a product that is provided by the customer */
@@ -1310,78 +1289,19 @@ interface paths {
1310
1289
  siteProductName: string;
1311
1290
  /** @description The category of products the product belongs to. */
1312
1291
  siteProductType: string;
1292
+ /** @description An ISO-8601 duration that represents the contract length */
1293
+ productContractLength: string;
1294
+ /** @description An integer representing how many of this particular product the user is purchasing */
1295
+ quantity: number;
1313
1296
  /** @description The upfront price the user has to pay for the product. */
1314
1297
  productPriceUpfront: number;
1315
- }[];
1316
- /**
1317
- * @description The language of the part of the site the sales data is coming from in ISO 639-1 format e.g. 'en', 'es' etc.
1318
- * @enum {string}
1319
- */
1320
- language?: "de" | "en" | "es" | "fr" | "it";
1321
- /** @description This property is intended to replace session_id, but is being used in the meantime so that developers can switch over to using browser_session_id without different services needing to all update in sync.
1322
- *
1323
- * A 36 character alphanumeric hash that uniquely identifies a session.
1324
- *
1325
- *
1326
- * This should match the UUID V4 as specified in RFC 9652:
1327
- * https://datatracker.ietf.org/doc/html/rfc9562#name-uuid-version-4
1328
- *
1329
- * e.g f81d4fae-7dec-41d0-a765-00a0c91e6bf6 */
1330
- browserSessionId?: string | null;
1331
- /** @description A list of product items with properties that are specific to Spectrum */
1332
- productsSoldSpectrum?: {
1333
- /** @description The ID or SKU of a product that is provided by the customer */
1334
- siteProductId: string;
1335
- /** @description The ID of the bundle that a product is part of (if it's in one) */
1336
- bundleId: string;
1337
- }[];
1338
- /** @description Properties at the sale level (not product item level) specifically required from media customers */
1339
- saleCustomPropertiesMedia?: {
1340
- /** @description The total monthly cost at the sale level */
1341
- priceMonthly: number;
1342
- };
1343
- /** @description A list of product item objects specific to media customers */
1344
- productsSoldMedia?: {
1345
- /** @description The ID or SKU of a product that is provided by the customer */
1346
- siteProductId: string;
1347
- /** @description The recurring payment per payment period */
1298
+ /** @description The recurring payment per payment period for the product */
1348
1299
  productPricePerPeriod: number;
1349
- /** @description An ISO-8601 duration that represents the period of time that the product_price_per_period payment recurs over */
1300
+ /** @description An ISO-8601 duration that represents the period of time that the productPricePerPeriod payment recurs over */
1350
1301
  productRecurringPaymentPeriod: string;
1351
- /** @description An ISO-8601 duration that represents the contract length */
1352
- productContractLength: string;
1302
+ /** @description The ID or SKU of a bundle that the product (and other products being purchased at the same time) are part of */
1303
+ bundleId?: string;
1353
1304
  }[];
1354
- /**
1355
- * @description The name of the system/service that the event originates from
1356
- * @enum {string}
1357
- */
1358
- service?: "frontend" | "salesTrackingApi";
1359
- /** @description A JSON object containing the different versions of services directly used by the service that tracks an event. The version of the service that is firing any tracking event should ALWAYS be included, for example if the conversation_api is firing an event, service_versions should include conversation_api_version. It should also ideally include the version numbers of any other services used in the generation of the event that is being tracked. */
1360
- serviceVersions?: {
1361
- /** @description The version number for the frontend service */
1362
- frontendVersion?: string | null;
1363
- /** @description The version number for the frontend api service */
1364
- frontendApiVersion?: string | null;
1365
- /** @description The version number for the conversation api service */
1366
- conversationApiVersion?: string | null;
1367
- /** @description The version number for the customer configuration service */
1368
- customerConfigurationVersion?: string | null;
1369
- /** @description The version number for the client library our customers are using */
1370
- sdkVersion?: string | null;
1371
- /** @description The version number for the product configuration data */
1372
- productConfigurationVersion?: string | null;
1373
- /** @description The version number for the sales tracking api service. *in the short term this is technically just the frontend so will match that */
1374
- salesTrackingApiVersion?: string | null;
1375
- /** @description The version number for the recommender service */
1376
- recommenderVersion?: string | null;
1377
- };
1378
- /**
1379
- * @description The environment the event originated from (production/development/testing/staging/local/uat/ephemeral)
1380
- * @enum {string}
1381
- */
1382
- environment?: "development" | "ephemeral" | "local" | "production" | "staging" | "test" | "uat";
1383
- /** @description A JWT used to identify the user in the system, can be obtained from the identity endpoint */
1384
- identityToken: string;
1385
1305
  };
1386
1306
  };
1387
1307
  };
@@ -1577,6 +1497,8 @@ interface paths {
1577
1497
  *
1578
1498
  * e.g f81d4fae-7dec-41d0-a765-00a0c91e6bf6 */
1579
1499
  browser_session_id?: string | null;
1500
+ /** @description The type of entry point the event refers to, e.g. engagement_button (previously named tab), engagement popup (previously named engagement bubble) etc */
1501
+ entry_point_type?: string;
1580
1502
  /** @description The name of the system/service that the event originates from */
1581
1503
  service?: string;
1582
1504
  /** @description A JSON object containing the different versions of services directly used by the service that tracks an event. The version of the service that is firing any tracking event should ALWAYS be included, for example if the conversation_api is firing an event, service_versions should include conversation_api_version. It should also ideally include the version numbers of any other services used in the generation of the event that is being tracked. */
@@ -1625,14 +1547,18 @@ interface paths {
1625
1547
  is_pre_output_guardrail_checks?: boolean;
1626
1548
  /** @description Describes the stage that the conversation is currently at. A conversation stage is triggered in response to each user message, and according to the stage, the main LLM prompt is tweaked to apply specific instructions and steer the conversation. */
1627
1549
  conversation_stage?: string | null;
1628
- /** @description A list of products sent in a conversation api message, typically initially in a recommendation message, but then could also be in an exit_to_purchase message. */
1629
- recommendation_products?: unknown[];
1550
+ /** @description A list of ids that each relate to a single recommendation that was shown in a set of recs */
1551
+ recommendation_ids_recommended?: unknown[];
1630
1552
  /** @description Contains the fallback text provided by the conversation api to a frontend that non 'text' (single_select/multi_select etc) messages could revert to if they needed to. Described in the conversation api docs as: \"What should a client render if they do not have a native renderer for this message type?\". */
1631
1553
  fallback_text?: string;
1632
1554
  /** @description Specifies if a free text response can be provided to an assistant single/multi-select message */
1633
1555
  is_allow_free_text_message?: boolean;
1634
1556
  /** @description The reason an exit to chat response was provided by the conversation api */
1635
1557
  exit_to_chat_reason?: string;
1558
+ /** @description A list of ids that each correspond to their own recommendation, with all recs in the list being 'exit to purchase-able' or 'exit to chat-able' */
1559
+ recommendation_ids_for_exit?: unknown[];
1560
+ /** @description The type of destination the user will be sent to as a result of exiting to chat. E.g 'phone','chat','email' etc */
1561
+ exit_destination_type?: string;
1636
1562
  /** @description The ID for the sale, a unique, non-empty value we can correlate with customer records. */
1637
1563
  sale_id?: string;
1638
1564
  /** @description The type of user, for example, existing or prospect. */
@@ -1655,6 +1581,8 @@ interface paths {
1655
1581
  sale_custom_properties_aidem?: Record<string, never>;
1656
1582
  /** @description A list of product items with properties that are specific to Aidem */
1657
1583
  products_sold_aidem?: unknown[];
1584
+ /** @description Specifies whether the click on the entry point was a positive or negative CTA. Positive would be expected to open the tool ui, negative would be expected to close the entry point. */
1585
+ entry_point_click_type?: string | null;
1658
1586
  /** @description True if user has qualified for using the 15gifts sales advisor (except on customers with no qualification process where this will always be True) */
1659
1587
  is_qualified?: boolean;
1660
1588
  /** @description The stage on the particular customer's site that a user would be expected to qualify at. Should be NULL for customer sites that don't have a qualification process.
@@ -1679,12 +1607,14 @@ interface paths {
1679
1607
  *
1680
1608
  * https://backoffice.15gifts.com/product/recommender/slots */
1681
1609
  slots?: unknown[];
1682
- /** @description The type of entry point the event refers to (tab, engagement bubble etc) */
1683
- entry_point_type?: string;
1684
1610
  /** @description Describes the reason the entry point was closed. When the value is 'customer_triggered' it's because it's been programmatically closed by the customer (by running window.axiom.integrations.hide()). When it's 'user_close_click' it's because the actual end user has closed it manually by clicking. */
1685
1611
  entry_point_closed_reason?: string;
1686
- /** @description The type of destination the user will be sent to as a result of exiting to chat. E.g 'phone','chat','email' etc */
1687
- exit_destination_type?: string;
1612
+ /** @description A list of objects for recommendations sent in a conversation api message. */
1613
+ recommendation_set?: unknown[];
1614
+ /** @description This is a score that evaluates how much progress has been made through the discovery phase of the conversation. A higher score means more information has been discovered. This value is generated by the recommender.
1615
+ *
1616
+ * https://github.com/15gifts/indy-contracts/blob/main/contracts/recommendation_v2_generate.json#L57 */
1617
+ discovery_progress_score?: number;
1688
1618
  };
1689
1619
  /**
1690
1620
  * @description A 36 character hash, 5 segments, separated by dashes that uniquely identifies a conversation
@@ -1695,7 +1625,7 @@ interface paths {
1695
1625
  * @description Event Name
1696
1626
  * @enum {string}
1697
1627
  */
1698
- eventName: "entry_point-shown" | "feedback_submit-clicked" | "page-shown" | "tool_ui-closed" | "user_message-submitted" | "user_message-submitted message" | "user_message-submitted single_select" | "user_message-submitted multi_select" | "assistant_message-submitted" | "assistant_message-submitted recommendation" | "assistant_message-submitted message" | "assistant_message-submitted single_select" | "assistant_message-submitted multi_select" | "assistant_message-submitted exit_to_chat" | "assistant_message-submitted exit_to_purchase" | "feedback-shown" | "feedback_skip-clicked" | "sale-completed" | "sale-completed spectrum" | "sale-completed aidem" | "sale-completed spectrum-us-media-consumer-en" | "entry_point-clicked" | "tool_close-clicked" | "exit_to_chat-completed" | "exit_to_purchase-completed" | "conversation-started" | "user_qualification-identified" | "experiment_variation-assigned" | "slot_filling-completed" | "entry_point-closed" | "entry_point-suppressed" | "exit_to_human-completed" | "user-created";
1628
+ eventName: "entry_point-shown" | "feedback_submit-clicked" | "page-shown" | "tool_ui-closed" | "user_message-submitted" | "user_message-submitted message" | "user_message-submitted single_select" | "user_message-submitted multi_select" | "assistant_message-submitted" | "assistant_message-submitted recommendation" | "assistant_message-submitted message" | "assistant_message-submitted single_select" | "assistant_message-submitted multi_select" | "assistant_message-submitted exit_to_chat" | "assistant_message-submitted exit_to_purchase" | "assistant_message-submitted exit_to_human" | "feedback-shown" | "feedback_skip-clicked" | "sale-completed" | "sale-completed spectrum" | "sale-completed aidem" | "sale-completed spectrum-us-media-consumer-en" | "entry_point-clicked" | "tool_close-clicked" | "exit_to_chat-completed" | "exit_to_purchase-completed" | "conversation-started" | "user_qualification-identified" | "experiment_variation-assigned" | "slot_filling-completed" | "entry_point-closed" | "entry_point-suppressed" | "user-created" | "exit_to_human-completed" | "recommendation_set-returned" | "ww_rag_context-used";
1699
1629
  /**
1700
1630
  * @description A 36 character hash, 5 segments, separated by dashes that uniquely identifies a page view (page-shown event)
1701
1631
  * @example 1a1a1a1a-1a1a-1a1a-1a1a-1a1a1a1a1a1a
@@ -1986,6 +1916,7 @@ declare class Client {
1986
1916
  screen_height?: number;
1987
1917
  screen_size?: string;
1988
1918
  browser_session_id?: string | null;
1919
+ entry_point_type?: string;
1989
1920
  service?: string;
1990
1921
  service_versions?: Record<string, never>;
1991
1922
  environment?: string;
@@ -2002,10 +1933,12 @@ declare class Client {
2002
1933
  guardrails?: unknown[];
2003
1934
  is_pre_output_guardrail_checks?: boolean;
2004
1935
  conversation_stage?: string | null;
2005
- recommendation_products?: unknown[];
1936
+ recommendation_ids_recommended?: unknown[];
2006
1937
  fallback_text?: string;
2007
1938
  is_allow_free_text_message?: boolean;
2008
1939
  exit_to_chat_reason?: string;
1940
+ recommendation_ids_for_exit?: unknown[];
1941
+ exit_destination_type?: string;
2009
1942
  sale_id?: string;
2010
1943
  user_type?: string;
2011
1944
  currency_code?: string;
@@ -2017,6 +1950,7 @@ declare class Client {
2017
1950
  products_sold_media?: unknown[];
2018
1951
  sale_custom_properties_aidem?: Record<string, never>;
2019
1952
  products_sold_aidem?: unknown[];
1953
+ entry_point_click_type?: string | null;
2020
1954
  is_qualified?: boolean;
2021
1955
  qualification_stage?: string;
2022
1956
  is_main_uplift_experiment?: boolean;
@@ -2024,12 +1958,12 @@ declare class Client {
2024
1958
  experiment_variation_id?: string;
2025
1959
  experiment_variation_name?: string;
2026
1960
  slots?: unknown[];
2027
- entry_point_type?: string;
2028
1961
  entry_point_closed_reason?: string;
2029
- exit_destination_type?: string;
1962
+ recommendation_set?: unknown[];
1963
+ discovery_progress_score?: number;
2030
1964
  };
2031
1965
  conversationId?: string;
2032
- eventName: "entry_point-shown" | "feedback_submit-clicked" | "page-shown" | "tool_ui-closed" | "user_message-submitted" | "user_message-submitted message" | "user_message-submitted single_select" | "user_message-submitted multi_select" | "assistant_message-submitted" | "assistant_message-submitted recommendation" | "assistant_message-submitted message" | "assistant_message-submitted single_select" | "assistant_message-submitted multi_select" | "assistant_message-submitted exit_to_chat" | "assistant_message-submitted exit_to_purchase" | "feedback-shown" | "feedback_skip-clicked" | "sale-completed" | "sale-completed spectrum" | "sale-completed aidem" | "sale-completed spectrum-us-media-consumer-en" | "entry_point-clicked" | "tool_close-clicked" | "exit_to_chat-completed" | "exit_to_purchase-completed" | "conversation-started" | "user_qualification-identified" | "experiment_variation-assigned" | "slot_filling-completed" | "entry_point-closed" | "entry_point-suppressed" | "exit_to_human-completed" | "user-created";
1966
+ eventName: "entry_point-shown" | "feedback_submit-clicked" | "page-shown" | "tool_ui-closed" | "user_message-submitted" | "user_message-submitted message" | "user_message-submitted single_select" | "user_message-submitted multi_select" | "assistant_message-submitted" | "assistant_message-submitted recommendation" | "assistant_message-submitted message" | "assistant_message-submitted single_select" | "assistant_message-submitted multi_select" | "assistant_message-submitted exit_to_chat" | "assistant_message-submitted exit_to_purchase" | "assistant_message-submitted exit_to_human" | "feedback-shown" | "feedback_skip-clicked" | "sale-completed" | "sale-completed spectrum" | "sale-completed aidem" | "sale-completed spectrum-us-media-consumer-en" | "entry_point-clicked" | "tool_close-clicked" | "exit_to_chat-completed" | "exit_to_purchase-completed" | "conversation-started" | "user_qualification-identified" | "experiment_variation-assigned" | "slot_filling-completed" | "entry_point-closed" | "entry_point-suppressed" | "user-created" | "exit_to_human-completed" | "recommendation_set-returned" | "ww_rag_context-used";
2033
1967
  pageviewId: string;
2034
1968
  screenHeight?: number;
2035
1969
  screenSize?: "mobile" | "large";
package/dist/index.d.ts CHANGED
@@ -1070,7 +1070,7 @@ interface paths {
1070
1070
  * @description The customer that the event occurred on
1071
1071
  * @enum {string}
1072
1072
  */
1073
- customerId: "spectrum-us-media-consumer-en";
1073
+ customerId: "spectrum";
1074
1074
  /** @description The timestamp describing the time the event occurred. This should conform to ISO 8601 standards and be in UTC */
1075
1075
  eventAt?: string;
1076
1076
  /** @description A JWT used to identify the user in the system, can be obtained from the identity endpoint */
@@ -1224,56 +1224,26 @@ interface paths {
1224
1224
  bundleId?: string;
1225
1225
  }[];
1226
1226
  } | {
1227
- /** @description A 36 character alphanumeric hash that uniquely identifies a session.
1228
- *
1229
- *
1230
- * This should match the UUID V4 as specified in RFC 9652:
1231
- * https://datatracker.ietf.org/doc/html/rfc9562#name-uuid-version-4
1232
- *
1233
- * e.g f81d4fae-7dec-41d0-a765-00a0c91e6bf6 */
1234
- sessionId?: string | null;
1235
- /** @description A 36 character alphanumeric hash that uniquely identifies a user.
1236
- *
1237
- *
1238
- * This should match the UUID V4 as specified in RFC 9652:
1239
- * https://datatracker.ietf.org/doc/html/rfc9562#name-uuid-version-4
1240
- *
1241
- * e.g f81d4fae-7dec-41d0-a765-00a0c91e6bf6 */
1242
- userId?: string;
1243
- /** @description A timestamp describing the time the event occurred. This should conform to ISO 8601 standards and be in UTC. Example: \"2024-07-17T10:11:16.591Z\" */
1244
- eventAt?: string;
1245
- /** @description The page url at the time the event is fired */
1246
- url?: string;
1247
- /** @description What web browser the user is using e.g. chrome/firefox/safari etc. */
1248
- browser?: string;
1249
1227
  /**
1250
1228
  * @description The customer that the event occurred on
1251
1229
  * @enum {string}
1252
1230
  */
1253
1231
  customerId: "spectrum-us-media-consumer-en";
1254
- /** @description The user agent string e.g. \"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.124 Safari/537.36\" */
1255
- userAgent?: string;
1256
- /** @description A 36 character alphanumeric hash that uniquely identifies a tracking event
1257
- *
1258
- * This should match the UUID V4 as specified in RFC 9652:
1259
- * https://datatracker.ietf.org/doc/html/rfc9562#name-uuid-version-4
1260
- *
1261
- * e.g f81d4fae-7dec-41d0-a765-00a0c91e6bf6 */
1262
- eventId?: string;
1232
+ /** @description The timestamp describing the time the event occurred. This should conform to ISO 8601 standards and be in UTC */
1233
+ eventAt?: string;
1234
+ /** @description A JWT used to identify the user in the system, can be obtained from the identity endpoint */
1235
+ identityToken: string;
1236
+ /** @description The ID for the sale, a unique value we can correlate with customer records. */
1237
+ saleId: string;
1263
1238
  /**
1264
- * @description The name of an event
1239
+ * @description The type of user, for example, existing or prospect.
1265
1240
  * @enum {string}
1266
1241
  */
1267
- eventName?: "sale-completed";
1268
- /** @description A 36 character alphanumeric hash that uniquely identifies a page view (page-shown event)
1269
- *
1270
- * This should match the UUID V4 as specified in RFC 9652:
1271
- * https://datatracker.ietf.org/doc/html/rfc9562#name-uuid-version-4
1272
- *
1273
- * e.g f81d4fae-7dec-41d0-a765-00a0c91e6bf6 */
1274
- pageviewId?: string | null;
1275
- /** @description A unique user id native to our customers web analytics platforms (adobe, google analytics etc). Helps us & our customers align our data with what customers see in their platforms. */
1276
- webAnalyticsPlatformUserId?: string | null;
1242
+ userType: "existing" | "prospect";
1243
+ /** @description The browser the user is using, e.g. Chrome, Firefox, Safari, etc. */
1244
+ browser?: string;
1245
+ /** @description The user agent string e.g. "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.124 Safari/537.36" */
1246
+ userAgent?: string;
1277
1247
  /** @description The device screen width in pixels - window.screen.width in JS. This is a user level property that should never change. */
1278
1248
  screenWidth?: number;
1279
1249
  /** @description The device screen height in pixels - window.screen.height in JS. This is a user level property that should never change. */
@@ -1287,21 +1257,30 @@ interface paths {
1287
1257
  * screen_width > 480px = 'large'
1288
1258
  * @enum {string}
1289
1259
  */
1290
- screenSize?: "large" | "mobile";
1291
- /** @description The ID for the sale, a unique, non-empty value we can correlate with customer records. */
1292
- saleId: string;
1293
- /**
1294
- * @description The type of user, for example, existing or prospect.
1295
- * @enum {string}
1296
- */
1297
- userType: "existing" | "prospect";
1298
- /**
1299
- * @description A code that represents what currency the product price is listed in e.g. USD, GBP. This should match the ISO 4217 standard - see https://www.iban.com/currency-codes.
1300
- * @enum {string}
1301
- */
1302
- currencyCode?: "AUD" | "CAD" | "EUR" | "GBP" | "MXN" | "USD";
1260
+ screenSize?: "mobile" | "large";
1261
+ /** @description "A code that represents what currency the product price is listed in e.g. USD, GBP. This should match the ISO 4217 standard - see https://www.iban.com/currency-codes. */
1262
+ currencyCode?: string;
1263
+ /** @description The host/domain of the URL at the time the event is fired */
1264
+ siteHost: string;
1265
+ /** @description The path of the URL (including an initial `/`) at the time the event is fired */
1266
+ sitePath?: string;
1267
+ /** @description The query string of the URL (including an initial `?`) at the time the event is fired */
1268
+ siteQueryString?: string;
1269
+ /** @description The language of the part of the site the sales data is coming from in ISO 639-1 format e.g. 'en-us', 'es-us' etc. */
1270
+ language?: string;
1271
+ /** @description The recurring payment due per payment period */
1272
+ priceRecurring: number;
1273
+ /** @description An ISO-8601 duration that represents the period of time that the priceRecurring payment recurs over */
1274
+ priceRecurringPeriod: string;
1275
+ /** @description The upfront price the user has to pay for the product. */
1276
+ priceUpfront?: number;
1303
1277
  /** @description The full basket value of the sale, inclusive of any offers. */
1304
- saleTotalValue?: number;
1278
+ totalValueOfSale?: number;
1279
+ /** @description The taxes the user has to pay relating to the priceUpfront of the product(s) */
1280
+ totalUpfrontTax?: number;
1281
+ /** @description The taxes the user has to pay relating to the priceRecurring of the product(s), due per payment period */
1282
+ totalRecurringTax?: number;
1283
+ totalTaxOnSale?: number;
1305
1284
  /** @description A list containing separate line items for each product sold. */
1306
1285
  productsSold: {
1307
1286
  /** @description The ID or SKU of a product that is provided by the customer */
@@ -1310,78 +1289,19 @@ interface paths {
1310
1289
  siteProductName: string;
1311
1290
  /** @description The category of products the product belongs to. */
1312
1291
  siteProductType: string;
1292
+ /** @description An ISO-8601 duration that represents the contract length */
1293
+ productContractLength: string;
1294
+ /** @description An integer representing how many of this particular product the user is purchasing */
1295
+ quantity: number;
1313
1296
  /** @description The upfront price the user has to pay for the product. */
1314
1297
  productPriceUpfront: number;
1315
- }[];
1316
- /**
1317
- * @description The language of the part of the site the sales data is coming from in ISO 639-1 format e.g. 'en', 'es' etc.
1318
- * @enum {string}
1319
- */
1320
- language?: "de" | "en" | "es" | "fr" | "it";
1321
- /** @description This property is intended to replace session_id, but is being used in the meantime so that developers can switch over to using browser_session_id without different services needing to all update in sync.
1322
- *
1323
- * A 36 character alphanumeric hash that uniquely identifies a session.
1324
- *
1325
- *
1326
- * This should match the UUID V4 as specified in RFC 9652:
1327
- * https://datatracker.ietf.org/doc/html/rfc9562#name-uuid-version-4
1328
- *
1329
- * e.g f81d4fae-7dec-41d0-a765-00a0c91e6bf6 */
1330
- browserSessionId?: string | null;
1331
- /** @description A list of product items with properties that are specific to Spectrum */
1332
- productsSoldSpectrum?: {
1333
- /** @description The ID or SKU of a product that is provided by the customer */
1334
- siteProductId: string;
1335
- /** @description The ID of the bundle that a product is part of (if it's in one) */
1336
- bundleId: string;
1337
- }[];
1338
- /** @description Properties at the sale level (not product item level) specifically required from media customers */
1339
- saleCustomPropertiesMedia?: {
1340
- /** @description The total monthly cost at the sale level */
1341
- priceMonthly: number;
1342
- };
1343
- /** @description A list of product item objects specific to media customers */
1344
- productsSoldMedia?: {
1345
- /** @description The ID or SKU of a product that is provided by the customer */
1346
- siteProductId: string;
1347
- /** @description The recurring payment per payment period */
1298
+ /** @description The recurring payment per payment period for the product */
1348
1299
  productPricePerPeriod: number;
1349
- /** @description An ISO-8601 duration that represents the period of time that the product_price_per_period payment recurs over */
1300
+ /** @description An ISO-8601 duration that represents the period of time that the productPricePerPeriod payment recurs over */
1350
1301
  productRecurringPaymentPeriod: string;
1351
- /** @description An ISO-8601 duration that represents the contract length */
1352
- productContractLength: string;
1302
+ /** @description The ID or SKU of a bundle that the product (and other products being purchased at the same time) are part of */
1303
+ bundleId?: string;
1353
1304
  }[];
1354
- /**
1355
- * @description The name of the system/service that the event originates from
1356
- * @enum {string}
1357
- */
1358
- service?: "frontend" | "salesTrackingApi";
1359
- /** @description A JSON object containing the different versions of services directly used by the service that tracks an event. The version of the service that is firing any tracking event should ALWAYS be included, for example if the conversation_api is firing an event, service_versions should include conversation_api_version. It should also ideally include the version numbers of any other services used in the generation of the event that is being tracked. */
1360
- serviceVersions?: {
1361
- /** @description The version number for the frontend service */
1362
- frontendVersion?: string | null;
1363
- /** @description The version number for the frontend api service */
1364
- frontendApiVersion?: string | null;
1365
- /** @description The version number for the conversation api service */
1366
- conversationApiVersion?: string | null;
1367
- /** @description The version number for the customer configuration service */
1368
- customerConfigurationVersion?: string | null;
1369
- /** @description The version number for the client library our customers are using */
1370
- sdkVersion?: string | null;
1371
- /** @description The version number for the product configuration data */
1372
- productConfigurationVersion?: string | null;
1373
- /** @description The version number for the sales tracking api service. *in the short term this is technically just the frontend so will match that */
1374
- salesTrackingApiVersion?: string | null;
1375
- /** @description The version number for the recommender service */
1376
- recommenderVersion?: string | null;
1377
- };
1378
- /**
1379
- * @description The environment the event originated from (production/development/testing/staging/local/uat/ephemeral)
1380
- * @enum {string}
1381
- */
1382
- environment?: "development" | "ephemeral" | "local" | "production" | "staging" | "test" | "uat";
1383
- /** @description A JWT used to identify the user in the system, can be obtained from the identity endpoint */
1384
- identityToken: string;
1385
1305
  };
1386
1306
  };
1387
1307
  };
@@ -1577,6 +1497,8 @@ interface paths {
1577
1497
  *
1578
1498
  * e.g f81d4fae-7dec-41d0-a765-00a0c91e6bf6 */
1579
1499
  browser_session_id?: string | null;
1500
+ /** @description The type of entry point the event refers to, e.g. engagement_button (previously named tab), engagement popup (previously named engagement bubble) etc */
1501
+ entry_point_type?: string;
1580
1502
  /** @description The name of the system/service that the event originates from */
1581
1503
  service?: string;
1582
1504
  /** @description A JSON object containing the different versions of services directly used by the service that tracks an event. The version of the service that is firing any tracking event should ALWAYS be included, for example if the conversation_api is firing an event, service_versions should include conversation_api_version. It should also ideally include the version numbers of any other services used in the generation of the event that is being tracked. */
@@ -1625,14 +1547,18 @@ interface paths {
1625
1547
  is_pre_output_guardrail_checks?: boolean;
1626
1548
  /** @description Describes the stage that the conversation is currently at. A conversation stage is triggered in response to each user message, and according to the stage, the main LLM prompt is tweaked to apply specific instructions and steer the conversation. */
1627
1549
  conversation_stage?: string | null;
1628
- /** @description A list of products sent in a conversation api message, typically initially in a recommendation message, but then could also be in an exit_to_purchase message. */
1629
- recommendation_products?: unknown[];
1550
+ /** @description A list of ids that each relate to a single recommendation that was shown in a set of recs */
1551
+ recommendation_ids_recommended?: unknown[];
1630
1552
  /** @description Contains the fallback text provided by the conversation api to a frontend that non 'text' (single_select/multi_select etc) messages could revert to if they needed to. Described in the conversation api docs as: \"What should a client render if they do not have a native renderer for this message type?\". */
1631
1553
  fallback_text?: string;
1632
1554
  /** @description Specifies if a free text response can be provided to an assistant single/multi-select message */
1633
1555
  is_allow_free_text_message?: boolean;
1634
1556
  /** @description The reason an exit to chat response was provided by the conversation api */
1635
1557
  exit_to_chat_reason?: string;
1558
+ /** @description A list of ids that each correspond to their own recommendation, with all recs in the list being 'exit to purchase-able' or 'exit to chat-able' */
1559
+ recommendation_ids_for_exit?: unknown[];
1560
+ /** @description The type of destination the user will be sent to as a result of exiting to chat. E.g 'phone','chat','email' etc */
1561
+ exit_destination_type?: string;
1636
1562
  /** @description The ID for the sale, a unique, non-empty value we can correlate with customer records. */
1637
1563
  sale_id?: string;
1638
1564
  /** @description The type of user, for example, existing or prospect. */
@@ -1655,6 +1581,8 @@ interface paths {
1655
1581
  sale_custom_properties_aidem?: Record<string, never>;
1656
1582
  /** @description A list of product items with properties that are specific to Aidem */
1657
1583
  products_sold_aidem?: unknown[];
1584
+ /** @description Specifies whether the click on the entry point was a positive or negative CTA. Positive would be expected to open the tool ui, negative would be expected to close the entry point. */
1585
+ entry_point_click_type?: string | null;
1658
1586
  /** @description True if user has qualified for using the 15gifts sales advisor (except on customers with no qualification process where this will always be True) */
1659
1587
  is_qualified?: boolean;
1660
1588
  /** @description The stage on the particular customer's site that a user would be expected to qualify at. Should be NULL for customer sites that don't have a qualification process.
@@ -1679,12 +1607,14 @@ interface paths {
1679
1607
  *
1680
1608
  * https://backoffice.15gifts.com/product/recommender/slots */
1681
1609
  slots?: unknown[];
1682
- /** @description The type of entry point the event refers to (tab, engagement bubble etc) */
1683
- entry_point_type?: string;
1684
1610
  /** @description Describes the reason the entry point was closed. When the value is 'customer_triggered' it's because it's been programmatically closed by the customer (by running window.axiom.integrations.hide()). When it's 'user_close_click' it's because the actual end user has closed it manually by clicking. */
1685
1611
  entry_point_closed_reason?: string;
1686
- /** @description The type of destination the user will be sent to as a result of exiting to chat. E.g 'phone','chat','email' etc */
1687
- exit_destination_type?: string;
1612
+ /** @description A list of objects for recommendations sent in a conversation api message. */
1613
+ recommendation_set?: unknown[];
1614
+ /** @description This is a score that evaluates how much progress has been made through the discovery phase of the conversation. A higher score means more information has been discovered. This value is generated by the recommender.
1615
+ *
1616
+ * https://github.com/15gifts/indy-contracts/blob/main/contracts/recommendation_v2_generate.json#L57 */
1617
+ discovery_progress_score?: number;
1688
1618
  };
1689
1619
  /**
1690
1620
  * @description A 36 character hash, 5 segments, separated by dashes that uniquely identifies a conversation
@@ -1695,7 +1625,7 @@ interface paths {
1695
1625
  * @description Event Name
1696
1626
  * @enum {string}
1697
1627
  */
1698
- eventName: "entry_point-shown" | "feedback_submit-clicked" | "page-shown" | "tool_ui-closed" | "user_message-submitted" | "user_message-submitted message" | "user_message-submitted single_select" | "user_message-submitted multi_select" | "assistant_message-submitted" | "assistant_message-submitted recommendation" | "assistant_message-submitted message" | "assistant_message-submitted single_select" | "assistant_message-submitted multi_select" | "assistant_message-submitted exit_to_chat" | "assistant_message-submitted exit_to_purchase" | "feedback-shown" | "feedback_skip-clicked" | "sale-completed" | "sale-completed spectrum" | "sale-completed aidem" | "sale-completed spectrum-us-media-consumer-en" | "entry_point-clicked" | "tool_close-clicked" | "exit_to_chat-completed" | "exit_to_purchase-completed" | "conversation-started" | "user_qualification-identified" | "experiment_variation-assigned" | "slot_filling-completed" | "entry_point-closed" | "entry_point-suppressed" | "exit_to_human-completed" | "user-created";
1628
+ eventName: "entry_point-shown" | "feedback_submit-clicked" | "page-shown" | "tool_ui-closed" | "user_message-submitted" | "user_message-submitted message" | "user_message-submitted single_select" | "user_message-submitted multi_select" | "assistant_message-submitted" | "assistant_message-submitted recommendation" | "assistant_message-submitted message" | "assistant_message-submitted single_select" | "assistant_message-submitted multi_select" | "assistant_message-submitted exit_to_chat" | "assistant_message-submitted exit_to_purchase" | "assistant_message-submitted exit_to_human" | "feedback-shown" | "feedback_skip-clicked" | "sale-completed" | "sale-completed spectrum" | "sale-completed aidem" | "sale-completed spectrum-us-media-consumer-en" | "entry_point-clicked" | "tool_close-clicked" | "exit_to_chat-completed" | "exit_to_purchase-completed" | "conversation-started" | "user_qualification-identified" | "experiment_variation-assigned" | "slot_filling-completed" | "entry_point-closed" | "entry_point-suppressed" | "user-created" | "exit_to_human-completed" | "recommendation_set-returned" | "ww_rag_context-used";
1699
1629
  /**
1700
1630
  * @description A 36 character hash, 5 segments, separated by dashes that uniquely identifies a page view (page-shown event)
1701
1631
  * @example 1a1a1a1a-1a1a-1a1a-1a1a-1a1a1a1a1a1a
@@ -1986,6 +1916,7 @@ declare class Client {
1986
1916
  screen_height?: number;
1987
1917
  screen_size?: string;
1988
1918
  browser_session_id?: string | null;
1919
+ entry_point_type?: string;
1989
1920
  service?: string;
1990
1921
  service_versions?: Record<string, never>;
1991
1922
  environment?: string;
@@ -2002,10 +1933,12 @@ declare class Client {
2002
1933
  guardrails?: unknown[];
2003
1934
  is_pre_output_guardrail_checks?: boolean;
2004
1935
  conversation_stage?: string | null;
2005
- recommendation_products?: unknown[];
1936
+ recommendation_ids_recommended?: unknown[];
2006
1937
  fallback_text?: string;
2007
1938
  is_allow_free_text_message?: boolean;
2008
1939
  exit_to_chat_reason?: string;
1940
+ recommendation_ids_for_exit?: unknown[];
1941
+ exit_destination_type?: string;
2009
1942
  sale_id?: string;
2010
1943
  user_type?: string;
2011
1944
  currency_code?: string;
@@ -2017,6 +1950,7 @@ declare class Client {
2017
1950
  products_sold_media?: unknown[];
2018
1951
  sale_custom_properties_aidem?: Record<string, never>;
2019
1952
  products_sold_aidem?: unknown[];
1953
+ entry_point_click_type?: string | null;
2020
1954
  is_qualified?: boolean;
2021
1955
  qualification_stage?: string;
2022
1956
  is_main_uplift_experiment?: boolean;
@@ -2024,12 +1958,12 @@ declare class Client {
2024
1958
  experiment_variation_id?: string;
2025
1959
  experiment_variation_name?: string;
2026
1960
  slots?: unknown[];
2027
- entry_point_type?: string;
2028
1961
  entry_point_closed_reason?: string;
2029
- exit_destination_type?: string;
1962
+ recommendation_set?: unknown[];
1963
+ discovery_progress_score?: number;
2030
1964
  };
2031
1965
  conversationId?: string;
2032
- eventName: "entry_point-shown" | "feedback_submit-clicked" | "page-shown" | "tool_ui-closed" | "user_message-submitted" | "user_message-submitted message" | "user_message-submitted single_select" | "user_message-submitted multi_select" | "assistant_message-submitted" | "assistant_message-submitted recommendation" | "assistant_message-submitted message" | "assistant_message-submitted single_select" | "assistant_message-submitted multi_select" | "assistant_message-submitted exit_to_chat" | "assistant_message-submitted exit_to_purchase" | "feedback-shown" | "feedback_skip-clicked" | "sale-completed" | "sale-completed spectrum" | "sale-completed aidem" | "sale-completed spectrum-us-media-consumer-en" | "entry_point-clicked" | "tool_close-clicked" | "exit_to_chat-completed" | "exit_to_purchase-completed" | "conversation-started" | "user_qualification-identified" | "experiment_variation-assigned" | "slot_filling-completed" | "entry_point-closed" | "entry_point-suppressed" | "exit_to_human-completed" | "user-created";
1966
+ eventName: "entry_point-shown" | "feedback_submit-clicked" | "page-shown" | "tool_ui-closed" | "user_message-submitted" | "user_message-submitted message" | "user_message-submitted single_select" | "user_message-submitted multi_select" | "assistant_message-submitted" | "assistant_message-submitted recommendation" | "assistant_message-submitted message" | "assistant_message-submitted single_select" | "assistant_message-submitted multi_select" | "assistant_message-submitted exit_to_chat" | "assistant_message-submitted exit_to_purchase" | "assistant_message-submitted exit_to_human" | "feedback-shown" | "feedback_skip-clicked" | "sale-completed" | "sale-completed spectrum" | "sale-completed aidem" | "sale-completed spectrum-us-media-consumer-en" | "entry_point-clicked" | "tool_close-clicked" | "exit_to_chat-completed" | "exit_to_purchase-completed" | "conversation-started" | "user_qualification-identified" | "experiment_variation-assigned" | "slot_filling-completed" | "entry_point-closed" | "entry_point-suppressed" | "user-created" | "exit_to_human-completed" | "recommendation_set-returned" | "ww_rag_context-used";
2033
1967
  pageviewId: string;
2034
1968
  screenHeight?: number;
2035
1969
  screenSize?: "mobile" | "large";
package/dist/index.js CHANGED
@@ -1,2 +1,2 @@
1
- "use strict";var P=Object.create;var a=Object.defineProperty;var A=Object.getOwnPropertyDescriptor;var U=Object.getOwnPropertyNames;var R=Object.getPrototypeOf,W=Object.prototype.hasOwnProperty;var V=(e,t)=>{for(var n in t)a(e,n,{get:t[n],enumerable:!0})},O=(e,t,n,s)=>{if(t&&typeof t=="object"||typeof t=="function")for(let o of U(t))!W.call(e,o)&&o!==n&&a(e,o,{get:()=>t[o],enumerable:!(s=A(t,o))||s.enumerable});return e};var G=(e,t,n)=>(n=e!=null?P(R(e)):{},O(t||!e||!e.__esModule?a(n,"default",{value:e,enumerable:!0}):n,e)),j=e=>O(a({},"__esModule",{value:!0}),e);var $={};V($,{CONVERSATION_ID:()=>d,Client:()=>_,JWT_TOKEN:()=>g,SESSION_ID:()=>v,TTL:()=>b,USER_ID:()=>S,authMiddleware:()=>f,deleteConversationId:()=>u,errorMiddleware:()=>I,getConversationId:()=>m,getSessionId:()=>h,getToken:()=>M,getUserId:()=>E,headerMiddleware:()=>l,isTokenExpired:()=>D,setConversationId:()=>c,setSessionId:()=>y,setToken:()=>T,setUserId:()=>p});module.exports=j($);var C=G(require("openapi-fetch"));var d="__15gifts_conversation_id",u=()=>sessionStorage.removeItem(d),m=()=>sessionStorage.getItem(d),c=e=>sessionStorage.setItem(d,e);var v="__15gifts_session_id",h=()=>sessionStorage.getItem(v),y=e=>sessionStorage.setItem(v,e);var B=e=>{let t=localStorage.getItem(e);if(!t)return null;let n=JSON.parse(t);return Date.now()>n.expires?(localStorage.removeItem(e),null):n.value},w=B;var J=(e,t,n)=>{let s={expires:Date.now()+n,value:t};localStorage.setItem(e,JSON.stringify(s))},x=J;var X=1e3*60*60*24,S="__15gifts_user_id",b=X*30,E=()=>{let e=w(S);return e&&p(e),e},p=e=>x(S,e,b);var g="__15gifts_identity_token",D=e=>{try{let[,t]=e.split(".");if(!t)throw new Error("Invalid token payload");let n=JSON.parse(atob(t));return n.exp&&Date.now()/1e3>n.exp}catch(t){return console.error("Invalid token format",t),!0}},M=()=>{let e=localStorage.getItem(g);return!e||D(e)?(localStorage.removeItem(g),null):e},T=e=>localStorage.setItem(g,e);var z=e=>({onRequest:async({request:t})=>(t.headers.set("Authorization",`Bearer ${e}`),t)}),f=z;var H={onResponse:async({response:e})=>{if(!e.ok){let t=await e.json();throw new Error(t.message)}return e}},I=H;var K=(e,t)=>({onRequest:async({request:n})=>(e.pageviewId&&n.headers.set("X-PAGEVIEW-ID",e.pageviewId),t&&n.headers.set("X-PAGE-URL",t),n)}),l=K;var N="0.11.6";var _=class{endpoint;identity;constructor(t){let{conversationUrl:n,customerId:s,fetch:o,frontendUrl:r,headers:i}=t,k={...i,"X-SDK-VERSION":N};this.endpoint={conversation:(0,C.default)({baseUrl:n,fetch:o,headers:k,credentials:"include"}),frontend:(0,C.default)({baseUrl:r,fetch:o,headers:k})},this.identity={customerId:s,conversationId:m()??void 0,sessionId:h()??void 0,userId:E()??void 0},this.endpoint.conversation.use(I),this.endpoint.conversation.use(l(this.identity,window.location.href))}async createIdentity(){let{customerId:t,pageviewId:n,sessionId:s,userId:o}=this.identity,{data:r}=await this.endpoint.frontend.POST("/api/tracking/identity/v2",{body:{customerId:t,sessionId:s,userId:o,url:window.location.href,userAgent:window.navigator.userAgent}});r&&(n||(this.identity.pageviewId=r.pageviewId),s||(this.identity.sessionId=r.sessionId,y(r.sessionId)),o||(this.identity.userId=r.userId,p(r.userId)),T(r.token),Object.values(this.endpoint).forEach(i=>{i.use(f(r.token))}))}endConversation(){u(),this.identity.conversationId=void 0}async startConversation(t){this.endConversation();let n={...t},{data:s}=await this.endpoint.conversation.POST("/api/conversation/v3",{body:{type:"START_CONVERSATION",conversationContext:n}});if(!s)return;let[o,r]=s,i=o.conversationId;if(!i)throw new Error("Conversation ID not received");return c(i),this.identity.conversationId=i,r}async sendMessage({userMessage:t}){let{data:n}=await this.endpoint.conversation.POST("/api/conversation/v3",{body:{conversationId:this.identity.conversationId,userMessage:t,type:"MESSAGE"}});if(!n)return;let s=n.filter(i=>i.type==="DEBUG");s.length&&console.info("Debug messages:",s);let o=n.find(i=>i.type==="CONVERSATION_ID")?.conversationId;return o&&(c(o),this.identity.conversationId=o),n.filter(i=>i.type!=="CONVERSATION_ID"&&i.type!=="DEBUG")}async trackEvent(t,n){let s={additionalProperties:n,conversationId:this.identity.conversationId,eventName:t,pageviewId:this.identity.pageviewId??"unknown",screenWidth:window.screen.width,screenHeight:window.screen.height,screenSize:window.screen.width<=480?"mobile":"large",url:window.location.href,userAgent:window.navigator.userAgent};return this.endpoint.frontend.POST("/api/tracking/user/v2",{body:s})}getIdentity(){return this.identity}getIdentityToken(){return M()}};0&&(module.exports={CONVERSATION_ID,Client,JWT_TOKEN,SESSION_ID,TTL,USER_ID,authMiddleware,deleteConversationId,errorMiddleware,getConversationId,getSessionId,getToken,getUserId,headerMiddleware,isTokenExpired,setConversationId,setSessionId,setToken,setUserId});
1
+ "use strict";var P=Object.create;var a=Object.defineProperty;var A=Object.getOwnPropertyDescriptor;var U=Object.getOwnPropertyNames;var R=Object.getPrototypeOf,W=Object.prototype.hasOwnProperty;var V=(e,t)=>{for(var n in t)a(e,n,{get:t[n],enumerable:!0})},O=(e,t,n,s)=>{if(t&&typeof t=="object"||typeof t=="function")for(let o of U(t))!W.call(e,o)&&o!==n&&a(e,o,{get:()=>t[o],enumerable:!(s=A(t,o))||s.enumerable});return e};var G=(e,t,n)=>(n=e!=null?P(R(e)):{},O(t||!e||!e.__esModule?a(n,"default",{value:e,enumerable:!0}):n,e)),j=e=>O(a({},"__esModule",{value:!0}),e);var $={};V($,{CONVERSATION_ID:()=>d,Client:()=>_,JWT_TOKEN:()=>g,SESSION_ID:()=>v,TTL:()=>b,USER_ID:()=>S,authMiddleware:()=>f,deleteConversationId:()=>u,errorMiddleware:()=>I,getConversationId:()=>m,getSessionId:()=>h,getToken:()=>M,getUserId:()=>E,headerMiddleware:()=>l,isTokenExpired:()=>D,setConversationId:()=>c,setSessionId:()=>y,setToken:()=>T,setUserId:()=>p});module.exports=j($);var C=G(require("openapi-fetch"));var d="__15gifts_conversation_id",u=()=>sessionStorage.removeItem(d),m=()=>sessionStorage.getItem(d),c=e=>sessionStorage.setItem(d,e);var v="__15gifts_session_id",h=()=>sessionStorage.getItem(v),y=e=>sessionStorage.setItem(v,e);var B=e=>{let t=localStorage.getItem(e);if(!t)return null;let n=JSON.parse(t);return Date.now()>n.expires?(localStorage.removeItem(e),null):n.value},w=B;var J=(e,t,n)=>{let s={expires:Date.now()+n,value:t};localStorage.setItem(e,JSON.stringify(s))},x=J;var X=1e3*60*60*24,S="__15gifts_user_id",b=X*30,E=()=>{let e=w(S);return e&&p(e),e},p=e=>x(S,e,b);var g="__15gifts_identity_token",D=e=>{try{let[,t]=e.split(".");if(!t)throw new Error("Invalid token payload");let n=JSON.parse(atob(t));return n.exp&&Date.now()/1e3>n.exp}catch(t){return console.error("Invalid token format",t),!0}},M=()=>{let e=localStorage.getItem(g);return!e||D(e)?(localStorage.removeItem(g),null):e},T=e=>localStorage.setItem(g,e);var z=e=>({onRequest:async({request:t})=>(t.headers.set("Authorization",`Bearer ${e}`),t)}),f=z;var H={onResponse:async({response:e})=>{if(!e.ok){let t=await e.json();throw new Error(t.message)}return e}},I=H;var K=(e,t)=>({onRequest:async({request:n})=>(e.pageviewId&&n.headers.set("X-PAGEVIEW-ID",e.pageviewId),t&&n.headers.set("X-PAGE-URL",t),n)}),l=K;var N="0.11.8";var _=class{endpoint;identity;constructor(t){let{conversationUrl:n,customerId:s,fetch:o,frontendUrl:r,headers:i}=t,k={...i,"X-SDK-VERSION":N};this.endpoint={conversation:(0,C.default)({baseUrl:n,fetch:o,headers:k,credentials:"include"}),frontend:(0,C.default)({baseUrl:r,fetch:o,headers:k})},this.identity={customerId:s,conversationId:m()??void 0,sessionId:h()??void 0,userId:E()??void 0},this.endpoint.conversation.use(I),this.endpoint.conversation.use(l(this.identity,window.location.href))}async createIdentity(){let{customerId:t,pageviewId:n,sessionId:s,userId:o}=this.identity,{data:r}=await this.endpoint.frontend.POST("/api/tracking/identity/v2",{body:{customerId:t,sessionId:s,userId:o,url:window.location.href,userAgent:window.navigator.userAgent}});r&&(n||(this.identity.pageviewId=r.pageviewId),s||(this.identity.sessionId=r.sessionId,y(r.sessionId)),o||(this.identity.userId=r.userId,p(r.userId)),T(r.token),Object.values(this.endpoint).forEach(i=>{i.use(f(r.token))}))}endConversation(){u(),this.identity.conversationId=void 0}async startConversation(t){this.endConversation();let n={...t},{data:s}=await this.endpoint.conversation.POST("/api/conversation/v3",{body:{type:"START_CONVERSATION",conversationContext:n}});if(!s)return;let[o,r]=s,i=o.conversationId;if(!i)throw new Error("Conversation ID not received");return c(i),this.identity.conversationId=i,r}async sendMessage({userMessage:t}){let{data:n}=await this.endpoint.conversation.POST("/api/conversation/v3",{body:{conversationId:this.identity.conversationId,userMessage:t,type:"MESSAGE"}});if(!n)return;let s=n.filter(i=>i.type==="DEBUG");s.length&&console.info("Debug messages:",s);let o=n.find(i=>i.type==="CONVERSATION_ID")?.conversationId;return o&&(c(o),this.identity.conversationId=o),n.filter(i=>i.type!=="CONVERSATION_ID"&&i.type!=="DEBUG")}async trackEvent(t,n){let s={additionalProperties:n,conversationId:this.identity.conversationId,eventName:t,pageviewId:this.identity.pageviewId??"unknown",screenWidth:window.screen.width,screenHeight:window.screen.height,screenSize:window.screen.width<=480?"mobile":"large",url:window.location.href,userAgent:window.navigator.userAgent};return this.endpoint.frontend.POST("/api/tracking/user/v2",{body:s})}getIdentity(){return this.identity}getIdentityToken(){return M()}};0&&(module.exports={CONVERSATION_ID,Client,JWT_TOKEN,SESSION_ID,TTL,USER_ID,authMiddleware,deleteConversationId,errorMiddleware,getConversationId,getSessionId,getToken,getUserId,headerMiddleware,isTokenExpired,setConversationId,setSessionId,setToken,setUserId});
2
2
  //# sourceMappingURL=index.js.map
package/dist/index.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"sources":["../src/index.ts","../src/client.ts","../src/identity/conversationId.ts","../src/identity/sessionId.ts","../src/utils/getItemWithExpiry.ts","../src/utils/setItemWithExpiry.ts","../src/identity/userId.ts","../src/identity/token.ts","../src/middlewares/auth.ts","../src/middlewares/error.ts","../src/middlewares/headers.ts","../package.json"],"sourcesContent":["export * from './client'\nexport * from './identity'\nexport * from './middlewares'\nexport * from './types'\n","import createClient, { type ClientOptions } from 'openapi-fetch'\n\nimport {\n deleteConversationId,\n getConversationId,\n getSessionId,\n getUserId,\n getToken,\n setConversationId,\n setSessionId,\n setUserId,\n setToken,\n} from './identity'\nimport { authMiddleware, errorMiddleware, headerMiddleware } from './middlewares'\nimport type { components, paths as conversationPaths } from './schemas/conversation'\nimport type { paths as frontendPaths } from './schemas/frontend'\nimport type {\n Config,\n ConversationIdMessage,\n DebugMessage,\n Endpoint,\n Identity,\n Message,\n TextMessage,\n TrackingEvent,\n} from './types'\nimport { version } from '../package.json'\n\n/**\n * The `Client` class provides methods to manage 15gifts API.\n */\nexport class Client {\n /**\n * This can be used to interact with the APIs directly. It is recommended to use the [helper methods](/sdk/sdk-reference/classes/client/#methods) provided by the `Client` class instead.\n *\n * @example\n * ```ts\n * const client = new Client({ customerId: 'YOUR_CUSTOMER_ID' })\n * const { data } = await client.endpoint.conversation.POST('/api/conversation/v3')\n * ```\n */\n endpoint: Endpoint\n\n /**\n * The identity information.\n */\n identity: Identity\n\n /**\n * Creates a new instance of the `Client` class.\n *\n * @param config - Configuration options for initializing the client.\n *\n * @example\n * ```ts\n * const client = new Client({ customerId: 'YOUR_CUSTOMER_ID' })\n * ```\n */\n constructor(config: Config) {\n const { conversationUrl, customerId, fetch, frontendUrl, headers: defaultHeaders } = config\n\n const headers: ClientOptions['headers'] = {\n ...defaultHeaders,\n 'X-SDK-VERSION': version,\n }\n\n this.endpoint = {\n conversation: createClient<conversationPaths>({\n baseUrl: conversationUrl,\n fetch,\n headers,\n credentials: 'include',\n }),\n frontend: createClient<frontendPaths>({ baseUrl: frontendUrl, fetch, headers }),\n }\n\n this.identity = {\n customerId,\n conversationId: getConversationId() ?? undefined,\n sessionId: getSessionId() ?? undefined,\n userId: getUserId() ?? undefined,\n }\n\n this.endpoint.conversation.use(errorMiddleware)\n this.endpoint.conversation.use(headerMiddleware(this.identity, window.location.href))\n }\n\n /**\n * Creates a new identity for the user by generating a session ID and user ID if they don't exist, and sets the access token for future API calls.\n * Ends the current conversation if a conversation ID is present before sending a request to update identity.\n *\n * @returns A promise that resolves once the identity is created and the access token is set.\n *\n * @example\n * ```ts\n * await client.createIdentity()\n * console.log('Identity created:', client.identity)\n * ```\n */\n async createIdentity(): Promise<void> {\n const { customerId, pageviewId, sessionId, userId } = this.identity\n\n const { data } = await this.endpoint.frontend.POST('/api/tracking/identity/v2', {\n body: {\n customerId,\n sessionId,\n userId,\n url: window.location.href,\n userAgent: window.navigator.userAgent,\n },\n })\n\n if (data) {\n if (!pageviewId) {\n this.identity.pageviewId = data.pageviewId\n }\n if (!sessionId) {\n this.identity.sessionId = data.sessionId\n setSessionId(data.sessionId)\n }\n if (!userId) {\n this.identity.userId = data.userId\n setUserId(data.userId)\n }\n\n setToken(data.token)\n\n Object.values(this.endpoint).forEach((endpoint) => {\n endpoint.use(authMiddleware(data.token))\n })\n }\n }\n\n /**\n * Ends the current conversation by deleting the conversation ID.\n *\n * @example\n * ```ts\n * client.endConversation()\n * console.log('Conversation ended')\n * ```\n */\n endConversation(): void {\n deleteConversationId()\n this.identity.conversationId = undefined\n }\n\n /**\n * Clears the existing conversation ID, then generates a new one and returns the opening message.\n *\n * @param context - Optional context to customize the conversation. It can include:\n * @param context.eligibleProducts An array of eligible product IDs.\n * @param context.eligibleBundles An array of eligible bundle IDs.\n * @param context.productOverrides Overrides for product details.\n * @param context.bundleOverrides Overrides for bundle details.\n *\n * @returns A promise that resolves to the opening message.\n *\n * @example\n * ##### Basic usage\n * ```ts\n * const openingMessage = await client.startConversation()\n * console.log('Opening message:', openingMessage)\n * ```\n *\n * ##### With context\n * ```ts\n * const openingMessage = await client.startConversation({ eligibleProducts: ['product-1', 'product-2'], productOverrides: { 'product-1': { price: 40 } })\n * console.log('Opening message:', openingMessage)\n * ```\n */\n async startConversation(context?: components['schemas']['ConversationContext']): Promise<TextMessage | undefined> {\n this.endConversation()\n\n const conversationContext = {\n ...context,\n }\n\n const { data } = await this.endpoint.conversation.POST(`/api/conversation/v3`, {\n body: {\n type: 'START_CONVERSATION',\n conversationContext,\n },\n })\n\n if (!data) return undefined\n\n const [conversationIdMessage, openingMessage] = data as [ConversationIdMessage, TextMessage]\n\n const conversationId = conversationIdMessage.conversationId\n if (!conversationId) {\n throw new Error('Conversation ID not received')\n }\n\n setConversationId(conversationId)\n this.identity.conversationId = conversationId\n\n return openingMessage\n }\n\n /**\n * Sends a message in the conversation.\n *\n * @param options - An object containing the user message.\n * @returns A promise that resolves to an array of messages\n *\n * @example\n * ```ts\n * const newMessages = await client.sendMessage({\n * userMessage: 'How can I get support?',\n * })\n *\n * if (newMessages) {\n * console.log('Received messages:', newMessages)\n * } else {\n * console.log('No message received')\n * }\n * ```\n */\n async sendMessage({\n userMessage,\n }: {\n userMessage: string\n }): Promise<Exclude<Message, ConversationIdMessage | DebugMessage>[] | undefined> {\n const { data } = await this.endpoint.conversation.POST('/api/conversation/v3', {\n body: {\n conversationId: this.identity.conversationId,\n userMessage,\n type: 'MESSAGE',\n },\n })\n\n if (!data) return undefined\n\n // Log debug messages\n // These will only be in the response when used in internal testing\n const debugMessages = data.filter((message) => message.type === 'DEBUG')\n if (debugMessages.length) {\n console.info('Debug messages:', debugMessages)\n }\n\n // When a request does not contain a conversation ID, the API will return a new conversation ID as the first message\n const conversationId = data.find((message) => message.type === 'CONVERSATION_ID')?.conversationId\n if (conversationId) {\n setConversationId(conversationId)\n this.identity.conversationId = conversationId\n }\n\n const messages = data.filter((message) => message.type !== 'CONVERSATION_ID' && message.type !== 'DEBUG')\n return messages\n }\n\n /**\n * Sends an event to the tracking API, with the required properties already set.\n *\n * @param eventName - The name of the event to track.\n * @param properties - Additional properties to include in the event.\n * @returns A promise that resolves once the event is tracked.\n *\n * @example\n * ```ts\n * await client.trackEvent('entry_point-shown')\n * ```\n */\n async trackEvent(eventName: TrackingEvent['eventName'], properties?: TrackingEvent['additionalProperties']) {\n const body: TrackingEvent = {\n additionalProperties: properties,\n conversationId: this.identity.conversationId,\n eventName,\n pageviewId: this.identity.pageviewId ?? 'unknown',\n screenWidth: window.screen.width,\n screenHeight: window.screen.height,\n screenSize: window.screen.width <= 480 ? 'mobile' : 'large',\n url: window.location.href,\n userAgent: window.navigator.userAgent,\n }\n\n return this.endpoint.frontend.POST('/api/tracking/user/v2', {\n body,\n })\n }\n\n /**\n * Gets an existing identity of the user.\n *\n * @returns An Identity object containing `customerId`, `conversationId`, `sessionId`, `userId`.\n *\n * @example\n * ```ts\n * identity = client.getIdentity()\n * console.log('Identity retrieved:', identity)\n * ```\n */\n getIdentity(): Identity {\n return this.identity\n }\n\n /**\n * Gets the JWT from the localStorage.\n *\n * @returns {string | null} the JWT.\n *\n * @example\n * ```ts\n * token = client.getIdentityToken()\n * console.log('Identity token retrieved:', token)\n * ```\n */\n getIdentityToken(): string | null {\n return getToken()\n }\n}\n","/**\n * The key used to store the conversation ID in `sessionStorage`.\n *\n * @ignore\n */\nexport const CONVERSATION_ID = '__15gifts_conversation_id'\n\n/**\n * Deletes the conversation ID from `sessionStorage`.\n *\n * @example\n * ```ts\n * import { deleteConversationId } from '@15gifts/sdk'\n *\n * deleteConversationId()\n * // The conversation ID will be removed.\n * ```\n */\nexport const deleteConversationId = () => sessionStorage.removeItem(CONVERSATION_ID)\n\n/**\n * Retrieves the conversation ID from `sessionStorage`.\n *\n * @example\n * ```ts\n * import { getConversationId } from '@15gifts/sdk'\n *\n * const conversationId = getConversationId()\n *\n * if (conversationId) {\n * console.log(`Conversation ID: ${conversationId}`)\n * } else {\n * console.log('No conversation ID found.')\n * }\n * ```\n */\nexport const getConversationId = () => sessionStorage.getItem(CONVERSATION_ID)\n\n/**\n * Stores the given conversation ID in `sessionStorage`.\n *\n * @example\n * ```ts\n * import { setConversationId } from '@15gifts/sdk'\n *\n * setConversationId('ca0ab4ce-f697-41cc-8d0c-081762aace9b')\n * // The conversation ID 'ca0ab4ce-f697-41cc-8d0c-081762aace9b' will be stored.\n * ```\n */\nexport const setConversationId = (conversationId: string) => sessionStorage.setItem(CONVERSATION_ID, conversationId)\n","/**\n * The key used to store the session ID in `sessionStorage`.\n *\n * @ignore\n */\nexport const SESSION_ID = '__15gifts_session_id'\n\n/**\n * Retrieves the session ID from `sessionStorage`.\n *\n * @example\n * ```ts\n * import { getSessionId } from '@15gifts/sdk'\n *\n * const sessionId = getSessionId()\n *\n * if (sessionId) {\n * console.log(`Session ID: ${sessionId}`)\n * } else {\n * console.log('No session ID found.')\n * }\n * ```\n */\nexport const getSessionId = () => sessionStorage.getItem(SESSION_ID)\n\n/**\n * Stores the given session ID in `sessionStorage`.\n *\n * @example\n * ```ts\n * import { setSessionId } from '@15gifts/sdk'\n *\n * setSessionId('20b2bff6-64a0-4101-bed9-ff545326584a')\n * // The session ID '20b2bff6-64a0-4101-bed9-ff545326584a' will be stored.\n * ```\n */\nexport const setSessionId = (sessionId: string) => sessionStorage.setItem(SESSION_ID, sessionId)\n","const getItemWithExpiry = (key: string) => {\n const itemString = localStorage.getItem(key)\n\n if (!itemString) return null\n\n const item = JSON.parse(itemString) as { expires: number; value: string }\n\n if (Date.now() > item.expires) {\n localStorage.removeItem(key)\n\n return null\n }\n\n return item.value\n}\n\nexport default getItemWithExpiry\n","/**\n * Set an item in localStorage with an expiration time\n * @param key The key under which the value is stored in localStorage\n * @param value The value to be stored\n * @param ttl The time-to-live (TTL) in milliseconds\n */\nconst setItemWithExpiry = (key: string, value: string, ttl: number) => {\n const item = {\n expires: Date.now() + ttl,\n value,\n }\n\n localStorage.setItem(key, JSON.stringify(item))\n}\n\nexport default setItemWithExpiry\n","import { getItemWithExpiry, setItemWithExpiry } from '../utils'\nconst day = 1000 * 60 * 60 * 24\n\n/**\n * The key used to store the user ID in `localStorage`.\n *\n * @ignore\n */\nexport const USER_ID = '__15gifts_user_id'\n\n/**\n * Time-to-live (TTL) for the user ID in milliseconds.\n * Set to 30 days.\n *\n * @ignore\n */\nexport const TTL = day * 30\n\n/**\n * Retrieves the user ID from `localStorage` and updates its expiry time.\n *\n * @example\n * ```ts\n * import { getUserId } from '@15gifts/sdk'\n *\n * const userId = getUserId()\n *\n * if (userId) {\n * console.log(`User ID: ${userId}`)\n * } else {\n * console.log('No user ID found.')\n * }\n * ```\n */\nexport const getUserId = () => {\n const userId = getItemWithExpiry(USER_ID)\n\n // Update the userId with a new expiry time\n // So that it will be valid for another 30 days, rather than 30 days from when it was first set\n if (userId) {\n setUserId(userId)\n }\n\n return userId\n}\n\n/**\n * Stores the given user ID in `localStorage`.\n *\n * @example\n * ```ts\n * import { setUserId } from '@15gifts/sdk'\n *\n * setUserId('5b77656c-ea4c-492f-82bf-7129297c5873')\n * // The user ID '5b77656c-ea4c-492f-82bf-7129297c5873' will be stored with a 30-day expiry.\n * ```\n */\nexport const setUserId = (userId: string) => setItemWithExpiry(USER_ID, userId, TTL)\n","/**\n * The key used to store the JWT in `localStorage`.\n *\n * @ignore\n */\nexport const JWT_TOKEN = '__15gifts_identity_token'\n\n/**\n * Checks if the JWT is expired.\n *\n * @param {string} token - the JWT.\n * @returns {boolean} `true` if expired, `false` otherwise.\n */\nexport const isTokenExpired = (token: string): boolean => {\n try {\n const [, payloadBase64] = token.split('.')\n if (!payloadBase64) {\n throw new Error('Invalid token payload')\n }\n const payload = JSON.parse(atob(payloadBase64))\n\n return payload.exp && Date.now() / 1000 > payload.exp\n } catch (error) {\n console.error('Invalid token format', error)\n return true\n }\n}\n\n/**\n * Retrieves the JWT from `localStorage` and checks if it is expired.\n *\n * @returns {string | null} The JWT if valid, otherwise `null`.\n */\nexport const getToken = (): string | null => {\n const token = localStorage.getItem(JWT_TOKEN)\n\n if (!token || isTokenExpired(token)) {\n localStorage.removeItem(JWT_TOKEN)\n return null\n }\n\n return token\n}\n\n/**\n * Stores the given JWT in `localStorage`.\n *\n * @example\n * ```ts\n * import { setToken } from '@15gifts/sdk'\n *\n * setToken('ey...')\n * ```\n */\nexport const setToken = (token: string) => localStorage.setItem(JWT_TOKEN, token)\n","import type { Middleware } from 'openapi-fetch'\n\n/**\n * Middleware for adding an `Authorization` header to requests.\n *\n * @param accessToken - The token to be included in the `Authorization` header.\n * @returns A middleware object that attaches the access token to the request headers.\n *\n * @example\n * ```ts\n * import { authMiddleware } from '@15gifts/sdk';\n *\n * this.endpoint.conversation.use(authMiddleware(accessToken))\n * ```\n */\nconst authMiddleware = (accessToken: string): Middleware => ({\n onRequest: async ({ request }) => {\n request.headers.set('Authorization', `Bearer ${accessToken}`)\n\n return request\n },\n})\n\nexport default authMiddleware\n","import type { Middleware } from 'openapi-fetch'\n\n/**\n * Middleware for handling errors.\n *\n * @returns A middleware object that throws an error if the response is not ok.\n *\n * @example\n * ```ts\n * import { errorMiddleware } from '@15gifts/sdk';\n *\n * this.endpoint.conversation.use(errorMiddleware())\n * ```\n */\nconst errorMiddleware: Middleware = {\n // onError does not handle error responses with 4xx or 5xx HTTP status codes, since these are considered \"successful\" responses but with a bad status code.\n // In these cases we need to check the response's status property or ok() method via the onResponse callback.\n onResponse: async ({ response }) => {\n if (!response.ok) {\n const data = await response.json()\n\n throw new Error(data.message)\n }\n\n return response\n },\n}\n\nexport default errorMiddleware\n","import type { Middleware } from 'openapi-fetch'\n\nimport { Identity } from '../types'\n\n/**\n * Middleware for adding request headers that other services use for tracking.\n *\n * @returns A middleware object that throws an error if the response is not ok.\n *\n * @example\n * ```ts\n * import { pageViewId } from '@15gifts/sdk';\n *\n * this.endpoint.conversation.use(headerMiddleware('123', 'https://example.com'))\n * ```\n */\nconst headerMiddleware = (identity: Identity, url: string): Middleware => ({\n onRequest: async ({ request }) => {\n if (identity.pageviewId) {\n request.headers.set('X-PAGEVIEW-ID', identity.pageviewId)\n }\n if (url) {\n request.headers.set('X-PAGE-URL', url)\n }\n\n return request\n },\n})\n\nexport default headerMiddleware\n","{\n \"name\": \"@15gifts/sdk\",\n \"version\": \"0.11.6\",\n \"files\": [\n \"dist\"\n ],\n \"main\": \"./dist/index.js\",\n \"module\": \"./dist/index.mjs\",\n \"types\": \"./dist/index.d.ts\",\n \"scripts\": {\n \"build\": \"npm run generate && tsup\",\n \"coverage\": \"vitest run --coverage\",\n \"dev\": \"tsup --watch\",\n \"format\": \"prettier . --write\",\n \"generate\": \"npx openapi-typescript\",\n \"lint\": \"eslint .\",\n \"test\": \"vitest run\",\n \"test:watch\": \"vitest\",\n \"typecheck\": \"tsc\"\n },\n \"dependencies\": {\n \"openapi-fetch\": \"^0.13.4\"\n },\n \"devDependencies\": {\n \"openapi-typescript\": \"^7.6.0\",\n \"tsup\": \"^8.3.6\"\n },\n \"sideEffects\": false,\n \"prettier\": \"prettier-config-custom\"\n}\n"],"mappings":"0jBAAA,IAAAA,EAAA,GAAAC,EAAAD,EAAA,qBAAAE,EAAA,WAAAC,EAAA,cAAAC,EAAA,eAAAC,EAAA,QAAAC,EAAA,YAAAC,EAAA,mBAAAC,EAAA,yBAAAC,EAAA,oBAAAC,EAAA,sBAAAC,EAAA,iBAAAC,EAAA,aAAAC,EAAA,cAAAC,EAAA,qBAAAC,EAAA,mBAAAC,EAAA,sBAAAC,EAAA,iBAAAC,EAAA,aAAAC,EAAA,cAAAC,IAAA,eAAAC,EAAArB,GCAA,IAAAsB,EAAiD,4BCK1C,IAAMC,EAAkB,4BAalBC,EAAuB,IAAM,eAAe,WAAWD,CAAe,EAkBtEE,EAAoB,IAAM,eAAe,QAAQF,CAAe,EAahEG,EAAqBC,GAA2B,eAAe,QAAQJ,EAAiBI,CAAc,EC5C5G,IAAMC,EAAa,uBAkBbC,EAAe,IAAM,eAAe,QAAQD,CAAU,EAatDE,EAAgBC,GAAsB,eAAe,QAAQH,EAAYG,CAAS,ECpC/F,IAAMC,EAAqBC,GAAgB,CACzC,IAAMC,EAAa,aAAa,QAAQD,CAAG,EAE3C,GAAI,CAACC,EAAY,OAAO,KAExB,IAAMC,EAAO,KAAK,MAAMD,CAAU,EAElC,OAAI,KAAK,IAAI,EAAIC,EAAK,SACpB,aAAa,WAAWF,CAAG,EAEpB,MAGFE,EAAK,KACd,EAEOC,EAAQJ,ECVf,IAAMK,EAAoB,CAACC,EAAaC,EAAeC,IAAgB,CACrE,IAAMC,EAAO,CACX,QAAS,KAAK,IAAI,EAAID,EACtB,MAAAD,CACF,EAEA,aAAa,QAAQD,EAAK,KAAK,UAAUG,CAAI,CAAC,CAChD,EAEOC,EAAQL,ECdf,IAAMM,EAAM,IAAO,GAAK,GAAK,GAOhBC,EAAU,oBAQVC,EAAMF,EAAM,GAkBZG,EAAY,IAAM,CAC7B,IAAMC,EAASC,EAAkBJ,CAAO,EAIxC,OAAIG,GACFE,EAAUF,CAAM,EAGXA,CACT,EAaaE,EAAaF,GAAmBG,EAAkBN,EAASG,EAAQF,CAAG,ECpD5E,IAAMM,EAAY,2BAQZC,EAAkBC,GAA2B,CACxD,GAAI,CACF,GAAM,CAAC,CAAEC,CAAa,EAAID,EAAM,MAAM,GAAG,EACzC,GAAI,CAACC,EACH,MAAM,IAAI,MAAM,uBAAuB,EAEzC,IAAMC,EAAU,KAAK,MAAM,KAAKD,CAAa,CAAC,EAE9C,OAAOC,EAAQ,KAAO,KAAK,IAAI,EAAI,IAAOA,EAAQ,GACpD,OAASC,EAAO,CACd,eAAQ,MAAM,uBAAwBA,CAAK,EACpC,EACT,CACF,EAOaC,EAAW,IAAqB,CAC3C,IAAMJ,EAAQ,aAAa,QAAQF,CAAS,EAE5C,MAAI,CAACE,GAASD,EAAeC,CAAK,GAChC,aAAa,WAAWF,CAAS,EAC1B,MAGFE,CACT,EAYaK,EAAYL,GAAkB,aAAa,QAAQF,EAAWE,CAAK,ECvChF,IAAMM,EAAkBC,IAAqC,CAC3D,UAAW,MAAO,CAAE,QAAAC,CAAQ,KAC1BA,EAAQ,QAAQ,IAAI,gBAAiB,UAAUD,CAAW,EAAE,EAErDC,EAEX,GAEOC,EAAQH,ECTf,IAAMI,EAA8B,CAGlC,WAAY,MAAO,CAAE,SAAAC,CAAS,IAAM,CAClC,GAAI,CAACA,EAAS,GAAI,CAChB,IAAMC,EAAO,MAAMD,EAAS,KAAK,EAEjC,MAAM,IAAI,MAAMC,EAAK,OAAO,CAC9B,CAEA,OAAOD,CACT,CACF,EAEOE,EAAQH,ECZf,IAAMI,EAAmB,CAACC,EAAoBC,KAA6B,CACzE,UAAW,MAAO,CAAE,QAAAC,CAAQ,KACtBF,EAAS,YACXE,EAAQ,QAAQ,IAAI,gBAAiBF,EAAS,UAAU,EAEtDC,GACFC,EAAQ,QAAQ,IAAI,aAAcD,CAAG,EAGhCC,EAEX,GAEOC,EAAQJ,EC3Bb,IAAAK,EAAW,SV6BN,IAAMC,EAAN,KAAa,CAUlB,SAKA,SAYA,YAAYC,EAAgB,CAC1B,GAAM,CAAE,gBAAAC,EAAiB,WAAAC,EAAY,MAAAC,EAAO,YAAAC,EAAa,QAASC,CAAe,EAAIL,EAE/EM,EAAoC,CACxC,GAAGD,EACH,gBAAiBE,CACnB,EAEA,KAAK,SAAW,CACd,gBAAc,EAAAC,SAAgC,CAC5C,QAASP,EACT,MAAAE,EACA,QAAAG,EACA,YAAa,SACf,CAAC,EACD,YAAU,EAAAE,SAA4B,CAAE,QAASJ,EAAa,MAAAD,EAAO,QAAAG,CAAQ,CAAC,CAChF,EAEA,KAAK,SAAW,CACd,WAAAJ,EACA,eAAgBO,EAAkB,GAAK,OACvC,UAAWC,EAAa,GAAK,OAC7B,OAAQC,EAAU,GAAK,MACzB,EAEA,KAAK,SAAS,aAAa,IAAIC,CAAe,EAC9C,KAAK,SAAS,aAAa,IAAIC,EAAiB,KAAK,SAAU,OAAO,SAAS,IAAI,CAAC,CACtF,CAcA,MAAM,gBAAgC,CACpC,GAAM,CAAE,WAAAX,EAAY,WAAAY,EAAY,UAAAC,EAAW,OAAAC,CAAO,EAAI,KAAK,SAErD,CAAE,KAAAC,CAAK,EAAI,MAAM,KAAK,SAAS,SAAS,KAAK,4BAA6B,CAC9E,KAAM,CACJ,WAAAf,EACA,UAAAa,EACA,OAAAC,EACA,IAAK,OAAO,SAAS,KACrB,UAAW,OAAO,UAAU,SAC9B,CACF,CAAC,EAEGC,IACGH,IACH,KAAK,SAAS,WAAaG,EAAK,YAE7BF,IACH,KAAK,SAAS,UAAYE,EAAK,UAC/BC,EAAaD,EAAK,SAAS,GAExBD,IACH,KAAK,SAAS,OAASC,EAAK,OAC5BE,EAAUF,EAAK,MAAM,GAGvBG,EAASH,EAAK,KAAK,EAEnB,OAAO,OAAO,KAAK,QAAQ,EAAE,QAASI,GAAa,CACjDA,EAAS,IAAIC,EAAeL,EAAK,KAAK,CAAC,CACzC,CAAC,EAEL,CAWA,iBAAwB,CACtBM,EAAqB,EACrB,KAAK,SAAS,eAAiB,MACjC,CA0BA,MAAM,kBAAkBC,EAA0F,CAChH,KAAK,gBAAgB,EAErB,IAAMC,EAAsB,CAC1B,GAAGD,CACL,EAEM,CAAE,KAAAP,CAAK,EAAI,MAAM,KAAK,SAAS,aAAa,KAAK,uBAAwB,CAC7E,KAAM,CACJ,KAAM,qBACN,oBAAAQ,CACF,CACF,CAAC,EAED,GAAI,CAACR,EAAM,OAEX,GAAM,CAACS,EAAuBC,CAAc,EAAIV,EAE1CW,EAAiBF,EAAsB,eAC7C,GAAI,CAACE,EACH,MAAM,IAAI,MAAM,8BAA8B,EAGhD,OAAAC,EAAkBD,CAAc,EAChC,KAAK,SAAS,eAAiBA,EAExBD,CACT,CAqBA,MAAM,YAAY,CAChB,YAAAG,CACF,EAEkF,CAChF,GAAM,CAAE,KAAAb,CAAK,EAAI,MAAM,KAAK,SAAS,aAAa,KAAK,uBAAwB,CAC7E,KAAM,CACJ,eAAgB,KAAK,SAAS,eAC9B,YAAAa,EACA,KAAM,SACR,CACF,CAAC,EAED,GAAI,CAACb,EAAM,OAIX,IAAMc,EAAgBd,EAAK,OAAQe,GAAYA,EAAQ,OAAS,OAAO,EACnED,EAAc,QAChB,QAAQ,KAAK,kBAAmBA,CAAa,EAI/C,IAAMH,EAAiBX,EAAK,KAAMe,GAAYA,EAAQ,OAAS,iBAAiB,GAAG,eACnF,OAAIJ,IACFC,EAAkBD,CAAc,EAChC,KAAK,SAAS,eAAiBA,GAGhBX,EAAK,OAAQe,GAAYA,EAAQ,OAAS,mBAAqBA,EAAQ,OAAS,OAAO,CAE1G,CAcA,MAAM,WAAWC,EAAuCC,EAAoD,CAC1G,IAAMC,EAAsB,CAC1B,qBAAsBD,EACtB,eAAgB,KAAK,SAAS,eAC9B,UAAAD,EACA,WAAY,KAAK,SAAS,YAAc,UACxC,YAAa,OAAO,OAAO,MAC3B,aAAc,OAAO,OAAO,OAC5B,WAAY,OAAO,OAAO,OAAS,IAAM,SAAW,QACpD,IAAK,OAAO,SAAS,KACrB,UAAW,OAAO,UAAU,SAC9B,EAEA,OAAO,KAAK,SAAS,SAAS,KAAK,wBAAyB,CAC1D,KAAAE,CACF,CAAC,CACH,CAaA,aAAwB,CACtB,OAAO,KAAK,QACd,CAaA,kBAAkC,CAChC,OAAOC,EAAS,CAClB,CACF","names":["index_exports","__export","CONVERSATION_ID","Client","JWT_TOKEN","SESSION_ID","TTL","USER_ID","auth_default","deleteConversationId","error_default","getConversationId","getSessionId","getToken","getUserId","headers_default","isTokenExpired","setConversationId","setSessionId","setToken","setUserId","__toCommonJS","import_openapi_fetch","CONVERSATION_ID","deleteConversationId","getConversationId","setConversationId","conversationId","SESSION_ID","getSessionId","setSessionId","sessionId","getItemWithExpiry","key","itemString","item","getItemWithExpiry_default","setItemWithExpiry","key","value","ttl","item","setItemWithExpiry_default","day","USER_ID","TTL","getUserId","userId","getItemWithExpiry_default","setUserId","setItemWithExpiry_default","JWT_TOKEN","isTokenExpired","token","payloadBase64","payload","error","getToken","setToken","authMiddleware","accessToken","request","auth_default","errorMiddleware","response","data","error_default","headerMiddleware","identity","url","request","headers_default","version","Client","config","conversationUrl","customerId","fetch","frontendUrl","defaultHeaders","headers","version","createClient","getConversationId","getSessionId","getUserId","error_default","headers_default","pageviewId","sessionId","userId","data","setSessionId","setUserId","setToken","endpoint","auth_default","deleteConversationId","context","conversationContext","conversationIdMessage","openingMessage","conversationId","setConversationId","userMessage","debugMessages","message","eventName","properties","body","getToken"]}
1
+ {"version":3,"sources":["../src/index.ts","../src/client.ts","../src/identity/conversationId.ts","../src/identity/sessionId.ts","../src/utils/getItemWithExpiry.ts","../src/utils/setItemWithExpiry.ts","../src/identity/userId.ts","../src/identity/token.ts","../src/middlewares/auth.ts","../src/middlewares/error.ts","../src/middlewares/headers.ts","../package.json"],"sourcesContent":["export * from './client'\nexport * from './identity'\nexport * from './middlewares'\nexport * from './types'\n","import createClient, { type ClientOptions } from 'openapi-fetch'\n\nimport {\n deleteConversationId,\n getConversationId,\n getSessionId,\n getUserId,\n getToken,\n setConversationId,\n setSessionId,\n setUserId,\n setToken,\n} from './identity'\nimport { authMiddleware, errorMiddleware, headerMiddleware } from './middlewares'\nimport type { components, paths as conversationPaths } from './schemas/conversation'\nimport type { paths as frontendPaths } from './schemas/frontend'\nimport type {\n Config,\n ConversationIdMessage,\n DebugMessage,\n Endpoint,\n Identity,\n Message,\n TextMessage,\n TrackingEvent,\n} from './types'\nimport { version } from '../package.json'\n\n/**\n * The `Client` class provides methods to manage 15gifts API.\n */\nexport class Client {\n /**\n * This can be used to interact with the APIs directly. It is recommended to use the [helper methods](/sdk/sdk-reference/classes/client/#methods) provided by the `Client` class instead.\n *\n * @example\n * ```ts\n * const client = new Client({ customerId: 'YOUR_CUSTOMER_ID' })\n * const { data } = await client.endpoint.conversation.POST('/api/conversation/v3')\n * ```\n */\n endpoint: Endpoint\n\n /**\n * The identity information.\n */\n identity: Identity\n\n /**\n * Creates a new instance of the `Client` class.\n *\n * @param config - Configuration options for initializing the client.\n *\n * @example\n * ```ts\n * const client = new Client({ customerId: 'YOUR_CUSTOMER_ID' })\n * ```\n */\n constructor(config: Config) {\n const { conversationUrl, customerId, fetch, frontendUrl, headers: defaultHeaders } = config\n\n const headers: ClientOptions['headers'] = {\n ...defaultHeaders,\n 'X-SDK-VERSION': version,\n }\n\n this.endpoint = {\n conversation: createClient<conversationPaths>({\n baseUrl: conversationUrl,\n fetch,\n headers,\n credentials: 'include',\n }),\n frontend: createClient<frontendPaths>({ baseUrl: frontendUrl, fetch, headers }),\n }\n\n this.identity = {\n customerId,\n conversationId: getConversationId() ?? undefined,\n sessionId: getSessionId() ?? undefined,\n userId: getUserId() ?? undefined,\n }\n\n this.endpoint.conversation.use(errorMiddleware)\n this.endpoint.conversation.use(headerMiddleware(this.identity, window.location.href))\n }\n\n /**\n * Creates a new identity for the user by generating a session ID and user ID if they don't exist, and sets the access token for future API calls.\n * Ends the current conversation if a conversation ID is present before sending a request to update identity.\n *\n * @returns A promise that resolves once the identity is created and the access token is set.\n *\n * @example\n * ```ts\n * await client.createIdentity()\n * console.log('Identity created:', client.identity)\n * ```\n */\n async createIdentity(): Promise<void> {\n const { customerId, pageviewId, sessionId, userId } = this.identity\n\n const { data } = await this.endpoint.frontend.POST('/api/tracking/identity/v2', {\n body: {\n customerId,\n sessionId,\n userId,\n url: window.location.href,\n userAgent: window.navigator.userAgent,\n },\n })\n\n if (data) {\n if (!pageviewId) {\n this.identity.pageviewId = data.pageviewId\n }\n if (!sessionId) {\n this.identity.sessionId = data.sessionId\n setSessionId(data.sessionId)\n }\n if (!userId) {\n this.identity.userId = data.userId\n setUserId(data.userId)\n }\n\n setToken(data.token)\n\n Object.values(this.endpoint).forEach((endpoint) => {\n endpoint.use(authMiddleware(data.token))\n })\n }\n }\n\n /**\n * Ends the current conversation by deleting the conversation ID.\n *\n * @example\n * ```ts\n * client.endConversation()\n * console.log('Conversation ended')\n * ```\n */\n endConversation(): void {\n deleteConversationId()\n this.identity.conversationId = undefined\n }\n\n /**\n * Clears the existing conversation ID, then generates a new one and returns the opening message.\n *\n * @param context - Optional context to customize the conversation. It can include:\n * @param context.eligibleProducts An array of eligible product IDs.\n * @param context.eligibleBundles An array of eligible bundle IDs.\n * @param context.productOverrides Overrides for product details.\n * @param context.bundleOverrides Overrides for bundle details.\n *\n * @returns A promise that resolves to the opening message.\n *\n * @example\n * ##### Basic usage\n * ```ts\n * const openingMessage = await client.startConversation()\n * console.log('Opening message:', openingMessage)\n * ```\n *\n * ##### With context\n * ```ts\n * const openingMessage = await client.startConversation({ eligibleProducts: ['product-1', 'product-2'], productOverrides: { 'product-1': { price: 40 } })\n * console.log('Opening message:', openingMessage)\n * ```\n */\n async startConversation(context?: components['schemas']['ConversationContext']): Promise<TextMessage | undefined> {\n this.endConversation()\n\n const conversationContext = {\n ...context,\n }\n\n const { data } = await this.endpoint.conversation.POST(`/api/conversation/v3`, {\n body: {\n type: 'START_CONVERSATION',\n conversationContext,\n },\n })\n\n if (!data) return undefined\n\n const [conversationIdMessage, openingMessage] = data as [ConversationIdMessage, TextMessage]\n\n const conversationId = conversationIdMessage.conversationId\n if (!conversationId) {\n throw new Error('Conversation ID not received')\n }\n\n setConversationId(conversationId)\n this.identity.conversationId = conversationId\n\n return openingMessage\n }\n\n /**\n * Sends a message in the conversation.\n *\n * @param options - An object containing the user message.\n * @returns A promise that resolves to an array of messages\n *\n * @example\n * ```ts\n * const newMessages = await client.sendMessage({\n * userMessage: 'How can I get support?',\n * })\n *\n * if (newMessages) {\n * console.log('Received messages:', newMessages)\n * } else {\n * console.log('No message received')\n * }\n * ```\n */\n async sendMessage({\n userMessage,\n }: {\n userMessage: string\n }): Promise<Exclude<Message, ConversationIdMessage | DebugMessage>[] | undefined> {\n const { data } = await this.endpoint.conversation.POST('/api/conversation/v3', {\n body: {\n conversationId: this.identity.conversationId,\n userMessage,\n type: 'MESSAGE',\n },\n })\n\n if (!data) return undefined\n\n // Log debug messages\n // These will only be in the response when used in internal testing\n const debugMessages = data.filter((message) => message.type === 'DEBUG')\n if (debugMessages.length) {\n console.info('Debug messages:', debugMessages)\n }\n\n // When a request does not contain a conversation ID, the API will return a new conversation ID as the first message\n const conversationId = data.find((message) => message.type === 'CONVERSATION_ID')?.conversationId\n if (conversationId) {\n setConversationId(conversationId)\n this.identity.conversationId = conversationId\n }\n\n const messages = data.filter((message) => message.type !== 'CONVERSATION_ID' && message.type !== 'DEBUG')\n return messages\n }\n\n /**\n * Sends an event to the tracking API, with the required properties already set.\n *\n * @param eventName - The name of the event to track.\n * @param properties - Additional properties to include in the event.\n * @returns A promise that resolves once the event is tracked.\n *\n * @example\n * ```ts\n * await client.trackEvent('entry_point-shown')\n * ```\n */\n async trackEvent(eventName: TrackingEvent['eventName'], properties?: TrackingEvent['additionalProperties']) {\n const body: TrackingEvent = {\n additionalProperties: properties,\n conversationId: this.identity.conversationId,\n eventName,\n pageviewId: this.identity.pageviewId ?? 'unknown',\n screenWidth: window.screen.width,\n screenHeight: window.screen.height,\n screenSize: window.screen.width <= 480 ? 'mobile' : 'large',\n url: window.location.href,\n userAgent: window.navigator.userAgent,\n }\n\n return this.endpoint.frontend.POST('/api/tracking/user/v2', {\n body,\n })\n }\n\n /**\n * Gets an existing identity of the user.\n *\n * @returns An Identity object containing `customerId`, `conversationId`, `sessionId`, `userId`.\n *\n * @example\n * ```ts\n * identity = client.getIdentity()\n * console.log('Identity retrieved:', identity)\n * ```\n */\n getIdentity(): Identity {\n return this.identity\n }\n\n /**\n * Gets the JWT from the localStorage.\n *\n * @returns {string | null} the JWT.\n *\n * @example\n * ```ts\n * token = client.getIdentityToken()\n * console.log('Identity token retrieved:', token)\n * ```\n */\n getIdentityToken(): string | null {\n return getToken()\n }\n}\n","/**\n * The key used to store the conversation ID in `sessionStorage`.\n *\n * @ignore\n */\nexport const CONVERSATION_ID = '__15gifts_conversation_id'\n\n/**\n * Deletes the conversation ID from `sessionStorage`.\n *\n * @example\n * ```ts\n * import { deleteConversationId } from '@15gifts/sdk'\n *\n * deleteConversationId()\n * // The conversation ID will be removed.\n * ```\n */\nexport const deleteConversationId = () => sessionStorage.removeItem(CONVERSATION_ID)\n\n/**\n * Retrieves the conversation ID from `sessionStorage`.\n *\n * @example\n * ```ts\n * import { getConversationId } from '@15gifts/sdk'\n *\n * const conversationId = getConversationId()\n *\n * if (conversationId) {\n * console.log(`Conversation ID: ${conversationId}`)\n * } else {\n * console.log('No conversation ID found.')\n * }\n * ```\n */\nexport const getConversationId = () => sessionStorage.getItem(CONVERSATION_ID)\n\n/**\n * Stores the given conversation ID in `sessionStorage`.\n *\n * @example\n * ```ts\n * import { setConversationId } from '@15gifts/sdk'\n *\n * setConversationId('ca0ab4ce-f697-41cc-8d0c-081762aace9b')\n * // The conversation ID 'ca0ab4ce-f697-41cc-8d0c-081762aace9b' will be stored.\n * ```\n */\nexport const setConversationId = (conversationId: string) => sessionStorage.setItem(CONVERSATION_ID, conversationId)\n","/**\n * The key used to store the session ID in `sessionStorage`.\n *\n * @ignore\n */\nexport const SESSION_ID = '__15gifts_session_id'\n\n/**\n * Retrieves the session ID from `sessionStorage`.\n *\n * @example\n * ```ts\n * import { getSessionId } from '@15gifts/sdk'\n *\n * const sessionId = getSessionId()\n *\n * if (sessionId) {\n * console.log(`Session ID: ${sessionId}`)\n * } else {\n * console.log('No session ID found.')\n * }\n * ```\n */\nexport const getSessionId = () => sessionStorage.getItem(SESSION_ID)\n\n/**\n * Stores the given session ID in `sessionStorage`.\n *\n * @example\n * ```ts\n * import { setSessionId } from '@15gifts/sdk'\n *\n * setSessionId('20b2bff6-64a0-4101-bed9-ff545326584a')\n * // The session ID '20b2bff6-64a0-4101-bed9-ff545326584a' will be stored.\n * ```\n */\nexport const setSessionId = (sessionId: string) => sessionStorage.setItem(SESSION_ID, sessionId)\n","const getItemWithExpiry = (key: string) => {\n const itemString = localStorage.getItem(key)\n\n if (!itemString) return null\n\n const item = JSON.parse(itemString) as { expires: number; value: string }\n\n if (Date.now() > item.expires) {\n localStorage.removeItem(key)\n\n return null\n }\n\n return item.value\n}\n\nexport default getItemWithExpiry\n","/**\n * Set an item in localStorage with an expiration time\n * @param key The key under which the value is stored in localStorage\n * @param value The value to be stored\n * @param ttl The time-to-live (TTL) in milliseconds\n */\nconst setItemWithExpiry = (key: string, value: string, ttl: number) => {\n const item = {\n expires: Date.now() + ttl,\n value,\n }\n\n localStorage.setItem(key, JSON.stringify(item))\n}\n\nexport default setItemWithExpiry\n","import { getItemWithExpiry, setItemWithExpiry } from '../utils'\nconst day = 1000 * 60 * 60 * 24\n\n/**\n * The key used to store the user ID in `localStorage`.\n *\n * @ignore\n */\nexport const USER_ID = '__15gifts_user_id'\n\n/**\n * Time-to-live (TTL) for the user ID in milliseconds.\n * Set to 30 days.\n *\n * @ignore\n */\nexport const TTL = day * 30\n\n/**\n * Retrieves the user ID from `localStorage` and updates its expiry time.\n *\n * @example\n * ```ts\n * import { getUserId } from '@15gifts/sdk'\n *\n * const userId = getUserId()\n *\n * if (userId) {\n * console.log(`User ID: ${userId}`)\n * } else {\n * console.log('No user ID found.')\n * }\n * ```\n */\nexport const getUserId = () => {\n const userId = getItemWithExpiry(USER_ID)\n\n // Update the userId with a new expiry time\n // So that it will be valid for another 30 days, rather than 30 days from when it was first set\n if (userId) {\n setUserId(userId)\n }\n\n return userId\n}\n\n/**\n * Stores the given user ID in `localStorage`.\n *\n * @example\n * ```ts\n * import { setUserId } from '@15gifts/sdk'\n *\n * setUserId('5b77656c-ea4c-492f-82bf-7129297c5873')\n * // The user ID '5b77656c-ea4c-492f-82bf-7129297c5873' will be stored with a 30-day expiry.\n * ```\n */\nexport const setUserId = (userId: string) => setItemWithExpiry(USER_ID, userId, TTL)\n","/**\n * The key used to store the JWT in `localStorage`.\n *\n * @ignore\n */\nexport const JWT_TOKEN = '__15gifts_identity_token'\n\n/**\n * Checks if the JWT is expired.\n *\n * @param {string} token - the JWT.\n * @returns {boolean} `true` if expired, `false` otherwise.\n */\nexport const isTokenExpired = (token: string): boolean => {\n try {\n const [, payloadBase64] = token.split('.')\n if (!payloadBase64) {\n throw new Error('Invalid token payload')\n }\n const payload = JSON.parse(atob(payloadBase64))\n\n return payload.exp && Date.now() / 1000 > payload.exp\n } catch (error) {\n console.error('Invalid token format', error)\n return true\n }\n}\n\n/**\n * Retrieves the JWT from `localStorage` and checks if it is expired.\n *\n * @returns {string | null} The JWT if valid, otherwise `null`.\n */\nexport const getToken = (): string | null => {\n const token = localStorage.getItem(JWT_TOKEN)\n\n if (!token || isTokenExpired(token)) {\n localStorage.removeItem(JWT_TOKEN)\n return null\n }\n\n return token\n}\n\n/**\n * Stores the given JWT in `localStorage`.\n *\n * @example\n * ```ts\n * import { setToken } from '@15gifts/sdk'\n *\n * setToken('ey...')\n * ```\n */\nexport const setToken = (token: string) => localStorage.setItem(JWT_TOKEN, token)\n","import type { Middleware } from 'openapi-fetch'\n\n/**\n * Middleware for adding an `Authorization` header to requests.\n *\n * @param accessToken - The token to be included in the `Authorization` header.\n * @returns A middleware object that attaches the access token to the request headers.\n *\n * @example\n * ```ts\n * import { authMiddleware } from '@15gifts/sdk';\n *\n * this.endpoint.conversation.use(authMiddleware(accessToken))\n * ```\n */\nconst authMiddleware = (accessToken: string): Middleware => ({\n onRequest: async ({ request }) => {\n request.headers.set('Authorization', `Bearer ${accessToken}`)\n\n return request\n },\n})\n\nexport default authMiddleware\n","import type { Middleware } from 'openapi-fetch'\n\n/**\n * Middleware for handling errors.\n *\n * @returns A middleware object that throws an error if the response is not ok.\n *\n * @example\n * ```ts\n * import { errorMiddleware } from '@15gifts/sdk';\n *\n * this.endpoint.conversation.use(errorMiddleware())\n * ```\n */\nconst errorMiddleware: Middleware = {\n // onError does not handle error responses with 4xx or 5xx HTTP status codes, since these are considered \"successful\" responses but with a bad status code.\n // In these cases we need to check the response's status property or ok() method via the onResponse callback.\n onResponse: async ({ response }) => {\n if (!response.ok) {\n const data = await response.json()\n\n throw new Error(data.message)\n }\n\n return response\n },\n}\n\nexport default errorMiddleware\n","import type { Middleware } from 'openapi-fetch'\n\nimport { Identity } from '../types'\n\n/**\n * Middleware for adding request headers that other services use for tracking.\n *\n * @returns A middleware object that throws an error if the response is not ok.\n *\n * @example\n * ```ts\n * import { pageViewId } from '@15gifts/sdk';\n *\n * this.endpoint.conversation.use(headerMiddleware('123', 'https://example.com'))\n * ```\n */\nconst headerMiddleware = (identity: Identity, url: string): Middleware => ({\n onRequest: async ({ request }) => {\n if (identity.pageviewId) {\n request.headers.set('X-PAGEVIEW-ID', identity.pageviewId)\n }\n if (url) {\n request.headers.set('X-PAGE-URL', url)\n }\n\n return request\n },\n})\n\nexport default headerMiddleware\n","{\n \"name\": \"@15gifts/sdk\",\n \"version\": \"0.11.8\",\n \"files\": [\n \"dist\"\n ],\n \"main\": \"./dist/index.js\",\n \"module\": \"./dist/index.mjs\",\n \"types\": \"./dist/index.d.ts\",\n \"scripts\": {\n \"build\": \"npm run generate && tsup\",\n \"coverage\": \"vitest run --coverage\",\n \"dev\": \"tsup --watch\",\n \"format\": \"prettier . --write\",\n \"generate\": \"npx openapi-typescript\",\n \"lint\": \"eslint .\",\n \"test\": \"vitest run\",\n \"test:watch\": \"vitest\",\n \"typecheck\": \"tsc\"\n },\n \"dependencies\": {\n \"openapi-fetch\": \"^0.13.4\"\n },\n \"devDependencies\": {\n \"openapi-typescript\": \"^7.6.0\",\n \"tsup\": \"^8.3.6\"\n },\n \"sideEffects\": false,\n \"prettier\": \"prettier-config-custom\"\n}\n"],"mappings":"0jBAAA,IAAAA,EAAA,GAAAC,EAAAD,EAAA,qBAAAE,EAAA,WAAAC,EAAA,cAAAC,EAAA,eAAAC,EAAA,QAAAC,EAAA,YAAAC,EAAA,mBAAAC,EAAA,yBAAAC,EAAA,oBAAAC,EAAA,sBAAAC,EAAA,iBAAAC,EAAA,aAAAC,EAAA,cAAAC,EAAA,qBAAAC,EAAA,mBAAAC,EAAA,sBAAAC,EAAA,iBAAAC,EAAA,aAAAC,EAAA,cAAAC,IAAA,eAAAC,EAAArB,GCAA,IAAAsB,EAAiD,4BCK1C,IAAMC,EAAkB,4BAalBC,EAAuB,IAAM,eAAe,WAAWD,CAAe,EAkBtEE,EAAoB,IAAM,eAAe,QAAQF,CAAe,EAahEG,EAAqBC,GAA2B,eAAe,QAAQJ,EAAiBI,CAAc,EC5C5G,IAAMC,EAAa,uBAkBbC,EAAe,IAAM,eAAe,QAAQD,CAAU,EAatDE,EAAgBC,GAAsB,eAAe,QAAQH,EAAYG,CAAS,ECpC/F,IAAMC,EAAqBC,GAAgB,CACzC,IAAMC,EAAa,aAAa,QAAQD,CAAG,EAE3C,GAAI,CAACC,EAAY,OAAO,KAExB,IAAMC,EAAO,KAAK,MAAMD,CAAU,EAElC,OAAI,KAAK,IAAI,EAAIC,EAAK,SACpB,aAAa,WAAWF,CAAG,EAEpB,MAGFE,EAAK,KACd,EAEOC,EAAQJ,ECVf,IAAMK,EAAoB,CAACC,EAAaC,EAAeC,IAAgB,CACrE,IAAMC,EAAO,CACX,QAAS,KAAK,IAAI,EAAID,EACtB,MAAAD,CACF,EAEA,aAAa,QAAQD,EAAK,KAAK,UAAUG,CAAI,CAAC,CAChD,EAEOC,EAAQL,ECdf,IAAMM,EAAM,IAAO,GAAK,GAAK,GAOhBC,EAAU,oBAQVC,EAAMF,EAAM,GAkBZG,EAAY,IAAM,CAC7B,IAAMC,EAASC,EAAkBJ,CAAO,EAIxC,OAAIG,GACFE,EAAUF,CAAM,EAGXA,CACT,EAaaE,EAAaF,GAAmBG,EAAkBN,EAASG,EAAQF,CAAG,ECpD5E,IAAMM,EAAY,2BAQZC,EAAkBC,GAA2B,CACxD,GAAI,CACF,GAAM,CAAC,CAAEC,CAAa,EAAID,EAAM,MAAM,GAAG,EACzC,GAAI,CAACC,EACH,MAAM,IAAI,MAAM,uBAAuB,EAEzC,IAAMC,EAAU,KAAK,MAAM,KAAKD,CAAa,CAAC,EAE9C,OAAOC,EAAQ,KAAO,KAAK,IAAI,EAAI,IAAOA,EAAQ,GACpD,OAASC,EAAO,CACd,eAAQ,MAAM,uBAAwBA,CAAK,EACpC,EACT,CACF,EAOaC,EAAW,IAAqB,CAC3C,IAAMJ,EAAQ,aAAa,QAAQF,CAAS,EAE5C,MAAI,CAACE,GAASD,EAAeC,CAAK,GAChC,aAAa,WAAWF,CAAS,EAC1B,MAGFE,CACT,EAYaK,EAAYL,GAAkB,aAAa,QAAQF,EAAWE,CAAK,ECvChF,IAAMM,EAAkBC,IAAqC,CAC3D,UAAW,MAAO,CAAE,QAAAC,CAAQ,KAC1BA,EAAQ,QAAQ,IAAI,gBAAiB,UAAUD,CAAW,EAAE,EAErDC,EAEX,GAEOC,EAAQH,ECTf,IAAMI,EAA8B,CAGlC,WAAY,MAAO,CAAE,SAAAC,CAAS,IAAM,CAClC,GAAI,CAACA,EAAS,GAAI,CAChB,IAAMC,EAAO,MAAMD,EAAS,KAAK,EAEjC,MAAM,IAAI,MAAMC,EAAK,OAAO,CAC9B,CAEA,OAAOD,CACT,CACF,EAEOE,EAAQH,ECZf,IAAMI,EAAmB,CAACC,EAAoBC,KAA6B,CACzE,UAAW,MAAO,CAAE,QAAAC,CAAQ,KACtBF,EAAS,YACXE,EAAQ,QAAQ,IAAI,gBAAiBF,EAAS,UAAU,EAEtDC,GACFC,EAAQ,QAAQ,IAAI,aAAcD,CAAG,EAGhCC,EAEX,GAEOC,EAAQJ,EC3Bb,IAAAK,EAAW,SV6BN,IAAMC,EAAN,KAAa,CAUlB,SAKA,SAYA,YAAYC,EAAgB,CAC1B,GAAM,CAAE,gBAAAC,EAAiB,WAAAC,EAAY,MAAAC,EAAO,YAAAC,EAAa,QAASC,CAAe,EAAIL,EAE/EM,EAAoC,CACxC,GAAGD,EACH,gBAAiBE,CACnB,EAEA,KAAK,SAAW,CACd,gBAAc,EAAAC,SAAgC,CAC5C,QAASP,EACT,MAAAE,EACA,QAAAG,EACA,YAAa,SACf,CAAC,EACD,YAAU,EAAAE,SAA4B,CAAE,QAASJ,EAAa,MAAAD,EAAO,QAAAG,CAAQ,CAAC,CAChF,EAEA,KAAK,SAAW,CACd,WAAAJ,EACA,eAAgBO,EAAkB,GAAK,OACvC,UAAWC,EAAa,GAAK,OAC7B,OAAQC,EAAU,GAAK,MACzB,EAEA,KAAK,SAAS,aAAa,IAAIC,CAAe,EAC9C,KAAK,SAAS,aAAa,IAAIC,EAAiB,KAAK,SAAU,OAAO,SAAS,IAAI,CAAC,CACtF,CAcA,MAAM,gBAAgC,CACpC,GAAM,CAAE,WAAAX,EAAY,WAAAY,EAAY,UAAAC,EAAW,OAAAC,CAAO,EAAI,KAAK,SAErD,CAAE,KAAAC,CAAK,EAAI,MAAM,KAAK,SAAS,SAAS,KAAK,4BAA6B,CAC9E,KAAM,CACJ,WAAAf,EACA,UAAAa,EACA,OAAAC,EACA,IAAK,OAAO,SAAS,KACrB,UAAW,OAAO,UAAU,SAC9B,CACF,CAAC,EAEGC,IACGH,IACH,KAAK,SAAS,WAAaG,EAAK,YAE7BF,IACH,KAAK,SAAS,UAAYE,EAAK,UAC/BC,EAAaD,EAAK,SAAS,GAExBD,IACH,KAAK,SAAS,OAASC,EAAK,OAC5BE,EAAUF,EAAK,MAAM,GAGvBG,EAASH,EAAK,KAAK,EAEnB,OAAO,OAAO,KAAK,QAAQ,EAAE,QAASI,GAAa,CACjDA,EAAS,IAAIC,EAAeL,EAAK,KAAK,CAAC,CACzC,CAAC,EAEL,CAWA,iBAAwB,CACtBM,EAAqB,EACrB,KAAK,SAAS,eAAiB,MACjC,CA0BA,MAAM,kBAAkBC,EAA0F,CAChH,KAAK,gBAAgB,EAErB,IAAMC,EAAsB,CAC1B,GAAGD,CACL,EAEM,CAAE,KAAAP,CAAK,EAAI,MAAM,KAAK,SAAS,aAAa,KAAK,uBAAwB,CAC7E,KAAM,CACJ,KAAM,qBACN,oBAAAQ,CACF,CACF,CAAC,EAED,GAAI,CAACR,EAAM,OAEX,GAAM,CAACS,EAAuBC,CAAc,EAAIV,EAE1CW,EAAiBF,EAAsB,eAC7C,GAAI,CAACE,EACH,MAAM,IAAI,MAAM,8BAA8B,EAGhD,OAAAC,EAAkBD,CAAc,EAChC,KAAK,SAAS,eAAiBA,EAExBD,CACT,CAqBA,MAAM,YAAY,CAChB,YAAAG,CACF,EAEkF,CAChF,GAAM,CAAE,KAAAb,CAAK,EAAI,MAAM,KAAK,SAAS,aAAa,KAAK,uBAAwB,CAC7E,KAAM,CACJ,eAAgB,KAAK,SAAS,eAC9B,YAAAa,EACA,KAAM,SACR,CACF,CAAC,EAED,GAAI,CAACb,EAAM,OAIX,IAAMc,EAAgBd,EAAK,OAAQe,GAAYA,EAAQ,OAAS,OAAO,EACnED,EAAc,QAChB,QAAQ,KAAK,kBAAmBA,CAAa,EAI/C,IAAMH,EAAiBX,EAAK,KAAMe,GAAYA,EAAQ,OAAS,iBAAiB,GAAG,eACnF,OAAIJ,IACFC,EAAkBD,CAAc,EAChC,KAAK,SAAS,eAAiBA,GAGhBX,EAAK,OAAQe,GAAYA,EAAQ,OAAS,mBAAqBA,EAAQ,OAAS,OAAO,CAE1G,CAcA,MAAM,WAAWC,EAAuCC,EAAoD,CAC1G,IAAMC,EAAsB,CAC1B,qBAAsBD,EACtB,eAAgB,KAAK,SAAS,eAC9B,UAAAD,EACA,WAAY,KAAK,SAAS,YAAc,UACxC,YAAa,OAAO,OAAO,MAC3B,aAAc,OAAO,OAAO,OAC5B,WAAY,OAAO,OAAO,OAAS,IAAM,SAAW,QACpD,IAAK,OAAO,SAAS,KACrB,UAAW,OAAO,UAAU,SAC9B,EAEA,OAAO,KAAK,SAAS,SAAS,KAAK,wBAAyB,CAC1D,KAAAE,CACF,CAAC,CACH,CAaA,aAAwB,CACtB,OAAO,KAAK,QACd,CAaA,kBAAkC,CAChC,OAAOC,EAAS,CAClB,CACF","names":["index_exports","__export","CONVERSATION_ID","Client","JWT_TOKEN","SESSION_ID","TTL","USER_ID","auth_default","deleteConversationId","error_default","getConversationId","getSessionId","getToken","getUserId","headers_default","isTokenExpired","setConversationId","setSessionId","setToken","setUserId","__toCommonJS","import_openapi_fetch","CONVERSATION_ID","deleteConversationId","getConversationId","setConversationId","conversationId","SESSION_ID","getSessionId","setSessionId","sessionId","getItemWithExpiry","key","itemString","item","getItemWithExpiry_default","setItemWithExpiry","key","value","ttl","item","setItemWithExpiry_default","day","USER_ID","TTL","getUserId","userId","getItemWithExpiry_default","setUserId","setItemWithExpiry_default","JWT_TOKEN","isTokenExpired","token","payloadBase64","payload","error","getToken","setToken","authMiddleware","accessToken","request","auth_default","errorMiddleware","response","data","error_default","headerMiddleware","identity","url","request","headers_default","version","Client","config","conversationUrl","customerId","fetch","frontendUrl","defaultHeaders","headers","version","createClient","getConversationId","getSessionId","getUserId","error_default","headers_default","pageviewId","sessionId","userId","data","setSessionId","setUserId","setToken","endpoint","auth_default","deleteConversationId","context","conversationContext","conversationIdMessage","openingMessage","conversationId","setConversationId","userMessage","debugMessages","message","eventName","properties","body","getToken"]}
package/dist/index.mjs CHANGED
@@ -1,2 +1,2 @@
1
- import _ from"openapi-fetch";var a="__15gifts_conversation_id",v=()=>sessionStorage.removeItem(a),h=()=>sessionStorage.getItem(a),d=e=>sessionStorage.setItem(a,e);var y="__15gifts_session_id",w=()=>sessionStorage.getItem(y),x=e=>sessionStorage.setItem(y,e);var O=e=>{let t=localStorage.getItem(e);if(!t)return null;let n=JSON.parse(t);return Date.now()>n.expires?(localStorage.removeItem(e),null):n.value},c=O;var b=(e,t,n)=>{let s={expires:Date.now()+n,value:t};localStorage.setItem(e,JSON.stringify(s))},p=b;var D=1e3*60*60*24,S="__15gifts_user_id",N=D*30,E=()=>{let e=c(S);return e&&g(e),e},g=e=>p(S,e,N);var f="__15gifts_identity_token",P=e=>{try{let[,t]=e.split(".");if(!t)throw new Error("Invalid token payload");let n=JSON.parse(atob(t));return n.exp&&Date.now()/1e3>n.exp}catch(t){return console.error("Invalid token format",t),!0}},M=()=>{let e=localStorage.getItem(f);return!e||P(e)?(localStorage.removeItem(f),null):e},T=e=>localStorage.setItem(f,e);var A=e=>({onRequest:async({request:t})=>(t.headers.set("Authorization",`Bearer ${e}`),t)}),I=A;var U={onResponse:async({response:e})=>{if(!e.ok){let t=await e.json();throw new Error(t.message)}return e}},l=U;var R=(e,t)=>({onRequest:async({request:n})=>(e.pageviewId&&n.headers.set("X-PAGEVIEW-ID",e.pageviewId),t&&n.headers.set("X-PAGE-URL",t),n)}),u=R;var C="0.11.6";var k=class{endpoint;identity;constructor(t){let{conversationUrl:n,customerId:s,fetch:r,frontendUrl:i,headers:o}=t,m={...o,"X-SDK-VERSION":C};this.endpoint={conversation:_({baseUrl:n,fetch:r,headers:m,credentials:"include"}),frontend:_({baseUrl:i,fetch:r,headers:m})},this.identity={customerId:s,conversationId:h()??void 0,sessionId:w()??void 0,userId:E()??void 0},this.endpoint.conversation.use(l),this.endpoint.conversation.use(u(this.identity,window.location.href))}async createIdentity(){let{customerId:t,pageviewId:n,sessionId:s,userId:r}=this.identity,{data:i}=await this.endpoint.frontend.POST("/api/tracking/identity/v2",{body:{customerId:t,sessionId:s,userId:r,url:window.location.href,userAgent:window.navigator.userAgent}});i&&(n||(this.identity.pageviewId=i.pageviewId),s||(this.identity.sessionId=i.sessionId,x(i.sessionId)),r||(this.identity.userId=i.userId,g(i.userId)),T(i.token),Object.values(this.endpoint).forEach(o=>{o.use(I(i.token))}))}endConversation(){v(),this.identity.conversationId=void 0}async startConversation(t){this.endConversation();let n={...t},{data:s}=await this.endpoint.conversation.POST("/api/conversation/v3",{body:{type:"START_CONVERSATION",conversationContext:n}});if(!s)return;let[r,i]=s,o=r.conversationId;if(!o)throw new Error("Conversation ID not received");return d(o),this.identity.conversationId=o,i}async sendMessage({userMessage:t}){let{data:n}=await this.endpoint.conversation.POST("/api/conversation/v3",{body:{conversationId:this.identity.conversationId,userMessage:t,type:"MESSAGE"}});if(!n)return;let s=n.filter(o=>o.type==="DEBUG");s.length&&console.info("Debug messages:",s);let r=n.find(o=>o.type==="CONVERSATION_ID")?.conversationId;return r&&(d(r),this.identity.conversationId=r),n.filter(o=>o.type!=="CONVERSATION_ID"&&o.type!=="DEBUG")}async trackEvent(t,n){let s={additionalProperties:n,conversationId:this.identity.conversationId,eventName:t,pageviewId:this.identity.pageviewId??"unknown",screenWidth:window.screen.width,screenHeight:window.screen.height,screenSize:window.screen.width<=480?"mobile":"large",url:window.location.href,userAgent:window.navigator.userAgent};return this.endpoint.frontend.POST("/api/tracking/user/v2",{body:s})}getIdentity(){return this.identity}getIdentityToken(){return M()}};export{a as CONVERSATION_ID,k as Client,f as JWT_TOKEN,y as SESSION_ID,N as TTL,S as USER_ID,I as authMiddleware,v as deleteConversationId,l as errorMiddleware,h as getConversationId,w as getSessionId,M as getToken,E as getUserId,u as headerMiddleware,P as isTokenExpired,d as setConversationId,x as setSessionId,T as setToken,g as setUserId};
1
+ import _ from"openapi-fetch";var a="__15gifts_conversation_id",v=()=>sessionStorage.removeItem(a),h=()=>sessionStorage.getItem(a),d=e=>sessionStorage.setItem(a,e);var y="__15gifts_session_id",w=()=>sessionStorage.getItem(y),x=e=>sessionStorage.setItem(y,e);var O=e=>{let t=localStorage.getItem(e);if(!t)return null;let n=JSON.parse(t);return Date.now()>n.expires?(localStorage.removeItem(e),null):n.value},c=O;var b=(e,t,n)=>{let s={expires:Date.now()+n,value:t};localStorage.setItem(e,JSON.stringify(s))},p=b;var D=1e3*60*60*24,S="__15gifts_user_id",N=D*30,E=()=>{let e=c(S);return e&&g(e),e},g=e=>p(S,e,N);var f="__15gifts_identity_token",P=e=>{try{let[,t]=e.split(".");if(!t)throw new Error("Invalid token payload");let n=JSON.parse(atob(t));return n.exp&&Date.now()/1e3>n.exp}catch(t){return console.error("Invalid token format",t),!0}},M=()=>{let e=localStorage.getItem(f);return!e||P(e)?(localStorage.removeItem(f),null):e},T=e=>localStorage.setItem(f,e);var A=e=>({onRequest:async({request:t})=>(t.headers.set("Authorization",`Bearer ${e}`),t)}),I=A;var U={onResponse:async({response:e})=>{if(!e.ok){let t=await e.json();throw new Error(t.message)}return e}},l=U;var R=(e,t)=>({onRequest:async({request:n})=>(e.pageviewId&&n.headers.set("X-PAGEVIEW-ID",e.pageviewId),t&&n.headers.set("X-PAGE-URL",t),n)}),u=R;var C="0.11.8";var k=class{endpoint;identity;constructor(t){let{conversationUrl:n,customerId:s,fetch:r,frontendUrl:i,headers:o}=t,m={...o,"X-SDK-VERSION":C};this.endpoint={conversation:_({baseUrl:n,fetch:r,headers:m,credentials:"include"}),frontend:_({baseUrl:i,fetch:r,headers:m})},this.identity={customerId:s,conversationId:h()??void 0,sessionId:w()??void 0,userId:E()??void 0},this.endpoint.conversation.use(l),this.endpoint.conversation.use(u(this.identity,window.location.href))}async createIdentity(){let{customerId:t,pageviewId:n,sessionId:s,userId:r}=this.identity,{data:i}=await this.endpoint.frontend.POST("/api/tracking/identity/v2",{body:{customerId:t,sessionId:s,userId:r,url:window.location.href,userAgent:window.navigator.userAgent}});i&&(n||(this.identity.pageviewId=i.pageviewId),s||(this.identity.sessionId=i.sessionId,x(i.sessionId)),r||(this.identity.userId=i.userId,g(i.userId)),T(i.token),Object.values(this.endpoint).forEach(o=>{o.use(I(i.token))}))}endConversation(){v(),this.identity.conversationId=void 0}async startConversation(t){this.endConversation();let n={...t},{data:s}=await this.endpoint.conversation.POST("/api/conversation/v3",{body:{type:"START_CONVERSATION",conversationContext:n}});if(!s)return;let[r,i]=s,o=r.conversationId;if(!o)throw new Error("Conversation ID not received");return d(o),this.identity.conversationId=o,i}async sendMessage({userMessage:t}){let{data:n}=await this.endpoint.conversation.POST("/api/conversation/v3",{body:{conversationId:this.identity.conversationId,userMessage:t,type:"MESSAGE"}});if(!n)return;let s=n.filter(o=>o.type==="DEBUG");s.length&&console.info("Debug messages:",s);let r=n.find(o=>o.type==="CONVERSATION_ID")?.conversationId;return r&&(d(r),this.identity.conversationId=r),n.filter(o=>o.type!=="CONVERSATION_ID"&&o.type!=="DEBUG")}async trackEvent(t,n){let s={additionalProperties:n,conversationId:this.identity.conversationId,eventName:t,pageviewId:this.identity.pageviewId??"unknown",screenWidth:window.screen.width,screenHeight:window.screen.height,screenSize:window.screen.width<=480?"mobile":"large",url:window.location.href,userAgent:window.navigator.userAgent};return this.endpoint.frontend.POST("/api/tracking/user/v2",{body:s})}getIdentity(){return this.identity}getIdentityToken(){return M()}};export{a as CONVERSATION_ID,k as Client,f as JWT_TOKEN,y as SESSION_ID,N as TTL,S as USER_ID,I as authMiddleware,v as deleteConversationId,l as errorMiddleware,h as getConversationId,w as getSessionId,M as getToken,E as getUserId,u as headerMiddleware,P as isTokenExpired,d as setConversationId,x as setSessionId,T as setToken,g as setUserId};
2
2
  //# sourceMappingURL=index.mjs.map
@@ -1 +1 @@
1
- {"version":3,"sources":["../src/client.ts","../src/identity/conversationId.ts","../src/identity/sessionId.ts","../src/utils/getItemWithExpiry.ts","../src/utils/setItemWithExpiry.ts","../src/identity/userId.ts","../src/identity/token.ts","../src/middlewares/auth.ts","../src/middlewares/error.ts","../src/middlewares/headers.ts","../package.json"],"sourcesContent":["import createClient, { type ClientOptions } from 'openapi-fetch'\n\nimport {\n deleteConversationId,\n getConversationId,\n getSessionId,\n getUserId,\n getToken,\n setConversationId,\n setSessionId,\n setUserId,\n setToken,\n} from './identity'\nimport { authMiddleware, errorMiddleware, headerMiddleware } from './middlewares'\nimport type { components, paths as conversationPaths } from './schemas/conversation'\nimport type { paths as frontendPaths } from './schemas/frontend'\nimport type {\n Config,\n ConversationIdMessage,\n DebugMessage,\n Endpoint,\n Identity,\n Message,\n TextMessage,\n TrackingEvent,\n} from './types'\nimport { version } from '../package.json'\n\n/**\n * The `Client` class provides methods to manage 15gifts API.\n */\nexport class Client {\n /**\n * This can be used to interact with the APIs directly. It is recommended to use the [helper methods](/sdk/sdk-reference/classes/client/#methods) provided by the `Client` class instead.\n *\n * @example\n * ```ts\n * const client = new Client({ customerId: 'YOUR_CUSTOMER_ID' })\n * const { data } = await client.endpoint.conversation.POST('/api/conversation/v3')\n * ```\n */\n endpoint: Endpoint\n\n /**\n * The identity information.\n */\n identity: Identity\n\n /**\n * Creates a new instance of the `Client` class.\n *\n * @param config - Configuration options for initializing the client.\n *\n * @example\n * ```ts\n * const client = new Client({ customerId: 'YOUR_CUSTOMER_ID' })\n * ```\n */\n constructor(config: Config) {\n const { conversationUrl, customerId, fetch, frontendUrl, headers: defaultHeaders } = config\n\n const headers: ClientOptions['headers'] = {\n ...defaultHeaders,\n 'X-SDK-VERSION': version,\n }\n\n this.endpoint = {\n conversation: createClient<conversationPaths>({\n baseUrl: conversationUrl,\n fetch,\n headers,\n credentials: 'include',\n }),\n frontend: createClient<frontendPaths>({ baseUrl: frontendUrl, fetch, headers }),\n }\n\n this.identity = {\n customerId,\n conversationId: getConversationId() ?? undefined,\n sessionId: getSessionId() ?? undefined,\n userId: getUserId() ?? undefined,\n }\n\n this.endpoint.conversation.use(errorMiddleware)\n this.endpoint.conversation.use(headerMiddleware(this.identity, window.location.href))\n }\n\n /**\n * Creates a new identity for the user by generating a session ID and user ID if they don't exist, and sets the access token for future API calls.\n * Ends the current conversation if a conversation ID is present before sending a request to update identity.\n *\n * @returns A promise that resolves once the identity is created and the access token is set.\n *\n * @example\n * ```ts\n * await client.createIdentity()\n * console.log('Identity created:', client.identity)\n * ```\n */\n async createIdentity(): Promise<void> {\n const { customerId, pageviewId, sessionId, userId } = this.identity\n\n const { data } = await this.endpoint.frontend.POST('/api/tracking/identity/v2', {\n body: {\n customerId,\n sessionId,\n userId,\n url: window.location.href,\n userAgent: window.navigator.userAgent,\n },\n })\n\n if (data) {\n if (!pageviewId) {\n this.identity.pageviewId = data.pageviewId\n }\n if (!sessionId) {\n this.identity.sessionId = data.sessionId\n setSessionId(data.sessionId)\n }\n if (!userId) {\n this.identity.userId = data.userId\n setUserId(data.userId)\n }\n\n setToken(data.token)\n\n Object.values(this.endpoint).forEach((endpoint) => {\n endpoint.use(authMiddleware(data.token))\n })\n }\n }\n\n /**\n * Ends the current conversation by deleting the conversation ID.\n *\n * @example\n * ```ts\n * client.endConversation()\n * console.log('Conversation ended')\n * ```\n */\n endConversation(): void {\n deleteConversationId()\n this.identity.conversationId = undefined\n }\n\n /**\n * Clears the existing conversation ID, then generates a new one and returns the opening message.\n *\n * @param context - Optional context to customize the conversation. It can include:\n * @param context.eligibleProducts An array of eligible product IDs.\n * @param context.eligibleBundles An array of eligible bundle IDs.\n * @param context.productOverrides Overrides for product details.\n * @param context.bundleOverrides Overrides for bundle details.\n *\n * @returns A promise that resolves to the opening message.\n *\n * @example\n * ##### Basic usage\n * ```ts\n * const openingMessage = await client.startConversation()\n * console.log('Opening message:', openingMessage)\n * ```\n *\n * ##### With context\n * ```ts\n * const openingMessage = await client.startConversation({ eligibleProducts: ['product-1', 'product-2'], productOverrides: { 'product-1': { price: 40 } })\n * console.log('Opening message:', openingMessage)\n * ```\n */\n async startConversation(context?: components['schemas']['ConversationContext']): Promise<TextMessage | undefined> {\n this.endConversation()\n\n const conversationContext = {\n ...context,\n }\n\n const { data } = await this.endpoint.conversation.POST(`/api/conversation/v3`, {\n body: {\n type: 'START_CONVERSATION',\n conversationContext,\n },\n })\n\n if (!data) return undefined\n\n const [conversationIdMessage, openingMessage] = data as [ConversationIdMessage, TextMessage]\n\n const conversationId = conversationIdMessage.conversationId\n if (!conversationId) {\n throw new Error('Conversation ID not received')\n }\n\n setConversationId(conversationId)\n this.identity.conversationId = conversationId\n\n return openingMessage\n }\n\n /**\n * Sends a message in the conversation.\n *\n * @param options - An object containing the user message.\n * @returns A promise that resolves to an array of messages\n *\n * @example\n * ```ts\n * const newMessages = await client.sendMessage({\n * userMessage: 'How can I get support?',\n * })\n *\n * if (newMessages) {\n * console.log('Received messages:', newMessages)\n * } else {\n * console.log('No message received')\n * }\n * ```\n */\n async sendMessage({\n userMessage,\n }: {\n userMessage: string\n }): Promise<Exclude<Message, ConversationIdMessage | DebugMessage>[] | undefined> {\n const { data } = await this.endpoint.conversation.POST('/api/conversation/v3', {\n body: {\n conversationId: this.identity.conversationId,\n userMessage,\n type: 'MESSAGE',\n },\n })\n\n if (!data) return undefined\n\n // Log debug messages\n // These will only be in the response when used in internal testing\n const debugMessages = data.filter((message) => message.type === 'DEBUG')\n if (debugMessages.length) {\n console.info('Debug messages:', debugMessages)\n }\n\n // When a request does not contain a conversation ID, the API will return a new conversation ID as the first message\n const conversationId = data.find((message) => message.type === 'CONVERSATION_ID')?.conversationId\n if (conversationId) {\n setConversationId(conversationId)\n this.identity.conversationId = conversationId\n }\n\n const messages = data.filter((message) => message.type !== 'CONVERSATION_ID' && message.type !== 'DEBUG')\n return messages\n }\n\n /**\n * Sends an event to the tracking API, with the required properties already set.\n *\n * @param eventName - The name of the event to track.\n * @param properties - Additional properties to include in the event.\n * @returns A promise that resolves once the event is tracked.\n *\n * @example\n * ```ts\n * await client.trackEvent('entry_point-shown')\n * ```\n */\n async trackEvent(eventName: TrackingEvent['eventName'], properties?: TrackingEvent['additionalProperties']) {\n const body: TrackingEvent = {\n additionalProperties: properties,\n conversationId: this.identity.conversationId,\n eventName,\n pageviewId: this.identity.pageviewId ?? 'unknown',\n screenWidth: window.screen.width,\n screenHeight: window.screen.height,\n screenSize: window.screen.width <= 480 ? 'mobile' : 'large',\n url: window.location.href,\n userAgent: window.navigator.userAgent,\n }\n\n return this.endpoint.frontend.POST('/api/tracking/user/v2', {\n body,\n })\n }\n\n /**\n * Gets an existing identity of the user.\n *\n * @returns An Identity object containing `customerId`, `conversationId`, `sessionId`, `userId`.\n *\n * @example\n * ```ts\n * identity = client.getIdentity()\n * console.log('Identity retrieved:', identity)\n * ```\n */\n getIdentity(): Identity {\n return this.identity\n }\n\n /**\n * Gets the JWT from the localStorage.\n *\n * @returns {string | null} the JWT.\n *\n * @example\n * ```ts\n * token = client.getIdentityToken()\n * console.log('Identity token retrieved:', token)\n * ```\n */\n getIdentityToken(): string | null {\n return getToken()\n }\n}\n","/**\n * The key used to store the conversation ID in `sessionStorage`.\n *\n * @ignore\n */\nexport const CONVERSATION_ID = '__15gifts_conversation_id'\n\n/**\n * Deletes the conversation ID from `sessionStorage`.\n *\n * @example\n * ```ts\n * import { deleteConversationId } from '@15gifts/sdk'\n *\n * deleteConversationId()\n * // The conversation ID will be removed.\n * ```\n */\nexport const deleteConversationId = () => sessionStorage.removeItem(CONVERSATION_ID)\n\n/**\n * Retrieves the conversation ID from `sessionStorage`.\n *\n * @example\n * ```ts\n * import { getConversationId } from '@15gifts/sdk'\n *\n * const conversationId = getConversationId()\n *\n * if (conversationId) {\n * console.log(`Conversation ID: ${conversationId}`)\n * } else {\n * console.log('No conversation ID found.')\n * }\n * ```\n */\nexport const getConversationId = () => sessionStorage.getItem(CONVERSATION_ID)\n\n/**\n * Stores the given conversation ID in `sessionStorage`.\n *\n * @example\n * ```ts\n * import { setConversationId } from '@15gifts/sdk'\n *\n * setConversationId('ca0ab4ce-f697-41cc-8d0c-081762aace9b')\n * // The conversation ID 'ca0ab4ce-f697-41cc-8d0c-081762aace9b' will be stored.\n * ```\n */\nexport const setConversationId = (conversationId: string) => sessionStorage.setItem(CONVERSATION_ID, conversationId)\n","/**\n * The key used to store the session ID in `sessionStorage`.\n *\n * @ignore\n */\nexport const SESSION_ID = '__15gifts_session_id'\n\n/**\n * Retrieves the session ID from `sessionStorage`.\n *\n * @example\n * ```ts\n * import { getSessionId } from '@15gifts/sdk'\n *\n * const sessionId = getSessionId()\n *\n * if (sessionId) {\n * console.log(`Session ID: ${sessionId}`)\n * } else {\n * console.log('No session ID found.')\n * }\n * ```\n */\nexport const getSessionId = () => sessionStorage.getItem(SESSION_ID)\n\n/**\n * Stores the given session ID in `sessionStorage`.\n *\n * @example\n * ```ts\n * import { setSessionId } from '@15gifts/sdk'\n *\n * setSessionId('20b2bff6-64a0-4101-bed9-ff545326584a')\n * // The session ID '20b2bff6-64a0-4101-bed9-ff545326584a' will be stored.\n * ```\n */\nexport const setSessionId = (sessionId: string) => sessionStorage.setItem(SESSION_ID, sessionId)\n","const getItemWithExpiry = (key: string) => {\n const itemString = localStorage.getItem(key)\n\n if (!itemString) return null\n\n const item = JSON.parse(itemString) as { expires: number; value: string }\n\n if (Date.now() > item.expires) {\n localStorage.removeItem(key)\n\n return null\n }\n\n return item.value\n}\n\nexport default getItemWithExpiry\n","/**\n * Set an item in localStorage with an expiration time\n * @param key The key under which the value is stored in localStorage\n * @param value The value to be stored\n * @param ttl The time-to-live (TTL) in milliseconds\n */\nconst setItemWithExpiry = (key: string, value: string, ttl: number) => {\n const item = {\n expires: Date.now() + ttl,\n value,\n }\n\n localStorage.setItem(key, JSON.stringify(item))\n}\n\nexport default setItemWithExpiry\n","import { getItemWithExpiry, setItemWithExpiry } from '../utils'\nconst day = 1000 * 60 * 60 * 24\n\n/**\n * The key used to store the user ID in `localStorage`.\n *\n * @ignore\n */\nexport const USER_ID = '__15gifts_user_id'\n\n/**\n * Time-to-live (TTL) for the user ID in milliseconds.\n * Set to 30 days.\n *\n * @ignore\n */\nexport const TTL = day * 30\n\n/**\n * Retrieves the user ID from `localStorage` and updates its expiry time.\n *\n * @example\n * ```ts\n * import { getUserId } from '@15gifts/sdk'\n *\n * const userId = getUserId()\n *\n * if (userId) {\n * console.log(`User ID: ${userId}`)\n * } else {\n * console.log('No user ID found.')\n * }\n * ```\n */\nexport const getUserId = () => {\n const userId = getItemWithExpiry(USER_ID)\n\n // Update the userId with a new expiry time\n // So that it will be valid for another 30 days, rather than 30 days from when it was first set\n if (userId) {\n setUserId(userId)\n }\n\n return userId\n}\n\n/**\n * Stores the given user ID in `localStorage`.\n *\n * @example\n * ```ts\n * import { setUserId } from '@15gifts/sdk'\n *\n * setUserId('5b77656c-ea4c-492f-82bf-7129297c5873')\n * // The user ID '5b77656c-ea4c-492f-82bf-7129297c5873' will be stored with a 30-day expiry.\n * ```\n */\nexport const setUserId = (userId: string) => setItemWithExpiry(USER_ID, userId, TTL)\n","/**\n * The key used to store the JWT in `localStorage`.\n *\n * @ignore\n */\nexport const JWT_TOKEN = '__15gifts_identity_token'\n\n/**\n * Checks if the JWT is expired.\n *\n * @param {string} token - the JWT.\n * @returns {boolean} `true` if expired, `false` otherwise.\n */\nexport const isTokenExpired = (token: string): boolean => {\n try {\n const [, payloadBase64] = token.split('.')\n if (!payloadBase64) {\n throw new Error('Invalid token payload')\n }\n const payload = JSON.parse(atob(payloadBase64))\n\n return payload.exp && Date.now() / 1000 > payload.exp\n } catch (error) {\n console.error('Invalid token format', error)\n return true\n }\n}\n\n/**\n * Retrieves the JWT from `localStorage` and checks if it is expired.\n *\n * @returns {string | null} The JWT if valid, otherwise `null`.\n */\nexport const getToken = (): string | null => {\n const token = localStorage.getItem(JWT_TOKEN)\n\n if (!token || isTokenExpired(token)) {\n localStorage.removeItem(JWT_TOKEN)\n return null\n }\n\n return token\n}\n\n/**\n * Stores the given JWT in `localStorage`.\n *\n * @example\n * ```ts\n * import { setToken } from '@15gifts/sdk'\n *\n * setToken('ey...')\n * ```\n */\nexport const setToken = (token: string) => localStorage.setItem(JWT_TOKEN, token)\n","import type { Middleware } from 'openapi-fetch'\n\n/**\n * Middleware for adding an `Authorization` header to requests.\n *\n * @param accessToken - The token to be included in the `Authorization` header.\n * @returns A middleware object that attaches the access token to the request headers.\n *\n * @example\n * ```ts\n * import { authMiddleware } from '@15gifts/sdk';\n *\n * this.endpoint.conversation.use(authMiddleware(accessToken))\n * ```\n */\nconst authMiddleware = (accessToken: string): Middleware => ({\n onRequest: async ({ request }) => {\n request.headers.set('Authorization', `Bearer ${accessToken}`)\n\n return request\n },\n})\n\nexport default authMiddleware\n","import type { Middleware } from 'openapi-fetch'\n\n/**\n * Middleware for handling errors.\n *\n * @returns A middleware object that throws an error if the response is not ok.\n *\n * @example\n * ```ts\n * import { errorMiddleware } from '@15gifts/sdk';\n *\n * this.endpoint.conversation.use(errorMiddleware())\n * ```\n */\nconst errorMiddleware: Middleware = {\n // onError does not handle error responses with 4xx or 5xx HTTP status codes, since these are considered \"successful\" responses but with a bad status code.\n // In these cases we need to check the response's status property or ok() method via the onResponse callback.\n onResponse: async ({ response }) => {\n if (!response.ok) {\n const data = await response.json()\n\n throw new Error(data.message)\n }\n\n return response\n },\n}\n\nexport default errorMiddleware\n","import type { Middleware } from 'openapi-fetch'\n\nimport { Identity } from '../types'\n\n/**\n * Middleware for adding request headers that other services use for tracking.\n *\n * @returns A middleware object that throws an error if the response is not ok.\n *\n * @example\n * ```ts\n * import { pageViewId } from '@15gifts/sdk';\n *\n * this.endpoint.conversation.use(headerMiddleware('123', 'https://example.com'))\n * ```\n */\nconst headerMiddleware = (identity: Identity, url: string): Middleware => ({\n onRequest: async ({ request }) => {\n if (identity.pageviewId) {\n request.headers.set('X-PAGEVIEW-ID', identity.pageviewId)\n }\n if (url) {\n request.headers.set('X-PAGE-URL', url)\n }\n\n return request\n },\n})\n\nexport default headerMiddleware\n","{\n \"name\": \"@15gifts/sdk\",\n \"version\": \"0.11.6\",\n \"files\": [\n \"dist\"\n ],\n \"main\": \"./dist/index.js\",\n \"module\": \"./dist/index.mjs\",\n \"types\": \"./dist/index.d.ts\",\n \"scripts\": {\n \"build\": \"npm run generate && tsup\",\n \"coverage\": \"vitest run --coverage\",\n \"dev\": \"tsup --watch\",\n \"format\": \"prettier . --write\",\n \"generate\": \"npx openapi-typescript\",\n \"lint\": \"eslint .\",\n \"test\": \"vitest run\",\n \"test:watch\": \"vitest\",\n \"typecheck\": \"tsc\"\n },\n \"dependencies\": {\n \"openapi-fetch\": \"^0.13.4\"\n },\n \"devDependencies\": {\n \"openapi-typescript\": \"^7.6.0\",\n \"tsup\": \"^8.3.6\"\n },\n \"sideEffects\": false,\n \"prettier\": \"prettier-config-custom\"\n}\n"],"mappings":"AAAA,OAAOA,MAA0C,gBCK1C,IAAMC,EAAkB,4BAalBC,EAAuB,IAAM,eAAe,WAAWD,CAAe,EAkBtEE,EAAoB,IAAM,eAAe,QAAQF,CAAe,EAahEG,EAAqBC,GAA2B,eAAe,QAAQJ,EAAiBI,CAAc,EC5C5G,IAAMC,EAAa,uBAkBbC,EAAe,IAAM,eAAe,QAAQD,CAAU,EAatDE,EAAgBC,GAAsB,eAAe,QAAQH,EAAYG,CAAS,ECpC/F,IAAMC,EAAqBC,GAAgB,CACzC,IAAMC,EAAa,aAAa,QAAQD,CAAG,EAE3C,GAAI,CAACC,EAAY,OAAO,KAExB,IAAMC,EAAO,KAAK,MAAMD,CAAU,EAElC,OAAI,KAAK,IAAI,EAAIC,EAAK,SACpB,aAAa,WAAWF,CAAG,EAEpB,MAGFE,EAAK,KACd,EAEOC,EAAQJ,ECVf,IAAMK,EAAoB,CAACC,EAAaC,EAAeC,IAAgB,CACrE,IAAMC,EAAO,CACX,QAAS,KAAK,IAAI,EAAID,EACtB,MAAAD,CACF,EAEA,aAAa,QAAQD,EAAK,KAAK,UAAUG,CAAI,CAAC,CAChD,EAEOC,EAAQL,ECdf,IAAMM,EAAM,IAAO,GAAK,GAAK,GAOhBC,EAAU,oBAQVC,EAAMF,EAAM,GAkBZG,EAAY,IAAM,CAC7B,IAAMC,EAASC,EAAkBJ,CAAO,EAIxC,OAAIG,GACFE,EAAUF,CAAM,EAGXA,CACT,EAaaE,EAAaF,GAAmBG,EAAkBN,EAASG,EAAQF,CAAG,ECpD5E,IAAMM,EAAY,2BAQZC,EAAkBC,GAA2B,CACxD,GAAI,CACF,GAAM,CAAC,CAAEC,CAAa,EAAID,EAAM,MAAM,GAAG,EACzC,GAAI,CAACC,EACH,MAAM,IAAI,MAAM,uBAAuB,EAEzC,IAAMC,EAAU,KAAK,MAAM,KAAKD,CAAa,CAAC,EAE9C,OAAOC,EAAQ,KAAO,KAAK,IAAI,EAAI,IAAOA,EAAQ,GACpD,OAASC,EAAO,CACd,eAAQ,MAAM,uBAAwBA,CAAK,EACpC,EACT,CACF,EAOaC,EAAW,IAAqB,CAC3C,IAAMJ,EAAQ,aAAa,QAAQF,CAAS,EAE5C,MAAI,CAACE,GAASD,EAAeC,CAAK,GAChC,aAAa,WAAWF,CAAS,EAC1B,MAGFE,CACT,EAYaK,EAAYL,GAAkB,aAAa,QAAQF,EAAWE,CAAK,ECvChF,IAAMM,EAAkBC,IAAqC,CAC3D,UAAW,MAAO,CAAE,QAAAC,CAAQ,KAC1BA,EAAQ,QAAQ,IAAI,gBAAiB,UAAUD,CAAW,EAAE,EAErDC,EAEX,GAEOC,EAAQH,ECTf,IAAMI,EAA8B,CAGlC,WAAY,MAAO,CAAE,SAAAC,CAAS,IAAM,CAClC,GAAI,CAACA,EAAS,GAAI,CAChB,IAAMC,EAAO,MAAMD,EAAS,KAAK,EAEjC,MAAM,IAAI,MAAMC,EAAK,OAAO,CAC9B,CAEA,OAAOD,CACT,CACF,EAEOE,EAAQH,ECZf,IAAMI,EAAmB,CAACC,EAAoBC,KAA6B,CACzE,UAAW,MAAO,CAAE,QAAAC,CAAQ,KACtBF,EAAS,YACXE,EAAQ,QAAQ,IAAI,gBAAiBF,EAAS,UAAU,EAEtDC,GACFC,EAAQ,QAAQ,IAAI,aAAcD,CAAG,EAGhCC,EAEX,GAEOC,EAAQJ,EC3Bb,IAAAK,EAAW,SV6BN,IAAMC,EAAN,KAAa,CAUlB,SAKA,SAYA,YAAYC,EAAgB,CAC1B,GAAM,CAAE,gBAAAC,EAAiB,WAAAC,EAAY,MAAAC,EAAO,YAAAC,EAAa,QAASC,CAAe,EAAIL,EAE/EM,EAAoC,CACxC,GAAGD,EACH,gBAAiBE,CACnB,EAEA,KAAK,SAAW,CACd,aAAcC,EAAgC,CAC5C,QAASP,EACT,MAAAE,EACA,QAAAG,EACA,YAAa,SACf,CAAC,EACD,SAAUE,EAA4B,CAAE,QAASJ,EAAa,MAAAD,EAAO,QAAAG,CAAQ,CAAC,CAChF,EAEA,KAAK,SAAW,CACd,WAAAJ,EACA,eAAgBO,EAAkB,GAAK,OACvC,UAAWC,EAAa,GAAK,OAC7B,OAAQC,EAAU,GAAK,MACzB,EAEA,KAAK,SAAS,aAAa,IAAIC,CAAe,EAC9C,KAAK,SAAS,aAAa,IAAIC,EAAiB,KAAK,SAAU,OAAO,SAAS,IAAI,CAAC,CACtF,CAcA,MAAM,gBAAgC,CACpC,GAAM,CAAE,WAAAX,EAAY,WAAAY,EAAY,UAAAC,EAAW,OAAAC,CAAO,EAAI,KAAK,SAErD,CAAE,KAAAC,CAAK,EAAI,MAAM,KAAK,SAAS,SAAS,KAAK,4BAA6B,CAC9E,KAAM,CACJ,WAAAf,EACA,UAAAa,EACA,OAAAC,EACA,IAAK,OAAO,SAAS,KACrB,UAAW,OAAO,UAAU,SAC9B,CACF,CAAC,EAEGC,IACGH,IACH,KAAK,SAAS,WAAaG,EAAK,YAE7BF,IACH,KAAK,SAAS,UAAYE,EAAK,UAC/BC,EAAaD,EAAK,SAAS,GAExBD,IACH,KAAK,SAAS,OAASC,EAAK,OAC5BE,EAAUF,EAAK,MAAM,GAGvBG,EAASH,EAAK,KAAK,EAEnB,OAAO,OAAO,KAAK,QAAQ,EAAE,QAASI,GAAa,CACjDA,EAAS,IAAIC,EAAeL,EAAK,KAAK,CAAC,CACzC,CAAC,EAEL,CAWA,iBAAwB,CACtBM,EAAqB,EACrB,KAAK,SAAS,eAAiB,MACjC,CA0BA,MAAM,kBAAkBC,EAA0F,CAChH,KAAK,gBAAgB,EAErB,IAAMC,EAAsB,CAC1B,GAAGD,CACL,EAEM,CAAE,KAAAP,CAAK,EAAI,MAAM,KAAK,SAAS,aAAa,KAAK,uBAAwB,CAC7E,KAAM,CACJ,KAAM,qBACN,oBAAAQ,CACF,CACF,CAAC,EAED,GAAI,CAACR,EAAM,OAEX,GAAM,CAACS,EAAuBC,CAAc,EAAIV,EAE1CW,EAAiBF,EAAsB,eAC7C,GAAI,CAACE,EACH,MAAM,IAAI,MAAM,8BAA8B,EAGhD,OAAAC,EAAkBD,CAAc,EAChC,KAAK,SAAS,eAAiBA,EAExBD,CACT,CAqBA,MAAM,YAAY,CAChB,YAAAG,CACF,EAEkF,CAChF,GAAM,CAAE,KAAAb,CAAK,EAAI,MAAM,KAAK,SAAS,aAAa,KAAK,uBAAwB,CAC7E,KAAM,CACJ,eAAgB,KAAK,SAAS,eAC9B,YAAAa,EACA,KAAM,SACR,CACF,CAAC,EAED,GAAI,CAACb,EAAM,OAIX,IAAMc,EAAgBd,EAAK,OAAQe,GAAYA,EAAQ,OAAS,OAAO,EACnED,EAAc,QAChB,QAAQ,KAAK,kBAAmBA,CAAa,EAI/C,IAAMH,EAAiBX,EAAK,KAAMe,GAAYA,EAAQ,OAAS,iBAAiB,GAAG,eACnF,OAAIJ,IACFC,EAAkBD,CAAc,EAChC,KAAK,SAAS,eAAiBA,GAGhBX,EAAK,OAAQe,GAAYA,EAAQ,OAAS,mBAAqBA,EAAQ,OAAS,OAAO,CAE1G,CAcA,MAAM,WAAWC,EAAuCC,EAAoD,CAC1G,IAAMC,EAAsB,CAC1B,qBAAsBD,EACtB,eAAgB,KAAK,SAAS,eAC9B,UAAAD,EACA,WAAY,KAAK,SAAS,YAAc,UACxC,YAAa,OAAO,OAAO,MAC3B,aAAc,OAAO,OAAO,OAC5B,WAAY,OAAO,OAAO,OAAS,IAAM,SAAW,QACpD,IAAK,OAAO,SAAS,KACrB,UAAW,OAAO,UAAU,SAC9B,EAEA,OAAO,KAAK,SAAS,SAAS,KAAK,wBAAyB,CAC1D,KAAAE,CACF,CAAC,CACH,CAaA,aAAwB,CACtB,OAAO,KAAK,QACd,CAaA,kBAAkC,CAChC,OAAOC,EAAS,CAClB,CACF","names":["createClient","CONVERSATION_ID","deleteConversationId","getConversationId","setConversationId","conversationId","SESSION_ID","getSessionId","setSessionId","sessionId","getItemWithExpiry","key","itemString","item","getItemWithExpiry_default","setItemWithExpiry","key","value","ttl","item","setItemWithExpiry_default","day","USER_ID","TTL","getUserId","userId","getItemWithExpiry_default","setUserId","setItemWithExpiry_default","JWT_TOKEN","isTokenExpired","token","payloadBase64","payload","error","getToken","setToken","authMiddleware","accessToken","request","auth_default","errorMiddleware","response","data","error_default","headerMiddleware","identity","url","request","headers_default","version","Client","config","conversationUrl","customerId","fetch","frontendUrl","defaultHeaders","headers","version","createClient","getConversationId","getSessionId","getUserId","error_default","headers_default","pageviewId","sessionId","userId","data","setSessionId","setUserId","setToken","endpoint","auth_default","deleteConversationId","context","conversationContext","conversationIdMessage","openingMessage","conversationId","setConversationId","userMessage","debugMessages","message","eventName","properties","body","getToken"]}
1
+ {"version":3,"sources":["../src/client.ts","../src/identity/conversationId.ts","../src/identity/sessionId.ts","../src/utils/getItemWithExpiry.ts","../src/utils/setItemWithExpiry.ts","../src/identity/userId.ts","../src/identity/token.ts","../src/middlewares/auth.ts","../src/middlewares/error.ts","../src/middlewares/headers.ts","../package.json"],"sourcesContent":["import createClient, { type ClientOptions } from 'openapi-fetch'\n\nimport {\n deleteConversationId,\n getConversationId,\n getSessionId,\n getUserId,\n getToken,\n setConversationId,\n setSessionId,\n setUserId,\n setToken,\n} from './identity'\nimport { authMiddleware, errorMiddleware, headerMiddleware } from './middlewares'\nimport type { components, paths as conversationPaths } from './schemas/conversation'\nimport type { paths as frontendPaths } from './schemas/frontend'\nimport type {\n Config,\n ConversationIdMessage,\n DebugMessage,\n Endpoint,\n Identity,\n Message,\n TextMessage,\n TrackingEvent,\n} from './types'\nimport { version } from '../package.json'\n\n/**\n * The `Client` class provides methods to manage 15gifts API.\n */\nexport class Client {\n /**\n * This can be used to interact with the APIs directly. It is recommended to use the [helper methods](/sdk/sdk-reference/classes/client/#methods) provided by the `Client` class instead.\n *\n * @example\n * ```ts\n * const client = new Client({ customerId: 'YOUR_CUSTOMER_ID' })\n * const { data } = await client.endpoint.conversation.POST('/api/conversation/v3')\n * ```\n */\n endpoint: Endpoint\n\n /**\n * The identity information.\n */\n identity: Identity\n\n /**\n * Creates a new instance of the `Client` class.\n *\n * @param config - Configuration options for initializing the client.\n *\n * @example\n * ```ts\n * const client = new Client({ customerId: 'YOUR_CUSTOMER_ID' })\n * ```\n */\n constructor(config: Config) {\n const { conversationUrl, customerId, fetch, frontendUrl, headers: defaultHeaders } = config\n\n const headers: ClientOptions['headers'] = {\n ...defaultHeaders,\n 'X-SDK-VERSION': version,\n }\n\n this.endpoint = {\n conversation: createClient<conversationPaths>({\n baseUrl: conversationUrl,\n fetch,\n headers,\n credentials: 'include',\n }),\n frontend: createClient<frontendPaths>({ baseUrl: frontendUrl, fetch, headers }),\n }\n\n this.identity = {\n customerId,\n conversationId: getConversationId() ?? undefined,\n sessionId: getSessionId() ?? undefined,\n userId: getUserId() ?? undefined,\n }\n\n this.endpoint.conversation.use(errorMiddleware)\n this.endpoint.conversation.use(headerMiddleware(this.identity, window.location.href))\n }\n\n /**\n * Creates a new identity for the user by generating a session ID and user ID if they don't exist, and sets the access token for future API calls.\n * Ends the current conversation if a conversation ID is present before sending a request to update identity.\n *\n * @returns A promise that resolves once the identity is created and the access token is set.\n *\n * @example\n * ```ts\n * await client.createIdentity()\n * console.log('Identity created:', client.identity)\n * ```\n */\n async createIdentity(): Promise<void> {\n const { customerId, pageviewId, sessionId, userId } = this.identity\n\n const { data } = await this.endpoint.frontend.POST('/api/tracking/identity/v2', {\n body: {\n customerId,\n sessionId,\n userId,\n url: window.location.href,\n userAgent: window.navigator.userAgent,\n },\n })\n\n if (data) {\n if (!pageviewId) {\n this.identity.pageviewId = data.pageviewId\n }\n if (!sessionId) {\n this.identity.sessionId = data.sessionId\n setSessionId(data.sessionId)\n }\n if (!userId) {\n this.identity.userId = data.userId\n setUserId(data.userId)\n }\n\n setToken(data.token)\n\n Object.values(this.endpoint).forEach((endpoint) => {\n endpoint.use(authMiddleware(data.token))\n })\n }\n }\n\n /**\n * Ends the current conversation by deleting the conversation ID.\n *\n * @example\n * ```ts\n * client.endConversation()\n * console.log('Conversation ended')\n * ```\n */\n endConversation(): void {\n deleteConversationId()\n this.identity.conversationId = undefined\n }\n\n /**\n * Clears the existing conversation ID, then generates a new one and returns the opening message.\n *\n * @param context - Optional context to customize the conversation. It can include:\n * @param context.eligibleProducts An array of eligible product IDs.\n * @param context.eligibleBundles An array of eligible bundle IDs.\n * @param context.productOverrides Overrides for product details.\n * @param context.bundleOverrides Overrides for bundle details.\n *\n * @returns A promise that resolves to the opening message.\n *\n * @example\n * ##### Basic usage\n * ```ts\n * const openingMessage = await client.startConversation()\n * console.log('Opening message:', openingMessage)\n * ```\n *\n * ##### With context\n * ```ts\n * const openingMessage = await client.startConversation({ eligibleProducts: ['product-1', 'product-2'], productOverrides: { 'product-1': { price: 40 } })\n * console.log('Opening message:', openingMessage)\n * ```\n */\n async startConversation(context?: components['schemas']['ConversationContext']): Promise<TextMessage | undefined> {\n this.endConversation()\n\n const conversationContext = {\n ...context,\n }\n\n const { data } = await this.endpoint.conversation.POST(`/api/conversation/v3`, {\n body: {\n type: 'START_CONVERSATION',\n conversationContext,\n },\n })\n\n if (!data) return undefined\n\n const [conversationIdMessage, openingMessage] = data as [ConversationIdMessage, TextMessage]\n\n const conversationId = conversationIdMessage.conversationId\n if (!conversationId) {\n throw new Error('Conversation ID not received')\n }\n\n setConversationId(conversationId)\n this.identity.conversationId = conversationId\n\n return openingMessage\n }\n\n /**\n * Sends a message in the conversation.\n *\n * @param options - An object containing the user message.\n * @returns A promise that resolves to an array of messages\n *\n * @example\n * ```ts\n * const newMessages = await client.sendMessage({\n * userMessage: 'How can I get support?',\n * })\n *\n * if (newMessages) {\n * console.log('Received messages:', newMessages)\n * } else {\n * console.log('No message received')\n * }\n * ```\n */\n async sendMessage({\n userMessage,\n }: {\n userMessage: string\n }): Promise<Exclude<Message, ConversationIdMessage | DebugMessage>[] | undefined> {\n const { data } = await this.endpoint.conversation.POST('/api/conversation/v3', {\n body: {\n conversationId: this.identity.conversationId,\n userMessage,\n type: 'MESSAGE',\n },\n })\n\n if (!data) return undefined\n\n // Log debug messages\n // These will only be in the response when used in internal testing\n const debugMessages = data.filter((message) => message.type === 'DEBUG')\n if (debugMessages.length) {\n console.info('Debug messages:', debugMessages)\n }\n\n // When a request does not contain a conversation ID, the API will return a new conversation ID as the first message\n const conversationId = data.find((message) => message.type === 'CONVERSATION_ID')?.conversationId\n if (conversationId) {\n setConversationId(conversationId)\n this.identity.conversationId = conversationId\n }\n\n const messages = data.filter((message) => message.type !== 'CONVERSATION_ID' && message.type !== 'DEBUG')\n return messages\n }\n\n /**\n * Sends an event to the tracking API, with the required properties already set.\n *\n * @param eventName - The name of the event to track.\n * @param properties - Additional properties to include in the event.\n * @returns A promise that resolves once the event is tracked.\n *\n * @example\n * ```ts\n * await client.trackEvent('entry_point-shown')\n * ```\n */\n async trackEvent(eventName: TrackingEvent['eventName'], properties?: TrackingEvent['additionalProperties']) {\n const body: TrackingEvent = {\n additionalProperties: properties,\n conversationId: this.identity.conversationId,\n eventName,\n pageviewId: this.identity.pageviewId ?? 'unknown',\n screenWidth: window.screen.width,\n screenHeight: window.screen.height,\n screenSize: window.screen.width <= 480 ? 'mobile' : 'large',\n url: window.location.href,\n userAgent: window.navigator.userAgent,\n }\n\n return this.endpoint.frontend.POST('/api/tracking/user/v2', {\n body,\n })\n }\n\n /**\n * Gets an existing identity of the user.\n *\n * @returns An Identity object containing `customerId`, `conversationId`, `sessionId`, `userId`.\n *\n * @example\n * ```ts\n * identity = client.getIdentity()\n * console.log('Identity retrieved:', identity)\n * ```\n */\n getIdentity(): Identity {\n return this.identity\n }\n\n /**\n * Gets the JWT from the localStorage.\n *\n * @returns {string | null} the JWT.\n *\n * @example\n * ```ts\n * token = client.getIdentityToken()\n * console.log('Identity token retrieved:', token)\n * ```\n */\n getIdentityToken(): string | null {\n return getToken()\n }\n}\n","/**\n * The key used to store the conversation ID in `sessionStorage`.\n *\n * @ignore\n */\nexport const CONVERSATION_ID = '__15gifts_conversation_id'\n\n/**\n * Deletes the conversation ID from `sessionStorage`.\n *\n * @example\n * ```ts\n * import { deleteConversationId } from '@15gifts/sdk'\n *\n * deleteConversationId()\n * // The conversation ID will be removed.\n * ```\n */\nexport const deleteConversationId = () => sessionStorage.removeItem(CONVERSATION_ID)\n\n/**\n * Retrieves the conversation ID from `sessionStorage`.\n *\n * @example\n * ```ts\n * import { getConversationId } from '@15gifts/sdk'\n *\n * const conversationId = getConversationId()\n *\n * if (conversationId) {\n * console.log(`Conversation ID: ${conversationId}`)\n * } else {\n * console.log('No conversation ID found.')\n * }\n * ```\n */\nexport const getConversationId = () => sessionStorage.getItem(CONVERSATION_ID)\n\n/**\n * Stores the given conversation ID in `sessionStorage`.\n *\n * @example\n * ```ts\n * import { setConversationId } from '@15gifts/sdk'\n *\n * setConversationId('ca0ab4ce-f697-41cc-8d0c-081762aace9b')\n * // The conversation ID 'ca0ab4ce-f697-41cc-8d0c-081762aace9b' will be stored.\n * ```\n */\nexport const setConversationId = (conversationId: string) => sessionStorage.setItem(CONVERSATION_ID, conversationId)\n","/**\n * The key used to store the session ID in `sessionStorage`.\n *\n * @ignore\n */\nexport const SESSION_ID = '__15gifts_session_id'\n\n/**\n * Retrieves the session ID from `sessionStorage`.\n *\n * @example\n * ```ts\n * import { getSessionId } from '@15gifts/sdk'\n *\n * const sessionId = getSessionId()\n *\n * if (sessionId) {\n * console.log(`Session ID: ${sessionId}`)\n * } else {\n * console.log('No session ID found.')\n * }\n * ```\n */\nexport const getSessionId = () => sessionStorage.getItem(SESSION_ID)\n\n/**\n * Stores the given session ID in `sessionStorage`.\n *\n * @example\n * ```ts\n * import { setSessionId } from '@15gifts/sdk'\n *\n * setSessionId('20b2bff6-64a0-4101-bed9-ff545326584a')\n * // The session ID '20b2bff6-64a0-4101-bed9-ff545326584a' will be stored.\n * ```\n */\nexport const setSessionId = (sessionId: string) => sessionStorage.setItem(SESSION_ID, sessionId)\n","const getItemWithExpiry = (key: string) => {\n const itemString = localStorage.getItem(key)\n\n if (!itemString) return null\n\n const item = JSON.parse(itemString) as { expires: number; value: string }\n\n if (Date.now() > item.expires) {\n localStorage.removeItem(key)\n\n return null\n }\n\n return item.value\n}\n\nexport default getItemWithExpiry\n","/**\n * Set an item in localStorage with an expiration time\n * @param key The key under which the value is stored in localStorage\n * @param value The value to be stored\n * @param ttl The time-to-live (TTL) in milliseconds\n */\nconst setItemWithExpiry = (key: string, value: string, ttl: number) => {\n const item = {\n expires: Date.now() + ttl,\n value,\n }\n\n localStorage.setItem(key, JSON.stringify(item))\n}\n\nexport default setItemWithExpiry\n","import { getItemWithExpiry, setItemWithExpiry } from '../utils'\nconst day = 1000 * 60 * 60 * 24\n\n/**\n * The key used to store the user ID in `localStorage`.\n *\n * @ignore\n */\nexport const USER_ID = '__15gifts_user_id'\n\n/**\n * Time-to-live (TTL) for the user ID in milliseconds.\n * Set to 30 days.\n *\n * @ignore\n */\nexport const TTL = day * 30\n\n/**\n * Retrieves the user ID from `localStorage` and updates its expiry time.\n *\n * @example\n * ```ts\n * import { getUserId } from '@15gifts/sdk'\n *\n * const userId = getUserId()\n *\n * if (userId) {\n * console.log(`User ID: ${userId}`)\n * } else {\n * console.log('No user ID found.')\n * }\n * ```\n */\nexport const getUserId = () => {\n const userId = getItemWithExpiry(USER_ID)\n\n // Update the userId with a new expiry time\n // So that it will be valid for another 30 days, rather than 30 days from when it was first set\n if (userId) {\n setUserId(userId)\n }\n\n return userId\n}\n\n/**\n * Stores the given user ID in `localStorage`.\n *\n * @example\n * ```ts\n * import { setUserId } from '@15gifts/sdk'\n *\n * setUserId('5b77656c-ea4c-492f-82bf-7129297c5873')\n * // The user ID '5b77656c-ea4c-492f-82bf-7129297c5873' will be stored with a 30-day expiry.\n * ```\n */\nexport const setUserId = (userId: string) => setItemWithExpiry(USER_ID, userId, TTL)\n","/**\n * The key used to store the JWT in `localStorage`.\n *\n * @ignore\n */\nexport const JWT_TOKEN = '__15gifts_identity_token'\n\n/**\n * Checks if the JWT is expired.\n *\n * @param {string} token - the JWT.\n * @returns {boolean} `true` if expired, `false` otherwise.\n */\nexport const isTokenExpired = (token: string): boolean => {\n try {\n const [, payloadBase64] = token.split('.')\n if (!payloadBase64) {\n throw new Error('Invalid token payload')\n }\n const payload = JSON.parse(atob(payloadBase64))\n\n return payload.exp && Date.now() / 1000 > payload.exp\n } catch (error) {\n console.error('Invalid token format', error)\n return true\n }\n}\n\n/**\n * Retrieves the JWT from `localStorage` and checks if it is expired.\n *\n * @returns {string | null} The JWT if valid, otherwise `null`.\n */\nexport const getToken = (): string | null => {\n const token = localStorage.getItem(JWT_TOKEN)\n\n if (!token || isTokenExpired(token)) {\n localStorage.removeItem(JWT_TOKEN)\n return null\n }\n\n return token\n}\n\n/**\n * Stores the given JWT in `localStorage`.\n *\n * @example\n * ```ts\n * import { setToken } from '@15gifts/sdk'\n *\n * setToken('ey...')\n * ```\n */\nexport const setToken = (token: string) => localStorage.setItem(JWT_TOKEN, token)\n","import type { Middleware } from 'openapi-fetch'\n\n/**\n * Middleware for adding an `Authorization` header to requests.\n *\n * @param accessToken - The token to be included in the `Authorization` header.\n * @returns A middleware object that attaches the access token to the request headers.\n *\n * @example\n * ```ts\n * import { authMiddleware } from '@15gifts/sdk';\n *\n * this.endpoint.conversation.use(authMiddleware(accessToken))\n * ```\n */\nconst authMiddleware = (accessToken: string): Middleware => ({\n onRequest: async ({ request }) => {\n request.headers.set('Authorization', `Bearer ${accessToken}`)\n\n return request\n },\n})\n\nexport default authMiddleware\n","import type { Middleware } from 'openapi-fetch'\n\n/**\n * Middleware for handling errors.\n *\n * @returns A middleware object that throws an error if the response is not ok.\n *\n * @example\n * ```ts\n * import { errorMiddleware } from '@15gifts/sdk';\n *\n * this.endpoint.conversation.use(errorMiddleware())\n * ```\n */\nconst errorMiddleware: Middleware = {\n // onError does not handle error responses with 4xx or 5xx HTTP status codes, since these are considered \"successful\" responses but with a bad status code.\n // In these cases we need to check the response's status property or ok() method via the onResponse callback.\n onResponse: async ({ response }) => {\n if (!response.ok) {\n const data = await response.json()\n\n throw new Error(data.message)\n }\n\n return response\n },\n}\n\nexport default errorMiddleware\n","import type { Middleware } from 'openapi-fetch'\n\nimport { Identity } from '../types'\n\n/**\n * Middleware for adding request headers that other services use for tracking.\n *\n * @returns A middleware object that throws an error if the response is not ok.\n *\n * @example\n * ```ts\n * import { pageViewId } from '@15gifts/sdk';\n *\n * this.endpoint.conversation.use(headerMiddleware('123', 'https://example.com'))\n * ```\n */\nconst headerMiddleware = (identity: Identity, url: string): Middleware => ({\n onRequest: async ({ request }) => {\n if (identity.pageviewId) {\n request.headers.set('X-PAGEVIEW-ID', identity.pageviewId)\n }\n if (url) {\n request.headers.set('X-PAGE-URL', url)\n }\n\n return request\n },\n})\n\nexport default headerMiddleware\n","{\n \"name\": \"@15gifts/sdk\",\n \"version\": \"0.11.8\",\n \"files\": [\n \"dist\"\n ],\n \"main\": \"./dist/index.js\",\n \"module\": \"./dist/index.mjs\",\n \"types\": \"./dist/index.d.ts\",\n \"scripts\": {\n \"build\": \"npm run generate && tsup\",\n \"coverage\": \"vitest run --coverage\",\n \"dev\": \"tsup --watch\",\n \"format\": \"prettier . --write\",\n \"generate\": \"npx openapi-typescript\",\n \"lint\": \"eslint .\",\n \"test\": \"vitest run\",\n \"test:watch\": \"vitest\",\n \"typecheck\": \"tsc\"\n },\n \"dependencies\": {\n \"openapi-fetch\": \"^0.13.4\"\n },\n \"devDependencies\": {\n \"openapi-typescript\": \"^7.6.0\",\n \"tsup\": \"^8.3.6\"\n },\n \"sideEffects\": false,\n \"prettier\": \"prettier-config-custom\"\n}\n"],"mappings":"AAAA,OAAOA,MAA0C,gBCK1C,IAAMC,EAAkB,4BAalBC,EAAuB,IAAM,eAAe,WAAWD,CAAe,EAkBtEE,EAAoB,IAAM,eAAe,QAAQF,CAAe,EAahEG,EAAqBC,GAA2B,eAAe,QAAQJ,EAAiBI,CAAc,EC5C5G,IAAMC,EAAa,uBAkBbC,EAAe,IAAM,eAAe,QAAQD,CAAU,EAatDE,EAAgBC,GAAsB,eAAe,QAAQH,EAAYG,CAAS,ECpC/F,IAAMC,EAAqBC,GAAgB,CACzC,IAAMC,EAAa,aAAa,QAAQD,CAAG,EAE3C,GAAI,CAACC,EAAY,OAAO,KAExB,IAAMC,EAAO,KAAK,MAAMD,CAAU,EAElC,OAAI,KAAK,IAAI,EAAIC,EAAK,SACpB,aAAa,WAAWF,CAAG,EAEpB,MAGFE,EAAK,KACd,EAEOC,EAAQJ,ECVf,IAAMK,EAAoB,CAACC,EAAaC,EAAeC,IAAgB,CACrE,IAAMC,EAAO,CACX,QAAS,KAAK,IAAI,EAAID,EACtB,MAAAD,CACF,EAEA,aAAa,QAAQD,EAAK,KAAK,UAAUG,CAAI,CAAC,CAChD,EAEOC,EAAQL,ECdf,IAAMM,EAAM,IAAO,GAAK,GAAK,GAOhBC,EAAU,oBAQVC,EAAMF,EAAM,GAkBZG,EAAY,IAAM,CAC7B,IAAMC,EAASC,EAAkBJ,CAAO,EAIxC,OAAIG,GACFE,EAAUF,CAAM,EAGXA,CACT,EAaaE,EAAaF,GAAmBG,EAAkBN,EAASG,EAAQF,CAAG,ECpD5E,IAAMM,EAAY,2BAQZC,EAAkBC,GAA2B,CACxD,GAAI,CACF,GAAM,CAAC,CAAEC,CAAa,EAAID,EAAM,MAAM,GAAG,EACzC,GAAI,CAACC,EACH,MAAM,IAAI,MAAM,uBAAuB,EAEzC,IAAMC,EAAU,KAAK,MAAM,KAAKD,CAAa,CAAC,EAE9C,OAAOC,EAAQ,KAAO,KAAK,IAAI,EAAI,IAAOA,EAAQ,GACpD,OAASC,EAAO,CACd,eAAQ,MAAM,uBAAwBA,CAAK,EACpC,EACT,CACF,EAOaC,EAAW,IAAqB,CAC3C,IAAMJ,EAAQ,aAAa,QAAQF,CAAS,EAE5C,MAAI,CAACE,GAASD,EAAeC,CAAK,GAChC,aAAa,WAAWF,CAAS,EAC1B,MAGFE,CACT,EAYaK,EAAYL,GAAkB,aAAa,QAAQF,EAAWE,CAAK,ECvChF,IAAMM,EAAkBC,IAAqC,CAC3D,UAAW,MAAO,CAAE,QAAAC,CAAQ,KAC1BA,EAAQ,QAAQ,IAAI,gBAAiB,UAAUD,CAAW,EAAE,EAErDC,EAEX,GAEOC,EAAQH,ECTf,IAAMI,EAA8B,CAGlC,WAAY,MAAO,CAAE,SAAAC,CAAS,IAAM,CAClC,GAAI,CAACA,EAAS,GAAI,CAChB,IAAMC,EAAO,MAAMD,EAAS,KAAK,EAEjC,MAAM,IAAI,MAAMC,EAAK,OAAO,CAC9B,CAEA,OAAOD,CACT,CACF,EAEOE,EAAQH,ECZf,IAAMI,EAAmB,CAACC,EAAoBC,KAA6B,CACzE,UAAW,MAAO,CAAE,QAAAC,CAAQ,KACtBF,EAAS,YACXE,EAAQ,QAAQ,IAAI,gBAAiBF,EAAS,UAAU,EAEtDC,GACFC,EAAQ,QAAQ,IAAI,aAAcD,CAAG,EAGhCC,EAEX,GAEOC,EAAQJ,EC3Bb,IAAAK,EAAW,SV6BN,IAAMC,EAAN,KAAa,CAUlB,SAKA,SAYA,YAAYC,EAAgB,CAC1B,GAAM,CAAE,gBAAAC,EAAiB,WAAAC,EAAY,MAAAC,EAAO,YAAAC,EAAa,QAASC,CAAe,EAAIL,EAE/EM,EAAoC,CACxC,GAAGD,EACH,gBAAiBE,CACnB,EAEA,KAAK,SAAW,CACd,aAAcC,EAAgC,CAC5C,QAASP,EACT,MAAAE,EACA,QAAAG,EACA,YAAa,SACf,CAAC,EACD,SAAUE,EAA4B,CAAE,QAASJ,EAAa,MAAAD,EAAO,QAAAG,CAAQ,CAAC,CAChF,EAEA,KAAK,SAAW,CACd,WAAAJ,EACA,eAAgBO,EAAkB,GAAK,OACvC,UAAWC,EAAa,GAAK,OAC7B,OAAQC,EAAU,GAAK,MACzB,EAEA,KAAK,SAAS,aAAa,IAAIC,CAAe,EAC9C,KAAK,SAAS,aAAa,IAAIC,EAAiB,KAAK,SAAU,OAAO,SAAS,IAAI,CAAC,CACtF,CAcA,MAAM,gBAAgC,CACpC,GAAM,CAAE,WAAAX,EAAY,WAAAY,EAAY,UAAAC,EAAW,OAAAC,CAAO,EAAI,KAAK,SAErD,CAAE,KAAAC,CAAK,EAAI,MAAM,KAAK,SAAS,SAAS,KAAK,4BAA6B,CAC9E,KAAM,CACJ,WAAAf,EACA,UAAAa,EACA,OAAAC,EACA,IAAK,OAAO,SAAS,KACrB,UAAW,OAAO,UAAU,SAC9B,CACF,CAAC,EAEGC,IACGH,IACH,KAAK,SAAS,WAAaG,EAAK,YAE7BF,IACH,KAAK,SAAS,UAAYE,EAAK,UAC/BC,EAAaD,EAAK,SAAS,GAExBD,IACH,KAAK,SAAS,OAASC,EAAK,OAC5BE,EAAUF,EAAK,MAAM,GAGvBG,EAASH,EAAK,KAAK,EAEnB,OAAO,OAAO,KAAK,QAAQ,EAAE,QAASI,GAAa,CACjDA,EAAS,IAAIC,EAAeL,EAAK,KAAK,CAAC,CACzC,CAAC,EAEL,CAWA,iBAAwB,CACtBM,EAAqB,EACrB,KAAK,SAAS,eAAiB,MACjC,CA0BA,MAAM,kBAAkBC,EAA0F,CAChH,KAAK,gBAAgB,EAErB,IAAMC,EAAsB,CAC1B,GAAGD,CACL,EAEM,CAAE,KAAAP,CAAK,EAAI,MAAM,KAAK,SAAS,aAAa,KAAK,uBAAwB,CAC7E,KAAM,CACJ,KAAM,qBACN,oBAAAQ,CACF,CACF,CAAC,EAED,GAAI,CAACR,EAAM,OAEX,GAAM,CAACS,EAAuBC,CAAc,EAAIV,EAE1CW,EAAiBF,EAAsB,eAC7C,GAAI,CAACE,EACH,MAAM,IAAI,MAAM,8BAA8B,EAGhD,OAAAC,EAAkBD,CAAc,EAChC,KAAK,SAAS,eAAiBA,EAExBD,CACT,CAqBA,MAAM,YAAY,CAChB,YAAAG,CACF,EAEkF,CAChF,GAAM,CAAE,KAAAb,CAAK,EAAI,MAAM,KAAK,SAAS,aAAa,KAAK,uBAAwB,CAC7E,KAAM,CACJ,eAAgB,KAAK,SAAS,eAC9B,YAAAa,EACA,KAAM,SACR,CACF,CAAC,EAED,GAAI,CAACb,EAAM,OAIX,IAAMc,EAAgBd,EAAK,OAAQe,GAAYA,EAAQ,OAAS,OAAO,EACnED,EAAc,QAChB,QAAQ,KAAK,kBAAmBA,CAAa,EAI/C,IAAMH,EAAiBX,EAAK,KAAMe,GAAYA,EAAQ,OAAS,iBAAiB,GAAG,eACnF,OAAIJ,IACFC,EAAkBD,CAAc,EAChC,KAAK,SAAS,eAAiBA,GAGhBX,EAAK,OAAQe,GAAYA,EAAQ,OAAS,mBAAqBA,EAAQ,OAAS,OAAO,CAE1G,CAcA,MAAM,WAAWC,EAAuCC,EAAoD,CAC1G,IAAMC,EAAsB,CAC1B,qBAAsBD,EACtB,eAAgB,KAAK,SAAS,eAC9B,UAAAD,EACA,WAAY,KAAK,SAAS,YAAc,UACxC,YAAa,OAAO,OAAO,MAC3B,aAAc,OAAO,OAAO,OAC5B,WAAY,OAAO,OAAO,OAAS,IAAM,SAAW,QACpD,IAAK,OAAO,SAAS,KACrB,UAAW,OAAO,UAAU,SAC9B,EAEA,OAAO,KAAK,SAAS,SAAS,KAAK,wBAAyB,CAC1D,KAAAE,CACF,CAAC,CACH,CAaA,aAAwB,CACtB,OAAO,KAAK,QACd,CAaA,kBAAkC,CAChC,OAAOC,EAAS,CAClB,CACF","names":["createClient","CONVERSATION_ID","deleteConversationId","getConversationId","setConversationId","conversationId","SESSION_ID","getSessionId","setSessionId","sessionId","getItemWithExpiry","key","itemString","item","getItemWithExpiry_default","setItemWithExpiry","key","value","ttl","item","setItemWithExpiry_default","day","USER_ID","TTL","getUserId","userId","getItemWithExpiry_default","setUserId","setItemWithExpiry_default","JWT_TOKEN","isTokenExpired","token","payloadBase64","payload","error","getToken","setToken","authMiddleware","accessToken","request","auth_default","errorMiddleware","response","data","error_default","headerMiddleware","identity","url","request","headers_default","version","Client","config","conversationUrl","customerId","fetch","frontendUrl","defaultHeaders","headers","version","createClient","getConversationId","getSessionId","getUserId","error_default","headers_default","pageviewId","sessionId","userId","data","setSessionId","setUserId","setToken","endpoint","auth_default","deleteConversationId","context","conversationContext","conversationIdMessage","openingMessage","conversationId","setConversationId","userMessage","debugMessages","message","eventName","properties","body","getToken"]}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@15gifts/sdk",
3
- "version": "0.11.6",
3
+ "version": "0.11.8",
4
4
  "files": [
5
5
  "dist"
6
6
  ],