@scalar/helpers 0.0.2

package/CHANGELOG.md

@@ -0,0 +1,7 @@
+# @scalar/helpers
+
+## 0.0.2
+
+### Patch Changes
+
+- 8165b3b: feat(helpers): added new helpers package

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023-present Scalar
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/array/is-defined.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Type safe alternative to array.filter(Boolean)
+ *
+ * @example
+ *
+ * ```ts
+ * const dataArray = [1, null, 2, undefined, 3].filter(isDefined)
+ * ```
+ *
+ * @see https://jaketrent.com/post/typescript-type-safe-filter-boolean/
+ */
+export declare const isDefined: <T>(value: T | null | undefined) => value is NonNullable<T>;
+//# sourceMappingURL=is-defined.d.ts.map

package/dist/array/is-defined.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"is-defined.d.ts","sourceRoot":"","sources":["../../src/array/is-defined.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AACH,eAAO,MAAM,SAAS,GAAI,CAAC,SAAS,CAAC,GAAG,IAAI,GAAG,SAAS,KAAG,KAAK,IAAI,WAAW,CAAC,CAAC,CAC1C,CAAA"}

package/dist/array/is-defined.js

@@ -0,0 +1,5 @@
+const isDefined = (value) => value !== null && value !== void 0;
+export {
+  isDefined
+};
+//# sourceMappingURL=is-defined.js.map

package/dist/array/is-defined.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../src/array/is-defined.ts"],
+  "sourcesContent": ["/**\n * Type safe alternative to array.filter(Boolean)\n *\n * @example\n *\n * ```ts\n * const dataArray = [1, null, 2, undefined, 3].filter(isDefined)\n * ```\n *\n * @see https://jaketrent.com/post/typescript-type-safe-filter-boolean/\n */\nexport const isDefined = <T>(value: T | null | undefined): value is NonNullable<T> =>\n  value !== null && value !== undefined\n"],
+  "mappings": "AAWO,MAAM,YAAY,CAAI,UAC3B,UAAU,QAAQ,UAAU;",
+  "names": []
+}

package/dist/dom/freeze-element.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Scroll Freezing Utility
+ * "Freezes" the scroll position of an element, so that it doesn't move when the rest of the content changes
+ *
+ * @example
+ * const unfreeze = freezeElement(document.querySelector('#your-element'))
+ * ... content changes ...
+ * unfreeze()
+ */
+export declare const freezeElement: (element: HTMLElement) => () => void;
+//# sourceMappingURL=freeze-element.d.ts.map

package/dist/dom/freeze-element.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"freeze-element.d.ts","sourceRoot":"","sources":["../../src/dom/freeze-element.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AACH,eAAO,MAAM,aAAa,YAAa,WAAW,eA4DjD,CAAA"}

package/dist/dom/freeze-element.js

@@ -0,0 +1,45 @@
+const freezeElement = (element) => {
+  if (!element) {
+    return () => null;
+  }
+  const rect = element.getBoundingClientRect();
+  const initialViewportTop = rect.top;
+  let rafId = null;
+  const observer = new MutationObserver((mutations) => {
+    const shouldProcess = mutations.some(
+      (mutation) => mutation.type === "childList" || mutation.type === "attributes" && (mutation.attributeName === "style" || mutation.attributeName === "class")
+    );
+    if (!shouldProcess) {
+      return;
+    }
+    if (rafId !== null) {
+      cancelAnimationFrame(rafId);
+    }
+    rafId = requestAnimationFrame(() => {
+      const newRect = element.getBoundingClientRect();
+      const currentViewportTop = newRect.top;
+      if (currentViewportTop !== initialViewportTop) {
+        const diff = currentViewportTop - initialViewportTop;
+        window.scrollBy(0, diff);
+      }
+      rafId = null;
+    });
+  });
+  observer.observe(document.body, {
+    childList: true,
+    subtree: true,
+    attributes: true,
+    attributeFilter: ["style", "class"],
+    characterData: false
+  });
+  return () => {
+    if (rafId !== null) {
+      cancelAnimationFrame(rafId);
+    }
+    observer.disconnect();
+  };
+};
+export {
+  freezeElement
+};
+//# sourceMappingURL=freeze-element.js.map

