@arrai-innovations/reactive-helpers 18.0.2 → 18.1.0

package/config/listCrud.js

@@ -86,7 +86,7 @@ const defaultCrud = {
  */
 
 /**
- * @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.
+ * @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.
  */
 
 /**

package/config/objectCrud.js

@@ -1,7 +1,8 @@
 import { addOrUpdateReactiveObject } from "../utils/assignReactiveObject.js";
 import cloneDeep from "lodash-es/cloneDeep.js";
 import isFunction from "lodash-es/isFunction.js";
-import { isReactive, toRef } from "vue";
+import { isReactive, readonly, toRef } from "vue";
+import { CancellablePromise } from "../utils/cancellablePromise.js";
 
 /**
  * Configuration for the default object crud functions.
@@ -9,89 +10,160 @@ import { isReactive, toRef } from "vue";
  * @module config/objectCrud.js
  */
 
-const defaultCrud = {
-    args: {},
-    retrieve: undefined,
-    create: undefined,
-    update: undefined,
-    patch: undefined,
-    delete: undefined,
-    subscribe: undefined,
+/**
+ * @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
+ */
+
 /**
  * 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} ObjectCrudArgsOption
+ * @property {ObjectCrudArgsArgs} [crudArgs={}] - 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.
+ * @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.
+ * @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.
+ * @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.
+ * @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.
+ * @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.
+ * @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
  */
 
 /**
- * @typedef {Promise<object|string> & { cancel: () => Promise<void>|void }} ResponseData
+ * @callback CrudCreateFn
+ * @param {CreateDetailArgs} 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.
+ * @returns {CrudResponse} - The response data from the retrieve function.
+ */
+
+/**
+ * @callback CrudUpdateFn
+ * @param {UpdateDetailArgs} 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.
+ * @returns {CrudResponse} - The response data from the patch function.
+ */
+
+/**
+ * @callback CrudDeleteFn
+ * @param {DeleteDetailArgs} 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.
+ * @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 {CrudSubscribeFn} [subscribe] - A function to be used instead of the default crud subscribe function.
  */
 
 /**
@@ -101,6 +173,18 @@ const defaultCrud = {
  *
  */
 
+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"),
+};
+
+export const defaultCrud = readonly(_defaultCrud);
+
 /**
  * Set the object crud functions.
  *
@@ -108,14 +192,14 @@ const defaultCrud = {
  * @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;
+    _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
-    Object.assign(defaultCrud.args, cloneDeep(args));
+    Object.assign(_defaultCrud.args, cloneDeep(args));
     if (Object.keys(rest).length) {
         throw new Error(`Unknown key(s) passed to setObjectCrud: ${Object.keys(rest).join(", ")}`);
     }
@@ -124,17 +208,15 @@ export const setObjectCrud = ({ retrieve, create, update, patch, delete: deleteF
 /**
  * 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>} reactiveCrud - 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));
+    Object.assign(reactiveCrud, cloneDeep(_defaultCrud));
     if (props?.crudArgs) {
         addOrUpdateReactiveObject(reactiveCrud.args, props.crudArgs);
     }

package/index.js

@@ -23,8 +23,11 @@ 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";

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@arrai-innovations/reactive-helpers",
-    "version": "18.0.2",
+    "version": "18.1.0",
     "description": "VueJS 3 utility composition functions to help manipulate objects and lists.",
     "main": "index.js",
     "type": "module",
@@ -30,7 +30,7 @@
         "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"
     },
     "repository": {
         "type": "git",

package/types/config/listCrud.d.ts

@@ -123,7 +123,7 @@ export type SubscribeFn = (SubscribeFnArgs: any) => Promise<boolean> & {
 /**
  * - 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").ResponseData | false> & {
+export type ExecuteActionFn = (ExecuteActionFnArgs: any) => Promise<import("./objectCrud.js").CrudResponse | false> & {
     cancel: () => Promise<void> | void;
 };
 export type ListCrudFunctions = {

package/types/config/objectCrud.d.ts

@@ -1,10 +1,20 @@
+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<object>, { props, functions }?: {
-    props?: import("vue").UnwrapNestedRefs<{
-        crudArgs: ObjectCrudArgsProperties | undefined;
-    }>;
+export function getObjectCrud(reactiveCrud: import("vue").UnwrapNestedRefs<ObjectCrudArgsProperties>, { props, functions }?: {
+    props?: import("vue").UnwrapNestedRefs<ObjectCrudArgsOption>;
     functions?: ObjectCrudFunctions;
 }): void;
+export type ObjectCrudArgsArgs = {
+    [key: string]: any;
+};
 /**
  * Defines the CRUD-related functions and additional utilities provided by the object instance.
  */
@@ -12,31 +22,49 @@ export type ObjectCrudArgsProperties = {
     /**
      * - The arguments to be passed to the crud functions.
      */
-    args?: object;
+    args: ObjectCrudArgsArgs;
+};
+export type ObjectCrudArgsOption = {
+    /**
+     * - The arguments to be passed to the crud functions.
+     */
+    crudArgs?: ObjectCrudArgsArgs;
 };
 export type CreateDetailArgs = {
     /**
      * - The arguments to be passed to the crud functions.
      */
-    crudArgs: object;
+    crudArgs: {
+        [key: string]: any;
+    };
     /**
      * - The data to be acted upon.
      */
-    object: object;
+    object: {
+        [key: string]: any;
+    };
     /**
      * - The arguments to be passed to the retrieve function.
      */
-    retrieveArgs: object;
+    retrieveArgs: {
+        [key: string]: any;
+    };
     /**
      * - The key name of the primary key.
      */
     pkKey: string;
+    /**
+     * - A ref to indicate if the request was cancelled.
+     */
+    isCancelled: Readonly<import("vue").Ref<boolean>>;
 };
 export type RetrieveDetailArgs = {
     /**
      * - The arguments to be passed to the crud functions.
      */
-    crudArgs: object;
+    crudArgs: {
+        [key: string]: any;
+    };
     /**
      * - The pk of the object to be acted upon.
      */
@@ -48,31 +76,47 @@ export type RetrieveDetailArgs = {
     /**
      * - The arguments to be passed to the retrieve function.
      */
-    retrieveArgs: object;
+    retrieveArgs: {
+        [key: string]: any;
+    };
+    /**
+     * - A ref to indicate if the request was cancelled.
+     */
+    isCancelled: Readonly<import("vue").Ref<boolean>>;
 };
 export type UpdateDetailArgs = {
     /**
      * - The arguments to be passed to the crud functions.
      */
-    crudArgs: object;
+    crudArgs: {
+        [key: string]: any;
+    };
     /**
      * - The data to be acted upon.
      */
-    object: import("../use/objectInstance.js").CrudObject;
+    object: import("../use/objectInstance.js").ExistingCrudObject;
     /**
      * - The arguments to be passed to the retrieve function.
      */
-    retrieveArgs: object;
+    retrieveArgs: {
+        [key: string]: any;
+    };
     /**
      * - The key name of the primary key.
      */
     pkKey: string;
+    /**
+     * - A ref to indicate if the request was cancelled.
+     */
+    isCancelled: Readonly<import("vue").Ref<boolean>>;
 };
 export type DeleteDetailArgs = {
     /**
      * - The arguments to be passed to the crud functions.
      */
-    crudArgs: object;
+    crudArgs: {
+        [key: string]: any;
+    };
     /**
      * - The pk of the object to be acted upon.
      */
@@ -82,15 +126,17 @@ export type DeleteDetailArgs = {
      */
     pkKey: string;
     /**
-     * - The arguments to be passed to the retrieve function.
+     * - A ref to indicate if the request was cancelled.
      */
-    retrieveArgs: object;
+    isCancelled: Readonly<import("vue").Ref<boolean>>;
 };
 export type PartialDetailArgs = {
     /**
      * - The arguments to be passed to the crud functions.
      */
-    crudArgs: object;
+    crudArgs: {
+        [key: string]: any;
+    };
     /**
      * - The pk of the object to be acted upon.
      */
@@ -102,17 +148,28 @@ export type PartialDetailArgs = {
     /**
      * - The data to be acted upon.
      */
-    partialObject: object;
+    partialObject: {
+        [key: string]: any;
+    };
     /**
      * - The arguments to be passed to the retrieve function.
      */
-    retrieveArgs: object;
+    retrieveArgs: {
+        [key: string]: any;
+    };
+    /**
+     * - A ref to indicate if the request was cancelled.
+     */
+    isCancelled: Readonly<import("vue").Ref<boolean>>;
 };
+export type CrudSubscribeCallback = (data: import("../use/objectInstance.js").ExistingCrudObject, action: string) => any;
 export type SubscribeArgs = {
     /**
      * - The arguments to be passed to the crud functions.
      */
-    crudArgs: object;
+    crudArgs: {
+        [key: string]: any;
+    };
     /**
      * - The pk of the object to be acted upon.
      */
@@ -124,15 +181,25 @@ export type SubscribeArgs = {
     /**
      * - The arguments to be passed to the retrieve function.
      */
-    retrieveArgs: object;
+    retrieveArgs: {
+        [key: string]: any;
+    };
     /**
      * - The callback to be called when the object is updated.
      */
-    callback: (data: import("../use/objectInstance.js").CrudObject, action: string) => void;
-};
-export type ResponseData = Promise<object | string> & {
-    cancel: () => Promise<void> | void;
+    callback: CrudSubscribeCallback;
+    /**
+     * - A ref to indicate if the request was cancelled.
+     */
+    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>;
 /**
  * Defines the CRUD-related functions and additional utilities provided by the object instance.
  */
@@ -140,32 +207,31 @@ export type ObjectCrudFunctions = {
     /**
      * - A function to be used instead of the default crud create function.
      */
-    create?: (CreateDetailArgs: any) => ResponseData;
+    create?: CrudCreateFn;
     /**
      * - A function to be used instead of the default crud retrieve function.
      */
-    retrieve?: (RetrieveDetailArgs: any) => ResponseData;
+    retrieve?: CrudRetrieveFn;
     /**
      * - A function to be used instead of the default crud update function.
      */
-    update?: (UpdateDetailArgs: any) => ResponseData;
+    update?: CrudUpdateFn;
     /**
      * - A function to be used instead of the default crud delete function.
      */
-    delete?: (DeleteDetailArgs: any) => ResponseData;
+    delete?: CrudDeleteFn;
     /**
      * - A function to be used instead of the default crud patch function.
      */
-    patch?: (PartialDetailArgs: any) => ResponseData;
+    patch?: CrudPatchFn;
     /**
      * - A function to be used instead of the default crud subscribe function.
      */
-    subscribe?: (SubscribeArgs: any) => void & {
-        cancel: () => Promise<void> | void;
-    };
+    subscribe?: CrudSubscribeFn;
 };
 /**
  * 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":"AA6GO,+GAHI,cAAc,QAexB;AAaM,4CARI,OAAO,KAAK,EAAE,gBAAgB,CAAC,MAAM,CAAC,yBAE9C;IAEa,KAAK,GAFV,OAAO,KAAK,EAAE,gBAAgB,CAAC;QACnC,QAAQ,EAAE,wBAAwB,GAAC,SAAS,CAAC;KAChD,CAAC;IACoC,SAAS,GAAvC,mBAAmB;CAC3B,QAoBF;;;;;;;;WA/Ha,MAAM;;;;;;cAKN,MAAM;;;;YACN,MAAM;;;;kBACN,MAAM;;;;WACN,MAAM;;;;;;cAKN,MAAM;;;;QACN,MAAM;;;;WACN,MAAM;;;;kBACN,MAAM;;;;;;cAKN,MAAM;;;;YACN,OAAO,0BAA0B,EAAE,UAAU;;;;kBAC7C,MAAM;;;;WACN,MAAM;;;;;;cAKN,MAAM;;;;QACN,MAAM;;;;WACN,MAAM;;;;kBACN,MAAM;;;;;;cAKN,MAAM;;;;QACN,MAAM;;;;WACN,MAAM;;;;mBACN,MAAM;;;;kBACN,MAAM;;;;;;cAKN,MAAM;;;;QACN,MAAM;;;;WACN,MAAM;;;;kBACN,MAAM;;;;cACN,CACP,IAAI,EAAC,OAAO,0BAA0B,EAAE,UAAU,EAAE,MAAM,EAAC,MAAM,KAChE,IAAI;;2BAIC,OAAO,CAAC,MAAM,GAAC,MAAM,CAAC,GAAG;IAAE,MAAM,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,GAAC,IAAI,CAAA;CAAE;;;;;;;;aAO5D,CAAC,gBAAgB,KAAA,KAAG,YAAY;;;;eAChC,CAAC,kBAAkB,KAAA,KAAG,YAAY;;;;aAClC,CAAC,gBAAgB,KAAA,KAAG,YAAY;;;;aAChC,CAAC,gBAAgB,KAAA,KAAG,YAAY;;;;YAChC,CAAC,iBAAiB,KAAA,KAAG,YAAY;;;;gBACjC,CAAC,aAAa,KAAA,KAAG,IAAI,GAAG;QAAE,MAAM,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,GAAC,IAAI,CAAA;KAAE;;;;;6BAM7D,wBAAwB,GAAG,mBAAmB"}
+{"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"}

package/types/index.d.ts

@@ -22,8 +22,11 @@ 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";

package/types/use/cancellableIntent.d.ts

@@ -1,11 +1,6 @@
 /**
  * @module use/cancellableIntent.js - A composable function for handling cancellable intents.
  */
-/**
- * A Promise that can be cancelled.
- *
- * @typedef {Promise<any> & { cancel: () => Promise<void>|void }} CancellablePromise
- */
 /**
  * @typedef {import("vue").UnwrapNestedRefs<object>} CancellableIntentState - The state of the cancellable intent.
  * @property {number} activeCount - The number of active intents.
@@ -18,7 +13,7 @@
  */
 /**
  * @typedef {object} CancellableIntentOptions - The options for the cancellable intent.
- * @property {() => CancellablePromise} awaitableWithCancel - The function that returns a promise that can be cancelled.
+ * @property {() => import('../utils/cancellablePromise.js').MaybeCancellablePromise<void>} awaitableWithCancel - The function that returns a promise that can be cancelled.
  * @property {import("vue").UnwrapNestedRefs<object>} [watchArguments={}] - The reactive object to watch for changes.
  * @property {import("vue").UnwrapNestedRefs<object>} [guardArguments={}] - The reactive object to watch for truthiness before running the intent.
  * @property {boolean} [clearActiveOnResolved=true] - Whether to clear the active state when the promise resolves.
@@ -70,12 +65,6 @@
  * @returns {CancellableIntent} - The instance of the cancellable intent.
  */
 export function useCancellableIntent({ awaitableWithCancel, watchArguments, guardArguments, clearActiveOnResolved, }: CancellableIntentOptions): CancellableIntent;
-/**
- * A Promise that can be cancelled.
- */
-export type CancellablePromise = Promise<any> & {
-    cancel: () => Promise<void> | void;
-};
 /**
  * - The state of the cancellable intent.
  */
@@ -87,7 +76,7 @@ export type CancellableIntentOptions = {
     /**
      * - The function that returns a promise that can be cancelled.
      */
-    awaitableWithCancel: () => CancellablePromise;
+    awaitableWithCancel: () => import("../utils/cancellablePromise.js").MaybeCancellablePromise<void>;
     /**
      * - The reactive object to watch for changes.
      */

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

@@ -1 +1 @@
-{"version":3,"file":"cancellableIntent.d.ts","sourceRoot":"","sources":["../../use/cancellableIntent.js"],"names":[],"mappings":"AAOA;;GAEG;AAEH;;;;GAIG;AAEH;;;;;;;;;GASG;AAEH;;;;;;GAMG;AAEH;;;;;;;GAOG;AAEH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqCG;AACH,sHAHW,wBAAwB,GACtB,iBAAiB,CAwL7B;;;;iCA3PY,OAAO,CAAC,GAAG,CAAC,GAAG;IAAE,MAAM,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,GAAC,IAAI,CAAA;CAAE;;;;qCAInD,OAAO,KAAK,EAAE,gBAAgB,CAAC,MAAM,CAAC;;;;;;;;yBAYrC,MAAM,kBAAkB;;;;qBACxB,OAAO,KAAK,EAAE,gBAAgB,CAAC,MAAM,CAAC;;;;qBACtC,OAAO,KAAK,EAAE,gBAAgB,CAAC,MAAM,CAAC;;;;4BACtC,OAAO;;;;;;;;;WAKP,sBAAsB;;;;oBACtB,OAAO,KAAK,EAAE,gBAAgB,CAAC,MAAM,CAAC;;;;oBACtC,OAAO,KAAK,EAAE,gBAAgB,CAAC,MAAM,CAAC"}
+{"version":3,"file":"cancellableIntent.d.ts","sourceRoot":"","sources":["../../use/cancellableIntent.js"],"names":[],"mappings":"AAOA;;GAEG;AAEH;;;;;;;;;GASG;AAEH;;;;;;GAMG;AAEH;;;;;;;GAOG;AAEH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqCG;AACH,sHAHW,wBAAwB,GACtB,iBAAiB,CAyL7B;;;;qCAxPY,OAAO,KAAK,EAAE,gBAAgB,CAAC,MAAM,CAAC;;;;;;;;yBAYrC,MAAM,OAAO,gCAAgC,EAAE,uBAAuB,CAAC,IAAI,CAAC;;;;qBAC5E,OAAO,KAAK,EAAE,gBAAgB,CAAC,MAAM,CAAC;;;;qBACtC,OAAO,KAAK,EAAE,gBAAgB,CAAC,MAAM,CAAC;;;;4BACtC,OAAO;;;;;;;;;WAKP,sBAAsB;;;;oBACtB,OAAO,KAAK,EAAE,gBAAgB,CAAC,MAAM,CAAC;;;;oBACtC,OAAO,KAAK,EAAE,gBAAgB,CAAC,MAAM,CAAC"}