mirror of
https://github.com/elastic/kibana.git
synced 2025-06-27 10:40:07 -04:00
519 lines
No EOL
18 KiB
JSON
519 lines
No EOL
18 KiB
JSON
{
|
|
"id": "@kbn/subscription-tracking",
|
|
"client": {
|
|
"classes": [],
|
|
"functions": [],
|
|
"interfaces": [],
|
|
"enums": [],
|
|
"misc": [],
|
|
"objects": []
|
|
},
|
|
"server": {
|
|
"classes": [],
|
|
"functions": [],
|
|
"interfaces": [],
|
|
"enums": [],
|
|
"misc": [],
|
|
"objects": []
|
|
},
|
|
"common": {
|
|
"classes": [],
|
|
"functions": [
|
|
{
|
|
"parentPluginId": "@kbn/subscription-tracking",
|
|
"id": "def-common.registerEvents",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "registerEvents",
|
|
"description": [
|
|
"\nRegisters the subscription-specific event types"
|
|
],
|
|
"signature": [
|
|
"(analyticsClient: Pick<",
|
|
{
|
|
"pluginId": "@kbn/analytics-client",
|
|
"scope": "common",
|
|
"docId": "kibKbnAnalyticsClientPluginApi",
|
|
"section": "def-common.IAnalyticsClient",
|
|
"text": "IAnalyticsClient"
|
|
},
|
|
", \"registerEventType\">) => void"
|
|
],
|
|
"path": "packages/kbn-subscription-tracking/src/services.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/subscription-tracking",
|
|
"id": "def-common.registerEvents.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "analyticsClient",
|
|
"description": [],
|
|
"signature": [
|
|
"Pick<",
|
|
{
|
|
"pluginId": "@kbn/analytics-client",
|
|
"scope": "common",
|
|
"docId": "kibKbnAnalyticsClientPluginApi",
|
|
"section": "def-common.IAnalyticsClient",
|
|
"text": "IAnalyticsClient"
|
|
},
|
|
", \"registerEventType\">"
|
|
],
|
|
"path": "packages/kbn-subscription-tracking/src/services.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/subscription-tracking",
|
|
"id": "def-common.SubscriptionButton",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "SubscriptionButton",
|
|
"description": [
|
|
"\nWrapper around `EuiButton` that provides subscription events"
|
|
],
|
|
"signature": [
|
|
"({\n subscriptionContext,\n children,\n ...restProps\n}: ",
|
|
{
|
|
"pluginId": "@kbn/subscription-tracking",
|
|
"scope": "common",
|
|
"docId": "kibKbnSubscriptionTrackingPluginApi",
|
|
"section": "def-common.SubscriptionButtonProps",
|
|
"text": "SubscriptionButtonProps"
|
|
},
|
|
") => JSX.Element"
|
|
],
|
|
"path": "packages/kbn-subscription-tracking/src/subscription_elements.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/subscription-tracking",
|
|
"id": "def-common.SubscriptionButton.$1",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "{\n subscriptionContext,\n children,\n ...restProps\n}",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/subscription-tracking",
|
|
"scope": "common",
|
|
"docId": "kibKbnSubscriptionTrackingPluginApi",
|
|
"section": "def-common.SubscriptionButtonProps",
|
|
"text": "SubscriptionButtonProps"
|
|
}
|
|
],
|
|
"path": "packages/kbn-subscription-tracking/src/subscription_elements.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/subscription-tracking",
|
|
"id": "def-common.SubscriptionButtonEmpty",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "SubscriptionButtonEmpty",
|
|
"description": [
|
|
"\nWrapper around `EuiButtonEmpty` that provides subscription events"
|
|
],
|
|
"signature": [
|
|
"({\n subscriptionContext,\n children,\n ...restProps\n}: ",
|
|
{
|
|
"pluginId": "@kbn/subscription-tracking",
|
|
"scope": "common",
|
|
"docId": "kibKbnSubscriptionTrackingPluginApi",
|
|
"section": "def-common.SubscriptionButtonEmptyProps",
|
|
"text": "SubscriptionButtonEmptyProps"
|
|
},
|
|
") => JSX.Element"
|
|
],
|
|
"path": "packages/kbn-subscription-tracking/src/subscription_elements.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/subscription-tracking",
|
|
"id": "def-common.SubscriptionButtonEmpty.$1",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "{\n subscriptionContext,\n children,\n ...restProps\n}",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/subscription-tracking",
|
|
"scope": "common",
|
|
"docId": "kibKbnSubscriptionTrackingPluginApi",
|
|
"section": "def-common.SubscriptionButtonEmptyProps",
|
|
"text": "SubscriptionButtonEmptyProps"
|
|
}
|
|
],
|
|
"path": "packages/kbn-subscription-tracking/src/subscription_elements.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/subscription-tracking",
|
|
"id": "def-common.SubscriptionLink",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "SubscriptionLink",
|
|
"description": [
|
|
"\nWrapper around `EuiLink` that provides subscription events"
|
|
],
|
|
"signature": [
|
|
"({\n subscriptionContext,\n children,\n ...restProps\n}: ",
|
|
{
|
|
"pluginId": "@kbn/subscription-tracking",
|
|
"scope": "common",
|
|
"docId": "kibKbnSubscriptionTrackingPluginApi",
|
|
"section": "def-common.SubscriptionLinkProps",
|
|
"text": "SubscriptionLinkProps"
|
|
},
|
|
") => JSX.Element"
|
|
],
|
|
"path": "packages/kbn-subscription-tracking/src/subscription_elements.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/subscription-tracking",
|
|
"id": "def-common.SubscriptionLink.$1",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "{\n subscriptionContext,\n children,\n ...restProps\n}",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/subscription-tracking",
|
|
"scope": "common",
|
|
"docId": "kibKbnSubscriptionTrackingPluginApi",
|
|
"section": "def-common.SubscriptionLinkProps",
|
|
"text": "SubscriptionLinkProps"
|
|
}
|
|
],
|
|
"path": "packages/kbn-subscription-tracking/src/subscription_elements.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/subscription-tracking",
|
|
"id": "def-common.SubscriptionTrackingProvider",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "SubscriptionTrackingProvider",
|
|
"description": [
|
|
"\nExternal services provider"
|
|
],
|
|
"signature": [
|
|
"({ children, ...services }: React.PropsWithChildren<",
|
|
{
|
|
"pluginId": "@kbn/subscription-tracking",
|
|
"scope": "common",
|
|
"docId": "kibKbnSubscriptionTrackingPluginApi",
|
|
"section": "def-common.Services",
|
|
"text": "Services"
|
|
},
|
|
">) => JSX.Element"
|
|
],
|
|
"path": "packages/kbn-subscription-tracking/src/services.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/subscription-tracking",
|
|
"id": "def-common.SubscriptionTrackingProvider.$1",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "{ children, ...services }",
|
|
"description": [],
|
|
"signature": [
|
|
"React.PropsWithChildren<",
|
|
{
|
|
"pluginId": "@kbn/subscription-tracking",
|
|
"scope": "common",
|
|
"docId": "kibKbnSubscriptionTrackingPluginApi",
|
|
"section": "def-common.Services",
|
|
"text": "Services"
|
|
},
|
|
">"
|
|
],
|
|
"path": "packages/kbn-subscription-tracking/src/services.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"interfaces": [
|
|
{
|
|
"parentPluginId": "@kbn/subscription-tracking",
|
|
"id": "def-common.Services",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "Services",
|
|
"description": [],
|
|
"path": "packages/kbn-subscription-tracking/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/subscription-tracking",
|
|
"id": "def-common.Services.navigateToApp",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "navigateToApp",
|
|
"description": [],
|
|
"signature": [
|
|
"(app: string, options: { path: string; }) => void"
|
|
],
|
|
"path": "packages/kbn-subscription-tracking/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/subscription-tracking",
|
|
"id": "def-common.Services.navigateToApp.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "app",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "packages/kbn-subscription-tracking/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/subscription-tracking",
|
|
"id": "def-common.Services.navigateToApp.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "options",
|
|
"description": [],
|
|
"path": "packages/kbn-subscription-tracking/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/subscription-tracking",
|
|
"id": "def-common.Services.navigateToApp.$2.path",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "path",
|
|
"description": [],
|
|
"path": "packages/kbn-subscription-tracking/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/subscription-tracking",
|
|
"id": "def-common.Services.analyticsClient",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "analyticsClient",
|
|
"description": [],
|
|
"signature": [
|
|
"{ reportEvent: <EventTypeData extends object>(eventType: string, eventData: EventTypeData) => void; }"
|
|
],
|
|
"path": "packages/kbn-subscription-tracking/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/subscription-tracking",
|
|
"id": "def-common.SubscriptionContextData",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "SubscriptionContextData",
|
|
"description": [
|
|
"\nA piece of metadata which consists of an identifier of the advertised feature and\nthe `source` (e.g. location) of the subscription element."
|
|
],
|
|
"path": "packages/kbn-subscription-tracking/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/subscription-tracking",
|
|
"id": "def-common.SubscriptionContextData.source",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "source",
|
|
"description": [
|
|
"\nA human-readable identifier describing the location of the beginning of the\nsubscription flow.\nLocation identifiers are prefixed with a solution identifier, e.g. `security__`\n"
|
|
],
|
|
"signature": [
|
|
"`observability__${string}` | `security__${string}`"
|
|
],
|
|
"path": "packages/kbn-subscription-tracking/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/subscription-tracking",
|
|
"id": "def-common.SubscriptionContextData.feature",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "feature",
|
|
"description": [
|
|
"\nA human-readable identifier describing the feature that is being promoted.\n"
|
|
],
|
|
"path": "packages/kbn-subscription-tracking/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"enums": [
|
|
{
|
|
"parentPluginId": "@kbn/subscription-tracking",
|
|
"id": "def-common.EVENT_NAMES",
|
|
"type": "Enum",
|
|
"tags": [],
|
|
"label": "EVENT_NAMES",
|
|
"description": [],
|
|
"path": "packages/kbn-subscription-tracking/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"misc": [
|
|
{
|
|
"parentPluginId": "@kbn/subscription-tracking",
|
|
"id": "def-common.SubscriptionButtonEmptyProps",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "SubscriptionButtonEmptyProps",
|
|
"description": [],
|
|
"signature": [
|
|
"((",
|
|
"DisambiguateSet",
|
|
"<EuiButtonEmptyPropsForAnchor, ",
|
|
"EuiButtonEmptyPropsForButton",
|
|
"> & ",
|
|
"CommonEuiButtonEmptyProps",
|
|
" & { onClick?: React.MouseEventHandler<HTMLButtonElement> | undefined; } & React.ButtonHTMLAttributes<HTMLButtonElement>) | (",
|
|
"DisambiguateSet",
|
|
"<",
|
|
"EuiButtonEmptyPropsForButton",
|
|
", EuiButtonEmptyPropsForAnchor> & ",
|
|
"CommonEuiButtonEmptyProps",
|
|
" & { href?: string | undefined; onClick?: React.MouseEventHandler<HTMLAnchorElement> | undefined; } & React.AnchorHTMLAttributes<HTMLAnchorElement>)) & CommonProps"
|
|
],
|
|
"path": "packages/kbn-subscription-tracking/src/subscription_elements.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/subscription-tracking",
|
|
"id": "def-common.SubscriptionButtonProps",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "SubscriptionButtonProps",
|
|
"description": [],
|
|
"signature": [
|
|
"EuiButtonProps",
|
|
" & CommonProps"
|
|
],
|
|
"path": "packages/kbn-subscription-tracking/src/subscription_elements.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/subscription-tracking",
|
|
"id": "def-common.SubscriptionLinkProps",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "SubscriptionLinkProps",
|
|
"description": [],
|
|
"signature": [
|
|
"((",
|
|
"DisambiguateSet",
|
|
"<",
|
|
"EuiLinkButtonProps",
|
|
", ",
|
|
"EuiLinkAnchorProps",
|
|
"> & ",
|
|
"EuiLinkAnchorProps",
|
|
") | (",
|
|
"DisambiguateSet",
|
|
"<",
|
|
"EuiLinkAnchorProps",
|
|
", ",
|
|
"EuiLinkButtonProps",
|
|
"> & ",
|
|
"EuiLinkButtonProps",
|
|
")) & CommonProps"
|
|
],
|
|
"path": "packages/kbn-subscription-tracking/src/subscription_elements.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"objects": [
|
|
{
|
|
"parentPluginId": "@kbn/subscription-tracking",
|
|
"id": "def-common.SubscriptionTrackingContext",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "SubscriptionTrackingContext",
|
|
"description": [],
|
|
"signature": [
|
|
"React.Context<",
|
|
{
|
|
"pluginId": "@kbn/subscription-tracking",
|
|
"scope": "common",
|
|
"docId": "kibKbnSubscriptionTrackingPluginApi",
|
|
"section": "def-common.Services",
|
|
"text": "Services"
|
|
},
|
|
" | null>"
|
|
],
|
|
"path": "packages/kbn-subscription-tracking/src/services.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
}
|
|
]
|
|
}
|
|
} |