@lblod/ember-rdfa-editor-lblod-plugins 32.5.2 → 32.5.3-dev.9d68486643ee171b9ead4c9c49cd2fd273fb08d6

package/.changeset/tender-actors-shout.md

@@ -0,0 +1,5 @@
+---
+'@lblod/ember-rdfa-editor-lblod-plugins': minor
+---
+
+Add actions to document validation plugin

package/CHANGELOG.md

@@ -1,5 +1,15 @@
 # @lblod/ember-rdfa-editor-lblod-plugins
 
+## 32.5.3
+
+### Patch Changes
+
+- [#594](https://github.com/lblod/ember-rdfa-editor-lblod-plugins/pull/594) [`b732735`](https://github.com/lblod/ember-rdfa-editor-lblod-plugins/commit/b732735c373e2cec7bb4ccce6974cc0934ae1f99) Thanks [@abeforgit](https://github.com/abeforgit)! - Fix parsing of articles
+
+- [#595](https://github.com/lblod/ember-rdfa-editor-lblod-plugins/pull/595) [`eb0aea2`](https://github.com/lblod/ember-rdfa-editor-lblod-plugins/commit/eb0aea28d0887ef5274aba72c6f6a7daa02aca24) Thanks [@piemonkey](https://github.com/piemonkey)! - Fix parsing of oslo locations to no longer incorrectly catch non-locations
+
+- [#596](https://github.com/lblod/ember-rdfa-editor-lblod-plugins/pull/596) [`ece607c`](https://github.com/lblod/ember-rdfa-editor-lblod-plugins/commit/ece607cf50f6480277f9b47893df71fbb85e4b82) Thanks [@piemonkey](https://github.com/piemonkey)! - Correctly parse the subject URI of roadsign_regulation nodes
+
 ## 32.5.2
 
 ### Patch Changes

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

@@ -12,6 +12,7 @@ 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';
 
 interface Sig {
   Args: {
@@ -37,10 +38,20 @@ export default class DocumentValidationPluginCard extends Component<Sig> {
   }
   get documentValidationErrors() {
     if (!this.validationState) return [];
-    const { propertiesWithErrors } = this.validationState;
+
+    const { propertiesWithErrors, actions } = this.validationState;
     if (!propertiesWithErrors) return undefined;
 
-    return propertiesWithErrors;
+    const documentValidationErrors = propertiesWithErrors.map((property) => {
+      const action = actions.find(
+        (action) => property?.shape === action.shaclRule,
+      );
+      return {
+        ...property,
+        action,
+      };
+    });
+    return documentValidationErrors;
   }
   get propertiesWithoutErrors() {
     if (!this.validationState) return [];
@@ -65,6 +76,50 @@ 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;
+
+  dedupe = (val: typeof this.documentValidationErrors) => {
+    if (this.myCompare(val, this.oldVal)) {
+      return this.oldVal;
+    } else {
+      this.oldVal = val;
+      return val;
+    }
+  };
+
+  myCompare = (
+    val1: typeof this.documentValidationErrors,
+    val2: typeof this.documentValidationErrors,
+  ) => {
+    if (!val1?.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 +149,53 @@ 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.dedupe 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.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.action.action)
+                    }}
+                  >{{error.action.buttonTitle}}</AuButton>
+                {{/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/plugins/document-validation-plugin/common-fixes.ts

@@ -0,0 +1,92 @@
+import { SayController } from '@lblod/ember-rdfa-editor';
+import { getCurrentBesluitRange } from '../besluit-topic-plugin/utils/helpers';
+import IntlService from 'ember-intl/services/intl';
+import {
+  insertMotivation,
+  insertArticleContainer,
+  insertDescription,
+  insertTitle,
+} from '@lblod/ember-rdfa-editor-lblod-plugins/plugins/decision-plugin/commands';
+
+export function insertTitleAtCursor(
+  controller: SayController,
+  intl: IntlService,
+) {
+  const decisionNodeLocation = getDecisionNodeLocation(controller);
+  if (!decisionNodeLocation) return;
+  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;
+  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;
+  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;
+  controller.doCommand(
+    insertArticleContainer({
+      intl: intl,
+      decisionUri: decisionNodeLocation?.node.attrs.subject,
+      articleUriGenerator: articleUriGenerator,
+    }),
+    {
+      view: controller.mainEditorView,
+    },
+  );
+}
+
+function getDecisionNodeLocation(controller: SayController) {
+  const besluitRange = getCurrentBesluitRange(controller);
+  if (!besluitRange) return;
+  const decisionNodeLocation = {
+    pos: besluitRange.from,
+    node: besluitRange.node,
+  };
+  return decisionNodeLocation;
+}

package/addon/plugins/document-validation-plugin/index.ts

@@ -2,7 +2,12 @@ import factory from '@rdfjs/dataset';
 import SHACLValidator from 'rdf-validate-shacl';
 import { Parser as ParserN3 } from 'n3';
 import { RdfaParser } from 'rdfa-streaming-parser';
-import { ProsePlugin, PluginKey, EditorView } from '@lblod/ember-rdfa-editor';
+import {
+  ProsePlugin,
+  PluginKey,
+  EditorView,
+  SayController,
+} from '@lblod/ember-rdfa-editor';
 import removeQuotes from '@lblod/ember-rdfa-editor-lblod-plugins/utils/remove-quotes';
 import {
   BlankNode,
@@ -20,6 +25,11 @@ export const documentValidationPluginKey =
 
 interface DocumentValidationPluginArgs {
   documentShape: string;
+  actions: {
+    shaclRule: string;
+    action: (controller: SayController, report: ValidationReport) => void;
+    buttonTitle: string;
+  }[];
 }
 
 export type ShaclValidationReport = ValidationReport.ValidationReport<
@@ -34,6 +44,7 @@ interface DocumentValidationResult {
     | {
         message: string;
         subject: string | undefined;
+        shape: string;
       }
     // TODO get rid of this?
     | undefined
@@ -47,6 +58,11 @@ export interface DocumentValidationPluginState
   extends DocumentValidationResult {
   documentShape: string;
   validationCallback: typeof validationCallback;
+  actions: {
+    shaclRule: string;
+    action: (controller: SayController, report: ValidationReport) => void;
+    buttonTitle: string;
+  }[];
 }
 
 export const documentValidationPlugin = (
@@ -61,6 +77,7 @@ export const documentValidationPlugin = (
           documentShape: options.documentShape,
           propertiesWithoutErrors: [],
           propertiesWithErrors: [],
+          actions: options.actions,
         };
       },
       apply(tr, state) {
@@ -121,17 +138,23 @@ async function validationCallback(view: EditorView, documentHtml: string) {
   );
   const propertiesWithErrorsMessages = propertiesWithErrors
     .map(({ sourceShape, focusNode }) => {
+      console.log(sourceShape);
       const match = shacl.match(sourceShape, errorMessagePred, undefined);
       const message = [...match][0]?.object.value;
       return message
-        ? { message: removeQuotes(message), subject: focusNode?.value }
+        ? {
+            message: removeQuotes(message),
+            subject: focusNode?.value,
+            shape: sourceShape.value,
+          }
         : undefined;
     })
     .filter((message) => message);
   const propertiesWithoutErrorsArray = propertyNodes.filter((propertyNode) =>
-    propertiesWithErrors.some((propertyWithError) => {
-      return propertyWithError.sourceShape.value !== propertyNode.value;
-    }),
+    propertiesWithErrors.every(
+      (propertyWithError) =>
+        propertyWithError.sourceShape.value !== propertyNode.value,
+    ),
   );
 
   const successMessagePred = sayFactory.namedNode(

package/addon/plugins/location-plugin/node.ts

@@ -109,13 +109,15 @@ const parseDOM = (config: LocationPluginConfig): TagParseRule[] => {
             nodeContentsUtils.address.parse(contentContainer.children[0]) ||
             nodeContentsUtils.place.parse(contentContainer.children[0]) ||
             nodeContentsUtils.area.parse(contentContainer.children[0]);
-          // Ignore the properties for now, we handle these ourselves
-          const properties: OutgoingTriple[] = [];
-          return {
-            ...attrs,
-            properties,
-            value: location,
-          };
+          if (location) {
+            // Ignore the properties for now, we handle these ourselves
+            const properties: OutgoingTriple[] = [];
+            return {
+              ...attrs,
+              properties,
+              value: location,
+            };
+          }
         }
         return false;
       },

package/addon/plugins/roadsign-regulation-plugin/nodes.ts

@@ -114,6 +114,7 @@ export const roadsign_regulation: NodeSpec = {
             __rdfaId,
             properties: propertiesFiltered,
             backlinks,
+            subject: resourceUri,
             label: `Mobiliteitsmaatregel`,
           };
         }

package/addon/plugins/structure-plugin/node.ts

@@ -476,7 +476,7 @@ export const emberNodeConfig: (
           const body = Array.from(rdfaContent.children).find((child) =>
             SAY('body').matches(child.getAttribute('property') ?? ''),
           );
-          return (body && getRdfaContentElement(body)) ?? (node as HTMLElement);
+          return (body && getRdfaContentElement(body)) ?? node;
         },
       },
       {
@@ -537,7 +537,7 @@ export const emberNodeConfig: (
           if (bodyNode) {
             return getRdfaContentElement(bodyNode);
           } else {
-            return node as HTMLElement;
+            return node;
           }
         },
       },

package/declarations/addon/components/document-validation-plugin/card.d.ts

@@ -1,5 +1,6 @@
 import Component from '@glimmer/component';
 import { SayController } from '@lblod/ember-rdfa-editor';
+import ValidationReport from 'rdf-validate-shacl/src/validation-report';
 interface Sig {
     Args: {
         controller: SayController;
@@ -8,15 +9,34 @@ interface Sig {
 export default class DocumentValidationPluginCard extends Component<Sig> {
     get controller(): SayController;
     get validationState(): import("@lblod/ember-rdfa-editor-lblod-plugins/plugins/document-validation-plugin").DocumentValidationPluginState | undefined;
-    get documentValidationErrors(): ({
-        message: string;
-        subject: string | undefined;
-    } | undefined)[] | undefined;
+    get documentValidationErrors(): {
+        action: {
+            shaclRule: string;
+            action: (controller: SayController, report: ValidationReport) => void;
+            buttonTitle: string;
+        } | undefined;
+        message?: string | undefined;
+        subject?: string | undefined;
+        shape?: string | undefined;
+    }[] | undefined;
     get propertiesWithoutErrors(): {
         message: string;
     }[];
     goToSubject: (subject: string) => void;
     get status(): "not-run" | "no-matches" | "valid" | "invalid";
     get isSuccesslike(): boolean;
+    doActionAndTriggerValidation: (action: (controller: SayController, report: ValidationReport) => void) => Promise<void>;
+    oldVal: typeof this.documentValidationErrors;
+    dedupe: (val: typeof this.documentValidationErrors) => {
+        action: {
+            shaclRule: string;
+            action: (controller: SayController, report: ValidationReport) => void;
+            buttonTitle: string;
+        } | undefined;
+        message?: string | undefined;
+        subject?: string | undefined;
+        shape?: string | undefined;
+    }[] | undefined;
+    myCompare: (val1: typeof this.documentValidationErrors, val2: typeof this.documentValidationErrors) => boolean;
 }
 export {};

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

@@ -0,0 +1,6 @@
+import { SayController } from '@lblod/ember-rdfa-editor';
+import IntlService from 'ember-intl/services/intl';
+export declare function insertTitleAtCursor(controller: SayController, intl: IntlService): void;
+export declare function insertDescriptionAtCursor(controller: SayController, intl: IntlService): void;
+export declare function insertMotivationAtCursor(controller: SayController, intl: IntlService): void;
+export declare function insertArticleContainerAtCursor(controller: SayController, intl: IntlService, articleUriGenerator?: () => string): void;

package/declarations/addon/plugins/document-validation-plugin/index.d.ts

@@ -1,9 +1,14 @@
-import { ProsePlugin, PluginKey, EditorView } from '@lblod/ember-rdfa-editor';
+import { ProsePlugin, PluginKey, EditorView, SayController } from '@lblod/ember-rdfa-editor';
 import { DataFactory, DatasetCore, DatasetCoreFactory, Quad } from '@rdfjs/types';
 import ValidationReport from 'rdf-validate-shacl/src/validation-report';
 export declare const documentValidationPluginKey: PluginKey<DocumentValidationPluginState>;
 interface DocumentValidationPluginArgs {
     documentShape: string;
+    actions: {
+        shaclRule: string;
+        action: (controller: SayController, report: ValidationReport) => void;
+        buttonTitle: string;
+    }[];
 }
 export type ShaclValidationReport = ValidationReport.ValidationReport<DataFactory<Quad, Quad> & DatasetCoreFactory<Quad, Quad, DatasetCore<Quad, Quad>>>;
 interface DocumentValidationResult {
@@ -14,6 +19,7 @@ interface DocumentValidationResult {
     propertiesWithErrors: ({
         message: string;
         subject: string | undefined;
+        shape: string;
     } | undefined)[];
 }
 export interface DocumentValidationTransactionMeta extends DocumentValidationResult {
@@ -22,6 +28,11 @@ export interface DocumentValidationTransactionMeta extends DocumentValidationRes
 export interface DocumentValidationPluginState extends DocumentValidationResult {
     documentShape: string;
     validationCallback: typeof validationCallback;
+    actions: {
+        shaclRule: string;
+        action: (controller: SayController, report: ValidationReport) => void;
+        buttonTitle: string;
+    }[];
 }
 export declare const documentValidationPlugin: (options: DocumentValidationPluginArgs) => ProsePlugin<DocumentValidationPluginState>;
 declare function validationCallback(view: EditorView, documentHtml: string): Promise<void>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lblod/ember-rdfa-editor-lblod-plugins",
-  "version": "32.5.2",
+  "version": "32.5.3-dev.9d68486643ee171b9ead4c9c49cd2fd273fb08d6",
   "description": "Ember addon providing lblod specific plugins for the ember-rdfa-editor",
   "keywords": [
     "ember-addon",
@@ -112,7 +112,7 @@
     "@glint/template": "^1.5.0",
     "@graphy/content.ttl.write": "^4.3.7",
     "@graphy/memory.dataset.fast": "4.3.3",
-    "@lblod/ember-rdfa-editor": "12.9.0",
+    "@lblod/ember-rdfa-editor": "^12.12.1",
     "@rdfjs/types": "^1.1.0",
     "@release-it/keep-a-changelog": "^4.0.0",
     "@tsconfig/ember": "^3.0.8",
@@ -183,7 +183,7 @@
     "@appuniversum/ember-appuniversum": "^3.12.0",
     "@ember/string": "3.x",
     "@glint/template": "^1.4.0",
-    "@lblod/ember-rdfa-editor": "^12.1.0",
+    "@lblod/ember-rdfa-editor": "^12.12.1",
     "ember-concurrency": "^4.0.2",
     "ember-element-helper": "^0.8.6",
     "ember-intl": "^7.0.0",