@zenwave360/lsp-js 0.1.0-next.12.1 → 0.1.0-next.13.1

package/README.md

@@ -74,10 +74,31 @@ groups of the same document's `zenwave/eventFlowViews` that stand for the node's
 `event:OrderCreated`, `event:OrderCreated@Orders>OrderService`, `group:Orders>OrderService`, `policy:…`); it
 is empty when the diagram has no counterpart.
 
-`zenwave/preview` answers for ZDL (one Mermaid `class-diagram`) and ZFL (a `flowchart`, then one
-`sequence:<outcome>:<index>` per end outcome; the first sequence is the default). `sequenceRenderMode`
+`zenwave/preview` answers for ZDL (one `MARKDOWN` representation `domain`, "Domain model": the model's page with its
+diagrams as `mermaid` fences), `.zw` (one `MARKDOWN` representation `configuration`, "Plugin configuration": the `config`
+block and each plugin with what it is for and its resolved configuration; the document's language id is `zw`, or its
+URI ends in `.zw`) and ZFL (a `flowchart`, then one `sequence:<outcome>:<index>` per end outcome; the first sequence is
+the default). What a model wrote is escaped in the Markdown, so a `<script>` shows as text. `sequenceRenderMode`
 defaults to `ALT_BLOCKS`. Null properties are omitted from every result.
 
+### Plugin catalogue
+
+The `.zw` page describes each plugin (what it is for, what its options mean) from a plugin catalogue, the JSON
+the ZenWave SDK reports for `-h json`, in the shape of the VS Code extension's `sdk-plugin-catalogue.json`
+(`{ source, version, plugins: [...] }`; fields the server does not know are ignored). The server ships its own copy,
+embedded in the bundle, so it works with no file read (the Web Worker too), and uses the last valid catalogue a
+client sent. The copy is generated by `scripts/generate-plugin-catalogue.mjs` from a named SDK build (its
+`source`/`version`, today `ZenWave SDK 2.8.0-SNAPSHOT`) and parsed the first time a `.zw` is previewed.
+
+- At initialisation: `initializationOptions.pluginCatalogue`, the catalogue as a JSON object.
+- At any time: the notification `zenwave/pluginCatalogue` with params `{ catalogue: <JSON object> }`. It is advertised
+  in `capabilities.experimental.customNotifications` (`["zenwave/pluginCatalogue"]`), beside `customRequests`.
+
+The next `zenwave/preview` uses it (previews are not cached). A plugin that is not in the catalogue still shows its
+name and resolved configuration, without a description. A catalogue that is not an object, is not JSON or has no
+`plugins` array is ignored, the previous one stays, and the server logs a warning with `window/logMessage`;
+it never fails initialisation.
+
 Both visualisation requests read open documents. When a document cannot answer they fail with JSON-RPC
 `-32803` and `data.kind`: `documentUnreadable` (a syntax error; `data.diagnostics` holds LSP diagnostics),
 `documentNotFound` (not open) or `unsupportedDocument` (a kind of document the request does not cover).
@@ -87,7 +108,7 @@ The worker bundle carries elkjs for the flow layout. elkjs' in-process layout wo
 the Web Worker's `onmessage` when it detects a worker global; `build.mjs` disables that detection when bundling,
 and the build fails if an elkjs upgrade changes it.
 
-Initialization options take the form `{ zenwave: { configUri?, projectManifestUri? } }`.
+Initialization options take the form `{ zenwave: { configUri?, projectManifestUri? }, pluginCatalogue? }`.
 
 ## Building