@real1ty-obsidian-plugins/utils 2.15.0 → 2.16.0

package/dist/file/templater.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"templater.d.ts","sourceRoot":"","sources":["../../src/file/templater.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,GAAG,EAAyB,KAAK,KAAK,EAAE,MAAM,UAAU,CAAC;AAgCvE,wBAAgB,oBAAoB,CAAC,GAAG,EAAE,GAAG,GAAG,OAAO,CAGtD;AAED,wBAAsB,kBAAkB,CACvC,GAAG,EAAE,GAAG,EACR,YAAY,EAAE,MAAM,EACpB,YAAY,CAAC,EAAE,MAAM,EACrB,QAAQ,CAAC,EAAE,MAAM,EACjB,WAAW,UAAQ,GACjB,OAAO,CAAC,KAAK,GAAG,IAAI,CAAC,CA+BvB"}
+{"version":3,"file":"templater.d.ts","sourceRoot":"","sources":["../../src/file/templater.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,GAAG,EAAyB,KAAK,EAAE,MAAM,UAAU,CAAC;AAelE,MAAM,WAAW,mBAAmB;IACnC,KAAK,EAAE,MAAM,CAAC;IACd,eAAe,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,WAAW,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACtC,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,YAAY,CAAC,EAAE,OAAO,CAAC;CACvB;AAmBD,wBAAgB,oBAAoB,CAAC,GAAG,EAAE,GAAG,GAAG,OAAO,CAGtD;AAED,wBAAsB,kBAAkB,CACvC,GAAG,EAAE,GAAG,EACR,YAAY,EAAE,MAAM,EACpB,YAAY,CAAC,EAAE,MAAM,EACrB,QAAQ,CAAC,EAAE,MAAM,EACjB,WAAW,UAAQ,GACjB,OAAO,CAAC,KAAK,GAAG,IAAI,CAAC,CA+BvB;AAED,wBAAsB,sBAAsB,CAC3C,GAAG,EAAE,GAAG,EACR,OAAO,EAAE,mBAAmB,GAC1B,OAAO,CAAC,KAAK,CAAC,CAyChB"}

package/dist/file/templater.js

@@ -1,5 +1,5 @@
 import { __awaiter } from "tslib";
-import { Notice, normalizePath } from "obsidian";
+import { Notice, normalizePath, TFile } from "obsidian";
 const TEMPLATER_ID = "templater-obsidian";
 function waitForTemplater(app_1) {
     return __awaiter(this, arguments, void 0, function* (app, timeoutMs = 8000) {
@@ -48,4 +48,35 @@ export function createFromTemplate(app_1, templatePath_1, targetFolder_1, filena
         }
     });
 }
+export function createFileWithTemplate(app, options) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const { title, targetDirectory, filename, content, frontmatter, templatePath, useTemplater } = options;
+        const finalFilename = filename || title;
+        const baseName = finalFilename.replace(/\.md$/, "");
+        const filePath = normalizePath(`${targetDirectory}/${baseName}.md`);
+        const existingFile = app.vault.getAbstractFileByPath(filePath);
+        if (existingFile instanceof TFile) {
+            return existingFile;
+        }
+        if (useTemplater && templatePath && templatePath.trim() !== "" && isTemplaterAvailable(app)) {
+            const templateFile = yield createFromTemplate(app, templatePath, targetDirectory, finalFilename);
+            if (templateFile) {
+                if (frontmatter && Object.keys(frontmatter).length > 0) {
+                    yield app.fileManager.processFrontMatter(templateFile, (fm) => {
+                        Object.assign(fm, frontmatter);
+                    });
+                }
+                return templateFile;
+            }
+        }
+        const fileContent = content || "";
+        const file = yield app.vault.create(filePath, fileContent);
+        if (frontmatter && Object.keys(frontmatter).length > 0) {
+            yield app.fileManager.processFrontMatter(file, (fm) => {
+                Object.assign(fm, frontmatter);
+            });
+        }
+        return file;
+    });
+}
 //# sourceMappingURL=templater.js.map

package/dist/file/templater.js.map

