Wrapper: Make codeResources and useDiffEditor optional in EditorAppConfig

package.json

@@ -5,30 +5,30 @@
     "@codingame/esbuild-import-meta-url-plugin": "~1.0.2",
     "@codingame/monaco-vscode-rollup-vsix-plugin": "~5.2.0",
     "@rollup/pluginutils": "~5.1.0",
-    "@types/node": "~20.12.12",
+    "@types/node": "~20.14.0",
     "@types/react": "~18.3.3",
     "@types/react-dom": "~18.3.0",
     "@types/vscode": "~1.89.0",
-    "@typescript-eslint/eslint-plugin": "~7.10.0",
-    "@typescript-eslint/parser": "~7.10.0",
+    "@typescript-eslint/eslint-plugin": "~7.11.0",
+    "@typescript-eslint/parser": "~7.11.0",
     "@vitest/browser": "~1.6.0",
     "editorconfig": "~2.0.0",
-    "esbuild": "~0.21.3",
+    "esbuild": "~0.21.4",
     "eslint": "~8.57.0",
     "eslint-plugin-header": "~3.1.1",
     "eslint-plugin-import": "~2.29.1",
     "eslint-plugin-unused-imports": "~3.2.0",
     "minimatch": "~9.0.4",
     "http-server": "~14.1.1",
     "typescript": "~5.4.5",
-    "vite": "~5.2.11",
+    "vite": "~5.2.12",
     "vitest": "~1.6.0",
     "vite-node": "~1.6.0",
-    "webdriverio": "~8.37.0"
+    "webdriverio": "~8.38.0"
   },
   "volta": {
-    "node": "20.13.1",
-    "npm": "10.5.2"
+    "node": "20.14.0",
+    "npm": "10.7.0"
   },
   "scripts": {
     "clean": "npm run clean --workspaces",

packages/client/package.json

@@ -51,8 +51,8 @@
     "npm": ">=9.0.0"
   },
   "volta": {
-    "node": "20.13.1",
-    "npm": "10.5.2"
+    "node": "20.14.0",
+    "npm": "10.7.0"
   },
   "files": [
     "lib",

packages/examples/package.json

@@ -77,7 +77,7 @@
     "monaco-editor": "npm:@codingame/monaco-vscode-editor-api@~5.2.0",
     "monaco-editor-wrapper": "~5.2.0",
     "monaco-languageclient": "~8.5.0",
-    "pyright": "~1.1.364",
+    "pyright": "~1.1.365",
     "react": "~18.3.1",
     "react-dom": "~18.3.1",
     "request-light": "~0.7.0",
@@ -97,8 +97,8 @@
     "vscode-languageserver-types": "~3.17.5"
   },
   "volta": {
-    "node": "20.13.1",
-    "npm": "10.5.2"
+    "node": "20.14.0",
+    "npm": "10.7.0"
   },
   "files": [
     "dist",

packages/examples/src/ts/wrapperTs.ts

@@ -120,7 +120,9 @@ export const runTsWrapper = async () => {
             }
         });
         document.querySelector('#button-diff')?.addEventListener('click', async () => {
-            userConfig.wrapperConfig.editorAppConfig.useDiffEditor = !userConfig.wrapperConfig.editorAppConfig.useDiffEditor;
+            // ensure it is boolean value and not undefined
+            const useDiffEditor = userConfig.wrapperConfig.editorAppConfig.useDiffEditor === true;
+            userConfig.wrapperConfig.editorAppConfig.useDiffEditor = !useDiffEditor;
             await wrapper.dispose();
             await wrapper.initAndStart(userConfig, htmlElement);
         });

packages/vscode-ws-jsonrpc/package.json

