@readme/httpsnippet 4.0.0 → 4.0.3

package/src/targets/javascript/jquery/client.ts

@@ -1,95 +0,0 @@
-/**
- * @description
- * HTTP code snippet generator for native XMLHttpRequest
- *
- * @author
- * @AhmadNassri
- *
- * for any questions or issues regarding the generated code snippet, please open an issue mentioning the author.
- */
-
-import type { Client } from '../../targets';
-import stringifyObject from 'stringify-object';
-
-import { CodeBuilder } from '../../../helpers/code-builder';
-import { getHeader, getHeaderName, hasHeader } from '../../../helpers/headers';
-
-export const jquery: Client = {
-  info: {
-    key: 'jquery',
-    title: 'jQuery',
-    link: 'http://api.jquery.com/jquery.ajax/',
-    description: 'Perform an asynchronous HTTP (Ajax) requests with jQuery',
-  },
-  convert: ({ fullUrl, method, allHeaders, postData }, options) => {
-    const opts = {
-      indent: '  ',
-      ...options,
-    };
-
-    const { blank, push, join } = new CodeBuilder({ indent: opts.indent });
-
-    const settings: Record<string, any> = {
-      async: true,
-      crossDomain: true,
-      url: fullUrl,
-      method,
-      headers: allHeaders,
-    };
-
-    switch (postData.mimeType) {
-      case 'application/x-www-form-urlencoded':
-        settings.data = postData.paramsObj ? postData.paramsObj : postData.text;
-        break;
-
-      case 'application/json':
-        settings.processData = false;
-        settings.data = postData.text;
-        break;
-
-      case 'multipart/form-data':
-        if (!postData.params) {
-          break;
-        }
-
-        push('const form = new FormData();');
-
-        postData.params.forEach(param => {
-          push(`form.append('${param.name}', '${param.value || param.fileName || ''}');`);
-        });
-
-        settings.processData = false;
-        settings.contentType = false;
-        settings.mimeType = 'multipart/form-data';
-        settings.data = '[form]';
-
-        // remove the contentType header
-        if (hasHeader(allHeaders, 'content-type')) {
-          if (String(getHeader(allHeaders, 'content-type'))?.includes('boundary')) {
-            const headerName = getHeaderName(allHeaders, 'content-type');
-            if (headerName) {
-              delete settings.headers[headerName];
-            }
-          }
-        }
-
-        blank();
-        break;
-
-      default:
-        if (postData.text) {
-          settings.data = postData.text;
-        }
-    }
-
-    const stringifiedSettings = stringifyObject(settings, { indent: opts.indent }).replace("'[form]'", 'form');
-
-    push(`const settings = ${stringifiedSettings};`);
-    blank();
-    push('$.ajax(settings).done(function (response) {');
-    push('console.log(response);', 1);
-    push('});');
-
-    return join();
-  },
-};

package/src/targets/javascript/jquery/fixtures/application-form-encoded.js

@@ -1,17 +0,0 @@
-const settings = {
-  async: true,
-  crossDomain: true,
-  url: 'https://httpbin.org/anything',
-  method: 'POST',
-  headers: {
-    'content-type': 'application/x-www-form-urlencoded'
-  },
-  data: {
-    foo: 'bar',
-    hello: 'world'
-  }
-};
-
-$.ajax(settings).done(function (response) {
-  console.log(response);
-});

package/src/targets/javascript/jquery/fixtures/application-json.js

@@ -1,15 +0,0 @@
-const settings = {
-  async: true,
-  crossDomain: true,
-  url: 'https://httpbin.org/anything',
-  method: 'POST',
-  headers: {
-    'content-type': 'application/json'
-  },
-  processData: false,
-  data: '{"number":1,"string":"f\"oo","arr":[1,2,3],"nested":{"a":"b"},"arr_mix":[1,"a",{"arr_mix_nested":{}}],"boolean":false}'
-};
-
-$.ajax(settings).done(function (response) {
-  console.log(response);
-});

package/src/targets/javascript/jquery/fixtures/cookies.js

