@arrai-innovations/reactive-helpers 21.0.1 → 21.1.0

package/README.md

@@ -83,3 +83,14 @@ Since v21.0.0, the changelog is available in the [CHANGELOG.md](./CHANGELOG.md)
     ```bash
     $ npm run docs
     ```
+
+6. Type-only workflows:
+
+    - Generate types without docs:
+        ```bash
+        $ npm run types
+        ```
+    - Smoke-check emitted types without regenerating:
+        ```bash
+        $ npm run types:check -- --skip-gen
+        ```

package/config/commonCrud.js

@@ -4,6 +4,18 @@ import { addOrUpdateReactiveObject } from "../utils/assignReactiveObject.js";
 import isFunction from "lodash-es/isFunction.js";
 import { refIfReactive } from "../utils/refIfReactive.js";
 
+/**
+ * Primary key type accepted as input (will be coerced to string).
+ *
+ * @typedef {string | number} PkInput
+ */
+
+/**
+ * Primary key type used for storage and output (always a string).
+ *
+ * @typedef {string} Pk
+ */
+
 /**
  * @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.

package/config/listCrud.js

@@ -19,6 +19,13 @@ import { readonly } from "vue";
 /**
  * @typedef {import("../use/listInstance.js").SetColumnTotalsFn} SetColumnTotals
  */
+
+/**
+ * Additional arguments that can be passed to list crud handlers.
+ *
+ * @typedef {{[key:string]: any}} AdditionalListArgs
+ */
+
 /**
  * @typedef {object} ListArgsRaw
  * @property {import('../config/objectCrud.js').TargetArgs} target - The arguments to be passed to the crud handlers.
@@ -33,16 +40,20 @@ import { readonly } from "vue";
  */
 
 /**
- * @typedef {ListArgsRaw & Partial<import('../use/cancellableIntent.js').CommonRunTracking>} ListArgs
+ * @typedef {ListArgsRaw & Partial<import('../use/cancellableIntent.js').CommonRunTracking> & AdditionalListArgs} ListArgs
  */
 
 /**
- * @typedef {object} BulkDeleteArgs
+ * @typedef {object} BulkDeleteArgsRaw
  * @property {import('../config/objectCrud.js').TargetArgs} target - The arguments to be passed to the crud handlers.
- * @property {string[]} pks - The ids of the objects to be deleted.
+ * @property {import('./commonCrud.js').Pk[]} pks - The ids of the objects to be deleted.
  * @property {string} pkKey - The key name of the primary key.
  */
 
+/**
+ * @typedef {BulkDeleteArgsRaw & AdditionalListArgs} BulkDeleteArgs
+ */
+
 /**
  * @typedef {(
  *     newOrUpdatedOrDeleteObject:import('../use/objectInstance.js').ExistingCrudObject|string,
@@ -61,17 +72,21 @@ import { readonly } from "vue";
  */
 
 /**
- * @typedef {ListSubscribeArgsRaw & Partial<import('../use/cancellableIntent.js').CommonRunTracking>} ListSubscribeArgs
+ * @typedef {ListSubscribeArgsRaw & Partial<import('../use/cancellableIntent.js').CommonRunTracking> & AdditionalListArgs } ListSubscribeArgs
  */
 
 /**
- * @typedef {object} ExecuteActionArgs
+ * @typedef {object} ExecuteActionArgsRaw
  * @property {import('../config/objectCrud.js').TargetArgs} target - The arguments to be passed to the crud handlers.
- * @property {string[]} pks - The ids of the objects to be acted upon.
+ * @property {import('./commonCrud.js').Pk[]} 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.
  */
 
+/**
+ * @typedef {ExecuteActionArgsRaw  & AdditionalListArgs } ExecuteActionArgs
+ */
+
 /**
  * @callback CrudListFn
  * @param {ListArgs} args - The arguments to be passed to the crud handlers.

package/config/objectCrud.js

@@ -12,6 +12,12 @@ import { readonly } from "vue";
  * @typedef {{[key:string]: any}} TargetArgs
  */
 
+/**
+ * Additional arguments that can be passed to CRUD handlers.
+ *
+ * @typedef {{[key:string]: any}} AdditionalCrudArgs
+ */
+
 /**
  * Defines the CRUD-related handlers and additional utilities provided by the object instance.
  *
@@ -25,7 +31,7 @@ import { readonly } from "vue";
  */
 
 /**
- * @typedef {object} CreateArgs
+ * @typedef {object} CreateArgsRaw
  * @property {TargetArgs} 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}} params - The arguments to be passed to the retrieve function.
@@ -33,21 +39,25 @@ import { readonly } from "vue";
  * @property {Readonly<import('vue').Ref<boolean>>} isCancelled - A ref to indicate if the request was cancelled.
  */
 
