Change ManyLink to Collection

Author: markusjwetzel

src/Collection.js

@@ -0,0 +1,99 @@
+import Link from './Link';
+import { TYPENAME } from './constants';
+
+const transformEntitiesToLinks = (value) => {
+  // eslint-disable-next-line no-use-before-define
+  if (value instanceof Collection || value instanceof Link) {
+    return value;
+  }
+
+  if (Array.isArray(value)) {
+    // eslint-disable-next-line no-use-before-define
+    return new Collection(value);
+  }
+
+  if (value === null || typeof value !== 'object') {
+    return value;
+  }
+
+  if (TYPENAME in value) {
+    return new Link(value);
+  }
+
+  const item = {};
+
+  Object.entries(value).forEach(([k, v]) => {
+    item[k] = transformEntitiesToLinks(v);
+  });
+
+  return item;
+};
+
+const convertToLinks = (values) => {
+  const items = Array.isArray(values) ? values : [values];
+
+  return items.map(transformEntitiesToLinks);
+};
+
+const removeDuplicateLinks = (currentRefs, items) =>
+  currentRefs.filter((refLink) => !items.some((link) => refLink.equals(link)));
+
+export default class Collection {
+  items;
+
+  constructor(values = []) {
+    this.items = convertToLinks(values);
+  }
+
+  static fromNative(items) {
+    const instance = new Collection();
+    instance.items = items;
+
+    return instance;
+  }
+
+  prepend(values) {
+    this.items = [...convertToLinks(values), ...this.items];
+
+    return this;
+  }
+
+  append(values) {
+    this.items = [...this.items, ...convertToLinks(values)];
+
+    return this;
+  }
+
+  syncPrepend(values) {
+    const items = convertToLinks(values);
+    const filteredLinks = removeDuplicateLinks(this.items, items);
+
+    this.items = [...items, ...filteredLinks];
+
+    return this;
+  }
+
+  syncAppend(values) {
+    const items = convertToLinks(values);
+    const filteredLinks = removeDuplicateLinks(this.items, items);
+
+    this.items = [...filteredLinks, ...items];
+
+    return this;
+  }
+
+  detach(values) {
+    const items = convertToLinks(values);
+    this.items = removeDuplicateLinks(this.items, items);
+
+    return this;
+  }
+
+  all() {
+    return this.items;
+  }
+
+  toNative() {
+    return this.all();
+  }
+}

src/Link.js

@@ -18,6 +18,10 @@ export default class Link {
     return instance;
   }
 
+  equals(link) {
+    return this.ref[0] === link.ref[0] && this.ref[1] === link.ref[1];
+  }
+
   toNative() {
     return this.ref;
   }

src/ManyLink.js

@@ -3,10 +3,10 @@ import createNode from './container/createNode';
 import GraphQLError from './errors/GraphQLError';
 import HttpError from './errors/HttpError';
 import Resource from './resources/Resource';
+import Collection from './Collection';
 import createHttpClient from './createHttpClient';
 import key from './key';
 import Link from './Link';
-import ManyLink from './ManyLink';
 import ref from './ref';
 import Transporter from './Transporter';
 import TransporterProvider from './TransporterProvider';
@@ -21,10 +21,10 @@ export {
   GraphQLError,
   HttpError,
   Resource,
+  Collection,
   createHttpClient,
   key,
   Link,
-  ManyLink,
   ref,
   Transporter,
   TransporterProvider,

src/index.js

@@ -1,63 +1,71 @@
 import Link from '../Link';
-import ManyLink from '../ManyLink';
-import { REF_KEY } from '../constants';
+import Collection from '../Collection';
+import { REF_KEY, TYPENAME } from '../constants';
+
+// Native format:
+// - Only uses arrays and { ref: [typename, id] } refs
+//
+// User (non-native) format:
+// - Uses Collection instances instead of arrays
+// - Uses Link instances instead of { ref: [typename, id] } refs
+// - Also allows { __typename, id, ... } objects as refs
 
 const isDate = (v) => Object.prototype.toString.call(v) === '[object Date]';
 
 export default class ValueCaster {
   static fromNative(value) {
     if (Array.isArray(value)) {
-      return value.map((v) => ValueCaster.fromNative(v));
+      return Collection.fromNative(value.map((v) => ValueCaster.fromNative(v)));
     }
 
-    if (typeof value === 'object') {
-      if (REF_KEY in value) {
-        const ref = value[REF_KEY];
-
-        if (ref.length === 2 && !Array.isArray(ref[0])) {
-          return Link.fromNative(ref);
-        }
-
-        return ManyLink.fromNative(ref);
-      }
+    if (value === null || typeof value !== 'object') {
+      return value;
+    }
 
-      const result = {};
+    if (REF_KEY in value) {
+      return Link.fromNative(value[REF_KEY]);
+    }
 
-      Object.entries(value).forEach(([k, v]) => {
-        result[k] = ValueCaster.fromNative(v);
-      });
+    const item = {};
 
-      return result;
-    }
+    Object.entries(value).forEach(([k, v]) => {
+      item[k] = ValueCaster.fromNative(v);
+    });
 
-    return value;
+    return item;
   }
 
   static toNative(value) {
-    if (value instanceof Link || value instanceof ManyLink) {
-      return {
-        [REF_KEY]: value.toNative(),
-      };
-    }
-
     if (isDate(value)) {
       return value.toISOString();
     }
 
+    if (value instanceof Collection) {
+      return value.toNative().map((v) => ValueCaster.toNative(v));
+    }
+
     if (Array.isArray(value)) {
       return value.map((v) => ValueCaster.toNative(v));
     }
 
-    if (value && typeof value === 'object') {
-      const result = {};
+    if (value === null || typeof value !== 'object') {
+      return value;
+    }
 
-      Object.entries(value).forEach(([k, v]) => {
-        result[k] = ValueCaster.toNative(v);
-      });
+    if (value instanceof Link) {
+      return { [REF_KEY]: value.toNative() };
+    }
 
-      return result;
+    if (TYPENAME in value) {
+      return { [REF_KEY]: new Link(value).toNative() };
     }
 
-    return value;
+    const item = {};
+
+    Object.entries(value).forEach(([k, v]) => {
+      item[k] = ValueCaster.toNative(v);
+    });
+
+    return item;
   }
 }

src/network/ValueCaster.js

@@ -164,21 +164,12 @@ const handleValue = (selectionSet, value, context, path) => {
     return handleSelectionSet(selectionSet, value, context, path);
   }
 
-  const ref = value[REF_KEY];
   const { handleLink } = context;
 
   // TODO: Apply connections
-  // const entity = handleConnection(ref ? data.get(...ref) : value);
+  // const entity = handleConnection(value[REF_KEY] ? data.get(...value[REF_KEY]) : value);
 
-  if (ref.length === 2 && !Array.isArray(ref[0])) {
-    return handleLink(handleRef(selectionSet, ref, context, path));
-  }
-
-  return handleLink(
-    ref.map((refItem, refKey) =>
-      handleRef(selectionSet, refItem, context, [...path, refKey]),
-    ),
-  );
+  return handleLink(handleRef(selectionSet, value[REF_KEY], context, path));
 };
 
 export default function traverseAST(