@@ -1,13 +0,0 @@
-const settings = {
-  async: true,
-  crossDomain: true,
-  url: 'https://httpbin.org/cookies',
-  method: 'GET',
-  headers: {
-    cookie: 'foo=bar; bar=baz'
-  }
-};
-
-$.ajax(settings).done(function (response) {
-  console.log(response);
-});

package/src/targets/javascript/jquery/fixtures/custom-method.js

@@ -1,11 +0,0 @@
-const settings = {
-  async: true,
-  crossDomain: true,
-  url: 'https://httpbin.org/anything',
-  method: 'PROPFIND',
-  headers: {}
-};
-
-$.ajax(settings).done(function (response) {
-  console.log(response);
-});

package/src/targets/javascript/jquery/fixtures/full.js

@@ -1,18 +0,0 @@
-const settings = {
-  async: true,
-  crossDomain: true,
-  url: 'https://httpbin.org/anything?foo=bar&foo=baz&baz=abc&key=value',
-  method: 'POST',
-  headers: {
-    cookie: 'foo=bar; bar=baz',
-    accept: 'application/json',
-    'content-type': 'application/x-www-form-urlencoded'
-  },
-  data: {
-    foo: 'bar'
-  }
-};
-
-$.ajax(settings).done(function (response) {
-  console.log(response);
-});

package/src/targets/javascript/jquery/fixtures/headers.js

@@ -1,15 +0,0 @@
-const settings = {
-  async: true,
-  crossDomain: true,
-  url: 'https://httpbin.org/headers',
-  method: 'GET',
-  headers: {
-    accept: 'application/json',
-    'x-foo': 'Bar',
-    'x-bar': 'Foo'
-  }
-};
-
-$.ajax(settings).done(function (response) {
-  console.log(response);
-});

package/src/targets/javascript/jquery/fixtures/http-insecure.js

@@ -1,11 +0,0 @@
-const settings = {
-  async: true,
-  crossDomain: true,
-  url: 'http://httpbin.org/anything',
-  method: 'GET',
-  headers: {}
-};
-
-$.ajax(settings).done(function (response) {
-  console.log(response);
-});

package/src/targets/javascript/jquery/fixtures/jsonObj-multiline.js

@@ -1,15 +0,0 @@
-const settings = {
-  async: true,
-  crossDomain: true,
-  url: 'https://httpbin.org/anything',
-  method: 'POST',
-  headers: {
-    'content-type': 'application/json'
-  },
-  processData: false,
-  data: '{\n  "foo": "bar"\n}'
-};
-
-$.ajax(settings).done(function (response) {
-  console.log(response);
-});

package/src/targets/javascript/jquery/fixtures/jsonObj-null-value.js

@@ -1,15 +0,0 @@
-const settings = {
-  async: true,
-  crossDomain: true,
-  url: 'https://httpbin.org/anything',
-  method: 'POST',
-  headers: {
-    'content-type': 'application/json'
-  },
-  processData: false,
-  data: '{"foo":null}'
-};
-
-$.ajax(settings).done(function (response) {
-  console.log(response);
-});

package/src/targets/javascript/jquery/fixtures/multipart-data.js

@@ -1,19 +0,0 @@
-const form = new FormData();
-form.append('foo', 'Hello World');
-form.append('bar', 'Bonjour le monde');
-
-const settings = {
-  async: true,
-  crossDomain: true,
-  url: 'https://httpbin.org/anything',
-  method: 'POST',
-  headers: {},
-  processData: false,
-  contentType: false,
-  mimeType: 'multipart/form-data',
-  data: form
-};
-
-$.ajax(settings).done(function (response) {
-  console.log(response);
-});

package/src/targets/javascript/jquery/fixtures/multipart-file.js

@@ -1,18 +0,0 @@
-const form = new FormData();
-form.append('foo', 'src/fixtures/files/hello.txt');
-
-const settings = {
-  async: true,
-  crossDomain: true,
-  url: 'https://httpbin.org/anything',
-  method: 'POST',
-  headers: {},
-  processData: false,
-  contentType: false,
-  mimeType: 'multipart/form-data',
-  data: form
-};
-
-$.ajax(settings).done(function (response) {
-  console.log(response);
-});

