@sheetpane/grid 0.3.0 → 0.4.0

package/dist/web-types.json

@@ -1,7 +1,7 @@
 {
   "$schema": "https://raw.githubusercontent.com/JetBrains/web-types/master/schema/web-types.json",
   "name": "@sheetpane/grid",
-  "version": "0.3.0",
+  "version": "0.4.0",
   "description-markup": "markdown",
   "js-types-syntax": "typescript",
   "contributions": {
@@ -156,6 +156,76 @@
                   "name": "off"
                 }
               ]
+            },
+            {
+              "name": "ref",
+              "description": "The cell or range selected once a file is read, scrolled into view: `B4`, `Data!B4`, `'Q3 data'!B4:D8`; setting it later selects it then. One that names no cell is warned (SP-3019) and the sheet opens at A1. React, Vue and Solid keep `ref` for their own refs — set it with `setAttribute`.",
+              "value": {
+                "type": "string",
+                "kind": "plain"
+              }
+            },
+            {
+              "name": "link",
+              "description": "`none` (the default) or `hash`: the selection is kept in the URL fragment as `#sheetpane=<pane>:<Sheet>!<ref>`, read when a file is read and on back and forward, and *Copy link* joins the cell menu. The rest of the fragment is the host's and is kept as it was.",
+              "default": "none",
+              "value": {
+                "type": "'none' | 'hash'",
+                "kind": "plain"
+              },
+              "values": [
+                {
+                  "name": "none"
+                },
+                {
+                  "name": "hash"
+                }
+              ]
+            },
+            {
+              "name": "results",
+              "description": "`summary` (the default), `marks` or `off`: how `pass` and `skipped` results show, pane-wide (W-50).",
+              "default": "summary",
+              "value": {
+                "type": "'summary' | 'marks' | 'off'",
+                "kind": "plain"
+              },
+              "values": [
+                {
+                  "name": "summary"
+                },
+                {
+                  "name": "marks"
+                },
+                {
+                  "name": "off"
+                }
+              ]
+            },
+            {
+              "name": "layers",
+              "description": "Space-separated review layers to show (W-51); none shows every layer. Shared by the pane's elements.",
+              "value": {
+                "type": "string",
+                "kind": "plain"
+              }
+            },
+            {
+              "name": "protection",
+              "description": "`honour` (the default) or `ignore`: whether a protected sheet's locked cells refuse edits and a protected structure keeps its sheets, pane-wide (W-62). `ignore` is the host's decision; the file is unchanged.",
+              "default": "honour",
+              "value": {
+                "type": "'honour' | 'ignore'",
+                "kind": "plain"
+              },
+              "values": [
+                {
+                  "name": "honour"
+                },
+                {
+                  "name": "ignore"
+                }
+              ]
             }
           ],
           "slots": [
@@ -181,11 +251,21 @@
                 "type": "readonly ErrorType[]",
                 "description": "The types offered in the Flag issue form; an empty list falls back to `DEFAULT_ERROR_TYPES`."
               },
+              {
+                "name": "renderDetail",
+                "type": "RenderDetail | undefined",
+                "description": "The host's extra detail for an error (W-68): called with a copy of the error when its card opens in the sheet, and\ndrawn after the message in a `part=\"detail\"` region. A string is text, never HTML; a Node is the host's own. Called\nagain only when the error changes (its `meta` included) or this is replaced; a throw is logged as SP-3017. Set it on\neach element that should show it — `<sheetpane-errors>` has its own."
+              },
               {
                 "name": "file",
                 "type": "File | Blob | ArrayBuffer | Uint8Array | null",
                 "description": "Loads a file, like `load()`; `null` does nothing."
               },
+              {
+                "name": "layers",
+                "type": "string[]",
+                "description": "The review layers shown (W-51) — the pane's, shared with `<sheetpane-errors>`: every layer until the `layers`\nattribute or the switch names some. Setting it sets the attribute; `null` or `[]` shows every layer."
+              },
               {
                 "name": "mode",
                 "type": "Mode",
@@ -206,6 +286,16 @@
                 "type": "'on' | 'off'",
                 "description": "`flagging=\"off\"`: no Flag issue anywhere, no composer, no callout card — the errors panel is the one place errors are read."
               },
