@arrai-innovations/reactive-helpers 18.1.0 → 19.0.0

package/README.md

@@ -948,11 +948,17 @@ await awaitNot3.promise;
     ```bash
     $ npm ci
     ```
-3. Run tests via jest:
+3. Run tests via vitest:
     ```bash
     $ npm test
     ```
 4. Run tests with coverage output:
+
     ```bash
     $ npm run coverage
     ```
+
+5. Generate types and typedocs:
+    ```bash
+    $ npm run docs
+    ```

package/config/commonCrud.js

@@ -0,0 +1,75 @@
+import { CancellablePromise } from "../utils/cancellablePromise.js";
+import cloneDeep from "lodash-es/cloneDeep.js";
+import { addOrUpdateReactiveObject } from "../utils/assignReactiveObject.js";
+import isFunction from "lodash-es/isFunction.js";
+import { refIfReactive } from "../utils/refIfReactive.js";
+
+/**
+ * @param {string} name - The name of the method.
+ * @returns {(...args: any[]) => import('../utils/cancellablePromise.js').MaybeCancellablePromise<any>} - A function that returns a rejected promise with an error message.
+ */
+export const missingMethod = (name) => () =>
+    CancellablePromise.reject(new Error(`Crud method "${name}" is not implemented.`));
+
+// HACK: eslint, tsc, webstorm all can't agree on how to do this right
+// noinspection JSValidateTypes,JSUnusedLocalSymbols
+/**
+ * @param {string} name - The name of the method.
+ * @returns {(
+ *     (..._args: any[]) => import('../utils/cancellablePromise.js').CancellablePromise<void>
+ * )} - A function that returns a rejected promise with an error message.
+ */
+export const requiredCancelMissingMethod =
+    (name) =>
+    /* eslint-disable no-unused-vars */
+    // @ts-ignore - refuses to accept returned CancellablePromise<void> = imported CancellablePromise<void>
+    (..._args) =>
+        CancellablePromise(Promise.reject(new Error(`Crud method "${name}" is not implemented.`)), () => {});
+/* eslint-enable no-unused-vars */
+
+/**
+ * Creates a default CRUD object with the given keys.
+ *
+ * @param {string[]} keys - The CRUD function keys.
+ * @param {Set<string>} cancellableKeys - Which ones need required cancellation.
+ * @returns {object} - The default CRUD object.
+ */
+export const createDefaultCrud = (keys, cancellableKeys = new Set()) => {
+    const result = { args: {} };
+    for (const key of keys) {
+        result[key] = cancellableKeys.has(key) ? requiredCancelMissingMethod(key) : missingMethod(key);
+    }
+    return result;
+};
+
+/**
+ * Assigns the default CRUD functions to the target object.
+ *
+ * @param {object} target - The reactive object to assign to.
+ * @param {object} defaultCrud - The default CRUD definition (usually created by `createDefaultCrud`).
+ * @param {object} [options] - The options object.
+ * @param {object} [options.props] - The props object.
+ * @param {object} [options.functions] - The functions to assign.
+ * @param {Set<string>} [options.validKeys] - The valid keys for the functions.
+ */
+export function assignCrud(
+    target,
+    defaultCrud,
+    { props, functions, validKeys = new Set(Object.keys(defaultCrud).filter((k) => k !== "args")) } = {}
+) {
+    Object.assign(target, cloneDeep(defaultCrud));
+    if (props?.crudArgs) {
+        addOrUpdateReactiveObject(target.args, props.crudArgs);
+    }
+    if (functions) {
+        for (const [key, fn] of Object.entries(functions)) {
+            if (!validKeys.has(key)) {
+                throw new Error(`Invalid function key "${key}" passed to assignCrud`);
+            }
+            if (!isFunction(fn)) {
+                throw new Error(`Function "${key}" is not actually a function`);
+            }
+            target[key] = refIfReactive(functions, key, fn);
+        }
+    }
+}

package/config/listCrud.js

@@ -1,7 +1,6 @@
-import { addOrUpdateReactiveObject } from "../utils/assignReactiveObject.js";
+import { assignCrud, createDefaultCrud } from "./commonCrud.js";
 import cloneDeep from "lodash-es/cloneDeep.js";
-import isFunction from "lodash-es/isFunction.js";
-import { isReactive, toRef } from "vue";
+import { readonly } from "vue";
 
 /**
  * Configuration for the default list crud functions.
@@ -9,14 +8,6 @@ import { isReactive, toRef } from "vue";
  * @module config/listCrud.js
  */
 
-const defaultCrud = {
-    args: {},
-    list: undefined,
-    bulkDelete: undefined,
-    subscribe: undefined,
-    executeAction: undefined,
-};
-
 /**
  * @typedef {object} PaginateInfo
  * @property {number} totalRecords - The total records.
@@ -32,7 +23,7 @@ const defaultCrud = {
  */
 
 /**
- * @typedef {object} ListFnArgs
+ * @typedef {object} ListArgs
  * @property {object} crudArgs - The arguments to be passed to the crud functions.
  * @property {string} pkKey - The key name of the primary key.
  * @property {object} retrieveArgs - The arguments to be passed to the retrieve function.
@@ -43,10 +34,12 @@ const defaultCrud = {
  */
 
 /**
- * @typedef {object} DeleteFnArgs
+ * @typedef {object} BulkDeleteArgs
  * @property {object} crudArgs - The arguments to be passed to the crud functions.
  * @property {string[]} pks - The ids of the objects to be deleted.
  * @property {string} pkKey - The key name of the primary key.
+ * @property {Readonly<import('vue').Ref<boolean>>} isCancelled - A ref to a boolean indicating whether the request has
+ *  been cancelled.
  */
 
 /**
@@ -57,51 +50,77 @@ const defaultCrud = {
  */
 
 /**
- * @typedef {object} SubscribeFnArgs
+ * @typedef {object} ListSubscribeArgs
  * @property {object} crudArgs - The arguments to be passed to the crud functions.
  * @property {string} pkKey - The key name of the primary key.
  * @property {object} retrieveArgs - The arguments to be passed to the retrieve function.
  * @property {object} listArgs - The arguments to be passed for list crud functions.
  * @property {SubscriptionEventCallback} subscriptionEventCallback - The method to call when new data is received.
+ * @property {Readonly<import('vue').Ref<boolean>>} isCancelled - A ref to a boolean indicating whether the request has
+ *  been cancelled.
  */
 
 /**
- * @typedef {object} ExecuteActionFnArgs
+ * @typedef {object} ExecuteActionArgs
  * @property {object} crudArgs - The arguments to be passed to the crud functions.
  * @property {string[]} pks - The ids of the objects to be acted upon.
  * @property {string} pkKey - The key name of the primary key.
  * @property {string} action - The action to execute.
+ * @property {Readonly<import('vue').Ref<boolean>>} isCancelled - A ref to a boolean indicating whether the request has
+ *  been cancelled.
  */
 
 /**
- * @typedef {(ListFnArgs)=>Promise<boolean> & { cancel: () => Promise<void>|void }} ListFn - The list function to get a list of items, returning a boolean indicating success.
+ * @callback CrudListFn
+ * @param {ListArgs} args - The arguments to be passed to the crud functions.
+ * @returns {import('../utils/cancellablePromise.js').MaybeCancellablePromise<void>} - A promise that resolves to a boolean indicating success.
  */
 
 /**
- * @typedef {(DeleteFnArgs)=>Promise<boolean> & { cancel: () => Promise<void>|void }} BulkDeleteFn - The delete function to bulk delete a list of items.
+ * @callback CrudBulkDeleteFn
+ * @param {BulkDeleteArgs} args - The arguments to be passed to the crud functions.
+ * @returns {import('../utils/cancellablePromise.js').MaybeCancellablePromise<void>} - A promise that resolves to a boolean indicating success.
  */
 
 /**
- * @typedef {(SubscribeFnArgs)=>Promise<boolean> & { cancel: () => Promise<void>|void }} SubscribeFn - The subscribe function to set up a subscription to a list of items.
+ * @callback CrudListSubscribeFn
+ * @param {ListSubscribeArgs} args - The arguments to be passed to the crud functions.
+ * @returns {import('../utils/cancellablePromise.js').CancellablePromise<void>} - A promise that resolves to a boolean indicating success.
  */
 
 /**
- * @typedef {(ExecuteActionFnArgs)=>Promise<import('./objectCrud.js').CrudResponse|false> & { cancel: () => Promise<void>|void }} ExecuteActionFn - The function to execute a certain action on a list of items, returning the response data or false.
+ * @callback CrudExecuteActionFn
+ * @param {ExecuteActionArgs} args - The arguments to be passed to the crud functions.
+ * @returns {import('../utils/cancellablePromise.js').MaybeCancellablePromise<object|string|null>} - A promise that resolves the result of the action, returned to the executor.
  */
 
 /**
  * @typedef {object} ListCrudFunctions
- * @property {ListFn} [list] - The list function to get a list of items.
- * @property {BulkDeleteFn} [bulkDelete] - The delete function to bulk delete a list of items.
- * @property {ExecuteActionFn} [executeAction] - The  function to execute a certain action on a list of items.
- * @property {SubscribeFn} [subscribe] - The subscribe function to get a subscription to a list of items.
+ * @property {CrudListFn} [list] - The list function to get a list of items.
+ * @property {CrudBulkDeleteFn} [bulkDelete] - The delete function to bulk delete a list of items.
+ * @property {CrudExecuteActionFn} [executeAction] - The  function to execute a certain action on a list of items.
+ * @property {CrudListSubscribeFn} [subscribe] - The subscribe function to get a subscription to a list of items.
  */
 
 /**
  * @typedef {object} ListCrudArgs
- * @property {object} [args={}] - The default arguments for the crud functions.
+ * @property {object} args - The default arguments for the crud functions.
  */
 
