@chronicle.app/obsidian 0.3.0 → 0.5.0

package/dist/connectors/ObsidianExtractor.d.ts

@@ -1,4 +1,4 @@
-import { Extractor, Record } from '@chronicle.app/etl';
+import { Extractor, Record, type Survey, type SurveyOptions } from '@chronicle.app/etl';
 import ObsidianTransformer from './ObsidianTransformer.js';
 export interface VaultNote {
     /** Path relative to the enclosing vault, including .md. */
@@ -41,6 +41,8 @@ export declare class ObsidianExtractor extends Extractor<typeof ObsidianExtracto
     protected asOfTime(): Date;
     keyOf(record: Record): string | null;
     determineCount(): Promise<number | null>;
+    /** The notes a run reads and when they were last edited, from the file list setup made. */
+    survey(options?: SurveyOptions): Promise<Survey>;
     extract(): AsyncGenerator<Record>;
     private readNote;
     /** Ignore hidden files/directories and symlinks; only Markdown is imported. */

package/dist/connectors/ObsidianExtractor.js

@@ -1,6 +1,6 @@
 import { promises as fs } from 'node:fs';
 import path from 'node:path';
-import { Extractor } from '@chronicle.app/etl';
+import { Extractor, countMonth } from '@chronicle.app/etl';
 import { load, CORE_SCHEMA } from 'js-yaml';
 import { z } from 'zod';
 import ObsidianTransformer from './ObsidianTransformer.js';
@@ -85,6 +85,22 @@ export class ObsidianExtractor extends Extractor {
         const limit = this.getEffectiveLimit();
         return limit === null ? this.entries.length : Math.min(limit, this.entries.length);
     }
+    /** The notes a run reads and when they were last edited, from the file list setup made. */
+    async survey(options = {}) {
+        // Newest first, so the ends are the latest and earliest edits.
+        const [newest, oldest] = [this.entries[0], this.entries.at(-1)];
+        const byMonth = {};
+        if (options.byMonth)
+            for (const entry of this.entries)
+                countMonth(byMonth, entry.mtime);
+        return {
+            notes: {
+                count: this.entries.length,
+                ...(newest && oldest && { earliest: oldest.mtime, latest: newest.mtime }),
+                ...(options.byMonth && { byMonth }),
+            },
+        };
+    }
     async *extract() {
         let count = 0;
         for (const entry of this.entries) {

package/dist/connectors/ObsidianLocator.d.ts

@@ -0,0 +1,12 @@
+import { Locator, type Candidate, type LocationMatch } from '@chronicle.app/etl';
+/**
+ * The vaults Obsidian has opened, from its registry, `obsidian.json`: one
+ * candidate each, its folder the run's input. A vault Obsidian remembers
+ * but that has since moved or gone isn't found, so it isn't offered.
+ */
+export declare class ObsidianLocator extends Locator {
+    static source: string;
+    static strategy: string;
+    locate(matches: LocationMatch[]): AsyncGenerator<Candidate>;
+}
+//# sourceMappingURL=ObsidianLocator.d.ts.map

package/dist/connectors/ObsidianLocator.js

@@ -0,0 +1,36 @@
+import { readFile } from 'node:fs/promises';
+import path from 'node:path';
+import { Locator } from '@chronicle.app/etl';
+/**
+ * The vaults Obsidian has opened, from its registry, `obsidian.json`: one
+ * candidate each, its folder the run's input. A vault Obsidian remembers
+ * but that has since moved or gone isn't found, so it isn't offered.
+ */
+export class ObsidianLocator extends Locator {
+    static source = 'obsidian';
+    static strategy = 'vault';
+    async *locate(matches) {
+        for (const match of matches) {
+            let vaults;
+            try {
+                vaults = JSON.parse(await readFile(match.path, 'utf8'))?.vaults ?? {};
+            }
+            catch {
+                continue;
+            }
+            for (const vault of Object.values(vaults)) {
+                if (typeof vault?.path !== 'string')
+                    continue;
+                const { home } = this.context;
+                const where = vault.path.startsWith(home + path.sep)
+                    ? `~${vault.path.slice(home.length)}`
+                    : vault.path;
+                yield {
+                    label: where,
+                    config: { input: vault.path },
+                    path: vault.path,
+                };
+            }
+        }
+    }
+}

package/dist/index.d.ts

@@ -1,3 +1,4 @@
 export { ObsidianExtractor } from './connectors/ObsidianExtractor.js';
+export { ObsidianLocator } from './connectors/ObsidianLocator.js';
 export { default as ObsidianTransformer } from './connectors/ObsidianTransformer.js';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -1,2 +1,3 @@
 export { ObsidianExtractor } from './connectors/ObsidianExtractor.js';
+export { ObsidianLocator } from './connectors/ObsidianLocator.js';
 export { default as ObsidianTransformer } from './connectors/ObsidianTransformer.js';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@chronicle.app/obsidian",
-  "version": "0.3.0",
+  "version": "0.5.0",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "files": [
@@ -22,9 +22,9 @@
   "type": "module",
   "description": "Chronicle plugin for Obsidian Markdown documents and note links",
   "devDependencies": {
-    "@chronicle.app/etl": "0.3.0",
-    "@chronicle.app/schema": "0.3.0",
-    "@chronicle.app/tsconfig": "0.3.0",
+    "@chronicle.app/etl": "0.5.0",
+    "@chronicle.app/schema": "0.5.0",
+    "@chronicle.app/tsconfig": "0.5.0",
     "@types/js-yaml": "^4.0.9",
     "@types/node": "^22.10.1",
     "typescript": "^5.7.2"
@@ -66,10 +66,29 @@
             "recordTypes": [
               "notes"
             ],
-            "default": true
+            "default": true,
+            "locations": [
+              {
+                "path": "~/Library/Application Support/obsidian/obsidian.json",
+                "platforms": [
+                  "darwin"
+                ]
+              },
+              {
+                "path": "~/.config/obsidian/obsidian.json",
+                "platforms": [
+                  "linux"
+                ]
+              }
+            ]
           }
         }
       }
+    },
+    "deepLinks": {
+      "obsidian": {
+        "*": "obsidian://open?vault={inRealm.handle}&file={handle}"
+      }
     }
   }
 }