@sinequa/atomic 2.3.2 → 2.5.0

package/README.md

@@ -1,10 +1,9 @@
 <div align="center">
 
 <img src="https://img.shields.io/npm/v/@sinequa/atomic?style=for-the-badge&color=0ea5e9&label=@sinequa%2Fatomic" alt="npm version" />
-<img src="https://img.shields.io/badge/TypeScript-5.x-3178c6?style=for-the-badge&logo=typescript&logoColor=white" alt="TypeScript" />
+<img src="https://img.shields.io/badge/TypeScript-7.x-3178c6?style=for-the-badge&logo=typescript&logoColor=white" alt="TypeScript" />
 <img src="https://img.shields.io/badge/ESM-ready-f59e0b?style=for-the-badge" alt="ESM" />
 <img src="https://img.shields.io/badge/SPFx-ready-0078d4?style=for-the-badge&logo=microsoftsharepoint&logoColor=white" alt="SPFx" />
-<img src="https://img.shields.io/npm/l/@sinequa/atomic?style=for-the-badge&color=22c55e" alt="MIT License" />
 
 <br /><br />
 
@@ -14,7 +13,7 @@
 Authentication, search, aggregations, datasets, preview — everything typed, tree-shakable, zero runtime dependencies.  
 SPFx-ready via the `@sinequa/atomic/spfx` subpath export.
 
