@real1ty-obsidian-plugins/utils 2.23.0 → 2.24.0

package/dist/components/index.d.ts

@@ -1,3 +1,4 @@
 export * from "./frontmatter-propagation-modal";
 export * from "./input-managers";
+export * from "./whats-new-modal";
 //# sourceMappingURL=index.d.ts.map

package/dist/components/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/components/index.ts"],"names":[],"mappings":"AAAA,cAAc,iCAAiC,CAAC;AAChD,cAAc,kBAAkB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/components/index.ts"],"names":[],"mappings":"AAAA,cAAc,iCAAiC,CAAC;AAChD,cAAc,kBAAkB,CAAC;AACjC,cAAc,mBAAmB,CAAC"}

package/dist/components/index.js

@@ -1,3 +1,4 @@
 export * from "./frontmatter-propagation-modal";
 export * from "./input-managers";
+export * from "./whats-new-modal";
 //# sourceMappingURL=index.js.map

package/dist/components/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/components/index.ts"],"names":[],"mappings":"AAAA,cAAc,iCAAiC,CAAC;AAChD,cAAc,kBAAkB,CAAC","sourcesContent":["export * from \"./frontmatter-propagation-modal\";\nexport * from \"./input-managers\";\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/components/index.ts"],"names":[],"mappings":"AAAA,cAAc,iCAAiC,CAAC;AAChD,cAAc,kBAAkB,CAAC;AACjC,cAAc,mBAAmB,CAAC","sourcesContent":["export * from \"./frontmatter-propagation-modal\";\nexport * from \"./input-managers\";\nexport * from \"./whats-new-modal\";\n"]}

package/dist/components/whats-new-modal.d.ts

@@ -0,0 +1,57 @@
+import type { App, Plugin } from "obsidian";
+import { Modal } from "obsidian";
+export interface WhatsNewModalConfig {
+    /**
+     * The CSS class prefix/suffix to use for styling.
+     * Example: "custom-calendar" will generate classes like "custom-calendar-whats-new-modal"
+     */
+    cssPrefix: string;
+    /**
+     * Display name of the plugin.
+     * Example: "Custom Calendar"
+     */
+    pluginName: string;
+    /**
+     * Raw changelog markdown content to parse.
+     */
+    changelogContent: string;
+    /**
+     * Links to external resources.
+     */
+    links: {
+        /**
+         * URL to support/donate page.
+         */
+        support?: string;
+        /**
+         * URL to full changelog page.
+         */
+        changelog?: string;
+        /**
+         * URL to documentation.
+         */
+        documentation?: string;
+    };
+}
+/**
+ * Generic "What's New" modal that displays changelog entries between versions.
+ * Supports custom CSS prefixes, plugin names, and configurable links.
+ */
+export declare class WhatsNewModal extends Modal {
+    private plugin;
+    private config;
+    private fromVersion;
+    private toVersion;
+    constructor(app: App, plugin: Plugin, config: WhatsNewModalConfig, fromVersion: string, toVersion: string);
+    /**
+     * Helper to create CSS class names with the configured prefix.
+     */
+    private cls;
+    /**
+     * Helper to add CSS class to an element.
+     */
+    private addCls;
+    onOpen(): Promise<void>;
+    onClose(): void;
+}
+//# sourceMappingURL=whats-new-modal.d.ts.map

package/dist/components/whats-new-modal.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"whats-new-modal.d.ts","sourceRoot":"","sources":["../../src/components/whats-new-modal.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAC5C,OAAO,EAAoB,KAAK,EAAE,MAAM,UAAU,CAAC;AAGnD,MAAM,WAAW,mBAAmB;IACnC;;;OAGG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,KAAK,EAAE;QACN;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;QAEjB;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,aAAa,CAAC,EAAE,MAAM,CAAC;KACvB,CAAC;CACF;AAED;;;GAGG;AACH,qBAAa,aAAc,SAAQ,KAAK;IAGtC,OAAO,CAAC,MAAM;IACd,OAAO,CAAC,MAAM;IACd,OAAO,CAAC,WAAW;IACnB,OAAO,CAAC,SAAS;gBAJjB,GAAG,EAAE,GAAG,EACA,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,mBAAmB,EAC3B,WAAW,EAAE,MAAM,EACnB,SAAS,EAAE,MAAM;IAK1B;;OAEG;IACH,OAAO,CAAC,GAAG;IAIX;;OAEG;IACH,OAAO,CAAC,MAAM;IAIR,MAAM;IAmGZ,OAAO;CAGP"}

package/dist/components/whats-new-modal.js

