@scalar/snippetz 0.7.4 → 0.7.5

package/dist/httpsnippet-lite/targets/objc/nsurlsession/client.js

@@ -1,123 +1,125 @@
-import { CodeBuilder } from "../../../../httpsnippet-lite/helpers/code-builder.js";
-import { nsDeclaration } from "../../../../httpsnippet-lite/targets/objc/helpers.js";
-const 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: ({ allHeaders, postData, method, fullUrl }, options) => {
-    let _a;
-    const opts = {
-      indent: "    ",
-      pretty: true,
-      timeout: 10,
-      ...options
-    };
-    const { push, join, blank } = new CodeBuilder({ indent: opts.indent });
-    const req = {
-      hasHeaders: false,
-      hasBody: false
-    };
-    push("#import <Foundation/Foundation.h>");
-    if (Object.keys(allHeaders).length) {
-      req.hasHeaders = true;
-      blank();
-      push(nsDeclaration("NSDictionary", "headers", allHeaders, opts.pretty));
-    }
-    if (postData && (postData.text || postData.jsonObj || postData.params)) {
-      req.hasBody = true;
-      switch (postData.mimeType) {
-        case "application/x-www-form-urlencoded":
-          if ((_a = postData.params) === null || _a === void 0 ? void 0 : _a.length) {
+/**
+ * @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 { CodeBuilder } from '../../../../httpsnippet-lite/helpers/code-builder.js';
+import { nsDeclaration } from '../../../../httpsnippet-lite/targets/objc/helpers.js';
+export const 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: ({ allHeaders, postData, method, fullUrl }, options) => {
+        let _a;
+        const opts = {
+            indent: '    ',
+            pretty: true,
+            timeout: 10,
+            ...options,
+        };
+        const { push, join, blank } = new CodeBuilder({ indent: opts.indent });
+        // Markers for headers to be created as literal objects and later be set on the NSURLRequest if exist
+        const 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();
-            const [head, ...tail] = postData.params;
-            push(
-              `NSMutableData *postData = [[NSMutableData alloc] initWithData:[@"${head.name}=${head.value}" dataUsingEncoding:NSUTF8StringEncoding]];`
-            );
-            tail.forEach(({ name, value }) => {
-              push(`[postData appendData:[@"&${name}=${value}" dataUsingEncoding:NSUTF8StringEncoding]];`);
-            });
-          } else {
-            req.hasBody = false;
-          }
-          break;
-        case "application/json":
-          if (postData.jsonObj) {
-            push(nsDeclaration("NSDictionary", "parameters", postData.jsonObj, opts.pretty));
-            blank();
-            push("NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];");
-          }
-          break;
-        case "multipart/form-data":
-          push(nsDeclaration("NSArray", "parameters", postData.params || [], opts.pretty));
-          push(`NSString *boundary = @"${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:[@"${postData.text}" dataUsingEncoding:NSUTF8StringEncoding]];`
-          );
-      }
-    }
-    blank();
-    push(`NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"${fullUrl}"]`);
-    push("                                                       cachePolicy:NSURLRequestUseProtocolCachePolicy");
-    push(`                                                   timeoutInterval:${opts.timeout.toFixed(1)}];`);
-    push(`[request setHTTPMethod:@"${method}"];`);
-    if (req.hasHeaders) {
-      push("[request setAllHTTPHeaderFields:headers];");
-    }
-    if (req.hasBody) {
-      push("[request setHTTPBody:postData];");
-    }
-    blank();
-    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);
-    push(
-      "                                            NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;",
-      2
-    );
-    push('                                            NSLog(@"%@", httpResponse);', 2);
-    push("                                            }", 1);
-    push("                                            }];");
-    push("[dataTask resume];");
-    return join();
-  }
-};
-export {
-  nsurlsession
+            push(nsDeclaration('NSDictionary', 'headers', allHeaders, opts.pretty));
+        }
+        if (postData && (postData.text || postData.jsonObj || postData.params)) {
+            req.hasBody = true;
+            switch (postData.mimeType) {
+                case 'application/x-www-form-urlencoded':
+                    if ((_a = postData.params) === null || _a === void 0 ? void 0 : _a.length) {
+                        // 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();
+                        const [head, ...tail] = postData.params;
+                        push(`NSMutableData *postData = [[NSMutableData alloc] initWithData:[@"${head.name}=${head.value}" dataUsingEncoding:NSUTF8StringEncoding]];`);
+                        tail.forEach(({ name, value }) => {
+                            push(`[postData appendData:[@"&${name}=${value}" dataUsingEncoding:NSUTF8StringEncoding]];`);
+                        });
+                    }
+                    else {
+                        req.hasBody = false;
+                    }
+                    break;
+                case 'application/json':
+                    if (postData.jsonObj) {
+                        push(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(nsDeclaration('NSArray', 'parameters', postData.params || [], opts.pretty));
+                    push(`NSString *boundary = @"${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:[@"${postData.text}" dataUsingEncoding:NSUTF8StringEncoding]];`);
+            }
+        }
+        blank();
+        push(`NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"${fullUrl}"]`);
+        // NSURLRequestUseProtocolCachePolicy is the default policy, let's just always set it to avoid confusion.
+        push('                                                       cachePolicy:NSURLRequestUseProtocolCachePolicy');
+        push(`                                                   timeoutInterval:${opts.timeout.toFixed(1)}];`);
+        push(`[request setHTTPMethod:@"${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();
+    },
 };
-//# sourceMappingURL=client.js.map

package/dist/httpsnippet-lite/targets/ocaml/cohttp/client.js

@@ -1,50 +1,61 @@
-import { CodeBuilder } from "../../../../httpsnippet-lite/helpers/code-builder.js";
-import { escapeForDoubleQuotes } from "../../../../httpsnippet-lite/helpers/escape.js";
-const cohttp = {
-  info: {
-    key: "cohttp",
-    title: "CoHTTP",
-    link: "https://github.com/mirage/ocaml-cohttp",
-    description: "Cohttp is a very lightweight HTTP server using Lwt or Async for OCaml"
-  },
-  convert: ({ fullUrl, allHeaders, postData, method }, options) => {
-    const opts = {
-      indent: "  ",
-      ...options
-    };
-    const methods = ["get", "post", "head", "delete", "patch", "put", "options"];
-    const { push, blank, join } = new CodeBuilder({ indent: opts.indent });
-    push("open Cohttp_lwt_unix");
-    push("open Cohttp");
-    push("open Lwt");
-    blank();
-    push(`let uri = Uri.of_string "${fullUrl}" in`);
-    const headers = Object.keys(allHeaders);
-    if (headers.length === 1) {
-      push(
-        `let headers = Header.add (Header.init ()) "${headers[0]}" "${escapeForDoubleQuotes(allHeaders[headers[0]])}" in`
-      );
-    } else if (headers.length > 1) {
-      push("let headers = Header.add_list (Header.init ()) [");
-      headers.forEach((key) => {
-        push(`("${key}", "${escapeForDoubleQuotes(allHeaders[key])}");`, 1);
-      });
-      push("] in");
-    }
-    if (postData === null || postData === void 0 ? void 0 : postData.text) {
-      push(`let body = Cohttp_lwt_body.of_string ${JSON.stringify(postData.text)} in`);
-    }
-    blank();
-    const h = headers.length ? "~headers " : "";
-    const b = (postData === null || postData === void 0 ? void 0 : postData.text) ? "~body " : "";
-    const m = methods.includes(method.toLowerCase()) ? `\`${method.toUpperCase()}` : `(Code.method_of_string "${method}")`;
-    push(`Client.call ${h}${b}${m} uri`);
-    push(">>= fun (res, body_stream) ->");
-    push("(* Do stuff with the result *)", 1);
-    return join();
-  }
+/**
+ * @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 { CodeBuilder } from '../../../../httpsnippet-lite/helpers/code-builder.js';
+import { escapeForDoubleQuotes } from '../../../../httpsnippet-lite/helpers/escape.js';
+export const cohttp = {
+    info: {
+        key: 'cohttp',
+        title: 'CoHTTP',
+        link: 'https://github.com/mirage/ocaml-cohttp',
+        description: 'Cohttp is a very lightweight HTTP server using Lwt or Async for OCaml',
+    },
+    convert: ({ fullUrl, allHeaders, postData, method }, options) => {
+        const opts = {
+            indent: '  ',
+            ...options,
+        };
+        const methods = ['get', 'post', 'head', 'delete', 'patch', 'put', 'options'];
+        const { push, blank, join } = new CodeBuilder({ indent: opts.indent });
+        push('open Cohttp_lwt_unix');
+        push('open Cohttp');
+        push('open Lwt');
+        blank();
+        push(`let uri = Uri.of_string "${fullUrl}" in`);
+        // Add headers, including the cookies
+        const headers = Object.keys(allHeaders);
+        if (headers.length === 1) {
+            push(`let headers = Header.add (Header.init ()) "${headers[0]}" "${escapeForDoubleQuotes(allHeaders[headers[0]])}" in`);
+        }
+        else if (headers.length > 1) {
+            push('let headers = Header.add_list (Header.init ()) [');
+            headers.forEach((key) => {
+                push(`("${key}", "${escapeForDoubleQuotes(allHeaders[key])}");`, 1);
+            });
+            push('] in');
+        }
+        // Add body
+        if (postData === null || postData === void 0 ? void 0 : postData.text) {
+            // Just text
+            push(`let body = Cohttp_lwt_body.of_string ${JSON.stringify(postData.text)} in`);
+        }
+        // Do the request
+        blank();
+        const h = headers.length ? '~headers ' : '';
+        const b = (postData === null || postData === void 0 ? void 0 : postData.text) ? '~body ' : '';
+        const m = methods.includes(method.toLowerCase())
+            ? `\`${method.toUpperCase()}`
+            : `(Code.method_of_string "${method}")`;
+        push(`Client.call ${h}${b}${m} uri`);
+        // Catch result
+        push('>>= fun (res, body_stream) ->');
+        push('(* Do stuff with the result *)', 1);
+        return join();
+    },
 };
-export {
-  cohttp
-};
-//# sourceMappingURL=client.js.map

package/dist/httpsnippet-lite/targets/powershell/common.js

@@ -1,58 +1,48 @@
-import { CodeBuilder } from "../../../httpsnippet-lite/helpers/code-builder.js";
-import { escapeString } from "../../../httpsnippet-lite/helpers/escape.js";
-import { getHeader } from "../../../httpsnippet-lite/helpers/headers.js";
-const generatePowershellConvert = (command) => {
-  const convert = ({
-    method,
-    headersObj,
-    cookies,
-    uriObj,
-    fullUrl,
-    postData,
-    allHeaders
-  }) => {
-    const { push, join } = new CodeBuilder();
-    const methods = ["GET", "POST", "PUT", "DELETE", "PATCH", "HEAD", "OPTIONS"];
-    if (!methods.includes(method.toUpperCase())) {
-      return "Method not supported";
-    }
-    const commandOptions = [];
-    const headers = Object.keys(headersObj);
-    if (headers.length) {
-      push("$headers=@{}");
-      headers.forEach((key) => {
-        if (key !== "connection") {
-          push(`$headers.Add("${key}", "${escapeString(headersObj[key], { escapeChar: "`" })}")`);
+import { CodeBuilder } from '../../../httpsnippet-lite/helpers/code-builder.js';
+import { escapeString } from '../../../httpsnippet-lite/helpers/escape.js';
+import { getHeader } from '../../../httpsnippet-lite/helpers/headers.js';
+export const generatePowershellConvert = (command) => {
+    const convert = ({ method, headersObj, cookies, uriObj, fullUrl, postData, allHeaders, }) => {
+        const { push, join } = new CodeBuilder();
+        const methods = ['GET', 'POST', 'PUT', 'DELETE', 'PATCH', 'HEAD', 'OPTIONS'];
+        if (!methods.includes(method.toUpperCase())) {
+            return 'Method not supported';
         }
-      });
-      commandOptions.push("-Headers $headers");
-    }
-    if (cookies.length) {
-      push("$session = New-Object Microsoft.PowerShell.Commands.WebRequestSession");
-      cookies.forEach((cookie) => {
-        push("$cookie = New-Object System.Net.Cookie");
-        push(`$cookie.Name = '${cookie.name}'`);
-        push(`$cookie.Value = '${cookie.value}'`);
-        push(`$cookie.Domain = '${uriObj.host}'`);
-        push("$session.Cookies.Add($cookie)");
-      });
-      commandOptions.push("-WebSession $session");
-    }
-    if (postData === null || postData === void 0 ? void 0 : postData.text) {
-      commandOptions.push(
-        `-ContentType '${escapeString(getHeader(allHeaders, "content-type"), {
-          delimiter: "'",
-          escapeChar: "`"
-        })}'`
-      );
-      commandOptions.push(`-Body '${postData.text}'`);
-    }
-    push(`$response = ${command} -Uri '${fullUrl}' -Method ${method} ${commandOptions.join(" ")}`);
-    return join();
-  };
-  return convert;
-};
-export {
-  generatePowershellConvert
+        const commandOptions = [];
+        // Add headers, including the cookies
+        const headers = Object.keys(headersObj);
+        // construct headers
+        if (headers.length) {
+            push('$headers=@{}');
+            headers.forEach((key) => {
+                if (key !== 'connection') {
+                    // Not allowed
+                    push(`$headers.Add("${key}", "${escapeString(headersObj[key], { escapeChar: '`' })}")`);
+                }
+            });
+            commandOptions.push('-Headers $headers');
+        }
+        // construct cookies
+        if (cookies.length) {
+            push('$session = New-Object Microsoft.PowerShell.Commands.WebRequestSession');
+            cookies.forEach((cookie) => {
+                push('$cookie = New-Object System.Net.Cookie');
+                push(`$cookie.Name = '${cookie.name}'`);
+                push(`$cookie.Value = '${cookie.value}'`);
+                push(`$cookie.Domain = '${uriObj.host}'`);
+                push('$session.Cookies.Add($cookie)');
+            });
+            commandOptions.push('-WebSession $session');
+        }
+        if (postData === null || postData === void 0 ? void 0 : postData.text) {
+            commandOptions.push(`-ContentType '${escapeString(getHeader(allHeaders, 'content-type'), {
+                delimiter: "'",
+                escapeChar: '`',
+            })}'`);
+            commandOptions.push(`-Body '${postData.text}'`);
+        }
+        push(`$response = ${command} -Uri '${fullUrl}' -Method ${method} ${commandOptions.join(' ')}`);
+        return join();
+    };
+    return convert;
 };
-//# sourceMappingURL=common.js.map

package/dist/httpsnippet-lite/targets/powershell/restmethod/client.js

@@ -1,14 +1,10 @@
-import { generatePowershellConvert } from "../common.js";
-const restmethod = {
-  info: {
-    key: "restmethod",
-    title: "Invoke-RestMethod",
-    link: "https://docs.microsoft.com/en-us/powershell/module/Microsoft.PowerShell.Utility/Invoke-RestMethod",
-    description: "Powershell Invoke-RestMethod client"
-  },
-  convert: generatePowershellConvert("Invoke-RestMethod")
+import { generatePowershellConvert } from '../common.js';
+export const restmethod = {
+    info: {
+        key: 'restmethod',
+        title: 'Invoke-RestMethod',
+        link: 'https://docs.microsoft.com/en-us/powershell/module/Microsoft.PowerShell.Utility/Invoke-RestMethod',
+        description: 'Powershell Invoke-RestMethod client',
+    },
+    convert: generatePowershellConvert('Invoke-RestMethod'),
 };
-export {
-  restmethod
-};
-//# sourceMappingURL=client.js.map

package/dist/httpsnippet-lite/targets/powershell/webrequest/client.js

@@ -1,14 +1,10 @@
-import { generatePowershellConvert } from "../common.js";
-const webrequest = {
-  info: {
-    key: "webrequest",
-    title: "Invoke-WebRequest",
-    link: "https://docs.microsoft.com/en-us/powershell/module/Microsoft.PowerShell.Utility/Invoke-WebRequest",
-    description: "Powershell Invoke-WebRequest client"
-  },
-  convert: generatePowershellConvert("Invoke-WebRequest")
+import { generatePowershellConvert } from '../common.js';
+export const webrequest = {
+    info: {
+        key: 'webrequest',
+        title: 'Invoke-WebRequest',
+        link: 'https://docs.microsoft.com/en-us/powershell/module/Microsoft.PowerShell.Utility/Invoke-WebRequest',
+        description: 'Powershell Invoke-WebRequest client',
+    },
+    convert: generatePowershellConvert('Invoke-WebRequest'),
 };
-export {
-  webrequest
-};
-//# sourceMappingURL=client.js.map