algoliasearch 4.14.1 → 5.0.0-alpha.10

package/dist/lite/src/liteClient.d.ts

@@ -0,0 +1,51 @@
+import type { CreateClientOptions, RequestOptions } from '@algolia/client-common';
+import type { PostProps, LegacySearchMethodProps } from '../model/clientMethodProps';
+import type { SearchMethodParams } from '../model/searchMethodParams';
+import type { SearchResponses } from '../model/searchResponses';
+export declare const apiClientVersion = "5.0.0-alpha.10";
+export declare function createLiteClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, ...options }: CreateClientOptions): {
+    transporter: import("@algolia/client-common").Transporter;
+    /**
+     * The `appId` currently in use.
+     */
+    appId: string;
+    /**
+     * Clears the cache of the transporter for the `requestsCache` and `responsesCache` properties.
+     */
+    clearCache(): Promise<void>;
+    /**
+     * Get the value of the `algoliaAgent`, used by our libraries internally and telemetry system.
+     */
+    readonly _ua: string;
+    /**
+     * Adds a `segment` to the `x-algolia-agent` sent with every requests.
+     *
+     * @param segment - The algolia agent (user-agent) segment to add.
+     * @param version - The version of the agent.
+     */
+    addAlgoliaAgent(segment: string, version?: string): void;
+    /**
+     * This method allow you to send requests to the Algolia REST API.
+     *
+     * @summary Send requests to the Algolia REST API.
+     * @param post - The post object.
+     * @param post.path - The path of the API endpoint to target, anything after the /1 needs to be specified.
+     * @param post.parameters - Query parameters to be applied to the current query.
+     * @param post.body - The parameters to send with the custom request.
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     */
+    post({ path, parameters, body }: PostProps, requestOptions?: RequestOptions): Promise<Record<string, any>>;
+    /**
+     * Perform a search operation targeting one or many indices.
+     *
+     * @summary Search multiple indices.
+     * @param searchMethodParams - The `search` requests and strategy.
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     */
+    search<T>(searchMethodParams: LegacySearchMethodProps | SearchMethodParams, requestOptions?: RequestOptions): Promise<SearchResponses<T>>;
+};
+/**
+ * The client type.
+ */
+export declare type LiteClient = ReturnType<typeof createLiteClient>;
+//# sourceMappingURL=liteClient.d.ts.map

package/dist/lite/src/liteClient.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"liteClient.d.ts","sourceRoot":"","sources":["../../../lite/src/liteClient.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,EACV,mBAAmB,EAInB,cAAc,EAEf,MAAM,wBAAwB,CAAC;AAEhC,OAAO,KAAK,EACV,SAAS,EACT,uBAAuB,EACxB,MAAM,4BAA4B,CAAC;AACpC,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,6BAA6B,CAAC;AACtE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAC;AAEhE,eAAO,MAAM,gBAAgB,mBAAmB,CAAC;AAsCjD,wBAAgB,gBAAgB,CAAC,EAC/B,KAAK,EAAE,WAAW,EAClB,MAAM,EAAE,YAAY,EACpB,QAAQ,EACR,aAAa,EACb,GAAG,OAAO,EACX,EAAE,mBAAmB;;IAwBlB;;OAEG;;IAGH;;OAEG;kBACW,QAAQ,IAAI,CAAC;IAO3B;;OAEG;;IAKH;;;;;OAKG;6BACsB,MAAM,YAAY,MAAM,GAAG,IAAI;IAIxD;;;;;;;;;OASG;qCAE2B,SAAS,mBACpB,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,GAAG,CAAC,CAAC;IAoB/B;;;;;;OAMG;kCAEmB,uBAAuB,GAAG,kBAAkB,mBAC/C,cAAc;EAwDpC;AAED;;GAEG;AACH,oBAAY,UAAU,GAAG,UAAU,CAAC,OAAO,gBAAgB,CAAC,CAAC"}

package/index.d.ts

@@ -1,3 +1,2 @@
-/* eslint-disable import/no-unresolved*/
-export * from './dist/algoliasearch';
-export { default } from './dist/algoliasearch';
+// eslint-disable-next-line import/no-unresolved
+export * from './dist/builds/node';

