@splitty-test/validation 0.1.0 → 0.1.2

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Ronnie Garcia
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,39 +1,9 @@
 # validation
 
-This template should help get you started developing with Vue 3 in Vite.
+This is a validation library for Vue 3 that is both simple but powerful. More documentation is coming soon.
 
-## Recommended IDE Setup
+## Installation
 
-[VSCode](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) (and disable Vetur).
-
-## Type Support for `.vue` Imports in TS
-
-TypeScript cannot handle type information for `.vue` imports by default, so we replace the `tsc` CLI with `vue-tsc` for type checking. In editors, we need [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) to make the TypeScript language service aware of `.vue` types.
-
-## Customize configuration
-
-See [Vite Configuration Reference](https://vite.dev/config/).
-
-## Project Setup
-
-```sh
-npm install
-```
-
-### Compile and Hot-Reload for Development
-
-```sh
-npm run dev
 ```
-
-### Type-Check, Compile and Minify for Production
-
-```sh
-npm run build
-```
-
-### Lint with [ESLint](https://eslint.org/)
-
-```sh
-npm run lint
+npm install @splitty-test/validation
 ```

package/dist/FieldValidation.vue.d.ts

@@ -0,0 +1,54 @@
+import { PropType } from 'vue';
+import { Validator } from './ValidatorClass';
+import { ValidationRule } from './FieldValidatorClass';
+declare const _default: import('vue').DefineComponent<import('vue').ExtractPropTypes<{
+    name: {
+        type: StringConstructor;
+        required: true;
+    };
+    hideError: BooleanConstructor;
+    modelValue: {
+        type: null;
+    };
+    modelModifiers: {
+        default: () => {};
+    };
+    rules: {
+        type: PropType<ValidationRule[]>;
+        default(): never[];
+    };
+    validator: {
+        type: typeof Validator;
+        required: true;
+    };
+}>, {}, {
+    form_fields: HTMLElement[];
+}, {
+    field(): import('./FieldValidatorClass').FieldValidator;
+    error(): string | null | undefined;
+}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
+    name: {
+        type: StringConstructor;
+        required: true;
+    };
+    hideError: BooleanConstructor;
+    modelValue: {
+        type: null;
+    };
+    modelModifiers: {
+        default: () => {};
+    };
+    rules: {
+        type: PropType<ValidationRule[]>;
+        default(): never[];
+    };
+    validator: {
+        type: typeof Validator;
+        required: true;
+    };
+}>> & Readonly<{}>, {
+    hideError: boolean;
+    modelModifiers: {};
+    rules: ValidationRule[];
+}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
+export default _default;

package/dist/FieldValidatorClass.d.ts

@@ -0,0 +1,22 @@
+import { Validator } from './ValidatorClass';
+export interface FieldValidatorConfig {
+    value: any;
+    rules: ValidationRule[];
+    group?: string;
+}
+export type ValidationRule = (value: any, ...args: any) => Promise<string | null> | (string | null);
+export declare class FieldValidator {
+    controls: HTMLElement[];
+    dirty: boolean;
+    errors: string[];
+    group?: string;
+    rules: ValidationRule[];
+    touched: boolean;
+    validated: boolean;
+    validator: Validator;
+    value: any;
+    constructor(config: FieldValidatorConfig, validator: Validator);
+    get isValid(): boolean;
+    reset(): void;
+    validate(): Promise<boolean>;
+}

package/dist/ValidatorClass.d.ts

@@ -0,0 +1,24 @@
+import { FieldValidator, FieldValidatorConfig } from './FieldValidatorClass';
+export interface ValidatorConfig {
+    fields?: Record<string, FieldValidatorConfig>;
+}
+export interface ValidationGroup {
+    dirty: boolean;
+    fields: Record<string, FieldValidator>;
+    touched: boolean;
+    validated: boolean;
+}
+export declare class Validator {
+    dirty: boolean;
+    errors: string[];
+    fields: Record<string, FieldValidator>;
+    groups: Record<string, ValidationGroup>;
+    touched: boolean;
+    validated: boolean;
+    constructor(config?: ValidatorConfig);
+    isValid(group_name?: string): boolean;
+    reset(group_name?: string): void;
+    addField(field_name: string, field_config: FieldValidatorConfig): void;
+    removeField(field_name: string): void;
+    validate(group_name?: string): Promise<void>;
+}

package/{lib/index.ts → dist/index.d.ts}

@@ -1,6 +1,5 @@
 import { Validator } from './ValidatorClass';
 import { FieldValidator } from './FieldValidatorClass';
-import FieldValidation from './FieldValidation.vue';
+import { default as FieldValidation } from './FieldValidation.vue';
 import * as rules from './rules';
-
 export { Validator, FieldValidator, FieldValidation, rules };