algoliasearch 5.0.0-alpha.99 → 5.0.0-beta.10

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2013-Present Algolia
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/builds/browser.ts

@@ -1,45 +1,41 @@
 // 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.
 
-import type {
-  Region as AbtestingRegion,
-  AbtestingClient,
-} from '@algolia/client-abtesting/src/abtestingClient';
+import type { AbtestingClient } from '@algolia/client-abtesting';
+import type { Region as AbtestingRegion } from '@algolia/client-abtesting/src/abtestingClient';
 import {
   createAbtestingClient,
   REGIONS as abtestingRegions,
 } from '@algolia/client-abtesting/src/abtestingClient';
-import type {
-  Region as AnalyticsRegion,
-  AnalyticsClient,
-} from '@algolia/client-analytics/src/analyticsClient';
+import type { AnalyticsClient } from '@algolia/client-analytics';
 import {
   createAnalyticsClient,
   REGIONS as analyticsRegions,
 } from '@algolia/client-analytics/src/analyticsClient';
+import type { Region as AnalyticsRegion } from '@algolia/client-analytics/src/analyticsClient';
 import {
-  createMemoryCache,
-  createFallbackableCache,
-  createBrowserLocalStorageCache,
   DEFAULT_CONNECT_TIMEOUT_BROWSER,
   DEFAULT_READ_TIMEOUT_BROWSER,
   DEFAULT_WRITE_TIMEOUT_BROWSER,
+  createBrowserLocalStorageCache,
+  createFallbackableCache,
+  createMemoryCache,
 } from '@algolia/client-common';
 import type {
-  CreateClientOptions,
   ClientOptions,
+  CreateClientOptions,
 } from '@algolia/client-common';
+import type { PersonalizationClient } from '@algolia/client-personalization';
+import type { Region as PersonalizationRegion } from '@algolia/client-personalization/src/personalizationClient';
 import {
   createPersonalizationClient,
   REGIONS as personalizationRegions,
 } from '@algolia/client-personalization/src/personalizationClient';
-import type {
-  Region as PersonalizationRegion,
-  PersonalizationClient,
-} from '@algolia/client-personalization/src/personalizationClient';
 import {
   createSearchClient,
   apiClientVersion as searchClientVersion,
 } from '@algolia/client-search/src/searchClient';
+import type { RecommendClient } from '@algolia/recommend';
+import { createRecommendClient } from '@algolia/recommend/src/recommendClient';
 import { createXhrRequester } from '@algolia/requester-browser-xhr';
 
 import type { InitClientOptions, InitClientRegion } from './models';
