@algolia/client-search 4.14.1 → 5.0.0-alpha.10

package/model/snippetResultOption.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 { MatchLevel } from './matchLevel';
+
+/**
+ * Snippeted attributes show parts of the matched attributes. Only returned when attributesToSnippet is non-empty.
+ */
+export type SnippetResultOption = {
+  /**
+   * Markup text with occurrences highlighted.
+   */
+  value: string;
+
+  matchLevel: MatchLevel;
+};

package/model/sortRemainingBy.ts

@@ -0,0 +1,6 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+/**
+ * How to display the remaining items.   - `count`: facet count (descending).   - `alpha`: alphabetical (ascending).   - `hidden`: show only pinned values.
+ */
+export type SortRemainingBy = 'alpha' | 'count' | 'hidden';

package/model/source.ts

@@ -0,0 +1,16 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+/**
+ * The source.
+ */
+export type Source = {
+  /**
+   * The IP range of the source.
+   */
+  source: string;
+
+  /**
+   * The description of the source.
+   */
+  description?: string;
+};

package/model/standardEntries.ts

@@ -0,0 +1,21 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+/**
+ * Map of language ISO code supported by the dictionary (e.g., \"en\" for English) to a boolean value.
+ */
+export type StandardEntries = {
+  /**
+   * Language ISO code.
+   */
+  plurals?: Record<string, boolean> | null;
+
+  /**
+   * Language ISO code.
+   */
+  stopwords?: Record<string, boolean> | null;
+
+  /**
+   * Language ISO code.
+   */
+  compounds?: Record<string, boolean> | null;
+};

package/model/synonymHit.ts

@@ -0,0 +1,48 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+import type { SynonymHitHighlightResult } from './synonymHitHighlightResult';
+import type { SynonymType } from './synonymType';
+
+/**
+ * Synonym object.
+ */
+export type SynonymHit = {
+  /**
+   * Unique identifier of the synonym object to be created or updated.
+   */
+  objectID: string;
+
+  type: SynonymType;
+
+  /**
+   * Words or phrases to be considered equivalent.
+   */
+  synonyms?: string[];
+
+  /**
+   * Word or phrase to appear in query strings (for onewaysynonym).
+   */
+  input?: string;
+
+  /**
+   * Word or phrase to appear in query strings (for altcorrection1 and altcorrection2).
+   */
+  word?: string;
+
+  /**
+   * Words to be matched in records.
+   */
+  corrections?: string[];
+
+  /**
+   * Token to be put inside records.
+   */
+  placeholder?: string;
+
+  /**
+   * List of query words that will match the token.
+   */
+  replacements?: string[];
+
+  _highlightResult?: SynonymHitHighlightResult;
+};

package/model/synonymHitHighlightResult.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 { HighlightResult } from './highlightResult';
+
+/**
+ * Highlighted results.
+ */
+export type SynonymHitHighlightResult = {
+  /**
+   * Show highlighted section and words matched on a query.
+   */
+  type?: Record<string, HighlightResult>;
+
+  synonyms?: Array<Record<string, HighlightResult>>;
+};

package/model/synonymType.ts

@@ -0,0 +1,11 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+/**
+ * Type of the synonym object.
+ */
+export type SynonymType =
+  | 'altcorrection1'
+  | 'altcorrection2'
+  | 'onewaysynonym'
+  | 'placeholder'
+  | 'synonym';

package/model/tagFilters.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 { MixedSearchFilters } from './mixedSearchFilters';
+
+/**
+ * Filter hits by tags.
+ */
+export type TagFilters = MixedSearchFilters[] | string;

package/model/taskStatus.ts

@@ -0,0 +1,3 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+export type TaskStatus = 'notPublished' | 'published';

package/model/timeRange.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 TimeRange = {
+  /**
+   * Lower bound of the time range (Unix timestamp).
+   */
+  from: number;
+
+  /**
+   * Upper bound of the time range (Unix timestamp).
+   */
+  until: number;
+};

package/model/typoTolerance.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 { TypoToleranceEnum } from './typoToleranceEnum';
+
+/**
+ * Controls whether typo tolerance is enabled and how it is applied.
+ */
+export type TypoTolerance = TypoToleranceEnum | boolean;

package/model/typoToleranceEnum.ts

@@ -0,0 +1,3 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+export type TypoToleranceEnum = 'min' | 'strict';

package/model/updateApiKeyResponse.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 UpdateApiKeyResponse = {
+  /**
+   * The API key.
+   */
+  key: string;
+
+  /**
+   * Date of last update (ISO-8601 format).
+   */
+  updatedAt: string;
+};

