NamePath renamed to Path

Added support auxiliary data.

• NamePath renamed to Path.
• Field.path renamed to pathName.
• Field.path renamed to path.

Added Numbering support

Added numbering support so that array indices can be shown in a display format when generating labels.

• added Field.numbering.
• added Tyr.numberize().

Added group support to NamePath

Added support auxiliary data.

• added NamePath.groupCount.
• added NamePath.groupLabel().
• added NamePath.groupRange().

Auxiliary Data

Added support auxiliary data.

Whitelabels

Added support for white label systems. See Tyr.config().

Services

Added support for Services.

removeReferences()

• Added Collection.removeReferences projection support

$minimal Projection Support

• Added $minimal projection support

fromClient() changed to be asynchronous

• Collection.fromClient changed to be asynchronous

Comparator support added to types

• Added Type.compare method

$options functionality and Media Type (MIME Type) Metadata

• Added Document.$options property
• Document.$save() and Document.$update() will use Document.$options as the default set of options. This means that, for example, when you use an auth option when finding a document, if you later then save or update that document that the auth parameter will be carried forward to the updating call.
• Added Media Type metadata

Add support for shorthand link definitions

See link shorthand syntax.

Upsert Option added to Document Updates

• Updated Document.$update() to default to not upserting unless the new upsert parameter is set to true.
• Updated Collection.updateDoc() to default to not upserting unless the new upsert parameter is set to true.

Additional client-side API support

• Updated Document.$update() to be available on the client
• Updated Collection.updateDoc() to be available on the client

Upgrade to MongoDB 3.x API drivers, initially 3.1.10.

• Added mongoClient option to Tyr.config().
• Added Tyr.mongoClient property.

Add support for projection security

• Added Options.keepNonAccessible option
• Added Document.$access
• Added Document.$checkAccess()
• Added Document.$redact()
• Added Secure.checkAccess()

Migration utility from Patch to Document format added

Added support for Collection.migratePatchToDocument().

Conditional Fields

Added support for conditional fields.

Collection Destructuring

Added support for capitalized names in Tyr.collections permitting use of destructuring assignment.

For example, you can now write

const { Depot, Train } = Tyr.collections;

instead of

const Depot = Tyr.byName.depot;
const Train = Tyr.byName.train;

This works on both the client and the server. The existing syntax is also still supported.

Add support for document vs. patch history storage

• added document historical storage type

Add support sleep utility functions

• added sleep()
• added sleepUntil()

Add support for Currency Conversion

See the Units Guide for more information.

Added support for preserveInitialValues

• added support for preserveInitialValues

Field Groups

• added support for field groups

Generated and Internal Collections

• added internal collection status to indicate a collection is internal to Tyranid
• added generated collection status to indicate a collection was automatically generated

isSameId()

• added Tyr.isSameId()

Migration Support

Added support for database migrations.

• added migration options to Tyr.config()
• added Tyr.migrate()

Plain 'ole Javascript Object (POJO) Document Support

Added additional support to convert Tyranid Documents to POJO objects that is also available in the client API.

• added Document.$toPlain()
• added plain option to Options

Node 8 Support

Tyranid has been updated to Node 8. This includes generating native ES2017 code (including native async functions).

Unfortunately we had to remove the plugin system since it was based on a library which was incompatible with Node 8's native async functions. However, the Event system provides the same hooks for plugging into Tyranid.

• Removed Collection.plugin()
• Removed Collection.pre()
• Removed Collection.post()
• Removed Collection.unhook()

Support for Optional Links

Links can now be optional. See optional links for discussion and an example.

• added support for optional links
• Tyranid logging now has an optional link to user meaning that a user collection is no longer required for Tyranid to operate

Collection.exists(), Field custom validations, support for insert and update events

• added Collection.exists()
• added validate option to Field.def
• added insert and update event types as more targeted alternatives to change

Find Events

Added support for find events that can mutate documents coming out of reads (see example).

Counts

Adding counting methods and options. All of the counting functionality is also supported in the client.

• added Collection.count()
• added count option to findAll()

Timer class

