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

package/plugins/template-variable-plugin/utils/fetch-data.d.ts

@@ -0,0 +1,9 @@
+export type CodeListOptions = {
+    type: string;
+    options: CodeListOption[];
+};
+export type CodeListOption = {
+    value?: string;
+    label?: string;
+};
+export declare function fetchCodeListOptions(endpoint: string, codelistUri: string): Promise<CodeListOptions>;

package/services/import-rdfa-snippet.d.ts

@@ -0,0 +1,99 @@
+import Service from '@ember/service';
+import ContextScanner from '@lblod/marawa/rdfa-context-scanner';
+import RdfaBlock from '@lblod/marawa/rdfa-block';
+type RequestParams = {
+    source: string;
+    uri?: string;
+    omitCredentials: boolean | string;
+    mock: boolean | string;
+};
+export declare class RdfaSnippet {
+    readonly source: string;
+    readonly type: string;
+    readonly content: string;
+    readonly blocks: RdfaBlock[];
+    constructor(source: string, type: string, content: string, blocks: RdfaBlock[]);
+}
+type Error = {
+    source: string;
+    details: string;
+};
+/**
+ * Service responsible for fetching and storing a snippet
+ *
+ * Assumptions
+ * -----------
+ *  - one toplevel rdfa block per snippet
+ *
+ * @module editor-import-snippet-plugin
+ * @class ImportRdfaSnippet
+ * @constructor
+ * @extends EmberService
+ */
+export default class ImportRdfaSnippet extends Service {
+    errors: Error[];
+    snippets: RdfaSnippet[];
+    contextScanner: ContextScanner;
+    constructor();
+    /**
+     * Download, processes and stores snippet
+     * @method downloadSnippet
+     * @param {Object}: {source}
+     * @return {String}
+     * @public
+     */
+    downloadSnippet(params: RequestParams): Promise<void>;
+    /**
+     * Remove a snippet from the store, typically after using it
+     * @method removeSnippet
+     * @return void
+     * @public
+     */
+    removeSnippet(snippet: RdfaSnippet): void;
+    /**
+     * Return snippets for a given type, current supported types are 'roadsign' and 'generic'
+     * @method snippetsForType
+     * @params {String} type
+     * @return {Array} array of RdfaSnippets
+     */
+    snippetsForType(type: string): RdfaSnippet[];
+    /**
+     * Fetches snippet from remote
+     * @method processSnippet
+     * @param params.omitCredentials {String} if truthy, the fetch call will omit credentials (this is important for endpoints that only provide simple CORS headers). When not set or falsy we fetch with "include" credentials. This means the endpoint needs to provide the Access-Control-Allow-Credentials and Access-Controlled-Allow-Origin needs to be set to the requesting domain ('*' is not allowed)
+     * @param params.source {String} the URL of the document to fetch
+     * @result {Response} result from ember fetch call
+     * @private
+     */
+    getSnippet(params: RequestParams): Promise<Response | null>;
+    /**
+     * heuristic to determine the type of snippet
+     * currently just a very basic check if a type exists in the snippet.
+     * @method determineType
+     */
+    determineType(rdfaBlocks: RdfaBlock[]): string;
+    /**
+     * Processes and stores snippet
+     * @method processSnippet
+     * @private
+     */
+    processSnippet(params: RequestParams, data: Response): Promise<void>;
+    /**
+     * Make HTML Content Template from string
+     * @method htmlToElement
+     * @param {String}
+     * @return {Object}
+     * @private
+     */
+    htmlToElements(html: string): Element[];
+    /**
+     * Stores snippet
+     * @method storeSnippet
+     * @param {String} source the source url of the snippet
+     * @param {String} content the unparsed text content of the snippet
+     * @param {Array} block array of richnodes representing the content of the snippet
+     * @private
+     */
+    storeSnippet(source: string, type: string, content: string, blocks: RdfaBlock[]): void;
+}
+export {};

package/services/roadsign-registry.d.ts

