oneentry 1.0.169 → 1.0.170

package/changelog.md

@@ -1,5 +1,19 @@
 # SDK Change Log
 
+## v.1.0.170
+
+### What's Changed
+
+- **`IAttributeValidators` named four validators of the eighteen the platform accepts.** The interface gave a shape to `requiredValidator`, `stringInspectionValidator`, `emailInspectionValidator` and `defaultValueValidator`, and closed with `[key: string]: unknown`; its JSDoc said only that the set is extensible. A developer reading the types learned that a required flag, a length constraint, an e-mail toggle and a default value exist, and did not learn that a **regular expression**, an **input mask**, a **whitespace trim** and **date bounds** exist — fourteen capabilities absent from the model of the platform, which on one pilot reached three client-facing documents as the sentence "a field has exactly four validators; there are no regular expressions and no phone check". All eighteen names are now declared with the shape the platform stores: `requiredValidator`, `trimValidator`, `stringInspectionValidator`, `urlInspectionValidator`, `emailInspectionValidator`, `checkForNumberValidator`, `roundingNumberValidator`, `booleanValidator`, `comparisonValidator`, `regExpValidator`, `fieldMaskValidator`, `checkForAGivenList`, `defaultValueValidator`, `sizeInPixelsValidator`, `checkingFilesValidator`, `minMaxDateValidator`, `valueValidator`, `checkForLettersValidator` (CMS-983).
+
+- **A misspelt validator name is a compile error instead of a `400`.** The index signature `[key: string]: unknown` made the gap silent in the other direction too: `emailValidator` typechecked and the platform refused the write at run time with `schema contains unknown validator name(s)`. The signature is gone, so an unknown name is caught where it is written. Code that still needs a name the SDK does not know can cast at that one place.
+
+- **Shapes follow what the platform executes, not what reads well.** `regExpValidator` takes `{ patternValue, invert, flags }` and not `{ regExp }`, `fieldMaskValidator` takes `{ maskValue }`, `checkForAGivenList` carries no `Validator` suffix, and `minMaxDateValidator` stores `minDateTimeValue` / `maxDateTimeValue`. The toggles — `requiredValidator`, `trimValidator`, `urlInspectionValidator`, `emailInspectionValidator` — are typed `object | boolean`, because both forms are in live data: an e-mail check is stored as the boolean `true` on seven fields of the stands checked and as an object on one. Every validator may also carry `customErrorText`, which is now in the type. `valueValidator` is kept with the same shape as `defaultValueValidator`: it is the panel's own name for that control, and the API stores it.
+
+- **The attribute JSDoc in `base/utils.ts` named `regexValidator`,** which does not exist. It points at `IAttributeValidators` for the full list instead.
+
+Types and documentation only; the wire format did not change.
+
 ## v.1.0.169
 
 ### What's Fixed

package/dist/attribute-sets/attributeSetsInterfaces.d.ts

