@algolia/client-analytics 4.14.2 → 5.0.0-alpha.11

package/model/getSearchesCountResponse.ts

@@ -0,0 +1,15 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+import type { SearchEvent } from './searchEvent';
+
+export type GetSearchesCountResponse = {
+  /**
+   * The number of occurrences.
+   */
+  count: number;
+
+  /**
+   * A list of search events with their date and count.
+   */
+  dates: SearchEvent[];
+};

package/model/getSearchesNoClicksResponse.ts

@@ -0,0 +1,10 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+import type { SearchNoClickEvent } from './searchNoClickEvent';
+
+export type GetSearchesNoClicksResponse = {
+  /**
+   * A list of searches with no clicks and their count.
+   */
+  searches: SearchNoClickEvent[];
+};

package/model/getSearchesNoResultsResponse.ts

@@ -0,0 +1,10 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+import type { SearchNoResultEvent } from './searchNoResultEvent';
+
+export type GetSearchesNoResultsResponse = {
+  /**
+   * A list of searches with no results and their count.
+   */
+  searches: SearchNoResultEvent[];
+};

package/model/getStatusResponse.ts

@@ -0,0 +1,8 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+export type GetStatusResponse = {
+  /**
+   * Date of last update (ISO-8601 format).
+   */
+  updatedAt: string;
+};

package/model/getTopCountriesResponse.ts

@@ -0,0 +1,10 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+import type { TopCountry } from './topCountry';
+
+export type GetTopCountriesResponse = {
+  /**
+   * A list of countries with their count.
+   */
+  countries: TopCountry[];
+};

package/model/getTopFilterAttribute.ts

@@ -0,0 +1,13 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+export type GetTopFilterAttribute = {
+  /**
+   * The attribute.
+   */
+  attribute: string;
+
+  /**
+   * The number of occurrences.
+   */
+  count: number;
+};

package/model/getTopFilterAttributesResponse.ts

@@ -0,0 +1,10 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+import type { GetTopFilterAttribute } from './getTopFilterAttribute';
+
+export type GetTopFilterAttributesResponse = {
+  /**
+   * A list of attributes with their count.
+   */
+  attributes: GetTopFilterAttribute[];
+};

package/model/getTopFilterForAttribute.ts

@@ -0,0 +1,23 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+export type GetTopFilterForAttribute = {
+  /**
+   * The attribute.
+   */
+  attribute: string;
+
+  /**
+   * The operator.
+   */
+  operator: string;
+
+  /**
+   * The value of the attribute.
+   */
+  value: string;
+
+  /**
+   * The number of occurrences.
+   */
+  count: number;
+};

package/model/getTopFilterForAttributeResponse.ts

@@ -0,0 +1,10 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+import type { GetTopFilterForAttribute } from './getTopFilterForAttribute';
+
+export type GetTopFilterForAttributeResponse = {
+  /**
+   * A list of filters for the given attributes.
+   */
+  values: GetTopFilterForAttribute[];
+};

package/model/getTopFiltersNoResultsResponse.ts

@@ -0,0 +1,10 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+import type { GetTopFiltersNoResultsValues } from './getTopFiltersNoResultsValues';
+
+export type GetTopFiltersNoResultsResponse = {
+  /**
+   * A list of filters without results.
+   */
+  values: GetTopFiltersNoResultsValues[];
+};

package/model/getTopFiltersNoResultsValue.ts

@@ -0,0 +1,18 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+export type GetTopFiltersNoResultsValue = {
+  /**
+   * The attribute.
+   */
+  attribute: string;
+
+  /**
+   * The operator.
+   */
+  operator: string;
+
+  /**
+   * The value of the attribute.
+   */
+  value: string;
+};

package/model/getTopFiltersNoResultsValues.ts

@@ -0,0 +1,15 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+import type { GetTopFiltersNoResultsValue } from './getTopFiltersNoResultsValue';
+
+export type GetTopFiltersNoResultsValues = {
+  /**
+   * The number of occurrences.
+   */
+  count: number;
+
+  /**
+   * A list of filters without results.
+   */
+  values: GetTopFiltersNoResultsValue[];
+};

package/model/getTopHitsResponse.ts

@@ -0,0 +1,6 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+import type { TopHitsResponse } from './topHitsResponse';
+import type { TopHitsResponseWithAnalytics } from './topHitsResponseWithAnalytics';
+
+export type GetTopHitsResponse = TopHitsResponse | TopHitsResponseWithAnalytics;

package/model/getTopSearchesResponse.ts

@@ -0,0 +1,8 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+import type { TopSearchesResponse } from './topSearchesResponse';
+import type { TopSearchesResponseWithAnalytics } from './topSearchesResponseWithAnalytics';
+
+export type GetTopSearchesResponse =
+  | TopSearchesResponse
+  | TopSearchesResponseWithAnalytics;

package/model/getUsersCountResponse.ts

@@ -0,0 +1,15 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+import type { UserWithDate } from './userWithDate';
+
+export type GetUsersCountResponse = {
+  /**
+   * The number of occurrences.
+   */
+  count: number;
+
+  /**
+   * A list of users count with their date.
+   */
+  dates: UserWithDate[];
+};

