@fc-components/monaco-editor 0.1.16 → 0.1.17

package/dist/promql/completion/DataProvider.d.ts

@@ -9,6 +9,7 @@ export declare class DataProvider {
     private readonly errorHandler?;
     private readonly httpMethod;
     private readonly apiPrefix;
+    private enableRequests;
     private readonly customRequest;
     metrics: string[];
     labelKeys: string[];
@@ -23,8 +24,8 @@ export declare class DataProvider {
     fetchLabels: (selector: string) => Promise<string[]>;
     fetchLabelValues: (labelName: string, selector: string) => Promise<string[]>;
     getAllMetricNames(): string[];
-    start: () => Promise<void[]>;
-    loadMetricsMetadata(): Promise<void>;
+    start: () => Promise<PromMetricsMetadata[]>;
+    loadMetricsMetadata(): Promise<PromMetricsMetadata>;
     metricNamesToMetrics(metricNames: string[]): Metric[];
     private setInputInRange;
     private enableAutocompleteSuggestionsUpdate;

package/dist/promql/index.d.ts

@@ -8,6 +8,7 @@ interface PromQLEditorProps {
     placeholder?: string;
     enableAutocomplete?: boolean;
     durationVariablesCompletion?: boolean;
+    enableRequests?: boolean;
     readOnly?: boolean;
     disabled?: boolean;
     interpolateString?: (query: string) => string;

package/dist/promql/types.d.ts

@@ -27,5 +27,6 @@ export interface DataProviderParams {
     httpMethod?: 'POST' | 'GET';
     apiPrefix?: string;
     httpErrorHandler?: (error: any) => void;
+    enableRequests?: boolean;
 }
 export {};

package/package.json

@@ -3,7 +3,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "0.1.16",
+  "version": "0.1.17",
   "license": "MIT",
   "main": "dist/index.js",
   "module": "dist/monaco-editor.esm.js",

package/src/promql/completion/DataProvider.ts

@@ -26,6 +26,7 @@ export class DataProvider {
   private readonly errorHandler?: (error: any) => void;
   private readonly httpMethod: 'POST' | 'GET' = 'GET';
   private readonly apiPrefix: string = '/api/v1';
+  private enableRequests: boolean = true;
   private readonly customRequest: CustomRequest = (input: RequestInfo, init?: RequestInit): Promise<Response> => fetch(input, init);
   metrics: string[];
   labelKeys: string[];
@@ -56,6 +57,11 @@ export class DataProvider {
       this.apiPrefix = params.apiPrefix;
     }
 
+    // control whether DataProvider should actually send network requests
+    if (typeof params.enableRequests !== 'undefined') {
+      this.enableRequests = !!params.enableRequests;
+    }
+
     this.metrics = [];
     this.labelKeys = [];
   }
@@ -113,6 +119,9 @@ export class DataProvider {
   }
 
   fetchSeries = async (selector: string, withLimit?: string): Promise<Record<string, string | undefined>[]> => {
+    if (!this.enableRequests) {
+      return [] as Record<string, string | undefined>[];
+    }
     const end = new Date();
     const start = new Date(end.getTime() - this.lookbackInterval);
     const url = `${this.apiPrefix}/series`;
@@ -138,6 +147,9 @@ export class DataProvider {
   };
 
   fetchLabels = async (selector: string): Promise<string[]> => {
+    if (!this.enableRequests) {
+      return [] as string[];
+    }
     const end = new Date();
     const start = new Date(end.getTime() - this.lookbackInterval);
     const url = `${this.apiPrefix}/labels`;
@@ -164,6 +176,9 @@ export class DataProvider {
   };
 
   fetchLabelValues = async (labelName: string, selector: string): Promise<string[]> => {
+    if (!this.enableRequests) {
+      return [] as string[];
+    }
     const end = new Date();
     const start = new Date(end.getTime() - this.lookbackInterval);
     const url = `${this.apiPrefix}/label/${labelName}/values`;
@@ -198,7 +213,11 @@ export class DataProvider {
     ]);
   };
 
-  async loadMetricsMetadata() {
+  async loadMetricsMetadata(): Promise<PromMetricsMetadata> {
+    if (!this.enableRequests) {
+      this.metricsMetadata = {} as PromMetricsMetadata;
+      return this.metricsMetadata;
+    }
     const request = this.buildRequest(`${this.apiPrefix}/metadata`, new URLSearchParams({}));
     this.metricsMetadata = await this.request<PromMetricsMetadata>(request.uri, {
       method: this.httpMethod,
@@ -206,6 +225,8 @@ export class DataProvider {
     }).catch(() => {
       return {} as PromMetricsMetadata;
     });
+
+    return this.metricsMetadata || ({} as PromMetricsMetadata);
   }
 
   metricNamesToMetrics(metricNames: string[]): Metric[] {

package/src/promql/index.tsx

@@ -20,6 +20,8 @@ interface PromQLEditorProps {
   placeholder?: string;
   enableAutocomplete?: boolean;
   durationVariablesCompletion?: boolean;
+  // When false, DataProvider will not send network requests. Default: true
+  enableRequests?: boolean;
   readOnly?: boolean;
   disabled?: boolean;
   interpolateString?: (query: string) => string;
@@ -92,6 +94,7 @@ export default function PromQLEditor(props: PromQLEditorProps & DataProviderPara
     placeholder,
     interpolateString,
     enableAutocomplete = true,
+    enableRequests = true,
     readOnly = false,
     disabled = false,
     onChange,
@@ -266,6 +269,7 @@ export default function PromQLEditor(props: PromQLEditorProps & DataProviderPara
         httpMethod: props.httpMethod,
         apiPrefix: props.apiPrefix,
         httpErrorHandler: props.httpErrorHandler,
+        enableRequests: enableRequests,
       });
       dataProviderRef.current = dataProvider;
       dataProvider.start();
@@ -331,6 +335,7 @@ export default function PromQLEditor(props: PromQLEditorProps & DataProviderPara
     props.httpMethod,
     props.apiPrefix,
     placeholder,
+    enableRequests,
   ]);
 
   return (

package/src/promql/types.ts

@@ -33,4 +33,6 @@ export interface DataProviderParams {
   httpMethod?: 'POST' | 'GET';
   apiPrefix?: string;
   httpErrorHandler?: (error: any) => void;
+  // When false, DataProvider will not send any network requests.
+  enableRequests?: boolean;
 }