@ubiquity-os/plugin-sdk 3.6.0 → 3.6.2

package/README.md

@@ -17,117 +17,42 @@ The `createActionsPlugin` function allows users to create plugins that will be a
 
 The `createPlugin` function enables users to create a plugin that will run on Cloudflare Workers environment.
 
-### `callLlm`
-
-The `callLlm` function sends chat completion requests to `ai.ubq.fi` using the auth token and repository context supplied by the kernel.
-
 ### `postComment`
 
-The `postComment` function enables users to easily post a comment to an issue, a pull-request, or a pull request review thread.
-
-## Getting Started
-
-To set up the project locally, `bun` is the preferred package manager.
-
-1. Install the dependencies:
-
-   ```sh
-   bun install
-   ```
-
-2. Build the SDK
-   ```
-   bun sdk:build
-   ```
-3. Link it locally to another plugin
-   ```
-   bun link
-   ```
-
-## Scripts
-
-The project provides several npm scripts for various tasks:
-
-- `bun run sdk:build`: Compiles the TypeScript code.
-- `bun run test`: Runs the tests.
-- `bun run lint`: Runs the linter.
-- `bun run format`: Formats the code using Prettier.
-
-## Testing
-
-### Jest
-
-To start Jest tests, run:
-
-```sh
-bun run test
-```
-
-## LLM Utility
-
-```ts
-import { callLlm } from "@ubiquity-os/plugin-sdk";
-
-const result = await callLlm(
-  {
-    messages: [{ role: "user", content: "Summarize this issue." }],
-  },
-  context
-);
-```
-
-## Markdown Cleaning Utility
-
-`cleanMarkdown` removes top-level HTML comments and configured HTML tags while preserving content inside fenced/indented code blocks, inline code spans, and blockquotes.
-
-### Import
-
-```ts
-import { cleanMarkdown, type CleanMarkdownOptions } from "@ubiquity-os/plugin-sdk/markdown";
-```
-
-### Options (`CleanMarkdownOptions`)
-
-| Option               | Type                              | Default | Description                                                                                                                                                                                 |
-| -------------------- | --------------------------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `tags`               | `(keyof HTMLElementTagNameMap)[]` | `[]`    | List of HTML tag names to strip. Whole block tokens that are a single matching root element are removed entirely. Inline self-closing/void-like occurrences (e.g. `<br>`) are also removed. |
-| `collapseEmptyLines` | `boolean`                         | `false` | Collapses runs of 3+ blank lines down to exactly 2.                                                                                                                                         |
-
-### Behavior Summary
-
-- Strips HTML comments (`<!-- ... -->`) outside protected contexts:
-  - Not inside fenced/indented code blocks
-  - Not inside inline code spans
-  - Not inside blockquotes (blockquote content is left untouched)
-- Removes entire HTML block tokens consisting of a single root element whose tag is in `tags`.
-- Removes inline occurrences of any tag in `tags` (void/self-closing style).
-- Leaves everything else unchanged to minimize diff noise.
-- Final output is trimmed (no trailing blank lines).
-
-### Example
-
-```ts
-const input = `
-<!-- build badge -->
-<details>
-<summary>Info</summary>
-Content inside details
-</details>
-
-Paragraph with <br> line break and \`<br>\` in code.
-
-\`\`\`ts
-// Code block with <!-- comment --> and <br>
-const x = 1;
-\`\`\`
-
-> Blockquote with <!-- preserved comment --> and <br>.
-`;
+### `callLlm`
 
-const cleaned = cleanMarkdown(input, {
-  tags: ["details", "br"],
-  collapseEmptyLines: true,
+The `callLlm` function allows plugins to securely call the ai.ubq.fi LLM endpoint using inherited GitHub authentication.
+
+#### Usage
+
+```typescript
+import { PluginInput, createPlugin, callLlm } from '@ubiquity-os/plugin-sdk';
+
+export default createPlugin({
+  async onCommand(input: PluginInput) {
+    // Non-streaming: resolves to ChatCompletion.
+    const result = await callLlm(
+      {
+        messages: [{ role: 'user', content: 'Hello, world!' }]
+      },
+      input
+    );
+
+    // Streaming: returns AsyncIterable<ChatCompletionChunk>.
+    const stream = await callLlm(
+      {
+        messages: [{ role: 'user', content: 'Hello, world!' }],
+        stream: true
+      },
+      input
+    );
+    for await (const chunk of stream) {
+      const delta = chunk.choices?.[0]?.delta?.content ?? '';
+      // handle delta
+    }
+    return { success: true };
+  }
 });
-
-console.log(cleaned);
 ```
+
+Automatically extracts `authToken`, `owner`, `repo` from input and passes to ai.ubq.fi with proper headers for secure, repo-scoped access.

package/dist/configuration.d.mts

@@ -11,7 +11,7 @@ import './octokit.mjs';
 import '@octokit/core/types';
 import '@octokit/plugin-paginate-graphql';
 import '@octokit/plugin-paginate-rest';
-import '@octokit/webhooks/node_modules/@octokit/request-error';
+import '@octokit/request-error';
 import '@octokit/core';
 
 type GithubPlugin = {

package/dist/configuration.d.ts

@@ -11,7 +11,7 @@ import './octokit.js';
 import '@octokit/core/types';
 import '@octokit/plugin-paginate-graphql';
 import '@octokit/plugin-paginate-rest';
-import '@octokit/webhooks/node_modules/@octokit/request-error';
+import '@octokit/request-error';
 import '@octokit/core';
 
 type GithubPlugin = {