@api-client/core 0.9.24 → 0.10.0

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

@@ -0,0 +1,152 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ProjectExecution = exports.Kind = void 0;
+const json_1 = require("@api-client/json");
+exports.Kind = 'Core#ProjectExecution';
+class ProjectExecution {
+    kind = exports.Kind;
+    /**
+     * The key of the execution entry. This is generated by the store. Client value is ignored.
+     */
+    key = '';
+    /**
+     * The key of the parent project.
+     */
+    project = '';
+    /**
+     * The key of the parent folder, if any.
+     */
+    parent;
+    /**
+     * The application id that generated the entry.
+     */
+    app = '';
+    /**
+     * The user id that made that request.
+     * This is only available when the store support multi-user environment.
+     */
+    user;
+    /**
+     * @param value The timestamp of the midnight when the request object was updated
+     */
+    set midnight(value) {
+        if (!value) {
+            this.midnightInternal = this.defaultMidnight();
+        }
+        else {
+            this.midnightInternal = value;
+        }
+    }
+    /**
+     * @returns The timestamp of the midnight when the request object was updated
+     */
+    get midnight() {
+        if (this.midnightInternal) {
+            return this.midnightInternal;
+        }
+        return this.defaultMidnight();
+    }
+    midnightInternal = 0;
+    /**
+     * The timestamp when the execution started
+     */
+    started = 0;
+    /**
+     * The timestamp when the execution ended
+     */
+    ended = 0;
+    /**
+     * The execution logs for each iteration.
+     */
+    iterations = [];
+    constructor(input) {
+        let init;
+        if (typeof input === 'string') {
+            init = JSON.parse(input);
+        }
+        else if (typeof input === 'object') {
+            init = input;
+        }
+        else {
+            const now = Date.now();
+            init = {
+                kind: exports.Kind,
+                user: '',
+                app: '',
+                key: '',
+                project: '',
+                ended: 0,
+                iterations: [],
+                midnight: 0,
+                started: now,
+            };
+        }
+        this.new(init);
+    }
+    new(init) {
+        const { started = Date.now(), midnight, project, user, key, app, ended = started, iterations, parent } = init;
+        this.started = started;
+        this.ended = ended;
+        this.iterations = iterations.map(i => json_1.Core.clone(i));
+        if (key) {
+            this.key = key;
+        }
+        else {
+            this.key = '';
+        }
+        if (app) {
+            this.app = app;
+        }
+        else {
+            this.app = '';
+        }
+        if (midnight) {
+            this.midnight = midnight;
+        }
+        if (project) {
+            this.project = project;
+        }
+        else {
+            this.project = '';
+        }
+        if (parent) {
+            this.parent = parent;
+        }
+        else {
+            this.parent = '';
+        }
+        if (user) {
+            this.user = user;
+        }
+        else {
+            this.user = '';
+        }
+    }
+    toJSON() {
+        const result = {
+            kind: exports.Kind,
+            midnight: this.midnight,
+            user: this.user,
+            key: this.key,
+            project: this.project,
+            app: this.app,
+            ended: this.ended,
+            iterations: this.iterations.map(i => json_1.Core.clone(i)),
+            started: this.started,
+        };
+        if (this.parent) {
+            result.parent = this.parent;
+        }
+        return result;
+    }
+    /**
+     * @returns The default value for the midnight when the request was last updated.
+     */
+    defaultMidnight() {
+        const d = new Date(this.started);
+        d.setHours(0, 0, 0, 0);
+        return d.getTime();
+    }
+}
+exports.ProjectExecution = ProjectExecution;
+//# sourceMappingURL=ProjectExecution.js.map