package/src/targets/javascript/jquery/fixtures/multipart-form-data-no-params.js

@@ -1,13 +0,0 @@
-const settings = {
-  async: true,
-  crossDomain: true,
-  url: 'https://httpbin.org/anything',
-  method: 'POST',
-  headers: {
-    'Content-Type': 'multipart/form-data'
-  }
-};
-
-$.ajax(settings).done(function (response) {
-  console.log(response);
-});

package/src/targets/javascript/jquery/fixtures/multipart-form-data.js

@@ -1,18 +0,0 @@
-const form = new FormData();
-form.append('foo', 'bar');
-
-const settings = {
-  async: true,
-  crossDomain: true,
-  url: 'https://httpbin.org/anything',
-  method: 'POST',
-  headers: {},
-  processData: false,
-  contentType: false,
-  mimeType: 'multipart/form-data',
-  data: form
-};
-
-$.ajax(settings).done(function (response) {
-  console.log(response);
-});

package/src/targets/javascript/jquery/fixtures/nested.js

@@ -1,11 +0,0 @@
-const settings = {
-  async: true,
-  crossDomain: true,
-  url: 'https://httpbin.org/anything?foo%5Bbar%5D=baz%2Czap&fiz=buz&key=value',
-  method: 'GET',
-  headers: {}
-};
-
-$.ajax(settings).done(function (response) {
-  console.log(response);
-});

package/src/targets/javascript/jquery/fixtures/query-encoded.js

@@ -1,11 +0,0 @@
-const settings = {
-  async: true,
-  crossDomain: true,
-  url: 'https://httpbin.org/anything?startTime=2019-06-13T19%3A08%3A25.455Z&endTime=2015-09-15T14%3A00%3A12-04%3A00',
-  method: 'GET',
-  headers: {}
-};
-
-$.ajax(settings).done(function (response) {
-  console.log(response);
-});

package/src/targets/javascript/jquery/fixtures/query.js

@@ -1,11 +0,0 @@
-const settings = {
-  async: true,
-  crossDomain: true,
-  url: 'https://httpbin.org/anything?foo=bar&foo=baz&baz=abc&key=value',
-  method: 'GET',
-  headers: {}
-};
-
-$.ajax(settings).done(function (response) {
-  console.log(response);
-});

package/src/targets/javascript/jquery/fixtures/short.js

@@ -1,11 +0,0 @@
-const settings = {
-  async: true,
-  crossDomain: true,
-  url: 'https://httpbin.org/anything',
-  method: 'GET',
-  headers: {}
-};
-
-$.ajax(settings).done(function (response) {
-  console.log(response);
-});

package/src/targets/javascript/jquery/fixtures/text-plain.js

@@ -1,14 +0,0 @@
-const settings = {
-  async: true,
-  crossDomain: true,
-  url: 'https://httpbin.org/anything',
-  method: 'POST',
-  headers: {
-    'content-type': 'text/plain'
-  },
-  data: 'Hello World'
-};
-
-$.ajax(settings).done(function (response) {
-  console.log(response);
-});

package/src/targets/javascript/target.ts

@@ -1,21 +0,0 @@
-import type { Target } from '../targets';
-import { axios } from './axios/client';
-import { fetch } from './fetch/client';
-import { jquery } from './jquery/client';
-import { xhr } from './xhr/client';
-
-export const javascript: Target = {
-  info: {
-    key: 'javascript',
-    title: 'JavaScript',
-    extname: '.js',
-    default: 'xhr',
-  },
-
-  clientsById: {
-    xhr,
-    axios,
-    fetch,
-    jquery,
-  },
-};

package/src/targets/javascript/xhr/client.test.ts

