algoliasearch 4.14.2 → 5.0.0-alpha.11

package/lite/model/searchForFacets.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 { SearchForFacetsOptions } from './searchForFacetsOptions';
+import type { SearchParams } from './searchParams';
+
+export type SearchForFacets = SearchForFacetsOptions & SearchParams;

package/lite/model/searchForFacetsOptions.ts

@@ -0,0 +1,27 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+import type { SearchTypeFacet } from './searchTypeFacet';
+
+export type SearchForFacetsOptions = {
+  /**
+   * The `facet` name.
+   */
+  facet: string;
+
+  /**
+   * The Algolia index name.
+   */
+  indexName: string;
+
+  /**
+   * Text to search inside the facet\'s values.
+   */
+  facetQuery?: string;
+
+  /**
+   * Maximum number of facet hits to return during a search for facet values. For performance reasons, the maximum allowed number of returned values is 100.
+   */
+  maxFacetHits?: number;
+
+  type: SearchTypeFacet;
+};

package/lite/model/searchForHits.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 { SearchForHitsOptions } from './searchForHitsOptions';
+import type { SearchParams } from './searchParams';
+
+export type SearchForHits = SearchForHitsOptions & SearchParams;

package/lite/model/searchForHitsOptions.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 { SearchTypeDefault } from './searchTypeDefault';
+
+export type SearchForHitsOptions = {
+  /**
+   * The Algolia index name.
+   */
+  indexName: string;
+
+  type?: SearchTypeDefault;
+} & { facet?: never; maxFacetHits?: never; facetQuery?: never };

package/lite/model/searchHits.ts

@@ -0,0 +1,7 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+import type { Hit } from './hit';
+
+export type SearchHits<T = Record<string, any>> = {
+  hits: Array<Hit<T>>;
+};

package/lite/model/searchMethodParams.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 { SearchQuery } from './searchQuery';
+import type { SearchStrategy } from './searchStrategy';
+
+export type SearchMethodParams = {
+  requests: SearchQuery[];
+
+  strategy?: SearchStrategy;
+};

package/lite/model/searchParams.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 { SearchParamsObject } from './searchParamsObject';
+import type { SearchParamsString } from './searchParamsString';
+
+export type SearchParams = SearchParamsObject | SearchParamsString;

package/lite/model/searchParamsObject.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 { BaseSearchParams } from './baseSearchParams';
+import type { IndexSettingsAsSearchParams } from './indexSettingsAsSearchParams';
+
+export type SearchParamsObject = BaseSearchParams & IndexSettingsAsSearchParams;

package/lite/model/searchParamsQuery.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 SearchParamsQuery = {
+  /**
+   * The text to search in the index.
+   */
+  query?: string;
+};

package/lite/model/searchParamsString.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 SearchParamsString = {
+  /**
+   * Search parameters as URL-encoded query string.
+   */
+  params?: string;
+};

package/lite/model/searchQuery.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 { SearchForFacets } from './searchForFacets';
+import type { SearchForHits } from './searchForHits';
+
+export type SearchQuery = SearchForFacets | SearchForHits;

package/lite/model/searchResponse.ts

@@ -0,0 +1,7 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+import type { BaseSearchResponse } from './baseSearchResponse';
+import type { SearchHits } from './searchHits';
+
+export type SearchResponse<T = Record<string, any>> = BaseSearchResponse &
+  SearchHits<T>;

package/lite/model/searchResponses.ts

@@ -0,0 +1,7 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+import type { SearchResponse } from './searchResponse';
+
+export type SearchResponses<T = Record<string, any>> = {
+  results: Array<SearchResponse<T>>;
+};

package/lite/model/searchStrategy.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 SearchStrategy = 'none' | 'stopIfEnoughMatches';

package/lite/model/searchSynonymsResponse.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 { SynonymHit } from './synonymHit';
+
+export type SearchSynonymsResponse = Record<string, any> & {
+  /**
+   * Array of synonym objects.
+   */
+  hits: SynonymHit[];
+
+  /**
+   * Number of hits that the search query matched.
+   */
+  nbHits: number;
+};

package/lite/model/searchTypeDefault.ts

@@ -0,0 +1,6 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+/**
+ * Perform a search query with `default`, will search for facet values if `facet` is given.
+ */
+export type SearchTypeDefault = 'default';

package/lite/model/searchTypeFacet.ts

@@ -0,0 +1,6 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+/**
+ * Perform a search query with `default`, will search for facet values if `facet` is given.
+ */
+export type SearchTypeFacet = 'facet';

package/lite/model/snippetResult.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 { SnippetResultOption } from './snippetResultOption';
+
+export type SnippetResult = SnippetResultOption | SnippetResultOption[];

package/lite/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/lite/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/lite/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/lite/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/lite/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/lite/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/lite/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/lite/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/lite/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/lite/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/lite/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/lite/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/lite/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/lite/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/lite/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/lite/src/liteClient.ts

