@lblod/ember-rdfa-editor-lblod-plugins 0.4.1 → 1.0.0-alpha.2

package/addon/plugins/article-structure-plugin/structures/chapter.ts

@@ -0,0 +1,83 @@
+import { unwrap } from '@lblod/ember-rdfa-editor/utils/option';
+import { StructureSpec } from '..';
+import {
+  constructStructureBodyNodeSpec,
+  constructStructureNodeSpec,
+  romanize,
+} from '../utils/structure';
+import { v4 as uuid } from 'uuid';
+import { SAY } from '../constants';
+
+const PLACEHOLDERS = {
+  title: 'article-structure-plugin.placeholder.chapter.heading',
+  body: 'article-structure-plugin.placeholder.chapter.body',
+};
+export const chapterSpec: StructureSpec = {
+  name: 'chapter',
+  context: ['doc', 'block', 'title_body'],
+  continuous: false,
+  translations: {
+    insert: 'article-structure-plugin.insert.chapter',
+    move: {
+      up: 'article-structure-plugin.moveUp.chapter',
+      down: 'article-structure-plugin.moveDown.chapter',
+    },
+    remove: 'article-structure-plugin.remove.chapter',
+  },
+  constructor: ({ schema, number, content, intl }) => {
+    const numberConverted = romanize(number ?? 1);
+    const node = schema.node(
+      `chapter`,
+      { resource: `http://data.lblod.info/chapters/${uuid()}` },
+      [
+        schema.node(
+          'structure_header',
+          { level: 4, number: numberConverted },
+          schema.node('placeholder', {
+            placeholderText: intl?.t(PLACEHOLDERS.title),
+          })
+        ),
+        schema.node(
+          `chapter_body`,
+          {},
+          content ??
+            schema.node(
+              'paragraph',
+              {},
+              schema.node('placeholder', {
+                placeholderText: intl?.t(PLACEHOLDERS.body),
+              })
+            )
+        ),
+      ]
+    );
+    const selectionConfig: {
+      relativePos: number;
+      type: 'text' | 'node';
+    } = content
+      ? { relativePos: 5, type: 'text' }
+      : { relativePos: 6, type: 'node' };
+    return {
+      node,
+      selectionConfig,
+    };
+  },
+  updateNumber: ({ number, pos, transaction }) => {
+    const numberConverted = romanize(number);
+    return transaction.setNodeAttribute(pos + 1, 'number', numberConverted);
+  },
+  content: ({ pos, state }) => {
+    const node = unwrap(state.doc.nodeAt(pos));
+    return node.child(1).content;
+  },
+};
+
+export const chapter = constructStructureNodeSpec({
+  type: SAY('Chapter'),
+  content: 'structure_header chapter_body',
+  group: 'block',
+});
+
+export const chapter_body = constructStructureBodyNodeSpec({
+  content: '(section|paragraph)+|(article|paragraph)+',
+});

package/addon/plugins/article-structure-plugin/structures/index.ts

@@ -0,0 +1,33 @@
+import { ArticleStructurePluginOptions } from '..';
+import { article, articleSpec, article_body, article_header } from './article';
+import { articleParagraphSpec, article_paragraph } from './article-paragraph';
+import { chapterSpec, chapter, chapter_body } from './chapter';
+import { titleSpec, title, title_body } from './title';
+import { sectionSpec, section, section_body } from './section';
+import { structure_header } from './structure-header';
+import { subsectionSpec, subsection, subsection_body } from './subsection';
+
+export const STRUCTURE_SPECS: ArticleStructurePluginOptions = [
+  titleSpec,
+  chapterSpec,
+  sectionSpec,
+  subsectionSpec,
+  articleSpec,
+  articleParagraphSpec,
+];
+
+export const STRUCTURE_NODES = {
+  structure_header,
+  title,
+  title_body,
+  chapter,
+  chapter_body,
+  section,
+  section_body,
+  subsection,
+  subsection_body,
+  article,
+  article_header,
+  article_body,
+  article_paragraph,
+};

