@algolia/client-insights 0.0.0 → 5.0.0-alpha.100

package/model/purchasedObjectIDsAfterSearch.ts

@@ -0,0 +1,57 @@
+// 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 { ConversionEvent } from './conversionEvent';
+import type { ObjectDataAfterSearch } from './objectDataAfterSearch';
+import type { PurchaseEvent } from './purchaseEvent';
+import type { Value } from './value';
+
+/**
+ * Use this event to track when users make a purchase after a previous Algolia request. If you\'re building your category pages with Algolia, you\'ll also use this event.
+ */
+export type PurchasedObjectIDsAfterSearch = {
+  /**
+   * 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.
+   */
+  eventName: string;
+
+  eventType: ConversionEvent;
+
+  eventSubtype: PurchaseEvent;
+
+  /**
+   * The name of an Algolia index.
+   */
+  index: string;
+
+  /**
+   * The 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.
+   */
+  userToken: string;
+
+  /**
+   * An identifier for authenticated users.  > **Note**: Never include personally identifiable information in user tokens.
+   */
+  authenticatedUserToken?: string;
+
+  /**
+   * Three-letter [currency code](https://www.iso.org/iso-4217-currency-codes.html).
+   */
+  currency?: string;
+
+  /**
+   * Extra information about the records involved in a purchase or add-to-cart events.  If provided, it must be the same length as `objectIDs`.
+   */
+  objectData?: ObjectDataAfterSearch[];
+
+  /**
+   * 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?: number;
+
+  value?: Value;
+};

package/model/value.ts

@@ -0,0 +1,6 @@
+// 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.
+
+/**
+ * Total monetary value of this event in units of `currency`.
+ */
+export type Value = number | string;

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,40 @@
+// 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 = {
+  /**
+   * 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.
+   */
+  eventName: string;
+
+  eventType: ViewEvent;
+
+  /**
+   * The name of an Algolia index.
+   */
+  index: string;
+
+  /**
+   * Facet filters.  Each facet filter string 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.
+   */
+  userToken: string;
+
+  /**
+   * An identifier for authenticated users.  > **Note**: Never include personally identifiable information in user tokens.
+   */
+  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?: number;
+};

package/model/viewedObjectIDs.ts

@@ -0,0 +1,40 @@
+// 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 = {
+  /**
+   * 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.
+   */
+  eventName: string;
+
+  eventType: ViewEvent;
+
+  /**
+   * The name of an Algolia index.
+   */
+  index: string;
+
+  /**
+   * The 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.
+   */
+  userToken: string;
+
+  /**
+   * An identifier for authenticated users.  > **Note**: Never include personally identifiable information in user tokens.
+   */
+  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?: number;
+};

package/package.json

@@ -1 +1,54 @@
-{ "version": "0.0.0", "name": "@algolia/client-insights"}
+{
+  "name": "@algolia/client-insights",
+  "version": "5.0.0-alpha.100",
+  "description": "JavaScript client for client-insights",
+  "repository": "algolia/algoliasearch-client-javascript",
+  "license": "MIT",
+  "author": "Algolia",
+  "type": "module",
+  "exports": {
+    ".": {
+      "node": {
+        "import": "./dist/client-insights.esm.node.js",
+        "module": "./dist/client-insights.esm.node.js",
+        "require": "./dist/client-insights.cjs",
+        "default": "./dist/client-insights.cjs"
+      },
+      "default": {
+        "umd": "./dist/client-insights.umd.js",
+        "module": "./dist/client-insights.esm.browser.js",
+        "import": "./dist/client-insights.esm.browser.js",
+        "default": "./dist/client-insights.umd.js"
+      }
+    },
+    "./src/*": "./src/*.ts",
+    "./model": "./model/index.ts"
+  },
+  "jsdelivr": "./dist/client-insights.umd.js",
+  "unpkg": "./dist/client-insights.umd.js",
+  "browser": "./dist/client-insights.umd.js",
+  "types": "./index.d.ts",
+  "files": [
+    "dist",
+    "model",
+    "index.js",
+    "index.d.ts"
+  ],
+  "scripts": {
+    "build": "yarn clean && rollup --config",
+    "clean": "rm -rf ./dist || true"
+  },
+  "dependencies": {
+    "@algolia/client-common": "5.0.0-alpha.101",
+    "@algolia/requester-browser-xhr": "5.0.0-alpha.101",
+    "@algolia/requester-node-http": "5.0.0-alpha.101"
+  },
+  "devDependencies": {
+    "@types/node": "20.11.0",
+    "rollup": "4.9.6",
+    "typescript": "5.3.3"
+  },
+  "engines": {
+    "node": ">= 14.0.0"
+  }
+}