@genesislcap/foundation-ui 14.488.2 → 14.489.0-canary.FUI-2574-1

package/dist/foundation-ui.api.json

@@ -8496,6 +8496,37 @@
               "isAbstract": false,
               "name": "applyRequestServerData"
             },
+            {
+              "kind": "Method",
+              "canonicalReference": "@genesislcap/foundation-ui!BaseDatasource#canRequestMoreRows:member(1)",
+              "docComment": "/**\n * Whether a further page of rows can be requested from the server.\n *\n * @public\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "canRequestMoreRows(): "
+                },
+                {
+                  "kind": "Content",
+                  "text": "boolean"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isStatic": false,
+              "returnTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "releaseTag": "Public",
+              "isProtected": false,
+              "overloadIndex": 1,
+              "parameters": [],
+              "isOptional": false,
+              "isAbstract": false,
+              "name": "canRequestMoreRows"
+            },
             {
               "kind": "Method",
               "canonicalReference": "@genesislcap/foundation-ui!BaseDatasource#clearData:member(1)",
@@ -9400,10 +9431,70 @@
               "isProtected": false,
               "isAbstract": false
             },
+            {
+              "kind": "Property",
+              "canonicalReference": "@genesislcap/foundation-ui!BaseDatasource#moreRowsAvailable:member",
+              "docComment": "/**\n * Whether the server reported more rows are available beyond the ones already fetched.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "protected moreRowsAvailable: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "boolean"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "moreRowsAvailable",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isStatic": false,
+              "isProtected": true,
+              "isAbstract": false
+            },
+            {
+              "kind": "Property",
+              "canonicalReference": "@genesislcap/foundation-ui!BaseDatasource#nextRequestOffset:member",
+              "docComment": "/**\n * The OFFSET to request the next page from, for REQUEST_SERVER paging.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "protected nextRequestOffset: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "number"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "nextRequestOffset",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isStatic": false,
+              "isProtected": true,
+              "isAbstract": false
+            },
             {
               "kind": "Property",
               "canonicalReference": "@genesislcap/foundation-ui!BaseDatasource#orderBy:member",
-              "docComment": "",
+              "docComment": "/**\n * Sort field(s) for the resource. When using OFFSET-based paging (e.g. `options-datasource`'s `infinite-scroll`), the server has no other guaranteed row ordering between requests, so a stable `orderBy` is required to avoid rows shifting across pages (duplicates/gaps) as the underlying data changes between fetches.\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
@@ -9572,6 +9663,42 @@
               "isAbstract": false,
               "name": "requestChanged"
             },
+            {
+              "kind": "Method",
+              "canonicalReference": "@genesislcap/foundation-ui!BaseDatasource#requestMoreRows:member(1)",
+              "docComment": "/**\n * Requests the next page of rows (up to `maxRows`) from the server.\n *\n * @remarks\n *\n * For DATASERVER resources a MORE_ROWS message is sent against the active stream's view and the rows are delivered as inserts on the existing stream subscription. For REQUEST_SERVER resources the next page is requested by OFFSET and delivered via `handleStreamInserts`.\n *\n * @public\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "requestMoreRows(): "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Promise",
+                  "canonicalReference": "!Promise:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": "<void>"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isStatic": false,
+              "returnTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 3
+              },
+              "releaseTag": "Public",
+              "isProtected": false,
+              "overloadIndex": 1,
+              "parameters": [],
+              "isOptional": false,
+              "isAbstract": false,
+              "name": "requestMoreRows"
+            },
             {
               "kind": "Property",
               "canonicalReference": "@genesislcap/foundation-ui!BaseDatasource#requiresFullDataRefresh:member",
@@ -9822,6 +9949,36 @@
               "isAbstract": false,
               "name": "setFilter"
             },