package/dist/dom/freeze-element.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../src/dom/freeze-element.ts"],
+  "sourcesContent": ["/**\n * Scroll Freezing Utility\n * \"Freezes\" the scroll position of an element, so that it doesn't move when the rest of the content changes\n *\n * @example\n * const unfreeze = freezeElement(document.querySelector('#your-element'))\n * ... content changes ...\n * unfreeze()\n */\nexport const freezeElement = (element: HTMLElement) => {\n  if (!element) {\n    return () => null\n  }\n\n  // Get initial position relative to viewport\n  const rect = element.getBoundingClientRect()\n  const initialViewportTop = rect.top\n  let rafId: number | null = null\n\n  // Create mutation observer to watch for DOM changes\n  const observer = new MutationObserver((mutations) => {\n    // Only process if we have mutations that might affect layout\n    const shouldProcess = mutations.some(\n      (mutation) =>\n        mutation.type === 'childList' ||\n        (mutation.type === 'attributes' && (mutation.attributeName === 'style' || mutation.attributeName === 'class')),\n    )\n\n    if (!shouldProcess) {\n      return\n    }\n\n    // Cancel any pending animation frame\n    if (rafId !== null) {\n      cancelAnimationFrame(rafId)\n    }\n\n    // Schedule the scroll adjustment for the next frame\n    rafId = requestAnimationFrame(() => {\n      const newRect = element.getBoundingClientRect()\n      const currentViewportTop = newRect.top\n\n      // If element has moved from its initial viewport position\n      if (currentViewportTop !== initialViewportTop) {\n        // Calculate how far it moved\n        const diff = currentViewportTop - initialViewportTop\n        // Adjust scroll to maintain position\n        window.scrollBy(0, diff)\n      }\n      rafId = null\n    })\n  })\n\n  // Start observing with more specific configuration\n  observer.observe(document.body, {\n    childList: true,\n    subtree: true,\n    attributes: true,\n    attributeFilter: ['style', 'class'],\n    characterData: false,\n  })\n\n  // Return function to stop maintaining position\n  return () => {\n    if (rafId !== null) {\n      cancelAnimationFrame(rafId)\n    }\n    observer.disconnect()\n  }\n}\n"],
+  "mappings": "AASO,MAAM,gBAAgB,CAAC,YAAyB;AACrD,MAAI,CAAC,SAAS;AACZ,WAAO,MAAM;AAAA,EACf;AAGA,QAAM,OAAO,QAAQ,sBAAsB;AAC3C,QAAM,qBAAqB,KAAK;AAChC,MAAI,QAAuB;AAG3B,QAAM,WAAW,IAAI,iBAAiB,CAAC,cAAc;AAEnD,UAAM,gBAAgB,UAAU;AAAA,MAC9B,CAAC,aACC,SAAS,SAAS,eACjB,SAAS,SAAS,iBAAiB,SAAS,kBAAkB,WAAW,SAAS,kBAAkB;AAAA,IACzG;AAEA,QAAI,CAAC,eAAe;AAClB;AAAA,IACF;AAGA,QAAI,UAAU,MAAM;AAClB,2BAAqB,KAAK;AAAA,IAC5B;AAGA,YAAQ,sBAAsB,MAAM;AAClC,YAAM,UAAU,QAAQ,sBAAsB;AAC9C,YAAM,qBAAqB,QAAQ;AAGnC,UAAI,uBAAuB,oBAAoB;AAE7C,cAAM,OAAO,qBAAqB;AAElC,eAAO,SAAS,GAAG,IAAI;AAAA,MACzB;AACA,cAAQ;AAAA,IACV,CAAC;AAAA,EACH,CAAC;AAGD,WAAS,QAAQ,SAAS,MAAM;AAAA,IAC9B,WAAW;AAAA,IACX,SAAS;AAAA,IACT,YAAY;AAAA,IACZ,iBAAiB,CAAC,SAAS,OAAO;AAAA,IAClC,eAAe;AAAA,EACjB,CAAC;AAGD,SAAO,MAAM;AACX,QAAI,UAAU,MAAM;AAClB,2BAAqB,KAAK;AAAA,IAC5B;AACA,aAAS,WAAW;AAAA,EACtB;AACF;",
+  "names": []
+}

package/dist/dom/scroll-to-id.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Tiny wrapper around the scrollIntoView API
+ *
+ * Also focuses the element if the focus flag is true
+ */
+export declare const scrollToId: (id: string, focus?: boolean) => Promise<void>;
+//# sourceMappingURL=scroll-to-id.d.ts.map

package/dist/dom/scroll-to-id.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"scroll-to-id.d.ts","sourceRoot":"","sources":["../../src/dom/scroll-to-id.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,eAAO,MAAM,UAAU,OAAc,MAAM,UAAU,OAAO,kBAkC3D,CAAA"}

package/dist/dom/scroll-to-id.js

@@ -0,0 +1,29 @@
+const scrollToId = async (id, focus) => {
+  const scrollToElement = (element2) => {
+    element2.scrollIntoView();
+    if (focus) {
+      element2.focus();
+    }
+  };
+  const element = document.getElementById(id);
+  if (element) {
+    scrollToElement(element);
+    return;
+  }
+  const stopTime = Date.now() + 1e3;
+  const tryScroll = () => {
+    const element2 = document.getElementById(id);
+    if (element2) {
+      scrollToElement(element2);
+      return;
+    }
+    if (Date.now() < stopTime) {
+      requestAnimationFrame(tryScroll);
+    }
+  };
+  requestAnimationFrame(tryScroll);
+};
+export {
+  scrollToId
+};
+//# sourceMappingURL=scroll-to-id.js.map

