Minor changes before v1.0.0 can include breaking changes.

0.16.2

Fix upsert when virtual fields have not been passed during creation: Don't attempt to delete from non-existing index. (#543)
Fix failing deletion of many-to-many fields with custom accessor names. (#552)
Update Babel-related dependencies. (#544)

0.16.1

Fixed map selectors being stored under the same key. (ad9d0c7)
Prevent map selectors from returning unrelated refs. (27bddb6)

0.16.0

Removed unnecessary branches (#316)
Optimized objectShallowEquals using every instead of forEach (#317)

This release should not be breaking. It is a new minor version only to safeguard from potential edge cases.

0.15.1

Fix memoization for map selectors. (#318)

Consider the selector createSelector(orm.Book.authors.map(orm.Author.name)). When the list of a book's authors didn't change but one of the authors' names changed, the selector would still return the old name.

0.15.0

Serializing the database using JSON.stringify is now officially supported and tested. This allows using redux-persist without any special configuration again. We no longer use a symbol to detect state objects, so you may need to add a migration to make this work with older persisted states. (#321)
Fixed 'desc' values for ordering query sets. (#311)
Fixed a bug with field selectors for self-referencing fields not being able to infer the model that the fields point to. (#315)

0.14.1

Use Symbol.for to create symbols in the global symbol registry. (#290)

Allows you to use Redux-ORM across JavaScript contexts again.

0.14.0

Much easier selectors for common use-cases. (#257)
Specify related models using Model classes instead of strings. (#266)
Pass custom accessor names for many-to-many fields to be able to access initially passed data. (#279)

0.13.3

Prevent caching selectors if individual records accessed via index have changed. (#255, 02edce9)
Also filter by non-PK attributes when user specifies a PK in filter object. (69a87f8)
Replace usage of lodash/mapValues by ES8 Object.entries.reduce.

0.13.2

Optimized full bundles using babel-plugin-lodash and lodash-webpack-plugin:

dist/redux-orm.min.js decreased from 67.7 kB to 48.5 kB.
Gzipped size decreased from 18.5 kB to 13.1 kB.

0.13.1

Don't filter needlessly after applying foreign key indexes. Prevents applying object-based filters again after already fully satisfying their conditions using indexes. (41ece84)
Remove attributes already looked up via index from filter clauses. After applying indexes, if additional filtering needs to occur, strip away the indexed columns from the filter object. (278ff6f)

Removed tests, coverage reports and other unneeded files from NPM package builds. This decreased our NPM package size to around 700 kB.

0.13.0

Automatically index foreign keys. Queries will be fulfilled by using foreign key indexes if possible. Only works for direct FK relationships. For instance, book.authors will be optimized if the Author model has a fk({ to: 'Book', 'relatedName': 'authors' }) field. (#250, b9c1635)

This release should be non-breaking, however it does slightly decrease performance of writes. Many-to-many queries (e.g. child.parents) are also less performant, but in theory it is now possible to optimize them by an order of magnitude (similar to SQL joins).

0.12.4

Fixed a bug with memoization when specifying a custom mapName using Model.options. (0fb2aca)
Optimized memoization by not scanning entire tables for equality but relying on the propagated table identity instead. (0fb2aca)
Optimized model initialization by using Object.keys() instead of Object.entries(). (e371ac7)

0.12.3

Updated dependencies, most notably Babel v7.
Set sideEffects: false in package.json for tree-shaking.
Replaced some internal usage of lodash by ES6 methods.

0.12.2

Fixed self-referencing many-to-many relationships. They previously caused errors during initialization. (#226)
Throw error when user attempts to register a model class without a modelName set. (#231)
Throw error when user attempts to interact with the database without a session. (#237)
Fixed tests not running on Windows. (abe8723)
Drastically increased test coverage and split up tests to make them easier to digest. (#220, 294d5f2)
Removed unused methods from Model. (f9efb8b)

0.12.1

Our exported ES module in es/ (pkg.module) is now ES5 compatible. (#216, #221)
You can supply an as option to foreign key fields (fk()) to have Redux-ORM create a separate field for their accessors so as to not override foreign key references (#219):

class Movie extends Model {};
Movie.fields = {
    publisherId: fk({
        to: 'Publisher',
        as: 'publisher',
        relatedName: 'movies',
    }),
};

Publisher.create({ id: 123 });
const movie = Movie.create({ publisherId: 123 });

movie.publisherId // 123
movie.publisher.id === movie.publisherId // true

0.12.0

Fixed bug where using the ES5 version with ES6-based model classes would not work. #213
- Unfortunately this hotfix contains a performance degradation, so only upgrade if you suffer from the above issue. We are working on an alternative solution.

0.11.0

Potential breaking changes to model API:
- Model#equals is now used by Model#update to prevent unnecessary updates in some cases when the intended updates would not change the current model. By default models will always be updated if any of the passed attributes have a different reference than the respective existing attribute. #204
- Model.withId and resolving foreign key relationships no longer throw an error if the referenced model does not exist. Instead null is returned. #210
- Model.exists now accepts passing a lookup object to check if any model instance matching the passed attributes exists. #209
- Model.hasId has been replaced by Model.idExists. #209
Fixed QuerySet#toString. 12ce882
Upgraded to reselect v3.0.1. #208
Refactored fields.js, descriptors.js and small parts of Model.js. #210

0.10.2

pkg.module now points to a new entrypoint at es/index.js adhering to the latest finalized ECMAScript version without non-standard language features. 3ab92b9 To use the original source in your application, please have your bundler resolve src/index.js as defined in pkg["jsnext:main"].

0.10.1

Fixed filter functions not working when using strings as id attributes. #207

0.10.0

Added memoization by instance. Prevents unnecessary full table scans when not interested in unchanged records. #185
Improved performance of many-to-many descriptors. #165
Faster model lookups by primary key (id). #158
Added @deprecated JSDoc tag to deprecated members and functions. #201
Added pkg.module path to package.json indicating path for ES6 module. May fix #53 for some people. #192
Introduced dependency on ES2015 Set. See Polyfill.
Added performance regression tests.

0.9.4

fix for filter/query #99

0.9.2 - 0.9.3

fix for many-many updates #136

0.9.1

Added 'upsert' method to Model (insert or update behaviour)
Major updates for tests
CI integration

0.9.0

A lot. See the migration guide.

0.8.4

Adds UMD build to partially fix #41. You can now use or try out redux-orm through a script tag:

<script src="https://unpkg.com/redux-orm/dist/redux-orm.min.js"></script>

redux-orm.js will point to the master version of the library; If you need to stick to a version, make a copy or build it yourself.

0.8.3

Fixed bug that mutated the backend options in Model if you supplied custom ones, see Issue 37. Thanks to @diffcunha for the fix!

0.8.2

Fixed regression in Model.prototype.update

0.8.1

Added babel-runtime to dependencies

0.8.0

Adds batched mutations. This is a big performance improvement. Previously adding 10,000 objects would take 15s, now it takes about 0.5s. Batched mutations are implemented using immutable-ops internally.

Breaking changes:

Removed indexById option from Backend. This means that data will always be stored in both an array of id's and a map of id => entity, which was the default setting. If you didn't explicitly set indexById to false, you don't need to change anything.
Batched mutations brought some internal changes. If you had custom Backend or Session classes, or have overridden Model.getNextState, please check out the diff.

0.7.0

Breaking changes:

Model classes that you access in reducers and selectors are now session-specific. Previously the user-defined Model class reference was used for sessions, with a private session property changing based on the most recently created session. Now Model classes are given a unique dummy subclass for each session. The subclass will be bound to that specific session. This allows multiple sessions to be used at the same time.

You most likely don't need to change anything. The documentation was written with this feature in mind from the start. As long as you've used the model class references given to you in reducers and selectors as arguments (not the reference to the model class you defined), you're fine.

0.6.0

Breaking changes:

When calling QuerySet.filter or QuerySet.exclude with an object argument, any values of that object that look like a Model instance (i.e. they have a getId property that is a function), will be turned into the id of that instance before performing the filtering or excluding.

E.g.

Book.filter({ author: Author.withId(0) });

Is equivalent to

Book.filter({ author: 0 });

0.5.0

Breaking changes:

Model instance method equals(otherModel) now checks if the two model's attributes are shallow equal. Previously, it checked if the id's and model classes are equal.
Session constructor now receives a Schema instance as its first argument, instead of an array of Model classes (this only affects you if you're manually instantiating Sessions with the new operator).

Other changes:

Added hasId static method to the Model class. It tests for the existence of the supplied id in the model's state.
Added instance method getNextState to the Session class. This enables you to get the next state without running model-reducers. Useful if you're bootstrapping data, writing tests, or otherwise operating on the data outside reducers. You can pass an options object that currently accepts a runReducers key. It's value indicates if reducers should be run or not.
Improved API documentation.

0.4.0

Fixed a bug that mutated props passed to Model constructors, which could be a reference from the state. I highly recommend updating from 0.3.1.
API cleanup, see breaking changes below.
Calling getNextState is no longer mandatory in your Model reducers. If your reducer returns undefined, getNextState will be called for you.

Breaking changes:

Removed static methods Model.setOrder() and Backend.order. If you want ordered entities, use the QuerySet instance method orderBy.
Added helpful error messages when trying to add a duplicate many-to-many entry (Model.someManyRelated.add(...)), trying to remove an unexisting many-to-many entry (Model.exampleManyRelated.remove(...)), or creating a Model with duplicate many-to-many entry ids (Model.create(...)).
Removed ability to supply a mapping function to QuerySet instance method update. If you need to record updates dynamically based on each entity, iterate through the objects with forEach and record updates separately:

const authors = publisher.authors;
authors.forEach(author => {
    const isAdult = author.age >= 18;
    author.update({ isAdult });
})

or use the ability to merge an object with all objects in a QuerySet. Since the update operation is batched for all objects in the QuerySet, it can be more performant with a large amount of entities:

const authors = publisher.authors;
const isAdult = author => author.age >= 18;

const adultAuthors = authors.filter(isAdult);
adultAuthors.update({ isAdult: true });

const youngAuthors = authors.exclude(isAdult);
youngAuthors.update({ isAdult: false });

0.3.1

A descriptive error is now thrown when a reverse field conflicts with another field declaration. For example, the following schema:

class A extends Model {}
A.modelName = 'A';

class B extends Model {}
B.modelName = 'B';
B.fields = {
    field1: one('A'),
    field2: one('A'),
};

would try to define the reverse field b on A twice, throwing an error with an undescriptive message.

0.3.0

Breaking changes:

Model.withId(id) now throws if object with id id does not exist in the database.

0.2.0

Includes various bugfixes and improvements.

Breaking changes:

Replaced plain and models instance attributes in QuerySet with withRefs and withModels respectively. The attributes return a new QuerySet instead of modifying the existing one. A ref alias is also added for withRefs, so you can do Book.ref.at(2).
After calling filter, exclude or orderBy method on a QuerySet instance, the withRefs flag is always flipped off so that calling the same methods on the returned QuerySet would use model instances in the operations. Previously the flag value remained after calling those methods.
.toPlain() from QuerySet is renamed to .toRefArray() for clarity.
Added .toModelArray() method to QuerySet.
Removed .objects() method from QuerySet. Use .toRefArray() or .toModelArray() instead.
Removed .toPlain() method from Model, which returned a copy of the Model instance's property values. To replace that, ref instance getter was added. It returns a reference to the plain JavaScript object in the database. So you can do Book.withId(0).ref. If you need a copy, you can do Object.assign({}, Book.withId(0).ref).
Removed .fromEmpty() instance method from Schema.
Removed .setReducer() instance method from Schema. You can just do ModelClass.reducer = reducerFunc;.

Files

CHANGELOG.md

Latest commit

History

CHANGELOG.md

File metadata and controls

0.16.2

0.16.1

0.16.0

0.15.1

0.15.0

0.14.1

0.14.0

0.13.3

0.13.2

0.13.1

0.13.0

0.12.4

0.12.3

0.12.2

0.12.1

0.12.0

0.11.0

0.10.2

0.10.1

0.10.0

0.9.4

0.9.2 - 0.9.3

0.9.1

0.9.0

0.8.4

0.8.3

0.8.2

0.8.1

0.8.0

0.7.0

0.6.0

0.5.0

0.4.0

0.3.1

0.3.0

0.2.0