@algolia/client-insights 5.0.0-alpha.99 → 5.0.0-beta.10

package/model/viewedFilters.ts

@@ -7,34 +7,34 @@ import type { ViewEvent } from './viewEvent';
  */
 export type ViewedFilters = {
   /**
-   * The name of the event, up to 64 ASCII characters.  Consider naming events consistently—for example, by adopting Segment\'s [object-action](https://segment.com/academy/collecting-data/naming-conventions-for-clean-data/#the-object-action-framework) framework.
+   * Event name, up to 64 ASCII characters.  Consider naming events consistently—for example, by adopting Segment\'s [object-action](https://segment.com/academy/collecting-data/naming-conventions-for-clean-data/#the-object-action-framework) framework.
    */
   eventName: string;
 
   eventType: ViewEvent;
 
   /**
-   * The name of an Algolia index.
+   * Index name (case-sensitive) to which the event\'s items belong.
    */
   index: string;
 
   /**
-   * Facet filters.  Each facet filter string must be URL-encoded, such as, `discount:10%25`.
+   * Applied facet filters.  Facet filters are `facet:value` pairs. Facet values must be URL-encoded, such as, `discount:10%25`.
    */
   filters: string[];
 
   /**
-   * An anonymous or pseudonymous user identifier.  > **Note**: Never include personally identifiable information in user tokens.
+   * Anonymous or pseudonymous user identifier.  Don\'t use personally identifiable information in user tokens. For more information, see [User token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken/).
    */
   userToken: string;
 
   /**
-   * An identifier for authenticated users.  > **Note**: Never include personally identifiable information in user tokens.
+   * Identifier for authenticated users.  When the user signs in, you can get an identifier from your system and send it as `authenticatedUserToken`. This lets you keep using the `userToken` from before the user signed in, while providing a reliable way to identify users across sessions. Don\'t use personally identifiable information in user tokens. For more information, see [User token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken/).
    */
   authenticatedUserToken?: string;
 
   /**
-   * The timestamp of the event in milliseconds in [Unix epoch time](https://wikipedia.org/wiki/Unix_time). By default, the Insights API uses the time it receives an event as its timestamp.
+   * Timestamp of the event, measured in milliseconds since the Unix epoch. By default, the Insights API uses the time it receives an event as its timestamp.
    */
   timestamp?: number;
 };

package/model/viewedObjectIDs.ts

@@ -7,34 +7,34 @@ import type { ViewEvent } from './viewEvent';
  */
 export type ViewedObjectIDs = {
   /**
-   * The name of the event, up to 64 ASCII characters.  Consider naming events consistently—for example, by adopting Segment\'s [object-action](https://segment.com/academy/collecting-data/naming-conventions-for-clean-data/#the-object-action-framework) framework.
+   * Event name, up to 64 ASCII characters.  Consider naming events consistently—for example, by adopting Segment\'s [object-action](https://segment.com/academy/collecting-data/naming-conventions-for-clean-data/#the-object-action-framework) framework.
    */
   eventName: string;
 
   eventType: ViewEvent;
 
   /**
-   * The name of an Algolia index.
+   * Index name (case-sensitive) to which the event\'s items belong.
    */
   index: string;
 
   /**
-   * The object IDs of the records that are part of the event.
+   * Object IDs of the records that are part of the event.
    */
   objectIDs: string[];
 
   /**
-   * An anonymous or pseudonymous user identifier.  > **Note**: Never include personally identifiable information in user tokens.
+   * Anonymous or pseudonymous user identifier.  Don\'t use personally identifiable information in user tokens. For more information, see [User token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken/).
    */
   userToken: string;
 
   /**
-   * An identifier for authenticated users.  > **Note**: Never include personally identifiable information in user tokens.
+   * Identifier for authenticated users.  When the user signs in, you can get an identifier from your system and send it as `authenticatedUserToken`. This lets you keep using the `userToken` from before the user signed in, while providing a reliable way to identify users across sessions. Don\'t use personally identifiable information in user tokens. For more information, see [User token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken/).
    */
   authenticatedUserToken?: string;
 
   /**
-   * The timestamp of the event in milliseconds in [Unix epoch time](https://wikipedia.org/wiki/Unix_time). By default, the Insights API uses the time it receives an event as its timestamp.
+   * Timestamp of the event, measured in milliseconds since the Unix epoch. By default, the Insights API uses the time it receives an event as its timestamp.
    */
   timestamp?: number;
 };

package/package.json

@@ -1,8 +1,11 @@
 {
   "name": "@algolia/client-insights",
-  "version": "5.0.0-alpha.99",
+  "version": "5.0.0-beta.10",
   "description": "JavaScript client for client-insights",
-  "repository": "algolia/algoliasearch-client-javascript",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/algolia/algoliasearch-client-javascript.git"
+  },
   "license": "MIT",
   "author": "Algolia",
   "type": "module",
@@ -39,14 +42,14 @@
     "clean": "rm -rf ./dist || true"
   },
   "dependencies": {
-    "@algolia/client-common": "5.0.0-alpha.100",
-    "@algolia/requester-browser-xhr": "5.0.0-alpha.100",
-    "@algolia/requester-node-http": "5.0.0-alpha.100"
+    "@algolia/client-common": "5.0.0-beta.11",
+    "@algolia/requester-browser-xhr": "5.0.0-beta.11",
+    "@algolia/requester-node-http": "5.0.0-beta.11"
   },
   "devDependencies": {
-    "@types/node": "20.11.0",
-    "rollup": "4.9.6",
-    "typescript": "5.3.3"
+    "@types/node": "20.14.10",
+    "rollup": "4.18.0",
+    "typescript": "5.5.3"
   },
   "engines": {
     "node": ">= 14.0.0"