+/**
+ * @typedef {CreateArgsRaw & AdditionalCrudArgs} CreateArgs
+ */
+
 /**
  * @typedef {object} RetrieveArgsRaw
  * @property {TargetArgs} target - The arguments to be passed to the crud handlers.
- * @property {string} pk - The pk of the object to be acted upon.
+ * @property {import('./commonCrud.js').Pk} pk - The pk of the object to be acted upon.
  * @property {string} pkKey - The key name of the primary key.
  * @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 {RetrieveArgsRaw & import('../use/cancellableIntent.js').CommonRunTracking} RetrieveArgs
+ * @typedef {RetrieveArgsRaw & Partial<import('../use/cancellableIntent.js').CommonRunTracking> & AdditionalCrudArgs} RetrieveArgs
  */
 
 /**
- * @typedef {object} UpdateArgs
+ * @typedef {object} UpdateArgsRaw
  * @property {TargetArgs} 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}} params - The arguments to be passed to the retrieve function.
@@ -56,21 +66,45 @@ import { readonly } from "vue";
  */
 
 /**
- * @typedef {object} DeleteArgs
+ * @typedef {UpdateArgsRaw & AdditionalCrudArgs} UpdateArgs
+ */
+
+/**
+ * @typedef {object} DeleteArgsRaw
  * @property {TargetArgs} target - The arguments to be passed to the crud handlers.
- * @property {string} pk - The pk of the object to be acted upon.
+ * @property {import('./commonCrud.js').Pk} pk - The pk of the object to be acted upon.
  * @property {string} pkKey - The key name of the primary key.
  */
 
 /**
- * @typedef {object} PartialArgs
+ * @typedef {DeleteArgsRaw & AdditionalCrudArgs} DeleteArgs
+ */
+
+/**
+ * @typedef {object} PartialArgsRaw
  * @property {TargetArgs} target - The arguments to be passed to the crud handlers.
- * @property {string} pk - The pk of the object to be acted upon.
+ * @property {import('./commonCrud.js').Pk} 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}} 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 {PartialArgsRaw & AdditionalCrudArgs} PartialArgs
+ */
+
+/**
+ * @typedef {object} ObjectExecuteActionArgsRaw
+ * @property {import('../config/objectCrud.js').TargetArgs} target - The arguments to be passed to the crud handlers.
+ * @property {string} pk - The id 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 indicate if the request was cancelled.
+ */
+
+/**
+ * @typedef {ObjectExecuteActionArgsRaw & AdditionalCrudArgs} ObjectExecuteActionArgs
+ */
 
 /**
  * @callback CrudSubscribeCallback
@@ -81,7 +115,7 @@ import { readonly } from "vue";
 /**
  * @typedef {object} ObjectSubscribeArgsRaw
  * @property {TargetArgs} target - The arguments to be passed to the crud handlers.
- * @property {string} pk - The pk of the object to be acted upon.
+ * @property {import('./commonCrud.js').Pk} pk - The pk of the object to be acted upon.
  * @property {string} pkKey - The key name of the primary key.
  * @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.
@@ -89,7 +123,7 @@ import { readonly } from "vue";
  */
 
 /**
- * @typedef {ObjectSubscribeArgsRaw & import('../use/cancellableIntent.js').CommonRunTracking} ObjectSubscribeArgs
+ * @typedef {ObjectSubscribeArgsRaw & import('../use/cancellableIntent.js').CommonRunTracking & AdditionalCrudArgs} ObjectSubscribeArgs
  */
 
 /**
@@ -126,6 +160,12 @@ import { readonly } from "vue";
  * @returns {CrudResponse} - The response data from the delete function.
  */
 