package/dist/dom/scroll-to-id.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../src/dom/scroll-to-id.ts"],
+  "sourcesContent": ["/**\n * Tiny wrapper around the scrollIntoView API\n *\n * Also focuses the element if the focus flag is true\n */\nexport const scrollToId = async (id: string, focus?: boolean) => {\n  const scrollToElement = (element: HTMLElement) => {\n    element.scrollIntoView()\n    if (focus) {\n      element.focus()\n    }\n  }\n\n  // Try to find the element immediately\n  const element = document.getElementById(id)\n  if (element) {\n    scrollToElement(element)\n    return\n  }\n\n  /** Try to find the element for up to 1 second\n   * allowing it to render for instance in markdown heading usage\n   */\n  const stopTime = Date.now() + 1000\n\n  const tryScroll = () => {\n    const element = document.getElementById(id)\n    if (element) {\n      scrollToElement(element)\n      return\n    }\n\n    if (Date.now() < stopTime) {\n      requestAnimationFrame(tryScroll)\n    }\n  }\n\n  // Start the retry process if the element doesn't exist yet\n  requestAnimationFrame(tryScroll)\n}\n"],
+  "mappings": "AAKO,MAAM,aAAa,OAAO,IAAY,UAAoB;AAC/D,QAAM,kBAAkB,CAACA,aAAyB;AAChD,IAAAA,SAAQ,eAAe;AACvB,QAAI,OAAO;AACT,MAAAA,SAAQ,MAAM;AAAA,IAChB;AAAA,EACF;AAGA,QAAM,UAAU,SAAS,eAAe,EAAE;AAC1C,MAAI,SAAS;AACX,oBAAgB,OAAO;AACvB;AAAA,EACF;AAKA,QAAM,WAAW,KAAK,IAAI,IAAI;AAE9B,QAAM,YAAY,MAAM;AACtB,UAAMA,WAAU,SAAS,eAAe,EAAE;AAC1C,QAAIA,UAAS;AACX,sBAAgBA,QAAO;AACvB;AAAA,IACF;AAEA,QAAI,KAAK,IAAI,IAAI,UAAU;AACzB,4BAAsB,SAAS;AAAA,IACjC;AAAA,EACF;AAGA,wBAAsB,SAAS;AACjC;",
+  "names": ["element"]
+}

package/dist/file/json2xml.d.ts

@@ -0,0 +1,5 @@
+/**
+ * This function converts an object to XML.
+ */
+export declare function json2xml(data: Record<string, any>, tab?: string): string;
+//# sourceMappingURL=json2xml.d.ts.map

package/dist/file/json2xml.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"json2xml.d.ts","sourceRoot":"","sources":["../../src/file/json2xml.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,wBAAgB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE,GAAG,CAAC,EAAE,MAAM,UAiD/D"}

package/dist/file/json2xml.js

@@ -0,0 +1,47 @@
+function json2xml(data, tab) {
+  const toXml = (value, key, indentation) => {
+    let xml2 = "";
+    if (Array.isArray(value)) {
+      for (let i = 0, n = value.length; i < n; i++) {
+        xml2 += indentation + toXml(value[i], key, indentation + "	") + "\n";
+      }
+    } else if (typeof value === "object") {
+      let hasChild = false;
+      xml2 += indentation + "<" + key;
+      for (const m in value) {
+        if (m.charAt(0) === "@") {
+          xml2 += " " + m.substr(1) + '="' + value[m].toString() + '"';
+        } else {
+          hasChild = true;
+        }
+      }
+      xml2 += hasChild ? ">" : "/>";
+      if (hasChild) {
+        for (const m in value) {
+          if (m === "#text") {
+            xml2 += value[m];
+          } else if (m === "#cdata") {
+            xml2 += "<![CDATA[" + value[m] + "]]>";
+          } else if (m.charAt(0) !== "@") {
+            xml2 += toXml(value[m], m, indentation + "	");
+          }
+        }
+        xml2 += (xml2.charAt(xml2.length - 1) === "\n" ? indentation : "") + "</" + key + ">";
+      }
+    } else {
+      xml2 += indentation + "<" + key + ">" + value.toString() + "</" + key + ">";
+    }
+    return xml2;
+  };
+  let xml = "";
+  for (const key in data) {
+    if (Object.hasOwn(data, key)) {
+      xml += toXml(data[key], key, "");
+    }
+  }
+  return tab ? xml.replace(/\t/g, tab) : xml.replace(/\t|\n/g, "");
+}
+export {
+  json2xml
+};
+//# sourceMappingURL=json2xml.js.map

