@lblod/ember-rdfa-editor-lblod-plugins 23.1.0 → 24.0.0

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @lblod/ember-rdfa-editor-lblod-plugins
 
+## 24.0.0
+
+### Major Changes
+
+- [#482](https://github.com/lblod/ember-rdfa-editor-lblod-plugins/pull/482) [`8c46ded`](https://github.com/lblod/ember-rdfa-editor-lblod-plugins/commit/8c46deddb0ab3d156b27fb555709e6489f647ced) Thanks [@elpoelma](https://github.com/elpoelma)! - Adjust snippet queries to work with new snippet data-model
+
+### Minor Changes
+
+- [#472](https://github.com/lblod/ember-rdfa-editor-lblod-plugins/pull/472) [`a114436`](https://github.com/lblod/ember-rdfa-editor-lblod-plugins/commit/a114436ce7b0a7a4f2fca9faf494729169554dbd) Thanks [@lagartoverde](https://github.com/lagartoverde)! - Add autofill variable
+
+- [#484](https://github.com/lblod/ember-rdfa-editor-lblod-plugins/pull/484) [`14e8c57`](https://github.com/lblod/ember-rdfa-editor-lblod-plugins/commit/14e8c5746b7674dfa3e0d968d4ce16c5855ffff3) Thanks [@elpoelma](https://github.com/elpoelma)! - Add option for enabling/disabling multi-snippet insertion
+
 ## 23.1.0
 
 ### Minor Changes

package/addon/components/snippet-plugin/nodes/snippet.gts

@@ -81,10 +81,17 @@ export default class SnippetNode extends Component<Signature> {
     this.controller.focus();
     this.showModal = true;
   }
+
+  get allowMultipleSnippets() {
+    return this.node.attrs.allowMultipleSnippets as boolean;
+  }
+
   @action
   addFragment() {
-    this.mode = 'add';
-    this.openModal();
+    if (this.allowMultipleSnippets) {
+      this.mode = 'add';
+      this.openModal();
+    }
   }
   @action
   editFragment() {
@@ -151,6 +158,7 @@ export default class SnippetNode extends Component<Signature> {
         assignedSnippetListsIds,
         importedResources: this.node.attrs.importedResources,
         range: { start, end },
+        allowMultipleSnippets: this.allowMultipleSnippets,
       }),
     );
   }
@@ -173,12 +181,14 @@ export default class SnippetNode extends Component<Signature> {
           @isActive={{this.isActive}}
           class='say-snippet-remove-button'
         />
-        <SnippetButton
-          @icon={{AddIcon}}
-          @helpText='snippet-plugin.snippet-node.add-fragment'
-          @onClick={{this.addFragment}}
-          @isActive={{this.isActive}}
-        />
+        {{#if this.allowMultipleSnippets}}
+          <SnippetButton
+            @icon={{AddIcon}}
+            @helpText='snippet-plugin.snippet-node.add-fragment'
+            @onClick={{this.addFragment}}
+            @isActive={{this.isActive}}
+          />
+        {{/if}}
       </div>
 
     </div>

package/addon/components/snippet-plugin/snippet-insert-placeholder.gts

@@ -38,9 +38,16 @@ export default class SnippetPluginSnippetInsertPlaceholder extends Component<Sig
   }
 
   @action
-  insertPlaceholder(lists: SnippetList[] | undefined) {
+  insertPlaceholder(
+    lists: SnippetList[] | undefined,
+    allowMultipleSnippets: boolean,
+  ) {
     if (lists) {
-      const node = createSnippetPlaceholder(lists, this.args.controller.schema);
+      const node = createSnippetPlaceholder(
+        lists,
+        this.args.controller.schema,
+        allowMultipleSnippets,
+      );
 
       this.args.controller.withTransaction(
         (tr) => {
@@ -66,6 +73,7 @@ export default class SnippetPluginSnippetInsertPlaceholder extends Component<Sig
     <SnippetListModal
       @config={{@config}}
       @assignedSnippetListsIds={{empty}}
+      @allowMultipleSnippets={{false}}
       @onSaveSnippetLists={{this.insertPlaceholder}}
       @open={{this.isModalOpen}}
       @closeModal={{this.closeModal}}

package/addon/components/snippet-plugin/snippet-insert-rdfa.gts

@@ -71,12 +71,17 @@ export default class SnippetInsertRdfaComponent extends Component<Sig> {
     return undefined;
   }
 
+  get allowMultipleSnippets() {
+    return this.args.node.value.attrs.allowMultipleSnippets as boolean;
+  }
+
   <template>
     <SnippetInsert
       @config={{@config}}
       @controller={{@controller}}
       @snippetListProperties={{this.snippetListProperties}}
       @disabled={{this.disableInsert}}
+      @allowMultipleSnippets={{this.allowMultipleSnippets}}
     />
   </template>
 }

package/addon/components/snippet-plugin/snippet-insert.gts

@@ -23,6 +23,7 @@ interface Sig {
       | { listIds: string[]; importedResources: ImportedResourceMap }
       | undefined;
     disabled?: boolean;
+    allowMultipleSnippets?: boolean;
   };
 }
 
@@ -63,6 +64,7 @@ export default class SnippetInsertComponent extends Component<Sig> {
         title,
         assignedSnippetListsIds: this.args.snippetListProperties?.listIds || [],
         importedResources: this.args.snippetListProperties?.importedResources,
+        allowMultipleSnippets: this.args.allowMultipleSnippets,
       }),
     );
   }

package/addon/components/snippet-plugin/snippet-list/snippet-list-modal.hbs

@@ -31,20 +31,31 @@
           @border='top'
           @size='large'
           @nowrap={{true}}
-          @reverse={{true}}
+          class='au-u-flex--vertical-center'
+          as |Group|
         >
-          <AuButtonGroup>
-            <AuButton @skin='secondary' {{on 'click' this.closeModal}}>
-              {{t 'snippet-plugin.snippet-list.modal.button.cancel'}}
-            </AuButton>
-            <AuButton
-              @skin='primary'
-              {{on 'click' this.saveAndClose}}
-              @disabled={{@onSaveSnippetLists.isRunning}}
+          <Group>
+            <AuCheckbox
+              @checked={{this.allowMultipleSnippets}}
+              @onChange={{this.handleMultipleSnippetsCheckbox}}
             >
-              {{t 'snippet-plugin.snippet-list.modal.button.update'}}
-            </AuButton>
-          </AuButtonGroup>
+              {{t 'snippet-plugin.snippet-list.modal.multi-snippet-toggle'}}
+            </AuCheckbox>
+          </Group>
+          <Group>
+            <AuButtonGroup>
+              <AuButton @skin='secondary' {{on 'click' this.closeModal}}>
+                {{t 'snippet-plugin.snippet-list.modal.button.cancel'}}
+              </AuButton>
+              <AuButton
+                @skin='primary'
+                {{on 'click' this.saveAndClose}}
+                @disabled={{@onSaveSnippetLists.isRunning}}
+              >
+                {{t 'snippet-plugin.snippet-list.modal.button.update'}}
+              </AuButton>
+            </AuButtonGroup>
+          </Group>
         </AuToolbar>
       </mc.content>
     </AuMainContainer>

package/addon/components/snippet-plugin/snippet-list/snippet-list-modal.ts

@@ -14,15 +14,19 @@ import {
   SnippetPluginConfig,
   SnippetList,
 } from '@lblod/ember-rdfa-editor-lblod-plugins/plugins/snippet-plugin';
-import { trackedReset } from 'tracked-toolbox';
+import { localCopy, trackedReset } from 'tracked-toolbox';
 
 interface Signature {
   Args: {
     config: SnippetPluginConfig;
-    onSaveSnippetLists: (lists: SnippetList[]) => void;
+    onSaveSnippetLists: (
+      lists: SnippetList[],
+      allowMultipleSnippets: boolean,
+    ) => void;
     assignedSnippetListsIds: string[] | undefined;
     closeModal: () => void;
     open: boolean;
+    allowMultipleSnippets?: boolean;
   };
 }
 
@@ -41,12 +45,20 @@ export default class SnippetListModalComponent extends Component<Signature> {
     ...(this.args.assignedSnippetListsIds ?? []),
   ];
 
+  @localCopy('args.allowMultipleSnippets') allowMultipleSnippets = false;
+
+  @action
+  handleMultipleSnippetsCheckbox(checked: boolean) {
+    this.allowMultipleSnippets = checked;
+  }
+
   get config() {
     return this.args.config;
   }
 
   @action
   closeModal() {
+    this.allowMultipleSnippets = this.args.allowMultipleSnippets ?? false;
     this.args.closeModal();
   }
 
@@ -55,7 +67,10 @@ export default class SnippetListModalComponent extends Component<Signature> {
     const snippetLists = this.snippetListResource.value?.filter((snippetList) =>
       this.assignedSnippetListsIds.includes(snippetList.id),
     );
-    this.args.onSaveSnippetLists(snippetLists || []);
+    this.args.onSaveSnippetLists(
+      snippetLists || [],
+      this.allowMultipleSnippets,
+    );
     this.args.closeModal();
     // Clear selection for next time
     this.assignedSnippetListsIds = [];

package/addon/components/snippet-plugin/snippet-list-select.gts

@@ -59,12 +59,16 @@ export default class SnippetListSelect extends Component<Signature> {
     );
   }
 
+  get allowMultipleSnippets(): boolean {
+    return this.args.node.value.attrs.allowMultipleSnippets as boolean;
+  }
+
   get imported(): ImportedResourceMap {
     return this.args.node.value.attrs['importedResources'];
   }
 
   @action
-  onSaveSnippetLists(lists: SnippetList[]) {
+  onSaveSnippetLists(lists: SnippetList[], allowMultipleSnippets: boolean) {
     if (this.currentResource) {
       this.args.controller?.doCommand(
         updateSnippetPlaceholder({
@@ -73,6 +77,7 @@ export default class SnippetListSelect extends Component<Signature> {
           newSnippetLists: lists,
           oldImportedResources: this.imported,
           node: this.args.node,
+          allowMultipleSnippets,
         }),
         {
           view: this.args.controller.mainEditorView,
@@ -96,6 +101,7 @@ export default class SnippetListSelect extends Component<Signature> {
         @config={{@config}}
         @assignedSnippetListsIds={{this.assignedSnippetListsIds}}
         @onSaveSnippetLists={{this.onSaveSnippetLists}}
+        @allowMultipleSnippets={{this.allowMultipleSnippets}}
         @open={{this.showModal}}
         @closeModal={{this.closeModal}}
       />

package/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>
+}

package/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>
+}