@@ -0,0 +1,108 @@
+import { __awaiter } from "tslib";
+import { MarkdownRenderer, Modal } from "obsidian";
+import { formatChangelogSections, getChangelogSince } from "../string/changelog-parser";
+/**
+ * Generic "What's New" modal that displays changelog entries between versions.
+ * Supports custom CSS prefixes, plugin names, and configurable links.
+ */
+export class WhatsNewModal extends Modal {
+    constructor(app, plugin, config, fromVersion, toVersion) {
+        super(app);
+        this.plugin = plugin;
+        this.config = config;
+        this.fromVersion = fromVersion;
+        this.toVersion = toVersion;
+    }
+    /**
+     * Helper to create CSS class names with the configured prefix.
+     */
+    cls(suffix) {
+        return `${this.config.cssPrefix}-${suffix}`;
+    }
+    /**
+     * Helper to add CSS class to an element.
+     */
+    addCls(el, suffix) {
+        el.classList.add(this.cls(suffix));
+    }
+    onOpen() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { contentEl } = this;
+            contentEl.empty();
+            this.addCls(contentEl, "whats-new-modal");
+            // Header section
+            const header = contentEl.createDiv({ cls: this.cls("whats-new-header") });
+            header.createEl("h2", {
+                text: `${this.config.pluginName} updated to v${this.toVersion}`,
+            });
+            header.createEl("p", {
+                text: `Changes since v${this.fromVersion}`,
+                cls: this.cls("whats-new-subtitle"),
+            });
+            // Support section (optional)
+            if (this.config.links.support) {
+                const supportSection = contentEl.createDiv({
+                    cls: this.cls("whats-new-support"),
+                });
+                supportSection.createEl("h3", { text: "Support My Work" });
+                const supportText = supportSection.createEl("p");
+                supportText.createSpan({ text: "If you enjoy using this plugin, please consider " });
+                supportText.createEl("a", {
+                    text: "supporting my work",
+                    href: this.config.links.support,
+                });
+                supportText.createSpan({
+                    text: ". Your support helps keep this plugin maintained and improved!",
+                });
+                contentEl.createEl("hr");
+            }
+            // Changelog content
+            const changelogSections = getChangelogSince(this.config.changelogContent, this.fromVersion, this.toVersion);
+            if (changelogSections.length === 0) {
+                contentEl.createEl("p", {
+                    text: "No significant changes found in this update.",
+                    cls: this.cls("whats-new-empty"),
+                });
+            }
+            else {
+                const changelogContainer = contentEl.createDiv({
+                    cls: this.cls("whats-new-content"),
+                });
+                const markdownContent = formatChangelogSections(changelogSections);
+                yield MarkdownRenderer.render(this.app, markdownContent, changelogContainer, "/", this.plugin);
+            }
+            // Action buttons
+            const buttonContainer = contentEl.createDiv({
+                cls: this.cls("whats-new-buttons"),
+            });
+            // Full changelog button (optional)
+            if (this.config.links.changelog) {
+                const changelogBtn = buttonContainer.createEl("button", {
+                    text: "Full Changelog",
+                });
+                changelogBtn.addEventListener("click", () => {
+                    window.open(this.config.links.changelog, "_blank");
+                });
+            }
+            // Documentation button (optional)
+            if (this.config.links.documentation) {
+                const docsBtn = buttonContainer.createEl("button", {
+                    text: "Documentation",
+                });
+                docsBtn.addEventListener("click", () => {
+                    window.open(this.config.links.documentation, "_blank");
+                });
+            }
+            // Close button (always present)
+            const closeBtn = buttonContainer.createEl("button", {
+                text: "Close",
+                cls: this.cls("mod-cta"),
+            });
+            closeBtn.addEventListener("click", () => this.close());
+        });
+    }
+    onClose() {
+        this.contentEl.empty();
+    }
+}
+//# sourceMappingURL=whats-new-modal.js.map