package/model/index.ts

@@ -0,0 +1,46 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+export * from './averageClickEvent';
+export * from './clickPosition';
+export * from './clickThroughRateEvent';
+export * from './conversionRateEvent';
+export * from './direction';
+export * from './errorBase';
+export * from './getAverageClickPositionResponse';
+export * from './getClickPositionsResponse';
+export * from './getClickThroughRateResponse';
+export * from './getConversationRateResponse';
+export * from './getNoClickRateResponse';
+export * from './getNoResultsRateResponse';
+export * from './getSearchesCountResponse';
+export * from './getSearchesNoClicksResponse';
+export * from './getSearchesNoResultsResponse';
+export * from './getStatusResponse';
+export * from './getTopCountriesResponse';
+export * from './getTopFilterAttribute';
+export * from './getTopFilterAttributesResponse';
+export * from './getTopFilterForAttribute';
+export * from './getTopFilterForAttributeResponse';
+export * from './getTopFiltersNoResultsResponse';
+export * from './getTopFiltersNoResultsValue';
+export * from './getTopFiltersNoResultsValues';
+export * from './getTopHitsResponse';
+export * from './getTopSearchesResponse';
+export * from './getUsersCountResponse';
+export * from './noClickRateEvent';
+export * from './noResultsRateEvent';
+export * from './orderBy';
+export * from './searchEvent';
+export * from './searchNoClickEvent';
+export * from './searchNoResultEvent';
+export * from './topCountry';
+export * from './topHit';
+export * from './topHitWithAnalytics';
+export * from './topHitsResponse';
+export * from './topHitsResponseWithAnalytics';
+export * from './topSearch';
+export * from './topSearchWithAnalytics';
+export * from './topSearchesResponse';
+export * from './topSearchesResponseWithAnalytics';
+export * from './userWithDate';
+export * from './clientMethodProps';

package/model/noClickRateEvent.ts

@@ -0,0 +1,23 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+export type NoClickRateEvent = {
+  /**
+   * The click-through rate.
+   */
+  rate: number;
+
+  /**
+   * The number of click event.
+   */
+  count: number;
+
+  /**
+   * The number of click event.
+   */
+  noClickCount: number;
+
+  /**
+   * Date of the event.
+   */
+  date: string;
+};

package/model/noResultsRateEvent.ts

@@ -0,0 +1,23 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+export type NoResultsRateEvent = {
+  /**
+   * Date of the event.
+   */
+  date: string;
+
+  /**
+   * The number of occurrences.
+   */
+  noResultCount: number;
+
+  /**
+   * The number of occurrences.
+   */
+  count: number;
+
+  /**
+   * The click-through rate.
+   */
+  rate: number;
+};

package/model/orderBy.ts

@@ -0,0 +1,7 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+export type OrderBy =
+  | 'averageClickPosition'
+  | 'clickThroughRate'
+  | 'conversionRate'
+  | 'searchCount';

package/model/searchEvent.ts

@@ -0,0 +1,13 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+export type SearchEvent = {
+  /**
+   * Date of the event.
+   */
+  date: string;
+
+  /**
+   * The number of occurrences.
+   */
+  count: number;
+};

package/model/searchNoClickEvent.ts

@@ -0,0 +1,18 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+export type SearchNoClickEvent = {
+  /**
+   * The search query.
+   */
+  search: string;
+
+  /**
+   * The number of occurrences.
+   */
+  count: number;
+
+  /**
+   * The number of occurrences.
+   */
+  withFilterCount: number;
+};

package/model/searchNoResultEvent.ts

@@ -0,0 +1,18 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+export type SearchNoResultEvent = {
+  /**
+   * The search query.
+   */
+  search: string;
+
+  /**
+   * The number of occurrences.
+   */
+  count: number;
+
+  /**
+   * Number of hits that the search query matched.
+   */
+  nbHits: number;
+};

package/model/topCountry.ts

@@ -0,0 +1,13 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+export type TopCountry = {
+  /**
+   * The country.
+   */
+  country: string;
+
+  /**
+   * The number of occurrences.
+   */
+  count: number;
+};

package/model/topHit.ts

@@ -0,0 +1,13 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+export type TopHit = {
+  /**
+   * The hit.
+   */
+  hit: string;
+
+  /**
+   * The number of occurrences.
+   */
+  count: number;
+};

package/model/topHitWithAnalytics.ts

@@ -0,0 +1,38 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+export type TopHitWithAnalytics = {
+  /**
+   * The hit.
+   */
+  hit: string;
+
+  /**
+   * The number of occurrences.
+   */
+  count: number;
+
+  /**
+   * The click-through rate.
+   */
+  clickThroughRate: number;
+
+  /**
+   * The conversion rate.
+   */
+  conversionRate: number;
+
+  /**
+   * The number of tracked search click.
+   */
+  trackedSearchCount: number;
+
+  /**
+   * The number of click event.
+   */
+  clickCount: number;
+
+  /**
+   * The number of converted clicks.
+   */
+  conversionCount: number;
+};

package/model/topHitsResponse.ts