package/build/cjs/src/models/ProjectExecution.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ProjectExecution.js","sourceRoot":"","sources":["../../../../src/models/ProjectExecution.ts"],"names":[],"mappings":";;;AAAA,2CAAmD;AAGtC,QAAA,IAAI,GAAG,uBAAuB,CAAC;AAuE5C,MAAa,gBAAgB;IAC3B,IAAI,GAAgB,YAAI,CAAC;IAEzB;;OAEG;IACH,GAAG,GAAG,EAAE,CAAC;IAET;;OAEG;IACH,OAAO,GAAG,EAAE,CAAC;IAEb;;OAEG;IACH,MAAM,CAAU;IAEhB;;OAEG;IACH,GAAG,GAAG,EAAE,CAAC;IAET;;;OAGG;IACH,IAAI,CAAU;IAEd;;OAEG;IACH,IAAI,QAAQ,CAAC,KAAyB;QACpC,IAAI,CAAC,KAAK,EAAE;YACV,IAAI,CAAC,gBAAgB,GAAG,IAAI,CAAC,eAAe,EAAE,CAAC;SAChD;aAAM;YACL,IAAI,CAAC,gBAAgB,GAAG,KAAK,CAAC;SAC/B;IACH,CAAC;IAED;;OAEG;IACH,IAAI,QAAQ;QACV,IAAI,IAAI,CAAC,gBAAgB,EAAE;YACzB,OAAO,IAAI,CAAC,gBAAgB,CAAC;SAC9B;QACD,OAAO,IAAI,CAAC,eAAe,EAAE,CAAC;IAChC,CAAC;IAEO,gBAAgB,GAAG,CAAC,CAAC;IAE7B;;OAEG;IACH,OAAO,GAAG,CAAC,CAAC;IAEZ;;OAEG;IACH,KAAK,GAAG,CAAC,CAAC;IAEV;;OAEG;IACH,UAAU,GAAiC,EAAE,CAAC;IAG9C,YAAY,KAAkC;QAC5C,IAAI,IAAuB,CAAC;QAC5B,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,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;YACvB,IAAI,GAAG;gBACL,IAAI,EAAE,YAAI;gBACV,IAAI,EAAE,EAAE;gBACR,GAAG,EAAE,EAAE;gBACP,GAAG,EAAE,EAAE;gBACP,OAAO,EAAE,EAAE;gBACX,KAAK,EAAE,CAAC;gBACR,UAAU,EAAE,EAAE;gBACd,QAAQ,EAAE,CAAC;gBACX,OAAO,EAAE,GAAG;aACb,CAAC;SACH;QACD,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IACjB,CAAC;IAED,GAAG,CAAC,IAAuB;QACzB,MAAM,EAAE,OAAO,GAAG,IAAI,CAAC,GAAG,EAAE,EAAE,QAAQ,EAAE,OAAO,EAAE,IAAI,EAAE,GAAG,EAAE,GAAG,EAAE,KAAK,GAAG,OAAO,EAAE,UAAU,EAAG,MAAM,EAAE,GAAG,IAAI,CAAC;QAC/G,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,WAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;QACzD,IAAI,GAAG,EAAE;YACP,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;SAChB;aAAM;YACL,IAAI,CAAC,GAAG,GAAG,EAAE,CAAC;SACf;QACD,IAAI,GAAG,EAAE;YACP,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;SAChB;aAAM;YACL,IAAI,CAAC,GAAG,GAAG,EAAE,CAAC;SACf;QACD,IAAI,QAAQ,EAAE;YACZ,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;SAC1B;QACD,IAAI,OAAO,EAAE;YACX,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;SACxB;aAAM;YACL,IAAI,CAAC,OAAO,GAAG,EAAE,CAAC;SACnB;QACD,IAAI,MAAM,EAAE;YACV,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;SACtB;aAAM;YACL,IAAI,CAAC,MAAM,GAAG,EAAE,CAAC;SAClB;QACD,IAAI,IAAI,EAAE;YACR,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;SAClB;aAAM;YACL,IAAI,CAAC,IAAI,GAAG,EAAE,CAAC;SAChB;IACH,CAAC;IAED,MAAM;QACJ,MAAM,MAAM,GAAsB;YAChC,IAAI,EAAE,YAAI;YACV,QAAQ,EAAE,IAAI,CAAC,QAAQ;YACvB,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,GAAG,EAAE,IAAI,CAAC,GAAG;YACb,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,GAAG,EAAE,IAAI,CAAC,GAAG;YACb,KAAK,EAAE,IAAI,CAAC,KAAK;YACjB,UAAU,EAAE,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,WAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;YACvD,OAAO,EAAE,IAAI,CAAC,OAAO;SACtB,CAAC;QACF,IAAI,IAAI,CAAC,MAAM,EAAE;YACf,MAAM,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;SAC7B;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;OAEG;IACH,eAAe;QACb,MAAM,CAAC,GAAG,IAAI,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACjC,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;QACvB,OAAO,CAAC,CAAC,OAAO,EAAE,CAAC;IACrB,CAAC;CACF;AAxJD,4CAwJC"}

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

@@ -0,0 +1,250 @@
+import { ProjectParent } from './ProjectParent.js';
+import { IProjectDefinitionProperty } from './ProjectDefinitionProperty.js';
+import { ProjectItem, IProjectItem } from './ProjectItem.js';
+import { ProjectRequest, IProjectRequest } from './ProjectRequest.js';
+import { HttpProject, IEnvironmentCreateOptions } from './HttpProject.js';
+import { IThing } from './Thing.js';
+import { Environment, IEnvironment } from './Environment.js';
+import { ProjectFolderKind } from './kinds.js';
+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 ProjectFolderKind;
+    /**
+     * 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[];
+    /**
+     * 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 a 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;
+    /**
+     * 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?: IEnvironmentCreateOptions): 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?: IEnvironmentCreateOptions): 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?: IEnvironmentCreateOptions): Environment;
+    /**
+     * 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;
+    /**
+     * @returns The list of environments defined in this folder
+     */
+    getEnvironments(): 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[];
+    /**
+     * 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;
+}