@ascribed/review 0.1.2-next.2

package/LICENSE

@@ -0,0 +1,373 @@
+Mozilla Public License Version 2.0
+==================================
+
+1. Definitions
+--------------
+
+1.1. "Contributor"
+    means each individual or legal entity that creates, contributes to
+    the creation of, or owns Covered Software.
+
+1.2. "Contributor Version"
+    means the combination of the Contributions of others (if any) used
+    by a Contributor and that particular Contributor's Contribution.
+
+1.3. "Contribution"
+    means Covered Software of a particular Contributor.
+
+1.4. "Covered Software"
+    means Source Code Form to which the initial Contributor has attached
+    the notice in Exhibit A, the Executable Form of such Source Code
+    Form, and Modifications of such Source Code Form, in each case
+    including portions thereof.
+
+1.5. "Incompatible With Secondary Licenses"
+    means
+
+    (a) that the initial Contributor has attached the notice described
+        in Exhibit B to the Covered Software; or
+
+    (b) that the Covered Software was made available under the terms of
+        version 1.1 or earlier of the License, but not also under the
+        terms of a Secondary License.
+
+1.6. "Executable Form"
+    means any form of the work other than Source Code Form.
+
+1.7. "Larger Work"
+    means a work that combines Covered Software with other material, in
+    a separate file or files, that is not Covered Software.
+
+1.8. "License"
+    means this document.
+
+1.9. "Licensable"
+    means having the right to grant, to the maximum extent possible,
+    whether at the time of the initial grant or subsequently, any and
+    all of the rights conveyed by this License.
+
+1.10. "Modifications"
+    means any of the following:
+
+    (a) any file in Source Code Form that results from an addition to,
+        deletion from, or modification of the contents of Covered
+        Software; or
+
+    (b) any new file in Source Code Form that contains any Covered
+        Software.
+
+1.11. "Patent Claims" of a Contributor
+    means any patent claim(s), including without limitation, method,
+    process, and apparatus claims, in any patent Licensable by such
+    Contributor that would be infringed, but for the grant of the
+    License, by the making, using, selling, offering for sale, having
+    made, import, or transfer of either its Contributions or its
+    Contributor Version.
+
+1.12. "Secondary License"
+    means either the GNU General Public License, Version 2.0, the GNU
+    Lesser General Public License, Version 2.1, the GNU Affero General
+    Public License, Version 3.0, or any later versions of those
+    licenses.
+
+1.13. "Source Code Form"
+    means the form of the work preferred for making modifications.
+
+1.14. "You" (or "Your")
+    means an individual or a legal entity exercising rights under this
+    License. For legal entities, "You" includes any entity that
+    controls, is controlled by, or is under common control with You. For
+    purposes of this definition, "control" means (a) the power, direct
+    or indirect, to cause the direction or management of such entity,
+    whether by contract or otherwise, or (b) ownership of more than
+    fifty percent (50%) of the outstanding shares or beneficial
+    ownership of such entity.
+
+2. License Grants and Conditions
+--------------------------------
+
+2.1. Grants
+
+Each Contributor hereby grants You a world-wide, royalty-free,
+non-exclusive license:
+
+(a) under intellectual property rights (other than patent or trademark)
+    Licensable by such Contributor to use, reproduce, make available,
+    modify, display, perform, distribute, and otherwise exploit its
+    Contributions, either on an unmodified basis, with Modifications, or
+    as part of a Larger Work; and
+
+(b) under Patent Claims of such Contributor to make, use, sell, offer
+    for sale, have made, import, and otherwise transfer either its
+    Contributions or its Contributor Version.
+
+2.2. Effective Date
+
+The licenses granted in Section 2.1 with respect to any Contribution
+become effective for each Contribution on the date the Contributor first
+distributes such Contribution.
+
+2.3. Limitations on Grant Scope
+
+The licenses granted in this Section 2 are the only rights granted under
+this License. No additional rights or licenses will be implied from the
+distribution or licensing of Covered Software under this License.
+Notwithstanding Section 2.1(b) above, no patent license is granted by a
+Contributor:
+
+(a) for any code that a Contributor has removed from Covered Software;
+    or
+
+(b) for infringements caused by: (i) Your and any other third party's
+    modifications of Covered Software, or (ii) the combination of its
+    Contributions with other software (except as part of its Contributor
+    Version); or
+
+(c) under Patent Claims infringed by Covered Software in the absence of
+    its Contributions.
+
+This License does not grant any rights in the trademarks, service marks,
+or logos of any Contributor (except as may be necessary to comply with
+the notice requirements in Section 3.4).
+
+2.4. Subsequent Licenses
+
+No Contributor makes additional grants as a result of Your choice to
+distribute the Covered Software under a subsequent version of this
+License (see Section 10.2) or under the terms of a Secondary License (if
+permitted under the terms of Section 3.3).
+
+2.5. Representation
+
+Each Contributor represents that the Contributor believes its
+Contributions are its original creation(s) or it has sufficient rights
+to grant the rights to its Contributions conveyed by this License.
+
+2.6. Fair Use
+
+This License is not intended to limit any rights You have under
+applicable copyright doctrines of fair use, fair dealing, or other
+equivalents.
+
+2.7. Conditions
+
+Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted
+in Section 2.1.
+
+3. Responsibilities
+-------------------
+
+3.1. Distribution of Source Form
+
+All distribution of Covered Software in Source Code Form, including any
+Modifications that You create or to which You contribute, must be under
+the terms of this License. You must inform recipients that the Source
+Code Form of the Covered Software is governed by the terms of this
+License, and how they can obtain a copy of this License. You may not
+attempt to alter or restrict the recipients' rights in the Source Code
+Form.
+
+3.2. Distribution of Executable Form
+
+If You distribute Covered Software in Executable Form then:
+
+(a) such Covered Software must also be made available in Source Code
+    Form, as described in Section 3.1, and You must inform recipients of
+    the Executable Form how they can obtain a copy of such Source Code
+    Form by reasonable means in a timely manner, at a charge no more
+    than the cost of distribution to the recipient; and
+
+(b) You may distribute such Executable Form under the terms of this
+    License, or sublicense it under different terms, provided that the
+    license for the Executable Form does not attempt to limit or alter
+    the recipients' rights in the Source Code Form under this License.
+
+3.3. Distribution of a Larger Work
+
+You may create and distribute a Larger Work under terms of Your choice,
+provided that You also comply with the requirements of this License for
+the Covered Software. If the Larger Work is a combination of Covered
+Software with a work governed by one or more Secondary Licenses, and the
+Covered Software is not Incompatible With Secondary Licenses, this
+License permits You to additionally distribute such Covered Software
+under the terms of such Secondary License(s), so that the recipient of
+the Larger Work may, at their option, further distribute the Covered
+Software under the terms of either this License or such Secondary
+License(s).
+
+3.4. Notices
+
+You may not remove or alter the substance of any license notices
+(including copyright notices, patent notices, disclaimers of warranty,
+or limitations of liability) contained within the Source Code Form of
+the Covered Software, except that You may alter any license notices to
+the extent required to remedy known factual inaccuracies.
+
+3.5. Application of Additional Terms
+
+You may choose to offer, and to charge a fee for, warranty, support,
+indemnity or liability obligations to one or more recipients of Covered
+Software. However, You may do so only on Your own behalf, and not on
+behalf of any Contributor. You must make it absolutely clear that any
+such warranty, support, indemnity, or liability obligation is offered by
+You alone, and You hereby agree to indemnify every Contributor for any
+liability incurred by such Contributor as a result of warranty, support,
+indemnity or liability terms You offer. You may include additional
+disclaimers of warranty and limitations of liability specific to any
+jurisdiction.
+
+4. Inability to Comply Due to Statute or Regulation
+---------------------------------------------------
+
+If it is impossible for You to comply with any of the terms of this
+License with respect to some or all of the Covered Software due to
+statute, judicial order, or regulation then You must: (a) comply with
+the terms of this License to the maximum extent possible; and (b)
+describe the limitations and the code they affect. Such description must
+be placed in a text file included with all distributions of the Covered
+Software under this License. Except to the extent prohibited by statute
+or regulation, such description must be sufficiently detailed for a
+recipient of ordinary skill to be able to understand it.
+
+5. Termination
+--------------
+
+5.1. The rights granted under this License will terminate automatically
+if You fail to comply with any of its terms. However, if You become
+compliant, then the rights granted under this License from a particular
+Contributor are reinstated (a) provisionally, unless and until such
+Contributor explicitly and finally terminates Your grants, and (b) on an
+ongoing basis, if such Contributor fails to notify You of the
+non-compliance by some reasonable means prior to 60 days after You have
+come back into compliance. Moreover, Your grants from a particular
+Contributor are reinstated on an ongoing basis if such Contributor
+notifies You of the non-compliance by some reasonable means, this is the
+first time You have received notice of non-compliance with this License
+from such Contributor, and You become compliant prior to 30 days after
+Your receipt of the notice.
+
+5.2. If You initiate litigation against any entity by asserting a patent
+infringement claim (excluding declaratory judgment actions,
+counter-claims, and cross-claims) alleging that a Contributor Version
+directly or indirectly infringes any patent, then the rights granted to
+You by any and all Contributors for the Covered Software under Section
+2.1 of this License shall terminate.
+
+5.3. In the event of termination under Sections 5.1 or 5.2 above, all
+end user license agreements (excluding distributors and resellers) which
+have been validly granted by You or Your distributors under this License
+prior to termination shall survive termination.
+
+************************************************************************
+*                                                                      *
+*  6. Disclaimer of Warranty                                           *
+*  -------------------------                                           *
+*                                                                      *
+*  Covered Software is provided under this License on an "as is"       *
+*  basis, without warranty of any kind, either expressed, implied, or  *
+*  statutory, including, without limitation, warranties that the       *
+*  Covered Software is free of defects, merchantable, fit for a        *
+*  particular purpose or non-infringing. The entire risk as to the     *
+*  quality and performance of the Covered Software is with You.        *
+*  Should any Covered Software prove defective in any respect, You     *
+*  (not any Contributor) assume the cost of any necessary servicing,   *
+*  repair, or correction. This disclaimer of warranty constitutes an   *
+*  essential part of this License. No use of any Covered Software is   *
+*  authorized under this License except under this disclaimer.         *
+*                                                                      *
+************************************************************************
+
+************************************************************************
+*                                                                      *
+*  7. Limitation of Liability                                          *
+*  --------------------------                                          *
+*                                                                      *
+*  Under no circumstances and under no legal theory, whether tort      *
+*  (including negligence), contract, or otherwise, shall any           *
+*  Contributor, or anyone who distributes Covered Software as          *
+*  permitted above, be liable to You for any direct, indirect,         *
+*  special, incidental, or consequential damages of any character      *
+*  including, without limitation, damages for lost profits, loss of    *
+*  goodwill, work stoppage, computer failure or malfunction, or any    *
+*  and all other commercial damages or losses, even if such party      *
+*  shall have been informed of the possibility of such damages. This   *
+*  limitation of liability shall not apply to liability for death or   *
+*  personal injury resulting from such party's negligence to the       *
+*  extent applicable law prohibits such limitation. Some               *
+*  jurisdictions do not allow the exclusion or limitation of           *
+*  incidental or consequential damages, so this exclusion and          *
+*  limitation may not apply to You.                                    *
+*                                                                      *
+************************************************************************
+
+8. Litigation
+-------------
+
+Any litigation relating to this License may be brought only in the
+courts of a jurisdiction where the defendant maintains its principal
+place of business and such litigation shall be governed by laws of that
+jurisdiction, without reference to its conflict-of-law provisions.
+Nothing in this Section shall prevent a party's ability to bring
+cross-claims or counter-claims.
+
+9. Miscellaneous
+----------------
+
+This License represents the complete agreement concerning the subject
+matter hereof. If any provision of this License is held to be
+unenforceable, such provision shall be reformed only to the extent
+necessary to make it enforceable. Any law or regulation which provides
+that the language of a contract shall be construed against the drafter
+shall not be used to construe this License against a Contributor.
+
+10. Versions of the License
+---------------------------
+
+10.1. New Versions
+
+Mozilla Foundation is the license steward. Except as provided in Section
+10.3, no one other than the license steward has the right to modify or
+publish new versions of this License. Each version will be given a
+distinguishing version number.
+
+10.2. Effect of New Versions
+
+You may distribute the Covered Software under the terms of the version
+of the License under which You originally received the Covered Software,
+or under the terms of any subsequent version published by the license
+steward.
+
+10.3. Modified Versions
+
+If you create software not governed by this License, and you want to
+create a new license for such software, you may create and use a
+modified version of this License if you rename the license and remove
+any references to the name of the license steward (except to note that
+such modified license differs from this License).
+
+10.4. Distributing Source Code Form that is Incompatible With Secondary
+Licenses
+
+If You choose to distribute Source Code Form that is Incompatible With
+Secondary Licenses under the terms of this version of the License, the
+notice described in Exhibit B of this License must be attached.
+
+Exhibit A - Source Code Form License Notice
+-------------------------------------------
+
+  This Source Code Form is subject to the terms of the Mozilla Public
+  License, v. 2.0. If a copy of the MPL was not distributed with this
+  file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+If it is not possible or desirable to put the notice in a particular
+file, then You may include the notice in a location (such as a LICENSE
+file in a relevant directory) where a recipient would be likely to look
+for such a notice.
+
+You may add additional accurate notices of copyright ownership.
+
+Exhibit B - "Incompatible With Secondary Licenses" Notice
+---------------------------------------------------------
+
+  This Source Code Form is "Incompatible With Secondary Licenses", as
+  defined by the Mozilla Public License, v. 2.0.

