@arrai-innovations/reactive-helpers 18.0.2 → 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').ResponseData|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,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 object crud functions.
@@ -9,89 +8,133 @@ import { isReactive, toRef } from "vue";
  * @module config/objectCrud.js
  */
 
-const defaultCrud = {
-    args: {},
-    retrieve: undefined,
-    create: undefined,
-    update: undefined,
-    patch: undefined,
-    delete: undefined,
-    subscribe: undefined,
-};
+/**
+ * @typedef {{[key:string]: any}} ObjectCrudArgsArgs
+ */
 
 /**
  * Defines the CRUD-related functions and additional utilities provided by the object instance.
  *
  * @typedef {object} ObjectCrudArgsProperties
- * @property {object} [args={}] - The arguments to be passed to the crud functions.
+ * @property {ObjectCrudArgsArgs} args - The arguments to be passed to the crud functions.
  */
 
 /**
- * @typedef {object} CreateDetailArgs
- * @property {object} crudArgs - The arguments to be passed to the crud functions.
- * @property {object} object - The data to be acted upon.
- * @property {object} retrieveArgs - The arguments to be passed to the retrieve function.
+ * @typedef {object} ObjectCrudArgsOption
+ * @property {ObjectCrudArgsArgs} [crudArgs={}] - The arguments to be passed to the crud functions.
+ */
+
+/**
+ * @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.
  * @property {string} pkKey - The key name of the primary key.
+ * @property {Readonly<import('vue').Ref<boolean>>} isCancelled - A ref to indicate if the request was cancelled.
  */
 
 /**
- * @typedef {object} RetrieveDetailArgs
- * @property {object} crudArgs - The arguments to be passed to the crud functions.
+ * @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.
- * @property {object} retrieveArgs - The arguments to be passed to the retrieve function.
+ * @property {{[key:string]: any}} retrieveArgs - The arguments to be passed to the retrieve function.
+ * @property {Readonly<import('vue').Ref<boolean>>} isCancelled - A ref to indicate if the request was cancelled.
  */
 
 /**
- * @typedef {object} UpdateDetailArgs
- * @property {object} crudArgs - The arguments to be passed to the crud functions.
- * @property {import('../use/objectInstance.js').CrudObject} object - The data to be acted upon.
- * @property {object} retrieveArgs - The arguments to be passed to the retrieve function.
+ * @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.
  * @property {string} pkKey - The key name of the primary key.
+ * @property {Readonly<import('vue').Ref<boolean>>} isCancelled - A ref to indicate if the request was cancelled.
  */
 
 /**
- * @typedef {object} DeleteDetailArgs
- * @property {object} crudArgs - The arguments to be passed to the crud functions.
+ * @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.
- * @property {object} retrieveArgs - The arguments to be passed to the retrieve function.
+ * @property {Readonly<import('vue').Ref<boolean>>} isCancelled - A ref to indicate if the request was cancelled.
  */
 
 /**
- * @typedef {object} PartialDetailArgs
- * @property {object} crudArgs - The arguments to be passed to the crud functions.
+ * @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.
- * @property {object} partialObject - The data to be acted upon.
- * @property {object} retrieveArgs - The arguments to be passed to the retrieve function.
+ * @property {{[key:string]: any}} partialObject - The data to be acted upon.
+ * @property {{[key:string]: any}} retrieveArgs - The arguments to be passed to the retrieve function.
+ * @property {Readonly<import('vue').Ref<boolean>>} isCancelled - A ref to indicate if the request was cancelled.
+ */
+
+/**
+ * @callback CrudSubscribeCallback
+ * @param {import('../use/objectInstance.js').ExistingCrudObject} data - The data to be passed to the callback.
+ * @param {string} action - The action that was performed.
  */
 
 /**
- * @typedef {object} SubscribeArgs
- * @property {object} crudArgs - The arguments to be passed to the crud functions.
+ * @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.
- * @property {object} retrieveArgs - The arguments to be passed to the retrieve function.
- * @property {(
- *     data:import('../use/objectInstance.js').CrudObject, action:string
- * ) => void} callback - The callback to be called when the object is updated.
+ * @property {{[key:string]: any}} retrieveArgs - The arguments to be passed to the retrieve function.
+ * @property {CrudSubscribeCallback} callback - The callback to be called when the object is updated.
+ * @property {Readonly<import('vue').Ref<boolean>>} isCancelled - A ref to indicate if the request was cancelled.
+ */
+
+/**
+ * @typedef {import('../utils/cancellablePromise.js').MaybeCancellablePromise<object|string>} CrudResponse
+ */
+
+/**
+ * @callback CrudCreateFn
+ * @param {CreateArgs} args - The arguments to be passed to the create function.
+ * @returns {CrudResponse} - The response data from the create function.
+ */
+
+/**
+ * @callback CrudRetrieveFn
+ * @param {RetrieveArgs} args - The arguments to be passed to the retrieve function.
+ * @returns {CrudResponse} - The response data from the retrieve function.
  */
 
 /**
- * @typedef {Promise<object|string> & { cancel: () => Promise<void>|void }} ResponseData
+ * @callback CrudUpdateFn
+ * @param {UpdateArgs} args - The arguments to be passed to the update function.
+ * @returns {CrudResponse} - The response data from the update function.
+ */
+
+/**
+ * @callback CrudPatchFn
+ * @param {PartialArgs} args - The arguments to be passed to the patch function.
+ * @returns {CrudResponse} - The response data from the patch function.
+ */
+
+/**
+ * @callback CrudDeleteFn
+ * @param {DeleteArgs} args - The arguments to be passed to the delete function.
+ * @returns {CrudResponse} - The response data from the delete 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.
  */
 
 /**
  * Defines the CRUD-related functions and additional utilities provided by the object instance.
  *
  * @typedef {object} ObjectCrudFunctions
- * @property {(CreateDetailArgs)=>ResponseData} [create] - A function to be used instead of the default crud create function.
- * @property {(RetrieveDetailArgs)=>ResponseData} [retrieve] - A function to be used instead of the default crud retrieve function.
- * @property {(UpdateDetailArgs)=>ResponseData} [update] - A function to be used instead of the default crud update function.
- * @property {(DeleteDetailArgs)=>ResponseData} [delete] - A function to be used instead of the default crud delete function.
- * @property {(PartialDetailArgs)=>ResponseData} [patch] - A function to be used instead of the default crud patch function.
- * @property {(SubscribeArgs)=>void & { cancel: () => Promise<void>|void }} [subscribe] - A function to be used instead of the default crud subscribe function.
+ * @property {CrudCreateFn} [create] - A function to be used instead of the default crud create function.
+ * @property {CrudRetrieveFn} [retrieve] - A function to be used instead of the default crud retrieve function.
+ * @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 {CrudObjectSubscribeFn} [subscribe] - A function to be used instead of the default crud subscribe function.
  */
 
 /**
@@ -101,53 +144,43 @@ const defaultCrud = {
  *
  */
 