Documented previously-undocumented Timer class.

More Field Type Metadata

Added additional metadata to field types.

• added placeholder to most fields
• added cardinality to array fields
• added min, max, and step to numeric fields
• added pattern, minlength, and maxlength to string fields
• added granularity to time fields

Subscriptions

Added support for clients to subscribe to updates in data to support live updating of data on clients. See Subscriptions.

• socket.io functionality added to connect()
• added Collection.subscribe()
• added Collection.values
• added Collection.cache()
• added Tyr.socket and Tyr.io

datetime and time types added

Added datetime and time built-in data types to complement the existing date type.

Collection fromClient() hook

Added a "fromClient" hook that can be defined for collections

Events and Tyranid Instances

Tyranid instances will now auto-join a local Tyranid cluster and Tyranid events can now be sent cluster-wide.

• Added Tyr.instanceId property

isCompliant()

• Added Tyr.isCompliant method.

Deprecated Fields

You can now mark fields as being deprecated.

Events

• Collection.on() added
• Event added

Additional ObjectID support

• Tyr.isObject() added
• Tyr.parseBson() added

Deep cloning on documents

• Document.$cloneDeep() added

Historical support in Population

Added historical asOf option to most query methods that support population, allowing you to query a tree of documents that are all $asOf()'d the same date.

• Added asOf option to Options

Collection.references() method

Added Collection.references() method which can be used to find all references to an id or a list of ids.

Expanded client options in field definitions

See client options for more information.

Pre-defined Projections, Projection Merging

Added ability to define pre-defined projections and enhanced the fields syntax to support pre-defined projections and projection merging. See Projections.

Enhanced Document.$toClient() to support an options object which provides further control on how the toClient processing is performed.

$tyr property on documents

• Document.$tyr() added

Support Array Paging and Relative NamePaths

Array paging (using the new Document.$slice() method) provides a way to page large embedded arrays inside large documents down to the client without having to send down the entire document. You can sort, filter, skip, limit, and populate the embedded array just like querying top-level documents.

• Document.$slice() added
• NamePath.base added
• NamePath.parse() added
• Path updated to work with relative paths from the new parse method
• NamePath.set() added
• Tyr.arraySort() added
• Tyr.mongoCompare() added

Population supports Projection

Advanced population projection syntax is now supported (was silently ignored before).

• NamePath.spath added

Historical Data

Adds support for historical data to Tyranid.

• Added historical option to Collection.def
• Added historical option to Field.def
• Collection.pull() added
• Collection.push() added
• Document.$asOf() added
• Document.$copy() added
• Document.history added
• Document.$historical added
• Document.$orig added
• Document.$replace() added
• Document.$snapshot() added
• NamePath.decode() added
• NamePath.encode() added
• Path.isHistorical() added
• Tyr.addToSet() added
• Tyr.cloneDeep() added
• Tyr.diff added
• Tyr.indexOf() added
• Tyr.isEqual() added
• Tyr.pullAll() added
• SecureError added
• Added author option to Options
• Added comment option to Options
• Added historical option to Options
• Added timestamps option to Options
• $update() and updateDoc() will now update updatedAt in the source document if timestamps are being used.

Add support for indexes

• Added indexes option to Tyr.config()
• Added Tyr.createIndexes()
• Added indexes option to Collection.def

Add support for multiple servers in Tyr.config() and a server option when defining collections.

This allows you to place specific collections onto alternate servers to help distribute the load.

Add support for globs in Tyr.validate().

See Tyr.validate() for an example.

ES2015 and minification support for client code generation

You can now use ES2015 functionality in code that will be used on the client (it will be transformed into ES5 via babel) and the code generated by tyranid (at /api/tyranid) is now by default minified.

• Added a minify option to Tyr.config().

async utility methods

Added various async utilities functions.

• Tyr.eachAsync() added.
• Tyr.everyAsync() added.
• Tyr.filterAsync() added.
• Tyr.findAsync() added.
• Tyr.findIndexAsync() added.
• Tyr.mapAsync() added.
• Tyr.mapAwait() added.
• Tyr.someAsync() added.