@@ -0,0 +1,10 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+import type { TopHit } from './topHit';
+
+export type TopHitsResponse = {
+  /**
+   * A list of top hits with their count.
+   */
+  hits: TopHit[];
+};

package/model/topHitsResponseWithAnalytics.ts

@@ -0,0 +1,10 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+import type { TopHitWithAnalytics } from './topHitWithAnalytics';
+
+export type TopHitsResponseWithAnalytics = {
+  /**
+   * A list of top hits with their count and analytics.
+   */
+  hits: TopHitWithAnalytics[];
+};

package/model/topSearch.ts

@@ -0,0 +1,18 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+export type TopSearch = {
+  /**
+   * The search query.
+   */
+  search: string;
+
+  /**
+   * The number of occurrences.
+   */
+  count: number;
+
+  /**
+   * Number of hits that the search query matched.
+   */
+  nbHits: number;
+};

package/model/topSearchWithAnalytics.ts

@@ -0,0 +1,48 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+export type TopSearchWithAnalytics = {
+  /**
+   * The search query.
+   */
+  search: string;
+
+  /**
+   * The number of occurrences.
+   */
+  count: number;
+
+  /**
+   * The click-through rate.
+   */
+  clickThroughRate: number;
+
+  /**
+   * The average position of all the click count event.
+   */
+  averageClickPosition: number;
+
+  /**
+   * The conversion rate.
+   */
+  conversionRate: number;
+
+  /**
+   * The number of tracked search click.
+   */
+  trackedSearchCount: number;
+
+  /**
+   * The number of click event.
+   */
+  clickCount: number;
+
+  /**
+   * The number of converted clicks.
+   */
+  conversionCount: number;
+
+  /**
+   * Number of hits that the search query matched.
+   */
+  nbHits: number;
+};

package/model/topSearchesResponse.ts

@@ -0,0 +1,10 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+import type { TopSearch } from './topSearch';
+
+export type TopSearchesResponse = {
+  /**
+   * A list of top searches with their count.
+   */
+  searches: TopSearch[];
+};

package/model/topSearchesResponseWithAnalytics.ts

@@ -0,0 +1,10 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+import type { TopSearchWithAnalytics } from './topSearchWithAnalytics';
+
+export type TopSearchesResponseWithAnalytics = {
+  /**
+   * A list of top searches with their count and analytics.
+   */
+  searches: TopSearchWithAnalytics[];
+};

package/model/userWithDate.ts

@@ -0,0 +1,13 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+export type UserWithDate = {
+  /**
+   * Date of the event.
+   */
+  date: string;
+
+  /**
+   * The number of occurrences.
+   */
+  count: number;
+};

package/package.json

@@ -1,24 +1,53 @@
 {
   "name": "@algolia/client-analytics",
-  "version": "4.14.2",
-  "private": false,
-  "repository": {
-    "type": "git",
-    "url": "git://github.com/algolia/algoliasearch-client-javascript.git"
-  },
+  "version": "5.0.0-alpha.11",
+  "description": "JavaScript client for client-analytics",
+  "repository": "algolia/algoliasearch-client-javascript",
   "license": "MIT",
-  "sideEffects": false,
-  "main": "index.js",
-  "module": "dist/client-analytics.esm.js",
-  "types": "dist/client-analytics.d.ts",
+  "author": "Algolia",
+  "exports": {
+    ".": {
+      "node": {
+        "import": "./dist/client-analytics.esm.node.js",
+        "module": "./dist/client-analytics.esm.node.js",
+        "require": "./dist/client-analytics.cjs.js",
+        "default": "./dist/client-analytics.cjs.js"
+      },
+      "default": {
+        "umd": "./dist/client-analytics.umd.js",
+        "module": "./dist/client-analytics.esm.browser.js",
+        "import": "./dist/client-analytics.esm.browser.js",
+        "default": "./dist/client-analytics.umd.js"
+      }
+    },
+    "./src/*": "./src/*.ts",
+    "./model": "./model/index.ts"
+  },
+  "jsdelivr": "./dist/client-analytics.umd.js",
+  "unpkg": "./dist/client-analytics.umd.js",
+  "browser": "./dist/client-analytics.umd.js",
+  "types": "./index.d.ts",
   "files": [
+    "dist",
+    "model",
     "index.js",
-    "dist"
+    "index.d.ts"
   ],
+  "scripts": {
+    "build": "yarn clean && rollup --config",
+    "clean": "rm -rf ./dist || true"
+  },
   "dependencies": {
-    "@algolia/client-common": "4.14.2",
-    "@algolia/client-search": "4.14.2",
-    "@algolia/requester-common": "4.14.2",
-    "@algolia/transporter": "4.14.2"
+    "@algolia/client-common": "5.0.0-alpha.11",
+    "@algolia/requester-browser-xhr": "5.0.0-alpha.11",
+    "@algolia/requester-node-http": "5.0.0-alpha.11"
+  },
+  "devDependencies": {
+    "@types/node": "16.11.47",
+    "rollup": "2.78.1",
+    "typescript": "4.7.4"
+  },
+  "engines": {
+    "node": ">= 14.0.0"
   }
 }