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

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

@@ -2,14 +2,17 @@ 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,
   DataFactory,
   DatasetCore,
   DatasetCoreFactory,
-  NamedNode,
   Quad,
 } from '@rdfjs/types';
 import ValidationReport from 'rdf-validate-shacl/src/validation-report';
@@ -18,8 +21,34 @@ import { SayDataFactory } from '@lblod/ember-rdfa-editor/core/say-data-factory';
 export const documentValidationPluginKey =
   new PluginKey<DocumentValidationPluginState>('DOCUMENT_VALIDATION');
 
-interface DocumentValidationPluginArgs {
+type Violation =
+  | {
+      action: (controller: SayController, report: ValidationReport) => void;
+      buttonTitle: string;
+    }
+  | {
+      helpText: string;
+    };
+type Rule =
+  | {
+      shaclRule: string;
+      violations: {
+        [key: string]: Violation;
+      };
+    }
+  | {
+      shaclRule: string;
+      action: (controller: SayController, report: ValidationReport) => void;
+      buttonTitle: string;
+    }
+  | {
+      shaclRule: string;
+      helpText: string;
+    };
+
+export interface DocumentValidationPluginArgs {
   documentShape: string;
+  rules: Rule[];
 }
 
 export type ShaclValidationReport = ValidationReport.ValidationReport<
@@ -27,17 +56,16 @@ export type ShaclValidationReport = ValidationReport.ValidationReport<
     DatasetCoreFactory<Quad, Quad, DatasetCore<Quad, Quad>>
 >;
 
+type PropertyWithError = {
+  message: string;
+  subject: string | undefined;
+  shape: string;
+  constraint: string;
+};
 interface DocumentValidationResult {
   report?: ValidationReport;
   propertiesWithoutErrors: { message: string }[];
-  propertiesWithErrors: (
-    | {
-        message: string;
-        subject: string | undefined;
-      }
-    // TODO get rid of this?
-    | undefined
-  )[];
+  propertiesWithErrors: PropertyWithError[];
 }
 export interface DocumentValidationTransactionMeta
   extends DocumentValidationResult {
@@ -47,6 +75,7 @@ export interface DocumentValidationPluginState
   extends DocumentValidationResult {
   documentShape: string;
   validationCallback: typeof validationCallback;
+  rules: Rule[];
 }
 
 export const documentValidationPlugin = (
@@ -61,6 +90,7 @@ export const documentValidationPlugin = (
           documentShape: options.documentShape,
           propertiesWithoutErrors: [],
           propertiesWithErrors: [],
+          rules: options.rules,
         };
       },
       apply(tr, state) {
@@ -107,31 +137,30 @@ async function validationCallback(view: EditorView, documentHtml: string) {
     ...shacl.match(undefined, propertyPred, undefined),
   ].map((quad: Quad) => quad.object);
 
-  const propertiesWithErrors: {
-    sourceShape: BlankNode | NamedNode<string>;
-    focusNode: BlankNode | NamedNode<string> | null;
-  }[] = [];
-  for (const r of report.results) {
-    const sourceShape = r.sourceShape;
-    if (sourceShape)
-      propertiesWithErrors.push({ sourceShape, focusNode: r.focusNode });
-  }
   const errorMessagePred = sayFactory.namedNode(
     'http://www.w3.org/ns/shacl#resultMessage',
   );
-  const propertiesWithErrorsMessages = propertiesWithErrors
-    .map(({ sourceShape, focusNode }) => {
+  const propertiesWithErrors: PropertyWithError[] = [];
+  for (const r of report.results) {
+    const sourceShape = r.sourceShape;
+    if (sourceShape) {
       const match = shacl.match(sourceShape, errorMessagePred, undefined);
       const message = [...match][0]?.object.value;
-      return message
-        ? { message: removeQuotes(message), subject: focusNode?.value }
-        : undefined;
-    })
-    .filter((message) => message);
+      if (message) {
+        propertiesWithErrors.push({
+          message: removeQuotes(message),
+          subject: r.focusNode?.value,
+          shape: sourceShape.value,
+          constraint: r.sourceConstraintComponent?.value as string,
+        });
+      }
+    }
+  }
+
   const propertiesWithoutErrorsArray = propertyNodes.filter((propertyNode) =>
-    propertiesWithErrors.some((propertyWithError) => {
-      return propertyWithError.sourceShape.value !== propertyNode.value;
-    }),
+    propertiesWithErrors.every(
+      (propertyWithError) => propertyWithError.shape !== propertyNode.value,
+    ),
   );
 
   const successMessagePred = sayFactory.namedNode(
@@ -149,7 +178,7 @@ async function validationCallback(view: EditorView, documentHtml: string) {
     type: 'setNewReport',
     report,
     propertiesWithoutErrors,
-    propertiesWithErrors: propertiesWithErrorsMessages,
+    propertiesWithErrors: propertiesWithErrors,
   });
   transaction.setMeta('addToHistory', false);
   view.dispatch(transaction);

package/addon/plugins/roadsign-regulation-plugin/actions/insert-measure.ts

@@ -38,30 +38,50 @@ import { createNumberVariable } from '../../variable-plugin/actions/create-numbe
 import { createDateVariable } from '../../variable-plugin/actions/create-date-variable';
 import { createCodelistVariable } from '../../variable-plugin/actions/create-codelist-variable';
 import { createClassicLocationVariable } from '../../variable-plugin/actions/create-classic-location-variable';
+import { isTrafficSignal, TrafficSignal } from '../schemas/traffic-signal';
+import { MobilityMeasurePreview } from '../schemas/mobility-measure-preview';
+import {
+  isVariableInstance,
+  VariableInstance,
+} from '../schemas/variable-instance';
 
-interface InsertMeasureArgs {
-  measureConcept: MobilityMeasureConcept;
+type InsertMeasureArgs = {
   zonality: ZonalOrNot;
   temporal: boolean;
-  variables: Record<string, Exclude<Variable, { type: 'instruction' }>>;
+  variables: Record<
+    string,
+    Exclude<Variable, { type: 'instruction' }> | VariableInstance
+  >;
   templateString: string;
   decisionUri: string;
   articleUriGenerator?: () => string;
-}
+} & (
+  | {
+      measureConcept: MobilityMeasureConcept;
+    }
+  | {
+      measurePreview: MobilityMeasurePreview;
+    }
+);
 
 export default function insertMeasure({
-  measureConcept,
   zonality,
   temporal,
   variables,
   templateString,
   articleUriGenerator,
   decisionUri,
+  ...args
 }: InsertMeasureArgs): TransactionMonad<boolean> {
   return function (state: EditorState) {
+    const measureConcept =
+      'measureConcept' in args
+        ? args.measureConcept
+        : args.measurePreview.measureConcept;
+    const measurePreview = 'measurePreview' in args && args.measurePreview;
     const { schema } = state;
     const signNodes = measureConcept.trafficSignalConcepts.map((signConcept) =>
-      constructSignNode(signConcept, schema, zonality),
+      constructSignalNode(signConcept, schema, zonality),
     );
     let signSection: PNode[] = [];
     if (signNodes.length) {
@@ -117,6 +137,14 @@ export default function insertMeasure({
             predicate: DCT('description').full,
             object: sayDataFactory.contentLiteral('nl-BE'),
           },
+          ...(measurePreview
+            ? [
+                {
+                  predicate: MOBILITEIT('isGebaseerdOpMaatregelOntwerp'),
+                  object: sayDataFactory.namedNode(measurePreview.uri),
+                },
+              ]
+            : []),
           // TODO there are some properties that are missing from the measure that we should define if we can:
           // locn:address, mobiliteit:contactorganisatie, mobiliteit:doelgroep, adms:identifier,
           // mobiliteit:periode, mobiliteit:plaatsbepaling, schema:eventSchedule, mobiliteit:type,
@@ -172,7 +200,10 @@ export default function insertMeasure({
 
 function constructMeasureBody(
   templateString: string,
-  variables: Record<string, Exclude<Variable, { type: 'instruction' }>>,
+  variables: Record<
+    string,
+    Exclude<Variable, { type: 'instruction' }> | VariableInstance
+  >,
   schema: Schema,
 ) {
   const parts = templateString.split(/(\$\{[^{}$]+\})/);
@@ -216,13 +247,18 @@ function determineSignLabel(signConcept: TrafficSignalConcept) {
   }
 }
 
-function constructSignNode(
-  signConcept: TrafficSignalConcept,
+function constructSignalNode(
+  signalOrSignalConcept: TrafficSignal | TrafficSignalConcept,
   schema: Schema,
   zonality?: ZonalOrNot,
 ) {
-  const signUri = `http://data.lblod.info/verkeerstekens/${uuid()}`;
-  const prefix = determineSignLabel(signConcept);
+  const signalConcept = isTrafficSignal(signalOrSignalConcept)
+    ? signalOrSignalConcept.trafficSignalConcept
+    : signalOrSignalConcept;
+  const signalUri = isTrafficSignal(signalOrSignalConcept)
+    ? signalOrSignalConcept.uri
+    : `http://data.lblod.info/verkeerstekens/${uuid()}`;
+  const prefix = determineSignLabel(signalConcept);
   const zonalityText =
     !zonality || zonality !== ZONALITY_OPTIONS.ZONAL
       ? ''
@@ -232,7 +268,7 @@ function constructSignNode(
   const node = schema.nodes.inline_rdfa.create(
     {
       rdfaNodeType: 'resource',
-      subject: signUri,
+      subject: signalUri,
       __rdfaId: uuid(),
       properties: [
         {
@@ -242,33 +278,48 @@ function constructSignNode(
         {
           predicate: RDF('type').full,
           object: sayDataFactory.namedNode(
-            TRAFFIC_SIGNAL_TYPE_MAPPING[signConcept.type],
+            TRAFFIC_SIGNAL_TYPE_MAPPING[signalConcept.type],
           ),
         },
         {
           predicate: PROV('wasDerivedFrom').full,
-          object: sayDataFactory.namedNode(signConcept.uri),
+          object: sayDataFactory.namedNode(signalOrSignalConcept.uri),
         },
         // TODO should include extra Verkeersteken properties? mobiliteit:heeftOnderbord,
         // mobiliteit:isBeginZone, mobiliteit:isEindeZone?
       ],
     },
     schema.text(
-      `${prefix} ${signConcept.regulatoryNotation || signConcept.code}${zonalityText}`,
+      `${prefix} ${signalConcept.regulatoryNotation || signalConcept.code}${zonalityText}`,
     ),
   );
   return node;
 }
 
 function constructVariableNode(
-  variable: Exclude<Variable, { type: 'instruction' }>,
+  variableOrVariableInstance:
+    | Exclude<Variable, { type: 'instruction' }>
+    | VariableInstance,
   schema: Schema,
 ) {
-  const variableInstance = generateVariableInstanceUri();
+  const variable = isVariableInstance(variableOrVariableInstance)
+    ? variableOrVariableInstance.variable
+    : variableOrVariableInstance;
+  const variableInstance = isVariableInstance(variableOrVariableInstance)
+    ? variableOrVariableInstance
+    : {
+        uri: generateVariableInstanceUri(),
+        value: undefined,
+      };
+  const valueStr =
+    variableInstance.value instanceof Date
+      ? variableInstance.value.toISOString()
+      : variableInstance.value?.toString();
   const args = {
     schema,
     variable: variable.uri,
-    variableInstance,
+    variableInstance: variableInstance.uri,
+    value: valueStr,
     label: variable.label,
   };
   switch (variable.type) {

package/addon/plugins/roadsign-regulation-plugin/queries/mobility-measure-concept.ts

@@ -92,8 +92,15 @@ async function _queryMobilityMeasures<Count extends boolean>(
     : /* sparql */ `SELECT DISTINCT ?uri ?label ?preview ?zonality ?variableSignage`;
 
   const filterStatement = _buildFilters(options).join('\n');
+  const orderBindings = !count
+    ? `
+      BIND(REPLACE(?label, "^(\\\\D+).*", "$1", "i") AS ?firstLetters)
+      BIND(xsd:decimal(REPLACE(?label, "^\\\\D+(\\\\d*\\\\.?\\\\d*).*", "$1", "i")) AS ?number)
+      BIND(REPLACE(?label, "^\\\\D+\\\\d*\\\\.?\\\\d*(.*)", "$1", "i") AS ?secondLetters)
+    `
+    : '';
   const orderByStatement = !count
-    ? /* sparql */ `ORDER BY ASC(strlen(str(?label))) ASC(?label)`
+    ? /* sparql */ `ORDER BY ASC(UCASE(?firstLetters)) ASC(?number) ASC(LCASE(?secondLetters))`
     : '';
   const paginationStatement = !count
     ? /* sparql */ `LIMIT ${pageSize} OFFSET ${page * pageSize}`
@@ -126,6 +133,7 @@ async function _queryMobilityMeasures<Count extends boolean>(
         ?signUri dct:type ?signClassification.
       }
       ${filterStatement}
+      ${orderBindings}
     }
     ${orderByStatement}
     ${paginationStatement}

package/addon/plugins/roadsign-regulation-plugin/schemas/mobility-measure-preview.ts

@@ -0,0 +1,22 @@
+import { z } from 'zod';
+import { TrafficSignalSchema } from './traffic-signal';
+import {
+  type MobilityMeasureConcept,
+  MobilityMeasureConceptSchema,
+} from './mobility-measure-concept';
+
+export const MobilityMeasurePreviewSchema = z.object({
+  uri: z.string(),
+  trafficSignals: z.array(TrafficSignalSchema),
+  measureConcept: MobilityMeasureConceptSchema,
+});
+
+export type MobilityMeasurePreview = z.infer<
+  typeof MobilityMeasurePreviewSchema
+>;
+
+export function isMobilityMeasurePreview(
+  conceptOrPreview: MobilityMeasureConcept | MobilityMeasurePreview,
+): conceptOrPreview is MobilityMeasurePreview {
+  return 'measureConcept' in conceptOrPreview;
+}

package/addon/plugins/roadsign-regulation-plugin/schemas/traffic-signal.ts

@@ -0,0 +1,18 @@
+import { z } from 'zod';
+import {
+  TrafficSignalConcept,
+  TrafficSignalConceptSchema,
+} from './traffic-signal-concept';
+
+export const TrafficSignalSchema = z.object({
+  uri: z.string(),
+  trafficSignalConcept: TrafficSignalConceptSchema,
+});
+
+export type TrafficSignal = z.infer<typeof TrafficSignalSchema>;
+
+export function isTrafficSignal(
+  signalOrSignalConcept: TrafficSignal | TrafficSignalConcept,
+): signalOrSignalConcept is TrafficSignal {
+  return 'trafficSignalConcept' in signalOrSignalConcept;
+}

package/addon/plugins/roadsign-regulation-plugin/schemas/variable-instance.ts

@@ -0,0 +1,55 @@
+import { z } from 'zod';
+import {
+  CodelistVariableSchema,
+  DateVariableSchema,
+  LocationVariableSchema,
+  NumberVariableSchema,
+  TextVariableSchema,
+  Variable,
+} from './variable';
+
+const BaseVariableInstanceSchema = z.object({
+  uri: z.string(),
+  id: z.string(),
+});
+
+const TextVariableInstanceSchema = BaseVariableInstanceSchema.extend({
+  value: z.string().optional(),
+  variable: TextVariableSchema,
+});
+
+const NumberVariableInstanceSchema = BaseVariableInstanceSchema.extend({
+  value: z.number({ coerce: true }).optional(),
+  variable: NumberVariableSchema,
+});
+
+const DateVariableInstanceSchema = BaseVariableInstanceSchema.extend({
+  value: z.date({ coerce: true }).optional(),
+  variable: DateVariableSchema,
+});
+
+const LocationVariableInstanceSchema = BaseVariableInstanceSchema.extend({
+  value: z.string().optional(),
+  variable: LocationVariableSchema,
+});
+
+const CodelistVariableInstanceSchema = BaseVariableInstanceSchema.extend({
+  value: z.string().optional(),
+  variable: CodelistVariableSchema,
+});
+
+const VariableInstanceSchema = z.union([
+  TextVariableInstanceSchema,
+  NumberVariableInstanceSchema,
+  DateVariableInstanceSchema,
+  LocationVariableInstanceSchema,
+  CodelistVariableInstanceSchema,
+]);
+
+export type VariableInstance = z.infer<typeof VariableInstanceSchema>;
+
+export function isVariableInstance(
+  variableOrVariableInstance: Variable | VariableInstance,
+): variableOrVariableInstance is VariableInstance {
+  return 'variable' in variableOrVariableInstance;
+}

package/addon/plugins/roadsign-regulation-plugin/schemas/variable.ts

@@ -5,33 +5,33 @@ const BaseVariableSchema = z.object({
   label: z.string(),
   source: z.string().optional(),
 });
-const TextVariableSchema = BaseVariableSchema.extend({
+export const TextVariableSchema = BaseVariableSchema.extend({
   type: z.literal('text'),
   defaultValue: z.string().optional(),
 });
 
-const NumberVariableSchema = BaseVariableSchema.extend({
+export const NumberVariableSchema = BaseVariableSchema.extend({
   type: z.literal('number'),
   defaultValue: z.number({ coerce: true }).optional(),
 });
 
-const DateVariableSchema = BaseVariableSchema.extend({
+export const DateVariableSchema = BaseVariableSchema.extend({
   type: z.literal('date'),
   defaultValue: z.date({ coerce: true }).optional(),
 });
 
-const CodelistVariableSchema = BaseVariableSchema.extend({
+export const CodelistVariableSchema = BaseVariableSchema.extend({
   type: z.literal('codelist'),
   defaultValue: z.string().optional(),
   codelistUri: z.string(),
 });
 
-const LocationVariableSchema = BaseVariableSchema.extend({
+export const LocationVariableSchema = BaseVariableSchema.extend({
   type: z.literal('location'),
   defaultValue: z.string().optional(),
 });
 
-const InstructionVariableSchema = BaseVariableSchema.extend({
+export const InstructionVariableSchema = BaseVariableSchema.extend({
   type: z.literal('instruction'),
 });
 

package/addon/{plugins/besluit-topic-plugin/utils/helpers.ts → utils/decision-utils.ts}

@@ -7,6 +7,16 @@ import { hasOutgoingNamedNodeTriple } from '@lblod/ember-rdfa-editor-lblod-plugi
 import { ElementPNode } from '@lblod/ember-rdfa-editor/plugins/datastore';
 import { findAncestors } from '@lblod/ember-rdfa-editor/utils/position-utils';
 
+export function getDecisionNodeLocation(controller: SayController) {
+  const besluitRange = getCurrentBesluitRange(controller);
+  if (!besluitRange) return;
+  const decisionNodeLocation = {
+    pos: besluitRange.from,
+    node: besluitRange.node,
+  };
+  return decisionNodeLocation;
+}
+
 export const getCurrentBesluitRange = (
   controllerOrState: SayController | EditorState,
 ): ElementPNode | undefined => {
@@ -15,15 +25,29 @@ export const getCurrentBesluitRange = (
       ? controllerOrState.mainEditorState
       : controllerOrState;
   const selection = state.selection;
-
-  const besluit =
-    findAncestors(selection.$from, (node: PNode) => {
-      return hasOutgoingNamedNodeTriple(
-        node.attrs,
-        RDF('type'),
-        BESLUIT('Besluit'),
-      );
-    })[0] ?? null;
+  let besluit;
+  if (
+    selection.$from.nodeAfter &&
+    hasOutgoingNamedNodeTriple(
+      selection.$from.nodeAfter.attrs,
+      RDF('type'),
+      BESLUIT('Besluit'),
+    )
+  ) {
+    besluit = {
+      node: selection.$from.nodeAfter,
+      pos: selection.$from.pos,
+    };
+  } else {
+    besluit =
+      findAncestors(selection.$from, (node: PNode) => {
+        return hasOutgoingNamedNodeTriple(
+          node.attrs,
+          RDF('type'),
+          BESLUIT('Besluit'),
+        );
+      })[0] ?? null;
+  }
   if (!besluit) {
     return undefined;
   }

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;
@@ -9,14 +10,63 @@ 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(): ({
+        rule: {
+            action: (controller: SayController, report: ValidationReport) => void;
+            buttonTitle: string;
+        } | {
+            helpText: string;
+        };
         message: string;
         subject: string | undefined;
-    } | undefined)[] | undefined;
+        shape: string;
+        constraint: string;
+    } | {
+        rule: {
+            shaclRule: string;
+            action: (controller: SayController, report: ValidationReport) => void;
+            buttonTitle: string;
+        } | {
+            shaclRule: string;
+            helpText: string;
+        } | undefined;
+        message: string;
+        subject: string | undefined;
+        shape: string;
+        constraint: string;
+    })[] | 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;
+    dedupeDocumentValidationErrors: (val: typeof this.documentValidationErrors) => ({
+        rule: {
+            action: (controller: SayController, report: ValidationReport) => void;
+            buttonTitle: string;
+        } | {
+            helpText: string;
+        };
+        message: string;
+        subject: string | undefined;
+        shape: string;
+        constraint: string;
+    } | {
+        rule: {
+            shaclRule: string;
+            action: (controller: SayController, report: ValidationReport) => void;
+            buttonTitle: string;
+        } | {
+            shaclRule: string;
+            helpText: string;
+        } | undefined;
+        message: string;
+        subject: string | undefined;
+        shape: string;
+        constraint: string;
+    })[] | undefined;
+    compareDocumentValidationErrors: (val1: typeof this.documentValidationErrors, val2: typeof this.documentValidationErrors) => boolean;
 }
 export {};

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

@@ -1,9 +1,11 @@
 import { Command } from '@lblod/ember-rdfa-editor';
 import IntlService from 'ember-intl/services/intl';
+import { NodeWithPos } from '@curvenote/prosemirror-utils';
 interface InsertArticleContainerArgs {
     intl: IntlService;
     decisionUri: string;
     articleUriGenerator?: () => string;
+    decisionLocation: NodeWithPos;
 }
-export default function insertArticleContainer({ decisionUri, articleUriGenerator, }: InsertArticleContainerArgs): Command;
+export default function insertArticleContainer({ decisionUri, articleUriGenerator, decisionLocation, }: InsertArticleContainerArgs): Command;
 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;