@genesislcap/grid-pro 14.107.0 → 14.107.1-alpha-afbc4d7.0

package/dist/grid-pro.api.json

@@ -1,7 +1,7 @@
 {
   "metadata": {
     "toolPackage": "@microsoft/api-extractor",
-    "toolVersion": "7.34.9",
+    "toolVersion": "7.38.0",
     "schemaVersion": 1011,
     "oldestForwardsCompatibleVersion": 1001,
     "tsdocConfig": {
@@ -3862,6 +3862,51 @@
             "endIndex": 2
           }
         },
+        {
+          "kind": "Function",
+          "canonicalReference": "@genesislcap/grid-pro!formatDateExtra:function(1)",
+          "docComment": "/**\n * Returns a formatted date value from an epoch number.\n *\n * @deprecated\n *\n * No longer used in the Grid Pro package.\n *\n * @param epoch - A number representing the number of milliseconds since the Unix epoch (1 January 1970 00:00:00 UTC).\n *\n * @returns A formatted date value.\n *\n * @alpha\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export declare function formatDateExtra(epoch: "
+            },
+            {
+              "kind": "Content",
+              "text": "number"
+            },
+            {
+              "kind": "Content",
+              "text": "): "
+            },
+            {
+              "kind": "Content",
+              "text": "string"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "src/grid-pro.definitions.ts",
+          "returnTypeTokenRange": {
+            "startIndex": 3,
+            "endIndex": 4
+          },
+          "releaseTag": "Alpha",
+          "overloadIndex": 1,
+          "parameters": [
+            {
+              "parameterName": "epoch",
+              "parameterTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isOptional": false
+            }
+          ],
+          "name": "formatDateExtra"
+        },
         {
           "kind": "Variable",
           "canonicalReference": "@genesislcap/grid-pro!foundationAgBooleanRenderer:var",
@@ -5920,6 +5965,51 @@
             "endIndex": 6
           }
         },
+        {
+          "kind": "Function",
+          "canonicalReference": "@genesislcap/grid-pro!getColumnType:function(1)",
+          "docComment": "/**\n * Return a column type base on each field's metadata from the selected resource.\n *\n * @remarks\n *\n * Currently only handles numeric columns\n *\n * @param metadataType - The type of the field/column\n *\n * @returns the column type\n *\n * @alpha\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export declare function getColumnType(metadataType: "
+            },
+            {
+              "kind": "Content",
+              "text": "string"
+            },
+            {
+              "kind": "Content",
+              "text": "): "
+            },
+            {
+              "kind": "Content",
+              "text": "string"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "src/grid-pro.definitions.ts",
+          "returnTypeTokenRange": {
+            "startIndex": 3,
+            "endIndex": 4
+          },
+          "releaseTag": "Alpha",
+          "overloadIndex": 1,
+          "parameters": [
+            {
+              "parameterName": "metadataType",
+              "parameterTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isOptional": false
+            }
+          ],
+          "name": "getColumnType"
+        },
         {
           "kind": "Variable",
           "canonicalReference": "@genesislcap/grid-pro!getDateEditorTemplate:var",
@@ -5961,6 +6051,96 @@
             "endIndex": 6
           }
         },
+        {
+          "kind": "Function",
+          "canonicalReference": "@genesislcap/grid-pro!getFilterByFieldType:function(1)",
+          "docComment": "/**\n * Returns a filter type based on the Grid Pro field/column type.\n *\n * @remarks\n *\n * Currently only returns agTextColumnFilter\n *\n * @param type - The type of the field/column\n *\n * @returns The ag-grid filter type\n *\n * @alpha\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export declare function getFilterByFieldType(type: "
+            },
+            {
+              "kind": "Content",
+              "text": "string"
+            },
+            {
+              "kind": "Content",
+              "text": "): "
+            },
+            {
+              "kind": "Content",
+              "text": "string"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "src/grid-pro.definitions.ts",
+          "returnTypeTokenRange": {
+            "startIndex": 3,
+            "endIndex": 4
+          },
+          "releaseTag": "Alpha",
+          "overloadIndex": 1,
+          "parameters": [
+            {
+              "parameterName": "type",
+              "parameterTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isOptional": false
+            }
+          ],
+          "name": "getFilterByFieldType"
+        },
+        {
+          "kind": "Function",
+          "canonicalReference": "@genesislcap/grid-pro!getFilterParamsByFieldType:function(1)",
+          "docComment": "/**\n * Returns the filter params based on the Grid Pro field/column type.\n *\n * @remarks\n *\n * Currently only returns a default filter params object, for all field types\n *\n * @param type - The type of the field/column\n *\n * @returns the filter params for the specified field type\n *\n * @alpha\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export declare function getFilterParamsByFieldType(type: "
+            },
+            {
+              "kind": "Content",
+              "text": "string"
+            },
+            {
+              "kind": "Content",
+              "text": "): "
+            },
+            {
+              "kind": "Content",
+              "text": "any"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "src/grid-pro.definitions.ts",
+          "returnTypeTokenRange": {
+            "startIndex": 3,
+            "endIndex": 4
+          },
+          "releaseTag": "Alpha",
+          "overloadIndex": 1,
+          "parameters": [
+            {
+              "parameterName": "type",
+              "parameterTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isOptional": false
+            }
+          ],
+          "name": "getFilterParamsByFieldType"
+        },
         {
           "kind": "Variable",
           "canonicalReference": "@genesislcap/grid-pro!getMultiselectEditorTemplate:var",
@@ -9370,6 +9550,128 @@
             }
           ]
         },