@@ -1 +1 @@
-{"version":3,"file":"templater.js","sourceRoot":"","sources":["../../src/file/templater.ts"],"names":[],"mappings":";AAAA,OAAO,EAAY,MAAM,EAAE,aAAa,EAAc,MAAM,UAAU,CAAC;AAEvE,MAAM,YAAY,GAAG,oBAAoB,CAAC;AAa1C,SAAe,gBAAgB;yDAAC,GAAQ,EAAE,SAAS,GAAG,IAAI;;QACzD,MAAM,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,EAAE,CAAC,GAAG,CAAC,SAAS,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,CAAC;QAE3E,MAAM,OAAO,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QAC3B,OAAO,IAAI,CAAC,GAAG,EAAE,GAAG,OAAO,GAAG,SAAS,EAAE,CAAC;YACzC,MAAM,IAAI,GAAQ,MAAA,MAAC,GAAW,CAAC,OAAO,0CAAE,SAAS,mDAAG,YAAY,CAAC,CAAC;YAClE,MAAM,GAAG,GAAG,MAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,SAAS,mCAAI,IAAI,CAAC;YAEpC,MAAM,QAAQ,GAAyB,MAAA,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,6BAA6B,0CAAE,IAAI,CAAC,GAAG,CAAC,CAAC;YACrF,IAAI,OAAO,QAAQ,KAAK,UAAU,EAAE,CAAC;gBACpC,OAAO,EAAE,6BAA6B,EAAE,QAAQ,EAAE,CAAC;YACpD,CAAC;YACD,MAAM,IAAI,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,UAAU,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC;QAC9C,CAAC;QACD,OAAO,IAAI,CAAC;IACb,CAAC;CAAA;AAED,MAAM,UAAU,oBAAoB,CAAC,GAAQ;;IAC5C,MAAM,QAAQ,GAAG,MAAA,MAAC,GAAW,CAAC,OAAO,0CAAE,SAAS,mDAAG,YAAY,CAAC,CAAC;IACjE,OAAO,CAAC,CAAC,QAAQ,CAAC;AACnB,CAAC;AAED,MAAM,UAAgB,kBAAkB;yDACvC,GAAQ,EACR,YAAoB,EACpB,YAAqB,EACrB,QAAiB,EACjB,WAAW,GAAG,KAAK;QAEnB,MAAM,SAAS,GAAG,MAAM,gBAAgB,CAAC,GAAG,CAAC,CAAC;QAC9C,IAAI,CAAC,SAAS,EAAE,CAAC;YAChB,OAAO,CAAC,IAAI,CAAC,uDAAuD,CAAC,CAAC;YACtE,IAAI,MAAM,CACT,0FAA0F,CAC1F,CAAC;YACF,OAAO,IAAI,CAAC;QACb,CAAC;QAED,MAAM,YAAY,GAAG,GAAG,CAAC,KAAK,CAAC,aAAa,CAAC,aAAa,CAAC,YAAY,CAAC,CAAC,CAAC;QAC1E,IAAI,CAAC,YAAY,EAAE,CAAC;YACnB,OAAO,CAAC,KAAK,CAAC,uBAAuB,YAAY,EAAE,CAAC,CAAC;YACrD,IAAI,MAAM,CAAC,4BAA4B,YAAY,2CAA2C,CAAC,CAAC;YAChG,OAAO,IAAI,CAAC;QACb,CAAC;QAED,IAAI,CAAC;YACJ,MAAM,OAAO,GAAG,MAAM,SAAS,CAAC,6BAA6B,CAC5D,YAAY,EACZ,YAAY,EACZ,QAAQ,EACR,WAAW,CACX,CAAC;YAEF,OAAO,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,IAAI,CAAC;QACxB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YAChB,OAAO,CAAC,KAAK,CAAC,oCAAoC,EAAE,KAAK,CAAC,CAAC;YAC3D,IAAI,MAAM,CAAC,8EAA8E,CAAC,CAAC;YAC3F,OAAO,IAAI,CAAC;QACb,CAAC;IACF,CAAC;CAAA","sourcesContent":["import { type App, Notice, normalizePath, type TFile } from \"obsidian\";\n\nconst TEMPLATER_ID = \"templater-obsidian\";\n\ntype CreateFn = (\n\ttemplateFile: TFile,\n\tfolder?: string,\n\tfilename?: string,\n\topenNewNote?: boolean\n) => Promise<TFile | undefined>;\n\ninterface TemplaterLike {\n\tcreate_new_note_from_template: CreateFn;\n}\n\nasync function waitForTemplater(app: App, timeoutMs = 8000): Promise<TemplaterLike | null> {\n\tawait new Promise<void>((resolve) => app.workspace.onLayoutReady(resolve));\n\n\tconst started = Date.now();\n\twhile (Date.now() - started < timeoutMs) {\n\t\tconst plug: any = (app as any).plugins?.getPlugin?.(TEMPLATER_ID);\n\t\tconst api = plug?.templater ?? null;\n\n\t\tconst createFn: CreateFn | undefined = api?.create_new_note_from_template?.bind(api);\n\t\tif (typeof createFn === \"function\") {\n\t\t\treturn { create_new_note_from_template: createFn };\n\t\t}\n\t\tawait new Promise((r) => setTimeout(r, 150));\n\t}\n\treturn null;\n}\n\nexport function isTemplaterAvailable(app: App): boolean {\n\tconst instance = (app as any).plugins?.getPlugin?.(TEMPLATER_ID);\n\treturn !!instance;\n}\n\nexport async function createFromTemplate(\n\tapp: App,\n\ttemplatePath: string,\n\ttargetFolder?: string,\n\tfilename?: string,\n\topenNewNote = false\n): Promise<TFile | null> {\n\tconst templater = await waitForTemplater(app);\n\tif (!templater) {\n\t\tconsole.warn(\"Templater isn't ready yet (or not installed/enabled).\");\n\t\tnew Notice(\n\t\t\t\"Templater plugin is not available or enabled. Please ensure it is installed and enabled.\"\n\t\t);\n\t\treturn null;\n\t}\n\n\tconst templateFile = app.vault.getFileByPath(normalizePath(templatePath));\n\tif (!templateFile) {\n\t\tconsole.error(`Template not found: ${templatePath}`);\n\t\tnew Notice(`Template file not found: ${templatePath}. Please ensure the template file exists.`);\n\t\treturn null;\n\t}\n\n\ttry {\n\t\tconst newFile = await templater.create_new_note_from_template(\n\t\t\ttemplateFile,\n\t\t\ttargetFolder,\n\t\t\tfilename,\n\t\t\topenNewNote\n\t\t);\n\n\t\treturn newFile ?? null;\n\t} catch (error) {\n\t\tconsole.error(\"Error creating file from template:\", error);\n\t\tnew Notice(\"Error creating file from template. Please ensure the template file is valid.\");\n\t\treturn null;\n\t}\n}\n"]}
+{"version":3,"file":"templater.js","sourceRoot":"","sources":["../../src/file/templater.ts"],"names":[],"mappings":";AAAA,OAAO,EAAY,MAAM,EAAE,aAAa,EAAE,KAAK,EAAE,MAAM,UAAU,CAAC;AAElE,MAAM,YAAY,GAAG,oBAAoB,CAAC;AAuB1C,SAAe,gBAAgB;yDAAC,GAAQ,EAAE,SAAS,GAAG,IAAI;;QACzD,MAAM,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,EAAE,CAAC,GAAG,CAAC,SAAS,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,CAAC;QAE3E,MAAM,OAAO,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QAC3B,OAAO,IAAI,CAAC,GAAG,EAAE,GAAG,OAAO,GAAG,SAAS,EAAE,CAAC;YACzC,MAAM,IAAI,GAAQ,MAAA,MAAC,GAAW,CAAC,OAAO,0CAAE,SAAS,mDAAG,YAAY,CAAC,CAAC;YAClE,MAAM,GAAG,GAAG,MAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,SAAS,mCAAI,IAAI,CAAC;YAEpC,MAAM,QAAQ,GAAyB,MAAA,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,6BAA6B,0CAAE,IAAI,CAAC,GAAG,CAAC,CAAC;YACrF,IAAI,OAAO,QAAQ,KAAK,UAAU,EAAE,CAAC;gBACpC,OAAO,EAAE,6BAA6B,EAAE,QAAQ,EAAE,CAAC;YACpD,CAAC;YACD,MAAM,IAAI,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,UAAU,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC;QAC9C,CAAC;QACD,OAAO,IAAI,CAAC;IACb,CAAC;CAAA;AAED,MAAM,UAAU,oBAAoB,CAAC,GAAQ;;IAC5C,MAAM,QAAQ,GAAG,MAAA,MAAC,GAAW,CAAC,OAAO,0CAAE,SAAS,mDAAG,YAAY,CAAC,CAAC;IACjE,OAAO,CAAC,CAAC,QAAQ,CAAC;AACnB,CAAC;AAED,MAAM,UAAgB,kBAAkB;yDACvC,GAAQ,EACR,YAAoB,EACpB,YAAqB,EACrB,QAAiB,EACjB,WAAW,GAAG,KAAK;QAEnB,MAAM,SAAS,GAAG,MAAM,gBAAgB,CAAC,GAAG,CAAC,CAAC;QAC9C,IAAI,CAAC,SAAS,EAAE,CAAC;YAChB,OAAO,CAAC,IAAI,CAAC,uDAAuD,CAAC,CAAC;YACtE,IAAI,MAAM,CACT,0FAA0F,CAC1F,CAAC;YACF,OAAO,IAAI,CAAC;QACb,CAAC;QAED,MAAM,YAAY,GAAG,GAAG,CAAC,KAAK,CAAC,aAAa,CAAC,aAAa,CAAC,YAAY,CAAC,CAAC,CAAC;QAC1E,IAAI,CAAC,YAAY,EAAE,CAAC;YACnB,OAAO,CAAC,KAAK,CAAC,uBAAuB,YAAY,EAAE,CAAC,CAAC;YACrD,IAAI,MAAM,CAAC,4BAA4B,YAAY,2CAA2C,CAAC,CAAC;YAChG,OAAO,IAAI,CAAC;QACb,CAAC;QAED,IAAI,CAAC;YACJ,MAAM,OAAO,GAAG,MAAM,SAAS,CAAC,6BAA6B,CAC5D,YAAY,EACZ,YAAY,EACZ,QAAQ,EACR,WAAW,CACX,CAAC;YAEF,OAAO,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,IAAI,CAAC;QACxB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YAChB,OAAO,CAAC,KAAK,CAAC,oCAAoC,EAAE,KAAK,CAAC,CAAC;YAC3D,IAAI,MAAM,CAAC,8EAA8E,CAAC,CAAC;YAC3F,OAAO,IAAI,CAAC;QACb,CAAC;IACF,CAAC;CAAA;AAED,MAAM,UAAgB,sBAAsB,CAC3C,GAAQ,EACR,OAA4B;;QAE5B,MAAM,EAAE,KAAK,EAAE,eAAe,EAAE,QAAQ,EAAE,OAAO,EAAE,WAAW,EAAE,YAAY,EAAE,YAAY,EAAE,GAC3F,OAAO,CAAC;QAET,MAAM,aAAa,GAAG,QAAQ,IAAI,KAAK,CAAC;QACxC,MAAM,QAAQ,GAAG,aAAa,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;QACpD,MAAM,QAAQ,GAAG,aAAa,CAAC,GAAG,eAAe,IAAI,QAAQ,KAAK,CAAC,CAAC;QAEpE,MAAM,YAAY,GAAG,GAAG,CAAC,KAAK,CAAC,qBAAqB,CAAC,QAAQ,CAAC,CAAC;QAC/D,IAAI,YAAY,YAAY,KAAK,EAAE,CAAC;YACnC,OAAO,YAAY,CAAC;QACrB,CAAC;QAED,IAAI,YAAY,IAAI,YAAY,IAAI,YAAY,CAAC,IAAI,EAAE,KAAK,EAAE,IAAI,oBAAoB,CAAC,GAAG,CAAC,EAAE,CAAC;YAC7F,MAAM,YAAY,GAAG,MAAM,kBAAkB,CAC5C,GAAG,EACH,YAAY,EACZ,eAAe,EACf,aAAa,CACb,CAAC;YAEF,IAAI,YAAY,EAAE,CAAC;gBAClB,IAAI,WAAW,IAAI,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;oBACxD,MAAM,GAAG,CAAC,WAAW,CAAC,kBAAkB,CAAC,YAAY,EAAE,CAAC,EAAE,EAAE,EAAE;wBAC7D,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,WAAW,CAAC,CAAC;oBAChC,CAAC,CAAC,CAAC;gBACJ,CAAC;gBACD,OAAO,YAAY,CAAC;YACrB,CAAC;QACF,CAAC;QAED,MAAM,WAAW,GAAG,OAAO,IAAI,EAAE,CAAC;QAClC,MAAM,IAAI,GAAG,MAAM,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC;QAE3D,IAAI,WAAW,IAAI,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACxD,MAAM,GAAG,CAAC,WAAW,CAAC,kBAAkB,CAAC,IAAI,EAAE,CAAC,EAAE,EAAE,EAAE;gBACrD,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,WAAW,CAAC,CAAC;YAChC,CAAC,CAAC,CAAC;QACJ,CAAC;QAED,OAAO,IAAI,CAAC;IACb,CAAC;CAAA","sourcesContent":["import { type App, Notice, normalizePath, TFile } from \"obsidian\";\n\nconst TEMPLATER_ID = \"templater-obsidian\";\n\ntype CreateFn = (\n\ttemplateFile: TFile,\n\tfolder?: string,\n\tfilename?: string,\n\topenNewNote?: boolean\n) => Promise<TFile | undefined>;\n\ninterface TemplaterLike {\n\tcreate_new_note_from_template: CreateFn;\n}\n\nexport interface FileCreationOptions {\n\ttitle: string;\n\ttargetDirectory: string;\n\tfilename?: string;\n\tcontent?: string;\n\tfrontmatter?: Record<string, unknown>;\n\ttemplatePath?: string;\n\tuseTemplater?: boolean;\n}\n\nasync function waitForTemplater(app: App, timeoutMs = 8000): Promise<TemplaterLike | null> {\n\tawait new Promise<void>((resolve) => app.workspace.onLayoutReady(resolve));\n\n\tconst started = Date.now();\n\twhile (Date.now() - started < timeoutMs) {\n\t\tconst plug: any = (app as any).plugins?.getPlugin?.(TEMPLATER_ID);\n\t\tconst api = plug?.templater ?? null;\n\n\t\tconst createFn: CreateFn | undefined = api?.create_new_note_from_template?.bind(api);\n\t\tif (typeof createFn === \"function\") {\n\t\t\treturn { create_new_note_from_template: createFn };\n\t\t}\n\t\tawait new Promise((r) => setTimeout(r, 150));\n\t}\n\treturn null;\n}\n\nexport function isTemplaterAvailable(app: App): boolean {\n\tconst instance = (app as any).plugins?.getPlugin?.(TEMPLATER_ID);\n\treturn !!instance;\n}\n\nexport async function createFromTemplate(\n\tapp: App,\n\ttemplatePath: string,\n\ttargetFolder?: string,\n\tfilename?: string,\n\topenNewNote = false\n): Promise<TFile | null> {\n\tconst templater = await waitForTemplater(app);\n\tif (!templater) {\n\t\tconsole.warn(\"Templater isn't ready yet (or not installed/enabled).\");\n\t\tnew Notice(\n\t\t\t\"Templater plugin is not available or enabled. Please ensure it is installed and enabled.\"\n\t\t);\n\t\treturn null;\n\t}\n\n\tconst templateFile = app.vault.getFileByPath(normalizePath(templatePath));\n\tif (!templateFile) {\n\t\tconsole.error(`Template not found: ${templatePath}`);\n\t\tnew Notice(`Template file not found: ${templatePath}. Please ensure the template file exists.`);\n\t\treturn null;\n\t}\n\n\ttry {\n\t\tconst newFile = await templater.create_new_note_from_template(\n\t\t\ttemplateFile,\n\t\t\ttargetFolder,\n\t\t\tfilename,\n\t\t\topenNewNote\n\t\t);\n\n\t\treturn newFile ?? null;\n\t} catch (error) {\n\t\tconsole.error(\"Error creating file from template:\", error);\n\t\tnew Notice(\"Error creating file from template. Please ensure the template file is valid.\");\n\t\treturn null;\n\t}\n}\n\nexport async function createFileWithTemplate(\n\tapp: App,\n\toptions: FileCreationOptions\n): Promise<TFile> {\n\tconst { title, targetDirectory, filename, content, frontmatter, templatePath, useTemplater } =\n\t\toptions;\n\n\tconst finalFilename = filename || title;\n\tconst baseName = finalFilename.replace(/\\.md$/, \"\");\n\tconst filePath = normalizePath(`${targetDirectory}/${baseName}.md`);\n\n\tconst existingFile = app.vault.getAbstractFileByPath(filePath);\n\tif (existingFile instanceof TFile) {\n\t\treturn existingFile;\n\t}\n\n\tif (useTemplater && templatePath && templatePath.trim() !== \"\" && isTemplaterAvailable(app)) {\n\t\tconst templateFile = await createFromTemplate(\n\t\t\tapp,\n\t\t\ttemplatePath,\n\t\t\ttargetDirectory,\n\t\t\tfinalFilename\n\t\t);\n\n\t\tif (templateFile) {\n\t\t\tif (frontmatter && Object.keys(frontmatter).length > 0) {\n\t\t\t\tawait app.fileManager.processFrontMatter(templateFile, (fm) => {\n\t\t\t\t\tObject.assign(fm, frontmatter);\n\t\t\t\t});\n\t\t\t}\n\t\t\treturn templateFile;\n\t\t}\n\t}\n\n\tconst fileContent = content || \"\";\n\tconst file = await app.vault.create(filePath, fileContent);\n\n\tif (frontmatter && Object.keys(frontmatter).length > 0) {\n\t\tawait app.fileManager.processFrontMatter(file, (fm) => {\n\t\t\tObject.assign(fm, frontmatter);\n\t\t});\n\t}\n\n\treturn file;\n}\n"]}

