@lblod/ember-rdfa-editor-lblod-plugins 33.4.0 → 34.0.1

package/addon/plugins/variable-plugin/variables/legacy-codelist.ts

@@ -0,0 +1,261 @@
+import {
+  getOutgoingTriple,
+  hasOutgoingNamedNodeTriple,
+  hasRDFaAttribute,
+} from '@lblod/ember-rdfa-editor-lblod-plugins/utils/namespace';
+import {
+  DCT,
+  EXT,
+  MOBILITEIT,
+  RDF,
+  VARIABLES,
+  XSD,
+} from '@lblod/ember-rdfa-editor-lblod-plugins/utils/constants';
+import {
+  createEmberNodeSpec,
+  createEmberNodeView,
+  EmberNodeConfig,
+} from '@lblod/ember-rdfa-editor/utils/ember-node';
+import {
+  DOMOutputSpec,
+  PNode,
+  getRdfaAttrs,
+  rdfaAttrSpec,
+} from '@lblod/ember-rdfa-editor';
+import {
+  hasRdfaVariableType,
+  isVariable,
+  parseLabel,
+  parseVariableInstance,
+  parseVariableSource,
+  parseVariableType,
+} from '@lblod/ember-rdfa-editor-lblod-plugins/utils/variable-attribute-parsers';
+import VariableNodeViewComponent from '@lblod/ember-rdfa-editor-lblod-plugins/components/variable-plugin/variable/nodeview';
+import type { ComponentLike } from '@glint/template';
+import { renderRdfaAware } from '@lblod/ember-rdfa-editor/core/schema';
+import { recreateVariableUris } from '../utils/recreate-variable-uris';
+import { generateVariableInstanceUri } from '../utils/variable-helpers';
+import getClassnamesFromNode from '@lblod/ember-rdfa-editor/utils/get-classnames-from-node';
+import { createLegacyCodelistVariableAttrs } from '../actions/create-legacy-codelist-variable';
+
+const CONTENT_SELECTOR = '[data-content-container="true"]';
+
+const CONTENT_SELECTOR_LEGACY = `span[property~='${EXT('content').prefixed}'],
+                          span[property~='${EXT('content').full}']`;
+const rdfaAware = true;
+
+const parseDOM = [
+  {
+    tag: 'span',
+    getAttrs: (node: HTMLElement) => {
+      const attrs = getRdfaAttrs(node, { rdfaAware });
+      if (!attrs) {
+        return false;
+      }
+      if (
+        node.dataset.sayVariable &&
+        (node.dataset.sayVariableType === 'codelist' ||
+          node.dataset.sayVariableType === 'legacy_codelist') &&
+        (!node.dataset.sayNodeVersion || node.dataset.sayNodeVersion === '1') &&
+        node.querySelector(CONTENT_SELECTOR)
+      ) {
+        const label = node.dataset.label;
+        const source = node.dataset.source;
+        const codelist = node.dataset.codelist;
+        const selectionStyle = node.dataset.selectionStyle;
+        return { ...attrs, label, source, codelist, selectionStyle };
+      }
+      return false;
+    },
+    contentElement: CONTENT_SELECTOR,
+  },
+];
+
+const parseDOMLegacy = [
+  {
+    tag: 'span',
+    getAttrs: (node: HTMLElement) => {
+      const attrs = getRdfaAttrs(node, { rdfaAware });
+      if (!attrs || attrs.rdfaNodeType !== 'resource') {
+        return false;
+      }
+
+      if (
+        hasOutgoingNamedNodeTriple(
+          attrs,
+          RDF('type'),
+          VARIABLES('VariableInstance'),
+        ) &&
+        node.querySelector(CONTENT_SELECTOR) &&
+        hasRdfaVariableType(attrs, 'codelist')
+      ) {
+        const variableInstanceUri = attrs.subject;
+        const variableUri = getOutgoingTriple(attrs, VARIABLES('instanceOf'))
+          ?.object.value;
+        if (!variableInstanceUri || !variableUri) {
+          return false;
+        }
+
+        const codelistUri = getOutgoingTriple(attrs, MOBILITEIT('codelijst'))
+          ?.object.value;
+        const sourceUri = getOutgoingTriple(attrs, DCT('source'))?.object.value;
+        const selectionStyle = node.dataset.selectionStyle;
+        const label = getOutgoingTriple(attrs, DCT('title'))?.object.value;
+
+        return createLegacyCodelistVariableAttrs({
+          variable: variableUri,
+          variableInstance: variableInstanceUri,
+          label,
+          // These attrs are required but it's possible for older documents to get into a broken
+          // state. We mark these as unknown so we can push the user to fix this as we can't do it.
+          source: sourceUri,
+          codelist: codelistUri,
+          selectionStyle,
+        });
+      }
+      return false;
+    },
+    contentElement: CONTENT_SELECTOR,
+  },
+  {
+    tag: 'span',
+    getAttrs(node: HTMLElement) {
+      const attrs = getRdfaAttrs(node, { rdfaAware });
+      if (!attrs || attrs.rdfaNodeType !== 'resource') {
+        return false;
+      }
+
+      if (
+        hasOutgoingNamedNodeTriple(attrs, RDF('type'), EXT('Mapping')) &&
+        node.querySelector(CONTENT_SELECTOR) &&
+        hasRdfaVariableType(attrs, 'codelist')
+      ) {
+        const variableUri = attrs.subject;
+        const variableInstanceUri =
+          getOutgoingTriple(attrs, EXT('instance'))?.object.value ??
+          generateVariableInstanceUri();
+
+        const codelistUri = getOutgoingTriple(attrs, EXT('codelist'))?.object
+          .value;
+        const sourceUri = getOutgoingTriple(attrs, DCT('source'))?.object.value;
+        const selectionStyle = node.dataset.selectionStyle;
+        const label = getOutgoingTriple(attrs, EXT('label'))?.object.value;
+        return createLegacyCodelistVariableAttrs({
+          variable: variableUri,
+          variableInstance: variableInstanceUri,
+          label,
+          source: sourceUri,
+          codelist: codelistUri,
+          selectionStyle,
+        });
+      }
+      return false;
+    },
+    contentElement: CONTENT_SELECTOR,
+  },
+  {
+    tag: 'span',
+    getAttrs: (node: HTMLElement) => {
+      if (
+        isVariable(node) &&
+        node.querySelector(CONTENT_SELECTOR_LEGACY) &&
+        parseVariableType(node) === 'codelist'
+      ) {
+        const variableUri = node.getAttribute('resource');
+        if (!variableUri) {
+          return false;
+        }
+        const variableInstanceUri =
+          parseVariableInstance(node) ?? generateVariableInstanceUri();
+
+        const source = parseVariableSource(node) ?? undefined;
+        const selectionStyle = node.dataset.selectionStyle;
+        const codelistSpan = Array.from(node.children).find((el) =>
+          hasRDFaAttribute(el, 'property', EXT('codelist')),
+        );
+        const codelistUri =
+          codelistSpan?.getAttribute('resource') ??
+          codelistSpan?.getAttribute('content') ??
+          undefined;
+        const label = parseLabel(node) ?? undefined;
+
+        return createLegacyCodelistVariableAttrs({
+          variable: variableUri,
+          variableInstance: variableInstanceUri,
+          label,
+          source,
+          codelist: codelistUri,
+          selectionStyle,
+        });
+      }
+
+      return false;
+    },
+    contentElement: CONTENT_SELECTOR_LEGACY,
+  },
+];
+
+const toDOM = (node: PNode): DOMOutputSpec => {
+  const { selectionStyle, label, codelist, source } = node.attrs;
+  const onlyContentType =
+    node.content.size === 1 && node.content.firstChild?.type;
+  const className =
+    onlyContentType &&
+    onlyContentType === onlyContentType.schema.nodes['placeholder']
+      ? ' say-variable'
+      : '';
+
+  return renderRdfaAware({
+    renderable: node,
+    attrs: {
+      class: `${getClassnamesFromNode(node)}${className}`,
+      'data-say-variable': 'true',
+      'data-say-variable-type': 'legacy_codelist',
+      'data-say-node-version': '1',
+      'data-selection-style': selectionStyle as string,
+      'data-label': label as string | null,
+      'data-codelist': codelist as string,
+      'data-source': source as string,
+    },
+    tag: 'span',
+    content: 0,
+  });
+};
+
+const emberNodeConfig: EmberNodeConfig = {
+  name: 'legacy_codelist',
+  component: VariableNodeViewComponent as unknown as ComponentLike,
+  inline: true,
+  group: 'inline variable',
+  content: 'inline*',
+  atom: true,
+  editable: true,
+  recreateUriFunction: recreateVariableUris,
+  draggable: false,
+  needsFFKludge: true,
+  selectable: true,
+  attrs: {
+    ...rdfaAttrSpec({ rdfaAware }),
+    label: {
+      default: null,
+    },
+    codelist: {
+      default: 'UNKNOWN',
+    },
+    source: {
+      default: 'UNKNOWN',
+    },
+    selectionStyle: {
+      default: null,
+    },
+    datatype: {
+      default: XSD('string').namedNode,
+    },
+  },
+  classNames: ['say-codelist-variable'],
+  toDOM,
+  parseDOM: [...parseDOM, ...parseDOMLegacy],
+};
+
+export const legacy_codelist = createEmberNodeSpec(emberNodeConfig);
+export const legacyCodelistView = createEmberNodeView(emberNodeConfig);