package/dist/file/json2xml.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../src/file/json2xml.ts"],
+  "sourcesContent": ["/**\n * This function converts an object to XML.\n */\nexport function json2xml(data: Record<string, any>, tab?: string) {\n  const toXml = (value: any, key: string, indentation: string) => {\n    let xml = ''\n\n    if (Array.isArray(value)) {\n      for (let i = 0, n = value.length; i < n; i++) {\n        xml += indentation + toXml(value[i], key, indentation + '\\t') + '\\n'\n      }\n    } else if (typeof value === 'object') {\n      let hasChild = false\n      xml += indentation + '<' + key\n\n      for (const m in value) {\n        if (m.charAt(0) === '@') {\n          xml += ' ' + m.substr(1) + '=\"' + value[m].toString() + '\"'\n        } else {\n          hasChild = true\n        }\n      }\n\n      xml += hasChild ? '>' : '/>'\n\n      if (hasChild) {\n        for (const m in value) {\n          if (m === '#text') {\n            xml += value[m]\n          } else if (m === '#cdata') {\n            xml += '<![CDATA[' + value[m] + ']]>'\n          } else if (m.charAt(0) !== '@') {\n            xml += toXml(value[m], m, indentation + '\\t')\n          }\n        }\n        xml += (xml.charAt(xml.length - 1) === '\\n' ? indentation : '') + '</' + key + '>'\n      }\n    } else {\n      xml += indentation + '<' + key + '>' + value.toString() + '</' + key + '>'\n    }\n    return xml\n  }\n\n  let xml = ''\n\n  for (const key in data) {\n    if (Object.hasOwn(data, key)) {\n      xml += toXml(data[key], key, '')\n    }\n  }\n\n  return tab ? xml.replace(/\\t/g, tab) : xml.replace(/\\t|\\n/g, '')\n}\n"],
+  "mappings": "AAGO,SAAS,SAAS,MAA2B,KAAc;AAChE,QAAM,QAAQ,CAAC,OAAY,KAAa,gBAAwB;AAC9D,QAAIA,OAAM;AAEV,QAAI,MAAM,QAAQ,KAAK,GAAG;AACxB,eAAS,IAAI,GAAG,IAAI,MAAM,QAAQ,IAAI,GAAG,KAAK;AAC5C,QAAAA,QAAO,cAAc,MAAM,MAAM,CAAC,GAAG,KAAK,cAAc,GAAI,IAAI;AAAA,MAClE;AAAA,IACF,WAAW,OAAO,UAAU,UAAU;AACpC,UAAI,WAAW;AACf,MAAAA,QAAO,cAAc,MAAM;AAE3B,iBAAW,KAAK,OAAO;AACrB,YAAI,EAAE,OAAO,CAAC,MAAM,KAAK;AACvB,UAAAA,QAAO,MAAM,EAAE,OAAO,CAAC,IAAI,OAAO,MAAM,CAAC,EAAE,SAAS,IAAI;AAAA,QAC1D,OAAO;AACL,qBAAW;AAAA,QACb;AAAA,MACF;AAEA,MAAAA,QAAO,WAAW,MAAM;AAExB,UAAI,UAAU;AACZ,mBAAW,KAAK,OAAO;AACrB,cAAI,MAAM,SAAS;AACjB,YAAAA,QAAO,MAAM,CAAC;AAAA,UAChB,WAAW,MAAM,UAAU;AACzB,YAAAA,QAAO,cAAc,MAAM,CAAC,IAAI;AAAA,UAClC,WAAW,EAAE,OAAO,CAAC,MAAM,KAAK;AAC9B,YAAAA,QAAO,MAAM,MAAM,CAAC,GAAG,GAAG,cAAc,GAAI;AAAA,UAC9C;AAAA,QACF;AACA,QAAAA,SAAQA,KAAI,OAAOA,KAAI,SAAS,CAAC,MAAM,OAAO,cAAc,MAAM,OAAO,MAAM;AAAA,MACjF;AAAA,IACF,OAAO;AACL,MAAAA,QAAO,cAAc,MAAM,MAAM,MAAM,MAAM,SAAS,IAAI,OAAO,MAAM;AAAA,IACzE;AACA,WAAOA;AAAA,EACT;AAEA,MAAI,MAAM;AAEV,aAAW,OAAO,MAAM;AACtB,QAAI,OAAO,OAAO,MAAM,GAAG,GAAG;AAC5B,aAAO,MAAM,KAAK,GAAG,GAAG,KAAK,EAAE;AAAA,IACjC;AAAA,EACF;AAEA,SAAO,MAAM,IAAI,QAAQ,OAAO,GAAG,IAAI,IAAI,QAAQ,UAAU,EAAE;AACjE;",
+  "names": ["xml"]
+}

package/dist/general/is-mac-os.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Checks whether the user is on macOS
+ * Uses the modern navigator.userAgentData API with a fallback to navigator.userAgent
+ */
+export declare const isMacOS: () => any;
+//# sourceMappingURL=is-mac-os.d.ts.map

package/dist/general/is-mac-os.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"is-mac-os.d.ts","sourceRoot":"","sources":["../../src/general/is-mac-os.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,eAAO,MAAM,OAAO,WAcnB,CAAA"}

package/dist/general/is-mac-os.js

@@ -0,0 +1,13 @@
+const isMacOS = () => {
+  if (typeof navigator === "undefined") {
+    return false;
+  }
+  if (navigator.userAgentData?.platform) {
+    return navigator.userAgentData.platform.toLowerCase().includes("mac");
+  }
+  return /Mac/.test(navigator.userAgent);
+};
+export {
+  isMacOS
+};
+//# sourceMappingURL=is-mac-os.js.map

