@arrai-innovations/reactive-helpers 20.0.0 → 20.1.0

package/config/listCrud.js

@@ -10,15 +10,16 @@ import { readonly } from "vue";
 
 /**
  * @typedef {object} PaginateInfo
- * @property {number} totalRecords - The total records.
- * @property {number} totalPages - The total pages.
- * @property {number} perPage - The per page.
+ * @property {number} [totalRecords] - The total records.
+ * @property {number} [totalPages] - The total pages.
+ * @property {number} [perPage] - The per page.
+ * @property {number} [page] - The page you are giving us results for.
  */
 
 /**
  * @typedef {(
  *     newObjects:import('../use/listInstance.js').ListObject,
- *     paginationInfo: PaginateInfo|undefined
+ *     paginationInfo?: PaginateInfo,
  * )=>void} PageCallback
  */
 

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@arrai-innovations/reactive-helpers",
-    "version": "20.0.0",
+    "version": "20.1.0",
     "description": "VueJS 3 utility composition functions to help manipulate objects and lists.",
     "main": "index.js",
     "type": "module",

package/types/config/listCrud.d.ts

@@ -13,17 +13,21 @@ export type PaginateInfo = {
     /**
      * - The total records.
      */
-    totalRecords: number;
+    totalRecords?: number;
     /**
      * - The total pages.
      */
-    totalPages: number;
+    totalPages?: number;
     /**
      * - The per page.
      */
-    perPage: number;
+    perPage?: number;
+    /**
+     * - The page you are giving us results for.
+     */
+    page?: number;
 };
