@lblod/ember-rdfa-editor-lblod-plugins 7.0.0 → 7.1.0

package/CHANGELOG.md

@@ -7,6 +7,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [7.1.0] - 2023-05-18
+
+### Added
+- validate motivering and article section
+
 ## [7.0.0] - 2023-05-17
 ### Added
 - add docker build for easy demo environments
@@ -14,9 +19,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - BREAKING: Endpoint config for `CitationPlugin`
 ### Fixed
 - Remove structure doesn't always work - disable the "Remove <structure>" button correctly
+- Fix initialization of default date properties
 
 ### Fixed
-- Fix initialization of default date properties
+
 ## [6.1.0] - 2023-05-11
 
 ### Added
@@ -438,7 +444,8 @@ add onclick handler to pencil icon in variable plugin
 
 # Changelog
 
-[unreleased]: https://github.com/lblod/ember-rdfa-editor-lblod-plugins/compare/v7.0.0...HEAD
+[unreleased]: https://github.com/lblod/ember-rdfa-editor-lblod-plugins/compare/v7.1.0...HEAD
+[7.1.0]: https://github.com/lblod/ember-rdfa-editor-lblod-plugins/compare/v7.0.0...v7.1.0
 [7.0.0]: https://github.com/lblod/ember-rdfa-editor-lblod-plugins/compare/v6.1.0...v7.0.0
 [6.1.0]: https://github.com/lblod/ember-rdfa-editor-lblod-plugins/compare/v6.0.0...v6.1.0
 [6.0.0]: https://github.com/lblod/ember-rdfa-editor-lblod-plugins/compare/v5.0.1...v6.0.0

package/README.md

@@ -21,6 +21,7 @@ This addon contains the following editor plugins:
 
 * besluit-type-plugin
 * citaten-plugin
+* decision-plugin
 * import-snippet-plugin
 * insert-variable-plugin
 * rdfa-date-plugin
