@arrai-innovations/reactive-helpers 18.1.0 → 20.0.0

package/config/objectCrud.js

@@ -1,100 +1,71 @@
-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.
+ * Configuration for the default object crud handlers.
  *
  * @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
+ * @typedef {{[key:string]: any}} ObjectTargetArgs
  */
 
 /**
- * Defines the CRUD-related functions and additional utilities provided by the object instance.
+ * Defines the CRUD-related handlers and additional utilities provided by the object instance.
  *
- * @typedef {object} ObjectCrudArgsProperties
- * @property {ObjectCrudArgsArgs} args - The arguments to be passed to the crud functions.
+ * @typedef {object} ObjectTargetProperties
+ * @property {ObjectTargetArgs} args - The arguments to be passed to the crud handlers.
  */
 
 /**
- * @typedef {object} ObjectCrudArgsOption
- * @property {ObjectCrudArgsArgs} [crudArgs={}] - The arguments to be passed to the crud functions.
+ * @typedef {object} ObjectTargetOption
+ * @property {ObjectTargetArgs} [target={}] - The arguments to be passed to the crud handlers.
  */
 
 /**
- * @typedef {object} CreateDetailArgs
- * @property {{[key:string]: any}} crudArgs - The arguments to be passed to the crud functions.
+ * @typedef {object} CreateArgs
+ * @property {{[key:string]: any}} target - The arguments to be passed to the crud handlers.
  * @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 {{[key:string]: any}} params - 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 {{[key:string]: any}} crudArgs - The arguments to be passed to the crud functions.
+ * @typedef {object} RetrieveArgs
+ * @property {{[key:string]: any}} target - The arguments to be passed to the crud handlers.
  * @property {string} pk - The pk of the object to be acted upon.
  * @property {string} pkKey - The key name of the primary key.
- * @property {{[key:string]: any}} retrieveArgs - The arguments to be passed to the retrieve function.
+ * @property {{[key:string]: any}} params - 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 {{[key:string]: any}} crudArgs - The arguments to be passed to the crud functions.
+ * @typedef {object} UpdateArgs
+ * @property {{[key:string]: any}} target - The arguments to be passed to the crud handlers.
  * @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 {{[key:string]: any}} params - 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 {{[key:string]: any}} crudArgs - The arguments to be passed to the crud functions.
+ * @typedef {object} DeleteArgs
+ * @property {{[key:string]: any}} target - The arguments to be passed to the crud handlers.
  * @property {string} pk - The pk of the object to be acted upon.
  * @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} PartialDetailArgs
- * @property {{[key:string]: any}} crudArgs - The arguments to be passed to the crud functions.
+ * @typedef {object} PartialArgs
+ * @property {{[key:string]: any}} target - The arguments to be passed to the crud handlers.
  * @property {string} pk - The pk of the object to be acted upon.
  * @property {string} pkKey - The key name of the primary key.
  * @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 {{[key:string]: any}} params - 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.
  */
 