package/dist/general/is-mac-os.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../src/general/is-mac-os.ts"],
+  "sourcesContent": ["/**\n * Checks whether the user is on macOS\n * Uses the modern navigator.userAgentData API with a fallback to navigator.userAgent\n */\nexport const isMacOS = () => {\n  if (typeof navigator === 'undefined') {\n    return false\n  }\n\n  // Modern approach using navigator.userAgentData\n  // @ts-expect-error - userAgentData is new, we can remove this when its stable\n  if (navigator.userAgentData?.platform) {\n    // @ts-expect-error - userAgentData is new, we can remove this when its stable\n    return navigator.userAgentData.platform.toLowerCase().includes('mac')\n  }\n\n  // Fallback to userAgent\n  return /Mac/.test(navigator.userAgent)\n}\n"],
+  "mappings": "AAIO,MAAM,UAAU,MAAM;AAC3B,MAAI,OAAO,cAAc,aAAa;AACpC,WAAO;AAAA,EACT;AAIA,MAAI,UAAU,eAAe,UAAU;AAErC,WAAO,UAAU,cAAc,SAAS,YAAY,EAAE,SAAS,KAAK;AAAA,EACtE;AAGA,SAAO,MAAM,KAAK,UAAU,SAAS;AACvC;",
+  "names": []
+}

package/dist/http/can-method-have-body.d.ts

@@ -0,0 +1,8 @@
+import type { HttpMethod } from './http-methods';
+/** HTTP Methods which can have a body */
+declare const BODY_METHODS: ["post", "put", "patch", "delete"];
+type BodyMethod = (typeof BODY_METHODS)[number];
+/** Makes a check to see if this method CAN have a body */
+export declare const canMethodHaveBody: (method: HttpMethod) => method is BodyMethod;
+export {};
+//# sourceMappingURL=can-method-have-body.d.ts.map

package/dist/http/can-method-have-body.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"can-method-have-body.d.ts","sourceRoot":"","sources":["../../src/http/can-method-have-body.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAA;AAEhD,yCAAyC;AACzC,QAAA,MAAM,YAAY,oCAAqE,CAAA;AACvF,KAAK,UAAU,GAAG,CAAC,OAAO,YAAY,CAAC,CAAC,MAAM,CAAC,CAAA;AAE/C,0DAA0D;AAC1D,eAAO,MAAM,iBAAiB,WAAY,UAAU,KAAG,MAAM,IAAI,UACN,CAAA"}

package/dist/http/can-method-have-body.js

@@ -0,0 +1,6 @@
+const BODY_METHODS = ["post", "put", "patch", "delete"];
+const canMethodHaveBody = (method) => BODY_METHODS.includes(method.toLowerCase());
+export {
+  canMethodHaveBody
+};
+//# sourceMappingURL=can-method-have-body.js.map

package/dist/http/can-method-have-body.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../src/http/can-method-have-body.ts"],
+  "sourcesContent": ["import type { HttpMethod } from './http-methods'\n\n/** HTTP Methods which can have a body */\nconst BODY_METHODS = ['post', 'put', 'patch', 'delete'] as const satisfies HttpMethod[]\ntype BodyMethod = (typeof BODY_METHODS)[number]\n\n/** Makes a check to see if this method CAN have a body */\nexport const canMethodHaveBody = (method: HttpMethod): method is BodyMethod =>\n  BODY_METHODS.includes(method.toLowerCase() as BodyMethod)\n"],
+  "mappings": "AAGA,MAAM,eAAe,CAAC,QAAQ,OAAO,SAAS,QAAQ;AAI/C,MAAM,oBAAoB,CAAC,WAChC,aAAa,SAAS,OAAO,YAAY,CAAe;",
+  "names": []
+}

package/dist/http/http-info.d.ts

