@naptics/vue-collection 1.0.0-beta.1 → 1.0.0-beta.2

package/src/lib/utils/validation.ts

@@ -1,189 +0,0 @@
-import { trsl } from '../i18n'
-
-export type ValidationResultValid = {
-    isValid: true
-    errorMessage?: undefined
-}
-
-export type ValidationResultInvalid = {
-    isValid: false
-    errorMessage: string
-}
-
-export type InputValue = string | null | undefined
-export type ValidationResult = ValidationResultValid | ValidationResultInvalid
-
-/**
- * A `ValidationRule` checks an input for a criteria and returns either
- * a {@link ValidationResultValid} or a {@link ValidationResultInvalid}.
- * A falsy input-value should always return a valid result to not interfere
- * with the {@link required} rule.
- */
-export type ValidationRule = (input: InputValue) => ValidationResult
-
-/**
- * Creates a valid result.
- */
-export function validResult(): ValidationResultValid {
-    return { isValid: true }
-}
-
-/**
- * Creates an invalid result with the provided error message.
- */
-export function invalidResult(errorMessage: string): ValidationResultInvalid {
-    return { isValid: false, errorMessage }
-}
-
-const TRANSLATION_KEY_BASE = 'vue-collection.validation.rules'
-function invalidResultInternal(key: string, params?: Record<string, unknown>): ValidationResultInvalid {
-    return invalidResult(trsl(`${TRANSLATION_KEY_BASE}.${key}`, params))
-}
-
-/**
- * Validates a given input with the specified rules.
- * The rules are evaluated in the order they're in the array.
- * The {@link ValidationResult} will either contain the errorMessage of the failed rule
- * or a valid result if all rules passed.
- * @param input the input to validate.
- * @param rules the rules which should be vaildated, in the order of priority.
- * @returns an object containing the result of the validation.
- */
-export function validate(input: InputValue, rules: ValidationRule[]): ValidationResult {
-    for (const rule of rules) {
-        const validationResult = rule(input)
-        if (!validationResult.isValid) return validationResult
-    }
-    return validResult()
-}
-
-/*
- * ---------- Validation Rules ----------
- */
-
-/**
- * This rule expects the trimmed input-value to be truthy.
- */
-export const required: ValidationRule = input => {
-    const trimmed = input?.trim()
-    if (trimmed) return validResult()
-    else return invalidResultInternal('required')
-}
-
-/**
- * This rule expects the input to be an integer.
- */
-export const integer: ValidationRule = input => {
-    if (!input || Number.isInteger(+input)) return validResult()
-    else return invalidResultInternal('integer')
-}
-
-/**
- * This rule expects the input to be in the specified length range. An empty input
- * will always be allowed by this rule to not interefere with the {@link required} rule.
- * @param min The minimum length of the string.
- * @param max The maximum length of the string.
- */
-export function length(min: number | undefined, max: number | undefined): ValidationRule {
-    return input => {
-        if (!input) return validResult()
-
-        if (min !== undefined && max !== undefined && !(min <= input.length && input.length <= max))
-            return invalidResultInternal('length.min-max', { min, max })
-        else if (min !== undefined && !(min <= input.length)) return invalidResultInternal('length.min', { min })
-        else if (max !== undefined && !(input.length <= max)) return invalidResultInternal('length.max', { max })
-
-        return validResult()
-    }
-}
-
-/**
- * This rule expects the input to be a number in the specified range.
- * @param min the lower bound, if `undefined` there is no lower bound.
- * @param max the upper bound, if `undefined` there is no upper bound.
- */
-export function numberRange(min: number | undefined, max: number | undefined): ValidationRule {
-    return input => {
-        if (!input) return validResult()
-
-        const parsed = Number.parseFloat(input)
-        if (Number.isNaN(parsed)) return invalidResultInternal('number-range.nan')
-
-        if (min !== undefined && max !== undefined && !(min <= parsed && parsed <= max))
-            return invalidResultInternal('number-range.min-max', { min, max })
-        else if (min !== undefined && !(min <= parsed)) return invalidResultInternal('number-range.min', { min })
-        else if (max !== undefined && !(parsed <= max)) return invalidResultInternal('number-range.max', { max })
-
-        return validResult()
-    }
-}
-
-export const VALIDATION_FORMAT_EMAIL = /^\w+([.-]?\w+)*@\w+([.-]?\w+)*(\.\w{2,3})+$/
-
-/**
- * This rule expects the input-value to be a valid email adress matching {@link VALIDATION_FORMAT_EMAIL}.
- */
-export const email: ValidationRule = input => {
-    if (!input || VALIDATION_FORMAT_EMAIL.test(input)) return validResult()
-    else return invalidResultInternal('email')
-}
-
-export const VALIDATION_FORMAT_PASSWORD = /^(?=.*[a-z])(?=.*[A-Z])(?=.*\d)(?=.*[#$^+\-=!*()@%&?]).{8,}$/
-
-/**
- * This rule expects the input-value to be a password matching {@link VALIDATION_FORMAT_PASSWORD}.
- */
-export const password: ValidationRule = input => {
-    if (!input || VALIDATION_FORMAT_PASSWORD.test(input)) return validResult()
-    else if (input.length < 8) return invalidResultInternal('password.to-short')
-    else if (!/[a-z]+/.test(input)) return invalidResultInternal('password.no-lowercase')
-    else if (!/[A-Z]+/.test(input)) return invalidResultInternal('password.no-uppercase')
-    else if (!/\d+/.test(input)) return invalidResultInternal('password.no-digits')
-    else if (!/[#$^+\-=!*()@%&?]+/.test(input)) return invalidResultInternal('password.no-special-chars')
-    else return invalidResultInternal('password.unknown')
-}
-
-/**
- * This rule expects the input-value to match another (input-) value.
- * In difference to most other rules, this rule does not always return a valid result,
- * when the input is falsy. The input is always required to match the other value.
- * @param other the other value to match
- */
-export function matches(other: string | null | undefined): ValidationRule {
-    return input => {
-        if (input === other) return validResult()
-        else return invalidResultInternal('matches')
-    }
-}
-
-/**
- * This rule expects the input-value to match one option in an array.
- * @param options the options which the input can match
- */
-export function option(options: string[]): ValidationRule {
-    return input => {
-        if (!input || options.includes(input || '')) return validResult()
-        else return invalidResultInternal('option')
-    }
-}
-
-/**
- * This rule expects the input-value to match the regex pattern
- * @param pattern the pattern the input should match.
- */
-export function regex(pattern: RegExp): ValidationRule {
-    return input => {
-        if (!input || pattern.test(input || '')) return validResult()
-        else return invalidResultInternal('regex')
-    }
-}
-
-/**
- * This rule can be used if the validation logic happens somewhere else.
- * When `isValid = true` is passed, the function will return a valid result,
- * otherwise it will return the invalid result with the passed `errorKey`.
- * Like always, a falsy input is always valid to not interefere with the {@link required} rule.
- */
-export function external(isValid: boolean, errorMessage: string): ValidationRule {
-    return input => (!input || isValid ? validResult() : invalidResult(errorMessage))
-}

package/src/lib/utils/vue.ts

@@ -1,25 +0,0 @@
-import { type Ref, watch, type ComputedRef } from 'vue'
-
-/**
- * Creates a watcher on the updater function, which sets the value of the ref on every change.
- * @param ref the ref to update
- * @param updater the updater funtion which provides the updates
- */
-export function updateWith<T>(ref: Ref<T>, updater: () => T): void {
-    watch(
-        updater,
-        newValue => {
-            ref.value = newValue
-        },
-        { immediate: true }
-    )
-}
-
-/**
- * Conveience function to create a watcher for a ref
- * @param ref the ref to watch
- * @param onChange the function, which is executed on change of a value
- */
-export function watchRef<T>(ref: Ref<T> | ComputedRef<T>, onChange: (newValue: T) => void): void {
-    watch(() => ref.value, onChange)
-}

package/tsconfig.config.json

@@ -1,9 +0,0 @@
-{
-    "extends": "@vue/tsconfig/tsconfig.json",
-    "include": ["vite.config.*", "vitest.config.*", "cypress.config.*"],
-    "compilerOptions": {
-        "composite": true,
-        "types": ["node"],
-        "noEmit": false
-    }
-}

package/tsconfig.demo.json

@@ -1,19 +0,0 @@
-{
-    "extends": "@vue/tsconfig/tsconfig.dom.json",
-    // all files must be included, because demo uses lib.
-    "include": ["env.d.ts", "src/**/*", "src/**/*.json"],
-    "exclude": ["src/**/__tests__/*"],
-    "compilerOptions": {
-        "composite": true,
-        "baseUrl": ".",
-        "paths": {
-            "@/*": ["./src/*"]
-        },
-        "jsx": "preserve",
-        "jsxImportSource": "vue",
-        "noImplicitAny": false,
-        "noUncheckedIndexedAccess": false,
-        "skipLibCheck": true,
-        "noEmit": false
-    }
-}

package/tsconfig.json

@@ -1,16 +0,0 @@
-{
-    "references": [
-        {
-            "path": "./tsconfig.config.json"
-        },
-        {
-            "path": "./tsconfig.demo.json"
-        },
-        {
-            "path": "./tsconfig.lib.json"
-        },
-        {
-            "path": "./tsconfig.vitest.json"
-        }
-    ]
-}

package/tsconfig.lib.json

@@ -1,19 +0,0 @@
-{
-    "extends": "@vue/tsconfig/tsconfig.dom.json",
-    "include": ["src/lib/**/*", "src/lib/**/*.json"],
-    "exclude": ["src/**/__tests__/*"],
-    "compilerOptions": {
-        "composite": true,
-        // don't allow @ alias inside library
-        "paths": {},
-        "outDir": "lib",
-        "jsx": "preserve",
-        "jsxImportSource": "vue",
-        "noImplicitAny": false,
-        "downlevelIteration": true,
-        "skipLibCheck": true,
-        "allowImportingTsExtensions": false,
-        "noEmit": false,
-        "declaration": true
-    }
-}

package/tsconfig.vitest.json

@@ -1,8 +0,0 @@
-{
-    "extends": "./tsconfig.lib.json",
-    "exclude": [],
-    "compilerOptions": {
-        "composite": true,
-        "types": ["node", "jsdom"]
-    }
-}

package/vite.config.ts

@@ -1,30 +0,0 @@
-import { fileURLToPath, URL } from 'url'
-import { defineConfig } from 'vite'
-import tailwindcss from '@tailwindcss/vite'
-import vue from '@vitejs/plugin-vue'
-import vueJsx from '@vitejs/plugin-vue-jsx'
-import vueI18n from '@intlify/unplugin-vue-i18n/vite'
-import { resolve, dirname } from 'path'
-
-const __dirname = dirname(fileURLToPath(import.meta.url))
-
-// https://vitejs.dev/config/
-export default defineConfig({
-    plugins: [
-        tailwindcss(),
-        vue(),
-        vueJsx(),
-        vueI18n({
-            compositionOnly: true,
-            runtimeOnly: false,
-            fullInstall: false,
-            include: resolve(__dirname, 'src/i18n/*'),
-        }),
-    ],
-    resolve: {
-        alias: {
-            '@': fileURLToPath(new URL('./src', import.meta.url)),
-        },
-    },
-    base: process.env.VITE_BASE_PATH,
-})