Gn 4901 autofill variable

.changeset/mean-deers-call.md

@@ -0,0 +1,5 @@
+---
+'@lblod/ember-rdfa-editor-lblod-plugins': minor
+---
+
+Add autofill variable

addon/components/variable-plugin/autofilled/edit.gts

@@ -0,0 +1,224 @@
+import Component from '@glimmer/component';
+import { action } from '@ember/object';
+import { service } from '@ember/service';
+import { NodeSelection, type SayController } from '@lblod/ember-rdfa-editor';
+import IntlService from 'ember-intl/services/intl';
+import AuFormRow from '@appuniversum/ember-appuniversum/components/au-form-row';
+import AuLabel from '@appuniversum/ember-appuniversum/components/au-label';
+import AuButton from '@appuniversum/ember-appuniversum/components/au-button';
+import AuCheckbox from '@appuniversum/ember-appuniversum/components/au-checkbox';
+import AuNativeInput from '@lblod/ember-rdfa-editor-lblod-plugins/components/au-native-input';
+import AuCard from '@appuniversum/ember-appuniversum/components/au-card';
+import AuHeading from '@appuniversum/ember-appuniversum/components/au-heading';
+import t from 'ember-intl/helpers/t';
+import { on } from '@ember/modifier';
+import { trackedReset } from 'tracked-toolbox';
+import { EXT } from '@lblod/ember-rdfa-editor-lblod-plugins/utils/constants';
+import { sayDataFactory } from '@lblod/ember-rdfa-editor/core/say-data-factory/data-factory';
+import { getOutgoingTriple } from '@lblod/ember-rdfa-editor-lblod-plugins/utils/namespace';
+import LabelInput from '../utils/label-input';
+import {
+  ContentLiteralTerm,
+  SayLiteral,
+  SayNamedNode,
+} from '@lblod/ember-rdfa-editor/core/say-data-factory';
+type Args = {
+  controller: SayController;
+};
+
+type nodeProperty =
+  | {
+      predicate: string;
+      object: SayNamedNode<string>;
+    }
+  | {
+      predicate: string;
+      object: SayLiteral;
+    }
+  | {
+      predicate: string;
+      object: ContentLiteralTerm;
+    };
+
+export default class AutoFilledVariableInsertComponent extends Component<Args> {
+  @service declare intl: IntlService;
+
+  // memo is the path to the trigger, which calls update
+  // see https://github.com/tracked-tools/tracked-toolbox?tab=readme-ov-file#trackedreset
+  // it's sort of badly explained in the docs, but it's a more generic version
+  // of localCopy, which we can't use here cause our derived state from the args
+  // is too complex to express as a string path
+  @trackedReset({
+    memo: 'args.controller.mainEditorState',
+    // using this as the first arg is special typescript syntax
+    // which allows you to explicitly type the this context, cause
+    // ts is not smart enough to know that
+    update(this: AutoFilledVariableInsertComponent) {
+      return this.convertToStringAttr;
+    },
+  })
+  convertToString: boolean = false;
+
+  @trackedReset({
+    memo: 'args.controller.mainEditorState',
+    update(this: AutoFilledVariableInsertComponent) {
+      return this.autofillKeyAttr;
+    },
+  })
+  autofillKey?: string;
+
+  @trackedReset({
+    memo: 'args.controller.mainEditorState',
+    update(this: AutoFilledVariableInsertComponent) {
+      return this.labelAttr;
+    },
+  })
+  label!: string;
+
+  get selectedVariable() {
+    const { selection } = this.controller.mainEditorState;
+    if (
+      selection instanceof NodeSelection &&
+      selection.node.type === this.controller.schema.nodes.autofilled_variable
+    ) {
+      return {
+        node: selection.node,
+        pos: selection.from,
+      };
+    } else {
+      return null;
+    }
+  }
+  get autofillKeyAttr() {
+    return this.selectedVariable?.node.attrs.autofillKey;
+  }
+  get convertToStringAttr() {
+    return this.selectedVariable?.node.attrs.convertToString;
+  }
+  get labelAttr() {
+    if (!this.selectedVariable) return '';
+    return getOutgoingTriple(this.selectedVariable.node.attrs, EXT('label'))
+      ?.object.value;
+  }
+
+  get showCard() {
+    return !!this.selectedVariable;
+  }
+
+  get controller() {
+    return this.args.controller;
+  }
+
+  get schema() {
+    return this.args.controller.schema;
+  }
+
+  get documentLanguage() {
+    return this.controller.documentLanguage;
+  }
+
+  @action
+  updateLabel(event: InputEvent) {
+    this.label = (event.target as HTMLInputElement).value;
+  }
+
+  @action
+  updateAutofillKey(event: InputEvent) {
+    this.autofillKey = (event.target as HTMLInputElement).value;
+  }
+
+  @action
+  updateConvertToString(value: boolean) {
+    this.convertToString = value;
+  }
+
+  @action
+  edit() {
+    if (this.selectedVariable) {
+      this.controller.withTransaction(
+        (tr) => {
+          const position = this.selectedVariable?.pos as number;
+          tr.setNodeAttribute(position, 'autofillKey', this.autofillKey);
+          tr.setNodeAttribute(
+            position,
+            'convertToString',
+            this.convertToString,
+          );
+          const oldProperties = this.selectedVariable?.node.attrs.properties;
+          const newProperties = oldProperties.filter(
+            (property: nodeProperty) =>
+              property.predicate !== EXT('label').full,
+          );
+          newProperties.push({
+            predicate: EXT('label').full,
+            object: sayDataFactory.literal(this.label || ''),
+          });
+          tr.setNodeAttribute(position, 'properties', newProperties);
+          return tr;
+        },
+        // because the variable pill contains a nested editor, when it's
+        // selected, the currentEditorView is the nested one. When you run
+        // withTransaction without the optional second argument, it defaults to using
+        // the current view.
+        //
+        // Here, we don't want that, cause we want to edit the outside node, not
+        // any node in the nested editor.
+        { view: this.controller.mainEditorView },
+      );
+    }
+  }
+  <template>
+    {{#if this.showCard}}
+      <AuCard
+        @flex={{true}}
+        @divided={{true}}
+        @isOpenInitially={{true}}
+        @expandable={{true}}
+        @shadow={{true}}
+        @size='small'
+        as |c|
+      >
+        <c.header>
+          <AuHeading @level='3' @skin='6'>
+            {{t 'variable-plugin.enter-variable-value'}}
+          </AuHeading>
+        </c.header>
+        <c.content>
+          <AuFormRow>
+            <LabelInput
+              @label={{this.label}}
+              @updateLabel={{this.updateLabel}}
+            />
+          </AuFormRow>
+          <AuFormRow>
+            <AuLabel for='autofill_key'>
+              {{t 'variable-plugin.autofill.autofillKey'}}
+            </AuLabel>
+            <AuNativeInput
+              id='autofill_key'
+              placeholder={{t
+                'variable-plugin.autofill.autofillKeyPlaceholder'
+              }}
+              @type='text'
+              @width='block'
+              value={{this.autofillKey}}
+              {{on 'input' this.updateAutofillKey}}
+            />
+          </AuFormRow>
+          <AuFormRow>
+            <AuCheckbox
+              id='convert_to_string'
+              @checked={{this.convertToString}}
+              @onChange={{this.updateConvertToString}}
+            >
+              {{t 'variable-plugin.autofill.convertToString'}}
+            </AuCheckbox>
+          </AuFormRow>
+          <AuButton {{on 'click' this.edit}}>
+            {{t 'variable-plugin.button'}}
+          </AuButton>
+        </c.content>
+      </AuCard>
+    {{/if}}
+  </template>
+}

addon/components/variable-plugin/autofilled/insert.gts

@@ -0,0 +1,143 @@
+import Component from '@glimmer/component';
+import { tracked } from '@glimmer/tracking';
+import { action } from '@ember/object';
+import { service } from '@ember/service';
+import { type SayController } from '@lblod/ember-rdfa-editor';
+import { sayDataFactory } from '@lblod/ember-rdfa-editor/core/say-data-factory';
+import { v4 as uuidv4 } from 'uuid';
+import IntlService from 'ember-intl/services/intl';
+import {
+  DCT,
+  EXT,
+  RDF,
+} from '@lblod/ember-rdfa-editor-lblod-plugins/utils/constants';
+import { replaceSelectionWithAndSelectNode } from '@lblod/ember-rdfa-editor-lblod-plugins/commands';
+import AuFormRow from '@appuniversum/ember-appuniversum/components/au-form-row';
+import AuLabel from '@appuniversum/ember-appuniversum/components/au-label';
+import AuButton from '@appuniversum/ember-appuniversum/components/au-button';
+import AuCheckbox from '@appuniversum/ember-appuniversum/components/au-checkbox';
+import AuNativeInput from '@lblod/ember-rdfa-editor-lblod-plugins/components/au-native-input';
+import t from 'ember-intl/helpers/t';
+import { on } from '@ember/modifier';
+import LabelInput from '@lblod/ember-rdfa-editor-lblod-plugins/components/variable-plugin/utils/label-input';
+
+type Args = {
+  controller: SayController;
+};
+
+export default class AutoFilledVariableInsertComponent extends Component<Args> {
+  @service declare intl: IntlService;
+  @tracked label: string = '';
+  @tracked autofillKey?: string;
+  @tracked convertToString?: boolean;
+
+  get controller() {
+    return this.args.controller;
+  }
+
+  get schema() {
+    return this.args.controller.schema;
+  }
+
+  get documentLanguage() {
+    return this.controller.documentLanguage;
+  }
+
+  @action
+  updateLabel(event: InputEvent) {
+    this.label = (event.target as HTMLInputElement).value;
+  }
+
+  @action
+  updateAutofillKey(event: InputEvent) {
+    this.autofillKey = (event.target as HTMLInputElement).value;
+  }
+
+  @action
+  updateConvertToString(value: boolean) {
+    this.convertToString = value;
+  }
+
+  @action
+  insert() {
+    const mappingSubject = `http://data.lblod.info/mappings/${uuidv4()}`;
+    const variableInstance = `http://data.lblod.info/variables/${uuidv4()}`;
+    const variableId = uuidv4();
+
+    const placeholder = this.intl.t('variable.autofilled.label', {
+      locale: this.documentLanguage,
+    });
+
+    const label = this.label != '' ? this.label : placeholder;
+    const node = this.schema.nodes.autofilled_variable.create(
+      {
+        subject: mappingSubject,
+        rdfaNodeType: 'resource',
+        __rdfaId: variableId,
+        properties: [
+          {
+            predicate: RDF('type').full,
+            object: sayDataFactory.namedNode(EXT('Mapping').full),
+          },
+          {
+            predicate: EXT('instance').full,
+            object: sayDataFactory.namedNode(variableInstance),
+          },
+          {
+            predicate: EXT('label').full,
+            object: sayDataFactory.literal(label),
+          },
+          {
+            predicate: DCT('type').full,
+            object: sayDataFactory.literal('autofilled'),
+          },
+          {
+            predicate: EXT('content').full,
+            object: sayDataFactory.contentLiteral(),
+          },
+        ],
+        autofillKey: this.autofillKey,
+        convertToString: this.convertToString,
+      },
+
+      this.schema.node('placeholder', {
+        placeholderText: `Autofill ${this.autofillKey}`,
+      }),
+    );
+    this.label = '';
+
+    this.controller.doCommand(replaceSelectionWithAndSelectNode(node), {
+      view: this.controller.mainEditorView,
+    });
+  }
+  <template>
+    <AuFormRow>
+      <LabelInput @label={{this.label}} @updateLabel={{this.updateLabel}} />
+    </AuFormRow>
+    <AuFormRow>
+      <AuLabel for='autofill_key'>
+        {{t 'variable-plugin.autofill.autofillKey'}}
+      </AuLabel>
+      <AuNativeInput
+        id='autofill_key'
+        placeholder={{t 'variable-plugin.autofill.autofillKeyPlaceholder'}}
+        @type='text'
+        @width='block'
+        value={{this.autofillKey}}
+        {{on 'input' this.updateAutofillKey}}
+      />
+    </AuFormRow>
+    <AuFormRow>
+      <AuCheckbox
+        id='convert_to_string'
+        @checked={{this.convertToString}}
+        @onChange={{this.updateConvertToString}}
+      >
+        {{t 'variable-plugin.autofill.convertToString'}}
+      </AuCheckbox>
+    </AuFormRow>
+    <AuButton {{on 'click' this.insert}}>
+      {{t 'variable-plugin.button'}}
+    </AuButton>
+  </template>
+}