feat: update Intellij d.ts Stubs and add Window.btoa/atob (#839)

Author: AnWeber

CHANGELOG.md

@@ -2,6 +2,7 @@
 
 ### Features
 - logger supports call to parent logger (AnWeber/vscode-httpyac#347)
+- update Intellij d.ts Stubs and add Window.btoa/atob (#839)
 
 ### Fix
 - ensure correct order if cli args are used (#773)

src/plugins/intellij/api/index.ts

@@ -4,4 +4,5 @@ export * from './intellijHttpRequest';
 export * from './intellijHttpResponse';
 export * from './intellijRandom';
 export * from './intellijVariables';
+export * from './intellijWindow';
 export * from './stubs';

src/plugins/intellij/api/intellijWindow.ts

@@ -0,0 +1,11 @@
+import { CommonWindow } from './stubs';
+
+export class IntellijWindow implements CommonWindow {
+  btoa(bytes: string): string {
+    return global.btoa(bytes);
+  }
+
+  atob(bytes: string): string {
+    return global.atob(bytes);
+  }
+}

src/plugins/intellij/api/stubs/http-client.common.ts

@@ -36,12 +36,12 @@ export interface Variables {
   /**
    * Saves variable with name 'varName' and sets its value to 'varValue'.
    */
-  set(varName: string, varValue: string): void;
+  set(varName: string, varValue: unknown): void;
 
   /**
    * Returns value of variable 'varName'.
    */
-  get(varName: string): string;
+  get(varName: string): unknown;
 
   /**
    * Checks no variables are defined.
@@ -84,6 +84,11 @@ export interface CommonHttpClientRequest {
    * Method of the current request
    */
   method: string;
+
+  // currently not supported
+  // iteration(): number;
+  // currently not supported
+  // templateValue(expressionNumber: number): string | boolean | number;
 }
 
 /**
@@ -117,12 +122,12 @@ export interface RequestEnvironment {
 /**
  * Variables for constructing current request. Can be updated in Pre-request handler script.
  */
-export interface RequestVariables {
+interface RequestVariables {
   /**
    * Retrieves request variable value by its name. Returns null if there is no such variable
    * @param name request variable name
    */
-  get(name: string): string | null;
+  get(name: string): unknown;
 }
 
 /**
@@ -134,6 +139,7 @@ export interface CommonRequestHeader {
    */
   name: string;
 }
+
 /**
  * Retrieves a value from a JSON object using a JSONPath expression.
  *
@@ -142,3 +148,19 @@ export interface CommonRequestHeader {
  * @return {any} - The value found in the JSON object using the JSONPath expression.
  */
 export type jsonPath = (obj: unknown, expression: string) => unknown;
+
+/**
+ * Retrieves a value from a XML object using a XPath expression.
+ *
+ * @param {any} obj - The obj to search in with XPath expression:
+ *                    - if obj is Node, Element or  Document returns result of search with expression.
+ *                    - null in all other cases.
+ * @param {string} expression - The XPath expression to use for searching.
+ * @return {any} - The value found in the XML object using the XPath expression.
+ */
+export type xpath = (obj: unknown, expression: string) => unknown;
+
+export interface CommonWindow {
+  atob(str: string): string;
+  btoa(bytes: string): string;
+}

src/plugins/intellij/api/stubs/http-client.pre-request.ts

@@ -18,12 +18,12 @@ export interface PreRequestRequestVariables {
   /**
    * Saves variable with name 'varName' and sets its value to 'varValue'.
    */
-  set(varName: string, varValue: string): void;
+  set(varName: string, varValue: unknown): void;
 
   /**
    * Returns value of variable 'varName'.
    */
-  get(varName: string): string | undefined;
+  get(varName: string): unknown;
 
   /**
    * Checks no variables are defined.

src/plugins/intellij/api/stubs/http-client.ts

@@ -5,7 +5,7 @@
 
 import { CommonHttpClient, CommonHttpClientRequest, CommonRequestHeader } from './http-client.common';
 import { PreRequestRequestHeader } from './http-client.pre-request';
-
+import { Document } from '@xmldom/xmldom';
 // declare const request: HttpClientFinalRequest;
 
 export interface HttpClient extends CommonHttpClient {
@@ -34,7 +34,10 @@ export interface TextStreamResponse {
    * @param subscriber function to be called on each line of the stream
    * @param onFinish function to be called after the end of the stream
    */
-  onEachLine(subscriber: (line: string | object, unsubscribe: () => void) => void, onFinish?: () => void): void;
+  onEachLine(
+    subscriber: (line: string | Document | object, unsubscribe: () => void) => void,
+    onFinish?: () => void
+  ): void;
 
   /**
    * Subscribes user to each message sent by server. This method should be used with well-defined streaming protocols,
@@ -44,7 +47,11 @@ export interface TextStreamResponse {
    * @param onFinish function to be called after the end of the stream
    */
   onEachMessage(
-    subscriber: (message: string | object, unsubscribe: () => void, output?: (answer: string) => void) => void,
+    subscriber: (
+      message: string | Document | object,
+      unsubscribe: () => void,
+      output?: (answer: string) => void
+    ) => void,
     onFinish?: () => void
   ): void;
 }
@@ -56,7 +63,7 @@ export interface HttpResponse {
   /**
    * Response content, it is a string or JSON object if response content-type is json.
    */
-  body: string | TextStreamResponse | unknown;
+  body: string | TextStreamResponse | Document | object;
 
   /**
    * Response headers storage.

src/plugins/intellij/api/stubs/http-declare.ts

@@ -1,5 +1,5 @@
 import { HttpClient, HttpClientRequest, HttpResponse } from './http-client';
-import { jsonPath } from './http-client.common';
+import { CommonWindow, jsonPath, xpath } from './http-client.common';
 import { CryptoSupport } from './http-client.crypto';
 import { PreRequestHttpClientRequest } from './http-client.pre-request';
 
@@ -8,6 +8,8 @@ export interface IntellijJavascriptGlobal extends Record<string, unknown> {
   client: HttpClient;
   crypto: CryptoSupport;
   jsonPath?: jsonPath; // not implemented
+  xpath?: xpath; // not implemented
+  Window: CommonWindow;
   $exampleServer?: string; // not implemented
   /**
    * The object holds information about HTTP Response.

src/plugins/intellij/intellijAction.ts

@@ -111,6 +111,8 @@ function initIntellijVariables(context: models.ProcessorContext): intellij.Intel
     crypto: new intellij.IntellijCryptoSupport(),
     $random: new intellij.IntellijRandom(),
     $env: process.env,
+    Window: new intellij.IntellijWindow(),
+    xpath:
   };
   if (context.request) {
     if (context.httpRegion.response) {