@starter-solutions/inertia-data-table-vue 0.1.4 → 0.2.0

package/README.md

@@ -1,7 +1,43 @@
-# inertia-data-table-vue
+# @starter-solutions/inertia-data-table-vue
 
-# Install
+> ⚠️ This is the **Vue 3 frontend companion package** for  
+> **starter-solutions/inertia-data-table (Laravel)**.  
+>  
+> If you are looking for the backend package, visit:  
+> 👉 https://github.com/starter-solutions/inertia-data-table-laravel
+
+---
+
+## 📦 Overview
+
+`@starter-solutions/inertia-data-table-vue` provides Vue 3 composables and components for handling:
+
+- Server-driven pagination
+- Sorting
+- Query state management
+- Inertia-powered table updates
+
+It is designed to work seamlessly with the Laravel package:
+
+**Backend (Laravel):**
+https://github.com/starter-solutions/inertia-data-table-laravel
+
+Together they provide a clean, consistent way to manage paginated and sortable data tables across your Laravel + Inertia + Vue application.
+
+---
+
+## 🚀 Installation
 
 ```bash
-npm i @starter-solutions/inertia-data-table-vue
+npm install @starter-solutions/inertia-data-table-vue
 ```
+
+## 🐛 Issues & Support
+
+Bug reports and feature requests should be submitted to the main repository:
+
+🔗 https://github.com/starter-solutions/inertia-data-table/issues
+
+## 📄 License
+
+MIT © Starter Solutions

package/dist/composables/index.d.ts

@@ -0,0 +1,2 @@
+export * from './useInertiaDataTableConfig';
+export * from './useLaravelPagination';

package/dist/composables/useInertiaDataTableConfig.d.ts

@@ -0,0 +1,9 @@
+import { InertiaDataTableDefaults, InertiaDataTableOptions, InertiaDataTableQueryParams, InertiaDataTableSettings, InertiaDataTableStateRoutes } from '../types/config';
+import { MaybeRefOrGetter } from 'vue';
+
+export declare const useInertiaDataTableConfig: (tableKey: MaybeRefOrGetter<string>, options?: MaybeRefOrGetter<InertiaDataTableOptions>) => {
+    settings: import('vue').ComputedRef<InertiaDataTableSettings>;
+    stateRoutes: import('vue').ComputedRef<InertiaDataTableStateRoutes>;
+    queryParams: import('vue').ComputedRef<InertiaDataTableQueryParams>;
+    defaults: import('vue').ComputedRef<InertiaDataTableDefaults>;
+};

package/dist/index.cjs

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const l=require("vue"),P=e=>{const r=l.computed(()=>o(l.toValue(e))),n=l.computed(()=>r.value.data),a=l.computed(()=>r.value.pagination);return{data:n,pagination:a,getPaginatedRequest:(t={})=>({page:t.page??a.value.current_page,per_page:t.per_page??a.value.per_page,sort_by:t.sort_by??a.value.sort_by,descending:t.descending??a.value.descending}),validPage:t=>t>0&&t<=a.value.last_page}},o=e=>({data:(e==null?void 0:e.data)??[],pagination:i(e)}),_=e=>"meta"in e&&typeof e.meta=="object"&&e.meta!==null,i=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(_(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:r,last_page:n,per_page:a,total:s,from:u,to:t,path:g,links:c,first_page_url:p,last_page_url:m,next_page_url:f,prev_page_url:v,sort_by:b,descending:y}=e;return{current_page:r,last_page:n,per_page:a,total:s,from:u,to:t,path:g,links:c,first_page_url:p,last_page_url:m,next_page_url:f,prev_page_url:v,sort_by:b??"id",descending:y??!1}};function d(){return{install(e){}}}exports.createInertiaDataTable=d;exports.getPaginationMeta=i;exports.isResource=_;exports.normalizePagination=o;exports.useLaravelPagination=P;
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const d=require("@inertiajs/vue3"),t=require("vue"),v=(e,n)=>{const l=d.usePage(),r=t.computed(()=>{const s=t.toValue(n);return{tableKey:t.toValue(e),pagePropsKey:t.toValue(s==null?void 0:s.pagePropsKey)??t.toValue(e),useUrlQuery:t.toValue(s==null?void 0:s.useUrlQuery)??!1}}),u=t.computed(()=>l.props.inertiaDataTable.stateRoutes),o=t.computed(()=>l.props.inertiaDataTable.queryParams),a=t.computed(()=>l.props.inertiaDataTable.defaults);return{settings:r,stateRoutes:u,queryParams:o,defaults:a}},k=e=>{const n=t.computed(()=>c(t.toValue(e))),l=t.computed(()=>n.value.data),r=t.computed(()=>n.value.pagination);return{data:l,pagination:r,getPaginatedRequest:(a={})=>({page:a.page??r.value.current_page,per_page:a.per_page??r.value.per_page,sort_by:a.sort_by??r.value.sort_by,descending:a.descending??r.value.descending}),validPage:a=>a>0&&a<=r.value.last_page}},c=e=>({data:(e==null?void 0:e.data)??[],pagination:_(e)}),i=e=>"meta"in e&&typeof e.meta=="object"&&e.meta!==null,_=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(i(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:n,last_page:l,per_page:r,total:u,from:o,to:a,path:s,links:p,first_page_url:g,last_page_url:m,next_page_url:f,prev_page_url:b,sort_by:y,descending:P}=e;return{current_page:n,last_page:l,per_page:r,total:u,from:o,to:a,path:s,links:p,first_page_url:g,last_page_url:m,next_page_url:f,prev_page_url:b,sort_by:y??"id",descending:P??!1}};function T(){return{install(e){}}}exports.createInertiaDataTable=T;exports.getPaginationMeta=_;exports.isResource=i;exports.normalizePagination=c;exports.useInertiaDataTableConfig=v;exports.useLaravelPagination=k;

