qrbit 0.5.0

package/dist/qrbit.cjs

@@ -0,0 +1,394 @@
+"use strict";
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/qrbit.ts
+var qrbit_exports = {};
+__export(qrbit_exports, {
+  QrBit: () => QrBit,
+  QrBitEvents: () => QrBitEvents
+});
+module.exports = __toCommonJS(qrbit_exports);
+var import_node_buffer = require("buffer");
+var import_node_fs = __toESM(require("fs"), 1);
+var import_node_path = __toESM(require("path"), 1);
+var import_cacheable = require("cacheable");
+var import_hookified = require("hookified");
+var import_qrcode = __toESM(require("qrcode"), 1);
+var import_native = require("./native.js");
+var QrBitEvents = /* @__PURE__ */ ((QrBitEvents2) => {
+  QrBitEvents2["warn"] = "warn";
+  QrBitEvents2["info"] = "info";
+  QrBitEvents2["error"] = "error";
+  return QrBitEvents2;
+})(QrBitEvents || {});
+var logoFileDoesNotExistMessage = (logo) => `Logo file not found: ${logo}. Proceeding without logo.`;
+var QrBit = class _QrBit extends import_hookified.Hookified {
+  /**
+   * Create a new QrBit instance.
+   * @param options - Configuration options for the QR code
+   */
+  constructor(options) {
+    super();
+    this._napi = {
+      convertSvgToPng: import_native.convertSvgToPng,
+      generateQr: import_native.generateQr,
+      generateQrPng: import_native.generateQrPng,
+      generateQrPngWithBuffer: import_native.generateQrPngWithBuffer,
+      generateQrSvg: import_native.generateQrSvg,
+      generateQrSvgWithBuffer: import_native.generateQrSvgWithBuffer
+    };
+    this._text = options.text;
+    this._size = options.size ?? 200;
+    this._margin = options.margin ?? void 0;
+    this._logo = options.logo;
+    this._logoSizeRatio = options.logoSizeRatio ?? 0.2;
+    this._backgroundColor = options.backgroundColor ?? "#FFFFFF";
+    this._foregroundColor = options.foregroundColor ?? "#000000";
+    if (options.cache !== void 0) {
+      if (options.cache === true) {
+        this._cache = new import_cacheable.Cacheable();
+      } else if (options.cache !== false) {
+        this._cache = options.cache;
+      }
+    } else {
+      this._cache = new import_cacheable.Cacheable();
+    }
+    this.throwOnEmitError = true;
+  }
+  /**
+   * Get the text content for the QR code.
+   * @returns {string} The text content
+   */
+  get text() {
+    return this._text;
+  }
+  /**
+   * Set the text content for the QR code.
+   * @param value - The text content to encode
+   */
+  set text(value) {
+    this._text = value;
+  }
+  /**
+   * Get the size of the QR code in pixels.
+   * @returns {number} The size in pixels
+   * @default 200
+   */
+  get size() {
+    return this._size;
+  }
+  /**
+   * Set the size of the QR code in pixels.
+   * @param value - The size in pixels
+   */
+  set size(value) {
+    this._size = value;
+  }
+  /**
+   * Get the margin around the QR code in pixels.
+   * @returns {number | undefined} The margin in pixels
+   */
+  get margin() {
+    return this._margin;
+  }
+  /**
+   * Set the margin around the QR code in pixels.
+   * @param value - The margin in pixels
+   */
+  set margin(value) {
+    this._margin = value;
+  }
+  /**
+   * Get the logo path or buffer.
+   * @returns {string | Buffer | undefined} The logo path, buffer, or undefined if no logo
+   * @default undefined
+   */
+  get logo() {
+    return this._logo;
+  }
+  /**
+   * Set the logo as a file path or buffer.
+   * @param value - The logo file path, buffer, or undefined to remove logo
+   */
+  set logo(value) {
+    this._logo = value;
+  }
+  /**
+   * Get the logo size ratio relative to QR code size.
+   * @returns {number} The logo size ratio
+   * @default 0.2
+   */
+  get logoSizeRatio() {
+    return this._logoSizeRatio;
+  }
+  /**
+   * Set the logo size ratio relative to QR code size.
+   * @param value - The logo size ratio (0.0 to 1.0)
+   */
+  set logoSizeRatio(value) {
+    this._logoSizeRatio = value;
+  }
+  /**
+   * Get the background color of the QR code.
+   * @returns {string} The background color in hex format
+   * @default "#FFFFFF"
+   */
+  get backgroundColor() {
+    return this._backgroundColor;
+  }
+  /**
+   * Set the background color of the QR code.
+   * @param value - The background color in hex format (e.g., "#FFFFFF")
+   */
+  set backgroundColor(value) {
+    this._backgroundColor = value;
+  }
+  /**
+   * Get the foreground color of the QR code.
+   * @returns {string} The foreground color in hex format
+   * @default "#000000"
+   */
+  get foregroundColor() {
+    return this._foregroundColor;
+  }
+  /**
+   * Set the foreground color of the QR code.
+   * @param value - The foreground color in hex format (e.g., "#000000")
+   */
+  set foregroundColor(value) {
+    this._foregroundColor = value;
+  }
+  /**
+   * Get the cache instance.
+   * @returns {Cacheable | undefined} The cache instance or undefined if caching is disabled
+   */
+  get cache() {
+    return this._cache;
+  }
+  /**
+   * Set the cache instance.
+   * @param value - The cache instance or undefined to disable caching
+   */
+  set cache(value) {
+    this._cache = value;
+  }
+  /**
+   * Generate SVG QR code with optional caching.
+   * Uses QRCode library for simple cases, Rust implementation for logos.
+   * @param {toOptions} options - Generation options whether to use caching (default: true)
+   * @returns {Promise<string>} The SVG string
+   */
+  async toSvg(options) {
+    let result = "";
+    let renderKey = `native-svg`;
+    if (this._logo) {
+      renderKey = `napi-svg`;
+    }
+    const qrOptions = {
+      text: this._text,
+      size: this._size,
+      margin: this._margin,
+      logo: this._logo,
+      logoSizeRatio: this._logoSizeRatio,
+      backgroundColor: this._backgroundColor,
+      foregroundColor: this._foregroundColor
+    };
+    if (this._cache && options?.cache !== false) {
+      const key = this.generateCacheKey(renderKey);
+      const cached = await this._cache.get(key);
+      if (cached) {
+        return cached;
+      }
+    }
+    if (!this._logo) {
+      const qrCodeOptions = {
+        type: "svg",
+        width: qrOptions.size,
+        color: {
+          dark: qrOptions.foregroundColor,
+          light: qrOptions.backgroundColor
+        }
+      };
+      result = await import_qrcode.default.toString(this._text, qrCodeOptions);
+    } else {
+      result = await this.toSvgNapi();
+    }
+    if (this._cache && options?.cache !== false) {
+      const key = this.generateCacheKey(renderKey);
+      await this._cache.set(key, result);
+    }
+    return result;
+  }
+  /**
+   * Generate SVG QR code using the native Rust implementation.
+   * Automatically chooses between file path and buffer functions.
+   * @returns {Promise<string>} The SVG string
+   */
+  async toSvgNapi() {
+    if (this._logo && import_node_buffer.Buffer.isBuffer(this._logo)) {
+      const nativeOptionsBuffer = {
+        text: this._text,
+        size: this._size,
+        margin: this._margin,
+        logoBuffer: this._logo,
+        logoSizeRatio: this._logoSizeRatio,
+        backgroundColor: this._backgroundColor,
+        foregroundColor: this._foregroundColor
+      };
+      return this._napi.generateQrSvgWithBuffer(nativeOptionsBuffer);
+    } else {
+      const nativeOptions = {
+        text: this._text,
+        size: this._size,
+        margin: this._margin,
+        logoPath: this._logo,
+        logoSizeRatio: this._logoSizeRatio,
+        backgroundColor: this._backgroundColor,
+        foregroundColor: this._foregroundColor
+      };
+      if (this._logo && this.isLogoString()) {
+        if (!await this.logoFileExists(this._logo)) {
+          this.emit(
+            "error" /* error */,
+            logoFileDoesNotExistMessage(this._logo)
+          );
+        }
+      }
+      return this._napi.generateQrSvg(nativeOptions);
+    }
+  }
+  /**
+   * Generate PNG QR code with optional caching.
+   * Generates the QR as Svg either in rust if it has a logo or native. Then does a conversion on it.
+   * @param options - Generation options
+   * @param options.cache - Whether to use caching (default: true)
+   * @returns {Promise<Buffer>} The PNG buffer
+   */
+  async toPng(options) {
+    let result;
+    const renderKey = `napi-png`;
+    if (this._cache && options?.cache !== false) {
+      const key = this.generateCacheKey(renderKey);
+      const cached = await this._cache.get(key);
+      if (cached) {
+        return import_node_buffer.Buffer.from(cached);
+      }
+    }
+    const svg = await this.toSvg();
+    result = _QrBit.convertSvgToPng(svg);
+    if (this._cache && options?.cache !== false) {
+      const key = this.generateCacheKey(renderKey);
+      await this._cache.set(key, result);
+    }
+    return result;
+  }
+  /**
+   * Generate PNG QR code and save it to a file.
+   * Creates directories if they don't exist.
+   * @param filePath - The file path where to save the PNG
+   * @param options - Generation options
+   * @param options.cache - Whether to use caching (default: true)
+   * @returns {Promise<void>} Resolves when file is written
+   */
+  async toPngFile(filePath, options) {
+    const pngBuffer = await this.toPng(options);
+    const dir = import_node_path.default.dirname(filePath);
+    await import_node_fs.default.promises.mkdir(dir, { recursive: true });
+    await import_node_fs.default.promises.writeFile(filePath, pngBuffer);
+  }
+  /**
+   * Generate SVG QR code and save it to a file.
+   * Creates directories if they don't exist.
+   * @param filePath - The file path where to save the SVG
+   * @param options - Generation options
+   * @param options.cache - Whether to use caching (default: true)
+   * @returns {Promise<void>} Resolves when file is written
+   */
+  async toSvgFile(filePath, options) {
+    const svgString = await this.toSvg(options);
+    const dir = import_node_path.default.dirname(filePath);
+    await import_node_fs.default.promises.mkdir(dir, { recursive: true });
+    await import_node_fs.default.promises.writeFile(filePath, svgString, "utf8");
+  }
+  /**
+   * Convert SVG content to PNG buffer using the native Rust implementation.
+   * @param svgContent - The SVG content as a string
+   * @param width - Optional width for the PNG output
+   * @param height - Optional height for the PNG output
+   * @returns {Buffer} The PNG buffer
+   */
+  static convertSvgToPng(svgContent, width, height) {
+    return (0, import_native.convertSvgToPng)(svgContent, width, height);
+  }
+  /**
+   * Generate a cache key based on the current QR code options.
+   * @param {string} renderKey the format that you are rendering in such as `napi-png`, `native-svg`, `napi-svg`
+   * @returns {string} The cache key
+   */
+  generateCacheKey(renderKey) {
+    const qrOptions = {
+      text: this._text,
+      size: this._size,
+      margin: this._margin,
+      logo: this._logo || void 0,
+      logoSizeRatio: this._logoSizeRatio,
+      backgroundColor: this._backgroundColor,
+      foregroundColor: this._foregroundColor,
+      renderKey
+    };
+    const cache = this._cache || new import_cacheable.Cacheable();
+    return cache.hash(qrOptions);
+  }
+  /**
+   * Check if the logo is a string (file path).
+   * @returns {boolean} True if logo is a string, false otherwise
+   */
+  isLogoString() {
+    return typeof this._logo === "string";
+  }
+  /**
+   * Check if a logo file exists at the specified path.
+   * @param filePath - The file path to check
+   * @returns {Promise<boolean>} True if file exists, false otherwise
+   */
+  async logoFileExists(filePath) {
+    try {
+      await import_node_fs.default.promises.access(filePath, import_node_fs.default.constants.F_OK);
+      return true;
+    } catch (_error) {
+      return false;
+    }
+  }
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  QrBit,
+  QrBitEvents
+});
+//# sourceMappingURL=qrbit.cjs.map

