@reviewflow/sdk 6.24.0 → 6.25.0

package/build/git-node.mjs

@@ -403,7 +403,7 @@ const groupDiffPaths = (isPackage, paths) => {
     if (group === void 0) groups.set(name, [path]);
     else group.push(path);
   }
-  return [...groups].toSorted(([left], [right]) => Number(left !== "") - Number(right !== "")).map(([name, groupPaths]) => ({ name, paths: groupPaths }));
+  return [...groups].toSorted(([left], [right]) => Number(left === "") - Number(right === "")).map(([name, groupPaths]) => ({ name, paths: groupPaths }));
 };
 
 const cEscapes = {
@@ -782,7 +782,7 @@ const orderPackages = (names, dependsOn) => {
   const isDependedOnByRemaining = (name) => [...remaining].some(
     (other) => other !== name && dependencies.get(other).has(name)
   );
-  const ordered = names.includes("") ? [""] : [];
+  const ordered = [];
   while (remaining.size > 0) {
     const sorted = [...remaining].toSorted(
       (left, right) => left.localeCompare(right)
@@ -791,6 +791,7 @@ const orderPackages = (names, dependsOn) => {
     ordered.push(next);
     remaining.delete(next);
   }
+  if (names.includes("")) ordered.push("");
   return ordered;
 };
 const orderForReading = ({

package/build/index-browser.es.js

@@ -98,6 +98,7 @@ const subjectsOf = (path) => {
 };
 
 const diffThemes = [
+  "reviewflow",
   "github",
   "github-high-contrast",
   "pierre",
@@ -116,7 +117,12 @@ const diffThemes = [
   "min"
 ];
 const isDiffTheme = (value) => diffThemes.includes(value);
+const defaultDiffTheme = "reviewflow";
 const families = {
+  reviewflow: {
+    label: "Reviewflow",
+    themes: { light: "reviewflow-light", dark: "reviewflow-dark" }
+  },
   github: {
     label: "GitHub",
     themes: { light: "github-light-default", dark: "github-dark-default" }
@@ -181,6 +187,13 @@ const diffThemeOptions = diffThemes.map((theme) => ({
   value: theme,
   label: families[theme].label
 }));
+const isDiffFont = (value) => value === "alouette" || value === "pierre" || value === "custom";
+const defaultDiffFont = "alouette";
+const diffFontOptions = [
+  { value: "alouette", label: "Alouette (Chivo Mono)" },
+  { value: "pierre", label: "Pierre (system mono)" },
+  { value: "custom", label: "Custom" }
+];
 
 const isDiffWhitespace = (value) => value === "hide" || value === "show";
 
@@ -3475,6 +3488,8 @@ const createReviewflowFollower = ({
   };
 };
 
+const defaultRepoPath = "~/dev/";
+
 const isRecord = (value) => typeof value === "object" && value !== null && !Array.isArray(value);
 const insertCheckoutEntry = (source, ownerRepo) => {
   let parsed;
@@ -3506,5 +3521,5 @@ const insertCheckoutEntry = (source, ownerRepo) => {
   return { source: text, cursor: value };
 };
 
-export { accountOfOwnerRepo, applyPullRequestEdit, applyStreamEvent, applySuggestionsToText, assembleBoard, boardReadDelayMs, buildPrQuery, changedPullRequestParts, checkOutcomes, checksFromReviewflow, coAuthorTrailers, commitSuggestions, createGitHubTransport, createReviewflowClient, createReviewflowFollower, diffLines, diffPaths, diffThemeNames, diffThemeOptions, diffThemes, editPullRequest, fail, fetchCompareDiff, fetchPullRequestCandidates, fetchPullRequestHead, fetchPullRequestPart, fetchPullRequestRevisions, formatPrChanges, formatRelativeDate, insertCheckoutEntry, interpretGraphql, isAttachablePath, isDiffTheme, isDiffWhitespace, isPullRequestOnBoard, isPullRequestPart, isPullRequestReactionContent, isReviewflowFailure, lingerMs, maxExtraPagesPerBucket, maxFailedCheckNames, maxLookupTargets, maxRetryMs, parsePrQueryResponse, parsePullRequestCandidates, parsePullRequestChecks, parsePullRequestCommits, parsePullRequestDetail, parsePullRequestEdit, parsePullRequestFiles, parsePullRequestRevisions, parsePullRequestTimeline, parseSuggestions, partFingerprint, planSuggestions, pluralOf, prFields, prHasConflicts, prNumberOf, prStatus, prStatusLabels, prStatuses, prUrl, pullRequestCandidatesQuery, pullRequestChecksQuery, pullRequestCommitsQuery, pullRequestDetailQuery, pullRequestEditMovesBoard, pullRequestFilesQuery, pullRequestHeadQuery, pullRequestParts, pullRequestPartsStaleAfter, pullRequestReactionContents, pullRequestRevisionsQuery, pullRequestTimelineQuery, readAccountBoards, readPrDetail, readReviewflowStream, reconnectDelayMs, responseFailure, restErrorMessage, reviewflowErrorCode, reviewflowPrChangesRequested, reviewflowPrFailure, reviewflowPrFlowDate, reviewflowPrOwners, reviewflowPrProgress, reviewflowPrStatus, reviewflowReviewDecisions, splitOwnerRepo, streamClosedWithinDays, streamIdleTimeoutMs, subjectsOf, suggestionCommitRefusal, suggestionOriginalLines, suggestionRangesOverlap, toBoardPr, toFetchedPr, withAccountBoard, withFileViewed };
+export { accountOfOwnerRepo, applyPullRequestEdit, applyStreamEvent, applySuggestionsToText, assembleBoard, boardReadDelayMs, buildPrQuery, changedPullRequestParts, checkOutcomes, checksFromReviewflow, coAuthorTrailers, commitSuggestions, createGitHubTransport, createReviewflowClient, createReviewflowFollower, defaultDiffFont, defaultDiffTheme, defaultRepoPath, diffFontOptions, diffLines, diffPaths, diffThemeNames, diffThemeOptions, diffThemes, editPullRequest, fail, fetchCompareDiff, fetchPullRequestCandidates, fetchPullRequestHead, fetchPullRequestPart, fetchPullRequestRevisions, formatPrChanges, formatRelativeDate, insertCheckoutEntry, interpretGraphql, isAttachablePath, isDiffFont, isDiffTheme, isDiffWhitespace, isPullRequestOnBoard, isPullRequestPart, isPullRequestReactionContent, isReviewflowFailure, lingerMs, maxExtraPagesPerBucket, maxFailedCheckNames, maxLookupTargets, maxRetryMs, parsePrQueryResponse, parsePullRequestCandidates, parsePullRequestChecks, parsePullRequestCommits, parsePullRequestDetail, parsePullRequestEdit, parsePullRequestFiles, parsePullRequestRevisions, parsePullRequestTimeline, parseSuggestions, partFingerprint, planSuggestions, pluralOf, prFields, prHasConflicts, prNumberOf, prStatus, prStatusLabels, prStatuses, prUrl, pullRequestCandidatesQuery, pullRequestChecksQuery, pullRequestCommitsQuery, pullRequestDetailQuery, pullRequestEditMovesBoard, pullRequestFilesQuery, pullRequestHeadQuery, pullRequestParts, pullRequestPartsStaleAfter, pullRequestReactionContents, pullRequestRevisionsQuery, pullRequestTimelineQuery, readAccountBoards, readPrDetail, readReviewflowStream, reconnectDelayMs, responseFailure, restErrorMessage, reviewflowErrorCode, reviewflowPrChangesRequested, reviewflowPrFailure, reviewflowPrFlowDate, reviewflowPrOwners, reviewflowPrProgress, reviewflowPrStatus, reviewflowReviewDecisions, splitOwnerRepo, streamClosedWithinDays, streamIdleTimeoutMs, subjectsOf, suggestionCommitRefusal, suggestionOriginalLines, suggestionRangesOverlap, toBoardPr, toFetchedPr, withAccountBoard, withFileViewed };
 //# sourceMappingURL=index-browser.es.js.map

package/build/index-node.mjs

@@ -98,6 +98,7 @@ const subjectsOf = (path) => {
 };
 
 const diffThemes = [
+  "reviewflow",
   "github",
   "github-high-contrast",
   "pierre",
@@ -116,7 +117,12 @@ const diffThemes = [
   "min"
 ];
 const isDiffTheme = (value) => diffThemes.includes(value);
+const defaultDiffTheme = "reviewflow";
 const families = {
+  reviewflow: {
+    label: "Reviewflow",
+    themes: { light: "reviewflow-light", dark: "reviewflow-dark" }
+  },
   github: {
     label: "GitHub",
     themes: { light: "github-light-default", dark: "github-dark-default" }
@@ -181,6 +187,13 @@ const diffThemeOptions = diffThemes.map((theme) => ({
   value: theme,
   label: families[theme].label
 }));
+const isDiffFont = (value) => value === "alouette" || value === "pierre" || value === "custom";
+const defaultDiffFont = "alouette";
+const diffFontOptions = [
+  { value: "alouette", label: "Alouette (Chivo Mono)" },
+  { value: "pierre", label: "Pierre (system mono)" },
+  { value: "custom", label: "Custom" }
+];
 
 const isDiffWhitespace = (value) => value === "hide" || value === "show";
 
@@ -3475,6 +3488,8 @@ const createReviewflowFollower = ({
   };
 };
 
+const defaultRepoPath = "~/dev/";
+
 const isRecord = (value) => typeof value === "object" && value !== null && !Array.isArray(value);
 const insertCheckoutEntry = (source, ownerRepo) => {
   let parsed;
@@ -3506,5 +3521,5 @@ const insertCheckoutEntry = (source, ownerRepo) => {
   return { source: text, cursor: value };
 };
 
-export { accountOfOwnerRepo, applyPullRequestEdit, applyStreamEvent, applySuggestionsToText, assembleBoard, boardReadDelayMs, buildPrQuery, changedPullRequestParts, checkOutcomes, checksFromReviewflow, coAuthorTrailers, commitSuggestions, createGitHubTransport, createReviewflowClient, createReviewflowFollower, diffLines, diffPaths, diffThemeNames, diffThemeOptions, diffThemes, editPullRequest, fail, fetchCompareDiff, fetchPullRequestCandidates, fetchPullRequestHead, fetchPullRequestPart, fetchPullRequestRevisions, formatPrChanges, formatRelativeDate, insertCheckoutEntry, interpretGraphql, isAttachablePath, isDiffTheme, isDiffWhitespace, isPullRequestOnBoard, isPullRequestPart, isPullRequestReactionContent, isReviewflowFailure, lingerMs, maxExtraPagesPerBucket, maxFailedCheckNames, maxLookupTargets, maxRetryMs, parsePrQueryResponse, parsePullRequestCandidates, parsePullRequestChecks, parsePullRequestCommits, parsePullRequestDetail, parsePullRequestEdit, parsePullRequestFiles, parsePullRequestRevisions, parsePullRequestTimeline, parseSuggestions, partFingerprint, planSuggestions, pluralOf, prFields, prHasConflicts, prNumberOf, prStatus, prStatusLabels, prStatuses, prUrl, pullRequestCandidatesQuery, pullRequestChecksQuery, pullRequestCommitsQuery, pullRequestDetailQuery, pullRequestEditMovesBoard, pullRequestFilesQuery, pullRequestHeadQuery, pullRequestParts, pullRequestPartsStaleAfter, pullRequestReactionContents, pullRequestRevisionsQuery, pullRequestTimelineQuery, readAccountBoards, readPrDetail, readReviewflowStream, reconnectDelayMs, responseFailure, restErrorMessage, reviewflowErrorCode, reviewflowPrChangesRequested, reviewflowPrFailure, reviewflowPrFlowDate, reviewflowPrOwners, reviewflowPrProgress, reviewflowPrStatus, reviewflowReviewDecisions, splitOwnerRepo, streamClosedWithinDays, streamIdleTimeoutMs, subjectsOf, suggestionCommitRefusal, suggestionOriginalLines, suggestionRangesOverlap, toBoardPr, toFetchedPr, withAccountBoard, withFileViewed };
+export { accountOfOwnerRepo, applyPullRequestEdit, applyStreamEvent, applySuggestionsToText, assembleBoard, boardReadDelayMs, buildPrQuery, changedPullRequestParts, checkOutcomes, checksFromReviewflow, coAuthorTrailers, commitSuggestions, createGitHubTransport, createReviewflowClient, createReviewflowFollower, defaultDiffFont, defaultDiffTheme, defaultRepoPath, diffFontOptions, diffLines, diffPaths, diffThemeNames, diffThemeOptions, diffThemes, editPullRequest, fail, fetchCompareDiff, fetchPullRequestCandidates, fetchPullRequestHead, fetchPullRequestPart, fetchPullRequestRevisions, formatPrChanges, formatRelativeDate, insertCheckoutEntry, interpretGraphql, isAttachablePath, isDiffFont, isDiffTheme, isDiffWhitespace, isPullRequestOnBoard, isPullRequestPart, isPullRequestReactionContent, isReviewflowFailure, lingerMs, maxExtraPagesPerBucket, maxFailedCheckNames, maxLookupTargets, maxRetryMs, parsePrQueryResponse, parsePullRequestCandidates, parsePullRequestChecks, parsePullRequestCommits, parsePullRequestDetail, parsePullRequestEdit, parsePullRequestFiles, parsePullRequestRevisions, parsePullRequestTimeline, parseSuggestions, partFingerprint, planSuggestions, pluralOf, prFields, prHasConflicts, prNumberOf, prStatus, prStatusLabels, prStatuses, prUrl, pullRequestCandidatesQuery, pullRequestChecksQuery, pullRequestCommitsQuery, pullRequestDetailQuery, pullRequestEditMovesBoard, pullRequestFilesQuery, pullRequestHeadQuery, pullRequestParts, pullRequestPartsStaleAfter, pullRequestReactionContents, pullRequestRevisionsQuery, pullRequestTimelineQuery, readAccountBoards, readPrDetail, readReviewflowStream, reconnectDelayMs, responseFailure, restErrorMessage, reviewflowErrorCode, reviewflowPrChangesRequested, reviewflowPrFailure, reviewflowPrFlowDate, reviewflowPrOwners, reviewflowPrProgress, reviewflowPrStatus, reviewflowReviewDecisions, splitOwnerRepo, streamClosedWithinDays, streamIdleTimeoutMs, subjectsOf, suggestionCommitRefusal, suggestionOriginalLines, suggestionRangesOverlap, toBoardPr, toFetchedPr, withAccountBoard, withFileViewed };
 //# sourceMappingURL=index-node.mjs.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@reviewflow/sdk",
-  "version": "6.24.0",
+  "version": "6.25.0",
   "description": "pull request model shared by the reviewflow app server and its ui: diff and api types, pure utils, the GitHub layer behind an injected transport, and (node only) reading a diff from a local checkout (@reviewflow/sdk/git) and editing a text file in place (@reviewflow/sdk/files)",
   "keywords": [
     "code-review",

package/src/config/defaultRepoPath.ts

@@ -0,0 +1,2 @@
+/** Where the app searches checkouts when `config.json` sets no `defaultRepoPath`. */
+export const defaultRepoPath = "~/dev/";

package/src/diff/readingOrder.ts

@@ -381,9 +381,9 @@ const transitiveDependencies = (
 };
 
 /**
- * The root first, as `groupDiffPaths` has it; then a package before every
- * package it depends on, directly or through a package the change does not
- * touch. Alphabetical between two unrelated packages, and to break a cycle.
+ * A package before every package it depends on, directly or through a
+ * package the change does not touch. Alphabetical between two unrelated
+ * packages, and to break a cycle. The root last, as `groupDiffPaths` has it.
  */
 export const orderPackages = (
   names: readonly string[],
@@ -401,7 +401,7 @@ export const orderPackages = (
       (other) => other !== name && dependencies.get(other)!.has(name),
     );
 
-  const ordered = names.includes("") ? [""] : [];
+  const ordered: string[] = [];
   while (remaining.size > 0) {
     const sorted = [...remaining].toSorted((left, right) =>
       left.localeCompare(right),
@@ -411,6 +411,7 @@ export const orderPackages = (
     ordered.push(next);
     remaining.delete(next);
   }
+  if (names.includes("")) ordered.push("");
   return ordered;
 };
 

package/src/diff/themes.ts

@@ -5,6 +5,7 @@
  * same list the ui renders.
  */
 export const diffThemes = [
+  "reviewflow",
   "github",
   "github-high-contrast",
   "pierre",
@@ -28,13 +29,22 @@ export type DiffTheme = (typeof diffThemes)[number];
 export const isDiffTheme = (value: unknown): value is DiffTheme =>
   (diffThemes as readonly unknown[]).includes(value);
 
+export const defaultDiffTheme: DiffTheme = "reviewflow";
+
 interface DiffThemeFamily {
   label: string;
-  /** shiki theme names, the pierre ones resolved by `@pierre/diffs` itself */
+  /**
+   * shiki theme names, the pierre ones resolved by `@pierre/diffs` itself, the
+   * reviewflow ones registered by `@reviewflow/ui`
+   */
   themes: { light: string; dark: string };
 }
 
 const families: Record<DiffTheme, DiffThemeFamily> = {
+  reviewflow: {
+    label: "Reviewflow",
+    themes: { light: "reviewflow-light", dark: "reviewflow-dark" },
+  },
   github: {
     label: "GitHub",
     themes: { light: "github-light-default", dark: "github-dark-default" },
@@ -103,3 +113,21 @@ export const diffThemeOptions = diffThemes.map((theme) => ({
   value: theme,
   label: families[theme].label,
 }));
+
+/**
+ * The diff's code font: `alouette` is the design system's mono (Chivo Mono),
+ * `pierre` the system mono stack `@pierre/diffs` ships with, `custom` a font
+ * the user names (a CSS `font-family`, stored apart).
+ */
+export type DiffFont = "alouette" | "custom" | "pierre";
+
+export const isDiffFont = (value: unknown): value is DiffFont =>
+  value === "alouette" || value === "pierre" || value === "custom";
+
+export const defaultDiffFont: DiffFont = "alouette";
+
+export const diffFontOptions: { value: DiffFont; label: string }[] = [
+  { value: "alouette", label: "Alouette (Chivo Mono)" },
+  { value: "pierre", label: "Pierre (system mono)" },
+  { value: "custom", label: "Custom" },
+];

package/src/git/groupDiffPaths.ts

@@ -126,9 +126,9 @@ export const groupDiffPaths = (
     if (group === undefined) groups.set(name, [path]);
     else group.push(path);
   }
-  // The root first: its files (a lockfile, the root manifest, a README) are
-  // what the rest of the change is read against.
+  // The root last: its files (a lockfile, the root manifest, a README) follow
+  // from the packages' changes rather than explain them.
   return [...groups]
-    .toSorted(([left], [right]) => Number(left !== "") - Number(right !== ""))
+    .toSorted(([left], [right]) => Number(left === "") - Number(right === ""))
     .map(([name, groupPaths]) => ({ name, paths: groupPaths }));
 };

package/src/index.ts

@@ -35,5 +35,6 @@ export * from "./reviewflow/board.ts";
 export * from "./reviewflow/boardFacts.ts";
 export * from "./reviewflow/follow.ts";
 export type * from "./reviewflow/status.ts";
+export { defaultRepoPath } from "./config/defaultRepoPath.ts";
 export { insertCheckoutEntry } from "./config/insertCheckoutEntry.ts";
 export type { InsertedCheckoutEntry } from "./config/insertCheckoutEntry.ts";