Restructure builder (customFilters) to accept custom options (honestb…

…leeps#4797)

* Restructure builder (customFilters) to accept custom options

- The builder is less coupled with customFilter options (`ondemand`)
- Custom options is necessary for future comment filter options
- ondemand name field is now visible

* Prevent unknown types from breaking the builder

* move name from case conditions to filter

* Improve coupling between filter sources and external filters

* customFilter id

Needed as relying on the name as type can break references to on-demand
cases

* Retrieve case value on construction

* Tweak group case

* add 'name' parameter to adHoc cases

* on-demand filters default to state false

lib/core/migrate/migrate.js

@@ -687,6 +687,20 @@ const migrations = [
 
  // TODO Next stable: Remove `RESmodules.filteReddit` and option filteReddit customFilters
  },
+ }, {
+ versionNumber: '5.11.1-settingsConsole-builder-tweak',
+ async go() {
+ const { customFiltersP, customFiltersC } = await Options.loadRaw('filteReddit') || {};
+ let i = Date.now();
+ for (const v of [...(customFiltersP.value || []), ...(customFiltersC.value || [])]) {
+ const { body: { name }, ondemand } = v;
+ v.opts = { ondemand, name };
+ v.id = `customFilter-${String(i++)}`;
+ // The trash values will be ignored by the builder, so no need to remove them
+ }
+ if (customFiltersP) await Options.set('filteReddit', 'customFiltersP', customFiltersP.value);
+ if (customFiltersC) await Options.set('filteReddit', 'customFiltersC', customFiltersC.value);
+ },
  },
 
 ]; // ^^ Add new migrations ^^

lib/core/module.js

@@ -221,14 +221,20 @@ export type BuilderOption<Ctx> = {|
  defaultTemplate: () => BuilderRootValue,
  cases: { [string]: BuilderCase<*> },
  value: BuilderRootValue[],
+ customOptionsFields: Array<Array<BuilderField | string>>,
  ...CommonOptionProps<Ctx>,
 |};
 
 export type BuilderRootValue = {|
  note: string,
  ver: number,
+ id: string,
  body: BuilderValue,
- ondemand?: boolean,
+ opts?: {
+ [string]: mixed,
+ // Some typed (reserved) values in order to simplify type checking
+ name?: string,
+ },
 |};
 
 export type BuilderValue = {
@@ -241,7 +247,7 @@ type BuilderCase = {
  fields: Array<BuilderField | string>,
 };
 
-type BuilderField = BuilderSelectField | BuilderMultiField | BuilderTextField | BuilderDurationField | BuilderChecksetField | BuilderNumberField;
+type BuilderField = BuilderSelectField | BuilderMultiField | BuilderDurationField | BuilderChecksetField | BuilderNumberField | BuilderCheckboxField | BuilderGenericInputField;
 
 type PredefinedSelectChoice = 'COMPARISON';
 
@@ -257,11 +263,6 @@ type BuilderMultiField = {|
  id: string,
 |};
 
-type BuilderTextField = {|
- type: 'text',
- id: string,
-|};
-
 type BuilderDurationField = {|
  type: 'duration',
  id: string,
@@ -277,3 +278,14 @@ type BuilderNumberField = {|
  type: 'number',
  id: string,
 |};
+
+type BuilderCheckboxField = {|
+ type: 'check',
+ id: string,
+ label: string,
+|};
+
+type BuilderGenericInputField = {|
+ type: string,
+ id: string,
+|};

lib/css/res.scss

@@ -1423,6 +1423,10 @@ body.RESScrollLock {
  display: flex;
  margin-bottom: 5px;
 
+ > .builderCustomOptions {
+ margin-left: 10px;
+ }
+
  > .builderControls {
  padding: .3em .2em;
  }
@@ -1433,6 +1437,10 @@ body.RESScrollLock {
  &.handle { font-size: 27px; }
  }
  }
+
+ input[type='checkbox'] {
+ vertical-align: text-bottom !important;
+ }
 }
 
 .builderWrap {