@grafana/k6-test-builder 0.5.4 → 0.5.5-alpha.1

package/dist/index.d.ts

@@ -1,6 +1,7 @@
 import { FocusEventHandler, AnchorHTMLAttributes, ReactNode, ElementType, ReactElement, FunctionComponent } from "react";
 import { InvalidArchiveError } from "har-to-k6";
 import { ThemeOptions } from "@material-ui/core/styles/createTheme";
+import { GrafanaTheme2 } from "@grafana/data";
 /** @todo move this type */
 interface K6LoadZone {
     k6_load_zone_id: string;
@@ -13,6 +14,7 @@ export interface RampingStage {
     target: '' | number | null;
     duration: string;
 }
+type RequestMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'OPTIONS' | 'DELETE' | 'HEAD';
 declare const ScenarioExecutor: {
     readonly SharedIterations: "shared-iterations";
     readonly PerVUIterations: "per-vu-iterations";
@@ -70,6 +72,17 @@ interface RampingArrivalRateOptions extends ScenarioCommonOptions {
     maxVUs?: number;
 }
 type ScenarioOptions = SharedIterationsOptions | PerVUIterationsOptions | ConstantVUsOptions | RampingVUsOptions | ConstantArrivalRateOptions | RampingArrivalRateOptions;
+enum CheckType {
+    Text = 0,
+    JSONPathValue = 1,
+    JSONPath = 2,
+    RegEx = 3
+}
+enum VariableType {
+    JSONPath = 0,
+    RegEx = 1,
+    CSSSelector = 2
+}
 interface PrometheusTokenCredentials {
     token: string;
 }
@@ -130,8 +143,48 @@ interface ScriptScenarioConfig<T = ScenarioOptions> extends ConfigObject<T> {
     imports: string[];
     body: string;
 }
+export const DEFAULT_OPTIONS: {
+    vus: number;
+    duration: string;
+    ext: {
+        loadimpact: {
+            distribution: {
+                'amazon:us:ashburn': {
+                    loadZone: string;
+                    percent: number;
+                };
+            };
+        };
+    };
+};
 export const DOCS_ARTICLE_LINKS: {
+    root: string;
+    'error-codes': string;
+    start: string;
+    notifications: string;
+    'script-examples': string;
+    'ramp-up': string;
+    'insights-smart-results': string;
+    'interpret-test': string;
+    'concepts.checks': string;
+    'concepts.thresholds': string;
+    'concepts.performance-alerts': string;
+    'performance-alerts.too-many-urls': string;
+    'performance-alerts.third-party-content': string;
+    checks: string;
     thresholds: string;
+    metrics: string;
+    'metrics.built-in': string;
+    'metrics.custom': string;
+    scenarios: string;
+    tutorials: string;
+    'tutorials.automated-performance-testing.local-vs-cloud-execution': string;
+    'compare-results': string;
+    'insights-help': string;
+    'how-to-do-browser-recording': string;
+    'user-token': string;
+    'organization-help': string;
+    'project-help': string;
     'request-builder': string;
     'cloud-logs': string;
     'cloud-apm': string;
@@ -140,7 +193,60 @@ export const DOCS_ARTICLE_LINKS: {
     'cloud-apm-grafana-cloud': string;
     'cloud-apm-new-relic': string;
     'results-visualization/cloud': string;
+    'options.discard-response-bodies': string;
+    'groups-help': string;
+    'url-grouping-help': string;
+    'tags-help': string;
+    'websockets-help': string;
+    'http-requests-help': string;
+    'recording-help': string;
+    'data-retention-policy': string;
+    'usage-reports': string;
+    'manage-thresholds': string;
+    faq: string;
+    'getting-started': string;
+    'run-test': string;
+    'product-overview': string;
+    'javascript-api': string;
+    'javascript-api.metrics': string;
+    'javascript-api.http.set-response-callback': string;
+    'javascript-api.sleep': string;
+    'api-load-testing': string;
+    scripting: string;
+    'test-running': string;
+    'what-is-vus': string;
+    'filter-domains': string;
+    debuggin: string;
+    'schedule-help': string;
+    'request-builder.basic': string;
+    'request-builder.advanced': string;
+    'request-builder.payload': string;
+    'request-builder.scripting': string;
+    'request-builder.query-params': string;
+    'request-builder.variables': string;
+    'request-builder.checks': string;
+    'request-builder.headers': string;
+    'request-builder.importing': string;
     'cloud-tests-from-cli.load-zones': string;
+    'http-requests.url-grouping': string;
+    'http-requests.tags': string;
+    'modules.local-filesystem-modules': string;
+    'performance-insights.too-many-groups': string;
+    'performance-insights.too-many-metrics': string;
+    'performance-insights.too-many-urls': string;
+    'performance-insights.too-many-time-series': string;
+    'performance-insights.third-party-content': string;
+    'performance-insights.high-load-generator-cpu-usage': string;
+    'performance-insights.high-load-generator-memory-usage': string;
+    'performance-insights.high-http-failure-rate': string;
+    'performance-insights.increased-http-failure-rate': string;
+    'performance-insights.throughput-limit': string;
+    'performance-insights.disabling-performance-insights': string;
+    'performance-insights.abort-reason-user': string;
+    'performance-insights.abort-reason-threshold': string;
+    'performance-insights.abort-reason-system': string;
+    'performance-insights.abort-reason-limit': string;
+    'performance-insights.abort-reason-script-error': string;
 };
 type DocsArticleLink = keyof typeof DOCS_ARTICLE_LINKS;
 interface ImportItemChoice {
@@ -187,6 +293,76 @@ export interface LogOptions {
     thresholds: Thresholds;
     scenarios: Record<string, ScenarioOptions>;
 }
+enum SleepType {
+    Before = "before",
+    After = "after"
+}
+type Sleep = Partial<Record<SleepType, number>>;
+interface Page {
+    id: string;
+    name: string;
+    title: string;
+    sleep?: Sleep[];
+    startedDateTime: string;
+}
+type NameValueRecord = Record<'name' | 'value', string>;
+interface EntryCheck {
+    type: CheckType;
+    expression?: string;
+    subject?: number;
+    condition?: number;
+    value?: string;
+}
+type PostDataType = 'keyValuePairs' | 'json' | 'text' | 'file' | string;
+interface PostData {
+    mimeType: string;
+    comment: PostDataType;
+    text?: string;
+    params?: NameValueRecord[];
+}
+interface EntryRequest {
+    headers: NameValueRecord[];
+    method: RequestMethod;
+    queryString: NameValueRecord[];
+    postData?: PostData;
+    url: string;
+    sleep?: Sleep[];
+}
+interface EntryVariable {
+    type: VariableType;
+    name: string;
+    expression: string;
+    attribute?: string;
+}
+interface Entry {
+    pageref: string;
+    checks: EntryCheck[];
+    comment: string;
+    request: EntryRequest;
+    variables: EntryVariable[];
+    sleep?: Sleep[];
+    startedDateTime: string;
+}
+interface LogCreator {
+    name: string;
+    version: string;
+}
+interface ArchiveLog {
+    entries: Array<Entry>;
+    id?: string;
+    name?: string;
+    version?: string;
+    creator?: LogCreator;
+    options?: LogOptions;
+    pages?: Array<Page>;
+    exportAs?: string;
+    namedExport?: boolean;
+    comment?: string;
+}
+export interface Archive {
+    log: ArchiveLog;
+    optionsPlaceholder?: boolean;
+}
 export function convertDurationToSeconds(duration?: string): number;
 export function isDurationValid(duration: string): boolean;
 export function isStageTargetValid(target: any): boolean;
@@ -234,6 +410,25 @@ interface StagesVirtualizationComponentProps {
 type LoadZoneDataItem = {
     id: number;
 } & K6LoadZone;
+interface BaseBuilderContextValue {
+    ScriptEditorComponent?: (props: ScriptEditorProps) => ReactElement;
+    enableViewLinkHref?: boolean;
+    openImportModal?: () => Promise<Archive | null>;
+    openRecordModal?: () => void;
+    onViewChange?: (view: string) => void;
+    DocsLinkComponent?: ElementType<DocsLinkProps>;
+    k6Test?: TestBuilderTest;
+    readonlyScriptScenarios: boolean;
+    TestBuilderIconComponent: typeof TestBuilderIcon;
+}
+interface TestBuilderContextValue extends BaseBuilderContextValue {
+    StagesVirtualizationComponent?: (props: StagesVirtualizationComponentProps) => ReactElement;
+    availableLoadZones: LoadZoneDataItem[];
+    hasCloudExecution?: boolean;
+    apmConfigs?: APMConfig[];
+    hasCloudAPM?: boolean;
+    disableAPM?: boolean;
+}
 interface TestBuilderInternalContextProviderProps {
     children?: ReactNode;
 }
@@ -262,27 +457,36 @@ interface TestBuilderStandaloneProps {
     apmConfigs?: APMConfig[];
     hasCloudAPM?: boolean;
     disableAPM?: boolean;
+    openImportModal?: TestBuilderContextValue['openImportModal'];
+    openRecordModal?: TestBuilderContextValue['openRecordModal'];
 }
-export function TestBuilder({ loading, saving, k6Test, hasCloudExecution, availableLoadZones, DocsLinkComponent, onViewChange, StagesVirtualizationComponent, ScriptEditorComponent, TestBuilderIconComponent, readonlyScriptScenarios, apmConfigs, hasCloudAPM, disableAPM, }: TestBuilderStandaloneProps): JSX.Element;
-interface TestMetaInformationProps {
-    className?: string;
-}
-export const TestMetaInformation: FunctionComponent<TestMetaInformationProps>;
-interface StatusMessageProps {
-    text?: string | ReactNode;
-    level: TestBuilderStatus;
+export function TestBuilder({ loading, saving, k6Test, hasCloudExecution, availableLoadZones, DocsLinkComponent, onViewChange, StagesVirtualizationComponent, ScriptEditorComponent, TestBuilderIconComponent, readonlyScriptScenarios, apmConfigs, hasCloudAPM, openImportModal, openRecordModal, disableAPM, }: TestBuilderStandaloneProps): JSX.Element;
+interface Label {
+    name: string;
+    value: string;
 }
-export const StatusMessage: FunctionComponent<StatusMessageProps>;
-export const StatusBar: FunctionComponent<{
-    className?: string;
-}>;
-export function useTestBuilderName(): [string, (name: string) => void];
-interface MuiThemeProviderProps {
-    children: ReactNode;
-    inherit?: boolean;
-    theme?: ThemeOptions;
+interface Probe {
+    id: number;
+    tenantId: number;
+    commit: string;
+    buildstamp: string;
+    name: string;
+    created: number;
+    modified: number;
+    public: boolean;
+    latitude: number;
+    longitude: number;
+    region: string;
+    online: boolean;
+    onlineChange: number;
+    labels: Label[];
+    version: string;
+    deprecated: boolean;
 }
-export function TestBuilderThemeProvider({ children, theme: _theme }: MuiThemeProviderProps): JSX.Element;
+export type SyntheticsBuilderSubmit = (values: TestBuilderTest & {
+    script: string;
+}, errors: Error | InvalidArchiveError | undefined) => void;
+export function useGetUnsavedChanges(): [boolean, (value: boolean) => void];
 declare const grafanaThemeDark: {
     name: string;
     isDark: boolean;
@@ -1335,6 +1539,46 @@ declare const grafanaThemeLight: {
 };
 type GrafanaTheme = typeof grafanaThemeDark | typeof grafanaThemeLight;
 export const grafanaThemeToMuiTheme: (theme: GrafanaTheme) => ThemeOptions;
+interface SyntheticsBuilderStandaloneProps {
+    loading?: boolean;
+    saving: boolean;
+    onSubmit: (values: any, errors: any) => void;
+    k6Test?: TestBuilderTest;
+    availableProbes?: Probe[];
+    DocsLinkComponent?: ElementType<DocsLinkProps>;
+    onViewChange?: (view: string) => void;
+    ScriptEditorComponent?: (props: ScriptEditorProps) => ReactElement;
+    TestBuilderIconComponent?: typeof TestBuilderIcon;
+    readonlyScriptScenarios?: boolean;
+    theme: GrafanaTheme2;
+}
+export function SyntheticsBuilder({ loading, saving, k6Test, availableProbes, DocsLinkComponent, onViewChange, ScriptEditorComponent, TestBuilderIconComponent, readonlyScriptScenarios, theme, onSubmit, }: SyntheticsBuilderStandaloneProps): JSX.Element;
+interface TestMetaInformationProps {
+    className?: string;
+}
+export const TestMetaInformation: FunctionComponent<TestMetaInformationProps>;
+interface StatusMessageProps {
+    text?: string | ReactNode;
+    level: TestBuilderStatus;
+}
+export const StatusMessage: FunctionComponent<StatusMessageProps>;
+export const StatusBar: FunctionComponent<{
+    className?: string;
+}>;
+export function useTestBuilderName(): [string, (name: string) => void];
+interface MuiThemeProviderProps {
+    children: ReactNode;
+    inherit?: boolean;
+    theme?: ThemeOptions;
+}
+export function TestBuilderThemeProvider({ children, theme: _theme }: MuiThemeProviderProps): JSX.Element;
 type SetImportsHandler = (value: string[]) => void;
 export function useScriptImports(): [string[] | undefined, SetImportsHandler];
-export function useGetUnsavedChanges(): [boolean, (value: boolean) => void];
+interface ImportModalProps {
+    onChange: (files: File | null) => void;
+    errors?: string[];
+    content?: JSX.Element;
+    heading?: string;
+    lead?: string;
+}
+export const ImportModal: FunctionComponent<ImportModalProps>;