algoliasearch 5.2.4 → 5.2.5

package/dist/node.cjs

@@ -0,0 +1,161 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __reExport = (target, mod, secondTarget) => (__copyProps(target, mod, "default"), secondTarget && __copyProps(secondTarget, mod, "default"));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// builds/node.ts
+var node_exports = {};
+__export(node_exports, {
+  algoliasearch: () => algoliasearch,
+  apiClientVersion: () => import_client_search.apiClientVersion
+});
+module.exports = __toCommonJS(node_exports);
+var import_node_crypto = require("crypto");
+var import_client_abtesting = require("@algolia/client-abtesting");
+var import_client_analytics = require("@algolia/client-analytics");
+var import_client_common = require("@algolia/client-common");
+var import_client_personalization = require("@algolia/client-personalization");
+var import_client_search2 = require("@algolia/client-search");
+var import_recommend = require("@algolia/recommend");
+var import_requester_node_http = require("@algolia/requester-node-http");
+
+// builds/models.ts
+var models_exports = {};
+__export(models_exports, {
+  apiClientVersion: () => import_client_search.apiClientVersion
+});
+var import_client_search = require("@algolia/client-search");
+__reExport(models_exports, require("@algolia/client-search"));
+__reExport(models_exports, require("@algolia/recommend"));
+__reExport(models_exports, require("@algolia/client-personalization"));
+__reExport(models_exports, require("@algolia/client-analytics"));
+__reExport(models_exports, require("@algolia/client-abtesting"));
+
+// builds/node.ts
+__reExport(node_exports, models_exports, module.exports);
+function algoliasearch(appId, apiKey, options) {
+  if (!appId || typeof appId !== "string") {
+    throw new Error("`appId` is missing.");
+  }
+  if (!apiKey || typeof apiKey !== "string") {
+    throw new Error("`apiKey` is missing.");
+  }
+  function initRecommend(initOptions = {}) {
+    return (0, import_recommend.recommendClient)(initOptions.appId || appId, initOptions.apiKey || apiKey, initOptions.options);
+  }
+  function initAnalytics(initOptions = {}) {
+    return (0, import_client_analytics.analyticsClient)(
+      initOptions.appId || appId,
+      initOptions.apiKey || apiKey,
+      initOptions.region,
+      initOptions.options
+    );
+  }
+  function initAbtesting(initOptions = {}) {
+    return (0, import_client_abtesting.abtestingClient)(
+      initOptions.appId || appId,
+      initOptions.apiKey || apiKey,
+      initOptions.region,
+      initOptions.options
+    );
+  }
+  function initPersonalization(initOptions) {
+    return (0, import_client_personalization.personalizationClient)(
+      initOptions.appId || appId,
+      initOptions.apiKey || apiKey,
+      initOptions.region,
+      initOptions.options
+    );
+  }
+  return {
+    ...(0, import_client_search2.searchClient)(appId, apiKey, {
+      timeouts: {
+        connect: import_client_common.DEFAULT_CONNECT_TIMEOUT_NODE,
+        read: import_client_common.DEFAULT_READ_TIMEOUT_NODE,
+        write: import_client_common.DEFAULT_WRITE_TIMEOUT_NODE
+      },
+      requester: (0, import_requester_node_http.createHttpRequester)(),
+      algoliaAgents: [{ segment: "Node.js", version: process.versions.node }],
+      responsesCache: (0, import_client_common.createNullCache)(),
+      requestsCache: (0, import_client_common.createNullCache)(),
+      hostsCache: (0, import_client_common.createMemoryCache)(),
+      ...options
+    }),
+    /**
+     * Get the value of the `algoliaAgent`, used by our libraries internally and telemetry system.
+     */
+    get _ua() {
+      return this.transporter.algoliaAgent.value;
+    },
+    initAbtesting,
+    initAnalytics,
+    initPersonalization,
+    initRecommend,
+    /**
+     * Helper: Generates a secured API key based on the given `parentApiKey` and given `restrictions`.
+     *
+     * @summary Helper: Generates a secured API key based on the given `parentApiKey` and given `restrictions`.
+     * @param generateSecuredApiKey - The `generateSecuredApiKey` object.
+     * @param generateSecuredApiKey.parentApiKey - The base API key from which to generate the new secured one.
+     * @param generateSecuredApiKey.restrictions - A set of properties defining the restrictions of the secured API key.
+     */
+    generateSecuredApiKey({ parentApiKey, restrictions = {} }) {
+      let mergedRestrictions = restrictions;
+      if (restrictions.searchParams) {
+        mergedRestrictions = {
+          ...restrictions,
+          ...restrictions.searchParams
+        };
+        delete mergedRestrictions.searchParams;
+      }
+      mergedRestrictions = Object.keys(mergedRestrictions).sort().reduce(
+        (acc, key) => {
+          acc[key] = mergedRestrictions[key];
+          return acc;
+        },
+        {}
+      );
+      const queryParameters = (0, import_client_common.serializeQueryParameters)(mergedRestrictions);
+      return Buffer.from(
+        (0, import_node_crypto.createHmac)("sha256", parentApiKey).update(queryParameters).digest("hex") + queryParameters
+      ).toString("base64");
+    },
+    /**
+     * Helper: Retrieves the remaining validity of the previous generated `securedApiKey`, the `ValidUntil` parameter must have been provided.
+     *
+     * @summary Helper: Retrieves the remaining validity of the previous generated `secured_api_key`, the `ValidUntil` parameter must have been provided.
+     * @param getSecuredApiKeyRemainingValidity - The `getSecuredApiKeyRemainingValidity` object.
+     * @param getSecuredApiKeyRemainingValidity.securedApiKey - The secured API key generated with the `generateSecuredApiKey` method.
+     */
+    getSecuredApiKeyRemainingValidity({ securedApiKey }) {
+      const decodedString = Buffer.from(securedApiKey, "base64").toString("ascii");
+      const regex = /validUntil=(\d+)/;
+      const match = decodedString.match(regex);
+      if (match === null) {
+        throw new Error("validUntil not found in given secured api key.");
+      }
+      return parseInt(match[1], 10) - Math.round((/* @__PURE__ */ new Date()).getTime() / 1e3);
+    }
+  };
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  algoliasearch,
+  apiClientVersion
+});
+//# sourceMappingURL=node.cjs.map

