@api-client/core 0.3.0

package/build/src/models/transformers/PostmanV21Transformer.js

@@ -0,0 +1,195 @@
+/* eslint-disable no-unused-vars */
+import { PostmanTransformer, dataValue, paramValue } from './PostmanTransformer.js';
+import { HttpProject, Kind as ProjectKind } from '../HttpProject.js';
+import v4 from '../../lib/uuid.js';
+import { Environment } from '../Environment.js';
+export const currentItemValue = Symbol('currentItemValue');
+/**
+ * Transforms Postman v2.1 collections to ARC import object.
+ */
+export class PostmanV21Transformer extends PostmanTransformer {
+    /**
+     * Transforms `_data` into ARC data model.
+     * @returns Promise resolved when data are transformed.
+     */
+    async transform() {
+        const raw = this[dataValue];
+        const project = this.createProject(raw);
+        this.setProjectVariables(project, raw);
+        if (Array.isArray(raw.item)) {
+            for (const item of raw.item) {
+                await this.addProjectItem(project, item);
+            }
+        }
+        return project;
+    }
+    createProject(data) {
+        const { info } = data;
+        const init = {
+            kind: ProjectKind,
+            definitions: {},
+            environments: [],
+            info: {
+                kind: 'ARC#Thing',
+                name: info.name || 'Unnamed Postman project',
+            },
+            items: [],
+            key: info._postman_id || v4(),
+        };
+        if (info.description) {
+            init.info.description = info.description;
+        }
+        const project = new HttpProject(init);
+        return project;
+    }
+    setProjectVariables(project, collection) {
+        const { variable } = collection;
+        if (!Array.isArray(variable)) {
+            return;
+        }
+        const env = Environment.fromName('Default');
+        project.addEnvironment(env);
+        variable.forEach((param) => {
+            const { disabled = false, key, value } = param;
+            const parsed = this.ensureVariablesSyntax(value);
+            const created = env.addVariable(key, parsed);
+            created.enabled = !disabled;
+        });
+    }
+    async addProjectItem(current, item) {
+        const typedGroup = item;
+        if (typedGroup.item) {
+            return this.addProjectFolder(current, typedGroup);
+        }
+        const typedItem = item;
+        if (typedItem.request) {
+            return this.addProjectRequest(current, item);
+        }
+        this.addLog('error', 'Error when adding an item to the project. Unable to determine item type. Tested for a folder and a request.');
+    }
+    async addProjectFolder(current, group) {
+        const { description, name = 'Unnamed folder', item } = group;
+        const created = current.addFolder(name);
+        if (description) {
+            created.info.description = description;
+        }
+        if (Array.isArray(item)) {
+            for (const tmp of item) {
+                await this.addProjectItem(created, tmp);
+            }
+        }
+    }
+    async addProjectRequest(current, item) {
+        const { request, description } = item;
+        const name = item.name || 'Unnamed request';
+        let url;
+        if (typeof request.url === 'string') {
+            url = request.url;
+        }
+        else if (request.url && request.url.raw) {
+            url = request.url.raw;
+        }
+        else {
+            url = 'http://';
+        }
+        url = this.ensureVariablesSyntax(url);
+        let method = request.method || 'GET';
+        method = this.ensureVariablesSyntax(method);
+        const header = this.ensureVarsRecursively(request.header);
+        const headers = this.computeHeaders(header);
+        const created = current.addRequest(url);
+        created.info.name = name;
+        if (request.description) {
+            created.info.description = request.description;
+        }
+        else if (description) {
+            created.info.description = description;
+        }
+        created.expects.method = method;
+        if (headers) {
+            created.expects.headers = headers;
+        }
+        await this.addRequestBody(created, request.body);
+    }
+    /**
+     * Computes headers string from item's headers.
+     *
+     * @param headers Postman Request.header model.
+     * @returns Computed value of headers.
+     */
+    computeHeaders(headers) {
+        if (typeof headers === 'string') {
+            return headers;
+        }
+        if (!Array.isArray(headers)) {
+            return '';
+        }
+        const tmp = headers.filter((h) => !h.disabled);
+        return tmp.map((item) => `${item.key}: ${item.value}`).join('\n');
+    }
+    async addRequestBody(created, body) {
+        if (!body) {
+            return;
+        }
+        switch (body.mode) {
+            case 'file': return this.addBinaryBody(created, body);
+            case 'urlencoded': return this.addUrlencodedBody(created, body);
+            case 'formdata': return this.addParamsBody(created, body);
+            case 'raw': return this.addRawBody(created, body);
+        }
+    }
+    async addBinaryBody(created, body) {
+        // Postman sets the `body.file.src` property with the path to the file
+        // but not data itself. Because of that this method is a stub that can be extended
+        // by particular implementation (like node, CLI).
+    }
+    async addUrlencodedBody(created, body) {
+        const items = body[body.mode];
+        if (!Array.isArray(items)) {
+            return;
+        }
+        const data = this.ensureVarsRecursively(items);
+        const str = data.map(i => `${paramValue(i.key || 'missing name')}=${paramValue(i.value || '')}`).join('&');
+        await created.expects.writePayload(str);
+    }
+    async addParamsBody(created, body) {
+        const items = body[body.mode];
+        if (!Array.isArray(items)) {
+            return;
+        }
+        const data = this.ensureVarsRecursively(items);
+        const multipartBody = [];
+        for (const part of data) {
+            if (part.type === 'text') {
+                await this.addParamsTextPart(multipartBody, part);
+            }
+            else if (part.type === 'file') {
+                await this.addParamsFilePart(multipartBody, part);
+            }
+        }
+        created.expects.payload = {
+            type: 'formdata',
+            data: multipartBody,
+        };
+    }
+    async addParamsTextPart(body, param) {
+        const { key, value, disabled = false, } = param;
+        body.push({
+            isFile: false,
+            name: key || 'unnamed part',
+            value: value || '',
+            enabled: !disabled,
+        });
+    }
+    async addParamsFilePart(body, param) {
+        // Postman sets the `value` property with the path to the file
+        // but not data itself. Because of that this method is a stub that can be extended
+        // by particular implementation (like node, CLI).
+    }
+    async addRawBody(created, body) {
+        if (body.raw) {
+            await created.expects.writePayload(body.raw);
+        }
+    }
+}
+//# sourceMappingURL=PostmanV21Transformer.js.map

