@naptics/vue-collection 0.0.3 → 0.0.4

package/utils/utils.js

@@ -1,12 +1,12 @@
 export function markReadonly(object) {
-    return object;
+  return object;
 }
 let currentId = 1;
 /**
  * Generates and returns a non random but unique id.
  */
 export function uniqueId() {
-    return currentId++;
+  return currentId++;
 }
 /**
  * Determines if a value is not null or undefined.
@@ -14,7 +14,7 @@ export function uniqueId() {
  * @returns `true` if the value is anything but `null` or `undefined`.
  */
 export function notNullish(value) {
-    return value !== null && value !== undefined;
+  return value !== null && value !== undefined;
 }
 /**
  * Determines if a value is null or undefined.
@@ -22,5 +22,5 @@ export function notNullish(value) {
  * @returns `true` if the value is `null` or `undefined`.
  */
 export function isNullish(value) {
-    return value === null || value === undefined;
-}
+  return value === null || value === undefined;
+}

package/utils/vModel.js

@@ -8,54 +8,54 @@
  * @returns An object containing the value-property and the update-function.
  */
 export function vModelProps(propType) {
-    return {
-        /**
-         * The value of the component.
-         */
-        value: propType,
-        /**
-         * This will be called, when the value of the component has changed.
-         */
-        onUpdateValue: Function,
-    };
+  return {
+    /**
+     * The value of the component.
+     */
+    value: propType,
+    /**
+     * This will be called, when the value of the component has changed.
+     */
+    onUpdateValue: Function
+  };
 }
 /**
  * Creates props for a required `v-model` of the given type.
  * @see {@link vModelProps}
  */
 export function vModelRequiredProps(propType) {
-    return {
-        /**
-         * The value of the component.
-         */
-        value: {
-            type: propType,
-            required: true,
-        },
-        /**
-         * This will be called, when the value of the component has changed.
-         */
-        onUpdateValue: Function,
-    };
+  return {
+    /**
+     * The value of the component.
+     */
+    value: {
+      type: propType,
+      required: true
+    },
+    /**
+     * This will be called, when the value of the component has changed.
+     */
+    onUpdateValue: Function
+  };
 }
 /**
  * Creates props for a `v-model` of the given type with a default value.
  * @see {@link vModelProps}
  */
 export function vModelDefaultProps(propType, defaultValue) {
-    return {
-        /**
-         * The value of the component.
-         */
-        value: {
-            type: propType,
-            default: defaultValue,
-        },
-        /**
-         * This will be called, when the value of the component has changed.
-         */
-        onUpdateValue: Function,
-    };
+  return {
+    /**
+     * The value of the component.
+     */
+    value: {
+      type: propType,
+      default: defaultValue
+    },
+    /**
+     * This will be called, when the value of the component has changed.
+     */
+    onUpdateValue: Function
+  };
 }
 /**
  * Uses the given `ref` as a `v-model`, to create a two-way binding with the `ref`.
@@ -63,12 +63,12 @@ export function vModelDefaultProps(propType, defaultValue) {
  * @returns An object of type {@link VModel}, which connects the `ref` to the `v-model`.
  */
 export function vModelForRef(ref) {
-    return {
-        value: ref.value,
-        onUpdateValue: (newValue) => {
-            ref.value = newValue;
-        },
-    };
+  return {
+    value: ref.value,
+    onUpdateValue: newValue => {
+      ref.value = newValue;
+    }
+  };
 }
 /**
  * This creates a `v-model` for a property of an object. The property of the object is taken as the
@@ -93,12 +93,15 @@ export function vModelForRef(ref) {
  * ```
  */
 export function vModelForObjectProperty(object, key, onUpdate) {
-    return {
-        value: object[key],
-        onUpdateValue: (newValue) => {
-            onUpdate?.({ ...object, [key]: newValue });
-        },
-    };
+  return {
+    value: object[key],
+    onUpdateValue: newValue => {
+      onUpdate?.({
+        ...object,
+        [key]: newValue
+      });
+    }
+  };
 }
 /**
  * This creates a `v-model` which operates on one property of a parent `v-model`. It takes the value of
@@ -130,12 +133,15 @@ export function vModelForObjectProperty(object, key, onUpdate) {
  * ```
  */
 export function vModelForVModelProperty(vModel, key) {
-    return {
-        value: vModel.value[key],
-        onUpdateValue: (newValue) => {
-            vModel.onUpdateValue?.({ ...vModel.value, [key]: newValue });
-        },
-    };
+  return {
+    value: vModel.value[key],
+    onUpdateValue: newValue => {
+      vModel.onUpdateValue?.({
+        ...vModel.value,
+        [key]: newValue
+      });
+    }
+  };
 }
 /**
  * This function does the same thing as {@link vModelForVModelProperty},
@@ -168,12 +174,15 @@ export function vModelForVModelProperty(vModel, key) {
  * ```
  */
 export function vModelForVModelPropertyMapType(vModel, key, mapType) {
-    return {
-        value: vModel.value[key],
-        onUpdateValue: (newValue) => {
-            vModel.onUpdateValue?.({ ...vModel.value, [key]: mapType(newValue) });
-        },
-    };
+  return {
+    value: vModel.value[key],
+    onUpdateValue: newValue => {
+      vModel.onUpdateValue?.({
+        ...vModel.value,
+        [key]: mapType(newValue)
+      });
+    }
+  };
 }
 /**
  * Creates an array of `v-models`, one for every element of an array. All changes in
@@ -200,16 +209,16 @@ export function vModelForVModelPropertyMapType(vModel, key, mapType) {
  * ```
  */
 export function vModelsForArray(array, onUpdate) {
-    return array.map((entry, index) => ({
-        value: entry,
-        onUpdateValue: (entry) => {
-            const newArray = [...array];
-            newArray[index] = entry;
-            onUpdate?.(newArray);
-        },
-        remove: () => {
-            const newArray = [...array.slice(0, index), ...array.slice(index + 1)];
-            onUpdate?.(newArray);
-        },
-    }));
-}
+  return array.map((entry, index) => ({
+    value: entry,
+    onUpdateValue: entry => {
+      const newArray = [...array];
+      newArray[index] = entry;
+      onUpdate?.(newArray);
+    },
+    remove: () => {
+      const newArray = [...array.slice(0, index), ...array.slice(index + 1)];
+      onUpdate?.(newArray);
+    }
+  }));
+}

