@api-client/core 0.3.0

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

@@ -0,0 +1,213 @@
+import { ProjectParent } from './ProjectParent.js';
+import { IProjectDefinitionProperty } from './ProjectDefinitionProperty.js';
+import { ProjectItem, IProjectItem } from './ProjectItem.js';
+import { ProjectRequest, IProjectRequest } from './ProjectRequest.js';
+import { HttpProject } from './HttpProject.js';
+import { IThing } from './Thing.js';
+export declare const Kind = "ARC#ProjectFolder";
+export declare const DefaultFolderName = "New folder";
+export interface IFolderAddOptions {
+    /**
+     * Optionally the position at which to add the request into the list of items.
+     */
+    index?: number;
+}
+export interface IFolderCloneOptions {
+    /**
+     * 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?: HttpProject;
+    /**
+     * 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 IProjectFolder extends IProjectDefinitionProperty {
+    kind: typeof Kind;
+    /**
+     * The identifier of the folder.
+     */
+    key: string;
+    /**
+     * Folder meta
+     */
+    info: IThing;
+    /**
+     * 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 environments defined for this project.
+     * If not set it is inherited from the parent.
+     */
+    environments?: string[];
+    /**
+     * Timestamp when the folder was last updated.
+     */
+    updated: number;
+    /**
+     * Timestamp when the folder was created.
+     */
+    created: number;
+}
+/**
+ * Represents a folder, a group of requests or other folders, in a folder.
+ */
+export declare class ProjectFolder extends ProjectParent {
+    /**
+     * The default name of the folder.
+     */
+    static get defaultName(): string;
+    kind: string;
+    /**
+     * A reference to the top level project object.
+     */
+    project: HttpProject;
+    /**
+     * Timestamp when the folder was last updated.
+     */
+    updated: number;
+    /**
+     * Timestamp when the folder was created.
+     */
+    created: number;
+    constructor(project: HttpProject, input?: string | IProjectFolder);
+    /**
+     * Creates a new project folder clearing anything that is so far defined.
+     *
+     * Note, this throws an error when the project folder is not an ARC project folder.
+     */
+    new(init: IProjectFolder): void;
+    /**
+     * Checks whether the input is a definition of a project folder.
+     */
+    static isProjectFolder(input: unknown): boolean;
+    toJSON(): IProjectFolder;
+    /**
+     * Creates a new ProjectFolder object from a name.
+     * @param project The top-most project.
+     * @param name The name to set.
+     */
+    static fromName(project: HttpProject, name?: string): ProjectFolder;
+    /**
+     * Appends an instance of a folder to a project.
+     *
+     * @param folder The folder to add to this project.
+     * @returns The added folder.
+     */
+    addFolder(folder: ProjectFolder): ProjectFolder;
+    /**
+     * 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: IProjectFolder): ProjectFolder;
+    /**
+     * 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): ProjectFolder;
+    /**
+     * 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?: IFolderAddOptions): ProjectRequest;
+    /**
+     * 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: IProjectRequest | ProjectRequest, opts?: IFolderAddOptions): ProjectRequest;
+    /**
+     * Lists items (not the actual definitions!) that are folders.
+     */
+    listFolderItems(): ProjectItem[];
+    /**
+     * Lists items (not the actual definitions!) that are requests.
+     */
+    listRequestItems(): ProjectItem[];
+    /**
+     * Lists folders in this folder.
+     */
+    listFolders(): ProjectFolder[];
+    /**
+     * Lists requests in this folder.
+     */
+    listRequests(): ProjectRequest[];
+    /**
+     * The callback called when the object is attached to a parent.
+     * This is called when the object is created and inserted to a project or a folder
+     * and when the object is moved between folders.
+     */
+    attachedCallback(): void;
+    /**
+     * The callback called when the object is detached from its parent.
+     * This callback is called when the item is deleted from a folder or a project,
+     * or when the item is about to be moved to another folder.
+     */
+    detachedCallback(): void;
+    /**
+     * @returns The instance of the HttpProject or a ProjectFolder that is a closes parent of this instance.
+     */
+    getParent(): ProjectFolder | HttpProject | undefined;
+    /**
+     * @returns A reference to the parent folder or the top-level HTTP project.
+     */
+    getProject(): HttpProject;
+    /**
+     * 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?: IFolderCloneOptions): ProjectFolder;
+    /**
+     * 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: ProjectFolder, project: HttpProject): 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: ProjectFolder, project: HttpProject, withRequests?: boolean): void;
+}

package/build/src/models/ProjectFolder.js

@@ -0,0 +1,314 @@
+import { ProjectParent } from './ProjectParent.js';
+import { ProjectItem } from './ProjectItem.js';
+import { Kind as ProjectRequestKind } from './ProjectRequest.js';
+import { Thing, Kind as ThingKind } from './Thing.js';
+import v4 from '../lib/uuid.js';
+export const Kind = 'ARC#ProjectFolder';
+export const DefaultFolderName = 'New folder';
+/**
+ * Represents a folder, a group of requests or other folders, in a folder.
+ */
+export class ProjectFolder extends ProjectParent {
+    /**
+     * The default name of the folder.
+     */
+    static get defaultName() {
+        return DefaultFolderName;
+    }
+    kind = Kind;
+    /**
+     * A reference to the top level project object.
+     */
+    project;
+    /**
+     * Timestamp when the folder was last updated.
+     */
+    updated = 0;
+    /**
+     * Timestamp when the folder was created.
+     */
+    created = 0;
+    constructor(project, input) {
+        super();
+        this.project = project;
+        let init;
+        if (typeof input === 'string') {
+            init = JSON.parse(input);
+        }
+        else if (typeof input === 'object') {
+            init = input;
+        }
+        else {
+            const now = Date.now();
+            init = {
+                kind: Kind,
+                info: {
+                    kind: ThingKind,
+                    name: DefaultFolderName,
+                },
+                created: now,
+                updated: now,
+                items: [],
+                key: v4(),
+            };
+        }
+        this.new(init);
+    }
+    /**
+     * Creates a new project folder clearing anything that is so far defined.
+     *
+     * Note, this throws an error when the project folder is not an ARC project folder.
+     */
+    new(init) {
+        if (!ProjectFolder.isProjectFolder(init)) {
+            throw new Error(`Not an ARC project folder.`);
+        }
+        const { key = v4(), created = Date.now(), updated = Date.now(), items, environments, info } = init;
+        this.kind = Kind;
+        this.key = key;
+        this.created = created;
+        this.updated = updated;
+        if (Array.isArray(items)) {
+            this.items = items.map(i => new ProjectItem(this.project, i));
+        }
+        else {
+            this.items = [];
+        }
+        if (info) {
+            this.info = new Thing(info);
+        }
+        else {
+            this.info = new Thing({ kind: ThingKind, name: DefaultFolderName });
+        }
+        if (Array.isArray(environments)) {
+            this.environments = environments;
+        }
+        else {
+            this.environments = [];
+        }
+    }
+    /**
+     * Checks whether the input is a definition of a project folder.
+     */
+    static isProjectFolder(input) {
+        const typed = input;
+        if (!input || typed.kind !== Kind) {
+            return false;
+        }
+        return true;
+    }
+    toJSON() {
+        const result = {
+            kind: Kind,
+            info: this.info.toJSON(),
+            key: this.key,
+            created: this.created,
+            updated: this.updated,
+            items: [],
+            environments: [],
+        };
+        if (Array.isArray(this.items)) {
+            result.items = this.items.map(i => i.toJSON());
+        }
+        if (Array.isArray(this.environments)) {
+            result.environments = this.environments;
+        }
+        return result;
+    }
+    /**
+     * Creates a new ProjectFolder object from a name.
+     * @param project The top-most project.
+     * @param name The name to set.
+     */
+    static fromName(project, name = DefaultFolderName) {
+        const now = Date.now();
+        const key = v4();
+        const info = new Thing({ kind: ThingKind, name });
+        const definition = new ProjectFolder(project, {
+            key,
+            created: now,
+            updated: now,
+            items: [],
+            environments: [],
+            kind: Kind,
+            info: info.toJSON(),
+        });
+        return definition;
+    }
+    /**
+     * Appends a new folder to the folder. It updates the project to add the request definition.
+     * @param name The name to set. Optional.
+     * @returns The key of newly inserted folder.
+     */
+    addFolder(name) {
+        return this.project.addFolder(name, { parent: this.key });
+    }
+    /**
+     * Appends a new request to the folder. It updates the project to add the request definition.
+     * @param request The request to append to the folder.
+     * @returns The key of newly inserted request.
+     */
+    addRequest(request, opts = {}) {
+        const addOptions = { parent: this.key, ...opts };
+        if (typeof request === 'string') {
+            return this.project.addRequest(request, addOptions);
+        }
+        return this.project.addRequest(request, addOptions);
+    }
+    /**
+     * Lists items (not the actual definitions!) that are folders.
+     */
+    listFolderItems() {
+        const { items = [] } = this;
+        return items.filter(i => i.kind === Kind);
+    }
+    /**
+     * Lists items (not the actual definitions!) that are requests.
+     */
+    listRequestItems() {
+        const { items = [] } = this;
+        return items.filter(i => i.kind === ProjectRequestKind);
+    }
+    /**
+     * Lists folders in this folder.
+     */
+    listFolders() {
+        return this.project.listFolders({ folder: this.key });
+    }
+    /**
+     * Lists requests in this folder.
+     */
+    listRequests() {
+        return this.project.listRequests(this.key);
+    }
+    /**
+     * The callback called when the object is attached to a parent.
+     * This is called when the object is created and inserted to a project or a folder
+     * and when the object is moved between folders.
+     */
+    attachedCallback() {
+        // ...
+    }
+    /**
+     * The callback called when the object is detached from its parent.
+     * This callback is called when the item is deleted from a folder or a project,
+     * or when the item is about to be moved to another folder.
+     */
+    detachedCallback() {
+        // ...
+    }
+    /**
+     * @returns The instance of the HttpProject or a ProjectFolder that is a closes parent of this instance.
+     */
+    getParent() {
+        const { project, key } = this;
+        return project.findParent(key);
+    }
+    /**
+     * @returns A reference to the parent folder or the top-level HTTP project.
+     */
+    getProject() {
+        return this.project;
+    }
+    /**
+     * Removes this folder from the project.
+     */
+    remove() {
+        this.project.removeFolder(this.key);
+    }
+    /**
+     * 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 = {}) {
+        const { targetProject = this.project, targetFolder } = opts;
+        const copy = new ProjectFolder(targetProject, this.toJSON());
+        copy.key = v4();
+        const extProject = targetProject !== this.project;
+        if (extProject) {
+            if (targetFolder) {
+                const parent = targetProject.findFolder(targetFolder, { keyOnly: true });
+                if (!parent) {
+                    throw new Error(`The target project does not contain the folder ${targetFolder}`);
+                }
+                parent.addFolder(copy);
+            }
+            else {
+                targetProject.addFolder(copy);
+            }
+        }
+        else {
+            const parent = targetFolder ? this.project.findFolder(targetFolder, { keyOnly: true }) : this.getParent();
+            if (parent) {
+                parent.addFolder(copy);
+            }
+            else {
+                throw new Error(`Unable to locate a parent of the folder.`);
+            }
+        }
+        // removes all items. Depending on the passed option we re-add them next.
+        copy.items = [];
+        if (!opts.withoutRequests) {
+            this.cloneRequests(copy, this.project);
+        }
+        if (!opts.withoutFolders) {
+            this.cloneSubFolders(copy, this.project, !opts.withoutRequests);
+        }
+        return copy;
+    }
+    /**
+     * 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
+     */
+    cloneRequests(folder, project) {
+        const requests = this.items.filter(i => i.kind === ProjectRequestKind);
+        requests.forEach(r => {
+            const request = project.findRequest(r.key, { keyOnly: true });
+            if (!request) {
+                // Should we throw an error here?
+                // CONS:
+                // - It's not really related to the operation. It means there is an inconsistency in the project. That's the role of the project class.
+                // - Ignoring this would allow us to make a copy that is error free.
+                // - The error may occur in a situation when the user does not expect it (giving the nature of the error)
+                // Pros:
+                // - There's an inconsistency in the project definition that should be reported back to the UI for the user to inspect
+                return;
+            }
+            const copy = request.clone({ withoutAttach: true });
+            copy.project = folder.getProject();
+            folder.addRequest(copy);
+        });
+    }
+    /**
+     * 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.
+     */
+    cloneSubFolders(folder, project, withRequests = true) {
+        const folders = this.items.filter(i => i.kind === Kind);
+        folders.forEach(f => {
+            const definition = project.findFolder(f.key, { keyOnly: true });
+            if (!definition) {
+                return;
+            }
+            const copy = new ProjectFolder(folder.getProject(), definition.toJSON());
+            copy.key = v4();
+            copy.items = [];
+            folder.addFolder(copy);
+            if (withRequests) {
+                definition.cloneRequests(copy, project);
+            }
+            definition.cloneSubFolders(copy, project, withRequests);
+        });
+    }
+}
+//# sourceMappingURL=ProjectFolder.js.map

package/build/src/models/ProjectFolder.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ProjectFolder.js","sourceRoot":"","sources":["../../../src/models/ProjectFolder.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAEnD,OAAO,EAAE,WAAW,EAAgB,MAAM,kBAAkB,CAAC;AAC7D,OAAO,EAAkB,IAAI,IAAI,kBAAkB,EAAmB,MAAM,qBAAqB,CAAC;AAElG,OAAO,EAAU,KAAK,EAAE,IAAI,IAAI,SAAS,EAAE,MAAM,YAAY,CAAC;AAC9D,OAAO,EAAE,MAAM,gBAAgB,CAAC;AAEhC,MAAM,CAAC,MAAM,IAAI,GAAG,mBAAmB,CAAC;AACxC,MAAM,CAAC,MAAM,iBAAiB,GAAG,YAAY,CAAC;AAkE9C;;GAEG;AACH,MAAM,OAAO,aAAc,SAAQ,aAAa;IAC9C;;OAEG;IACH,MAAM,KAAK,WAAW;QACpB,OAAO,iBAAiB,CAAC;IAC3B,CAAC;IAED,IAAI,GAAG,IAAI,CAAC;IACZ;;OAEG;IACH,OAAO,CAAc;IACrB;;OAEG;IACH,OAAO,GAAG,CAAC,CAAC;IACZ;;OAEG;IACH,OAAO,GAAG,CAAC,CAAC;IAEZ,YAAY,OAAoB,EAAE,KAA+B;QAC/D,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,IAAoB,CAAC;QACzB,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;YAC7B,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;SAC1B;aAAM,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;YACpC,IAAI,GAAG,KAAK,CAAC;SACd;aAAM;YACL,MAAM,GAAG,GAAW,IAAI,CAAC,GAAG,EAAE,CAAC;YAC/B,IAAI,GAAG;gBACL,IAAI,EAAE,IAAI;gBACV,IAAI,EAAE;oBACJ,IAAI,EAAE,SAAS;oBACf,IAAI,EAAE,iBAAiB;iBACxB;gBACD,OAAO,EAAE,GAAG;gBACZ,OAAO,EAAE,GAAG;gBACZ,KAAK,EAAE,EAAE;gBACT,GAAG,EAAE,EAAE,EAAE;aACV,CAAC;SACH;QACD,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IACjB,CAAC;IAED;;;;OAIG;IACH,GAAG,CAAC,IAAoB;QACtB,IAAI,CAAC,aAAa,CAAC,eAAe,CAAC,IAAI,CAAC,EAAE;YACxC,MAAM,IAAI,KAAK,CAAC,4BAA4B,CAAC,CAAC;SAC/C;QACD,MAAM,EAAE,GAAG,GAAG,EAAE,EAAE,EAAE,OAAO,GAAG,IAAI,CAAC,GAAG,EAAE,EAAE,OAAO,GAAG,IAAI,CAAC,GAAG,EAAE,EAAE,KAAK,EAAE,YAAY,EAAE,IAAI,EAAE,GAAG,IAAI,CAAC;QACnG,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;QACf,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;YACxB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,WAAW,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,CAAC;SAC/D;aAAM;YACL,IAAI,CAAC,KAAK,GAAG,EAAE,CAAC;SACjB;QACD,IAAI,IAAI,EAAE;YACR,IAAI,CAAC,IAAI,GAAG,IAAI,KAAK,CAAC,IAAI,CAAC,CAAC;SAC7B;aAAM;YACL,IAAI,CAAC,IAAI,GAAG,IAAI,KAAK,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,iBAAiB,EAAE,CAAC,CAAC;SACrE;QACD,IAAI,KAAK,CAAC,OAAO,CAAC,YAAY,CAAC,EAAE;YAC/B,IAAI,CAAC,YAAY,GAAG,YAAY,CAAC;SAClC;aAAM;YACL,IAAI,CAAC,YAAY,GAAG,EAAE,CAAC;SACxB;IACH,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,eAAe,CAAC,KAAc;QACnC,MAAM,KAAK,GAAG,KAAuB,CAAC;QACtC,IAAI,CAAC,KAAK,IAAI,KAAK,CAAC,IAAI,KAAK,IAAI,EAAE;YACjC,OAAO,KAAK,CAAC;SACd;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,MAAM;QACJ,MAAM,MAAM,GAAmB;YAC7B,IAAI,EAAE,IAAI;YACV,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE;YACxB,GAAG,EAAE,IAAI,CAAC,GAAG;YACb,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,KAAK,EAAE,EAAE;YACT,YAAY,EAAE,EAAE;SACjB,CAAC;QACF,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE;YAC7B,MAAM,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC;SAChD;QACD,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,YAAY,CAAC,EAAE;YACpC,MAAM,CAAC,YAAY,GAAG,IAAI,CAAC,YAAY,CAAC;SACzC;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,QAAQ,CAAC,OAAoB,EAAE,IAAI,GAAG,iBAAiB;QAC5D,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QACvB,MAAM,GAAG,GAAG,EAAE,EAAE,CAAC;QACjB,MAAM,IAAI,GAAG,IAAI,KAAK,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QAClD,MAAM,UAAU,GAAG,IAAI,aAAa,CAAC,OAAO,EAAE;YAC5C,GAAG;YACH,OAAO,EAAE,GAAG;YACZ,OAAO,EAAE,GAAG;YACZ,KAAK,EAAE,EAAE;YACT,YAAY,EAAE,EAAE;YAChB,IAAI,EAAE,IAAI;YACV,IAAI,EAAE,IAAI,CAAC,MAAM,EAAE;SACpB,CAAC,CAAC;QACH,OAAO,UAAU,CAAC;IACpB,CAAC;IA4BD;;;;OAIG;IACH,SAAS,CAAC,IAAyD;QACjE,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,IAAqB,EAAE,EAAE,MAAM,EAAE,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC;IAC7E,CAAC;IAoBD;;;;OAIG;IACH,UAAU,CAAC,OAAkD,EAAE,OAA0B,EAAE;QACzF,MAAM,UAAU,GAAG,EAAE,MAAM,EAAE,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,EAAE,CAAC;QACjD,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE;YAC/B,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;SACrD;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;IACtD,CAAC;IAED;;OAEG;IACH,eAAe;QACb,MAAM,EAAE,KAAK,GAAG,EAAE,EAAE,GAAG,IAAI,CAAC;QAC5B,OAAO,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC;IAC5C,CAAC;IAED;;OAEG;IACH,gBAAgB;QACd,MAAM,EAAE,KAAK,GAAG,EAAE,EAAE,GAAG,IAAI,CAAC;QAC5B,OAAO,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,kBAAkB,CAAC,CAAC;IAC1D,CAAC;IAED;;OAEG;IACH,WAAW;QACT,OAAO,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC;IACxD,CAAC;IAED;;OAEG;IACH,YAAY;QACV,OAAO,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAC7C,CAAC;IAED;;;;OAIG;IACH,gBAAgB;QACd,MAAM;IACR,CAAC;IAED;;;;OAIG;IACH,gBAAgB;QACd,MAAM;IACR,CAAC;IAED;;OAEG;IACH,SAAS;QACP,MAAM,EAAE,OAAO,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC;QAC9B,OAAO,OAAO,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;IACjC,CAAC;IAED;;OAEG;IACH,UAAU;QACR,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAED;;OAEG;IACH,MAAM;QACJ,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACtC,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,OAA4B,EAAE;QAClC,MAAM,EAAE,aAAa,GAAC,IAAI,CAAC,OAAO,EAAE,YAAY,EAAE,GAAG,IAAI,CAAC;QAC1D,MAAM,IAAI,GAAG,IAAI,aAAa,CAAC,aAAa,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;QAC7D,IAAI,CAAC,GAAG,GAAG,EAAE,EAAE,CAAC;QAEhB,MAAM,UAAU,GAAG,aAAa,KAAK,IAAI,CAAC,OAAO,CAAC;QAClD,IAAI,UAAU,EAAE;YACd,IAAI,YAAY,EAAE;gBAChB,MAAM,MAAM,GAAG,aAAa,CAAC,UAAU,CAAC,YAAY,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC;gBACzE,IAAI,CAAC,MAAM,EAAE;oBACX,MAAM,IAAI,KAAK,CAAC,kDAAkD,YAAY,EAAE,CAAC,CAAC;iBACnF;gBACD,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;aACxB;iBAAM;gBACL,aAAa,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;aAC/B;SACF;aAAM;YACL,MAAM,MAAM,GAAG,YAAY,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,YAAY,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC;YAC1G,IAAI,MAAM,EAAE;gBACV,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;aACxB;iBAAM;gBACL,MAAM,IAAI,KAAK,CAAC,0CAA0C,CAAC,CAAC;aAC7D;SACF;QACD,yEAAyE;QACzE,IAAI,CAAC,KAAK,GAAG,EAAE,CAAC;QAEhB,IAAI,CAAC,IAAI,CAAC,eAAe,EAAE;YACzB,IAAI,CAAC,aAAa,CAAC,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;SACxC;QACD,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE;YACxB,IAAI,CAAC,eAAe,CAAC,IAAI,EAAE,IAAI,CAAC,OAAO,EAAE,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;SACjE;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;OAKG;IACO,aAAa,CAAC,MAAqB,EAAE,OAAoB;QACjE,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,kBAAkB,CAAC,CAAC;QACvE,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE;YACnB,MAAM,OAAO,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,GAAG,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC;YAC9D,IAAI,CAAC,OAAO,EAAE;gBACZ,iCAAiC;gBACjC,QAAQ;gBACR,uIAAuI;gBACvI,oEAAoE;gBACpE,yGAAyG;gBACzG,QAAQ;gBACR,sHAAsH;gBACtH,OAAO;aACR;YACD,MAAM,IAAI,GAAG,OAAO,CAAC,KAAK,CAAC,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC,CAAC;YACpD,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,UAAU,EAAE,CAAC;YACnC,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;QAC1B,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;;OAMG;IACO,eAAe,CAAC,MAAqB,EAAE,OAAoB,EAAE,YAAY,GAAG,IAAI;QACxF,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC;QACxD,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE;YAClB,MAAM,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,GAAG,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC;YAChE,IAAI,CAAC,UAAU,EAAE;gBACf,OAAO;aACR;YACD,MAAM,IAAI,GAAG,IAAI,aAAa,CAAC,MAAM,CAAC,UAAU,EAAE,EAAE,UAAU,CAAC,MAAM,EAAE,CAAC,CAAC;YACzE,IAAI,CAAC,GAAG,GAAG,EAAE,EAAE,CAAC;YAChB,IAAI,CAAC,KAAK,GAAG,EAAE,CAAC;YAChB,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;YACvB,IAAI,YAAY,EAAE;gBAChB,UAAU,CAAC,aAAa,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;aACzC;YACD,UAAU,CAAC,eAAe,CAAC,IAAI,EAAE,OAAO,EAAE,YAAY,CAAC,CAAC;QAC1D,CAAC,CAAC,CAAC;IACL,CAAC;CACF"}

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

@@ -0,0 +1,59 @@
+import { Kind as ProjectFolderKind, ProjectFolder } from './ProjectFolder.js';
+import { Kind as ProjectRequestKind, ProjectRequest } from './ProjectRequest.js';
+import { HttpProject } from './HttpProject.js';
+export interface IProjectItem {
+    /**
+     * The kind of the item.
+     */
+    kind: typeof ProjectFolderKind | typeof ProjectRequestKind;
+    /**
+     * The identifier in the `definitions` array of the project.
+     */
+    key: string;
+}
+export declare class ProjectItem {
+    /**
+     * The kind of the item.
+     */
+    kind: typeof ProjectFolderKind | typeof ProjectRequestKind;
+    /**
+     * The identifier of the object in the `definitions` array of the project.
+     */
+    key: string;
+    /**
+     * A reference to the top level project object.
+     */
+    private project;
+    /**
+     * Checks whether the input is a definition of a project item.
+     */
+    static isProjectItem(input: unknown): boolean;
+    /**
+     * @return An instance that represents a request object
+     */
+    static projectRequest(project: HttpProject, key: string): ProjectItem;
+    /**
+     * @return An instance that represents a folder object
+     */
+    static projectFolder(project: HttpProject, key: string): ProjectItem;
+    /**
+     * @param project The top-most project.
+     * @param input The project item definition used to restore the state.
+     */
+    constructor(project: HttpProject, input: string | IProjectItem);
+    /**
+     * Creates a new project item clearing anything that is so far defined.
+     *
+     * Note, this throws an error when the project item is not an ARC project item.
+     */
+    new(init: IProjectItem): void;
+    toJSON(): IProjectItem;
+    /**
+     * @returns The instance of the definition associated with this item.
+     */
+    getItem(): ProjectFolder | ProjectRequest | undefined;
+    /**
+     * @returns The instance of the HttpProject or a ProjectFolder that is a closes parent of this item.
+     */
+    getParent(): ProjectFolder | HttpProject | undefined;
+}