+              {
+                "name": "results",
+                "type": "ResultsLevel",
+                "description": "The pane's results level (W-50): `summary` (the default), `marks` or `off`; setting it sets the `results` attribute."
+              },
+              {
+                "name": "protection",
+                "type": "ProtectionMode",
+                "description": "The pane's protection mode (W-62): `honour` (the default) keeps the file's protection; `ignore` is the host's decision. Setting it sets the `protection` attribute."
+              },
               {
                 "name": "columns",
                 "type": "ColumnRules | undefined",
@@ -235,23 +325,38 @@
                 "name": "src",
                 "type": "string | null",
                 "description": "The `src` attribute; `null`, `undefined` or `''` removes it."
+              },
+              {
+                "name": "ref",
+                "type": "string | null",
+                "description": "The `ref` attribute: the cell or range selected once a file is read (W-66); `null`, `undefined` or `''` removes it."
+              },
+              {
+                "name": "link",
+                "type": "'none' | 'hash'",
+                "description": "`none` (the default) or `hash`: the selection kept in the URL fragment, and *Copy link* in the cell menu (W-66)."
               }
             ],
             "events": [
               {
                 "name": "sheetpane-load",
-                "type": "CustomEvent<{ status: 'ready'; name: string; kind: 'xlsx' | 'csv'; sheets: string[]; readMs: number } | { status: 'error'; code: string; spCode: SpCode; message: string; name: string; detail?: string }>",
-                "description": "`{ status: 'ready', name, kind, sheets, readMs }` when a file is read, or the refusal `{ status: 'error', code, spCode, message, name, detail? }`."
+                "type": "CustomEvent<{ status: 'ready'; name: string; kind: 'xlsx' | 'csv'; sheets: string[]; readMs: number; sha256: string | undefined } | { status: 'error'; code: string; spCode: SpCode; message: string; name: string; detail?: string }>",
+                "description": "`{ status: 'ready', name, kind, sheets, readMs, sha256 }` when a file is read (`sha256`: the file's SHA-256, W-65), or the refusal `{ status: 'error', code, spCode, message, name, detail? }`."
               },
               {
                 "name": "sheetpane-change",
-                "type": "CustomEvent<{ sheet: string; ref: string; kind: ChangeKind; was: unknown; now: unknown }>",
-                "description": "`{ sheet, ref, kind, was, now }` for each change, undo and redo included."
+                "type": "CustomEvent<{ sheet: string; ref: string; kind: ChangeKind; was: unknown; now: unknown; op?: 'insertRows' | 'deleteRows' | 'insertCols' | 'deleteCols'; at?: number; count?: number }>",
+                "description": "`{ sheet, ref, kind, was, now, op?, at?, count? }` for each change, undo and redo included; rows or columns inserted or deleted (W-52) are one event, `kind: 'structure'`, with `op`, `at` (0-based) and `count`."
               },
               {
                 "name": "sheetpane-errors",
-                "type": "CustomEvent<{ errors: SheetpaneError[]; plugins: string[] }>",
-                "description": "`{ errors, plugins }` when the pane's errors change."
+                "type": "CustomEvent<{ v: 2; errors: SheetpaneError[]; plugins: string[]; layers: string[]; changed: string[] }>",
+                "description": "`{ v, errors, plugins, layers, changed }` when the pane's errors change — the envelope to save a review (`v: 2`, W-51); `changed` names the layers whose errors changed."
+              },
+              {
+                "name": "sheetpane-layers",
+                "type": "CustomEvent<{ visible: string[]; layers: string[] }>",
+                "description": "`{ visible, layers }` when the visible review layers change (W-51)."
               },
               {
                 "name": "sheetpane-select",
@@ -268,6 +373,11 @@
                 "type": "CustomEvent<{ sheet: string; axis: 'col' | 'row'; indexes: number[]; px: number | number[]; via: 'drag' | 'fit' | 'menu' | 'reset' }>",
                 "description": "`{ sheet, axis, indexes, px, via }` when a column width or row height is set by a drag, a fit, the header menu or a reset — on release, never during a drag (W-47)."
               },
+              {
+                "name": "sheetpane-hover",
+                "type": "CustomEvent<{ sheet: string; ref: string; column: { index: number; letter: string; header: string } } | null>",
+                "description": "`{ sheet, ref, column }` when a mouse or pen pointer moves onto another cell (a merge's top-left), at most once per frame, or `null` when it leaves the cells; never for a finger (W-56)."
+              },
               {
                 "name": "sheetpane-sheet",
                 "type": "CustomEvent<{ sheet: string }>",
@@ -285,8 +395,8 @@
               },
               {
                 "name": "sheetpane-editstart",
-                "type": "CustomEvent<{ sheet: string; ref: string; column: { index: number; letter: string; header: string }; value: unknown }>",
-                "description": "`{ sheet, ref, column, value }` before a cell edit starts; cancellable — the cell stays read-only."
+                "type": "CustomEvent<{ sheet: string; ref: string; column: { index: number; letter: string; header: string }; value: unknown; richText?: true }>",
+                "description": "`{ sheet, ref, column, value, richText?: true }` before a cell edit starts (`richText: true` on a rich-text cell, whose edit saves plain text — W-53); cancellable — the cell stays read-only."
               },
               {
                 "name": "sheetpane-input",
@@ -300,13 +410,13 @@
               },
               {
                 "name": "sheetpane-editcancel",
-                "type": "CustomEvent<{ sheet: string; ref: string } | { sheet: string; ref: string; reason: 'blocked'; code: 'SP-6003'; message: string }>",
-                "description": "`{ sheet, ref }` when Esc restores a draft, or `{ sheet, ref, reason: 'blocked', code: 'SP-6003', message }` when a `block` rule refuses it."
+                "type": "CustomEvent<{ sheet: string; ref: string } | { sheet: string; ref: string; reason: 'blocked'; code: 'SP-6003'; message: string } | { sheet: string; ref: string; reason: 'locked'; code: 'SP-3026'; message: string }>",
+                "description": "`{ sheet, ref }` when Esc restores a draft, `{ sheet, ref, reason: 'blocked', code: 'SP-6003', message }` when a `block` rule refuses it, or `{ sheet, ref, reason: 'locked', code: 'SP-3026', message }` when the cell is locked on a protected sheet (W-62)."
               },
               {
                 "name": "sheetpane-export",
-                "type": "CustomEvent<{ blob: Blob; kind: 'xlsx' | 'csv'; name: string; guarded: string[] | false; format: 'xlsx' | 'csv'; converted: boolean; original?: boolean }>",
-                "description": "`{ blob, kind, name, guarded, format, converted, original? }` on `export()` and Download; cancellable — the Download control then saves nothing."
+                "type": "CustomEvent<{ blob: Blob; kind: 'xlsx' | 'csv'; name: string; guarded: string[] | false; format: 'xlsx' | 'csv'; converted: boolean; sha256: string | undefined; original?: boolean }>",
+                "description": "`{ blob, kind, name, guarded, format, converted, sha256, original? }` on `export()` and Download (`sha256`: the blob's SHA-256, W-65); cancellable — the Download control then saves nothing."
               },
               {
                 "name": "sheetpane-close",
@@ -340,6 +450,10 @@
               {
                 "name": "dialog",
                 "description": "The modal `<dialog>` the root moves into when `display=\"popup\"`."
+              },
+              {
+                "name": "detail",
+                "description": "The host's region in the error card, after the message: what `renderDetail` returns (W-68)."
               }
             ],
             "properties": [
@@ -401,12 +515,16 @@
               },
               {
                 "name": "--sp-pass",
-                "description": "Resolved, passing. Dark theme: `#86B399`. Default: `#16703E`."
+                "description": "Resolved, passing; the ✓ result mark. Dark theme: `#86B399`. Default: `#16703E`."
               },
               {
                 "name": "--sp-pass-soft",
                 "description": "Resolved, passing — the tint. Dark theme: `#163225`. Default: `#E6F2EA`."
               },
+              {
+                "name": "--sp-skip",
+                "description": "Not checked: the — result mark (W-50). Dark theme: `#A1A1A1`. Default: `#63666E`."
+              },
               {
                 "name": "--sp-fail",
                 "description": "Errors. Dark theme: `#D2827B`. Default: `#B42318`."
@@ -505,7 +623,7 @@
             },
             {
               "name": "readonly",
-              "description": "Hides the form, Resolve, Delete, Undo and Redo (a sign-off screen).",
+              "description": "Hides the form, Resolve, Accept…, Delete, Undo and Redo (a sign-off screen).",
               "value": {
                 "type": "boolean",
                 "kind": "no-value"
@@ -513,7 +631,7 @@
             },
             {
               "name": "author",
-              "description": "Written into the errors this element's user adds.",
+              "description": "Written into the errors this element's user adds, and as who accepted one (W-69).",
               "value": {
                 "type": "string",
                 "kind": "plain"
@@ -546,6 +664,34 @@
                   "name": "auto"
                 }
               ]
+            },
+            {
+              "name": "results",
+              "description": "`summary` (the default), `marks` or `off`: how `pass` and `skipped` results show, pane-wide (W-50).",
+              "default": "summary",
+              "value": {
+                "type": "'summary' | 'marks' | 'off'",
+                "kind": "plain"
+              },
+              "values": [
+                {
+                  "name": "summary"
+                },
+                {
+                  "name": "marks"
+                },
+                {
+                  "name": "off"
+                }
+              ]
+            },
+            {
+              "name": "layers",
+              "description": "Space-separated review layers to show (W-51); none shows every layer. Shared by the pane's elements; with two or more layers the header shows a switch.",
+              "value": {
+                "type": "string",
+                "kind": "plain"
+              }
             }
           ],
           "slots": [],
