Merge pull request #24 from open-formulieren/feature/2-select

✨ [#2] Implement types for `select`
open-formulieren · Nov 13, 2023 · c51f719 · c51f719
2 parents 68a544b + fa1c3fc
commit c51f719
Show file tree

Hide file tree

Showing 4 changed files with 287 additions and 0 deletions.
diff --git a/src/formio/components/index.ts b/src/formio/components/index.ts
@@ -11,6 +11,7 @@ export * from './iban';
 export * from './licenseplate';
 export * from './bsn';
 export * from './number';
+export * from './select';
 export * from './checkbox';
 export * from './selectboxes';
 export * from './file';

diff --git a/src/formio/components/select.ts b/src/formio/components/select.ts
@@ -0,0 +1,52 @@
+import {InputComponentSchema} from '..';
+import {MultipleCapable, OFExtensions} from '../base';
+import {ManualValues, Option, VariableValues} from '../common';
+
+type Validator = 'required';
+type TranslatableKeys = 'label' | 'description' | 'tooltip';
+
+export type SelectInputSchema = InputComponentSchema<string, Validator, TranslatableKeys>;
+
+export type SelectUnsupported = 'hideLabel' | 'disabled' | 'placeholder';
+
+/**
+ * @group Form.io components
+ * @category Base types
+ */
+interface BaseSelectSchema {
+  type: 'select';
+  // not to be confused with openforms.dataSrc. Formio itself supports dynamic sources
+  // like json/url/resource/custom but we don't use any of that, our backend resolves
+  // dynamic values into data.values already.
+  // So our openForms.dataSrc == itemsExpression results in dataSrc == values.
+  dataSrc: 'values';
+}
+
+/**
+ * @group Form.io components
+ * @category Base types
+ */
+type SelectManualValuesSchema = Omit<SelectInputSchema, SelectUnsupported> &
+  BaseSelectSchema & {
+    openForms: OFExtensions<TranslatableKeys>['openForms'] & ManualValues;
+    data: {
+      values: Option[];
+    };
+  };
+
+/**
+ * @group Form.io components
+ * @category Base types
+ */
+type SelectVariableValuesSchema = Omit<SelectInputSchema, SelectUnsupported> &
+  BaseSelectSchema & {
+    openForms: OFExtensions<TranslatableKeys>['openForms'] & VariableValues;
+  };
+
+/**
+ * @group Form.io components
+ * @category Concrete types
+ */
+export type SelectComponentSchema = MultipleCapable<
+  SelectManualValuesSchema | SelectVariableValuesSchema
+>;
diff --git a/src/formio/index.ts b/src/formio/index.ts
@@ -13,6 +13,7 @@ import {
   PhoneNumberComponentSchema,
   PostcodeComponentSchema,
   RadioComponentSchema,
+  SelectComponentSchema,
   SelectboxesComponentSchema,
   TextFieldComponentSchema,
   TimeComponentSchema,
@@ -52,6 +53,7 @@ export type AnyComponentSchema =
   | PostcodeComponentSchema
   | FileComponentSchema
   | NumberComponentSchema
+  | SelectComponentSchema
   | CheckboxComponentSchema
   | SelectboxesComponentSchema
   | CurrencyComponentSchema

diff --git a/test-d/formio/components/select.test-d.ts b/test-d/formio/components/select.test-d.ts
@@ -0,0 +1,232 @@
+import {expectAssignable, expectNotAssignable} from 'tsd';
+
+import {SelectComponentSchema} from '../../../lib';
+
+// minimal component schema, manual:
+expectAssignable<SelectComponentSchema>({
+  id: 'yejak',
+  type: 'select',
+  dataSrc: 'values',
+  key: 'someSelect',
+  label: 'Some select',
+  openForms: {
+    dataSrc: 'manual',
+    translations: {},
+  },
+  data: {
+    values: [
+      {
+        value: 'dummy',
+        label: 'dummy',
+      },
+    ],
+  },
+});
+
+// minimal component schema, variable:
+expectAssignable<SelectComponentSchema>({
+  id: 'yejak',
+  type: 'select',
+  dataSrc: 'values',
+  key: 'someSelect',
+  label: 'Some select',
+  openForms: {
+    dataSrc: 'variable',
+    itemsExpression: 'dummy',
+    translations: {},
+  },
+});
+
+// minimal component schema, multiple false:
+expectAssignable<SelectComponentSchema>({
+  id: 'yejak',
+  type: 'select',
+  dataSrc: 'values',
+  key: 'someSelect',
+  label: 'Some select',
+  multiple: false,
+  defaultValue: 'dummy',
+  openForms: {
+    dataSrc: 'variable',
+    itemsExpression: 'dummy',
+    translations: {},
+  },
+});
+
+// minimal component schema, multiple true:
+expectAssignable<SelectComponentSchema>({
+  id: 'yejak',
+  type: 'select',
+  dataSrc: 'values',
+  key: 'someSelect',
+  label: 'Some select',
+  multiple: true,
+  defaultValue: ['dummy'],
+  openForms: {
+    dataSrc: 'variable',
+    itemsExpression: 'dummy',
+    translations: {},
+  },
+});
+
+// minimal component schema, multiple true and empty defaults:
+expectAssignable<SelectComponentSchema>({
+  id: 'yejak',
+  type: 'select',
+  dataSrc: 'values',
+  key: 'someSelect',
+  label: 'Some select',
+  multiple: true,
+  defaultValue: [],
+  openForms: {
+    dataSrc: 'variable',
+    itemsExpression: 'dummy',
+    translations: {},
+  },
+});
+
+// values translations
+expectAssignable<SelectComponentSchema>({
+  id: 'yejak',
+  type: 'select',
+  dataSrc: 'values',
+  key: 'someSelect',
+  label: 'Some select',
+  defaultValue: 'dummy',
+  openForms: {
+    dataSrc: 'manual',
+    translations: {},
+  },
+  data: {
+    values: [
+      {
+        value: 'dummy',
+        label: 'dummy',
+        openForms: {
+          translations: {
+            en: {
+              label: 'dummy_en',
+            },
+            nl: {
+              label: 'dummy_nl',
+            },
+          },
+        },
+      },
+    ],
+  },
+});
+
+// full, correct schema
+expectAssignable<SelectComponentSchema>({
+  id: 'yejak',
+  type: 'select',
+  dataSrc: 'values',
+  // basic tab
+  label: 'Some select',
+  key: 'someSelect',
+  description: '',
+  tooltip: 'A tooltip',
+  showInSummary: true,
+  showInEmail: false,
+  showInPDF: true,
+  hidden: false,
+  clearOnHide: true,
+  isSensitiveData: true,
+  defaultValue: 'dummy',
+  // Advanced tab
+  conditional: {
+    show: undefined,
+    when: '',
+    eq: '',
+  },
+  // Validation tab
+  validate: {
+    required: false,
+    plugins: [],
+  },
+  translatedErrors: {nl: {required: 'Geef checkbox.'}},
+  errors: {required: 'Geef checkbox.'},
+  // registration tab
+  registration: {
+    attribute: '',
+  },
+  // translations tab in builder form
+  openForms: {
+    translations: {
+      nl: {label: 'foo'},
+    },
+    dataSrc: 'variable',
+    itemsExpression: 'dummy',
+  },
+  // fixed but not editable
+  validateOn: 'blur',
+});
+
+// Missing openForms
+expectNotAssignable<SelectComponentSchema>({
+  id: 'yejak',
+  type: 'select',
+  dataSrc: 'values',
+  key: 'someSelect',
+  label: 'Some select',
+});
+
+// multiple true, wrong default value
+expectNotAssignable<SelectComponentSchema>({
+  id: 'yejak',
+  type: 'select',
+  dataSrc: 'values',
+  key: 'someSelect',
+  label: 'Some select',
+  multiple: true,
+  defaultValue: 'dummy',
+  openForms: {
+    dataSrc: 'variable',
+    itemsExpression: 'dummy',
+    translations: {},
+  },
+});
+
+// multiple false, wrong default value
+expectNotAssignable<SelectComponentSchema>({
+  id: 'yejak',
+  type: 'select',
+  dataSrc: 'values',
+  key: 'someSelect',
+  label: 'Some select',
+  multiple: false,
+  defaultValue: ['dummy'],
+  openForms: {
+    dataSrc: 'variable',
+    itemsExpression: 'dummy',
+    translations: {},
+  },
+});
+
+// manual without values
+expectNotAssignable<SelectComponentSchema>({
+  id: 'yejak',
+  type: 'select',
+  dataSrc: 'values',
+  key: 'someSelect',
+  label: 'Some select',
+  openForms: {
+    dataSrc: 'manual',
+    translations: {},
+  },
+  data: {},
+});
+
+// variable without itemsExpressions
+expectNotAssignable<SelectComponentSchema>({
+  id: 'yejak',
+  type: 'select',
+  dataSrc: 'values',
+  key: 'someSelect',
+  label: 'Some select',
+  openForms: {
+    dataSrc: 'variable',
+    translations: {},
+  },
+});