From a7f1e5d0f8a17958749cac894ac784c92f7cbb55 Mon Sep 17 00:00:00 2001
From: Francis Ashley <francisashley.dev@gmail.com>
Date: Fri, 3 Jan 2025 17:17:04 +0000
Subject: [PATCH] feat: publish types

---
 package.json                                             | 2 +-
 src/components/VueScreener.vue                           | 4 ++--
 src/components/pagination/VueScreenerPagination.vue      | 4 ++--
 src/components/search/VueScreenerSearch.vue              | 4 ++--
 src/components/search/VueScreenerSearchOptions.vue       | 4 ++--
 src/components/table/VueScreenerTableCell.vue            | 4 ++--
 src/components/table/VueScreenerTableHeadCell.vue        | 4 ++--
 src/components/viewport/VueScreenerViewport.vue          | 4 ++--
 src/components/viewport/states/VueScreenerTableState.vue | 4 ++--
 src/hooks/use-vue-screener.ts                            | 4 ++--
 src/index.ts                                             | 2 ++
 src/interfaces/vue-screener.ts                           | 2 +-
 12 files changed, 22 insertions(+), 20 deletions(-)

diff --git a/package.json b/package.json
index 02def55..9b2f48a 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "vue-screener",
-  "version": "0.15.11",
+  "version": "0.15.12",
   "type": "module",
   "description": "Easily search and filter data in Vue3.",
   "author": "Francis Ashley",
diff --git a/src/components/VueScreener.vue b/src/components/VueScreener.vue
index 0ff8c66..e3b1c47 100644
--- a/src/components/VueScreener.vue
+++ b/src/components/VueScreener.vue
@@ -20,7 +20,7 @@
 </template>
 
 <script lang="ts" setup>
-import type { Column, VueScreener } from '../interfaces/vue-screener'
+import type { Column, IVueScreener } from '../interfaces/vue-screener'
 import { useElementSize } from '../hooks/use-element-size'
 import { computed, ref, watch } from 'vue'
 import VueScreenerViewport from './viewport/VueScreenerViewport.vue'