@@ -0,0 +1,42 @@
+import Service from '@ember/service';
+import Instruction from '../models/instruction';
+import Measure from '../models/measure';
+import Sign from '../models/sign';
+import { IBindings } from 'fetch-sparql-endpoint';
+export default class RoadsignRegistryService extends Service {
+    classifications: {
+        value: string;
+        label: string;
+    }[];
+    instructions: Map<string, Instruction[]>;
+    endpoint: string;
+    imageBaseUrl: string;
+    constructor();
+    loadClassifications: import("ember-concurrency").TaskForAsyncTaskFunction<unknown, () => Promise<void>>;
+    getInstructionsForMeasure: import("ember-concurrency").TaskForAsyncTaskFunction<unknown, (uri: string) => Promise<Instruction[]>>;
+    searchCode: import("ember-concurrency").TaskForAsyncTaskFunction<{
+        restartable: boolean;
+    }, (codeString?: string, category?: string, type?: string, combinedSigns?: string[]) => Promise<{
+        value: string;
+        label: string;
+    }[]>>;
+    executeQuery: import("ember-concurrency").TaskForAsyncTaskFunction<unknown, (query: string) => Promise<{
+        results: {
+            bindings: IBindings[];
+        };
+    }>>;
+    fetchInstructionsForMeasure: import("ember-concurrency").TaskForAsyncTaskFunction<unknown, (uri: string) => Promise<Instruction[]>>;
+    fetchMeasures: import("ember-concurrency").TaskForAsyncTaskFunction<{
+        restartable: boolean;
+    }, ({ zonality, type, codes, category, pageStart, }?: {
+        zonality?: string | undefined;
+        type?: string | undefined;
+        codes?: string[] | undefined;
+        category?: string | undefined;
+        pageStart?: number | undefined;
+    }) => Promise<{
+        measures: Measure[];
+        count: number;
+    }>>;
+    fetchSignsForMeasure: import("ember-concurrency").TaskForAsyncTaskFunction<unknown, (uri: string) => Promise<Sign[]>>;
+}

package/services/standard-template-plugin.d.ts

@@ -0,0 +1,21 @@
+import Store from '@ember-data/store';
+import { DS } from 'ember-data';
+import Service from '@ember/service';
+import { Task } from 'ember-concurrency';
+import TemplateModel from '../models/template';
+export default class StandardTemplatePluginService extends Service {
+    store: Store;
+    templates: DS.RecordArray<TemplateModel>;
+    constructor();
+    fetchTemplates: Task<DS.RecordArray<TemplateModel>, []>;
+    loadTemplates(): Promise<void>;
+    /**
+       Filter the valid templates for a context.
+       @method templatesForContext
+       @param {Array} Array of templates
+       @param {Array} The path of rdfaContext objects from the root till the current context
+       @return {Array} Array of templates (filtered)
+       @private
+    */
+    templatesForContext(templates: TemplateModel[], rdfaTypes: string[]): TemplateModel[];
+}

package/translations/en-US.yaml

@@ -56,6 +56,16 @@ besluit-type-plugin:
   error-title: "Error"
   error-first-body: "An error occured while fetching the decision types. Try again later. If this problem persists, please contact"
   error-rest-body: ". For more specific details about this problem, inspect the browser console."
+besluit-plugin:
+  card:
+    title: Edit decision
+  insert:
+    article: Insert article
+    decision-title: Insert decision title
+  action:
+    delete-article: Delete article
+    article-up: Move article up
+    article-down: Move article down
 date-plugin:
   insert:
     date: "Insert date"
@@ -70,4 +80,57 @@ date-plugin:
     now: "Now"
 insert-variable-plugin:
   variable: Insert variable
-  button: Insert
+  button: Insert
+article-structure-plugin:
+  insert:
+    paragraph: Insert paragraph
+    article: Insert article
+    articleBelow: Insert article below
+    title: Insert title
+    chapter: Insert chapter
+    section: Insert section
+    subsection: Insert subsection
+  moveUp:
+    paragraph: Move paragraph up
+    article: Move article up
+    title: Move title up
+    chapter: Move chapter up
+    section: Move section up
+    subsection: Move subsection up
+  moveDown:
+    paragraph: Move paragraph down
+    article: Move article down
+    title: Move title down
+    chapter: Move chapter down
+    section: Move section down
+    subsection: Move subsection down
+  title:
+    paragraphCard: Paragraph Card
+    articleCard: Article Card
+    structureCard: Structure Card
+  remove:
+    article: Remove Article
+    paragraph: Remove Paragraph
+    subsection: Remove subsection
+    section: Remove section
+    chapter: Remove chapter
+    title: Remove title
+    content: Remove content
+  placeholder:
+    generic:
+      heading: Insert title
+      body: Insert content
+    chapter:
+      heading: Insert chapter heading
+      body: Insert chapter content
+    section:
+      heading: Insert section heading
+      body: Insert section content
+    subsection: 
+      heading: Insert subsection heading
+      body: Insert subsection content
+    article:
+      heading: Insert article heading
+      body: Insert article content
+    paragraph:
+      body: Insert paragraph content

