@lblod/ember-rdfa-editor-lblod-plugins 23.1.0 → 24.0.0

package/addon/components/variable-plugin/autofilled/nodeview.gts

@@ -0,0 +1,100 @@
+import Component from '@glimmer/component';
+import {
+  NodeSelection,
+  PNode,
+  ProsePlugin,
+  SayController,
+  SayView,
+} from '@lblod/ember-rdfa-editor';
+import { editableNodePlugin } from '@lblod/ember-rdfa-editor/plugins/editable-node';
+import { tracked } from '@glimmer/tracking';
+import { action } from '@ember/object';
+import { PencilIcon } from '@appuniversum/ember-appuniversum/components/icons/pencil';
+
+import {
+  EmberNodeArgs,
+  SayNodeViewConstructor,
+} from '@lblod/ember-rdfa-editor/utils/ember-node';
+import { getOutgoingTriple } from '@lblod/ember-rdfa-editor-lblod-plugins/utils/namespace';
+import { EXT } from '@lblod/ember-rdfa-editor-lblod-plugins/utils/constants';
+import AuPill from '@appuniversum/ember-appuniversum/components/au-pill';
+import { on } from '@ember/modifier';
+import EmbeddedEditor from '@lblod/ember-rdfa-editor/components/ember-node/embedded-editor';
+
+type Args = EmberNodeArgs & {
+  getPos: () => number | undefined;
+  node: PNode;
+  updateAttribute: (attr: string, value: unknown) => void;
+  controller: SayController;
+  view: SayView;
+  selected: boolean;
+  selectNode: () => void;
+  nodeViews: Record<string, SayNodeViewConstructor>;
+};
+
+export default class AutoFilledVariableNodeViewComponent extends Component<Args> {
+  PencilIcon = PencilIcon;
+
+  @tracked innerView?: SayView;
+
+  get plugins(): ProsePlugin[] {
+    return [editableNodePlugin(this.args.getPos)];
+  }
+  @action
+  onClick() {
+    if (this.innerView) {
+      if (this.innerView.state.doc.firstChild?.type.name === 'placeholder') {
+        this.innerView.focus();
+        // Use request animation frame to only change the selection when the focus has been established
+        window.requestAnimationFrame(() => {
+          if (this.innerView) {
+            const tr = this.innerView.state.tr;
+            tr.setSelection(NodeSelection.create(this.innerView?.state.doc, 0));
+            this.innerView?.dispatch(tr);
+          }
+        });
+      } else {
+        this.innerView.focus();
+      }
+    }
+  }
+  @action
+  initEditor(view: SayView) {
+    this.innerView = view;
+  }
+
+  get label() {
+    if (this.innerView?.state.doc.firstChild?.type.name !== 'placeholder') {
+      return '';
+    }
+    return getOutgoingTriple(this.args.node.attrs, EXT('label'))?.object.value;
+  }
+  <template>
+    <AuPill
+      @icon={{this.PencilIcon}}
+      @iconAlignment='right'
+      class='variable'
+      {{on 'click' this.onClick}}
+    >
+      <EmbeddedEditor
+        @controller={{@controller}}
+        @view={{@view}}
+        @getPos={{@getPos}}
+        @node={{@node}}
+        @selected={{@selected}}
+        @initEditor={{this.initEditor}}
+        @nodeViews={{@nodeViews}}
+        @plugins={{this.plugins}}
+        @updateAttribute={{@updateAttribute}}
+        @selectNode={{@selectNode}}
+        @placeholder=''
+        @contentDecorations={{@contentDecorations}}
+      />
+      {{#if this.label}}
+        <span class='label'>
+          ({{this.label}})
+        </span>
+      {{/if}}
+    </AuPill>
+  </template>
+}

package/addon/components/variable-plugin/utils/label-input.gts

@@ -0,0 +1,28 @@
+import AuLabel from '@appuniversum/ember-appuniversum/components/au-label';
+import AuNativeInput from '@lblod/ember-rdfa-editor-lblod-plugins/components/au-native-input';
+import t from 'ember-intl/helpers/t';
+import { on } from '@ember/modifier';
+import { TemplateOnlyComponent } from '@ember/component/template-only';
+
+interface Sig {
+  Args: {
+    label: string;
+    updateLabel: (event: InputEvent) => void;
+  };
+}
+
+const LabelInput: TemplateOnlyComponent<Sig> = <template>
+  <AuLabel for='label'>
+    {{t 'variable-plugin.label'}}
+  </AuLabel>
+  <AuNativeInput
+    id='label'
+    placeholder={{t 'variable-plugin.labelPlaceholder'}}
+    @type='text'
+    @width='block'
+    value={{@label}}
+    {{on 'input' @updateLabel}}
+  />
+</template>;
+
+export default LabelInput;

package/addon/plugins/citation-plugin/utils/public-decisions.ts

@@ -1,6 +1,7 @@
 import {
   executeCountQuery,
   executeQuery,
+  sparqlEscapeString,
 } from '@lblod/ember-rdfa-editor-lblod-plugins/utils/sparql-helpers';
 import {
   dateValue,
@@ -43,18 +44,18 @@ const getFilters = ({
   }
 
   const governmentNameFilter = filter.governmentName?.trim()
-    ? `FILTER (CONTAINS(LCASE(?administrativeUnitName), "${replaceDiacriticsInWord(
-        filter.governmentName?.trim(),
-      ).toLowerCase()}"))`
+    ? `FILTER (CONTAINS(LCASE(?administrativeUnitName), ${sparqlEscapeString(
+        replaceDiacriticsInWord(filter.governmentName?.trim()).toLowerCase(),
+      )}))`
     : '';
 
   return `
     ${words
       .map(
         (word) =>
-          `FILTER (CONTAINS(LCASE(?decisionTitle), "${replaceDiacriticsInWord(
-            word,
-          ).toLowerCase()}"))`,
+          `FILTER (CONTAINS(LCASE(?decisionTitle), ${sparqlEscapeString(
+            replaceDiacriticsInWord(word).toLowerCase(),
+          )}))`,
       )
       .join('\n')}
     ${documentDateFilter.join('\n')}

package/addon/plugins/citation-plugin/utils/vlaamse-codex.ts

@@ -5,6 +5,7 @@ import {
 import {
   executeCountQuery,
   executeQuery,
+  sparqlEscapeString,
 } from '@lblod/ember-rdfa-editor-lblod-plugins/utils/sparql-helpers';
 import {
   LegalDocument,
@@ -91,9 +92,9 @@ export async function fetchVlaamseCodexLegalDocuments({
         ${words
           .map(
             (word) =>
-              `FILTER (CONTAINS(LCASE(?title), "${replaceDiacriticsInWord(
-                word,
-              ).toLowerCase()}"))`,
+              `FILTER (CONTAINS(LCASE(?title), ${sparqlEscapeString(
+                replaceDiacriticsInWord(word).toLowerCase(),
+              )}))`,
           )
           .join('\n')}
         ${excludeAdaptationFilters.join('\n')}
@@ -116,9 +117,9 @@ export async function fetchVlaamseCodexLegalDocuments({
           ${words
             .map(
               (word) =>
-                `FILTER (CONTAINS(LCASE(?title), "${replaceDiacriticsInWord(
-                  word,
-                ).toLowerCase()}"))`,
+                `FILTER (CONTAINS(LCASE(?title), ${sparqlEscapeString(
+                  replaceDiacriticsInWord(word).toLowerCase(),
+                )}))`,
             )
             .join('\n')}
           OPTIONAL { ?expressionUri eli:date_publication ?publicationDate . }

package/addon/plugins/snippet-plugin/commands/insert-snippet.ts

@@ -15,6 +15,7 @@ export interface InsertSnippetCommandArgs {
   assignedSnippetListsIds: string[];
   importedResources?: ImportedResourceMap;
   range?: { start: number; end: number };
+  allowMultipleSnippets?: boolean;
 }
 
 const insertSnippet = ({
@@ -23,6 +24,7 @@ const insertSnippet = ({
   assignedSnippetListsIds,
   importedResources,
   range,
+  allowMultipleSnippets,
 }: InsertSnippetCommandArgs): Command => {
   return (state, dispatch) => {
     const domParser = new DOMParser();
@@ -44,6 +46,7 @@ const insertSnippet = ({
         title,
         snippetListIds: assignedSnippetListsIds,
         importedResources,
+        allowMultipleSnippets,
       });
 
       const addImportedResourceProperties = Object.values(
@@ -60,7 +63,6 @@ const insertSnippet = ({
           );
         })
         .flat();
-
       tr = transactionCombinator(
         state,
         tr.replaceRangeWith(insertRange.start, insertRange.end, snippet),
@@ -72,6 +74,7 @@ const insertSnippet = ({
         tr.replaceRange(insertRange.start, insertRange.end, slice),
       )([recalculateNumbers]).transaction;
     }
+    tr.setMeta('insertSnippet', true);
     if (dispatch) {
       dispatch(tr);
     }

package/addon/plugins/snippet-plugin/commands/update-snippet-placeholder.ts

@@ -17,12 +17,14 @@ export const updateSnippetPlaceholder = ({
   newSnippetLists,
   oldImportedResources,
   node,
+  allowMultipleSnippets = false,
 }: {
   resource: string;
   oldSnippetProperties: OutgoingTriple[];
   newSnippetLists: SnippetList[];
   oldImportedResources: ImportedResourceMap;
   node: ResolvedPNode;
+  allowMultipleSnippets?: boolean;
 }): Command => {
   return (state, dispatch) => {
     if (dispatch) {
@@ -68,6 +70,11 @@ export const updateSnippetPlaceholder = ({
           oldImportedResources,
         ),
       );
+      transaction = transaction.setNodeAttribute(
+        node.pos,
+        'allowMultipleSnippets',
+        allowMultipleSnippets,
+      );
 
       dispatch(transaction);
     }

package/addon/plugins/snippet-plugin/nodes/snippet-placeholder.ts

@@ -38,7 +38,11 @@ export function importedResourcesFromSnippetLists(
   );
 }
 
-export function createSnippetPlaceholder(lists: SnippetList[], schema: Schema) {
+export function createSnippetPlaceholder(
+  lists: SnippetList[],
+  schema: Schema,
+  allowMultipleSnippets?: boolean,
+) {
   const mappingResource = `http://example.net/lblod-snippet-placeholder/${uuidv4()}`;
   return schema.nodes.snippet_placeholder.create({
     rdfaNodeType: 'resource',
@@ -55,6 +59,7 @@ export function createSnippetPlaceholder(lists: SnippetList[], schema: Schema) {
       })),
     ],
     importedResources: importedResourcesFromSnippetLists(lists),
+    allowMultipleSnippets,
   });
 }
 
@@ -70,6 +75,7 @@ const emberNodeConfig: EmberNodeConfig = {
     typeof: { default: EXT('SnippetPlaceholder') },
     listNames: { default: [] },
     importedResources: { default: {} },
+    allowMultipleSnippets: { default: false },
   },
   component: SnippetPlaceholderComponent,
   serialize(node, editorState) {
@@ -82,6 +88,7 @@ const emberNodeConfig: EmberNodeConfig = {
         class: 'say-snippet-placeholder-node',
         'data-list-names': (node.attrs.listNames as string[]).join(','),
         'data-imported-resources': JSON.stringify(node.attrs.importedResources),
+        'data-allow-multiple-snippets': node.attrs.allowMultipleSnippets,
       },
       content: [
         'text',
@@ -111,6 +118,8 @@ const emberNodeConfig: EmberNodeConfig = {
             importedResources: jsonParse(
               node.getAttribute('data-imported-resources'),
             ),
+            allowMultipleSnippets:
+              node.dataset.allowMultipleSnippets === 'true',
           };
         }
         return false;

package/addon/plugins/snippet-plugin/nodes/snippet.ts

@@ -63,6 +63,7 @@ interface CreateSnippetArgs {
   title: string;
   snippetListIds: string[];
   importedResources?: ImportedResourceMap;
+  allowMultipleSnippets?: boolean;
 }
 
 /**
@@ -77,6 +78,7 @@ export function createSnippet({
   title,
   snippetListIds,
   importedResources,
+  allowMultipleSnippets,
 }: CreateSnippetArgs): [PNode, Map<string, OutgoingTriple[]>] {
   // Replace instances of linked to uris with the resources that exist in the outer document.
   let replacedContent = content;
@@ -99,6 +101,7 @@ export function createSnippet({
       title,
       subject: `http://data.lblod.info/snippets/${uuidv4()}`,
       importedResources,
+      allowMultipleSnippets,
     },
     contentAsNode.content,
   );
@@ -151,6 +154,7 @@ const emberNodeConfig = (options: SnippetPluginConfig): EmberNodeConfig => ({
     importedResources: { default: {} },
     title: { default: '' },
     config: { default: options },
+    allowMultipleSnippets: { default: false },
   },
   component: SnippetComponent,
   content: options.allowedContent || DEFAULT_CONTENT_STRING,
@@ -165,6 +169,7 @@ const emberNodeConfig = (options: SnippetPluginConfig): EmberNodeConfig => ({
         ).join(','),
         'data-imported-resources': JSON.stringify(node.attrs.importedResources),
         'data-snippet-title': node.attrs.title,
+        'data-allow-multiple-snippets': node.attrs.allowMultipleSnippets,
       },
       content: 0,
     });
@@ -187,6 +192,8 @@ const emberNodeConfig = (options: SnippetPluginConfig): EmberNodeConfig => ({
               node.getAttribute('data-imported-resources'),
             ),
             title: node.getAttribute('data-snippet-title'),
+            allowMultipleSnippets:
+              node.dataset.allowMultipleSnippets === 'true',
           };
         }
         return false;

package/addon/plugins/snippet-plugin/utils/fetch-data.ts

@@ -17,7 +17,7 @@ export type OrderBy =
 type Pagination = { pageNumber: number; pageSize: number };
 
 const buildSnippetCountQuery = ({ name, assignedSnippetListIds }: Filter) => {
-  return `
+  return /* sparql */ `
       PREFIX schema: <http://schema.org/>
       PREFIX dct: <http://purl.org/dc/terms/>
       PREFIX pav: <http://purl.org/pav/>
@@ -25,26 +25,25 @@ const buildSnippetCountQuery = ({ name, assignedSnippetListIds }: Filter) => {
       PREFIX ext: <http://mu.semte.ch/vocabularies/ext/>
       PREFIX prov: <http://www.w3.org/ns/prov#>
       PREFIX mu: <http://mu.semte.ch/vocabularies/core/>
+      PREFIX say: <https://say.data.gift/ns/>
 
-      SELECT (COUNT(?publishedSnippetVersion) AS ?count)
+      SELECT (COUNT(?snippet) AS ?count)
       WHERE {
-          ?publishedSnippetContainer a ext:PublishedSnippetContainer ;
-                             pav:hasCurrentVersion ?publishedSnippetVersion ;
-                             ext:fromSnippetList ?fromSnippetList .
-          ?fromSnippetList mu:uuid ?fromSnippetListId .
-          ?publishedSnippetVersion dct:title ?title ;
-               ext:editorDocumentContent ?content ;
-               pav:createdOn ?createdOn .
-          OPTIONAL { ?publishedSnippetVersion schema:validThrough ?validThrough. }
+          ?snippet a say:Snippet;
+                   pav:hasCurrentVersion ?snippetVersion;
+                   ^say:hasSnippet ?snippetList.
+          ?snippetList mu:uuid ?snippetListId.
+          ?snippetVersion dct:title ?title.
+          OPTIONAL { ?snippetVersion schema:validThrough ?validThrough. }
           FILTER(!BOUND(?validThrough) || xsd:dateTime(?validThrough) > now())
           ${
             name
-              ? `FILTER (CONTAINS(LCASE(?title), "${name.toLowerCase()}"))`
+              ? `FILTER (CONTAINS(LCASE(?title), ${sparqlEscapeString(name.toLowerCase())}))`
               : ''
           }
           ${
             assignedSnippetListIds && assignedSnippetListIds.length
-              ? `FILTER (?fromSnippetListId IN (${assignedSnippetListIds
+              ? `FILTER (?snippetListId IN (${assignedSnippetListIds
                   .map((from) => sparqlEscapeString(from))
                   .join(', ')}))`
               : ''
@@ -76,7 +75,7 @@ const buildSnippetFetchQuery = ({
   filter: Filter;
   pagination: Pagination;
 }) => {
-  return `
+  return /* sparql */ `
       PREFIX schema: <http://schema.org/>
       PREFIX dct: <http://purl.org/dc/terms/>
       PREFIX pav: <http://purl.org/pav/>
@@ -84,32 +83,37 @@ const buildSnippetFetchQuery = ({
       PREFIX ext: <http://mu.semte.ch/vocabularies/ext/>
       PREFIX prov: <http://www.w3.org/ns/prov#>
       PREFIX mu: <http://mu.semte.ch/vocabularies/core/>
+      PREFIX say: <https://say.data.gift/ns/>
 
       SELECT DISTINCT ?title ?content ?createdOn
       WHERE {
-          ?publishedSnippetContainer a ext:PublishedSnippetContainer ;
-                             pav:hasCurrentVersion ?publishedSnippetVersion ;
-                             ext:fromSnippetList ?fromSnippetList .
-          ?fromSnippetList mu:uuid ?fromSnippetListId .
-          ?publishedSnippetVersion dct:title ?title ;
-               ext:editorDocumentContent ?content ;
-               pav:createdOn ?createdOn .
+          ?snippet a say:Snippet;
+                   pav:hasCurrentVersion ?snippetVersion;
+                   pav:createdOn ?createdOn;
+                   ^say:hasSnippet ?snippetList.
+          OPTIONAL {
+            ?snippet schema:position ?position.
+          }
+          ?snippetList mu:uuid ?snippetListId;
+                       pav:createdOn ?snippetListCreatedOn.
+          ?snippetVersion dct:title ?title ;
+                          ext:editorDocumentContent ?content.
+          OPTIONAL { ?snippetVersion schema:validThrough ?validThrough. }
+          FILTER(!BOUND(?validThrough) || xsd:dateTime(?validThrough) > now())
           ${
             name
-              ? `FILTER (CONTAINS(LCASE(?title), "${name.toLowerCase()}"))`
+              ? `FILTER (CONTAINS(LCASE(?title), ${sparqlEscapeString(name.toLowerCase())}))`
               : ''
           }
           ${
             assignedSnippetListIds && assignedSnippetListIds.length
-              ? `FILTER (?fromSnippetListId IN (${assignedSnippetListIds
+              ? `FILTER (?snippetListId IN (${assignedSnippetListIds
                   .map((from) => sparqlEscapeString(from))
                   .join(', ')}))`
               : ''
           }
-          OPTIONAL { ?publishedSnippetVersion schema:validThrough ?validThrough. }
-          FILTER(!BOUND(?validThrough) || xsd:dateTime(?validThrough) > now())
       }
-      ORDER BY DESC(?createdOn) LIMIT ${pageSize} OFFSET ${
+      ORDER BY DESC(?snippetListCreatedOn) ASC(?position) DESC(?createdOn) LIMIT ${pageSize} OFFSET ${
         pageNumber * pageSize
       }
       `;
@@ -138,20 +142,19 @@ const buildSnippetListFetchQuery = ({
   filter: Filter;
   orderBy: OrderBy;
 }) => {
-  return `
+  return /* sparql */ `
         PREFIX pav: <http://purl.org/pav/>
         PREFIX skos: <http://www.w3.org/2004/02/skos/core#>
-        PREFIX ext: <http://mu.semte.ch/vocabularies/ext/>
         PREFIX say: <https://say.data.gift/ns/>
 
         SELECT (?snippetLists as ?id) ?label ?createdOn ?importedResources WHERE {
-          ?snippetLists a ext:SnippetList;
+          ?snippetLists a say:SnippetList;
             skos:prefLabel ?label;
             pav:createdOn ?createdOn.
           OPTIONAL { ?snippetLists say:snippetImportedResource ?importedResources . }
           ${
             name
-              ? `FILTER (CONTAINS(LCASE(?label), "${name.toLowerCase()}"))`
+              ? `FILTER (CONTAINS(LCASE(?label), ${sparqlEscapeString(name.toLowerCase())}))`
               : ''
           }
         }

package/addon/plugins/variable-plugin/plugins/autofiller.ts

@@ -0,0 +1,98 @@
+import {
+  EditorState,
+  PNode,
+  ProsePlugin,
+  Schema,
+  Transaction,
+} from '@lblod/ember-rdfa-editor';
+import { changedDescendants } from '@lblod/ember-rdfa-editor/utils/_private/changed-descendants';
+import { undoDepth } from '@lblod/ember-rdfa-editor/plugins/history';
+
+type AutofilledArgs = {
+  autofilledValues: {
+    [Key: string]: string;
+  };
+};
+
+export function variableAutofillerPlugin(config: AutofilledArgs): ProsePlugin {
+  return new ProsePlugin({
+    appendTransaction(
+      transactions: readonly Transaction[],
+      oldState: EditorState,
+      newState: EditorState,
+    ) {
+      const autofilledVariables: { node: PNode; pos: number }[] = [];
+      if (undoDepth(oldState)) {
+        let isInsertSnippet = false;
+        for (const transaction of transactions) {
+          if (transaction.getMeta('insertSnippet')) {
+            isInsertSnippet = true;
+          }
+        }
+        if (!isInsertSnippet) return;
+        changedDescendants(
+          oldState.doc,
+          newState.doc,
+          0,
+          (node: PNode, pos: number) => {
+            if (
+              node.type.name === 'autofilled_variable' &&
+              !node.attrs.initialized
+            ) {
+              autofilledVariables.push({ node, pos });
+              return false;
+            }
+            return true;
+          },
+        );
+      } else {
+        newState.doc.descendants((node: PNode, pos: number) => {
+          if (
+            node.type.name === 'autofilled_variable' &&
+            !node.attrs.initialized
+          ) {
+            autofilledVariables.push({ node, pos });
+            return false;
+          }
+          return true;
+        });
+      }
+      if (autofilledVariables.length) {
+        const tr = newState.tr;
+        autofilledVariables.reverse();
+        for (const { node, pos } of autofilledVariables) {
+          autofillVariable(
+            node,
+            pos,
+            config.autofilledValues,
+            tr,
+            newState.schema,
+          );
+        }
+        return tr;
+      }
+      return newState.tr;
+    },
+  });
+}
+
+function autofillVariable(
+  node: PNode,
+  pos: number,
+  values: { [Key: string]: string },
+  tr: Transaction,
+  schema: Schema,
+) {
+  const autofillKey = node.attrs.autofillKey as string;
+  const value = values[autofillKey];
+  if (value) {
+    const nodeSize = node.nodeSize;
+    const valueNode = schema.text(value);
+    if (node.attrs.convertToString === true) {
+      tr.replaceRangeWith(pos, pos + nodeSize, valueNode);
+    } else {
+      tr.replaceRangeWith(pos + 1, pos + nodeSize - 1, valueNode);
+      tr.setNodeAttribute(pos, 'initialized', true);
+    }
+  }
+}