@api-client/core 0.5.15 → 0.5.16

package/src/models/ProjectItem.ts

@@ -1,12 +1,15 @@
 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';
 
+type Kind = typeof ProjectFolderKind | typeof ProjectRequestKind | typeof EnvironmentKind;
+
 export interface IProjectItem {
   /**
    * The kind of the item.
    */
-  kind: typeof ProjectFolderKind | typeof ProjectRequestKind;
+  kind: Kind;
   /**
    * The identifier in the `definitions` array of the project.
    */
@@ -17,7 +20,7 @@ export class ProjectItem {
   /**
    * The kind of the item.
    */
-  kind: typeof ProjectFolderKind | typeof ProjectRequestKind = ProjectRequestKind;
+  kind: Kind = ProjectRequestKind;
   /**
    * The identifier of the object in the `definitions` array of the project.
    */
@@ -32,16 +35,16 @@ export class ProjectItem {
    */
   static isProjectItem(input: unknown): boolean {
     const typed = input as IProjectItem;
-    if (!input || ![ProjectFolderKind, ProjectRequestKind].includes(typed.kind)) {
+    if (!input || ![ProjectFolderKind, ProjectRequestKind, EnvironmentKind].includes(typed.kind)) {
       return false;
     }
     return true;
   }
 
   /**
-   * @return An instance that represents a request object
+   * @return An instance that represents a request item
    */
-  static projectRequest(project: HttpProject, key: string) : ProjectItem {
+  static projectRequest(project: HttpProject, key: string): ProjectItem {
     const item = new ProjectItem(project, {
       kind: ProjectRequestKind,
       key,
@@ -50,9 +53,9 @@ export class ProjectItem {
   }
 
   /**
-   * @return An instance that represents a folder object
+   * @return An instance that represents a folder item
    */
-  static projectFolder(project: HttpProject, key: string) : ProjectItem {
+  static projectFolder(project: HttpProject, key: string): ProjectItem {
     const item = new ProjectItem(project, {
       kind: ProjectFolderKind,
       key,
@@ -60,11 +63,22 @@ export class ProjectItem {
     return item;
   }
 
+  /**
+   * @return An instance that represents an environment item
+   */
+  static projectEnvironment(project: HttpProject, key: string): ProjectItem {
+    const item = new ProjectItem(project, {
+      kind: EnvironmentKind,
+      key,
+    });
+    return item;
+  }
+
   /**
    * @param project The top-most project.
    * @param input The project item definition used to restore the state.
    */
-  constructor(project: HttpProject, input: string|IProjectItem) {
+  constructor(project: HttpProject, input: string | IProjectItem) {
     this.project = project;
     let init: IProjectItem;
     if (typeof input === 'string') {
@@ -78,6 +92,11 @@ export class ProjectItem {
           kind: ProjectFolderKind,
           key: '',
         };
+      } else if (input === 'environment') {
+        init = {
+          kind: EnvironmentKind,
+          key: '',
+        };
       } else {
         init = JSON.parse(input);
       }
@@ -114,7 +133,7 @@ export class ProjectItem {
   /**
    * @returns The instance of the definition associated with this item.
    */
-  getItem(): ProjectFolder | ProjectRequest| undefined {
+  getItem(): ProjectFolder | ProjectRequest | Environment | undefined {
     const { project, key, kind } = this;
     const { definitions } = project;
     if (kind === ProjectRequestKind) {
@@ -123,12 +142,15 @@ export class ProjectItem {
     if (kind === ProjectFolderKind) {
       return definitions.folders.find(i => i.key === key);
     }
+    if (kind === EnvironmentKind) {
+      return definitions.environments.find(i => i.key === key);
+    }
   }
 
   /**
-   * @returns The instance of the HttpProject or a ProjectFolder that is a closes parent of this item.
+   * @returns The instance of the HttpProject or a ProjectFolder that is a closest parent of this item.
    */
-  getParent(): ProjectFolder|HttpProject|undefined {
+  getParent(): ProjectFolder | HttpProject | undefined {
     const { project, key } = this;
     return project.findParent(key);
   }

package/src/models/ProjectParent.ts

@@ -3,8 +3,6 @@ import { ProjectFolder } from "./ProjectFolder.js";
 import { ProjectItem } from "./ProjectItem.js";
 import { Thing, Kind as ThingKind } from "./Thing.js";
 import { ProjectDefinitionProperty } from "./ProjectDefinitionProperty.js";
-import { Environment, IEnvironment } from "./Environment.js";
-import v4 from '../lib/uuid.js';
 
 /**
  * A class that contains a common properties and methods of an `HttpProject` and
@@ -14,12 +12,7 @@ export abstract class ProjectParent implements ProjectDefinitionProperty {
   kind: unknown;
   key: string = '';
   /**
-   * The environments defined for this project.
-   * If not set it is inherited from the parent.
-   */
-  environments: string[] = [];
-  /**
-   * The ordered list of HTTP requests / folders in the projects.
+   * 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[] = [];
@@ -35,106 +28,4 @@ export abstract class ProjectParent implements ProjectDefinitionProperty {
   abstract getParent(): HttpProject | ProjectFolder | undefined;
 
   abstract getProject(): HttpProject;
-
-  /**
-   * Adds an environment to the project.
-   * 
-   * @param env The definition of the environment to use to create the environment
-   * @returns The same or created environment.
-   */
-  addEnvironment(env: IEnvironment): Environment;
-
-  /**
-   * Adds an environment to the project.
-   * 
-   * @param env The instance of the environment to add
-   * @returns The same or created environment.
-   */
-  addEnvironment(env: Environment): Environment;
-
-  /**
-   * Adds an environment to the project.
-   * 
-   * @param env The name of the environment to create
-   * @returns The same or created environment.
-   */
-  addEnvironment(env: string): Environment;
-
-  /**
-   * Adds an environment to the project.
-   * @returns The same or created environment.
-   */
-  addEnvironment(env: IEnvironment | Environment | string): Environment {
-    if (!Array.isArray(this.environments)) {
-      this.environments = [];
-    }
-    let finalEnv;
-    if (env instanceof Environment) {
-      finalEnv = env;
-    } else if (typeof env === 'string') {
-      finalEnv = Environment.fromName(env);
-    } else {
-      finalEnv = new Environment(env);
-    }
-    if (!finalEnv.key) {
-      finalEnv.key = v4();
-    }
-    const project = this.getProject();
-    if (!project.definitions.environments) {
-      project.definitions.environments = [];
-    }
-    project.definitions.environments.push(finalEnv);
-    this.environments.push(finalEnv.key);
-    return finalEnv;
-  }
-
-  /**
-   * 
-   * @returns The list of environments defined in this folder.
-   */
-  getEnvironments(): Environment[] {
-    const { environments } = this;
-    if (!environments.length) {
-      return [];
-    }
-    const project = this.getProject();
-    if (!project.definitions.environments) {
-      return [];
-    }
-    const result: Environment[] = [];
-    environments.forEach((key) => {
-      const env = project.definitions.environments.find(i => i.key === key);
-      if (env) {
-        result.push(env);
-      }
-    });
-    return result;
-  }
-
-  /**
-   * @param key The environment key to read.
-   */
-  getEnvironment(key: string): Environment | undefined {
-    const { environments } = this;
-    if (!environments.length) {
-      return undefined;
-    }
-    const has = environments.includes(key);
-    if (!has) {
-      return undefined;
-    }
-    const project = this.getProject();
-    if (!project.definitions.environments) {
-      return undefined;
-    }
-    return project.definitions.environments.find(i => i.key === key);
-  }
-
-  /**
-   * 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.
-   */
-  listEnvironments(): Environment[] {
-    return this.getEnvironments();
-  }
 }

package/src/models/transformers/PostmanBackupTransformer.ts

@@ -146,7 +146,6 @@ export class PostmanBackupTransformer extends PostmanTransformer {
     const init: IHttpProject = {
       kind: ProjectKind,
       definitions: {},
-      environments: [],
       info: {
         kind: ThingKind,
         name,

package/src/models/transformers/PostmanV21Transformer.ts

@@ -133,7 +133,6 @@ export class PostmanV21Transformer extends PostmanTransformer {
     const init: IHttpProject = {
       kind: ProjectKind,
       definitions: {},
-      environments: [],
       info: {
         kind: ThingKind,
         name: info.name || 'Unnamed Postman project',

package/src/models/transformers/PostmanV2Transformer.ts

@@ -130,7 +130,6 @@ export class PostmanV2Transformer extends PostmanTransformer {
     const init: IHttpProject = {
       kind: ProjectKind,
       definitions: {},
-      environments: [],
       info: {
         kind: ThingKind,
         name: info.name || 'Unnamed Postman project',

package/src/runtime/node/ProjectRequestRunner.ts

@@ -205,7 +205,7 @@ export class ProjectRequestRunner extends EventEmitter {
    */
   protected async readEnvironments(parent: HttpProject | ProjectFolder): Promise<Environment[]> {
     const folderKey = parent.kind === ProjectFolderKind ? (parent as ProjectFolder).key : undefined;
-    return this.project.readEnvironments({ folderKey });
+    return this.project.readEnvironments({ parent: folderKey });
   }
 
   /**