@api-client/core 0.9.24 → 0.10.0

package/build/esm/src/models/ProjectRequest.js

@@ -0,0 +1,444 @@
+import { Kind as HttpRequestKind } from './HttpRequest.js';
+import v4 from '../lib/uuid.js';
+import { Request } from './Request.js';
+import { Property } from './Property.js';
+import { UriTemplate } from '../lib/parsers/UriTemplate.js';
+import { Thing } from './Thing.js';
+export const Kind = 'Core#ProjectRequest';
+/**
+ * **Note about the payload.**
+ *
+ * The payload is **always** stored in the request object in its serialized form.
+ * Use the `readPayload()` to read the correct data type and the `writePayload()` to
+ * safely store the payload.
+ */
+export class ProjectRequest extends Request {
+    kind = Kind;
+    /**
+     * The identifier of the request.
+     */
+    key = '';
+    /**
+     * A reference to the top level project object.
+     */
+    project;
+    /**
+     * The key of an environment defined on the project to apply to this request.
+     * When not set it inherits environments from parents.
+     * However, when this is set, it makes sure that server/variables from this environment are always applied.
+     */
+    environment;
+    /**
+     * Checks whether the input is a definition of a project folder.
+     */
+    static isProjectRequest(input) {
+        const typed = input;
+        if (!input || typed.kind !== Kind) {
+            return false;
+        }
+        return true;
+    }
+    /**
+     * 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, project) {
+        if (!project) {
+            throw new Error(`The project is required.`);
+        }
+        const now = Date.now();
+        const request = new ProjectRequest(project, {
+            key: v4(),
+            kind: Kind,
+            created: now,
+            updated: now,
+            expects: {
+                kind: HttpRequestKind,
+                method: 'GET',
+                url,
+            },
+            info: Thing.fromName(url).toJSON(),
+        });
+        return request;
+    }
+    /**
+     * 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, project) {
+        if (!project) {
+            throw new Error(`The project is required.`);
+        }
+        const now = Date.now();
+        const request = new ProjectRequest(project, {
+            key: v4(),
+            kind: Kind,
+            created: now,
+            updated: now,
+            expects: {
+                kind: HttpRequestKind,
+                method: 'GET',
+                url: '',
+            },
+            info: Thing.fromName(name).toJSON(),
+        });
+        return request;
+    }
+    /**
+     * 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, project) {
+        if (!project) {
+            throw new Error(`The project is required.`);
+        }
+        const now = Date.now();
+        const request = new ProjectRequest(project, {
+            key: v4(),
+            kind: Kind,
+            created: now,
+            updated: now,
+            expects: {
+                kind: HttpRequestKind,
+                method: info.method,
+                url: info.url,
+                headers: info.headers,
+                payload: info.payload,
+            },
+            info: Thing.fromName(info.url).toJSON(),
+        });
+        return request;
+    }
+    /**
+     * Creates a project request for a schema of a Request.
+     */
+    static fromRequest(request, project) {
+        const key = v4();
+        const init = { ...request, key, kind: Kind };
+        const result = new ProjectRequest(project, init);
+        return result;
+    }
+    constructor(project, input) {
+        super(input);
+        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 = {
+                key: v4(),
+                kind: Kind,
+                created: now,
+                updated: now,
+                expects: {
+                    kind: HttpRequestKind,
+                    method: 'GET',
+                    url: '',
+                },
+                info: Thing.fromName('').toJSON(),
+            };
+        }
+        this.new(init);
+    }
+    new(init) {
+        super.new(init);
+        const { key, environment } = init;
+        this.key = key || v4();
+        if (environment) {
+            this.environment = environment;
+        }
+    }
+    toJSON() {
+        const request = super.toJSON();
+        const result = { ...request, key: this.key, kind: Kind };
+        if (this.environment) {
+            result.environment = this.environment;
+        }
+        return result;
+    }
+    /**
+     * 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 request from the project.
+     */
+    remove() {
+        this.project.removeRequest(this.key);
+    }
+    /**
+     * 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 = {}) {
+        const copy = new ProjectRequest(this.project, this.toJSON());
+        if (!opts.withoutRevalidate) {
+            copy.key = v4();
+        }
+        if (!opts.withoutAttach) {
+            // if the parent is the project then add the request to the project.
+            const parent = this.getParent();
+            if (parent) {
+                parent.addRequest(copy);
+            }
+        }
+        return copy;
+    }
+    /**
+     * 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, project, opts = {}) {
+        const obj = new ProjectRequest(project, request);
+        return obj.clone(opts);
+    }
+    /**
+     * @returns The environment that should be applied to the request, if any.
+     */
+    getEnvironment() {
+        const { environment, project } = this;
+        if (!environment) {
+            return undefined;
+        }
+        let parent = this.getParent();
+        if (parent === project) {
+            parent = undefined;
+        }
+        return project.findEnvironment(environment);
+    }
+    /**
+     * @returns All environments that can be applied to this request.
+     */
+    readEnvironments() {
+        let parent = this.getParent();
+        if (parent === this.project) {
+            parent = undefined;
+        }
+        return this.project.readEnvironments({ parent: parent?.key });
+    }
+    /**
+     * It reads the URL from an environment defined for the request..
+     * The environment servers and variables are applies for all environments defined on each folder down to this request.
+     * This respects the `encapsulate` flag defined on an environment.
+     *
+     * By default it applies variables collected from the environments to the url. You can configure this behavior
+     * by passing a configuration option.
+     *
+     * Note on performance.
+     * This is a heave computing operation so use it sparingly. For best performance only compute the URL when
+     * environments, environment selection or variables change.
+     *
+     * @param opts Read URL options
+     * @returns the read URL or undefined when the URL/environments are not defined.
+     */
+    readUrl(opts = {}) {
+        const { environment } = this;
+        const expects = this.getExpects();
+        // note, this list respects the `encapsulate` flag.
+        const environments = this.readEnvironments();
+        let requestUrl = opts.baseUrl ? undefined : expects.url;
+        if (!environments) {
+            if (requestUrl && opts.variables) {
+                return this.evaluateUri(requestUrl, opts.variables);
+            }
+            return requestUrl || undefined;
+        }
+        // we assume that absolute URL has a scheme with a delimiter (://). However, the scheme value can be an URL.
+        // When the request starts with `/` is obviously a relative (no domain) URL
+        // The edge case is `{` because it may mean a variable with a domain or a path to be appended to the base URI 
+        // defined in an environment. However, we choose to use `/` as the indicator of being a "relative" URL.
+        const isAbsolute = !!requestUrl && !requestUrl.startsWith('/') && requestUrl.includes('://');
+        if (isAbsolute && opts.noVariables) {
+            // we know the URL exists, it is absolute (server wouldn't be applied anyway), and we don't 
+            // want to apply variables. We return what we have so far.
+            return requestUrl;
+        }
+        const flatProperties = [];
+        let effectiveServer;
+        for (const env of environments) {
+            if (env.server && env.server.uri) {
+                effectiveServer = env.server;
+            }
+            if (!opts.noVariables && !opts.variables && env.variables) {
+                for (const prop of env.variables) {
+                    // environments are listed from the project's root down to the folder where the request
+                    // exists. When a folder has a variable that was already defined it is replaced.
+                    this.addProperty(prop, flatProperties);
+                }
+            }
+            if (env.key === environment) {
+                break;
+            }
+        }
+        if (!requestUrl) {
+            // we return whatever we have in the server.
+            if (effectiveServer) {
+                // flatProperties is be empty if `noVariables` option is passed.
+                const uri = effectiveServer.readUri();
+                if (opts.variables) {
+                    return this.evaluateUri(uri, opts.variables);
+                }
+                return this.evaluateUri(uri, flatProperties);
+            }
+            return undefined;
+        }
+        if (isAbsolute) {
+            // ignore server reading and just apply variables to the request URL
+            if (opts.variables) {
+                return this.evaluateUri(requestUrl, opts.variables);
+            }
+            return this.evaluateUri(requestUrl, flatProperties);
+        }
+        let serverUrl = '';
+        if (effectiveServer) {
+            serverUrl = effectiveServer.readUri();
+        }
+        if (!serverUrl.endsWith('/')) {
+            serverUrl += '/';
+        }
+        if (requestUrl.startsWith('/')) {
+            requestUrl = requestUrl.substring(1);
+        }
+        const url = serverUrl + requestUrl;
+        if (opts.variables) {
+            return this.evaluateUri(url, opts.variables);
+        }
+        return this.evaluateUri(url, flatProperties);
+    }
+    addProperty(item, list) {
+        const index = list.findIndex(i => i.name === item.name);
+        if (index >= 0) {
+            list.splice(index, 1);
+        }
+        list.push(item);
+    }
+    /**
+     * Evaluates the URI against variables.
+     *
+     * Note, this doesn't throw errors. When error occurs it returns the input string.
+     *
+     * @param uri The URI to process
+     * @param variables The list of variables to use
+     * @returns Expanded URI.
+     */
+    evaluateUri(uri, variables) {
+        if (!variables) {
+            return uri;
+        }
+        let vars;
+        if (Array.isArray(variables)) {
+            if (variables.length) {
+                vars = Property.toMap(variables);
+            }
+        }
+        else {
+            vars = variables;
+        }
+        if (!vars) {
+            return uri;
+        }
+        let result = uri;
+        try {
+            result = new UriTemplate(uri).expand(vars, { ignoreMissing: true });
+        }
+        catch (e) {
+            // 
+        }
+        return result;
+    }
+    /**
+     * Reads the authorization that should be applied to the request.
+     *
+     * 1) First it returns the locally (on the request) defined authorization.
+     * 2) Then it returns authorization defined on the selected environment.
+     * 3) If has defined environment but no authorization on it, then it returns empty array.
+     * 4) Only if the request has no selected environment then it reads first environment
+     * that has authorization (from the request up to the project's root).
+     */
+    readAuthorization() {
+        if (Array.isArray(this.authorization) && this.authorization.length) {
+            return this.authorization;
+        }
+        const envAuth = this.readEnvironmentAuthorization();
+        if (envAuth) {
+            return envAuth;
+        }
+        if (this.environment) {
+            return [];
+        }
+        const inherited = this.readEnvironmentsAuthorization();
+        if (inherited) {
+            return inherited;
+        }
+        return [];
+    }
+    /**
+     * @returns Authorization defined on the selected environment or undefined.
+     */
+    readEnvironmentAuthorization() {
+        const selfEnv = this.getEnvironment();
+        if (!selfEnv) {
+            return undefined;
+        }
+        if (Array.isArray(selfEnv.authorization) && selfEnv.authorization.length) {
+            return selfEnv.authorization;
+        }
+        return undefined;
+    }
+    /**
+     * @returns Authorization defined on any inherited environment or undefined.
+     */
+    readEnvironmentsAuthorization() {
+        const envs = this.readEnvironments();
+        const authEnv = envs.find(i => Array.isArray(i.authorization) && !!i.authorization.length);
+        if (authEnv) {
+            return authEnv.authorization;
+        }
+        return undefined;
+    }
+}
+//# sourceMappingURL=ProjectRequest.js.map