package/dist/node.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../builds/node.ts","../builds/models.ts"],"sourcesContent":["// 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.\n\nimport { createHmac } from 'node:crypto';\n\nimport type { AbtestingClient, Region as AbtestingRegion } from '@algolia/client-abtesting';\nimport { abtestingClient } from '@algolia/client-abtesting';\nimport type { AnalyticsClient, Region as AnalyticsRegion } from '@algolia/client-analytics';\nimport { analyticsClient } from '@algolia/client-analytics';\nimport {\n  DEFAULT_CONNECT_TIMEOUT_NODE,\n  DEFAULT_READ_TIMEOUT_NODE,\n  DEFAULT_WRITE_TIMEOUT_NODE,\n  createMemoryCache,\n  createNullCache,\n  serializeQueryParameters,\n} from '@algolia/client-common';\nimport type { ClientOptions } from '@algolia/client-common';\nimport type { PersonalizationClient, Region as PersonalizationRegion } from '@algolia/client-personalization';\nimport { personalizationClient } from '@algolia/client-personalization';\nimport { searchClient } from '@algolia/client-search';\nimport type { RecommendClient } from '@algolia/recommend';\nimport { recommendClient } from '@algolia/recommend';\nimport { createHttpRequester } from '@algolia/requester-node-http';\n\nimport type {\n  InitClientOptions,\n  InitClientRegion,\n  GenerateSecuredApiKeyOptions,\n  GetSecuredApiKeyRemainingValidityOptions,\n} from './models';\n\nexport * from './models';\n\n/**\n * The client type.\n */\nexport type Algoliasearch = ReturnType<typeof algoliasearch>;\n\n// eslint-disable-next-line @typescript-eslint/explicit-function-return-type\nexport function algoliasearch(appId: string, apiKey: string, options?: ClientOptions) {\n  if (!appId || typeof appId !== 'string') {\n    throw new Error('`appId` is missing.');\n  }\n\n  if (!apiKey || typeof apiKey !== 'string') {\n    throw new Error('`apiKey` is missing.');\n  }\n  function initRecommend(initOptions: InitClientOptions = {}): RecommendClient {\n    return recommendClient(initOptions.appId || appId, initOptions.apiKey || apiKey, initOptions.options);\n  }\n\n  function initAnalytics(initOptions: InitClientOptions & InitClientRegion<AnalyticsRegion> = {}): AnalyticsClient {\n    return analyticsClient(\n      initOptions.appId || appId,\n      initOptions.apiKey || apiKey,\n      initOptions.region,\n      initOptions.options,\n    );\n  }\n\n  function initAbtesting(initOptions: InitClientOptions & InitClientRegion<AbtestingRegion> = {}): AbtestingClient {\n    return abtestingClient(\n      initOptions.appId || appId,\n      initOptions.apiKey || apiKey,\n      initOptions.region,\n      initOptions.options,\n    );\n  }\n\n  function initPersonalization(\n    initOptions: InitClientOptions & Required<InitClientRegion<PersonalizationRegion>>,\n  ): PersonalizationClient {\n    return personalizationClient(\n      initOptions.appId || appId,\n      initOptions.apiKey || apiKey,\n      initOptions.region,\n      initOptions.options,\n    );\n  }\n\n  return {\n    ...searchClient(appId, apiKey, {\n      timeouts: {\n        connect: DEFAULT_CONNECT_TIMEOUT_NODE,\n        read: DEFAULT_READ_TIMEOUT_NODE,\n        write: DEFAULT_WRITE_TIMEOUT_NODE,\n      },\n      requester: createHttpRequester(),\n      algoliaAgents: [{ segment: 'Node.js', version: process.versions.node }],\n      responsesCache: createNullCache(),\n      requestsCache: createNullCache(),\n      hostsCache: createMemoryCache(),\n      ...options,\n    }),\n    /**\n     * Get the value of the `algoliaAgent`, used by our libraries internally and telemetry system.\n     */\n    get _ua(): string {\n      return this.transporter.algoliaAgent.value;\n    },\n    initAbtesting,\n    initAnalytics,\n    initPersonalization,\n    initRecommend,\n    /**\n     * Helper: Generates a secured API key based on the given `parentApiKey` and given `restrictions`.\n     *\n     * @summary Helper: Generates a secured API key based on the given `parentApiKey` and given `restrictions`.\n     * @param generateSecuredApiKey - The `generateSecuredApiKey` object.\n     * @param generateSecuredApiKey.parentApiKey - The base API key from which to generate the new secured one.\n     * @param generateSecuredApiKey.restrictions - A set of properties defining the restrictions of the secured API key.\n     */\n    generateSecuredApiKey({ parentApiKey, restrictions = {} }: GenerateSecuredApiKeyOptions): string {\n      let mergedRestrictions = restrictions;\n      if (restrictions.searchParams) {\n        // merge searchParams with the root restrictions\n        mergedRestrictions = {\n          ...restrictions,\n          ...restrictions.searchParams,\n        };\n\n        delete mergedRestrictions.searchParams;\n      }\n\n      mergedRestrictions = Object.keys(mergedRestrictions)\n        .sort()\n        .reduce(\n          (acc, key) => {\n            // eslint-disable-next-line no-param-reassign\n            acc[key] = (mergedRestrictions as any)[key];\n            return acc;\n          },\n          {} as Record<string, unknown>,\n        );\n\n      const queryParameters = serializeQueryParameters(mergedRestrictions);\n      return Buffer.from(\n        createHmac('sha256', parentApiKey).update(queryParameters).digest('hex') + queryParameters,\n      ).toString('base64');\n    },\n\n    /**\n     * Helper: Retrieves the remaining validity of the previous generated `securedApiKey`, the `ValidUntil` parameter must have been provided.\n     *\n     * @summary Helper: Retrieves the remaining validity of the previous generated `secured_api_key`, the `ValidUntil` parameter must have been provided.\n     * @param getSecuredApiKeyRemainingValidity - The `getSecuredApiKeyRemainingValidity` object.\n     * @param getSecuredApiKeyRemainingValidity.securedApiKey - The secured API key generated with the `generateSecuredApiKey` method.\n     */\n    getSecuredApiKeyRemainingValidity({ securedApiKey }: GetSecuredApiKeyRemainingValidityOptions): number {\n      const decodedString = Buffer.from(securedApiKey, 'base64').toString('ascii');\n      const regex = /validUntil=(\\d+)/;\n      const match = decodedString.match(regex);\n\n      if (match === null) {\n        throw new Error('validUntil not found in given secured api key.');\n      }\n\n      return parseInt(match[1], 10) - Math.round(new Date().getTime() / 1000);\n    },\n  };\n}\n","// 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.\n\nimport type { Region as ABTestingRegion } from '@algolia/client-abtesting';\nimport type { Region as AnalyticsRegion } from '@algolia/client-analytics';\nimport type { ClientOptions } from '@algolia/client-common';\nimport type {\n  AdvancedSyntaxFeatures,\n  AlternativesAsExact,\n  Anchoring,\n  AroundPrecision,\n  AroundRadius,\n  AroundRadiusAll,\n  AutomaticFacetFilter,\n  AutomaticFacetFilters,\n  BaseSearchParams,\n  BaseSearchParamsWithoutQuery,\n  BaseSearchResponse,\n  BooleanString,\n  Condition,\n  Consequence,\n  ConsequenceHide,\n  ConsequenceParams,\n  ConsequenceQuery,\n  ConsequenceQueryObject,\n  CustomDeleteProps,\n  CustomGetProps,\n  CustomPostProps,\n  CustomPutProps,\n  DeletedAtResponse,\n  Distinct,\n  Edit,\n  EditType,\n  ErrorBase,\n  ExactOnSingleWordQuery,\n  Exhaustive,\n  FacetFilters,\n  FacetOrdering,\n  Facets,\n  FacetStats,\n  HighlightResult,\n  HighlightResultOption,\n  IgnorePlurals,\n  IndexSettingsAsSearchParams,\n  MatchLevel,\n  MatchedGeoLocation,\n  Mode,\n  NumericFilters,\n  OptionalFilters,\n  Params,\n  Personalization,\n  Promote,\n  PromoteObjectID,\n  PromoteObjectIDs,\n  QueryType,\n  Range,\n  RankingInfo,\n  ReRankingApplyFilter,\n  Redirect,\n  RedirectRuleIndexMetadata,\n  RedirectRuleIndexData,\n  RedirectURL,\n  RemoveStopWords,\n  RemoveWordsIfNoResults,\n  RenderingContent,\n  SearchPagination,\n  SearchParams,\n  SearchParamsObject,\n  SearchParamsQuery,\n  SemanticSearch,\n  SnippetResult,\n  SnippetResultOption,\n  SortRemainingBy,\n  SupportedLanguage,\n  TagFilters,\n  TaskStatus,\n  TypoTolerance,\n  TypoToleranceEnum,\n  Value,\n} from '@algolia/client-search';\nimport { apiClientVersion } from '@algolia/client-search';\n\ntype Region = ABTestingRegion | AnalyticsRegion;\n\nexport * from '@algolia/client-search';\nexport * from '@algolia/recommend';\nexport * from '@algolia/client-personalization';\nexport * from '@algolia/client-analytics';\nexport * from '@algolia/client-abtesting';\n\nexport {\n  AdvancedSyntaxFeatures,\n  AlternativesAsExact,\n  Anchoring,\n  AroundPrecision,\n  AroundRadius,\n  AroundRadiusAll,\n  AutomaticFacetFilter,\n  AutomaticFacetFilters,\n  BaseSearchParams,\n  BaseSearchParamsWithoutQuery,\n  BaseSearchResponse,\n  BooleanString,\n  Condition,\n  Consequence,\n  ConsequenceHide,\n  ConsequenceParams,\n  ConsequenceQuery,\n  ConsequenceQueryObject,\n  CustomDeleteProps,\n  CustomGetProps,\n  CustomPostProps,\n  CustomPutProps,\n  DeletedAtResponse,\n  Distinct,\n  Edit,\n  EditType,\n  ErrorBase,\n  ExactOnSingleWordQuery,\n  Exhaustive,\n  FacetFilters,\n  FacetOrdering,\n  Facets,\n  FacetStats,\n  HighlightResult,\n  HighlightResultOption,\n  IgnorePlurals,\n  IndexSettingsAsSearchParams,\n  MatchLevel,\n  MatchedGeoLocation,\n  Mode,\n  NumericFilters,\n  OptionalFilters,\n  Params,\n  Personalization,\n  Promote,\n  PromoteObjectID,\n  PromoteObjectIDs,\n  QueryType,\n  Range,\n  RankingInfo,\n  ReRankingApplyFilter,\n  Redirect,\n  RedirectRuleIndexMetadata,\n  RedirectRuleIndexData,\n  RedirectURL,\n  RemoveStopWords,\n  RemoveWordsIfNoResults,\n  RenderingContent,\n  SearchParams,\n  SearchParamsObject,\n  SearchParamsQuery,\n  SemanticSearch,\n  SearchPagination,\n  SnippetResult,\n  SnippetResultOption,\n  SortRemainingBy,\n  SupportedLanguage,\n  TagFilters,\n  TaskStatus,\n  TypoTolerance,\n  TypoToleranceEnum,\n  Value,\n  AnalyticsRegion,\n  ABTestingRegion,\n  Region,\n  apiClientVersion,\n};\n\n/**\n * Options forwarded to the client initialized via the `init` method.\n */\nexport type InitClientOptions = Partial<{\n  /**\n   * App to target with the initialized client, defaults to the `algoliasearch` appId.\n   */\n  appId: string;\n  /**\n   * API key of the targeted app ID, defaults to the `algoliasearch` apiKey.\n   */\n  apiKey: string;\n  options: ClientOptions;\n}>;\n\nexport type InitClientRegion<TRegion> = Partial<{\n  /**\n   * Available regions of the initialized client.\n   */\n  region: TRegion;\n}>;\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAEA,yBAA2B;AAG3B,8BAAgC;AAEhC,8BAAgC;AAChC,2BAOO;AAGP,oCAAsC;AACtC,IAAAA,wBAA6B;AAE7B,uBAAgC;AAChC,iCAAoC;;;ACtBpC;AAAA;AAAA;AAAA;AA+EA,2BAAiC;AAIjC,2BAAc;AACd,2BAAc;AACd,2BAAc;AACd,2BAAc;AACd,2BAAc;;;ADxDd,yBAAc,gBA/Bd;AAuCO,SAAS,cAAc,OAAe,QAAgB,SAAyB;AACpF,MAAI,CAAC,SAAS,OAAO,UAAU,UAAU;AACvC,UAAM,IAAI,MAAM,qBAAqB;AAAA,EACvC;AAEA,MAAI,CAAC,UAAU,OAAO,WAAW,UAAU;AACzC,UAAM,IAAI,MAAM,sBAAsB;AAAA,EACxC;AACA,WAAS,cAAc,cAAiC,CAAC,GAAoB;AAC3E,eAAO,kCAAgB,YAAY,SAAS,OAAO,YAAY,UAAU,QAAQ,YAAY,OAAO;AAAA,EACtG;AAEA,WAAS,cAAc,cAAqE,CAAC,GAAoB;AAC/G,eAAO;AAAA,MACL,YAAY,SAAS;AAAA,MACrB,YAAY,UAAU;AAAA,MACtB,YAAY;AAAA,MACZ,YAAY;AAAA,IACd;AAAA,EACF;AAEA,WAAS,cAAc,cAAqE,CAAC,GAAoB;AAC/G,eAAO;AAAA,MACL,YAAY,SAAS;AAAA,MACrB,YAAY,UAAU;AAAA,MACtB,YAAY;AAAA,MACZ,YAAY;AAAA,IACd;AAAA,EACF;AAEA,WAAS,oBACP,aACuB;AACvB,eAAO;AAAA,MACL,YAAY,SAAS;AAAA,MACrB,YAAY,UAAU;AAAA,MACtB,YAAY;AAAA,MACZ,YAAY;AAAA,IACd;AAAA,EACF;AAEA,SAAO;AAAA,IACL,OAAG,oCAAa,OAAO,QAAQ;AAAA,MAC7B,UAAU;AAAA,QACR,SAAS;AAAA,QACT,MAAM;AAAA,QACN,OAAO;AAAA,MACT;AAAA,MACA,eAAW,gDAAoB;AAAA,MAC/B,eAAe,CAAC,EAAE,SAAS,WAAW,SAAS,QAAQ,SAAS,KAAK,CAAC;AAAA,MACtE,oBAAgB,sCAAgB;AAAA,MAChC,mBAAe,sCAAgB;AAAA,MAC/B,gBAAY,wCAAkB;AAAA,MAC9B,GAAG;AAAA,IACL,CAAC;AAAA;AAAA;AAAA;AAAA,IAID,IAAI,MAAc;AAChB,aAAO,KAAK,YAAY,aAAa;AAAA,IACvC;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IASA,sBAAsB,EAAE,cAAc,eAAe,CAAC,EAAE,GAAyC;AAC/F,UAAI,qBAAqB;AACzB,UAAI,aAAa,cAAc;AAE7B,6BAAqB;AAAA,UACnB,GAAG;AAAA,UACH,GAAG,aAAa;AAAA,QAClB;AAEA,eAAO,mBAAmB;AAAA,MAC5B;AAEA,2BAAqB,OAAO,KAAK,kBAAkB,EAChD,KAAK,EACL;AAAA,QACC,CAAC,KAAK,QAAQ;AAEZ,cAAI,GAAG,IAAK,mBAA2B,GAAG;AAC1C,iBAAO;AAAA,QACT;AAAA,QACA,CAAC;AAAA,MACH;AAEF,YAAM,sBAAkB,+CAAyB,kBAAkB;AACnE,aAAO,OAAO;AAAA,YACZ,+BAAW,UAAU,YAAY,EAAE,OAAO,eAAe,EAAE,OAAO,KAAK,IAAI;AAAA,MAC7E,EAAE,SAAS,QAAQ;AAAA,IACrB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IASA,kCAAkC,EAAE,cAAc,GAAqD;AACrG,YAAM,gBAAgB,OAAO,KAAK,eAAe,QAAQ,EAAE,SAAS,OAAO;AAC3E,YAAM,QAAQ;AACd,YAAM,QAAQ,cAAc,MAAM,KAAK;AAEvC,UAAI,UAAU,MAAM;AAClB,cAAM,IAAI,MAAM,gDAAgD;AAAA,MAClE;AAEA,aAAO,SAAS,MAAM,CAAC,GAAG,EAAE,IAAI,KAAK,OAAM,oBAAI,KAAK,GAAE,QAAQ,IAAI,GAAI;AAAA,IACxE;AAAA,EACF;AACF;","names":["import_client_search"]}