package/translations/nl-BE.yaml

@@ -20,7 +20,7 @@ citaten-plugin:
     from: van
     to: tot
     article: Zoek artikel
-    article-placeholder: Artikel nummer  
+    article-placeholder: Artikel nummer
     back: Terug naar zoekresultaten
     results: Resultaten
 
@@ -41,7 +41,7 @@ citaten-plugin:
     no-results: Geen resultaten gevonden
     error-title: Probleem bij het laden
     error-intro: "Er heeft zich een fout voorgedaan bij het zoeken in de Vlaamse Codex:"
-    error-outro: Moest dit probleem aanhouden, neem contact op met 
+    error-outro: Moest dit probleem aanhouden, neem contact op met
 table-of-contents-plugin:
   title: Inhoudstafel
   toggle: Toon Inhoudstafel
@@ -56,6 +56,16 @@ besluit-type-plugin:
   error-title: "Fout"
   error-first-body: "Er was een probleem bij het ophalen van de besluittypes. Probeer later opnieuw. Bij blijvende problemen, contacteer"
   error-rest-body: ". Voor meer specifieke details, controleer de console in de browser."
+besluit-plugin:
+  card:
+    title: Artikels bewerken
+  insert:
+    article: Voeg artikel in
+    decision-title: Voeg besluittitel in
+  action:
+    delete-article: Artikel verwijderen
+    article-up: Artikel naar boven verplaatsen
+    article-down: Artikel naar beneden verplaatsen
 date-plugin:
   insert:
     date: "Datum invoegen"
@@ -71,4 +81,57 @@ date-plugin:
     now: "Nu"
 insert-variable-plugin:
   variable: Voeg variabele in
-  button: Voeg in
+  button: Voeg in
+article-structure-plugin:
+  insert:
+    paragraph: Paragraaf invoegen
+    article: Artikel invoegen
+    articleBelow: Voeg onderstaand artikel in
+    title: Titel invoegen
+    chapter: Hoofdstuk invoegen
+    section: Afdeling invoegen
+    subsection: Onderafdeling invoegen
+  moveUp:
+    paragraph: Paragraaf naar boven verplaatsen
+    article: Artikel naar boven verplaatsen
+    title: Titel naar boven verplaatsen
+    chapter: Hoofdstuk naar boven verplaatsen
+    section: Afdeling naar boven verplaatsen
+    subsection: Onderafdeling naar boven verplaatsen
+  moveDown:
+    paragraph: Paragraaf naar beneden verplaatsen
+    article: Artikel naar beneden verplaatsen
+    title: Titel naar beneden verplaatsen
+    chapter: Hoofdstuk naar beneden verplaatsen
+    section: Afdeling naar beneden verplaatsen
+    subsection: Onderafdeling naar boven verplaatsen
+  title:
+    paragraphCard: Paragraaf card
+    articleCard: Artikel card
+    structureCard: Structuur card
+  remove:
+    article: Artikel verwijderen
+    paragraph: Paragraaf verwijderen
+    subsection: Onderafdeling verwijderen
+    section: Afdeling verwijderen
+    chapter: Hoofdstuk verwijderen
+    title: Titel verwijderen
+    content: Inhoud verwijderen
+  placeholder:
+    generic:
+      heading: Voeg titel in
+      body: Voeg inhoud in
+    chapter:
+      heading: Voeg hoofdstuk in
+      body: Voeg inhoud hoofdstuk in
+    section:
+      heading: Voeg afdeling in
+      body: Voeg inhoud afdeling in
+    subsection: 
+      heading: Voeg onderafdeling in
+      body: Voeg inhoud onderafdeling in
+    article:
+      heading: Voeg artikel in
+      body: Voeg inhoud artikel in
+    paragraph:
+      body: Voeg inhoud paragraaf in