package/addon/plugins/article-structure-plugin/structures/section.ts

@@ -0,0 +1,82 @@
+import {
+  constructStructureBodyNodeSpec,
+  constructStructureNodeSpec,
+  romanize,
+} from '../utils/structure';
+import { v4 as uuid } from 'uuid';
+import { StructureSpec } from '..';
+import { unwrap } from '@lblod/ember-rdfa-editor/utils/option';
+import { SAY } from '../constants';
+
+const PLACEHOLDERS = {
+  title: 'article-structure-plugin.placeholder.section.heading',
+  body: 'article-structure-plugin.placeholder.section.body',
+};
+export const sectionSpec: StructureSpec = {
+  name: 'section',
+  context: ['chapter_body'],
+  continuous: false,
+  translations: {
+    insert: 'article-structure-plugin.insert.section',
+    move: {
+      up: 'article-structure-plugin.moveUp.section',
+      down: 'article-structure-plugin.moveDown.section',
+    },
+    remove: 'article-structure-plugin.remove.section',
+  },
+  constructor: ({ schema, number, content, intl }) => {
+    const numberConverted = romanize(number || 1);
+    const node = schema.node(
+      `section`,
+      { resource: `http://data.lblod.info/sections/${uuid()}` },
+      [
+        schema.node(
+          'structure_header',
+          { level: 4, number: numberConverted },
+          schema.node('placeholder', {
+            placeholderText: intl?.t(PLACEHOLDERS.title),
+          })
+        ),
+        schema.node(
+          `section_body`,
+          {},
+          content ??
+            schema.node(
+              'paragraph',
+              {},
+              schema.node('placeholder', {
+                placeholderText: intl?.t(PLACEHOLDERS.body),
+              })
+            )
+        ),
+      ]
+    );
+    const selectionConfig: {
+      relativePos: number;
+      type: 'text' | 'node';
+    } = content
+      ? { relativePos: 5, type: 'text' }
+      : { relativePos: 6, type: 'node' };
+    return {
+      node,
+      selectionConfig,
+    };
+  },
+  updateNumber: ({ number, pos, transaction }) => {
+    const numberConverted = romanize(number);
+    return transaction.setNodeAttribute(pos + 1, 'number', numberConverted);
+  },
+  content: ({ pos, state }) => {
+    const node = unwrap(state.doc.nodeAt(pos));
+    return node.child(1).content;
+  },
+};
+
+export const section = constructStructureNodeSpec({
+  type: SAY('Section'),
+  content: 'structure_header section_body',
+});
+
+export const section_body = constructStructureBodyNodeSpec({
+  content: '(subsection|paragraph)+|(article|paragraph)+',
+});

package/addon/plugins/article-structure-plugin/structures/structure-header.ts

@@ -0,0 +1,65 @@
+import { NodeSpec } from '@lblod/ember-rdfa-editor';
+import { ELI, EXT, SAY, XSD } from '../constants';
+import { getStructureHeaderAttrs } from '../utils/structure';
+
+const TAG_TO_LEVEL = new Map([
+  ['h1', 1],
+  ['h2', 2],
+  ['h3', 3],
+  ['h4', 4],
+  ['h5', 5],
+  ['h6', 6],
+  ['span', 6],
+]);
+
+export const structure_header: NodeSpec = {
+  content: 'text*|placeholder',
+  inline: false,
+  attrs: {
+    property: {
+      default: SAY('heading').prefixed,
+    },
+
+    number: {
+      default: '1',
+    },
+    level: {
+      default: 1,
+    },
+  },
+  toDOM(node) {
+    return [
+      `h${node.attrs.level as number}`,
+      { property: node.attrs.property as string },
+      [
+        'span',
+        { property: ELI('number').prefixed, datatype: XSD('string').prefixed },
+        node.attrs.number,
+      ],
+      '. ',
+      [
+        'span',
+        {
+          property: EXT('title').prefixed,
+        },
+        0,
+      ],
+    ];
+  },
+  parseDOM: [
+    {
+      tag: 'h1,h2,h3,h4,h5,h6,span',
+      getAttrs(element: HTMLElement) {
+        const level = TAG_TO_LEVEL.get(element.tagName.toLowerCase()) ?? 6;
+        const headerAttrs = getStructureHeaderAttrs(element);
+        if (headerAttrs) {
+          return { level, ...headerAttrs };
+        }
+
+        return false;
+      },
+      contentElement: `span[property~='${EXT('title').prefixed}'], 
+                       span[property~='${EXT('title').full}']`,
+    },
+  ],
+};

