@frontera-sdk/knowledge 0.0.0-stage → 1.53.17

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 Sebati
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -1,3 +1,177 @@
-# Temporary Holding Version
+# @frontera-sdk/knowledge
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+A typed client for Frontera Knowledge. From a backend, a script or an App it
+creates knowledge bases, adds files and waits until they are read, searches
+with citations, reads a document's pages for quoting, chooses the knowledge
+bases an Agent searches, and manages sources.
+
+```bash
+bun add @frontera-sdk/knowledge @frontera-sdk/core
+```
+
+## Choose a credential
+
+The credential decides who acts and what they reach. The package sends what
+you give it, and the platform decides.
+
+| Caller | Credential | Acts as | Reaches |
+| --- | --- | --- | --- |
+| A backend or a script | A workspace key (`sk-ws-…`) created with the **Knowledge** purpose | Its workspace | The workspace's own knowledge bases, to read and change, and organization knowledge bases shared with the workspace, to read |
+| An App | The App's token, which the App runtime provides | The person using the App, in the App's workspace | What that person reads and adds there |
+| A person at a terminal | Their own sign-in | That person | What they may do, including sources |
+
+A workspace key created for another purpose, such as Platform access, is
+refused with the reason `knowledge_key_required`. An organization key is
+refused everywhere in Knowledge with `credential_not_allowed`. An organization
+key stands at no workspace, and organization knowledge bases are shared and
+changed by Knowledge stewards, who are people. Sources are managed only by a
+person signed in, because their credentials reach another system.
+
+## Create a knowledge base and add a file
+
+```ts
+import { FronteraClient } from '@frontera-sdk/core/client'
+import { KnowledgeClient } from '@frontera-sdk/knowledge/knowledge-client'
+
+const knowledge = new KnowledgeClient(new FronteraClient({
+  apiBaseUrl: 'https://api.example.com',
+  credential: { kind: 'apiKey', key: process.env.FRONTERA_KNOWLEDGE_KEY! },
+}))
+
+const base = await knowledge.bases.create({ name: 'Policies' })
+const { document, duplicate } = await knowledge.documents.upload(base.id, new File([bytes], 'leave-policy.pdf'))
+const { documents, missing } = await knowledge.documents.waitUntilReady([document.id])
+console.log(documents[0]?.status) // 'ready', 'failed' or 'blocked'
+```
+
+Sending the same bytes to the same knowledge base again answers the document
+they made, with `duplicate: true`, so you can send a file again after a timeout
+or a crash without making a copy. A file is checked for malware first
+(`scanning`), then read (`pending`, `processing`). `blocked` means it failed
+the malware check and was removed. `waitUntilReady` never throws for a failed
+or blocked document. It throws `KNOWLEDGE_WAIT_TIMEOUT` after ten minutes by
+default.
+
+A file may be at most 50 MB. `documents.list(baseId, { limit: 100 })` answers a
+page, newest first, and `nextCursor` for the next one.
+
+## Add a folder
+
+```ts
+import { uploadFiles } from '@frontera-sdk/knowledge/upload-files'
+
+const outcomes = await uploadFiles(knowledge, base.id, files, { wait: true })
+for (const outcome of outcomes) {
+  if (outcome.outcome === 'refused') console.log(outcome.path, outcome.reason, outcome.message)
+}
+```
+
+`files` is a list, or an async iterable, of `{ path, file }`. The last part of
+`path` is the file name Knowledge reads the type from. Four files are sent at a
+time. A network failure or a server error is tried again up to three times. A
+refusal, such as a file type Knowledge cannot read, is not tried again. While
+Knowledge is still reading many earlier files it answers `busy`, and
+`uploadFiles` waits as long as it is told to before it sends again. With
+`wait`, each outcome carries the settled document, and a file whose upload did
+not get it stored is sent once more.
+
+## Search and cite
+
+```ts
+const { results } = await knowledge.search({ query: 'annual leave', limit: 5, includeText: true })
+for (const citation of results) {
+  console.log(citation.title, citation.page, citation.openUrl)
+}
+
+const text = await knowledge.documents.text(results[0]!.documentId, { fromPage: 3, toPage: 4 })
+```
+
+Each result names its document, its knowledge base and its page. `snippet` is
+HTML-escaped with `<mark>` around the matched words. `openUrl` is the
+document's page on the platform, for a person who may read it. `includeText`
+adds each passage's whole text, for a program that writes its own answer.
+`documents.text` answers a ready document's text page by page, and `nextPage`
+when it stopped at `maxChars`.
+
+## Choose an Agent's knowledge bases
+
+```ts
+const { bases } = await knowledge.agents.bases(agentId)
+await knowledge.agents.setBases(agentId, [base.id])
+```
+
+## Manage a source
+
+Sources need a person's sign-in. The organization's policy decides which
+knowledge bases may have them.
+
+```ts
+const source = await knowledge.sources.add(base.id, {
+  kind: 'api_pull',
+  name: 'Help centre',
+  config: {
+    listUrl: 'https://help.example.com/api/articles',
+    itemsAt: 'articles',
+    paging: { kind: 'next_url', at: 'next_page' },
+    changes: { kind: 'full' },
+    fields: { id: 'id', title: 'title', updatedAt: 'updated_at', content: { kind: 'inline', at: 'body', format: 'html' } },
+  },
+  auth: { kind: 'bearer' },
+  credential: process.env.HELP_CENTRE_TOKEN,
+})
+await knowledge.sources.sync(source.id)
+```
+
+`sources.test(baseId, input, { detect: true })` reads the first page as the
+source would be added and stores nothing. `sources.removedDocuments(baseId)`
+lists the documents a source no longer has, and
+`sources.deleteRemovedDocuments` deletes them before their retention ends.
+
+## Handle a refusal
+
+Every refusal carries one reason from a closed list,
+`KNOWLEDGE_REFUSAL_REASONS`. Branch on the reason. The message is written for
+people.
+
+```ts
+import { refusalReason, retryAfterSeconds } from '@frontera-sdk/knowledge/errors'
+
+try {
+  await knowledge.documents.upload(base.id, file)
+} catch (error) {
+  switch (refusalReason(error)) {
+    case 'file_type':
+    case 'file_too_large':
+      break // skip this file
+    case 'busy':
+      await new Promise((resolve) => setTimeout(resolve, (retryAfterSeconds(error) ?? 30) * 1000))
+      break
+    case 'knowledge_off':
+      throw new Error('Knowledge is not turned on for this deployment. Ask your administrator to turn it on.')
+    default:
+      throw error
+  }
+}
+```
+
+`refusalReason` answers `undefined` for an error that is not a Knowledge
+refusal, such as a network failure.
+
+## Use it in an App
+
+```tsx
+import { createFronteraApp } from '@frontera-sdk/core/create-frontera-app'
+import { knowledgeProvider } from '@frontera-sdk/knowledge/provider'
+import { useKnowledgeClient, useKnowledgeSearch } from '@frontera-sdk/knowledge/hooks'
+
+createFronteraApp(<App />, { providers: [knowledgeProvider] })
+
+function Answers({ query }: { query: string }) {
+  const search = useKnowledgeSearch({ query, limit: 5 })
+  return <ul>{search.data?.results.map((citation) => <li key={citation.passageId ?? citation.documentId}>{citation.title}</li>)}</ul>
+}
+```
+
+`useKnowledgeDocument(id)` reads one document, and `useKnowledgeClient()` gives
+the client for uploads and anything else. An App does not create, rename or
+delete knowledge bases, or choose an Agent's knowledge bases.

