@fusion.dev/helix-headless 0.56.0 → 0.57.0

package/custom-elements.json

@@ -106748,492 +106748,182 @@
     },
     {
       "kind": "javascript-module",
-      "path": "src/video/root/captions.ts",
+      "path": "src/video/root/extra-controls.ts",
       "declarations": [
         {
           "kind": "function",
-          "name": "captionTracks",
+          "name": "offers",
           "return": {
             "type": {
-              "text": "TextTrack[]"
+              "text": "boolean"
             }
           },
           "parameters": [
             {
-              "name": "video",
+              "name": "one",
               "type": {
-                "text": "HTMLVideoElement | null"
+                "text": "string"
+              }
+            },
+            {
+              "name": "player",
+              "type": {
+                "text": "Conditions"
               }
             }
           ],
-          "description": "The tracks a reader could choose between, in the order they were written.\n\nFiltered by kind, because `textTracks` also carries `chapters`, `metadata`\nand `descriptions`, and a menu offering \"Chapters\" as a subtitle language\nwould be offering something that draws no words. Read off the video rather\nthan off the slot: a `<track>` added later is in one and not the other, and\nthe video is the one that has resolved them."
+          "description": "Whether this platform can do a named control at all."
         },
         {
           "kind": "function",
-          "name": "showCaption",
+          "name": "barControls",
           "return": {
             "type": {
-              "text": "void"
+              "text": "string[]"
             }
           },
           "parameters": [
             {
-              "name": "tracks",
+              "name": "written",
               "type": {
-                "text": "readonly TextTrack[]"
+                "text": "string"
               }
             },
             {
-              "name": "index",
+              "name": "player",
               "type": {
-                "text": "number"
+                "text": "Conditions"
               }
             }
           ],
-          "description": "Shows one track and disables every other, or shows none at `-1`.\n\nEvery other, rather than only the one that was on. Two tracks in `hidden`\nboth fire `cuechange`, so the rendered cue becomes whichever fired last and\na reader who switched language gets the two interleaved. Measured as two\nsubtitles alternating line by line.\n\n`hidden`, never `showing`. Hidden is the mode where a track still fires\n`cuechange` and still fills `activeCues`, and the browser draws nothing,\nwhich is exactly what is wanted when something else is doing the drawing."
+          "description": "The extras asked for, in order, and only the ones this platform can do."
         },
         {
           "kind": "function",
-          "name": "adoptTrack",
+          "name": "menuControls",
           "return": {
             "type": {
-              "text": "boolean"
+              "text": "string[]"
             }
           },
           "parameters": [
             {
-              "name": "track",
+              "name": "written",
               "type": {
-                "text": "TextTrack"
+                "text": "string"
               }
-            }
-          ],
-          "description": "Whether a track the platform started showing is now ours to draw.\n\nA `<track default>` arrives `showing`, which is the browser drawing it.\nMoved to `hidden` so the cues keep coming and we draw them instead. What\ncomes back is whether captions are on, which is not always \"off\": a button\nthat began there reported the opposite of what was on screen."
-        },
-        {
-          "kind": "function",
-          "name": "captionsAmong",
-          "return": {
-            "type": {
-              "text": "Caption[]"
-            }
-          },
-          "parameters": [
+            },
             {
-              "name": "media",
+              "name": "onBar",
+              "type": {
+                "text": "readonly string[]"
+              }
+            },
+            {
+              "name": "player",
               "type": {
-                "text": "readonly TrackCopy[]"
+                "text": "Conditions"
               }
             }
           ],
-          "description": "The caption tracks among the copies, before the render that draws them.\n\nBy the platform's own reading of `kind`, which is what makes a `<track>` a\ncaption at all: missing is `subtitles` and anything it does not know is\n`metadata`. Read from the video's tracks after the render instead, the count\narrived a render late and asked for one more. Choosing one still goes\nthrough the video's tracks, which hold them in the same order."
+          "description": "The controls asked for behind the overflow button, in order.\n\nA name in both lists is on the bar and not here. Drawing it twice is worse\nthan either placement, and the bar is the one a reader can see."
         },
         {
           "kind": "function",
-          "name": "activeCue",
+          "name": "ownFile",
           "return": {
             "type": {
-              "text": "DocumentFragment | undefined"
+              "text": "boolean"
             }
           },
           "parameters": [
             {
-              "name": "track",
-              "type": {
-                "text": "TextTrack | undefined"
-              }
-            }
-          ],
-          "description": "The cue on screen now, as nodes, or nothing between cues.\n\nNodes rather than a string, because `VTTCue.text` is the cue's *source*:\nWebVTT carries markup, and a caption file in the wild is full of it. `<v\nHildy>` names who is speaking, `<b>` and `<i>` and `<u>` mark emphasis, and\n`<c.loud>` classes a line. Rendered as text every one of those arrives on\nscreen as visible angle brackets.\n\n`getCueAsHTML` is the platform parsing its own format, so nothing here has\nto know the grammar and no cue text is ever treated as HTML: what comes\nback is a fragment the browser built, not a string anybody interpolated."
-        },
-        {
-          "kind": "class",
-          "description": "Listens to one track's cues at a time, so the next one can take it off.\n\nTaken off whatever it was on before adding it here. `follow` runs from\n`loadedmetadata`, which fires again for every source a reader moves to, and\na consumer adding a `<track>` later gets another. Added without removing, a\nplaylist of six left six listeners on tracks that between them fire for\nevery cue in the video.",
-          "name": "CueController",
-          "members": [
-            {
-              "kind": "field",
-              "name": "track",
+              "name": "src",
               "type": {
-                "text": "TextTrack | undefined"
-              },
-              "privacy": "private"
-            },
-            {
-              "kind": "method",
-              "name": "follow",
-              "return": {
-                "type": {
-                  "text": "void"
-                }
-              },
-              "parameters": [
-                {
-                  "name": "track",
-                  "type": {
-                    "text": "TextTrack"
-                  }
-                }
-              ]
-            },
-            {
-              "kind": "method",
-              "name": "hostDisconnected",
-              "return": {
-                "type": {
-                  "text": "void"
-                }
-              }
-            },
-            {
-              "kind": "method",
-              "name": "stop",
-              "privacy": "private",
-              "return": {
-                "type": {
-                  "text": "void"
-                }
+                "text": "string"
               }
             }
           ],
-          "helix": {}
+          "description": "Whether the file a `src` points at is the player's to hand over.\n\nHere because it is the download control's other condition: whether it is\ndrawn at all is `source`, and whether the `download` attribute on it means\nanything is this.\n\n`blob:` and `data:` named rather than compared, because the rule `download`\nactually follows is same-origin *or one of those two*: a clip a consumer\ngenerated in the page has no origin to match and is theirs to save by\ndefinition. Comparing origins alone called both foreign, so the one case\nwhere a download certainly works was the one case it was not offered."
         }
       ],
       "exports": [
         {
           "kind": "js",
-          "name": "captionTracks",
-          "declaration": {
-            "name": "captionTracks",
-            "module": "src/video/root/captions.ts"
-          }
-        },
-        {
-          "kind": "js",
-          "name": "showCaption",
-          "declaration": {
-            "name": "showCaption",
-            "module": "src/video/root/captions.ts"
-          }
-        },
-        {
-          "kind": "js",
-          "name": "adoptTrack",
+          "name": "offers",
           "declaration": {
-            "name": "adoptTrack",
-            "module": "src/video/root/captions.ts"
+            "name": "offers",
+            "module": "src/video/root/extra-controls.ts"
           }
         },
         {
           "kind": "js",
-          "name": "captionsAmong",
+          "name": "barControls",
           "declaration": {
-            "name": "captionsAmong",
-            "module": "src/video/root/captions.ts"
+            "name": "barControls",
+            "module": "src/video/root/extra-controls.ts"
           }
         },
         {
           "kind": "js",
-          "name": "activeCue",
+          "name": "menuControls",
           "declaration": {
-            "name": "activeCue",
-            "module": "src/video/root/captions.ts"
+            "name": "menuControls",
+            "module": "src/video/root/extra-controls.ts"
           }
         },
         {
           "kind": "js",
-          "name": "CueController",
+          "name": "ownFile",
           "declaration": {
-            "name": "CueController",
-            "module": "src/video/root/captions.ts"
+            "name": "ownFile",
+            "module": "src/video/root/extra-controls.ts"
           }
         }
       ]
     },
     {
       "kind": "javascript-module",
-      "path": "src/video/root/fullscreen.ts",
+      "path": "src/video/root/keys.ts",
       "declarations": [
         {
-          "kind": "class",
-          "description": "Into fullscreen and back, and honest about where the element is.\n\nThe state follows `fullscreenchange` rather than the request, so a refused\nrequest leaves a button that correctly reports \"not fullscreen\".",
-          "name": "FullscreenController",
-          "members": [
-            {
-              "kind": "method",
-              "name": "toggle",
-              "return": {
-                "type": {
-                  "text": "Promise<void>"
-                }
-              },
-              "description": "Into fullscreen and back, and quiet about being refused.\n\n`requestFullscreen` rejects rather than returning false, and the two\nrefusals a consumer will actually meet are a Permissions Policy that does\nnot grant `fullscreen` to the frame the player is in, and a call without\nuser activation. Both are `TypeError: Permissions check failed`, which is\nthe same message for two different causes.\n\nCaught rather than `void`ed, or a refusal becomes an unhandled rejection\nnaming neither the element nor the reason."
-            },
-            {
-              "kind": "method",
-              "name": "hostConnected",
-              "return": {
-                "type": {
-                  "text": "void"
-                }
-              }
-            },
-            {
-              "kind": "method",
-              "name": "hostDisconnected",
-              "return": {
-                "type": {
-                  "text": "void"
-                }
-              }
-            },
-            {
-              "kind": "field",
-              "name": "handleChange",
-              "privacy": "private",
-              "readonly": true
+          "kind": "function",
+          "name": "takeKey",
+          "return": {
+            "type": {
+              "text": "boolean"
             }
-          ],
-          "helix": {}
-        }
-      ],
-      "exports": [
-        {
-          "kind": "js",
-          "name": "FullscreenController",
-          "declaration": {
-            "name": "FullscreenController",
-            "module": "src/video/root/fullscreen.ts"
-          }
-        }
-      ]
-    },
-    {
-      "kind": "javascript-module",
-      "path": "src/video/root/idle.ts",
-      "declarations": [
-        {
-          "kind": "class",
-          "description": "How long the reader has been still, which decides when the bar goes.\n\nA wait rather than leaving with the pointer, or a reader moving across the\npicture to reach a control watches the bar vanish under them. The wait is\nonly ever about *idling*: whether a paused video keeps its bar is the\nelement's decision, and this only says when the reader stopped.\n\nThe delay is asked for on every restart rather than taken once, because it\nis a property the consumer can change while the video plays.",
-          "name": "IdleController",
-          "members": [
+          },
+          "parameters": [
             {
-              "kind": "field",
-              "name": "timer",
+              "name": "event",
               "type": {
-                "text": "ReturnType<typeof setTimeout> | undefined"
-              },
-              "privacy": "private"
-            },
-            {
-              "kind": "field",
-              "name": "stir",
-              "readonly": true,
-              "description": "Restarts the wait, on anything that counts as the reader being here.\n\nPointer movement and focus both count, and both have to: a reader using the\nkeyboard never moves a pointer, and a bar that only answered the mouse\nwould leave them nothing to look at. Zero turns the wait off and the bar\ngoes immediately; a large number keeps it up for as long as anyone is\nlikely to look."
-            },
-            {
-              "kind": "field",
-              "name": "leave",
-              "readonly": true,
-              "description": "Leaving is the one case that does not wait: the reader has gone somewhere\nelse, and there is nothing to reach for."
-            },
-            {
-              "kind": "method",
-              "name": "hostDisconnected",
-              "return": {
-                "type": {
-                  "text": "void"
-                }
+                "text": "KeyboardEvent"
               }
-            }
-          ],
-          "helix": {}
-        }
-      ],
-      "exports": [
-        {
-          "kind": "js",
-          "name": "IdleController",
-          "declaration": {
-            "name": "IdleController",
-            "module": "src/video/root/idle.ts"
-          }
-        }
-      ]
-    },
-    {
-      "kind": "javascript-module",
-      "path": "src/video/root/media-session.ts",
-      "declarations": [
-        {
-          "kind": "variable",
-          "name": "SKIP_SECONDS",
-          "type": {
-            "text": "number"
-          },
-          "default": "10",
-          "description": "How far a skip control moves, in seconds.\n\nTen, which is the number every player that has one uses, and the number the\nplatform names in `seekbackward` and `seekforward` when it hands over a\ndefault. A different length here would be correct only on this player."
-        },
-        {
-          "kind": "class",
-          "description": "Holds the page's media session for one player, and tells the platform what\nis playing.\n\nThe handlers are what make a headset's play, pause and skip work at all.\nWithout them a platform falls back to guessing which element was meant,\nwhich is right often enough to hide the fault and wrong exactly when there\nare two.",
-          "name": "MediaSessionController",
-          "members": [
-            {
-              "kind": "method",
-              "name": "claim",
-              "return": {
-                "type": {
-                  "text": "void"
-                }
-              },
-              "parameters": [
-                {
-                  "name": "metadata",
-                  "type": {
-                    "text": "{ artwork: string; title: string }"
-                  }
-                },
-                {
-                  "name": "handlers",
-                  "type": {
-                    "text": "SessionHandlers"
-                  }
-                }
-              ],
-              "description": "Takes the session.\n\nOn play rather than on render, which is the ownership rule: a page with two\nplayers gives the session to whichever one the reader started, so a\nheadset's buttons land on what they are listening to rather than on\nwhichever came first in the markup."
-            },
-            {
-              "kind": "method",
-              "name": "report",
-              "return": {
-                "type": {
-                  "text": "void"
-                }
-              },
-              "parameters": [
-                {
-                  "name": "playing",
-                  "type": {
-                    "text": "boolean"
-                  }
-                }
-              ],
-              "description": "Tells the platform whether the owner is playing, and nothing if it is not the owner."
             },
             {
-              "kind": "method",
-              "name": "hostDisconnected",
-              "return": {
-                "type": {
-                  "text": "void"
-                }
-              },
-              "description": "The page's one media session goes back to nobody, but only if this\nelement is the one holding it."
-            }
-          ],
-          "helix": {}
-        }
-      ],
-      "exports": [
-        {
-          "kind": "js",
-          "name": "SKIP_SECONDS",
-          "declaration": {
-            "name": "SKIP_SECONDS",
-            "module": "src/video/root/media-session.ts"
-          }
-        },
-        {
-          "kind": "js",
-          "name": "MediaSessionController",
-          "declaration": {
-            "name": "MediaSessionController",
-            "module": "src/video/root/media-session.ts"
-          }
-        }
-      ]
-    },
-    {
-      "kind": "javascript-module",
-      "path": "src/video/root/remote-playback.ts",
-      "declarations": [
-        {
-          "kind": "class",
-          "description": "Watches for something to play the video on, and stops on the way out.\n\nThe Remote Playback API is the standard one, and it is what Safari\nimplements for AirPlay and Chrome for Cast: one call covers both, where the\nolder `webkitShowPlaybackTargetPicker` covers only the first. Firefox has\nneither, and `remote` simply being absent is what turns the control off\nthere.\n\n`watchAvailability` returns an id that has to be canceled, or the callback\noutlives the element that owns it: a callback holding a removed element is a\nleak with a `@state` write on the end.",
-          "name": "RemotePlaybackController",
-          "members": [
-            {
-              "kind": "field",
               "name": "video",
               "type": {
-                "text": "HTMLVideoElement | undefined"
-              },
-              "privacy": "private"
+                "text": "HTMLVideoElement"
+              }
             },
             {
-              "kind": "field",
-              "name": "watch",
+              "name": "actions",
               "type": {
-                "text": "number | undefined"
-              },
-              "privacy": "private",
-              "description": "Cancels the availability watch, since it outlives a single render."
-            },
-            {
-              "kind": "method",
-              "name": "attach",
-              "return": {
-                "type": {
-                  "text": "Promise<void>"
-                }
-              },
-              "parameters": [
-                {
-                  "name": "video",
-                  "type": {
-                    "text": "HTMLVideoElement"
-                  }
-                }
-              ],
-              "description": "Starts watching the video, once there is one."
-            },
-            {
-              "kind": "method",
-              "name": "prompt",
-              "return": {
-                "type": {
-                  "text": "Promise<void>"
-                }
-              },
-              "description": "Opens the platform's own device picker. It has no list of its own."
-            },
-            {
-              "kind": "method",
-              "name": "hostDisconnected",
-              "return": {
-                "type": {
-                  "text": "void"
-                }
+                "text": "KeyActions"
               }
-            },
-            {
-              "kind": "field",
-              "name": "handleState",
-              "privacy": "private",
-              "readonly": true
             }
           ],
-          "helix": {}
+          "description": "Answers one press, and says whether it was one of these.\n\nNothing is taken while focus is in a range. The scrubber and the volume are\nreal inputs and the arrows are already theirs, so intercepting would mean\nseeking twice for one press."
         }
       ],
       "exports": [
         {
           "kind": "js",
-          "name": "RemotePlaybackController",
+          "name": "takeKey",
           "declaration": {
-            "name": "RemotePlaybackController",
-            "module": "src/video/root/remote-playback.ts"
+            "name": "takeKey",
+            "module": "src/video/root/keys.ts"
           }
         }
       ]
@@ -107625,16 +107315,6 @@
               "description": "What the play control is called while it would start the video.",
               "attribute": "play-label"
             },
-            {
-              "kind": "field",
-              "name": "localFile",
-              "type": {
-                "text": "boolean"
-              },
-              "privacy": "private",
-              "description": "Whether the file this points at is ours to hand over.\n\n`blob:` and `data:` named rather than compared, because the rule `download`\nactually follows is same-origin *or one of those two*: a clip a consumer\ngenerated in the page has no origin to match and is theirs to save by\ndefinition. Comparing origins alone called both foreign, so the one case\nwhere a download certainly works was the one case it was not offered.",
-              "readonly": true
-            },
             {
               "kind": "field",
               "name": "playsInline",
@@ -107881,23 +107561,14 @@
               "default": "new MediaSessionController(this)"
             },
             {
-              "kind": "method",
-              "name": "offers",
-              "privacy": "private",
-              "return": {
-                "type": {
-                  "text": "boolean"
-                }
+              "kind": "field",
+              "name": "conditions",
+              "type": {
+                "text": "Conditions"
               },
-              "parameters": [
-                {
-                  "name": "one",
-                  "type": {
-                    "text": "string"
-                  }
-                }
-              ],
-              "description": "Whether this platform can do a named control at all."
+              "privacy": "private",
+              "description": "What the roster asks about this player, which is the whole of what it reads.",
+              "readonly": true
             },
             {
               "kind": "field",
@@ -107916,14 +107587,14 @@
                 "text": "string[]"
               },
               "privacy": "private",
-              "description": "The controls asked for behind the overflow button, in order.\n\nA name in both lists is on the bar and not here. Drawing it twice is worse\nthan either placement, and the bar is the one a reader can see.",
+              "description": "The controls asked for behind the overflow button, in order.",
               "readonly": true
             },
             {
               "kind": "field",
               "name": "media",
               "type": {
-                "text": "{ attrs: Record<string, string>; tag: 'source' | 'track' }[]"
+                "text": "MediaCopy[]"
               },
               "privacy": "private",
               "default": "[]",
@@ -108157,31 +107828,12 @@
               "default": "false",
               "description": "Whether the first set of copies has been read from the children."
             },
-            {
-              "kind": "method",
-              "name": "copiesOf",
-              "privacy": "private",
-              "return": {
-                "type": {
-                  "text": "{ attrs: Record<string, string>; tag: 'source' | 'track' }[]"
-                }
-              },
-              "parameters": [
-                {
-                  "name": "elements",
-                  "type": {
-                    "text": "Element[]"
-                  }
-                }
-              ],
-              "description": "The copies to make of what the default slot is given.\n\nThe attribute list is explicit rather than a blind copy of every attribute:\nthese are two elements with a known and small surface, and copying anything\na consumer happened to put on one would carry their framework's own markers\ninto a shadow root that has no use for them."
-            },
             {
               "kind": "field",
               "name": "handleMedia",
               "privacy": "private",
               "readonly": true,
-              "description": "Rebuilds the copies when what is slotted changes after the first read.\n\nThe same set again is not a change. A video reloads for every new list, and\nthe first `slotchange` reports the children this element already read."
+              "description": "Rebuilds the copies when what is slotted changes after the first read."
             },
             {
               "kind": "field",
@@ -108344,7 +107996,7 @@
               "name": "handleKeydown",
               "privacy": "private",
               "readonly": true,
-              "description": "The keys every player uses, bound to this element rather than the document.\n\nA video is not a command palette: its keys belong to it while a reader is\non it, and a page with two videos on it would otherwise have both answering\nthe same press.\n\nNothing is taken while focus is in a range. The scrubber and the volume are\nreal inputs and the arrows are already theirs, so intercepting would mean\nseeking twice for one press."
+              "description": "The keys every player uses, bound to this element rather than the document.\n\nA video is not a command palette: its keys belong to it while a reader is\non it, and a page with two videos on it would otherwise have both answering\nthe same press.\n\nA taken press is stopped here rather than in the table, because what the\ndefault would have been is the element's business: the table says what the\nkey means and this says that nothing else gets it."
             },
             {
               "kind": "field",