@uxf/core 11.127.0 → 11.129.0

package/README.md

@@ -1,5 +1,9 @@
 # UXF Core
 
+Framework-agnostic helpers shared by every `@uxf/*` package: constants, value helpers (money, dates, QR, cookies), a large set of small utils and validators.
+
+There is no root entry point – every symbol is imported from its own deep path, e.g. `import { isNil } from "@uxf/core/utils/is-nil";`. Import paths in this document are the ones to copy.
+
 ## Constants
 
 - common modifier classnames for interactive elements (eg. `CLASSES.IS_HOVERABLE` for is-hoverable classname)
@@ -26,7 +30,7 @@
 ```json
 [
     {
-        "route": "/generated/static/:width(\\d+|x)_:height(\\d+|x)_:fit([a-z]+)_:position([a-z]+)_:background([a-z]+)_:trim([a-z]+)_:quality(\\d+|x)/:version/:filename(*).:extension.:toFormat",
+        "route": "/generated/static/:width(\\d+|x)_:height(\\d+|x)_:fit([a-z]+)_:position([a-z]+)_:background([a-z]+)_:trim([a-z]+)_:quality(\\d+|x)/:version/:filename(.*).:extension.:toFormat",
         "source": "https://uxf-base.uxf.dev/:filename+.:extension"
     },
     {
@@ -821,9 +825,50 @@ const example = trimTrailingZeros("120,450"); /* returns "120,45" */
 
 ## Validators
 
+Predicates returning a plain `boolean`.
+
 ```tsx
-import { Validator } from "@uxf/core";
+import { Validator } from "@uxf/core/validators/validator";
 
-Validator.isEmail("...");
-Validator.isPhone("...");
+Validator.isEmail("dev@uxf.cz"); /* returns true */
+Validator.isPhone("777 888 999"); /* returns true */
 ```
+
+| Validator           | Signature                    | Accepts                                                                      |
+| ------------------- | ---------------------------- | ---------------------------------------------------------------------------- |
+| `Validator.isEmail` | `(email: string) => boolean` | `local@domain.tld`                                                           |
+| `Validator.isPhone` | `(phone: string) => boolean` | 9 digits, optional spaces, optional `+420` / `00420` prefix (1–3 digit code) |
+
+### FormValidator
+
+Field-level validators built on top of `Validator`. Each one takes an optional error message and
+returns a validation function that yields the message when the value is invalid, or `undefined`
+when it passes – the shape a `@uxf/form` field validator expects.
+
+```tsx
+import { FormValidator } from "@uxf/core/validators/form-validator";
+
+FormValidator.required()(""); /* returns "Vyplňte." */
+FormValidator.isEmail("Zadejte e-mail.")("dev@uxfcz"); /* returns "Zadejte e-mail." */
+FormValidator.isLessThan(10)("9.9"); /* returns undefined */
+```
+
+| Validator              | Signature                                              | Passes when                                               |
+| ---------------------- | ------------------------------------------------------ | --------------------------------------------------------- |
+| `required`             | `(errorMessage?) => (value: unknown)`                  | value is not `null`, `undefined` or `""`                  |
+| `isEmail`              | `(errorMessage?) => (value: string)`                   | value is empty, or `Validator.isEmail` accepts it         |
+| `isPhone`              | `(errorMessage?) => (value: string)`                   | value is empty, or `Validator.isPhone` accepts it         |
+| `isLessThan`           | `(maxValue: number, errorMessage?) => (value: string)` | value is `""`, or `Number.parseFloat(value) < maxValue`   |
+| `isLessOrEqualThan`    | `(maxValue: number, errorMessage?) => (value: string)` | value is `""`, or `Number.parseFloat(value) <= maxValue`  |
+| `isGreaterThan`        | `(minValue: number, errorMessage?) => (value: string)` | value is empty, or `Number.parseFloat(value) > minValue`  |
+| `isGreaterOrEqualThan` | `(minValue: number, errorMessage?) => (value: string)` | value is empty, or `Number.parseFloat(value) >= minValue` |
+
+Gotchas:
+
+- Every validator except `required` treats an empty value as valid. Combine them with `required` to
+  enforce presence.
+- `required` only rejects `null`, `undefined` and `""` – `0` and `false` pass.
+- The numeric validators compare `Number.parseFloat(value)`, and every comparison against `NaN` is
+  `false`, so a non-numeric string such as `"abc"` passes all four.
+- The default error messages are Czech (`"Vyplňte."`, `"E-mail není validní"`, …). Pass your own
+  message for any other language.

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@uxf/core",
-    "version": "11.127.0",
+    "version": "11.129.0",
     "description": "UXF Core",
     "author": "Petr Vejvoda <vejvoda@uxf.cz>",
     "homepage": "https://gitlab.com/uxf-npm/core#readme",

package/utils/resizer.js

@@ -83,7 +83,7 @@ function resizerImageUrl(source, width = "auto", height = "auto", props = {}, ve
 function resizerGetDefaultConfig(generatedFilesUrl, staticFilesUrl) {
     return [
         {
-            route: "/generated/static/:width(\\d+|x)_:height(\\d+|x)_:fit([a-z]+)_:position([a-z]+)_:background([a-z]+)_:trim([a-z]+)_:quality(\\d+|x)/:version/:filename(*).:extension.:toFormat",
+            route: "/generated/static/:width(\\d+|x)_:height(\\d+|x)_:fit([a-z]+)_:position([a-z]+)_:background([a-z]+)_:trim([a-z]+)_:quality(\\d+|x)/:version/:filename(.*).:extension.:toFormat",
             source: `${staticFilesUrl}/:filename+.:extension`,
         },
         {

package/utils/resizer.test.js

@@ -71,7 +71,7 @@ describe("resizerGetDefaultConfig", () => {
         const staticFilesUrl = "http://example.com/static";
         const expectedConfig = [
             {
-                route: "/generated/static/:width(\\d+|x)_:height(\\d+|x)_:fit([a-z]+)_:position([a-z]+)_:background([a-z]+)_:trim([a-z]+)_:quality(\\d+|x)/:version/:filename(*).:extension.:toFormat",
+                route: "/generated/static/:width(\\d+|x)_:height(\\d+|x)_:fit([a-z]+)_:position([a-z]+)_:background([a-z]+)_:trim([a-z]+)_:quality(\\d+|x)/:version/:filename(.*).:extension.:toFormat",
                 source: `${staticFilesUrl}/:filename+.:extension`,
             },
             {

package/index.d.ts

@@ -1,2 +0,0 @@
-export * from "./validators/form-validator";
-export * from "./validators/validator";

package/index.js

@@ -1,19 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-// TODO @vejvis - remove me
-__exportStar(require("./validators/form-validator"), exports);
-__exportStar(require("./validators/validator"), exports);