@dogsbay/plugin-ask 0.2.0-beta.101

package/dist/schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"schema.js","sourceRoot":"","sources":["../src/schema.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AA0FH,MAAM,QAAQ,GAAkD;IAC9D,IAAI,EAAE,QAAQ;IACd,WAAW,EAAE,QAAQ;IACrB,KAAK,EAAE,cAAc;IACrB,WAAW,EAAE,iBAAiB;IAC9B,QAAQ,EAAE,cAAc;IACxB,SAAS,EAAE,MAAM;IACjB,cAAc,EAAE,IAAI;IACpB,QAAQ,EAAE,CAAC;IACX,mBAAmB,EAAE,IAAI;IACzB,QAAQ,EAAE,IAAI;IACd,gBAAgB,EAAE,EAAE;CACrB,CAAC;AAEF,MAAM,GAAG,GAAG,qBAAqB,CAAC;AAElC;;;GAGG;AACH,MAAM,UAAU,YAAY,CAAC,KAAc;IACzC,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QAC/F,MAAM,IAAI,KAAK,CACb,GAAG,GAAG,sFAAsF,QAAQ,CAAC,KAAK,CAAC,GAAG,CAC/G,CAAC;IACJ,CAAC;IACD,MAAM,IAAI,GAAG,KAAgC,CAAC;IAE9C,MAAM,QAAQ,GAAG,UAAU,CAAC,IAAI,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC;IACvD,MAAM,IAAI,GAAG,qBAAqB,CAAC,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IAEtD,MAAM,GAAG,GAAuB,EAAE,GAAG,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;IAEhE,IAAI,IAAI,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;QAC5B,IAAI,IAAI,CAAC,IAAI,KAAK,QAAQ,IAAI,IAAI,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;YACrD,MAAM,IAAI,KAAK,CAAC,GAAG,GAAG,8CAA8C,CAAC,CAAC;QACxE,CAAC;QACD,GAAG,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC;IACvB,CAAC;IACD,IAAI,IAAI,CAAC,WAAW,KAAK,SAAS;QAAE,GAAG,CAAC,WAAW,GAAG,qBAAqB,CAAC,IAAI,CAAC,WAAW,EAAE,aAAa,CAAC,CAAC;IAC7G,IAAI,IAAI,CAAC,KAAK,KAAK,SAAS;QAAE,GAAG,CAAC,KAAK,GAAG,qBAAqB,CAAC,IAAI,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;IACrF,IAAI,IAAI,CAAC,WAAW,KAAK,SAAS;QAAE,GAAG,CAAC,WAAW,GAAG,qBAAqB,CAAC,IAAI,CAAC,WAAW,EAAE,aAAa,CAAC,CAAC;IAC7G,IAAI,IAAI,CAAC,QAAQ,KAAK,SAAS,EAAE,CAAC;QAChC,IAAI,IAAI,CAAC,QAAQ,KAAK,cAAc,IAAI,IAAI,CAAC,QAAQ,KAAK,aAAa,EAAE,CAAC;YACxE,MAAM,IAAI,KAAK,CAAC,GAAG,GAAG,6DAA6D,CAAC,CAAC;QACvF,CAAC;QACD,GAAG,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;IAC/B,CAAC;IACD,IAAI,IAAI,CAAC,SAAS,KAAK,SAAS,EAAE,CAAC;QACjC,IAAI,IAAI,CAAC,SAAS,KAAK,MAAM,IAAI,IAAI,CAAC,SAAS,KAAK,MAAM,IAAI,IAAI,CAAC,SAAS,KAAK,UAAU,EAAE,CAAC;YAC5F,MAAM,IAAI,KAAK,CAAC,GAAG,GAAG,4DAA4D,CAAC,CAAC;QACtF,CAAC;QACD,GAAG,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC;IACjC,CAAC;IACD,IAAI,IAAI,CAAC,cAAc,KAAK,SAAS,EAAE,CAAC;QACtC,IAAI,OAAO,IAAI,CAAC,cAAc,KAAK,SAAS,EAAE,CAAC;YAC7C,MAAM,IAAI,KAAK,CAAC,GAAG,GAAG,6CAA6C,CAAC,CAAC;QACvE,CAAC;QACD,GAAG,CAAC,cAAc,GAAG,IAAI,CAAC,cAAc,CAAC;IAC3C,CAAC;IACD,IAAI,IAAI,CAAC,QAAQ,KAAK,SAAS,EAAE,CAAC;QAChC,IAAI,OAAO,IAAI,CAAC,QAAQ,KAAK,QAAQ,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,IAAI,CAAC,QAAQ,GAAG,CAAC,EAAE,CAAC;YAC/F,MAAM,IAAI,KAAK,CAAC,GAAG,GAAG,gDAAgD,CAAC,CAAC;QAC1E,CAAC;QACD,GAAG,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;IAC/B,CAAC;IACD,IAAI,IAAI,CAAC,mBAAmB,KAAK,SAAS,EAAE,CAAC;QAC3C,IAAI,OAAO,IAAI,CAAC,mBAAmB,KAAK,SAAS,EAAE,CAAC;YAClD,MAAM,IAAI,KAAK,CAAC,GAAG,GAAG,kDAAkD,CAAC,CAAC;QAC5E,CAAC;QACD,GAAG,CAAC,mBAAmB,GAAG,IAAI,CAAC,mBAAmB,CAAC;IACrD,CAAC;IACD,IAAI,IAAI,CAAC,QAAQ,KAAK,SAAS,EAAE,CAAC;QAChC,IAAI,OAAO,IAAI,CAAC,QAAQ,KAAK,SAAS,EAAE,CAAC;YACvC,MAAM,IAAI,KAAK,CAAC,GAAG,GAAG,uCAAuC,CAAC,CAAC;QACjE,CAAC;QACD,GAAG,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;IAC/B,CAAC;IACD,IAAI,IAAI,CAAC,gBAAgB,KAAK,SAAS,EAAE,CAAC;QACxC,GAAG,CAAC,gBAAgB,GAAG,qBAAqB,CAAC,IAAI,CAAC,gBAAgB,EAAE,kBAAkB,CAAC,CAAC;IAC1F,CAAC;IAED,OAAO,GAAG,CAAC;AACb,CAAC;AAED,SAAS,qBAAqB,CAAC,KAAc,EAAE,KAAa;IAC1D,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC;QACrD,MAAM,IAAI,KAAK,CAAC,GAAG,GAAG,aAAa,KAAK,8BAA8B,CAAC,CAAC;IAC1E,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED,SAAS,UAAU,CAAC,KAAc,EAAE,KAAa;IAC/C,MAAM,CAAC,GAAG,qBAAqB,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;IAC9C,IAAI,CAAC;QACH,kCAAkC;QAClC,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC;IACb,CAAC;IAAC,MAAM,CAAC;QACP,MAAM,IAAI,KAAK,CAAC,GAAG,GAAG,aAAa,KAAK,uCAAuC,CAAC,IAAI,CAAC,CAAC;IACxF,CAAC;IACD,OAAO,CAAC,CAAC;AACX,CAAC;AAED,SAAS,QAAQ,CAAC,KAAc;IAC9B,IAAI,KAAK,KAAK,IAAI;QAAE,OAAO,MAAM,CAAC;IAClC,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC;QAAE,OAAO,OAAO,CAAC;IACzC,OAAO,OAAO,KAAK,CAAC;AACtB,CAAC"}