@@ -0,0 +1,116 @@
+export type HttpInfo = {
+    short: string;
+    colorClass: `text-${string}`;
+    colorVar: `var(--scalar-color-${string})`;
+    backgroundColor: string;
+};
+/**
+ * HTTP methods in a specific order
+ * Do not change the order
+ */
+export declare const REQUEST_METHODS: {
+    readonly get: {
+        readonly short: "GET";
+        readonly colorClass: "text-blue";
+        readonly colorVar: "var(--scalar-color-blue)";
+        readonly backgroundColor: "bg-blue/10";
+    };
+    readonly post: {
+        readonly short: "POST";
+        readonly colorClass: "text-green";
+        readonly colorVar: "var(--scalar-color-green)";
+        readonly backgroundColor: "bg-green/10";
+    };
+    readonly put: {
+        readonly short: "PUT";
+        readonly colorClass: "text-orange";
+        readonly colorVar: "var(--scalar-color-orange)";
+        readonly backgroundColor: "bg-orange/10";
+    };
+    readonly patch: {
+        readonly short: "PATCH";
+        readonly colorClass: "text-yellow";
+        readonly colorVar: "var(--scalar-color-yellow)";
+        readonly backgroundColor: "bg-yellow/10";
+    };
+    readonly delete: {
+        readonly short: "DEL";
+        readonly colorClass: "text-red";
+        readonly colorVar: "var(--scalar-color-red)";
+        readonly backgroundColor: "bg-red/10";
+    };
+    readonly options: {
+        readonly short: "OPTS";
+        readonly colorClass: "text-purple";
+        readonly colorVar: "var(--scalar-color-purple)";
+        readonly backgroundColor: "bg-purple/10";
+    };
+    readonly head: {
+        readonly short: "HEAD";
+        readonly colorClass: "text-c-2";
+        readonly colorVar: "var(--scalar-color-2)";
+        readonly backgroundColor: "bg-c-2/10";
+    };
+    readonly connect: {
+        readonly short: "CONN";
+        readonly colorClass: "text-c-2";
+        readonly colorVar: "var(--scalar-color-2)";
+        readonly backgroundColor: "bg-c-2/10";
+    };
+    readonly trace: {
+        readonly short: "TRACE";
+        readonly colorClass: "text-c-2";
+        readonly colorVar: "var(--scalar-color-2)";
+        readonly backgroundColor: "bg-c-2/10";
+    };
+};
+/**
+ * Accepts an HTTP Method name and returns some properties for the tag
+ */
+export declare const getHttpMethodInfo: (methodName: string) => {
+    readonly short: "GET";
+    readonly colorClass: "text-blue";
+    readonly colorVar: "var(--scalar-color-blue)";
+    readonly backgroundColor: "bg-blue/10";
+} | {
+    readonly short: "POST";
+    readonly colorClass: "text-green";
+    readonly colorVar: "var(--scalar-color-green)";
+    readonly backgroundColor: "bg-green/10";
+} | {
+    readonly short: "PUT";
+    readonly colorClass: "text-orange";
+    readonly colorVar: "var(--scalar-color-orange)";
+    readonly backgroundColor: "bg-orange/10";
+} | {
+    readonly short: "PATCH";
+    readonly colorClass: "text-yellow";
+    readonly colorVar: "var(--scalar-color-yellow)";
+    readonly backgroundColor: "bg-yellow/10";
+} | {
+    readonly short: "DEL";
+    readonly colorClass: "text-red";
+    readonly colorVar: "var(--scalar-color-red)";
+    readonly backgroundColor: "bg-red/10";
+} | {
+    readonly short: "OPTS";
+    readonly colorClass: "text-purple";
+    readonly colorVar: "var(--scalar-color-purple)";
+    readonly backgroundColor: "bg-purple/10";
+} | {
+    readonly short: "HEAD";
+    readonly colorClass: "text-c-2";
+    readonly colorVar: "var(--scalar-color-2)";
+    readonly backgroundColor: "bg-c-2/10";
+} | {
+    readonly short: "CONN";
+    readonly colorClass: "text-c-2";
+    readonly colorVar: "var(--scalar-color-2)";
+    readonly backgroundColor: "bg-c-2/10";
+} | {
+    readonly short: "TRACE";
+    readonly colorClass: "text-c-2";
+    readonly colorVar: "var(--scalar-color-2)";
+    readonly backgroundColor: "bg-c-2/10";
+};
+//# sourceMappingURL=http-info.d.ts.map

package/dist/http/http-info.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"http-info.d.ts","sourceRoot":"","sources":["../../src/http/http-info.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,QAAQ,GAAG;IACrB,KAAK,EAAE,MAAM,CAAA;IACb,UAAU,EAAE,QAAQ,MAAM,EAAE,CAAA;IAC5B,QAAQ,EAAE,sBAAsB,MAAM,GAAG,CAAA;IACzC,eAAe,EAAE,MAAM,CAAA;CACxB,CAAA;AAED;;;GAGG;AACH,eAAO,MAAM,eAAe;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAuDqB,CAAA;AAEjD;;GAEG;AACH,eAAO,MAAM,iBAAiB,eAAgB,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CASnD,CAAA"}

package/dist/http/http-info.js

