@api-client/core 0.6.31 → 0.7.2

package/build/src/models/{arc/ArcProject.js → AppProject.js}

@@ -3,15 +3,17 @@
 /* eslint-disable @typescript-eslint/no-this-alias */
 /* eslint-disable max-classes-per-file */
 // import { ARCHistoryRequest, ARCSavedRequest } from "@api-client/core/build/legacy.js";
-import v4 from "../../lib/uuid.js";
-import { HttpRequest } from "../HttpRequest.js";
-import { Request } from "../Request.js";
-import { Thing } from "../Thing.js";
-export const ArcProjectKind = 'ARC#HttpProject';
-export const ArcProjectFolderKind = 'ARC#HttpProjectFolder';
-export const ArcProjectRequestKind = 'ARC#HttpProjectRequest';
-export class ArcProjectRequest extends Request {
-    kind = ArcProjectRequestKind;
+import v4 from "../lib/uuid.js";
+import { HttpRequest } from "./HttpRequest.js";
+import { Request } from "./Request.js";
+import { Environment, Kind as EnvironmentKind } from './Environment.js';
+import { Thing } from "./Thing.js";
+import { Certificate } from "./ClientCertificate.js";
+export const AppProjectKind = 'Core#AppProject';
+export const AppProjectFolderKind = 'Core#AppProjectFolder';
+export const AppProjectRequestKind = 'Core#AppProjectRequest';
+export class AppProjectRequest extends Request {
+    kind = AppProjectRequestKind;
     /**
      * The identifier of the request.
      */
@@ -32,9 +34,9 @@ export class ArcProjectRequest extends Request {
             throw new Error(`The project is required.`);
         }
         const now = Date.now();
-        const request = new ArcProjectRequest(project, {
+        const request = new AppProjectRequest(project, {
             key: v4(),
-            kind: ArcProjectRequestKind,
+            kind: AppProjectRequestKind,
             created: now,
             updated: now,
             expects: HttpRequest.fromBaseValues({ url, method: 'GET' }).toJSON(),
@@ -54,9 +56,9 @@ export class ArcProjectRequest extends Request {
             throw new Error(`The project is required.`);
         }
         const now = Date.now();
-        const request = new ArcProjectRequest(project, {
+        const request = new AppProjectRequest(project, {
             key: v4(),
-            kind: ArcProjectRequestKind,
+            kind: AppProjectRequestKind,
             created: now,
             updated: now,
             expects: new HttpRequest().toJSON(),
@@ -76,9 +78,9 @@ export class ArcProjectRequest extends Request {
             throw new Error(`The project is required.`);
         }
         const now = Date.now();
-        const request = new ArcProjectRequest(project, {
+        const request = new AppProjectRequest(project, {
             key: v4(),
-            kind: ArcProjectRequestKind,
+            kind: AppProjectRequestKind,
             created: now,
             updated: now,
             expects: HttpRequest.fromBaseValues({ method: info.method, url: info.url, headers: info.headers, payload: info.payload }).toJSON(),
@@ -91,8 +93,8 @@ export class ArcProjectRequest extends Request {
      */
     static fromRequest(request, project) {
         const key = v4();
-        const init = { ...request, key, kind: ArcProjectRequestKind };
-        const result = new ArcProjectRequest(project, init);
+        const init = { ...request, key, kind: AppProjectRequestKind };
+        const result = new AppProjectRequest(project, init);
         return result;
     }
     constructor(project, input) {
@@ -108,17 +110,17 @@ export class ArcProjectRequest extends Request {
         if (init) {
             this.key = init.key || v4();
         }
-        this.kind = ArcProjectRequestKind;
+        this.kind = AppProjectRequestKind;
     }
     new(init) {
         super.new(init);
         const { key = v4() } = init;
         this.key = key;
-        this.kind = ArcProjectRequestKind;
+        this.kind = AppProjectRequestKind;
     }
     toJSON() {
         const request = super.toJSON();
-        const result = { ...request, key: this.key, kind: ArcProjectRequestKind };
+        const result = { ...request, key: this.key, kind: AppProjectRequestKind };
         return result;
     }
     /**
@@ -146,7 +148,7 @@ export class ArcProjectRequest extends Request {
      * Use the options dictionary to control this behavior.
      */
     clone(opts = {}) {
-        const copy = new ArcProjectRequest(this.project, this.toJSON());
+        const copy = new AppProjectRequest(this.project, this.toJSON());
         if (!opts.withoutRevalidate) {
             copy.key = v4();
         }
@@ -168,15 +170,15 @@ export class ArcProjectRequest extends Request {
      * @returns The copied request.
      */
     static clone(request, project, opts = {}) {
-        const obj = new ArcProjectRequest(project, request);
+        const obj = new AppProjectRequest(project, request);
         return obj.clone(opts);
     }
 }
-export class ArcProjectItem {
+export class AppProjectItem {
     /**
      * The kind of the item.
      */
-    kind = ArcProjectRequestKind;
+    kind = AppProjectRequestKind;
     /**
      * The identifier of the object in the `definitions` array of the project.
      */
@@ -190,7 +192,7 @@ export class ArcProjectItem {
      */
     static isProjectItem(input) {
         const typed = input;
-        if (!input || ![ArcProjectFolderKind, ArcProjectRequestKind].includes(typed.kind)) {
+        if (!input || ![AppProjectFolderKind, AppProjectRequestKind, EnvironmentKind].includes(typed.kind)) {
             return false;
         }
         return true;
@@ -199,8 +201,8 @@ export class ArcProjectItem {
      * @return An instance that represents a request item
      */
     static projectRequest(project, key) {
-        const item = new ArcProjectItem(project, {
-            kind: ArcProjectRequestKind,
+        const item = new AppProjectItem(project, {
+            kind: AppProjectRequestKind,
             key,
         });
         return item;
@@ -209,8 +211,18 @@ export class ArcProjectItem {
      * @return An instance that represents a folder item
      */
     static projectFolder(project, key) {
-        const item = new ArcProjectItem(project, {
-            kind: ArcProjectFolderKind,
+        const item = new AppProjectItem(project, {
+            kind: AppProjectFolderKind,
+            key,
+        });
+        return item;
+    }
+    /**
+     * @return An instance that represents an environment item
+     */
+    static projectEnvironment(project, key) {
+        const item = new AppProjectItem(project, {
+            kind: EnvironmentKind,
             key,
         });
         return item;
@@ -225,13 +237,19 @@ export class ArcProjectItem {
         if (typeof input === 'string') {
             if (input === 'http-request') {
                 init = {
-                    kind: ArcProjectRequestKind,
+                    kind: AppProjectRequestKind,
                     key: '',
                 };
             }
             else if (input === 'folder') {
                 init = {
-                    kind: ArcProjectFolderKind,
+                    kind: AppProjectFolderKind,
+                    key: '',
+                };
+            }
+            else if (input === 'environment') {
+                init = {
+                    kind: EnvironmentKind,
                     key: '',
                 };
             }
@@ -253,7 +271,7 @@ export class ArcProjectItem {
      * Note, this throws an error when the project item is not a project item.
      */
     new(init) {
-        if (!ArcProjectItem.isProjectItem(init)) {
+        if (!AppProjectItem.isProjectItem(init)) {
             throw new Error(`Not a project item.`);
         }
         const { kind, key } = init;
@@ -273,12 +291,15 @@ export class ArcProjectItem {
     getItem() {
         const { project, key, kind } = this;
         const { definitions } = project;
-        if (kind === ArcProjectRequestKind) {
+        if (kind === AppProjectRequestKind) {
             return definitions.requests.find(i => i.key === key);
         }
-        if (kind === ArcProjectFolderKind) {
+        if (kind === AppProjectFolderKind) {
             return definitions.folders.find(i => i.key === key);
         }
+        if (kind === EnvironmentKind) {
+            return definitions.environments.find(i => i.key === key);
+        }
         return undefined;
     }
     /**
@@ -289,7 +310,7 @@ export class ArcProjectItem {
         return project.findParent(key);
     }
 }
-export class ArcProjectParent {
+export class AppProjectParent {
     /**
      * The auto-generated key for the folder object.
      * For the project root this is the same as the `_id`.
@@ -363,17 +384,17 @@ export class ArcProjectParent {
      */
     listFolderItems() {
         const { items = [] } = this;
-        return items.filter(i => i.kind === ArcProjectFolderKind);
+        return items.filter(i => i.kind === AppProjectFolderKind);
     }
     /**
      * Lists items (not the actual definitions!) that are requests.
      */
     listRequestItems() {
         const { items = [] } = this;
-        return items.filter(i => i.kind === ArcProjectRequestKind);
+        return items.filter(i => i.kind === AppProjectRequestKind);
     }
 }
-export class ArcProjectFolder extends ArcProjectParent {
+export class AppProjectFolder extends AppProjectParent {
     project;
     /**
      * Creates a new ArcProjectFolder object from a name.
@@ -384,18 +405,18 @@ export class ArcProjectFolder extends ArcProjectParent {
         const now = Date.now();
         const key = v4();
         const info = Thing.fromName(name);
-        const definition = new ArcProjectFolder(project, {
+        const definition = new AppProjectFolder(project, {
             key,
             created: now,
             updated: now,
             items: [],
-            kind: ArcProjectFolderKind,
+            kind: AppProjectFolderKind,
             info: info.toJSON(),
         });
         return definition;
     }
     constructor(project, input) {
-        super(ArcProjectFolderKind, input);
+        super(AppProjectFolderKind, input);
         this.project = project;
         let init;
         if (typeof input === 'string') {
@@ -407,11 +428,11 @@ export class ArcProjectFolder extends ArcProjectParent {
         if (init) {
             this.key = init.key || v4();
         }
-        this.kind = ArcProjectFolderKind;
+        this.kind = AppProjectFolderKind;
     }
     toJSON() {
         const result = {
-            kind: ArcProjectFolderKind,
+            kind: AppProjectFolderKind,
             info: this.info.toJSON(),
             key: this.key,
             created: this.created,
@@ -425,7 +446,7 @@ export class ArcProjectFolder extends ArcProjectParent {
     }
     setItems(items) {
         if (Array.isArray(items)) {
-            this.items = items.map(i => new ArcProjectItem(this.project, i));
+            this.items = items.map(i => new AppProjectItem(this.project, i));
         }
         else {
             this.items = [];
@@ -481,7 +502,7 @@ export class ArcProjectFolder extends ArcProjectParent {
      */
     clone(opts = {}) {
         const { targetProject = this.project, targetFolder } = opts;
-        const copy = new ArcProjectFolder(targetProject, this.toJSON());
+        const copy = new AppProjectFolder(targetProject, this.toJSON());
         copy.key = v4();
         const extProject = targetProject !== this.project;
         if (extProject) {
@@ -522,7 +543,7 @@ export class ArcProjectFolder extends ArcProjectParent {
      * @param project The originating project where the definitions are stored
      */
     cloneRequests(folder, project) {
-        const requests = this.items.filter(i => i.kind === ArcProjectRequestKind);
+        const requests = this.items.filter(i => i.kind === AppProjectRequestKind);
         requests.forEach(r => {
             const request = project.findRequest(r.key, { keyOnly: true });
             if (!request) {
@@ -548,13 +569,13 @@ export class ArcProjectFolder extends ArcProjectParent {
      * @param withRequests Whether to clone requests with the folder.
      */
     cloneSubFolders(folder, project, withRequests = true) {
-        const folders = this.items.filter(i => i.kind === ArcProjectFolderKind);
+        const folders = this.items.filter(i => i.kind === AppProjectFolderKind);
         folders.forEach(f => {
             const definition = project.findFolder(f.key, { keyOnly: true });
             if (!definition) {
                 return;
             }
-            const copy = new ArcProjectFolder(folder.getProject(), definition.toJSON());
+            const copy = new AppProjectFolder(folder.getProject(), definition.toJSON());
             copy.key = v4();
             copy.items = [];
             folder.addFolder(copy);
@@ -584,11 +605,45 @@ export class ArcProjectFolder extends ArcProjectParent {
      */
     async addLegacyRequest(legacy) {
         const request = await Request.fromLegacy(legacy);
-        const projectRequest = ArcProjectRequest.fromRequest(request.toJSON(), this.project);
+        const projectRequest = AppProjectRequest.fromRequest(request.toJSON(), this.project);
         return this.addRequest(projectRequest);
     }
+    /**
+     * Adds an environment to the project.
+     * @returns The same or created environment.
+     */
+    addEnvironment(env, opts = {}) {
+        const newOptions = { ...opts, parent: this.key };
+        return this.project.addEnvironment(env, newOptions);
+    }
+    /**
+     * @param key The environment key to read.
+     */
+    getEnvironment(key) {
+        return this.project.getEnvironment(key, { parent: this.key });
+    }
+    /**
+     * Removes an environment from the folder or a sub-folder.
+     *
+     * @param key the key of the environment to remove
+     * @returns The removed environment, if any.
+     */
+    removeEnvironment(key) {
+        return this.project.removeEnvironment(key, { parent: this.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() {
+        return this.project.listEnvironments({ parent: this.key });
+    }
 }
-export class ArcProject extends ArcProjectParent {
+/**
+ * An app project is similar to the HttpProject but stored for a single application
+ * and has no sharing options. The AppProject can be upgraded to an HttpProject.
+ */
+export class AppProject extends AppProjectParent {
     /**
      * Timestamp when the project was last updated.
      */
@@ -603,7 +658,7 @@ export class ArcProject extends ArcProjectParent {
      * @param name The name to set.
      */
     static fromName(name) {
-        const project = new ArcProject();
+        const project = new AppProject();
         const info = Thing.fromName(name);
         project.info = info;
         return project;
@@ -615,7 +670,7 @@ export class ArcProject extends ArcProjectParent {
      */
     static async fromLegacyProject(project, requests) {
         const { name = 'Unnamed project', description, requests: ids } = project;
-        const result = ArcProject.fromName(name);
+        const result = AppProject.fromName(name);
         if (project._id) {
             result.key = project._id;
         }
@@ -629,7 +684,7 @@ export class ArcProject extends ArcProjectParent {
                     return;
                 }
                 const request = await Request.fromLegacy(old);
-                const projectRequest = ArcProjectRequest.fromRequest(request.toJSON(), result);
+                const projectRequest = AppProjectRequest.fromRequest(request.toJSON(), result);
                 if (old._id) {
                     projectRequest.key = old._id;
                 }
@@ -640,10 +695,12 @@ export class ArcProject extends ArcProjectParent {
         return result;
     }
     constructor(input) {
-        super(ArcProjectKind);
+        super(AppProjectKind);
         this.definitions = {
             folders: [],
             requests: [],
+            environments: [],
+            certificates: [],
         };
         let init;
         if (typeof input === 'string') {
@@ -652,13 +709,13 @@ export class ArcProject extends ArcProjectParent {
         else if (typeof input === 'object') {
             init = input;
             if (!init.kind) {
-                init.kind = ArcProjectKind;
+                init.kind = AppProjectKind;
             }
         }
         else {
             const now = Date.now();
             init = {
-                kind: ArcProjectKind,
+                kind: AppProjectKind,
                 key: v4(),
                 definitions: {},
                 items: [],
@@ -687,23 +744,31 @@ export class ArcProject extends ArcProjectParent {
         this.definitions = {
             folders: [],
             requests: [],
+            environments: [],
+            certificates: [],
         };
         if (Array.isArray(definitions.requests)) {
             this.definitions.requests = definitions.requests.map(i => {
-                const instance = new ArcProjectRequest(this, i);
+                const instance = new AppProjectRequest(this, i);
                 return instance;
             });
         }
         if (Array.isArray(definitions.folders)) {
             this.definitions.folders = definitions.folders.map(i => {
-                const instance = new ArcProjectFolder(this, i);
+                const instance = new AppProjectFolder(this, i);
                 return instance;
             });
         }
+        if (Array.isArray(definitions.environments)) {
+            this.definitions.environments = definitions.environments.map(i => new Environment(i));
+        }
+        if (Array.isArray(definitions.certificates)) {
+            this.definitions.certificates = definitions.certificates.map(i => new Certificate(i));
+        }
     }
     toJSON() {
         const result = {
-            kind: ArcProjectKind,
+            kind: AppProjectKind,
             key: this.key,
             definitions: {},
             items: [],
@@ -717,6 +782,12 @@ export class ArcProject extends ArcProjectParent {
         if (Array.isArray(this.definitions.folders) && this.definitions.folders.length) {
             result.definitions.folders = this.definitions.folders.map(i => i.toJSON());
         }
+        if (Array.isArray(this.definitions.environments) && this.definitions.environments.length) {
+            result.definitions.environments = this.definitions.environments.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());
         }
@@ -724,7 +795,7 @@ export class ArcProject extends ArcProjectParent {
     }
     setItems(items) {
         if (Array.isArray(items)) {
-            this.items = items.map(i => new ArcProjectItem(this, i));
+            this.items = items.map(i => new AppProjectItem(this, i));
         }
         else {
             this.items = [];
@@ -779,13 +850,13 @@ export class ArcProject extends ArcProjectParent {
         }
         let definition;
         if (typeof init === 'string') {
-            definition = ArcProjectFolder.fromName(this, init);
+            definition = AppProjectFolder.fromName(this, init);
         }
-        else if (init instanceof ArcProjectFolder) {
+        else if (init instanceof AppProjectFolder) {
             definition = init;
         }
         else {
-            definition = new ArcProjectFolder(this, init);
+            definition = new AppProjectFolder(this, init);
         }
         if (skipExisting) {
             const folders = root.listFolderItems();
@@ -797,7 +868,7 @@ export class ArcProject extends ArcProjectParent {
             }
         }
         this.definitions.folders.push(definition);
-        const item = ArcProjectItem.projectFolder(this, definition.key);
+        const item = AppProjectItem.projectFolder(this, definition.key);
         if (!Array.isArray(root.items)) {
             root.items = [];
         }
@@ -819,7 +890,7 @@ export class ArcProject extends ArcProjectParent {
     findFolder(nameOrKey, opts = {}) {
         const { definitions } = this;
         const item = definitions.folders.find((i) => {
-            if (i.kind !== ArcProjectFolderKind) {
+            if (i.kind !== AppProjectFolderKind) {
                 return false;
             }
             const folder = i;
@@ -932,7 +1003,7 @@ export class ArcProject extends ArcProjectParent {
             if (item.key === child) {
                 return true;
             }
-            if (item.kind === ArcProjectFolderKind) {
+            if (item.kind === AppProjectFolderKind) {
                 const hasChild = this.hasChild(child, item.key);
                 if (hasChild) {
                     return true;
@@ -963,14 +1034,14 @@ export class ArcProject extends ArcProjectParent {
         // if we got here, it means that we are adding a new request object to the project.
         let finalRequest;
         if (typeof request === 'string') {
-            finalRequest = ArcProjectRequest.fromUrl(request, this);
+            finalRequest = AppProjectRequest.fromUrl(request, this);
         }
-        else if (request instanceof ArcProjectRequest) {
+        else if (request instanceof AppProjectRequest) {
             finalRequest = request;
             finalRequest.project = this;
         }
         else {
-            finalRequest = new ArcProjectRequest(this, request);
+            finalRequest = new AppProjectRequest(this, request);
         }
         if (!finalRequest.key) {
             finalRequest.key = v4();
@@ -996,7 +1067,7 @@ export class ArcProject extends ArcProjectParent {
             }
         }
         this.definitions.requests.push(finalRequest);
-        const item = ArcProjectItem.projectRequest(this, finalRequest.key);
+        const item = AppProjectItem.projectRequest(this, finalRequest.key);
         if (typeof opts.index === 'number') {
             root.items.splice(opts.index, 0, item);
         }
@@ -1013,7 +1084,7 @@ export class ArcProject extends ArcProjectParent {
      */
     async addLegacyRequest(legacy) {
         const request = await Request.fromLegacy(legacy);
-        const projectRequest = ArcProjectRequest.fromRequest(request.toJSON(), this);
+        const projectRequest = AppProjectRequest.fromRequest(request.toJSON(), this);
         return this.addRequest(projectRequest);
     }
     /**
@@ -1114,14 +1185,14 @@ export class ArcProject extends ArcProjectParent {
      */
     listFolderItems() {
         const { items = [] } = this;
-        return items.filter(i => i.kind === ArcProjectFolderKind);
+        return items.filter(i => i.kind === AppProjectFolderKind);
     }
     /**
      * Lists items (not the actual definitions!) that are requests.
      */
     listRequestItems() {
         const { items = [] } = this;
-        return items.filter(i => i.kind === ArcProjectRequestKind);
+        return items.filter(i => i.kind === AppProjectRequestKind);
     }
     /**
      * Lists folders from the project or a sub-folder.
@@ -1198,12 +1269,15 @@ export class ArcProject extends ArcProjectParent {
         const { definitions } = this;
         items.forEach((item) => {
             let definition;
-            if (item.kind === ArcProjectFolderKind) {
+            if (item.kind === AppProjectFolderKind) {
                 definition = definitions.folders.find(d => item.key === d.key);
             }
-            else if (item.kind === ArcProjectRequestKind) {
+            else if (item.kind === AppProjectRequestKind) {
                 definition = definitions.requests.find(d => item.key === d.key);
             }
+            else if (item.kind === EnvironmentKind) {
+                definition = definitions.environments.find(d => item.key === d.key);
+            }
             if (definition) {
                 result.push(definition);
             }
@@ -1223,15 +1297,15 @@ export class ArcProject extends ArcProjectParent {
      * Makes a copy of this project.
      */
     clone(opts = {}) {
-        const copy = new ArcProject(this.toJSON());
+        const copy = new AppProject(this.toJSON());
         if (!opts.withoutRevalidate) {
             copy.key = v4();
-            ArcProject.regenerateKeys(copy);
+            AppProject.regenerateKeys(copy);
         }
         return copy;
     }
     static clone(project, opts = {}) {
-        const obj = new ArcProject(project);
+        const obj = new AppProject(project);
         return obj.clone(opts);
     }
     /**
@@ -1273,6 +1347,289 @@ export class ArcProject extends ArcProjectParent {
             indexObject.key = newKey;
             request.key = newKey;
         });
+        (definitions.environments || []).forEach((environment) => {
+            const oldKey = environment.key;
+            const indexObject = flatItems.find(i => i.key === oldKey);
+            if (!indexObject) {
+                return;
+            }
+            const newKey = v4();
+            indexObject.key = newKey;
+            environment.key = newKey;
+        });
+        (definitions.certificates || []).forEach((cert) => {
+            cert.key = v4();
+        });
+    }
+    /**
+     * Adds an environment to the project.
+     * @returns The same or created environment.
+     */
+    addEnvironment(env, opts = {}) {
+        const environment = this._createEnv(env);
+        const root = this._getRoot(opts);
+        const project = this.getProject();
+        if (!project.definitions.environments) {
+            project.definitions.environments = [];
+        }
+        project.definitions.environments.push(environment);
+        const item = AppProjectItem.projectEnvironment(project, environment.key);
+        this._insertItem(item, root, opts);
+        return environment;
+    }
+    _createEnv(env) {
+        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();
+        }
+        return finalEnv;
+    }
+    /**
+     * @param key The environment key to read.
+     */
+    getEnvironment(key, opts = {}) {
+        const root = this._getRoot(opts);
+        const item = root.items.find(i => i.key === key);
+        if (!item) {
+            return undefined;
+        }
+        const project = this.getProject();
+        if (!Array.isArray(project.definitions.environments)) {
+            project.definitions.environments = [];
+        }
+        return project.definitions.environments.find(e => e.key === key);
+    }
+    /**
+     * Removes an environment from the folder or a sub-folder.
+     *
+     * @param key the key of the environment to remove
+     * @returns The removed environment, if any.
+     */
+    removeEnvironment(key, opts = {}) {
+        const root = this._getRoot(opts);
+        const itemIndex = root.items.findIndex(i => i.key === key);
+        if (itemIndex < 0) {
+            return undefined;
+        }
+        root.items.splice(itemIndex, 1);
+        const project = this.getProject();
+        if (!Array.isArray(project.definitions.environments)) {
+            project.definitions.environments = [];
+        }
+        const defIndex = project.definitions.environments.findIndex(i => i.key === key);
+        if (defIndex < 0) {
+            return undefined;
+        }
+        const env = project.definitions.environments[defIndex];
+        project.definitions.environments.splice(defIndex, 1);
+        return env;
+    }
+    /**
+     * 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(opts = {}) {
+        const root = this._getRoot(opts);
+        const items = root.items.filter(i => i.kind === EnvironmentKind).map(i => i.key);
+        const project = this.getProject();
+        if (!Array.isArray(project.definitions.environments)) {
+            project.definitions.environments = [];
+        }
+        return project.definitions.environments.filter(e => items.includes(e.key));
+    }
+    /**
+     * Reads the list of environments from then selected folder up to the project root.
+     * It stops going up in the project structure when selected environment has the `encapsulated`
+     * property set to true.
+     * The environments are ordered from the top-most level to the selected folder.
+     *
+     * @param opts The environment read options
+     */
+    readEnvironments(opts = {}) {
+        const result = [];
+        const { parent, nameOrKey } = opts;
+        const root = parent ? this.findFolder(parent, { keyOnly: true }) : this;
+        if (!root) {
+            return result;
+        }
+        let current = root;
+        while (current) {
+            const environments = current.listEnvironments();
+            if (environments.length) {
+                const selected = nameOrKey ? environments.find(i => i.key === nameOrKey || i.info.name === nameOrKey) : environments[0];
+                if (selected) {
+                    result.push(selected);
+                    if (selected.encapsulated) {
+                        break;
+                    }
+                }
+            }
+            current = current.getParent();
+        }
+        return result.reverse();
+    }
+    /**
+     * Finds a definition for an environment regardless of its parent.
+     *
+     * @param key The Key of the environment to find.
+     * @returns The environment definition or undefined if not found.
+     */
+    findEnvironment(key) {
+        return this.definitions.environments.find(i => i.key === key);
+    }
+    /**
+     * Depending on the options returns a project or a folder.
+     * It throws when parent folder cannot ber found.
+     */
+    _getRoot(opts) {
+        const project = this.getProject();
+        if (opts.parent) {
+            const parent = project.findFolder(opts.parent);
+            if (!parent) {
+                throw new Error(`Unable to find the parent folder ${opts.parent}.`);
+            }
+            return parent;
+        }
+        return project;
+    }
+    _insertItem(item, root, opts) {
+        if (!Array.isArray(root.items)) {
+            root.items = [];
+        }
+        if (typeof opts.index === 'number') {
+            root.items.splice(opts.index, 0, item);
+        }
+        else {
+            root.items.push(item);
+        }
+    }
+    /**
+     * 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) {
+        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) {
+        let finalCert;
+        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) {
+        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) {
+        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;
+            return !!cnf && !!cnf.certificate && cnf.certificate.key === key;
+        });
+    }
+    /**
+     * Iterates over requests in the project.
+     */
+    *requestIterator(opts = {}) {
+        const { definitions } = this;
+        const { ignore = [], parent, recursive, requests = [] } = opts;
+        const root = parent ? this.findFolder(parent) : this;
+        if (!root) {
+            throw new Error(`The parent folder not found: ${parent}.`);
+        }
+        const items = root.items;
+        if (!items || !items.length) {
+            return;
+        }
+        for (const item of items) {
+            if (ignore.includes(item.key)) {
+                continue;
+            }
+            if (item.kind === AppProjectRequestKind) {
+                const request = definitions.requests.find(i => i.key === item.key);
+                if (!request) {
+                    continue;
+                }
+                const name = request.info.name || '';
+                if (ignore.includes(name)) {
+                    continue;
+                }
+                if (requests.length && !requests.includes(item.key) && !requests.includes(name)) {
+                    continue;
+                }
+                yield request;
+            }
+            else if (recursive && item.kind === AppProjectFolderKind) {
+                const folder = definitions.folders.find(i => i.key === item.key);
+                if (!folder) {
+                    continue;
+                }
+                const name = folder.info.name || '';
+                if (ignore.includes(name)) {
+                    continue;
+                }
+                const it = this.requestIterator({
+                    parent: item.key,
+                    recursive,
+                    ignore,
+                    requests,
+                });
+                for (const request of it) {
+                    yield request;
+                }
+            }
+        }
     }
 }
-//# sourceMappingURL=ArcProject.js.map
+//# sourceMappingURL=AppProject.js.map