package/dist/components/whats-new-modal.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"whats-new-modal.js","sourceRoot":"","sources":["../../src/components/whats-new-modal.ts"],"names":[],"mappings":";AACA,OAAO,EAAE,gBAAgB,EAAE,KAAK,EAAE,MAAM,UAAU,CAAC;AACnD,OAAO,EAAE,uBAAuB,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AAyCxF;;;GAGG;AACH,MAAM,OAAO,aAAc,SAAQ,KAAK;IACvC,YACC,GAAQ,EACA,MAAc,EACd,MAA2B,EAC3B,WAAmB,EACnB,SAAiB;QAEzB,KAAK,CAAC,GAAG,CAAC,CAAC;QALH,WAAM,GAAN,MAAM,CAAQ;QACd,WAAM,GAAN,MAAM,CAAqB;QAC3B,gBAAW,GAAX,WAAW,CAAQ;QACnB,cAAS,GAAT,SAAS,CAAQ;IAG1B,CAAC;IAED;;OAEG;IACK,GAAG,CAAC,MAAc;QACzB,OAAO,GAAG,IAAI,CAAC,MAAM,CAAC,SAAS,IAAI,MAAM,EAAE,CAAC;IAC7C,CAAC;IAED;;OAEG;IACK,MAAM,CAAC,EAAe,EAAE,MAAc;QAC7C,EAAE,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC;IACpC,CAAC;IAEK,MAAM;;YACX,MAAM,EAAE,SAAS,EAAE,GAAG,IAAI,CAAC;YAC3B,SAAS,CAAC,KAAK,EAAE,CAAC;YAElB,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE,iBAAiB,CAAC,CAAC;YAE1C,iBAAiB;YACjB,MAAM,MAAM,GAAG,SAAS,CAAC,SAAS,CAAC,EAAE,GAAG,EAAE,IAAI,CAAC,GAAG,CAAC,kBAAkB,CAAC,EAAE,CAAC,CAAC;YAC1E,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE;gBACrB,IAAI,EAAE,GAAG,IAAI,CAAC,MAAM,CAAC,UAAU,gBAAgB,IAAI,CAAC,SAAS,EAAE;aAC/D,CAAC,CAAC;YAEH,MAAM,CAAC,QAAQ,CAAC,GAAG,EAAE;gBACpB,IAAI,EAAE,kBAAkB,IAAI,CAAC,WAAW,EAAE;gBAC1C,GAAG,EAAE,IAAI,CAAC,GAAG,CAAC,oBAAoB,CAAC;aACnC,CAAC,CAAC;YAEH,6BAA6B;YAC7B,IAAI,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC;gBAC/B,MAAM,cAAc,GAAG,SAAS,CAAC,SAAS,CAAC;oBAC1C,GAAG,EAAE,IAAI,CAAC,GAAG,CAAC,mBAAmB,CAAC;iBAClC,CAAC,CAAC;gBAEH,cAAc,CAAC,QAAQ,CAAC,IAAI,EAAE,EAAE,IAAI,EAAE,iBAAiB,EAAE,CAAC,CAAC;gBAE3D,MAAM,WAAW,GAAG,cAAc,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;gBACjD,WAAW,CAAC,UAAU,CAAC,EAAE,IAAI,EAAE,kDAAkD,EAAE,CAAC,CAAC;gBACrF,WAAW,CAAC,QAAQ,CAAC,GAAG,EAAE;oBACzB,IAAI,EAAE,oBAAoB;oBAC1B,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,OAAO;iBAC/B,CAAC,CAAC;gBACH,WAAW,CAAC,UAAU,CAAC;oBACtB,IAAI,EAAE,gEAAgE;iBACtE,CAAC,CAAC;gBAEH,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YAC1B,CAAC;YAED,oBAAoB;YACpB,MAAM,iBAAiB,GAAG,iBAAiB,CAC1C,IAAI,CAAC,MAAM,CAAC,gBAAgB,EAC5B,IAAI,CAAC,WAAW,EAChB,IAAI,CAAC,SAAS,CACd,CAAC;YAEF,IAAI,iBAAiB,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBACpC,SAAS,CAAC,QAAQ,CAAC,GAAG,EAAE;oBACvB,IAAI,EAAE,8CAA8C;oBACpD,GAAG,EAAE,IAAI,CAAC,GAAG,CAAC,iBAAiB,CAAC;iBAChC,CAAC,CAAC;YACJ,CAAC;iBAAM,CAAC;gBACP,MAAM,kBAAkB,GAAG,SAAS,CAAC,SAAS,CAAC;oBAC9C,GAAG,EAAE,IAAI,CAAC,GAAG,CAAC,mBAAmB,CAAC;iBAClC,CAAC,CAAC;gBAEH,MAAM,eAAe,GAAG,uBAAuB,CAAC,iBAAiB,CAAC,CAAC;gBAEnE,MAAM,gBAAgB,CAAC,MAAM,CAC5B,IAAI,CAAC,GAAG,EACR,eAAe,EACf,kBAAkB,EAClB,GAAG,EACH,IAAI,CAAC,MAAM,CACX,CAAC;YACH,CAAC;YAED,iBAAiB;YACjB,MAAM,eAAe,GAAG,SAAS,CAAC,SAAS,CAAC;gBAC3C,GAAG,EAAE,IAAI,CAAC,GAAG,CAAC,mBAAmB,CAAC;aAClC,CAAC,CAAC;YAEH,mCAAmC;YACnC,IAAI,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,SAAS,EAAE,CAAC;gBACjC,MAAM,YAAY,GAAG,eAAe,CAAC,QAAQ,CAAC,QAAQ,EAAE;oBACvD,IAAI,EAAE,gBAAgB;iBACtB,CAAC,CAAC;gBACH,YAAY,CAAC,gBAAgB,CAAC,OAAO,EAAE,GAAG,EAAE;oBAC3C,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;gBACpD,CAAC,CAAC,CAAC;YACJ,CAAC;YAED,kCAAkC;YAClC,IAAI,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,aAAa,EAAE,CAAC;gBACrC,MAAM,OAAO,GAAG,eAAe,CAAC,QAAQ,CAAC,QAAQ,EAAE;oBAClD,IAAI,EAAE,eAAe;iBACrB,CAAC,CAAC;gBACH,OAAO,CAAC,gBAAgB,CAAC,OAAO,EAAE,GAAG,EAAE;oBACtC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,aAAa,EAAE,QAAQ,CAAC,CAAC;gBACxD,CAAC,CAAC,CAAC;YACJ,CAAC;YAED,gCAAgC;YAChC,MAAM,QAAQ,GAAG,eAAe,CAAC,QAAQ,CAAC,QAAQ,EAAE;gBACnD,IAAI,EAAE,OAAO;gBACb,GAAG,EAAE,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC;aACxB,CAAC,CAAC;YACH,QAAQ,CAAC,gBAAgB,CAAC,OAAO,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC,CAAC;QACxD,CAAC;KAAA;IAED,OAAO;QACN,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,CAAC;IACxB,CAAC;CACD","sourcesContent":["import type { App, Plugin } from \"obsidian\";\nimport { MarkdownRenderer, Modal } from \"obsidian\";\nimport { formatChangelogSections, getChangelogSince } from \"../string/changelog-parser\";\n\nexport interface WhatsNewModalConfig {\n\t/**\n\t * The CSS class prefix/suffix to use for styling.\n\t * Example: \"custom-calendar\" will generate classes like \"custom-calendar-whats-new-modal\"\n\t */\n\tcssPrefix: string;\n\n\t/**\n\t * Display name of the plugin.\n\t * Example: \"Custom Calendar\"\n\t */\n\tpluginName: string;\n\n\t/**\n\t * Raw changelog markdown content to parse.\n\t */\n\tchangelogContent: string;\n\n\t/**\n\t * Links to external resources.\n\t */\n\tlinks: {\n\t\t/**\n\t\t * URL to support/donate page.\n\t\t */\n\t\tsupport?: string;\n\n\t\t/**\n\t\t * URL to full changelog page.\n\t\t */\n\t\tchangelog?: string;\n\n\t\t/**\n\t\t * URL to documentation.\n\t\t */\n\t\tdocumentation?: string;\n\t};\n}\n\n/**\n * Generic \"What's New\" modal that displays changelog entries between versions.\n * Supports custom CSS prefixes, plugin names, and configurable links.\n */\nexport class WhatsNewModal extends Modal {\n\tconstructor(\n\t\tapp: App,\n\t\tprivate plugin: Plugin,\n\t\tprivate config: WhatsNewModalConfig,\n\t\tprivate fromVersion: string,\n\t\tprivate toVersion: string\n\t) {\n\t\tsuper(app);\n\t}\n\n\t/**\n\t * Helper to create CSS class names with the configured prefix.\n\t */\n\tprivate cls(suffix: string): string {\n\t\treturn `${this.config.cssPrefix}-${suffix}`;\n\t}\n\n\t/**\n\t * Helper to add CSS class to an element.\n\t */\n\tprivate addCls(el: HTMLElement, suffix: string): void {\n\t\tel.classList.add(this.cls(suffix));\n\t}\n\n\tasync onOpen() {\n\t\tconst { contentEl } = this;\n\t\tcontentEl.empty();\n\n\t\tthis.addCls(contentEl, \"whats-new-modal\");\n\n\t\t// Header section\n\t\tconst header = contentEl.createDiv({ cls: this.cls(\"whats-new-header\") });\n\t\theader.createEl(\"h2\", {\n\t\t\ttext: `${this.config.pluginName} updated to v${this.toVersion}`,\n\t\t});\n\n\t\theader.createEl(\"p\", {\n\t\t\ttext: `Changes since v${this.fromVersion}`,\n\t\t\tcls: this.cls(\"whats-new-subtitle\"),\n\t\t});\n\n\t\t// Support section (optional)\n\t\tif (this.config.links.support) {\n\t\t\tconst supportSection = contentEl.createDiv({\n\t\t\t\tcls: this.cls(\"whats-new-support\"),\n\t\t\t});\n\n\t\t\tsupportSection.createEl(\"h3\", { text: \"Support My Work\" });\n\n\t\t\tconst supportText = supportSection.createEl(\"p\");\n\t\t\tsupportText.createSpan({ text: \"If you enjoy using this plugin, please consider \" });\n\t\t\tsupportText.createEl(\"a\", {\n\t\t\t\ttext: \"supporting my work\",\n\t\t\t\thref: this.config.links.support,\n\t\t\t});\n\t\t\tsupportText.createSpan({\n\t\t\t\ttext: \". Your support helps keep this plugin maintained and improved!\",\n\t\t\t});\n\n\t\t\tcontentEl.createEl(\"hr\");\n\t\t}\n\n\t\t// Changelog content\n\t\tconst changelogSections = getChangelogSince(\n\t\t\tthis.config.changelogContent,\n\t\t\tthis.fromVersion,\n\t\t\tthis.toVersion\n\t\t);\n\n\t\tif (changelogSections.length === 0) {\n\t\t\tcontentEl.createEl(\"p\", {\n\t\t\t\ttext: \"No significant changes found in this update.\",\n\t\t\t\tcls: this.cls(\"whats-new-empty\"),\n\t\t\t});\n\t\t} else {\n\t\t\tconst changelogContainer = contentEl.createDiv({\n\t\t\t\tcls: this.cls(\"whats-new-content\"),\n\t\t\t});\n\n\t\t\tconst markdownContent = formatChangelogSections(changelogSections);\n\n\t\t\tawait MarkdownRenderer.render(\n\t\t\t\tthis.app,\n\t\t\t\tmarkdownContent,\n\t\t\t\tchangelogContainer,\n\t\t\t\t\"/\",\n\t\t\t\tthis.plugin\n\t\t\t);\n\t\t}\n\n\t\t// Action buttons\n\t\tconst buttonContainer = contentEl.createDiv({\n\t\t\tcls: this.cls(\"whats-new-buttons\"),\n\t\t});\n\n\t\t// Full changelog button (optional)\n\t\tif (this.config.links.changelog) {\n\t\t\tconst changelogBtn = buttonContainer.createEl(\"button\", {\n\t\t\t\ttext: \"Full Changelog\",\n\t\t\t});\n\t\t\tchangelogBtn.addEventListener(\"click\", () => {\n\t\t\t\twindow.open(this.config.links.changelog, \"_blank\");\n\t\t\t});\n\t\t}\n\n\t\t// Documentation button (optional)\n\t\tif (this.config.links.documentation) {\n\t\t\tconst docsBtn = buttonContainer.createEl(\"button\", {\n\t\t\t\ttext: \"Documentation\",\n\t\t\t});\n\t\t\tdocsBtn.addEventListener(\"click\", () => {\n\t\t\t\twindow.open(this.config.links.documentation, \"_blank\");\n\t\t\t});\n\t\t}\n\n\t\t// Close button (always present)\n\t\tconst closeBtn = buttonContainer.createEl(\"button\", {\n\t\t\ttext: \"Close\",\n\t\t\tcls: this.cls(\"mod-cta\"),\n\t\t});\n\t\tcloseBtn.addEventListener(\"click\", () => this.close());\n\t}\n\n\tonClose() {\n\t\tthis.contentEl.empty();\n\t}\n}\n"]}