package/tsconfig.json

@@ -1,13 +1,30 @@
 {
-  "extends": "@tsconfig/ember/tsconfig.json",
   "compilerOptions": {
-
-    // The combination of `baseUrl` with `paths` allows Ember's classic package
-    // layout, which is not resolvable with the Node resolution algorithm, to
-    // work with TypeScript.
+    "target": "es2021",
+    "module": "es2020",
     "allowJs": true,
+    "checkJs": false,
+    "moduleResolution": "node",
+    "allowSyntheticDefaultImports": true,
+    "noImplicitAny": true,
+    "noImplicitThis": true,
+    "alwaysStrict": true,
+    "strictNullChecks": true,
+    "strictPropertyInitialization": true,
+    "noFallthroughCasesInSwitch": true,
+    "noUnusedLocals": false,
+    "noUnusedParameters": false,
+    "noImplicitReturns": true,
     "noEmitOnError": false,
+    "noEmit": true,
+    "inlineSourceMap": true,
+    "inlineSources": true,
     "baseUrl": ".",
+    "skipLibCheck": true,
+    "experimentalDecorators": true,
+    "typeRoots": [
+      "./node_modules/@types",
+    ],
     "paths": {
       "dummy/tests/*": [
         "tests/*"
@@ -29,16 +46,24 @@
         "addon-test-support/*"
       ],
       "*": [
-        "types/*"
-      ]
-    }
+        "types/*",
+        "node_modules/@lblod/ember-rdfa-editor/types/*"
+      ],
+      "@lblod/ember-rdfa-editor": [
+        "node_modules/@lblod/ember-rdfa-editor/addon"
+      ],
+      "@lblod/ember-rdfa-editor/*": [
+        "node_modules/@lblod/ember-rdfa-editor/addon/*"
+      ],
+    },
   },
   "include": [
     "app/**/*",
     "addon/**/*",
     "tests/**/*",
     "types/**/*",
+    "node_modules/@lblod/ember-rdfa-editor/types/**/*",
     "test-support/**/*",
-    "addon-test-support/**/*"
+    "addon-test-support/**/*",
   ]
 }

package/types/config/environment.d.ts

@@ -0,0 +1,22 @@
+declare const config: {
+  environment: string;
+  modulePrefix: string;
+  podModulePrefix: string;
+  locationType: 'history' | 'hash' | 'none' | 'auto';
+  rootURL: string;
+  APP: Record<string, unknown>;
+  roadsignRegulationPlugin: {
+    endpoint: string;
+    imageBaseUrl: string;
+  };
+  besluitTypePlugin: {
+    endpoint: string;
+  };
+  templateVariablePlugin: {
+    endpoint: string;
+    zonalLocationCodelistUri: string;
+    nonZonalLocationCodelistUri: string;
+  };
+};
+
+export default config;

package/types/ember-mu-transform-helpers/transforms/string-set.d.ts

@@ -0,0 +1,14 @@
+declare module 'ember-mu-transform-helpers/transforms/string-set' {
+  import Transform from '@ember-data/serializer/transform';
+
+  module 'ember-data/types/registries/transform' {
+    export default interface TransformRegistry {
+      'string-set': StringSetTransform;
+    }
+  }
+  export default class StringSetTransform extends Transform {
+    deserialize(serialized: unknown[]): unknown[];
+
+    serialize(deserialized: unknown[]): unknown[];
+  }
+}

package/types/lblod/frontend-gelinkt-notuleren/models/account.d.ts

@@ -0,0 +1,10 @@
+declare module '@lblod/frontend-gelinkt-notuleren/models/account' {
+  import Model, { AsyncBelongsTo } from '@ember-data/model';
+  import GebruikerModel from '@lblod/frontend-gelinkt-notuleren/models/gebruiker';
+
+  export default class AccountModel extends Model {
+    voId: string;
+    provider: string;
+    gebruiker: AsyncBelongsTo<GebruikerModel>;
+  }
+}

package/types/lblod/frontend-gelinkt-notuleren/models/bestuurseenheid-classificatie-code.d.ts

