@fvc/utils 3.0.1 → 3.0.2-next-ec65dfb844e6183b3d7f417eee613cfe5ecfd997

package/README.md

@@ -0,0 +1,112 @@
+# @fvc/utils
+
+`@fvc/utils` provides shared utility functions used across the FE-VIS component library. It includes locale-aware text transformation with Azerbaijani character support, CSS custom property resolution for typography props, numeric validation, and a value clamping helper.
+
+## Installation
+
+```bash
+bun add @fvc/utils
+```
+
+## Peer Dependencies
+
+The package expects these dependencies to be available in the consuming application:
+
+```bash
+bun add react
+```
+
+## Import
+
+```tsx
+import { clamp, cssVarResolver, isNumeric, transformText } from '@fvc/utils';
+```
+
+## Quick Start
+
+```tsx
+import { transformText, clamp, cssVarResolver, isNumeric } from '@fvc/utils';
+
+transformText('salam', 'uppercase', 'az'); // 'SALAM'
+clamp({ value: 150, min: 0, max: 100 });   // 100
+cssVarResolver(16);                         // '16px'
+isNumeric('42');                            // true
+```
+
+## API
+
+### `transformText`
+
+Transforms a string with locale-aware casing. Has built-in character mappings for Azerbaijani (`az`) to correctly handle `i ↔ İ` and `ı ↔ I` conversions.
+
+```ts
+transformText(text: string, transformType: TextTransform, locale?: string): string
+```
+
+| Parameter       | Type            | Default | Description                                               |
+| --------------- | --------------- | ------- | --------------------------------------------------------- |
+| `text`          | `string`        | —       | The input string to transform.                            |
+| `transformType` | `TextTransform` | —       | `'uppercase'`, `'lowercase'`, `'capitalize'`, `'integer'` |
+| `locale`        | `string`        | `'az'`  | BCP 47 locale tag used for case mapping.                  |
+
+```tsx
+transformText('istanbul', 'uppercase', 'az'); // 'İSTANBUL'
+transformText('İstanbul', 'lowercase', 'az'); // 'istanbul'
+transformText('hello world', 'capitalize');   // 'Hello World'
+transformText('3.14', 'integer');             // '3'
+```
+
+### `clamp`
+
+Clamps a numeric value between a minimum and maximum.
+
+```ts
+clamp({ value: number, min: number, max: number }): number
+```
+
+```tsx
+clamp({ value: -5, min: 0, max: 100 });  // 0
+clamp({ value: 50, min: 0, max: 100 });  // 50
+clamp({ value: 200, min: 0, max: 100 }); // 100
+```
+
+### `cssVarResolver`
+
+Converts a `size` or `weight` value to a CSS-compatible string. Numbers are suffixed with `px`; strings are returned as-is.
+
+```ts
+cssVarResolver(value?: string | number): string | undefined
+```
+
+```tsx
+cssVarResolver(16);        // '16px'
+cssVarResolver('1.5rem');  // '1.5rem'
+cssVarResolver(undefined); // undefined
+```
+
+### `isNumeric`
+
+Returns `true` when the value consists entirely of digit characters (`0–9`).
+
+```ts
+isNumeric(value?: string | number): boolean
+```
+
+```tsx
+isNumeric('100');  // true
+isNumeric('10.5'); // false — decimal point is not a digit
+isNumeric('');     // false
+```
+
+## TypeScript
+
+The package ships with type definitions. No `@types/` install needed.
+
+## Development
+
+```bash
+bun run lint
+bun run type-check
+bun run test
+bun run build
+```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fvc/utils",
-  "version": "3.0.1",
+  "version": "3.0.2-next-ec65dfb844e6183b3d7f417eee613cfe5ecfd997",
   "main": "./dist/lib/index.js",
   "types": "./dist/lib/utils/src/index.d.ts",
   "exports": {
@@ -24,6 +24,16 @@
     "type-check": "tsc --noEmit",
     "test": "bun test --preload ../../tests/happydom.ts --preload ../../tests/testing-library.tsx"
   },
+  "keywords": [
+    "react",
+    "react-component",
+    "fvc",
+    "fe-vis-core",
+    "utils",
+    "utilities",
+    "helpers",
+    "design-system"
+  ],
   "peerDependencies": {
     "react": "^18.0.0"
   }