@hardlydifficult/document-generator 1.0.2 → 1.1.0

package/dist/Document.d.ts

@@ -1,6 +1,30 @@
-import type { Block } from './types.js';
+import type { Block, DocumentOptions, KeyValueOptions, TruncatedListOptions, TimestampOptions } from './types.js';
 export declare class Document {
     private blocks;
+    /**
+     * Create a new Document, optionally with initial content.
+     *
+     * @example
+     * ```typescript
+     * // Empty document
+     * const doc = new Document();
+     *
+     * // Document with initial content
+     * const doc = new Document({
+     *   header: 'Report Title',
+     *   sections: [
+     *     { title: 'Summary', content: 'All systems operational' },
+     *     { content: 'No issues found' },
+     *   ],
+     *   context: { Network: 'mainnet', Status: 'active' },
+     * });
+     * ```
+     */
+    constructor(options?: DocumentOptions);
+    /**
+     * Truncate text to a maximum length with ellipsis.
+     */
+    static truncate(text: string, maxLength: number): string;
     header(text: string): this;
     text(content: string): this;
     list(items: string[]): this;
@@ -9,8 +33,108 @@ export declare class Document {
     link(text: string, url: string): this;
     code(content: string): this;
     image(url: string, alt?: string): this;
+    /**
+     * Add a section with header and divider.
+     *
+     * @example
+     * ```typescript
+     * doc.section('Customer Details').text('Name: Alice');
+     * ```
+     */
+    section(title: string): this;
+    /**
+     * Add key-value pairs formatted as **Key:** value.
+     *
+     * @example
+     * ```typescript
+     * doc.keyValue({ Network: 'mainnet', Status: 'active' });
+     * // Output: **Network:** mainnet\n**Status:** active
+     *
+     * doc.keyValue({ Name: 'Alice', Role: 'Admin' }, { style: 'bullet' });
+     * // Output: • **Name:** Alice\n• **Role:** Admin
+     * ```
+     */
+    keyValue(data: Record<string, string | number | boolean | undefined>, options?: KeyValueOptions): this;
+    /**
+     * Add a list with automatic truncation and "X more" message.
+     *
+     * @example
+     * ```typescript
+     * doc.truncatedList(['a', 'b', 'c', 'd', 'e', 'f'], { limit: 3 });
+     * // Output:
+     * // • a
+     * // • b
+     * // • c
+     * // _... and 3 more_
+     * ```
+     */
+    truncatedList<T>(items: T[], options?: TruncatedListOptions<T>): this;
+    /**
+     * Add a timestamp in context format.
+     *
+     * @example
+     * ```typescript
+     * doc.timestamp(); // 🕐 2024-02-04T12:00:00.000Z
+     * doc.timestamp({ emoji: false }); // 2024-02-04T12:00:00.000Z
+     * doc.timestamp({ prefix: 'Generated' }); // Generated 2024-02-04T...
+     * ```
+     */
+    timestamp(options?: TimestampOptions): this;
+    /**
+     * Conditionally add content to the document.
+     *
+     * @example
+     * ```typescript
+     * doc.if(hasErrors, d => d.section('Errors').list(errors));
+     * ```
+     */
+    if(condition: boolean, callback: (doc: this) => void): this;
+    /**
+     * Add content only if the array is not empty.
+     *
+     * @example
+     * ```typescript
+     * doc.ifNotEmpty(warnings, (d, items) => d.section('Warnings').list(items));
+     * ```
+     */
+    ifNotEmpty<T>(items: T[], callback: (doc: this, items: T[]) => void): this;
+    /**
+     * Iterate over items and add content for each.
+     *
+     * @example
+     * ```typescript
+     * doc.forEach(users, (d, user, i) => d.text(`${i + 1}. ${user.name}`));
+     * ```
+     */
+    forEach<T>(items: T[], callback: (doc: this, item: T, index: number) => void): this;
+    /**
+     * Check if the document has no content.
+     */
+    isEmpty(): boolean;
+    /**
+     * Create a shallow copy of the document.
+     */
+    clone(): Document;
+    /**
+     * Get the raw blocks array.
+     */
     getBlocks(): Block[];
+    /**
+     * Convert document to markdown string.
+     */
     toMarkdown(): string;
+    /**
+     * Convert document to plain text string.
+     */
     toPlainText(): string;
 }
+/**
+ * Factory function to create a new Document.
+ *
+ * @example
+ * ```typescript
+ * const message = doc().header('Title').text('Content');
+ * ```
+ */
+export declare function doc(options?: DocumentOptions): Document;
 //# sourceMappingURL=Document.d.ts.map

package/dist/Document.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Document.d.ts","sourceRoot":"","sources":["../src/Document.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,KAAK,EASN,MAAM,YAAY,CAAC;AAIpB,qBAAa,QAAQ;IACnB,OAAO,CAAC,MAAM,CAAe;IAE7B,MAAM,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IAS1B,IAAI,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI;IAS3B,IAAI,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,IAAI;IAS3B,OAAO,IAAI,IAAI;IAQf,OAAO,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IAS3B,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,IAAI;IAUrC,IAAI,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI;IAW3B,KAAK,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI;IAUtC,SAAS,IAAI,KAAK,EAAE;IAIpB,UAAU,IAAI,MAAM;IAIpB,WAAW,IAAI,MAAM;CAGtB"}
+{"version":3,"file":"Document.d.ts","sourceRoot":"","sources":["../src/Document.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,KAAK,EASL,eAAe,EACf,eAAe,EACf,oBAAoB,EACpB,gBAAgB,EACjB,MAAM,YAAY,CAAC;AAIpB,qBAAa,QAAQ;IACnB,OAAO,CAAC,MAAM,CAAe;IAE7B;;;;;;;;;;;;;;;;;;OAkBG;gBACS,OAAO,CAAC,EAAE,eAAe;IAoBrC;;OAEG;IACH,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,MAAM;IASxD,MAAM,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IAS1B,IAAI,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI;IAS3B,IAAI,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,IAAI;IAS3B,OAAO,IAAI,IAAI;IAQf,OAAO,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IAS3B,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,IAAI;IAUrC,IAAI,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI;IAW3B,KAAK,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI;IActC;;;;;;;OAOG;IACH,OAAO,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAI5B;;;;;;;;;;;OAWG;IACH,QAAQ,CACN,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,SAAS,CAAC,EAC3D,OAAO,GAAE,eAAoB,GAC5B,IAAI;IAgBP;;;;;;;;;;;;OAYG;IACH,aAAa,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,EAAE,OAAO,GAAE,oBAAoB,CAAC,CAAC,CAAM,GAAG,IAAI;IAyBzE;;;;;;;;;OASG;IACH,SAAS,CAAC,OAAO,GAAE,gBAAqB,GAAG,IAAI;IAe/C;;;;;;;OAOG;IACH,EAAE,CAAC,SAAS,EAAE,OAAO,EAAE,QAAQ,EAAE,CAAC,GAAG,EAAE,IAAI,KAAK,IAAI,GAAG,IAAI;IAO3D;;;;;;;OAOG;IACH,UAAU,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,EAAE,QAAQ,EAAE,CAAC,GAAG,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,IAAI,GAAG,IAAI;IAO1E;;;;;;;OAOG;IACH,OAAO,CAAC,CAAC,EACP,KAAK,EAAE,CAAC,EAAE,EACV,QAAQ,EAAE,CAAC,GAAG,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,EAAE,KAAK,EAAE,MAAM,KAAK,IAAI,GACpD,IAAI;IASP;;OAEG;IACH,OAAO,IAAI,OAAO;IAIlB;;OAEG;IACH,KAAK,IAAI,QAAQ;IAMjB;;OAEG;IACH,SAAS,IAAI,KAAK,EAAE;IAIpB;;OAEG;IACH,UAAU,IAAI,MAAM;IAIpB;;OAEG;IACH,WAAW,IAAI,MAAM;CAGtB;AAED;;;;;;;GAOG;AACH,wBAAgB,GAAG,CAAC,OAAO,CAAC,EAAE,eAAe,GAAG,QAAQ,CAEvD"}

package/dist/Document.js

@@ -1,10 +1,60 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Document = void 0;
+exports.doc = doc;
 const markdown_js_1 = require("./outputters/markdown.js");
 const plainText_js_1 = require("./outputters/plainText.js");
 class Document {
     blocks = [];
+    /**
+     * Create a new Document, optionally with initial content.
+     *
+     * @example
+     * ```typescript
+     * // Empty document
+     * const doc = new Document();
+     *
+     * // Document with initial content
+     * const doc = new Document({
+     *   header: 'Report Title',
+     *   sections: [
+     *     { title: 'Summary', content: 'All systems operational' },
+     *     { content: 'No issues found' },
+     *   ],
+     *   context: { Network: 'mainnet', Status: 'active' },
+     * });
+     * ```
+     */
+    constructor(options) {
+        if (options) {
+            if (options.header) {
+                this.header(options.header);
+            }
+            if (options.sections) {
+                for (const section of options.sections) {
+                    if (section.title) {
+                        this.section(section.title);
+                    }
+                    this.text(section.content);
+                }
+            }
+            if (options.context) {
+                this.divider();
+                this.keyValue(options.context);
+            }
+        }
+    }
+    /**
+     * Truncate text to a maximum length with ellipsis.
+     */
+    static truncate(text, maxLength) {
+        if (text.length <= maxLength)
+            return text;
+        return `${text.slice(0, maxLength - 3)}...`;
+    }
+    // ─────────────────────────────────────────────────────────────────────────────
+    // Core block methods
+    // ─────────────────────────────────────────────────────────────────────────────
     header(text) {
         const block = {
             type: 'header',
@@ -72,15 +122,181 @@ class Document {
         this.blocks.push(block);
         return this;
     }
+    // ─────────────────────────────────────────────────────────────────────────────
+    // Convenience methods
+    // ─────────────────────────────────────────────────────────────────────────────
+    /**
+     * Add a section with header and divider.
+     *
+     * @example
+     * ```typescript
+     * doc.section('Customer Details').text('Name: Alice');
+     * ```
+     */
+    section(title) {
+        return this.header(title).divider();
+    }
+    /**
+     * Add key-value pairs formatted as **Key:** value.
+     *
+     * @example
+     * ```typescript
+     * doc.keyValue({ Network: 'mainnet', Status: 'active' });
+     * // Output: **Network:** mainnet\n**Status:** active
+     *
+     * doc.keyValue({ Name: 'Alice', Role: 'Admin' }, { style: 'bullet' });
+     * // Output: • **Name:** Alice\n• **Role:** Admin
+     * ```
+     */
+    keyValue(data, options = {}) {
+        const { style = 'plain', separator = ':', bold = true } = options;
+        const entries = Object.entries(data).filter(([, v]) => v !== undefined);
+        if (entries.length === 0)
+            return this;
+        const lines = entries.map(([key, value], i) => {
+            const formattedKey = bold ? `**${key}**` : key;
+            const prefix = style === 'bullet' ? '• ' : style === 'numbered' ? `${i + 1}. ` : '';
+            return `${prefix}${formattedKey}${separator} ${value}`;
+        });
+        return this.text(lines.join('\n'));
+    }
+    /**
+     * Add a list with automatic truncation and "X more" message.
+     *
+     * @example
+     * ```typescript
+     * doc.truncatedList(['a', 'b', 'c', 'd', 'e', 'f'], { limit: 3 });
+     * // Output:
+     * // • a
+     * // • b
+     * // • c
+     * // _... and 3 more_
+     * ```
+     */
+    truncatedList(items, options = {}) {
+        const { limit = 10, format = (item) => String(item), moreText = (n) => `_... and ${n} more_`, ordered = false, } = options;
+        if (items.length === 0)
+            return this;
+        const visible = items.slice(0, limit);
+        const remaining = items.length - limit;
+        const lines = visible.map((item, i) => {
+            const prefix = ordered ? `${i + 1}. ` : '• ';
+            return `${prefix}${format(item, i)}`;
+        });
+        if (remaining > 0) {
+            lines.push(moreText(remaining));
+        }
+        return this.text(lines.join('\n'));
+    }
+    /**
+     * Add a timestamp in context format.
+     *
+     * @example
+     * ```typescript
+     * doc.timestamp(); // 🕐 2024-02-04T12:00:00.000Z
+     * doc.timestamp({ emoji: false }); // 2024-02-04T12:00:00.000Z
+     * doc.timestamp({ prefix: 'Generated' }); // Generated 2024-02-04T...
+     * ```
+     */
+    timestamp(options = {}) {
+        const { date = new Date(), emoji = true, prefix } = options;
+        const iso = date.toISOString();
+        const text = prefix
+            ? `${prefix} ${iso}`
+            : emoji
+                ? `🕐 ${iso}`
+                : iso;
+        return this.context(text);
+    }
+    // ─────────────────────────────────────────────────────────────────────────────
+    // Conditional and iteration methods
+    // ─────────────────────────────────────────────────────────────────────────────
+    /**
+     * Conditionally add content to the document.
+     *
+     * @example
+     * ```typescript
+     * doc.if(hasErrors, d => d.section('Errors').list(errors));
+     * ```
+     */
+    if(condition, callback) {
+        if (condition) {
+            callback(this);
+        }
+        return this;
+    }
+    /**
+     * Add content only if the array is not empty.
+     *
+     * @example
+     * ```typescript
+     * doc.ifNotEmpty(warnings, (d, items) => d.section('Warnings').list(items));
+     * ```
+     */
+    ifNotEmpty(items, callback) {
+        if (items.length > 0) {
+            callback(this, items);
+        }
+        return this;
+    }
+    /**
+     * Iterate over items and add content for each.
+     *
+     * @example
+     * ```typescript
+     * doc.forEach(users, (d, user, i) => d.text(`${i + 1}. ${user.name}`));
+     * ```
+     */
+    forEach(items, callback) {
+        items.forEach((item, i) => callback(this, item, i));
+        return this;
+    }
+    // ─────────────────────────────────────────────────────────────────────────────
+    // Utility methods
+    // ─────────────────────────────────────────────────────────────────────────────
+    /**
+     * Check if the document has no content.
+     */
+    isEmpty() {
+        return this.blocks.length === 0;
+    }
+    /**
+     * Create a shallow copy of the document.
+     */
+    clone() {
+        const copy = new Document();
+        copy.blocks = [...this.blocks];
+        return copy;
+    }
+    /**
+     * Get the raw blocks array.
+     */
     getBlocks() {
         return this.blocks;
     }
+    /**
+     * Convert document to markdown string.
+     */
     toMarkdown() {
         return (0, markdown_js_1.toMarkdown)(this.blocks);
     }
+    /**
+     * Convert document to plain text string.
+     */
     toPlainText() {
         return (0, plainText_js_1.toPlainText)(this.blocks);
     }
 }
 exports.Document = Document;
+/**
+ * Factory function to create a new Document.
+ *
+ * @example
+ * ```typescript
+ * const message = doc().header('Title').text('Content');
+ * ```
+ */
+function doc(options) {
+    return new Document(options);
+}
 //# sourceMappingURL=Document.js.map

package/dist/Document.js.map

@@ -1 +1 @@
-{"version":3,"file":"Document.js","sourceRoot":"","sources":["../src/Document.ts"],"names":[],"mappings":";;;AAWA,0DAAwE;AACxE,4DAA2E;AAE3E,MAAa,QAAQ;IACX,MAAM,GAAY,EAAE,CAAC;IAE7B,MAAM,CAAC,IAAY;QACjB,MAAM,KAAK,GAAgB;YACzB,IAAI,EAAE,QAAQ;YACd,IAAI;SACL,CAAC;QACF,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACxB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,IAAI,CAAC,OAAe;QAClB,MAAM,KAAK,GAAc;YACvB,IAAI,EAAE,MAAM;YACZ,OAAO;SACR,CAAC;QACF,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACxB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,IAAI,CAAC,KAAe;QAClB,MAAM,KAAK,GAAc;YACvB,IAAI,EAAE,MAAM;YACZ,KAAK;SACN,CAAC;QACF,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACxB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,OAAO;QACL,MAAM,KAAK,GAAiB;YAC1B,IAAI,EAAE,SAAS;SAChB,CAAC;QACF,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACxB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,OAAO,CAAC,IAAY;QAClB,MAAM,KAAK,GAAiB;YAC1B,IAAI,EAAE,SAAS;YACf,IAAI;SACL,CAAC;QACF,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACxB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,IAAI,CAAC,IAAY,EAAE,GAAW;QAC5B,MAAM,KAAK,GAAc;YACvB,IAAI,EAAE,MAAM;YACZ,IAAI;YACJ,GAAG;SACJ,CAAC;QACF,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACxB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,IAAI,CAAC,OAAe;QAClB,MAAM,SAAS,GAAG,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QACzC,MAAM,KAAK,GAAc;YACvB,IAAI,EAAE,MAAM;YACZ,OAAO;YACP,SAAS;SACV,CAAC;QACF,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACxB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,KAAK,CAAC,GAAW,EAAE,GAAY;QAC7B,MAAM,KAAK,GAAe;YACxB,IAAI,EAAE,OAAO;YACb,GAAG;YACH,GAAG;SACJ,CAAC;QACF,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACxB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,SAAS;QACP,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED,UAAU;QACR,OAAO,IAAA,wBAAc,EAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IACrC,CAAC;IAED,WAAW;QACT,OAAO,IAAA,0BAAe,EAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IACtC,CAAC;CACF;AAzFD,4BAyFC"}
+{"version":3,"file":"Document.js","sourceRoot":"","sources":["../src/Document.ts"],"names":[],"mappings":";;;AAiWA,kBAEC;AApVD,0DAAwE;AACxE,4DAA2E;AAE3E,MAAa,QAAQ;IACX,MAAM,GAAY,EAAE,CAAC;IAE7B;;;;;;;;;;;;;;;;;;OAkBG;IACH,YAAY,OAAyB;QACnC,IAAI,OAAO,EAAE,CAAC;YACZ,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;gBACnB,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;YAC9B,CAAC;YACD,IAAI,OAAO,CAAC,QAAQ,EAAE,CAAC;gBACrB,KAAK,MAAM,OAAO,IAAI,OAAO,CAAC,QAAQ,EAAE,CAAC;oBACvC,IAAI,OAAO,CAAC,KAAK,EAAE,CAAC;wBAClB,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;oBAC9B,CAAC;oBACD,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;gBAC7B,CAAC;YACH,CAAC;YACD,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;gBACpB,IAAI,CAAC,OAAO,EAAE,CAAC;gBACf,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;YACjC,CAAC;QACH,CAAC;IACH,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,QAAQ,CAAC,IAAY,EAAE,SAAiB;QAC7C,IAAI,IAAI,CAAC,MAAM,IAAI,SAAS;YAAE,OAAO,IAAI,CAAC;QAC1C,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,SAAS,GAAG,CAAC,CAAC,KAAK,CAAC;IAC9C,CAAC;IAED,gFAAgF;IAChF,qBAAqB;IACrB,gFAAgF;IAEhF,MAAM,CAAC,IAAY;QACjB,MAAM,KAAK,GAAgB;YACzB,IAAI,EAAE,QAAQ;YACd,IAAI;SACL,CAAC;QACF,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACxB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,IAAI,CAAC,OAAe;QAClB,MAAM,KAAK,GAAc;YACvB,IAAI,EAAE,MAAM;YACZ,OAAO;SACR,CAAC;QACF,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACxB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,IAAI,CAAC,KAAe;QAClB,MAAM,KAAK,GAAc;YACvB,IAAI,EAAE,MAAM;YACZ,KAAK;SACN,CAAC;QACF,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACxB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,OAAO;QACL,MAAM,KAAK,GAAiB;YAC1B,IAAI,EAAE,SAAS;SAChB,CAAC;QACF,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACxB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,OAAO,CAAC,IAAY;QAClB,MAAM,KAAK,GAAiB;YAC1B,IAAI,EAAE,SAAS;YACf,IAAI;SACL,CAAC;QACF,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACxB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,IAAI,CAAC,IAAY,EAAE,GAAW;QAC5B,MAAM,KAAK,GAAc;YACvB,IAAI,EAAE,MAAM;YACZ,IAAI;YACJ,GAAG;SACJ,CAAC;QACF,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACxB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,IAAI,CAAC,OAAe;QAClB,MAAM,SAAS,GAAG,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QACzC,MAAM,KAAK,GAAc;YACvB,IAAI,EAAE,MAAM;YACZ,OAAO;YACP,SAAS;SACV,CAAC;QACF,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACxB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,KAAK,CAAC,GAAW,EAAE,GAAY;QAC7B,MAAM,KAAK,GAAe;YACxB,IAAI,EAAE,OAAO;YACb,GAAG;YACH,GAAG;SACJ,CAAC;QACF,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACxB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,gFAAgF;IAChF,sBAAsB;IACtB,gFAAgF;IAEhF;;;;;;;OAOG;IACH,OAAO,CAAC,KAAa;QACnB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,OAAO,EAAE,CAAC;IACtC,CAAC;IAED;;;;;;;;;;;OAWG;IACH,QAAQ,CACN,IAA2D,EAC3D,UAA2B,EAAE;QAE7B,MAAM,EAAE,KAAK,GAAG,OAAO,EAAE,SAAS,GAAG,GAAG,EAAE,IAAI,GAAG,IAAI,EAAE,GAAG,OAAO,CAAC;QAElE,MAAM,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,SAAS,CAAC,CAAC;QACxE,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC;YAAE,OAAO,IAAI,CAAC;QAEtC,MAAM,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,CAAC,EAAE,EAAE;YAC5C,MAAM,YAAY,GAAG,IAAI,CAAC,CAAC,CAAC,KAAK,GAAG,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC;YAC/C,MAAM,MAAM,GACV,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,KAAK,UAAU,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;YACvE,OAAO,GAAG,MAAM,GAAG,YAAY,GAAG,SAAS,IAAI,KAAK,EAAE,CAAC;QACzD,CAAC,CAAC,CAAC;QAEH,OAAO,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IACrC,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,aAAa,CAAI,KAAU,EAAE,UAAmC,EAAE;QAChE,MAAM,EACJ,KAAK,GAAG,EAAE,EACV,MAAM,GAAG,CAAC,IAAO,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,EAClC,QAAQ,GAAG,CAAC,CAAS,EAAE,EAAE,CAAC,YAAY,CAAC,QAAQ,EAC/C,OAAO,GAAG,KAAK,GAChB,GAAG,OAAO,CAAC;QAEZ,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC;YAAE,OAAO,IAAI,CAAC;QAEpC,MAAM,OAAO,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;QACtC,MAAM,SAAS,GAAG,KAAK,CAAC,MAAM,GAAG,KAAK,CAAC;QAEvC,MAAM,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC,EAAE,EAAE;YACpC,MAAM,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC;YAC7C,OAAO,GAAG,MAAM,GAAG,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC,EAAE,CAAC;QACvC,CAAC,CAAC,CAAC;QAEH,IAAI,SAAS,GAAG,CAAC,EAAE,CAAC;YAClB,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC;QAClC,CAAC;QAED,OAAO,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IACrC,CAAC;IAED;;;;;;;;;OASG;IACH,SAAS,CAAC,UAA4B,EAAE;QACtC,MAAM,EAAE,IAAI,GAAG,IAAI,IAAI,EAAE,EAAE,KAAK,GAAG,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC;QAC5D,MAAM,GAAG,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC;QAC/B,MAAM,IAAI,GAAG,MAAM;YACjB,CAAC,CAAC,GAAG,MAAM,IAAI,GAAG,EAAE;YACpB,CAAC,CAAC,KAAK;gBACL,CAAC,CAAC,MAAM,GAAG,EAAE;gBACb,CAAC,CAAC,GAAG,CAAC;QACV,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IAC5B,CAAC;IAED,gFAAgF;IAChF,oCAAoC;IACpC,gFAAgF;IAEhF;;;;;;;OAOG;IACH,EAAE,CAAC,SAAkB,EAAE,QAA6B;QAClD,IAAI,SAAS,EAAE,CAAC;YACd,QAAQ,CAAC,IAAI,CAAC,CAAC;QACjB,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;OAOG;IACH,UAAU,CAAI,KAAU,EAAE,QAAyC;QACjE,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACrB,QAAQ,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;QACxB,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;OAOG;IACH,OAAO,CACL,KAAU,EACV,QAAqD;QAErD,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,CAAC,EAAE,EAAE,CAAC,QAAQ,CAAC,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;QACpD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,gFAAgF;IAChF,kBAAkB;IAClB,gFAAgF;IAEhF;;OAEG;IACH,OAAO;QACL,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,KAAK,CAAC,CAAC;IAClC,CAAC;IAED;;OAEG;IACH,KAAK;QACH,MAAM,IAAI,GAAG,IAAI,QAAQ,EAAE,CAAC;QAC5B,IAAI,CAAC,MAAM,GAAG,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC;QAC/B,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACH,SAAS;QACP,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED;;OAEG;IACH,UAAU;QACR,OAAO,IAAA,wBAAc,EAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IACrC,CAAC;IAED;;OAEG;IACH,WAAW;QACT,OAAO,IAAA,0BAAe,EAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IACtC,CAAC;CACF;AArUD,4BAqUC;AAED;;;;;;;GAOG;AACH,SAAgB,GAAG,CAAC,OAAyB;IAC3C,OAAO,IAAI,QAAQ,CAAC,OAAO,CAAC,CAAC;AAC/B,CAAC"}

package/dist/index.d.ts

@@ -1,5 +1,5 @@
-export { Document } from './Document.js';
-export type { Block, HeaderBlock, TextBlock, ListBlock, DividerBlock, ContextBlock, LinkBlock, CodeBlock, ImageBlock, Platform, } from './types.js';
+export { Document, doc } from './Document.js';
+export type { Block, HeaderBlock, TextBlock, ListBlock, DividerBlock, ContextBlock, LinkBlock, CodeBlock, ImageBlock, Platform, DocumentOptions, DocumentSection, KeyValueOptions, TruncatedListOptions, TimestampOptions, } from './types.js';
 export { toMarkdown } from './outputters/markdown.js';
 export { toPlainText } from './outputters/plainText.js';
 export { convertMarkdown, stripMarkdown } from './markdownConverter.js';

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAGzC,YAAY,EACV,KAAK,EACL,WAAW,EACX,SAAS,EACT,SAAS,EACT,YAAY,EACZ,YAAY,EACZ,SAAS,EACT,SAAS,EACT,UAAU,EACV,QAAQ,GACT,MAAM,YAAY,CAAC;AAGpB,OAAO,EAAE,UAAU,EAAE,MAAM,0BAA0B,CAAC;AACtD,OAAO,EAAE,WAAW,EAAE,MAAM,2BAA2B,CAAC;AAGxD,OAAO,EAAE,eAAe,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,QAAQ,EAAE,GAAG,EAAE,MAAM,eAAe,CAAC;AAG9C,YAAY,EACV,KAAK,EACL,WAAW,EACX,SAAS,EACT,SAAS,EACT,YAAY,EACZ,YAAY,EACZ,SAAS,EACT,SAAS,EACT,UAAU,EACV,QAAQ,EAER,eAAe,EACf,eAAe,EACf,eAAe,EACf,oBAAoB,EACpB,gBAAgB,GACjB,MAAM,YAAY,CAAC;AAGpB,OAAO,EAAE,UAAU,EAAE,MAAM,0BAA0B,CAAC;AACtD,OAAO,EAAE,WAAW,EAAE,MAAM,2BAA2B,CAAC;AAGxD,OAAO,EAAE,eAAe,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC"}

package/dist/index.js

@@ -1,9 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.stripMarkdown = exports.convertMarkdown = exports.toPlainText = exports.toMarkdown = exports.Document = void 0;
-// Main class
+exports.stripMarkdown = exports.convertMarkdown = exports.toPlainText = exports.toMarkdown = exports.doc = exports.Document = void 0;
+// Main class and factory
 var Document_js_1 = require("./Document.js");
 Object.defineProperty(exports, "Document", { enumerable: true, get: function () { return Document_js_1.Document; } });
+Object.defineProperty(exports, "doc", { enumerable: true, get: function () { return Document_js_1.doc; } });
 // Outputters (for direct use)
 var markdown_js_1 = require("./outputters/markdown.js");
 Object.defineProperty(exports, "toMarkdown", { enumerable: true, get: function () { return markdown_js_1.toMarkdown; } });

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,aAAa;AACb,6CAAyC;AAAhC,uGAAA,QAAQ,OAAA;AAgBjB,8BAA8B;AAC9B,wDAAsD;AAA7C,yGAAA,UAAU,OAAA;AACnB,0DAAwD;AAA/C,2GAAA,WAAW,OAAA;AAEpB,6CAA6C;AAC7C,+DAAwE;AAA/D,uHAAA,eAAe,OAAA;AAAE,qHAAA,aAAa,OAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,yBAAyB;AACzB,6CAA8C;AAArC,uGAAA,QAAQ,OAAA;AAAE,kGAAA,GAAG,OAAA;AAsBtB,8BAA8B;AAC9B,wDAAsD;AAA7C,yGAAA,UAAU,OAAA;AACnB,0DAAwD;AAA/C,2GAAA,WAAW,OAAA;AAEpB,6CAA6C;AAC7C,+DAAwE;AAA/D,uHAAA,eAAe,OAAA;AAAE,qHAAA,aAAa,OAAA"}

package/dist/types.d.ts

@@ -34,4 +34,39 @@ export interface ImageBlock {
     url: string;
     alt?: string;
 }
+export interface DocumentSection {
+    title?: string;
+    content: string;
+}
+export interface DocumentOptions {
+    header?: string;
+    sections?: DocumentSection[];
+    context?: Record<string, string | number | boolean | undefined>;
+}
+export interface KeyValueOptions {
+    /** List style: plain (default), bullet, or numbered */
+    style?: 'plain' | 'bullet' | 'numbered';
+    /** Separator between key and value. Default: ':' */
+    separator?: string;
+    /** Whether to bold keys. Default: true */
+    bold?: boolean;
+}
+export interface TruncatedListOptions<T = string> {
+    /** Maximum items to show. Default: 10 */
+    limit?: number;
+    /** Custom formatter for each item. Default: String(item) */
+    format?: (item: T, index: number) => string;
+    /** Custom "more" text. Default: "_... and N more_" */
+    moreText?: (remaining: number) => string;
+    /** Use numbered list instead of bullets. Default: false */
+    ordered?: boolean;
+}
+export interface TimestampOptions {
+    /** Custom date to use. Default: new Date() */
+    date?: Date;
+    /** Include clock emoji. Default: true */
+    emoji?: boolean;
+    /** Custom prefix text */
+    prefix?: string;
+}
 //# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,QAAQ,GAAG,UAAU,GAAG,OAAO,GAAG,SAAS,GAAG,WAAW,CAAC;AAEtE,MAAM,MAAM,KAAK,GACb,WAAW,GACX,SAAS,GACT,SAAS,GACT,YAAY,GACZ,YAAY,GACZ,SAAS,GACT,SAAS,GACT,UAAU,CAAC;AAEf,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,QAAQ,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,SAAS;IACxB,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,SAAS;IACxB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,EAAE,CAAC;CACjB;AAED,MAAM,WAAW,YAAY;IAC3B,IAAI,EAAE,SAAS,CAAC;CACjB;AAED,MAAM,WAAW,YAAY;IAC3B,IAAI,EAAE,SAAS,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,SAAS;IACxB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,SAAS;IACxB,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,OAAO,CAAC;CACpB;AAED,MAAM,WAAW,UAAU;IACzB,IAAI,EAAE,OAAO,CAAC;IACd,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,CAAC,EAAE,MAAM,CAAC;CACd"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,QAAQ,GAAG,UAAU,GAAG,OAAO,GAAG,SAAS,GAAG,WAAW,CAAC;AAEtE,MAAM,MAAM,KAAK,GACb,WAAW,GACX,SAAS,GACT,SAAS,GACT,YAAY,GACZ,YAAY,GACZ,SAAS,GACT,SAAS,GACT,UAAU,CAAC;AAEf,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,QAAQ,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,SAAS;IACxB,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,SAAS;IACxB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,EAAE,CAAC;CACjB;AAED,MAAM,WAAW,YAAY;IAC3B,IAAI,EAAE,SAAS,CAAC;CACjB;AAED,MAAM,WAAW,YAAY;IAC3B,IAAI,EAAE,SAAS,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,SAAS;IACxB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,SAAS;IACxB,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,OAAO,CAAC;CACpB;AAED,MAAM,WAAW,UAAU;IACzB,IAAI,EAAE,OAAO,CAAC;IACd,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAGD,MAAM,WAAW,eAAe;IAC9B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,eAAe;IAC9B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,eAAe,EAAE,CAAC;IAC7B,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,SAAS,CAAC,CAAC;CACjE;AAGD,MAAM,WAAW,eAAe;IAC9B,uDAAuD;IACvD,KAAK,CAAC,EAAE,OAAO,GAAG,QAAQ,GAAG,UAAU,CAAC;IACxC,oDAAoD;IACpD,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,0CAA0C;IAC1C,IAAI,CAAC,EAAE,OAAO,CAAC;CAChB;AAGD,MAAM,WAAW,oBAAoB,CAAC,CAAC,GAAG,MAAM;IAC9C,yCAAyC;IACzC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,4DAA4D;IAC5D,MAAM,CAAC,EAAE,CAAC,IAAI,EAAE,CAAC,EAAE,KAAK,EAAE,MAAM,KAAK,MAAM,CAAC;IAC5C,sDAAsD;IACtD,QAAQ,CAAC,EAAE,CAAC,SAAS,EAAE,MAAM,KAAK,MAAM,CAAC;IACzC,2DAA2D;IAC3D,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAGD,MAAM,WAAW,gBAAgB;IAC/B,8CAA8C;IAC9C,IAAI,CAAC,EAAE,IAAI,CAAC;IACZ,yCAAyC;IACzC,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,yBAAyB;IACzB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hardlydifficult/document-generator",
-  "version": "1.0.2",
+  "version": "1.1.0",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "files": [