package/dist/string/changelog-parser.d.ts

@@ -0,0 +1,17 @@
+interface VersionSection {
+    version: string;
+    content: string;
+}
+/**
+ * Parses changelog markdown content into version sections.
+ * Each section starts with "## X.Y.Z" heading.
+ */
+export declare function parseChangelog(changelogContent: string): VersionSection[];
+/**
+ * Gets all changelog sections between fromVersion (exclusive) and toVersion (inclusive).
+ * Sections are returned in reverse chronological order (newest first).
+ */
+export declare function getChangelogSince(changelogContent: string, fromVersion: string, toVersion: string): VersionSection[];
+export declare function formatChangelogSections(sections: VersionSection[]): string;
+export type { VersionSection };
+//# sourceMappingURL=changelog-parser.d.ts.map

package/dist/string/changelog-parser.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"changelog-parser.d.ts","sourceRoot":"","sources":["../../src/string/changelog-parser.ts"],"names":[],"mappings":"AAAA,UAAU,cAAc;IACvB,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;CAChB;AAED;;;GAGG;AACH,wBAAgB,cAAc,CAAC,gBAAgB,EAAE,MAAM,GAAG,cAAc,EAAE,CAiCzE;AAyBD;;;GAGG;AACH,wBAAgB,iBAAiB,CAChC,gBAAgB,EAAE,MAAM,EACxB,WAAW,EAAE,MAAM,EACnB,SAAS,EAAE,MAAM,GACf,cAAc,EAAE,CAQlB;AAED,wBAAgB,uBAAuB,CAAC,QAAQ,EAAE,cAAc,EAAE,GAAG,MAAM,CAY1E;AAED,YAAY,EAAE,cAAc,EAAE,CAAC"}

