@api-client/core 0.7.6 → 0.7.9

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@api-client/core",
   "description": "The API Client's core client library. Works in NodeJS and in a ES enabled browser.",
-  "version": "0.7.6",
+  "version": "0.7.9",
   "license": "Apache-2.0",
   "main": "build/index.js",
   "module": "build/index.js",

package/src/cookies/CookieParser.ts

@@ -71,19 +71,20 @@ export class CookieParser {
 
   /**
    * Parses the `set-cookie` header value and creates a list of cookies.
-   * The cookie configuration must match the `url`. This means that if the cookie has a `host` property
-   * this must match the request URL (browsers do not allow setting cookies from one domain for another).
    * 
-   * When `host` or `path` part is missing from the cookie, the URL values are used.
+   * Notes:
+   * - This does not check whether the cookie should be stored in the Cookie Jar based on the request URL, use `parse()` instead
+   * - This will fill up cookies' `domain` and `path` when `requestUrl` is provided. Otherwise it will leave these fields empty which makes the cookie invalid. Use `parse()` instead
    * 
-   * @param requestUrl The HTTP request URL. Cookies must match this URL or will be ignored.
    * @param setCookie The value of the `set-cookie` string.
+   * @param requestUrl The HTTP request URL.
    */
-  static parse(requestUrl: string, setCookie?: string): HttpCookie[] {
+  static parseRelaxed(setCookie?: string, requestUrl?: string): HttpCookie[] {
     const result: HttpCookie[] = [];
     if (!setCookie || typeof setCookie !== 'string') {
       return result;
     }
+
     const blocks = setCookie.split(';').map(i => i.trim());
     blocks.forEach((part, index) => {
       // Consider the following set-cookie string:
@@ -153,28 +154,41 @@ export class CookieParser {
       }
     });
 
-    // At this point we have all cookies set by the server. Now we need to filter out cookies 
-    // set for a different domains.
-
-    // first lets set cookie domain and path.
-    const url = new URL(requestUrl);
-    const domain = this.canonicalDomain(url.host);
-    const path = this.getPath(url);
+    if (requestUrl) {
+      const url = new URL(requestUrl);
+      const domain = this.canonicalDomain(url.host);
+      const path = this.getPath(url);
+  
+      result.forEach((cookie) => {
+        if (!cookie.path) {
+          cookie.path = path;
+        }
+        if (!cookie.domain) {
+          // point 6. of https://tools.ietf.org/html/rfc6265#section-5.3
+          cookie.domain = domain;
+          cookie.hostOnly = true;
+        } else if (cookie.domain[0] !== '.') {
+          // https://stackoverflow.com/a/1063760/1127848
+          cookie.domain = `.${cookie.domain}`;
+        }
+      });
+    }
+    return result;
+  }
 
-    result.forEach((cookie) => {
-      if (!cookie.path) {
-        cookie.path = path;
-      }
-      if (!cookie.domain) {
-        // point 6. of https://tools.ietf.org/html/rfc6265#section-5.3
-        cookie.domain = domain;
-        cookie.hostOnly = true;
-      } else if (cookie.domain[0] !== '.') {
-        // https://stackoverflow.com/a/1063760/1127848
-        cookie.domain = `.${cookie.domain}`;
-      }
-    });
-    return this.filterCookies(result, requestUrl);
+  /**
+   * Parses the `set-cookie` header value and creates a list of cookies.
+   * The cookie configuration must match the `url`. This means that if the cookie has a `host` property
+   * this must match the request URL (browsers do not allow setting cookies from one domain for another).
+   * 
+   * When `host` or `path` part is missing from the cookie, the URL values are used.
+   * 
+   * @param requestUrl The HTTP request URL. Cookies must match this URL or will be ignored.
+   * @param setCookie The value of the `set-cookie` string.
+   */
+  static parse(requestUrl: string, setCookie?: string): HttpCookie[] {
+    const cookies = this.parseRelaxed(setCookie, requestUrl);
+    return this.filterCookies(cookies, requestUrl);
   }
 
   /**

package/src/events/BaseEvents.ts

@@ -319,6 +319,10 @@ export interface ContextListOptions {
    * A string that should be used with the pagination.
    */
   nextPageToken?: string;
+  /**
+   * Optional parent for the query.
+   */
+  parent?: string;
 }
 
 export class ContextListEvent<T> extends ContextEvent<ContextListOptions, ContextListResult<T>> {

package/src/events/transport/TransportEventTypes.ts

@@ -3,9 +3,11 @@ export const TransportEventTypes = Object.freeze({
    * Transport via the CoreEngine.
    */
   Core: Object.freeze({
-    // sends a request
-    send: 'coretransportsend',
+    request: 'transportcorerequest',
+    httpProject: 'transportcorehttpproject',
+    appProject: 'transportcoreappproject',
   }),
+  
   /** 
    * Transport via the native platform's bindings.
    */
@@ -13,12 +15,6 @@ export const TransportEventTypes = Object.freeze({
     send: 'httptransportsend',
   }),
 
-  // project runner
-  Project: Object.freeze({
-    // for both a request or a folder (since it's all single configuration.)
-    send: 'transportprojectsend',
-  }),
-
   // web sockets.
   Ws: Object.freeze({
     /** 

package/src/events/transport/TransportEvents.ts

@@ -5,6 +5,7 @@ import { IHttpRequest } from "../../models/HttpRequest.js";
 import { IRequestBaseConfig } from "../../models/RequestConfig.js";
 import { IRequestLog } from '../../models/RequestLog.js';
 import { HttpProject } from "../../models/HttpProject.js";
+import { AppProject } from "../../models/AppProject.js";
 import { ContextEvent } from "../BaseEvents.js";
 import { TransportEventTypes } from "./TransportEventTypes.js";
 import { IProjectRunnerOptions } from "../../runtime/node/InteropInterfaces.js";
@@ -21,11 +22,25 @@ export interface IHttpRequestDetail {
   init?: RequestInit;
 }
 
-export interface IProjectRequestDetail {
+export interface IHttpRequestResult {
+  log: IRequestLog;
+  /**
+   * The variables evaluated during the run. 
+   * These variables have values set by request HTTP flows.
+   */
+  variables: Record<string, string>;
+}
+
+export interface IHttpProjectRequestDetail {
   project: HttpProject | string; 
   opts: IProjectRunnerOptions;
 }
 
+export interface IAppProjectRequestDetail {
+  project: AppProject | string; 
+  opts: IProjectRunnerOptions;
+}
+
 /* eslint-disable no-unused-vars */
 export const TransportEvent = Object.freeze({
   /** 
@@ -39,10 +54,10 @@ export const TransportEvent = Object.freeze({
      * @param request The request definition
      * @param authorization When known, a list of authorization configuration to apply to the request.
      * @param config Optional request configuration.
-     * @returns The execution log or `undefined` when the event was not handled.
+     * @returns The execution log with the variables evaluated during the run or `undefined` when the event was not handled.
      */
-    send: async (request: IHttpRequest, authorization?: IRequestAuthorization[], config?: IRequestBaseConfig, target: EventTarget = window): Promise<IRequestLog | undefined> => {
-      const e = new ContextEvent<ICoreRequestDetail, IRequestLog>(TransportEventTypes.Core.send, {
+    request: async (request: IHttpRequest, authorization?: IRequestAuthorization[], config?: IRequestBaseConfig, target: EventTarget = window): Promise<IHttpRequestResult | undefined> => {
+      const e = new ContextEvent<ICoreRequestDetail, IHttpRequestResult>(TransportEventTypes.Core.request, {
         request,
         authorization,
         config
@@ -50,6 +65,38 @@ export const TransportEvent = Object.freeze({
       target.dispatchEvent(e);
       return e.detail.result;
     },
+
+    /**
+     * For both the project or a folder (since it's all single configuration.)
+     * 
+     * @param target The events target
+     * @param project The instance of a project or an id of the project to execute. The current user has to be already authenticated.
+     * @param opts The project execution options.
+     */
+    httpProject: async (project: HttpProject | string, opts: IProjectRunnerOptions, target: EventTarget = window): Promise<IProjectExecutionLog | undefined> => {
+      const e = new ContextEvent<IHttpProjectRequestDetail, IProjectExecutionLog>(TransportEventTypes.Core.httpProject, {
+        project,
+        opts,
+      });
+      target.dispatchEvent(e);
+      return e.detail.result;
+    },
+
+    /**
+     * For both the project or a folder (since it's all single configuration.)
+     * 
+     * @param target The events target
+     * @param project The instance of a project or an id of the project to execute. The current user has to be already authenticated.
+     * @param opts The project execution options.
+     */
+    appProject: async (project: AppProject | string, opts: IProjectRunnerOptions, target: EventTarget = window): Promise<IProjectExecutionLog | undefined> => {
+      const e = new ContextEvent<IAppProjectRequestDetail, IProjectExecutionLog>(TransportEventTypes.Core.appProject, {
+        project,
+        opts,
+      });
+      target.dispatchEvent(e);
+      return e.detail.result;
+    },
   }),
   /** 
    * Transport via the native platform's bindings.
@@ -74,26 +121,6 @@ export const TransportEvent = Object.freeze({
     },
   }),
 
-  // project runner
-  Project: Object.freeze({
-    /**
-     * For both a request or a folder (since it's all single configuration.)
-     * 
-     * @param target The events target
-     * @param project The instance of a project or an id of the project to execute. The current user has to be already authenticated.
-     * @param opts The project execution options.
-     * @returns 
-     */
-    send: async (project: HttpProject | string, opts: IProjectRunnerOptions, target: EventTarget = window): Promise<IProjectExecutionLog | undefined> => {
-      const e = new ContextEvent<IProjectRequestDetail, IProjectExecutionLog>(TransportEventTypes.Project.send, {
-        project,
-        opts,
-      });
-      target.dispatchEvent(e);
-      return e.detail.result;
-    },
-  }),
-
   // web sockets.
   Ws: Object.freeze({
     /** 

package/src/lib/transformers/PayloadSerializer.ts

@@ -154,6 +154,7 @@ export class PayloadSerializer {
         const result = await PayloadSerializer.stringifyFormData(payload);
         return result;
       } catch (e: unknown) {
+        // eslint-disable-next-line no-console
         console.warn(`Unable to transform FormData: ${(e as Error).message}`);
       }
     }

package/src/models/AppProject.ts

@@ -983,6 +983,13 @@ export class AppProjectFolder extends AppProjectParent {
   listEnvironments(): Environment[] {
     return this.project.listEnvironments({ parent: this.key });
   }
+
+  /**
+   * @returns The list of environments defined in this folder
+   */
+  getEnvironments(): Environment[] {
+    return this.project.getEnvironments({ parent: this.key });
+  }
 }
 
 /**
@@ -1879,6 +1886,15 @@ export class AppProject extends AppProjectParent {
     return env;
   }
 
+  /**
+   * This method is a link to `listEnvironments()` to be compatible with the HttpProject.
+   * 
+   * @returns The list of environments defined in this folder
+   */
+  getEnvironments(opts?: IAppProjectItemOptions): Environment[] {
+    return this.listEnvironments(opts);
+  }
+
   /**
    * This is a link to the `getEnvironments()`. The difference is that on the 
    * project level it won't return environments defined with the class initialization.

package/src/models/HttpResponse.ts

@@ -72,7 +72,7 @@ export class HttpResponse extends SerializablePayload {
   /**
    * @param input The response definition used to restore the state.
    */
-  constructor(input?: string|IHttpResponse) {
+  constructor(input?: string | IHttpResponse) {
     super();
     let init: IHttpResponse;
     if (typeof input === 'string') {
@@ -97,7 +97,7 @@ export class HttpResponse extends SerializablePayload {
     if (!HttpResponse.isHttpResponse(init)) {
       throw new Error(`Not a response.`);
     }
-    const { status, statusText, headers, payload, kind=Kind } = init;
+    const { status, statusText, headers, payload, kind = Kind } = init;
     this.kind = kind;
     this.status = status;
     this.statusText = statusText;

package/src/models/ProjectRequest.ts

@@ -70,7 +70,7 @@ export class ProjectRequest extends Request implements ProjectDefinitionProperty
     if (!project) {
       throw new Error(`The project is required.`);
     }
-    const now:number = Date.now();
+    const now: number = Date.now();
     const request = new ProjectRequest(project, {
       key: v4(),
       kind: Kind,
@@ -100,7 +100,7 @@ export class ProjectRequest extends Request implements ProjectDefinitionProperty
     if (!project) {
       throw new Error(`The project is required.`);
     }
-    const now:number = Date.now();
+    const now: number = Date.now();
     const request = new ProjectRequest(project, {
       key: v4(),
       kind: Kind,
@@ -130,7 +130,7 @@ export class ProjectRequest extends Request implements ProjectDefinitionProperty
     if (!project) {
       throw new Error(`The project is required.`);
     }
-    const now:number = Date.now();
+    const now: number = Date.now();
     const request = new ProjectRequest(project, {
       key: v4(),
       kind: Kind,
@@ -160,8 +160,8 @@ export class ProjectRequest extends Request implements ProjectDefinitionProperty
     const result = new ProjectRequest(project, init);
     return result;
   }
-  
-  constructor(project: HttpProject, input?: string|IProjectRequest | IAppProjectRequest) {
+
+  constructor(project: HttpProject, input?: string | IProjectRequest | IAppProjectRequest) {
     super(input);
     this.project = project;
     let init: IProjectRequest | IAppProjectRequest;
@@ -170,7 +170,7 @@ export class ProjectRequest extends Request implements ProjectDefinitionProperty
     } else if (typeof input === 'object') {
       init = input;
     } else {
-      const now:number = Date.now();
+      const now: number = Date.now();
       init = {
         key: v4(),
         kind: Kind,
@@ -192,7 +192,7 @@ export class ProjectRequest extends Request implements ProjectDefinitionProperty
 
   new(init: IProjectRequest | IAppProjectRequest): void {
     super.new(init);
-    
+
     const { key } = init;
     this.key = key || v4();
   }
@@ -224,7 +224,7 @@ export class ProjectRequest extends Request implements ProjectDefinitionProperty
   /**
    * @returns The instance of the HttpProject or a ProjectFolder that is a closes parent of this instance.
    */
-  getParent(): ProjectFolder|HttpProject|undefined {
+  getParent(): ProjectFolder | HttpProject | undefined {
     const { project, key } = this;
     return project.findParent(key);
   }

package/src/models/Request.ts

@@ -117,7 +117,7 @@ export class Request {
    * @param url The Request URL.
    */
   static fromUrl(url: string): Request {
-    const now:number = Date.now();
+    const now: number = Date.now();
     const request = new Request({
       kind: Kind,
       created: now,
@@ -141,7 +141,7 @@ export class Request {
    * @param name The Request name.
    */
   static fromName(name: string): Request {
-    const now:number = Date.now();
+    const now: number = Date.now();
     const request = new Request({
       kind: Kind,
       created: now,
@@ -165,7 +165,7 @@ export class Request {
    * @param info The request data.
    */
   static fromHttpRequest(info: IHttpRequest): Request {
-    const now:number = Date.now();
+    const now: number = Date.now();
     const request = new Request({
       kind: Kind,
       created: now,
@@ -185,12 +185,12 @@ export class Request {
     return request;
   }
 
-  static async fromLegacy(request: ARCSavedRequest|ARCHistoryRequest): Promise<Request> {
+  static async fromLegacy(request: ARCSavedRequest | ARCHistoryRequest): Promise<Request> {
     const normalized = Normalizer.normalizeRequest(request) as ARCSavedRequest;
     if (!normalized) {
       throw new Error(`Unknown object.`);
     }
-    const init:IRequest = {
+    const init: IRequest = {
       kind: Kind,
       expects: {
         kind: HttpRequestKind,
@@ -312,14 +312,14 @@ export class Request {
     return this.defaultMidnight();
   }
 
-  constructor(input?: string|IRequest) {
+  constructor(input?: string | IRequest) {
     let init: IRequest;
     if (typeof input === 'string') {
       init = JSON.parse(input);
     } else if (typeof input === 'object') {
       init = input;
     } else {
-      const now:number = Date.now();
+      const now: number = Date.now();
       init = {
         kind: Kind,
         created: now,

package/src/models/legacy/DataExport.ts

@@ -122,6 +122,24 @@ export interface EncryptionOptions {
   passphrase?: string;
 }
 
+export interface ProviderOptions {
+  /**
+   * Export file name or path to render in the save dialog or file name
+   * in the cloud provider.
+   */
+  file: string;
+
+  /**
+   * The folder where to put the file.
+   */
+  parent?: string;
+
+  /**
+   * Content's mime type
+   */
+  contentType?: string;
+}
+
 /**
  * @deprecated
  */
@@ -154,15 +172,25 @@ export interface ExportOptionsInternal extends ExportOptions {
   appVersion: string;
 }
 
+/**
+ * @deprecated
+ */
 export interface ArcExportProcessedData {
   key: keyof ArcNativeDataExport;
   data: any[];
 }
+
+/**
+ * @deprecated
+ */
 export interface ArcExportClientCertificateData {
   item: ARCCertificateIndex;
   data: ARCRequestCertificate;
 }
 
+/**
+ * @deprecated
+ */
 export interface ArcNativeDataExport {
   authdata?: boolean | ARCAuthData[];
   clientcertificates?: boolean;
@@ -175,3 +203,52 @@ export interface ArcNativeDataExport {
   websocketurlhistory?: boolean | ARCWebsocketUrlHistory[];
   urlhistory?: boolean | ARCUrlHistory[];
 }
+
+/**
+ * @deprecated
+ */
+export declare const ExportKey: keyof ArcNativeDataExport;
+
+/**
+ * @deprecated
+ */
+export interface ArcLegacyNativeDataExport extends ArcNativeDataExport {
+  'websocket-url-history': boolean | ARCWebsocketUrlHistory[];
+  'auth-data': boolean | ARCAuthData[];
+  'url-history': boolean | ARCUrlHistory[];
+  'host-rules': boolean | ARCHostRule[];
+  'client-certificates': boolean | ARCVariable[];
+}
+
+/**
+ * @deprecated
+ */
+export interface ArcExportResult {
+  /**
+   * Whether an export operation was a success
+   */
+  success: boolean;
+  /**
+   * Whether the operation was interrupted by the user.
+   */
+  interrupted: boolean;
+  /**
+   * With the cloud based export this is the ID of parent folder.
+   * For file export it is the path of the file.
+   */
+  parentId: string;
+  /**
+   * The generated file id.
+   * With the cloud based export this is the ID of created file entry.
+   * For file export it is the file name that the user provided in the save dialog.
+   */
+  fileId: string;
+}
+
+/**
+ * Options interface for file import
+ * @deprecated
+ */
+export interface FileImportOptions {
+  driveId?: string;
+}

package/src/models/legacy/Normalizer.ts

@@ -82,7 +82,7 @@ export class Normalizer {
   }
 
   /**
-   * Transforms the `TransformedPayload` object to its original data type.
+   * Transforms the legacy `TransformedPayload` object to its original data type.
    */
   static restoreTransformedPayload(body: string | ArrayBuffer | Buffer | LegacyTransformedPayload): string | Buffer | ArrayBuffer | undefined {
     if (!body) {

package/src/runtime/node/InteropInterfaces.ts

@@ -4,6 +4,7 @@ import { Environment } from '../../models/Environment.js';
 import { Logger } from '../../lib/logging/Logger.js';
 import { IRequestLog } from '../../models/RequestLog.js';
 import { CookieJar } from '../../cookies/CookieJar.js';
+import { IAppProject } from 'browser.js';
 
 export interface IRequestRunnerOptions {
   /**
@@ -71,7 +72,7 @@ export interface IProjectParallelRunnerOptions extends IProjectRunnerOptions {
 }
 
 export interface IProjectParallelWorkerOptions extends IProjectRunnerOptions {
-  project: IHttpProject;
+  project: IHttpProject | IAppProject;
 }
 
 export interface IProjectRunnerOptions {

package/src/runtime/node/ProjectParallelRunner.ts

@@ -3,6 +3,7 @@ import { cpus } from 'os';
 import { dirname, join } from 'path';
 import { fileURLToPath } from 'url';
 import { HttpProject } from '../../models/HttpProject.js';
+import { AppProject } from '../../models/AppProject.js';
 import { IProjectExecutionLog, IProjectExecutionIteration } from '../reporters/Reporter.js';
 import { BaseRunner } from './BaseRunner.js';
 import { State } from './enums.js';
@@ -66,13 +67,13 @@ export interface ProjectParallelRunner {
  * change. This event can be user to refresh the UI to reflect the newest state.
  */
 export class ProjectParallelRunner extends BaseRunner {
-  project: HttpProject;
+  project: HttpProject | AppProject;
   options: IProjectParallelRunnerOptions;
   workers: WorkerInfoInternal[] = [];
   private mainResolver?: (report: IProjectExecutionLog) => void;
   private mainRejecter?: (err: Error) => void;
 
-  constructor(project: HttpProject, opts: IProjectParallelRunnerOptions = {}) {
+  constructor(project: HttpProject | AppProject, opts: IProjectParallelRunnerOptions = {}) {
     super();
     this.project = project;
     this.options = opts;

package/src/runtime/node/ProjectRunner.ts

@@ -11,9 +11,9 @@ import { pathExists, readJson } from '../../lib/fs/Fs.js';
 import { BaseRunner } from './BaseRunner.js';
 import { IProjectRunnerOptions, IRequestRunnerOptions } from './InteropInterfaces.js';
 import { State } from './enums.js';
-import { AppProject } from '../../models/AppProject.js';
+import { AppProject, AppProjectFolder } from '../../models/AppProject.js';
 
-type ProjectParent = HttpProject | ProjectFolder;
+type ProjectParent = HttpProject | ProjectFolder | AppProject | AppProjectFolder;
 
 export interface ProjectRunner {
   /**
@@ -173,7 +173,7 @@ export abstract class ProjectRunner extends BaseRunner {
    * A required step before running the project.
    * It configures the execution context. It may throw an error when configuration is not valid.
    */
-  async configure(project: HttpProject, opts: IProjectRunnerOptions = {}): Promise<void> {
+  async configure(project: HttpProject | AppProject, opts: IProjectRunnerOptions = {}): Promise<void> {
     this.project = project;
     this.options = opts || {};
     if (typeof this.options.iterations === 'number' && this.options.iterations >= 0) {

package/src/runtime/node/ProjectRunnerWorker.ts

@@ -2,7 +2,8 @@
 /* eslint-disable no-unused-vars */
 import process from 'process';
 import cluster from 'cluster';
-import { HttpProject } from '../../models/HttpProject.js';
+import { HttpProject, Kind as HttpProjectKind } from '../../models/HttpProject.js';
+import { AppProject, AppProjectKind } from '../../models/AppProject.js';
 import { IProjectExecutionLog } from '../reporters/Reporter.js';
 import { IWorkerMessage } from './ProjectParallelRunner.js';
 import { IProjectParallelWorkerOptions } from './InteropInterfaces.js';
@@ -16,7 +17,9 @@ class ProjectExeWorker extends ProjectRunner {
     if (cluster.isPrimary) {
       throw new Error(`This file should not be called directly.`);
     }
-    process.send!({ cmd: 'online' });
+    if (process.send) {
+      process.send({ cmd: 'online' });
+    }
     process.on('message', this.messageHandler.bind(this));
   }
 
@@ -29,11 +32,22 @@ class ProjectExeWorker extends ProjectRunner {
   async run(options: IProjectParallelWorkerOptions): Promise<void> {
     options.cookies = new InMemoryCookieJar();
     try {
-      await this.configure(new HttpProject(options.project), options);
+      const schema = options.project;
+      let project: HttpProject | AppProject;
+      if (schema.kind === HttpProjectKind) {
+        project = new HttpProject(schema);
+      } else if (schema.kind === AppProjectKind) {
+        project = new AppProject(schema);
+      } else {
+        throw new Error(`Unknown project kind: ${schema.kind}`);
+      }
+      await this.configure(project, options);
       await this.execute();
     } catch (e) {
       const cause = e as Error;
-      process.send!({ cmd: 'error', data: cause.message });
+      if (process.send) {
+        process.send({ cmd: 'error', data: cause.message });
+      }
     }
   }
 
@@ -58,7 +72,9 @@ class ProjectExeWorker extends ProjectRunner {
     this.endTime = Date.now();
 
     const log = await this.createReport();
-    process.send!({ cmd: 'result', data: log.iterations });
+    if (process.send) {
+      process.send({ cmd: 'result', data: log.iterations });
+    }
     this._state = State.Idle as State;
     return log;
   }