Reload list of authorities upon configuration change; remember selected register type

Author: wolfgangmm

README.md

@@ -1,11 +1,12 @@
 # TEI Publisher Extension for Visual Studio Code
 
-A package to help editors work on TEI files.
+An extension to help editors work on TEI files. 
 
 ## Features
 
 * Preview the currently edited TEI document by sending it to a TEI Publisher instance where it will be transformed to HTML via an existing ODD
-* Look up an entity in a register database
+* Look up an entity in one of the configured authority databases and replace the current selection with a TEI tag corresponding to the entity type
+
 ### Preview
 
 Get an HTML preview of the TEI file currently opened in the editor. The content is sent to a TEI Publisher endpoint and transformed to HTML via an ODD with processing instructions. The extension queries the server for a list of available ODDs and lets you choose one.
@@ -46,10 +47,13 @@ The _teipublisher.endpoint_ configuration property defines the HTTP or HTTPS URL
 
 The extension supports various authorities to query for entities (plugin name in parentheses):
 
-1. Karl Barth-Gesamtausgabe, Basel (kbga)
-2. Metagrid (metagrid)
-3. Google Places (google)
-4. GND (gnd)
+
+Authority | Plugin name | Supported register types | Notes
+---------|----------|---------|------------
+Karl Barth-Gesamtausgabe, Basel | kbga | places, actors, terms |
+GND | gnd | places, actors, organisations, terms |
+Google Places | google | places | Requires an access token
+Metagrid (metagrid) | metagrid | actors |
 
 You can define a different connector for each entity type. The configuration is a JSON snippet like below:
 
@@ -74,6 +78,12 @@ You can define a different connector for each entity type. The configuration is
 ]
 ```
 
+The `name` property defines the name of the register to search in. It should correspond to one of the supported register types for each authority given in the table above.
+
+The `label` property provides the text to be shown to the user in the dropdown.
+
+`plugin` should correspond to one of the available plugin names given in the table above.
+
 ## Recommended Extensions
 
 For proper XML editing support, we recommend installing some of the following extensions:

media/main.js

@@ -9,6 +9,14 @@ class View {
             this.lookup();
         });
 
+        const register = document.getElementById('api-list');
+        register.addEventListener('change', (ev) => {
+            this.vscode.postMessage({
+                command: 'register',
+                register: register.value
+            });
+        });
+
         // Handle messages sent from the extension to the webview
         window.addEventListener('message', event => {
             const message = event.data; // The json data that the extension sent

src/extension.ts

@@ -14,7 +14,7 @@ export function activate(context: vscode.ExtensionContext) {
 			if (editor && !editor.selection.isEmpty) {
 				provider.show();
 				const selected = editor.document.getText(editor.selection);
-				provider.query(selected, '', editor);
+				provider.query(selected, null, editor);
 			}
 		})
 	);
@@ -23,16 +23,20 @@ export function activate(context: vscode.ExtensionContext) {
 		vscode.commands.registerCommand('teipublisher.preview', preview)
 	);
 
-	vscode.workspace.onDidChangeConfiguration(() => configure(provider));
+	vscode.workspace.onDidChangeConfiguration((ev) => {
+		if (ev.affectsConfiguration('teipublisher')) {
+			configure(provider, ev);
+		}
+	});
 	configure(provider);
 }
 
-function configure(provider: RegistryPanel) {
+function configure(provider: RegistryPanel, ev?: vscode.ConfigurationChangeEvent) {
 	const endpoint:string|undefined = vscode.workspace.getConfiguration('teipublisher').get('endpoint');
 	if (endpoint) {
 		apiEndpoint = endpoint;
 	}
-	provider.configure();
+	provider.configure(ev);
 }
 
 // this method is called when your extension is deactivated

src/panel.ts

@@ -14,7 +14,7 @@ export class RegistryPanel implements vscode.WebviewViewProvider {
 	public static readonly viewType = 'teipublisher.entityView';
 
 	private _registry:Map<string, Registry> = new Map();
-
+	private _currentRegister:string = '';
     private _view?: vscode.WebviewView;
 	private _currentEditor: vscode.TextEditor | undefined = undefined;
 
@@ -31,6 +31,9 @@ export class RegistryPanel implements vscode.WebviewViewProvider {
 		webviewView.webview.onDidReceiveMessage(
 			message => {
 				switch (message.command) {
+					case 'register':
+						this._currentRegister = message.register;
+						break;
 					case 'replace':
 						if (this._currentEditor) {
 							const editor = this._currentEditor;
@@ -40,7 +43,7 @@ export class RegistryPanel implements vscode.WebviewViewProvider {
 								editor.insertSnippet(new vscode.SnippetString(snippet));
 							}
 						}
-						return;
+						break;
 					case 'query':
                         this.query(message.query, message.register);
 						break;
@@ -53,7 +56,7 @@ export class RegistryPanel implements vscode.WebviewViewProvider {
     }
 
 
-	public configure() {
+	public configure(ev?: vscode.ConfigurationChangeEvent) {
 		const configs:any[] | undefined = vscode.workspace.getConfiguration('teipublisher').get('apiList');
 		if (!configs) {
 			return;
@@ -77,16 +80,22 @@ export class RegistryPanel implements vscode.WebviewViewProvider {
 			}
 			this._registry.set(config.name, registry);
 		});
+		if (ev && this._view) {
+			this._view.webview.html = this._getHtmlForWebview(this._view.webview);
+		}
 	}
 
 	public show() {
 		this._view?.show(true);
 	}
 
-    public async query(text: string, register: string, editor?:vscode.TextEditor) {
+    public async query(text: string, register: string|null, editor?:vscode.TextEditor) {
 		if (editor) {
 			this._currentEditor = editor;
 		}
+		if (!register) {
+			register = this._currentRegister;
+		}
 		vscode.window.withProgress({
 			location: vscode.ProgressLocation.Notification,
 			title: `Querying authorities for ${text}`,
@@ -146,7 +155,7 @@ export class RegistryPanel implements vscode.WebviewViewProvider {
 			<body>
 				<div class="toolbar">
                     <select id="api-list">
-                        <option value=''>Alle</option>
+                        <option value=''>All</option>
                         ${ this._getApiOptions() }
                     </select>
                     <input id="query" class="input" type="text" placeholder="Suchtext">