@api-client/core 0.10.13 → 0.11.0

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

@@ -0,0 +1,50 @@
+import { HttpProject } from '../HttpProject.js';
+export declare const postmanVarRegex: RegExp;
+/**
+ * Replacer function for regex replace to be used to replace variables
+ * notation to ARC's
+ *
+ * @param match
+ * @param value
+ * @return Value to be replaced in the string.
+ */
+export declare function variablesReplacerFunction(match: string, value: string): string;
+/**
+ * Parse input string as a payload param key or value.
+ *
+ * @param input An input to parse.
+ * @return Trimmed string
+ */
+export declare function paramValue(input: string): string;
+export declare const dataValue: unique symbol;
+export type PostmanImportLogLevel = 'error' | 'warning' | 'info';
+export interface PostmanImportLog {
+    type: PostmanImportLogLevel;
+    message: string;
+}
+/**
+ * Base class for all Postman transformers
+ */
+export declare abstract class PostmanTransformer {
+    [dataValue]: any;
+    logs: PostmanImportLog[];
+    /**
+     * @param data Data to be transformed.
+     */
+    constructor(data: any);
+    addLog(type: PostmanImportLogLevel, message: string): void;
+    /**
+     * Replaces any occurrence of {{STRING}} with ARC's variables syntax.
+     *
+     * @param str A string value to check for variables.
+     * @return The same string with ARC's variables syntax
+     */
+    ensureVariablesSyntax(str?: string): string | undefined;
+    ensureVarsRecursively(obj: any): any;
+    /**
+     * Transforms the data into ARC data model.
+     * @returns Promise resolved when data are transformed.
+     */
+    abstract transform(): Promise<HttpProject | HttpProject[]>;
+}
+//# sourceMappingURL=PostmanTransformer.d.ts.map

package/build/src/models/transformers/PostmanTransformer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"PostmanTransformer.d.ts","sourceRoot":"","sources":["../../../../src/models/transformers/PostmanTransformer.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAA;AAE/C,eAAO,MAAM,eAAe,QAAqB,CAAA;AAEjD;;;;;;;GAOG;AACH,wBAAgB,yBAAyB,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,CAc9E;AAED;;;;;GAKG;AACH,wBAAgB,UAAU,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAOhD;AAED,eAAO,MAAM,SAAS,eAAsB,CAAA;AAE5C,MAAM,MAAM,qBAAqB,GAAG,OAAO,GAAG,SAAS,GAAG,MAAM,CAAA;AAEhE,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,qBAAqB,CAAA;IAC3B,OAAO,EAAE,MAAM,CAAA;CAChB;AAED;;GAEG;AACH,8BAAsB,kBAAkB;IACtC,CAAC,SAAS,CAAC,EAAE,GAAG,CAAA;IAChB,IAAI,EAAE,gBAAgB,EAAE,CAAK;IAE7B;;OAEG;gBACS,IAAI,EAAE,GAAG;IAIrB,MAAM,CAAC,IAAI,EAAE,qBAAqB,EAAE,OAAO,EAAE,MAAM,GAAG,IAAI;IAO1D;;;;;OAKG;IACH,qBAAqB,CAAC,GAAG,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS;IAWvD,qBAAqB,CAAC,GAAG,EAAE,GAAG,GAAG,GAAG;IAgBpC;;;OAGG;IACH,QAAQ,CAAC,SAAS,IAAI,OAAO,CAAC,WAAW,GAAG,WAAW,EAAE,CAAC;CAC3D"}

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