package/model/updatedAtResponse.ts

@@ -0,0 +1,16 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+/**
+ * The response with a taskID and an updatedAt timestamp.
+ */
+export type UpdatedAtResponse = {
+  /**
+   * TaskID of the task to wait for.
+   */
+  taskID: number;
+
+  /**
+   * Date of last update (ISO-8601 format).
+   */
+  updatedAt: string;
+};

package/model/updatedAtWithObjectIdResponse.ts

@@ -0,0 +1,21 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+/**
+ * The response with a taskID, an objectID and an updatedAt timestamp.
+ */
+export type UpdatedAtWithObjectIdResponse = {
+  /**
+   * TaskID of the task to wait for.
+   */
+  taskID?: number;
+
+  /**
+   * Date of last update (ISO-8601 format).
+   */
+  updatedAt?: string;
+
+  /**
+   * Unique identifier of the object.
+   */
+  objectID?: string;
+};

package/model/updatedRuleResponse.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 UpdatedRuleResponse = {
+  /**
+   * Unique identifier of the object.
+   */
+  objectID: string;
+
+  /**
+   * Date of last update (ISO-8601 format).
+   */
+  updatedAt: string;
+
+  /**
+   * TaskID of the task to wait for.
+   */
+  taskID: number;
+};

package/model/userHighlightResult.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 { HighlightResult } from './highlightResult';
+
+export type UserHighlightResult = {
+  /**
+   * Show highlighted section and words matched on a query.
+   */
+  userID: Record<string, HighlightResult>;
+
+  /**
+   * Show highlighted section and words matched on a query.
+   */
+  clusterName: Record<string, HighlightResult>;
+};

package/model/userHit.ts

@@ -0,0 +1,32 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+import type { UserHighlightResult } from './userHighlightResult';
+
+export type UserHit = {
+  /**
+   * UserID of the user.
+   */
+  userID: string;
+
+  /**
+   * Name of the cluster.
+   */
+  clusterName: string;
+
+  /**
+   * Number of records in the cluster.
+   */
+  nbRecords: number;
+
+  /**
+   * Data size taken by all the users assigned to the cluster.
+   */
+  dataSize: number;
+
+  /**
+   * UserID of the requested user. Same as userID.
+   */
+  objectID: string;
+
+  _highlightResult: UserHighlightResult;
+};

package/model/userId.ts

@@ -0,0 +1,26 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+/**
+ * A userID.
+ */
+export type UserId = {
+  /**
+   * UserID of the user.
+   */
+  userID: string;
+
+  /**
+   * Cluster on which the user is assigned.
+   */
+  clusterName: string;
+
+  /**
+   * Number of records belonging to the user.
+   */
+  nbRecords: number;
+
+  /**
+   * Data size used by the user.
+   */
+  dataSize: number;
+};

package/model/value.ts

@@ -0,0 +1,12 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+import type { SortRemainingBy } from './sortRemainingBy';
+
+export type Value = {
+  /**
+   * Pinned order of facet lists.
+   */
+  order?: string[];
+
+  sortRemainingBy?: SortRemainingBy;
+};

package/package.json

@@ -1,23 +1,37 @@
 {
   "name": "@algolia/client-search",
-  "version": "4.14.1",
-  "private": false,
-  "repository": {
-    "type": "git",
-    "url": "git://github.com/algolia/algoliasearch-client-javascript.git"
-  },
+  "version": "5.0.0-alpha.10",
+  "description": "JavaScript client for client-search",
+  "repository": "algolia/algoliasearch-client-javascript",
   "license": "MIT",
-  "sideEffects": false,
+  "author": "Algolia",
   "main": "index.js",
-  "module": "dist/client-search.esm.js",
-  "types": "dist/client-search.d.ts",
+  "jsdelivr": "dist/client-search.umd.js",
+  "unpkg": "dist/client-search.umd.js",
+  "module": "dist/client-search.esm.node.js",
+  "browser": "dist/client-search.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.1",
-    "@algolia/requester-common": "4.14.1",
-    "@algolia/transporter": "4.14.1"
+    "@algolia/client-common": "5.0.0-alpha.10",
+    "@algolia/requester-browser-xhr": "5.0.0-alpha.10",
+    "@algolia/requester-node-http": "5.0.0-alpha.10"
+  },
+  "devDependencies": {
+    "@types/node": "16.11.47",
+    "rollup": "2.77.2",
+    "typescript": "4.7.4"
+  },
+  "engines": {
+    "node": ">= 14.0.0"
   }
 }