@gravito/constellation 3.0.2 → 3.1.1

package/dist/chunk-3IZTXYU7.js

@@ -0,0 +1,166 @@
+// src/storage/DiskSitemapStorage.ts
+import { createReadStream, createWriteStream } from "fs";
+import fs from "fs/promises";
+import path from "path";
+import { Readable as Readable2 } from "stream";
+import { pipeline } from "stream/promises";
+
+// src/utils/Compression.ts
+import { Readable } from "stream";
+import { createGzip } from "zlib";
+async function compressToBuffer(source, config) {
+  const level = config?.level ?? 6;
+  if (level < 1 || level > 9) {
+    throw new Error(`Invalid compression level: ${level}. Must be between 1 and 9.`);
+  }
+  const chunks = [];
+  const gzip = createGzip({ level });
+  const readable = Readable.from(source, { encoding: "utf-8" });
+  try {
+    readable.pipe(gzip);
+    for await (const chunk of gzip) {
+      chunks.push(chunk);
+    }
+    return Buffer.concat(chunks);
+  } catch (error) {
+    readable.destroy();
+    gzip.destroy();
+    throw error;
+  }
+}
+function createCompressionStream(config) {
+  const level = config?.level ?? 6;
+  if (level < 1 || level > 9) {
+    throw new Error(`Invalid compression level: ${level}. Must be between 1 and 9.`);
+  }
+  return createGzip({ level });
+}
+function toGzipFilename(filename) {
+  return filename.endsWith(".gz") ? filename : `${filename}.gz`;
+}
+function fromGzipFilename(filename) {
+  return filename.endsWith(".gz") ? filename.slice(0, -3) : filename;
+}
+
+// src/storage/DiskSitemapStorage.ts
+function sanitizeFilename(filename) {
+  if (!filename) {
+    throw new Error("Invalid sitemap filename.");
+  }
+  if (filename.includes("\0")) {
+    throw new Error("Invalid sitemap filename.");
+  }
+  if (filename.includes("/") || filename.includes("\\")) {
+    throw new Error("Invalid sitemap filename.");
+  }
+  if (filename.includes("..")) {
+    throw new Error("Invalid sitemap filename.");
+  }
+  return filename;
+}
+var DiskSitemapStorage = class {
+  constructor(outDir, baseUrl) {
+    this.outDir = outDir;
+    this.baseUrl = baseUrl;
+  }
+  /**
+   * Writes sitemap content to a file on the local disk.
+   *
+   * @param filename - The name of the file to write.
+   * @param content - The XML or JSON content.
+   */
+  async write(filename, content) {
+    const safeName = sanitizeFilename(filename);
+    await fs.mkdir(this.outDir, { recursive: true });
+    await fs.writeFile(path.join(this.outDir, safeName), content);
+  }
+  /**
+   * 使用串流方式寫入 sitemap 檔案，可選擇性啟用 gzip 壓縮。
+   * 此方法可大幅降低大型 sitemap 的記憶體峰值。
+   *
+   * @param filename - 檔案名稱
+   * @param stream - XML 內容的 AsyncIterable
+   * @param options - 寫入選項（如壓縮、content type）
+   *
+   * @since 3.1.0
+   */
+  async writeStream(filename, stream, options) {
+    const safeName = sanitizeFilename(options?.compress ? toGzipFilename(filename) : filename);
+    await fs.mkdir(this.outDir, { recursive: true });
+    const filePath = path.join(this.outDir, safeName);
+    const writeStream = createWriteStream(filePath);
+    const readable = Readable2.from(stream, { encoding: "utf-8" });
+    if (options?.compress) {
+      const gzip = createCompressionStream();
+      await pipeline(readable, gzip, writeStream);
+    } else {
+      await pipeline(readable, writeStream);
+    }
+  }
+  /**
+   * Reads sitemap content from a file on the local disk.
+   *
+   * @param filename - The name of the file to read.
+   * @returns A promise resolving to the file content as a string, or null if not found.
+   */
+  async read(filename) {
+    try {
+      const safeName = sanitizeFilename(filename);
+      return await fs.readFile(path.join(this.outDir, safeName), "utf-8");
+    } catch {
+      return null;
+    }
+  }
+  /**
+   * Returns a readable stream for a sitemap file on the local disk.
+   *
+   * @param filename - The name of the file to stream.
+   * @returns A promise resolving to an async iterable of file chunks, or null if not found.
+   */
+  async readStream(filename) {
+    try {
+      const safeName = sanitizeFilename(filename);
+      const fullPath = path.join(this.outDir, safeName);
+      await fs.access(fullPath);
+      const stream = createReadStream(fullPath, { encoding: "utf-8" });
+      return stream;
+    } catch {
+      return null;
+    }
+  }
+  /**
+   * Checks if a sitemap file exists on the local disk.
+   *
+   * @param filename - The name of the file to check.
+   * @returns A promise resolving to true if the file exists, false otherwise.
+   */
+  async exists(filename) {
+    try {
+      const safeName = sanitizeFilename(filename);
+      await fs.access(path.join(this.outDir, safeName));
+      return true;
+    } catch {
+      return false;
+    }
+  }
+  /**
+   * Returns the full public URL for a sitemap file.
+   *
+   * @param filename - The name of the sitemap file.
+   * @returns The public URL as a string.
+   */
+  getUrl(filename) {
+    const safeName = sanitizeFilename(filename);
+    const base = this.baseUrl.endsWith("/") ? this.baseUrl.slice(0, -1) : this.baseUrl;
+    const file = safeName.startsWith("/") ? safeName.slice(1) : safeName;
+    return `${base}/${file}`;
+  }
+};
+
+export {
+  compressToBuffer,
+  createCompressionStream,
+  toGzipFilename,
+  fromGzipFilename,
+  DiskSitemapStorage
+};