@@ -0,0 +1 @@
+{"version":3,"file":"PostmanTransformer.js","sourceRoot":"","sources":["../../../../src/models/transformers/PostmanTransformer.ts"],"names":[],"mappings":"AAGA,MAAM,CAAC,MAAM,eAAe,GAAG,kBAAkB,CAAA;AAEjD;;;;;;;GAOG;AACH,MAAM,UAAU,yBAAyB,CAAC,KAAa,EAAE,KAAa;IACpE,QAAQ,KAAK,EAAE,CAAC;QACd,KAAK,YAAY;YACf,KAAK,GAAG,UAAU,CAAA;YAClB,MAAK;QACP,KAAK,OAAO;YACV,KAAK,GAAG,QAAQ,CAAA;YAChB,MAAK;QACP,KAAK,YAAY;YACf,KAAK,GAAG,OAAO,CAAA;YACf,MAAK;QACP,QAAQ;IACV,CAAC;IACD,OAAO,MAAM,KAAK,GAAG,CAAA;AACvB,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,UAAU,CAAC,KAAa;IACtC,IAAI,CAAC,KAAK,EAAE,CAAC;QACX,OAAO,MAAM,EAAE,CAAA;IACjB,CAAC;IACD,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC,CAAA;IACrB,KAAK,GAAG,KAAK,CAAC,IAAI,EAAE,CAAA;IACpB,OAAO,KAAK,CAAA;AACd,CAAC;AAED,MAAM,CAAC,MAAM,SAAS,GAAG,MAAM,CAAC,WAAW,CAAC,CAAA;AAS5C;;GAEG;AACH,MAAM,OAAgB,kBAAkB;IACtC,CAAC,SAAS,CAAC,CAAK;IAChB,IAAI,GAAuB,EAAE,CAAA;IAE7B;;OAEG;IACH,YAAY,IAAS;QACnB,IAAI,CAAC,SAAS,CAAC,GAAG,IAAI,CAAA;IACxB,CAAC;IAED,MAAM,CAAC,IAA2B,EAAE,OAAe;QACjD,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC;YACb,IAAI;YACJ,OAAO;SACR,CAAC,CAAA;IACJ,CAAC;IAED;;;;;OAKG;IACH,qBAAqB,CAAC,GAAY;QAChC,IAAI,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC;YACzB,OAAO,GAAG,CAAA;QACZ,CAAC;QACD,wDAAwD;QACxD,IAAI,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC;YAC7B,GAAG,GAAG,GAAG,CAAC,OAAO,CAAC,eAAe,EAAE,yBAAyB,CAAC,CAAA;QAC/D,CAAC;QACD,OAAO,GAAG,CAAA;IACZ,CAAC;IAED,qBAAqB,CAAC,GAAQ;QAC5B,IAAI,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC;YACvB,OAAO,GAAG,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,qBAAqB,CAAC,IAAI,CAAC,CAAC,CAAA;QAC5D,CAAC;QACD,IAAI,GAAG,KAAK,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC;YACxB,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;gBAC/B,GAAG,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,qBAAqB,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAA;YACjD,CAAC,CAAC,CAAA;YACF,OAAO,GAAG,CAAA;QACZ,CAAC;QACD,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAC;YAC5B,OAAO,IAAI,CAAC,qBAAqB,CAAC,GAAG,CAAC,CAAA;QACxC,CAAC;QACD,OAAO,GAAG,CAAA;IACZ,CAAC;CAOF","sourcesContent":["/* eslint-disable @typescript-eslint/no-explicit-any */\nimport { HttpProject } from '../HttpProject.js'\n\nexport const postmanVarRegex = /\\{\\{(.*?)\\}\\}/gim\n\n/**\n * Replacer function for regex replace to be used to replace variables\n * notation to ARC's\n *\n * @param match\n * @param value\n * @return Value to be replaced in the string.\n */\nexport function variablesReplacerFunction(match: string, value: string): string {\n  switch (value) {\n    case '$randomInt':\n      value = 'random()'\n      break\n    case '$guid':\n      value = 'uuid()'\n      break\n    case '$timestamp':\n      value = 'now()'\n      break\n    default:\n  }\n  return `\\${${value}}`\n}\n\n/**\n * Parse input string as a payload param key or value.\n *\n * @param input An input to parse.\n * @return Trimmed string\n */\nexport function paramValue(input: string): string {\n  if (!input) {\n    return String()\n  }\n  input = String(input)\n  input = input.trim()\n  return input\n}\n\nexport const dataValue = Symbol('dataValue')\n\nexport type PostmanImportLogLevel = 'error' | 'warning' | 'info'\n\nexport interface PostmanImportLog {\n  type: PostmanImportLogLevel\n  message: string\n}\n\n/**\n * Base class for all Postman transformers\n */\nexport abstract class PostmanTransformer {\n  [dataValue]: any\n  logs: PostmanImportLog[] = []\n\n  /**\n   * @param data Data to be transformed.\n   */\n  constructor(data: any) {\n    this[dataValue] = data\n  }\n\n  addLog(type: PostmanImportLogLevel, message: string): void {\n    this.logs.push({\n      type,\n      message,\n    })\n  }\n\n  /**\n   * Replaces any occurrence of {{STRING}} with ARC's variables syntax.\n   *\n   * @param str A string value to check for variables.\n   * @return The same string with ARC's variables syntax\n   */\n  ensureVariablesSyntax(str?: string): string | undefined {\n    if (!str || !str.indexOf) {\n      return str\n    }\n    // https://jsperf.com/regex-replace-with-test-conditions\n    if (str.indexOf('{{') !== -1) {\n      str = str.replace(postmanVarRegex, variablesReplacerFunction)\n    }\n    return str\n  }\n\n  ensureVarsRecursively(obj: any): any {\n    if (Array.isArray(obj)) {\n      return obj.map((item) => this.ensureVarsRecursively(item))\n    }\n    if (obj === Object(obj)) {\n      Object.keys(obj).forEach((key) => {\n        obj[key] = this.ensureVarsRecursively(obj[key])\n      })\n      return obj\n    }\n    if (typeof obj === 'string') {\n      return this.ensureVariablesSyntax(obj)\n    }\n    return obj\n  }\n\n  /**\n   * Transforms the data into ARC data model.\n   * @returns Promise resolved when data are transformed.\n   */\n  abstract transform(): Promise<HttpProject | HttpProject[]>\n}\n"]}

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

@@ -0,0 +1,129 @@
+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;
+}
+type PostmanHeader = PostmanParameter;
+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 | PostmanHeader[];
+    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.1 collections to ARC import object.
+ */
+export declare class PostmanV21Transformer 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.
+     * @returns Computed value of headers.
+     */
+    computeHeaders(headers: string | PostmanHeader[]): 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 {};
+//# sourceMappingURL=PostmanV21Transformer.d.ts.map

