@lblod/ember-rdfa-editor-lblod-plugins 26.3.0 → 26.3.1-dev.0425a0927cdcb0fddfc50cf066a29539f400e92a

package/.changeset/tough-queens-hide.md

@@ -0,0 +1,5 @@
+---
+'@lblod/ember-rdfa-editor-lblod-plugins': patch
+---
+
+Removed the need of specify the type in the citaten plugin config

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @lblod/ember-rdfa-editor-lblod-plugins
 
+## 26.3.1
+
+### Patch Changes
+
+- [`18068ff`](https://github.com/lblod/ember-rdfa-editor-lblod-plugins/commit/18068ffae2fda5ba4f34568d9e03c06ffe7b4b2f) Thanks [@lagartoverde](https://github.com/lagartoverde)! - Trigger release because of a npm error
+
 ## 26.3.0
 
 ### Minor Changes

package/README.md

@@ -326,7 +326,6 @@ Make `this.citationPlugin` a tracked reference to the plugin created with the fu
   import { citationPlugin } from '@lblod/ember-rdfa-editor-lblod-plugins/plugins/citation-plugin';
 
   @tracked citationPlugin = citationPlugin({
-    type: 'nodes',
     activeInNodeTypes(schema) {
       return new Set([schema.nodes.motivering]);
     },
@@ -335,10 +334,10 @@ Make `this.citationPlugin` a tracked reference to the plugin created with the fu
 
 Configuration:
 
-- type (optional): it can either be 'nodes', or 'ranges'
-  * if 'nodes' is selected, you are expected to pass the `activeInNode` function. It's a function which expects an instance of a prosemirror node and returns whether it should be active in that node. The previously expected `activeInNodeTypes` is marked as deprecated and will be removed in a future release.
-  * if 'ranges' is selected, you are expected to pass the `activeInRanges` function. 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]]`
-  * if no type is provided, the citation plugin will be activated document-wide
+- You are expected to set one of two functions
+  * `activeInNode` function. It's a function which expects an instance of a prosemirror node and returns whether it should be active in that node.
+  * `activeInRanges` function. 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]]`.
+  * If no function is provided, the citation plugin will be activated document-wide, if both are provided, it will try to do it best in combining the two but this is not encouraged.
 
 - regex: you can provide your custom regex to detect citations, if not the default one will be used
 
@@ -348,14 +347,12 @@ A common usecase is to have the plugin active in the entire document. Here's how
 import { citationPlugin } from '@lblod/ember-rdfa-editor-lblod-plugins/plugins/citation-plugin';
 
 const configA = {
-  type: 'nodes',
   activeInNode(node, state) {
     return node.type === state.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

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

@@ -64,35 +64,43 @@ export default class EditorPluginsCitationInsertComponent extends Component<Args
     }
     const { selection } = this.controller.mainEditorState;
     const config = this.config;
-    if (!('type' in config)) {
-      // Enable plugin document wide
-      return false;
-    }
-    if (config.type === 'ranges') {
+    if (config.activeInRanges) {
+      let activeInRange;
       const ranges = config.activeInRanges(this.controller.mainEditorState);
       for (const range of ranges) {
         if (selection.from > range[0] && selection.from < range[1]) {
-          return false;
+          activeInRange = true;
         }
       }
-      return true;
-    } else {
-      let condition: (node: PNode) => boolean;
-      if ('activeInNodeTypes' in config) {
-        const nodeTypes = config.activeInNodeTypes(
-          this.controller.schema,
-          this.controller.mainEditorState,
-        );
-        condition = (node) => nodeTypes.has(node.type);
-      } else {
-        condition = (node) =>
-          config.activeInNode(node, this.controller.mainEditorState);
-      }
+      if (!activeInRange) return true;
+    }
+    let condition: ((node: PNode) => boolean) | undefined;
+    const { activeInNode, activeInNodeTypes } = config;
+    if (activeInNodeTypes && activeInNode) {
+      const nodeTypes = activeInNodeTypes(
+        this.controller.schema,
+        this.controller.mainEditorState,
+      );
+      condition = (node) =>
+        nodeTypes.has(node.type) &&
+        activeInNode(node, this.controller.mainEditorState);
+    } else if (activeInNodeTypes) {
+      const nodeTypes = activeInNodeTypes(
+        this.controller.schema,
+        this.controller.mainEditorState,
+      );
+      condition = (node) => nodeTypes.has(node.type);
+    } else if (activeInNode) {
+      condition = (node) => activeInNode(node, this.controller.mainEditorState);
+    }
 
+    if (condition) {
       if (condition(this.controller.mainEditorState.doc)) {
         return false;
       }
       return !findParentNode(condition)(selection);
+    } else {
+      return false;
     }
   }
 

package/addon/plugins/citation-plugin/index.ts

@@ -120,34 +120,13 @@ export interface CitationPluginState {
 
 export type CitationPlugin = ProsePlugin<CitationPluginState>;
 
-export type CitationPluginNodeConfig = CitationPluginBaseConfig & {
-  type: 'nodes';
-} & (
-    | {
-        /**
-         * @deprecated use the `activeInNode` property instead
-         */
-        activeInNodeTypes(schema: Schema, state: EditorState): Set<NodeType>;
-      }
-    | {
-        activeInNode(node: PNode, state?: EditorState): boolean;
-      }
-  );
-
-export type CitationPluginRangeConfig = CitationPluginBaseConfig & {
-  type: 'ranges';
-  activeInRanges(state: EditorState): [number, number][];
-};
-
-export type CitationPluginBaseConfig = {
+export type CitationPluginConfig = {
   regex?: RegExp;
+  activeInRanges?: (state: EditorState) => [number, number][];
+  activeInNodeTypes?: (schema: Schema, state: EditorState) => Set<NodeType>;
+  activeInNode?: (node: PNode, state?: EditorState) => boolean;
 };
 
-export type CitationPluginConfig =
-  | CitationPluginBaseConfig
-  | CitationPluginNodeConfig
-  | CitationPluginRangeConfig;
-
 export type CitationPluginEmberComponentConfig = CitationPluginConfig & {
   endpoint: string;
   decisionsEndpoint?: string;
@@ -190,40 +169,56 @@ function calculateCitationPluginState(
   oldDecs?: DecorationSet,
 ) {
   const { doc, schema } = state;
-  let activeRanges;
-  let highlights;
-  if ('type' in config) {
-    if (config.type === 'ranges') {
+  let activeRanges: [number, number][] = [];
+  let highlights: DecorationSet | undefined;
+
+  if (config.activeInNodeTypes || config.activeInNode) {
+    let condition: (node: PNode) => boolean = () => false;
+    const { activeInNode, activeInNodeTypes } = config;
+    if (activeInNodeTypes && activeInNode) {
+      const nodeTypes = activeInNodeTypes(schema, state);
+      condition = (node) => {
+        return nodeTypes.has(node.type) || activeInNode(node, state);
+      };
+    } else if (activeInNodeTypes) {
+      const nodeTypes = activeInNodeTypes(schema, state);
+      condition = (node) => {
+        return nodeTypes.has(node.type);
+      };
+    } else if (activeInNode) {
+      condition = (node) => activeInNode(node, state);
+    }
+    if (config.activeInRanges) {
       activeRanges = config.activeInRanges(state);
       const calculatedDecs = calculateDecorationsInRanges(
         config,
         schema,
         doc,
         activeRanges,
+        condition,
       );
       highlights = calculatedDecs.decorations;
     } else {
-      let condition: (node: PNode) => boolean;
-      if ('activeInNodeTypes' in config) {
-        const nodeTypes = config.activeInNodeTypes(schema, state);
-        condition = (node) => {
-          return nodeTypes.has(node.type);
-        };
-      } else {
-        condition = (node) => config.activeInNode(node, state);
-      }
-
       const calculatedDecs = calculateDecorationsInNodes(
         config,
         schema,
         condition,
         doc,
         oldState?.doc,
-        oldDecs,
+        highlights || oldDecs,
       );
       activeRanges = calculatedDecs.activeRanges;
       highlights = calculatedDecs.decorations;
     }
+  } else if (config.activeInRanges) {
+    activeRanges = config.activeInRanges(state);
+    const calculatedDecs = calculateDecorationsInRanges(
+      config,
+      schema,
+      doc,
+      activeRanges,
+    );
+    highlights = calculatedDecs.decorations;
   } else {
     const calculatedDecs = calculateDecorationsInNodes(
       config,
@@ -236,7 +231,9 @@ function calculateCitationPluginState(
     activeRanges = calculatedDecs.activeRanges;
     highlights = calculatedDecs.decorations;
   }
-
+  if (!highlights) {
+    highlights = DecorationSet.create(doc, []);
+  }
   return {
     highlights,
     activeRanges,
@@ -305,6 +302,7 @@ function calculateDecorationsInRanges(
   schema: CitationSchema,
   doc: PNode,
   activeRanges: [number, number][],
+  condition?: (node: PNode) => boolean,
 ): { decorations: DecorationSet; activeRanges: [number, number][] } {
   const decorationsToAdd: Decoration[] = [];
   const collector = collectDecorations(
@@ -315,7 +313,12 @@ function calculateDecorationsInRanges(
   );
 
   for (const [start, end] of activeRanges) {
-    doc.nodesBetween(start, end, collector);
+    doc.nodesBetween(start, end, (node, pos) => {
+      if (condition && !condition(node)) {
+        return false;
+      }
+      return collector(node, pos);
+    });
   }
   return {
     decorations: DecorationSet.create(doc, decorationsToAdd),

package/declarations/addon/plugins/citation-plugin/index.d.ts

@@ -20,24 +20,12 @@ export interface CitationPluginState {
     activeRanges: [number, number][];
 }
 export type CitationPlugin = ProsePlugin<CitationPluginState>;
-export type CitationPluginNodeConfig = CitationPluginBaseConfig & {
-    type: 'nodes';
-} & ({
-    /**
-     * @deprecated use the `activeInNode` property instead
-     */
-    activeInNodeTypes(schema: Schema, state: EditorState): Set<NodeType>;
-} | {
-    activeInNode(node: PNode, state?: EditorState): boolean;
-});
-export type CitationPluginRangeConfig = CitationPluginBaseConfig & {
-    type: 'ranges';
-    activeInRanges(state: EditorState): [number, number][];
-};
-export type CitationPluginBaseConfig = {
+export type CitationPluginConfig = {
     regex?: RegExp;
+    activeInRanges?: (state: EditorState) => [number, number][];
+    activeInNodeTypes?: (schema: Schema, state: EditorState) => Set<NodeType>;
+    activeInNode?: (node: PNode, state?: EditorState) => boolean;
 };
-export type CitationPluginConfig = CitationPluginBaseConfig | CitationPluginNodeConfig | CitationPluginRangeConfig;
 export type CitationPluginEmberComponentConfig = CitationPluginConfig & {
     endpoint: string;
     decisionsEndpoint?: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lblod/ember-rdfa-editor-lblod-plugins",
-  "version": "26.3.0",
+  "version": "26.3.1-dev.0425a0927cdcb0fddfc50cf066a29539f400e92a",
   "description": "Ember addon providing lblod specific plugins for the ember-rdfa-editor",
   "keywords": [
     "ember-addon",