@hiai-gg/docsmint 0.8.4 → 0.8.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -10,20 +10,10 @@ agents access to the same documents through MCP, REST, the SDK, or CLI.
10
10
  operating the stack, or **[self-host with Docker](#quickstart)** to run the
11
11
  Apache-2.0 application on your own infrastructure.
12
12
 
13
- [![Apache-2.0 License](https://img.shields.io/badge/License-Apache--2.0-green.svg)](LICENSE)
13
+ [![Apache-2.0 License](https://img.shields.io/badge/License-Apache--2.0-green.svg)](https://github.com/HiAi-gg/docsmint/blob/main/LICENSE)
14
14
  [![Release](https://img.shields.io/github/v/release/hiai-gg/docsmint?sort=semver)](https://github.com/hiai-gg/docsmint/releases)
15
15
  [![npm](https://img.shields.io/npm/v/@hiai-gg/docsmint?logo=npm)](https://www.npmjs.com/package/@hiai-gg/docsmint)
16
- [![Docker Pulls](https://img.shields.io/docker/pulls/vgalibov/docsmint?logo=docker)](https://hub.docker.com/r/vgalibov/docsmint)
17
- [![Stars](https://img.shields.io/github/stars/hiai-gg/docsmint)](https://github.com/hiai-gg/docsmint/stargazers)
18
16
  [![CI](https://github.com/hiai-gg/docsmint/actions/workflows/ci.yml/badge.svg)](https://github.com/hiai-gg/docsmint/actions/workflows/ci.yml)
19
- [![Bun](https://img.shields.io/badge/Runtime-Bun_1.4-black?logo=bun&logoColor=white)](https://bun.sh)
20
- [![TypeScript](https://img.shields.io/badge/TypeScript-6.x-3178C6?logo=typescript&logoColor=white)](https://www.typescriptlang.org)
21
- [![Svelte](https://img.shields.io/badge/Svelte-5.x-FF3E00?logo=svelte&logoColor=white)](https://svelte.dev)
22
- [![Elysia](https://img.shields.io/badge/Elysia-1.4-lightgrey?logo=elysia&logoColor=white)](https://elysiajs.com)
23
- [![Tailwind_CSS](https://img.shields.io/badge/Tailwind_CSS-v4-06B6D4?logo=tailwindcss&logoColor=white)](https://tailwindcss.com)
24
- [![Drizzle_ORM](https://img.shields.io/badge/Drizzle_ORM-0.45-C5F74F?logo=drizzle&logoColor=black)](https://orm.drizzle.team)
25
- [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](CONTRIBUTING.md)
26
- [![MCP Badge](https://lobehub.com/badge/mcp/hiai-gg-docsmint)](https://lobehub.com/mcp/hiai-gg-docsmint)
27
17
 
28
18
  [GitHub](https://github.com/HiAi-gg/docsmint) ·
29
19
  [Docker Hub](https://hub.docker.com/r/vgalibov/docsmint) ·
@@ -56,7 +46,7 @@ credentials; lifecycle management belongs to the signed-in browser session.
56
46
  key in its browser UI, and configure `HIAI_DOCS_URL` and `HIAI_DOCS_API_KEY` for
57
47
  `npx --yes --package @hiai-gg/docsmint docsmint-mcp`. The npm package is a stdio
58
48
  bridge to your running deployment, not a server installer. See the
59
- [MCP guide](packages/mcp-server/README.md) for client configuration.
49
+ [MCP guide](https://github.com/HiAi-gg/docsmint/blob/main/packages/mcp-server/README.md) for client configuration.
60
50
 
61
51
  ## Why DocsMint?
62
52
 
@@ -73,30 +63,18 @@ bridge to your running deployment, not a server installer. See the
73
63
  - **Choose how you run it.** Use [managed DocsMint](https://docsmint.com) or
74
64
  self-host the application, database, search, queues, and files.
75
65
 
76
- ## What's new in 0.8.4?
66
+ ## What's new in 0.8.5?
77
67
 
78
- MCP discovery now explains both supported deployment choices:
68
+ This release makes DocsMint easier to discover, install, and evaluate:
79
69
 
80
- - DocsMint Cloud is the recommended route for connecting without running a server.
81
- - Self-hosted DocsMint remains the complete Apache-2.0 alternative with the same
82
- npm/stdio bridge, tools, prompts, resources and public contracts.
83
- - Registry, LobeHub and npm descriptions include hybrid search, reranking,
84
- GraphRAG and scoped document access, with source-aware onboarding links.
85
- - The MCP guide explains Cloud browser authorization for OAuth-capable clients,
86
- existing API-key configuration and the separate self-hosted setup.
87
- - Release checks now verify built public exports and MCP binaries before packaging.
88
- - Authorization regression coverage includes mixed category scopes, external tenant
89
- assertions, scoped attachment deletion, workspace tags and partial category updates.
90
- - A deterministic offline retrieval baseline makes evaluation repeatable without
91
- claiming a change to live retrieval quality.
70
+ - Clearer guides for choosing DocsMint Cloud or a self-hosted workspace.
71
+ - One public package, `@hiai-gg/docsmint`, for the SDK, CLI, and MCP bridge.
72
+ - A Docker image guide that distinguishes the API, web application, and Caddy proxy.
73
+ - Consistent release notes and package documentation, with links that also work on npm.
92
74
 
93
- No database migration, tool redesign or SDK contract change is added. Hosted
94
- OAuth is a DocsMint Cloud capability; this OSS release documents how to connect
95
- and does not embed Cloud accounts, billing or analytics in self-hosted installs.
96
-
97
- Read the complete release history in the [changelog](CHANGELOG.md) or
98
- [GitHub Releases](https://github.com/HiAi-gg/docsmint/releases). See the
99
- [roadmap](docs/ROADMAP.md) for what comes next.
75
+ No database migration or public API change is required. Read the
76
+ [release notes](https://github.com/HiAi-gg/docsmint/releases/tag/v0.8.5),
77
+ [changelog](https://github.com/HiAi-gg/docsmint/blob/main/CHANGELOG.md), or [roadmap](https://github.com/HiAi-gg/docsmint/blob/main/docs/ROADMAP.md).
100
78
 
101
79
  ## Install with an AI agent
102
80
 
@@ -148,8 +126,9 @@ docker pull vgalibov/docsmint:web-latest
148
126
  docker pull vgalibov/docsmint:caddy-latest
149
127
  ```
150
128
 
151
- Use versioned tags `api-v0.8.4`, `web-v0.8.4`, and `caddy-v0.8.4` for
152
- reproducible deploys. The quickstart still builds the Compose stack from this repository so PostgreSQL,
129
+ Use versioned tags `api-v0.8.5`, `web-v0.8.5`, and `caddy-v0.8.5` for
130
+ reproducible deploys. Caddy is the supporting reverse proxy with rate limiting;
131
+ it is separate from the API and web application. The quickstart still builds the Compose stack from this repository so PostgreSQL,
153
132
  Redis, and SeaweedFS start together with the application.
154
133
 
155
134
  For OpenRouter, add one value to `.env` and run the script again:
@@ -197,7 +176,7 @@ The canonical local ports are:
197
176
  | SeaweedFS S3 gateway | `50702` |
198
177
  | SeaweedFS filer UI | `50703` |
199
178
 
200
- See [Deployment](docs/DEPLOYMENT.md) for domains, TLS, provider tuning,
179
+ See [Deployment](https://github.com/HiAi-gg/docsmint/blob/main/docs/DEPLOYMENT.md) for domains, TLS, provider tuning,
201
180
  backups, and production operation.
202
181
 
203
182
  Embedding provider URLs, models, and credentials are deployment configuration.
@@ -205,8 +184,9 @@ They are never stored in browser settings or local storage.
205
184
 
206
185
  ## Use DocsMint from the terminal
207
186
 
208
- The published package includes the CLI. It connects to an already running
209
- DocsMint server; installing it does not deploy the server.
187
+ One public package, **`@hiai-gg/docsmint`**, includes the TypeScript SDK,
188
+ `docsmint` CLI, and `docsmint-mcp` bridge. These clients connect to a running
189
+ DocsMint deployment; use the Docker quickstart to install the self-hosted server.
210
190
 
211
191
  ```bash
212
192
  bun add @hiai-gg/docsmint
@@ -225,7 +205,7 @@ bunx --package @hiai-gg/docsmint docsmint create \
225
205
  ```
226
206
 
227
207
  Credentials can also be supplied through `HIAI_DOCS_URL` and
228
- `HIAI_DOCS_API_KEY`. See the [CLI guide](packages/cli/README.md) for every
208
+ `HIAI_DOCS_API_KEY`. See the [CLI guide](https://github.com/HiAi-gg/docsmint/blob/main/packages/cli/README.md) for every
229
209
  command and configuration precedence.
230
210
 
231
211
  ## Connect an MCP client
@@ -266,7 +246,7 @@ Run the published stdio bridge against your own DocsMint API:
266
246
 
267
247
  Category keys let you expose only the documents and operations an agent needs.
268
248
  Use a global key only for trusted owner-wide automation. See the
269
- [complete MCP reference](packages/mcp-server/README.md) for Bun, npm, local
249
+ [complete MCP reference](https://github.com/HiAi-gg/docsmint/blob/main/packages/mcp-server/README.md) for Bun, npm, local
270
250
  checkout, all tools, prompts, resources, permissions, and REST mappings.
271
251
 
272
252
  ## TypeScript SDK
@@ -294,7 +274,7 @@ console.log(created.id, results.items);
294
274
 
295
275
  The SDK is a typed `fetch` client with retries for transient failures and
296
276
  idempotent document creation retries. See the
297
- [SDK reference](packages/sdk/README.md) and [REST API](docs/API.md).
277
+ [SDK reference](https://github.com/HiAi-gg/docsmint/blob/main/packages/sdk/README.md) and [REST API](https://github.com/HiAi-gg/docsmint/blob/main/docs/API.md).
298
278
 
299
279
  ## API keys and integrations
300
280
 
@@ -364,8 +344,8 @@ extracts entities after embeddings are ready and finds related documents beyond
364
344
  direct keyword or vector similarity. It degrades gracefully when an external
365
345
  model is unavailable.
366
346
 
367
- For pipeline internals and tuning, see [Architecture](docs/ARCHITECTURE.md) and
368
- [Deployment](docs/DEPLOYMENT.md).
347
+ For pipeline internals and tuning, see [Architecture](https://github.com/HiAi-gg/docsmint/blob/main/docs/ARCHITECTURE.md) and
348
+ [Deployment](https://github.com/HiAi-gg/docsmint/blob/main/docs/DEPLOYMENT.md).
369
349
 
370
350
  ## Stack
371
351
 
@@ -379,16 +359,16 @@ For pipeline internals and tuning, see [Architecture](docs/ARCHITECTURE.md) and
379
359
 
380
360
  ## Documentation
381
361
 
382
- - [Documentation index](docs/README.md)
383
- - [Product usage](docs/USAGE.md)
384
- - [Roadmap](docs/ROADMAP.md)
385
- - [REST API](docs/API.md) and [OpenAPI JSON](docs/openapi.json)
386
- - [Architecture](docs/ARCHITECTURE.md)
387
- - [Deployment and operations](docs/DEPLOYMENT.md)
388
- - [Extension points](docs/EXTENDING.md)
389
- - [Maintainer release flow](docs/RELEASING.md)
390
- - [Security policy](SECURITY.md)
391
- - [Changelog](CHANGELOG.md)
362
+ - [Documentation index](https://github.com/HiAi-gg/docsmint/blob/main/docs/README.md)
363
+ - [Product usage](https://github.com/HiAi-gg/docsmint/blob/main/docs/USAGE.md)
364
+ - [Roadmap](https://github.com/HiAi-gg/docsmint/blob/main/docs/ROADMAP.md)
365
+ - [REST API](https://github.com/HiAi-gg/docsmint/blob/main/docs/API.md) and [OpenAPI JSON](https://github.com/HiAi-gg/docsmint/blob/main/docs/openapi.json)
366
+ - [Architecture](https://github.com/HiAi-gg/docsmint/blob/main/docs/ARCHITECTURE.md)
367
+ - [Deployment and operations](https://github.com/HiAi-gg/docsmint/blob/main/docs/DEPLOYMENT.md)
368
+ - [Extension points](https://github.com/HiAi-gg/docsmint/blob/main/docs/EXTENDING.md)
369
+ - [Maintainer release flow](https://github.com/HiAi-gg/docsmint/blob/main/docs/RELEASING.md)
370
+ - [Security policy](https://github.com/HiAi-gg/docsmint/blob/main/SECURITY.md)
371
+ - [Changelog](https://github.com/HiAi-gg/docsmint/blob/main/CHANGELOG.md)
392
372
 
393
373
  ## Development
394
374
 
@@ -402,12 +382,12 @@ bun run test
402
382
  bun run build
403
383
  ```
404
384
 
405
- Read [CONTRIBUTING.md](CONTRIBUTING.md) before opening a pull request. Please
406
- report vulnerabilities through [SECURITY.md](SECURITY.md), not a public issue.
385
+ Read [CONTRIBUTING.md](https://github.com/HiAi-gg/docsmint/blob/main/CONTRIBUTING.md) before opening a pull request. Please
386
+ report vulnerabilities through [SECURITY.md](https://github.com/HiAi-gg/docsmint/blob/main/SECURITY.md), not a public issue.
407
387
 
408
388
  ## License
409
389
 
410
- DocsMint is released under the [Apache License 2.0](LICENSE).
390
+ DocsMint is released under the [Apache License 2.0](https://github.com/HiAi-gg/docsmint/blob/main/LICENSE).
411
391
 
412
392
  Built as an independent open-source project in the
413
393
  [HiAi](https://github.com/HiAi-gg) ecosystem.
@@ -238398,7 +238398,7 @@ var swaggerConfig = {
238398
238398
  },
238399
238399
  info: {
238400
238400
  title: "DocsMint API",
238401
- version: "0.8.4",
238401
+ version: "0.8.5",
238402
238402
  description: "Self-hosted AI-native knowledge workspace and installable PWA with hybrid search, GraphRAG, REST, SDK, CLI, and MCP access for people and AI agents.",
238403
238403
  contact: { name: "HiAi-gg", url: "https://github.com/HiAi-gg/docsmint" },
238404
238404
  license: {
package/dist/mcp-cli.js CHANGED
@@ -1052,7 +1052,7 @@ function registerDocsmintMcpCapabilities(server, client2) {
1052
1052
  registerExtendedCapabilities(server, client2, (handler11) => wrapHandler("extended", handler11));
1053
1053
  }
1054
1054
  function createDocsmintMcpServer(options = {}) {
1055
- const server = new McpServer({ name: "docsmint", version: "0.8.4" });
1055
+ const server = new McpServer({ name: "docsmint", version: "0.8.5" });
1056
1056
  const client2 = options.docsClient ? createMcpDocsClient(options.docsClient, options.requestContext) : options.client ?? createMcpDocsClient(createDefaultDocsClient(), options.requestContext);
1057
1057
  registerDocsmintMcpCapabilities(server, client2);
1058
1058
  return server;
@@ -1048,7 +1048,7 @@ function registerDocsmintMcpCapabilities(server, client2) {
1048
1048
  registerExtendedCapabilities(server, client2, (handler11) => wrapHandler("extended", handler11));
1049
1049
  }
1050
1050
  function createDocsmintMcpServer(options = {}) {
1051
- const server = new McpServer({ name: "docsmint", version: "0.8.4" });
1051
+ const server = new McpServer({ name: "docsmint", version: "0.8.5" });
1052
1052
  const client2 = options.docsClient ? createMcpDocsClient(options.docsClient, options.requestContext) : options.client ?? createMcpDocsClient(createDefaultDocsClient(), options.requestContext);
1053
1053
  registerDocsmintMcpCapabilities(server, client2);
1054
1054
  return server;
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@hiai-gg/docsmint",
3
3
  "mcpName": "io.github.HiAi-gg/docsmint",
4
- "version": "0.8.4",
4
+ "version": "0.8.5",
5
5
  "type": "module",
6
6
  "browser": {
7
7
  "./dist/backend-launcher.js": false,
@@ -25,7 +25,7 @@ import { registerSearch } from './commands/search.js';
25
25
  import { registerSnapshot } from './commands/snapshot.js';
26
26
  import { registerUpdate } from './commands/update.js';
27
27
 
28
- const VERSION = '0.8.4';
28
+ const VERSION = '0.8.5';
29
29
 
30
30
  const program = new Command();
31
31
  program.name('docsmint').description('CLI for the DocsMint knowledge workspace').version(VERSION);
package/server.json CHANGED
@@ -10,7 +10,7 @@
10
10
  "id": "1249550690",
11
11
  "subfolder": "packages/mcp-server"
12
12
  },
13
- "version": "0.8.4",
13
+ "version": "0.8.5",
14
14
  "icons": [
15
15
  {
16
16
  "src": "https://raw.githubusercontent.com/HiAi-gg/docsmint/main/frontend/static/logo-dark.png",
@@ -30,7 +30,7 @@
30
30
  "registryType": "npm",
31
31
  "registryBaseUrl": "https://registry.npmjs.org",
32
32
  "identifier": "@hiai-gg/docsmint",
33
- "version": "0.8.4",
33
+ "version": "0.8.5",
34
34
  "runtimeHint": "npx",
35
35
  "transport": {
36
36
  "type": "stdio"