package/addon/plugins/article-structure-plugin/structures/subsection.ts

@@ -0,0 +1,83 @@
+import { StructureSpec } from '..';
+import {
+  constructStructureBodyNodeSpec,
+  constructStructureNodeSpec,
+  romanize,
+} from '../utils/structure';
+import { v4 as uuid } from 'uuid';
+import { unwrap } from '@lblod/ember-rdfa-editor/utils/option';
+import { SAY } from '../constants';
+
+const PLACEHOLDERS = {
+  title: 'article-structure-plugin.placeholder.subsection.heading',
+  body: 'article-structure-plugin.placeholder.subsection.body',
+};
+
+export const subsectionSpec: StructureSpec = {
+  name: 'subsection',
+  context: ['section_body'],
+  continuous: false,
+  translations: {
+    insert: 'article-structure-plugin.insert.subsection',
+    move: {
+      up: 'article-structure-plugin.moveUp.subsection',
+      down: 'article-structure-plugin.moveDown.subsection',
+    },
+    remove: 'article-structure-plugin.remove.subsection',
+  },
+  constructor: ({ schema, number, intl, content }) => {
+    const numberConverted = romanize(number ?? 1);
+    const node = schema.node(
+      `subsection`,
+      { resource: `http://data.lblod.info/subsections/${uuid()}` },
+      [
+        schema.node(
+          'structure_header',
+          { level: 4, number: numberConverted },
+          schema.node('placeholder', {
+            placeholderText: intl?.t(PLACEHOLDERS.title),
+          })
+        ),
+        schema.node(
+          `subsection_body`,
+          {},
+          content ??
+            schema.node(
+              'paragraph',
+              {},
+              schema.node('placeholder', {
+                placeholderText: intl?.t(PLACEHOLDERS.body),
+              })
+            )
+        ),
+      ]
+    );
+    const selectionConfig: {
+      relativePos: number;
+      type: 'text' | 'node';
+    } = content
+      ? { relativePos: 5, type: 'text' }
+      : { relativePos: 6, type: 'node' };
+    return {
+      node,
+      selectionConfig,
+    };
+  },
+  updateNumber: ({ number, pos, transaction }) => {
+    const numberConverted = romanize(number);
+    return transaction.setNodeAttribute(pos + 1, 'number', numberConverted);
+  },
+  content: ({ pos, state }) => {
+    const node = unwrap(state.doc.nodeAt(pos));
+    return node.child(1).content;
+  },
+};
+
+export const subsection = constructStructureNodeSpec({
+  type: SAY('Subsection'),
+  content: 'structure_header subsection_body',
+});
+
+export const subsection_body = constructStructureBodyNodeSpec({
+  content: '(article|paragraph)+',
+});

package/addon/plugins/article-structure-plugin/structures/title.ts