@@ -1,18 +0,0 @@
-import type { Request } from '../../..';
-import request from '../../../fixtures/requests/short';
-import { runCustomFixtures } from '../../../fixtures/runCustomFixtures';
-
-runCustomFixtures({
-  targetId: 'javascript',
-  clientId: 'xhr',
-  tests: [
-    {
-      it: 'should not use cors',
-      input: request.log.entries[0].request as Request,
-      options: {
-        cors: false,
-      },
-      expected: 'cors.js',
-    },
-  ],
-});

package/src/targets/javascript/xhr/client.ts

@@ -1,100 +0,0 @@
-/**
- * @description
- * HTTP code snippet generator for native XMLHttpRequest
- *
- * @author
- * @AhmadNassri
- *
- * for any questions or issues regarding the generated code snippet, please open an issue mentioning the author.
- */
-
-import type { Client } from '../../targets';
-import stringifyObject from 'stringify-object';
-
-import { CodeBuilder } from '../../../helpers/code-builder';
-import { getHeader, getHeaderName, hasHeader } from '../../../helpers/headers';
-
-export interface XhrOptions {
-  cors?: boolean;
-}
-
-export const xhr: Client = {
-  info: {
-    key: 'xhr',
-    title: 'XMLHttpRequest',
-    link: 'https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest',
-    description: 'W3C Standard API that provides scripted client functionality',
-  },
-  convert: ({ postData, allHeaders, method, fullUrl }, options) => {
-    const opts = {
-      indent: '  ',
-      cors: true,
-      ...options,
-    };
-
-    const { blank, push, join } = new CodeBuilder({ indent: opts.indent });
-
-    switch (postData.mimeType) {
-      case 'application/json':
-        push(
-          `const data = JSON.stringify(${stringifyObject(postData.jsonObj, {
-            indent: opts.indent,
-          })});`
-        );
-        blank();
-        break;
-
-      case 'multipart/form-data':
-        if (!postData.params) {
-          break;
-        }
-
-        push('const data = new FormData();');
-
-        postData.params.forEach(param => {
-          push(`data.append('${param.name}', '${param.value || param.fileName || ''}');`);
-        });
-
-        // remove the contentType header
-        if (hasHeader(allHeaders, 'content-type')) {
-          if (String(getHeader(allHeaders, 'content-type')).includes('boundary')) {
-            const headerName = getHeaderName(allHeaders, 'content-type');
-            if (headerName) {
-              delete allHeaders[headerName];
-            }
-          }
-        }
-
-        blank();
-        break;
-
-      default:
-        push(`const data = ${postData.text ? `'${postData.text}'` : 'null'};`);
-        blank();
-    }
-
-    push('const xhr = new XMLHttpRequest();');
-
-    if (opts.cors) {
-      push('xhr.withCredentials = true;');
-    }
-
-    blank();
-    push("xhr.addEventListener('readystatechange', function () {");
-    push('if (this.readyState === this.DONE) {', 1);
-    push('console.log(this.responseText);', 2);
-    push('}', 1);
-    push('});');
-    blank();
-    push(`xhr.open('${method}', '${fullUrl}');`);
-
-    Object.keys(allHeaders).forEach(key => {
-      push(`xhr.setRequestHeader('${key}', '${allHeaders[key]}');`);
-    });
-
-    blank();
-    push('xhr.send(data);');
-
-    return join();
-  },
-};

package/src/targets/javascript/xhr/fixtures/application-form-encoded.js

@@ -1,15 +0,0 @@
-const data = 'foo=bar&hello=world';
-
-const xhr = new XMLHttpRequest();
-xhr.withCredentials = true;
-
-xhr.addEventListener('readystatechange', function () {
-  if (this.readyState === this.DONE) {
-    console.log(this.responseText);
-  }
-});
-
-xhr.open('POST', 'https://httpbin.org/anything');
-xhr.setRequestHeader('content-type', 'application/x-www-form-urlencoded');
-
-xhr.send(data);

package/src/targets/javascript/xhr/fixtures/application-json.js

