@open-formulieren/types - npm Package Compare versions

Comparing version 0.27.0 to 0.28.0

lib/formio/base.d.ts

 import { ComponentSchema } from 'formiojs';
 import { ComponentTranslations, ErrorTranslations } from './i18n';
 import { ComponentErrorKeys, ComponentErrors, CuratedValidatorNames, OFValidateOptions } from './validation';
-export interface HasValidation<VN extends CuratedValidatorNames> {
-    validate?: OFValidateOptions<VN | 'plugins'>;
+/**
+ * The `HasValidation` interfaces encapsulates properties involved in validation.
+ *
+ * - The `validate` property defines the types for each possible Formio validator, e.g.
+ *   a `pattern` must be a string, while a `maxLength` must be a number. Open Forms
+ *   also supports backend validators that are called async, which is specified as a
+ *   list of strings for the validator names.
+ * - The `errors` property defines the (translated) error messages that may be returned
+ *   by the backend, at runtime. The possible keys are coupled with the possible
+ *   validator names in the `validate` property. The resulting strings are the strings
+ *   that are ultimately presented to the end user.
+ * - The `translatedErrors` property is used to store the translated error messages. The
+ *   keys are the supported language codes, the values have the same shape as the
+ *   `errors` property. Effectively, at runtime, this object is assigned for the active
+ *   language: `Object.assign(obj.errors, obj.translatedErrors[activeLanguage])`.
+ *
+ * There are some generics involed:
+ *
+ * - `VN`: the relevant validator names. Most components only use a small subset of
+ *   validator options depending on their type. E.g. a `pattern` makes no sense for a
+ *   number field, only for textfield/textarea etc. Likewise, `max` only has meaning for
+ *   numbers, but not for strings. Typically you pass in a union:
+ *   `'pattern' | 'maxLength'`. This generic is then used to populate the `errors` and
+ *   `translatedErrors` objects with only the relevant keys.
+ * - `WithPlugins` - most components support plugin validation, but the error messages
+ *   come from the server. The `plugins` key is never included in the `errors` and
+ *   `translatedErrors` objects. Pass `false` if plugin validation is not available for
+ *   the component.
+ */
+export interface HasValidation<VN extends CuratedValidatorNames, WithPlugins extends boolean = true> {
+    validate?: OFValidateOptions<WithPlugins extends true ? VN | 'plugins' : VN>;
     errors?: ComponentErrors<ComponentErrorKeys<VN>>;
@@ -7,0 +36,0 @@ translatedErrors?: ErrorTranslations<ComponentErrorKeys<VN>>;

lib/formio/components/addressNL.d.ts

@@ -1,3 +0,3 @@
-import { InputComponentSchema } from '..';
-import { ComponentTranslations, ErrorTranslations } from '../i18n';
+import { HasValidation, InputComponentSchema } from '..';
+import { ComponentTranslations } from '../i18n';
 type Validator = 'required';
@@ -14,11 +14,5 @@ type TranslatableKeys = 'label' | 'description' | 'tooltip';
 }
-export interface ComponentValidation {
-    validate: {
-        pattern: string;
-    };
-    translatedErrors: ErrorTranslations;
-}
 export interface AddressComponents {
-    postcode?: ComponentValidation;
-    city?: ComponentValidation;
+    postcode?: HasValidation<'pattern', false>;
+    city?: HasValidation<'pattern', false>;
 }
@@ -25,0 +19,0 @@ export type AddressNLInputSchema = InputComponentSchema<AddressData, Validator, TranslatableKeys>;

package.json

 {
   "name": "@open-formulieren/types",
-  "version": "0.27.0",
+  "version": "0.28.0",
   "description": "Typescript type definitions for Open Forms' Form.io extensions",
@@ -5,0 +5,0 @@ "main": "index.js",

New alerts

Long strings

Supply chain risk

Contains long string literals, which may be a sign of obfuscated or packed code.

Found 1 instance in 1 package

Fixed alerts

Long strings

Supply chain risk

Contains long string literals, which may be a sign of obfuscated or packed code.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

53915

3.45%

Lines of code

1357

1.72%

No dependency changes