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

package/components/citation-plugin/citations/search-modal.d.ts

@@ -1,16 +1,16 @@
 import Component from '@glimmer/component';
-import { Article, Decision } from '../../../plugins/citation-plugin/utils/vlaamse-codex';
+import { CitationPluginEmberComponentConfig } from '@lblod/ember-rdfa-editor-lblod-plugins/plugins/citation-plugin';
 import IntlService from 'ember-intl/services/intl';
+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 {
-    selectedDecision: Decision;
+    selectedDecision: LegalDocument;
     legislationTypeUri: string;
     text: string;
-    insertDecisionCitation: (decision: Decision) => void;
-    insertArticleCitation: (decision: Decision, article: Article) => void;
+    insertDecisionCitation: (decision: LegalDocument) => void;
+    insertArticleCitation: (decision: LegalDocument, article: Article) => void;
     closeModal: (legislationTypeUri?: string, text?: string) => void;
-    config: {
-        endpoint: string;
-    };
+    config: CitationPluginEmberComponentConfig;
 }
 export default class EditorPluginsCitationsSearchModalComponent extends Component<Args> {
     intl: IntlService;
@@ -19,7 +19,7 @@ export default class EditorPluginsCitationsSearchModalComponent extends Componen
     totalCount: number;
     decisions: never[];
     error: unknown;
-    selectedDecision: Decision | null;
+    selectedDecision: LegalDocument | null;
     documentDateFrom: Date | null;
     documentDateTo: Date | null;
     publicationDateFrom: Date | null;
@@ -42,24 +42,23 @@ export default class EditorPluginsCitationsSearchModalComponent extends Componen
         monthNames: string[];
         monthNamesShort: 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 legislationSelected(): string;
     get text(): string;
-    get config(): {
-        endpoint: string;
-    };
+    get config(): CitationPluginEmberComponentConfig;
     get searchText(): string;
-    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>;
+    get isBesluitType(): boolean;
     setInputSearchText(event: InputEvent): void;
     updateDocumentDateFrom(_isoDate: unknown, date: Date): void;
     updateDocumentDateTo(_isoDate: unknown, date: Date): void;
     updatePublicationDateFrom(_isoDate: unknown, date: Date): void;
     updatePublicationDateTo(_isoDate: unknown, date: Date): void;
-    insertDecisionCitation(decision: Decision): Promise<void>;
-    insertArticleCitation(decision: Decision, article: Article): Promise<void>;
+    insertDecisionCitation(decision: LegalDocument): Promise<void>;
+    insertArticleCitation(decision: LegalDocument, article: Article): Promise<void>;
     closeModal(legislationTypeUri?: string, text?: string): Promise<void>;
-    openDecisionDetail(decision: Decision): void;
+    openDecisionDetail(decision: LegalDocument): void;
     closeDecisionDetail(): void;
     previousPage(): void;
     nextPage(): void;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lblod/ember-rdfa-editor-lblod-plugins",
-  "version": "11.2.0",
+  "version": "11.3.0",
   "description": "Ember addon providing lblod specific plugins for the ember-rdfa-editor",
   "keywords": [
     "ember-addon",
@@ -43,7 +43,7 @@
     "buffer": "^6.0.3",
     "codemirror": "^6.0.1",
     "date-fns": "^2.30.0",
-    "ember-auto-import": "~2.5.0",
+    "ember-auto-import": "~2.6.3",
     "ember-cli-babel": "^7.26.11",
     "ember-cli-htmlbars": "^6.1.1",
     "ember-cli-typescript": "^5.2.1",

package/plugins/citation-plugin/index.d.ts

@@ -1,6 +1,6 @@
 import { Decoration, DecorationSet, EditorState, InlineDecorationSpec, NodeType, ProsePlugin, Schema } from '@lblod/ember-rdfa-editor';
 /**
- * The monster regex that makes the citation plugin trigger.
+ * The monster regex that makes the citation plugin trigger to show `CitationCard`.
  * In restructuring, I've made sure that I didn't abstract away any of the capturing groups,
  * only their content, so you can still see what's going on
  *
@@ -33,6 +33,7 @@ export interface CitationPluginRangeConfig {
 export type CitationPluginConfig = CitationPluginNodeConfig | CitationPluginRangeConfig;
 export type CitationPluginEmberComponentConfig = CitationPluginConfig & {
     endpoint: string;
+    decisionsEndpoint?: string;
 };
 export declare function citationPlugin(config: CitationPluginConfig): CitationPlugin;
 export {};

package/plugins/citation-plugin/utils/article.d.ts

@@ -0,0 +1,29 @@
+import { LegalDocumentsQueryConfig } from '@lblod/ember-rdfa-editor-lblod-plugins/plugins/citation-plugin/utils/legal-documents';
+interface ArticleArgs {
+    uri: string;
+    number?: number;
+    content: string | null;
+    dateInForce: string | null;
+    dateNoLongerInForce: string | null;
+}
+export declare class Article {
+    uri: string;
+    number?: number;
+    content: string | null;
+    dateInForce: string | null;
+    dateNoLongerInForce: string | null;
+    constructor({ uri, number, content, dateInForce, dateNoLongerInForce, }: ArticleArgs);
+}
+export declare const fetchArticlesCache: Map<string, ArticleCollection>;
+declare function fetchArticles({ legalExpression, pageNumber, pageSize, articleFilter, config, }: {
+    legalExpression: string;
+    pageNumber: number;
+    pageSize: number;
+    articleFilter: string;
+    config: LegalDocumentsQueryConfig;
+}): Promise<ArticleCollection>;
+interface ArticleCollection {
+    totalCount: number;
+    articles: Article[];
+}
+export { fetchArticles };

package/plugins/citation-plugin/utils/cache.d.ts

@@ -0,0 +1 @@
+export declare function cleanCaches(): void;

package/plugins/citation-plugin/utils/legal-documents.d.ts

@@ -0,0 +1,48 @@
+import { Option } from '@lblod/ember-rdfa-editor-lblod-plugins/utils/option';
+interface LegalDocumentArgs {
+    uri: string;
+    legislationTypeUri: Option<string>;
+    title: string | null;
+    publicationDate: string | null;
+    documentDate: string | null;
+    meta?: Record<string, unknown> | null;
+}
+export declare class LegalDocument {
+    uri: string;
+    legislationType: {
+        label: string;
+        value: string;
+    } | undefined;
+    title: string | null;
+    publicationDate: string | null;
+    documentDate: string | null;
+    meta: Record<string, unknown> | null;
+    constructor({ uri, legislationTypeUri, title, publicationDate, documentDate, meta, }: LegalDocumentArgs);
+    get fullTitle(): string;
+}
+export declare const isBesluitLegalDocument: (legalDocument: LegalDocument) => boolean;
+export declare const fetchLegalDocumentsCache: Map<string, LegalDocumentsCollection>;
+export interface LegalDocumentsCollection {
+    totalCount: number;
+    legalDocuments: LegalDocument[];
+}
+export interface LegalDocumentsQueryFilter {
+    type: string;
+    documentDateFrom?: Option<string>;
+    documentDateTo?: Option<string>;
+    publicationDateFrom?: Option<string>;
+    publicationDateTo?: Option<string>;
+}
+export type LegalDocumentsQueryConfig = {
+    endpoint: string;
+    decisionsEndpoint?: string;
+    abortSignal?: AbortSignal;
+};
+export declare function fetchLegalDocuments({ words, filter, pageNumber, pageSize, config, }: {
+    words: string[];
+    filter: LegalDocumentsQueryFilter;
+    pageNumber: number;
+    pageSize: number;
+    config: LegalDocumentsQueryConfig;
+}): Promise<LegalDocumentsCollection>;
+export {};

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

@@ -0,0 +1,8 @@
+import { LegalDocumentsQueryConfig, LegalDocumentsQueryFilter, LegalDocumentsCollection } from '@lblod/ember-rdfa-editor-lblod-plugins/plugins/citation-plugin/utils/legal-documents';
+export declare function fetchPublicDecisions({ words, filter, pageNumber, pageSize, config, }: {
+    words: string[];
+    config: LegalDocumentsQueryConfig;
+    filter: LegalDocumentsQueryFilter;
+    pageNumber?: number;
+    pageSize?: number;
+}): Promise<LegalDocumentsCollection>;

package/plugins/citation-plugin/utils/types.d.ts

@@ -0,0 +1,28 @@
+export declare const LEGISLATION_TYPES: {
+    decreet: string;
+    'koninklijk besluit': string;
+    wet: string;
+    'ministerieel besluit': string;
+    'besluit van de vlaamse regering': string;
+    omzendbrief: string;
+    verdrag: string;
+    grondwet: string;
+    grondwetswijziging: string;
+    samenwerkingsakkoord: string;
+    wetboek: string;
+    'geco\u00F6rdineerde wetten': string;
+    'bijzondere wet': string;
+    'genummerd koninklijk besluit': string;
+    protocol: string;
+    besluit: string;
+};
+export declare const legislationKeysCapitalized: ["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"];
+export declare const isLegislationType: (type: string) => type is "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";
+export declare const isBesluitType: (type: string) => boolean;
+export declare const LEGISLATION_TYPE_CONCEPTS: {
+    label: string;
+    value: string;
+}[];
+export interface Binding<A> {
+    value: A;
+}

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

@@ -0,0 +1 @@
+export declare function replaceDiacriticsInWord(word: string): string;

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

@@ -1,70 +1,8 @@
-import { Option } from '@lblod/ember-rdfa-editor-lblod-plugins/utils/option';
-interface DecisionArgs {
-    uri: string;
-    legislationTypeUri: Option<string>;
-    title: string | null;
-    publicationDate: string | null;
-    documentDate: string | null;
-}
-export declare 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);
-    get fullTitle(): string;
-}
-interface ArticleArgs {
-    uri: string;
-    number?: number;
-    content: string | null;
-    dateInForce: string | null;
-    dateNoLongerInForce: string | null;
-}
-export declare class Article {
-    uri: string;
-    number?: number;
-    content: string | null;
-    dateInForce: string | null;
-    dateNoLongerInForce: string | null;
-    constructor({ uri, number, content, dateInForce, dateNoLongerInForce, }: ArticleArgs);
-}
-export interface QueryFilter {
-    type: string;
-    documentDateFrom?: Option<string>;
-    documentDateTo?: Option<string>;
-    publicationDateFrom?: Option<string>;
-    publicationDateTo?: Option<string>;
-}
-declare function fetchDecisions({ words, filter, pageNumber, pageSize, config, }: {
+import { LegalDocumentsCollection, LegalDocumentsQueryConfig, LegalDocumentsQueryFilter } from '@lblod/ember-rdfa-editor-lblod-plugins/plugins/citation-plugin/utils/legal-documents';
+export declare function fetchVlaamseCodexLegalDocuments({ words, filter, pageNumber, pageSize, config, }: {
     words: string[];
-    filter: QueryFilter;
-    pageNumber: number;
-    pageSize: number;
-    config: CodexQueryConfig;
-}): Promise<DecisionCollection>;
-interface DecisionCollection {
-    totalCount: number;
-    decisions: Decision[];
-}
-declare function fetchArticles({ legalExpression, pageNumber, pageSize, articleFilter, config, }: {
-    legalExpression: string;
-    pageNumber: number;
-    pageSize: number;
-    articleFilter: string;
-    config: CodexQueryConfig;
-}): Promise<ArticleCollection>;
-interface ArticleCollection {
-    totalCount: number;
-    articles: Article[];
-}
-declare function cleanCaches(): void;
-type CodexQueryConfig = {
-    endpoint: string;
-    abortSignal?: AbortSignal;
-};
-export { fetchDecisions, fetchArticles, cleanCaches };
+    filter: LegalDocumentsQueryFilter;
+    config: LegalDocumentsQueryConfig;
+    pageNumber?: number;
+    pageSize?: number;
+}): Promise<LegalDocumentsCollection>;

package/translations/en-US.yaml

@@ -94,6 +94,10 @@ citaten-plugin:
     refer-whole: Refer to whole document
     refer-article: Refer to this article
     lookup-codex: Lookup in Flemish Codex
+    lookup-publicatie: Lookup in Publicatie
+    lookup-publicatie-short: Publicatie
+    publicatie-non-available: Full content not public
+    publicatie-non-available-short: Not public
   alert:
     loading: Loading…
     no-results: No results found
@@ -359,4 +363,3 @@ editor-plugins:
         contact: In case of persisting issues, contact <a href="mailto:{email}">{email}</a>.
     nodeview:
       placeholder: Insert address
-    

package/translations/nl-BE.yaml

@@ -95,6 +95,10 @@ citaten-plugin:
     refer-whole: Verwijs naar volledig document
     refer-article: Verwijs naar artikel
     lookup-codex: Bekijk in Vlaamse Codex
+    lookup-publicatie: Bekijk in Publicatie
+    lookup-publicatie-short: Publicatie
+    publicatie-non-available: Volledige inhoud niet publiek
+    publicatie-non-available-short: Niet publiek
   alert:
     loading: Laden…
     no-results: Geen resultaten gevonden

package/plugins/citation-plugin/utils/legislation-types.d.ts

@@ -1,24 +0,0 @@
-declare const LEGISLATION_TYPES: {
-    decreet: string;
-    'koninklijk besluit': string;
-    wet: string;
-    'ministerieel besluit': string;
-    'besluit van de vlaamse regering': string;
-    omzendbrief: string;
-    verdrag: string;
-    grondwet: string;
-    grondwetswijziging: string;
-    samenwerkingsakkoord: string;
-    wetboek: string;
-    'geco\u00F6rdineerde wetten': string;
-    'bijzondere wet': string;
-    'genummerd koninklijk besluit': string;
-    protocol: string;
-};
-export type Legislations = typeof LEGISLATION_TYPES;
-export type LegislationKey = keyof Legislations;
-declare const LEGISLATION_TYPE_CONCEPTS: {
-    label: string;
-    value: string;
-}[];
-export { LEGISLATION_TYPES, LEGISLATION_TYPE_CONCEPTS };