@@ -30,7 +30,7 @@ import { useVueScreener } from '../hooks/use-vue-screener'
 import { twMerge } from 'tailwind-merge'
 
 const props = defineProps<{
-  screener?: VueScreener
+  screener?: IVueScreener
   data?: any[]
   class?: string
   // options
diff --git a/src/components/pagination/VueScreenerPagination.vue b/src/components/pagination/VueScreenerPagination.vue
index 7059296..5c6de4d 100644
--- a/src/components/pagination/VueScreenerPagination.vue
+++ b/src/components/pagination/VueScreenerPagination.vue
@@ -31,7 +31,7 @@
 </template>
 
 <script lang="ts" setup>
-import { VueScreener } from '@/interfaces/vue-screener'
+import { IVueScreener } from '@/interfaces/vue-screener'
 import { computed, HTMLAttributes, onMounted, watch } from 'vue'
 import VueScreenerPaginationRowsPerPage from '../pagination/VueScreenerPaginationRowsPerPage.vue'
 import VueScreenerPaginationResults from '../pagination/VueScreenerPaginationResults.vue'
@@ -39,7 +39,7 @@ import VueScreenerPaginationButtons from '../pagination/VueScreenerPaginationBut
 import { twMerge } from 'tailwind-merge'
 
 const props = defineProps<{
-  screener: VueScreener
+  screener: IVueScreener
   class?: HTMLAttributes['class']
 }>()
 
diff --git a/src/components/search/VueScreenerSearch.vue b/src/components/search/VueScreenerSearch.vue
index dd728bc..53da8fa 100644
--- a/src/components/search/VueScreenerSearch.vue
+++ b/src/components/search/VueScreenerSearch.vue
@@ -20,7 +20,7 @@
 </template>
 
 <script lang="ts" setup>
-import { VueScreener } from '@/interfaces/vue-screener'
+import { IVueScreener } from '@/interfaces/vue-screener'
 import { computed, HTMLAttributes, ref } from 'vue'
 import { isValidRegExp } from '../../utils/regex.utils'
 import UiInput from '../ui/input/Input.vue'
@@ -28,7 +28,7 @@ import VueScreenerSearchOptions from './VueScreenerSearchOptions.vue'
 import { twMerge } from 'tailwind-merge'
 
 const props = defineProps<{
-  screener: VueScreener
+  screener: IVueScreener
   inputClass?: HTMLAttributes['class']
   optionsClass?: string
   toggleButtonClass?: string
diff --git a/src/components/search/VueScreenerSearchOptions.vue b/src/components/search/VueScreenerSearchOptions.vue
index e2e0c1e..707301f 100644
--- a/src/components/search/VueScreenerSearchOptions.vue
+++ b/src/components/search/VueScreenerSearchOptions.vue
@@ -31,14 +31,14 @@
 </template>
 
 <script lang="ts" setup>
-import { VueScreener } from '@/interfaces/vue-screener'
+import { IVueScreener } from '@/interfaces/vue-screener'
 import ToggleButtonGroup from '../ui/toggle-button/ToggleButtonGroup.vue'
 import ToggleButton from '../ui/toggle-button/ToggleButton.vue'
 import { twMerge } from '../../utils/tailwind-merge.utils'
 import { Icon } from '@iconify/vue'
 
 const props = defineProps<{
-  screener: VueScreener
+  screener: IVueScreener
   toggleButtonClass?: string
   toggleButtonActiveClass?: string
   iconClass?: string
diff --git a/src/components/table/VueScreenerTableCell.vue b/src/components/table/VueScreenerTableCell.vue
index 1cd4ca2..bd7a058 100644
--- a/src/components/table/VueScreenerTableCell.vue
+++ b/src/components/table/VueScreenerTableCell.vue
@@ -21,11 +21,11 @@
 <script lang="ts" setup>
 import { computed, defineProps, HTMLAttributes } from 'vue'
 import { twMerge } from '../../utils/tailwind-merge.utils'
-import { Column, Row, VueScreener } from '@/interfaces/vue-screener'
+import { Column, Row, IVueScreener } from '@/interfaces/vue-screener'
 import { highlightMatches } from '../../utils/text.utils'
 
 const props = defineProps<{
-  screener?: VueScreener
+  screener?: IVueScreener
   column: Column
   row?: Row
   pinnedClass?: string
diff --git a/src/components/table/VueScreenerTableHeadCell.vue b/src/components/table/VueScreenerTableHeadCell.vue
index c92f70b..0b08ed7 100644
--- a/src/components/table/VueScreenerTableHeadCell.vue
+++ b/src/components/table/VueScreenerTableHeadCell.vue
@@ -22,13 +22,13 @@
 
 <script lang="ts" setup>
 import { computed, HTMLAttributes } from 'vue'
-import type { VueScreener, Column } from '../../interfaces/vue-screener'
+import type { IVueScreener, Column } from '../../interfaces/vue-screener'
 import VueScreenerTableCell from '../table/VueScreenerTableCell.vue'
 import SortIcon from '../icons/SortIcon.vue'
 import { twMerge } from '../../utils/tailwind-merge.utils'
 
 const props = defineProps<{
-  screener: VueScreener
+  screener: IVueScreener
   column: Column
   sortableClass?: string
   sortingClass?: string
diff --git a/src/components/viewport/VueScreenerViewport.vue b/src/components/viewport/VueScreenerViewport.vue
index 81ae48a..cb34bac 100644
--- a/src/components/viewport/VueScreenerViewport.vue
+++ b/src/components/viewport/VueScreenerViewport.vue
@@ -23,7 +23,7 @@
 </template>
 
 <script lang="ts" setup>
-import type { VueScreener } from '../../interfaces/vue-screener'
+import type { IVueScreener } from '../../interfaces/vue-screener'
 import { computed } from 'vue'
 import VueScreenerTableState from './states/VueScreenerTableState.vue'
 import VueScreenerErrorState from './states/VueScreenerErrorState.vue'
@@ -31,7 +31,7 @@ import VueScreenerEmptyState from './states/VueScreenerEmptyState.vue'
 import VueScreenerLoadingState from './states/VueScreenerLoadingState.vue'
 
 const props = defineProps<{
-  screener: VueScreener
+  screener: IVueScreener
 }>()
 
 const state = computed<'default' | 'loading' | 'empty' | 'error'>(() => {
diff --git a/src/components/viewport/states/VueScreenerTableState.vue b/src/components/viewport/states/VueScreenerTableState.vue
index 86e9f2f..a35c081 100644
--- a/src/components/viewport/states/VueScreenerTableState.vue
+++ b/src/components/viewport/states/VueScreenerTableState.vue
@@ -35,7 +35,7 @@
 </template>
 
 <script lang="ts" setup>
-import type { VueScreener } from '../../../interfaces/vue-screener'
+import type { IVueScreener } from '../../../interfaces/vue-screener'
 import VueScreenerTableRow from '../../table/VueScreenerTableRow.vue'
 import VueScreenerTableSummaryRow from '../../table/VueScreenerTableSummaryRow.vue'
 import VueScreenerTableCell from '../../table/VueScreenerTableCell.vue'
@@ -44,6 +44,6 @@ import VueScreenerTable from '../../table/VueScreenerTable.vue'
 import VueScreenerTableHead from '../../table/VueScreenerTableHead.vue'
 
 defineProps<{
-  screener: VueScreener
+  screener: IVueScreener
 }>()
 </script>
diff --git a/src/hooks/use-vue-screener.ts b/src/hooks/use-vue-screener.ts
index 2c010dd..904c46c 100644
--- a/src/hooks/use-vue-screener.ts
+++ b/src/hooks/use-vue-screener.ts
@@ -1,9 +1,9 @@
-import { Column, Row, VueScreener, SearchQuery, VueScreenerOptions } from '@/interfaces/vue-screener'
+import { Column, Row, IVueScreener, SearchQuery, VueScreenerOptions } from '@/interfaces/vue-screener'
 import { createColumn, getFields, getPaginated, isValidInput, convertToRows, sortRows } from '../utils/data.utils'
 import { computed, ref } from 'vue'
 import { search } from '../utils/search.utils'
 
-export const useVueScreener = (inputData?: unknown[], defaultOptions: VueScreenerOptions = {}): VueScreener => {
+export const useVueScreener = (inputData?: unknown[], defaultOptions: VueScreenerOptions = {}): IVueScreener => {
   const options = ref<VueScreenerOptions>({
     contentHeight: defaultOptions.contentHeight,
     disableSearchHighlight: defaultOptions.disableSearchHighlight ?? false,
diff --git a/src/index.ts b/src/index.ts
index 08d2e4f..662b4c6 100644
--- a/src/index.ts
+++ b/src/index.ts
@@ -20,6 +20,8 @@ import VueScreenerPaginationRowsPerPage from './components/pagination/VueScreene
 import { useVueScreener } from './hooks/use-vue-screener'
 import './assets/tailwind.css'
 
+export type { IVueScreener, VueScreenerOptions, SearchQuery, Column, Row, DataType } from './interfaces/vue-screener'
+
 export {
   // Base component
   VueScreener,
diff --git a/src/interfaces/vue-screener.ts b/src/interfaces/vue-screener.ts
index 13a5048..c94d965 100644
--- a/src/interfaces/vue-screener.ts
+++ b/src/interfaces/vue-screener.ts
@@ -12,7 +12,7 @@ export type VueScreenerOptions = {
   loading?: boolean
 }
 
-export type VueScreener = {
+export interface IVueScreener {
   options: Ref<VueScreenerOptions>
   searchQuery: Ref<SearchQuery>
   hasError: ComputedRef<boolean>