package/index.js

@@ -1,15 +1,2 @@
-/* eslint-disable functional/immutable-data, import/no-commonjs */
-const algoliasearch = require('./dist/algoliasearch.cjs.js');
-
-/**
- * The Common JS build is the default entry point for the Node environment. Keep in
- * in mind, that for the browser environment, we hint the bundler to use the UMD
- * build instead as specified on the key `browser` of our `package.json` file.
- */
-module.exports = algoliasearch;
-
-/**
- * In addition, we also set explicitly the default export below making
- * this Common JS module in compliance with es6 modules specification.
- */
-module.exports.default = algoliasearch;
+// eslint-disable-next-line import/no-commonjs,import/extensions
+module.exports = require('./dist/algoliasearch.cjs.js');

package/lite/builds/browser.ts

@@ -0,0 +1,54 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+import type { ClientOptions } from '@algolia/client-common';
+import {
+  DEFAULT_CONNECT_TIMEOUT_BROWSER,
+  DEFAULT_READ_TIMEOUT_BROWSER,
+  DEFAULT_WRITE_TIMEOUT_BROWSER,
+  createMemoryCache,
+  createFallbackableCache,
+  createBrowserLocalStorageCache,
+} from '@algolia/client-common';
+import { createXhrRequester } from '@algolia/requester-browser-xhr';
+
+import { createLiteClient, apiClientVersion } from '../src/liteClient';
+import type { LiteClient } from '../src/liteClient';
+
+export { apiClientVersion, LiteClient } from '../src/liteClient';
+export * from '../model';
+
+export function liteClient(
+  appId: string,
+  apiKey: string,
+  options?: ClientOptions
+): LiteClient {
+  if (!appId || typeof appId !== 'string') {
+    throw new Error('`appId` is missing.');
+  }
+
+  if (!apiKey || typeof apiKey !== 'string') {
+    throw new Error('`apiKey` is missing.');
+  }
+
+  return createLiteClient({
+    appId,
+    apiKey,
+    timeouts: {
+      connect: DEFAULT_CONNECT_TIMEOUT_BROWSER,
+      read: DEFAULT_READ_TIMEOUT_BROWSER,
+      write: DEFAULT_WRITE_TIMEOUT_BROWSER,
+    },
+    requester: createXhrRequester(),
+    algoliaAgents: [{ segment: 'Browser' }],
+    authMode: 'WithinQueryParameters',
+    responsesCache: createMemoryCache(),
+    requestsCache: createMemoryCache({ serializable: false }),
+    hostsCache: createFallbackableCache({
+      caches: [
+        createBrowserLocalStorageCache({ key: `${apiClientVersion}-${appId}` }),
+        createMemoryCache(),
+      ],
+    }),
+    ...options,
+  });
+}

package/lite/builds/node.ts

@@ -0,0 +1,47 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+import type { ClientOptions } from '@algolia/client-common';
+import {
+  DEFAULT_CONNECT_TIMEOUT_NODE,
+  DEFAULT_READ_TIMEOUT_NODE,
+  DEFAULT_WRITE_TIMEOUT_NODE,
+  createMemoryCache,
+  createNullCache,
+} from '@algolia/client-common';
+import { createHttpRequester } from '@algolia/requester-node-http';
+
+import { createLiteClient } from '../src/liteClient';
+import type { LiteClient } from '../src/liteClient';
+
+export { apiClientVersion, LiteClient } from '../src/liteClient';
+export * from '../model';
+
+export function liteClient(
+  appId: string,
+  apiKey: string,
+  options?: ClientOptions
+): LiteClient {
+  if (!appId || typeof appId !== 'string') {
+    throw new Error('`appId` is missing.');
+  }
+
+  if (!apiKey || typeof apiKey !== 'string') {
+    throw new Error('`apiKey` is missing.');
+  }
+
+  return createLiteClient({
+    appId,
+    apiKey,
+    timeouts: {
+      connect: DEFAULT_CONNECT_TIMEOUT_NODE,
+      read: DEFAULT_READ_TIMEOUT_NODE,
+      write: DEFAULT_WRITE_TIMEOUT_NODE,
+    },
+    requester: createHttpRequester(),
+    algoliaAgents: [{ segment: 'Node.js', version: process.versions.node }],
+    responsesCache: createNullCache(),
+    requestsCache: createNullCache(),
+    hostsCache: createMemoryCache(),
+    ...options,
+  });
+}