@@ -575,13 +721,38 @@
                 "name": "theme",
                 "type": "Theme",
                 "description": "`light` (the default), `dark` or `auto` — the same tokens as the sheet (W-29)."
+              },
+              {
+                "name": "renderDetail",
+                "type": "RenderDetail | undefined",
+                "description": "The host's extra detail for an error (W-68): called with a copy of the error when its row is opened, and drawn after\nthe message in a `part=\"detail\"` region. A string is text, never HTML; a Node is the host's own. Called again only when\nthe error changes (its `meta` included) or this is replaced; a throw is logged as SP-3017. Set it on each element\nthat should show it — the sheet's error card has its own."
+              },
+              {
+                "name": "results",
+                "type": "ResultsLevel",
+                "description": "The pane's results level (W-50): `summary` (the default), `marks` or `off`; setting it sets the `results` attribute."
+              },
+              {
+                "name": "layers",
+                "type": "string[]",
+                "description": "The review layers shown (W-51) — the pane's, shared with `<sheetpane-excel>`: every layer until the `layers`\nattribute or the switch names some. Setting it sets the attribute; `null` or `[]` shows every layer."
+              },
+              {
+                "name": "layerNames",
+                "type": "Readonly<Record<string, string>>",
+                "description": "What the switch and the rows call each layer (W-51), e.g. `{ pdf: 'PDF check' }`; a layer not named here shows its name (`review` as *Review*)."
               }
             ],
             "events": [
               {
                 "name": "sheetpane-errors",
-                "type": "CustomEvent<{ errors: SheetpaneError[]; plugins: string[] }>",
-                "description": "`{ errors, plugins }` when the pane's errors change — the envelope to save a review."
+                "type": "CustomEvent<{ v: 2; errors: SheetpaneError[]; plugins: string[]; layers: string[]; changed: string[] }>",
+                "description": "`{ v, errors, plugins, layers, changed }` when the pane's errors change — the envelope to save a review (`v: 2`, W-51); `changed` names the layers whose errors changed."
+              },
+              {
+                "name": "sheetpane-layers",
+                "type": "CustomEvent<{ visible: string[]; layers: string[] }>",
+                "description": "`{ visible, layers }` when the visible review layers change — the switch or the `layers` attribute (W-51)."
               },
               {
                 "name": "sheetpane-change",
@@ -601,7 +772,7 @@
               {
                 "name": "sheetpane-reveal",
                 "type": "CustomEvent<{ error: SheetpaneError }>",
-                "description": "`{ error }` on Show in sheet, so the host can switch tab or open the pop-up."
+                "description": "`{ error }` on Show in sheet, so the host can switch tab or open the pop-up — for a whole-sheet error too (its tab is opened); never for a workbook-level one (W-55); for a result group's Show ▸, its first entry (W-50)."
               }
             ]
           },
