@readme/httpsnippet 4.0.0 → 4.0.3

package/dist/targets/node/unirest/fixtures/application-json.js

@@ -0,0 +1,32 @@
+"use strict";
+var unirest = require('unirest');
+var req = unirest('POST', 'https://httpbin.org/anything');
+req.headers({
+    'content-type': 'application/json'
+});
+req.type('json');
+req.send({
+    number: 1,
+    string: 'f"oo',
+    arr: [
+        1,
+        2,
+        3
+    ],
+    nested: {
+        a: 'b'
+    },
+    arr_mix: [
+        1,
+        'a',
+        {
+            arr_mix_nested: {}
+        }
+    ],
+    boolean: false
+});
+req.end(function (res) {
+    if (res.error)
+        throw new Error(res.error);
+    console.log(res.body);
+});

package/dist/targets/node/unirest/fixtures/cookies.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/targets/node/unirest/fixtures/cookies.js

@@ -0,0 +1,12 @@
+"use strict";
+var unirest = require('unirest');
+var req = unirest('GET', 'https://httpbin.org/cookies');
+var CookieJar = unirest.jar();
+CookieJar.add('foo=bar', 'https://httpbin.org/cookies');
+CookieJar.add('bar=baz', 'https://httpbin.org/cookies');
+req.jar(CookieJar);
+req.end(function (res) {
+    if (res.error)
+        throw new Error(res.error);
+    console.log(res.body);
+});

package/dist/targets/node/unirest/fixtures/custom-method.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/targets/node/unirest/fixtures/custom-method.js

@@ -0,0 +1,8 @@
+"use strict";
+var unirest = require('unirest');
+var req = unirest('PROPFIND', 'https://httpbin.org/anything');
+req.end(function (res) {
+    if (res.error)
+        throw new Error(res.error);
+    console.log(res.body);
+});

package/dist/targets/node/unirest/fixtures/full.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/targets/node/unirest/fixtures/full.js

@@ -0,0 +1,27 @@
+"use strict";
+var unirest = require('unirest');
+var req = unirest('POST', 'https://httpbin.org/anything');
+var CookieJar = unirest.jar();
+CookieJar.add('foo=bar', 'https://httpbin.org/anything');
+CookieJar.add('bar=baz', 'https://httpbin.org/anything');
+req.jar(CookieJar);
+req.query({
+    foo: [
+        'bar',
+        'baz'
+    ],
+    baz: 'abc',
+    key: 'value'
+});
+req.headers({
+    accept: 'application/json',
+    'content-type': 'application/x-www-form-urlencoded'
+});
+req.form({
+    foo: 'bar'
+});
+req.end(function (res) {
+    if (res.error)
+        throw new Error(res.error);
+    console.log(res.body);
+});

package/dist/targets/node/unirest/fixtures/headers.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/targets/node/unirest/fixtures/headers.js

@@ -0,0 +1,13 @@
+"use strict";
+var unirest = require('unirest');
+var req = unirest('GET', 'https://httpbin.org/headers');
+req.headers({
+    accept: 'application/json',
+    'x-foo': 'Bar',
+    'x-bar': 'Foo'
+});
+req.end(function (res) {
+    if (res.error)
+        throw new Error(res.error);
+    console.log(res.body);
+});

package/dist/targets/node/unirest/fixtures/http-insecure.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/targets/node/unirest/fixtures/http-insecure.js

@@ -0,0 +1,8 @@
+"use strict";
+var unirest = require('unirest');
+var req = unirest('GET', 'http://httpbin.org/anything');
+req.end(function (res) {
+    if (res.error)
+        throw new Error(res.error);
+    console.log(res.body);
+});

package/dist/targets/node/unirest/fixtures/jsonObj-multiline.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/targets/node/unirest/fixtures/jsonObj-multiline.js

@@ -0,0 +1,15 @@
+"use strict";
+var unirest = require('unirest');
+var req = unirest('POST', 'https://httpbin.org/anything');
+req.headers({
+    'content-type': 'application/json'
+});
+req.type('json');
+req.send({
+    foo: 'bar'
+});
+req.end(function (res) {
+    if (res.error)
+        throw new Error(res.error);
+    console.log(res.body);
+});

package/dist/targets/node/unirest/fixtures/jsonObj-null-value.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/targets/node/unirest/fixtures/jsonObj-null-value.js

