@scalar/snippetz 0.7.4 → 0.7.6

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

@@ -1,114 +1,128 @@
-import { CodeBuilder } from "../../../../httpsnippet-lite/helpers/code-builder.js";
-import { literalDeclaration } from "../../../../httpsnippet-lite/targets/swift/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, fullUrl, method }, options) => {
-    let _a;
-    const opts = {
-      indent: "  ",
-      pretty: true,
-      timeout: "10",
-      ...options
-    };
-    const { push, blank, join } = new CodeBuilder({ indent: opts.indent });
-    const req = {
-      hasHeaders: false,
-      hasBody: false
-    };
-    push("import Foundation");
-    if (Object.keys(allHeaders).length) {
-      req.hasHeaders = true;
-      blank();
-      push(literalDeclaration("headers", allHeaders, opts));
-    }
-    if (postData && (postData.text || postData.jsonObj || postData.params)) {
-      req.hasBody = true;
-      switch (postData.mimeType) {
-        case "application/x-www-form-urlencoded":
-          blank();
-          if ((_a = postData.params) === null || _a === void 0 ? void 0 : _a.length) {
-            const [head, ...tail] = postData.params;
-            push(
-              `let postData = NSMutableData(data: "${head.name}=${head.value}".data(using: String.Encoding.utf8)!)`
-            );
-            tail.forEach(({ name, value }) => {
-              push(`postData.append("&${name}=${value}".data(using: String.Encoding.utf8)!)`);
-            });
-          } else {
-            req.hasBody = false;
-          }
-          break;
-        case "application/json":
-          if (postData.jsonObj) {
-            push(`${literalDeclaration("parameters", postData.jsonObj, opts)} as [String : Any]`);
+/**
+ * @description
+ * HTTP code snippet generator for Swift 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 { literalDeclaration } from '../../../../httpsnippet-lite/targets/swift/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, fullUrl, method }, options) => {
+        let _a;
+        const opts = {
+            indent: '  ',
+            pretty: true,
+            timeout: '10',
+            ...options,
+        };
+        const { push, blank, join } = new CodeBuilder({ indent: opts.indent });
+        // Markers for headers to be created as litteral 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');
+        if (Object.keys(allHeaders).length) {
+            req.hasHeaders = true;
             blank();
-            push("let postData = JSONSerialization.data(withJSONObject: parameters, options: [])");
-          }
-          break;
-        case "multipart/form-data":
-          push(literalDeclaration("parameters", postData.params, opts));
-          blank();
-          push(`let boundary = "${postData.boundary}"`);
-          blank();
-          push('var body = ""');
-          push("var error: NSError? = nil");
-          push("for param in parameters {");
-          push('let paramName = param["name"]!', 1);
-          push('body += "--\\(boundary)\\r\\n"', 1);
-          push('body += "Content-Disposition:form-data; name=\\"\\(paramName)\\""', 1);
-          push('if let filename = param["fileName"] {', 1);
-          push('let contentType = param["content-type"]!', 2);
-          push("let fileContent = String(contentsOfFile: filename, encoding: String.Encoding.utf8)", 2);
-          push("if (error != nil) {", 2);
-          push("print(error as Any)", 3);
-          push("}", 2);
-          push('body += "; filename=\\"\\(filename)\\"\\r\\n"', 2);
-          push('body += "Content-Type: \\(contentType)\\r\\n\\r\\n"', 2);
-          push("body += fileContent", 2);
-          push('} else if let paramValue = param["value"] {', 1);
-          push('body += "\\r\\n\\r\\n\\(paramValue)"', 2);
-          push("}", 1);
-          push("}");
-          break;
-        default:
-          blank();
-          push(`let postData = NSData(data: "${postData.text}".data(using: String.Encoding.utf8)!)`);
-      }
-    }
-    blank();
-    push(`let request = NSMutableURLRequest(url: NSURL(string: "${fullUrl}")! as URL,`);
-    push("                                        cachePolicy: .useProtocolCachePolicy,");
-    push(`                                    timeoutInterval: ${Number.parseInt(opts.timeout, 10).toFixed(1)})`);
-    push(`request.httpMethod = "${method}"`);
-    if (req.hasHeaders) {
-      push("request.allHTTPHeaderFields = headers");
-    }
-    if (req.hasBody) {
-      push("request.httpBody = postData as Data");
-    }
-    blank();
-    push("let session = URLSession.shared");
-    push(
-      "let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in"
-    );
-    push("if (error != nil) {", 1);
-    push("print(error as Any)", 2);
-    push("} else {", 1);
-    push("let httpResponse = response as? HTTPURLResponse", 2);
-    push("print(httpResponse)", 2);
-    push("}", 1);
-    push("})");
-    blank();
-    push("dataTask.resume()");
-    return join();
-  }
+            push(literalDeclaration('headers', allHeaders, opts));
+        }
+        if (postData && (postData.text || postData.jsonObj || postData.params)) {
+            req.hasBody = true;
+            switch (postData.mimeType) {
+                case 'application/x-www-form-urlencoded':
+                    // 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();
+                    if ((_a = postData.params) === null || _a === void 0 ? void 0 : _a.length) {
+                        const [head, ...tail] = postData.params;
+                        push(`let postData = NSMutableData(data: "${head.name}=${head.value}".data(using: String.Encoding.utf8)!)`);
+                        tail.forEach(({ name, value }) => {
+                            push(`postData.append("&${name}=${value}".data(using: String.Encoding.utf8)!)`);
+                        });
+                    }
+                    else {
+                        req.hasBody = false;
+                    }
+                    break;
+                case 'application/json':
+                    if (postData.jsonObj) {
+                        push(`${literalDeclaration('parameters', postData.jsonObj, opts)} as [String : Any]`);
+                        blank();
+                        push('let postData = JSONSerialization.data(withJSONObject: parameters, options: [])');
+                    }
+                    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(literalDeclaration('parameters', postData.params, opts));
+                    blank();
+                    push(`let boundary = "${postData.boundary}"`);
+                    blank();
+                    push('var body = ""');
+                    push('var error: NSError? = nil');
+                    push('for param in parameters {');
+                    push('let paramName = param["name"]!', 1);
+                    push('body += "--\\(boundary)\\r\\n"', 1);
+                    push('body += "Content-Disposition:form-data; name=\\"\\(paramName)\\""', 1);
+                    push('if let filename = param["fileName"] {', 1);
+                    push('let contentType = param["content-type"]!', 2);
+                    push('let fileContent = String(contentsOfFile: filename, encoding: String.Encoding.utf8)', 2);
+                    push('if (error != nil) {', 2);
+                    push('print(error as Any)', 3);
+                    push('}', 2);
+                    push('body += "; filename=\\"\\(filename)\\"\\r\\n"', 2);
+                    push('body += "Content-Type: \\(contentType)\\r\\n\\r\\n"', 2);
+                    push('body += fileContent', 2);
+                    push('} else if let paramValue = param["value"] {', 1);
+                    push('body += "\\r\\n\\r\\n\\(paramValue)"', 2);
+                    push('}', 1);
+                    push('}');
+                    break;
+                default:
+                    blank();
+                    push(`let postData = NSData(data: "${postData.text}".data(using: String.Encoding.utf8)!)`);
+            }
+        }
+        blank();
+        // NSURLRequestUseProtocolCachePolicy is the default policy, let's just always set it to avoid confusion.
+        push(`let request = NSMutableURLRequest(url: NSURL(string: "${fullUrl}")! as URL,`);
+        push('                                        cachePolicy: .useProtocolCachePolicy,');
+        push(`                                    timeoutInterval: ${Number.parseInt(opts.timeout, 10).toFixed(1)})`);
+        push(`request.httpMethod = "${method}"`);
+        if (req.hasHeaders) {
+            push('request.allHTTPHeaderFields = headers');
+        }
+        if (req.hasBody) {
+            push('request.httpBody = postData as Data');
+        }
+        blank();
+        // Retrieving the shared session will be less verbose than creating a new one.
+        push('let session = URLSession.shared');
+        push('let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in');
+        push('if (error != nil) {', 1);
+        push('print(error as Any)', 2);
+        push('} else {', 1); // Casting the NSURLResponse to NSHTTPURLResponse so the user can see the status     .
+        push('let httpResponse = response as? HTTPURLResponse', 2);
+        push('print(httpResponse)', 2);
+        push('}', 1);
+        push('})');
+        blank();
+        push('dataTask.resume()');
+        return join();
+    },
 };
-export {
-  nsurlsession
-};
-//# sourceMappingURL=client.js.map

package/dist/httpsnippet-lite/targets/target.js

@@ -1 +1 @@
-//# sourceMappingURL=target.js.map
+export {};

package/dist/index.js

@@ -1,9 +1,2 @@
-import {
-  AVAILABLE_CLIENTS
-} from "@scalar/types/snippetz";
-import { snippetz } from "./snippetz.js";
-export {
-  AVAILABLE_CLIENTS,
-  snippetz
-};
-//# sourceMappingURL=index.js.map
+export { AVAILABLE_CLIENTS, } from '@scalar/types/snippetz';
+export { snippetz } from './snippetz.js';

package/dist/libs/http.js

@@ -1,63 +1,75 @@
-function normalizeRequest(request) {
-  return {
-    ...request,
-    method: (request.method || "GET").toUpperCase()
-  };
+/**
+ * Normalizes the request object with defaults
+ */
+export function normalizeRequest(request) {
+    return {
+        ...request,
+        method: (request.method || 'GET').toUpperCase(),
+    };
 }
-function buildQueryString(queryParams) {
-  if (!queryParams?.length) {
-    return "";
-  }
-  const queryPairs = queryParams.map((param) => `${encodeURIComponent(param.name)}=${encodeURIComponent(param.value)}`);
-  return `?${queryPairs.join("&")}`;
+/**
+ * Builds the query string from request parameters
+ */
+export function buildQueryString(queryParams) {
+    if (!queryParams?.length) {
+        return '';
+    }
+    const queryPairs = queryParams.map((param) => `${encodeURIComponent(param.name)}=${encodeURIComponent(param.value)}`);
+    return `?${queryPairs.join('&')}`;
 }
-const createSearchParams = (query = []) => {
-  const searchParams = new URLSearchParams();
-  query.forEach((q) => {
-    searchParams.append(q.name, q.value);
-  });
-  return searchParams;
+/**
+ * Creates a new URL search params object and sets query params so we can handle arrays
+ */
+export const createSearchParams = (query = []) => {
+    const searchParams = new URLSearchParams();
+    query.forEach((q) => {
+        searchParams.append(q.name, q.value);
+    });
+    return searchParams;
 };
-function reduceQueryParams(query = []) {
-  return query.reduce(
-    (acc, { name, value }) => {
-      const existingValue = acc[name];
-      if (existingValue === void 0) {
-        acc[name] = value;
-      } else if (Array.isArray(existingValue)) {
-        existingValue.push(value);
-      } else {
-        acc[name] = [existingValue, value];
-      }
-      return acc;
-    },
-    {}
-  );
+/**
+ * Reduces query parameters into an object while preserving repeated keys as arrays.
+ */
+export function reduceQueryParams(query = []) {
+    return query.reduce((acc, { name, value }) => {
+        const existingValue = acc[name];
+        if (existingValue === undefined) {
+            acc[name] = value;
+        }
+        else if (Array.isArray(existingValue)) {
+            existingValue.push(value);
+        }
+        else {
+            acc[name] = [existingValue, value];
+        }
+        return acc;
+    }, {});
 }
-function buildUrl(baseUrl, queryString) {
-  return `${baseUrl}${queryString}`;
+/**
+ * Builds the complete URL with query string
+ */
+export function buildUrl(baseUrl, queryString) {
+    return `${baseUrl}${queryString}`;
 }
-function processHeaders(request) {
-  const headers = {};
-  if (request.headers) {
-    for (const header of request.headers) {
-      if (header.value && !/[; ]/.test(header.name)) {
-        headers[header.name] = header.value;
-      }
+/**
+ * Processes headers and cookies into a headers object
+ */
+export function processHeaders(request) {
+    const headers = {};
+    // Process regular headers
+    if (request.headers) {
+        for (const header of request.headers) {
+            if (header.value && !/[; ]/.test(header.name)) {
+                headers[header.name] = header.value;
+            }
+        }
+    }
+    // Process cookies
+    if (request.cookies && request.cookies.length > 0) {
+        const cookieString = request.cookies
+            .map((cookie) => `${encodeURIComponent(cookie.name)}=${encodeURIComponent(cookie.value)}`)
+            .join('; ');
+        headers['Cookie'] = cookieString;
     }
-  }
-  if (request.cookies && request.cookies.length > 0) {
-    const cookieString = request.cookies.map((cookie) => `${encodeURIComponent(cookie.name)}=${encodeURIComponent(cookie.value)}`).join("; ");
-    headers["Cookie"] = cookieString;
-  }
-  return headers;
+    return headers;
 }
-export {
-  buildQueryString,
-  buildUrl,
-  createSearchParams,
-  normalizeRequest,
-  processHeaders,
-  reduceQueryParams
-};
-//# sourceMappingURL=http.js.map

package/dist/libs/javascript.js

@@ -1,69 +1,86 @@
+/**
+ * Checks if a key needs to be wrapped in quotes when used as an object property
+ *
+ * Returns true if the key contains spaces or hyphens
+ */
 function needsQuotes(key) {
-  return /\s|-/.test(key);
+    return /\s|-/.test(key);
 }
-class Raw {
-  constructor(value) {
-    this.value = value;
-  }
+/**
+ * Represents a raw code that should not be quoted, e.g. `JSON.stringify(...)`.
+ * If consists of multiple lines, they will be indented properly.
+ */
+export class Raw {
+    value;
+    constructor(value) {
+        this.value = value;
+    }
 }
-function objectToString(obj, indent = 0) {
-  const parts = [];
-  const indentation = " ".repeat(indent);
-  const innerIndentation = " ".repeat(indent + 2);
-  if (Object.keys(obj).length === 0) {
-    return "{}";
-  }
-  for (const [key, value] of Object.entries(obj)) {
-    const formattedKey = needsQuotes(key) ? `'${key}'` : key;
-    if (value instanceof Raw) {
-      const lines = value.value.split("\n");
-      let formattedValue = `${value.value}`;
-      if (lines.length > 1) {
-        formattedValue = lines.map((line, index) => {
-          if (index === 0) {
-            return line;
-          }
-          return `${innerIndentation}${line}`;
-        }).join("\n");
-      }
-      parts.push(`${innerIndentation}${formattedKey}: ${formattedValue}`);
-    } else if (Array.isArray(value)) {
-      const items = value.map((item) => {
-        if (typeof item === "string") {
-          return `'${item}'`;
+/**
+ * Converts an object into a string representation with proper formatting and indentation
+ *
+ * Handles nested objects, arrays, and special string values
+ */
+export function objectToString(obj, indent = 0) {
+    const parts = [];
+    const indentation = ' '.repeat(indent);
+    const innerIndentation = ' '.repeat(indent + 2);
+    if (Object.keys(obj).length === 0) {
+        return '{}';
+    }
+    for (const [key, value] of Object.entries(obj)) {
+        const formattedKey = needsQuotes(key) ? `'${key}'` : key;
+        if (value instanceof Raw) {
+            const lines = value.value.split('\n');
+            let formattedValue = `${value.value}`;
+            if (lines.length > 1) {
+                formattedValue = lines
+                    .map((line, index) => {
+                    if (index === 0) {
+                        return line;
+                    }
+                    return `${innerIndentation}${line}`;
+                })
+                    .join('\n');
+            }
+            parts.push(`${innerIndentation}${formattedKey}: ${formattedValue}`);
+        }
+        else if (Array.isArray(value)) {
+            const items = value.map((item) => {
+                if (typeof item === 'string') {
+                    return `'${item}'`;
+                }
+                if (item && typeof item === 'object') {
+                    return objectToString(item);
+                }
+                return JSON.stringify(item);
+            });
+            if (items.some((item) => item.includes('\n'))) {
+                // format vertically if any array element contains a newline
+                const arrayString = items.map((item) => indentString(item, indent + 4)).join(',\n');
+                parts.push(`${innerIndentation}${formattedKey}: [\n${arrayString}\n${innerIndentation}]`);
+            }
+            else {
+                parts.push(`${innerIndentation}${formattedKey}: [${items.join(', ')}]`);
+            }
+        }
+        else if (value && typeof value === 'object') {
+            parts.push(`${innerIndentation}${formattedKey}: ${objectToString(value, indent + 2)}`);
+        }
+        else if (typeof value === 'string') {
+            const formattedValue = `'${value}'`;
+            parts.push(`${innerIndentation}${formattedKey}: ${formattedValue}`);
         }
-        if (item && typeof item === "object") {
-          return objectToString(item);
+        else {
+            parts.push(`${innerIndentation}${formattedKey}: ${value}`);
         }
-        return JSON.stringify(item);
-      });
-      if (items.some((item) => item.includes("\n"))) {
-        const arrayString = items.map((item) => indentString(item, indent + 4)).join(",\n");
-        parts.push(`${innerIndentation}${formattedKey}: [
-${arrayString}
-${innerIndentation}]`);
-      } else {
-        parts.push(`${innerIndentation}${formattedKey}: [${items.join(", ")}]`);
-      }
-    } else if (value && typeof value === "object") {
-      parts.push(`${innerIndentation}${formattedKey}: ${objectToString(value, indent + 2)}`);
-    } else if (typeof value === "string") {
-      const formattedValue = `'${value}'`;
-      parts.push(`${innerIndentation}${formattedKey}: ${formattedValue}`);
-    } else {
-      parts.push(`${innerIndentation}${formattedKey}: ${value}`);
     }
-  }
-  return `{
-${parts.join(",\n")}
-${indentation}}`;
+    return `{\n${parts.join(',\n')}\n${indentation}}`;
 }
 function indentString(str, indent) {
-  const indentation = " ".repeat(indent);
-  return str.split("\n").map((line) => `${indentation}${line}`).join("\n");
+    const indentation = ' '.repeat(indent);
+    return str
+        .split('\n')
+        .map((line) => `${indentation}${line}`)
+        .join('\n');
 }
-export {
-  Raw,
-  objectToString
-};
-//# sourceMappingURL=javascript.js.map