numora 2.0.4 → 3.0.0

package/dist/types.d.ts

@@ -0,0 +1,34 @@
+export declare enum FormatOn {
+    Blur = "blur",
+    Change = "change"
+}
+export declare enum ThousandStyle {
+    None = "none",
+    Thousand = "thousand",
+    Lakh = "lakh",
+    Wan = "wan"
+}
+export interface FormattingOptions {
+    formatOn?: FormatOn;
+    thousandSeparator?: string;
+    ThousandStyle?: ThousandStyle;
+    enableCompactNotation?: boolean;
+    enableNegative?: boolean;
+    enableLeadingZeros?: boolean;
+    decimalSeparator?: string;
+    decimalMinLength?: number;
+    rawValueMode?: boolean;
+}
+export interface CaretPositionInfo {
+    selectionStart?: number;
+    selectionEnd?: number;
+    endOffset?: number;
+}
+export interface SeparatorOptions {
+    decimalSeparator?: string;
+    thousandSeparator?: string;
+}
+export interface Separators {
+    decimalSeparator: string;
+    thousandSeparator?: string;
+}

package/dist/utils/escape-reg-exp.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Shared utility functions used across multiple features.
+ */
+/**
+ * Escapes special regex characters in a string.
+ * This is used when building regex patterns from user-provided separator characters.
+ *
+ * @param str - The string to escape
+ * @returns The escaped string safe for use in regex patterns
+ *
+ * @example
+ * escapeRegExp(".") // Returns: "\\."
+ * escapeRegExp("$") // Returns: "\\$"
+ * escapeRegExp("1,234") // Returns: "1\\,234"
+ */
+export declare function escapeRegExp(str: string): string;

package/dist/utils/event-handlers.d.ts

@@ -0,0 +1,31 @@
+import { type FormattingOptions, type CaretPositionInfo } from '@/types';
+/**
+ * Handles the keydown event to prevent the user from entering a second decimal point.
+ * Also tracks selection info for Delete/Backspace keys to enable proper cursor positioning.
+ * In 'change' mode with formatting, skips cursor over thousand separators on delete/backspace.
+ *
+ * @param e - The keyboard event triggered by the input.
+ * @param formattingOptions - Optional formatting options for separator skipping
+ * @returns Caret position info if Delete/Backspace was pressed, undefined otherwise
+ */
+export declare function handleOnKeyDownNumoraInput(e: KeyboardEvent, formattingOptions?: FormattingOptions): CaretPositionInfo | undefined;
+/**
+ * Handles the input change event to ensure the value does not exceed the maximum number of decimal places,
+ * replaces commas with dots, and removes invalid non-numeric characters.
+ * Also handles cursor positioning for Delete/Backspace keys.
+ * Optionally formats with thousand separators in real-time if formatOn is 'change'.
+ *
+ * @param e - The event triggered by the input.
+ * @param decimalMaxLength - The maximum number of decimal places allowed.
+ * @param caretPositionBeforeChange - Optional caret position info from keydown handler
+ * @param formattingOptions - Optional formatting options for real-time formatting
+ * @returns Object with formatted value and raw value
+ */
+export declare function handleOnChangeNumoraInput(e: Event, decimalMaxLength: number, caretPositionBeforeChange?: CaretPositionInfo, formattingOptions?: FormattingOptions): {
+    formatted: string;
+    raw: string;
+};
+export declare function handleOnPasteNumoraInput(e: ClipboardEvent, decimalMaxLength: number, formattingOptions?: FormattingOptions): {
+    formatted: string;
+    raw: string;
+};

package/dist/utils/format-utils.d.ts

@@ -0,0 +1,28 @@
+import { type FormattingOptions } from '@/types';
+/**
+ * Formats a value from user input events (onChange, onBlur) by sanitizing, trimming decimals, and applying formatting.
+ * The behavior adapts based on formatOn mode - removes separators in 'change' mode since they'll be re-added.
+ *
+ * @param rawValue - The raw input value from the user event
+ * @param decimalMaxLength - Maximum number of decimal places allowed
+ * @param formattingOptions - Optional formatting options
+ * @param shouldRemoveThousandSeparators - Whether to remove thousand separators during sanitization (default: determined by formatOn)
+ * @returns Object with formatted value and raw value (raw value is the value before formatting)
+ */
+export declare function formatInputValue(rawValue: string, decimalMaxLength: number, formattingOptions?: FormattingOptions, shouldRemoveThousandSeparators?: boolean): {
+    formatted: string;
+    raw: string;
+};
+/**
+ * Formats a value for display (e.g., initial values, controlled values).
+ * Assumes the value might already contain thousand separators, so removes them before processing.
+ *
+ * @param value - The value to format for display
+ * @param decimalMaxLength - Maximum number of decimal places allowed
+ * @param formattingOptions - Optional formatting options
+ * @returns Object with formatted value and raw value
+ */
+export declare function formatValueForDisplay(value: string, decimalMaxLength: number, formattingOptions?: FormattingOptions): {
+    formatted: string;
+    raw: string;
+};

package/dist/utils/input-pattern.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Builds an input pattern that allows optional negative sign and a single custom decimal separator.
+ * The separator is escaped so any character can be safely used.
+ */
+export declare function getNumoraPattern(decimalSeparator: string, enableNegative: boolean): string;

package/dist/validation.d.ts

@@ -0,0 +1,20 @@
+import { FormatOn } from './types';
+import { ThousandStyle } from './types';
+export interface NumoraInputValidationOptions {
+    decimalMaxLength?: number;
+    decimalMinLength?: number;
+    formatOn?: FormatOn;
+    thousandSeparator?: string;
+    thousandStyle?: ThousandStyle;
+    decimalSeparator?: string;
+    enableCompactNotation?: boolean;
+    enableNegative?: boolean;
+    enableLeadingZeros?: boolean;
+    rawValueMode?: boolean;
+    onChange?: (value: string) => void;
+}
+/**
+ * Validates all NumoraInput constructor parameters.
+ * Throws descriptive errors for invalid values.
+ */
+export declare function validateNumoraInputOptions(options: NumoraInputValidationOptions): void;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "numora",
-  "version": "2.0.4",
+  "version": "3.0.0",
   "description": "Precision-first numeric input library for DeFi and financial applications",
   "homepage": "https://numora.xyz/",
   "main": "dist/index.js",
@@ -61,7 +61,7 @@
     "access": "public"
   },
   "scripts": {
-    "build": "vite build && tsc --emitDeclarationOnly",
+    "build": "vite build & tsc --emitDeclarationOnly",
     "test": "vitest run",
     "dev": "vite build --watch"
   }