package/declarations/addon/components/variable-plugin/codelist/edit.d.ts

@@ -13,6 +13,7 @@ type Sig = {
 export default class CodelistEditComponent extends Component<Sig> {
     selectedCodelistOption?: CodeListOption | CodeListOption[];
     get controller(): SayController;
+    get isLegacyCodelist(): boolean;
     get selectedCodelist(): {
         node: import("prosemirror-model").Node;
         pos: number;
@@ -21,6 +22,7 @@ export default class CodelistEditComponent extends Component<Sig> {
     get codelistUri(): string | undefined;
     get showCard(): boolean;
     get label(): string | undefined;
+    get schema(): import("prosemirror-model").Schema<any, any>;
     codelistOptions: import("reactiveweb/function").State<Promise<CodeListOptions | undefined>>;
     get multiSelect(): boolean;
     insert(): void;

package/declarations/addon/components/variable-plugin/codelist/insert.d.ts

@@ -13,25 +13,31 @@ type Args = {
 };
 interface SelectStyle {
     label: string;
-    value: string;
+    value: 'single' | 'multi';
 }
 export default class CodelistInsertComponent extends Component<Args> {
     intl: IntlService;
     selectedCodelist?: CodeList;
-    label?: string;
-    selectedStyleValue: string;
+    label: string;
+    selectedStyleValue: 'single' | 'multi';
     get controller(): SayController;
     get documentLanguage(): string;
     get schema(): import("prosemirror-model").Schema<any, any>;
     get publisher(): string | undefined;
     get endpoint(): string;
-    get selectionStyles(): {
-        label: string;
-        value: string;
-    }[];
+    get selectionStyles(): ({
+        readonly label: string;
+        readonly value: "single";
+    } | {
+        readonly label: string;
+        readonly value: "multi";
+    })[];
     get selectedStyle(): {
-        label: string;
-        value: string;
+        readonly label: string;
+        readonly value: "single";
+    } | {
+        readonly label: string;
+        readonly value: "multi";
     } | undefined;
     codelistData: import("reactiveweb/function").State<Promise<CodeList[]>>;
     updateLabel(event: InputEvent): void;

package/declarations/addon/components/variable-plugin/codelist/nodeview.d.ts

@@ -0,0 +1,18 @@
+import Component from '@glimmer/component';
+import { DecorationSource, PNode, SayController, SayView } from '@lblod/ember-rdfa-editor';
+type Args = {
+    getPos: () => number | undefined;
+    node: PNode;
+    selectNode: () => void;
+    updateAttribute: (attr: string, value: unknown) => void;
+    controller: SayController;
+    view: SayView;
+    selected: boolean;
+    contentDecorations?: DecorationSource;
+};
+export default class CodelistNodeviewComponent extends Component<Args> {
+    get filled(): boolean;
+    get humanReadableCodelistOption(): any;
+    get class(): string;
+}
+export {};

package/declarations/addon/plugins/roadsign-regulation-plugin/queries/variable.d.ts

@@ -7,38 +7,38 @@ type QueryOptions = {
 export declare function queryVariables(endpoint: string, options?: QueryOptions): Promise<({
     type: "text";
     label: string;
+    source: string;
     uri: string;
-    source?: string | undefined;
     defaultValue?: string | undefined;
 } | {
     type: "number";
     label: string;
+    source: string;
     uri: string;
-    source?: string | undefined;
     defaultValue?: number | undefined;
 } | {
     type: "date";
     label: string;
+    source: string;
     uri: string;
-    source?: string | undefined;
     defaultValue?: Date | undefined;
 } | {
     type: "codelist";
     label: string;
+    source: string;
     uri: string;
     codelistUri: string;
-    source?: string | undefined;
     defaultValue?: string | undefined;
 } | {
     type: "location";
     label: string;
+    source: string;
     uri: string;
-    source?: string | undefined;
     defaultValue?: string | undefined;
 } | {
     type: "instruction";
     label: string;
+    source: string;
     uri: string;
-    source?: string | undefined;
 })[]>;
 export {};

package/declarations/addon/plugins/roadsign-regulation-plugin/schemas/variable-instance.d.ts

@@ -7,21 +7,21 @@ export declare const VariableInstanceSchema: z.ZodUnion<[z.ZodObject<z.objectUti
     variable: z.ZodObject<z.objectUtil.extendShape<{
         uri: z.ZodString;
         label: z.ZodString;
-        source: z.ZodOptional<z.ZodString>;
+        source: z.ZodString;
     }, {
         type: z.ZodLiteral<"text">;
         defaultValue: z.ZodOptional<z.ZodString>;
     }>, "strip", z.ZodTypeAny, {
         type: "text";
         label: string;
+        source: string;
         uri: string;
-        source?: string | undefined;
         defaultValue?: string | undefined;
     }, {
         type: "text";
         label: string;
+        source: string;
         uri: string;
-        source?: string | undefined;
         defaultValue?: string | undefined;
     }>;
 }>, "strip", z.ZodTypeAny, {
@@ -29,8 +29,8 @@ export declare const VariableInstanceSchema: z.ZodUnion<[z.ZodObject<z.objectUti
     variable: {
         type: "text";
         label: string;
+        source: string;
         uri: string;
-        source?: string | undefined;
         defaultValue?: string | undefined;
     };
     value?: string | undefined;
@@ -39,8 +39,8 @@ export declare const VariableInstanceSchema: z.ZodUnion<[z.ZodObject<z.objectUti
     variable: {
         type: "text";
         label: string;
+        source: string;
         uri: string;
-        source?: string | undefined;
         defaultValue?: string | undefined;
     };
     value?: string | undefined;
@@ -51,21 +51,21 @@ export declare const VariableInstanceSchema: z.ZodUnion<[z.ZodObject<z.objectUti
     variable: z.ZodObject<z.objectUtil.extendShape<{
         uri: z.ZodString;
         label: z.ZodString;
-        source: z.ZodOptional<z.ZodString>;
+        source: z.ZodString;
     }, {
         type: z.ZodLiteral<"number">;
         defaultValue: z.ZodOptional<z.ZodNumber>;
     }>, "strip", z.ZodTypeAny, {
         type: "number";
         label: string;
+        source: string;
         uri: string;
-        source?: string | undefined;
         defaultValue?: number | undefined;
     }, {
         type: "number";
         label: string;
+        source: string;
         uri: string;
-        source?: string | undefined;
         defaultValue?: number | undefined;
     }>;
 }>, "strip", z.ZodTypeAny, {
@@ -73,8 +73,8 @@ export declare const VariableInstanceSchema: z.ZodUnion<[z.ZodObject<z.objectUti
     variable: {
         type: "number";
         label: string;
+        source: string;
         uri: string;
-        source?: string | undefined;
         defaultValue?: number | undefined;
     };
     value?: number | undefined;
@@ -83,8 +83,8 @@ export declare const VariableInstanceSchema: z.ZodUnion<[z.ZodObject<z.objectUti
     variable: {
         type: "number";
         label: string;
+        source: string;
         uri: string;
-        source?: string | undefined;
         defaultValue?: number | undefined;
     };
     value?: number | undefined;
@@ -95,21 +95,21 @@ export declare const VariableInstanceSchema: z.ZodUnion<[z.ZodObject<z.objectUti
     variable: z.ZodObject<z.objectUtil.extendShape<{
         uri: z.ZodString;
         label: z.ZodString;
-        source: z.ZodOptional<z.ZodString>;
+        source: z.ZodString;
     }, {
         type: z.ZodLiteral<"date">;
         defaultValue: z.ZodOptional<z.ZodDate>;
     }>, "strip", z.ZodTypeAny, {
         type: "date";
         label: string;
+        source: string;
         uri: string;
-        source?: string | undefined;
         defaultValue?: Date | undefined;
     }, {
         type: "date";
         label: string;
+        source: string;
         uri: string;
-        source?: string | undefined;
         defaultValue?: Date | undefined;
     }>;
 }>, "strip", z.ZodTypeAny, {
@@ -117,8 +117,8 @@ export declare const VariableInstanceSchema: z.ZodUnion<[z.ZodObject<z.objectUti
     variable: {
         type: "date";
         label: string;
+        source: string;
         uri: string;
-        source?: string | undefined;
         defaultValue?: Date | undefined;
     };
     value?: Date | undefined;
@@ -127,8 +127,8 @@ export declare const VariableInstanceSchema: z.ZodUnion<[z.ZodObject<z.objectUti
     variable: {
         type: "date";
         label: string;
+        source: string;
         uri: string;
-        source?: string | undefined;
         defaultValue?: Date | undefined;
     };
     value?: Date | undefined;
@@ -139,21 +139,21 @@ export declare const VariableInstanceSchema: z.ZodUnion<[z.ZodObject<z.objectUti
     variable: z.ZodObject<z.objectUtil.extendShape<{
         uri: z.ZodString;
         label: z.ZodString;
-        source: z.ZodOptional<z.ZodString>;
+        source: z.ZodString;
     }, {
         type: z.ZodLiteral<"location">;
         defaultValue: z.ZodOptional<z.ZodString>;
     }>, "strip", z.ZodTypeAny, {
         type: "location";
         label: string;
+        source: string;
         uri: string;
-        source?: string | undefined;
         defaultValue?: string | undefined;
     }, {
         type: "location";
         label: string;
+        source: string;
         uri: string;
-        source?: string | undefined;
         defaultValue?: string | undefined;
     }>;
 }>, "strip", z.ZodTypeAny, {
@@ -161,8 +161,8 @@ export declare const VariableInstanceSchema: z.ZodUnion<[z.ZodObject<z.objectUti
     variable: {
         type: "location";
         label: string;
+        source: string;
         uri: string;
-        source?: string | undefined;
         defaultValue?: string | undefined;
     };
     value?: string | undefined;
@@ -171,8 +171,8 @@ export declare const VariableInstanceSchema: z.ZodUnion<[z.ZodObject<z.objectUti
     variable: {
         type: "location";
         label: string;
+        source: string;
         uri: string;
-        source?: string | undefined;
         defaultValue?: string | undefined;
     };
     value?: string | undefined;
@@ -183,7 +183,7 @@ export declare const VariableInstanceSchema: z.ZodUnion<[z.ZodObject<z.objectUti
     variable: z.ZodObject<z.objectUtil.extendShape<{
         uri: z.ZodString;
         label: z.ZodString;
-        source: z.ZodOptional<z.ZodString>;
+        source: z.ZodString;
     }, {
         type: z.ZodLiteral<"codelist">;
         defaultValue: z.ZodOptional<z.ZodString>;
@@ -191,16 +191,16 @@ export declare const VariableInstanceSchema: z.ZodUnion<[z.ZodObject<z.objectUti
     }>, "strip", z.ZodTypeAny, {
         type: "codelist";
         label: string;
+        source: string;
         uri: string;
         codelistUri: string;
-        source?: string | undefined;
         defaultValue?: string | undefined;
     }, {
         type: "codelist";
         label: string;
+        source: string;
         uri: string;
         codelistUri: string;
-        source?: string | undefined;
         defaultValue?: string | undefined;
     }>;
 }>, "strip", z.ZodTypeAny, {
@@ -208,9 +208,9 @@ export declare const VariableInstanceSchema: z.ZodUnion<[z.ZodObject<z.objectUti
     variable: {
         type: "codelist";
         label: string;
+        source: string;
         uri: string;
         codelistUri: string;
-        source?: string | undefined;
         defaultValue?: string | undefined;
     };
     value?: string | undefined;
@@ -219,9 +219,9 @@ export declare const VariableInstanceSchema: z.ZodUnion<[z.ZodObject<z.objectUti
     variable: {
         type: "codelist";
         label: string;
+        source: string;
         uri: string;
         codelistUri: string;
-        source?: string | undefined;
         defaultValue?: string | undefined;
     };
     value?: string | undefined;