@@ -76,6 +77,28 @@ You can need to specify the endpoint from which the plugin will fetch the types
 }
 ```
 
+## decision-plugin
+
+This plugin provides some warnings to the user if the validation for a besluit fails, it need to be used with the validation plugin as it exports some validation rules for it.
+In order to use it you will need to add its card to the sidebar like
+```hbs
+ <DecisionPlugin::DecisionPluginCard
+    @controller={{this.controller}}
+  />
+```
+
+and then import the rule and add it to the config of your validation plugin like
+```js
+import { atLeastOneArticleContainer } from '@lblod/ember-rdfa-editor-lblod-plugins/plugins/decision-plugin/utils/validation-rules';
+...
+ @tracked validationPlugin = validation((schema: Schema) => ({
+    shapes: [
+      atLeastOneArticleContainer(schema),
+    ]
+ })
+```
+With these changes you will see a warning if the decision is missing a title, a motivation block or an article block.
+
 ## citaten-plugin
 
 Plugin which allows a user to insert references to a legal resource or legal expression into the document.

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

@@ -1,8 +1,24 @@
 {{#if this.canInsertTitle}}
-<AuAlert class="title-alert" @skin="warning" @closable={{false}} @icon="alert-triangle" @title={{t "besluit-plugin.missing-title-warning"}}>
-  <AuButton @iconAlignment="left" @skin="link-secondary" @disabled={{not this.canInsertTitle}} {{on 'click'
-    this.insertTitle}}>
-    {{t "besluit-plugin.insert.decision-title"}}
-  </AuButton>
-</AuAlert>
+  <AuAlert class="validation-alert" @skin="warning" @closable={{false}} @icon="alert-triangle" @title={{t "besluit-plugin.missing-title-warning"}}>
+    <AuButton @iconAlignment="left" @skin="link-secondary" @disabled={{not this.canInsertTitle}} {{on 'click'
+      this.insertTitle}}>
+      {{t "besluit-plugin.insert.decision-title"}}
+    </AuButton>
+  </AuAlert>
+{{/if}}
+{{#if this.canInsertMotivation}}
+  <AuAlert class="validation-alert" @skin="warning" @closable={{false}} @icon="alert-triangle" @title={{t "besluit-plugin.missing-motivation-warning"}}>
+    <AuButton @iconAlignment="left" @skin="link-secondary" @disabled={{not this.canInsertMotivation}} {{on 'click'
+      this.insertMotivation}}>
+      {{t "besluit-plugin.insert.motivation"}}
+    </AuButton>
+  </AuAlert>
+{{/if}}
+{{#if this.missingArticleBlock}}
+  <AuAlert class="validation-alert" @skin="warning" @closable={{false}} @icon="alert-triangle" @title={{t "besluit-plugin.missing-article-block-warning"}}>
+    <AuButton @iconAlignment="left" @skin="link-secondary" @disabled={{not this.missingArticleBlock}} {{on 'click'
+      this.insertArticleBlock}}>
+      {{t "besluit-plugin.insert.article-block"}}
+    </AuButton>
+  </AuAlert>
 {{/if}}

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

@@ -1,9 +1,13 @@
 import Component from '@glimmer/component';
 import { action } from '@ember/object';
-import { insertTitle } from '@lblod/ember-rdfa-editor-lblod-plugins/plugins/decision-plugin/commands';
+import {
+  insertMotivation,
+  insertArticleContainer,
+} from '@lblod/ember-rdfa-editor-lblod-plugins/plugins/decision-plugin/commands';
 import { SayController } from '@lblod/ember-rdfa-editor';
 import { inject as service } from '@ember/service';
 import IntlService from 'ember-intl/services/intl';
+import { VALIDATION_KEY } from '@lblod/ember-rdfa-editor-lblod-plugins/plugins/validation';
 
 type Args = {
   controller: SayController;
@@ -24,26 +28,41 @@ export default class DecisionPluginCard extends Component<Args> {
   }
 
   @action
-  insertTitle() {
-    this.controller.doCommand(
-      insertTitle({
-        placeholderText: this.intl.t('besluit-plugin.insert.decision-title'),
-      }),
-      {
-        view: this.controller.mainEditorView,
-      }
-    );
+  insertMotivation() {
+    this.controller.doCommand(insertMotivation({ intl: this.intl }), {
+      view: this.controller.mainEditorView,
+    });
+    this.focus();
+  }
+
+  get canInsertMotivation() {
+    return this.controller.checkCommand(insertMotivation({ intl: this.intl }), {
+      view: this.controller.mainEditorView,
+    });
+  }
+
+  @action
+  insertArticleBlock() {
+    this.controller.doCommand(insertArticleContainer({ intl: this.intl }), {
+      view: this.controller.mainEditorView,
+    });
     this.focus();
   }
 
-  get canInsertTitle() {
-    return this.controller.checkCommand(
-      insertTitle({
-        placeholderText: this.intl.t('besluit-plugin.insert.decision-title'),
-      }),
-      {
-        view: this.controller.mainEditorView,
+  get missingArticleBlock() {
+    const state = VALIDATION_KEY.getState(this.controller.activeEditorState);
+    if (state) {
+      let missingArticleBlock = false;
+      const results = state.report.results;
+      if (!results) return false;
+      for (const result of results) {
+        if (result.sourceShape.name === 'at-least-one-article-container') {
+          missingArticleBlock = true;
+        }
       }
-    );
+      return missingArticleBlock;
+    } else {
+      return false;
+    }
   }
 }

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

@@ -8,16 +8,17 @@ import { v4 as uuid } from 'uuid';
 import { isNone } from '@lblod/ember-rdfa-editor-lblod-plugins/utils/option';
 import { transactionCompliesWithShapes } from '@lblod/ember-rdfa-editor-lblod-plugins/plugins/validation/utils/transaction-complies-with-shapes';
 import { findInsertionPosInAncestorOfType } from '@lblod/ember-rdfa-editor-lblod-plugins/utils/find-insertion-pos-in-ancestor-of-type';
+import IntlService from 'ember-intl/services/intl';
 
 interface InsertMotivationArgs {
-  placeholderText?: string;
+  intl: IntlService;
   validateShapes?: Set<string>;
 }
 
 export default function insertMotivation({
+  intl,
   validateShapes,
-  placeholderText = 'Insert motivation',
-}: InsertMotivationArgs = {}): Command {
+}: InsertMotivationArgs): Command {
   return function (state: EditorState, dispatch?: (tr: Transaction) => void) {
     const { selection, schema } = state;
     const nodeToInsert = schema.node('motivering', { __rdfaId: uuid() }, [
@@ -25,9 +26,63 @@ export default function insertMotivation({
         'paragraph',
         null,
         schema.node('placeholder', {
-          placeholderText,
+          placeholderText: intl.t('besluit-plugin.placeholder.government-body'),
         })
       ),
+      schema.node(
+        'heading',
+        {
+          level: 5,
+        },
+        [schema.text(intl.t('besluit-plugin.text.authority'))]
+      ),
+      schema.node('bullet_list', null, [
+        schema.node('list_item', null, [
+          schema.node('paragraph', null, [
+            schema.node('placeholder', {
+              placeholderText: intl.t(
+                'besluit-plugin.placeholder.legal-jurisdiction'
+              ),
+            }),
+          ]),
+        ]),
+      ]),
+      schema.node(
+        'heading',
+        {
+          level: 5,
+        },
+        [schema.text(intl.t('besluit-plugin.text.legal-context'))]
+      ),
+      schema.node('bullet_list', null, [
+        schema.node('list_item', null, [
+          schema.node('paragraph', null, [
+            schema.node('placeholder', {
+              placeholderText: intl.t(
+                'besluit-plugin.placeholder.insert-legal-context'
+              ),
+            }),
+          ]),
+        ]),
+      ]),
+      schema.node(
+        'heading',
+        {
+          level: 5,
+        },
+        [schema.text(intl.t('besluit-plugin.text.factual-context'))]
+      ),
+      schema.node('bullet_list', null, [
+        schema.node('list_item', null, [
+          schema.node('paragraph', null, [
+            schema.node('placeholder', {
+              placeholderText: intl.t(
+                'besluit-plugin.placeholder.insert-factual-context'
+              ),
+            }),
+          ]),
+        ]),
+      ]),
     ]);
     // how the offset between the insertion point and the point where the cursor should end up
     const cursorOffset = 2;
@@ -47,8 +102,6 @@ export default function insertMotivation({
       return false;
     }
     if (dispatch) {
-      console.log('inserts in ', insertionPos);
-      console.log('selection on ', insertionPos + cursorOffset);
       const selectionPos = tr.doc.resolve(insertionPos + cursorOffset);
       // const targetPos = tr.doc.resolve(insertionPos + cursorOffset + 1);
       // TODO figure out why I cant just set a nodeSelection here

package/addon/plugins/decision-plugin/utils/validation-rules.ts

@@ -0,0 +1,11 @@
+import { Schema } from '@lblod/ember-rdfa-editor';
+
+export const atLeastOneArticleContainer = (schema: Schema) => ({
+  name: 'at-least-one-article-container',
+  focusNodeType: schema.nodes.besluit,
+  path: ['article_container'],
+  message: 'Document must contain at least one article container.',
+  constraints: {
+    minCount: 1,
+  },
+});

package/addon/plugins/validation/index.ts

@@ -141,13 +141,7 @@ export function validation(
         const schemaChanged = oldState.schema !== newState.schema;
         if (schemaChanged) {
           const spec = compileSpec(configurator, newState.schema);
-          const newValidation = doValidation(
-            tr,
-            oldPluginState,
-            oldState,
-            newState,
-            spec
-          );
+          const newValidation = doValidation(newState, spec);
           tr.setMeta('validated', newValidation);
           tr.setMeta('firstPass', false);
           return { spec, report: newValidation };
@@ -166,13 +160,7 @@ export function validation(
             tr.setMeta('firstPass', false);
             return cachedValidation;
           }
-          const newValidation = doValidation(
-            tr,
-            oldPluginState,
-            oldState,
-            newState,
-            spec
-          );
+          const newValidation = doValidation(newState, spec);
           tr.setMeta('validated', newValidation);
           tr.setMeta('firstPass', false);
           return { spec, report: newValidation };
@@ -230,9 +218,6 @@ interface ValidationContext {
  * @param spec
  */
 function doValidation(
-  tr: Transaction,
-  oldPluginState: ValidationState,
-  oldState: EditorState,
   newState: EditorState,
   spec: ValidationSpec
 ): ValidationReport {

package/app/styles/besluit-plugin.scss

@@ -1,4 +1,4 @@
-.title-alert .au-c-button {
+.validation-alert .au-c-button {
     padding: 0;
 }
 

package/components/decision-plugin/decision-plugin-card.d.ts

@@ -11,7 +11,9 @@ export default class DecisionPluginCard extends Component<Args> {
     intl: IntlService;
     get controller(): SayController;
     focus(): void;
-    insertTitle(): void;
-    get canInsertTitle(): boolean;
+    insertMotivation(): void;
+    get canInsertMotivation(): boolean;
+    insertArticleBlock(): void;
+    get missingArticleBlock(): boolean;
 }
 export {};

package/package.json

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

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

@@ -1,7 +1,8 @@
 import { Command } from '@lblod/ember-rdfa-editor';
+import IntlService from 'ember-intl/services/intl';
 interface InsertMotivationArgs {
-    placeholderText?: string;
+    intl: IntlService;
     validateShapes?: Set<string>;
 }
-export default function insertMotivation({ validateShapes, placeholderText, }?: InsertMotivationArgs): Command;
+export default function insertMotivation({ intl, validateShapes, }: InsertMotivationArgs): Command;
 export {};

package/plugins/decision-plugin/utils/validation-rules.d.ts

@@ -0,0 +1,10 @@
+import { Schema } from '@lblod/ember-rdfa-editor';
+export declare const atLeastOneArticleContainer: (schema: Schema) => {
+    name: string;
+    focusNodeType: import("prosemirror-model").NodeType;
+    path: string[];
+    message: string;
+    constraints: {
+        minCount: number;
+    };
+};

package/translations/en-US.yaml

@@ -114,11 +114,24 @@ besluit-type-plugin:
   error-rest-body: '. For more specific details about this problem, inspect the browser console.'
 
 besluit-plugin:
-  missing-title-warning: This decision is missing a title
+  missing-title-warning: This decision is missing a title.
+  missing-motivation-warning: This decision is missing a motivation block, a decision without this block will be harder to parse by our system.
+  missing-article-block-warning: This decision is missing an article block, a decision without this block will be harder to parse by our system.
   insert:
     decision-title: Insert decision title
+    motivation: Insert motivation
+    article-block: Insert article block
   placeholder:
     decision-title: Insert decision title
+    government-body: specify governing body
+    legal-jurisdiction: Legal basis providing that body has jurisdiction.
+    insert-legal-context: Insert juridische context
+    insert-factual-context: Factual context and reasoning
+    insert-article: Insert article
+  text:
+    authority: Authority
+    legal-context: Legal context
+    factual-context: Factual context and reasoning
 
 date-plugin:
   help:

package/translations/nl-BE.yaml

@@ -117,11 +117,24 @@ besluit-type-plugin:
 
 
 besluit-plugin:
-  missing-title-warning: Dit besluit heeft geen titel
+  missing-title-warning: Dit besluit heeft geen titel.
+  missing-motivation-warning: Dit besluit mist een motivatieblok, een besluit zonder dit blok zal moeilijker te ontleden zijn door ons systeem.
+  missing-article-block-warning: Deze besluit mist een artikelblok, een besluit zonder dit blok zal moeilijker te ontleden zijn door ons systeem.
   insert:
     decision-title: Voeg besluittitel in
+    motivation: Voeg motivatie in
+    article-block: Voeg artikelblok in
   placeholder:
     decision-title: Geef titel besluit op
+    government-body: geef bestuursorgaan op
+    legal-jurisdiction: Rechtsgrond die bepaalt dat dit orgaan bevoegd is.
+    insert-legal-context: Voeg juridische context in
+    insert-factual-context: Feitelijke context en argumentatie
+    insert-article: Artikel invoegen
+  text:
+    authority: Bevoegdheid
+    legal-context: Juridische context
+    factual-context: Feitelijke context en argumentatie
 
 
 date-plugin: