@api-client/core 0.5.19 → 0.5.22

package/src/models/Request.ts

@@ -1,7 +1,7 @@
 import { IRequestConfig, RequestConfig } from './RequestConfig.js';
 import { Thing, IThing, Kind as ThingKind } from './Thing.js';
 import { IRequestActions, RequestActions } from './RequestActions.js';
-import { IRequestCertificate } from './ClientCertificate.js';
+import { HttpCertificate, Certificate } from './ClientCertificate.js';
 import { IRequestAuthorization, RequestAuthorization } from './RequestAuthorization.js';
 import { IRequestLog, RequestLog, Kind as LogKind } from './RequestLog.js';
 import { SentRequest } from './SentRequest.js';
@@ -64,7 +64,7 @@ export interface IRequest {
   /**
    * The list of certificates to use with the request.
    */
-  clientCertificate?: IRequestCertificate;
+  clientCertificate?: HttpCertificate;
 }
 
 export class Request {
@@ -99,7 +99,7 @@ export class Request {
   /**
    * The list of certificates to use with the request.
    */
-  clientCertificate?: IRequestCertificate;
+  clientCertificate?: Certificate;
 
   /**
    * Creates a request from an URL.
@@ -373,7 +373,7 @@ export class Request {
       this.actions = undefined;
     }
     if (clientCertificate) {
-      this.clientCertificate = clientCertificate;
+      this.clientCertificate = new Certificate(clientCertificate);
     } else {
       this.clientCertificate = undefined;
     }
@@ -401,7 +401,7 @@ export class Request {
       result.actions = this.actions.toJSON();
     }
     if (this.clientCertificate) {
-      result.clientCertificate = { ...this.clientCertificate };
+      result.clientCertificate = this.clientCertificate.toJSON();
     }
     return result;
   }

package/src/models/RequestAuthorization.ts

@@ -58,9 +58,13 @@ export class RequestAuthorization {
   }
 
   static fromLegacy(info: LegacyAuthorization): RequestAuthorization {
+    const copy = { ...info };
+    if (copy.type === 'client certificate') {
+      copy.config = {};
+    }
     return new RequestAuthorization({
       kind: Kind,
-      config: info.config,
+      config: (info.config as any),
       enabled: true,
       type: info.type as AuthorizationType,
       valid: info.valid,

package/src/runtime/http-engine/CoreEngine.ts

@@ -728,12 +728,15 @@ export class CoreEngine extends HttpEngine {
       return;
     }
     if (data.length === 0) {
+      if (this.currentResponse?.status === 204) {
+        this._reportResponse();
+        return;
+      }
       if (this.currentHeaders.has('Content-Length')) {
         // If the server do not close the connection and clearly indicate that
         // there are no further data to receive the app can close the connection
         // and prepare the response.
         const length = Number(this.currentHeaders.get('Content-Length'));
-        // NaN never equals NaN. This is faster.
         if (!Number.isNaN(length) && length === 0) {
           this._reportResponse();
           return;

package/src/runtime/http-engine/HttpEngine.ts

@@ -10,7 +10,7 @@ import { IHttpRequest, HttpRequest } from '../../models/HttpRequest.js';
 import { IRequestBaseConfig } from '../../models/RequestConfig.js';
 import { IRequestAuthorization } from '../../models/RequestAuthorization.js';
 import { HostRule } from '../../models/HostRule.js';
-import { IRequestCertificate } from '../../models/ClientCertificate.js';
+import { HttpCertificate } from '../../models/ClientCertificate.js';
 import { SentRequest } from '../../models/SentRequest.js';
 import { Response } from '../../models/Response.js';
 import { ErrorResponse } from '../../models/ErrorResponse.js';
@@ -40,7 +40,7 @@ export interface HttpEngineOptions extends IRequestBaseConfig {
   /**
    * A certificate to use with the request.
    */
-  certificates?: IRequestCertificate[];
+  certificates?: HttpCertificate[];
 }
 
 export interface RequestStats {
@@ -385,7 +385,7 @@ export abstract class HttpEngine extends EventEmitter {
 
   /**
    * Reports response when redirected.
-   * @param  Received status code
+   * @param status Received status code
    * @return True if the request has been redirected.
    */
   _reportRedirect(status: number): boolean {
@@ -734,51 +734,57 @@ Check your request parameters.`);
    * @param certificate List of certificate configurations.
    * @param options Request options. Cert agent options are added to this object.
    */
-  _addClientCertificate(certificate: IRequestCertificate, options: tls.ConnectionOptions): void {
+  _addClientCertificate(certificate: HttpCertificate, options: tls.ConnectionOptions): void {
     if (!certificate) {
       return;
     }
     const cert = { ...certificate };
-    if (!Array.isArray(cert.cert)) {
-      cert.cert = [cert.cert];
-    }
     if (cert.type === 'p12') {
       if (!options.pfx) {
         options.pfx = [];
       }
-      const added = cert.cert.map((item) => {
-        const struct: tls.PxfObject = {
-          buf: Buffer.from(item.data as string),
-        };
-        if (item.passphrase) {
-          struct.passphrase = item.passphrase;
+      const struct: tls.PxfObject = {
+        buf: Buffer.from(cert.cert.data as string),
+      };
+      if (cert.cert.passphrase) {
+        struct.passphrase = cert.cert.passphrase;
+      }
+      if (!Array.isArray(options.pfx)) {
+        if (options.pfx) {
+          options.pfx = [options.pfx];
+        } else {
+          options.pfx = [];
         }
-        return struct;
-      });
-      options.pfx = (options.pfx as tls.PxfObject[]).concat(added);
+      }
+      options.pfx.push(struct);
     } else if (cert.type === 'pem') {
       if (!options.cert) {
         options.cert = [];
       }
-      const added = cert.cert.map((item) => Buffer.from(item.data as string));
-      options.cert = (options.cert as Buffer[]).concat(added);
-      if (cert.key) {
-        if (!Array.isArray(cert.key)) {
-          cert.key = [cert.key];
-        }
-        if (!options.key) {
-          options.key = [];
+      if (!Array.isArray(options.cert)) {
+        if (options.cert) {
+          options.cert = [options.cert];
+        } else {
+          options.cert = [];
         }
-        const keys = cert.key.map((item) => {
-          const struct: tls.KeyObject = {
-            pem: Buffer.from(item.data as string),
-          };
-          if (item.passphrase) {
-            struct.passphrase = item.passphrase;
+      }
+      const added = Buffer.from(cert.cert.data as string);
+      options.cert.push(added);
+      if (cert.certKey) {
+        if (!Array.isArray(options.key)) {
+          if (options.key) {
+            options.key = [options.key];
+          } else {
+            options.key = [];
           }
-          return struct;
-        });
-        options.key = (options.key as tls.KeyObject[]).concat(keys);
+        }
+        const struct: tls.KeyObject = {
+          pem: Buffer.from(cert.certKey.data as string),
+        };
+        if (cert.certKey.passphrase) {
+          struct.passphrase = cert.certKey.passphrase;
+        }
+        options.key.push(struct);
       }
     }
   }

package/src/runtime/modules/ModulesRegistry.ts

@@ -8,7 +8,7 @@ import { ClientCertificateEvents } from '../../events/models/ClientCertificateEv
 import { IRequestAuthorization } from '../../models/RequestAuthorization.js';
 import { IRequestConfig } from '../../models/RequestConfig.js';
 import { IRequestLog } from '../../models/RequestLog.js';
-import { IRequestCertificate } from '../../models/ClientCertificate.js';
+import { HttpCertificate } from '../../models/ClientCertificate.js';
 
 export interface RegisteredRequestModule {
   fn: (request: IHttpRequest, context: ExecutionContext) => Promise<number>;
@@ -49,7 +49,7 @@ export interface ExecutionContext {
   /**
    * Can be altered by the actions.
    */
-  certificates?: IRequestCertificate[];
+  certificates?: HttpCertificate[];
 }
 
 export interface ExecutionEvents {

package/src/runtime/modules/RequestAuthorization.ts

@@ -9,18 +9,14 @@ import { ExecutionContext } from './ModulesRegistry.js';
  * Injects client certificate object into the request object
  */
 async function processClientCertificate(config: ICCAuthorization, context: ExecutionContext): Promise<void> {
-  const { id } = config;
-  if (!id || !context.Events) {
-    return;
-  }
-  const result = await context.Events.ClientCertificate.read(context.eventsTarget, id);
-  if (!result) {
+  const { certificate } = config;
+  if (!certificate) {
     return;
   }
   if (!Array.isArray(context.certificates)) {
     context.certificates = [];
   }
-  context.certificates.push(result);
+  context.certificates.push(certificate);
 }
 
 /**

package/src/runtime/node/ProjectRequestRunner.ts

@@ -136,7 +136,7 @@ export class ProjectRequestRunner extends EventEmitter {
       factory.actions = request.actions.toJSON();
     }
     if (request.clientCertificate) {
-      factory.certificates = [request.clientCertificate];
+      factory.certificates = [request.clientCertificate.toJSON()];
     }
     if (config.enabled !== false) {
       factory.config = config.toJSON();

package/src/runtime/node/RequestFactory.ts

@@ -3,7 +3,7 @@ import { IHttpRequest } from '../../models/HttpRequest.js';
 import { IRequestConfig, IRequestBaseConfig } from '../../models/RequestConfig.js';
 import { IRequestAuthorization } from '../../models/RequestAuthorization.js';
 import { IRequestActions } from '../../models/RequestActions.js';
-import { IRequestCertificate } from '../../models/ClientCertificate.js';
+import { HttpCertificate } from '../../models/ClientCertificate.js';
 import { IRequestLog } from '../../models/RequestLog.js';
 import { VariablesProcessor } from '../variables/VariablesProcessor.js';
 import { IRunnableAction } from '../../models/actions/RunnableAction.js';
@@ -57,7 +57,7 @@ export class RequestFactory {
   /**
    * The list of certificates to use with the request.
    */
-  certificates?: IRequestCertificate[];
+  certificates?: HttpCertificate[];
   /**
    * The cumulative list of all variables to be applied to the request and other properties.
    * The variables must be already processed for variables in values (evaluated).

package/build/src/events/models/ProjectEvents.d.ts

@@ -1,221 +0,0 @@
-import { IHttpProject, IProjectMoveOptions, IHttpProjectIndex, IFolderCreateOptions, IRequestAddOptions } from "../../models/HttpProject.js";
-import { IProjectFolder } from "../../models/ProjectFolder.js";
-import { IProjectRequest } from "../../models/ProjectRequest.js";
-import { IEnvironment } from "../../models/Environment.js";
-import { ContextChangeRecord, ContextDeleteRecord } from "../BaseEvents.js";
-export interface ProjectMoveEventDetail {
-    type: 'request' | 'folder';
-    key: string;
-    opts?: IProjectMoveOptions;
-}
-export interface ProjectCloneEventDetail {
-    /**
-     * The id of the project to clone in the data store.
-     */
-    id: string;
-}
-/**
- * A list of options to initialize a folder in a project.
- */
-export interface IFolderInitOptions extends IFolderCreateOptions {
-    /**
-     * The store id of the project.
-     */
-    id: string;
-    /**
-     * Optional name of the new folder.
-     */
-    name?: string;
-}
-/**
- * A list of options to initialize a request in a project.
- */
-export interface IRequestInitOptions extends IRequestAddOptions {
-    /**
-     * The store id of the project.
-     */
-    id: string;
-    /**
-     * The URL of the request.
-     */
-    url: string;
-}
-export interface IEnvironmentInitOptions {
-    /**
-     * The store id of the project.
-     */
-    id: string;
-    /**
-     * The name of the environment to create.
-     */
-    name: string;
-    /**
-     * The optional key of the parent folder.
-     */
-    key?: string;
-}
-declare class ProjectFolderEvents {
-    /**
-     * Creates a folder in a project.
-     *
-     * @param target The target on which to dispatch the event
-     * @param id The store id of the project
-     * @param name Optionally, name of the folder to create.
-     * @param opts Optional options to create a folder.
-     * @returns The change record of the created folder. Note, the client should either refresh the project from the store or append the change record to the instance of the project.
-     */
-    static create(target: EventTarget, id: string, name?: string, opts?: IFolderCreateOptions): Promise<ContextChangeRecord<IProjectFolder> | undefined>;
-    /**
-     * Deletes a folder from a project
-     *
-     * @param target The target on which to dispatch the event
-     * @param id The data store id of the project
-     * @param key The key of the folder to delete.
-     */
-    static delete(target: EventTarget, id: string, key: string): Promise<ContextDeleteRecord | undefined>;
-    /**
-     * Updates the entire folder schema in a project.
-     *
-     * @param target The target on which to dispatch the event
-     * @param id The data store id of the project
-     * @param folder The folder to replace the schema for.
-     * @returns The change record of the updated folder.
-     */
-    static update(target: EventTarget, id: string, folder: IProjectFolder): Promise<ContextChangeRecord<IProjectFolder> | undefined>;
-}
-declare class ProjectRequestEvents {
-    /**
-     * Creates a request in a project.
-     *
-     * @param target The target on which to dispatch the event
-     * @param id The store id of the project
-     * @param url The URL of the request.
-     * @param opts Optional options to create a request.
-     * @returns The change record of the created request. Note, the client should either refresh the project from the store or append the change record to the instance of the project.
-     */
-    static create(target: EventTarget, id: string, url: string, opts?: IRequestAddOptions): Promise<ContextChangeRecord<IProjectRequest> | undefined>;
-    /**
-     * Deletes a request from a project
-     *
-     * @param target The target on which to dispatch the event
-     * @param id The data store id of the project
-     * @param key The key of the request to delete.
-     */
-    static delete(target: EventTarget, id: string, key: string): Promise<ContextDeleteRecord | undefined>;
-    /**
-     * Updates the entire request schema in a project.
-     *
-     * @param target The target on which to dispatch the event
-     * @param id The data store id of the project
-     * @param request The request to replace the schema for.
-     * @returns The change record of the updated request.
-     */
-    static update(target: EventTarget, id: string, request: IProjectRequest): Promise<ContextChangeRecord<IProjectRequest> | undefined>;
-}
-declare class ProjectEnvironmentEvents {
-    /**
-     * Creates an environment in a project.
-     *
-     * @param target The target on which to dispatch the event
-     * @param id The store id of the project
-     * @param name The name of the environment.
-     * @param key The optional key of the parent folder.
-     * @returns The change record of the created environment. Note, the client should either refresh the project from the store or append the change record to the instance of the project.
-     */
-    static create(target: EventTarget, id: string, name: string, key?: string): Promise<ContextChangeRecord<IEnvironment> | undefined>;
-    /**
-     * Deletes an environment from a project
-     *
-     * @param target The target on which to dispatch the event
-     * @param id The data store id of the project
-     * @param key The key of the environment to delete.
-     */
-    static delete(target: EventTarget, id: string, key: string): Promise<ContextDeleteRecord | undefined>;
-    /**
-     * Updates the entire environment schema in a project.
-     *
-     * @param target The target on which to dispatch the event
-     * @param id The data store id of the project
-     * @param environment The environment to replace the schema for.
-     * @returns The change record of the updated environment.
-     */
-    static update(target: EventTarget, id: string, environment: IEnvironment): Promise<ContextChangeRecord<IEnvironment> | undefined>;
-}
-/**
- * API Client's HTTP project events.
- *
- * Note, `id`s refers to datastore ids but `key`s are internal identifiers inside the project.
- * Whenever id is used it refers to the store's ids. When `key` is used it is the id of the project or any of its components.
- */
-export declare class ProjectEvents {
-    /**
-     * Creates a new project in the data store.
-     *
-     * @param target The target on which to dispatch the event
-     * @param name The name of the project to create
-     * @returns The change record of the created project.
-     */
-    static create(target: EventTarget, name: string): Promise<ContextChangeRecord<IHttpProject> | undefined>;
-    /**
-     * Reads a project from the data store.
-     *
-     * @param target The target on which to dispatch the event
-     * @param id The data store id of the project to read.
-     * @param rev Optional revision version, when supported.
-     */
-    static read(target: EventTarget, id: string, rev?: string): Promise<IHttpProject | undefined>;
-    /**
-     * Updates the entire object in the store.
-     *
-     * @param target The target on which to dispatch the event
-     * @param project The project to replace the value for.
-     * @returns The change record of the updated project.
-     */
-    static update(target: EventTarget, project: IHttpProject): Promise<ContextChangeRecord<IHttpProject> | undefined>;
-    /**
-     * Deletes a project from the data store.
-     *
-     * @param target The target on which to dispatch the event
-     * @param id The data store id of the project to delete.
-     */
-    static delete(target: EventTarget, id: string): Promise<ContextDeleteRecord | undefined>;
-    /**
-     * Moves a request or a folder inside the project.
-     *
-     * @param target The target on which to dispatch the event
-     * @param type The type of the object to move within the project.
-     * @param key The `key` of the request of the folder
-     * @param opts The move options. When omitted then it moves the object to the project root at the last position.
-     * @returns The change record of the updated project.
-     */
-    static move(target: EventTarget, type: 'request' | 'folder', key: string, opts?: IProjectMoveOptions): Promise<ContextChangeRecord<IHttpProject> | undefined>;
-    /**
-     * Clones a project that is stored in the data store.
-     *
-     * @param target The target on which to dispatch the event
-     * @param id The data store id of the project to clone.
-     * @returns The cloned project (the copy).
-     */
-    static clone(target: EventTarget, id: string): Promise<ContextChangeRecord<IHttpProject> | undefined>;
-    /**
-     * Lists all projects in the data store.
-     * This does not return the whole project record. Instead it only returns the index object of the project.
-     *
-     * @param target The target on which to dispatch the event
-     * @returns The list of project index objects.
-     */
-    static listAll(target: EventTarget): Promise<IHttpProjectIndex[] | undefined>;
-    /**
-     * Events related to a folder manipulation in a project.
-     */
-    static get Folder(): typeof ProjectFolderEvents;
-    /**
-     * Events related to a request manipulation in a project.
-     */
-    static get Request(): typeof ProjectRequestEvents;
-    /**
-     * Events related to an environment manipulation in a project.
-     */
-    static get Environment(): typeof ProjectEnvironmentEvents;
-}
-export {};