@lblod/ember-rdfa-editor-lblod-plugins 4.0.1 → 4.0.2

package/CHANGELOG.md

@@ -7,6 +7,16 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [4.0.2] - 2023-04-04
+
+### Fixed
+- Prevent decision nodes regenerating when (de)serializing
+- Ensure editor is focused after inserting a citation
+- fix(citation): make plugin trigger correctly when `doc` is passed as an allowed nodeType
+
+### Added
+- docs: add examples on how to enable the citation plugin for the entire document
+ 
 ## [4.0.1] - 2023-03-27
 
 ### Dependencies
@@ -29,6 +39,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Removed:
 - Removal of prosemirror-plugin dependency of `CitationPlugin::CitationInsert` component.
 
+### Dependencies
+- bump `ember-rdfa-editor` to v3.4.0
+
 ## [3.1.0] - 2023-03-02
 
 ### Fixed
@@ -40,7 +53,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Dependencies
 - bump `ember-rdfa-editor` to v3.3.0
-- bump `ember-rdfa-editor` to v3.4.0
 
 ## [3.0.0] - 2023-02-27
 
@@ -379,7 +391,8 @@ add onclick handler to pencil icon in variable plugin
 
 # Changelog
 
-[unreleased]: https://github.com/lblod/ember-rdfa-editor-lblod-plugins/compare/v4.0.1...HEAD
+[unreleased]: https://github.com/lblod/ember-rdfa-editor-lblod-plugins/compare/v4.0.2...HEAD
+[4.0.2]: https://github.com/lblod/ember-rdfa-editor-lblod-plugins/compare/v4.0.1...v4.0.2
 [4.0.1]: https://github.com/lblod/ember-rdfa-editor-lblod-plugins/compare/v4.0.0...v4.0.1
 [4.0.0]: https://github.com/lblod/ember-rdfa-editor-lblod-plugins/compare/v3.1.0...v4.0.0
 [3.1.0]: https://github.com/lblod/ember-rdfa-editor-lblod-plugins/compare/v3.0.0...v3.1.0

package/README.md

@@ -101,6 +101,31 @@ Configuration:
   - activeInRanges: it's a function that gets the state of the actual instance of the editor and returns an array of ranges for the plugin to be active in, for example `[[0,50], [70,100]]`
   - regex: you can provide your custom regex to detect citations, if not the default one will be used
 
+
+A common usecase is to have the plugin active in the entire document. Here's how to do that using each configuration type:
+
+```js
+import { citationPlugin } from "@lblod/ember-rdfa-editor-lblod-plugins/plugins/citation-plugin";
+
+const configA = {
+   type: "nodes",
+   activeInNodeTypes(schema) {
+     // the root node of the document should always have the doc type
+     return new Set([schema.nodes.doc]);
+   }
+ };
+  
+const configB = {
+  type: "ranges",
+  activeInRanges(state) {
+    // a node's nodeSize follows the Prosemirror definition
+    // a non-leaf node's size is the sum of its children's sizes + 2
+    // so to get the last valid position "inside" a node, you need to subtract two from its nodeSize
+    // ref: https://prosemirror.net/docs/ref/#model.Node.nodeSize 
+    return [[0, state.doc.nodeSize - 2]];
+  }
+};
+```
 ### Using the plugin
 If used with the example configuration provided this plugin can be triggered by typing one of the following in the correct RDFa context (the [besluit:motivering](http://data.vlaanderen.be/ns/besluit#motivering) of a [besluit:Besluit](https://data.vlaanderen.be/ns/besluit#Besluit)).
 

package/addon/components/citation-plugin/citation-card.ts

@@ -202,6 +202,7 @@ export default class CitationCardComponent extends Component<Args> {
           .scrollIntoView(),
       { view: this.controller.mainEditorView }
     );
+    this.controller.focus();
   }
 
   @action

package/addon/components/citation-plugin/citation-insert.ts

@@ -76,6 +76,12 @@ export default class EditorPluginsCitationInsertComponent extends Component<Args
         this.controller.schema,
         this.controller.mainEditorState
       );
+      // if the doc node is included, the button should always be active
+      // the findParentNodeOfType util we import does NOT consider the doc node
+      // in its search.
+      if (nodeTypes.has(this.controller.schema.nodes.doc)) {
+        return false;
+      }
       return !findParentNodeOfType([...nodeTypes])(selection);
     }
   }

package/addon/plugins/standard-template-plugin/utils/nodes.ts

@@ -127,14 +127,12 @@ export const article_container: NodeSpec = {
     {
       tag: 'div',
       getAttrs(element: HTMLElement) {
-        if (
-          hasRDFaAttribute(element, 'property', PROV('value')) &&
-          hasRDFaAttribute(element, 'typeof', BESLUIT('Besluit'))
-        ) {
+        if (hasRDFaAttribute(element, 'property', PROV('value'))) {
           return getRdfaAttrs(element);
         }
         return false;
       },
+      context: 'besluit/',
     },
   ],
 };
@@ -279,6 +277,7 @@ export const besluit_article_header: NodeSpec = {
 };
 
 export const besluit_article_content: NodeSpec = {
+  group: 'block',
   content: 'block+',
   inline: false,
   attrs: {
@@ -302,6 +301,7 @@ export const besluit_article_content: NodeSpec = {
         }
         return false;
       },
+      context: 'besluit_article//',
     },
   ],
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lblod/ember-rdfa-editor-lblod-plugins",
-  "version": "4.0.1",
+  "version": "4.0.2",
   "description": "Ember addon providing lblod specific plugins for the ember-rdfa-editor",
   "keywords": [
     "ember-addon",