package/README.md

@@ -0,0 +1,183 @@
+# @ascribed/review
+
+Reviewing [Ascribe](https://github.com/ascribed-dev/ascribe) pages as readers see them: what a change does to each rendered page, and a pull request's review threads beside the blocks they're about.
+
+This README is for building a host. To review a pull request with Ascribe, read [Review](https://github.com/ascribed-dev/ascribe/blob/main/docs/content/guides/review.md).
+
+Each entry point is separate, so a host bundles only what it uses.
+
+| Entry point | Runs in | What it's for |
+|---|---|---|
+| `@ascribed/review/marks` | the browser | Marking the changed blocks of a rendered page, from `ascribe diff --format json`'s changes |
+| `@ascribed/review/overlay` | the browser | The review overlay: a pull request's review threads beside a rendered page's blocks |
+| `@ascribed/review/github` | Node | Reading and writing a pull request's review threads on GitHub |
+| `@ascribed/review/place` | Node | Placing review threads on the blocks of a page |
+
+The rendered page is Ascribe's site output with source anchors (`ascribe build --emit site --anchors`, and always in the editor's page preview), which say where each block is written. The [site-render contract](https://github.com/ascribed-dev/ascribe/blob/main/docs/content/contracts/site-render.md#7-source-anchors) describes them.
+
+## Marks
+
+```ts
+import { markChanges, setShow, showSources } from "@ascribed/review/marks";
+import "@ascribed/review/marks.css";
+
+// `page` holds the page rendered with anchors; `was`, optionally, the page as
+// it was. `changes` is one page's `changes` from `ascribe diff --format json`.
+const marks = markChanges(page, changes, { was });
+setShow(page, "changes"); // or "will" (the page as it will be), or "was"
+showSources(page); // each block's source file and lines, on hover
+```
+
+Each changed block gets a label (Added, Changed, Removed, Moved) and a bar in the margin whose color and style differ by kind. Inside a changed block, the words added are in `<ins>` and the words removed in `<del>`. A removed block is shown where it was, collapsed to one line with **Show**, copied from the page as it was (or from the change's text without it). A moved block links to a stub at its old place, and the stub back to it. A tab's label and a `<details>`' summary say what's changed in what they can hide: "new" for an added tab, else how many changes. `markChanges` returns the marks in page order, for stepping through them with `goTo`. `clearMarks` removes them all.
+
+The blocks are found by their anchors: the element with exactly a change's anchor, or, when there's none (a paragraph in a tight list item has no element of its own), the smallest anchored element with the same file and includes whose lines contain it.
+
+The colors are the `--ascribe-review-*` custom properties at the top of `marks.css`, with light and dark values.
+
+## The static report
+
+`src/report/` is the script of `ascribe diff --format html`'s report, which draws the list of changed pages and each page with its marks. It isn't an entry point: `pnpm --filter @ascribed/review embed` bundles it with the marks and `@ascribed/elements` into `crates/tessera-diff/src/html/`, where the binary embeds it, along with one stylesheet made of the element library's, `marks.css`, and `src/report/report.css`. It also writes the script's SHA-256 beside it, which the report's content security policy names as the one script allowed to run. Run it after changing any of them; `test/embedded.test.ts` fails until you do.
+
+## `@ascribed/review/overlay`
+
+```ts
+import { createOverlay } from "@ascribed/review/overlay";
+
+const overlay = createOverlay({ root: article, host });
+```
+
+Draws a pull request's threads beside the blocks of `root`, a rendered page with source anchors: in a column beside the page when its container is at least `columnAt` pixels wide (default 600), else as a count on each block that opens its threads. Threads with no block on the page are listed above it, and a bar below it counts unsent comments, with the submit dialog. A reviewer can reply (at once, or with the review), resolve and reopen, comment on any block, and submit or discard the review, all from the keyboard. It draws in shadow roots, so its styles and the page's stay apart; theme it with the `--ascribe-review-*` custom properties `marks.css` declares.
+
+The host (`OverlayHost`) supplies the data and does the work: `load()` for the page's threads (`ReviewSession.threads`), its pending review, and the viewer; `commentTarget`, `comment`, `reply`, `resolve`, `submit`, `discard`, and `allThreads`, as `ReviewSession` has them; and `openSource`, `openThread` (a thread on another page), and optionally `openLink` and `notify`. `onDidChange` tells the overlay to read the threads again. The overlay never talks to GitHub itself, so a host can keep the token out of the page.
+
+`overlay.refresh()` reads the threads again, `layout()` places them again after the page changed size, `goToThread(id)` goes to one, `showAllComments()` opens the list of every thread, and `dispose()` takes everything away.
+
+Comment bodies are other people's Markdown: `renderMarkdown(document, text)` builds a safe subset (paragraphs, emphasis, code, links that open apart from the page, lists, block quotes) as DOM nodes. Raw HTML stays text, links other than web and email ones are dropped, and an image is a link to it, so nothing loads without a click.
+
+## `@ascribed/review/github`
+
+```ts
+import { openReview, ghTransport, tokenTransport } from "@ascribed/review/github";
+
+const review = await openReview({ projectDir: "/path/to/project" });
+if (review === undefined) {
+  // No open pull request for this branch, or HEAD is detached.
+} else {
+  const placed = await review.threads(page);
+  await review.comment(anchor, "Is this still true?", page);
+  console.log(`${(await review.pending()).count} unsent comments`);
+  await review.submit("COMMENT");
+}
+```
+
+### `openReview(options)`
+
+Finds the open pull request whose head is the checkout's current branch and returns a `ReviewSession` for it, or `undefined` when there is none. It looks in the repository of a remote named `upstream`, if there is one, and then in the repository the branch is pushed to, and takes the pull request whose head is in the repository the branch is pushed to. No pull request is a normal answer, not an error.
+
+| Option | Meaning |
+|---|---|
+| `projectDir` | The directory holding the project's `ascribe.toml`, inside the checkout. |
+| `contentPrefix` | The content root's path in the repository, with a trailing `/` (`""` at the root). By default it's worked out from `ascribe.toml`'s `content-root`. |
+| `transport` | `(host) => GitHubTransport`. By default `ghTransport({ host })`. The host comes from the branch's remote, so GitHub Enterprise Server works. |
+| `mutationInterval` | The least time between two requests that change something, in milliseconds. Default `1000`, which keeps under GitHub's secondary rate limit. |
+
+`session.pullRequest` describes the pull request: `number`, `url`, `repository` (`host`, `owner`, `name`), `baseRefName`, `baseOid`, `headRefName`, `headOid`, and `local`, how the checkout's `HEAD` relates to the head commit: `"same"`, `"behind"` (pull), `"ahead"` (push), `"diverged"`, or `"missing"` (the head commit isn't in the local repository: fetch).
+
+### `ReviewSession`
+
+| Method | What it does |
+|---|---|
+| `threads(page)` | The page's threads, placed (see [`placeOnPage`](#placeonpagepage-threads)). Reads the pull request once and caches it until `refresh()` or a change made through the session. |
+| `comment(anchor, body, page, quote?)` | Comments on a block. The comment becomes a review thread on the block's file, at its lines at the pull request's head commit (moved back through any local edits), on the right side, in the viewer's pending review, which is created on the first comment. If any of the block's lines isn't at the head commit unchanged, it rejects with `push-first`. If the file isn't in the pull request, or GitHub can't anchor a comment to the lines (it can only anchor to lines near the pull request's changes), the comment is held in the pending review's body instead, quoting the block's text (`quote`, the text the page shows, escaped so GitHub shows it as written and cut at 2,000 characters; without it, the block's source), linking its lines, and ending with a hidden marker (below); it reaches the pull request's conversation when the review is submitted. GitHub can't add a body to a pending review created without one, so the session creates its review with a placeholder body, `<!-- ascribe:review -->`, which is never shown or sent; if the pending review was started on GitHub with no body, a held comment rejects with `cant-hold`. Resolves with the new thread. |
+| `reply(threadId, body, when)` | Replies to a review thread: `"withReview"` holds the reply in the pending review; `"now"` sends it at once. While the viewer has a pending review, GitHub puts every reply into it, so a reply sent with `"now"` then is deleted again and the call rejects with `reply-held`: offer `"now"` only when `pending().count` is 0. |
+| `resolve(threadId, resolved)` | Resolves or reopens a thread, at once. |
+| `pending()` | What's in the viewer's pending review: its `id`, new `threads`, `replies` to existing threads, held `conversation` comments, and the `count` of all of them. |
+| `submit(event, body?)` | Submits the pending review as `"COMMENT"`, `"APPROVE"`, or `"REQUEST_CHANGES"`, with `body` first and the held conversation comments after it, the two separated by `<!-- ascribe:summary -->` (and without the placeholder). |
+| `discard()` | Deletes the pending review and everything in it. |
+| `refresh()` | Forgets what's cached. |
+
+Nothing the session does is visible to anyone else until `submit`, except `resolve` and replies sent with `"now"`. Changes go one at a time, spaced by `mutationInterval`.
+
+"Pending" is the GitHub API's word, and these names keep it. Text shown to readers says "unsent".
+
+### Threads
+
+A `Thread` has an `id`, `kind` (`"review"`, or `"conversation"` for a conversation comment with a marker, which GitHub can't resolve or reply to as a thread), `repositoryPath`, `subject` (`"line"` or `"file"`), `side` (`"RIGHT"`, or `"LEFT"` for removed text), the lines GitHub reports (`line`, `startLine`, `originalLine`, `originalStartLine`, and the commits they're counted at), `resolved`, `outdated`, `canResolve`, `canUnresolve`, `canReply`, `comments`, and `quote`, the text the thread is on when it's known. Each comment has an `id`, `author` (`login`, `avatarUrl`, or `null`), `body`, `createdAt`, `url`, and `pending`, whether it's in the viewer's pending review.
+
+Comment bodies are Markdown written by other people, returned as text. Render them safely.
+
+### Hidden markers
+
+A comment held for the conversation ends with a marker naming its block and build:
+
+```html
+<!-- ascribe:anchor guides/install.md:12-14 build=site -->
+```
+
+When the comment quotes the text the page shows, rather than the block's source, the marker ends ` quote=text`. In a submitted review, the summary comes first and ends with `<!-- ascribe:summary -->`; a summary with no held comments after it has no marker.
+
+Reading a pull request also reads its conversation comments and review bodies, splits them at markers, and places each part like a thread.
+
+### Transports
+
+```ts
+interface GitHubTransport {
+  graphql<T>(query: string, variables: Record<string, unknown>): Promise<T>;
+}
+```
+
+- `ghTransport({ host?, command? })` runs `gh api graphql --hostname <host>`, with the query on standard input and each variable as an argument (`-f` for strings, `-F` for numbers, booleans, and `null`). It needs `gh` 2.0.0 or later, signed in to the host (`gh auth login --hostname <host>`).
+- `tokenTransport(getToken, { host?, fetch? })` posts to the host's GraphQL endpoint (`https://api.github.com/graphql`, or `https://<host>/api/graphql`) with the token `getToken` returns, called for each request.
+
+Neither stores a token, and neither puts one in an error: anything shaped like a GitHub token is removed from error messages.
+
+### Errors
+
+Failures reject with a `ReviewError`, whose `message` is a sentence to show and whose `code` says what happened:
+
+| Code | Meaning |
+|---|---|
+| `gh-missing` | `gh` isn't on the path. |
+| `gh-too-old` | `gh` is older than 2.0.0. |
+| `not-signed-in` | No sign-in for the host, or the host refused it. |
+| `rate-limited` | GitHub's secondary rate limit. `retryAfter` is the seconds to wait, when GitHub says. |
+| `refused` | GitHub answered with an error. |
+| `network` | The request didn't reach GitHub, or the answer wasn't JSON. |
+| `push-first` | The block's lines aren't all at the pull request's head commit, unchanged. |
+| `reply-held` | A reply can't be sent at once while the viewer has a pending review. |
+| `cant-hold` | The viewer's pending review was started on GitHub without a body, and GitHub can't add one to hold a comment. Submit or discard it on GitHub first. |
+| `not-found` | The thread, or something else named, isn't there. |
+| `git` | `git` failed, isn't on the path, or the directory isn't a repository. |
+
+## `@ascribed/review/place`
+
+### Anchors
+
+`Anchor` is `{ source, via }`, a block's `data-ascribe-source` and `data-ascribe-via` (as an array). `parseSource("guides/install.md:12-14")` returns `{ path, first, last }` with the path decoded; `formatSource` and `encodePath` write them; `anchorKey(anchor)` is a string identifying an anchor, `via` included.
+
+### `locateThreads(threads, { root, contentPrefix, headOid })`
+
+Moves threads into the working tree's terms. Threads on files outside the content root are left out. Each other thread gets its content `path` and either `lines` or a `detached` reason:
+
+- A thread on the right side is at its line at the pull request's head commit, moved through the working tree's changes since (`git diff --unified=0`). A reworded line moves onto the text that replaced it, and the thread is marked `outdated`, with the text it was on as `quote`. If the line was deleted, the thread is detached (`"line-gone"`), with the same `quote`.
+- An outdated thread is at its original line at its original commit, moved the same way, and keeps that text as `quote`. It stays marked `outdated`.
+- A thread on the left side keeps its line, on the diff's base.
+- A thread on a whole file is detached (`"file"`).
+- A conversation comment is at the lines its marker names.
+
+### `placeOnPage(page, threads)`
+
+The threads on one page. `page` is a `PageRef`:
+
+| Field | Meaning |
+|---|---|
+| `build` | The build the page is rendered for. Conversation comments marked for another build are left out. |
+| `path` | The page's content path. |
+| `anchors` | Every anchored block on the page, in order. |
+| `removed` | The `was` of each removed, moved, or changed block on the page, from `ascribe diff`: where threads on the base's text go. |
+
+A thread goes on the smallest block that holds all its lines (failing that, its last line), and on every block with that source: a fragment included twice gives the thread twice. A thread on the left side goes on a removed, moved, or changed block's old lines the same way. The result has `blocks` and `removed`, each a list of `{ anchor, threads }` in the page's order, and `detached`: the threads on any of the page's files (its own, and the fragments it shows) that aren't on a block, with reason `"no-block"` when the page has no block for their lines.
+
+### Lines
+
+`lineMap(root, commit, file, "to-worktree" | "to-commit")` maps line numbers of a repository file between a commit and the working tree; `parseHunks` and `shiftLine` do the same for a diff in hand; `linesAt` reads lines of a file at a commit. A line maps to `{ line, replaced }`: a replaced line maps onto the lines that replaced it, at the same offset (or their last line), with `replaced` set, and a deleted line maps to `undefined`.

package/dist/github/index.d.ts

@@ -0,0 +1,7 @@
+export { contentPrefixOf, createSession, findPullRequest, openReview, type CommentTarget, type LocalState, type OpenReviewOptions, type PendingReview, type PullRequestInfo, type ReviewEvent, type ReviewSession, type SessionOptions, } from "./session.js";
+export { answerRequest, baseRevision, OVERLAY_METHODS, pagesShowing, pullRequestBase, type Answer, type ChangedPageRef, type OverlayMethod, type RequestContext, } from "./requests.js";
+export { parseRemote, readCheckout, type CheckoutInfo, type RepositoryRef } from "./repository.js";
+export { ghTransport, graphqlUrl, MIN_GH_VERSION, tokenTransport, type GhTransportOptions, type GitHubTransport, type TokenTransportOptions, } from "./transport.js";
+export { formatSection, marker, parseSections, type MarkedSection } from "./marker.js";
+export { ReviewError, type ReviewErrorCode } from "../shared/errors.js";
+export type { Author, Side, Thread, ThreadComment } from "../shared/types.js";

package/dist/github/index.js

@@ -0,0 +1,8 @@
+// Reading and writing a pull request's review threads on GitHub.
+export { contentPrefixOf, createSession, findPullRequest, openReview, } from "./session.js";
+export { answerRequest, baseRevision, OVERLAY_METHODS, pagesShowing, pullRequestBase, } from "./requests.js";
+export { parseRemote, readCheckout } from "./repository.js";
+export { ghTransport, graphqlUrl, MIN_GH_VERSION, tokenTransport, } from "./transport.js";
+export { formatSection, marker, parseSections } from "./marker.js";
+export { ReviewError } from "../shared/errors.js";
+//# sourceMappingURL=index.js.map

package/dist/github/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/github/index.ts"],"names":[],"mappings":"AAAA,iEAAiE;AACjE,OAAO,EACL,eAAe,EACf,aAAa,EACb,eAAe,EACf,UAAU,GASX,MAAM,cAAc,CAAC;AACtB,OAAO,EACL,aAAa,EACb,YAAY,EACZ,eAAe,EACf,YAAY,EACZ,eAAe,GAKhB,MAAM,eAAe,CAAC;AACvB,OAAO,EAAE,WAAW,EAAE,YAAY,EAAyC,MAAM,iBAAiB,CAAC;AACnG,OAAO,EACL,WAAW,EACX,UAAU,EACV,cAAc,EACd,cAAc,GAIf,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAE,aAAa,EAAE,MAAM,EAAE,aAAa,EAAsB,MAAM,aAAa,CAAC;AACvF,OAAO,EAAE,WAAW,EAAwB,MAAM,qBAAqB,CAAC"}

package/dist/github/marker.d.ts

@@ -0,0 +1,63 @@
+/** One anchored comment, as written in a body. */
+export interface MarkedSection {
+    /** The block's source. */
+    source: string;
+    build: string | undefined;
+    /** The comment, without the quote, the link line, or the marker. */
+    body: string;
+    /** The block's text the comment quoted, if it did. */
+    quote: string | undefined;
+}
+/**
+ * The summary a pending review starts with. GitHub can't edit the summary of
+ * a pending review created without one, so the session's reviews start with
+ * this, which reading and submitting remove.
+ */
+export declare const PLACEHOLDER = "<!-- ascribe:review -->";
+/** Ends a review's summary when anchored comments follow it. */
+export declare const SUMMARY_END = "<!-- ascribe:summary -->";
+/** `body` without the placeholder summary. */
+export declare function withoutPlaceholder(body: string): string;
+/**
+ * The marker for a block. Without a build (or with `""`), the comment is on
+ * every build's page. `shown` marks a quote of the shown text.
+ */
+export declare function marker(source: string, build: string | undefined, shown?: boolean): string;
+/**
+ * Plain text as Markdown that GitHub shows as the text: punctuation
+ * escaped, `@name` and `#123` not linked, line breaks and leading spaces
+ * kept.
+ */
+export declare function escapeText(text: string): string;
+/** Text that `escapeText` wrote, as it was. */
+export declare function unescapeText(text: string): string;
+/**
+ * Writes a section: the block's text quoted, the comment, a line linking the
+ * block's lines, and the marker.
+ */
+export declare function formatSection(options: {
+    source: string;
+    build: string | undefined;
+    body: string;
+    quote: string | undefined;
+    /** Whether `quote` is the block's text as the page shows it, rather than its source. */
+    shown?: boolean;
+    link: {
+        label: string;
+        url: string;
+    } | undefined;
+}): string;
+/**
+ * Splits a body into its summary, its marked sections, and the text after
+ * the last marker (`rest`), which isn't anchored either.
+ */
+export declare function parseSections(text: string): {
+    summary: string;
+    sections: MarkedSection[];
+    rest: string;
+};
+/**
+ * Joins a summary and sections into one body: the summary first, so it
+ * doesn't read as a remark on the last section.
+ */
+export declare function joinSections(sections: readonly string[], summary: string | undefined): string;