@globalbrain/sefirot 2.0.0-draft.5 → 2.0.0-draft.8

package/CHANGELOG.md

@@ -1,3 +1,23 @@
+# [2.0.0-draft.8](https://github.com/globalbrain/sefirot/compare/v2.0.0-draft.7...v2.0.0-draft.8) (2022-04-21)
+
+### Features
+
+* **validation:** update types
+
+# [2.0.0-draft.7](https://github.com/globalbrain/sefirot/compare/v2.0.0-draft.6...v2.0.0-draft.7) (2022-02-21)
+
+### Bug Fixes
+
+* **validation:** vuelidate import ([1c2e547](https://github.com/globalbrain/sefirot/commit/1c2e547d2ef5fa31ab36ba65882c54085cc4a991))
+
+# [2.0.0-draft.6](https://github.com/globalbrain/sefirot/compare/v2.0.0-draft.5...v2.0.0-draft.6) (2022-02-21)
+
+### Features
+
+* **input-select:** add SInputSelect component ([1d0608e](https://github.com/globalbrain/sefirot/commit/1d0608e8aaa3f7007bb4aff18255ce2b528a7d76))
+* **validation:** add custom error message support ([acb0894](https://github.com/globalbrain/sefirot/commit/acb0894ec5fdcc052100e3623525fbf030854a2f))
+
+
 # [2.0.0-draft.5](https://github.com/globalbrain/sefirot/compare/v2.0.0-draft.4...v2.0.0-draft.5) (2022-02-16)
 
 ### Features

package/LICENSE.md

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2021 Global Brain Corporation
+Copyright (c) 2022 Global Brain Corporation
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/lib/components/SInputSelect.vue

@@ -0,0 +1,235 @@
+<template>
+  <SInputBase
+    class="SInputSelect"
+    :class="classes"
+    :label="label"
+    :note="note"
+    :help="help"
+    :error-message="errorMessage ?? true"
+    :validation="validation"
+  >
+    <div class="box" :class="{ focus: isFocused }">
+      <select
+        class="select"
+        :class="{ 'is-not-selected': isNotSelected }"
+        :disabled="disabled"
+        @focus="focus"
+        @blur="blur"
+        @change="emitChange"
+      >
+        <option
+          v-if="placeholder || nullable"
+          :value="JSON.stringify({ value: null })"
+          :selected="isNotSelected"
+          :disabled="!nullable"
+        >
+          {{ placeholder || 'Please select' }}
+        </option>
+
+        <option
+          v-for="(option, index) in options"
+          :key="index"
+          :style="{ display: option.disabled ? 'none' : undefined }"
+          :value="JSON.stringify(option)"
+          :selected="isSelectedOption(option)"
+        >
+          {{ option.label }}
+        </option>
+      </select>
+
+      <div class="icon" role="button">
+        <SIconChevronUp class="icon-svg up" />
+        <SIconChevronDown class="icon-svg down" />
+      </div>
+    </div>
+  </SInputBase>
+</template>
+
+<script setup lang="ts">
+import { PropType, ref, computed } from 'vue'
+import { Validation, Validatable } from '../composables/Validation'
+import SIconChevronUp from './icons/SIconChevronUp.vue'
+import SIconChevronDown from './icons/SIconChevronDown.vue'
+import SInputBase from './SInputBase.vue'
+
+type Size = 'mini' | 'small' | 'medium'
+
+interface Option {
+  label: string
+  value: boolean | number | string
+  disabled?: boolean
+}
+
+const props = defineProps({
+  size: { type: String as PropType<Size>, default: 'small' },
+  label: { type: String, default: null },
+  note: { type: String, default: null },
+  help: { type: String, default: null },
+  placeholder: { type: String, default: null },
+  options: { type: Array as PropType<Option[]>, required: true },
+  disabled: { type: Boolean, default: false },
+  nullable: { type: Boolean, default: false },
+  errorMessage: { type: Boolean, default: true },
+  modelValue: { type: [String, Number, Boolean] as PropType<string | number | boolean | null>, default: null },
+  validation: { type: Object as PropType<Validatable>, default: null }
+})
+
+const emit = defineEmits(['update:modelValue'])
+
+const isFocused = ref(false)
+
+const classes = computed(() => [
+  props.size ?? 'small',
+  { disabled: props.disabled ?? false }
+])
+
+const isNotSelected = computed(() => {
+  return props.modelValue === undefined || props.modelValue === null || props.modelValue === ''
+})
+
+function isSelectedOption(option: Option): boolean {
+  return option.value === props.modelValue
+}
+
+function focus() {
+  isFocused.value = true
+}
+
+function blur() {
+  isFocused.value = false
+}
+
+function emitChange(e: any): void {
+  props.validation?.$touch()
+
+  const option = JSON.parse(e.target.value)
+
+  emit('update:modelValue', option.value)
+}
+</script>
+
+<style scoped lang="postcss">
+.SInputSelect.mini {
+  .box {
+    height: 32px;
+  }
+
+  .select {
+    padding: 3px 30px 3px 12px;
+    line-height: 24px;
+    font-size: 14px;
+  }
+
+  .icon {
+    top: 3px;
+    right: 8px;
+  }
+}
+
+.SInputSelect.small {
+  .box {
+    height: 40px;
+  }
+
+  .select {
+    padding: 7px 30px 5px 12px;
+    line-height: 24px;
+    font-size: 16px;
+  }
+
+  .icon {
+    top: 7px;
+    right: 10px;
+  }
+}
+
+.SInputSelect.medium {
+  .box {
+    height: 48px;
+  }
+
+  .select {
+    padding: 11px 44px 11px 16px;
+    line-height: 24px;
+    font-size: 16px;
+  }
+
+  .icon {
+    top: 11px;
+    right: 12px;
+  }
+}
+
+.SInputSelect.disabled {
+  .box {
+    background-color: var(--c-bg-mute);
+  }
+
+  .box:hover .select {
+    cursor: not-allowed;
+  }
+}
+
+.SInputSelect.has-error {
+  .box {
+    border-color: var(--c-danger);
+  }
+
+  .select {
+    border-color: var(--c-danger);
+  }
+}
+
+.box {
+  position: relative;
+  border: 1px solid var(--input-border);
+  border-radius: 4px;
+  width: 100%;
+  color: var(--input-text);
+  cursor: pointer;
+  transition: border-color .25s, background-color .25s;
+
+  &:hover,
+  &.focus {
+    border-color: var(--input-border);
+  }
+
+  &:focus:not(:focus-visible) {
+    border-color: var(--input-border);
+    outline: 0;
+  }
+}
+
+.select {
+  position: relative;
+  z-index: 20;
+  display: block;
+  border: 0;
+  border-radius: 4px;
+  width: 100%;
+  background-color: transparent;
+  cursor: pointer;
+
+  &.select.is-not-selected {
+    color: var(--input-placeholder);
+    font-weight: 500;
+  }
+}
+
+.icon {
+  position: absolute;
+  z-index: 10;
+  cursor: pointer;
+}
+
+.icon-svg {
+  display: block;
+  width: 14px;
+  height: 14px;
+  fill: var(--input-placeholder);
+}
+
+.icon-svg.up {
+  margin-bottom: -4px;
+}
+</style>

package/lib/composables/Form.ts

@@ -1,7 +1,7 @@
 import { Ref, ToRefs, reactive, computed } from 'vue'
 import { cloneDeep } from '../support/Utils'
 import { useSnackbar } from './Snackbar'
-import { Validation, ExtractState, ValidationArgs, useValidation } from './Validation'
+import { Validation, ValidationArgs, useValidation } from './Validation'
 
 export interface Form<D> {
   data: D

package/lib/composables/Validation.ts

@@ -1,13 +1,13 @@
 import { Ref, ToRefs } from 'vue'
-import useVuelidate, {
+import {
   Validation,
   ValidationArgs,
   GlobalConfig,
-  ExtractState,
-  ErrorObject
+  ErrorObject,
+  useVuelidate
 } from '@vuelidate/core'
 
-export type { Validation, ValidationArgs, GlobalConfig, ExtractState }
+export type { Validation, ValidationArgs, GlobalConfig }
 
 export interface Validatable {
   readonly $dirty: boolean
@@ -16,13 +16,17 @@ export interface Validatable {
   readonly $touch: () => void
 }
 
+export interface ValidationNotification {
+  notify(): Promise<boolean>
+}
+
 export function useValidation<
-  T extends ExtractState<A>,
-  A extends ValidationArgs
+  T extends { [key in keyof A]: any },
+  A extends ValidationArgs = ValidationArgs,
 >(
   state: T | Ref<T> | ToRefs<T>,
   rules: Ref<A> | A,
   config?: GlobalConfig
-): Ref<Validation<A>> {
+): Ref<Validation<A, T>> {
   return useVuelidate(rules, state, config)
 }

package/lib/validation/rules/checked.ts

@@ -1,7 +1,9 @@
 import { helpers } from '@vuelidate/validators'
 import { checked as baseChecked } from '../validators/checked'
 
-export const checked = helpers.withMessage(
-  'You must check the field.',
-  (value: boolean) => !helpers.req(value) || baseChecked(value)
-)
+export function checked(msg?: string) {
+  return helpers.withMessage(
+    () => msg ?? 'You must check the field.',
+    (value: boolean) => !helpers.req(value) || baseChecked(value)
+  )
+}

package/lib/validation/rules/email.ts

@@ -0,0 +1,8 @@
+import { helpers, email as baseEmail } from '@vuelidate/validators'
+
+export function email(msg?: string) {
+  return helpers.withMessage(
+    () => msg ?? 'The Email is invalid.',
+    baseEmail
+  )
+}

package/lib/validation/rules/fileExtension.ts

@@ -1,9 +1,9 @@
 import { helpers } from '@vuelidate/validators'
 import { fileExtension as baseFileExtension } from '../validators/fileExtension'
 
-export function fileExtension(extensions: string[], message?: string) {
+export function fileExtension(extensions: string[], msg?: string) {
   return helpers.withMessage(
-    'The file extension is invalid.',
+    () => msg ?? 'The file extension is invalid.',
     (value: File) => {
       return !helpers.req(value) || baseFileExtension(value, extensions)
     }

package/lib/validation/rules/hms.ts

@@ -1,9 +1,9 @@
 import { helpers } from '@vuelidate/validators'
 import { hms as baseHms, Hms, HmsType } from '../validators/hms'
 
-export function hms(required?: HmsType[]) {
+export function hms(required?: HmsType[], msg?: string) {
   return helpers.withMessage(
-    'The time is invalid.',
+    () => msg ?? 'The time is invalid.',
     (value: Hms) => {
       return !helpers.req(value) || baseHms(value, required)
     }

package/lib/validation/rules/index.ts

@@ -1,4 +1,5 @@
 export * from './checked'
+export * from './email'
 export * from './fileExtension'
 export * from './hms'
 export * from './maxLength'
@@ -7,4 +8,5 @@ export * from './required'
 export * from './requiredHms'
 export * from './requiredIf'
 export * from './requiredYmd'
+export * from './url'
 export * from './ymd'

package/lib/validation/rules/maxLength.ts

@@ -1,11 +1,9 @@
 import { helpers, maxLength as baseMaxLength } from '@vuelidate/validators'
 
-export function maxLength(length: number) {
+export function maxLength(length: number, msg?: string) {
   return helpers.withMessage(
     ({ $params }) => {
-      return `
-        The value must be less or equal to ${($params as any).max} characters.
-      `
+      return msg ?? `The value must be less or equal to ${($params as any).max} characters.`
     },
     baseMaxLength(length)
   )

package/lib/validation/rules/minLength.ts

@@ -1,11 +1,9 @@
 import { helpers, minLength as baseMinLength } from '@vuelidate/validators'
 
-export function minLength(length: number) {
+export function minLength(length: number, msg?: string) {
   return helpers.withMessage(
     ({ $params }) => {
-      return `
-        The value must be greater or equal to ${($params as any).min} characters.
-      `
+      return msg ?? `The value must be greater or equal to ${($params as any).min} characters.`
     },
     baseMinLength(length)
   )

package/lib/validation/rules/required.ts

@@ -1,3 +1,8 @@
 import { helpers, required as baseRequired } from '@vuelidate/validators'
 
-export const required = helpers.withMessage('The field is required.', baseRequired)
+export function required(msg?: string) {
+  return helpers.withMessage(
+    () => msg ?? 'The field is required.',
+    baseRequired
+  )
+}

package/lib/validation/rules/requiredHms.ts

@@ -1,9 +1,9 @@
 import { helpers } from '@vuelidate/validators'
 import { requiredHms as baseRequiredHms, Hms, HmsType } from '../validators/requiredHms'
 
-export function requiredHms(required?: HmsType[]) {
+export function requiredHms(required?: HmsType[], msg?: string) {
   return helpers.withMessage(
-    'The field is required.',
+    () => msg ?? 'The field is required.',
     (value: Hms) => {
       return !helpers.req(value) || baseRequiredHms(value, required)
     }

package/lib/validation/rules/requiredIf.ts

@@ -1,5 +1,11 @@
 import { helpers, requiredIf as baseRequiredIf } from '@vuelidate/validators'
 
-export function requiredIf(prop: boolean | string | (() => boolean | Promise<boolean>)) {
-  return helpers.withMessage('The field is required.', baseRequiredIf(prop))
+export function requiredIf(
+  prop: boolean | string | (() => boolean | Promise<boolean>),
+  msg?: string
+) {
+  return helpers.withMessage(
+    () => msg ?? 'The field is required.',
+    baseRequiredIf(prop)
+  )
 }

package/lib/validation/rules/requiredYmd.ts

@@ -1,9 +1,9 @@
 import { helpers } from '@vuelidate/validators'
 import { requiredYmd as baseRequiredYmd, Ymd, YmdType } from '../validators/requiredYmd'
 
-export function requiredYmd(required?: YmdType[]) {
+export function requiredYmd(required?: YmdType[], msg?: string) {
   return helpers.withMessage(
-    'The field is required.',
+    () => msg ?? 'The field is required.',
     (value: Ymd) => {
       return !helpers.req(value) || baseRequiredYmd(value, required)
     }

package/lib/validation/rules/url.ts

@@ -0,0 +1,8 @@
+import { helpers, url as baseUrl } from '@vuelidate/validators'
+
+export function url(msg?: string) {
+  return helpers.withMessage(
+    () => msg ?? 'The URL is invalid.',
+    baseUrl
+  )
+}

package/lib/validation/rules/ymd.ts

@@ -1,9 +1,9 @@
 import { helpers } from '@vuelidate/validators'
 import { ymd as baseYmd, Ymd, YmdType } from '../validators/ymd'
 
-export function ymd(required?: YmdType[]) {
+export function ymd(required?: YmdType[], msg?: string) {
   return helpers.withMessage(
-    'The date is invalid.',
+    () => msg ?? 'The date is invalid.',
     (value: Ymd) => {
       return !helpers.req(value) || baseYmd(value, required)
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@globalbrain/sefirot",
-  "version": "2.0.0-draft.5",
+  "version": "2.0.0-draft.8",
   "description": "Vue Components for Global Brain Design System.",
   "files": [
     "lib"
@@ -32,51 +32,51 @@
   },
   "peerDependencies": {
     "@types/body-scroll-lock": "^3.1.0",
-    "@types/lodash-es": "^4.17.5",
-    "@vuelidate/core": "^2.0.0-alpha.34",
-    "@vuelidate/validators": "^2.0.0-alpha.26",
+    "@types/lodash-es": "^4.17.6",
+    "@vuelidate/core": "^2.0.0-alpha.38",
+    "@vuelidate/validators": "^2.0.0-alpha.28",
     "body-scroll-lock": "^4.0.0-beta.0",
+    "dayjs": "^1.11.0",
     "fuse.js": "^6.5.3",
     "lodash-es": "^4.17.21",
     "normalize.css": "^8.0.1",
-    "postcss": "^8.4.6",
+    "postcss": "^8.4.12",
     "postcss-nested": "^5.0.6",
-    "typescript": "^4.5.5",
+    "typescript": "^4.6.3",
     "vue": "^3.2.31",
-    "vue-router": "^4.0.12",
-    "vue-tsc": "^0.31.4",
+    "vue-router": "^4.0.14",
     "vuex": "^4.0.2"
   },
   "devDependencies": {
-    "@babel/core": "^7.17.4",
+    "@babel/core": "^7.17.8",
     "@types/body-scroll-lock": "^3.1.0",
     "@types/lodash-es": "^4.17.6",
-    "@typescript-eslint/parser": "^5.12.0",
-    "@vitejs/plugin-vue": "^2.2.0",
-    "@vue/test-utils": "^2.0.0-rc.17",
-    "@vuelidate/core": "^2.0.0-alpha.34",
-    "@vuelidate/validators": "^2.0.0-alpha.26",
+    "@typescript-eslint/parser": "^5.17.0",
+    "@vitejs/plugin-vue": "^2.2.4",
+    "@vue/test-utils": "^2.0.0-rc.18",
+    "@vuelidate/core": "^2.0.0-alpha.38",
+    "@vuelidate/validators": "^2.0.0-alpha.28",
     "body-scroll-lock": "^4.0.0-beta.0",
     "c8": "^7.11.0",
     "codecov": "^3.8.3",
     "conventional-changelog-cli": "^2.2.2",
-    "dayjs": "^1.10.7",
+    "dayjs": "^1.11.0",
     "enquirer": "^2.3.6",
-    "eslint": "^8.9.0",
-    "eslint-plugin-vue": "^8.4.1",
+    "eslint": "^8.12.0",
+    "eslint-plugin-vue": "^8.5.0",
     "execa": "^5.1.1",
     "fuse.js": "^6.5.3",
-    "happy-dom": "^2.31.1",
+    "happy-dom": "^2.50.0",
     "lodash-es": "^4.17.21",
     "normalize.css": "^8.0.1",
-    "postcss": "^8.4.6",
+    "postcss": "^8.4.12",
     "postcss-nested": "^5.0.6",
-    "typescript": "^4.5.5",
-    "vite": "^2.8.3",
-    "vitest": "^0.3.5",
+    "typescript": "^4.6.3",
+    "vite": "^2.8.6",
+    "vitest": "^0.7.12",
     "vue": "^3.2.31",
-    "vue-router": "^4.0.12",
-    "vue-tsc": "^0.31.4",
+    "vue-router": "^4.0.14",
+    "vue-tsc": "^0.33.9",
     "vuex": "^4.0.2"
   }
 }