@@ -610,6 +781,10 @@
               {
                 "name": "root",
                 "description": "The panel's frame: the header, the form, the filters and the list."
+              },
+              {
+                "name": "detail",
+                "description": "The host's region in an open row, after the message: what `renderDetail` returns (W-68)."
               }
             ],
             "properties": [
@@ -671,12 +846,16 @@
               },
               {
                 "name": "--sp-pass",
-                "description": "Resolved, passing. Dark theme: `#86B399`. Default: `#16703E`."
+                "description": "Resolved, passing; the ✓ result mark. Dark theme: `#86B399`. Default: `#16703E`."
               },
               {
                 "name": "--sp-pass-soft",
                 "description": "Resolved, passing — the tint. Dark theme: `#163225`. Default: `#E6F2EA`."
               },
+              {
+                "name": "--sp-skip",
+                "description": "Not checked: the — result mark (W-50). Dark theme: `#A1A1A1`. Default: `#63666E`."
+              },
               {
                 "name": "--sp-fail",
                 "description": "Errors. Dark theme: `#D2827B`. Default: `#B42318`."
@@ -822,12 +1001,16 @@
         },
         {
           "name": "--sp-pass",
-          "description": "Resolved, passing. Dark theme: `#86B399`. Default: `#16703E`."
+          "description": "Resolved, passing; the ✓ result mark. Dark theme: `#86B399`. Default: `#16703E`."
         },
         {
           "name": "--sp-pass-soft",
           "description": "Resolved, passing — the tint. Dark theme: `#163225`. Default: `#E6F2EA`."
         },