@@ -0,0 +1,15 @@
+"use strict";
+var unirest = require('unirest');
+var req = unirest('POST', 'https://httpbin.org/anything');
+req.headers({
+    'content-type': 'application/json'
+});
+req.type('json');
+req.send({
+    foo: null
+});
+req.end(function (res) {
+    if (res.error)
+        throw new Error(res.error);
+    console.log(res.body);
+});

package/dist/targets/node/unirest/fixtures/multipart-data.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/targets/node/unirest/fixtures/multipart-data.js

@@ -0,0 +1,20 @@
+"use strict";
+var unirest = require('unirest');
+var req = unirest('POST', 'https://httpbin.org/anything');
+req.headers({
+    'content-type': 'multipart/form-data; boundary=---011000010111000001101001'
+});
+req.multipart([
+    {
+        body: 'Hello World',
+        'content-type': 'text/plain'
+    },
+    {
+        body: 'Bonjour le monde'
+    }
+]);
+req.end(function (res) {
+    if (res.error)
+        throw new Error(res.error);
+    console.log(res.body);
+});

package/dist/targets/node/unirest/fixtures/multipart-file.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/targets/node/unirest/fixtures/multipart-file.js

@@ -0,0 +1,18 @@
+"use strict";
+var fs = require('fs');
+var unirest = require('unirest');
+var req = unirest('POST', 'https://httpbin.org/anything');
+req.headers({
+    'content-type': 'multipart/form-data; boundary=---011000010111000001101001'
+});
+req.multipart([
+    {
+        body: fs.createReadStream('src/fixtures/files/hello.txt'),
+        'content-type': 'text/plain'
+    }
+]);
+req.end(function (res) {
+    if (res.error)
+        throw new Error(res.error);
+    console.log(res.body);
+});

package/dist/targets/node/unirest/fixtures/multipart-form-data-no-params.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/targets/node/unirest/fixtures/multipart-form-data-no-params.js

@@ -0,0 +1,11 @@
+"use strict";
+var unirest = require('unirest');
+var req = unirest('POST', 'https://httpbin.org/anything');
+req.headers({
+    'Content-Type': 'multipart/form-data'
+});
+req.end(function (res) {
+    if (res.error)
+        throw new Error(res.error);
+    console.log(res.body);
+});

package/dist/targets/node/unirest/fixtures/multipart-form-data.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/targets/node/unirest/fixtures/multipart-form-data.js

@@ -0,0 +1,16 @@
+"use strict";
+var unirest = require('unirest');
+var req = unirest('POST', 'https://httpbin.org/anything');
+req.headers({
+    'Content-Type': 'multipart/form-data; boundary=---011000010111000001101001'
+});
+req.multipart([
+    {
+        body: 'bar'
+    }
+]);
+req.end(function (res) {
+    if (res.error)
+        throw new Error(res.error);
+    console.log(res.body);
+});

package/dist/targets/node/unirest/fixtures/nested.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/targets/node/unirest/fixtures/nested.js

@@ -0,0 +1,13 @@
+"use strict";
+var unirest = require('unirest');
+var req = unirest('GET', 'https://httpbin.org/anything');
+req.query({
+    'foo[bar]': 'baz,zap',
+    fiz: 'buz',
+    key: 'value'
+});
+req.end(function (res) {
+    if (res.error)
+        throw new Error(res.error);
+    console.log(res.body);
+});

package/dist/targets/node/unirest/fixtures/query-encoded.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/targets/node/unirest/fixtures/query-encoded.js

@@ -0,0 +1,12 @@
+"use strict";
+var unirest = require('unirest');
+var req = unirest('GET', 'https://httpbin.org/anything');
+req.query({
+    startTime: '2019-06-13T19%3A08%3A25.455Z',
+    endTime: '2015-09-15T14%3A00%3A12-04%3A00'
+});
+req.end(function (res) {
+    if (res.error)
+        throw new Error(res.error);
+    console.log(res.body);
+});

package/dist/targets/node/unirest/fixtures/query.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/targets/node/unirest/fixtures/query.js

@@ -0,0 +1,16 @@
+"use strict";
+var unirest = require('unirest');
+var req = unirest('GET', 'https://httpbin.org/anything');
+req.query({
+    foo: [
+        'bar',
+        'baz'
+    ],
+    baz: 'abc',
+    key: 'value'
+});
+req.end(function (res) {
+    if (res.error)
+        throw new Error(res.error);
+    console.log(res.body);
+});

package/dist/targets/node/unirest/fixtures/short.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/targets/node/unirest/fixtures/short.js