package/build/src/models/transformers/PostmanV21Transformer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"PostmanV21Transformer.d.ts","sourceRoot":"","sources":["../../../../src/models/transformers/PostmanV21Transformer.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,kBAAkB,EAAyB,MAAM,yBAAyB,CAAA;AACnF,OAAO,EAAE,WAAW,EAAqC,MAAM,mBAAmB,CAAA;AAClF,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAA;AACnD,OAAO,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAA;AACrD,OAAO,EAAE,cAAc,EAAE,MAAM,6CAA6C,CAAA;AAK5E,eAAO,MAAM,gBAAgB,eAA6B,CAAA;AAE1D,UAAU,WAAW;IACnB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IACZ;;OAEG;IACH,MAAM,EAAE,MAAM,CAAA;IACd;;;;;OAKG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB;AAED,UAAU,iBAAiB;IACzB,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IACxB,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IACxB,IAAI,CAAC,EAAE,MAAM,CAAA;CACd;AACD,UAAU,gBAAgB;IACxB,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACnB,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACrB,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB;AACD,KAAK,aAAa,GAAG,gBAAgB,CAAA;AACrC,UAAU,iBAAkB,SAAQ,gBAAgB;IAClD,IAAI,CAAC,EAAE,MAAM,CAAA;CACd;AACD,UAAU,eAAgB,SAAQ,gBAAgB;IAChD,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB;AACD,UAAU,WAAW;IACnB,GAAG,EAAE,MAAM,GAAG,IAAI,CAAA;IAClB,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB;AACD,UAAU,WAAW;IACnB,IAAI,EAAE,MAAM,GAAG,IAAI,CAAA;IACnB,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,UAAU,CAAC,EAAE,iBAAiB,EAAE,CAAA;IAChC,QAAQ,CAAC,EAAE,eAAe,EAAE,CAAA;IAC5B,IAAI,CAAC,EAAE,WAAW,CAAA;CACnB;AAED,UAAU,cAAc;IACtB,GAAG,CAAC,EAAE,MAAM,GAAG,iBAAiB,CAAA;IAChC,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,MAAM,CAAC,EAAE,MAAM,GAAG,aAAa,EAAE,CAAA;IACjC,IAAI,CAAC,EAAE,WAAW,CAAA;CACnB;AAGD,UAAU,eAAe;CAAG;AAE5B,UAAU,WAAW;IACnB;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAA;IACX;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,OAAO,EAAE,cAAc,CAAA;IACvB,QAAQ,CAAC,EAAE,eAAe,EAAE,CAAA;CAC7B;AAED,UAAU,gBAAgB;IACxB;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,IAAI,EAAE,WAAW,EAAE,GAAG,gBAAgB,EAAE,CAAA;CACzC;AAED,UAAU,eAAe;IACvB,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,GAAG,EAAE,MAAM,CAAA;IACX,KAAK,EAAE,MAAM,CAAA;CACd;AAED,UAAU,SAAS;IACjB,QAAQ,CAAC,EAAE,eAAe,EAAE,CAAA;IAC5B,IAAI,EAAE,WAAW,CAAA;IACjB,IAAI,EAAE,WAAW,EAAE,GAAG,gBAAgB,EAAE,CAAA;CACzC;AAED;;GAEG;AACH,qBAAa,qBAAsB,SAAQ,kBAAkB;IAC3D;;;OAGG;IACG,SAAS,IAAI,OAAO,CAAC,WAAW,CAAC;IAYvC,aAAa,CAAC,IAAI,EAAE,SAAS,GAAG,WAAW;IAgB3C,mBAAmB,CAAC,OAAO,EAAE,WAAW,EAAE,UAAU,EAAE,SAAS,GAAG,IAAI;IAgBhE,cAAc,CAAC,OAAO,EAAE,WAAW,GAAG,aAAa,EAAE,IAAI,EAAE,WAAW,GAAG,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC;IAezG,gBAAgB,CAAC,OAAO,EAAE,WAAW,GAAG,aAAa,EAAE,KAAK,EAAE,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC;IAc9F,iBAAiB,CAAC,OAAO,EAAE,WAAW,GAAG,aAAa,EAAE,IAAI,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC;IAiC/F;;;;;OAKG;IACH,cAAc,CAAC,OAAO,EAAE,MAAM,GAAG,aAAa,EAAE,GAAG,MAAM;IAWnD,cAAc,CAAC,OAAO,EAAE,cAAc,EAAE,IAAI,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC;IAgB1E,aAAa,CAAC,OAAO,EAAE,cAAc,EAAE,IAAI,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC;IAMxE,iBAAiB,CAAC,OAAO,EAAE,cAAc,EAAE,IAAI,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC;IAU5E,aAAa,CAAC,OAAO,EAAE,cAAc,EAAE,IAAI,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC;IAoBxE,iBAAiB,CAAC,IAAI,EAAE,cAAc,EAAE,EAAE,KAAK,EAAE,eAAe,GAAG,OAAO,CAAC,IAAI,CAAC;IAUhF,iBAAiB,CAAC,IAAI,EAAE,cAAc,EAAE,EAAE,KAAK,EAAE,eAAe,GAAG,OAAO,CAAC,IAAI,CAAC;IAMhF,UAAU,CAAC,OAAO,EAAE,cAAc,EAAE,IAAI,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC;CAK5E"}

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