package/build/src/models/transformers/PostmanV21Transformer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PostmanV21Transformer.js","sourceRoot":"","sources":["../../../../src/models/transformers/PostmanV21Transformer.ts"],"names":[],"mappings":"AAAA,mCAAmC;AACnC,OAAO,EAAE,kBAAkB,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AACpF,OAAO,EAAE,WAAW,EAAgB,IAAI,IAAI,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAInF,OAAO,EAAE,MAAM,mBAAmB,CAAC;AACnC,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAEhD,MAAM,CAAC,MAAM,gBAAgB,GAAG,MAAM,CAAC,kBAAkB,CAAC,CAAC;AAoG3D;;GAEG;AACH,MAAM,OAAO,qBAAsB,SAAQ,kBAAkB;IAC3D;;;OAGG;IACH,KAAK,CAAC,SAAS;QACb,MAAM,GAAG,GAAG,IAAI,CAAC,SAAS,CAAc,CAAC;QACzC,MAAM,OAAO,GAAG,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC;QACxC,IAAI,CAAC,mBAAmB,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;QACvC,IAAI,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE;YAC3B,KAAK,MAAM,IAAI,IAAI,GAAG,CAAC,IAAI,EAAE;gBAC3B,MAAM,IAAI,CAAC,cAAc,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;aAC1C;SACF;QACD,OAAO,OAAO,CAAC;IACjB,CAAC;IAED,aAAa,CAAC,IAAe;QAC3B,MAAM,EAAE,IAAI,EAAE,GAAG,IAAI,CAAC;QACtB,MAAM,IAAI,GAAiB;YACzB,IAAI,EAAE,WAAW;YACjB,WAAW,EAAE,EAAE;YACf,YAAY,EAAE,EAAE;YAChB,IAAI,EAAE;gBACJ,IAAI,EAAE,WAAW;gBACjB,IAAI,EAAE,IAAI,CAAC,IAAI,IAAI,yBAAyB;aAC7C;YACD,KAAK,EAAE,EAAE;YACT,GAAG,EAAE,IAAI,CAAC,WAAW,IAAI,EAAE,EAAE;SAC9B,CAAC;QACF,IAAI,IAAI,CAAC,WAAW,EAAE;YACpB,IAAI,CAAC,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC;SAC1C;QACD,MAAM,OAAO,GAAG,IAAI,WAAW,CAAC,IAAI,CAAC,CAAC;QACtC,OAAO,OAAO,CAAC;IACjB,CAAC;IAED,mBAAmB,CAAC,OAAoB,EAAE,UAAqB;QAC7D,MAAM,EAAE,QAAQ,EAAE,GAAG,UAAU,CAAC;QAChC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE;YAC5B,OAAO;SACR;QACD,MAAM,GAAG,GAAG,WAAW,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC;QAC5C,OAAO,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC;QAC5B,QAAQ,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;YACzB,MAAM,EAAE,QAAQ,GAAC,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,KAAK,CAAC;YAE7C,MAAM,MAAM,GAAG,IAAI,CAAC,qBAAqB,CAAC,KAAK,CAAW,CAAC;YAC3D,MAAM,OAAO,GAAG,GAAG,CAAC,WAAW,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;YAC7C,OAAO,CAAC,OAAO,GAAG,CAAC,QAAQ,CAAC;QAC9B,CAAC,CAAC,CAAC;IACL,CAAC;IAED,KAAK,CAAC,cAAc,CAAC,OAAoC,EAAE,IAAoC;QAC7F,MAAM,UAAU,GAAG,IAAwB,CAAC;QAC5C,IAAI,UAAU,CAAC,IAAI,EAAE;YACnB,OAAO,IAAI,CAAC,gBAAgB,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;SACnD;QACD,MAAM,SAAS,GAAG,IAAmB,CAAC;QACtC,IAAI,SAAS,CAAC,OAAO,EAAE;YACrB,OAAO,IAAI,CAAC,iBAAiB,CAAC,OAAO,EAAE,IAAmB,CAAC,CAAC;SAC7D;QACD,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,6GAA6G,CAAC,CAAC;IACtI,CAAC;IAED,KAAK,CAAC,gBAAgB,CAAC,OAAoC,EAAE,KAAuB;QAClF,MAAM,EAAE,WAAW,EAAE,IAAI,GAAC,gBAAgB,EAAE,IAAI,EAAE,GAAG,KAAK,CAAC;QAC3D,MAAM,OAAO,GAAG,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QACxC,IAAI,WAAW,EAAE;YACf,OAAO,CAAC,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;SACxC;QAED,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;YACvB,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE;gBACtB,MAAM,IAAI,CAAC,cAAc,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;aACzC;SACF;IACH,CAAC;IAED,KAAK,CAAC,iBAAiB,CAAC,OAAoC,EAAE,IAAiB;QAC7E,MAAM,EAAE,OAAO,EAAE,WAAW,EAAE,GAAG,IAAI,CAAC;QACtC,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,IAAI,iBAAiB,CAAC;QAC5C,IAAI,GAAW,CAAC;QAChB,IAAI,OAAO,OAAO,CAAC,GAAG,KAAK,QAAQ,EAAE;YACnC,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC;SACnB;aAAM,IAAI,OAAO,CAAC,GAAG,IAAI,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE;YACzC,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC;SACvB;aAAM;YACL,GAAG,GAAG,SAAS,CAAC;SACjB;QACD,GAAG,GAAG,IAAI,CAAC,qBAAqB,CAAC,GAAG,CAAW,CAAC;QAChD,IAAI,MAAM,GAAG,OAAO,CAAC,MAAM,IAAI,KAAK,CAAC;QACrC,MAAM,GAAG,IAAI,CAAC,qBAAqB,CAAC,MAAM,CAAW,CAAC;QAEtD,MAAM,MAAM,GAAG,IAAI,CAAC,qBAAqB,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QAC1D,MAAM,OAAO,GAAG,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;QAE5C,MAAM,OAAO,GAAG,OAAO,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;QACxC,OAAO,CAAC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACzB,IAAI,OAAO,CAAC,WAAW,EAAE;YACvB,OAAO,CAAC,IAAI,CAAC,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC;SAChD;aAAM,IAAI,WAAW,EAAE;YACtB,OAAO,CAAC,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;SACxC;QACD,OAAO,CAAC,OAAO,CAAC,MAAM,GAAG,MAAM,CAAC;QAChC,IAAI,OAAO,EAAE;YACX,OAAO,CAAC,OAAO,CAAC,OAAO,GAAG,OAAO,CAAC;SACnC;QAED,MAAM,IAAI,CAAC,cAAc,CAAC,OAAO,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;IACnD,CAAC;IAED;;;;;OAKG;IACH,cAAc,CAAC,OAA+B;QAC5C,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE;YAC/B,OAAO,OAAO,CAAC;SAChB;QACD,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE;YAC3B,OAAO,EAAE,CAAC;SACX;QACD,MAAM,GAAG,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC;QAC/C,OAAO,GAAG,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,GAAG,IAAI,CAAC,GAAG,KAAK,IAAI,CAAC,KAAK,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACpE,CAAC;IAED,KAAK,CAAC,cAAc,CAAC,OAAuB,EAAE,IAAkB;QAC9D,IAAI,CAAC,IAAI,EAAE;YACT,OAAO;SACR;QACD,QAAQ,IAAI,CAAC,IAAI,EAAE;YACjB,KAAK,MAAM,CAAC,CAAC,OAAO,IAAI,CAAC,aAAa,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;YACtD,KAAK,YAAY,CAAC,CAAC,OAAO,IAAI,CAAC,iBAAiB,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;YAChE,KAAK,UAAU,CAAC,CAAC,OAAO,IAAI,CAAC,aAAa,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;YAC1D,KAAK,KAAK,CAAC,CAAC,OAAO,IAAI,CAAC,UAAU,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;SACnD;IACH,CAAC;IAED,KAAK,CAAC,aAAa,CAAC,OAAuB,EAAE,IAAiB;QAC5D,sEAAsE;QACtE,kFAAkF;QAClF,iDAAiD;IACnD,CAAC;IAED,KAAK,CAAC,iBAAiB,CAAC,OAAuB,EAAE,IAAiB;QAChE,MAAM,KAAK,GAAG,IAAI,CAAC,IAAI,CAAC,IAAyB,CAAwB,CAAC;QAC1E,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;YACzB,OAAO;SACR;QACD,MAAM,IAAI,GAAG,IAAI,CAAC,qBAAqB,CAAC,KAAK,CAAwB,CAAC;QACtE,MAAM,GAAG,GAAI,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,GAAG,UAAU,CAAC,CAAC,CAAC,GAAG,IAAI,cAAc,CAAC,IAAI,UAAU,CAAC,CAAC,CAAC,KAAK,IAAI,EAAE,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAC5G,MAAM,OAAO,CAAC,OAAO,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC;IAC1C,CAAC;IAED,KAAK,CAAC,aAAa,CAAC,OAAuB,EAAE,IAAiB;QAC5D,MAAM,KAAK,GAAG,IAAI,CAAC,IAAI,CAAC,IAAyB,CAAsB,CAAC;QACxE,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;YACzB,OAAO;SACR;QACD,MAAM,IAAI,GAAG,IAAI,CAAC,qBAAqB,CAAC,KAAK,CAAsB,CAAC;QACpE,MAAM,aAAa,GAAqB,EAAE,CAAC;QAC3C,KAAK,MAAM,IAAI,IAAI,IAAI,EAAE;YACvB,IAAI,IAAI,CAAC,IAAI,KAAK,MAAM,EAAE;gBACxB,MAAM,IAAI,CAAC,iBAAiB,CAAC,aAAa,EAAE,IAAI,CAAC,CAAC;aACnD;iBAAM,IAAI,IAAI,CAAC,IAAI,KAAK,MAAM,EAAE;gBAC/B,MAAM,IAAI,CAAC,iBAAiB,CAAC,aAAa,EAAE,IAAI,CAAC,CAAC;aACnD;SACF;QACD,OAAO,CAAC,OAAO,CAAC,OAAO,GAAG;YACxB,IAAI,EAAE,UAAU;YAChB,IAAI,EAAE,aAAa;SACpB,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,iBAAiB,CAAC,IAAsB,EAAE,KAAsB;QACpE,MAAM,EAAE,GAAG,EAAE,KAAK,EAAE,QAAQ,GAAC,KAAK,GAAG,GAAG,KAAK,CAAC;QAC9C,IAAI,CAAC,IAAI,CAAC;YACR,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,GAAG,IAAI,cAAc;YAC3B,KAAK,EAAE,KAAK,IAAI,EAAE;YAClB,OAAO,EAAE,CAAC,QAAQ;SACnB,CAAC,CAAC;IACL,CAAC;IAED,KAAK,CAAC,iBAAiB,CAAC,IAAsB,EAAE,KAAsB;QACpE,8DAA8D;QAC9D,kFAAkF;QAClF,iDAAiD;IACnD,CAAC;IAED,KAAK,CAAC,UAAU,CAAC,OAAuB,EAAE,IAAiB;QACzD,IAAI,IAAI,CAAC,GAAG,EAAE;YACZ,MAAM,OAAO,CAAC,OAAO,CAAC,YAAY,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;SAC9C;IACH,CAAC;CACF"}

