feat: stateVersion should be docVersion

Resolves: #71

Author: stee-re

oscd-shell.spec.ts

@@ -153,15 +153,15 @@ describe('with editor plugins loaded', () => {
     });
   });
 
-  it('passes property stateVersion', async () => {
+  it('passes property docVersion', async () => {
     editor.dispatchEvent(newOpenEvent(doc, 'test.scd'));
     await editor.updateComplete;
 
-    expect(editorPlugin.stateVersion).to.equal(0);
+    expect(editorPlugin.docVersion).to.equal(0);
     expect(editorPlugin.editCount).to.equal(0);
   });
 
-  it('updated passed stateVersion property on edit events', async () => {
+  it('updated passed docVersion property on edit events', async () => {
     editor.dispatchEvent(newOpenEvent(doc, 'test.scd'));
     await editor.updateComplete;
 
@@ -174,7 +174,7 @@ describe('with editor plugins loaded', () => {
     );
     await editor.updateComplete;
 
-    expect(editorPlugin.stateVersion).to.equal(1);
+    expect(editorPlugin.docVersion).to.equal(1);
     expect(editorPlugin.editCount).to.equal(1);
   });
 });
@@ -239,15 +239,15 @@ describe('with menu plugins loaded', () => {
     });
   });
 
-  it('passes property stateVersion', async () => {
+  it('passes property docVersion', async () => {
     editor.dispatchEvent(newOpenEvent(doc, 'test.scd'));
     await editor.updateComplete;
 
-    expect(menuPlugin).to.have.property('stateVersion', 0);
+    expect(menuPlugin).to.have.property('docVersion', 0);
     expect(menuPlugin).to.have.property('editCount', 0);
   });
 
-  it('updated passed stateVersion property on edit events', async () => {
+  it('updated passed docVersion property on edit events', async () => {
     editor.dispatchEvent(newOpenEvent(doc, 'test.scd'));
     await editor.updateComplete;
 
@@ -260,7 +260,7 @@ describe('with menu plugins loaded', () => {
     );
     await editor.updateComplete;
 
-    expect(menuPlugin).to.have.property('stateVersion', 1);
+    expect(menuPlugin).to.have.property('docVersion', 1);
     expect(menuPlugin).to.have.property('editCount', 1);
   });
 });

oscd-shell.ts

@@ -51,8 +51,8 @@ export interface Plugin {
   docs: Record<string, XMLDocument>;
   doc?: XMLDocument; // the document currently being edited
   docName?: string; // the current doc's name
-  stateVersion: unknown; // changes when the document is modified
-  /** @deprecated Use `stateVersion` instead */
+  docVersion: unknown; // changes when the document is modified
+  /** @deprecated Use `docVersion` instead */
   editCount: number; // the number of edits made to the document
   locale: string; // the end user's chosen locale
 }
@@ -160,7 +160,7 @@ export class OpenSCD extends LitElement {
   }
 
   onDocsChanged() {
-    this.stateVersion += 1;
+    this.docVersion += 1;
   }
 
   /** The name of the [[`doc`]] currently being edited */
@@ -176,7 +176,7 @@ export class OpenSCD extends LitElement {
   xmlEditor: XMLEditor = new XMLEditor();
 
   @state()
-  stateVersion: number = -1;
+  docVersion: number = -1;
 
   @state()
   get last(): number {
@@ -400,7 +400,7 @@ export class OpenSCD extends LitElement {
 
     // Catch all edits (from commits AND events) and trigger an update
     this.xmlEditor.subscribe(() => {
-      this.stateVersion += 1;
+      this.docVersion += 1;
     });
   }
 
@@ -423,8 +423,8 @@ export class OpenSCD extends LitElement {
               .docName="${this.docName}"
               .doc=${this.doc}
               .docs=${this.docs} 
-              .editCount=${this.stateVersion}
-              .stateVersion=${this.stateVersion}
+              .editCount=${this.docVersion}
+              .docVersion=${this.docVersion}
               .editor=${this.xmlEditor}>
             </${tag}>`;
   }