@popcorn245/cornfield-components 0.50.1 → 0.51.0

package/dist/manifest.json

@@ -1,16 +1,31 @@
 {
   "name": "@popcorn245/cornfield-components",
-  "cornfield": "0.50.1",
+  "cornfield": "0.51.0",
   "files": [
     {
-      "path": "chunks/_corn-default-tokens-DfrjTpZt.js",
-      "bytes": 142014,
-      "sha256": "1d8cd96b3fc891679898e0c5062e978ff590c33345666ac6253590919f949657"
+      "path": "chunks/corn-map-B240mjGE.js",
+      "bytes": 6979,
+      "sha256": "53722f2158fd675f1a208dcea77124f4b7d22482e765a7e80b5bd2ffd72e65b0"
     },
     {
-      "path": "chunks/corn-map-Bd7PO6yD.js",
-      "bytes": 94825,
-      "sha256": "4ae154ba31412f99da0cfeeaf83cea781dae8dbfc76efcc68acffedd4407e2f2"
+      "path": "chunks/corn-review-CJ4u6APS.js",
+      "bytes": 261309,
+      "sha256": "ec4cba41f778fe3e3fc0ef6504bfb4bea087f7bbb0af8f627b7e6e3f4431cdd1"
+    },
+    {
+      "path": "chunks/engine-ClfnAsgM.js",
+      "bytes": 142410,
+      "sha256": "ad758cc528e95bc8ae395f93ea3bbe38527706519da1f34d4d9cacde1cbd3a9e"
+    },
+    {
+      "path": "chunks/map-B6AeKeiu.js",
+      "bytes": 88136,
+      "sha256": "8caee9e232d7dc805f52bd2bd9212419779873d1d8cea4eba6e2d2687e6ecaeb"
+    },
+    {
+      "path": "chunks/review-source-CPiFTfyc.js",
+      "bytes": 1482,
+      "sha256": "da3b37a1c67688434275fad6e93ec17627bbae2800d3c76e3a86de3b12dd7263"
     },
     {
       "path": "chunks/rolldown-runtime-CGnMp29N.js",
@@ -23,40 +38,60 @@
       "sha256": "47327281b56616b00075dd5e4b52c0142fc3414509eb8258d9b98c8b56fc372d"
     },
     {
-      "path": "chunks/scope-HD2C0JDl.js",
-      "bytes": 26321,
-      "sha256": "7113aad6c230c9c7273cbbf30918b993f6141fbcf6487ee2c3b6e53dbcb3d864"
+      "path": "chunks/scope-Dg_uzefP.js",
+      "bytes": 3769,
+      "sha256": "047c0e94e994c373aa523a94b2278bcd4fc14543d4f4d170484b352a6770713d"
+    },
+    {
+      "path": "chunks/source-address-B7hYRgt8.js",
+      "bytes": 7608,
+      "sha256": "0a6a5d2f692df54c69173cc2304a4f640e80506212bed977c7f58354ba44cdf9"
+    },
+    {
+      "path": "chunks/status-CYQD5PwL.js",
+      "bytes": 19929,
+      "sha256": "7bd89b233cab9f3d05a0962dfea5b73edba9c4065cfd3de9c96b1feaff8995cd"
     },
     {
       "path": "corn-map.js",
       "bytes": 62,
-      "sha256": "6a8ad8370d2718f03d2b2829429a485f04a19cb5bc3b80a45a3e33beab13eed7"
+      "sha256": "d656967bf3a395cf07e00a511f6d44d663e9a19028e0276e1c3b0f48397d0af5"
+    },
+    {
+      "path": "corn-review.js",
+      "bytes": 68,
+      "sha256": "8df8767d56569407b96ced24a4726d72c467524881d1f09b6364b5137de367bb"
     },
     {
       "path": "corn-scope.js",
-      "bytes": 1891,
-      "sha256": "ee292dcbcffe996991e7acf3ab06a195c3ccfe20235858cb3d08b47143b07b41"
+      "bytes": 1877,
+      "sha256": "6e1dfdad6dacc0f61f7479f3c954011708f57b20d705ba0cb66a42a544ef3298"
     },
     {
       "path": "index.js",
-      "bytes": 195,
-      "sha256": "914e13d675aaebf5c4e767c0f1ea0f58433f5cf8634b00f6750e6c4a9d15e0f5"
+      "bytes": 266,
+      "sha256": "299dae60889a385c7d68bedf649df2dedbc18c423e4463207c64c428af42d0cb"
     },
     {
       "path": "tokens.css",
-      "bytes": 22404,
-      "sha256": "b7b3770c02d54dc4b143363051a9a4ee553231d595fcf8102927d2e42876ffd7"
+      "bytes": 22475,
+      "sha256": "585ea930140d195b2f6c5903caf3c5b68e66d1f94e595e124647f6ae5d148dfa"
     },
     {
       "path": "types/components.d.ts",
-      "bytes": 11230,
-      "sha256": "200e1fc27f2e3c6fccbdf4e639e3290545ac37c80f264b3f33fd282c670d4a87"
+      "bytes": 22051,
+      "sha256": "87bb200f744029296d8f7ba3215a3f12b2a0e023efb83b54e525d8bf2f7865f8"
     },
     {
       "path": "types/corn-map.d.ts",
       "bytes": 126,
       "sha256": "55a73109062f33a77cfb61cd01a3c26241112518b4c09b3e27655be1c6e9f08d"
     },
+    {
+      "path": "types/corn-review.d.ts",
+      "bytes": 135,
+      "sha256": "c574859c4b1b1abed9b0ba51a8b36a99da358b861036e5e7e6afb433b398fc05"
+    },
     {
       "path": "types/corn-scope.d.ts",
       "bytes": 132,
@@ -64,13 +99,13 @@
     },
     {
       "path": "types/index.d.ts",
-      "bytes": 365,
-      "sha256": "3a88ac322244901600af3ab8b7f2772b672e6e535a048840ef61825c11fc58af"
+      "bytes": 467,
+      "sha256": "08157585330a32ea501785334c388249a88d58b9775023299ac0c92e67e25fed"
     },
     {
       "path": "version.json",
       "bytes": 65,
-      "sha256": "faf1c1a4214c40217b5f38c3c610c2e8c45cdd77bb145442f33afc126ffa1b98"
+      "sha256": "88fe18fdf80be56814b4f599260ad191d0134c1eccfe2352346ab509e549bdc6"
     }
   ]
 }