@@ -66,7 +62,6 @@ export function algoliasearch(
   if (!apiKey || typeof apiKey !== 'string') {
     throw new Error('`apiKey` is missing.');
   }
-
   const commonOptions: CreateClientOptions = {
     apiKey,
     appId,
@@ -89,6 +84,14 @@ export function algoliasearch(
     ...options,
   };
 
+  function initRecommend(initOptions: InitClientOptions = {}): RecommendClient {
+    return createRecommendClient({
+      ...commonOptions,
+      ...initOptions.options,
+      ...initOptions,
+    });
+  }
+
   function initAnalytics(
     initOptions: InitClientOptions & InitClientRegion<AnalyticsRegion> = {}
   ): AnalyticsClient {
@@ -159,8 +162,9 @@ export function algoliasearch(
     get _ua(): string {
       return this.transporter.algoliaAgent.value;
     },
+    initAbtesting,
     initAnalytics,
     initPersonalization,
-    initAbtesting,
+    initRecommend,
   };
 }

package/builds/models.ts

@@ -2,29 +2,163 @@
 
 import type { ClientOptions } from '@algolia/client-common';
 import {
-  ErrorBase,
-  CustomPutProps,
-  CustomPostProps,
+  AdvancedSyntaxFeatures,
+  AlternativesAsExact,
+  Anchoring,
+  AroundPrecision,
+  AroundPrecisionFromValueInner,
+  AroundRadius,
+  AroundRadiusAll,
+  AutomaticFacetFilter,
+  AutomaticFacetFilters,
+  BaseSearchParams,
+  BaseSearchParamsWithoutQuery,
+  BaseSearchResponse,
+  Condition,
+  Consequence,
+  ConsequenceHide,
+  ConsequenceParams,
+  ConsequenceQuery,
+  ConsequenceQueryObject,
   CustomDeleteProps,
   CustomGetProps,
+  CustomPostProps,
+  CustomPutProps,
+  DeletedAtResponse,
+  Distinct,
+  Edit,
+  EditType,
+  ErrorBase,
+  ExactOnSingleWordQuery,
+  Exhaustive,
+  FacetFilters,
+  FacetOrdering,
+  Facets,
+  FacetsStats,
+  HighlightResult,
+  HighlightResultOption,
+  IgnorePlurals,
+  IndexSettingsAsSearchParams,
+  MatchLevel,
+  MatchedGeoLocation,
+  Mode,
+  NumericFilters,
+  OptionalFilters,
+  Params,
+  Personalization,
+  Promote,
+  PromoteObjectID,
+  PromoteObjectIDs,
+  QueryType,
+  RankingInfo,
+  ReRankingApplyFilter,
+  Redirect,
+  RedirectRuleIndexMetadata,
+  RedirectRuleIndexMetadataData,
+  RedirectURL,
+  RemoveStopWords,
+  RemoveWordsIfNoResults,
+  RenderingContent,
+  SearchPagination,
+  SearchParams,
+  SearchParamsObject,
+  SearchParamsQuery,
+  SemanticSearch,
+  SnippetResult,
+  SnippetResultOption,
+  SortRemainingBy,
+  SupportedLanguage,
+  TagFilters,
+  TaskStatus,
+  TypoTolerance,
+  TypoToleranceEnum,
+  Value,
 } from '@algolia/client-search/model';
 
 export * from '@algolia/client-search/model';
+export * from '@algolia/recommend/model';
 export * from '@algolia/client-personalization/model';
 export * from '@algolia/client-analytics/model';
 export * from '@algolia/client-abtesting/model';
 
 export { SearchClient } from '@algolia/client-search';
+export { RecommendClient } from '@algolia/recommend';
 export { PersonalizationClient } from '@algolia/client-personalization';
 export { AnalyticsClient } from '@algolia/client-analytics';
 export { AbtestingClient } from '@algolia/client-abtesting';
 
 export {
-  ErrorBase,
-  CustomPutProps,
-  CustomPostProps,
+  AdvancedSyntaxFeatures,
+  AlternativesAsExact,
+  Anchoring,
+  AroundPrecision,
+  AroundPrecisionFromValueInner,
+  AroundRadius,
+  AroundRadiusAll,
+  AutomaticFacetFilter,
+  AutomaticFacetFilters,
+  BaseSearchParams,
+  BaseSearchParamsWithoutQuery,
+  BaseSearchResponse,
+  Condition,
+  Consequence,
+  ConsequenceHide,
+  ConsequenceParams,
+  ConsequenceQuery,
+  ConsequenceQueryObject,
   CustomDeleteProps,
   CustomGetProps,
+  CustomPostProps,
+  CustomPutProps,
+  DeletedAtResponse,
+  Distinct,
+  Edit,
+  EditType,
+  ErrorBase,
+  ExactOnSingleWordQuery,
+  Exhaustive,
+  FacetFilters,
+  FacetOrdering,
+  Facets,
+  FacetsStats,
+  HighlightResult,
+  HighlightResultOption,
+  IgnorePlurals,
+  IndexSettingsAsSearchParams,
+  MatchLevel,
+  MatchedGeoLocation,
+  Mode,
+  NumericFilters,
+  OptionalFilters,
+  Params,
+  Personalization,
+  Promote,
+  PromoteObjectID,
+  PromoteObjectIDs,
+  QueryType,
+  RankingInfo,
+  ReRankingApplyFilter,
+  Redirect,
+  RedirectRuleIndexMetadata,
+  RedirectRuleIndexMetadataData,
+  RedirectURL,
+  RemoveStopWords,
+  RemoveWordsIfNoResults,
+  RenderingContent,
+  SearchParams,
+  SearchParamsObject,
+  SearchParamsQuery,
+  SemanticSearch,
+  SearchPagination,
+  SnippetResult,
+  SnippetResultOption,
+  SortRemainingBy,
+  SupportedLanguage,
+  TagFilters,
+  TaskStatus,
+  TypoTolerance,
+  TypoToleranceEnum,
+  Value,
 };
 
 /**

package/builds/node.ts

@@ -1,47 +1,51 @@
 // 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.
 
-import type {
-  Region as AbtestingRegion,
-  AbtestingClient,
-} from '@algolia/client-abtesting/src/abtestingClient';
+import { createHmac } from 'crypto';
+
+import type { AbtestingClient } from '@algolia/client-abtesting';
+import type { Region as AbtestingRegion } from '@algolia/client-abtesting/src/abtestingClient';
 import {
   createAbtestingClient,
   REGIONS as abtestingRegions,
 } from '@algolia/client-abtesting/src/abtestingClient';
-import type {
-  Region as AnalyticsRegion,
-  AnalyticsClient,
-} from '@algolia/client-analytics/src/analyticsClient';
+import type { AnalyticsClient } from '@algolia/client-analytics';
 import {
   createAnalyticsClient,
   REGIONS as analyticsRegions,
 } from '@algolia/client-analytics/src/analyticsClient';
+import type { Region as AnalyticsRegion } from '@algolia/client-analytics/src/analyticsClient';
 import {
   DEFAULT_CONNECT_TIMEOUT_NODE,
   DEFAULT_READ_TIMEOUT_NODE,
   DEFAULT_WRITE_TIMEOUT_NODE,
   createMemoryCache,
   createNullCache,
+  serializeQueryParameters,
 } from '@algolia/client-common';
 import type {
-  CreateClientOptions,
   ClientOptions,
+  CreateClientOptions,
 } from '@algolia/client-common';
+import type { PersonalizationClient } from '@algolia/client-personalization';
+import type { Region as PersonalizationRegion } from '@algolia/client-personalization/src/personalizationClient';
 import {
   createPersonalizationClient,
   REGIONS as personalizationRegions,
 } from '@algolia/client-personalization/src/personalizationClient';
-import type {
-  Region as PersonalizationRegion,
-  PersonalizationClient,
-} from '@algolia/client-personalization/src/personalizationClient';
 import {
   createSearchClient,
   apiClientVersion as searchClientVersion,
 } from '@algolia/client-search/src/searchClient';
+import type { RecommendClient } from '@algolia/recommend';
+import { createRecommendClient } from '@algolia/recommend/src/recommendClient';
 import { createHttpRequester } from '@algolia/requester-node-http';
 
-import type { InitClientOptions, InitClientRegion } from './models';
+import type {
+  InitClientOptions,
+  InitClientRegion,
+  GenerateSecuredApiKeyOptions,
+  GetSecuredApiKeyRemainingValidityOptions,
+} from './models';
 
 export * from './models';
 
@@ -65,7 +69,6 @@ export function algoliasearch(
   if (!apiKey || typeof apiKey !== 'string') {
     throw new Error('`apiKey` is missing.');
   }
-
   const commonOptions: CreateClientOptions = {
     apiKey,
     appId,
@@ -82,6 +85,14 @@ export function algoliasearch(
     ...options,
   };
 
+  function initRecommend(initOptions: InitClientOptions = {}): RecommendClient {
+    return createRecommendClient({
+      ...commonOptions,
+      ...initOptions.options,
+      ...initOptions,
+    });
+  }
+
   function initAnalytics(
     initOptions: InitClientOptions & InitClientRegion<AnalyticsRegion> = {}
   ): AnalyticsClient {
@@ -152,8 +163,73 @@ export function algoliasearch(
     get _ua(): string {
       return this.transporter.algoliaAgent.value;
     },
+    initAbtesting,
     initAnalytics,
     initPersonalization,
-    initAbtesting,
+    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 = {},
+    }: GenerateSecuredApiKeyOptions): string {
+      let mergedRestrictions = restrictions;
+      if (restrictions.searchParams) {
+        // merge searchParams with the root restrictions
+        mergedRestrictions = {
+          ...restrictions,
+          ...restrictions.searchParams,
+        };
+
+        delete mergedRestrictions.searchParams;
+      }
+
+      mergedRestrictions = Object.keys(mergedRestrictions)
+        .sort()
+        .reduce(
+          (acc, key) => {
+            // eslint-disable-next-line no-param-reassign
+            acc[key] = (mergedRestrictions as any)[key];
+            return acc;
+          },
+          {} as Record<string, unknown>
+        );
+
+      const queryParameters = serializeQueryParameters(mergedRestrictions);
+      return Buffer.from(
+        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,
+    }: GetSecuredApiKeyRemainingValidityOptions): number {
+      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(new Date().getTime() / 1000);
+    },
   };
 }