@naptics/vue-collection 0.0.2 → 0.0.4

package/utils/validation.js

@@ -1,9 +1,24 @@
 import { trsl } from '../i18n';
+/**
+ * Creates a valid result.
+ */
 export function validResult() {
-    return { isValid: true };
+  return {
+    isValid: true
+  };
+}
+/**
+ * Creates an invalid result with the provided error message.
+ */
+export function invalidResult(errorMessage) {
+  return {
+    isValid: false,
+    errorMessage
+  };
 }
-export function invalidResult(ruleKey, params) {
-    return { isValid: false, errorMessage: trsl(`vue-collection.validation.rules.${ruleKey}`, params) };
+const TRANSLATION_KEY_BASE = 'vue-collection.validation.rules';
+function invalidResultInternal(key, params) {
+  return invalidResult(trsl(`${TRANSLATION_KEY_BASE}.${key}`, params));
 }
 /**
  * Validates a given input with the specified rules.
@@ -15,12 +30,11 @@ export function invalidResult(ruleKey, params) {
  * @returns an object containing the result of the validation.
  */
 export function validate(input, rules) {
-    for (const rule of rules) {
-        const validationResult = rule(input);
-        if (!validationResult.isValid)
-            return validationResult;
-    }
-    return validResult();
+  for (const rule of rules) {
+    const validationResult = rule(input);
+    if (!validationResult.isValid) return validationResult;
+  }
+  return validResult();
 }
 /*
  * ---------- Validation Rules ----------
@@ -29,20 +43,14 @@ export function validate(input, rules) {
  * This rule expects the trimmed input-value to be truthy.
  */
 export const required = input => {
-    const trimmed = input?.trim();
-    if (trimmed)
-        return validResult();
-    else
-        return invalidResult('required');
+  const trimmed = input?.trim();
+  if (trimmed) return validResult();else return invalidResultInternal('required');
 };
 /**
  * This rule expects the input to be an integer.
  */
 export const integer = input => {
-    if (!input || Number.isInteger(+input))
-        return validResult();
-    else
-        return invalidResult('integer');
+  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
@@ -51,17 +59,18 @@ export const integer = input => {
  * @param max The maximum length of the string.
  */
 export function length(min, max) {
-    return input => {
-        if (!input)
-            return validResult();
-        if (min !== undefined && max !== undefined && !(min <= input.length && input.length <= max))
-            return invalidResult('length.min-max', { min, max });
-        else if (min !== undefined && !(min <= input.length))
-            return invalidResult('length.min', { min });
-        else if (max !== undefined && !(input.length <= max))
-            return invalidResult('length.max', { max });
-        return validResult();
-    };
+  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.
@@ -69,50 +78,34 @@ export function length(min, max) {
  * @param max the upper bound, if `undefined` there is no upper bound.
  */
 export function numberRange(min, max) {
-    return input => {
-        if (!input)
-            return validResult();
-        const parsed = Number.parseFloat(input);
-        if (Number.isNaN(parsed))
-            return invalidResult('number-range.nan');
-        if (min !== undefined && max !== undefined && !(min <= parsed && parsed <= max))
-            return invalidResult('number-range.min-max', { min, max });
-        else if (min !== undefined && !(min <= parsed))
-            return invalidResult('number-range.min', { min });
-        else if (max !== undefined && !(parsed <= max))
-            return invalidResult('number-range.max', { max });
-        return validResult();
-    };
+  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 = input => {
-    if (!input || VALIDATION_FORMAT_EMAIL.test(input))
-        return validResult();
-    else
-        return invalidResult('email');
+  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 = input => {
-    if (!input || VALIDATION_FORMAT_PASSWORD.test(input))
-        return validResult();
-    else if (input.length < 8)
-        return invalidResult('password.to-short');
-    else if (!/[a-z]+/.test(input))
-        return invalidResult('password.no-lowercase');
-    else if (!/[A-Z]+/.test(input))
-        return invalidResult('password.no-uppercase');
-    else if (!/\d+/.test(input))
-        return invalidResult('password.no-digits');
-    else if (!/[#$^+\-=!*()@%&?]+/.test(input))
-        return invalidResult('password.no-special-chars');
-    else
-        return invalidResult('password.unknown');
+  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.
@@ -121,43 +114,34 @@ export const password = input => {
  * @param other the other value to match
  */
 export function matches(other) {
-    return input => {
-        if (input === other)
-            return validResult();
-        else
-            return invalidResult('matches');
-    };
+  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) {
-    return input => {
-        if (!input || options.includes(input || ''))
-            return validResult();
-        else
-            return invalidResult('option');
-    };
+  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) {
-    return input => {
-        if (!input || pattern.test(input || ''))
-            return validResult();
-        else
-            return invalidResult('regex');
-    };
+  return input => {
+    if (!input || pattern.test(input || '')) return validResult();else return invalidResultInternal('regex');
+  };
 }
 /**
- * This rule can be used if the validation logic happens somwhere else.
+ * 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, errorKey) {
-    return input => (!input || isValid ? validResult() : invalidResult(errorKey));
-}
+export function external(isValid, errorMessage) {
+  return input => !input || isValid ? validResult() : invalidResult(errorMessage);
+}

package/utils/vue.js

@@ -5,9 +5,11 @@ import { watch } from 'vue';
  * @param updater the updater funtion which provides the updates
  */
 export function updateWith(ref, updater) {
-    watch(updater, newValue => {
-        ref.value = newValue;
-    }, { immediate: true });
+  watch(updater, newValue => {
+    ref.value = newValue;
+  }, {
+    immediate: true
+  });
 }
 /**
  * Conveience function to create a watcher for a ref
@@ -15,5 +17,5 @@ export function updateWith(ref, updater) {
  * @param onChange the function, which is executed on change of a value
  */
 export function watchRef(ref, onChange) {
-    watch(() => ref.value, onChange);
-}
+  watch(() => ref.value, onChange);
+}

package/i18n/de/template.json

@@ -1,10 +0,0 @@
-{
-    "title": {},
-    "subtitle": {},
-    "text": {},
-    "property": {},
-    "term": {},
-    "action": {},
-    "enum": {},
-    "error": {}
-}

package/i18n/de.d.ts

@@ -1,61 +0,0 @@
-declare const de: {
-    "vue-collection": {
-        title: {};
-        subtitle: {};
-        text: {
-            "loading-search-results": string;
-            "no-search-results": string;
-            "drag-n-drop-files": string;
-            "files-selected": string;
-        };
-        property: {};
-        term: {};
-        action: {
-            search: string;
-            select: string;
-            remove: string;
-            cancel: string;
-            "all-right": string;
-            proceed: string;
-            save: string;
-            "clear-files": string;
-        };
-        enum: {};
-        error: {
-            "file-type": string;
-            "file-size": string;
-            "too-many-files": string;
-        };
-        validation: {
-            rules: {
-                email: string;
-                integer: string;
-                length: {
-                    min: string;
-                    max: string;
-                    "min-max": string;
-                };
-                matches: string;
-                "number-range": {
-                    nan: string;
-                    min: string;
-                    max: string;
-                    "min-max": string;
-                };
-                option: string;
-                password: {
-                    "to-short": string;
-                    "no-lowercase": string;
-                    "no-uppercase": string;
-                    "no-digits": string;
-                    "no-special-chars": string;
-                    unknown: string;
-                };
-                phone: string;
-                required: string;
-                regex: string;
-            };
-        };
-    };
-};
-export default de;

package/i18n/de.js

@@ -1,5 +0,0 @@
-import vueCollection from './de/vue-collection.json';
-const de = {
-    ['vue-collection']: vueCollection,
-};
-export default de;

package/i18n/en/template.json

@@ -1,10 +0,0 @@
-{
-    "title": {},
-    "subtitle": {},
-    "text": {},
-    "property": {},
-    "term": {},
-    "action": {},
-    "enum": {},
-    "error": {}
-}

package/i18n/en.d.ts

@@ -1,61 +0,0 @@
-declare const en: {
-    "vue-collection": {
-        title: {};
-        subtitle: {};
-        text: {
-            "loading-search-results": string;
-            "no-search-results": string;
-            "drag-n-drop-files": string;
-            "files-selected": string;
-        };
-        property: {};
-        term: {};
-        action: {
-            search: string;
-            select: string;
-            remove: string;
-            cancel: string;
-            "all-right": string;
-            proceed: string;
-            save: string;
-            "clear-files": string;
-        };
-        enum: {};
-        error: {
-            "file-type": string;
-            "file-size": string;
-            "too-many-files": string;
-        };
-        validation: {
-            rules: {
-                email: string;
-                integer: string;
-                length: {
-                    min: string;
-                    max: string;
-                    "min-max": string;
-                };
-                matches: string;
-                "number-range": {
-                    nan: string;
-                    min: string;
-                    max: string;
-                    "min-max": string;
-                };
-                option: string;
-                password: {
-                    "to-short": string;
-                    "no-lowercase": string;
-                    "no-uppercase": string;
-                    "no-digits": string;
-                    "no-special-chars": string;
-                    unknown: string;
-                };
-                phone: string;
-                required: string;
-                regex: string;
-            };
-        };
-    };
-};
-export default en;

package/i18n/en.js

@@ -1,5 +0,0 @@
-import vueCollection from './en/vue-collection.json';
-const en = {
-    ['vue-collection']: vueCollection,
-};
-export default en;