+const _defaultCrud = createDefaultCrud(
+    ["retrieve", "create", "update", "patch", "delete", "subscribe"],
+    new Set(["subscribe"])
+);
+
+/**
+ * The default object crud functions.
+ *
+ * @type {Readonly<ObjectCrudFunctions>}
+ */
+export const defaultObjectCrud = readonly(_defaultCrud);
+
 /**
  * Set the object crud functions.
  *
  * @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;
-    defaultCrud.create = create;
-    defaultCrud.update = update;
-    defaultCrud.patch = patch;
-    defaultCrud.delete = deleteFn;
-    defaultCrud.subscribe = subscribe;
-    // defensive cloning
-    Object.assign(defaultCrud.args, cloneDeep(args));
-    if (Object.keys(rest).length) {
-        throw new Error(`Unknown key(s) passed to setObjectCrud: ${Object.keys(rest).join(", ")}`);
+export const setObjectCrud = ({ 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 setObjectCrud`);
+        }
+        _defaultCrud[key] = value ?? _defaultCrud[key];
     }
 };
 
 /**
  * Get the previously set object crud functions.
  *
- * @param {import("vue").UnwrapNestedRefs<object>} 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<{
- *     crudArgs: ObjectCrudArgsProperties|undefined,
- * }>} [options.props] - The props with any passed crudArgs.
+ * @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";
@@ -23,15 +23,20 @@ export * from "./use/proxyLoadingError.js";
 export * from "./use/search.js";
 export * from "./use/watchesRunning.js";
 export * from "./utils/assignReactiveObject.js";
+export * from "./utils/cancellableFetch.js";
+export * from "./utils/cancellablePromise.js";
 export * from "./utils/classes.js";
 export * from "./utils/compact.js";
+export * from "./utils/deepUnref.js";
 export * from "./utils/deleteKey.js";
 export * from "./utils/flattenPaths.js";
 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.0.2",
+    "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": "npx --no-install tsc && 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"}