@@ -189,28 +189,130 @@ interface IAttributeSchemaItem {
 }
 /**
  * @interface IAttributeValidators
- * @property {object} [requiredValidator] - Marks the field as required. Shape: `{ strict: boolean }`. Example: `{ strict: true }`.
- * @property {object} [stringInspectionValidator] - Length constraints for string fields. Shape: `{ stringMin: number; stringMax: number; stringLength: number }`.
- * @property {boolean} [emailInspectionValidator] - Toggle for email-format validation.
- * @property {object} [defaultValueValidator] - Default value configuration with optional custom error text. Shape: `{ customErrorText?: string; fieldDefaultValue?: unknown; fieldDefaultValue2?: unknown }`.
- * @description Map of validators applied to an attribute or form field. Set is extensible — additional validator types may be added by the API.
+ * @property {object | boolean} [requiredValidator] - Field must be filled in. Shape: `{ strict: boolean }`. Example: `{ strict: true }`.
+ * @property {object | boolean} [trimValidator] - Leading and trailing whitespace is stripped from the value. Stored as an empty object when the toggle is on. Example: `{}`.
+ * @property {object} [stringInspectionValidator] - Length constraints for string fields. Example: `{ stringLength: 0, stringMin: 2, stringMax: 60 }`.
+ * @property {object | boolean} [urlInspectionValidator] - Value must look like a URL. Stored either as `true` or as an object. Example: `true`.
+ * @property {object | boolean} [emailInspectionValidator] - Value must look like an e-mail address. Stored either as `true` or as an object. Example: `true`.
+ * @property {object} [checkForNumberValidator] - Value must be a number, optionally an integer within bounds. `0` disables a bound. Example: `{ integerOnly: true, minValue: 1, maxValue: 10 }`.
+ * @property {object} [roundingNumberValidator] - Rounds the number before storing it. Example: `{ integerOnly: false, numberOfDecimals: 2, direction: 'round' }`.
+ * @property {object} [booleanValidator] - Value must equal one of the two declared values. Example: `{ trueValue: 1, falseValue: 0 }`.
+ * @property {object} [comparisonValidator] - Compares the value with another attribute or with a constant. Example: `{ compareAttribute: 'notChoosed', compareValue: '10', type: 'number', operator: 'equality' }`.
+ * @property {object} [regExpValidator] - Value must match a regular expression; `invert` refuses matches instead. Example: `{ patternValue: '^[0-9]{5}$', invert: false, flags: ['i'] }`.
+ * @property {object} [fieldMaskValidator] - Value must match an input mask (`9` digit, `A` upper letter, `a` lower letter, `*` any, `$` one of `()+-`). Example: `{ maskValue: '+9 (999) 999-99-99' }`.
+ * @property {object} [checkForAGivenList] - Value must be in the list, or outside it when `notValue` is true. Example: `{ rangeValue: ['red', 'green'], notValue: false }`.
+ * @property {object} [defaultValueValidator] - Value substituted when the field is left empty. Example: `{ fieldDefaultValue: 'USD' }`.
+ * @property {object} [sizeInPixelsValidator] - Image bounds in pixels; executed by the admin panel. Example: `{ maxX: 1920, maxY: 1080 }`.
+ * @property {object} [checkingFilesValidator] - File size bounds and allowed extensions; executed by the admin panel. Example: `{ minValue: 0, maxValue: 5, minUnits: 'kb', maxUnits: 'mb', extensions: ['pdf'] }`.
+ * @property {object} [minMaxDateValidator] - Date bounds; executed by the admin panel. Example: `{ minDateTimeValue: '2026-01-01', maxDateTimeValue: '2026-12-31' }`.
+ * @property {object} [valueValidator] - The panel's "default value" control; it writes `defaultValueValidator`, and this name is kept because the API accepts and stores it. Example: `{ fieldDefaultValue: 'USD' }`.
+ * @property {object} [checkForLettersValidator] - Letters-only check by pattern; executed by the admin panel. Example: `{ patternValue: '^[A-Za-z ]+$' }`.
+ * @description Map of validators applied to an attribute or form field, keyed by validator name.
+ *
+ * These eighteen names are the full set the API accepts in
+ * `attributes_sets.schema.<attribute>.validators.<langCode>`; any other name is refused
+ * with `400`. The first thirteen are executed by the platform on write, the last five are
+ * stored as given and executed by the admin panel.
+ *
+ * Every validator may also carry `customErrorText` — the message shown instead of the
+ * default one when the value is refused.
  */
 interface IAttributeValidators {
     requiredValidator?: {
-        strict: boolean;
-    };
+        strict?: boolean;
+        customErrorText?: string;
+    } | boolean;
+    trimValidator?: {
+        strict?: boolean;
+        customErrorText?: string;
+    } | boolean;
     stringInspectionValidator?: {
-        stringMin: number;
-        stringMax: number;
-        stringLength: number;
+        stringMin?: number;
+        stringMax?: number;
+        stringLength?: number;
+        customErrorText?: string;
+    };
+    urlInspectionValidator?: {
+        strict?: boolean;
+        customErrorText?: string;
+    } | boolean;
+    emailInspectionValidator?: {
+        strict?: boolean;
+        customErrorText?: string;
+    } | boolean;
+    checkForNumberValidator?: {
+        integerOnly?: boolean;
+        minValue?: number;
+        maxValue?: number;
+        customErrorText?: string;
+    };
+    roundingNumberValidator?: {
+        integerOnly?: boolean;
+        numberOfDecimals?: number;
+        direction?: 'round' | 'up' | 'down' | 'truncate';
+        customErrorText?: string;
+    };
+    booleanValidator?: {
+        trueValue?: unknown;
+        falseValue?: unknown;
+        customErrorText?: string;
+    };
+    comparisonValidator?: {
+        compareAttribute?: string;
+        compareValue?: string;
+        compareValue2?: string;
+        type?: string;
+        operator?: string;
+        customErrorText?: string;
+    };
+    regExpValidator?: {
+        patternValue?: string;
+        invert?: boolean;
+        flags?: string[];
+        customErrorText?: string;
+    };
+    fieldMaskValidator?: {
+        maskValue?: string;
+        customErrorText?: string;
+    };
+    checkForAGivenList?: {
+        rangeValue?: unknown[];
+        rangeValue2?: unknown[];
+        notValue?: boolean;
+        customErrorText?: string;
     };
