@algolia/composition 1.12.0 → 1.13.0

package/dist/worker.d.ts

@@ -610,6 +610,23 @@ type AroundRadiusAll = 'all';
  */
 type AroundRadius = number | AroundRadiusAll;
 
+type ExternalInjection = {
+    /**
+     * An objectID injected into an external source.
+     */
+    objectID: string;
+    /**
+     * User-defined key-values that will be added to the injected item in the response. This is identical to Hits metadata defined in Composition or Composition Rule, with the benefit of being set at runtime.
+     */
+    metadata?: {
+        [key: string]: any;
+    } | undefined;
+};
+
+type ExternalInjectedItem = {
+    items: Array<ExternalInjection>;
+};
+
 /**
  * Filter the search by facet values, so that only records with the same facet values are retrieved.  **Prefer using the `filters` parameter, which supports all filter types and combinations with boolean operators.**  - `[filter1, filter2]` is interpreted as `filter1 AND filter2`. - `[[filter1, filter2], filter3]` is interpreted as `filter1 OR filter2 AND filter3`. - `facet:-value` is interpreted as `NOT facet:value`.  While it\'s best to avoid attributes that start with a `-`, you can still filter them by escaping with a backslash: `facet:\\-value`.
  */
@@ -719,6 +736,12 @@ type Params = {
      * Whether this search will use [Dynamic Re-Ranking](https://www.algolia.com/doc/guides/algolia-ai/re-ranking/) This setting only has an effect if you activated Dynamic Re-Ranking for this index in the Algolia dashboard.
      */
     enableReRanking?: boolean | undefined;
+    /**
+     * A list of extenrally injected objectID groups into from an external source.
+     */
+    injectedItems?: {
+        [key: string]: ExternalInjectedItem;
+    } | undefined;
 };
 
 type RequestBody = {
@@ -766,7 +789,7 @@ type SearchForFacetValuesProps = {
     searchForFacetValuesRequest?: SearchForFacetValuesRequest | undefined;
 };
 
-declare const apiClientVersion = "1.12.0";
+declare const apiClientVersion = "1.13.0";
 declare function createCompositionClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, ...options }: CreateClientOptions): {
     transporter: _algolia_client_common.Transporter;
     /**
@@ -837,4 +860,4 @@ type CompositionClient = ReturnType<typeof createCompositionClient>;
 
 declare function compositionClient(appId: string, apiKey: string, options?: ClientOptions | undefined): CompositionClient;
 
-export { type AroundPrecision, type AroundRadius, type AroundRadiusAll, type Banner, type BannerImage, type BannerImageUrl, type BannerLink, type BaseSearchResponse, type CompositionBaseSearchResponse, type CompositionClient, type CompositionIdRankingInfo, type CompositionRankingInfo, type CompositionRunAppliedRules, type CompositionRunSearchResponse, type CompositionsSearchResponse, type ErrorBase, type Exhaustive, type FacetFilters, type FacetHits, type FacetOrdering, type FacetStats, type Facets, type HighlightResult, type HighlightResultOption, type Hit, type HitMetadata, type HitRankingInfo, type InsideBoundingBox, type MatchLevel, type MatchedGeoLocation, type NumericFilters, type OptionalFilters, type Params, type Personalization, type Range, type RankingInfo, type Redirect, type RedirectRuleIndexData, type RedirectRuleIndexMetadata, type RedirectURL, type RenderingContent, type RequestBody, type ResultsCompositionInfoResponse, type ResultsCompositionsResponse, type ResultsInjectedItemAppliedRulesInfoResponse, type ResultsInjectedItemInfoResponse, type SearchForFacetValuesParams, type SearchForFacetValuesProps, type SearchForFacetValuesRequest, type SearchForFacetValuesResponse, type SearchForFacetValuesResults, type SearchHits, type SearchPagination, type SearchProps, type SearchResponse, type SearchResults, type SearchResultsItem, type SnippetResult, type SnippetResultOption, type SortRemainingBy, type SupportedLanguage, type Value, type Widgets, apiClientVersion, compositionClient };
+export { type AroundPrecision, type AroundRadius, type AroundRadiusAll, type Banner, type BannerImage, type BannerImageUrl, type BannerLink, type BaseSearchResponse, type CompositionBaseSearchResponse, type CompositionClient, type CompositionIdRankingInfo, type CompositionRankingInfo, type CompositionRunAppliedRules, type CompositionRunSearchResponse, type CompositionsSearchResponse, type ErrorBase, type Exhaustive, type ExternalInjectedItem, type ExternalInjection, type FacetFilters, type FacetHits, type FacetOrdering, type FacetStats, type Facets, type HighlightResult, type HighlightResultOption, type Hit, type HitMetadata, type HitRankingInfo, type InsideBoundingBox, type MatchLevel, type MatchedGeoLocation, type NumericFilters, type OptionalFilters, type Params, type Personalization, type Range, type RankingInfo, type Redirect, type RedirectRuleIndexData, type RedirectRuleIndexMetadata, type RedirectURL, type RenderingContent, type RequestBody, type ResultsCompositionInfoResponse, type ResultsCompositionsResponse, type ResultsInjectedItemAppliedRulesInfoResponse, type ResultsInjectedItemInfoResponse, type SearchForFacetValuesParams, type SearchForFacetValuesProps, type SearchForFacetValuesRequest, type SearchForFacetValuesResponse, type SearchForFacetValuesResults, type SearchHits, type SearchPagination, type SearchProps, type SearchResponse, type SearchResults, type SearchResultsItem, type SnippetResult, type SnippetResultOption, type SortRemainingBy, type SupportedLanguage, type Value, type Widgets, apiClientVersion, compositionClient };

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.12.0",
+  "version": "1.13.0",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/algolia/algoliasearch-client-javascript.git"
@@ -49,10 +49,10 @@
     "index.d.ts"
   ],
   "dependencies": {
-    "@algolia/client-common": "5.36.0",
-    "@algolia/requester-browser-xhr": "5.36.0",
-    "@algolia/requester-fetch": "5.36.0",
-    "@algolia/requester-node-http": "5.36.0"
+    "@algolia/client-common": "5.37.0",
+    "@algolia/requester-browser-xhr": "5.37.0",
+    "@algolia/requester-fetch": "5.37.0",
+    "@algolia/requester-node-http": "5.37.0"
   },
   "devDependencies": {
     "@arethetypeswrong/cli": "0.18.2",