@arrai-innovations/reactive-helpers 21.1.0 → 22.0.0

package/package.json

@@ -1,91 +1,95 @@
 {
-    "name": "@arrai-innovations/reactive-helpers",
-    "version": "21.1.0",
-    "description": "VueJS 3 utility composition functions to help manipulate objects and lists.",
-    "main": "index.js",
-    "type": "module",
-    "types": "types/index.d.ts",
-    "exports": {
-        ".": {
-            "import": "./index.js",
-            "types": "./types/index.d.ts"
-        }
-    },
-    "files": [
-        "index.js",
-        "README.md",
-        "use/",
-        "utils/",
-        "config/",
-        "types/"
-    ],
-    "directories": {
-        "use": "use",
-        "utils": "utils",
-        "tests": "tests"
-    },
-    "scripts": {
-        "test": "npx --no-install vitest",
-        "eslint": "npx --no-install eslint --fix index.js config/**/*.js tests/**/*.js use/**/*.js utils/**/*.js",
-        "prettier": "npx --no-install prettier --write .",
-        "coverage": "npm test -- run --coverage=true",
-        "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",
-        "types": "node make_types.js",
-        "types:check": "node check_types.js"
-    },
-    "repository": {
-        "type": "git",
-        "url": "git+https://github.com/arrai-innovations/reactive-helpers.git"
-    },
-    "author": "Arrai Innovations Inc. <developers@arrai.com>",
-    "license": "UNLICENSED",
-    "bugs": {
-        "url": "https://github.com/arrai-innovations/reactive-helpers/issues"
-    },
-    "homepage": "https://github.com/arrai-innovations/reactive-helpers#readme",
-    "devDependencies": {
-        "@arrai-innovations/commitlint-config": "^2.0.0",
-        "@commitlint/cli": "^19.4.0",
-        "@godaddy/dmd": "^1.0.4",
-        "@trivago/prettier-plugin-sort-imports": "^5.2.1",
-        "@types/browser-util-inspect": "^0.2.4",
-        "@types/lodash-es": "^4.17.12",
-        "@typescript-eslint/eslint-plugin": "^7.18.0",
-        "@typescript-eslint/parser": "^7.18.0",
-        "@vitest/coverage-istanbul": "^3.1.4",
-        "@vitest/coverage-v8": "^3.1.4",
-        "@vue/compiler-sfc": "^3.4.37",
-        "@vue/eslint-config-prettier": "^9.0.0",
-        "@vue/test-utils": "^2.3.2",
-        "doctoc": "^2.1.0",
-        "eslint": "^8.56.0",
-        "eslint-plugin-jsdoc": "^48.11.0",
-        "eslint-plugin-vitest": "~0.5.4",
-        "eslint-plugin-vitest-globals": "^1.3.1",
-        "eslint-plugin-vue": "^9.27.0",
-        "flush-promises": "^1.0.2",
-        "globals": "^16.0.0",
-        "husky": "^9.1.7",
-        "jsdom": "^26.0.0",
-        "lint-staged": "^15.2.8",
-        "prettier": "^3.3.3",
-        "typedoc": "^0.28.15",
-        "typedoc-plugin-markdown": "^4.9.0",
-        "typescript": "^5.5.4",
-        "vitest": "^3.1.2"
-    },
-    "dependencies": {
-        "@jcoreio/async-throttle": "^1.6.0",
-        "browser-util-inspect": "^0.2.0",
-        "flexsearch": "0.7.21",
-        "vue-deepunref": "^1.0.1"
-    },
-    "peerDependencies": {
-        "@vueuse/core": "^13.0.0",
-        "lodash-es": "^4.17.21",
-        "vue": "^3.5.13"
+  "name": "@arrai-innovations/reactive-helpers",
+  "version": "22.0.0",
+  "description": "VueJS 3 utility composition functions to help manipulate objects and lists.",
+  "main": "index.js",
+  "type": "module",
+  "types": "types/index.d.ts",
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/",
+    "access": "public"
+  },
+  "exports": {
+    ".": {
+      "import": "./index.js",
+      "types": "./types/index.d.ts"
     }
-}
+  },
+  "files": [
+    "index.js",
+    "README.md",
+    "use/",
+    "utils/",
+    "config/",
+    "types/"
+  ],
+  "directories": {
+    "use": "use",
+    "utils": "utils",
+    "tests": "tests"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/arrai-innovations/reactive-helpers.git"
+  },
+  "author": "Arrai Innovations Inc. <developers@arrai.com>",
+  "license": "BSD-3-Clause",
+  "bugs": {
+    "url": "https://github.com/arrai-innovations/reactive-helpers/issues"
+  },
+  "homepage": "https://github.com/arrai-innovations/reactive-helpers#readme",
+  "devDependencies": {
+    "@arrai-innovations/commitlint-config": "^2.1.0",
+    "@commitlint/cli": "^19.8.1",
+    "@eslint/js": "9.39.4",
+    "@godaddy/dmd": "^1.0.4",
+    "@trivago/prettier-plugin-sort-imports": "^5.2.2",
+    "@types/browser-util-inspect": "^0.2.4",
+    "@types/lodash-es": "^4.17.12",
+    "@vitest/coverage-istanbul": "^4.1.9",
+    "@vitest/coverage-v8": "^4.1.9",
+    "@vitest/eslint-plugin": "^1.6.20",
+    "@vue/compiler-sfc": "^3.5.38",
+    "@vue/eslint-config-prettier": "^10.2.0",
+    "@vue/test-utils": "^2.4.11",
+    "doctoc": "^2.5.0",
+    "eslint": "^9.39.4",
+    "eslint-config-prettier": "^10.1.8",
+    "eslint-plugin-jsdoc": "^63.0.6",
+    "eslint-plugin-no-autofix": "^2.1.0",
+    "eslint-plugin-vue": "^10.9.2",
+    "flush-promises": "^1.0.2",
+    "globals": "^16.5.0",
+    "jsdom": "^26.1.0",
+    "lefthook": "^1.13.6",
+    "prettier": "^3.8.4",
+    "typedoc": "^0.28.19",
+    "typedoc-plugin-markdown": "^4.12.0",
+    "typescript": "^5.9.3",
+    "vite": "^8.0.16",
+    "vitest": "^4.1.9",
+    "vue-eslint-parser": "^10.4.1"
+  },
+  "dependencies": {
+    "@jcoreio/async-throttle": "^1.7.0",
+    "browser-util-inspect": "^0.2.0",
+    "flexsearch": "0.7.21",
+    "vue-deepunref": "^1.0.1"
+  },
+  "peerDependencies": {
+    "@vueuse/core": "^13.0.0",
+    "lodash-es": "^4.17.23",
+    "vue": "^3.5.13"
+  },
+  "scripts": {
+    "test": "vitest",
+    "eslint": "eslint --fix index.js config/**/*.js tests/**/*.js use/**/*.js utils/**/*.js",
+    "prettier": "prettier --write .",
+    "coverage": "vitest run --coverage=true",
+    "docs": "node make_type_doc.js",
+    "docs:check": "node check_type_doc.js",
+    "docs:clean": "node clean_type_doc.js",
+    "types": "node make_types.js",
+    "types:check": "node check_types.js"
+  }
+}