package/package.json

@@ -1,6 +1,85 @@
 {
   "name": "@frontera-sdk/knowledge",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "1.53.17",
+  "description": "Typed client for Frontera Knowledge: knowledge bases, documents, uploads, search with citations and sources, from a backend, a script or an App.",
+  "keywords": [
+    "frontera",
+    "knowledge",
+    "search",
+    "sdk"
+  ],
+  "license": "Apache-2.0",
+  "type": "module",
+  "files": [
+    "src",
+    "!src/__tests__",
+    "!src/**/*.test.ts",
+    "README.md",
+    "LICENSE"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "exports": {
+    "./types": {
+      "types": "./src/types.ts",
+      "import": "./src/types.ts"
+    },
+    "./errors": {
+      "types": "./src/errors.ts",
+      "import": "./src/errors.ts"
+    },
+    "./routes": {
+      "types": "./src/routes.ts",
+      "import": "./src/routes.ts"
+    },
+    "./knowledge-client": {
+      "types": "./src/knowledge-client.ts",
+      "import": "./src/knowledge-client.ts"
+    },
+    "./wait-until-ready": {
+      "types": "./src/wait-until-ready.ts",
+      "import": "./src/wait-until-ready.ts"
+    },
+    "./upload-files": {
+      "types": "./src/upload-files.ts",
+      "import": "./src/upload-files.ts"
+    },
+    "./hooks": {
+      "types": "./src/hooks.ts",
+      "import": "./src/hooks.ts"
+    },
+    "./provider": {
+      "types": "./src/provider.tsx",
+      "import": "./src/provider.tsx"
+    }
+  },
+  "scripts": {
+    "test": "bun test",
+    "typecheck": "../../node_modules/typescript7/bin/tsc --noEmit"
+  },
+  "dependencies": {
+    "@frontera-sdk/core": "1.53.17"
+  },
+  "peerDependencies": {
+    "@tanstack/react-query": "^5.90.21",
+    "react": "^19.0.0"
+  },
+  "peerDependenciesMeta": {
+    "@tanstack/react-query": {
+      "optional": true
+    },
+    "react": {
+      "optional": true
+    }
+  },
+  "devDependencies": {
+    "@happy-dom/global-registrator": "^20.11.1",
+    "@tanstack/react-query": "^5.90.21",
+    "@types/bun": "^1.3.14",
+    "@types/react": "^19",
+    "react": "19.2.5",
+    "react-dom": "19.2.5",
+    "typescript": "^5.9.3"
+  }
+}

package/src/errors.ts

@@ -0,0 +1,89 @@
+import type { FronteraError } from '@frontera-sdk/core/errors'
+
+/**
+ * Why Knowledge refused a request: one closed list the platform sends as
+ * `details.reason` on every refusal, so a program branches on the reason while
+ * the message stays written for people. The service's contract test keeps this
+ * copy equal to the platform's list. A release may add a reason; none is
+ * renamed or removed.
+ */
+export const KNOWLEDGE_REFUSAL_REASONS = [
+  /** Knowledge does not run on this deployment. */
+  'knowledge_off',
+  /** No credential, or one the platform does not accept. */
+  'sign_in_required',
+  /** A workspace key without the Knowledge purpose. */
+  'knowledge_key_required',
+  /** This kind of credential cannot use this route, such as a key on sharing or an organization key anywhere. */
+  'credential_not_allowed',
+  /** The caller lacks the permission this change or view needs. */
+  'not_permitted',
+  /** An organization knowledge base changes only through a Knowledge steward at the organization level. */
+  'steward_only',
+  /** No such base, document, Agent or workspace, or one the caller cannot read from its place. */
+  'not_found',
+  /** The request's path, query or body is not one this route accepts. */
+  'invalid_request',
+  /** Knowledge cannot read this file type. */
+  'file_type',
+  /** The file is larger than Knowledge accepts. */
+  'file_too_large',
+  /** The organization has chosen no model for preparing content, so nothing can be added. */
+  'embedding_not_chosen',
+  /** The file failed the malware check and was removed. */
+  'blocked',
+  /** The document is already waiting to be read. */
+  'already_waiting',
+  /** The document has nothing to show in the viewer yet. */
+  'no_preview',
+  /** A workspace knowledge base stays in its workspace. */
+  'not_shareable',
+  /** The request conflicts with the current state in another way. */
+  'conflict',
+  /** A part Knowledge needs is unavailable for now; try again later. */
+  'unavailable',
+  /** The organization has many files waiting to be read; send again after `retryAfterSeconds`, which `Retry-After` also gives. */
+  'busy',
+  /** The server failed. */
+  'server_error',
+  /** The organization's source policy does not allow sources on this base's layer. */
+  'sources_off',
+  /** A change moves where a source's credential would be sent, so it needs the credential again. */
+  'credential_required',
+  /** The person asked too often, such as Test connection more than ten times a minute or while two of theirs still run; try again after `retryAfterSeconds`, which `Retry-After` also gives. */
+  'too_many_requests',
+  /** The source is syncing now, so it cannot be synced again until the sync ends. */
+  'sync_running',
+  /** The source is paused; it syncs again once it is resumed. */
+  'source_paused',
+  /** The source is being removed. */
+  'source_removing',
+] as const
+
+export type KnowledgeRefusalReason = (typeof KNOWLEDGE_REFUSAL_REASONS)[number]
+
+const REASONS: ReadonlySet<string> = new Set(KNOWLEDGE_REFUSAL_REASONS)
+
+function refusalDetails(error: unknown): { reason?: unknown; retryAfterSeconds?: unknown } | undefined {
+  // By shape rather than `instanceof`: an App can bundle a second copy of the core package.
+  if (!(error instanceof Error) || typeof (error as Partial<FronteraError>).code !== 'string') return undefined
+  const body = (error as FronteraError).details as { details?: unknown } | undefined
+  const details = body?.details
+  return typeof details === 'object' && details !== null ? (details as { reason?: unknown; retryAfterSeconds?: unknown }) : undefined
+}
+
+/**
+ * The reason Knowledge gave for refusing the request that threw `error`, or
+ * undefined when it is not a Knowledge refusal (a network failure, say) or
+ * names a reason this version of the package does not know yet.
+ */
+export function refusalReason(error: unknown): KnowledgeRefusalReason | undefined {
+  const reason = refusalDetails(error)?.reason
+  return typeof reason === 'string' && REASONS.has(reason) ? (reason as KnowledgeRefusalReason) : undefined
+}
+
+/** For `busy` and `too_many_requests`: how many seconds to wait before sending again. */
+export function retryAfterSeconds(error: unknown): number | undefined {
+  const seconds = refusalDetails(error)?.retryAfterSeconds
+  return typeof seconds === 'number' ? seconds : undefined
+}

package/src/hooks.ts

@@ -0,0 +1,46 @@
+import { createContext, useContext } from 'react'
+import { useQuery, type UseQueryOptions, type UseQueryResult } from '@tanstack/react-query'
+
+import type { KnowledgeClient } from './knowledge-client'
+import type { KnowledgeDocumentDetails, SearchRequest, SearchResponse } from './types'
+
+/** Query keys, so an App can invalidate after an upload. */
+export const knowledgeKeys = {
+  all: ['frontera-knowledge'] as const,
+  search: (request: SearchRequest) => ['frontera-knowledge', 'search', request] as const,
+  document: (id: string) => ['frontera-knowledge', 'document', id] as const,
+}
+
+export const FronteraKnowledgeContext = createContext<KnowledgeClient | null>(null)
+
+/** The App's Knowledge client, for uploads, statuses and anything the hooks do not cover. */
+export function useKnowledgeClient(): KnowledgeClient {
+  const client = useContext(FronteraKnowledgeContext)
+  if (!client) throw new Error('No KnowledgeClient in context. Add knowledgeProvider to the providers of createFronteraApp or FronteraAppProvider.')
+  return client
+}
+
+type ReadOptions<TData> = Omit<UseQueryOptions<TData, Error>, 'queryKey' | 'queryFn'>
+
+/** Search results for `request`, or nothing while it is null or its query is empty. */
+export function useKnowledgeSearch(request: SearchRequest | null, options: ReadOptions<SearchResponse> = {}): UseQueryResult<SearchResponse, Error> {
+  const client = useKnowledgeClient()
+  const asked = request && request.query.trim() ? request : null
+  return useQuery({
+    queryKey: knowledgeKeys.search(asked ?? { query: '' }),
+    queryFn: ({ signal }) => client.search(asked!, signal),
+    ...options,
+    enabled: asked ? (options.enabled ?? true) : false,
+  })
+}
+
+/** One document with its base, for a citation's details; disabled while `id` is missing. */
+export function useKnowledgeDocument(id: string | null | undefined, options: ReadOptions<KnowledgeDocumentDetails> = {}): UseQueryResult<KnowledgeDocumentDetails, Error> {
+  const client = useKnowledgeClient()
+  return useQuery({
+    queryKey: knowledgeKeys.document(id ?? ''),
+    queryFn: () => client.documents.get(id!),
+    ...options,
+    enabled: id ? (options.enabled ?? true) : false,
+  })
+}