package/dist/string/changelog-parser.js

@@ -0,0 +1,77 @@
+/**
+ * Parses changelog markdown content into version sections.
+ * Each section starts with "## X.Y.Z" heading.
+ */
+export function parseChangelog(changelogContent) {
+    const sections = [];
+    const lines = changelogContent.split("\n");
+    let currentVersion = null;
+    let currentContent = [];
+    for (const line of lines) {
+        const versionMatch = line.match(/^##\s+(\d+\.\d+\.\d+)/);
+        if (versionMatch) {
+            if (currentVersion !== null) {
+                sections.push({
+                    version: currentVersion,
+                    content: currentContent.join("\n").trim(),
+                });
+            }
+            currentVersion = versionMatch[1];
+            currentContent = [];
+        }
+        else if (currentVersion !== null) {
+            currentContent.push(line);
+        }
+    }
+    if (currentVersion !== null && currentContent.length > 0) {
+        sections.push({
+            version: currentVersion,
+            content: currentContent.join("\n").trim(),
+        });
+    }
+    return sections;
+}
+/**
+ * Compares two semantic version strings.
+ * Returns:
+ * - negative if v1 < v2
+ * - 0 if v1 === v2
+ * - positive if v1 > v2
+ */
+function compareVersions(v1, v2) {
+    const parts1 = v1.split(".").map(Number);
+    const parts2 = v2.split(".").map(Number);
+    for (let i = 0; i < Math.max(parts1.length, parts2.length); i++) {
+        const num1 = parts1[i] || 0;
+        const num2 = parts2[i] || 0;
+        if (num1 !== num2) {
+            return num1 - num2;
+        }
+    }
+    return 0;
+}
+/**
+ * Gets all changelog sections between fromVersion (exclusive) and toVersion (inclusive).
+ * Sections are returned in reverse chronological order (newest first).
+ */
+export function getChangelogSince(changelogContent, fromVersion, toVersion) {
+    const allSections = parseChangelog(changelogContent);
+    return allSections.filter((section) => {
+        const isAfterFrom = compareVersions(section.version, fromVersion) > 0;
+        const isBeforeOrEqualTo = compareVersions(section.version, toVersion) <= 0;
+        return isAfterFrom && isBeforeOrEqualTo;
+    });
+}
+export function formatChangelogSections(sections) {
+    if (sections.length === 0) {
+        return "No changes found.";
+    }
+    return sections
+        .map((section) => {
+        // Escape Dataview inline queries to prevent parsing errors
+        const content = section.content.replace(/`=([^`]+)`/g, "`\\=$1`");
+        return `## ${section.version}\n\n${content}`;
+    })
+        .join("\n\n");
+}
+//# sourceMappingURL=changelog-parser.js.map