package/build/src/models/transformers/PostmanV2Transformer.d.ts

@@ -0,0 +1,123 @@
+import { PostmanTransformer } from './PostmanTransformer.js';
+import { HttpProject } from '../HttpProject.js';
+import { ProjectFolder } from '../ProjectFolder.js';
+import { ProjectRequest } from '../ProjectRequest.js';
+import { IMultipartBody } from '../../lib/transformers/PayloadSerializer.js';
+export declare const currentItemValue: unique symbol;
+interface PostmanInfo {
+    /**
+     * Name of the collection
+     */
+    name: string;
+    /**
+     * This should ideally hold a link to the Postman schema that is used to validate this collection. E.g: https://schema.getpostman.com/collection/v1
+     */
+    schema: string;
+    /**
+     * Every collection is identified by the unique value of this field. The value of this field is usually easiest to generate using a UID generator function. If you already have a collection, it is recommended that you maintain the same id since changing the id usually implies that is a different collection than it was originally.\n *Note: This field exists for compatibility reasons with Collection Format V1.
+     */
+    _postman_id?: string;
+    description?: string;
+}
+interface PostmanRequestUrl {
+    raw?: string;
+    protocol?: string;
+    host?: string | string[];
+    path?: string | string[];
+    port?: string;
+}
+interface PostmanParameter {
+    key?: string | null;
+    value?: string | null;
+    disabled?: boolean;
+    description?: string;
+}
+interface PostmanUrlEncoded extends PostmanParameter {
+    type?: string;
+}
+interface PostmanFormData extends PostmanParameter {
+    type?: string;
+    src?: string;
+    contentType?: string;
+}
+interface PostmanFile {
+    src: string | null;
+    contentType?: string;
+}
+interface PostmanBody {
+    mode: string | null;
+    raw?: string;
+    urlencoded?: PostmanUrlEncoded[];
+    formdata?: PostmanFormData[];
+    file?: PostmanFile;
+}
+interface PostmanRequest {
+    url?: string | PostmanRequestUrl;
+    method?: string;
+    description?: string;
+    header?: string | PostmanParameter[];
+    body?: PostmanBody;
+}
+interface PostmanResponse {
+}
+interface PostmanItem {
+    /**
+     * A unique ID that is used to identify collections internally
+     */
+    id?: string;
+    /**
+     * Name of the collection
+     */
+    name?: string;
+    description?: string;
+    request: PostmanRequest;
+    response?: PostmanResponse[];
+}
+interface PostmanItemGroup {
+    /**
+     * A folder's friendly name is defined by this field. You would want to set this field to a value that would allow you to easily identify this folder.
+     */
+    name?: string;
+    description?: string;
+    item: PostmanItem[] | PostmanItemGroup[];
+}
+interface PostmanVariable {
+    disabled?: boolean;
+    key: string;
+    value: string;
+}
+interface PostmanV2 {
+    variable?: PostmanVariable[];
+    info: PostmanInfo;
+    item: PostmanItem[] | PostmanItemGroup[];
+}
+/**
+ * Transforms Postman v2 collections to ARC import object.
+ */
+export declare class PostmanV2Transformer extends PostmanTransformer {
+    /**
+     * Transforms `_data` into ARC data model.
+     * @returns Promise resolved when data are transformed.
+     */
+    transform(): Promise<HttpProject>;
+    createProject(data: PostmanV2): HttpProject;
+    setProjectVariables(project: HttpProject, collection: PostmanV2): void;
+    addProjectItem(current: HttpProject | ProjectFolder, item: PostmanItem | PostmanItemGroup): Promise<void>;
+    addProjectFolder(current: HttpProject | ProjectFolder, group: PostmanItemGroup): Promise<void>;
+    addProjectRequest(current: HttpProject | ProjectFolder, item: PostmanItem): Promise<void>;
+    /**
+     * Computes headers string from item's headers.
+     *
+     * @param headers Postman Request.header model.
+     * @return Computed value of headers.
+     */
+    computeHeaders(headers?: string | PostmanParameter[]): string;
+    addRequestBody(created: ProjectRequest, body?: PostmanBody): Promise<void>;
+    addBinaryBody(created: ProjectRequest, body: PostmanBody): Promise<void>;
+    addUrlencodedBody(created: ProjectRequest, body: PostmanBody): Promise<void>;
+    addParamsBody(created: ProjectRequest, body: PostmanBody): Promise<void>;
+    addParamsTextPart(body: IMultipartBody[], param: PostmanFormData): Promise<void>;
+    addParamsFilePart(body: IMultipartBody[], param: PostmanFormData): Promise<void>;
+    addRawBody(created: ProjectRequest, body: PostmanBody): Promise<void>;
+}
+export {};

