@api-client/core 0.8.22 → 0.9.1

package/build/src/models/AppProject.d.ts

@@ -1,817 +0,0 @@
-import { IHttpRequest } from "./HttpRequest.js";
-import { IRequest, Request } from "./Request.js";
-import { Environment, IEnvironment, Kind as EnvironmentKind } from './Environment.js';
-import { IThing, Thing } from "./Thing.js";
-import { ARCHistoryRequest, ARCSavedRequest } from "./legacy/request/ArcRequest.js";
-import { ARCProject } from "./legacy/models/ArcLegacyProject.js";
-import { Certificate, HttpCertificate } from "./ClientCertificate.js";
-import { IProjectRequestIterator } from "./HttpProject.js";
-import { IFile, File } from "./store/File.js";
-export declare const AppProjectKind = "Core#AppProject";
-export declare const AppProjectFolderKind = "Core#AppProjectFolder";
-export declare const AppProjectRequestKind = "Core#AppProjectRequest";
-export declare const AppProjectFileKind = "Core#AppProjectFile";
-export interface IAppProjectItemOptions {
-    /**
-     * The parent folder to add the item to.
-     */
-    parent?: string;
-}
-export interface IAppProjectItemCreateOptions extends IAppProjectItemOptions {
-    /**
-     * The position at which to add the item.
-     */
-    index?: number;
-}
-export interface IAppProjectRequestCloneOptions {
-    /**
-     * By default it revalidates (re-creates) keys in the request.
-     * Set this to true to not make any changes to the keys.
-     */
-    withoutRevalidate?: boolean;
-    /**
-     * By default it attaches the request to the same parent as the original request.
-     * Set this to `true` when moving a request between projects to prevent adding the request to the project.
-     * Note, the request still have a reference to the original project. You need to update the `project` property.
-     */
-    withoutAttach?: boolean;
-}
-export interface IAppProjectFolderAddOptions {
-    /**
-     * Optionally the position at which to add the request into the list of items.
-     */
-    index?: number;
-}
-export interface IAppProjectFolderCloneOptions {
-    /**
-     * By default it clones the folder with all requests in it.
-     * Set this to `true` to skip copying the requests along with the folder.
-     */
-    withoutRequests?: boolean;
-    /**
-     * By default it clones the folder with all folders in it.
-     * Set this to `true` to skip copying the folders along with the folder.
-     */
-    withoutFolders?: boolean;
-    /**
-     * The target project where to put the copied folder.
-     * When the target project is not the same as the source project then the folder
-     * is put into the project root rather than the parent folder (as it would when cloning
-     * a folder inside the same project).
-     */
-    targetProject?: AppProject;
-    /**
-     * The **key** of the target folder.
-     *
-     * By default it clones the folder to its parent unless the clone is attached to another project.
-     * When the target folder is set then it places the clone under the passed target folder.
-     */
-    targetFolder?: string;
-}
-export interface IAppProjectFolderCreateOptions extends IAppProjectItemOptions {
-    /**
-     * 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;
-    /**
-     * Optionally the position at which to add the folder into the list of items.
-     */
-    index?: number;
-}
-export interface IAppProjectFolderSearchOptions {
-    /**
-     * When set it searches for a folder using keys only.
-     * By default it searches for a key and the name.
-     */
-    keyOnly?: boolean;
-}
-export interface IAppProjectFolderDeleteOptions {
-    /**
-     * When set it won't throw an error when the folder is not found in the project.
-     */
-    safe?: boolean;
-}
-export interface IAppProjectRequestAddOptions extends IAppProjectItemOptions {
-    /**
-     * Optionally the position at which to add the request into the list of items.
-     */
-    index?: number;
-}
-export interface IAppProjectRequestSearchOptions {
-    /**
-     * When set it searches for a request using keys only.
-     * By default it searches for a key and the name.
-     */
-    keyOnly?: boolean;
-}
-export interface IAppProjectRequestDeleteOptions {
-    /**
-     * When set it won't throw an error when the request is not found in the project.
-     */
-    safe?: boolean;
-}
-export interface IAppProjectProjectMoveOptions extends IAppProjectItemOptions {
-    /**
-     * The position at which to insert the object in the destination. BY default it adds the object at the end.
-     */
-    index?: number;
-}
-export interface IAppProjectFolderListOptions {
-    /**
-     * Folder name or key to list folders for.
-     */
-    folder?: string;
-}
-export interface IAppProjectProjectCloneOptions {
-    /**
-     * 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 IAppProjectEnvironmentCreateOptions extends IAppProjectItemOptions {
-    /**
-     * The position at which to add the item.
-     */
-    index?: number;
-}
-export interface IAppProjectReadEnvironmentOptions extends IAppProjectItemOptions {
-    /**
-     * 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;
-}
-export interface IAppProjectRequest extends IRequest {
-    kind: typeof AppProjectRequestKind;
-    key: string;
-}
-export interface IAppProjectItem {
-    kind: typeof AppProjectFolderKind | typeof AppProjectRequestKind | typeof EnvironmentKind;
-    key: string;
-}
-export interface IAppProjectDefinitions {
-    /**
-     * The list of all folders defined in the project.
-     */
-    folders?: IAppProjectParent[];
-    /**
-     * The list of all requests defined in the project.
-     */
-    requests?: IAppProjectRequest[];
-    environments?: IEnvironment[];
-    certificates?: HttpCertificate[];
-}
-export interface AppProjectDefinitions {
-    /**
-     * The list of all folders defined in the project.
-     */
-    folders: AppProjectFolder[];
-    /**
-     * The list of all requests defined in the project.
-     */
-    requests: AppProjectRequest[];
-    environments: Environment[];
-    certificates: Certificate[];
-}
-/**
- * An app project is similar to the HttpProject but stored for a single application
- * and has no sharing options. The AppProject can be upgraded to an HttpProject.
- */
-export interface IAppProject extends IAppProjectParent {
-    definitions: IAppProjectDefinitions;
-}
-export interface IAppProjectParent {
-    key: string;
-    kind: typeof AppProjectKind | typeof AppProjectFolderKind;
-    /**
-     * Folder meta
-     */
-    info: IThing;
-    /**
-     * The list of items in the folder.
-     * It is an ordered list of requests and folders.
-     * The actual definition is kept in the root's `definitions`.
-     */
-    items: IAppProjectItem[];
-    /**
-     * Timestamp when the project was last updated.
-     */
-    updated?: number;
-    /**
-     * Timestamp when the project was created.
-     */
-    created?: number;
-}
-export declare class AppProjectRequest extends Request {
-    kind: string;
-    /**
-     * The identifier of the request.
-     */
-    key: string;
-    /**
-     * A reference to the top level project object.
-     */
-    project: AppProject;
-    /**
-     * Creates a project request from an URL.
-     * This does not manipulate the project.
-     *
-     * @param url The Request URL. This is required.
-     * @param project The parent project.
-     */
-    static fromUrl(url: string, project?: AppProject): AppProjectRequest;
-    /**
-     * Creates a project request from a name.
-     * This does not manipulate the project.
-     *
-     * @param name The Request name.
-     * @param project The parent project.This is required.
-     */
-    static fromName(name: string, project?: AppProject): AppProjectRequest;
-    /**
-     * Creates a project request from an HttpRequest definition.
-     * This does not manipulate the project.
-     *
-     * @param project The parent project This is required.
-     * @param info The request data.
-     */
-    static fromHttpRequest(info: IHttpRequest, project?: AppProject): AppProjectRequest;
-    /**
-     * Creates a project request for a schema of a Request.
-     */
-    static fromRequest(request: IRequest, project: AppProject): AppProjectRequest;
-    constructor(project: AppProject, input?: string | IAppProjectRequest);
-    new(init: IAppProjectRequest): void;
-    toJSON(): IAppProjectRequest;
-    /**
-     * @returns The instance of the ArcProject or a ArcProjectFolder that is a closes parent of this instance.
-     */
-    getParent(): AppProjectFolder | AppProject | undefined;
-    /**
-     * @returns A reference to the parent folder or the top-level HTTP project.
-     */
-    getProject(): AppProject;
-    /**
-     * Removes this request from the project.
-     */
-    remove(): void;
-    /**
-     * Makes a copy of this request.
-     * By default it attaches the copied request to the same parent.
-     * Use the options dictionary to control this behavior.
-     */
-    clone(opts?: IAppProjectRequestCloneOptions): AppProjectRequest;
-    /**
-     * The static version of the `clone()` method.
-     *
-     * @param request The request schema to clone.
-     * @param project The project to add the request to.
-     * @param opts Optional options.
-     * @returns The copied request.
-     */
-    static clone(request: IAppProjectRequest, project: AppProject, opts?: IAppProjectRequestCloneOptions): AppProjectRequest;
-}
-export declare class AppProjectItem {
-    /**
-     * The kind of the item.
-     */
-    kind: typeof AppProjectFolderKind | typeof AppProjectRequestKind | typeof EnvironmentKind;
-    /**
-     * The identifier of the object in the `definitions` array of the project.
-     */
-    key: string;
-    /**
-     * A reference to the top level project object.
-     */
-    project: AppProject;
-    /**
-     * Checks whether the input is a definition of a project item.
-     */
-    static isProjectItem(input: unknown): boolean;
-    /**
-     * @return An instance that represents a request item
-     */
-    static projectRequest(project: AppProject, key: string): AppProjectItem;
-    /**
-     * @return An instance that represents a folder item
-     */
-    static projectFolder(project: AppProject, key: string): AppProjectItem;
-    /**
-     * @return An instance that represents an environment item
-     */
-    static projectEnvironment(project: AppProject, key: string): AppProjectItem;
-    /**
-     * @param project The top-most project.
-     * @param input The project item definition used to restore the state.
-     */
-    constructor(project: AppProject, input: string | IAppProjectItem);
-    /**
-     * Creates a new project item clearing anything that is so far defined.
-     *
-     * Note, this throws an error when the project item is not a project item.
-     */
-    new(init: IAppProjectItem): void;
-    toJSON(): IAppProjectItem;
-    /**
-     * @returns The instance of the definition associated with this item.
-     */
-    getItem(): AppProjectFolder | AppProjectRequest | Environment | undefined;
-    /**
-     * @returns The instance of the ArcProject or a ArcProjectFolder that is a closest parent of this item.
-     */
-    getParent(): AppProjectFolder | AppProject | undefined;
-}
-export declare abstract class AppProjectParent {
-    /**
-     * The auto-generated key for the folder object.
-     * For the project root this is the same as the `_id`.
-     */
-    kind: typeof AppProjectKind | typeof AppProjectFolderKind;
-    /**
-     * The key of the project / folder.
-     */
-    key: string;
-    /**
-     * The basic information about the project / folder.
-     */
-    info: Thing;
-    /**
-     * The list of items in the folder.
-     * It is an ordered list of requests and folders.
-     * The actual definition is kept in the root's `definitions`.
-     */
-    items: AppProjectItem[];
-    /**
-     * Timestamp when the project was last updated.
-     */
-    updated: number;
-    /**
-     * Timestamp when the project was created.
-     */
-    created: number;
-    constructor(kind: typeof AppProjectKind | typeof AppProjectFolderKind, input?: string | IAppProjectParent);
-    /**
-     * Creates a new project folder clearing anything that is so far defined.
-     *
-     * Note, this throws an error when the project folder is not a project folder.
-     */
-    new(init: IAppProjectParent): void;
-    abstract setItems(items?: IAppProjectItem[]): void;
-    /**
-     * Lists items (not the actual definitions!) that are folders.
-     */
-    listFolderItems(): AppProjectItem[];
-    /**
-     * Lists items (not the actual definitions!) that are requests.
-     */
-    listRequestItems(): AppProjectItem[];
-}
-export declare class AppProjectFolder extends AppProjectParent {
-    project: AppProject;
-    /**
-     * Creates a new ArcProjectFolder object from a name.
-     * @param project The top-most project.
-     * @param name The name to set.
-     */
-    static fromName(project: AppProject, name?: string): AppProjectFolder;
-    constructor(project: AppProject, input?: string | IAppProjectParent);
-    toJSON(): IAppProjectParent;
-    setItems(items?: IAppProjectItem[]): void;
-    /**
-     * Appends an instance of a folder to a project.
-     *
-     * @param folder The folder to add to this project.
-     * @returns The added folder.
-     */
-    addFolder(folder: AppProjectFolder): AppProjectFolder;
-    /**
-     * Appends new folder to a project from a full folder schema.
-     * This is primarily used to insert a folder on the client side
-     * after a folder was created in the store.
-     *
-     * @param folder The folder schema to add to this project.
-     * @returns The added folder.
-     */
-    addFolder(folder: IAppProjectParent): AppProjectFolder;
-    /**
-     * Appends a new folder to the project or a sub-folder.
-     *
-     * @param name The name to set. Optional.
-     * @returns The newly inserted folder. If the folder already existed it returns its instance.
-     */
-    addFolder(name?: string): AppProjectFolder;
-    /**
-     * Adds a request to the project or a sub-folder.
-     *
-     * @param url The URL of the request.
-     * @param opts The request add options.
-     * @returns The inserted into the definitions request.
-     */
-    addRequest(url: string, opts?: IAppProjectFolderAddOptions): AppProjectRequest;
-    /**
-     * Adds a request to the project or a sub-folder.
-     *
-     * @param request The request to add.
-     * @param opts The request add options.
-     * @returns The inserted into the definitions request.
-     */
-    addRequest(request: IAppProjectRequest | AppProjectRequest, opts?: IAppProjectFolderAddOptions): AppProjectRequest;
-    /**
-     * @returns The instance of the ArcProject or a ArcProjectFolder that is a closes parent of this instance.
-     */
-    getParent(): AppProjectFolder | AppProject | undefined;
-    /**
-     * @returns A reference to the parent folder or the top-level HTTP project.
-     */
-    getProject(): AppProject;
-    /**
-     * Removes this folder from the project.
-     */
-    remove(): void;
-    /**
-     * Makes a copy of this folder.
-     * By default it attaches the copied folder to the same parent.
-     * It also, by default, copies requests declared in this folder.
-     *
-     * Use the options dictionary to control these behaviors.
-     *
-     * @param opts Cloning options
-     */
-    clone(opts?: IAppProjectFolderCloneOptions): AppProjectFolder;
-    /**
-     * Clones the current requests to the target folder.
-     *
-     * @param folder The target folder into which to put the requests. The folder has to have the target project attached to it.
-     * @param project The originating project where the definitions are stored
-     */
-    protected cloneRequests(folder: AppProjectFolder, project: AppProject): void;
-    /**
-     * Clones the sub-folders to the target folder.
-     *
-     * @param folder The target folder into which to put the sub-folders. The folder has to have the target project attached to it.
-     * @param project The originating project where the definitions are stored
-     * @param withRequests Whether to clone requests with the folder.
-     */
-    protected cloneSubFolders(folder: AppProjectFolder, project: AppProject, withRequests?: boolean): void;
-    /**
-     * Lists folders in this folder.
-     */
-    listFolders(): AppProjectFolder[];
-    /**
-     * Lists requests in this folder.
-     */
-    listRequests(): AppProjectRequest[];
-    /**
-     * 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.
-     */
-    addLegacyRequest(legacy: ARCSavedRequest | ARCHistoryRequest): Promise<AppProjectRequest>;
-    /**
-     * Adds an environment to the project.
-     *
-     * @param env The definition of the environment to use to create the environment
-     * @returns The same or created environment.
-     */
-    addEnvironment(env: IEnvironment, opts?: IAppProjectEnvironmentCreateOptions): Environment;
-    /**
-     * Adds an environment to the project.
-     *
-     * @param env The instance of the environment to add
-     * @returns The same or created environment.
-     */
-    addEnvironment(env: Environment, opts?: IAppProjectEnvironmentCreateOptions): Environment;
-    /**
-     * Adds an environment to the project.
-     *
-     * @param env The name of the environment to create
-     * @returns The same or created environment.
-     */
-    addEnvironment(env: string, opts?: IAppProjectEnvironmentCreateOptions): Environment;
-    /**
-     * @param key The environment key to read.
-     */
-    getEnvironment(key: string): Environment | undefined;
-    /**
-     * 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): Environment | undefined;
-    /**
-     * This is a link to the `getEnvironments()`. The difference is that on the
-     * project level it won't return environments defined with the class initialization.
-     */
-    listEnvironments(): Environment[];
-    /**
-     * @returns The list of environments defined in this folder
-     */
-    getEnvironments(): Environment[];
-}
-/**
- * An app project is similar to the HttpProject but stored for a single application
- * and has no sharing options. The AppProject can be upgraded to an HttpProject.
- */
-export declare class AppProject extends AppProjectParent {
-    /**
-     * Timestamp when the project was last updated.
-     */
-    updated: number;
-    /**
-     * Timestamp when the project was created.
-     */
-    created: number;
-    definitions: AppProjectDefinitions;
-    /**
-     * Creates a new ARC project from a name.
-     * @param name The name to set.
-     */
-    static fromName(name: string): AppProject;
-    /**
-     * Creates an HTTP project instance from ARC's legacy project definition.
-     *
-     * Note, the `requests` should be processed and the payload restored to it's original value.
-     */
-    static fromLegacyProject(project: ARCProject, requests: ARCSavedRequest[]): Promise<AppProject>;
-    constructor(input?: string | IAppProject);
-    new(init: IAppProject): void;
-    toJSON(): IAppProject;
-    setItems(items?: IAppProjectItem[]): void;
-    /**
-     * Finds a parent of a definition.
-     *
-     * @param  key The key of the definition.
-     * @returns The parent or undefine when not found.
-     */
-    findParent(key: string): AppProjectFolder | AppProject | undefined;
-    /**
-     * Appends an instance of a folder to a project.
-     *
-     * @param folder The folder to add to this project.
-     * @param opts Optional folder add options.
-     * @returns The added folder.
-     */
-    addFolder(folder: AppProjectFolder, opts?: IAppProjectFolderCreateOptions): AppProjectFolder;
-    /**
-     * Appends new folder to a project from a full folder schema.
-     * This is primarily used to insert a folder on the client side
-     * after a folder was created in the store.
-     *
-     * @param folder The folder schema to add to this project.
-     * @param opts Optional folder add options.
-     * @returns The added folder.
-     */
-    addFolder(folder: IAppProjectParent, opts?: IAppProjectFolderCreateOptions): AppProjectFolder;
-    /**
-     * Appends a new folder to the project or a sub-folder.
-     *
-     * @param name The name to set. Optional.
-     * @param opts Folder create options.
-     * @returns The newly inserted folder. If the folder already existed it returns its instance.
-     */
-    addFolder(name?: string, opts?: IAppProjectFolderCreateOptions): AppProjectFolder;
-    /**
-     * 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?: IAppProjectFolderSearchOptions): AppProjectFolder | undefined;
-    /**
-     * 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?: IAppProjectFolderDeleteOptions): AppProjectFolder | undefined;
-    /**
-     * 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?: IAppProjectProjectMoveOptions): void;
-    /**
-     * 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;
-    /**
-     * Adds a request to the project or a sub-folder.
-     *
-     * @param url The URL of the request.
-     * @param opts The request add options.
-     * @returns The inserted into the definitions request.
-     */
-    addRequest(url: string, opts?: IAppProjectRequestAddOptions): AppProjectRequest;
-    /**
-     * Adds a request to the project or a sub-folder.
-     *
-     * @param request The request to add.
-     * @param opts The request add options.
-     * @returns The inserted into the definitions request.
-     */
-    addRequest(request: IAppProjectRequest | AppProjectRequest, opts?: IAppProjectRequestAddOptions): AppProjectRequest;
-    /**
-     * 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.
-     */
-    addLegacyRequest(legacy: ARCSavedRequest | ARCHistoryRequest): Promise<AppProjectRequest>;
-    /**
-     * 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?: IAppProjectRequestSearchOptions): AppProjectRequest | 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?: IAppProjectRequestDeleteOptions): AppProjectRequest | undefined;
-    /**
-     * 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?: IAppProjectProjectMoveOptions): void;
-    /**
-     * Lists items (not the actual definitions!) that are folders.
-     */
-    listFolderItems(): AppProjectItem[];
-    /**
-     * Lists items (not the actual definitions!) that are requests.
-     */
-    listRequestItems(): AppProjectItem[];
-    /**
-     * Lists folders from the project or a sub-folder.
-     * @param opts Folder listing options.
-     */
-    listFolders(opts?: IAppProjectFolderListOptions): AppProjectFolder[];
-    /**
-     * 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): AppProjectRequest[];
-    /**
-     * 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): (AppProjectFolder | AppProjectRequest | Environment)[];
-    /**
-     * @returns On the project level this always returns undefined.
-     */
-    getParent(): AppProjectFolder | AppProject | undefined;
-    getProject(): AppProject;
-    /**
-     * Makes a copy of this project.
-     */
-    clone(opts?: IAppProjectProjectCloneOptions): AppProject;
-    static clone(project: IAppProject, opts?: IAppProjectProjectCloneOptions): AppProject;
-    /**
-     * 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: AppProject): void;
-    /**
-     * Adds an environment to the project.
-     *
-     * @param env The definition of the environment to use to create the environment
-     * @returns The same or created environment.
-     */
-    addEnvironment(env: IEnvironment, opts?: IAppProjectEnvironmentCreateOptions): Environment;
-    /**
-     * Adds an environment to the project.
-     *
-     * @param env The instance of the environment to add
-     * @returns The same or created environment.
-     */
-    addEnvironment(env: Environment, opts?: IAppProjectEnvironmentCreateOptions): Environment;
-    /**
-     * Adds an environment to the project.
-     *
-     * @param env The name of the environment to create
-     * @returns The same or created environment.
-     */
-    addEnvironment(env: string, opts?: IAppProjectEnvironmentCreateOptions): Environment;
-    protected _createEnv(env: IEnvironment | Environment | string): Environment;
-    /**
-     * @param key The environment key to read.
-     */
-    getEnvironment(key: string, opts?: IAppProjectItemOptions): Environment | undefined;
-    /**
-     * 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?: IAppProjectItemOptions): Environment | undefined;
-    /**
-     * This method is a link to `listEnvironments()` to be compatible with the HttpProject.
-     *
-     * @returns The list of environments defined in this folder
-     */
-    getEnvironments(opts?: IAppProjectItemOptions): Environment[];
-    /**
-     * 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?: IAppProjectItemOptions): Environment[];
-    /**
-     * 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?: IAppProjectReadEnvironmentOptions): Environment[];
-    /**
-     * 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;
-    /**
-     * Depending on the options returns a project or a folder.
-     * It throws when parent folder cannot ber found.
-     */
-    protected _getRoot(opts: {
-        parent?: string;
-    }): AppProjectFolder | AppProject;
-    protected _insertItem(item: AppProjectItem, root: AppProjectFolder | AppProject, opts: IAppProjectItemCreateOptions): void;
-    /**
-     * 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;
-    /**
-     * 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;
-    /**
-     * 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;
-    /**
-     * 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): AppProjectRequest[];
-    /**
-     * Iterates over requests in the project.
-     */
-    requestIterator(opts?: IProjectRequestIterator): Generator<AppProjectRequest>;
-}
-/**
- * This model represents a meta data for an AppProject stored with the data store.
- * This does not include the AppProject entity, though, it is referenced through the same key.
- */
-export interface IAppProjectFile extends IFile {
-    kind: typeof AppProjectFileKind;
-}
-export declare class AppProjectFile extends File {
-    kind: string;
-    static fromProject(project: AppProject | IAppProject): AppProjectFile;
-    constructor(input?: string | IAppProjectFile);
-    new(init: IAppProjectFile): void;
-    static isProject(input: unknown): boolean;
-    toJSON(): IAppProjectFile;
-}