@algolia/client-insights 5.0.0-alpha.72 → 5.0.0-alpha.75

package/model/index.ts

@@ -1,8 +1,18 @@
 // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
+export * from './clickEvent';
+export * from './clickedFilters';
+export * from './clickedObjectIDs';
+export * from './clickedObjectIDsAfterSearch';
+export * from './conversionEvent';
+export * from './convertedFilters';
+export * from './convertedObjectIDs';
+export * from './convertedObjectIDsAfterSearch';
 export * from './errorBase';
-export * from './eventType';
-export * from './insightEvent';
-export * from './insightEvents';
-export * from './pushEventsResponse';
+export * from './eventsItems';
+export * from './eventsResponse';
+export * from './insightsEvents';
+export * from './viewEvent';
+export * from './viewedFilters';
+export * from './viewedObjectIDs';
 export * from './clientMethodProps';

package/model/insightsEvents.ts

@@ -0,0 +1,10 @@
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
+
+import type { EventsItems } from './eventsItems';
+
+export type InsightsEvents = {
+  /**
+   * List of click and conversion events.  An event is an object representing a user interaction. Events have attributes that describe the interaction, such as an event name, a type, or a user token. Some attributes require other attributes to be declared, and some attributes can\'t be declared at the same time.  **All** events must be valid, otherwise the API returns an error.
+   */
+  events: EventsItems[];
+};

package/model/viewEvent.ts

@@ -0,0 +1,3 @@
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
+
+export type ViewEvent = 'view';

package/model/viewedFilters.ts

