Add topic selector field

app/controllers/custom_wizard/admin/wizard.rb

@@ -115,6 +115,7 @@ def save_wizard_params
  :preview_template,
  :placeholder,
  :can_create_tag,
+ :category,
  prefill: mapped_params,
  content: mapped_params,
  condition: mapped_params,

app/serializers/custom_wizard/wizard_field_serializer.rb

@@ -18,6 +18,7 @@ class CustomWizard::FieldSerializer < ::ApplicationSerializer
  :content,
  :tag_groups,
  :can_create_tag,
+ :category,
  :validations,
  :max_length,
  :char_counter,

assets/javascripts/discourse/components/custom-wizard-field-topic.js.es6

@@ -0,0 +1,21 @@
+import Component from "@ember/component";
+
+export default Component.extend({
+ topics: [],
+
+ didInsertElement() {
+ const value = this.field.value;
+
+ if (value) {
+ this.set("topics", value);
+ }
+ },
+
+ actions: {
+ setValue(_, topics) {
+ if (topics.length) {
+ this.set("field.value", topics);
+ }
+ },
+ },
+});

assets/javascripts/discourse/components/custom-wizard-topic-selector.js.es6

@@ -0,0 +1,73 @@
+import MultiSelectComponent from "select-kit/components/multi-select";
+import { isEmpty } from "@ember/utils";
+import { searchForTerm } from "discourse/lib/search";
+import { makeArray } from "discourse-common/lib/helpers";
+
+export default MultiSelectComponent.extend({
+ classNames: ["topic-selector", "wizard-topic-selector"],
+ topics: null,
+ value: [],
+ content: [],
+ nameProperty: "fancy_title",
+ labelProperty: "title",
+ titleProperty: "title",
+
+ selectKitOptions: {
+ clearable: true,
+ filterable: true,
+ filterPlaceholder: "choose_topic.title.placeholder",
+ allowAny: false,
+ },
+
+ didReceiveAttrs() {
+ if (this.topics && !this.selectKit.hasSelection) {
+ const values = makeArray(this.topics.map((t) => t.id));
+ const content = makeArray(this.topics);
+ this.selectKit.change(values, content);
+ }
+ this._super(...arguments);
+ },
+
+ modifyComponentForRow() {
+ return "topic-row";
+ },
+
+ search(filter) {
+ if (isEmpty(filter)) {
+ return [];
+ }
+
+ const searchParams = {};
+ searchParams.typeFilter = "topic";
+ searchParams.restrictToArchetype = "regular";
+ searchParams.searchForId = true;
+
+ if (this.category) {
+ searchParams.searchContext = {
+ type: "category",
+ id: this.category,
+ };
+ }
+
+ return searchForTerm(filter, searchParams).then((results) => {
+ if (results?.posts?.length > 0) {
+ return results.posts.mapBy("topic");
+ }
+ });
+ },
+
+ actions: {
+ onChange(value, items) {
+ const content = items.map((t) => {
+ return {
+ id: t.id,
+ title: t.title,
+ fancy_title: t.fancy_title,
+ url: t.url,
+ };
+ });
+ this.setProperties({ value, content });
+ this.onChange(value, content);
+ },
+ },
+});

assets/javascripts/discourse/components/wizard-custom-field.js.es6

@@ -15,15 +15,23 @@ export default Component.extend(UndoChanges, {
  isDropdown: equal("field.type", "dropdown"),
  isUpload: equal("field.type", "upload"),
  isCategory: equal("field.type", "category"),
+ isTopic: equal("field.type", "topic"),
  isGroup: equal("field.type", "group"),
  isTag: equal("field.type", "tag"),
  isText: equal("field.type", "text"),
  isTextarea: equal("field.type", "textarea"),
  isUrl: equal("field.type", "url"),
  isComposer: equal("field.type", "composer"),
- showPrefill: or("isText", "isCategory", "isTag", "isGroup", "isDropdown"),
- showContent: or("isCategory", "isTag", "isGroup", "isDropdown"),
- showLimit: or("isCategory", "isTag"),
+ showPrefill: or(
+ "isText",
+ "isCategory",
+ "isTag",
+ "isGroup",
+ "isDropdown",
+ "isTopic"
+ ),
+ showContent: or("isCategory", "isTag", "isGroup", "isDropdown", "isTopic"),
+ showLimit: or("isCategory", "isTag", "isTopic"),
  isTextType: or("isText", "isTextarea", "isComposer"),
  isComposerPreview: equal("field.type", "composer_preview"),
  categoryPropertyTypes: selectKitContent(["id", "slug"]),
@@ -156,5 +164,9 @@ export default Component.extend(UndoChanges, {
  "field.image_upload_id": null,
  });
  },
+
+ changeCategory(category) {
+ this.set("field.category", category?.id);
+ },
  },
 });