@@ -0,0 +1,228 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+import {
+  createAuth,
+  createTransporter,
+  getAlgoliaAgent,
+  shuffle,
+} from '@algolia/client-common';
+import type {
+  CreateClientOptions,
+  Headers,
+  Host,
+  Request,
+  RequestOptions,
+  QueryParameters,
+} from '@algolia/client-common';
+
+import type {
+  PostProps,
+  LegacySearchMethodProps,
+} from '../model/clientMethodProps';
+import type { SearchMethodParams } from '../model/searchMethodParams';
+import type { SearchResponses } from '../model/searchResponses';
+
+export const apiClientVersion = '5.0.0-alpha.11';
+
+function getDefaultHosts(appId: string): Host[] {
+  return (
+    [
+      {
+        url: `${appId}-dsn.algolia.net`,
+        accept: 'read',
+        protocol: 'https',
+      },
+      {
+        url: `${appId}.algolia.net`,
+        accept: 'write',
+        protocol: 'https',
+      },
+    ] as Host[]
+  ).concat(
+    shuffle([
+      {
+        url: `${appId}-1.algolianet.com`,
+        accept: 'readWrite',
+        protocol: 'https',
+      },
+      {
+        url: `${appId}-2.algolianet.com`,
+        accept: 'readWrite',
+        protocol: 'https',
+      },
+      {
+        url: `${appId}-3.algolianet.com`,
+        accept: 'readWrite',
+        protocol: 'https',
+      },
+    ])
+  );
+}
+
+// eslint-disable-next-line @typescript-eslint/explicit-function-return-type
+export function createLiteClient({
+  appId: appIdOption,
+  apiKey: apiKeyOption,
+  authMode,
+  algoliaAgents,
+  ...options
+}: CreateClientOptions) {
+  const auth = createAuth(appIdOption, apiKeyOption, authMode);
+  const transporter = createTransporter({
+    hosts: getDefaultHosts(appIdOption),
+    ...options,
+    algoliaAgent: getAlgoliaAgent({
+      algoliaAgents,
+      client: 'Lite',
+      version: apiClientVersion,
+    }),
+    baseHeaders: {
+      'content-type': 'text/plain',
+      ...auth.headers(),
+      ...options.baseHeaders,
+    },
+    baseQueryParameters: {
+      ...auth.queryParameters(),
+      ...options.baseQueryParameters,
+    },
+  });
+
+  return {
+    transporter,
+
+    /**
+     * The `appId` currently in use.
+     */
+    appId: appIdOption,
+
+    /**
+     * Clears the cache of the transporter for the `requestsCache` and `responsesCache` properties.
+     */
+    clearCache(): Promise<void> {
+      return Promise.all([
+        transporter.requestsCache.clear(),
+        transporter.responsesCache.clear(),
+      ]).then(() => undefined);
+    },
+
+    /**
+     * Get the value of the `algoliaAgent`, used by our libraries internally and telemetry system.
+     */
+    get _ua(): string {
+      return transporter.algoliaAgent.value;
+    },
+
+    /**
+     * 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 {
+      transporter.algoliaAgent.add({ segment, version });
+    },
+
+    /**
+     * 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>> {
+      if (!path) {
+        throw new Error('Parameter `path` is required when calling `post`.');
+      }
+
+      const requestPath = '/1{path}'.replace('{path}', path);
+      const headers: Headers = {};
+      const queryParameters: QueryParameters = parameters ? parameters : {};
+
+      const request: Request = {
+        method: 'POST',
+        path: requestPath,
+        queryParameters,
+        headers,
+        data: body ? body : {},
+      };
+
+      return transporter.request(request, requestOptions);
+    },
+
+    /**
+     * 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>> {
+      if (searchMethodParams && Array.isArray(searchMethodParams)) {
+        const newSignatureRequest: SearchMethodParams = {
+          requests: searchMethodParams.map(({ params, ...legacyRequest }) => {
+            if (legacyRequest.type === 'facet') {
+              return {
+                ...legacyRequest,
+                ...params,
+                type: 'facet',
+              };
+            }
+
+            return {
+              ...legacyRequest,
+              ...params,
+              facet: undefined,
+              maxFacetHits: undefined,
+              facetQuery: undefined,
+            };
+          }),
+        };
+
+        // eslint-disable-next-line no-param-reassign
+        searchMethodParams = newSignatureRequest;
+      }
+
+      if (!searchMethodParams) {
+        throw new Error(
+          'Parameter `searchMethodParams` is required when calling `search`.'
+        );
+      }
+
+      if (!searchMethodParams.requests) {
+        throw new Error(
+          'Parameter `searchMethodParams.requests` is required when calling `search`.'
+        );
+      }
+
+      const requestPath = '/1/indexes/*/queries';
+      const headers: Headers = {};
+      const queryParameters: QueryParameters = {};
+
+      const request: Request = {
+        method: 'POST',
+        path: requestPath,
+        queryParameters,
+        headers,
+        data: searchMethodParams,
+        useReadTransporter: true,
+        cacheable: true,
+      };
+
+      return transporter.request(request, requestOptions);
+    },
+  };
+}
+
+/**
+ * The client type.
+ */
+export type LiteClient = ReturnType<typeof createLiteClient>;

package/lite/tsconfig.json

@@ -0,0 +1,9 @@
+{
+  "extends": "../tsconfig.json",
+  "compilerOptions": {
+    "types": ["node"],
+    "outDir": "dist/lite"
+  },
+  "include": ["builds", "model", "src"],
+  "exclude": ["dist", "node_modules"]
+}