package/build/src/models/transformers/PostmanV2Transformer.js

@@ -0,0 +1,195 @@
+/* eslint-disable no-unused-vars */
+import { PostmanTransformer, dataValue, paramValue } from './PostmanTransformer.js';
+import { HttpProject, Kind as ProjectKind } from '../HttpProject.js';
+import v4 from '../../lib/uuid.js';
+import { Environment } from '../Environment.js';
+export const currentItemValue = Symbol('currentItemValue');
+/**
+ * Transforms Postman v2 collections to ARC import object.
+ */
+export class PostmanV2Transformer extends PostmanTransformer {
+    /**
+     * Transforms `_data` into ARC data model.
+     * @returns Promise resolved when data are transformed.
+     */
+    async transform() {
+        const raw = this[dataValue];
+        const project = this.createProject(raw);
+        this.setProjectVariables(project, raw);
+        if (Array.isArray(raw.item)) {
+            for (const item of raw.item) {
+                await this.addProjectItem(project, item);
+            }
+        }
+        return project;
+    }
+    createProject(data) {
+        const { info } = data;
+        const init = {
+            kind: ProjectKind,
+            definitions: {},
+            environments: [],
+            info: {
+                kind: 'ARC#Thing',
+                name: info.name || 'Unnamed Postman project',
+            },
+            items: [],
+            key: info._postman_id || v4(),
+        };
+        if (info.description) {
+            init.info.description = info.description;
+        }
+        const project = new HttpProject(init);
+        return project;
+    }
+    setProjectVariables(project, collection) {
+        const { variable } = collection;
+        if (!Array.isArray(variable)) {
+            return;
+        }
+        const env = Environment.fromName('Default');
+        project.addEnvironment(env);
+        variable.forEach((param) => {
+            const { disabled = false, key, value } = param;
+            const parsed = this.ensureVariablesSyntax(value);
+            const created = env.addVariable(key, parsed);
+            created.enabled = !disabled;
+        });
+    }
+    async addProjectItem(current, item) {
+        const typedGroup = item;
+        if (typedGroup.item) {
+            return this.addProjectFolder(current, typedGroup);
+        }
+        const typedItem = item;
+        if (typedItem.request) {
+            return this.addProjectRequest(current, item);
+        }
+        this.addLog('error', 'Error when adding an item to the project. Unable to determine item type. Tested for a folder and a request.');
+    }
+    async addProjectFolder(current, group) {
+        const { description, name = 'Unnamed folder', item } = group;
+        const created = current.addFolder(name);
+        if (description) {
+            created.info.description = description;
+        }
+        if (Array.isArray(item)) {
+            for (const tmp of item) {
+                await this.addProjectItem(created, tmp);
+            }
+        }
+    }
+    async addProjectRequest(current, item) {
+        const { request, description } = item;
+        const name = item.name || 'Unnamed request';
+        let url;
+        if (typeof request.url === 'string') {
+            url = request.url;
+        }
+        else if (request.url && request.url.raw) {
+            url = request.url.raw;
+        }
+        else {
+            url = 'http://';
+        }
+        url = this.ensureVariablesSyntax(url);
+        let method = request.method || 'GET';
+        method = this.ensureVariablesSyntax(method);
+        const header = this.ensureVarsRecursively(request.header);
+        const headers = this.computeHeaders(header);
+        const created = current.addRequest(url);
+        created.info.name = name;
+        if (request.description) {
+            created.info.description = request.description;
+        }
+        else if (description) {
+            created.info.description = description;
+        }
+        created.expects.method = method;
+        if (headers) {
+            created.expects.headers = headers;
+        }
+        await this.addRequestBody(created, request.body);
+    }
+    /**
+     * Computes headers string from item's headers.
+     *
+     * @param headers Postman Request.header model.
+     * @return Computed value of headers.
+     */
+    computeHeaders(headers) {
+        if (typeof headers === 'string') {
+            return headers;
+        }
+        if (!Array.isArray(headers)) {
+            return '';
+        }
+        const tmp = headers.filter((h) => !h.disabled);
+        return tmp.map((item) => `${item.key}: ${item.value}`).join('\n');
+    }
+    async addRequestBody(created, body) {
+        if (!body) {
+            return;
+        }
+        switch (body.mode) {
+            case 'file': return this.addBinaryBody(created, body);
+            case 'urlencoded': return this.addUrlencodedBody(created, body);
+            case 'formdata': return this.addParamsBody(created, body);
+            case 'raw': return this.addRawBody(created, body);
+        }
+    }
+    async addBinaryBody(created, body) {
+        // Postman sets the `body.file.src` property with the path to the file
+        // but not data itself. Because of that this method is a stub that can be extended
+        // by particular implementation (like node, CLI).
+    }
+    async addUrlencodedBody(created, body) {
+        const items = body[body.mode];
+        if (!Array.isArray(items)) {
+            return;
+        }
+        const data = this.ensureVarsRecursively(items);
+        const str = data.map(i => `${paramValue(i.key || 'missing name')}=${paramValue(i.value || '')}`).join('&');
+        await created.expects.writePayload(str);
+    }
+    async addParamsBody(created, body) {
+        const items = body[body.mode];
+        if (!Array.isArray(items)) {
+            return;
+        }
+        const data = this.ensureVarsRecursively(items);
+        const multipartBody = [];
+        for (const part of data) {
+            if (part.type === 'text') {
+                await this.addParamsTextPart(multipartBody, part);
+            }
+            else if (part.type === 'file') {
+                await this.addParamsFilePart(multipartBody, part);
+            }
+        }
+        created.expects.payload = {
+            type: 'formdata',
+            data: multipartBody,
+        };
+    }
+    async addParamsTextPart(body, param) {
+        const { key, value, disabled = false, } = param;
+        body.push({
+            isFile: false,
+            name: key || 'unnamed part',
+            value: value || '',
+            enabled: !disabled,
+        });
+    }
+    async addParamsFilePart(body, param) {
+        // Postman sets the `value` property with the path to the file
+        // but not data itself. Because of that this method is a stub that can be extended
+        // by particular implementation (like node, CLI).
+    }
+    async addRawBody(created, body) {
+        if (body.raw) {
+            await created.expects.writePayload(body.raw);
+        }
+    }
+}
+//# sourceMappingURL=PostmanV2Transformer.js.map