package/dist/index.d.ts

@@ -1,3 +1,3 @@
-export * from './composables/useLaravelPagination';
+export * from './composables';
 export * from './plugin';
-export type * from './types/pagination';
+export type * from './types';

package/dist/index.js

@@ -1,8 +1,30 @@
-import { computed as n, toValue as v } from "vue";
-const d = (e) => {
-  const r = n(() => b(v(e))), l = n(() => r.value.data), a = n(() => r.value.pagination);
+import { usePage as b } from "@inertiajs/vue3";
+import { computed as l, toValue as u } from "vue";
+const D = (e, n) => {
+  const s = b(), a = l(() => {
+    const r = u(n);
+    return {
+      tableKey: u(e),
+      pagePropsKey: u(r == null ? void 0 : r.pagePropsKey) ?? u(e),
+      useUrlQuery: u(r == null ? void 0 : r.useUrlQuery) ?? !1
+    };
+  }), o = l(
+    () => s.props.inertiaDataTable.stateRoutes
+  ), _ = l(
+    () => s.props.inertiaDataTable.queryParams
+  ), t = l(
+    () => s.props.inertiaDataTable.defaults
+  );
+  return {
+    settings: a,
+    stateRoutes: o,
+    queryParams: _,
+    defaults: t
+  };
+}, R = (e) => {
+  const n = l(() => P(u(e))), s = l(() => n.value.data), a = l(() => n.value.pagination);
   return {
-    data: l,
+    data: s,
     pagination: a,
     getPaginatedRequest: (t = {}) => ({
       page: t.page ?? a.value.current_page,
@@ -12,10 +34,10 @@ const d = (e) => {
     }),
     validPage: (t) => t > 0 && t <= a.value.last_page
   };
-}, b = (e) => ({
+}, P = (e) => ({
   data: (e == null ? void 0 : e.data) ?? [],
   pagination: k(e)
-}), y = (e) => "meta" in e && typeof e.meta == "object" && e.meta !== null, k = (e) => {
+}), v = (e) => "meta" in e && typeof e.meta == "object" && e.meta !== null, k = (e) => {
   if (!e)
     return {
       current_page: 1,
@@ -35,7 +57,7 @@ const d = (e) => {
       sort_by: "id",
       descending: !1
     };
-  if (y(e))
+  if (v(e))
     return {
       current_page: e.meta.current_page,
       last_page: e.meta.last_page,
@@ -55,52 +77,53 @@ const d = (e) => {
       descending: e.meta.descending ?? !1
     };
   const {
-    current_page: r,
-    last_page: l,
+    current_page: n,
+    last_page: s,
     per_page: a,
-    total: s,
+    total: o,
     from: _,
     to: t,
-    path: u,
-    links: o,
+    path: r,
+    links: p,
     //links
-    first_page_url: p,
-    last_page_url: g,
-    next_page_url: c,
-    prev_page_url: i,
+    first_page_url: g,
+    last_page_url: c,
+    next_page_url: i,
+    prev_page_url: m,
     //custom
-    sort_by: m,
-    descending: f
+    sort_by: f,
+    descending: y
   } = e;
   return {
-    current_page: r,
-    last_page: l,
+    current_page: n,
+    last_page: s,
     per_page: a,
-    total: s,
+    total: o,
     from: _,
     to: t,
-    path: u,
-    links: o,
+    path: r,
+    links: p,
     //links
-    first_page_url: p,
-    last_page_url: g,
-    next_page_url: c,
-    prev_page_url: i,
+    first_page_url: g,
+    last_page_url: c,
+    next_page_url: i,
+    prev_page_url: m,
     //custom
-    sort_by: m ?? "id",
-    descending: f ?? !1
+    sort_by: f ?? "id",
+    descending: y ?? !1
   };
 };
-function x() {
+function T() {
   return {
     install(e) {
     }
   };
 }
 export {
-  x as createInertiaDataTable,
+  T as createInertiaDataTable,
   k as getPaginationMeta,
-  y as isResource,
-  b as normalizePagination,
-  d as useLaravelPagination
+  v as isResource,
+  P as normalizePagination,
+  D as useInertiaDataTableConfig,
+  R as useLaravelPagination
 };

package/dist/types/config.d.ts

@@ -0,0 +1,41 @@
+import { MaybeRefOrGetter } from 'vue';
+
+export type InertiaDataTableStateRoutes = {
+    set: string;
+    drop: string;
+    dropAll: string;
+};
+export type InertiaDataTableQueryParams = {
+    tableKey: string;
+    perPage: string;
+    sortBy: string;
+    descending: string;
+    pageName: string;
+};
+export type InertiaDataTableDefaults = {
+    perPage: number;
+    sortBy: string;
+};
+export type InertiaDataTableSharedProps = {
+    inertiaDataTable: {
+        stateRoutes: InertiaDataTableStateRoutes;
+        queryParams: InertiaDataTableQueryParams;
+        defaults: InertiaDataTableDefaults;
+    };
+};
+export type InertiaDataTableOptions = {
+    /**
+     * Whether to use the URL query for pagination and sorting state. If false, the state is stored in the session.
+     * Using the URL query allows for better shareability of links, but requires more complex handling of the query parameters in the backend.
+     */
+    useUrlQuery?: MaybeRefOrGetter<boolean>;
+    /**
+     * The key in which the paginated data is stored in the page props. Defaults to the tableKey if not provided.
+     */
+    pagePropsKey?: MaybeRefOrGetter<string>;
+};
+export type InertiaDataTableSettings = {
+    tableKey: string;
+    pagePropsKey: string;
+    useUrlQuery: boolean;
+};

package/dist/types/index.d.ts

@@ -0,0 +1,2 @@
+export type * from './config';
+export type * from './pagination';

package/package.json

@@ -1,7 +1,8 @@
 {
     "name": "@starter-solutions/inertia-data-table-vue",
-    "version": "0.1.4",
+    "version": "0.2.0",
     "license": "MIT",
+    "description": "Vue 3 + Inertia.js data table utilities with Laravel backend integration.",
     "type": "module",
     "main": "./dist/index.cjs",
     "module": "./dist/index.js",
@@ -16,10 +17,35 @@
             "types": "./dist/index.d.ts"
         }
     },
+    "author": {
+        "name": "Luca Hoffmann",
+        "url": "https://github.com/HoffmannLuca"
+    },
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/starter-solutions/inertia-data-table-vue.git"
+    },
+    "homepage": "https://github.com/starter-solutions/inertia-data-table#readme",
+    "bugs": {
+        "url": "https://github.com/starter-solutions/inertia-data-table/issues"
+    },
+    "keywords": [
+        "laravel",
+        "inertia",
+        "vue",
+        "vue3",
+        "typescript",
+        "data-table",
+        "pagination",
+        "sorting"
+    ],
     "scripts": {
         "typecheck": "tsc -p tsconfig.build.json --noEmit",
         "build": "vite build",
-        "dev": "vite"
+        "dev": "vite",
+        "git-patch": "npm version patch && git push --follow-tags",
+        "git-minor": "npm version minor && git push --follow-tags",
+        "git-major": "npm version major && git push --follow-tags"
     },
     "peerDependencies": {
         "@inertiajs/vue3": "^2.0.0",