package/dist/qrbit.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/qrbit.ts"],"sourcesContent":["import { Buffer } from \"node:buffer\";\nimport fs from \"node:fs\";\nimport path from \"node:path\";\nimport { Cacheable } from \"cacheable\";\nimport { Hookified, type HookifiedOptions } from \"hookified\";\nimport QRCode, { type QRCodeToStringOptions } from \"qrcode\";\nimport {\n\tconvertSvgToPng as nativeConvertSvgToPng,\n\tgenerateQr as nativeGenerateQr,\n\tgenerateQrPng as nativeGenerateQrPng,\n\tgenerateQrPngWithBuffer as nativeGenerateQrPngWithBuffer,\n\tgenerateQrSvg as nativeGenerateQrSvg,\n\tgenerateQrSvgWithBuffer as nativeGenerateQrSvgWithBuffer,\n} from \"./native.js\";\n\nexport enum QrBitEvents {\n\twarn = \"warn\",\n\tinfo = \"info\",\n\terror = \"error\",\n}\n\nconst logoFileDoesNotExistMessage = (logo: string) =>\n\t`Logo file not found: ${logo}. Proceeding without logo.`;\n\nexport type QrOptions = {\n\t/**\n\t * The text content to encode in the QR code. It can be text or a url.\n\t * @type {string}\n\t */\n\ttext: string;\n\t/**\n\t * The size of the QR code in pixels.\n\t * @type {number}\n\t * @default 200\n\t */\n\tsize?: number;\n\t/**\n\t * The margin around the QR code in pixels.\n\t * @type {number}\n\t */\n\tmargin?: number;\n\t/**\n\t * The logo to embed in the QR code.\n\t * @type {string | Buffer}\n\t */\n\tlogo?: string | Buffer;\n\t/**\n\t * The logo size ratio relative to QR code size.\n\t * @type {number}\n\t * @default 0.2\n\t */\n\tlogoSizeRatio?: number;\n\t/**\n\t * The background color of the QR code.\n\t * @type {string}\n\t * @default \"#FFFFFF\"\n\t */\n\tbackgroundColor?: string;\n\t/**\n\t * The foreground color of the QR code.\n\t * @type {string}\n\t * @default \"#000000\"\n\t */\n\tforegroundColor?: string;\n\t/**\n\t * Caching is enabled by default. You can disable it by setting this option to false. You can also pass\n\t * a custom Cacheable instance.\n\t * @type {Cacheable | boolean}\n\t * @default true\n\t */\n\tcache?: Cacheable | boolean;\n} & HookifiedOptions;\n\nexport interface QrResult {\n\tsvg?: string;\n\tpng?: Buffer;\n\twidth: number;\n\theight: number;\n}\n\nexport type toOptions = {\n\tcache?: boolean;\n};\n\n/**\n * QR code generator with logo support and caching capabilities.\n * Supports both file path and buffer-based logos with automatic optimization.\n */\nexport class QrBit extends Hookified {\n\tprivate _text: string;\n\tprivate _size: number;\n\tprivate _margin: number | undefined;\n\tprivate _logo: string | Buffer | undefined;\n\tprivate _logoSizeRatio: number;\n\tprivate _backgroundColor: string;\n\tprivate _foregroundColor: string;\n\tprivate _cache: Cacheable | undefined;\n\tprivate _napi = {\n\t\tconvertSvgToPng: nativeConvertSvgToPng,\n\t\tgenerateQr: nativeGenerateQr,\n\t\tgenerateQrPng: nativeGenerateQrPng,\n\t\tgenerateQrPngWithBuffer: nativeGenerateQrPngWithBuffer,\n\t\tgenerateQrSvg: nativeGenerateQrSvg,\n\t\tgenerateQrSvgWithBuffer: nativeGenerateQrSvgWithBuffer,\n\t};\n\n\t/**\n\t * Create a new QrBit instance.\n\t * @param options - Configuration options for the QR code\n\t */\n\tconstructor(options: QrOptions) {\n\t\tsuper();\n\t\tthis._text = options.text;\n\t\tthis._size = options.size ?? 200;\n\t\tthis._margin = options.margin ?? undefined;\n\t\tthis._logo = options.logo;\n\t\tthis._logoSizeRatio = options.logoSizeRatio ?? 0.2;\n\t\tthis._backgroundColor = options.backgroundColor ?? \"#FFFFFF\";\n\t\tthis._foregroundColor = options.foregroundColor ?? \"#000000\";\n\t\tif (options.cache !== undefined) {\n\t\t\t// if it is boolean and true then create a new cacheable instance\n\t\t\tif (options.cache === true) {\n\t\t\t\tthis._cache = new Cacheable();\n\t\t\t} else if (options.cache !== false) {\n\t\t\t\t// it is a cacheable instance\n\t\t\t\tthis._cache = options.cache as Cacheable;\n\t\t\t}\n\t\t} else {\n\t\t\tthis._cache = new Cacheable();\n\t\t}\n\n\t\t// set throwOnEmitError to true if there are no listeners\n\t\tthis.throwOnEmitError = true;\n\t}\n\n\t/**\n\t * Get the text content for the QR code.\n\t * @returns {string} The text content\n\t */\n\tpublic get text(): string {\n\t\treturn this._text;\n\t}\n\n\t/**\n\t * Set the text content for the QR code.\n\t * @param value - The text content to encode\n\t */\n\tpublic set text(value: string) {\n\t\tthis._text = value;\n\t}\n\n\t/**\n\t * Get the size of the QR code in pixels.\n\t * @returns {number} The size in pixels\n\t * @default 200\n\t */\n\tpublic get size(): number {\n\t\treturn this._size;\n\t}\n\n\t/**\n\t * Set the size of the QR code in pixels.\n\t * @param value - The size in pixels\n\t */\n\tpublic set size(value: number) {\n\t\tthis._size = value;\n\t}\n\n\t/**\n\t * Get the margin around the QR code in pixels.\n\t * @returns {number | undefined} The margin in pixels\n\t */\n\tpublic get margin(): number | undefined {\n\t\treturn this._margin;\n\t}\n\n\t/**\n\t * Set the margin around the QR code in pixels.\n\t * @param value - The margin in pixels\n\t */\n\tpublic set margin(value: number | undefined) {\n\t\tthis._margin = value;\n\t}\n\n\t/**\n\t * Get the logo path or buffer.\n\t * @returns {string | Buffer | undefined} The logo path, buffer, or undefined if no logo\n\t * @default undefined\n\t */\n\tpublic get logo(): string | Buffer | undefined {\n\t\treturn this._logo;\n\t}\n\n\t/**\n\t * Set the logo as a file path or buffer.\n\t * @param value - The logo file path, buffer, or undefined to remove logo\n\t */\n\tpublic set logo(value: string | Buffer | undefined) {\n\t\tthis._logo = value;\n\t}\n\n\t/**\n\t * Get the logo size ratio relative to QR code size.\n\t * @returns {number} The logo size ratio\n\t * @default 0.2\n\t */\n\tpublic get logoSizeRatio(): number {\n\t\treturn this._logoSizeRatio;\n\t}\n\n\t/**\n\t * Set the logo size ratio relative to QR code size.\n\t * @param value - The logo size ratio (0.0 to 1.0)\n\t */\n\tpublic set logoSizeRatio(value: number) {\n\t\tthis._logoSizeRatio = value;\n\t}\n\n\t/**\n\t * Get the background color of the QR code.\n\t * @returns {string} The background color in hex format\n\t * @default \"#FFFFFF\"\n\t */\n\tpublic get backgroundColor(): string {\n\t\treturn this._backgroundColor;\n\t}\n\n\t/**\n\t * Set the background color of the QR code.\n\t * @param value - The background color in hex format (e.g., \"#FFFFFF\")\n\t */\n\tpublic set backgroundColor(value: string) {\n\t\tthis._backgroundColor = value;\n\t}\n\n\t/**\n\t * Get the foreground color of the QR code.\n\t * @returns {string} The foreground color in hex format\n\t * @default \"#000000\"\n\t */\n\tpublic get foregroundColor(): string {\n\t\treturn this._foregroundColor;\n\t}\n\n\t/**\n\t * Set the foreground color of the QR code.\n\t * @param value - The foreground color in hex format (e.g., \"#000000\")\n\t */\n\tpublic set foregroundColor(value: string) {\n\t\tthis._foregroundColor = value;\n\t}\n\n\t/**\n\t * Get the cache instance.\n\t * @returns {Cacheable | undefined} The cache instance or undefined if caching is disabled\n\t */\n\tpublic get cache(): Cacheable | undefined {\n\t\treturn this._cache;\n\t}\n\n\t/**\n\t * Set the cache instance.\n\t * @param value - The cache instance or undefined to disable caching\n\t */\n\tpublic set cache(value: Cacheable | undefined) {\n\t\tthis._cache = value;\n\t}\n\n\t/**\n\t * Generate SVG QR code with optional caching.\n\t * Uses QRCode library for simple cases, Rust implementation for logos.\n\t * @param {toOptions} options - Generation options whether to use caching (default: true)\n\t * @returns {Promise<string>} The SVG string\n\t */\n\tpublic async toSvg(options?: toOptions): Promise<string> {\n\t\tlet result = \"\";\n\t\tlet renderKey = `native-svg`;\n\n\t\tif (this._logo) {\n\t\t\trenderKey = `napi-svg`;\n\t\t}\n\n\t\t// set all the options\n\t\tconst qrOptions = {\n\t\t\ttext: this._text,\n\t\t\tsize: this._size,\n\t\t\tmargin: this._margin,\n\t\t\tlogo: this._logo,\n\t\t\tlogoSizeRatio: this._logoSizeRatio,\n\t\t\tbackgroundColor: this._backgroundColor,\n\t\t\tforegroundColor: this._foregroundColor,\n\t\t};\n\n\t\t// check the cache\n\t\tif (this._cache && options?.cache !== false) {\n\t\t\tconst key = this.generateCacheKey(renderKey);\n\t\t\tconst cached = await this._cache.get<string>(key);\n\t\t\tif (cached) {\n\t\t\t\treturn cached;\n\t\t\t}\n\t\t}\n\n\t\tif (!this._logo) {\n\t\t\tconst qrCodeOptions: QRCodeToStringOptions = {\n\t\t\t\ttype: \"svg\",\n\t\t\t\twidth: qrOptions.size,\n\t\t\t\tcolor: {\n\t\t\t\t\tdark: qrOptions.foregroundColor,\n\t\t\t\t\tlight: qrOptions.backgroundColor,\n\t\t\t\t},\n\t\t\t};\n\n\t\t\tresult = await QRCode.toString(this._text, qrCodeOptions);\n\t\t} else {\n\t\t\t// If logoPath is set, use the Rust implementation\n\t\t\tresult = await this.toSvgNapi();\n\t\t}\n\n\t\tif (this._cache && options?.cache !== false) {\n\t\t\t// set the cache, generate the key from hash\n\t\t\tconst key = this.generateCacheKey(renderKey);\n\t\t\t// cache the value\n\t\t\tawait this._cache.set(key, result);\n\t\t}\n\n\t\treturn result;\n\t}\n\n\t/**\n\t * Generate SVG QR code using the native Rust implementation.\n\t * Automatically chooses between file path and buffer functions.\n\t * @returns {Promise<string>} The SVG string\n\t */\n\tpublic async toSvgNapi(): Promise<string> {\n\t\t// Choose optimal path based on logo type\n\t\tif (this._logo && Buffer.isBuffer(this._logo)) {\n\t\t\t// Logo is already a buffer - use buffer function\n\t\t\tconst nativeOptionsBuffer = {\n\t\t\t\ttext: this._text,\n\t\t\t\tsize: this._size,\n\t\t\t\tmargin: this._margin,\n\t\t\t\tlogoBuffer: this._logo,\n\t\t\t\tlogoSizeRatio: this._logoSizeRatio,\n\t\t\t\tbackgroundColor: this._backgroundColor,\n\t\t\t\tforegroundColor: this._foregroundColor,\n\t\t\t};\n\t\t\treturn this._napi.generateQrSvgWithBuffer(nativeOptionsBuffer);\n\t\t} else {\n\t\t\t// Logo is a string path or undefined - use original function\n\t\t\tconst nativeOptions = {\n\t\t\t\ttext: this._text,\n\t\t\t\tsize: this._size,\n\t\t\t\tmargin: this._margin,\n\t\t\t\tlogoPath: this._logo as string,\n\t\t\t\tlogoSizeRatio: this._logoSizeRatio,\n\t\t\t\tbackgroundColor: this._backgroundColor,\n\t\t\t\tforegroundColor: this._foregroundColor,\n\t\t\t};\n\n\t\t\tif (this._logo && this.isLogoString()) {\n\t\t\t\tif (!(await this.logoFileExists(this._logo as string))) {\n\t\t\t\t\tthis.emit(\n\t\t\t\t\t\tQrBitEvents.error,\n\t\t\t\t\t\tlogoFileDoesNotExistMessage(this._logo as string),\n\t\t\t\t\t);\n\t\t\t\t}\n\t\t\t}\n\n\t\t\treturn this._napi.generateQrSvg(nativeOptions);\n\t\t}\n\t}\n\n\t/**\n\t * Generate PNG QR code with optional caching.\n\t * Generates the QR as Svg either in rust if it has a logo or native. Then does a conversion on it.\n\t * @param options - Generation options\n\t * @param options.cache - Whether to use caching (default: true)\n\t * @returns {Promise<Buffer>} The PNG buffer\n\t */\n\tpublic async toPng(options?: toOptions): Promise<Buffer> {\n\t\tlet result: Buffer;\n\t\tconst renderKey = `napi-png`;\n\n\t\t// check the cache\n\t\tif (this._cache && options?.cache !== false) {\n\t\t\tconst key = this.generateCacheKey(renderKey);\n\t\t\tconst cached = await this._cache.get<Buffer>(key);\n\t\t\tif (cached) {\n\t\t\t\t// Ensure we return a Buffer, not Uint8Array\n\t\t\t\treturn Buffer.from(cached);\n\t\t\t}\n\t\t}\n\n\t\tconst svg = await this.toSvg();\n\t\tresult = QrBit.convertSvgToPng(svg);\n\n\t\tif (this._cache && options?.cache !== false) {\n\t\t\t// set the cache, generate the key from hash\n\t\t\tconst key = this.generateCacheKey(renderKey);\n\t\t\t// cache the value\n\t\t\tawait this._cache.set(key, result);\n\t\t}\n\n\t\treturn result;\n\t}\n\n\t/**\n\t * Generate PNG QR code and save it to a file.\n\t * Creates directories if they don't exist.\n\t * @param filePath - The file path where to save the PNG\n\t * @param options - Generation options\n\t * @param options.cache - Whether to use caching (default: true)\n\t * @returns {Promise<void>} Resolves when file is written\n\t */\n\tpublic async toPngFile(filePath: string, options?: toOptions): Promise<void> {\n\t\tconst pngBuffer = await this.toPng(options);\n\n\t\t// Create directory if it doesn't exist\n\t\tconst dir = path.dirname(filePath);\n\t\tawait fs.promises.mkdir(dir, { recursive: true });\n\n\t\tawait fs.promises.writeFile(filePath, pngBuffer);\n\t}\n\n\t/**\n\t * Generate SVG QR code and save it to a file.\n\t * Creates directories if they don't exist.\n\t * @param filePath - The file path where to save the SVG\n\t * @param options - Generation options\n\t * @param options.cache - Whether to use caching (default: true)\n\t * @returns {Promise<void>} Resolves when file is written\n\t */\n\tpublic async toSvgFile(filePath: string, options?: toOptions): Promise<void> {\n\t\tconst svgString = await this.toSvg(options);\n\n\t\t// Create directory if it doesn't exist\n\t\tconst dir = path.dirname(filePath);\n\t\tawait fs.promises.mkdir(dir, { recursive: true });\n\n\t\tawait fs.promises.writeFile(filePath, svgString, \"utf8\");\n\t}\n\n\t/**\n\t * Convert SVG content to PNG buffer using the native Rust implementation.\n\t * @param svgContent - The SVG content as a string\n\t * @param width - Optional width for the PNG output\n\t * @param height - Optional height for the PNG output\n\t * @returns {Buffer} The PNG buffer\n\t */\n\tpublic static convertSvgToPng(\n\t\tsvgContent: string,\n\t\twidth?: number,\n\t\theight?: number,\n\t): Buffer {\n\t\treturn nativeConvertSvgToPng(svgContent, width, height);\n\t}\n\n\t/**\n\t * Generate a cache key based on the current QR code options.\n\t * @param {string} renderKey the format that you are rendering in such as `napi-png`, `native-svg`, `napi-svg`\n\t * @returns {string} The cache key\n\t */\n\tpublic generateCacheKey(renderKey: string): string {\n\t\tconst qrOptions = {\n\t\t\ttext: this._text,\n\t\t\tsize: this._size,\n\t\t\tmargin: this._margin,\n\t\t\tlogo: this._logo || undefined,\n\t\t\tlogoSizeRatio: this._logoSizeRatio,\n\t\t\tbackgroundColor: this._backgroundColor,\n\t\t\tforegroundColor: this._foregroundColor,\n\t\t\trenderKey,\n\t\t};\n\n\t\tconst cache = this._cache || new Cacheable();\n\n\t\treturn cache.hash(qrOptions);\n\t}\n\n\t/**\n\t * Check if the logo is a string (file path).\n\t * @returns {boolean} True if logo is a string, false otherwise\n\t */\n\tpublic isLogoString(): boolean {\n\t\treturn typeof this._logo === \"string\";\n\t}\n\n\t/**\n\t * Check if a logo file exists at the specified path.\n\t * @param filePath - The file path to check\n\t * @returns {Promise<boolean>} True if file exists, false otherwise\n\t */\n\tpublic async logoFileExists(filePath: string): Promise<boolean> {\n\t\ttry {\n\t\t\tawait fs.promises.access(filePath, fs.constants.F_OK);\n\t\t\treturn true;\n\t\t} catch (_error) {\n\t\t\treturn false;\n\t\t}\n\t}\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,yBAAuB;AACvB,qBAAe;AACf,uBAAiB;AACjB,uBAA0B;AAC1B,uBAAiD;AACjD,oBAAmD;AACnD,oBAOO;AAEA,IAAK,cAAL,kBAAKA,iBAAL;AACN,EAAAA,aAAA,UAAO;AACP,EAAAA,aAAA,UAAO;AACP,EAAAA,aAAA,WAAQ;AAHG,SAAAA;AAAA,GAAA;AAMZ,IAAM,8BAA8B,CAAC,SACpC,wBAAwB,IAAI;AAkEtB,IAAM,QAAN,MAAM,eAAc,2BAAU;AAAA;AAAA;AAAA;AAAA;AAAA,EAsBpC,YAAY,SAAoB;AAC/B,UAAM;AAdP,SAAQ,QAAQ;AAAA,MACf,iBAAiB,cAAAC;AAAA,MACjB,YAAY,cAAAC;AAAA,MACZ,eAAe,cAAAC;AAAA,MACf,yBAAyB,cAAAC;AAAA,MACzB,eAAe,cAAAC;AAAA,MACf,yBAAyB,cAAAC;AAAA,IAC1B;AAQC,SAAK,QAAQ,QAAQ;AACrB,SAAK,QAAQ,QAAQ,QAAQ;AAC7B,SAAK,UAAU,QAAQ,UAAU;AACjC,SAAK,QAAQ,QAAQ;AACrB,SAAK,iBAAiB,QAAQ,iBAAiB;AAC/C,SAAK,mBAAmB,QAAQ,mBAAmB;AACnD,SAAK,mBAAmB,QAAQ,mBAAmB;AACnD,QAAI,QAAQ,UAAU,QAAW;AAEhC,UAAI,QAAQ,UAAU,MAAM;AAC3B,aAAK,SAAS,IAAI,2BAAU;AAAA,MAC7B,WAAW,QAAQ,UAAU,OAAO;AAEnC,aAAK,SAAS,QAAQ;AAAA,MACvB;AAAA,IACD,OAAO;AACN,WAAK,SAAS,IAAI,2BAAU;AAAA,IAC7B;AAGA,SAAK,mBAAmB;AAAA,EACzB;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,IAAW,OAAe;AACzB,WAAO,KAAK;AAAA,EACb;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,IAAW,KAAK,OAAe;AAC9B,SAAK,QAAQ;AAAA,EACd;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,IAAW,OAAe;AACzB,WAAO,KAAK;AAAA,EACb;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,IAAW,KAAK,OAAe;AAC9B,SAAK,QAAQ;AAAA,EACd;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,IAAW,SAA6B;AACvC,WAAO,KAAK;AAAA,EACb;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,IAAW,OAAO,OAA2B;AAC5C,SAAK,UAAU;AAAA,EAChB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,IAAW,OAAoC;AAC9C,WAAO,KAAK;AAAA,EACb;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,IAAW,KAAK,OAAoC;AACnD,SAAK,QAAQ;AAAA,EACd;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,IAAW,gBAAwB;AAClC,WAAO,KAAK;AAAA,EACb;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,IAAW,cAAc,OAAe;AACvC,SAAK,iBAAiB;AAAA,EACvB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,IAAW,kBAA0B;AACpC,WAAO,KAAK;AAAA,EACb;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,IAAW,gBAAgB,OAAe;AACzC,SAAK,mBAAmB;AAAA,EACzB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,IAAW,kBAA0B;AACpC,WAAO,KAAK;AAAA,EACb;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,IAAW,gBAAgB,OAAe;AACzC,SAAK,mBAAmB;AAAA,EACzB;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,IAAW,QAA+B;AACzC,WAAO,KAAK;AAAA,EACb;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,IAAW,MAAM,OAA8B;AAC9C,SAAK,SAAS;AAAA,EACf;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,MAAa,MAAM,SAAsC;AACxD,QAAI,SAAS;AACb,QAAI,YAAY;AAEhB,QAAI,KAAK,OAAO;AACf,kBAAY;AAAA,IACb;AAGA,UAAM,YAAY;AAAA,MACjB,MAAM,KAAK;AAAA,MACX,MAAM,KAAK;AAAA,MACX,QAAQ,KAAK;AAAA,MACb,MAAM,KAAK;AAAA,MACX,eAAe,KAAK;AAAA,MACpB,iBAAiB,KAAK;AAAA,MACtB,iBAAiB,KAAK;AAAA,IACvB;AAGA,QAAI,KAAK,UAAU,SAAS,UAAU,OAAO;AAC5C,YAAM,MAAM,KAAK,iBAAiB,SAAS;AAC3C,YAAM,SAAS,MAAM,KAAK,OAAO,IAAY,GAAG;AAChD,UAAI,QAAQ;AACX,eAAO;AAAA,MACR;AAAA,IACD;AAEA,QAAI,CAAC,KAAK,OAAO;AAChB,YAAM,gBAAuC;AAAA,QAC5C,MAAM;AAAA,QACN,OAAO,UAAU;AAAA,QACjB,OAAO;AAAA,UACN,MAAM,UAAU;AAAA,UAChB,OAAO,UAAU;AAAA,QAClB;AAAA,MACD;AAEA,eAAS,MAAM,cAAAC,QAAO,SAAS,KAAK,OAAO,aAAa;AAAA,IACzD,OAAO;AAEN,eAAS,MAAM,KAAK,UAAU;AAAA,IAC/B;AAEA,QAAI,KAAK,UAAU,SAAS,UAAU,OAAO;AAE5C,YAAM,MAAM,KAAK,iBAAiB,SAAS;AAE3C,YAAM,KAAK,OAAO,IAAI,KAAK,MAAM;AAAA,IAClC;AAEA,WAAO;AAAA,EACR;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAa,YAA6B;AAEzC,QAAI,KAAK,SAAS,0BAAO,SAAS,KAAK,KAAK,GAAG;AAE9C,YAAM,sBAAsB;AAAA,QAC3B,MAAM,KAAK;AAAA,QACX,MAAM,KAAK;AAAA,QACX,QAAQ,KAAK;AAAA,QACb,YAAY,KAAK;AAAA,QACjB,eAAe,KAAK;AAAA,QACpB,iBAAiB,KAAK;AAAA,QACtB,iBAAiB,KAAK;AAAA,MACvB;AACA,aAAO,KAAK,MAAM,wBAAwB,mBAAmB;AAAA,IAC9D,OAAO;AAEN,YAAM,gBAAgB;AAAA,QACrB,MAAM,KAAK;AAAA,QACX,MAAM,KAAK;AAAA,QACX,QAAQ,KAAK;AAAA,QACb,UAAU,KAAK;AAAA,QACf,eAAe,KAAK;AAAA,QACpB,iBAAiB,KAAK;AAAA,QACtB,iBAAiB,KAAK;AAAA,MACvB;AAEA,UAAI,KAAK,SAAS,KAAK,aAAa,GAAG;AACtC,YAAI,CAAE,MAAM,KAAK,eAAe,KAAK,KAAe,GAAI;AACvD,eAAK;AAAA,YACJ;AAAA,YACA,4BAA4B,KAAK,KAAe;AAAA,UACjD;AAAA,QACD;AAAA,MACD;AAEA,aAAO,KAAK,MAAM,cAAc,aAAa;AAAA,IAC9C;AAAA,EACD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,MAAa,MAAM,SAAsC;AACxD,QAAI;AACJ,UAAM,YAAY;AAGlB,QAAI,KAAK,UAAU,SAAS,UAAU,OAAO;AAC5C,YAAM,MAAM,KAAK,iBAAiB,SAAS;AAC3C,YAAM,SAAS,MAAM,KAAK,OAAO,IAAY,GAAG;AAChD,UAAI,QAAQ;AAEX,eAAO,0BAAO,KAAK,MAAM;AAAA,MAC1B;AAAA,IACD;AAEA,UAAM,MAAM,MAAM,KAAK,MAAM;AAC7B,aAAS,OAAM,gBAAgB,GAAG;AAElC,QAAI,KAAK,UAAU,SAAS,UAAU,OAAO;AAE5C,YAAM,MAAM,KAAK,iBAAiB,SAAS;AAE3C,YAAM,KAAK,OAAO,IAAI,KAAK,MAAM;AAAA,IAClC;AAEA,WAAO;AAAA,EACR;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA,MAAa,UAAU,UAAkB,SAAoC;AAC5E,UAAM,YAAY,MAAM,KAAK,MAAM,OAAO;AAG1C,UAAM,MAAM,iBAAAC,QAAK,QAAQ,QAAQ;AACjC,UAAM,eAAAC,QAAG,SAAS,MAAM,KAAK,EAAE,WAAW,KAAK,CAAC;AAEhD,UAAM,eAAAA,QAAG,SAAS,UAAU,UAAU,SAAS;AAAA,EAChD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA,MAAa,UAAU,UAAkB,SAAoC;AAC5E,UAAM,YAAY,MAAM,KAAK,MAAM,OAAO;AAG1C,UAAM,MAAM,iBAAAD,QAAK,QAAQ,QAAQ;AACjC,UAAM,eAAAC,QAAG,SAAS,MAAM,KAAK,EAAE,WAAW,KAAK,CAAC;AAEhD,UAAM,eAAAA,QAAG,SAAS,UAAU,UAAU,WAAW,MAAM;AAAA,EACxD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,OAAc,gBACb,YACA,OACA,QACS;AACT,eAAO,cAAAR,iBAAsB,YAAY,OAAO,MAAM;AAAA,EACvD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOO,iBAAiB,WAA2B;AAClD,UAAM,YAAY;AAAA,MACjB,MAAM,KAAK;AAAA,MACX,MAAM,KAAK;AAAA,MACX,QAAQ,KAAK;AAAA,MACb,MAAM,KAAK,SAAS;AAAA,MACpB,eAAe,KAAK;AAAA,MACpB,iBAAiB,KAAK;AAAA,MACtB,iBAAiB,KAAK;AAAA,MACtB;AAAA,IACD;AAEA,UAAM,QAAQ,KAAK,UAAU,IAAI,2BAAU;AAE3C,WAAO,MAAM,KAAK,SAAS;AAAA,EAC5B;AAAA;AAAA;AAAA;AAAA;AAAA,EAMO,eAAwB;AAC9B,WAAO,OAAO,KAAK,UAAU;AAAA,EAC9B;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAa,eAAe,UAAoC;AAC/D,QAAI;AACH,YAAM,eAAAQ,QAAG,SAAS,OAAO,UAAU,eAAAA,QAAG,UAAU,IAAI;AACpD,aAAO;AAAA,IACR,SAAS,QAAQ;AAChB,aAAO;AAAA,IACR;AAAA,EACD;AACD;","names":["QrBitEvents","nativeConvertSvgToPng","nativeGenerateQr","nativeGenerateQrPng","nativeGenerateQrPngWithBuffer","nativeGenerateQrSvg","nativeGenerateQrSvgWithBuffer","QRCode","path","fs"]}