@@ -0,0 +1,69 @@
+const REQUEST_METHODS = {
+  get: {
+    short: "GET",
+    colorClass: "text-blue",
+    colorVar: "var(--scalar-color-blue)",
+    backgroundColor: "bg-blue/10"
+  },
+  post: {
+    short: "POST",
+    colorClass: "text-green",
+    colorVar: "var(--scalar-color-green)",
+    backgroundColor: "bg-green/10"
+  },
+  put: {
+    short: "PUT",
+    colorClass: "text-orange",
+    colorVar: "var(--scalar-color-orange)",
+    backgroundColor: "bg-orange/10"
+  },
+  patch: {
+    short: "PATCH",
+    colorClass: "text-yellow",
+    colorVar: "var(--scalar-color-yellow)",
+    backgroundColor: "bg-yellow/10"
+  },
+  delete: {
+    short: "DEL",
+    colorClass: "text-red",
+    colorVar: "var(--scalar-color-red)",
+    backgroundColor: "bg-red/10"
+  },
+  options: {
+    short: "OPTS",
+    colorClass: "text-purple",
+    colorVar: "var(--scalar-color-purple)",
+    backgroundColor: "bg-purple/10"
+  },
+  head: {
+    short: "HEAD",
+    colorClass: "text-c-2",
+    colorVar: "var(--scalar-color-2)",
+    backgroundColor: "bg-c-2/10"
+  },
+  connect: {
+    short: "CONN",
+    colorClass: "text-c-2",
+    colorVar: "var(--scalar-color-2)",
+    backgroundColor: "bg-c-2/10"
+  },
+  trace: {
+    short: "TRACE",
+    colorClass: "text-c-2",
+    colorVar: "var(--scalar-color-2)",
+    backgroundColor: "bg-c-2/10"
+  }
+};
+const getHttpMethodInfo = (methodName) => {
+  const normalizedMethod = methodName.trim().toLowerCase();
+  return REQUEST_METHODS[normalizedMethod] ?? {
+    short: normalizedMethod,
+    color: "text-c-2",
+    backgroundColor: "bg-c-2"
+  };
+};
+export {
+  REQUEST_METHODS,
+  getHttpMethodInfo
+};
+//# sourceMappingURL=http-info.js.map

package/dist/http/http-info.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../src/http/http-info.ts"],
+  "sourcesContent": ["import type { HttpMethod } from './http-methods'\n\nexport type HttpInfo = {\n  short: string\n  colorClass: `text-${string}`\n  colorVar: `var(--scalar-color-${string})`\n  backgroundColor: string\n}\n\n/**\n * HTTP methods in a specific order\n * Do not change the order\n */\nexport const REQUEST_METHODS = {\n  get: {\n    short: 'GET',\n    colorClass: 'text-blue',\n    colorVar: 'var(--scalar-color-blue)',\n    backgroundColor: 'bg-blue/10',\n  },\n  post: {\n    short: 'POST',\n    colorClass: 'text-green',\n    colorVar: 'var(--scalar-color-green)',\n    backgroundColor: 'bg-green/10',\n  },\n  put: {\n    short: 'PUT',\n    colorClass: 'text-orange',\n    colorVar: 'var(--scalar-color-orange)',\n    backgroundColor: 'bg-orange/10',\n  },\n  patch: {\n    short: 'PATCH',\n    colorClass: 'text-yellow',\n    colorVar: 'var(--scalar-color-yellow)',\n    backgroundColor: 'bg-yellow/10',\n  },\n  delete: {\n    short: 'DEL',\n    colorClass: 'text-red',\n    colorVar: 'var(--scalar-color-red)',\n    backgroundColor: 'bg-red/10',\n  },\n  options: {\n    short: 'OPTS',\n    colorClass: 'text-purple',\n    colorVar: 'var(--scalar-color-purple)',\n    backgroundColor: 'bg-purple/10',\n  },\n  head: {\n    short: 'HEAD',\n    colorClass: 'text-c-2',\n    colorVar: 'var(--scalar-color-2)',\n    backgroundColor: 'bg-c-2/10',\n  },\n  connect: {\n    short: 'CONN',\n    colorClass: 'text-c-2',\n    colorVar: 'var(--scalar-color-2)',\n    backgroundColor: 'bg-c-2/10',\n  },\n  trace: {\n    short: 'TRACE',\n    colorClass: 'text-c-2',\n    colorVar: 'var(--scalar-color-2)',\n    backgroundColor: 'bg-c-2/10',\n  },\n} as const satisfies Record<HttpMethod, HttpInfo>\n\n/**\n * Accepts an HTTP Method name and returns some properties for the tag\n */\nexport const getHttpMethodInfo = (methodName: string) => {\n  const normalizedMethod = methodName.trim().toLowerCase() as HttpMethod\n  return (\n    REQUEST_METHODS[normalizedMethod] ?? {\n      short: normalizedMethod,\n      color: 'text-c-2',\n      backgroundColor: 'bg-c-2',\n    }\n  )\n}\n"],
+  "mappings": "AAaO,MAAM,kBAAkB;AAAA,EAC7B,KAAK;AAAA,IACH,OAAO;AAAA,IACP,YAAY;AAAA,IACZ,UAAU;AAAA,IACV,iBAAiB;AAAA,EACnB;AAAA,EACA,MAAM;AAAA,IACJ,OAAO;AAAA,IACP,YAAY;AAAA,IACZ,UAAU;AAAA,IACV,iBAAiB;AAAA,EACnB;AAAA,EACA,KAAK;AAAA,IACH,OAAO;AAAA,IACP,YAAY;AAAA,IACZ,UAAU;AAAA,IACV,iBAAiB;AAAA,EACnB;AAAA,EACA,OAAO;AAAA,IACL,OAAO;AAAA,IACP,YAAY;AAAA,IACZ,UAAU;AAAA,IACV,iBAAiB;AAAA,EACnB;AAAA,EACA,QAAQ;AAAA,IACN,OAAO;AAAA,IACP,YAAY;AAAA,IACZ,UAAU;AAAA,IACV,iBAAiB;AAAA,EACnB;AAAA,EACA,SAAS;AAAA,IACP,OAAO;AAAA,IACP,YAAY;AAAA,IACZ,UAAU;AAAA,IACV,iBAAiB;AAAA,EACnB;AAAA,EACA,MAAM;AAAA,IACJ,OAAO;AAAA,IACP,YAAY;AAAA,IACZ,UAAU;AAAA,IACV,iBAAiB;AAAA,EACnB;AAAA,EACA,SAAS;AAAA,IACP,OAAO;AAAA,IACP,YAAY;AAAA,IACZ,UAAU;AAAA,IACV,iBAAiB;AAAA,EACnB;AAAA,EACA,OAAO;AAAA,IACL,OAAO;AAAA,IACP,YAAY;AAAA,IACZ,UAAU;AAAA,IACV,iBAAiB;AAAA,EACnB;AACF;AAKO,MAAM,oBAAoB,CAAC,eAAuB;AACvD,QAAM,mBAAmB,WAAW,KAAK,EAAE,YAAY;AACvD,SACE,gBAAgB,gBAAgB,KAAK;AAAA,IACnC,OAAO;AAAA,IACP,OAAO;AAAA,IACP,iBAAiB;AAAA,EACnB;AAEJ;",
+  "names": []
+}