package/types/config/listCrud.d.ts

@@ -9,8 +9,17 @@ export function getListCrud(target: import("vue").UnwrapNestedRefs<ListCrudHandl
     props?: import("vue").UnwrapNestedRefs<ListTargetOption>;
     handlers?: ListCrudHandlers;
 }): void;
+/**
+ * Signature for the handler that clears the objects held by the list.
+ */
 export type ClearObjectsFn = import("../use/listInstance.js").ClearListFn;
+/**
+ * Signature for the handler that updates the list's pagination information.
+ */
 export type SetPaginateInfo = import("../use/listInstance.js").SetPaginateInfoFn;
+/**
+ * Signature for the handler that updates the list's column totals.
+ */
 export type SetColumnTotals = import("../use/listInstance.js").SetColumnTotalsFn;
 /**
  * Additional arguments that can be passed to list crud handlers.
@@ -18,132 +27,180 @@ export type SetColumnTotals = import("../use/listInstance.js").SetColumnTotalsFn
 export type AdditionalListArgs = {
     [key: string]: any;
 };
+/**
+ * Raw arguments for a list operation before run-tracking and additional list CRUD arguments are merged in.
+ */
 export type ListArgsRaw = {
     /**
-     * - The arguments to be passed to the crud handlers.
+     * The arguments to be passed to the crud handlers.
      */
     target: import("../config/objectCrud.js").TargetArgs;
     /**
-     * - The key name of the primary key.
+     * The key name of the primary key.
      */
     pkKey: string;
     /**
-     * - The arguments to be passed for list crud handlers.
+     * The arguments to be passed for list crud handlers.
      */
     params: object;
     /**
-     * - The method to call with new page(s) of data received.
+     * The method to call with new page(s) of data received.
      */
     pushObjects: import("../use/listInstance.js").PushObjectsFn;
     /**
-     * - The method to call to clear the objects.
+     * The method to call to clear the objects.
      */
     clearObjects: ClearObjectsFn;
     /**
-     * - A ref to a boolean indicating whether the request has
+     * A ref to a boolean indicating whether the request has
      * been cancelled.
      */
     isCancelled: Readonly<import("vue").Ref<boolean>>;
     /**
-     * - The method to update pagination information.
+     * The method to update pagination information.
      */
     setPaginateInfo: SetPaginateInfo;
     /**
-     * - The method to update column totals.
+     * The method to update column totals.
      */
     setColumnTotals: SetColumnTotals;
 };
+/**
+ * Arguments for a list operation, combining the raw arguments with run-tracking and any additional list CRUD arguments.
+ */
 export type ListArgs = ListArgsRaw & Partial<import("../use/cancellableIntent.js").CommonRunTracking> & AdditionalListArgs;