@@ -0,0 +1,10 @@
+declare module '@lblod/frontend-gelinkt-notuleren/models/bestuurseenheid-classificatie' {
+  import Model from '@ember-data/model';
+  export default class BestuurseenheidClassificatieCodeModel extends Model {
+    label: string;
+    scopeNote: string;
+    uri: string;
+
+    rdfaBindings: Record<string, string>;
+  }
+}

package/types/lblod/frontend-gelinkt-notuleren/models/bestuurseenheid.d.ts

@@ -0,0 +1,12 @@
+declare module '@lblod/frontend-gelinkt-notuleren/models/bestuurseenheid' {
+  import Model, { AsyncBelongsTo } from '@ember-data/model';
+  import BestuurseenheidClassificatieCodeModel from '@lblod/frontend-gelinkt-notuleren/models/bestuurseenheid-classificatie';
+  export default class BestuurseenheidModel extends Model {
+    naam: string;
+    uri: string;
+
+    classificatie: AsyncBelongsTo<BestuurseenheidClassificatieCodeModel>;
+
+    rdfaBindings: Record<string, string>;
+  }
+}

package/types/lblod/frontend-gelinkt-notuleren/models/gebruiker-model.d.ts

@@ -0,0 +1,18 @@
+declare module '@lblod/frontend-gelinkt-notuleren/models/gebruiker' {
+  import Model, { AsyncHasMany } from '@ember-data/model';
+  import AccountModel from '@lblod/frontend-gelinkt-notuleren/models/account';
+  import BestuurseenheidModel from '@lblod/frontend-gelinkt-notuleren/models/bestuurseenheid';
+  export default class GebruikerModel extends Model {
+    voornaam: string;
+    achternaam: string;
+    rijksregisterNummer: string;
+
+    account: AsyncHasMany<AccountModel>;
+
+    bestuurseenheden: AsyncHasMany<BestuurseenheidModel>;
+
+    // this is only used for mock login afaik
+    get group(): BestuurseenheidModel;
+    get fullName(): string;
+  }
+}

package/types/lblod/frontend-gelinkt-notuleren/services/current-session.d.ts

@@ -0,0 +1,30 @@
+declare module '@lblod/frontend-gelinkt-notuleren/services/current-session' {
+  import Service from '@ember/service';
+  // eslint-disable-next-line ember/use-ember-data-rfc-395-imports
+  import DS from 'ember-data';
+  import AccountModel from '@lblod/frontend-gelinkt-notuleren/models/account';
+  import GebruikerModel from '@lblod/frontend-gelinkt-notuleren/models/gebruiker';
+  import BestuurseenheidModel from '@lblod/frontend-gelinkt-notuleren/models/bestuurseenheid';
+
+  export default class CurrentSessionService extends Service {
+    session: Service;
+    store: DS.Store;
+
+    account: AccountModel;
+    user: GebruikerModel;
+    group: BestuurseenheidModel;
+    roles: unknown[];
+
+    get canRead(): boolean;
+
+    get canWrite(): boolean;
+
+    get canPublish(): boolean;
+
+    get canSign(): boolean;
+
+    hasRole(role: unknown): boolean;
+
+    load(): Promise<void>;
+  }
+}

package/types/lblod/marawa/dom-helpers.d.ts

@@ -0,0 +1,4 @@
+declare module '@lblod/marawa/dom-helpers' {
+  export function findFirstNodeOfType(node: Node, type: string): Node | null;
+  export function findAllNodesOfType(node: Node, type: string): Node[];
+}

package/types/lblod/marawa/ember-object-mock.d.ts

@@ -0,0 +1,3 @@
+declare module '@lblod/marawa/ember-object-mock' {
+  export function warn(msg: string): void;
+}

package/types/lblod/marawa/node-walker.d.ts

@@ -0,0 +1,18 @@
+declare module '@lblod/marawa/node-walker' {
+  import RichNode, { RichNodeContent } from '@lblod/marawa/rich-node';
+
+  export function walk(node: Node): RichNode;
+  export default class NodeWalker {
+    processDomNode(domNode: Node, parentNode?: Node, start?: number): RichNode;
+    stepInDomNode(richNode: RichNode, childDomNode: Node): RichNode;
+    stepNextDomNode(richNode: RichNode, nextDomChildren: Node[]): RichNode[];
+    finishChildSteps(richNode: RichNode): void;
+    processTextNode(richNode: RichNode): RichNode;
+    processTagNode(richNode: RichNode): RichNode;
+    processRegularTagNode(richNode: RichNode): RichNode;
+    processVoidTagNode(richNode: RichNode): RichNode;
+    processOtherNode(richNode: RichNode): RichNode;
+    detectDomNodeType(domNode: Node): string;
+    createRichNode(content: RichNodeContent): RichNode;
+  }
+}