+/**
+ * @typedef {object} ListCrudArgsOption
+ * @property {object} [crudArgs={}] - The default arguments for the crud functions.
+ */
+
+const _defaultCrud = createDefaultCrud(["list", "bulkDelete", "executeAction", "subscribe"], new Set(["subscribe"]));
+
+/**
+ * The default list crud functions.
+ *
+ * @type {Readonly<ListCrudFunctions>}
+ */
+export const defaultListCrud = readonly(_defaultCrud);
+
 /**
  * Set the list and subscribe functions for the default crud.
  *
@@ -109,43 +128,25 @@ const defaultCrud = {
  * @throws {Error} - If unknown keys are passed.
  * @returns {void}
  */
-export const setListCrud = ({ list, bulkDelete, subscribe, executeAction, args = {}, ...rest }) => {
-    defaultCrud.list = list;
-    defaultCrud.subscribe = subscribe;
-    defaultCrud.bulkDelete = bulkDelete;
-    defaultCrud.executeAction = executeAction;
-    Object.assign(defaultCrud.args, cloneDeep(args));
-    if (Object.keys(rest).length) {
-        throw new Error(`Unknown key(s) passed to setListCrud: ${Object.keys(rest).join(", ")}`);
+export const setListCrud = ({ args = {}, ...rest }) => {
+    Object.assign(_defaultCrud.args, cloneDeep(args));
+    for (const [key, value] of Object.entries(rest)) {
+        if (!(key in _defaultCrud)) {
+            throw new Error(`Unknown key "${key}" passed to setListCrud`);
+        }
+        _defaultCrud[key] = value ?? _defaultCrud[key];
     }
 };
 
 /**
  * Get the previously set list and subscribe functions for the default crud.
  *
- * @param {import("vue").UnwrapNestedRefs<ListCrudFunctions & ListCrudArgs>} reactiveCrud - The reactive crud object, which will be mutated.
+ * @param {import("vue").UnwrapNestedRefs<ListCrudFunctions & ListCrudArgs>} target - The reactive crud object, which will be mutated.
  * @param {object} options - The options for the default crud.
- * @param {import("vue").UnwrapNestedRefs<{
- *     crudArgs: object|undefined,
- * }>} [options.props] - The props to set for the crud.
- * @param {ListCrudFunctions & ListCrudArgs} [options.functions] - The functions to set for the crud.
- */
-export const getListCrud = (reactiveCrud, { props, functions } = {}) => {
-    // don't mutate the default crud
-    Object.assign(reactiveCrud, cloneDeep(defaultCrud));
-    if (props?.crudArgs) {
-        addOrUpdateReactiveObject(reactiveCrud.args, props.crudArgs);
-    }
-    if (functions) {
-        for (const [key, value] of Object.entries(functions)) {
-            if (isFunction(value) && key in reactiveCrud) {
-                reactiveCrud[key] = isReactive(functions)
-                    ? // @ts-ignore - this is a valid key...
-                      toRef(functions, key)
-                    : value;
-            } else {
-                throw Error(`Invalid function "${key}" for getListCrud: invalid key or not a function.`);
-            }
-        }
-    }
+ * @param {import("vue").UnwrapNestedRefs<ListCrudArgsOption>} [options.props] - The props to set for the crud.
+ * @param {ListCrudFunctions} [options.functions] - The functions to set for the crud.
+ * @throws {Error} - If an invalid function is passed, or if the function is not a function.
+ */
+export const getListCrud = (target, options) => {
+    assignCrud(target, _defaultCrud, options);
 };

package/config/objectCrud.js

@@ -1,8 +1,6 @@
-import { addOrUpdateReactiveObject } from "../utils/assignReactiveObject.js";
+import { assignCrud, createDefaultCrud } from "./commonCrud.js";
 import cloneDeep from "lodash-es/cloneDeep.js";
-import isFunction from "lodash-es/isFunction.js";
-import { isReactive, readonly, toRef } from "vue";
-import { CancellablePromise } from "../utils/cancellablePromise.js";
+import { readonly } from "vue";
 
 /**
  * Configuration for the default object crud functions.
@@ -10,33 +8,6 @@ import { CancellablePromise } from "../utils/cancellablePromise.js";
  * @module config/objectCrud.js
  */
 
-/**
- * @template T
- * @param {string} name - The name of the method.
- * @returns {(...args:any[]) => import('../utils/cancellablePromise.js')
- *                               .MaybeCancellablePromise<T>} - A function that returns a rejected promise with an error message.
- */
-const missingMethod = (name) => () => {
-    return CancellablePromise.reject(new Error(`Crud method "${name}" is not implemented.`));
-};
-
-/**
- * @template T
- * @param {string} name - The name of the method.
- * @returns {(...args:any[]) => import('../utils/cancellablePromise.js')
- *                               .CancellablePromise<T>} - A function that returns a rejected promise with an error message.
- */
-const requiredCancelMissingMethod = (name) => () => {
-    return CancellablePromise(
-        new Promise(() => {
-            return Promise.reject(new Error(`Crud method "${name}" is not implemented.`));
-        }),
-        () => {
-            // do nothing
-        }
-    );
-};
-
 /**
  * @typedef {{[key:string]: any}} ObjectCrudArgsArgs
  */
@@ -54,7 +25,7 @@ const requiredCancelMissingMethod = (name) => () => {
  */
 
 /**
- * @typedef {object} CreateDetailArgs
+ * @typedef {object} CreateArgs
  * @property {{[key:string]: any}} crudArgs - The arguments to be passed to the crud functions.
  * @property {{[key:string]: any}} object - The data to be acted upon.
  * @property {{[key:string]: any}} retrieveArgs - The arguments to be passed to the retrieve function.
@@ -63,7 +34,7 @@ const requiredCancelMissingMethod = (name) => () => {
  */
 
 /**
- * @typedef {object} RetrieveDetailArgs
+ * @typedef {object} RetrieveArgs
  * @property {{[key:string]: any}} crudArgs - The arguments to be passed to the crud functions.
  * @property {string} pk - The pk of the object to be acted upon.
  * @property {string} pkKey - The key name of the primary key.
@@ -72,7 +43,7 @@ const requiredCancelMissingMethod = (name) => () => {
  */
 
 /**
- * @typedef {object} UpdateDetailArgs
+ * @typedef {object} UpdateArgs
  * @property {{[key:string]: any}} crudArgs - The arguments to be passed to the crud functions.
  * @property {import('../use/objectInstance.js').ExistingCrudObject} object - The data to be acted upon.
  * @property {{[key:string]: any}} retrieveArgs - The arguments to be passed to the retrieve function.
@@ -81,7 +52,7 @@ const requiredCancelMissingMethod = (name) => () => {
  */
 
 /**
- * @typedef {object} DeleteDetailArgs
+ * @typedef {object} DeleteArgs
  * @property {{[key:string]: any}} crudArgs - The arguments to be passed to the crud functions.
  * @property {string} pk - The pk of the object to be acted upon.
  * @property {string} pkKey - The key name of the primary key.
@@ -89,7 +60,7 @@ const requiredCancelMissingMethod = (name) => () => {
  */
 
 /**
- * @typedef {object} PartialDetailArgs
+ * @typedef {object} PartialArgs
  * @property {{[key:string]: any}} crudArgs - The arguments to be passed to the crud functions.
  * @property {string} pk - The pk of the object to be acted upon.
  * @property {string} pkKey - The key name of the primary key.
@@ -105,7 +76,7 @@ const requiredCancelMissingMethod = (name) => () => {
  */
 
 /**
- * @typedef {object} SubscribeArgs
+ * @typedef {object} ObjectSubscribeArgs
  * @property {{[key:string]: any}} crudArgs - The arguments to be passed to the crud functions.
  * @property {string} pk - The pk of the object to be acted upon.
  * @property {string} pkKey - The key name of the primary key.
@@ -120,37 +91,37 @@ const requiredCancelMissingMethod = (name) => () => {
 
 /**
  * @callback CrudCreateFn
- * @param {CreateDetailArgs} args - The arguments to be passed to the create function.
+ * @param {CreateArgs} args - The arguments to be passed to the create function.
  * @returns {CrudResponse} - The response data from the create function.
  */
 
 /**
  * @callback CrudRetrieveFn
- * @param {RetrieveDetailArgs} args - The arguments to be passed to the retrieve function.
+ * @param {RetrieveArgs} args - The arguments to be passed to the retrieve function.
  * @returns {CrudResponse} - The response data from the retrieve function.
  */
 
 /**
  * @callback CrudUpdateFn
- * @param {UpdateDetailArgs} args - The arguments to be passed to the update function.
+ * @param {UpdateArgs} args - The arguments to be passed to the update function.
  * @returns {CrudResponse} - The response data from the update function.
  */
 
 /**
  * @callback CrudPatchFn
- * @param {PartialDetailArgs} args - The arguments to be passed to the patch function.
+ * @param {PartialArgs} args - The arguments to be passed to the patch function.
  * @returns {CrudResponse} - The response data from the patch function.
  */
 
 /**
  * @callback CrudDeleteFn
- * @param {DeleteDetailArgs} args - The arguments to be passed to the delete function.
+ * @param {DeleteArgs} args - The arguments to be passed to the delete function.
  * @returns {CrudResponse} - The response data from the delete function.
  */
 
 /**
- * @callback CrudSubscribeFn
- * @param {SubscribeArgs} args - The arguments to be passed to the subscribe function.
+ * @callback CrudObjectSubscribeFn
+ * @param {ObjectSubscribeArgs} args - The arguments to be passed to the subscribe function.
  * @returns {import('../utils/cancellablePromise.js').CancellablePromise<void>} - The cancellable promise.
  */
 
@@ -163,7 +134,7 @@ const requiredCancelMissingMethod = (name) => () => {
  * @property {CrudUpdateFn} [update] - A function to be used instead of the default crud update function.
  * @property {CrudDeleteFn} [delete] - A function to be used instead of the default crud delete function.
  * @property {CrudPatchFn} [patch] - A function to be used instead of the default crud patch function.
- * @property {CrudSubscribeFn} [subscribe] - A function to be used instead of the default crud subscribe function.
+ * @property {CrudObjectSubscribeFn} [subscribe] - A function to be used instead of the default crud subscribe function.
  */
 
 /**
@@ -173,17 +144,17 @@ const requiredCancelMissingMethod = (name) => () => {
  *
  */
 
-const _defaultCrud = {
-    args: {},
-    retrieve: /** @type {CrudRetrieveFn} */ missingMethod("retrieve"),
-    create: /** @type {CrudCreateFn} */ missingMethod("create"),
-    update: /** @type {CrudUpdateFn} */ missingMethod("update"),
-    patch: /** @type {CrudPatchFn} */ missingMethod("patch"),
-    delete: /** @type {CrudDeleteFn} */ missingMethod("delete"),
-    subscribe: /** @type {CrudSubscribeFn} */ requiredCancelMissingMethod("subscribe"),
-};
+const _defaultCrud = createDefaultCrud(
+    ["retrieve", "create", "update", "patch", "delete", "subscribe"],
+    new Set(["subscribe"])
+);
 
-export const defaultCrud = readonly(_defaultCrud);
+/**
+ * The default object crud functions.
+ *
+ * @type {Readonly<ObjectCrudFunctions>}
+ */
+export const defaultObjectCrud = readonly(_defaultCrud);
 
 /**
  * Set the object crud functions.
@@ -191,45 +162,25 @@ export const defaultCrud = readonly(_defaultCrud);
  * @param {ObjectCrudArgs} options - The options for the object crud functions.
  * @throws {Error} - if unknown keys are passed.
  */
-export const setObjectCrud = ({ retrieve, create, update, patch, delete: deleteFn, subscribe, args = {}, ...rest }) => {
-    _defaultCrud.retrieve = retrieve ?? missingMethod("retrieve");
-    _defaultCrud.create = create ?? missingMethod("create");
-    _defaultCrud.update = update ?? missingMethod("update");
-    _defaultCrud.patch = patch ?? missingMethod("patch");
-    _defaultCrud.delete = deleteFn ?? missingMethod("delete");
-    _defaultCrud.subscribe = subscribe ?? requiredCancelMissingMethod("subscribe");
-    // defensive cloning
+export const setObjectCrud = ({ args = {}, ...rest }) => {
     Object.assign(_defaultCrud.args, cloneDeep(args));
-    if (Object.keys(rest).length) {
-        throw new Error(`Unknown key(s) passed to setObjectCrud: ${Object.keys(rest).join(", ")}`);
+    for (const [key, value] of Object.entries(rest)) {
+        if (!(key in _defaultCrud)) {
+            throw new Error(`Unknown key "${key}" passed to setObjectCrud`);
+        }
+        _defaultCrud[key] = value ?? _defaultCrud[key];
     }
 };
 
 /**
  * Get the previously set object crud functions.
  *
- * @param {import("vue").UnwrapNestedRefs<ObjectCrudArgsProperties>} reactiveCrud - The reactive object you want to add the resulting crud to.
+ * @param {import("vue").UnwrapNestedRefs<ObjectCrudArgsProperties>} target - The reactive object you want to add the resulting crud to.
  * @param {object} options - The options for the reactive crud object.
  * @param {import("vue").UnwrapNestedRefs<ObjectCrudArgsOption>} [options.props] - The props with any passed crudArgs.
  * @param {ObjectCrudFunctions} [options.functions] - Any functions to override the default crud functions.
  * @throws {Error} - If an invalid function is passed, or if the function is not a function.
  */
-export const getObjectCrud = (reactiveCrud, { props, functions } = {}) => {
-    // don't mutate the default crud
-    Object.assign(reactiveCrud, cloneDeep(_defaultCrud));
-    if (props?.crudArgs) {
-        addOrUpdateReactiveObject(reactiveCrud.args, props.crudArgs);
-    }
-    if (functions) {
-        for (const [key, value] of Object.entries(functions)) {
-            if (isFunction(value) && key in reactiveCrud) {
-                reactiveCrud[key] = isReactive(functions)
-                    ? // @ts-ignore - key is a keyof ObjectCrudFunctions...
-                      toRef(functions, key)
-                    : value;
-            } else {
-                throw Error(`Invalid function "${key}" for getObjectCrud: invalid key or not a function.`);
-            }
-        }
-    }
+export const getObjectCrud = (target, options) => {
+    assignCrud(target, _defaultCrud, options);
 };

package/index.js

@@ -5,9 +5,9 @@ export * from "./use/cancellableIntent.js";
 export * from "./use/combineClasses.js";
 export * from "./use/list.js";
 export * from "./use/listCalculated.js";
-export * from "./use/listKeys.js";
 export * from "./use/listFilter.js";
 export * from "./use/listInstance.js";
+export * from "./use/listKeys.js";
 export * from "./use/listRelated.js";
 export * from "./use/listSearch.js";
 export * from "./use/listSort.js";
@@ -34,7 +34,9 @@ export * from "./utils/getFakePk.js";
 export * from "./utils/keepAliveTry.js";
 export * from "./utils/keyDiff.js";
 export * from "./utils/loadingCombine.js";
+export * from "./utils/refIfReactive.js";
 export * from "./utils/relatedCalculatedHelpers.js";
 export * from "./utils/set.js";
 export * from "./utils/transformWalk.js";
+export * from "./utils/unwrapNested.js";
 export * from "./utils/watches.js";

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@arrai-innovations/reactive-helpers",
-    "version": "18.1.0",
+    "version": "19.0.0",
     "description": "VueJS 3 utility composition functions to help manipulate objects and lists.",
     "main": "index.js",
     "type": "module",
@@ -30,7 +30,8 @@
         "prettier": "npx --no-install prettier --write .",
         "coverage": "npm test -- run --coverage=true",
         "prepare": "npx --no-install husky",
-        "docs": "node make_type_doc.js"
+        "docs": "node make_type_doc.js",
+        "docs:check": "node check_type_doc.js"
     },
     "repository": {
         "type": "git",

package/types/config/commonCrud.d.ts

@@ -0,0 +1,19 @@
+/**
+ * Assigns the default CRUD functions to the target object.
+ *
+ * @param {object} target - The reactive object to assign to.
+ * @param {object} defaultCrud - The default CRUD definition (usually created by `createDefaultCrud`).
+ * @param {object} [options] - The options object.
+ * @param {object} [options.props] - The props object.
+ * @param {object} [options.functions] - The functions to assign.
+ * @param {Set<string>} [options.validKeys] - The valid keys for the functions.
+ */
+export function assignCrud(target: object, defaultCrud: object, { props, functions, validKeys }?: {
+    props?: object;
+    functions?: object;
+    validKeys?: Set<string>;
+}): void;
+export function missingMethod(name: string): (...args: any[]) => import("../utils/cancellablePromise.js").MaybeCancellablePromise<any>;
+export function requiredCancelMissingMethod(name: string): ((..._args: any[]) => import("../utils/cancellablePromise.js").CancellablePromise<void>);
+export function createDefaultCrud(keys: string[], cancellableKeys?: Set<string>): object;
+//# sourceMappingURL=commonCrud.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"commonCrud.d.ts","sourceRoot":"","sources":["../../config/commonCrud.js"],"names":[],"mappings":"AA4CA;;;;;;;;;GASG;AACH,mCAPW,MAAM,eACN,MAAM,oCAEd;IAAyB,KAAK,GAAtB,MAAM;IACW,SAAS,GAA1B,MAAM;IACgB,SAAS,GAA/B,GAAG,CAAC,MAAM,CAAC;CACrB,QAqBA;AAhEM,oCAHI,MAAM,GACJ,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,OAAO,gCAAgC,EAAE,uBAAuB,CAAC,GAAG,CAAC,CAGjB;AAU9E,kDALI,MAAM,GACJ,CACZ,CAAO,GAAG,KAAK,EAAE,GAAG,EAAE,KAAK,OAAO,gCAAgC,EAAE,kBAAkB,CAAC,IAAI,CAAC,CACzF,CAOwG;AAUrG,wCAJI,MAAM,EAAE,oBACR,GAAG,CAAC,MAAM,CAAC,GACT,MAAM,CAQlB"}

package/types/config/listCrud.d.ts

@@ -1,9 +1,13 @@
-export function setListCrud({ list, bulkDelete, subscribe, executeAction, args, ...rest }: ListCrudFunctions & Partial<ListCrudArgs>): void;
-export function getListCrud(reactiveCrud: import("vue").UnwrapNestedRefs<ListCrudFunctions & ListCrudArgs>, { props, functions }?: {
-    props?: import("vue").UnwrapNestedRefs<{
-        crudArgs: object | undefined;
-    }>;
-    functions?: ListCrudFunctions & ListCrudArgs;
+/**
+ * The default list crud functions.
+ *
+ * @type {Readonly<ListCrudFunctions>}
+ */
+export const defaultListCrud: Readonly<ListCrudFunctions>;
+export function setListCrud({ args, ...rest }: ListCrudFunctions & Partial<ListCrudArgs>): void;
+export function getListCrud(target: import("vue").UnwrapNestedRefs<ListCrudFunctions & ListCrudArgs>, options: {
+    props?: import("vue").UnwrapNestedRefs<ListCrudArgsOption>;
+    functions?: ListCrudFunctions;
 }): void;
 export type PaginateInfo = {
     /**
@@ -20,7 +24,7 @@ export type PaginateInfo = {
     perPage: number;
 };
 export type PageCallback = (newObjects: import("../use/listInstance.js").ListObject, paginationInfo: PaginateInfo | undefined) => void;
-export type ListFnArgs = {
+export type ListArgs = {
     /**
      * - The arguments to be passed to the crud functions.
      */
@@ -47,7 +51,7 @@ export type ListFnArgs = {
      */
     isCancelled: Readonly<import("vue").Ref<boolean>>;
 };
-export type DeleteFnArgs = {
+export type BulkDeleteArgs = {
     /**
      * - The arguments to be passed to the crud functions.
      */
@@ -60,9 +64,14 @@ export type DeleteFnArgs = {
      * - The key name of the primary key.
      */
     pkKey: string;
+    /**
+     * - A ref to a boolean indicating whether the request has
+     * been cancelled.
+     */
+    isCancelled: Readonly<import("vue").Ref<boolean>>;
 };
 export type SubscriptionEventCallback = (newOrUpdatedOrDeleteObject: import("../use/listInstance.js").ListObject | string, action: "create" | "update" | "delete") => void;
-export type SubscribeFnArgs = {
+export type ListSubscribeArgs = {
     /**
      * - The arguments to be passed to the crud functions.
      */
@@ -83,8 +92,13 @@ export type SubscribeFnArgs = {
      * - The method to call when new data is received.
      */
     subscriptionEventCallback: SubscriptionEventCallback;
+    /**
+     * - A ref to a boolean indicating whether the request has
+     * been cancelled.
+     */
+    isCancelled: Readonly<import("vue").Ref<boolean>>;
 };
-export type ExecuteActionFnArgs = {
+export type ExecuteActionArgs = {
     /**
      * - The arguments to be passed to the crud functions.
      */
@@ -101,53 +115,44 @@ export type ExecuteActionFnArgs = {
      * - The action to execute.
      */
     action: string;
+    /**
+     * - A ref to a boolean indicating whether the request has
+     * been cancelled.
+     */
+    isCancelled: Readonly<import("vue").Ref<boolean>>;
 };
-/**
- * - The list function to get a list of items, returning a boolean indicating success.
- */
-export type ListFn = (ListFnArgs: any) => Promise<boolean> & {
-    cancel: () => Promise<void> | void;
-};
-/**
- * - The delete function to bulk delete a list of items.
- */
-export type BulkDeleteFn = (DeleteFnArgs: any) => Promise<boolean> & {
-    cancel: () => Promise<void> | void;
-};
-/**
- * - The subscribe function to set up a subscription to a list of items.
- */
-export type SubscribeFn = (SubscribeFnArgs: any) => Promise<boolean> & {
-    cancel: () => Promise<void> | void;
-};
-/**
- * - The function to execute a certain action on a list of items, returning the response data or false.
- */
-export type ExecuteActionFn = (ExecuteActionFnArgs: any) => Promise<import("./objectCrud.js").CrudResponse | false> & {
-    cancel: () => Promise<void> | void;
-};
+export type CrudListFn = (args: ListArgs) => import("../utils/cancellablePromise.js").MaybeCancellablePromise<void>;
+export type CrudBulkDeleteFn = (args: BulkDeleteArgs) => import("../utils/cancellablePromise.js").MaybeCancellablePromise<void>;
+export type CrudListSubscribeFn = (args: ListSubscribeArgs) => import("../utils/cancellablePromise.js").CancellablePromise<void>;
+export type CrudExecuteActionFn = (args: ExecuteActionArgs) => import("../utils/cancellablePromise.js").MaybeCancellablePromise<object | string | null>;
 export type ListCrudFunctions = {
     /**
      * - The list function to get a list of items.
      */
-    list?: ListFn;
+    list?: CrudListFn;
     /**
      * - The delete function to bulk delete a list of items.
      */
-    bulkDelete?: BulkDeleteFn;
+    bulkDelete?: CrudBulkDeleteFn;
     /**
      * - The  function to execute a certain action on a list of items.
      */
-    executeAction?: ExecuteActionFn;
+    executeAction?: CrudExecuteActionFn;
     /**
      * - The subscribe function to get a subscription to a list of items.
      */
-    subscribe?: SubscribeFn;
+    subscribe?: CrudListSubscribeFn;
 };
 export type ListCrudArgs = {
     /**
      * - The default arguments for the crud functions.
      */
-    args?: object;
+    args: object;
+};
+export type ListCrudArgsOption = {
+    /**
+     * - The default arguments for the crud functions.
+     */
+    crudArgs?: object;
 };
 //# sourceMappingURL=listCrud.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"listCrud.d.ts","sourceRoot":"","sources":["../../config/listCrud.js"],"names":[],"mappings":"AA+GO,2FAJI,iBAAiB,GAAG,OAAO,CAAC,YAAY,CAAC,GAEvC,IAAI,CAWhB;AAYM,0CAPI,OAAO,KAAK,EAAE,gBAAgB,CAAC,iBAAiB,GAAG,YAAY,CAAC,yBAExE;IAEa,KAAK,GAFV,OAAO,KAAK,EAAE,gBAAgB,CAAC;QACnC,QAAQ,EAAE,MAAM,GAAC,SAAS,CAAC;KAC9B,CAAC;IACiD,SAAS,GAApD,iBAAiB,GAAG,YAAY;CAC1C,QAmBA;;;;;kBAjIa,MAAM;;;;gBACN,MAAM;;;;aACN,MAAM;;2BAIP,CACN,UAAU,EAAC,OAAO,wBAAwB,EAAE,UAAU,EACtD,cAAc,EAAE,YAAY,GAAC,SAAS,KACvC,IAAI;;;;;cAKI,MAAM;;;;WACN,MAAM;;;;kBACN,MAAM;;;;cACN,MAAM;;;;kBACN,YAAY;;;;;iBACZ,QAAQ,CAAC,OAAO,KAAK,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC;;;;;;cAMpC,MAAM;;;;SACN,MAAM,EAAE;;;;WACR,MAAM;;wCAIP,CACN,0BAA0B,EAAC,OAAO,wBAAwB,EAAE,UAAU,GAAC,MAAM,EAC7E,MAAM,EAAE,QAAQ,GAAC,QAAQ,GAAC,QAAQ,KACnC,IAAI;;;;;cAKI,MAAM;;;;WACN,MAAM;;;;kBACN,MAAM;;;;cACN,MAAM;;;;+BACN,yBAAyB;;;;;;cAKzB,MAAM;;;;SACN,MAAM,EAAE;;;;WACR,MAAM;;;;YACN,MAAM;;;;;qBAIP,CAAC,UAAU,KAAA,KAAG,OAAO,CAAC,OAAO,CAAC,GAAG;IAAE,MAAM,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,GAAC,IAAI,CAAA;CAAE;;;;2BAIrE,CAAC,YAAY,KAAA,KAAG,OAAO,CAAC,OAAO,CAAC,GAAG;IAAE,MAAM,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,GAAC,IAAI,CAAA;CAAE;;;;0BAIvE,CAAC,eAAe,KAAA,KAAG,OAAO,CAAC,OAAO,CAAC,GAAG;IAAE,MAAM,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,GAAC,IAAI,CAAA;CAAE;;;;8BAI1E,CAAC,mBAAmB,KAAA,KAAG,OAAO,CAAC,OAAO,iBAAiB,EAAE,YAAY,GAAC,KAAK,CAAC,GAAG;IAAE,MAAM,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,GAAC,IAAI,CAAA;CAAE;;;;;WAKlH,MAAM;;;;iBACN,YAAY;;;;oBACZ,eAAe;;;;gBACf,WAAW;;;;;;WAKX,MAAM"}
+{"version":3,"file":"listCrud.d.ts","sourceRoot":"","sources":["../../config/listCrud.js"],"names":[],"mappings":"AAoHA;;;;GAIG;AACH,8BAFU,QAAQ,CAAC,iBAAiB,CAAC,CAEiB;AAS/C,+CAJI,iBAAiB,GAAG,OAAO,CAAC,YAAY,CAAC,GAEvC,IAAI,CAUhB;AAWM,oCANI,OAAO,KAAK,EAAE,gBAAgB,CAAC,iBAAiB,GAAG,YAAY,CAAC,WAExE;IAAqE,KAAK,GAAlE,OAAO,KAAK,EAAE,gBAAgB,CAAC,kBAAkB,CAAC;IACtB,SAAS,GAArC,iBAAiB;CACzB,QAIF;;;;;kBA3Ia,MAAM;;;;gBACN,MAAM;;;;aACN,MAAM;;2BAIP,CACN,UAAU,EAAC,OAAO,wBAAwB,EAAE,UAAU,EACtD,cAAc,EAAE,YAAY,GAAC,SAAS,KACvC,IAAI;;;;;cAKI,MAAM;;;;WACN,MAAM;;;;kBACN,MAAM;;;;cACN,MAAM;;;;kBACN,YAAY;;;;;iBACZ,QAAQ,CAAC,OAAO,KAAK,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC;;;;;;cAMpC,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;;;;;cAKI,MAAM;;;;WACN,MAAM;;;;kBACN,MAAM;;;;cACN,MAAM;;;;+BACN,yBAAyB;;;;;iBACzB,QAAQ,CAAC,OAAO,KAAK,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC;;;;;;cAMpC,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;;;;;;eAKN,MAAM"}

package/types/config/objectCrud.d.ts

@@ -1,14 +1,11 @@
-export const defaultCrud: {
-    readonly args: {};
-    readonly retrieve: (...args: any[]) => import("../utils/cancellablePromise.js").MaybeCancellablePromise<any>;
-    readonly create: (...args: any[]) => import("../utils/cancellablePromise.js").MaybeCancellablePromise<any>;
-    readonly update: (...args: any[]) => import("../utils/cancellablePromise.js").MaybeCancellablePromise<any>;
-    readonly patch: (...args: any[]) => import("../utils/cancellablePromise.js").MaybeCancellablePromise<any>;
-    readonly delete: (...args: any[]) => import("../utils/cancellablePromise.js").MaybeCancellablePromise<any>;
-    readonly subscribe: (...args: any[]) => CancellablePromise<any>;
-};
-export function setObjectCrud({ retrieve, create, update, patch, delete: deleteFn, subscribe, args, ...rest }: ObjectCrudArgs): void;
-export function getObjectCrud(reactiveCrud: import("vue").UnwrapNestedRefs<ObjectCrudArgsProperties>, { props, functions }?: {
+/**
+ * The default object crud functions.
+ *
+ * @type {Readonly<ObjectCrudFunctions>}
+ */
+export const defaultObjectCrud: Readonly<ObjectCrudFunctions>;
+export function setObjectCrud({ args, ...rest }: ObjectCrudArgs): void;
+export function getObjectCrud(target: import("vue").UnwrapNestedRefs<ObjectCrudArgsProperties>, options: {
     props?: import("vue").UnwrapNestedRefs<ObjectCrudArgsOption>;
     functions?: ObjectCrudFunctions;
 }): void;
@@ -30,7 +27,7 @@ export type ObjectCrudArgsOption = {
      */
     crudArgs?: ObjectCrudArgsArgs;
 };
-export type CreateDetailArgs = {
+export type CreateArgs = {
     /**
      * - The arguments to be passed to the crud functions.
      */
@@ -58,7 +55,7 @@ export type CreateDetailArgs = {
      */
     isCancelled: Readonly<import("vue").Ref<boolean>>;
 };
-export type RetrieveDetailArgs = {
+export type RetrieveArgs = {
     /**
      * - The arguments to be passed to the crud functions.
      */
@@ -84,7 +81,7 @@ export type RetrieveDetailArgs = {
      */
     isCancelled: Readonly<import("vue").Ref<boolean>>;
 };
-export type UpdateDetailArgs = {
+export type UpdateArgs = {
     /**
      * - The arguments to be passed to the crud functions.
      */
@@ -110,7 +107,7 @@ export type UpdateDetailArgs = {
      */
     isCancelled: Readonly<import("vue").Ref<boolean>>;
 };
-export type DeleteDetailArgs = {
+export type DeleteArgs = {
     /**
      * - The arguments to be passed to the crud functions.
      */
@@ -130,7 +127,7 @@ export type DeleteDetailArgs = {
      */
     isCancelled: Readonly<import("vue").Ref<boolean>>;
 };
-export type PartialDetailArgs = {
+export type PartialArgs = {
     /**
      * - The arguments to be passed to the crud functions.
      */
@@ -163,7 +160,7 @@ export type PartialDetailArgs = {
     isCancelled: Readonly<import("vue").Ref<boolean>>;
 };
 export type CrudSubscribeCallback = (data: import("../use/objectInstance.js").ExistingCrudObject, action: string) => any;
-export type SubscribeArgs = {
+export type ObjectSubscribeArgs = {
     /**
      * - The arguments to be passed to the crud functions.
      */
@@ -194,12 +191,12 @@ export type SubscribeArgs = {
     isCancelled: Readonly<import("vue").Ref<boolean>>;
 };
 export type CrudResponse = import("../utils/cancellablePromise.js").MaybeCancellablePromise<object | string>;
-export type CrudCreateFn = (args: CreateDetailArgs) => CrudResponse;
-export type CrudRetrieveFn = (args: RetrieveDetailArgs) => CrudResponse;
-export type CrudUpdateFn = (args: UpdateDetailArgs) => CrudResponse;
-export type CrudPatchFn = (args: PartialDetailArgs) => CrudResponse;
-export type CrudDeleteFn = (args: DeleteDetailArgs) => CrudResponse;
-export type CrudSubscribeFn = (args: SubscribeArgs) => import("../utils/cancellablePromise.js").CancellablePromise<void>;
+export type CrudCreateFn = (args: CreateArgs) => CrudResponse;
+export type CrudRetrieveFn = (args: RetrieveArgs) => CrudResponse;
+export type CrudUpdateFn = (args: UpdateArgs) => CrudResponse;
+export type CrudPatchFn = (args: PartialArgs) => CrudResponse;
+export type CrudDeleteFn = (args: DeleteArgs) => CrudResponse;
+export type CrudObjectSubscribeFn = (args: ObjectSubscribeArgs) => import("../utils/cancellablePromise.js").CancellablePromise<void>;
 /**
  * Defines the CRUD-related functions and additional utilities provided by the object instance.
  */
@@ -227,11 +224,10 @@ export type ObjectCrudFunctions = {
     /**
      * - A function to be used instead of the default crud subscribe function.
      */
-    subscribe?: CrudSubscribeFn;
+    subscribe?: CrudObjectSubscribeFn;
 };
 /**
  * The CRUD arguments.
  */
 export type ObjectCrudArgs = ObjectCrudArgsProperties & ObjectCrudFunctions;
-import { CancellablePromise } from "../utils/cancellablePromise.js";
 //# sourceMappingURL=objectCrud.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"objectCrud.d.ts","sourceRoot":"","sources":["../../config/objectCrud.js"],"names":[],"mappings":"AAyLA;;iCA1KsB,GAAG,EAAE;+BAAL,GAAG,EAAE;+BAAL,GAAG,EAAE;8BAAL,GAAG,EAAE;+BAAL,GAAG,EAAE;kCAUL,GAAG,EAAE;EAgKuB;AAQ3C,+GAHI,cAAc,QAexB;AAWM,4CANI,OAAO,KAAK,EAAE,gBAAgB,CAAC,wBAAwB,CAAC,yBAEhE;IAAuE,KAAK,GAApE,OAAO,KAAK,EAAE,gBAAgB,CAAC,oBAAoB,CAAC;IACtB,SAAS,GAAvC,mBAAmB;CAC3B,QAoBF;iCAlMY;IAAC,CAAC,GAAG,EAAC,MAAM,GAAG,GAAG,CAAA;CAAC;;;;;;;;UAOlB,kBAAkB;;;;;;eAKlB,kBAAkB;;;;;;cAKlB;QAAC,CAAC,GAAG,EAAC,MAAM,GAAG,GAAG,CAAA;KAAC;;;;YACnB;QAAC,CAAC,GAAG,EAAC,MAAM,GAAG,GAAG,CAAA;KAAC;;;;kBACnB;QAAC,CAAC,GAAG,EAAC,MAAM,GAAG,GAAG,CAAA;KAAC;;;;WACnB,MAAM;;;;iBACN,QAAQ,CAAC,OAAO,KAAK,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC;;;;;;cAKpC;QAAC,CAAC,GAAG,EAAC,MAAM,GAAG,GAAG,CAAA;KAAC;;;;QACnB,MAAM;;;;WACN,MAAM;;;;kBACN;QAAC,CAAC,GAAG,EAAC,MAAM,GAAG,GAAG,CAAA;KAAC;;;;iBACnB,QAAQ,CAAC,OAAO,KAAK,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC;;;;;;cAKpC;QAAC,CAAC,GAAG,EAAC,MAAM,GAAG,GAAG,CAAA;KAAC;;;;YACnB,OAAO,0BAA0B,EAAE,kBAAkB;;;;kBACrD;QAAC,CAAC,GAAG,EAAC,MAAM,GAAG,GAAG,CAAA;KAAC;;;;WACnB,MAAM;;;;iBACN,QAAQ,CAAC,OAAO,KAAK,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC;;;;;;cAKpC;QAAC,CAAC,GAAG,EAAC,MAAM,GAAG,GAAG,CAAA;KAAC;;;;QACnB,MAAM;;;;WACN,MAAM;;;;iBACN,QAAQ,CAAC,OAAO,KAAK,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC;;;;;;cAKpC;QAAC,CAAC,GAAG,EAAC,MAAM,GAAG,GAAG,CAAA;KAAC;;;;QACnB,MAAM;;;;WACN,MAAM;;;;mBACN;QAAC,CAAC,GAAG,EAAC,MAAM,GAAG,GAAG,CAAA;KAAC;;;;kBACnB;QAAC,CAAC,GAAG,EAAC,MAAM,GAAG,GAAG,CAAA;KAAC;;;;iBACnB,QAAQ,CAAC,OAAO,KAAK,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC;;2CAKvC,OAAO,0BAA0B,EAAE,kBAAkB,UACrD,MAAM;;;;;cAKH;QAAC,CAAC,GAAG,EAAC,MAAM,GAAG,GAAG,CAAA;KAAC;;;;QACnB,MAAM;;;;WACN,MAAM;;;;kBACN;QAAC,CAAC,GAAG,EAAC,MAAM,GAAG,GAAG,CAAA;KAAC;;;;cACnB,qBAAqB;;;;iBACrB,QAAQ,CAAC,OAAO,KAAK,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC;;2BAIrC,OAAO,gCAAgC,EAAE,uBAAuB,CAAC,MAAM,GAAC,MAAM,CAAC;kCAKjF,gBAAgB,KACd,YAAY;oCAKd,kBAAkB,KAChB,YAAY;kCAKd,gBAAgB,KACd,YAAY;iCAKd,iBAAiB,KACf,YAAY;kCAKd,gBAAgB,KACd,YAAY;qCAKd,aAAa,KACX,OAAO,gCAAgC,EAAE,kBAAkB,CAAC,IAAI,CAAC;;;;;;;;aAOhE,YAAY;;;;eACZ,cAAc;;;;aACd,YAAY;;;;aACZ,YAAY;;;;YACZ,WAAW;;;;gBACX,eAAe;;;;;6BAMhB,wBAAwB,GAAG,mBAAmB;mCAvKxB,gCAAgC"}
+{"version":3,"file":"objectCrud.d.ts","sourceRoot":"","sources":["../../config/objectCrud.js"],"names":[],"mappings":"AAuJA;;;;GAIG;AACH,gCAFU,QAAQ,CAAC,mBAAmB,CAAC,CAEiB;AAQjD,iDAHI,cAAc,QAWxB;AAWM,sCANI,OAAO,KAAK,EAAE,gBAAgB,CAAC,wBAAwB,CAAC,WAEhE;IAAuE,KAAK,GAApE,OAAO,KAAK,EAAE,gBAAgB,CAAC,oBAAoB,CAAC;IACtB,SAAS,GAAvC,mBAAmB;CAC3B,QAIF;iCA9KY;IAAC,CAAC,GAAG,EAAC,MAAM,GAAG,GAAG,CAAA;CAAC;;;;;;;;UAOlB,kBAAkB;;;;;;eAKlB,kBAAkB;;;;;;cAKlB;QAAC,CAAC,GAAG,EAAC,MAAM,GAAG,GAAG,CAAA;KAAC;;;;YACnB;QAAC,CAAC,GAAG,EAAC,MAAM,GAAG,GAAG,CAAA;KAAC;;;;kBACnB;QAAC,CAAC,GAAG,EAAC,MAAM,GAAG,GAAG,CAAA;KAAC;;;;WACnB,MAAM;;;;iBACN,QAAQ,CAAC,OAAO,KAAK,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC;;;;;;cAKpC;QAAC,CAAC,GAAG,EAAC,MAAM,GAAG,GAAG,CAAA;KAAC;;;;QACnB,MAAM;;;;WACN,MAAM;;;;kBACN;QAAC,CAAC,GAAG,EAAC,MAAM,GAAG,GAAG,CAAA;KAAC;;;;iBACnB,QAAQ,CAAC,OAAO,KAAK,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC;;;;;;cAKpC;QAAC,CAAC,GAAG,EAAC,MAAM,GAAG,GAAG,CAAA;KAAC;;;;YACnB,OAAO,0BAA0B,EAAE,kBAAkB;;;;kBACrD;QAAC,CAAC,GAAG,EAAC,MAAM,GAAG,GAAG,CAAA;KAAC;;;;WACnB,MAAM;;;;iBACN,QAAQ,CAAC,OAAO,KAAK,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC;;;;;;cAKpC;QAAC,CAAC,GAAG,EAAC,MAAM,GAAG,GAAG,CAAA;KAAC;;;;QACnB,MAAM;;;;WACN,MAAM;;;;iBACN,QAAQ,CAAC,OAAO,KAAK,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC;;;;;;cAKpC;QAAC,CAAC,GAAG,EAAC,MAAM,GAAG,GAAG,CAAA;KAAC;;;;QACnB,MAAM;;;;WACN,MAAM;;;;mBACN;QAAC,CAAC,GAAG,EAAC,MAAM,GAAG,GAAG,CAAA;KAAC;;;;kBACnB;QAAC,CAAC,GAAG,EAAC,MAAM,GAAG,GAAG,CAAA;KAAC;;;;iBACnB,QAAQ,CAAC,OAAO,KAAK,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC;;2CAKvC,OAAO,0BAA0B,EAAE,kBAAkB,UACrD,MAAM;;;;;cAKH;QAAC,CAAC,GAAG,EAAC,MAAM,GAAG,GAAG,CAAA;KAAC;;;;QACnB,MAAM;;;;WACN,MAAM;;;;kBACN;QAAC,CAAC,GAAG,EAAC,MAAM,GAAG,GAAG,CAAA;KAAC;;;;cACnB,qBAAqB;;;;iBACrB,QAAQ,CAAC,OAAO,KAAK,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC;;2BAIrC,OAAO,gCAAgC,EAAE,uBAAuB,CAAC,MAAM,GAAC,MAAM,CAAC;kCAKjF,UAAU,KACR,YAAY;oCAKd,YAAY,KACV,YAAY;kCAKd,UAAU,KACR,YAAY;iCAKd,WAAW,KACT,YAAY;kCAKd,UAAU,KACR,YAAY;2CAKd,mBAAmB,KACjB,OAAO,gCAAgC,EAAE,kBAAkB,CAAC,IAAI,CAAC;;;;;;;;aAOhE,YAAY;;;;eACZ,cAAc;;;;aACd,YAAY;;;;aACZ,YAAY;;;;YACZ,WAAW;;;;gBACX,qBAAqB;;;;;6BAMtB,wBAAwB,GAAG,mBAAmB"}

package/types/index.d.ts

@@ -4,9 +4,9 @@ export * from "./use/cancellableIntent.js";
 export * from "./use/combineClasses.js";
 export * from "./use/list.js";
 export * from "./use/listCalculated.js";
-export * from "./use/listKeys.js";
 export * from "./use/listFilter.js";
 export * from "./use/listInstance.js";
+export * from "./use/listKeys.js";
 export * from "./use/listRelated.js";
 export * from "./use/listSearch.js";
 export * from "./use/listSort.js";
@@ -33,8 +33,10 @@ export * from "./utils/getFakePk.js";
 export * from "./utils/keepAliveTry.js";
 export * from "./utils/keyDiff.js";
 export * from "./utils/loadingCombine.js";
+export * from "./utils/refIfReactive.js";
 export * from "./utils/relatedCalculatedHelpers.js";
 export * from "./utils/set.js";
 export * from "./utils/transformWalk.js";
+export * from "./utils/unwrapNested.js";
 export * from "./utils/watches.js";
 //# sourceMappingURL=index.d.ts.map

package/types/use/listInstance.d.ts

@@ -13,13 +13,13 @@
  * @typedef {object} ListInstanceOptions
  * @property {import('vue').UnwrapNestedRefs<ListInstanceProps>} props - The props for the list instance.
  * @property {object} [functions] - Default implementation are used as set by `setListCrud`.
- * @property {import('../config/listCrud.js').ListFn} [functions.list] - Provide the implementation for the list
+ * @property {import('../config/listCrud.js').CrudListFn} [functions.list] - Provide the implementation for the list
  *  function.
- *  @property {import('../config/listCrud.js').BulkDeleteFn} [functions.bulkDelete] - Provide the implementation for the bulkDelete
+ *  @property {import('../config/listCrud.js').CrudBulkDeleteFn} [functions.bulkDelete] - Provide the implementation for the bulkDelete
  *  function.
- *   @property {import('../config/listCrud.js').ExecuteActionFn} [functions.executeAction] - Provide the implementation for the executeAction
+ *   @property {import('../config/listCrud.js').CrudExecuteActionFn} [functions.executeAction] - Provide the implementation for the executeAction
  *  function.
- * @property {import('../config/listCrud.js').SubscribeFn} [functions.subscribe] - Provide the implementation for the
+ * @property {import('../config/listCrud.js').CrudListSubscribeFn} [functions.subscribe] - Provide the implementation for the
  *  subscribe function.
  * @property {boolean} keepOldPages - If true, pages will not be cleared when defaultPageCallback is called.
  */
@@ -211,10 +211,10 @@ export type ListInstanceOptions = {
      * - Default implementation are used as set by `setListCrud`.
      */
     functions?: {
-        list?: import("../config/listCrud.js").ListFn;
-        bulkDelete?: import("../config/listCrud.js").BulkDeleteFn;
-        executeAction?: import("../config/listCrud.js").ExecuteActionFn;
-        subscribe?: import("../config/listCrud.js").SubscribeFn;
+        list?: import("../config/listCrud.js").CrudListFn;
+        bulkDelete?: import("../config/listCrud.js").CrudBulkDeleteFn;
+        executeAction?: import("../config/listCrud.js").CrudExecuteActionFn;
+        subscribe?: import("../config/listCrud.js").CrudListSubscribeFn;
     };
     /**
      * - If true, pages will not be cleared when defaultPageCallback is called.

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

@@ -1 +1 @@
-{"version":3,"file":"listInstance.d.ts","sourceRoot":"","sources":["../../use/listInstance.js"],"names":[],"mappings":"AAuCA;;;;;;;;GAQG;AAEH;;;;;;;;;;;;;;;GAeG;AAEH;;;;GAIG;AAEH;;;;GAIG;AAEH;;;;GAIG;AAEH;;;;;;;;;;;;;;;;;GAiBG;AAEH;;;;GAIG;AAEH;;;;;;;;;;;;;;GAcG;AAEH;;;;GAIG;AAEH;;;;GAIG;AAEH;;;;;GAKG;AACH,mDAHW;IAAC,CAAC,GAAG,EAAE,MAAM,GAAG,mBAAmB,CAAA;CAAC,GAClC;IAAC,CAAC,GAAG,EAAE,MAAM,GAAG,YAAY,CAAA;CAAC,CASzC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsDG;AACH,oEALW,mBAAmB,GAEjB,YAAY,CAsTxB;AA1fD;;;;GAIG;AAEH;;;;;GAKG;AAEH;;;GAGG;AACH;IACI;;;;;OAKG;IACH,qBAHW,MAAM,QACN,MAAM,EAMhB;IADG,aAAgB;CAEvB;;;;;;;;WAMa,MAAM;;;;kBACN,MAAM;;;;cACN,MAAM;;;;cACN,MAAM;;;;;;;;;WAON,OAAO,KAAK,EAAE,gBAAgB,CAAC,iBAAiB,CAAC;;;;gBAE5D;QAA8D,IAAI,GAAvD,OAAO,uBAAuB,EAAE,MAAM;QAEoB,UAAU,GAAnE,OAAO,uBAAuB,EAAE,YAAY;QAEiB,aAAa,GAAzE,OAAO,uBAAuB,EAAE,eAAe;QAEO,SAAS,GAAjE,OAAO,uBAAuB,EAAE,WAAW;KAEtD;;;;kBAAW,OAAO;;;;;0BAMR;IAAC,CAAC,EAAE,EAAE,MAAM,GAAG,UAAU,CAAA;CAAC;;;;6BAM1B,OAAO,KAAK,EAAE,WAAW,CAAC,UAAU,EAAE,CAAC;;;;wBAMvC,OAAO,KAAK,EAAE,WAAW,CAAC,MAAM,EAAE,CAAC;;;;;;;;UAQ7C;QAAwB,IAAI,EAAjB,MAAM;QACU,IAAI;KAC/B;;;;WAAW,MAAM;;;;kBACN,MAAM;;;;cACN,MAAM;;;;aACN,WAAW;;;;aACX,OAAO;;;;cACP,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;;;;WACvC,SAAS;;;;oBACT,cAAc;;;;;gCAMf,OAAO,KAAK,EAAE,gBAAgB,CAAC,oBAAoB,CAAC;;;;;;;;yBAOnD,CAAC,UAAU,EAAE,UAAU,EAAE,KAAK,IAAI;;;;kBAClC,CAAC,UAAU,EAAE,UAAU,EAAE,KAAK,IAAI;;;;mBAClC,CAAC,MAAM,EAAE,UAAU,KAAK,IAAI;;;;sBAC5B,CAAC,MAAM,EAAE,UAAU,KAAK,IAAI;;;;sBAC5B,CAAC,QAAQ,EAAE,MAAM,KAAK,IAAI;;;;eAC1B,MAAM,IAAI;;;;eACV,MAAM,MAAM;;;;UACZ,MAAM,OAAO,gCAAgC,EAAE,uBAAuB,CAAC,OAAO,GAAC,KAAK,CAAC;;;;gBACrF,MAAM,OAAO,CAAC,OAAO,CAAC;;;;mBACtB,MAAM,OAAO,CAAC,MAAM,GAAC,MAAM,GAAC,KAAK,CAAC;;;;;qCAMnC;IAAC,KAAK,EAAE,iBAAiB,CAAA;CAAC;;;;2BAM1B,sBAAsB,GAAG,qBAAqB;;;;;yBApH9C;IAAC,EAAE,EAAE,MAAM,CAAC;IAAC,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;CAAC"}
+{"version":3,"file":"listInstance.d.ts","sourceRoot":"","sources":["../../use/listInstance.js"],"names":[],"mappings":"AAwCA;;;;;;;;GAQG;AAEH;;;;;;;;;;;;;;;GAeG;AAEH;;;;GAIG;AAEH;;;;GAIG;AAEH;;;;GAIG;AAEH;;;;;;;;;;;;;;;;;GAiBG;AAEH;;;;GAIG;AAEH;;;;;;;;;;;;;;GAcG;AAEH;;;;GAIG;AAEH;;;;GAIG;AAEH;;;;;GAKG;AACH,mDAHW;IAAC,CAAC,GAAG,EAAE,MAAM,GAAG,mBAAmB,CAAA;CAAC,GAClC;IAAC,CAAC,GAAG,EAAE,MAAM,GAAG,YAAY,CAAA;CAAC,CASzC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsDG;AACH,oEALW,mBAAmB,GAEjB,YAAY,CAqTxB;AAzfD;;;;GAIG;AAEH;;;;;GAKG;AAEH;;;GAGG;AACH;IACI;;;;;OAKG;IACH,qBAHW,MAAM,QACN,MAAM,EAMhB;IADG,aAAgB;CAEvB;;;;;;;;WAMa,MAAM;;;;kBACN,MAAM;;;;cACN,MAAM;;;;cACN,MAAM;;;;;;;;;WAON,OAAO,KAAK,EAAE,gBAAgB,CAAC,iBAAiB,CAAC;;;;gBAE5D;QAAkE,IAAI,GAA3D,OAAO,uBAAuB,EAAE,UAAU;QAEoB,UAAU,GAAvE,OAAO,uBAAuB,EAAE,gBAAgB;QAEiB,aAAa,GAA7E,OAAO,uBAAuB,EAAE,mBAAmB;QAEW,SAAS,GAAzE,OAAO,uBAAuB,EAAE,mBAAmB;KAE9D;;;;kBAAW,OAAO;;;;;0BAMR;IAAC,CAAC,EAAE,EAAE,MAAM,GAAG,UAAU,CAAA;CAAC;;;;6BAM1B,OAAO,KAAK,EAAE,WAAW,CAAC,UAAU,EAAE,CAAC;;;;wBAMvC,OAAO,KAAK,EAAE,WAAW,CAAC,MAAM,EAAE,CAAC;;;;;;;;UAQ7C;QAAwB,IAAI,EAAjB,MAAM;QACU,IAAI;KAC/B;;;;WAAW,MAAM;;;;kBACN,MAAM;;;;cACN,MAAM;;;;aACN,WAAW;;;;aACX,OAAO;;;;cACP,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;;;;WACvC,SAAS;;;;oBACT,cAAc;;;;;gCAMf,OAAO,KAAK,EAAE,gBAAgB,CAAC,oBAAoB,CAAC;;;;;;;;yBAOnD,CAAC,UAAU,EAAE,UAAU,EAAE,KAAK,IAAI;;;;kBAClC,CAAC,UAAU,EAAE,UAAU,EAAE,KAAK,IAAI;;;;mBAClC,CAAC,MAAM,EAAE,UAAU,KAAK,IAAI;;;;sBAC5B,CAAC,MAAM,EAAE,UAAU,KAAK,IAAI;;;;sBAC5B,CAAC,QAAQ,EAAE,MAAM,KAAK,IAAI;;;;eAC1B,MAAM,IAAI;;;;eACV,MAAM,MAAM;;;;UACZ,MAAM,OAAO,gCAAgC,EAAE,uBAAuB,CAAC,OAAO,GAAC,KAAK,CAAC;;;;gBACrF,MAAM,OAAO,CAAC,OAAO,CAAC;;;;mBACtB,MAAM,OAAO,CAAC,MAAM,GAAC,MAAM,GAAC,KAAK,CAAC;;;;;qCAMnC;IAAC,KAAK,EAAE,iBAAiB,CAAA;CAAC;;;;2BAM1B,sBAAsB,GAAG,qBAAqB;;;;;yBApH9C;IAAC,EAAE,EAAE,MAAM,CAAC;IAAC,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;CAAC"}

package/types/use/objectInstance.d.ts

@@ -102,13 +102,13 @@ export function useObjectInstance({ props, functions }: ObjectInstanceOptions):
  * @property {import('../config/objectCrud.js').CrudUpdateFn} update - The update function.
  * @property {import('../config/objectCrud.js').CrudPatchFn} patch - The patch function.
  * @property {import('../config/objectCrud.js').CrudDeleteFn} delete - The delete function.
- * @property {import('../config/objectCrud.js').CrudSubscribeFn} subscribe - The subscribe function.
+ * @property {import('../config/objectCrud.js').CrudObjectSubscribeFn} subscribe - The subscribe function.
  */
 /**
  * The raw state of the object instance.
  *
  * @typedef {object} ObjectInstanceRawState
- * @property {import('vue').ShallowReactive<ObjectInstanceRawStateCrud>} crud - The crud functions.
+ * @property {import('vue').Reactive<ObjectInstanceRawStateCrud>} crud - The crud functions.
  * @property {import('vue').Ref<string|undefined>} pk - The pk of the object.
  * @property {import('vue').Ref<string|undefined>} pkKey - The pk key of the object.
  * @property {import('vue').Ref<{[key:string]: any}>} retrieveArgs - The arguments to be passed to the retrieve function.
@@ -236,7 +236,7 @@ export type ObjectInstanceRawStateCrud = {
     /**
      * - The subscribe function.
      */
-    subscribe: import("../config/objectCrud.js").CrudSubscribeFn;
+    subscribe: import("../config/objectCrud.js").CrudObjectSubscribeFn;
 };
 /**
  * The raw state of the object instance.
@@ -245,7 +245,7 @@ export type ObjectInstanceRawState = {
     /**
      * - The crud functions.
      */
-    crud: import("vue").ShallowReactive<ObjectInstanceRawStateCrud>;
+    crud: import("vue").Reactive<ObjectInstanceRawStateCrud>;
     /**
      * - The pk of the object.
      */

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

@@ -1 +1 @@
-{"version":3,"file":"objectInstance.d.ts","sourceRoot":"","sources":["../../use/objectInstance.js"],"names":[],"mappings":"AAuIA;;;;;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,wDAHW,qBAAqB,GACnB,cAAc,CAkR1B;AApdD;;;;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;;;;gBACtD,OAAO,yBAAyB,EAAE,mBAAmB;;;;;;;;;SAOrD,MAAM;;;;WACN,MAAM;;;;kBACN,MAAM;;;;cACN,OAAO,yBAAyB,EAAE,cAAc;;;;;;UAKhD,OAAO,KAAK,EAAE,QAAQ,CAAC,OAAO,yBAAyB,EAAE,kBAAkB,GAAC,EAAE,CAAC;;;;YAC/E,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,eAAe;;;;;;;;;UAOjD,OAAO,KAAK,EAAE,eAAe,CAAC,0BAA0B,CAAC;;;;QACzD,OAAO,KAAK,EAAE,GAAG,CAAC,MAAM,GAAC,SAAS,CAAC;;;;WACnC,OAAO,KAAK,EAAE,GAAG,CAAC,MAAM,GAAC,SAAS,CAAC;;;;kBACnC,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,wDAHW,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;;;;gBACtD,OAAO,yBAAyB,EAAE,mBAAmB;;;;;;;;;SAOrD,MAAM;;;;WACN,MAAM;;;;kBACN,MAAM;;;;cACN,OAAO,yBAAyB,EAAE,cAAc;;;;;;UAKhD,OAAO,KAAK,EAAE,QAAQ,CAAC,OAAO,yBAAyB,EAAE,kBAAkB,GAAC,EAAE,CAAC;;;;YAC/E,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;;;;kBACnC,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/utils/refIfReactive.d.ts

@@ -0,0 +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;
+//# sourceMappingURL=refIfReactive.d.ts.map

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

@@ -0,0 +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"}

package/types/utils/unwrapNested.d.ts

@@ -0,0 +1,2 @@
+export function unwrapNested<T>(arg: T): import("vue").UnwrapRef<T>;
+//# sourceMappingURL=unwrapNested.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"unwrapNested.d.ts","sourceRoot":"","sources":["../../utils/unwrapNested.js"],"names":[],"mappings":"AASO,6BAJM,CAAC,OACH,CAAC,GACC,OAAO,KAAK,EAAE,SAAS,CAAC,CAAC,CAAC,CAiBtC"}

package/use/listInstance.js

@@ -1,10 +1,11 @@
-import { getListCrud } from "../config/listCrud.js";
+import { defaultListCrud, getListCrud } from "../config/listCrud.js";
 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, toRef, unref, watch } from "vue";
+import { computed, effectScope, nextTick, reactive, readonly, ref, shallowReactive, toRef, unref, watch } from "vue";
 import { CancellablePromise, wrapMaybeCancellable } from "../utils/cancellablePromise.js";
+import { refIfReactive } from "../utils/refIfReactive.js";
 
 /**
  * A composable function for managing a list of objects.
@@ -53,13 +54,13 @@ export class ListInstanceError extends Error {
  * @typedef {object} ListInstanceOptions
  * @property {import('vue').UnwrapNestedRefs<ListInstanceProps>} props - The props for the list instance.
  * @property {object} [functions] - Default implementation are used as set by `setListCrud`.
- * @property {import('../config/listCrud.js').ListFn} [functions.list] - Provide the implementation for the list
+ * @property {import('../config/listCrud.js').CrudListFn} [functions.list] - Provide the implementation for the list
  *  function.
- *  @property {import('../config/listCrud.js').BulkDeleteFn} [functions.bulkDelete] - Provide the implementation for the bulkDelete
+ *  @property {import('../config/listCrud.js').CrudBulkDeleteFn} [functions.bulkDelete] - Provide the implementation for the bulkDelete
  *  function.
- *   @property {import('../config/listCrud.js').ExecuteActionFn} [functions.executeAction] - Provide the implementation for the executeAction
+ *   @property {import('../config/listCrud.js').CrudExecuteActionFn} [functions.executeAction] - Provide the implementation for the executeAction
  *  function.
- * @property {import('../config/listCrud.js').SubscribeFn} [functions.subscribe] - Provide the implementation for the
+ * @property {import('../config/listCrud.js').CrudListSubscribeFn} [functions.subscribe] - Provide the implementation for the
  *  subscribe function.
  * @property {boolean} keepOldPages - If true, pages will not be cleared when defaultPageCallback is called.
  */
@@ -207,16 +208,22 @@ export function useListInstances(listInstanceArgs) {
  */
 export function useListInstance({ props, functions = {}, keepOldPages }) {
     if (!props) {
-        throw new ListInstanceError(`useListInstance requires props`, "missing-props");
+        throw new ListInstanceError("useListInstance requires props", "missing-props");
     }
     if (keepOldPages === undefined) {
-        throw new ListInstanceError(`useListInstance requires keepOldPages`, "missing-keepOldPages");
+        throw new ListInstanceError("useListInstance requires keepOldPages", "missing-keepOldPages");
     }
+    if (!props.pkKey) {
+        throw new ListInstanceError("useListInstance requires pkKey.", "missing-pkKey");
+    }
+
+    const es = effectScope();
 
     // ### touching the _objectsMap or _objectsProxy directly will not trigger reactivity ###
     const _objectsMap = new Map(); // maps are ordered, if you don't clear lists, you need to insert pages in order.
 
     // ### touching the _objectsMap or _objectsProxy directly will not trigger reactivity ###
+    // noinspection JSValidateTypes
     /** @type {{[key: string]: ListObject}} */
     // @ts-ignore - we are using a proxy to make this map behave like an object for reactivity
     const _objectsProxy = new Proxy(_objectsMap, {
@@ -251,7 +258,7 @@ export function useListInstance({ props, functions = {}, keepOldPages }) {
                   }
                 : Reflect.getOwnPropertyDescriptor(target, p); // we can't report target properties as non-existent re: proxy invariants
         },
-        // things introspect us thing we are a map, we need to pretend to be a object
+        // things introspect us thing we are a map, we need to pretend to be an object
         getPrototypeOf() {
             return Object.prototype;
         },
@@ -263,27 +270,24 @@ export function useListInstance({ props, functions = {}, keepOldPages }) {
 
     // ### touching the _objectsMap or _objectsProxy directly will not trigger reactivity ###
     const state = reactive({
-        crud: {
-            args: {},
-            list: undefined,
-            bulkDelete: undefined,
-            executeAction: undefined,
-        },
-        pkKey: toRef(props, "pkKey"),
-        retrieveArgs: toRef(props, "retrieveArgs"),
-        listArgs: toRef(props, "listArgs"),
+        crud: shallowReactive({
+            args: reactive({}),
+            list: defaultListCrud.list,
+            bulkDelete: defaultListCrud.bulkDelete,
+            executeAction: defaultListCrud.executeAction,
+        }),
+        pkKey: refIfReactive(props, "pkKey"),
+        retrieveArgs: refIfReactive(props, "retrieveArgs", {}),
+        listArgs: refIfReactive(props, "listArgs", {}),
         /** @type {{[key: string]: ListObject}} */
         objects: /** @type {{[key: string]: ListObject}} */ _objectsProxy,
         running: false,
         loading: loadingError.loading,
         errored: loadingError.errored,
         error: loadingError.error,
-        /** @type {import('vue').ComputedRef<string[]>|undefined} */
-        order: undefined,
-        /** @type {import('vue').ComputedRef<ListObject[]>|undefined} */
-        objectsInOrder: undefined,
+        order: es.run(() => computed(() => Object.keys(state.objects))),
+        objectsInOrder: es.run(() => computed(() => objectsInOrderRefs.value.map((ref) => unref(ref)))),
     });
-    const es = effectScope();
 
     getListCrud(state.crud, { props, functions });
 
@@ -345,13 +349,13 @@ export function useListInstance({ props, functions = {}, keepOldPages }) {
                 pks: Object.keys(state.objects).map(Number),
                 pkKey: state.pkKey,
             })
-            .then((/** @type {any} */ responseData) => {
+            .then((/** @type {object|string} */ responseData) => {
                 loadingError.clearError();
                 return Promise.resolve(responseData);
             })
             .catch((/** @type {Error} */ error) => {
                 loadingError.setError(error);
-                return Promise.resolve(false);
+                return Promise.resolve(null);
             })
             .finally(() => {
                 loadingError.clearLoading();
@@ -489,10 +493,6 @@ export function useListInstance({ props, functions = {}, keepOldPages }) {
                 deep: true,
             }
         );
-        // @ts-ignore - we want the computed in the explicit effect scope, tsc is mad that we are 'changing' the type
-        state.objectsInOrder = computed(() => objectsInOrderRefs.value.map((ref) => unref(ref)));
-        // @ts-ignore - we want the computed in the explicit effect scope, tsc is mad that we are 'changing' the type
-        state.order = computed(() => Object.keys(state.objects));
     });
 
     // This isn't a direct return because we want the live returnedObject.pageCallback in list()

package/use/objectInstance.js

@@ -1,8 +1,9 @@
-import { defaultCrud, getObjectCrud } from "../config/objectCrud.js";
+import { defaultObjectCrud, getObjectCrud } from "../config/objectCrud.js";
 import { assignReactiveObject } from "../utils/assignReactiveObject.js";
 import { useLoadingError } from "./loadingError.js";
-import { reactive, readonly, ref, shallowReactive, toRef } from "vue";
+import { reactive, readonly, ref, shallowReactive } from "vue";
 import { wrapMaybeCancellable } from "../utils/cancellablePromise.js";
+import { refIfReactive } from "../utils/refIfReactive.js";
 
 /**
  * A composition function to manage create, retrieve, update, delete, and patch operations.
@@ -50,14 +51,14 @@ import { wrapMaybeCancellable } from "../utils/cancellablePromise.js";
  * @property {import('../config/objectCrud.js').CrudUpdateFn} update - The update function.
  * @property {import('../config/objectCrud.js').CrudPatchFn} patch - The patch function.
  * @property {import('../config/objectCrud.js').CrudDeleteFn} delete - The delete function.
- * @property {import('../config/objectCrud.js').CrudSubscribeFn} subscribe - The subscribe function.
+ * @property {import('../config/objectCrud.js').CrudObjectSubscribeFn} subscribe - The subscribe function.
  */
 
 /**
  * The raw state of the object instance.
  *
  * @typedef {object} ObjectInstanceRawState
- * @property {import('vue').ShallowReactive<ObjectInstanceRawStateCrud>} crud - The crud functions.
+ * @property {import('vue').Reactive<ObjectInstanceRawStateCrud>} crud - The crud functions.
  * @property {import('vue').Ref<string|undefined>} pk - The pk of the object.
  * @property {import('vue').Ref<string|undefined>} pkKey - The pk key of the object.
  * @property {import('vue').Ref<{[key:string]: any}>} retrieveArgs - The arguments to be passed to the retrieve function.
@@ -211,23 +212,22 @@ export function useObjectInstance({ props, functions = {} }) {
     const state = reactive(
         /** @type {ObjectInstanceRawState} */
         {
-            // function typing support is a lot nicer with shallow reactive
             crud: shallowReactive(
                 /** @type {ObjectInstanceRawStateCrud} */
                 {
                     args: reactive({}),
-                    create: defaultCrud.create,
-                    retrieve: defaultCrud.retrieve,
-                    update: defaultCrud.update,
-                    delete: defaultCrud.delete,
-                    patch: defaultCrud.patch,
-                    subscribe: defaultCrud.subscribe,
+                    create: defaultObjectCrud.create,
+                    retrieve: defaultObjectCrud.retrieve,
+                    update: defaultObjectCrud.update,
+                    delete: defaultObjectCrud.delete,
+                    patch: defaultObjectCrud.patch,
+                    subscribe: defaultObjectCrud.subscribe,
                 }
             ),
             object: reactive({}),
-            pk: toRef(props, "pk"),
-            pkKey: toRef(props, "pkKey"),
-            retrieveArgs: toRef(props, "retrieveArgs"),
+            pk: refIfReactive(props, "pk", null),
+            pkKey: refIfReactive(props, "pkKey"),
+            retrieveArgs: refIfReactive(props, "retrieveArgs", {}),
             loading: loadingError.loading,
             errored: loadingError.errored,
             error: loadingError.error,

package/utils/refIfReactive.js

@@ -0,0 +1,18 @@
+import { isReactive, toRef, unref } from "vue";
+
+/**
+ * Returns a ref to a property if the source is reactive, otherwise returns the unrefed value.
+ *
+ * @template T
+ * @template {keyof T} K
+ * @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.
+ */
+export const refIfReactive = (source, property, defaultValue) => {
+    if (source && isReactive(source)) {
+        return toRef(source, property);
+    }
+    return unref(source?.[property]) ?? defaultValue;
+};

package/utils/unwrapNested.js

@@ -0,0 +1,25 @@
+import { isProxy, isReactive, isRef, toRaw, unref } from "vue";
+
+/**
+ * Unwraps Vue refs and proxies to get the raw value.
+ *
+ * @template T
+ * @param {T} arg - The argument to unwrap.
+ * @returns {import('vue').UnwrapRef<T>} The unwrapped value.
+ */
+export const unwrapNested = (arg) => {
+    /** @type {unknown} */
+    let key = arg;
+    let proxied = isProxy(arg) || isReactive(arg);
+    let refed = isRef(arg);
+    while (proxied || refed) {
+        if (proxied) {
+            key = toRaw(key);
+        } else if (refed) {
+            key = unref(key);
+        }
+        proxied = isProxy(key);
+        refed = isRef(key);
+    }
+    return /** @type {import('vue').UnwrapRef<T>} */ (key);
+};