+            {
+              "kind": "Property",
+              "canonicalReference": "@genesislcap/foundation-ui!BaseDatasource#sourceRef:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "protected sourceRef: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "sourceRef",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isStatic": false,
+              "isProtected": true,
+              "isAbstract": false
+            },
             {
               "kind": "Method",
               "canonicalReference": "@genesislcap/foundation-ui!BaseDatasource#syncComponentData:member(1)",
@@ -12285,7 +12442,7 @@
         {
           "kind": "Class",
           "canonicalReference": "@genesislcap/foundation-ui!Combobox:class",
-          "docComment": "/**\n * @tagname %%prefix%%-combobox\n *\n * @fires\n *\n * change - Fired when a selection is confirmed in autocomplete-both mode\n */\n",
+          "docComment": "/**\n * @tagname %%prefix%%-combobox\n *\n * @fires\n *\n * change - Fired when a selection is confirmed in autocomplete-both mode\n *\n * @fires\n *\n * open-change - Fired when the dropdown opens or closes. detail: `OpenChangeEventDetail`\n */\n",
           "excerptTokens": [
             {
               "kind": "Content",
@@ -12340,7 +12497,7 @@
             {
               "kind": "Property",
               "canonicalReference": "@genesislcap/foundation-ui!Combobox#async:member",
-              "docComment": "",
+              "docComment": "/**\n * Enables server-side filtering: typed input refetches from the server with a criteria instead of filtering the already-loaded options client-side.\n *\n * @remarks\n *\n * Automatically forced to `true` (overriding an explicit `async=\"false\"`) when the slotted datasource has `infinite-scroll` enabled — see {@link Combobox.enableAsyncForInfiniteScrollDatasource}. With only a page of the resource loaded, client-side filtering would silently only search that page.\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
@@ -12932,6 +13089,41 @@
               "isProtected": false,
               "isAbstract": false
             },
+            {
+              "kind": "Property",
+              "canonicalReference": "@genesislcap/foundation-ui!Combobox#scrollableListbox:member",
+              "docComment": "/**\n * The scrollable element hosting the dropdown options. Part of the public contract for slotted datasources (e.g. options-datasource infinite scroll) to observe scrolling.\n *\n * @public\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "get scrollableListbox(): "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "HTMLElement",
+                  "canonicalReference": "!HTMLElement:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": " | null"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": true,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "scrollableListbox",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 3
+              },
+              "isStatic": false,
+              "isProtected": false,
+              "isAbstract": false
+            },
             {
               "kind": "Property",
               "canonicalReference": "@genesislcap/foundation-ui!Combobox#scrollToSelectedWhenOpening:member",
@@ -57708,6 +57900,51 @@
             "endIndex": 3
           }
         },
+        {
+          "kind": "Interface",
+          "canonicalReference": "@genesislcap/foundation-ui!OpenChangeEventDetail:interface",
+          "docComment": "/**\n * Detail payload for the `open-change` event fired by `Select` and `Combobox` when their dropdown opens or closes.\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export interface OpenChangeEventDetail "
+            }
+          ],
+          "fileUrlPath": "src/utils/event-types.ts",
+          "releaseTag": "Public",
+          "name": "OpenChangeEventDetail",
+          "preserveMemberOrder": false,
+          "members": [
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@genesislcap/foundation-ui!OpenChangeEventDetail#open:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "open: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "boolean"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "open",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            }
+          ],
+          "extendsTokenRanges": []
+        },
         {
           "kind": "Variable",
           "canonicalReference": "@genesislcap/foundation-ui!OPERATOR_DISPLAY_LABEL:var",
@@ -58152,7 +58389,7 @@
             {
               "kind": "Method",
               "canonicalReference": "@genesislcap/foundation-ui!OptionsDatasource#handleStreamDeletes:member(1)",
-              "docComment": "",
+              "docComment": "/**\n * @remarks\n *\n * Not implemented: rendered options are only ever appended (see `syncComponentData` / `handleStreamInserts`). For DATASERVER `infinite-scroll`, a live delete/update on a row already rendered in an open dropdown will not be reflected until the datasource is refetched (e.g. criteria change) — tracked as a known limitation, not a v1 goal.\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
@@ -58200,7 +58437,7 @@
             {
               "kind": "Method",
               "canonicalReference": "@genesislcap/foundation-ui!OptionsDatasource#handleStreamInserts:member(1)",
-              "docComment": "",
+              "docComment": "/**\n * Appends rows to the already rendered options. Used by REQUEST_SERVER infinite scroll paging, where each page contains only the new rows.\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
@@ -58248,7 +58485,7 @@
             {
               "kind": "Method",
               "canonicalReference": "@genesislcap/foundation-ui!OptionsDatasource#handleStreamUpdates:member(1)",
-              "docComment": "",
+              "docComment": "/**\n * @remarks\n *\n * Not implemented — see {@link OptionsDatasource.handleStreamDeletes}.\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
@@ -58293,6 +58530,36 @@
               "isAbstract": false,
               "name": "handleStreamUpdates"
             },
+            {
+              "kind": "Property",
+              "canonicalReference": "@genesislcap/foundation-ui!OptionsDatasource#infiniteScroll:member",
+              "docComment": "/**\n * Enables infinite scrolling. Instead of loading everything upfront, only `page-size` options are loaded initially and the next page is requested when the user scrolls near the bottom of the dropdown. REQUEST_SERVER resources page by OFFSET; DATASERVER resources page via MORE_ROWS on a live stream (total still capped by `maxView`).\n *\n * @remarks\n *\n * When paging REQUEST_SERVER resources by OFFSET, set a stable `order-by` — without one the server has no other guaranteed ordering between requests, so rows can shift across pages (duplicates/gaps) as the underlying data changes between fetches. Also, when the parent is a combobox, this forces `async` mode on it (see `Combobox.async`), since only a page of options is loaded client-side.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "infiniteScroll: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "boolean"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "infiniteScroll",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isStatic": false,
+              "isProtected": false,
+              "isAbstract": false
+            },
             {
               "kind": "Property",
               "canonicalReference": "@genesislcap/foundation-ui!OptionsDatasource#initalSelectedValueInitialized:member",
@@ -58597,6 +58864,36 @@
               "isProtected": true,
               "isAbstract": false
             },
+            {
+              "kind": "Property",
+              "canonicalReference": "@genesislcap/foundation-ui!OptionsDatasource#pageSize:member",
+              "docComment": "/**\n * Number of options fetched per page when `infinite-scroll` is enabled. Defaults to 20.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "pageSize: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "number"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "pageSize",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isStatic": false,
+              "isProtected": false,
+              "isAbstract": false
+            },
             {
               "kind": "Method",
               "canonicalReference": "@genesislcap/foundation-ui!OptionsDatasource#resetCombobox:member(1)",
@@ -58628,6 +58925,37 @@
               "isAbstract": false,
               "name": "resetCombobox"
             },
+            {
+              "kind": "Property",
+              "canonicalReference": "@genesislcap/foundation-ui!OptionsDatasource#resources:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "resources: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "GenesisResources",
+                  "canonicalReference": "@genesislcap/foundation-comms!GenesisResources:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "resources",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isStatic": false,
+              "isProtected": false,
+              "isAbstract": false
+            },
             {
               "kind": "Property",
               "canonicalReference": "@genesislcap/foundation-ui!OptionsDatasource#select:member",
@@ -64573,7 +64901,7 @@
         {
           "kind": "Class",
           "canonicalReference": "@genesislcap/foundation-ui!Select:class",
-          "docComment": "/**\n * @tagname %%prefix%%-select\n */\n",
+          "docComment": "/**\n * @tagname %%prefix%%-select\n *\n * @fires\n *\n * open-change - Fired when the dropdown opens or closes. detail: `OpenChangeEventDetail`\n */\n",
           "excerptTokens": [
             {
               "kind": "Content",
@@ -64707,6 +65035,41 @@
               "isOptional": false,
               "isAbstract": false,
               "name": "openChanged"
+            },
+            {
+              "kind": "Property",
+              "canonicalReference": "@genesislcap/foundation-ui!Select#scrollableListbox:member",
+              "docComment": "/**\n * The scrollable element hosting the dropdown options. Part of the public contract for slotted datasources (e.g. options-datasource infinite scroll) to observe scrolling.\n *\n * @public\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "get scrollableListbox(): "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "HTMLElement",
+                  "canonicalReference": "!HTMLElement:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": " | null"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": true,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "scrollableListbox",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 3
+              },
+              "isStatic": false,
+              "isProtected": false,
+              "isAbstract": false
             }
           ],
           "extendsTokenRange": {