@api-client/core 0.20.10 → 0.21.0

package/src/models/HttpProject.ts

@@ -1,1533 +0,0 @@
-/* eslint-disable @typescript-eslint/no-empty-object-type */
-/* eslint-disable @typescript-eslint/no-explicit-any */
-/* eslint-disable @typescript-eslint/no-this-alias */
-import { ProjectParent } from './ProjectParent.js'
-import { IProjectDefinitionProperty } from './ProjectDefinitionProperty.js'
-import { Environment, IEnvironment, Kind as EnvironmentKind } from './Environment.js'
-import { License, ILicense } from './License.js'
-import { Provider, IProvider } from './Provider.js'
-import { ThingSchema, Thing } from './Thing.js'
-import { ProjectItem, IProjectItem } from './ProjectItem.js'
-import { IProjectFolder, ProjectFolder } from './ProjectFolder.js'
-import { IProjectRequest, ProjectRequest, Kind as ProjectRequestKind } from './ProjectRequest.js'
-import { ProjectSchema, IProjectSchema } from './ProjectSchema.js'
-import { Request } from './Request.js'
-import { nanoid } from '../nanoid.js'
-import { ARCSavedRequest, ARCHistoryRequest } from './legacy/request/ArcRequest.js'
-import { ArcLegacyProject, ARCProject } from './legacy/models/ArcLegacyProject.js'
-import { PostmanDataTransformer } from './transformers/PostmanDataTransformer.js'
-import { Certificate, HttpCertificate } from './ClientCertificate.js'
-import { ICCAuthorization } from './Authorization.js'
-import { ProjectFolderKind } from './kinds.js'
-
-export const Kind = 'Core#HttpProject'
-
-export interface IItemOptions {
-  /**
-   * The parent folder of the item to.
-   */
-  parent?: string
-}
-
-export interface IItemCreateOptions extends IItemOptions {
-  /**
-   * The position at which to add the item.
-   */
-  index?: number
-}
-
-export interface IEnvironmentCreateOptions extends IItemCreateOptions {}
-
-/**
- * A list of options to initialize a project in various situations.
- */
-export interface IProjectInitOptions {
-  /**
-   * The name of the project.
-   */
-  name: string
-}
-
-export interface IFolderCreateOptions {
-  /**
-   * Ignores the operation when the folder with the same name already exists.
-   * This command can be used used to ensure that the folder exists.
-   */
-  skipExisting?: boolean
-  /**
-   * The id of the parent folder. When not set it adds the folder to the project root.
-   */
-  parent?: string
-  /**
-   * Optionally the position at which to add the folder into the list of items.
-   */
-  index?: number
-}
-
-export interface IFolderSearchOptions {
-  /**
-   * When set it searches for a folder using keys only.
-   * By default it searches for a key and the name.
-   */
-  keyOnly?: boolean
-}
-
-export interface IFolderDeleteOptions {
-  /**
-   * When set it won't throw an error when the folder is not found in the project.
-   */
-  safe?: boolean
-}
-
-export interface IRequestAddOptions {
-  /**
-   * The id of the parent folder. When not set it adds the request to the project root.
-   */
-  parent?: string
-  /**
-   * Optionally the position at which to add the request into the list of items.
-   */
-  index?: number
-}
-
-export interface IRequestSearchOptions {
-  /**
-   * When set it searches for a request using keys only.
-   * By default it searches for a key and the name.
-   */
-  keyOnly?: boolean
-}
-
-export interface IRequestDeleteOptions {
-  /**
-   * When set it won't throw an error when the request is not found in the project.
-   */
-  safe?: boolean
-}
-
-export interface IProjectMoveOptions {
-  /**
-   * The position at which to insert the object in the destination. BY default it adds the object at the end.
-   */
-  index?: number
-  /**
-   * The name or the key of the parent folder to move the item into.
-   * When not set it moves the item to the project's root.
-   */
-  parent?: string
-}
-
-export interface IReadEnvironmentOptions extends IItemOptions {
-  /**
-   * The name or the key of the environment to select.
-   *
-   * When the name is not specified it selects:
-   * - the first environment from the project, if any
-   * - any parent folder's first environment to the requested folder, if any (if parent is set)
-   * - the requested folder's first environment, if any (if parent is set)
-   */
-  nameOrKey?: string
-}
-
-/**
- * The object stored as a list index for the projects.
- * This is used to list projects in the store and in the UI.
- */
-export interface IHttpProjectIndex {
-  key: string
-  name: string
-  version?: string
-}
-
-export interface IProjectCloneOptions {
-  /**
-   * By default it revalidates (re-creates) keys in the request.
-   * Set this to true to not make any changes to the keys.
-   */
-  withoutRevalidate?: boolean
-}
-
-export interface IFolderListOptions {
-  /**
-   * Folder name or key to list folders for.
-   */
-  folder?: string
-}
-
-export interface ISchemaAddOptions {
-  /**
-   * Optionally the position at which to add the schema into the list of schemas.
-   */
-  index?: number
-}
-
-export interface IProjectRequestIterator {
-  /**
-   * The parent folder key or name. Sets the starting point to iterate over the requests.
-   */
-  parent?: string
-  /**
-   * When set it includes requests in the current folder and sub-folder according to the order
-   * defined in the folder.
-   */
-  recursive?: boolean
-  /**
-   * Limits the number of requests to include in the iterator.
-   * It is an array of request keys or names.
-   */
-  requests?: string[]
-  /**
-   * The opposite of the `requests`. The list of names or keys of requests or folders to ignore.
-   * Note, ignore is tested before the `requests`.
-   */
-  ignore?: string[]
-}
-
-export interface IProjectFolderIterator {
-  /**
-   * The parent folder key or name. Sets the starting point to iterate over the folder.
-   */
-  parent?: string
-  /**
-   * When set it includes folders in the current folder and sub-folder according to the order
-   * defined in the folder.
-   */
-  recursive?: boolean
-  /**
-   * The list of names or keys to ignore.
-   */
-  ignore?: string[]
-}
-
-export interface IProjectFolderIteratorResult {
-  /**
-   * The folder.
-   */
-  folder: ProjectFolder
-  /**
-   * Optional parent key.
-   */
-  parent?: string
-  /**
-   * How deep in the structure the folder is located.
-   * The indent is relative to the `parent`.
-   */
-  indent: number
-}
-
-/**
- * The new definition of a project in API Client.
- * Note, this is not the same as future `ApiProject` which is reserved for building APIs
- * using RAML or OAS.
- */
-export interface IHttpProject extends IProjectDefinitionProperty {
-  kind: typeof Kind
-  /**
-   * The license information for this HTTP project.
-   */
-  license?: ILicense
-  /**
-   * The basic information about the project.
-   */
-  info: ThingSchema
-  /**
-   * Information about project provider.
-   */
-  provider?: IProvider
-  /**
-   * The ordered list of HTTP requests / folders in the projects.
-   * The UI uses this to manipulate the view without changing the definitions.
-   */
-  items: IProjectItem[]
-  /**
-   * The project definitions.
-   * This is where all the data are stored.
-   */
-  definitions: IHttpProjectDefinitions
-}
-
-export interface IHttpProjectDefinitions {
-  requests?: IProjectRequest[]
-  folders?: IProjectFolder[]
-  schemas?: IProjectSchema[]
-  environments?: IEnvironment[]
-  certificates?: HttpCertificate[]
-}
-
-interface HttpProjectDefinitions {
-  requests: ProjectRequest[]
-  folders: ProjectFolder[]
-  schemas: ProjectSchema[]
-  environments: Environment[]
-  certificates: Certificate[]
-}
-
-/**
- * An instance of an HttpProject.
- */
-export class HttpProject extends ProjectParent {
-  override kind = Kind
-  private initEnvironments?: Environment[]
-  /**
-   * The license information for this HTTP project.
-   */
-  license?: License
-  /**
-   * Information about project provider.
-   */
-  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: HttpProjectDefinitions = HttpProject.defaultDefinitions()
-
-  static defaultDefinitions(): HttpProjectDefinitions {
-    return { environments: [], folders: [], requests: [], schemas: [], certificates: [] }
-  }
-
-  /**
-   * Creates a new HTTP project from a name.
-   * @param {string} name The name to set.
-   */
-  static fromName(name: string): HttpProject {
-    const project = new HttpProject()
-    const info = Thing.fromName(name)
-    project.info = info
-    return project
-  }
-
-  /**
-   * Creates an HTTP project instance from ARC's legacy project definition.
-   */
-  static async fromLegacy(project: ArcLegacyProject, requests: ARCSavedRequest[]): Promise<HttpProject> {
-    const { name = 'Unnamed project', description, requests: ids } = project
-    const typedLegacyDb = project as ARCProject
-    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.fromLegacy(old)
-        const projectRequest = 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: any): Promise<HttpProject> {
-    const result = await 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: IProjectInitOptions): HttpProject {
-    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?: string | IHttpProject, environments?: IEnvironment[]) {
-    super()
-    if (Array.isArray(environments)) {
-      this.initEnvironments = environments.map((i) => new Environment(i))
-    }
-    let init: IHttpProject
-    if (typeof input === 'string') {
-      init = JSON.parse(input)
-    } else if (typeof input === 'object') {
-      init = input
-      if (!init.kind) {
-        init.kind = Kind
-      }
-    } else {
-      init = {
-        kind: Kind,
-        key: nanoid(),
-        definitions: {},
-        items: [],
-        info: 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: IHttpProject): void {
-    if (!init || !init.definitions || !init.items) {
-      throw new Error(`Not a project.`)
-    }
-    const { key = nanoid(), definitions = {}, items, info, license, provider } = init
-    this.key = key
-    if (license) {
-      this.license = new License(license)
-    } else {
-      this.license = undefined
-    }
-    if (provider) {
-      this.provider = new Provider(provider)
-    } else {
-      this.provider = undefined
-    }
-    if (info) {
-      this.info = new Thing(info)
-    } else {
-      this.info = Thing.fromName('')
-    }
-    this.items = []
-    if (Array.isArray(items)) {
-      this.items = items.map((i) => new ProjectItem(this, i))
-    }
-    this.definitions = HttpProject.defaultDefinitions()
-    if (Array.isArray(definitions.environments)) {
-      this.definitions.environments = definitions.environments.map((i) => new Environment(i))
-    }
-    if (Array.isArray(definitions.requests)) {
-      this.definitions.requests = definitions.requests.map((i) => {
-        const instance = new ProjectRequest(this, i)
-        instance.attachedCallback()
-        return instance
-      })
-    }
-    if (Array.isArray(definitions.folders)) {
-      this.definitions.folders = definitions.folders.map((i) => {
-        const instance = new ProjectFolder(this, i)
-        instance.attachedCallback()
-        return instance
-      })
-    }
-    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 {
-    const result: IHttpProject = {
-      kind: 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
-   */
-  override toString(): string {
-    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: string): ProjectFolder | HttpProject | undefined {
-    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: string | IProjectFolder | ProjectFolder = ProjectFolder.defaultName,
-    opts: IFolderCreateOptions = {}
-  ): ProjectFolder {
-    if (!Array.isArray(this.items)) {
-      this.items = []
-    }
-    if (!Array.isArray(this.definitions.folders)) {
-      this.definitions.folders = []
-    }
-    const { skipExisting, parent } = opts
-    let root: ProjectFolder | HttpProject
-    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: ProjectFolder
-    if (typeof init === 'string') {
-      definition = ProjectFolder.fromName(this, init)
-    } else if (init instanceof ProjectFolder) {
-      definition = init
-    } else {
-      definition = new 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.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: string, opts: IFolderSearchOptions = {}): ProjectFolder | undefined {
-    const { definitions } = this
-    const item = definitions.folders.find((i) => {
-      if (i.kind !== ProjectFolderKind) {
-        return false
-      }
-      const folder = i as ProjectFolder
-      if (folder.key === nameOrKey) {
-        return true
-      }
-      if (opts.keyOnly) {
-        return false
-      }
-      return !!folder.info && folder.info.name === nameOrKey
-    })
-    if (item) {
-      return item as ProjectFolder
-    }
-  }
-
-  /**
-   * 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: string, opts: IFolderDeleteOptions = {}): ProjectFolder | undefined {
-    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: string, opts: IProjectMoveOptions = {}): void {
-    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: string, folder?: string): boolean {
-    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 === 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: IProjectRequest | ProjectRequest | string, opts: IRequestAddOptions = {}): ProjectRequest {
-    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 as IProjectRequest)
-        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.fromUrl(request, this)
-    } else if (request instanceof ProjectRequest) {
-      finalRequest = request
-      if (finalRequest.project && finalRequest.project !== this) {
-        finalRequest.detachedCallback()
-      }
-      finalRequest.project = this
-    } else {
-      finalRequest = new ProjectRequest(this, request)
-    }
-    if (!finalRequest.key) {
-      finalRequest.key = nanoid()
-    }
-
-    let root: ProjectFolder | HttpProject
-    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.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: ARCSavedRequest | ARCHistoryRequest): Promise<ProjectRequest> {
-    const request = await Request.fromLegacy(legacy)
-    const projectRequest = 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: string, opts: IRequestSearchOptions = {}): ProjectRequest | undefined {
-    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 as ProjectRequest
-    }
-    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: string, opts: IRequestDeleteOptions = {}): ProjectRequest | undefined {
-    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: string, opts: IProjectMoveOptions = {}): void {
-    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(): ProjectItem[] {
-    const { items = [] } = this
-    return items.filter((i) => i.kind === ProjectFolderKind)
-  }
-
-  /**
-   * Lists items (not the actual definitions!) that are requests.
-   */
-  listRequestItems(): ProjectItem[] {
-    const { items = [] } = this
-    return items.filter((i) => i.kind === ProjectRequestKind)
-  }
-
-  /**
-   * Lists folders from the project or a sub-folder.
-   * @param opts Folder listing options.
-   */
-  listFolders(opts: IFolderListOptions = {}): ProjectFolder[] {
-    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: ProjectFolder[] = []
-    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?: string): ProjectRequest[] {
-    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: ProjectRequest[] = []
-    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?: string): (ProjectFolder | ProjectRequest | Environment)[] {
-    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: (ProjectFolder | ProjectRequest | Environment)[] = []
-    const { items = [] } = root
-    const { definitions } = this
-    items.forEach((item) => {
-      let definition: ProjectFolder | ProjectRequest | Environment | undefined
-      if (item.kind === ProjectFolderKind) {
-        definition = definitions.folders.find((d) => item.key === d.key)
-      } else if (item.kind === ProjectRequestKind) {
-        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)
-      }
-    })
-    return result
-  }
-
-  /**
-   * Makes sure the license information exists.
-   * @returns The set license.
-   */
-  ensureLicense(): License {
-    if (!this.license) {
-      this.license = new License()
-    }
-    return this.license
-  }
-
-  /**
-   * Makes sure the Provider information exists.
-   * @returns The set provider.
-   */
-  ensureProvider(): Provider {
-    if (!this.provider) {
-      this.provider = new Provider()
-    }
-    return this.provider
-  }
-
-  /**
-   * @returns On the project level this always returns undefined.
-   */
-  getParent(): ProjectFolder | HttpProject | undefined {
-    return undefined
-  }
-
-  attachedCallback(): void {
-    // ...
-  }
-
-  detachedCallback(): void {
-    // ...
-  }
-
-  getProject(): HttpProject {
-    return this
-  }
-
-  /**
-   * Makes a copy of this project.
-   */
-  clone(opts: IProjectCloneOptions = {}): HttpProject {
-    const copy = new HttpProject(this.toJSON())
-    if (!opts.withoutRevalidate) {
-      copy.key = nanoid()
-      HttpProject.regenerateKeys(copy)
-    }
-    return copy
-  }
-
-  static clone(project: IHttpProject, opts: IProjectCloneOptions = {}): HttpProject {
-    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: HttpProject): void {
-    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 = nanoid()
-      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 = nanoid()
-      indexObject.key = newKey
-      request.key = newKey
-    })
-    ;(definitions.schemas || []).forEach((schema) => {
-      schema.key = nanoid()
-    })
-    ;(definitions.certificates || []).forEach((cert) => {
-      cert.key = nanoid()
-    })
-    ;(definitions.environments || []).forEach((environment) => {
-      const oldKey = environment.key
-      const indexObject = flatItems.find((i) => i.key === oldKey)
-      if (!indexObject) {
-        return
-      }
-      const newKey = nanoid()
-      indexObject.key = newKey
-      environment.key = newKey
-    })
-  }
-
-  /**
-   * Adds a request to the project or a sub-folder.
-   * @param schema The schema to add or a name of the schema.
-   * @param opts Thew schema add options.
-   * @returns The inserted into the schemas schema.
-   */
-  addSchema(schema: IProjectSchema | ProjectSchema | string, opts: ISchemaAddOptions = {}): ProjectSchema {
-    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) as ProjectSchema | undefined
-      if (existing) {
-        existing.new(schema as IProjectSchema)
-        return existing
-      }
-    }
-
-    let finalSchema: ProjectSchema
-    if (typeof schema === 'string') {
-      finalSchema = ProjectSchema.fromName(schema)
-    } else if (schema instanceof ProjectSchema) {
-      finalSchema = schema
-    } else {
-      finalSchema = new ProjectSchema(schema)
-    }
-    if (!finalSchema.key) {
-      finalSchema.key = nanoid()
-    }
-    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(): ProjectSchema[] {
-    if (!Array.isArray(this.definitions.schemas)) {
-      return []
-    }
-    return this.definitions.schemas
-  }
-
-  /**
-   * Iterates over requests in the project.
-   */
-  *requestIterator(opts: IProjectRequestIterator = {}): Generator<ProjectRequest> {
-    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 === ProjectRequestKind) {
-        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 === 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: IProjectFolderIterator = {}, indent = 0): Generator<IProjectFolderIteratorResult> {
-    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 !== 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: IProjectFolderIteratorResult = {
-        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](): Generator<ProjectRequest> {
-    return this.requestIterator({
-      recursive: true,
-    })
-  }
-
-  /**
-   * Depending on the options returns a project or a folder.
-   * It throws when parent folder cannot ber found.
-   */
-  protected _getRoot(opts: IItemOptions): ProjectFolder | HttpProject {
-    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
-  }
-
-  protected _insertItem(item: ProjectItem, root: ProjectFolder | HttpProject, opts: IItemCreateOptions): void {
-    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.
-   * @param env The name of the environment to create or its schema
-   * @returns The same or created environment.
-   */
-  addEnvironment(env: IEnvironment | Environment | string, opts: IEnvironmentCreateOptions = {}): Environment {
-    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.projectEnvironment(project, environment.key)
-    this._insertItem(item, root, opts)
-    return environment
-  }
-
-  protected _createEnv(env: IEnvironment | Environment | string): Environment {
-    let finalEnv: Environment
-    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 = nanoid()
-    }
-    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: IItemOptions = {}): Environment[] {
-    if (Array.isArray(this.initEnvironments)) {
-      return this.initEnvironments
-    }
-    return this.listEnvironments(opts)
-  }
-
-  /**
-   * @param key The environment key to read.
-   */
-  getEnvironment(key: string, opts: IItemOptions = {}): Environment | undefined {
-    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: string, opts: IItemOptions = {}): Environment | undefined {
-    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: IItemOptions = {}): Environment[] {
-    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: IReadEnvironmentOptions = {}): Environment[] {
-    const result: Environment[] = []
-    const { parent, nameOrKey } = opts
-
-    const root = parent ? this.findFolder(parent, { keyOnly: true }) : this
-    if (!root) {
-      return result
-    }
-
-    let current: HttpProject | ProjectFolder | undefined = 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: 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
-    })
-  }
-}