@@ -0,0 +1,196 @@
+/* eslint-disable @typescript-eslint/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';
+import { Thing } from '../Thing.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: {},
+            info: Thing.fromName(info.name || 'Unnamed Postman project').toJSON(),
+            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,sDAAsD;AACtD,OAAO,EAAE,kBAAkB,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAA;AACnF,OAAO,EAAE,WAAW,EAAgB,IAAI,IAAI,WAAW,EAAE,MAAM,mBAAmB,CAAA;AAIlF,OAAO,EAAE,MAAM,mBAAmB,CAAA;AAClC,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAA;AAC/C,OAAO,EAAE,KAAK,EAAE,MAAM,aAAa,CAAA;AAEnC,MAAM,CAAC,MAAM,gBAAgB,GAAG,MAAM,CAAC,kBAAkB,CAAC,CAAA;AAsG1D;;GAEG;AACH,MAAM,OAAO,qBAAsB,SAAQ,kBAAkB;IAC3D;;;OAGG;IACH,KAAK,CAAC,SAAS;QACb,MAAM,GAAG,GAAG,IAAI,CAAC,SAAS,CAAc,CAAA;QACxC,MAAM,OAAO,GAAG,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,CAAA;QACvC,IAAI,CAAC,mBAAmB,CAAC,OAAO,EAAE,GAAG,CAAC,CAAA;QACtC,IAAI,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC;YAC5B,KAAK,MAAM,IAAI,IAAI,GAAG,CAAC,IAAI,EAAE,CAAC;gBAC5B,MAAM,IAAI,CAAC,cAAc,CAAC,OAAO,EAAE,IAAI,CAAC,CAAA;YAC1C,CAAC;QACH,CAAC;QACD,OAAO,OAAO,CAAA;IAChB,CAAC;IAED,aAAa,CAAC,IAAe;QAC3B,MAAM,EAAE,IAAI,EAAE,GAAG,IAAI,CAAA;QACrB,MAAM,IAAI,GAAiB;YACzB,IAAI,EAAE,WAAW;YACjB,WAAW,EAAE,EAAE;YACf,IAAI,EAAE,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,IAAI,yBAAyB,CAAC,CAAC,MAAM,EAAE;YACrE,KAAK,EAAE,EAAE;YACT,GAAG,EAAE,IAAI,CAAC,WAAW,IAAI,EAAE,EAAE;SAC9B,CAAA;QACD,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;YACrB,IAAI,CAAC,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,CAAA;QAC1C,CAAC;QACD,MAAM,OAAO,GAAG,IAAI,WAAW,CAAC,IAAI,CAAC,CAAA;QACrC,OAAO,OAAO,CAAA;IAChB,CAAC;IAED,mBAAmB,CAAC,OAAoB,EAAE,UAAqB;QAC7D,MAAM,EAAE,QAAQ,EAAE,GAAG,UAAU,CAAA;QAC/B,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC7B,OAAM;QACR,CAAC;QACD,MAAM,GAAG,GAAG,WAAW,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAA;QAC3C,OAAO,CAAC,cAAc,CAAC,GAAG,CAAC,CAAA;QAC3B,QAAQ,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;YACzB,MAAM,EAAE,QAAQ,GAAG,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,KAAK,CAAA;YAE9C,MAAM,MAAM,GAAG,IAAI,CAAC,qBAAqB,CAAC,KAAK,CAAW,CAAA;YAC1D,MAAM,OAAO,GAAG,GAAG,CAAC,WAAW,CAAC,GAAG,EAAE,MAAM,CAAC,CAAA;YAC5C,OAAO,CAAC,OAAO,GAAG,CAAC,QAAQ,CAAA;QAC7B,CAAC,CAAC,CAAA;IACJ,CAAC;IAED,KAAK,CAAC,cAAc,CAAC,OAAoC,EAAE,IAAoC;QAC7F,MAAM,UAAU,GAAG,IAAwB,CAAA;QAC3C,IAAI,UAAU,CAAC,IAAI,EAAE,CAAC;YACpB,OAAO,IAAI,CAAC,gBAAgB,CAAC,OAAO,EAAE,UAAU,CAAC,CAAA;QACnD,CAAC;QACD,MAAM,SAAS,GAAG,IAAmB,CAAA;QACrC,IAAI,SAAS,CAAC,OAAO,EAAE,CAAC;YACtB,OAAO,IAAI,CAAC,iBAAiB,CAAC,OAAO,EAAE,IAAmB,CAAC,CAAA;QAC7D,CAAC;QACD,IAAI,CAAC,MAAM,CACT,OAAO,EACP,6GAA6G,CAC9G,CAAA;IACH,CAAC;IAED,KAAK,CAAC,gBAAgB,CAAC,OAAoC,EAAE,KAAuB;QAClF,MAAM,EAAE,WAAW,EAAE,IAAI,GAAG,gBAAgB,EAAE,IAAI,EAAE,GAAG,KAAK,CAAA;QAC5D,MAAM,OAAO,GAAG,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,CAAA;QACvC,IAAI,WAAW,EAAE,CAAC;YAChB,OAAO,CAAC,IAAI,CAAC,WAAW,GAAG,WAAW,CAAA;QACxC,CAAC;QAED,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;YACxB,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;gBACvB,MAAM,IAAI,CAAC,cAAc,CAAC,OAAO,EAAE,GAAG,CAAC,CAAA;YACzC,CAAC;QACH,CAAC;IACH,CAAC;IAED,KAAK,CAAC,iBAAiB,CAAC,OAAoC,EAAE,IAAiB;QAC7E,MAAM,EAAE,OAAO,EAAE,WAAW,EAAE,GAAG,IAAI,CAAA;QACrC,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,IAAI,iBAAiB,CAAA;QAC3C,IAAI,GAAW,CAAA;QACf,IAAI,OAAO,OAAO,CAAC,GAAG,KAAK,QAAQ,EAAE,CAAC;YACpC,GAAG,GAAG,OAAO,CAAC,GAAG,CAAA;QACnB,CAAC;aAAM,IAAI,OAAO,CAAC,GAAG,IAAI,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC;YAC1C,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC,GAAG,CAAA;QACvB,CAAC;aAAM,CAAC;YACN,GAAG,GAAG,SAAS,CAAA;QACjB,CAAC;QACD,GAAG,GAAG,IAAI,CAAC,qBAAqB,CAAC,GAAG,CAAW,CAAA;QAC/C,IAAI,MAAM,GAAG,OAAO,CAAC,MAAM,IAAI,KAAK,CAAA;QACpC,MAAM,GAAG,IAAI,CAAC,qBAAqB,CAAC,MAAM,CAAW,CAAA;QAErD,MAAM,MAAM,GAAG,IAAI,CAAC,qBAAqB,CAAC,OAAO,CAAC,MAAM,CAAC,CAAA;QACzD,MAAM,OAAO,GAAG,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,CAAA;QAE3C,MAAM,OAAO,GAAG,OAAO,CAAC,UAAU,CAAC,GAAG,CAAC,CAAA;QACvC,OAAO,CAAC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAA;QACxB,IAAI,OAAO,CAAC,WAAW,EAAE,CAAC;YACxB,OAAO,CAAC,IAAI,CAAC,WAAW,GAAG,OAAO,CAAC,WAAW,CAAA;QAChD,CAAC;aAAM,IAAI,WAAW,EAAE,CAAC;YACvB,OAAO,CAAC,IAAI,CAAC,WAAW,GAAG,WAAW,CAAA;QACxC,CAAC;QACD,OAAO,CAAC,OAAO,CAAC,MAAM,GAAG,MAAM,CAAA;QAC/B,IAAI,OAAO,EAAE,CAAC;YACZ,OAAO,CAAC,OAAO,CAAC,OAAO,GAAG,OAAO,CAAA;QACnC,CAAC;QAED,MAAM,IAAI,CAAC,cAAc,CAAC,OAAO,EAAE,OAAO,CAAC,IAAI,CAAC,CAAA;IAClD,CAAC;IAED;;;;;OAKG;IACH,cAAc,CAAC,OAAiC;QAC9C,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE,CAAC;YAChC,OAAO,OAAO,CAAA;QAChB,CAAC;QACD,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;YAC5B,OAAO,EAAE,CAAA;QACX,CAAC;QACD,MAAM,GAAG,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAA;QAC9C,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,CAAA;IACnE,CAAC;IAED,KAAK,CAAC,cAAc,CAAC,OAAuB,EAAE,IAAkB;QAC9D,IAAI,CAAC,IAAI,EAAE,CAAC;YACV,OAAM;QACR,CAAC;QACD,QAAQ,IAAI,CAAC,IAAI,EAAE,CAAC;YAClB,KAAK,MAAM;gBACT,OAAO,IAAI,CAAC,aAAa,CAAC,OAAO,EAAE,IAAI,CAAC,CAAA;YAC1C,KAAK,YAAY;gBACf,OAAO,IAAI,CAAC,iBAAiB,CAAC,OAAO,EAAE,IAAI,CAAC,CAAA;YAC9C,KAAK,UAAU;gBACb,OAAO,IAAI,CAAC,aAAa,CAAC,OAAO,EAAE,IAAI,CAAC,CAAA;YAC1C,KAAK,KAAK;gBACR,OAAO,IAAI,CAAC,UAAU,CAAC,OAAO,EAAE,IAAI,CAAC,CAAA;QACzC,CAAC;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,CAAA;QACzE,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;YAC1B,OAAM;QACR,CAAC;QACD,MAAM,IAAI,GAAG,IAAI,CAAC,qBAAqB,CAAC,KAAK,CAAwB,CAAA;QACrE,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,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,CAAA;QAC5G,MAAM,OAAO,CAAC,OAAO,CAAC,YAAY,CAAC,GAAG,CAAC,CAAA;IACzC,CAAC;IAED,KAAK,CAAC,aAAa,CAAC,OAAuB,EAAE,IAAiB;QAC5D,MAAM,KAAK,GAAG,IAAI,CAAC,IAAI,CAAC,IAAyB,CAAsB,CAAA;QACvE,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;YAC1B,OAAM;QACR,CAAC;QACD,MAAM,IAAI,GAAG,IAAI,CAAC,qBAAqB,CAAC,KAAK,CAAsB,CAAA;QACnE,MAAM,aAAa,GAAqB,EAAE,CAAA;QAC1C,KAAK,MAAM,IAAI,IAAI,IAAI,EAAE,CAAC;YACxB,IAAI,IAAI,CAAC,IAAI,KAAK,MAAM,EAAE,CAAC;gBACzB,MAAM,IAAI,CAAC,iBAAiB,CAAC,aAAa,EAAE,IAAI,CAAC,CAAA;YACnD,CAAC;iBAAM,IAAI,IAAI,CAAC,IAAI,KAAK,MAAM,EAAE,CAAC;gBAChC,MAAM,IAAI,CAAC,iBAAiB,CAAC,aAAa,EAAE,IAAI,CAAC,CAAA;YACnD,CAAC;QACH,CAAC;QACD,OAAO,CAAC,OAAO,CAAC,OAAO,GAAG;YACxB,IAAI,EAAE,UAAU;YAChB,IAAI,EAAE,aAAa;SACpB,CAAA;IACH,CAAC;IAED,KAAK,CAAC,iBAAiB,CAAC,IAAsB,EAAE,KAAsB;QACpE,MAAM,EAAE,GAAG,EAAE,KAAK,EAAE,QAAQ,GAAG,KAAK,EAAE,GAAG,KAAK,CAAA;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,CAAA;IACJ,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,CAAC;YACb,MAAM,OAAO,CAAC,OAAO,CAAC,YAAY,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;QAC9C,CAAC;IACH,CAAC;CACF","sourcesContent":["/* eslint-disable @typescript-eslint/no-unused-vars */\nimport { PostmanTransformer, dataValue, paramValue } from './PostmanTransformer.js'\nimport { HttpProject, IHttpProject, Kind as ProjectKind } from '../HttpProject.js'\nimport { ProjectFolder } from '../ProjectFolder.js'\nimport { ProjectRequest } from '../ProjectRequest.js'\nimport { IMultipartBody } from '../../lib/transformers/PayloadSerializer.js'\nimport v4 from '../../lib/uuid.js'\nimport { Environment } from '../Environment.js'\nimport { Thing } from '../Thing.js'\n\nexport const currentItemValue = Symbol('currentItemValue')\n\ninterface PostmanInfo {\n  /**\n   * Name of the collection\n   */\n  name: string\n  /**\n   * 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\n   */\n  schema: string\n  /**\n   * Every collection is identified by the unique value of this field. The value of this field is usually\n   * easiest to generate using a UID generator function. If you already have a collection, it is recommended\n   * that you maintain the same id since changing the id usually implies that is a different collection than\n   * it was originally.\\n *Note: This field exists for compatibility reasons with Collection Format V1.\n   */\n  _postman_id?: string\n  description?: string\n}\n\ninterface PostmanRequestUrl {\n  raw?: string\n  protocol?: string\n  host?: string | string[]\n  path?: string | string[]\n  port?: string\n}\ninterface PostmanParameter {\n  key?: string | null\n  value?: string | null\n  disabled?: boolean\n  description?: string\n}\ntype PostmanHeader = PostmanParameter\ninterface PostmanUrlEncoded extends PostmanParameter {\n  type?: string\n}\ninterface PostmanFormData extends PostmanParameter {\n  type?: string\n  src?: string\n  contentType?: string\n}\ninterface PostmanFile {\n  src: string | null\n  contentType?: string\n}\ninterface PostmanBody {\n  mode: string | null\n  raw?: string\n  urlencoded?: PostmanUrlEncoded[]\n  formdata?: PostmanFormData[]\n  file?: PostmanFile\n}\n\ninterface PostmanRequest {\n  url?: string | PostmanRequestUrl\n  method?: string\n  description?: string\n  header?: string | PostmanHeader[]\n  body?: PostmanBody\n}\n\n// eslint-disable-next-line @typescript-eslint/no-empty-object-type\ninterface PostmanResponse {}\n\ninterface PostmanItem {\n  /**\n   * A unique ID that is used to identify collections internally\n   */\n  id?: string\n  /**\n   * Name of the collection\n   */\n  name?: string\n  description?: string\n  request: PostmanRequest\n  response?: PostmanResponse[]\n}\n\ninterface PostmanItemGroup {\n  /**\n   * A folder's friendly name is defined by this field. You would want to set this field\n   * to a value that would allow you to easily identify this folder.\n   */\n  name?: string\n  description?: string\n  item: PostmanItem[] | PostmanItemGroup[]\n}\n\ninterface PostmanVariable {\n  disabled?: boolean\n  key: string\n  value: string\n}\n\ninterface PostmanV2 {\n  variable?: PostmanVariable[]\n  info: PostmanInfo\n  item: PostmanItem[] | PostmanItemGroup[]\n}\n\n/**\n * Transforms Postman v2.1 collections to ARC import object.\n */\nexport class PostmanV21Transformer extends PostmanTransformer {\n  /**\n   * Transforms `_data` into ARC data model.\n   * @returns Promise resolved when data are transformed.\n   */\n  async transform(): Promise<HttpProject> {\n    const raw = this[dataValue] as PostmanV2\n    const project = this.createProject(raw)\n    this.setProjectVariables(project, raw)\n    if (Array.isArray(raw.item)) {\n      for (const item of raw.item) {\n        await this.addProjectItem(project, item)\n      }\n    }\n    return project\n  }\n\n  createProject(data: PostmanV2): HttpProject {\n    const { info } = data\n    const init: IHttpProject = {\n      kind: ProjectKind,\n      definitions: {},\n      info: Thing.fromName(info.name || 'Unnamed Postman project').toJSON(),\n      items: [],\n      key: info._postman_id || v4(),\n    }\n    if (info.description) {\n      init.info.description = info.description\n    }\n    const project = new HttpProject(init)\n    return project\n  }\n\n  setProjectVariables(project: HttpProject, collection: PostmanV2): void {\n    const { variable } = collection\n    if (!Array.isArray(variable)) {\n      return\n    }\n    const env = Environment.fromName('Default')\n    project.addEnvironment(env)\n    variable.forEach((param) => {\n      const { disabled = false, key, value } = param\n\n      const parsed = this.ensureVariablesSyntax(value) as string\n      const created = env.addVariable(key, parsed)\n      created.enabled = !disabled\n    })\n  }\n\n  async addProjectItem(current: HttpProject | ProjectFolder, item: PostmanItem | PostmanItemGroup): Promise<void> {\n    const typedGroup = item as PostmanItemGroup\n    if (typedGroup.item) {\n      return this.addProjectFolder(current, typedGroup)\n    }\n    const typedItem = item as PostmanItem\n    if (typedItem.request) {\n      return this.addProjectRequest(current, item as PostmanItem)\n    }\n    this.addLog(\n      'error',\n      'Error when adding an item to the project. Unable to determine item type. Tested for a folder and a request.'\n    )\n  }\n\n  async addProjectFolder(current: HttpProject | ProjectFolder, group: PostmanItemGroup): Promise<void> {\n    const { description, name = 'Unnamed folder', item } = group\n    const created = current.addFolder(name)\n    if (description) {\n      created.info.description = description\n    }\n\n    if (Array.isArray(item)) {\n      for (const tmp of item) {\n        await this.addProjectItem(created, tmp)\n      }\n    }\n  }\n\n  async addProjectRequest(current: HttpProject | ProjectFolder, item: PostmanItem): Promise<void> {\n    const { request, description } = item\n    const name = item.name || 'Unnamed request'\n    let url: string\n    if (typeof request.url === 'string') {\n      url = request.url\n    } else if (request.url && request.url.raw) {\n      url = request.url.raw\n    } else {\n      url = 'http://'\n    }\n    url = this.ensureVariablesSyntax(url) as string\n    let method = request.method || 'GET'\n    method = this.ensureVariablesSyntax(method) as string\n\n    const header = this.ensureVarsRecursively(request.header)\n    const headers = this.computeHeaders(header)\n\n    const created = current.addRequest(url)\n    created.info.name = name\n    if (request.description) {\n      created.info.description = request.description\n    } else if (description) {\n      created.info.description = description\n    }\n    created.expects.method = method\n    if (headers) {\n      created.expects.headers = headers\n    }\n\n    await this.addRequestBody(created, request.body)\n  }\n\n  /**\n   * Computes headers string from item's headers.\n   *\n   * @param headers Postman Request.header model.\n   * @returns Computed value of headers.\n   */\n  computeHeaders(headers: string | PostmanHeader[]): string {\n    if (typeof headers === 'string') {\n      return headers\n    }\n    if (!Array.isArray(headers)) {\n      return ''\n    }\n    const tmp = headers.filter((h) => !h.disabled)\n    return tmp.map((item) => `${item.key}: ${item.value}`).join('\\n')\n  }\n\n  async addRequestBody(created: ProjectRequest, body?: PostmanBody): Promise<void> {\n    if (!body) {\n      return\n    }\n    switch (body.mode) {\n      case 'file':\n        return this.addBinaryBody(created, body)\n      case 'urlencoded':\n        return this.addUrlencodedBody(created, body)\n      case 'formdata':\n        return this.addParamsBody(created, body)\n      case 'raw':\n        return this.addRawBody(created, body)\n    }\n  }\n\n  async addBinaryBody(created: ProjectRequest, body: PostmanBody): Promise<void> {\n    // Postman sets the `body.file.src` property with the path to the file\n    // but not data itself. Because of that this method is a stub that can be extended\n    // by particular implementation (like node, CLI).\n  }\n\n  async addUrlencodedBody(created: ProjectRequest, body: PostmanBody): Promise<void> {\n    const items = body[body.mode as keyof PostmanBody] as PostmanUrlEncoded[]\n    if (!Array.isArray(items)) {\n      return\n    }\n    const data = this.ensureVarsRecursively(items) as PostmanUrlEncoded[]\n    const str = data.map((i) => `${paramValue(i.key || 'missing name')}=${paramValue(i.value || '')}`).join('&')\n    await created.expects.writePayload(str)\n  }\n\n  async addParamsBody(created: ProjectRequest, body: PostmanBody): Promise<void> {\n    const items = body[body.mode as keyof PostmanBody] as PostmanFormData[]\n    if (!Array.isArray(items)) {\n      return\n    }\n    const data = this.ensureVarsRecursively(items) as PostmanFormData[]\n    const multipartBody: IMultipartBody[] = []\n    for (const part of data) {\n      if (part.type === 'text') {\n        await this.addParamsTextPart(multipartBody, part)\n      } else if (part.type === 'file') {\n        await this.addParamsFilePart(multipartBody, part)\n      }\n    }\n    created.expects.payload = {\n      type: 'formdata',\n      data: multipartBody,\n    }\n  }\n\n  async addParamsTextPart(body: IMultipartBody[], param: PostmanFormData): Promise<void> {\n    const { key, value, disabled = false } = param\n    body.push({\n      isFile: false,\n      name: key || 'unnamed part',\n      value: value || '',\n      enabled: !disabled,\n    })\n  }\n\n  async addParamsFilePart(body: IMultipartBody[], param: PostmanFormData): Promise<void> {\n    // Postman sets the `value` property with the path to the file\n    // but not data itself. Because of that this method is a stub that can be extended\n    // by particular implementation (like node, CLI).\n  }\n\n  async addRawBody(created: ProjectRequest, body: PostmanBody): Promise<void> {\n    if (body.raw) {\n      await created.expects.writePayload(body.raw)\n    }\n  }\n}\n"]}

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

