@lblod/ember-rdfa-editor-lblod-plugins 11.2.0 → 11.3.0

package/addon/plugins/citation-plugin/utils/{legislation-types.ts → types.ts}

@@ -1,4 +1,6 @@
-const LEGISLATION_TYPES = {
+import { capitalize } from '@ember/string';
+
+export const LEGISLATION_TYPES = {
   decreet: 'https://data.vlaanderen.be/id/concept/AardWetgeving/Decreet',
   'koninklijk besluit':
     'https://data.vlaanderen.be/id/concept/AardWetgeving/KoninklijkBesluit',
@@ -24,24 +26,28 @@ const LEGISLATION_TYPES = {
   'genummerd koninklijk besluit':
     'https://data.vlaanderen.be/id/concept/AardWetgeving/GenummerdKoninklijkBesluit',
   protocol: 'https://data.vlaanderen.be/id/concept/AardWetgeving/Protocol',
+  besluit: 'https://data.vlaanderen.be/doc/concept/AardWetgeving/Besluit',
 };
 
-export type Legislations = typeof LEGISLATION_TYPES;
-export type LegislationKey = keyof Legislations;
-// export type MappedLegislations = {
-//   [K in LegislationKey]: {
-//     label: K;
-//     value: Legislations[K];
-//   };
-// };
-// export type MappedLegislation = MappedLegislations[LegislationKey];
-const LEGISLATION_TYPE_CONCEPTS = Object.entries(LEGISLATION_TYPES).map(
-  (pair: [string, string]) => {
-    return {
-      label: pair[0],
-      value: pair[1],
-    };
-  },
+export const legislationKeysCapitalized = Object.keys(LEGISLATION_TYPES).map(
+  capitalize,
+) as [Capitalize<keyof typeof LEGISLATION_TYPES>];
+
+export const isLegislationType = (
+  type: string,
+): type is keyof typeof LEGISLATION_TYPES =>
+  Object.keys(LEGISLATION_TYPES).includes(type);
+
+export const isBesluitType = (type: string) =>
+  type === LEGISLATION_TYPES['besluit'];
+
+export const LEGISLATION_TYPE_CONCEPTS = Object.entries(LEGISLATION_TYPES).map(
+  ([label, value]) => ({
+    label,
+    value,
+  }),
 );
 
-export { LEGISLATION_TYPES, LEGISLATION_TYPE_CONCEPTS };
+export interface Binding<A> {
+  value: A;
+}

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

@@ -0,0 +1,14 @@
+/*
+ * flemish codex encodes certain characters as a html character, which breaks our search
+ * this is an ugly work around
+ */
+export function replaceDiacriticsInWord(word: string): string {
+  const characters =
+    'Ë À Ì Â Í Ã Î Ä Ï Ç Ò È Ó É Ô Ê Õ Ö ê Ù ë Ú î Û ï Ü ô Ý õ â û ã ÿ ç'.split(
+      ' ',
+    );
+  for (const char of characters) {
+    word = word.replace(new RegExp(`${char}`, 'g'), `&#${char.charCodeAt(0)};`);
+  }
+  return word;
+}

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

@@ -1,158 +1,28 @@
-import { LEGISLATION_TYPE_CONCEPTS } from './legislation-types';
-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;
-  legislationTypeUri: Option<string>;
-  title: string | null;
-  publicationDate: string | null;
-  documentDate: string | null;
-}
-
-export class Decision {
-  uri: string;
-  legislationType: { label: string; value: string } | undefined;
-  title: string | null;
-  publicationDate: string | null;
-  documentDate: string | null;
-
-  constructor({
-    uri,
-    legislationTypeUri,
-    title,
-    publicationDate,
-    documentDate,
-  }: DecisionArgs) {
-    this.uri = uri;
-    this.legislationType = LEGISLATION_TYPE_CONCEPTS.find(
-      (t) => t.value === legislationTypeUri,
-    );
-    this.title = title;
-    this.publicationDate = publicationDate;
-    this.documentDate = documentDate;
-  }
-
-  get fullTitle() {
-    return `${this.legislationType?.label ?? ''} ${this.title ?? ''}`;
-  }
-}
-
-interface ArticleArgs {
-  uri: string;
-  number?: number;
-  content: string | null;
-  dateInForce: string | null;
-  dateNoLongerInForce: string | null;
-}
-
-export class Article {
-  uri: string;
-  number?: number;
-  content: string | null;
-  dateInForce: string | null;
-  dateNoLongerInForce: string | null;
-
-  constructor({
-    uri,
-    number,
-    content,
-    dateInForce,
-    dateNoLongerInForce,
-  }: ArticleArgs) {
-    this.uri = uri;
-    this.number = number;
-    this.content = content;
-    this.dateInForce = dateInForce;
-    this.dateNoLongerInForce = dateNoLongerInForce;
-  }
-}
-
-/*
- * flemish codex encodes certain characters as a html character, which breaks our search
- * this is an ugly work around
- */
-function replaceDiacriticsInWord(word: string): string {
-  const characters =
-    'Ë À Ì Â Í Ã Î Ä Ï Ç Ò È Ó É Ô Ê Õ Ö ê Ù ë Ú î Û ï Ü ô Ý õ â û ã ÿ ç'.split(
-      ' ',
-    );
-  for (const char of characters) {
-    word = word.replace(new RegExp(`${char}`, 'g'), `&#${char.charCodeAt(0)};`);
-  }
-  return word;
-}
-
-//Attempt to memoise on the fetching by stringifying the arguments. This could spare a few fetches.
-//If memoising fails, at least a normal fetch is performed.
-
-const fetchDecisionsMemory = new Map<string, DecisionCollection>();
-
-export interface QueryFilter {
-  type: string;
-  documentDateFrom?: Option<string>;
-  documentDateTo?: Option<string>;
-  publicationDateFrom?: Option<string>;
-  publicationDateTo?: Option<string>;
-}
-
-async function fetchDecisions({
-  words,
-  filter,
-  pageNumber = 0,
-  pageSize = 5,
-  config,
-}: {
-  words: string[];
-  filter: QueryFilter;
-  pageNumber: number;
-  pageSize: number;
-  config: CodexQueryConfig;
-}) {
-  /*abortSignal*/
-  //This is silly, but null != undefined, so we have to be careful and include the correct value here
-  //Also, reconstruct the whole filter object to always have the same ordering, hopefully.
-  filter = {
-    type: filter.type,
-    documentDateFrom: filter.documentDateFrom || null,
-    documentDateTo: filter.documentDateTo || null,
-    publicationDateFrom: filter.publicationDateFrom || null,
-    publicationDateTo: filter.publicationDateTo || null,
-  };
-  const stringArguments = JSON.stringify({
-    words,
-    filter,
-    pageNumber,
-    pageSize,
-  });
-  const results = fetchDecisionsMemory.get(stringArguments);
-  if (results) {
-    return results;
-  } else {
-    const newResults = await fetchDecisionsMemo({
-      words,
-      filter,
-      pageNumber,
-      pageSize,
-      config,
-    });
-    fetchDecisionsMemory.set(stringArguments, newResults);
-    return newResults;
-  }
-}
-
-interface DecisionCollection {
-  totalCount: number;
-  decisions: Decision[];
+import {
+  executeCountQuery,
+  executeQuery,
+} from '@lblod/ember-rdfa-editor-lblod-plugins/utils/sparql-helpers';
+import {
+  LegalDocument,
+  LegalDocumentsCollection,
+  LegalDocumentsQueryConfig,
+  LegalDocumentsQueryFilter,
+} from '@lblod/ember-rdfa-editor-lblod-plugins/plugins/citation-plugin/utils/legal-documents';
+import { Binding } from '@lblod/ember-rdfa-editor-lblod-plugins/plugins/citation-plugin/utils/types';
+import { replaceDiacriticsInWord } from '@lblod/ember-rdfa-editor-lblod-plugins/plugins/citation-plugin/utils/utils';
+
+interface VlaamseCodexLegalDocumentBinding {
+  uri: Binding<string>;
+  title: Binding<string>;
+  publicationDate: Binding<string>;
+  documentDate: Binding<string>;
 }
 
-async function fetchDecisionsMemo({
+export async function fetchVlaamseCodexLegalDocuments({
   words,
   filter,
   pageNumber = 0,
@@ -160,11 +30,11 @@ async function fetchDecisionsMemo({
   config,
 }: {
   words: string[];
-  filter: QueryFilter;
-  config: CodexQueryConfig;
+  filter: LegalDocumentsQueryFilter;
+  config: LegalDocumentsQueryConfig;
   pageNumber?: number;
   pageSize?: number;
-}): Promise<DecisionCollection> {
+}): Promise<LegalDocumentsCollection> {
   // TBD/NOTE: in the context of a <http://data.europa.eu/eli/ontology#LegalResource>
   // the eli:cites can have either a <http://xmlns.com/foaf/0.1/Document> or <http://data.europa.eu/eli/ontology#LegalResource>
   // as range (see AP https://data.vlaanderen.be/doc/applicatieprofiel/besluit-publicatie/#Rechtsgrond),
@@ -230,11 +100,11 @@ async function fetchDecisionsMemo({
         ${documentDateFilter}
         ${publicationDateFilter}
       }`,
-    config,
+    ...config,
   });
 
   if (totalCount > 0) {
-    const response = await executeQuery<DecisionBinding>({
+    const response = await executeQuery<VlaamseCodexLegalDocumentBinding>({
       query: `PREFIX eli: <http://data.europa.eu/eli/ontology#>
 
         SELECT DISTINCT ?expressionUri as ?uri ?title ?publicationDate ?documentDate
@@ -256,10 +126,10 @@ async function fetchDecisionsMemo({
           ${documentDateFilter}
           ${publicationDateFilter}
         } ORDER BY ?title LIMIT ${pageSize} OFFSET ${pageNumber * pageSize}`,
-      config,
+      ...config,
     });
 
-    const decisions = response.results.bindings.map((binding) => {
+    const legalDocuments = response.results.bindings.map((binding) => {
       const escapedTitle = escapeValue(binding.title.value);
       const publicationDate = dateValue(
         binding.publicationDate && binding.publicationDate.value,
@@ -267,7 +137,7 @@ async function fetchDecisionsMemo({
       const documentDate = dateValue(
         binding.documentDate && binding.documentDate.value,
       );
-      return new Decision({
+      return new LegalDocument({
         uri: binding.uri.value,
         title: escapedTitle,
         legislationTypeUri: type,
@@ -278,243 +148,12 @@ async function fetchDecisionsMemo({
 
     return {
       totalCount,
-      decisions,
-    };
-  } else {
-    return {
-      totalCount,
-      decisions: [],
-    };
-  }
-}
-
-interface Binding<A> {
-  value: A;
-}
-
-interface DecisionBinding {
-  uri: Binding<string>;
-  title: Binding<string>;
-  publicationDate: Binding<string>;
-  documentDate: Binding<string>;
-}
-
-const fetchArticlesMemory = new Map<string, ArticleCollection>();
-
-async function fetchArticles({
-  legalExpression,
-  pageNumber,
-  pageSize,
-  articleFilter,
-  config,
-}: {
-  legalExpression: string;
-  pageNumber: number;
-  pageSize: number;
-  articleFilter: string;
-  config: CodexQueryConfig;
-}): Promise<ArticleCollection> {
-  //Simpler here, only one way arguments are set up
-  const stringArguments = JSON.stringify({
-    legalExpression,
-    pageNumber,
-    pageSize,
-    articleFilter,
-  });
-  const results = fetchArticlesMemory.get(stringArguments);
-  if (results) {
-    return results;
-  } else {
-    const newResults = await fetchArticlesMemo({
-      legalExpression,
-      pageNumber,
-      pageSize,
-      articleFilter,
-      config,
-    });
-    fetchArticlesMemory.set(stringArguments, newResults);
-    return newResults;
-  }
-}
-
-interface ArticleBinding {
-  count: {
-    value: string;
-  };
-  content?: {
-    value: string;
-  };
-  dateInForce?: {
-    value: string;
-  };
-  dateNoLongerInForce?: {
-    value: string;
-  };
-  article: {
-    value: string;
-  };
-  number?: {
-    value: number;
-  };
-}
-
-interface QueryResponse<B> {
-  results: {
-    bindings: B[];
-  };
-}
-
-interface ArticleCollection {
-  totalCount: number;
-  articles: Article[];
-}
-
-async function fetchArticlesMemo({
-  legalExpression,
-  pageNumber = 0,
-  pageSize = 10,
-  articleFilter,
-  config,
-}: {
-  legalExpression: string;
-  pageNumber: number;
-  pageSize: number;
-  articleFilter: string;
-  config: CodexQueryConfig;
-}): Promise<ArticleCollection> {
-  const numberFilter = articleFilter
-    ? `FILTER( !BOUND(?number) || CONTAINS(?number, "${articleFilter}"))`
-    : '';
-  const totalCount = await executeCountQuery({
-    query: `PREFIX eli: <http://data.europa.eu/eli/ontology#>
-    PREFIX dct: <http://purl.org/dc/terms/>
-
-    SELECT COUNT(DISTINCT(?article)) as ?count
-    WHERE {
-        ?legalResource eli:is_realized_by <${legalExpression}> ;
-                       eli:has_part ?articleResource .
-        ?articleResource eli:is_realized_by ?article ;
-                         dct:type <https://data.vlaanderen.be/id/concept/TypeRechtsbrononderdeel/Artikel>.
-        OPTIONAL {
-           ?article eli:first_date_entry_in_force ?dateInForce .
-           FILTER (?dateInForce <= NOW() )
-        }
-        OPTIONAL { ?article eli:date_no_longer_in_force ?dateNoLongerInForce }
-        FILTER( !BOUND(?dateNoLongerInForce) || ?dateNoLongerInForce > NOW() )
-        OPTIONAL { ?article eli:number ?number . }
-        ${numberFilter}
-    }`,
-    config,
-  });
-
-  if (totalCount > 0) {
-    // ?number has format like "Artikel 12." We parse the number from the string for ordering
-    // Second degree ordering on ?numberStr to make sure "Artikel 3/1." comes after "Artikel 3."
-    const response = await executeQuery<ArticleBinding>({
-      query: `PREFIX eli: <http://data.europa.eu/eli/ontology#>
-      PREFIX prov: <http://www.w3.org/ns/prov#>
-      PREFIX dct: <http://purl.org/dc/terms/>
-
-      SELECT DISTINCT ?article ?dateInForce ?dateNoLongerInForce ?number ?content WHERE {
-          ?legalResource eli:is_realized_by <${legalExpression}> ;
-                         eli:has_part ?articleResource .
-          ?articleResource eli:is_realized_by ?article ;
-                           dct:type <https://data.vlaanderen.be/id/concept/TypeRechtsbrononderdeel/Artikel>.
-          OPTIONAL {
-            ?article eli:first_date_entry_in_force ?dateInForce .
-            FILTER (?dateInForce <= NOW() )
-          }
-          OPTIONAL { ?article eli:date_no_longer_in_force ?dateNoLongerInForce }
-          FILTER( !BOUND(?dateNoLongerInForce) || ?dateNoLongerInForce > NOW() )
-          OPTIONAL { ?article prov:value ?content . }
-          OPTIONAL { ?article eli:number ?number . }
-          ${numberFilter}
-          BIND(REPLACE(?number, "Artikel ", "") as ?numberStr)
-          BIND(STRDT(?numberStr, xsd:integer) as ?numberInt)
-      } ORDER BY ?numberInt ?numberStr LIMIT ${pageSize} OFFSET ${
-        pageNumber * pageSize
-      }`,
-      config,
-    });
-
-    const articles = response.results.bindings.map((binding) => {
-      const escapedContent = escapeValue(
-        binding.content && binding.content.value,
-      );
-      const dateInForce = dateValue(
-        binding.dateInForce && binding.dateInForce.value,
-      );
-      const dateNoLongerInForce = dateValue(
-        binding.dateNoLongerInForce && binding.dateNoLongerInForce.value,
-      );
-      return new Article({
-        uri: binding.article.value,
-        number: binding.number && binding.number.value,
-        content: escapedContent,
-        dateInForce,
-        dateNoLongerInForce,
-      });
-    });
-
-    return {
-      totalCount,
-      articles,
+      legalDocuments,
     };
   } else {
     return {
       totalCount,
-      articles: [],
+      legalDocuments: [],
     };
   }
 }
-
-function cleanCaches() {
-  fetchDecisionsMemory.clear();
-  fetchArticlesMemory.clear();
-}
-
-async function executeCountQuery({
-  query,
-  config,
-}: {
-  query: string;
-  config: CodexQueryConfig;
-}) {
-  const response = await executeQuery<{ count: { value: string } }>({
-    query,
-    config,
-  });
-  return optionMapOr(0, parseInt, response.results.bindings[0]?.count.value);
-}
-
-type CodexQueryConfig = { endpoint: string; abortSignal?: AbortSignal };
-
-async function executeQuery<A>({
-  query,
-  config,
-}: {
-  query: string;
-  config: CodexQueryConfig;
-}): Promise<QueryResponse<A>> {
-  const encodedQuery = encodeURIComponent(query.trim());
-
-  const response = await fetch(config.endpoint, {
-    method: 'POST',
-    headers: {
-      Accept: 'application/sparql-results+json',
-      'Content-Type': 'application/x-www-form-urlencoded; charset=UTF-8',
-    },
-    body: `query=${encodedQuery}`,
-    signal: config.abortSignal,
-  });
-
-  if (response.ok) {
-    return response.json() as Promise<QueryResponse<A>>;
-  } else {
-    throw new Error(
-      `Request to Vlaamse Codex was unsuccessful: [${response.status}] ${response.statusText}`,
-    );
-  }
-}
-
-export { fetchDecisions, fetchArticles, cleanCaches };

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

@@ -1,14 +1,13 @@
 import Component from '@glimmer/component';
-import { Article, Decision } from '../../plugins/citation-plugin/utils/vlaamse-codex';
 import { Option } from '@lblod/ember-rdfa-editor-lblod-plugins/utils/option';
-import { CitationDecoration, CitationPlugin } from '@lblod/ember-rdfa-editor-lblod-plugins/plugins/citation-plugin';
+import { CitationDecoration, CitationPlugin, CitationPluginEmberComponentConfig } from '@lblod/ember-rdfa-editor-lblod-plugins/plugins/citation-plugin';
 import { SayController } from '@lblod/ember-rdfa-editor';
+import { Article } from '@lblod/ember-rdfa-editor-lblod-plugins/plugins/citation-plugin/utils/article';
+import { LegalDocument } from '@lblod/ember-rdfa-editor-lblod-plugins/plugins/citation-plugin/utils/legal-documents';
 interface Args {
     controller: SayController;
     plugin: CitationPlugin;
-    config: {
-        endpoint: string;
-    };
+    config: CitationPluginEmberComponentConfig;
 }
 export default class CitationCardComponent extends Component<Args> {
     pageNumber: number;
@@ -18,7 +17,7 @@ export default class CitationCardComponent extends Component<Args> {
     decisions: never[];
     error: unknown;
     showModal: boolean;
-    decision: Decision | null;
+    decision: LegalDocument | null;
     cardText: string | null;
     cardLegislationType: string | null;
     documentLegislationType: Option<string>;
@@ -27,13 +26,11 @@ export default class CitationCardComponent extends Component<Args> {
     get controller(): SayController;
     get showCard(): false | Option<CitationDecoration>;
     get plugin(): CitationPlugin;
-    get config(): {
-        endpoint: string;
-    };
+    get config(): CitationPluginEmberComponentConfig;
     get decorations(): import("prosemirror-view").DecorationSet | undefined;
     get activeDecoration(): Option<CitationDecoration>;
     get searchText(): string;
-    get legislationTypes(): string[];
+    get legislationTypes(): ("Besluit" | "Decreet" | "Koninklijk besluit" | "Wet" | "Ministerieel besluit" | "Besluit van de vlaamse regering" | "Omzendbrief" | "Verdrag" | "Grondwet" | "Grondwetswijziging" | "Samenwerkingsakkoord" | "Wetboek" | "Gecoördineerde wetten" | "Bijzondere wet" | "Genummerd koninklijk besluit" | "Protocol")[];
     get selectedLegislationType(): {
         label: string;
         value: string;
@@ -42,14 +39,14 @@ export default class CitationCardComponent extends Component<Args> {
     get selectedLegislationTypeUri(): string;
     resetToDocumentState(): void;
     onCardTextChange(event: InputEvent): void;
-    resourceSearch: import("ember-concurrency").TaskForAsyncTaskFunction<unknown, () => Promise<Decision[]>>;
+    resourceSearch: import("ember-concurrency").TaskForAsyncTaskFunction<unknown, () => Promise<LegalDocument[]>>;
     decisionResource: import("ember-resources/util/ember-concurrency").TaskInstance<unknown>;
     selectLegislationType(type: string): void;
-    openDecisionDetailModal(decision: Decision): void;
+    openDecisionDetailModal(decision: LegalDocument): void;
     openSearchModal(): Promise<void>;
     closeModal(lastSearchType: string, lastSearchTerm: string): void;
-    insertDecisionCitation(decision: Decision): void;
-    insertArticleCitation(decision: Decision, article: Article): void;
+    insertDecisionCitation(decision: LegalDocument): void;
+    insertArticleCitation(decision: LegalDocument, article: Article): void;
     focus(): void;
     willDestroy(): void;
 }

package/components/citation-plugin/citation-insert.d.ts

@@ -1,7 +1,8 @@
 import Component from '@glimmer/component';
 import { SayController } from '@lblod/ember-rdfa-editor';
-import { Article, Decision } from '@lblod/ember-rdfa-editor-lblod-plugins/plugins/citation-plugin/utils/vlaamse-codex';
 import { CitationPluginEmberComponentConfig } from '@lblod/ember-rdfa-editor-lblod-plugins/plugins/citation-plugin';
+import { Article } from '@lblod/ember-rdfa-editor-lblod-plugins/plugins/citation-plugin/utils/article';
+import { LegalDocument } from '@lblod/ember-rdfa-editor-lblod-plugins/plugins/citation-plugin/utils/legal-documents';
 interface Args {
     controller: SayController;
     config: CitationPluginEmberComponentConfig;
@@ -22,7 +23,7 @@ export default class EditorPluginsCitationInsertComponent extends Component<Args
     get controller(): SayController;
     openModal(): void;
     closeModal(): void;
-    insertDecisionCitation(decision: Decision): void;
-    insertArticleCitation(decision: Decision, article: Article): void;
+    insertDecisionCitation(decision: LegalDocument): void;
+    insertArticleCitation(decision: LegalDocument, article: Article): void;
 }
 export {};

package/components/citation-plugin/citations/decision-detail.d.ts

@@ -1,7 +1,7 @@
 import Component from '@glimmer/component';
-import { Decision } from '../../../plugins/citation-plugin/utils/vlaamse-codex';
+import { LegalDocument } from '@lblod/ember-rdfa-editor-lblod-plugins/plugins/citation-plugin/utils/legal-documents';
 interface Args {
-    decision: Decision;
+    decision: LegalDocument;
     close: () => void;
     config: {
         endpoint: string;
@@ -16,7 +16,7 @@ export default class EditorPluginsCitationsDecisionDetailComponent extends Compo
     articleFilter: string;
     articleFilterAfterTimeout: string;
     updateArticleFilter: import("ember-concurrency").TaskForAsyncTaskFunction<unknown, () => Promise<void>>;
-    resourceSearch: import("ember-concurrency").TaskForAsyncTaskFunction<unknown, () => Promise<import("../../../plugins/citation-plugin/utils/vlaamse-codex").Article[]>>;
+    resourceSearch: import("ember-concurrency").TaskForAsyncTaskFunction<unknown, () => Promise<import("@lblod/ember-rdfa-editor-lblod-plugins/plugins/citation-plugin/utils/article").Article[]>>;
     articleResource: import("ember-resources/util/ember-concurrency").TaskInstance<unknown>;
     close(): Promise<void>;
     previousPage(): void;

package/components/citation-plugin/citations/decision-preview.d.ts

@@ -0,0 +1,10 @@
+import Component from '@glimmer/component';
+import { LegalDocument } from '@lblod/ember-rdfa-editor-lblod-plugins/plugins/citation-plugin/utils/legal-documents';
+interface Args {
+    decision: LegalDocument;
+}
+export default class DecisionPreviewComponent extends Component<Args> {
+    get isBesluit(): boolean;
+    get hasPublicationLink(): unknown;
+}
+export {};