+        {
+          "name": "--sp-skip",
+          "description": "Not checked: the — result mark (W-50). Dark theme: `#A1A1A1`. Default: `#63666E`."
+        },
         {
           "name": "--sp-fail",
           "description": "Errors. Dark theme: `#D2827B`. Default: `#B42318`."

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sheetpane/grid",
-  "version": "0.3.0",
+  "version": "0.4.0",
   "description": "View and edit .xlsx and .csv files inside any web page: the <sheetpane-excel> and <sheetpane-errors> web components, always in sync through one in-memory workbook.",
   "license": "MIT",
   "repository": {
@@ -22,6 +22,14 @@
       "types": "./dist/index.d.ts",
       "import": "./dist/index.js"
     },
+    "./check": {
+      "types": "./dist/check.d.ts",
+      "import": "./dist/check.js"
+    },
+    "./static": {
+      "types": "./dist/static.d.ts",
+      "import": "./dist/static.js"
+    },
     "./style.css": "./dist/style.css",
     "./rules.schema.json": "./dist/rules.schema.json",
     "./llms.txt": "./dist/llms.txt",
@@ -53,9 +61,9 @@
   "customElements": "custom-elements.json",
   "web-types": "./dist/web-types.json",
   "dependencies": {
-    "@sheetpane/export": "0.3.0",
-    "@sheetpane/skills": "0.3.0",
-    "@sheetpane/import": "0.3.0"
+    "@sheetpane/export": "0.4.0",
+    "@sheetpane/import": "0.4.0",
+    "@sheetpane/skills": "0.4.0"
   },
   "publishConfig": {
     "access": "public"