@scalar/snippetz 0.7.4 → 0.7.6

package/dist/plugins/shell/curl/curl.js

@@ -1,100 +1,132 @@
-import { escapeSingleQuotes } from "../../../libs/shell.js";
-const shellCurl = {
-  target: "shell",
-  client: "curl",
-  title: "Curl",
-  generate(request, configuration) {
-    const normalizedRequest = {
-      method: "GET",
-      ...request
-    };
-    normalizedRequest.method = normalizedRequest.method.toUpperCase();
-    const parts = ["curl"];
-    const queryString = normalizedRequest.queryString?.length ? "?" + normalizedRequest.queryString.map((param) => {
-      const encodedName = encodeURIComponent(param.name);
-      const encodedValue = encodeURIComponent(param.value);
-      return `${encodedName}=${encodedValue}`;
-    }).join("&") : "";
-    const url = `${normalizedRequest.url}${queryString}`;
-    const hasSpecialChars = /[\s<>[\]{}|\\^%$]/.test(url);
-    const urlPart = queryString || hasSpecialChars ? `'${url}'` : url;
-    parts[0] = `curl ${urlPart}`;
-    if (normalizedRequest.method !== "GET") {
-      parts.push(`--request ${normalizedRequest.method}`);
-    }
-    if (configuration?.auth?.username && configuration?.auth?.password) {
-      const authValue = escapeSingleQuotes(`${configuration.auth.username}:${configuration.auth.password}`);
-      parts.push(`--user '${authValue}'`);
-    }
-    if (normalizedRequest.headers?.length) {
-      normalizedRequest.headers.forEach((header) => {
-        const headerValue = escapeSingleQuotes(`${header.name}: ${header.value}`);
-        parts.push(`--header '${headerValue}'`);
-      });
-      const acceptEncoding = normalizedRequest.headers.find((header) => header.name.toLowerCase() === "accept-encoding");
-      if (acceptEncoding && /gzip|deflate/.test(acceptEncoding.value)) {
-        parts.push("--compressed");
-      }
-    }
-    if (normalizedRequest.cookies?.length) {
-      const cookieString = normalizedRequest.cookies.map((cookie) => {
-        const encodedName = encodeURIComponent(cookie.name);
-        const encodedValue = encodeURIComponent(cookie.value);
-        return `${encodedName}=${encodedValue}`;
-      }).join("; ");
-      const escapedCookieString = escapeSingleQuotes(cookieString);
-      parts.push(`--cookie '${escapedCookieString}'`);
-    }
-    if (normalizedRequest.postData) {
-      if (normalizedRequest.postData.mimeType === "application/json") {
-        if (normalizedRequest.postData.text) {
-          try {
-            const jsonData = JSON.parse(normalizedRequest.postData.text);
-            const prettyJson = JSON.stringify(jsonData, null, 2);
-            const escapedJson = escapeSingleQuotes(prettyJson);
-            parts.push(`--data '${escapedJson}'`);
-          } catch {
-            const escapedText = escapeSingleQuotes(normalizedRequest.postData.text ?? "");
-            parts.push(`--data '${escapedText}'`);
-          }
+import { escapeSingleQuotes } from '../../../libs/shell.js';
+/**
+ * shell/curl
+ */
+export const shellCurl = {
+    target: 'shell',
+    client: 'curl',
+    title: 'Curl',
+    generate(request, configuration) {
+        // Defaults
+        const normalizedRequest = {
+            method: 'GET',
+            ...request,
+        };
+        // Normalization
+        normalizedRequest.method = normalizedRequest.method.toUpperCase();
+        // Build curl command parts
+        const parts = ['curl'];
+        // URL (quote if has query parameters or special characters)
+        const queryString = normalizedRequest.queryString?.length
+            ? '?' +
+                normalizedRequest.queryString
+                    .map((param) => {
+                    // Ensure both name and value are fully URI encoded
+                    const encodedName = encodeURIComponent(param.name);
+                    const encodedValue = encodeURIComponent(param.value);
+                    return `${encodedName}=${encodedValue}`;
+                })
+                    .join('&')
+            : '';
+        const url = `${normalizedRequest.url}${queryString}`;
+        const hasSpecialChars = /[\s<>[\]{}|\\^%$]/.test(url);
+        const urlPart = queryString || hasSpecialChars ? `'${url}'` : url;
+        parts[0] = `curl ${urlPart}`;
+        // Method
+        if (normalizedRequest.method !== 'GET') {
+            parts.push(`--request ${normalizedRequest.method}`);
         }
-      } else if (normalizedRequest.postData.mimeType === "application/octet-stream") {
-        const escapedText = escapeSingleQuotes(normalizedRequest.postData.text ?? "");
-        parts.push(`--data-binary '${escapedText}'`);
-      } else if (normalizedRequest.postData.mimeType === "application/x-www-form-urlencoded" && normalizedRequest.postData.params) {
-        normalizedRequest.postData.params.forEach((param) => {
-          const escapedValue = escapeSingleQuotes(param.value ?? "");
-          const encodedName = encodeURIComponent(param.name);
-          const escapedName = escapeSingleQuotes(encodedName);
-          parts.push(`--data-urlencode '${escapedName}=${escapedValue}'`);
-        });
-      } else if (normalizedRequest.postData.mimeType === "multipart/form-data" && normalizedRequest.postData.params) {
-        normalizedRequest.postData.params.forEach((param) => {
-          const escapedName = escapeSingleQuotes(param.name);
-          if (param.fileName !== void 0) {
-            const escapedFileName = escapeSingleQuotes(param.fileName);
-            parts.push(`--form '${escapedName}=@${escapedFileName}'`);
-          } else {
-            const escapedValue = escapeSingleQuotes(param.value ?? "");
-            parts.push(`--form '${escapedName}=${escapedValue}'`);
-          }
-        });
-      } else {
-        try {
-          const jsonData = JSON.parse(normalizedRequest.postData.text ?? "");
-          const prettyJson = JSON.stringify(jsonData, null, 2);
-          const escapedJson = escapeSingleQuotes(prettyJson);
-          parts.push(`--data '${escapedJson}'`);
-        } catch {
-          const escapedText = escapeSingleQuotes(normalizedRequest.postData.text ?? "");
-          parts.push(`--data '${escapedText}'`);
+        // Basic Auth
+        if (configuration?.auth?.username && configuration?.auth?.password) {
+            const authValue = escapeSingleQuotes(`${configuration.auth.username}:${configuration.auth.password}`);
+            parts.push(`--user '${authValue}'`);
         }
-      }
-    }
-    return parts.join(" \\\n  ");
-  }
-};
-export {
-  shellCurl
+        // Headers
+        if (normalizedRequest.headers?.length) {
+            normalizedRequest.headers.forEach((header) => {
+                const headerValue = escapeSingleQuotes(`${header.name}: ${header.value}`);
+                parts.push(`--header '${headerValue}'`);
+            });
+            // Add compressed flag if Accept-Encoding header includes compression
+            const acceptEncoding = normalizedRequest.headers.find((header) => header.name.toLowerCase() === 'accept-encoding');
+            if (acceptEncoding && /gzip|deflate/.test(acceptEncoding.value)) {
+                parts.push('--compressed');
+            }
+        }
+        // Cookies
+        if (normalizedRequest.cookies?.length) {
+            const cookieString = normalizedRequest.cookies
+                .map((cookie) => {
+                // Encode both cookie name and value to handle special characters
+                const encodedName = encodeURIComponent(cookie.name);
+                const encodedValue = encodeURIComponent(cookie.value);
+                return `${encodedName}=${encodedValue}`;
+            })
+                .join('; ');
+            const escapedCookieString = escapeSingleQuotes(cookieString);
+            parts.push(`--cookie '${escapedCookieString}'`);
+        }
+        // Body
+        if (normalizedRequest.postData) {
+            if (normalizedRequest.postData.mimeType === 'application/json') {
+                // Pretty print JSON data
+                if (normalizedRequest.postData.text) {
+                    try {
+                        const jsonData = JSON.parse(normalizedRequest.postData.text);
+                        const prettyJson = JSON.stringify(jsonData, null, 2);
+                        const escapedJson = escapeSingleQuotes(prettyJson);
+                        parts.push(`--data '${escapedJson}'`);
+                    }
+                    catch {
+                        // If JSON parsing fails, use the original text
+                        const escapedText = escapeSingleQuotes(normalizedRequest.postData.text ?? '');
+                        parts.push(`--data '${escapedText}'`);
+                    }
+                }
+            }
+            else if (normalizedRequest.postData.mimeType === 'application/octet-stream') {
+                const escapedText = escapeSingleQuotes(normalizedRequest.postData.text ?? '');
+                parts.push(`--data-binary '${escapedText}'`);
+            }
+            else if (normalizedRequest.postData.mimeType === 'application/x-www-form-urlencoded' &&
+                normalizedRequest.postData.params) {
+                // Handle URL-encoded form data
+                normalizedRequest.postData.params.forEach((param) => {
+                    const escapedValue = escapeSingleQuotes(param.value ?? '');
+                    const encodedName = encodeURIComponent(param.name);
+                    const escapedName = escapeSingleQuotes(encodedName);
+                    parts.push(`--data-urlencode '${escapedName}=${escapedValue}'`);
+                });
+            }
+            else if (normalizedRequest.postData.mimeType === 'multipart/form-data' && normalizedRequest.postData.params) {
+                // Handle multipart form data
+                normalizedRequest.postData.params.forEach((param) => {
+                    const escapedName = escapeSingleQuotes(param.name);
+                    const multipartValueSuffix = param.contentType ? `;type=${param.contentType}` : '';
+                    if (param.fileName !== undefined) {
+                        const escapedFileName = escapeSingleQuotes(`${param.fileName}${multipartValueSuffix}`);
+                        parts.push(`--form '${escapedName}=@${escapedFileName}'`);
+                    }
+                    else {
+                        const escapedValue = escapeSingleQuotes(`${param.value ?? ''}${multipartValueSuffix}`);
+                        parts.push(`--form '${escapedName}=${escapedValue}'`);
+                    }
+                });
+            }
+            else {
+                // Try to parse and pretty print if it's JSON, otherwise use raw text
+                try {
+                    const jsonData = JSON.parse(normalizedRequest.postData.text ?? '');
+                    const prettyJson = JSON.stringify(jsonData, null, 2);
+                    const escapedJson = escapeSingleQuotes(prettyJson);
+                    parts.push(`--data '${escapedJson}'`);
+                }
+                catch {
+                    const escapedText = escapeSingleQuotes(normalizedRequest.postData.text ?? '');
+                    parts.push(`--data '${escapedText}'`);
+                }
+            }
+        }
+        return parts.join(' \\\n  ');
+    },
 };
-//# sourceMappingURL=curl.js.map

package/dist/plugins/shell/curl/index.js

@@ -1,5 +1 @@
-import { shellCurl } from "./curl.js";
-export {
-  shellCurl
-};
-//# sourceMappingURL=index.js.map
+export { shellCurl } from './curl.js';

package/dist/plugins/shell/httpie/httpie.js

@@ -1,14 +1,14 @@
-import { httpie } from "../../../httpsnippet-lite/targets/shell/httpie/client.js";
-import { convertWithHttpSnippetLite } from "../../../utils/convertWithHttpSnippetLite.js";
-const shellHttpie = {
-  target: "shell",
-  client: "httpie",
-  title: "HTTPie",
-  generate(request) {
-    return convertWithHttpSnippetLite(httpie, request);
-  }
+import { httpie } from '../../../httpsnippet-lite/targets/shell/httpie/client.js';
+import { convertWithHttpSnippetLite } from '../../../utils/convertWithHttpSnippetLite.js';
+/**
+ * shell/httpie
+ */
+export const shellHttpie = {
+    target: 'shell',
+    client: 'httpie',
+    title: 'HTTPie',
+    generate(request) {
+        // TODO: Write an own converter
+        return convertWithHttpSnippetLite(httpie, request);
+    },
 };
-export {
-  shellHttpie
-};
-//# sourceMappingURL=httpie.js.map

package/dist/plugins/shell/httpie/index.js

@@ -1,5 +1 @@
-import { shellHttpie } from "./httpie.js";
-export {
-  shellHttpie
-};
-//# sourceMappingURL=index.js.map
+export { shellHttpie } from './httpie.js';

package/dist/plugins/shell/wget/index.js

@@ -1,5 +1 @@
-import { shellWget } from "./wget.js";
-export {
-  shellWget
-};
-//# sourceMappingURL=index.js.map
+export { shellWget } from './wget.js';

package/dist/plugins/shell/wget/wget.js

@@ -1,14 +1,14 @@
-import { wget } from "../../../httpsnippet-lite/targets/shell/wget/client.js";
-import { convertWithHttpSnippetLite } from "../../../utils/convertWithHttpSnippetLite.js";
-const shellWget = {
-  target: "shell",
-  client: "wget",
-  title: "Wget",
-  generate(request) {
-    return convertWithHttpSnippetLite(wget, request);
-  }
+import { wget } from '../../../httpsnippet-lite/targets/shell/wget/client.js';
+import { convertWithHttpSnippetLite } from '../../../utils/convertWithHttpSnippetLite.js';
+/**
+ * shell/wget
+ */
+export const shellWget = {
+    target: 'shell',
+    client: 'wget',
+    title: 'Wget',
+    generate(request) {
+        // TODO: Write an own converter
+        return convertWithHttpSnippetLite(wget, request);
+    },
 };
-export {
-  shellWget
-};
-//# sourceMappingURL=wget.js.map

package/dist/plugins/swift/nsurlsession/index.js

@@ -1,5 +1 @@
-import { swiftNsurlsession } from "./nsurlsession.js";
-export {
-  swiftNsurlsession
-};
-//# sourceMappingURL=index.js.map
+export { swiftNsurlsession } from './nsurlsession.js';

package/dist/plugins/swift/nsurlsession/nsurlsession.js

@@ -1,14 +1,14 @@
-import { nsurlsession } from "../../../httpsnippet-lite/targets/swift/nsurlsession/client.js";
-import { convertWithHttpSnippetLite } from "../../../utils/convertWithHttpSnippetLite.js";
-const swiftNsurlsession = {
-  target: "swift",
-  client: "nsurlsession",
-  title: "NSURLSession",
-  generate(request) {
-    return convertWithHttpSnippetLite(nsurlsession, request);
-  }
+import { nsurlsession } from '../../../httpsnippet-lite/targets/swift/nsurlsession/client.js';
+import { convertWithHttpSnippetLite } from '../../../utils/convertWithHttpSnippetLite.js';
+/**
+ * swift/nsurlsession
+ */
+export const swiftNsurlsession = {
+    target: 'swift',
+    client: 'nsurlsession',
+    title: 'NSURLSession',
+    generate(request) {
+        // TODO: Write an own converter
+        return convertWithHttpSnippetLite(nsurlsession, request);
+    },
 };
-export {
-  swiftNsurlsession
-};
-//# sourceMappingURL=nsurlsession.js.map

package/dist/snippetz.js

@@ -1,30 +1,27 @@
-import { clients } from "./clients/index.js";
-function snippetz() {
-  function findPlugin(target, client) {
-    return clients.find(({ key }) => key === target)?.clients.find((plugin) => plugin.client === client);
-  }
-  return {
-    print(target, client, request) {
-      return findPlugin(target, client)?.generate(request);
-    },
-    clients() {
-      return clients;
-    },
-    plugins() {
-      return clients.flatMap(
-        ({ key, clients: clients2 }) => clients2.map((plugin) => ({
-          target: key,
-          client: plugin.client
-        }))
-      );
-    },
-    findPlugin,
-    hasPlugin(target, client) {
-      return Boolean(findPlugin(target, client));
+import { clients } from './clients/index.js';
+/**
+ * Generate code examples for HAR requests
+ */
+export function snippetz() {
+    function findPlugin(target, client) {
+        return clients.find(({ key }) => key === target)?.clients.find((plugin) => plugin.client === client);
     }
-  };
+    return {
+        print(target, client, request) {
+            return findPlugin(target, client)?.generate(request);
+        },
+        clients() {
+            return clients;
+        },
+        plugins() {
+            return clients.flatMap(({ key, clients }) => clients.map((plugin) => ({
+                target: key,
+                client: plugin.client,
+            })));
+        },
+        findPlugin,
+        hasPlugin(target, client) {
+            return Boolean(findPlugin(target, client));
+        },
+    };
 }
-export {
-  snippetz
-};
-//# sourceMappingURL=snippetz.js.map

package/dist/utils/convertWithHttpSnippetLite.js

@@ -1,98 +1,102 @@
-import { reduceQueryParams } from "../libs/http.js";
-function convertWithHttpSnippetLite(client, request) {
-  const urlObject = new URL(request?.url ?? "");
-  const url = urlObject.pathname === "/" ? urlObject.origin : urlObject.toString();
-  const harRequest = {
-    method: request?.method ?? "GET",
-    url,
-    httpVersion: "HTTP/1.1",
-    cookies: [],
-    // Cookies are handled through headers
-    headers: request?.headers ?? [],
-    headersSize: -1,
-    bodySize: -1,
-    queryString: Array.from(urlObject.searchParams.entries()).map(([name, value]) => ({
-      name,
-      value
-    })),
-    postData: request?.postData
-  };
-  const allHeaders = (harRequest?.headers ?? []).reduce(
-    (acc, header) => ({
-      ...acc,
-      [header.name]: header.value
-    }),
-    {}
-  );
-  const queryObj = reduceQueryParams(harRequest.queryString);
-  const cookiesObj = (harRequest.cookies ?? []).reduce(
-    (acc, cookie) => ({
-      ...acc,
-      [cookie.name]: cookie.value
-    }),
-    {}
-  );
-  const parsedUrl = new URL(harRequest.url);
-  const uriObj = {
-    protocol: parsedUrl.protocol,
-    hostname: parsedUrl.hostname,
-    host: parsedUrl.hostname,
-    port: parsedUrl.port,
-    pathname: parsedUrl.pathname.split("/").map((segment) => encodeURIComponent(decodeURIComponent(segment))).join("/") + parsedUrl.search,
-    path: parsedUrl.pathname.split("/").map((segment) => encodeURIComponent(decodeURIComponent(segment))).join("/") + parsedUrl.search,
-    search: parsedUrl.search,
-    hash: parsedUrl.hash,
-    href: parsedUrl.href,
-    origin: parsedUrl.origin,
-    password: parsedUrl.password,
-    searchParams: parsedUrl.searchParams,
-    username: parsedUrl.username,
-    toString: parsedUrl.toString,
-    toJSON: () => parsedUrl.toJSON()
-  };
-  const convertRequest = {
-    url: harRequest.url,
-    uriObj,
-    method: harRequest.method?.toLocaleUpperCase() ?? "GET",
-    httpVersion: harRequest.httpVersion,
-    cookies: harRequest.cookies ?? [],
-    headers: harRequest.headers ?? [],
-    headersSize: harRequest.headersSize ?? 0,
-    headersObj: allHeaders ?? {},
-    bodySize: harRequest.bodySize ?? 0,
-    queryString: harRequest.queryString ?? [],
-    postData: harRequest.postData ? {
-      mimeType: harRequest.postData.mimeType ?? "application/json",
-      text: harRequest.postData.text ?? "",
-      params: harRequest.postData.params ?? [],
-      paramsObj: harRequest.postData.params?.reduce(
-        (acc, param) => {
-          if (param.name && param.value !== void 0) {
-            acc[param.name] = param.value;
-          }
-          return acc;
-        },
-        {}
-      ) ?? {}
-    } : void 0,
-    allHeaders: allHeaders ?? {},
-    fullUrl: harRequest.url,
-    queryObj: queryObj ?? {},
-    cookiesObj: cookiesObj ?? {}
-  };
-  if (convertRequest.postData?.mimeType === "application/json" && convertRequest.postData.text) {
-    try {
-      convertRequest.postData.jsonObj = JSON.parse(convertRequest.postData.text);
-    } catch (error) {
-      console.error("Error parsing JSON:", error);
+import { reduceQueryParams } from '../libs/http.js';
+/**
+ * Takes a httpsnippet-lite client and converts the given request to a code example with it.
+ *
+ * @deprecated This a temporary wrapper around httpsnippet-lite. Let's write all the generators ourselves instead.
+ */
+export function convertWithHttpSnippetLite(
+// Couldn't find the proper type, there was always a mismatch.
+client, request) {
+    const urlObject = new URL(request?.url ?? '');
+    // If it's just the domain, omit the trailing slash
+    const url = urlObject.pathname === '/' ? urlObject.origin : urlObject.toString();
+    const harRequest = {
+        method: request?.method ?? 'GET',
+        url,
+        httpVersion: 'HTTP/1.1',
+        cookies: [], // Cookies are handled through headers
+        headers: request?.headers ?? [],
+        headersSize: -1,
+        bodySize: -1,
+        queryString: Array.from(urlObject.searchParams.entries()).map(([name, value]) => ({
+            name,
+            value,
+        })),
+        postData: request?.postData,
+    };
+    const allHeaders = (harRequest?.headers ?? []).reduce((acc, header) => ({
+        ...acc,
+        [header.name]: header.value,
+    }), {});
+    const queryObj = reduceQueryParams(harRequest.queryString);
+    const cookiesObj = (harRequest.cookies ?? []).reduce((acc, cookie) => ({
+        ...acc,
+        [cookie.name]: cookie.value,
+    }), {});
+    const parsedUrl = new URL(harRequest.url);
+    const uriObj = {
+        protocol: parsedUrl.protocol,
+        hostname: parsedUrl.hostname,
+        host: parsedUrl.hostname,
+        port: parsedUrl.port,
+        pathname: parsedUrl.pathname
+            .split('/')
+            .map((segment) => encodeURIComponent(decodeURIComponent(segment)))
+            .join('/') + parsedUrl.search,
+        path: parsedUrl.pathname
+            .split('/')
+            .map((segment) => encodeURIComponent(decodeURIComponent(segment)))
+            .join('/') + parsedUrl.search,
+        search: parsedUrl.search,
+        hash: parsedUrl.hash,
+        href: parsedUrl.href,
+        origin: parsedUrl.origin,
+        password: parsedUrl.password,
+        searchParams: parsedUrl.searchParams,
+        username: parsedUrl.username,
+        toString: parsedUrl.toString,
+        toJSON: () => parsedUrl.toJSON(),
+    };
+    const convertRequest = {
+        url: harRequest.url,
+        uriObj,
+        method: harRequest.method?.toLocaleUpperCase() ?? 'GET',
+        httpVersion: harRequest.httpVersion,
+        cookies: harRequest.cookies ?? [],
+        headers: harRequest.headers ?? [],
+        headersSize: harRequest.headersSize ?? 0,
+        headersObj: allHeaders ?? {},
+        bodySize: harRequest.bodySize ?? 0,
+        queryString: harRequest.queryString ?? [],
+        postData: harRequest.postData
+            ? {
+                mimeType: harRequest.postData.mimeType ?? 'application/json',
+                text: harRequest.postData.text ?? '',
+                params: harRequest.postData.params ?? [],
+                paramsObj: harRequest.postData.params?.reduce((acc, param) => {
+                    if (param.name && param.value !== undefined) {
+                        acc[param.name] = param.value;
+                    }
+                    return acc;
+                }, {}) ?? {},
+            }
+            : undefined,
+        allHeaders: allHeaders ?? {},
+        fullUrl: harRequest.url,
+        queryObj: queryObj ?? {},
+        cookiesObj: cookiesObj ?? {},
+    };
+    // If the request is a JSON request, parse the text as JSON
+    if (convertRequest.postData?.mimeType === 'application/json' && convertRequest.postData.text) {
+        try {
+            convertRequest.postData.jsonObj = JSON.parse(convertRequest.postData.text);
+        }
+        catch (error) {
+            console.error('Error parsing JSON:', error);
+        }
     }
-  }
-  if (typeof client.convert === "function") {
-    return client.convert(convertRequest);
-  }
-  return "";
+    if (typeof client.convert === 'function') {
+        return client.convert(convertRequest);
+    }
+    return '';
 }
-export {
-  convertWithHttpSnippetLite
-};
-//# sourceMappingURL=convertWithHttpSnippetLite.js.map

package/dist/utils/index.js

@@ -1,5 +1 @@
-import { convertWithHttpSnippetLite } from "./convertWithHttpSnippetLite.js";
-export {
-  convertWithHttpSnippetLite
-};
-//# sourceMappingURL=index.js.map
+export { convertWithHttpSnippetLite } from './convertWithHttpSnippetLite.js';