mongo-assets v0.1.31

Class

MongoAssets

constructor()

config: *

db: *

client: *

initialize(config: Object, config.endpoint: String): Promise

Initialize the instance, connecting it to the database.

connect(args: object, args.endpoint: string): Promise

Create a connection to the mongo database, setting this.db as an instance.

disconnect(args: Object): {"success": boolean}

Disconnect the instance from the database.

createAsset(args: Object, args.type: String, args.user: Object, args.asset: Object, args.relate: Boolean, args.assoc_method: Boolean, args.role: Object): Promise

Insert an asset, associating it to the user role

createAssets(args: Object, args.type: String, args.user: Object, args.assets: Object|Array, args.relate: Boolean, args.assoc_method: String, args.role: Object): Promise

Insert an array of assets, associating it to the user role

updateAsset(args: Object, args.type: String, args.asset: Object, args.assoc_method: String): Promise

Update Asset

deleteAsset(args: Object, args.type: String, args.asset: Object, args.recycle: Boolean): Promise

Delete an asset, disassociating it from all related items.

deleteAssets(args: Object, args.type: String, args.assets: Array, args.asset: Object): Promise

dropAssetType(args: Object, args.type: String): Promise

Drop an asset type entirely, removing all associates.

assetCollectionExists(args: Object, args.type: String): Promise

Check for the existence of an asset collection.

associate(args: Object, args.target: Object, args.source: Object, args.relationship: String, args.assoc_method: String, args.withTree: Boolean, args.returnOnly: String): Promise

Associate Assets.

disassociate(args: Object, args.target: Object, args.source: Object, args.relationship: String, args.assoc_method: String, args.withTree: Boolean, args.returnOnly: String): Promise

Disassociate Assets.

updateAssociations(args: Object, args.type: String, args.asset: Object): Promise

Update all associations of an argued asset.

dropAssociations(args: Object, args.type: String, args.asset: Object): Promise

Drop all assocations from the asset and update associates, this orphans the asset (useful prior to deletion of an asset)

gatherAssets(args: Object, args.user: Object, args.type: String, args.types: Array): Promise

Gather assets associated to argued roles.

getAssociates(args: Object, args.assetType: String, args.assocs: Array, args.exclude: Array): Promise

Retrieve the associates in their full form.

getAssociatedRoles(args: Object, args.type: String, args.asset: Object): Promise

Gain the roles assocated to an argued asset.

shareAssets(args: Object, args.user: Object, args.type: String, args.asset: Object, args.assets: Object, args.role: Object, args.roles: Object, args.assoc_method: String): Promise

Share assets to argued roles.

_isRealObject(obj: Object): Boolean

Test a variable to be an object

defaultrole(user: Object): Object

Get the default role for an argued user.

handleError(method: String, err: Error, options: Object): {"success": *, "errored": boolean, "message": string}

Error handler.

splitAsset(args: *): *

_findAssetChunks(root: *, key: *, chunks: *, itr: *, id: *): {"root": *, "chunks": *, "paged": *, "pages": *, "frag": *}

create(args: object, args.collection: string, args.documents: array): *

Insert one or many documents

findOne(args: Object, args.collection: String, args.frag: Object): Promise

Find One asset.

find(args: object, args.collection: string, args.documents: object|array, args.ql: function, args.fuse: boolean, args.debug: boolean): *

distinct(args: Object, args.collection: String, args.attribute: String): Array

findAsset(args: Object, args.type: String, args.frag: Object): Object

Retrieve an asset.

findAssets(args: object, args.user: object, args.role: object|array, args.userrole: boolean, args.type: string): *

Retrieve assets for a given user/roles.

getAssetPartial(args: object, args.type: string, args.asset: object, args.nest: string, args.page: integer, args.pages: array): *

findAssociatedRoles(args: object, args.type: string, args.asset: object): *

Retrieve roles that are associated to a given asset.

updateOne(args: object, args.collection: string, args.document: object, args.ops: object): Promise

Update a document

deleteOne(args: object, args.collection: string, args.document: object): object

Deletes a document

delete(args: object, args.collection: string, args.frag: object, args.documents: array): object

Deletes multiple documents

deleteOneAsset(args: *): *

releaseAssets(args: object): *

Release assets from a relationship, effective "un-sharing" them.

releaseAssetType(args: object, args.type: string, args.target: object, args.targetType: string): *

Release an entire assetType from a relationship, effectively unsharing that type.

assetToAssoc(method: String, type: String, asset: Object): Promise

Get the association representation of an asset.

assocToAsset(asset: Object): Promise

Gain the actual asset from an association method.

reassociate(args: Object, args.type: String, args.role: Object|Array, args.method: String): Array

Change the association method of related assets to a role(s)

decouple_associates(o: *): *

Strip an objects out of arrays and objects, leaving just the attributes.

parseQL(ql: *): *

idify(doc: *): *

Takes a document with a string typed _id, returns it with an ObjectId.

Function

withMongoAssets(args: Object, args.key: String, args.initialize: Boolean, args.config: Object, args.config.endpoint: String): *

Decorate a class with an instance of Mongo Assets