@chronicle.app/shell 0.3.0 → 0.5.0

package/dist/connectors/ShellHistoryExtractor.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 { z } from 'zod';
 import ShellHistoryTransformer from './ShellHistoryTransformer.js';
 export declare class ShellHistoryExtractor extends Extractor<typeof ShellHistoryExtractor> {
@@ -41,6 +41,11 @@ export declare class ShellHistoryExtractor extends Extractor<typeof ShellHistory
     private parseZshHistory;
     private parseBashHistory;
     private parseFishHistory;
+    /**
+     * The commands a run reads and when, from one pass over the history file,
+     * which stays small. Commands without a time count, but date nothing.
+     */
+    survey(options?: SurveyOptions): Promise<Survey>;
     determineCount(): Promise<number | null>;
 }
 //# sourceMappingURL=ShellHistoryExtractor.d.ts.map

package/dist/connectors/ShellHistoryExtractor.js

@@ -1,4 +1,4 @@
-import { Extractor } from '@chronicle.app/etl';
+import { Extractor, countMonth, fileError, } from '@chronicle.app/etl';
 import { readFile, access } from 'node:fs/promises';
 import { z } from 'zod';
 import os from 'node:os';
@@ -25,7 +25,9 @@ export class ShellHistoryExtractor extends Extractor {
     });
     async detectShellType() {
         if (this.config.input) {
-            const content = await readFile(this.config.input, 'utf8');
+            const content = await readFile(this.config.input, 'utf8').catch(error => {
+                throw fileError(error, this.config.input, 'shell history');
+            });
             if (/^: \d+:\d+;/m.test(content))
                 return 'zsh';
             if (/^- cmd: /m.test(content))
@@ -101,6 +103,9 @@ export class ShellHistoryExtractor extends Extractor {
             }
         }
         catch (error) {
+            const typed = fileError(error, inputPath, `${shellType} history`);
+            if (typed !== error)
+                throw typed;
             throw new Error(`Failed to read ${shellType} history file from ${inputPath}: ${error}`);
         }
     }
@@ -263,6 +268,37 @@ export class ShellHistoryExtractor extends Extractor {
         }
         yield* this.yieldNewestFirst(entries);
     }
+    /**
+     * The commands a run reads and when, from one pass over the history file,
+     * which stays small. Commands without a time count, but date nothing.
+     */
+    async survey(options = {}) {
+        // Every command in range, whatever the run's limit.
+        const all = new ShellHistoryExtractor({ ...this.config, limit: undefined });
+        let count = 0;
+        let earliest;
+        let latest;
+        const byMonth = {};
+        for await (const { data } of all.extract()) {
+            count++;
+            if (!data.timestamp)
+                continue;
+            const time = new Date(data.timestamp);
+            if (!earliest || time < earliest)
+                earliest = time;
+            if (!latest || time > latest)
+                latest = time;
+            if (options.byMonth)
+                countMonth(byMonth, time);
+        }
+        return {
+            commands: {
+                count,
+                ...(earliest && { earliest, latest }),
+                ...(options.byMonth && { byMonth }),
+            },
+        };
+    }
     async determineCount() {
         const config = this.config;
         try {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@chronicle.app/shell",
-  "version": "0.3.0",
+  "version": "0.5.0",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "files": [
@@ -19,9 +19,9 @@
   "type": "module",
   "description": "Chronicle shell extraction plugin",
   "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/node": "^22.10.1",
     "typescript": "^5.7.2"
   },
@@ -61,7 +61,24 @@
             "recordTypes": [
               "commands"
             ],
-            "default": true
+            "default": true,
+            "locations": [
+              {
+                "path": "~/.zsh_history"
+              },
+              {
+                "path": "~/.bash_history",
+                "options": {
+                  "shell": "bash"
+                }
+              },
+              {
+                "path": "~/.local/share/fish/fish_history",
+                "options": {
+                  "shell": "fish"
+                }
+              }
+            ]
           }
         }
       }