@@ -105,11 +76,11 @@ const requiredCancelMissingMethod = (name) => () => {
  */
 
 /**
- * @typedef {object} SubscribeArgs
- * @property {{[key:string]: any}} crudArgs - The arguments to be passed to the crud functions.
+ * @typedef {object} ObjectSubscribeArgs
+ * @property {{[key:string]: any}} target - The arguments to be passed to the crud handlers.
  * @property {string} pk - The pk of the object to be acted upon.
  * @property {string} pkKey - The key name of the primary key.
- * @property {{[key:string]: any}} retrieveArgs - The arguments to be passed to the retrieve function.
+ * @property {{[key:string]: any}} params - 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.
  */
@@ -120,116 +91,96 @@ 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.
  */
 
 /**
- * Defines the CRUD-related functions and additional utilities provided by the object instance.
+ * Defines the CRUD-related handlers and additional utilities provided by the object instance.
  *
- * @typedef {object} ObjectCrudFunctions
+ * @typedef {object} ObjectCrudHandlers
  * @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 {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.
  */
 
 /**
  * The CRUD arguments.
  *
- * @typedef {ObjectCrudArgsProperties & ObjectCrudFunctions} ObjectCrudArgs
+ * @typedef {ObjectTargetProperties & ObjectCrudHandlers} ObjectTarget
  *
  */
 
-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 handlers.
+ *
+ * @type {Readonly<ObjectCrudHandlers>}
+ */
+export const defaultObjectCrud = readonly(_defaultCrud);
 
 /**
- * Set the object crud functions.
+ * Set the object crud handlers.
  *
- * @param {ObjectCrudArgs} options - The options for the object crud functions.
+ * @param {ObjectTarget} options - The options for the object crud handlers.
  * @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.
+ * Get the previously set object crud handlers.
  *
- * @param {import("vue").UnwrapNestedRefs<ObjectCrudArgsProperties>} reactiveCrud - The reactive object you want to add the resulting crud to.
+ * @param {import("vue").UnwrapNestedRefs<ObjectTargetProperties>} 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.
+ * @param {import("vue").UnwrapNestedRefs<ObjectTargetOption>} [options.props] - The props with any passed target.
+ * @param {ObjectCrudHandlers} [options.handlers] - 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": "20.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",
@@ -51,7 +52,7 @@
         "@types/lodash-es": "^4.17.12",
         "@typescript-eslint/eslint-plugin": "^7.18.0",
         "@typescript-eslint/parser": "^7.18.0",
-        "@vitest/coverage-v8": "^3.0.8",
+        "@vitest/coverage-v8": "^3.1.2",
         "@vue/compiler-sfc": "^3.4.37",
         "@vue/eslint-config-prettier": "^9.0.0",
         "@vue/test-utils": "^2.3.2",
@@ -70,7 +71,7 @@
         "typedoc": "^0.27.1",
         "typedoc-plugin-markdown": "^4.3.0",
         "typescript": "^5.5.4",
-        "vitest": "^3.0.8"
+        "vitest": "^3.1.2"
     },
     "dependencies": {
         "@jcoreio/async-throttle": "^1.6.0",

package/types/config/commonCrud.d.ts

@@ -0,0 +1,19 @@
+/**
+ * Assigns the default CRUD handlers 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.handlers] - The functions to assign.
+ * @param {Set<string>} [options.validKeys] - The valid keys for the handlers.
+ */
+export function assignCrud(target: object, defaultCrud: object, { props, handlers, validKeys }?: {
+    props?: object;
+    handlers?: 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,mCAEd;IAAyB,KAAK,GAAtB,MAAM;IACW,QAAQ,GAAzB,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 handlers.
+ *
+ * @type {Readonly<ListCrudHandlers>}
+ */
+export const defaultListCrud: Readonly<ListCrudHandlers>;
+export function setListCrud({ args, ...rest }: ListCrudHandlers & Partial<ListTarget>): void;
+export function getListCrud(target: import("vue").UnwrapNestedRefs<ListCrudHandlers & ListTarget>, options: {
+    props?: import("vue").UnwrapNestedRefs<ListTargetOption>;
+    handlers?: ListCrudHandlers;
 }): void;
 export type PaginateInfo = {
     /**
@@ -20,23 +24,19 @@ 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.
+     * - The arguments to be passed to the crud handlers.
      */
-    crudArgs: object;
+    target: object;
     /**
      * - The key name of the primary key.
      */
     pkKey: string;
     /**
-     * - The arguments to be passed to the retrieve function.
+     * - The arguments to be passed for list crud handlers.
      */
-    retrieveArgs: object;
-    /**
-     * - The arguments to be passed for list crud functions.
-     */
-    listArgs: object;
+    params: object;
     /**
      * - The method to call with new page(s) of data received.
      */
@@ -47,11 +47,11 @@ export type ListFnArgs = {
      */
     isCancelled: Readonly<import("vue").Ref<boolean>>;
 };
-export type DeleteFnArgs = {
+export type BulkDeleteArgs = {
     /**
-     * - The arguments to be passed to the crud functions.
+     * - The arguments to be passed to the crud handlers.
      */
-    crudArgs: object;
+    target: object;
     /**
      * - The ids of the objects to be deleted.
      */
@@ -60,35 +60,41 @@ 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.
+     * - The arguments to be passed to the crud handlers.
      */
-    crudArgs: object;
+    target: object;
     /**
      * - The key name of the primary key.
      */
     pkKey: string;
     /**
-     * - The arguments to be passed to the retrieve function.
+     * - The arguments to be passed for list crud handlers.
      */
-    retrieveArgs: object;
-    /**
-     * - The arguments to be passed for list crud functions.
-     */
-    listArgs: object;
+    params: object;
     /**
      * - 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.
+     * - The arguments to be passed to the crud handlers.
      */
-    crudArgs: object;
+    target: object;
     /**
      * - The ids of the objects to be acted upon.
      */
@@ -101,53 +107,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 ListCrudFunctions = {
+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 ListCrudHandlers = {
     /**
      * - 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 ListTarget = {
+    /**
+     * - The default arguments for the crud handlers.
+     */
+    args: object;
 };
-export type ListCrudArgs = {
+export type ListTargetOption = {
     /**
-     * - The default arguments for the crud functions.
+     * - The default arguments for the crud handlers.
      */
-    args?: object;
+    target?: 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":"AAkHA;;;;GAIG;AACH,8BAFU,QAAQ,CAAC,gBAAgB,CAAC,CAEkB;AAS/C,+CAJI,gBAAgB,GAAG,OAAO,CAAC,UAAU,CAAC,GAEpC,IAAI,CAUhB;AAWM,oCANI,OAAO,KAAK,EAAE,gBAAgB,CAAC,gBAAgB,GAAG,UAAU,CAAC,WAErE;IAAmE,KAAK,GAAhE,OAAO,KAAK,EAAE,gBAAgB,CAAC,gBAAgB,CAAC;IACrB,QAAQ,GAAnC,gBAAgB;CACxB,QAIF;;;;;kBAzIa,MAAM;;;;gBACN,MAAM;;;;aACN,MAAM;;2BAIP,CACN,UAAU,EAAC,OAAO,wBAAwB,EAAE,UAAU,EACtD,cAAc,EAAE,YAAY,GAAC,SAAS,KACvC,IAAI;;;;;YAKI,MAAM;;;;WACN,MAAM;;;;YACN,MAAM;;;;kBACN,YAAY;;;;;iBACZ,QAAQ,CAAC,OAAO,KAAK,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC;;;;;;YAMpC,MAAM;;;;SACN,MAAM,EAAE;;;;WACR,MAAM;;;;;iBACN,QAAQ,CAAC,OAAO,KAAK,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC;;wCAKrC,CACN,0BAA0B,EAAC,OAAO,wBAAwB,EAAE,UAAU,GAAC,MAAM,EAC7E,MAAM,EAAE,QAAQ,GAAC,QAAQ,GAAC,QAAQ,KACnC,IAAI;;;;;YAKI,MAAM;;;;WACN,MAAM;;;;YACN,MAAM;;;;+BACN,yBAAyB;;;;;iBACzB,QAAQ,CAAC,OAAO,KAAK,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC;;;;;;YAMpC,MAAM;;;;SACN,MAAM,EAAE;;;;WACR,MAAM;;;;YACN,MAAM;;;;;iBACN,QAAQ,CAAC,OAAO,KAAK,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC;;gCAMvC,QAAQ,KACN,OAAO,gCAAgC,EAAE,uBAAuB,CAAC,IAAI,CAAC;sCAKxE,cAAc,KACZ,OAAO,gCAAgC,EAAE,uBAAuB,CAAC,IAAI,CAAC;yCAKxE,iBAAiB,KACf,OAAO,gCAAgC,EAAE,kBAAkB,CAAC,IAAI,CAAC;yCAKnE,iBAAiB,KACf,OAAO,gCAAgC,EAAE,uBAAuB,CAAC,MAAM,GAAC,MAAM,GAAC,IAAI,CAAC;;;;;WAKnF,UAAU;;;;iBACV,gBAAgB;;;;oBAChB,mBAAmB;;;;gBACnB,mBAAmB;;;;;;UAKnB,MAAM;;;;;;aAKN,MAAM"}