kibana/api_docs/kbn_securitysolution_utils.devdocs.json

{
  "id": "@kbn/securitysolution-utils",
  "client": {
    "classes": [],
    "functions": [],
    "interfaces": [],
    "enums": [],
    "misc": [],
    "objects": []
  },
  "server": {
    "classes": [],
    "functions": [],
    "interfaces": [],
    "enums": [],
    "misc": [],
    "objects": []
  },
  "common": {
    "classes": [],
    "functions": [
      {
        "parentPluginId": "@kbn/securitysolution-utils",
        "id": "def-common.addIdToItem",
        "type": "Function",
        "tags": [],
        "label": "addIdToItem",
        "description": [],
        "signature": [
          "<T>(item: NotArray<T>) => T"
        ],
        "path": "packages/kbn-securitysolution-utils/src/add_remove_id_to_item/index.ts",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "@kbn/securitysolution-utils",
            "id": "def-common.addIdToItem.$1",
            "type": "Uncategorized",
            "tags": [],
            "label": "item",
            "description": [],
            "signature": [
              "NotArray<T>"
            ],
            "path": "packages/kbn-securitysolution-utils/src/add_remove_id_to_item/index.ts",
            "deprecated": false,
            "trackAdoption": false,
            "isRequired": true
          }
        ],
        "returnComment": [],
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/securitysolution-utils",
        "id": "def-common.computeIsESQLQueryAggregating",
        "type": "Function",
        "tags": [],
        "label": "computeIsESQLQueryAggregating",
        "description": [
          "\ncompute if esqlQuery is aggregating/grouping, i.e. using STATS...BY command"
        ],
        "signature": [
          "(esqlQuery: string) => boolean"
        ],
        "path": "packages/kbn-securitysolution-utils/src/esql/compute_if_esql_query_aggregating.ts",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "@kbn/securitysolution-utils",
            "id": "def-common.computeIsESQLQueryAggregating.$1",
            "type": "string",
            "tags": [],
            "label": "esqlQuery",
            "description": [],
            "signature": [
              "string"
            ],
            "path": "packages/kbn-securitysolution-utils/src/esql/compute_if_esql_query_aggregating.ts",
            "deprecated": false,
            "trackAdoption": false,
            "isRequired": true
          }
        ],
        "returnComment": [
          "boolean"
        ],
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/securitysolution-utils",
        "id": "def-common.getIndexListFromEsqlQuery",
        "type": "Function",
        "tags": [],
        "label": "getIndexListFromEsqlQuery",
        "description": [
          "\nparses ES|QL query and returns array of indices"
        ],
        "signature": [
          "(query: string | undefined) => string[]"
        ],
        "path": "packages/kbn-securitysolution-utils/src/esql/get_index_list_from_esql_query.ts",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "@kbn/securitysolution-utils",
            "id": "def-common.getIndexListFromEsqlQuery.$1",
            "type": "string",
            "tags": [],
            "label": "query",
            "description": [],
            "signature": [
              "string | undefined"
            ],
            "path": "packages/kbn-securitysolution-utils/src/esql/get_index_list_from_esql_query.ts",
            "deprecated": false,
            "trackAdoption": false,
            "isRequired": false
          }
        ],
        "returnComment": [],
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/securitysolution-utils",
        "id": "def-common.getIndexListFromIndexString",
        "type": "Function",
        "tags": [],
        "label": "getIndexListFromIndexString",
        "description": [
          "\ntransforms sting of indices, separated by commas to array\nindex*, index2* => [index*, index2*]"
        ],
        "signature": [
          "(indexString: string | undefined) => string[]"
        ],
        "path": "packages/kbn-securitysolution-utils/src/esql/get_index_list_from_esql_query.ts",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "@kbn/securitysolution-utils",
            "id": "def-common.getIndexListFromIndexString.$1",
            "type": "string",
            "tags": [],
            "label": "indexString",
            "description": [],
            "signature": [
              "string | undefined"
            ],
            "path": "packages/kbn-securitysolution-utils/src/esql/get_index_list_from_esql_query.ts",
            "deprecated": false,
            "trackAdoption": false,
            "isRequired": false
          }
        ],
        "returnComment": [],
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/securitysolution-utils",
        "id": "def-common.hasSimpleExecutableName",
        "type": "Function",
        "tags": [],
        "label": "hasSimpleExecutableName",
        "description": [],
        "signature": [
          "({ os, type, value, }: { os: ",
          {
            "pluginId": "@kbn/securitysolution-utils",
            "scope": "common",
            "docId": "kibKbnSecuritysolutionUtilsPluginApi",
            "section": "def-common.OperatingSystem",
            "text": "OperatingSystem"
          },
          "; type: ",
          {
            "pluginId": "@kbn/securitysolution-utils",
            "scope": "common",
            "docId": "kibKbnSecuritysolutionUtilsPluginApi",
            "section": "def-common.EntryTypes",
            "text": "EntryTypes"
          },
          "; value: string; }) => boolean | undefined"
        ],
        "path": "packages/kbn-securitysolution-utils/src/path_validations/index.ts",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "@kbn/securitysolution-utils",
            "id": "def-common.hasSimpleExecutableName.$1",
            "type": "Object",
            "tags": [],
            "label": "{\n  os,\n  type,\n  value,\n}",
            "description": [],
            "path": "packages/kbn-securitysolution-utils/src/path_validations/index.ts",
            "deprecated": false,
            "trackAdoption": false,
            "children": [
              {
                "parentPluginId": "@kbn/securitysolution-utils",
                "id": "def-common.hasSimpleExecutableName.$1.os",
                "type": "Enum",
                "tags": [],
                "label": "os",
                "description": [],
                "signature": [
                  {
                    "pluginId": "@kbn/securitysolution-utils",
                    "scope": "common",
                    "docId": "kibKbnSecuritysolutionUtilsPluginApi",
                    "section": "def-common.OperatingSystem",
                    "text": "OperatingSystem"
                  }
                ],
                "path": "packages/kbn-securitysolution-utils/src/path_validations/index.ts",
                "deprecated": false,
                "trackAdoption": false
              },
              {
                "parentPluginId": "@kbn/securitysolution-utils",
                "id": "def-common.hasSimpleExecutableName.$1.type",
                "type": "CompoundType",
                "tags": [],
                "label": "type",
                "description": [],
                "signature": [
                  "\"match\" | \"wildcard\" | \"match_any\""
                ],
                "path": "packages/kbn-securitysolution-utils/src/path_validations/index.ts",
                "deprecated": false,
                "trackAdoption": false
              },
              {
                "parentPluginId": "@kbn/securitysolution-utils",
                "id": "def-common.hasSimpleExecutableName.$1.value",
                "type": "string",
                "tags": [],
                "label": "value",
                "description": [],
                "path": "packages/kbn-securitysolution-utils/src/path_validations/index.ts",
                "deprecated": false,
                "trackAdoption": false
              }
            ]
          }
        ],
        "returnComment": [],
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/securitysolution-utils",
        "id": "def-common.isPathValid",
        "type": "Function",
        "tags": [],
        "label": "isPathValid",
        "description": [],
        "signature": [
          "({ os, field, type, value, }: { os: ",
          {
            "pluginId": "@kbn/securitysolution-utils",
            "scope": "common",
            "docId": "kibKbnSecuritysolutionUtilsPluginApi",
            "section": "def-common.OperatingSystem",
            "text": "OperatingSystem"
          },
          "; field: ",
          {
            "pluginId": "@kbn/securitysolution-utils",
            "scope": "common",
            "docId": "kibKbnSecuritysolutionUtilsPluginApi",
            "section": "def-common.AllConditionEntryFields",
            "text": "AllConditionEntryFields"
          },
          "; type: ",
          {
            "pluginId": "@kbn/securitysolution-utils",
            "scope": "common",
            "docId": "kibKbnSecuritysolutionUtilsPluginApi",
            "section": "def-common.EntryTypes",
            "text": "EntryTypes"
          },
          "; value: string; }) => boolean"
        ],
        "path": "packages/kbn-securitysolution-utils/src/path_validations/index.ts",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "@kbn/securitysolution-utils",
            "id": "def-common.isPathValid.$1",
            "type": "Object",
            "tags": [],
            "label": "{\n  os,\n  field,\n  type,\n  value,\n}",
            "description": [],
            "path": "packages/kbn-securitysolution-utils/src/path_validations/index.ts",
            "deprecated": false,
            "trackAdoption": false,
            "children": [
              {
                "parentPluginId": "@kbn/securitysolution-utils",
                "id": "def-common.isPathValid.$1.os",
                "type": "Enum",
                "tags": [],
                "label": "os",
                "description": [],
                "signature": [
                  {
                    "pluginId": "@kbn/securitysolution-utils",
                    "scope": "common",
                    "docId": "kibKbnSecuritysolutionUtilsPluginApi",
                    "section": "def-common.OperatingSystem",
                    "text": "OperatingSystem"
                  }
                ],
                "path": "packages/kbn-securitysolution-utils/src/path_validations/index.ts",
                "deprecated": false,
                "trackAdoption": false
              },
              {
                "parentPluginId": "@kbn/securitysolution-utils",
                "id": "def-common.isPathValid.$1.field",
                "type": "CompoundType",
                "tags": [],
                "label": "field",
                "description": [],
                "signature": [
                  "\"file.path.text\" | ",
                  {
                    "pluginId": "@kbn/securitysolution-utils",
                    "scope": "common",
                    "docId": "kibKbnSecuritysolutionUtilsPluginApi",
                    "section": "def-common.TrustedAppConditionEntryField",
                    "text": "TrustedAppConditionEntryField"
                  },
                  " | ",
                  {
                    "pluginId": "@kbn/securitysolution-utils",
                    "scope": "common",
                    "docId": "kibKbnSecuritysolutionUtilsPluginApi",
                    "section": "def-common.BlocklistConditionEntryField",
                    "text": "BlocklistConditionEntryField"
                  }
                ],
                "path": "packages/kbn-securitysolution-utils/src/path_validations/index.ts",
                "deprecated": false,
                "trackAdoption": false
              },
              {
                "parentPluginId": "@kbn/securitysolution-utils",
                "id": "def-common.isPathValid.$1.type",
                "type": "CompoundType",
                "tags": [],
                "label": "type",
                "description": [],
                "signature": [
                  "\"match\" | \"wildcard\" | \"match_any\""
                ],
                "path": "packages/kbn-securitysolution-utils/src/path_validations/index.ts",
                "deprecated": false,
                "trackAdoption": false
              },
              {
                "parentPluginId": "@kbn/securitysolution-utils",
                "id": "def-common.isPathValid.$1.value",
                "type": "string",
                "tags": [],
                "label": "value",
                "description": [],
                "path": "packages/kbn-securitysolution-utils/src/path_validations/index.ts",
                "deprecated": false,
                "trackAdoption": false
              }
            ]
          }
        ],
        "returnComment": [],
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/securitysolution-utils",
        "id": "def-common.removeIdFromItem",
        "type": "Function",
        "tags": [],
        "label": "removeIdFromItem",
        "description": [
          "\nThis is to reverse the id you added to your arrays for ReactJS keys."
        ],
        "signature": [
          "<T>(item: NotArray<T>) => T | Pick<T & { id?: string | undefined; }, Exclude<keyof T, \"id\">>"
        ],
        "path": "packages/kbn-securitysolution-utils/src/add_remove_id_to_item/index.ts",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "@kbn/securitysolution-utils",
            "id": "def-common.removeIdFromItem.$1",
            "type": "Uncategorized",
            "tags": [],
            "label": "item",
            "description": [
              "The item to remove the id from."
            ],
            "signature": [
              "NotArray<T>"
            ],
            "path": "packages/kbn-securitysolution-utils/src/add_remove_id_to_item/index.ts",
            "deprecated": false,
            "trackAdoption": false,
            "isRequired": true
          }
        ],
        "returnComment": [],
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/securitysolution-utils",
        "id": "def-common.transformDataToNdjson",
        "type": "Function",
        "tags": [],
        "label": "transformDataToNdjson",
        "description": [],
        "signature": [
          "(data: unknown[]) => string"
        ],
        "path": "packages/kbn-securitysolution-utils/src/transform_data_to_ndjson/index.ts",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "@kbn/securitysolution-utils",
            "id": "def-common.transformDataToNdjson.$1",
            "type": "Array",
            "tags": [],
            "label": "data",
            "description": [],
            "signature": [
              "unknown[]"
            ],
            "path": "packages/kbn-securitysolution-utils/src/transform_data_to_ndjson/index.ts",
            "deprecated": false,
            "trackAdoption": false,
            "isRequired": true
          }
        ],
        "returnComment": [],
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/securitysolution-utils",
        "id": "def-common.validateFilePathInput",
        "type": "Function",
        "tags": [],
        "label": "validateFilePathInput",
        "description": [],
        "signature": [
          "({ os, value, }: { os: ",
          {
            "pluginId": "@kbn/securitysolution-utils",
            "scope": "common",
            "docId": "kibKbnSecuritysolutionUtilsPluginApi",
            "section": "def-common.OperatingSystem",
            "text": "OperatingSystem"
          },
          "; value?: string | undefined; }) => string | undefined"
        ],
        "path": "packages/kbn-securitysolution-utils/src/path_validations/index.ts",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "@kbn/securitysolution-utils",
            "id": "def-common.validateFilePathInput.$1",
            "type": "Object",
            "tags": [],
            "label": "{\n  os,\n  value = '',\n}",
            "description": [],
            "path": "packages/kbn-securitysolution-utils/src/path_validations/index.ts",
            "deprecated": false,
            "trackAdoption": false,
            "children": [
              {
                "parentPluginId": "@kbn/securitysolution-utils",
                "id": "def-common.validateFilePathInput.$1.os",
                "type": "Enum",
                "tags": [],
                "label": "os",
                "description": [],
                "signature": [
                  {
                    "pluginId": "@kbn/securitysolution-utils",
                    "scope": "common",
                    "docId": "kibKbnSecuritysolutionUtilsPluginApi",
                    "section": "def-common.OperatingSystem",
                    "text": "OperatingSystem"
                  }
                ],
                "path": "packages/kbn-securitysolution-utils/src/path_validations/index.ts",
                "deprecated": false,
                "trackAdoption": false
              },
              {
                "parentPluginId": "@kbn/securitysolution-utils",
                "id": "def-common.validateFilePathInput.$1.value",
                "type": "string",
                "tags": [],
                "label": "value",
                "description": [],
                "signature": [
                  "string | undefined"
                ],
                "path": "packages/kbn-securitysolution-utils/src/path_validations/index.ts",
                "deprecated": false,
                "trackAdoption": false
              }
            ]
          }
        ],
        "returnComment": [],
        "initialIsOpen": false
      }
    ],
    "interfaces": [],
    "enums": [
      {
        "parentPluginId": "@kbn/securitysolution-utils",
        "id": "def-common.ConditionEntryField",
        "type": "Enum",
        "tags": [],
        "label": "ConditionEntryField",
        "description": [],
        "path": "packages/kbn-securitysolution-utils/src/path_validations/index.ts",
        "deprecated": false,
        "trackAdoption": false,
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/securitysolution-utils",
        "id": "def-common.EntryFieldType",
        "type": "Enum",
        "tags": [],
        "label": "EntryFieldType",
        "description": [],
        "path": "packages/kbn-securitysolution-utils/src/path_validations/index.ts",
        "deprecated": false,
        "trackAdoption": false,
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/securitysolution-utils",
        "id": "def-common.OperatingSystem",
        "type": "Enum",
        "tags": [],
        "label": "OperatingSystem",
        "description": [],
        "path": "packages/kbn-securitysolution-utils/src/path_validations/index.ts",
        "deprecated": false,
        "trackAdoption": false,
        "initialIsOpen": false
      }
    ],
    "misc": [
      {
        "parentPluginId": "@kbn/securitysolution-utils",
        "id": "def-common.AllConditionEntryFields",
        "type": "Type",
        "tags": [],
        "label": "AllConditionEntryFields",
        "description": [],
        "signature": [
          "\"file.path.text\" | ",
          {
            "pluginId": "@kbn/securitysolution-utils",
            "scope": "common",
            "docId": "kibKbnSecuritysolutionUtilsPluginApi",
            "section": "def-common.TrustedAppConditionEntryField",
            "text": "TrustedAppConditionEntryField"
          },
          " | ",
          {
            "pluginId": "@kbn/securitysolution-utils",
            "scope": "common",
            "docId": "kibKbnSecuritysolutionUtilsPluginApi",
            "section": "def-common.BlocklistConditionEntryField",
            "text": "BlocklistConditionEntryField"
          }
        ],
        "path": "packages/kbn-securitysolution-utils/src/path_validations/index.ts",
        "deprecated": false,
        "trackAdoption": false,
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/securitysolution-utils",
        "id": "def-common.BlocklistConditionEntryField",
        "type": "Type",
        "tags": [],
        "label": "BlocklistConditionEntryField",
        "description": [],
        "signature": [
          "\"file.path\" | \"file.Ext.code_signature\" | \"file.hash.*\" | \"file.path.caseless\""
        ],
        "path": "packages/kbn-securitysolution-utils/src/path_validations/index.ts",
        "deprecated": false,
        "trackAdoption": false,
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/securitysolution-utils",
        "id": "def-common.EntryTypes",
        "type": "Type",
        "tags": [],
        "label": "EntryTypes",
        "description": [],
        "signature": [
          "\"match\" | \"wildcard\" | \"match_any\""
        ],
        "path": "packages/kbn-securitysolution-utils/src/path_validations/index.ts",
        "deprecated": false,
        "trackAdoption": false,
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/securitysolution-utils",
        "id": "def-common.FILENAME_WILDCARD_WARNING",
        "type": "string",
        "tags": [],
        "label": "FILENAME_WILDCARD_WARNING",
        "description": [],
        "path": "packages/kbn-securitysolution-utils/src/path_validations/index.ts",
        "deprecated": false,
        "trackAdoption": false,
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/securitysolution-utils",
        "id": "def-common.FILEPATH_WARNING",
        "type": "string",
        "tags": [],
        "label": "FILEPATH_WARNING",
        "description": [],
        "path": "packages/kbn-securitysolution-utils/src/path_validations/index.ts",
        "deprecated": false,
        "trackAdoption": false,
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/securitysolution-utils",
        "id": "def-common.TrustedAppConditionEntryField",
        "type": "Type",
        "tags": [],
        "label": "TrustedAppConditionEntryField",
        "description": [],
        "signature": [
          "\"process.hash.*\" | \"process.executable.caseless\" | \"process.Ext.code_signature\""
        ],
        "path": "packages/kbn-securitysolution-utils/src/path_validations/index.ts",
        "deprecated": false,
        "trackAdoption": false,
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/securitysolution-utils",
        "id": "def-common.TrustedAppEntryTypes",
        "type": "Type",
        "tags": [],
        "label": "TrustedAppEntryTypes",
        "description": [],
        "signature": [
          "\"match\" | \"wildcard\""
        ],
        "path": "packages/kbn-securitysolution-utils/src/path_validations/index.ts",
        "deprecated": false,
        "trackAdoption": false,
        "initialIsOpen": false
      }
    ],
    "objects": []
  }
}