feat: Add Collection.remove (#3560)

Author: ntucker

.changeset/pink-waves-judge.md

@@ -0,0 +1,17 @@
+---
+'@data-client/endpoint': patch
+'@data-client/graphql': patch
+'@data-client/rest': patch
+---
+
+Add Collection.remove
+
+```ts
+ctrl.set(MyResource.getList.schema.remove, { id });
+```
+
+```ts
+const removeItem = MyResource.delete.extend({
+  schema: MyResource.getList.schema.remove
+})
+```

docs/rest/api/Collection.md

@@ -430,6 +430,20 @@ A creation schema that places at the _end_ of this collection
 
 A creation schema that places at the _start_ of this collection
 
+### remove
+
+Remove item[s] from a collection by value.
+
+```ts
+ctrl.set(MyResource.getList.schema.remove, { id });
+```
+
+```ts
+const removeItem = MyResource.delete.extend({
+  schema: MyResource.getList.schema.remove
+})
+```
+
 ### assign
 
 A creation schema that [assigns](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/assign)

packages/endpoint/src/schemaTypes.ts

@@ -153,6 +153,11 @@ export interface CollectionInterface<
    */
   unshift: CollectionArrayAdder<S>;
 
+  /** Schema to remove (by value) from a Collection
+   * @see https://dataclient.io/rest/api/Collection#remove
+   */
+  remove: CollectionArrayAdder<S>;
+
   /** Schema to merge with a Values Collection
    * @see https://dataclient.io/rest/api/Collection#assign
    */

packages/endpoint/src/schemas/Collection.ts

@@ -19,6 +19,10 @@ const unshiftMerge = (existing: any, incoming: any) => {
 const valuesMerge = (existing: any, incoming: any) => {
   return { ...existing, ...incoming };
 };
+const removeMerge = (existing: Array<any>, incoming: any) => {
+  return existing.filter((item: any) => !incoming.includes(item));
+};
+
 const createArray = (value: any) => [...value];
 const createValue = (value: any) => ({ ...value });
 
@@ -49,6 +53,9 @@ export default class CollectionSchema<
   declare assign: S extends ValuesType<any> ? CollectionSchema<S, Args, Parent>
   : undefined;
 
+  declare remove: S extends ArrayType<any> ? CollectionSchema<S, Args, Parent>
+  : undefined;
+
   addWith<P extends any[] = Args>(
     merge: (existing: any, incoming: any) => any,
     createCollectionFilter?: (
@@ -118,6 +125,7 @@ export default class CollectionSchema<
       this.createIfValid = createArray;
       this.push = CreateAdder(this, pushMerge);
       this.unshift = CreateAdder(this, unshiftMerge);
+      this.remove = CreateAdder(this, removeMerge);
     } else if (schema instanceof Values) {
       this.createIfValid = createValue;
       this.assign = CreateAdder(this, valuesMerge);