+        {
+          "kind": "Class",
+          "canonicalReference": "@genesislcap/grid-pro!GridProServerSideDatasource:class",
+          "docComment": "/**\n * A Genesis Datasource element, for server-side | SSRM-compatible data fetching and used exclusively by the GridPro element.\n *\n * @remarks\n *\n * Only supports Server-Side Row Model. Requires `@ag-grid-enterprise/server-side-row-model` setup and valid AG Grid Enterprise license.\n *\n * @alpha\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export declare class GridProServerSideDatasource extends "
+            },
+            {
+              "kind": "Reference",
+              "text": "GridProServerSideDatasource_base",
+              "canonicalReference": "@genesislcap/grid-pro!~GridProServerSideDatasource_base"
+            },
+            {
+              "kind": "Content",
+              "text": " "
+            }
+          ],
+          "fileUrlPath": "src/datasource/server-side.datasource.ts",
+          "releaseTag": "Alpha",
+          "isAbstract": false,
+          "name": "GridProServerSideDatasource",
+          "preserveMemberOrder": false,
+          "members": [
+            {
+              "kind": "Property",
+              "canonicalReference": "@genesislcap/grid-pro!GridProServerSideDatasource#pagination:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "pagination: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "boolean"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Alpha",
+              "name": "pagination",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isStatic": false,
+              "isProtected": false,
+              "isAbstract": false
+            },
+            {
+              "kind": "Property",
+              "canonicalReference": "@genesislcap/grid-pro!GridProServerSideDatasource#params:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "get params(): "
+                },
+                {
+                  "kind": "Content",
+                  "text": "any"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": true,
+              "isOptional": false,
+              "releaseTag": "Alpha",
+              "name": "params",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isStatic": false,
+              "isProtected": false,
+              "isAbstract": false
+            },
+            {
+              "kind": "Property",
+              "canonicalReference": "@genesislcap/grid-pro!GridProServerSideDatasource#rowId:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "rowId: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Alpha",
+              "name": "rowId",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isStatic": false,
+              "isProtected": false,
+              "isAbstract": false
+            }
+          ],
+          "extendsTokenRange": {
+            "startIndex": 1,
+            "endIndex": 2
+          },
+          "implementsTokenRanges": []
+        },
         {
           "kind": "Variable",
           "canonicalReference": "@genesislcap/grid-pro!gridProTemplate:var",
@@ -11595,6 +11897,300 @@
             }
           ]
         },
