Akita: Akita v3 roadmap

[NetanelBasal]

Here are the changes that we plan to present in Akita v3. We're still open to any suggestions or feedback, so feel free to bring up anything you'd like.

BREAKING CHANGES:

• EntityStore.set() - remove options param, i.e entityClass. done.
• Remove EntityStore.createOrReplace() in favor of EntityStore.upsert(). done
• Remove EntityStore.updateRoot() in favor of EntityStore.update(). done
• Remove EntityStore.updateAll() in favor of EntityStore.update(null, newState), done
• Store.setState is internal and changed to _setState() - use only the update() method. done
• Remove mapWorker. done
• Remove array helpers. done
• Remove decrement and increment. done
• Remove Query.selectOnce - use select().pipe(take(1)). done
• Remove deprecated Query.getSnapshot(). done
• Remove noop - use the of() observable. done
• Remove isPristine and isDirty in favor of new caching functionality. done
• The action decorator takes the action name instead of an object. done
• Remove EntityStore.isEmpty in favor of EntityStore.hasEntity(). done

Features:

• Add async support to persistState so it will work with IndexedDB etc. done
• Add akitaPreUpdateEntity and akitaPreAddEntity middlewares to EntityStore. done
• Add akitaPreUpdate middleware to Store. done
• Add caching functionality that exposes API like: this.query.getHasCache(), this.query.selectHasCache() with ability to define a ttl. done
• Add support for event-based APIs like websockets. We've added the following functionality:

 import { runStoreAction, StoreActions } from '@datorama/akita';

 runStoreAction('books', StoreActions.UpdateEntities, {
   payload: {
     data: { title: 'New title' },
     entityIds: 2
   }
 });

done

[danzrou]

Great news.
Regarding

• Remove array helpers. done

How would arrays be handled then? (specifically remove specific index etc.)

[NetanelBasal]

@danzrou you can include what you need in your application and use it. We can't find any reason that we should include it inside Akita.

https://github.com/georapbox/immutable-arrays

[danzrou]

Seems totally legit.

Would love the new caching functionality <3

[zverbeta]

Amazing news, but i still waiting class support.

[NetanelBasal]

@zverbeta https://netbasal.gitbook.io/akita/general/additional-functionality/class-support

[zverbeta]

@NetanelBasal It's working only if we pass object in constructor

[manudss]

As their are a lot of break changes. You could also rename all Plug in to have Akita in the name :

PaginatorPlugin -> AkitaPaginatorPlugin
StateHistoryPlugin -> AkitaStateHistoryPlugin
DirtyCheckPlugin -> AkitaDirtyCheckPlugin
persistState() -> AkitaPersistState()
PersistNgFormPlugin -> AkitaPersistNgFormPlugin (maybe for this : "AkitaNgPersistFormPlugin" to have better corresponding with other ng plugin.

Did you provide a version 2.x with all deprecated feature, and new feature, to help the migration !?

[NetanelBasal]

Thanks for the suggestion. We're planning bigger changes in the plugins area, so we'll do it in that time.

[NetanelBasal]

https://engineering.datorama.com/you-asked-for-it-we-listened-and-now-its-here-akita-v3-92740d0d72e4

[MarcelMalik]

runStoreAction and StoreActions are not exported in src/index.ts so there are not usable.

[jonchai99]

Worth noting that if you're using forkJoin to fetch from your api, of() would short-circuit it. Either do of(null) or pipe(defaultIfEmpty())

[NetanelBasal]

@MarcelMalik fixed. @jonchai99 you're right, thanks.