Merge pull request #4 from sandrohaiden/master

[fix] Making the argument optional in the entity adapter builder

Author: imanubhardwaj

README.md

@@ -1,3 +1,10 @@
+# Note
+This project is a fork of the project of [Manu Bhardwaj](https://github.com/imanubhardwaj), 
+You can access the original project [here](https://github.com/imanubhardwaj/vue-entity-adapter).
+
+
+The difference from this project to the original project, are just a few changes in the definitions for typescript and a small improvement in the ordering logic in the getAll method and in logic in addOne method.
+
 # Introduction
 
 Entity State adapter for managing record collections.
@@ -13,11 +20,7 @@ Extensible type-safe adapters for selecting entity information.
 ## Installation
 Installing with *npm*
 
-``npm i vue-entity-adapter``  
-
-Installing with *yarn*  
-
-``yarn add vue-entity-adapter``
+``npm i vue-entity-adapter-plus``
 
 ## Getting Started
 

example/package.json

@@ -11,7 +11,7 @@
     "core-js": "^2.6.5",
     "vue": "^2.6.10",
     "vue-class-component": "^7.0.2",
-    "vue-entity-adapter": "^1.0.2",
+    "vue-entity-adapter-plus": "^1.0.0",
     "vue-property-decorator": "^8.1.0",
     "vuex": "^3.0.1"
   },

example/src/models/state.model.ts

@@ -1,4 +1,4 @@
-import {EntityState} from "vue-entity-adapter";
+import {EntityState} from "vue-entity-adapter-plus";
 import {Lesson} from "@/models/lessons.model";
 
 export interface State {

example/src/store.ts

@@ -1,7 +1,7 @@
 import Vue from 'vue'
 import Vuex from 'vuex'
 import {Lesson} from "@/models/lessons.model"
-import {EntityAdapter} from 'vue-entity-adapter'
+import {EntityAdapter} from 'vue-entity-adapter-plus'
 import actions from '@/store/actions';
 import mutations from '@/store/mutations';
 import getters from '@/store/getters';

example/src/store/actions.ts

@@ -16,7 +16,7 @@ import {
 	UPDATE_LESSONS_MUTATION, UPSERT_LESSON_ACTION, UPSERT_LESSON_MUTATION, UPSERT_LESSONS_ACTION, UPSERT_LESSONS_MUTATION
 } from "@/store/types";
 import {Lesson} from "@/models/lessons.model";
-import {Update} from "vue-entity-adapter";
+import {Update} from "vue-entity-adapter-plus";
 
 export default {
 	[ADD_LESSON_ACTION]: ({commit}: any, payload: Lesson) => {

example/src/store/mutations.ts

@@ -14,7 +14,7 @@ import {
 import {State} from "@/models/state.model";
 import {Lesson} from "@/models/lessons.model";
 import {lessonsAdapter} from "@/store";
-import {Update} from "vue-entity-adapter";
+import {Update} from "vue-entity-adapter-plus";
 
 export default {
 	[ADD_LESSON_MUTATION]: (state: State, payload: Lesson) => {

index.d.ts

@@ -1,6 +1,6 @@
 /// <reference types="node" />
 
-declare module 'vue-entity-adapter' {
+declare module 'vue-entity-adapter-plus' {
 	export interface EntityState<T> {
 		ids: string[];
 		entities: T[];
@@ -18,7 +18,7 @@ declare module 'vue-entity-adapter' {
 	export type Update<T> = UpdateStr<T> | UpdateNum<T>;
 
 	export class EntityAdapter<T> {
-		constructor(sortFn: Function);
+		constructor(sortFn?: Function);
 
 		public getInitialState(): EntityState<T>;
 		public getOne(id: string, state: EntityState<T>): T;

index.js

@@ -1,4 +1,4 @@
-import { cloneDeep } from 'lodash';
+import { cloneDeep } from "lodash";
 
 /**
  * Class to manipulate entities
@@ -17,8 +17,8 @@ export class EntityAdapter {
   getInitialState() {
     return {
       ids: this.ids,
-      entities: this.entities
-    }
+      entities: this.entities,
+    };
   }
 
   /**
@@ -37,7 +37,9 @@ export class EntityAdapter {
    * @returns {(*)[]}
    */
   getAll(state) {
-    return Object.keys(state.entities).map(key => state.entities[key]).sort(this.sortFn);
+    return this.sortFn
+      ? state.ids.map((id) => (state.entities)[id]).sort(this.sortFn)
+      : state.ids.map((id) => (state.entities)[id]);
   }
 
   /**
@@ -67,7 +69,9 @@ export class EntityAdapter {
   addOne(element, state) {
     const newState = cloneDeep(state);
 
-    newState.ids.push(element.id);
+    if(!newState.ids.includes(element.id)) {
+      newState.ids.push(element.id);
+    }
     newState.entities[element.id] = element;
 
     return newState;
@@ -116,7 +120,7 @@ export class EntityAdapter {
     const newState = cloneDeep(state);
 
     delete newState.entities[id];
-    newState.ids = newState.ids.filter(_id => _id !== id);
+    newState.ids = newState.ids.filter((_id) => _id !== id);
 
     return newState;
   }
@@ -193,7 +197,7 @@ export class EntityAdapter {
     let newState = cloneDeep(state);
 
     if (element.id in newState.entities) {
-      newState = this.updateOne({id: element.id, changes: element}, newState);
+      newState = this.updateOne({ id: element.id, changes: element }, newState);
     } else {
       newState = this.addOne(element, newState);
     }

package.json

@@ -1,6 +1,6 @@
 {
-  "name": "vue-entity-adapter",
-  "version": "1.0.5",
+  "name": "vue-entity-adapter-plus",
+  "version": "1.0.1",
   "description": "Package to maintain entities for vuex.",
   "private": false,
   "keywords": ["Vue", "Vuex", "State Management", "Entity Adapter", "Flux"],
@@ -11,14 +11,14 @@
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/imanubhardwaj/vue-entity-adapter.git"
+    "url": "git+https://github.com/sandrohaiden/vue-entity-adapter-plus.git"
   },
   "author": "Manu Bhardwaj",
   "license": "MIT",
   "bugs": {
-    "url": "https://github.com/imanubhardwaj/vue-entity-adapter/issues"
+    "url": "https://github.com/sandrohaiden/vue-entity-adapter-plus/issues"
   },
-  "homepage": "https://github.com/imanubhardwaj/vue-entity-adapter#readme",
+  "homepage": "https://github.com/sandrohaiden/vue-entity-adapter-plus#readme",
   "devDependencies": {
     "@babel/core": "^7.4.0",
     "@babel/preset-env": "^7.4.2",