@api-client/core 0.9.25 → 0.10.0

package/build/cjs/src/models/HttpProject.js

@@ -0,0 +1,1242 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HttpProject = exports.Kind = void 0;
+/* eslint-disable @typescript-eslint/no-empty-interface */
+/* eslint-disable @typescript-eslint/no-explicit-any */
+/* eslint-disable @typescript-eslint/no-this-alias */
+const ProjectParent_js_1 = require("./ProjectParent.js");
+const Environment_js_1 = require("./Environment.js");
+const License_js_1 = require("./License.js");
+const Provider_js_1 = require("./Provider.js");
+const Thing_js_1 = require("./Thing.js");
+const ProjectItem_js_1 = require("./ProjectItem.js");
+const ProjectFolder_js_1 = require("./ProjectFolder.js");
+const ProjectRequest_js_1 = require("./ProjectRequest.js");
+const ProjectSchema_js_1 = require("./ProjectSchema.js");
+const Request_js_1 = require("./Request.js");
+const uuid_js_1 = __importDefault(require("../lib/uuid.js"));
+const PostmanDataTransformer_js_1 = require("./transformers/PostmanDataTransformer.js");
+const ClientCertificate_js_1 = require("./ClientCertificate.js");
+const kinds_js_1 = require("./kinds.js");
+exports.Kind = 'Core#HttpProject';
+/**
+ * An instance of an HttpProject.
+ */
+class HttpProject extends ProjectParent_js_1.ProjectParent {
+    kind = exports.Kind;
+    initEnvironments;
+    /**
+     * The license information for this HTTP project.
+     */
+    license;
+    /**
+     * Information about project provider.
+     */
+    provider;
+    /**
+     * The list of all requests stored in this project.
+     * Note, this is not used to visualized the request in the UI.
+     * This is just the source of data.
+     * The `items` property is used to build the view.
+     */
+    definitions = HttpProject.defaultDefinitions();
+    static defaultDefinitions() {
+        return { environments: [], folders: [], requests: [], schemas: [], certificates: [] };
+    }
+    /**
+     * Creates a new HTTP project from a name.
+     * @param {string} name The name to set.
+     */
+    static fromName(name) {
+        const project = new HttpProject();
+        const info = Thing_js_1.Thing.fromName(name);
+        project.info = info;
+        return project;
+    }
+    /**
+     * Creates an HTTP project instance from ARC's legacy project definition.
+     */
+    static async fromLegacy(project, requests) {
+        const { name = 'Unnamed project', description, requests: ids } = project;
+        const typedLegacyDb = project;
+        const result = HttpProject.fromName(name);
+        if (typedLegacyDb._id) {
+            result.key = typedLegacyDb._id;
+        }
+        if (description) {
+            result.info.description = description;
+        }
+        if (Array.isArray(ids) && ids.length) {
+            const promises = ids.map(async (id) => {
+                const old = requests.find((item) => item._id === id);
+                if (!old) {
+                    return;
+                }
+                const request = await Request_js_1.Request.fromLegacy(old);
+                const projectRequest = ProjectRequest_js_1.ProjectRequest.fromRequest(request.toJSON(), result);
+                if (old._id) {
+                    projectRequest.key = old._id;
+                }
+                result.addRequest(projectRequest);
+            });
+            await Promise.allSettled(promises);
+        }
+        return result;
+    }
+    /**
+     * Creates an HTTP project from a Postman collection
+     * @param init The postman collection object or a string that can be parsed to one.
+     */
+    static async fromPostman(init) {
+        const result = await PostmanDataTransformer_js_1.PostmanDataTransformer.transform(init);
+        if (Array.isArray(result) && result.length > 1) {
+            throw new Error(`Unable to process postman data. It contains multiple collections.`);
+        }
+        const project = Array.isArray(result) ? result[0] : result;
+        return project;
+    }
+    /**
+     * Creates a new project from a set of options.
+     */
+    static fromInitOptions(init) {
+        const { name = 'Unnamed project' } = init;
+        return HttpProject.fromName(name);
+    }
+    /**
+     * @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.
+     */
+    constructor(input, environments) {
+        super();
+        if (Array.isArray(environments)) {
+            this.initEnvironments = environments.map(i => new Environment_js_1.Environment(i));
+        }
+        let init;
+        if (typeof input === 'string') {
+            init = JSON.parse(input);
+        }
+        else if (typeof input === 'object') {
+            init = input;
+            if (!init.kind) {
+                init.kind = exports.Kind;
+            }
+        }
+        else {
+            init = {
+                kind: exports.Kind,
+                key: (0, uuid_js_1.default)(),
+                definitions: {},
+                items: [],
+                info: Thing_js_1.Thing.fromName('').toJSON(),
+            };
+        }
+        this.new(init);
+    }
+    /**
+     * Creates a new project definition clearing anything that is so far defined.
+     *
+     * Note, this throws an error when the project is not an API Client project.
+     */
+    new(init) {
+        if (!init || !init.definitions || !init.items) {
+            throw new Error(`Not a project.`);
+        }
+        const { key = (0, uuid_js_1.default)(), definitions = {}, items, info, license, provider } = init;
+        this.key = key;
+        if (license) {
+            this.license = new License_js_1.License(license);
+        }
+        else {
+            this.license = undefined;
+        }
+        if (provider) {
+            this.provider = new Provider_js_1.Provider(provider);
+        }
+        else {
+            this.provider = undefined;
+        }
+        if (info) {
+            this.info = new Thing_js_1.Thing(info);
+        }
+        else {
+            this.info = Thing_js_1.Thing.fromName('');
+        }
+        this.items = [];
+        if (Array.isArray(items)) {
+            this.items = items.map(i => new ProjectItem_js_1.ProjectItem(this, i));
+        }
+        this.definitions = HttpProject.defaultDefinitions();
+        if (Array.isArray(definitions.environments)) {
+            this.definitions.environments = definitions.environments.map(i => new Environment_js_1.Environment(i));
+        }
+        if (Array.isArray(definitions.requests)) {
+            this.definitions.requests = definitions.requests.map(i => {
+                const instance = new ProjectRequest_js_1.ProjectRequest(this, i);
+                instance.attachedCallback();
+                return instance;
+            });
+        }
+        if (Array.isArray(definitions.folders)) {
+            this.definitions.folders = definitions.folders.map(i => {
+                const instance = new ProjectFolder_js_1.ProjectFolder(this, i);
+                instance.attachedCallback();
+                return instance;
+            });
+        }
+        if (Array.isArray(definitions.schemas)) {
+            this.definitions.schemas = definitions.schemas.map(i => new ProjectSchema_js_1.ProjectSchema(i));
+        }
+        if (Array.isArray(definitions.certificates)) {
+            this.definitions.certificates = definitions.certificates.map(i => new ClientCertificate_js_1.Certificate(i));
+        }
+    }
+    toJSON() {
+        const result = {
+            kind: exports.Kind,
+            key: this.key,
+            definitions: {},
+            items: [],
+            info: this.info.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.requests) && this.definitions.requests.length) {
+            result.definitions.requests = this.definitions.requests.map(i => i.toJSON());
+        }
+        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.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());
+        }
+        if (this.provider) {
+            result.provider = this.provider.toJSON();
+        }
+        if (this.license) {
+            result.license = this.license.toJSON();
+        }
+        return result;
+    }
+    /**
+     * @returns JSON representation of the project
+     */
+    toString() {
+        return JSON.stringify(this);
+    }
+    /**
+     * Finds a parent of a definition.
+     *
+     * @param  key The key of the definition.
+     * @returns The parent or undefine when not found.
+     */
+    findParent(key) {
+        const { definitions, items = [] } = this;
+        const projectItemsIndex = items.findIndex(i => i.key === key);
+        if (projectItemsIndex > -1) {
+            return this;
+        }
+        const definition = definitions.folders.find(i => i.items.some(item => item.key === key));
+        if (definition) {
+            return definition;
+        }
+        return undefined;
+    }
+    /**
+     * Appends a new folder to the project or a sub-folder.
+     *
+     * Passing the folder schema as the fist argument is primarily used to insert a folder on the client side
+     * after a folder was created in the store.
+     *
+     * @param init The name or a folder schema. When not set a default name is assumed.
+     * @param opts Folder create options.
+     * @returns The newly inserted folder. If the folder already existed it returns its instance.
+     */
+    addFolder(init = ProjectFolder_js_1.ProjectFolder.defaultName, opts = {}) {
+        if (!Array.isArray(this.items)) {
+            this.items = [];
+        }
+        if (!Array.isArray(this.definitions.folders)) {
+            this.definitions.folders = [];
+        }
+        const { skipExisting, parent } = opts;
+        let root;
+        if (parent) {
+            const rootCandidate = this.findFolder(parent);
+            if (!rootCandidate) {
+                throw new Error(`Unable to find the parent folder ${parent}`);
+            }
+            root = rootCandidate;
+        }
+        else {
+            root = this;
+        }
+        let definition;
+        if (typeof init === 'string') {
+            definition = ProjectFolder_js_1.ProjectFolder.fromName(this, init);
+        }
+        else if (init instanceof ProjectFolder_js_1.ProjectFolder) {
+            definition = init;
+        }
+        else {
+            definition = new ProjectFolder_js_1.ProjectFolder(this, init);
+        }
+        if (skipExisting) {
+            const folders = root.listFolderItems();
+            for (const item of folders) {
+                const existing = this.findFolder(item.key, { keyOnly: true });
+                if (existing && existing.info.name === definition.info.name) {
+                    return existing;
+                }
+            }
+        }
+        this.definitions.folders.push(definition);
+        const item = ProjectItem_js_1.ProjectItem.projectFolder(this, definition.key);
+        if (!Array.isArray(root.items)) {
+            root.items = [];
+        }
+        if (typeof opts.index === 'number') {
+            root.items.splice(opts.index, 0, item);
+        }
+        else {
+            root.items.push(item);
+        }
+        definition.attachedCallback();
+        return definition;
+    }
+    /**
+     * Searches for a folder in the structure.
+     *
+     * @param nameOrKey The name or the key of the folder.
+     * @param opts Optional search options.
+     * @returns Found project folder or undefined.
+     */
+    findFolder(nameOrKey, opts = {}) {
+        const { definitions } = this;
+        const item = definitions.folders.find((i) => {
+            if (i.kind !== kinds_js_1.ProjectFolderKind) {
+                return false;
+            }
+            const folder = i;
+            if (folder.key === nameOrKey) {
+                return true;
+            }
+            if (opts.keyOnly) {
+                return false;
+            }
+            return !!folder.info && folder.info.name === nameOrKey;
+        });
+        if (item) {
+            return item;
+        }
+    }
+    /**
+     * Removes a folder from the project.
+     * @param key The folder key. It ignores the name when searching to the folder to avoid ambiguity.
+     * @param opts Folder remove options.
+     * @returns The removed folder definition or undefined when not removed.
+     */
+    removeFolder(key, opts = {}) {
+        const { definitions } = this;
+        const folder = this.findFolder(key, { keyOnly: true });
+        if (!folder) {
+            if (opts.safe) {
+                return undefined;
+            }
+            throw new Error(`Unable to find the folder ${key}`);
+        }
+        const parent = this.findParent(key);
+        if (!parent) {
+            if (opts.safe) {
+                return undefined;
+            }
+            throw new Error(`Unable to find a parent of the folder ${key}`);
+        }
+        const requests = folder.listRequests();
+        requests.forEach(r => r.remove());
+        const folders = folder.listFolders();
+        folders.forEach(f => f.remove());
+        const itemIndex = parent.items.findIndex(i => i.key === key);
+        const definitionIndex = definitions.folders.findIndex(i => i.key === key);
+        definitions.folders.splice(definitionIndex, 1);
+        folder.detachedCallback();
+        if (itemIndex >= 0) {
+            parent.items.splice(itemIndex, 1);
+        }
+        return folder;
+    }
+    /**
+     * Moves a folder between folders and the project or between items inside a folder or a project
+     *
+     * Note, when the `parent` option is not specified it moved the folder to the project's root.
+     *
+     * @param key The key of the request to move.
+     * @param opts The moving options.
+     */
+    moveFolder(key, opts = {}) {
+        const { index, parent } = opts;
+        const movedFolder = this.findFolder(key);
+        if (!movedFolder) {
+            throw new Error(`Unable to locate the folder ${key}`);
+        }
+        const parentFolder = this.findParent(key);
+        if (!parentFolder) {
+            throw new Error(`Unable to locate a parent of the folder ${key}`);
+        }
+        if (parent) {
+            // check if moving a folder into another folder that is a child of the moved folder.
+            if (this.hasChild(parent, key)) {
+                throw new RangeError(`Unable to move a folder to its child.`);
+            }
+        }
+        const target = parent ? this.findFolder(parent) : this;
+        if (!target) {
+            throw new Error(`Unable to locate the new parent folder ${parent}`);
+        }
+        const hasIndex = typeof index === 'number';
+        if (hasIndex) {
+            // comparing to the `.length` and not `.length - 1` in case we are adding at the end.
+            const maxIndex = Math.max(target.items.length, 0);
+            if (index > maxIndex) {
+                throw new RangeError(`Index out of bounds. Maximum index is ${maxIndex}.`);
+            }
+        }
+        const itemIndex = parentFolder.items.findIndex(i => i.key === key);
+        const item = parentFolder.items.splice(itemIndex, 1)[0];
+        movedFolder.detachedCallback();
+        if (hasIndex && target.items.length > index) {
+            target.items.splice(index, 0, item);
+        }
+        else {
+            target.items.push(item);
+        }
+        movedFolder.attachedCallback();
+    }
+    /**
+     * Checks whether a folder has a child (anywhere down the structure).
+     *
+     * @param child The **key** of the child.
+     * @param folder The **key** of the folder. When not set it searches from the project root.
+     * @returns True when the child is located somewhere down the structure.
+     */
+    hasChild(child, folder) {
+        const target = folder ? this.findFolder(folder) : this;
+        if (!target) {
+            throw new Error(`Unable to locate the folder ${folder}`);
+        }
+        const { items = [] } = target;
+        for (const item of items) {
+            if (item.key === child) {
+                return true;
+            }
+            if (item.kind === kinds_js_1.ProjectFolderKind) {
+                const hasChild = this.hasChild(child, item.key);
+                if (hasChild) {
+                    return true;
+                }
+            }
+        }
+        return false;
+    }
+    /**
+     * Adds a request to the project or a sub-folder.
+     * @param request The request to add.
+     * @param opts Thew request add options.
+     * @returns The inserted into the definitions request.
+     */
+    addRequest(request, opts = {}) {
+        if (!Array.isArray(this.definitions.requests)) {
+            this.definitions.requests = [];
+        }
+        // the request can be already added to the project as the same method is used to refresh a request after 
+        // a store update. From the system perspective it is the same event.
+        if (typeof request === 'object' && request.key) {
+            const existing = this.definitions.requests.find(i => i.key === request.key);
+            if (existing) {
+                existing.new(request);
+                return existing;
+            }
+        }
+        // if we got here, it means that we are adding a new request object to the project.
+        let finalRequest;
+        if (typeof request === 'string') {
+            finalRequest = ProjectRequest_js_1.ProjectRequest.fromUrl(request, this);
+        }
+        else if (request instanceof ProjectRequest_js_1.ProjectRequest) {
+            finalRequest = request;
+            if (finalRequest.project && finalRequest.project !== this) {
+                finalRequest.detachedCallback();
+            }
+            finalRequest.project = this;
+        }
+        else {
+            finalRequest = new ProjectRequest_js_1.ProjectRequest(this, request);
+        }
+        if (!finalRequest.key) {
+            finalRequest.key = (0, uuid_js_1.default)();
+        }
+        let root;
+        if (opts.parent) {
+            const rootCandidate = this.findFolder(opts.parent);
+            if (!rootCandidate) {
+                throw new Error(`Unable to find the parent folder ${opts.parent}.`);
+            }
+            root = rootCandidate;
+        }
+        else {
+            root = this;
+        }
+        if (!Array.isArray(root.items)) {
+            root.items = [];
+        }
+        if (typeof opts.index === 'number') {
+            const maxIndex = Math.max(root.items.length - 1, 0);
+            if (opts.index > maxIndex) {
+                throw new RangeError(`Index out of bounds. Maximum index is ${maxIndex}.`);
+            }
+        }
+        this.definitions.requests.push(finalRequest);
+        const item = ProjectItem_js_1.ProjectItem.projectRequest(this, finalRequest.key);
+        if (typeof opts.index === 'number') {
+            root.items.splice(opts.index, 0, item);
+        }
+        else {
+            root.items.push(item);
+        }
+        finalRequest.attachedCallback();
+        return finalRequest;
+    }
+    /**
+     * Adds a request to the project that has been created for a previous version of ARC.
+     *
+     * @param legacy The legacy request definition.
+     * @returns The created project request.
+     */
+    async addLegacyRequest(legacy) {
+        const request = await Request_js_1.Request.fromLegacy(legacy);
+        const projectRequest = ProjectRequest_js_1.ProjectRequest.fromRequest(request.toJSON(), this);
+        return this.addRequest(projectRequest);
+    }
+    /**
+     * Searches for a request in the project.
+     *
+     * @param nameOrKey The name or the key of the request.
+     * @param opts Optional search options.
+     * @returns Found project request or undefined.
+     */
+    findRequest(nameOrKey, opts = {}) {
+        const { definitions } = this;
+        const item = definitions.requests.find((request) => {
+            if (request.key === nameOrKey) {
+                return true;
+            }
+            if (opts.keyOnly) {
+                return false;
+            }
+            return !!request.info && request.info.name === nameOrKey;
+        });
+        if (item) {
+            return item;
+        }
+        return undefined;
+    }
+    /**
+     * Removes a request from the project.
+     *
+     * @param key The request key. It ignores the name when searching to the request to avoid ambiguity.
+     * @param opts Request remove options.
+     * @returns The removed request definition or undefined when not removed.
+     */
+    removeRequest(key, opts = {}) {
+        const { definitions } = this;
+        const request = this.findRequest(key, { keyOnly: true });
+        if (!request) {
+            if (opts.safe) {
+                return undefined;
+            }
+            throw new Error(`Unable to find the request ${key}`);
+        }
+        const parent = this.findParent(key);
+        if (!parent) {
+            if (opts.safe) {
+                return undefined;
+            }
+            throw new Error(`Unable to find a parent of the request ${key}`);
+        }
+        const itemIndex = parent.items.findIndex(i => i.key === key);
+        const definitionIndex = definitions.requests.findIndex(i => i.key === key);
+        definitions.requests.splice(definitionIndex, 1);
+        request.detachedCallback();
+        if (itemIndex >= 0) {
+            parent.items.splice(itemIndex, 1);
+        }
+        return request;
+    }
+    /**
+     * Moves a request between folders and the project or between items inside a folder or a project.
+     *
+     * Note, when the `parent` option is not specified it moved the request to the project's root.
+     *
+     * @param key The key of the request to move.
+     * @param opts The moving options.
+     */
+    moveRequest(key, opts = {}) {
+        const { index, parent } = opts;
+        const request = this.findRequest(key);
+        if (!request) {
+            throw new Error(`Unable to locate the request ${key}`);
+        }
+        const parentFolder = this.findParent(key);
+        if (!parentFolder) {
+            throw new Error(`Unable to locate a parent of the request ${key}`);
+        }
+        const target = parent ? this.findFolder(parent) : this;
+        if (!target) {
+            throw new Error(`Unable to locate the new parent folder ${parent}`);
+        }
+        const hasIndex = typeof index === 'number';
+        if (hasIndex) {
+            // comparing to the `.length` and not `.length - 1` in case we are adding at the end.
+            const maxIndex = Math.max(target.items.length, 0);
+            if (index > maxIndex) {
+                throw new RangeError(`Index out of bounds. Maximum index is ${maxIndex}.`);
+            }
+        }
+        const itemIndex = parentFolder.items.findIndex(i => i.key === key);
+        const item = parentFolder.items.splice(itemIndex, 1)[0];
+        request.detachedCallback();
+        if (hasIndex && target.items.length > index) {
+            target.items.splice(index, 0, item);
+        }
+        else {
+            target.items.push(item);
+        }
+        request.attachedCallback();
+    }
+    /**
+     * Lists items (not the actual definitions!) that are folders.
+     */
+    listFolderItems() {
+        const { items = [] } = this;
+        return items.filter(i => i.kind === kinds_js_1.ProjectFolderKind);
+    }
+    /**
+     * Lists items (not the actual definitions!) that are requests.
+     */
+    listRequestItems() {
+        const { items = [] } = this;
+        return items.filter(i => i.kind === ProjectRequest_js_1.Kind);
+    }
+    /**
+     * Lists folders from the project or a sub-folder.
+     * @param opts Folder listing options.
+     */
+    listFolders(opts = {}) {
+        let root;
+        if (opts.folder) {
+            const parent = this.findFolder(opts.folder);
+            if (!parent) {
+                throw new Error(`Unable to find the folder ${opts.folder}.`);
+            }
+            root = parent;
+        }
+        else {
+            root = this;
+        }
+        const items = root.listFolderItems();
+        const result = [];
+        const { definitions } = this;
+        items.forEach((i) => {
+            const definition = definitions.folders.find(d => i.key === d.key);
+            if (definition) {
+                result.push(definition);
+            }
+        });
+        return result;
+    }
+    /**
+     * Lists requests in this project or a sub-folder.
+     * @param folder The optional folder name or the key to list requests for.
+     */
+    listRequests(folder) {
+        let root;
+        if (folder) {
+            const parent = this.findFolder(folder);
+            if (!parent) {
+                throw new Error(`Unable to find the folder ${folder}.`);
+            }
+            root = parent;
+        }
+        else {
+            root = this;
+        }
+        const items = root.listRequestItems();
+        const result = [];
+        const { definitions } = this;
+        items.forEach((i) => {
+            const definition = definitions.requests.find(d => i.key === d.key);
+            if (definition) {
+                result.push(definition);
+            }
+        });
+        return result;
+    }
+    /**
+     * Lists definitions for the `items` of the project or a folder.
+     * @param folder Optionally the folder name to list the definitions for.
+     */
+    listDefinitions(folder) {
+        let root;
+        if (folder) {
+            const parent = this.findFolder(folder);
+            if (!parent) {
+                throw new Error(`Unable to find the folder ${folder}`);
+            }
+            root = parent;
+        }
+        else {
+            root = this;
+        }
+        const result = [];
+        const { items = [] } = root;
+        const { definitions } = this;
+        items.forEach((item) => {
+            let definition;
+            if (item.kind === kinds_js_1.ProjectFolderKind) {
+                definition = definitions.folders.find(d => item.key === d.key);
+            }
+            else if (item.kind === ProjectRequest_js_1.Kind) {
+                definition = definitions.requests.find(d => item.key === d.key);
+            }
+            else if (item.kind === Environment_js_1.Kind) {
+                definition = definitions.environments.find(d => item.key === d.key);
+            }
+            if (definition) {
+                result.push(definition);
+            }
+        });
+        return result;
+    }
+    /**
+     * Makes sure the license information exists.
+     * @returns The set license.
+     */
+    ensureLicense() {
+        if (!this.license) {
+            this.license = new License_js_1.License();
+        }
+        return this.license;
+    }
+    /**
+     * Makes sure the Provider information exists.
+     * @returns The set provider.
+     */
+    ensureProvider() {
+        if (!this.provider) {
+            this.provider = new Provider_js_1.Provider();
+        }
+        return this.provider;
+    }
+    /**
+     * @returns On the project level this always returns undefined.
+     */
+    getParent() {
+        return undefined;
+    }
+    attachedCallback() {
+        // ...
+    }
+    detachedCallback() {
+        // ...
+    }
+    getProject() {
+        return this;
+    }
+    /**
+     * Makes a copy of this project.
+     */
+    clone(opts = {}) {
+        const copy = new HttpProject(this.toJSON());
+        if (!opts.withoutRevalidate) {
+            copy.key = (0, uuid_js_1.default)();
+            HttpProject.regenerateKeys(copy);
+        }
+        return copy;
+    }
+    static clone(project, opts = {}) {
+        const obj = new HttpProject(project);
+        return obj.clone(opts);
+    }
+    /**
+     * Re-generates keys in the project, taking care of the references.
+     *
+     * Note, this changes the project properties. Make a copy of the project before calling this.
+     *
+     * @param src The project instance to re-generate keys for.
+     */
+    static regenerateKeys(src) {
+        const { items = [], definitions } = src;
+        // create a flat list of all "items" in the project and all folders.
+        let flatItems = [...items];
+        (definitions.folders || []).forEach((folder) => {
+            if (Array.isArray(folder.items) && folder.items.length) {
+                flatItems = flatItems.concat(folder.items);
+            }
+        });
+        (definitions.folders || []).forEach((folder) => {
+            const oldKey = folder.key;
+            const indexObject = flatItems.find(i => i.key === oldKey);
+            if (!indexObject) {
+                return;
+            }
+            const newKey = (0, uuid_js_1.default)();
+            indexObject.key = newKey;
+            folder.key = newKey;
+        });
+        (definitions.requests || []).forEach((request) => {
+            const oldKey = request.key;
+            const indexObject = flatItems.find(i => i.key === oldKey);
+            if (!indexObject) {
+                return;
+            }
+            const newKey = (0, uuid_js_1.default)();
+            indexObject.key = newKey;
+            request.key = newKey;
+        });
+        (definitions.schemas || []).forEach((schema) => {
+            schema.key = (0, uuid_js_1.default)();
+        });
+        (definitions.certificates || []).forEach((cert) => {
+            cert.key = (0, uuid_js_1.default)();
+        });
+        (definitions.environments || []).forEach((environment) => {
+            const oldKey = environment.key;
+            const indexObject = flatItems.find(i => i.key === oldKey);
+            if (!indexObject) {
+                return;
+            }
+            const newKey = (0, uuid_js_1.default)();
+            indexObject.key = newKey;
+            environment.key = newKey;
+        });
+    }
+    /**
+     * Adds a request to the project or a sub-folder.
+     * @param schema The schema to add.
+     * @param opts Thew schema add options.
+     * @returns The inserted into the schemas schema.
+     */
+    addSchema(schema, opts = {}) {
+        if (!Array.isArray(this.definitions.schemas)) {
+            this.definitions.schemas = [];
+        }
+        // this renews existing schema
+        if (typeof schema === 'object' && schema.key) {
+            const existing = this.definitions.schemas.find(i => i.key === schema.key);
+            if (existing) {
+                existing.new(schema);
+                return existing;
+            }
+        }
+        let finalSchema;
+        if (typeof schema === 'string') {
+            finalSchema = ProjectSchema_js_1.ProjectSchema.fromName(schema);
+        }
+        else if (schema instanceof ProjectSchema_js_1.ProjectSchema) {
+            finalSchema = schema;
+        }
+        else {
+            finalSchema = new ProjectSchema_js_1.ProjectSchema(schema);
+        }
+        if (!finalSchema.key) {
+            finalSchema.key = (0, uuid_js_1.default)();
+        }
+        const { index } = opts;
+        const hasIndex = typeof index === 'number';
+        if (hasIndex && this.definitions.schemas.length > index) {
+            // comparing to the `.length` and not `.length - 1` in case we are adding at the end.
+            const maxIndex = Math.max(this.definitions.schemas.length, 0);
+            if (index > maxIndex) {
+                throw new RangeError(`Index out of bounds. Maximum index is ${maxIndex}.`);
+            }
+            this.definitions.schemas.splice(index, 0, finalSchema);
+        }
+        else {
+            this.definitions.schemas.push(finalSchema);
+        }
+        return finalSchema;
+    }
+    /**
+     * @returns The current list of schemas in the project.
+     */
+    listSchemas() {
+        if (!Array.isArray(this.definitions.schemas)) {
+            return [];
+        }
+        return this.definitions.schemas;
+    }
+    /**
+     * 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 === ProjectRequest_js_1.Kind) {
+                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 === kinds_js_1.ProjectFolderKind) {
+                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;
+                }
+            }
+        }
+    }
+    /**
+     * Iterates over folders in the project.
+     *
+     * @param opts Iterator configuration options
+     * @param indent Used internally to add `indent` to the result
+     * @returns Iterator that yields when a folder is found, including all sub-folders (if configured).
+     */
+    *folderIterator(opts = {}, indent = 0) {
+        const { definitions } = this;
+        const { ignore = [], parent, recursive } = 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 (item.kind !== kinds_js_1.ProjectFolderKind) {
+                continue;
+            }
+            const folder = definitions.folders.find(i => i.key === item.key);
+            if (!folder) {
+                // missing definition.
+                continue;
+            }
+            if (ignore.includes(folder.key) || (folder.info.name && ignore.includes(folder.info.name))) {
+                continue;
+            }
+            const result = {
+                folder,
+                indent,
+            };
+            if (parent) {
+                result.parent = parent;
+            }
+            yield result;
+            if (recursive) {
+                const it = this.folderIterator({
+                    parent: folder.key,
+                    recursive,
+                    ignore,
+                }, indent + 1);
+                for (const f of it) {
+                    yield f;
+                }
+            }
+        }
+    }
+    [Symbol.iterator]() {
+        return this.requestIterator({
+            recursive: true,
+        });
+    }
+    /**
+     * 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);
+        }
+    }
+    /**
+     * 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 = ProjectItem_js_1.ProjectItem.projectEnvironment(project, environment.key);
+        this._insertItem(item, root, opts);
+        return environment;
+    }
+    _createEnv(env) {
+        let finalEnv;
+        if (env instanceof Environment_js_1.Environment) {
+            finalEnv = env;
+        }
+        else if (typeof env === 'string') {
+            finalEnv = Environment_js_1.Environment.fromName(env);
+        }
+        else {
+            finalEnv = new Environment_js_1.Environment(env);
+        }
+        if (!finalEnv.key) {
+            finalEnv.key = (0, uuid_js_1.default)();
+        }
+        return finalEnv;
+    }
+    /**
+     * This is different to `readEnvironments()`. While the `readEnvironments()`
+     * function generate a list of all environments that apply to a folder, this method
+     * just lists this folder's environments.
+     *
+     * @returns The list of environments defined in this folder
+     */
+    getEnvironments(opts = {}) {
+        if (Array.isArray(this.initEnvironments)) {
+            return this.initEnvironments;
+        }
+        return this.listEnvironments(opts);
+    }
+    /**
+     * @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 === Environment_js_1.Kind).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.getEnvironments();
+            if (environments.length) {
+                if (nameOrKey) {
+                    const selected = environments.find(i => i.key === nameOrKey || i.info.name === nameOrKey);
+                    if (selected) {
+                        result.push(selected);
+                        if (selected.encapsulated) {
+                            break;
+                        }
+                    }
+                }
+                else {
+                    let finished = false;
+                    for (const item of environments) {
+                        result.push(item);
+                        if (item.encapsulated) {
+                            finished = true;
+                            break;
+                        }
+                    }
+                    if (finished) {
+                        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);
+    }
+    /**
+     * 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 ClientCertificate_js_1.Certificate) {
+            finalCert = init;
+        }
+        else {
+            finalCert = new ClientCertificate_js_1.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;
+        });
+    }
+}
+exports.HttpProject = HttpProject;
+//# sourceMappingURL=HttpProject.js.map