feathers-utils 5.2.0 → 6.0.0

package/README.md

@@ -1,10 +1,9 @@
 # feathers-utils
 
 [![npm](https://img.shields.io/npm/v/feathers-utils)](https://www.npmjs.com/package/feathers-utils)
-[![GitHub Workflow Status](https://img.shields.io/github/workflow/status/fratzinger/feathers-utils/Node.js%20CI)](https://github.com/fratzinger/feathers-utils/actions/workflows/node.js.yml?query=branch%3Amain)
+[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/fratzinger/feathers-utils/node.js.yml?branch=main)](https://github.com/fratzinger/feathers-utils/actions/workflows/node.js.yml?query=branch%3Amain)
 [![Code Climate maintainability](https://img.shields.io/codeclimate/maintainability/fratzinger/feathers-utils)](https://codeclimate.com/github/fratzinger/feathers-utils)
 [![Code Climate coverage](https://img.shields.io/codeclimate/coverage/fratzinger/feathers-utils)](https://codeclimate.com/github/fratzinger/feathers-utils)
-[![libraries.io](https://img.shields.io/librariesio/release/npm/feathers-utils)](https://libraries.io/npm/feathers-utils)
 [![npm](https://img.shields.io/npm/dm/feathers-utils)](https://www.npmjs.com/package/feathers-utils)
 [![GitHub license](https://img.shields.io/github/license/fratzinger/feathers-utils)](https://github.com/fratzinger/feathers-utils/blob/main/LICENSE.md)
 

package/dist/index.cjs

@@ -620,13 +620,18 @@ const validateQueryProperty = (query, operators = []) => {
 
 function optimizeBatchPatch(items, options) {
   const map = [];
-  const id = options?.id ?? "id";
-  for (const [id2, data] of items) {
-    const index = map.findIndex((item) => fastEquals.deepEqual(item.data, data));
+  const idKey = options?.id ?? "id";
+  for (const _data of items) {
+    const data = _data;
+    const id = _data[idKey];
+    delete data[idKey];
+    const index = map.findIndex((item) => {
+      return fastEquals.deepEqual(item.data, data);
+    });
     if (index === -1) {
-      map.push({ ids: [id2], data });
+      map.push({ ids: [id], data });
     } else {
-      map[index].ids.push(id2);
+      map[index].ids.push(id);
     }
   }
   return map.map(({ ids, data }) => {
@@ -635,7 +640,7 @@ function optimizeBatchPatch(items, options) {
       data,
       {
         query: {
-          [id]: { $in: ids }
+          [idKey]: { $in: ids }
         }
       }
     ];

package/dist/index.d.cts

@@ -14,6 +14,7 @@ type MaybeArray<T> = T | T[];
 type Promisable<T> = T | Promise<T>;
 type Path = Array<string | number>;
 type ReturnAsyncHook<H extends HookContext$1 = HookContext$1> = (context: H) => Promise<H>;
+type KeyOf<T> = Extract<keyof T, string>;
 
 interface CreateRelatedOptions<S = Record<string, any>> {
     service: keyof S;
@@ -253,11 +254,12 @@ declare const toJSON: (context: HookContext) => HookContext<_feathersjs_feathers
  */
 declare const validateQueryProperty: (query: any, operators?: string[]) => Query;
 
-type OptimizeBatchPatchOptions = {
-    id?: string;
+type OptimizeBatchPatchOptions<IdKey extends string> = {
+    /** the key of the id property */
+    id?: IdKey;
 };
 type OptimizeBatchPatchResultItem<T = Record<string, unknown>, P = Params> = [Id, T, P | undefined];
-declare function optimizeBatchPatch<T extends Record<string, unknown>, P extends Params>(items: Map<Id, T>, options?: OptimizeBatchPatchOptions): OptimizeBatchPatchResultItem<T, P>[];
+declare function optimizeBatchPatch<T extends Record<string, any>, IdKey extends KeyOf<T>, P extends Params, R extends Omit<T, IdKey> = Omit<T, IdKey>>(items: T[], options?: OptimizeBatchPatchOptions<IdKey>): OptimizeBatchPatchResultItem<R, P>[];
 
 declare function flattenQuery(q: Query): any;
 

package/dist/index.d.mts

@@ -14,6 +14,7 @@ type MaybeArray<T> = T | T[];
 type Promisable<T> = T | Promise<T>;
 type Path = Array<string | number>;
 type ReturnAsyncHook<H extends HookContext$1 = HookContext$1> = (context: H) => Promise<H>;
+type KeyOf<T> = Extract<keyof T, string>;
 
 interface CreateRelatedOptions<S = Record<string, any>> {
     service: keyof S;
@@ -253,11 +254,12 @@ declare const toJSON: (context: HookContext) => HookContext<_feathersjs_feathers
  */
 declare const validateQueryProperty: (query: any, operators?: string[]) => Query;
 
-type OptimizeBatchPatchOptions = {
-    id?: string;
+type OptimizeBatchPatchOptions<IdKey extends string> = {
+    /** the key of the id property */
+    id?: IdKey;
 };
 type OptimizeBatchPatchResultItem<T = Record<string, unknown>, P = Params> = [Id, T, P | undefined];
-declare function optimizeBatchPatch<T extends Record<string, unknown>, P extends Params>(items: Map<Id, T>, options?: OptimizeBatchPatchOptions): OptimizeBatchPatchResultItem<T, P>[];
+declare function optimizeBatchPatch<T extends Record<string, any>, IdKey extends KeyOf<T>, P extends Params, R extends Omit<T, IdKey> = Omit<T, IdKey>>(items: T[], options?: OptimizeBatchPatchOptions<IdKey>): OptimizeBatchPatchResultItem<R, P>[];
 
 declare function flattenQuery(q: Query): any;
 

package/dist/index.d.ts

@@ -14,6 +14,7 @@ type MaybeArray<T> = T | T[];
 type Promisable<T> = T | Promise<T>;
 type Path = Array<string | number>;
 type ReturnAsyncHook<H extends HookContext$1 = HookContext$1> = (context: H) => Promise<H>;
+type KeyOf<T> = Extract<keyof T, string>;
 
 interface CreateRelatedOptions<S = Record<string, any>> {
     service: keyof S;
@@ -253,11 +254,12 @@ declare const toJSON: (context: HookContext) => HookContext<_feathersjs_feathers
  */
 declare const validateQueryProperty: (query: any, operators?: string[]) => Query;
 
-type OptimizeBatchPatchOptions = {
-    id?: string;
+type OptimizeBatchPatchOptions<IdKey extends string> = {
+    /** the key of the id property */
+    id?: IdKey;
 };
 type OptimizeBatchPatchResultItem<T = Record<string, unknown>, P = Params> = [Id, T, P | undefined];
-declare function optimizeBatchPatch<T extends Record<string, unknown>, P extends Params>(items: Map<Id, T>, options?: OptimizeBatchPatchOptions): OptimizeBatchPatchResultItem<T, P>[];
+declare function optimizeBatchPatch<T extends Record<string, any>, IdKey extends KeyOf<T>, P extends Params, R extends Omit<T, IdKey> = Omit<T, IdKey>>(items: T[], options?: OptimizeBatchPatchOptions<IdKey>): OptimizeBatchPatchResultItem<R, P>[];
 
 declare function flattenQuery(q: Query): any;
 

package/dist/index.mjs

@@ -609,13 +609,18 @@ const validateQueryProperty = (query, operators = []) => {
 
 function optimizeBatchPatch(items, options) {
   const map = [];
-  const id = options?.id ?? "id";
-  for (const [id2, data] of items) {
-    const index = map.findIndex((item) => deepEqual(item.data, data));
+  const idKey = options?.id ?? "id";
+  for (const _data of items) {
+    const data = _data;
+    const id = _data[idKey];
+    delete data[idKey];
+    const index = map.findIndex((item) => {
+      return deepEqual(item.data, data);
+    });
     if (index === -1) {
-      map.push({ ids: [id2], data });
+      map.push({ ids: [id], data });
     } else {
-      map[index].ids.push(id2);
+      map[index].ids.push(id);
     }
   }
   return map.map(({ ids, data }) => {
@@ -624,7 +629,7 @@ function optimizeBatchPatch(items, options) {
       data,
       {
         query: {
-          [id]: { $in: ids }
+          [idKey]: { $in: ids }
         }
       }
     ];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "feathers-utils",
-  "version": "5.2.0",
+  "version": "6.0.0",
   "description": "Some utils for projects using '@feathersjs/feathers'",
   "author": "fratzinger",
   "repository": {

package/src/typesInternal.ts

@@ -22,3 +22,5 @@ export type ReturnSyncHook<H extends HookContext = HookContext> = (
 export type ReturnAsyncHook<H extends HookContext = HookContext> = (
   context: H,
 ) => Promise<H>;
+
+export type KeyOf<T> = Extract<keyof T, string>;

package/src/utils/optimizeBatchPatch.ts

@@ -1,8 +1,10 @@
 import type { Id, Params } from "@feathersjs/feathers";
 import { deepEqual } from "fast-equals";
+import type { KeyOf } from "../typesInternal";
 
-export type OptimizeBatchPatchOptions = {
-  id?: string;
+export type OptimizeBatchPatchOptions<IdKey extends string> = {
+  /** the key of the id property */
+  id?: IdKey;
 };
 
 export type OptimizeBatchPatchResultItem<
@@ -11,18 +13,26 @@ export type OptimizeBatchPatchResultItem<
 > = [Id, T, P | undefined];
 
 export function optimizeBatchPatch<
-  T extends Record<string, unknown>,
+  T extends Record<string, any>,
+  IdKey extends KeyOf<T>,
   P extends Params,
+  R extends Omit<T, IdKey> = Omit<T, IdKey>,
 >(
-  items: Map<Id, T>,
-  options?: OptimizeBatchPatchOptions,
-): OptimizeBatchPatchResultItem<T, P>[] {
-  const map: { ids: Id[]; data: T }[] = [];
+  items: T[],
+  options?: OptimizeBatchPatchOptions<IdKey>,
+): OptimizeBatchPatchResultItem<R, P>[] {
+  const map: { ids: Id[]; data: R }[] = [];
 
-  const id = options?.id ?? "id";
+  const idKey = options?.id ?? "id";
 
-  for (const [id, data] of items) {
-    const index = map.findIndex((item) => deepEqual(item.data, data));
+  for (const _data of items) {
+    const data = _data as unknown as R;
+    const id = _data[idKey];
+    delete data[idKey as any];
+
+    const index = map.findIndex((item) => {
+      return deepEqual(item.data, data);
+    });
 
     if (index === -1) {
       map.push({ ids: [id], data });
@@ -33,34 +43,56 @@ export function optimizeBatchPatch<
 
   return map.map(({ ids, data }) => {
     return ids.length === 1
-      ? ([ids[0], data, undefined] as OptimizeBatchPatchResultItem<T, P>)
+      ? ([ids[0], data, undefined] as OptimizeBatchPatchResultItem<R, P>)
       : ([
           null,
           data,
           {
             query: {
-              [id]: { $in: ids },
+              [idKey]: { $in: ids },
             },
           },
-        ] as OptimizeBatchPatchResultItem<T, P>);
+        ] as OptimizeBatchPatchResultItem<R, P>);
   });
 }
 
 if (import.meta.vitest) {
   const { it, expect } = import.meta.vitest;
   it("optimizeBatchPatch", () => {
-    const items = new Map<Id, Record<string, unknown>>([
-      ["1", { name: "John" }],
-      ["2", { name: "Jane" }],
-      ["3", { name: "John" }],
-      ["4", { name: "Jane" }],
-      [5, { name: "Jack" }],
-    ]);
-
-    expect(optimizeBatchPatch(items)).toEqual([
+    expect(
+      optimizeBatchPatch(
+        [
+          { id: "1", name: "John" },
+          { id: "2", name: "Jane" },
+          { id: "3", name: "John" },
+          { id: "4", name: "Jane" },
+          { id: 5, name: "Jack" },
+        ],
+        { id: "id" },
+      ),
+    ).toEqual([
       [null, { name: "John" }, { query: { id: { $in: ["1", "3"] } } }],
       [null, { name: "Jane" }, { query: { id: { $in: ["2", "4"] } } }],
       [5, { name: "Jack" }, undefined],
     ]);
   });
+
+  it("optimizeBatchPatch with _id", () => {
+    expect(
+      optimizeBatchPatch(
+        [
+          { _id: "1", name: "John" },
+          { _id: "2", name: "Jane" },
+          { _id: "3", name: "John" },
+          { _id: "4", name: "Jane" },
+          { _id: 5, name: "Jack" },
+        ],
+        { id: "_id" },
+      ),
+    ).toEqual([
+      [null, { name: "John" }, { query: { _id: { $in: ["1", "3"] } } }],
+      [null, { name: "Jane" }, { query: { _id: { $in: ["2", "4"] } } }],
+      [5, { name: "Jack" }, undefined],
+    ]);
+  });
 }