package/build/esm/src/models/ProjectRequest.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ProjectRequest.js","sourceRoot":"","sources":["../../../../src/models/ProjectRequest.ts"],"names":[],"mappings":"AAEA,OAAO,EAAgB,IAAI,IAAI,eAAe,EAAE,MAAM,kBAAkB,CAAC;AAEzE,OAAO,EAAE,MAAM,gBAAgB,CAAC;AAChC,OAAO,EAAY,OAAO,EAAE,MAAM,cAAc,CAAC;AAEjD,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAEzC,OAAO,EAAE,WAAW,EAAE,MAAM,+BAA+B,CAAC;AAE5D,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AAEnC,MAAM,CAAC,MAAM,IAAI,GAAG,qBAAqB,CAAC;AA+C1C;;;;;;GAMG;AACH,MAAM,OAAO,cAAe,SAAQ,OAAO;IAChC,IAAI,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,GAAG,GAAG,EAAE,CAAC;IAET;;OAEG;IACH,OAAO,CAAc;IAErB;;;;OAIG;IACH,WAAW,CAAU;IAErB;;OAEG;IACH,MAAM,CAAC,gBAAgB,CAAC,KAAc;QACpC,MAAM,KAAK,GAAG,KAAwB,CAAC;QACvC,IAAI,CAAC,KAAK,IAAI,KAAK,CAAC,IAAI,KAAK,IAAI,EAAE;YACjC,OAAO,KAAK,CAAC;SACd;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAU,OAAO,CAAC,GAAW,EAAE,OAAqB;QACxD,IAAI,CAAC,OAAO,EAAE;YACZ,MAAM,IAAI,KAAK,CAAC,0BAA0B,CAAC,CAAC;SAC7C;QACD,MAAM,GAAG,GAAW,IAAI,CAAC,GAAG,EAAE,CAAC;QAC/B,MAAM,OAAO,GAAG,IAAI,cAAc,CAAC,OAAO,EAAE;YAC1C,GAAG,EAAE,EAAE,EAAE;YACT,IAAI,EAAE,IAAI;YACV,OAAO,EAAE,GAAG;YACZ,OAAO,EAAE,GAAG;YACZ,OAAO,EAAE;gBACP,IAAI,EAAE,eAAe;gBACrB,MAAM,EAAE,KAAK;gBACb,GAAG;aACJ;YACD,IAAI,EAAE,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE;SACnC,CAAC,CAAC;QACH,OAAO,OAAO,CAAC;IACjB,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAU,QAAQ,CAAC,IAAY,EAAE,OAAqB;QAC1D,IAAI,CAAC,OAAO,EAAE;YACZ,MAAM,IAAI,KAAK,CAAC,0BAA0B,CAAC,CAAC;SAC7C;QACD,MAAM,GAAG,GAAW,IAAI,CAAC,GAAG,EAAE,CAAC;QAC/B,MAAM,OAAO,GAAG,IAAI,cAAc,CAAC,OAAO,EAAE;YAC1C,GAAG,EAAE,EAAE,EAAE;YACT,IAAI,EAAE,IAAI;YACV,OAAO,EAAE,GAAG;YACZ,OAAO,EAAE,GAAG;YACZ,OAAO,EAAE;gBACP,IAAI,EAAE,eAAe;gBACrB,MAAM,EAAE,KAAK;gBACb,GAAG,EAAE,EAAE;aACR;YACD,IAAI,EAAE,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE;SACpC,CAAC,CAAC;QACH,OAAO,OAAO,CAAC;IACjB,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAU,eAAe,CAAC,IAAkB,EAAE,OAAqB;QACvE,IAAI,CAAC,OAAO,EAAE;YACZ,MAAM,IAAI,KAAK,CAAC,0BAA0B,CAAC,CAAC;SAC7C;QACD,MAAM,GAAG,GAAW,IAAI,CAAC,GAAG,EAAE,CAAC;QAC/B,MAAM,OAAO,GAAG,IAAI,cAAc,CAAC,OAAO,EAAE;YAC1C,GAAG,EAAE,EAAE,EAAE;YACT,IAAI,EAAE,IAAI;YACV,OAAO,EAAE,GAAG;YACZ,OAAO,EAAE,GAAG;YACZ,OAAO,EAAE;gBACP,IAAI,EAAE,eAAe;gBACrB,MAAM,EAAE,IAAI,CAAC,MAAM;gBACnB,GAAG,EAAE,IAAI,CAAC,GAAG;gBACb,OAAO,EAAE,IAAI,CAAC,OAAO;gBACrB,OAAO,EAAE,IAAI,CAAC,OAAO;aACtB;YACD,IAAI,EAAE,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE;SACxC,CAAC,CAAC;QACH,OAAO,OAAO,CAAC;IACjB,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,WAAW,CAAC,OAAiB,EAAE,OAAoB;QACxD,MAAM,GAAG,GAAG,EAAE,EAAE,CAAC;QACjB,MAAM,IAAI,GAAoB,EAAE,GAAG,OAAO,EAAE,GAAG,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC;QAC9D,MAAM,MAAM,GAAG,IAAI,cAAc,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;QACjD,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,YAAY,OAAoB,EAAE,KAAgC;QAChE,KAAK,CAAC,KAAK,CAAC,CAAC;QACb,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,IAAqB,CAAC;QAC1B,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,GAAG,EAAE,EAAE,EAAE;gBACT,IAAI,EAAE,IAAI;gBACV,OAAO,EAAE,GAAG;gBACZ,OAAO,EAAE,GAAG;gBACZ,OAAO,EAAE;oBACP,IAAI,EAAE,eAAe;oBACrB,MAAM,EAAE,KAAK;oBACb,GAAG,EAAE,EAAE;iBACR;gBACD,IAAI,EAAE,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,MAAM,EAAE;aAClC,CAAC;SACH;QACD,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IACjB,CAAC;IAEQ,GAAG,CAAC,IAAqB;QAChC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAEhB,MAAM,EAAE,GAAG,EAAE,WAAW,EAAE,GAAG,IAAuB,CAAC;QACrD,IAAI,CAAC,GAAG,GAAG,GAAG,IAAI,EAAE,EAAE,CAAC;QACvB,IAAI,WAAW,EAAE;YACf,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;SAChC;IACH,CAAC;IAEQ,MAAM;QACb,MAAM,OAAO,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC;QAC/B,MAAM,MAAM,GAAoB,EAAE,GAAG,OAAO,EAAE,GAAG,EAAE,IAAI,CAAC,GAAG,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC;QAC1E,IAAI,IAAI,CAAC,WAAW,EAAE;YACpB,MAAM,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC;SACvC;QACD,OAAO,MAAM,CAAC;IAChB,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,aAAa,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACvC,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,OAA6B,EAAE;QACnC,MAAM,IAAI,GAAG,IAAI,cAAc,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;QAC7D,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE;YAC3B,IAAI,CAAC,GAAG,GAAG,EAAE,EAAE,CAAC;SACjB;QACD,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE;YACvB,oEAAoE;YACpE,MAAM,MAAM,GAAG,IAAI,CAAC,SAAS,EAAE,CAAC;YAChC,IAAI,MAAM,EAAE;gBACV,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;aACzB;SACF;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,KAAK,CAAC,OAAwB,EAAE,OAAoB,EAAE,OAA6B,EAAE;QAC1F,MAAM,GAAG,GAAG,IAAI,cAAc,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QACjD,OAAO,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IACzB,CAAC;IAED;;OAEG;IACH,cAAc;QACZ,MAAM,EAAE,WAAW,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC;QACtC,IAAI,CAAC,WAAW,EAAE;YAChB,OAAO,SAAS,CAAC;SAClB;QACD,IAAI,MAAM,GAAG,IAAI,CAAC,SAAS,EAAE,CAAC;QAC9B,IAAI,MAAM,KAAK,OAAO,EAAE;YACtB,MAAM,GAAG,SAAS,CAAC;SACpB;QACD,OAAO,OAAO,CAAC,eAAe,CAAC,WAAW,CAAC,CAAC;IAC9C,CAAC;IAED;;OAEG;IACH,gBAAgB;QACd,IAAI,MAAM,GAAG,IAAI,CAAC,SAAS,EAAE,CAAC;QAC9B,IAAI,MAAM,KAAK,IAAI,CAAC,OAAO,EAAE;YAC3B,MAAM,GAAG,SAAS,CAAC;SACpB;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,gBAAgB,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC,CAAC;IAChE,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,OAAO,CAAC,OAA8B,EAAE;QACtC,MAAM,EAAE,WAAW,EAAE,GAAG,IAAI,CAAC;QAC7B,MAAM,OAAO,GAAG,IAAI,CAAC,UAAU,EAAE,CAAC;QAClC,mDAAmD;QACnD,MAAM,YAAY,GAAG,IAAI,CAAC,gBAAgB,EAAE,CAAC;QAE7C,IAAI,UAAU,GAAG,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC;QACxD,IAAI,CAAC,YAAY,EAAE;YACjB,IAAI,UAAU,IAAI,IAAI,CAAC,SAAS,EAAE;gBAChC,OAAO,IAAI,CAAC,WAAW,CAAC,UAAU,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;aACrD;YACD,OAAO,UAAU,IAAI,SAAS,CAAC;SAChC;QAED,4GAA4G;QAC5G,2EAA2E;QAC3E,8GAA8G;QAC9G,uGAAuG;QACvG,MAAM,UAAU,GAAG,CAAC,CAAC,UAAU,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,UAAU,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QAC7F,IAAI,UAAU,IAAI,IAAI,CAAC,WAAW,EAAE;YAClC,4FAA4F;YAC5F,0DAA0D;YAC1D,OAAO,UAAU,CAAC;SACnB;QAED,MAAM,cAAc,GAAe,EAAE,CAAC;QACtC,IAAI,eAAmC,CAAC;QACxC,KAAK,MAAM,GAAG,IAAI,YAAY,EAAE;YAC9B,IAAI,GAAG,CAAC,MAAM,IAAI,GAAG,CAAC,MAAM,CAAC,GAAG,EAAE;gBAChC,eAAe,GAAG,GAAG,CAAC,MAAM,CAAC;aAC9B;YACD,IAAI,CAAC,IAAI,CAAC,WAAW,IAAI,CAAC,IAAI,CAAC,SAAS,IAAI,GAAG,CAAC,SAAS,EAAE;gBACzD,KAAK,MAAM,IAAI,IAAI,GAAG,CAAC,SAAS,EAAE;oBAChC,uFAAuF;oBACvF,gFAAgF;oBAChF,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,cAAc,CAAC,CAAA;iBACvC;aACF;YACD,IAAI,GAAG,CAAC,GAAG,KAAK,WAAW,EAAE;gBAC3B,MAAM;aACP;SACF;QAED,IAAI,CAAC,UAAU,EAAE;YACf,4CAA4C;YAC5C,IAAI,eAAe,EAAE;gBACnB,gEAAgE;gBAChE,MAAM,GAAG,GAAG,eAAe,CAAC,OAAO,EAAE,CAAC;gBACtC,IAAI,IAAI,CAAC,SAAS,EAAE;oBAClB,OAAO,IAAI,CAAC,WAAW,CAAC,GAAG,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;iBAC9C;gBACD,OAAO,IAAI,CAAC,WAAW,CAAC,GAAG,EAAE,cAAc,CAAC,CAAC;aAC9C;YACD,OAAO,SAAS,CAAC;SAClB;QAED,IAAI,UAAU,EAAE;YACd,oEAAoE;YACpE,IAAI,IAAI,CAAC,SAAS,EAAE;gBAClB,OAAO,IAAI,CAAC,WAAW,CAAC,UAAU,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;aACrD;YACD,OAAO,IAAI,CAAC,WAAW,CAAC,UAAU,EAAE,cAAc,CAAC,CAAC;SACrD;QAED,IAAI,SAAS,GAAG,EAAE,CAAC;QACnB,IAAI,eAAe,EAAE;YACnB,SAAS,GAAG,eAAe,CAAC,OAAO,EAAE,CAAC;SACvC;QACD,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;YAC5B,SAAS,IAAI,GAAG,CAAC;SAClB;QACD,IAAI,UAAU,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE;YAC9B,UAAU,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;SACtC;QACD,MAAM,GAAG,GAAG,SAAS,GAAG,UAAU,CAAC;QACnC,IAAI,IAAI,CAAC,SAAS,EAAE;YAClB,OAAO,IAAI,CAAC,WAAW,CAAC,GAAG,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;SAC9C;QACD,OAAO,IAAI,CAAC,WAAW,CAAC,GAAG,EAAE,cAAc,CAAC,CAAC;IAC/C,CAAC;IAES,WAAW,CAAC,IAAc,EAAE,IAAgB;QACpD,MAAM,KAAK,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,IAAI,CAAC,IAAI,CAAC,CAAC;QACxD,IAAI,KAAK,IAAI,CAAC,EAAE;YACd,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;SACvB;QACD,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAClB,CAAC;IAMD;;;;;;;;OAQG;IACO,WAAW,CAAC,GAAW,EAAE,SAA+C;QAChF,IAAI,CAAC,SAAS,EAAE;YACd,OAAO,GAAG,CAAC;SACZ;QAED,IAAI,IAAwC,CAAC;QAC7C,IAAI,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE;YAC5B,IAAI,SAAS,CAAC,MAAM,EAAE;gBACpB,IAAI,GAAG,QAAQ,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;aAClC;SACF;aAAM;YACL,IAAI,GAAG,SAAS,CAAC;SAClB;QACD,IAAI,CAAC,IAAI,EAAE;YACT,OAAO,GAAG,CAAC;SACZ;QACD,IAAI,MAAM,GAAG,GAAG,CAAC;QACjB,IAAI;YACF,MAAM,GAAG,IAAI,WAAW,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC,CAAC;SACrE;QAAC,OAAO,CAAC,EAAE;YACV,GAAG;SACJ;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;;;;;;;OAQG;IACH,iBAAiB;QACf,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,CAAC,IAAI,IAAI,CAAC,aAAa,CAAC,MAAM,EAAE;YAClE,OAAO,IAAI,CAAC,aAAa,CAAC;SAC3B;QACD,MAAM,OAAO,GAAG,IAAI,CAAC,4BAA4B,EAAE,CAAC;QACpD,IAAI,OAAO,EAAE;YACX,OAAO,OAAO,CAAC;SAChB;QACD,IAAI,IAAI,CAAC,WAAW,EAAE;YACpB,OAAO,EAAE,CAAC;SACX;QACD,MAAM,SAAS,GAAG,IAAI,CAAC,6BAA6B,EAAE,CAAC;QACvD,IAAI,SAAS,EAAE;YACb,OAAO,SAAS,CAAC;SAClB;QACD,OAAO,EAAE,CAAC;IACZ,CAAC;IAED;;OAEG;IACO,4BAA4B;QACpC,MAAM,OAAO,GAAG,IAAI,CAAC,cAAc,EAAE,CAAC;QACtC,IAAI,CAAC,OAAO,EAAE;YACZ,OAAO,SAAS,CAAC;SAClB;QACD,IAAI,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,aAAa,CAAC,IAAI,OAAO,CAAC,aAAa,CAAC,MAAM,EAAE;YACxE,OAAO,OAAO,CAAC,aAAa,CAAC;SAC9B;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IAED;;OAEG;IACO,6BAA6B;QACrC,MAAM,IAAI,GAAG,IAAI,CAAC,gBAAgB,EAAE,CAAC;QACrC,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;QAC3F,IAAI,OAAO,EAAE;YACX,OAAO,OAAO,CAAC,aAAuC,CAAC;SACxD;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;CACF"}

