pipeup 0.8.0-beta.1 → 0.8.0-beta.3

package/dist/types/ui/thread-view.d.ts

@@ -1,10 +1,14 @@
-import type { Mention, Thread } from "../model/types";
+import type { Comment, Mention, Thread } from "../model/types";
 import { type Person } from "./mentions";
 import { type ReactionPicker } from "./reactions";
 export interface ThreadActions {
     /** This reviewer's key, to mark their own reactions. */
     readonly me: string;
     reply(parentId: string, text: string, mentions?: Mention[]): Promise<void>;
+    /** Changes the words of one of this reviewer's comments. */
+    edit(commentId: string, text: string, mentions?: Mention[]): Promise<void>;
+    /** Deletes one of this reviewer's comments. */
+    remove(commentId: string): Promise<void>;
     /** Who can be mentioned with `@` in a reply. */
     people(): Person[];
     /** Gives (`on`) or takes back this reviewer's reaction to a comment. */
@@ -16,31 +20,38 @@ export interface ThreadActions {
     /** "Still not right" on an addressed thread: reopens it and puts the cursor in its reply line. */
     notRight(threadId: string): Promise<void>;
     copy(threadId: string): void;
-    /** Esc in the reply line: closes the thread. */
+    /** Cancel or Esc threw away the words in thread `threadId`'s reply line: offers them back. */
+    drop(threadId: string, words: string): void;
+    /** Esc in an empty reply line: closes the thread. */
     close(): void;
 }
 export interface ThreadViewOptions {
-    variant: "column" | "popover";
+    /** `card`: a closed card in All comments, only its first comment: words cut to two lines, no replies or reply box. */
+    variant: "column" | "popover" | "card";
     quote?: string | null;
     /** Snapshot of content that can't be shown: gone from the page, or somewhere it couldn't be reached. */
     lost?: string | null;
     /** Where that content is, when it isn't gone ("On slide 3"); default "No longer on the page". */
     place?: string | null;
+    /** Its content was found changed or nearby: flagged Moved, with what it was about, for someone to confirm. */
+    moved?: boolean;
+    /** A card's line about what it's on, as written (in place of the quote). */
+    note?: string | null;
+    /** A card's quiet last line (its replies and reactions), as written. */
+    rest?: string | null;
     now?: () => number;
 }
 export declare const plural: (n: number) => string;
+/** A thread's replies that haven't been deleted: a deleted comment goes away. */
+export declare const replies: (t: Thread) => Comment[];
 export interface ThreadView {
     readonly element: HTMLElement;
     /** Shows a newer copy of the thread. The reply line is kept, so what's being typed in it (and focus) survives. */
-    update(t: Thread, o?: {
-        quote?: string | null;
-        lost?: string | null;
-        place?: string | null;
-    }): void;
+    update(t: Thread, o?: Partial<ThreadViewOptions>): void;
 }
 /**
- * One thread: the words first; who, when and actions ease open beneath them on hover (always shown in a popover,
- * so its height never changes under the pointer). Replies sit one level
- * in beneath the comment, oldest first, and the thread ends with its reply line at the same indent.
+ * One thread, as a compact card: who and how long ago, then the words; its actions sit at the top right (on hover,
+ * and always when open). Replies sit one level in beneath the comment, oldest first, and the thread ends with its
+ * reply box at the same indent.
  */
 export declare function threadView(first: Thread, actions: ThreadActions, options: ThreadViewOptions): ThreadView;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pipeup",
-  "version": "0.8.0-beta.1",
+  "version": "0.8.0-beta.3",
   "description": "Comments and feedback right on any HTML page: documents, slide decks and whole sites.",
   "keywords": [
     "comments",

package/skills/pipeup-add/SKILL.md

@@ -5,7 +5,7 @@ description: Use when someone asks you to add comments to an HTML page, make it
 
 # Add Pipeup to this page
 
-Written for Pipeup 0.8.0-beta.1 This skill is published at https://pipeup-ai.github.io/pipeup/skills/pipeup-add/SKILL.md. Its companions: [integrate](https://pipeup-ai.github.io/pipeup/skills/pipeup-integrate/SKILL.md) (the full reference: layouts, decks, tabs, every option), [apply](https://pipeup-ai.github.io/pipeup/skills/pipeup-apply/SKILL.md) (answering the comments) and [summarise](https://pipeup-ai.github.io/pipeup/skills/pipeup-summarise/SKILL.md).
+Written for Pipeup 0.8.0-beta.3 This skill is published at https://pipeup-ai.github.io/pipeup/skills/pipeup-add/SKILL.md. Its companions: [integrate](https://pipeup-ai.github.io/pipeup/skills/pipeup-integrate/SKILL.md) (the full reference: layouts, decks, tabs, every option), [apply](https://pipeup-ai.github.io/pipeup/skills/pipeup-apply/SKILL.md) (answering the comments) and [summarise](https://pipeup-ai.github.io/pipeup/skills/pipeup-summarise/SKILL.md).
 
 Pipeup lets people comment on an HTML page in place. **When the page already exists, never change its layout, styling or behaviour to make room for Pipeup**: it draws in its own layer, and you only add attributes and one script tag. Edit the HTML file only; don't download, fetch or run anything yourself.
 
@@ -14,7 +14,7 @@ Pipeup lets people comment on an HTML page in place. **When the page already exi
 1. **Pin the script.** Just before `</body>`:
 
    ```html
-   <script src="https://cdn.jsdelivr.net/npm/pipeup@0.8.0-beta.1/dist/pipeup.min.js"
+   <script src="https://cdn.jsdelivr.net/npm/pipeup@0.8.0-beta.3/dist/pipeup.min.js"
            integrity="sha384-…" crossorigin="anonymous"></script>
    ```
 
@@ -49,5 +49,5 @@ When you rewrite or regenerate a page, keep `data-pipeup-doc`, `data-pipeup-shar
 ## Tell the author
 
 What you added (one script, a few attributes), how to comment (**⇧⌥C** on a Mac, **Shift+Alt+C** elsewhere, or the round
-button), how comments come back (**Copy as Markdown**, or, with the agents add-on, **Copy a prompt for my agent**), and that nothing leaves their
+button), how comments come back (**Copy comments › As Markdown**, or, with the agents add-on, **Copy a prompt for my agent**), and that nothing leaves their
 browser unless they choose it.

package/skills/pipeup-apply/SKILL.md

@@ -5,7 +5,7 @@ description: Use when someone asks you to act on Pipeup feedback for an HTML pag
 
 # Apply Pipeup feedback
 
-Written for Pipeup 0.8.0-beta.1 This skill is published at https://pipeup-ai.github.io/pipeup/skills/pipeup-apply/SKILL.md. Its companions: [integrate](https://pipeup-ai.github.io/pipeup/skills/pipeup-integrate/SKILL.md), [summarise](https://pipeup-ai.github.io/pipeup/skills/pipeup-summarise/SKILL.md).
+Written for Pipeup 0.8.0-beta.3 This skill is published at https://pipeup-ai.github.io/pipeup/skills/pipeup-apply/SKILL.md. Its companions: [integrate](https://pipeup-ai.github.io/pipeup/skills/pipeup-integrate/SKILL.md), [summarise](https://pipeup-ai.github.io/pipeup/skills/pipeup-summarise/SKILL.md).
 
 ## 1. Read the comments
 
@@ -19,7 +19,7 @@ Use the first of these that works:
    `await Pipeup.comments()`. It returns `{ markdown, threads }`: `markdown` is the same text as **Copy as
    Markdown**, and `threads` is the same threads as data (`id`, `state`, `where`, `element`, `quote`, and each
    comment with `by`, `agent` and `text`). Pass `{ all: true }` to include resolved threads.
-2. **The pasted Markdown**: the author clicks **Copy as Markdown** (or, on a page with the agents add-on, **Copy a prompt for my agent**) and pastes it.
+2. **The pasted Markdown**: the author clicks **Copy comments › As Markdown** (or, on a page with the agents add-on, **Copy a prompt for my agent**) and pastes it.
 
 Each thread has a `- **Thread:** <id>` line: you need it to answer the thread.
 

package/skills/pipeup-integrate/SKILL.md

@@ -5,7 +5,7 @@ description: Use when creating or editing an HTML document, slide deck, report,
 
 # Add Pipeup to a page: the full reference
 
-Written for Pipeup 0.8.0-beta.1 For a quick "add comments to this page", [pipeup-add](https://pipeup-ai.github.io/pipeup/skills/pipeup-add/SKILL.md) is the short version; this is the full reference. This skill is published at https://pipeup-ai.github.io/pipeup/skills/pipeup-integrate/SKILL.md. Its companions: [summarise](https://pipeup-ai.github.io/pipeup/skills/pipeup-summarise/SKILL.md), [apply](https://pipeup-ai.github.io/pipeup/skills/pipeup-apply/SKILL.md).
+Written for Pipeup 0.8.0-beta.3 For a quick "add comments to this page", [pipeup-add](https://pipeup-ai.github.io/pipeup/skills/pipeup-add/SKILL.md) is the short version; this is the full reference. This skill is published at https://pipeup-ai.github.io/pipeup/skills/pipeup-integrate/SKILL.md. Its companions: [summarise](https://pipeup-ai.github.io/pipeup/skills/pipeup-summarise/SKILL.md), [apply](https://pipeup-ai.github.io/pipeup/skills/pipeup-apply/SKILL.md).
 
 Pipeup lets people comment on an HTML page in place: select text, click any element (including
 buttons and charts) or drop a pin on a slide. Your job is to make the page *reviewable* while it
@@ -75,7 +75,7 @@ Then choose the options (see "Options" below): usually just the defaults.
    - Just before `</body>`, add the script pinned to an exact version:
 
      ```html
-     <script src="https://cdn.jsdelivr.net/npm/pipeup@0.8.0-beta.1/dist/pipeup.min.js"
+     <script src="https://cdn.jsdelivr.net/npm/pipeup@0.8.0-beta.3/dist/pipeup.min.js"
              integrity="sha384-…" crossorigin="anonymous"></script>
      ```
 
@@ -157,7 +157,7 @@ Then choose the options (see "Options" below): usually just the defaults.
 - Don't wrap content in new elements or add classes for Pipeup.
 - Don't add inline styles, z-index changes or padding "for the comment column".
 - Don't load the script from anywhere but the pinned CDN URL
-  (`https://cdn.jsdelivr.net/npm/pipeup@0.8.0-beta.1/dist/pipeup.min.js`, with the `integrity` value from
+  (`https://cdn.jsdelivr.net/npm/pipeup@0.8.0-beta.3/dist/pipeup.min.js`, with the `integrity` value from
   the release notes) or a copy of that same file next to the page. Never use an unpinned URL.
 - Don't put secrets in `data-pipeup-doc`; it *is* the document's key — anyone with the file can
   read its feedback, which is the intended audience.
@@ -175,7 +175,7 @@ page opened from disk and in any script order, and they are released with Pipeup
 
 - **Ask first, and say in plain words what it sends and to whom** (the line above, and the add-on's README). Never
   pick a sharing service yourself: the author chooses one.
-- Add it as one more `<script>` after Pipeup's, pinned the same way (`https://cdn.jsdelivr.net/npm/@pipeup/share@0.8.0-beta.1/dist/share.min.js`
+- Add it as one more `<script>` after Pipeup's, pinned the same way (`https://cdn.jsdelivr.net/npm/@pipeup/share@0.8.0-beta.3/dist/share.min.js`
   with its `integrity` from the release notes), or use the combined file `pipeup+share.min.js` instead of Pipeup's.
 - Sharing is set up by the author with the command line (`npx @pipeup/share create page.html --server …`), which writes
   `data-pipeup-share` into the file and prints a stop key once. **Never write `data-pipeup-share` yourself and never

package/skills/pipeup-send-to-git-setup/SKILL.md

@@ -5,10 +5,10 @@ description: Use when someone wants Pipeup reviews saved as Markdown files in th
 
 # Set up "Save to GitHub" or "Send to Git"
 
-Written for Pipeup 0.8.0-beta.1 This skill is published at https://pipeup-ai.github.io/pipeup/skills/pipeup-send-to-git-setup/SKILL.md.
+Written for Pipeup 0.8.0-beta.3 This skill is published at https://pipeup-ai.github.io/pipeup/skills/pipeup-send-to-git-setup/SKILL.md.
 
 Two example add-ons (written the way a company writes its own; **not** from the Pipeup project) get a review into Git as a
-Markdown file, the same Markdown that Copy as Markdown makes (each comment says where it is, ready for an AI to act on):
+Markdown file, the same Markdown that Copy comments › As Markdown makes (each comment says where it is, ready for an AI to act on):
 
 - **Save to GitHub** needs **no server and no token**. One menu row opens GitHub's own "new file" page in a new tab with the review filled in;
   the reviewer signs in to GitHub as themselves and presses its commit button. Best to start with, and for short reviews.

package/skills/pipeup-summarise/SKILL.md

@@ -1,15 +1,15 @@
 ---
 name: pipeup-summarise
-description: Use when someone has Pipeup feedback on an HTML page — text a reviewer copied with "Copy as Markdown" and pasted into the conversation — and wants it understood, summarised, grouped or prioritised. Read-only: produces a summary, changes nothing.
+description: Use when someone has Pipeup feedback on an HTML page — text a reviewer copied with "Copy comments › As Markdown" and pasted into the conversation — and wants it understood, summarised, grouped or prioritised. Read-only: produces a summary, changes nothing.
 ---
 
 # Summarise Pipeup feedback
 
-Written for Pipeup 0.8.0-beta.1 This skill is published at https://pipeup-ai.github.io/pipeup/skills/pipeup-summarise/SKILL.md. Its companions: [integrate](https://pipeup-ai.github.io/pipeup/skills/pipeup-integrate/SKILL.md), [apply](https://pipeup-ai.github.io/pipeup/skills/pipeup-apply/SKILL.md).
+Written for Pipeup 0.8.0-beta.3 This skill is published at https://pipeup-ai.github.io/pipeup/skills/pipeup-summarise/SKILL.md. Its companions: [integrate](https://pipeup-ai.github.io/pipeup/skills/pipeup-integrate/SKILL.md), [apply](https://pipeup-ai.github.io/pipeup/skills/pipeup-apply/SKILL.md).
 
 ## 1. Get the feedback as text
 
-The input is the Markdown a reviewer copied with **Copy as Markdown** and pasted into the conversation, or, if you
+The input is the Markdown a reviewer copied with **Copy comments › As Markdown** and pasted into the conversation, or, if you
 can run the page in a browser, `(await Pipeup.comments()).markdown` (add `{ all: true }` for resolved threads). It
 starts with `# Review comments:`. Use it directly. A thread marked "open, addressed" has an agent's note: report it as
 answered, still waiting for the author to close it. Summarising changes nothing, so don't reply in the page.