tiny-essentials 1.28.19 → 1.29.1

package/dist/v1/libs/tools/TinySiteMapStream.cjs

@@ -0,0 +1,121 @@
+'use strict';
+
+var node_stream = require('node:stream');
+var TinySiteMap = require('./TinySiteMap.cjs');
+
+/**
+ * @typedef {import('./TinySiteMap.mjs').SitemapEntry} SitemapEntry
+ * @typedef {import('./TinySiteMap.mjs').SitemapIndexEntry} SitemapIndexEntry
+ * @typedef {import('./TinySiteMap.mjs').SitemapNamespace} SitemapNamespace
+ */
+
+/**
+ * @typedef {Object} TinySiteMapStreamOptions
+ * @property {'silent'|'warn'|'error'} [level] - Error handling level. Defaults to 'warn'.
+ * @property {import('./TinySiteMap.mjs').SitemapNamespace[]} [xmlns] - XML namespaces or attributes to include.
+ */
+
+/**
+ * A Transform stream for generating XML sitemaps incrementally.
+ * @extends Transform
+ */
+class TinySiteMapStream extends node_stream.Transform {
+  /** Indicates whether the XML declaration and header have already been pushed to the stream. @type {boolean} */
+  #hasHeadOutput = false;
+  /** The configuration options applied to the stream. @type {TinySiteMapStreamOptions} */
+  #options;
+  /** The parent TinySiteMap instance used for configuration inheritance. @type {TinySiteMap} */
+  #instance;
+
+  /**
+   * @param {TinySiteMap} instance - An instance of TinySiteMap to inherit configuration.
+   * @param {TinySiteMapStreamOptions} [options] - Stream-specific options.
+   */
+  constructor(instance, options = {}) {
+    super({ objectMode: true });
+
+    this.#instance = instance;
+    this.#options = {
+      level: 'warn',
+      ...options,
+    };
+  }
+
+  /**
+   * Processes a sitemap entry, validates its content, and pushes the resulting XML fragment to the stream.
+   * @param {SitemapEntry | SitemapIndexEntry} entry
+   * @param {string} encoding
+   * @param {import('node:stream').TransformCallback} callback
+   */
+  _transform(entry, encoding, callback) {
+    try {
+      if (!this.#hasHeadOutput) {
+        // Stream sends XML declaration and header
+        this.push('<?xml version="1.0" encoding="UTF-8"?>\n');
+        this.push(
+          TinySiteMap._generateHeader(
+            this.#instance.namespaces,
+            this.#instance.xslUrl ?? undefined,
+            this.#instance.type,
+          ),
+        );
+        this.#hasHeadOutput = true;
+      }
+
+      const validated = TinySiteMap.resolveAndValidate(
+        entry,
+        this.#instance.baseUrl,
+        this.#instance.type,
+        this.#instance.maxResolvedUrlSize,
+        TinySiteMap.xmlNameRegex,
+        this.#instance.urlVerifier,
+      );
+
+      // Use the static method that already handles the logic on each input
+      const xmlFragment = TinySiteMap._generateEntry(
+        validated,
+        this.#instance.type,
+        this.#instance.lastmodDateOnly,
+      );
+
+      this.push(xmlFragment);
+      callback(); // Success
+    } catch (e) {
+      const err = e instanceof Error ? e : new Error(String(e));
+
+      if (this.#options.level === 'error') {
+        // Emit the error properly in the Node.js Stream
+        callback(err);
+      } else {
+        if (this.#options.level === 'warn') {
+          console.warn(`[TinySiteMapStream Warn]: Failed to process entry. Reason: ${err.message}`);
+        }
+        // If 'silent', we ignore the error and the invalid chunk is skipped.
+        callback();
+      }
+    }
+  }
+
+  /**
+   * Finalizes the stream by ensuring the XML footer is appended.
+   * @param {import('node:stream').TransformCallback} cb
+   */
+  _flush(cb) {
+    if (!this.#hasHeadOutput) {
+      this.push('<?xml version="1.0" encoding="UTF-8"?>\n');
+      this.push(
+        TinySiteMap._generateHeader(
+          this.#instance.namespaces,
+          this.#instance.xslUrl ?? undefined,
+          this.#instance.type,
+        ),
+      );
+    }
+
+    // Use static method to footer
+    this.push(TinySiteMap._generateFooter(this.#instance.type));
+    cb();
+  }
+}
+
+module.exports = TinySiteMapStream;

package/dist/v1/libs/tools/TinySiteMapStream.d.mts

@@ -0,0 +1,51 @@
+import { Transform } from 'node:stream';
+import TinySiteMap from './TinySiteMap.mjs';
+export type SitemapEntry = import('./TinySiteMap.mjs').SitemapEntry;
+export type SitemapIndexEntry = import('./TinySiteMap.mjs').SitemapIndexEntry;
+export type SitemapNamespace = import('./TinySiteMap.mjs').SitemapNamespace;
+export type TinySiteMapStreamOptions = {
+    /**
+     * - Error handling level. Defaults to 'warn'.
+     */
+    level?: 'silent' | 'warn' | 'error';
+    /**
+     * - XML namespaces or attributes to include.
+     */
+    xmlns?: import('./TinySiteMap.mjs').SitemapNamespace[];
+};
+/**
+ * @typedef {import('./TinySiteMap.mjs').SitemapEntry} SitemapEntry
+ * @typedef {import('./TinySiteMap.mjs').SitemapIndexEntry} SitemapIndexEntry
+ * @typedef {import('./TinySiteMap.mjs').SitemapNamespace} SitemapNamespace
+ */
+/**
+ * @typedef {Object} TinySiteMapStreamOptions
+ * @property {'silent'|'warn'|'error'} [level] - Error handling level. Defaults to 'warn'.
+ * @property {import('./TinySiteMap.mjs').SitemapNamespace[]} [xmlns] - XML namespaces or attributes to include.
+ */
+/**
+ * A Transform stream for generating XML sitemaps incrementally.
+ * @extends Transform
+ */
+declare class TinySiteMapStream extends Transform {
+    #private;
+    /**
+     * @param {TinySiteMap} instance - An instance of TinySiteMap to inherit configuration.
+     * @param {TinySiteMapStreamOptions} [options] - Stream-specific options.
+     */
+    constructor(instance: TinySiteMap, options?: TinySiteMapStreamOptions);
+    /**
+     * Processes a sitemap entry, validates its content, and pushes the resulting XML fragment to the stream.
+     * @param {SitemapEntry | SitemapIndexEntry} entry
+     * @param {string} encoding
+     * @param {import('node:stream').TransformCallback} callback
+     */
+    _transform(entry: SitemapEntry | SitemapIndexEntry, encoding: string, callback: import('node:stream').TransformCallback): void;
+    /**
+     * Finalizes the stream by ensuring the XML footer is appended.
+     * @param {import('node:stream').TransformCallback} cb
+     */
+    _flush(cb: import('node:stream').TransformCallback): void;
+}
+export default TinySiteMapStream;
+//# sourceMappingURL=TinySiteMapStream.d.mts.map

package/dist/v1/libs/tools/TinySiteMapStream.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"TinySiteMapStream.d.mts","sourceRoot":"","sources":["../../../../src/v1/libs/tools/TinySiteMapStream.mjs"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACxC,OAAO,WAAW,MAAM,mBAAmB,CAAC;AAGzC,YAAoD,YAAY,GAAtD,OAAO,mBAAmB,EAAE,YAAY,CAAc;AAChE,YAAyD,iBAAiB,GAAhE,OAAO,mBAAmB,EAAE,iBAAiB,CAAmB;AAC1E,YAAwD,gBAAgB,GAA9D,OAAO,mBAAmB,EAAE,gBAAgB,CAAkB;AAIxE,YAAkB,wBAAwB,GAC1C;;;;IAAqC,KAAK,AAA1C,CACA,EADW,QAAQ,GAAC,MAAM,GAAC,OAAO,CAClC;;;;IAA4D,KAAK,AAAjE,CACF,EADa,OAAO,mBAAmB,EAAE,gBAAgB,EAAE,CAC3D;CAAA,CAAA;AAVD;;;;GAIG;AAEH;;;;GAIG;AAEH;;;GAGG;AACH,cAAM,iBAAkB,SAAQ,SAAS;;IAQvC;;;OAGG;IACH,YAAY,QAAQ,EAHT,WAGS,EAAE,OAAO,AAF1B,CACF,EADU,wBAEuB,EAQjC;IAED;;;;;OAKG;IACH,UAAU,CAAC,KAAK,EAJL,YAAY,GAAG,iBAIV,EAAE,QAAQ,EAHf,MAGe,EAAE,QAAQ,EAFzB,OAAO,aAAa,EAAE,iBAEG,QA+CnC;IAED;;;OAGG;IACH,MAAM,CAAC,EAAE,EAFE,OAAO,aAAa,EAAE,iBAExB,QAeR;CACF;eAEc,iBAAiB"}

package/dist/v1/libs/tools/TinySiteMapStream.mjs

@@ -0,0 +1,85 @@
+import { Transform } from 'node:stream';
+import TinySiteMap from './TinySiteMap.mjs';
+/**
+ * @typedef {import('./TinySiteMap.mjs').SitemapEntry} SitemapEntry
+ * @typedef {import('./TinySiteMap.mjs').SitemapIndexEntry} SitemapIndexEntry
+ * @typedef {import('./TinySiteMap.mjs').SitemapNamespace} SitemapNamespace
+ */
+/**
+ * @typedef {Object} TinySiteMapStreamOptions
+ * @property {'silent'|'warn'|'error'} [level] - Error handling level. Defaults to 'warn'.
+ * @property {import('./TinySiteMap.mjs').SitemapNamespace[]} [xmlns] - XML namespaces or attributes to include.
+ */
+/**
+ * A Transform stream for generating XML sitemaps incrementally.
+ * @extends Transform
+ */
+class TinySiteMapStream extends Transform {
+    /** Indicates whether the XML declaration and header have already been pushed to the stream. @type {boolean} */
+    #hasHeadOutput = false;
+    /** The configuration options applied to the stream. @type {TinySiteMapStreamOptions} */
+    #options;
+    /** The parent TinySiteMap instance used for configuration inheritance. @type {TinySiteMap} */
+    #instance;
+    /**
+     * @param {TinySiteMap} instance - An instance of TinySiteMap to inherit configuration.
+     * @param {TinySiteMapStreamOptions} [options] - Stream-specific options.
+     */
+    constructor(instance, options = {}) {
+        super({ objectMode: true });
+        this.#instance = instance;
+        this.#options = {
+            level: 'warn',
+            ...options,
+        };
+    }
+    /**
+     * Processes a sitemap entry, validates its content, and pushes the resulting XML fragment to the stream.
+     * @param {SitemapEntry | SitemapIndexEntry} entry
+     * @param {string} encoding
+     * @param {import('node:stream').TransformCallback} callback
+     */
+    _transform(entry, encoding, callback) {
+        try {
+            if (!this.#hasHeadOutput) {
+                // Stream sends XML declaration and header
+                this.push('<?xml version="1.0" encoding="UTF-8"?>\n');
+                this.push(TinySiteMap._generateHeader(this.#instance.namespaces, this.#instance.xslUrl ?? undefined, this.#instance.type));
+                this.#hasHeadOutput = true;
+            }
+            const validated = TinySiteMap.resolveAndValidate(entry, this.#instance.baseUrl, this.#instance.type, this.#instance.maxResolvedUrlSize, TinySiteMap.xmlNameRegex, this.#instance.urlVerifier);
+            // Use the static method that already handles the logic on each input
+            const xmlFragment = TinySiteMap._generateEntry(validated, this.#instance.type, this.#instance.lastmodDateOnly);
+            this.push(xmlFragment);
+            callback(); // Success
+        }
+        catch (e) {
+            const err = e instanceof Error ? e : new Error(String(e));
+            if (this.#options.level === 'error') {
+                // Emit the error properly in the Node.js Stream
+                callback(err);
+            }
+            else {
+                if (this.#options.level === 'warn') {
+                    console.warn(`[TinySiteMapStream Warn]: Failed to process entry. Reason: ${err.message}`);
+                }
+                // If 'silent', we ignore the error and the invalid chunk is skipped.
+                callback();
+            }
+        }
+    }
+    /**
+     * Finalizes the stream by ensuring the XML footer is appended.
+     * @param {import('node:stream').TransformCallback} cb
+     */
+    _flush(cb) {
+        if (!this.#hasHeadOutput) {
+            this.push('<?xml version="1.0" encoding="UTF-8"?>\n');
+            this.push(TinySiteMap._generateHeader(this.#instance.namespaces, this.#instance.xslUrl ?? undefined, this.#instance.type));
+        }
+        // Use static method to footer
+        this.push(TinySiteMap._generateFooter(this.#instance.type));
+        cb();
+    }
+}
+export default TinySiteMapStream;