@@ -51,8 +51,8 @@
     "npm": ">=8.0.0"
   },
   "volta": {
-    "node": "20.13.1",
-    "npm": "10.5.2"
+    "node": "20.14.0",
+    "npm": "10.7.0"
   },
   "files": [
     "lib",

packages/wrapper-react/package.json

@@ -38,8 +38,8 @@
     "build": "npm run clean && npm run compile"
   },
   "volta": {
-    "node": "20.13.1",
-    "npm": "10.5.2"
+    "node": "20.14.0",
+    "npm": "10.7.0"
   },
   "dependencies": {
     "monaco-editor": "npm:@codingame/monaco-vscode-editor-api@~5.2.0",

packages/wrapper-react/src/index.tsx

@@ -181,8 +181,9 @@ export class MonacoEditorReactComp<T extends MonacoEditorProps = MonacoEditorPro
             const verifyModelContent = () => {
                 const main = textModels?.text?.getValue() ?? '';
                 const original = textModels?.textOriginal?.getValue() ?? '';
-                const dirty = main !== userConfig.wrapperConfig.editorAppConfig.codeResources.main?.text ?? '';
-                const dirtyOriginal = original !== userConfig.wrapperConfig.editorAppConfig.codeResources.original?.text ?? '';
+                const codeResources = userConfig.wrapperConfig.editorAppConfig.codeResources;
+                const dirty = main !== codeResources?.main?.text ?? '';
+                const dirtyOriginal = original !== codeResources?.original?.text ?? '';
                 onTextChanged({
                     main,
                     original,

packages/wrapper/package.json

@@ -81,8 +81,8 @@
     "build": "npm run clean && npm run compile && npm run build:workers:esbuild && npm run build:workers:vite"
   },
   "volta": {
-    "node": "20.13.1",
-    "npm": "10.5.2"
+    "node": "20.14.0",
+    "npm": "10.7.0"
   },
   "dependencies": {
     "@codingame/monaco-vscode-configuration-service-override": "~5.2.0",

packages/wrapper/src/editorAppBase.ts

@@ -32,8 +32,8 @@ export type EditorAppType = 'extended' | 'classic';
 
 export type EditorAppConfigBase = {
     $type: EditorAppType;
-    codeResources: CodeResources;
-    useDiffEditor: boolean;
+    codeResources?: CodeResources;
+    useDiffEditor?: boolean;
     domReadOnly?: boolean;
     readOnly?: boolean;
     awaitExtensionReadiness?: Array<() => Promise<void>>;
@@ -109,7 +109,7 @@ export abstract class EditorAppBase {
     }
 
     async createEditors(container: HTMLElement): Promise<void> {
-        if (this.getConfig().useDiffEditor) {
+        if (this.getConfig().useDiffEditor === true) {
             this.diffEditor = monaco.editor.createDiffEditor(container, this.getConfig().diffEditorOptions);
         } else {
             this.editor = monaco.editor.create(container, this.getConfig().editorOptions);
@@ -148,7 +148,7 @@ export abstract class EditorAppBase {
         };
     }
 
-    async updateCodeResources(codeResources: CodeResources): Promise<void> {
+    async updateCodeResources(codeResources?: CodeResources): Promise<void> {
         if (!this.editor && !this.diffEditor) {
             return Promise.reject(new Error('You cannot update the code resources as neither editor or diff editor is available.'));
         }
@@ -160,20 +160,20 @@ export abstract class EditorAppBase {
 
         if (modelUpdateType === ModelUpdateType.CODE) {
             if (this.editor) {
-                this.editor.setValue(codeResources.main?.text ?? '');
+                this.editor.setValue(codeResources?.main?.text ?? '');
             } else {
-                this.diffEditor?.getModifiedEditor().setValue(codeResources.main?.text ?? '');
-                this.diffEditor?.getOriginalEditor().setValue(codeResources.original?.text ?? '');
+                this.diffEditor?.getModifiedEditor().setValue(codeResources?.main?.text ?? '');
+                this.diffEditor?.getOriginalEditor().setValue(codeResources?.original?.text ?? '');
             }
         } else if (modelUpdateType === ModelUpdateType.MODEL || modelUpdateType === ModelUpdateType.CODE_AND_MODEL) {
             const modelRefs = await this.buildModelRefs(codeResources);
             this.updateEditorModels(modelRefs);
         }
     }
 
-    async buildModelRefs(codeResources: CodeResources): Promise<ModelRefs> {
-        const modelRef = await this.buildModelRef(codeResources.main);
-        const modelRefOriginal = await this.buildModelRef(codeResources.original);
+    async buildModelRefs(codeResources?: CodeResources): Promise<ModelRefs> {
+        const modelRef = await this.buildModelRef(codeResources?.main);
+        const modelRefOriginal = await this.buildModelRef(codeResources?.original);
 
         return {
             modelRef,
@@ -236,14 +236,19 @@ export abstract class EditorAppBase {
         }
     }
 
-    private updateCodeResourcesConfig(codeResources: CodeResources) {
+    private updateCodeResourcesConfig(codeResources?: CodeResources) {
         const config = this.getConfig();
-        config.codeResources.main = codeResources.main;
-        config.codeResources.original = codeResources.original;
+        config.codeResources = {};
+        if (codeResources?.main) {
+            config.codeResources.main = codeResources?.main;
+        }
+        if (codeResources?.original) {
+            config.codeResources.original = codeResources?.original;
+        }
     }
 
     updateLayout() {
-        if (this.getConfig().useDiffEditor) {
+        if (this.getConfig().useDiffEditor === true) {
             this.diffEditor?.layout();
         } else {
             this.editor?.layout();

packages/wrapper/src/utils.ts

@@ -61,26 +61,26 @@ export enum ModelUpdateType {
     CODE_AND_MODEL
 }
 
-export const isCodeUpdateRequired = (codeResourcesPrevious: CodeResources, codeResources: CodeResources) => {
-    const a = evaluateCodeUpdate(codeResourcesPrevious.main);
-    const b = evaluateCodeUpdate(codeResources.main);
-    const c = evaluateCodeUpdate(codeResourcesPrevious.original);
-    const d = evaluateCodeUpdate(codeResources.original);
+export const isCodeUpdateRequired = (codeResourcesPrevious?: CodeResources, codeResources?: CodeResources) => {
+    const a = evaluateCodeUpdate(codeResourcesPrevious?.main);
+    const b = evaluateCodeUpdate(codeResources?.main);
+    const c = evaluateCodeUpdate(codeResourcesPrevious?.original);
+    const d = evaluateCodeUpdate(codeResources?.original);
     return a !== b || c !== d ? ModelUpdateType.CODE : ModelUpdateType.NONE;
 };
 
 export const evaluateCodeUpdate = (code?: CodePlusUri | CodePlusFileExt) => {
     return code && Object.hasOwn(code, 'text') ? code.text : undefined;
 };
 
-export const isModelUpdateRequired = (codeResourcesPrevious: CodeResources, codeResources: CodeResources): ModelUpdateType => {
+export const isModelUpdateRequired = (codeResourcesPrevious?: CodeResources, codeResources?: CodeResources): ModelUpdateType => {
     const codeUpdateType = isCodeUpdateRequired(codeResourcesPrevious, codeResources);
     const codeChanged = codeUpdateType === ModelUpdateType.CODE;
 
-    const a = evaluateCodeModel(codeResourcesPrevious.main);
-    const b = evaluateCodeModel(codeResources.main);
-    const c = evaluateCodeModel(codeResourcesPrevious.original);
-    const d = evaluateCodeModel(codeResources.original);
+    const a = evaluateCodeModel(codeResourcesPrevious?.main);
+    const b = evaluateCodeModel(codeResources?.main);
+    const c = evaluateCodeModel(codeResourcesPrevious?.original);
+    const d = evaluateCodeModel(codeResources?.original);
     const modelChanged = a !== b || c !== d;
 
     return (modelChanged && codeChanged) ? ModelUpdateType.CODE_AND_MODEL : (modelChanged ? ModelUpdateType.MODEL : (codeChanged ? ModelUpdateType.CODE : ModelUpdateType.NONE));

packages/wrapper/src/wrapper.ts

@@ -37,8 +37,8 @@ export class MonacoEditorLanguageClientWrapper {
         }
 
         const editorAppConfig = userConfig.wrapperConfig.editorAppConfig;
-        if (editorAppConfig.useDiffEditor && !editorAppConfig.codeResources.original) {
-            throw new Error(`Use diff editor was used without a valid config. code: ${editorAppConfig.codeResources.main} codeOriginal: ${editorAppConfig.codeResources.original}`);
+        if (editorAppConfig.useDiffEditor === true && !editorAppConfig.codeResources?.original) {
+            throw new Error(`Use diff editor was used without a valid config. code: ${editorAppConfig.codeResources?.main} codeOriginal: ${editorAppConfig.codeResources?.original}`);
         }
 
         // Always dispose old instances before start
@@ -157,7 +157,7 @@ export class MonacoEditorLanguageClientWrapper {
         return this.languageClientWrapper?.getWorker();
     }
 
-    async updateCodeResources(codeResources: CodeResources): Promise<void> {
+    async updateCodeResources(codeResources?: CodeResources): Promise<void> {
         return this.editorApp?.updateCodeResources(codeResources);
     }
 

packages/wrapper/test/editorAppClassic.test.ts

@@ -49,6 +49,10 @@ describe('Test EditorAppClassic', () => {
         const app = new EditorAppClassic('test', createBaseConfig('classic'));
         expect(app.isAppConfigDifferent(orgConfig, config, false)).toBeFalsy();
 
+        if (!config.codeResources) {
+            config.codeResources = {};
+        }
+
         config.codeResources.main = {
             text: 'test',
             fileExt: 'js'
@@ -79,9 +83,9 @@ describe('Test EditorAppClassic', () => {
     test('config defaults', () => {
         const config = createBaseConfig('classic');
         const app = new EditorAppClassic('config defaults', config);
-        expect(app.getConfig().codeResources.main?.text).toEqual('');
-        expect(app.getConfig().codeResources.original).toBeUndefined();
-        expect(app.getConfig().useDiffEditor).toBeFalsy();
+        expect(app.getConfig().codeResources?.main?.text).toEqual('');
+        expect(app.getConfig().codeResources?.original).toBeUndefined();
+        expect(app.getConfig().useDiffEditor === true).toBeFalsy();
         expect(app.getConfig().readOnly).toBeFalsy();
         expect(app.getConfig().domReadOnly).toBeFalsy();
     });

packages/wrapper/test/editorAppExtended.test.ts

@@ -36,6 +36,10 @@ describe('Test EditorAppExtended', () => {
         const app = new EditorAppExtended('test', createBaseConfig('extended'));
         expect(app.isAppConfigDifferent(orgConfig, config, false)).toBeFalsy();
 
+        if (!config.codeResources) {
+            config.codeResources = {};
+        }
+
         config.codeResources.main = {
             text: 'test',
             fileExt: 'js'
@@ -62,9 +66,9 @@ describe('Test EditorAppExtended', () => {
     test('config defaults', () => {
         const config = createBaseConfig('extended');
         const app = new EditorAppExtended('config defaults', config);
-        expect(app.getConfig().codeResources.main?.text).toEqual('');
-        expect(app.getConfig().codeResources.original).toBeUndefined();
-        expect(app.getConfig().useDiffEditor).toBeFalsy();
+        expect(app.getConfig().codeResources?.main?.text).toEqual('');
+        expect(app.getConfig().codeResources?.original).toBeUndefined();
+        expect(app.getConfig().useDiffEditor === true).toBeFalsy();
         expect(app.getConfig().readOnly).toBeFalsy();
         expect(app.getConfig().domReadOnly).toBeFalsy();
     });

packages/wrapper/test/wrapper.test.ts

@@ -93,8 +93,12 @@ describe('Test MonacoEditorLanguageClientWrapper', () => {
         createMonacoEditorDiv();
         const wrapper = new MonacoEditorLanguageClientWrapper();
         const userConfig = createBaseConfig('classic');
-        userConfig.wrapperConfig.editorAppConfig.codeResources.main = undefined;
-        userConfig.wrapperConfig.editorAppConfig.codeResources.original = {
+        let codeResources = userConfig.wrapperConfig.editorAppConfig.codeResources;
+        if (!codeResources) {
+            codeResources = {};
+        }
+        codeResources.main = undefined;
+        codeResources.original = {
             text: 'original',
             fileExt: 'js'
         };
@@ -111,7 +115,11 @@ describe('Test MonacoEditorLanguageClientWrapper', () => {
         createMonacoEditorDiv();
         const wrapper = new MonacoEditorLanguageClientWrapper();
         const userConfig = createBaseConfig('classic');
-        userConfig.wrapperConfig.editorAppConfig.codeResources.original = {
+        let codeResources = userConfig.wrapperConfig.editorAppConfig.codeResources;
+        if (!codeResources) {
+            codeResources = {};
+        }
+        codeResources.original = {
             text: 'original',
             fileExt: 'js'
         };

verify/angular/package.json

@@ -39,7 +39,7 @@
     "style-loader": "~4.0.0"
   },
   "volta": {
-    "node": "20.13.1",
-    "npm": "10.5.2"
+    "node": "20.14.0",
+    "npm": "10.7.0"
   }
 }

verify/pnpm/package.json

@@ -15,7 +15,7 @@
     "vite": "~5.2.8"
   },
   "volta": {
-    "node": "20.13.1"
+    "node": "20.14.0"
   },
   "scripts": {
     "verify": "pnpm install && pnpm run build && pnpm run start",

verify/vite/package.json

@@ -15,8 +15,8 @@
     "vite": "~5.2.8"
   },
   "volta": {
-    "node": "20.13.1",
-    "npm": "10.5.2"
+    "node": "20.14.0",
+    "npm": "10.7.0"
   },
   "scripts": {
     "verify": "npm install && npm run build && npm run start",

verify/webpack/package.json

@@ -19,8 +19,8 @@
     "webpack-cli": "~5.1.4"
   },
   "volta": {
-    "node": "20.13.1",
-    "npm": "10.5.2"
+    "node": "20.14.0",
+    "npm": "10.7.0"
   },
   "scripts": {
     "verify": "npm install && npm run build && npm run start",

verify/yarn/package.json

@@ -17,7 +17,7 @@
     "vite": "~5.2.8"
   },
   "volta": {
-    "node": "20.13.1",
+    "node": "20.14.0",
     "yarn": "1.22.22"
   },
   "scripts": {