package/package.json

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

package/src/components/frontmatter-propagation-modal.ts

@@ -9,6 +9,7 @@ export interface FrontmatterPropagationModalOptions {
 	instanceCount: number;
 	onConfirm: () => void | Promise<void>;
 	onCancel?: () => void | Promise<void>;
+	cssPrefix?: string;
 }
 
 export class FrontmatterPropagationModal extends Modal {
@@ -21,6 +22,7 @@ export class FrontmatterPropagationModal extends Modal {
 
 	onOpen(): void {
 		const { contentEl } = this;
+		const prefix = this.options.cssPrefix ?? "frontmatter-propagation";
 
 		contentEl.empty();
 
@@ -30,48 +32,50 @@ export class FrontmatterPropagationModal extends Modal {
 			text: `The recurring event "${this.options.eventTitle}" has frontmatter changes. Do you want to apply these changes to all ${this.options.instanceCount} physical instances?`,
 		});
 
-		const changesContainer = contentEl.createDiv({ cls: "prisma-frontmatter-changes" });
+		const changesContainer = contentEl.createDiv({ cls: `${prefix}-frontmatter-changes` });
 
 		if (this.options.diff.added.length > 0) {
-			const addedSection = changesContainer.createDiv({ cls: "prisma-changes-section" });
+			const addedSection = changesContainer.createDiv({
+				cls: `${prefix}-frontmatter-changes-section`,
+			});
 			addedSection.createEl("h4", { text: "Added properties:" });
 			const addedList = addedSection.createEl("ul");
 
 			for (const change of this.options.diff.added) {
 				addedList.createEl("li", {
 					text: formatChangeForDisplay(change),
-					cls: "prisma-change-added",
+					cls: `${prefix}-change-added`,
 				});
 			}
 		}
 
 		if (this.options.diff.modified.length > 0) {
-			const modifiedSection = changesContainer.createDiv({ cls: "prisma-changes-section" });
+			const modifiedSection = changesContainer.createDiv({ cls: `${prefix}-changes-section` });
 			modifiedSection.createEl("h4", { text: "Modified properties:" });
 			const modifiedList = modifiedSection.createEl("ul");
 
 			for (const change of this.options.diff.modified) {
 				modifiedList.createEl("li", {
 					text: formatChangeForDisplay(change),
-					cls: "prisma-change-modified",
+					cls: `${prefix}-change-modified`,
 				});
 			}
 		}
 
 		if (this.options.diff.deleted.length > 0) {
-			const deletedSection = changesContainer.createDiv({ cls: "prisma-changes-section" });
+			const deletedSection = changesContainer.createDiv({ cls: `${prefix}-changes-section` });
 			deletedSection.createEl("h4", { text: "Deleted properties:" });
 			const deletedList = deletedSection.createEl("ul");
 
 			for (const change of this.options.diff.deleted) {
 				deletedList.createEl("li", {
 					text: formatChangeForDisplay(change),
-					cls: "prisma-change-deleted",
+					cls: `${prefix}-change-deleted`,
 				});
 			}
 		}
 
-		const buttonContainer = contentEl.createDiv({ cls: "prisma-modal-buttons" });
+		const buttonContainer = contentEl.createDiv({ cls: `${prefix}-modal-buttons` });
 
 		const yesButton = buttonContainer.createEl("button", {
 			text: "Yes, propagate",

package/src/core/index.ts

@@ -4,5 +4,6 @@ export * from "./evaluator";
 export * from "./expression-utils";
 export * from "./frontmatter-value";
 export * from "./generate";
+export * from "./indexer";
 export * from "./property-renderer";
 export * from "./validation";

package/src/core/indexer.ts

@@ -0,0 +1,353 @@
+import { type App, type MetadataCache, type TAbstractFile, TFile, type Vault } from "obsidian";
+import {
+	type BehaviorSubject,
+	from,
+	fromEventPattern,
+	lastValueFrom,
+	merge,
+	type Observable,
+	of,
+	BehaviorSubject as RxBehaviorSubject,
+	Subject,
+	type Subscription,
+} from "rxjs";
+import { debounceTime, filter, groupBy, map, mergeMap, switchMap, toArray } from "rxjs/operators";
+import { isFileInConfiguredDirectory } from "../file/file";
+import { compareFrontmatter, type FrontmatterDiff } from "../file/frontmatter-diff";
+
+/**
+ * Generic frontmatter object type for indexer
+ */
+export type IndexerFrontmatter = Record<string, unknown>;
+
+/**
+ * Configuration for the generic indexer
+ */
+export interface IndexerConfig {
+	/**
+	 * Directory to scan for files (e.g., "Calendar", "Notes")
+	 * If empty string or undefined, scans entire vault
+	 */
+	directory?: string;
+
+	/**
+	 * Properties to exclude when comparing frontmatter diffs
+	 */
+	excludedDiffProps?: Set<string>;
+
+	/**
+	 * Concurrency limit for file scanning operations
+	 */
+	scanConcurrency?: number;
+
+	/**
+	 * Debounce time in milliseconds for file change events
+	 */
+	debounceMs?: number;
+}
+
+/**
+ * Raw file source with frontmatter and metadata
+ */
+export interface FileSource {
+	filePath: string;
+	mtime: number;
+	frontmatter: IndexerFrontmatter;
+	folder: string;
+}
+
+/**
+ * Types of indexer events
+ */
+export type IndexerEventType = "file-changed" | "file-deleted";
+
+/**
+ * Generic indexer event
+ */
+export interface IndexerEvent {
+	type: IndexerEventType;
+	filePath: string;
+	oldPath?: string;
+	source?: FileSource;
+	oldFrontmatter?: IndexerFrontmatter;
+	frontmatterDiff?: FrontmatterDiff;
+}
+
+type VaultEvent = "create" | "modify" | "delete" | "rename";
+
+type FileIntent =
+	| { kind: "changed"; file: TFile; path: string; oldPath?: string }
+	| { kind: "deleted"; path: string };
+
+/**
+ * Generic indexer that listens to Obsidian vault events and emits
+ * RxJS observables with frontmatter diffs and metadata.
+ *
+ * This indexer is framework-agnostic and can be used by any plugin
+ * that needs to track file changes with frontmatter.
+ */
+export class Indexer {
+	private config: Required<IndexerConfig>;
+	private fileSub: Subscription | null = null;
+	private configSubscription: Subscription | null = null;
+	private vault: Vault;
+	private metadataCache: MetadataCache;
+	private scanEventsSubject = new Subject<IndexerEvent>();
+	private indexingCompleteSubject = new RxBehaviorSubject<boolean>(false);
+	private frontmatterCache: Map<string, IndexerFrontmatter> = new Map();
+
+	public readonly events$: Observable<IndexerEvent>;
+	public readonly indexingComplete$: Observable<boolean>;
+
+	constructor(_app: App, configStore: BehaviorSubject<IndexerConfig>) {
+		this.vault = _app.vault;
+		this.metadataCache = _app.metadataCache;
+
+		// Set defaults
+		this.config = {
+			directory: configStore.value.directory || "",
+			excludedDiffProps: configStore.value.excludedDiffProps || new Set(),
+			scanConcurrency: configStore.value.scanConcurrency || 10,
+			debounceMs: configStore.value.debounceMs || 100,
+		};
+
+		// Subscribe to config changes
+		this.configSubscription = configStore.subscribe((newConfig) => {
+			const directoryChanged = this.config.directory !== (newConfig.directory || "");
+
+			this.config = {
+				directory: newConfig.directory || "",
+				excludedDiffProps: newConfig.excludedDiffProps || new Set(),
+				scanConcurrency: newConfig.scanConcurrency || 10,
+				debounceMs: newConfig.debounceMs || 100,
+			};
+
+			// Rescan if directory changed
+			if (directoryChanged) {
+				this.indexingCompleteSubject.next(false);
+				void this.scanAllFiles();
+			}
+		});
+
+		this.events$ = this.scanEventsSubject.asObservable();
+		this.indexingComplete$ = this.indexingCompleteSubject.asObservable();
+	}
+
+	/**
+	 * Start the indexer and perform initial scan
+	 */
+	async start(): Promise<void> {
+		this.indexingCompleteSubject.next(false);
+
+		const fileSystemEvents$ = this.buildFileSystemEvents$();
+
+		this.fileSub = fileSystemEvents$.subscribe((event) => {
+			this.scanEventsSubject.next(event);
+		});
+
+		await this.scanAllFiles();
+	}
+
+	/**
+	 * Stop the indexer and clean up subscriptions
+	 */
+	stop(): void {
+		this.fileSub?.unsubscribe();
+		this.fileSub = null;
+		this.configSubscription?.unsubscribe();
+		this.configSubscription = null;
+		this.indexingCompleteSubject.complete();
+	}
+
+	/**
+	 * Clear cache and rescan all files
+	 */
+	resync(): void {
+		this.frontmatterCache.clear();
+		this.indexingCompleteSubject.next(false);
+		void this.scanAllFiles();
+	}
+
+	/**
+	 * Scan all markdown files in the configured directory
+	 */
+	private async scanAllFiles(): Promise<void> {
+		const allFiles = this.vault.getMarkdownFiles();
+		const relevantFiles = allFiles.filter((file) => this.isRelevantFile(file));
+
+		const events$ = from(relevantFiles).pipe(
+			mergeMap(async (file) => {
+				try {
+					return await this.buildEvent(file);
+				} catch (error) {
+					console.error(`Error processing file ${file.path}:`, error);
+					return null;
+				}
+			}, this.config.scanConcurrency),
+			filter((event): event is IndexerEvent => event !== null),
+			toArray()
+		);
+
+		try {
+			const allEvents = await lastValueFrom(events$);
+
+			for (const event of allEvents) {
+				this.scanEventsSubject.next(event);
+			}
+
+			this.indexingCompleteSubject.next(true);
+		} catch (error) {
+			console.error("❌ Error during file scanning:", error);
+			this.indexingCompleteSubject.next(true);
+		}
+	}
+
+	/**
+	 * Create an observable from a vault event
+	 */
+	private fromVaultEvent(eventName: VaultEvent): Observable<TAbstractFile> {
+		if (eventName === "create") {
+			return fromEventPattern<TAbstractFile>(
+				(handler) => this.vault.on("create", handler),
+				(handler) => this.vault.off("create", handler)
+			);
+		}
+
+		if (eventName === "modify") {
+			return fromEventPattern<TAbstractFile>(
+				(handler) => this.vault.on("modify", handler),
+				(handler) => this.vault.off("modify", handler)
+			);
+		}
+
+		if (eventName === "delete") {
+			return fromEventPattern<TAbstractFile>(
+				(handler) => this.vault.on("delete", handler),
+				(handler) => this.vault.off("delete", handler)
+			);
+		}
+
+		// eventName === "rename"
+		return fromEventPattern<[TAbstractFile, string]>(
+			(handler) => this.vault.on("rename", handler),
+			(handler) => this.vault.off("rename", handler)
+		).pipe(map(([file]) => file));
+	}
+
+	/**
+	 * Type guard to check if file is a markdown file
+	 */
+	private static isMarkdownFile(f: TAbstractFile): f is TFile {
+		return f instanceof TFile && f.extension === "md";
+	}
+
+	/**
+	 * Filter to only relevant markdown files in configured directory
+	 */
+	private toRelevantFiles<T extends TAbstractFile>() {
+		return (source: Observable<T>) =>
+			source.pipe(
+				filter((f: TAbstractFile): f is TFile => Indexer.isMarkdownFile(f)),
+				filter((f) => this.isRelevantFile(f))
+			);
+	}
+
+	/**
+	 * Debounce events by file path
+	 */
+	private debounceByPath<T>(ms: number, key: (x: T) => string) {
+		return (source: Observable<T>) =>
+			source.pipe(
+				groupBy(key),
+				mergeMap((g$) => g$.pipe(debounceTime(ms)))
+			);
+	}
+
+	/**
+	 * Build the file system events observable stream
+	 */
+	private buildFileSystemEvents$(): Observable<IndexerEvent> {
+		const created$ = this.fromVaultEvent("create").pipe(this.toRelevantFiles());
+		const modified$ = this.fromVaultEvent("modify").pipe(this.toRelevantFiles());
+		const deleted$ = this.fromVaultEvent("delete").pipe(this.toRelevantFiles());
+
+		const renamed$ = fromEventPattern<[TAbstractFile, string]>(
+			(handler) => this.vault.on("rename", handler),
+			(handler) => this.vault.off("rename", handler)
+		);
+
+		const changedIntents$ = merge(created$, modified$).pipe(
+			this.debounceByPath(this.config.debounceMs, (f) => f.path),
+			map((file): FileIntent => ({ kind: "changed", file, path: file.path }))
+		);
+
+		const deletedIntents$ = deleted$.pipe(
+			map((file): FileIntent => ({ kind: "deleted", path: file.path }))
+		);
+
+		const renamedIntents$ = renamed$.pipe(
+			map(([f, oldPath]) => [f, oldPath] as const),
+			filter(([f]) => Indexer.isMarkdownFile(f) && this.isRelevantFile(f)),
+			mergeMap(([f, oldPath]) => [
+				{ kind: "deleted", path: oldPath } as FileIntent,
+				{ kind: "changed", file: f, path: f.path, oldPath } as FileIntent,
+			])
+		);
+
+		const intents$ = merge(changedIntents$, deletedIntents$, renamedIntents$);
+
+		return intents$.pipe(
+			switchMap((intent) => {
+				if (intent.kind === "deleted") {
+					this.frontmatterCache.delete(intent.path);
+					return of<IndexerEvent>({ type: "file-deleted", filePath: intent.path });
+				}
+
+				return from(this.buildEvent(intent.file, intent.oldPath)).pipe(
+					filter((e): e is IndexerEvent => e !== null)
+				);
+			})
+		);
+	}
+
+	/**
+	 * Build an indexer event from a file
+	 */
+	private async buildEvent(file: TFile, oldPath?: string): Promise<IndexerEvent | null> {
+		const cache = this.metadataCache.getFileCache(file);
+		if (!cache || !cache.frontmatter) return null;
+
+		const { frontmatter } = cache;
+		const oldFrontmatter = this.frontmatterCache.get(file.path);
+
+		const source: FileSource = {
+			filePath: file.path,
+			mtime: file.stat.mtime,
+			frontmatter,
+			folder: file.parent?.path || "",
+		};
+
+		const event: IndexerEvent = {
+			type: "file-changed",
+			filePath: file.path,
+			oldPath,
+			source,
+			oldFrontmatter,
+			frontmatterDiff: oldFrontmatter
+				? compareFrontmatter(oldFrontmatter, frontmatter, this.config.excludedDiffProps)
+				: undefined,
+		};
+
+		// Update cache
+		this.frontmatterCache.set(file.path, { ...frontmatter });
+
+		return event;
+	}
+
+	/**
+	 * Check if file is in the configured directory
+	 */
+	private isRelevantFile(file: TFile): boolean {
+		return isFileInConfiguredDirectory(file.path, this.config.directory);
+	}
+}

package/src/file/frontmatter-propagation.ts

@@ -0,0 +1,59 @@
+import type { App } from "obsidian";
+import { TFile } from "obsidian";
+import type { Frontmatter, FrontmatterDiff } from "./frontmatter-diff";
+
+export interface NexusPropertiesSettings {
+	excludedPropagatedProps?: string;
+	parentProp: string;
+	childrenProp: string;
+	relatedProp: string;
+	zettelIdProp: string;
+}
+
+export function parseExcludedProps(settings: NexusPropertiesSettings): Set<string> {
+	const excludedPropsStr = settings.excludedPropagatedProps || "";
+	const userExcluded = excludedPropsStr
+		.split(",")
+		.map((prop) => prop.trim())
+		.filter((prop) => prop.length > 0);
+
+	const alwaysExcluded = [
+		settings.parentProp,
+		settings.childrenProp,
+		settings.relatedProp,
+		settings.zettelIdProp,
+	];
+
+	return new Set([...alwaysExcluded, ...userExcluded]);
+}
+
+export async function applyFrontmatterChanges(
+	app: App,
+	targetPath: string,
+	sourceFrontmatter: Frontmatter,
+	diff: FrontmatterDiff
+): Promise<void> {
+	try {
+		const file = app.vault.getAbstractFileByPath(targetPath);
+		if (!(file instanceof TFile)) {
+			console.warn(`Target file not found: ${targetPath}`);
+			return;
+		}
+
+		await app.fileManager.processFrontMatter(file, (fm) => {
+			for (const change of diff.added) {
+				fm[change.key] = sourceFrontmatter[change.key];
+			}
+
+			for (const change of diff.modified) {
+				fm[change.key] = sourceFrontmatter[change.key];
+			}
+
+			for (const change of diff.deleted) {
+				delete fm[change.key];
+			}
+		});
+	} catch (error) {
+		console.error(`Error applying frontmatter changes to ${targetPath}:`, error);
+	}
+}

package/src/file/index.ts

@@ -4,6 +4,7 @@ export * from "./file-operations";
 export * from "./file-utils";
 export * from "./frontmatter";
 export * from "./frontmatter-diff";
+export * from "./frontmatter-propagation";
 export * from "./link-parser";
 export * from "./property-utils";
 export * from "./templater";

package/src/file/templater.ts

@@ -1,4 +1,4 @@
-import { type App, Notice, normalizePath, type TFile } from "obsidian";
+import { type App, Notice, normalizePath, TFile } from "obsidian";
 
 const TEMPLATER_ID = "templater-obsidian";
 
@@ -13,6 +13,16 @@ interface TemplaterLike {
 	create_new_note_from_template: CreateFn;
 }
 
+export interface FileCreationOptions {
+	title: string;
+	targetDirectory: string;
+	filename?: string;
+	content?: string;
+	frontmatter?: Record<string, unknown>;
+	templatePath?: string;
+	useTemplater?: boolean;
+}
+
 async function waitForTemplater(app: App, timeoutMs = 8000): Promise<TemplaterLike | null> {
 	await new Promise<void>((resolve) => app.workspace.onLayoutReady(resolve));
 
@@ -73,3 +83,49 @@ export async function createFromTemplate(
 		return null;
 	}
 }
+
+export async function createFileWithTemplate(
+	app: App,
+	options: FileCreationOptions
+): Promise<TFile> {
+	const { title, targetDirectory, filename, content, frontmatter, templatePath, useTemplater } =
+		options;
+
+	const finalFilename = filename || title;
+	const baseName = finalFilename.replace(/\.md$/, "");
+	const filePath = normalizePath(`${targetDirectory}/${baseName}.md`);
+
+	const existingFile = app.vault.getAbstractFileByPath(filePath);
+	if (existingFile instanceof TFile) {
+		return existingFile;
+	}
+
+	if (useTemplater && templatePath && templatePath.trim() !== "" && isTemplaterAvailable(app)) {
+		const templateFile = await createFromTemplate(
+			app,
+			templatePath,
+			targetDirectory,
+			finalFilename
+		);
+
+		if (templateFile) {
+			if (frontmatter && Object.keys(frontmatter).length > 0) {
+				await app.fileManager.processFrontMatter(templateFile, (fm) => {
+					Object.assign(fm, frontmatter);
+				});
+			}
+			return templateFile;
+		}
+	}
+
+	const fileContent = content || "";
+	const file = await app.vault.create(filePath, fileContent);
+
+	if (frontmatter && Object.keys(frontmatter).length > 0) {
+		await app.fileManager.processFrontMatter(file, (fm) => {
+			Object.assign(fm, frontmatter);
+		});
+	}
+
+	return file;
+}