✨ [open-formulieren/open-forms#5016] Referentielijsten dataSrc for op…

…tions dynamically fetch options for select, selectboxes and radio components
open-formulieren · Jan 27, 2025 · 7475aad · 7475aad
1 parent 9888f01
commit 7475aad
Show file tree

Hide file tree

Showing 4 changed files with 58 additions and 10 deletions.
diff --git a/src/formio/common.ts b/src/formio/common.ts
@@ -27,3 +27,12 @@ export interface VariableValues {
   dataSrc: 'variable';
   itemsExpression: string | JSONObject;
 }
+
+/**
+ * @category Utilities
+ */
+export interface ReferentielijstenValues {
+  dataSrc: 'referentielijsten';
+  service: string;
+  code: string;
+}
diff --git a/src/formio/components/radio.ts b/src/formio/components/radio.ts
@@ -1,5 +1,5 @@
 import {InputComponentSchema} from '..';
-import {ManualValues, Option, VariableValues} from '../common';
+import {ManualValues, Option, ReferentielijstenValues, VariableValues} from '../common';
 import {Require} from '../util';
 
 type Validator = 'required';
@@ -12,6 +12,8 @@ export type RadioInputSchema<Extensions> = InputComponentSchema<
   Extensions
 >;
 
+export type RadioUnsupported = 'hideLabel' | 'disabled';
+
 /**
  * @group Form.io components
  * @category Base types
@@ -25,7 +27,7 @@ interface BaseRadioSchema {
  * @group Form.io components
  * @category Base types
  */
-type RadioManualValuesSchema = Omit<RadioInputSchema<ManualValues>, 'hideLabel' | 'disabled'> &
+type RadioManualValuesSchema = Omit<RadioInputSchema<ManualValues>, RadioUnsupported> &
   BaseRadioSchema & {
     values: Option[];
   };
@@ -34,14 +36,24 @@ type RadioManualValuesSchema = Omit<RadioInputSchema<ManualValues>, 'hideLabel'
  * @group Form.io components
  * @category Base types
  */
-type RadioVariableValuesSchema = Omit<RadioInputSchema<VariableValues>, 'hideLabel' | 'disabled'> &
+type RadioVariableValuesSchema = Omit<RadioInputSchema<VariableValues>, RadioUnsupported> &
+  BaseRadioSchema;
+
+/**
+ * @group Form.io components
+ * @category Base types
+ */
+type RadioReferentielijstenValuesSchema = Omit<
+  RadioInputSchema<ReferentielijstenValues>,
+  RadioUnsupported
+> &
   BaseRadioSchema;
 
 /**
  * @group Form.io components
  * @category Concrete types
  */
 export type RadioComponentSchema = Require<
-  RadioManualValuesSchema | RadioVariableValuesSchema,
+  RadioManualValuesSchema | RadioVariableValuesSchema | RadioReferentielijstenValuesSchema,
   'openForms'
 >;
diff --git a/src/formio/components/select.ts b/src/formio/components/select.ts
@@ -1,6 +1,6 @@
 import {InputComponentSchema} from '..';
 import {MultipleCapable} from '../base';
-import {ManualValues, Option, VariableValues} from '../common';
+import {ManualValues, Option, ReferentielijstenValues, VariableValues} from '../common';
 import {Require} from '../util';
 
 type Validator = 'required';
@@ -50,10 +50,23 @@ type SelectManualValuesSchema = Omit<SelectInputSchema<ManualValues>, SelectUnsu
 type SelectVariableValuesSchema = Omit<SelectInputSchema<VariableValues>, SelectUnsupported> &
   BaseSelectSchema;
 
+/**
+ * @group Form.io components
+ * @category Base types
+ */
+type SelectReferentielijstenValuesSchema = Omit<
+  SelectInputSchema<ReferentielijstenValues>,
+  SelectUnsupported
+> &
+  BaseSelectSchema;
+
 /**
  * @group Form.io components
  * @category Concrete types
  */
 export type SelectComponentSchema = MultipleCapable<
-  Require<SelectManualValuesSchema | SelectVariableValuesSchema, 'openForms'>
+  Require<
+    SelectManualValuesSchema | SelectVariableValuesSchema | SelectReferentielijstenValuesSchema,
+    'openForms'
+  >
 >;
diff --git a/src/formio/components/selectboxes.ts b/src/formio/components/selectboxes.ts
@@ -1,5 +1,5 @@
 import {InputComponentSchema} from '..';
-import {ManualValues, Option, VariableValues} from '../common';
+import {ManualValues, Option, ReferentielijstenValues, VariableValues} from '../common';
 import {Require} from '../util';
 
 type Validator = 'required' | 'minSelectedCount' | 'maxSelectedCount';
@@ -12,6 +12,8 @@ export type SelectboxesInputSchema<Extensions> = InputComponentSchema<
   Extensions
 >;
 
+export type SelectboxesUnsupported = 'hideLabel' | 'disabled';
+
 /**
  * @group Form.io components
  * @category Base types
@@ -27,7 +29,7 @@ interface BaseSelectboxesSchema {
  */
 type SelectboxesManualValuesSchema = Omit<
   SelectboxesInputSchema<ManualValues>,
-  'hideLabel' | 'disabled'
+  SelectboxesUnsupported
 > &
   BaseSelectboxesSchema & {
     values: Option[];
@@ -39,7 +41,17 @@ type SelectboxesManualValuesSchema = Omit<
  */
 type SelectboxesVariableValuesSchema = Omit<
   SelectboxesInputSchema<VariableValues>,
-  'hideLabel' | 'disabled'
+  SelectboxesUnsupported
+> &
+  BaseSelectboxesSchema;
+
+/**
+ * @group Form.io components
+ * @category Base types
+ */
+type SelectboxesReferentielijstenValuesSchema = Omit<
+  SelectboxesInputSchema<ReferentielijstenValues>,
+  SelectboxesUnsupported
 > &
   BaseSelectboxesSchema;
 
@@ -48,6 +60,8 @@ type SelectboxesVariableValuesSchema = Omit<
  * @category Concrete types
  */
 export type SelectboxesComponentSchema = Require<
-  SelectboxesManualValuesSchema | SelectboxesVariableValuesSchema,
+  | SelectboxesManualValuesSchema
+  | SelectboxesVariableValuesSchema
+  | SelectboxesReferentielijstenValuesSchema,
   'openForms'
 >;