@boldare/askdare 0.0.0-stage → 0.1.0-rc.1

package/CHANGELOG.md

@@ -0,0 +1,26 @@
+# @boldare/askdare
+
+## 0.1.0-rc.1
+
+### Patch Changes
+
+- 13259d4: When the chat opens with a stored conversation and the server refuses the session, it shows the server's reason (explained in development) instead of "Could not load the previous conversation." The conversation stays stored for the next try.
+
+## 0.1.0-rc.0
+
+### Minor Changes
+
+- da333a2: First release of askdare: an AI chat for any website, served by your Next.js app and built on the official OpenAI SDK (Responses and Conversations APIs). It succeeds `@boldare/openai-assistant`, which stopped working when OpenAI shut down the Assistants API.
+  
+  - **Integration:** a bot in `askdare.config.ts` (`defineBot`), one catch-all route (`createChatHandler`) and one script tag on any website (`widget.js?bot=<id>`). `npx @boldare/askdare init` sets it up, and `npx @boldare/askdare doctor` checks the key, models, vector store, headers and allowed sites, locally or deployed.
+  - **Embedding:** a small loader and an isolated iframe served by your app, shown only on the sites in `security.allowedOrigins`. As a bubble, behind your own button (`data-launcher="none"`) or inside the page (`data-mode="inline"`), driven by `askdare('open' | 'close' | 'toggle' | 'configure' | 'identify')`.
+  - **No database:** conversations live in OpenAI's Conversations API, and the browser keeps an encrypted resume token. Visitors can start a new conversation, which deletes the old one and its files.
+  - **Knowledge base:** `npx @boldare/askdare kb sync <folder>` mirrors your documents to a vector store, and answers cite your pages.
+  - **Tools:** `defineTool` with Zod schemas, validated arguments, timeouts and output limits. Tools see only verified context.
+  - **Attachments and voice:** images and PDFs (checked by their bytes, re-encoded in the browser, referenced by encrypted handles), and dictation into the message field.
+  - **Signed-in visitors:** `askdare('identify', token)` with a JWT your backend signs.
+  - **Safety and cost:** short-lived encrypted sessions; rate limits; daily token and speech budgets per visitor, IP, bot and app, reserved per model call; a kill switch; sanitized Markdown; no cookies; no message content in logs; `onError` for your monitoring. In development, the chat and the log say what is wrong with the setup.
+  - **Look:** four themes (Aura, Halo, Sage, Care) in light and dark, your own with `defineTheme`, `--ask-*` tokens and `data-ask-part` parts for your CSS, English and Polish texts with overrides for every key, and an AI disclosure. Keyboard, focus and screen reader support, checked with axe.
+  - **Docs in the package:** the guides (`docs/`), `llms.txt` and a skill for AI coding agents (`skills/askdare`), always matching the installed version.
+  
+  For limits shared across several server instances, add `@boldare/askdare-upstash`.

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Boldare S.A.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,66 @@
-# Temporary Holding Version
+# @boldare/askdare
 
-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.
+**Dare to ask.** An AI chatbot for any website, served by your Next.js app and built on the official OpenAI SDK. One route file, one `<script>` tag, no database.
+
+- Embeds anywhere through a small loader and an isolated iframe, limited to the sites you list.
+- Secure by default: short-lived session tokens, rate limits, daily token budgets, sanitized output.
+- Knowledge base with citations, your own tools, image and PDF attachments, voice input.
+- Four themes in light and dark, English and Polish texts, customizable down to your own CSS.
+
+> **Release candidate (0.1.0-rc).** The API may still change before 0.1.0; pin the exact version.
+
+## Quick start
+
+In a Next.js 16 app with the App Router:
+
+```bash
+npm install @boldare/askdare@rc zod
+npx @boldare/askdare init      # route, bot config, .env.local and the chat script
+# set OPENAI_API_KEY and ASKDARE_MODEL in .env.local
+npm run dev
+npx @boldare/askdare doctor    # checks the key, model, permissions and headers
+```
+
+`init` writes the bot definition and the route, and loads the chat in the root layout:
+
+```ts
+// askdare.config.ts
+import { defineBot } from '@boldare/askdare';
+
+export const bots = [
+  defineBot({
+    id: 'support',
+    model: process.env.ASKDARE_MODEL ?? '',
+    instructions: 'You answer questions about our product. If you do not know, say so.',
+    security: { allowedOrigins: ['https://www.example.com'] },
+    widget: { theme: 'aura', greeting: 'Hi! How can I help?' },
+  }),
+];
+```
+
+```ts
+// app/api/chat/[...path]/route.ts
+import { createChatHandler } from '@boldare/askdare/next';
+import { bots } from '../../../../askdare.config';
+
+export const maxDuration = 300;
+export const { GET, POST, DELETE } = createChatHandler({ bots });
+```
+
+Other sites embed the same chat with one tag:
+
+```html
+<script src="https://your-app.example.com/api/chat/widget.js?bot=support" async></script>
+```
+
+## Documentation
+
+The guides ship with the package in `node_modules/@boldare/askdare/docs/`, starting with `getting-started.md`; `configuration.md`, `cli.md` and `troubleshooting.md` are the references. They are also on [GitHub](https://github.com/boldare/askdare/tree/main/docs). AI coding agents can start from `node_modules/@boldare/askdare/llms.txt`, or use the skill in `node_modules/@boldare/askdare/skills/askdare/` (copy the folder into `.claude/skills/`).
+
+## Requirements
+
+Node.js 22 or later, Next.js 16 with the App Router on the Node.js runtime, React 19 and zod 4.1 or later. The full matrix, browsers included, is in `docs/support.md`.
+
+## License
+
+MIT © Boldare