task: Add dedupe form control to workflow (#2932)

- Adds new "Deduplication" section to workflows
- Allows users to use a collection for deduplication
- Various refactors for consistency

Author: SuaYoo

frontend/docs/docs/user-guide/workflow-setup.md

@@ -392,6 +392,10 @@ You can use a tool like [crontab.guru](https://crontab.guru/) to check Cron synt
 
 Cron schedules are always in [UTC](https://en.wikipedia.org/wiki/Coordinated_Universal_Time).
 
+## Deduplication
+
+Prevent duplicate content from being crawled and stored.
+
 ## Collections
 
 ### Auto-Add to Collection

frontend/src/components/ui/combobox.ts

@@ -79,9 +79,7 @@ export class Combobox extends LitElement {
         @keyup=${this.onKeyup}
         @focusout=${this.onFocusout}
       >
-        <div slot="anchor">
-          <slot></slot>
-        </div>
+        <slot slot="anchor"></slot>
         <div
           id="dropdown"
           class="dropdown hidden"

frontend/src/components/ui/config-details.ts

@@ -2,6 +2,7 @@ import { localized, msg, str } from "@lit/localize";
 import ISO6391 from "iso-639-1";
 import { html, nothing, type TemplateResult } from "lit";
 import { customElement, property, state } from "lit/decorators.js";
+import { ifDefined } from "lit/directives/if-defined.js";
 import { when } from "lit/directives/when.js";
 import capitalize from "lodash/fp/capitalize";
 
@@ -171,7 +172,7 @@ export class ConfigDetails extends BtrixElement {
         heading: sectionStrings.behaviors,
         renderDescItems: (seedsConfig) => html`
           ${this.renderSetting(
-            labelFor.behaviors,
+            sectionStrings.behaviors,
             [
               seedsConfig?.behaviors?.includes(Behavior.AutoScroll) &&
                 labelFor.autoscrollBehavior,
@@ -194,7 +195,7 @@ export class ConfigDetails extends BtrixElement {
               ),
           )}
           ${this.renderSetting(
-            labelFor.customBehaviors,
+            labelFor.customBehavior,
             seedsConfig?.customBehaviors.length
               ? html`
                   <btrix-custom-behaviors-table
@@ -309,6 +310,16 @@ export class ConfigDetails extends BtrixElement {
           )}
         `,
       })}
+      ${this.renderSection({
+        id: "deduplication",
+        heading: sectionStrings.deduplication,
+        renderDescItems: () => html`
+          ${this.renderSetting(
+            html`<span class="mb-1 inline-block">${labelFor.dedupeType}</span>`,
+            crawlConfig?.dedupeCollId ? msg("Enabled") : msg("Disabled"),
+          )}
+        `,
+      })}
       ${when(!this.hideMetadata, () =>
         this.renderSection({
           id: "collection",
@@ -321,6 +332,7 @@ export class ConfigDetails extends BtrixElement {
               crawlConfig?.autoAddCollections.length
                 ? html`<btrix-linked-collections
                     .collections=${crawlConfig.autoAddCollections}
+                    dedupeId=${ifDefined(crawlConfig.dedupeCollId || undefined)}
                   ></btrix-linked-collections>`
                 : undefined,
             )}
@@ -575,7 +587,7 @@ export class ConfigDetails extends BtrixElement {
     const selectors = this.crawlConfig?.config.selectLinks || [];
 
     return this.renderSetting(
-      labelFor.selectLink,
+      labelFor.selectLinks,
       selectors.length
         ? html`
             <div class="mb-2">

frontend/src/components/ui/search-combobox.ts

@@ -1,38 +1,46 @@
 import { localized, msg } from "@lit/localize";
-import type { SlInput, SlMenuItem } from "@shoelace-style/shoelace";
+import type {
+  SlClearEvent,
+  SlInput,
+  SlMenuItem,
+} from "@shoelace-style/shoelace";
 import Fuse from "fuse.js";
-import { html, LitElement, nothing, type PropertyValues } from "lit";
+import { html, nothing, type PropertyValues } from "lit";
 import { customElement, property, query, state } from "lit/decorators.js";
+import { ifDefined } from "lit/directives/if-defined.js";
 import { when } from "lit/directives/when.js";
 import debounce from "lodash/fp/debounce";
 
+import { TailwindElement } from "@/classes/TailwindElement";
+import { defaultFuseOptions } from "@/context/search-org/connectFuse";
+import type { BtrixSelectEvent } from "@/events/btrix-select";
 import { type UnderlyingFunction } from "@/types/utils";
+import { isNotEqual } from "@/utils/is-not-equal";
 
-type SelectEventDetail<T> = {
+export type BtrixSearchComboboxSelectEvent = BtrixSelectEvent<{
   key: string | null;
-  value?: T;
-};
-export type SelectEvent<T> = CustomEvent<SelectEventDetail<T>>;
+  value: string;
+}>;
 
 const MIN_SEARCH_LENGTH = 2;
-const MAX_SEARCH_RESULTS = 10;
+const MAX_SEARCH_RESULTS = 5;
 
 /**
  * Fuzzy search through list of options
  *
- * @event btrix-select
- * @event btrix-clear
+ * @fires btrix-select
+ * @fires btrix-clear
  */
 @customElement("btrix-search-combobox")
 @localized()
-export class SearchCombobox<T> extends LitElement {
+export class SearchCombobox<T> extends TailwindElement {
   @property({ type: Array })
   searchOptions: T[] = [];
 
-  @property({ type: Array })
+  @property({ type: Array, hasChanged: isNotEqual })
   searchKeys: string[] = [];
 
-  @property({ type: Object })
+  @property({ type: Object, hasChanged: isNotEqual })
   keyLabels?: { [key: string]: string };
 
   @property({ type: String })
@@ -44,6 +52,30 @@ export class SearchCombobox<T> extends LitElement {
   @property({ type: String })
   searchByValue = "";
 
+  @property({ type: String })
+  label?: string;
+
+  @property({ type: String })
+  name?: string;
+
+  @property({ type: Number })
+  maxlength?: number;
+
+  @property({ type: Boolean })
+  required?: boolean;
+
+  @property({ type: Boolean })
+  disabled?: boolean;
+
+  @property({ type: String })
+  size?: SlInput["size"];
+
+  @property({ type: Boolean })
+  disableSearch = false;
+
+  @property({ type: Boolean })
+  createNew = false;
+
   private get hasSearchStr() {
     return this.searchByValue.length >= MIN_SEARCH_LENGTH;
   }
@@ -54,10 +86,9 @@ export class SearchCombobox<T> extends LitElement {
   @query("sl-input")
   private readonly input!: SlInput;
 
-  private fuse = new Fuse<T>([], {
-    keys: [],
-    threshold: 0.2, // stricter; default is 0.6
-    includeMatches: true,
+  protected fuse = new Fuse<T>(this.searchOptions, {
+    ...defaultFuseOptions,
+    keys: this.searchKeys,
   });
 
   disconnectedCallback(): void {
@@ -72,7 +103,7 @@ export class SearchCombobox<T> extends LitElement {
     }
     if (changedProperties.has("searchKeys")) {
       this.onSearchInput.cancel();
-      this.fuse = new Fuse<T>([], {
+      this.fuse = new Fuse<T>(this.searchOptions, {
         ...(
           this.fuse as unknown as {
             options: ConstructorParameters<typeof Fuse>[1];
@@ -106,21 +137,27 @@ export class SearchCombobox<T> extends LitElement {
           this.searchByValue = value;
           await this.updateComplete;
           this.dispatchEvent(
-            new CustomEvent<SelectEventDetail<T>>("btrix-select", {
-              detail: {
-                key: key ?? null,
-                value: value as T,
+            new CustomEvent<BtrixSearchComboboxSelectEvent["detail"]>(
+              "btrix-select",
+              {
+                detail: {
+                  item: { key: key ?? null, value: value },
+                },
               },
-            }),
+            ),
           );
         }}
       >
         <sl-input
-          size="small"
           placeholder=${this.placeholder}
+          label=${ifDefined(this.label)}
+          size=${ifDefined(this.size)}
+          maxlength=${ifDefined(this.maxlength)}
+          ?disabled=${this.disabled}
           clearable
           value=${this.searchByValue}
-          @sl-clear=${() => {
+          @sl-clear=${(e: SlClearEvent) => {
+            e.stopPropagation();
             this.searchResultsOpen = false;
             this.onSearchInput.cancel();
             this.dispatchEvent(new CustomEvent("btrix-clear"));
@@ -139,7 +176,10 @@ export class SearchCombobox<T> extends LitElement {
                 style="margin-left: var(--sl-spacing-3x-small)"
                 >${this.keyLabels![this.selectedKey!]}</sl-tag
               >`,
-            () => html`<sl-icon name="search" slot="prefix"></sl-icon>`,
+            () =>
+              this.disableSearch
+                ? nothing
+                : html`<sl-icon name="search" slot="prefix"></sl-icon>`,
           )}
         </sl-input>
         ${this.renderSearchResults()}
@@ -160,38 +200,65 @@ export class SearchCombobox<T> extends LitElement {
       limit: MAX_SEARCH_RESULTS,
     });
 
-    if (!searchResults.length) {
-      return html`
-        <sl-menu-item slot="menu-item" disabled
-          >${msg("No matches found.")}</sl-menu-item
-        >
-      `;
-    }
+    const match = ({ key, value }: Fuse.FuseResultMatch) => {
+      if (!!key && !!value) {
+        const keyLabel = this.keyLabels?.[key];
+        return html`
+          <sl-menu-item slot="menu-item" data-key=${key} value=${value}>
+            ${keyLabel
+              ? html`<sl-tag slot="prefix" size="small" pill
+                  >${keyLabel}</sl-tag
+                >`
+              : nothing}
+            ${value}
+          </sl-menu-item>
+        `;
+      }
+      return nothing;
+    };
+
+    const newName = this.searchByValue.trim();
+    // Hide "Add" if there's a result that matches the entire string (case insensitive)
+    const showCreateNew =
+      this.createNew &&
+      !searchResults.some((res) =>
+        res.matches?.some(
+          ({ value }) =>
+            value && value.toLocaleLowerCase() === newName.toLocaleLowerCase(),
+        ),
+      );
 
     return html`
-      ${searchResults.map(({ matches }) =>
-        matches?.map(({ key, value }) => {
-          if (!!key && !!value) {
-            const keyLabel = this.keyLabels?.[key];
-            return html`
-              <sl-menu-item slot="menu-item" data-key=${key} value=${value}>
-                ${keyLabel
-                  ? html`<sl-tag slot="prefix" size="small" pill
-                      >${keyLabel}</sl-tag
-                    >`
-                  : nothing}
-                ${value}
-              </sl-menu-item>
-            `;
-          }
-          return nothing;
-        }),
+      ${when(
+        searchResults.length,
+        () => html`
+          ${searchResults.map(({ matches }) => matches?.map(match))}
+          ${showCreateNew
+            ? html`<sl-divider slot="menu-item"></sl-divider>`
+            : nothing}
+        `,
+        () =>
+          showCreateNew
+            ? nothing
+            : html`
+                <sl-menu-item slot="menu-item" disabled
+                  >${msg("No matches found.")}</sl-menu-item
+                >
+              `,
       )}
+      ${when(showCreateNew, () => {
+        return html`
+          <sl-menu-item slot="menu-item" value=${newName}>
+            <span class="text-neutral-500">${msg("Create")} “</span
+            >${newName}<span class="text-neutral-500">”</span>
+          </sl-menu-item>
+        `;
+      })}
     `;
   }
 
   private readonly onSearchInput = debounce(150)(() => {
-    this.searchByValue = this.input.value.trim();
+    this.searchByValue = this.input.value;
 
     if (!this.searchResultsOpen && this.hasSearchStr) {
       this.searchResultsOpen = true;

frontend/src/context/search-org/WithSearchOrgContext.ts

@@ -1,8 +1,12 @@
-import { ContextConsumer } from "@lit/context";
+import { ContextConsumer, type ContextCallback } from "@lit/context";
 import type { LitElement } from "lit";
 import type { Constructor } from "type-fest";
 
-import { searchOrgContext, searchOrgInitialValue } from "./search-org";
+import {
+  searchOrgContext,
+  searchOrgInitialValue,
+  type SearchOrgContext,
+} from "./search-org";
 import type { SearchOrgKey } from "./types";
 
 /**
@@ -17,8 +21,14 @@ export const WithSearchOrgContext = <T extends Constructor<LitElement>>(
   superClass: T,
 ) =>
   class extends superClass {
+    protected searchOrgContextUpdated: ContextCallback<SearchOrgContext> =
+      () => {};
+
     readonly #searchOrg = new ContextConsumer(this, {
       context: searchOrgContext,
+      callback: (value) => {
+        this.searchOrgContextUpdated(value);
+      },
       subscribe: true,
     });
 

frontend/src/context/search-org/connectFuse.ts

@@ -5,10 +5,17 @@ import Fuse from "fuse.js";
 
 import { searchQueryKeys, type SearchQuery } from "./types";
 
+export const defaultFuseOptions: Fuse.IFuseOptions<unknown> = {
+  threshold: 0.3, // stricter; default is 0.6
+  useExtendedSearch: true,
+  includeMatches: true,
+  includeScore: true,
+  shouldSort: false,
+};
+
 export function connectFuse(values: SearchQuery[]) {
   return new Fuse(values, {
+    ...defaultFuseOptions,
     keys: searchQueryKeys,
-    threshold: 0.3,
-    useExtendedSearch: true,
   });
 }

frontend/src/events/btrix-select.ts

@@ -2,6 +2,6 @@ export type BtrixSelectEvent<T = unknown> = CustomEvent<{ item: T }>;
 
 declare global {
   interface GlobalEventHandlersEventMap {
-    "btrix-select": BtrixSelectEvent;
+    "btrix-select": BtrixSelectEvent<never>;
   }
 }

frontend/src/features/archived-items/file-uploader.ts

@@ -237,7 +237,7 @@ export class FileUploader extends BtrixElement {
       ></btrix-tag-input>
       <div class="mt-4">
         <btrix-collections-add
-          .initialCollections=${this.collectionIds}
+          .collectionIds=${this.collectionIds}
           label=${msg("Add to Collection")}
           @collections-change=${(e: CollectionsChangeEvent) =>
             (this.collectionIds = e.detail.collections)}