-    emailInspectionValidator?: boolean;
     defaultValueValidator?: {
+        fieldDefaultValue?: unknown;
+        fieldDefaultValue2?: unknown;
+        customErrorText?: string;
+    };
+    sizeInPixelsValidator?: {
+        maxX?: number;
+        maxY?: number;
         customErrorText?: string;
+    };
+    checkingFilesValidator?: {
+        minValue?: number;
+        maxValue?: number;
+        minUnits?: 'kb' | 'mb';
+        maxUnits?: 'kb' | 'mb';
+        extensions?: string[];
+        customErrorText?: string;
+    };
+    minMaxDateValidator?: {
+        minDateTimeValue?: string;
+        maxDateTimeValue?: string;
+        customErrorText?: string;
+    };
+    valueValidator?: {
         fieldDefaultValue?: unknown;
         fieldDefaultValue2?: unknown;
+        customErrorText?: string;
+    };
+    checkForLettersValidator?: {
+        patternValue?: string;
+        customErrorText?: string;
     };
-    [key: string]: unknown;
 }
 /**
  * Represents an attribute set entity.

package/dist/base/utils.d.ts

@@ -96,7 +96,7 @@ interface IConfig {
  * @property {boolean} isVisible - Whether the attribute is exposed in the public API/UI. Example: true.
  * @property {string} type - Attribute data type (e.g. "string", "integer", "list", "file", "image").
  * @property {Record<string, unknown>} [settings] - Type-specific configuration (e.g. min/max for numbers, accepted MIME types for files). Optional.
- * @property {Record<string, unknown>} validators - Validation rules applied to the attribute value (e.g. `requiredValidator`, `regexValidator`). Example: { "requiredValidator": { "strict": true } }.
+ * @property {Record<string, unknown>} validators - Validation rules applied to the attribute value, keyed by validator name (e.g. `requiredValidator`, `regExpValidator`); the full set of names is listed on `IAttributeValidators`. Example: { "requiredValidator": { "strict": true } }.
  * @property {Record<string, IAttributes>} [additionalFields] - Nested sub-attributes attached to this attribute, keyed by marker. Optional.
  * @property {boolean} [isIcon] - Block/preview attribute flag — whether the field is treated as an icon. Optional.
  * @property {boolean} [isProductPreview] - Block/preview attribute flag — whether the field is shown in product preview. Optional.

package/esm/attribute-sets/attributeSetsInterfaces.d.ts

@@ -189,28 +189,130 @@ interface IAttributeSchemaItem {
 }
 /**
  * @interface IAttributeValidators
- * @property {object} [requiredValidator] - Marks the field as required. Shape: `{ strict: boolean }`. Example: `{ strict: true }`.
- * @property {object} [stringInspectionValidator] - Length constraints for string fields. Shape: `{ stringMin: number; stringMax: number; stringLength: number }`.
- * @property {boolean} [emailInspectionValidator] - Toggle for email-format validation.
- * @property {object} [defaultValueValidator] - Default value configuration with optional custom error text. Shape: `{ customErrorText?: string; fieldDefaultValue?: unknown; fieldDefaultValue2?: unknown }`.
- * @description Map of validators applied to an attribute or form field. Set is extensible — additional validator types may be added by the API.
+ * @property {object | boolean} [requiredValidator] - Field must be filled in. Shape: `{ strict: boolean }`. Example: `{ strict: true }`.
+ * @property {object | boolean} [trimValidator] - Leading and trailing whitespace is stripped from the value. Stored as an empty object when the toggle is on. Example: `{}`.
+ * @property {object} [stringInspectionValidator] - Length constraints for string fields. Example: `{ stringLength: 0, stringMin: 2, stringMax: 60 }`.
+ * @property {object | boolean} [urlInspectionValidator] - Value must look like a URL. Stored either as `true` or as an object. Example: `true`.
+ * @property {object | boolean} [emailInspectionValidator] - Value must look like an e-mail address. Stored either as `true` or as an object. Example: `true`.
+ * @property {object} [checkForNumberValidator] - Value must be a number, optionally an integer within bounds. `0` disables a bound. Example: `{ integerOnly: true, minValue: 1, maxValue: 10 }`.
+ * @property {object} [roundingNumberValidator] - Rounds the number before storing it. Example: `{ integerOnly: false, numberOfDecimals: 2, direction: 'round' }`.
+ * @property {object} [booleanValidator] - Value must equal one of the two declared values. Example: `{ trueValue: 1, falseValue: 0 }`.
+ * @property {object} [comparisonValidator] - Compares the value with another attribute or with a constant. Example: `{ compareAttribute: 'notChoosed', compareValue: '10', type: 'number', operator: 'equality' }`.
+ * @property {object} [regExpValidator] - Value must match a regular expression; `invert` refuses matches instead. Example: `{ patternValue: '^[0-9]{5}$', invert: false, flags: ['i'] }`.
+ * @property {object} [fieldMaskValidator] - Value must match an input mask (`9` digit, `A` upper letter, `a` lower letter, `*` any, `$` one of `()+-`). Example: `{ maskValue: '+9 (999) 999-99-99' }`.
+ * @property {object} [checkForAGivenList] - Value must be in the list, or outside it when `notValue` is true. Example: `{ rangeValue: ['red', 'green'], notValue: false }`.
+ * @property {object} [defaultValueValidator] - Value substituted when the field is left empty. Example: `{ fieldDefaultValue: 'USD' }`.
+ * @property {object} [sizeInPixelsValidator] - Image bounds in pixels; executed by the admin panel. Example: `{ maxX: 1920, maxY: 1080 }`.
+ * @property {object} [checkingFilesValidator] - File size bounds and allowed extensions; executed by the admin panel. Example: `{ minValue: 0, maxValue: 5, minUnits: 'kb', maxUnits: 'mb', extensions: ['pdf'] }`.
+ * @property {object} [minMaxDateValidator] - Date bounds; executed by the admin panel. Example: `{ minDateTimeValue: '2026-01-01', maxDateTimeValue: '2026-12-31' }`.
+ * @property {object} [valueValidator] - The panel's "default value" control; it writes `defaultValueValidator`, and this name is kept because the API accepts and stores it. Example: `{ fieldDefaultValue: 'USD' }`.
+ * @property {object} [checkForLettersValidator] - Letters-only check by pattern; executed by the admin panel. Example: `{ patternValue: '^[A-Za-z ]+$' }`.
+ * @description Map of validators applied to an attribute or form field, keyed by validator name.
+ *
+ * These eighteen names are the full set the API accepts in
+ * `attributes_sets.schema.<attribute>.validators.<langCode>`; any other name is refused
+ * with `400`. The first thirteen are executed by the platform on write, the last five are
+ * stored as given and executed by the admin panel.
+ *
+ * Every validator may also carry `customErrorText` — the message shown instead of the
+ * default one when the value is refused.
  */
 interface IAttributeValidators {
     requiredValidator?: {
-        strict: boolean;
-    };
+        strict?: boolean;
+        customErrorText?: string;
+    } | boolean;
+    trimValidator?: {
+        strict?: boolean;
+        customErrorText?: string;
+    } | boolean;
     stringInspectionValidator?: {
-        stringMin: number;
-        stringMax: number;
-        stringLength: number;
+        stringMin?: number;
+        stringMax?: number;
+        stringLength?: number;
+        customErrorText?: string;
+    };
+    urlInspectionValidator?: {
+        strict?: boolean;
+        customErrorText?: string;
+    } | boolean;
+    emailInspectionValidator?: {
+        strict?: boolean;
+        customErrorText?: string;
+    } | boolean;
+    checkForNumberValidator?: {
+        integerOnly?: boolean;
+        minValue?: number;
+        maxValue?: number;
+        customErrorText?: string;
+    };
+    roundingNumberValidator?: {
+        integerOnly?: boolean;
+        numberOfDecimals?: number;
+        direction?: 'round' | 'up' | 'down' | 'truncate';
+        customErrorText?: string;
+    };
+    booleanValidator?: {
+        trueValue?: unknown;
+        falseValue?: unknown;
+        customErrorText?: string;
+    };
+    comparisonValidator?: {
+        compareAttribute?: string;
+        compareValue?: string;
+        compareValue2?: string;
+        type?: string;
+        operator?: string;
+        customErrorText?: string;
+    };
+    regExpValidator?: {
+        patternValue?: string;
+        invert?: boolean;
+        flags?: string[];
+        customErrorText?: string;
+    };
+    fieldMaskValidator?: {
+        maskValue?: string;
+        customErrorText?: string;
+    };
+    checkForAGivenList?: {
+        rangeValue?: unknown[];
+        rangeValue2?: unknown[];
+        notValue?: boolean;
+        customErrorText?: string;
     };