+/**
+ * @callback CrudObjectExecuteActionFn
+ * @param {ObjectExecuteActionArgs} args - The arguments to be passed to the executeAction function.
+ * @returns {CrudResponse} - The response data from the delete function.
+ */
+
 /**
  * @callback CrudObjectSubscribeFn
  * @param {ObjectSubscribeArgs} args - The arguments to be passed to the subscribe function.
@@ -142,6 +182,8 @@ import { readonly } from "vue";
  * @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.
+ * @property {CrudObjectExecuteActionFn} [executeAction] - The  function to execute a certain action on an object.
+ *
  */
 
 /**
@@ -152,7 +194,7 @@ import { readonly } from "vue";
  */
 
 const _defaultCrud = createDefaultCrud(
-    ["retrieve", "create", "update", "patch", "delete", "subscribe"],
+    ["retrieve", "create", "update", "patch", "delete", "subscribe", "executeAction"],
     new Set(["subscribe"])
 );
 

package/index.js

@@ -33,12 +33,15 @@ export * from "./utils/deleteKey.js";
 export * from "./utils/flattenPaths.js";
 export * from "./utils/flattenPathsWithValues.js";
 export * from "./utils/getFakePk.js";
+export * from "./utils/isReactiveTyped.js";
 export * from "./utils/keepAliveTry.js";
 export * from "./utils/keyDiff.js";
 export * from "./utils/loadingCombine.js";
+export * from "./utils/proxyRunning.js";
 export * from "./utils/refIfReactive.js";
 export * from "./utils/relatedCalculatedHelpers.js";
 export * from "./utils/set.js";
+export * from "./utils/toRefsIfReactive.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": "21.0.1",
+    "version": "21.1.0",
     "description": "VueJS 3 utility composition functions to help manipulate objects and lists.",
     "main": "index.js",
     "type": "module",
@@ -32,7 +32,9 @@
         "prepare": "npx --no-install husky",
         "docs": "node make_type_doc.js",
         "docs:check": "node check_type_doc.js",
-        "docs:clean": "node clean_type_doc.js"
+        "docs:clean": "node clean_type_doc.js",
+        "types": "node make_types.js",
+        "types:check": "node check_types.js"
     },
     "repository": {
         "type": "git",
@@ -70,8 +72,8 @@
         "jsdom": "^26.0.0",
         "lint-staged": "^15.2.8",
         "prettier": "^3.3.3",
-        "typedoc": "^0.27.1",
-        "typedoc-plugin-markdown": "^4.3.0",
+        "typedoc": "^0.28.15",
+        "typedoc-plugin-markdown": "^4.9.0",
         "typescript": "^5.5.4",
         "vitest": "^3.1.2"
     },

package/types/config/commonCrud.d.ts