package/types/lblod/marawa/range-helpers.d.ts

@@ -0,0 +1,10 @@
+declare module '@lblod/marawa/range-helpers' {
+  type Range = [number, number];
+  export function positionInRange(position: number, range: Range): boolean;
+  export function rangeAStartsOrEndsinB(rangeA: Range, rangeB: Range): boolean;
+  export function isLeftAdjacentRange(rangeA: Range, rangeB: Range): boolean;
+  export function isRightAdjacentRange(rangeA: Range, rangeB: Range): boolean;
+  export function isAdjacentRange(rangeA: Range, rangeB: Range): boolean;
+  export function isEmptyRange(range: Range): boolean;
+  export function isEqualRange(rangeA: Range, rangeB: Range): boolean;
+}

package/types/lblod/marawa/rdfa-attributes.d.ts

@@ -0,0 +1,25 @@
+declare module '@lblod/marawa/rdfa-attributes' {
+  export default class RdfaAttributes {
+    constructor(
+      node: { getAttribute(key: string): string | undefined },
+      knownPrefixes?: unknown,
+      options?: Record<string, unknown>
+    );
+    get vocab(): string;
+    get content(): string;
+    get properties(): string[];
+    get rel(): string[];
+    get typeof(): string[];
+    get rev(): string[];
+    get about(): string;
+    get datatype(): string;
+    get src(): string;
+    get href(): string;
+    get resource(): string;
+    get isEmpty(): boolean;
+    currentPrefixes: Record<string, unknown>;
+  }
+  export function parsePrefixString(prefixString: string): {
+    [key: string]: string;
+  };
+}

package/types/lblod/marawa/rdfa-block.d.ts

@@ -0,0 +1,22 @@
+declare module '@lblod/marawa/rdfa-block' {
+  import Triple from '@lblod/marawa/triple';
+  import RichNode from '@lblod/marawa/rich-node';
+  type Region = [number, number];
+  export default class RdfaBlock {
+    constructor(content: unknown);
+
+    get region(): Region;
+    set region(region: Region);
+
+    get length(): number;
+    get richNode(): RichNode;
+
+    get context(): Triple[];
+
+    isInRegion(region: Region): boolean;
+    isPartiallyInRegion(region: Region): boolean;
+    isPartiallyOrFullyInRegion(region: Region): boolean;
+    containsRegion(region: Region): boolean;
+    normalizeRegion(region: Region): Region;
+  }
+}

package/types/lblod/marawa/rdfa-context-scanner.d.ts

@@ -0,0 +1,13 @@
+declare module '@lblod/marawa/rdfa-context-scanner' {
+  import RdfaBlock from '@lblod/marawa/rdfa-block';
+
+  type Region = [number, number];
+  export default class RdfaContextScanner {
+    analyse(domNode: Node, region?: Region, options?: unknown): RdfaBlock[];
+  }
+  export function analyse(
+    node: Node,
+    region?: Region,
+    options?: unknown
+  ): RdfaBlock[];
+}

package/types/lblod/marawa/rdfa-helpers.d.ts

@@ -0,0 +1,22 @@
+declare module '@lblod/marawa/rdfa-helpers' {
+  import RichNode from '@lblod/marawa/rich-node';
+  import RdfaAttributes from '@lblod/marawa/rdfa-attributes';
+
+  export function enrichWithRdfaProperties(
+    richNode: RichNode,
+    parentContext: RdfaAttributes[],
+    parentPrefixes?: unknown,
+    options?: Record<string, unknown>
+  ): void;
+  export function resolvePrefix(
+    attribute: string,
+    uri: string | string[],
+    prefixes: unknown,
+    documentUri?: string
+  ): string;
+  export function rdfaAttributesToTriples(
+    rdfaAttributes: RdfaAttributes[]
+  ): unknown[];
+  export function isFullUri(uri: string): boolean;
+  export function isPrefixedUri(uri: string): boolean;
+}