package/package.json

@@ -0,0 +1,52 @@
+{
+  "name": "@dogsbay/plugin-ask",
+  "version": "0.2.0-beta.101",
+  "description": "Floating \"Ask AI\" widget for Dogsbay docs sites — calls a shared AI Search proxy (dogsbay-ask).",
+  "type": "module",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "default": "./dist/index.js"
+    },
+    "./client": "./dist/client.js",
+    "./styles.css": "./src/styles.css"
+  },
+  "files": [
+    "dist",
+    "src/styles.css",
+    "src/client.ts",
+    "src/RightRailAsk.astro",
+    "skills",
+    "README.md"
+  ],
+  "dependencies": {
+    "@dogsbay/types": "0.2.0-beta.101"
+  },
+  "devDependencies": {
+    "@types/node": "^22.20.1",
+    "typescript": "^5.9.3",
+    "vitest": "^4.1.10"
+  },
+  "license": "MIT",
+  "keywords": [
+    "dogsbay",
+    "dogsbay-plugin",
+    "documentation",
+    "ai-search",
+    "rag",
+    "ask-ai"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/dogsbay/dogsbay.git",
+    "directory": "packages/plugin-ask"
+  },
+  "scripts": {
+    "build": "tsc",
+    "test": "vitest run",
+    "test:watch": "vitest"
+  }
+}

package/skills/ask-config.md