package/dist/node.d.cts

@@ -0,0 +1,153 @@
+import * as _algolia_client_search from '@algolia/client-search';
+import { GenerateSecuredApiKeyOptions, GetSecuredApiKeyRemainingValidityOptions } from '@algolia/client-search';
+export * from '@algolia/client-search';
+export { AdvancedSyntaxFeatures, AlternativesAsExact, Anchoring, AroundPrecision, AroundRadius, AroundRadiusAll, AutomaticFacetFilter, AutomaticFacetFilters, BaseSearchParams, BaseSearchParamsWithoutQuery, BaseSearchResponse, BooleanString, Condition, Consequence, ConsequenceHide, ConsequenceParams, ConsequenceQuery, ConsequenceQueryObject, CustomDeleteProps, CustomGetProps, CustomPostProps, CustomPutProps, DeletedAtResponse, Distinct, Edit, EditType, ErrorBase, ExactOnSingleWordQuery, Exhaustive, FacetFilters, FacetOrdering, FacetStats, Facets, HighlightResult, HighlightResultOption, IgnorePlurals, IndexSettingsAsSearchParams, MatchLevel, MatchedGeoLocation, Mode, NumericFilters, OptionalFilters, Params, Personalization, Promote, PromoteObjectID, PromoteObjectIDs, QueryType, Range, RankingInfo, ReRankingApplyFilter, Redirect, RedirectRuleIndexData, RedirectRuleIndexMetadata, RedirectURL, RemoveStopWords, RemoveWordsIfNoResults, RenderingContent, SearchPagination, SearchParams, SearchParamsObject, SearchParamsQuery, SemanticSearch, SnippetResult, SnippetResultOption, SortRemainingBy, SupportedLanguage, TagFilters, TaskStatus, TypoTolerance, TypoToleranceEnum, Value, apiClientVersion } from '@algolia/client-search';
+import * as _algolia_client_common from '@algolia/client-common';
+import { ClientOptions } from '@algolia/client-common';
+import { Region as Region$1, AbtestingClient } from '@algolia/client-abtesting';
+export * from '@algolia/client-abtesting';
+export { Region as ABTestingRegion } from '@algolia/client-abtesting';
+import { Region as Region$2, AnalyticsClient } from '@algolia/client-analytics';
+export * from '@algolia/client-analytics';
+export { Region as AnalyticsRegion } from '@algolia/client-analytics';
+import { Region as Region$3, PersonalizationClient } from '@algolia/client-personalization';
+export * from '@algolia/client-personalization';
+import { RecommendClient } from '@algolia/recommend';
+export * from '@algolia/recommend';
+
+type Region = Region$1 | Region$2;
+
+/**
+ * Options forwarded to the client initialized via the `init` method.
+ */
+type InitClientOptions = Partial<{
+    /**
+     * App to target with the initialized client, defaults to the `algoliasearch` appId.
+     */
+    appId: string;
+    /**
+     * API key of the targeted app ID, defaults to the `algoliasearch` apiKey.
+     */
+    apiKey: string;
+    options: ClientOptions;
+}>;
+type InitClientRegion<TRegion> = Partial<{
+    /**
+     * Available regions of the initialized client.
+     */
+    region: TRegion;
+}>;
+
+/**
+ * The client type.
+ */
+type Algoliasearch = ReturnType<typeof algoliasearch>;
+declare function algoliasearch(appId: string, apiKey: string, options?: ClientOptions): {
+    _ua: string;
+    initAbtesting: (initOptions?: InitClientOptions & InitClientRegion<Region$1>) => AbtestingClient;
+    initAnalytics: (initOptions?: InitClientOptions & InitClientRegion<Region$2>) => AnalyticsClient;
+    initPersonalization: (initOptions: InitClientOptions & Required<InitClientRegion<Region$3>>) => PersonalizationClient;
+    initRecommend: (initOptions?: InitClientOptions) => RecommendClient;
+    /**
+     * Helper: Generates a secured API key based on the given `parentApiKey` and given `restrictions`.
+     *
+     * @summary Helper: Generates a secured API key based on the given `parentApiKey` and given `restrictions`.
+     * @param generateSecuredApiKey - The `generateSecuredApiKey` object.
+     * @param generateSecuredApiKey.parentApiKey - The base API key from which to generate the new secured one.
+     * @param generateSecuredApiKey.restrictions - A set of properties defining the restrictions of the secured API key.
+     */
+    generateSecuredApiKey({ parentApiKey, restrictions }: GenerateSecuredApiKeyOptions): string;
+    /**
+     * Helper: Retrieves the remaining validity of the previous generated `securedApiKey`, the `ValidUntil` parameter must have been provided.
+     *
+     * @summary Helper: Retrieves the remaining validity of the previous generated `secured_api_key`, the `ValidUntil` parameter must have been provided.
+     * @param getSecuredApiKeyRemainingValidity - The `getSecuredApiKeyRemainingValidity` object.
+     * @param getSecuredApiKeyRemainingValidity.securedApiKey - The secured API key generated with the `generateSecuredApiKey` method.
+     */
+    getSecuredApiKeyRemainingValidity({ securedApiKey }: GetSecuredApiKeyRemainingValidityOptions): number;
+    transporter: _algolia_client_common.Transporter;
+    appId: string;
+    clearCache(): Promise<void>;
+    addAlgoliaAgent(segment: string, version?: string): void;
+    waitForTask({ indexName, taskID, maxRetries, timeout, }: _algolia_client_search.WaitForTaskOptions, requestOptions?: _algolia_client_common.RequestOptions): Promise<_algolia_client_search.GetTaskResponse>;
+    waitForAppTask({ taskID, maxRetries, timeout, }: _algolia_client_search.WaitForAppTaskOptions, requestOptions?: _algolia_client_common.RequestOptions): Promise<_algolia_client_search.GetTaskResponse>;
+    waitForApiKey({ operation, key, apiKey, maxRetries, timeout, }: _algolia_client_search.WaitForApiKeyOptions, requestOptions?: _algolia_client_common.RequestOptions): Promise<_algolia_client_search.GetApiKeyResponse | undefined>;
+    browseObjects<T>({ indexName, browseParams, ...browseObjectsOptions }: _algolia_client_search.BrowseOptions<_algolia_client_search.BrowseResponse<T>> & _algolia_client_search.BrowseProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<_algolia_client_search.BrowseResponse<T>>;
+    browseRules({ indexName, searchRulesParams, ...browseRulesOptions }: _algolia_client_search.BrowseOptions<_algolia_client_search.SearchRulesResponse> & _algolia_client_search.SearchRulesProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<_algolia_client_search.SearchRulesResponse>;
+    browseSynonyms({ indexName, searchSynonymsParams, ...browseSynonymsOptions }: _algolia_client_search.BrowseOptions<_algolia_client_search.SearchSynonymsResponse> & _algolia_client_search.SearchSynonymsProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<_algolia_client_search.SearchSynonymsResponse>;
+    chunkedBatch({ indexName, objects, action, waitForTasks, batchSize }: _algolia_client_search.ChunkedBatchOptions, requestOptions?: _algolia_client_common.RequestOptions): Promise<_algolia_client_search.BatchResponse[]>;
+    saveObjects({ indexName, objects }: _algolia_client_search.SaveObjectsOptions, requestOptions?: _algolia_client_common.RequestOptions): Promise<_algolia_client_search.BatchResponse[]>;
+    deleteObjects({ indexName, objectIDs }: _algolia_client_search.DeleteObjectsOptions, requestOptions?: _algolia_client_common.RequestOptions): Promise<_algolia_client_search.BatchResponse[]>;
+    partialUpdateObjects({ indexName, objects, createIfNotExists }: _algolia_client_search.PartialUpdateObjectsOptions, requestOptions?: _algolia_client_common.RequestOptions): Promise<_algolia_client_search.BatchResponse[]>;
+    replaceAllObjects({ indexName, objects, batchSize }: _algolia_client_search.ReplaceAllObjectsOptions, requestOptions?: _algolia_client_common.RequestOptions): Promise<_algolia_client_search.ReplaceAllObjectsResponse>;
+    searchForHits<T>(searchMethodParams: _algolia_client_search.LegacySearchMethodProps | _algolia_client_search.SearchMethodParams, requestOptions?: _algolia_client_common.RequestOptions): Promise<{
+        results: Array<_algolia_client_search.SearchResponse<T>>;
+    }>;
+    searchForFacets(searchMethodParams: _algolia_client_search.LegacySearchMethodProps | _algolia_client_search.SearchMethodParams, requestOptions?: _algolia_client_common.RequestOptions): Promise<{
+        results: _algolia_client_search.SearchForFacetValuesResponse[];
+    }>;
+    addApiKey(apiKey: _algolia_client_search.ApiKey, requestOptions?: _algolia_client_common.RequestOptions): Promise<_algolia_client_search.AddApiKeyResponse>;
+    addOrUpdateObject({ indexName, objectID, body }: _algolia_client_search.AddOrUpdateObjectProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<_algolia_client_search.UpdatedAtWithObjectIdResponse>;
+    appendSource(source: _algolia_client_search.Source, requestOptions?: _algolia_client_common.RequestOptions): Promise<_algolia_client_search.CreatedAtResponse>;
+    assignUserId({ xAlgoliaUserID, assignUserIdParams }: _algolia_client_search.AssignUserIdProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<_algolia_client_search.CreatedAtResponse>;
+    batch({ indexName, batchWriteParams }: _algolia_client_search.BatchProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<_algolia_client_search.BatchResponse>;
+    batchAssignUserIds({ xAlgoliaUserID, batchAssignUserIdsParams }: _algolia_client_search.BatchAssignUserIdsProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<_algolia_client_search.CreatedAtResponse>;
+    batchDictionaryEntries({ dictionaryName, batchDictionaryEntriesParams }: _algolia_client_search.BatchDictionaryEntriesProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<_algolia_client_search.UpdatedAtResponse>;
+    browse<T>({ indexName, browseParams }: _algolia_client_search.BrowseProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<_algolia_client_search.BrowseResponse<T>>;
+    clearObjects({ indexName }: _algolia_client_search.ClearObjectsProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<_algolia_client_search.UpdatedAtResponse>;
+    clearRules({ indexName, forwardToReplicas }: _algolia_client_search.ClearRulesProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<_algolia_client_search.UpdatedAtResponse>;
+    clearSynonyms({ indexName, forwardToReplicas }: _algolia_client_search.ClearSynonymsProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<_algolia_client_search.UpdatedAtResponse>;
+    customDelete({ path, parameters }: _algolia_client_search.CustomDeleteProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<Record<string, unknown>>;
+    customGet({ path, parameters }: _algolia_client_search.CustomGetProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<Record<string, unknown>>;
+    customPost({ path, parameters, body }: _algolia_client_search.CustomPostProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<Record<string, unknown>>;
+    customPut({ path, parameters, body }: _algolia_client_search.CustomPutProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<Record<string, unknown>>;
+    deleteApiKey({ key }: _algolia_client_search.DeleteApiKeyProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<_algolia_client_search.DeleteApiKeyResponse>;
+    deleteBy({ indexName, deleteByParams }: _algolia_client_search.DeleteByProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<_algolia_client_search.DeletedAtResponse>;
+    deleteIndex({ indexName }: _algolia_client_search.DeleteIndexProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<_algolia_client_search.DeletedAtResponse>;
+    deleteObject({ indexName, objectID }: _algolia_client_search.DeleteObjectProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<_algolia_client_search.DeletedAtResponse>;
+    deleteRule({ indexName, objectID, forwardToReplicas }: _algolia_client_search.DeleteRuleProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<_algolia_client_search.UpdatedAtResponse>;
+    deleteSource({ source }: _algolia_client_search.DeleteSourceProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<_algolia_client_search.DeleteSourceResponse>;
+    deleteSynonym({ indexName, objectID, forwardToReplicas }: _algolia_client_search.DeleteSynonymProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<_algolia_client_search.DeletedAtResponse>;
+    getApiKey({ key }: _algolia_client_search.GetApiKeyProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<_algolia_client_search.GetApiKeyResponse>;
+    getAppTask({ taskID }: _algolia_client_search.GetAppTaskProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<_algolia_client_search.GetTaskResponse>;
+    getDictionaryLanguages(requestOptions?: _algolia_client_common.RequestOptions): Promise<Record<string, _algolia_client_search.Languages>>;
+    getDictionarySettings(requestOptions?: _algolia_client_common.RequestOptions): Promise<_algolia_client_search.GetDictionarySettingsResponse>;
+    getLogs({ offset, length, indexName, type }?: _algolia_client_search.GetLogsProps, requestOptions?: _algolia_client_common.RequestOptions | undefined): Promise<_algolia_client_search.GetLogsResponse>;
+    getObject({ indexName, objectID, attributesToRetrieve }: _algolia_client_search.GetObjectProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<Record<string, unknown>>;
+    getObjects<T>(getObjectsParams: _algolia_client_search.GetObjectsParams, requestOptions?: _algolia_client_common.RequestOptions): Promise<_algolia_client_search.GetObjectsResponse<T>>;
+    getRule({ indexName, objectID }: _algolia_client_search.GetRuleProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<_algolia_client_search.Rule>;
+    getSettings({ indexName }: _algolia_client_search.GetSettingsProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<_algolia_client_search.SettingsResponse>;
+    getSources(requestOptions?: _algolia_client_common.RequestOptions): Promise<_algolia_client_search.Source[]>;
+    getSynonym({ indexName, objectID }: _algolia_client_search.GetSynonymProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<_algolia_client_search.SynonymHit>;
+    getTask({ indexName, taskID }: _algolia_client_search.GetTaskProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<_algolia_client_search.GetTaskResponse>;
+    getTopUserIds(requestOptions?: _algolia_client_common.RequestOptions): Promise<_algolia_client_search.GetTopUserIdsResponse>;
+    getUserId({ userID }: _algolia_client_search.GetUserIdProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<_algolia_client_search.UserId>;
+    hasPendingMappings({ getClusters }?: _algolia_client_search.HasPendingMappingsProps, requestOptions?: _algolia_client_common.RequestOptions | undefined): Promise<_algolia_client_search.HasPendingMappingsResponse>;
+    listApiKeys(requestOptions?: _algolia_client_common.RequestOptions): Promise<_algolia_client_search.ListApiKeysResponse>;
+    listClusters(requestOptions?: _algolia_client_common.RequestOptions): Promise<_algolia_client_search.ListClustersResponse>;
+    listIndices({ page, hitsPerPage }?: _algolia_client_search.ListIndicesProps, requestOptions?: _algolia_client_common.RequestOptions | undefined): Promise<_algolia_client_search.ListIndicesResponse>;
+    listUserIds({ page, hitsPerPage }?: _algolia_client_search.ListUserIdsProps, requestOptions?: _algolia_client_common.RequestOptions | undefined): Promise<_algolia_client_search.ListUserIdsResponse>;
+    multipleBatch(batchParams: _algolia_client_search.BatchParams, requestOptions?: _algolia_client_common.RequestOptions): Promise<_algolia_client_search.MultipleBatchResponse>;
+    operationIndex({ indexName, operationIndexParams }: _algolia_client_search.OperationIndexProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<_algolia_client_search.UpdatedAtResponse>;
+    partialUpdateObject({ indexName, objectID, attributesToUpdate, createIfNotExists }: _algolia_client_search.PartialUpdateObjectProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<_algolia_client_search.UpdatedAtWithObjectIdResponse>;
+    removeUserId({ userID }: _algolia_client_search.RemoveUserIdProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<_algolia_client_search.RemoveUserIdResponse>;
+    replaceSources({ source }: _algolia_client_search.ReplaceSourcesProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<_algolia_client_search.ReplaceSourceResponse>;
+    restoreApiKey({ key }: _algolia_client_search.RestoreApiKeyProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<_algolia_client_search.AddApiKeyResponse>;
+    saveObject({ indexName, body }: _algolia_client_search.SaveObjectProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<_algolia_client_search.SaveObjectResponse>;
+    saveRule({ indexName, objectID, rule, forwardToReplicas }: _algolia_client_search.SaveRuleProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<_algolia_client_search.UpdatedRuleResponse>;
+    saveRules({ indexName, rules, forwardToReplicas, clearExistingRules }: _algolia_client_search.SaveRulesProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<_algolia_client_search.UpdatedAtResponse>;
+    saveSynonym({ indexName, objectID, synonymHit, forwardToReplicas }: _algolia_client_search.SaveSynonymProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<_algolia_client_search.SaveSynonymResponse>;
+    saveSynonyms({ indexName, synonymHit, forwardToReplicas, replaceExistingSynonyms }: _algolia_client_search.SaveSynonymsProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<_algolia_client_search.UpdatedAtResponse>;
+    search<T>(searchMethodParams: _algolia_client_search.LegacySearchMethodProps | _algolia_client_search.SearchMethodParams, requestOptions?: _algolia_client_common.RequestOptions): Promise<_algolia_client_search.SearchResponses<T>>;
+    searchDictionaryEntries({ dictionaryName, searchDictionaryEntriesParams }: _algolia_client_search.SearchDictionaryEntriesProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<_algolia_client_search.SearchDictionaryEntriesResponse>;
+    searchForFacetValues({ indexName, facetName, searchForFacetValuesRequest }: _algolia_client_search.SearchForFacetValuesProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<_algolia_client_search.SearchForFacetValuesResponse>;
+    searchRules({ indexName, searchRulesParams }: _algolia_client_search.SearchRulesProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<_algolia_client_search.SearchRulesResponse>;
+    searchSingleIndex<T>({ indexName, searchParams }: _algolia_client_search.SearchSingleIndexProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<_algolia_client_search.SearchResponse<T>>;
+    searchSynonyms({ indexName, searchSynonymsParams }: _algolia_client_search.SearchSynonymsProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<_algolia_client_search.SearchSynonymsResponse>;
+    searchUserIds(searchUserIdsParams: _algolia_client_search.SearchUserIdsParams, requestOptions?: _algolia_client_common.RequestOptions): Promise<_algolia_client_search.SearchUserIdsResponse>;
+    setDictionarySettings(dictionarySettingsParams: _algolia_client_search.DictionarySettingsParams, requestOptions?: _algolia_client_common.RequestOptions): Promise<_algolia_client_search.UpdatedAtResponse>;
+    setSettings({ indexName, indexSettings, forwardToReplicas }: _algolia_client_search.SetSettingsProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<_algolia_client_search.UpdatedAtResponse>;
+    updateApiKey({ key, apiKey }: _algolia_client_search.UpdateApiKeyProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<_algolia_client_search.UpdateApiKeyResponse>;
+};
+
+export { type Algoliasearch, type InitClientOptions, type InitClientRegion, type Region, algoliasearch };

package/dist/node.d.ts

@@ -0,0 +1,153 @@
+import * as _algolia_client_search from '@algolia/client-search';
+import { GenerateSecuredApiKeyOptions, GetSecuredApiKeyRemainingValidityOptions } from '@algolia/client-search';
+export * from '@algolia/client-search';
+export { AdvancedSyntaxFeatures, AlternativesAsExact, Anchoring, AroundPrecision, AroundRadius, AroundRadiusAll, AutomaticFacetFilter, AutomaticFacetFilters, BaseSearchParams, BaseSearchParamsWithoutQuery, BaseSearchResponse, BooleanString, Condition, Consequence, ConsequenceHide, ConsequenceParams, ConsequenceQuery, ConsequenceQueryObject, CustomDeleteProps, CustomGetProps, CustomPostProps, CustomPutProps, DeletedAtResponse, Distinct, Edit, EditType, ErrorBase, ExactOnSingleWordQuery, Exhaustive, FacetFilters, FacetOrdering, FacetStats, Facets, HighlightResult, HighlightResultOption, IgnorePlurals, IndexSettingsAsSearchParams, MatchLevel, MatchedGeoLocation, Mode, NumericFilters, OptionalFilters, Params, Personalization, Promote, PromoteObjectID, PromoteObjectIDs, QueryType, Range, RankingInfo, ReRankingApplyFilter, Redirect, RedirectRuleIndexData, RedirectRuleIndexMetadata, RedirectURL, RemoveStopWords, RemoveWordsIfNoResults, RenderingContent, SearchPagination, SearchParams, SearchParamsObject, SearchParamsQuery, SemanticSearch, SnippetResult, SnippetResultOption, SortRemainingBy, SupportedLanguage, TagFilters, TaskStatus, TypoTolerance, TypoToleranceEnum, Value, apiClientVersion } from '@algolia/client-search';
+import * as _algolia_client_common from '@algolia/client-common';
+import { ClientOptions } from '@algolia/client-common';
+import { Region as Region$1, AbtestingClient } from '@algolia/client-abtesting';
+export * from '@algolia/client-abtesting';
+export { Region as ABTestingRegion } from '@algolia/client-abtesting';
+import { Region as Region$2, AnalyticsClient } from '@algolia/client-analytics';
+export * from '@algolia/client-analytics';
+export { Region as AnalyticsRegion } from '@algolia/client-analytics';
+import { Region as Region$3, PersonalizationClient } from '@algolia/client-personalization';
+export * from '@algolia/client-personalization';
+import { RecommendClient } from '@algolia/recommend';
+export * from '@algolia/recommend';
+
+type Region = Region$1 | Region$2;
+
+/**
+ * Options forwarded to the client initialized via the `init` method.
+ */
+type InitClientOptions = Partial<{
+    /**
+     * App to target with the initialized client, defaults to the `algoliasearch` appId.
+     */
+    appId: string;
+    /**
+     * API key of the targeted app ID, defaults to the `algoliasearch` apiKey.
+     */
+    apiKey: string;
+    options: ClientOptions;
+}>;
+type InitClientRegion<TRegion> = Partial<{
+    /**
+     * Available regions of the initialized client.
+     */
+    region: TRegion;
+}>;
+
+/**
+ * The client type.
+ */
+type Algoliasearch = ReturnType<typeof algoliasearch>;
+declare function algoliasearch(appId: string, apiKey: string, options?: ClientOptions): {
+    _ua: string;
+    initAbtesting: (initOptions?: InitClientOptions & InitClientRegion<Region$1>) => AbtestingClient;
+    initAnalytics: (initOptions?: InitClientOptions & InitClientRegion<Region$2>) => AnalyticsClient;
+    initPersonalization: (initOptions: InitClientOptions & Required<InitClientRegion<Region$3>>) => PersonalizationClient;
+    initRecommend: (initOptions?: InitClientOptions) => RecommendClient;
+    /**
+     * Helper: Generates a secured API key based on the given `parentApiKey` and given `restrictions`.
+     *
+     * @summary Helper: Generates a secured API key based on the given `parentApiKey` and given `restrictions`.
+     * @param generateSecuredApiKey - The `generateSecuredApiKey` object.
+     * @param generateSecuredApiKey.parentApiKey - The base API key from which to generate the new secured one.
+     * @param generateSecuredApiKey.restrictions - A set of properties defining the restrictions of the secured API key.
+     */
+    generateSecuredApiKey({ parentApiKey, restrictions }: GenerateSecuredApiKeyOptions): string;
+    /**
+     * Helper: Retrieves the remaining validity of the previous generated `securedApiKey`, the `ValidUntil` parameter must have been provided.
+     *
+     * @summary Helper: Retrieves the remaining validity of the previous generated `secured_api_key`, the `ValidUntil` parameter must have been provided.
+     * @param getSecuredApiKeyRemainingValidity - The `getSecuredApiKeyRemainingValidity` object.
+     * @param getSecuredApiKeyRemainingValidity.securedApiKey - The secured API key generated with the `generateSecuredApiKey` method.
+     */
+    getSecuredApiKeyRemainingValidity({ securedApiKey }: GetSecuredApiKeyRemainingValidityOptions): number;
+    transporter: _algolia_client_common.Transporter;
+    appId: string;
+    clearCache(): Promise<void>;
+    addAlgoliaAgent(segment: string, version?: string): void;
+    waitForTask({ indexName, taskID, maxRetries, timeout, }: _algolia_client_search.WaitForTaskOptions, requestOptions?: _algolia_client_common.RequestOptions): Promise<_algolia_client_search.GetTaskResponse>;
+    waitForAppTask({ taskID, maxRetries, timeout, }: _algolia_client_search.WaitForAppTaskOptions, requestOptions?: _algolia_client_common.RequestOptions): Promise<_algolia_client_search.GetTaskResponse>;
+    waitForApiKey({ operation, key, apiKey, maxRetries, timeout, }: _algolia_client_search.WaitForApiKeyOptions, requestOptions?: _algolia_client_common.RequestOptions): Promise<_algolia_client_search.GetApiKeyResponse | undefined>;
+    browseObjects<T>({ indexName, browseParams, ...browseObjectsOptions }: _algolia_client_search.BrowseOptions<_algolia_client_search.BrowseResponse<T>> & _algolia_client_search.BrowseProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<_algolia_client_search.BrowseResponse<T>>;
+    browseRules({ indexName, searchRulesParams, ...browseRulesOptions }: _algolia_client_search.BrowseOptions<_algolia_client_search.SearchRulesResponse> & _algolia_client_search.SearchRulesProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<_algolia_client_search.SearchRulesResponse>;
+    browseSynonyms({ indexName, searchSynonymsParams, ...browseSynonymsOptions }: _algolia_client_search.BrowseOptions<_algolia_client_search.SearchSynonymsResponse> & _algolia_client_search.SearchSynonymsProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<_algolia_client_search.SearchSynonymsResponse>;
+    chunkedBatch({ indexName, objects, action, waitForTasks, batchSize }: _algolia_client_search.ChunkedBatchOptions, requestOptions?: _algolia_client_common.RequestOptions): Promise<_algolia_client_search.BatchResponse[]>;
+    saveObjects({ indexName, objects }: _algolia_client_search.SaveObjectsOptions, requestOptions?: _algolia_client_common.RequestOptions): Promise<_algolia_client_search.BatchResponse[]>;
+    deleteObjects({ indexName, objectIDs }: _algolia_client_search.DeleteObjectsOptions, requestOptions?: _algolia_client_common.RequestOptions): Promise<_algolia_client_search.BatchResponse[]>;
+    partialUpdateObjects({ indexName, objects, createIfNotExists }: _algolia_client_search.PartialUpdateObjectsOptions, requestOptions?: _algolia_client_common.RequestOptions): Promise<_algolia_client_search.BatchResponse[]>;
+    replaceAllObjects({ indexName, objects, batchSize }: _algolia_client_search.ReplaceAllObjectsOptions, requestOptions?: _algolia_client_common.RequestOptions): Promise<_algolia_client_search.ReplaceAllObjectsResponse>;
+    searchForHits<T>(searchMethodParams: _algolia_client_search.LegacySearchMethodProps | _algolia_client_search.SearchMethodParams, requestOptions?: _algolia_client_common.RequestOptions): Promise<{
+        results: Array<_algolia_client_search.SearchResponse<T>>;
+    }>;
+    searchForFacets(searchMethodParams: _algolia_client_search.LegacySearchMethodProps | _algolia_client_search.SearchMethodParams, requestOptions?: _algolia_client_common.RequestOptions): Promise<{
+        results: _algolia_client_search.SearchForFacetValuesResponse[];
+    }>;
+    addApiKey(apiKey: _algolia_client_search.ApiKey, requestOptions?: _algolia_client_common.RequestOptions): Promise<_algolia_client_search.AddApiKeyResponse>;
+    addOrUpdateObject({ indexName, objectID, body }: _algolia_client_search.AddOrUpdateObjectProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<_algolia_client_search.UpdatedAtWithObjectIdResponse>;
+    appendSource(source: _algolia_client_search.Source, requestOptions?: _algolia_client_common.RequestOptions): Promise<_algolia_client_search.CreatedAtResponse>;
+    assignUserId({ xAlgoliaUserID, assignUserIdParams }: _algolia_client_search.AssignUserIdProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<_algolia_client_search.CreatedAtResponse>;
+    batch({ indexName, batchWriteParams }: _algolia_client_search.BatchProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<_algolia_client_search.BatchResponse>;
+    batchAssignUserIds({ xAlgoliaUserID, batchAssignUserIdsParams }: _algolia_client_search.BatchAssignUserIdsProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<_algolia_client_search.CreatedAtResponse>;
+    batchDictionaryEntries({ dictionaryName, batchDictionaryEntriesParams }: _algolia_client_search.BatchDictionaryEntriesProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<_algolia_client_search.UpdatedAtResponse>;
+    browse<T>({ indexName, browseParams }: _algolia_client_search.BrowseProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<_algolia_client_search.BrowseResponse<T>>;
+    clearObjects({ indexName }: _algolia_client_search.ClearObjectsProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<_algolia_client_search.UpdatedAtResponse>;
+    clearRules({ indexName, forwardToReplicas }: _algolia_client_search.ClearRulesProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<_algolia_client_search.UpdatedAtResponse>;
+    clearSynonyms({ indexName, forwardToReplicas }: _algolia_client_search.ClearSynonymsProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<_algolia_client_search.UpdatedAtResponse>;
+    customDelete({ path, parameters }: _algolia_client_search.CustomDeleteProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<Record<string, unknown>>;
+    customGet({ path, parameters }: _algolia_client_search.CustomGetProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<Record<string, unknown>>;
+    customPost({ path, parameters, body }: _algolia_client_search.CustomPostProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<Record<string, unknown>>;
+    customPut({ path, parameters, body }: _algolia_client_search.CustomPutProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<Record<string, unknown>>;
+    deleteApiKey({ key }: _algolia_client_search.DeleteApiKeyProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<_algolia_client_search.DeleteApiKeyResponse>;
+    deleteBy({ indexName, deleteByParams }: _algolia_client_search.DeleteByProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<_algolia_client_search.DeletedAtResponse>;
+    deleteIndex({ indexName }: _algolia_client_search.DeleteIndexProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<_algolia_client_search.DeletedAtResponse>;
+    deleteObject({ indexName, objectID }: _algolia_client_search.DeleteObjectProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<_algolia_client_search.DeletedAtResponse>;
+    deleteRule({ indexName, objectID, forwardToReplicas }: _algolia_client_search.DeleteRuleProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<_algolia_client_search.UpdatedAtResponse>;
+    deleteSource({ source }: _algolia_client_search.DeleteSourceProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<_algolia_client_search.DeleteSourceResponse>;
+    deleteSynonym({ indexName, objectID, forwardToReplicas }: _algolia_client_search.DeleteSynonymProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<_algolia_client_search.DeletedAtResponse>;
+    getApiKey({ key }: _algolia_client_search.GetApiKeyProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<_algolia_client_search.GetApiKeyResponse>;
+    getAppTask({ taskID }: _algolia_client_search.GetAppTaskProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<_algolia_client_search.GetTaskResponse>;
+    getDictionaryLanguages(requestOptions?: _algolia_client_common.RequestOptions): Promise<Record<string, _algolia_client_search.Languages>>;
+    getDictionarySettings(requestOptions?: _algolia_client_common.RequestOptions): Promise<_algolia_client_search.GetDictionarySettingsResponse>;
+    getLogs({ offset, length, indexName, type }?: _algolia_client_search.GetLogsProps, requestOptions?: _algolia_client_common.RequestOptions | undefined): Promise<_algolia_client_search.GetLogsResponse>;
+    getObject({ indexName, objectID, attributesToRetrieve }: _algolia_client_search.GetObjectProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<Record<string, unknown>>;
+    getObjects<T>(getObjectsParams: _algolia_client_search.GetObjectsParams, requestOptions?: _algolia_client_common.RequestOptions): Promise<_algolia_client_search.GetObjectsResponse<T>>;
+    getRule({ indexName, objectID }: _algolia_client_search.GetRuleProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<_algolia_client_search.Rule>;
+    getSettings({ indexName }: _algolia_client_search.GetSettingsProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<_algolia_client_search.SettingsResponse>;
+    getSources(requestOptions?: _algolia_client_common.RequestOptions): Promise<_algolia_client_search.Source[]>;
+    getSynonym({ indexName, objectID }: _algolia_client_search.GetSynonymProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<_algolia_client_search.SynonymHit>;
+    getTask({ indexName, taskID }: _algolia_client_search.GetTaskProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<_algolia_client_search.GetTaskResponse>;
+    getTopUserIds(requestOptions?: _algolia_client_common.RequestOptions): Promise<_algolia_client_search.GetTopUserIdsResponse>;
+    getUserId({ userID }: _algolia_client_search.GetUserIdProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<_algolia_client_search.UserId>;
+    hasPendingMappings({ getClusters }?: _algolia_client_search.HasPendingMappingsProps, requestOptions?: _algolia_client_common.RequestOptions | undefined): Promise<_algolia_client_search.HasPendingMappingsResponse>;
+    listApiKeys(requestOptions?: _algolia_client_common.RequestOptions): Promise<_algolia_client_search.ListApiKeysResponse>;
+    listClusters(requestOptions?: _algolia_client_common.RequestOptions): Promise<_algolia_client_search.ListClustersResponse>;
+    listIndices({ page, hitsPerPage }?: _algolia_client_search.ListIndicesProps, requestOptions?: _algolia_client_common.RequestOptions | undefined): Promise<_algolia_client_search.ListIndicesResponse>;
+    listUserIds({ page, hitsPerPage }?: _algolia_client_search.ListUserIdsProps, requestOptions?: _algolia_client_common.RequestOptions | undefined): Promise<_algolia_client_search.ListUserIdsResponse>;
+    multipleBatch(batchParams: _algolia_client_search.BatchParams, requestOptions?: _algolia_client_common.RequestOptions): Promise<_algolia_client_search.MultipleBatchResponse>;
+    operationIndex({ indexName, operationIndexParams }: _algolia_client_search.OperationIndexProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<_algolia_client_search.UpdatedAtResponse>;
+    partialUpdateObject({ indexName, objectID, attributesToUpdate, createIfNotExists }: _algolia_client_search.PartialUpdateObjectProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<_algolia_client_search.UpdatedAtWithObjectIdResponse>;
+    removeUserId({ userID }: _algolia_client_search.RemoveUserIdProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<_algolia_client_search.RemoveUserIdResponse>;
+    replaceSources({ source }: _algolia_client_search.ReplaceSourcesProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<_algolia_client_search.ReplaceSourceResponse>;
+    restoreApiKey({ key }: _algolia_client_search.RestoreApiKeyProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<_algolia_client_search.AddApiKeyResponse>;
+    saveObject({ indexName, body }: _algolia_client_search.SaveObjectProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<_algolia_client_search.SaveObjectResponse>;
+    saveRule({ indexName, objectID, rule, forwardToReplicas }: _algolia_client_search.SaveRuleProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<_algolia_client_search.UpdatedRuleResponse>;
+    saveRules({ indexName, rules, forwardToReplicas, clearExistingRules }: _algolia_client_search.SaveRulesProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<_algolia_client_search.UpdatedAtResponse>;
+    saveSynonym({ indexName, objectID, synonymHit, forwardToReplicas }: _algolia_client_search.SaveSynonymProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<_algolia_client_search.SaveSynonymResponse>;
+    saveSynonyms({ indexName, synonymHit, forwardToReplicas, replaceExistingSynonyms }: _algolia_client_search.SaveSynonymsProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<_algolia_client_search.UpdatedAtResponse>;
+    search<T>(searchMethodParams: _algolia_client_search.LegacySearchMethodProps | _algolia_client_search.SearchMethodParams, requestOptions?: _algolia_client_common.RequestOptions): Promise<_algolia_client_search.SearchResponses<T>>;
+    searchDictionaryEntries({ dictionaryName, searchDictionaryEntriesParams }: _algolia_client_search.SearchDictionaryEntriesProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<_algolia_client_search.SearchDictionaryEntriesResponse>;
+    searchForFacetValues({ indexName, facetName, searchForFacetValuesRequest }: _algolia_client_search.SearchForFacetValuesProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<_algolia_client_search.SearchForFacetValuesResponse>;
+    searchRules({ indexName, searchRulesParams }: _algolia_client_search.SearchRulesProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<_algolia_client_search.SearchRulesResponse>;
+    searchSingleIndex<T>({ indexName, searchParams }: _algolia_client_search.SearchSingleIndexProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<_algolia_client_search.SearchResponse<T>>;
+    searchSynonyms({ indexName, searchSynonymsParams }: _algolia_client_search.SearchSynonymsProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<_algolia_client_search.SearchSynonymsResponse>;
+    searchUserIds(searchUserIdsParams: _algolia_client_search.SearchUserIdsParams, requestOptions?: _algolia_client_common.RequestOptions): Promise<_algolia_client_search.SearchUserIdsResponse>;
+    setDictionarySettings(dictionarySettingsParams: _algolia_client_search.DictionarySettingsParams, requestOptions?: _algolia_client_common.RequestOptions): Promise<_algolia_client_search.UpdatedAtResponse>;
+    setSettings({ indexName, indexSettings, forwardToReplicas }: _algolia_client_search.SetSettingsProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<_algolia_client_search.UpdatedAtResponse>;
+    updateApiKey({ key, apiKey }: _algolia_client_search.UpdateApiKeyProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<_algolia_client_search.UpdateApiKeyResponse>;
+};
+
+export { type Algoliasearch, type InitClientOptions, type InitClientRegion, type Region, algoliasearch };