@@ -16,3 +16,11 @@ export function assignCrud(target: object, defaultCrud: object, { props, handler
 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;
+/**
+ * Primary key type accepted as input (will be coerced to string).
+ */
+export type PkInput = string | number;
+/**
+ * Primary key type used for storage and output (always a string).
+ */
+export type Pk = string;

package/types/config/listCrud.d.ts

@@ -12,6 +12,12 @@ export function getListCrud(target: import("vue").UnwrapNestedRefs<ListCrudHandl
 export type ClearObjectsFn = import("../use/listInstance.js").ClearListFn;
 export type SetPaginateInfo = import("../use/listInstance.js").SetPaginateInfoFn;
 export type SetColumnTotals = import("../use/listInstance.js").SetColumnTotalsFn;
+/**
+ * Additional arguments that can be passed to list crud handlers.
+ */
+export type AdditionalListArgs = {
+    [key: string]: any;
+};
 export type ListArgsRaw = {
     /**
      * - The arguments to be passed to the crud handlers.
@@ -47,8 +53,8 @@ export type ListArgsRaw = {
      */
     setColumnTotals: SetColumnTotals;
 };
-export type ListArgs = ListArgsRaw & Partial<import("../use/cancellableIntent.js").CommonRunTracking>;
-export type BulkDeleteArgs = {
+export type ListArgs = ListArgsRaw & Partial<import("../use/cancellableIntent.js").CommonRunTracking> & AdditionalListArgs;
+export type BulkDeleteArgsRaw = {
     /**
      * - The arguments to be passed to the crud handlers.
      */
@@ -56,12 +62,13 @@ export type BulkDeleteArgs = {
     /**
      * - The ids of the objects to be deleted.
      */
-    pks: string[];
+    pks: import("./commonCrud.js").Pk[];
     /**
      * - The key name of the primary key.
      */
     pkKey: string;
 };
+export type BulkDeleteArgs = BulkDeleteArgsRaw & AdditionalListArgs;
 export type applyObjectEvent = (newOrUpdatedOrDeleteObject: import("../use/objectInstance.js").ExistingCrudObject | string, action: "create" | "update" | "delete") => void;
 export type ListSubscribeArgsRaw = {
     /**
@@ -86,8 +93,8 @@ export type ListSubscribeArgsRaw = {
      */
     isCancelled: Readonly<import("vue").Ref<boolean>>;
 };
-export type ListSubscribeArgs = ListSubscribeArgsRaw & Partial<import("../use/cancellableIntent.js").CommonRunTracking>;
-export type ExecuteActionArgs = {
+export type ListSubscribeArgs = ListSubscribeArgsRaw & Partial<import("../use/cancellableIntent.js").CommonRunTracking> & AdditionalListArgs;
+export type ExecuteActionArgsRaw = {
     /**
      * - The arguments to be passed to the crud handlers.
      */
@@ -95,7 +102,7 @@ export type ExecuteActionArgs = {
     /**
      * - The ids of the objects to be acted upon.
      */
-    pks: string[];
+    pks: import("./commonCrud.js").Pk[];
     /**
      * - The key name of the primary key.
      */
@@ -105,6 +112,7 @@ export type ExecuteActionArgs = {
      */
     action: string;
 };
+export type ExecuteActionArgs = ExecuteActionArgsRaw & AdditionalListArgs;
 export type CrudListFn = (args: ListArgs) => import("../utils/cancellablePromise.js").MaybeCancellablePromise<void>;
 export type CrudBulkDeleteFn = (args: BulkDeleteArgs) => Promise<boolean>;
 export type CrudListSubscribeFn = (args: ListSubscribeArgs) => import("../utils/cancellablePromise.js").CancellablePromise<void>;

package/types/config/objectCrud.d.ts

@@ -12,6 +12,12 @@ export function getObjectCrud(target: import("vue").UnwrapNestedRefs<ObjectTarge
 export type TargetArgs = {
     [key: string]: any;
 };
+/**
+ * Additional arguments that can be passed to CRUD handlers.
+ */
+export type AdditionalCrudArgs = {
+    [key: string]: any;
+};
 /**
  * Defines the CRUD-related handlers and additional utilities provided by the object instance.
  */
@@ -27,7 +33,7 @@ export type ObjectTargetOption = {
      */
     target?: TargetArgs;
 };
-export type CreateArgs = {
+export type CreateArgsRaw = {
     /**
      * - The arguments to be passed to the crud handlers.
      */
@@ -53,6 +59,7 @@ export type CreateArgs = {
      */
     isCancelled: Readonly<import("vue").Ref<boolean>>;
 };
+export type CreateArgs = CreateArgsRaw & AdditionalCrudArgs;
 export type RetrieveArgsRaw = {
     /**
      * - The arguments to be passed to the crud handlers.
@@ -61,7 +68,7 @@ export type RetrieveArgsRaw = {
     /**
      * - The pk of the object to be acted upon.
      */
-    pk: string;
+    pk: import("./commonCrud.js").Pk;
     /**
      * - The key name of the primary key.
      */
@@ -77,8 +84,8 @@ export type RetrieveArgsRaw = {
      */
     isCancelled: Readonly<import("vue").Ref<boolean>>;
 };
-export type RetrieveArgs = RetrieveArgsRaw & import("../use/cancellableIntent.js").CommonRunTracking;
-export type UpdateArgs = {
+export type RetrieveArgs = RetrieveArgsRaw & Partial<import("../use/cancellableIntent.js").CommonRunTracking> & AdditionalCrudArgs;
+export type UpdateArgsRaw = {
     /**
      * - The arguments to be passed to the crud handlers.
      */
@@ -102,7 +109,8 @@ export type UpdateArgs = {
      */
     isCancelled: Readonly<import("vue").Ref<boolean>>;
 };
-export type DeleteArgs = {
+export type UpdateArgs = UpdateArgsRaw & AdditionalCrudArgs;
+export type DeleteArgsRaw = {
     /**
      * - The arguments to be passed to the crud handlers.
      */
@@ -110,13 +118,14 @@ export type DeleteArgs = {
     /**
      * - The pk of the object to be acted upon.
      */
-    pk: string;
+    pk: import("./commonCrud.js").Pk;
     /**
      * - The key name of the primary key.
      */
     pkKey: string;
 };
-export type PartialArgs = {
+export type DeleteArgs = DeleteArgsRaw & AdditionalCrudArgs;
+export type PartialArgsRaw = {
     /**
      * - The arguments to be passed to the crud handlers.
      */
@@ -124,7 +133,7 @@ export type PartialArgs = {
     /**
      * - The pk of the object to be acted upon.
      */
-    pk: string;
+    pk: import("./commonCrud.js").Pk;
     /**
      * - The key name of the primary key.
      */
@@ -146,6 +155,30 @@ export type PartialArgs = {
      */
     isCancelled: Readonly<import("vue").Ref<boolean>>;
 };
+export type PartialArgs = PartialArgsRaw & AdditionalCrudArgs;
+export type ObjectExecuteActionArgsRaw = {
+    /**
+     * - The arguments to be passed to the crud handlers.
+     */
+    target: import("../config/objectCrud.js").TargetArgs;
+    /**
+     * - The id of the objects to be acted upon.
+     */
+    pk: string;
+    /**
+     * - The key name of the primary key.
+     */
+    pkKey: string;
+    /**
+     * - The action to execute.
+     */
+    action: string;
+    /**
+     * - A ref to indicate if the request was cancelled.
+     */
+    isCancelled: Readonly<import("vue").Ref<boolean>>;
+};
+export type ObjectExecuteActionArgs = ObjectExecuteActionArgsRaw & AdditionalCrudArgs;
 export type CrudSubscribeCallback = (data: import("../use/objectInstance.js").ExistingCrudObject, action: "delete" | "update" | "create") => any;
 export type ObjectSubscribeArgsRaw = {
     /**
@@ -155,7 +188,7 @@ export type ObjectSubscribeArgsRaw = {
     /**
      * - The pk of the object to be acted upon.
      */
-    pk: string;
+    pk: import("./commonCrud.js").Pk;
     /**
      * - The key name of the primary key.
      */
@@ -175,13 +208,14 @@ export type ObjectSubscribeArgsRaw = {
      */
     isCancelled: Readonly<import("vue").Ref<boolean>>;
 };
-export type ObjectSubscribeArgs = ObjectSubscribeArgsRaw & import("../use/cancellableIntent.js").CommonRunTracking;
+export type ObjectSubscribeArgs = ObjectSubscribeArgsRaw & import("../use/cancellableIntent.js").CommonRunTracking & AdditionalCrudArgs;
 export type CrudResponse = import("../utils/cancellablePromise.js").MaybeCancellablePromise<object | string>;
 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 CrudObjectExecuteActionFn = (args: ObjectExecuteActionArgs) => CrudResponse;
 export type CrudObjectSubscribeFn = (args: ObjectSubscribeArgs) => import("../utils/cancellablePromise.js").CancellablePromise<void>;
 /**
  * Defines the CRUD-related handlers and additional utilities provided by the object instance.
@@ -211,6 +245,10 @@ export type ObjectCrudHandlers = {
      * - A function to be used instead of the default crud subscribe function.
      */
     subscribe?: CrudObjectSubscribeFn;
+    /**
+     * - The  function to execute a certain action on an object.
+     */
+    executeAction?: CrudObjectExecuteActionFn;
 };
 /**
  * The CRUD arguments.

package/types/index.d.ts

@@ -32,12 +32,15 @@ export * from "./utils/deleteKey.js";
 export * from "./utils/flattenPaths.js";
 export * from "./utils/flattenPathsWithValues.js";
 export * from "./utils/getFakePk.js";
+export * from "./utils/isReactiveTyped.js";
 export * from "./utils/keepAliveTry.js";
 export * from "./utils/keyDiff.js";
 export * from "./utils/loadingCombine.js";
+export * from "./utils/proxyRunning.js";
 export * from "./utils/refIfReactive.js";
 export * from "./utils/relatedCalculatedHelpers.js";
 export * from "./utils/set.js";
+export * from "./utils/toRefsIfReactive.js";
 export * from "./utils/transformWalk.js";
 export * from "./utils/unwrapNested.js";
 export * from "./utils/watches.js";

package/types/tests/unit/utils/isReactiveTyped.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/types/tests/unit/utils/refIfReactive.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/types/tests/unit/utils/toRefsIfReactive.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/types/use/cancellableIntent.d.ts

@@ -4,7 +4,7 @@
  * Enables distinguishing results or effects from overlapping async runs.
  */
 /**
- * @typedef {object} CancellableIntentRawState - The raw state of the cancellable intent.
+ * @typedef {object} CancellableIntentMyState - The raw state of the cancellable intent.
  * @property {import('vue').ComputedRef<boolean>|undefined} active - Whether there are active intents.
  * @property {import('vue').ComputedRef<boolean>|undefined} resolving - Whether there are resolving intents.
  * @property {boolean} clearActiveOnResolved - Whether to clear the active state when the promise resolves.
@@ -13,10 +13,10 @@
  * @property {import('vue').DeepReadonly<object>} guardArguments - The guard arguments.
  */
 /**
- * @typedef {import("vue").Reactive<
- *     CancellableIntentRawState &
- *     Pick<import('./error.js').ErrorStatus, 'error' | 'errored'>
- * >} CancellableIntentState - The state of the cancellable intent.
+ * @typedef {CancellableIntentMyState & import('./error.js').ErrorProperties} CancellableIntentRawState - The raw state of the cancellable intent.
+ */
+/**
+ * @typedef {import("vue").Reactive<CancellableIntentRawState>} CancellableIntentState - The state of the cancellable intent.
  */
 /**
  * @typedef {() => boolean} IsCurrentRunFn - A function that checks if the current run ID matches the last run ID.
@@ -29,7 +29,7 @@
  * @property {IsCurrentRunFn} isCurrentRun - A function that checks if the current run ID matches your run ID.
  */
 /**
- * @typedef {(runTracking: CommonRunTracking) => import('../utils/cancellablePromise.js').MaybeCancellablePromise<void>} AwaitableWithCancel - A function that returns a promise that can be cancelled.
+ * @typedef {(runTracking: CommonRunTracking) => import('../utils/cancellablePromise.js').MaybeCancellablePromise<unknown>} AwaitableWithCancel - A function that returns a promise that can be cancelled. The return value of the promise is not used.
  */
 /**
  * @typedef {import("vue").UnwrapNestedRefs<object>|{[key: string]: import('vue').Ref<any>}} WatchGuardArguments - The reactive object to watch for changes.
@@ -56,7 +56,7 @@
  * @property {CancelFn} cancel - Cancel the cancellable intent.
  */
 /**
- * @typedef {MyCancellableIntent & Pick<import('./error.js').ErrorStatus, "clearError">} CancellableIntent - The instance of the cancellable intent.
+ * @typedef {MyCancellableIntent & import('./error.js').ErrorReadOnlyFunctions} CancellableIntent - The instance of the cancellable intent.
  */
 /**
  * Calls your awaitable function with the arguments you pass in when the watch arguments change and are all truthy.
@@ -122,7 +122,7 @@ export type RunId = number;
 /**
  * - The raw state of the cancellable intent.
  */
-export type CancellableIntentRawState = {
+export type CancellableIntentMyState = {
     /**
      * - Whether there are active intents.
      */
@@ -148,10 +148,14 @@ export type CancellableIntentRawState = {
      */
     guardArguments: import("vue").DeepReadonly<object>;
 };
+/**
+ * - The raw state of the cancellable intent.
+ */
+export type CancellableIntentRawState = CancellableIntentMyState & import("./error.js").ErrorProperties;
 /**
  * - The state of the cancellable intent.
  */
-export type CancellableIntentState = import("vue").Reactive<CancellableIntentRawState & Pick<import("./error.js").ErrorStatus, "error" | "errored">>;
+export type CancellableIntentState = import("vue").Reactive<CancellableIntentRawState>;
 /**
  * - A function that checks if the current run ID matches the last run ID.
  */
@@ -170,9 +174,9 @@ export type CommonRunTracking = {
     isCurrentRun: IsCurrentRunFn;
 };
 /**
- * - A function that returns a promise that can be cancelled.
+ * - A function that returns a promise that can be cancelled. The return value of the promise is not used.
  */
-export type AwaitableWithCancel = (runTracking: CommonRunTracking) => import("../utils/cancellablePromise.js").MaybeCancellablePromise<void>;
+export type AwaitableWithCancel = (runTracking: CommonRunTracking) => import("../utils/cancellablePromise.js").MaybeCancellablePromise<unknown>;
 /**
  * - The reactive object to watch for changes.
  */
@@ -224,4 +228,4 @@ export type MyCancellableIntent = {
 /**
  * - The instance of the cancellable intent.
  */
-export type CancellableIntent = MyCancellableIntent & Pick<import("./error.js").ErrorStatus, "clearError">;
+export type CancellableIntent = MyCancellableIntent & import("./error.js").ErrorReadOnlyFunctions;