@sinequa/atomic 2.0.2 → 2.0.5

package/README.md

@@ -3,6 +3,7 @@
 <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/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 />
@@ -10,7 +11,8 @@
 # `@sinequa/atomic`
 
 **The TypeScript-first SDK for the Sinequa REST API.**  
-Authentication, search, aggregations, datasets, preview — everything typed, tree-shakable, zero runtime dependencies.
+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)
 
@@ -24,7 +26,13 @@ Authentication, search, aggregations, datasets, preview — everything typed, tr
 npm install @sinequa/atomic
 ```
 
-> Requires **Node ≥ 18** or any modern browser. Ships as ESM (`atomic.js`) and CJS (`atomic.umd.cjs`) with full `.d.ts` declarations.
+> Requires **Node ≥ 18** or any modern browser. Ships as ESM (`atomic.js`) and CJS (`atomic.cjs`) with full `.d.ts` declarations.
+
+For **SharePoint Framework** web parts, `@microsoft/sp-http` is an optional peer dependency — install it only if you need it:
+
+```bash
+npm install @microsoft/sp-http --save-peer
+```
 
 ---
 
@@ -43,6 +51,33 @@ const facets  = await fetchAggregation({ aggregation: 'company', query: 'knowled
 
 ---
 
+## SharePoint Framework (SPFx)
+
+In an SPFx web part, all HTTP requests must go through the `AadHttpClient` so the Azure AD bearer
+token is attached automatically. Import from the `./spfx` subpath and call
+`initializeAadHttpClient` once during web part initialization:
+
+```typescript
+import { initializeAadHttpClient, fetchQuery } from '@sinequa/atomic/spfx';
+import { AadHttpClient } from '@microsoft/sp-http';
+
+// In your web part's onInit():
+const client = await this.context.aadHttpClientFactory
+  .getClient('https://my-sinequa-server.example.com');
+initializeAadHttpClient(client);
+
+// All subsequent API calls route through AadHttpClient automatically:
+const results = await fetchQuery({ name: '_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.
+
+---
+
 ## Modules
 
 ### Authentication
@@ -241,7 +276,7 @@ console.log(globalConfig.backendUrl, globalConfig.authMode.kind);
 ## Testing
 
 ```bash
-npm test          # run vitest (274 test cases across 24 files)
+npm test          # run vitest (287 test cases across 25 files)
 npm test -- --ui  # interactive UI
 ```
 

package/dist/atomic.cjs

@@ -0,0 +1 @@
+Object.defineProperty(exports,Symbol.toStringTag,{value:`Module`});const e=require("./src-B54_W-0n.cjs");exports.API=e.F,exports.ApiError=e.Ht,exports.Audit=e.$,exports.AuditEventType=e.Ct,exports.AuthMode=e.En,exports.DidYouMeanKind=e.yt,exports.EngineType=e.St,exports.EngineTypeModifier=e.xt,exports.LogLevel=e.Wt,exports.MINIMUM_COMPATIBLE_SERVER_API_VERSION=e.bt,exports.RFMDisplay=e.vt,exports.ServerError=e.Vt,exports.TimeoutError=e.Bt,exports.UnauthorizedError=e.zt,exports.addAuditAdditionalInfo=e.et,exports.addConcepts=e.dn,exports.addSessionId=e.tt,exports.addUrl=e.nt,exports.aggItemRegex=e.vn,exports.aggregationItemStrictCompare=e.yn,exports.appInitializerFn=e.q,exports.bisect=e._n,exports.buildPathsAndLevels=e.M,exports.clearSessionTokens=e.n,exports.configureLogger=e.Gt,exports.createHeaders=e.Ut,exports.createTimeoutController=e.kt,exports.createUserProfile=e.m,exports.debug=e.Kt,exports.del=e.Ft,exports.deleteUserProfileProperty=e.h,exports.deleteUserSettings=e.b,exports.deleteWebTokenCookie=e.i,exports.detectAuthMode=e.Z,exports.emitAuthenticatedEvent=e.On,exports.error=e.qt,exports.escapeExpr=e.rt,exports.expiresSoon=e.Et,exports.extraColumns=e.gt,exports.fetchAggregation=e.Q,exports.fetchApp=e.J,exports.fetchAppPreLogin=e.Y,exports.fetchBulkQuery=e.N,exports.fetchChangePassword=e.y,exports.fetchDataset=e.W,exports.fetchDatasetList=e.G,exports.fetchDatasets=e.K,exports.fetchLabels=e.H,exports.fetchPreview=e.B,exports.fetchPreviewUrl=e.V,exports.fetchPrincipal=e.I,exports.fetchPrincipalList=e.L,exports.fetchPrincipalUserid=e.R,exports.fetchPrincipalUserids=e.z,exports.fetchQuery=e.P,exports.fetchQueryExport=e.j,exports.fetchQueryIntent=e.A,exports.fetchSendPasswordResetEmail=e.v,exports.fetchSimilarDocuments=e.k,exports.fetchSponsoredLinks=e.O,exports.fetchSuggest=e.T,exports.fetchSuggestField=e.E,exports.fetchSuggestQuery=e.D,exports.fetchTextChunks=e.w,exports.fetchUserProfile=e.g,exports.fetchUserSettings=e.x,exports.fetchVersion=e.p,exports.filter=e.ht,exports.get=e.Pt,exports.getConcepts=e.fn,exports.getCsrfToken=e.l,exports.getFiltersFromURI=e.$t,exports.getFiltersFromUrl=e.en,exports.getHelpIndexUrl=e.Zt,exports.getIdFromUrl=e.tn,exports.getJWToken=e.c,exports.getMetadata=e.pt,exports.getMetadataWithValues=e.mt,exports.getOffsetFromDates=e.ln,exports.getQueryPageFromUrl=e.nn,exports.getQueryParamsFromUrl=e.rn,exports.getQueryTabFromUrl=e.in,exports.getQueryTextFromUrl=e.an,exports.getRelativeDate=e.un,exports.getTime=e.it,exports.getToken=e.s,exports.getUrlParamsFromQueryParams=e.on,exports.globalConfig=e.wn,exports.guid=e.at,exports.handleResponse=e.Rt,exports.info=e.Jt,exports.initializeAppConfig=e.X,exports.isArrayBuffer=e.ot,exports.isAuthenticated=e.t,exports.isBlob=e.st,exports.isDate=e.ct,exports.isExpired=e.Dt,exports.isJsonable=e.lt,exports.isNotInputEvent=e.cn,exports.isObject=e.ut,exports.isString=e.dt,exports.labels=e.U,exports.legacyBooleansToAuthMode=e.Dn,exports.login=e.a,exports.logout=e.r,exports.makeColumn=e._t,exports.notify=e.Xt,exports.openParentNodes=e.bn,exports.parseText=e.pn,exports.parseValueAndOperatorFromItem=e.xn,exports.patch=e.Mt,exports.patchUserProfile=e._,exports.patchUserSettings=e.S,exports.post=e.jt,exports.put=e.At,exports.queryParamsFromUrl=e.sn,exports.removeConcept=e.mn,exports.removeConcepts=e.hn,exports.resolveNoAutoAuthentication=e.Nt,exports.resolveToColumnName=e.wt,exports.rewriteText=e.gn,exports.saveUserSettings=e.C,exports.setGlobalConfig=e.Tn,exports.setToken=e.u,exports.sha512=e.ft,exports.suggestionsToTreeAggregationNodes=e.Sn,exports.sysLang=e.Qt,exports.toDate=e.Ot,exports.translateAggregationToDateOptions=e.Cn,exports.tryAutoAuthentication=e.o,exports.tryOAuthAuthentication=e.f,exports.trySAMLAuthentication=e.d,exports.warn=e.Yt,exports.withRetry=e.Tt;