package/build/src/models/transformers/PostmanV2Transformer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PostmanV2Transformer.js","sourceRoot":"","sources":["../../../../src/models/transformers/PostmanV2Transformer.ts"],"names":[],"mappings":"AAAA,mCAAmC;AACnC,OAAO,EAAE,kBAAkB,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AACpF,OAAO,EAAE,WAAW,EAAgB,IAAI,IAAI,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAInF,OAAO,EAAE,MAAM,mBAAmB,CAAC;AACnC,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAEhD,MAAM,CAAC,MAAM,gBAAgB,GAAG,MAAM,CAAC,kBAAkB,CAAC,CAAC;AAiG3D;;GAEG;AACH,MAAM,OAAO,oBAAqB,SAAQ,kBAAkB;IAC1D;;;OAGG;IACH,KAAK,CAAC,SAAS;QACb,MAAM,GAAG,GAAG,IAAI,CAAC,SAAS,CAAc,CAAC;QACzC,MAAM,OAAO,GAAG,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC;QACxC,IAAI,CAAC,mBAAmB,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;QACvC,IAAI,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE;YAC3B,KAAK,MAAM,IAAI,IAAI,GAAG,CAAC,IAAI,EAAE;gBAC3B,MAAM,IAAI,CAAC,cAAc,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;aAC1C;SACF;QACD,OAAO,OAAO,CAAC;IACjB,CAAC;IAED,aAAa,CAAC,IAAe;QAC3B,MAAM,EAAE,IAAI,EAAE,GAAG,IAAI,CAAC;QACtB,MAAM,IAAI,GAAiB;YACzB,IAAI,EAAE,WAAW;YACjB,WAAW,EAAE,EAAE;YACf,YAAY,EAAE,EAAE;YAChB,IAAI,EAAE;gBACJ,IAAI,EAAE,WAAW;gBACjB,IAAI,EAAE,IAAI,CAAC,IAAI,IAAI,yBAAyB;aAC7C;YACD,KAAK,EAAE,EAAE;YACT,GAAG,EAAE,IAAI,CAAC,WAAW,IAAI,EAAE,EAAE;SAC9B,CAAC;QACF,IAAI,IAAI,CAAC,WAAW,EAAE;YACpB,IAAI,CAAC,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC;SAC1C;QACD,MAAM,OAAO,GAAG,IAAI,WAAW,CAAC,IAAI,CAAC,CAAC;QACtC,OAAO,OAAO,CAAC;IACjB,CAAC;IAED,mBAAmB,CAAC,OAAoB,EAAE,UAAqB;QAC7D,MAAM,EAAE,QAAQ,EAAE,GAAG,UAAU,CAAC;QAChC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE;YAC5B,OAAO;SACR;QACD,MAAM,GAAG,GAAG,WAAW,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC;QAC5C,OAAO,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC;QAC5B,QAAQ,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;YACzB,MAAM,EAAE,QAAQ,GAAC,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,KAAK,CAAC;YAE7C,MAAM,MAAM,GAAG,IAAI,CAAC,qBAAqB,CAAC,KAAK,CAAW,CAAC;YAC3D,MAAM,OAAO,GAAG,GAAG,CAAC,WAAW,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;YAC7C,OAAO,CAAC,OAAO,GAAG,CAAC,QAAQ,CAAC;QAC9B,CAAC,CAAC,CAAC;IACL,CAAC;IAED,KAAK,CAAC,cAAc,CAAC,OAAoC,EAAE,IAAoC;QAC7F,MAAM,UAAU,GAAG,IAAwB,CAAC;QAC5C,IAAI,UAAU,CAAC,IAAI,EAAE;YACnB,OAAO,IAAI,CAAC,gBAAgB,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;SACnD;QACD,MAAM,SAAS,GAAG,IAAmB,CAAC;QACtC,IAAI,SAAS,CAAC,OAAO,EAAE;YACrB,OAAO,IAAI,CAAC,iBAAiB,CAAC,OAAO,EAAE,IAAmB,CAAC,CAAC;SAC7D;QACD,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,6GAA6G,CAAC,CAAC;IACtI,CAAC;IAED,KAAK,CAAC,gBAAgB,CAAC,OAAoC,EAAE,KAAuB;QAClF,MAAM,EAAE,WAAW,EAAE,IAAI,GAAC,gBAAgB,EAAE,IAAI,EAAE,GAAG,KAAK,CAAC;QAC3D,MAAM,OAAO,GAAG,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QACxC,IAAI,WAAW,EAAE;YACf,OAAO,CAAC,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;SACxC;QAED,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;YACvB,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE;gBACtB,MAAM,IAAI,CAAC,cAAc,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;aACzC;SACF;IACH,CAAC;IAED,KAAK,CAAC,iBAAiB,CAAC,OAAoC,EAAE,IAAiB;QAC7E,MAAM,EAAE,OAAO,EAAE,WAAW,EAAE,GAAG,IAAI,CAAC;QACtC,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,IAAI,iBAAiB,CAAC;QAC5C,IAAI,GAAW,CAAC;QAChB,IAAI,OAAO,OAAO,CAAC,GAAG,KAAK,QAAQ,EAAE;YACnC,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC;SACnB;aAAM,IAAI,OAAO,CAAC,GAAG,IAAI,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE;YACzC,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC;SACvB;aAAM;YACL,GAAG,GAAG,SAAS,CAAC;SACjB;QACD,GAAG,GAAG,IAAI,CAAC,qBAAqB,CAAC,GAAG,CAAW,CAAC;QAChD,IAAI,MAAM,GAAG,OAAO,CAAC,MAAM,IAAI,KAAK,CAAC;QACrC,MAAM,GAAG,IAAI,CAAC,qBAAqB,CAAC,MAAM,CAAW,CAAC;QAEtD,MAAM,MAAM,GAAG,IAAI,CAAC,qBAAqB,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QAC1D,MAAM,OAAO,GAAG,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;QAE5C,MAAM,OAAO,GAAG,OAAO,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;QACxC,OAAO,CAAC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACzB,IAAI,OAAO,CAAC,WAAW,EAAE;YACvB,OAAO,CAAC,IAAI,CAAC,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC;SAChD;aAAM,IAAI,WAAW,EAAE;YACtB,OAAO,CAAC,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;SACxC;QACD,OAAO,CAAC,OAAO,CAAC,MAAM,GAAG,MAAM,CAAC;QAChC,IAAI,OAAO,EAAE;YACX,OAAO,CAAC,OAAO,CAAC,OAAO,GAAG,OAAO,CAAC;SACnC;QAED,MAAM,IAAI,CAAC,cAAc,CAAC,OAAO,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;IACnD,CAAC;IAED;;;;;OAKG;IACH,cAAc,CAAC,OAAmC;QAChD,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE;YAC/B,OAAO,OAAO,CAAC;SAChB;QACD,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE;YAC3B,OAAO,EAAE,CAAC;SACX;QACD,MAAM,GAAG,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC;QAC/C,OAAO,GAAG,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,GAAG,IAAI,CAAC,GAAG,KAAK,IAAI,CAAC,KAAK,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACpE,CAAC;IAED,KAAK,CAAC,cAAc,CAAC,OAAuB,EAAE,IAAkB;QAC9D,IAAI,CAAC,IAAI,EAAE;YACT,OAAO;SACR;QACD,QAAQ,IAAI,CAAC,IAAI,EAAE;YACjB,KAAK,MAAM,CAAC,CAAC,OAAO,IAAI,CAAC,aAAa,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;YACtD,KAAK,YAAY,CAAC,CAAC,OAAO,IAAI,CAAC,iBAAiB,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;YAChE,KAAK,UAAU,CAAC,CAAC,OAAO,IAAI,CAAC,aAAa,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;YAC1D,KAAK,KAAK,CAAC,CAAC,OAAO,IAAI,CAAC,UAAU,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;SACnD;IACH,CAAC;IAED,KAAK,CAAC,aAAa,CAAC,OAAuB,EAAE,IAAiB;QAC5D,sEAAsE;QACtE,kFAAkF;QAClF,iDAAiD;IACnD,CAAC;IAED,KAAK,CAAC,iBAAiB,CAAC,OAAuB,EAAE,IAAiB;QAChE,MAAM,KAAK,GAAG,IAAI,CAAC,IAAI,CAAC,IAAyB,CAAwB,CAAC;QAC1E,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;YACzB,OAAO;SACR;QACD,MAAM,IAAI,GAAG,IAAI,CAAC,qBAAqB,CAAC,KAAK,CAAwB,CAAC;QACtE,MAAM,GAAG,GAAI,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,GAAG,UAAU,CAAC,CAAC,CAAC,GAAG,IAAI,cAAc,CAAC,IAAI,UAAU,CAAC,CAAC,CAAC,KAAK,IAAI,EAAE,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAC5G,MAAM,OAAO,CAAC,OAAO,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC;IAC1C,CAAC;IAED,KAAK,CAAC,aAAa,CAAC,OAAuB,EAAE,IAAiB;QAC5D,MAAM,KAAK,GAAG,IAAI,CAAC,IAAI,CAAC,IAAyB,CAAsB,CAAC;QACxE,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;YACzB,OAAO;SACR;QACD,MAAM,IAAI,GAAG,IAAI,CAAC,qBAAqB,CAAC,KAAK,CAAsB,CAAC;QACpE,MAAM,aAAa,GAAqB,EAAE,CAAC;QAC3C,KAAK,MAAM,IAAI,IAAI,IAAI,EAAE;YACvB,IAAI,IAAI,CAAC,IAAI,KAAK,MAAM,EAAE;gBACxB,MAAM,IAAI,CAAC,iBAAiB,CAAC,aAAa,EAAE,IAAI,CAAC,CAAC;aACnD;iBAAM,IAAI,IAAI,CAAC,IAAI,KAAK,MAAM,EAAE;gBAC/B,MAAM,IAAI,CAAC,iBAAiB,CAAC,aAAa,EAAE,IAAI,CAAC,CAAC;aACnD;SACF;QACD,OAAO,CAAC,OAAO,CAAC,OAAO,GAAG;YACxB,IAAI,EAAE,UAAU;YAChB,IAAI,EAAE,aAAa;SACpB,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,iBAAiB,CAAC,IAAsB,EAAE,KAAsB;QACpE,MAAM,EAAE,GAAG,EAAE,KAAK,EAAE,QAAQ,GAAC,KAAK,GAAG,GAAG,KAAK,CAAC;QAC9C,IAAI,CAAC,IAAI,CAAC;YACR,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,GAAG,IAAI,cAAc;YAC3B,KAAK,EAAE,KAAK,IAAI,EAAE;YAClB,OAAO,EAAE,CAAC,QAAQ;SACnB,CAAC,CAAC;IACL,CAAC;IAED,KAAK,CAAC,iBAAiB,CAAC,IAAsB,EAAE,KAAsB;QACpE,8DAA8D;QAC9D,kFAAkF;QAClF,iDAAiD;IACnD,CAAC;IAED,KAAK,CAAC,UAAU,CAAC,OAAuB,EAAE,IAAiB;QACzD,IAAI,IAAI,CAAC,GAAG,EAAE;YACZ,MAAM,OAAO,CAAC,OAAO,CAAC,YAAY,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;SAC9C;IACH,CAAC;CACF"}