package/lite/model/acl.ts

@@ -0,0 +1,20 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+/**
+ * List of rights for the API key. The following rights can be used:  addObject: allows to add/update an object in the index (copy/move index are also allowed with this right). Analytics: allows to retrieve the analytics through the Analytics API. Browse: allows to retrieve all index content via the browse API. DeleteIndex: allows to delete or clear index content. DeleteObject: allows to delete objects from the index. EditSettings: allows to change index settings. ListIndexes: allows to list all accessible indices. Logs: allows to get the logs. Recommendation: Allows usage of the Personalization dashboard and the Recommendation API. Search: allows to search the index. SeeUnretrievableAttributes: disable unretrievableAttributes feature for all operations returning records. Settings: allows to get index settings.
+ */
+export type Acl =
+  | 'addObject'
+  | 'analytics'
+  | 'browse'
+  | 'deleteIndex'
+  | 'deleteObject'
+  | 'editSettings'
+  | 'listIndexes'
+  | 'logs'
+  | 'personalization'
+  | 'recommendation'
+  | 'search'
+  | 'seeUnretrievableAttributes'
+  | 'settings'
+  | 'usage';

package/lite/model/action.ts

@@ -0,0 +1,13 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+/**
+ * Type of operation.
+ */
+export type Action =
+  | 'addObject'
+  | 'clear'
+  | 'delete'
+  | 'deleteObject'
+  | 'partialUpdateObject'
+  | 'partialUpdateObjectNoCreate'
+  | 'updateObject';

package/lite/model/addApiKeyResponse.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 AddApiKeyResponse = {
+  /**
+   * The API key.
+   */
+  key: string;
+
+  /**
+   * Date of creation (ISO-8601 format).
+   */
+  createdAt: string;
+};

package/lite/model/advancedSyntaxFeatures.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 AdvancedSyntaxFeatures = 'exactPhrase' | 'excludeWords';

package/lite/model/alternativesAsExact.ts

@@ -0,0 +1,6 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+export type AlternativesAsExact =
+  | 'ignorePlurals'
+  | 'multiWordsSynonym'
+  | 'singleWordSynonym';

package/lite/model/anchoring.ts

@@ -0,0 +1,6 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+/**
+ * Whether the pattern parameter must match the beginning or the end of the query string, or both, or none.
+ */
+export type Anchoring = 'contains' | 'endsWith' | 'is' | 'startsWith';

package/lite/model/apiKey.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 { Acl } from './acl';
+
+/**
+ * Api Key object.
+ */
+export type ApiKey = {
+  /**
+   * Set of permissions associated with the key.
+   */
+  acl: Acl[];
+
+  /**
+   * A comment used to identify a key more easily in the dashboard. It is not interpreted by the API.
+   */
+  description?: string;
+
+  /**
+   * Restrict this new API key to a list of indices or index patterns. If the list is empty, all indices are allowed.
+   */
+  indexes?: string[];
+
+  /**
+   * Maximum number of hits this API key can retrieve in one query. If zero, no limit is enforced.
+   */
+  maxHitsPerQuery?: number;
+
+  /**
+   * Maximum number of API calls per hour allowed from a given IP address or a user token.
+   */
+  maxQueriesPerIPPerHour?: number;
+
+  /**
+   * URL-encoded query string. Force some query parameters to be applied for each query made with this API key.
+   */
+  queryParameters?: string;
+
+  /**
+   * Restrict this new API key to specific referers. If empty or blank, defaults to all referers.
+   */
+  referers?: string[];
+
+  /**
+   * Validity limit for this key in seconds. The key will automatically be removed after this period of time.
+   */
+  validity?: number;
+};

