Road Map: Dexie Cloud
Dexie Cloud is now publicly released and can be used in production apps.
For backlog, future and current work, see https://github.com/orgs/dexie/projects.
Old Milestones:
Milestone 1 - Private beta
The private beta was released in June 2021 and included the following features.
- Initial documentation on dexie.org
- CLI: “npx dexie-cloud create”
- dexie-cloud-addon
- Dexie Cloud Server published on https://dexie.cloud
- Dexie Cloud CLI
- Complete authentication flow using email OTP
- Complete Sync flow
- DB management access control
- Token endpoint for custom authentication
- Service Worker with periodic sync
- A workind sample app
Milestone 2 - Consistent Sync
This milestone was finalized in September 2021
- ACID atomicity in sync requests
- Full consistency when syncing Collection.modify() and Collection.delete() operations.
- Respect CORS origins
- Fully implemented CLI tool
- Improved performance in WebSocket reactivity
- Bug fixes
Milestone 3 - Fully functional Access Control
This milestone was released December 19, 2021.
Another 150 people from the wait list are now able to use it (update on december 21).
- Possible to create realms and respect permissions on sync and maintain realm consistency.
- Support compound primary keys
- New React hook
usePermission()
to disable unpermitted fields and buttons. - New permissions helper for non-react apps (db.cloud.permissions(db, table, obj),
can.add('members'), can.update('done'), can.delete()
) - Improve migration framework (server side on dexie cloud)
- Add new migration to reflect updated model
- Decide solution for binding an object to a dedicated realm
- Support switching object between being shared (connected to realm) and private (connected to private realm) back and forth in a consistent manner.
- Implement invite route on dexie cloud server (endpoint for accepting / rejecting invites)
- Send out email invites when inviting people to a realm
- Add demo users to sample app
- Implement todo-list sharing on sample app
- Support for private IDs (solution for per-user singletons)
- Support for generating tied realm IDs (consistency of realms that are tied to an entity)
- db.cloud.invites - an observable of invites
- Tests
- Run migration on production cloud and publish new version
- Publish new version of sample todo app
- Allowed another 150 people from the wait list!
Milestone 4 - Role support + Updated Documentation
Target release date: Jan 10, 2022. May 31, 2022.
- Respect global roles
- Allow importing global roles in JSON format for dexie-cloud import CLI.
- Add sharing support with roles to the sample app
- Update Authentication docs: signed refresh tokens
- Updated docs explaining that ‘@’ keys are optional.
- Docs: Explain Universally consistent modify() operations
- Document all options in db.cloud.configure()
- Document db.cloud properties and how to use them
- Document service worker support
- Update docs for unauthorized use case
Document REST API: import / export- Document how to tie an object to a Realm
Milestone 5 - Increase number of beta testers
- Set up monitoring, alarms and redundancy
- Approve more testers
- Start sending out waitlist confirmation emails
- Collect new requirements
- New REST API
- Document REST API
Milestone 6 - Commercialization
- Subscription manager
- Stripe Integration
- Implement monthly cost limit setting
- Implement end-user trial period for customer apps
- Feature complete
- The new Subscription model applied
- Extend all customers’ eval users to guarantee full service until official release date.
- Production level service for paying customers
- Possible to manage databases, users and evaluation policy using Dexie Cloud Manager
- Possible to purchase Dexie Cloud Production using Dexie Cloud Manager
Milestone 7 - Public Release
- Release new version (prod version) of the software to On-Prem customers
- Dexie Cloud Manager officially released
- Communicate the release in a newsletter to everyone in the waitlist
- Marketing campaign launched
- “beta” removed from web site
- Waitlist closed
- Anyone can create databases and use the Free version
- Anyone can purchase subscriptions
Table of Contents
- API Reference
- Access Control in Dexie Cloud
- Add demo users
- Add public data
- Authentication in Dexie Cloud
- Best Practices
- Building Addons
- Collection
- Collection.and()
- Collection.clone()
- Collection.count()
- Collection.delete()
- Collection.desc()
- Collection.distinct()
- Collection.each()
- Collection.eachKey()
- Collection.eachPrimaryKey()
- Collection.eachUniqueKey()
- Collection.filter()
- Collection.first()
- Collection.keys()
- Collection.last()
- Collection.limit()
- Collection.modify()
- Collection.offset()
- Collection.or()
- Collection.primaryKeys()
- Collection.raw()
- Collection.reverse()
- Collection.sortBy()
- Collection.toArray()
- Collection.uniqueKeys()
- Collection.until()
- Compound Index
- Consistency in Dexie Cloud
- Consistent add() operator
- Consistent remove() operator
- Consistent replacePrefix() operator
- Consuming Dexie as a module
- Custom Emails in Dexie Cloud
- DBCore
- DBCoreAddRequest
- DBCoreCountRequest
- DBCoreCursor
- DBCoreDeleteRangeRequest
- DBCoreDeleteRequest
- DBCoreGetManyRequest
- DBCoreGetRequest
- DBCoreIndex
- DBCoreKeyRange
- DBCoreMutateRequest
- DBCoreMutateResponse
- DBCoreOpenCursorRequest
- DBCorePutRequest
- DBCoreQuery
- DBCoreQueryRequest
- DBCoreQueryResponse
- DBCoreRangeType
- DBCoreSchema
- DBCoreTable
- DBCoreTableSchema
- DBCoreTransaction
- DBCoreTransactionMode
- DBPermissionSet
- Deprecations
- Derived Work
- Design
- Dexie Cloud API
- Dexie Cloud API Limits
- Dexie Cloud Best Practices
- Dexie Cloud CLI
- Dexie Cloud Docs
- Dexie Cloud REST API
- Dexie Cloud Web Hooks
- Dexie Constructor
- Dexie.AbortError
- Dexie.BulkError
- Dexie.ConstraintError
- Dexie.DataCloneError
- Dexie.DataError
- Dexie.DatabaseClosedError
- Dexie.IncompatiblePromiseError
- Dexie.InternalError
- Dexie.InvalidAccessError
- Dexie.InvalidArgumentError
- Dexie.InvalidStateError
- Dexie.InvalidTableError
- Dexie.MissingAPIError
- Dexie.ModifyError
- Dexie.NoSuchDatabaseErrorError
- Dexie.NotFoundError
- Dexie.Observable
- Dexie.Observable.DatabaseChange
- Dexie.OpenFailedError
- Dexie.PrematureCommitError
- Dexie.QuotaExceededError
- Dexie.ReadOnlyError
- Dexie.SchemaError
- Dexie.SubTransactionError
- Dexie.Syncable
- Dexie.Syncable.IDatabaseChange
- Dexie.Syncable.IPersistentContext
- Dexie.Syncable.ISyncProtocol
- Dexie.Syncable.StatusTexts
- Dexie.Syncable.Statuses
- Dexie.Syncable.registerSyncProtocol()
- Dexie.TimeoutError
- Dexie.TransactionInactiveError
- Dexie.UnknownError
- Dexie.UnsupportedError
- Dexie.UpgradeError()
- Dexie.VersionChangeError
- Dexie.VersionError
- Dexie.[table]
- Dexie.addons
- Dexie.async()
- Dexie.backendDB()
- Dexie.close()
- Dexie.currentTransaction
- Dexie.debug
- Dexie.deepClone()
- Dexie.defineClass()
- Dexie.delByKeyPath()
- Dexie.delete()
- Dexie.derive()
- Dexie.events()
- Dexie.exists()
- Dexie.extend()
- Dexie.fakeAutoComplete()
- Dexie.getByKeyPath()
- Dexie.getDatabaseNames()
- Dexie.hasFailed()
- Dexie.ignoreTransaction()
- Dexie.isOpen()
- Dexie.js
- Dexie.name
- Dexie.on()
- Dexie.on.blocked
- Dexie.on.close
- Dexie.on.error
- Dexie.on.populate
- Dexie.on.populate-(old-version)
- Dexie.on.ready
- Dexie.on.storagemutated
- Dexie.on.versionchange
- Dexie.open()
- Dexie.override()
- Dexie.semVer
- Dexie.setByKeyPath()
- Dexie.shallowClone()
- Dexie.spawn()
- Dexie.table()
- Dexie.tables
- Dexie.transaction()
- Dexie.transaction()-(old-version)
- Dexie.use()
- Dexie.verno
- Dexie.version
- Dexie.version()
- Dexie.vip()
- Dexie.waitFor()
- DexieCloudOptions
- DexieError
- Docs Home
- Download
- EntityTable
- Export and Import Database
- Get started with Dexie in Angular
- Get started with Dexie in React
- Get started with Dexie in Svelte
- Get started with Dexie in Vue
- Hello World
- How To Use the StorageManager API
- Inbound
- IndexSpec
- Indexable Type
- IndexedDB on Safari
- Invite
- Member
- Migrating existing DB to Dexie
- MultiEntry Index
- PersistedSyncState
- Privacy Policy
- Promise
- Promise.PSD
- Promise.catch()
- Promise.finally()
- Promise.on.error
- Promise.onuncatched
- Questions and Answers
- Realm
- Releasing Dexie
- Road Map
- Road Map: Dexie 5.0
- Road Map: Dexie Cloud
- Role
- Run Dexie Cloud on Own Servers
- Sharding and Scalability
- Simplify with yield
- Support Ukraine
- SyncState
- Table
- Table Schema
- Table.add()
- Table.bulkAdd()
- Table.bulkDelete()
- Table.bulkGet()
- Table.bulkPut()
- Table.bulkUpdate()
- Table.clear()
- Table.count()
- Table.defineClass()
- Table.delete()
- Table.each()
- Table.filter()
- Table.get()
- Table.hook('creating')
- Table.hook('deleting')
- Table.hook('reading')
- Table.hook('updating')
- Table.limit()
- Table.mapToClass()
- Table.name
- Table.offset()
- Table.orderBy()
- Table.put()
- Table.reverse()
- Table.schema
- Table.toArray()
- Table.toCollection()
- Table.update()
- Table.where()
- The main limitations of IndexedDB
- Transaction
- Transaction.abort()
- Transaction.on.abort
- Transaction.on.complete
- Transaction.on.error
- Transaction.table()
- Tutorial
- Typescript
- Typescript (old)
- Understanding the basics
- UserLogin
- Version
- Version.stores()
- Version.upgrade()
- WhereClause
- WhereClause.above()
- WhereClause.aboveOrEqual()
- WhereClause.anyOf()
- WhereClause.anyOfIgnoreCase()
- WhereClause.below()
- WhereClause.belowOrEqual()
- WhereClause.between()
- WhereClause.equals()
- WhereClause.equalsIgnoreCase()
- WhereClause.inAnyRange()
- WhereClause.noneOf()
- WhereClause.notEqual()
- WhereClause.startsWith()
- WhereClause.startsWithAnyOf()
- WhereClause.startsWithAnyOfIgnoreCase()
- WhereClause.startsWithIgnoreCase()
- db.cloud.configure()
- db.cloud.currentUser
- db.cloud.currentUserId
- db.cloud.events.syncComplete
- db.cloud.invites
- db.cloud.login()
- db.cloud.logout()
- db.cloud.options
- db.cloud.permissions()
- db.cloud.persistedSyncState
- db.cloud.roles
- db.cloud.schema
- db.cloud.sync()
- db.cloud.syncState
- db.cloud.userInteraction
- db.cloud.usingServiceWorker
- db.cloud.version
- db.cloud.webSocketStatus
- db.members
- db.realms
- db.roles
- db.syncable.connect()
- db.syncable.delete()
- db.syncable.disconnect()
- db.syncable.getOptions()
- db.syncable.getStatus()
- db.syncable.list()
- db.syncable.on('statusChanged')
- db.syncable.setFilter()
- dexie-cloud-addon
- dexie-react-hooks
- liveQuery()
- unhandledrejection-event
- useLiveQuery()
- useObservable()
- usePermissions()