@@ -0,0 +1,129 @@
+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.
+     * 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 {};
+//# sourceMappingURL=PostmanV2Transformer.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"PostmanV2Transformer.d.ts","sourceRoot":"","sources":["../../../../src/models/transformers/PostmanV2Transformer.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,kBAAkB,EAAyB,MAAM,yBAAyB,CAAA;AACnF,OAAO,EAAE,WAAW,EAAyC,MAAM,mBAAmB,CAAA;AACtF,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAA;AACnD,OAAO,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAA;AACrD,OAAO,EAAE,cAAc,EAAE,MAAM,6CAA6C,CAAA;AAK5E,eAAO,MAAM,gBAAgB,eAA6B,CAAA;AAE1D,UAAU,WAAW;IACnB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IACZ;;OAEG;IACH,MAAM,EAAE,MAAM,CAAA;IACd;;;;;;OAMG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB;AAED,UAAU,iBAAiB;IACzB,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IACxB,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IACxB,IAAI,CAAC,EAAE,MAAM,CAAA;CACd;AACD,UAAU,gBAAgB;IACxB,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACnB,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACrB,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB;AACD,UAAU,iBAAkB,SAAQ,gBAAgB;IAClD,IAAI,CAAC,EAAE,MAAM,CAAA;CACd;AACD,UAAU,eAAgB,SAAQ,gBAAgB;IAChD,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB;AACD,UAAU,WAAW;IACnB,GAAG,EAAE,MAAM,GAAG,IAAI,CAAA;IAClB,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB;AACD,UAAU,WAAW;IACnB,IAAI,EAAE,MAAM,GAAG,IAAI,CAAA;IACnB,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,UAAU,CAAC,EAAE,iBAAiB,EAAE,CAAA;IAChC,QAAQ,CAAC,EAAE,eAAe,EAAE,CAAA;IAC5B,IAAI,CAAC,EAAE,WAAW,CAAA;CACnB;AAED,UAAU,cAAc;IACtB,GAAG,CAAC,EAAE,MAAM,GAAG,iBAAiB,CAAA;IAChC,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,MAAM,CAAC,EAAE,MAAM,GAAG,gBAAgB,EAAE,CAAA;IACpC,IAAI,CAAC,EAAE,WAAW,CAAA;CACnB;AAGD,UAAU,eAAe;CAAG;AAE5B,UAAU,WAAW;IACnB;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAA;IACX;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,OAAO,EAAE,cAAc,CAAA;IACvB,QAAQ,CAAC,EAAE,eAAe,EAAE,CAAA;CAC7B;AAED,UAAU,gBAAgB;IACxB;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,IAAI,EAAE,WAAW,EAAE,GAAG,gBAAgB,EAAE,CAAA;CACzC;AAED,UAAU,eAAe;IACvB,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,GAAG,EAAE,MAAM,CAAA;IACX,KAAK,EAAE,MAAM,CAAA;CACd;AAED,UAAU,SAAS;IACjB,QAAQ,CAAC,EAAE,eAAe,EAAE,CAAA;IAC5B,IAAI,EAAE,WAAW,CAAA;IACjB,IAAI,EAAE,WAAW,EAAE,GAAG,gBAAgB,EAAE,CAAA;CACzC;AAED;;GAEG;AACH,qBAAa,oBAAqB,SAAQ,kBAAkB;IAC1D;;;OAGG;IACG,SAAS,IAAI,OAAO,CAAC,WAAW,CAAC;IAYvC,aAAa,CAAC,IAAI,EAAE,SAAS,GAAG,WAAW;IAgB3C,mBAAmB,CAAC,OAAO,EAAE,WAAW,EAAE,UAAU,EAAE,SAAS,GAAG,IAAI;IAgBhE,cAAc,CAAC,OAAO,EAAE,WAAW,GAAG,aAAa,EAAE,IAAI,EAAE,WAAW,GAAG,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC;IAezG,gBAAgB,CAAC,OAAO,EAAE,WAAW,GAAG,aAAa,EAAE,KAAK,EAAE,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC;IAc9F,iBAAiB,CAAC,OAAO,EAAE,WAAW,GAAG,aAAa,EAAE,IAAI,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC;IAiC/F;;;;;OAKG;IACH,cAAc,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,gBAAgB,EAAE,GAAG,MAAM;IAWvD,cAAc,CAAC,OAAO,EAAE,cAAc,EAAE,IAAI,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC;IAgB1E,aAAa,CAAC,OAAO,EAAE,cAAc,EAAE,IAAI,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC;IAMxE,iBAAiB,CAAC,OAAO,EAAE,cAAc,EAAE,IAAI,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC;IAU5E,aAAa,CAAC,OAAO,EAAE,cAAc,EAAE,IAAI,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC;IAoBxE,iBAAiB,CAAC,IAAI,EAAE,cAAc,EAAE,EAAE,KAAK,EAAE,eAAe,GAAG,OAAO,CAAC,IAAI,CAAC;IAUhF,iBAAiB,CAAC,IAAI,EAAE,cAAc,EAAE,EAAE,KAAK,EAAE,eAAe,GAAG,OAAO,CAAC,IAAI,CAAC;IAMhF,UAAU,CAAC,OAAO,EAAE,cAAc,EAAE,IAAI,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC;CAK5E"}