package/utils/validation.js

@@ -3,17 +3,22 @@ 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 };
+  return {
+    isValid: false,
+    errorMessage
+  };
 }
 const TRANSLATION_KEY_BASE = 'vue-collection.validation.rules';
 function invalidResultInternal(key, params) {
-    return invalidResult(trsl(`${TRANSLATION_KEY_BASE}.${key}`, params));
+  return invalidResult(trsl(`${TRANSLATION_KEY_BASE}.${key}`, params));
 }
 /**
  * Validates a given input with the specified rules.
@@ -25,12 +30,11 @@ function invalidResultInternal(key, 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 ----------
@@ -39,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 invalidResultInternal('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 invalidResultInternal('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
@@ -61,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 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();
-    };
+  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.
@@ -79,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 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();
-    };
+  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 invalidResultInternal('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 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');
+  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.
@@ -131,36 +114,27 @@ export const password = input => {
  * @param other the other value to match
  */
 export function matches(other) {
-    return input => {
-        if (input === other)
-            return validResult();
-        else
-            return invalidResultInternal('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 invalidResultInternal('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 invalidResultInternal('regex');
-    };
+  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.
@@ -169,5 +143,5 @@ export function regex(pattern) {
  * Like always, a falsy input is always valid to not interefere with the {@link required} rule.
  */
 export function external(isValid, errorMessage) {
-    return input => (!input || isValid ? validResult() : invalidResult(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);
+}