@vc-shell/framework 1.0.52 → 1.0.54

package/ui/components/molecules/vc-input/vc-input.vue

@@ -12,9 +12,17 @@
     ]"
   >
     <!-- Input label -->
-    <VcLabel v-if="label" class="tw-mb-2" :required="required">
+    <VcLabel
+      v-if="label"
+      class="tw-mb-2"
+      :required="required"
+    >
       <span>{{ label }}</span>
-      <template v-if="tooltip" v-slot:tooltip>{{ tooltip }}</template>
+      <template
+        v-if="tooltip"
+        v-slot:tooltip
+        >{{ tooltip }}</template
+      >
     </VcLabel>
 
     <div class="tw-flex tw-flex-nowrap tw-items-start">
@@ -25,9 +33,7 @@
         >
           <slot name="prepend"></slot>
         </div>
-        <div
-          class="tw-flex tw-flex-col tw-flex-nowrap tw-flex-auto tw-relative"
-        >
+        <div class="tw-flex tw-flex-col tw-flex-nowrap tw-flex-auto tw-relative">
           <div class="vc-input__field-wrapper">
             <div class="tw-flex tw-flex-nowrap tw-flex-auto tw-h-full">
               <div
@@ -72,13 +78,14 @@
                   {{ suffix }}
                 </div>
                 <div
-                  v-if="
-                    clearable && modelValue && !disabled && type !== 'password'
-                  "
+                  v-if="clearable && modelValue && !disabled && type !== 'password'"
                   class="vc-input__clear"
                   @click="onReset"
                 >
-                  <VcIcon size="s" icon="fas fa-times"></VcIcon>
+                  <VcIcon
+                    size="s"
+                    icon="fas fa-times"
+                  ></VcIcon>
                 </div>
 
                 <div
@@ -86,7 +93,10 @@
                   v-if="type === 'password' && internalType === 'password'"
                   @click="internalType = 'text'"
                 >
-                  <VcIcon size="s" icon="fas fa-eye-slash"></VcIcon>
+                  <VcIcon
+                    size="s"
+                    icon="fas fa-eye-slash"
+                  ></VcIcon>
                 </div>
 
                 <div
@@ -94,7 +104,10 @@
                   v-if="type === 'password' && internalType === 'text'"
                   @click="internalType = 'password'"
                 >
-                  <VcIcon size="s" icon="fas fa-eye"></VcIcon>
+                  <VcIcon
+                    size="s"
+                    icon="fas fa-eye"
+                  ></VcIcon>
                 </div>
               </div>
 
@@ -116,20 +129,27 @@
               </div>
             </div>
           </div>
-          <div
-            class="tw-absolute tw-translate-y-full tw-left-0 tw-right-0 tw-bottom-0 tw-min-h-[20px]"
-          >
-            <Transition name="slide-up" mode="out-in">
+          <div class="tw-absolute tw-translate-y-full tw-left-0 tw-right-0 tw-bottom-0 tw-min-h-[20px]">
+            <Transition
+              name="slide-up"
+              mode="out-in"
+            >
               <div v-if="error">
                 <slot name="error">
-                  <VcHint class="vc-input__error" v-if="errorMessage">
+                  <VcHint
+                    class="vc-input__error"
+                    v-if="errorMessage"
+                  >
                     {{ errorMessage }}
                   </VcHint>
                 </slot>
               </div>
               <div v-else>
                 <slot name="hint">
-                  <VcHint class="vc-input__desc" v-if="hint">
+                  <VcHint
+                    class="vc-input__desc"
+                    v-if="hint"
+                  >
                     {{ hint }}
                   </VcHint>
                 </slot>
@@ -151,19 +171,11 @@
 
 <script lang="ts" setup>
 import { computed, ref, unref, watch } from "vue";
-import { VcInputProps } from "./vc-input-model";
+import { inputEmits, inputProps } from "./vc-input-model";
 
-const props = withDefaults(defineProps<VcInputProps>(), {
-  modelValue: null,
-  clearable: false,
-  required: false,
-  disabled: false,
-  type: "text",
-  name: "Field",
-  maxlength: "1024",
-});
+const props = defineProps(inputProps);
 
