@gui-chat-plugin/scroll-to-anchor 0.1.0

package/README.md

@@ -0,0 +1,66 @@
+# @gui-chat-plugin/scroll-to-anchor
+
+[![npm version](https://badge.fury.io/js/%40gui-chat-plugin%2Fscroll-to-anchor.svg)](https://www.npmjs.com/package/@gui-chat-plugin/scroll-to-anchor)
+
+A scroll-to-anchor plugin for [MulmoChat](https://github.com/receptron/MulmoChat).
+
+## Overview
+
+This plugin allows the AI to scroll the view to a specific tool result by its anchor ID. Useful for navigating between multiple results in a conversation.
+
+## Installation
+
+```bash
+yarn add @gui-chat-plugin/scroll-to-anchor
+```
+
+## Usage
+
+### Vue Implementation (for MulmoChat)
+
+```typescript
+// In src/tools/index.ts
+import ScrollToAnchorPlugin from "@gui-chat-plugin/scroll-to-anchor/vue";
+
+const pluginList = [
+  // ... other plugins
+  ScrollToAnchorPlugin,
+];
+
+// In src/main.ts
+import "@gui-chat-plugin/scroll-to-anchor/style.css";
+```
+
+### Core Only (Framework-agnostic)
+
+```typescript
+import { pluginCore, TOOL_NAME } from "@gui-chat-plugin/scroll-to-anchor";
+```
+
+## Package Exports
+
+| Export | Description |
+|--------|-------------|
+| `@gui-chat-plugin/scroll-to-anchor` | Core (framework-agnostic) |
+| `@gui-chat-plugin/scroll-to-anchor/vue` | Vue implementation |
+| `@gui-chat-plugin/scroll-to-anchor/style.css` | Tailwind CSS styles |
+
+## Test Prompts
+
+1. "Show me the previous image" (after generating multiple images)
+2. "Go back to the first result"
+3. "Scroll to the quiz"
+
+## Development
+
+```bash
+yarn install
+yarn dev        # Start dev server
+yarn build      # Build
+yarn typecheck  # Type check
+yarn lint       # Lint
+```
+
+## License
+
+MIT

package/dist/core/definition.d.ts

@@ -0,0 +1,7 @@
+/**
+ * ScrollToAnchor Tool Definition (Schema)
+ */
+import type { ToolDefinition } from "gui-chat-protocol";
+export declare const TOOL_NAME = "scrollToAnchor";
+export declare const TOOL_DEFINITION: ToolDefinition;
+export declare const SYSTEM_PROMPT = "Use the scrollToAnchor API to scroll the document view to a specific anchor when the user asks to read a specific step or navigate to a section. For example, when the user says \"read step 3\" or \"what's next?\", call this function with the appropriate anchor ID (e.g., \"step-3\") BEFORE or AFTER reading the step aloud.";

package/dist/core/index.d.ts

@@ -0,0 +1,5 @@
+/**
+ * ScrollToAnchor Plugin - Core (Framework-agnostic)
+ */
+export type { ScrollToAnchorArgs } from "./types";
+export { TOOL_NAME, TOOL_DEFINITION, SYSTEM_PROMPT, executeScrollToAnchor, pluginCore, } from "./plugin";

package/dist/core/plugin.d.ts

@@ -0,0 +1,12 @@
+/**
+ * ScrollToAnchor Plugin Core (Framework-agnostic)
+ */
+import type { ToolPluginCore, ToolContext, ToolResult } from "gui-chat-protocol";
+import type { ScrollToAnchorArgs } from "./types";
+export { TOOL_NAME, TOOL_DEFINITION, SYSTEM_PROMPT } from "./definition";
+/**
+ * Execute the scrollToAnchor function
+ * Updates the current result's viewState to trigger scrolling in the document
+ */
+export declare const executeScrollToAnchor: (context: ToolContext, args: ScrollToAnchorArgs) => Promise<ToolResult>;
+export declare const pluginCore: ToolPluginCore<unknown, unknown, ScrollToAnchorArgs>;

package/dist/core/types.d.ts

@@ -0,0 +1,7 @@
+/**
+ * ScrollToAnchor Plugin Types
+ */
+/** Arguments passed to the scrollToAnchor tool */
+export interface ScrollToAnchorArgs {
+    anchorId: string;
+}

package/dist/core.cjs

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const t="scrollToAnchor",r={type:"function",name:t,description:"Scroll the current document view to a specific anchor tag. Use this when reading recipe steps aloud or navigating to specific sections.",parameters:{type:"object",properties:{anchorId:{type:"string",description:'The ID of the anchor tag to scroll to (e.g., "step-1", "step-2"). Should match the anchor IDs in the document.'}},required:["anchorId"]}},s=`Use the ${t} API to scroll the document view to a specific anchor when the user asks to read a specific step or navigate to a section. For example, when the user says "read step 3" or "what's next?", call this function with the appropriate anchor ID (e.g., "step-3") BEFORE or AFTER reading the step aloud.`,n=async(e,c)=>{const{anchorId:o}=c;return e.currentResult?{...e.currentResult,message:`Scrolled to ${o}`,updating:!0,viewState:{...e.currentResult.viewState,scrollToAnchor:o,scrollTimestamp:Date.now()},instructions:"Read the step aloud.",instructionsRequired:!0}:{message:"No document is currently displayed to scroll.",updating:!1}},i={toolDefinition:r,execute:n,generatingMessage:"Scrolling to section...",isEnabled:()=>!0,systemPrompt:s};exports.SYSTEM_PROMPT=s;exports.TOOL_DEFINITION=r;exports.TOOL_NAME=t;exports.executeScrollToAnchor=n;exports.pluginCore=i;

package/dist/core.js

@@ -0,0 +1,47 @@
+const o = "scrollToAnchor", s = {
+  type: "function",
+  name: o,
+  description: "Scroll the current document view to a specific anchor tag. Use this when reading recipe steps aloud or navigating to specific sections.",
+  parameters: {
+    type: "object",
+    properties: {
+      anchorId: {
+        type: "string",
+        description: 'The ID of the anchor tag to scroll to (e.g., "step-1", "step-2"). Should match the anchor IDs in the document.'
+      }
+    },
+    required: ["anchorId"]
+  }
+}, n = `Use the ${o} API to scroll the document view to a specific anchor when the user asks to read a specific step or navigate to a section. For example, when the user says "read step 3" or "what's next?", call this function with the appropriate anchor ID (e.g., "step-3") BEFORE or AFTER reading the step aloud.`, c = async (e, r) => {
+  const { anchorId: t } = r;
+  return e.currentResult ? {
+    ...e.currentResult,
+    message: `Scrolled to ${t}`,
+    updating: !0,
+    // This will update the existing result instead of creating a new one
+    viewState: {
+      ...e.currentResult.viewState,
+      scrollToAnchor: t,
+      scrollTimestamp: Date.now()
+      // Add timestamp to ensure reactivity even with same anchor
+    },
+    instructions: "Read the step aloud.",
+    instructionsRequired: !0
+  } : {
+    message: "No document is currently displayed to scroll.",
+    updating: !1
+  };
+}, i = {
+  toolDefinition: s,
+  execute: c,
+  generatingMessage: "Scrolling to section...",
+  isEnabled: () => !0,
+  systemPrompt: n
+};
+export {
+  n as SYSTEM_PROMPT,
+  s as TOOL_DEFINITION,
+  o as TOOL_NAME,
+  c as executeScrollToAnchor,
+  i as pluginCore
+};

package/dist/index.cjs

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const e=require("./core.cjs");exports.SYSTEM_PROMPT=e.SYSTEM_PROMPT;exports.TOOL_DEFINITION=e.TOOL_DEFINITION;exports.TOOL_NAME=e.TOOL_NAME;exports.executeScrollToAnchor=e.executeScrollToAnchor;exports.pluginCore=e.pluginCore;

package/dist/index.d.ts

@@ -0,0 +1,6 @@
+/**
+ * ScrollToAnchor Plugin
+ *
+ * Main entry point - re-exports core module.
+ */
+export * from "./core";

package/dist/index.js

@@ -0,0 +1,8 @@
+import { SYSTEM_PROMPT as T, TOOL_DEFINITION as e, TOOL_NAME as r, executeScrollToAnchor as c, pluginCore as l } from "./core.js";
+export {
+  T as SYSTEM_PROMPT,
+  e as TOOL_DEFINITION,
+  r as TOOL_NAME,
+  c as executeScrollToAnchor,
+  l as pluginCore
+};

package/dist/style.css

@@ -0,0 +1 @@
+@layer properties{@supports (((-webkit-hyphens:none)) and (not (margin-trim:inline))) or ((-moz-orient:inline) and (not (color:rgb(from red r g b)))){*,:before,:after,::backdrop{--tw-space-y-reverse:0;--tw-border-style:solid;--tw-font-weight:initial;--tw-shadow:0 0 #0000;--tw-shadow-color:initial;--tw-shadow-alpha:100%;--tw-inset-shadow:0 0 #0000;--tw-inset-shadow-color:initial;--tw-inset-shadow-alpha:100%;--tw-ring-color:initial;--tw-ring-shadow:0 0 #0000;--tw-inset-ring-color:initial;--tw-inset-ring-shadow:0 0 #0000;--tw-ring-inset:initial;--tw-ring-offset-width:0px;--tw-ring-offset-color:#fff;--tw-ring-offset-shadow:0 0 #0000}}}@layer theme{:root,:host{--font-sans:ui-sans-serif,system-ui,sans-serif,"Apple Color Emoji","Segoe UI Emoji","Segoe UI Symbol","Noto Color Emoji";--font-mono:ui-monospace,SFMono-Regular,Menlo,Monaco,Consolas,"Liberation Mono","Courier New",monospace;--color-yellow-50:oklch(98.7% .026 102.212);--color-yellow-200:oklch(94.5% .129 101.54);--color-yellow-700:oklch(55.4% .135 66.442);--color-yellow-800:oklch(47.6% .114 61.907);--color-indigo-600:oklch(51.1% .262 276.966);--color-indigo-700:oklch(45.7% .24 277.023);--color-gray-100:oklch(96.7% .003 264.542);--color-gray-300:oklch(87.2% .01 258.338);--color-gray-600:oklch(44.6% .03 256.802);--color-gray-800:oklch(27.8% .033 256.848);--color-white:#fff;--spacing:.25rem;--container-3xl:48rem;--text-xs:.75rem;--text-xs--line-height:calc(1/.75);--text-sm:.875rem;--text-sm--line-height:calc(1.25/.875);--text-lg:1.125rem;--text-lg--line-height:calc(1.75/1.125);--text-xl:1.25rem;--text-xl--line-height:calc(1.75/1.25);--text-2xl:1.5rem;--text-2xl--line-height:calc(2/1.5);--font-weight-bold:700;--radius-lg:.5rem;--default-font-family:var(--font-sans);--default-mono-font-family:var(--font-mono)}}@layer base{*,:after,:before,::backdrop{box-sizing:border-box;border:0 solid;margin:0;padding:0}::file-selector-button{box-sizing:border-box;border:0 solid;margin:0;padding:0}html,:host{-webkit-text-size-adjust:100%;tab-size:4;line-height:1.5;font-family:var(--default-font-family,ui-sans-serif,system-ui,sans-serif,"Apple Color Emoji","Segoe UI Emoji","Segoe UI Symbol","Noto Color Emoji");font-feature-settings:var(--default-font-feature-settings,normal);font-variation-settings:var(--default-font-variation-settings,normal);-webkit-tap-highlight-color:transparent}hr{height:0;color:inherit;border-top-width:1px}abbr:where([title]){-webkit-text-decoration:underline dotted;text-decoration:underline dotted}h1,h2,h3,h4,h5,h6{font-size:inherit;font-weight:inherit}a{color:inherit;-webkit-text-decoration:inherit;text-decoration:inherit}b,strong{font-weight:bolder}code,kbd,samp,pre{font-family:var(--default-mono-font-family,ui-monospace,SFMono-Regular,Menlo,Monaco,Consolas,"Liberation Mono","Courier New",monospace);font-feature-settings:var(--default-mono-font-feature-settings,normal);font-variation-settings:var(--default-mono-font-variation-settings,normal);font-size:1em}small{font-size:80%}sub,sup{vertical-align:baseline;font-size:75%;line-height:0;position:relative}sub{bottom:-.25em}sup{top:-.5em}table{text-indent:0;border-color:inherit;border-collapse:collapse}:-moz-focusring{outline:auto}progress{vertical-align:baseline}summary{display:list-item}ol,ul,menu{list-style:none}img,svg,video,canvas,audio,iframe,embed,object{vertical-align:middle;display:block}img,video{max-width:100%;height:auto}button,input,select,optgroup,textarea{font:inherit;font-feature-settings:inherit;font-variation-settings:inherit;letter-spacing:inherit;color:inherit;opacity:1;background-color:#0000;border-radius:0}::file-selector-button{font:inherit;font-feature-settings:inherit;font-variation-settings:inherit;letter-spacing:inherit;color:inherit;opacity:1;background-color:#0000;border-radius:0}:where(select:is([multiple],[size])) optgroup{font-weight:bolder}:where(select:is([multiple],[size])) optgroup option{padding-inline-start:20px}::file-selector-button{margin-inline-end:4px}::placeholder{opacity:1}@supports (not ((-webkit-appearance:-apple-pay-button))) or (contain-intrinsic-size:1px){::placeholder{color:currentColor}@supports (color:color-mix(in lab,red,red)){::placeholder{color:color-mix(in oklab,currentcolor 50%,transparent)}}}textarea{resize:vertical}::-webkit-search-decoration{-webkit-appearance:none}::-webkit-date-and-time-value{min-height:1lh;text-align:inherit}::-webkit-datetime-edit{display:inline-flex}::-webkit-datetime-edit-fields-wrapper{padding:0}::-webkit-datetime-edit{padding-block:0}::-webkit-datetime-edit-year-field{padding-block:0}::-webkit-datetime-edit-month-field{padding-block:0}::-webkit-datetime-edit-day-field{padding-block:0}::-webkit-datetime-edit-hour-field{padding-block:0}::-webkit-datetime-edit-minute-field{padding-block:0}::-webkit-datetime-edit-second-field{padding-block:0}::-webkit-datetime-edit-millisecond-field{padding-block:0}::-webkit-datetime-edit-meridiem-field{padding-block:0}::-webkit-calendar-picker-indicator{line-height:1}:-moz-ui-invalid{box-shadow:none}button,input:where([type=button],[type=reset],[type=submit]){appearance:button}::file-selector-button{appearance:button}::-webkit-inner-spin-button{height:auto}::-webkit-outer-spin-button{height:auto}[hidden]:where(:not([hidden=until-found])){display:none!important}}@layer components;@layer utilities{.mx-auto{margin-inline:auto}.mt-4{margin-top:calc(var(--spacing)*4)}.mb-2{margin-bottom:calc(var(--spacing)*2)}.mb-4{margin-bottom:calc(var(--spacing)*4)}.mb-5{margin-bottom:calc(var(--spacing)*5)}.mb-8{margin-bottom:calc(var(--spacing)*8)}.contents{display:contents}.flex{display:flex}.max-w-3xl{max-width:var(--container-3xl)}.flex-1{flex:1}.gap-2{gap:calc(var(--spacing)*2)}:where(.space-y-2>:not(:last-child)){--tw-space-y-reverse:0;margin-block-start:calc(calc(var(--spacing)*2)*var(--tw-space-y-reverse));margin-block-end:calc(calc(var(--spacing)*2)*calc(1 - var(--tw-space-y-reverse)))}.overflow-auto{overflow:auto}.rounded{border-radius:.25rem}.rounded-lg{border-radius:var(--radius-lg)}.border{border-style:var(--tw-border-style);border-width:1px}.border-gray-300{border-color:var(--color-gray-300)}.border-yellow-200{border-color:var(--color-yellow-200)}.bg-gray-100{background-color:var(--color-gray-100)}.bg-indigo-600{background-color:var(--color-indigo-600)}.bg-white{background-color:var(--color-white)}.bg-yellow-50{background-color:var(--color-yellow-50)}.p-3{padding:calc(var(--spacing)*3)}.p-5{padding:calc(var(--spacing)*5)}.p-8{padding:calc(var(--spacing)*8)}.px-3{padding-inline:calc(var(--spacing)*3)}.px-4{padding-inline:calc(var(--spacing)*4)}.py-2{padding-block:calc(var(--spacing)*2)}.text-2xl{font-size:var(--text-2xl);line-height:var(--tw-leading,var(--text-2xl--line-height))}.text-lg{font-size:var(--text-lg);line-height:var(--tw-leading,var(--text-lg--line-height))}.text-sm{font-size:var(--text-sm);line-height:var(--tw-leading,var(--text-sm--line-height))}.text-xl{font-size:var(--text-xl);line-height:var(--tw-leading,var(--text-xl--line-height))}.text-xs{font-size:var(--text-xs);line-height:var(--tw-leading,var(--text-xs--line-height))}.font-bold{--tw-font-weight:var(--font-weight-bold);font-weight:var(--font-weight-bold)}.text-gray-600{color:var(--color-gray-600)}.text-gray-800{color:var(--color-gray-800)}.text-white{color:var(--color-white)}.text-yellow-700{color:var(--color-yellow-700)}.text-yellow-800{color:var(--color-yellow-800)}.shadow-md{--tw-shadow:0 4px 6px -1px var(--tw-shadow-color,#0000001a),0 2px 4px -2px var(--tw-shadow-color,#0000001a);box-shadow:var(--tw-inset-shadow),var(--tw-inset-ring-shadow),var(--tw-ring-offset-shadow),var(--tw-ring-shadow),var(--tw-shadow)}@media(hover:hover){.hover\:bg-indigo-700:hover{background-color:var(--color-indigo-700)}}}body{margin:calc(var(--spacing)*0);background-color:var(--color-gray-100);padding:calc(var(--spacing)*5);font-family:var(--font-sans)}@property --tw-space-y-reverse{syntax:"*";inherits:false;initial-value:0}@property --tw-border-style{syntax:"*";inherits:false;initial-value:solid}@property --tw-font-weight{syntax:"*";inherits:false}@property --tw-shadow{syntax:"*";inherits:false;initial-value:0 0 #0000}@property --tw-shadow-color{syntax:"*";inherits:false}@property --tw-shadow-alpha{syntax:"<percentage>";inherits:false;initial-value:100%}@property --tw-inset-shadow{syntax:"*";inherits:false;initial-value:0 0 #0000}@property --tw-inset-shadow-color{syntax:"*";inherits:false}@property --tw-inset-shadow-alpha{syntax:"<percentage>";inherits:false;initial-value:100%}@property --tw-ring-color{syntax:"*";inherits:false}@property --tw-ring-shadow{syntax:"*";inherits:false;initial-value:0 0 #0000}@property --tw-inset-ring-color{syntax:"*";inherits:false}@property --tw-inset-ring-shadow{syntax:"*";inherits:false;initial-value:0 0 #0000}@property --tw-ring-inset{syntax:"*";inherits:false}@property --tw-ring-offset-width{syntax:"<length>";inherits:false;initial-value:0}@property --tw-ring-offset-color{syntax:"*";inherits:false;initial-value:#fff}@property --tw-ring-offset-shadow{syntax:"*";inherits:false;initial-value:0 0 #0000}

package/dist/vue/index.d.ts

@@ -0,0 +1,16 @@
+/**
+ * ScrollToAnchor Plugin - Vue Implementation
+ *
+ * Note: This plugin has no View or Preview components
+ * It only updates the viewState of the current result to trigger scrolling
+ */
+import "../style.css";
+import type { ToolPlugin } from "gui-chat-protocol/vue";
+import type { ScrollToAnchorArgs } from "../core/types";
+export declare const plugin: ToolPlugin<unknown, unknown, ScrollToAnchorArgs>;
+export type { ScrollToAnchorArgs } from "../core/types";
+export { TOOL_NAME, TOOL_DEFINITION, SYSTEM_PROMPT, executeScrollToAnchor, pluginCore, } from "../core/plugin";
+declare const _default: {
+    plugin: ToolPlugin<unknown, unknown, ScrollToAnchorArgs, import("gui-chat-protocol/vue").InputHandler, Record<string, unknown>>;
+};
+export default _default;

package/dist/vue.cjs

@@ -0,0 +1 @@
+"use strict";Object.defineProperties(exports,{__esModule:{value:!0},[Symbol.toStringTag]:{value:"Module"}});const e=require("./core.cjs"),o={...e.pluginCore},l={plugin:o};exports.SYSTEM_PROMPT=e.SYSTEM_PROMPT;exports.TOOL_DEFINITION=e.TOOL_DEFINITION;exports.TOOL_NAME=e.TOOL_NAME;exports.executeScrollToAnchor=e.executeScrollToAnchor;exports.pluginCore=e.pluginCore;exports.default=l;exports.plugin=o;

package/dist/vue.js

@@ -0,0 +1,15 @@
+import { pluginCore as o } from "./core.js";
+import { SYSTEM_PROMPT as T, TOOL_DEFINITION as c, TOOL_NAME as l, executeScrollToAnchor as p } from "./core.js";
+const e = {
+  ...o
+  // No viewComponent or previewComponent - this plugin updates existing results
+}, t = { plugin: e };
+export {
+  T as SYSTEM_PROMPT,
+  c as TOOL_DEFINITION,
+  l as TOOL_NAME,
+  t as default,
+  p as executeScrollToAnchor,
+  e as plugin,
+  o as pluginCore
+};

package/package.json

@@ -0,0 +1,63 @@
+{
+  "name": "@gui-chat-plugin/scroll-to-anchor",
+  "version": "0.1.0",
+  "description": "Scroll to anchor plugin for GUIChat",
+  "type": "module",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    },
+    "./core": {
+      "types": "./dist/core/index.d.ts",
+      "import": "./dist/core.js",
+      "require": "./dist/core.cjs"
+    },
+    "./vue": {
+      "types": "./dist/vue/index.d.ts",
+      "import": "./dist/vue.js",
+      "require": "./dist/vue.cjs"
+    },
+    "./style.css": "./dist/style.css"
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "dev": "vite",
+    "build": "vite build && vue-tsc -p tsconfig.build.json --emitDeclarationOnly",
+    "typecheck": "vue-tsc --noEmit",
+    "lint": "eslint src demo"
+  },
+  "peerDependencies": {
+    "gui-chat-protocol": "^0.0.1",
+    "vue": "^3.5.0"
+  },
+  "devDependencies": {
+    "@tailwindcss/vite": "^4.1.18",
+    "@typescript-eslint/eslint-plugin": "^8.53.0",
+    "@typescript-eslint/parser": "^8.53.0",
+    "@vitejs/plugin-vue": "^6.0.3",
+    "eslint": "^9.39.2",
+    "eslint-plugin-vue": "^10.6.2",
+    "globals": "^17.0.0",
+    "gui-chat-protocol": "^0.0.1",
+    "tailwindcss": "^4.1.18",
+    "typescript": "~5.9.3",
+    "vite": "^7.3.1",
+    "vue": "^3.5.27",
+    "vue-eslint-parser": "^10.2.0",
+    "vue-tsc": "^3.2.2"
+  },
+  "keywords": [
+    "guichat",
+    "plugin",
+    "scroll",
+    "anchor"
+  ],
+  "license": "MIT"
+}