assets/javascripts/discourse/components/wizard-table-field.js.es6

@@ -18,6 +18,7 @@ export default Component.extend({
  isDropdown: equal("value.type", "dropdown"),
  isTag: equal("value.type", "tag"),
  isCategory: equal("value.type", "category"),
+ isTopic: equal("value.type", "topic"),
  isGroup: equal("value.type", "group"),
  isUserSelector: equal("value.type", "user_selector"),
  isSubmittedAt: equal("field", "submitted_at"),

assets/javascripts/discourse/lib/wizard-schema.js.es6

@@ -73,6 +73,7 @@ const field = {
  type: null,
  condition: null,
  tag_groups: null,
+ category: null,
  },
  types: {},
  mapped: ["prefill", "content", "condition", "index"],
@@ -227,6 +228,7 @@ const filters = {
  "dropdown",
  "tag",
  "category",
+ "topic",
  "group",
  "user_selector",
  ],

assets/javascripts/discourse/models/custom-wizard-field.js.es6

@@ -14,6 +14,7 @@ const StandardFieldValidation = [
  "text_only",
  "composer",
  "category",
+ "topic",
  "group",
  "date",
  "time",

assets/javascripts/discourse/models/custom-wizard-step.js.es6

@@ -63,7 +63,8 @@ export default EmberObject.extend(ValidState, {
  return ajax({
  url: `/w/${wizardId}/steps/${this.get("id")}`,
  type: "PUT",
- data: { fields },
+ contentType: "application/json",
+ data: JSON.stringify({ fields }),
  }).catch((response) => {
  if (response.jqXHR) {
  response = response.jqXHR;

assets/javascripts/discourse/templates/components/custom-wizard-field-topic.hbs

@@ -0,0 +1,6 @@
+{{custom-wizard-topic-selector
+ topics=topics
+ category=field.category
+ onChange=(action "setValue")
+ options=(hash maximum=field.limit)
+}}

assets/javascripts/discourse/templates/components/wizard-custom-field.hbs

@@ -245,6 +245,25 @@
  </div>
 {{/if}}
 
+{{#if isTopic}}
+ <div class="setting full field-mapper-setting">
+ <div class="setting-label">
+ <label>{{i18n "admin.wizard.field.category.label"}}</label>
+ </div>
+
+ <div class="setting-value">
+ <CategoryChooser
+ @value={{this.field.category}}
+ @onChangeCategory={{action "changeCategory"}}
+ @options={{hash
+ none="admin.wizard.field.category.none"
+ autoInsertNoneItem=true
+ }}
+ />
+ </div>
+ </div>
+{{/if}}
+
 {{#wizard-subscription-container}}
  <div class="setting full field-mapper-setting">
  <div class="setting-label">

assets/javascripts/discourse/templates/components/wizard-table-field.hbs

@@ -122,6 +122,22 @@
  </a>
  {{/if}}
 
+ {{#if isTopic}}
+ <strong>
+ {{i18n "admin.wizard.submissions.topic_id"}}:
+ </strong>
+ {{#each value.value as |topic|}}
+ <a
+ target="_blank"
+ rel="noopener noreferrer"
+ href={{topic.url}}
+ title={{topic.fancy_title}}
+ >
+ {{topic.id}}
+ </a>
+ {{/each}}
+ {{/if}}
+
  {{#if isGroup}}
  <strong>
  {{i18n "admin.wizard.submissions.group_id"}}:

assets/stylesheets/common/wizard/field.scss

@@ -182,7 +182,15 @@ body.custom-wizard {
  }
  }
 
- .wizard-category-selector {
+ .wizard-category-selector,
+ .wizard-topic-selector {
  width: 500px;
  }
+
+ .wizard-topic-selector .topic-row {
+ .topic-title,
+ .topic-categories > span:not(:last-of-type) {
+ margin-right: 10px;
+ }
+ }
 }

config/locales/client.en.yml

@@ -212,6 +212,7 @@ en:
  user_field_options: "user field options"
  user: "user"
  category: "category"
+ topic: "topic"
  tag: "tag"
  group: "group"
  list: "list"
@@ -229,6 +230,7 @@ en:
  user_field_options: "Select field"
  user: "Select user"
  category: "Select category"
+ topic: "Select a topic"
  tag: "Select tag"
  group: "Select group"
  list: "Enter item"
@@ -280,6 +282,9 @@ en:
  content: "Content"
  tag_groups: "Tag Groups"
  can_create_tag: "Can Create Tag"
+ category:
+ label: "Category"
+ none: "Limit to a category..."
  date_time_format:
  label: "Format"
  instructions: "<a href='https://momentjs.com/docs/#/displaying/format/' target='_blank'>Moment.js format</a>"
@@ -311,6 +316,7 @@ en:
  dropdown: Dropdown
  tag: Tag
  category: Category
+ topic: Topic
  group: Group
  user_selector: User Selector
  date: Date
@@ -469,6 +475,7 @@ en:
  download: "Download"
  group_id: "Group ID"
  category_id: "Category ID"
+ topic_id: "Topic ID"
  composer_preview: "Composer Preview"
 
  api:

lib/custom_wizard/builder.rb

@@ -131,7 +131,7 @@ def append_field(step, step_template, field_template, build_opts)
  params[:format] = field_template['format']
  end
 
- if field_template['type'] === 'category' || field_template['type'] === 'tag'
+ if %w[category tag topic].include?(field_template['type'])
  params[:limit] = field_template['limit']
  end
 
@@ -143,6 +143,10 @@ def append_field(step, step_template, field_template, build_opts)
  params[:property] = field_template['property']
  end
 
+ if field_template['type'] === 'topic'
+ params[:category] = field_template['category']
+ end
+
  if (content_inputs = field_template['content']).present?
  content = CustomWizard::Mapper.new(
  inputs: content_inputs,

lib/custom_wizard/field.rb

@@ -22,6 +22,7 @@ class CustomWizard::Field
  :property,
  :content,
  :tag_groups,
+ :category,
  :can_create_tag,
  :preview_template,
  :placeholder
@@ -53,6 +54,7 @@ def initialize(attrs)
  @property = attrs[:property]
  @content = attrs[:content]
  @tag_groups = attrs[:tag_groups]
+ @category = attrs[:category]
  @can_create_tag = attrs[:can_create_tag]
  @preview_template = attrs[:preview_template]
  @placeholder = attrs[:placeholder]
@@ -129,6 +131,12 @@ def self.types
  prefill: nil,
  content: nil
  },
+ topic: {
+ limit: 1,
+ prefill: nil,
+ content: nil,
+ category: nil
+ },
  group: {
  prefill: nil,
  content: nil

lib/discourse_plugin_statistics/plugin.rb

@@ -33,6 +33,7 @@ def self.discourse_custom_wizard
  upload: 0,
  tag: 0,
  category: 0,
+ topic: 0,
  group: 0,
  user_selector: 0,
  },

plugin.rb

@@ -1,14 +1,14 @@
 # frozen_string_literal: true
 # name: discourse-custom-wizard
 # about: Forms for Discourse. Better onboarding, structured posting, data enrichment, automated actions and much more.
-# version: 2.6.11
+# version: 2.7.0
 # authors: Angus McLeod, Faizaan Gagan, Robert Barrow, Keegan George, Kaitlin Maddever, Juan Marcos Gutierrez Ramos
 # url: https://github.com/paviliondev/discourse-custom-wizard
 # contact_emails: development@pavilion.tech
 # subscription_url: https://coop.pavilion.tech
 # meta_topic_id: 73345
 
-gem 'liquid', '5.0.1', require: true
+gem 'liquid', '5.5.0', require: true
 gem "discourse_subscription_client", "0.1.2", require_name: "discourse_subscription_client"
 gem 'discourse_plugin_statistics', '0.1.0.pre7', require: true
 register_asset 'stylesheets/common/admin.scss'