-export type PageCallback = (newObjects: import("../use/listInstance.js").ListObject, paginationInfo: PaginateInfo | undefined) => void;
+export type PageCallback = (newObjects: import("../use/listInstance.js").ListObject, paginationInfo?: PaginateInfo) => void;
 export type ListArgs = {
     /**
      * - The arguments to be passed to the crud handlers.

package/types/config/listCrud.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"listCrud.d.ts","sourceRoot":"","sources":["../../config/listCrud.js"],"names":[],"mappings":"AAkHA;;;;GAIG;AACH,8BAFU,QAAQ,CAAC,gBAAgB,CAAC,CAEkB;AAS/C,+CAJI,gBAAgB,GAAG,OAAO,CAAC,UAAU,CAAC,GAEpC,IAAI,CAUhB;AAWM,oCANI,OAAO,KAAK,EAAE,gBAAgB,CAAC,gBAAgB,GAAG,UAAU,CAAC,WAErE;IAAmE,KAAK,GAAhE,OAAO,KAAK,EAAE,gBAAgB,CAAC,gBAAgB,CAAC;IACrB,QAAQ,GAAnC,gBAAgB;CACxB,QAIF;;;;;kBAzIa,MAAM;;;;gBACN,MAAM;;;;aACN,MAAM;;2BAIP,CACN,UAAU,EAAC,OAAO,wBAAwB,EAAE,UAAU,EACtD,cAAc,EAAE,YAAY,GAAC,SAAS,KACvC,IAAI;;;;;YAKI,MAAM;;;;WACN,MAAM;;;;YACN,MAAM;;;;kBACN,YAAY;;;;;iBACZ,QAAQ,CAAC,OAAO,KAAK,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC;;;;;;YAMpC,MAAM;;;;SACN,MAAM,EAAE;;;;WACR,MAAM;;;;;iBACN,QAAQ,CAAC,OAAO,KAAK,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC;;wCAKrC,CACN,0BAA0B,EAAC,OAAO,wBAAwB,EAAE,UAAU,GAAC,MAAM,EAC7E,MAAM,EAAE,QAAQ,GAAC,QAAQ,GAAC,QAAQ,KACnC,IAAI;;;;;YAKI,MAAM;;;;WACN,MAAM;;;;YACN,MAAM;;;;+BACN,yBAAyB;;;;;iBACzB,QAAQ,CAAC,OAAO,KAAK,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC;;;;;;YAMpC,MAAM;;;;SACN,MAAM,EAAE;;;;WACR,MAAM;;;;YACN,MAAM;;;;;iBACN,QAAQ,CAAC,OAAO,KAAK,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC;;gCAMvC,QAAQ,KACN,OAAO,gCAAgC,EAAE,uBAAuB,CAAC,IAAI,CAAC;sCAKxE,cAAc,KACZ,OAAO,gCAAgC,EAAE,uBAAuB,CAAC,IAAI,CAAC;yCAKxE,iBAAiB,KACf,OAAO,gCAAgC,EAAE,kBAAkB,CAAC,IAAI,CAAC;yCAKnE,iBAAiB,KACf,OAAO,gCAAgC,EAAE,uBAAuB,CAAC,MAAM,GAAC,MAAM,GAAC,IAAI,CAAC;;;;;WAKnF,UAAU;;;;iBACV,gBAAgB;;;;oBAChB,mBAAmB;;;;gBACnB,mBAAmB;;;;;;UAKnB,MAAM;;;;;;aAKN,MAAM"}
+{"version":3,"file":"listCrud.d.ts","sourceRoot":"","sources":["../../config/listCrud.js"],"names":[],"mappings":"AAmHA;;;;GAIG;AACH,8BAFU,QAAQ,CAAC,gBAAgB,CAAC,CAEkB;AAS/C,+CAJI,gBAAgB,GAAG,OAAO,CAAC,UAAU,CAAC,GAEpC,IAAI,CAUhB;AAWM,oCANI,OAAO,KAAK,EAAE,gBAAgB,CAAC,gBAAgB,GAAG,UAAU,CAAC,WAErE;IAAmE,KAAK,GAAhE,OAAO,KAAK,EAAE,gBAAgB,CAAC,gBAAgB,CAAC;IACrB,QAAQ,GAAnC,gBAAgB;CACxB,QAIF;;;;;mBA1Ia,MAAM;;;;iBACN,MAAM;;;;cACN,MAAM;;;;WACN,MAAM;;2BAIP,CACN,UAAU,EAAC,OAAO,wBAAwB,EAAE,UAAU,EACtD,cAAc,CAAC,EAAE,YAAY,KAC9B,IAAI;;;;;YAKI,MAAM;;;;WACN,MAAM;;;;YACN,MAAM;;;;kBACN,YAAY;;;;;iBACZ,QAAQ,CAAC,OAAO,KAAK,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC;;;;;;YAMpC,MAAM;;;;SACN,MAAM,EAAE;;;;WACR,MAAM;;;;;iBACN,QAAQ,CAAC,OAAO,KAAK,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC;;wCAKrC,CACN,0BAA0B,EAAC,OAAO,wBAAwB,EAAE,UAAU,GAAC,MAAM,EAC7E,MAAM,EAAE,QAAQ,GAAC,QAAQ,GAAC,QAAQ,KACnC,IAAI;;;;;YAKI,MAAM;;;;WACN,MAAM;;;;YACN,MAAM;;;;+BACN,yBAAyB;;;;;iBACzB,QAAQ,CAAC,OAAO,KAAK,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC;;;;;;YAMpC,MAAM;;;;SACN,MAAM,EAAE;;;;WACR,MAAM;;;;YACN,MAAM;;;;;iBACN,QAAQ,CAAC,OAAO,KAAK,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC;;gCAMvC,QAAQ,KACN,OAAO,gCAAgC,EAAE,uBAAuB,CAAC,IAAI,CAAC;sCAKxE,cAAc,KACZ,OAAO,gCAAgC,EAAE,uBAAuB,CAAC,IAAI,CAAC;yCAKxE,iBAAiB,KACf,OAAO,gCAAgC,EAAE,kBAAkB,CAAC,IAAI,CAAC;yCAKnE,iBAAiB,KACf,OAAO,gCAAgC,EAAE,uBAAuB,CAAC,MAAM,GAAC,MAAM,GAAC,IAAI,CAAC;;;;;WAKnF,UAAU;;;;iBACV,gBAAgB;;;;oBAChB,mBAAmB;;;;gBACnB,mBAAmB;;;;;;UAKnB,MAAM;;;;;;aAKN,MAAM"}

package/types/use/objectInstance.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"objectInstance.d.ts","sourceRoot":"","sources":["../../use/objectInstance.js"],"names":[],"mappings":"AAwIA;;;;;GAKG;AACH,iDAHW;IAAC,CAAC,GAAG,EAAE,MAAM,GAAG,qBAAqB,CAAA;CAAC,GACpC;IAAC,CAAC,GAAG,EAAE,MAAM,GAAG,cAAc,CAAA;CAAC,CAS3C;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmDG;AACH,uDAHW,qBAAqB,GACnB,cAAc,CAiR1B;AAndD;;;;GAIG;AAEH;;;;GAIG;AAEH;;GAEG;AAEH;;GAEG;AAEH;;;;;;GAMG;AAEH;;;;;;;;GAQG;AAEH;;;;;;;;;GASG;AAEH;;;;;;;;;;;;;GAaG;AAEH;;;;;GAKG;AAEH;;;;;;;;;;;GAWG;AAEH;;;;;GAKG;AAEH;;;;GAIG;AAEH;;;GAGG;AACH;IACI;;;;;OAKG;IACH,qBAHW,MAAM,QACN,MAAM,EAMhB;IADG,aAAgB;CAEvB;AAED,+CAUE;AAEF,+CAAkH;;;;iCAtHrG;IAAC,KAAK,EAAE,MAAM,CAAC;IAAC,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;CAAC;4BAInC;IAAC,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;CAAC;yBAIpB,kBAAkB,GAAC,aAAa;;;;;;;;WAO/B,OAAO,KAAK,EAAE,gBAAgB,CAAC,sBAAsB,CAAC;;;;eACtD,OAAO,yBAAyB,EAAE,kBAAkB;;;;;;;;;SAOpD,MAAM;;;;WACN,MAAM;;;;YACN,MAAM;;;;YACN,OAAO,yBAAyB,EAAE,YAAY;;;;;;UAK9C,OAAO,KAAK,EAAE,QAAQ,CAAC,OAAO,yBAAyB,EAAE,gBAAgB,GAAC,EAAE,CAAC;;;;YAC7E,OAAO,yBAAyB,EAAE,YAAY;;;;cAC9C,OAAO,yBAAyB,EAAE,cAAc;;;;YAChD,OAAO,yBAAyB,EAAE,YAAY;;;;WAC9C,OAAO,yBAAyB,EAAE,WAAW;;;;YAC7C,OAAO,yBAAyB,EAAE,YAAY;;;;eAC9C,OAAO,yBAAyB,EAAE,qBAAqB;;;;;;;;;UAOvD,OAAO,KAAK,EAAE,QAAQ,CAAC,0BAA0B,CAAC;;;;QAClD,OAAO,KAAK,EAAE,GAAG,CAAC,MAAM,GAAC,SAAS,CAAC;;;;WACnC,OAAO,KAAK,EAAE,GAAG,CAAC,MAAM,GAAC,SAAS,CAAC;;;;YACnC,OAAO,KAAK,EAAE,GAAG,CAAC;QAAC,CAAC,GAAG,EAAC,MAAM,GAAG,GAAG,CAAA;KAAC,CAAC;;;;YACtC,OAAO,KAAK,EAAE,QAAQ,CAAC,UAAU,CAAC;;;;aAClC,QAAQ,CAAC,OAAO,KAAK,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC;;;;aACpC,QAAQ,CAAC,OAAO,KAAK,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC;;;;WACpC,QAAQ,CAAC,OAAO,KAAK,EAAE,GAAG,CAAC,KAAK,GAAC,IAAI,CAAC,CAAC;;;;aACvC,OAAO;;;;;;kCAOR,OAAO,KAAK,EAAE,QAAQ,CAAC,sBAAsB,CAAC;;;;;;;;YAO7C,CAAC,IAAI,EAAE;QAAE,MAAM,EAAE,MAAM,CAAA;KAAE,KAAK,OAAO,gCAAgC,EAAE,uBAAuB,CAAC,OAAO,CAAC;;;;cACvG,MAAM,OAAO,gCAAgC,EAAE,uBAAuB,CAAC,OAAO,CAAC;;;;YAC/E,CAAC,IAAI,EAAE;QAAE,MAAM,EAAE,kBAAkB,CAAA;KAAE,KAAK,OAAO,gCAAgC,EAAE,uBAAuB,CAAC,OAAO,CAAC;;;;YACnH,MAAM,OAAO,gCAAgC,EAAE,uBAAuB,CAAC,OAAO,CAAC;;;;WAC/E,CAAC,IAAI,EAAE;QAAE,aAAa,EAAE,kBAAkB,CAAA;KAAE,KAAK,OAAO,gCAAgC,EAAE,uBAAuB,CAAC,OAAO,CAAC;;;;gBAC1H,OAAO,mBAAmB,EAAE,YAAY;;;;WACxC,MAAM,IAAI;;;;;;;;;WAOV,mBAAmB;;;;;6BAMpB,uBAAuB,GAAG,wBAAwB"}
+{"version":3,"file":"objectInstance.d.ts","sourceRoot":"","sources":["../../use/objectInstance.js"],"names":[],"mappings":"AAwIA;;;;;GAKG;AACH,iDAHW;IAAC,CAAC,GAAG,EAAE,MAAM,GAAG,qBAAqB,CAAA;CAAC,GACpC;IAAC,CAAC,GAAG,EAAE,MAAM,GAAG,cAAc,CAAA;CAAC,CAS3C;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmDG;AACH,uDAHW,qBAAqB,GACnB,cAAc,CAgR1B;AAldD;;;;GAIG;AAEH;;;;GAIG;AAEH;;GAEG;AAEH;;GAEG;AAEH;;;;;;GAMG;AAEH;;;;;;;;GAQG;AAEH;;;;;;;;;GASG;AAEH;;;;;;;;;;;;;GAaG;AAEH;;;;;GAKG;AAEH;;;;;;;;;;;GAWG;AAEH;;;;;GAKG;AAEH;;;;GAIG;AAEH;;;GAGG;AACH;IACI;;;;;OAKG;IACH,qBAHW,MAAM,QACN,MAAM,EAMhB;IADG,aAAgB;CAEvB;AAED,+CAUE;AAEF,+CAAkH;;;;iCAtHrG;IAAC,KAAK,EAAE,MAAM,CAAC;IAAC,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;CAAC;4BAInC;IAAC,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;CAAC;yBAIpB,kBAAkB,GAAC,aAAa;;;;;;;;WAO/B,OAAO,KAAK,EAAE,gBAAgB,CAAC,sBAAsB,CAAC;;;;eACtD,OAAO,yBAAyB,EAAE,kBAAkB;;;;;;;;;SAOpD,MAAM;;;;WACN,MAAM;;;;YACN,MAAM;;;;YACN,OAAO,yBAAyB,EAAE,YAAY;;;;;;UAK9C,OAAO,KAAK,EAAE,QAAQ,CAAC,OAAO,yBAAyB,EAAE,gBAAgB,GAAC,EAAE,CAAC;;;;YAC7E,OAAO,yBAAyB,EAAE,YAAY;;;;cAC9C,OAAO,yBAAyB,EAAE,cAAc;;;;YAChD,OAAO,yBAAyB,EAAE,YAAY;;;;WAC9C,OAAO,yBAAyB,EAAE,WAAW;;;;YAC7C,OAAO,yBAAyB,EAAE,YAAY;;;;eAC9C,OAAO,yBAAyB,EAAE,qBAAqB;;;;;;;;;UAOvD,OAAO,KAAK,EAAE,QAAQ,CAAC,0BAA0B,CAAC;;;;QAClD,OAAO,KAAK,EAAE,GAAG,CAAC,MAAM,GAAC,SAAS,CAAC;;;;WACnC,OAAO,KAAK,EAAE,GAAG,CAAC,MAAM,GAAC,SAAS,CAAC;;;;YACnC,OAAO,KAAK,EAAE,GAAG,CAAC;QAAC,CAAC,GAAG,EAAC,MAAM,GAAG,GAAG,CAAA;KAAC,CAAC;;;;YACtC,OAAO,KAAK,EAAE,QAAQ,CAAC,UAAU,CAAC;;;;aAClC,QAAQ,CAAC,OAAO,KAAK,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC;;;;aACpC,QAAQ,CAAC,OAAO,KAAK,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC;;;;WACpC,QAAQ,CAAC,OAAO,KAAK,EAAE,GAAG,CAAC,KAAK,GAAC,IAAI,CAAC,CAAC;;;;aACvC,OAAO;;;;;;kCAOR,OAAO,KAAK,EAAE,QAAQ,CAAC,sBAAsB,CAAC;;;;;;;;YAO7C,CAAC,IAAI,EAAE;QAAE,MAAM,EAAE,MAAM,CAAA;KAAE,KAAK,OAAO,gCAAgC,EAAE,uBAAuB,CAAC,OAAO,CAAC;;;;cACvG,MAAM,OAAO,gCAAgC,EAAE,uBAAuB,CAAC,OAAO,CAAC;;;;YAC/E,CAAC,IAAI,EAAE;QAAE,MAAM,EAAE,kBAAkB,CAAA;KAAE,KAAK,OAAO,gCAAgC,EAAE,uBAAuB,CAAC,OAAO,CAAC;;;;YACnH,MAAM,OAAO,gCAAgC,EAAE,uBAAuB,CAAC,OAAO,CAAC;;;;WAC/E,CAAC,IAAI,EAAE;QAAE,aAAa,EAAE,kBAAkB,CAAA;KAAE,KAAK,OAAO,gCAAgC,EAAE,uBAAuB,CAAC,OAAO,CAAC;;;;gBAC1H,OAAO,mBAAmB,EAAE,YAAY;;;;WACxC,MAAM,IAAI;;;;;;;;;WAOV,mBAAmB;;;;;6BAMpB,uBAAuB,GAAG,wBAAwB"}

package/types/use/paginatedListInstance.d.ts

@@ -1,21 +1,3 @@
-/**
- * @module use/paginatedListInstance.js
- *
- */
-/**
- * @typedef {object} PagedListListanceOptions
- * @property {boolean} keepOldPages - Whether to keep old pages.
- */
-/**
- * @typedef {object} PagedListInstanceState
- * @property {number} totalRecords - The total records.
- * @property {number} totalPages - The total pages.
- * @property {number} perPage - The per page.
- */
-/**
- * @typedef {object} PagedListInstance
- * @property {import('./listInstance.js').ListInstanceState & PagedListInstanceState} state - The state.
- */
 /**
  *
  * @param {PagedListListanceOptions & import('./listInstance.js').ListInstanceOptions} options - The options.
@@ -28,7 +10,7 @@ export type PagedListListanceOptions = {
      */
     keepOldPages: boolean;
 };
