From 5d1b659e2fd36c486fc2f4790ad133b7ba2ef9b4 Mon Sep 17 00:00:00 2001 From: Steve Faulkner Date: Mon, 17 May 2021 10:40:23 -0500 Subject: [PATCH 001/124] Revert "Migrate Collapse/Open Resource Tree to React (#733)" (#792) This reverts commit d7c62ac7f17501f3c8b85943d3f190ac07ff1cf8. --- less/documentDB.less | 6 +- less/tree.less | 1 - src/Common/CollapsedResourceTree.tsx | 35 ------ src/Common/ResourceTree.tsx | 59 ---------- .../SettingsComponent.test.tsx.snap | 8 ++ src/Explorer/Explorer.tsx | 23 +++- .../GitHubReposPanel.test.tsx.snap | 2 + .../StringInputPane.test.tsx.snap | 2 + ...eteDatabaseConfirmationPanel.test.tsx.snap | 2 + src/Main.tsx | 106 +++++++++++++++--- 10 files changed, 124 insertions(+), 120 deletions(-) delete mode 100644 src/Common/CollapsedResourceTree.tsx delete mode 100644 src/Common/ResourceTree.tsx diff --git a/less/documentDB.less b/less/documentDB.less index 5fc2f8571..e58206818 100644 --- a/less/documentDB.less +++ b/less/documentDB.less @@ -2099,7 +2099,7 @@ a:link { display: flex; flex: 1 1 auto; overflow-x: auto; - overflow-y: hidden; + overflow-y: auto; height: 100%; } @@ -3085,7 +3085,3 @@ settings-pane { padding-left: @SmallSpace; } } -.hiddenMain { - visibility: hidden; - height: 0px; -} \ No newline at end of file diff --git a/less/tree.less b/less/tree.less index e60bcf69c..56a5ee38e 100644 --- a/less/tree.less +++ b/less/tree.less @@ -3,7 +3,6 @@ .resourceTree { height: 100%; - width: 20%; flex: 0 0 auto; .main { height: 100%; diff --git a/src/Common/CollapsedResourceTree.tsx b/src/Common/CollapsedResourceTree.tsx deleted file mode 100644 index ea1ee6a32..000000000 --- a/src/Common/CollapsedResourceTree.tsx +++ /dev/null @@ -1,35 +0,0 @@ -import React, { FunctionComponent } from "react"; -import arrowLeftImg from "../../images/imgarrowlefticon.svg"; - -export interface CollapsedResourceTreeProps { - toggleLeftPaneExpanded: () => void; - isLeftPaneExpanded: boolean; -} - -export const CollapsedResourceTree: FunctionComponent = ({ - toggleLeftPaneExpanded, - isLeftPaneExpanded, -}: CollapsedResourceTreeProps): JSX.Element => { - return ( -
-
-
    -
  • - - Expand - - - - -
    • -
-
-
- ); -}; diff --git a/src/Common/ResourceTree.tsx b/src/Common/ResourceTree.tsx deleted file mode 100644 index 9aae283ea..000000000 --- a/src/Common/ResourceTree.tsx +++ /dev/null @@ -1,59 +0,0 @@ -import React, { FunctionComponent } from "react"; -import arrowLeftImg from "../../images/imgarrowlefticon.svg"; -import refreshImg from "../../images/refresh-cosmos.svg"; -import { AuthType } from "../AuthType"; -import { userContext } from "../UserContext"; - -export interface ResourceTreeProps { - toggleLeftPaneExpanded: () => void; - isLeftPaneExpanded: boolean; -} - -export const ResourceTree: FunctionComponent = ({ - toggleLeftPaneExpanded, - isLeftPaneExpanded, -}: ResourceTreeProps): JSX.Element => { - return ( -
- {/* Collections Window - - Start */} -
- {/* Collections Window Title/Command Bar - Start */} -
-
- -
- - Refresh tree - - - Hide - -
-
-
- {userContext.authType === AuthType.ResourceToken ? ( -
- ) : ( -
- )} -
- {/* Collections Window - End */} -
- ); -}; diff --git a/src/Explorer/Controls/Settings/__snapshots__/SettingsComponent.test.tsx.snap b/src/Explorer/Controls/Settings/__snapshots__/SettingsComponent.test.tsx.snap index 7a23e0a3a..adfb92b42 100644 --- a/src/Explorer/Controls/Settings/__snapshots__/SettingsComponent.test.tsx.snap +++ b/src/Explorer/Controls/Settings/__snapshots__/SettingsComponent.test.tsx.snap @@ -879,6 +879,7 @@ exports[`SettingsComponent renders 1`] = ` "isAutoscaleDefaultEnabled": [Function], "isFixedCollectionWithSharedThroughputSupported": [Function], "isHostedDataExplorerEnabled": [Function], + "isLeftPaneExpanded": [Function], "isMongoIndexingEnabled": [Function], "isNotebookEnabled": [Function], "isNotebooksEnabledForAccount": [Function], @@ -945,6 +946,7 @@ exports[`SettingsComponent renders 1`] = ` "activeTab": [Function], "openedTabs": [Function], }, + "toggleLeftPaneExpandedKeyPress": [Function], }, "databaseId": "test", "defaultTtl": [Function], @@ -1817,6 +1819,7 @@ exports[`SettingsComponent renders 1`] = ` "isAutoscaleDefaultEnabled": [Function], "isFixedCollectionWithSharedThroughputSupported": [Function], "isHostedDataExplorerEnabled": [Function], + "isLeftPaneExpanded": [Function], "isMongoIndexingEnabled": [Function], "isNotebookEnabled": [Function], "isNotebooksEnabledForAccount": [Function], @@ -1883,6 +1886,7 @@ exports[`SettingsComponent renders 1`] = ` "activeTab": [Function], "openedTabs": [Function], }, + "toggleLeftPaneExpandedKeyPress": [Function], } } isAutoPilotSelected={false} @@ -2768,6 +2772,7 @@ exports[`SettingsComponent renders 1`] = ` "isAutoscaleDefaultEnabled": [Function], "isFixedCollectionWithSharedThroughputSupported": [Function], "isHostedDataExplorerEnabled": [Function], + "isLeftPaneExpanded": [Function], "isMongoIndexingEnabled": [Function], "isNotebookEnabled": [Function], "isNotebooksEnabledForAccount": [Function], @@ -2834,6 +2839,7 @@ exports[`SettingsComponent renders 1`] = ` "activeTab": [Function], "openedTabs": [Function], }, + "toggleLeftPaneExpandedKeyPress": [Function], }, "databaseId": "test", "defaultTtl": [Function], @@ -3706,6 +3712,7 @@ exports[`SettingsComponent renders 1`] = ` "isAutoscaleDefaultEnabled": [Function], "isFixedCollectionWithSharedThroughputSupported": [Function], "isHostedDataExplorerEnabled": [Function], + "isLeftPaneExpanded": [Function], "isMongoIndexingEnabled": [Function], "isNotebookEnabled": [Function], "isNotebooksEnabledForAccount": [Function], @@ -3772,6 +3779,7 @@ exports[`SettingsComponent renders 1`] = ` "activeTab": [Function], "openedTabs": [Function], }, + "toggleLeftPaneExpandedKeyPress": [Function], } } geospatialConfigType="Geometry" diff --git a/src/Explorer/Explorer.tsx b/src/Explorer/Explorer.tsx index 0643f90a7..85a377370 100644 --- a/src/Explorer/Explorer.tsx +++ b/src/Explorer/Explorer.tsx @@ -131,6 +131,7 @@ export default class Explorer { public databases: ko.ObservableArray; public selectedDatabaseId: ko.Computed; public selectedCollectionId: ko.Computed; + public isLeftPaneExpanded: ko.Observable; public selectedNode: ko.Observable; private resourceTree: ResourceTreeAdapter; @@ -222,7 +223,6 @@ export default class Explorer { }); } }); - this.isNotebooksEnabledForAccount = ko.observable(false); this.isNotebooksEnabledForAccount.subscribe((isEnabledForAccount: boolean) => this.refreshCommandBarButtons()); this.isSparkEnabledForAccount = ko.observable(false); @@ -327,6 +327,7 @@ export default class Explorer { } return true; }); + this.isLeftPaneExpanded = ko.observable(true); this.selectedNode = ko.observable(); this.selectedNode.subscribe((nodeSelected: ViewModels.TreeNode) => { // Make sure switching tabs restores tabs display @@ -645,8 +646,16 @@ export default class Explorer { this.setIsNotificationConsoleExpanded(true); } - public collapseConsole(): void { - this.setIsNotificationConsoleExpanded(false); + public toggleLeftPaneExpanded() { + this.isLeftPaneExpanded(!this.isLeftPaneExpanded()); + + if (this.isLeftPaneExpanded()) { + document.getElementById("expandToggleLeftPaneButton").focus(); + this.splitter.expandLeft(); + } else { + document.getElementById("collapseToggleLeftPaneButton").focus(); + this.splitter.collapseLeft(); + } } public refreshDatabaseForResourceToken(): Q.Promise { @@ -765,6 +774,14 @@ export default class Explorer { this.refreshNotebookList(); }; + public toggleLeftPaneExpandedKeyPress = (source: any, event: KeyboardEvent): boolean => { + if (event.keyCode === Constants.KeyCodes.Space || event.keyCode === Constants.KeyCodes.Enter) { + this.toggleLeftPaneExpanded(); + return false; + } + return true; + }; + // Facade public provideFeedbackEmail = () => { window.open(Constants.Urls.feedbackEmail, "_blank"); diff --git a/src/Explorer/Panes/GitHubReposPanel/__snapshots__/GitHubReposPanel.test.tsx.snap b/src/Explorer/Panes/GitHubReposPanel/__snapshots__/GitHubReposPanel.test.tsx.snap index 3ddac360f..417bbd332 100644 --- a/src/Explorer/Panes/GitHubReposPanel/__snapshots__/GitHubReposPanel.test.tsx.snap +++ b/src/Explorer/Panes/GitHubReposPanel/__snapshots__/GitHubReposPanel.test.tsx.snap @@ -868,6 +868,7 @@ exports[`GitHub Repos Panel should render Default properly 1`] = ` "isAutoscaleDefaultEnabled": [Function], "isFixedCollectionWithSharedThroughputSupported": [Function], "isHostedDataExplorerEnabled": [Function], + "isLeftPaneExpanded": [Function], "isMongoIndexingEnabled": [Function], "isNotebookEnabled": [Function], "isNotebooksEnabledForAccount": [Function], @@ -934,6 +935,7 @@ exports[`GitHub Repos Panel should render Default properly 1`] = ` "activeTab": [Function], "openedTabs": [Function], }, + "toggleLeftPaneExpandedKeyPress": [Function], }, "getRepo": [Function], "pinRepo": [Function], diff --git a/src/Explorer/Panes/StringInputPane/__snapshots__/StringInputPane.test.tsx.snap b/src/Explorer/Panes/StringInputPane/__snapshots__/StringInputPane.test.tsx.snap index 2bec097e8..77a3af75a 100644 --- a/src/Explorer/Panes/StringInputPane/__snapshots__/StringInputPane.test.tsx.snap +++ b/src/Explorer/Panes/StringInputPane/__snapshots__/StringInputPane.test.tsx.snap @@ -858,6 +858,7 @@ exports[`StringInput Pane should render Create new directory properly 1`] = ` "isAutoscaleDefaultEnabled": [Function], "isFixedCollectionWithSharedThroughputSupported": [Function], "isHostedDataExplorerEnabled": [Function], + "isLeftPaneExpanded": [Function], "isMongoIndexingEnabled": [Function], "isNotebookEnabled": [Function], "isNotebooksEnabledForAccount": [Function], @@ -924,6 +925,7 @@ exports[`StringInput Pane should render Create new directory properly 1`] = ` "activeTab": [Function], "openedTabs": [Function], }, + "toggleLeftPaneExpandedKeyPress": [Function], } } inProgressMessage="Creating directory " diff --git a/src/Explorer/Panes/__snapshots__/DeleteDatabaseConfirmationPanel.test.tsx.snap b/src/Explorer/Panes/__snapshots__/DeleteDatabaseConfirmationPanel.test.tsx.snap index 8cbd0e904..44a530919 100644 --- a/src/Explorer/Panes/__snapshots__/DeleteDatabaseConfirmationPanel.test.tsx.snap +++ b/src/Explorer/Panes/__snapshots__/DeleteDatabaseConfirmationPanel.test.tsx.snap @@ -858,6 +858,7 @@ exports[`Delete Database Confirmation Pane submit() Should call delete database "isHostedDataExplorerEnabled": [Function], "isLastCollection": [Function], "isLastNonEmptyDatabase": [Function], + "isLeftPaneExpanded": [Function], "isMongoIndexingEnabled": [Function], "isNotebookEnabled": [Function], "isNotebooksEnabledForAccount": [Function], @@ -926,6 +927,7 @@ exports[`Delete Database Confirmation Pane submit() Should call delete database "activeTab": [Function], "openedTabs": [Function], }, + "toggleLeftPaneExpandedKeyPress": [Function], } } openNotificationConsole={[Function]} diff --git a/src/Main.tsx b/src/Main.tsx index c4c3be41c..b99d951b0 100644 --- a/src/Main.tsx +++ b/src/Main.tsx @@ -14,6 +14,8 @@ import "../externals/jquery.typeahead.min.js"; import "../images/CosmosDB_rgb_ui_lighttheme.ico"; import "../images/favicon.ico"; import hdeConnectImage from "../images/HdeConnectCosmosDB.svg"; +import arrowLeftImg from "../images/imgarrowlefticon.svg"; +import refreshImg from "../images/refresh-cosmos.svg"; import "../less/documentDB.less"; import "../less/forms.less"; import "../less/infobox.less"; @@ -25,8 +27,7 @@ import "../less/TableStyles/EntityEditor.less"; import "../less/TableStyles/fulldatatables.less"; import "../less/TableStyles/queryBuilder.less"; import "../less/tree.less"; -import { CollapsedResourceTree } from "./Common/CollapsedResourceTree"; -import { ResourceTree } from "./Common/ResourceTree"; +import { AuthType } from "./AuthType"; import "./Explorer/Controls/Accordion/AccordionComponent.less"; import "./Explorer/Controls/CollapsiblePanel/CollapsiblePanelComponent.less"; import { Dialog, DialogProps } from "./Explorer/Controls/Dialog"; @@ -53,6 +54,7 @@ import { useSidePanel } from "./hooks/useSidePanel"; import { useTabs } from "./hooks/useTabs"; import "./Libs/jquery"; import "./Shared/appInsights"; +import { userContext } from "./UserContext"; initializeIcons(); @@ -61,7 +63,6 @@ const App: React.FunctionComponent = () => { const [notificationConsoleData, setNotificationConsoleData] = useState(undefined); //TODO: Refactor so we don't need to pass the id to remove a console data const [inProgressConsoleDataIdToBeDeleted, setInProgressConsoleDataIdToBeDeleted] = useState(""); - const [isLeftPaneExpanded, setIsLeftPaneExpanded] = useState(true); const [dialogProps, setDialogProps] = useState(); const [showDialog, setShowDialog] = useState(false); @@ -91,15 +92,6 @@ const App: React.FunctionComponent = () => { const config = useConfig(); const explorer = useKnockoutExplorer(config?.platform, explorerParams); - const toggleLeftPaneExpanded = () => { - setIsLeftPaneExpanded(!isLeftPaneExpanded); - if (isLeftPaneExpanded) { - document.getElementById("expandToggleLeftPaneButton").focus(); - } else { - document.getElementById("collapseToggleLeftPaneButton").focus(); - } - }; - if (!explorer) { return ; } @@ -115,13 +107,93 @@ const App: React.FunctionComponent = () => {
{/* Collections Tree Expanded - Start */} - +
+ {/* Collections Window - - Start */} +
+ {/* Collections Window Title/Command Bar - Start */} +
+
+ +
+ + + + + Hide + +
+
+
+ {userContext.authType === AuthType.ResourceToken ? ( +
+ ) : ( +
+ )} +
+ {/* Collections Window - End */} +
{/* Collections Tree Expanded - End */} {/* Collections Tree Collapsed - Start */} - +
+
+
    +
  • + + Expand + + + + +
    • +
+
+
{/* Collections Tree Collapsed - End */}
{/* Splitter - Start */} From 4f3b2f7996a91cc518e186362e56f25b8ca0153f Mon Sep 17 00:00:00 2001 From: Laurent Nguyen Date: Mon, 17 May 2021 17:57:12 +0200 Subject: [PATCH 002/124] Add 'import 'jquery-typeahead' to fix InputTypeahead in GraphExplorer (#793) --- .../Controls/InputTypeahead/InputTypeaheadComponent.tsx | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/src/Explorer/Controls/InputTypeahead/InputTypeaheadComponent.tsx b/src/Explorer/Controls/InputTypeahead/InputTypeaheadComponent.tsx index 22aa71388..69f01a745 100644 --- a/src/Explorer/Controls/InputTypeahead/InputTypeaheadComponent.tsx +++ b/src/Explorer/Controls/InputTypeahead/InputTypeaheadComponent.tsx @@ -6,9 +6,10 @@ * typeaheadOverrideOptions: { dynamic:false } * */ +import "jquery-typeahead"; import * as React from "react"; -import "./InputTypeahead.less"; import { KeyCodes } from "../../../Common/Constants"; +import "./InputTypeahead.less"; export interface Item { caption: string; From a06e213b818a638d8bd7240dc81395e599131573 Mon Sep 17 00:00:00 2001 From: Zachary Foster Date: Mon, 17 May 2021 14:10:54 -0400 Subject: [PATCH 003/124] Upgrades to msal-browser (#781) * Replaces msal with msal-browser * Remove unused id, logging in returns the tenant * format * Fix tenant switch * Removes v1 forceRefresh --- package-lock.json | 18 +++++++++++ package.json | 2 +- .../Hosted/Components/MeControl.test.tsx | 4 +-- src/Platform/Hosted/Components/MeControl.tsx | 8 ++--- src/hooks/useAADAuth.ts | 30 +++++++++---------- 5 files changed, 39 insertions(+), 23 deletions(-) diff --git a/package-lock.json b/package-lock.json index c9ed3c821..a14e6d566 100644 --- a/package-lock.json +++ b/package-lock.json @@ -275,6 +275,24 @@ "adal-node": "^0.1.28" } }, + "@azure/msal-browser": { + "version": "2.14.2", + "resolved": "https://registry.npmjs.org/@azure/msal-browser/-/msal-browser-2.14.2.tgz", + "integrity": "sha512-JKHE9Rer41CI8tweiyE91M8ZbGvQV9P+jOPB4ZtPxyxCi2f7ED3jNfdzyUJ1eGB+hCRnvO56M1Xc61T1R+JfYg==", + "requires": { + "@azure/msal-common": "^4.3.0" + }, + "dependencies": { + "@azure/msal-common": { + "version": "4.3.0", + "resolved": "https://registry.npmjs.org/@azure/msal-common/-/msal-common-4.3.0.tgz", + "integrity": "sha512-jFqUWe83wVb6O8cNGGBFg2QlKvqM1ezUgJTEV7kIsAPX0RXhGFE4B1DLNt6hCnkTXDbw+KGW0zgxOEr4MJQwLw==", + "requires": { + "debug": "^4.1.1" + } + } + } + }, "@azure/msal-common": { "version": "1.7.2", "resolved": "https://registry.npmjs.org/@azure/msal-common/-/msal-common-1.7.2.tgz", diff --git a/package.json b/package.json index 467ec71a7..caf25c982 100644 --- a/package.json +++ b/package.json @@ -9,6 +9,7 @@ "@azure/cosmos-language-service": "0.0.5", "@azure/identity": "1.2.1", "@azure/ms-rest-nodeauth": "3.0.7", + "@azure/msal-browser": "2.14.2", "@babel/plugin-proposal-class-properties": "7.12.1", "@babel/plugin-proposal-decorators": "7.12.12", "@fluentui/react": "8.14.3", @@ -75,7 +76,6 @@ "mkdirp": "1.0.4", "monaco-editor": "0.18.1", "ms": "2.1.3", - "msal": "1.4.4", "p-retry": "4.2.0", "plotly.js-cartesian-dist-min": "1.52.3", "post-robot": "10.0.42", diff --git a/src/Platform/Hosted/Components/MeControl.test.tsx b/src/Platform/Hosted/Components/MeControl.test.tsx index 4c5823e07..b2911d145 100644 --- a/src/Platform/Hosted/Components/MeControl.test.tsx +++ b/src/Platform/Hosted/Components/MeControl.test.tsx @@ -1,12 +1,12 @@ jest.mock("../../../hooks/useDirectories"); +import { AccountInfo } from "@azure/msal-browser"; import "@testing-library/jest-dom"; import { fireEvent, render, screen } from "@testing-library/react"; import React from "react"; import { MeControl } from "./MeControl"; -import { Account } from "msal"; it("renders", () => { - const account = {} as Account; + const account = {} as AccountInfo; const logout = jest.fn(); const openPanel = jest.fn(); diff --git a/src/Platform/Hosted/Components/MeControl.tsx b/src/Platform/Hosted/Components/MeControl.tsx index 4765256aa..4432d0226 100644 --- a/src/Platform/Hosted/Components/MeControl.tsx +++ b/src/Platform/Hosted/Components/MeControl.tsx @@ -1,11 +1,11 @@ -import { FocusZone, DefaultButton, DirectionalHint, Persona, PersonaInitialsColor, PersonaSize } from "@fluentui/react"; +import { AccountInfo } from "@azure/msal-browser"; +import { DefaultButton, DirectionalHint, FocusZone, Persona, PersonaInitialsColor, PersonaSize } from "@fluentui/react"; import * as React from "react"; -import { Account } from "msal"; import { useGraphPhoto } from "../../../hooks/useGraphPhoto"; interface Props { graphToken: string; - account: Account; + account: AccountInfo; openPanel: () => void; logout: () => void; } @@ -48,7 +48,7 @@ export const MeControl: React.FunctionComponent = ({ openPanel, logout, a void; logout: () => void; tenantId: string; - account: Account; + account: msal.AccountInfo; switchTenant: (tenantId: string) => void; } @@ -36,13 +36,14 @@ export function useAADAuth(): ReturnType { const [isLoggedIn, { setTrue: setLoggedIn, setFalse: setLoggedOut }] = useBoolean( Boolean(cachedAccount && cachedTenantId) || false ); - const [account, setAccount] = React.useState(cachedAccount); + const [account, setAccount] = React.useState(cachedAccount); const [tenantId, setTenantId] = React.useState(cachedTenantId); const [graphToken, setGraphToken] = React.useState(); const [armToken, setArmToken] = React.useState(); + msalInstance.setActiveAccount(account); const login = React.useCallback(async () => { - const response = await msal.loginPopup(); + const response = await msalInstance.loginPopup(); setLoggedIn(); setAccount(response.account); setTenantId(response.tenantId); @@ -52,13 +53,14 @@ export function useAADAuth(): ReturnType { const logout = React.useCallback(() => { setLoggedOut(); localStorage.removeItem("cachedTenantId"); - msal.logout(); + msalInstance.logoutRedirect(); }, []); const switchTenant = React.useCallback( async (id) => { - const response = await msal.loginPopup({ + const response = await msalInstance.loginPopup({ authority: `https://login.microsoftonline.com/${id}`, + scopes: [], }); setTenantId(response.tenantId); setAccount(response.account); @@ -69,15 +71,11 @@ export function useAADAuth(): ReturnType { React.useEffect(() => { if (account && tenantId) { Promise.all([ - msal.acquireTokenSilent({ - // There is a bug in MSALv1 that requires us to refresh the token. Their internal cache is not respecting authority - forceRefresh: true, + msalInstance.acquireTokenSilent({ authority: `https://login.microsoftonline.com/${tenantId}`, scopes: ["https://graph.windows.net//.default"], }), - msal.acquireTokenSilent({ - // There is a bug in MSALv1 that requires us to refresh the token. Their internal cache is not respecting authority - forceRefresh: true, + msalInstance.acquireTokenSilent({ authority: `https://login.microsoftonline.com/${tenantId}`, scopes: ["https://management.azure.com//.default"], }), From 62e205be6ac051ab2f402aad809e8a57c8c90f2b Mon Sep 17 00:00:00 2001 From: Srinath Narayanan Date: Mon, 17 May 2021 16:10:15 -0700 Subject: [PATCH 004/124] Added documentation for Self Serve Model (#716) * initial commit for docs * Added readme * modified selfServeutil docs * updated docs * moved documentation to docs folder * Updated ReadME for selfserve * added more comments * Added more function types * Update index.html * Update index.html * minro edits * minor edits * package.json updated * Added Module decorators * Added modules * initial commit for mongo shell refactor * undid changes * addressed PR comments * docs changes * addressed PR comments * More changes * Added selfserveexample types file * minor edits * minor edits * Addressed PR comments * format changes * added Metrics blade link * documentation changes * updated docs * Addressed PR comments * fixed format error --- docs/assets/css/main.css | 2660 +++++++++++++++++ docs/assets/images/icons.png | Bin 0 -> 9615 bytes docs/assets/images/icons@2x.png | Bin 0 -> 28144 bytes docs/assets/images/widgets.png | Bin 0 -> 480 bytes docs/assets/images/widgets@2x.png | Bin 0 -> 855 bytes docs/assets/js/main.js | 248 ++ docs/assets/js/search.js | 1 + ...rve_selfservetypes.selfservebaseclass.html | 306 ++ ...fserve_selfservetypes.descriptiontype.html | 245 ++ ...selfserve_selfservetypes.numberuitype.html | 229 ++ .../selfserve_selfserveutils.bladetype.html | 264 ++ ...elfserve_selfserveutils.selfservetype.html | 201 ++ docs/index.html | 209 ++ ...fserve_decorators.booleaninputoptions.html | 255 ++ ...lfserve_decorators.choiceinputoptions.html | 255 ++ ..._decorators.descriptiondisplayoptions.html | 249 ++ ...lfserve_decorators.numberinputoptions.html | 287 ++ ...lfserve_decorators.stringinputoptions.html | 239 ++ .../selfserve_selfservetypes.description.html | 277 ++ .../selfserve_selfservetypes.info.html | 266 ++ ...selfserve_selfservetypes.onsaveresult.html | 321 ++ ...elfserve_selfservetypes.refreshparams.html | 222 ++ ...elfserve_selfservetypes.refreshresult.html | 239 ++ ...fservetypes.selfservetelemetrymessage.html | 227 ++ ...selfserve_selfservetypes.smartuiinput.html | 254 ++ docs/modules.html | 138 + docs/modules/selfserve.html | 498 +++ ...fserve___what_is_currently_supported_.html | 149 + docs/modules/selfserve_decorators.html | 341 +++ ...selfserve_selfservetelemetryprocessor.html | 323 ++ docs/modules/selfserve_selfservetypes.html | 363 +++ docs/modules/selfserve_selfserveutils.html | 185 ++ package-lock.json | 165 + package.json | 2 + src/SelfServe/Decorators.tsx | 98 +- src/SelfServe/Documentation/Documentation.ts | 5 + src/SelfServe/Documentation/README.md | 357 +++ .../Documentation/SupportedFeatures.md | 12 + .../Documentation/SupportedFeatures.ts | 5 + src/SelfServe/Example/SelfServeExample.rp.ts | 40 +- src/SelfServe/Example/SelfServeExample.tsx | 107 +- .../Example/SelfServeExample.types.ts | 13 + src/SelfServe/SelfServe.tsx | 2 +- src/SelfServe/SelfServeTelemetryProcessor.ts | 29 + src/SelfServe/SelfServeTypes.ts | 185 +- src/SelfServe/SelfServeUtils.tsx | 56 +- tsconfig.json | 14 + 47 files changed, 10399 insertions(+), 142 deletions(-) create mode 100644 docs/assets/css/main.css create mode 100644 docs/assets/images/icons.png create mode 100644 docs/assets/images/icons@2x.png create mode 100644 docs/assets/images/widgets.png create mode 100644 docs/assets/images/widgets@2x.png create mode 100644 docs/assets/js/main.js create mode 100644 docs/assets/js/search.js create mode 100644 docs/classes/selfserve_selfservetypes.selfservebaseclass.html create mode 100644 docs/enums/selfserve_selfservetypes.descriptiontype.html create mode 100644 docs/enums/selfserve_selfservetypes.numberuitype.html create mode 100644 docs/enums/selfserve_selfserveutils.bladetype.html create mode 100644 docs/enums/selfserve_selfserveutils.selfservetype.html create mode 100644 docs/index.html create mode 100644 docs/interfaces/selfserve_decorators.booleaninputoptions.html create mode 100644 docs/interfaces/selfserve_decorators.choiceinputoptions.html create mode 100644 docs/interfaces/selfserve_decorators.descriptiondisplayoptions.html create mode 100644 docs/interfaces/selfserve_decorators.numberinputoptions.html create mode 100644 docs/interfaces/selfserve_decorators.stringinputoptions.html create mode 100644 docs/interfaces/selfserve_selfservetypes.description.html create mode 100644 docs/interfaces/selfserve_selfservetypes.info.html create mode 100644 docs/interfaces/selfserve_selfservetypes.onsaveresult.html create mode 100644 docs/interfaces/selfserve_selfservetypes.refreshparams.html create mode 100644 docs/interfaces/selfserve_selfservetypes.refreshresult.html create mode 100644 docs/interfaces/selfserve_selfservetypes.selfservetelemetrymessage.html create mode 100644 docs/interfaces/selfserve_selfservetypes.smartuiinput.html create mode 100644 docs/modules.html create mode 100644 docs/modules/selfserve.html create mode 100644 docs/modules/selfserve___what_is_currently_supported_.html create mode 100644 docs/modules/selfserve_decorators.html create mode 100644 docs/modules/selfserve_selfservetelemetryprocessor.html create mode 100644 docs/modules/selfserve_selfservetypes.html create mode 100644 docs/modules/selfserve_selfserveutils.html create mode 100644 src/SelfServe/Documentation/Documentation.ts create mode 100644 src/SelfServe/Documentation/README.md create mode 100644 src/SelfServe/Documentation/SupportedFeatures.md create mode 100644 src/SelfServe/Documentation/SupportedFeatures.ts create mode 100644 src/SelfServe/Example/SelfServeExample.types.ts diff --git a/docs/assets/css/main.css b/docs/assets/css/main.css new file mode 100644 index 000000000..46571c27c --- /dev/null +++ b/docs/assets/css/main.css @@ -0,0 +1,2660 @@ +:root { + --color-background: #fdfdfd; + --color-text: #222; + --color-text-aside: #707070; + --color-link: #4da6ff; + --color-menu-divider: #eee; + --color-menu-divider-focus: #000; + --color-menu-label: #707070; + --color-panel: #fff; + --color-panel-divider: #eee; + --color-comment-tag: #707070; + --color-comment-tag-text: #fff; + --color-code-background: rgba(0, 0, 0, 0.04); + --color-ts: #9600ff; + --color-ts-interface: #647f1b; + --color-ts-enum: #937210; + --color-ts-class: #0672de; + --color-ts-private: #707070; + --color-toolbar: #fff; + --color-toolbar-text: #333; +} + +/*! normalize.css v1.1.3 | MIT License | git.io/normalize */ +/* ========================================================================== + * * HTML5 display definitions + * * ========================================================================== */ +/** + * * Correct `block` display not defined in IE 6/7/8/9 and Firefox 3. */ +article, aside, details, figcaption, figure, footer, header, hgroup, main, nav, section, summary { + display: block; +} + +/** + * * Correct `inline-block` display not defined in IE 6/7/8/9 and Firefox 3. */ +audio, canvas, video { + display: inline-block; + *display: inline; + *zoom: 1; +} + +/** + * * Prevent modern browsers from displaying `audio` without controls. + * * Remove excess height in iOS 5 devices. */ +audio:not([controls]) { + display: none; + height: 0; +} + +/** + * * Address styling not present in IE 7/8/9, Firefox 3, and Safari 4. + * * Known issue: no IE 6 support. */ +[hidden] { + display: none; +} + +/* ========================================================================== + * * Base + * * ========================================================================== */ +/** + * * 1. Correct text resizing oddly in IE 6/7 when body `font-size` is set using + * * `em` units. + * * 2. Prevent iOS text size adjust after orientation change, without disabling + * * user zoom. */ +html { + font-size: 100%; + /* 1 */ + -ms-text-size-adjust: 100%; + /* 2 */ + -webkit-text-size-adjust: 100%; + /* 2 */ + font-family: sans-serif; +} + +/** + * * Address `font-family` inconsistency between `textarea` and other form + * * elements. */ +button, input, select, textarea { + font-family: sans-serif; +} + +/** + * * Address margins handled incorrectly in IE 6/7. */ +body { + margin: 0; +} + +/* ========================================================================== + * * Links + * * ========================================================================== */ +/** + * * Address `outline` inconsistency between Chrome and other browsers. */ +a:focus { + outline: thin dotted; +} +a:active, a:hover { + outline: 0; +} + +/** + * * Improve readability when focused and also mouse hovered in all browsers. */ +/* ========================================================================== + * * Typography + * * ========================================================================== */ +/** + * * Address font sizes and margins set differently in IE 6/7. + * * Address font sizes within `section` and `article` in Firefox 4+, Safari 5, + * * and Chrome. */ +h1 { + font-size: 2em; + margin: 0.67em 0; +} + +h2 { + font-size: 1.5em; + margin: 0.83em 0; +} + +h3 { + font-size: 1.17em; + margin: 1em 0; +} + +h4, .tsd-index-panel h3 { + font-size: 1em; + margin: 1.33em 0; +} + +h5 { + font-size: 0.83em; + margin: 1.67em 0; +} + +h6 { + font-size: 0.67em; + margin: 2.33em 0; +} + +/** + * * Address styling not present in IE 7/8/9, Safari 5, and Chrome. */ +abbr[title] { + border-bottom: 1px dotted; +} + +/** + * * Address style set to `bolder` in Firefox 3+, Safari 4/5, and Chrome. */ +b, strong { + font-weight: bold; +} + +blockquote { + margin: 1em 40px; +} + +/** + * * Address styling not present in Safari 5 and Chrome. */ +dfn { + font-style: italic; +} + +/** + * * Address differences between Firefox and other browsers. + * * Known issue: no IE 6/7 normalization. */ +hr { + -moz-box-sizing: content-box; + box-sizing: content-box; + height: 0; +} + +/** + * * Address styling not present in IE 6/7/8/9. */ +mark { + background: #ff0; + color: #000; +} + +/** + * * Address margins set differently in IE 6/7. */ +p, pre { + margin: 1em 0; +} + +/** + * * Correct font family set oddly in IE 6, Safari 4/5, and Chrome. */ +code, kbd, pre, samp { + font-family: monospace, serif; + _font-family: "courier new", monospace; + font-size: 1em; +} + +/** + * * Improve readability of pre-formatted text in all browsers. */ +pre { + white-space: pre; + white-space: pre-wrap; + word-wrap: break-word; +} + +/** + * * Address CSS quotes not supported in IE 6/7. */ +q { + quotes: none; +} +q:before, q:after { + content: ""; + content: none; +} + +/** + * * Address `quotes` property not supported in Safari 4. */ +/** + * * Address inconsistent and variable font size in all browsers. */ +small { + font-size: 80%; +} + +/** + * * Prevent `sub` and `sup` affecting `line-height` in all browsers. */ +sub { + font-size: 75%; + line-height: 0; + position: relative; + vertical-align: baseline; +} + +sup { + font-size: 75%; + line-height: 0; + position: relative; + vertical-align: baseline; + top: -0.5em; +} + +sub { + bottom: -0.25em; +} + +/* ========================================================================== + * * Lists + * * ========================================================================== */ +/** + * * Address margins set differently in IE 6/7. */ +dl, menu, ol, ul { + margin: 1em 0; +} + +dd { + margin: 0 0 0 40px; +} + +/** + * * Address paddings set differently in IE 6/7. */ +menu, ol, ul { + padding: 0 0 0 40px; +} + +/** + * * Correct list images handled incorrectly in IE 7. */ +nav ul, nav ol { + list-style: none; + list-style-image: none; +} + +/* ========================================================================== + * * Embedded content + * * ========================================================================== */ +/** + * * 1. Remove border when inside `a` element in IE 6/7/8/9 and Firefox 3. + * * 2. Improve image quality when scaled in IE 7. */ +img { + border: 0; + /* 1 */ + -ms-interpolation-mode: bicubic; +} + +/* 2 */ +/** + * * Correct overflow displayed oddly in IE 9. */ +svg:not(:root) { + overflow: hidden; +} + +/* ========================================================================== + * * Figures + * * ========================================================================== */ +/** + * * Address margin not present in IE 6/7/8/9, Safari 5, and Opera 11. */ +figure, form { + margin: 0; +} + +/* ========================================================================== + * * Forms + * * ========================================================================== */ +/** + * * Correct margin displayed oddly in IE 6/7. */ +/** + * * Define consistent border, margin, and padding. */ +fieldset { + border: 1px solid #c0c0c0; + margin: 0 2px; + padding: 0.35em 0.625em 0.75em; +} + +/** + * * 1. Correct color not being inherited in IE 6/7/8/9. + * * 2. Correct text not wrapping in Firefox 3. + * * 3. Correct alignment displayed oddly in IE 6/7. */ +legend { + border: 0; + /* 1 */ + padding: 0; + white-space: normal; + /* 2 */ + *margin-left: -7px; +} + +/* 3 */ +/** + * * 1. Correct font size not being inherited in all browsers. + * * 2. Address margins set differently in IE 6/7, Firefox 3+, Safari 5, + * * and Chrome. + * * 3. Improve appearance and consistency in all browsers. */ +button, input, select, textarea { + font-size: 100%; + /* 1 */ + margin: 0; + /* 2 */ + vertical-align: baseline; + /* 3 */ + *vertical-align: middle; +} + +/* 3 */ +/** + * * Address Firefox 3+ setting `line-height` on `input` using `!important` in + * * the UA stylesheet. */ +button, input { + line-height: normal; +} + +/** + * * Address inconsistent `text-transform` inheritance for `button` and `select`. + * * All other form control elements do not inherit `text-transform` values. + * * Correct `button` style inheritance in Chrome, Safari 5+, and IE 6+. + * * Correct `select` style inheritance in Firefox 4+ and Opera. */ +button, select { + text-transform: none; +} + +/** + * * 1. Avoid the WebKit bug in Android 4.0.* where (2) destroys native `audio` + * * and `video` controls. + * * 2. Correct inability to style clickable `input` types in iOS. + * * 3. Improve usability and consistency of cursor style between image-type + * * `input` and others. + * * 4. Remove inner spacing in IE 7 without affecting normal text inputs. + * * Known issue: inner spacing remains in IE 6. */ +button, html input[type=button] { + -webkit-appearance: button; + /* 2 */ + cursor: pointer; + /* 3 */ + *overflow: visible; +} + +/* 4 */ +input[type=reset], input[type=submit] { + -webkit-appearance: button; + /* 2 */ + cursor: pointer; + /* 3 */ + *overflow: visible; +} + +/* 4 */ +/** + * * Re-set default cursor for disabled elements. */ +button[disabled], html input[disabled] { + cursor: default; +} + +/** + * * 1. Address box sizing set to content-box in IE 8/9. + * * 2. Remove excess padding in IE 8/9. + * * 3. Remove excess padding in IE 7. + * * Known issue: excess padding remains in IE 6. */ +input { + /* 3 */ +} +input[type=checkbox], input[type=radio] { + box-sizing: border-box; + /* 1 */ + padding: 0; + /* 2 */ + *height: 13px; + /* 3 */ + *width: 13px; +} +input[type=search] { + -webkit-appearance: textfield; + /* 1 */ + -moz-box-sizing: content-box; + -webkit-box-sizing: content-box; + /* 2 */ + box-sizing: content-box; +} +input[type=search]::-webkit-search-cancel-button, input[type=search]::-webkit-search-decoration { + -webkit-appearance: none; +} + +/** + * * 1. Address `appearance` set to `searchfield` in Safari 5 and Chrome. + * * 2. Address `box-sizing` set to `border-box` in Safari 5 and Chrome + * * (include `-moz` to future-proof). */ +/** + * * Remove inner padding and search cancel button in Safari 5 and Chrome + * * on OS X. */ +/** + * * Remove inner padding and border in Firefox 3+. */ +button::-moz-focus-inner, input::-moz-focus-inner { + border: 0; + padding: 0; +} + +/** + * * 1. Remove default vertical scrollbar in IE 6/7/8/9. + * * 2. Improve readability and alignment in all browsers. */ +textarea { + overflow: auto; + /* 1 */ + vertical-align: top; +} + +/* 2 */ +/* ========================================================================== + * * Tables + * * ========================================================================== */ +/** + * * Remove most spacing between table cells. */ +table { + border-collapse: collapse; + border-spacing: 0; +} + +ul.tsd-descriptions > li > :first-child, .tsd-panel > :first-child, .col > :first-child, .col-11 > :first-child, .col-10 > :first-child, .col-9 > :first-child, .col-8 > :first-child, .col-7 > :first-child, .col-6 > :first-child, .col-5 > :first-child, .col-4 > :first-child, .col-3 > :first-child, .col-2 > :first-child, .col-1 > :first-child, +ul.tsd-descriptions > li > :first-child > :first-child, +.tsd-panel > :first-child > :first-child, +.col > :first-child > :first-child, +.col-11 > :first-child > :first-child, +.col-10 > :first-child > :first-child, +.col-9 > :first-child > :first-child, +.col-8 > :first-child > :first-child, +.col-7 > :first-child > :first-child, +.col-6 > :first-child > :first-child, +.col-5 > :first-child > :first-child, +.col-4 > :first-child > :first-child, +.col-3 > :first-child > :first-child, +.col-2 > :first-child > :first-child, +.col-1 > :first-child > :first-child, +ul.tsd-descriptions > li > :first-child > :first-child > :first-child, +.tsd-panel > :first-child > :first-child > :first-child, +.col > :first-child > :first-child > :first-child, +.col-11 > :first-child > :first-child > :first-child, +.col-10 > :first-child > :first-child > :first-child, +.col-9 > :first-child > :first-child > :first-child, +.col-8 > :first-child > :first-child > :first-child, +.col-7 > :first-child > :first-child > :first-child, +.col-6 > :first-child > :first-child > :first-child, +.col-5 > :first-child > :first-child > :first-child, +.col-4 > :first-child > :first-child > :first-child, +.col-3 > :first-child > :first-child > :first-child, +.col-2 > :first-child > :first-child > :first-child, +.col-1 > :first-child > :first-child > :first-child { + margin-top: 0; +} +ul.tsd-descriptions > li > :last-child, .tsd-panel > :last-child, .col > :last-child, .col-11 > :last-child, .col-10 > :last-child, .col-9 > :last-child, .col-8 > :last-child, .col-7 > :last-child, .col-6 > :last-child, .col-5 > :last-child, .col-4 > :last-child, .col-3 > :last-child, .col-2 > :last-child, .col-1 > :last-child, +ul.tsd-descriptions > li > :last-child > :last-child, +.tsd-panel > :last-child > :last-child, +.col > :last-child > :last-child, +.col-11 > :last-child > :last-child, +.col-10 > :last-child > :last-child, +.col-9 > :last-child > :last-child, +.col-8 > :last-child > :last-child, +.col-7 > :last-child > :last-child, +.col-6 > :last-child > :last-child, +.col-5 > :last-child > :last-child, +.col-4 > :last-child > :last-child, +.col-3 > :last-child > :last-child, +.col-2 > :last-child > :last-child, +.col-1 > :last-child > :last-child, +ul.tsd-descriptions > li > :last-child > :last-child > :last-child, +.tsd-panel > :last-child > :last-child > :last-child, +.col > :last-child > :last-child > :last-child, +.col-11 > :last-child > :last-child > :last-child, +.col-10 > :last-child > :last-child > :last-child, +.col-9 > :last-child > :last-child > :last-child, +.col-8 > :last-child > :last-child > :last-child, +.col-7 > :last-child > :last-child > :last-child, +.col-6 > :last-child > :last-child > :last-child, +.col-5 > :last-child > :last-child > :last-child, +.col-4 > :last-child > :last-child > :last-child, +.col-3 > :last-child > :last-child > :last-child, +.col-2 > :last-child > :last-child > :last-child, +.col-1 > :last-child > :last-child > :last-child { + margin-bottom: 0; +} + +.container { + max-width: 1200px; + margin: 0 auto; + padding: 0 40px; +} +@media (max-width: 640px) { + .container { + padding: 0 20px; + } +} + +.container-main { + padding-bottom: 200px; +} + +.row { + display: flex; + position: relative; + margin: 0 -10px; +} +.row:after { + visibility: hidden; + display: block; + content: ""; + clear: both; + height: 0; +} + +.col, .col-11, .col-10, .col-9, .col-8, .col-7, .col-6, .col-5, .col-4, .col-3, .col-2, .col-1 { + box-sizing: border-box; + float: left; + padding: 0 10px; +} + +.col-1 { + width: 8.3333333333%; +} + +.offset-1 { + margin-left: 8.3333333333%; +} + +.col-2 { + width: 16.6666666667%; +} + +.offset-2 { + margin-left: 16.6666666667%; +} + +.col-3 { + width: 25%; +} + +.offset-3 { + margin-left: 25%; +} + +.col-4 { + width: 33.3333333333%; +} + +.offset-4 { + margin-left: 33.3333333333%; +} + +.col-5 { + width: 41.6666666667%; +} + +.offset-5 { + margin-left: 41.6666666667%; +} + +.col-6 { + width: 50%; +} + +.offset-6 { + margin-left: 50%; +} + +.col-7 { + width: 58.3333333333%; +} + +.offset-7 { + margin-left: 58.3333333333%; +} + +.col-8 { + width: 66.6666666667%; +} + +.offset-8 { + margin-left: 66.6666666667%; +} + +.col-9 { + width: 75%; +} + +.offset-9 { + margin-left: 75%; +} + +.col-10 { + width: 83.3333333333%; +} + +.offset-10 { + margin-left: 83.3333333333%; +} + +.col-11 { + width: 91.6666666667%; +} + +.offset-11 { + margin-left: 91.6666666667%; +} + +.tsd-kind-icon { + display: block; + position: relative; + padding-left: 20px; + text-indent: -20px; +} +.tsd-kind-icon:before { + content: ""; + display: inline-block; + vertical-align: middle; + width: 17px; + height: 17px; + margin: 0 3px 2px 0; + background-image: url(../images/icons.png); +} +@media (-webkit-min-device-pixel-ratio: 1.5), (min-resolution: 144dpi) { + .tsd-kind-icon:before { + background-image: url(../images/icons@2x.png); + background-size: 238px 204px; + } +} + +.tsd-signature.tsd-kind-icon:before { + background-position: 0 -153px; +} + +.tsd-kind-object-literal > .tsd-kind-icon:before { + background-position: 0px -17px; +} +.tsd-kind-object-literal.tsd-is-protected > .tsd-kind-icon:before { + background-position: -17px -17px; +} +.tsd-kind-object-literal.tsd-is-private > .tsd-kind-icon:before { + background-position: -34px -17px; +} + +.tsd-kind-class > .tsd-kind-icon:before { + background-position: 0px -34px; +} +.tsd-kind-class.tsd-is-protected > .tsd-kind-icon:before { + background-position: -17px -34px; +} +.tsd-kind-class.tsd-is-private > .tsd-kind-icon:before { + background-position: -34px -34px; +} + +.tsd-kind-class.tsd-has-type-parameter > .tsd-kind-icon:before { + background-position: 0px -51px; +} +.tsd-kind-class.tsd-has-type-parameter.tsd-is-protected > .tsd-kind-icon:before { + background-position: -17px -51px; +} +.tsd-kind-class.tsd-has-type-parameter.tsd-is-private > .tsd-kind-icon:before { + background-position: -34px -51px; +} + +.tsd-kind-interface > .tsd-kind-icon:before { + background-position: 0px -68px; +} +.tsd-kind-interface.tsd-is-protected > .tsd-kind-icon:before { + background-position: -17px -68px; +} +.tsd-kind-interface.tsd-is-private > .tsd-kind-icon:before { + background-position: -34px -68px; +} + +.tsd-kind-interface.tsd-has-type-parameter > .tsd-kind-icon:before { + background-position: 0px -85px; +} +.tsd-kind-interface.tsd-has-type-parameter.tsd-is-protected > .tsd-kind-icon:before { + background-position: -17px -85px; +} +.tsd-kind-interface.tsd-has-type-parameter.tsd-is-private > .tsd-kind-icon:before { + background-position: -34px -85px; +} + +.tsd-kind-namespace > .tsd-kind-icon:before { + background-position: 0px -102px; +} +.tsd-kind-namespace.tsd-is-protected > .tsd-kind-icon:before { + background-position: -17px -102px; +} +.tsd-kind-namespace.tsd-is-private > .tsd-kind-icon:before { + background-position: -34px -102px; +} + +.tsd-kind-module > .tsd-kind-icon:before { + background-position: 0px -102px; +} +.tsd-kind-module.tsd-is-protected > .tsd-kind-icon:before { + background-position: -17px -102px; +} +.tsd-kind-module.tsd-is-private > .tsd-kind-icon:before { + background-position: -34px -102px; +} + +.tsd-kind-enum > .tsd-kind-icon:before { + background-position: 0px -119px; +} +.tsd-kind-enum.tsd-is-protected > .tsd-kind-icon:before { + background-position: -17px -119px; +} +.tsd-kind-enum.tsd-is-private > .tsd-kind-icon:before { + background-position: -34px -119px; +} + +.tsd-kind-enum-member > .tsd-kind-icon:before { + background-position: 0px -136px; +} +.tsd-kind-enum-member.tsd-is-protected > .tsd-kind-icon:before { + background-position: -17px -136px; +} +.tsd-kind-enum-member.tsd-is-private > .tsd-kind-icon:before { + background-position: -34px -136px; +} + +.tsd-kind-signature > .tsd-kind-icon:before { + background-position: 0px -153px; +} +.tsd-kind-signature.tsd-is-protected > .tsd-kind-icon:before { + background-position: -17px -153px; +} +.tsd-kind-signature.tsd-is-private > .tsd-kind-icon:before { + background-position: -34px -153px; +} + +.tsd-kind-type-alias > .tsd-kind-icon:before { + background-position: 0px -170px; +} +.tsd-kind-type-alias.tsd-is-protected > .tsd-kind-icon:before { + background-position: -17px -170px; +} +.tsd-kind-type-alias.tsd-is-private > .tsd-kind-icon:before { + background-position: -34px -170px; +} + +.tsd-kind-type-alias.tsd-has-type-parameter > .tsd-kind-icon:before { + background-position: 0px -187px; +} +.tsd-kind-type-alias.tsd-has-type-parameter.tsd-is-protected > .tsd-kind-icon:before { + background-position: -17px -187px; +} +.tsd-kind-type-alias.tsd-has-type-parameter.tsd-is-private > .tsd-kind-icon:before { + background-position: -34px -187px; +} + +.tsd-kind-variable > .tsd-kind-icon:before { + background-position: -136px -0px; +} +.tsd-kind-variable.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -0px; +} +.tsd-kind-variable.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -0px; +} +.tsd-kind-variable.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -0px; +} +.tsd-kind-variable.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -68px -0px; +} +.tsd-kind-variable.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { + background-position: -85px -0px; +} +.tsd-kind-variable.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -102px -0px; +} +.tsd-kind-variable.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -0px; +} +.tsd-kind-variable.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -0px; +} +.tsd-kind-variable.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { + background-position: -187px -0px; +} +.tsd-kind-variable.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -0px; +} +.tsd-kind-variable.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -0px; +} +.tsd-kind-variable.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -221px -0px; +} + +.tsd-kind-property > .tsd-kind-icon:before { + background-position: -136px -0px; +} +.tsd-kind-property.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -0px; +} +.tsd-kind-property.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -0px; +} +.tsd-kind-property.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -0px; +} +.tsd-kind-property.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -68px -0px; +} +.tsd-kind-property.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { + background-position: -85px -0px; +} +.tsd-kind-property.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -102px -0px; +} +.tsd-kind-property.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -0px; +} +.tsd-kind-property.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -0px; +} +.tsd-kind-property.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { + background-position: -187px -0px; +} +.tsd-kind-property.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -0px; +} +.tsd-kind-property.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -0px; +} +.tsd-kind-property.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -221px -0px; +} + +.tsd-kind-get-signature > .tsd-kind-icon:before { + background-position: -136px -17px; +} +.tsd-kind-get-signature.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -17px; +} +.tsd-kind-get-signature.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -17px; +} +.tsd-kind-get-signature.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -17px; +} +.tsd-kind-get-signature.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -68px -17px; +} +.tsd-kind-get-signature.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { + background-position: -85px -17px; +} +.tsd-kind-get-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -102px -17px; +} +.tsd-kind-get-signature.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -17px; +} +.tsd-kind-get-signature.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -17px; +} +.tsd-kind-get-signature.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { + background-position: -187px -17px; +} +.tsd-kind-get-signature.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -17px; +} +.tsd-kind-get-signature.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -17px; +} +.tsd-kind-get-signature.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -221px -17px; +} + +.tsd-kind-set-signature > .tsd-kind-icon:before { + background-position: -136px -34px; +} +.tsd-kind-set-signature.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -34px; +} +.tsd-kind-set-signature.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -34px; +} +.tsd-kind-set-signature.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -34px; +} +.tsd-kind-set-signature.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -68px -34px; +} +.tsd-kind-set-signature.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { + background-position: -85px -34px; +} +.tsd-kind-set-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -102px -34px; +} +.tsd-kind-set-signature.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -34px; +} +.tsd-kind-set-signature.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -34px; +} +.tsd-kind-set-signature.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { + background-position: -187px -34px; +} +.tsd-kind-set-signature.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -34px; +} +.tsd-kind-set-signature.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -34px; +} +.tsd-kind-set-signature.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -221px -34px; +} + +.tsd-kind-accessor > .tsd-kind-icon:before { + background-position: -136px -51px; +} +.tsd-kind-accessor.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -51px; +} +.tsd-kind-accessor.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -51px; +} +.tsd-kind-accessor.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -51px; +} +.tsd-kind-accessor.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -68px -51px; +} +.tsd-kind-accessor.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { + background-position: -85px -51px; +} +.tsd-kind-accessor.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -102px -51px; +} +.tsd-kind-accessor.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -51px; +} +.tsd-kind-accessor.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -51px; +} +.tsd-kind-accessor.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { + background-position: -187px -51px; +} +.tsd-kind-accessor.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -51px; +} +.tsd-kind-accessor.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -51px; +} +.tsd-kind-accessor.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -221px -51px; +} + +.tsd-kind-function > .tsd-kind-icon:before { + background-position: -136px -68px; +} +.tsd-kind-function.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -68px; +} +.tsd-kind-function.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -68px; +} +.tsd-kind-function.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -68px; +} +.tsd-kind-function.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -68px -68px; +} +.tsd-kind-function.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { + background-position: -85px -68px; +} +.tsd-kind-function.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -102px -68px; +} +.tsd-kind-function.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -68px; +} +.tsd-kind-function.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -68px; +} +.tsd-kind-function.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { + background-position: -187px -68px; +} +.tsd-kind-function.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -68px; +} +.tsd-kind-function.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -68px; +} +.tsd-kind-function.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -221px -68px; +} + +.tsd-kind-method > .tsd-kind-icon:before { + background-position: -136px -68px; +} +.tsd-kind-method.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -68px; +} +.tsd-kind-method.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -68px; +} +.tsd-kind-method.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -68px; +} +.tsd-kind-method.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -68px -68px; +} +.tsd-kind-method.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { + background-position: -85px -68px; +} +.tsd-kind-method.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -102px -68px; +} +.tsd-kind-method.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -68px; +} +.tsd-kind-method.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -68px; +} +.tsd-kind-method.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { + background-position: -187px -68px; +} +.tsd-kind-method.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -68px; +} +.tsd-kind-method.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -68px; +} +.tsd-kind-method.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -221px -68px; +} + +.tsd-kind-call-signature > .tsd-kind-icon:before { + background-position: -136px -68px; +} +.tsd-kind-call-signature.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -68px; +} +.tsd-kind-call-signature.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -68px; +} +.tsd-kind-call-signature.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -68px; +} +.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -68px -68px; +} +.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { + background-position: -85px -68px; +} +.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -102px -68px; +} +.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -68px; +} +.tsd-kind-call-signature.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -68px; +} +.tsd-kind-call-signature.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { + background-position: -187px -68px; +} +.tsd-kind-call-signature.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -68px; +} +.tsd-kind-call-signature.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -68px; +} +.tsd-kind-call-signature.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -221px -68px; +} + +.tsd-kind-function.tsd-has-type-parameter > .tsd-kind-icon:before { + background-position: -136px -85px; +} +.tsd-kind-function.tsd-has-type-parameter.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -85px; +} +.tsd-kind-function.tsd-has-type-parameter.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -85px; +} +.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -85px; +} +.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -68px -85px; +} +.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { + background-position: -85px -85px; +} +.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -102px -85px; +} +.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -85px; +} +.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -85px; +} +.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { + background-position: -187px -85px; +} +.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -85px; +} +.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -85px; +} +.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -221px -85px; +} + +.tsd-kind-method.tsd-has-type-parameter > .tsd-kind-icon:before { + background-position: -136px -85px; +} +.tsd-kind-method.tsd-has-type-parameter.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -85px; +} +.tsd-kind-method.tsd-has-type-parameter.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -85px; +} +.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -85px; +} +.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -68px -85px; +} +.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { + background-position: -85px -85px; +} +.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -102px -85px; +} +.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -85px; +} +.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -85px; +} +.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { + background-position: -187px -85px; +} +.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -85px; +} +.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -85px; +} +.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -221px -85px; +} + +.tsd-kind-constructor > .tsd-kind-icon:before { + background-position: -136px -102px; +} +.tsd-kind-constructor.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -102px; +} +.tsd-kind-constructor.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -102px; +} +.tsd-kind-constructor.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -102px; +} +.tsd-kind-constructor.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -68px -102px; +} +.tsd-kind-constructor.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { + background-position: -85px -102px; +} +.tsd-kind-constructor.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -102px -102px; +} +.tsd-kind-constructor.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -102px; +} +.tsd-kind-constructor.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -102px; +} +.tsd-kind-constructor.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { + background-position: -187px -102px; +} +.tsd-kind-constructor.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -102px; +} +.tsd-kind-constructor.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -102px; +} +.tsd-kind-constructor.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -221px -102px; +} + +.tsd-kind-constructor-signature > .tsd-kind-icon:before { + background-position: -136px -102px; +} +.tsd-kind-constructor-signature.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -102px; +} +.tsd-kind-constructor-signature.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -102px; +} +.tsd-kind-constructor-signature.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -102px; +} +.tsd-kind-constructor-signature.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -68px -102px; +} +.tsd-kind-constructor-signature.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { + background-position: -85px -102px; +} +.tsd-kind-constructor-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -102px -102px; +} +.tsd-kind-constructor-signature.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -102px; +} +.tsd-kind-constructor-signature.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -102px; +} +.tsd-kind-constructor-signature.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { + background-position: -187px -102px; +} +.tsd-kind-constructor-signature.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -102px; +} +.tsd-kind-constructor-signature.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -102px; +} +.tsd-kind-constructor-signature.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -221px -102px; +} + +.tsd-kind-index-signature > .tsd-kind-icon:before { + background-position: -136px -119px; +} +.tsd-kind-index-signature.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -119px; +} +.tsd-kind-index-signature.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -119px; +} +.tsd-kind-index-signature.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -119px; +} +.tsd-kind-index-signature.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -68px -119px; +} +.tsd-kind-index-signature.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { + background-position: -85px -119px; +} +.tsd-kind-index-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -102px -119px; +} +.tsd-kind-index-signature.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -119px; +} +.tsd-kind-index-signature.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -119px; +} +.tsd-kind-index-signature.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { + background-position: -187px -119px; +} +.tsd-kind-index-signature.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -119px; +} +.tsd-kind-index-signature.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -119px; +} +.tsd-kind-index-signature.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -221px -119px; +} + +.tsd-kind-event > .tsd-kind-icon:before { + background-position: -136px -136px; +} +.tsd-kind-event.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -136px; +} +.tsd-kind-event.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -136px; +} +.tsd-kind-event.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -136px; +} +.tsd-kind-event.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -68px -136px; +} +.tsd-kind-event.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { + background-position: -85px -136px; +} +.tsd-kind-event.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -102px -136px; +} +.tsd-kind-event.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -136px; +} +.tsd-kind-event.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -136px; +} +.tsd-kind-event.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { + background-position: -187px -136px; +} +.tsd-kind-event.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -136px; +} +.tsd-kind-event.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -136px; +} +.tsd-kind-event.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -221px -136px; +} + +.tsd-is-static > .tsd-kind-icon:before { + background-position: -136px -153px; +} +.tsd-is-static.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -153px; +} +.tsd-is-static.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -153px; +} +.tsd-is-static.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -153px; +} +.tsd-is-static.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -68px -153px; +} +.tsd-is-static.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { + background-position: -85px -153px; +} +.tsd-is-static.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -102px -153px; +} +.tsd-is-static.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -153px; +} +.tsd-is-static.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -153px; +} +.tsd-is-static.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { + background-position: -187px -153px; +} +.tsd-is-static.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -153px; +} +.tsd-is-static.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -153px; +} +.tsd-is-static.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -221px -153px; +} + +.tsd-is-static.tsd-kind-function > .tsd-kind-icon:before { + background-position: -136px -170px; +} +.tsd-is-static.tsd-kind-function.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -170px; +} +.tsd-is-static.tsd-kind-function.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -170px; +} +.tsd-is-static.tsd-kind-function.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -170px; +} +.tsd-is-static.tsd-kind-function.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -68px -170px; +} +.tsd-is-static.tsd-kind-function.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { + background-position: -85px -170px; +} +.tsd-is-static.tsd-kind-function.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -102px -170px; +} +.tsd-is-static.tsd-kind-function.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -170px; +} +.tsd-is-static.tsd-kind-function.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -170px; +} +.tsd-is-static.tsd-kind-function.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { + background-position: -187px -170px; +} +.tsd-is-static.tsd-kind-function.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -170px; +} +.tsd-is-static.tsd-kind-function.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -170px; +} +.tsd-is-static.tsd-kind-function.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -221px -170px; +} + +.tsd-is-static.tsd-kind-method > .tsd-kind-icon:before { + background-position: -136px -170px; +} +.tsd-is-static.tsd-kind-method.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -170px; +} +.tsd-is-static.tsd-kind-method.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -170px; +} +.tsd-is-static.tsd-kind-method.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -170px; +} +.tsd-is-static.tsd-kind-method.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -68px -170px; +} +.tsd-is-static.tsd-kind-method.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { + background-position: -85px -170px; +} +.tsd-is-static.tsd-kind-method.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -102px -170px; +} +.tsd-is-static.tsd-kind-method.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -170px; +} +.tsd-is-static.tsd-kind-method.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -170px; +} +.tsd-is-static.tsd-kind-method.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { + background-position: -187px -170px; +} +.tsd-is-static.tsd-kind-method.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -170px; +} +.tsd-is-static.tsd-kind-method.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -170px; +} +.tsd-is-static.tsd-kind-method.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -221px -170px; +} + +.tsd-is-static.tsd-kind-call-signature > .tsd-kind-icon:before { + background-position: -136px -170px; +} +.tsd-is-static.tsd-kind-call-signature.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -170px; +} +.tsd-is-static.tsd-kind-call-signature.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -170px; +} +.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -170px; +} +.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -68px -170px; +} +.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { + background-position: -85px -170px; +} +.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -102px -170px; +} +.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -170px; +} +.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -170px; +} +.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { + background-position: -187px -170px; +} +.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -170px; +} +.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -170px; +} +.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -221px -170px; +} + +.tsd-is-static.tsd-kind-event > .tsd-kind-icon:before { + background-position: -136px -187px; +} +.tsd-is-static.tsd-kind-event.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -187px; +} +.tsd-is-static.tsd-kind-event.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -187px; +} +.tsd-is-static.tsd-kind-event.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -187px; +} +.tsd-is-static.tsd-kind-event.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -68px -187px; +} +.tsd-is-static.tsd-kind-event.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { + background-position: -85px -187px; +} +.tsd-is-static.tsd-kind-event.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -102px -187px; +} +.tsd-is-static.tsd-kind-event.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -187px; +} +.tsd-is-static.tsd-kind-event.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -187px; +} +.tsd-is-static.tsd-kind-event.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { + background-position: -187px -187px; +} +.tsd-is-static.tsd-kind-event.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -187px; +} +.tsd-is-static.tsd-kind-event.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -187px; +} +.tsd-is-static.tsd-kind-event.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -221px -187px; +} + +@keyframes fade-in { + from { + opacity: 0; + } + to { + opacity: 1; + } +} +@keyframes fade-out { + from { + opacity: 1; + visibility: visible; + } + to { + opacity: 0; + } +} +@keyframes fade-in-delayed { + 0% { + opacity: 0; + } + 33% { + opacity: 0; + } + 100% { + opacity: 1; + } +} +@keyframes fade-out-delayed { + 0% { + opacity: 1; + visibility: visible; + } + 66% { + opacity: 0; + } + 100% { + opacity: 0; + } +} +@keyframes shift-to-left { + from { + transform: translate(0, 0); + } + to { + transform: translate(-25%, 0); + } +} +@keyframes unshift-to-left { + from { + transform: translate(-25%, 0); + } + to { + transform: translate(0, 0); + } +} +@keyframes pop-in-from-right { + from { + transform: translate(100%, 0); + } + to { + transform: translate(0, 0); + } +} +@keyframes pop-out-to-right { + from { + transform: translate(0, 0); + visibility: visible; + } + to { + transform: translate(100%, 0); + } +} +body { + background: var(--color-background); + font-family: "Segoe UI", sans-serif; + font-size: 16px; + color: var(--color-text); +} + +a { + color: var(--color-link); + text-decoration: none; +} +a:hover { + text-decoration: underline; +} + +code, pre { + font-family: Menlo, Monaco, Consolas, "Courier New", monospace; + padding: 0.2em; + margin: 0; + font-size: 14px; + background-color: var(--color-code-background); +} + +pre { + padding: 10px; +} +pre code { + padding: 0; + font-size: 100%; + background-color: transparent; +} + +blockquote { + margin: 1em 0; + padding-left: 1em; + border-left: 4px solid gray; +} + +.tsd-typography { + line-height: 1.333em; +} +.tsd-typography ul { + list-style: square; + padding: 0 0 0 20px; + margin: 0; +} +.tsd-typography h4, .tsd-typography .tsd-index-panel h3, .tsd-index-panel .tsd-typography h3, .tsd-typography h5, .tsd-typography h6 { + font-size: 1em; + margin: 0; +} +.tsd-typography h5, .tsd-typography h6 { + font-weight: normal; +} +.tsd-typography p, .tsd-typography ul, .tsd-typography ol { + margin: 1em 0; +} + +@media (min-width: 901px) and (max-width: 1024px) { + html.default .col-content { + width: 72%; + } + html.default .col-menu { + width: 28%; + } + html.default .tsd-navigation { + padding-left: 10px; + } +} +@media (max-width: 900px) { + html.default .col-content { + float: none; + width: 100%; + } + html.default .col-menu { + position: fixed !important; + overflow: auto; + -webkit-overflow-scrolling: touch; + z-index: 1024; + top: 0 !important; + bottom: 0 !important; + left: auto !important; + right: 0 !important; + width: 100%; + padding: 20px 20px 0 0; + max-width: 450px; + visibility: hidden; + background-color: var(--color-panel); + transform: translate(100%, 0); + } + html.default .col-menu > *:last-child { + padding-bottom: 20px; + } + html.default .overlay { + content: ""; + display: block; + position: fixed; + z-index: 1023; + top: 0; + left: 0; + right: 0; + bottom: 0; + background-color: rgba(0, 0, 0, 0.75); + visibility: hidden; + } + html.default.to-has-menu .overlay { + animation: fade-in 0.4s; + } + html.default.to-has-menu header, +html.default.to-has-menu footer, +html.default.to-has-menu .col-content { + animation: shift-to-left 0.4s; + } + html.default.to-has-menu .col-menu { + animation: pop-in-from-right 0.4s; + } + html.default.from-has-menu .overlay { + animation: fade-out 0.4s; + } + html.default.from-has-menu header, +html.default.from-has-menu footer, +html.default.from-has-menu .col-content { + animation: unshift-to-left 0.4s; + } + html.default.from-has-menu .col-menu { + animation: pop-out-to-right 0.4s; + } + html.default.has-menu body { + overflow: hidden; + } + html.default.has-menu .overlay { + visibility: visible; + } + html.default.has-menu header, +html.default.has-menu footer, +html.default.has-menu .col-content { + transform: translate(-25%, 0); + } + html.default.has-menu .col-menu { + visibility: visible; + transform: translate(0, 0); + } +} + +.tsd-page-title { + padding: 70px 0 20px 0; + margin: 0 0 40px 0; + background: var(--color-panel); + box-shadow: 0 0 5px rgba(0, 0, 0, 0.35); +} +.tsd-page-title h1 { + margin: 0; +} + +.tsd-breadcrumb { + margin: 0; + padding: 0; + color: var(--color-text-aside); +} +.tsd-breadcrumb a { + color: var(--color-text-aside); + text-decoration: none; +} +.tsd-breadcrumb a:hover { + text-decoration: underline; +} +.tsd-breadcrumb li { + display: inline; +} +.tsd-breadcrumb li:after { + content: " / "; +} + +html.minimal .container { + margin: 0; +} +html.minimal .container-main { + padding-top: 50px; + padding-bottom: 0; +} +html.minimal .content-wrap { + padding-left: 300px; +} +html.minimal .tsd-navigation { + position: fixed !important; + overflow: auto; + -webkit-overflow-scrolling: touch; + box-sizing: border-box; + z-index: 1; + left: 0; + top: 40px; + bottom: 0; + width: 300px; + padding: 20px; + margin: 0; +} +html.minimal .tsd-member .tsd-member { + margin-left: 0; +} +html.minimal .tsd-page-toolbar { + position: fixed; + z-index: 2; +} +html.minimal #tsd-filter .tsd-filter-group { + right: 0; + transform: none; +} +html.minimal footer { + background-color: transparent; +} +html.minimal footer .container { + padding: 0; +} +html.minimal .tsd-generator { + padding: 0; +} +@media (max-width: 900px) { + html.minimal .tsd-navigation { + display: none; + } + html.minimal .content-wrap { + padding-left: 0; + } +} + +dl.tsd-comment-tags { + overflow: hidden; +} +dl.tsd-comment-tags dt { + float: left; + padding: 1px 5px; + margin: 0 10px 0 0; + border-radius: 4px; + border: 1px solid var(--color-comment-tag); + color: var(--color-comment-tag); + font-size: 0.8em; + font-weight: normal; +} +dl.tsd-comment-tags dd { + margin: 0 0 10px 0; +} +dl.tsd-comment-tags dd:before, dl.tsd-comment-tags dd:after { + display: table; + content: " "; +} +dl.tsd-comment-tags dd pre, dl.tsd-comment-tags dd:after { + clear: both; +} +dl.tsd-comment-tags p { + margin: 0; +} + +.tsd-panel.tsd-comment .lead { + font-size: 1.1em; + line-height: 1.333em; + margin-bottom: 2em; +} +.tsd-panel.tsd-comment .lead:last-child { + margin-bottom: 0; +} + +.toggle-protected .tsd-is-private { + display: none; +} + +.toggle-public .tsd-is-private, +.toggle-public .tsd-is-protected, +.toggle-public .tsd-is-private-protected { + display: none; +} + +.toggle-inherited .tsd-is-inherited { + display: none; +} + +.toggle-externals .tsd-is-external { + display: none; +} + +#tsd-filter { + position: relative; + display: inline-block; + height: 40px; + vertical-align: bottom; +} +.no-filter #tsd-filter { + display: none; +} +#tsd-filter .tsd-filter-group { + display: inline-block; + height: 40px; + vertical-align: bottom; + white-space: nowrap; +} +#tsd-filter input { + display: none; +} +@media (max-width: 900px) { + #tsd-filter .tsd-filter-group { + display: block; + position: absolute; + top: 40px; + right: 20px; + height: auto; + background-color: var(--color-panel); + visibility: hidden; + transform: translate(50%, 0); + box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); + } + .has-options #tsd-filter .tsd-filter-group { + visibility: visible; + } + .to-has-options #tsd-filter .tsd-filter-group { + animation: fade-in 0.2s; + } + .from-has-options #tsd-filter .tsd-filter-group { + animation: fade-out 0.2s; + } + #tsd-filter label, +#tsd-filter .tsd-select { + display: block; + padding-right: 20px; + } +} + +footer { + border-top: 1px solid var(--color-panel-divider); + background-color: var(--color-panel); +} +footer.with-border-bottom { + border-bottom: 1px solid var(--color-panel-divider); +} +footer .tsd-legend-group { + font-size: 0; +} +footer .tsd-legend { + display: inline-block; + width: 25%; + padding: 0; + font-size: 16px; + list-style: none; + line-height: 1.333em; + vertical-align: top; +} +@media (max-width: 900px) { + footer .tsd-legend { + width: 50%; + } +} + +.tsd-hierarchy { + list-style: square; + padding: 0 0 0 20px; + margin: 0; +} +.tsd-hierarchy .target { + font-weight: bold; +} + +.tsd-index-panel .tsd-index-content { + margin-bottom: -30px !important; +} +.tsd-index-panel .tsd-index-section { + margin-bottom: 30px !important; +} +.tsd-index-panel h3 { + margin: 0 -20px 10px -20px; + padding: 0 20px 10px 20px; + border-bottom: 1px solid var(--color-panel-divider); +} +.tsd-index-panel ul.tsd-index-list { + -webkit-column-count: 3; + -moz-column-count: 3; + -ms-column-count: 3; + -o-column-count: 3; + column-count: 3; + -webkit-column-gap: 20px; + -moz-column-gap: 20px; + -ms-column-gap: 20px; + -o-column-gap: 20px; + column-gap: 20px; + padding: 0; + list-style: none; + line-height: 1.333em; +} +@media (max-width: 900px) { + .tsd-index-panel ul.tsd-index-list { + -webkit-column-count: 1; + -moz-column-count: 1; + -ms-column-count: 1; + -o-column-count: 1; + column-count: 1; + } +} +@media (min-width: 901px) and (max-width: 1024px) { + .tsd-index-panel ul.tsd-index-list { + -webkit-column-count: 2; + -moz-column-count: 2; + -ms-column-count: 2; + -o-column-count: 2; + column-count: 2; + } +} +.tsd-index-panel ul.tsd-index-list li { + -webkit-page-break-inside: avoid; + -moz-page-break-inside: avoid; + -ms-page-break-inside: avoid; + -o-page-break-inside: avoid; + page-break-inside: avoid; +} +.tsd-index-panel a, +.tsd-index-panel .tsd-parent-kind-module a { + color: var(--color-ts); +} +.tsd-index-panel .tsd-parent-kind-interface a { + color: var(--color-ts-interface); +} +.tsd-index-panel .tsd-parent-kind-enum a { + color: var(--color-ts-enum); +} +.tsd-index-panel .tsd-parent-kind-class a { + color: var(--color-ts-class); +} +.tsd-index-panel .tsd-kind-module a { + color: var(--color-ts); +} +.tsd-index-panel .tsd-kind-interface a { + color: var(--color-ts-interface); +} +.tsd-index-panel .tsd-kind-enum a { + color: var(--color-ts-enum); +} +.tsd-index-panel .tsd-kind-class a { + color: var(--color-ts-class); +} +.tsd-index-panel .tsd-is-private a { + color: var(--color-ts-private); +} + +.tsd-flag { + display: inline-block; + padding: 1px 5px; + border-radius: 4px; + color: var(--color-comment-tag-text); + background-color: var(--color-comment-tag); + text-indent: 0; + font-size: 14px; + font-weight: normal; +} + +.tsd-anchor { + position: absolute; + top: -100px; +} + +.tsd-member { + position: relative; +} +.tsd-member .tsd-anchor + h3 { + margin-top: 0; + margin-bottom: 0; + border-bottom: none; +} +.tsd-member a[data-tsd-kind] { + color: var(--color-ts); +} +.tsd-member a[data-tsd-kind=Interface] { + color: var(--color-ts-interface); +} +.tsd-member a[data-tsd-kind=Enum] { + color: var(--color-ts-enum); +} +.tsd-member a[data-tsd-kind=Class] { + color: var(--color-ts-class); +} +.tsd-member a[data-tsd-kind=Private] { + color: var(--color-ts-private); +} + +.tsd-navigation { + margin: 0 0 0 40px; +} +.tsd-navigation a { + display: block; + padding-top: 2px; + padding-bottom: 2px; + border-left: 2px solid transparent; + color: var(--color-text); + text-decoration: none; + transition: border-left-color 0.1s; +} +.tsd-navigation a:hover { + text-decoration: underline; +} +.tsd-navigation ul { + margin: 0; + padding: 0; + list-style: none; +} +.tsd-navigation li { + padding: 0; +} + +.tsd-navigation.primary { + padding-bottom: 40px; +} +.tsd-navigation.primary a { + display: block; + padding-top: 6px; + padding-bottom: 6px; +} +.tsd-navigation.primary ul li a { + padding-left: 5px; +} +.tsd-navigation.primary ul li li a { + padding-left: 25px; +} +.tsd-navigation.primary ul li li li a { + padding-left: 45px; +} +.tsd-navigation.primary ul li li li li a { + padding-left: 65px; +} +.tsd-navigation.primary ul li li li li li a { + padding-left: 85px; +} +.tsd-navigation.primary ul li li li li li li a { + padding-left: 105px; +} +.tsd-navigation.primary > ul { + border-bottom: 1px solid var(--color-panel-divider); +} +.tsd-navigation.primary li { + border-top: 1px solid var(--color-panel-divider); +} +.tsd-navigation.primary li.current > a { + font-weight: bold; +} +.tsd-navigation.primary li.label span { + display: block; + padding: 20px 0 6px 5px; + color: var(--color-menu-label); +} +.tsd-navigation.primary li.globals + li > span, .tsd-navigation.primary li.globals + li > a { + padding-top: 20px; +} + +.tsd-navigation.secondary { + max-height: calc(100vh - 1rem - 40px); + overflow: auto; + position: -webkit-sticky; + position: sticky; + top: calc(.5rem + 40px); + transition: 0.3s; +} +.tsd-navigation.secondary.tsd-navigation--toolbar-hide { + max-height: calc(100vh - 1rem); + top: 0.5rem; +} +.tsd-navigation.secondary ul { + transition: opacity 0.2s; +} +.tsd-navigation.secondary ul li a { + padding-left: 25px; +} +.tsd-navigation.secondary ul li li a { + padding-left: 45px; +} +.tsd-navigation.secondary ul li li li a { + padding-left: 65px; +} +.tsd-navigation.secondary ul li li li li a { + padding-left: 85px; +} +.tsd-navigation.secondary ul li li li li li a { + padding-left: 105px; +} +.tsd-navigation.secondary ul li li li li li li a { + padding-left: 125px; +} +.tsd-navigation.secondary ul.current a { + border-left-color: var(--color-panel-divider); +} +.tsd-navigation.secondary li.focus > a, +.tsd-navigation.secondary ul.current li.focus > a { + border-left-color: var(--color-menu-divider-focus); +} +.tsd-navigation.secondary li.current { + margin-top: 20px; + margin-bottom: 20px; + border-left-color: var(--color-panel-divider); +} +.tsd-navigation.secondary li.current > a { + font-weight: bold; +} + +@media (min-width: 901px) { + .menu-sticky-wrap { + position: static; + } +} + +.tsd-panel { + margin: 20px 0; + padding: 20px; + background-color: var(--color-panel); + box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); +} +.tsd-panel:empty { + display: none; +} +.tsd-panel > h1, .tsd-panel > h2, .tsd-panel > h3 { + margin: 1.5em -20px 10px -20px; + padding: 0 20px 10px 20px; + border-bottom: 1px solid var(--color-panel-divider); +} +.tsd-panel > h1.tsd-before-signature, .tsd-panel > h2.tsd-before-signature, .tsd-panel > h3.tsd-before-signature { + margin-bottom: 0; + border-bottom: 0; +} +.tsd-panel table { + display: block; + width: 100%; + overflow: auto; + margin-top: 10px; + word-break: normal; + word-break: keep-all; +} +.tsd-panel table th { + font-weight: bold; +} +.tsd-panel table th, .tsd-panel table td { + padding: 6px 13px; + border: 1px solid #ddd; +} +.tsd-panel table tr { + background-color: #fff; + border-top: 1px solid #ccc; +} +.tsd-panel table tr:nth-child(2n) { + background-color: #f8f8f8; +} + +.tsd-panel-group { + margin: 60px 0; +} +.tsd-panel-group > h1, .tsd-panel-group > h2, .tsd-panel-group > h3 { + padding-left: 20px; + padding-right: 20px; +} + +#tsd-search { + transition: background-color 0.2s; +} +#tsd-search .title { + position: relative; + z-index: 2; +} +#tsd-search .field { + position: absolute; + left: 0; + top: 0; + right: 40px; + height: 40px; +} +#tsd-search .field input { + box-sizing: border-box; + position: relative; + top: -50px; + z-index: 1; + width: 100%; + padding: 0 10px; + opacity: 0; + outline: 0; + border: 0; + background: transparent; + color: var(--color-text); +} +#tsd-search .field label { + position: absolute; + overflow: hidden; + right: -40px; +} +#tsd-search .field input, +#tsd-search .title { + transition: opacity 0.2s; +} +#tsd-search .results { + position: absolute; + visibility: hidden; + top: 40px; + width: 100%; + margin: 0; + padding: 0; + list-style: none; + box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); +} +#tsd-search .results li { + padding: 0 10px; + background-color: var(--color-background); +} +#tsd-search .results li:nth-child(even) { + background-color: var(--color-panel); +} +#tsd-search .results li.state { + display: none; +} +#tsd-search .results li.current, +#tsd-search .results li:hover { + background-color: var(--color-panel-divider); +} +#tsd-search .results a { + display: block; +} +#tsd-search .results a:before { + top: 10px; +} +#tsd-search .results span.parent { + color: var(--color-text-aside); + font-weight: normal; +} +#tsd-search.has-focus { + background-color: var(--color-panel-divider); +} +#tsd-search.has-focus .field input { + top: 0; + opacity: 1; +} +#tsd-search.has-focus .title { + z-index: 0; + opacity: 0; +} +#tsd-search.has-focus .results { + visibility: visible; +} +#tsd-search.loading .results li.state.loading { + display: block; +} +#tsd-search.failure .results li.state.failure { + display: block; +} + +.tsd-signature { + margin: 0 0 1em 0; + padding: 10px; + border: 1px solid var(--color-panel-divider); + font-family: Menlo, Monaco, Consolas, "Courier New", monospace; + font-size: 14px; + overflow-x: auto; +} +.tsd-signature.tsd-kind-icon { + padding-left: 30px; +} +.tsd-signature.tsd-kind-icon:before { + top: 10px; + left: 10px; +} +.tsd-panel > .tsd-signature { + margin-left: -20px; + margin-right: -20px; + border-width: 1px 0; +} +.tsd-panel > .tsd-signature.tsd-kind-icon { + padding-left: 40px; +} +.tsd-panel > .tsd-signature.tsd-kind-icon:before { + left: 20px; +} + +.tsd-signature-symbol { + color: var(--color-text-aside); + font-weight: normal; +} + +.tsd-signature-type { + font-style: italic; + font-weight: normal; +} + +.tsd-signatures { + padding: 0; + margin: 0 0 1em 0; + border: 1px solid var(--color-panel-divider); +} +.tsd-signatures .tsd-signature { + margin: 0; + border-width: 1px 0 0 0; + transition: background-color 0.1s; +} +.tsd-signatures .tsd-signature:first-child { + border-top-width: 0; +} +.tsd-signatures .tsd-signature.current { + background-color: var(--color-panel-divider); +} +.tsd-signatures.active > .tsd-signature { + cursor: pointer; +} +.tsd-panel > .tsd-signatures { + margin-left: -20px; + margin-right: -20px; + border-width: 1px 0; +} +.tsd-panel > .tsd-signatures .tsd-signature.tsd-kind-icon { + padding-left: 40px; +} +.tsd-panel > .tsd-signatures .tsd-signature.tsd-kind-icon:before { + left: 20px; +} +.tsd-panel > a.anchor + .tsd-signatures { + border-top-width: 0; + margin-top: -20px; +} + +ul.tsd-descriptions { + position: relative; + overflow: hidden; + padding: 0; + list-style: none; +} +ul.tsd-descriptions.active > .tsd-description { + display: none; +} +ul.tsd-descriptions.active > .tsd-description.current { + display: block; +} +ul.tsd-descriptions.active > .tsd-description.fade-in { + animation: fade-in-delayed 0.3s; +} +ul.tsd-descriptions.active > .tsd-description.fade-out { + animation: fade-out-delayed 0.3s; + position: absolute; + display: block; + top: 0; + left: 0; + right: 0; + opacity: 0; + visibility: hidden; +} +ul.tsd-descriptions h4, ul.tsd-descriptions .tsd-index-panel h3, .tsd-index-panel ul.tsd-descriptions h3 { + font-size: 16px; + margin: 1em 0 0.5em 0; +} + +ul.tsd-parameters, +ul.tsd-type-parameters { + list-style: square; + margin: 0; + padding-left: 20px; +} +ul.tsd-parameters > li.tsd-parameter-signature, +ul.tsd-type-parameters > li.tsd-parameter-signature { + list-style: none; + margin-left: -20px; +} +ul.tsd-parameters h5, +ul.tsd-type-parameters h5 { + font-size: 16px; + margin: 1em 0 0.5em 0; +} +ul.tsd-parameters .tsd-comment, +ul.tsd-type-parameters .tsd-comment { + margin-top: -0.5em; +} + +.tsd-sources { + font-size: 14px; + color: var(--color-text-aside); + margin: 0 0 1em 0; +} +.tsd-sources a { + color: var(--color-text-aside); + text-decoration: underline; +} +.tsd-sources ul, .tsd-sources p { + margin: 0 !important; +} +.tsd-sources ul { + list-style: none; + padding: 0; +} + +.tsd-page-toolbar { + position: fixed; + z-index: 1; + top: 0; + left: 0; + width: 100%; + height: 40px; + color: var(--color-toolbar-text); + background: var(--color-toolbar); + border-bottom: 1px solid var(--color-panel-divider); + transition: transform 0.3s linear; +} +.tsd-page-toolbar a { + color: var(--color-toolbar-text); + text-decoration: none; +} +.tsd-page-toolbar a.title { + font-weight: bold; +} +.tsd-page-toolbar a.title:hover { + text-decoration: underline; +} +.tsd-page-toolbar .table-wrap { + display: table; + width: 100%; + height: 40px; +} +.tsd-page-toolbar .table-cell { + display: table-cell; + position: relative; + white-space: nowrap; + line-height: 40px; +} +.tsd-page-toolbar .table-cell:first-child { + width: 100%; +} + +.tsd-page-toolbar--hide { + transform: translateY(-100%); +} + +.tsd-select .tsd-select-list li:before, .tsd-select .tsd-select-label:before, .tsd-widget:before { + content: ""; + display: inline-block; + width: 40px; + height: 40px; + margin: 0 -8px 0 0; + background-image: url(../images/widgets.png); + background-repeat: no-repeat; + text-indent: -1024px; + vertical-align: bottom; +} +@media (-webkit-min-device-pixel-ratio: 1.5), (min-resolution: 144dpi) { + .tsd-select .tsd-select-list li:before, .tsd-select .tsd-select-label:before, .tsd-widget:before { + background-image: url(../images/widgets@2x.png); + background-size: 320px 40px; + } +} + +.tsd-widget { + display: inline-block; + overflow: hidden; + opacity: 0.6; + height: 40px; + transition: opacity 0.1s, background-color 0.2s; + vertical-align: bottom; + cursor: pointer; +} +.tsd-widget:hover { + opacity: 0.8; +} +.tsd-widget.active { + opacity: 1; + background-color: var(--color-panel-divider); +} +.tsd-widget.no-caption { + width: 40px; +} +.tsd-widget.no-caption:before { + margin: 0; +} +.tsd-widget.search:before { + background-position: 0 0; +} +.tsd-widget.menu:before { + background-position: -40px 0; +} +.tsd-widget.options:before { + background-position: -80px 0; +} +.tsd-widget.options, .tsd-widget.menu { + display: none; +} +@media (max-width: 900px) { + .tsd-widget.options, .tsd-widget.menu { + display: inline-block; + } +} +input[type=checkbox] + .tsd-widget:before { + background-position: -120px 0; +} +input[type=checkbox]:checked + .tsd-widget:before { + background-position: -160px 0; +} + +.tsd-select { + position: relative; + display: inline-block; + height: 40px; + transition: opacity 0.1s, background-color 0.2s; + vertical-align: bottom; + cursor: pointer; +} +.tsd-select .tsd-select-label { + opacity: 0.6; + transition: opacity 0.2s; +} +.tsd-select .tsd-select-label:before { + background-position: -240px 0; +} +.tsd-select.active .tsd-select-label { + opacity: 0.8; +} +.tsd-select.active .tsd-select-list { + visibility: visible; + opacity: 1; + transition-delay: 0s; +} +.tsd-select .tsd-select-list { + position: absolute; + visibility: hidden; + top: 40px; + left: 0; + margin: 0; + padding: 0; + opacity: 0; + list-style: none; + box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); + transition: visibility 0s 0.2s, opacity 0.2s; +} +.tsd-select .tsd-select-list li { + padding: 0 20px 0 0; + background-color: var(--color-background); +} +.tsd-select .tsd-select-list li:before { + background-position: 40px 0; +} +.tsd-select .tsd-select-list li:nth-child(even) { + background-color: var(--color-panel); +} +.tsd-select .tsd-select-list li:hover { + background-color: var(--color-panel-divider); +} +.tsd-select .tsd-select-list li.selected:before { + background-position: -200px 0; +} +@media (max-width: 900px) { + .tsd-select .tsd-select-list { + top: 0; + left: auto; + right: 100%; + margin-right: -5px; + } + .tsd-select .tsd-select-label:before { + background-position: -280px 0; + } +} + +img { + max-width: 100%; +} diff --git a/docs/assets/images/icons.png b/docs/assets/images/icons.png new file mode 100644 index 0000000000000000000000000000000000000000..3836d5fe46e48bbe186116855aae879c23935327 GIT binary patch literal 9615 zcmZ{Kc_36>+`rwViHMAd#!?~-${LfgP1$7)F~(N1WKRsT#$-?;yNq3ylq}iztr1xY z8DtsBI<`UHtDfii{r-60Kg@OSJ?GqW=bZ2NvwY{NzOLpergKbGR8*&KBGn9m;|lQC z2Vwv|y`nSufCHVQijE2uRauuTeKZL;=kiiF^SbTk;N^?*u%}Y7bF;O-aMK0lXm4nb zvU~Kf+x|Kgl@Ro%nu?L%x8-yetd((kCqY|t;-%}@Y3Ez_m(HTRt=ekeUQ2n4-aRvJ zrlKaWct8JSc8Kxl4KHu+3VW1L`9%n~_KC5}g6&tFXqyKT-}R0?EdkYqCmQot47^9Z z6;opqR@7Nq-s|6=e6*0^`}+X1kg>CpuGnbpL7{xFTa|8nymC0{xgx*tI7n4mTKZNA znsd@3eVsV>YhATuv~+5(^Vu4j?)Tn`{x@8ijIA;wdf`+0P3$vnSrcWFXXc{Lx`1Z7 z%-n(BM(owD$7LzqJx)(f^Cusecq>OW z=h6n4YzSVM-V!-DK(sLT`!W~}($=O$9|ie`>_fpH0=1G1tiIFw($?~{5T>`74|p0H z``5=UydE)!CiFvmECW|s^TzG9*7pN|KknkVm3C{fEu30gffX&8iCm? zTFPm6*k%Hog`Q6JGj@dg9Z5nlAc6ApUe>;6xauB0-u!?wMU92jVL|3EcP9gEu5^wH z%tXRy#>HCEs*?KgMf73UcJ!lJ?x<6+)eJ{mEIS|HMDP7(7!(< z@X;?ACT8mncW9*XIaiJPW}Mw@b0W||)!sYnLw)0j4&-rXQgJhnQ2?frg1Nfk&JpmV8F=dDZl)e%#Grs|&0th7_o) z?7hQn<1078qcq?#;)CH=2kBBiGt37EtcXfpTXtHB59dr9=B~jI`yPm-Q?(ys=ajAu zGY;eS^z&WFvztZI3I~}*l}_lI^}6D<&CZ94;|&G9_pMx!C~$~EL4^8`QjT#|tqxxk zhl4CdxppbDiOk!Ht#SVAK4gf6Cr#=U&1sVxZ`y-X zTSi#@wHf(?(Dd6ypNOyshRZ*tneVP^W?y?$ur_!9iD-vY{&Q5(ooX2;`SkUjwEYA~ zwGcylCT4_`MZobm(0v$U(IhfYXxyjNJ@ztpH0sDmfpn|LMp3eM(R4uqKi_q1=D1-d z%GdV<&2+_9k@sc44xhIjqktRA2!Su|vzM0R-@#MK&{RdLoU#$Hc?{{JItvX{hKCtc zQNqZpkfG^@LGJRZM4H_>`F=N;O*+_`>M_ko_XWCgu@}ntqLX8VSeZQ_25Z8|^!d?o z$~}~9|`ZW9d_o<=8&K^~;Cr08b;qgq{(*e*sNt00lO2lZ;m-b<`Rl}=Lr6iQ8+$&br z!RLn{5a}j1Dh^|_1)Q?<;iBSrS0V|c_D@3}mc2d!%tV1VN?BC@clkFdx?HB&9KOTF z)9eHpmUEYsCqx^%JHuNdwY zz9P3oPYuTAXZVY}LRp&2qNl$pbsXL1GJ@wx?@CTO!acs+OFfW_U6?&As-(GJED}RR zO}B+Kxph7aUUm>i3rbPZQGXN}oQq;u`yTnFDAJ*d$4gjEJH!JPyt6V{cOUp*Jbyol zE$8wh)T=vpJOWRbv}HvR(cUSlO}ePIPdJ`J@yp=IC&E6K%r?QfW7F&%p!H~@?%yj5 z&MpiV!hyfukD56A097f!0+ANt`JSB~oLak75oKQN7FH=rQbX#Eak37|4&mqp@S~TA zOo51)xQxX}5NQ(3I_UeR4B;P0Q#x$_lDce78ET`Blo;`Hj*R;b8slZS7Oak(LjDuE z3z?-~-U@vWe*cEOsf^9|duH9};Pe)!=Ky+QQ!jr2VV-jMUH-F>oB>Ds zDJw}jm%V?OT^fu1y`$`yRdaW03L?)6vmInxhAsGrPhWIP8?=speMFf9Inn4^t zs$!88*B~c1A2J6t0~hgK2BJ_Pl23l=oeQQqjI2(4Mcv6U_#9#$PEN|qz36rCZ5$@I zNF1LpRe%ZG4qwuYr7ZdaynrPs?spt;9VbQM$462zbksMVhAOqPunrR7@Nbv#5;VKk zJB7xC?~QXd(e9REiLixHxRGhLcKR#0va}|LMS`AXKGOIGFKQv?=+>zf^ zN5XLjX6^`zh*%1UG_QV1H`@z!HZgC+OT2`+_B( z)J95hk;3C+K4XCswSP}au;fx=47~*$k`RAaYEU-qb03y0#x|&>LAeiXgri5E(!h9k z|9OVt@sk1-4+>0?ELyw|zs`~<95M=%o?Gix$?8z4Gz3Kpw|b>?BcD&s{X)-aXg!GJ zyq&`ZEP{K^u7ActXP$gGnO#F0Sr+QUZe0&d5*Yhw9A?C4(Sx2j3QKAlUpkQz7nji^ z%y8F|W{ypj(T%Bf#Wgyvq4szMo?*U-;3IGBRg1fK9!h-=YRsZ_+t~2!-)=pr;)Vnk zmt95&wMb02toOf`I9>M^Kv3LqKb_-#jauF&cGrWsCnMt?p7*uh zevugda={D04DB#7wR375=1i5}Z9fi3r)!F#7qmX9`SjppE&%8l8bKt+ADRMTWRv21 z4L&PldV8YpHw3b^`p0uWlIm#J&K65-y4lQW0VzZR!4#gfeT{b#fL1e*)Z*Ux}M^}bO%OM7uXip_4! zL@yo@q{utZeVV?3CtXs}i>nI|%26fwuzt0f#96fQ!{=dEX^YKnvIk*D%y9Cin;9R) zi{?)baJhgFs$1$SOZESTpldw2H&FD=v*v@1cA!`|s;avDKHa>Q+uJ8qhy!9%C4&lJSTN4OeydYOm4S?Bj7*e{xRYbU9Xos)R7qZT3dBBD5{ zo+(E3pR{>>)}hFhE+}!yYP0V+CVhyAq+RV{^X`XA3{iXj(ir$k@u|t8ZJ1ZnHq2dd zD$0RHmGJ=!?T5`*T2zOEJ~y}Nsyt7O)%+!0ulRQdsopJJxoznfpusv=2@zLXIq@^& z>0T5k4lzGCG(DnltLIe@6=ZOG@C(dvmYXfh4IhJfMfY8S?KkT znb7~EDE}Yhg$J1LxB7m`L4VMS(+(SXTQvh_mz!x&M3-6Z zFRB*a%_gVEqI^mL5|c%V=l_oi%|~h>gL0SB4QH5uonWd#={KPg6}6ES)zk0~#3^KJ zJq@{iqbHe3gyC))jeQ`W;(u3|q)JxuF24|GMsh%v5>>VY-bok%* z1Yl@(5G2UCK=fQck}pAyWV0n{`ML|rsl_N7vmW|frii__zB;ozrQ7{z)y}M^Sg@m_ z;+?{q3sUZs3WxnBbp~CyyL(TA?C*0KIeDPp7w0$!Ijd+M8#}r~vYW)NB*$mG*7-vH z@s^wK07OMxq>WveCEQFQ*p&2gjD1j%i+#G9z##Th`gew>H5=`RwyfPDg2G%f>x3@c z14Oy}pQK?(i06GWLWu%4cGjDoE-tTEI$`9^E?nLT663vu_>6K1e!N>A-^q&tfl$0& zy&>w~+yUelAa!c@xd8iyt^`B^$cj+}h}0i!40K2Ve1KFCDezBzZO8@=k&r)`TNTJ* zzF4Pim>SYL^=~7kW>EyiVHXNMT2)8l#v^IW!pLB_8ZvVfK&m8QHkjsZ)mvd?o$VYG zX#HiWwWlW>N{D85URJ-d)}_3h73|)X=E(6hFzi#TF{$4aSka4TeY>1a_(RIkFBL#O zE0_FoSQI)}+si51ufAqRHhDU=actTRQl@y#2h}xaDv-A&GP&0Qu9V4ED5aWnX z1E#mRT1QSvL!4~%Ozt84nP{&F>VIm6w2q!EPhh^BF-94$4JhCTcrdbDXA3Q&8mPTh zqdPv|X}??B?bIZPpl}z%(zr<8U-NoXjb*L#xyqHHfpIGAgN$5i(E9#rYPYq_tISC4 z2TDkd*uZ;CIhVI2o!||T)Kz`ER@%rTf-&SfmJFF>;d(RW(B6k!1<)uxHM_1G+9BWe zc)k`gBxYMcztqY5@jccaU)CqQ@^G5TBVx(nNf2}D@);3+{D)GzyT{>%dO6ibggS({N!!=P4=M8J}5R*&fgd(w36z0M0D$ z(SN5a`i%sZ9vmaEjiC4)DF}ix&`?mc-vYwK@+}8Gqzj6r6y)lT|Iqwlpj(LXqvh;- zb>jECiiOZ%&Q7gQg7(ix-?-RE*c(O6NG0F-+VCr;701@%L~fyfHnU<;Vk`m3A2{1MSmpii@G*k?KDq0GdZ)|hd`8OHep z8@6wv_|9NKNpe*sc#?zZ1S#}*qk{k<(I99u6(QT#>wf9w^u9~9_>;2d20T=^g-;b5 ze9x~fHZ-JL=J`hq-;W{2SgN)&m9RsVo=%?`JYp`pxEA_>`18Y>XA$rfWm^pQfG3MQ zxT^I1*({tZz2}+!5$AyNUE*jiYwu_S8v<#qZS4e!bGGBdY`3RkgLMf%Kz8s-;7PF+ z6w#-FwV#)PiKGR79miXmrDyv=ZTjc)j>N=&h4F+#G;unBZhhZz?a*;8@bi5`fV4)O zuU5pCs;tvRzbV@P5%W5xLI4I+w*^KExeVlzP4kNRGp-wi3g$lf-I|(o`JQ|u^XfkP zcik+g-5~2lG*oHfjLCpfNalFwz=4ZY>$Rc-QGpws&tCfFZUuJDL)3et%ap*$Q=-v0 zgLfsn-&%#+wnox~@)6ppx30sK(UJg1dCAvQF&}DkoPI+uX_wH))iaYvWtl}BtVKpU&MN= z0GdENbhdLgIwL-#_phGK;mZRlk4zq8*)akvV5zRX@jFUmvcr#3p99P@4z@m|bz-)^ zbZl8Wt?hR*z(sEZl;2PaILIG#835i@YoZQ@EwrD9IOBl7BpJX(ilLgcd)KCZAzo^b z6Z{|~=H;$D2dD53tejr_jx7^y-zT{SNZpNjn4+wJQX~K#LcrlKOv=D5xk%QXD{tg; z+xh`PvMV*HC*rF?xyjK5@KsMl5*w`r@wL#r13uFpso~#^oYIFc^&gGNS825eqFttU2_sG%_ z;X8VXD#Ol4X&$2B_Z$*&-)ZIUXf9I%mOOXJ3O%GbGpJfl+9(jY^fF_(b!Gt{{HAA3 zusUOCPDHYT@&*H~7a050c7r-_CaFACp$BXx)5==@fC11Gn|n~~+u@6N-}lvdyl3&6 z<#c_zm0Xp1F!8o2OBbFfgzzC4vno}9XEf40dGaVo;jiwiazo8hZ~iPVD(re=5k;H| zotm286$6nnTeIw>1FY$Ri|t{Lp?o(Fg3g_>|y~Z+16tvyLc@r?t9g7 zBuXyVuu9bC#q`?@OFIhgS)6v^XP@H0ukl2X!RPMsg%`YHMGad z4{VsgxaprFss3X%HbZablb6IdaNdbISVWp7yQXPPn=s7?J9qLEH{4>XAv8}%h&TDg zs()1sh}4at3nL3^%q!?P9BbW80e*ZwU63}CV7pt}gVu;~V6c$9p+*wfhw!zeE-z|V z=k{Ksec2)$Hu&?pRh;*TPk0T$Fc~^oAoBT4q?-Q}Y&3DluXeoMQ0LesTk}pVlf5(I z$dl8;zA0&=L&z*F*H>W7IeiPhTo@P0VTB~vyC2Bm7lCN}t7@NNlKFSHGKkh?z_qij zoYju!#D4b28cdslLdIM5Cmqe&!v^IcRr=qq^?l+P^n@6}fh@)IS81hx)SPAY7osk0)^ulqC1F*{hBNQl+Y}b>XjVXnS_Cc!L zIZ@Jq#mp^E&fKT~t4DM_^S17R@YJ@`(7;zv1mz_Y=~q*Gdg#*yXGxotY=#F|lvhPM zjlE)VHS=8=)njE^c7M|ZiBqARx>9Ib!y91$70iC8jPi$c+ysP}5Q3s`ti&1sx>~oG zI^>^1onS%G`mtq&)cZ15dZ{X^#MOfatyH0I=l%Q)n z7*@kZtC_3?=J_}?_G@?F?UK<0_AhYFclyrS-PkfYhAeVHcF z16x+quy10*2V$A%p_|@C(vlf}j3uY83h(#TSr$(;^8(I={_=YQQWmA9-IlwJv>tQm z=vN-I{TO7X`;qBxwb5w$91YLV?ZD5}pddq(7IdMCH zi>`qAn|#FITi!L5;K!(tYm9r416}Wof}P8~?R9I9Gp(?VA;uQg19MO47*gS7fH*&jBO!+ zA*<^BMccHjJIvGHguBb4a`X z3aZw#!c&Xr8&szD1+gu&;vYfoWo>0Pxfr2%m34tC33fmRbzWF9I_Pqb9nNK@N##9_ z7K)v)des!^owH`MoXY_O?|;^9;comiPx0e78xhnnVvTYt+t+cU1rn_>gaFJsL-iPn)?<9P9cF#4)7q&v+d&6|3G@s-AcJy+m zE&u*GUaMK|x|4GmT(CgBICk`2BP@3rqtjKIRD#uBy}y*d;<>`?W&mGsG;i*_}V&^tlP`%;=g39@jxP z+3lrtg*!i6N;irOpUfKcd;iDl5a`<#kr8RwFm9=^m+ouwwjcXmTB}w5V#9IF^&Bl$ zr1$Ly#cQ<3u86>am9}pk&i%nxu(W&s@>qEDtn_xVtH-_EiQ}iAK4Ssfsdn&L9t=)d z`XOQN7*J)g$Jrtq0=-yeLnHg*23LxYA7$cxz^Yc)I6E-!;{LQwu_wfGw4&MYy7{n< z@{g0Hf)N5gAJKQ1Z&HGPn9x9B7U(m(9K&=+LHAc_D{YdMBZs~x)u1Y8|Oq!`C4(3_9<&$ddi6>R$Nsz z*ti?=jA-Sr_97V}feo+}Lq3-cfpgWR;PLI8s{ve9@?e;2o}0MpquOucipz^DrT}QH z*(<{nLb4h9799hx4&%I8KPj}xcQ}llgcaG1!nRb(PP?m)=CzA4v%6>oOe96H9 zv4mUhw`>V$29k?)$Co>qIqq(~3w4jJ;Hv5(RxjB-j_iEhlF;&|DDC|I8IcT>Vn;RY zhtw5mT0ygXAu=M%{^;GqYuYIMu4H;Mj--5CL}|zMEhOum_o51Y7i|D>$XmUFoe;@1 z%GsTUsKgF4w%-Cr3lg#~h)8;Lk%WQTLBS8r*sE{YBUDw4HU#o}E)8pVIEfWv&14?U z-+Za${OFm=>IA358en)nB5Iaqxw&Xi*ty@uDOX8o2c0tq0^sX>ZXD+Hn|;KY!Omm1 z^%wgf&Zy9Azd?vmU`~zuOOA0{TZ*mAC!_>|avcN83F#c+sFn_6tGo!v?95IUR2bL$ zlO(OlhszqAgy)mNt8PRulC#6u^SL#z-O&@{=_!AzBZ>T4ROorj%fx$A;u8u>saum0ha7p zeHRX-z)PW*@v9bruyAtVI@)PhaEs5kp`xyxTQ`U9$Whwz#z$=U$V|&0w@EfCUS!Ob zACSTE{VeC-0V~ZCpkKq~P4CLgdOeBy>vB+0ZxIt_Cp4aa%vI#LS^K}ui07WNo}5r0 zagMHmq-jqTf-OD<kAvu_ob1mUP%1jxeKqB!1&-)_hP{p74hHE%WM!atyx68j5b zSqwh8aKo|NIOL<2_eiX+iOsRP`{MUt{0iQetB*SL!F_8)_;0f$iJ4(o__4KWuvy_! z8TZ{dTb*rL6VmuN-yl2Z>0glL84u^jAH^DQl}VRI=x0CnuF*|;|My-5aPI;>(mo+m z`nyEOe&k$RG11$vEdDPG7^raBCw|#C*4#pIUoZJNx?4|ZC{)l>+jaSiiJ`GBKf}l) zUk1>%A61hqy!KvfRsM^|u6vwbH5WpfH(I5AdpBAg%rar%zW}nccGxfgRV4&v`tEoGyBq!uz^f zVqWEtxn%j&+Q2Fi$rL)H`M_HExP+?mFyN^){c{JXs{IM}f}p>7lfD zLZ;s)%6a(Ow@`(jP}k~pn@!dv6JhJkZf5UoumHv`g-tcCs)w* z#0sc%t9@Li{p}f*$vg$UiQ*RGZUr=ykDIaxRDU_(QfcURuYrpX*7IQcS$(Buw%VW7 zxaffDgn{-=K@iEh)LlPc3MPzc+qM^>RXr6Y8ASnP&dr6fqmwYILTpmh$E%{Iz%Qz( NZmR35l_G4O{0}dcmS_L~ literal 0 HcmV?d00001 diff --git a/docs/assets/images/icons@2x.png b/docs/assets/images/icons@2x.png new file mode 100644 index 0000000000000000000000000000000000000000..5a209e2f6d7f915cc9cb6fe7a4264c8be4db87b0 GIT binary patch literal 28144 zcmeFZcUTka`>%_-5TzIqq$xo`r3nZ`iiBRG(z{ZnN$)K|ii-3S5u{fmRRNLEoAh2n z@4X|01dtAA(50@mzH5K?{+)CF+}EWTz2eMdW-{;n-p}WG1C$hCWW;pD1Ox#ad~k9g4`y4!oVfq@3c(iW~uhy*`T7_0aH7`>`EnYuXVq#+YC==3#rnNM4TqqzM zpi2Elr!3hl!ZdK#y0bV+yVc8rwFEtAX3=QlvJ&e-EsBp)Q`0yKXbNuf-yYw7kh0CD z|Flk1UuHgvoR+*QR0ee&IDUfUzE7*`A=P$6nC;BPI@VJs|F#`Xc>X!`<6%M7XXNok zw^unt1h0m>-&2{GiIGsByulr92XZRrazZs&&M3jJintF7A}cE^uW4zt_r81yHt1I! z6-_gmO@78G3$})kfyhR0^qk?zev_%4R$qSjQI3MAg0)9EM#TOAD=_tf(*)S$7yiiR z&5v>wk3Bn**iD9S_I#2%^vi(^O+gpv2i^A);6^AcH%VC>0nH8|O!jN*L<#RtT z@aF9HMNu*d(BdiZq(LBO%(qsjSot+ZXQd{zLYh#CvOrK(?#u+|XYRylqcXOLk=m!) zBp`~~1dg7kF(Q#m)I8ZHMOD5%m&U)5jGOW@7+sm1N+O~^j*zRG;e4x@OteV=T4yo9 zSG`^0j^S)ZYp2DT>}AR|n$S)4FPI#8#(R~;Y**AZ9`&yqT;p`rks7Nhz;)dn-TgXU zw!^Bo@W6|jfp@}ijsSEFo#x3LnG;`o_yXK@2KuG8cTv&K@=dU?_PK*6=YU9!Ix8l;<_!y*Qc2phVpLM}&t|CuHBv&{M$K?VXtTabi(7kUMwV zl!>5cDNNqK6`Br*B~EcVh#5Z!FgiJZBN5nzpC7?UdAc+&AT0ivd;DA2$@YXMPK6=< z+#U~?*!R0i`3uu|#zDrRRN&j-j>ZOu#h-n#7WO^)@0> zCT6a$LGWwFLcPfN=(3#6`*UIS%uIT=LIXV-RbGE&!!+8)q~dkx`l{aKCe1`{J<5&< zlhRo;JX-UC>5)X;mwR+W96`@&ucHp$jIb~B_w_=mH>In?BLume!Wta=`ca+&7~pek zBVD?f5{nelCaje~EtZn+g3%5GJF}R_b`q}IH$Iom2IRD$^h*R)Cid8Q5~4Dzm!P&Q z<`iI)4wA#l@TwjPL)*9k5Vc!!;`9;bf?HRMm86wi9LI8A%*NGep3g11H{aP)>%l2Q zRMMQU!*0J$hJI5Qs3b=6?}qR7O;BU%Yzufc*ZKBV`}ro7zm=C?OY6Vlabc^r6r7P> z?1c^jD{e4n*Ou441V=Pd1eE8utX@)G5gq72HQAXLZ4l2wKd@yIYC+s) z-mu`E`kj=B!)a^B;pecv4W5oh>_tpj>^NU8L*eH4EhcOxQ|);$x(z(Yb5^tudSptV z%8z{(h@_t`chWkvFX=r!p~Vjhf1AdM>uGK05$1fyLb5D7m0!MUKW=JTZv)bXz9~*F z$yP@U3UE0=$;yjWr8b7C(1^oNDMZVxYYeMtL}ZnvQDkm>S0)=r_ugabEZ}AJ<<_Fu z{I^KKIz+V8K|pK811W5r##z8^S*2fr9Ln zlRG?Zzz8;xu9VSE8s+=(!^TGi1P2hC7%7MUqF=cZqFBtJNW9BROV ziv0cjsUmVvsU^X!`1UivK|dy+fSG$3YH8W0`q${`)taBT9jV{Hfh|&RIaJVvqRIFh zC*Rmvl&3*;XcMiJZ-+Mvfe0xN4N?AvJeABnNdgs(BYb!fK5<1)5UvM!Tz4_aojmUX z#Ymoh)m%fN(>6|#*RP~Lxt1?5);w}yT_lftje3sidO&MxNgcMg9@S+>M%s~y)0i`8 zT_+7LrZ~d<7V^K^C^~ast~@nM04^c5dw*&660^p%^R>n4xzd&jo)Y@ z1r=F09>jFOr%wsj^a3;>N!{rvf(qpkAdWM*5IYCsuwNwoJh7;9I$#`T6-NUIEKsiS;OylQ(XY zQtCiR1dyEGJV=~|zaFOEveB&szAVx*wsyuY?hiBGWR{h0!D zv;G`;F9cnib*YxugasrI^%uy@i)>BvC4V8@! zwy5#iHC#Qar(i0EPA3CuMQbaKy4m$CLjLSNwJs!13b%h{&x7479bv{SjC&3?SO&)3 z6q4nRRP(zOfw-mQrmx@Z64~o}GNXa9YCE$vD-(CLseaF%6HH+WZz4 zbRiJ~zAtA6*i9;z!+zZ?9~V0Lr66|Ae;}U1e#6D^hMhB6XJNHZi{t>DgU&jb=#rPK z@s04Hr_SOr%UCRY_SdDuSw^D*Rzre~4PCqgc)DBYam}@G^TxsTqX%w-yWtYU-Q2IX-a2Z4Kz_-yIe`m;x2bY1F?XZoIH=`uW{$R)ICXxqU$- zG#M6s!fDZwUOA_cs|PXe1T@XN3^UdYyR*t}943A1dTvXp!=%8c%)(s)5y@OJ@@%1a ztlq}Uvhfo3^ZO>ZO|NKfu37JMRRmXfJ_*VOBVnxFFmbq!zc%A+R+w|={11?sJpmca zCeCi;;-*yO)ywzKxa#q?E%@U-+LGH4{=2|reRd-Kz*Ps1$u6sPFO>{K9^k2Y!@=h7rZt472^BCU& z|0MZmbh1HlC3#bcjoX#m73R?H>6oW=45{gu0$S>j`v?``ch#0kGur}QbO_gO3XrB- zS4pz-Yrnqqt-k_LE-&~ox9gd#^n&HE%Z~grM;N@Das8-#U304PA$v*rj36j~qQzYN zsX>8?%q9DhpxrWR@M>30YI^WUDh4bcn+*bYn;~zt_g`$3{#G+=lBmWE;j}5e&vlDa zjsdE(Xg^o(Z|3$Tx>~-q5NrZ}^$y0eMd|h`7Y4OWkgF0(Cu&CfJV03AKfzSGBhMU4bqd4kc`qE!CH4Q^FdOCtUHaZW3R&>S}$! zhk=OYL~3fch$-?wa0)OEkynDzJR=vc^vuUQ$hF(>E(q3{7{4uhC^f@bzHUZT>k%%R zsekA}E`OlGE(x+lP1smp0;Ba7{C$F=@Pp~i$AsJkc)x+3Vf9xQB=aSN>D!T;Y5iU~39#6yoQuj6Bj%kdYC z`72YjnSoF_A)d#@S`|;~F|6TOn%b{4?MWJC4uG&NK=D zqd0rU$A@62MtWD$=Gg>TgO6)b6Vf41#Au&Zq<@p1RG!t}NG8kv#>%{bHuCdAeIao2 zkWX{dyO`XCdv`FlK?jS{48~Uaz;oD6PtoFF0u6HBTHCHh<)5wP<r?9UIw%{psu)`l~*PK0?1^oH}d{D_wF{En-ejdBHTK|(*2$K?xVkG zwYXl8^HAjVOqKQj0f6s~O`)Slp+alXd8@#4Iw?pHys|MW1|l%ipCPeN)|fLB$Dc(9s}LNw@?8G{ zU>U(Vid5}ltIy~zNv>o09)rC()g8O`<5~!qF*Z_?L;+2Sy!WSv=}|67mnOPb!A*2; z^f>okkk+f3+9?Tg&6NBMX%;BtB3Ds#(PZ6E4`X0e`~amc=9QGw3J-$!nw6)l1A8;m zFdl>D?g@J3P-41+3N`R32d*Hq0GWj!{3n&rVA)dpcB+|5`XZFFZI1bKA7d;-x=0wt zy;$6nvCJ$_&JDjWa%`LQYq&(6LqBP7G_+`+4$|qk7IlS4wK{qnP-3!yFO%_fw(8(Q(#|htD?ECEYPeT&anf%0GjGQC<0)vR3x=4pq`@gX z{0?*O(e3p_zu@N9G2O%!F8j&|FRhF(c@BWMxZTpdW0xv^K!`2L39%+Hs0#R>a@n-J#u*kF6~?DIhPrUi@$pR0tS?5wF%PE z(-eYCc#{7tVRzd>j~xO&LBPK62xxwmxrdd{N6!G1hfD0H?fV)_B^PBIm|@~CZXnpdaM=<+?&D8Md^RL00JfP zK|cm@`4bB6muuN!Zck2>k+wh^8kM73#1(%6#^TG;42H{?eTC(h^zB32g{Skc%t3Dn zcHX3$TQhR}n9xXCd$?igvlBH@ZU~p4OO*Gf=$@=w?9vYs)!RYa9V@}xVt8Sr4y_!< zGjn5?gnlSKhqS-YW^o#@NScez6I3x{ zv>meTLLYSK!pa+|kqQI8rWST7_)jL~mqQ}Ou*!V2U-g|ZR+pB%Z@w|HnZrV~uY*w?_gMhSp+4fY?hMmdNXYD(iruAlj0&qga8nQ1=c#y* zgYc@oWp>=|LQ+s})zQ5kv*UF?QMJ2|FN1CzjX$x&TwGJ!4VjOiZxVDVz#r28{^WRn z{o1SYRs*^Nt9(ZX`wad=44v--X~h#aROW$yKE=n-VWRfhI&wn|_X6(` z_WPK(bt4Q8gxJ=b%BW_nNj&h;H;2z`{vi`~)tCBk(zGYBp?f;(Ua+^@+rKm53ld9S zPP#A^Wv7>F7c36IAp7(%S716|mr9fnL?n&Q*?OcmX7>@shP*98yVXmJ{1{z!s;@_D zt0}M~j-0t@?)wY>a9PxzCVtBiTKiS1<;-&hv5CHiv=8d$IOnl?aI_>zR3eW}l*}`T zd7%jWK1w(iqAjU37u~dz-4@O^=PWhD7_yL+z1;-hnPx|je;QFR?I_x6McEg|;`Zuf z_}_7>V@hb=%%^H&>8W{N&Ud5bKD%p(B6#&l@nN^wOdQizb`@g}g1c|qGqGr^c>a1w z|5;G!BbS8(8#mlqM+re6&;L0Ba$evPxRGW!koG@-z@*c+8&^U^7Q+0jgUtgB$)Bh)OGD5oa(ju zL&w{}@q-4qVXtvRtXul%gWH0DxXe$&?MN>z2jh1!ElU%a2;fz@xaTyfs`lnr<` zLv5teGAw`KJIh))Wg8JzoRNMyP>X1rhr)=#Y8O6Nf7>}xLS8!@+&6k0h#H>Nn{`&~ z<h^0MI*wtWWT)UGMw#$-to|sCF?yXL$;_=8T>RsAI7ks*W{$R-UI&M5a3{Gda?9J z3PeWSws3vp1$(`F*+<1X7B6hG<6u)lqr|?N&1Up;Si*MeoRFeRNGZa1=`C?4ZaPvJ zuHL9EQ^d$jd1pu9n6iBgWPMtJyxmfJGQf{a*eag-%E@KZ$^*2_&F#h|LL)2_l*QS9(#5T>)&wtE8a=@FF+vG8N zk>*kU^97;}tRP6EGf5HKhlr6@^Nb7N1`_>QnnYF9-8tncspx59kcfE)TtFun#cCjn zEU2;}6Xu~xx+Bv+O;tKLcuo?~kQbcPghcWdz4-^H!wQOhQukRZRMRk>kfMa~V;A;p zSqpR3D87(4X}j4Awfr<~7h4dgK)pzpZf{bn z^yt`yH4+85n%*$3rL0fWi>l^4|J{Qess(a2+0W-O>gl%xIaVi`l9N3Nq}{$Q?o$#6 zP(6};On20~O*x}!V+=9YO)zz4yeTv@_04tEzA@Muc((5aTR+rHpa6@RymHX{a%Ss{ z+ZVey@TSCpCZq6G3WNWPfd3Z(|HlaUnQ37#)!hnd5VH}%lQbK+^qVrFox87bV{eTd zMjY@0wT+?ndYzV$vST&K{gWpow&Zbq;%=a$(B%@MLh@v!P|L4U zgM9JBN_Gb)g+}3@K$8-*b+GGuC&@6v)Fomd?4){kVQ)620*%U<8saNfLM+ndN~1z> zV$;~rU}Fc&M@|;i!@q(ZqbHdoB(EYYOs>u5jd5A-M`}}pr;g+_B5o2kj-|Pa zF8qc!e5d+kUV>;ih=57(*r24g=6@)>+c%LfGLw_-Bbm7r_`az+tag}5rqG&jrg(-W~CJFkaxZTf@_Ofx@ zzxqF#<4|HKKBpc&B9R1r8t{!k_=WNfzbR?aogs939=bT|!c4N>91ai-wsc4|JdG9y zGpB1A4i1ueuSS{R3h}0^YLpx`pB;Ok2-R5 zZzHya))4+|xc0QJ*&1>3;@0$RcgE3M_rt55cZ9<51j!pV&i`8js3v%e$CG{I{X+yj zruhC$iN%UA-Y%u_?FQq!rBg;{`8h`ZCg^bG&OC=733*%4cUW`DPGqp|OgNy?)-Lky zuY7>yw$@M~Jl&X?9MI2RqOdsWZwzFd6{P)UF5-=GVh z;$}}BvAUMs#V{T@TweGxI7dhuIzFqotm&oQreos6)^Nt1G4l8ce%&u1F<%WFM9t;W zBAEtq#1FS}e7Gq{9nzJ-0@1fhx^+w)&5)h+@I@?kv+h4xs>`xqTMB()kR)QH0W6ODL=b|ea)CmcTzPItT=KH66{L4@p}bW9=F z=+(cM#QUgiq$M^X08=_kUPU7sf!8j#4rN7NO0#TX0-;8=ySO&T7v$C}*`++cHZu0; zRv+{Je*j9;z>+TGv1i76Qc^1lu^>XXp&w}t;MzI_nTpY_m?O?J|UF!?x>j)zIZZ*}uTg|S?56^~@P4iEAwq#7&c^D#OmVAeT^&ib{UcAER@k$$X; zQdR$NNz=G^;6|aY!VuP>0e2>_I^ymyjmC*~Oj(aU>lb7XxoNc&mR~HbdffiYw#m3DLJ)nb-vczmSGI=PaP=yOJ4mrW01pSsP02=(ym z!R+#8VFsL>Puje-hBZZ0gY`?oFt44R6Z--pJ~w8q7te$W<+z`WB)mKtrOR>%f~{*2 z8>hh;3|%NPQq8-xDbWw`*n5*Ni7GB0zr7D?q`b1s^a4*X%Jk>EYA*r$va{t*S$Wk8 zL^lqaL9$a?PVadKA#e`-ocbsFKC1awpXsVmMxs^Fnz9Tb*6tD1sa`;k~@OqRo@ub(|hVwu)j^O#EQmIetE!ma(-|!O<`ZRqJb<$^dia$W5ARK;F@n)=G zXY|L|OhQ88G?ay6&;=(qqYF;O$NJ7x1?PPHYJC`UButfql;CF9^Z@N$9e`rgvKY7- zzkY{r^gSjplQ4S;+v7}YOOB)q;im)xJ8Tb}^>Fe{+E{o<&QW1zc~g`vO5=ii`UUW? zZp)~%d!YRLs1P5Gsp1zs3gc8)u&mU&?P*XcG+Tr-__K7L+$}7WQfV_Ngi(tq_9feK zK+m&sYg9Dt?NYYIX6$uOy3OW4i<~fWv+Cf(7LSO2Cy{IK;1#Y8C_5@I{l+TY*=I|v zB849$N`$Qn3)Wezrk#N{(Sj^ujO*o{#sa4oD_O8zmLim4B{5HQWLd}YpB(b z4G-q~15C`KQcuBSO|^7AHPTM2RneHT?`cv7UxhiJ{_{;Q;kGe05x5xg&K3|_>$pD_a&U>aXaI13$(JL50d8Z5nu7>Swu zA*$V;mYnn2)kI5c`a29y*`L60#8U8YzlVb^NVbZO*AIlUcC6{g-vYStoB)oYa(>HrRpU$_+Fu$?E^-+?mgq9i+l>lZ?b zT6(Rs*ytr2RlqzPAC<(}aFaO~EuqFiP9Nk%5YV?9#t-?A=4jtCuRhpfZRc5{uXo+q z=LI8vUYPpMT}NAmAiT1T|Lra-gEjft1a;1k`{Oe~KvJy%Wz~FR@vzsl)Hj`G)zsap zD0(^YuCzHguv&0Ryn%gl!eek+ywQej&`(Qef(ql7EcAYQoG}tAUY=Ns0uhUO05V)*ND z@*NLrHqhR{%JlU-nMJbBbn#Q$0gDOt;1glG|M6dhX@zoq#PRvcMk<`}n-dBYPlDbf zY2&o+<&J4^>4Q557tWSxa)1M;mS}X$!JFe6+N_0AI?erp9CdjDGuyvnelpc04y2u#n8-PU5wo6P&9?ZpnONA+t}Ucy z&nD(V>H%M8avRC7jdV$uW8n|L5W6kw7|(e8$j>_ZLqe`6y!1fWM}{tJ3t7HmzB894QuSOpNj=&WDT3e5Or0)3wFwasb4%9_M@6)K z&l3J-@<{!8U7lZ%P!XZsO|ejU04NSjBEBESP4Ff6+T}!&pxTCxBG{W z{I$5gyC-P##k--2l=5r77AsRg@o4?Q7zqe%7Y9-kbSnK|KDcKK;nZqb@o$i(QzUtW z4FlkIku@T67|OO;)}XWaHSwT$i->~}#O|Bld^q?M%%`d*s2x9BKP zZo$OD?q27J1NAg#Nd(Fn?4I|PbI>nwdR&!F6YOHC^L#n$QG{zQGnjL8QL{~TyS%sy zMT%4c%BbJPXL6?WNg|O1-c<>qUm^=RW`+5)eH2jAI{T^M6-_natW57V(D?*MKT4n;I#vjkQ1Y~X{0hj4% zF}qYRzy8zJX(%d$`X$XgPvDafqM65Qw_;|~(JO*m8-*q1ir0~W4cd`@#KX3_GEp5t z5?rPAGz%$L?%(5dRFgw~R^|tdxXDGF>^=J2drvtC0;nBNt)$2d+>6A}c}i_~ef`fu zywIKq{Tp+H@09h2i{+Dn7?p7~8D%gZ+<(bq<1f|tL;Qy~w3}O7WX))3Ej+(psj!1- zrlt&tNKU|u?sySN{!ByuYY@P5bL5@7&Uld^k~iLzJaP7WDAI|JZrsHHT>hmAC?xw& zC!c!IBNTzL7K;wAXR3vVTe1i(oYdqoy3H0Zw{@>?*4UcFaMCNHwib2efs0(Ync=2q zwM72#(Cn=nv2ablw^j({)fdng^E-(uP|5UD8@CzqpKlZ^=HH}?5{kmM7vLAoAatc; zwH5KZJkkdhh8C1p5+HZgC}LE+Xu}KIn7|*#?;j-8^-VaZ5jOW{JA#*;g5p`(xTiDd zKkPnW*IU@QEsE%-JWbaZU2+aF3<-bfklBU}TCC{E-~c1suP&!}=v`e&X_xF{wro+L zcgxt?1af+ArOGprbI<(>!E99@GkN&7?#q=uz{(bMN@|0qqxcTr07b2;i>k6W8Za(r zOGe?77{mF3SVV_<+hIDRNdbE)(lSDJU|Bf|swOh*8)pQ6AizER8M>1xnN1+Qcqhg$ z&ak{6PD5v75^-mAcvoOH6*!9Hkzpt)*#Ip_vNoGk)^|nj*9+w7+7R(=j4q>aw<4Wc z=nBx)kd4$ER29&>bnknJ`n4)pOczJMPJ! z0)p$AgO&S=`T1(PYN?P}4cSJ%&R?iNexQp^N$*`-AbTP7WfZIW#P4d}}S2|=#O7ke0mzh*aEWQE)y!|#~iGCKXe zpzrFFL$pk!^d8pUI(IfGO<%TTQHsrDXLDNnMC6*d0wT9m7x6Ft7V=_OlTqkuj{x>p z;1kpB_NxE04RdYk)Y!laqUU=rfZJ$T5)`7`QV?5(Ltg_xlECcjtEa{J!@6Brx);>b zl?P)xrifEIfWi;~!Hgrq*7bz~i3BH#^2_mOIb$vnOz3yqef|S?NrX2~aMzcrlIGhJ zJ57YYnbrjk0gMXNJsZ;3!GV3+U0eN7l{dNPN>2^D{M%{F_n#@Jh)M2G9pb6tlT&F# zzc){OFWO&LCDH1cNMGR@X9VA+vt>EiQ|#sD{Y6sIh0eE(T5g#Bhn{L{CgdEL#dtrL zC>~e(BtwcN6QdM$0h>v5cu{@BvleO1d{z*-w8N(k$wHP$AXwvfT1)EL-?E&6nLdTq zFA@*HmwLR__b301zkRRgd(MeG6hCvppG6OwFv=2NKQVx_rQX$Z3q-DFDcOMHtbuC2 zb}=nSGqv$BlXjj(ahhid7ECVPglKaK;z#;LgZZ+OisWYuKBPX7xpErFk*@EYkKqg2 ze61oYkPXBN#&}jK`c6OUoF{pGlCOmyvi0VbqIH)+GaMDJ>Eg{$20?GwP~=nbph7n3wT-iS@IWTjG!q<-}5nJdNKFs75SDJ`2N60FM#00h+c!NU0ufy*_DlHj73t z5%X`Hqe$xxtHUL9%+{FK#XTYqf1a`&Lh=``4pOX3cy239FO^N zfStakz4XYa-?AppcGY?%Pj@WYmLvxBlKhq06UyFTy`Dj|YO2D`3uG#B$$f7PEjp~U zN;XAx*Xx;j?A}%@n)?=Uw67Bf^MPlLUonDdnT0whr^OXyCbtVRp^N&tL4I{~Dg4l+ zvxK9}?_3)Y$>n?i!054VsQ<#MMZ=Q@luen-sz=N_VC}l?`zNJtA`krH?K@>?REBq0S+(}^2UlFWDqHi30Pa~uu05d$T+-JrcJV1?aXOg(}Rs zl`@li5%>|PHxJjZT#h6)u5#ukqU%dvk;$HYi|x;L7naNA&)c1zj7(iIm+BYA&tK7r zwW0zwzaX`x0|CVQVi4}J(N#ScVIBUXBSyY%CN{!aH)SJ(GEwpFU}-yF{d#w05hL=m zqA}!Sf^U&%EPmu~34)ZMEMWZ|Z{ zf+Da%zhehlo-wY?=x^Nensm)O!dR`~B96^wloNE6>dRY#u#pQB(ftm&2{0{aPw);3 zLS~XJegtuFdsZ#-4}Yw<2z1ya*ZublDU*Ut>&i)(l$<$AW-E7gWuf>Kh>nR@=~Jgg zYVeI|2kH%1E@)ScwTRMO*HTWJ!AcdT*o-xoiH_PF%JHNE29RfRx{{W~Mn)HwZeR53 z{~74suQ)4?@;WN79bIYU3yi%hNhnxTu7in4w>kOLA9 z^_cPfyxl`BO^Jaqzdl`|Ez%y3HTE#{dbqX?j$5k&zQxN?z*CZw+vAZV-WEk=-9oI^ zi>;EFv9pBIbUMsM{{@)yaWwa#nUxs`jEZa5y%dJ~ZYpxpbwF;r5KM9NBrtI6bS49Z z{7GcMaXGAxDfXDD;60Li!JF~fHPwUU&ynr@B*@3ChF52>+Zzj(2PL6C2Mor0xpcaX zJz8ihH2PY@>!))WZIW^vV%K*vW$Xw?vcF2|dP9n=qCP9;7B^IZhW=jxJ&T%Ztkc=ADNzA zsx*6uOG(O5$(&<*ti|J7dW)DtZjKZ4%;`A)POZf?A4Jh3X-N5M*8W<2T>+@m+RM zso4=f_o0cfhnM$+auk~mI=kVgHZ;l-+V`UB8DLApLi~fqxxCu82ZpTHwuvkJ zMaL0c$(fK#3^%@^>W3#TVHR`5ZG3y0Clb5K47#1K#yLmQyhW_55~ZZn&H*`)Kcz#xCRQCFdlucHx%dY1wZPf=tL$KK^-_TTkBlg%SX#-AMe8 zDRJaA`0SE_!0FPPn@x{0rimZQd9k+}88MLx`S?6fu6=l1Y@h3fs<=&*q;z=urTS=C zK%}u|(8k5e&Y-zSmoYb|zD$^cY}p6(t?!f9J6m?2>Tc-Xy34Rp*Ug6P;_=3oS~ z%u;Q7%I5MiGqZ{d!-pEl{0|+1NTm+haNN1M^6$Gh!|V@!B;}D{h3pn(C{xBk%}#IR zO1TK6*^j5|!U4^zB>Fw$Ab?>qDPT1M^Jx#~^C&2cPdIB_0;KSVNk9r$##HLTSD_Z& zz)jE%*Gj)7d9uVMl=+HdJ8%e}9%lwaY;_kEvV>UsLHx;mMC@f3lzq5Iv&y8{w)@Z#?E z$bXT?tyF)?<3bugVVY6(e@Vg`2i>|)$^m~$WioLwW}oXXZ}=w;=N0{LOx0{9*as^Bb{)>T@3m+vEip|GPIJDHTEO0j?I58}) z3~@%Q(7?0uCeHM#BsO=kytmWFVcmtD#HF#V$&{e5iF)nW6D|+WjJvd;&5ukcPLykI zL)z_SO#T-IEgtk{E$oT_$8EEJI%wS_Y2C(F)`01pzGC)%N-d}qrB@+6yelt`_?uuN zPMGYZCo678{Kdb+IPo{#IN(js1Ummj@!l19H8oPMb}r|M+d{D&z2T^r|!8rbRwlE=7j zz{QM`99y%o-F!wvWl#jR$l|ML^ohwPPlBQ~Vi{{yBOjvrhl~uf zK5Vk45;70o*YhtM&7#Sc2dfA3wZq@0ZZ6N~v6zg&MzJl<$ZNrwqf-$TiT@#W`2x6Mt;TiS4huyA5^}YIPTFF^l19VciDe9QgSuo770l zz$Fvs?0FY@_UtE2YE##{%dGmgZHHfzsU_`V*H`P4*F`ul(sYs9Jq*h6rbk1>eD34Z{2K;_cLbZ46halLc ze2%NUKU&GA!WwUqG&=coFm>87tCT*F4xGxo74O@5Y3xJVE!8F_1FP%~BdC2FS9Isf zXuW-CnGh!{^D*Drcrxc3Y`W9=5ZVYqn-rEs?8_&q}IoEx+VFS zRga(VCYV$<=Zq#wk?;b+las#o#HsNw*`FGFDeA^*xQuB(cE3~CcEUYt6MjgdL|p=P z2+pPgOZ0Zk#7FPiJV}Wb={;89-U46uTu_QI1&b)P=+se1|88_^!5Um>o)Nj!lfI}_ zA{$}3*734@W4yItj?m zLJCa$`Rn$L_lRPSglt!uro*Wg-e^WHi@NW8q5zxYdq%ULx=%RZ(Ry~zKFHmgD!x8n_+?xj`!7VyZLb@!Ht zcyvx*=Ox|L<#!iwxI;b}HqA-#(_&c7eI; zh0-~Nl>BWL;lGfbd$~ThM~0`;bnAxA&t^Bg46A9F67?ijVTmmSHXl37dKJH@X%pJ( zv;J34-$9e2BLwPjbgdS-#g6)O&a!wuZ-4?=C;(W1fb*oq3F7!&Q;TDT{dSIuAJ0r( zTYW}1z5Y^?(IYRkcvPK{&UNZ!DTD2NG^^l4v6pZ*x!@0~FW+zs*VWLZvD5?b&529v zzAIr#Blpmqud6Eze&qzM(zwET6WE`YFdmz$)SiInkY`uE9 z2W8d!Z|P-BLFnbp3rcnGlI9P_{}G(V#2CJpq^&-OF7u(-e@`ex!`4!J7AZxIWjne$ z*}p)Oo)D;<^YCfczySXZ)mxzJ%Trh$e@@Xs6YI$UjQXTpMM3=OD}yJh-k2t_G}69%^Fr!Z2HQA5*4M*x@spn| zrheG^IKj0ez3X@*QK}PLKen)$lLlOFZ8tSxuEOsfZ4ZBRv~f7a=7}eY0qYvDhVUkw zZOeCWJKZrO(yrm9v!+wYKhPp+8sVTN>nKBQt1)2z7ZTr41?oJxD3UIFa*^`;bD2FhRFQI1$)e-S7>YM&OE5M83i$Yg1gC4XbSB(3HY$XeKc0w~r|t-}85eyvq znGOcAFmP`I@uNFB6D-U3R7zi&HI?4$T$XBCYp7jyF2hIU++&75Z}~Yj0lG(o!Q{%x zle@H4z=iwQ^%fFV}$@P%l|Q*S||Fc=aU(OuYN7&dFa}V3Nc7J*3pGRNHysT zpl1qYqD}+z4udN>1yr0@uF3~3%~hGND|wBbU_IaPN$MmzOSBa(DV?!lmqJAFWhao7 z6XK-N{+v`HO%=al&V4z}>Sa|@+Qf8!nk9bZMS#vdzl+RDih{^-@~-07nqb7URdH*R+DD=7!&A9Oi{-a*?F%R^?_>z|&W zHQ+4C_b)3pp#^K(qJHO8s1UDOMw^aDYOOebgZD{HMbGVDVk$+=PF2;lVmdaX96DD( z2>^x9360&?xbJ=C?ww+GUzY7mi#yf$i@Zi^^Y}?DA8FLB1O|#d@$jX3gICv(QdzlV&8dxsHV(c+LsK>QTvzU6_ zYb0#5dCxZ%c~~}R7+|_=M1NiJ;GL(M6jlh!W$wT&BZz#^;TRxOvOoC5av{aK*jUdB zEJTT7g$OLq7j%VOxq7lBmjswrMs{Cq4i_QLuY?I-R*l_PX%)WEauEF6LE{{cM%g#Z zY=g9-pHTq4-?B_^ws)ot(CdUT(Q;?3ZgB%&0-LSJk}S~oODd0f;gmE$LNlWC)*SZw zTF2tWUDe>}3GAgFzfUW{@fr-5%+TXNF!#@u3xLK#M@{^pJ@RwHxR(mQv$rbM^u)yF zp7gc4+^-scO=w4GnLoUHm&|*G%B4)zdnT-@sLAXD{t?qVWoK?M#QmO7ZDZYumcROM zT0RXq?@|A$uOb2&0IX>Ab9ty?U)lM3)bo7LPM+d~0IDZ9U)9X4Pt|IhEccrc4$Yqg zxN&t9niz^0H@V{LX*57HW5=4LcVn`mZrtz!m-E4LWa#a&|ZE=ZeR z_be>uWC0uQotqmp(+ySAn|+s`Jh^?c#?)U-^^qVEROY9akEY4F$EfL{d=!)6%BG-- zzxb^*e?e$Rf1Wl1QT?k8F>OCoXwv?=Ung`f@oR`*z|{D)G%5h9(2EXaoVg^$f5Zm< zKZTunJXG!9$1R~Oja|ej${K1yXo$j8_FcA;rjQxV!J)?|Gj8yk6(bnRAXg-|KsQuFvOvU}1Q)$#BKFf7rFv3#c^C6nuM& zOO0Gft$Kq{^uZk+fBQMx4ywF#eZ10jN%@}^6Trc3hCtkr5v?qLPeTBZoa}i>5KfE4m^W45!H&tNIy2!R)_bi2pfs)oyorVbu+nl5 ziVqIJzcjU0;LWSXA>n4vmdvWwz`nJ(vB0=#2PO^BiHo&%ecgXrM@U_;#^7aMCflK* zu?J85J`Tl@CXG@Gz9}c1FQwCP4okOwbBpS37P8a>qfV`z9k+`X5YFPzTfu%UP!6y`Fvr_P9?4V5;X6Bf8{U9#rCkAZ zM&uVB!n66B@`9(+a&}!KKRfCf^oQNN+6$^tHoMIK!>*$7-0ZFr=x>*b-P5X-LgxBY zo2Ug*pNH%q>8qqJmtk=~7g&DYcueN3PcuE3&z~%j0gUYgSS9wn57tV0QdV~{+bxEnx{U^j4&k6Tg_t{mX$_Yq$xe=@q|jc4#`MB^ zJT!tidMB9LT+XqKk3JFN=!_dS0?dknKn##1>;EeT2o)}9LyEIBz=e4SFuw9d_vq)Y znKx|vFBXdWkaNz_)-AYMGNnQ9zLj_f%C}~7N!N>u)Lf+CfEIdIU7czh$QbcAide4T zZQJy*?<2fUv(SP%PV21I_X1kz7G8vO5oI)0xCIvcYt6{A`!}bwQlGSad^&0sE+dig ztCN-J!D2iYgG*FJ2{BPzy1^u&y=FXDd67a8y7BGP|L)Sh_Z*1ci7meUFD~utdnA|k z%FkshXa7&|yHfQ-cZaL9*88w++@nx&uAPsEVL*=wVw{~gi>(snR7!xUfN3m@nIRqe z$bxi@pG5F$L=in`nIEOo82`J5h_9j*7~_4)pr(1ea&G+SOCoJiMKDK#1^!`Tmo zu(KAj$s(@Ez}~eSFWD$y#q zslU<&-b60sArh0MhfMd8Ut(rM_CQZ8FfKQivy3;fi)0|#R9eO4o~zDAw8`&mCJBRl zL+V<9>B#dX+=Ch6E=t$PUla#aJlOiq<<`$o@7t~|m@_8YX~f5JPr8|q*x0k}KKaw) zlj4s{p!Bb0(O2I@&cJP`BT4v(=^IBCC}>G;6Pl`dvTGO(u1uHZFzBch#Oi5#?{oUA zMDhff&?FU9`${$qfOt^aXNUDLXp}!L8o++(*YdqI@rZ`e_9q$WGiZtk%BdwBGNUQLOvKhbHU?bZL0ypyF6t66gl zm;}?$LvW7=cpykxJulrHg1_Tybvk9?!FUgQFW7)ZjiG5RKh5P)A-N+a_IR~*prd%Jub(3dwV#iE zEZRnitmR!zrZDwcFZbI$fi zpQ#2NyF^|ZZxhg}_2{p|uY5RbnD8K6ZJ*(Qw2)?}wekp&yaRA|Qo#DxsS?SeI+jqSMG)is9$_pX3e;QRCk`w z6Eyf}-+>ptnm-5fB$ja02cI*FiDNlWz6!au(Hs}CGqc@Mmic~|=QFFJrG1@1hjtXy z4~e%c+1cVu*QrSvt}^-J7&3CYOFA(;0v#pDtP1!!v4p;BvW*`n{US>q(dX{NUrV`ti>sUd7L3MP0-oP`aRTgYw5brGKhov{JH8&ZnR)OJ2X6Hj z*N%E-g5%w9Tu(o3p@Ox209&F)dqM|)8ypzq@>_T7)U{4lXM#FbS?FxaC!G^bZMM9+ z4tmuQbQP|}fWbv^^L6{ks3C9Ej)`TTPs7Rx%f;*+b8A$!FHS$N0rHb7YlE-;Os=Pr zQ{twGcgc=sfxFbo@AZ<0v(i)mIIN>SayZmhz4f%!>5C|cW!)L%h17s1v)z*m@qbN( zLIG`HP@`-xc!<{bo61SZlQWVZ1OuYl!Sb-gF-ru;V-o?-65R4%f%6Z;4dlCb<*tm4 zT`7ejX`!VvI;>13$7YHQz%+8p7l(Tpo$_JB4f^W={o?Bv;zK3iLCjqj{gvE5lo;fd zHH{q|VzJ(ecLFb~dW44K((lhkhDQ$2inQ@ZcRq7Y>-^*1b>gOVEt)4}ovdHpbt^K@ z|3sf`Dm|bJwcZkK{pP34+PPS-&Y(HzYpQh%%*U0(ohJ^qYv&SPhZse79v3M#nTUb? zTTjUjU*9&)0S1{kUx6pKuPYG_c~z}evFZy5xUz{>?k8wd2OGRLnS6!W@2E;KWyJGkUt&UFTh*2NVjj=kW%jj~V001z!4 z=ACav4hf=_2vC25z)FK{a-HCIF%1b@(>NH^N7$**yWUBYO61yA32R`g-kGrQqT2&s zZ1aW~`>zx~03Uhl@0bL?Vul+mpc)cp64nzfU1rpi*eG&?8WU7Xl4Pf1!!_iKpK_${ zC;xLY0h})InNl8x8hkL6Jpz7odsa%}^mCw|17HWPhf{dC+kQ}x((i~n?<}jL=p9a@ z<9^KPtHyuVYuBL`*B7H;P2iVO8ICwx_P&$c40y;=GC7R)u@F`J-|`;#me&bZ9#xFU zJg^Th!=rFfc{Bw+ujIxWBM>U0T(6i0?6X&W^QWn?a#<*foA?<)RQJ+am_wkw5~pN- z7sfTpB>PChT4dEn1d;2VMl0o-hg^bZeAQZSZ%fT*?fK_jkzO;p1^Kn_+yjstFP#ra zNvx;BrMYSMj?`B;0sS zFuJaW4L~Ou?IWxSIxyrDP0$laaSx}5DtUOzHO?=y^m2JYfcOG)&~ws}entE=bCT7$ z=#rYt?lU1eR^i}WaqU8Z0rKPflqR^`l!q|k(Zo+khOK+ubx;hXEPh&3dhXVaKhK_5 zEWuW;iN*%L+&b5&xM}Dl-pY8w8~S%KsSYAxoEeE0RatjS6)vupzw^Mi4zR4J9^a9vEO zGsL1|=&T;B!-Hc|XANCOT4+&_Am}oQeN;)!5I#Ng%dGfD89Z`xzBJfQ5Uq?0g3AeUS9@IhE|>w~}OV)8>HvkoV#COPN{LT#vk8 zt2Z)j@{a(~lW*kv*4-rOL6sffa^(OAYdJ-0AsgF9gwSQe2wH&X@4yh*TSHt#%TNt1(?*1p$1*$&WoXj%(3D- zcQ5QJ#PkYUg9UjMs?vZCI$TX&{X=JmqECeM2>uCx|CpLx$`!gYuDe(vVX}YRkFG^k zURe>tw{_d=^mg9nvS?KtpkI=2?(iG$tPXR5QosdvzxGoCt z$$I=Gfzpq+2F3?10L^~%hk|tHo!byiu28i+0-PzrVDKCekd-_eW}(>Fp}Ancc191J z%LV{ozGVXd7!U|yD)X?cRj`u12B#u~Q22#>5x;tCwV54R+A8Kzk+(poe&f<5a*v*K zT2oU&Cy_LPGej(sedjw!v3{YylrY}sxYF)>cfp<-T!xEu)CFu&YJe?D)I%N!%*L!8 zEi#ZVi4r-oMksMF`zOoUUiq(+KVL}Vgk4zs|M2{i%LBzJSShuf5=6EJK+gfbJ})q= zG0GhyJ>s|)s`}>jgj5{06DiB8;CT5#UeEFuCDRNU65yFEh+SOUYPR?{idoz^hcctc z&442k_wYk5d(L7ZTKmy)4^n0o##7c6!_jl_B86&KbNSP0;&tq_AS1DeI66n%PR*pX zi2%0k-ZNP@3`AaRb)vJ?W}XEv*Z1a+PPd6tY;c0IY-s0=Iw-*C*soU) zC=bBofdMQRHt;f`m;%bDO+Q@6&hS8dvdDDe(V_H-k2t&!J`FL&9w2#0bHLqd5+>n8)4e;ua%TPUO&4#d!TjvD`IHe+m+wqABkj zoNs5r+GI!s>cQZx77EF%7%V;lk~d43R$%h9**@|sc6SSR>J07Anld(@sT0nyR>Qu_ zPhkc@Fj;M*AKsf3%f|p*H1HyY%3g7T%cCKt?y8k0=-`j0laL`{!mVH11jZ{=3)Zbo z21^05#asw*jiv?Hew&@KV*;teNz-jz?UZ2y0k!l8DBW^9Rj~0!uD>Ft|27Lg;_|N} z*?vvL_xnuig>$EG@^@kLoJ?zdbt0stXU1YVLJO_W zCv!h-*}a>}{Q3SZv`DX6-2%p&B;T>R%A72KsxXP5VK54m2trhI`mBmx(#zV{ zInu6zS{==2l?XBO^i7UsOK?Fk{?ekyEXECjxn| ze`kRpJim|8Q}?3d(XG1>vcoX%zs<(_g-QWYTElLe@&5AL%%^F!{2#PFiop zRz~d(ix56>b@e=g)qGNk>2`{de6Q_WxRCIF*6yQFR#bxy#Qy{EQ~~2n-V>tkL{`UY z&0Rmmuj2DpeT)jObl<7A@des_b`d1V25nwoq~e9M<^f>hHSU>co8g(*{m}-YwofiI z-mkS=3Wl~O+8MFVW{YqX8E6K**_pPc`QNK@m~X8Hg&Kle5qX4L!dd6!IWdLU*Nlkc zGiH(n$H6or(h^BfuCPB&?kP`30z;2(u1 zR+FQfD9dIbldYlRvSLo87bRrF5U656yei7F$Z+uFv&!-!9(3wD{QY)By0oUJmuQ{- zU}FV=;Y7LSZ1uxnRdzVY10dxWlIkcKoJet_HxrwC@n~W6^hFyQekJ5|pV<4XQj zka1?kZLfD%g`ld(`_Jln6>AAWt9jnwML-$NI@O($<9KJ{W`C%l?Zl4-L0J7Mr!-?21u}Dy5k;D zu}!eeZ*3?R;L}9xDghYu?{zNJxF-U5o>7it>+~T~$v2ua{;7P)^J*yJ6~TT02(a@l_L<@JIZo3wOYJ9t9BNNUnvpIZ184_1fah;Vh@r1saB z^4y@`7jq3dxmVlsiow+%)C~5)FovY6v>3pvw$J%t@r@7cp&Ec@j$@T1u-i81-!`X5 z*u0~!^hDZq+7k7};*;b~0?h1x(q(|(>8OIVD1hr(THoGWk=iwDyIPzQf69sA=(J+o zn#EcLV}QPlry2xM(Oe*&QuTxz|DO({_ui&T9ig&XSsUK?V&dy)5>MGnr6uw&*J)SR z4O5d0C2t!+(VG{Y3fFU3G4!F~;z`0^Zy$VT zlJGjGSF&$3BUtfc03n5Fp1KQfb~InA&8`q*1q&GG=||Hzpy6L2H1f*;LpyQht{w?} zDZ2kUk>FaSr)>&iD|Z|7sH6U!z%}z@JhB~OedrN<`}Lfq^UV}Y43>cn?*zZ0AOM2< zpX5w(`QSQaEYTvqHz~=NXHUjQf0o%dBkQfeAN31lR&xxOEgYHTdZp%bVXN280=Ana z^M=FH$n=5rl?&BI)^08Qe_`>YwGkkoEIR+Kv^%~Pb0k^b?3|sA#qp8cs#eTueeM2Q zRw=0&M&6mX$~YF!Y0ZBc@63#c7`f!9BKSXd@Voc{RoLU+XN*d^;RK${8T?=LBS%Bk z&gkb&o-U3d6^w6h1+IPUz|;DW zIZ;96kdsD>Qv^q=09&hp0GpEni<1IR%gvP3v%OR9*{MuRTKWHZyIbuBt)Ci`cU_&% z1T+i^Y)o{%281-<3TpPAUTzw5v;RY=>1rvxmPl96#kYc9hX!6V^nB|ad#(S+)}?8C zr_H+lT3B#So$T=?$(w3-{rbQ4R<@nsf$}$hwSO)A$8&`(j+wQf=Jwhb0`CvhR5DCf z^OgI)KQemrUFPH+UynC$Y~QHG%DbTVh-Skz{enNU)cV_hPu~{TD7TPZl>0&K>iuE| z7AYn$7)Jrb9GE&SfQW4q&G*@N|4cHI`VakFa5-C!ov&XD)J(qp$rJJ*9e z-sHv}#g*T7Cv048d1v~BEAzM5FztAse#q78WWC^BUCzQ U&wLp6h6BX&boFyt=akR{0G%$)mH+?% literal 0 HcmV?d00001 diff --git a/docs/assets/images/widgets@2x.png b/docs/assets/images/widgets@2x.png new file mode 100644 index 0000000000000000000000000000000000000000..4bbbd57272f3b28f47527d4951ad10f950b8ad43 GIT binary patch literal 855 zcmeAS@N?(olHy`uVBq!ia0y~yU}^xe12~w0Jcmn z@(X6T|9^jgLcx21{)7exgY)a>N6m2F0<`Rqr;B4q1>>88jUdw-7W`c)zLE*mq8W2H z-<&Jl_Hco5BuC5n@AbF5GD82~-e8-v=#zCyUX0F-o}8pPfAv`!GN$ff+TL<~@kgt} z62eO?_|&+>xBmM$@p|z`tIKEdpPf8%qI>4r7@jn<=eta*{3~?g(zz{Ke9zc-G^gr? z-7foa?LcS!hmbwzru}ICvbWLlW8;+l-}!^=c32!^nV`+`C*;0-*Y%l94pC;Cb3GXz zzSf%a!{gVr{Y_lVuUj+a)*Ca+!-Hu%xmP&&X-2CuANY8^i{D7Kg6qzP zXz_ps9+lN8ESH{K4`yu&b~I>N9xGlE&;2u*b?+Go!AhN?m-bxlLvtC#MzDF2kFzfHJ1W7ybqdefSqVhbOykd*Yi%EDuhs z4wF{ft^bv2+DDnKb8gj1FuvcV`M}luS>lO<^)8x>y1#R;a=-ZKwWTQQb)ioBbi;zh zD!f5V)8581to1LL7c9!l^PSC$NBPYif!_vAZhmL4)v4U)4UsrLYiH_9rmQDd?)(e5 z^pcH>qvBg*i0dus2r*mp4;zKvu=P#s-ti;2obl`NjjwoYd>e(oo#j_uyRb<7Pv^If zzZ|mGHmV)8^tbO%^>eqMw(@7(&3g{jEp-Najo7V75xI_ZHK*FA`elF{r5}E*d7+j_R literal 0 HcmV?d00001 diff --git a/docs/assets/js/main.js b/docs/assets/js/main.js new file mode 100644 index 000000000..dc257a868 --- /dev/null +++ b/docs/assets/js/main.js @@ -0,0 +1,248 @@ +/* + * ATTENTION: The "eval" devtool has been used (maybe by default in mode: "development"). + * This devtool is not neither made for production nor for readable output files. + * It uses "eval()" calls to create a separate source file in the browser devtools. + * If you are trying to read the output file, select a different devtool (https://webpack.js.org/configuration/devtool/) + * or disable the default devtool with "devtool: false". + * If you are looking for production-ready output files, see mode: "production" (https://webpack.js.org/configuration/mode/). + */ +/******/ (() => { // webpackBootstrap +/******/ var __webpack_modules__ = ({ + +/***/ "../node_modules/lunr/lunr.js": +/*!************************************!*\ + !*** ../node_modules/lunr/lunr.js ***! + \************************************/ +/***/ ((module, exports, __webpack_require__) => { + +eval("var __WEBPACK_AMD_DEFINE_FACTORY__, __WEBPACK_AMD_DEFINE_RESULT__;/**\n * lunr - http://lunrjs.com - A bit like Solr, but much smaller and not as bright - 2.3.9\n * Copyright (C) 2020 Oliver Nightingale\n * @license MIT\n */\n\n;(function(){\n\n/**\n * A convenience function for configuring and constructing\n * a new lunr Index.\n *\n * A lunr.Builder instance is created and the pipeline setup\n * with a trimmer, stop word filter and stemmer.\n *\n * This builder object is yielded to the configuration function\n * that is passed as a parameter, allowing the list of fields\n * and other builder parameters to be customised.\n *\n * All documents _must_ be added within the passed config function.\n *\n * @example\n * var idx = lunr(function () {\n * this.field('title')\n * this.field('body')\n * this.ref('id')\n *\n * documents.forEach(function (doc) {\n * this.add(doc)\n * }, this)\n * })\n *\n * @see {@link lunr.Builder}\n * @see {@link lunr.Pipeline}\n * @see {@link lunr.trimmer}\n * @see {@link lunr.stopWordFilter}\n * @see {@link lunr.stemmer}\n * @namespace {function} lunr\n */\nvar lunr = function (config) {\n var builder = new lunr.Builder\n\n builder.pipeline.add(\n lunr.trimmer,\n lunr.stopWordFilter,\n lunr.stemmer\n )\n\n builder.searchPipeline.add(\n lunr.stemmer\n )\n\n config.call(builder, builder)\n return builder.build()\n}\n\nlunr.version = \"2.3.9\"\n/*!\n * lunr.utils\n * Copyright (C) 2020 Oliver Nightingale\n */\n\n/**\n * A namespace containing utils for the rest of the lunr library\n * @namespace lunr.utils\n */\nlunr.utils = {}\n\n/**\n * Print a warning message to the console.\n *\n * @param {String} message The message to be printed.\n * @memberOf lunr.utils\n * @function\n */\nlunr.utils.warn = (function (global) {\n /* eslint-disable no-console */\n return function (message) {\n if (global.console && console.warn) {\n console.warn(message)\n }\n }\n /* eslint-enable no-console */\n})(this)\n\n/**\n * Convert an object to a string.\n *\n * In the case of `null` and `undefined` the function returns\n * the empty string, in all other cases the result of calling\n * `toString` on the passed object is returned.\n *\n * @param {Any} obj The object to convert to a string.\n * @return {String} string representation of the passed object.\n * @memberOf lunr.utils\n */\nlunr.utils.asString = function (obj) {\n if (obj === void 0 || obj === null) {\n return \"\"\n } else {\n return obj.toString()\n }\n}\n\n/**\n * Clones an object.\n *\n * Will create a copy of an existing object such that any mutations\n * on the copy cannot affect the original.\n *\n * Only shallow objects are supported, passing a nested object to this\n * function will cause a TypeError.\n *\n * Objects with primitives, and arrays of primitives are supported.\n *\n * @param {Object} obj The object to clone.\n * @return {Object} a clone of the passed object.\n * @throws {TypeError} when a nested object is passed.\n * @memberOf Utils\n */\nlunr.utils.clone = function (obj) {\n if (obj === null || obj === undefined) {\n return obj\n }\n\n var clone = Object.create(null),\n keys = Object.keys(obj)\n\n for (var i = 0; i < keys.length; i++) {\n var key = keys[i],\n val = obj[key]\n\n if (Array.isArray(val)) {\n clone[key] = val.slice()\n continue\n }\n\n if (typeof val === 'string' ||\n typeof val === 'number' ||\n typeof val === 'boolean') {\n clone[key] = val\n continue\n }\n\n throw new TypeError(\"clone is not deep and does not support nested objects\")\n }\n\n return clone\n}\nlunr.FieldRef = function (docRef, fieldName, stringValue) {\n this.docRef = docRef\n this.fieldName = fieldName\n this._stringValue = stringValue\n}\n\nlunr.FieldRef.joiner = \"/\"\n\nlunr.FieldRef.fromString = function (s) {\n var n = s.indexOf(lunr.FieldRef.joiner)\n\n if (n === -1) {\n throw \"malformed field ref string\"\n }\n\n var fieldRef = s.slice(0, n),\n docRef = s.slice(n + 1)\n\n return new lunr.FieldRef (docRef, fieldRef, s)\n}\n\nlunr.FieldRef.prototype.toString = function () {\n if (this._stringValue == undefined) {\n this._stringValue = this.fieldName + lunr.FieldRef.joiner + this.docRef\n }\n\n return this._stringValue\n}\n/*!\n * lunr.Set\n * Copyright (C) 2020 Oliver Nightingale\n */\n\n/**\n * A lunr set.\n *\n * @constructor\n */\nlunr.Set = function (elements) {\n this.elements = Object.create(null)\n\n if (elements) {\n this.length = elements.length\n\n for (var i = 0; i < this.length; i++) {\n this.elements[elements[i]] = true\n }\n } else {\n this.length = 0\n }\n}\n\n/**\n * A complete set that contains all elements.\n *\n * @static\n * @readonly\n * @type {lunr.Set}\n */\nlunr.Set.complete = {\n intersect: function (other) {\n return other\n },\n\n union: function () {\n return this\n },\n\n contains: function () {\n return true\n }\n}\n\n/**\n * An empty set that contains no elements.\n *\n * @static\n * @readonly\n * @type {lunr.Set}\n */\nlunr.Set.empty = {\n intersect: function () {\n return this\n },\n\n union: function (other) {\n return other\n },\n\n contains: function () {\n return false\n }\n}\n\n/**\n * Returns true if this set contains the specified object.\n *\n * @param {object} object - Object whose presence in this set is to be tested.\n * @returns {boolean} - True if this set contains the specified object.\n */\nlunr.Set.prototype.contains = function (object) {\n return !!this.elements[object]\n}\n\n/**\n * Returns a new set containing only the elements that are present in both\n * this set and the specified set.\n *\n * @param {lunr.Set} other - set to intersect with this set.\n * @returns {lunr.Set} a new set that is the intersection of this and the specified set.\n */\n\nlunr.Set.prototype.intersect = function (other) {\n var a, b, elements, intersection = []\n\n if (other === lunr.Set.complete) {\n return this\n }\n\n if (other === lunr.Set.empty) {\n return other\n }\n\n if (this.length < other.length) {\n a = this\n b = other\n } else {\n a = other\n b = this\n }\n\n elements = Object.keys(a.elements)\n\n for (var i = 0; i < elements.length; i++) {\n var element = elements[i]\n if (element in b.elements) {\n intersection.push(element)\n }\n }\n\n return new lunr.Set (intersection)\n}\n\n/**\n * Returns a new set combining the elements of this and the specified set.\n *\n * @param {lunr.Set} other - set to union with this set.\n * @return {lunr.Set} a new set that is the union of this and the specified set.\n */\n\nlunr.Set.prototype.union = function (other) {\n if (other === lunr.Set.complete) {\n return lunr.Set.complete\n }\n\n if (other === lunr.Set.empty) {\n return this\n }\n\n return new lunr.Set(Object.keys(this.elements).concat(Object.keys(other.elements)))\n}\n/**\n * A function to calculate the inverse document frequency for\n * a posting. This is shared between the builder and the index\n *\n * @private\n * @param {object} posting - The posting for a given term\n * @param {number} documentCount - The total number of documents.\n */\nlunr.idf = function (posting, documentCount) {\n var documentsWithTerm = 0\n\n for (var fieldName in posting) {\n if (fieldName == '_index') continue // Ignore the term index, its not a field\n documentsWithTerm += Object.keys(posting[fieldName]).length\n }\n\n var x = (documentCount - documentsWithTerm + 0.5) / (documentsWithTerm + 0.5)\n\n return Math.log(1 + Math.abs(x))\n}\n\n/**\n * A token wraps a string representation of a token\n * as it is passed through the text processing pipeline.\n *\n * @constructor\n * @param {string} [str=''] - The string token being wrapped.\n * @param {object} [metadata={}] - Metadata associated with this token.\n */\nlunr.Token = function (str, metadata) {\n this.str = str || \"\"\n this.metadata = metadata || {}\n}\n\n/**\n * Returns the token string that is being wrapped by this object.\n *\n * @returns {string}\n */\nlunr.Token.prototype.toString = function () {\n return this.str\n}\n\n/**\n * A token update function is used when updating or optionally\n * when cloning a token.\n *\n * @callback lunr.Token~updateFunction\n * @param {string} str - The string representation of the token.\n * @param {Object} metadata - All metadata associated with this token.\n */\n\n/**\n * Applies the given function to the wrapped string token.\n *\n * @example\n * token.update(function (str, metadata) {\n * return str.toUpperCase()\n * })\n *\n * @param {lunr.Token~updateFunction} fn - A function to apply to the token string.\n * @returns {lunr.Token}\n */\nlunr.Token.prototype.update = function (fn) {\n this.str = fn(this.str, this.metadata)\n return this\n}\n\n/**\n * Creates a clone of this token. Optionally a function can be\n * applied to the cloned token.\n *\n * @param {lunr.Token~updateFunction} [fn] - An optional function to apply to the cloned token.\n * @returns {lunr.Token}\n */\nlunr.Token.prototype.clone = function (fn) {\n fn = fn || function (s) { return s }\n return new lunr.Token (fn(this.str, this.metadata), this.metadata)\n}\n/*!\n * lunr.tokenizer\n * Copyright (C) 2020 Oliver Nightingale\n */\n\n/**\n * A function for splitting a string into tokens ready to be inserted into\n * the search index. Uses `lunr.tokenizer.separator` to split strings, change\n * the value of this property to change how strings are split into tokens.\n *\n * This tokenizer will convert its parameter to a string by calling `toString` and\n * then will split this string on the character in `lunr.tokenizer.separator`.\n * Arrays will have their elements converted to strings and wrapped in a lunr.Token.\n *\n * Optional metadata can be passed to the tokenizer, this metadata will be cloned and\n * added as metadata to every token that is created from the object to be tokenized.\n *\n * @static\n * @param {?(string|object|object[])} obj - The object to convert into tokens\n * @param {?object} metadata - Optional metadata to associate with every token\n * @returns {lunr.Token[]}\n * @see {@link lunr.Pipeline}\n */\nlunr.tokenizer = function (obj, metadata) {\n if (obj == null || obj == undefined) {\n return []\n }\n\n if (Array.isArray(obj)) {\n return obj.map(function (t) {\n return new lunr.Token(\n lunr.utils.asString(t).toLowerCase(),\n lunr.utils.clone(metadata)\n )\n })\n }\n\n var str = obj.toString().toLowerCase(),\n len = str.length,\n tokens = []\n\n for (var sliceEnd = 0, sliceStart = 0; sliceEnd <= len; sliceEnd++) {\n var char = str.charAt(sliceEnd),\n sliceLength = sliceEnd - sliceStart\n\n if ((char.match(lunr.tokenizer.separator) || sliceEnd == len)) {\n\n if (sliceLength > 0) {\n var tokenMetadata = lunr.utils.clone(metadata) || {}\n tokenMetadata[\"position\"] = [sliceStart, sliceLength]\n tokenMetadata[\"index\"] = tokens.length\n\n tokens.push(\n new lunr.Token (\n str.slice(sliceStart, sliceEnd),\n tokenMetadata\n )\n )\n }\n\n sliceStart = sliceEnd + 1\n }\n\n }\n\n return tokens\n}\n\n/**\n * The separator used to split a string into tokens. Override this property to change the behaviour of\n * `lunr.tokenizer` behaviour when tokenizing strings. By default this splits on whitespace and hyphens.\n *\n * @static\n * @see lunr.tokenizer\n */\nlunr.tokenizer.separator = /[\\s\\-]+/\n/*!\n * lunr.Pipeline\n * Copyright (C) 2020 Oliver Nightingale\n */\n\n/**\n * lunr.Pipelines maintain an ordered list of functions to be applied to all\n * tokens in documents entering the search index and queries being ran against\n * the index.\n *\n * An instance of lunr.Index created with the lunr shortcut will contain a\n * pipeline with a stop word filter and an English language stemmer. Extra\n * functions can be added before or after either of these functions or these\n * default functions can be removed.\n *\n * When run the pipeline will call each function in turn, passing a token, the\n * index of that token in the original list of all tokens and finally a list of\n * all the original tokens.\n *\n * The output of functions in the pipeline will be passed to the next function\n * in the pipeline. To exclude a token from entering the index the function\n * should return undefined, the rest of the pipeline will not be called with\n * this token.\n *\n * For serialisation of pipelines to work, all functions used in an instance of\n * a pipeline should be registered with lunr.Pipeline. Registered functions can\n * then be loaded. If trying to load a serialised pipeline that uses functions\n * that are not registered an error will be thrown.\n *\n * If not planning on serialising the pipeline then registering pipeline functions\n * is not necessary.\n *\n * @constructor\n */\nlunr.Pipeline = function () {\n this._stack = []\n}\n\nlunr.Pipeline.registeredFunctions = Object.create(null)\n\n/**\n * A pipeline function maps lunr.Token to lunr.Token. A lunr.Token contains the token\n * string as well as all known metadata. A pipeline function can mutate the token string\n * or mutate (or add) metadata for a given token.\n *\n * A pipeline function can indicate that the passed token should be discarded by returning\n * null, undefined or an empty string. This token will not be passed to any downstream pipeline\n * functions and will not be added to the index.\n *\n * Multiple tokens can be returned by returning an array of tokens. Each token will be passed\n * to any downstream pipeline functions and all will returned tokens will be added to the index.\n *\n * Any number of pipeline functions may be chained together using a lunr.Pipeline.\n *\n * @interface lunr.PipelineFunction\n * @param {lunr.Token} token - A token from the document being processed.\n * @param {number} i - The index of this token in the complete list of tokens for this document/field.\n * @param {lunr.Token[]} tokens - All tokens for this document/field.\n * @returns {(?lunr.Token|lunr.Token[])}\n */\n\n/**\n * Register a function with the pipeline.\n *\n * Functions that are used in the pipeline should be registered if the pipeline\n * needs to be serialised, or a serialised pipeline needs to be loaded.\n *\n * Registering a function does not add it to a pipeline, functions must still be\n * added to instances of the pipeline for them to be used when running a pipeline.\n *\n * @param {lunr.PipelineFunction} fn - The function to check for.\n * @param {String} label - The label to register this function with\n */\nlunr.Pipeline.registerFunction = function (fn, label) {\n if (label in this.registeredFunctions) {\n lunr.utils.warn('Overwriting existing registered function: ' + label)\n }\n\n fn.label = label\n lunr.Pipeline.registeredFunctions[fn.label] = fn\n}\n\n/**\n * Warns if the function is not registered as a Pipeline function.\n *\n * @param {lunr.PipelineFunction} fn - The function to check for.\n * @private\n */\nlunr.Pipeline.warnIfFunctionNotRegistered = function (fn) {\n var isRegistered = fn.label && (fn.label in this.registeredFunctions)\n\n if (!isRegistered) {\n lunr.utils.warn('Function is not registered with pipeline. This may cause problems when serialising the index.\\n', fn)\n }\n}\n\n/**\n * Loads a previously serialised pipeline.\n *\n * All functions to be loaded must already be registered with lunr.Pipeline.\n * If any function from the serialised data has not been registered then an\n * error will be thrown.\n *\n * @param {Object} serialised - The serialised pipeline to load.\n * @returns {lunr.Pipeline}\n */\nlunr.Pipeline.load = function (serialised) {\n var pipeline = new lunr.Pipeline\n\n serialised.forEach(function (fnName) {\n var fn = lunr.Pipeline.registeredFunctions[fnName]\n\n if (fn) {\n pipeline.add(fn)\n } else {\n throw new Error('Cannot load unregistered function: ' + fnName)\n }\n })\n\n return pipeline\n}\n\n/**\n * Adds new functions to the end of the pipeline.\n *\n * Logs a warning if the function has not been registered.\n *\n * @param {lunr.PipelineFunction[]} functions - Any number of functions to add to the pipeline.\n */\nlunr.Pipeline.prototype.add = function () {\n var fns = Array.prototype.slice.call(arguments)\n\n fns.forEach(function (fn) {\n lunr.Pipeline.warnIfFunctionNotRegistered(fn)\n this._stack.push(fn)\n }, this)\n}\n\n/**\n * Adds a single function after a function that already exists in the\n * pipeline.\n *\n * Logs a warning if the function has not been registered.\n *\n * @param {lunr.PipelineFunction} existingFn - A function that already exists in the pipeline.\n * @param {lunr.PipelineFunction} newFn - The new function to add to the pipeline.\n */\nlunr.Pipeline.prototype.after = function (existingFn, newFn) {\n lunr.Pipeline.warnIfFunctionNotRegistered(newFn)\n\n var pos = this._stack.indexOf(existingFn)\n if (pos == -1) {\n throw new Error('Cannot find existingFn')\n }\n\n pos = pos + 1\n this._stack.splice(pos, 0, newFn)\n}\n\n/**\n * Adds a single function before a function that already exists in the\n * pipeline.\n *\n * Logs a warning if the function has not been registered.\n *\n * @param {lunr.PipelineFunction} existingFn - A function that already exists in the pipeline.\n * @param {lunr.PipelineFunction} newFn - The new function to add to the pipeline.\n */\nlunr.Pipeline.prototype.before = function (existingFn, newFn) {\n lunr.Pipeline.warnIfFunctionNotRegistered(newFn)\n\n var pos = this._stack.indexOf(existingFn)\n if (pos == -1) {\n throw new Error('Cannot find existingFn')\n }\n\n this._stack.splice(pos, 0, newFn)\n}\n\n/**\n * Removes a function from the pipeline.\n *\n * @param {lunr.PipelineFunction} fn The function to remove from the pipeline.\n */\nlunr.Pipeline.prototype.remove = function (fn) {\n var pos = this._stack.indexOf(fn)\n if (pos == -1) {\n return\n }\n\n this._stack.splice(pos, 1)\n}\n\n/**\n * Runs the current list of functions that make up the pipeline against the\n * passed tokens.\n *\n * @param {Array} tokens The tokens to run through the pipeline.\n * @returns {Array}\n */\nlunr.Pipeline.prototype.run = function (tokens) {\n var stackLength = this._stack.length\n\n for (var i = 0; i < stackLength; i++) {\n var fn = this._stack[i]\n var memo = []\n\n for (var j = 0; j < tokens.length; j++) {\n var result = fn(tokens[j], j, tokens)\n\n if (result === null || result === void 0 || result === '') continue\n\n if (Array.isArray(result)) {\n for (var k = 0; k < result.length; k++) {\n memo.push(result[k])\n }\n } else {\n memo.push(result)\n }\n }\n\n tokens = memo\n }\n\n return tokens\n}\n\n/**\n * Convenience method for passing a string through a pipeline and getting\n * strings out. This method takes care of wrapping the passed string in a\n * token and mapping the resulting tokens back to strings.\n *\n * @param {string} str - The string to pass through the pipeline.\n * @param {?object} metadata - Optional metadata to associate with the token\n * passed to the pipeline.\n * @returns {string[]}\n */\nlunr.Pipeline.prototype.runString = function (str, metadata) {\n var token = new lunr.Token (str, metadata)\n\n return this.run([token]).map(function (t) {\n return t.toString()\n })\n}\n\n/**\n * Resets the pipeline by removing any existing processors.\n *\n */\nlunr.Pipeline.prototype.reset = function () {\n this._stack = []\n}\n\n/**\n * Returns a representation of the pipeline ready for serialisation.\n *\n * Logs a warning if the function has not been registered.\n *\n * @returns {Array}\n */\nlunr.Pipeline.prototype.toJSON = function () {\n return this._stack.map(function (fn) {\n lunr.Pipeline.warnIfFunctionNotRegistered(fn)\n\n return fn.label\n })\n}\n/*!\n * lunr.Vector\n * Copyright (C) 2020 Oliver Nightingale\n */\n\n/**\n * A vector is used to construct the vector space of documents and queries. These\n * vectors support operations to determine the similarity between two documents or\n * a document and a query.\n *\n * Normally no parameters are required for initializing a vector, but in the case of\n * loading a previously dumped vector the raw elements can be provided to the constructor.\n *\n * For performance reasons vectors are implemented with a flat array, where an elements\n * index is immediately followed by its value. E.g. [index, value, index, value]. This\n * allows the underlying array to be as sparse as possible and still offer decent\n * performance when being used for vector calculations.\n *\n * @constructor\n * @param {Number[]} [elements] - The flat list of element index and element value pairs.\n */\nlunr.Vector = function (elements) {\n this._magnitude = 0\n this.elements = elements || []\n}\n\n\n/**\n * Calculates the position within the vector to insert a given index.\n *\n * This is used internally by insert and upsert. If there are duplicate indexes then\n * the position is returned as if the value for that index were to be updated, but it\n * is the callers responsibility to check whether there is a duplicate at that index\n *\n * @param {Number} insertIdx - The index at which the element should be inserted.\n * @returns {Number}\n */\nlunr.Vector.prototype.positionForIndex = function (index) {\n // For an empty vector the tuple can be inserted at the beginning\n if (this.elements.length == 0) {\n return 0\n }\n\n var start = 0,\n end = this.elements.length / 2,\n sliceLength = end - start,\n pivotPoint = Math.floor(sliceLength / 2),\n pivotIndex = this.elements[pivotPoint * 2]\n\n while (sliceLength > 1) {\n if (pivotIndex < index) {\n start = pivotPoint\n }\n\n if (pivotIndex > index) {\n end = pivotPoint\n }\n\n if (pivotIndex == index) {\n break\n }\n\n sliceLength = end - start\n pivotPoint = start + Math.floor(sliceLength / 2)\n pivotIndex = this.elements[pivotPoint * 2]\n }\n\n if (pivotIndex == index) {\n return pivotPoint * 2\n }\n\n if (pivotIndex > index) {\n return pivotPoint * 2\n }\n\n if (pivotIndex < index) {\n return (pivotPoint + 1) * 2\n }\n}\n\n/**\n * Inserts an element at an index within the vector.\n *\n * Does not allow duplicates, will throw an error if there is already an entry\n * for this index.\n *\n * @param {Number} insertIdx - The index at which the element should be inserted.\n * @param {Number} val - The value to be inserted into the vector.\n */\nlunr.Vector.prototype.insert = function (insertIdx, val) {\n this.upsert(insertIdx, val, function () {\n throw \"duplicate index\"\n })\n}\n\n/**\n * Inserts or updates an existing index within the vector.\n *\n * @param {Number} insertIdx - The index at which the element should be inserted.\n * @param {Number} val - The value to be inserted into the vector.\n * @param {function} fn - A function that is called for updates, the existing value and the\n * requested value are passed as arguments\n */\nlunr.Vector.prototype.upsert = function (insertIdx, val, fn) {\n this._magnitude = 0\n var position = this.positionForIndex(insertIdx)\n\n if (this.elements[position] == insertIdx) {\n this.elements[position + 1] = fn(this.elements[position + 1], val)\n } else {\n this.elements.splice(position, 0, insertIdx, val)\n }\n}\n\n/**\n * Calculates the magnitude of this vector.\n *\n * @returns {Number}\n */\nlunr.Vector.prototype.magnitude = function () {\n if (this._magnitude) return this._magnitude\n\n var sumOfSquares = 0,\n elementsLength = this.elements.length\n\n for (var i = 1; i < elementsLength; i += 2) {\n var val = this.elements[i]\n sumOfSquares += val * val\n }\n\n return this._magnitude = Math.sqrt(sumOfSquares)\n}\n\n/**\n * Calculates the dot product of this vector and another vector.\n *\n * @param {lunr.Vector} otherVector - The vector to compute the dot product with.\n * @returns {Number}\n */\nlunr.Vector.prototype.dot = function (otherVector) {\n var dotProduct = 0,\n a = this.elements, b = otherVector.elements,\n aLen = a.length, bLen = b.length,\n aVal = 0, bVal = 0,\n i = 0, j = 0\n\n while (i < aLen && j < bLen) {\n aVal = a[i], bVal = b[j]\n if (aVal < bVal) {\n i += 2\n } else if (aVal > bVal) {\n j += 2\n } else if (aVal == bVal) {\n dotProduct += a[i + 1] * b[j + 1]\n i += 2\n j += 2\n }\n }\n\n return dotProduct\n}\n\n/**\n * Calculates the similarity between this vector and another vector.\n *\n * @param {lunr.Vector} otherVector - The other vector to calculate the\n * similarity with.\n * @returns {Number}\n */\nlunr.Vector.prototype.similarity = function (otherVector) {\n return this.dot(otherVector) / this.magnitude() || 0\n}\n\n/**\n * Converts the vector to an array of the elements within the vector.\n *\n * @returns {Number[]}\n */\nlunr.Vector.prototype.toArray = function () {\n var output = new Array (this.elements.length / 2)\n\n for (var i = 1, j = 0; i < this.elements.length; i += 2, j++) {\n output[j] = this.elements[i]\n }\n\n return output\n}\n\n/**\n * A JSON serializable representation of the vector.\n *\n * @returns {Number[]}\n */\nlunr.Vector.prototype.toJSON = function () {\n return this.elements\n}\n/* eslint-disable */\n/*!\n * lunr.stemmer\n * Copyright (C) 2020 Oliver Nightingale\n * Includes code from - http://tartarus.org/~martin/PorterStemmer/js.txt\n */\n\n/**\n * lunr.stemmer is an english language stemmer, this is a JavaScript\n * implementation of the PorterStemmer taken from http://tartarus.org/~martin\n *\n * @static\n * @implements {lunr.PipelineFunction}\n * @param {lunr.Token} token - The string to stem\n * @returns {lunr.Token}\n * @see {@link lunr.Pipeline}\n * @function\n */\nlunr.stemmer = (function(){\n var step2list = {\n \"ational\" : \"ate\",\n \"tional\" : \"tion\",\n \"enci\" : \"ence\",\n \"anci\" : \"ance\",\n \"izer\" : \"ize\",\n \"bli\" : \"ble\",\n \"alli\" : \"al\",\n \"entli\" : \"ent\",\n \"eli\" : \"e\",\n \"ousli\" : \"ous\",\n \"ization\" : \"ize\",\n \"ation\" : \"ate\",\n \"ator\" : \"ate\",\n \"alism\" : \"al\",\n \"iveness\" : \"ive\",\n \"fulness\" : \"ful\",\n \"ousness\" : \"ous\",\n \"aliti\" : \"al\",\n \"iviti\" : \"ive\",\n \"biliti\" : \"ble\",\n \"logi\" : \"log\"\n },\n\n step3list = {\n \"icate\" : \"ic\",\n \"ative\" : \"\",\n \"alize\" : \"al\",\n \"iciti\" : \"ic\",\n \"ical\" : \"ic\",\n \"ful\" : \"\",\n \"ness\" : \"\"\n },\n\n c = \"[^aeiou]\", // consonant\n v = \"[aeiouy]\", // vowel\n C = c + \"[^aeiouy]*\", // consonant sequence\n V = v + \"[aeiou]*\", // vowel sequence\n\n mgr0 = \"^(\" + C + \")?\" + V + C, // [C]VC... is m>0\n meq1 = \"^(\" + C + \")?\" + V + C + \"(\" + V + \")?$\", // [C]VC[V] is m=1\n mgr1 = \"^(\" + C + \")?\" + V + C + V + C, // [C]VCVC... is m>1\n s_v = \"^(\" + C + \")?\" + v; // vowel in stem\n\n var re_mgr0 = new RegExp(mgr0);\n var re_mgr1 = new RegExp(mgr1);\n var re_meq1 = new RegExp(meq1);\n var re_s_v = new RegExp(s_v);\n\n var re_1a = /^(.+?)(ss|i)es$/;\n var re2_1a = /^(.+?)([^s])s$/;\n var re_1b = /^(.+?)eed$/;\n var re2_1b = /^(.+?)(ed|ing)$/;\n var re_1b_2 = /.$/;\n var re2_1b_2 = /(at|bl|iz)$/;\n var re3_1b_2 = new RegExp(\"([^aeiouylsz])\\\\1$\");\n var re4_1b_2 = new RegExp(\"^\" + C + v + \"[^aeiouwxy]$\");\n\n var re_1c = /^(.+?[^aeiou])y$/;\n var re_2 = /^(.+?)(ational|tional|enci|anci|izer|bli|alli|entli|eli|ousli|ization|ation|ator|alism|iveness|fulness|ousness|aliti|iviti|biliti|logi)$/;\n\n var re_3 = /^(.+?)(icate|ative|alize|iciti|ical|ful|ness)$/;\n\n var re_4 = /^(.+?)(al|ance|ence|er|ic|able|ible|ant|ement|ment|ent|ou|ism|ate|iti|ous|ive|ize)$/;\n var re2_4 = /^(.+?)(s|t)(ion)$/;\n\n var re_5 = /^(.+?)e$/;\n var re_5_1 = /ll$/;\n var re3_5 = new RegExp(\"^\" + C + v + \"[^aeiouwxy]$\");\n\n var porterStemmer = function porterStemmer(w) {\n var stem,\n suffix,\n firstch,\n re,\n re2,\n re3,\n re4;\n\n if (w.length < 3) { return w; }\n\n firstch = w.substr(0,1);\n if (firstch == \"y\") {\n w = firstch.toUpperCase() + w.substr(1);\n }\n\n // Step 1a\n re = re_1a\n re2 = re2_1a;\n\n if (re.test(w)) { w = w.replace(re,\"$1$2\"); }\n else if (re2.test(w)) { w = w.replace(re2,\"$1$2\"); }\n\n // Step 1b\n re = re_1b;\n re2 = re2_1b;\n if (re.test(w)) {\n var fp = re.exec(w);\n re = re_mgr0;\n if (re.test(fp[1])) {\n re = re_1b_2;\n w = w.replace(re,\"\");\n }\n } else if (re2.test(w)) {\n var fp = re2.exec(w);\n stem = fp[1];\n re2 = re_s_v;\n if (re2.test(stem)) {\n w = stem;\n re2 = re2_1b_2;\n re3 = re3_1b_2;\n re4 = re4_1b_2;\n if (re2.test(w)) { w = w + \"e\"; }\n else if (re3.test(w)) { re = re_1b_2; w = w.replace(re,\"\"); }\n else if (re4.test(w)) { w = w + \"e\"; }\n }\n }\n\n // Step 1c - replace suffix y or Y by i if preceded by a non-vowel which is not the first letter of the word (so cry -> cri, by -> by, say -> say)\n re = re_1c;\n if (re.test(w)) {\n var fp = re.exec(w);\n stem = fp[1];\n w = stem + \"i\";\n }\n\n // Step 2\n re = re_2;\n if (re.test(w)) {\n var fp = re.exec(w);\n stem = fp[1];\n suffix = fp[2];\n re = re_mgr0;\n if (re.test(stem)) {\n w = stem + step2list[suffix];\n }\n }\n\n // Step 3\n re = re_3;\n if (re.test(w)) {\n var fp = re.exec(w);\n stem = fp[1];\n suffix = fp[2];\n re = re_mgr0;\n if (re.test(stem)) {\n w = stem + step3list[suffix];\n }\n }\n\n // Step 4\n re = re_4;\n re2 = re2_4;\n if (re.test(w)) {\n var fp = re.exec(w);\n stem = fp[1];\n re = re_mgr1;\n if (re.test(stem)) {\n w = stem;\n }\n } else if (re2.test(w)) {\n var fp = re2.exec(w);\n stem = fp[1] + fp[2];\n re2 = re_mgr1;\n if (re2.test(stem)) {\n w = stem;\n }\n }\n\n // Step 5\n re = re_5;\n if (re.test(w)) {\n var fp = re.exec(w);\n stem = fp[1];\n re = re_mgr1;\n re2 = re_meq1;\n re3 = re3_5;\n if (re.test(stem) || (re2.test(stem) && !(re3.test(stem)))) {\n w = stem;\n }\n }\n\n re = re_5_1;\n re2 = re_mgr1;\n if (re.test(w) && re2.test(w)) {\n re = re_1b_2;\n w = w.replace(re,\"\");\n }\n\n // and turn initial Y back to y\n\n if (firstch == \"y\") {\n w = firstch.toLowerCase() + w.substr(1);\n }\n\n return w;\n };\n\n return function (token) {\n return token.update(porterStemmer);\n }\n})();\n\nlunr.Pipeline.registerFunction(lunr.stemmer, 'stemmer')\n/*!\n * lunr.stopWordFilter\n * Copyright (C) 2020 Oliver Nightingale\n */\n\n/**\n * lunr.generateStopWordFilter builds a stopWordFilter function from the provided\n * list of stop words.\n *\n * The built in lunr.stopWordFilter is built using this generator and can be used\n * to generate custom stopWordFilters for applications or non English languages.\n *\n * @function\n * @param {Array} token The token to pass through the filter\n * @returns {lunr.PipelineFunction}\n * @see lunr.Pipeline\n * @see lunr.stopWordFilter\n */\nlunr.generateStopWordFilter = function (stopWords) {\n var words = stopWords.reduce(function (memo, stopWord) {\n memo[stopWord] = stopWord\n return memo\n }, {})\n\n return function (token) {\n if (token && words[token.toString()] !== token.toString()) return token\n }\n}\n\n/**\n * lunr.stopWordFilter is an English language stop word list filter, any words\n * contained in the list will not be passed through the filter.\n *\n * This is intended to be used in the Pipeline. If the token does not pass the\n * filter then undefined will be returned.\n *\n * @function\n * @implements {lunr.PipelineFunction}\n * @params {lunr.Token} token - A token to check for being a stop word.\n * @returns {lunr.Token}\n * @see {@link lunr.Pipeline}\n */\nlunr.stopWordFilter = lunr.generateStopWordFilter([\n 'a',\n 'able',\n 'about',\n 'across',\n 'after',\n 'all',\n 'almost',\n 'also',\n 'am',\n 'among',\n 'an',\n 'and',\n 'any',\n 'are',\n 'as',\n 'at',\n 'be',\n 'because',\n 'been',\n 'but',\n 'by',\n 'can',\n 'cannot',\n 'could',\n 'dear',\n 'did',\n 'do',\n 'does',\n 'either',\n 'else',\n 'ever',\n 'every',\n 'for',\n 'from',\n 'get',\n 'got',\n 'had',\n 'has',\n 'have',\n 'he',\n 'her',\n 'hers',\n 'him',\n 'his',\n 'how',\n 'however',\n 'i',\n 'if',\n 'in',\n 'into',\n 'is',\n 'it',\n 'its',\n 'just',\n 'least',\n 'let',\n 'like',\n 'likely',\n 'may',\n 'me',\n 'might',\n 'most',\n 'must',\n 'my',\n 'neither',\n 'no',\n 'nor',\n 'not',\n 'of',\n 'off',\n 'often',\n 'on',\n 'only',\n 'or',\n 'other',\n 'our',\n 'own',\n 'rather',\n 'said',\n 'say',\n 'says',\n 'she',\n 'should',\n 'since',\n 'so',\n 'some',\n 'than',\n 'that',\n 'the',\n 'their',\n 'them',\n 'then',\n 'there',\n 'these',\n 'they',\n 'this',\n 'tis',\n 'to',\n 'too',\n 'twas',\n 'us',\n 'wants',\n 'was',\n 'we',\n 'were',\n 'what',\n 'when',\n 'where',\n 'which',\n 'while',\n 'who',\n 'whom',\n 'why',\n 'will',\n 'with',\n 'would',\n 'yet',\n 'you',\n 'your'\n])\n\nlunr.Pipeline.registerFunction(lunr.stopWordFilter, 'stopWordFilter')\n/*!\n * lunr.trimmer\n * Copyright (C) 2020 Oliver Nightingale\n */\n\n/**\n * lunr.trimmer is a pipeline function for trimming non word\n * characters from the beginning and end of tokens before they\n * enter the index.\n *\n * This implementation may not work correctly for non latin\n * characters and should either be removed or adapted for use\n * with languages with non-latin characters.\n *\n * @static\n * @implements {lunr.PipelineFunction}\n * @param {lunr.Token} token The token to pass through the filter\n * @returns {lunr.Token}\n * @see lunr.Pipeline\n */\nlunr.trimmer = function (token) {\n return token.update(function (s) {\n return s.replace(/^\\W+/, '').replace(/\\W+$/, '')\n })\n}\n\nlunr.Pipeline.registerFunction(lunr.trimmer, 'trimmer')\n/*!\n * lunr.TokenSet\n * Copyright (C) 2020 Oliver Nightingale\n */\n\n/**\n * A token set is used to store the unique list of all tokens\n * within an index. Token sets are also used to represent an\n * incoming query to the index, this query token set and index\n * token set are then intersected to find which tokens to look\n * up in the inverted index.\n *\n * A token set can hold multiple tokens, as in the case of the\n * index token set, or it can hold a single token as in the\n * case of a simple query token set.\n *\n * Additionally token sets are used to perform wildcard matching.\n * Leading, contained and trailing wildcards are supported, and\n * from this edit distance matching can also be provided.\n *\n * Token sets are implemented as a minimal finite state automata,\n * where both common prefixes and suffixes are shared between tokens.\n * This helps to reduce the space used for storing the token set.\n *\n * @constructor\n */\nlunr.TokenSet = function () {\n this.final = false\n this.edges = {}\n this.id = lunr.TokenSet._nextId\n lunr.TokenSet._nextId += 1\n}\n\n/**\n * Keeps track of the next, auto increment, identifier to assign\n * to a new tokenSet.\n *\n * TokenSets require a unique identifier to be correctly minimised.\n *\n * @private\n */\nlunr.TokenSet._nextId = 1\n\n/**\n * Creates a TokenSet instance from the given sorted array of words.\n *\n * @param {String[]} arr - A sorted array of strings to create the set from.\n * @returns {lunr.TokenSet}\n * @throws Will throw an error if the input array is not sorted.\n */\nlunr.TokenSet.fromArray = function (arr) {\n var builder = new lunr.TokenSet.Builder\n\n for (var i = 0, len = arr.length; i < len; i++) {\n builder.insert(arr[i])\n }\n\n builder.finish()\n return builder.root\n}\n\n/**\n * Creates a token set from a query clause.\n *\n * @private\n * @param {Object} clause - A single clause from lunr.Query.\n * @param {string} clause.term - The query clause term.\n * @param {number} [clause.editDistance] - The optional edit distance for the term.\n * @returns {lunr.TokenSet}\n */\nlunr.TokenSet.fromClause = function (clause) {\n if ('editDistance' in clause) {\n return lunr.TokenSet.fromFuzzyString(clause.term, clause.editDistance)\n } else {\n return lunr.TokenSet.fromString(clause.term)\n }\n}\n\n/**\n * Creates a token set representing a single string with a specified\n * edit distance.\n *\n * Insertions, deletions, substitutions and transpositions are each\n * treated as an edit distance of 1.\n *\n * Increasing the allowed edit distance will have a dramatic impact\n * on the performance of both creating and intersecting these TokenSets.\n * It is advised to keep the edit distance less than 3.\n *\n * @param {string} str - The string to create the token set from.\n * @param {number} editDistance - The allowed edit distance to match.\n * @returns {lunr.Vector}\n */\nlunr.TokenSet.fromFuzzyString = function (str, editDistance) {\n var root = new lunr.TokenSet\n\n var stack = [{\n node: root,\n editsRemaining: editDistance,\n str: str\n }]\n\n while (stack.length) {\n var frame = stack.pop()\n\n // no edit\n if (frame.str.length > 0) {\n var char = frame.str.charAt(0),\n noEditNode\n\n if (char in frame.node.edges) {\n noEditNode = frame.node.edges[char]\n } else {\n noEditNode = new lunr.TokenSet\n frame.node.edges[char] = noEditNode\n }\n\n if (frame.str.length == 1) {\n noEditNode.final = true\n }\n\n stack.push({\n node: noEditNode,\n editsRemaining: frame.editsRemaining,\n str: frame.str.slice(1)\n })\n }\n\n if (frame.editsRemaining == 0) {\n continue\n }\n\n // insertion\n if (\"*\" in frame.node.edges) {\n var insertionNode = frame.node.edges[\"*\"]\n } else {\n var insertionNode = new lunr.TokenSet\n frame.node.edges[\"*\"] = insertionNode\n }\n\n if (frame.str.length == 0) {\n insertionNode.final = true\n }\n\n stack.push({\n node: insertionNode,\n editsRemaining: frame.editsRemaining - 1,\n str: frame.str\n })\n\n // deletion\n // can only do a deletion if we have enough edits remaining\n // and if there are characters left to delete in the string\n if (frame.str.length > 1) {\n stack.push({\n node: frame.node,\n editsRemaining: frame.editsRemaining - 1,\n str: frame.str.slice(1)\n })\n }\n\n // deletion\n // just removing the last character from the str\n if (frame.str.length == 1) {\n frame.node.final = true\n }\n\n // substitution\n // can only do a substitution if we have enough edits remaining\n // and if there are characters left to substitute\n if (frame.str.length >= 1) {\n if (\"*\" in frame.node.edges) {\n var substitutionNode = frame.node.edges[\"*\"]\n } else {\n var substitutionNode = new lunr.TokenSet\n frame.node.edges[\"*\"] = substitutionNode\n }\n\n if (frame.str.length == 1) {\n substitutionNode.final = true\n }\n\n stack.push({\n node: substitutionNode,\n editsRemaining: frame.editsRemaining - 1,\n str: frame.str.slice(1)\n })\n }\n\n // transposition\n // can only do a transposition if there are edits remaining\n // and there are enough characters to transpose\n if (frame.str.length > 1) {\n var charA = frame.str.charAt(0),\n charB = frame.str.charAt(1),\n transposeNode\n\n if (charB in frame.node.edges) {\n transposeNode = frame.node.edges[charB]\n } else {\n transposeNode = new lunr.TokenSet\n frame.node.edges[charB] = transposeNode\n }\n\n if (frame.str.length == 1) {\n transposeNode.final = true\n }\n\n stack.push({\n node: transposeNode,\n editsRemaining: frame.editsRemaining - 1,\n str: charA + frame.str.slice(2)\n })\n }\n }\n\n return root\n}\n\n/**\n * Creates a TokenSet from a string.\n *\n * The string may contain one or more wildcard characters (*)\n * that will allow wildcard matching when intersecting with\n * another TokenSet.\n *\n * @param {string} str - The string to create a TokenSet from.\n * @returns {lunr.TokenSet}\n */\nlunr.TokenSet.fromString = function (str) {\n var node = new lunr.TokenSet,\n root = node\n\n /*\n * Iterates through all characters within the passed string\n * appending a node for each character.\n *\n * When a wildcard character is found then a self\n * referencing edge is introduced to continually match\n * any number of any characters.\n */\n for (var i = 0, len = str.length; i < len; i++) {\n var char = str[i],\n final = (i == len - 1)\n\n if (char == \"*\") {\n node.edges[char] = node\n node.final = final\n\n } else {\n var next = new lunr.TokenSet\n next.final = final\n\n node.edges[char] = next\n node = next\n }\n }\n\n return root\n}\n\n/**\n * Converts this TokenSet into an array of strings\n * contained within the TokenSet.\n *\n * This is not intended to be used on a TokenSet that\n * contains wildcards, in these cases the results are\n * undefined and are likely to cause an infinite loop.\n *\n * @returns {string[]}\n */\nlunr.TokenSet.prototype.toArray = function () {\n var words = []\n\n var stack = [{\n prefix: \"\",\n node: this\n }]\n\n while (stack.length) {\n var frame = stack.pop(),\n edges = Object.keys(frame.node.edges),\n len = edges.length\n\n if (frame.node.final) {\n /* In Safari, at this point the prefix is sometimes corrupted, see:\n * https://github.com/olivernn/lunr.js/issues/279 Calling any\n * String.prototype method forces Safari to \"cast\" this string to what\n * it's supposed to be, fixing the bug. */\n frame.prefix.charAt(0)\n words.push(frame.prefix)\n }\n\n for (var i = 0; i < len; i++) {\n var edge = edges[i]\n\n stack.push({\n prefix: frame.prefix.concat(edge),\n node: frame.node.edges[edge]\n })\n }\n }\n\n return words\n}\n\n/**\n * Generates a string representation of a TokenSet.\n *\n * This is intended to allow TokenSets to be used as keys\n * in objects, largely to aid the construction and minimisation\n * of a TokenSet. As such it is not designed to be a human\n * friendly representation of the TokenSet.\n *\n * @returns {string}\n */\nlunr.TokenSet.prototype.toString = function () {\n // NOTE: Using Object.keys here as this.edges is very likely\n // to enter 'hash-mode' with many keys being added\n //\n // avoiding a for-in loop here as it leads to the function\n // being de-optimised (at least in V8). From some simple\n // benchmarks the performance is comparable, but allowing\n // V8 to optimize may mean easy performance wins in the future.\n\n if (this._str) {\n return this._str\n }\n\n var str = this.final ? '1' : '0',\n labels = Object.keys(this.edges).sort(),\n len = labels.length\n\n for (var i = 0; i < len; i++) {\n var label = labels[i],\n node = this.edges[label]\n\n str = str + label + node.id\n }\n\n return str\n}\n\n/**\n * Returns a new TokenSet that is the intersection of\n * this TokenSet and the passed TokenSet.\n *\n * This intersection will take into account any wildcards\n * contained within the TokenSet.\n *\n * @param {lunr.TokenSet} b - An other TokenSet to intersect with.\n * @returns {lunr.TokenSet}\n */\nlunr.TokenSet.prototype.intersect = function (b) {\n var output = new lunr.TokenSet,\n frame = undefined\n\n var stack = [{\n qNode: b,\n output: output,\n node: this\n }]\n\n while (stack.length) {\n frame = stack.pop()\n\n // NOTE: As with the #toString method, we are using\n // Object.keys and a for loop instead of a for-in loop\n // as both of these objects enter 'hash' mode, causing\n // the function to be de-optimised in V8\n var qEdges = Object.keys(frame.qNode.edges),\n qLen = qEdges.length,\n nEdges = Object.keys(frame.node.edges),\n nLen = nEdges.length\n\n for (var q = 0; q < qLen; q++) {\n var qEdge = qEdges[q]\n\n for (var n = 0; n < nLen; n++) {\n var nEdge = nEdges[n]\n\n if (nEdge == qEdge || qEdge == '*') {\n var node = frame.node.edges[nEdge],\n qNode = frame.qNode.edges[qEdge],\n final = node.final && qNode.final,\n next = undefined\n\n if (nEdge in frame.output.edges) {\n // an edge already exists for this character\n // no need to create a new node, just set the finality\n // bit unless this node is already final\n next = frame.output.edges[nEdge]\n next.final = next.final || final\n\n } else {\n // no edge exists yet, must create one\n // set the finality bit and insert it\n // into the output\n next = new lunr.TokenSet\n next.final = final\n frame.output.edges[nEdge] = next\n }\n\n stack.push({\n qNode: qNode,\n output: next,\n node: node\n })\n }\n }\n }\n }\n\n return output\n}\nlunr.TokenSet.Builder = function () {\n this.previousWord = \"\"\n this.root = new lunr.TokenSet\n this.uncheckedNodes = []\n this.minimizedNodes = {}\n}\n\nlunr.TokenSet.Builder.prototype.insert = function (word) {\n var node,\n commonPrefix = 0\n\n if (word < this.previousWord) {\n throw new Error (\"Out of order word insertion\")\n }\n\n for (var i = 0; i < word.length && i < this.previousWord.length; i++) {\n if (word[i] != this.previousWord[i]) break\n commonPrefix++\n }\n\n this.minimize(commonPrefix)\n\n if (this.uncheckedNodes.length == 0) {\n node = this.root\n } else {\n node = this.uncheckedNodes[this.uncheckedNodes.length - 1].child\n }\n\n for (var i = commonPrefix; i < word.length; i++) {\n var nextNode = new lunr.TokenSet,\n char = word[i]\n\n node.edges[char] = nextNode\n\n this.uncheckedNodes.push({\n parent: node,\n char: char,\n child: nextNode\n })\n\n node = nextNode\n }\n\n node.final = true\n this.previousWord = word\n}\n\nlunr.TokenSet.Builder.prototype.finish = function () {\n this.minimize(0)\n}\n\nlunr.TokenSet.Builder.prototype.minimize = function (downTo) {\n for (var i = this.uncheckedNodes.length - 1; i >= downTo; i--) {\n var node = this.uncheckedNodes[i],\n childKey = node.child.toString()\n\n if (childKey in this.minimizedNodes) {\n node.parent.edges[node.char] = this.minimizedNodes[childKey]\n } else {\n // Cache the key for this node since\n // we know it can't change anymore\n node.child._str = childKey\n\n this.minimizedNodes[childKey] = node.child\n }\n\n this.uncheckedNodes.pop()\n }\n}\n/*!\n * lunr.Index\n * Copyright (C) 2020 Oliver Nightingale\n */\n\n/**\n * An index contains the built index of all documents and provides a query interface\n * to the index.\n *\n * Usually instances of lunr.Index will not be created using this constructor, instead\n * lunr.Builder should be used to construct new indexes, or lunr.Index.load should be\n * used to load previously built and serialized indexes.\n *\n * @constructor\n * @param {Object} attrs - The attributes of the built search index.\n * @param {Object} attrs.invertedIndex - An index of term/field to document reference.\n * @param {Object} attrs.fieldVectors - Field vectors\n * @param {lunr.TokenSet} attrs.tokenSet - An set of all corpus tokens.\n * @param {string[]} attrs.fields - The names of indexed document fields.\n * @param {lunr.Pipeline} attrs.pipeline - The pipeline to use for search terms.\n */\nlunr.Index = function (attrs) {\n this.invertedIndex = attrs.invertedIndex\n this.fieldVectors = attrs.fieldVectors\n this.tokenSet = attrs.tokenSet\n this.fields = attrs.fields\n this.pipeline = attrs.pipeline\n}\n\n/**\n * A result contains details of a document matching a search query.\n * @typedef {Object} lunr.Index~Result\n * @property {string} ref - The reference of the document this result represents.\n * @property {number} score - A number between 0 and 1 representing how similar this document is to the query.\n * @property {lunr.MatchData} matchData - Contains metadata about this match including which term(s) caused the match.\n */\n\n/**\n * Although lunr provides the ability to create queries using lunr.Query, it also provides a simple\n * query language which itself is parsed into an instance of lunr.Query.\n *\n * For programmatically building queries it is advised to directly use lunr.Query, the query language\n * is best used for human entered text rather than program generated text.\n *\n * At its simplest queries can just be a single term, e.g. `hello`, multiple terms are also supported\n * and will be combined with OR, e.g `hello world` will match documents that contain either 'hello'\n * or 'world', though those that contain both will rank higher in the results.\n *\n * Wildcards can be included in terms to match one or more unspecified characters, these wildcards can\n * be inserted anywhere within the term, and more than one wildcard can exist in a single term. Adding\n * wildcards will increase the number of documents that will be found but can also have a negative\n * impact on query performance, especially with wildcards at the beginning of a term.\n *\n * Terms can be restricted to specific fields, e.g. `title:hello`, only documents with the term\n * hello in the title field will match this query. Using a field not present in the index will lead\n * to an error being thrown.\n *\n * Modifiers can also be added to terms, lunr supports edit distance and boost modifiers on terms. A term\n * boost will make documents matching that term score higher, e.g. `foo^5`. Edit distance is also supported\n * to provide fuzzy matching, e.g. 'hello~2' will match documents with hello with an edit distance of 2.\n * Avoid large values for edit distance to improve query performance.\n *\n * Each term also supports a presence modifier. By default a term's presence in document is optional, however\n * this can be changed to either required or prohibited. For a term's presence to be required in a document the\n * term should be prefixed with a '+', e.g. `+foo bar` is a search for documents that must contain 'foo' and\n * optionally contain 'bar'. Conversely a leading '-' sets the terms presence to prohibited, i.e. it must not\n * appear in a document, e.g. `-foo bar` is a search for documents that do not contain 'foo' but may contain 'bar'.\n *\n * To escape special characters the backslash character '\\' can be used, this allows searches to include\n * characters that would normally be considered modifiers, e.g. `foo\\~2` will search for a term \"foo~2\" instead\n * of attempting to apply a boost of 2 to the search term \"foo\".\n *\n * @typedef {string} lunr.Index~QueryString\n * @example Simple single term query\n * hello\n * @example Multiple term query\n * hello world\n * @example term scoped to a field\n * title:hello\n * @example term with a boost of 10\n * hello^10\n * @example term with an edit distance of 2\n * hello~2\n * @example terms with presence modifiers\n * -foo +bar baz\n */\n\n/**\n * Performs a search against the index using lunr query syntax.\n *\n * Results will be returned sorted by their score, the most relevant results\n * will be returned first. For details on how the score is calculated, please see\n * the {@link https://lunrjs.com/guides/searching.html#scoring|guide}.\n *\n * For more programmatic querying use lunr.Index#query.\n *\n * @param {lunr.Index~QueryString} queryString - A string containing a lunr query.\n * @throws {lunr.QueryParseError} If the passed query string cannot be parsed.\n * @returns {lunr.Index~Result[]}\n */\nlunr.Index.prototype.search = function (queryString) {\n return this.query(function (query) {\n var parser = new lunr.QueryParser(queryString, query)\n parser.parse()\n })\n}\n\n/**\n * A query builder callback provides a query object to be used to express\n * the query to perform on the index.\n *\n * @callback lunr.Index~queryBuilder\n * @param {lunr.Query} query - The query object to build up.\n * @this lunr.Query\n */\n\n/**\n * Performs a query against the index using the yielded lunr.Query object.\n *\n * If performing programmatic queries against the index, this method is preferred\n * over lunr.Index#search so as to avoid the additional query parsing overhead.\n *\n * A query object is yielded to the supplied function which should be used to\n * express the query to be run against the index.\n *\n * Note that although this function takes a callback parameter it is _not_ an\n * asynchronous operation, the callback is just yielded a query object to be\n * customized.\n *\n * @param {lunr.Index~queryBuilder} fn - A function that is used to build the query.\n * @returns {lunr.Index~Result[]}\n */\nlunr.Index.prototype.query = function (fn) {\n // for each query clause\n // * process terms\n // * expand terms from token set\n // * find matching documents and metadata\n // * get document vectors\n // * score documents\n\n var query = new lunr.Query(this.fields),\n matchingFields = Object.create(null),\n queryVectors = Object.create(null),\n termFieldCache = Object.create(null),\n requiredMatches = Object.create(null),\n prohibitedMatches = Object.create(null)\n\n /*\n * To support field level boosts a query vector is created per\n * field. An empty vector is eagerly created to support negated\n * queries.\n */\n for (var i = 0; i < this.fields.length; i++) {\n queryVectors[this.fields[i]] = new lunr.Vector\n }\n\n fn.call(query, query)\n\n for (var i = 0; i < query.clauses.length; i++) {\n /*\n * Unless the pipeline has been disabled for this term, which is\n * the case for terms with wildcards, we need to pass the clause\n * term through the search pipeline. A pipeline returns an array\n * of processed terms. Pipeline functions may expand the passed\n * term, which means we may end up performing multiple index lookups\n * for a single query term.\n */\n var clause = query.clauses[i],\n terms = null,\n clauseMatches = lunr.Set.empty\n\n if (clause.usePipeline) {\n terms = this.pipeline.runString(clause.term, {\n fields: clause.fields\n })\n } else {\n terms = [clause.term]\n }\n\n for (var m = 0; m < terms.length; m++) {\n var term = terms[m]\n\n /*\n * Each term returned from the pipeline needs to use the same query\n * clause object, e.g. the same boost and or edit distance. The\n * simplest way to do this is to re-use the clause object but mutate\n * its term property.\n */\n clause.term = term\n\n /*\n * From the term in the clause we create a token set which will then\n * be used to intersect the indexes token set to get a list of terms\n * to lookup in the inverted index\n */\n var termTokenSet = lunr.TokenSet.fromClause(clause),\n expandedTerms = this.tokenSet.intersect(termTokenSet).toArray()\n\n /*\n * If a term marked as required does not exist in the tokenSet it is\n * impossible for the search to return any matches. We set all the field\n * scoped required matches set to empty and stop examining any further\n * clauses.\n */\n if (expandedTerms.length === 0 && clause.presence === lunr.Query.presence.REQUIRED) {\n for (var k = 0; k < clause.fields.length; k++) {\n var field = clause.fields[k]\n requiredMatches[field] = lunr.Set.empty\n }\n\n break\n }\n\n for (var j = 0; j < expandedTerms.length; j++) {\n /*\n * For each term get the posting and termIndex, this is required for\n * building the query vector.\n */\n var expandedTerm = expandedTerms[j],\n posting = this.invertedIndex[expandedTerm],\n termIndex = posting._index\n\n for (var k = 0; k < clause.fields.length; k++) {\n /*\n * For each field that this query term is scoped by (by default\n * all fields are in scope) we need to get all the document refs\n * that have this term in that field.\n *\n * The posting is the entry in the invertedIndex for the matching\n * term from above.\n */\n var field = clause.fields[k],\n fieldPosting = posting[field],\n matchingDocumentRefs = Object.keys(fieldPosting),\n termField = expandedTerm + \"/\" + field,\n matchingDocumentsSet = new lunr.Set(matchingDocumentRefs)\n\n /*\n * if the presence of this term is required ensure that the matching\n * documents are added to the set of required matches for this clause.\n *\n */\n if (clause.presence == lunr.Query.presence.REQUIRED) {\n clauseMatches = clauseMatches.union(matchingDocumentsSet)\n\n if (requiredMatches[field] === undefined) {\n requiredMatches[field] = lunr.Set.complete\n }\n }\n\n /*\n * if the presence of this term is prohibited ensure that the matching\n * documents are added to the set of prohibited matches for this field,\n * creating that set if it does not yet exist.\n */\n if (clause.presence == lunr.Query.presence.PROHIBITED) {\n if (prohibitedMatches[field] === undefined) {\n prohibitedMatches[field] = lunr.Set.empty\n }\n\n prohibitedMatches[field] = prohibitedMatches[field].union(matchingDocumentsSet)\n\n /*\n * Prohibited matches should not be part of the query vector used for\n * similarity scoring and no metadata should be extracted so we continue\n * to the next field\n */\n continue\n }\n\n /*\n * The query field vector is populated using the termIndex found for\n * the term and a unit value with the appropriate boost applied.\n * Using upsert because there could already be an entry in the vector\n * for the term we are working with. In that case we just add the scores\n * together.\n */\n queryVectors[field].upsert(termIndex, clause.boost, function (a, b) { return a + b })\n\n /**\n * If we've already seen this term, field combo then we've already collected\n * the matching documents and metadata, no need to go through all that again\n */\n if (termFieldCache[termField]) {\n continue\n }\n\n for (var l = 0; l < matchingDocumentRefs.length; l++) {\n /*\n * All metadata for this term/field/document triple\n * are then extracted and collected into an instance\n * of lunr.MatchData ready to be returned in the query\n * results\n */\n var matchingDocumentRef = matchingDocumentRefs[l],\n matchingFieldRef = new lunr.FieldRef (matchingDocumentRef, field),\n metadata = fieldPosting[matchingDocumentRef],\n fieldMatch\n\n if ((fieldMatch = matchingFields[matchingFieldRef]) === undefined) {\n matchingFields[matchingFieldRef] = new lunr.MatchData (expandedTerm, field, metadata)\n } else {\n fieldMatch.add(expandedTerm, field, metadata)\n }\n\n }\n\n termFieldCache[termField] = true\n }\n }\n }\n\n /**\n * If the presence was required we need to update the requiredMatches field sets.\n * We do this after all fields for the term have collected their matches because\n * the clause terms presence is required in _any_ of the fields not _all_ of the\n * fields.\n */\n if (clause.presence === lunr.Query.presence.REQUIRED) {\n for (var k = 0; k < clause.fields.length; k++) {\n var field = clause.fields[k]\n requiredMatches[field] = requiredMatches[field].intersect(clauseMatches)\n }\n }\n }\n\n /**\n * Need to combine the field scoped required and prohibited\n * matching documents into a global set of required and prohibited\n * matches\n */\n var allRequiredMatches = lunr.Set.complete,\n allProhibitedMatches = lunr.Set.empty\n\n for (var i = 0; i < this.fields.length; i++) {\n var field = this.fields[i]\n\n if (requiredMatches[field]) {\n allRequiredMatches = allRequiredMatches.intersect(requiredMatches[field])\n }\n\n if (prohibitedMatches[field]) {\n allProhibitedMatches = allProhibitedMatches.union(prohibitedMatches[field])\n }\n }\n\n var matchingFieldRefs = Object.keys(matchingFields),\n results = [],\n matches = Object.create(null)\n\n /*\n * If the query is negated (contains only prohibited terms)\n * we need to get _all_ fieldRefs currently existing in the\n * index. This is only done when we know that the query is\n * entirely prohibited terms to avoid any cost of getting all\n * fieldRefs unnecessarily.\n *\n * Additionally, blank MatchData must be created to correctly\n * populate the results.\n */\n if (query.isNegated()) {\n matchingFieldRefs = Object.keys(this.fieldVectors)\n\n for (var i = 0; i < matchingFieldRefs.length; i++) {\n var matchingFieldRef = matchingFieldRefs[i]\n var fieldRef = lunr.FieldRef.fromString(matchingFieldRef)\n matchingFields[matchingFieldRef] = new lunr.MatchData\n }\n }\n\n for (var i = 0; i < matchingFieldRefs.length; i++) {\n /*\n * Currently we have document fields that match the query, but we\n * need to return documents. The matchData and scores are combined\n * from multiple fields belonging to the same document.\n *\n * Scores are calculated by field, using the query vectors created\n * above, and combined into a final document score using addition.\n */\n var fieldRef = lunr.FieldRef.fromString(matchingFieldRefs[i]),\n docRef = fieldRef.docRef\n\n if (!allRequiredMatches.contains(docRef)) {\n continue\n }\n\n if (allProhibitedMatches.contains(docRef)) {\n continue\n }\n\n var fieldVector = this.fieldVectors[fieldRef],\n score = queryVectors[fieldRef.fieldName].similarity(fieldVector),\n docMatch\n\n if ((docMatch = matches[docRef]) !== undefined) {\n docMatch.score += score\n docMatch.matchData.combine(matchingFields[fieldRef])\n } else {\n var match = {\n ref: docRef,\n score: score,\n matchData: matchingFields[fieldRef]\n }\n matches[docRef] = match\n results.push(match)\n }\n }\n\n /*\n * Sort the results objects by score, highest first.\n */\n return results.sort(function (a, b) {\n return b.score - a.score\n })\n}\n\n/**\n * Prepares the index for JSON serialization.\n *\n * The schema for this JSON blob will be described in a\n * separate JSON schema file.\n *\n * @returns {Object}\n */\nlunr.Index.prototype.toJSON = function () {\n var invertedIndex = Object.keys(this.invertedIndex)\n .sort()\n .map(function (term) {\n return [term, this.invertedIndex[term]]\n }, this)\n\n var fieldVectors = Object.keys(this.fieldVectors)\n .map(function (ref) {\n return [ref, this.fieldVectors[ref].toJSON()]\n }, this)\n\n return {\n version: lunr.version,\n fields: this.fields,\n fieldVectors: fieldVectors,\n invertedIndex: invertedIndex,\n pipeline: this.pipeline.toJSON()\n }\n}\n\n/**\n * Loads a previously serialized lunr.Index\n *\n * @param {Object} serializedIndex - A previously serialized lunr.Index\n * @returns {lunr.Index}\n */\nlunr.Index.load = function (serializedIndex) {\n var attrs = {},\n fieldVectors = {},\n serializedVectors = serializedIndex.fieldVectors,\n invertedIndex = Object.create(null),\n serializedInvertedIndex = serializedIndex.invertedIndex,\n tokenSetBuilder = new lunr.TokenSet.Builder,\n pipeline = lunr.Pipeline.load(serializedIndex.pipeline)\n\n if (serializedIndex.version != lunr.version) {\n lunr.utils.warn(\"Version mismatch when loading serialised index. Current version of lunr '\" + lunr.version + \"' does not match serialized index '\" + serializedIndex.version + \"'\")\n }\n\n for (var i = 0; i < serializedVectors.length; i++) {\n var tuple = serializedVectors[i],\n ref = tuple[0],\n elements = tuple[1]\n\n fieldVectors[ref] = new lunr.Vector(elements)\n }\n\n for (var i = 0; i < serializedInvertedIndex.length; i++) {\n var tuple = serializedInvertedIndex[i],\n term = tuple[0],\n posting = tuple[1]\n\n tokenSetBuilder.insert(term)\n invertedIndex[term] = posting\n }\n\n tokenSetBuilder.finish()\n\n attrs.fields = serializedIndex.fields\n\n attrs.fieldVectors = fieldVectors\n attrs.invertedIndex = invertedIndex\n attrs.tokenSet = tokenSetBuilder.root\n attrs.pipeline = pipeline\n\n return new lunr.Index(attrs)\n}\n/*!\n * lunr.Builder\n * Copyright (C) 2020 Oliver Nightingale\n */\n\n/**\n * lunr.Builder performs indexing on a set of documents and\n * returns instances of lunr.Index ready for querying.\n *\n * All configuration of the index is done via the builder, the\n * fields to index, the document reference, the text processing\n * pipeline and document scoring parameters are all set on the\n * builder before indexing.\n *\n * @constructor\n * @property {string} _ref - Internal reference to the document reference field.\n * @property {string[]} _fields - Internal reference to the document fields to index.\n * @property {object} invertedIndex - The inverted index maps terms to document fields.\n * @property {object} documentTermFrequencies - Keeps track of document term frequencies.\n * @property {object} documentLengths - Keeps track of the length of documents added to the index.\n * @property {lunr.tokenizer} tokenizer - Function for splitting strings into tokens for indexing.\n * @property {lunr.Pipeline} pipeline - The pipeline performs text processing on tokens before indexing.\n * @property {lunr.Pipeline} searchPipeline - A pipeline for processing search terms before querying the index.\n * @property {number} documentCount - Keeps track of the total number of documents indexed.\n * @property {number} _b - A parameter to control field length normalization, setting this to 0 disabled normalization, 1 fully normalizes field lengths, the default value is 0.75.\n * @property {number} _k1 - A parameter to control how quickly an increase in term frequency results in term frequency saturation, the default value is 1.2.\n * @property {number} termIndex - A counter incremented for each unique term, used to identify a terms position in the vector space.\n * @property {array} metadataWhitelist - A list of metadata keys that have been whitelisted for entry in the index.\n */\nlunr.Builder = function () {\n this._ref = \"id\"\n this._fields = Object.create(null)\n this._documents = Object.create(null)\n this.invertedIndex = Object.create(null)\n this.fieldTermFrequencies = {}\n this.fieldLengths = {}\n this.tokenizer = lunr.tokenizer\n this.pipeline = new lunr.Pipeline\n this.searchPipeline = new lunr.Pipeline\n this.documentCount = 0\n this._b = 0.75\n this._k1 = 1.2\n this.termIndex = 0\n this.metadataWhitelist = []\n}\n\n/**\n * Sets the document field used as the document reference. Every document must have this field.\n * The type of this field in the document should be a string, if it is not a string it will be\n * coerced into a string by calling toString.\n *\n * The default ref is 'id'.\n *\n * The ref should _not_ be changed during indexing, it should be set before any documents are\n * added to the index. Changing it during indexing can lead to inconsistent results.\n *\n * @param {string} ref - The name of the reference field in the document.\n */\nlunr.Builder.prototype.ref = function (ref) {\n this._ref = ref\n}\n\n/**\n * A function that is used to extract a field from a document.\n *\n * Lunr expects a field to be at the top level of a document, if however the field\n * is deeply nested within a document an extractor function can be used to extract\n * the right field for indexing.\n *\n * @callback fieldExtractor\n * @param {object} doc - The document being added to the index.\n * @returns {?(string|object|object[])} obj - The object that will be indexed for this field.\n * @example Extracting a nested field\n * function (doc) { return doc.nested.field }\n */\n\n/**\n * Adds a field to the list of document fields that will be indexed. Every document being\n * indexed should have this field. Null values for this field in indexed documents will\n * not cause errors but will limit the chance of that document being retrieved by searches.\n *\n * All fields should be added before adding documents to the index. Adding fields after\n * a document has been indexed will have no effect on already indexed documents.\n *\n * Fields can be boosted at build time. This allows terms within that field to have more\n * importance when ranking search results. Use a field boost to specify that matches within\n * one field are more important than other fields.\n *\n * @param {string} fieldName - The name of a field to index in all documents.\n * @param {object} attributes - Optional attributes associated with this field.\n * @param {number} [attributes.boost=1] - Boost applied to all terms within this field.\n * @param {fieldExtractor} [attributes.extractor] - Function to extract a field from a document.\n * @throws {RangeError} fieldName cannot contain unsupported characters '/'\n */\nlunr.Builder.prototype.field = function (fieldName, attributes) {\n if (/\\//.test(fieldName)) {\n throw new RangeError (\"Field '\" + fieldName + \"' contains illegal character '/'\")\n }\n\n this._fields[fieldName] = attributes || {}\n}\n\n/**\n * A parameter to tune the amount of field length normalisation that is applied when\n * calculating relevance scores. A value of 0 will completely disable any normalisation\n * and a value of 1 will fully normalise field lengths. The default is 0.75. Values of b\n * will be clamped to the range 0 - 1.\n *\n * @param {number} number - The value to set for this tuning parameter.\n */\nlunr.Builder.prototype.b = function (number) {\n if (number < 0) {\n this._b = 0\n } else if (number > 1) {\n this._b = 1\n } else {\n this._b = number\n }\n}\n\n/**\n * A parameter that controls the speed at which a rise in term frequency results in term\n * frequency saturation. The default value is 1.2. Setting this to a higher value will give\n * slower saturation levels, a lower value will result in quicker saturation.\n *\n * @param {number} number - The value to set for this tuning parameter.\n */\nlunr.Builder.prototype.k1 = function (number) {\n this._k1 = number\n}\n\n/**\n * Adds a document to the index.\n *\n * Before adding fields to the index the index should have been fully setup, with the document\n * ref and all fields to index already having been specified.\n *\n * The document must have a field name as specified by the ref (by default this is 'id') and\n * it should have all fields defined for indexing, though null or undefined values will not\n * cause errors.\n *\n * Entire documents can be boosted at build time. Applying a boost to a document indicates that\n * this document should rank higher in search results than other documents.\n *\n * @param {object} doc - The document to add to the index.\n * @param {object} attributes - Optional attributes associated with this document.\n * @param {number} [attributes.boost=1] - Boost applied to all terms within this document.\n */\nlunr.Builder.prototype.add = function (doc, attributes) {\n var docRef = doc[this._ref],\n fields = Object.keys(this._fields)\n\n this._documents[docRef] = attributes || {}\n this.documentCount += 1\n\n for (var i = 0; i < fields.length; i++) {\n var fieldName = fields[i],\n extractor = this._fields[fieldName].extractor,\n field = extractor ? extractor(doc) : doc[fieldName],\n tokens = this.tokenizer(field, {\n fields: [fieldName]\n }),\n terms = this.pipeline.run(tokens),\n fieldRef = new lunr.FieldRef (docRef, fieldName),\n fieldTerms = Object.create(null)\n\n this.fieldTermFrequencies[fieldRef] = fieldTerms\n this.fieldLengths[fieldRef] = 0\n\n // store the length of this field for this document\n this.fieldLengths[fieldRef] += terms.length\n\n // calculate term frequencies for this field\n for (var j = 0; j < terms.length; j++) {\n var term = terms[j]\n\n if (fieldTerms[term] == undefined) {\n fieldTerms[term] = 0\n }\n\n fieldTerms[term] += 1\n\n // add to inverted index\n // create an initial posting if one doesn't exist\n if (this.invertedIndex[term] == undefined) {\n var posting = Object.create(null)\n posting[\"_index\"] = this.termIndex\n this.termIndex += 1\n\n for (var k = 0; k < fields.length; k++) {\n posting[fields[k]] = Object.create(null)\n }\n\n this.invertedIndex[term] = posting\n }\n\n // add an entry for this term/fieldName/docRef to the invertedIndex\n if (this.invertedIndex[term][fieldName][docRef] == undefined) {\n this.invertedIndex[term][fieldName][docRef] = Object.create(null)\n }\n\n // store all whitelisted metadata about this token in the\n // inverted index\n for (var l = 0; l < this.metadataWhitelist.length; l++) {\n var metadataKey = this.metadataWhitelist[l],\n metadata = term.metadata[metadataKey]\n\n if (this.invertedIndex[term][fieldName][docRef][metadataKey] == undefined) {\n this.invertedIndex[term][fieldName][docRef][metadataKey] = []\n }\n\n this.invertedIndex[term][fieldName][docRef][metadataKey].push(metadata)\n }\n }\n\n }\n}\n\n/**\n * Calculates the average document length for this index\n *\n * @private\n */\nlunr.Builder.prototype.calculateAverageFieldLengths = function () {\n\n var fieldRefs = Object.keys(this.fieldLengths),\n numberOfFields = fieldRefs.length,\n accumulator = {},\n documentsWithField = {}\n\n for (var i = 0; i < numberOfFields; i++) {\n var fieldRef = lunr.FieldRef.fromString(fieldRefs[i]),\n field = fieldRef.fieldName\n\n documentsWithField[field] || (documentsWithField[field] = 0)\n documentsWithField[field] += 1\n\n accumulator[field] || (accumulator[field] = 0)\n accumulator[field] += this.fieldLengths[fieldRef]\n }\n\n var fields = Object.keys(this._fields)\n\n for (var i = 0; i < fields.length; i++) {\n var fieldName = fields[i]\n accumulator[fieldName] = accumulator[fieldName] / documentsWithField[fieldName]\n }\n\n this.averageFieldLength = accumulator\n}\n\n/**\n * Builds a vector space model of every document using lunr.Vector\n *\n * @private\n */\nlunr.Builder.prototype.createFieldVectors = function () {\n var fieldVectors = {},\n fieldRefs = Object.keys(this.fieldTermFrequencies),\n fieldRefsLength = fieldRefs.length,\n termIdfCache = Object.create(null)\n\n for (var i = 0; i < fieldRefsLength; i++) {\n var fieldRef = lunr.FieldRef.fromString(fieldRefs[i]),\n fieldName = fieldRef.fieldName,\n fieldLength = this.fieldLengths[fieldRef],\n fieldVector = new lunr.Vector,\n termFrequencies = this.fieldTermFrequencies[fieldRef],\n terms = Object.keys(termFrequencies),\n termsLength = terms.length\n\n\n var fieldBoost = this._fields[fieldName].boost || 1,\n docBoost = this._documents[fieldRef.docRef].boost || 1\n\n for (var j = 0; j < termsLength; j++) {\n var term = terms[j],\n tf = termFrequencies[term],\n termIndex = this.invertedIndex[term]._index,\n idf, score, scoreWithPrecision\n\n if (termIdfCache[term] === undefined) {\n idf = lunr.idf(this.invertedIndex[term], this.documentCount)\n termIdfCache[term] = idf\n } else {\n idf = termIdfCache[term]\n }\n\n score = idf * ((this._k1 + 1) * tf) / (this._k1 * (1 - this._b + this._b * (fieldLength / this.averageFieldLength[fieldName])) + tf)\n score *= fieldBoost\n score *= docBoost\n scoreWithPrecision = Math.round(score * 1000) / 1000\n // Converts 1.23456789 to 1.234.\n // Reducing the precision so that the vectors take up less\n // space when serialised. Doing it now so that they behave\n // the same before and after serialisation. Also, this is\n // the fastest approach to reducing a number's precision in\n // JavaScript.\n\n fieldVector.insert(termIndex, scoreWithPrecision)\n }\n\n fieldVectors[fieldRef] = fieldVector\n }\n\n this.fieldVectors = fieldVectors\n}\n\n/**\n * Creates a token set of all tokens in the index using lunr.TokenSet\n *\n * @private\n */\nlunr.Builder.prototype.createTokenSet = function () {\n this.tokenSet = lunr.TokenSet.fromArray(\n Object.keys(this.invertedIndex).sort()\n )\n}\n\n/**\n * Builds the index, creating an instance of lunr.Index.\n *\n * This completes the indexing process and should only be called\n * once all documents have been added to the index.\n *\n * @returns {lunr.Index}\n */\nlunr.Builder.prototype.build = function () {\n this.calculateAverageFieldLengths()\n this.createFieldVectors()\n this.createTokenSet()\n\n return new lunr.Index({\n invertedIndex: this.invertedIndex,\n fieldVectors: this.fieldVectors,\n tokenSet: this.tokenSet,\n fields: Object.keys(this._fields),\n pipeline: this.searchPipeline\n })\n}\n\n/**\n * Applies a plugin to the index builder.\n *\n * A plugin is a function that is called with the index builder as its context.\n * Plugins can be used to customise or extend the behaviour of the index\n * in some way. A plugin is just a function, that encapsulated the custom\n * behaviour that should be applied when building the index.\n *\n * The plugin function will be called with the index builder as its argument, additional\n * arguments can also be passed when calling use. The function will be called\n * with the index builder as its context.\n *\n * @param {Function} plugin The plugin to apply.\n */\nlunr.Builder.prototype.use = function (fn) {\n var args = Array.prototype.slice.call(arguments, 1)\n args.unshift(this)\n fn.apply(this, args)\n}\n/**\n * Contains and collects metadata about a matching document.\n * A single instance of lunr.MatchData is returned as part of every\n * lunr.Index~Result.\n *\n * @constructor\n * @param {string} term - The term this match data is associated with\n * @param {string} field - The field in which the term was found\n * @param {object} metadata - The metadata recorded about this term in this field\n * @property {object} metadata - A cloned collection of metadata associated with this document.\n * @see {@link lunr.Index~Result}\n */\nlunr.MatchData = function (term, field, metadata) {\n var clonedMetadata = Object.create(null),\n metadataKeys = Object.keys(metadata || {})\n\n // Cloning the metadata to prevent the original\n // being mutated during match data combination.\n // Metadata is kept in an array within the inverted\n // index so cloning the data can be done with\n // Array#slice\n for (var i = 0; i < metadataKeys.length; i++) {\n var key = metadataKeys[i]\n clonedMetadata[key] = metadata[key].slice()\n }\n\n this.metadata = Object.create(null)\n\n if (term !== undefined) {\n this.metadata[term] = Object.create(null)\n this.metadata[term][field] = clonedMetadata\n }\n}\n\n/**\n * An instance of lunr.MatchData will be created for every term that matches a\n * document. However only one instance is required in a lunr.Index~Result. This\n * method combines metadata from another instance of lunr.MatchData with this\n * objects metadata.\n *\n * @param {lunr.MatchData} otherMatchData - Another instance of match data to merge with this one.\n * @see {@link lunr.Index~Result}\n */\nlunr.MatchData.prototype.combine = function (otherMatchData) {\n var terms = Object.keys(otherMatchData.metadata)\n\n for (var i = 0; i < terms.length; i++) {\n var term = terms[i],\n fields = Object.keys(otherMatchData.metadata[term])\n\n if (this.metadata[term] == undefined) {\n this.metadata[term] = Object.create(null)\n }\n\n for (var j = 0; j < fields.length; j++) {\n var field = fields[j],\n keys = Object.keys(otherMatchData.metadata[term][field])\n\n if (this.metadata[term][field] == undefined) {\n this.metadata[term][field] = Object.create(null)\n }\n\n for (var k = 0; k < keys.length; k++) {\n var key = keys[k]\n\n if (this.metadata[term][field][key] == undefined) {\n this.metadata[term][field][key] = otherMatchData.metadata[term][field][key]\n } else {\n this.metadata[term][field][key] = this.metadata[term][field][key].concat(otherMatchData.metadata[term][field][key])\n }\n\n }\n }\n }\n}\n\n/**\n * Add metadata for a term/field pair to this instance of match data.\n *\n * @param {string} term - The term this match data is associated with\n * @param {string} field - The field in which the term was found\n * @param {object} metadata - The metadata recorded about this term in this field\n */\nlunr.MatchData.prototype.add = function (term, field, metadata) {\n if (!(term in this.metadata)) {\n this.metadata[term] = Object.create(null)\n this.metadata[term][field] = metadata\n return\n }\n\n if (!(field in this.metadata[term])) {\n this.metadata[term][field] = metadata\n return\n }\n\n var metadataKeys = Object.keys(metadata)\n\n for (var i = 0; i < metadataKeys.length; i++) {\n var key = metadataKeys[i]\n\n if (key in this.metadata[term][field]) {\n this.metadata[term][field][key] = this.metadata[term][field][key].concat(metadata[key])\n } else {\n this.metadata[term][field][key] = metadata[key]\n }\n }\n}\n/**\n * A lunr.Query provides a programmatic way of defining queries to be performed\n * against a {@link lunr.Index}.\n *\n * Prefer constructing a lunr.Query using the {@link lunr.Index#query} method\n * so the query object is pre-initialized with the right index fields.\n *\n * @constructor\n * @property {lunr.Query~Clause[]} clauses - An array of query clauses.\n * @property {string[]} allFields - An array of all available fields in a lunr.Index.\n */\nlunr.Query = function (allFields) {\n this.clauses = []\n this.allFields = allFields\n}\n\n/**\n * Constants for indicating what kind of automatic wildcard insertion will be used when constructing a query clause.\n *\n * This allows wildcards to be added to the beginning and end of a term without having to manually do any string\n * concatenation.\n *\n * The wildcard constants can be bitwise combined to select both leading and trailing wildcards.\n *\n * @constant\n * @default\n * @property {number} wildcard.NONE - The term will have no wildcards inserted, this is the default behaviour\n * @property {number} wildcard.LEADING - Prepend the term with a wildcard, unless a leading wildcard already exists\n * @property {number} wildcard.TRAILING - Append a wildcard to the term, unless a trailing wildcard already exists\n * @see lunr.Query~Clause\n * @see lunr.Query#clause\n * @see lunr.Query#term\n * @example query term with trailing wildcard\n * query.term('foo', { wildcard: lunr.Query.wildcard.TRAILING })\n * @example query term with leading and trailing wildcard\n * query.term('foo', {\n * wildcard: lunr.Query.wildcard.LEADING | lunr.Query.wildcard.TRAILING\n * })\n */\n\nlunr.Query.wildcard = new String (\"*\")\nlunr.Query.wildcard.NONE = 0\nlunr.Query.wildcard.LEADING = 1\nlunr.Query.wildcard.TRAILING = 2\n\n/**\n * Constants for indicating what kind of presence a term must have in matching documents.\n *\n * @constant\n * @enum {number}\n * @see lunr.Query~Clause\n * @see lunr.Query#clause\n * @see lunr.Query#term\n * @example query term with required presence\n * query.term('foo', { presence: lunr.Query.presence.REQUIRED })\n */\nlunr.Query.presence = {\n /**\n * Term's presence in a document is optional, this is the default value.\n */\n OPTIONAL: 1,\n\n /**\n * Term's presence in a document is required, documents that do not contain\n * this term will not be returned.\n */\n REQUIRED: 2,\n\n /**\n * Term's presence in a document is prohibited, documents that do contain\n * this term will not be returned.\n */\n PROHIBITED: 3\n}\n\n/**\n * A single clause in a {@link lunr.Query} contains a term and details on how to\n * match that term against a {@link lunr.Index}.\n *\n * @typedef {Object} lunr.Query~Clause\n * @property {string[]} fields - The fields in an index this clause should be matched against.\n * @property {number} [boost=1] - Any boost that should be applied when matching this clause.\n * @property {number} [editDistance] - Whether the term should have fuzzy matching applied, and how fuzzy the match should be.\n * @property {boolean} [usePipeline] - Whether the term should be passed through the search pipeline.\n * @property {number} [wildcard=lunr.Query.wildcard.NONE] - Whether the term should have wildcards appended or prepended.\n * @property {number} [presence=lunr.Query.presence.OPTIONAL] - The terms presence in any matching documents.\n */\n\n/**\n * Adds a {@link lunr.Query~Clause} to this query.\n *\n * Unless the clause contains the fields to be matched all fields will be matched. In addition\n * a default boost of 1 is applied to the clause.\n *\n * @param {lunr.Query~Clause} clause - The clause to add to this query.\n * @see lunr.Query~Clause\n * @returns {lunr.Query}\n */\nlunr.Query.prototype.clause = function (clause) {\n if (!('fields' in clause)) {\n clause.fields = this.allFields\n }\n\n if (!('boost' in clause)) {\n clause.boost = 1\n }\n\n if (!('usePipeline' in clause)) {\n clause.usePipeline = true\n }\n\n if (!('wildcard' in clause)) {\n clause.wildcard = lunr.Query.wildcard.NONE\n }\n\n if ((clause.wildcard & lunr.Query.wildcard.LEADING) && (clause.term.charAt(0) != lunr.Query.wildcard)) {\n clause.term = \"*\" + clause.term\n }\n\n if ((clause.wildcard & lunr.Query.wildcard.TRAILING) && (clause.term.slice(-1) != lunr.Query.wildcard)) {\n clause.term = \"\" + clause.term + \"*\"\n }\n\n if (!('presence' in clause)) {\n clause.presence = lunr.Query.presence.OPTIONAL\n }\n\n this.clauses.push(clause)\n\n return this\n}\n\n/**\n * A negated query is one in which every clause has a presence of\n * prohibited. These queries require some special processing to return\n * the expected results.\n *\n * @returns boolean\n */\nlunr.Query.prototype.isNegated = function () {\n for (var i = 0; i < this.clauses.length; i++) {\n if (this.clauses[i].presence != lunr.Query.presence.PROHIBITED) {\n return false\n }\n }\n\n return true\n}\n\n/**\n * Adds a term to the current query, under the covers this will create a {@link lunr.Query~Clause}\n * to the list of clauses that make up this query.\n *\n * The term is used as is, i.e. no tokenization will be performed by this method. Instead conversion\n * to a token or token-like string should be done before calling this method.\n *\n * The term will be converted to a string by calling `toString`. Multiple terms can be passed as an\n * array, each term in the array will share the same options.\n *\n * @param {object|object[]} term - The term(s) to add to the query.\n * @param {object} [options] - Any additional properties to add to the query clause.\n * @returns {lunr.Query}\n * @see lunr.Query#clause\n * @see lunr.Query~Clause\n * @example adding a single term to a query\n * query.term(\"foo\")\n * @example adding a single term to a query and specifying search fields, term boost and automatic trailing wildcard\n * query.term(\"foo\", {\n * fields: [\"title\"],\n * boost: 10,\n * wildcard: lunr.Query.wildcard.TRAILING\n * })\n * @example using lunr.tokenizer to convert a string to tokens before using them as terms\n * query.term(lunr.tokenizer(\"foo bar\"))\n */\nlunr.Query.prototype.term = function (term, options) {\n if (Array.isArray(term)) {\n term.forEach(function (t) { this.term(t, lunr.utils.clone(options)) }, this)\n return this\n }\n\n var clause = options || {}\n clause.term = term.toString()\n\n this.clause(clause)\n\n return this\n}\nlunr.QueryParseError = function (message, start, end) {\n this.name = \"QueryParseError\"\n this.message = message\n this.start = start\n this.end = end\n}\n\nlunr.QueryParseError.prototype = new Error\nlunr.QueryLexer = function (str) {\n this.lexemes = []\n this.str = str\n this.length = str.length\n this.pos = 0\n this.start = 0\n this.escapeCharPositions = []\n}\n\nlunr.QueryLexer.prototype.run = function () {\n var state = lunr.QueryLexer.lexText\n\n while (state) {\n state = state(this)\n }\n}\n\nlunr.QueryLexer.prototype.sliceString = function () {\n var subSlices = [],\n sliceStart = this.start,\n sliceEnd = this.pos\n\n for (var i = 0; i < this.escapeCharPositions.length; i++) {\n sliceEnd = this.escapeCharPositions[i]\n subSlices.push(this.str.slice(sliceStart, sliceEnd))\n sliceStart = sliceEnd + 1\n }\n\n subSlices.push(this.str.slice(sliceStart, this.pos))\n this.escapeCharPositions.length = 0\n\n return subSlices.join('')\n}\n\nlunr.QueryLexer.prototype.emit = function (type) {\n this.lexemes.push({\n type: type,\n str: this.sliceString(),\n start: this.start,\n end: this.pos\n })\n\n this.start = this.pos\n}\n\nlunr.QueryLexer.prototype.escapeCharacter = function () {\n this.escapeCharPositions.push(this.pos - 1)\n this.pos += 1\n}\n\nlunr.QueryLexer.prototype.next = function () {\n if (this.pos >= this.length) {\n return lunr.QueryLexer.EOS\n }\n\n var char = this.str.charAt(this.pos)\n this.pos += 1\n return char\n}\n\nlunr.QueryLexer.prototype.width = function () {\n return this.pos - this.start\n}\n\nlunr.QueryLexer.prototype.ignore = function () {\n if (this.start == this.pos) {\n this.pos += 1\n }\n\n this.start = this.pos\n}\n\nlunr.QueryLexer.prototype.backup = function () {\n this.pos -= 1\n}\n\nlunr.QueryLexer.prototype.acceptDigitRun = function () {\n var char, charCode\n\n do {\n char = this.next()\n charCode = char.charCodeAt(0)\n } while (charCode > 47 && charCode < 58)\n\n if (char != lunr.QueryLexer.EOS) {\n this.backup()\n }\n}\n\nlunr.QueryLexer.prototype.more = function () {\n return this.pos < this.length\n}\n\nlunr.QueryLexer.EOS = 'EOS'\nlunr.QueryLexer.FIELD = 'FIELD'\nlunr.QueryLexer.TERM = 'TERM'\nlunr.QueryLexer.EDIT_DISTANCE = 'EDIT_DISTANCE'\nlunr.QueryLexer.BOOST = 'BOOST'\nlunr.QueryLexer.PRESENCE = 'PRESENCE'\n\nlunr.QueryLexer.lexField = function (lexer) {\n lexer.backup()\n lexer.emit(lunr.QueryLexer.FIELD)\n lexer.ignore()\n return lunr.QueryLexer.lexText\n}\n\nlunr.QueryLexer.lexTerm = function (lexer) {\n if (lexer.width() > 1) {\n lexer.backup()\n lexer.emit(lunr.QueryLexer.TERM)\n }\n\n lexer.ignore()\n\n if (lexer.more()) {\n return lunr.QueryLexer.lexText\n }\n}\n\nlunr.QueryLexer.lexEditDistance = function (lexer) {\n lexer.ignore()\n lexer.acceptDigitRun()\n lexer.emit(lunr.QueryLexer.EDIT_DISTANCE)\n return lunr.QueryLexer.lexText\n}\n\nlunr.QueryLexer.lexBoost = function (lexer) {\n lexer.ignore()\n lexer.acceptDigitRun()\n lexer.emit(lunr.QueryLexer.BOOST)\n return lunr.QueryLexer.lexText\n}\n\nlunr.QueryLexer.lexEOS = function (lexer) {\n if (lexer.width() > 0) {\n lexer.emit(lunr.QueryLexer.TERM)\n }\n}\n\n// This matches the separator used when tokenising fields\n// within a document. These should match otherwise it is\n// not possible to search for some tokens within a document.\n//\n// It is possible for the user to change the separator on the\n// tokenizer so it _might_ clash with any other of the special\n// characters already used within the search string, e.g. :.\n//\n// This means that it is possible to change the separator in\n// such a way that makes some words unsearchable using a search\n// string.\nlunr.QueryLexer.termSeparator = lunr.tokenizer.separator\n\nlunr.QueryLexer.lexText = function (lexer) {\n while (true) {\n var char = lexer.next()\n\n if (char == lunr.QueryLexer.EOS) {\n return lunr.QueryLexer.lexEOS\n }\n\n // Escape character is '\\'\n if (char.charCodeAt(0) == 92) {\n lexer.escapeCharacter()\n continue\n }\n\n if (char == \":\") {\n return lunr.QueryLexer.lexField\n }\n\n if (char == \"~\") {\n lexer.backup()\n if (lexer.width() > 0) {\n lexer.emit(lunr.QueryLexer.TERM)\n }\n return lunr.QueryLexer.lexEditDistance\n }\n\n if (char == \"^\") {\n lexer.backup()\n if (lexer.width() > 0) {\n lexer.emit(lunr.QueryLexer.TERM)\n }\n return lunr.QueryLexer.lexBoost\n }\n\n // \"+\" indicates term presence is required\n // checking for length to ensure that only\n // leading \"+\" are considered\n if (char == \"+\" && lexer.width() === 1) {\n lexer.emit(lunr.QueryLexer.PRESENCE)\n return lunr.QueryLexer.lexText\n }\n\n // \"-\" indicates term presence is prohibited\n // checking for length to ensure that only\n // leading \"-\" are considered\n if (char == \"-\" && lexer.width() === 1) {\n lexer.emit(lunr.QueryLexer.PRESENCE)\n return lunr.QueryLexer.lexText\n }\n\n if (char.match(lunr.QueryLexer.termSeparator)) {\n return lunr.QueryLexer.lexTerm\n }\n }\n}\n\nlunr.QueryParser = function (str, query) {\n this.lexer = new lunr.QueryLexer (str)\n this.query = query\n this.currentClause = {}\n this.lexemeIdx = 0\n}\n\nlunr.QueryParser.prototype.parse = function () {\n this.lexer.run()\n this.lexemes = this.lexer.lexemes\n\n var state = lunr.QueryParser.parseClause\n\n while (state) {\n state = state(this)\n }\n\n return this.query\n}\n\nlunr.QueryParser.prototype.peekLexeme = function () {\n return this.lexemes[this.lexemeIdx]\n}\n\nlunr.QueryParser.prototype.consumeLexeme = function () {\n var lexeme = this.peekLexeme()\n this.lexemeIdx += 1\n return lexeme\n}\n\nlunr.QueryParser.prototype.nextClause = function () {\n var completedClause = this.currentClause\n this.query.clause(completedClause)\n this.currentClause = {}\n}\n\nlunr.QueryParser.parseClause = function (parser) {\n var lexeme = parser.peekLexeme()\n\n if (lexeme == undefined) {\n return\n }\n\n switch (lexeme.type) {\n case lunr.QueryLexer.PRESENCE:\n return lunr.QueryParser.parsePresence\n case lunr.QueryLexer.FIELD:\n return lunr.QueryParser.parseField\n case lunr.QueryLexer.TERM:\n return lunr.QueryParser.parseTerm\n default:\n var errorMessage = \"expected either a field or a term, found \" + lexeme.type\n\n if (lexeme.str.length >= 1) {\n errorMessage += \" with value '\" + lexeme.str + \"'\"\n }\n\n throw new lunr.QueryParseError (errorMessage, lexeme.start, lexeme.end)\n }\n}\n\nlunr.QueryParser.parsePresence = function (parser) {\n var lexeme = parser.consumeLexeme()\n\n if (lexeme == undefined) {\n return\n }\n\n switch (lexeme.str) {\n case \"-\":\n parser.currentClause.presence = lunr.Query.presence.PROHIBITED\n break\n case \"+\":\n parser.currentClause.presence = lunr.Query.presence.REQUIRED\n break\n default:\n var errorMessage = \"unrecognised presence operator'\" + lexeme.str + \"'\"\n throw new lunr.QueryParseError (errorMessage, lexeme.start, lexeme.end)\n }\n\n var nextLexeme = parser.peekLexeme()\n\n if (nextLexeme == undefined) {\n var errorMessage = \"expecting term or field, found nothing\"\n throw new lunr.QueryParseError (errorMessage, lexeme.start, lexeme.end)\n }\n\n switch (nextLexeme.type) {\n case lunr.QueryLexer.FIELD:\n return lunr.QueryParser.parseField\n case lunr.QueryLexer.TERM:\n return lunr.QueryParser.parseTerm\n default:\n var errorMessage = \"expecting term or field, found '\" + nextLexeme.type + \"'\"\n throw new lunr.QueryParseError (errorMessage, nextLexeme.start, nextLexeme.end)\n }\n}\n\nlunr.QueryParser.parseField = function (parser) {\n var lexeme = parser.consumeLexeme()\n\n if (lexeme == undefined) {\n return\n }\n\n if (parser.query.allFields.indexOf(lexeme.str) == -1) {\n var possibleFields = parser.query.allFields.map(function (f) { return \"'\" + f + \"'\" }).join(', '),\n errorMessage = \"unrecognised field '\" + lexeme.str + \"', possible fields: \" + possibleFields\n\n throw new lunr.QueryParseError (errorMessage, lexeme.start, lexeme.end)\n }\n\n parser.currentClause.fields = [lexeme.str]\n\n var nextLexeme = parser.peekLexeme()\n\n if (nextLexeme == undefined) {\n var errorMessage = \"expecting term, found nothing\"\n throw new lunr.QueryParseError (errorMessage, lexeme.start, lexeme.end)\n }\n\n switch (nextLexeme.type) {\n case lunr.QueryLexer.TERM:\n return lunr.QueryParser.parseTerm\n default:\n var errorMessage = \"expecting term, found '\" + nextLexeme.type + \"'\"\n throw new lunr.QueryParseError (errorMessage, nextLexeme.start, nextLexeme.end)\n }\n}\n\nlunr.QueryParser.parseTerm = function (parser) {\n var lexeme = parser.consumeLexeme()\n\n if (lexeme == undefined) {\n return\n }\n\n parser.currentClause.term = lexeme.str.toLowerCase()\n\n if (lexeme.str.indexOf(\"*\") != -1) {\n parser.currentClause.usePipeline = false\n }\n\n var nextLexeme = parser.peekLexeme()\n\n if (nextLexeme == undefined) {\n parser.nextClause()\n return\n }\n\n switch (nextLexeme.type) {\n case lunr.QueryLexer.TERM:\n parser.nextClause()\n return lunr.QueryParser.parseTerm\n case lunr.QueryLexer.FIELD:\n parser.nextClause()\n return lunr.QueryParser.parseField\n case lunr.QueryLexer.EDIT_DISTANCE:\n return lunr.QueryParser.parseEditDistance\n case lunr.QueryLexer.BOOST:\n return lunr.QueryParser.parseBoost\n case lunr.QueryLexer.PRESENCE:\n parser.nextClause()\n return lunr.QueryParser.parsePresence\n default:\n var errorMessage = \"Unexpected lexeme type '\" + nextLexeme.type + \"'\"\n throw new lunr.QueryParseError (errorMessage, nextLexeme.start, nextLexeme.end)\n }\n}\n\nlunr.QueryParser.parseEditDistance = function (parser) {\n var lexeme = parser.consumeLexeme()\n\n if (lexeme == undefined) {\n return\n }\n\n var editDistance = parseInt(lexeme.str, 10)\n\n if (isNaN(editDistance)) {\n var errorMessage = \"edit distance must be numeric\"\n throw new lunr.QueryParseError (errorMessage, lexeme.start, lexeme.end)\n }\n\n parser.currentClause.editDistance = editDistance\n\n var nextLexeme = parser.peekLexeme()\n\n if (nextLexeme == undefined) {\n parser.nextClause()\n return\n }\n\n switch (nextLexeme.type) {\n case lunr.QueryLexer.TERM:\n parser.nextClause()\n return lunr.QueryParser.parseTerm\n case lunr.QueryLexer.FIELD:\n parser.nextClause()\n return lunr.QueryParser.parseField\n case lunr.QueryLexer.EDIT_DISTANCE:\n return lunr.QueryParser.parseEditDistance\n case lunr.QueryLexer.BOOST:\n return lunr.QueryParser.parseBoost\n case lunr.QueryLexer.PRESENCE:\n parser.nextClause()\n return lunr.QueryParser.parsePresence\n default:\n var errorMessage = \"Unexpected lexeme type '\" + nextLexeme.type + \"'\"\n throw new lunr.QueryParseError (errorMessage, nextLexeme.start, nextLexeme.end)\n }\n}\n\nlunr.QueryParser.parseBoost = function (parser) {\n var lexeme = parser.consumeLexeme()\n\n if (lexeme == undefined) {\n return\n }\n\n var boost = parseInt(lexeme.str, 10)\n\n if (isNaN(boost)) {\n var errorMessage = \"boost must be numeric\"\n throw new lunr.QueryParseError (errorMessage, lexeme.start, lexeme.end)\n }\n\n parser.currentClause.boost = boost\n\n var nextLexeme = parser.peekLexeme()\n\n if (nextLexeme == undefined) {\n parser.nextClause()\n return\n }\n\n switch (nextLexeme.type) {\n case lunr.QueryLexer.TERM:\n parser.nextClause()\n return lunr.QueryParser.parseTerm\n case lunr.QueryLexer.FIELD:\n parser.nextClause()\n return lunr.QueryParser.parseField\n case lunr.QueryLexer.EDIT_DISTANCE:\n return lunr.QueryParser.parseEditDistance\n case lunr.QueryLexer.BOOST:\n return lunr.QueryParser.parseBoost\n case lunr.QueryLexer.PRESENCE:\n parser.nextClause()\n return lunr.QueryParser.parsePresence\n default:\n var errorMessage = \"Unexpected lexeme type '\" + nextLexeme.type + \"'\"\n throw new lunr.QueryParseError (errorMessage, nextLexeme.start, nextLexeme.end)\n }\n}\n\n /**\n * export the module via AMD, CommonJS or as a browser global\n * Export code from https://github.com/umdjs/umd/blob/master/returnExports.js\n */\n ;(function (root, factory) {\n if (true) {\n // AMD. Register as an anonymous module.\n !(__WEBPACK_AMD_DEFINE_FACTORY__ = (factory),\n\t\t__WEBPACK_AMD_DEFINE_RESULT__ = (typeof __WEBPACK_AMD_DEFINE_FACTORY__ === 'function' ?\n\t\t(__WEBPACK_AMD_DEFINE_FACTORY__.call(exports, __webpack_require__, exports, module)) :\n\t\t__WEBPACK_AMD_DEFINE_FACTORY__),\n\t\t__WEBPACK_AMD_DEFINE_RESULT__ !== undefined && (module.exports = __WEBPACK_AMD_DEFINE_RESULT__))\n } else {}\n }(this, function () {\n /**\n * Just return a value to define the module export.\n * This example returns an object, but the module\n * can return a function as the exported value.\n */\n return lunr\n }))\n})();\n\n\n//# sourceURL=webpack:///../node_modules/lunr/lunr.js?"); + +/***/ }), + +/***/ "./default/assets/css/main.sass": +/*!**************************************!*\ + !*** ./default/assets/css/main.sass ***! + \**************************************/ +/***/ ((__unused_webpack_module, __webpack_exports__, __webpack_require__) => { + +"use strict"; +eval("__webpack_require__.r(__webpack_exports__);\n// extracted by mini-css-extract-plugin\n\n\n//# sourceURL=webpack:///./default/assets/css/main.sass?"); + +/***/ }), + +/***/ "./default/assets/js/src/bootstrap.ts": +/*!********************************************!*\ + !*** ./default/assets/js/src/bootstrap.ts ***! + \********************************************/ +/***/ ((__unused_webpack_module, __webpack_exports__, __webpack_require__) => { + +"use strict"; +eval("__webpack_require__.r(__webpack_exports__);\n/* harmony import */ var _typedoc_Application__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__(/*! ./typedoc/Application */ \"./default/assets/js/src/typedoc/Application.ts\");\n/* harmony import */ var _typedoc_components_MenuHighlight__WEBPACK_IMPORTED_MODULE_1__ = __webpack_require__(/*! ./typedoc/components/MenuHighlight */ \"./default/assets/js/src/typedoc/components/MenuHighlight.ts\");\n/* harmony import */ var _typedoc_components_Search__WEBPACK_IMPORTED_MODULE_2__ = __webpack_require__(/*! ./typedoc/components/Search */ \"./default/assets/js/src/typedoc/components/Search.ts\");\n/* harmony import */ var _typedoc_components_Signature__WEBPACK_IMPORTED_MODULE_3__ = __webpack_require__(/*! ./typedoc/components/Signature */ \"./default/assets/js/src/typedoc/components/Signature.ts\");\n/* harmony import */ var _typedoc_components_Toggle__WEBPACK_IMPORTED_MODULE_4__ = __webpack_require__(/*! ./typedoc/components/Toggle */ \"./default/assets/js/src/typedoc/components/Toggle.ts\");\n/* harmony import */ var _typedoc_components_Filter__WEBPACK_IMPORTED_MODULE_5__ = __webpack_require__(/*! ./typedoc/components/Filter */ \"./default/assets/js/src/typedoc/components/Filter.ts\");\n/* harmony import */ var _css_main_sass__WEBPACK_IMPORTED_MODULE_6__ = __webpack_require__(/*! ../../css/main.sass */ \"./default/assets/css/main.sass\");\n\n\n\n\n\n\n\n(0,_typedoc_components_Search__WEBPACK_IMPORTED_MODULE_2__.initSearch)();\n(0,_typedoc_Application__WEBPACK_IMPORTED_MODULE_0__.registerComponent)(_typedoc_components_MenuHighlight__WEBPACK_IMPORTED_MODULE_1__.MenuHighlight, \".menu-highlight\");\n(0,_typedoc_Application__WEBPACK_IMPORTED_MODULE_0__.registerComponent)(_typedoc_components_Signature__WEBPACK_IMPORTED_MODULE_3__.Signature, \".tsd-signatures\");\n(0,_typedoc_Application__WEBPACK_IMPORTED_MODULE_0__.registerComponent)(_typedoc_components_Toggle__WEBPACK_IMPORTED_MODULE_4__.Toggle, \"a[data-toggle]\");\nif (_typedoc_components_Filter__WEBPACK_IMPORTED_MODULE_5__.Filter.isSupported()) {\n (0,_typedoc_Application__WEBPACK_IMPORTED_MODULE_0__.registerComponent)(_typedoc_components_Filter__WEBPACK_IMPORTED_MODULE_5__.Filter, \"#tsd-filter\");\n}\nelse {\n document.documentElement.classList.add(\"no-filter\");\n}\nvar app = new _typedoc_Application__WEBPACK_IMPORTED_MODULE_0__.Application();\nObject.defineProperty(window, \"app\", { value: app });\n\n\n//# sourceURL=webpack:///./default/assets/js/src/bootstrap.ts?"); + +/***/ }), + +/***/ "./default/assets/js/src/typedoc/Application.ts": +/*!******************************************************!*\ + !*** ./default/assets/js/src/typedoc/Application.ts ***! + \******************************************************/ +/***/ ((__unused_webpack_module, __webpack_exports__, __webpack_require__) => { + +"use strict"; +eval("__webpack_require__.r(__webpack_exports__);\n/* harmony export */ __webpack_require__.d(__webpack_exports__, {\n/* harmony export */ \"registerComponent\": () => /* binding */ registerComponent,\n/* harmony export */ \"Application\": () => /* binding */ Application\n/* harmony export */ });\n/**\n * List of all known components.\n */\nvar components = [];\n/**\n * Register a new component.\n */\nfunction registerComponent(constructor, selector) {\n components.push({\n selector: selector,\n constructor: constructor,\n });\n}\n/**\n * TypeDoc application class.\n */\nvar Application = /** @class */ (function () {\n /**\n * Create a new Application instance.\n */\n function Application() {\n this.createComponents(document.body);\n }\n /**\n * Create all components beneath the given jQuery element.\n */\n Application.prototype.createComponents = function (context) {\n components.forEach(function (c) {\n context.querySelectorAll(c.selector).forEach(function (el) {\n if (!el.dataset.hasInstance) {\n new c.constructor({ el: el });\n el.dataset.hasInstance = String(true);\n }\n });\n });\n };\n return Application;\n}());\n\n\n\n//# sourceURL=webpack:///./default/assets/js/src/typedoc/Application.ts?"); + +/***/ }), + +/***/ "./default/assets/js/src/typedoc/Component.ts": +/*!****************************************************!*\ + !*** ./default/assets/js/src/typedoc/Component.ts ***! + \****************************************************/ +/***/ ((__unused_webpack_module, __webpack_exports__, __webpack_require__) => { + +"use strict"; +eval("__webpack_require__.r(__webpack_exports__);\n/* harmony export */ __webpack_require__.d(__webpack_exports__, {\n/* harmony export */ \"Component\": () => /* binding */ Component\n/* harmony export */ });\n/**\n * TypeDoc component class.\n */\nvar Component = /** @class */ (function () {\n function Component(options) {\n this.el = options.el;\n }\n return Component;\n}());\n\n\n\n//# sourceURL=webpack:///./default/assets/js/src/typedoc/Component.ts?"); + +/***/ }), + +/***/ "./default/assets/js/src/typedoc/EventTarget.ts": +/*!******************************************************!*\ + !*** ./default/assets/js/src/typedoc/EventTarget.ts ***! + \******************************************************/ +/***/ ((__unused_webpack_module, __webpack_exports__, __webpack_require__) => { + +"use strict"; +eval("__webpack_require__.r(__webpack_exports__);\n/* harmony export */ __webpack_require__.d(__webpack_exports__, {\n/* harmony export */ \"EventTarget\": () => /* binding */ EventTarget\n/* harmony export */ });\n/**\n * TypeDoc event target class.\n */\nvar EventTarget = /** @class */ (function () {\n function EventTarget() {\n this.listeners = {};\n }\n EventTarget.prototype.addEventListener = function (type, callback) {\n if (!(type in this.listeners)) {\n this.listeners[type] = [];\n }\n this.listeners[type].push(callback);\n };\n EventTarget.prototype.removeEventListener = function (type, callback) {\n if (!(type in this.listeners)) {\n return;\n }\n var stack = this.listeners[type];\n for (var i = 0, l = stack.length; i < l; i++) {\n if (stack[i] === callback) {\n stack.splice(i, 1);\n return;\n }\n }\n };\n EventTarget.prototype.dispatchEvent = function (event) {\n if (!(event.type in this.listeners)) {\n return true;\n }\n var stack = this.listeners[event.type].slice();\n for (var i = 0, l = stack.length; i < l; i++) {\n stack[i].call(this, event);\n }\n return !event.defaultPrevented;\n };\n return EventTarget;\n}());\n\n\n\n//# sourceURL=webpack:///./default/assets/js/src/typedoc/EventTarget.ts?"); + +/***/ }), + +/***/ "./default/assets/js/src/typedoc/components/Filter.ts": +/*!************************************************************!*\ + !*** ./default/assets/js/src/typedoc/components/Filter.ts ***! + \************************************************************/ +/***/ ((__unused_webpack_module, __webpack_exports__, __webpack_require__) => { + +"use strict"; +eval("__webpack_require__.r(__webpack_exports__);\n/* harmony export */ __webpack_require__.d(__webpack_exports__, {\n/* harmony export */ \"Filter\": () => /* binding */ Filter\n/* harmony export */ });\n/* harmony import */ var _Component__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__(/*! ../Component */ \"./default/assets/js/src/typedoc/Component.ts\");\n/* harmony import */ var _utils_pointer__WEBPACK_IMPORTED_MODULE_1__ = __webpack_require__(/*! ../utils/pointer */ \"./default/assets/js/src/typedoc/utils/pointer.ts\");\nvar __extends = (undefined && undefined.__extends) || (function () {\n var extendStatics = function (d, b) {\n extendStatics = Object.setPrototypeOf ||\n ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||\n function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };\n return extendStatics(d, b);\n };\n return function (d, b) {\n extendStatics(d, b);\n function __() { this.constructor = d; }\n d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());\n };\n})();\n\n\nvar FilterItem = /** @class */ (function () {\n function FilterItem(key, value) {\n this.key = key;\n this.value = value;\n this.defaultValue = value;\n this.initialize();\n if (window.localStorage[this.key]) {\n this.setValue(this.fromLocalStorage(window.localStorage[this.key]));\n }\n }\n FilterItem.prototype.initialize = function () { };\n FilterItem.prototype.setValue = function (value) {\n if (this.value == value)\n return;\n var oldValue = this.value;\n this.value = value;\n window.localStorage[this.key] = this.toLocalStorage(value);\n this.handleValueChange(oldValue, value);\n };\n return FilterItem;\n}());\nvar FilterItemCheckbox = /** @class */ (function (_super) {\n __extends(FilterItemCheckbox, _super);\n function FilterItemCheckbox() {\n return _super !== null && _super.apply(this, arguments) || this;\n }\n FilterItemCheckbox.prototype.initialize = function () {\n var _this = this;\n var checkbox = document.querySelector(\"#tsd-filter-\" + this.key);\n if (!checkbox)\n return;\n this.checkbox = checkbox;\n this.checkbox.addEventListener(\"change\", function () {\n _this.setValue(_this.checkbox.checked);\n });\n };\n FilterItemCheckbox.prototype.handleValueChange = function (oldValue, newValue) {\n if (!this.checkbox)\n return;\n this.checkbox.checked = this.value;\n document.documentElement.classList.toggle(\"toggle-\" + this.key, this.value != this.defaultValue);\n };\n FilterItemCheckbox.prototype.fromLocalStorage = function (value) {\n return value == \"true\";\n };\n FilterItemCheckbox.prototype.toLocalStorage = function (value) {\n return value ? \"true\" : \"false\";\n };\n return FilterItemCheckbox;\n}(FilterItem));\nvar FilterItemSelect = /** @class */ (function (_super) {\n __extends(FilterItemSelect, _super);\n function FilterItemSelect() {\n return _super !== null && _super.apply(this, arguments) || this;\n }\n FilterItemSelect.prototype.initialize = function () {\n var _this = this;\n document.documentElement.classList.add(\"toggle-\" + this.key + this.value);\n var select = document.querySelector(\"#tsd-filter-\" + this.key);\n if (!select)\n return;\n this.select = select;\n var onActivate = function () {\n _this.select.classList.add(\"active\");\n };\n var onDeactivate = function () {\n _this.select.classList.remove(\"active\");\n };\n this.select.addEventListener(_utils_pointer__WEBPACK_IMPORTED_MODULE_1__.pointerDown, onActivate);\n this.select.addEventListener(\"mouseover\", onActivate);\n this.select.addEventListener(\"mouseleave\", onDeactivate);\n this.select.querySelectorAll(\"li\").forEach(function (el) {\n el.addEventListener(_utils_pointer__WEBPACK_IMPORTED_MODULE_1__.pointerUp, function (e) {\n select.classList.remove(\"active\");\n _this.setValue(e.target.dataset.value || \"\");\n });\n });\n document.addEventListener(_utils_pointer__WEBPACK_IMPORTED_MODULE_1__.pointerDown, function (e) {\n if (_this.select.contains(e.target))\n return;\n _this.select.classList.remove(\"active\");\n });\n };\n FilterItemSelect.prototype.handleValueChange = function (oldValue, newValue) {\n this.select.querySelectorAll(\"li.selected\").forEach(function (el) {\n el.classList.remove(\"selected\");\n });\n var selected = this.select.querySelector('li[data-value=\"' + newValue + '\"]');\n var label = this.select.querySelector(\".tsd-select-label\");\n if (selected && label) {\n selected.classList.add(\"selected\");\n label.textContent = selected.textContent;\n }\n document.documentElement.classList.remove(\"toggle-\" + oldValue);\n document.documentElement.classList.add(\"toggle-\" + newValue);\n };\n FilterItemSelect.prototype.fromLocalStorage = function (value) {\n return value;\n };\n FilterItemSelect.prototype.toLocalStorage = function (value) {\n return value;\n };\n return FilterItemSelect;\n}(FilterItem));\nvar Filter = /** @class */ (function (_super) {\n __extends(Filter, _super);\n function Filter(options) {\n var _this = _super.call(this, options) || this;\n _this.optionVisibility = new FilterItemSelect(\"visibility\", \"private\");\n _this.optionInherited = new FilterItemCheckbox(\"inherited\", true);\n _this.optionExternals = new FilterItemCheckbox(\"externals\", true);\n return _this;\n }\n Filter.isSupported = function () {\n try {\n return typeof window.localStorage != \"undefined\";\n }\n catch (e) {\n return false;\n }\n };\n return Filter;\n}(_Component__WEBPACK_IMPORTED_MODULE_0__.Component));\n\n\n\n//# sourceURL=webpack:///./default/assets/js/src/typedoc/components/Filter.ts?"); + +/***/ }), + +/***/ "./default/assets/js/src/typedoc/components/MenuHighlight.ts": +/*!*******************************************************************!*\ + !*** ./default/assets/js/src/typedoc/components/MenuHighlight.ts ***! + \*******************************************************************/ +/***/ ((__unused_webpack_module, __webpack_exports__, __webpack_require__) => { + +"use strict"; +eval("__webpack_require__.r(__webpack_exports__);\n/* harmony export */ __webpack_require__.d(__webpack_exports__, {\n/* harmony export */ \"MenuHighlight\": () => /* binding */ MenuHighlight\n/* harmony export */ });\n/* harmony import */ var _Component__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__(/*! ../Component */ \"./default/assets/js/src/typedoc/Component.ts\");\n/* harmony import */ var _services_Viewport__WEBPACK_IMPORTED_MODULE_1__ = __webpack_require__(/*! ../services/Viewport */ \"./default/assets/js/src/typedoc/services/Viewport.ts\");\nvar __extends = (undefined && undefined.__extends) || (function () {\n var extendStatics = function (d, b) {\n extendStatics = Object.setPrototypeOf ||\n ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||\n function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };\n return extendStatics(d, b);\n };\n return function (d, b) {\n extendStatics(d, b);\n function __() { this.constructor = d; }\n d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());\n };\n})();\n\n\n/**\n * Manages the sticky state of the navigation and moves the highlight\n * to the current navigation item.\n */\nvar MenuHighlight = /** @class */ (function (_super) {\n __extends(MenuHighlight, _super);\n /**\n * Create a new MenuHighlight instance.\n *\n * @param options Backbone view constructor options.\n */\n function MenuHighlight(options) {\n var _this = _super.call(this, options) || this;\n /**\n * List of all discovered anchors.\n */\n _this.anchors = [];\n /**\n * Index of the currently highlighted anchor.\n */\n _this.index = -1;\n _services_Viewport__WEBPACK_IMPORTED_MODULE_1__.Viewport.instance.addEventListener(\"resize\", function () { return _this.onResize(); });\n _services_Viewport__WEBPACK_IMPORTED_MODULE_1__.Viewport.instance.addEventListener(\"scroll\", function (e) { return _this.onScroll(e); });\n _this.createAnchors();\n return _this;\n }\n /**\n * Find all anchors on the current page.\n */\n MenuHighlight.prototype.createAnchors = function () {\n var _this = this;\n var base = window.location.href;\n if (base.indexOf(\"#\") != -1) {\n base = base.substr(0, base.indexOf(\"#\"));\n }\n this.el.querySelectorAll(\"a\").forEach(function (el) {\n var href = el.href;\n if (href.indexOf(\"#\") == -1)\n return;\n if (href.substr(0, base.length) != base)\n return;\n var hash = href.substr(href.indexOf(\"#\") + 1);\n var anchor = document.querySelector(\"a.tsd-anchor[name=\" + hash + \"]\");\n var link = el.parentNode;\n if (!anchor || !link)\n return;\n _this.anchors.push({\n link: link,\n anchor: anchor,\n position: 0,\n });\n });\n this.onResize();\n };\n /**\n * Triggered after the viewport was resized.\n */\n MenuHighlight.prototype.onResize = function () {\n var anchor;\n for (var index = 0, count = this.anchors.length; index < count; index++) {\n anchor = this.anchors[index];\n var rect = anchor.anchor.getBoundingClientRect();\n anchor.position = rect.top + document.body.scrollTop;\n }\n this.anchors.sort(function (a, b) {\n return a.position - b.position;\n });\n var event = new CustomEvent(\"scroll\", {\n detail: {\n scrollTop: _services_Viewport__WEBPACK_IMPORTED_MODULE_1__.Viewport.instance.scrollTop,\n },\n });\n this.onScroll(event);\n };\n /**\n * Triggered after the viewport was scrolled.\n *\n * @param event The custom event with the current vertical scroll position.\n */\n MenuHighlight.prototype.onScroll = function (event) {\n var scrollTop = event.detail.scrollTop + 5;\n var anchors = this.anchors;\n var count = anchors.length - 1;\n var index = this.index;\n while (index > -1 && anchors[index].position > scrollTop) {\n index -= 1;\n }\n while (index < count && anchors[index + 1].position < scrollTop) {\n index += 1;\n }\n if (this.index != index) {\n if (this.index > -1)\n this.anchors[this.index].link.classList.remove(\"focus\");\n this.index = index;\n if (this.index > -1)\n this.anchors[this.index].link.classList.add(\"focus\");\n }\n };\n return MenuHighlight;\n}(_Component__WEBPACK_IMPORTED_MODULE_0__.Component));\n\n\n\n//# sourceURL=webpack:///./default/assets/js/src/typedoc/components/MenuHighlight.ts?"); + +/***/ }), + +/***/ "./default/assets/js/src/typedoc/components/Search.ts": +/*!************************************************************!*\ + !*** ./default/assets/js/src/typedoc/components/Search.ts ***! + \************************************************************/ +/***/ ((__unused_webpack_module, __webpack_exports__, __webpack_require__) => { + +"use strict"; +eval("__webpack_require__.r(__webpack_exports__);\n/* harmony export */ __webpack_require__.d(__webpack_exports__, {\n/* harmony export */ \"initSearch\": () => /* binding */ initSearch\n/* harmony export */ });\n/* harmony import */ var _utils_debounce__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__(/*! ../utils/debounce */ \"./default/assets/js/src/typedoc/utils/debounce.ts\");\n/* harmony import */ var lunr__WEBPACK_IMPORTED_MODULE_1__ = __webpack_require__(/*! lunr */ \"../node_modules/lunr/lunr.js\");\n/* harmony import */ var lunr__WEBPACK_IMPORTED_MODULE_1___default = /*#__PURE__*/__webpack_require__.n(lunr__WEBPACK_IMPORTED_MODULE_1__);\n\n\nfunction initSearch() {\n var searchEl = document.getElementById(\"tsd-search\");\n if (!searchEl)\n return;\n var searchScript = document.getElementById(\"search-script\");\n searchEl.classList.add(\"loading\");\n if (searchScript) {\n searchScript.addEventListener(\"error\", function () {\n searchEl.classList.remove(\"loading\");\n searchEl.classList.add(\"failure\");\n });\n searchScript.addEventListener(\"load\", function () {\n searchEl.classList.remove(\"loading\");\n searchEl.classList.add(\"ready\");\n });\n if (window.searchData) {\n searchEl.classList.remove(\"loading\");\n }\n }\n var field = document.querySelector(\"#tsd-search-field\");\n var results = document.querySelector(\".results\");\n if (!field || !results) {\n throw new Error(\"The input field or the result list wrapper was not found\");\n }\n var resultClicked = false;\n results.addEventListener(\"mousedown\", function () { return (resultClicked = true); });\n results.addEventListener(\"mouseup\", function () {\n resultClicked = false;\n searchEl.classList.remove(\"has-focus\");\n });\n field.addEventListener(\"focus\", function () { return searchEl.classList.add(\"has-focus\"); });\n field.addEventListener(\"blur\", function () {\n if (!resultClicked) {\n resultClicked = false;\n searchEl.classList.remove(\"has-focus\");\n }\n });\n var state = {\n base: searchEl.dataset.base + \"/\",\n };\n bindEvents(searchEl, results, field, state);\n}\nfunction bindEvents(searchEl, results, field, state) {\n field.addEventListener(\"input\", (0,_utils_debounce__WEBPACK_IMPORTED_MODULE_0__.debounce)(function () {\n updateResults(searchEl, results, field, state);\n }, 200));\n var preventPress = false;\n field.addEventListener(\"keydown\", function (e) {\n preventPress = true;\n if (e.key == \"Enter\") {\n gotoCurrentResult(results, field);\n }\n else if (e.key == \"Escape\") {\n field.blur();\n }\n else if (e.key == \"ArrowUp\") {\n setCurrentResult(results, -1);\n }\n else if (e.key === \"ArrowDown\") {\n setCurrentResult(results, 1);\n }\n else {\n preventPress = false;\n }\n });\n field.addEventListener(\"keypress\", function (e) {\n if (preventPress)\n e.preventDefault();\n });\n /**\n * Start searching by pressing slash.\n */\n document.body.addEventListener(\"keydown\", function (e) {\n if (e.altKey || e.ctrlKey || e.metaKey)\n return;\n if (!field.matches(\":focus\") && e.key === \"/\") {\n field.focus();\n e.preventDefault();\n }\n });\n}\nfunction checkIndex(state, searchEl) {\n if (state.index)\n return;\n if (window.searchData) {\n searchEl.classList.remove(\"loading\");\n searchEl.classList.add(\"ready\");\n state.data = window.searchData;\n state.index = lunr__WEBPACK_IMPORTED_MODULE_1__.Index.load(window.searchData.index);\n }\n}\nfunction updateResults(searchEl, results, query, state) {\n checkIndex(state, searchEl);\n // Don't clear results if loading state is not ready,\n // because loading or error message can be removed.\n if (!state.index || !state.data)\n return;\n results.textContent = \"\";\n var searchText = query.value.trim();\n // Perform a wildcard search\n var res = state.index.search(\"*\" + searchText + \"*\");\n for (var i = 0, c = Math.min(10, res.length); i < c; i++) {\n var row = state.data.rows[Number(res[i].ref)];\n // Bold the matched part of the query in the search results\n var name_1 = boldMatches(row.name, searchText);\n if (row.parent) {\n name_1 = \"\" + boldMatches(row.parent, searchText) + \".\" + name_1;\n }\n var item = document.createElement(\"li\");\n item.classList.value = row.classes;\n var anchor = document.createElement(\"a\");\n anchor.href = state.base + row.url;\n anchor.classList.add(\"tsd-kind-icon\");\n anchor.innerHTML = name_1;\n item.append(anchor);\n results.appendChild(item);\n }\n}\n/**\n * Move the highlight within the result set.\n */\nfunction setCurrentResult(results, dir) {\n var current = results.querySelector(\".current\");\n if (!current) {\n current = results.querySelector(dir == 1 ? \"li:first-child\" : \"li:last-child\");\n if (current) {\n current.classList.add(\"current\");\n }\n }\n else {\n var rel = dir == 1\n ? current.nextElementSibling\n : current.previousElementSibling;\n if (rel) {\n current.classList.remove(\"current\");\n rel.classList.add(\"current\");\n }\n }\n}\n/**\n * Navigate to the highlighted result.\n */\nfunction gotoCurrentResult(results, field) {\n var current = results.querySelector(\".current\");\n if (!current) {\n current = results.querySelector(\"li:first-child\");\n }\n if (current) {\n var link = current.querySelector(\"a\");\n if (link) {\n window.location.href = link.href;\n }\n field.blur();\n }\n}\nfunction boldMatches(text, search) {\n if (search === \"\") {\n return text;\n }\n var lowerText = text.toLocaleLowerCase();\n var lowerSearch = search.toLocaleLowerCase();\n var parts = [];\n var lastIndex = 0;\n var index = lowerText.indexOf(lowerSearch);\n while (index != -1) {\n parts.push(escapeHtml(text.substring(lastIndex, index)), \"\" + escapeHtml(text.substring(index, index + lowerSearch.length)) + \"\");\n lastIndex = index + lowerSearch.length;\n index = lowerText.indexOf(lowerSearch, lastIndex);\n }\n parts.push(escapeHtml(text.substring(lastIndex)));\n return parts.join(\"\");\n}\nvar SPECIAL_HTML = {\n \"&\": \"&\",\n \"<\": \"<\",\n \">\": \">\",\n \"'\": \"'\",\n '\"': \""\",\n};\nfunction escapeHtml(text) {\n return text.replace(/[&<>\"'\"]/g, function (match) { return SPECIAL_HTML[match]; });\n}\n\n\n//# sourceURL=webpack:///./default/assets/js/src/typedoc/components/Search.ts?"); + +/***/ }), + +/***/ "./default/assets/js/src/typedoc/components/Signature.ts": +/*!***************************************************************!*\ + !*** ./default/assets/js/src/typedoc/components/Signature.ts ***! + \***************************************************************/ +/***/ ((__unused_webpack_module, __webpack_exports__, __webpack_require__) => { + +"use strict"; +eval("__webpack_require__.r(__webpack_exports__);\n/* harmony export */ __webpack_require__.d(__webpack_exports__, {\n/* harmony export */ \"Signature\": () => /* binding */ Signature\n/* harmony export */ });\n/* harmony import */ var _Component__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__(/*! ../Component */ \"./default/assets/js/src/typedoc/Component.ts\");\n/* harmony import */ var _services_Viewport__WEBPACK_IMPORTED_MODULE_1__ = __webpack_require__(/*! ../services/Viewport */ \"./default/assets/js/src/typedoc/services/Viewport.ts\");\nvar __extends = (undefined && undefined.__extends) || (function () {\n var extendStatics = function (d, b) {\n extendStatics = Object.setPrototypeOf ||\n ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||\n function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };\n return extendStatics(d, b);\n };\n return function (d, b) {\n extendStatics(d, b);\n function __() { this.constructor = d; }\n d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());\n };\n})();\n\n\n/**\n * Holds a signature and its description.\n */\nvar SignatureGroup = /** @class */ (function () {\n /**\n * Create a new SignatureGroup instance.\n *\n * @param signature The target signature.\n * @param description The description for the signature.\n */\n function SignatureGroup(signature, description) {\n this.signature = signature;\n this.description = description;\n }\n /**\n * Add the given class to all elements of the group.\n *\n * @param className The class name to add.\n */\n SignatureGroup.prototype.addClass = function (className) {\n this.signature.classList.add(className);\n this.description.classList.add(className);\n return this;\n };\n /**\n * Remove the given class from all elements of the group.\n *\n * @param className The class name to remove.\n */\n SignatureGroup.prototype.removeClass = function (className) {\n this.signature.classList.remove(className);\n this.description.classList.remove(className);\n return this;\n };\n return SignatureGroup;\n}());\n/**\n * Controls the tab like behaviour of methods and functions with multiple signatures.\n */\nvar Signature = /** @class */ (function (_super) {\n __extends(Signature, _super);\n /**\n * Create a new Signature instance.\n *\n * @param options Backbone view constructor options.\n */\n function Signature(options) {\n var _this = _super.call(this, options) || this;\n /**\n * List of found signature groups.\n */\n _this.groups = [];\n /**\n * The index of the currently displayed signature.\n */\n _this.index = -1;\n _this.createGroups();\n if (_this.container) {\n _this.el.classList.add(\"active\");\n Array.from(_this.el.children).forEach(function (signature) {\n signature.addEventListener(\"touchstart\", function (event) {\n return _this.onClick(event);\n });\n signature.addEventListener(\"click\", function (event) {\n return _this.onClick(event);\n });\n });\n _this.container.classList.add(\"active\");\n _this.setIndex(0);\n }\n return _this;\n }\n /**\n * Set the index of the active signature.\n *\n * @param index The index of the signature to activate.\n */\n Signature.prototype.setIndex = function (index) {\n if (index < 0)\n index = 0;\n if (index > this.groups.length - 1)\n index = this.groups.length - 1;\n if (this.index == index)\n return;\n var to = this.groups[index];\n if (this.index > -1) {\n var from_1 = this.groups[this.index];\n from_1.removeClass(\"current\").addClass(\"fade-out\");\n to.addClass(\"current\");\n to.addClass(\"fade-in\");\n _services_Viewport__WEBPACK_IMPORTED_MODULE_1__.Viewport.instance.triggerResize();\n setTimeout(function () {\n from_1.removeClass(\"fade-out\");\n to.removeClass(\"fade-in\");\n }, 300);\n }\n else {\n to.addClass(\"current\");\n _services_Viewport__WEBPACK_IMPORTED_MODULE_1__.Viewport.instance.triggerResize();\n }\n this.index = index;\n };\n /**\n * Find all signature/description groups.\n */\n Signature.prototype.createGroups = function () {\n var signatures = this.el.children;\n if (signatures.length < 2)\n return;\n this.container = this.el.nextElementSibling;\n var descriptions = this.container.children;\n this.groups = [];\n for (var index = 0; index < signatures.length; index++) {\n this.groups.push(new SignatureGroup(signatures[index], descriptions[index]));\n }\n };\n /**\n * Triggered when the user clicks onto a signature header.\n *\n * @param e The related event object.\n */\n Signature.prototype.onClick = function (e) {\n var _this = this;\n this.groups.forEach(function (group, index) {\n if (group.signature === e.currentTarget) {\n _this.setIndex(index);\n }\n });\n };\n return Signature;\n}(_Component__WEBPACK_IMPORTED_MODULE_0__.Component));\n\n\n\n//# sourceURL=webpack:///./default/assets/js/src/typedoc/components/Signature.ts?"); + +/***/ }), + +/***/ "./default/assets/js/src/typedoc/components/Toggle.ts": +/*!************************************************************!*\ + !*** ./default/assets/js/src/typedoc/components/Toggle.ts ***! + \************************************************************/ +/***/ ((__unused_webpack_module, __webpack_exports__, __webpack_require__) => { + +"use strict"; +eval("__webpack_require__.r(__webpack_exports__);\n/* harmony export */ __webpack_require__.d(__webpack_exports__, {\n/* harmony export */ \"Toggle\": () => /* binding */ Toggle\n/* harmony export */ });\n/* harmony import */ var _Component__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__(/*! ../Component */ \"./default/assets/js/src/typedoc/Component.ts\");\n/* harmony import */ var _utils_pointer__WEBPACK_IMPORTED_MODULE_1__ = __webpack_require__(/*! ../utils/pointer */ \"./default/assets/js/src/typedoc/utils/pointer.ts\");\nvar __extends = (undefined && undefined.__extends) || (function () {\n var extendStatics = function (d, b) {\n extendStatics = Object.setPrototypeOf ||\n ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||\n function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };\n return extendStatics(d, b);\n };\n return function (d, b) {\n extendStatics(d, b);\n function __() { this.constructor = d; }\n d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());\n };\n})();\n\n\nvar Toggle = /** @class */ (function (_super) {\n __extends(Toggle, _super);\n function Toggle(options) {\n var _this = _super.call(this, options) || this;\n _this.className = _this.el.dataset.toggle || \"\";\n _this.el.addEventListener(_utils_pointer__WEBPACK_IMPORTED_MODULE_1__.pointerUp, function (e) { return _this.onPointerUp(e); });\n _this.el.addEventListener(\"click\", function (e) { return e.preventDefault(); });\n document.addEventListener(_utils_pointer__WEBPACK_IMPORTED_MODULE_1__.pointerDown, function (e) {\n return _this.onDocumentPointerDown(e);\n });\n document.addEventListener(_utils_pointer__WEBPACK_IMPORTED_MODULE_1__.pointerUp, function (e) {\n return _this.onDocumentPointerUp(e);\n });\n return _this;\n }\n Toggle.prototype.setActive = function (value) {\n if (this.active == value)\n return;\n this.active = value;\n document.documentElement.classList.toggle(\"has-\" + this.className, value);\n this.el.classList.toggle(\"active\", value);\n var transition = (this.active ? \"to-has-\" : \"from-has-\") + this.className;\n document.documentElement.classList.add(transition);\n setTimeout(function () { return document.documentElement.classList.remove(transition); }, 500);\n };\n Toggle.prototype.onPointerUp = function (event) {\n if (_utils_pointer__WEBPACK_IMPORTED_MODULE_1__.hasPointerMoved)\n return;\n this.setActive(true);\n event.preventDefault();\n };\n Toggle.prototype.onDocumentPointerDown = function (e) {\n if (this.active) {\n if (e.target.closest(\".col-menu, .tsd-filter-group\")) {\n return;\n }\n this.setActive(false);\n }\n };\n Toggle.prototype.onDocumentPointerUp = function (e) {\n var _this = this;\n if (_utils_pointer__WEBPACK_IMPORTED_MODULE_1__.hasPointerMoved)\n return;\n if (this.active) {\n if (e.target.closest(\".col-menu\")) {\n var link = e.target.closest(\"a\");\n if (link) {\n var href = window.location.href;\n if (href.indexOf(\"#\") != -1) {\n href = href.substr(0, href.indexOf(\"#\"));\n }\n if (link.href.substr(0, href.length) == href) {\n setTimeout(function () { return _this.setActive(false); }, 250);\n }\n }\n }\n }\n };\n return Toggle;\n}(_Component__WEBPACK_IMPORTED_MODULE_0__.Component));\n\n\n\n//# sourceURL=webpack:///./default/assets/js/src/typedoc/components/Toggle.ts?"); + +/***/ }), + +/***/ "./default/assets/js/src/typedoc/services/Viewport.ts": +/*!************************************************************!*\ + !*** ./default/assets/js/src/typedoc/services/Viewport.ts ***! + \************************************************************/ +/***/ ((__unused_webpack_module, __webpack_exports__, __webpack_require__) => { + +"use strict"; +eval("__webpack_require__.r(__webpack_exports__);\n/* harmony export */ __webpack_require__.d(__webpack_exports__, {\n/* harmony export */ \"Viewport\": () => /* binding */ Viewport\n/* harmony export */ });\n/* harmony import */ var _EventTarget__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__(/*! ../EventTarget */ \"./default/assets/js/src/typedoc/EventTarget.ts\");\n/* harmony import */ var _utils_trottle__WEBPACK_IMPORTED_MODULE_1__ = __webpack_require__(/*! ../utils/trottle */ \"./default/assets/js/src/typedoc/utils/trottle.ts\");\nvar __extends = (undefined && undefined.__extends) || (function () {\n var extendStatics = function (d, b) {\n extendStatics = Object.setPrototypeOf ||\n ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||\n function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };\n return extendStatics(d, b);\n };\n return function (d, b) {\n extendStatics(d, b);\n function __() { this.constructor = d; }\n d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());\n };\n})();\n\n\n/**\n * A global service that monitors the window size and scroll position.\n */\nvar Viewport = /** @class */ (function (_super) {\n __extends(Viewport, _super);\n /**\n * Create new Viewport instance.\n */\n function Viewport() {\n var _this = _super.call(this) || this;\n /**\n * The current scroll position.\n */\n _this.scrollTop = 0;\n /**\n * The previous scrollTop.\n */\n _this.lastY = 0;\n /**\n * The width of the window.\n */\n _this.width = 0;\n /**\n * The height of the window.\n */\n _this.height = 0;\n /**\n * Boolean indicating whether the toolbar is shown.\n */\n _this.showToolbar = true;\n _this.toolbar = (document.querySelector(\".tsd-page-toolbar\"));\n _this.secondaryNav = (document.querySelector(\".tsd-navigation.secondary\"));\n window.addEventListener(\"scroll\", (0,_utils_trottle__WEBPACK_IMPORTED_MODULE_1__.throttle)(function () { return _this.onScroll(); }, 10));\n window.addEventListener(\"resize\", (0,_utils_trottle__WEBPACK_IMPORTED_MODULE_1__.throttle)(function () { return _this.onResize(); }, 10));\n _this.onResize();\n _this.onScroll();\n return _this;\n }\n /**\n * Trigger a resize event.\n */\n Viewport.prototype.triggerResize = function () {\n var event = new CustomEvent(\"resize\", {\n detail: {\n width: this.width,\n height: this.height,\n },\n });\n this.dispatchEvent(event);\n };\n /**\n * Triggered when the size of the window has changed.\n */\n Viewport.prototype.onResize = function () {\n this.width = window.innerWidth || 0;\n this.height = window.innerHeight || 0;\n var event = new CustomEvent(\"resize\", {\n detail: {\n width: this.width,\n height: this.height,\n },\n });\n this.dispatchEvent(event);\n };\n /**\n * Triggered when the user scrolled the viewport.\n */\n Viewport.prototype.onScroll = function () {\n this.scrollTop = window.scrollY || 0;\n var event = new CustomEvent(\"scroll\", {\n detail: {\n scrollTop: this.scrollTop,\n },\n });\n this.dispatchEvent(event);\n this.hideShowToolbar();\n };\n /**\n * Handle hiding/showing of the toolbar.\n */\n Viewport.prototype.hideShowToolbar = function () {\n var isShown = this.showToolbar;\n this.showToolbar = this.lastY >= this.scrollTop || this.scrollTop <= 0;\n if (isShown !== this.showToolbar) {\n this.toolbar.classList.toggle(\"tsd-page-toolbar--hide\");\n this.secondaryNav.classList.toggle(\"tsd-navigation--toolbar-hide\");\n }\n this.lastY = this.scrollTop;\n };\n Viewport.instance = new Viewport();\n return Viewport;\n}(_EventTarget__WEBPACK_IMPORTED_MODULE_0__.EventTarget));\n\n\n\n//# sourceURL=webpack:///./default/assets/js/src/typedoc/services/Viewport.ts?"); + +/***/ }), + +/***/ "./default/assets/js/src/typedoc/utils/debounce.ts": +/*!*********************************************************!*\ + !*** ./default/assets/js/src/typedoc/utils/debounce.ts ***! + \*********************************************************/ +/***/ ((__unused_webpack_module, __webpack_exports__, __webpack_require__) => { + +"use strict"; +eval("__webpack_require__.r(__webpack_exports__);\n/* harmony export */ __webpack_require__.d(__webpack_exports__, {\n/* harmony export */ \"debounce\": () => /* binding */ debounce\n/* harmony export */ });\nvar debounce = function (fn, wait) {\n if (wait === void 0) { wait = 100; }\n var timeout;\n return function () {\n var args = [];\n for (var _i = 0; _i < arguments.length; _i++) {\n args[_i] = arguments[_i];\n }\n clearTimeout(timeout);\n timeout = setTimeout(function () { return fn(args); }, wait);\n };\n};\n\n\n//# sourceURL=webpack:///./default/assets/js/src/typedoc/utils/debounce.ts?"); + +/***/ }), + +/***/ "./default/assets/js/src/typedoc/utils/pointer.ts": +/*!********************************************************!*\ + !*** ./default/assets/js/src/typedoc/utils/pointer.ts ***! + \********************************************************/ +/***/ ((__unused_webpack_module, __webpack_exports__, __webpack_require__) => { + +"use strict"; +eval("__webpack_require__.r(__webpack_exports__);\n/* harmony export */ __webpack_require__.d(__webpack_exports__, {\n/* harmony export */ \"pointerDown\": () => /* binding */ pointerDown,\n/* harmony export */ \"pointerMove\": () => /* binding */ pointerMove,\n/* harmony export */ \"pointerUp\": () => /* binding */ pointerUp,\n/* harmony export */ \"pointerDownPosition\": () => /* binding */ pointerDownPosition,\n/* harmony export */ \"preventNextClick\": () => /* binding */ preventNextClick,\n/* harmony export */ \"isPointerDown\": () => /* binding */ isPointerDown,\n/* harmony export */ \"isPointerTouch\": () => /* binding */ isPointerTouch,\n/* harmony export */ \"hasPointerMoved\": () => /* binding */ hasPointerMoved,\n/* harmony export */ \"isMobile\": () => /* binding */ isMobile\n/* harmony export */ });\n/**\n * Event name of the pointer down event.\n */\nvar pointerDown = \"mousedown\";\n/**\n * Event name of the pointer move event.\n */\nvar pointerMove = \"mousemove\";\n/**\n * Event name of the pointer up event.\n */\nvar pointerUp = \"mouseup\";\n/**\n * Position the pointer was pressed at.\n */\nvar pointerDownPosition = { x: 0, y: 0 };\n/**\n * Should the next click on the document be supressed?\n */\nvar preventNextClick = false;\n/**\n * Is the pointer down?\n */\nvar isPointerDown = false;\n/**\n * Is the pointer a touch point?\n */\nvar isPointerTouch = false;\n/**\n * Did the pointer move since the last down event?\n */\nvar hasPointerMoved = false;\n/**\n * Is the user agent a mobile agent?\n */\nvar isMobile = /Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);\ndocument.documentElement.classList.add(isMobile ? \"is-mobile\" : \"not-mobile\");\nif (isMobile && \"ontouchstart\" in document.documentElement) {\n isPointerTouch = true;\n pointerDown = \"touchstart\";\n pointerMove = \"touchmove\";\n pointerUp = \"touchend\";\n}\ndocument.addEventListener(pointerDown, function (e) {\n isPointerDown = true;\n hasPointerMoved = false;\n var t = pointerDown == \"touchstart\"\n ? e.targetTouches[0]\n : e;\n pointerDownPosition.y = t.pageY || 0;\n pointerDownPosition.x = t.pageX || 0;\n});\ndocument.addEventListener(pointerMove, function (e) {\n if (!isPointerDown)\n return;\n if (!hasPointerMoved) {\n var t = pointerDown == \"touchstart\"\n ? e.targetTouches[0]\n : e;\n var x = pointerDownPosition.x - (t.pageX || 0);\n var y = pointerDownPosition.y - (t.pageY || 0);\n hasPointerMoved = Math.sqrt(x * x + y * y) > 10;\n }\n});\ndocument.addEventListener(pointerUp, function () {\n isPointerDown = false;\n});\ndocument.addEventListener(\"click\", function (e) {\n if (preventNextClick) {\n e.preventDefault();\n e.stopImmediatePropagation();\n preventNextClick = false;\n }\n});\n\n\n//# sourceURL=webpack:///./default/assets/js/src/typedoc/utils/pointer.ts?"); + +/***/ }), + +/***/ "./default/assets/js/src/typedoc/utils/trottle.ts": +/*!********************************************************!*\ + !*** ./default/assets/js/src/typedoc/utils/trottle.ts ***! + \********************************************************/ +/***/ ((__unused_webpack_module, __webpack_exports__, __webpack_require__) => { + +"use strict"; +eval("__webpack_require__.r(__webpack_exports__);\n/* harmony export */ __webpack_require__.d(__webpack_exports__, {\n/* harmony export */ \"throttle\": () => /* binding */ throttle\n/* harmony export */ });\nvar throttle = function (fn, wait) {\n if (wait === void 0) { wait = 100; }\n var time = Date.now();\n return function () {\n var args = [];\n for (var _i = 0; _i < arguments.length; _i++) {\n args[_i] = arguments[_i];\n }\n if (time + wait - Date.now() < 0) {\n fn.apply(void 0, args);\n time = Date.now();\n }\n };\n};\n\n\n//# sourceURL=webpack:///./default/assets/js/src/typedoc/utils/trottle.ts?"); + +/***/ }) + +/******/ }); +/************************************************************************/ +/******/ // The module cache +/******/ var __webpack_module_cache__ = {}; +/******/ +/******/ // The require function +/******/ function __webpack_require__(moduleId) { +/******/ // Check if module is in cache +/******/ if(__webpack_module_cache__[moduleId]) { +/******/ return __webpack_module_cache__[moduleId].exports; +/******/ } +/******/ // Create a new module (and put it into the cache) +/******/ var module = __webpack_module_cache__[moduleId] = { +/******/ // no module.id needed +/******/ // no module.loaded needed +/******/ exports: {} +/******/ }; +/******/ +/******/ // Execute the module function +/******/ __webpack_modules__[moduleId](module, module.exports, __webpack_require__); +/******/ +/******/ // Return the exports of the module +/******/ return module.exports; +/******/ } +/******/ +/************************************************************************/ +/******/ /* webpack/runtime/compat get default export */ +/******/ (() => { +/******/ // getDefaultExport function for compatibility with non-harmony modules +/******/ __webpack_require__.n = (module) => { +/******/ var getter = module && module.__esModule ? +/******/ () => module['default'] : +/******/ () => module; +/******/ __webpack_require__.d(getter, { a: getter }); +/******/ return getter; +/******/ }; +/******/ })(); +/******/ +/******/ /* webpack/runtime/define property getters */ +/******/ (() => { +/******/ // define getter functions for harmony exports +/******/ __webpack_require__.d = (exports, definition) => { +/******/ for(var key in definition) { +/******/ if(__webpack_require__.o(definition, key) && !__webpack_require__.o(exports, key)) { +/******/ Object.defineProperty(exports, key, { enumerable: true, get: definition[key] }); +/******/ } +/******/ } +/******/ }; +/******/ })(); +/******/ +/******/ /* webpack/runtime/hasOwnProperty shorthand */ +/******/ (() => { +/******/ __webpack_require__.o = (obj, prop) => Object.prototype.hasOwnProperty.call(obj, prop) +/******/ })(); +/******/ +/******/ /* webpack/runtime/make namespace object */ +/******/ (() => { +/******/ // define __esModule on exports +/******/ __webpack_require__.r = (exports) => { +/******/ if(typeof Symbol !== 'undefined' && Symbol.toStringTag) { +/******/ Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' }); +/******/ } +/******/ Object.defineProperty(exports, '__esModule', { value: true }); +/******/ }; +/******/ })(); +/******/ +/************************************************************************/ +/******/ // startup +/******/ // Load entry module +/******/ __webpack_require__("./default/assets/js/src/bootstrap.ts"); +/******/ // This entry module used 'exports' so it can't be inlined +/******/ })() +; \ No newline at end of file diff --git a/docs/assets/js/search.js b/docs/assets/js/search.js new file mode 100644 index 000000000..9cac81346 --- /dev/null +++ b/docs/assets/js/search.js @@ -0,0 +1 @@ +window.searchData = {"kinds":{"1":"Module","4":"Enumeration","16":"Enumeration member","64":"Function","128":"Class","256":"Interface","512":"Constructor","1024":"Property","65536":"Type literal","4194304":"Type alias"},"rows":[{"id":0,"kind":1,"name":"SelfServe","url":"modules/selfserve.html","classes":"tsd-kind-module"},{"id":1,"kind":1,"name":"SelfServe - What is currently supported?","url":"modules/selfserve___what_is_currently_supported_.html","classes":"tsd-kind-module"},{"id":2,"kind":1,"name":"SelfServe/Decorators","url":"modules/selfserve_decorators.html","classes":"tsd-kind-module"},{"id":3,"kind":256,"name":"NumberInputOptions","url":"interfaces/selfserve_decorators.numberinputoptions.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"SelfServe/Decorators"},{"id":4,"kind":1024,"name":"min","url":"interfaces/selfserve_decorators.numberinputoptions.html#min","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"SelfServe/Decorators.NumberInputOptions"},{"id":5,"kind":1024,"name":"max","url":"interfaces/selfserve_decorators.numberinputoptions.html#max","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"SelfServe/Decorators.NumberInputOptions"},{"id":6,"kind":1024,"name":"step","url":"interfaces/selfserve_decorators.numberinputoptions.html#step","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"SelfServe/Decorators.NumberInputOptions"},{"id":7,"kind":1024,"name":"uiType","url":"interfaces/selfserve_decorators.numberinputoptions.html#uitype","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"SelfServe/Decorators.NumberInputOptions"},{"id":8,"kind":1024,"name":"labelTKey","url":"interfaces/selfserve_decorators.numberinputoptions.html#labeltkey","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"SelfServe/Decorators.NumberInputOptions"},{"id":9,"kind":256,"name":"StringInputOptions","url":"interfaces/selfserve_decorators.stringinputoptions.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"SelfServe/Decorators"},{"id":10,"kind":1024,"name":"placeholderTKey","url":"interfaces/selfserve_decorators.stringinputoptions.html#placeholdertkey","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"SelfServe/Decorators.StringInputOptions"},{"id":11,"kind":1024,"name":"labelTKey","url":"interfaces/selfserve_decorators.stringinputoptions.html#labeltkey","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"SelfServe/Decorators.StringInputOptions"},{"id":12,"kind":256,"name":"BooleanInputOptions","url":"interfaces/selfserve_decorators.booleaninputoptions.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"SelfServe/Decorators"},{"id":13,"kind":1024,"name":"trueLabelTKey","url":"interfaces/selfserve_decorators.booleaninputoptions.html#truelabeltkey","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"SelfServe/Decorators.BooleanInputOptions"},{"id":14,"kind":1024,"name":"falseLabelTKey","url":"interfaces/selfserve_decorators.booleaninputoptions.html#falselabeltkey","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"SelfServe/Decorators.BooleanInputOptions"},{"id":15,"kind":1024,"name":"labelTKey","url":"interfaces/selfserve_decorators.booleaninputoptions.html#labeltkey","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"SelfServe/Decorators.BooleanInputOptions"},{"id":16,"kind":256,"name":"ChoiceInputOptions","url":"interfaces/selfserve_decorators.choiceinputoptions.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"SelfServe/Decorators"},{"id":17,"kind":1024,"name":"choices","url":"interfaces/selfserve_decorators.choiceinputoptions.html#choices","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"SelfServe/Decorators.ChoiceInputOptions"},{"id":18,"kind":1024,"name":"placeholderTKey","url":"interfaces/selfserve_decorators.choiceinputoptions.html#placeholdertkey","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"SelfServe/Decorators.ChoiceInputOptions"},{"id":19,"kind":1024,"name":"labelTKey","url":"interfaces/selfserve_decorators.choiceinputoptions.html#labeltkey","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"SelfServe/Decorators.ChoiceInputOptions"},{"id":20,"kind":256,"name":"DescriptionDisplayOptions","url":"interfaces/selfserve_decorators.descriptiondisplayoptions.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"SelfServe/Decorators"},{"id":21,"kind":1024,"name":"labelTKey","url":"interfaces/selfserve_decorators.descriptiondisplayoptions.html#labeltkey","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"SelfServe/Decorators.DescriptionDisplayOptions"},{"id":22,"kind":1024,"name":"description","url":"interfaces/selfserve_decorators.descriptiondisplayoptions.html#description","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"SelfServe/Decorators.DescriptionDisplayOptions"},{"id":23,"kind":1024,"name":"isDynamicDescription","url":"interfaces/selfserve_decorators.descriptiondisplayoptions.html#isdynamicdescription","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"SelfServe/Decorators.DescriptionDisplayOptions"},{"id":24,"kind":4194304,"name":"InputOptions","url":"modules/selfserve_decorators.html#inputoptions","classes":"tsd-kind-type-alias tsd-parent-kind-module","parent":"SelfServe/Decorators"},{"id":25,"kind":64,"name":"OnChange","url":"modules/selfserve_decorators.html#onchange","classes":"tsd-kind-function tsd-parent-kind-module","parent":"SelfServe/Decorators"},{"id":26,"kind":64,"name":"PropertyInfo","url":"modules/selfserve_decorators.html#propertyinfo","classes":"tsd-kind-function tsd-parent-kind-module","parent":"SelfServe/Decorators"},{"id":27,"kind":64,"name":"Values","url":"modules/selfserve_decorators.html#values","classes":"tsd-kind-function tsd-parent-kind-module","parent":"SelfServe/Decorators"},{"id":28,"kind":64,"name":"IsDisplayable","url":"modules/selfserve_decorators.html#isdisplayable","classes":"tsd-kind-function tsd-parent-kind-module","parent":"SelfServe/Decorators"},{"id":29,"kind":64,"name":"RefreshOptions","url":"modules/selfserve_decorators.html#refreshoptions","classes":"tsd-kind-function tsd-parent-kind-module","parent":"SelfServe/Decorators"},{"id":30,"kind":1,"name":"SelfServe/SelfServeTypes","url":"modules/selfserve_selfservetypes.html","classes":"tsd-kind-module"},{"id":31,"kind":4194304,"name":"initializeCallback","url":"modules/selfserve_selfservetypes.html#initializecallback","classes":"tsd-kind-type-alias tsd-parent-kind-module","parent":"SelfServe/SelfServeTypes"},{"id":32,"kind":65536,"name":"__type","url":"modules/selfserve_selfservetypes.html#initializecallback.__type-2","classes":"tsd-kind-type-literal tsd-parent-kind-type-alias","parent":"SelfServe/SelfServeTypes.initializeCallback"},{"id":33,"kind":4194304,"name":"onSaveCallback","url":"modules/selfserve_selfservetypes.html#onsavecallback","classes":"tsd-kind-type-alias tsd-parent-kind-module","parent":"SelfServe/SelfServeTypes"},{"id":34,"kind":65536,"name":"__type","url":"modules/selfserve_selfservetypes.html#onsavecallback.__type-3","classes":"tsd-kind-type-literal tsd-parent-kind-type-alias","parent":"SelfServe/SelfServeTypes.onSaveCallback"},{"id":35,"kind":128,"name":"SelfServeBaseClass","url":"classes/selfserve_selfservetypes.selfservebaseclass.html","classes":"tsd-kind-class tsd-parent-kind-module","parent":"SelfServe/SelfServeTypes"},{"id":36,"kind":512,"name":"constructor","url":"classes/selfserve_selfservetypes.selfservebaseclass.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"SelfServe/SelfServeTypes.SelfServeBaseClass"},{"id":37,"kind":1024,"name":"initialize","url":"classes/selfserve_selfservetypes.selfservebaseclass.html#initialize","classes":"tsd-kind-property tsd-parent-kind-class","parent":"SelfServe/SelfServeTypes.SelfServeBaseClass"},{"id":38,"kind":1024,"name":"onSave","url":"classes/selfserve_selfservetypes.selfservebaseclass.html#onsave","classes":"tsd-kind-property tsd-parent-kind-class","parent":"SelfServe/SelfServeTypes.SelfServeBaseClass"},{"id":39,"kind":1024,"name":"onRefresh","url":"classes/selfserve_selfservetypes.selfservebaseclass.html#onrefresh","classes":"tsd-kind-property tsd-parent-kind-class","parent":"SelfServe/SelfServeTypes.SelfServeBaseClass"},{"id":40,"kind":65536,"name":"__type","url":"classes/selfserve_selfservetypes.selfservebaseclass.html#__type","classes":"tsd-kind-type-literal tsd-parent-kind-class","parent":"SelfServe/SelfServeTypes.SelfServeBaseClass"},{"id":41,"kind":4194304,"name":"OnChangeCallback","url":"modules/selfserve_selfservetypes.html#onchangecallback","classes":"tsd-kind-type-alias tsd-parent-kind-module","parent":"SelfServe/SelfServeTypes"},{"id":42,"kind":65536,"name":"__type","url":"modules/selfserve_selfservetypes.html#onchangecallback.__type-1","classes":"tsd-kind-type-literal tsd-parent-kind-type-alias","parent":"SelfServe/SelfServeTypes.OnChangeCallback"},{"id":43,"kind":4,"name":"NumberUiType","url":"enums/selfserve_selfservetypes.numberuitype.html","classes":"tsd-kind-enum tsd-parent-kind-module","parent":"SelfServe/SelfServeTypes"},{"id":44,"kind":16,"name":"Spinner","url":"enums/selfserve_selfservetypes.numberuitype.html#spinner","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"SelfServe/SelfServeTypes.NumberUiType"},{"id":45,"kind":16,"name":"Slider","url":"enums/selfserve_selfservetypes.numberuitype.html#slider","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"SelfServe/SelfServeTypes.NumberUiType"},{"id":46,"kind":4194304,"name":"ChoiceItem","url":"modules/selfserve_selfservetypes.html#choiceitem","classes":"tsd-kind-type-alias tsd-parent-kind-module","parent":"SelfServe/SelfServeTypes"},{"id":47,"kind":65536,"name":"__type","url":"modules/selfserve_selfservetypes.html#choiceitem.__type","classes":"tsd-kind-type-literal tsd-parent-kind-type-alias","parent":"SelfServe/SelfServeTypes.ChoiceItem"},{"id":48,"kind":1024,"name":"labelTKey","url":"modules/selfserve_selfservetypes.html#choiceitem.__type.labeltkey","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"SelfServe/SelfServeTypes.ChoiceItem.__type"},{"id":49,"kind":1024,"name":"key","url":"modules/selfserve_selfservetypes.html#choiceitem.__type.key","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"SelfServe/SelfServeTypes.ChoiceItem.__type"},{"id":50,"kind":4194304,"name":"InputType","url":"modules/selfserve_selfservetypes.html#inputtype","classes":"tsd-kind-type-alias tsd-parent-kind-module","parent":"SelfServe/SelfServeTypes"},{"id":51,"kind":256,"name":"Info","url":"interfaces/selfserve_selfservetypes.info.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"SelfServe/SelfServeTypes"},{"id":52,"kind":1024,"name":"messageTKey","url":"interfaces/selfserve_selfservetypes.info.html#messagetkey","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"SelfServe/SelfServeTypes.Info"},{"id":53,"kind":1024,"name":"link","url":"interfaces/selfserve_selfservetypes.info.html#link","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"SelfServe/SelfServeTypes.Info"},{"id":54,"kind":65536,"name":"__type","url":"interfaces/selfserve_selfservetypes.info.html#__type","classes":"tsd-kind-type-literal tsd-parent-kind-interface","parent":"SelfServe/SelfServeTypes.Info"},{"id":55,"kind":1024,"name":"href","url":"interfaces/selfserve_selfservetypes.info.html#__type.href","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"SelfServe/SelfServeTypes.Info.__type"},{"id":56,"kind":1024,"name":"textTKey","url":"interfaces/selfserve_selfservetypes.info.html#__type.texttkey","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"SelfServe/SelfServeTypes.Info.__type"},{"id":57,"kind":4,"name":"DescriptionType","url":"enums/selfserve_selfservetypes.descriptiontype.html","classes":"tsd-kind-enum tsd-parent-kind-module","parent":"SelfServe/SelfServeTypes"},{"id":58,"kind":16,"name":"Text","url":"enums/selfserve_selfservetypes.descriptiontype.html#text","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"SelfServe/SelfServeTypes.DescriptionType"},{"id":59,"kind":16,"name":"InfoMessageBar","url":"enums/selfserve_selfservetypes.descriptiontype.html#infomessagebar","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"SelfServe/SelfServeTypes.DescriptionType"},{"id":60,"kind":16,"name":"WarningMessageBar","url":"enums/selfserve_selfservetypes.descriptiontype.html#warningmessagebar","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"SelfServe/SelfServeTypes.DescriptionType"},{"id":61,"kind":256,"name":"Description","url":"interfaces/selfserve_selfservetypes.description.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"SelfServe/SelfServeTypes"},{"id":62,"kind":1024,"name":"textTKey","url":"interfaces/selfserve_selfservetypes.description.html#texttkey-1","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"SelfServe/SelfServeTypes.Description"},{"id":63,"kind":1024,"name":"type","url":"interfaces/selfserve_selfservetypes.description.html#type","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"SelfServe/SelfServeTypes.Description"},{"id":64,"kind":1024,"name":"link","url":"interfaces/selfserve_selfservetypes.description.html#link","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"SelfServe/SelfServeTypes.Description"},{"id":65,"kind":65536,"name":"__type","url":"interfaces/selfserve_selfservetypes.description.html#__type","classes":"tsd-kind-type-literal tsd-parent-kind-interface","parent":"SelfServe/SelfServeTypes.Description"},{"id":66,"kind":1024,"name":"href","url":"interfaces/selfserve_selfservetypes.description.html#__type.href","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"SelfServe/SelfServeTypes.Description.__type"},{"id":67,"kind":1024,"name":"textTKey","url":"interfaces/selfserve_selfservetypes.description.html#__type.texttkey","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"SelfServe/SelfServeTypes.Description.__type"},{"id":68,"kind":256,"name":"SmartUiInput","url":"interfaces/selfserve_selfservetypes.smartuiinput.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"SelfServe/SelfServeTypes"},{"id":69,"kind":1024,"name":"value","url":"interfaces/selfserve_selfservetypes.smartuiinput.html#value","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"SelfServe/SelfServeTypes.SmartUiInput"},{"id":70,"kind":1024,"name":"hidden","url":"interfaces/selfserve_selfservetypes.smartuiinput.html#hidden","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"SelfServe/SelfServeTypes.SmartUiInput"},{"id":71,"kind":1024,"name":"disabled","url":"interfaces/selfserve_selfservetypes.smartuiinput.html#disabled","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"SelfServe/SelfServeTypes.SmartUiInput"},{"id":72,"kind":256,"name":"OnSaveResult","url":"interfaces/selfserve_selfservetypes.onsaveresult.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"SelfServe/SelfServeTypes"},{"id":73,"kind":1024,"name":"operationStatusUrl","url":"interfaces/selfserve_selfservetypes.onsaveresult.html#operationstatusurl","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"SelfServe/SelfServeTypes.OnSaveResult"},{"id":74,"kind":1024,"name":"portalNotification","url":"interfaces/selfserve_selfservetypes.onsaveresult.html#portalnotification","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"SelfServe/SelfServeTypes.OnSaveResult"},{"id":75,"kind":65536,"name":"__type","url":"interfaces/selfserve_selfservetypes.onsaveresult.html#__type","classes":"tsd-kind-type-literal tsd-parent-kind-interface","parent":"SelfServe/SelfServeTypes.OnSaveResult"},{"id":76,"kind":1024,"name":"initialize","url":"interfaces/selfserve_selfservetypes.onsaveresult.html#__type.initialize","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"SelfServe/SelfServeTypes.OnSaveResult.__type"},{"id":77,"kind":65536,"name":"__type","url":"interfaces/selfserve_selfservetypes.onsaveresult.html#__type.__type-2","classes":"tsd-kind-type-literal tsd-parent-kind-type-literal","parent":"SelfServe/SelfServeTypes.OnSaveResult.__type"},{"id":78,"kind":1024,"name":"titleTKey","url":"interfaces/selfserve_selfservetypes.onsaveresult.html#__type.__type-2.titletkey-1","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"SelfServe/SelfServeTypes.OnSaveResult.__type.__type"},{"id":79,"kind":1024,"name":"messageTKey","url":"interfaces/selfserve_selfservetypes.onsaveresult.html#__type.__type-2.messagetkey-1","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"SelfServe/SelfServeTypes.OnSaveResult.__type.__type"},{"id":80,"kind":1024,"name":"success","url":"interfaces/selfserve_selfservetypes.onsaveresult.html#__type.success","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"SelfServe/SelfServeTypes.OnSaveResult.__type"},{"id":81,"kind":65536,"name":"__type","url":"interfaces/selfserve_selfservetypes.onsaveresult.html#__type.__type-3","classes":"tsd-kind-type-literal tsd-parent-kind-type-literal","parent":"SelfServe/SelfServeTypes.OnSaveResult.__type"},{"id":82,"kind":1024,"name":"titleTKey","url":"interfaces/selfserve_selfservetypes.onsaveresult.html#__type.__type-3.titletkey-2","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"SelfServe/SelfServeTypes.OnSaveResult.__type.__type"},{"id":83,"kind":1024,"name":"messageTKey","url":"interfaces/selfserve_selfservetypes.onsaveresult.html#__type.__type-3.messagetkey-2","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"SelfServe/SelfServeTypes.OnSaveResult.__type.__type"},{"id":84,"kind":1024,"name":"failure","url":"interfaces/selfserve_selfservetypes.onsaveresult.html#__type.failure","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"SelfServe/SelfServeTypes.OnSaveResult.__type"},{"id":85,"kind":65536,"name":"__type","url":"interfaces/selfserve_selfservetypes.onsaveresult.html#__type.__type-1","classes":"tsd-kind-type-literal tsd-parent-kind-type-literal","parent":"SelfServe/SelfServeTypes.OnSaveResult.__type"},{"id":86,"kind":1024,"name":"titleTKey","url":"interfaces/selfserve_selfservetypes.onsaveresult.html#__type.__type-1.titletkey","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"SelfServe/SelfServeTypes.OnSaveResult.__type.__type"},{"id":87,"kind":1024,"name":"messageTKey","url":"interfaces/selfserve_selfservetypes.onsaveresult.html#__type.__type-1.messagetkey","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"SelfServe/SelfServeTypes.OnSaveResult.__type.__type"},{"id":88,"kind":256,"name":"RefreshResult","url":"interfaces/selfserve_selfservetypes.refreshresult.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"SelfServe/SelfServeTypes"},{"id":89,"kind":1024,"name":"isUpdateInProgress","url":"interfaces/selfserve_selfservetypes.refreshresult.html#isupdateinprogress","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"SelfServe/SelfServeTypes.RefreshResult"},{"id":90,"kind":1024,"name":"updateInProgressMessageTKey","url":"interfaces/selfserve_selfservetypes.refreshresult.html#updateinprogressmessagetkey","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"SelfServe/SelfServeTypes.RefreshResult"},{"id":91,"kind":256,"name":"RefreshParams","url":"interfaces/selfserve_selfservetypes.refreshparams.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"SelfServe/SelfServeTypes"},{"id":92,"kind":1024,"name":"retryIntervalInMs","url":"interfaces/selfserve_selfservetypes.refreshparams.html#retryintervalinms","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"SelfServe/SelfServeTypes.RefreshParams"},{"id":93,"kind":256,"name":"SelfServeTelemetryMessage","url":"interfaces/selfserve_selfservetypes.selfservetelemetrymessage.html","classes":"tsd-kind-interface tsd-parent-kind-module","parent":"SelfServe/SelfServeTypes"},{"id":94,"kind":1024,"name":"selfServeClassName","url":"interfaces/selfserve_selfservetypes.selfservetelemetrymessage.html#selfserveclassname","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"SelfServe/SelfServeTypes.SelfServeTelemetryMessage"},{"id":95,"kind":1,"name":"SelfServe/SelfServeUtils","url":"modules/selfserve_selfserveutils.html","classes":"tsd-kind-module"},{"id":96,"kind":4,"name":"SelfServeType","url":"enums/selfserve_selfserveutils.selfservetype.html","classes":"tsd-kind-enum tsd-parent-kind-module","parent":"SelfServe/SelfServeUtils"},{"id":97,"kind":16,"name":"invalid","url":"enums/selfserve_selfserveutils.selfservetype.html#invalid","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"SelfServe/SelfServeUtils.SelfServeType"},{"id":98,"kind":16,"name":"example","url":"enums/selfserve_selfserveutils.selfservetype.html#example","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"SelfServe/SelfServeUtils.SelfServeType"},{"id":99,"kind":16,"name":"sqlx","url":"enums/selfserve_selfserveutils.selfservetype.html#sqlx","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"SelfServe/SelfServeUtils.SelfServeType"},{"id":100,"kind":4,"name":"BladeType","url":"enums/selfserve_selfserveutils.bladetype.html","classes":"tsd-kind-enum tsd-parent-kind-module","parent":"SelfServe/SelfServeUtils"},{"id":101,"kind":16,"name":"SqlKeys","url":"enums/selfserve_selfserveutils.bladetype.html#sqlkeys","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"SelfServe/SelfServeUtils.BladeType"},{"id":102,"kind":16,"name":"MongoKeys","url":"enums/selfserve_selfserveutils.bladetype.html#mongokeys","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"SelfServe/SelfServeUtils.BladeType"},{"id":103,"kind":16,"name":"CassandraKeys","url":"enums/selfserve_selfserveutils.bladetype.html#cassandrakeys","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"SelfServe/SelfServeUtils.BladeType"},{"id":104,"kind":16,"name":"GremlinKeys","url":"enums/selfserve_selfserveutils.bladetype.html#gremlinkeys","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"SelfServe/SelfServeUtils.BladeType"},{"id":105,"kind":16,"name":"TableKeys","url":"enums/selfserve_selfserveutils.bladetype.html#tablekeys","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"SelfServe/SelfServeUtils.BladeType"},{"id":106,"kind":16,"name":"Metrics","url":"enums/selfserve_selfserveutils.bladetype.html#metrics","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"SelfServe/SelfServeUtils.BladeType"},{"id":107,"kind":64,"name":"generateBladeLink","url":"modules/selfserve_selfserveutils.html#generatebladelink","classes":"tsd-kind-function tsd-parent-kind-module","parent":"SelfServe/SelfServeUtils"},{"id":108,"kind":1,"name":"SelfServe/SelfServeTelemetryProcessor","url":"modules/selfserve_selfservetelemetryprocessor.html","classes":"tsd-kind-module"},{"id":109,"kind":64,"name":"selfServeTrace","url":"modules/selfserve_selfservetelemetryprocessor.html#selfservetrace","classes":"tsd-kind-function tsd-parent-kind-module","parent":"SelfServe/SelfServeTelemetryProcessor"},{"id":110,"kind":64,"name":"selfServeTraceStart","url":"modules/selfserve_selfservetelemetryprocessor.html#selfservetracestart","classes":"tsd-kind-function tsd-parent-kind-module","parent":"SelfServe/SelfServeTelemetryProcessor"},{"id":111,"kind":64,"name":"selfServeTraceSuccess","url":"modules/selfserve_selfservetelemetryprocessor.html#selfservetracesuccess","classes":"tsd-kind-function tsd-parent-kind-module","parent":"SelfServe/SelfServeTelemetryProcessor"},{"id":112,"kind":64,"name":"selfServeTraceFailure","url":"modules/selfserve_selfservetelemetryprocessor.html#selfservetracefailure","classes":"tsd-kind-function tsd-parent-kind-module","parent":"SelfServe/SelfServeTelemetryProcessor"},{"id":113,"kind":64,"name":"selfServeTraceCancel","url":"modules/selfserve_selfservetelemetryprocessor.html#selfservetracecancel","classes":"tsd-kind-function tsd-parent-kind-module","parent":"SelfServe/SelfServeTelemetryProcessor"}],"index":{"version":"2.3.9","fields":["name","parent"],"fieldVectors":[["name/0",[0,38.825]],["parent/0",[]],["name/1",[0,14.915,1,16.905,2,16.905,3,16.905,4,16.905]],["parent/1",[]],["name/2",[5,22.504]],["parent/2",[]],["name/3",[6,44.005]],["parent/3",[5,2.17]],["name/4",[7,44.005]],["parent/4",[8,2.973]],["name/5",[9,44.005]],["parent/5",[8,2.973]],["name/6",[10,44.005]],["parent/6",[8,2.973]],["name/7",[11,44.005]],["parent/7",[8,2.973]],["name/8",[12,29.135]],["parent/8",[8,2.973]],["name/9",[13,44.005]],["parent/9",[5,2.17]],["name/10",[14,38.825]],["parent/10",[15,3.744]],["name/11",[12,29.135]],["parent/11",[15,3.744]],["name/12",[16,44.005]],["parent/12",[5,2.17]],["name/13",[17,44.005]],["parent/13",[18,3.415]],["name/14",[19,44.005]],["parent/14",[18,3.415]],["name/15",[12,29.135]],["parent/15",[18,3.415]],["name/16",[20,44.005]],["parent/16",[5,2.17]],["name/17",[21,44.005]],["parent/17",[22,3.415]],["name/18",[14,38.825]],["parent/18",[22,3.415]],["name/19",[12,29.135]],["parent/19",[22,3.415]],["name/20",[23,44.005]],["parent/20",[5,2.17]],["name/21",[12,29.135]],["parent/21",[24,3.415]],["name/22",[25,38.825]],["parent/22",[24,3.415]],["name/23",[26,44.005]],["parent/23",[24,3.415]],["name/24",[27,44.005]],["parent/24",[5,2.17]],["name/25",[28,44.005]],["parent/25",[5,2.17]],["name/26",[29,44.005]],["parent/26",[5,2.17]],["name/27",[30,44.005]],["parent/27",[5,2.17]],["name/28",[31,44.005]],["parent/28",[5,2.17]],["name/29",[32,44.005]],["parent/29",[5,2.17]],["name/30",[33,19.689]],["parent/30",[]],["name/31",[34,44.005]],["parent/31",[33,1.898]],["name/32",[35,23.35]],["parent/32",[36,4.243]],["name/33",[37,44.005]],["parent/33",[33,1.898]],["name/34",[35,23.35]],["parent/34",[38,4.243]],["name/35",[39,44.005]],["parent/35",[33,1.898]],["name/36",[40,44.005]],["parent/36",[41,2.973]],["name/37",[42,38.825]],["parent/37",[41,2.973]],["name/38",[43,44.005]],["parent/38",[41,2.973]],["name/39",[44,44.005]],["parent/39",[41,2.973]],["name/40",[35,23.35]],["parent/40",[41,2.973]],["name/41",[45,44.005]],["parent/41",[33,1.898]],["name/42",[35,23.35]],["parent/42",[46,4.243]],["name/43",[47,44.005]],["parent/43",[33,1.898]],["name/44",[48,44.005]],["parent/44",[49,3.744]],["name/45",[50,44.005]],["parent/45",[49,3.744]],["name/46",[51,44.005]],["parent/46",[33,1.898]],["name/47",[35,23.35]],["parent/47",[52,4.243]],["name/48",[12,29.135]],["parent/48",[53,3.744]],["name/49",[54,44.005]],["parent/49",[53,3.744]],["name/50",[55,44.005]],["parent/50",[33,1.898]],["name/51",[56,44.005]],["parent/51",[33,1.898]],["name/52",[57,32.864]],["parent/52",[58,3.415]],["name/53",[59,38.825]],["parent/53",[58,3.415]],["name/54",[35,23.35]],["parent/54",[58,3.415]],["name/55",[60,38.825]],["parent/55",[61,3.744]],["name/56",[62,35.413]],["parent/56",[61,3.744]],["name/57",[63,44.005]],["parent/57",[33,1.898]],["name/58",[64,44.005]],["parent/58",[65,3.415]],["name/59",[66,44.005]],["parent/59",[65,3.415]],["name/60",[67,44.005]],["parent/60",[65,3.415]],["name/61",[25,38.825]],["parent/61",[33,1.898]],["name/62",[62,35.413]],["parent/62",[68,3.169]],["name/63",[69,44.005]],["parent/63",[68,3.169]],["name/64",[59,38.825]],["parent/64",[68,3.169]],["name/65",[35,23.35]],["parent/65",[68,3.169]],["name/66",[60,38.825]],["parent/66",[70,3.744]],["name/67",[62,35.413]],["parent/67",[70,3.744]],["name/68",[71,44.005]],["parent/68",[33,1.898]],["name/69",[72,44.005]],["parent/69",[73,3.415]],["name/70",[74,44.005]],["parent/70",[73,3.415]],["name/71",[75,44.005]],["parent/71",[73,3.415]],["name/72",[76,44.005]],["parent/72",[33,1.898]],["name/73",[77,44.005]],["parent/73",[78,3.415]],["name/74",[79,44.005]],["parent/74",[78,3.415]],["name/75",[35,23.35]],["parent/75",[78,3.415]],["name/76",[42,38.825]],["parent/76",[80,2.809]],["name/77",[35,23.35]],["parent/77",[80,2.809]],["name/78",[81,35.413]],["parent/78",[82,2.809]],["name/79",[57,32.864]],["parent/79",[82,2.809]],["name/80",[83,44.005]],["parent/80",[80,2.809]],["name/81",[35,23.35]],["parent/81",[80,2.809]],["name/82",[81,35.413]],["parent/82",[82,2.809]],["name/83",[57,32.864]],["parent/83",[82,2.809]],["name/84",[84,44.005]],["parent/84",[80,2.809]],["name/85",[35,23.35]],["parent/85",[80,2.809]],["name/86",[81,35.413]],["parent/86",[82,2.809]],["name/87",[57,32.864]],["parent/87",[82,2.809]],["name/88",[85,44.005]],["parent/88",[33,1.898]],["name/89",[86,44.005]],["parent/89",[87,3.744]],["name/90",[88,44.005]],["parent/90",[87,3.744]],["name/91",[89,44.005]],["parent/91",[33,1.898]],["name/92",[90,44.005]],["parent/92",[91,4.243]],["name/93",[92,44.005]],["parent/93",[33,1.898]],["name/94",[93,44.005]],["parent/94",[94,4.243]],["name/95",[95,32.864]],["parent/95",[]],["name/96",[96,44.005]],["parent/96",[95,3.169]],["name/97",[97,44.005]],["parent/97",[98,3.415]],["name/98",[99,44.005]],["parent/98",[98,3.415]],["name/99",[100,44.005]],["parent/99",[98,3.415]],["name/100",[101,44.005]],["parent/100",[95,3.169]],["name/101",[102,44.005]],["parent/101",[103,2.809]],["name/102",[104,44.005]],["parent/102",[103,2.809]],["name/103",[105,44.005]],["parent/103",[103,2.809]],["name/104",[106,44.005]],["parent/104",[103,2.809]],["name/105",[107,44.005]],["parent/105",[103,2.809]],["name/106",[108,44.005]],["parent/106",[103,2.809]],["name/107",[109,44.005]],["parent/107",[95,3.169]],["name/108",[110,29.135]],["parent/108",[]],["name/109",[111,44.005]],["parent/109",[110,2.809]],["name/110",[112,44.005]],["parent/110",[110,2.809]],["name/111",[113,44.005]],["parent/111",[110,2.809]],["name/112",[114,44.005]],["parent/112",[110,2.809]],["name/113",[115,44.005]],["parent/113",[110,2.809]]],"invertedIndex":[["__type",{"_index":35,"name":{"32":{},"34":{},"40":{},"42":{},"47":{},"54":{},"65":{},"75":{},"77":{},"81":{},"85":{}},"parent":{}}],["bladetype",{"_index":101,"name":{"100":{}},"parent":{}}],["booleaninputoptions",{"_index":16,"name":{"12":{}},"parent":{}}],["cassandrakeys",{"_index":105,"name":{"103":{}},"parent":{}}],["choiceinputoptions",{"_index":20,"name":{"16":{}},"parent":{}}],["choiceitem",{"_index":51,"name":{"46":{}},"parent":{}}],["choices",{"_index":21,"name":{"17":{}},"parent":{}}],["constructor",{"_index":40,"name":{"36":{}},"parent":{}}],["currently",{"_index":3,"name":{"1":{}},"parent":{}}],["description",{"_index":25,"name":{"22":{},"61":{}},"parent":{}}],["descriptiondisplayoptions",{"_index":23,"name":{"20":{}},"parent":{}}],["descriptiontype",{"_index":63,"name":{"57":{}},"parent":{}}],["disabled",{"_index":75,"name":{"71":{}},"parent":{}}],["example",{"_index":99,"name":{"98":{}},"parent":{}}],["failure",{"_index":84,"name":{"84":{}},"parent":{}}],["falselabeltkey",{"_index":19,"name":{"14":{}},"parent":{}}],["generatebladelink",{"_index":109,"name":{"107":{}},"parent":{}}],["gremlinkeys",{"_index":106,"name":{"104":{}},"parent":{}}],["hidden",{"_index":74,"name":{"70":{}},"parent":{}}],["href",{"_index":60,"name":{"55":{},"66":{}},"parent":{}}],["info",{"_index":56,"name":{"51":{}},"parent":{}}],["infomessagebar",{"_index":66,"name":{"59":{}},"parent":{}}],["initialize",{"_index":42,"name":{"37":{},"76":{}},"parent":{}}],["initializecallback",{"_index":34,"name":{"31":{}},"parent":{}}],["inputoptions",{"_index":27,"name":{"24":{}},"parent":{}}],["inputtype",{"_index":55,"name":{"50":{}},"parent":{}}],["invalid",{"_index":97,"name":{"97":{}},"parent":{}}],["is",{"_index":2,"name":{"1":{}},"parent":{}}],["isdisplayable",{"_index":31,"name":{"28":{}},"parent":{}}],["isdynamicdescription",{"_index":26,"name":{"23":{}},"parent":{}}],["isupdateinprogress",{"_index":86,"name":{"89":{}},"parent":{}}],["key",{"_index":54,"name":{"49":{}},"parent":{}}],["labeltkey",{"_index":12,"name":{"8":{},"11":{},"15":{},"19":{},"21":{},"48":{}},"parent":{}}],["link",{"_index":59,"name":{"53":{},"64":{}},"parent":{}}],["max",{"_index":9,"name":{"5":{}},"parent":{}}],["messagetkey",{"_index":57,"name":{"52":{},"79":{},"83":{},"87":{}},"parent":{}}],["metrics",{"_index":108,"name":{"106":{}},"parent":{}}],["min",{"_index":7,"name":{"4":{}},"parent":{}}],["mongokeys",{"_index":104,"name":{"102":{}},"parent":{}}],["numberinputoptions",{"_index":6,"name":{"3":{}},"parent":{}}],["numberuitype",{"_index":47,"name":{"43":{}},"parent":{}}],["onchange",{"_index":28,"name":{"25":{}},"parent":{}}],["onchangecallback",{"_index":45,"name":{"41":{}},"parent":{}}],["onrefresh",{"_index":44,"name":{"39":{}},"parent":{}}],["onsave",{"_index":43,"name":{"38":{}},"parent":{}}],["onsavecallback",{"_index":37,"name":{"33":{}},"parent":{}}],["onsaveresult",{"_index":76,"name":{"72":{}},"parent":{}}],["operationstatusurl",{"_index":77,"name":{"73":{}},"parent":{}}],["placeholdertkey",{"_index":14,"name":{"10":{},"18":{}},"parent":{}}],["portalnotification",{"_index":79,"name":{"74":{}},"parent":{}}],["propertyinfo",{"_index":29,"name":{"26":{}},"parent":{}}],["refreshoptions",{"_index":32,"name":{"29":{}},"parent":{}}],["refreshparams",{"_index":89,"name":{"91":{}},"parent":{}}],["refreshresult",{"_index":85,"name":{"88":{}},"parent":{}}],["retryintervalinms",{"_index":90,"name":{"92":{}},"parent":{}}],["selfserve",{"_index":0,"name":{"0":{},"1":{}},"parent":{}}],["selfserve/decorators",{"_index":5,"name":{"2":{}},"parent":{"3":{},"9":{},"12":{},"16":{},"20":{},"24":{},"25":{},"26":{},"27":{},"28":{},"29":{}}}],["selfserve/decorators.booleaninputoptions",{"_index":18,"name":{},"parent":{"13":{},"14":{},"15":{}}}],["selfserve/decorators.choiceinputoptions",{"_index":22,"name":{},"parent":{"17":{},"18":{},"19":{}}}],["selfserve/decorators.descriptiondisplayoptions",{"_index":24,"name":{},"parent":{"21":{},"22":{},"23":{}}}],["selfserve/decorators.numberinputoptions",{"_index":8,"name":{},"parent":{"4":{},"5":{},"6":{},"7":{},"8":{}}}],["selfserve/decorators.stringinputoptions",{"_index":15,"name":{},"parent":{"10":{},"11":{}}}],["selfserve/selfservetelemetryprocessor",{"_index":110,"name":{"108":{}},"parent":{"109":{},"110":{},"111":{},"112":{},"113":{}}}],["selfserve/selfservetypes",{"_index":33,"name":{"30":{}},"parent":{"31":{},"33":{},"35":{},"41":{},"43":{},"46":{},"50":{},"51":{},"57":{},"61":{},"68":{},"72":{},"88":{},"91":{},"93":{}}}],["selfserve/selfservetypes.choiceitem",{"_index":52,"name":{},"parent":{"47":{}}}],["selfserve/selfservetypes.choiceitem.__type",{"_index":53,"name":{},"parent":{"48":{},"49":{}}}],["selfserve/selfservetypes.description",{"_index":68,"name":{},"parent":{"62":{},"63":{},"64":{},"65":{}}}],["selfserve/selfservetypes.description.__type",{"_index":70,"name":{},"parent":{"66":{},"67":{}}}],["selfserve/selfservetypes.descriptiontype",{"_index":65,"name":{},"parent":{"58":{},"59":{},"60":{}}}],["selfserve/selfservetypes.info",{"_index":58,"name":{},"parent":{"52":{},"53":{},"54":{}}}],["selfserve/selfservetypes.info.__type",{"_index":61,"name":{},"parent":{"55":{},"56":{}}}],["selfserve/selfservetypes.initializecallback",{"_index":36,"name":{},"parent":{"32":{}}}],["selfserve/selfservetypes.numberuitype",{"_index":49,"name":{},"parent":{"44":{},"45":{}}}],["selfserve/selfservetypes.onchangecallback",{"_index":46,"name":{},"parent":{"42":{}}}],["selfserve/selfservetypes.onsavecallback",{"_index":38,"name":{},"parent":{"34":{}}}],["selfserve/selfservetypes.onsaveresult",{"_index":78,"name":{},"parent":{"73":{},"74":{},"75":{}}}],["selfserve/selfservetypes.onsaveresult.__type",{"_index":80,"name":{},"parent":{"76":{},"77":{},"80":{},"81":{},"84":{},"85":{}}}],["selfserve/selfservetypes.onsaveresult.__type.__type",{"_index":82,"name":{},"parent":{"78":{},"79":{},"82":{},"83":{},"86":{},"87":{}}}],["selfserve/selfservetypes.refreshparams",{"_index":91,"name":{},"parent":{"92":{}}}],["selfserve/selfservetypes.refreshresult",{"_index":87,"name":{},"parent":{"89":{},"90":{}}}],["selfserve/selfservetypes.selfservebaseclass",{"_index":41,"name":{},"parent":{"36":{},"37":{},"38":{},"39":{},"40":{}}}],["selfserve/selfservetypes.selfservetelemetrymessage",{"_index":94,"name":{},"parent":{"94":{}}}],["selfserve/selfservetypes.smartuiinput",{"_index":73,"name":{},"parent":{"69":{},"70":{},"71":{}}}],["selfserve/selfserveutils",{"_index":95,"name":{"95":{}},"parent":{"96":{},"100":{},"107":{}}}],["selfserve/selfserveutils.bladetype",{"_index":103,"name":{},"parent":{"101":{},"102":{},"103":{},"104":{},"105":{},"106":{}}}],["selfserve/selfserveutils.selfservetype",{"_index":98,"name":{},"parent":{"97":{},"98":{},"99":{}}}],["selfservebaseclass",{"_index":39,"name":{"35":{}},"parent":{}}],["selfserveclassname",{"_index":93,"name":{"94":{}},"parent":{}}],["selfservetelemetrymessage",{"_index":92,"name":{"93":{}},"parent":{}}],["selfservetrace",{"_index":111,"name":{"109":{}},"parent":{}}],["selfservetracecancel",{"_index":115,"name":{"113":{}},"parent":{}}],["selfservetracefailure",{"_index":114,"name":{"112":{}},"parent":{}}],["selfservetracestart",{"_index":112,"name":{"110":{}},"parent":{}}],["selfservetracesuccess",{"_index":113,"name":{"111":{}},"parent":{}}],["selfservetype",{"_index":96,"name":{"96":{}},"parent":{}}],["slider",{"_index":50,"name":{"45":{}},"parent":{}}],["smartuiinput",{"_index":71,"name":{"68":{}},"parent":{}}],["spinner",{"_index":48,"name":{"44":{}},"parent":{}}],["sqlkeys",{"_index":102,"name":{"101":{}},"parent":{}}],["sqlx",{"_index":100,"name":{"99":{}},"parent":{}}],["step",{"_index":10,"name":{"6":{}},"parent":{}}],["stringinputoptions",{"_index":13,"name":{"9":{}},"parent":{}}],["success",{"_index":83,"name":{"80":{}},"parent":{}}],["supported",{"_index":4,"name":{"1":{}},"parent":{}}],["tablekeys",{"_index":107,"name":{"105":{}},"parent":{}}],["text",{"_index":64,"name":{"58":{}},"parent":{}}],["texttkey",{"_index":62,"name":{"56":{},"62":{},"67":{}},"parent":{}}],["titletkey",{"_index":81,"name":{"78":{},"82":{},"86":{}},"parent":{}}],["truelabeltkey",{"_index":17,"name":{"13":{}},"parent":{}}],["type",{"_index":69,"name":{"63":{}},"parent":{}}],["uitype",{"_index":11,"name":{"7":{}},"parent":{}}],["updateinprogressmessagetkey",{"_index":88,"name":{"90":{}},"parent":{}}],["value",{"_index":72,"name":{"69":{}},"parent":{}}],["values",{"_index":30,"name":{"27":{}},"parent":{}}],["warningmessagebar",{"_index":67,"name":{"60":{}},"parent":{}}],["what",{"_index":1,"name":{"1":{}},"parent":{}}]],"pipeline":[]}} \ No newline at end of file diff --git a/docs/classes/selfserve_selfservetypes.selfservebaseclass.html b/docs/classes/selfserve_selfservetypes.selfservebaseclass.html new file mode 100644 index 000000000..5cd632443 --- /dev/null +++ b/docs/classes/selfserve_selfservetypes.selfservebaseclass.html @@ -0,0 +1,306 @@ + + + + + + SelfServeBaseClass | cosmos-explorer + + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class SelfServeBaseClass

+
+
+
+
+
+
+
+
+
+

All SelfServe feature classes need to derive from the SelfServeBaseClass

+
+
+
+
+

Hierarchy

+
    +
  • + SelfServeBaseClass +
    • +
+
+
+

Index

+
+
+
+

Constructors

+ +
+
+

Properties

+ +
+
+
+
+
+

Constructors

+
+ +

constructor

+ + +
+
+
+

Properties

+
+ +

Abstract initialize

+
initialize: initializeCallback
+ +
+
+

Sets default values for the properties of the Self Serve Class. Typically, you can make rest calls here + to fetch the initial values for the properties. This is also called after the onSave callback, to reinitialize the defaults.

+
+
+
+
+ +

Abstract onRefresh

+
onRefresh: () => Promise<RefreshResult>
+ +
+
+

Callback that is triggered when the refresh button is clicked. Here, you should perform the your rest API + call to check if the update action is completed.

+
+
+
+

Type declaration

+ +
+
+
+ +

Abstract onSave

+
onSave: onSaveCallback
+ +
+
+

Callback that is triggerred when the submit button is clicked. You should perform your rest API + calls here using the data from the different inputs passed as a Map to this callback function.

+
+
+
+
+
+
+ + +
+
+
+
+
+

Legend

+
+
    +
  • Class
    • +
  • Constructor
    • +
  • Property
    • +
+
    +
  • Function
    • +
  • Type alias
    • +
+
    +
  • Enumeration
    • +
+
    +
  • Interface
    • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/docs/enums/selfserve_selfservetypes.descriptiontype.html b/docs/enums/selfserve_selfservetypes.descriptiontype.html new file mode 100644 index 000000000..ccce7d7c0 --- /dev/null +++ b/docs/enums/selfserve_selfservetypes.descriptiontype.html @@ -0,0 +1,245 @@ + + + + + + DescriptionType | cosmos-explorer + + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Enumeration DescriptionType

+
+
+
+
+
+
+
+

Index

+
+
+
+

Enumeration members

+ +
+
+
+
+
+

Enumeration members

+
+ +

InfoMessageBar

+
InfoMessageBar: = 1
+ +
+
+

Show the description as a Info Message bar.

+
+
+
+
+ +

Text

+
Text: = 0
+ +
+
+

Show the description as a text

+
+
+
+
+ +

WarningMessageBar

+
WarningMessageBar: = 2
+ +
+
+

Show the description as a Warning Message bar.

+
+
+
+
+
+
+ + +
+
+
+
+
+

Legend

+
+
    +
  • Function
    • +
  • Type alias
    • +
+
    +
  • Enumeration
    • +
+
    +
  • Interface
    • +
+
    +
  • Class
    • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/docs/enums/selfserve_selfservetypes.numberuitype.html b/docs/enums/selfserve_selfservetypes.numberuitype.html new file mode 100644 index 000000000..28dcadc76 --- /dev/null +++ b/docs/enums/selfserve_selfservetypes.numberuitype.html @@ -0,0 +1,229 @@ + + + + + + NumberUiType | cosmos-explorer + + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Enumeration NumberUiType

+
+
+
+
+
+
+
+

Index

+
+
+
+

Enumeration members

+ +
+
+
+
+
+

Enumeration members

+
+ +

Slider

+
Slider: = "Slider"
+ +
+
+

The numeric input UI element corresponding to the property is a Slider

+
+
+
+
+ +

Spinner

+
Spinner: = "Spinner"
+ +
+
+

The numeric input UI element corresponding to the property is a Spinner

+
+
+
+
+
+
+ + +
+
+
+
+
+

Legend

+
+
    +
  • Function
    • +
  • Type alias
    • +
+
    +
  • Enumeration
    • +
+
    +
  • Interface
    • +
+
    +
  • Class
    • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/docs/enums/selfserve_selfserveutils.bladetype.html b/docs/enums/selfserve_selfserveutils.bladetype.html new file mode 100644 index 000000000..9283b498f --- /dev/null +++ b/docs/enums/selfserve_selfserveutils.bladetype.html @@ -0,0 +1,264 @@ + + + + + + BladeType | cosmos-explorer + + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Enumeration BladeType

+
+
+
+
+
+
+
+
+
+

Portal Blade types

+
+
+
+
+

Index

+
+
+
+

Enumeration members

+ +
+
+
+
+
+

Enumeration members

+
+ +

CassandraKeys

+
CassandraKeys: = "cassandraDbKeys"
+ +
+
+

Keys blade of a Cassandra API account.

+
+
+
+
+ +

GremlinKeys

+
GremlinKeys: = "keys"
+ +
+
+

Keys blade of a Gremlin API account.

+
+
+
+
+ +

Metrics

+
Metrics: = "metrics"
+ +
+
+

Metrics blade of an Azure Cosmos DB account.

+
+
+
+
+ +

MongoKeys

+
MongoKeys: = "mongoDbKeys"
+ +
+
+

Keys blade of a Mongo API account.

+
+
+
+
+ +

SqlKeys

+
SqlKeys: = "keys"
+ +
+
+

Keys blade of a SQL API account.

+
+
+
+
+ +

TableKeys

+
TableKeys: = "tableKeys"
+ +
+
+

Keys blade of a Table API account.

+
+
+
+
+
+
+ + +
+
+
+
+
+

Legend

+
+
    +
  • Function
    • +
  • Type alias
    • +
+
    +
  • Enumeration
    • +
+
    +
  • Interface
    • +
+
    +
  • Class
    • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/docs/enums/selfserve_selfserveutils.selfservetype.html b/docs/enums/selfserve_selfserveutils.selfservetype.html new file mode 100644 index 000000000..b291557ef --- /dev/null +++ b/docs/enums/selfserve_selfserveutils.selfservetype.html @@ -0,0 +1,201 @@ + + + + + + SelfServeType | cosmos-explorer + + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Enumeration SelfServeType

+
+
+
+
+
+
+
+
+
+

The type used to identify the Self Serve Class

+
+
+
+
+

Index

+
+
+
+

Enumeration members

+ +
+
+
+
+
+

Enumeration members

+
+ +

example

+
example: = "example"
+ +
+
+ +

invalid

+
invalid: = "invalid"
+ +
+
+ +

sqlx

+
sqlx: = "sqlx"
+ +
+
+
+
+ + +
+
+
+
+
+

Legend

+
+
    +
  • Function
    • +
  • Type alias
    • +
+
    +
  • Enumeration
    • +
+
    +
  • Interface
    • +
+
    +
  • Class
    • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/docs/index.html b/docs/index.html new file mode 100644 index 000000000..f62e4c4f2 --- /dev/null +++ b/docs/index.html @@ -0,0 +1,209 @@ + + + + + + cosmos-explorer + + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+

cosmos-explorer

+
+
+
+
+
+
+
+ +

Cosmos DB Explorer

+ +

UI for Azure Cosmos DB. Powers the Azure Portal, https://cosmos.azure.com/, and the Cosmos DB Emulator

+

+ +

Getting Started

+ +
    +
  • npm install
    • +
  • npm run build
    • +
+ +

Developing

+ + +

Watch mode

+ +

Run npm start to start the development server and automatically rebuild on changes

+ +

Hosted Development (https://cosmos.azure.com)

+ +
    +
  • Visit: https://localhost:1234/hostedExplorer.html
    • +
  • The default webpack dev server configuration will proxy requests to the production portal backend: https://main.documentdb.ext.azure.com. This will allow you to use production connection strings on your local machine.
    • +
+ +

Emulator Development

+ + + +

Setting up a Remote Emulator

+ +

The Cosmos emulator currently only runs in Windows environments. You can still develop on a non-Windows machine by setting up an emulator on a windows box and exposing its ports publicly:

+
    +

  1. Expose these ports publicly: 8081, 8900, 8979, 10250, 10251, 10252, 10253, 10254, 10255, 10256

    +
    2. +

  2. Download and install the emulator: https://docs.microsoft.com/en-us/azure/cosmos-db/local-emulator

    +
    3. +

  3. Start the emulator from PowerShell:

    +
    4. +
+ 
> cd C:/
+
+> .\CosmosDB.Emulator.exe -AllowNetworkAccess -Key="<EMULATOR MASTER KEY>"
+
+ +

Portal Development

+ + + +

Testing

+ + +

Unit Tests

+ +

Unit tests are located adjacent to the code under test and run with Jest:

+

npm run test

+ +

End to End CI Tests

+ +

Jest and Puppeteer are used for end to end browser based tests and are contained in test/. To run these tests locally:

+
    +
  1. Copy .env.example to .env
    2. +
  2. Update the values in .env including your local data explorer endpoint (ask a teammate/codeowner for help with .env values)
    3. +
  3. Make sure all packages are installed npm install
    4. +
  4. Run the server npm run start and wait for it to start
    5. +
  5. Run npm run test:e2e
    6. +
+ +

Releasing

+ +

We generally adhere to the release strategy documented by the Azure SDK Guidelines. Most releases should happen from the master branch. If master contains commits that cannot be released, you may create a release from a release/ or hotfix/ branch. See linked documentation for more details.

+ +

Architecture

+ +

+ +

Contributing

+ +

Please read the contribution guidelines.

+
+
+
+ + +
+
+
+
+
+

Legend

+
+
    +
  • Function
    • +
  • Type alias
    • +
+
    +
  • Enumeration
    • +
+
    +
  • Interface
    • +
+
    +
  • Class
    • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/docs/interfaces/selfserve_decorators.booleaninputoptions.html b/docs/interfaces/selfserve_decorators.booleaninputoptions.html new file mode 100644 index 000000000..d489484dc --- /dev/null +++ b/docs/interfaces/selfserve_decorators.booleaninputoptions.html @@ -0,0 +1,255 @@ + + + + + + BooleanInputOptions | cosmos-explorer + + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface BooleanInputOptions

+
+
+
+
+
+
+
+
+
+

Toggle is rendered.

+
+
+
+
+

Hierarchy

+
    +
  • + InputOptionsBase +
      +
    • + BooleanInputOptions +
      • +
    +
    • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

falseLabelTKey

+
falseLabelTKey: string | (() => Promise<string>)
+ +
+
+

Key used to pickup the string corresponding to the false label of the toggle, from the strings JSON file.

+
+
+
+
+ +

labelTKey

+
labelTKey: string
+ +
+
+

Key used to pickup the string corresponding to the label of the UI element, from the strings JSON file.

+
+
+
+
+ +

trueLabelTKey

+
trueLabelTKey: string | (() => Promise<string>)
+ +
+
+

Key used to pickup the string corresponding to the true label of the toggle, from the strings JSON file.

+
+
+
+
+
+
+ + +
+
+
+
+
+

Legend

+
+
    +
  • Function
    • +
  • Type alias
    • +
+
    +
  • Interface
    • +
  • Property
    • +
+
    +
  • Enumeration
    • +
+
    +
  • Class
    • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/docs/interfaces/selfserve_decorators.choiceinputoptions.html b/docs/interfaces/selfserve_decorators.choiceinputoptions.html new file mode 100644 index 000000000..583e71512 --- /dev/null +++ b/docs/interfaces/selfserve_decorators.choiceinputoptions.html @@ -0,0 +1,255 @@ + + + + + + ChoiceInputOptions | cosmos-explorer + + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface ChoiceInputOptions

+
+
+
+
+
+
+
+
+
+

Dropdown is rendered.

+
+
+
+
+

Hierarchy

+
    +
  • + InputOptionsBase +
      +
    • + ChoiceInputOptions +
      • +
    +
    • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

choices

+
choices: (() => Promise<ChoiceItem[]>) | ChoiceItem[]
+ +
+
+

Choices to be shown in the dropdown

+
+
+
+
+ +

labelTKey

+
labelTKey: string
+ +
+
+

Key used to pickup the string corresponding to the label of the UI element, from the strings JSON file.

+
+
+
+
+ +

Optional placeholderTKey

+
placeholderTKey: string | (() => Promise<string>)
+ +
+
+

Key used to pickup the string corresponding to the placeholder text of the dropdown, from the strings JSON file.

+
+
+
+
+
+
+ + +
+
+
+
+
+

Legend

+
+
    +
  • Function
    • +
  • Type alias
    • +
+
    +
  • Interface
    • +
  • Property
    • +
+
    +
  • Enumeration
    • +
+
    +
  • Class
    • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/docs/interfaces/selfserve_decorators.descriptiondisplayoptions.html b/docs/interfaces/selfserve_decorators.descriptiondisplayoptions.html new file mode 100644 index 000000000..1347ad4d1 --- /dev/null +++ b/docs/interfaces/selfserve_decorators.descriptiondisplayoptions.html @@ -0,0 +1,249 @@ + + + + + + DescriptionDisplayOptions | cosmos-explorer + + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface DescriptionDisplayOptions

+
+
+
+
+
+
+
+
+
+

Text is rendered.

+
+
+
+
+

Hierarchy

+
    +
  • + DescriptionDisplayOptions +
    • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional description

+
description: (() => Promise<Description>) | Description
+ +
+
+

Static description to be shown as text.

+
+
+
+
+ +

Optional isDynamicDescription

+
isDynamicDescription: boolean
+ +
+
+

If true, Indicates that the Description will be populated dynamically and that it may not be present in some scenarios.

+
+
+
+
+ +

Optional labelTKey

+
labelTKey: string
+ +
+
+

Optional heading for the text displayed by this description element.

+
+
+
+
+
+
+ + +
+
+
+
+
+

Legend

+
+
    +
  • Function
    • +
  • Type alias
    • +
+
    +
  • Interface
    • +
  • Property
    • +
+
    +
  • Enumeration
    • +
+
    +
  • Class
    • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/docs/interfaces/selfserve_decorators.numberinputoptions.html b/docs/interfaces/selfserve_decorators.numberinputoptions.html new file mode 100644 index 000000000..d99ddd07f --- /dev/null +++ b/docs/interfaces/selfserve_decorators.numberinputoptions.html @@ -0,0 +1,287 @@ + + + + + + NumberInputOptions | cosmos-explorer + + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface NumberInputOptions

+
+
+
+
+
+
+
+
+
+

Numeric input UI element is rendered. The current options are to render it as a slider or a spinner.

+
+
+
+
+

Hierarchy

+
    +
  • + InputOptionsBase +
      +
    • + NumberInputOptions +
      • +
    +
    • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

labelTKey

+
labelTKey: string
+ +
+
+

Key used to pickup the string corresponding to the label of the UI element, from the strings JSON file.

+
+
+
+
+ +

max

+
max: number | (() => Promise<number>)
+ +
+
+

Max value of the numeric input UI element

+
+
+
+
+ +

min

+
min: number | (() => Promise<number>)
+ +
+
+

Min value of the numeric input UI element

+
+
+
+
+ +

step

+
step: number | (() => Promise<number>)
+ +
+
+

Value by which the numeric input is incremented or decremented in the UI.

+
+
+
+
+ +

uiType

+
uiType: NumberUiType
+ +
+
+

The type of the numeric input UI element

+
+
+
+
+
+
+ + +
+
+
+
+
+

Legend

+
+
    +
  • Function
    • +
  • Type alias
    • +
+
    +
  • Interface
    • +
  • Property
    • +
+
    +
  • Enumeration
    • +
+
    +
  • Class
    • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/docs/interfaces/selfserve_decorators.stringinputoptions.html b/docs/interfaces/selfserve_decorators.stringinputoptions.html new file mode 100644 index 000000000..a0424a0e6 --- /dev/null +++ b/docs/interfaces/selfserve_decorators.stringinputoptions.html @@ -0,0 +1,239 @@ + + + + + + StringInputOptions | cosmos-explorer + + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface StringInputOptions

+
+
+
+
+
+
+
+
+
+

Text box is rendered.

+
+
+
+
+

Hierarchy

+
    +
  • + InputOptionsBase +
      +
    • + StringInputOptions +
      • +
    +
    • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

labelTKey

+
labelTKey: string
+ +
+
+

Key used to pickup the string corresponding to the label of the UI element, from the strings JSON file.

+
+
+
+
+ +

Optional placeholderTKey

+
placeholderTKey: string | (() => Promise<string>)
+ +
+
+

Key used to pickup the string corresponding to the place holder text of the text box, from the strings JSON file.

+
+
+
+
+
+
+ + +
+
+
+
+
+

Legend

+
+
    +
  • Function
    • +
  • Type alias
    • +
+
    +
  • Interface
    • +
  • Property
    • +
+
    +
  • Enumeration
    • +
+
    +
  • Class
    • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/docs/interfaces/selfserve_selfservetypes.description.html b/docs/interfaces/selfserve_selfservetypes.description.html new file mode 100644 index 000000000..f95fdcfcf --- /dev/null +++ b/docs/interfaces/selfserve_selfservetypes.description.html @@ -0,0 +1,277 @@ + + + + + + Description | cosmos-explorer + + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface Description

+
+
+
+
+
+
+
+
+
+

Data to be shown as a description.

+
+
+
+
+

Hierarchy

+
    +
  • + Description +
    • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional link

+
link: { href: string; textTKey: string }
+ +
+
+

Optional link to be shown as part of the description, after the text.

+
+
+
+

Type declaration

+
    +
  • +
    href: string
    +
    +
    +

    The URL of the link

    +
    +
    +
    • +
  • +
    textTKey: string
    +
    +
    +

    Key used to pickup the string corresponding to the text of the link, from the strings JSON file.

    +
    +
    +
    • +
+
+
+
+ +

textTKey

+
textTKey: string
+ +
+
+

Key used to pickup the string corresponding to the text to be shown as part of the description, from the strings JSON file.

+
+
+
+
+ +

type

+
type: DescriptionType
+ +
+
+
+
+ + +
+
+
+
+
+

Legend

+
+
    +
  • Function
    • +
  • Type alias
    • +
+
    +
  • Interface
    • +
  • Property
    • +
+
    +
  • Enumeration
    • +
+
    +
  • Class
    • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/docs/interfaces/selfserve_selfservetypes.info.html b/docs/interfaces/selfserve_selfservetypes.info.html new file mode 100644 index 000000000..c774dcc52 --- /dev/null +++ b/docs/interfaces/selfserve_selfservetypes.info.html @@ -0,0 +1,266 @@ + + + + + + Info | cosmos-explorer + + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface Info

+
+
+
+
+
+
+
+
+
+

Data to be shown within the info bubble of the property.

+
+
+
+
+

Hierarchy

+
    +
  • + Info +
    • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional link

+
link: { href: string; textTKey: string }
+ +
+
+

Optional link to be shown within the info bubble, after the text.

+
+
+
+

Type declaration

+
    +
  • +
    href: string
    +
    +
    +

    The URL of the link

    +
    +
    +
    • +
  • +
    textTKey: string
    +
    +
    +

    Key used to pickup the string corresponding to the text of the link, from the strings JSON file.

    +
    +
    +
    • +
+
+
+
+ +

messageTKey

+
messageTKey: string
+ +
+
+

Key used to pickup the string corresponding to the text to be shown within the info bubble, from the strings JSON file.

+
+
+
+
+
+
+ + +
+
+
+
+
+

Legend

+
+
    +
  • Function
    • +
  • Type alias
    • +
+
    +
  • Interface
    • +
  • Property
    • +
+
    +
  • Enumeration
    • +
+
    +
  • Class
    • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/docs/interfaces/selfserve_selfservetypes.onsaveresult.html b/docs/interfaces/selfserve_selfservetypes.onsaveresult.html new file mode 100644 index 000000000..45f6ffb36 --- /dev/null +++ b/docs/interfaces/selfserve_selfservetypes.onsaveresult.html @@ -0,0 +1,321 @@ + + + + + + OnSaveResult | cosmos-explorer + + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface OnSaveResult

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + OnSaveResult +
    • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

operationStatusUrl

+
operationStatusUrl: string
+ +
+
+

The polling url returned by the RP call.

+
+
+
+
+ +

Optional portalNotification

+
portalNotification: { failure: { messageTKey: string; titleTKey: string }; initialize: { messageTKey: string; titleTKey: string }; success: { messageTKey: string; titleTKey: string } }
+ +
+
+

Notifications that need to be shown on the portal for different stages of a scenario (initialized, success/failure).

+
+
+
+

Type declaration

+
    +
  • +
    failure: { messageTKey: string; titleTKey: string }
    +
    +
    +

    Notification that need to be shown when the save operation failed.

    +
    +
    +
      +
    • +
      messageTKey: string
      +
      +
      +

      Key used to pickup the string corresponding to the notification message, from the strings JSON file.

      +
      +
      +
      • +
    • +
      titleTKey: string
      +
      +
      +

      Key used to pickup the string corresponding to the notification title, from the strings JSON file.

      +
      +
      +
      • +
    +
    • +
  • +
    initialize: { messageTKey: string; titleTKey: string }
    +
    +
    +

    Notification that need to be shown when the save operation has been triggered.

    +
    +
    +
      +
    • +
      messageTKey: string
      +
      +
      +

      Key used to pickup the string corresponding to the notification message, from the strings JSON file.

      +
      +
      +
      • +
    • +
      titleTKey: string
      +
      +
      +

      Key used to pickup the string corresponding to the notification title, from the strings JSON file.

      +
      +
      +
      • +
    +
    • +
  • +
    success: { messageTKey: string; titleTKey: string }
    +
    +
    +

    Notification that need to be shown when the save operation has successfully completed.

    +
    +
    +
      +
    • +
      messageTKey: string
      +
      +
      +

      Key used to pickup the string corresponding to the notification message, from the strings JSON file.

      +
      +
      +
      • +
    • +
      titleTKey: string
      +
      +
      +

      Key used to pickup the string corresponding to the notification title, from the strings JSON file.

      +
      +
      +
      • +
    +
    • +
+
+
+
+
+
+ + +
+
+
+
+
+

Legend

+
+
    +
  • Function
    • +
  • Type alias
    • +
+
    +
  • Interface
    • +
  • Property
    • +
+
    +
  • Enumeration
    • +
+
    +
  • Class
    • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/docs/interfaces/selfserve_selfservetypes.refreshparams.html b/docs/interfaces/selfserve_selfservetypes.refreshparams.html new file mode 100644 index 000000000..c7815c97c --- /dev/null +++ b/docs/interfaces/selfserve_selfservetypes.refreshparams.html @@ -0,0 +1,222 @@ + + + + + + RefreshParams | cosmos-explorer + + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface RefreshParams

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + RefreshParams +
    • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

retryIntervalInMs

+
retryIntervalInMs: number
+ +
+
+

The time interval between refresh attempts when an update in ongoing

+
+
+
+
+
+
+ + +
+
+
+
+
+

Legend

+
+
    +
  • Function
    • +
  • Type alias
    • +
+
    +
  • Interface
    • +
  • Property
    • +
+
    +
  • Enumeration
    • +
+
    +
  • Class
    • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/docs/interfaces/selfserve_selfservetypes.refreshresult.html b/docs/interfaces/selfserve_selfservetypes.refreshresult.html new file mode 100644 index 000000000..41159e1de --- /dev/null +++ b/docs/interfaces/selfserve_selfservetypes.refreshresult.html @@ -0,0 +1,239 @@ + + + + + + RefreshResult | cosmos-explorer + + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface RefreshResult

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + RefreshResult +
    • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

isUpdateInProgress

+
isUpdateInProgress: boolean
+ +
+
+

Indicate if the update is still ongoing

+
+
+
+
+ +

updateInProgressMessageTKey

+
updateInProgressMessageTKey: string
+ +
+
+

Key used to pickup the string corresponding to the message that will be shown on the UI if the update is still ongoing, from the strings JSON file. + Will be shown only if isUpdateInProgress is true.

+
+
+
+
+
+
+ + +
+
+
+
+
+

Legend

+
+
    +
  • Function
    • +
  • Type alias
    • +
+
    +
  • Interface
    • +
  • Property
    • +
+
    +
  • Enumeration
    • +
+
    +
  • Class
    • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/docs/interfaces/selfserve_selfservetypes.selfservetelemetrymessage.html b/docs/interfaces/selfserve_selfservetypes.selfservetelemetrymessage.html new file mode 100644 index 000000000..200ea0c44 --- /dev/null +++ b/docs/interfaces/selfserve_selfservetypes.selfservetelemetrymessage.html @@ -0,0 +1,227 @@ + + + + + + SelfServeTelemetryMessage | cosmos-explorer + + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface SelfServeTelemetryMessage

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + TelemetryData +
      +
    • + SelfServeTelemetryMessage +
      • +
    +
    • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

selfServeClassName

+
selfServeClassName: string
+ +
+
+

The className used to identify a SelfServe telemetry record

+
+
+
+
+
+
+ + +
+
+
+
+
+

Legend

+
+
    +
  • Function
    • +
  • Type alias
    • +
+
    +
  • Interface
    • +
  • Property
    • +
+
    +
  • Enumeration
    • +
+
    +
  • Class
    • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/docs/interfaces/selfserve_selfservetypes.smartuiinput.html b/docs/interfaces/selfserve_selfservetypes.smartuiinput.html new file mode 100644 index 000000000..ad6416a34 --- /dev/null +++ b/docs/interfaces/selfserve_selfservetypes.smartuiinput.html @@ -0,0 +1,254 @@ + + + + + + SmartUiInput | cosmos-explorer + + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface SmartUiInput

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + SmartUiInput +
    • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional disabled

+
disabled: boolean
+ +
+
+

Indicates whether the UI element corresponding to the property is disabled

+
+
+
+
+ +

Optional hidden

+
hidden: boolean
+ +
+
+

Indicates whether the UI element corresponding to the property is hidden

+
+
+
+
+ +

value

+
value: InputType
+ +
+
+

The value to be set for the UI element corresponding to the property

+
+
+
+
+
+
+ + +
+
+
+
+
+

Legend

+
+
    +
  • Function
    • +
  • Type alias
    • +
+
    +
  • Interface
    • +
  • Property
    • +
+
    +
  • Enumeration
    • +
+
    +
  • Class
    • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/docs/modules.html b/docs/modules.html new file mode 100644 index 000000000..923454972 --- /dev/null +++ b/docs/modules.html @@ -0,0 +1,138 @@ + + + + + + cosmos-explorer + + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+

cosmos-explorer

+
+
+
+
+
+
+
+

Index

+
+
+
+

Modules

+ +
+
+
+
+
+
+ + +
+
+
+
+
+

Legend

+
+
    +
  • Function
    • +
  • Type alias
    • +
+
    +
  • Enumeration
    • +
+
    +
  • Interface
    • +
+
    +
  • Class
    • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/docs/modules/selfserve.html b/docs/modules/selfserve.html new file mode 100644 index 000000000..6e5a4c6a6 --- /dev/null +++ b/docs/modules/selfserve.html @@ -0,0 +1,498 @@ + + + + + + SelfServe | cosmos-explorer + + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Module SelfServe

+
+
+
+
+
+
+
+
+
+ +

Self Serve Model

+ +

The Self Serve Model allows you to write classes that auto generate UI components for your feature. The idea is to allow developers from other feature teams, who may not be familiar with writing UI, to develop and own UX components. This is accomplished by just writing simpler TypeScript classes for their features.

+

What this means for the feature team

+
    +
  • Can concentrate just on the logic behind showing, hiding and disabling UI components
    • +
  • Need not worry about specifics of the UI language or UX requirements (Accessibility, Localization, Themes, etc.)
    • +
  • Can own the REST API calls made as part of the feature, which can change in the future
    • +
  • Quicker turn around time for development and bug fixes since they have deeper knowledge of the feature
    • +
+

What this means for the UI team

+
    +
  • No need to ramp up on the intricacies of every feature which requires UI changes
    • +
  • Own only the framework and not every feature, giving more bandwidth to prioritize inhouse features as well
    • +
+ +

Getting Started

+ +

Clone the cosmos-explorer repo and run

+
    +
  • npm install
    • +
  • npm run build
    • +
+

Click here for more info on setting up the cosmos-explorer repo.

+ +

Code Changes

+ +

Code changes need to be made only in the following files

+
    +
  • A JSON file - for strings to be displayed
    • +
  • A Types File - for defining the data models
    • +
  • A RP file - for defining the REST calls
    • +
  • A Class file - for defining the UI
    • +
  • SelfServeUtils.tsx and SelfServe.tsx - for defning the entrypoint for the UI
    • +
+ +

1. JSON file for UI strings

+ + +

Naming Convention

+ +

Localization/en/<FEATURE_NAME>.json
Please place your files only under "Localization/en" folder. If not, the UI strings will not be picked up by the framework.

+ +

Example

+ +

SelfServeExample.json

+ +

Description

+ +

This is a JSON file where the values are the strings that needs to be displayed in the UI. These strings are referenced using their corresponding unique keys.

+

For example, If your class file defines properties as follows

+ 
  @Values({
+    labelTKey: "stringPropertylabel"
+  })
+  stringProperty: string;
+
+  @Values({
+    labelTKey: "booleanPropertyLabel",
+    trueLabelTKey: "trueLabel",
+    falseLabelTKey: "falseLabel",
+  })
+  booleanProperty: boolean;
+
+

Then the content of Localization/en/FeatureName.json should be

+ 
{
+    stringPropertyLabel: "string property",
+    booleanPropertyLabel: "boolean property",
+    trueLabel: "Enable",
+    falseLabel: "Disable"
+}
+
+

You can learn more on how to define the class file here.

+ +

2. Types file

+ + +

Naming Convention

+ +

<FEATURE_NAME>.types.ts

+ +

Example

+ +

SelfServeExample.types.ts

+ +

Description

+ +

This file contains the definitions of all the data models to be used in your Class file and RP file.

+

For example, if your RP call takes/returns the stringProperty and booleanProperty of your SelfServe class, then you can define an interface in your FeatureName.types.ts file like this.

+ 
export RpDataModel {
+  stringProperty: string,
+  booleanProperty: boolean
+}
+
+ +

3. RP file

+ + +

Naming Convention

+ +

<FEATURE_NAME>.rp.ts

+ +

Example

+ +

SelfServeExample.rp.ts

+ +

Description

+ +

The RP file will host the REST calls needed for the initialize, save and refresh functions. This decouples the view and the model of the feature.

+

To make the ARM call, we need some information about the Azure Cosmos DB databaseAccount - the subscription id, resource group name and database account name. These are readily available through the userContext object, exposed through

+
    +
  • userContext.subscriptionId
    • +
  • userContext.resourceGroup
    • +
  • userContext.databaseAccount.name
    • +
+

You can use the armRequestWithoutPolling function to make the ARM api call.

+

Your FeatureName.rp.ts file can look like the following.

+ 
import { userContext } from "../../UserContext";
+import { armRequestWithoutPolling } from "../../Utils/arm/request";
+import { configContext } from "../../ConfigContext";
+
+const apiVersion = "2020-06-01-preview";
+
+export const saveData = async (properties: RpDataModel): Promise<string> => {
+  const path = `/subscriptions/${userContext.subscriptionId}/resourceGroups/${userContext.resourceGroup}/providers/Microsoft.DocumentDB/databaseAccounts/${userContext.databaseAccount.name}/<REST_OF_THE_PATH>`
+  const body = {
+      data : properties
+  }
+  const armRequestResult = await armRequestWithoutPolling({
+    host: configContext.ARM_ENDPOINT,
+    path,
+    method: "PUT",
+    apiVersion,
+    body,
+  });
+
+  return armRequestResult.operationStatusUrl;
+};
+
+
+ +

4. Class file

+ + +

Naming Convention

+ +

<FEATURE_NAME>.tsx

+ +

Example

+ +

SelfServeExample.tsx

+ +

Description

+ +

This file will contain the actual code that is translated into the UI component by the Self Serve framework.

+
    +

  • Each Self Serve class

    +
      +
    • Needs to extends the SelfServeBase class.
      • +
    • Needs to have the @IsDisplayable() decorator to tell the compiler that UI needs to be generated from this class.
      • +
    • Needs to define an initialize() function, to set default values for the inputs.
      • +
    • Needs to define an onSave() function, a callback for when the save button is clicked.
      • +
    • Needs to define an onRefresh() function, a callback for when the refresh button is clicked.
      • +
    • Can have an optional @RefreshOptions() decorator that determines how often the auto refresh of the UI component should take place.
      • +
    +
    • +

  • For every UI element needed, add a property to the Self Serve class. Each of these properties

    +
      +
    • Needs to have a @Values() decorator.
      • +
    • Can have an optional @PropertyInfo() decorator that describes it's info bubble.
      • +
    • Can have an optional @OnChange() decorator that dictates the effects of the change of the UI element tied to this property.
      • +
    +
    • +
+

Your FeatureName.tsx file will look like the following.

+ 
@IsDisplayable()
+@RefreshOptions({ retryIntervalInMs: 2000 })
+export default class FeatureName extends SelfServeBaseClass {
+
+  public initialize = async (): Promise<Map<string, SmartUiInput>> => {
+      // initialize RP call and processing logic
+  }
+
+  public onSave = async (
+    currentValues: Map<string, SmartUiInput>,
+    baselineValues: ReadonlyMap<string, SmartUiInput>
+  ): Promise<OnSaveResult> => {
+      // onSave RP call and processing logic
+  }
+
+  public onRefresh = async (): Promise<RefreshResult> => {
+      // refresh RP call and processing logic
+  };
+
+  @Values(...)
+  stringProperty: string;
+
+  @OnChange(...)
+  @PropertyInfo(...)
+  @Values(...)
+  booleanProperty: boolean;
+}
+
+ +

5. Update SelfServeType

+ +

Once you have written your Self Serve Class, add a corresponding type to SelfServeType

+ 
export enum SelfServeType {
+  invalid = "invalid",
+  example = "example",
+  ...
+  // Add the type for your new feature
+  featureName = "featurename"
+}
+
+ +

6. Update SelfServe.tsx (landing page)

+ +

Once the SelfServeType has been updated, update SelfServe.tsx for your feature. This ensures that the framework picks up your SelfServe Class.

+ 
const getDescriptor = async (selfServeType: SelfServeType): Promise<SelfServeDescriptor> => {
+  switch (selfServeType) {
+    case SelfServeType.example: {
+        ....
+    }
+    ...
+    ...
+    ...
+    // Add this for your new feature
+    case SelfServeType.featureName: {
+      // The 'webpackChunkName' is used during debugging, to identify if the correct class has been loaded
+      const FeatureName = await import(/* webpackChunkName: "FeatureName" */ "./FeatureName/FeatureName");
+      const featureName = new FeatureName.default();
+      await loadTranslations(featureName.constructor.name);
+      return featureName.toSelfServeDescriptor();
+    }
+    ...
+    ...
+    default:
+      return undefined;
+  }
+};
+
+
+ +

Telemetry

+ +

You can add telemetry for your feature using the functions in SelfServeTelemetryProcessor

+

For example, in your SelfServe class, you can call the trace method in your onSave function.

+ 
import { saveData } from "./FeatureName.rp"
+import { RpDataModel } from "./FeatureName.types"
+
+@IsDisplayable()
+export default class FeatureName extends SelfServeBaseClass {
+
+  .
+  .
+  .
+
+  public onSave = async (
+    currentValues: Map<string, SmartUiInput>,
+    baselineValues: ReadonlyMap<string, SmartUiInput>
+  ): Promise<OnSaveResult> => {
+
+    stringPropertyValue = currentValues.get("stringProperty")
+    booleanPropertyValue = currentValues.get("booleanProperty")
+    
+    const propertiesToSave : RpDataModel = { 
+      stringProperty: stringPropertyValue,
+      booleanProperty: booleanPropertyValue
+    }
+    const telemetryData = { ...propertiesToSave, selfServeClassName: FeatureName.name }
+    const onSaveTimeStamp = selfServeTraceStart(telemetryData)
+
+    await saveData(propertiesToSave)
+
+    selfServeTraceSuccess(telemetryData, onSaveTimeStamp)
+
+    // return required values
+  }
+
+  .
+  .
+  .
+
+  @Values(...)
+  stringProperty: string;
+
+  @Values(...)
+  booleanProperty: boolean;
+}
+
+ +

Portal Notifications

+ +

You can enable portal notifications for your feature by passing in the required strings as part of the portalNotification property of the onSaveResult.

+ 
@IsDisplayable()
+export default class SqlX extends SelfServeBaseClass {
+
+.
+.
+.
+
+  public onSave = async (
+      currentValues: Map<string, SmartUiInput>,
+      baselineValues: Map<string, SmartUiInput>
+  ): Promise<OnSaveResult> => {
+
+    stringPropertyValue = currentValues.get("stringProperty")
+    booleanPropertyValue = currentValues.get("booleanProperty")
+    
+    const propertiesToSave : RpDataModel = { 
+      stringProperty: stringPropertyValue,
+      booleanProperty: booleanPropertyValue
+    }
+
+    const operationStatusUrl = await saveData(propertiesToSave);
+    return {
+      operationStatusUrl: operationStatusUrl,
+      portalNotification: {
+        initialize: {
+          titleTKey: "DeleteInitializeTitle",
+          messageTKey: "DeleteInitializeMessage",
+        },
+        success: {
+          titleTKey: "DeleteSuccessTitle",
+          messageTKey: "DeleteSuccesseMessage",
+        },
+        failure: {
+          titleTKey: "DeleteFailureTitle",
+          messageTKey: "DeleteFailureMessage",
+        },
+      },
+    };
+  }
+
+  .
+  .
+  .
+
+  @Values(...)
+  stringProperty: string;
+
+  @Values(...)
+  booleanProperty: boolean;
+}
+
+ +

Execution

+ + +

Watch mode

+ +

Run npm start to start the development server and automatically rebuild on changes

+ +

Local Development

+ +

Ensure that you have made the Code changes.

+
    +
  • Go to https://ms.portal.azure.com/
    • +
  • Add the query string feature.showSelfServeExample=true&feature.selfServeSource=https://localhost:1234/selfServe.html?selfServeType%3D<SELF_SERVE_TYPE>
    • +
  • Click on the Self Serve Example menu item on the left panel.
    • +
+

For example, if you want to open up the the UI of a class with the type sqlx, then visit https://ms.portal.azure.com/?feature.showSelfServeExample=true&feature.selfServeSource=https://localhost:1234/selfServe.html?selfServeType%3Dsqlx

+

+
+
+
+
+
+ + +
+
+
+
+
+

Legend

+
+
    +
  • Function
    • +
  • Type alias
    • +
+
    +
  • Enumeration
    • +
+
    +
  • Interface
    • +
+
    +
  • Class
    • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/docs/modules/selfserve___what_is_currently_supported_.html b/docs/modules/selfserve___what_is_currently_supported_.html new file mode 100644 index 000000000..e044d593f --- /dev/null +++ b/docs/modules/selfserve___what_is_currently_supported_.html @@ -0,0 +1,149 @@ + + + + + + SelfServe - What is currently supported? | cosmos-explorer + + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Module SelfServe - What is currently supported?

+
+
+
+
+
+
+
+
+
+

The Self Serve framework has integrated support for

+
    +
  1. Portal Notifications
    2. +
  2. Telemetry
    3. +
  3. the following UI controls: +
    4. +
+
+
+
+
+
+ + +
+
+
+
+
+

Legend

+
+
    +
  • Function
    • +
  • Type alias
    • +
+
    +
  • Enumeration
    • +
+
    +
  • Interface
    • +
+
    +
  • Class
    • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/docs/modules/selfserve_decorators.html b/docs/modules/selfserve_decorators.html new file mode 100644 index 000000000..2605197ce --- /dev/null +++ b/docs/modules/selfserve_decorators.html @@ -0,0 +1,341 @@ + + + + + + SelfServe/Decorators | cosmos-explorer + + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Module SelfServe/Decorators

+
+
+
+
+
+
+
+

Index

+
+
+
+

Interfaces

+ +
+
+

Type aliases

+ +
+
+

Functions

+ +
+
+
+
+
+

Type aliases

+
+ +

InputOptions

+
InputOptions: NumberInputOptions | StringInputOptions | BooleanInputOptions | ChoiceInputOptions | DescriptionDisplayOptions
+ +
+
+

Interprets the type of the UI element and correspondingly renders

+
    +
  • slider or spinner
    • +
  • text box
    • +
  • toggle
    • +
  • drop down
    • +
  • plain text or message bar
    • +
+
+
+
+
+
+

Functions

+
+ +

Const IsDisplayable

+
    +
  • IsDisplayable(): ClassDecorator
    • +
+
    +
  • + +
    +
    +

    Indicates to the compiler that UI should be generated from this class.

    +
    +
    +

    Returns ClassDecorator

    +
    • +
+
+
+ +

Const OnChange

+ +
    +
  • + +
    +
    +

    Indicates the callback to be fired when the UI element corresponding to the property is changed.

    +
    +
    +

    Parameters

    + +

    Returns PropertyDecorator

    +
    • +
+
+
+ +

Const PropertyInfo

+
    +
  • PropertyInfo(info: Info | (() => Promise<Info>)): PropertyDecorator
    • +
+
    +
  • + +
    +
    +

    Indicates that the UI element corresponding to the property should have an Info bubble. The Info + bubble is the icon that looks like an "i" which users click on to get more information about the UI element.

    +
    +
    +

    Parameters

    +
      +
    • +
      info: Info | (() => Promise<Info>)
      +
      • +
    +

    Returns PropertyDecorator

    +
    • +
+
+
+ +

Const RefreshOptions

+
    +
  • RefreshOptions(refreshParams: RefreshParams): ClassDecorator
    • +
+
    +
  • + +
    +
    +

    If there is a long running operation in your page after the onSave action, the page can + optionally auto refresh itself using the onRefresh action. The 'RefreshOptions' indicate + how often the auto refresh of the page occurs.

    +
    +
    +

    Parameters

    + +

    Returns ClassDecorator

    +
    • +
+
+
+ +

Const Values

+ +
    +
  • + +
    +
    +

    Indicates that this property should correspond to a UI element with the given parameters.

    +
    +
    +

    Parameters

    + +

    Returns PropertyDecorator

    +
    • +
+
+
+
+
+ + +
+
+
+
+
+

Legend

+
+
    +
  • Function
    • +
  • Type alias
    • +
+
    +
  • Enumeration
    • +
+
    +
  • Interface
    • +
+
    +
  • Class
    • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/docs/modules/selfserve_selfservetelemetryprocessor.html b/docs/modules/selfserve_selfservetelemetryprocessor.html new file mode 100644 index 000000000..b70d893a9 --- /dev/null +++ b/docs/modules/selfserve_selfservetelemetryprocessor.html @@ -0,0 +1,323 @@ + + + + + + SelfServe/SelfServeTelemetryProcessor | cosmos-explorer + + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Module SelfServe/SelfServeTelemetryProcessor

+
+
+
+
+
+
+
+

Index

+
+
+
+

Functions

+ +
+
+
+
+
+

Functions

+
+ +

Const selfServeTrace

+ +
    +
  • + +
    +
    +

    Log an action.

    +
    +
    +

    Parameters

    + +

    Returns void

    +
    • +
+
+
+ +

Const selfServeTraceCancel

+ +
    +
  • + +
    +
    +

    Log an action as cancelled.

    +
    +
    +

    Parameters

    +
      +
    • +
      data: SelfServeTelemetryMessage
      +
      +

      Data to be sent as part of the Self Serve Telemetry.

      +
      +
      • +
    • +
      Optional timestamp: number
      +
      +

      Timestamp of the action's start trace.

      +
      +
      • +
    +

    Returns void

    +
    • +
+
+
+ +

Const selfServeTraceFailure

+ +
    +
  • + +
    +
    +

    Log an action as a failure.

    +
    +
    +

    Parameters

    +
      +
    • +
      data: SelfServeTelemetryMessage
      +
      +

      Data to be sent as part of the Self Serve Telemetry.

      +
      +
      • +
    • +
      Optional timestamp: number
      +
      +

      Timestamp of the action's start trace.

      +
      +
      • +
    +

    Returns void

    +
    • +
+
+
+ +

Const selfServeTraceStart

+ +
    +
  • + +
    +
    +

    Start logging an action.

    +
    +
    +

    Parameters

    + +

    Returns number

    +

    Timestamp of the trace start, that can be used in other trace actions. + The timestamp is used to identify all the logs associated with an action.

    +
    • +
+
+
+ +

Const selfServeTraceSuccess

+ +
    +
  • + +
    +
    +

    Log an action as a success.

    +
    +
    +

    Parameters

    +
      +
    • +
      data: SelfServeTelemetryMessage
      +
      +

      Data to be sent as part of the Self Serve Telemetry.

      +
      +
      • +
    • +
      Optional timestamp: number
      +
      +

      Timestamp of the action's start trace.

      +
      +
      • +
    +

    Returns void

    +
    • +
+
+
+
+
+ + +
+
+
+
+
+

Legend

+
+
    +
  • Function
    • +
  • Type alias
    • +
+
    +
  • Enumeration
    • +
+
    +
  • Interface
    • +
+
    +
  • Class
    • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/docs/modules/selfserve_selfservetypes.html b/docs/modules/selfserve_selfservetypes.html new file mode 100644 index 000000000..7edda26ee --- /dev/null +++ b/docs/modules/selfserve_selfservetypes.html @@ -0,0 +1,363 @@ + + + + + + SelfServe/SelfServeTypes | cosmos-explorer + + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Module SelfServe/SelfServeTypes

+
+
+
+
+
+
+
+

Index

+
+
+
+

Enumerations

+ +
+
+

Classes

+ +
+
+

Interfaces

+ +
+
+

Type aliases

+ +
+
+
+
+
+

Type aliases

+
+ +

ChoiceItem

+
ChoiceItem: { key: string; labelTKey: string }
+ +
+

Type declaration

+
    +
  • +
    key: string
    +
    +
    +

    Key used to pickup the string that uniquely identifies the dropdown choice item, from the strings JSON file.

    +
    +
    +
    • +
  • +
    labelTKey: string
    +
    +
    +

    Key used to pickup the string corresponding to the label of the dropdown choice item, from the strings JSON file.

    +
    +
    +
    • +
+
+
+
+ +

InputType

+
InputType: number | string | boolean | ChoiceItem | Description
+ +
+
+ +

OnChangeCallback

+
OnChangeCallback: (newValue: InputType, currentValues: Map<string, SmartUiInput>, baselineValues: ReadonlyMap<string, SmartUiInput>) => Map<string, SmartUiInput>
+ +
+
+

Function that dictates how the overall UI should transform when the UI element corresponding to a property, say prop1, is changed. + The callback can be used to
* Change the value (and reflect it in the UI) for another property, say prop2
* Change the visibility for prop2 in the UI
* Disable or enable the UI element corresponding to prop2
depending on logic based on the newValue of prop1, the currentValues Map and baselineValues Map.

+
+
+
+

Type declaration

+
    +
  • + +
      +
    • +

      Parameters

      +
        +
      • +
        newValue: InputType
        +
        +

        The newValue that the property needs to be set to, after the change in the UI element corresponding to this property.

        +
        +
        • +
      • +
        currentValues: Map<string, SmartUiInput>
        +
        +

        The map of propertyName => SmartUiInput corresponding to the current state of the UI.

        +
        +
        • +
      • +
        baselineValues: ReadonlyMap<string, SmartUiInput>
        +
        +

        The map of propertyName => SmartUiInput corresponding to the initial state of the UI.

        +
        +
        • +
      +

      Returns Map<string, SmartUiInput>

      +

      A new Map of propertyName => SmartUiInput corresponding to the new state of the overall UI

      +
      • +
    +
    • +
+
+
+
+ +

initializeCallback

+
initializeCallback: () => Promise<Map<string, SmartUiInput>>
+ +
+

Type declaration

+
    +
  • + +
      +
    • +

      Returns Promise<Map<string, SmartUiInput>>

      +

      Promise of Map of propertyName => SmartUiInput which will become the current state of the UI.

      +
      • +
    +
    • +
+
+
+
+ +

onSaveCallback

+
onSaveCallback: (currentValues: Map<string, SmartUiInput>, baselineValues: ReadonlyMap<string, SmartUiInput>) => Promise<OnSaveResult>
+ +
+

Type declaration

+ +
+
+
+
+
+ + +
+
+
+
+
+

Legend

+
+
    +
  • Function
    • +
  • Type alias
    • +
+
    +
  • Enumeration
    • +
+
    +
  • Interface
    • +
+
    +
  • Class
    • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/docs/modules/selfserve_selfserveutils.html b/docs/modules/selfserve_selfserveutils.html new file mode 100644 index 000000000..6dcb66f55 --- /dev/null +++ b/docs/modules/selfserve_selfserveutils.html @@ -0,0 +1,185 @@ + + + + + + SelfServe/SelfServeUtils | cosmos-explorer + + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Module SelfServe/SelfServeUtils

+
+
+
+
+
+
+
+

Index

+
+
+
+

Enumerations

+ +
+
+

Functions

+ +
+
+
+
+
+

Functions

+
+ +

Const generateBladeLink

+
    +
  • generateBladeLink(blade: BladeType): string
    • +
+
    +
  • + +
    +
    +

    Generate the URL corresponding to the portal blade for the current Azure Cosmos DB account

    +
    +
    +

    Parameters

    + +

    Returns string

    +
    • +
+
+
+
+
+ + +
+
+
+
+
+

Legend

+
+
    +
  • Function
    • +
  • Type alias
    • +
+
    +
  • Enumeration
    • +
+
    +
  • Interface
    • +
+
    +
  • Class
    • +
+
+
+
+
+

Generated using TypeDoc

+
+
+ + + \ No newline at end of file diff --git a/package-lock.json b/package-lock.json index a14e6d566..e5c3928bc 100644 --- a/package-lock.json +++ b/package-lock.json @@ -6787,6 +6787,12 @@ "resolved": "https://registry.npmjs.org/asynckit/-/asynckit-0.4.0.tgz", "integrity": "sha1-x57Zf380y48robyXkLzDZkdLS3k=" }, + "at-least-node": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/at-least-node/-/at-least-node-1.0.0.tgz", + "integrity": "sha512-+q/t7Ekv1EDY2l6Gda6LLiX14rU9TV20Wa3ofeQmwPFZbOMo9DXrLbOjFaaclkXKWidIaopwAObQDqwWtGUjqg==", + "dev": true + }, "atob": { "version": "2.1.2", "resolved": "https://registry.npmjs.org/atob/-/atob-2.1.2.tgz", @@ -8112,6 +8118,12 @@ "integrity": "sha512-puCDz0CzydiSYOrnXpz/PKd69zRrribezjtE9yd4zvytoRc8+RY/KJPvtPFKZS3E3wP6neGyMe0vOTlHO5L3Pw==", "dev": true }, + "colors": { + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/colors/-/colors-1.4.0.tgz", + "integrity": "sha512-a+UqTh4kgZg/SlGvfbzDHpgRu7AAQOmmqRHJnxhRZICKFUT91brVhNNt58CMWU9PsBbv3PDCZUHbVxuDiH2mtA==", + "dev": true + }, "combined-stream": { "version": "1.0.8", "resolved": "https://registry.npmjs.org/combined-stream/-/combined-stream-1.0.8.tgz", @@ -12147,6 +12159,27 @@ "integrity": "sha512-9Qn4yBxelxoh2Ow62nP+Ka/kMnOXRi8BXnRaUwezLNhqelnN49xKz4F/dPP8OYLxLxq6JDtZb2i9XznUQbNPTg==", "dev": true }, + "handlebars": { + "version": "4.7.7", + "resolved": "https://registry.npmjs.org/handlebars/-/handlebars-4.7.7.tgz", + "integrity": "sha512-aAcXm5OAfE/8IXkcZvCepKU3VzW1/39Fb5ZuqMtgI/hT8X2YgoMvBY5dLhq/cpOvw7Lk1nK/UF71aLG/ZnVYRA==", + "dev": true, + "requires": { + "minimist": "^1.2.5", + "neo-async": "^2.6.0", + "source-map": "^0.6.1", + "uglify-js": "^3.1.4", + "wordwrap": "^1.0.0" + }, + "dependencies": { + "source-map": { + "version": "0.6.1", + "resolved": "https://registry.npmjs.org/source-map/-/source-map-0.6.1.tgz", + "integrity": "sha512-UjgapumWlbMhkBgzT7Ykc5YXUT46F0iKu8SGXq0bcwP5dz/h0Plj6enJqjz1Zbq2l5WaqYnrVbwWOWMyF3F47g==", + "dev": true + } + } + }, "har-schema": { "version": "2.0.0", "resolved": "https://registry.npmjs.org/har-schema/-/har-schema-2.0.0.tgz", @@ -18632,6 +18665,12 @@ "yallist": "^4.0.0" } }, + "lunr": { + "version": "2.3.9", + "resolved": "https://registry.npmjs.org/lunr/-/lunr-2.3.9.tgz", + "integrity": "sha512-zTU3DaZaF3Rt9rhN3uBMGQD3dD2/vFQqnvZCDv4dl5iOzq2IZQqTxu90r4E5J+nP70J3ilqVCrbho2eWaeW8Ow==", + "dev": true + }, "lz-string": { "version": "1.4.4", "resolved": "https://registry.npmjs.org/lz-string/-/lz-string-1.4.4.tgz", @@ -18706,6 +18745,12 @@ "resolved": "https://registry.npmjs.org/markdown-escapes/-/markdown-escapes-1.0.4.tgz", "integrity": "sha512-8z4efJYk43E0upd0NbVXwgSTQs6cT3T06etieCMEg7dRbzCbxUCK/GHlX8mhHRDcp+OLlHkPKsvqQTCvsRl2cg==" }, + "marked": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/marked/-/marked-2.0.3.tgz", + "integrity": "sha512-5otztIIcJfPc2qGTN8cVtOJEjNJZ0jwa46INMagrYfk0EvqtRuEHLsEe0LrFS0/q+ZRKT0+kXK7P2T1AN5lWRA==", + "dev": true + }, "martinez-polygon-clipping": { "version": "0.1.5", "resolved": "https://registry.npmjs.org/martinez-polygon-clipping/-/martinez-polygon-clipping-0.1.5.tgz", @@ -19979,6 +20024,32 @@ "mimic-fn": "^2.1.0" } }, + "onigasm": { + "version": "2.2.5", + "resolved": "https://registry.npmjs.org/onigasm/-/onigasm-2.2.5.tgz", + "integrity": "sha512-F+th54mPc0l1lp1ZcFMyL/jTs2Tlq4SqIHKIXGZOR/VkHkF9A7Fr5rRr5+ZG/lWeRsyrClLYRq7s/yFQ/XhWCA==", + "dev": true, + "requires": { + "lru-cache": "^5.1.1" + }, + "dependencies": { + "lru-cache": { + "version": "5.1.1", + "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-5.1.1.tgz", + "integrity": "sha512-KpNARQA3Iwv+jTA0utUVVbrh+Jlrr1Fv0e56GGzAFOXN7dk/FviaDW8LHmK52DlcH4WP2n6gI8vN1aesBFgo9w==", + "dev": true, + "requires": { + "yallist": "^3.0.2" + } + }, + "yallist": { + "version": "3.1.1", + "resolved": "https://registry.npmjs.org/yallist/-/yallist-3.1.1.tgz", + "integrity": "sha512-a4UGQaWPH59mOXUYnAG2ewncQS4i4F43Tv3JoAM+s2VDAmS9NsK8GpDMLrCHPksFT7h3K6TOoUNn2pb7RoXx4g==", + "dev": true + } + } + }, "open": { "version": "7.3.1", "resolved": "https://registry.npmjs.org/open/-/open-7.3.1.tgz", @@ -22783,11 +22854,32 @@ "integrity": "sha512-mRz/m/JVscCrkMyPqHc/bczi3OQHkLTqXHEFu0zDhK/qfv3UcOA4SVmRCLmos4bhjr9ekVQubj/R7waKapmiQg==", "dev": true }, + "shelljs": { + "version": "0.8.4", + "resolved": "https://registry.npmjs.org/shelljs/-/shelljs-0.8.4.tgz", + "integrity": "sha512-7gk3UZ9kOfPLIAbslLzyWeGiEqx9e3rxwZM0KE6EL8GlGwjym9Mrlx5/p33bWTu9YG6vcS4MBxYZDHYr5lr8BQ==", + "dev": true, + "requires": { + "glob": "^7.0.0", + "interpret": "^1.0.0", + "rechoir": "^0.6.2" + } + }, "shellwords": { "version": "0.1.1", "resolved": "https://registry.npmjs.org/shellwords/-/shellwords-0.1.1.tgz", "integrity": "sha512-vFwSUfQvqybiICwZY5+DAWIPLKsWO31Q91JSKl3UYv+K5c2QRPzn0qzec6QPu1Qc9eHYItiP3NdJqNVqetYAww==" }, + "shiki": { + "version": "0.9.3", + "resolved": "https://registry.npmjs.org/shiki/-/shiki-0.9.3.tgz", + "integrity": "sha512-NEjg1mVbAUrzRv2eIcUt3TG7X9svX7l3n3F5/3OdFq+/BxUdmBOeKGiH4icZJBLHy354Shnj6sfBTemea2e7XA==", + "dev": true, + "requires": { + "onigasm": "^2.2.5", + "vscode-textmate": "^5.2.0" + } + }, "shimmer": { "version": "1.2.1", "resolved": "https://registry.npmjs.org/shimmer/-/shimmer-1.2.1.tgz", @@ -24252,6 +24344,67 @@ "is-typedarray": "^1.0.0" } }, + "typedoc": { + "version": "0.20.36", + "resolved": "https://registry.npmjs.org/typedoc/-/typedoc-0.20.36.tgz", + "integrity": "sha512-qFU+DWMV/hifQ9ZAlTjdFO9wbUIHuUBpNXzv68ZyURAP9pInjZiO4+jCPeAzHVcaBCHER9WL/+YzzTt6ZlN/Nw==", + "dev": true, + "requires": { + "colors": "^1.4.0", + "fs-extra": "^9.1.0", + "handlebars": "^4.7.7", + "lodash": "^4.17.21", + "lunr": "^2.3.9", + "marked": "^2.0.3", + "minimatch": "^3.0.0", + "progress": "^2.0.3", + "shelljs": "^0.8.4", + "shiki": "^0.9.3", + "typedoc-default-themes": "^0.12.10" + }, + "dependencies": { + "fs-extra": { + "version": "9.1.0", + "resolved": "https://registry.npmjs.org/fs-extra/-/fs-extra-9.1.0.tgz", + "integrity": "sha512-hcg3ZmepS30/7BSFqRvoo3DOMQu7IjqxO5nCDt+zM9XWjb33Wg7ziNT+Qvqbuc3+gWpzO02JubVyk2G4Zvo1OQ==", + "dev": true, + "requires": { + "at-least-node": "^1.0.0", + "graceful-fs": "^4.2.0", + "jsonfile": "^6.0.1", + "universalify": "^2.0.0" + } + }, + "jsonfile": { + "version": "6.1.0", + "resolved": "https://registry.npmjs.org/jsonfile/-/jsonfile-6.1.0.tgz", + "integrity": "sha512-5dgndWOriYSm5cnYaJNhalLNDKOqFwyDB/rr1E9ZsGciGvKPs8R2xYGCacuf3z6K1YKDz182fd+fY3cn3pMqXQ==", + "dev": true, + "requires": { + "graceful-fs": "^4.1.6", + "universalify": "^2.0.0" + } + }, + "lodash": { + "version": "4.17.21", + "resolved": "https://registry.npmjs.org/lodash/-/lodash-4.17.21.tgz", + "integrity": "sha512-v2kDEe57lecTulaDIuNTPy3Ry4gLGJ6Z1O3vE1krgXZNrsQ+LFTGHVxVjcXPs17LhbZVGedAJv8XZ1tvj5FvSg==", + "dev": true + }, + "universalify": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/universalify/-/universalify-2.0.0.tgz", + "integrity": "sha512-hAZsKq7Yy11Zu1DE0OzWjw7nnLZmJZYTDZZyEFHZdUhV8FkH5MCfoU1XMaxXovpyW5nq5scPqq0ZDP9Zyl04oQ==", + "dev": true + } + } + }, + "typedoc-default-themes": { + "version": "0.12.10", + "resolved": "https://registry.npmjs.org/typedoc-default-themes/-/typedoc-default-themes-0.12.10.tgz", + "integrity": "sha512-fIS001cAYHkyQPidWXmHuhs8usjP5XVJjWB8oZGqkTowZaz3v7g3KDZeeqE82FBrmkAnIBOY3jgy7lnPnqATbA==", + "dev": true + }, "typescript": { "version": "4.2.4", "resolved": "https://registry.npmjs.org/typescript/-/typescript-4.2.4.tgz", @@ -24740,6 +24893,12 @@ "resolved": "https://registry.npmjs.org/void-elements/-/void-elements-2.0.1.tgz", "integrity": "sha1-wGavtYK7HLQSjWDqkjkulNXp2+w=" }, + "vscode-textmate": { + "version": "5.4.0", + "resolved": "https://registry.npmjs.org/vscode-textmate/-/vscode-textmate-5.4.0.tgz", + "integrity": "sha512-c0Q4zYZkcLizeYJ3hNyaVUM2AA8KDhNCA3JvXY8CeZSJuBdAy3bAvSbv46RClC4P3dSO9BdwhnKEx2zOo6vP/w==", + "dev": true + }, "w3c-hr-time": { "version": "1.0.2", "resolved": "https://registry.npmjs.org/w3c-hr-time/-/w3c-hr-time-1.0.2.tgz", @@ -25701,6 +25860,12 @@ "resolved": "https://registry.npmjs.org/word-wrap/-/word-wrap-1.2.3.tgz", "integrity": "sha512-Hz/mrNwitNRh/HUAtM/VT/5VH+ygD6DV7mYKZAtHOrbs8U7lvPS6xf7EJKMF0uW1KJCl0H701g3ZGus+muE5vQ==" }, + "wordwrap": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/wordwrap/-/wordwrap-1.0.0.tgz", + "integrity": "sha1-J1hIEIkUVqQXHI0CJkQa3pDLyus=", + "dev": true + }, "worker-farm": { "version": "1.7.0", "resolved": "https://registry.npmjs.org/worker-farm/-/worker-farm-1.7.0.tgz", diff --git a/package.json b/package.json index caf25c982..01b536804 100644 --- a/package.json +++ b/package.json @@ -174,6 +174,7 @@ "ts-loader": "6.2.2", "tslint": "5.11.0", "tslint-microsoft-contrib": "6.0.0", + "typedoc": "0.20.36", "typescript": "4.2.4", "url-loader": "1.1.1", "wait-on": "4.0.2", @@ -196,6 +197,7 @@ "watch": "npm run start", "wait-for-server": "wait-on -t 240000 -i 5000 -v https-get://0.0.0.0:1234/", "build:ase": "gulp build:ase", + "selfServeDocs": "typedoc", "compile": "tsc", "compile:contracts": "tsc -p ./tsconfig.contracts.json", "compile:strict": "tsc -p ./tsconfig.strict.json", diff --git a/src/SelfServe/Decorators.tsx b/src/SelfServe/Decorators.tsx index a855533ec..3d85024a0 100644 --- a/src/SelfServe/Decorators.tsx +++ b/src/SelfServe/Decorators.tsx @@ -1,5 +1,9 @@ -import { ChoiceItem, Description, Info, InputType, NumberUiType, SmartUiInput, RefreshParams } from "./SelfServeTypes"; -import { addPropertyToMap, DecoratorProperties, buildSmartUiDescriptor } from "./SelfServeUtils"; +/** + * @module SelfServe/Decorators + */ + +import { ChoiceItem, Description, Info, NumberUiType, OnChangeCallback, RefreshParams } from "./SelfServeTypes"; +import { addPropertyToMap, buildSmartUiDescriptor, DecoratorProperties } from "./SelfServeUtils"; type ValueOf = T[keyof T]; interface Decorator { @@ -8,37 +12,99 @@ interface Decorator { } interface InputOptionsBase { + /** + * Key used to pickup the string corresponding to the label of the UI element, from the strings JSON file. + */ labelTKey: string; } +/** + * Numeric input UI element is rendered. The current options are to render it as a slider or a spinner. + */ export interface NumberInputOptions extends InputOptionsBase { + /** + * Min value of the numeric input UI element + */ min: (() => Promise) | number; + /** + * Max value of the numeric input UI element + */ max: (() => Promise) | number; + /** + * Value by which the numeric input is incremented or decremented in the UI. + */ step: (() => Promise) | number; + /** + * The type of the numeric input UI element + */ uiType: NumberUiType; } +/** + * Text box is rendered. + */ export interface StringInputOptions extends InputOptionsBase { + /** + * Key used to pickup the string corresponding to the place holder text of the text box, from the strings JSON file. + */ placeholderTKey?: (() => Promise) | string; } +/** + * Toggle is rendered. + */ export interface BooleanInputOptions extends InputOptionsBase { + /** + * Key used to pickup the string corresponding to the true label of the toggle, from the strings JSON file. + */ trueLabelTKey: (() => Promise) | string; + /** + * Key used to pickup the string corresponding to the false label of the toggle, from the strings JSON file. + */ falseLabelTKey: (() => Promise) | string; } +/** + * Dropdown is rendered. + */ export interface ChoiceInputOptions extends InputOptionsBase { + /** + * Choices to be shown in the dropdown + */ choices: (() => Promise) | ChoiceItem[]; + /** + * Key used to pickup the string corresponding to the placeholder text of the dropdown, from the strings JSON file. + */ placeholderTKey?: (() => Promise) | string; } +/** + * Text is rendered. + */ export interface DescriptionDisplayOptions { + /** + * Optional heading for the text displayed by this description element. + */ labelTKey?: string; + /** + * Static description to be shown as text. + */ description?: (() => Promise) | Description; + /** + * If true, Indicates that the Description will be populated dynamically and that it may not be present in some scenarios. + */ isDynamicDescription?: boolean; } -type InputOptions = +/** + * Interprets the type of the UI element and correspondingly renders + * - slider or spinner + * - text box + * - toggle + * - drop down + * - plain text or message bar + */ +export type InputOptions = | NumberInputOptions | StringInputOptions | BooleanInputOptions @@ -81,20 +147,24 @@ const addToMap = (...decorators: Decorator[]): PropertyDecorator => { }; }; -export const OnChange = ( - onChange: ( - newValue: InputType, - currentState: Map, - baselineValues: ReadonlyMap - ) => Map -): PropertyDecorator => { +/** + * Indicates the callback to be fired when the UI element corresponding to the property is changed. + */ +export const OnChange = (onChange: OnChangeCallback): PropertyDecorator => { return addToMap({ name: "onChange", value: onChange }); }; +/** + * Indicates that the UI element corresponding to the property should have an Info bubble. The Info + * bubble is the icon that looks like an "i" which users click on to get more information about the UI element. + */ export const PropertyInfo = (info: (() => Promise) | Info): PropertyDecorator => { return addToMap({ name: "info", value: info }); }; +/** + * Indicates that this property should correspond to a UI element with the given parameters. + */ export const Values = (inputOptions: InputOptions): PropertyDecorator => { if (isNumberInputOptions(inputOptions)) { return addToMap( @@ -130,12 +200,20 @@ export const Values = (inputOptions: InputOptions): PropertyDecorator => { } }; +/** + * Indicates to the compiler that UI should be generated from this class. + */ export const IsDisplayable = (): ClassDecorator => { return (target) => { buildSmartUiDescriptor(target.name, target.prototype); }; }; +/** + * If there is a long running operation in your page after the {@linkcode onSave} action, the page can + * optionally auto refresh itself using the {@linkcode onRefresh} action. The 'RefreshOptions' indicate + * how often the auto refresh of the page occurs. + */ export const RefreshOptions = (refreshParams: RefreshParams): ClassDecorator => { return (target) => { addPropertyToMap(target.prototype, "root", target.name, "refreshParams", refreshParams); diff --git a/src/SelfServe/Documentation/Documentation.ts b/src/SelfServe/Documentation/Documentation.ts new file mode 100644 index 000000000..ecc294b1d --- /dev/null +++ b/src/SelfServe/Documentation/Documentation.ts @@ -0,0 +1,5 @@ +/** + * [[include: README.md]] + * + * @module SelfServe + */ diff --git a/src/SelfServe/Documentation/README.md b/src/SelfServe/Documentation/README.md new file mode 100644 index 000000000..884c9eb7b --- /dev/null +++ b/src/SelfServe/Documentation/README.md @@ -0,0 +1,357 @@ +# Self Serve Model + +The Self Serve Model allows you to write classes that auto generate UI components for your feature. The idea is to allow developers from other feature teams, who may not be familiar with writing UI, to develop and own UX components. This is accomplished by just writing simpler TypeScript classes for their features. + +What this means for the feature team +- Can concentrate just on the logic behind showing, hiding and disabling UI components +- Need not worry about specifics of the UI language or UX requirements (Accessibility, Localization, Themes, etc.) +- Can own the REST API calls made as part of the feature, which can change in the future +- Quicker turn around time for development and bug fixes since they have deeper knowledge of the feature + +What this means for the UI team +- No need to ramp up on the intricacies of every feature which requires UI changes +- Own only the framework and not every feature, giving more bandwidth to prioritize inhouse features as well + +## Getting Started + +Clone the cosmos-explorer repo and run + +- `npm install` +- `npm run build` + +[Click here](../index.html) for more info on setting up the cosmos-explorer repo. + +## Code Changes + +Code changes need to be made only in the following files +- A JSON file - for strings to be displayed +- A Types File - for defining the data models +- A RP file - for defining the REST calls +- A Class file - for defining the UI +- [SelfServeUtils.tsx](https://github.com/Azure/cosmos-explorer/blob/master/src/SelfServe/SelfServeUtils.tsx) and [SelfServe.tsx](https://github.com/Azure/cosmos-explorer/blob/master/src/SelfServe/SelfServe.tsx) - for defning the entrypoint for the UI + +### 1. JSON file for UI strings + +#### Naming Convention +`Localization/en/.json`\ +Please place your files only under "Localization/en" folder. If not, the UI strings will not be picked up by the framework. + +#### Example +[SelfServeExample.json](https://github.com/Azure/cosmos-explorer/blob/master/src/Localization/en/SelfServeExample.json) + +#### Description +This is a JSON file where the values are the strings that needs to be displayed in the UI. These strings are referenced using their corresponding unique keys. + +For example, If your class file defines properties as follows +```ts + @Values({ + labelTKey: "stringPropertylabel" + }) + stringProperty: string; + + @Values({ + labelTKey: "booleanPropertyLabel", + trueLabelTKey: "trueLabel", + falseLabelTKey: "falseLabel", + }) + booleanProperty: boolean; +``` + +Then the content of `Localization/en/FeatureName.json` should be + +```json +{ + stringPropertyLabel: "string property", + booleanPropertyLabel: "boolean property", + trueLabel: "Enable", + falseLabel: "Disable" +} +``` +You can learn more on how to define the class file [here](./selfserve.html#4-class-file). + +### 2. Types file + +#### Naming Convention +`.types.ts` + +#### Example +[SelfServeExample.types.ts](https://github.com/Azure/cosmos-explorer/blob/master/src/SelfServe/Example/SelfServeExample.types.ts) + +#### Description +This file contains the definitions of all the data models to be used in your Class file and RP file. + +For example, if your RP call takes/returns the `stringProperty` and `booleanProperty` of your SelfServe class, then you can define an interface in your `FeatureName.types.ts` file like this. + +```ts +export RpDataModel { + stringProperty: string, + booleanProperty: boolean +} +``` + +### 3. RP file + +#### Naming Convention +`.rp.ts` + +#### Example +[SelfServeExample.rp.ts](https://github.com/Azure/cosmos-explorer/blob/master/src/SelfServe/Example/SelfServeExample.rp.ts) + +#### Description +The RP file will host the REST calls needed for the initialize, save and refresh functions. This decouples the view and the model of the feature. + +To make the ARM call, we need some information about the Azure Cosmos DB databaseAccount - the subscription id, resource group name and database account name. These are readily available through the `userContext` object, exposed through + +* `userContext.subscriptionId` +* `userContext.resourceGroup` +* `userContext.databaseAccount.name` + +You can use the `armRequestWithoutPolling` function to make the ARM api call. + +Your `FeatureName.rp.ts` file can look like the following. + +```ts +import { userContext } from "../../UserContext"; +import { armRequestWithoutPolling } from "../../Utils/arm/request"; +import { configContext } from "../../ConfigContext"; + +const apiVersion = "2020-06-01-preview"; + +export const saveData = async (properties: RpDataModel): Promise => { + const path = `/subscriptions/${userContext.subscriptionId}/resourceGroups/${userContext.resourceGroup}/providers/Microsoft.DocumentDB/databaseAccounts/${userContext.databaseAccount.name}/` + const body = { + data : properties + } + const armRequestResult = await armRequestWithoutPolling({ + host: configContext.ARM_ENDPOINT, + path, + method: "PUT", + apiVersion, + body, + }); + + return armRequestResult.operationStatusUrl; +}; + +``` + +### 4. Class file + +#### Naming Convention +`.tsx` + +#### Example +[SelfServeExample.tsx](https://github.com/Azure/cosmos-explorer/blob/master/src/SelfServe/Example/SelfServeExample.tsx) + +#### Description +This file will contain the actual code that is translated into the UI component by the Self Serve framework. +* Each Self Serve class + * Needs to extends the [SelfServeBase](../classes/selfserve_selfservetypes.selfservebaseclass.html) class. + * Needs to have the [@IsDisplayable()](./selfserve_decorators.html#isdisplayable) decorator to tell the compiler that UI needs to be generated from this class. + * Needs to define an [initialize()](../classes/selfserve_selfservetypes.selfservebaseclass.html#initialize) function, to set default values for the inputs. + * Needs to define an [onSave()](../classes/selfserve_selfservetypes.selfservebaseclass.html#onsave) function, a callback for when the save button is clicked. + * Needs to define an [onRefresh()](../classes/selfserve_selfservetypes.selfservebaseclass.html#onrefresh) function, a callback for when the refresh button is clicked. + * Can have an optional [@RefreshOptions()](./selfserve_decorators.html#refreshoptions) decorator that determines how often the auto refresh of the UI component should take place. + +* For every UI element needed, add a property to the Self Serve class. Each of these properties + * Needs to have a [@Values()](./selfserve_decorators.html#values) decorator. + * Can have an optional [@PropertyInfo()](./selfserve_decorators.html#propertyinfo) decorator that describes it's info bubble. + * Can have an optional [@OnChange()](./selfserve_decorators.html#onchange) decorator that dictates the effects of the change of the UI element tied to this property. + +Your `FeatureName.tsx` file will look like the following. +```ts +@IsDisplayable() +@RefreshOptions({ retryIntervalInMs: 2000 }) +export default class FeatureName extends SelfServeBaseClass { + + public initialize = async (): Promise> => { + // initialize RP call and processing logic + } + + public onSave = async ( + currentValues: Map, + baselineValues: ReadonlyMap + ): Promise => { + // onSave RP call and processing logic + } + + public onRefresh = async (): Promise => { + // refresh RP call and processing logic + }; + + @Values(...) + stringProperty: string; + + @OnChange(...) + @PropertyInfo(...) + @Values(...) + booleanProperty: boolean; +} +``` + +### 5. Update SelfServeType + +Once you have written your Self Serve Class, add a corresponding type to [SelfServeType](../enums/selfserve_selfserveutils.selfservetype.html) + +```ts +export enum SelfServeType { + invalid = "invalid", + example = "example", + ... + // Add the type for your new feature + featureName = "featurename" +} +``` + +### 6. Update SelfServe.tsx (landing page) + +Once the SelfServeType has been updated, update [SelfServe.tsx](https://github.com/Azure/cosmos-explorer/blob/master/src/SelfServe/SelfServe.tsx) for your feature. This ensures that the framework picks up your SelfServe Class. + +```ts +const getDescriptor = async (selfServeType: SelfServeType): Promise => { + switch (selfServeType) { + case SelfServeType.example: { + .... + } + ... + ... + ... + // Add this for your new feature + case SelfServeType.featureName: { + // The 'webpackChunkName' is used during debugging, to identify if the correct class has been loaded + const FeatureName = await import(/* webpackChunkName: "FeatureName" */ "./FeatureName/FeatureName"); + const featureName = new FeatureName.default(); + await loadTranslations(featureName.constructor.name); + return featureName.toSelfServeDescriptor(); + } + ... + ... + default: + return undefined; + } +}; + +``` + +## Telemetry +You can add telemetry for your feature using the functions in [SelfServeTelemetryProcessor](./selfserve_selfservetelemetryprocessor.html) + +For example, in your SelfServe class, you can call the trace method in your `onSave` function. + +```ts +import { saveData } from "./FeatureName.rp" +import { RpDataModel } from "./FeatureName.types" + +@IsDisplayable() +export default class FeatureName extends SelfServeBaseClass { + + . + . + . + + public onSave = async ( + currentValues: Map, + baselineValues: ReadonlyMap + ): Promise => { + + stringPropertyValue = currentValues.get("stringProperty") + booleanPropertyValue = currentValues.get("booleanProperty") + + const propertiesToSave : RpDataModel = { + stringProperty: stringPropertyValue, + booleanProperty: booleanPropertyValue + } + const telemetryData = { ...propertiesToSave, selfServeClassName: FeatureName.name } + const onSaveTimeStamp = selfServeTraceStart(telemetryData) + + await saveData(propertiesToSave) + + selfServeTraceSuccess(telemetryData, onSaveTimeStamp) + + // return required values + } + + . + . + . + + @Values(...) + stringProperty: string; + + @Values(...) + booleanProperty: boolean; +} +``` +## Portal Notifications +You can enable portal notifications for your feature by passing in the required strings as part of the [portalNotification](../interfaces/selfserve_selfservetypes.onsaveresult.html#portalnotification) property of the [onSaveResult](../interfaces/selfserve_selfservetypes.onsaveresult.html). + +```ts +@IsDisplayable() +export default class SqlX extends SelfServeBaseClass { + +. +. +. + + public onSave = async ( + currentValues: Map, + baselineValues: Map + ): Promise => { + + stringPropertyValue = currentValues.get("stringProperty") + booleanPropertyValue = currentValues.get("booleanProperty") + + const propertiesToSave : RpDataModel = { + stringProperty: stringPropertyValue, + booleanProperty: booleanPropertyValue + } + + const operationStatusUrl = await saveData(propertiesToSave); + return { + operationStatusUrl: operationStatusUrl, + portalNotification: { + initialize: { + titleTKey: "DeleteInitializeTitle", + messageTKey: "DeleteInitializeMessage", + }, + success: { + titleTKey: "DeleteSuccessTitle", + messageTKey: "DeleteSuccesseMessage", + }, + failure: { + titleTKey: "DeleteFailureTitle", + messageTKey: "DeleteFailureMessage", + }, + }, + }; + } + + . + . + . + + @Values(...) + stringProperty: string; + + @Values(...) + booleanProperty: boolean; +} +``` + +## Execution + +### Watch mode + +Run `npm start` to start the development server and automatically rebuild on changes + +### Local Development + +Ensure that you have made the [Code changes](./selfserve.html#code-changes). + +- Go to `https://ms.portal.azure.com/` +- Add the query string `feature.showSelfServeExample=true&feature.selfServeSource=https://localhost:1234/selfServe.html?selfServeType%3D` +- Click on the `Self Serve Example` menu item on the left panel. + +For example, if you want to open up the the UI of a class with the type `sqlx`, then visit `https://ms.portal.azure.com/?feature.showSelfServeExample=true&feature.selfServeSource=https://localhost:1234/selfServe.html?selfServeType%3Dsqlx` + +![](https://sdkctlstore.blob.core.windows.net/exe/selfserveDev.PNG) diff --git a/src/SelfServe/Documentation/SupportedFeatures.md b/src/SelfServe/Documentation/SupportedFeatures.md new file mode 100644 index 000000000..f4820cc1d --- /dev/null +++ b/src/SelfServe/Documentation/SupportedFeatures.md @@ -0,0 +1,12 @@ +The Self Serve framework has integrated support for + +1. [Portal Notifications](./selfserve.html#portal-notifications) +2. [Telemetry](./selfserve.html#telemetry) +3. the following UI controls: + * [Slider](https://developer.microsoft.com/en-us/fluentui#/controls/web/slider) + * [SpinButton](https://developer.microsoft.com/en-us/fluentui#/controls/web/spinbutton) + * [TextField](https://developer.microsoft.com/en-us/fluentui#/controls/web/textfield) + * [Toggle](https://developer.microsoft.com/en-us/fluentui#/controls/web/toggle) + * [Dropdown](https://developer.microsoft.com/en-us/fluentui#/controls/web/dropdown) + * [Link](https://developer.microsoft.com/en-us/fluentui#/controls/web/link) + * [MessageBar](https://developer.microsoft.com/en-us/fluentui#/controls/web/messagebar) diff --git a/src/SelfServe/Documentation/SupportedFeatures.ts b/src/SelfServe/Documentation/SupportedFeatures.ts new file mode 100644 index 000000000..5e23dde1c --- /dev/null +++ b/src/SelfServe/Documentation/SupportedFeatures.ts @@ -0,0 +1,5 @@ +/** + * [[include: SupportedFeatures.md]] + * + * @module SelfServe - What is currently supported? + */ diff --git a/src/SelfServe/Example/SelfServeExample.rp.ts b/src/SelfServe/Example/SelfServeExample.rp.ts index f0da48641..360a8717a 100644 --- a/src/SelfServe/Example/SelfServeExample.rp.ts +++ b/src/SelfServe/Example/SelfServeExample.rp.ts @@ -2,19 +2,7 @@ import { SessionStorageUtility } from "../../Shared/StorageUtility"; import { userContext } from "../../UserContext"; import { get } from "../../Utils/arm/generatedClients/2020-04-01/databaseAccounts"; import { RefreshResult } from "../SelfServeTypes"; -export enum Regions { - NorthCentralUS = "NorthCentralUS", - WestUS = "WestUS", - EastUS2 = "EastUS2", -} - -export interface InitializeResponse { - regions: Regions; - enableLogging: boolean; - accountName: string; - collectionThroughput: number; - dbThroughput: number; -} +import { AccountProps, Regions } from "./SelfServeExample.types"; export const getMaxCollectionThroughput = async (): Promise => { return 10000; @@ -32,21 +20,19 @@ export const getMinDatabaseThroughput = async (): Promise => { return 400; }; -export const update = async ( - regions: Regions, - enableLogging: boolean, - accountName: string, - collectionThroughput: number, - dbThoughput: number -): Promise => { - SessionStorageUtility.setEntry("regions", regions); - SessionStorageUtility.setEntry("enableLogging", enableLogging?.toString()); - SessionStorageUtility.setEntry("accountName", accountName); - SessionStorageUtility.setEntry("collectionThroughput", collectionThroughput?.toString()); - SessionStorageUtility.setEntry("dbThroughput", dbThoughput?.toString()); +export const update = async (accountProps: AccountProps): Promise => { + // This is only an example. DO NOT store actual data in the Session/Local storage for your SelfServe feature. + + SessionStorageUtility.setEntry("regions", accountProps.regions); + SessionStorageUtility.setEntry("enableLogging", accountProps.enableLogging?.toString()); + SessionStorageUtility.setEntry("accountName", accountProps.accountName); + SessionStorageUtility.setEntry("collectionThroughput", accountProps.collectionThroughput?.toString()); + SessionStorageUtility.setEntry("dbThroughput", accountProps.dbThroughput?.toString()); }; -export const initialize = async (): Promise => { +export const initialize = async (): Promise => { + // This is only an example. DO NOT store actual data in the Session/Local storage for your SelfServe feature. + const regions = Regions[SessionStorageUtility.getEntry("regions") as keyof typeof Regions]; const enableLogging = SessionStorageUtility.getEntry("enableLogging") === "true"; const accountName = SessionStorageUtility.getEntry("accountName"); @@ -64,6 +50,8 @@ export const initialize = async (): Promise => { }; export const onRefreshSelfServeExample = async (): Promise => { + // This is only an example. DO NOT store actual data in the Session/Local storage for your SelfServe feature. + const refreshCountString = SessionStorageUtility.getEntry("refreshCount"); const refreshCount = refreshCountString ? parseInt(refreshCountString) : 0; diff --git a/src/SelfServe/Example/SelfServeExample.tsx b/src/SelfServe/Example/SelfServeExample.tsx index a533a26f7..004ff993d 100644 --- a/src/SelfServe/Example/SelfServeExample.tsx +++ b/src/SelfServe/Example/SelfServeExample.tsx @@ -1,4 +1,5 @@ import { IsDisplayable, OnChange, PropertyInfo, RefreshOptions, Values } from "../Decorators"; +import { selfServeTraceStart, selfServeTraceSuccess } from "../SelfServeTelemetryProcessor"; import { ChoiceItem, Description, @@ -18,9 +19,9 @@ import { getMinDatabaseThroughput, initialize, onRefreshSelfServeExample, - Regions, update, } from "./SelfServeExample.rp"; +import { AccountProps, Regions } from "./SelfServeExample.types"; const regionDropdownItems: ChoiceItem[] = [ { labelTKey: "NorthCentralUS", key: Regions.NorthCentralUS }, @@ -73,61 +74,16 @@ const validate = ( } }; -/* - This is an example self serve class that auto generates UI components for your feature. - - Each self serve class - - Needs to extends the SelfServeBase class. - - Needs to have the @IsDisplayable() decorator to tell the compiler that UI needs to be generated from this class. - - Needs to define an onSave() function, a callback for when the submit button is clicked. - - Needs to define an initialize() function, to set default values for the inputs. - - Needs to define an onRefresh() function, a callback for when the refresh button is clicked. - - You can test this self serve UI by using the featureflag '?feature.selfServeType=example' - and plumb in similar feature flags for your own self serve class. - - All string to be used should be present in the "src/Localization" folder, in the language specific json files. The - corresponding key should be given as the value for the fields like "label", the error message etc. -*/ - -/* - @IsDisplayable() - - role: Indicates to the compiler that UI should be generated from this class. -*/ @IsDisplayable() -/* - @RefreshOptions() - - role: Passes the refresh options to be used by the self serve model. - - inputs: - retryIntervalInMs - The time interval between refresh attempts when an update in ongoing. -*/ @RefreshOptions({ retryIntervalInMs: 2000 }) export default class SelfServeExample extends SelfServeBaseClass { - /* - onRefresh() - - role : Callback that is triggerrd when the refresh button is clicked. You should perform the your rest API - call to check if the update action is completed. - - returns: - RefreshResult - - isComponentUpdating: Indicated if the state is still being updated - notificationMessage: Notification message to be shown in case the component is still being updated - i.e, isComponentUpdating is true - */ public onRefresh = async (): Promise => { return onRefreshSelfServeExample(); }; /* - onSave() - - input: (currentValues: Map, baselineValues: ReadonlyMap) => Promise - - role: Callback that is triggerred when the submit button is clicked. You should perform your rest API - calls here using the data from the different inputs passed as a Map to this callback function. - - In this example, the onSave callback simply sets the value for keys corresponding to the field name - in the SessionStorage. It uses the currentValues and baselineValues maps to perform custom validations - as well. - - - returns: The initialize, success and failure messages to be displayed in the Portal Notification blade after the operation is completed. + In this example, the onSave callback simply sets the value for keys corresponding to the field name in the SessionStorage. + It uses the currentValues and baselineValues maps to perform custom validations as well. */ public onSave = async ( currentValues: Map, @@ -142,7 +98,13 @@ export default class SelfServeExample extends SelfServeBaseClass { let dbThroughput = currentValues.get("dbThroughput")?.value as number; dbThroughput = enableDbLevelThroughput ? dbThroughput : undefined; try { - await update(regions, enableLogging, accountName, collectionThroughput, dbThroughput); + const accountProps: AccountProps = { regions, enableLogging, accountName, collectionThroughput, dbThroughput }; + const telemetryData = { ...accountProps, selfServeClassName: SelfServeExample.name }; + + const onSaveTimeStamp = selfServeTraceStart(telemetryData); + await update(accountProps); + selfServeTraceSuccess(telemetryData, onSaveTimeStamp); + if (currentValues.get("regions") === baselineValues.get("regions")) { return { operationStatusUrl: undefined, @@ -186,19 +148,8 @@ export default class SelfServeExample extends SelfServeBaseClass { }; /* - initialize() - - role: Set default values for the properties of this class. - - The properties of this class (namely regions, enableLogging, accountName, dbThroughput, collectionThroughput), - having the @Values decorator, will each correspond to an UI element. Their values can be of 'InputType'. Their - defaults can be set by setting values in a Map corresponding to the field's name. - - Typically, you can make rest calls in the async initialize function, to fetch the initial values for - these fields. This is called after the onSave callback, to reinitialize the defaults. - - In this example, the initialize function simply reads the SessionStorage to fetch the default values - for these fields. These are then set when the changes are submitted. - - returns: () => Promise> + In this example, the initialize function simply reads the SessionStorage to fetch the default values + for these fields. These are then set when the changes are submitted. */ public initialize = async (): Promise> => { const initializeResponse = await initialize(); @@ -215,16 +166,6 @@ export default class SelfServeExample extends SelfServeBaseClass { return defaults; }; - /* - @Values() : - - input: NumberInputOptions | StringInputOptions | BooleanInputOptions | ChoiceInputOptions | DescriptionDisplay - - role: Specifies the required options to display the property as - a) TextBox for text input - b) Spinner/Slider for number input - c) Radio buton/Toggle for boolean input - d) Dropdown for choice input - e) Text (with optional hyperlink) for descriptions - */ @Values({ labelTKey: "DescriptionLabel", description: { @@ -244,28 +185,12 @@ export default class SelfServeExample extends SelfServeBaseClass { }) currentRegionText: string; - /* - @PropertyInfo() - - optional - - input: Info | () => Promise - - role: Display an Info bar above the UI element for this property. - */ @PropertyInfo(regionDropdownInfo) /* - @OnChange() - - optional - - input: (currentValues: Map, newValue: InputType, baselineValues: ReadonlyMap) => Map - - role: Takes a Map of current values, the newValue for this property and a ReadonlyMap of baselineValues as inputs. This is called when a property, - say prop1, changes its value in the UI. This can be used to - a) Change the value (and reflect it in the UI) for prop2 based on prop1. - b) Change the visibility for prop2 in the UI, based on prop1 - - The new Map of propertyName -> value is returned. - - In this example, the onRegionsChange function sets the enableLogging property to false (and disables - the corresponsing toggle UI) when "regions" is set to "North Central US", and enables the toggle for - any other value of "regions" + In this example, the onRegionsChange function sets the enableLogging property to false (and disables + the corresponsing toggle UI) when "regions" is set to "North Central US", and enables the toggle for + any other value of "regions" */ @OnChange(onRegionsChange) @Values({ labelTKey: "Regions", choices: regionDropdownItems, placeholderTKey: "RegionsPlaceholder" }) diff --git a/src/SelfServe/Example/SelfServeExample.types.ts b/src/SelfServe/Example/SelfServeExample.types.ts new file mode 100644 index 000000000..79e2726fa --- /dev/null +++ b/src/SelfServe/Example/SelfServeExample.types.ts @@ -0,0 +1,13 @@ +export enum Regions { + NorthCentralUS = "NorthCentralUS", + WestUS = "WestUS", + EastUS2 = "EastUS2", +} + +export interface AccountProps { + regions: Regions; + enableLogging: boolean; + accountName: string; + collectionThroughput: number; + dbThroughput: number; +} diff --git a/src/SelfServe/SelfServe.tsx b/src/SelfServe/SelfServe.tsx index 27d868756..50f6eecf8 100644 --- a/src/SelfServe/SelfServe.tsx +++ b/src/SelfServe/SelfServe.tsx @@ -86,7 +86,7 @@ const handleMessage = async (event: MessageEvent): Promise => { } const urlSearchParams = new URLSearchParams(window.location.search); - const selfServeTypeText = inputs.selfServeType || urlSearchParams.get("selfServeType"); + const selfServeTypeText = urlSearchParams.get("selfServeType") || inputs.selfServeType; const selfServeType = SelfServeType[selfServeTypeText?.toLowerCase() as keyof typeof SelfServeType]; if ( !inputs.subscriptionId || diff --git a/src/SelfServe/SelfServeTelemetryProcessor.ts b/src/SelfServe/SelfServeTelemetryProcessor.ts index 0cdf81a15..ac5376abc 100644 --- a/src/SelfServe/SelfServeTelemetryProcessor.ts +++ b/src/SelfServe/SelfServeTelemetryProcessor.ts @@ -1,24 +1,53 @@ +/** + * @module SelfServe/SelfServeTelemetryProcessor + */ + import { SelfServeMessageTypes } from "../Contracts/SelfServeContracts"; import { Action, ActionModifiers } from "../Shared/Telemetry/TelemetryConstants"; import { trace, traceCancel, traceFailure, traceStart, traceSuccess } from "../Shared/Telemetry/TelemetryProcessor"; import { SelfServeTelemetryMessage } from "./SelfServeTypes"; +/** + * Log an action. + * @param data Data to be sent as part of the Self Serve Telemetry. + */ export const selfServeTrace = (data: SelfServeTelemetryMessage): void => { trace(Action.SelfServe, ActionModifiers.Mark, data, SelfServeMessageTypes.TelemetryInfo); }; +/** + * Start logging an action. + * @param data Data to be sent as part of the Self Serve Telemetry. + * @returns Timestamp of the trace start, that can be used in other trace actions. + * The timestamp is used to identify all the logs associated with an action. + */ export const selfServeTraceStart = (data: SelfServeTelemetryMessage): number => { return traceStart(Action.SelfServe, data, SelfServeMessageTypes.TelemetryInfo); }; +/** + * Log an action as a success. + * @param data Data to be sent as part of the Self Serve Telemetry. + * @param timestamp Timestamp of the action's start trace. + */ export const selfServeTraceSuccess = (data: SelfServeTelemetryMessage, timestamp?: number): void => { traceSuccess(Action.SelfServe, data, timestamp, SelfServeMessageTypes.TelemetryInfo); }; +/** + * Log an action as a failure. + * @param data Data to be sent as part of the Self Serve Telemetry. + * @param timestamp Timestamp of the action's start trace. + */ export const selfServeTraceFailure = (data: SelfServeTelemetryMessage, timestamp?: number): void => { traceFailure(Action.SelfServe, data, timestamp, SelfServeMessageTypes.TelemetryInfo); }; +/** + * Log an action as cancelled. + * @param data Data to be sent as part of the Self Serve Telemetry. + * @param timestamp Timestamp of the action's start trace. + */ export const selfServeTraceCancel = (data: SelfServeTelemetryMessage, timestamp?: number): void => { traceCancel(Action.SelfServe, data, timestamp, SelfServeMessageTypes.TelemetryInfo); }; diff --git a/src/SelfServe/SelfServeTypes.ts b/src/SelfServe/SelfServeTypes.ts index 518d76fee..0428d663d 100644 --- a/src/SelfServe/SelfServeTypes.ts +++ b/src/SelfServe/SelfServeTypes.ts @@ -1,3 +1,7 @@ +/** + * @module SelfServe/SelfServeTypes + */ + import { TelemetryData } from "../Shared/Telemetry/TelemetryProcessor"; interface BaseInput { @@ -13,6 +17,7 @@ interface BaseInput { placeholderTKey?: (() => Promise) | string; } +/**@internal */ export interface NumberInput extends BaseInput { min: (() => Promise) | number; max: (() => Promise) | number; @@ -21,25 +26,30 @@ export interface NumberInput extends BaseInput { uiType: NumberUiType; } +/**@internal */ export interface BooleanInput extends BaseInput { trueLabelTKey: (() => Promise) | string; falseLabelTKey: (() => Promise) | string; defaultValue?: boolean; } +/**@internal */ export interface StringInput extends BaseInput { defaultValue?: string; } +/**@internal */ export interface ChoiceInput extends BaseInput { choices: (() => Promise) | ChoiceItem[]; defaultKey?: string; } +/**@internal */ export interface DescriptionDisplay extends BaseInput { description: (() => Promise) | Description; } +/**@internal */ export interface Node { id: string; info?: (() => Promise) | Info; @@ -47,6 +57,7 @@ export interface Node { children?: Node[]; } +/**@internal */ export interface SelfServeDescriptor { root: Node; initialize?: () => Promise>; @@ -59,16 +70,51 @@ export interface SelfServeDescriptor { refreshParams?: RefreshParams; } +/**@internal */ export type AnyDisplay = NumberInput | BooleanInput | StringInput | ChoiceInput | DescriptionDisplay; -export abstract class SelfServeBaseClass { - public abstract initialize: () => Promise>; - public abstract onSave: ( +/**@internal */ +export type InputTypeValue = "number" | "string" | "boolean" | "object"; + +export type initializeCallback = + /** + * @returns Promise of Map of propertyName => {@linkcode SmartUiInput} which will become the current state of the UI. + */ + () => Promise>; + +export type onSaveCallback = + /** + * @param currentValues - The map of propertyName => {@linkcode SmartUiInput} corresponding to the current state of the UI + * @param baselineValues - The map of propertyName => {@linkcode SmartUiInput} corresponding to the initial state of the UI + */ + ( currentValues: Map, baselineValues: ReadonlyMap ) => Promise; + +/** + * All SelfServe feature classes need to derive from the SelfServeBaseClass + */ +export abstract class SelfServeBaseClass { + /** + * Sets default values for the properties of the Self Serve Class. Typically, you can make rest calls here + * to fetch the initial values for the properties. This is also called after the onSave callback, to reinitialize the defaults. + */ + public abstract initialize: initializeCallback; + + /** + * Callback that is triggerred when the submit button is clicked. You should perform your rest API + * calls here using the data from the different inputs passed as a Map to this callback function. + */ + public abstract onSave: onSaveCallback; + + /** + * Callback that is triggered when the refresh button is clicked. Here, you should perform the your rest API + * call to check if the update action is completed. + */ public abstract onRefresh: () => Promise; + /**@internal */ public toSelfServeDescriptor(): SelfServeDescriptor { const className = this.constructor.name; const selfServeDescriptor = Reflect.getMetadata(className, this) as SelfServeDescriptor; @@ -95,73 +141,202 @@ export abstract class SelfServeBaseClass { } } -export type InputTypeValue = "number" | "string" | "boolean" | "object"; +/** + * Function that dictates how the overall UI should transform when the UI element corresponding to a property, say prop1, is changed. + * The callback can be used to\ + * * Change the value (and reflect it in the UI) for another property, say prop2\ + * * Change the visibility for prop2 in the UI\ + * * Disable or enable the UI element corresponding to prop2\ + * depending on logic based on the newValue of prop1, the currentValues Map and baselineValues Map. + */ +export type OnChangeCallback = + /** + * @param newValue - The newValue that the property needs to be set to, after the change in the UI element corresponding to this property. + * @param currentValues - The map of propertyName => {@linkcode SmartUiInput} corresponding to the current state of the UI. + * @param baselineValues - The map of propertyName => {@linkcode SmartUiInput} corresponding to the initial state of the UI. + * @returns A new Map of propertyName => {@linkcode SmartUiInput} corresponding to the new state of the overall UI + */ + ( + newValue: InputType, + currentValues: Map, + baselineValues: ReadonlyMap + ) => Map; export enum NumberUiType { + /** + * The numeric input UI element corresponding to the property is a Spinner + */ Spinner = "Spinner", + /** + * The numeric input UI element corresponding to the property is a Slider + */ Slider = "Slider", } -export type ChoiceItem = { labelTKey: string; key: string }; +export type ChoiceItem = { + /** + * Key used to pickup the string corresponding to the label of the dropdown choice item, from the strings JSON file. + */ + labelTKey: string; + /** + * Key used to pickup the string that uniquely identifies the dropdown choice item, from the strings JSON file. + */ + key: string; +}; export type InputType = number | string | boolean | ChoiceItem | Description; +/** + * Data to be shown within the info bubble of the property. + */ export interface Info { + /** + * Key used to pickup the string corresponding to the text to be shown within the info bubble, from the strings JSON file. + */ messageTKey: string; + /** + * Optional link to be shown within the info bubble, after the text. + */ link?: { + /** + * The URL of the link + */ href: string; + /** + * Key used to pickup the string corresponding to the text of the link, from the strings JSON file. + */ textTKey: string; }; } export enum DescriptionType { + /** + * Show the description as a text + */ Text, + /** + * Show the description as a Info Message bar. + */ InfoMessageBar, + /** + * Show the description as a Warning Message bar. + */ WarningMessageBar, } +/** + * Data to be shown as a description. + */ export interface Description { + /** + * Key used to pickup the string corresponding to the text to be shown as part of the description, from the strings JSON file. + */ textTKey: string; type: DescriptionType; + /** + * Optional link to be shown as part of the description, after the text. + */ link?: { + /** + * The URL of the link + */ href: string; + /** + * Key used to pickup the string corresponding to the text of the link, from the strings JSON file. + */ textTKey: string; }; } export interface SmartUiInput { + /** + * The value to be set for the UI element corresponding to the property + */ value: InputType; + /** + * Indicates whether the UI element corresponding to the property is hidden + */ hidden?: boolean; + /** + * Indicates whether the UI element corresponding to the property is disabled + */ disabled?: boolean; } export interface OnSaveResult { + /** + * The polling url returned by the RP call. + */ operationStatusUrl: string; + /** + * Notifications that need to be shown on the portal for different stages of a scenario (initialized, success/failure). + */ portalNotification?: { + /** + * Notification that need to be shown when the save operation has been triggered. + */ initialize: { + /** + * Key used to pickup the string corresponding to the notification title, from the strings JSON file. + */ titleTKey: string; + /** + * Key used to pickup the string corresponding to the notification message, from the strings JSON file. + */ messageTKey: string; }; + /** + * Notification that need to be shown when the save operation has successfully completed. + */ success: { + /** + * Key used to pickup the string corresponding to the notification title, from the strings JSON file. + */ titleTKey: string; + /** + * Key used to pickup the string corresponding to the notification message, from the strings JSON file. + */ messageTKey: string; }; + /** + * Notification that need to be shown when the save operation failed. + */ failure: { + /** + * Key used to pickup the string corresponding to the notification title, from the strings JSON file. + */ titleTKey: string; + /** + * Key used to pickup the string corresponding to the notification message, from the strings JSON file. + */ messageTKey: string; }; }; } export interface RefreshResult { + /** + * Indicate if the update is still ongoing + */ isUpdateInProgress: boolean; + + /** + * Key used to pickup the string corresponding to the message that will be shown on the UI if the update is still ongoing, from the strings JSON file. + * Will be shown only if {@linkcode isUpdateInProgress} is true. + */ updateInProgressMessageTKey: string; } export interface RefreshParams { + /** + * The time interval between refresh attempts when an update in ongoing + */ retryIntervalInMs: number; } export interface SelfServeTelemetryMessage extends TelemetryData { + /** + * The className used to identify a SelfServe telemetry record + */ selfServeClassName: string; } diff --git a/src/SelfServe/SelfServeUtils.tsx b/src/SelfServe/SelfServeUtils.tsx index e82084069..3c34bc982 100644 --- a/src/SelfServe/SelfServeUtils.tsx +++ b/src/SelfServe/SelfServeUtils.tsx @@ -1,3 +1,7 @@ +/** + * @module SelfServe/SelfServeUtils + */ + import "reflect-metadata"; import { userContext } from "../UserContext"; import { @@ -18,9 +22,10 @@ import { StringInput, } from "./SelfServeTypes"; +/** + * The type used to identify the Self Serve Class + */ export enum SelfServeType { - // No self serve type passed, launch explorer - none = "none", // Unsupported self serve type passed as feature flag invalid = "invalid", // Add your self serve types here @@ -28,15 +33,47 @@ export enum SelfServeType { sqlx = "sqlx", } +/** + * Portal Blade types + */ export enum BladeType { + /** + * Keys blade of a SQL API account. + */ SqlKeys = "keys", + /** + * Keys blade of a Mongo API account. + */ MongoKeys = "mongoDbKeys", + /** + * Keys blade of a Cassandra API account. + */ CassandraKeys = "cassandraDbKeys", + /** + * Keys blade of a Gremlin API account. + */ GremlinKeys = "keys", + /** + * Keys blade of a Table API account. + */ TableKeys = "tableKeys", + /** + * Metrics blade of an Azure Cosmos DB account. + */ Metrics = "metrics", } +/** + * Generate the URL corresponding to the portal blade for the current Azure Cosmos DB account + */ +export const generateBladeLink = (blade: BladeType): string => { + const subscriptionId = userContext.subscriptionId; + const resourceGroupName = userContext.resourceGroup; + const databaseAccountName = userContext.databaseAccount.name; + return `${document.referrer}#@microsoft.onmicrosoft.com/resource/subscriptions/${subscriptionId}/resourceGroups/${resourceGroupName}/providers/Microsoft.DocumentDb/databaseAccounts/${databaseAccountName}/${blade}`; +}; + +/**@internal */ export interface DecoratorProperties { id: string; info?: (() => Promise) | Info; @@ -62,6 +99,7 @@ export interface DecoratorProperties { ) => Map; } +/**@internal */ const setValue = ( name: T, value: K, @@ -70,10 +108,12 @@ const setValue = (name: T, fieldObject: DecoratorProperties): unknown => { return fieldObject[name]; }; +/**@internal */ export const addPropertyToMap = ( target: unknown, propertyName: string, @@ -88,6 +128,7 @@ export const addPropertyToMap = ( context: Map, propertyName: string, @@ -111,12 +152,14 @@ export const updateContextWithDecorator = { const context = Reflect.getMetadata(className, target) as Map; const smartUiDescriptor = mapToSmartUiDescriptor(context); Reflect.defineMetadata(className, smartUiDescriptor, target); }; +/**@internal */ export const mapToSmartUiDescriptor = (context: Map): SelfServeDescriptor => { const inputNames: string[] = []; const root = context.get("root"); @@ -140,6 +183,7 @@ export const mapToSmartUiDescriptor = (context: Map return smartUiDescriptor; }; +/**@internal */ const addToDescriptor = ( context: Map, root: Node, @@ -158,6 +202,7 @@ const addToDescriptor = ( root.children.push(element); }; +/**@internal */ const getInput = (value: DecoratorProperties): AnyDisplay => { switch (value.type) { case "number": @@ -188,10 +233,3 @@ const getInput = (value: DecoratorProperties): AnyDisplay => { return value as ChoiceInput; } }; - -export const generateBladeLink = (blade: BladeType): string => { - const { subscriptionId, resourceGroup, databaseAccount } = userContext; - const databaseAccountName = databaseAccount.name; - - return `${document.referrer}#@microsoft.onmicrosoft.com/resource/subscriptions/${subscriptionId}/resourceGroups/${resourceGroup}/providers/Microsoft.DocumentDb/databaseAccounts/${databaseAccountName}/${blade}`; -}; diff --git a/tsconfig.json b/tsconfig.json index 29814265e..45097fb68 100644 --- a/tsconfig.json +++ b/tsconfig.json @@ -28,6 +28,20 @@ "jest" ] }, + "typedocOptions": { + "entryPoints": [ + "./src/SelfServe/Documentation/Documentation.ts", + "./src/SelfServe/Documentation/SupportedFeatures.ts", + "./src/SelfServe/Decorators.tsx", + "./src/SelfServe/SelfServeTypes.ts", + "./src/SelfServe/SelfServeUtils.tsx", + "./src/SelfServe/SelfServeTelemetryProcessor.ts" + ], + "out": "docs", + "excludeInternal": true, + "includes": "./src/SelfServe/Documentation", + "disableSources": true + }, "include": [ "./src/**/*", "./utils/**/*" From 48eeb8419d5a842ee43fe1ec739633f6ce732d02 Mon Sep 17 00:00:00 2001 From: fnbalaji <75445927+fnbalaji@users.noreply.github.com> Date: Mon, 17 May 2021 22:15:26 -0700 Subject: [PATCH 005/124] Portal changes for DedicatedGateway (#742) * src/SelfServe/Example/SelfServeExample.rp.ts. Portal changes for DedicatedGateway 1. Change Sqlx endpoints to SqlDedicatedGateway endpoint 2. Remove D32s from the SKU list 3. Add telemetry 4. Remove SKU details field per discussion 5. Support dynamic instance scaling. * format files to ensure format check and lint tests pass * Lint fixes * Lint fixes * Added metrics blade link * updated conditions for warning banner * fixed lint error * Incorporate metrics link and CR feedback * Lint fixes * CR feedback and fix links * CR feedback and fix links * Link fix Co-authored-by: Srinath Narayanan --- src/Localization/en/SqlX.json | 9 ++- src/SelfServe/SqlX/SqlX.rp.ts | 83 ++++++++++++++------- src/SelfServe/SqlX/SqlX.tsx | 135 +++++++++++++++++++++------------- 3 files changed, 147 insertions(+), 80 deletions(-) diff --git a/src/Localization/en/SqlX.json b/src/Localization/en/SqlX.json index 3c1d81dac..e2128a40e 100644 --- a/src/Localization/en/SqlX.json +++ b/src/Localization/en/SqlX.json @@ -37,16 +37,19 @@ "CannotSave": "Cannot save the changes to the Dedicated gateway resource at the moment.", "DedicatedGatewayEndpoint": "Dedicated gatewayEndpoint", "NoValue": "", - "SKUDetails": "SKU Details:", "CosmosD4Details": "General Purpose Cosmos Compute with 4 vCPUs, 16 GB Memory", "CosmosD8Details": "General Purpose Cosmos Compute with 8 vCPUs, 32 GB Memory", "CosmosD16Details": "General Purpose Cosmos Compute with 16 vCPUs, 64 GB Memory", - "CosmosD32Details": "General Purpose Cosmos Compute with 32 vCPUs, 128 GB Memory", "Cost": "Cost", "CostText": "Hourly cost of the dedicated gateway resource depends on the SKU selection, number of instances per region, and number of regions.", "ConnectionString": "Connection String", "ConnectionStringText": "To use the dedicated gateway, use the connection string shown in ", - "KeysBlade": "the keys blade", + "KeysBlade": "the keys blade.", + "MetricsString": "Metrics", + "MetricsText": "Monitor the \"DedicatedGatewayMaximumCpuUsage\" and \"DedicatedGatewayAverageMemoryUsage\" in ", + "MetricsBlade": "the metrics blade.", + "ResizingDecisionText": "To understand if the dedicated gateway is the right size, ", + "ResizingDecisionLink": "learn more about dedicated gateway sizing.", "WarningBannerOnUpdate": "Adding or modifying dedicated gateway instances may affect your bill.", "WarningBannerOnDelete": "After deprovisioning the dedicated gateway, you must update any applications using the old dedicated gateway connection string." } \ No newline at end of file diff --git a/src/SelfServe/SqlX/SqlX.rp.ts b/src/SelfServe/SqlX/SqlX.rp.ts index b5a097fca..2bc7a70fa 100644 --- a/src/SelfServe/SqlX/SqlX.rp.ts +++ b/src/SelfServe/SqlX/SqlX.rp.ts @@ -1,10 +1,12 @@ -import { RefreshResult } from "../SelfServeTypes"; +import { configContext } from "../../ConfigContext"; import { userContext } from "../../UserContext"; import { armRequestWithoutPolling } from "../../Utils/arm/request"; -import { configContext } from "../../ConfigContext"; +import { selfServeTraceFailure, selfServeTraceStart, selfServeTraceSuccess } from "../SelfServeTelemetryProcessor"; +import { RefreshResult } from "../SelfServeTypes"; +import SqlX from "./SqlX"; import { SqlxServiceResource, UpdateDedicatedGatewayRequestParameters } from "./SqlxTypes"; -const apiVersion = "2020-06-01-preview"; +const apiVersion = "2021-04-01-preview"; export enum ResourceStatus { Running = "Running", @@ -21,7 +23,7 @@ export interface DedicatedGatewayResponse { } export const getPath = (subscriptionId: string, resourceGroup: string, name: string): string => { - return `/subscriptions/${subscriptionId}/resourceGroups/${resourceGroup}/providers/Microsoft.DocumentDB/databaseAccounts/${name}/services/sqlx`; + return `/subscriptions/${subscriptionId}/resourceGroups/${resourceGroup}/providers/Microsoft.DocumentDB/databaseAccounts/${name}/services/SqlDedicatedGateway`; }; export const updateDedicatedGatewayResource = async (sku: string, instances: number): Promise => { @@ -30,39 +32,66 @@ export const updateDedicatedGatewayResource = async (sku: string, instances: num properties: { instanceSize: sku, instanceCount: instances, - serviceType: "Sqlx", + serviceType: "SqlDedicatedGateway", }, }; - const armRequestResult = await armRequestWithoutPolling({ - host: configContext.ARM_ENDPOINT, - path, - method: "PUT", - apiVersion, - body, - }); - return armRequestResult.operationStatusUrl; + const telemetryData = { ...body, httpMethod: "PUT", selfServeClassName: SqlX.name }; + const updateTimeStamp = selfServeTraceStart(telemetryData); + let armRequestResult; + try { + armRequestResult = await armRequestWithoutPolling({ + host: configContext.ARM_ENDPOINT, + path, + method: "PUT", + apiVersion, + body, + }); + selfServeTraceSuccess(telemetryData, updateTimeStamp); + } catch (e) { + const failureTelemetry = { ...body, e, selfServeClassName: SqlX.name }; + selfServeTraceFailure(failureTelemetry, updateTimeStamp); + } + return armRequestResult?.operationStatusUrl; }; export const deleteDedicatedGatewayResource = async (): Promise => { const path = getPath(userContext.subscriptionId, userContext.resourceGroup, userContext.databaseAccount.name); - const armRequestResult = await armRequestWithoutPolling({ - host: configContext.ARM_ENDPOINT, - path, - method: "DELETE", - apiVersion, - }); - return armRequestResult.operationStatusUrl; + const telemetryData = { httpMethod: "DELETE", selfServeClassName: SqlX.name }; + const deleteTimeStamp = selfServeTraceStart(telemetryData); + let armRequestResult; + try { + armRequestResult = await armRequestWithoutPolling({ + host: configContext.ARM_ENDPOINT, + path, + method: "DELETE", + apiVersion, + }); + selfServeTraceSuccess(telemetryData, deleteTimeStamp); + } catch (e) { + const failureTelemetry = { e, selfServeClassName: SqlX.name }; + selfServeTraceFailure(failureTelemetry, deleteTimeStamp); + } + return armRequestResult?.operationStatusUrl; }; export const getDedicatedGatewayResource = async (): Promise => { const path = getPath(userContext.subscriptionId, userContext.resourceGroup, userContext.databaseAccount.name); - const armRequestResult = await armRequestWithoutPolling({ - host: configContext.ARM_ENDPOINT, - path, - method: "GET", - apiVersion, - }); - return armRequestResult.result; + const telemetryData = { httpMethod: "GET", selfServeClassName: SqlX.name }; + const getResourceTimeStamp = selfServeTraceStart(telemetryData); + let armRequestResult; + try { + armRequestResult = await armRequestWithoutPolling({ + host: configContext.ARM_ENDPOINT, + path, + method: "GET", + apiVersion, + }); + selfServeTraceSuccess(telemetryData, getResourceTimeStamp); + } catch (e) { + const failureTelemetry = { e, selfServeClassName: SqlX.name }; + selfServeTraceFailure(failureTelemetry, getResourceTimeStamp); + } + return armRequestResult?.result; }; export const getCurrentProvisioningState = async (): Promise => { diff --git a/src/SelfServe/SqlX/SqlX.tsx b/src/SelfServe/SqlX/SqlX.tsx index a532c5244..44356969a 100644 --- a/src/SelfServe/SqlX/SqlX.tsx +++ b/src/SelfServe/SqlX/SqlX.tsx @@ -23,7 +23,7 @@ const costPerHourValue: Description = { textTKey: "CostText", type: DescriptionType.Text, link: { - href: "https://azure.microsoft.com/en-us/pricing/details/cosmos-db/", + href: "https://aka.ms/cosmos-db-dedicated-gateway-pricing", textTKey: "DedicatedGatewayPricing", }, }; @@ -37,43 +37,56 @@ const connectionStringValue: Description = { }, }; +const metricsStringValue: Description = { + textTKey: "MetricsText", + type: DescriptionType.Text, + link: { + href: generateBladeLink(BladeType.Metrics), + textTKey: "MetricsBlade", + }, +}; + +const resizingDecisionValue: Description = { + textTKey: "ResizingDecisionText", + type: DescriptionType.Text, + link: { + href: "https://aka.ms/cosmos-db-dedicated-gateway-size", + textTKey: "ResizingDecisionLink", + }, +}; + const CosmosD4s = "Cosmos.D4s"; const CosmosD8s = "Cosmos.D8s"; const CosmosD16s = "Cosmos.D16s"; -const CosmosD32s = "Cosmos.D32s"; - -const getSKUDetails = (sku: string): string => { - if (sku === CosmosD4s) { - return "CosmosD4Details"; - } else if (sku === CosmosD8s) { - return "CosmosD8Details"; - } else if (sku === CosmosD16s) { - return "CosmosD16Details"; - } else if (sku === CosmosD32s) { - return "CosmosD32Details"; - } - return "Not Supported Yet"; -}; const onSKUChange = (newValue: InputType, currentValues: Map): Map => { currentValues.set("sku", { value: newValue }); - currentValues.set("skuDetails", { - value: { textTKey: getSKUDetails(`${newValue.toString()}`), type: DescriptionType.Text } as Description, - }); currentValues.set("costPerHour", { value: costPerHourValue }); return currentValues; }; const onNumberOfInstancesChange = ( newValue: InputType, - currentValues: Map + currentValues: Map, + baselineValues: Map ): Map => { currentValues.set("instances", { value: newValue }); - currentValues.set("warningBanner", { - value: { textTKey: "WarningBannerOnUpdate" } as Description, - hidden: false, - }); - + const dedicatedGatewayOriginallyEnabled = baselineValues.get("enableDedicatedGateway")?.value as boolean; + const baselineInstances = baselineValues.get("instances")?.value as number; + if (!dedicatedGatewayOriginallyEnabled || baselineInstances !== newValue) { + currentValues.set("warningBanner", { + value: { + textTKey: "WarningBannerOnUpdate", + link: { + href: "https://aka.ms/cosmos-db-dedicated-gateway-overview", + textTKey: "DedicatedGatewayPricing", + }, + } as Description, + hidden: false, + }); + } else { + currentValues.set("warningBanner", undefined); + } return currentValues; }; @@ -87,10 +100,11 @@ const onEnableDedicatedGatewayChange = ( if (dedicatedGatewayOriginallyEnabled === newValue) { currentValues.set("sku", baselineValues.get("sku")); currentValues.set("instances", baselineValues.get("instances")); - currentValues.set("skuDetails", baselineValues.get("skuDetails")); currentValues.set("costPerHour", baselineValues.get("costPerHour")); currentValues.set("warningBanner", baselineValues.get("warningBanner")); currentValues.set("connectionString", baselineValues.get("connectionString")); + currentValues.set("metricsString", baselineValues.get("metricsString")); + currentValues.set("resizingDecisionString", baselineValues.get("resizingDecisionString")); return currentValues; } @@ -100,7 +114,7 @@ const onEnableDedicatedGatewayChange = ( value: { textTKey: "WarningBannerOnUpdate", link: { - href: "https://docs.microsoft.com/en-us/azure/cosmos-db/introduction", + href: "https://aka.ms/cosmos-db-dedicated-gateway-pricing", textTKey: "DedicatedGatewayPricing", }, } as Description, @@ -111,7 +125,7 @@ const onEnableDedicatedGatewayChange = ( value: { textTKey: "WarningBannerOnDelete", link: { - href: "https://docs.microsoft.com/en-us/azure/cosmos-db/introduction", + href: "https://aka.ms/cosmos-db-dedicated-gateway-overview", textTKey: "DeprovisioningDetailsText", }, } as Description, @@ -132,18 +146,22 @@ const onEnableDedicatedGatewayChange = ( disabled: dedicatedGatewayOriginallyEnabled, }); - currentValues.set("skuDetails", { - value: { textTKey: getSKUDetails(`${currentValues.get("sku").value}`), type: DescriptionType.Text } as Description, - hidden: hideAttributes, - disabled: dedicatedGatewayOriginallyEnabled, - }); - currentValues.set("costPerHour", { value: costPerHourValue, hidden: hideAttributes }); currentValues.set("connectionString", { value: connectionStringValue, hidden: !newValue || !dedicatedGatewayOriginallyEnabled, }); + currentValues.set("metricsString", { + value: metricsStringValue, + hidden: !newValue || !dedicatedGatewayOriginallyEnabled, + }); + + currentValues.set("resizingDecisionString", { + value: resizingDecisionValue, + hidden: !newValue || !dedicatedGatewayOriginallyEnabled, + }); + return currentValues; }; @@ -151,7 +169,6 @@ const skuDropDownItems: ChoiceItem[] = [ { labelTKey: "CosmosD4s", key: CosmosD4s }, { labelTKey: "CosmosD8s", key: CosmosD8s }, { labelTKey: "CosmosD16s", key: CosmosD16s }, - { labelTKey: "CosmosD32s", key: CosmosD32s }, ]; const getSkus = async (): Promise => { @@ -184,7 +201,6 @@ export default class SqlX extends SelfServeBaseClass { currentValues.set("warningBanner", undefined); - //TODO : Add try catch for each RP call and return relevant notifications if (dedicatedGatewayOriginallyEnabled) { if (!dedicatedGatewayCurrentlyEnabled) { const operationStatusUrl = await deleteDedicatedGatewayResource(); @@ -206,9 +222,11 @@ export default class SqlX extends SelfServeBaseClass { }, }; } else { - // Check for scaling up/down/in/out + const sku = currentValues.get("sku")?.value as string; + const instances = currentValues.get("instances").value as number; + const operationStatusUrl = await updateDedicatedGatewayResource(sku, instances); return { - operationStatusUrl: undefined, + operationStatusUrl: operationStatusUrl, portalNotification: { initialize: { titleTKey: "UpdateInitializeTitle", @@ -255,24 +273,37 @@ export default class SqlX extends SelfServeBaseClass { defaults.set("enableDedicatedGateway", { value: false }); defaults.set("sku", { value: CosmosD4s, hidden: true }); defaults.set("instances", { value: await getInstancesMin(), hidden: true }); - defaults.set("skuDetails", undefined); defaults.set("costPerHour", undefined); defaults.set("connectionString", undefined); + defaults.set("metricsString", { + value: undefined, + hidden: true, + }); + defaults.set("resizingDecisionString", { + value: undefined, + hidden: true, + }); const response = await getCurrentProvisioningState(); if (response.status && response.status !== "Deleting") { defaults.set("enableDedicatedGateway", { value: true }); defaults.set("sku", { value: response.sku, disabled: true }); - defaults.set("instances", { value: response.instances, disabled: true }); + defaults.set("instances", { value: response.instances, disabled: false }); defaults.set("costPerHour", { value: costPerHourValue }); - defaults.set("skuDetails", { - value: { textTKey: getSKUDetails(`${defaults.get("sku").value}`), type: DescriptionType.Text } as Description, - hidden: false, - }); defaults.set("connectionString", { value: connectionStringValue, hidden: false, }); + + defaults.set("metricsString", { + value: metricsStringValue, + hidden: false, + }); + + defaults.set("resizingDecisionString", { + value: resizingDecisionValue, + hidden: false, + }); } defaults.set("warningBanner", undefined); @@ -289,7 +320,7 @@ export default class SqlX extends SelfServeBaseClass { textTKey: "DedicatedGatewayDescription", type: DescriptionType.Text, link: { - href: "https://docs.microsoft.com/en-us/azure/cosmos-db/introduction", + href: "https://aka.ms/cosmos-db-dedicated-gateway-overview", textTKey: "LearnAboutDedicatedGateway", }, }, @@ -312,12 +343,6 @@ export default class SqlX extends SelfServeBaseClass { }) sku: ChoiceItem; - @Values({ - labelTKey: "SKUDetails", - isDynamicDescription: true, - }) - skuDetails: string; - @OnChange(onNumberOfInstancesChange) @Values({ labelTKey: "NumberOfInstances", @@ -328,6 +353,16 @@ export default class SqlX extends SelfServeBaseClass { }) instances: number; + @Values({ + description: metricsStringValue, + }) + metricsString: string; + + @Values({ + description: resizingDecisionValue, + }) + resizingDecisionString: string; + @Values({ labelTKey: "Cost", isDynamicDescription: true, From 2bc298fef12264afa1b34b464d84f5fc521aae63 Mon Sep 17 00:00:00 2001 From: Zachary Foster Date: Tue, 18 May 2021 18:59:09 -0400 Subject: [PATCH 006/124] [Hosted] AAD implementation for item operations (#643) --- src/Common/CosmosClient.ts | 9 ++++++++- src/Common/dataAccess/createDocument.ts | 2 +- src/Common/dataAccess/queryDocuments.ts | 2 +- src/Common/dataAccess/queryDocumentsPage.ts | 4 ++-- src/Contracts/ExplorerContracts.ts | 2 +- src/HostedExplorer.tsx | 21 +++++++++++---------- src/HostedExplorerChildFrame.ts | 1 + src/Platform/Hosted/extractFeatures.ts | 2 ++ src/Terminal/index.ts | 10 +++++----- src/UserContext.ts | 1 + src/hooks/useAADAuth.ts | 9 ++++++++- src/hooks/useKnockoutExplorer.ts | 1 + 12 files changed, 42 insertions(+), 22 deletions(-) diff --git a/src/Common/CosmosClient.ts b/src/Common/CosmosClient.ts index 9ba100b3b..756c53a2e 100644 --- a/src/Common/CosmosClient.ts +++ b/src/Common/CosmosClient.ts @@ -10,6 +10,13 @@ const _global = typeof self === "undefined" ? window : self; export const tokenProvider = async (requestInfo: RequestInfo) => { const { verb, resourceId, resourceType, headers } = requestInfo; + + if (userContext.features.enableAadDataPlane && userContext.aadToken) { + const AUTH_PREFIX = `type=aad&ver=1.0&sig=`; + const authorizationToken = `${AUTH_PREFIX}${userContext.aadToken}`; + return authorizationToken; + } + if (configContext.platform === Platform.Emulator) { // TODO This SDK method mutates the headers object. Find a better one or fix the SDK. await setAuthorizationTokenHeaderUsingMasterKey(verb, resourceId, resourceType, headers, EmulatorMasterKey); @@ -76,7 +83,7 @@ export function client(): Cosmos.CosmosClient { if (_client) return _client; const options: Cosmos.CosmosClientOptions = { endpoint: endpoint() || "https://cosmos.azure.com", // CosmosClient gets upset if we pass a bad URL. This should never actually get called - key: userContext.masterKey, + ...(!userContext.features.enableAadDataPlane && { key: userContext.masterKey }), tokenProvider, connectionPolicy: { enableEndpointDiscovery: false, diff --git a/src/Common/dataAccess/createDocument.ts b/src/Common/dataAccess/createDocument.ts index b64f70ff9..94dde951d 100644 --- a/src/Common/dataAccess/createDocument.ts +++ b/src/Common/dataAccess/createDocument.ts @@ -1,8 +1,8 @@ import { CollectionBase } from "../../Contracts/ViewModels"; +import { logConsoleInfo, logConsoleProgress } from "../../Utils/NotificationConsoleUtils"; import { client } from "../CosmosClient"; import { getEntityName } from "../DocumentUtility"; import { handleError } from "../ErrorHandlingUtils"; -import { logConsoleInfo, logConsoleProgress } from "../../Utils/NotificationConsoleUtils"; export const createDocument = async (collection: CollectionBase, newDocument: unknown): Promise => { const entityName = getEntityName(); diff --git a/src/Common/dataAccess/queryDocuments.ts b/src/Common/dataAccess/queryDocuments.ts index 16b2fb39e..c24e22ff6 100644 --- a/src/Common/dataAccess/queryDocuments.ts +++ b/src/Common/dataAccess/queryDocuments.ts @@ -1,6 +1,6 @@ -import { Queries } from "../Constants"; import { FeedOptions, ItemDefinition, QueryIterator, Resource } from "@azure/cosmos"; import { LocalStorageUtility, StorageKey } from "../../Shared/StorageUtility"; +import { Queries } from "../Constants"; import { client } from "../CosmosClient"; export const queryDocuments = ( diff --git a/src/Common/dataAccess/queryDocumentsPage.ts b/src/Common/dataAccess/queryDocumentsPage.ts index 064e4126f..e8b5447ef 100644 --- a/src/Common/dataAccess/queryDocumentsPage.ts +++ b/src/Common/dataAccess/queryDocumentsPage.ts @@ -1,8 +1,8 @@ import { QueryResults } from "../../Contracts/ViewModels"; import { logConsoleInfo, logConsoleProgress } from "../../Utils/NotificationConsoleUtils"; -import { MinimalQueryIterator, nextPage } from "../IteratorUtilities"; -import { handleError } from "../ErrorHandlingUtils"; import { getEntityName } from "../DocumentUtility"; +import { handleError } from "../ErrorHandlingUtils"; +import { MinimalQueryIterator, nextPage } from "../IteratorUtilities"; export const queryDocumentsPage = async ( resourceName: string, diff --git a/src/Contracts/ExplorerContracts.ts b/src/Contracts/ExplorerContracts.ts index 1689a96b5..d1c3dba58 100644 --- a/src/Contracts/ExplorerContracts.ts +++ b/src/Contracts/ExplorerContracts.ts @@ -1,6 +1,6 @@ -import * as Versions from "./Versions"; import * as ActionContracts from "./ActionContracts"; import * as Diagnostics from "./Diagnostics"; +import * as Versions from "./Versions"; /** * Messaging types used with Data Explorer <-> Portal communication diff --git a/src/HostedExplorer.tsx b/src/HostedExplorer.tsx index 9f73ecdc4..4751ea5fa 100644 --- a/src/HostedExplorer.tsx +++ b/src/HostedExplorer.tsx @@ -5,20 +5,20 @@ import { render } from "react-dom"; import ChevronRight from "../images/chevron-right.svg"; import "../less/hostedexplorer.less"; import { AuthType } from "./AuthType"; -import { ConnectExplorer } from "./Platform/Hosted/Components/ConnectExplorer"; import { DatabaseAccount } from "./Contracts/DataModels"; -import { DirectoryPickerPanel } from "./Platform/Hosted/Components/DirectoryPickerPanel"; -import { AccountSwitcher } from "./Platform/Hosted/Components/AccountSwitcher"; import "./Explorer/Menus/NavBar/MeControlComponent.less"; -import { useTokenMetadata } from "./hooks/usePortalAccessToken"; -import { MeControl } from "./Platform/Hosted/Components/MeControl"; -import "./Platform/Hosted/ConnectScreen.less"; -import "./Shared/appInsights"; -import { SignInButton } from "./Platform/Hosted/Components/SignInButton"; import { useAADAuth } from "./hooks/useAADAuth"; -import { FeedbackCommandButton } from "./Platform/Hosted/Components/FeedbackCommandButton"; +import { useTokenMetadata } from "./hooks/usePortalAccessToken"; import { HostedExplorerChildFrame } from "./HostedExplorerChildFrame"; +import { AccountSwitcher } from "./Platform/Hosted/Components/AccountSwitcher"; +import { ConnectExplorer } from "./Platform/Hosted/Components/ConnectExplorer"; +import { DirectoryPickerPanel } from "./Platform/Hosted/Components/DirectoryPickerPanel"; +import { FeedbackCommandButton } from "./Platform/Hosted/Components/FeedbackCommandButton"; +import { MeControl } from "./Platform/Hosted/Components/MeControl"; +import { SignInButton } from "./Platform/Hosted/Components/SignInButton"; +import "./Platform/Hosted/ConnectScreen.less"; import { extractMasterKeyfromConnectionString } from "./Platform/Hosted/HostedUtils"; +import "./Shared/appInsights"; initializeIcons(); @@ -31,7 +31,7 @@ const App: React.FunctionComponent = () => { // For showing/hiding panel const [isOpen, { setTrue: openPanel, setFalse: dismissPanel }] = useBoolean(false); - const { isLoggedIn, armToken, graphToken, account, tenantId, logout, login, switchTenant } = useAADAuth(); + const { isLoggedIn, armToken, graphToken, aadToken, account, tenantId, logout, login, switchTenant } = useAADAuth(); const [databaseAccount, setDatabaseAccount] = React.useState(); const [authType, setAuthType] = React.useState(encryptedToken ? AuthType.EncryptedToken : undefined); const [connectionString, setConnectionString] = React.useState(); @@ -50,6 +50,7 @@ const App: React.FunctionComponent = () => { authType: AuthType.AAD, databaseAccount, authorizationToken: armToken, + aadToken, }; } else if (authType === AuthType.EncryptedToken) { frameWindow.hostedConfig = { diff --git a/src/HostedExplorerChildFrame.ts b/src/HostedExplorerChildFrame.ts index 2cff6c862..1366a0062 100644 --- a/src/HostedExplorerChildFrame.ts +++ b/src/HostedExplorerChildFrame.ts @@ -7,6 +7,7 @@ export interface HostedExplorerChildFrame extends Window { } export interface AAD { + aadToken: string; authType: AuthType.AAD; databaseAccount: DatabaseAccount; authorizationToken: string; diff --git a/src/Platform/Hosted/extractFeatures.ts b/src/Platform/Hosted/extractFeatures.ts index 18ff57cc2..9b0805515 100644 --- a/src/Platform/Hosted/extractFeatures.ts +++ b/src/Platform/Hosted/extractFeatures.ts @@ -13,6 +13,7 @@ export type Features = { readonly enableSpark: boolean; readonly enableTtl: boolean; readonly executeSproc: boolean; + readonly enableAadDataPlane: boolean; readonly hostedDataExplorer: boolean; readonly junoEndpoint?: string; readonly livyEndpoint?: string; @@ -43,6 +44,7 @@ export function extractFeatures(given = new URLSearchParams(window.location.sear return { canExceedMaximumValue: "true" === get("canexceedmaximumvalue"), cosmosdb: "true" === get("cosmosdb"), + enableAadDataPlane: "true" === get("enableaaddataplane"), enableChangeFeedPolicy: "true" === get("enablechangefeedpolicy"), enableFixedCollectionWithSharedThroughput: "true" === get("enablefixedcollectionwithsharedthroughput"), enableKOPanel: "true" === get("enablekopanel"), diff --git a/src/Terminal/index.ts b/src/Terminal/index.ts index eb272a1a5..02524eaad 100644 --- a/src/Terminal/index.ts +++ b/src/Terminal/index.ts @@ -1,11 +1,11 @@ -import "@jupyterlab/terminal/style/index.css"; -import "./index.css"; import { ServerConnection } from "@jupyterlab/services"; -import { JupyterLabAppFactory } from "./JupyterLabAppFactory"; +import "@jupyterlab/terminal/style/index.css"; +import { HttpHeaders, TerminalQueryParams } from "../Common/Constants"; import { Action } from "../Shared/Telemetry/TelemetryConstants"; import * as TelemetryProcessor from "../Shared/Telemetry/TelemetryProcessor"; import { updateUserContext } from "../UserContext"; -import { HttpHeaders, TerminalQueryParams } from "../Common/Constants"; +import "./index.css"; +import { JupyterLabAppFactory } from "./JupyterLabAppFactory"; const getUrlVars = (): { [key: string]: string } => { const vars: { [key: string]: string } = {}; @@ -50,7 +50,7 @@ const createServerSettings = (urlVars: { [key: string]: string }): ServerConnect const main = async (): Promise => { const urlVars = getUrlVars(); - // Initialize userContext. Currently only subscrptionId is required by TelemetryProcessor + // Initialize userContext. Currently only subscriptionId is required by TelemetryProcessor updateUserContext({ subscriptionId: urlVars[TerminalQueryParams.SubscriptionId], }); diff --git a/src/UserContext.ts b/src/UserContext.ts index 0cbec9226..4655411ad 100644 --- a/src/UserContext.ts +++ b/src/UserContext.ts @@ -11,6 +11,7 @@ interface UserContext { readonly resourceGroup?: string; readonly databaseAccount?: DatabaseAccount; readonly endpoint?: string; + readonly aadToken?: string; readonly accessToken?: string; readonly authorizationToken?: string; readonly resourceToken?: string; diff --git a/src/hooks/useAADAuth.ts b/src/hooks/useAADAuth.ts index 5be0f7fc4..1c6e946b2 100644 --- a/src/hooks/useAADAuth.ts +++ b/src/hooks/useAADAuth.ts @@ -25,6 +25,7 @@ interface ReturnType { isLoggedIn: boolean; graphToken: string; armToken: string; + aadToken: string; login: () => void; logout: () => void; tenantId: string; @@ -40,6 +41,7 @@ export function useAADAuth(): ReturnType { const [tenantId, setTenantId] = React.useState(cachedTenantId); const [graphToken, setGraphToken] = React.useState(); const [armToken, setArmToken] = React.useState(); + const [aadToken, setAadToken] = React.useState(); msalInstance.setActiveAccount(account); const login = React.useCallback(async () => { @@ -79,9 +81,13 @@ export function useAADAuth(): ReturnType { authority: `https://login.microsoftonline.com/${tenantId}`, scopes: ["https://management.azure.com//.default"], }), - ]).then(([graphTokenResponse, armTokenResponse]) => { + msalInstance.acquireTokenSilent({ + scopes: ["https://cosmos.azure.com/.default"], + }), + ]).then(([graphTokenResponse, armTokenResponse, aadTokenResponse]) => { setGraphToken(graphTokenResponse.accessToken); setArmToken(armTokenResponse.accessToken); + setAadToken(aadTokenResponse.accessToken); }); } }, [account, tenantId]); @@ -92,6 +98,7 @@ export function useAADAuth(): ReturnType { isLoggedIn, graphToken, armToken, + aadToken, login, logout, switchTenant, diff --git a/src/hooks/useKnockoutExplorer.ts b/src/hooks/useKnockoutExplorer.ts index 25807a8c9..d73c0572a 100644 --- a/src/hooks/useKnockoutExplorer.ts +++ b/src/hooks/useKnockoutExplorer.ts @@ -83,6 +83,7 @@ async function configureHostedWithAAD(config: AAD, explorerParams: ExplorerParam updateUserContext({ authType: AuthType.AAD, authorizationToken: `Bearer ${config.authorizationToken}`, + aadToken: config.aadToken, }); const account = config.databaseAccount; const accountResourceId = account.id; From 030a4dec3c22c69c485906121559b8fe099ed9af Mon Sep 17 00:00:00 2001 From: Hardikkumar Nai <80053762+hardiknai-techm@users.noreply.github.com> Date: Wed, 19 May 2021 08:00:11 +0530 Subject: [PATCH 007/124] Migrate Cassandra Add Container to React (#723) --- .eslintignore | 4 - src/Explorer/ComponentRegisterer.ts | 4 - .../SettingsComponent.test.tsx.snap | 180 ------ src/Explorer/Explorer.tsx | 27 +- src/Explorer/OpenActions.test.ts | 25 - src/Explorer/OpenActions.ts | 2 +- .../Panes/CassandraAddCollectionPane.html | 273 --------- .../Panes/CassandraAddCollectionPane.ts | 539 ------------------ .../CassandraAddCollectionPane.test.tsx | 32 ++ .../CassandraAddCollectionPane.tsx | 427 ++++++++++++++ .../CassandraAddCollectionPane.test.tsx.snap | 164 ++++++ .../GitHubReposPanel.test.tsx.snap | 45 -- src/Explorer/Panes/PaneComponents.ts | 15 - .../StringInputPane.test.tsx.snap | 45 -- ...eteDatabaseConfirmationPanel.test.tsx.snap | 45 -- src/Main.tsx | 1 - test/cassandra/container.spec.ts | 10 +- tsconfig.strict.json | 1 - 18 files changed, 645 insertions(+), 1194 deletions(-) delete mode 100644 src/Explorer/Panes/CassandraAddCollectionPane.html delete mode 100644 src/Explorer/Panes/CassandraAddCollectionPane.ts create mode 100644 src/Explorer/Panes/CassandraAddCollectionPane/CassandraAddCollectionPane.test.tsx create mode 100644 src/Explorer/Panes/CassandraAddCollectionPane/CassandraAddCollectionPane.tsx create mode 100644 src/Explorer/Panes/CassandraAddCollectionPane/__snapshots__/CassandraAddCollectionPane.test.tsx.snap delete mode 100644 src/Explorer/Panes/PaneComponents.ts diff --git a/.eslintignore b/.eslintignore index 967345584..f723666ed 100644 --- a/.eslintignore +++ b/.eslintignore @@ -111,13 +111,9 @@ src/Explorer/OpenActionsStubs.ts src/Explorer/Panes/AddDatabasePane.ts src/Explorer/Panes/AddDatabasePane.test.ts src/Explorer/Panes/BrowseQueriesPane.ts -src/Explorer/Panes/CassandraAddCollectionPane.ts src/Explorer/Panes/ContextualPaneBase.ts -src/Explorer/Panes/DeleteDatabaseConfirmationPane.test.ts -src/Explorer/Panes/DeleteDatabaseConfirmationPane.ts # src/Explorer/Panes/GraphStylingPane.ts # src/Explorer/Panes/NewVertexPane.ts -src/Explorer/Panes/PaneComponents.ts src/Explorer/Panes/RenewAdHocAccessPane.ts src/Explorer/Panes/SetupNotebooksPane.ts src/Explorer/Panes/SwitchDirectoryPane.ts diff --git a/src/Explorer/ComponentRegisterer.ts b/src/Explorer/ComponentRegisterer.ts index 9a49fd643..778e89f02 100644 --- a/src/Explorer/ComponentRegisterer.ts +++ b/src/Explorer/ComponentRegisterer.ts @@ -4,13 +4,9 @@ import { DynamicListComponent } from "./Controls/DynamicList/DynamicListComponen import { EditorComponent } from "./Controls/Editor/EditorComponent"; import { JsonEditorComponent } from "./Controls/JsonEditor/JsonEditorComponent"; import { ThroughputInputComponentAutoPilotV3 } from "./Controls/ThroughputInput/ThroughputInputComponentAutoPilotV3"; -import * as PaneComponents from "./Panes/PaneComponents"; ko.components.register("editor", new EditorComponent()); ko.components.register("json-editor", new JsonEditorComponent()); ko.components.register("diff-editor", new DiffEditorComponent()); ko.components.register("dynamic-list", DynamicListComponent); ko.components.register("throughput-input-autopilot-v3", ThroughputInputComponentAutoPilotV3); - -// Panes -ko.components.register("cassandra-add-collection-pane", new PaneComponents.CassandraAddCollectionPaneComponent()); diff --git a/src/Explorer/Controls/Settings/__snapshots__/SettingsComponent.test.tsx.snap b/src/Explorer/Controls/Settings/__snapshots__/SettingsComponent.test.tsx.snap index adfb92b42..6a8979379 100644 --- a/src/Explorer/Controls/Settings/__snapshots__/SettingsComponent.test.tsx.snap +++ b/src/Explorer/Controls/Settings/__snapshots__/SettingsComponent.test.tsx.snap @@ -38,51 +38,6 @@ exports[`SettingsComponent renders 1`] = ` "arcadiaToken": [Function], "canExceedMaximumValue": [Function], "canSaveQueries": [Function], - "cassandraAddCollectionPane": CassandraAddCollectionPane { - "autoPilotUsageCost": [Function], - "canConfigureThroughput": [Function], - "canExceedMaximumValue": [Function], - "canRequestSupport": [Function], - "container": [Circular], - "costsVisible": [Function], - "createTableQuery": [Function], - "dedicateTableThroughput": [Function], - "firstFieldHasFocus": [Function], - "formErrors": [Function], - "formErrorsDetails": [Function], - "id": "cassandraaddcollectionpane", - "isAutoPilotSelected": [Function], - "isExecuting": [Function], - "isFreeTierAccount": [Function], - "isSharedAutoPilotSelected": [Function], - "isTemplateReady": [Function], - "keyspaceCreateNew": [Function], - "keyspaceHasSharedOffer": [Function], - "keyspaceId": [Function], - "keyspaceIds": [Function], - "keyspaceOffers": Map {}, - "keyspaceThroughput": [Function], - "maxThroughputRU": [Function], - "minThroughputRU": [Function], - "requestUnitsUsageCostDedicated": [Function], - "requestUnitsUsageCostShared": [Function], - "ruToolTipText": [Function], - "selectedAutoPilotThroughput": [Function], - "sharedAutoPilotThroughput": [Function], - "sharedThroughputRangeText": [Function], - "sharedThroughputSpendAck": [Function], - "sharedThroughputSpendAckText": [Function], - "sharedThroughputSpendAckVisible": [Function], - "tableId": [Function], - "throughput": [Function], - "throughputRangeText": [Function], - "throughputSpendAck": [Function], - "throughputSpendAckText": [Function], - "throughputSpendAckVisible": [Function], - "title": [Function], - "userTableQuery": [Function], - "visible": [Function], - }, "closeDialog": undefined, "closeSidePanel": undefined, "collapsedResourceTreeWidth": 36, @@ -978,51 +933,6 @@ exports[`SettingsComponent renders 1`] = ` "arcadiaToken": [Function], "canExceedMaximumValue": [Function], "canSaveQueries": [Function], - "cassandraAddCollectionPane": CassandraAddCollectionPane { - "autoPilotUsageCost": [Function], - "canConfigureThroughput": [Function], - "canExceedMaximumValue": [Function], - "canRequestSupport": [Function], - "container": [Circular], - "costsVisible": [Function], - "createTableQuery": [Function], - "dedicateTableThroughput": [Function], - "firstFieldHasFocus": [Function], - "formErrors": [Function], - "formErrorsDetails": [Function], - "id": "cassandraaddcollectionpane", - "isAutoPilotSelected": [Function], - "isExecuting": [Function], - "isFreeTierAccount": [Function], - "isSharedAutoPilotSelected": [Function], - "isTemplateReady": [Function], - "keyspaceCreateNew": [Function], - "keyspaceHasSharedOffer": [Function], - "keyspaceId": [Function], - "keyspaceIds": [Function], - "keyspaceOffers": Map {}, - "keyspaceThroughput": [Function], - "maxThroughputRU": [Function], - "minThroughputRU": [Function], - "requestUnitsUsageCostDedicated": [Function], - "requestUnitsUsageCostShared": [Function], - "ruToolTipText": [Function], - "selectedAutoPilotThroughput": [Function], - "sharedAutoPilotThroughput": [Function], - "sharedThroughputRangeText": [Function], - "sharedThroughputSpendAck": [Function], - "sharedThroughputSpendAckText": [Function], - "sharedThroughputSpendAckVisible": [Function], - "tableId": [Function], - "throughput": [Function], - "throughputRangeText": [Function], - "throughputSpendAck": [Function], - "throughputSpendAckText": [Function], - "throughputSpendAckVisible": [Function], - "title": [Function], - "userTableQuery": [Function], - "visible": [Function], - }, "closeDialog": undefined, "closeSidePanel": undefined, "collapsedResourceTreeWidth": 36, @@ -1931,51 +1841,6 @@ exports[`SettingsComponent renders 1`] = ` "arcadiaToken": [Function], "canExceedMaximumValue": [Function], "canSaveQueries": [Function], - "cassandraAddCollectionPane": CassandraAddCollectionPane { - "autoPilotUsageCost": [Function], - "canConfigureThroughput": [Function], - "canExceedMaximumValue": [Function], - "canRequestSupport": [Function], - "container": [Circular], - "costsVisible": [Function], - "createTableQuery": [Function], - "dedicateTableThroughput": [Function], - "firstFieldHasFocus": [Function], - "formErrors": [Function], - "formErrorsDetails": [Function], - "id": "cassandraaddcollectionpane", - "isAutoPilotSelected": [Function], - "isExecuting": [Function], - "isFreeTierAccount": [Function], - "isSharedAutoPilotSelected": [Function], - "isTemplateReady": [Function], - "keyspaceCreateNew": [Function], - "keyspaceHasSharedOffer": [Function], - "keyspaceId": [Function], - "keyspaceIds": [Function], - "keyspaceOffers": Map {}, - "keyspaceThroughput": [Function], - "maxThroughputRU": [Function], - "minThroughputRU": [Function], - "requestUnitsUsageCostDedicated": [Function], - "requestUnitsUsageCostShared": [Function], - "ruToolTipText": [Function], - "selectedAutoPilotThroughput": [Function], - "sharedAutoPilotThroughput": [Function], - "sharedThroughputRangeText": [Function], - "sharedThroughputSpendAck": [Function], - "sharedThroughputSpendAckText": [Function], - "sharedThroughputSpendAckVisible": [Function], - "tableId": [Function], - "throughput": [Function], - "throughputRangeText": [Function], - "throughputSpendAck": [Function], - "throughputSpendAckText": [Function], - "throughputSpendAckVisible": [Function], - "title": [Function], - "userTableQuery": [Function], - "visible": [Function], - }, "closeDialog": undefined, "closeSidePanel": undefined, "collapsedResourceTreeWidth": 36, @@ -2871,51 +2736,6 @@ exports[`SettingsComponent renders 1`] = ` "arcadiaToken": [Function], "canExceedMaximumValue": [Function], "canSaveQueries": [Function], - "cassandraAddCollectionPane": CassandraAddCollectionPane { - "autoPilotUsageCost": [Function], - "canConfigureThroughput": [Function], - "canExceedMaximumValue": [Function], - "canRequestSupport": [Function], - "container": [Circular], - "costsVisible": [Function], - "createTableQuery": [Function], - "dedicateTableThroughput": [Function], - "firstFieldHasFocus": [Function], - "formErrors": [Function], - "formErrorsDetails": [Function], - "id": "cassandraaddcollectionpane", - "isAutoPilotSelected": [Function], - "isExecuting": [Function], - "isFreeTierAccount": [Function], - "isSharedAutoPilotSelected": [Function], - "isTemplateReady": [Function], - "keyspaceCreateNew": [Function], - "keyspaceHasSharedOffer": [Function], - "keyspaceId": [Function], - "keyspaceIds": [Function], - "keyspaceOffers": Map {}, - "keyspaceThroughput": [Function], - "maxThroughputRU": [Function], - "minThroughputRU": [Function], - "requestUnitsUsageCostDedicated": [Function], - "requestUnitsUsageCostShared": [Function], - "ruToolTipText": [Function], - "selectedAutoPilotThroughput": [Function], - "sharedAutoPilotThroughput": [Function], - "sharedThroughputRangeText": [Function], - "sharedThroughputSpendAck": [Function], - "sharedThroughputSpendAckText": [Function], - "sharedThroughputSpendAckVisible": [Function], - "tableId": [Function], - "throughput": [Function], - "throughputRangeText": [Function], - "throughputSpendAck": [Function], - "throughputSpendAckText": [Function], - "throughputSpendAckVisible": [Function], - "title": [Function], - "userTableQuery": [Function], - "visible": [Function], - }, "closeDialog": undefined, "closeSidePanel": undefined, "collapsedResourceTreeWidth": 36, diff --git a/src/Explorer/Explorer.tsx b/src/Explorer/Explorer.tsx index 85a377370..a8d9fa7d7 100644 --- a/src/Explorer/Explorer.tsx +++ b/src/Explorer/Explorer.tsx @@ -54,7 +54,7 @@ import { NotebookUtil } from "./Notebook/NotebookUtil"; import { AddCollectionPanel } from "./Panes/AddCollectionPanel"; import { AddDatabasePanel } from "./Panes/AddDatabasePanel/AddDatabasePanel"; import { BrowseQueriesPane } from "./Panes/BrowseQueriesPane/BrowseQueriesPane"; -import CassandraAddCollectionPane from "./Panes/CassandraAddCollectionPane"; +import { CassandraAddCollectionPane } from "./Panes/CassandraAddCollectionPane/CassandraAddCollectionPane"; import { ContextualPaneBase } from "./Panes/ContextualPaneBase"; import { DeleteCollectionConfirmationPane } from "./Panes/DeleteCollectionConfirmationPane/DeleteCollectionConfirmationPane"; import { DeleteDatabaseConfirmationPanel } from "./Panes/DeleteDatabaseConfirmationPanel"; @@ -148,7 +148,6 @@ export default class Explorer { public tabsManager: TabsManager; // Contextual panes - public cassandraAddCollectionPane: CassandraAddCollectionPane; private gitHubClient: GitHubClient; public gitHubOAuthService: GitHubOAuthService; public junoClient: JunoClient; @@ -398,13 +397,6 @@ export default class Explorer { } }); - this.cassandraAddCollectionPane = new CassandraAddCollectionPane({ - id: "cassandraaddcollectionpane", - visible: ko.observable(false), - - container: this, - }); - this.tabsManager = params?.tabsManager ?? new TabsManager(); this.tabsManager.openedTabs.subscribe((tabs) => { if (tabs.length === 0) { @@ -1138,7 +1130,10 @@ export default class Explorer { private getDeltaDatabases( updatedDatabaseList: DataModels.Database[] - ): { toAdd: ViewModels.Database[]; toDelete: ViewModels.Database[] } { + ): { + toAdd: ViewModels.Database[]; + toDelete: ViewModels.Database[]; + } { const newDatabases: DataModels.Database[] = _.filter(updatedDatabaseList, (database: DataModels.Database) => { const databaseExists = _.some( this.databases(), @@ -1791,7 +1786,7 @@ export default class Explorer { public onNewCollectionClicked(databaseId?: string): void { if (userContext.apiType === "Cassandra") { - this.cassandraAddCollectionPane.open(); + this.openCassandraAddCollectionPane(); } else { this.openAddCollectionPanel(databaseId); } @@ -1983,6 +1978,16 @@ export default class Explorer { ); } + public openCassandraAddCollectionPane(): void { + this.openSidePanel( + "Add Table", + this.closeSidePanel()} + cassandraApiClient={new CassandraAPIDataClient()} + /> + ); + } public openGitHubReposPanel(header: string, junoClient?: JunoClient): void { this.openSidePanel( header, diff --git a/src/Explorer/OpenActions.test.ts b/src/Explorer/OpenActions.test.ts index 0ea2057b7..d06e8b239 100644 --- a/src/Explorer/OpenActions.test.ts +++ b/src/Explorer/OpenActions.test.ts @@ -3,7 +3,6 @@ import { ActionContracts } from "../Contracts/ExplorerContracts"; import * as ViewModels from "../Contracts/ViewModels"; import Explorer from "./Explorer"; import { handleOpenAction } from "./OpenActions"; -import CassandraAddCollectionPane from "./Panes/CassandraAddCollectionPane"; describe("OpenActions", () => { describe("handleOpenAction", () => { @@ -15,8 +14,6 @@ describe("OpenActions", () => { beforeEach(() => { explorer = {} as Explorer; explorer.onNewCollectionClicked = jest.fn(); - explorer.cassandraAddCollectionPane = {} as CassandraAddCollectionPane; - explorer.cassandraAddCollectionPane.open = jest.fn(); database = { id: ko.observable("db"), @@ -64,28 +61,6 @@ describe("OpenActions", () => { expect(actionHandled).toBe(true); }); - describe("CassandraAddCollection pane kind", () => { - it("string value should call cassandraAddCollectionPane.open", () => { - const action = { - actionType: "OpenPane", - paneKind: "CassandraAddCollection", - }; - - const actionHandled = handleOpenAction(action, [], explorer); - expect(explorer.cassandraAddCollectionPane.open).toHaveBeenCalled(); - }); - - it("enum value should call cassandraAddCollectionPane.open", () => { - const action = { - actionType: "OpenPane", - paneKind: ActionContracts.PaneKind.CassandraAddCollection, - }; - - const actionHandled = handleOpenAction(action, [], explorer); - expect(explorer.cassandraAddCollectionPane.open).toHaveBeenCalled(); - }); - }); - describe("AddCollection pane kind", () => { it("string value should call explorer.onNewCollectionClicked", () => { const action = { diff --git a/src/Explorer/OpenActions.ts b/src/Explorer/OpenActions.ts index afc3251c2..033cb8135 100644 --- a/src/Explorer/OpenActions.ts +++ b/src/Explorer/OpenActions.ts @@ -145,7 +145,7 @@ function openPane(action: ActionContracts.OpenPane, explorer: Explorer) { action.paneKind === ActionContracts.PaneKind.CassandraAddCollection || (action).paneKind === ActionContracts.PaneKind[ActionContracts.PaneKind.CassandraAddCollection] ) { - explorer.cassandraAddCollectionPane.open(); + explorer.openCassandraAddCollectionPane(); } else if ( action.paneKind === ActionContracts.PaneKind.GlobalSettings || (action).paneKind === ActionContracts.PaneKind[ActionContracts.PaneKind.GlobalSettings] diff --git a/src/Explorer/Panes/CassandraAddCollectionPane.html b/src/Explorer/Panes/CassandraAddCollectionPane.html deleted file mode 100644 index 2450196ee..000000000 --- a/src/Explorer/Panes/CassandraAddCollectionPane.html +++ /dev/null @@ -1,273 +0,0 @@ -
-
-
- -
- - - -
- loading indicator -
- -
-
-
diff --git a/src/Explorer/Panes/CassandraAddCollectionPane.ts b/src/Explorer/Panes/CassandraAddCollectionPane.ts deleted file mode 100644 index 18879e6d3..000000000 --- a/src/Explorer/Panes/CassandraAddCollectionPane.ts +++ /dev/null @@ -1,539 +0,0 @@ -import * as ko from "knockout"; -import * as _ from "underscore"; -import * as Constants from "../../Common/Constants"; -import { getErrorMessage, getErrorStack } from "../../Common/ErrorHandlingUtils"; -import { configContext, Platform } from "../../ConfigContext"; -import * as DataModels from "../../Contracts/DataModels"; -import * as ViewModels from "../../Contracts/ViewModels"; -import * as AddCollectionUtility from "../../Shared/AddCollectionUtility"; -import * as SharedConstants from "../../Shared/Constants"; -import { Action, ActionModifiers } from "../../Shared/Telemetry/TelemetryConstants"; -import * as TelemetryProcessor from "../../Shared/Telemetry/TelemetryProcessor"; -import { userContext } from "../../UserContext"; -import * as AutoPilotUtils from "../../Utils/AutoPilotUtils"; -import * as PricingUtils from "../../Utils/PricingUtils"; -import { CassandraAPIDataClient } from "../Tables/TableDataClient"; -import { ContextualPaneBase } from "./ContextualPaneBase"; - -export default class CassandraAddCollectionPane extends ContextualPaneBase { - public createTableQuery: ko.Observable; - public keyspaceId: ko.Observable; - public maxThroughputRU: ko.Observable; - public minThroughputRU: ko.Observable; - public tableId: ko.Observable; - public throughput: ko.Observable; - public throughputRangeText: ko.Computed; - public sharedThroughputRangeText: ko.Computed; - public userTableQuery: ko.Observable; - public requestUnitsUsageCostDedicated: ko.Computed; - public requestUnitsUsageCostShared: ko.Computed; - public costsVisible: ko.PureComputed; - public keyspaceHasSharedOffer: ko.Observable; - public keyspaceIds: ko.ObservableArray; - public keyspaceThroughput: ko.Observable; - public keyspaceCreateNew: ko.Observable; - public dedicateTableThroughput: ko.Observable; - public canRequestSupport: ko.PureComputed; - public throughputSpendAckText: ko.Observable; - public throughputSpendAck: ko.Observable; - public sharedThroughputSpendAck: ko.Observable; - public sharedThroughputSpendAckText: ko.Observable; - public isAutoPilotSelected: ko.Observable; - public isSharedAutoPilotSelected: ko.Observable; - public selectedAutoPilotThroughput: ko.Observable; - public sharedAutoPilotThroughput: ko.Observable; - public autoPilotUsageCost: ko.Computed; - public sharedThroughputSpendAckVisible: ko.Computed; - public throughputSpendAckVisible: ko.Computed; - public canExceedMaximumValue: ko.PureComputed; - public isFreeTierAccount: ko.Computed; - public ruToolTipText: ko.Computed; - public canConfigureThroughput: ko.PureComputed; - - private keyspaceOffers: Map; - - constructor(options: ViewModels.PaneOptions) { - super(options); - this.title("Add Table"); - this.createTableQuery = ko.observable("CREATE TABLE "); - this.keyspaceCreateNew = ko.observable(true); - this.ruToolTipText = ko.pureComputed(() => PricingUtils.getRuToolTipText()); - this.canConfigureThroughput = ko.pureComputed(() => !this.container.isServerlessEnabled()); - this.keyspaceOffers = new Map(); - this.keyspaceIds = ko.observableArray(); - this.keyspaceHasSharedOffer = ko.observable(false); - this.keyspaceThroughput = ko.observable(); - this.keyspaceId = ko.observable(""); - this.keyspaceId.subscribe((keyspaceId: string) => { - if (this.keyspaceIds.indexOf(keyspaceId) >= 0) { - this.keyspaceHasSharedOffer(this.keyspaceOffers.has(keyspaceId)); - } - }); - this.keyspaceId.extend({ rateLimit: 100 }); - this.dedicateTableThroughput = ko.observable(false); - const throughputDefaults = this.container.collectionCreationDefaults.throughput; - this.maxThroughputRU = ko.observable(throughputDefaults.unlimitedmax); - this.minThroughputRU = ko.observable(throughputDefaults.unlimitedmin); - - this.canExceedMaximumValue = ko.pureComputed(() => this.container.canExceedMaximumValue()); - - this.isFreeTierAccount = ko.computed(() => { - return userContext?.databaseAccount?.properties?.enableFreeTier; - }); - - this.tableId = ko.observable(""); - this.isAutoPilotSelected = ko.observable(false); - this.isSharedAutoPilotSelected = ko.observable(false); - this.selectedAutoPilotThroughput = ko.observable(); - this.sharedAutoPilotThroughput = ko.observable(); - this.throughput = ko.observable(); - this.throughputRangeText = ko.pureComputed(() => { - const enableAutoPilot = this.isAutoPilotSelected(); - if (!enableAutoPilot) { - return `Throughput (${this.minThroughputRU().toLocaleString()} - ${this.maxThroughputRU().toLocaleString()} RU/s)`; - } - return AutoPilotUtils.getAutoPilotHeaderText(); - }); - this.sharedThroughputRangeText = ko.pureComputed(() => { - if (this.isSharedAutoPilotSelected()) { - return AutoPilotUtils.getAutoPilotHeaderText(); - } - return `Throughput (${this.minThroughputRU().toLocaleString()} - ${this.maxThroughputRU().toLocaleString()} RU/s)`; - }); - this.userTableQuery = ko.observable("(userid int, name text, email text, PRIMARY KEY (userid))"); - this.keyspaceId.subscribe((keyspaceId) => { - this.createTableQuery(`CREATE TABLE ${keyspaceId}.`); - }); - - this.throughputSpendAckText = ko.observable(); - this.throughputSpendAck = ko.observable(false); - this.sharedThroughputSpendAck = ko.observable(false); - this.sharedThroughputSpendAckText = ko.observable(); - - this.resetData(); - - this.requestUnitsUsageCostDedicated = ko.computed(() => { - const { databaseAccount: account } = userContext; - if (!account) { - return ""; - } - - const regions = - (account && - account.properties && - account.properties.readLocations && - account.properties.readLocations.length) || - 1; - const multimaster = (account && account.properties && account.properties.enableMultipleWriteLocations) || false; - const offerThroughput: number = this.throughput(); - let estimatedSpend: string; - let estimatedDedicatedSpendAcknowledge: string; - if (!this.isAutoPilotSelected()) { - estimatedSpend = PricingUtils.getEstimatedSpendHtml( - offerThroughput, - userContext.portalEnv, - regions, - multimaster - ); - estimatedDedicatedSpendAcknowledge = PricingUtils.getEstimatedSpendAcknowledgeString( - offerThroughput, - userContext.portalEnv, - regions, - multimaster, - this.isAutoPilotSelected() - ); - } else { - estimatedSpend = PricingUtils.getEstimatedAutoscaleSpendHtml( - this.selectedAutoPilotThroughput(), - userContext.portalEnv, - regions, - multimaster - ); - estimatedDedicatedSpendAcknowledge = PricingUtils.getEstimatedSpendAcknowledgeString( - this.selectedAutoPilotThroughput(), - userContext.portalEnv, - regions, - multimaster, - this.isAutoPilotSelected() - ); - } - this.throughputSpendAckText(estimatedDedicatedSpendAcknowledge); - return estimatedSpend; - }); - - this.requestUnitsUsageCostShared = ko.computed(() => { - const { databaseAccount: account } = userContext; - if (!account) { - return ""; - } - - const regions = account?.properties?.readLocations?.length || 1; - const multimaster = account?.properties?.enableMultipleWriteLocations || false; - let estimatedSpend: string; - let estimatedSharedSpendAcknowledge: string; - if (!this.isSharedAutoPilotSelected()) { - estimatedSpend = PricingUtils.getEstimatedSpendHtml( - this.keyspaceThroughput(), - userContext.portalEnv, - regions, - multimaster - ); - estimatedSharedSpendAcknowledge = PricingUtils.getEstimatedSpendAcknowledgeString( - this.keyspaceThroughput(), - userContext.portalEnv, - regions, - multimaster, - this.isSharedAutoPilotSelected() - ); - } else { - estimatedSpend = PricingUtils.getEstimatedAutoscaleSpendHtml( - this.sharedAutoPilotThroughput(), - userContext.portalEnv, - regions, - multimaster - ); - estimatedSharedSpendAcknowledge = PricingUtils.getEstimatedSpendAcknowledgeString( - this.sharedAutoPilotThroughput(), - userContext.portalEnv, - regions, - multimaster, - this.isSharedAutoPilotSelected() - ); - } - this.sharedThroughputSpendAckText(estimatedSharedSpendAcknowledge); - return estimatedSpend; - }); - - this.costsVisible = ko.pureComputed(() => { - return configContext.platform !== Platform.Emulator; - }); - - this.canRequestSupport = ko.pureComputed(() => { - if (configContext.platform !== Platform.Emulator && !userContext.isTryCosmosDBSubscription) { - const offerThroughput: number = this.throughput(); - return offerThroughput <= 100000; - } - - return false; - }); - - this.sharedThroughputSpendAckVisible = ko.computed(() => { - const autoscaleThroughput = this.sharedAutoPilotThroughput() * 1; - if (this.isSharedAutoPilotSelected()) { - return autoscaleThroughput > SharedConstants.CollectionCreation.DefaultCollectionRUs100K; - } - - return this.keyspaceThroughput() > SharedConstants.CollectionCreation.DefaultCollectionRUs100K; - }); - - this.throughputSpendAckVisible = ko.pureComputed(() => { - const autoscaleThroughput = this.selectedAutoPilotThroughput() * 1; - if (this.isAutoPilotSelected()) { - return autoscaleThroughput > SharedConstants.CollectionCreation.DefaultCollectionRUs100K; - } - - return this.throughput() > SharedConstants.CollectionCreation.DefaultCollectionRUs100K; - }); - - if (!!this.container) { - const updateKeyspaceIds: (keyspaces: ViewModels.Database[]) => void = ( - newKeyspaceIds: ViewModels.Database[] - ): void => { - const cachedKeyspaceIdsList = _.map(newKeyspaceIds, (keyspace: ViewModels.Database) => { - if (keyspace && keyspace.offer && !!keyspace.offer()) { - this.keyspaceOffers.set(keyspace.id(), keyspace.offer()); - } - return keyspace.id(); - }); - this.keyspaceIds(cachedKeyspaceIdsList); - }; - this.container.databases.subscribe((newDatabases: ViewModels.Database[]) => updateKeyspaceIds(newDatabases)); - updateKeyspaceIds(this.container.databases()); - } - - this.autoPilotUsageCost = ko.pureComputed(() => { - const autoPilot = this._getAutoPilot(); - if (!autoPilot) { - return ""; - } - const isDatabaseThroughput: boolean = this.keyspaceCreateNew(); - return PricingUtils.getAutoPilotV3SpendHtml(autoPilot.maxThroughput, isDatabaseThroughput); - }); - } - - public decreaseThroughput() { - let offerThroughput: number = this.throughput(); - - if (offerThroughput > this.minThroughputRU()) { - offerThroughput -= 100; - this.throughput(offerThroughput); - } - } - - public increaseThroughput() { - let offerThroughput: number = this.throughput(); - - if (offerThroughput < this.maxThroughputRU()) { - offerThroughput += 100; - this.throughput(offerThroughput); - } - } - - public open() { - super.open(); - if (!this.container.isServerlessEnabled()) { - this.isAutoPilotSelected(this.container.isAutoscaleDefaultEnabled()); - } - const addCollectionPaneOpenMessage = { - collection: ko.toJS({ - id: this.tableId(), - storage: Constants.BackendDefaults.multiPartitionStorageInGb, - offerThroughput: this.throughput(), - partitionKey: "", - databaseId: this.keyspaceId(), - }), - subscriptionType: userContext.subscriptionType, - subscriptionQuotaId: userContext.quotaId, - defaultsCheck: { - storage: "u", - throughput: this.throughput(), - flight: userContext.addCollectionFlight, - }, - dataExplorerArea: Constants.Areas.ContextualPane, - }; - const focusElement = document.getElementById("keyspace-id"); - focusElement && focusElement.focus(); - TelemetryProcessor.trace(Action.CreateCollection, ActionModifiers.Open, addCollectionPaneOpenMessage); - } - - public submit() { - if (!this._isValid()) { - return; - } - this.isExecuting(true); - const autoPilotCommand = `cosmosdb_autoscale_max_throughput`; - let createTableAndKeyspacePromise: Q.Promise; - const toCreateKeyspace: boolean = this.keyspaceCreateNew(); - const useAutoPilotForKeyspace: boolean = this.isSharedAutoPilotSelected() && !!this.sharedAutoPilotThroughput(); - const createKeyspaceQueryPrefix: string = `CREATE KEYSPACE ${this.keyspaceId().trim()} WITH REPLICATION = { 'class' : 'SimpleStrategy', 'replication_factor' : 3 }`; - const createKeyspaceQuery: string = this.keyspaceHasSharedOffer() - ? useAutoPilotForKeyspace - ? `${createKeyspaceQueryPrefix} AND ${autoPilotCommand}=${this.sharedAutoPilotThroughput()};` - : `${createKeyspaceQueryPrefix} AND cosmosdb_provisioned_throughput=${this.keyspaceThroughput()};` - : `${createKeyspaceQueryPrefix};`; - const createTableQueryPrefix: string = `${this.createTableQuery()}${this.tableId().trim()} ${this.userTableQuery()}`; - let createTableQuery: string; - - if (this.canConfigureThroughput() && (this.dedicateTableThroughput() || !this.keyspaceHasSharedOffer())) { - if (this.isAutoPilotSelected() && this.selectedAutoPilotThroughput()) { - createTableQuery = `${createTableQueryPrefix} WITH ${autoPilotCommand}=${this.selectedAutoPilotThroughput()};`; - } else { - createTableQuery = `${createTableQueryPrefix} WITH cosmosdb_provisioned_throughput=${this.throughput()};`; - } - } else { - createTableQuery = `${createTableQueryPrefix};`; - } - - const addCollectionPaneStartMessage = { - collection: ko.toJS({ - id: this.tableId(), - storage: Constants.BackendDefaults.multiPartitionStorageInGb, - offerThroughput: this.throughput(), - partitionKey: "", - databaseId: this.keyspaceId(), - hasDedicatedThroughput: this.dedicateTableThroughput(), - }), - keyspaceHasSharedOffer: this.keyspaceHasSharedOffer(), - subscriptionType: userContext.subscriptionType, - subscriptionQuotaId: userContext.quotaId, - defaultsCheck: { - storage: "u", - throughput: this.throughput(), - flight: userContext.addCollectionFlight, - }, - dataExplorerArea: Constants.Areas.ContextualPane, - toCreateKeyspace: toCreateKeyspace, - createKeyspaceQuery: createKeyspaceQuery, - createTableQuery: createTableQuery, - }; - const startKey: number = TelemetryProcessor.traceStart(Action.CreateCollection, addCollectionPaneStartMessage); - const { databaseAccount } = userContext; - if (toCreateKeyspace) { - createTableAndKeyspacePromise = (this.container.tableDataClient).createTableAndKeyspace( - databaseAccount?.properties.cassandraEndpoint, - databaseAccount?.id, - this.container, - createTableQuery, - createKeyspaceQuery - ); - } else { - createTableAndKeyspacePromise = (this.container.tableDataClient).createTableAndKeyspace( - databaseAccount?.properties.cassandraEndpoint, - databaseAccount?.id, - this.container, - createTableQuery - ); - } - createTableAndKeyspacePromise.then( - () => { - this.container.refreshAllDatabases(); - this.isExecuting(false); - this.close(); - const addCollectionPaneSuccessMessage = { - collection: ko.toJS({ - id: this.tableId(), - storage: Constants.BackendDefaults.multiPartitionStorageInGb, - offerThroughput: this.throughput(), - partitionKey: "", - databaseId: this.keyspaceId(), - hasDedicatedThroughput: this.dedicateTableThroughput(), - }), - keyspaceHasSharedOffer: this.keyspaceHasSharedOffer(), - subscriptionType: userContext.subscriptionType, - subscriptionQuotaId: userContext.quotaId, - defaultsCheck: { - storage: "u", - throughput: this.throughput(), - flight: userContext.addCollectionFlight, - }, - dataExplorerArea: Constants.Areas.ContextualPane, - toCreateKeyspace: toCreateKeyspace, - createKeyspaceQuery: createKeyspaceQuery, - createTableQuery: createTableQuery, - }; - TelemetryProcessor.traceSuccess(Action.CreateCollection, addCollectionPaneSuccessMessage, startKey); - }, - (error) => { - const errorMessage = getErrorMessage(error); - this.formErrors(errorMessage); - this.isExecuting(false); - const addCollectionPaneFailedMessage = { - collection: { - id: this.tableId(), - storage: Constants.BackendDefaults.multiPartitionStorageInGb, - offerThroughput: this.throughput(), - partitionKey: "", - databaseId: this.keyspaceId(), - hasDedicatedThroughput: this.dedicateTableThroughput(), - }, - keyspaceHasSharedOffer: this.keyspaceHasSharedOffer(), - subscriptionType: userContext.subscriptionType, - subscriptionQuotaId: userContext.quotaId, - defaultsCheck: { - storage: "u", - throughput: this.throughput(), - flight: userContext.addCollectionFlight, - }, - dataExplorerArea: Constants.Areas.ContextualPane, - toCreateKeyspace: toCreateKeyspace, - createKeyspaceQuery: createKeyspaceQuery, - createTableQuery: createTableQuery, - error: errorMessage, - errorStack: getErrorStack(error), - }; - TelemetryProcessor.traceFailure(Action.CreateCollection, addCollectionPaneFailedMessage, startKey); - } - ); - } - - public resetData() { - super.resetData(); - const throughputDefaults = this.container.collectionCreationDefaults.throughput; - this.isAutoPilotSelected(this.container.isAutoscaleDefaultEnabled()); - this.isSharedAutoPilotSelected(this.container.isAutoscaleDefaultEnabled()); - this.selectedAutoPilotThroughput(AutoPilotUtils.minAutoPilotThroughput); - this.sharedAutoPilotThroughput(AutoPilotUtils.minAutoPilotThroughput); - this.throughput(AddCollectionUtility.getMaxThroughput(this.container.collectionCreationDefaults, this.container)); - this.keyspaceThroughput(throughputDefaults.shared); - this.maxThroughputRU(throughputDefaults.unlimitedmax); - this.minThroughputRU(throughputDefaults.unlimitedmin); - this.createTableQuery("CREATE TABLE "); - this.userTableQuery("(userid int, name text, email text, PRIMARY KEY (userid))"); - this.tableId(""); - this.keyspaceId(""); - this.throughputSpendAck(false); - this.keyspaceHasSharedOffer(false); - this.keyspaceCreateNew(true); - } - - private _isValid(): boolean { - const throughput = this.throughput(); - const keyspaceThroughput = this.keyspaceThroughput(); - - const sharedAutoscaleThroughput = this.sharedAutoPilotThroughput() * 1; - if ( - this.isSharedAutoPilotSelected() && - sharedAutoscaleThroughput > SharedConstants.CollectionCreation.DefaultCollectionRUs100K && - !this.sharedThroughputSpendAck() - ) { - this.formErrors(`Please acknowledge the estimated monthly spend.`); - return false; - } - - const dedicatedAutoscaleThroughput = this.selectedAutoPilotThroughput() * 1; - if ( - this.isAutoPilotSelected() && - dedicatedAutoscaleThroughput > SharedConstants.CollectionCreation.DefaultCollectionRUs100K && - !this.throughputSpendAck() - ) { - this.formErrors(`Please acknowledge the estimated monthly spend.`); - return false; - } - - if ( - (this.keyspaceCreateNew() && this.keyspaceHasSharedOffer() && this.isSharedAutoPilotSelected()) || - this.isAutoPilotSelected() - ) { - const autoPilot = this._getAutoPilot(); - if ( - !autoPilot || - !autoPilot.maxThroughput || - !AutoPilotUtils.isValidAutoPilotThroughput(autoPilot.maxThroughput) - ) { - this.formErrors( - `Please enter a value greater than ${AutoPilotUtils.minAutoPilotThroughput} for autopilot throughput` - ); - return false; - } - return true; - } - - if (throughput > SharedConstants.CollectionCreation.DefaultCollectionRUs100K && !this.throughputSpendAck()) { - this.formErrors(`Please acknowledge the estimated daily spend.`); - return false; - } - - if ( - this.keyspaceHasSharedOffer() && - this.keyspaceCreateNew() && - keyspaceThroughput > SharedConstants.CollectionCreation.DefaultCollectionRUs100K && - !this.sharedThroughputSpendAck() - ) { - this.formErrors("Please acknowledge the estimated daily spend"); - return false; - } - - return true; - } - - private _getAutoPilot(): DataModels.AutoPilotCreationSettings { - if ( - this.keyspaceCreateNew() && - this.keyspaceHasSharedOffer() && - this.isSharedAutoPilotSelected() && - this.sharedAutoPilotThroughput() - ) { - return { - maxThroughput: this.sharedAutoPilotThroughput() * 1, - }; - } - - if (this.selectedAutoPilotThroughput()) { - return { - maxThroughput: this.selectedAutoPilotThroughput() * 1, - }; - } - - return undefined; - } -} diff --git a/src/Explorer/Panes/CassandraAddCollectionPane/CassandraAddCollectionPane.test.tsx b/src/Explorer/Panes/CassandraAddCollectionPane/CassandraAddCollectionPane.test.tsx new file mode 100644 index 000000000..20433bac5 --- /dev/null +++ b/src/Explorer/Panes/CassandraAddCollectionPane/CassandraAddCollectionPane.test.tsx @@ -0,0 +1,32 @@ +import { fireEvent, render, screen } from "@testing-library/react"; +import { shallow } from "enzyme"; +import React from "react"; +import Explorer from "../../Explorer"; +import { CassandraAPIDataClient } from "../../Tables/TableDataClient"; +import { CassandraAddCollectionPane } from "./CassandraAddCollectionPane"; +const props = { + explorer: new Explorer(), + closePanel: (): void => undefined, + cassandraApiClient: new CassandraAPIDataClient(), +}; + +describe("CassandraAddCollectionPane Pane", () => { + beforeEach(() => render()); + + it("should render Default properly", () => { + const wrapper = shallow(); + expect(wrapper).toMatchSnapshot(); + }); + it("click on is Create new keyspace", () => { + fireEvent.click(screen.getByLabelText("Create new keyspace")); + expect(screen.getByLabelText("Provision keyspace throughput")).toBeDefined(); + }); + it("click on Use existing", () => { + fireEvent.click(screen.getByLabelText("Use existing keyspace")); + }); + + it("Enter Keyspace name ", () => { + fireEvent.change(screen.getByLabelText("Keyspace id"), { target: { value: "unittest1" } }); + expect(screen.getByLabelText("CREATE TABLE unittest1.")).toBeDefined(); + }); +}); diff --git a/src/Explorer/Panes/CassandraAddCollectionPane/CassandraAddCollectionPane.tsx b/src/Explorer/Panes/CassandraAddCollectionPane/CassandraAddCollectionPane.tsx new file mode 100644 index 000000000..d7b587d95 --- /dev/null +++ b/src/Explorer/Panes/CassandraAddCollectionPane/CassandraAddCollectionPane.tsx @@ -0,0 +1,427 @@ +import { Label, Stack, TextField } from "@fluentui/react"; +import React, { FunctionComponent, useEffect, useState } from "react"; +import * as _ from "underscore"; +import * as Constants from "../../../Common/Constants"; +import { getErrorMessage, getErrorStack } from "../../../Common/ErrorHandlingUtils"; +import { InfoTooltip } from "../../../Common/Tooltip/InfoTooltip"; +import * as DataModels from "../../../Contracts/DataModels"; +import * as ViewModels from "../../../Contracts/ViewModels"; +import * as AddCollectionUtility from "../../../Shared/AddCollectionUtility"; +import * as SharedConstants from "../../../Shared/Constants"; +import { Action, ActionModifiers } from "../../../Shared/Telemetry/TelemetryConstants"; +import * as TelemetryProcessor from "../../../Shared/Telemetry/TelemetryProcessor"; +import { userContext } from "../../../UserContext"; +import * as AutoPilotUtils from "../../../Utils/AutoPilotUtils"; +import { ThroughputInput } from "../../Controls/ThroughputInput/ThroughputInput"; +import Explorer from "../../Explorer"; +import { CassandraAPIDataClient } from "../../Tables/TableDataClient"; +import { RightPaneForm, RightPaneFormProps } from "../RightPaneForm/RightPaneForm"; + +export interface CassandraAddCollectionPaneProps { + explorer: Explorer; + closePanel: () => void; + cassandraApiClient: CassandraAPIDataClient; +} + +export const CassandraAddCollectionPane: FunctionComponent = ({ + explorer: container, + closePanel, + cassandraApiClient, +}: CassandraAddCollectionPaneProps) => { + const throughputDefaults = container.collectionCreationDefaults.throughput; + const [createTableQuery, setCreateTableQuery] = useState("CREATE TABLE "); + const [keyspaceId, setKeyspaceId] = useState(""); + const [tableId, setTableId] = useState(""); + const [throughput, setThroughput] = useState( + AddCollectionUtility.getMaxThroughput(container.collectionCreationDefaults, container) + ); + + const [isAutoPilotSelected, setIsAutoPilotSelected] = useState(container.isAutoscaleDefaultEnabled()); + + const [isSharedAutoPilotSelected, setIsSharedAutoPilotSelected] = useState( + container.isAutoscaleDefaultEnabled() + ); + + const [userTableQuery, setUserTableQuery] = useState( + "(userid int, name text, email text, PRIMARY KEY (userid))" + ); + + const [keyspaceHasSharedOffer, setKeyspaceHasSharedOffer] = useState(false); + const [keyspaceIds, setKeyspaceIds] = useState([]); + const [keyspaceThroughput, setKeyspaceThroughput] = useState(throughputDefaults.shared); + const [keyspaceCreateNew, setKeyspaceCreateNew] = useState(true); + const [dedicateTableThroughput, setDedicateTableThroughput] = useState(false); + const [throughputSpendAck, setThroughputSpendAck] = useState(false); + const [sharedThroughputSpendAck, setSharedThroughputSpendAck] = useState(false); + + const { minAutoPilotThroughput: selectedAutoPilotThroughput } = AutoPilotUtils; + const { minAutoPilotThroughput: sharedAutoPilotThroughput } = AutoPilotUtils; + + const _getAutoPilot = (): DataModels.AutoPilotCreationSettings => { + if (keyspaceCreateNew && keyspaceHasSharedOffer && isSharedAutoPilotSelected && sharedAutoPilotThroughput) { + return { + maxThroughput: sharedAutoPilotThroughput * 1, + }; + } + + if (selectedAutoPilotThroughput) { + return { + maxThroughput: selectedAutoPilotThroughput * 1, + }; + } + + return undefined; + }; + + const isFreeTierAccount: boolean = userContext.databaseAccount?.properties?.enableFreeTier; + + const canConfigureThroughput = !container.isServerlessEnabled(); + + const keyspaceOffers = new Map(); + const [isExecuting, setIsExecuting] = useState(); + const [formErrors, setFormErrors] = useState(""); + + useEffect(() => { + if (keyspaceIds.indexOf(keyspaceId) >= 0) { + setKeyspaceHasSharedOffer(keyspaceOffers.has(keyspaceId)); + } + setCreateTableQuery(`CREATE TABLE ${keyspaceId}.`); + }, [keyspaceId]); + + const addCollectionPaneOpenMessage = { + collection: { + id: tableId, + storage: Constants.BackendDefaults.multiPartitionStorageInGb, + offerThroughput: throughput, + partitionKey: "", + databaseId: keyspaceId, + }, + subscriptionType: userContext.subscriptionType, + subscriptionQuotaId: userContext.quotaId, + defaultsCheck: { + storage: "u", + throughput, + flight: userContext.addCollectionFlight, + }, + dataExplorerArea: Constants.Areas.ContextualPane, + }; + + useEffect(() => { + if (!container.isServerlessEnabled()) { + setIsAutoPilotSelected(container.isAutoscaleDefaultEnabled()); + } + + TelemetryProcessor.trace(Action.CreateCollection, ActionModifiers.Open, addCollectionPaneOpenMessage); + }, []); + + useEffect(() => { + if (container) { + const newKeyspaceIds: ViewModels.Database[] = container.databases(); + const cachedKeyspaceIdsList = _.map(newKeyspaceIds, (keyspace: ViewModels.Database) => { + if (keyspace && keyspace.offer && !!keyspace.offer()) { + keyspaceOffers.set(keyspace.id(), keyspace.offer()); + } + return keyspace.id(); + }); + setKeyspaceIds(cachedKeyspaceIdsList); + } + }, []); + + const _isValid = () => { + const sharedAutoscaleThroughput = sharedAutoPilotThroughput * 1; + if ( + isSharedAutoPilotSelected && + sharedAutoscaleThroughput > SharedConstants.CollectionCreation.DefaultCollectionRUs100K && + !sharedThroughputSpendAck + ) { + setFormErrors(`Please acknowledge the estimated monthly spend.`); + return false; + } + + const dedicatedAutoscaleThroughput = selectedAutoPilotThroughput * 1; + if ( + isAutoPilotSelected && + dedicatedAutoscaleThroughput > SharedConstants.CollectionCreation.DefaultCollectionRUs100K && + !throughputSpendAck + ) { + setFormErrors(`Please acknowledge the estimated monthly spend.`); + return false; + } + + if ((keyspaceCreateNew && keyspaceHasSharedOffer && isSharedAutoPilotSelected) || isAutoPilotSelected) { + const autoPilot = _getAutoPilot(); + if ( + !autoPilot || + !autoPilot.maxThroughput || + !AutoPilotUtils.isValidAutoPilotThroughput(autoPilot.maxThroughput) + ) { + setFormErrors( + `Please enter a value greater than ${AutoPilotUtils.minAutoPilotThroughput} for autopilot throughput` + ); + return false; + } + return true; + } + + if (throughput > SharedConstants.CollectionCreation.DefaultCollectionRUs100K && !throughputSpendAck) { + setFormErrors(`Please acknowledge the estimated daily spend.`); + return false; + } + + if ( + keyspaceHasSharedOffer && + keyspaceCreateNew && + keyspaceThroughput > SharedConstants.CollectionCreation.DefaultCollectionRUs100K && + !sharedThroughputSpendAck + ) { + setFormErrors("Please acknowledge the estimated daily spend"); + return false; + } + + return true; + }; + + const onSubmit = async () => { + if (!_isValid()) { + return; + } + setIsExecuting(true); + const autoPilotCommand = `cosmosdb_autoscale_max_throughput`; + + const toCreateKeyspace: boolean = keyspaceCreateNew; + const useAutoPilotForKeyspace: boolean = isSharedAutoPilotSelected && !!sharedAutoPilotThroughput; + const createKeyspaceQueryPrefix = `CREATE KEYSPACE ${keyspaceId.trim()} WITH REPLICATION = { 'class' : 'SimpleStrategy', 'replication_factor' : 3 }`; + const createKeyspaceQuery: string = keyspaceHasSharedOffer + ? useAutoPilotForKeyspace + ? `${createKeyspaceQueryPrefix} AND ${autoPilotCommand}=${keyspaceThroughput};` + : `${createKeyspaceQueryPrefix} AND cosmosdb_provisioned_throughput=${keyspaceThroughput};` + : `${createKeyspaceQueryPrefix};`; + let tableQuery: string; + const createTableQueryPrefix = `${createTableQuery}${tableId.trim()} ${userTableQuery}`; + + if (canConfigureThroughput && (dedicateTableThroughput || !keyspaceHasSharedOffer)) { + if (isAutoPilotSelected && selectedAutoPilotThroughput) { + tableQuery = `${createTableQueryPrefix} WITH ${autoPilotCommand}=${throughput};`; + } else { + tableQuery = `${createTableQueryPrefix} WITH cosmosdb_provisioned_throughput=${throughput};`; + } + } else { + tableQuery = `${createTableQueryPrefix};`; + } + + const addCollectionPaneStartMessage = { + ...addCollectionPaneOpenMessage, + collection: { + ...addCollectionPaneOpenMessage.collection, + hasDedicatedThroughput: dedicateTableThroughput, + }, + keyspaceHasSharedOffer, + toCreateKeyspace, + createKeyspaceQuery, + createTableQuery: tableQuery, + }; + + const startKey: number = TelemetryProcessor.traceStart(Action.CreateCollection, addCollectionPaneStartMessage); + try { + if (toCreateKeyspace) { + await cassandraApiClient.createTableAndKeyspace( + userContext?.databaseAccount?.properties?.cassandraEndpoint, + userContext?.databaseAccount?.id, + container, + tableQuery, + createKeyspaceQuery + ); + } else { + await cassandraApiClient.createTableAndKeyspace( + userContext?.databaseAccount?.properties?.cassandraEndpoint, + userContext?.databaseAccount?.id, + container, + tableQuery + ); + } + container.refreshAllDatabases(); + setIsExecuting(false); + closePanel(); + + TelemetryProcessor.traceSuccess(Action.CreateCollection, addCollectionPaneStartMessage, startKey); + } catch (error) { + const errorMessage = getErrorMessage(error); + setFormErrors(errorMessage); + setIsExecuting(false); + const addCollectionPaneFailedMessage = { + ...addCollectionPaneStartMessage, + error: errorMessage, + errorStack: getErrorStack(error), + }; + TelemetryProcessor.traceFailure(Action.CreateCollection, addCollectionPaneFailedMessage, startKey); + } + }; + const handleOnChangeKeyspaceType = (ev: React.FormEvent, mode: string): void => { + setKeyspaceCreateNew(mode === "Create new"); + }; + + const props: RightPaneFormProps = { + expandConsole: () => container.expandConsole(), + formError: formErrors, + isExecuting, + submitButtonText: "Apply", + onSubmit, + }; + return ( + +
+
+

+ +

+ + + handleOnChangeKeyspaceType(e, "Create new")} + /> + Create new + + handleOnChangeKeyspaceType(e, "Use existing")} + /> + Use existing + + + setKeyspaceId(newValue)} + ariaLabel="Keyspace id" + autoFocus + /> + + {keyspaceIds?.map((id: string, index: number) => ( + + ))} + + {canConfigureThroughput && keyspaceCreateNew && ( +
+ setKeyspaceHasSharedOffer(e.target.checked)} + /> + + Provision keyspace throughput + + + Provisioned throughput at the keyspace level will be shared across unlimited number of tables within the + keyspace + +
+ )} + {canConfigureThroughput && keyspaceCreateNew && keyspaceHasSharedOffer && ( +
+ setKeyspaceThroughput(throughput)} + setIsAutoscale={(isAutoscale: boolean) => setIsSharedAutoPilotSelected(isAutoscale)} + onCostAcknowledgeChange={(isAcknowledge: boolean) => { + setSharedThroughputSpendAck(isAcknowledge); + }} + /> +
+ )} +
+
+

+ +

+
+ {createTableQuery} +
+ setTableId(newValue)} + style={{ marginBottom: "5px" }} + /> + setUserTableQuery(newValue)} + /> +
+ + {canConfigureThroughput && keyspaceHasSharedOffer && !keyspaceCreateNew && ( +
+ setDedicateTableThroughput(e.target.checked)} + /> + Provision dedicated throughput for this table + + You can optionally provision dedicated throughput for a table within a keyspace that has throughput + provisioned. This dedicated throughput amount will not be shared with other tables in the keyspace and + does not count towards the throughput you provisioned for the keyspace. This throughput amount will be + billed in addition to the throughput amount you provisioned at the keyspace level. + +
+ )} + {canConfigureThroughput && (!keyspaceHasSharedOffer || dedicateTableThroughput) && ( +
+ setThroughput(throughput)} + setIsAutoscale={(isAutoscale: boolean) => setIsAutoPilotSelected(isAutoscale)} + onCostAcknowledgeChange={(isAcknowledge: boolean) => { + setThroughputSpendAck(isAcknowledge); + }} + /> +
+ )} +
+ + ); +}; diff --git a/src/Explorer/Panes/CassandraAddCollectionPane/__snapshots__/CassandraAddCollectionPane.test.tsx.snap b/src/Explorer/Panes/CassandraAddCollectionPane/__snapshots__/CassandraAddCollectionPane.test.tsx.snap new file mode 100644 index 000000000..19e1b1e10 --- /dev/null +++ b/src/Explorer/Panes/CassandraAddCollectionPane/__snapshots__/CassandraAddCollectionPane.test.tsx.snap @@ -0,0 +1,164 @@ +// Jest Snapshot v1, https://goo.gl/fbAQLP + +exports[`CassandraAddCollectionPane Pane should render Default properly 1`] = ` + +
+
+

+ + Keyspace name + + Select an existing keyspace or enter a new keyspace id. + + +

+ + + + Create new + + + + Use existing + + + + +
+ + + Provision keyspace throughput + + + Provisioned throughput at the keyspace level will be shared across unlimited number of tables within the keyspace + +
+
+
+

+ + Enter CQL command to create the table. + + Learn More + + +

+
+ CREATE TABLE +
+ + +
+
+ +
+
+ +`; diff --git a/src/Explorer/Panes/GitHubReposPanel/__snapshots__/GitHubReposPanel.test.tsx.snap b/src/Explorer/Panes/GitHubReposPanel/__snapshots__/GitHubReposPanel.test.tsx.snap index 417bbd332..fddba4c4d 100644 --- a/src/Explorer/Panes/GitHubReposPanel/__snapshots__/GitHubReposPanel.test.tsx.snap +++ b/src/Explorer/Panes/GitHubReposPanel/__snapshots__/GitHubReposPanel.test.tsx.snap @@ -27,51 +27,6 @@ exports[`GitHub Repos Panel should render Default properly 1`] = ` "arcadiaToken": [Function], "canExceedMaximumValue": [Function], "canSaveQueries": [Function], - "cassandraAddCollectionPane": CassandraAddCollectionPane { - "autoPilotUsageCost": [Function], - "canConfigureThroughput": [Function], - "canExceedMaximumValue": [Function], - "canRequestSupport": [Function], - "container": [Circular], - "costsVisible": [Function], - "createTableQuery": [Function], - "dedicateTableThroughput": [Function], - "firstFieldHasFocus": [Function], - "formErrors": [Function], - "formErrorsDetails": [Function], - "id": "cassandraaddcollectionpane", - "isAutoPilotSelected": [Function], - "isExecuting": [Function], - "isFreeTierAccount": [Function], - "isSharedAutoPilotSelected": [Function], - "isTemplateReady": [Function], - "keyspaceCreateNew": [Function], - "keyspaceHasSharedOffer": [Function], - "keyspaceId": [Function], - "keyspaceIds": [Function], - "keyspaceOffers": Map {}, - "keyspaceThroughput": [Function], - "maxThroughputRU": [Function], - "minThroughputRU": [Function], - "requestUnitsUsageCostDedicated": [Function], - "requestUnitsUsageCostShared": [Function], - "ruToolTipText": [Function], - "selectedAutoPilotThroughput": [Function], - "sharedAutoPilotThroughput": [Function], - "sharedThroughputRangeText": [Function], - "sharedThroughputSpendAck": [Function], - "sharedThroughputSpendAckText": [Function], - "sharedThroughputSpendAckVisible": [Function], - "tableId": [Function], - "throughput": [Function], - "throughputRangeText": [Function], - "throughputSpendAck": [Function], - "throughputSpendAckText": [Function], - "throughputSpendAckVisible": [Function], - "title": [Function], - "userTableQuery": [Function], - "visible": [Function], - }, "closeDialog": undefined, "closeSidePanel": undefined, "collapsedResourceTreeWidth": 36, diff --git a/src/Explorer/Panes/PaneComponents.ts b/src/Explorer/Panes/PaneComponents.ts deleted file mode 100644 index 81163e94a..000000000 --- a/src/Explorer/Panes/PaneComponents.ts +++ /dev/null @@ -1,15 +0,0 @@ -import CassandraAddCollectionPaneTemplate from "./CassandraAddCollectionPane.html"; -export class PaneComponent { - constructor(data: any) { - return data.data; - } -} - -export class CassandraAddCollectionPaneComponent { - constructor() { - return { - viewModel: PaneComponent, - template: CassandraAddCollectionPaneTemplate, - }; - } -} diff --git a/src/Explorer/Panes/StringInputPane/__snapshots__/StringInputPane.test.tsx.snap b/src/Explorer/Panes/StringInputPane/__snapshots__/StringInputPane.test.tsx.snap index 77a3af75a..c25904425 100644 --- a/src/Explorer/Panes/StringInputPane/__snapshots__/StringInputPane.test.tsx.snap +++ b/src/Explorer/Panes/StringInputPane/__snapshots__/StringInputPane.test.tsx.snap @@ -17,51 +17,6 @@ exports[`StringInput Pane should render Create new directory properly 1`] = ` "arcadiaToken": [Function], "canExceedMaximumValue": [Function], "canSaveQueries": [Function], - "cassandraAddCollectionPane": CassandraAddCollectionPane { - "autoPilotUsageCost": [Function], - "canConfigureThroughput": [Function], - "canExceedMaximumValue": [Function], - "canRequestSupport": [Function], - "container": [Circular], - "costsVisible": [Function], - "createTableQuery": [Function], - "dedicateTableThroughput": [Function], - "firstFieldHasFocus": [Function], - "formErrors": [Function], - "formErrorsDetails": [Function], - "id": "cassandraaddcollectionpane", - "isAutoPilotSelected": [Function], - "isExecuting": [Function], - "isFreeTierAccount": [Function], - "isSharedAutoPilotSelected": [Function], - "isTemplateReady": [Function], - "keyspaceCreateNew": [Function], - "keyspaceHasSharedOffer": [Function], - "keyspaceId": [Function], - "keyspaceIds": [Function], - "keyspaceOffers": Map {}, - "keyspaceThroughput": [Function], - "maxThroughputRU": [Function], - "minThroughputRU": [Function], - "requestUnitsUsageCostDedicated": [Function], - "requestUnitsUsageCostShared": [Function], - "ruToolTipText": [Function], - "selectedAutoPilotThroughput": [Function], - "sharedAutoPilotThroughput": [Function], - "sharedThroughputRangeText": [Function], - "sharedThroughputSpendAck": [Function], - "sharedThroughputSpendAckText": [Function], - "sharedThroughputSpendAckVisible": [Function], - "tableId": [Function], - "throughput": [Function], - "throughputRangeText": [Function], - "throughputSpendAck": [Function], - "throughputSpendAckText": [Function], - "throughputSpendAckVisible": [Function], - "title": [Function], - "userTableQuery": [Function], - "visible": [Function], - }, "closeDialog": undefined, "closeSidePanel": undefined, "collapsedResourceTreeWidth": 36, diff --git a/src/Explorer/Panes/__snapshots__/DeleteDatabaseConfirmationPanel.test.tsx.snap b/src/Explorer/Panes/__snapshots__/DeleteDatabaseConfirmationPanel.test.tsx.snap index 44a530919..59f9a7ab6 100644 --- a/src/Explorer/Panes/__snapshots__/DeleteDatabaseConfirmationPanel.test.tsx.snap +++ b/src/Explorer/Panes/__snapshots__/DeleteDatabaseConfirmationPanel.test.tsx.snap @@ -15,51 +15,6 @@ exports[`Delete Database Confirmation Pane submit() Should call delete database "arcadiaToken": [Function], "canExceedMaximumValue": [Function], "canSaveQueries": [Function], - "cassandraAddCollectionPane": CassandraAddCollectionPane { - "autoPilotUsageCost": [Function], - "canConfigureThroughput": [Function], - "canExceedMaximumValue": [Function], - "canRequestSupport": [Function], - "container": [Circular], - "costsVisible": [Function], - "createTableQuery": [Function], - "dedicateTableThroughput": [Function], - "firstFieldHasFocus": [Function], - "formErrors": [Function], - "formErrorsDetails": [Function], - "id": "cassandraaddcollectionpane", - "isAutoPilotSelected": [Function], - "isExecuting": [Function], - "isFreeTierAccount": [Function], - "isSharedAutoPilotSelected": [Function], - "isTemplateReady": [Function], - "keyspaceCreateNew": [Function], - "keyspaceHasSharedOffer": [Function], - "keyspaceId": [Function], - "keyspaceIds": [Function], - "keyspaceOffers": Map {}, - "keyspaceThroughput": [Function], - "maxThroughputRU": [Function], - "minThroughputRU": [Function], - "requestUnitsUsageCostDedicated": [Function], - "requestUnitsUsageCostShared": [Function], - "ruToolTipText": [Function], - "selectedAutoPilotThroughput": [Function], - "sharedAutoPilotThroughput": [Function], - "sharedThroughputRangeText": [Function], - "sharedThroughputSpendAck": [Function], - "sharedThroughputSpendAckText": [Function], - "sharedThroughputSpendAckVisible": [Function], - "tableId": [Function], - "throughput": [Function], - "throughputRangeText": [Function], - "throughputSpendAck": [Function], - "throughputSpendAckText": [Function], - "throughputSpendAckVisible": [Function], - "title": [Function], - "userTableQuery": [Function], - "visible": [Function], - }, "closeDialog": undefined, "closeSidePanel": undefined, "collapsedResourceTreeWidth": 36, diff --git a/src/Main.tsx b/src/Main.tsx index b99d951b0..4b04fae7e 100644 --- a/src/Main.tsx +++ b/src/Main.tsx @@ -226,7 +226,6 @@ const App: React.FunctionComponent = () => { closePanel={closeSidePanel} isConsoleExpanded={isNotificationConsoleExpanded} /> -
{showDialog && }
); diff --git a/test/cassandra/container.spec.ts b/test/cassandra/container.spec.ts index 45ee23ce7..cb207cae9 100644 --- a/test/cassandra/container.spec.ts +++ b/test/cassandra/container.spec.ts @@ -15,11 +15,11 @@ test("Cassandra keyspace and table CRUD", async () => { }); await explorer.click('[data-test="New Table"]'); - await explorer.click('[data-test="addCollection-keyspaceId"]'); - await explorer.fill('[data-test="addCollection-keyspaceId"]', keyspaceId); - await explorer.click('[data-test="addCollection-tableId"]'); - await explorer.fill('[data-test="addCollection-tableId"]', tableId); - await explorer.click('[aria-label="Add Table"] [data-test="addCollection-createCollection"]'); + await explorer.click('[aria-label="Keyspace id"]'); + await explorer.fill('[aria-label="Keyspace id"]', keyspaceId); + await explorer.click('[aria-label="addCollection-tableId"]'); + await explorer.fill('[aria-label="addCollection-tableId"]', tableId); + await explorer.click("#sidePanelOkButton"); await safeClick(explorer, `.nodeItem >> text=${keyspaceId}`); await safeClick(explorer, `[data-test="${tableId}"] [aria-label="More"]`); await safeClick(explorer, 'button[role="menuitem"]:has-text("Delete Table")'); diff --git a/tsconfig.strict.json b/tsconfig.strict.json index 7a8971ce1..3cd73bf9f 100644 --- a/tsconfig.strict.json +++ b/tsconfig.strict.json @@ -60,7 +60,6 @@ "./src/Explorer/Notebook/NotebookUtil.ts", "./src/Explorer/OpenFullScreen.test.tsx", "./src/Explorer/OpenFullScreen.tsx", - "./src/Explorer/Panes/PaneComponents.ts", "./src/Explorer/Panes/PanelFooterComponent.tsx", "./src/Explorer/Panes/PanelInfoErrorComponent.tsx", "./src/Explorer/Panes/PanelLoadingScreen.tsx", From 6e9144b068feccbcd7c417c8f1b42257072011a9 Mon Sep 17 00:00:00 2001 From: Hardikkumar Nai <80053762+hardiknai-techm@users.noreply.github.com> Date: Wed, 19 May 2021 08:27:31 +0530 Subject: [PATCH 008/124] Remove generic right pane component (#790) Co-authored-by: Steve Faulkner --- .../CodeOfConduct.test.tsx} | 10 +- .../CodeOfConduct.tsx} | 8 +- .../CodeOfConduct.test.tsx.snap} | 2 +- .../CodeOfConductComponent.tsx | 123 - .../GalleryViewerComponent.tsx | 4 +- src/Explorer/Explorer.tsx | 8 +- .../NewVertexComponent/NewVertexComponent.tsx | 1 + .../CopyNotebookPane/CopyNotebookPane.tsx | 17 +- .../DeleteCollectionConfirmationPane.test.tsx | 8 +- .../DeleteCollectionConfirmationPane.tsx | 19 +- ...teCollectionConfirmationPane.test.tsx.snap | 4364 ++---- .../DeleteDatabaseConfirmationPanel.test.tsx | 4 +- .../Panes/DeleteDatabaseConfirmationPanel.tsx | 62 +- .../ExecuteSprocParamsPane.tsx | 35 +- .../ExecuteSprocParamsPane.test.tsx.snap | 12386 +++++++--------- .../GenericRightPaneComponent.tsx | 126 - .../Panes/LoadQueryPane/LoadQueryPane.tsx | 36 +- .../__snapshots__/LoadQueryPane.test.tsx.snap | 8 +- .../NewVertexPanel/NewVertexPanel.test.tsx | 6 +- .../Panes/NewVertexPanel/NewVertexPanel.tsx | 32 +- .../NewVertexPanel.test.tsx.snap | 12 +- .../Panes/PanelInfoErrorComponent.tsx | 1 + .../PublishNotebookPane.tsx | 20 +- .../Panes/SaveQueryPane/SaveQueryPane.tsx | 43 +- .../__snapshots__/SaveQueryPane.test.tsx.snap | 8 +- .../Panes/StringInputPane/StringInputPane.tsx | 19 +- .../StringInputPane.test.tsx.snap | 4798 +++--- ...est.tsx => TableQuerySelectPanel.test.tsx} | 2 +- .../{index.tsx => TableQuerySelectPanel.tsx} | 31 +- .../TableQuerySelectPanel.test.tsx.snap | 3007 ++++ .../__snapshots__/index.test.tsx.snap | 4205 ------ .../Panes/UploadFilePane/UploadFilePane.tsx | 4 +- .../Panes/UploadItemsPane/UploadItemsPane.tsx | 4 +- ...eteDatabaseConfirmationPanel.test.tsx.snap | 3210 ++-- test/cassandra/container.spec.ts | 2 +- test/graph/container.spec.ts | 2 +- test/mongo/container.spec.ts | 4 +- test/mongo/container32.spec.ts | 2 +- test/sql/container.spec.ts | 2 +- test/tables/container.spec.ts | 2 +- 40 files changed, 13754 insertions(+), 18883 deletions(-) rename src/Explorer/Controls/NotebookGallery/{CodeOfConductComponent/index.test.tsx => CodeOfConduct/CodeOfConduct.test.tsx} (71%) rename src/Explorer/Controls/NotebookGallery/{CodeOfConductComponent/index.tsx => CodeOfConduct/CodeOfConduct.tsx} (92%) rename src/Explorer/Controls/NotebookGallery/{CodeOfConductComponent/__snapshots__/index.test.tsx.snap => CodeOfConduct/__snapshots__/CodeOfConduct.test.tsx.snap} (96%) delete mode 100644 src/Explorer/Controls/NotebookGallery/CodeOfConductComponent.tsx delete mode 100644 src/Explorer/Panes/GenericRightPaneComponent/GenericRightPaneComponent.tsx rename src/Explorer/Panes/Tables/TableQuerySelectPanel/{index.test.tsx => TableQuerySelectPanel.test.tsx} (95%) rename src/Explorer/Panes/Tables/TableQuerySelectPanel/{index.tsx => TableQuerySelectPanel.tsx} (91%) create mode 100644 src/Explorer/Panes/Tables/TableQuerySelectPanel/__snapshots__/TableQuerySelectPanel.test.tsx.snap delete mode 100644 src/Explorer/Panes/Tables/TableQuerySelectPanel/__snapshots__/index.test.tsx.snap diff --git a/src/Explorer/Controls/NotebookGallery/CodeOfConductComponent/index.test.tsx b/src/Explorer/Controls/NotebookGallery/CodeOfConduct/CodeOfConduct.test.tsx similarity index 71% rename from src/Explorer/Controls/NotebookGallery/CodeOfConductComponent/index.test.tsx rename to src/Explorer/Controls/NotebookGallery/CodeOfConduct/CodeOfConduct.test.tsx index 79a6880a3..e99c0c8c2 100644 --- a/src/Explorer/Controls/NotebookGallery/CodeOfConductComponent/index.test.tsx +++ b/src/Explorer/Controls/NotebookGallery/CodeOfConduct/CodeOfConduct.test.tsx @@ -1,12 +1,12 @@ jest.mock("../../../../Juno/JunoClient"); import { shallow } from "enzyme"; import React from "react"; -import { CodeOfConductComponent, CodeOfConductComponentProps } from "."; import { HttpStatusCodes } from "../../../../Common/Constants"; import { JunoClient } from "../../../../Juno/JunoClient"; +import { CodeOfConduct, CodeOfConductProps } from "./CodeOfConduct"; -describe("CodeOfConductComponent", () => { - let codeOfConductProps: CodeOfConductComponentProps; +describe("CodeOfConduct", () => { + let codeOfConductProps: CodeOfConductProps; beforeEach(() => { const junoClient = new JunoClient(); @@ -21,12 +21,12 @@ describe("CodeOfConductComponent", () => { }); it("renders", () => { - const wrapper = shallow(); + const wrapper = shallow(); expect(wrapper).toMatchSnapshot(); }); it("onAcceptedCodeOfConductCalled", async () => { - const wrapper = shallow(); + const wrapper = shallow(); wrapper.find(".genericPaneSubmitBtn").first().simulate("click"); await Promise.resolve(); expect(codeOfConductProps.onAcceptCodeOfConduct).toBeCalled(); diff --git a/src/Explorer/Controls/NotebookGallery/CodeOfConductComponent/index.tsx b/src/Explorer/Controls/NotebookGallery/CodeOfConduct/CodeOfConduct.tsx similarity index 92% rename from src/Explorer/Controls/NotebookGallery/CodeOfConductComponent/index.tsx rename to src/Explorer/Controls/NotebookGallery/CodeOfConduct/CodeOfConduct.tsx index 6d1d78fb2..2bfee23dc 100644 --- a/src/Explorer/Controls/NotebookGallery/CodeOfConductComponent/index.tsx +++ b/src/Explorer/Controls/NotebookGallery/CodeOfConduct/CodeOfConduct.tsx @@ -6,15 +6,15 @@ import { JunoClient } from "../../../../Juno/JunoClient"; import { Action } from "../../../../Shared/Telemetry/TelemetryConstants"; import { trace, traceFailure, traceStart, traceSuccess } from "../../../../Shared/Telemetry/TelemetryProcessor"; -export interface CodeOfConductComponentProps { +export interface CodeOfConductProps { junoClient: JunoClient; onAcceptCodeOfConduct: (result: boolean) => void; } -export const CodeOfConductComponent: FunctionComponent = ({ +export const CodeOfConduct: FunctionComponent = ({ junoClient, onAcceptCodeOfConduct, -}: CodeOfConductComponentProps) => { +}: CodeOfConductProps) => { const descriptionPara1 = "Azure Cosmos DB Notebook Gallery - Code of Conduct"; const descriptionPara2 = "The notebook public gallery contains notebook samples shared by users of Azure Cosmos DB."; const descriptionPara3 = "In order to view and publish your samples to the gallery, you must accept the "; @@ -47,7 +47,7 @@ export const CodeOfConductComponent: FunctionComponent void; -} - -interface CodeOfConductComponentState { - readCodeOfConduct: boolean; -} - -export class CodeOfConductComponent extends React.Component { - private viewCodeOfConductTraced: boolean; - private descriptionPara1: string; - private descriptionPara2: string; - private descriptionPara3: string; - private link1: { label: string; url: string }; - - constructor(props: CodeOfConductComponentProps) { - super(props); - - this.state = { - readCodeOfConduct: false, - }; - - this.descriptionPara1 = "Azure Cosmos DB Notebook Gallery - Code of Conduct"; - this.descriptionPara2 = "The notebook public gallery contains notebook samples shared by users of Azure Cosmos DB."; - this.descriptionPara3 = "In order to view and publish your samples to the gallery, you must accept the "; - this.link1 = { label: "code of conduct.", url: CodeOfConductEndpoints.codeOfConduct }; - } - - private async acceptCodeOfConduct(): Promise { - const startKey = traceStart(Action.NotebooksGalleryAcceptCodeOfConduct); - - try { - const response = await this.props.junoClient.acceptCodeOfConduct(); - if (response.status !== HttpStatusCodes.OK && response.status !== HttpStatusCodes.NoContent) { - throw new Error(`Received HTTP ${response.status} when accepting code of conduct`); - } - - traceSuccess(Action.NotebooksGalleryAcceptCodeOfConduct, {}, startKey); - - this.props.onAcceptCodeOfConduct(response.data); - } catch (error) { - traceFailure( - Action.NotebooksGalleryAcceptCodeOfConduct, - { - error: getErrorMessage(error), - errorStack: getErrorStack(error), - }, - startKey - ); - - handleError(error, "CodeOfConductComponent/acceptCodeOfConduct", "Failed to accept code of conduct"); - } - } - - private onChangeCheckbox = (): void => { - this.setState({ readCodeOfConduct: !this.state.readCodeOfConduct }); - }; - - public render(): JSX.Element { - if (!this.viewCodeOfConductTraced) { - this.viewCodeOfConductTraced = true; - trace(Action.NotebooksGalleryViewCodeOfConduct); - } - - return ( - - - {this.descriptionPara1} - - - - {this.descriptionPara2} - - - - - {this.descriptionPara3} - - {this.link1.label} - - - - - - - - - - await this.acceptCodeOfConduct()} - tabIndex={0} - className="genericPaneSubmitBtn" - text="Continue" - disabled={!this.state.readCodeOfConduct} - /> - - - ); - } -} diff --git a/src/Explorer/Controls/NotebookGallery/GalleryViewerComponent.tsx b/src/Explorer/Controls/NotebookGallery/GalleryViewerComponent.tsx index f1733a141..e26ef58e0 100644 --- a/src/Explorer/Controls/NotebookGallery/GalleryViewerComponent.tsx +++ b/src/Explorer/Controls/NotebookGallery/GalleryViewerComponent.tsx @@ -30,7 +30,7 @@ import * as GalleryUtils from "../../../Utils/GalleryUtils"; import Explorer from "../../Explorer"; import { Dialog, DialogProps } from "../Dialog"; import { GalleryCardComponent, GalleryCardComponentProps } from "./Cards/GalleryCardComponent"; -import { CodeOfConductComponent } from "./CodeOfConductComponent"; +import { CodeOfConduct } from "./CodeOfConduct/CodeOfConduct"; import "./GalleryViewerComponent.less"; import { InfoComponent } from "./InfoComponent/InfoComponent"; @@ -372,7 +372,7 @@ export class GalleryViewerComponent extends React.Component
- { this.setState({ isCodeOfConductAccepted: result }); diff --git a/src/Explorer/Explorer.tsx b/src/Explorer/Explorer.tsx index a8d9fa7d7..ba8f563c4 100644 --- a/src/Explorer/Explorer.tsx +++ b/src/Explorer/Explorer.tsx @@ -67,7 +67,7 @@ import { SetupNoteBooksPanel } from "./Panes/SetupNotebooksPanel/SetupNotebooksP import { StringInputPane } from "./Panes/StringInputPane/StringInputPane"; import { AddTableEntityPanel } from "./Panes/Tables/AddTableEntityPanel"; import { EditTableEntityPanel } from "./Panes/Tables/EditTableEntityPanel"; -import { TableQuerySelectPanel } from "./Panes/Tables/TableQuerySelectPanel"; +import { TableQuerySelectPanel } from "./Panes/Tables/TableQuerySelectPanel/TableQuerySelectPanel"; import { UploadFilePane } from "./Panes/UploadFilePane/UploadFilePane"; import { UploadItemsPane } from "./Panes/UploadItemsPane/UploadItemsPane"; import TableListViewModal from "./Tables/DataTable/TableEntityListViewModel"; @@ -1379,7 +1379,7 @@ export default class Explorer { this.showOkModalDialog("Unable to rename file", "This file is being edited. Please close the tab and try again."); } else { this.openSidePanel( - "", + "Rename Notebook", { @@ -1410,7 +1410,7 @@ export default class Explorer { } this.openSidePanel( - "", + "Create new directory", { @@ -1902,7 +1902,7 @@ export default class Explorer { "Delete " + getDatabaseName(), this.expandConsole()} closePanel={this.closeSidePanel} selectedDatabase={this.findSelectedDatabase()} /> diff --git a/src/Explorer/Graph/NewVertexComponent/NewVertexComponent.tsx b/src/Explorer/Graph/NewVertexComponent/NewVertexComponent.tsx index d3011155a..fce3d43e7 100644 --- a/src/Explorer/Graph/NewVertexComponent/NewVertexComponent.tsx +++ b/src/Explorer/Graph/NewVertexComponent/NewVertexComponent.tsx @@ -132,6 +132,7 @@ export const NewVertexComponent: FunctionComponent = ( onChange={(event: React.ChangeEvent) => { onLabelChange(event); }} + autoFocus />
diff --git a/src/Explorer/Panes/CopyNotebookPane/CopyNotebookPane.tsx b/src/Explorer/Panes/CopyNotebookPane/CopyNotebookPane.tsx index 41b52a189..8026401b6 100644 --- a/src/Explorer/Panes/CopyNotebookPane/CopyNotebookPane.tsx +++ b/src/Explorer/Panes/CopyNotebookPane/CopyNotebookPane.tsx @@ -9,10 +9,7 @@ import * as NotificationConsoleUtils from "../../../Utils/NotificationConsoleUti import Explorer from "../../Explorer"; import { NotebookContentItem, NotebookContentItemType } from "../../Notebook/NotebookContentItem"; import { ResourceTreeAdapter } from "../../Tree/ResourceTreeAdapter"; -import { - GenericRightPaneComponent, - GenericRightPaneProps, -} from "../GenericRightPaneComponent/GenericRightPaneComponent"; +import { RightPaneForm, RightPaneFormProps } from "../RightPaneForm/RightPaneForm"; import { CopyNotebookPaneComponent, CopyNotebookPaneProps } from "./CopyNotebookPaneComponent"; interface Location { @@ -42,7 +39,6 @@ export const CopyNotebookPane: FunctionComponent = ({ }: CopyNotebookPanelProps) => { const [isExecuting, setIsExecuting] = useState(); const [formError, setFormError] = useState(""); - const [formErrorDetail, setFormErrorDetail] = useState(""); const [pinnedRepos, setPinnedRepos] = useState(); const [selectedLocation, setSelectedLocation] = useState(); @@ -92,7 +88,6 @@ export const CopyNotebookPane: FunctionComponent = ({ } catch (error) { const errorMessage = getErrorMessage(error); setFormError(`Failed to copy ${name} to ${destination}`); - setFormErrorDetail(`${errorMessage}`); handleError(errorMessage, "CopyNotebookPaneAdapter/submit", formError); } finally { clearMessage && clearMessage(); @@ -130,14 +125,10 @@ export const CopyNotebookPane: FunctionComponent = ({ setSelectedLocation(option?.data); }; - const genericPaneProps: GenericRightPaneProps = { + const props: RightPaneFormProps = { formError, - formErrorDetail, - id: "copynotebookpane", isExecuting: isExecuting, - title: "Copy notebook", submitButtonText: "OK", - onClose: closePanel, onSubmit: () => submit(), expandConsole: () => container.expandConsole(), }; @@ -149,8 +140,8 @@ export const CopyNotebookPane: FunctionComponent = ({ }; return ( - + - + ); }; diff --git a/src/Explorer/Panes/DeleteCollectionConfirmationPane/DeleteCollectionConfirmationPane.test.tsx b/src/Explorer/Panes/DeleteCollectionConfirmationPane/DeleteCollectionConfirmationPane.test.tsx index 619650451..c75f998e3 100644 --- a/src/Explorer/Panes/DeleteCollectionConfirmationPane/DeleteCollectionConfirmationPane.test.tsx +++ b/src/Explorer/Panes/DeleteCollectionConfirmationPane/DeleteCollectionConfirmationPane.test.tsx @@ -130,8 +130,8 @@ describe("Delete Collection Confirmation Pane", () => { .hostNodes() .simulate("change", { target: { value: selectedCollectionId } }); - expect(wrapper.exists(".genericPaneSubmitBtn")).toBe(true); - wrapper.find(".genericPaneSubmitBtn").hostNodes().simulate("click"); + expect(wrapper.exists("#sidePanelOkButton")).toBe(true); + wrapper.find("#sidePanelOkButton").hostNodes().simulate("submit"); expect(deleteCollection).toHaveBeenCalledWith(databaseId, selectedCollectionId); wrapper.unmount(); @@ -151,8 +151,8 @@ describe("Delete Collection Confirmation Pane", () => { .hostNodes() .simulate("change", { target: { value: feedbackText } }); - expect(wrapper.exists(".genericPaneSubmitBtn")).toBe(true); - wrapper.find(".genericPaneSubmitBtn").hostNodes().simulate("click"); + expect(wrapper.exists("#sidePanelOkButton")).toBe(true); + wrapper.find("#sidePanelOkButton").hostNodes().simulate("submit"); expect(deleteCollection).toHaveBeenCalledWith(databaseId, selectedCollectionId); const deleteFeedback = new DeleteFeedback( diff --git a/src/Explorer/Panes/DeleteCollectionConfirmationPane/DeleteCollectionConfirmationPane.tsx b/src/Explorer/Panes/DeleteCollectionConfirmationPane/DeleteCollectionConfirmationPane.tsx index 1fdc2488b..5fe8c76f5 100644 --- a/src/Explorer/Panes/DeleteCollectionConfirmationPane/DeleteCollectionConfirmationPane.tsx +++ b/src/Explorer/Panes/DeleteCollectionConfirmationPane/DeleteCollectionConfirmationPane.tsx @@ -12,10 +12,7 @@ import { userContext } from "../../../UserContext"; import { getCollectionName } from "../../../Utils/APITypeUtils"; import * as NotificationConsoleUtils from "../../../Utils/NotificationConsoleUtils"; import Explorer from "../../Explorer"; -import { - GenericRightPaneComponent, - GenericRightPaneProps, -} from "../GenericRightPaneComponent/GenericRightPaneComponent"; +import { RightPaneForm, RightPaneFormProps } from "../RightPaneForm/RightPaneForm"; export interface DeleteCollectionConfirmationPaneProps { explorer: Explorer; closePanel: () => void; @@ -35,7 +32,7 @@ export const DeleteCollectionConfirmationPane: FunctionComponent => { + const onSubmit = async (): Promise => { const collection = explorer.findSelectedCollection(); if (!collection || inputCollectionName !== collection.id()) { const errorMessage = "Input " + collectionName + " name does not match the selected " + collectionName; @@ -100,19 +97,15 @@ export const DeleteCollectionConfirmationPane: FunctionComponent explorer.expandConsole(), }; return ( - +
@@ -150,6 +143,6 @@ export const DeleteCollectionConfirmationPane: FunctionComponent
- + ); }; diff --git a/src/Explorer/Panes/DeleteCollectionConfirmationPane/__snapshots__/DeleteCollectionConfirmationPane.test.tsx.snap b/src/Explorer/Panes/DeleteCollectionConfirmationPane/__snapshots__/DeleteCollectionConfirmationPane.test.tsx.snap index 2cf3a5962..0157faed6 100644 --- a/src/Explorer/Panes/DeleteCollectionConfirmationPane/__snapshots__/DeleteCollectionConfirmationPane.test.tsx.snap +++ b/src/Explorer/Panes/DeleteCollectionConfirmationPane/__snapshots__/DeleteCollectionConfirmationPane.test.tsx.snap @@ -15,70 +15,62 @@ exports[`Delete Collection Confirmation Pane submit() should call delete collect } } > - -
-
- Delete container + * - + + Confirm by typing the + container + id + + + - - *": Object { - "left": 0, - "position": "relative", - "top": 0, - }, - }, - "textAlign": "center", - "textDecoration": "none", - "userSelect": "none", - }, - Object { - "backgroundColor": "transparent", - "border": "none", - "color": "#0078d4", - "height": "32px", - "padding": "0 4px", - "width": "32px", - }, - ], - "rootChecked": Object { - "backgroundColor": "#edebe9", - "color": "#005a9e", - }, - "rootCheckedHovered": Object { - "backgroundColor": "#e1dfdd", - "color": "#005a9e", - }, - "rootDisabled": Array [ - Object { - "outline": "transparent", - "position": "relative", - "selectors": Object { - ".ms-Fabric--isFocusVisible &:focus:after": Object { - "border": "1px solid transparent", - "bottom": 2, - "content": "\\"\\"", - "left": 2, - "outline": "1px solid #605e5c", - "position": "absolute", - "right": 2, - "selectors": Object { - "@media screen and (-ms-high-contrast: active), (forced-colors: active)": Object { - "bottom": -2, - "left": -2, - "outlineColor": "ButtonText", - "right": -2, - "top": -2, - }, - }, - "top": 2, - "zIndex": 1, - }, - "::-moz-focus-inner": Object { - "border": "0", - }, - }, - }, - Object { - "backgroundColor": "#f3f2f1", - "borderColor": "#f3f2f1", - "color": "#a19f9d", - "cursor": "default", - "selectors": Object { - ":focus": Object { - "outline": 0, - }, - ":hover": Object { - "outline": 0, - }, - }, - }, - Object { - "color": "#c8c6c4", - }, - ], - "rootExpanded": Object { - "backgroundColor": "#edebe9", - "color": "#005a9e", - }, - "rootHasMenu": Object { - "width": "auto", - }, - "rootHovered": Object { - "backgroundColor": "#f3f2f1", - "color": "#106ebe", - "selectors": Object { - "@media screen and (-ms-high-contrast: active), (forced-colors: active)": Object { - "borderColor": "Highlight", - "color": "Highlight", - }, - }, - }, - "rootPressed": Object { - "backgroundColor": "#edebe9", - "color": "#005a9e", - }, - "screenReaderText": Object { - "border": 0, - "height": 1, - "margin": -1, - "overflow": "hidden", - "padding": 0, - "position": "absolute", - "width": 1, - }, - "splitButtonContainer": Array [ - Object { - "outline": "transparent", - "position": "relative", - "selectors": Object { - ".ms-Fabric--isFocusVisible &:focus:after": Object { - "border": "1px solid #ffffff", - "bottom": 3, - "content": "\\"\\"", - "left": 3, - "outline": "1px solid #605e5c", - "position": "absolute", - "right": 3, - "selectors": Object { - "@media screen and (-ms-high-contrast: active), (forced-colors: active)": Object { - "border": "none", - "bottom": -2, - "left": -2, - "right": -2, - "top": -2, - }, - }, - "top": 3, - "zIndex": 1, - }, - "::-moz-focus-inner": Object { - "border": "0", - }, - }, - }, - Object { - "display": "inline-flex", - "selectors": Object { - ".ms-Button--default": Object { - "borderBottomRightRadius": "0", - "borderRight": "none", - "borderTopRightRadius": "0", - }, - ".ms-Button--primary": Object { - "border": "none", - "borderBottomRightRadius": "0", - "borderTopRightRadius": "0", - "selectors": Object { - "@media screen and (-ms-high-contrast: active), (forced-colors: active)": Object { - "MsHighContrastAdjust": "none", - "backgroundColor": "Window", - "border": "1px solid WindowText", - "borderRightWidth": "0", - "color": "WindowText", - "forcedColorAdjust": "none", - }, - }, - }, - ".ms-Button--primary + .ms-Button": Object { - "border": "none", - "selectors": Object { - "@media screen and (-ms-high-contrast: active), (forced-colors: active)": Object { - "border": "1px solid WindowText", - "borderLeftWidth": "0", - }, - }, - }, - }, - }, - ], - "splitButtonContainerChecked": Object { - "selectors": Object { - ".ms-Button--primary": Object { - "selectors": Object { - "@media screen and (-ms-high-contrast: active), (forced-colors: active)": Object { - "MsHighContrastAdjust": "none", - "backgroundColor": "WindowText", - "color": "Window", - "forcedColorAdjust": "none", - }, - }, - }, - }, - }, - "splitButtonContainerCheckedHovered": Object { - "selectors": Object { - ".ms-Button--primary": Object { - "selectors": Object { - "@media screen and (-ms-high-contrast: active), (forced-colors: active)": Object { - "MsHighContrastAdjust": "none", - "backgroundColor": "WindowText", - "color": "Window", - "forcedColorAdjust": "none", - }, - }, - }, - }, - }, - "splitButtonContainerDisabled": Object { - "border": "none", - "outline": "none", - "selectors": Object { - "@media screen and (-ms-high-contrast: active), (forced-colors: active)": Object { - "MsHighContrastAdjust": "none", - "backgroundColor": "Window", - "borderColor": "GrayText", - "color": "GrayText", - "forcedColorAdjust": "none", - }, - }, - }, - "splitButtonContainerFocused": Object { - "outline": "none!important", - }, - "splitButtonContainerHovered": Object { - "selectors": Object { - ".ms-Button--primary": Object { - "selectors": Object { - "@media screen and (-ms-high-contrast: active), (forced-colors: active)": Object { - "backgroundColor": "Highlight", - "color": "Window", - }, - }, - }, - ".ms-Button.is-disabled": Object { - "color": "#a19f9d", - "selectors": Object { - "@media screen and (-ms-high-contrast: active), (forced-colors: active)": Object { - "backgroundColor": "Window", - "borderColor": "GrayText", - "color": "GrayText", - }, - }, - }, - }, - }, - "splitButtonDivider": Object { - "bottom": 8, - "position": "absolute", - "right": 31, - "selectors": Object { - "@media screen and (-ms-high-contrast: active), (forced-colors: active)": Object { - "backgroundColor": "WindowText", - }, - }, - "top": 8, - "width": 1, - }, - "splitButtonDividerDisabled": Object { - "bottom": 8, - "position": "absolute", - "right": 31, - "selectors": Object { - "@media screen and (-ms-high-contrast: active), (forced-colors: active)": Object { - "backgroundColor": "GrayText", - }, - }, - "top": 8, - "width": 1, - }, - "splitButtonFlexContainer": Object { - "alignItems": "center", - "display": "flex", - "flexWrap": "nowrap", - "height": "100%", - "justifyContent": "center", - }, - "splitButtonMenuButton": Object { - "@media screen and (-ms-high-contrast: active), (forced-colors: active)": Object { - ".ms-Button-menuIcon": Object { - "color": "WindowText", - }, - }, - "border": "1px solid #8a8886", - "borderBottomRightRadius": "2px", - "borderLeft": "none", - "borderRadius": 0, - "borderTopRightRadius": "2px", - "boxSizing": "border-box", - "cursor": "pointer", - "display": "inline-block", - "height": "auto", - "marginBottom": 0, - "marginLeft": -1, - "marginRight": 0, - "marginTop": 0, - "outline": "transparent", - "padding": 6, - "textAlign": "center", - "textDecoration": "none", - "userSelect": "none", - "verticalAlign": "top", - "width": 32, - }, - "splitButtonMenuButtonDisabled": Object { - "border": "none", - "pointerEvents": "none", - "selectors": Object { - ".ms-Button--primary": Object { - "selectors": Object { - "@media screen and (-ms-high-contrast: active), (forced-colors: active)": Object { - "backgroundColor": "Window", - "borderColor": "GrayText", - "color": "GrayText", - }, - }, - }, - ".ms-Button-menuIcon": Object { - "selectors": Object { - "@media screen and (-ms-high-contrast: active), (forced-colors: active)": Object { - "color": "GrayText", - }, - }, - }, - ":hover": Object { - "cursor": "default", - }, - "@media screen and (-ms-high-contrast: active), (forced-colors: active)": Object { - "backgroundColor": "Window", - "border": "1px solid GrayText", - "color": "GrayText", - }, - }, - }, - "splitButtonMenuFocused": Object { - "outline": "transparent", - "position": "relative", - "selectors": Object { - ".ms-Fabric--isFocusVisible &:focus:after": Object { - "border": "1px solid #ffffff", - "bottom": 3, - "content": "\\"\\"", - "left": 3, - "outline": "1px solid #605e5c", - "position": "absolute", - "right": 3, - "selectors": Object { - "@media screen and (-ms-high-contrast: active), (forced-colors: active)": Object { - "border": "none", - "bottom": -2, - "left": -2, - "right": -2, - "top": -2, - }, - }, - "top": 3, - "zIndex": 1, - }, - "::-moz-focus-inner": Object { - "border": "0", - }, - }, - }, - "textContainer": Object { - "display": "block", - "flexGrow": 1, - }, - } - } - tabIndex={0} - theme={ - Object { - "disableGlobalClassNames": false, - "effects": Object { - "elevation16": "0 6.4px 14.4px 0 rgba(0, 0, 0, 0.132), 0 1.2px 3.6px 0 rgba(0, 0, 0, 0.108)", - "elevation4": "0 1.6px 3.6px 0 rgba(0, 0, 0, 0.132), 0 0.3px 0.9px 0 rgba(0, 0, 0, 0.108)", - "elevation64": "0 25.6px 57.6px 0 rgba(0, 0, 0, 0.22), 0 4.8px 14.4px 0 rgba(0, 0, 0, 0.18)", - "elevation8": "0 3.2px 7.2px 0 rgba(0, 0, 0, 0.132), 0 0.6px 1.8px 0 rgba(0, 0, 0, 0.108)", - "roundedCorner2": "2px", - "roundedCorner4": "4px", - "roundedCorner6": "6px", - }, - "fonts": Object { - "large": Object { - "MozOsxFontSmoothing": "grayscale", - "WebkitFontSmoothing": "antialiased", - "fontFamily": "'Segoe UI', 'Segoe UI Web (West European)', 'Segoe UI', -apple-system, BlinkMacSystemFont, 'Roboto', 'Helvetica Neue', sans-serif", - "fontSize": "18px", - "fontWeight": 400, - }, - "medium": Object { - "MozOsxFontSmoothing": "grayscale", - "WebkitFontSmoothing": "antialiased", - "fontFamily": "'Segoe UI', 'Segoe UI Web (West European)', 'Segoe UI', -apple-system, BlinkMacSystemFont, 'Roboto', 'Helvetica Neue', sans-serif", - "fontSize": "14px", - "fontWeight": 400, - }, - "mediumPlus": Object { - "MozOsxFontSmoothing": "grayscale", - "WebkitFontSmoothing": "antialiased", - "fontFamily": "'Segoe UI', 'Segoe UI Web (West European)', 'Segoe UI', -apple-system, BlinkMacSystemFont, 'Roboto', 'Helvetica Neue', sans-serif", - "fontSize": "16px", - "fontWeight": 400, - }, - "mega": Object { - "MozOsxFontSmoothing": "grayscale", - "WebkitFontSmoothing": "antialiased", - "fontFamily": "'Segoe UI', 'Segoe UI Web (West European)', 'Segoe UI', -apple-system, BlinkMacSystemFont, 'Roboto', 'Helvetica Neue', sans-serif", - "fontSize": "68px", - "fontWeight": 600, - }, - "small": Object { - "MozOsxFontSmoothing": "grayscale", - "WebkitFontSmoothing": "antialiased", - "fontFamily": "'Segoe UI', 'Segoe UI Web (West European)', 'Segoe UI', -apple-system, BlinkMacSystemFont, 'Roboto', 'Helvetica Neue', sans-serif", - "fontSize": "12px", - "fontWeight": 400, - }, - "smallPlus": Object { - "MozOsxFontSmoothing": "grayscale", - "WebkitFontSmoothing": "antialiased", - "fontFamily": "'Segoe UI', 'Segoe UI Web (West European)', 'Segoe UI', -apple-system, BlinkMacSystemFont, 'Roboto', 'Helvetica Neue', sans-serif", - "fontSize": "12px", - "fontWeight": 400, - }, - "superLarge": Object { - "MozOsxFontSmoothing": "grayscale", - "WebkitFontSmoothing": "antialiased", - "fontFamily": "'Segoe UI', 'Segoe UI Web (West European)', 'Segoe UI', -apple-system, BlinkMacSystemFont, 'Roboto', 'Helvetica Neue', sans-serif", - "fontSize": "42px", - "fontWeight": 600, - }, - "tiny": Object { - "MozOsxFontSmoothing": "grayscale", - "WebkitFontSmoothing": "antialiased", - "fontFamily": "'Segoe UI', 'Segoe UI Web (West European)', 'Segoe UI', -apple-system, BlinkMacSystemFont, 'Roboto', 'Helvetica Neue', sans-serif", - "fontSize": "10px", - "fontWeight": 400, - }, - "xLarge": Object { - "MozOsxFontSmoothing": "grayscale", - "WebkitFontSmoothing": "antialiased", - "fontFamily": "'Segoe UI', 'Segoe UI Web (West European)', 'Segoe UI', -apple-system, BlinkMacSystemFont, 'Roboto', 'Helvetica Neue', sans-serif", - "fontSize": "20px", - "fontWeight": 600, - }, - "xLargePlus": Object { - "MozOsxFontSmoothing": "grayscale", - "WebkitFontSmoothing": "antialiased", - "fontFamily": "'Segoe UI', 'Segoe UI Web (West European)', 'Segoe UI', -apple-system, BlinkMacSystemFont, 'Roboto', 'Helvetica Neue', sans-serif", - "fontSize": "24px", - "fontWeight": 600, - }, - "xSmall": Object { - "MozOsxFontSmoothing": "grayscale", - "WebkitFontSmoothing": "antialiased", - "fontFamily": "'Segoe UI', 'Segoe UI Web (West European)', 'Segoe UI', -apple-system, BlinkMacSystemFont, 'Roboto', 'Helvetica Neue', sans-serif", - "fontSize": "10px", - "fontWeight": 400, - }, - "xxLarge": Object { - "MozOsxFontSmoothing": "grayscale", - "WebkitFontSmoothing": "antialiased", - "fontFamily": "'Segoe UI', 'Segoe UI Web (West European)', 'Segoe UI', -apple-system, BlinkMacSystemFont, 'Roboto', 'Helvetica Neue', sans-serif", - "fontSize": "28px", - "fontWeight": 600, - }, - "xxLargePlus": Object { - "MozOsxFontSmoothing": "grayscale", - "WebkitFontSmoothing": "antialiased", - "fontFamily": "'Segoe UI', 'Segoe UI Web (West European)', 'Segoe UI', -apple-system, BlinkMacSystemFont, 'Roboto', 'Helvetica Neue', sans-serif", - "fontSize": "32px", - "fontWeight": 600, - }, - }, - "isInverted": false, - "palette": Object { - "accent": "#0078d4", - "black": "#000000", - "blackTranslucent40": "rgba(0,0,0,.4)", - "blue": "#0078d4", - "blueDark": "#002050", - "blueLight": "#00bcf2", - "blueMid": "#00188f", - "green": "#107c10", - "greenDark": "#004b1c", - "greenLight": "#bad80a", - "magenta": "#b4009e", - "magentaDark": "#5c005c", - "magentaLight": "#e3008c", - "neutralDark": "#201f1e", - "neutralLight": "#edebe9", - "neutralLighter": "#f3f2f1", - "neutralLighterAlt": "#faf9f8", - "neutralPrimary": "#323130", - "neutralPrimaryAlt": "#3b3a39", - "neutralQuaternary": "#d2d0ce", - "neutralQuaternaryAlt": "#e1dfdd", - "neutralSecondary": "#605e5c", - "neutralSecondaryAlt": "#8a8886", - "neutralTertiary": "#a19f9d", - "neutralTertiaryAlt": "#c8c6c4", - "orange": "#d83b01", - "orangeLight": "#ea4300", - "orangeLighter": "#ff8c00", - "purple": "#5c2d91", - "purpleDark": "#32145a", - "purpleLight": "#b4a0ff", - "red": "#e81123", - "redDark": "#a4262c", - "teal": "#008272", - "tealDark": "#004b50", - "tealLight": "#00b294", - "themeDark": "#005a9e", - "themeDarkAlt": "#106ebe", - "themeDarker": "#004578", - "themeLight": "#c7e0f4", - "themeLighter": "#deecf9", - "themeLighterAlt": "#eff6fc", - "themePrimary": "#0078d4", - "themeSecondary": "#2b88d8", - "themeTertiary": "#71afe5", - "white": "#ffffff", - "whiteTranslucent40": "rgba(255,255,255,.4)", - "yellow": "#ffb900", - "yellowDark": "#d29200", - "yellowLight": "#fff100", - }, - "rtl": undefined, - "semanticColors": Object { - "accentButtonBackground": "#0078d4", - "accentButtonText": "#ffffff", - "actionLink": "#323130", - "actionLinkHovered": "#201f1e", - "blockingBackground": "#FDE7E9", - "blockingIcon": "#FDE7E9", - "bodyBackground": "#ffffff", - "bodyBackgroundChecked": "#edebe9", - "bodyBackgroundHovered": "#f3f2f1", - "bodyDivider": "#edebe9", - "bodyFrameBackground": "#ffffff", - "bodyFrameDivider": "#edebe9", - "bodyStandoutBackground": "#faf9f8", - "bodySubtext": "#605e5c", - "bodyText": "#323130", - "bodyTextChecked": "#000000", - "buttonBackground": "#ffffff", - "buttonBackgroundChecked": "#c8c6c4", - "buttonBackgroundCheckedHovered": "#edebe9", - "buttonBackgroundDisabled": "#f3f2f1", - "buttonBackgroundHovered": "#f3f2f1", - "buttonBackgroundPressed": "#edebe9", - "buttonBorder": "#8a8886", - "buttonBorderDisabled": "#f3f2f1", - "buttonText": "#323130", - "buttonTextChecked": "#201f1e", - "buttonTextCheckedHovered": "#000000", - "buttonTextDisabled": "#a19f9d", - "buttonTextHovered": "#201f1e", - "buttonTextPressed": "#201f1e", - "cardShadow": "0 1.6px 3.6px 0 rgba(0, 0, 0, 0.132), 0 0.3px 0.9px 0 rgba(0, 0, 0, 0.108)", - "cardShadowHovered": "0 3.2px 7.2px 0 rgba(0, 0, 0, 0.132), 0 0.6px 1.8px 0 rgba(0, 0, 0, 0.108)", - "cardStandoutBackground": "#ffffff", - "defaultStateBackground": "#faf9f8", - "disabledBackground": "#f3f2f1", - "disabledBodySubtext": "#c8c6c4", - "disabledBodyText": "#a19f9d", - "disabledBorder": "#c8c6c4", - "disabledSubtext": "#d2d0ce", - "disabledText": "#a19f9d", - "errorBackground": "#FDE7E9", - "errorIcon": "#A80000", - "errorText": "#a4262c", - "focusBorder": "#605e5c", - "infoBackground": "#f3f2f1", - "infoIcon": "#605e5c", - "inputBackground": "#ffffff", - "inputBackgroundChecked": "#0078d4", - "inputBackgroundCheckedHovered": "#005a9e", - "inputBorder": "#605e5c", - "inputBorderHovered": "#323130", - "inputFocusBorderAlt": "#0078d4", - "inputForegroundChecked": "#ffffff", - "inputIcon": "#0078d4", - "inputIconDisabled": "#a19f9d", - "inputIconHovered": "#005a9e", - "inputPlaceholderBackgroundChecked": "#deecf9", - "inputPlaceholderText": "#605e5c", - "inputText": "#323130", - "inputTextHovered": "#201f1e", - "link": "#0078d4", - "linkHovered": "#004578", - "listBackground": "#ffffff", - "listHeaderBackgroundHovered": "#f3f2f1", - "listHeaderBackgroundPressed": "#edebe9", - "listItemBackgroundChecked": "#edebe9", - "listItemBackgroundCheckedHovered": "#e1dfdd", - "listItemBackgroundHovered": "#f3f2f1", - "listText": "#323130", - "listTextColor": "#323130", - "menuBackground": "#ffffff", - "menuDivider": "#c8c6c4", - "menuHeader": "#0078d4", - "menuIcon": "#0078d4", - "menuItemBackgroundChecked": "#edebe9", - "menuItemBackgroundHovered": "#f3f2f1", - "menuItemBackgroundPressed": "#edebe9", - "menuItemText": "#323130", - "menuItemTextHovered": "#201f1e", - "messageLink": "#005A9E", - "messageLinkHovered": "#004578", - "messageText": "#323130", - "primaryButtonBackground": "#0078d4", - "primaryButtonBackgroundDisabled": "#f3f2f1", - "primaryButtonBackgroundHovered": "#106ebe", - "primaryButtonBackgroundPressed": "#005a9e", - "primaryButtonBorder": "transparent", - "primaryButtonText": "#ffffff", - "primaryButtonTextDisabled": "#d2d0ce", - "primaryButtonTextHovered": "#ffffff", - "primaryButtonTextPressed": "#ffffff", - "severeWarningBackground": "#FED9CC", - "severeWarningIcon": "#D83B01", - "smallInputBorder": "#605e5c", - "successBackground": "#DFF6DD", - "successIcon": "#107C10", - "successText": "#107C10", - "variantBorder": "#edebe9", - "variantBorderHovered": "#a19f9d", - "warningBackground": "#FFF4CE", - "warningHighlight": "#ffb900", - "warningIcon": "#797775", - "warningText": "#323130", - }, - "spacing": Object { - "l1": "20px", - "l2": "32px", - "m": "16px", - "s1": "8px", - "s2": "4px", - }, - } - } - title="Close pane" - variantClassName="ms-Button--icon" +
- - - - - + +
+
+
+ +
-
-
+ -
- - * - - - - Confirm by typing the - container - id - - - - -
-
-
- -
-
-
- - -
-
- - - Help us improve Azure Cosmos DB! - - - - - What is the reason why you are deleting this - container - ? - - - - -
-
-
-