package/dist/string/changelog-parser.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"changelog-parser.js","sourceRoot":"","sources":["../../src/string/changelog-parser.ts"],"names":[],"mappings":"AAKA;;;GAGG;AACH,MAAM,UAAU,cAAc,CAAC,gBAAwB;IACtD,MAAM,QAAQ,GAAqB,EAAE,CAAC;IACtC,MAAM,KAAK,GAAG,gBAAgB,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAE3C,IAAI,cAAc,GAAkB,IAAI,CAAC;IACzC,IAAI,cAAc,GAAa,EAAE,CAAC;IAElC,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QAC1B,MAAM,YAAY,GAAG,IAAI,CAAC,KAAK,CAAC,uBAAuB,CAAC,CAAC;QAEzD,IAAI,YAAY,EAAE,CAAC;YAClB,IAAI,cAAc,KAAK,IAAI,EAAE,CAAC;gBAC7B,QAAQ,CAAC,IAAI,CAAC;oBACb,OAAO,EAAE,cAAc;oBACvB,OAAO,EAAE,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE;iBACzC,CAAC,CAAC;YACJ,CAAC;YAED,cAAc,GAAG,YAAY,CAAC,CAAC,CAAC,CAAC;YACjC,cAAc,GAAG,EAAE,CAAC;QACrB,CAAC;aAAM,IAAI,cAAc,KAAK,IAAI,EAAE,CAAC;YACpC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC3B,CAAC;IACF,CAAC;IAED,IAAI,cAAc,KAAK,IAAI,IAAI,cAAc,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC1D,QAAQ,CAAC,IAAI,CAAC;YACb,OAAO,EAAE,cAAc;YACvB,OAAO,EAAE,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE;SACzC,CAAC,CAAC;IACJ,CAAC;IAED,OAAO,QAAQ,CAAC;AACjB,CAAC;AAED;;;;;;GAMG;AACH,SAAS,eAAe,CAAC,EAAU,EAAE,EAAU;IAC9C,MAAM,MAAM,GAAG,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IACzC,MAAM,MAAM,GAAG,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IAEzC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;QACjE,MAAM,IAAI,GAAG,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;QAC5B,MAAM,IAAI,GAAG,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;QAE5B,IAAI,IAAI,KAAK,IAAI,EAAE,CAAC;YACnB,OAAO,IAAI,GAAG,IAAI,CAAC;QACpB,CAAC;IACF,CAAC;IAED,OAAO,CAAC,CAAC;AACV,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,iBAAiB,CAChC,gBAAwB,EACxB,WAAmB,EACnB,SAAiB;IAEjB,MAAM,WAAW,GAAG,cAAc,CAAC,gBAAgB,CAAC,CAAC;IAErD,OAAO,WAAW,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE,EAAE;QACrC,MAAM,WAAW,GAAG,eAAe,CAAC,OAAO,CAAC,OAAO,EAAE,WAAW,CAAC,GAAG,CAAC,CAAC;QACtE,MAAM,iBAAiB,GAAG,eAAe,CAAC,OAAO,CAAC,OAAO,EAAE,SAAS,CAAC,IAAI,CAAC,CAAC;QAC3E,OAAO,WAAW,IAAI,iBAAiB,CAAC;IACzC,CAAC,CAAC,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,uBAAuB,CAAC,QAA0B;IACjE,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC3B,OAAO,mBAAmB,CAAC;IAC5B,CAAC;IAED,OAAO,QAAQ;SACb,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE;QAChB,2DAA2D;QAC3D,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,aAAa,EAAE,SAAS,CAAC,CAAC;QAClE,OAAO,MAAM,OAAO,CAAC,OAAO,OAAO,OAAO,EAAE,CAAC;IAC9C,CAAC,CAAC;SACD,IAAI,CAAC,MAAM,CAAC,CAAC;AAChB,CAAC","sourcesContent":["interface VersionSection {\n\tversion: string;\n\tcontent: string;\n}\n\n/**\n * Parses changelog markdown content into version sections.\n * Each section starts with \"## X.Y.Z\" heading.\n */\nexport function parseChangelog(changelogContent: string): VersionSection[] {\n\tconst sections: VersionSection[] = [];\n\tconst lines = changelogContent.split(\"\\n\");\n\n\tlet currentVersion: string | null = null;\n\tlet currentContent: string[] = [];\n\n\tfor (const line of lines) {\n\t\tconst versionMatch = line.match(/^##\\s+(\\d+\\.\\d+\\.\\d+)/);\n\n\t\tif (versionMatch) {\n\t\t\tif (currentVersion !== null) {\n\t\t\t\tsections.push({\n\t\t\t\t\tversion: currentVersion,\n\t\t\t\t\tcontent: currentContent.join(\"\\n\").trim(),\n\t\t\t\t});\n\t\t\t}\n\n\t\t\tcurrentVersion = versionMatch[1];\n\t\t\tcurrentContent = [];\n\t\t} else if (currentVersion !== null) {\n\t\t\tcurrentContent.push(line);\n\t\t}\n\t}\n\n\tif (currentVersion !== null && currentContent.length > 0) {\n\t\tsections.push({\n\t\t\tversion: currentVersion,\n\t\t\tcontent: currentContent.join(\"\\n\").trim(),\n\t\t});\n\t}\n\n\treturn sections;\n}\n\n/**\n * Compares two semantic version strings.\n * Returns:\n * - negative if v1 < v2\n * - 0 if v1 === v2\n * - positive if v1 > v2\n */\nfunction compareVersions(v1: string, v2: string): number {\n\tconst parts1 = v1.split(\".\").map(Number);\n\tconst parts2 = v2.split(\".\").map(Number);\n\n\tfor (let i = 0; i < Math.max(parts1.length, parts2.length); i++) {\n\t\tconst num1 = parts1[i] || 0;\n\t\tconst num2 = parts2[i] || 0;\n\n\t\tif (num1 !== num2) {\n\t\t\treturn num1 - num2;\n\t\t}\n\t}\n\n\treturn 0;\n}\n\n/**\n * Gets all changelog sections between fromVersion (exclusive) and toVersion (inclusive).\n * Sections are returned in reverse chronological order (newest first).\n */\nexport function getChangelogSince(\n\tchangelogContent: string,\n\tfromVersion: string,\n\ttoVersion: string\n): VersionSection[] {\n\tconst allSections = parseChangelog(changelogContent);\n\n\treturn allSections.filter((section) => {\n\t\tconst isAfterFrom = compareVersions(section.version, fromVersion) > 0;\n\t\tconst isBeforeOrEqualTo = compareVersions(section.version, toVersion) <= 0;\n\t\treturn isAfterFrom && isBeforeOrEqualTo;\n\t});\n}\n\nexport function formatChangelogSections(sections: VersionSection[]): string {\n\tif (sections.length === 0) {\n\t\treturn \"No changes found.\";\n\t}\n\n\treturn sections\n\t\t.map((section) => {\n\t\t\t// Escape Dataview inline queries to prevent parsing errors\n\t\t\tconst content = section.content.replace(/`=([^`]+)`/g, \"`\\\\=$1`\");\n\t\t\treturn `## ${section.version}\\n\\n${content}`;\n\t\t})\n\t\t.join(\"\\n\\n\");\n}\n\nexport type { VersionSection };\n"]}

