@arrai-innovations/reactive-helpers 23.0.2 → 24.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arrai-innovations/reactive-helpers",
-  "version": "23.0.2",
+  "version": "24.0.0",
   "description": "VueJS 3 utility composition functions to help manipulate objects and lists.",
   "main": "index.js",
   "type": "module",
@@ -83,7 +83,7 @@
     "vue-deepunref": "^1.0.1"
   },
   "peerDependencies": {
-    "@vueuse/core": "^13.0.0",
+    "@vueuse/core": "^14.0.0",
     "lodash-es": "^4.17.23",
     "vue": "^3.5.13"
   },

package/types/use/listRelated.d.ts

@@ -2,7 +2,7 @@
  * @typedef {object} ListRelatedRule - The rule for defining relationships for objects in a list.
  * @property {string} [fkKey] - Specifies the foreign key on each row used to link objects across lists. Defaults to
  *  the rule's own key when omitted.
- * @property {string} [pkKey] - Deprecated alias for `fkKey`, removed in v24. The option never named a primary key.
+ * @property {string} [pkKey] - Deprecated alias for `fkKey`, removed in v25. The option never named a primary key.
  *  A rule setting both uses `fkKey`.
  * @property {string[]} [order] - Specifies the order in which related objects should be sorted, if applicable.
  * @property {import('./listInstance.js').ObjectsByPk} objects - The objects that can be related based on the foreign key.
@@ -185,7 +185,7 @@ export type ListRelatedRule = {
      */
     fkKey?: string;
     /**
-     * Deprecated alias for `fkKey`, removed in v24. The option never named a primary key.
+     * Deprecated alias for `fkKey`, removed in v25. The option never named a primary key.
      * A rule setting both uses `fkKey`.
      */
     pkKey?: string;

package/types/use/objectRelated.d.ts

@@ -131,7 +131,7 @@ export class ObjectRelatedError extends Error {
  * @typedef {object} ObjectRelatedRule - The rule for defining relationships for the managed object to other collections of objects.
  * @property {string} [fkKey] - The foreign key on the managed object that corresponds to the key in the related
  *  object. Defaults to the rule's own key when omitted.
- * @property {string} [pkKey] - Deprecated alias for `fkKey`, removed in v24. The option never named a primary key.
+ * @property {string} [pkKey] - Deprecated alias for `fkKey`, removed in v25. The option never named a primary key.
  *  A rule setting both uses `fkKey`.
  * @property {import('./listInstance.js').ObjectsByPk} objects - The related objects, indexed by the key in the related object.
  * @property {string[]} [order] - The order of the related objects, if the related objects are an array.
@@ -225,7 +225,7 @@ export type ObjectRelatedRule = {
      */
     fkKey?: string;
     /**
-     * Deprecated alias for `fkKey`, removed in v24. The option never named a primary key.
+     * Deprecated alias for `fkKey`, removed in v25. The option never named a primary key.
      * A rule setting both uses `fkKey`.
      */
     pkKey?: string;

package/use/listRelated.js

@@ -46,7 +46,7 @@ export class ListRelatedError extends Error {
  * @typedef {object} ListRelatedRule - The rule for defining relationships for objects in a list.
  * @property {string} [fkKey] - Specifies the foreign key on each row used to link objects across lists. Defaults to
  *  the rule's own key when omitted.
- * @property {string} [pkKey] - Deprecated alias for `fkKey`, removed in v24. The option never named a primary key.
+ * @property {string} [pkKey] - Deprecated alias for `fkKey`, removed in v25. The option never named a primary key.
  *  A rule setting both uses `fkKey`.
  * @property {string[]} [order] - Specifies the order in which related objects should be sorted, if applicable.
  * @property {import('./listInstance.js').ObjectsByPk} objects - The objects that can be related based on the foreign key.

package/use/objectRelated.js

@@ -47,7 +47,7 @@ export class ObjectRelatedError extends Error {
  * @typedef {object} ObjectRelatedRule - The rule for defining relationships for the managed object to other collections of objects.
  * @property {string} [fkKey] - The foreign key on the managed object that corresponds to the key in the related
  *  object. Defaults to the rule's own key when omitted.
- * @property {string} [pkKey] - Deprecated alias for `fkKey`, removed in v24. The option never named a primary key.
+ * @property {string} [pkKey] - Deprecated alias for `fkKey`, removed in v25. The option never named a primary key.
  *  A rule setting both uses `fkKey`.
  * @property {import('./listInstance.js').ObjectsByPk} objects - The related objects, indexed by the key in the related object.
  * @property {string[]} [order] - The order of the related objects, if the related objects are an array.

package/utils/relatedCalculatedHelpers.js

@@ -78,7 +78,7 @@ export function warnDeprecatedRulePkKey(composableName, ruleKey, rule, warned) {
     warned.add(ruleKey);
     const bothNames = rule.fkKey !== undefined ? ` This rule sets both, and "fkKey" is the one used.` : "";
     console.warn(
-        `[${composableName}] Rule "${ruleKey}" uses "pkKey", which is deprecated and will be removed in v24. Rename it to "fkKey", which is what the option has always meant.${bothNames}`
+        `[${composableName}] Rule "${ruleKey}" uses "pkKey", which is deprecated and will be removed in v25. Rename it to "fkKey", which is what the option has always meant.${bothNames}`
     );
 }