@starter-solutions/inertia-data-table-vue 0.3.0 → 0.4.0

package/dist/composables/useDataTable.d.ts

@@ -3,8 +3,8 @@ import { MaybeRefOrGetter } from 'vue';
 
 export declare const useDataTable: <T>(tableKey: MaybeRefOrGetter<string>, options?: MaybeRefOrGetter<InertiaDataTableOptions>) => {
     data: import('vue').ComputedRef<T[]>;
+    reload: (pagination?: Partial<PaginatedRequest>) => void;
     pagination: import('vue').ComputedRef<Required<import('../types').NormalizedPagination>>;
-    reloadData: (request?: Partial<PaginatedRequest>) => void;
     firstPage: () => void;
     previousPage: () => void;
     nextPage: () => void;
@@ -12,4 +12,12 @@ export declare const useDataTable: <T>(tableKey: MaybeRefOrGetter<string>, optio
     goToPage: (newPage: number) => void;
     itemsPerPage: (perPage: number) => void;
     sortBy: (sort_by: string, descending?: boolean) => void;
+    filter: Record<string, any>;
+    setFilter: (key: string, value: any) => void;
+    setFilters: (filters: Array<{
+        key: string;
+        value: any;
+    }>) => void;
+    removeFilter: (key: string) => void;
+    resetFilters: () => void;
 };

package/dist/index.cjs

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const _=require("@inertiajs/vue3"),r=require("vue"),b=(e,o)=>{const n=_.usePage(),t=r.computed(()=>{const a=r.toValue(o);return{tableKey:r.toValue(e),pagePropsKey:r.toValue(a==null?void 0:a.pagePropsKey)??r.toValue(e),useUrlQuery:r.toValue(a==null?void 0:a.useUrlQuery)??!1}}),u=r.computed(()=>n.props.inertiaDataTable.stateRoutes),p=r.computed(()=>n.props.inertiaDataTable.queryParams),s=r.computed(()=>n.props.inertiaDataTable.defaults);return{settings:t,stateRoutes:u,queryParams:p,defaults:s}},f=e=>{const o=r.computed(()=>D(r.toValue(e))),n=r.computed(()=>o.value.data),t=r.computed(()=>o.value.pagination);return{data:n,pagination:t,getPaginatedRequest:(s={})=>({page:s.page??t.value.current_page,per_page:s.per_page??t.value.per_page,sort_by:s.sort_by??t.value.sort_by,descending:s.descending??t.value.descending}),validPage:s=>s>0&&s<=t.value.last_page}},D=e=>({data:(e==null?void 0:e.data)??[],pagination:T(e)}),K=e=>"meta"in e&&typeof e.meta=="object"&&e.meta!==null,T=e=>{if(!e)return{current_page:1,last_page:1,per_page:10,total:0,from:null,to:null,path:"",links:[],first_page_url:null,last_page_url:null,next_page_url:null,prev_page_url:null,sort_by:"id",descending:!1};if(K(e))return{current_page:e.meta.current_page,last_page:e.meta.last_page,per_page:e.meta.per_page,total:e.meta.total,from:e.meta.from,to:e.meta.to,path:e.meta.path,links:e.meta.links,first_page_url:e.links.first,last_page_url:e.links.last,next_page_url:e.links.next,prev_page_url:e.links.prev,sort_by:e.meta.sort_by??"id",descending:e.meta.descending??!1};const{current_page:o,last_page:n,per_page:t,total:u,from:p,to:s,path:a,links:c,first_page_url:v,last_page_url:g,next_page_url:m,prev_page_url:d,sort_by:y,descending:P}=e;return{current_page:o,last_page:n,per_page:t,total:u,from:p,to:s,path:a,links:c,first_page_url:v,last_page_url:g,next_page_url:m,prev_page_url:d,sort_by:y??"id",descending:P??!1}},S=(e,o)=>{const{stateRoutes:n,settings:t}=b(e,o);r.onBeforeUnmount(()=>{_.router.delete(n.value.drop,{preserveScroll:!0,preserveState:!0,data:{tableKey:t.value.tableKey}})});const u=_.usePage(),p=r.computed(()=>u.props[t.value.pagePropsKey]??null),{data:s,pagination:a,getPaginatedRequest:c,validPage:v}=f(p),g=l=>{l=c(l),t.value.useUrlQuery?_.router.reload({only:[t.value.pagePropsKey],data:{tableKey:t.value.tableKey,...l}}):_.router.post(n.value.set,{tableKey:t.value.tableKey,data:{...l}},{preserveState:!0,preserveScroll:!0,only:[t.value.pagePropsKey]})},m=()=>{i(1)},d=()=>{i(a.value.current_page-1)},y=()=>{i(a.value.current_page+1)},P=()=>{i(a.value.last_page)},i=l=>{if(!v(l)){console.error(`Invalid page: ${l}`);return}g(c({page:l}))};return{data:s,pagination:a,reloadData:g,firstPage:m,previousPage:d,nextPage:y,lastPage:P,goToPage:i,itemsPerPage:l=>{g(c({per_page:l,page:1}))},sortBy:(l,k)=>{const R=k??a.value.sort_by===l?!a.value.descending:!1;g(c({sort_by:l,descending:R}))}}};function V(){return{install(e){}}}exports.createInertiaDataTable=V;exports.getPaginationMeta=T;exports.isResource=K;exports.normalizePagination=D;exports.useDataTable=S;exports.useInertiaDataTableConfig=b;exports.useLaravelPagination=f;
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const m=require("@inertiajs/vue3"),l=require("vue"),D=(e,u)=>{const o=m.usePage(),r=l.computed(()=>{const t=l.toValue(u),_=l.toValue(e),g=l.toValue(t==null?void 0:t.pagePropsKey)??_,n=l.toValue(t==null?void 0:t.useUrlQuery)??!1,d=l.toValue(t==null?void 0:t.reloadOnly)?[g,...l.toValue(t==null?void 0:t.reloadOnly)]:[g];return{tableKey:_,pagePropsKey:g,useUrlQuery:n,reloadOnly:d}}),i=l.computed(()=>o.props.inertiaDataTable.stateRoutes),p=l.computed(()=>o.props.inertiaDataTable.queryParams),s=l.computed(()=>o.props.inertiaDataTable.defaults);return{settings:r,stateRoutes:i,queryParams:p,defaults:s}},T=e=>{const u=l.computed(()=>k(l.toValue(e))),o=l.computed(()=>u.value.data),r=l.computed(()=>u.value.pagination);return{data:o,pagination:r,getPaginatedRequest:(s={})=>({page:s.page??r.value.current_page,per_page:s.per_page??r.value.per_page,sort_by:s.sort_by??r.value.sort_by,descending:s.descending??r.value.descending}),validPage:s=>s>0&&s<=r.value.last_page}},k=e=>({data:(e==null?void 0:e.data)??[],pagination:O(e)}),F=e=>"meta"in e&&typeof e.meta=="object"&&e.meta!==null,O=e=>{if(!e)return{current_page:1,last_page:1,per_page:10,total:0,from:null,to:null,path:"",links:[],first_page_url:null,last_page_url:null,next_page_url:null,prev_page_url:null,sort_by:"id",descending:!1};if(F(e))return{current_page:e.meta.current_page,last_page:e.meta.last_page,per_page:e.meta.per_page,total:e.meta.total,from:e.meta.from,to:e.meta.to,path:e.meta.path,links:e.meta.links,first_page_url:e.links.first,last_page_url:e.links.last,next_page_url:e.links.next,prev_page_url:e.links.prev,sort_by:e.meta.sort_by??"id",descending:e.meta.descending??!1};const{current_page:u,last_page:o,per_page:r,total:i,from:p,to:s,path:t,links:_,first_page_url:g,last_page_url:n,next_page_url:d,prev_page_url:b,sort_by:f,descending:P}=e;return{current_page:u,last_page:o,per_page:r,total:i,from:p,to:s,path:t,links:_,first_page_url:g,last_page_url:n,next_page_url:d,prev_page_url:b,sort_by:f??"id",descending:P??!1}},V=(e,u)=>{const{stateRoutes:o,settings:r}=D(e,u);l.onBeforeUnmount(()=>{m.router.delete(o.value.drop,{preserveScroll:!0,preserveState:!0,data:{tableKey:r.value.tableKey}})});const i=m.usePage(),p=l.computed(()=>i.props[r.value.pagePropsKey]??null),{data:s,pagination:t,getPaginatedRequest:_,validPage:g}=T(p),n=a=>{a=_(a),r.value.useUrlQuery?m.router.reload({only:r.value.reloadOnly,data:{tableKey:r.value.tableKey,filter:c,...a}}):m.router.post(o.value.set,{tableKey:r.value.tableKey,filter:c,pagination:a},{preserveState:!0,preserveScroll:!0,only:r.value.reloadOnly})},d=()=>{v(1)},b=()=>{v(t.value.current_page-1)},f=()=>{v(t.value.current_page+1)},P=()=>{v(t.value.last_page)},v=a=>{if(!g(a)){console.error(`Invalid page: ${a}`);return}n({page:a})},R=a=>{n({per_page:a,page:1})},q=(a,y)=>{const K=y??t.value.sort_by===a?!t.value.descending:!1;n({sort_by:a,descending:K})},c=l.reactive({});return{data:s,reload:n,pagination:t,firstPage:d,previousPage:b,nextPage:f,lastPage:P,goToPage:v,itemsPerPage:R,sortBy:q,filter:c,setFilter:(a,y)=>{c[a]=y,n()},setFilters:a=>{a.forEach(({key:y,value:K})=>{c[y]=K}),n()},removeFilter:a=>{delete c[a],n()},resetFilters:()=>{Object.keys(c).forEach(a=>delete c[a]),n()}}};function h(){return{install(e){}}}exports.createInertiaDataTable=h;exports.getPaginationMeta=O;exports.isResource=F;exports.normalizePagination=k;exports.useDataTable=V;exports.useInertiaDataTableConfig=D;exports.useLaravelPagination=T;

package/dist/index.js

@@ -1,45 +1,46 @@
-import { usePage as b, router as P } from "@inertiajs/vue3";
-import { computed as o, toValue as _, onBeforeUnmount as k } from "vue";
-const R = (e, n) => {
-  const l = b(), t = o(() => {
-    const a = _(n);
+import { usePage as D, router as k } from "@inertiajs/vue3";
+import { computed as c, toValue as p, onBeforeUnmount as R, reactive as T } from "vue";
+const h = (e, o) => {
+  const n = D(), r = c(() => {
+    const t = p(o), y = p(e), g = p(t == null ? void 0 : t.pagePropsKey) ?? y, s = p(t == null ? void 0 : t.useUrlQuery) ?? !1, v = p(t == null ? void 0 : t.reloadOnly) ? [g, ...p(t == null ? void 0 : t.reloadOnly)] : [g];
     return {
-      tableKey: _(e),
-      pagePropsKey: _(a == null ? void 0 : a.pagePropsKey) ?? _(e),
-      useUrlQuery: _(a == null ? void 0 : a.useUrlQuery) ?? !1
+      tableKey: y,
+      pagePropsKey: g,
+      useUrlQuery: s,
+      reloadOnly: v
     };
-  }), u = o(
-    () => l.props.inertiaDataTable.stateRoutes
-  ), p = o(
-    () => l.props.inertiaDataTable.queryParams
-  ), r = o(
-    () => l.props.inertiaDataTable.defaults
+  }), _ = c(
+    () => n.props.inertiaDataTable.stateRoutes
+  ), i = c(
+    () => n.props.inertiaDataTable.queryParams
+  ), l = c(
+    () => n.props.inertiaDataTable.defaults
   );
   return {
-    settings: t,
-    stateRoutes: u,
-    queryParams: p,
-    defaults: r
+    settings: r,
+    stateRoutes: _,
+    queryParams: i,
+    defaults: l
   };
-}, T = (e) => {
-  const n = o(() => x(_(e))), l = o(() => n.value.data), t = o(
-    () => n.value.pagination
+}, x = (e) => {
+  const o = c(() => q(p(e))), n = c(() => o.value.data), r = c(
+    () => o.value.pagination
   );
   return {
-    data: l,
-    pagination: t,
-    getPaginatedRequest: (r = {}) => ({
-      page: r.page ?? t.value.current_page,
-      per_page: r.per_page ?? t.value.per_page,
-      sort_by: r.sort_by ?? t.value.sort_by,
-      descending: r.descending ?? t.value.descending
+    data: n,
+    pagination: r,
+    getPaginatedRequest: (l = {}) => ({
+      page: l.page ?? r.value.current_page,
+      per_page: l.per_page ?? r.value.per_page,
+      sort_by: l.sort_by ?? r.value.sort_by,
+      descending: l.descending ?? r.value.descending
     }),
-    validPage: (r) => r > 0 && r <= t.value.last_page
+    validPage: (l) => l > 0 && l <= r.value.last_page
   };
-}, x = (e) => ({
+}, q = (e) => ({
   data: (e == null ? void 0 : e.data) ?? [],
-  pagination: S(e)
-}), h = (e) => "meta" in e && typeof e.meta == "object" && e.meta !== null, S = (e) => {
+  pagination: Q(e)
+}), U = (e) => "meta" in e && typeof e.meta == "object" && e.meta !== null, Q = (e) => {
   if (!e)
     return {
       current_page: 1,
@@ -59,7 +60,7 @@ const R = (e, n) => {
       sort_by: "id",
       descending: !1
     };
-  if (h(e))
+  if (U(e))
     return {
       current_page: e.meta.current_page,
       last_page: e.meta.last_page,
@@ -79,116 +80,136 @@ const R = (e, n) => {
       descending: e.meta.descending ?? !1
     };
   const {
-    current_page: n,
-    last_page: l,
-    per_page: t,
-    total: u,
-    from: p,
-    to: r,
-    path: a,
-    links: g,
+    current_page: o,
+    last_page: n,
+    per_page: r,
+    total: _,
+    from: i,
+    to: l,
+    path: t,
+    links: y,
     //links
-    first_page_url: v,
-    last_page_url: c,
-    next_page_url: m,
-    prev_page_url: y,
+    first_page_url: g,
+    last_page_url: s,
+    next_page_url: v,
+    prev_page_url: f,
     //custom
-    sort_by: f,
-    descending: d
+    sort_by: b,
+    descending: P
   } = e;
   return {
-    current_page: n,
-    last_page: l,
-    per_page: t,
-    total: u,
-    from: p,
-    to: r,
-    path: a,
-    links: g,
+    current_page: o,
+    last_page: n,
+    per_page: r,
+    total: _,
+    from: i,
+    to: l,
+    path: t,
+    links: y,
     //links
-    first_page_url: v,
-    last_page_url: c,
-    next_page_url: m,
-    prev_page_url: y,
+    first_page_url: g,
+    last_page_url: s,
+    next_page_url: v,
+    prev_page_url: f,
     //custom
-    sort_by: f ?? "id",
-    descending: d ?? !1
+    sort_by: b ?? "id",
+    descending: P ?? !1
   };
-}, q = (e, n) => {
-  const { stateRoutes: l, settings: t } = R(
+}, C = (e, o) => {
+  const { stateRoutes: n, settings: r } = h(
     e,
-    n
+    o
   );
-  k(() => {
-    P.delete(l.value.drop, {
+  R(() => {
+    k.delete(n.value.drop, {
       preserveScroll: !0,
       preserveState: !0,
-      data: { tableKey: t.value.tableKey }
+      data: { tableKey: r.value.tableKey }
     });
   });
-  const u = b(), p = o(
-    () => u.props[t.value.pagePropsKey] ?? null
-  ), { data: r, pagination: a, getPaginatedRequest: g, validPage: v } = T(p), c = (s) => {
-    s = g(s), t.value.useUrlQuery ? P.reload({
-      only: [t.value.pagePropsKey],
-      data: { tableKey: t.value.tableKey, ...s }
-    }) : P.post(
-      l.value.set,
+  const _ = D(), i = c(
+    () => _.props[r.value.pagePropsKey] ?? null
+  ), { data: l, pagination: t, getPaginatedRequest: y, validPage: g } = x(i), s = (a) => {
+    a = y(a), r.value.useUrlQuery ? k.reload({
+      only: r.value.reloadOnly,
+      data: {
+        tableKey: r.value.tableKey,
+        filter: u,
+        ...a
+      }
+    }) : k.post(
+      n.value.set,
       {
-        tableKey: t.value.tableKey,
-        data: { ...s }
+        tableKey: r.value.tableKey,
+        filter: u,
+        pagination: a
       },
       {
         preserveState: !0,
         preserveScroll: !0,
-        only: [t.value.pagePropsKey]
+        only: r.value.reloadOnly
       }
     );
-  }, m = () => {
-    i(1);
-  }, y = () => {
-    i(a.value.current_page - 1);
+  }, v = () => {
+    d(1);
   }, f = () => {
-    i(a.value.current_page + 1);
-  }, d = () => {
-    i(a.value.last_page);
-  }, i = (s) => {
-    if (!v(s)) {
-      console.error(`Invalid page: ${s}`);
+    d(t.value.current_page - 1);
+  }, b = () => {
+    d(t.value.current_page + 1);
+  }, P = () => {
+    d(t.value.last_page);
+  }, d = (a) => {
+    if (!g(a)) {
+      console.error(`Invalid page: ${a}`);
       return;
     }
-    c(g({ page: s }));
-  };
+    s({ page: a });
+  }, F = (a) => {
+    s({ per_page: a, page: 1 });
+  }, O = (a, m) => {
+    const K = m ?? t.value.sort_by === a ? !t.value.descending : !1;
+    s({ sort_by: a, descending: K });
+  }, u = T({});
   return {
-    data: r,
-    pagination: a,
-    reloadData: c,
-    firstPage: m,
-    previousPage: y,
-    nextPage: f,
-    lastPage: d,
-    goToPage: i,
-    itemsPerPage: (s) => {
-      c(g({ per_page: s, page: 1 }));
+    data: l,
+    reload: s,
+    pagination: t,
+    firstPage: v,
+    previousPage: f,
+    nextPage: b,
+    lastPage: P,
+    goToPage: d,
+    itemsPerPage: F,
+    sortBy: O,
+    filter: u,
+    setFilter: (a, m) => {
+      u[a] = m, s();
+    },
+    setFilters: (a) => {
+      a.forEach(({ key: m, value: K }) => {
+        u[m] = K;
+      }), s();
+    },
+    removeFilter: (a) => {
+      delete u[a], s();
     },
-    sortBy: (s, K) => {
-      const D = K ?? a.value.sort_by === s ? !a.value.descending : !1;
-      c(g({ sort_by: s, descending: D }));
+    resetFilters: () => {
+      Object.keys(u).forEach((a) => delete u[a]), s();
     }
   };
 };
-function z() {
+function L() {
   return {
     install(e) {
     }
   };
 }
 export {
-  z as createInertiaDataTable,
-  S as getPaginationMeta,
-  h as isResource,
-  x as normalizePagination,
-  q as useDataTable,
-  R as useInertiaDataTableConfig,
-  T as useLaravelPagination
+  L as createInertiaDataTable,
+  Q as getPaginationMeta,
+  U as isResource,
+  q as normalizePagination,
+  C as useDataTable,
+  h as useInertiaDataTableConfig,
+  x as useLaravelPagination
 };

package/dist/types/config.d.ts

@@ -33,9 +33,14 @@ export type InertiaDataTableOptions = {
      * The key in which the paginated data is stored in the page props. Defaults to the tableKey if not provided.
      */
     pagePropsKey?: MaybeRefOrGetter<string>;
+    /**
+     * Defines page props that should be reloaded along with the table data.
+     */
+    reloadOnly?: MaybeRefOrGetter<Array<string>>;
 };
 export type InertiaDataTableSettings = {
     tableKey: string;
     pagePropsKey: string;
     useUrlQuery: boolean;
+    reloadOnly: Array<string>;
 };

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@starter-solutions/inertia-data-table-vue",
-    "version": "0.3.0",
+    "version": "0.4.0",
     "license": "MIT",
     "description": "Vue 3 + Inertia.js data table utilities with Laravel backend integration.",
     "type": "module",