permissions configuration

Permissions values used by Tyranid are now configurable.

inserts secured

• Secure.canInsert() added
• Collection.canInsert() added

remove(), updateDoc(), $update() secured

• Collection.remove() updated to support Options, including auth and perm.
• Collection.updateDoc() updated to support Options, including auth and perm.
• Document.$update() updated to support Options, including auth and perm.

options improvements; update secured

• populate option added to Options.
• Collection.update() updated to support Options, including auth and perm.

UID, security, database options improvements

• Tyr.byUid() is now available on the client
• Collection.secureQuery() added
• Collection.secureFindQuery() added
• support for a standardized Options object in collection methods (including many Document methods (like Document.$insert, ...) added, including the new auth and perm options.
• collection.isUid() added

Switch to Native MongoDB Library

Tyranid is switching from the promised-mongo to the native MongoDB library now that it supports promises.

• Switched from promised-mongo to native MongoDB library
• Added Collection.findAll() method.

Document.$remove()

• added Document.$remove()

Collection.links()

Added Collection.links() method to search for a list of links between collections.

• added Collection.links()

Link Relationships

Added relate option to Field defs. This allows you to specify the relationship between links. See Links for more information.

• added Field.def.relate

Components and Security

Added a Component mixin interface for Tyranid to facilitate extensions and plugins.

Collections are also Components, so you can use component hooks when defining your collections.

Also added a Secure mixin interface that permits client to plug in security rules.

• added Component
• added Secure
• added Tyr.mixin()

Logging

Added an isomorphic logging system that can log to the client console, the server console, and/or the database log collection. See Log for more information.

• added Log
• added Tyr.log* methods
• added Document.$clone()

Mixins

Added a new Collection.mixin() method that can add additional fields to an existing collection. This is useful for adding additional metadata to builtin Tyranid collections. See Mixins for more information.

• added Collection.mixin()
• added Collection.fields
• added Collection.paths

Continuation Local Storage

Added support for continuation local storage -- an equivalent to thread local storage for async node.js.

• added Local Storage
• added Tyr.local

Tyr.byUids()

Added ability to efficiently query an array of UIDs.

• added Tyr.byUids()

Maps

In addition to specifying a fields property on objects, you can now also specify a keys and of property for them as well to indicate that the object is a map. See Maps for more information.

• added Field.keys
• Field.of is now supported on objects
• NamePaths updated to understand maps

NamePath and Type enhancements

• NamePath is now available on the client
• Type is now available on the client
• added Field.namePath
• added Type.format()
• added Type.byName
• added Type.query()
• added Type.matches()
• added Type.sortValue()

NamePath updated to deal with arrays better; document.$id

• NamePath parsing now understands the ._ "contents of array syntax".
• namePath.tail ➜ namePath.detail
• namePath.tail added
• document.$id added

Access to Of, Type, and Link moved to Field

The general strategy going forward is to try to leave def untouched and to store compiled def information on the containing class (i.e. Collection, Field, Type, ...). This is easier to use (field.X instead of field.def.X) and also keeps the original unprocessed raw def value around for later inspection.

• field.def.is ➜ field.type
• field.def.link ➜ field.link
• field.def.of ➜ field.of

Units

Tyranid now supports units of measure. Units of measure are an important piece of metadata to keep track of. For example, knowing that a field is a double containing kilometers has a lot more meaning than simply knowing it is a double.

See the Units Guide, Units, and Unit for more information.

collection.boot()

Collections have a new boot() hook method can be used to bootstrap your collection.

field.parent, field.pathLabel, namePath.pathLabel

Field objects now have

• a parent property that points to their parent field and
• a pathLabel property that contains their path label.

NamePath objects now have

• a pathLabel property that contains their path label.

defaultValue

defaultValue can now take a function for dynamic defaults.

fromClientQuery()

Collection.fromClientQuery() method added which allows MongoDB queries created on the client to be usable on the server in MongoDB queries.

idToLabel()

Collection.idToLabel() method added, available on the client and server.

NamePath Support

NamePath support added.

NamePath can now also parse denormalized paths.