package/lite/model/aroundRadius.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 { AroundRadiusAll } from './aroundRadiusAll';
+
+/**
+ * Define the maximum radius for a geo search (in meters).
+ */
+export type AroundRadius = AroundRadiusAll | number;

package/lite/model/aroundRadiusAll.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 AroundRadiusAll = 'all';

package/lite/model/attributeToUpdate.ts

@@ -0,0 +1,5 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+import type { BuiltInOperation } from './builtInOperation';
+
+export type AttributeToUpdate = BuiltInOperation | string;

package/lite/model/automaticFacetFilter.ts

@@ -0,0 +1,21 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+/**
+ * Automatic facet Filter.
+ */
+export type AutomaticFacetFilter = {
+  /**
+   * Attribute to filter on. This must match a facet placeholder in the Rule\'s pattern.
+   */
+  facet: string;
+
+  /**
+   * Score for the filter. Typically used for optional or disjunctive filters.
+   */
+  score?: number;
+
+  /**
+   * Whether the filter is disjunctive (true) or conjunctive (false).
+   */
+  disjunctive?: boolean;
+};

package/lite/model/automaticFacetFilters.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 { AutomaticFacetFilter } from './automaticFacetFilter';
+
+/**
+ * Names of facets to which automatic filtering must be applied; they must match the facet name of a facet value placeholder in the query pattern.
+ */
+export type AutomaticFacetFilters = AutomaticFacetFilter[] | string[];

package/lite/model/baseGetApiKeyResponse.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 BaseGetApiKeyResponse = {
+  /**
+   * The API key.
+   */
+  value?: string;
+
+  /**
+   * Time of the event expressed in milliseconds since the Unix epoch.
+   */
+  createdAt: number;
+};

package/lite/model/baseIndexSettings.ts

@@ -0,0 +1,73 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+export type BaseIndexSettings = {
+  /**
+   * Creates replicas, exact copies of an index.
+   */
+  replicas?: string[];
+
+  /**
+   * Set the maximum number of hits accessible via pagination.
+   */
+  paginationLimitedTo?: number;
+
+  /**
+   * A list of words for which you want to turn off typo tolerance.
+   */
+  disableTypoToleranceOnWords?: string[];
+
+  /**
+   * Specify on which attributes in your index Algolia should apply Japanese transliteration to make words indexed in Katakana or Kanji searchable in Hiragana.
+   */
+  attributesToTransliterate?: string[];
+
+  /**
+   * List of attributes on which to do a decomposition of camel case words.
+   */
+  camelCaseAttributes?: string[];
+
+  /**
+   * Specify on which attributes in your index Algolia should apply word segmentation, also known as decompounding.
+   */
+  decompoundedAttributes?: Record<string, any>;
+
+  /**
+   * Sets the languages at the index level for language-specific processing such as tokenization and normalization.
+   */
+  indexLanguages?: string[];
+
+  /**
+   * List of attributes on which you want to disable prefix matching.
+   */
+  disablePrefixOnAttributes?: string[];
+
+  /**
+   * Enables compression of large integer arrays.
+   */
+  allowCompressionOfIntegerArray?: boolean;
+
+  /**
+   * List of numeric attributes that can be used as numerical filters.
+   */
+  numericAttributesForFiltering?: string[];
+
+  /**
+   * Control which separators are indexed.
+   */
+  separatorsToIndex?: string;
+
+  /**
+   * The complete list of attributes used for searching.
+   */
+  searchableAttributes?: string[];
+
+  /**
+   * Lets you store custom data in your indices.
+   */
+  userData?: Record<string, any>;
+
+  /**
+   * Overrides Algolia\'s default normalization.
+   */
+  customNormalization?: Record<string, Record<string, string>>;
+};

package/lite/model/baseSearchParams.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 { BaseSearchParamsWithoutQuery } from './baseSearchParamsWithoutQuery';
+import type { SearchParamsQuery } from './searchParamsQuery';
+
+export type BaseSearchParams = BaseSearchParamsWithoutQuery & SearchParamsQuery;

package/lite/model/baseSearchParamsWithoutQuery.ts