+        {
+          "kind": "Class",
+          "canonicalReference": "@genesislcap/grid-pro!StreamDatasource:class",
+          "docComment": "/**\n * The IServerSideDatasource implementation, used for SSRM (Server-Side Row Model) in the grid.\n *\n * @alpha\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export declare class StreamDatasource implements "
+            },
+            {
+              "kind": "Reference",
+              "text": "IServerSideDatasource",
+              "canonicalReference": "@ag-grid-community/core!IServerSideDatasource:interface"
+            },
+            {
+              "kind": "Content",
+              "text": " "
+            }
+          ],
+          "fileUrlPath": "src/datasource/server-side.datasource.ts",
+          "releaseTag": "Alpha",
+          "isAbstract": false,
+          "name": "StreamDatasource",
+          "preserveMemberOrder": false,
+          "members": [
+            {
+              "kind": "Constructor",
+              "canonicalReference": "@genesislcap/grid-pro!StreamDatasource:constructor(1)",
+              "docComment": "/**\n * Constructs a new instance of the `StreamDatasource` class\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "constructor(options: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "StreamDatasourceOptions",
+                  "canonicalReference": "@genesislcap/grid-pro!StreamDatasourceOptions:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": ");"
+                }
+              ],
+              "releaseTag": "Alpha",
+              "isProtected": false,
+              "overloadIndex": 1,
+              "parameters": [
+                {
+                  "parameterName": "options",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 2
+                  },
+                  "isOptional": false
+                }
+              ]
+            },
+            {
+              "kind": "Property",
+              "canonicalReference": "@genesislcap/grid-pro!StreamDatasource#auth:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "auth: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Auth",
+                  "canonicalReference": "@genesislcap/foundation-comms!Auth:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Alpha",
+              "name": "auth",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isStatic": false,
+              "isProtected": false,
+              "isAbstract": false
+            },
+            {
+              "kind": "Property",
+              "canonicalReference": "@genesislcap/grid-pro!StreamDatasource#connect:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "connect: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Connect",
+                  "canonicalReference": "@genesislcap/foundation-comms!Connect:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Alpha",
+              "name": "connect",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isStatic": false,
+              "isProtected": false,
+              "isAbstract": false
+            },
+            {
+              "kind": "Property",
+              "canonicalReference": "@genesislcap/grid-pro!StreamDatasource#dataserverStream:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "dataserverStream: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "SocketObservable",
+                  "canonicalReference": "@genesislcap/foundation-comms!SocketObservable:class"
+                },
+                {
+                  "kind": "Content",
+                  "text": "<"
+                },
+                {
+                  "kind": "Reference",
+                  "text": "FilteredDataServerResult",
+                  "canonicalReference": "@genesislcap/foundation-comms!FilteredDataServerResult:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": ">"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Alpha",
+              "name": "dataserverStream",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 5
+              },
+              "isStatic": false,
+              "isProtected": false,
+              "isAbstract": false
+            },
+            {
+              "kind": "Property",
+              "canonicalReference": "@genesislcap/grid-pro!StreamDatasource#resourceParams:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "resourceParams: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "any"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Alpha",
+              "name": "resourceParams",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isStatic": false,
+              "isProtected": false,
+              "isAbstract": false
+            },
+            {
+              "kind": "Property",
+              "canonicalReference": "@genesislcap/grid-pro!StreamDatasource#streamSourceRef:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "streamSourceRef: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Alpha",
+              "name": "streamSourceRef",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isStatic": false,
+              "isProtected": false,
+              "isAbstract": false
+            }
+          ],
+          "implementsTokenRanges": [
+            {
+              "startIndex": 1,
+              "endIndex": 2
+            }
+          ]
+        },
+        {
+          "kind": "TypeAlias",
+          "canonicalReference": "@genesislcap/grid-pro!StreamDatasourceOptions:type",
+          "docComment": "/**\n * Type definition for configuration options used for streams.\n *\n * @remarks\n *\n * Used by {@link @genesislcap/grid-pro#StreamDatasource} constructor to configure options for the stream.\n *\n * @alpha\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export type StreamDatasourceOptions = "
+            },
+            {
+              "kind": "Content",
+              "text": "{\n    stream: "
+            },
+            {
+              "kind": "Reference",
+              "text": "SocketObservable",
+              "canonicalReference": "@genesislcap/foundation-comms!SocketObservable:class"
+            },
+            {
+              "kind": "Content",
+              "text": "<"
+            },
+            {
+              "kind": "Reference",
+              "text": "FilteredDataServerResult",
+              "canonicalReference": "@genesislcap/foundation-comms!FilteredDataServerResult:type"
+            },
+            {
+              "kind": "Content",
+              "text": ">;\n    resourceName: string;\n    resourceParams?: any;\n    resourceIndexes?: "
+            },
+            {
+              "kind": "Reference",
+              "text": "Map",
+              "canonicalReference": "!Map:interface"
+            },
+            {
+              "kind": "Content",
+              "text": "<string, [string]>;\n    resourceColDefs?: "
+            },
+            {
+              "kind": "Reference",
+              "text": "MetadataDetail",
+              "canonicalReference": "@genesislcap/foundation-comms!MetadataDetail:type"
+            },
+            {
+              "kind": "Content",
+              "text": "[];\n    maxRows?: number;\n    maxView?: number;\n    rowId?: string;\n    pagination?: boolean;\n}"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "src/datasource/server-side.datasource.ts",
+          "releaseTag": "Alpha",
+          "name": "StreamDatasourceOptions",
+          "typeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 10
+          }
+        },
         {
           "kind": "Variable",
           "canonicalReference": "@genesislcap/grid-pro!textFieldRendererStyles:var",