@lblod/ember-rdfa-editor-lblod-plugins 2.1.0 → 2.1.1

package/.release-it.json

@@ -3,12 +3,14 @@
     "release": true
   },
   "plugins": {
-    "@release-it-plugins/lerna-changelog": {
-      "infile": "CHANGELOG.md",
-      "launchEditor": true
+    "@release-it/keep-a-changelog": {
+      "filename": "CHANGELOG.md",
+      "addUnreleased": true,
+      "strictLatest": false,
+      "addVersionUrl": true
     }
   },
   "npm": {
     "publish": false
   }
-}
+}

package/CHANGELOG.md

@@ -1,31 +1,41 @@
+# Changelog
 
+All notable changes to this project will be documented in this file.
 
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [Unreleased]
 
+## [2.1.1] - 2023-02-07
 
+### Changed
 
+- move to keep-a-changelog for changelog management
+- bump editor to v2.1.2
+- bump editor to v2.1.1
 
+### Added
 
+- add types for the `debug` lib
 
+### Fixed
 
+- correctly set the date type as xsd:date or xsd:dateTime based on the date content
+- Add the __rdfaId when manually creating decisions titles, decision articles or citations
+- fix citation highlights not triggering correctly in various situations
 
-
-
-
-
-
-
-
-
-
-
-## 2.1.0 (2023-02-06)
+## [2.1.0] - 2023-02-06
 
 #### :rocket: Enhancement
