@flyanra/vue-core 1.0.0 → 1.0.2

package/dist/types/composables/index.d.ts

@@ -1 +1 @@
-export {};
+export { UseLocaleInjector } from './UseLocaleInjector';

package/dist/types/utils/index.d.ts

@@ -0,0 +1,2 @@
+export { checkRange } from './pure-functions';
+export { checkInputRange, isRequiredError } from './validators';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@flyanra/vue-core",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "private": false,
   "description": "Source-distributed Vue component library for Vite and Nuxt consumers.",
   "sideEffects": false,
@@ -38,11 +38,21 @@
       "types": "./dist/types/composables/*/index.d.ts",
       "import": "./src/composables/*/index.ts"
     },
+    "./utils": {
+      "types": "./dist/types/utils/index.d.ts",
+      "import": "./src/utils/index.ts"
+    },
+    "./utils/*": {
+      "types": "./dist/types/utils/*.d.ts",
+      "import": "./src/utils/*.ts"
+    },
     "./package.json": "./package.json"
   },
   "types": "./dist/types/index.d.ts",
   "files": [
     "src/components",
+    "src/composables",
+    "src/utils",
     "src/styles",
     "src/index.ts",
     "dist/types",
@@ -87,7 +97,7 @@
   "devDependencies": {
     "@changesets/cli": "^2.30.0",
     "@eslint/js": "^10.0.1",
-    "@flyanra/js-utils": "^1.3.2",
+    "@flyanra/js-utils": "^1.5.0",
     "@iconify-json/ri": "^1.2.10",
     "@jamescoyle/vue-icon": "^0.1.2",
     "@mdi/js": "^7.4.47",

package/src/composables/UseLocaleInjector.ts

@@ -0,0 +1,18 @@
+import { inject } from 'vue'
+
+import { FallbackTranslateFn, I18N_KEY } from '@flyanra/js-utils/constants'
+import type { Locale } from '@flyanra/js-utils/locales'
+import type { ComposerTranslation } from 'vue-i18n'
+
+type T_LocaleInjector = {
+  t: ComposerTranslation
+  locale: Locale
+}
+export function UseLocaleInjector(): T_LocaleInjector {
+  const i18n = inject(I18N_KEY)
+
+  return {
+    t: i18n?.t || FallbackTranslateFn,
+    locale: (i18n?.locale as Locale | undefined) || 'en'
+  }
+}

package/src/composables/index.ts

@@ -0,0 +1 @@
+export { UseLocaleInjector } from './UseLocaleInjector'

package/src/utils/index.ts

@@ -0,0 +1,2 @@
+export { checkRange } from './pure-functions'
+export { checkInputRange, isRequiredError } from './validators'

package/src/utils/pure-functions.ts

@@ -0,0 +1,15 @@
+import { isArray, isNumber, isString } from 'lodash-es'
+
+export function checkRange(value: unknown, min = 0, max = Infinity) {
+  if (isString(value) || isArray(value)) {
+    if (value.length < min || value.length > max) {
+      return false
+    }
+  } else if (isNumber(value)) {
+    if (value < min || value > max) {
+      return false
+    }
+  }
+
+  return true
+}

package/src/utils/validators.ts

@@ -0,0 +1,81 @@
+import type { FormItemRule } from 'element-plus'
+
+import { UseLocaleInjector } from '../composables/UseLocaleInjector'
+
+import { checkRange } from './pure-functions'
+
+export const isRequiredError = (languageKey: string) => {
+  const { t } = UseLocaleInjector()
+
+  return t('validation.fieldIsRequired', {
+    fieldName: t(languageKey)
+  })
+}
+
+type RangeObject = {
+  min?: number
+  max?: number
+}
+export const checkInputRange = (
+  languageKey: string = 'validation.value',
+  range: RangeObject,
+  valueTypeLanguageKey: string = 'validation.valueTypes.characters',
+  errorMessage?: string
+): FormItemRule['validator'] => {
+  const { t } = UseLocaleInjector()
+
+  // used in element form validator
+  return (_rule: unknown, value: unknown, callback: (_?: string | Error | undefined) => void) => {
+    // used in element form validator
+    if (!checkRange(value, range.min, range.max)) {
+      let message = errorMessage
+      const l = t ? t(languageKey) : languageKey
+
+      if (!message) {
+        if (range.min === range.max) {
+          message = `${
+            t
+              ? t('validation.valueMustBe', {
+                  value: l,
+                  validValue: `${range.max} ${t(valueTypeLanguageKey)}`
+                })
+              : 'validation.valueMustBe'
+          }`
+        } else if (range.min && !range.max) {
+          message = `${
+            t
+              ? t('validation.mustBeGreaterEqual', {
+                  value: l,
+                  validRange: `${range.min} ${t(valueTypeLanguageKey)}`
+                })
+              : 'validation.mustBeGreaterEqual'
+          }`
+        } else if (!range.min && range.max) {
+          message = `${
+            t
+              ? t('validation.cannotExceed', {
+                  value: l,
+                  validRange: `${range.max} ${t(valueTypeLanguageKey)}`
+                })
+              : 'validation.cannotExceed'
+          }`
+        } else if (range.min && range.max) {
+          message = `${
+            t
+              ? t('validation.mustBetween', {
+                  value: l,
+                  minRange: `${range.min} ${t(valueTypeLanguageKey)}`,
+                  maxRange: `${range.max} ${t(valueTypeLanguageKey)}`,
+                  valueType: `${t(valueTypeLanguageKey)}`
+                })
+              : 'validation.mustBetween'
+          }`
+        }
+      }
+
+      return callback(new Error(message))
+    }
+
+    return callback()
+  }
+}