@algolia/client-query-suggestions - npm Package Compare versions

Comparing version 5.8.1 to 5.9.0

dist/browser.d.ts

@@ -256,8 +256,9 @@ import * as _algolia_client_common from '@algolia/client-common';
 
-declare const apiClientVersion = "5.8.1";
+declare const apiClientVersion = "5.9.0";
 declare const REGIONS: readonly ["eu", "us"];
 type Region = (typeof REGIONS)[number];
-declare function createQuerySuggestionsClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, region: regionOption, ...options }: CreateClientOptions & {
+type RegionOptions = {
     region: Region;
-}): {
+};
+declare function createQuerySuggestionsClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, region: regionOption, ...options }: CreateClientOptions & RegionOptions): {
     transporter: _algolia_client_common.Transporter;
@@ -406,2 +407,2 @@ /**
 
-export { type AppID, type BaseResponse, type ConfigStatus, type Configuration, type ConfigurationResponse, type ConfigurationWithIndex, type CustomDeleteProps, type CustomGetProps, type CustomPostProps, type CustomPutProps, type DeleteConfigProps, type ErrorBase, type Facet, type GetConfigProps, type GetConfigStatusProps, type GetLogFileProps, type Languages, type LogFile, type LogLevel, type QuerySuggestionsClient, type Region, type SourceIndex, type UpdateConfigProps, apiClientVersion, querySuggestionsClient };
+export { type AppID, type BaseResponse, type ConfigStatus, type Configuration, type ConfigurationResponse, type ConfigurationWithIndex, type CustomDeleteProps, type CustomGetProps, type CustomPostProps, type CustomPutProps, type DeleteConfigProps, type ErrorBase, type Facet, type GetConfigProps, type GetConfigStatusProps, type GetLogFileProps, type Languages, type LogFile, type LogLevel, type QuerySuggestionsClient, type Region, type RegionOptions, type SourceIndex, type UpdateConfigProps, apiClientVersion, querySuggestionsClient };

dist/builds/browser.js

@@ -15,3 +15,3 @@ // builds/browser.ts
 import { createAuth, createTransporter, getAlgoliaAgent } from "@algolia/client-common";
-var apiClientVersion = "5.8.1";
+var apiClientVersion = "5.9.0";
 var REGIONS = ["eu", "us"];
@@ -18,0 +18,0 @@ function getDefaultHosts(region) {

dist/builds/browser.min.js

@@ -1,2 +0,2 @@
-function k(){function r(e){return new Promise(s=>{let t=new XMLHttpRequest;t.open(e.method,e.url,!0),Object.keys(e.headers).forEach(a=>t.setRequestHeader(a,e.headers[a]));let i=(a,o)=>setTimeout(()=>{t.abort(),s({status:0,content:o,isTimedOut:!0})},a),m=i(e.connectTimeout,"Connection timeout"),g;t.onreadystatechange=()=>{t.readyState>t.OPENED&&g===void 0&&(clearTimeout(m),g=i(e.responseTimeout,"Socket timeout"))},t.onerror=()=>{t.status===0&&(clearTimeout(m),clearTimeout(g),s({content:t.responseText||"Network request failed",status:t.status,isTimedOut:!1}))},t.onload=()=>{clearTimeout(m),clearTimeout(g),s({content:t.responseText,status:t.status,isTimedOut:!1})},t.send(e.data)})}return{send:r}}function G(r){let e,s=`algolia-client-js-${r.key}`;function t(){return e===void 0&&(e=r.localStorage||window.localStorage),e}function i(){return JSON.parse(t().getItem(s)||"{}")}function m(a){t().setItem(s,JSON.stringify(a))}function g(){let a=r.timeToLive?r.timeToLive*1e3:null,o=i(),n=Object.fromEntries(Object.entries(o).filter(([,d])=>d.timestamp!==void 0));if(m(n),!a)return;let c=Object.fromEntries(Object.entries(n).filter(([,d])=>{let p=new Date().getTime();return!(d.timestamp+a<p)}));m(c)}return{get(a,o,n={miss:()=>Promise.resolve()}){return Promise.resolve().then(()=>(g(),i()[JSON.stringify(a)])).then(c=>Promise.all([c?c.value:o(),c!==void 0])).then(([c,d])=>Promise.all([c,d||n.miss(c)])).then(([c])=>c)},set(a,o){return Promise.resolve().then(()=>{let n=i();return n[JSON.stringify(a)]={timestamp:new Date().getTime(),value:o},t().setItem(s,JSON.stringify(n)),o})},delete(a){return Promise.resolve().then(()=>{let o=i();delete o[JSON.stringify(a)],t().setItem(s,JSON.stringify(o))})},clear(){return Promise.resolve().then(()=>{t().removeItem(s)})}}}function ee(){return{get(r,e,s={miss:()=>Promise.resolve()}){return e().then(i=>Promise.all([i,s.miss(i)])).then(([i])=>i)},set(r,e){return Promise.resolve(e)},delete(r){return Promise.resolve()},clear(){return Promise.resolve()}}}function T(r){let e=[...r.caches],s=e.shift();return s===void 0?ee():{get(t,i,m={miss:()=>Promise.resolve()}){return s.get(t,i,m).catch(()=>T({caches:e}).get(t,i,m))},set(t,i){return s.set(t,i).catch(()=>T({caches:e}).set(t,i))},delete(t){return s.delete(t).catch(()=>T({caches:e}).delete(t))},clear(){return s.clear().catch(()=>T({caches:e}).clear())}}}function v(r={serializable:!0}){let e={};return{get(s,t,i={miss:()=>Promise.resolve()}){let m=JSON.stringify(s);if(m in e)return Promise.resolve(r.serializable?JSON.parse(e[m]):e[m]);let g=t();return g.then(a=>i.miss(a)).then(()=>g)},set(s,t){return e[JSON.stringify(s)]=r.serializable?JSON.stringify(t):t,Promise.resolve(t)},delete(s){return delete e[JSON.stringify(s)],Promise.resolve()},clear(){return e={},Promise.resolve()}}}var F=1e3,$=2e3,j=3e4;function re(r){let e={value:`Algolia for JavaScript (${r})`,add(s){let t=`; ${s.segment}${s.version!==void 0?` (${s.version})`:""}`;return e.value.indexOf(t)===-1&&(e.value=`${e.value}${t}`),e}};return e}function J(r,e,s="WithinHeaders"){let t={"x-algolia-api-key":e,"x-algolia-application-id":r};return{headers(){return s==="WithinHeaders"?t:{}},queryParameters(){return s==="WithinQueryParameters"?t:{}}}}function M({algoliaAgents:r,client:e,version:s}){let t=re(s).add({segment:e,version:s});return r.forEach(i=>t.add(i)),t}function z(){return{debug(r,e){return Promise.resolve()},info(r,e){return Promise.resolve()},error(r,e){return Promise.resolve()}}}var W=2*60*1e3;function Q(r,e="up"){let s=Date.now();function t(){return e==="up"||Date.now()-s>W}function i(){return e==="timed out"&&Date.now()-s<=W}return{...r,status:e,lastUpdate:s,isUp:t,isTimedOut:i}}var B=class extends Error{name="AlgoliaError";constructor(r,e){super(r),e&&(this.name=e)}},X=class extends B{stackTrace;constructor(r,e,s){super(r,s),this.stackTrace=e}},te=class extends X{constructor(r){super("Unreachable hosts - your application id may be incorrect. If the error persists, please reach out to the Algolia Support team: https://alg.li/support.",r,"RetryError")}},b=class extends X{status;constructor(r,e,s,t="ApiError"){super(r,s,t),this.status=e}},se=class extends B{response;constructor(r,e){super(r,"DeserializationError"),this.response=e}},oe=class extends b{error;constructor(r,e,s,t){super(r,e,t,"DetailedApiError"),this.error=s}};function ne(r,e,s){let t=ae(s),i=`${r.protocol}://${r.url}${r.port?`:${r.port}`:""}/${e.charAt(0)==="/"?e.substring(1):e}`;return t.length&&(i+=`?${t}`),i}function ae(r){return Object.keys(r).filter(e=>r[e]!==void 0).sort().map(e=>`${e}=${encodeURIComponent(Object.prototype.toString.call(r[e])==="[object Array]"?r[e].join(","):r[e]).replace(/\+/g,"%20")}`).join("&")}function ie(r,e){if(r.method==="GET"||r.data===void 0&&e.data===void 0)return;let s=Array.isArray(r.data)?r.data:{...r.data,...e.data};return JSON.stringify(s)}function ue(r,e,s){let t={Accept:"application/json",...r,...e,...s},i={};return Object.keys(t).forEach(m=>{let g=t[m];i[m.toLowerCase()]=g}),i}function ce(r){try{return JSON.parse(r.content)}catch(e){throw new se(e.message,r)}}function le({content:r,status:e},s){try{let t=JSON.parse(r);return"error"in t?new oe(t.message,e,t.error,s):new b(t.message,e,s)}catch{}return new b(r,e,s)}function me({isTimedOut:r,status:e}){return!r&&~~e===0}function de({isTimedOut:r,status:e}){return r||me({isTimedOut:r,status:e})||~~(e/100)!==2&&~~(e/100)!==4}function he({status:r}){return~~(r/100)===2}function ge(r){return r.map(e=>K(e))}function K(r){let e=r.request.headers["x-algolia-api-key"]?{"x-algolia-api-key":"*****"}:{};return{...r,request:{...r.request,headers:{...r.request.headers,...e}}}}function V({hosts:r,hostsCache:e,baseHeaders:s,logger:t,baseQueryParameters:i,algoliaAgent:m,timeouts:g,requester:a,requestsCache:o,responsesCache:n}){async function c(u){let l=await Promise.all(u.map(h=>e.get(h,()=>Promise.resolve(Q(h))))),P=l.filter(h=>h.isUp()),y=l.filter(h=>h.isTimedOut()),w=[...P,...y];return{hosts:w.length>0?w:u,getTimeout(h,E){return(y.length===0&&h===0?1:y.length+3+h)*E}}}async function d(u,l,P=!0){let y=[],w=ie(u,l),q=ue(s,u.headers,l.headers),h=u.method==="GET"?{...u.data,...l.data}:{},E={...i,...u.queryParameters,...h};if(m.value&&(E["x-algolia-agent"]=m.value),l&&l.queryParameters)for(let f of Object.keys(l.queryParameters))!l.queryParameters[f]||Object.prototype.toString.call(l.queryParameters[f])==="[object Object]"?E[f]=l.queryParameters[f]:E[f]=l.queryParameters[f].toString();let O=0,I=async(f,x)=>{let C=f.pop();if(C===void 0)throw new te(ge(y));let A={...g,...l.timeouts},U={data:w,headers:q,method:u.method,url:ne(C,u.path,E),connectTimeout:x(O,A.connect),responseTimeout:x(O,P?A.read:A.write)},L=N=>{let H={request:U,response:N,host:C,triesLeft:f.length};return y.push(H),H},R=await a.send(U);if(de(R)){let N=L(R);return R.isTimedOut&&O++,t.info("Retryable failure",K(N)),await e.set(C,Q(C,R.isTimedOut?"timed out":"down")),I(f,x)}if(he(R))return ce(R);throw L(R),le(R,y)},Z=r.filter(f=>f.accept==="readWrite"||(P?f.accept==="read":f.accept==="write")),D=await c(Z);return I([...D.hosts].reverse(),D.getTimeout)}function p(u,l={}){let P=u.useReadTransporter||u.method==="GET";if(!P)return d(u,l,P);let y=()=>d(u,l);if((l.cacheable||u.cacheable)!==!0)return y();let q={request:u,requestOptions:l,transporter:{queryParameters:i,headers:s}};return n.get(q,()=>o.get(q,()=>o.set(q,y()).then(h=>Promise.all([o.delete(q),h]),h=>Promise.all([o.delete(q),Promise.reject(h)])).then(([h,E])=>E)),{miss:h=>n.set(q,h)})}return{hostsCache:e,requester:a,timeouts:g,logger:t,algoliaAgent:m,baseHeaders:s,baseQueryParameters:i,hosts:r,request:p,requestsCache:o,responsesCache:n}}var S="5.8.1",_=["eu","us"];function pe(r){return[{url:"query-suggestions.{region}.algolia.com".replace("{region}",r),accept:"readWrite",protocol:"https"}]}function Y({appId:r,apiKey:e,authMode:s,algoliaAgents:t,region:i,...m}){let g=J(r,e,s),a=V({hosts:pe(i),...m,algoliaAgent:M({algoliaAgents:t,client:"QuerySuggestions",version:S}),baseHeaders:{"content-type":"text/plain",...g.headers(),...m.baseHeaders},baseQueryParameters:{...g.queryParameters(),...m.baseQueryParameters}});return{transporter:a,appId:r,clearCache(){return Promise.all([a.requestsCache.clear(),a.responsesCache.clear()]).then(()=>{})},get _ua(){return a.algoliaAgent.value},addAlgoliaAgent(o,n){a.algoliaAgent.add({segment:o,version:n})},setClientApiKey({apiKey:o}){!s||s==="WithinHeaders"?a.baseHeaders["x-algolia-api-key"]=o:a.baseQueryParameters["x-algolia-api-key"]=o},createConfig(o,n){if(!o)throw new Error("Parameter `configurationWithIndex` is required when calling `createConfig`.");let u={method:"POST",path:"/1/configs",queryParameters:{},headers:{},data:o};return a.request(u,n)},customDelete({path:o,parameters:n},c){if(!o)throw new Error("Parameter `path` is required when calling `customDelete`.");let l={method:"DELETE",path:"/{path}".replace("{path}",o),queryParameters:n||{},headers:{}};return a.request(l,c)},customGet({path:o,parameters:n},c){if(!o)throw new Error("Parameter `path` is required when calling `customGet`.");let l={method:"GET",path:"/{path}".replace("{path}",o),queryParameters:n||{},headers:{}};return a.request(l,c)},customPost({path:o,parameters:n,body:c},d){if(!o)throw new Error("Parameter `path` is required when calling `customPost`.");let P={method:"POST",path:"/{path}".replace("{path}",o),queryParameters:n||{},headers:{},data:c||{}};return a.request(P,d)},customPut({path:o,parameters:n,body:c},d){if(!o)throw new Error("Parameter `path` is required when calling `customPut`.");let P={method:"PUT",path:"/{path}".replace("{path}",o),queryParameters:n||{},headers:{},data:c||{}};return a.request(P,d)},deleteConfig({indexName:o},n){if(!o)throw new Error("Parameter `indexName` is required when calling `deleteConfig`.");let u={method:"DELETE",path:"/1/configs/{indexName}".replace("{indexName}",encodeURIComponent(o)),queryParameters:{},headers:{}};return a.request(u,n)},getAllConfigs(o){let p={method:"GET",path:"/1/configs",queryParameters:{},headers:{}};return a.request(p,o)},getConfig({indexName:o},n){if(!o)throw new Error("Parameter `indexName` is required when calling `getConfig`.");let u={method:"GET",path:"/1/configs/{indexName}".replace("{indexName}",encodeURIComponent(o)),queryParameters:{},headers:{}};return a.request(u,n)},getConfigStatus({indexName:o},n){if(!o)throw new Error("Parameter `indexName` is required when calling `getConfigStatus`.");let u={method:"GET",path:"/1/configs/{indexName}/status".replace("{indexName}",encodeURIComponent(o)),queryParameters:{},headers:{}};return a.request(u,n)},getLogFile({indexName:o},n){if(!o)throw new Error("Parameter `indexName` is required when calling `getLogFile`.");let u={method:"GET",path:"/1/logs/{indexName}".replace("{indexName}",encodeURIComponent(o)),queryParameters:{},headers:{}};return a.request(u,n)},updateConfig({indexName:o,configuration:n},c){if(!o)throw new Error("Parameter `indexName` is required when calling `updateConfig`.");if(!n)throw new Error("Parameter `configuration` is required when calling `updateConfig`.");if(!n.sourceIndices)throw new Error("Parameter `configuration.sourceIndices` is required when calling `updateConfig`.");let l={method:"PUT",path:"/1/configs/{indexName}".replace("{indexName}",encodeURIComponent(o)),queryParameters:{},headers:{},data:n};return a.request(l,c)}}}function Je(r,e,s,t){if(!r||typeof r!="string")throw new Error("`appId` is missing.");if(!e||typeof e!="string")throw new Error("`apiKey` is missing.");if(!s||s&&(typeof s!="string"||!_.includes(s)))throw new Error(`\`region\` is required and must be one of the following: ${_.join(", ")}`);return Y({appId:r,apiKey:e,region:s,timeouts:{connect:F,read:$,write:j},logger:z(),requester:k(),algoliaAgents:[{segment:"Browser"}],authMode:"WithinQueryParameters",responsesCache:v(),requestsCache:v({serializable:!1}),hostsCache:T({caches:[G({key:`${S}-${r}`}),v()]}),...t})}export{S as apiClientVersion,Je as querySuggestionsClient};
+function k(){function r(e){return new Promise(s=>{let t=new XMLHttpRequest;t.open(e.method,e.url,!0),Object.keys(e.headers).forEach(a=>t.setRequestHeader(a,e.headers[a]));let i=(a,o)=>setTimeout(()=>{t.abort(),s({status:0,content:o,isTimedOut:!0})},a),m=i(e.connectTimeout,"Connection timeout"),g;t.onreadystatechange=()=>{t.readyState>t.OPENED&&g===void 0&&(clearTimeout(m),g=i(e.responseTimeout,"Socket timeout"))},t.onerror=()=>{t.status===0&&(clearTimeout(m),clearTimeout(g),s({content:t.responseText||"Network request failed",status:t.status,isTimedOut:!1}))},t.onload=()=>{clearTimeout(m),clearTimeout(g),s({content:t.responseText,status:t.status,isTimedOut:!1})},t.send(e.data)})}return{send:r}}function G(r){let e,s=`algolia-client-js-${r.key}`;function t(){return e===void 0&&(e=r.localStorage||window.localStorage),e}function i(){return JSON.parse(t().getItem(s)||"{}")}function m(a){t().setItem(s,JSON.stringify(a))}function g(){let a=r.timeToLive?r.timeToLive*1e3:null,o=i(),n=Object.fromEntries(Object.entries(o).filter(([,d])=>d.timestamp!==void 0));if(m(n),!a)return;let c=Object.fromEntries(Object.entries(n).filter(([,d])=>{let p=new Date().getTime();return!(d.timestamp+a<p)}));m(c)}return{get(a,o,n={miss:()=>Promise.resolve()}){return Promise.resolve().then(()=>(g(),i()[JSON.stringify(a)])).then(c=>Promise.all([c?c.value:o(),c!==void 0])).then(([c,d])=>Promise.all([c,d||n.miss(c)])).then(([c])=>c)},set(a,o){return Promise.resolve().then(()=>{let n=i();return n[JSON.stringify(a)]={timestamp:new Date().getTime(),value:o},t().setItem(s,JSON.stringify(n)),o})},delete(a){return Promise.resolve().then(()=>{let o=i();delete o[JSON.stringify(a)],t().setItem(s,JSON.stringify(o))})},clear(){return Promise.resolve().then(()=>{t().removeItem(s)})}}}function ee(){return{get(r,e,s={miss:()=>Promise.resolve()}){return e().then(i=>Promise.all([i,s.miss(i)])).then(([i])=>i)},set(r,e){return Promise.resolve(e)},delete(r){return Promise.resolve()},clear(){return Promise.resolve()}}}function T(r){let e=[...r.caches],s=e.shift();return s===void 0?ee():{get(t,i,m={miss:()=>Promise.resolve()}){return s.get(t,i,m).catch(()=>T({caches:e}).get(t,i,m))},set(t,i){return s.set(t,i).catch(()=>T({caches:e}).set(t,i))},delete(t){return s.delete(t).catch(()=>T({caches:e}).delete(t))},clear(){return s.clear().catch(()=>T({caches:e}).clear())}}}function v(r={serializable:!0}){let e={};return{get(s,t,i={miss:()=>Promise.resolve()}){let m=JSON.stringify(s);if(m in e)return Promise.resolve(r.serializable?JSON.parse(e[m]):e[m]);let g=t();return g.then(a=>i.miss(a)).then(()=>g)},set(s,t){return e[JSON.stringify(s)]=r.serializable?JSON.stringify(t):t,Promise.resolve(t)},delete(s){return delete e[JSON.stringify(s)],Promise.resolve()},clear(){return e={},Promise.resolve()}}}var F=1e3,$=2e3,j=3e4;function re(r){let e={value:`Algolia for JavaScript (${r})`,add(s){let t=`; ${s.segment}${s.version!==void 0?` (${s.version})`:""}`;return e.value.indexOf(t)===-1&&(e.value=`${e.value}${t}`),e}};return e}function J(r,e,s="WithinHeaders"){let t={"x-algolia-api-key":e,"x-algolia-application-id":r};return{headers(){return s==="WithinHeaders"?t:{}},queryParameters(){return s==="WithinQueryParameters"?t:{}}}}function M({algoliaAgents:r,client:e,version:s}){let t=re(s).add({segment:e,version:s});return r.forEach(i=>t.add(i)),t}function z(){return{debug(r,e){return Promise.resolve()},info(r,e){return Promise.resolve()},error(r,e){return Promise.resolve()}}}var W=2*60*1e3;function Q(r,e="up"){let s=Date.now();function t(){return e==="up"||Date.now()-s>W}function i(){return e==="timed out"&&Date.now()-s<=W}return{...r,status:e,lastUpdate:s,isUp:t,isTimedOut:i}}var B=class extends Error{name="AlgoliaError";constructor(r,e){super(r),e&&(this.name=e)}},X=class extends B{stackTrace;constructor(r,e,s){super(r,s),this.stackTrace=e}},te=class extends X{constructor(r){super("Unreachable hosts - your application id may be incorrect. If the error persists, please reach out to the Algolia Support team: https://alg.li/support.",r,"RetryError")}},b=class extends X{status;constructor(r,e,s,t="ApiError"){super(r,s,t),this.status=e}},se=class extends B{response;constructor(r,e){super(r,"DeserializationError"),this.response=e}},oe=class extends b{error;constructor(r,e,s,t){super(r,e,t,"DetailedApiError"),this.error=s}};function ne(r,e,s){let t=ae(s),i=`${r.protocol}://${r.url}${r.port?`:${r.port}`:""}/${e.charAt(0)==="/"?e.substring(1):e}`;return t.length&&(i+=`?${t}`),i}function ae(r){return Object.keys(r).filter(e=>r[e]!==void 0).sort().map(e=>`${e}=${encodeURIComponent(Object.prototype.toString.call(r[e])==="[object Array]"?r[e].join(","):r[e]).replace(/\+/g,"%20")}`).join("&")}function ie(r,e){if(r.method==="GET"||r.data===void 0&&e.data===void 0)return;let s=Array.isArray(r.data)?r.data:{...r.data,...e.data};return JSON.stringify(s)}function ue(r,e,s){let t={Accept:"application/json",...r,...e,...s},i={};return Object.keys(t).forEach(m=>{let g=t[m];i[m.toLowerCase()]=g}),i}function ce(r){try{return JSON.parse(r.content)}catch(e){throw new se(e.message,r)}}function le({content:r,status:e},s){try{let t=JSON.parse(r);return"error"in t?new oe(t.message,e,t.error,s):new b(t.message,e,s)}catch{}return new b(r,e,s)}function me({isTimedOut:r,status:e}){return!r&&~~e===0}function de({isTimedOut:r,status:e}){return r||me({isTimedOut:r,status:e})||~~(e/100)!==2&&~~(e/100)!==4}function he({status:r}){return~~(r/100)===2}function ge(r){return r.map(e=>K(e))}function K(r){let e=r.request.headers["x-algolia-api-key"]?{"x-algolia-api-key":"*****"}:{};return{...r,request:{...r.request,headers:{...r.request.headers,...e}}}}function V({hosts:r,hostsCache:e,baseHeaders:s,logger:t,baseQueryParameters:i,algoliaAgent:m,timeouts:g,requester:a,requestsCache:o,responsesCache:n}){async function c(u){let l=await Promise.all(u.map(h=>e.get(h,()=>Promise.resolve(Q(h))))),P=l.filter(h=>h.isUp()),y=l.filter(h=>h.isTimedOut()),w=[...P,...y];return{hosts:w.length>0?w:u,getTimeout(h,E){return(y.length===0&&h===0?1:y.length+3+h)*E}}}async function d(u,l,P=!0){let y=[],w=ie(u,l),q=ue(s,u.headers,l.headers),h=u.method==="GET"?{...u.data,...l.data}:{},E={...i,...u.queryParameters,...h};if(m.value&&(E["x-algolia-agent"]=m.value),l&&l.queryParameters)for(let f of Object.keys(l.queryParameters))!l.queryParameters[f]||Object.prototype.toString.call(l.queryParameters[f])==="[object Object]"?E[f]=l.queryParameters[f]:E[f]=l.queryParameters[f].toString();let O=0,I=async(f,x)=>{let C=f.pop();if(C===void 0)throw new te(ge(y));let A={...g,...l.timeouts},U={data:w,headers:q,method:u.method,url:ne(C,u.path,E),connectTimeout:x(O,A.connect),responseTimeout:x(O,P?A.read:A.write)},L=N=>{let H={request:U,response:N,host:C,triesLeft:f.length};return y.push(H),H},R=await a.send(U);if(de(R)){let N=L(R);return R.isTimedOut&&O++,t.info("Retryable failure",K(N)),await e.set(C,Q(C,R.isTimedOut?"timed out":"down")),I(f,x)}if(he(R))return ce(R);throw L(R),le(R,y)},Z=r.filter(f=>f.accept==="readWrite"||(P?f.accept==="read":f.accept==="write")),D=await c(Z);return I([...D.hosts].reverse(),D.getTimeout)}function p(u,l={}){let P=u.useReadTransporter||u.method==="GET";if(!P)return d(u,l,P);let y=()=>d(u,l);if((l.cacheable||u.cacheable)!==!0)return y();let q={request:u,requestOptions:l,transporter:{queryParameters:i,headers:s}};return n.get(q,()=>o.get(q,()=>o.set(q,y()).then(h=>Promise.all([o.delete(q),h]),h=>Promise.all([o.delete(q),Promise.reject(h)])).then(([h,E])=>E)),{miss:h=>n.set(q,h)})}return{hostsCache:e,requester:a,timeouts:g,logger:t,algoliaAgent:m,baseHeaders:s,baseQueryParameters:i,hosts:r,request:p,requestsCache:o,responsesCache:n}}var S="5.9.0",_=["eu","us"];function pe(r){return[{url:"query-suggestions.{region}.algolia.com".replace("{region}",r),accept:"readWrite",protocol:"https"}]}function Y({appId:r,apiKey:e,authMode:s,algoliaAgents:t,region:i,...m}){let g=J(r,e,s),a=V({hosts:pe(i),...m,algoliaAgent:M({algoliaAgents:t,client:"QuerySuggestions",version:S}),baseHeaders:{"content-type":"text/plain",...g.headers(),...m.baseHeaders},baseQueryParameters:{...g.queryParameters(),...m.baseQueryParameters}});return{transporter:a,appId:r,clearCache(){return Promise.all([a.requestsCache.clear(),a.responsesCache.clear()]).then(()=>{})},get _ua(){return a.algoliaAgent.value},addAlgoliaAgent(o,n){a.algoliaAgent.add({segment:o,version:n})},setClientApiKey({apiKey:o}){!s||s==="WithinHeaders"?a.baseHeaders["x-algolia-api-key"]=o:a.baseQueryParameters["x-algolia-api-key"]=o},createConfig(o,n){if(!o)throw new Error("Parameter `configurationWithIndex` is required when calling `createConfig`.");let u={method:"POST",path:"/1/configs",queryParameters:{},headers:{},data:o};return a.request(u,n)},customDelete({path:o,parameters:n},c){if(!o)throw new Error("Parameter `path` is required when calling `customDelete`.");let l={method:"DELETE",path:"/{path}".replace("{path}",o),queryParameters:n||{},headers:{}};return a.request(l,c)},customGet({path:o,parameters:n},c){if(!o)throw new Error("Parameter `path` is required when calling `customGet`.");let l={method:"GET",path:"/{path}".replace("{path}",o),queryParameters:n||{},headers:{}};return a.request(l,c)},customPost({path:o,parameters:n,body:c},d){if(!o)throw new Error("Parameter `path` is required when calling `customPost`.");let P={method:"POST",path:"/{path}".replace("{path}",o),queryParameters:n||{},headers:{},data:c||{}};return a.request(P,d)},customPut({path:o,parameters:n,body:c},d){if(!o)throw new Error("Parameter `path` is required when calling `customPut`.");let P={method:"PUT",path:"/{path}".replace("{path}",o),queryParameters:n||{},headers:{},data:c||{}};return a.request(P,d)},deleteConfig({indexName:o},n){if(!o)throw new Error("Parameter `indexName` is required when calling `deleteConfig`.");let u={method:"DELETE",path:"/1/configs/{indexName}".replace("{indexName}",encodeURIComponent(o)),queryParameters:{},headers:{}};return a.request(u,n)},getAllConfigs(o){let p={method:"GET",path:"/1/configs",queryParameters:{},headers:{}};return a.request(p,o)},getConfig({indexName:o},n){if(!o)throw new Error("Parameter `indexName` is required when calling `getConfig`.");let u={method:"GET",path:"/1/configs/{indexName}".replace("{indexName}",encodeURIComponent(o)),queryParameters:{},headers:{}};return a.request(u,n)},getConfigStatus({indexName:o},n){if(!o)throw new Error("Parameter `indexName` is required when calling `getConfigStatus`.");let u={method:"GET",path:"/1/configs/{indexName}/status".replace("{indexName}",encodeURIComponent(o)),queryParameters:{},headers:{}};return a.request(u,n)},getLogFile({indexName:o},n){if(!o)throw new Error("Parameter `indexName` is required when calling `getLogFile`.");let u={method:"GET",path:"/1/logs/{indexName}".replace("{indexName}",encodeURIComponent(o)),queryParameters:{},headers:{}};return a.request(u,n)},updateConfig({indexName:o,configuration:n},c){if(!o)throw new Error("Parameter `indexName` is required when calling `updateConfig`.");if(!n)throw new Error("Parameter `configuration` is required when calling `updateConfig`.");if(!n.sourceIndices)throw new Error("Parameter `configuration.sourceIndices` is required when calling `updateConfig`.");let l={method:"PUT",path:"/1/configs/{indexName}".replace("{indexName}",encodeURIComponent(o)),queryParameters:{},headers:{},data:n};return a.request(l,c)}}}function Je(r,e,s,t){if(!r||typeof r!="string")throw new Error("`appId` is missing.");if(!e||typeof e!="string")throw new Error("`apiKey` is missing.");if(!s||s&&(typeof s!="string"||!_.includes(s)))throw new Error(`\`region\` is required and must be one of the following: ${_.join(", ")}`);return Y({appId:r,apiKey:e,region:s,timeouts:{connect:F,read:$,write:j},logger:z(),requester:k(),algoliaAgents:[{segment:"Browser"}],authMode:"WithinQueryParameters",responsesCache:v(),requestsCache:v({serializable:!1}),hostsCache:T({caches:[G({key:`${S}-${r}`}),v()]}),...t})}export{S as apiClientVersion,Je as querySuggestionsClient};
 //# sourceMappingURL=browser.min.js.map

dist/builds/browser.umd.js

@@ -7,3 +7,3 @@ (function (global, factory) {
 
-	function k(){function r(e){return new Promise(s=>{let t=new XMLHttpRequest;t.open(e.method,e.url,!0),Object.keys(e.headers).forEach(a=>t.setRequestHeader(a,e.headers[a]));let i=(a,o)=>setTimeout(()=>{t.abort(),s({status:0,content:o,isTimedOut:!0});},a),m=i(e.connectTimeout,"Connection timeout"),g;t.onreadystatechange=()=>{t.readyState>t.OPENED&&g===void 0&&(clearTimeout(m),g=i(e.responseTimeout,"Socket timeout"));},t.onerror=()=>{t.status===0&&(clearTimeout(m),clearTimeout(g),s({content:t.responseText||"Network request failed",status:t.status,isTimedOut:!1}));},t.onload=()=>{clearTimeout(m),clearTimeout(g),s({content:t.responseText,status:t.status,isTimedOut:!1});},t.send(e.data);})}return {send:r}}function G(r){let e,s=`algolia-client-js-${r.key}`;function t(){return e===void 0&&(e=r.localStorage||window.localStorage),e}function i(){return JSON.parse(t().getItem(s)||"{}")}function m(a){t().setItem(s,JSON.stringify(a));}function g(){let a=r.timeToLive?r.timeToLive*1e3:null,o=i(),n=Object.fromEntries(Object.entries(o).filter(([,d])=>d.timestamp!==void 0));if(m(n),!a)return;let c=Object.fromEntries(Object.entries(n).filter(([,d])=>{let p=new Date().getTime();return !(d.timestamp+a<p)}));m(c);}return {get(a,o,n={miss:()=>Promise.resolve()}){return Promise.resolve().then(()=>(g(),i()[JSON.stringify(a)])).then(c=>Promise.all([c?c.value:o(),c!==void 0])).then(([c,d])=>Promise.all([c,d||n.miss(c)])).then(([c])=>c)},set(a,o){return Promise.resolve().then(()=>{let n=i();return n[JSON.stringify(a)]={timestamp:new Date().getTime(),value:o},t().setItem(s,JSON.stringify(n)),o})},delete(a){return Promise.resolve().then(()=>{let o=i();delete o[JSON.stringify(a)],t().setItem(s,JSON.stringify(o));})},clear(){return Promise.resolve().then(()=>{t().removeItem(s);})}}}function ee(){return {get(r,e,s={miss:()=>Promise.resolve()}){return e().then(i=>Promise.all([i,s.miss(i)])).then(([i])=>i)},set(r,e){return Promise.resolve(e)},delete(r){return Promise.resolve()},clear(){return Promise.resolve()}}}function T(r){let e=[...r.caches],s=e.shift();return s===void 0?ee():{get(t,i,m={miss:()=>Promise.resolve()}){return s.get(t,i,m).catch(()=>T({caches:e}).get(t,i,m))},set(t,i){return s.set(t,i).catch(()=>T({caches:e}).set(t,i))},delete(t){return s.delete(t).catch(()=>T({caches:e}).delete(t))},clear(){return s.clear().catch(()=>T({caches:e}).clear())}}}function v(r={serializable:!0}){let e={};return {get(s,t,i={miss:()=>Promise.resolve()}){let m=JSON.stringify(s);if(m in e)return Promise.resolve(r.serializable?JSON.parse(e[m]):e[m]);let g=t();return g.then(a=>i.miss(a)).then(()=>g)},set(s,t){return e[JSON.stringify(s)]=r.serializable?JSON.stringify(t):t,Promise.resolve(t)},delete(s){return delete e[JSON.stringify(s)],Promise.resolve()},clear(){return e={},Promise.resolve()}}}var F=1e3,$=2e3,j=3e4;function re(r){let e={value:`Algolia for JavaScript (${r})`,add(s){let t=`; ${s.segment}${s.version!==void 0?` (${s.version})`:""}`;return e.value.indexOf(t)===-1&&(e.value=`${e.value}${t}`),e}};return e}function J(r,e,s="WithinHeaders"){let t={"x-algolia-api-key":e,"x-algolia-application-id":r};return {headers(){return s==="WithinHeaders"?t:{}},queryParameters(){return s==="WithinQueryParameters"?t:{}}}}function M({algoliaAgents:r,client:e,version:s}){let t=re(s).add({segment:e,version:s});return r.forEach(i=>t.add(i)),t}function z(){return {debug(r,e){return Promise.resolve()},info(r,e){return Promise.resolve()},error(r,e){return Promise.resolve()}}}var W=2*60*1e3;function Q(r,e="up"){let s=Date.now();function t(){return e==="up"||Date.now()-s>W}function i(){return e==="timed out"&&Date.now()-s<=W}return {...r,status:e,lastUpdate:s,isUp:t,isTimedOut:i}}var B=class extends Error{name="AlgoliaError";constructor(r,e){super(r),e&&(this.name=e);}},X=class extends B{stackTrace;constructor(r,e,s){super(r,s),this.stackTrace=e;}},te=class extends X{constructor(r){super("Unreachable hosts - your application id may be incorrect. If the error persists, please reach out to the Algolia Support team: https://alg.li/support.",r,"RetryError");}},b=class extends X{status;constructor(r,e,s,t="ApiError"){super(r,s,t),this.status=e;}},se=class extends B{response;constructor(r,e){super(r,"DeserializationError"),this.response=e;}},oe=class extends b{error;constructor(r,e,s,t){super(r,e,t,"DetailedApiError"),this.error=s;}};function ne(r,e,s){let t=ae(s),i=`${r.protocol}://${r.url}${r.port?`:${r.port}`:""}/${e.charAt(0)==="/"?e.substring(1):e}`;return t.length&&(i+=`?${t}`),i}function ae(r){return Object.keys(r).filter(e=>r[e]!==void 0).sort().map(e=>`${e}=${encodeURIComponent(Object.prototype.toString.call(r[e])==="[object Array]"?r[e].join(","):r[e]).replace(/\+/g,"%20")}`).join("&")}function ie(r,e){if(r.method==="GET"||r.data===void 0&&e.data===void 0)return;let s=Array.isArray(r.data)?r.data:{...r.data,...e.data};return JSON.stringify(s)}function ue(r,e,s){let t={Accept:"application/json",...r,...e,...s},i={};return Object.keys(t).forEach(m=>{let g=t[m];i[m.toLowerCase()]=g;}),i}function ce(r){try{return JSON.parse(r.content)}catch(e){throw new se(e.message,r)}}function le({content:r,status:e},s){try{let t=JSON.parse(r);return "error"in t?new oe(t.message,e,t.error,s):new b(t.message,e,s)}catch{}return new b(r,e,s)}function me({isTimedOut:r,status:e}){return !r&&~~e===0}function de({isTimedOut:r,status:e}){return r||me({isTimedOut:r,status:e})||~~(e/100)!==2&&~~(e/100)!==4}function he({status:r}){return ~~(r/100)===2}function ge(r){return r.map(e=>K(e))}function K(r){let e=r.request.headers["x-algolia-api-key"]?{"x-algolia-api-key":"*****"}:{};return {...r,request:{...r.request,headers:{...r.request.headers,...e}}}}function V({hosts:r,hostsCache:e,baseHeaders:s,logger:t,baseQueryParameters:i,algoliaAgent:m,timeouts:g,requester:a,requestsCache:o,responsesCache:n}){async function c(u){let l=await Promise.all(u.map(h=>e.get(h,()=>Promise.resolve(Q(h))))),P=l.filter(h=>h.isUp()),y=l.filter(h=>h.isTimedOut()),w=[...P,...y];return {hosts:w.length>0?w:u,getTimeout(h,E){return (y.length===0&&h===0?1:y.length+3+h)*E}}}async function d(u,l,P=!0){let y=[],w=ie(u,l),q=ue(s,u.headers,l.headers),h=u.method==="GET"?{...u.data,...l.data}:{},E={...i,...u.queryParameters,...h};if(m.value&&(E["x-algolia-agent"]=m.value),l&&l.queryParameters)for(let f of Object.keys(l.queryParameters))!l.queryParameters[f]||Object.prototype.toString.call(l.queryParameters[f])==="[object Object]"?E[f]=l.queryParameters[f]:E[f]=l.queryParameters[f].toString();let O=0,I=async(f,x)=>{let C=f.pop();if(C===void 0)throw new te(ge(y));let A={...g,...l.timeouts},U={data:w,headers:q,method:u.method,url:ne(C,u.path,E),connectTimeout:x(O,A.connect),responseTimeout:x(O,P?A.read:A.write)},L=N=>{let H={request:U,response:N,host:C,triesLeft:f.length};return y.push(H),H},R=await a.send(U);if(de(R)){let N=L(R);return R.isTimedOut&&O++,t.info("Retryable failure",K(N)),await e.set(C,Q(C,R.isTimedOut?"timed out":"down")),I(f,x)}if(he(R))return ce(R);throw L(R),le(R,y)},Z=r.filter(f=>f.accept==="readWrite"||(P?f.accept==="read":f.accept==="write")),D=await c(Z);return I([...D.hosts].reverse(),D.getTimeout)}function p(u,l={}){let P=u.useReadTransporter||u.method==="GET";if(!P)return d(u,l,P);let y=()=>d(u,l);if((l.cacheable||u.cacheable)!==!0)return y();let q={request:u,requestOptions:l,transporter:{queryParameters:i,headers:s}};return n.get(q,()=>o.get(q,()=>o.set(q,y()).then(h=>Promise.all([o.delete(q),h]),h=>Promise.all([o.delete(q),Promise.reject(h)])).then(([h,E])=>E)),{miss:h=>n.set(q,h)})}return {hostsCache:e,requester:a,timeouts:g,logger:t,algoliaAgent:m,baseHeaders:s,baseQueryParameters:i,hosts:r,request:p,requestsCache:o,responsesCache:n}}var S="5.8.1",_=["eu","us"];function pe(r){return [{url:"query-suggestions.{region}.algolia.com".replace("{region}",r),accept:"readWrite",protocol:"https"}]}function Y({appId:r,apiKey:e,authMode:s,algoliaAgents:t,region:i,...m}){let g=J(r,e,s),a=V({hosts:pe(i),...m,algoliaAgent:M({algoliaAgents:t,client:"QuerySuggestions",version:S}),baseHeaders:{"content-type":"text/plain",...g.headers(),...m.baseHeaders},baseQueryParameters:{...g.queryParameters(),...m.baseQueryParameters}});return {transporter:a,appId:r,clearCache(){return Promise.all([a.requestsCache.clear(),a.responsesCache.clear()]).then(()=>{})},get _ua(){return a.algoliaAgent.value},addAlgoliaAgent(o,n){a.algoliaAgent.add({segment:o,version:n});},setClientApiKey({apiKey:o}){!s||s==="WithinHeaders"?a.baseHeaders["x-algolia-api-key"]=o:a.baseQueryParameters["x-algolia-api-key"]=o;},createConfig(o,n){if(!o)throw new Error("Parameter `configurationWithIndex` is required when calling `createConfig`.");let u={method:"POST",path:"/1/configs",queryParameters:{},headers:{},data:o};return a.request(u,n)},customDelete({path:o,parameters:n},c){if(!o)throw new Error("Parameter `path` is required when calling `customDelete`.");let l={method:"DELETE",path:"/{path}".replace("{path}",o),queryParameters:n||{},headers:{}};return a.request(l,c)},customGet({path:o,parameters:n},c){if(!o)throw new Error("Parameter `path` is required when calling `customGet`.");let l={method:"GET",path:"/{path}".replace("{path}",o),queryParameters:n||{},headers:{}};return a.request(l,c)},customPost({path:o,parameters:n,body:c},d){if(!o)throw new Error("Parameter `path` is required when calling `customPost`.");let P={method:"POST",path:"/{path}".replace("{path}",o),queryParameters:n||{},headers:{},data:c||{}};return a.request(P,d)},customPut({path:o,parameters:n,body:c},d){if(!o)throw new Error("Parameter `path` is required when calling `customPut`.");let P={method:"PUT",path:"/{path}".replace("{path}",o),queryParameters:n||{},headers:{},data:c||{}};return a.request(P,d)},deleteConfig({indexName:o},n){if(!o)throw new Error("Parameter `indexName` is required when calling `deleteConfig`.");let u={method:"DELETE",path:"/1/configs/{indexName}".replace("{indexName}",encodeURIComponent(o)),queryParameters:{},headers:{}};return a.request(u,n)},getAllConfigs(o){let p={method:"GET",path:"/1/configs",queryParameters:{},headers:{}};return a.request(p,o)},getConfig({indexName:o},n){if(!o)throw new Error("Parameter `indexName` is required when calling `getConfig`.");let u={method:"GET",path:"/1/configs/{indexName}".replace("{indexName}",encodeURIComponent(o)),queryParameters:{},headers:{}};return a.request(u,n)},getConfigStatus({indexName:o},n){if(!o)throw new Error("Parameter `indexName` is required when calling `getConfigStatus`.");let u={method:"GET",path:"/1/configs/{indexName}/status".replace("{indexName}",encodeURIComponent(o)),queryParameters:{},headers:{}};return a.request(u,n)},getLogFile({indexName:o},n){if(!o)throw new Error("Parameter `indexName` is required when calling `getLogFile`.");let u={method:"GET",path:"/1/logs/{indexName}".replace("{indexName}",encodeURIComponent(o)),queryParameters:{},headers:{}};return a.request(u,n)},updateConfig({indexName:o,configuration:n},c){if(!o)throw new Error("Parameter `indexName` is required when calling `updateConfig`.");if(!n)throw new Error("Parameter `configuration` is required when calling `updateConfig`.");if(!n.sourceIndices)throw new Error("Parameter `configuration.sourceIndices` is required when calling `updateConfig`.");let l={method:"PUT",path:"/1/configs/{indexName}".replace("{indexName}",encodeURIComponent(o)),queryParameters:{},headers:{},data:n};return a.request(l,c)}}}function Je(r,e,s,t){if(!r||typeof r!="string")throw new Error("`appId` is missing.");if(!e||typeof e!="string")throw new Error("`apiKey` is missing.");if(!s||s&&(typeof s!="string"||!_.includes(s)))throw new Error(`\`region\` is required and must be one of the following: ${_.join(", ")}`);return Y({appId:r,apiKey:e,region:s,timeouts:{connect:F,read:$,write:j},logger:z(),requester:k(),algoliaAgents:[{segment:"Browser"}],authMode:"WithinQueryParameters",responsesCache:v(),requestsCache:v({serializable:!1}),hostsCache:T({caches:[G({key:`${S}-${r}`}),v()]}),...t})}
+	function k(){function r(e){return new Promise(s=>{let t=new XMLHttpRequest;t.open(e.method,e.url,!0),Object.keys(e.headers).forEach(a=>t.setRequestHeader(a,e.headers[a]));let i=(a,o)=>setTimeout(()=>{t.abort(),s({status:0,content:o,isTimedOut:!0});},a),m=i(e.connectTimeout,"Connection timeout"),g;t.onreadystatechange=()=>{t.readyState>t.OPENED&&g===void 0&&(clearTimeout(m),g=i(e.responseTimeout,"Socket timeout"));},t.onerror=()=>{t.status===0&&(clearTimeout(m),clearTimeout(g),s({content:t.responseText||"Network request failed",status:t.status,isTimedOut:!1}));},t.onload=()=>{clearTimeout(m),clearTimeout(g),s({content:t.responseText,status:t.status,isTimedOut:!1});},t.send(e.data);})}return {send:r}}function G(r){let e,s=`algolia-client-js-${r.key}`;function t(){return e===void 0&&(e=r.localStorage||window.localStorage),e}function i(){return JSON.parse(t().getItem(s)||"{}")}function m(a){t().setItem(s,JSON.stringify(a));}function g(){let a=r.timeToLive?r.timeToLive*1e3:null,o=i(),n=Object.fromEntries(Object.entries(o).filter(([,d])=>d.timestamp!==void 0));if(m(n),!a)return;let c=Object.fromEntries(Object.entries(n).filter(([,d])=>{let p=new Date().getTime();return !(d.timestamp+a<p)}));m(c);}return {get(a,o,n={miss:()=>Promise.resolve()}){return Promise.resolve().then(()=>(g(),i()[JSON.stringify(a)])).then(c=>Promise.all([c?c.value:o(),c!==void 0])).then(([c,d])=>Promise.all([c,d||n.miss(c)])).then(([c])=>c)},set(a,o){return Promise.resolve().then(()=>{let n=i();return n[JSON.stringify(a)]={timestamp:new Date().getTime(),value:o},t().setItem(s,JSON.stringify(n)),o})},delete(a){return Promise.resolve().then(()=>{let o=i();delete o[JSON.stringify(a)],t().setItem(s,JSON.stringify(o));})},clear(){return Promise.resolve().then(()=>{t().removeItem(s);})}}}function ee(){return {get(r,e,s={miss:()=>Promise.resolve()}){return e().then(i=>Promise.all([i,s.miss(i)])).then(([i])=>i)},set(r,e){return Promise.resolve(e)},delete(r){return Promise.resolve()},clear(){return Promise.resolve()}}}function T(r){let e=[...r.caches],s=e.shift();return s===void 0?ee():{get(t,i,m={miss:()=>Promise.resolve()}){return s.get(t,i,m).catch(()=>T({caches:e}).get(t,i,m))},set(t,i){return s.set(t,i).catch(()=>T({caches:e}).set(t,i))},delete(t){return s.delete(t).catch(()=>T({caches:e}).delete(t))},clear(){return s.clear().catch(()=>T({caches:e}).clear())}}}function v(r={serializable:!0}){let e={};return {get(s,t,i={miss:()=>Promise.resolve()}){let m=JSON.stringify(s);if(m in e)return Promise.resolve(r.serializable?JSON.parse(e[m]):e[m]);let g=t();return g.then(a=>i.miss(a)).then(()=>g)},set(s,t){return e[JSON.stringify(s)]=r.serializable?JSON.stringify(t):t,Promise.resolve(t)},delete(s){return delete e[JSON.stringify(s)],Promise.resolve()},clear(){return e={},Promise.resolve()}}}var F=1e3,$=2e3,j=3e4;function re(r){let e={value:`Algolia for JavaScript (${r})`,add(s){let t=`; ${s.segment}${s.version!==void 0?` (${s.version})`:""}`;return e.value.indexOf(t)===-1&&(e.value=`${e.value}${t}`),e}};return e}function J(r,e,s="WithinHeaders"){let t={"x-algolia-api-key":e,"x-algolia-application-id":r};return {headers(){return s==="WithinHeaders"?t:{}},queryParameters(){return s==="WithinQueryParameters"?t:{}}}}function M({algoliaAgents:r,client:e,version:s}){let t=re(s).add({segment:e,version:s});return r.forEach(i=>t.add(i)),t}function z(){return {debug(r,e){return Promise.resolve()},info(r,e){return Promise.resolve()},error(r,e){return Promise.resolve()}}}var W=2*60*1e3;function Q(r,e="up"){let s=Date.now();function t(){return e==="up"||Date.now()-s>W}function i(){return e==="timed out"&&Date.now()-s<=W}return {...r,status:e,lastUpdate:s,isUp:t,isTimedOut:i}}var B=class extends Error{name="AlgoliaError";constructor(r,e){super(r),e&&(this.name=e);}},X=class extends B{stackTrace;constructor(r,e,s){super(r,s),this.stackTrace=e;}},te=class extends X{constructor(r){super("Unreachable hosts - your application id may be incorrect. If the error persists, please reach out to the Algolia Support team: https://alg.li/support.",r,"RetryError");}},b=class extends X{status;constructor(r,e,s,t="ApiError"){super(r,s,t),this.status=e;}},se=class extends B{response;constructor(r,e){super(r,"DeserializationError"),this.response=e;}},oe=class extends b{error;constructor(r,e,s,t){super(r,e,t,"DetailedApiError"),this.error=s;}};function ne(r,e,s){let t=ae(s),i=`${r.protocol}://${r.url}${r.port?`:${r.port}`:""}/${e.charAt(0)==="/"?e.substring(1):e}`;return t.length&&(i+=`?${t}`),i}function ae(r){return Object.keys(r).filter(e=>r[e]!==void 0).sort().map(e=>`${e}=${encodeURIComponent(Object.prototype.toString.call(r[e])==="[object Array]"?r[e].join(","):r[e]).replace(/\+/g,"%20")}`).join("&")}function ie(r,e){if(r.method==="GET"||r.data===void 0&&e.data===void 0)return;let s=Array.isArray(r.data)?r.data:{...r.data,...e.data};return JSON.stringify(s)}function ue(r,e,s){let t={Accept:"application/json",...r,...e,...s},i={};return Object.keys(t).forEach(m=>{let g=t[m];i[m.toLowerCase()]=g;}),i}function ce(r){try{return JSON.parse(r.content)}catch(e){throw new se(e.message,r)}}function le({content:r,status:e},s){try{let t=JSON.parse(r);return "error"in t?new oe(t.message,e,t.error,s):new b(t.message,e,s)}catch{}return new b(r,e,s)}function me({isTimedOut:r,status:e}){return !r&&~~e===0}function de({isTimedOut:r,status:e}){return r||me({isTimedOut:r,status:e})||~~(e/100)!==2&&~~(e/100)!==4}function he({status:r}){return ~~(r/100)===2}function ge(r){return r.map(e=>K(e))}function K(r){let e=r.request.headers["x-algolia-api-key"]?{"x-algolia-api-key":"*****"}:{};return {...r,request:{...r.request,headers:{...r.request.headers,...e}}}}function V({hosts:r,hostsCache:e,baseHeaders:s,logger:t,baseQueryParameters:i,algoliaAgent:m,timeouts:g,requester:a,requestsCache:o,responsesCache:n}){async function c(u){let l=await Promise.all(u.map(h=>e.get(h,()=>Promise.resolve(Q(h))))),P=l.filter(h=>h.isUp()),y=l.filter(h=>h.isTimedOut()),w=[...P,...y];return {hosts:w.length>0?w:u,getTimeout(h,E){return (y.length===0&&h===0?1:y.length+3+h)*E}}}async function d(u,l,P=!0){let y=[],w=ie(u,l),q=ue(s,u.headers,l.headers),h=u.method==="GET"?{...u.data,...l.data}:{},E={...i,...u.queryParameters,...h};if(m.value&&(E["x-algolia-agent"]=m.value),l&&l.queryParameters)for(let f of Object.keys(l.queryParameters))!l.queryParameters[f]||Object.prototype.toString.call(l.queryParameters[f])==="[object Object]"?E[f]=l.queryParameters[f]:E[f]=l.queryParameters[f].toString();let O=0,I=async(f,x)=>{let C=f.pop();if(C===void 0)throw new te(ge(y));let A={...g,...l.timeouts},U={data:w,headers:q,method:u.method,url:ne(C,u.path,E),connectTimeout:x(O,A.connect),responseTimeout:x(O,P?A.read:A.write)},L=N=>{let H={request:U,response:N,host:C,triesLeft:f.length};return y.push(H),H},R=await a.send(U);if(de(R)){let N=L(R);return R.isTimedOut&&O++,t.info("Retryable failure",K(N)),await e.set(C,Q(C,R.isTimedOut?"timed out":"down")),I(f,x)}if(he(R))return ce(R);throw L(R),le(R,y)},Z=r.filter(f=>f.accept==="readWrite"||(P?f.accept==="read":f.accept==="write")),D=await c(Z);return I([...D.hosts].reverse(),D.getTimeout)}function p(u,l={}){let P=u.useReadTransporter||u.method==="GET";if(!P)return d(u,l,P);let y=()=>d(u,l);if((l.cacheable||u.cacheable)!==!0)return y();let q={request:u,requestOptions:l,transporter:{queryParameters:i,headers:s}};return n.get(q,()=>o.get(q,()=>o.set(q,y()).then(h=>Promise.all([o.delete(q),h]),h=>Promise.all([o.delete(q),Promise.reject(h)])).then(([h,E])=>E)),{miss:h=>n.set(q,h)})}return {hostsCache:e,requester:a,timeouts:g,logger:t,algoliaAgent:m,baseHeaders:s,baseQueryParameters:i,hosts:r,request:p,requestsCache:o,responsesCache:n}}var S="5.9.0",_=["eu","us"];function pe(r){return [{url:"query-suggestions.{region}.algolia.com".replace("{region}",r),accept:"readWrite",protocol:"https"}]}function Y({appId:r,apiKey:e,authMode:s,algoliaAgents:t,region:i,...m}){let g=J(r,e,s),a=V({hosts:pe(i),...m,algoliaAgent:M({algoliaAgents:t,client:"QuerySuggestions",version:S}),baseHeaders:{"content-type":"text/plain",...g.headers(),...m.baseHeaders},baseQueryParameters:{...g.queryParameters(),...m.baseQueryParameters}});return {transporter:a,appId:r,clearCache(){return Promise.all([a.requestsCache.clear(),a.responsesCache.clear()]).then(()=>{})},get _ua(){return a.algoliaAgent.value},addAlgoliaAgent(o,n){a.algoliaAgent.add({segment:o,version:n});},setClientApiKey({apiKey:o}){!s||s==="WithinHeaders"?a.baseHeaders["x-algolia-api-key"]=o:a.baseQueryParameters["x-algolia-api-key"]=o;},createConfig(o,n){if(!o)throw new Error("Parameter `configurationWithIndex` is required when calling `createConfig`.");let u={method:"POST",path:"/1/configs",queryParameters:{},headers:{},data:o};return a.request(u,n)},customDelete({path:o,parameters:n},c){if(!o)throw new Error("Parameter `path` is required when calling `customDelete`.");let l={method:"DELETE",path:"/{path}".replace("{path}",o),queryParameters:n||{},headers:{}};return a.request(l,c)},customGet({path:o,parameters:n},c){if(!o)throw new Error("Parameter `path` is required when calling `customGet`.");let l={method:"GET",path:"/{path}".replace("{path}",o),queryParameters:n||{},headers:{}};return a.request(l,c)},customPost({path:o,parameters:n,body:c},d){if(!o)throw new Error("Parameter `path` is required when calling `customPost`.");let P={method:"POST",path:"/{path}".replace("{path}",o),queryParameters:n||{},headers:{},data:c||{}};return a.request(P,d)},customPut({path:o,parameters:n,body:c},d){if(!o)throw new Error("Parameter `path` is required when calling `customPut`.");let P={method:"PUT",path:"/{path}".replace("{path}",o),queryParameters:n||{},headers:{},data:c||{}};return a.request(P,d)},deleteConfig({indexName:o},n){if(!o)throw new Error("Parameter `indexName` is required when calling `deleteConfig`.");let u={method:"DELETE",path:"/1/configs/{indexName}".replace("{indexName}",encodeURIComponent(o)),queryParameters:{},headers:{}};return a.request(u,n)},getAllConfigs(o){let p={method:"GET",path:"/1/configs",queryParameters:{},headers:{}};return a.request(p,o)},getConfig({indexName:o},n){if(!o)throw new Error("Parameter `indexName` is required when calling `getConfig`.");let u={method:"GET",path:"/1/configs/{indexName}".replace("{indexName}",encodeURIComponent(o)),queryParameters:{},headers:{}};return a.request(u,n)},getConfigStatus({indexName:o},n){if(!o)throw new Error("Parameter `indexName` is required when calling `getConfigStatus`.");let u={method:"GET",path:"/1/configs/{indexName}/status".replace("{indexName}",encodeURIComponent(o)),queryParameters:{},headers:{}};return a.request(u,n)},getLogFile({indexName:o},n){if(!o)throw new Error("Parameter `indexName` is required when calling `getLogFile`.");let u={method:"GET",path:"/1/logs/{indexName}".replace("{indexName}",encodeURIComponent(o)),queryParameters:{},headers:{}};return a.request(u,n)},updateConfig({indexName:o,configuration:n},c){if(!o)throw new Error("Parameter `indexName` is required when calling `updateConfig`.");if(!n)throw new Error("Parameter `configuration` is required when calling `updateConfig`.");if(!n.sourceIndices)throw new Error("Parameter `configuration.sourceIndices` is required when calling `updateConfig`.");let l={method:"PUT",path:"/1/configs/{indexName}".replace("{indexName}",encodeURIComponent(o)),queryParameters:{},headers:{},data:n};return a.request(l,c)}}}function Je(r,e,s,t){if(!r||typeof r!="string")throw new Error("`appId` is missing.");if(!e||typeof e!="string")throw new Error("`apiKey` is missing.");if(!s||s&&(typeof s!="string"||!_.includes(s)))throw new Error(`\`region\` is required and must be one of the following: ${_.join(", ")}`);return Y({appId:r,apiKey:e,region:s,timeouts:{connect:F,read:$,write:j},logger:z(),requester:k(),algoliaAgents:[{segment:"Browser"}],authMode:"WithinQueryParameters",responsesCache:v(),requestsCache:v({serializable:!1}),hostsCache:T({caches:[G({key:`${S}-${r}`}),v()]}),...t})}
 
@@ -10,0 +10,0 @@ exports.apiClientVersion = S;

dist/builds/fetch.js

@@ -14,3 +14,3 @@ // builds/fetch.ts
 import { createAuth, createTransporter, getAlgoliaAgent } from "@algolia/client-common";
-var apiClientVersion = "5.8.1";
+var apiClientVersion = "5.9.0";
 var REGIONS = ["eu", "us"];
@@ -17,0 +17,0 @@ function getDefaultHosts(region) {

dist/builds/node.js

@@ -14,3 +14,3 @@ // builds/node.ts
 import { createAuth, createTransporter, getAlgoliaAgent } from "@algolia/client-common";
-var apiClientVersion = "5.8.1";
+var apiClientVersion = "5.9.0";
 var REGIONS = ["eu", "us"];
@@ -17,0 +17,0 @@ function getDefaultHosts(region) {

dist/fetch.d.ts

@@ -256,8 +256,9 @@ import * as _algolia_client_common from '@algolia/client-common';
 
-declare const apiClientVersion = "5.8.1";
+declare const apiClientVersion = "5.9.0";
 declare const REGIONS: readonly ["eu", "us"];
 type Region = (typeof REGIONS)[number];
-declare function createQuerySuggestionsClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, region: regionOption, ...options }: CreateClientOptions & {
+type RegionOptions = {
     region: Region;
-}): {
+};
+declare function createQuerySuggestionsClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, region: regionOption, ...options }: CreateClientOptions & RegionOptions): {
     transporter: _algolia_client_common.Transporter;
@@ -407,2 +408,2 @@ /**
 
-export { type AppID, type BaseResponse, type ConfigStatus, type Configuration, type ConfigurationResponse, type ConfigurationWithIndex, type CustomDeleteProps, type CustomGetProps, type CustomPostProps, type CustomPutProps, type DeleteConfigProps, type ErrorBase, type Facet, type GetConfigProps, type GetConfigStatusProps, type GetLogFileProps, type Languages, type LogFile, type LogLevel, type QuerySuggestionsClient, type Region, type SourceIndex, type UpdateConfigProps, apiClientVersion, querySuggestionsClient };
+export { type AppID, type BaseResponse, type ConfigStatus, type Configuration, type ConfigurationResponse, type ConfigurationWithIndex, type CustomDeleteProps, type CustomGetProps, type CustomPostProps, type CustomPutProps, type DeleteConfigProps, type ErrorBase, type Facet, type GetConfigProps, type GetConfigStatusProps, type GetLogFileProps, type Languages, type LogFile, type LogLevel, type QuerySuggestionsClient, type Region, type RegionOptions, type SourceIndex, type UpdateConfigProps, apiClientVersion, querySuggestionsClient };

dist/node.d.ts

@@ -256,8 +256,9 @@ import * as _algolia_client_common from '@algolia/client-common';
 
-declare const apiClientVersion = "5.8.1";
+declare const apiClientVersion = "5.9.0";
 declare const REGIONS: readonly ["eu", "us"];
 type Region = (typeof REGIONS)[number];
-declare function createQuerySuggestionsClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, region: regionOption, ...options }: CreateClientOptions & {
+type RegionOptions = {
     region: Region;
-}): {
+};
+declare function createQuerySuggestionsClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, region: regionOption, ...options }: CreateClientOptions & RegionOptions): {
     transporter: _algolia_client_common.Transporter;
@@ -407,2 +408,2 @@ /**
 
-export { type AppID, type BaseResponse, type ConfigStatus, type Configuration, type ConfigurationResponse, type ConfigurationWithIndex, type CustomDeleteProps, type CustomGetProps, type CustomPostProps, type CustomPutProps, type DeleteConfigProps, type ErrorBase, type Facet, type GetConfigProps, type GetConfigStatusProps, type GetLogFileProps, type Languages, type LogFile, type LogLevel, type QuerySuggestionsClient, type Region, type SourceIndex, type UpdateConfigProps, apiClientVersion, querySuggestionsClient };
+export { type AppID, type BaseResponse, type ConfigStatus, type Configuration, type ConfigurationResponse, type ConfigurationWithIndex, type CustomDeleteProps, type CustomGetProps, type CustomPostProps, type CustomPutProps, type DeleteConfigProps, type ErrorBase, type Facet, type GetConfigProps, type GetConfigStatusProps, type GetLogFileProps, type Languages, type LogFile, type LogLevel, type QuerySuggestionsClient, type Region, type RegionOptions, type SourceIndex, type UpdateConfigProps, apiClientVersion, querySuggestionsClient };

dist/src/querySuggestionsClient.js

 // src/querySuggestionsClient.ts
 import { createAuth, createTransporter, getAlgoliaAgent } from "@algolia/client-common";
-var apiClientVersion = "5.8.1";
+var apiClientVersion = "5.9.0";
 var REGIONS = ["eu", "us"];
@@ -5,0 +5,0 @@ function getDefaultHosts(region) {

package.json

 {
-  "version": "5.8.1",
+  "version": "5.9.0",
   "repository": {
@@ -52,14 +52,14 @@ "type": "git",
   "dependencies": {
-    "@algolia/client-common": "5.8.1",
-    "@algolia/requester-browser-xhr": "5.8.1",
-    "@algolia/requester-fetch": "5.8.1",
-    "@algolia/requester-node-http": "5.8.1"
+    "@algolia/client-common": "5.9.0",
+    "@algolia/requester-browser-xhr": "5.9.0",
+    "@algolia/requester-fetch": "5.9.0",
+    "@algolia/requester-node-http": "5.9.0"
   },
   "devDependencies": {
     "@arethetypeswrong/cli": "0.16.4",
-    "@types/node": "22.7.4",
+    "@types/node": "22.7.5",
     "publint": "0.2.11",
     "rollup": "4.24.0",
     "tsup": "8.3.0",
-    "typescript": "5.6.2"
+    "typescript": "5.6.3"
   },
@@ -66,0 +66,0 @@ "engines": {

README.md

@@ -35,2 +35,5 @@ <p align="center">
 
+> [!TIP]
+> This API client is already a dependency of [the algoliasearch client](https://www.npmjs.com/package/algoliasearch), you don't need to manually install `@algolia/client-query-suggestions` if you already have `algoliasearch` installed.
+
 To get started, you first need to install @algolia/client-query-suggestions (or any other available API client package).
@@ -42,7 +45,7 @@ All of our clients comes with type definition, and are available for both browser and node environments.
 ```bash
-yarn add @algolia/client-query-suggestions@5.8.1
+yarn add @algolia/client-query-suggestions@5.9.0
 # or
-npm install @algolia/client-query-suggestions@5.8.1
+npm install @algolia/client-query-suggestions@5.9.0
 # or
-pnpm add @algolia/client-query-suggestions@5.8.1
+pnpm add @algolia/client-query-suggestions@5.9.0
 ```
@@ -55,3 +58,3 @@
 ```html
-<script src="https://cdn.jsdelivr.net/npm/@algolia/client-query-suggestions@5.8.1/dist/builds/browser.umd.js"></script>
+<script src="https://cdn.jsdelivr.net/npm/@algolia/client-query-suggestions@5.9.0/dist/builds/browser.umd.js"></script>
 ```
@@ -58,0 +61,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

394628

increased by0.22%

Lines of code

3824

increased by0.08%

Number of lines in readme file

78

increased by4%

Dependency changes

• + Added@algolia/client-common@5.9.0(transitive)

• + Added@algolia/requester-browser-xhr@5.9.0(transitive)

• + Added@algolia/requester-fetch@5.9.0(transitive)

• + Added@algolia/requester-node-http@5.9.0(transitive)

• - Removed@algolia/client-common@5.8.1(transitive)

• - Removed@algolia/requester-browser-xhr@5.8.1(transitive)

• - Removed@algolia/requester-fetch@5.8.1(transitive)

• - Removed@algolia/requester-node-http@5.8.1(transitive)

• Updated@algolia/client-common@5.9.0

• Updated@algolia/requester-browser-xhr@5.9.0

• Updated@algolia/requester-fetch@5.9.0

• Updated@algolia/requester-node-http@5.9.0