-* [#98](https://github.com/lblod/ember-rdfa-editor-lblod-plugins/pull/98) Improve citation plugin regex and improve citation type matching ([@elpoelma](https://github.com/elpoelma))
+
+* [#98](https://github.com/lblod/ember-rdfa-editor-lblod-plugins/pull/98) Improve citation plugin regex and improve
+  citation type matching ([@elpoelma](https://github.com/elpoelma))
 
 #### :bug: Bug Fix
-* [#96](https://github.com/lblod/ember-rdfa-editor-lblod-plugins/pull/96) Fix insert-citation button not being enabled in correct context. ([@elpoelma](https://github.com/elpoelma))
+
+* [#96](https://github.com/lblod/ember-rdfa-editor-lblod-plugins/pull/96) Fix insert-citation button not being enabled
+  in correct context. ([@elpoelma](https://github.com/elpoelma))
 * [#100](https://github.com/lblod/ember-rdfa-editor-lblod-plugins/pull/100) Prevent splitting of besluit related nodes ([@elpoelma](https://github.com/elpoelma))
 * [#97](https://github.com/lblod/ember-rdfa-editor-lblod-plugins/pull/97) Fix: disallow splitting of besluit node ([@elpoelma](https://github.com/elpoelma))
 
@@ -305,3 +315,6 @@ add onclick handler to pencil icon in variable plugin
 - Elena Poelman ([@elpoelma](https://github.com/elpoelma))
 
 # Changelog
+
+[unreleased]: https://github.com/lblod/ember-rdfa-editor-lblod-plugins/compare/v2.1.1...HEAD
+[2.1.1]: https://github.com/lblod/ember-rdfa-editor-lblod-plugins/compare/v2.1.0...v2.1.1

package/addon/components/rdfa-date-plugin/card.ts

@@ -5,6 +5,7 @@ import { ProseController } from '@lblod/ember-rdfa-editor/core/prosemirror';
 import { NodeSelection, PNode } from '@lblod/ember-rdfa-editor';
 import { DateFormat } from '@lblod/ember-rdfa-editor-lblod-plugins/plugins/rdfa-date-plugin';
 import {
+  formatContainsTime,
   validateDateFormat,
   ValidationError,
 } from '@lblod/ember-rdfa-editor-lblod-plugins/plugins/rdfa-date-plugin/utils';
@@ -28,7 +29,6 @@ type Args = {
     };
   };
 };
-const TIME_CHAR_REGEX = new RegExp('[abBhHkKmsStTp]');
 const SECONDS_REGEX = new RegExp('[sStT]|p{2,}');
 export default class RdfaDatePluginCardComponent extends Component<Args> {
   @service
@@ -84,8 +84,7 @@ export default class RdfaDatePluginCardComponent extends Component<Args> {
     return optionMapOr(
       false,
       (node) => {
-        const format = node.attrs.format as string;
-        return !TIME_CHAR_REGEX.test(format);
+        return !formatContainsTime(node.attrs.format);
       },
       this.selectedDateNode
     );
@@ -96,7 +95,7 @@ export default class RdfaDatePluginCardComponent extends Component<Args> {
       false,
       (node) => {
         const format = node.attrs.format as string;
-        return SECONDS_REGEX.test(format);
+        return SECONDS_REGEX.test(format.replace(/'[^']*'|"[^"]*"/g, ''));
       },
       this.selectedDateNode
     );
@@ -209,7 +208,7 @@ export default class RdfaDatePluginCardComponent extends Component<Args> {
       return tr
         .setNodeAttribute(pos, 'format', dateFormat)
         .setNodeAttribute(pos, 'custom', custom)
-        .setNodeAttribute(pos, 'onlyDate', this.onlyDate);
+        .setNodeAttribute(pos, 'onlyDate', !formatContainsTime(dateFormat));
     }, true);
   }
 
@@ -243,7 +242,7 @@ export default class RdfaDatePluginCardComponent extends Component<Args> {
       this.controller.withTransaction((tr) => {
         return tr
           .setNodeAttribute(pos, 'format', format)
-          .setNodeAttribute(pos, 'onlyDate', this.onlyDate);
+          .setNodeAttribute(pos, 'onlyDate', !formatContainsTime(format));
       }, true);
     }
   }

package/addon/plugins/besluit-plugin/commands/insert-title.ts

@@ -1,6 +1,7 @@
 import { findParentNodeOfType } from '@curvenote/prosemirror-utils';
 import { Command, NodeSelection } from '@lblod/ember-rdfa-editor';
 import IntlService from 'ember-intl/services/intl';
+import { v4 as uuid } from 'uuid';
 
 export default function insertTitle(intl: IntlService): Command {
   return function (state, dispatch) {
@@ -19,7 +20,7 @@ export default function insertTitle(intl: IntlService): Command {
         besluit.pos + 1,
         schema.node(
           'title',
-          null,
+          { __rdfaId: uuid() },
           schema.node(
             'paragraph',
             null,

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

@@ -26,6 +26,7 @@ const NNWS = '[^\\S\\n]';
 
 /**
  * match for a "decree"
+ * the "t" at the end is not a typo
  */
 const DECREE = `\\w*decreet`;
 
@@ -56,7 +57,11 @@ const FLEMGOV = `besluit${VVR}`;
  * match for "coordinated laws"
  * whatever that may be
  */
-const COORD = `geco[öo]rdineerde${NNWS}wetten`;
+const COORD = `geco[öo]rdineerde${NNWS}wet(ten)?`;
+/**
+ * literally "special law"
+ */
+const SPECIAL = `bijzondere${NNWS}wet`;
 /**
  * Matches any kind of law
  */
@@ -80,13 +85,13 @@ const ENUM_ROYAL = `genummerd${NNWS}?${ROYAL}`;
 /**
  * The type of citation that we need to search for
  */
-const TYPE = `${DECREE}|${MEMO}|${TREATY}|${CONSTITUTION_CHANGE}|${COLLAB}|${BOOK}|${PROTOCOL}|${FLEMGOV}|${COORD}|${LAW}|${ROYAL}|${MINISTERIAL}|${ENUM_ROYAL}`;
+const TYPE = `${DECREE}|${MEMO}|${TREATY}|${CONSTITUTION_CHANGE}|${COLLAB}|${BOOK}|${PROTOCOL}|${FLEMGOV}|${COORD}|${SPECIAL}|${LAW}|${ROYAL}|${MINISTERIAL}|${ENUM_ROYAL}`;
 /**
  * The monster regex that makes the citation plugin trigger.
  * In restructuring, I've made sure that I didn't abstract away any of the capturing groups,
  * only their content, so you can still see what's going on
  *
- * This regex uses named capturing groups, that's the "?<name>" syntax for easy parsing later
+ * This regex uses named capturing groups, that's the "?<name>" syntax, for easy parsing later
  */
 export const CITATION_REGEX = new RegExp(
   `((?<type>${TYPE})${NNWS}*(?<searchTerms>(${NNWS}|[${BASIC_MULTIPLANE_CHARACTER};:'"()&-_]){3,})?)`,
@@ -179,8 +184,13 @@ function citationPlugin(config: CitationPluginConfig): CitationPlugin {
       init(stateConfig: EditorStateConfig, state: EditorState) {
         return calculateCitationPluginState(state, config);
       },
-      apply(tr, set, oldState, newState) {
-        return calculateCitationPluginState(newState, config, oldState);
+      apply(tr, oldPluginState, oldState, newState) {
+        return calculateCitationPluginState(
+          newState,
+          config,
+          oldState,
+          oldPluginState.highlights.map(tr.mapping, tr.doc)
+        );
       },
     },
     props: {
@@ -195,7 +205,8 @@ function citationPlugin(config: CitationPluginConfig): CitationPlugin {
 function calculateCitationPluginState(
   state: EditorState,
   config: CitationPluginConfig,
-  oldState?: EditorState
+  oldState?: EditorState,
+  oldDecs?: DecorationSet
 ) {
   const { doc, schema } = state;
   let activeRanges;
@@ -216,7 +227,8 @@ function calculateCitationPluginState(
       schema,
       nodes,
       doc,
-      oldState?.doc
+      oldState?.doc,
+      oldDecs
     );
     activeRanges = calculatedDecs.activeRanges;
     highlights = calculatedDecs.decorations;
@@ -232,11 +244,19 @@ function calculateDecorationsInNodes(
   schema: CitationSchema,
   nodes: Set<NodeType>,
   newDoc: PNode,
-  oldDoc?: PNode
+  oldDoc?: PNode,
+  oldDecorations?: DecorationSet
 ): { decorations: DecorationSet; activeRanges: [number, number][] } {
   const activeRanges: [number, number][] = [];
-  const decorations: Decoration[] = [];
-  const collector = collectDecorations(decorations, schema, config.regex);
+  const decsToAdd: Decoration[] = [];
+  const decsToRemove: Decoration[] = [];
+  const collector = collectDecorations(
+    decsToAdd,
+    schema,
+    config.regex,
+    decsToRemove,
+    oldDecorations
+  );
   if (nodes.has(newDoc.type)) {
     oldDoc
       ? changedDescendants(oldDoc, newDoc, 0, collector)
@@ -268,7 +288,9 @@ function calculateDecorationsInNodes(
         });
   }
   return {
-    decorations: DecorationSet.create(newDoc, decorations),
+    decorations: oldDecorations
+      ? oldDecorations.remove(decsToRemove).add(newDoc, decsToAdd)
+      : DecorationSet.create(newDoc, decsToAdd),
     activeRanges,
   };
 }
@@ -279,22 +301,24 @@ function calculateDecorationsInRanges(
   doc: PNode,
   activeRanges: [number, number][]
 ): { decorations: DecorationSet; activeRanges: [number, number][] } {
-  const decorations: Decoration[] = [];
-  const collector = collectDecorations(decorations, schema, config.regex);
+  const decorationsToAdd: Decoration[] = [];
+  const collector = collectDecorations(decorationsToAdd, schema, config.regex);
 
   for (const [start, end] of activeRanges) {
     doc.nodesBetween(start, end, collector);
   }
   return {
-    decorations: DecorationSet.create(doc, decorations),
+    decorations: DecorationSet.create(doc, decorationsToAdd),
     activeRanges: activeRanges,
   };
 }
 
 function collectDecorations(
-  decorations: Decoration[],
+  decsToAdd: Decoration[],
   schema: CitationSchema,
-  regex: RegExp = CITATION_REGEX
+  regex: RegExp = CITATION_REGEX,
+  decsToRemove?: Decoration[],
+  oldDecs?: DecorationSet
 ) {
   return function (node: PNode, pos: number): boolean {
     if (
@@ -302,6 +326,17 @@ function collectDecorations(
       node.text &&
       !schema.marks.citation.isInSet(node.marks)
     ) {
+      if (decsToRemove && oldDecs) {
+        decsToRemove.push(
+          ...oldDecs.find(
+            pos,
+            pos + node.nodeSize,
+            (spec) =>
+              (spec as Record<string, string>).name === 'citationHighlight'
+          )
+        );
+      }
+
       for (const match of node.text.matchAll(regex)) {
         const processedMatch = processMatch(
           match as RegexpMatchArrayWithIndices
@@ -312,7 +347,7 @@ function collectDecorations(
           const { start: matchStart, end: matchEnd } = searchTextMatch;
           const decorationStart = pos + matchStart;
           const decorationEnd = pos + matchEnd;
-          decorations.push(
+          decsToAdd.push(
             Decoration.inline(
               decorationStart,
               decorationEnd,
@@ -321,6 +356,7 @@ function collectDecorations(
                 'data-editor-highlight': 'true',
               },
               {
+                name: 'citationHighlight',
                 searchText: text,
                 legislationTypeUri,
               }

package/addon/plugins/citation-plugin/utils/cited-text.ts

@@ -1,6 +1,7 @@
 import { PNode } from '@lblod/ember-rdfa-editor';
 import { CitationSchema } from '@lblod/ember-rdfa-editor-lblod-plugins/plugins/citation-plugin';
 import { unwrap } from '@lblod/ember-rdfa-editor-lblod-plugins/utils/option';
+import { v4 as uuid } from 'uuid';
 
 export function citedText(
   schema: CitationSchema,
@@ -12,6 +13,7 @@ export function citedText(
       href: uri,
       property: 'eli:cites',
       typeof: 'eli:LegalExpression',
+      __rdfaId: uuid(),
     }),
   ]);
 }

package/addon/plugins/citation-plugin/utils/process-match.ts

@@ -5,7 +5,8 @@ import { unwrap } from '@lblod/ember-rdfa-editor-lblod-plugins/utils/option';
 const STOP_WORDS = ['het', 'de', 'van', 'tot', 'dat'];
 const DATE_REGEX = new RegExp('(\\d{1,2})\\s(\\w+)\\s(\\d{2,4})', 'g');
 const INVISIBLE_SPACE = '\u200B';
-const SPACES_REGEX = new RegExp('[\\s${UNBREAKABLE_SPACE}]+');
+const UNBREAKABLE_SPACE = '\u00A0';
+const SPACES_REGEX = new RegExp(`[\\s${UNBREAKABLE_SPACE}]+`);
 export type RegexpMatchArrayWithIndices = RegExpMatchArray & {
   indices: Array<[number, number]> & {
     groups: { [key: string]: [number, number] };
@@ -57,13 +58,13 @@ export default function processMatch(
       cleanedSearchTerms = `${type} ${cleanedSearchTerms}`;
     } else if (/wetboek/i.test(type)) {
       typeLabel = 'wetboek';
-    } else if (/geco[oö]rdineerde[^\S\n]wetten/i.test(type)) {
+    } else if (/geco[oö]rdineerde[^\S\n]wet(ten)?/i.test(type)) {
       typeLabel = 'gecoördineerde wetten';
     } else if (/grondwets?wijziging/i.test(type)) {
       typeLabel = 'grondwetswijziging';
     } else if (/grondwet/i.test(type)) {
       typeLabel = 'grondwet';
-    } else if (/bijzondere wet/i.test(type)) {
+    } else if (/bijzondere[^\S\n]wet/i.test(type)) {
       typeLabel = 'bijzondere wet';
     } else if (/\w+wet/i.test(type)) {
       typeLabel = 'wet';

package/addon/plugins/rdfa-date-plugin/utils.ts

@@ -2,6 +2,8 @@ import { formatWithOptions } from 'date-fns/fp';
 import { nlBE } from 'date-fns/locale';
 import { RegexpMatchArrayWithIndices } from '@lblod/ember-rdfa-editor-lblod-plugins/plugins/citation-plugin/utils/process-match';
 
+const TIME_CHAR_REGEX = new RegExp('[abBhHkKmsStTp]');
+
 export function formatDate(date: Date, format: string) {
   try {
     return formatWithOptions({ locale: nlBE }, format)(date);
@@ -10,6 +12,10 @@ export function formatDate(date: Date, format: string) {
   }
 }
 
+export function formatContainsTime(format: string) {
+  return TIME_CHAR_REGEX.test(format.replace(/'[^']*'|"[^"]*"/g, ''));
+}
+
 type ValidationErrorType =
   | 'date'
   | 'locale'

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

@@ -187,12 +187,18 @@ export const besluitArticleStructure: StructureSpec = {
     const numberConverted = number?.toString() ?? '1';
     const node = schema.node(
       `besluit_article`,
-      { resource: `http://data.lblod.info/articles/${uuid()}` },
+      {
+        resource: `http://data.lblod.info/articles/${uuid()}`,
+        __rdfaId: uuid(),
+      },
       [
-        schema.node('besluit_article_header', { number: numberConverted }),
+        schema.node('besluit_article_header', {
+          number: numberConverted,
+          __rdfaId: uuid(),
+        }),
         schema.node(
           `besluit_article_content`,
-          {},
+          { __rdfaId: uuid() },
           content ??
             schema.node(
               'paragraph',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lblod/ember-rdfa-editor-lblod-plugins",
-  "version": "2.1.0",
+  "version": "2.1.1",
   "description": "Ember addon providing lblod specific plugins for the ember-rdfa-editor",
   "keywords": [
     "ember-addon",
@@ -63,10 +63,11 @@
     "@embroider/test-setup": "^1.6.0",
     "@glimmer/component": "^1.1.2",
     "@glimmer/tracking": "^1.1.2",
-    "@lblod/ember-rdfa-editor": "^2.1.0",
+    "@lblod/ember-rdfa-editor": "^2.1.2",
     "@rdfjs/types": "^1.1.0",
-    "@release-it-plugins/lerna-changelog": "^5.0.0",
+    "@release-it/keep-a-changelog": "^3.1.0",
     "@tsconfig/ember": "^1.0.1",
+    "@types/debug": "^4.1.7",
     "@types/ember": "^4.0.2",
     "@types/ember__application": "^4.0.4",
     "@types/ember__array": "^4.0.3",
@@ -145,7 +146,7 @@
   },
   "peerDependencies": {
     "@appuniversum/ember-appuniversum": "^2.2.0",
-    "@lblod/ember-rdfa-editor": "^2.0.1",
+    "@lblod/ember-rdfa-editor": "^2.1.2",
     "ember-concurrency": "^2.3.7"
   },
   "engines": {

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

@@ -4,7 +4,7 @@ import { Decoration, DecorationSet, EditorState, InlineDecorationSpec, MarkSpec,
  * In restructuring, I've made sure that I didn't abstract away any of the capturing groups,
  * only their content, so you can still see what's going on
  *
- * This regex uses named capturing groups, that's the "?<name>" syntax for easy parsing later
+ * This regex uses named capturing groups, that's the "?<name>" syntax, for easy parsing later
  */
 export declare const CITATION_REGEX: RegExp;
 export type CitationSchema = Schema<string, 'citation'>;

package/plugins/rdfa-date-plugin/utils.d.ts

@@ -1,4 +1,5 @@
 export declare function formatDate(date: Date, format: string): string;
+export declare function formatContainsTime(format: string): boolean;
 type ValidationErrorType = 'date' | 'locale' | 'use-yyyy' | 'use-yy' | 'use-d' | 'use-dd' | 'character' | 'required' | 'fractions' | 'unknown';
 interface ValidationOk {
     type: 'ok';