package/dist/http/http-methods.d.ts

@@ -0,0 +1,7 @@
+/** All OpenAPI HTTP methods plus connect */
+export declare const HTTP_METHODS: readonly ["connect", "delete", "get", "head", "options", "patch", "post", "put", "trace"];
+/** All http methods we support */
+export type HttpMethod = (typeof HTTP_METHODS)[number];
+/** Set of all http methods we support */
+export declare const httpMethods: Set<"connect" | "delete" | "get" | "head" | "options" | "patch" | "post" | "put" | "trace">;
+//# sourceMappingURL=http-methods.d.ts.map

package/dist/http/http-methods.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"http-methods.d.ts","sourceRoot":"","sources":["../../src/http/http-methods.ts"],"names":[],"mappings":"AAAA,4CAA4C;AAC5C,eAAO,MAAM,YAAY,2FAA4F,CAAA;AAErH,kCAAkC;AAClC,MAAM,MAAM,UAAU,GAAG,CAAC,OAAO,YAAY,CAAC,CAAC,MAAM,CAAC,CAAA;AAEtD,yCAAyC;AACzC,eAAO,MAAM,WAAW,6FAAwB,CAAA"}

package/dist/http/http-methods.js

@@ -0,0 +1,7 @@
+const HTTP_METHODS = ["connect", "delete", "get", "head", "options", "patch", "post", "put", "trace"];
+const httpMethods = new Set(HTTP_METHODS);
+export {
+  HTTP_METHODS,
+  httpMethods
+};
+//# sourceMappingURL=http-methods.js.map

package/dist/http/http-methods.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../src/http/http-methods.ts"],
+  "sourcesContent": ["/** All OpenAPI HTTP methods plus connect */\nexport const HTTP_METHODS = ['connect', 'delete', 'get', 'head', 'options', 'patch', 'post', 'put', 'trace'] as const\n\n/** All http methods we support */\nexport type HttpMethod = (typeof HTTP_METHODS)[number]\n\n/** Set of all http methods we support */\nexport const httpMethods = new Set(HTTP_METHODS)\n"],
+  "mappings": "AACO,MAAM,eAAe,CAAC,WAAW,UAAU,OAAO,QAAQ,WAAW,SAAS,QAAQ,OAAO,OAAO;AAMpG,MAAM,cAAc,IAAI,IAAI,YAAY;",
+  "names": []
+}

package/dist/http/http-status-codes.d.ts

@@ -0,0 +1,8 @@
+export type HttpStatusCode = {
+    name: string;
+    url: string;
+    color: string;
+};
+export type HttpStatusCodes = Record<string | number, HttpStatusCode>;
+export declare const httpStatusCodes: HttpStatusCodes;
+//# sourceMappingURL=http-status-codes.d.ts.map

package/dist/http/http-status-codes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"http-status-codes.d.ts","sourceRoot":"","sources":["../../src/http/http-status-codes.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,cAAc,GAAG;IAC3B,IAAI,EAAE,MAAM,CAAA;IACZ,GAAG,EAAE,MAAM,CAAA;IACX,KAAK,EAAE,MAAM,CAAA;CACd,CAAA;AAED,MAAM,MAAM,eAAe,GAAG,MAAM,CAAC,MAAM,GAAG,MAAM,EAAE,cAAc,CAAC,CAAA;AAErE,eAAO,MAAM,eAAe,EAAE,eA4T7B,CAAA"}