+/**
+ * Raw arguments for a bulk-delete operation before additional list CRUD arguments are merged in.
+ */
 export type BulkDeleteArgsRaw = {
     /**
-     * - The arguments to be passed to the crud handlers.
+     * The arguments to be passed to the crud handlers.
      */
     target: import("../config/objectCrud.js").TargetArgs;
     /**
-     * - The ids of the objects to be deleted.
+     * The ids of the objects to be deleted.
      */
     pks: import("./commonCrud.js").Pk[];
     /**
-     * - The key name of the primary key.
+     * The key name of the primary key.
      */
     pkKey: string;
 };
+/**
+ * Arguments for a bulk-delete operation, combining the raw arguments with any additional list CRUD arguments.
+ */
 export type BulkDeleteArgs = BulkDeleteArgsRaw & AdditionalListArgs;
+/**
+ * Callback that applies a created, updated, or deleted object event received from a subscription to the list.
+ */
 export type applyObjectEvent = (newOrUpdatedOrDeleteObject: import("../use/objectInstance.js").ExistingCrudObject | string, action: "create" | "update" | "delete") => void;
+/**
+ * Raw arguments for a list subscribe operation before run-tracking and additional list CRUD arguments are merged in.
+ */
 export type ListSubscribeArgsRaw = {
     /**
-     * - The arguments to be passed to the crud handlers.
+     * The arguments to be passed to the crud handlers.
      */
     target: import("../config/objectCrud.js").TargetArgs;
     /**
-     * - The key name of the primary key.
+     * The key name of the primary key.
      */
     pkKey: string;
     /**
-     * - The arguments to be passed for list crud handlers.
+     * The arguments to be passed for list crud handlers.
      */
     params: object;
     /**
-     * - The method to call when new data is received.
+     * The method to call when new data is received.
      */
     applyObjectEvent: applyObjectEvent;
     /**
-     * - A ref to a boolean indicating whether the request has
+     * A ref to a boolean indicating whether the request has
      * been cancelled.
      */
     isCancelled: Readonly<import("vue").Ref<boolean>>;
 };
+/**
+ * Arguments for a list subscribe operation, combining the raw arguments with run-tracking and any additional list CRUD arguments.
+ */
 export type ListSubscribeArgs = ListSubscribeArgsRaw & Partial<import("../use/cancellableIntent.js").CommonRunTracking> & AdditionalListArgs;
+/**
+ * Raw arguments for a list execute-action operation before additional list CRUD arguments are merged in.
+ */
 export type ExecuteActionArgsRaw = {
     /**
-     * - The arguments to be passed to the crud handlers.
+     * The arguments to be passed to the crud handlers.
      */
     target: import("../config/objectCrud.js").TargetArgs;
     /**
-     * - The ids of the objects to be acted upon.
+     * The ids of the objects to be acted upon.
      */
     pks: import("./commonCrud.js").Pk[];
     /**
-     * - The key name of the primary key.
+     * The key name of the primary key.
      */
     pkKey: string;
     /**
-     * - The action to execute.
+     * The action to execute.
      */
     action: string;
 };
+/**
+ * Arguments for a list execute-action operation, combining the raw arguments with any additional list CRUD arguments.
+ */
 export type ExecuteActionArgs = ExecuteActionArgsRaw & AdditionalListArgs;
+/**
+ * Signature for the handler that lists objects from the backing store.
+ */
 export type CrudListFn = (args: ListArgs) => import("../utils/cancellablePromise.js").MaybeCancellablePromise<void>;
+/**
+ * Signature for the handler that bulk-deletes objects from the backing store.
+ */
 export type CrudBulkDeleteFn = (args: BulkDeleteArgs) => Promise<boolean>;
+/**
+ * Signature for the handler that subscribes to list changes in the backing store.
+ */
 export type CrudListSubscribeFn = (args: ListSubscribeArgs) => import("../utils/cancellablePromise.js").CancellablePromise<void>;
+/**
+ * Signature for the handler that executes an action on a list of objects in the backing store.
+ */
 export type CrudExecuteActionFn = (args: ExecuteActionArgs) => Promise<object | string | null>;
+/**
+ * The set of optional CRUD handler functions (list, bulkDelete, executeAction, subscribe) for a list.
+ */
 export type ListCrudHandlers = {
     /**
-     * - The list function to get a list of items.
+     * The list function to get a list of items.
      */
     list?: CrudListFn;
     /**
-     * - The delete function to bulk delete a list of items.
+     * The delete function to bulk delete a list of items.
      */
     bulkDelete?: CrudBulkDeleteFn;
     /**
-     * - The  function to execute a certain action on a list of items.
+     * The  function to execute a certain action on a list of items.
      */
     executeAction?: CrudExecuteActionFn;
     /**
-     * - The subscribe function to get a subscription to a list of items.
+     * The subscribe function to get a subscription to a list of items.
      */
     subscribe?: CrudListSubscribeFn;
 };
+/**
+ * The default target arguments passed through to the list CRUD handlers.
+ */
 export type ListTarget = {
     /**
-     * - The default arguments for the crud handlers.
+     * The default arguments for the crud handlers.
      */
     args: object;
 };
+/**
+ * Optional target arguments passed through to the list CRUD handlers.
+ */
 export type ListTargetOption = {
     /**
-     * - The default arguments for the crud handlers.
+     * The default arguments for the crud handlers.
      */
     target?: object;
 };