-const emit = defineEmits(["update:modelValue"]);
+const emit = defineEmits(inputEmits);
 
 let emitTimer;
 let emitValueFn;
@@ -194,7 +206,7 @@ function onInput(e: Event) {
   emitValue(newValue);
 }
 
-function emitValue(val) {
+function emitValue(val: string) {
   emitValueFn = () => {
     if (props.modelValue !== val) {
       emit("update:modelValue", val);

package/ui/components/molecules/vc-input-currency/index.ts

@@ -1,8 +1,9 @@
 import { ComponentPublicInstance } from "vue";
-import { VcInputCurrencyProps } from "./vc-input-currency-model";
-import { ComponentConstructor } from "@/ui/types/ts-helpers";
+import { VcInputCurrencyEmits, VcInputCurrencyProps } from "./vc-input-currency-model";
+import { ComponentConstructor } from "./../../../types/ts-helpers";
 import InputCurrency from "./vc-input-currency.vue";
 
 export const VcInputCurrency: ComponentConstructor<
-  ComponentPublicInstance<VcInputCurrencyProps>
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  ComponentPublicInstance<VcInputCurrencyProps, any, any, any, any, VcInputCurrencyEmits>
 > = InputCurrency;

package/ui/components/molecules/vc-input-currency/vc-input-currency-model.ts

@@ -1,114 +1,124 @@
-import { VNode } from "vue";
+import { PropType, VNode } from "vue";
+import { ExtractTypes } from "./../../../types/ts-helpers";
+import { isString, isNumber } from "./../../../utils";
 
-export type OptionProp =
-  | ((option: string | Record<string, unknown>) => string)
-  | string
-  | undefined;
+export type OptionProp = ((option: string | Record<string, unknown>) => string) | string | undefined;
 
-export interface VcInputCurrencyProps {
+export const inputCurrencyProps = {
   /**
    * Model of the currency component; Use with a listener for 'update:price' event OR use v-model:price directive
    */
-  modelValue?: string | number | Date | null;
+  modelValue: [String, Number, Date],
   /**
    * Input label text
    */
-  label?: string | undefined;
+  label: String,
   /**
    * Input placeholder text
    */
-  placeholder?: string | undefined;
+  placeholder: String,
   /**
    * Input description (hint) text below input component
    */
-  hint?: string | undefined;
+  hint: String,
   /**
    * Appends clearable icon when a value is set;
    * When clicked, model becomes null
    */
-  clearable?: boolean | undefined;
+  clearable: Boolean,
   /**
    * Prefix
    */
-  prefix?: string | undefined;
+  prefix: String,
   /**
    * Suffix
    */
-  suffix?: string | undefined;
+  suffix: String,
   /**
    * Used to specify the name of the control; If not specified, it takes the value 'Field'
    */
-  name?: string | undefined;
+  name: String,
   /**
    * Signals the user a process is in progress by displaying a spinner
    */
-  loading?: boolean | undefined;
+  loading: Boolean,
   /**
    * Debounce amount (in milliseconds) for search input
    * Default: 0
    */
-  debounce?: string | number | undefined;
+  debounce: {
+    type: [String, Number],
+    default: 0,
+  },
   /**
    * Put component in disabled mode
    */
-  disabled?: boolean | undefined;
+  disabled: Boolean,
   /**
    * Focus field on initial component render
    */
-  autofocus?: boolean | undefined;
+  autofocus: Boolean,
   /**
    * Does field have validation errors?
    */
-  error?: boolean | undefined;
+  error: Boolean,
   /**
    * Validation error message (gets displayed only if 'error' is set to 'true')
    */
-  errorMessage?: string | undefined;
+  errorMessage: String,
   /**
    * Specify a max length of model
    * Default value: 1024
    */
-  maxlength?: string | number | undefined;
+  maxlength: [String, Number],
   /**
    * Input tooltip information
    */
-  tooltip?: string | undefined;
+  tooltip: String,
   /**
    * Input required state
    */
-  required?: boolean | undefined;
+  required: Boolean,
   /**
    * Option label
    */
-  option?: string | undefined;
+  option: String,
   /**
    * Available options that the user can select from.
    * Default value: []
    */
-  options?: any[] | undefined;
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  options: Array as PropType<any[]>,
   /**
    * Property of option which holds the 'value'
    * Default value: id
    * @param option The current option being processed
    * @returns Value of the current option
    */
-  optionValue?: OptionProp;
+  optionValue: [Function, String] as PropType<OptionProp>,
   /**
    * Property of option which holds the 'label'
    * Default value: title
    * @param option The current option being processed
    * @returns Label of the current option
    */
-  optionLabel?: OptionProp;
+  optionLabel: [Function, String] as PropType<OptionProp>,
+};
+
+export const inputCurrencyEmits = {
   /**
-  * Emitted when the component needs to change the model; Is also used by v-model
-  */
-  "onUpdate:modelValue"?: (value: string | number | null) => void;
+   * Emitted when the component needs to change the model; Is also used by v-model
+   */
+  "update:modelValue": (value: string | number | null) => isString(value) || isNumber(value) || value === null,
   /**
    * Emitted when the component needs to change the options model; Is also used by v-model:option
    */
-  "onUpdate:option"?: (value: string | number | null) => void;
-}
+  "update:option": (value: string | number | null) => isString(value) || isNumber(value) || value === null,
+};
+
+export type VcInputCurrencyProps = ExtractTypes<typeof inputCurrencyProps>;
+export type VcInputCurrencyEmits = typeof inputCurrencyEmits;
+
 export interface VcInputCurrencySlots {
   /**
    * Slot for custom dropdown open handler

package/ui/components/molecules/vc-input-currency/vc-input-currency.vue

@@ -31,7 +31,10 @@
         @update:modelValue="$emit('update:modelValue', +$event)"
       >
         <template v-slot:append-inner>
-          <slot name="button" :toggleHandler="toggleHandler">
+          <slot
+            name="button"
+            :toggleHandler="toggleHandler"
+          >
             <button
               class="tw-text-[#43b0e6] tw-not-italic tw-font-medium tw-text-[13px] tw-leading-[20px] tw-cursor-pointer"
               @click.stop.prevent="toggleHandler"
@@ -41,7 +44,11 @@
           </slot>
         </template>
         <template v-slot:control="{ placeholder }">
-          <input type="text" ref="inputRef" :placeholder="placeholder" />
+          <input
+            type="text"
+            ref="inputRef"
+            :placeholder="placeholder"
+          />
         </template>
       </VcInput>
     </template>
@@ -49,15 +56,13 @@
 </template>
 
 <script lang="ts" setup>
-import { VcInputCurrencyProps } from "./vc-input-currency-model";
+import { inputCurrencyEmits, inputCurrencyProps } from "./vc-input-currency-model";
 import { useCurrencyInput, CurrencyDisplay } from "vue-currency-input";
 import { watch } from "vue";
 
-const props = withDefaults(defineProps<VcInputCurrencyProps>(), {
-  debounce: 0,
-});
+const props = defineProps(inputCurrencyProps);
 
-defineEmits(["update:modelValue", "update:option"]);
+defineEmits(inputCurrencyEmits);
 
 const { inputRef, setOptions } = useCurrencyInput({
   locale: navigator.language,

package/ui/components/molecules/vc-notification/index.ts

@@ -0,0 +1,8 @@
+import { ComponentPublicInstance } from "vue";
+import { VcNotificationEmits, VcNotificationProps } from "./vc-notification-model";
+import { ComponentConstructor } from "./../../../types/ts-helpers";
+import Notification from "./vc-notification.vue";
+export const VcNotification: ComponentConstructor<
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  ComponentPublicInstance<VcNotificationProps, any, any, any, any, VcNotificationEmits>
+> = Notification;

package/ui/components/molecules/vc-notification/vc-notification-model.ts

@@ -0,0 +1,21 @@
+import { VNode } from "vue";
+import { ExtractTypes } from "./../../../types/ts-helpers";
+
+export const notificationProps = {
+  timeout: {
+    type: Number,
+    default: 0,
+  },
+};
+
+export const notificationEmits = {
+  dismiss: () => true,
+  expired: () => true,
+};
+
+export type VcNotificationProps = ExtractTypes<typeof notificationProps>;
+export type VcNotificationEmits = typeof notificationEmits;
+
+export interface VcNotificationSlots {
+  default: () => VNode[];
+}

package/ui/components/molecules/vc-notification/vc-notification.vue

@@ -17,21 +17,12 @@
 </template>
 
 <script lang="ts" setup>
-import { VcIcon } from "@/ui/components";
+import { VcIcon } from "./../../../components";
+import { notificationEmits, notificationProps } from "./vc-notification-model";
 
-const props = defineProps({
-  variant: {
-    type: String,
-    default: "info",
-  },
+const props = defineProps(notificationProps);
 
-  timeout: {
-    type: Number,
-    default: 0,
-  },
-});
-
-const emit = defineEmits(["dismiss", "expired"]);
+const emit = defineEmits(notificationEmits);
 
 function Timer(callback: (...args: unknown[]) => unknown, delay: number) {
   let timerId: number;

package/ui/components/molecules/vc-pagination/index.ts

@@ -0,0 +1,8 @@
+import { ComponentPublicInstance } from "vue";
+import { VcPaginationEmits, VcPaginationProps } from "./vc-pagination-model";
+import { ComponentConstructor } from "./../../../types/ts-helpers";
+import Pagination from "./vc-pagination.vue";
+export const VcPagination: ComponentConstructor<
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  ComponentPublicInstance<VcPaginationProps, any, any, any, any, VcPaginationEmits>
+> = Pagination;

package/ui/components/molecules/vc-pagination/vc-pagination-model.ts

@@ -0,0 +1,29 @@
+import { VNode } from "vue";
+import { ExtractTypes } from "./../../../types/ts-helpers";
+import { isNumber } from "./../../../utils";
+
+export const paginationProps = {
+  expanded: {
+    type: Boolean,
+    default: false,
+  },
+  pages: {
+    type: Number,
+    default: 1,
+  },
+  currentPage: {
+    type: Number,
+    default: 1,
+  },
+};
+
+export const paginationEmits = {
+  itemClick: (pages: number) => isNumber(pages),
+};
+
+export type VcPaginationProps = ExtractTypes<typeof paginationProps>;
+export type VcPaginationEmits = typeof paginationEmits;
+
+export interface VcPaginationSlots {
+  default: () => VNode[];
+}

package/ui/components/molecules/vc-pagination/vc-pagination.vue

@@ -8,7 +8,10 @@
       }"
       @click="currentPage !== 1 && $emit('itemClick', 1)"
     >
-      <VcIcon size="xs" icon="fas fa-angle-double-left"></VcIcon>
+      <VcIcon
+        size="xs"
+        icon="fas fa-angle-double-left"
+      ></VcIcon>
     </div>
 
     <!-- To previous page arrow -->
@@ -19,7 +22,10 @@
       }"
       @click="currentPage !== 1 && $emit('itemClick', currentPage - 1)"
     >
-      <VcIcon size="xs" icon="fas fa-arrow-left"></VcIcon>
+      <VcIcon
+        size="xs"
+        icon="fas fa-arrow-left"
+      ></VcIcon>
     </div>
 
     <template v-if="expanded && $isDesktop.value">
@@ -75,7 +81,10 @@
       }"
       @click="currentPage !== pages && $emit('itemClick', currentPage + 1)"
     >
-      <VcIcon size="xs" icon="fas fa-arrow-right"></VcIcon>
+      <VcIcon
+        size="xs"
+        icon="fas fa-arrow-right"
+      ></VcIcon>
     </div>
 
     <!-- To last page chevron -->
@@ -86,32 +95,21 @@
       }"
       @click="currentPage !== pages && $emit('itemClick', pages)"
     >
-      <VcIcon size="xs" icon="fas fa-angle-double-right"></VcIcon>
+      <VcIcon
+        size="xs"
+        icon="fas fa-angle-double-right"
+      ></VcIcon>
     </div>
   </div>
 </template>
 
 <script lang="ts" setup>
-import { VcIcon } from "@/ui/components";
+import { VcIcon } from "./../../../components";
+import { paginationEmits, paginationProps } from "./vc-pagination-model";
 
-defineProps({
-  expanded: {
-    type: Boolean,
-    default: false,
-  },
+defineProps(paginationProps);
 
-  pages: {
-    type: Number,
-    default: 1,
-  },
-
-  currentPage: {
-    type: Number,
-    default: 1,
-  },
-});
-
-defineEmits(["itemClick"]);
+defineEmits(paginationEmits);
 </script>
 
 <style lang="scss">
@@ -119,7 +117,7 @@ defineEmits(["itemClick"]);
   --pagination-item-width: 30px;
   --pagination-item-height: 30px;
   --pagination-item-color: #000000;
-  --pagination-item-color-hover:tw- #000000;
+  --pagination-item-color-hover: #000000;
   --pagination-item-color-current: #ffffff;
   --pagination-item-color-disabled: #9c9c9c;
   --pagination-item-background-color: #ffffff;

package/ui/components/molecules/vc-rating/index.ts

@@ -0,0 +1,5 @@
+import { ComponentPublicInstance } from "vue";
+import { VcRatingProps } from "./vc-rating-model";
+import { ComponentConstructor } from "./../../../types/ts-helpers";
+import Rating from "./vc-rating.vue";
+export const VcRating: ComponentConstructor<ComponentPublicInstance<VcRatingProps>> = Rating;

package/ui/components/molecules/vc-rating/vc-rating-model.ts

@@ -0,0 +1,23 @@
+import { PropType, VNode } from "vue";
+import { ExtractTypes } from "./../../../types/ts-helpers";
+
+export const ratingProps = {
+  label: String,
+  placeholder: String,
+  tooltip: String,
+  rating: Number,
+  max: {
+    type: Number,
+    default: 5,
+  },
+  variant: {
+    type: String as PropType<"stars" | "star-and-text" | "text">,
+    default: "stars",
+  },
+};
+
+export type VcRatingProps = ExtractTypes<typeof ratingProps>;
+
+export interface VcRatingSlots {
+  details: () => VNode[];
+}

package/ui/components/molecules/vc-rating/vc-rating.vue

@@ -1,9 +1,15 @@
 <template>
   <div class="vc-rating">
     <!-- Rating label -->
-    <VcLabel v-if="label" class="tw-mb-2">
+    <VcLabel
+      v-if="label"
+      class="tw-mb-2"
+    >
       <span>{{ label }}</span>
-      <template v-if="tooltip" v-slot:tooltip>
+      <template
+        v-if="tooltip"
+        v-slot:tooltip
+      >
         <span v-html="tooltip"></span>
       </template>
     </VcLabel>
@@ -41,18 +47,10 @@
 </template>
 
 <script lang="ts" setup>
-import { VcIcon, VcLabel } from "@/ui/components";
+import { VcIcon, VcLabel } from "./../../../components";
+import { ratingProps } from "./vc-rating-model";
 
-export interface Props {
-  label?: string;
-  placeholder?: string;
-  tooltip?: string;
-  rating: number | undefined;
-  max?: number;
-  variant?: "stars" | "star-and-text" | "text";
-}
-
-withDefaults(defineProps<Props>(), { max: 5, variant: "stars" });
+defineProps(ratingProps);
 </script>
 
 <style lang="scss">

package/ui/components/molecules/vc-select/index.ts

@@ -1,8 +1,8 @@
 import { ComponentPublicInstance } from "vue";
-import { VcSelectProps } from "./vc-select-model";
-import { ComponentConstructor } from "@/ui/types/ts-helpers";
+import { VcSelectProps, VcSelectEmits } from "./vc-select-model";
+import { ComponentConstructor } from "./../../../types/ts-helpers";
 import Select from "./vc-select.vue";
 
-export const VcSelect: ComponentConstructor<
-  ComponentPublicInstance<VcSelectProps>
-> = Select;
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+export const VcSelect: ComponentConstructor<ComponentPublicInstance<VcSelectProps, any, any, any, any, VcSelectEmits>> =
+  Select;