package/build/esm/src/models/ProjectSchema.d.ts

@@ -0,0 +1,105 @@
+import { Property, IProperty, PropertyType } from './Property.js';
+export declare const Kind = "Core#ProjectSchema";
+export interface IProjectSchema {
+    kind?: typeof Kind;
+    /**
+     * The identifier of the environment.
+     */
+    key: string;
+    /**
+     * The name of the schema.
+     */
+    name: string;
+    /**
+     * The optional list of properties in this schema.
+     * Because this is a list instead of a map it is possible to duplicate the property name. In this
+     * case the last set value is the final value.
+     *
+     * When both the `properties` and the `content` is defined, `content` is used instead of properties.
+     */
+    properties?: IProperty[];
+    /**
+     * The "raw" content of the schema.
+     * This value goes unchanged to the request.
+     */
+    content?: string;
+    /**
+     * When content is used, it informs about the content type of the
+     * schema. The schema is invalid when `content` is set and the `mime` is not.
+     */
+    mime?: string;
+}
+/**
+ * A project can contain schema definitions that can be reused in project requests.
+ * The schema consists of:
+ *
+ * - content: the "raw" schema value in any format. This goes unprocessed into the request body.
+ * - properties: a map of properties description that can be manipulated at runtime
+ *
+ * Scalar values are not supported as a schema definition. It always represents an object.
+ */
+export declare class ProjectSchema {
+    kind: string;
+    /**
+     * The identifier of the environment.
+     */
+    key: string;
+    /**
+     * The optional list of properties in this schema.
+     * Because this is a list instead of a map it is possible to duplicate the property name. In this
+     * case the last set value is the final value.
+     *
+     * When both the `properties` and the `content` is defined, `content` is used instead of properties.
+     */
+    properties?: Property[];
+    /**
+     * The "raw" content of the schema.
+     * This value goes unchanged to the request.
+     */
+    content?: string;
+    /**
+     * When content is used, it informs about the content type of the
+     * schema. The schema is invalid when `content` is set and the `mime` is not.
+     */
+    mime?: string;
+    /**
+     * The name of the schema.
+     */
+    name: string;
+    /**
+     * Creates a new schema instance from the passed name.
+     * @param name The name of the schema.
+     */
+    static fromName(name: string): ProjectSchema;
+    /**
+     * Creates a new schema instance from the content definition
+     * @param name The name of the schema.
+     * @param content The "raw" content of the schema
+     * @param mime The mime type associated with the schema.
+     * @returns The instance of the created schema
+     */
+    static fromContent(name: string, content: string, mime: string): ProjectSchema;
+    /**
+     * @param input The schema definition used to restore the state.
+     */
+    constructor(input?: string | IProjectSchema);
+    /**
+     * Creates a new schema definition clearing anything that is so far defined.
+     */
+    new(init: IProjectSchema): void;
+    toJSON(): IProjectSchema;
+    /**
+     * Creates a schema property from a definition.
+     * @param info The property definition.
+     * @returns The same property definition
+     */
+    addProperty(info: IProperty): Property;
+    /**
+     * Creates a schema property from a definition.
+     *
+     * @param name The property name
+     * @param type The property data type
+     * @returns The created schema definition.
+     */
+    addProperty(name: string, type: PropertyType): Property;
+}