-    emailInspectionValidator?: boolean;
     defaultValueValidator?: {
+        fieldDefaultValue?: unknown;
+        fieldDefaultValue2?: unknown;
+        customErrorText?: string;
+    };
+    sizeInPixelsValidator?: {
+        maxX?: number;
+        maxY?: number;
         customErrorText?: string;
+    };
+    checkingFilesValidator?: {
+        minValue?: number;
+        maxValue?: number;
+        minUnits?: 'kb' | 'mb';
+        maxUnits?: 'kb' | 'mb';
+        extensions?: string[];
+        customErrorText?: string;
+    };
+    minMaxDateValidator?: {
+        minDateTimeValue?: string;
+        maxDateTimeValue?: string;
+        customErrorText?: string;
+    };
+    valueValidator?: {
         fieldDefaultValue?: unknown;
         fieldDefaultValue2?: unknown;
+        customErrorText?: string;
+    };
+    checkForLettersValidator?: {
+        patternValue?: string;
+        customErrorText?: string;
     };
-    [key: string]: unknown;
 }
 /**
  * Represents an attribute set entity.

package/esm/base/utils.d.ts

@@ -96,7 +96,7 @@ interface IConfig {
  * @property {boolean} isVisible - Whether the attribute is exposed in the public API/UI. Example: true.
  * @property {string} type - Attribute data type (e.g. "string", "integer", "list", "file", "image").
  * @property {Record<string, unknown>} [settings] - Type-specific configuration (e.g. min/max for numbers, accepted MIME types for files). Optional.
- * @property {Record<string, unknown>} validators - Validation rules applied to the attribute value (e.g. `requiredValidator`, `regexValidator`). Example: { "requiredValidator": { "strict": true } }.
+ * @property {Record<string, unknown>} validators - Validation rules applied to the attribute value, keyed by validator name (e.g. `requiredValidator`, `regExpValidator`); the full set of names is listed on `IAttributeValidators`. Example: { "requiredValidator": { "strict": true } }.
  * @property {Record<string, IAttributes>} [additionalFields] - Nested sub-attributes attached to this attribute, keyed by marker. Optional.
  * @property {boolean} [isIcon] - Block/preview attribute flag — whether the field is treated as an icon. Optional.
  * @property {boolean} [isProductPreview] - Block/preview attribute flag — whether the field is shown in product preview. Optional.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "oneentry",
-  "version": "1.0.169",
+  "version": "1.0.170",
   "description": "OneEntry NPM package",
   "main": "dist/index.js",
   "module": "esm/index.js",
@@ -48,7 +48,7 @@
   },
   "scripts": {
     "prepublishOnly": "node ../scripts/smoke-pack.js --files-only",
-    "postpublish": "node ../scripts/verify-published.js --named defineOneEntry --expect 1.0.169"
+    "postpublish": "node ../scripts/verify-published.js --named defineOneEntry --expect 1.0.170"
   },
   "sideEffects": false,
   "files": [