@api-client/core 0.6.29 → 0.7.0

package/src/models/HttpProject.ts

@@ -16,6 +16,9 @@ import v4 from '../lib/uuid.js';
 import { ARCSavedRequest, ARCHistoryRequest } from './legacy/request/ArcRequest.js';
 import { ArcLegacyProject, ARCProject } from './legacy/models/ArcLegacyProject.js';
 import { PostmanDataTransformer } from './transformers/PostmanDataTransformer.js';
+import { IAppProject } from './AppProject.js';
+import { Certificate, HttpCertificate } from './ClientCertificate.js';
+import { ICCAuthorization } from './Authorization.js';
 
 export const Kind = 'Core#HttpProject';
 
@@ -27,7 +30,6 @@ export interface IItemOptions {
 }
 
 export interface IItemCreateOptions extends IItemOptions{
-  
   /**
    * The position at which to add the item.
    */
@@ -250,6 +252,7 @@ export interface IHttpProjectDefinitions {
   folders?: IProjectFolder[];
   schemas?: IProjectSchema[];
   environments?: IEnvironment[];
+  certificates?: HttpCertificate[];
 }
 
 interface HttpProjectDefinitions {
@@ -257,6 +260,7 @@ interface HttpProjectDefinitions {
   folders: ProjectFolder[];
   schemas: ProjectSchema[];
   environments: Environment[];
+  certificates: Certificate[];
 }
 
 /**
@@ -282,7 +286,7 @@ export class HttpProject extends ProjectParent {
   definitions: HttpProjectDefinitions = HttpProject.defaultDefinitions();
 
   static defaultDefinitions(): HttpProjectDefinitions {
-    return { environments: [], folders: [], requests: [], schemas: [] };
+    return { environments: [], folders: [], requests: [], schemas: [], certificates: [] };
   }
 
   /**
@@ -348,6 +352,34 @@ export class HttpProject extends ProjectParent {
     return HttpProject.fromName(name);
   }
 
+  static fromAppProject(init: IAppProject): HttpProject {
+    const result = new HttpProject();
+    const { definitions = {}, items, info, key = v4() } = init;
+    result.key = key;
+    result.info = new Thing(info);
+    if (Array.isArray(items)) {
+      result.items = items.map(i => ProjectItem.fromAppProject(result, i));
+    }
+    if (Array.isArray(definitions.environments)) {
+      result.definitions.environments = definitions.environments.map(i => new Environment(i));
+    }
+    if (Array.isArray(definitions.requests)) {
+      result.definitions.requests = definitions.requests.map(i => {
+        const instance = new ProjectRequest(result, i);
+        instance.attachedCallback();
+        return instance;
+      });
+    }
+    if (Array.isArray(definitions.folders)) {
+      result.definitions.folders = definitions.folders.map(i => {
+        const instance = ProjectFolder.fromAppProject(result, i);
+        instance.attachedCallback();
+        return instance;
+      });
+    }
+    return result;
+  }
+
   /**
    * @param input The project definition used to restore the state.
    * @param environments Optional list of environments to use with this project. It overrides environments stored in the project definition.
@@ -431,6 +463,9 @@ export class HttpProject extends ProjectParent {
     if (Array.isArray(definitions.schemas)) {
       this.definitions.schemas = definitions.schemas.map(i => new ProjectSchema(i));
     }
+    if (Array.isArray(definitions.certificates)) {
+      this.definitions.certificates = definitions.certificates.map(i => new Certificate(i));
+    }
   }
 
   toJSON(): IHttpProject {
@@ -453,6 +488,9 @@ export class HttpProject extends ProjectParent {
     if (Array.isArray(this.definitions.schemas) && this.definitions.schemas.length) {
       result.definitions.schemas = this.definitions.schemas.map(i => i.toJSON());
     }
+    if (Array.isArray(this.definitions.certificates) && this.definitions.certificates.length) {
+      result.definitions.certificates = this.definitions.certificates.map(i => i.toJSON());
+    }
     if (Array.isArray(this.items) && this.items.length) {
       result.items = this.items.map(i => i.toJSON());
     }
@@ -1103,14 +1141,7 @@ export class HttpProject extends ProjectParent {
         flatItems = flatItems.concat(folder.items);
       }
     });
-    // const withEnvironments: (HttpProject | ProjectFolder)[] = [];
-    // if (Array.isArray(src.environments) && src.environments.length) {
-    //   withEnvironments.push(src);
-    // }
     (definitions.folders || []).forEach((folder) => {
-      // if (Array.isArray(folder.environments) && folder.environments.length) {
-      //   withEnvironments.push(folder);
-      // }
       const oldKey = folder.key;
       const indexObject = flatItems.find(i => i.key === oldKey);
       if (!indexObject) {
@@ -1133,6 +1164,9 @@ export class HttpProject extends ProjectParent {
     (definitions.schemas || []).forEach((schema) => {
       schema.key = v4();
     });
+    (definitions.certificates || []).forEach((cert) => {
+      cert.key = v4();
+    });
     (definitions.environments || []).forEach((environment) => {
       const oldKey = environment.key;
       const indexObject = flatItems.find(i => i.key === oldKey);
@@ -1152,7 +1186,7 @@ export class HttpProject extends ProjectParent {
    * @param opts The schema add options.
    * @returns The inserted into the schemas schema.
    */
-  addSchema(url: string, opts?: ISchemaAddOptions): ProjectSchema;
+  addSchema(name: string, opts?: ISchemaAddOptions): ProjectSchema;
 
   /**
    * Adds a schema to the project.
@@ -1524,4 +1558,73 @@ export class HttpProject extends ProjectParent {
   findEnvironment(key: string): Environment | undefined {
     return this.definitions.environments.find(i => i.key === key);
   }
+
+  /**
+   * Finds a definition for a certificate.
+   * 
+   * @param key The key of the certificate to find.
+   * @returns The certificate definition or undefined if not found.
+   */
+  findCertificate(key: string): Certificate | undefined {
+    return this.definitions.certificates.find(i => i.key === key);
+  }
+
+  /**
+   * Adds a certificate to the project.
+   * 
+   * @param init Either an instance of a certificate or its definition.
+   * @returns The inserted certificate.
+   */
+  addCertificate(init: Certificate | HttpCertificate): Certificate {
+    let finalCert: Certificate;
+    if (init instanceof Certificate) {
+      finalCert = init;
+    } else {
+      finalCert = new Certificate(init);
+    }
+    if (!this.definitions.certificates) {
+      this.definitions.certificates = [];
+    }
+    this.definitions.certificates.push(finalCert);
+    return finalCert;
+  }
+
+  /**
+   * Removes a certificate from the project.
+   * 
+   * @param key the key of the certificate to remove
+   * @returns The removed certificate, if any.
+   */
+  removeCertificate(key: string): Certificate | undefined {
+    if (!Array.isArray(this.definitions.certificates)) {
+      return undefined
+    }
+    const defIndex = this.definitions.certificates.findIndex(i => i.key === key);
+    if (defIndex < 0) {
+      return undefined;
+    }
+    const cert = this.definitions.certificates[defIndex];
+    this.definitions.certificates.splice(defIndex, 1);
+    return cert;
+  }
+
+  /**
+   * Finds the requests that are using the certificate identified by the key.
+   * 
+   * @param key The key of the certificate to find the usage for.
+   * @returns The list of requests that use this certificate.
+   */
+  findCertificateRequests(key: string): ProjectRequest[] {
+    return this.definitions.requests.filter((request) => {
+      if (!Array.isArray(request.authorization)) {
+        return false;
+      }
+      const ccAuth = request.authorization.find(auth => auth.type === 'client certificate');
+      if (!ccAuth) {
+        return false;
+      }
+      const cnf = ccAuth.config as ICCAuthorization;
+      return !!cnf && !!cnf.certificate && cnf.certificate.key === key;
+    });
+  }
 }

package/src/models/ProjectFolder.ts

@@ -6,6 +6,7 @@ import { HttpProject, IEnvironmentCreateOptions } from './HttpProject.js';
 import { IThing, Thing, Kind as ThingKind } from './Thing.js';
 import { Environment, IEnvironment } from './Environment.js';
 import v4 from '../lib/uuid.js';
+import { IAppProjectParent } from './AppProject.js';
 
 export const Kind = 'Core#ProjectFolder';
 export const DefaultFolderName = 'New folder';
@@ -94,6 +95,21 @@ export class ProjectFolder extends ProjectParent {
    */
   created = 0;
 
+  static fromAppProject(project: HttpProject, init: IAppProjectParent): ProjectFolder {
+    const result = new ProjectFolder(project);
+    const { key = v4(), created = Date.now(), updated = Date.now(), items, info } = init;
+    result.key = key;
+    result.created = created;
+    result.updated = updated;
+    if (info) {
+      result.info = new Thing(info);
+    }
+    if (Array.isArray(items)) {
+      result.items = items.map(i => ProjectItem.fromAppProject(project, i));
+    }
+    return result;
+  }
+
   constructor(project: HttpProject, input?: string | IProjectFolder) {
     super();
     this.project = project;

package/src/models/ProjectItem.ts

@@ -2,6 +2,7 @@ import { Kind as ProjectFolderKind, ProjectFolder } from './ProjectFolder.js';
 import { Kind as ProjectRequestKind, ProjectRequest } from './ProjectRequest.js';
 import { Kind as EnvironmentKind, Environment } from './Environment.js';
 import { HttpProject } from './HttpProject.js';
+import { AppProjectFolderKind, AppProjectRequestKind, IAppProjectItem } from './AppProject.js';
 
 type Kind = typeof ProjectFolderKind | typeof ProjectRequestKind | typeof EnvironmentKind;
 
@@ -74,6 +75,23 @@ export class ProjectItem {
     return item;
   }
 
+  static fromAppProject(project: HttpProject, item: IAppProjectItem): ProjectItem {
+    let kind: Kind;
+    if (item.kind === AppProjectFolderKind) {
+      kind = ProjectFolderKind
+    } else if (item.kind === AppProjectRequestKind) {
+      kind = ProjectRequestKind
+    } else if (item.kind === EnvironmentKind) {
+      kind = EnvironmentKind
+    } else {
+      throw new Error(`Invalid item kind: ${item.kind}`);
+    }
+    return new ProjectItem(project, {
+      kind,
+      key: item.key,
+    });
+  }
+
   /**
    * @param project The top-most project.
    * @param input The project item definition used to restore the state.

package/src/models/ProjectParent.ts

@@ -10,12 +10,15 @@ import { ProjectDefinitionProperty } from "./ProjectDefinitionProperty.js";
  */
 export abstract class ProjectParent implements ProjectDefinitionProperty {
   kind: unknown;
-  key: string = '';
+
+  key = '';
+
   /**
    * The ordered list of HTTP requests, folders, or environments in the projects.
    * The UI uses this to manipulate the view without changing the definitions.
    */
   items: ProjectItem[] = [];
+  
   /**
    * The basic information about the project / folder.
    */

package/src/models/ProjectRequest.ts

@@ -5,6 +5,7 @@ import { IHttpRequest, Kind as HttpRequestKind } from './HttpRequest.js';
 import { HttpProject } from './HttpProject.js';
 import v4 from '../lib/uuid.js';
 import { IRequest, Request } from './Request.js';
+import { IAppProjectRequest } from './AppProject.js';
 
 export const Kind = 'Core#ProjectRequest';
 
@@ -160,10 +161,10 @@ export class ProjectRequest extends Request implements ProjectDefinitionProperty
     return result;
   }
   
-  constructor(project: HttpProject, input?: string|IProjectRequest) {
+  constructor(project: HttpProject, input?: string|IProjectRequest | IAppProjectRequest) {
     super(input);
     this.project = project;
-    let init: IProjectRequest;
+    let init: IProjectRequest | IAppProjectRequest;
     if (typeof input === 'string') {
       init = JSON.parse(input);
     } else if (typeof input === 'object') {
@@ -189,7 +190,7 @@ export class ProjectRequest extends Request implements ProjectDefinitionProperty
     this.new(init);
   }
 
-  new(init: IProjectRequest): void {
+  new(init: IProjectRequest | IAppProjectRequest): void {
     super.new(init);
     
     const { key } = init;

package/src/models/Property.ts

@@ -27,7 +27,7 @@ export interface IProperty {
   /**
    * Enum values for the property.
    */
-  enum?: unknown;
+  enum?: unknown[];
   /**
    * The description of the property
    */
@@ -76,7 +76,7 @@ export class Property {
   /**
    * Enum values for the property.
    */
-  enum?: unknown;
+  enum?: unknown[];
   /**
    * Whether the value id required to be provided. This is used with validation.
    */
@@ -406,8 +406,8 @@ export class Property {
     if (typeof this.default !== 'undefined') {
       result.default = this.default;
     }
-    if (this.enum) {
-      result.enum = this.enum;
+    if (Array.isArray(this.enum) && this.enum.length) {
+      result.enum = [...this.enum];
     }
     if (typeof this.enabled === 'boolean') {
       result.enabled = this.enabled;

package/src/models/Request.ts

@@ -1,6 +1,6 @@
+import { Core as JsonCore } from '@api-client/json'
 import { IRequestConfig, RequestConfig } from './RequestConfig.js';
 import { Thing, IThing, Kind as ThingKind } from './Thing.js';
-import { IRequestActions, RequestActions } from './RequestActions.js';
 import { HttpCertificate, Certificate } from './ClientCertificate.js';
 import { IRequestAuthorization, RequestAuthorization } from './RequestAuthorization.js';
 import { IRequestLog, RequestLog, Kind as LogKind } from './RequestLog.js';
@@ -13,6 +13,8 @@ import { ARCSavedRequest, ARCHistoryRequest } from './legacy/request/ArcRequest.
 import { ErrorResponse as LegacyErrorResponse, Response as LegacyResponse } from './legacy/request/ArcResponse.js';
 import { PayloadSerializer } from '../lib/transformers/PayloadSerializer.js';
 import { Normalizer } from './legacy/Normalizer.js';
+import { IHttpActionFlow } from './http-actions/HttpActions.js';
+import { LegacyTranslator } from './http-actions/LegacyTranslator.js';
 
 export const Kind = 'Core#Request';
 export const createdSymbol = Symbol('created');
@@ -26,7 +28,7 @@ export const midnightSymbol = Symbol('midnight');
 export interface IRequest {
   kind: string;
   /**
-   * The basic information about the project.
+   * The basic information about the request.
    */
   info: IThing;
   /**
@@ -58,19 +60,23 @@ export interface IRequest {
    */
   authorization?: IRequestAuthorization[];
   /**
-   * Actions to be performed when the request is executed.
+   * Http action flows.
+   * In ARC this was "actions",
    */
-  actions?: IRequestActions;
+  flows?: IHttpActionFlow[];
   /**
-   * The list of certificates to use with the request.
+   * The certificate to use with the request.
+   * Note, the certificate defined on the certificate authorization 
+   * should not be included here by default. The HTTP transport should recognize 
+   * this certificate and update the configuration.
    */
   clientCertificate?: HttpCertificate;
 }
 
 export class Request {
-  [createdSymbol]: number;
-  [updatedSymbol]: number;
-  [midnightSymbol]: number;
+  [createdSymbol] = 0;
+  [updatedSymbol] = 0;
+  [midnightSymbol] = 0;
   kind = Kind;
   /**
    * The basic information about the project.
@@ -93,11 +99,15 @@ export class Request {
    */
   authorization?: RequestAuthorization[];
   /**
-   * Actions to be performed when the request is executed.
+   * Http action flows.
+   * In ARC this was "actions",
    */
-  actions?: RequestActions;
+  flows?: IHttpActionFlow[];
   /**
-   * The list of certificates to use with the request.
+   * The certificate to use with the request.
+   * Note, the certificate defined on the certificate authorization 
+   * should not be included here by default. The HTTP transport should recognize 
+   * this certificate and update the configuration.
    */
   clientCertificate?: Certificate;
 
@@ -196,7 +206,7 @@ export class Request {
     init.created = normalized.created;
     init.updated = normalized.updated;
     if (normalized.actions) {
-      init.actions = RequestActions.fromLegacy(normalized.actions).toJSON();
+      init.flows = LegacyTranslator.translate(normalized.actions);
     }
     if (Array.isArray(normalized.authorization) && normalized.authorization.length) {
       init.authorization = normalized.authorization.map((i) => RequestAuthorization.fromLegacy(i).toJSON());
@@ -329,7 +339,7 @@ export class Request {
   }
 
   new(init: IRequest): void {
-    const { expects, log, updated, created = Date.now(), midnight, config, authorization, actions, clientCertificate, info } = init;
+    const { expects, log, updated, created = Date.now(), midnight, config, authorization, flows, clientCertificate, info } = init;
     if (expects) {
       this.expects = new HttpRequest(expects);
     } else {
@@ -341,7 +351,7 @@ export class Request {
       }
       this.info = new Thing(info);
     } else {
-      this.info = new Thing({ kind: ThingKind, name: '' });
+      this.info = Thing.fromName('')
     }
     if (log) {
       this.log = new RequestLog(log);
@@ -367,10 +377,10 @@ export class Request {
     if (midnight) {
       this.midnight = midnight;
     }
-    if (actions) {
-      this.actions = new RequestActions(actions);
+    if (Array.isArray(flows)) {
+      this.flows = flows.map(i => JsonCore.clone(i));
     } else {
-      this.actions = undefined;
+      this.flows = undefined;
     }
     if (clientCertificate) {
       this.clientCertificate = new Certificate(clientCertificate);
@@ -397,8 +407,8 @@ export class Request {
     if (Array.isArray(this.authorization)) {
       result.authorization = this.authorization.map(i => i.toJSON());
     }
-    if (this.actions) {
-      result.actions = this.actions.toJSON();
+    if (Array.isArray(this.flows)) {
+      result.flows = this.flows.map(i => JsonCore.clone(i))
     }
     if (this.clientCertificate) {
       result.clientCertificate = this.clientCertificate.toJSON();

package/src/models/RequestAuthorization.ts

@@ -47,7 +47,7 @@ export class RequestAuthorization {
    */
   valid?: boolean;
 
-  static fromTypedConfig(type: AuthorizationType, config: IAuthorizationSettingsUnion, valid=true): RequestAuthorization {
+  static fromTypedConfig(type: AuthorizationType, config: IAuthorizationSettingsUnion, valid = true): RequestAuthorization {
     return new RequestAuthorization({
       kind: Kind,
       config,
@@ -74,7 +74,7 @@ export class RequestAuthorization {
   /**
    * @param input The provider definition used to restore the state.
    */
-  constructor(input?: string|IRequestAuthorization) {
+  constructor(input?: string | IRequestAuthorization) {
     let init: IRequestAuthorization;
     if (typeof input === 'string') {
       init = JSON.parse(input);
@@ -105,8 +105,8 @@ export class RequestAuthorization {
   }
 
   toJSON(): IRequestAuthorization {
-    const { config={} } = this;
-    const result:IRequestAuthorization = {
+    const { config = {} } = this;
+    const result: IRequestAuthorization = {
       kind: Kind,
       config: { ...config },
       enabled: this.enabled || false,

package/src/models/RequestUiMeta.ts

@@ -39,13 +39,6 @@ export interface IAuthMeta {
   selected?: number;
 }
 
-export interface IActionsMeta {
-  /**
-   * The index of the selected API Client actions view.
-   */
-  selected?: number;
-}
-
 export interface IResponseUiMeta {
   /**
    * The list of activated panels in the response view.
@@ -123,10 +116,6 @@ export interface IRequestUiMeta {
    * Authorization editor meta.
    */
   authorization?: IAuthMeta;
-  /**
-   * API Client request actions editor UI config.
-   */
-  actions?: IActionsMeta;
   /**
    * The currently selected editor in the request editor UI.
    */
@@ -155,10 +144,6 @@ export class RequestUiMeta {
    * Authorization editor meta.
    */
   authorization?: IAuthMeta;
-  /**
-   * API Client request actions editor UI config.
-   */
-  actions?: IActionsMeta;
   /**
    * The currently selected editor in the request editor UI.
    */
@@ -169,9 +154,8 @@ export class RequestUiMeta {
   response?: IResponseUiMeta;
 
   static fromLegacy(old: LegacyRequestUiMeta): RequestUiMeta {
-    const { actions, authorization, body, headers, response, selectedEditor, url } = old;
+    const { authorization, body, headers, response, selectedEditor, url } = old;
     const init: IRequestUiMeta = {
-      actions,
       authorization,
       body,
       response,
@@ -223,7 +207,6 @@ export class RequestUiMeta {
     this.url = init.url;
     this.headers = init.headers;
     this.authorization = init.authorization;
-    this.actions = init.actions;
     this.selectedEditor = init.selectedEditor;
     this.response = init.response;
   }
@@ -244,9 +227,6 @@ export class RequestUiMeta {
     if (this.authorization) {
       result.authorization = this.authorization;
     }
-    if (this.actions) {
-      result.actions = this.actions;
-    }
     if (this.response) {
       result.response = this.response;
     }

package/src/models/Server.ts

@@ -15,8 +15,7 @@ export interface IServer {
    */
   uri: string;
   /**
-   * Usually included in the `uri`. When the `uri` is missing a protocol 
-   * this is then used.
+   * Usually included in the `uri`. When the `uri` is missing a protocol this is then used.
    */
   protocol?: string;
   /**