package/dist/string/index.d.ts

@@ -1,3 +1,4 @@
+export * from "./changelog-parser";
 export * from "./filename-utils";
 export * from "./string";
 //# sourceMappingURL=index.d.ts.map

package/dist/string/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/string/index.ts"],"names":[],"mappings":"AAAA,cAAc,kBAAkB,CAAC;AACjC,cAAc,UAAU,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/string/index.ts"],"names":[],"mappings":"AAAA,cAAc,oBAAoB,CAAC;AACnC,cAAc,kBAAkB,CAAC;AACjC,cAAc,UAAU,CAAC"}

package/dist/string/index.js

@@ -1,3 +1,4 @@
+export * from "./changelog-parser";
 export * from "./filename-utils";
 export * from "./string";
 //# sourceMappingURL=index.js.map

package/dist/string/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/string/index.ts"],"names":[],"mappings":"AAAA,cAAc,kBAAkB,CAAC;AACjC,cAAc,UAAU,CAAC","sourcesContent":["export * from \"./filename-utils\";\nexport * from \"./string\";\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/string/index.ts"],"names":[],"mappings":"AAAA,cAAc,oBAAoB,CAAC;AACnC,cAAc,kBAAkB,CAAC;AACjC,cAAc,UAAU,CAAC","sourcesContent":["export * from \"./changelog-parser\";\nexport * from \"./filename-utils\";\nexport * from \"./string\";\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@real1ty-obsidian-plugins/utils",
-  "version": "2.23.0",
+  "version": "2.24.0",
   "description": "Shared utilities for Obsidian plugins",
   "type": "module",
   "main": "./dist/index.js",

package/src/components/index.ts

@@ -1,2 +1,3 @@
 export * from "./frontmatter-propagation-modal";
 export * from "./input-managers";
+export * from "./whats-new-modal";

package/src/components/whats-new-modal.ts

@@ -0,0 +1,175 @@
+import type { App, Plugin } from "obsidian";
+import { MarkdownRenderer, Modal } from "obsidian";
+import { formatChangelogSections, getChangelogSince } from "../string/changelog-parser";
+
+export interface WhatsNewModalConfig {
+	/**
+	 * The CSS class prefix/suffix to use for styling.
+	 * Example: "custom-calendar" will generate classes like "custom-calendar-whats-new-modal"
+	 */
+	cssPrefix: string;
+
+	/**
+	 * Display name of the plugin.
+	 * Example: "Custom Calendar"
+	 */
+	pluginName: string;
+
+	/**
+	 * Raw changelog markdown content to parse.
+	 */
+	changelogContent: string;
+
+	/**
+	 * Links to external resources.
+	 */
+	links: {
+		/**
+		 * URL to support/donate page.
+		 */
+		support?: string;
+
+		/**
+		 * URL to full changelog page.
+		 */
+		changelog?: string;
+
+		/**
+		 * URL to documentation.
+		 */
+		documentation?: string;
+	};
+}
+
+/**
+ * Generic "What's New" modal that displays changelog entries between versions.
+ * Supports custom CSS prefixes, plugin names, and configurable links.
+ */
+export class WhatsNewModal extends Modal {
+	constructor(
+		app: App,
+		private plugin: Plugin,
+		private config: WhatsNewModalConfig,
+		private fromVersion: string,
+		private toVersion: string
+	) {
+		super(app);
+	}
+
+	/**
+	 * Helper to create CSS class names with the configured prefix.
+	 */
+	private cls(suffix: string): string {
+		return `${this.config.cssPrefix}-${suffix}`;
+	}
+
+	/**
+	 * Helper to add CSS class to an element.
+	 */
+	private addCls(el: HTMLElement, suffix: string): void {
+		el.classList.add(this.cls(suffix));
+	}
+
+	async onOpen() {
+		const { contentEl } = this;
+		contentEl.empty();
+
+		this.addCls(contentEl, "whats-new-modal");
+
+		// Header section
+		const header = contentEl.createDiv({ cls: this.cls("whats-new-header") });
+		header.createEl("h2", {
+			text: `${this.config.pluginName} updated to v${this.toVersion}`,
+		});
+
+		header.createEl("p", {
+			text: `Changes since v${this.fromVersion}`,
+			cls: this.cls("whats-new-subtitle"),
+		});
+
+		// Support section (optional)
+		if (this.config.links.support) {
+			const supportSection = contentEl.createDiv({
+				cls: this.cls("whats-new-support"),
+			});
+
+			supportSection.createEl("h3", { text: "Support My Work" });
+
+			const supportText = supportSection.createEl("p");
+			supportText.createSpan({ text: "If you enjoy using this plugin, please consider " });
+			supportText.createEl("a", {
+				text: "supporting my work",
+				href: this.config.links.support,
+			});
+			supportText.createSpan({
+				text: ". Your support helps keep this plugin maintained and improved!",
+			});
+
+			contentEl.createEl("hr");
+		}
+
+		// Changelog content
+		const changelogSections = getChangelogSince(
+			this.config.changelogContent,
+			this.fromVersion,
+			this.toVersion
+		);
+
+		if (changelogSections.length === 0) {
+			contentEl.createEl("p", {
+				text: "No significant changes found in this update.",
+				cls: this.cls("whats-new-empty"),
+			});
+		} else {
+			const changelogContainer = contentEl.createDiv({
+				cls: this.cls("whats-new-content"),
+			});
+
+			const markdownContent = formatChangelogSections(changelogSections);
+
+			await MarkdownRenderer.render(
+				this.app,
+				markdownContent,
+				changelogContainer,
+				"/",
+				this.plugin
+			);
+		}
+
+		// Action buttons
+		const buttonContainer = contentEl.createDiv({
+			cls: this.cls("whats-new-buttons"),
+		});
+
+		// Full changelog button (optional)
+		if (this.config.links.changelog) {
+			const changelogBtn = buttonContainer.createEl("button", {
+				text: "Full Changelog",
+			});
+			changelogBtn.addEventListener("click", () => {
+				window.open(this.config.links.changelog, "_blank");
+			});
+		}
+
+		// Documentation button (optional)
+		if (this.config.links.documentation) {
+			const docsBtn = buttonContainer.createEl("button", {
+				text: "Documentation",
+			});
+			docsBtn.addEventListener("click", () => {
+				window.open(this.config.links.documentation, "_blank");
+			});
+		}
+
+		// Close button (always present)
+		const closeBtn = buttonContainer.createEl("button", {
+			text: "Close",
+			cls: this.cls("mod-cta"),
+		});
+		closeBtn.addEventListener("click", () => this.close());
+	}
+
+	onClose() {
+		this.contentEl.empty();
+	}
+}

package/src/string/changelog-parser.ts

@@ -0,0 +1,100 @@
+interface VersionSection {
+	version: string;
+	content: string;
+}
+
+/**
+ * Parses changelog markdown content into version sections.
+ * Each section starts with "## X.Y.Z" heading.
+ */
+export function parseChangelog(changelogContent: string): VersionSection[] {
+	const sections: VersionSection[] = [];
+	const lines = changelogContent.split("\n");
+
+	let currentVersion: string | null = null;
+	let currentContent: string[] = [];
+
+	for (const line of lines) {
+		const versionMatch = line.match(/^##\s+(\d+\.\d+\.\d+)/);
+
+		if (versionMatch) {
+			if (currentVersion !== null) {
+				sections.push({
+					version: currentVersion,
+					content: currentContent.join("\n").trim(),
+				});
+			}
+
+			currentVersion = versionMatch[1];
+			currentContent = [];
+		} else if (currentVersion !== null) {
+			currentContent.push(line);
+		}
+	}
+
+	if (currentVersion !== null && currentContent.length > 0) {
+		sections.push({
+			version: currentVersion,
+			content: currentContent.join("\n").trim(),
+		});
+	}
+
+	return sections;
+}
+
+/**
+ * Compares two semantic version strings.
+ * Returns:
+ * - negative if v1 < v2
+ * - 0 if v1 === v2
+ * - positive if v1 > v2
+ */
+function compareVersions(v1: string, v2: string): number {
+	const parts1 = v1.split(".").map(Number);
+	const parts2 = v2.split(".").map(Number);
+
+	for (let i = 0; i < Math.max(parts1.length, parts2.length); i++) {
+		const num1 = parts1[i] || 0;
+		const num2 = parts2[i] || 0;
+
+		if (num1 !== num2) {
+			return num1 - num2;
+		}
+	}
+
+	return 0;
+}
+
+/**
+ * Gets all changelog sections between fromVersion (exclusive) and toVersion (inclusive).
+ * Sections are returned in reverse chronological order (newest first).
+ */
+export function getChangelogSince(
+	changelogContent: string,
+	fromVersion: string,
+	toVersion: string
+): VersionSection[] {
+	const allSections = parseChangelog(changelogContent);
+
+	return allSections.filter((section) => {
+		const isAfterFrom = compareVersions(section.version, fromVersion) > 0;
+		const isBeforeOrEqualTo = compareVersions(section.version, toVersion) <= 0;
+		return isAfterFrom && isBeforeOrEqualTo;
+	});
+}
+
+export function formatChangelogSections(sections: VersionSection[]): string {
+	if (sections.length === 0) {
+		return "No changes found.";
+	}
+
+	return sections
+		.map((section) => {
+			// Escape Dataview inline queries to prevent parsing errors
+			const content = section.content.replace(/`=([^`]+)`/g, "`\\=$1`");
+			return `## ${section.version}\n\n${content}`;
+		})
+		.join("\n\n");
+}
+
+export type { VersionSection };

package/src/string/index.ts

@@ -1,2 +1,3 @@
+export * from "./changelog-parser";
 export * from "./filename-utils";
 export * from "./string";