@@ -0,0 +1,83 @@
+import { unwrap } from '@lblod/ember-rdfa-editor/utils/option';
+import { StructureSpec } from '..';
+import {
+  constructStructureBodyNodeSpec,
+  constructStructureNodeSpec,
+  romanize,
+} from '../utils/structure';
+import { v4 as uuid } from 'uuid';
+import { SAY } from '../constants';
+
+const PLACEHOLDERS = {
+  heading: 'article-structure-plugin.placeholder.generic.heading',
+  body: 'article-structure-plugin.placeholder.generic.body',
+};
+export const titleSpec: StructureSpec = {
+  name: 'title',
+  context: ['doc', 'block'],
+  continuous: false,
+  translations: {
+    insert: 'article-structure-plugin.insert.title',
+    move: {
+      up: 'article-structure-plugin.moveUp.title',
+      down: 'article-structure-plugin.moveDown.title',
+    },
+    remove: 'article-structure-plugin.remove.title',
+  },
+  constructor: ({ schema, number, content, intl }) => {
+    const numberConverted = romanize(number ?? 1);
+    const node = schema.node(
+      `title`,
+      { resource: `http://data.lblod.info/titles/${uuid()}` },
+      [
+        schema.node(
+          'structure_header',
+          { level: 3, number: numberConverted },
+          schema.node('placeholder', {
+            placeholderText: intl?.t(PLACEHOLDERS.heading),
+          })
+        ),
+        schema.node(
+          `title_body`,
+          {},
+          content ??
+            schema.node(
+              'paragraph',
+              {},
+              schema.node('placeholder', {
+                placeholderText: intl?.t(PLACEHOLDERS.body),
+              })
+            )
+        ),
+      ]
+    );
+    const selectionConfig: {
+      relativePos: number;
+      type: 'text' | 'node';
+    } = content
+      ? { relativePos: 5, type: 'text' }
+      : { relativePos: 6, type: 'node' };
+    return {
+      node,
+      selectionConfig,
+    };
+  },
+  updateNumber: ({ number, pos, transaction }) => {
+    const numberConverted = romanize(number);
+    return transaction.setNodeAttribute(pos + 1, 'number', numberConverted);
+  },
+  content: ({ pos, state }) => {
+    const node = unwrap(state.doc.nodeAt(pos));
+    return node.child(1).content;
+  },
+};
+
+export const title = constructStructureNodeSpec({
+  type: SAY('Title'),
+  content: 'structure_header title_body',
+  group: 'block',
+});
+
+export const title_body = constructStructureBodyNodeSpec({
+  content: '(chapter|paragraph)+|(article|paragraph)+',
+});

package/addon/plugins/article-structure-plugin/utils/namespace.ts

@@ -0,0 +1,25 @@
+export type Resource = {
+  prefixed: string;
+  full: string;
+};
+
+export function namespace(uri: string, prefix: string) {
+  return (s: string): Resource => {
+    return {
+      prefixed: prefix && `${prefix}:${s}`,
+      full: uri + s,
+    };
+  };
+}
+
+export function hasRDFaAttribute(
+  element: Element,
+  attr: string,
+  value: Resource
+) {
+  const result = element.getAttribute(attr)?.split(' ');
+  if (result) {
+    return result.includes(value.full) || result.includes(value.prefixed);
+  }
+  return false;
+}

package/addon/plugins/article-structure-plugin/utils/structure.ts