@@ -0,0 +1,46 @@
+---
+name: plugin-ask-config
+description: Configure the @dogsbay/plugin-ask "Ask AI" widget — endpoint, site id, and presentation options — in dogsbay.config.yml. Use when adding or debugging the Ask AI button on a Dogsbay docs site.
+---
+
+# Configuring @dogsbay/plugin-ask
+
+`@dogsbay/plugin-ask` adds a floating "Ask AI" button to every page. It sends
+the question to a configured backend and shows the answer, so the docs site
+stays static and holds no secrets.
+
+## Enable it
+
+```yaml
+# dogsbay.config.yml
+plugins:
+  - name: "@dogsbay/plugin-ask"
+    options:
+      endpoint: "https://<your-ask-endpoint>"
+      site: "openshift-docs-dogsbay"
+```
+
+- **`endpoint`** (required) — URL of the backend the widget calls.
+- **`site`** (required) — the site id sent with each request so the backend
+  knows which corpus to answer from. Conventionally the site's base path /
+  GitHub Pages subfolder, e.g. `tigera-dogsbay`. The team operating the backend
+  owns the `site` → corpus mapping; use the value they give you.
+
+Optional presentation: `mode` (`answer` | `search`), `buttonLabel`, `title`,
+`placeholder`, `position` (`bottom-right` | `bottom-left`).
+
+## When it isn't working
+
+1. **Button not appearing** — confirm the plugin is listed under `plugins:` and
+   that `dogsbay site build` ran; the widget mounts via a client module on every
+   page.
+2. **Errors when asking** — confirm `endpoint` is reachable from the browser and
+   that `site` matches the value the backend expects.
+3. **Empty or "I don't know" answers** — the backend's corpus may not be ready;
+   check with whoever operates the endpoint.
+
+## Styling
+
+Styles use Dogsbay theme tokens (`--color-accent`, `--color-surface`,
+`--radius`, …) with fallbacks, so the widget picks up the site theme. Override
+the `.dba-*` classes in your own CSS to customize further.

package/src/RightRailAsk.astro

@@ -0,0 +1,66 @@
+---
+/**
+ * Docked "Ask AI" panel shell — rendered into DocsLayout's `right-rail` named
+ * slot via the plugin's `componentWrappers()` hook (slot "RightRail").
+ *
+ * This is the SERVER-RENDERED structure only; behaviour (open, submit, stream,
+ * Turnstile) is wired by the client module (`client.ts`), which finds this shell
+ * by `[data-dba-panel="rail"]`. Presentational config comes from the same
+ * generated module the client uses, resolvable in SSR via the CLI's Vite alias.
+ *
+ * Must render `<slot />` to satisfy the wrapper contract (the inner slot is
+ * empty — this is an additive panel, not a content wrapper). Being a real
+ * element child also keeps DocsLayout's empty-rail rule
+ * (`aside[data-right-rail]:not(:has(*))`) from hiding the rail.
+ */
+// @ts-expect-error: virtual module resolved by the Dogsbay Vite alias at build.
+import config from "virtual:dogsbay-plugin-config/@dogsbay/plugin-ask";
+
+interface RailConfig {
+  title: string;
+  placeholder: string;
+  conversational?: boolean;
+  persistConversation?: boolean;
+  turnstileSitekey?: string;
+}
+const cfg = config as RailConfig;
+---
+
+<section class="dba-panel" data-dba-panel="rail" aria-label={cfg.title}>
+  <form class="dba-form" data-dba-form>
+    <header class="dba-header">
+      <h2 class="dba-title">{cfg.title}</h2>
+      {cfg.conversational !== false && (
+        <button type="button" class="dba-newchat" data-dba-newchat>New chat</button>
+      )}
+    </header>
+    {cfg.conversational !== false && cfg.persistConversation !== false && (
+      <label class="dba-remember">
+        <input type="checkbox" data-dba-remember />
+        Remember conversation
+      </label>
+    )}
+    <div class="dba-thread" data-dba-thread></div>
+    <div class="dba-inputrow">
+      <input
+        class="dba-input"
+        type="text"
+        autocomplete="off"
+        enterkeyhint="search"
+        placeholder={cfg.placeholder}
+      />
+      <button type="submit" class="dba-submit">Ask</button>
+    </div>
+    {cfg.turnstileSitekey && (
+      <div
+        class="cf-turnstile dba-turnstile"
+        data-sitekey={cfg.turnstileSitekey}
+        data-appearance="interaction-only"
+        data-callback="__dbaTsCb"
+        data-expired-callback="__dbaTsExpired"
+        data-error-callback="__dbaTsExpired"
+      />
+    )}
+  </form>
+</section>
+<slot />