package/dist/qrbit.d.cts

@@ -0,0 +1,237 @@
+import { Buffer } from 'node:buffer';
+import { Cacheable } from 'cacheable';
+import { HookifiedOptions, Hookified } from 'hookified';
+
+declare enum QrBitEvents {
+    warn = "warn",
+    info = "info",
+    error = "error"
+}
+type QrOptions = {
+    /**
+     * The text content to encode in the QR code. It can be text or a url.
+     * @type {string}
+     */
+    text: string;
+    /**
+     * The size of the QR code in pixels.
+     * @type {number}
+     * @default 200
+     */
+    size?: number;
+    /**
+     * The margin around the QR code in pixels.
+     * @type {number}
+     */
+    margin?: number;
+    /**
+     * The logo to embed in the QR code.
+     * @type {string | Buffer}
+     */
+    logo?: string | Buffer;
+    /**
+     * The logo size ratio relative to QR code size.
+     * @type {number}
+     * @default 0.2
+     */
+    logoSizeRatio?: number;
+    /**
+     * The background color of the QR code.
+     * @type {string}
+     * @default "#FFFFFF"
+     */
+    backgroundColor?: string;
+    /**
+     * The foreground color of the QR code.
+     * @type {string}
+     * @default "#000000"
+     */
+    foregroundColor?: string;
+    /**
+     * Caching is enabled by default. You can disable it by setting this option to false. You can also pass
+     * a custom Cacheable instance.
+     * @type {Cacheable | boolean}
+     * @default true
+     */
+    cache?: Cacheable | boolean;
+} & HookifiedOptions;
+interface QrResult {
+    svg?: string;
+    png?: Buffer;
+    width: number;
+    height: number;
+}
+type toOptions = {
+    cache?: boolean;
+};
+/**
+ * QR code generator with logo support and caching capabilities.
+ * Supports both file path and buffer-based logos with automatic optimization.
+ */
+declare class QrBit extends Hookified {
+    private _text;
+    private _size;
+    private _margin;
+    private _logo;
+    private _logoSizeRatio;
+    private _backgroundColor;
+    private _foregroundColor;
+    private _cache;
+    private _napi;
+    /**
+     * Create a new QrBit instance.
+     * @param options - Configuration options for the QR code
+     */
+    constructor(options: QrOptions);
+    /**
+     * Get the text content for the QR code.
+     * @returns {string} The text content
+     */
+    get text(): string;
+    /**
+     * Set the text content for the QR code.
+     * @param value - The text content to encode
+     */
+    set text(value: string);
+    /**
+     * Get the size of the QR code in pixels.
+     * @returns {number} The size in pixels
+     * @default 200
+     */
+    get size(): number;
+    /**
+     * Set the size of the QR code in pixels.
+     * @param value - The size in pixels
+     */
+    set size(value: number);
+    /**
+     * Get the margin around the QR code in pixels.
+     * @returns {number | undefined} The margin in pixels
+     */
+    get margin(): number | undefined;
+    /**
+     * Set the margin around the QR code in pixels.
+     * @param value - The margin in pixels
+     */
+    set margin(value: number | undefined);
+    /**
+     * Get the logo path or buffer.
+     * @returns {string | Buffer | undefined} The logo path, buffer, or undefined if no logo
+     * @default undefined
+     */
+    get logo(): string | Buffer | undefined;
+    /**
+     * Set the logo as a file path or buffer.
+     * @param value - The logo file path, buffer, or undefined to remove logo
+     */
+    set logo(value: string | Buffer | undefined);
+    /**
+     * Get the logo size ratio relative to QR code size.
+     * @returns {number} The logo size ratio
+     * @default 0.2
+     */
+    get logoSizeRatio(): number;
+    /**
+     * Set the logo size ratio relative to QR code size.
+     * @param value - The logo size ratio (0.0 to 1.0)
+     */
+    set logoSizeRatio(value: number);
+    /**
+     * Get the background color of the QR code.
+     * @returns {string} The background color in hex format
+     * @default "#FFFFFF"
+     */
+    get backgroundColor(): string;
+    /**
+     * Set the background color of the QR code.
+     * @param value - The background color in hex format (e.g., "#FFFFFF")
+     */
+    set backgroundColor(value: string);
+    /**
+     * Get the foreground color of the QR code.
+     * @returns {string} The foreground color in hex format
+     * @default "#000000"
+     */
+    get foregroundColor(): string;
+    /**
+     * Set the foreground color of the QR code.
+     * @param value - The foreground color in hex format (e.g., "#000000")
+     */
+    set foregroundColor(value: string);
+    /**
+     * Get the cache instance.
+     * @returns {Cacheable | undefined} The cache instance or undefined if caching is disabled
+     */
+    get cache(): Cacheable | undefined;
+    /**
+     * Set the cache instance.
+     * @param value - The cache instance or undefined to disable caching
+     */
+    set cache(value: Cacheable | undefined);
+    /**
+     * Generate SVG QR code with optional caching.
+     * Uses QRCode library for simple cases, Rust implementation for logos.
+     * @param {toOptions} options - Generation options whether to use caching (default: true)
+     * @returns {Promise<string>} The SVG string
+     */
+    toSvg(options?: toOptions): Promise<string>;
+    /**
+     * Generate SVG QR code using the native Rust implementation.
+     * Automatically chooses between file path and buffer functions.
+     * @returns {Promise<string>} The SVG string
+     */
+    toSvgNapi(): Promise<string>;
+    /**
+     * Generate PNG QR code with optional caching.
+     * Generates the QR as Svg either in rust if it has a logo or native. Then does a conversion on it.
+     * @param options - Generation options
+     * @param options.cache - Whether to use caching (default: true)
+     * @returns {Promise<Buffer>} The PNG buffer
+     */
+    toPng(options?: toOptions): Promise<Buffer>;
+    /**
+     * Generate PNG QR code and save it to a file.
+     * Creates directories if they don't exist.
+     * @param filePath - The file path where to save the PNG
+     * @param options - Generation options
+     * @param options.cache - Whether to use caching (default: true)
+     * @returns {Promise<void>} Resolves when file is written
+     */
+    toPngFile(filePath: string, options?: toOptions): Promise<void>;
+    /**
+     * Generate SVG QR code and save it to a file.
+     * Creates directories if they don't exist.
+     * @param filePath - The file path where to save the SVG
+     * @param options - Generation options
+     * @param options.cache - Whether to use caching (default: true)
+     * @returns {Promise<void>} Resolves when file is written
+     */
+    toSvgFile(filePath: string, options?: toOptions): Promise<void>;
+    /**
+     * Convert SVG content to PNG buffer using the native Rust implementation.
+     * @param svgContent - The SVG content as a string
+     * @param width - Optional width for the PNG output
+     * @param height - Optional height for the PNG output
+     * @returns {Buffer} The PNG buffer
+     */
+    static convertSvgToPng(svgContent: string, width?: number, height?: number): Buffer;
+    /**
+     * Generate a cache key based on the current QR code options.
+     * @param {string} renderKey the format that you are rendering in such as `napi-png`, `native-svg`, `napi-svg`
+     * @returns {string} The cache key
+     */
+    generateCacheKey(renderKey: string): string;
+    /**
+     * Check if the logo is a string (file path).
+     * @returns {boolean} True if logo is a string, false otherwise
+     */
+    isLogoString(): boolean;
+    /**
+     * Check if a logo file exists at the specified path.
+     * @param filePath - The file path to check
+     * @returns {Promise<boolean>} True if file exists, false otherwise
+     */
+    logoFileExists(filePath: string): Promise<boolean>;
+}
+
+export { QrBit, QrBitEvents, type QrOptions, type QrResult, type toOptions };