@@ -0,0 +1,162 @@
+import { NodeSpec, NodeType, Selection } from '@lblod/ember-rdfa-editor';
+import { findParentNodeOfType } from '@curvenote/prosemirror-utils';
+import { ELI, RDF, SAY } from '../constants';
+import { hasRDFaAttribute, Resource } from './namespace';
+
+export function constructStructureNodeSpec(config: {
+  type: Resource;
+  content: string;
+  group?: string;
+}): NodeSpec {
+  const { group, content, type } = config;
+  return {
+    group,
+    content,
+    inline: false,
+    attrs: {
+      property: {
+        default: SAY('hasPart').prefixed,
+      },
+      typeof: {
+        default: type.prefixed,
+      },
+      resource: {},
+    },
+    toDOM(node) {
+      return [
+        'div',
+        {
+          property: node.attrs.property as string,
+          typeof: node.attrs.typeof as string,
+          resource: node.attrs.resource as string,
+        },
+        0,
+      ];
+    },
+    parseDOM: [
+      {
+        tag: 'div',
+        getAttrs(element: HTMLElement) {
+          if (
+            hasRDFaAttribute(element, 'property', SAY('hasPart')) &&
+            hasRDFaAttribute(element, 'typeof', type) &&
+            element.getAttribute('resource')
+          ) {
+            return { resource: element.getAttribute('resource') };
+          }
+          return false;
+        },
+      },
+    ],
+  };
+}
+
+export function constructStructureBodyNodeSpec(config: {
+  content: string;
+}): NodeSpec {
+  const { content } = config;
+  return {
+    content,
+    inline: false,
+    toDOM() {
+      return [
+        'div',
+        {
+          property: SAY('body').prefixed,
+          datatype: RDF('XMLLiteral').prefixed,
+        },
+        0,
+      ];
+    },
+    parseDOM: [
+      {
+        tag: 'div',
+        getAttrs(element: HTMLElement) {
+          if (
+            hasRDFaAttribute(element, 'property', SAY('body')) &&
+            hasRDFaAttribute(element, 'datatype', RDF('XMLLiteral'))
+          ) {
+            return {};
+          }
+          return false;
+        },
+      },
+    ],
+  };
+}
+
+export function findAncestorOfType(selection: Selection, ...types: NodeType[]) {
+  const parent = findParentNodeOfType(types)(selection);
+  if (parent) {
+    return parent;
+  }
+  if (types.includes(selection.$from.doc.type)) {
+    return {
+      node: selection.$from.doc,
+      pos: -1,
+      start: 0,
+      depth: 0,
+    };
+  }
+  return;
+}
+
+export function getStructureHeaderAttrs(element: HTMLElement) {
+  const numberNode = element.children[0];
+  if (
+    hasRDFaAttribute(element, 'property', SAY('heading')) &&
+    numberNode &&
+    hasRDFaAttribute(numberNode, 'property', ELI('number'))
+  ) {
+    return {
+      number: numberNode.textContent,
+    };
+  }
+  return false;
+}
+
+export function romanize(num: number) {
+  if (isNaN(num)) throw new Error('Provided number is NaN');
+  const digits = String(+num).split('');
+  const key = [
+    '',
+    'C',
+    'CC',
+    'CCC',
+    'CD',
+    'D',
+    'DC',
+    'DCC',
+    'DCCC',
+    'CM',
+    '',
+    'X',
+    'XX',
+    'XXX',
+    'XL',
+    'L',
+    'LX',
+    'LXX',
+    'LXXX',
+    'XC',
+    '',
+    'I',
+    'II',
+    'III',
+    'IV',
+    'V',
+    'VI',
+    'VII',
+    'VIII',
+    'IX',
+  ];
+  let roman = '';
+  let i = 3;
+  while (i--) {
+    const digit = digits.pop();
+    if (digit) {
+      roman = (key[Number(digit) + i * 10] || '') + roman;
+    }
+  }
+  return Array(+digits.join('') + 1).join('M') + roman;
+}

package/addon/plugins/besluit-plugin/commands/get-article-nodes-for-besluit.ts

@@ -0,0 +1,30 @@
+import { ProseController } from '@lblod/ember-rdfa-editor';
+import { unwrap } from '@lblod/ember-rdfa-editor/utils/option';
+
+export default function getArticleNodesForBesluit(
+  controller: ProseController,
+  besluitUri?: string
+) {
+  if (!besluitUri) {
+    const selection = controller.state.selection;
+    besluitUri = controller.datastore
+      .limitToRange(controller.state, selection.from, selection.to)
+      .match(null, 'a', 'besluit:Besluit')
+      .asQuadResultSet()
+      .first()?.subject.value;
+  }
+  if (!besluitUri) {
+    return;
+  }
+  const articles = controller.datastore
+    .match(`>${besluitUri}`, 'eli:has_part')
+    .asObjectNodeMapping();
+  return [
+    ...articles.map((article) => {
+      return {
+        uri: article.term.value,
+        range: unwrap(article.nodes.shift()),
+      };
+    }),
+  ];
+}

package/addon/plugins/besluit-plugin/commands/index.ts

@@ -0,0 +1,4 @@
+export { default as insertArticle } from './insert-article';
+export { default as insertTitle } from './insert-title';
+export { default as moveArticle } from './move-article';
+export { default as recalculateArticleNumbers } from './recalculate-article-numbers';