@@ -0,0 +1,35 @@
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
+
+import type { ViewEvent } from './viewEvent';
+
+/**
+ * Use this method to capture active filters. For example, when browsing a category page, users see content filtered on that specific category.
+ */
+export type ViewedFilters = {
+  /**
+   * Can contain 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;
+
+  /**
+   * Name of the Algolia index.
+   */
+  index: string;
+
+  /**
+   * Facet filters.  Each facet filter string must be URL-encoded, such as, `discount:10%25`.
+   */
+  filters: string[];
+
+  /**
+   * Anonymous or pseudonymous user identifier.   > **Note**: Never include personally identifiable information in user tokens.
+   */
+  userToken: string;
+
+  /**
+   * Time 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?: number;
+};

package/model/viewedObjectIDs.ts

@@ -0,0 +1,35 @@
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
+
+import type { ViewEvent } from './viewEvent';
+
+/**
+ * Use this event to track when users viewed items in the search results.
+ */
+export type ViewedObjectIDs = {
+  /**
+   * Can contain 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;
+
+  /**
+   * Name of the Algolia index.
+   */
+  index: string;
+
+  /**
+   * List of object identifiers for items of an Algolia index.
+   */
+  objectIDs: string[];
+
+  /**
+   * Anonymous or pseudonymous user identifier.   > **Note**: Never include personally identifiable information in user tokens.
+   */
+  userToken: string;
+
+  /**
+   * Time 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?: number;
+};

package/package.json

@@ -1,10 +1,11 @@
 {
   "name": "@algolia/client-insights",
-  "version": "5.0.0-alpha.72",
+  "version": "5.0.0-alpha.75",
   "description": "JavaScript client for client-insights",
   "repository": "algolia/algoliasearch-client-javascript",
   "license": "MIT",
   "author": "Algolia",
+  "type": "module",
   "exports": {
     ".": {
       "node": {
@@ -38,14 +39,14 @@
     "clean": "rm -rf ./dist || true"
   },
   "dependencies": {
-    "@algolia/client-common": "5.0.0-alpha.72",
-    "@algolia/requester-browser-xhr": "5.0.0-alpha.72",
-    "@algolia/requester-node-http": "5.0.0-alpha.72"
+    "@algolia/client-common": "5.0.0-alpha.75",
+    "@algolia/requester-browser-xhr": "5.0.0-alpha.75",
+    "@algolia/requester-node-http": "5.0.0-alpha.75"
   },
   "devDependencies": {
-    "@types/node": "18.16.18",
-    "rollup": "2.79.1",
-    "typescript": "5.0.4"
+    "@types/node": "18.17.0",
+    "rollup": "3.26.3",
+    "typescript": "5.1.6"
   },
   "engines": {
     "node": ">= 14.0.0"

package/dist/model/eventType.d.ts

@@ -1,2 +0,0 @@
-export type EventType = 'click' | 'conversion' | 'view';
-//# sourceMappingURL=eventType.d.ts.map

package/dist/model/eventType.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"eventType.d.ts","sourceRoot":"","sources":["../../model/eventType.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,SAAS,GAAG,OAAO,GAAG,YAAY,GAAG,MAAM,CAAC"}

package/dist/model/insightEvent.d.ts

@@ -1,40 +0,0 @@
-import type { EventType } from './eventType';
-/**
- * Insights event.
- */
-export type InsightEvent = {
-    eventType: EventType;
-    /**
-     * A user-defined string used to categorize events.
-     */
-    eventName: string;
-    /**
-     * Name of the targeted index.
-     */
-    index: string;
-    /**
-     * A user identifier. Depending if the user is logged-in or not, several strategies can be used from a sessionId to a technical identifier. You should always send pseudonymous or anonymous userTokens.
-     */
-    userToken: string;
-    /**
-     * Time of the event expressed in milliseconds since the Unix epoch.
-     */
-    timestamp?: number;
-    /**
-     * Algolia queryID. This is required when an event is tied to a search.
-     */
-    queryID?: string;
-    /**
-     * An array of index objectID. Limited to 20 objects. An event can’t have both objectIDs and filters at the same time.
-     */
-    objectIDs?: string[];
-    /**
-     * An array of filters. Limited to 10 filters. An event can’t have both objectIDs and filters at the same time.
-     */
-    filters?: string[];
-    /**
-     * Position of the click in the list of Algolia search results. This field is required if a queryID is provided. One position must be provided for each objectID.
-     */
-    positions?: number[];
-};
-//# sourceMappingURL=insightEvent.d.ts.map

package/dist/model/insightEvent.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"insightEvent.d.ts","sourceRoot":"","sources":["../../model/insightEvent.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAE7C;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG;IACzB,SAAS,EAAE,SAAS,CAAC;IAErB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;IAErB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IAEnB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;CACtB,CAAC"}

package/dist/model/insightEvents.d.ts

@@ -1,11 +0,0 @@
-import type { InsightEvent } from './insightEvent';
-/**
- * Object containing the events sent.
- */
-export type InsightEvents = {
-    /**
-     * Array of events sent.
-     */
-    events: InsightEvent[];
-};
-//# sourceMappingURL=insightEvents.d.ts.map

package/dist/model/insightEvents.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"insightEvents.d.ts","sourceRoot":"","sources":["../../model/insightEvents.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAEnD;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG;IAC1B;;OAEG;IACH,MAAM,EAAE,YAAY,EAAE,CAAC;CACxB,CAAC"}

package/dist/model/pushEventsResponse.d.ts

@@ -1,7 +0,0 @@
-export type PushEventsResponse = {
-    /**
-     * A message confirming the event push.
-     */
-    message: string;
-};
-//# sourceMappingURL=pushEventsResponse.d.ts.map

package/dist/model/pushEventsResponse.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"pushEventsResponse.d.ts","sourceRoot":"","sources":["../../model/pushEventsResponse.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,kBAAkB,GAAG;IAC/B;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC"}

package/model/insightEvent.ts

@@ -1,50 +0,0 @@
-// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
-
-import type { EventType } from './eventType';
-
-/**
- * Insights event.
- */
-export type InsightEvent = {
-  eventType: EventType;
-
-  /**
-   * A user-defined string used to categorize events.
-   */
-  eventName: string;
-
-  /**
-   * Name of the targeted index.
-   */
-  index: string;
-
-  /**
-   * A user identifier. Depending if the user is logged-in or not, several strategies can be used from a sessionId to a technical identifier. You should always send pseudonymous or anonymous userTokens.
-   */
-  userToken: string;
-
-  /**
-   * Time of the event expressed in milliseconds since the Unix epoch.
-   */
-  timestamp?: number;
-
-  /**
-   * Algolia queryID. This is required when an event is tied to a search.
-   */
-  queryID?: string;
-
-  /**
-   * An array of index objectID. Limited to 20 objects. An event can’t have both objectIDs and filters at the same time.
-   */
-  objectIDs?: string[];
-
-  /**
-   * An array of filters. Limited to 10 filters. An event can’t have both objectIDs and filters at the same time.
-   */
-  filters?: string[];
-
-  /**
-   * Position of the click in the list of Algolia search results. This field is required if a queryID is provided. One position must be provided for each objectID.
-   */
-  positions?: number[];
-};

package/model/insightEvents.ts

@@ -1,13 +0,0 @@
-// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
-
-import type { InsightEvent } from './insightEvent';
-
-/**
- * Object containing the events sent.
- */
-export type InsightEvents = {
-  /**
-   * Array of events sent.
-   */
-  events: InsightEvent[];
-};