@@ -1,34 +0,0 @@
-const data = JSON.stringify({
-  number: 1,
-  string: 'f"oo',
-  arr: [
-    1,
-    2,
-    3
-  ],
-  nested: {
-    a: 'b'
-  },
-  arr_mix: [
-    1,
-    'a',
-    {
-      arr_mix_nested: {}
-    }
-  ],
-  boolean: false
-});
-
-const xhr = new XMLHttpRequest();
-xhr.withCredentials = true;
-
-xhr.addEventListener('readystatechange', function () {
-  if (this.readyState === this.DONE) {
-    console.log(this.responseText);
-  }
-});
-
-xhr.open('POST', 'https://httpbin.org/anything');
-xhr.setRequestHeader('content-type', 'application/json');
-
-xhr.send(data);

package/src/targets/javascript/xhr/fixtures/cookies.js

@@ -1,15 +0,0 @@
-const data = null;
-
-const xhr = new XMLHttpRequest();
-xhr.withCredentials = true;
-
-xhr.addEventListener('readystatechange', function () {
-  if (this.readyState === this.DONE) {
-    console.log(this.responseText);
-  }
-});
-
-xhr.open('GET', 'https://httpbin.org/cookies');
-xhr.setRequestHeader('cookie', 'foo=bar; bar=baz');
-
-xhr.send(data);

package/src/targets/javascript/xhr/fixtures/cors.js

@@ -1,13 +0,0 @@
-const data = null;
-
-const xhr = new XMLHttpRequest();
-
-xhr.addEventListener('readystatechange', function () {
-  if (this.readyState === this.DONE) {
-    console.log(this.responseText);
-  }
-});
-
-xhr.open('GET', 'https://httpbin.org/anything');
-
-xhr.send(data);

package/src/targets/javascript/xhr/fixtures/custom-method.js

@@ -1,14 +0,0 @@
-const data = null;
-
-const xhr = new XMLHttpRequest();
-xhr.withCredentials = true;
-
-xhr.addEventListener('readystatechange', function () {
-  if (this.readyState === this.DONE) {
-    console.log(this.responseText);
-  }
-});
-
-xhr.open('PROPFIND', 'https://httpbin.org/anything');
-
-xhr.send(data);

package/src/targets/javascript/xhr/fixtures/full.js

@@ -1,17 +0,0 @@
-const data = 'foo=bar';
-
-const xhr = new XMLHttpRequest();
-xhr.withCredentials = true;
-
-xhr.addEventListener('readystatechange', function () {
-  if (this.readyState === this.DONE) {
-    console.log(this.responseText);
-  }
-});
-
-xhr.open('POST', 'https://httpbin.org/anything?foo=bar&foo=baz&baz=abc&key=value');
-xhr.setRequestHeader('cookie', 'foo=bar; bar=baz');
-xhr.setRequestHeader('accept', 'application/json');
-xhr.setRequestHeader('content-type', 'application/x-www-form-urlencoded');
-
-xhr.send(data);

package/src/targets/javascript/xhr/fixtures/headers.js

@@ -1,17 +0,0 @@
-const data = null;
-
-const xhr = new XMLHttpRequest();
-xhr.withCredentials = true;
-
-xhr.addEventListener('readystatechange', function () {
-  if (this.readyState === this.DONE) {
-    console.log(this.responseText);
-  }
-});
-
-xhr.open('GET', 'https://httpbin.org/headers');
-xhr.setRequestHeader('accept', 'application/json');
-xhr.setRequestHeader('x-foo', 'Bar');
-xhr.setRequestHeader('x-bar', 'Foo');
-
-xhr.send(data);

package/src/targets/javascript/xhr/fixtures/http-insecure.js

@@ -1,14 +0,0 @@
-const data = null;
-
-const xhr = new XMLHttpRequest();
-xhr.withCredentials = true;
-
-xhr.addEventListener('readystatechange', function () {
-  if (this.readyState === this.DONE) {
-    console.log(this.responseText);
-  }
-});
-
-xhr.open('GET', 'http://httpbin.org/anything');
-
-xhr.send(data);