Merge pull request #54 from open-formulieren/feature/op-24-product-pr…

…ice-component

add productPrice component

src/formio/components/index.ts

@@ -12,6 +12,7 @@ export * from './iban';
 export * from './licenseplate';
 export * from './bsn';
 export * from './npFamilyMembers';
+export * from './productPrice';
 export * from './number';
 export * from './select';
 export * from './checkbox';

src/formio/components/productPrice.ts

@@ -0,0 +1,18 @@
+import {InputComponentSchema} from '..';
+
+type Validator = 'required';
+type TranslatableKeys = 'label' | 'description' | 'tooltip';
+
+export type ProductPriceInputSchema = InputComponentSchema<never, Validator, TranslatableKeys>;
+
+/**
+ * Experimental feature that could change.
+ * @experimental
+ * @group Form.io components
+ * @category Concrete types
+ */
+export interface ProductPriceComponentSchema
+  extends Omit<ProductPriceInputSchema, 'hideLabel' | 'disabled'> {
+  type: 'productPrice';
+  product: string;
+}

src/formio/index.ts

@@ -21,6 +21,7 @@ import {
   PasswordComponentSchema,
   PhoneNumberComponentSchema,
   PostcodeComponentSchema,
+  ProductPriceComponentSchema,
   RadioComponentSchema,
   SelectComponentSchema,
   SelectboxesComponentSchema,
@@ -75,6 +76,7 @@ export type AnyComponentSchema =
   | BsnComponentSchema
   | AddressNLComponentSchema
   | NpFamilyMembersComponentSchema
+  | ProductPriceComponentSchema
   | SignatureComponentSchema
   | CosignV2ComponentSchema
   | MapComponentSchema

test-d/formio/components/productPrice.test-d.ts

@@ -0,0 +1,86 @@
+import {expectAssignable, expectNotAssignable} from 'tsd';
+
+import {ProductPriceComponentSchema} from '../../../lib/';
+
+// minimal productPrice component schema
+expectAssignable<ProductPriceComponentSchema>({
+  id: '123',
+  type: 'productPrice',
+  key: 'aProductPrice',
+  label: 'A Product Price',
+  product: '123'
+} as const);
+
+// different component type
+expectNotAssignable<ProductPriceComponentSchema>({
+  type: 'textfield',
+} as const);
+
+// using unsupported properties
+expectNotAssignable<ProductPriceComponentSchema>({
+  id: '123',
+  type: 'productPrice',
+  key: 'aProductPrice',
+  label: 'A Product Price',
+  product: '123',
+  hideLabel: true,
+} as const);
+
+// No defaultValue allowed
+expectNotAssignable<ProductPriceComponentSchema>({
+  id: '123',
+  type: 'productPrice',
+  key: 'aProductPrice',
+  label: 'A Product Price',
+  product: '123',
+  defaultValue: 1,
+});
+
+// full, correct schema
+expectAssignable<ProductPriceComponentSchema>({
+  id: '8aosjaw',
+  type: 'productPrice',
+  // basic tab in builder form
+  key: 'aProductPrice',
+  label: 'A Product Price',
+  product: '123',
+  description: 'Sample description',
+  tooltip: 'A tooltip',
+  showInSummary: true,
+  showInEmail: false,
+  showInPDF: true,
+  // multiple: false,
+  hidden: false,
+  clearOnHide: true,
+  isSensitiveData: false,
+  // advanced tab in builder form
+  conditional: {
+    show: undefined,
+    when: undefined,
+    eq: undefined,
+  },
+  // validation tab in builder form
+  validate: {
+    required: false,
+    plugins: undefined,
+  },
+  translatedErrors: {
+    nl: {
+      required: 'Je moet een waarde opgeven!!!',
+    },
+  },
+  errors: {
+    // translatedErrors is converted into errors by the backend
+    required: 'Je moet een waarde opgeven!!!',
+  },
+  // registration tab in builder form
+  registration: {
+    attribute: '',
+  },
+  // translations tab in builder form
+  openForms: {
+    translations: {
+      nl: {tooltip: 'bar'},
+    },
+  },
+});