@cyberismo/data-handler 0.0.21 → 0.0.22

package/dist/utils/user-preferences.js.map

@@ -1 +1 @@
-{"version":3,"file":"user-preferences.js","sourceRoot":"","sources":["../../src/utils/user-preferences.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;EAUE;AACF,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAE7E,OAAO,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAC3C,OAAO,EAAE,UAAU,EAAE,MAAM,WAAW,CAAC;AACvC,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AAgBvD;;;GAGG;AACH,MAAM,OAAO,eAAe;IA8DN;IA7DpB,oDAAoD;IACpD,uBAAuB;IACvB,MAAM,CAAC,QAAQ,GAAG;QAChB,WAAW,EAAE;YACX,MAAM,EAAE;gBACN,OAAO,EAAE,MAAM;gBACf,IAAI,EAAE,CAAC,qBAAqB,EAAE,kBAAkB,CAAC;aAClD;YACD,KAAK,EAAE;gBACL,OAAO,EAAE,IAAI;gBACb,IAAI,EAAE,CAAC,qBAAqB,EAAE,kBAAkB,CAAC;aAClD;YACD,KAAK,EAAE;gBACL,OAAO,EAAE,aAAa;gBACtB,IAAI,EAAE,CAAC,qBAAqB,EAAE,kBAAkB,CAAC;aAClD;SACF;QACD,iBAAiB,EAAE;YACjB,MAAM,EAAE;gBACN;oBACE,QAAQ,EAAE,WAAW;oBACrB,OAAO,EAAE,sCAAsC;iBAChD;gBACD;oBACE,QAAQ,EAAE,eAAe;oBACzB,OAAO,EAAE,sCAAsC;iBAChD;gBACD;oBACE,QAAQ,EAAE,iBAAiB;oBAC3B,OAAO,EAAE,sCAAsC;iBAChD;aACF;YACD,KAAK,EAAE;gBACL;oBACE,QAAQ,EAAE,WAAW;oBACrB,OAAO,EAAE,2BAA2B;iBACrC;gBACD;oBACE,QAAQ,EAAE,eAAe;oBACzB,OAAO,EAAE,2BAA2B;iBACrC;aACF;YACD,KAAK,EAAE;gBACL;oBACE,QAAQ,EAAE,YAAY;oBACtB,OAAO,EAAE,gCAAgC;iBAC1C;gBACD;oBACE,QAAQ,EAAE,WAAW;oBACrB,OAAO,EACL,gEAAgE;iBACnE;gBACD;oBACE,QAAQ,EAAE,eAAe;oBACzB,OAAO,EACL,gEAAgE;iBACnE;aACF;SACF;KACF,CAAC;IAEF,YAAoB,aAAqB;QAArB,kBAAa,GAAb,aAAa,CAAQ;QACvC,kEAAkE;QAClE,MAAM,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QAE7C,IAAI,CAAC;YACH,gCAAgC;YAChC,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC;gBAC1B,SAAS,CAAC,QAAQ,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;YAC3C,CAAC;YAED,iDAAiD;YACjD,mDAAmD;YACnD,aAAa,CAAC,IAAI,CAAC,aAAa,EAAE,UAAU,CAAC,eAAe,CAAC,QAAQ,CAAC,EAAE;gBACtE,IAAI,EAAE,IAAI;aACX,CAAC,CAAC;QACL,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;gBACnB,6EAA6E;gBAC7E,IAAI,KAAK,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;oBAC5B,MAAM,IAAI,KAAK,CACb,oCAAoC,IAAI,CAAC,aAAa,MAAM,KAAK,EAAE,CACpE,CAAC;gBACJ,CAAC;qBAAM,CAAC;oBACN,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,iCAAiC,CAAC,CAAC;gBACtD,CAAC;YACH,CAAC;iBAAM,CAAC;gBACN,MAAM,IAAI,KAAK,CACb,oCAAoC,IAAI,CAAC,aAAa,MAAM,KAAK,EAAE,CACpE,CAAC;YACJ,CAAC;QACH,CAAC;IACH,CAAC;IAED,IAAY,MAAM;QAChB,OAAO,cAAc,CAAC;YACpB,MAAM,EAAE,iBAAiB;SAC1B,CAAC,CAAC;IACL,CAAC;IAEM,cAAc;QACnB,sCAAsC;QACtC,IAAI,CAAC;YACH,OAAO,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,IAAI,CAAC,aAAa,EAAE,MAAM,CAAC,CAAC,CAAC;QAC9D,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,IAAI,KAAK,CACb,mCAAmC,IAAI,CAAC,aAAa,MAAM,KAAK,EAAE,CACnE,CAAC;QACJ,CAAC;IACH,CAAC"}
+{"version":3,"file":"user-preferences.js","sourceRoot":"","sources":["../../src/utils/user-preferences.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;EAUE;AACF,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAE7E,OAAO,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAC3C,OAAO,EAAE,UAAU,EAAE,MAAM,WAAW,CAAC;AACvC,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AAgBvD;;;GAGG;AACH,MAAM,OAAO,eAAe;IA8DN;IA7DpB,oDAAoD;IACpD,uBAAuB;IACvB,MAAM,CAAC,QAAQ,GAAG;QAChB,WAAW,EAAE;YACX,MAAM,EAAE;gBACN,OAAO,EAAE,MAAM;gBACf,IAAI,EAAE,CAAC,qBAAqB,EAAE,kBAAkB,CAAC;aAClD;YACD,KAAK,EAAE;gBACL,OAAO,EAAE,IAAI;gBACb,IAAI,EAAE,CAAC,qBAAqB,EAAE,kBAAkB,CAAC;aAClD;YACD,KAAK,EAAE;gBACL,OAAO,EAAE,aAAa;gBACtB,IAAI,EAAE,CAAC,qBAAqB,EAAE,kBAAkB,CAAC;aAClD;SACF;QACD,iBAAiB,EAAE;YACjB,MAAM,EAAE;gBACN;oBACE,QAAQ,EAAE,WAAW;oBACrB,OAAO,EAAE,sCAAsC;iBAChD;gBACD;oBACE,QAAQ,EAAE,eAAe;oBACzB,OAAO,EAAE,sCAAsC;iBAChD;gBACD;oBACE,QAAQ,EAAE,iBAAiB;oBAC3B,OAAO,EAAE,sCAAsC;iBAChD;aACF;YACD,KAAK,EAAE;gBACL;oBACE,QAAQ,EAAE,WAAW;oBACrB,OAAO,EAAE,2BAA2B;iBACrC;gBACD;oBACE,QAAQ,EAAE,eAAe;oBACzB,OAAO,EAAE,2BAA2B;iBACrC;aACF;YACD,KAAK,EAAE;gBACL;oBACE,QAAQ,EAAE,YAAY;oBACtB,OAAO,EAAE,gCAAgC;iBAC1C;gBACD;oBACE,QAAQ,EAAE,WAAW;oBACrB,OAAO,EACL,gEAAgE;iBACnE;gBACD;oBACE,QAAQ,EAAE,eAAe;oBACzB,OAAO,EACL,gEAAgE;iBACnE;aACF;SACF;KACF,CAAC;IAEF,YAAoB,aAAqB;QAArB,kBAAa,GAAb,aAAa,CAAQ;QACvC,kEAAkE;QAClE,MAAM,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QAE7C,IAAI,CAAC;YACH,gCAAgC;YAChC,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC;gBAC1B,SAAS,CAAC,QAAQ,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;YAC3C,CAAC;YAED,iDAAiD;YACjD,mDAAmD;YACnD,aAAa,CAAC,IAAI,CAAC,aAAa,EAAE,UAAU,CAAC,eAAe,CAAC,QAAQ,CAAC,EAAE;gBACtE,IAAI,EAAE,IAAI;aACX,CAAC,CAAC;QACL,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;gBACnB,6EAA6E;gBAC7E,IAAI,KAAK,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;oBAC5B,MAAM,IAAI,KAAK,CACb,oCAAoC,IAAI,CAAC,aAAa,MAAM,KAAK,EAAE,EACnE,EAAE,KAAK,EAAE,KAAK,EAAE,CACjB,CAAC;gBACJ,CAAC;qBAAM,CAAC;oBACN,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,iCAAiC,CAAC,CAAC;gBACtD,CAAC;YACH,CAAC;iBAAM,CAAC;gBACN,MAAM,IAAI,KAAK,CACb,oCAAoC,IAAI,CAAC,aAAa,MAAM,KAAK,EAAE,EACnE,EAAE,KAAK,EAAE,KAAK,EAAE,CACjB,CAAC;YACJ,CAAC;QACH,CAAC;IACH,CAAC;IAED,IAAY,MAAM;QAChB,OAAO,cAAc,CAAC;YACpB,MAAM,EAAE,iBAAiB;SAC1B,CAAC,CAAC;IACL,CAAC;IAEM,cAAc;QACnB,sCAAsC;QACtC,IAAI,CAAC;YACH,OAAO,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,IAAI,CAAC,aAAa,EAAE,MAAM,CAAC,CAAC,CAAC;QAC9D,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,IAAI,KAAK,CACb,mCAAmC,IAAI,CAAC,aAAa,MAAM,KAAK,EAAE,EAClE,EAAE,KAAK,EAAE,KAAK,EAAE,CACjB,CAAC;QACJ,CAAC;IACH,CAAC"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@cyberismo/data-handler",
   "description": "Command handler for cards and web service",
-  "version": "0.0.21",
+  "version": "0.0.22",
   "author": "sami.merila@cyberismo.com",
   "license": "AGPL-3.0",
   "homepage": "https://github.com/CyberismoCom/cyberismo",
@@ -21,9 +21,9 @@
     "@types/jsdom": "^21.1.7",
     "@types/json-schema": "^7.0.15",
     "@types/sinon": "^21.0.0",
-    "c8": "^10.1.3",
+    "c8": "^11.0.0",
     "pino-pretty": "^13.1.3",
-    "sinon": "^21.0.0"
+    "sinon": "^21.0.1"
   },
   "dependencies": {
     "@asciidoctor/core": "^3.0.4",
@@ -46,9 +46,9 @@
     "vega": "^6.2.0",
     "vega-lite": "^6.4.2",
     "write-json-file": "^7.0.0",
-    "@cyberismo/assets": "0.0.21",
+    "@cyberismo/migrations": "0.0.22",
     "@cyberismo/node-clingo": "1.3.4",
-    "@cyberismo/migrations": "0.0.21"
+    "@cyberismo/assets": "0.0.22"
   },
   "type": "module",
   "files": [

package/src/command-handler.ts

@@ -163,12 +163,10 @@ export class Commands {
     const path = options.projectPath || '';
     this.projectPath = resolveTilde(await this.setProjectPath(path));
     if (!Validate.validateFolder(this.projectPath)) {
-      let errorMessage = '';
-      if (path === '' || path === undefined) {
-        errorMessage = `No 'cardRoot' in the current folder`;
-      } else {
-        errorMessage = `Input validation error: folder name '${path}' is invalid`;
-      }
+      const errorMessage =
+        path === '' || path === undefined
+          ? `No 'cardRoot' in the current folder`
+          : `Input validation error: folder name '${path}' is invalid`;
       throw new Error(errorMessage);
     }
 
@@ -180,6 +178,7 @@ export class Commands {
       logLevel: options.logLevel,
       watchResourceChanges: (options as StartCommandOptions)
         .watchResourceChanges,
+      autocommit: (options as StartCommandOptions).autocommit,
     });
     if (!this.commands) {
       throw new Error('Cannot get instance of CommandManager');
@@ -426,6 +425,7 @@ export class Commands {
           } catch (error) {
             throw new Error(
               `Failed to read mapping file: ${errorFunction(error)}`,
+              { cause: error },
             );
           }
         }
@@ -574,7 +574,7 @@ export class Commands {
       return { statusCode: 500 };
     }
     process.env.EXPORT_FORMAT = format;
-    let message = '';
+    let message: string;
     if (format === 'pdf') {
       const options = {
         title: pdfOptions?.title || 'Title',
@@ -717,7 +717,7 @@ export class Commands {
     }
 
     const { name, parameters } = parametersFile;
-    let result: string | undefined = '';
+    let result: string | undefined;
     try {
       result = await this.commands?.showCmd.showReportResults(
         name,
@@ -758,12 +758,9 @@ export class Commands {
       case 'attachments':
         promise = this.commands!.showCmd.showAttachments();
         break;
-      case 'card': {
-        return {
-          statusCode: 200,
-          payload: this.commands!.showCmd.showCardDetails(detail),
-        };
-      }
+      case 'card':
+        promise = this.commands!.showCmd.showCardDetails(detail);
+        break;
       case 'cards':
         promise = this.commands!.showCmd.showCards();
         break;
@@ -796,10 +793,8 @@ export class Commands {
         );
         break;
       case 'labels':
-        return {
-          statusCode: 200,
-          payload: this.commands!.showCmd.showLabels(),
-        };
+        promise = this.commands!.showCmd.showLabels();
+        break;
       case 'module':
         promise = this.commands!.showCmd.showModule(detail);
         break;
@@ -807,10 +802,7 @@ export class Commands {
         promise = this.commands!.showCmd.showHubs();
         break;
       case 'modules':
-        return {
-          statusCode: 200,
-          payload: this.commands!.showCmd.showModules(),
-        };
+        promise = this.commands!.showCmd.showModules();
         break;
       case 'project':
         promise = this.commands!.showCmd.showProject();

package/src/command-manager.ts

@@ -25,14 +25,16 @@ import { Transition } from './commands/transition.js';
 import { Update } from './commands/update.js';
 import { Validate } from './commands/validate.js';
 import { Project } from './containers/project.js';
-import { ProjectPaths } from './containers/project/project-paths.js';
-import pino, { type Level, type TransportTargetOptions } from 'pino';
-import { setLogger } from './utils/log-utils.js';
+import { runWithCommitContext } from './utils/commit-context.js';
+import { type Level } from 'pino';
+import { join } from 'node:path';
+import { initLogger } from './utils/log-utils.js';
 
 export interface CommandManagerOptions {
   watchResourceChanges?: boolean;
   autoSaveConfiguration?: boolean;
   logLevel?: Level;
+  autocommit?: boolean;
 }
 
 // Handles commands and ensures that no extra instances are created.
@@ -55,12 +57,11 @@ export class CommandManager {
   public updateCmd: Update;
   public validateCmd: Validate;
 
-  private pathHandler: ProjectPaths;
-
   constructor(path: string, options?: CommandManagerOptions) {
     this.project = new Project(path, {
       autoSave: options?.autoSaveConfiguration,
       watchResourceChanges: options?.watchResourceChanges,
+      autocommit: options?.autocommit,
     });
     this.validateCmd = Validate.getInstance();
 
@@ -77,7 +78,6 @@ export class CommandManager {
     this.renameCmd = new Rename(this.project);
     this.transitionCmd = new Transition(this.project);
     this.updateCmd = new Update(this.project);
-    this.pathHandler = new ProjectPaths(path);
   }
 
   /**
@@ -90,6 +90,36 @@ export class CommandManager {
     return this.project.configuration.checkSchemaVersion();
   }
 
+  /**
+   * Run a function with the given author set in async-local context.
+   * Git commits made during the function will use this author.
+   */
+  public runAsAuthor<T>(
+    author: { name: string; email: string },
+    fn: () => Promise<T>,
+  ): Promise<T> {
+    return runWithCommitContext({ author }, fn);
+  }
+
+  /**
+   * Execute multiple commands as a single atomic write transaction.
+   * All inner @write/@read calls reuse the same lock context.
+   * Git commit fires once on success; rollback on any error.
+   */
+  public async atomic<T>(fn: () => Promise<T>, message: string): Promise<T> {
+    const run = () => this.project.lock.write(fn);
+    return runWithCommitContext({ message }, run);
+  }
+
+  /**
+   * Execute multiple commands under a consistent read snapshot.
+   * All inner @read calls reuse the same lock context.
+   * Writers are blocked for the duration.
+   */
+  public async consistent<T>(fn: () => Promise<T>): Promise<T> {
+    return this.project.lock.read(fn);
+  }
+
   /**
    * Some commands needs initialization that cannot be performed inside constructor.
    * Add such calls here.
@@ -97,34 +127,7 @@ export class CommandManager {
   public async initialize() {
     this.project.resources.changedModules();
     await this.project.populateCaches();
-  }
-
-  /**
-   * Sets the logger for the command manager.
-   * @param level Log level.
-   */
-  public setLogger(level: Level) {
-    const all: TransportTargetOptions[] = [
-      {
-        target: 'pino/file',
-        level: 'trace',
-        options: { destination: this.pathHandler.logPath, mkdir: true },
-      },
-      {
-        target: 'pino/file',
-        level: level,
-        options: { destination: 1 }, // stdout
-      },
-    ];
-
-    setLogger(
-      pino({
-        level: 'trace',
-        transport: {
-          targets: all,
-        },
-      }),
-    );
+    await this.project.initializeGit();
   }
 
   /**
@@ -138,6 +141,12 @@ export class CommandManager {
     path: string,
     options?: CommandManagerOptions,
   ): Promise<CommandManager> {
+    // Set up logger before constructing anything so eager child loggers work
+    if (options?.logLevel) {
+      const logPath = join(path, '.logs', 'cyberismo_data-handler.log');
+      initLogger(options.logLevel, logPath);
+    }
+
     if (
       CommandManager.instance &&
       CommandManager.instance.project.basePath !== path
@@ -151,9 +160,6 @@ export class CommandManager {
       await CommandManager.instance.initialize();
     }
 
-    if (options?.logLevel) {
-      CommandManager.instance.setLogger(options?.logLevel);
-    }
     return CommandManager.instance;
   }
 }

package/src/commands/calculate.ts

@@ -14,6 +14,7 @@
 import type { Context } from '../interfaces/project-interfaces.js';
 import type { Project } from '../containers/project.js';
 import type { QueryName, QueryResult } from '../types/queries.js';
+import { read } from '../utils/rw-lock.js';
 
 // Class that calculates with logic program card / project level calculations.
 export class Calculate {
@@ -25,6 +26,7 @@ export class Calculate {
    * @param programs Programs or categories to export
    * @param query Query to export, if not provided, all programs will be exported
    */
+  @read
   public async exportLogicProgram(
     destination: string,
     programs: string[] = ['all'],
@@ -40,6 +42,7 @@ export class Calculate {
   /**
    * Generates a logic program.
    */
+  @read
   public async generate() {
     return this.project.calculationEngine.generate();
   }
@@ -50,6 +53,7 @@ export class Calculate {
    * @param timeout Maximum amount of milliseconds clingraph is allowed to run
    * @returns a base64 encoded image as a string
    */
+  @read
   public async runGraph(model: string, view: string, context: Context) {
     return this.project.calculationEngine.runGraph(model, view, context);
   }
@@ -59,6 +63,7 @@ export class Calculate {
    * @param query Logic program to be run
    * @returns parsed program output
    */
+  @read
   public async runLogicProgram(query: string, context: Context = 'localApp') {
     return this.project.calculationEngine.runLogicProgram(query, context);
   }
@@ -74,6 +79,8 @@ export class Calculate {
     context: Context = 'localApp',
     options?: unknown,
   ): Promise<QueryResult<T>[]> {
-    return this.project.calculationEngine.runQuery(queryName, context, options);
+    return this.project.lock.read(async () =>
+      this.project.calculationEngine.runQuery(queryName, context, options),
+    );
   }
 }

package/src/commands/create.ts

@@ -26,6 +26,7 @@ import { isModulePath } from '../utils/card-utils.js';
 import type { DataType } from '../interfaces/resource-interfaces.js';
 import type { Card, ProjectFile } from '../interfaces/project-interfaces.js';
 import { resourceName, resourceNameToString } from '../utils/resource-utils.js';
+import { write } from '../utils/rw-lock.js';
 import { writeJsonFile } from '../utils/json.js';
 
 // todo: Is there a easy to way to make JSON schema into a TypeScript interface/type?
@@ -80,6 +81,10 @@ export class Create {
    * @param count How many cards to add. By default one.
    * @returns non-empty string array with ids of added cards
    */
+  @write(
+    (cardTypeName, templateName) =>
+      `Add cards of type ${cardTypeName} to template ${templateName}`,
+  )
   public async addCards(
     cardTypeName: string,
     templateName: string,
@@ -140,6 +145,7 @@ export class Create {
    * Adds a new hub location.
    * @param hubUrl URL of the hub
    */
+  @write((hubUrl) => `Add hub ${hubUrl}`)
   public async addHubLocation(hubUrl: string) {
     return this.project.configuration.addHub(hubUrl);
   }
@@ -150,6 +156,7 @@ export class Create {
    * @param attachment path to an attachment file or attachment name if buffer is defined
    * @param buffer (Optional) attachment buffer
    */
+  @write((cardKey, attachment) => `Add attachment ${attachment} to ${cardKey}`)
   public async createAttachment(
     cardKey: string,
     attachment: string,
@@ -162,7 +169,7 @@ export class Create {
         buffer || attachment,
       );
     } catch (error) {
-      throw new Error(errorFunction(error));
+      throw new Error(errorFunction(error), { cause: error });
     }
   }
 
@@ -170,6 +177,7 @@ export class Create {
    * Creates a calculation resource.
    * @param calculationName name for the calculation resource
    */
+  @write((calculationName) => `Create calculation ${calculationName}`)
   public async createCalculation(calculationName: string) {
     return this.project.resources
       .byType(calculationName, 'calculations')
@@ -182,6 +190,7 @@ export class Create {
    * @param parentCardKey (Optional) card-key of a parent card. If missing, cards are added to the card root.
    * @returns array of card keys that were created. Cards are sorted by their parent key and rank. Template root cards are first but the order between other card groups is not guaranteed. However, the order of cards within a group is guaranteed to be ordered by rank.
    */
+  @write((templateName) => `Create card from template ${templateName}`)
   public async createCard(
     templateName: string,
     parentCardKey?: string,
@@ -232,6 +241,7 @@ export class Create {
    * @param cardTypeName name for the card type.
    * @param workflowName workflow name to use in the card type.
    */
+  @write((cardTypeName) => `Create card type ${cardTypeName}`)
   public async createCardType(cardTypeName: string, workflowName: string) {
     return this.project.resources
       .byType(cardTypeName, 'cardTypes')
@@ -243,6 +253,7 @@ export class Create {
    * @param fieldTypeName name for the field type.
    * @param dataType data type for the field type
    */
+  @write((fieldTypeName) => `Create field type ${fieldTypeName}`)
   public async createFieldType(fieldTypeName: string, dataType: DataType) {
     return this.project.resources
       .byType(fieldTypeName, 'fieldTypes')
@@ -253,6 +264,7 @@ export class Create {
    * Creates a new graph model.
    * @param graphModelName name for the graph model.
    */
+  @write((graphModelName) => `Create graph model ${graphModelName}`)
   public async createGraphModel(graphModelName: string) {
     return this.project.resources
       .byType(graphModelName, 'graphModels')
@@ -263,6 +275,7 @@ export class Create {
    * Creates a new graph view.
    * @param graphViewName name for the graph view.
    */
+  @write((graphViewName) => `Create graph view ${graphViewName}`)
   public async createGraphView(graphViewName: string) {
     return this.project.resources.byType(graphViewName, 'graphViews').create();
   }
@@ -272,6 +285,7 @@ export class Create {
    * @param cardKey The card to which the label is added to
    * @param label The label being added
    */
+  @write((cardKey, label) => `Add label ${label} to ${cardKey}`)
   public async createLabel(cardKey: string, label: string) {
     if (!Validate.isValidLabelName(label)) {
       throw new Error(`Not a valid label name'`);
@@ -292,6 +306,7 @@ export class Create {
    * Creates a new link type.
    * @param linkTypeName name for the link type.
    */
+  @write((linkTypeName) => `Create link type ${linkTypeName}`)
   public async createLinkType(linkTypeName: string) {
     return this.project.resources.byType(linkTypeName, 'linkTypes').create();
   }
@@ -303,6 +318,10 @@ export class Create {
    * @param linkType The type of link to add
    * @param linkDescription Optional description of the link
    */
+  @write(
+    (cardKey, destinationCardKey, linkType) =>
+      `Create ${linkType} link from ${cardKey} to ${destinationCardKey}`,
+  )
   public async createLink(
     cardKey: string,
     destinationCardKey: string,
@@ -393,6 +412,7 @@ export class Create {
     projectCategory: string,
     projectDescription: string,
   ) {
+    // No lock required, since we are creating a new project
     projectPath = resolve(projectPath);
 
     if (!projectPath) {
@@ -482,6 +502,7 @@ export class Create {
    * Creates a report
    * @param name name of the report
    */
+  @write((name) => `Create report ${name}`)
   public async createReport(name: string) {
     return this.project.resources.byType(name, 'reports').createReport();
   }
@@ -491,6 +512,7 @@ export class Create {
    * @param templateName Name of the template.
    * @param templateContent JSON content for the template file.
    */
+  @write((templateName) => `Create template ${templateName}`)
   public async createTemplate(templateName: string, templateContent: string) {
     return this.project.resources
       .byType(templateName, 'templates')
@@ -502,6 +524,7 @@ export class Create {
    * @param workflowName workflow name
    * @param workflowContent workflow content JSON
    */
+  @write((workflowName) => `Create workflow ${workflowName}`)
   public async createWorkflow(workflowName: string, workflowContent: string) {
     return this.project.resources
       .byType(workflowName, 'workflows')

package/src/commands/edit.ts

@@ -19,6 +19,7 @@ import { spawnSync } from 'node:child_process';
 import { ActionGuard } from '../permissions/action-guard.js';
 import { Project } from '../containers/project.js';
 import { UserPreferences } from '../utils/user-preferences.js';
+import { write } from '../utils/rw-lock.js';
 
 import type { MetadataContent } from '../interfaces/project-interfaces.js';
 
@@ -76,6 +77,7 @@ export class Edit {
    * @param cardKey The card to update.
    * @param changedContent New content for the card.
    */
+  @write((cardKey) => `Edit content of ${cardKey}`)
   public async editCardContent(cardKey: string, changedContent: string) {
     if (this.project.hasTemplateCard(cardKey)) {
       return this.project.updateCardContent(cardKey, changedContent);
@@ -93,6 +95,7 @@ export class Edit {
    * @param changedKey Which metadata property was changed
    * @param newValue New value for the metadata property
    */
+  @write((cardKey) => `Edit metadata of ${cardKey}`)
   public async editCardMetadata(
     cardKey: string,
     changedKey: string,

package/src/commands/export.ts

@@ -31,6 +31,7 @@ import { generateReportContent } from '../utils/report.js';
 import { getStaticDirectoryPath, pdfReport } from '@cyberismo/assets';
 import { Project } from '../containers/project.js';
 import type { QueryResult } from '../types/queries.js';
+import { read } from '../utils/rw-lock.js';
 import type { Show } from './show.js';
 import { sortItems } from '../utils/lexorank.js';
 
@@ -246,7 +247,10 @@ export class Export {
       children: [],
       attachments: [],
     };
-    const cardDetailsResponse = this.showCmd.showCardDetails(card.key, 'adoc');
+    const cardDetailsResponse = await this.showCmd.showCardDetails(
+      card.key,
+      'adoc',
+    );
     let asciiDocContent = '';
     const project = this.project;
     try {
@@ -283,6 +287,7 @@ export class Export {
    * @param options Export options.
    * @returns status message
    */
+  @read
   public async exportPdf(
     destination: string,
     options: ExportPdfOptions,
@@ -320,6 +325,7 @@ export class Export {
    * @param cardKey If not exporting the whole card tree, card key of parent card.
    * @returns status message
    */
+  @read
   public async exportToADoc(
     destination: string,
     cardKey?: string,
@@ -365,7 +371,7 @@ export class Export {
       destination,
       Project.cardContentFile,
     );
-    let message = '';
+    let message: string;
     try {
       await truncate(resultDocumentPath, 0);
       message = `Using existing output file '${resultDocumentPath}'`;

package/src/commands/fetch.ts

@@ -17,6 +17,7 @@ import { resolve, sep } from 'node:path';
 import { getChildLogger } from '../utils/log-utils.js';
 import { readJsonFile, writeJsonFile } from '../utils/json.js';
 import { validateJson } from '../utils/validate.js';
+import { write } from '../utils/rw-lock.js';
 
 import type { ModuleSetting } from '../interfaces/project-interfaces.js';
 import type { Project } from '../containers/project.js';
@@ -203,6 +204,7 @@ export class Fetch {
   /**
    * Ensures the module list is up to date by fetching if needed.
    */
+  @write()
   public async ensureModuleListUpToDate() {
     await this.fetchHubs();
   }
@@ -211,6 +213,7 @@ export class Fetch {
    * Fetches modules from modules hub(s) and writes them to a file.
    * Only fetches if the remote version is newer than the local version.
    */
+  @write(() => 'Fetch hubs')
   public async fetchHubs() {
     const needsFetch = await this.fetchModuleList();
     if (!needsFetch) {

package/src/commands/import.ts

@@ -14,6 +14,7 @@
 import { ModuleManager } from '../module-manager.js';
 import { readCsvFile } from '../utils/csv.js';
 import { Validate } from './validate.js';
+import { write } from '../utils/rw-lock.js';
 
 import type { Create } from './create.js';
 import type {
@@ -48,6 +49,7 @@ export class Import {
    * @param parentCardKey the cards in the csv file will be created under this card
    * @returns card keys of the imported cards
    */
+  @write((csvFilePath) => `Import cards from CSV ${csvFilePath}`)
   public async importCsv(
     csvFilePath: string,
     parentCardKey?: string,
@@ -137,6 +139,7 @@ export class Import {
    *        private: If true, uses credentials to clone the repository
    * @param skipMigrationLog If true, skip logging to migration log (used during project creation)
    */
+  @write((source) => `Import module ${source}`)
   public async importModule(
     source: string,
     destination?: string,
@@ -195,6 +198,7 @@ export class Import {
    * @param credentials Optional credentials for a private module.
    * @throws if module is not part of the project
    */
+  @write((moduleName) => `Update module ${moduleName}`)
   public async updateModule(moduleName: string, credentials?: Credentials) {
     // Ensure module list is up to date before updating
     await this.fetchCmd.ensureModuleListUpToDate();
@@ -212,6 +216,7 @@ export class Import {
    * Updates all imported modules.
    * @param credentials Optional credentials for private modules.
    */
+  @write(() => 'Update all modules')
   public async updateAllModules(credentials?: Credentials) {
     // Ensure module list is up to date before updating all modules
     await this.fetchCmd.ensureModuleListUpToDate();

package/src/commands/migrate.ts

@@ -14,6 +14,7 @@
 import { SCHEMA_VERSION } from '@cyberismo/assets';
 import type { MigrationResult } from '@cyberismo/migrations';
 import type { Project } from '../containers/project.js';
+import { write } from '../utils/rw-lock.js';
 
 /**
  * Command that handles schema migration operations.
@@ -32,6 +33,7 @@ export class Migrate {
    * @param timeoutMilliSeconds Optional timeout in milliseconds (defaults to 2 minutes)
    * @returns Migration result
    */
+  @write(() => 'Migrate project')
   public async migrate(
     toVersion?: number,
     backupDir?: string,