package/build/esm/src/models/ProjectSchema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ProjectSchema.js","sourceRoot":"","sources":["../../../../src/models/ProjectSchema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,gBAAgB,CAAC;AAChC,OAAO,EAAE,QAAQ,EAA2B,IAAI,IAAI,YAAY,EAAE,MAAM,eAAe,CAAC;AACxF,MAAM,CAAC,MAAM,IAAI,GAAG,oBAAoB,CAAC;AAgCzC;;;;;;;;GAQG;AACH,MAAM,OAAO,aAAa;IACxB,IAAI,GAAG,IAAI,CAAC;IACZ;;OAEG;IACH,GAAG,GAAG,EAAE,CAAC;IACT;;;;;;OAMG;IACH,UAAU,CAAc;IACxB;;;OAGG;IACH,OAAO,CAAU;IACjB;;;OAGG;IACH,IAAI,CAAU;IACd;;OAEG;IACH,IAAI,GAAE,EAAE,CAAC;IAET;;;OAGG;IACH,MAAM,CAAC,QAAQ,CAAC,IAAY;QAC1B,MAAM,IAAI,GAAmB;YAC3B,IAAI,EAAE,IAAI;YACV,IAAI;YACJ,GAAG,EAAE,EAAE,EAAE;SACV,CAAC;QACF,OAAO,IAAI,aAAa,CAAC,IAAI,CAAC,CAAC;IACjC,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,WAAW,CAAC,IAAY,EAAE,OAAe,EAAE,IAAY;QAC5D,MAAM,IAAI,GAAmB;YAC3B,IAAI,EAAE,IAAI;YACV,IAAI;YACJ,GAAG,EAAE,EAAE,EAAE;YACT,OAAO;YACP,IAAI;SACL,CAAC;QACF,OAAO,IAAI,aAAa,CAAC,IAAI,CAAC,CAAC;IACjC,CAAC;IAED;;OAEG;IACH,YAAY,KAA+B;QACzC,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,IAAI,GAAG;gBACL,IAAI,EAAE,IAAI;gBACV,IAAI,EAAE,EAAE;gBACR,GAAG,EAAE,EAAE,EAAE;aACV,CAAA;SACF;QACD,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IACjB,CAAC;IAED;;OAEG;IACH,GAAG,CAAC,IAAoB;QACtB,MAAM,EAAE,GAAG,GAAC,EAAE,EAAE,EAAE,OAAO,EAAE,UAAU,EAAE,IAAI,EAAE,IAAI,GAAC,EAAE,EAAE,GAAG,IAAI,CAAC;QAC9D,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;QACf,IAAI,OAAO,EAAE;YACX,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;SACxB;aAAM;YACL,IAAI,CAAC,OAAO,GAAG,SAAS,CAAC;SAC1B;QACD,IAAI,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE;YAC7B,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;SACxD;aAAM;YACL,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;SAC7B;QACD,IAAI,IAAI,EAAE;YACR,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;SAClB;aAAM;YACL,IAAI,CAAC,IAAI,GAAG,SAAS,CAAC;SACvB;IACH,CAAC;IAED,MAAM;QACJ,MAAM,MAAM,GAAkB;YAC5B,IAAI,EAAE,IAAI;YACV,IAAI,EAAE,IAAI,CAAC,IAAI,IAAI,EAAE;YACrB,GAAG,EAAE,IAAI,CAAC,GAAG,IAAI,EAAE,EAAE;SACtB,CAAC;QACF,IAAI,IAAI,CAAC,OAAO,EAAE;YAChB,MAAM,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC;SAC/B;QACD,IAAI,IAAI,CAAC,IAAI,EAAE;YACb,MAAM,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC;SACzB;QACD,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE;YAC5D,MAAM,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC;SAC1D;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IAkBD,WAAW,CAAC,UAA8B,EAAE,IAAmB;QAC7D,MAAM,QAAQ,GAAG,OAAO,UAAU,CAAC;QACnC,IAAI,QAAQ,KAAK,QAAQ,IAAI,CAAC,IAAI,EAAE;YAClC,MAAM,IAAI,KAAK,CAAC,uBAAuB,CAAC,CAAC;SAC1C;QACD,IAAI,QAAkB,CAAC;QACvB,IAAI,QAAQ,KAAK,QAAQ,EAAE;YACzB,QAAQ,GAAG,QAAQ,CAAC,eAAe,CAAC,UAAoB,EAAE,IAAoB,CAAC,CAAC;SACjF;aAAM;YACL,MAAM,IAAI,GAAG,UAAuB,CAAC;YACrC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE;gBACd,IAAI,CAAC,IAAI,GAAG,YAAY,CAAC;aAC1B;YACD,QAAQ,GAAG,IAAI,QAAQ,CAAC,IAAI,CAAC,CAAC;SAC/B;QACD,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE;YACnC,IAAI,CAAC,UAAU,GAAG,EAAE,CAAC;SACtB;QACD,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAC/B,OAAO,QAAQ,CAAC;IAClB,CAAC;CACF"}