-export type PagedListInstanceState = {
+export type PaginatedRawState = {
     /**
      * - The total records.
      */
@@ -41,11 +23,37 @@ export type PagedListInstanceState = {
      * - The per page.
      */
     perPage: number;
+    /**
+     * - The page to ids map.
+     */
+    pageToIds: Map<number, string[]>;
+};
+export type PaginatedState = import("vue").UnwrapNestedRefs<PaginatedRawState>;
+export type PagedListInstanceStateExtension = {
+    /**
+     * - The total records.
+     */
+    totalRecords: import("vue").Ref<number>;
+    /**
+     * - The total pages.
+     */
+    totalPages: import("vue").Ref<number>;
+    /**
+     * - The per page.
+     */
+    perPage: import("vue").Ref<number>;
+    /**
+     * - The page to ids map.
+     */
+    pageToIds: import("vue").Ref<Map<number, string[]>>;
 };
-export type PagedListInstance = {
+export type PagedListInstanceState = typeof reactive;
+export type PagedListRawInstance = {
     /**
      * - The state.
      */
-    state: import("./listInstance.js").ListInstanceState & PagedListInstanceState;
+    state: PagedListInstanceState;
 };
+export type PagedListInstance = import("./listInstance.js").ListInstance & PagedListRawInstance;
+import { reactive } from "vue";
 //# sourceMappingURL=paginatedListInstance.d.ts.map

package/types/use/paginatedListInstance.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"paginatedListInstance.d.ts","sourceRoot":"","sources":["../../use/paginatedListInstance.js"],"names":[],"mappings":"AAEA;;;GAGG;AAEH;;;GAGG;AAEH;;;;;GAKG;AAEH;;;GAGG;AAEH;;;;GAIG;AACH,+EAHW,wBAAwB,GAAG,OAAO,mBAAmB,EAAE,mBAAmB,GACxE,iBAAiB,CA+C7B;;;;;kBAjEa,OAAO;;;;;;kBAKP,MAAM;;;;gBACN,MAAM;;;;aACN,MAAM;;;;;;WAKN,OAAO,mBAAmB,EAAE,iBAAiB,GAAG,sBAAsB"}
+{"version":3,"file":"paginatedListInstance.d.ts","sourceRoot":"","sources":["../../use/paginatedListInstance.js"],"names":[],"mappings":"AA2DA;;;;GAIG;AACH,+EAHW,wBAAwB,GAAG,OAAO,mBAAmB,EAAE,mBAAmB,GACxE,iBAAiB,CA6D7B;;;;;kBAjHa,OAAO;;;;;;kBAKP,MAAM;;;;gBACN,MAAM;;;;aACN,MAAM;;;;eACN,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC;;6BAItB,OAAO,KAAK,EAAE,gBAAgB,CAAC,iBAAiB,CAAC;;;;;kBAKhD,OAAO,KAAK,EAAE,GAAG,CAAC,MAAM,CAAC;;;;gBACzB,OAAO,KAAK,EAAE,GAAG,CAAC,MAAM,CAAC;;;;aACzB,OAAO,KAAK,EAAE,GAAG,CAAC,MAAM,CAAC;;;;eACzB,OAAO,KAAK,EAAE,GAAG,CAAC,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC;;;;;;;WAYxC,sBAAsB;;gCAIvB,OAAO,mBAAmB,EAAE,YAAY,GAAG,oBAAoB;yBA7C3C,KAAK"}

package/types/utils/refIfReactive.d.ts

@@ -1,2 +1,2 @@
-export function refIfReactive<T, K extends keyof T>(source: (T & object) | undefined | null, property: K, defaultValue?: T[K]): import("vue").Ref<T[K]> | T[K] | undefined;
+export function refIfReactive<T, K extends keyof T>(source: (T & object) | undefined | null, property: K, defaultValue?: T[K]): import("vue").ComputedRef<T[K]> | import("vue").Ref<T[K]>;
 //# sourceMappingURL=refIfReactive.d.ts.map

package/types/utils/refIfReactive.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"refIfReactive.d.ts","sourceRoot":"","sources":["../../utils/refIfReactive.js"],"names":[],"mappings":"AAYO,8BAPM,CAAC,EACS,CAAC,SAAX,MAAO,CAAE,UACX,CAAA,CAAC,GAAG,MAAM,IAAG,SAAS,GAAG,IAAI,YAC7B,CAAC,iBACD,CAAC,CAAC,CAAC,CAAC,GACF,OAAO,KAAK,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,SAAS,CAOtD"}
+{"version":3,"file":"refIfReactive.d.ts","sourceRoot":"","sources":["../../utils/refIfReactive.js"],"names":[],"mappings":"AAYO,8BAPM,CAAC,EACS,CAAC,SAAX,MAAO,CAAE,UACX,CAAA,CAAC,GAAG,MAAM,IAAG,SAAS,GAAG,IAAI,YAC7B,CAAC,iBACD,CAAC,CAAC,CAAC,CAAC,GACF,OAAO,KAAK,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,OAAO,KAAK,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAOrE"}

package/use/listInstance.js

@@ -3,7 +3,7 @@ import { assignReactiveObject } from "../utils/assignReactiveObject.js";
 import { getFakePk } from "../utils/getFakePk.js";
 import { useLoadingError } from "./loadingError.js";
 import inspect from "browser-util-inspect";
-import { computed, effectScope, nextTick, reactive, readonly, ref, shallowReactive, toRef, unref, watch } from "vue";
+import { computed, effectScope, nextTick, reactive, readonly, ref, toRef, unref, watch } from "vue";
 import { CancellablePromise, wrapMaybeCancellable } from "../utils/cancellablePromise.js";
 import { refIfReactive } from "../utils/refIfReactive.js";
 
@@ -265,12 +265,12 @@ export function useListInstance({ props, handlers = {}, keepOldPages }) {
 
     // ### touching the _objectsMap or _objectsProxy directly will not trigger reactivity ###
     const state = reactive({
-        crud: shallowReactive({
-            args: reactive({}),
+        crud: {
+            args: {},
             list: defaultListCrud.list,
             bulkDelete: defaultListCrud.bulkDelete,
             executeAction: defaultListCrud.executeAction,
-        }),
+        },
         pkKey: refIfReactive(props, "pkKey"),
         params: refIfReactive(props, "params", {}),
         /** @type {{[key: string]: ListObject}} */

package/use/objectInstance.js

@@ -1,7 +1,7 @@
 import { defaultObjectCrud, getObjectCrud } from "../config/objectCrud.js";
 import { assignReactiveObject } from "../utils/assignReactiveObject.js";
 import { useLoadingError } from "./loadingError.js";
-import { reactive, readonly, ref, shallowReactive } from "vue";
+import { reactive, readonly, ref } from "vue";
 import { wrapMaybeCancellable } from "../utils/cancellablePromise.js";
 import { refIfReactive } from "../utils/refIfReactive.js";
 
@@ -212,19 +212,18 @@ export function useObjectInstance({ props, handlers = {} }) {
     const state = reactive(
         /** @type {ObjectInstanceRawState} */
         {
-            crud: shallowReactive(
+            crud:
                 /** @type {ObjectInstanceRawStateCrud} */
                 {
-                    args: reactive({}),
+                    args: {},
                     create: defaultObjectCrud.create,
                     retrieve: defaultObjectCrud.retrieve,
                     update: defaultObjectCrud.update,
                     delete: defaultObjectCrud.delete,
                     patch: defaultObjectCrud.patch,
                     subscribe: defaultObjectCrud.subscribe,
-                }
-            ),
-            object: reactive({}),
+                },
+            object: {},
             pk: refIfReactive(props, "pk", null),
             pkKey: refIfReactive(props, "pkKey"),
             params: refIfReactive(props, "params", {}),

package/use/paginatedListInstance.js

@@ -1,4 +1,5 @@
 import { useListInstance } from "./listInstance.js";
+import { reactive, toRefs } from "vue";
 
 /**
  * @module use/paginatedListInstance.js
@@ -11,65 +12,113 @@ import { useListInstance } from "./listInstance.js";
  */
 
 /**
- * @typedef {object} PagedListInstanceState
+ * @typedef {object} PaginatedRawState
  * @property {number} totalRecords - The total records.
  * @property {number} totalPages - The total pages.
  * @property {number} perPage - The per page.
+ * @property {Map<number, string[]>} pageToIds - The page to ids map.
  */
 
 /**
- * @typedef {object} PagedListInstance
- * @property {import('./listInstance.js').ListInstanceState & PagedListInstanceState} state - The state.
+ * @typedef {import('vue').UnwrapNestedRefs<PaginatedRawState>} PaginatedState
  */
 
+/**
+ * @typedef {object} PagedListInstanceStateExtension
+ * @property {import('vue').Ref<number>} totalRecords - The total records.
+ * @property {import('vue').Ref<number>} totalPages - The total pages.
+ * @property {import('vue').Ref<number>} perPage - The per page.
+ * @property {import('vue').Ref<Map<number, string[]>>} pageToIds - The page to ids map.
+ */
+
+/**
+ * @typedef {import('vue').reactive<(
+ *     import('./listInstance.js').ListInstanceRawState &
+ *     PagedListInstanceStateExtension
+ * )>} PagedListInstanceState
+ */
+
+/**
+ * @typedef {object} PagedListRawInstance
+ * @property {PagedListInstanceState} state - The state.
+ */
+
+/**
+ * @typedef {import('./listInstance.js').ListInstance & PagedListRawInstance} PagedListInstance
+ */
+
+/**
+ * @param {import('./listInstance.js').ListInstance} listInstance - The list instance.
+ * @param {PaginatedState} paginatedState - The paginated state.
+ * @returns {PagedListInstance} - The paged list instance.
+ */
+function makePagedListInstance(listInstance, paginatedState) {
+    Object.assign(listInstance.state, toRefs(paginatedState));
+    return /** @type {PagedListInstance} */ (listInstance);
+}
+
 /**
  *
  * @param {PagedListListanceOptions & import('./listInstance.js').ListInstanceOptions} options - The options.
  * @returns {PagedListInstance} - The paged list instance.
  */
 export function usePagedListInstance({ keepOldPages, ...useListInstanceArgs }) {
-    const listInstance = /** @type {PagedListInstance & import('./listInstance.js').ListInstance} */ (
-        /** @type {unknown} */ (useListInstance({ keepOldPages, ...useListInstanceArgs }))
-    );
+    /** @type {PaginatedState} */
+    const paginatedState = reactive({
+        totalRecords: 0,
+        totalPages: 0,
+        perPage: 0,
+        pageToIds: new Map(),
+    });
 
-    listInstance.state.totalRecords = 0;
-    listInstance.state.totalPages = 0;
-    listInstance.state.perPage = 0;
+    const paginatedListInstance = makePagedListInstance(
+        useListInstance({ keepOldPages, ...useListInstanceArgs }),
+        paginatedState
+    );
 
-    const superClearList = listInstance.clearList;
-    listInstance.clearList = () => {
+    const superClearList = paginatedListInstance.clearList;
+    paginatedListInstance.clearList = () => {
         superClearList();
-        listInstance.state.totalRecords = 0;
-        listInstance.state.totalPages = 0;
-        listInstance.state.perPage = 0;
+        paginatedState.totalRecords = 0;
+        paginatedState.totalPages = 0;
+        paginatedState.perPage = 0;
     };
     if (keepOldPages === undefined) {
         throw new Error("keepOldPages is required");
     }
 
-    listInstance.pageCallback = (newObjects, { totalRecords, totalPages, perPage }) => {
+    paginatedListInstance.pageCallback = (
+        /** @type {import('./listInstance.js').ListObject[]} */ newObjects,
+        /** @type {import('../config/listCrud.js').PaginateInfo} */ { page, totalRecords, totalPages, perPage }
+    ) => {
         // with keepOldPages, you are responsible for clearing the list as needed
         if (!keepOldPages) {
             // display one page at a time, clear the list
-            listInstance.clearList();
+            paginatedListInstance.clearList();
         }
         newObjects.forEach((newObject) => {
-            if (newObject[listInstance.state.pkKey] in listInstance.state.objects) {
-                listInstance.updateListObject(newObject);
+            if (newObject[paginatedListInstance.state.pkKey] in paginatedListInstance.state.objects) {
+                paginatedListInstance.updateListObject(newObject);
             } else {
-                listInstance.addListObject(newObject);
+                paginatedListInstance.addListObject(newObject);
             }
         });
+        if (keepOldPages && page !== undefined) {
+            const pageIds = newObjects.map((obj) => obj[paginatedListInstance.state.pkKey] + "");
+            // webstorm being crazy
+            // noinspection JSUnresolvedReference
+            paginatedState.pageToIds.set(page, pageIds);
+        }
         if (totalRecords !== undefined) {
-            listInstance.state.totalRecords = totalRecords;
+            paginatedState.totalRecords = totalRecords;
         }
         if (totalPages !== undefined) {
-            listInstance.state.totalPages = totalPages;
+            paginatedState.totalPages = totalPages;
         }
         if (perPage !== undefined) {
-            listInstance.state.perPage = perPage;
+            paginatedState.perPage = perPage;
         }
     };
 
-    return listInstance;
+    return paginatedListInstance;
 }

package/utils/refIfReactive.js

@@ -1,4 +1,4 @@
-import { isReactive, toRef, unref } from "vue";
+import { computed, isReactive, toRef, unref } from "vue";
 
 /**
  * Returns a ref to a property if the source is reactive, otherwise returns the unrefed value.
@@ -8,11 +8,11 @@ import { isReactive, toRef, unref } from "vue";
  * @param {T & object | undefined | null} source - The source object.
  * @param {K} property - The property to access.
  * @param {T[K]} [defaultValue] - The default value to use if source or property is missing.
- * @returns {import('vue').Ref<T[K]> | T[K] | undefined} The ref to the property if the source is reactive, otherwise the unrefed value.
+ * @returns {import('vue').ComputedRef<T[K]> | import('vue').Ref<T[K]>} The ref to the property if the source is reactive, otherwise the unrefed value.
  */
 export const refIfReactive = (source, property, defaultValue) => {
     if (source && isReactive(source)) {
         return toRef(source, property);
     }
-    return unref(source?.[property]) ?? defaultValue;
+    return computed(() => unref(source?.[property]) ?? defaultValue);
 };