@@ -0,0 +1,8 @@
+"use strict";
+var unirest = require('unirest');
+var req = unirest('GET', 'https://httpbin.org/anything');
+req.end(function (res) {
+    if (res.error)
+        throw new Error(res.error);
+    console.log(res.body);
+});

package/dist/targets/node/unirest/fixtures/text-plain.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/targets/node/unirest/fixtures/text-plain.js

@@ -0,0 +1,12 @@
+"use strict";
+var unirest = require('unirest');
+var req = unirest('POST', 'https://httpbin.org/anything');
+req.headers({
+    'content-type': 'text/plain'
+});
+req.send('Hello World');
+req.end(function (res) {
+    if (res.error)
+        throw new Error(res.error);
+    console.log(res.body);
+});

package/dist/targets/objc/helpers.d.ts

@@ -0,0 +1,26 @@
+/**
+ * Create a string corresponding to a valid declaration and initialization of an Objective-C object literal.
+ *
+ * @param nsClass Class of the litteral
+ * @param name Desired name of the instance
+ * @param parameters Key-value object of parameters to translate to an Objective-C object litearal
+ * @param indent If true, will declare the litteral by indenting each new key/value pair.
+ * @return A valid Objective-C declaration and initialization of an Objective-C object litteral.
+ *
+ * @example
+ *   nsDeclaration('NSDictionary', 'params', {a: 'b', c: 'd'}, true)
+ *   // returns:
+ *   NSDictionary *params = @{ @"a": @"b",
+ *                             @"c": @"d" };
+ *
+ *   nsDeclaration('NSDictionary', 'params', {a: 'b', c: 'd'})
+ *   // returns:
+ *   NSDictionary *params = @{ @"a": @"b", @"c": @"d" };
+ */
+export declare const nsDeclaration: (nsClass: string, name: string, parameters: Record<string, any>, indent?: boolean) => string;
+/**
+ * Create a valid Objective-C string of a literal value according to its type.
+ *
+ * @param value Any JavaScript literal
+ */
+export declare const literalRepresentation: (value: any, indentation?: number) => string;

package/dist/targets/objc/helpers.js