package/dist/tokens.css

@@ -315,6 +315,7 @@
 
 /* theme="light" on an element: this mode's tokens, on the element itself */
 :where(corn-map[theme="light"]),
+:where(corn-review[theme="light"]),
 :where(corn-scope[theme="light"]) {
   --corn-ground: #f4f6fa;
   --corn-ground-image: radial-gradient(circle at 14% 18%, rgba(66, 153, 225, 0.06) 0%, transparent 45%),
@@ -433,6 +434,7 @@
 
 /* theme="dark" on an element: this mode's tokens, on the element itself */
 :where(corn-map[theme="dark"]),
+:where(corn-review[theme="dark"]),
 :where(corn-scope[theme="dark"]) {
   --corn-ground: #090d16;
   --corn-ground-image: radial-gradient(circle at 14% 18%, rgba(66, 153, 225, 0.2) 0%, transparent 45%),

package/dist/types/components.d.ts

@@ -26,6 +26,59 @@ export interface CornSelectDetail {
   to?: string;
 }
 
+export interface CornDecisionDetail {
+  /** `approved`, or `notes` for a send back */
+  outcome: 'approved' | 'notes';
+  /** The proposal the decision was for, by name (the one that was open when the button was pressed), or null for a proposal that has no name */
+  proposal: string | null;
+  /** The copy of it the decision was for (`pull/31`), or null */
+  source: string | null;
+  /** Whether that proposal is still the one shown: false when another was opened, or this one closed, while the decision was sent */
+  open: boolean;
+  /** What the server answered */
+  review: CornReviewRecord;
+}
+
+export interface CornNavigateDetail {
+  /** The proposal's name, or null once it is closed (or for a proposal handed in as an object with no name) */
+  proposal: string | null;
+  /** The copy of it that was asked for by name (`checkout`, `pull/31`, a worktree), only when it was; null otherwise, as cornfield's page leaves it out of the address */
+  source: string | null;
+  /** `before`, `diff` or `after`, or null once the proposal is closed */
+  view: 'before' | 'diff' | 'after' | null;
+  /** `opened` (a proposal opened), `view` (Before, Diff or After changed) or `closed` */
+  change: 'opened' | 'view' | 'closed';
+}
+
+export interface CornReviewAuthDetail {
+  /** 401 or 403 */
+  status: number;
+  /** `<src>/auth/start?returnTo=<this page's address>`: a link the host or the piece puts in front of the person; the component never navigates the window */
+  signIn: string;
+  /** What was refused: `load` (the map), `proposal` (opening it), `facts` (the line above Approve), `review` (reading the last decision), `send` (the press itself) or `landing` (Undo of the hold) */
+  during: 'load' | 'proposal' | 'facts' | 'review' | 'send' | 'landing';
+}
+
+export interface CornReviewErrorDetail {
+  /** `not-listed` (the server gave this page no CORS answer: its origin is not in `embed.origins`), `offline`, `server` (it answered with something that is not a config or a map), `address` (`src` is not an http(s) address), `version` (the package and the server differ by a minor or more; it keeps working), `theme` (the server's theme could not be had) or `proposal` (the proposal did not open: no such proposal, or the server refused) */
+  kind: 'not-listed' | 'offline' | 'server' | 'address' | 'version' | 'theme' | 'proposal';
+  /** A few words more, plain text: the origin to list, the problem with the address, the two versions, what the proposal's bar says */
+  message?: string;
+}
+
+export interface CornReviewRecord {
+  /** `approved` or `notes` (a send back) */
+  verdict: 'approved' | 'notes';
+  /** When the server took it, an ISO time */
+  at: string;
+  /** Who it is recorded as: the signed-in maintainer */
+  by?: string;
+  /** false when the same approval stood already and the server posted nothing new */
+  posted?: boolean;
+  /** Anything else the server says about it */
+  [key: string]: unknown;
+}
+
 export namespace Components {
   interface CornMap {
     /** The map to draw: the object topology.json holds (`{ nodes, edges }`). The object is not changed; the map works on copies. */
@@ -49,6 +102,36 @@ export namespace Components {
     /** Reads the tokens again and draws: for a token changed at run time by something the map cannot see (a rule added to the page's head, a class on `<html>`) */
     'refresh': () => Promise<void>;
   }
+  interface CornReview {
+    /** The base address of a cornfield server, `https://map.example.com` (an http(s) origin with an optional path): the review reads the config and the map from there, opens the proposal, and sends its decision, with the signed-in maintainer's session. Another value is refused, and said in the box and in `cornError`. Read when the element connects: a new `src` makes a new review. */
+    'src'?: string | undefined;
+    /** The proposal to review: its name (`0042-retire-the-old-export`), which the review reads from the server, or, as a property only, the proposal object itself (shown for reading: a decision needs the name). It follows the reviewer: null once they close it in the bar, the name of a copy they open from it. Not reflected. */
+    'proposal'?: string | { [key: string]: unknown } | null | undefined;
+    /** Which copy of the proposal: `checkout`, `pull/31` (a spec PR) or a worktree's name; with none the server answers with the first it lists */
+    'source'?: string | null | undefined;
+    /** `before`, `diff` or `after`. Set it to choose; it follows the reviewer's own choice (the buttons on the bar) and is reflected as an attribute. */
+    'view'?: 'before' | 'diff' | 'after' | null | undefined;
+    /** The id of the selected node. Set it to select; it follows the map's selection (a click, a key) and is reflected as an attribute. */
+    'node'?: string | null | undefined;
+    /** The ground the review is drawn for: `light` or `dark` forces it for this element, `auto` (or none) follows the page's own `data-theme` or the system's setting */
+    'theme'?: 'light' | 'dark' | 'auto' | undefined;
+    /** With `src`: wear the server's theme (its stylesheet in this shadow root and its `--corn-*` tokens on this element). Off by default: a host app has its own look. */
+    'useTheme': boolean;
+    /** The map to draw, for a host that fetches for itself: the object `topology.json` holds. With it and `config` the review reads no map from the server. */
+    'topology'?: { nodes: Array<{ id: string; [key: string]: unknown }>; edges?: Array<{ from: string; to: string; [key: string]: unknown }> } | null | undefined;
+    /** The object `/cornfield/config.json` holds, for a host that fetches for itself */
+    'config'?: { [key: string]: unknown } | null | undefined;
+    /** The words the host overrides (a flat map of `strings` keys to text); they win over the server's */
+    'strings'?: { [key: string]: string } | null | undefined;
+    /** The permission checker for the scenarios, a module the host imported itself: `{ check(items, { signal }) }`. A config never names one that is loaded (D10); with none, a checked step reads "Not checked". */
+    'checker'?: { check(items: unknown[], options?: { signal?: AbortSignal }): unknown; apps?: unknown; max?: number } | null | undefined;
+    /** Puts the whole map in view */
+    'fit': () => Promise<void>;
+    /** Selects the node with this id and brings it into view; nothing happens when the map has no such node */
+    'focusNode': (id: string) => Promise<void>;
+    /** Reads the tokens again and draws: for a token changed at run time by something the review cannot see (a rule added to the page's head, a class on `<html>`) */
+    'refresh': () => Promise<void>;
+  }
   interface CornScope {
     /** The base address of a cornfield server, `https://map.example.com` (an http(s) origin with an optional path). Another value is refused, and said in the pieces and in `cornError`. */
     'src'?: string | undefined;
@@ -70,6 +153,11 @@ export interface CornMapCustomEvent<T> extends CustomEvent<T> {
   target: HTMLCornMapElement;
 }
 
+export interface CornReviewCustomEvent<T> extends CustomEvent<T> {
+  detail: T;
+  target: HTMLCornReviewElement;
+}
+
 export interface CornScopeCustomEvent<T> extends CustomEvent<T> {
   detail: T;
   target: HTMLCornScopeElement;
@@ -89,6 +177,25 @@ export namespace LocalJSX {
     'onCornAuth'?: (event: CornMapCustomEvent<CornAuthDetail>) => void;
     'onCornError'?: (event: CornMapCustomEvent<CornErrorDetail>) => void;
   }
+  interface CornReview {
+    'src'?: string | undefined;
+    'proposal'?: string | { [key: string]: unknown } | null | undefined;
+    'source'?: string | null | undefined;
+    'view'?: 'before' | 'diff' | 'after' | null | undefined;
+    'node'?: string | null | undefined;
+    'theme'?: 'light' | 'dark' | 'auto' | undefined;
+    'useTheme'?: boolean;
+    'topology'?: { nodes: Array<{ id: string; [key: string]: unknown }>; edges?: Array<{ from: string; to: string; [key: string]: unknown }> } | null | undefined;
+    'config'?: { [key: string]: unknown } | null | undefined;
+    'strings'?: { [key: string]: string } | null | undefined;
+    'checker'?: { check(items: unknown[], options?: { signal?: AbortSignal }): unknown; apps?: unknown; max?: number } | null | undefined;
+    'onCornReady'?: (event: CornReviewCustomEvent<void>) => void;
+    'onCornSelect'?: (event: CornReviewCustomEvent<CornSelectDetail>) => void;
+    'onCornNavigate'?: (event: CornReviewCustomEvent<CornNavigateDetail>) => void;
+    'onCornDecision'?: (event: CornReviewCustomEvent<CornDecisionDetail>) => void;
+    'onCornAuth'?: (event: CornReviewCustomEvent<CornReviewAuthDetail>) => void;
+    'onCornError'?: (event: CornReviewCustomEvent<CornReviewErrorDetail>) => void;
+  }
   interface CornScope {
     'src'?: string | undefined;
     'theme'?: 'light' | 'dark' | 'auto' | undefined;
@@ -102,6 +209,7 @@ export namespace LocalJSX {
   }
   interface IntrinsicElements {
     'corn-map': LocalJSX.CornMap & { [attribute: string]: unknown };
+    'corn-review': LocalJSX.CornReview & { [attribute: string]: unknown };
     'corn-scope': LocalJSX.CornScope & { [attribute: string]: unknown };
   }
 }
@@ -129,6 +237,32 @@ declare global {
   }
   var HTMLCornMapElement: { prototype: HTMLCornMapElement; new (): HTMLCornMapElement };
 
+  /** What `<corn-review>` sends: the event's name and the type of its `detail` */
+  interface HTMLCornReviewElementEventMap {
+    /** The first frame is drawn that shows the proposal asked for open, its title on the bar (or the bar saying why it is not): once per time the element is connected */
+    'cornReady': void;
+    /** The selection changed, whoever changed it: a click, a key, `node` or `focusNode()`. Once per change. */
+    'cornSelect': CornSelectDetail;
+    /** The open proposal, or its view, changed: what cornfield's own page would put in its address bar. The host decides what to do with it. */
+    'cornNavigate': CornNavigateDetail;
+    /** The server took a decision, Approve or Send back. Once per decision, after the server answered. */
+    'cornDecision': CornDecisionDetail;
+    /** The server wants the maintainer signed in (the read, or the press, was refused with 401 or 403). The review shows a link to `signIn`. */
+    'cornAuth': CornReviewAuthDetail;
+    /** Something the review could not do (see `kind`) */
+    'cornError': CornReviewErrorDetail;
+  }
+  /** The one-tag review (spec 0011 D4, D5, D6): a proposal on the map, what it changes, its scenarios, and Approve and Send back, in a shadow root. A thin shell (spec 0011 D1): it declares properties and events, mounts the engine's review piece (explorer/pieces/review.js) in its shadow root, passes each property change in, turns the piece's callbacks into events, and ends the piece when it leaves the page. It holds no behaviour (test/shell.test.ts fails if this file imports anything but the Stencil runtime, the engine's pieces and CSS, or grows past a shell). `src` is the address of a cornfield server it reads the map and the proposal from, and decides on, as the signed-in maintainer. It needs a height from its host. */
+  interface HTMLCornReviewElement extends Components.CornReview, HTMLElement {
+    addEventListener<K extends keyof HTMLCornReviewElementEventMap>(type: K, listener: (this: HTMLCornReviewElement, ev: CornReviewCustomEvent<HTMLCornReviewElementEventMap[K]>) => any, options?: boolean | AddEventListenerOptions): void;
+    addEventListener<K extends keyof HTMLElementEventMap>(type: K, listener: (this: HTMLCornReviewElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
+    addEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void;
+    removeEventListener<K extends keyof HTMLCornReviewElementEventMap>(type: K, listener: (this: HTMLCornReviewElement, ev: CornReviewCustomEvent<HTMLCornReviewElementEventMap[K]>) => any, options?: boolean | EventListenerOptions): void;
+    removeEventListener<K extends keyof HTMLElementEventMap>(type: K, listener: (this: HTMLCornReviewElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void;
+    removeEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void;
+  }
+  var HTMLCornReviewElement: { prototype: HTMLCornReviewElement; new (): HTMLCornReviewElement };
+
   /** What `<corn-scope>` sends: the event's name and the type of its `detail` */
   interface HTMLCornScopeElementEventMap {
     /** The scope has its data: read from the server, or handed in. Once per server. */
@@ -151,6 +285,7 @@ declare global {
 
   interface HTMLElementTagNameMap {
     'corn-map': HTMLCornMapElement;
+    'corn-review': HTMLCornReviewElement;
     'corn-scope': HTMLCornScopeElement;
   }
 }

package/dist/types/corn-review.d.ts

@@ -0,0 +1,2 @@
+export * from './components.js';
+export declare const CornReview: { prototype: HTMLCornReviewElement; new (): HTMLCornReviewElement };

package/dist/types/index.d.ts

@@ -2,4 +2,5 @@ export * from './components.js';
 /** The version of cornfield these components were built from (the server reports the same number) */
 export declare const version: string;
 export declare const CornMap: { prototype: HTMLCornMapElement; new (): HTMLCornMapElement };
+export declare const CornReview: { prototype: HTMLCornReviewElement; new (): HTMLCornReviewElement };
 export declare const CornScope: { prototype: HTMLCornScopeElement; new (): HTMLCornScopeElement };

package/dist/version.json

@@ -1 +1 @@
-{"name":"@popcorn245/cornfield-components","cornfield":"0.50.1"}
+{"name":"@popcorn245/cornfield-components","cornfield":"0.51.0"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@popcorn245/cornfield-components",
-  "version": "0.50.1",
+  "version": "0.51.0",
   "description": "cornfield's interface as web components (spec 0011): <corn-map> and what follows, thin StencilRS shells over the engine in cornfield. The same files are served by every cornfield server at /cornfield/components/.",
   "license": "MIT",
   "author": "popcorn245 (https://github.com/popcorn245)",
@@ -34,6 +34,10 @@
       "types": "./dist/types/corn-map.d.ts",
       "default": "./dist/corn-map.js"
     },
+    "./corn-review": {
+      "types": "./dist/types/corn-review.d.ts",
+      "default": "./dist/corn-review.js"
+    },
     "./corn-scope": {
       "types": "./dist/types/corn-scope.d.ts",
       "default": "./dist/corn-scope.js"