@@ -0,0 +1,157 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+import type { AroundRadius } from './aroundRadius';
+import type { FacetFilters } from './facetFilters';
+import type { NumericFilters } from './numericFilters';
+import type { OptionalFilters } from './optionalFilters';
+import type { ReRankingApplyFilter } from './reRankingApplyFilter';
+import type { TagFilters } from './tagFilters';
+
+export type BaseSearchParamsWithoutQuery = {
+  /**
+   * Overrides the query parameter and performs a more generic search that can be used to find \"similar\" results.
+   */
+  similarQuery?: string;
+
+  /**
+   * Filter the query with numeric, facet and/or tag filters.
+   */
+  filters?: string;
+
+  facetFilters?: FacetFilters;
+
+  optionalFilters?: OptionalFilters;
+
+  numericFilters?: NumericFilters;
+
+  tagFilters?: TagFilters;
+
+  /**
+   * Determines how to calculate the total score for filtering.
+   */
+  sumOrFiltersScores?: boolean;
+
+  /**
+   * Retrieve facets and their facet values.
+   */
+  facets?: string[];
+
+  /**
+   * Maximum number of facet values to return for each facet during a regular search.
+   */
+  maxValuesPerFacet?: number;
+
+  /**
+   * Force faceting to be applied after de-duplication (via the Distinct setting).
+   */
+  facetingAfterDistinct?: boolean;
+
+  /**
+   * Controls how facet values are fetched.
+   */
+  sortFacetValuesBy?: string;
+
+  /**
+   * Specify the page to retrieve.
+   */
+  page?: number;
+
+  /**
+   * Specify the offset of the first hit to return.
+   */
+  offset?: number;
+
+  /**
+   * Set the number of hits to retrieve (used only with offset).
+   */
+  length?: number;
+
+  /**
+   * Search for entries around a central geolocation, enabling a geo search within a circular area.
+   */
+  aroundLatLng?: string;
+
+  /**
+   * Search for entries around a given location automatically computed from the requester\'s IP address.
+   */
+  aroundLatLngViaIP?: boolean;
+
+  aroundRadius?: AroundRadius;
+
+  /**
+   * Precision of geo search (in meters), to add grouping by geo location to the ranking formula.
+   */
+  aroundPrecision?: number;
+
+  /**
+   * Minimum radius (in meters) used for a geo search when aroundRadius is not set.
+   */
+  minimumAroundRadius?: number;
+
+  /**
+   * Search inside a rectangular area (in geo coordinates).
+   */
+  insideBoundingBox?: number[];
+
+  /**
+   * Search inside a polygon (in geo coordinates).
+   */
+  insidePolygon?: number[];
+
+  /**
+   * This parameter changes the default values of certain parameters and settings that work best for a natural language query, such as ignorePlurals, removeStopWords, removeWordsIfNoResults, analyticsTags and ruleContexts. These parameters and settings work well together when the query is formatted in natural language instead of keywords, for example when your user performs a voice search.
+   */
+  naturalLanguages?: string[];
+
+  /**
+   * Enables contextual rules.
+   */
+  ruleContexts?: string[];
+
+  /**
+   * Define the impact of the Personalization feature.
+   */
+  personalizationImpact?: number;
+
+  /**
+   * Associates a certain user token with the current search.
+   */
+  userToken?: string;
+
+  /**
+   * Retrieve detailed ranking information.
+   */
+  getRankingInfo?: boolean;
+
+  /**
+   * Enable the Click Analytics feature.
+   */
+  clickAnalytics?: boolean;
+
+  /**
+   * Whether the current query will be taken into account in the Analytics.
+   */
+  analytics?: boolean;
+
+  /**
+   * List of tags to apply to the query for analytics purposes.
+   */
+  analyticsTags?: string[];
+
+  /**
+   * Whether to include or exclude a query from the processing-time percentile computation.
+   */
+  percentileComputation?: boolean;
+
+  /**
+   * Whether this search should participate in running AB tests.
+   */
+  enableABTest?: boolean;
+
+  /**
+   * Whether this search should use AI Re-Ranking.
+   */
+  enableReRanking?: boolean;
+
+  reRankingApplyFilter?: ReRankingApplyFilter | null;
+};