@@ -0,0 +1,59 @@
+"use strict";
+exports.__esModule = true;
+exports.literalRepresentation = exports.nsDeclaration = void 0;
+/**
+ * Create a string corresponding to a valid declaration and initialization of an Objective-C object literal.
+ *
+ * @param nsClass Class of the litteral
+ * @param name Desired name of the instance
+ * @param parameters Key-value object of parameters to translate to an Objective-C object litearal
+ * @param indent If true, will declare the litteral by indenting each new key/value pair.
+ * @return A valid Objective-C declaration and initialization of an Objective-C object litteral.
+ *
+ * @example
+ *   nsDeclaration('NSDictionary', 'params', {a: 'b', c: 'd'}, true)
+ *   // returns:
+ *   NSDictionary *params = @{ @"a": @"b",
+ *                             @"c": @"d" };
+ *
+ *   nsDeclaration('NSDictionary', 'params', {a: 'b', c: 'd'})
+ *   // returns:
+ *   NSDictionary *params = @{ @"a": @"b", @"c": @"d" };
+ */
+var nsDeclaration = function (nsClass, name, parameters, indent) {
+    var opening = "".concat(nsClass, " *").concat(name, " = ");
+    var literal = (0, exports.literalRepresentation)(parameters, indent ? opening.length : undefined);
+    return "".concat(opening).concat(literal, ";");
+};
+exports.nsDeclaration = nsDeclaration;
+/**
+ * Create a valid Objective-C string of a literal value according to its type.
+ *
+ * @param value Any JavaScript literal
+ */
+var literalRepresentation = function (value, indentation) {
+    var join = indentation === undefined ? ', ' : ",\n   ".concat(' '.repeat(indentation));
+    switch (Object.prototype.toString.call(value)) {
+        case '[object Number]':
+            return "@".concat(value);
+        case '[object Array]': {
+            var valuesRepresentation = value.map(function (val) { return (0, exports.literalRepresentation)(val); });
+            return "@[ ".concat(valuesRepresentation.join(join), " ]");
+        }
+        case '[object Object]': {
+            var keyValuePairs_1 = [];
+            Object.keys(value).forEach(function (key) {
+                keyValuePairs_1.push("@\"".concat(key, "\": ").concat((0, exports.literalRepresentation)(value[key])));
+            });
+            return "@{ ".concat(keyValuePairs_1.join(join), " }");
+        }
+        case '[object Boolean]':
+            return value ? '@YES' : '@NO';
+        default:
+            if (value === null || value === undefined) {
+                return '';
+            }
+            return "@\"".concat(value.toString().replace(/"/g, '\\"'), "\"");
+    }
+};
+exports.literalRepresentation = literalRepresentation;

package/dist/targets/objc/nsurlsession/client.d.ts

@@ -0,0 +1,15 @@
+/**
+ * @description
+ * HTTP code snippet generator for Objective-C using NSURLSession.
+ *
+ * @author
+ * @thibaultCha
+ *
+ * for any questions or issues regarding the generated code snippet, please open an issue mentioning the author.
+ */
+import type { Client } from '../../targets';
+export interface NsurlsessionOptions {
+    pretty?: boolean;
+    timeout?: number;
+}
+export declare const nsurlsession: Client<NsurlsessionOptions>;

package/dist/targets/objc/nsurlsession/client.js

@@ -0,0 +1,151 @@
+"use strict";
+/**
+ * @description
+ * HTTP code snippet generator for Objective-C using NSURLSession.
+ *
+ * @author
+ * @thibaultCha
+ *
+ * for any questions or issues regarding the generated code snippet, please open an issue mentioning the author.
+ */
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+var __read = (this && this.__read) || function (o, n) {
+    var m = typeof Symbol === "function" && o[Symbol.iterator];
+    if (!m) return o;
+    var i = m.call(o), r, ar = [], e;
+    try {
+        while ((n === void 0 || n-- > 0) && !(r = i.next()).done) ar.push(r.value);
+    }
+    catch (error) { e = { error: error }; }
+    finally {
+        try {
+            if (r && !r.done && (m = i["return"])) m.call(i);
+        }
+        finally { if (e) throw e.error; }
+    }
+    return ar;
+};
+exports.__esModule = true;
+exports.nsurlsession = void 0;
+var code_builder_1 = require("../../../helpers/code-builder");
+var helpers_1 = require("../helpers");
+exports.nsurlsession = {
+    info: {
+        key: 'nsurlsession',
+        title: 'NSURLSession',
+        link: 'https://developer.apple.com/library/mac/documentation/Foundation/Reference/NSURLSession_class/index.html',
+        description: "Foundation's NSURLSession request"
+    },
+    convert: function (_a, options) {
+        var allHeaders = _a.allHeaders, postData = _a.postData, method = _a.method, fullUrl = _a.fullUrl;
+        var opts = __assign({ indent: '    ', pretty: true, timeout: 10 }, options);
+        var _b = new code_builder_1.CodeBuilder({ indent: opts.indent }), push = _b.push, join = _b.join, blank = _b.blank;
+        // Markers for headers to be created as literal objects and later be set on the NSURLRequest if exist
+        var req = {
+            hasHeaders: false,
+            hasBody: false
+        };
+        // We just want to make sure people understand that is the only dependency
+        push('#import <Foundation/Foundation.h>');
+        if (Object.keys(allHeaders).length) {
+            req.hasHeaders = true;
+            blank();
+            push((0, helpers_1.nsDeclaration)('NSDictionary', 'headers', allHeaders, opts.pretty));
+        }
+        if (postData.text || postData.jsonObj || postData.params) {
+            req.hasBody = true;
+            switch (postData.mimeType) {
+                case 'application/x-www-form-urlencoded':
+                    if (postData.params) {
+                        // By appending parameters one by one in the resulting snippet,
+                        // we make it easier for the user to edit it according to his or her needs after pasting.
+                        // The user can just add/remove lines adding/removing body parameters.
+                        blank();
+                        var _c = __read(postData.params), head = _c[0], tail = _c.slice(1);
+                        push("NSMutableData *postData = [[NSMutableData alloc] initWithData:[@\"".concat(head.name, "=").concat(head.value, "\" dataUsingEncoding:NSUTF8StringEncoding]];"));
+                        tail.forEach(function (_a) {
+                            var name = _a.name, value = _a.value;
+                            push("[postData appendData:[@\"&".concat(name, "=").concat(value, "\" dataUsingEncoding:NSUTF8StringEncoding]];"));
+                        });
+                    }
+                    else {
+                        req.hasBody = false;
+                    }
+                    break;
+                case 'application/json':
+                    if (postData.jsonObj) {
+                        push((0, helpers_1.nsDeclaration)('NSDictionary', 'parameters', postData.jsonObj, opts.pretty));
+                        blank();
+                        push('NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];');
+                    }
+                    break;
+                case 'multipart/form-data':
+                    // By appending multipart parameters one by one in the resulting snippet,
+                    // we make it easier for the user to edit it according to his or her needs after pasting.
+                    // The user can just edit the parameters NSDictionary or put this part of a snippet in a multipart builder method.
+                    push((0, helpers_1.nsDeclaration)('NSArray', 'parameters', postData.params || [], opts.pretty));
+                    push("NSString *boundary = @\"".concat(postData.boundary, "\";"));
+                    blank();
+                    push('NSError *error;');
+                    push('NSMutableString *body = [NSMutableString string];');
+                    push('for (NSDictionary *param in parameters) {');
+                    push('[body appendFormat:@"--%@\\r\\n", boundary];', 1);
+                    push('if (param[@"fileName"]) {', 1);
+                    push('[body appendFormat:@"Content-Disposition:form-data; name=\\"%@\\"; filename=\\"%@\\"\\r\\n", param[@"name"], param[@"fileName"]];', 2);
+                    push('[body appendFormat:@"Content-Type: %@\\r\\n\\r\\n", param[@"contentType"]];', 2);
+                    push('[body appendFormat:@"%@", [NSString stringWithContentsOfFile:param[@"fileName"] encoding:NSUTF8StringEncoding error:&error]];', 2);
+                    push('if (error) {', 2);
+                    push('NSLog(@"%@", error);', 3);
+                    push('}', 2);
+                    push('} else {', 1);
+                    push('[body appendFormat:@"Content-Disposition:form-data; name=\\"%@\\"\\r\\n\\r\\n", param[@"name"]];', 2);
+                    push('[body appendFormat:@"%@", param[@"value"]];', 2);
+                    push('}', 1);
+                    push('}');
+                    push('[body appendFormat:@"\\r\\n--%@--\\r\\n", boundary];');
+                    push('NSData *postData = [body dataUsingEncoding:NSUTF8StringEncoding];');
+                    break;
+                default:
+                    blank();
+                    push("NSData *postData = [[NSData alloc] initWithData:[@\"".concat(postData.text, "\" dataUsingEncoding:NSUTF8StringEncoding]];"));
+            }
+        }
+        blank();
+        push("NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@\"".concat(fullUrl, "\"]"));
+        // NSURLRequestUseProtocolCachePolicy is the default policy, let's just always set it to avoid confusion.
+        push('                                                       cachePolicy:NSURLRequestUseProtocolCachePolicy');
+        push("                                                   timeoutInterval:".concat(opts.timeout.toFixed(1), "];"));
+        push("[request setHTTPMethod:@\"".concat(method, "\"];"));
+        if (req.hasHeaders) {
+            push('[request setAllHTTPHeaderFields:headers];');
+        }
+        if (req.hasBody) {
+            push('[request setHTTPBody:postData];');
+        }
+        blank();
+        // Retrieving the shared session will be less verbose than creating a new one.
+        push('NSURLSession *session = [NSURLSession sharedSession];');
+        push('NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request');
+        push('                                            completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {');
+        push('                                            if (error) {', 1);
+        push('                                            NSLog(@"%@", error);', 2);
+        push('                                            } else {', 1);
+        // Casting the NSURLResponse to NSHTTPURLResponse so the user can see the status     .
+        push('                                            NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;', 2);
+        push('                                            NSLog(@"%@", httpResponse);', 2);
+        push('                                            }', 1);
+        push('                                            }];');
+        push('[dataTask resume];');
+        return join();
+    }
+};

package/dist/targets/objc/target.d.ts

@@ -0,0 +1,2 @@
+import type { Target } from '../targets';
+export declare const objc: Target;

package/dist/targets/objc/target.js

@@ -0,0 +1,15 @@
+"use strict";
+exports.__esModule = true;
+exports.objc = void 0;
+var client_1 = require("./nsurlsession/client");
+exports.objc = {
+    info: {
+        key: 'objc',
+        title: 'Objective-C',
+        extname: '.m',
+        "default": 'nsurlsession'
+    },
+    clientsById: {
+        nsurlsession: client_1.nsurlsession
+    }
+};

package/dist/targets/ocaml/cohttp/client.d.ts

@@ -0,0 +1,11 @@
+/**
+ * @description
+ * HTTP code snippet generator for OCaml using CoHTTP.
+ *
+ * @author
+ * @SGrondin
+ *
+ * for any questions or issues regarding the generated code snippet, please open an issue mentioning the author.
+ */
+import type { Client } from '../../targets';
+export declare const cohttp: Client;