@lblod/ember-rdfa-editor-lblod-plugins 33.0.0 → 33.1.0-dev.367f7322beb7deee231dd44356f445bd1d6515fd

package/.changeset/eleven-jeans-yell.md

@@ -0,0 +1,5 @@
+---
+'@lblod/ember-rdfa-editor-lblod-plugins': minor
+---
+
+roadsign-regulation-plugin: add support for inserting mobility-measures based on VKS measure-designs

package/CHANGELOG.md

@@ -1,5 +1,15 @@
 # @lblod/ember-rdfa-editor-lblod-plugins
 
+## 33.1.0
+
+### Minor Changes
+
+- [#589](https://github.com/lblod/ember-rdfa-editor-lblod-plugins/pull/589) [`380f999`](https://github.com/lblod/ember-rdfa-editor-lblod-plugins/commit/380f9998e6c8f37f1c7be5bf2be528884f24a850) Thanks [@lagartoverde](https://github.com/lagartoverde)! - Add actions to document validation plugin
+
+### Patch Changes
+
+- [#608](https://github.com/lblod/ember-rdfa-editor-lblod-plugins/pull/608) [`7d01346`](https://github.com/lblod/ember-rdfa-editor-lblod-plugins/commit/7d01346456985efa3fc4438c828b4fbc31de297e) Thanks [@lagartoverde](https://github.com/lagartoverde)! - Fix ordering of measures in IRGN plugin
+
 ## 33.0.0
 
 ### Major Changes

package/addon/components/besluit-topic-plugin/besluit-topic-toolbar-dropdown.ts

@@ -15,7 +15,7 @@ import {
 import {
   getCurrentBesluitRange,
   getCurrentBesluitURI,
-} from '@lblod/ember-rdfa-editor-lblod-plugins/plugins/besluit-topic-plugin/utils/helpers';
+} from '@lblod/ember-rdfa-editor-lblod-plugins/utils/decision-utils';
 import {
   updateBesluitTopicResource,
   TOPIC_PREDICATE,

package/addon/components/besluit-type-plugin/toolbar-dropdown.gts

@@ -16,7 +16,7 @@ import { CircleXIcon } from '@appuniversum/ember-appuniversum/components/icons/c
 import { SayController } from '@lblod/ember-rdfa-editor';
 import fetchBesluitTypes from '@lblod/ember-rdfa-editor-lblod-plugins/plugins/besluit-type-plugin/utils/fetchBesluitTypes';
 import { BesluitTypePluginOptions } from '@lblod/ember-rdfa-editor-lblod-plugins/plugins/besluit-type-plugin';
-import { getCurrentBesluitRange } from '@lblod/ember-rdfa-editor-lblod-plugins/plugins/besluit-topic-plugin/utils/helpers';
+import { getCurrentBesluitRange } from '@lblod/ember-rdfa-editor-lblod-plugins/utils/decision-utils';
 import {
   BesluitTypeInstance,
   checkBesluitTypeInstance,

package/addon/components/decision-plugin/decision-plugin-card.gts

@@ -23,7 +23,7 @@ import { on } from '@ember/modifier';
 import { not } from 'ember-truth-helpers';
 import t from 'ember-intl/helpers/t';
 import { TemplateOnlyComponent } from '@ember/component/template-only';
-import { getCurrentBesluitRange } from '@lblod/ember-rdfa-editor-lblod-plugins/plugins/besluit-topic-plugin/utils/helpers';
+import { getCurrentBesluitRange } from '@lblod/ember-rdfa-editor-lblod-plugins/utils/decision-utils';
 
 interface DecisionCardOptions {
   articleUriGenerator?: () => string;
@@ -145,12 +145,13 @@ export default class DecisionPluginCard extends Component<Sig> {
   }
   @action
   insertArticleBlock() {
-    if (this.decisionUri) {
+    if (this.decisionUri && this.decisionNodeLocation) {
       this.controller.doCommand(
         insertArticleContainer({
           intl: this.intl,
           decisionUri: this.decisionUri,
           articleUriGenerator: this.args.options?.articleUriGenerator,
+          decisionLocation: this.decisionNodeLocation,
         }),
         {
           view: this.controller.mainEditorView,

package/addon/components/decision-plugin/insert-article.gts

@@ -4,7 +4,7 @@ import { action } from '@ember/object';
 import Component from '@glimmer/component';
 import { AddIcon } from '@appuniversum/ember-appuniversum/components/icons/add';
 import { PNode, SayController } from '@lblod/ember-rdfa-editor';
-import { getCurrentBesluitRange } from '@lblod/ember-rdfa-editor-lblod-plugins/plugins/besluit-topic-plugin/utils/helpers';
+import { getCurrentBesluitRange } from '@lblod/ember-rdfa-editor-lblod-plugins/utils/decision-utils';
 import { buildArticleStructure } from '@lblod/ember-rdfa-editor-lblod-plugins/plugins/decision-plugin/utils/build-article-structure';
 import { not } from 'ember-truth-helpers';
 import { service } from '@ember/service';

package/addon/components/document-validation-plugin/card.gts

@@ -12,6 +12,8 @@ import AuButton from '@appuniversum/ember-appuniversum/components/au-button';
 import { ExternalLinkIcon } from '@appuniversum/ember-appuniversum/components/icons/external-link';
 import t from 'ember-intl/helpers/t';
 import { eq } from 'ember-truth-helpers';
+import ValidationReport from 'rdf-validate-shacl/src/validation-report';
+import { CircleInfoIcon } from '@appuniversum/ember-appuniversum/components/icons/circle-info';
 
 interface Sig {
   Args: {
@@ -19,6 +21,17 @@ interface Sig {
   };
 }
 
+type ExtractWithKey<T, K extends PropertyKey> = T extends Record<K, unknown>
+  ? T
+  : never;
+
+function hasProperty<
+  O extends object = object,
+  K extends PropertyKey = PropertyKey,
+>(obj: O, key: K): obj is ExtractWithKey<O, K> {
+  return key in obj;
+}
+
 export default class DocumentValidationPluginCard extends Component<Sig> {
   get controller() {
     return this.args.controller;
@@ -37,10 +50,26 @@ export default class DocumentValidationPluginCard extends Component<Sig> {
   }
   get documentValidationErrors() {
     if (!this.validationState) return [];
-    const { propertiesWithErrors } = this.validationState;
+
+    const { propertiesWithErrors, rules } = this.validationState;
     if (!propertiesWithErrors) return undefined;
 
-    return propertiesWithErrors;
+    const documentValidationErrors = propertiesWithErrors.map((property) => {
+      const rule = rules.find((rule) => property?.shape === rule.shaclRule);
+      if (rule && 'violations' in rule) {
+        const rulePerConstraint = rule.violations[property?.constraint];
+        return {
+          ...property,
+          rule: rulePerConstraint,
+        };
+      } else {
+        return {
+          ...property,
+          rule: rule,
+        };
+      }
+    });
+    return documentValidationErrors;
   }
   get propertiesWithoutErrors() {
     if (!this.validationState) return [];
@@ -65,6 +94,53 @@ export default class DocumentValidationPluginCard extends Component<Sig> {
     return ['valid', 'no-matches'].includes(this.status);
   }
 
+  doActionAndTriggerValidation = async (
+    action: (controller: SayController, report: ValidationReport) => void,
+  ) => {
+    action(this.controller, this.validationState?.report as ValidationReport);
+    const pluginState = documentValidationPluginKey.getState(
+      this.controller.mainEditorView.state,
+    );
+    if (!pluginState) return;
+    const { validationCallback } = pluginState;
+    await validationCallback(
+      this.controller.mainEditorView,
+      this.controller.htmlContent,
+    );
+  };
+
+  oldVal: typeof this.documentValidationErrors;
+
+  dedupeDocumentValidationErrors = (
+    val: typeof this.documentValidationErrors,
+  ) => {
+    if (this.compareDocumentValidationErrors(val, this.oldVal)) {
+      return this.oldVal;
+    } else {
+      this.oldVal = val;
+      return val;
+    }
+  };
+
+  compareDocumentValidationErrors = (
+    val1: typeof this.documentValidationErrors,
+    val2: typeof this.documentValidationErrors,
+  ) => {
+    if (!val1?.length) return false;
+    if (val1.length !== val2?.length) return false;
+    for (let i = 0; i < val1.length; i++) {
+      if (
+        !val1 ||
+        !val2 ||
+        !val1[i] ||
+        !val2[i] ||
+        val1[i].shape !== val2[i].shape
+      )
+        return false;
+    }
+    return true;
+  };
+
   <template>
     <AuCard
       @flex={{true}}
@@ -94,42 +170,63 @@ export default class DocumentValidationPluginCard extends Component<Sig> {
         </p>
       </c.header>
       <c.content>
-        <p class='au-u-medium au-u-para-small'>{{t
-            'document-validation-plugin.description'
-          }}</p>
-        {{#each this.documentValidationErrors as |error|}}
-          <div class='say-document-validation__error-container'>
-            <AuIcon
-              @icon={{CloseFilledIcon}}
-              @size='large'
-              @ariaHidden={{true}}
-              class='say-document-validation__icon-error au-u-margin-right-small'
-            />
-            <div>
-              {{error.message}}
-              <AuButton
-                class='au-u-padding-left-none au-u-padding-right-none'
-                @icon={{ExternalLinkIcon}}
-                @skin='link'
-                title={{error.subject}}
-                {{on 'click' (fn this.goToSubject error.subject)}}
-              >{{t 'document-validation-plugin.see-related-node'}}</AuButton>
-            </div>
-          </div>
-        {{/each}}
-        {{#each this.propertiesWithoutErrors as |property|}}
-          <div class='say-document-validation__error-container'>
-            <div class='au-u-margin-right-small'>
+        <div>
+          {{#each
+            (this.dedupeDocumentValidationErrors this.documentValidationErrors)
+            as |error|
+          }}
+            <div class='say-document-validation__error-container'>
               <AuIcon
-                @icon={{CheckFilledIcon}}
+                @icon={{CloseFilledIcon}}
                 @size='large'
                 @ariaHidden={{true}}
-                class='say-document-validation__icon-success'
+                class='say-document-validation__icon-error au-u-margin-right-small'
               />
+              <div>
+                {{error.message}}
+                <AuButton
+                  class='au-u-padding-left-none au-u-padding-right-none'
+                  @icon={{ExternalLinkIcon}}
+                  @skin='link'
+                  title={{error.subject}}
+                  {{on 'click' (fn this.goToSubject error.subject)}}
+                >{{t 'document-validation-plugin.see-related-node'}}</AuButton>
+                {{#if error.rule}}
+                  {{#if (hasProperty error.rule 'action')}}
+                    <AuButton
+                      class='au-u-padding-left-none au-u-padding-right-none'
+                      @icon={{ExternalLinkIcon}}
+                      @skin='link'
+                      title={{error.subject}}
+                      {{on
+                        'click'
+                        (fn this.doActionAndTriggerValidation error.rule.action)
+                      }}
+                    >{{error.rule.buttonTitle}}</AuButton>
+                  {{/if}}
+                  {{#if (hasProperty error.rule 'helpText')}}
+                    <span title={{error.rule.helpText}}>
+                      <AuIcon @icon={{CircleInfoIcon}} />
+                    </span>
+                  {{/if}}
+                {{/if}}
+              </div>
+            </div>
+          {{/each}}
+          {{#each this.propertiesWithoutErrors as |property|}}
+            <div class='say-document-validation__error-container'>
+              <div class='au-u-margin-right-small'>
+                <AuIcon
+                  @icon={{CheckFilledIcon}}
+                  @size='large'
+                  @ariaHidden={{true}}
+                  class='say-document-validation__icon-success'
+                />
+              </div>
+              {{property.message}}
             </div>
-            {{property.message}}
-          </div>
-        {{/each}}
+          {{/each}}
+        </div>
       </c.content>
 
     </AuCard>

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

@@ -11,7 +11,7 @@ import {
   type LpdcPluginConfig,
 } from '@lblod/ember-rdfa-editor-lblod-plugins/plugins/lpdc-plugin';
 import { v4 as uuidv4 } from 'uuid';
-import { getCurrentBesluitURI } from '../../plugins/besluit-topic-plugin/utils/helpers';
+import { getCurrentBesluitURI } from '@lblod/ember-rdfa-editor-lblod-plugins/utils/decision-utils';
 import { SRO } from '../../utils/constants';
 
 interface Args {

package/addon/components/roadsign-regulation-plugin/roadsign-regulation-card.gts

@@ -3,7 +3,7 @@ import { action } from '@ember/object';
 import Component from '@glimmer/component';
 import { tracked } from '@glimmer/tracking';
 import { SayController } from '@lblod/ember-rdfa-editor';
-import { getCurrentBesluitRange } from '@lblod/ember-rdfa-editor-lblod-plugins/plugins/besluit-topic-plugin/utils/helpers';
+import { getCurrentBesluitRange } from '@lblod/ember-rdfa-editor-lblod-plugins/utils/decision-utils';
 import { RoadsignRegulationPluginOptions } from '@lblod/ember-rdfa-editor-lblod-plugins/plugins/roadsign-regulation-plugin';
 import { RDF } from '@lblod/ember-rdfa-editor-lblod-plugins/utils/constants';
 import { OutgoingTriple } from '@lblod/ember-rdfa-editor/core/rdfa-processor';

package/addon/components/roadsign-regulation-plugin/roadsigns-modal.gts

@@ -6,7 +6,7 @@ import { action } from '@ember/object';
 import Component from '@glimmer/component';
 import { tracked } from '@glimmer/tracking';
 import { SayController } from '@lblod/ember-rdfa-editor';
-import { getCurrentBesluitRange } from '@lblod/ember-rdfa-editor-lblod-plugins/plugins/besluit-topic-plugin/utils/helpers';
+import { getCurrentBesluitRange } from '@lblod/ember-rdfa-editor-lblod-plugins/utils/decision-utils';
 import { RoadsignRegulationPluginOptions } from '@lblod/ember-rdfa-editor-lblod-plugins/plugins/roadsign-regulation-plugin';
 import {
   countMobilityMeasures,

package/addon/plugins/besluit-type-plugin/utils/besluit-type-instances.ts

@@ -1,6 +1,6 @@
 import { type EditorState } from '@lblod/ember-rdfa-editor';
 import { getOutgoingTripleList } from '@lblod/ember-rdfa-editor-lblod-plugins/utils/namespace';
-import { getCurrentBesluitRange } from '@lblod/ember-rdfa-editor-lblod-plugins/plugins/besluit-topic-plugin/utils/helpers';
+import { getCurrentBesluitRange } from '@lblod/ember-rdfa-editor-lblod-plugins/utils/decision-utils';
 import { RDF } from '@lblod/ember-rdfa-editor-lblod-plugins/utils/constants';
 import { type BesluitType } from './fetchBesluitTypes';
 import { type NamedNodeTriple } from '@lblod/ember-rdfa-editor/core/rdfa-processor';

package/addon/plugins/besluit-type-plugin/utils/set-besluit-type.ts

@@ -8,7 +8,7 @@ import {
   removePropertyFromNode,
 } from '@lblod/ember-rdfa-editor/utils/rdfa-utils';
 import { sayDataFactory } from '@lblod/ember-rdfa-editor/core/say-data-factory';
-import { getCurrentBesluitURI } from '@lblod/ember-rdfa-editor-lblod-plugins/plugins/besluit-topic-plugin/utils/helpers';
+import { getCurrentBesluitURI } from '@lblod/ember-rdfa-editor-lblod-plugins/utils/decision-utils';
 import {
   extractBesluitTypeUris,
   isValidTypeChoice,

package/addon/plugins/decision-plugin/commands/insert-article-container.ts

@@ -8,16 +8,19 @@ import { buildArticleStructure } from '../utils/build-article-structure';
 import { transactionCombinator } from '@lblod/ember-rdfa-editor/utils/transaction-utils';
 import { insertArticle } from '../actions/insert-article';
 import { recalculateNumbers } from '../../structure-plugin/monads/recalculate-structure-numbers';
+import { NodeWithPos } from '@curvenote/prosemirror-utils';
 
 interface InsertArticleContainerArgs {
   intl: IntlService;
   decisionUri: string;
   articleUriGenerator?: () => string;
+  decisionLocation: NodeWithPos;
 }
 
 export default function insertArticleContainer({
   decisionUri,
   articleUriGenerator,
+  decisionLocation,
 }: InsertArticleContainerArgs): Command {
   return function (state: EditorState, dispatch?: (tr: Transaction) => void) {
     const { schema } = state;
@@ -33,9 +36,19 @@ export default function insertArticleContainer({
     const articleNode = buildArticleStructure(schema, articleUriGenerator);
 
     const factory = new SayDataFactory();
+    let replaceTr;
+    if (state.selection.$from.pos === decisionLocation.pos) {
+      replaceTr = state.tr.replaceRangeWith(
+        decisionLocation.pos + decisionLocation.node.nodeSize - 1,
+        decisionLocation.pos + decisionLocation.node.nodeSize - 1,
+        containerNode,
+      );
+    } else {
+      replaceTr = state.tr.replaceSelectionWith(containerNode);
+    }
     const { transaction: newTr, result } = transactionCombinator<boolean>(
       state,
-      state.tr.replaceSelectionWith(containerNode),
+      replaceTr,
     )([
       addPropertyToNode({
         resource: decisionUri,

package/addon/plugins/decision-plugin/commands/insert-description.ts

@@ -31,7 +31,15 @@ export default function insertDescription({
     );
     const tr = state.tr;
 
-    tr.replaceSelectionWith(nodeToInsert);
+    if (state.selection.$from.pos === decisionLocation.pos) {
+      tr.replaceRangeWith(
+        decisionLocation.pos + decisionLocation.node.nodeSize - 1,
+        decisionLocation.pos + decisionLocation.node.nodeSize - 1,
+        nodeToInsert,
+      );
+    } else {
+      tr.replaceSelectionWith(nodeToInsert);
+    }
 
     const factory = new SayDataFactory();
     const { transaction: newTr, result } = transactionCombinator<boolean>(

package/addon/plugins/decision-plugin/commands/insert-motivation.ts

@@ -110,7 +110,15 @@ export default function insertMotivation({
       ],
     );
     const tr = state.tr;
-    tr.replaceSelectionWith(nodeToInsert);
+    if (state.selection.$from.pos === decisionLocation.pos) {
+      tr.replaceRangeWith(
+        decisionLocation.pos + decisionLocation.node.nodeSize - 1,
+        decisionLocation.pos + decisionLocation.node.nodeSize - 1,
+        nodeToInsert,
+      );
+    } else {
+      tr.replaceSelectionWith(nodeToInsert);
+    }
     const factory = new SayDataFactory();
 
     const { transaction: newTr, result } = transactionCombinator<boolean>(

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

@@ -31,7 +31,15 @@ export default function insertTitle({
     );
 
     const tr = state.tr;
-    tr.replaceSelectionWith(nodeToInsert);
+    if (state.selection.$from.pos === decisionLocation.pos) {
+      tr.replaceRangeWith(
+        decisionLocation.pos + decisionLocation.node.nodeSize - 1,
+        decisionLocation.pos + decisionLocation.node.nodeSize - 1,
+        nodeToInsert,
+      );
+    } else {
+      tr.replaceSelectionWith(nodeToInsert);
+    }
 
     const factory = new SayDataFactory();
     const { transaction: newTr, result } = transactionCombinator<boolean>(

package/addon/plugins/document-validation-plugin/common-fixes.ts

@@ -0,0 +1,125 @@
+import { SayController } from '@lblod/ember-rdfa-editor';
+import { getDecisionNodeLocation } from '@lblod/ember-rdfa-editor-lblod-plugins/utils/decision-utils';
+import IntlService from 'ember-intl/services/intl';
+import {
+  Notification,
+  notificationPluginKey,
+} from '@lblod/ember-rdfa-editor/plugins/notification';
+import {
+  insertMotivation,
+  insertArticleContainer,
+  insertDescription,
+  insertTitle,
+} from '@lblod/ember-rdfa-editor-lblod-plugins/plugins/decision-plugin/commands';
+import { CircleXIcon } from '@appuniversum/ember-appuniversum/components/icons/circle-x';
+
+export function insertTitleAtCursor(
+  controller: SayController,
+  intl: IntlService,
+) {
+  const decisionNodeLocation = getDecisionNodeLocation(controller);
+  if (!decisionNodeLocation) {
+    return sendNotificationError(
+      controller,
+      intl.t('document-validation-plugin.decision-node-not-found'),
+    );
+  }
+  controller.doCommand(
+    insertTitle({
+      placeholderText: intl.t('besluit-plugin.placeholder.decision-title'),
+      decisionLocation: decisionNodeLocation,
+    }),
+    { view: controller.mainEditorView },
+  );
+  controller.focus();
+}
+
+export function insertDescriptionAtCursor(
+  controller: SayController,
+  intl: IntlService,
+) {
+  const decisionNodeLocation = getDecisionNodeLocation(controller);
+  if (!decisionNodeLocation) {
+    return sendNotificationError(
+      controller,
+      intl.t('document-validation-plugin.decision-node-not-found'),
+    );
+  }
+  controller.doCommand(
+    insertDescription({
+      placeholderText: intl.t(
+        'besluit-plugin.placeholder.decision-description',
+      ),
+      decisionLocation: decisionNodeLocation,
+    }),
+    {
+      view: controller.mainEditorView,
+    },
+  );
+  controller.focus();
+}
+
+export function insertMotivationAtCursor(
+  controller: SayController,
+  intl: IntlService,
+) {
+  const decisionNodeLocation = getDecisionNodeLocation(controller);
+  if (!decisionNodeLocation) {
+    return sendNotificationError(
+      controller,
+      intl.t('document-validation-plugin.decision-node-not-found'),
+    );
+  }
+  controller.doCommand(
+    insertMotivation({
+      intl: intl,
+      decisionLocation: decisionNodeLocation,
+    }),
+    {
+      view: controller.mainEditorView,
+    },
+  );
+  controller.focus();
+}
+
+export function insertArticleContainerAtCursor(
+  controller: SayController,
+  intl: IntlService,
+  articleUriGenerator?: () => string,
+) {
+  const decisionNodeLocation = getDecisionNodeLocation(controller);
+  if (!decisionNodeLocation) {
+    return sendNotificationError(
+      controller,
+      intl.t('document-validation-plugin.decision-node-not-found'),
+    );
+  }
+  controller.doCommand(
+    insertArticleContainer({
+      intl: intl,
+      decisionUri: decisionNodeLocation?.node.attrs.subject,
+      articleUriGenerator: articleUriGenerator,
+      decisionLocation: decisionNodeLocation,
+    }),
+    {
+      view: controller.mainEditorView,
+    },
+  );
+}
+
+function sendNotificationError(controller: SayController, text: string) {
+  // Show a notification via the notification plugin
+  const { notificationCallback } = notificationPluginKey.getState(
+    controller.mainEditorState,
+  ) as {
+    notificationCallback: (notification: Notification) => void;
+    intl: IntlService;
+  };
+  notificationCallback({
+    title: text,
+    options: {
+      type: 'error',
+      icon: CircleXIcon,
+    },
+  });
+}