-[Docs](https://sinequa.github.io/sba-mint/atomic/intro) · [API Reference](https://sinequa.github.io/sba-mint/atomic/api/app)
+[Docs](./docs/index.mdx) · [Get started](./docs/start/index.mdx) · [Reference](./docs/reference/index.mdx)
 
 </div>
 
@@ -39,16 +38,26 @@ npm install @microsoft/sp-http --save-peer
 ## At a glance
 
 ```typescript
-import { login, isAuthenticated, fetchQuery, fetchAggregation } from '@sinequa/atomic';
+import { setGlobalConfig, isAuthenticated, login, fetchQuery } from '@sinequa/atomic';
+
+setGlobalConfig({ app: 'my-app', backendUrl: 'https://my-sinequa-server.example.com' });
 
 if (!isAuthenticated()) {
   await login({ username: 'alice', password: 's3cr3t' });
 }
 
-const results = await fetchQuery({ query: 'knowledge management', pageSize: 10 });
-const facets  = await fetchAggregation({ aggregation: 'company', query: 'knowledge management' });
+// A query is a plain object; only `name` — the query web service — is required.
+const result = await fetchQuery({ name: '<your-query>', text: 'knowledge management', pageSize: 10 });
+
+// One round-trip: the documents are in `records`, the facet counts in `aggregations`.
+// Check `$error` before concluding anything from an empty `records`.
+const { records, aggregations, $error } = result;
 ```
 
+`fetchAggregation(aggregation, query)` is for **paging** an aggregation you already received — it
+takes the `Aggregation` object off `result.aggregations` and the same query, as two positional
+arguments. See [Aggregations](./docs/search/aggregations.mdx).
+
 ---
 
 ## SharePoint Framework (SPFx)
@@ -67,14 +76,17 @@ const client = await this.context.aadHttpClientFactory
 initializeAadHttpClient(client);
 
 // All subsequent API calls route through AadHttpClient automatically:
-const results = await fetchQuery({ name: '_query', text: 'knowledge management' });
+const results = await fetchQuery({ name: '<your-query>', text: 'knowledge management' });
 ```
 
 Call `initializeAadHttpClient(null)` to detach the client (e.g. in `onDispose`).
 
 > The `./spfx` subpath re-exports everything from `@sinequa/atomic` and adds
-> `initializeAadHttpClient`, `AadHttpClientLike`, and `AadHttpResponseLike`.
-> Standard (non-SPFx) consumers use `@sinequa/atomic` directly — no changes needed.
+> `initializeAadHttpClient`, `aadHttpClientManager`, `createSpfxHttpAdapter`, `AadHttpClientLike`
+> and `AadHttpResponseLike`. `initializeAadHttpClient` registers the client globally for the free
+> functions; `createSpfxHttpAdapter(aadHttpClient)` is the same transport as an `httpAdapter` for
+> `createAtomicClient`. Standard (non-SPFx) consumers use `@sinequa/atomic` directly — no changes
+> needed. See [SPFx](./docs/integration/spfx.mdx).
 
 ---
 
@@ -83,9 +95,11 @@ Call `initializeAadHttpClient(null)` to detach the client (e.g. in `onDispose`).
 ### Client (experimental)
 
 `createAtomicClient(config)` returns an isolated client — its own configuration, session and event
-subscribers — exposing `client.config`, `client.auth` and `client.http`. Several clients can target
-different backends from the same page, and each takes its `fetch`/`storage`/`logger` as
-configuration, which removes the need for module mocks in tests.
+subscribers — exposing `client.config`, `client.configure()`, `client.initializeConfig()`,
+`client.auth`, `client.http` and `client.api` (the typed endpoints, e.g.
+`client.api.query.search(query)`). Several clients can target different backends from the same page,
+and each takes its transport and auth knobs as configuration (`httpAdapter`, and
+`auth: { fetch, storage, logger }`), which removes the need for module mocks in tests.
 
 ```typescript
 import { createAtomicClient } from '@sinequa/atomic';
@@ -98,6 +112,7 @@ const results = await client.http.post('api/v1/search.query', { text: 'hello' })
 The free functions below keep working unchanged: they run on a default client whose configuration
 **is** `globalConfig`, and `getDefaultClient()` hands back that very instance — useful from code
 that cannot receive one (a distributed web component, a plugin).
+See [The client](./docs/core/client.mdx) and [Multiple backends](./docs/integration/multiple-backends.mdx).
 
 ### Authentication
 
@@ -105,34 +120,41 @@ Full auth lifecycle — from first handshake to logout.
 
 | Export | Description |
 |---|---|
-| `isAuthenticated()` | Returns `true` when a valid token is present |
-| `login(credentials?)` | Login — switches on the resolved `authMode` (credentials / SSO / OAuth / SAML / bearer) |
+| `isAuthenticated()` | Synchronous. `true` when a CSRF token is stored **or** a token-less session was recorded (ambient SSO issues no client token) |
+| `hasSession()` | Asks the server when nothing is stored, and never redirects — unlike `login()` |
+| `login(credentials?)` | Login — switches on the resolved `authMode` (credentials / SSO / OAuth / SAML / bearer / unknown) |
 | `logout()` | Clears session, returns the server's `redirectUrl` |
-| `clearSessionTokens()` | Drops the in-memory/stored session tokens without a server round-trip |
+| `clearSessionTokens()` | Drops the local session (tokens, token-less flag) and emits `authenticated: false`, without a server round-trip |
 | `detectAuthMode(config, preLogin?)` | Pure resolution of the `AuthMode` from config + server pre-login (no I/O) |
 | `getToken()` / `setToken(token)` | Read/write the stored CSRF token |
-| `getJWToken(credentials?)` | Fetches a JWT from the server, returns the CSRF token |
+| `requestWebTokenSession(credentials?)` | POSTs `security.webtoken`. The JWT lands in a cookie; the returned (and stored) value is the **CSRF token**. Omit the credentials to use the configured bearer token |
 | `getCsrfToken()` | CSRF token for mutating requests |
 | `deleteWebTokenCookie()` | Explicitly removes the web token cookie |
-| `onAuthEvent(event, handler)` | Typed subscription to the auth lifecycle (`authenticated`, `unauthorized`, `tokenRefreshed`, `loggedOut`) — returns the unsubscribe function |
-| `tryAutoAuthentication()` | Probes the server for auto-authentication (OIDC) — used by `login()` in `unknown` mode |
+| `onAuthEvent(event, handler)` | Typed subscription to the auth lifecycle (`authenticated`, `unauthorized`, `requestFailed`, `tokenRefreshed`, `loggedOut`) — returns the unsubscribe function |
+| `tryAutoAuthentication()` | Probes a protected endpoint for server-side auto-authentication (OIDC, IIS Negotiate) — used by `login()` in `sso`, `unknown` and `bearer` modes. Never throws |
+| `isRedirectPending()` | Whether an OAuth/SAML redirect is in flight and has not established a session yet |
 | `tryOAuthAuthentication()` / `trySAMLAuthentication()` | Redirect to the configured identity provider (with a one-shot redirect-loop guard) |
 | `emitAuthenticatedEvent(bool)` | Dispatches the DOM `'authenticated'` CustomEvent (on `document`, bubbles to `window`) |
 
+> `getJWToken` is **`@deprecated`**: it is an alias of `requestWebTokenSession`, renamed because the
+> old name suggested it returned the JWT. It will be removed in the next major.
+
 The authentication layer is configurable via `setGlobalConfig({ auth: { … } })` (`AuthOptions`):
-request timeout, auto-auth probe endpoint, injectable storage/logger/fetch, and the requests'
-`credentials` mode.
+`timeoutMs`, `probeEndpoint`, injectable `storage`/`logger`/`fetch`, the requests' `credentials`
+mode, and `recoverFromUnauthorized` — the hook that re-establishes a session after a 401 and gets
+the request replayed once. See [Authentication](./docs/auth/index.mdx) and
+[Handling 401](./docs/auth/handling-401.mdx).
 
 ```typescript
 import { isAuthenticated, login, logout } from '@sinequa/atomic';
 
 if (!isAuthenticated()) {
-  // Auto-resolve: reuse an existing session if any, otherwise try SSO and
-  // fall back to the credentials form. Provider resolved from server config.
+  // Auto-resolve: reuse an existing session if any, otherwise follow the resolved
+  // `authMode` — in `unknown` mode, probe for SSO then fall back to the credentials form.
   const ok = await login();
 
-  // — or — credential-based login, bypasses SSO
-  const ok = await login({ username: 'alice', password: 's3cr3t' });
+  // — or — explicit credentials, which bypass mode detection entirely.
+  const okWithCredentials = await login({ username: 'alice', password: 's3cr3t' });
 }
 
 const redirectUrl = await logout();
@@ -144,7 +166,7 @@ const redirectUrl = await logout();
 typed discriminated union — no more juggling overlapping booleans:
 
 ```typescript
-import { AuthMode, setGlobalConfig } from '@sinequa/atomic';
+import { AuthMode, globalConfig, setGlobalConfig } from '@sinequa/atomic';
 
 setGlobalConfig({ authMode: AuthMode.credentials() });        // username/password form
 setGlobalConfig({ authMode: AuthMode.sso() });                // browser/proxy-injected auth
@@ -153,14 +175,16 @@ setGlobalConfig({ authMode: AuthMode.saml('my-provider') });  // redirect to a S
 setGlobalConfig({ authMode: AuthMode.bearer(token) });        // server-to-server bearer token
 setGlobalConfig({ authMode: AuthMode.unknown() });            // try SSO, then fall back to credentials
 
-// `login()` and `detectAuthMode()` branch on `authMode.kind`:
-const kind = globalConfig.authMode.kind; // 'credentials' | 'sso' | 'oauth' | 'saml' | 'bearer' | 'unknown'
+// `login()` and `detectAuthMode()` branch on `authMode.kind`. Every key of `globalConfig` is
+// optional, so read it through `?.` — the default is `AuthMode.unknown()`.
+const kind = globalConfig.authMode?.kind; // 'credentials' | 'sso' | 'oauth' | 'saml' | 'bearer' | 'unknown'
 ```
 
 > **Migrating from 1.x:** the booleans `useCredentials` / `useSSO` / `useSAML` are now
 > **`@deprecated` read-only getters** derived from `authMode`. Reading them still works, and writing
 > them through `setGlobalConfig({ useSSO: true })` is translated into the matching `authMode` — so
 > existing code keeps working. Prefer `authMode.kind` (and the `AuthMode.*` constructors) in new code.
+> Full upgrade notes: [Migrating from 1.x](./docs/reference/migrating-from-1x.mdx).
 
 ---
 
@@ -171,7 +195,9 @@ Every Sinequa v1 endpoint has a typed wrapper.
 ```typescript
 import {
   fetchApp,
+  fetchAppPreLogin,
   fetchQuery,
+  fetchBulkQuery,
   fetchAggregation,
   fetchDataset,
   fetchPreview,
@@ -179,15 +205,18 @@ import {
   fetchSimilarDocuments,
   fetchSponsoredLinks,
   fetchSuggest,
-  fetchTextChunk,
+  fetchTextChunks,
   fetchUserSettings,
-  fetchAudit,
   fetchLabels,
   fetchQueryExport,
   fetchQueryIntent,
+  searchPrincipals,
 } from '@sinequa/atomic';
 ```
 
+Auditing is not a `fetch*` function: use `Audit.notify(...)`, plus the record decorators
+`addAuditAdditionalInfo`, `addSessionId` and `addUrl`. See [Audit](./docs/integration/audit.mdx).
+
 ### Web API — v2
 
 ```typescript
@@ -195,10 +224,13 @@ import {
   fetchUserProfile,
   fetchVersion,
   fetchChangePassword,
-  fetchForgotPassword,
+  fetchSendPasswordResetEmail,
 } from '@sinequa/atomic';
 ```
 
+The full endpoint list — with the `client.api` method and the free function for each — is in
+[Endpoints](./docs/reference/endpoints.mdx).
+
 ---
 
 ### Helpers
@@ -207,16 +239,20 @@ Utilities for transforming Sinequa data structures.
 
 ```typescript
 import {
-  getMetadata,
-  getMetadataWithValues, // parses comma-separated metadata strings
+  getMetadata,           // metadata of an article as `string[]` (splits comma-separated values)
+  getMetadataWithValues, // same, as `{ display, value }[]`
   makeColumn,
+  extraColumns,
   resolveToColumnName,
+  resultPages,
   escapeExpr,
   guid,
   isObject,
 } from '@sinequa/atomic';
 ```
 
+More in [Helpers](./docs/reference/helpers.mdx).
+
 #### Filter builder
 
 Build structured `query.filters` without hand-writing filter objects. Combinators ignore falsy
@@ -235,11 +271,16 @@ const filters = filter.and(
   onlyRecent && filter.between('modified', '2024-01-01', '2024-12-31'),
 );
 
-await fetchQuery({ name: '_query', text: 'report', filters });
+await fetchQuery({ name: '<your-query>', text: 'report', filters });
 ```
 
 Leaf operators: `eq` · `neq` · `gt` · `gte` · `lt` · `lte` · `like` · `contains` · `regex` · `isNull` · `isNotNull` · `in` · `between`. Combinators: `and` · `or` · `not`.
 
+`filter.distribution(field, item.value)` handles the one case the leaf operators cannot: a
+**distribution** aggregation item (a date or size bucket), whose `value` is an expression the server
+built rather than a value. Passing it to `filter.eq` makes the backend answer
+`500 — "Field type error"`. See [Filters](./docs/search/filters.mdx).
+
 ---
 
 ### Utilities
@@ -247,15 +288,19 @@ Leaf operators: `eq` · `neq` · `gt` · `gte` · `lt` · `lte` · `like` · `co
 ```typescript
 import {
   bisect,
-  formatDate,
-  parseDate,
-  logger,
-  queryParamsToString,
-  toSQL,
-  syslang,
+  sysLang,                     // resolves `all[fr]tous[de]alle` against a locale
+  getRelativeDate,             // and `getOffsetFromDates`
+  getQueryParamsFromUrl,       // and `getUrlParamsFromQueryParams`, `getFiltersFromUrl`, …
+  addConcepts,                 // and `getConcepts`, `parseText`, `rewriteText`, `removeConcept(s)`
+  notify,
+  configureLogger,             // and the `debug` / `info` / `warn` / `error` bindings, `LogLevel`
 } from '@sinequa/atomic';
 ```
 
+> The library's verbosity is set with `configureLogger({ level: LogLevel.DEBUG })`, **not** through
+> a configuration key. See [Logging](./docs/integration/logging.mdx) and
+> [URL state](./docs/search/url-state.mdx).
+
 ---
 
 ## Types
@@ -275,6 +320,8 @@ import type {
 } from '@sinequa/atomic';
 ```
 
+Which type comes back from which call: [Type map](./docs/reference/types-map.mdx).
+
 ---
 
 ## Configuration
@@ -291,23 +338,40 @@ setGlobalConfig({
   authMode: AuthMode.unknown(), // optional — defaults to `unknown`
 });
 
-// read it back
-console.log(globalConfig.backendUrl, globalConfig.authMode.kind);
+// read it back — every key is optional on `globalConfig`, so `?.` is required
+console.log(globalConfig.backendUrl, globalConfig.authMode?.kind);
 ```
 
-> `appInitializerFn` is also exported as an alias of `initializeAppConfig()`, which resolves the
-> `authMode` from the server pre-login response during app bootstrap.
+Call `initializeAppConfig()` once at bootstrap: it fills in `backendUrl`/`app` from the browser URL
+when they were not provided, then resolves the `authMode` from the server's pre-login response.
+
+> `appInitializerFn` is a **`@deprecated`** alias of `initializeAppConfig` — use the latter.
+
+Three declared keys are read by nothing, and setting them has no effect: `logLevel` (set the level
+with `configureLogger({ level })`), `loginPath` (routing is yours — use `recoverFromUnauthorized` or
+the `unauthorized` event) and `createRoutes`. Every key, with its default:
+[Configuration keys](./docs/reference/config-keys.mdx).
 
 ---
 
 ## Testing
 
 ```bash
-npm test          # run the vitest suite
-npm test -- --ui  # interactive UI
+npm test                    # vitest, watch mode
+npm test -- --watch=false   # single run (what CI does)
 ```
 
-Coverage spans authentication flows (`AuthMode` detection, OAuth, SAML, credentials), all API endpoints, error handling, the filter builder, metadata parsing, date utilities, and SQL helpers.
+`--ui` is not available out of the box: `@vitest/ui` is an optional peer of vitest and is not
+installed here — `npm i -D @vitest/ui` first.
+
+Coverage is deepest on authentication (`AuthMode` detection, OAuth, SAML, credentials, tokens,
+401 recovery) and on the HTTP helpers. On the endpoints it is targeted rather than exhaustive —
+`fetchQuery`, `fetchAggregation`, `fetchPrincipal`, `searchPrincipals`, `fetchApp` and the
+document-upload containers. Also covered: the filter builder, metadata parsing, column resolution,
+pagination, date utilities and the SQL value helper.
+
+Injecting `fetch`, `storage` and `logger` through the configuration is what lets a test avoid module
+mocks — see [Testing](./docs/integration/testing.mdx).
 
 ---
 
@@ -326,18 +390,17 @@ npm run dev:pack     # build + pack locally
 1. All tests must pass.
 2. Lint with [Biome](https://biomejs.dev/) — `npx @biomejs/biome check --write .`
 3. Follow [Conventional Commits](https://www.conventionalcommits.org/).
-4. New public API → add tests + JSDoc.
-
----
-
-## License
-
-MIT — see [LICENSE](./LICENSE).
+4. Any change touching `src/` needs a **changeset** in the same commit (`npm run changeset`, then
+   `npm run changeset:status` to check) — the `changeset-check` CI job blocks the merge without one.
+   Add `#skip-changeset` to the MR title for a change that does not touch the published library.
+   Full guide, with examples: [`CONTRIBUTING-changesets.md`](./CONTRIBUTING-changesets.md).
+5. New public API → add tests + JSDoc, and export it from `src/index.ts` (a helper that is written
+   and tested but not re-exported from the barrel is not part of the public API).
 
 ---
 
 <div align="center">
 
-Built for the [Sinequa](https://www.sinequa.com/) ecosystem · [Report an issue](https://github.com/Product/sba-atomic-js/issues)
+Built for the [Sinequa](https://www.sinequa.com/) ecosystem · [Report an issue](https://gitlab.chapsvision.in/sinequa/rnd/sba-atomic-js/-/issues)
 
 </div>

package/dist/atomic.cjs

@@ -1 +1 @@
-Object.defineProperty(exports,Symbol.toStringTag,{value:`Module`});const e=require("./src-DQYL0h7T.cjs");exports.API=e.st,exports.ApiError=e.In,exports.Audit=e.bt,exports.AuditEventType=e.Kt,exports.AuthMode=e.qn,exports.DidYouMeanKind=e.Ht,exports.EngineType=e.Gt,exports.EngineTypeModifier=e.Wt,exports.LogLevel=e.$n,exports.MINIMUM_COMPATIBLE_SERVER_API_VERSION=e.Ut,exports.RFMDisplay=e.Vt,exports.ServerError=e.Nn,exports.TimeoutError=e.En,exports.UnauthorizedError=e.Fn,exports.addAuditAdditionalInfo=e.xt,exports.addConcepts=e.g,exports.addSessionId=e.St,exports.addUrl=e.Ct,exports.aggItemRegex=e.C,exports.aggregationItemStrictCompare=e.w,exports.appInitializerFn=e.Qt,exports.applyConfig=e.Wn,exports.assertNever=e._n,exports.bisect=e.S,exports.buildPathsAndLevels=e.it,exports.clearSessionTokens=e.un,exports.configureLogger=e.er,exports.createAtomicClient=e.k,exports.createContainer=e.L,exports.createHeaders=e.Ln,exports.createHeadersWithContext=e.Rn,exports.createTimeoutController=e.Tn,exports.createUserProfile=e.M,Object.defineProperty(exports,"debug",{enumerable:!0,get:function(){return e.tr}}),exports.del=e.on,exports.delWithContext=e.sn,exports.deleteContainerDocuments=e.R,exports.deleteContainers=e.z,exports.deleteUserProfileProperty=e.N,exports.deleteUserSettings=e.G,exports.deleteWebTokenCookie=e.fn,exports.detectAuthMode=e.Sn,exports.emitAuthenticatedEvent=e.Bn,Object.defineProperty(exports,"error",{enumerable:!0,get:function(){return e.nr}}),exports.escapeExpr=e.wt,exports.expiresSoon=e.Yt,exports.extraColumns=e.zt,exports.fetchAggregation=e.yt,exports.fetchApp=e.$t,exports.fetchAppPreLogin=e.en,exports.fetchBulkQuery=e.at,exports.fetchChangePassword=e.W,exports.fetchDataset=e.gt,exports.fetchDatasetList=e._t,exports.fetchDatasets=e.vt,exports.fetchLabels=e.mt,exports.fetchPreview=e.ft,exports.fetchPreviewUrl=e.pt,exports.fetchPrincipal=e.ct,exports.fetchPrincipalList=e.lt,exports.fetchPrincipalUserid=e.ut,exports.fetchPrincipalUserids=e.dt,exports.fetchQuery=e.ot,exports.fetchQueryExport=e.rt,exports.fetchQueryIntent=e.nt,exports.fetchSendPasswordResetEmail=e.I,exports.fetchSimilarDocuments=e.et,exports.fetchSponsoredLinks=e.$,exports.fetchSuggest=e.X,exports.fetchSuggestField=e.Z,exports.fetchSuggestQuery=e.Q,exports.fetchTextChunks=e.Y,exports.fetchUserProfile=e.P,exports.fetchUserSettings=e.K,exports.fetchVersion=e.j,exports.filter=e.Lt,exports.get=e.bn,exports.getConcepts=e._,exports.getContainer=e.B,exports.getCsrfToken=e.yn,exports.getDefaultClient=e.A,exports.getFiltersFromURI=e.r,exports.getFiltersFromUrl=e.i,exports.getHelpIndexUrl=e.t,exports.getIdFromUrl=e.a,exports.getJWToken=e.hn,exports.getMetadata=e.Ft,exports.getMetadataWithValues=e.It,exports.getOffsetFromDates=e.m,exports.getQueryPageFromUrl=e.o,exports.getQueryParamsFromUrl=e.s,exports.getQueryTabFromUrl=e.c,exports.getQueryTextFromUrl=e.l,exports.getRelativeDate=e.h,exports.getTime=e.Tt,exports.getToken=e.zn,exports.getUrlParamsFromQueryParams=e.u,exports.getWithContext=e.xn,exports.globalConfig=e.Gn,exports.guid=e.Et,exports.handleResponse=e.jn,exports.handleResponseWithContext=e.Mn,exports.hasSession=e.vn,Object.defineProperty(exports,"info",{enumerable:!0,get:function(){return e.rr}}),exports.initializeAppConfig=e.tn,exports.isArrayBuffer=e.Dt,exports.isAuthenticated=e.cn,exports.isBlob=e.Ot,exports.isDate=e.kt,exports.isExpired=e.Xt,exports.isExternalAuthMode=e.Jn,exports.isJsonable=e.At,exports.isNotInputEvent=e.p,exports.isObject=e.jt,exports.isRedirectPending=e.ln,exports.isString=e.Mt,exports.labels=e.ht,exports.legacyBooleansToAuthMode=e.Yn,exports.legacyFilterToFilter=e.Rt,exports.listContainerDocuments=e.V,exports.listContainers=e.H,exports.login=e.pn,exports.logout=e.dn,exports.makeColumn=e.Bt,exports.notify=e.f,exports.onAuthEvent=e.ar,exports.openParentNodes=e.T,exports.parseText=e.v,exports.parseValueAndOperatorFromItem=e.E,exports.patch=e.in,exports.patchUserProfile=e.F,exports.patchUserSettings=e.q,exports.patchWithContext=e.an,exports.post=e.Dn,exports.postWithContext=e.On,exports.put=e.nn,exports.putWithContext=e.rn,exports.queryParamsFromUrl=e.d,exports.removeConcept=e.y,exports.removeConcepts=e.b,exports.requestWebTokenSession=e.gn,exports.resolveBearerToken=e.Xn,exports.resolveNoAutoAuthentication=e.kn,exports.resolveNoAutoAuthenticationWithContext=e.An,exports.resolveOAuthProvider=e.Zn,exports.resolveSAMLProvider=e.Qn,exports.resolveToColumnName=e.qt,exports.resultPages=e.Pt,exports.rewriteText=e.x,exports.saveUserSettings=e.J,exports.searchPrincipals=e.tt,exports.setGlobalConfig=e.Kn,exports.setToken=e.Pn,exports.sha512=e.Nt,exports.suggestionsToTreeAggregationNodes=e.D,exports.sysLang=e.n,exports.toDate=e.Zt,exports.translateAggregationToDateOptions=e.O,exports.tryAutoAuthentication=e.mn,exports.tryOAuthAuthentication=e.wn,exports.trySAMLAuthentication=e.Cn,exports.updateContainer=e.U,Object.defineProperty(exports,"warn",{enumerable:!0,get:function(){return e.ir}}),exports.withRetry=e.Jt;
+Object.defineProperty(exports,Symbol.toStringTag,{value:`Module`});const e=require("./src-BcyahlCg.cjs");exports.API=e.ft,exports.ApiError=e.Vn,exports.Audit=e.Tt,exports.AuditEventType=e.Qt,exports.AuthMode=e.Qn,exports.DEFAULT_AGGREGATION_COUNT=e.en,exports.DidYouMeanKind=e.Jt,exports.EngineType=e.Zt,exports.EngineTypeModifier=e.Xt,exports.LogLevel=e.ir,exports.MINIMUM_COMPATIBLE_SERVER_API_VERSION=e.Yt,exports.RFMDisplay=e.qt,exports.ServerError=e.Rn,exports.TimeoutError=e.jn,exports.UnauthorizedError=e.Bn,exports.addAuditAdditionalInfo=e.Et,exports.addConcepts=e.b,exports.addSessionId=e.Dt,exports.addUrl=e.Ot,exports.aggItemRegex=e.D,exports.aggregationHasMore=e.tn,exports.aggregationItemStrictCompare=e.O,exports.appInitializerFn=e.rn,exports.applyConfig=e.Yn,exports.assertNever=e.Sn,exports.bisect=e.E,exports.buildPathsAndLevels=e.lt,exports.clearSessionTokens=e.hn,exports.configureLogger=e.ar,exports.createAtomicClient=e.N,exports.createContainer=e.V,exports.createHeaders=e.Hn,exports.createHeadersWithContext=e.Un,exports.createTimeoutController=e.An,exports.createUserProfile=e.I,Object.defineProperty(exports,"debug",{enumerable:!0,get:function(){return e.or}}),exports.del=e.dn,exports.delWithContext=e.fn,exports.deleteContainerDocuments=e.H,exports.deleteContainers=e.U,exports.deleteUserProfileProperty=e.L,exports.deleteUserSettings=e.Y,exports.deleteWebTokenCookie=e._n,exports.detectAuthMode=e.Dn,exports.emitAuthenticatedEvent=e.Gn,Object.defineProperty(exports,"error",{enumerable:!0,get:function(){return e.sr}}),exports.escapeExpr=e.kt,exports.expiresSoon=e.n,exports.extraColumns=e.Gt,exports.fetchAggregation=e.wt,exports.fetchApp=e.in,exports.fetchAppPreLogin=e.an,exports.fetchBulkQuery=e.ut,exports.fetchChangePassword=e.J,exports.fetchDataset=e.xt,exports.fetchDatasetList=e.St,exports.fetchDatasets=e.Ct,exports.fetchLabels=e.yt,exports.fetchPreview=e._t,exports.fetchPreviewUrl=e.vt,exports.fetchPrincipal=e.pt,exports.fetchPrincipalList=e.mt,exports.fetchPrincipalUserid=e.ht,exports.fetchPrincipalUserids=e.gt,exports.fetchQuery=e.dt,exports.fetchQueryExport=e.ct,exports.fetchQueryIntent=e.st,exports.fetchSendPasswordResetEmail=e.B,exports.fetchSimilarDocuments=e.at,exports.fetchSponsoredLinks=e.it,exports.fetchSuggest=e.et,exports.fetchSuggestField=e.tt,exports.fetchSuggestQuery=e.nt,exports.fetchTextChunks=e.$,exports.fetchUserProfile=e.R,exports.fetchUserSettings=e.X,exports.fetchVersion=e.F,exports.filter=e.Ut,exports.get=e.Tn,exports.getConcepts=e.x,exports.getContainer=e.W,exports.getCsrfToken=e.wn,exports.getDefaultClient=e.P,exports.getFiltersFromURI=e.s,exports.getFiltersFromUrl=e.c,exports.getHelpIndexUrl=e.a,exports.getIdFromUrl=e.l,exports.getJWToken=e.bn,exports.getMetadata=e.Vt,exports.getMetadataWithValues=e.Ht,exports.getOffsetFromDates=e.v,exports.getQueryPageFromUrl=e.u,exports.getQueryParamsFromUrl=e.d,exports.getQueryTabFromUrl=e.f,exports.getQueryTextFromUrl=e.p,exports.getRelativeDate=e.y,exports.getTime=e.At,exports.getToken=e.Wn,exports.getUrlParamsFromQueryParams=e.m,exports.getWithContext=e.En,exports.globalConfig=e.Xn,exports.guid=e.jt,exports.handleResponse=e.In,exports.handleResponseWithContext=e.Ln,exports.hasSession=e.Cn,exports.hashString=e.Mt,Object.defineProperty(exports,"info",{enumerable:!0,get:function(){return e.cr}}),exports.initializeAppConfig=e.on,exports.isArrayBuffer=e.Nt,exports.isAuthenticated=e.pn,exports.isBlob=e.Pt,exports.isDate=e.Ft,exports.isExpired=e.r,exports.isExternalAuthMode=e.$n,exports.isJsonable=e.It,exports.isNotInputEvent=e._,exports.isObject=e.Lt,exports.isRedirectPending=e.mn,exports.isString=e.Rt,exports.labels=e.bt,exports.legacyBooleansToAuthMode=e.er,exports.legacyFilterToFilter=e.Wt,exports.listContainerDocuments=e.G,exports.listContainers=e.K,exports.login=e.vn,exports.logout=e.gn,exports.makeColumn=e.Kt,exports.notify=e.g,exports.onAuthEvent=e.ur,exports.openParentNodes=e.k,exports.parseText=e.S,exports.parseValueAndOperatorFromItem=e.A,exports.patch=e.ln,exports.patchUserProfile=e.z,exports.patchUserSettings=e.Z,exports.patchWithContext=e.un,exports.post=e.Mn,exports.postWithContext=e.Nn,exports.put=e.sn,exports.putWithContext=e.cn,exports.queryParamsFromUrl=e.h,exports.removeConcept=e.C,exports.removeConcepts=e.w,exports.requestWebTokenSession=e.xn,exports.resolveAggregationCount=e.nn,exports.resolveBearerToken=e.tr,exports.resolveNoAutoAuthentication=e.Pn,exports.resolveNoAutoAuthenticationWithContext=e.Fn,exports.resolveOAuthProvider=e.nr,exports.resolveSAMLProvider=e.rr,exports.resolveToColumnName=e.$t,exports.resultPages=e.Bt,exports.rewriteText=e.T,exports.saveUserSettings=e.Q,exports.searchPrincipals=e.ot,exports.setGlobalConfig=e.Zn,exports.setToken=e.zn,exports.sha512=e.zt,exports.suggestionsToTreeAggregationNodes=e.j,exports.sysLang=e.o,exports.toDate=e.i,exports.toSqlValue=e.rt,exports.translateAggregationToDateOptions=e.M,exports.tryAutoAuthentication=e.yn,exports.tryOAuthAuthentication=e.kn,exports.trySAMLAuthentication=e.On,exports.updateContainer=e.q,Object.defineProperty(exports,"warn",{enumerable:!0,get:function(){return e.lr}}),exports.withRetry=e.t;

package/dist/atomic.js

@@ -1,2 +1,2 @@
-import { $ as e, $n as t, $t as n, A as r, An as i, At as a, B as o, Bn as s, Bt as c, C as l, Cn as u, Ct as d, D as f, Dn as p, Dt as m, E as h, En as g, Et as _, F as v, Fn as y, Ft as b, G as x, Gn as S, Gt as C, H as w, Ht as T, I as E, In as D, It as O, J as k, Jn as A, Jt as j, K as M, Kn as N, Kt as P, L as F, Ln as I, Lt as L, M as R, Mn as z, Mt as B, N as V, Nn as H, Nt as U, O as W, On as G, Ot as K, P as q, Pn as J, Pt as Y, Q as X, Qn as Z, Qt as Q, R as $, Rn as ee, Rt as te, S as ne, Sn as re, St as ie, T as ae, Tn as oe, Tt as se, U as ce, Ut as le, V as ue, Vt as de, W as fe, Wn as pe, Wt as me, X as he, Xn as ge, Xt as _e, Y as ve, Yn as ye, Yt as be, Z as xe, Zn as Se, Zt as Ce, _ as we, _n as Te, _t as Ee, a as De, an as Oe, ar as ke, at as Ae, b as je, bn as Me, bt as Ne, c as Pe, cn as Fe, ct as Ie, d as Le, dn as Re, dt as ze, en as Be, er as Ve, et as He, f as Ue, fn as We, ft as Ge, g as Ke, gn as qe, gt as Je, h as Ye, hn as Xe, ht as Ze, i as Qe, in as $e, ir as et, it as tt, j as nt, jn as rt, jt as it, k as at, kn as ot, kt as st, l as ct, ln as lt, lt as ut, m as dt, mn as ft, mt as pt, n as mt, nn as ht, nr as gt, nt as _t, o as vt, on as yt, ot as bt, p as xt, pn as St, pt as Ct, q as wt, qn as Tt, qt as Et, r as Dt, rn as Ot, rr as kt, rt as At, s as jt, sn as Mt, st as Nt, t as Pt, tn as Ft, tr as It, tt as Lt, u as Rt, un as zt, ut as Bt, v as Vt, vn as Ht, vt as Ut, w as Wt, wn as Gt, wt as Kt, x as qt, xn as Jt, xt as Yt, y as Xt, yn as Zt, yt as Qt, z as $t, zn as en, zt as tn } from "./src-QHeKpRHd.js";
-export { Nt as API, D as ApiError, Ne as Audit, P as AuditEventType, Tt as AuthMode, T as DidYouMeanKind, C as EngineType, me as EngineTypeModifier, t as LogLevel, le as MINIMUM_COMPATIBLE_SERVER_API_VERSION, de as RFMDisplay, H as ServerError, g as TimeoutError, y as UnauthorizedError, Yt as addAuditAdditionalInfo, Ke as addConcepts, ie as addSessionId, d as addUrl, l as aggItemRegex, Wt as aggregationItemStrictCompare, Q as appInitializerFn, pe as applyConfig, Te as assertNever, ne as bisect, tt as buildPathsAndLevels, zt as clearSessionTokens, Ve as configureLogger, at as createAtomicClient, F as createContainer, I as createHeaders, ee as createHeadersWithContext, oe as createTimeoutController, R as createUserProfile, It as debug, yt as del, Mt as delWithContext, $ as deleteContainerDocuments, $t as deleteContainers, V as deleteUserProfileProperty, x as deleteUserSettings, We as deleteWebTokenCookie, re as detectAuthMode, s as emitAuthenticatedEvent, gt as error, Kt as escapeExpr, be as expiresSoon, tn as extraColumns, Qt as fetchAggregation, n as fetchApp, Be as fetchAppPreLogin, Ae as fetchBulkQuery, fe as fetchChangePassword, Je as fetchDataset, Ee as fetchDatasetList, Ut as fetchDatasets, pt as fetchLabels, Ge as fetchPreview, Ct as fetchPreviewUrl, Ie as fetchPrincipal, ut as fetchPrincipalList, Bt as fetchPrincipalUserid, ze as fetchPrincipalUserids, bt as fetchQuery, At as fetchQueryExport, _t as fetchQueryIntent, E as fetchSendPasswordResetEmail, He as fetchSimilarDocuments, e as fetchSponsoredLinks, he as fetchSuggest, xe as fetchSuggestField, X as fetchSuggestQuery, ve as fetchTextChunks, q as fetchUserProfile, M as fetchUserSettings, nt as fetchVersion, L as filter, Me as get, we as getConcepts, o as getContainer, Zt as getCsrfToken, r as getDefaultClient, Dt as getFiltersFromURI, Qe as getFiltersFromUrl, Pt as getHelpIndexUrl, De as getIdFromUrl, Xe as getJWToken, b as getMetadata, O as getMetadataWithValues, dt as getOffsetFromDates, vt as getQueryPageFromUrl, jt as getQueryParamsFromUrl, Pe as getQueryTabFromUrl, ct as getQueryTextFromUrl, Ye as getRelativeDate, se as getTime, en as getToken, Rt as getUrlParamsFromQueryParams, Jt as getWithContext, S as globalConfig, _ as guid, rt as handleResponse, z as handleResponseWithContext, Ht as hasSession, kt as info, Ft as initializeAppConfig, m as isArrayBuffer, Fe as isAuthenticated, K as isBlob, st as isDate, _e as isExpired, A as isExternalAuthMode, a as isJsonable, xt as isNotInputEvent, it as isObject, lt as isRedirectPending, B as isString, Ze as labels, ye as legacyBooleansToAuthMode, te as legacyFilterToFilter, ue as listContainerDocuments, w as listContainers, St as login, Re as logout, c as makeColumn, Ue as notify, ke as onAuthEvent, ae as openParentNodes, Vt as parseText, h as parseValueAndOperatorFromItem, $e as patch, v as patchUserProfile, wt as patchUserSettings, Oe as patchWithContext, p as post, G as postWithContext, ht as put, Ot as putWithContext, Le as queryParamsFromUrl, Xt as removeConcept, je as removeConcepts, qe as requestWebTokenSession, ge as resolveBearerToken, ot as resolveNoAutoAuthentication, i as resolveNoAutoAuthenticationWithContext, Se as resolveOAuthProvider, Z as resolveSAMLProvider, Et as resolveToColumnName, Y as resultPages, qt as rewriteText, k as saveUserSettings, Lt as searchPrincipals, N as setGlobalConfig, J as setToken, U as sha512, f as suggestionsToTreeAggregationNodes, mt as sysLang, Ce as toDate, W as translateAggregationToDateOptions, ft as tryAutoAuthentication, Gt as tryOAuthAuthentication, u as trySAMLAuthentication, ce as updateContainer, et as warn, j as withRetry };
+import { $ as e, $n as t, $t as n, A as r, An as i, At as a, B as o, Bn as s, Bt as c, C as l, Cn as u, Ct as d, D as f, Dn as p, Dt as m, E as h, En as g, Et as _, F as v, Fn as y, Ft as b, G as x, Gn as S, Gt as C, H as w, Hn as T, Ht as E, I as D, In as O, It as k, J as A, Jt as j, K as M, Kt as N, L as P, Ln as F, Lt as I, M as L, Mn as R, Mt as z, N as B, Nn as V, Nt as H, O as U, On as W, Ot as G, P as K, Pn as q, Pt as J, Q as Y, Qn as X, Qt as Z, R as Q, Rn as $, Rt as ee, S as te, Sn as ne, St as re, T as ie, Tn as ae, Tt as oe, U as se, Un as ce, Ut as le, V as ue, Vn as de, Vt as fe, W as pe, Wn as me, Wt as he, X as ge, Xn as _e, Xt as ve, Y as ye, Yn as be, Yt as xe, Z as Se, Zn as Ce, Zt as we, _ as Te, _n as Ee, _t as De, a as Oe, an as ke, ar as Ae, at as je, b as Me, bn as Ne, bt as Pe, c as Fe, cn as Ie, cr as Le, ct as Re, d as ze, dn as Be, dt as Ve, en as He, er as Ue, et as We, f as Ge, fn as Ke, ft as qe, g as Je, gn as Ye, gt as Xe, h as Ze, hn as Qe, ht as $e, i as et, in as tt, ir as nt, it as rt, j as it, jn as at, jt as ot, k as st, kn as ct, kt as lt, l as ut, ln as dt, lr as ft, lt as pt, m as mt, mn as ht, mt as gt, n as _t, nn as vt, nr as yt, nt as bt, o as xt, on as St, or as Ct, ot as wt, p as Tt, pn as Et, pt as Dt, q as Ot, qt as kt, r as At, rn as jt, rr as Mt, rt as Nt, s as Pt, sn as Ft, sr as It, st as Lt, t as Rt, tn as zt, tr as Bt, tt as Vt, u as Ht, un as Ut, ur as Wt, ut as Gt, v as Kt, vn as qt, vt as Jt, w as Yt, wn as Xt, wt as Zt, x as Qt, xn as $t, xt as en, y as tn, yn as nn, yt as rn, z as an, zn as on, zt as sn } from "./src-vDryIxd0.js";
+export { qe as API, de as ApiError, oe as Audit, Z as AuditEventType, X as AuthMode, He as DEFAULT_AGGREGATION_COUNT, j as DidYouMeanKind, we as EngineType, ve as EngineTypeModifier, nt as LogLevel, xe as MINIMUM_COMPATIBLE_SERVER_API_VERSION, kt as RFMDisplay, $ as ServerError, at as TimeoutError, s as UnauthorizedError, _ as addAuditAdditionalInfo, Me as addConcepts, m as addSessionId, G as addUrl, f as aggItemRegex, zt as aggregationHasMore, U as aggregationItemStrictCompare, jt as appInitializerFn, be as applyConfig, ne as assertNever, h as bisect, pt as buildPathsAndLevels, Qe as clearSessionTokens, Ae as configureLogger, B as createAtomicClient, ue as createContainer, T as createHeaders, ce as createHeadersWithContext, i as createTimeoutController, D as createUserProfile, Ct as debug, Be as del, Ke as delWithContext, w as deleteContainerDocuments, se as deleteContainers, P as deleteUserProfileProperty, ye as deleteUserSettings, Ee as deleteWebTokenCookie, p as detectAuthMode, S as emitAuthenticatedEvent, It as error, lt as escapeExpr, _t as expiresSoon, C as extraColumns, Zt as fetchAggregation, tt as fetchApp, ke as fetchAppPreLogin, Gt as fetchBulkQuery, A as fetchChangePassword, en as fetchDataset, re as fetchDatasetList, d as fetchDatasets, rn as fetchLabels, De as fetchPreview, Jt as fetchPreviewUrl, Dt as fetchPrincipal, gt as fetchPrincipalList, $e as fetchPrincipalUserid, Xe as fetchPrincipalUserids, Ve as fetchQuery, Re as fetchQueryExport, Lt as fetchQueryIntent, o as fetchSendPasswordResetEmail, je as fetchSimilarDocuments, rt as fetchSponsoredLinks, We as fetchSuggest, Vt as fetchSuggestField, bt as fetchSuggestQuery, e as fetchTextChunks, Q as fetchUserProfile, ge as fetchUserSettings, v as fetchVersion, le as filter, ae as get, Qt as getConcepts, pe as getContainer, Xt as getCsrfToken, K as getDefaultClient, Pt as getFiltersFromURI, Fe as getFiltersFromUrl, Oe as getHelpIndexUrl, ut as getIdFromUrl, Ne as getJWToken, fe as getMetadata, E as getMetadataWithValues, Kt as getOffsetFromDates, Ht as getQueryPageFromUrl, ze as getQueryParamsFromUrl, Ge as getQueryTabFromUrl, Tt as getQueryTextFromUrl, tn as getRelativeDate, a as getTime, me as getToken, mt as getUrlParamsFromQueryParams, g as getWithContext, _e as globalConfig, ot as guid, O as handleResponse, F as handleResponseWithContext, u as hasSession, z as hashString, Le as info, St as initializeAppConfig, H as isArrayBuffer, Et as isAuthenticated, J as isBlob, b as isDate, At as isExpired, t as isExternalAuthMode, k as isJsonable, Te as isNotInputEvent, I as isObject, ht as isRedirectPending, ee as isString, Pe as labels, Ue as legacyBooleansToAuthMode, he as legacyFilterToFilter, x as listContainerDocuments, M as listContainers, qt as login, Ye as logout, N as makeColumn, Je as notify, Wt as onAuthEvent, st as openParentNodes, te as parseText, r as parseValueAndOperatorFromItem, dt as patch, an as patchUserProfile, Se as patchUserSettings, Ut as patchWithContext, R as post, V as postWithContext, Ft as put, Ie as putWithContext, Ze as queryParamsFromUrl, l as removeConcept, Yt as removeConcepts, $t as requestWebTokenSession, vt as resolveAggregationCount, Bt as resolveBearerToken, q as resolveNoAutoAuthentication, y as resolveNoAutoAuthenticationWithContext, yt as resolveOAuthProvider, Mt as resolveSAMLProvider, n as resolveToColumnName, c as resultPages, ie as rewriteText, Y as saveUserSettings, wt as searchPrincipals, Ce as setGlobalConfig, on as setToken, sn as sha512, it as suggestionsToTreeAggregationNodes, xt as sysLang, et as toDate, Nt as toSqlValue, L as translateAggregationToDateOptions, nn as tryAutoAuthentication, ct as tryOAuthAuthentication, W as trySAMLAuthentication, Ot as updateContainer, ft as warn, Rt as withRetry };

package/dist/client/create-api.d.ts

@@ -29,8 +29,8 @@ export declare function createApi(ctx: AtomicContext): {
         }, signal?: AbortSignal | undefined) => Promise<import("..").SecurityPrincipalSearchResponse>;
     };
     query: {
-        search: (query: import("..").Query, audit?: import("..").AuditEvents | undefined, queryIntentData?: import("..").QueryIntentData | undefined) => Promise<import("..").Result>;
-        bulk: (queries: import("..").Query[], mode?: "parallel" | undefined, auditEvents?: import("..").AuditEvents | undefined) => Promise<import("..").Result[]>;
+        search: (query: import("..").Query, audit?: import("..").AuditEvents | undefined, queryIntentData?: import("..").QueryIntentData | undefined) => Promise<import("..").Result & import("..").ResultPages>;
+        bulk: (queries: import("..").Query[], mode?: "parallel" | undefined, auditEvents?: import("..").AuditEvents | undefined) => Promise<(import("..").Result & import("..").ResultPages)[]>;
         intent: (query: import("..").Query) => Promise<import("..").QueryIntentMatch[]>;
         export: (args_0: {
             model: import("..").ExportQueryModel;
@@ -38,7 +38,7 @@ export declare function createApi(ctx: AtomicContext): {
             query: import("..").Query;
             article?: import("..").Article;
         }) => Promise<Response>;
-        aggregate: (aggregation: import("..").Aggregation, query: import("..").Query, audit?: import("..").AuditEvents | undefined) => Promise<import("..").Aggregation>;
+        aggregate: (aggregation: import("..").Aggregation, query: import("..").Query, audit?: import("..").AuditEvents | undefined, count?: number | undefined) => Promise<import("..").Aggregation>;
         sponsoredLinks: (webservice: string, query: import("..").Query) => Promise<import("..").LinkResult[]>;
         similarDocuments: (documentId: string, queryName: string, signal?: AbortSignal | undefined) => Promise<import("..").Article[]>;
     };
@@ -100,7 +100,7 @@ export declare function createApi(ctx: AtomicContext): {
     };
     password: {
         change: (newPassword: string, currentPassword?: string | undefined) => Promise<import("..").ChangePasswordResponse>;
-        sendResetEmail: (userName: string) => Promise<import("..").PasswordResetEmailResponse>;
+        sendResetEmail: (userName: string, changePasswordRedirectUrl?: string | undefined) => Promise<import("..").PasswordResetEmailResponse>;
     };
     version: () => Promise<import("..").VersionResponse>;
 };

package/dist/configurations/auth-mode.d.ts

@@ -43,8 +43,8 @@ export declare const AuthMode: {
      * @param token - The Sinequa access token, sent as `Authorization: Bearer <token>`.
      * @param options.sessionCookie - Whether to also open a **server session** by exchanging the token
      *   through `security.webtoken` (`tokenInCookie`). Defaults to `true`, and a server that refuses
-     *   the exchange falls back to the header alone — see {@link AuthMode} and the `bearer` section of
-     *   `docs/authentication/auth-mode.md`. Pass `false` for a headless, server-to-server consumer:
+     *   the exchange falls back to the header alone — see {@link AuthMode} and `docs/auth/bearer.mdx`.
+     *   Pass `false` for a headless, server-to-server consumer:
      *   there is no browser to load anything on its own, so the roundtrip buys nothing.
      */
     readonly bearer: (token: string, options?: {

package/dist/configurations/global.config.d.ts

@@ -1,4 +1,5 @@
-import type { LogLevel } from "../utils";
+import type { AggregationCounts } from "../helpers/aggregation-count";
+import { type LogLevel } from "../utils/logger";
 import { type AuthMode as AuthModeType } from "./auth-mode";
 import type { AuthOptions } from "./auth-options";
 /**
@@ -16,7 +17,6 @@ export type AppGlobalConfig<T extends Record<string, unknown> = {}> = {
     autoOAuthProvider: string;
     autoSAMLProvider: string;
     bearerToken: string;
-    loginPath: string;
     userOverride: {
         username: string;
         domain: string;
@@ -31,13 +31,44 @@ export type AppGlobalConfig<T extends Record<string, unknown> = {}> = {
      * when not configured, so the server keeps applying its own default.
      */
     uiLanguage: string;
+    /**
+     * The number of values the server returns per aggregation, keyed by aggregation name — the
+     * administrator's `CCAggregation.count`, which no query response repeats.
+     *
+     * Declare it (typically once at start-up, from `api.app.get()`) so `$hasMore` is computed against
+     * the real page size. Aggregations left out fall back to
+     * {@link DEFAULT_AGGREGATION_COUNT}. @see AggregationCounts
+     */
+    aggregationCounts: AggregationCounts;
     /** @deprecated Derived read-only getter computed from {@link authMode}. */
     useCredentials: boolean;
     /** @deprecated Derived read-only getter computed from {@link authMode}. */
     useSSO: boolean;
     /** @deprecated Derived read-only getter computed from {@link authMode}. */
     useSAML: boolean;
+    /**
+     * Verbosity of the library logger, applied by {@link setGlobalConfig}.
+     *
+     * It used to be declared, defaulted, and read by nothing — so an application that set it got
+     * silence, and the comment here described a boolean ("when true, the application logs more
+     * information") for a value that was never one. `setGlobalConfig({ logLevel })` now forwards to
+     * `configureLogger({ level })`.
+     *
+     * A client created with `createAtomicClient` does **not** apply it: the library logger is
+     * process-wide, so a second client repointing it would silence the first. Inject `auth.logger`
+     * per client instead.
+     */
     logLevel: LogLevel;
+    /**
+     * @deprecated Read by nothing in this library. Routing belongs to the application: react to the
+     * `unauthorized` event, or configure `auth.recoverFromUnauthorized`. It will stop being declared
+     * in the next major.
+     */
+    loginPath: string;
+    /**
+     * @deprecated Read by nothing in this library, and always has been. It will stop being declared in
+     * the next major.
+     */
     createRoutes: boolean;
 } & T;
 /**

package/dist/configurations/global.config.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"global.config.d.ts","sourceRoot":"","sources":["../../src/configurations/global.config.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAC;AACzC,OAAO,EAEL,KAAK,QAAQ,IAAI,YAAY,EAE9B,MAAM,aAAa,CAAC;AACrB,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAElD;;;;;;;;GAQG;AACH,MAAM,MAAM,eAAe,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,EAAE,IAAI;IACpE,GAAG,EAAE,MAAM,CAAC;IACZ,UAAU,EAAE,MAAM,CAAC;IACnB,iBAAiB,EAAE,MAAM,CAAC;IAC1B,gBAAgB,EAAE,MAAM,CAAC;IACzB,WAAW,EAAE,MAAM,CAAC;IACpB,SAAS,EAAE,MAAM,CAAC;IAClB,YAAY,EAAE;QACZ,QAAQ,EAAE,MAAM,CAAC;QACjB,MAAM,EAAE,MAAM,CAAC;KAChB,CAAC;IACF,kBAAkB,EAAE,OAAO,CAAC;IAC5B,mEAAmE;IACnE,QAAQ,EAAE,YAAY,CAAC;IACvB,sGAAsG;IACtG,IAAI,EAAE,WAAW,CAAC;IAClB;;;OAGG;IACH,UAAU,EAAE,MAAM,CAAC;IACnB,2EAA2E;IAC3E,cAAc,EAAE,OAAO,CAAC;IACxB,2EAA2E;IAC3E,MAAM,EAAE,OAAO,CAAC;IAChB,2EAA2E;IAC3E,OAAO,EAAE,OAAO,CAAC;IACjB,QAAQ,EAAE,QAAQ,CAAC;IACnB,YAAY,EAAE,OAAO,CAAC;CACvB,GAAG,CAAC,CAAC;AAEN;;;;;;;;GAQG;AACH,QAAA,MAAM,YAAY,EAAE,OAAO,CAAC,eAAe,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAIpE,CAAC;AAsCF;;;;;;;;GAQG;AACH,wBAAgB,eAAe,CAC7B,MAAM,EAAE,OAAO,CAAC,eAAe,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GACzD,IAAI,CAEN;AAED;;;;GAIG;AACH,wBAAgB,WAAW,CACzB,MAAM,EAAE,OAAO,CAAC,eAAe,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC1D,MAAM,EAAE,OAAO,CAAC,eAAe,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GACzD,IAAI,CAwBN;AAED,OAAO,EAAE,YAAY,EAAE,CAAC"}
+{"version":3,"file":"global.config.d.ts","sourceRoot":"","sources":["../../src/configurations/global.config.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAC;AAGtE,OAAO,EAAmB,KAAK,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AACjE,OAAO,EAEL,KAAK,QAAQ,IAAI,YAAY,EAE9B,MAAM,aAAa,CAAC;AACrB,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAElD;;;;;;;;GAQG;AACH,MAAM,MAAM,eAAe,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,EAAE,IAAI;IACpE,GAAG,EAAE,MAAM,CAAC;IACZ,UAAU,EAAE,MAAM,CAAC;IACnB,iBAAiB,EAAE,MAAM,CAAC;IAC1B,gBAAgB,EAAE,MAAM,CAAC;IACzB,WAAW,EAAE,MAAM,CAAC;IACpB,YAAY,EAAE;QACZ,QAAQ,EAAE,MAAM,CAAC;QACjB,MAAM,EAAE,MAAM,CAAC;KAChB,CAAC;IACF,kBAAkB,EAAE,OAAO,CAAC;IAC5B,mEAAmE;IACnE,QAAQ,EAAE,YAAY,CAAC;IACvB,sGAAsG;IACtG,IAAI,EAAE,WAAW,CAAC;IAClB;;;OAGG;IACH,UAAU,EAAE,MAAM,CAAC;IACnB;;;;;;;OAOG;IACH,iBAAiB,EAAE,iBAAiB,CAAC;IACrC,2EAA2E;IAC3E,cAAc,EAAE,OAAO,CAAC;IACxB,2EAA2E;IAC3E,MAAM,EAAE,OAAO,CAAC;IAChB,2EAA2E;IAC3E,OAAO,EAAE,OAAO,CAAC;IACjB;;;;;;;;;;;OAWG;IACH,QAAQ,EAAE,QAAQ,CAAC;IACnB;;;;OAIG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;;OAGG;IACH,YAAY,EAAE,OAAO,CAAC;CACvB,GAAG,CAAC,CAAC;AAEN;;;;;;;;GAQG;AACH,QAAA,MAAM,YAAY,EAAE,OAAO,CAAC,eAAe,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAIpE,CAAC;AAsCF;;;;;;;;GAQG;AACH,wBAAgB,eAAe,CAC7B,MAAM,EAAE,OAAO,CAAC,eAAe,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GACzD,IAAI,CASN;AAED;;;;GAIG;AACH,wBAAgB,WAAW,CACzB,MAAM,EAAE,OAAO,CAAC,eAAe,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC1D,MAAM,EAAE,OAAO,CAAC,eAAe,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GACzD,IAAI,CAwBN;AAED,OAAO,EAAE,YAAY,EAAE,CAAC"}

package/dist/helpers/aggregation-count.d.ts

@@ -0,0 +1,68 @@
+import type { Aggregation, Query } from "../types";
+/**
+ * Page size assumed for an aggregation when nothing declares one.
+ *
+ * It mirrors the value the Sinequa administration proposes for
+ * [CCAggregation.count]{@link CCAggregation#count}, and it is a **fallback, not a fact**: a query
+ * web service configured with another count answers exactly the same way, so there is nothing in the
+ * response that would let the client notice. Declare the real sizes with
+ * {@link AggregationCounts} to get `$hasMore` right on those aggregations.
+ */
+export declare const DEFAULT_AGGREGATION_COUNT = 10;
+/**
+ * The number of values the server returns per aggregation, keyed by aggregation name.
+ *
+ * This is the administrator's decision — [CCAggregation.count]{@link CCAggregation#count}, *the
+ * maximum number of values to retrieve* — and the query response does not repeat it. An application
+ * that reads the configuration once at start-up can hand it over, and the whole library then sizes
+ * `$hasMore` and aggregation paging against the real values:
+ *
+ * @example
+ * ```ts
+ * const app = await client.api.app.get();
+ * client.configure({
+ *   aggregationCounts: Object.fromEntries(
+ *     app.queries["_query"].aggregations.map((a) => [a.name, a.count]),
+ *   ),
+ * });
+ * ```
+ */
+export type AggregationCounts = Record<string, number>;
+/**
+ * The number of values the server was asked for, for one aggregation.
+ *
+ * No field of the response carries it, so it is reconstructed from the most specific source
+ * available:
+ *
+ * 1. `query.aggregations[name].count` — what *this* call explicitly requested, as an
+ *    `action: "aggregate"` page does;
+ * 2. `counts[name]` — what the application declared once from the app configuration
+ *    (see {@link AggregationCounts});
+ * 3. {@link DEFAULT_AGGREGATION_COUNT}, when nothing is known.
+ *
+ * @param name - The name of the aggregation.
+ * @param query - The query the aggregation came back from, if any.
+ * @param counts - The declared page sizes, if any.
+ * @returns The count to compare the received items against.
+ */
+export declare function resolveAggregationCount(name: string, query?: Pick<Query, "aggregations">, counts?: AggregationCounts): number;
+/**
+ * Whether more values remain to be fetched for an aggregation.
+ *
+ * The response has no "total values" field. Instead, **when values remain the server returns one
+ * item beyond the `count` it was asked for**: ask for 10 and you receive 11, the eleventh being a
+ * sentinel that means "there is more". That extra item is the only signal available, so the test is
+ * `items.length > count` — and never an equality, which would only ever hold for one particular
+ * configured count and leave every other facet silently claiming it is complete.
+ *
+ * Distributions and trees always report `false`, deliberately: paging a bucket list, or a level of a
+ * hierarchy (`action: "open"`), is not the same operation as paging a flat list of values.
+ *
+ * @param aggregation - The aggregation returned by the server.
+ * @param count - The number of values that were requested. @see resolveAggregationCount
+ * @returns Whether the aggregation has more values on the server.
+ */
+export declare function aggregationHasMore(aggregation: Pick<Aggregation, "isDistribution" | "isTree"> & {
+    items?: Aggregation["items"];
+}, count: number): boolean;
+//# sourceMappingURL=aggregation-count.d.ts.map

package/dist/helpers/aggregation-count.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"aggregation-count.d.ts","sourceRoot":"","sources":["../../src/helpers/aggregation-count.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,KAAK,EAAE,MAAM,UAAU,CAAC;AAEnD;;;;;;;;GAQG;AACH,eAAO,MAAM,yBAAyB,KAAK,CAAC;AAE5C;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,MAAM,iBAAiB,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AAoBvD;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,uBAAuB,CACrC,IAAI,EAAE,MAAM,EACZ,KAAK,CAAC,EAAE,IAAI,CAAC,KAAK,EAAE,cAAc,CAAC,EACnC,MAAM,CAAC,EAAE,iBAAiB,GACzB,MAAM,CAQR;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,kBAAkB,CAChC,WAAW,EAAE,IAAI,CAAC,WAAW,EAAE,gBAAgB,GAAG,QAAQ,CAAC,GAAG;IAC5D,KAAK,CAAC,EAAE,WAAW,CAAC,OAAO,CAAC,CAAC;CAC9B,EACD,KAAK,EAAE,MAAM,GACZ,OAAO,CAKT"}