@adaptiqai/deepseek-harness 0.0.0-stage → 0.2.1

package/README.md

@@ -1,3 +1,115 @@
-# Temporary Holding Version
+# AdaptiqAI for DeepSeek Harness
 
-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.
+Use your AdaptiqAI workspace in DeepSeek Harness: every model your workspace has lanes on, with native memory that keeps the whole conversation — up to 5 million tokens — and your Knowledge collections in any conversation. You sign in once, or create your account, in the browser; then pick a model and start, all from inside the harness. There are no keys to copy.
+
+![Welcome](docs/screenshots/welcome.jpg)
+
+## Install
+
+1. Open **Plugins** in the sidebar and choose **Add plugin**.
+2. Enter the package — `@adaptiqai/deepseek-harness`, or the full path to a downloaded `adaptiqai-deepseek-harness-<version>.tgz` — and install it.
+3. A welcome card asks you to **Connect AdaptiqAI**. Your browser opens; you sign in (or create an account with GitHub, Google or email) and approve, and the harness picks it up by itself.
+4. A new account has no model yet: the same card shows the models on offer, with price, speed and memory. Choose one and how many lanes (conversations at once), then **Get access** and confirm in the browser. The model appears in the picker as soon as it is active.
+
+From a terminal the same is:
+
+```bash
+dsh plugin --profile web add @adaptiqai/deepseek-harness
+```
+
+DeepSeek Harness 0.2.0-rc.2 or a later 0.2 release is required.
+
+## What you get
+
+**Your models, set up correctly.** The model picker gets an **AdaptiqAI** group with exactly the models your workspace has lanes on. Each one comes with its real context window, its output limit and its own thinking levels, all read from the server — nothing in the plugin names a model.
+
+![Model picker](docs/screenshots/model-picker.jpg) ![Thinking levels](docs/screenshots/thinking-levels.jpg)
+
+**Memory you can see.** A small pill next to the send button shows how much of the conversation AdaptiqAI holds (`NCM · 25k of 5M`). After each answer it shows how much came straight from memory (`24.6k from memory`). Click it to switch the conversation between **Remember** and **Private**, see the last reply's split, and add or remove knowledge.
+
+![Composer](docs/screenshots/composer-from-memory.jpg) ![Memory popover](docs/screenshots/memory-popover.jpg)
+
+**Settings → AdaptiqAI.** Your workspace, the models and lanes with live running/waiting counts, memory use split into conversations and knowledge, whether new conversations are saved, and links to the console.
+
+![Settings](docs/screenshots/settings.jpg)
+
+**Knowledge.** The Knowledge panel in the sidebar lists your collections. Use one in the open conversation with one click, or drop files to create a new collection; it is attached automatically when it is ready.
+
+![Knowledge](docs/screenshots/knowledge.jpg) ![New collection](docs/screenshots/create-knowledge.jpg)
+
+**One model per memory.** AdaptiqAI builds a conversation's memory and each collection for one model, and they only work with that model. The Knowledge panel lists the collections that work with the model you are using first. Collections built for other models appear below, greyed out, each with **Make available for <model>**. A collection can never be added to a conversation on the wrong model. If you switch the model in a conversation whose memory is on another model, a short note above the composer offers **Switch back** or **Start fresh on <model>**.
+
+![Other models' collections](docs/screenshots/knowledge-by-model.jpg) ![Model notice](docs/screenshots/model-notice.jpg)
+
+**Notices that say what to do.** If every lane is busy, the harness waits and retries by itself and tells you so. If the workspace has no lanes on a model, you get a **Get access** button. If memory is nearly full, you are told before it fills, with a way to clean up or continue privately. If your sign-in expires, you are asked to sign in again.
+
+![Notices](docs/screenshots/notices.jpg)
+
+**`/adaptiq`** in the composer: `status`, `signin`, `private`, `remember`, `knowledge`, `open`, `diagnostics`, `signout`.
+
+**Get a model without leaving the harness.** Settings → AdaptiqAI → **Get a model** (or **Get access** on any "no lanes" notice) lists what is on offer. You confirm, and pay when payment is by card, in the browser; the plugin follows the request and shows the model when it is ready.
+
+![Get a model](docs/screenshots/get-a-model.jpg) ![Ready](docs/screenshots/model-ready.jpg)
+
+**Conversations as knowledge.** The Knowledge panel's **Conversations** tab lists your other conversations on the same model, newest first. Add one, and this conversation knows what it knew.
+
+![Conversations](docs/screenshots/conversations.jpg)
+
+**Agent tools.** Agents can find and attach knowledge (`adaptiq_knowledge`), check shared memory and offer clean-up options (`adaptiq_memory`), and save what they learned as a new collection (`adaptiq_create_knowledge`). Agents never delete anything; clean-up happens in the console.
+
+## How it works
+
+- **Requests** go to the AdaptiqAI OpenAI-compatible API. Each request carries the harness conversation id (`X-Adaptiq-Session-Id`), so the server keeps one memory per conversation. Title requests carry no id, so they never fork a saved conversation.
+- **No compaction.** AdaptiqAI keeps the full conversation, so the plugin reports the model's true context window and declines the harness's compaction requests with a plain explanation. Nothing is ever summarised away.
+- **Thinking levels** come from each model's capability card (`adaptiq-model-capabilities-v1`): the levels, the value that turns thinking off, the default and the request field. Models without a card fall back to Low/High/Extra high/Max only when their id names a reasoning model.
+- **Usage** is reported the harness's way: tokens read from memory count as cache reads, so the harness's own counters (cost, cache hit) are right.
+- **Busy and preparing answers** are retried by the harness, honouring the server's `Retry-After`.
+
+## Privacy and security
+
+- Sign-in uses the device flow: the plugin shows a short code, you approve in the browser, and the plugin receives a workspace credential. It is stored in the harness credential store (`$DSH_HOME/.credentials.yaml`, readable only by you) and renews itself. Tokens never reach the browser page.
+- The connection appears in the AdaptiqAI console under **API keys** as "DeepSeek Harness on <your computer>"; revoking it there disconnects this computer only.
+- **Private** conversations can still read memory and knowledge, but nothing new is saved.
+- `/adaptiq diagnostics` produces a report without any secrets that you can send to support.
+
+## Headless and CI
+
+Without a browser, store an API key from the console under the credential reference `ADAPTIQAI_API_KEY` (for example as an environment variable). The plugin uses it whenever no one is signed in.
+
+## Configuration
+
+Everything has a production default. To change something, add a row to your profile's `cordis.patch.yml`:
+
+```yaml
+- id: adaptiq
+  name: '@adaptiqai/deepseek-harness'
+  config:
+    route: adaptiqai              # provider id in the model picker
+    apiBase: https://api.adaptiqai.com
+    consoleUrl: https://memory.adaptiqai.com/memory
+    apiKeyEnv: ADAPTIQAI_API_KEY  # headless credential reference
+    tools: true                   # agent tools
+    progressEvents: true          # streamed "preparing" progress
+    streamIdleTimeoutSeconds: 900
+```
+
+## Troubleshooting
+
+- **"AdaptiqAI models are hidden — another provider already uses the route".** An older hand-made `adaptiqai` provider exists in your profile (usually an `llm-pi-ai` entry in `cordis.patch.yml`). Remove that entry and restart the harness.
+- **Models missing.** Open Settings → AdaptiqAI and press refresh; the list shows exactly what the workspace has lanes on.
+- Anything else: run `/adaptiq diagnostics` and send the report to support.
+
+## Development
+
+```bash
+pnpm install
+npm run link-dsh      # link the locally installed DeepSeek Harness packages for types and tests
+npm run build         # lib/index.js (Host), lib/client.js (browser), Typert artifacts
+npm test              # unit tests
+ADAPTIQ_LIVE=1 ADAPTIQAI_API_KEY=ak_live_… npx vitest run test/live.test.ts   # one short live request
+npm run pack:local    # dist/adaptiqai-deepseek-harness-<version>.tgz
+```
+
+Layout: `src/host` (adapter, sign-in, workspace service, Remote controller, command, tools), `src/client` (React UI in the AdaptiqAI design), `src/shared` (wire types), `scripts/remote-spec.mjs` (the Remote namespace; `scripts/gen-typert.mjs` turns it into the Typert artifacts the harness loads).
+
+The UI uses PP Frama when it is installed on the computer. The package does not ship PP Frama (its licence does not allow it); otherwise it falls back to Manrope, an SIL Open Font License grotesk embedded in the browser bundle (licence in `assets/fonts/Manrope-OFL.txt`).

package/assets/fonts/Manrope-OFL.txt

@@ -0,0 +1,93 @@
+Copyright 2019 The Manrope Project Authors (https://github.com/sharanda/manrope)
+
+This Font Software is licensed under the SIL Open Font License, Version 1.1.
+This license is copied below, and is also available with a FAQ at:
+http://scripts.sil.org/OFL
+
+
+-----------------------------------------------------------
+SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
+-----------------------------------------------------------
+
+PREAMBLE
+The goals of the Open Font License (OFL) are to stimulate worldwide
+development of collaborative font projects, to support the font creation
+efforts of academic and linguistic communities, and to provide a free and
+open framework in which fonts may be shared and improved in partnership
+with others.
+
+The OFL allows the licensed fonts to be used, studied, modified and
+redistributed freely as long as they are not sold by themselves. The
+fonts, including any derivative works, can be bundled, embedded,
+redistributed and/or sold with any software provided that any reserved
+names are not used by derivative works. The fonts and derivatives,
+however, cannot be released under any other type of license. The
+requirement for fonts to remain under this license does not apply
+to any document created using the fonts or their derivatives.
+
+DEFINITIONS
+"Font Software" refers to the set of files released by the Copyright
+Holder(s) under this license and clearly marked as such. This may
+include source files, build scripts and documentation.
+
+"Reserved Font Name" refers to any names specified as such after the
+copyright statement(s).
+
+"Original Version" refers to the collection of Font Software components as
+distributed by the Copyright Holder(s).
+
+"Modified Version" refers to any derivative made by adding to, deleting,
+or substituting -- in part or in whole -- any of the components of the
+Original Version, by changing formats or by porting the Font Software to a
+new environment.
+
+"Author" refers to any designer, engineer, programmer, technical
+writer or other person who contributed to the Font Software.
+
+PERMISSION & CONDITIONS
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of the Font Software, to use, study, copy, merge, embed, modify,
+redistribute, and sell modified and unmodified copies of the Font
+Software, subject to the following conditions:
+
+1) Neither the Font Software nor any of its individual components,
+in Original or Modified Versions, may be sold by itself.
+
+2) Original or Modified Versions of the Font Software may be bundled,
+redistributed and/or sold with any software, provided that each copy
+contains the above copyright notice and this license. These can be
+included either as stand-alone text files, human-readable headers or
+in the appropriate machine-readable metadata fields within text or
+binary files as long as those fields can be easily viewed by the user.
+
+3) No Modified Version of the Font Software may use the Reserved Font
+Name(s) unless explicit written permission is granted by the corresponding
+Copyright Holder. This restriction only applies to the primary font name as
+presented to the users.
+
+4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
+Software shall not be used to promote, endorse or advertise any
+Modified Version, except to acknowledge the contribution(s) of the
+Copyright Holder(s) and the Author(s) or with their explicit written
+permission.
+
+5) The Font Software, modified or unmodified, in part or in whole,
+must be distributed entirely under this license, and must not be
+distributed under any other license. The requirement for fonts to
+remain under this license does not apply to any document created
+using the Font Software.
+
+TERMINATION
+This license becomes null and void if any of the above conditions are
+not met.
+
+DISCLAIMER
+THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
+OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
+COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
+DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
+OTHER DEALINGS IN THE FONT SOFTWARE.

package/cordis.patch.yml

@@ -0,0 +1,7 @@
+# AdaptiqAI for DeepSeek Harness. One row: the Host half (model provider,
+# sign-in, memory, knowledge tools, /adaptiq) and, through package.json
+# dsh.client, the browser half (settings, composer memory pill, Knowledge,
+# notices).
+- insert:
+    - id: adaptiq
+      name: '@adaptiqai/deepseek-harness'

package/icon.svg

@@ -0,0 +1,10 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 128 128" width="128" height="128">
+  <!-- AdaptiqAI cairn on Dark Navy -->
+  <rect width="128" height="128" rx="28" fill="#0F1A2E"/>
+  <g transform="translate(64 2) scale(0.78)">
+    <ellipse cx="0" cy="110" rx="48" ry="14" fill="#D94E3A"/>
+    <ellipse cx="-3" cy="78" rx="36" ry="12" fill="#F06650"/>
+    <ellipse cx="3" cy="48" rx="26" ry="10" fill="#F4897A"/>
+    <ellipse cx="0" cy="22" rx="16" ry="8" fill="#FFFFFF"/>
+  </g>
+</svg>