@lblod/ember-rdfa-editor-lblod-plugins 8.2.2 → 8.4.0

package/addon/plugins/article-structure-plugin/commands/insert-structure.ts

@@ -2,19 +2,13 @@ import {
   Command,
   Fragment,
   NodeSelection,
-  NodeType,
-  PNode,
-  Schema,
-  Selection,
   TextSelection,
 } from '@lblod/ember-rdfa-editor';
 import recalculateStructureNumbers from './recalculate-structure-numbers';
 import { StructureSpec } from '@lblod/ember-rdfa-editor-lblod-plugins/plugins/article-structure-plugin';
 import wrapStructureContent from './wrap-structure-content';
 import IntlService from 'ember-intl/services/intl';
-import { findNodes } from '@lblod/ember-rdfa-editor/utils/position-utils';
-import { containsOnlyPlaceholder } from '../utils/structure';
-import { findParentNodeOfType } from '@curvenote/prosemirror-utils';
+import { findInsertionRange } from '@lblod/ember-rdfa-editor-lblod-plugins/utils/_private/find-insertion-range';
 
 const insertStructure = (
   structureSpec: StructureSpec,
@@ -28,7 +22,7 @@ const insertStructure = (
     }
     const insertionRange = findInsertionRange({
       doc,
-      selection,
+      $from: selection.$from,
       nodeType: schema.nodes[structureSpec.name],
       schema,
       limitTo: structureSpec.limitTo,
@@ -65,75 +59,4 @@ const insertStructure = (
   };
 };
 
-function findInsertionRange(args: {
-  doc: PNode;
-  selection: Selection;
-  nodeType: NodeType;
-  schema: Schema;
-  limitTo?: string;
-}) {
-  const { doc, selection, nodeType, schema, limitTo } = args;
-  const { $from } = selection;
-  for (let currentDepth = $from.depth; currentDepth >= 0; currentDepth--) {
-    const currentAncestor = $from.node(currentDepth);
-    const index = $from.index(currentDepth);
-    if (currentAncestor.canReplaceWith(index, index, nodeType)) {
-      if (containsOnlyPlaceholder(schema, currentAncestor)) {
-        return { from: $from.start(currentDepth), to: $from.end(currentDepth) };
-      } else {
-        const insertPos = $from.after(currentDepth + 1);
-        return { from: insertPos, to: insertPos };
-      }
-    }
-  }
-  const limitContainer = limitTo
-    ? findParentNodeOfType(schema.nodes[limitTo])(selection)
-    : null;
-
-  const limitContainerRange = limitContainer
-    ? {
-        from: limitContainer.pos,
-        to: limitContainer.pos + limitContainer.node.nodeSize,
-      }
-    : { from: 0, to: doc.nodeSize };
-  const filterFunction = ({ from, to }: { from: number; to: number }) => {
-    if (from >= limitContainerRange.from && to <= limitContainerRange.to) {
-      const node = doc.nodeAt(from);
-      if (node) {
-        if (node.canReplaceWith(node.childCount, node.childCount, nodeType)) {
-          return true;
-        }
-      }
-    }
-    return false;
-  };
-  const nextContainerRange =
-    findNodes({
-      doc,
-      start: selection.from,
-      visitParentUpwards: true,
-      reverse: false,
-      filter: filterFunction,
-    }).next().value ??
-    findNodes({
-      doc,
-      start: selection.from,
-      visitParentUpwards: true,
-      reverse: true,
-      filter: filterFunction,
-    }).next().value;
-  if (nextContainerRange) {
-    const { from, to } = nextContainerRange;
-    const containerNode = doc.nodeAt(from);
-    if (containerNode) {
-      if (containsOnlyPlaceholder(schema, containerNode)) {
-        return { from: from + 1, to: to - 1 };
-      } else {
-        return { from: to - 1, to: to - 1 };
-      }
-    }
-  }
-  return null;
-}
-
 export default insertStructure;

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

@@ -1,9 +1,12 @@
 import { LEGISLATION_TYPE_CONCEPTS } from './legislation-types';
-import { warn } from '@ember/debug';
 import {
   Option,
   optionMapOr,
 } from '@lblod/ember-rdfa-editor-lblod-plugins/utils/option';
+import {
+  dateValue,
+  escapeValue,
+} from '@lblod/ember-rdfa-editor-lblod-plugins/utils/strings';
 
 interface DecisionArgs {
   uri: string;
@@ -470,39 +473,6 @@ function cleanCaches() {
   fetchArticlesMemory.clear();
 }
 
-function escapeValue(value?: string) {
-  if (value) {
-    const shadowDomElement = document.createElement('textarea');
-    shadowDomElement.innerHTML = value;
-    return shadowDomElement.textContent;
-  } else {
-    return null;
-  }
-}
-
-function dateValue(value?: string): string | null {
-  if (value) {
-    try {
-      return new Intl.DateTimeFormat('nl-BE').format(
-        new Date(Date.parse(value))
-      );
-    } catch (e) {
-      let message: string;
-      if (e instanceof Error) {
-        message = e.message;
-      } else {
-        message = e as string;
-      }
-      warn(`Error parsing date ${value}: ${message}`, {
-        id: 'date-parsing-error',
-      });
-      return null;
-    }
-  } else {
-    return null;
-  }
-}
-
 async function executeCountQuery({
   query,
   config,

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

@@ -0,0 +1,45 @@
+import { Command } from '@lblod/ember-rdfa-editor';
+import { findInsertionRange } from '@lblod/ember-rdfa-editor-lblod-plugins/utils/_private/find-insertion-range';
+import { v4 as uuid } from 'uuid';
+
+interface InsertDocumentTitleArgs {
+  placeholder: string;
+}
+export default function insertDocumentTitle({
+  placeholder,
+}: InsertDocumentTitleArgs): Command {
+  return function (state, dispatch) {
+    const { schema } = state;
+    const insertionRange = findInsertionRange({
+      doc: state.doc,
+      $from: state.doc.resolve(0),
+      nodeType: schema.nodes.document_title,
+      schema,
+    });
+    if (!insertionRange) {
+      return false;
+    }
+
+    if (dispatch) {
+      const tr = state.tr;
+      tr.replaceWith(
+        insertionRange.from,
+        insertionRange.to,
+        schema.node(
+          'document_title',
+          { __rdfaId: uuid() },
+          schema.node(
+            'paragraph',
+            null,
+            schema.node('placeholder', {
+              placeholderText: placeholder,
+            })
+          )
+        )
+      );
+      dispatch(tr);
+    }
+
+    return true;
+  };
+}

package/addon/plugins/document-title-plugin/nodes/document-title.ts

@@ -0,0 +1,36 @@
+import { NodeSpec, getRdfaAttrs, rdfaAttrs } from '@lblod/ember-rdfa-editor';
+
+import { ELI } from '@lblod/ember-rdfa-editor-lblod-plugins/utils/constants';
+
+import { hasRDFaAttribute } from '@lblod/ember-rdfa-editor-lblod-plugins/utils/namespace';
+
+export const document_title: NodeSpec = {
+  content: 'paragraph{1}',
+  inline: false,
+  defining: true,
+  canSplit: false,
+  group: '',
+  attrs: {
+    ...rdfaAttrs,
+    property: {
+      default: 'eli:title',
+    },
+    datatype: {
+      default: 'xsd:string',
+    },
+  },
+  toDOM(node) {
+    return ['h4', node.attrs, 0];
+  },
+  parseDOM: [
+    {
+      tag: 'h1,h2,h3,h4,h5',
+      getAttrs(element: HTMLElement) {
+        if (hasRDFaAttribute(element, 'property', ELI('title'))) {
+          return getRdfaAttrs(element);
+        }
+        return false;
+      },
+    },
+  ],
+};

package/addon/plugins/document-title-plugin/nodes/index.ts

@@ -0,0 +1 @@
+export { document_title } from './document-title';

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

@@ -0,0 +1,27 @@
+import { htmlSafe } from '@ember/template';
+
+import { optionMapOr } from '@lblod/ember-rdfa-editor-lblod-plugins/utils/option';
+import { dateValue } from '@lblod/ember-rdfa-editor-lblod-plugins/utils/strings';
+import { SafeString } from '@lblod/ember-rdfa-editor-lblod-plugins/utils/types';
+
+export type SnippetPluginConfig = {
+  endpoint: string;
+};
+
+interface SnippetArgs {
+  title: string | null;
+  createdOn: string | null;
+  content: string | null;
+}
+
+export class Snippet {
+  content: SafeString | null;
+  createdOn: string | null;
+  title: string | null;
+
+  constructor({ title, createdOn, content }: SnippetArgs) {
+    this.content = optionMapOr(null, htmlSafe, content);
+    this.createdOn = dateValue(createdOn ?? undefined);
+    this.title = title;
+  }
+}

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

@@ -0,0 +1,96 @@
+import {
+  executeCountQuery,
+  executeQuery,
+} from '@lblod/ember-rdfa-editor-lblod-plugins/utils/sparql-helpers';
+import { Snippet } from '../index';
+
+type Filter = { name?: string };
+type Pagination = { pageNumber: number; pageSize: number };
+
+const buildCountQuery = ({ name }: Filter) => {
+  return `
+      PREFIX dct: <http://purl.org/dc/terms/>
+      PREFIX pav: <http://purl.org/pav/>
+      PREFIX ext: <http://mu.semte.ch/vocabularies/ext/>
+
+      SELECT (COUNT(?snippetDocument) AS ?count)
+      WHERE {
+          ?snippetList a ext:SnippetList ;
+              ext:hasSnippet/pav:hasCurrentVersion ?snippetDocument .
+          ?snippetDocument dct:title ?title ;
+              ext:editorDocumentContent ?content ;
+              pav:createdOn ?createdOn .
+          ${name ? `FILTER (CONTAINS(LCASE(?title), "${name}"))` : ''}
+      }
+      `;
+};
+
+const buildFetchQuery = ({
+  filter: { name },
+  pagination: { pageSize, pageNumber },
+}: {
+  filter: Filter;
+  pagination: Pagination;
+}) => {
+  return `
+      PREFIX dct: <http://purl.org/dc/terms/>
+      PREFIX pav: <http://purl.org/pav/>
+      PREFIX ext: <http://mu.semte.ch/vocabularies/ext/>
+
+      SELECT DISTINCT ?title ?content ?createdOn
+      WHERE {
+          ?snippetList a ext:SnippetList ;
+              ext:hasSnippet/pav:hasCurrentVersion ?snippetDocument .
+          ?snippetDocument dct:title ?title ;
+              ext:editorDocumentContent ?content ;
+              pav:createdOn ?createdOn .
+          ${name ? `FILTER (CONTAINS(LCASE(?title), "${name}"))` : ''}
+      }
+      ORDER BY DESC(?createdOn) LIMIT ${pageSize} OFFSET ${
+    pageNumber * pageSize
+  }
+      `;
+};
+
+export const fetchSnippets = async ({
+  endpoint,
+  abortSignal,
+  filter,
+  pagination,
+}: {
+  endpoint: string;
+  abortSignal: AbortSignal;
+  filter: Filter;
+  pagination: Pagination;
+}) => {
+  const totalCount = await executeCountQuery({
+    endpoint,
+    query: buildCountQuery(filter),
+    abortSignal,
+  });
+
+  if (totalCount === 0) {
+    return { totalCount, results: [] };
+  }
+
+  const queryResult = await executeQuery<{
+    title: { value: string };
+    createdOn: { value: string };
+    content: { value: string };
+  }>({
+    endpoint,
+    query: buildFetchQuery({ filter, pagination }),
+    abortSignal,
+  });
+
+  const results = queryResult.results.bindings.map(
+    (binding) =>
+      new Snippet({
+        title: binding.title?.value,
+        createdOn: binding.createdOn?.value,
+        content: binding.content?.value,
+      })
+  );
+
+  return { totalCount, results };
+};

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

@@ -73,20 +73,19 @@ export const contentToDom = ({
   type,
   node,
 }: {
-  content: string;
+  content: string | null;
   type: string;
   node: PNode;
 }) => {
   if (type === 'number') {
-    if (
-      node.attrs[WRITTEN_NUMBER_PNODE_KEY] ||
-      Number.isNaN(Number(content)) ||
-      content === null ||
-      content === ''
-    ) {
-      return n2words(Number(content), { lang: 'nl' });
+    if (!Number.isNaN(Number(content)) && content !== null && content !== '') {
+      if (node.attrs[WRITTEN_NUMBER_PNODE_KEY]) {
+        return n2words(Number(content), { lang: 'nl' });
+      } else {
+        return content;
+      }
     } else {
-      return content;
+      return 'Voeg getal in';
     }
   } else {
     return content;
@@ -137,7 +136,10 @@ export const parseAttributes = (node: HTMLElement): false | Attrs => {
   return false;
 };
 
-export const attributesToDOM = (node: PNode, content = null): DOMOutputSpec => {
+export const attributesToDOM = (
+  node: PNode,
+  content?: string | null
+): DOMOutputSpec => {
   const {
     mappingResource,
     codelistResource,
@@ -192,7 +194,9 @@ export const attributesToDOM = (node: PNode, content = null): DOMOutputSpec => {
         content: content ? content : '',
         ...(!!datatype && { datatype: datatype as string }),
       },
-      content ? contentToDom({ content, type: type as string, node }) : 0,
+      content !== undefined
+        ? contentToDom({ content, type: type as string, node })
+        : 0,
     ],
   ];
 };

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

@@ -43,10 +43,10 @@ export async function fetchCodeListOptions(
   endpoint: string,
   codelistUri: string
 ): Promise<CodeListOptions> {
-  const codelistsOptionsQueryResult = await executeQuery(
+  const codelistsOptionsQueryResult = await executeQuery({
     endpoint,
-    generateCodeListOptionsQuery(codelistUri)
-  );
+    query: generateCodeListOptionsQuery(codelistUri),
+  });
   const options = parseCodelistOptions(codelistsOptionsQueryResult);
   return {
     type:
@@ -95,10 +95,10 @@ export async function fetchCodeListsByPublisher(
   endpoint: string,
   publisher: string
 ): Promise<CodeList[]> {
-  const codelistsOptionsQueryResult = await executeQuery(
+  const codelistsOptionsQueryResult = await executeQuery({
     endpoint,
-    generateCodeListsByPublisherQuery(publisher)
-  );
+    query: generateCodeListsByPublisherQuery(publisher),
+  });
   const bindings = codelistsOptionsQueryResult.results.bindings;
   return bindings.map((binding) => ({
     uri: binding['uri']?.value,

package/addon/utils/_private/find-insertion-range.ts

@@ -0,0 +1,77 @@
+import { findParentNodeClosestToPos } from '@curvenote/prosemirror-utils';
+import { NodeType, PNode, ResolvedPos, Schema } from '@lblod/ember-rdfa-editor';
+import { containsOnlyPlaceholder } from '@lblod/ember-rdfa-editor-lblod-plugins/plugins/article-structure-plugin/utils/structure';
+import { findNodes } from '@lblod/ember-rdfa-editor/utils/position-utils';
+
+export function findInsertionRange(args: {
+  doc: PNode;
+  $from: ResolvedPos;
+  nodeType: NodeType;
+  schema: Schema;
+  limitTo?: string;
+}) {
+  const { doc, $from, nodeType, schema, limitTo } = args;
+  for (let currentDepth = $from.depth; currentDepth >= 0; currentDepth--) {
+    const currentAncestor = $from.node(currentDepth);
+    const index = $from.index(currentDepth);
+    if (currentAncestor.canReplaceWith(index, index, nodeType)) {
+      if (containsOnlyPlaceholder(schema, currentAncestor)) {
+        return { from: $from.start(currentDepth), to: $from.end(currentDepth) };
+      } else {
+        const insertPos = $from.after(currentDepth + 1);
+        return { from: insertPos, to: insertPos };
+      }
+    }
+  }
+  const limitContainer = limitTo
+    ? findParentNodeClosestToPos(
+        $from,
+        (node) => node.type === schema.nodes[limitTo]
+      )
+    : null;
+
+  const limitContainerRange = limitContainer
+    ? {
+        from: limitContainer.pos,
+        to: limitContainer.pos + limitContainer.node.nodeSize,
+      }
+    : { from: 0, to: doc.nodeSize };
+  const filterFunction = ({ from, to }: { from: number; to: number }) => {
+    if (from >= limitContainerRange.from && to <= limitContainerRange.to) {
+      const node = doc.nodeAt(from);
+      if (node) {
+        if (node.canReplaceWith(node.childCount, node.childCount, nodeType)) {
+          return true;
+        }
+      }
+    }
+    return false;
+  };
+  const nextContainerRange =
+    findNodes({
+      doc,
+      start: $from.pos,
+      visitParentUpwards: true,
+      reverse: false,
+      filter: filterFunction,
+    }).next().value ??
+    findNodes({
+      doc,
+      start: $from.pos,
+      visitParentUpwards: true,
+      reverse: true,
+      filter: filterFunction,
+    }).next().value;
+  if (nextContainerRange) {
+    const { from, to } = nextContainerRange;
+    const containerNode = doc.nodeAt(from);
+    if (containerNode) {
+      if (containsOnlyPlaceholder(schema, containerNode)) {
+        return { from: from + 1, to: to - 1 };
+      } else {
+        return { from: to - 1, to: to - 1 };
+      }
+    }
+  }
+  return null;
+}

package/addon/utils/sparql-helpers.ts

@@ -1,13 +1,25 @@
 import * as RDF from '@rdfjs/types';
+import { optionMapOr } from '@lblod/ember-rdfa-editor-lblod-plugins/utils/option';
 
-export type QueryResult = {
+export interface QueryResult<Binding = Record<string, RDF.Term>> {
   results: {
-    bindings: Record<string, RDF.Term>[];
+    bindings: Binding[];
   };
-};
+}
+
+interface QueryConfig {
+  query: string;
+  endpoint: string;
+  abortSignal?: AbortSignal;
+}
 
-export async function executeQuery(endpoint: string, query: string) {
+export async function executeQuery<Binding = Record<string, RDF.Term>>({
+  query,
+  endpoint,
+  abortSignal,
+}: QueryConfig) {
   const encodedQuery = encodeURIComponent(query.trim());
+
   const response = await fetch(endpoint, {
     method: 'POST',
     mode: 'cors',
@@ -16,12 +28,22 @@ export async function executeQuery(endpoint: string, query: string) {
       'Content-Type': 'application/x-www-form-urlencoded; charset=UTF-8',
     },
     body: `query=${encodedQuery}`,
+    signal: abortSignal,
   });
+
   if (response.ok) {
-    return response.json() as unknown as QueryResult;
+    return response.json() as Promise<QueryResult<Binding>>;
   } else {
     throw new Error(
-      `Request to MOW backend was unsuccessful: [${response.status}] ${response.statusText}`
+      `Request to ${endpoint} was unsuccessful: [${response.status}] ${response.statusText}`
     );
   }
 }
+
+export async function executeCountQuery(queryConfig: QueryConfig) {
+  const response = await executeQuery<{ count: { value: string } }>(
+    queryConfig
+  );
+
+  return optionMapOr(0, parseInt, response.results.bindings[0]?.count.value);
+}

package/addon/utils/strings.ts

@@ -0,0 +1,34 @@
+import { warn } from '@ember/debug';
+
+export function escapeValue(value?: string) {
+  if (value) {
+    const shadowDomElement = document.createElement('textarea');
+    shadowDomElement.innerHTML = value;
+    return shadowDomElement.textContent;
+  } else {
+    return null;
+  }
+}
+
+export function dateValue(value?: string): string | null {
+  if (value) {
+    try {
+      return new Intl.DateTimeFormat('nl-BE').format(
+        new Date(Date.parse(value))
+      );
+    } catch (e) {
+      let message: string;
+      if (e instanceof Error) {
+        message = e.message;
+      } else {
+        message = e as string;
+      }
+      warn(`Error parsing date ${value}: ${message}`, {
+        id: 'date-parsing-error',
+      });
+      return null;
+    }
+  } else {
+    return null;
+  }
+}

package/addon/utils/types.ts

@@ -0,0 +1,3 @@
+import { htmlSafe } from '@ember/template';
+
+export type SafeString = ReturnType<typeof htmlSafe>;

package/app/components/document-title-plugin/insert-title-card.js

@@ -0,0 +1 @@
+export { default } from '@lblod/ember-rdfa-editor-lblod-plugins/components/document-title-plugin/insert-title-card';

package/app/components/pagination/pagination-view.js

@@ -0,0 +1 @@
+export { default } from '@lblod/ember-rdfa-editor-lblod-plugins/components/pagination/pagination-view';

package/app/components/snippet-plugin/helpers/alert-load-error.js

@@ -0,0 +1 @@
+export { default } from '@lblod/ember-rdfa-editor-lblod-plugins/components/snippet-plugin/helpers/alert-load-error';

package/app/components/snippet-plugin/helpers/alert-no-items.js

@@ -0,0 +1 @@
+export { default } from '@lblod/ember-rdfa-editor-lblod-plugins/components/snippet-plugin/helpers/alert-no-items';

package/app/components/snippet-plugin/search-modal.js

@@ -0,0 +1 @@
+export { default } from '@lblod/ember-rdfa-editor-lblod-plugins/components/snippet-plugin/search-modal';

package/app/components/snippet-plugin/snippet-insert.js

@@ -0,0 +1 @@
+export { default } from '@lblod/ember-rdfa-editor-lblod-plugins/components/snippet-plugin/snippet-insert';

package/app/components/snippet-plugin/snippets/snippet-list.js

@@ -0,0 +1 @@
+export { default } from '@lblod/ember-rdfa-editor-lblod-plugins/components/snippet-plugin/snippets/snippet-list';

package/app/components/snippet-plugin/snippets/snippet-preview.js

@@ -0,0 +1 @@
+export { default } from '@lblod/ember-rdfa-editor-lblod-plugins/components/snippet-plugin/snippets/snippet-preview';

package/app/helpers/pagination.js

@@ -0,0 +1,4 @@
+export {
+  default,
+  pagination,
+} from '@lblod/ember-rdfa-editor-lblod-plugins/helpers/pagination';

package/app/styles/document-title-plugin.scss

@@ -0,0 +1,9 @@
+[property='eli:title']:before {
+  content: 'Document-titel' !important;
+}
+
+[lang='en-US'] {
+  [property='eli:title']:before {
+    content: 'Document title' !important;
+  }
+}