bpmn-server / ModelsDatastore

Class: ModelsDatastore

super class for various objects that are part of the server

Hierarchy

• ModelsDatastoreDB

↳ ModelsDatastore

Implements

• IModelsDatastore

Table of contents

Constructors

• constructor

Properties

• dbConfiguration
• db
• server

Accessors

• definitionsPath
• modelHistory
• keepsHistory
• configuration
• logger
• cron
• cache
• appDelegate
• engine
• dataStore
• lockManager
• definitions
• listener
• scriptHandler

Methods

• import
• getList
• getPath
• getFile
• saveFile
• getSource
• getSVG
• before
• keepVersion
• save
• history
• historySource
• deleteVersion
• purgeHistory
• deleteModel
• renameModel
• rebuild
• rebuildModel
• close
• backup
• get
• loadFromInstance
• load
• loadDefinition
• loadModel
• findEvents
• install
• updateTimer
• saveModel
• export

Constructors

constructor

• new ModelsDatastore(server): ModelsDatastore

Parameters

Name	Type
server	IBPMNServer

Returns

ModelsDatastore

Overrides

ModelsDatastoreDB.constructor

Defined in

packages/bpmn-server/src/datastore/ModelsDatastore.ts:14

Properties

dbConfiguration

• dbConfiguration: any

Inherited from

ModelsDatastoreDB.dbConfiguration

Defined in

packages/bpmn-server/src/datastore/ModelsDatastoreDB.ts:18

---

db

• db: any

The storage adapter: the server's shared documentStore, else this datastore's own MongoDB connection.

Inherited from

ModelsDatastoreDB.db

Defined in

packages/bpmn-server/src/datastore/ModelsDatastoreDB.ts:20

---

server

• server: any

Inherited from

ModelsDatastoreDB.server

Defined in

packages/bpmn-server/src/server/ServerComponent.ts:10

Accessors

definitionsPath

• get definitionsPath(): any

Returns

any

Defined in

packages/bpmn-server/src/datastore/ModelsDatastore.ts:18

---

modelHistory

• get modelHistory(): ModelHistory

Every save of a model, kept beside it (.history/<name>/), in the models folder.

Returns

ModelHistory

Defined in

packages/bpmn-server/src/datastore/ModelsDatastore.ts:102

---

keepsHistory

• get keepsHistory(): boolean

Is a version kept for each save (modelHistory, default true)?

Returns

boolean

Defined in

packages/bpmn-server/src/datastore/ModelsDatastore.ts:117

---

configuration

• get configuration(): any

Returns

any

Inherited from

ModelsDatastoreDB.configuration

Defined in

packages/bpmn-server/src/server/ServerComponent.ts:15

---

logger

• get logger(): any

Returns

any

Inherited from

ModelsDatastoreDB.logger

Defined in

packages/bpmn-server/src/server/ServerComponent.ts:16

---

cron

• get cron(): Cron

Returns

Cron

Inherited from

ModelsDatastoreDB.cron

Defined in

packages/bpmn-server/src/server/ServerComponent.ts:17

---

cache

• get cache(): ICacheManager

Returns

ICacheManager

Inherited from

ModelsDatastoreDB.cache

Defined in

packages/bpmn-server/src/server/ServerComponent.ts:18

---

appDelegate

• get appDelegate(): any

Returns

any

Inherited from

ModelsDatastoreDB.appDelegate

Defined in

packages/bpmn-server/src/server/ServerComponent.ts:19

---

engine

• get engine(): IEngine

Returns

IEngine

Inherited from

ModelsDatastoreDB.engine

Defined in

packages/bpmn-server/src/server/ServerComponent.ts:20

---

dataStore

• get dataStore(): any

Returns

any

Inherited from

ModelsDatastoreDB.dataStore

Defined in

packages/bpmn-server/src/server/ServerComponent.ts:21

---

lockManager

• get lockManager(): any

The lock port: the configuration's, else the data store's.

Returns

any

Inherited from

ModelsDatastoreDB.lockManager

Defined in

packages/bpmn-server/src/server/ServerComponent.ts:23

---

definitions

• get definitions(): any

Returns

any

Inherited from

ModelsDatastoreDB.definitions

Defined in

packages/bpmn-server/src/server/ServerComponent.ts:24

---

listener

• get listener(): any

Returns

any

Inherited from

ModelsDatastoreDB.listener

Defined in

packages/bpmn-server/src/server/ServerComponent.ts:25

---

scriptHandler

• get scriptHandler(): any

Returns

any

Inherited from

ModelsDatastoreDB.scriptHandler

Defined in

packages/bpmn-server/src/server/ServerComponent.ts:26

Methods

import

▸ import(data, owner?): Promise\<any>

Parameters

Name	Type	Default value
data	any	undefined
owner	any	null

Returns

Promise\<any>

Implementation of

IModelsDatastore.import

Overrides

ModelsDatastoreDB.import

Defined in

packages/bpmn-server/src/datastore/ModelsDatastore.ts:21

---

getList

▸ getList(query?): Promise\<string[]>

Parameters

Name	Type	Default value
query	any	null

Returns

Promise\<string[]>

Implementation of

IModelsDatastore.getList

Overrides

ModelsDatastoreDB.getList

Defined in

packages/bpmn-server/src/datastore/ModelsDatastore.ts:26

---

getPath

▸ getPath(name, type, owner?): string

Parameters

Name	Type	Default value
name	any	undefined
type	any	undefined
owner	any	null

Returns

string

Defined in

packages/bpmn-server/src/datastore/ModelsDatastore.ts:63

---

getFile

▸ getFile(name, type, owner?): Promise\<any>

A model file's text; null only when it does not exist (an unreadable file throws).

Parameters

Name	Type	Default value
name	any	undefined
type	any	undefined
owner	any	null

Returns

Promise\<any>

Defined in

packages/bpmn-server/src/datastore/ModelsDatastore.ts:69

---

saveFile

▸ saveFile(name, type, data, owner?): Promise\<void>

Writes a model file whole or not at all: to a temporary file beside it, then renamed over it.

Parameters

Name	Type	Default value
name	any	undefined
type	any	undefined
data	any	undefined
owner	any	null

Returns

Promise\<void>

Defined in

packages/bpmn-server/src/datastore/ModelsDatastore.ts:81

---

getSource

▸ getSource(name, owner?): Promise\<string>

Parameters

Name	Type	Default value
name	any	undefined
owner	any	null

Returns

Promise\<string>

Implementation of

IModelsDatastore.getSource

Overrides

ModelsDatastoreDB.getSource

Defined in

packages/bpmn-server/src/datastore/ModelsDatastore.ts:89

---

getSVG

▸ getSVG(name, owner?): Promise\<string>

The model's diagram, or null when it has none (the SVG is optional).

Parameters

Name	Type	Default value
name	any	undefined
owner	any	null

Returns

Promise\<string>

Implementation of

IModelsDatastore.getSVG

Overrides

ModelsDatastoreDB.getSVG

Defined in

packages/bpmn-server/src/datastore/ModelsDatastore.ts:97

---

before

▸ before(file): Promise\<{ source: string ; savedAt: Date }>

The model's file and its time before a save: kept first when the model has no history yet.

Parameters

Name	Type
file	string

Returns

Promise\<{ source: string ; savedAt: Date }>

Defined in

packages/bpmn-server/src/datastore/ModelsDatastore.ts:105

---

keepVersion

▸ keepVersion(history, name, bpmn, savedBy, before): Promise\<void>

Keeps a save in the model's history; a history that can not be written does not fail the save.

Parameters

Name	Type
history	ModelHistory
name	any
bpmn	any
savedBy	any
before	any

Returns

Promise\<void>

Defined in

packages/bpmn-server/src/datastore/ModelsDatastore.ts:120

---

save

▸ save(name, bpmn, svg?, owner?, savedBy?): Promise\<boolean>

Saves the model; savedBy (a user name) is kept with the version in its history.

Parameters

Name	Type	Default value
name	any	undefined
bpmn	any	undefined
svg?	any	undefined
owner	any	null
savedBy?	string	undefined

Returns

Promise\<boolean>

Implementation of

IModelsDatastore.save

Overrides

ModelsDatastoreDB.save

Defined in

packages/bpmn-server/src/datastore/ModelsDatastore.ts:132

---

history

▸ history(name): Promise\<IModelVersion[]>

The model's saved versions, newest first.

Parameters

Name	Type
name	string

Returns

Promise\<IModelVersion[]>

Implementation of

IModelsDatastore.history

Defined in

packages/bpmn-server/src/datastore/ModelsDatastore.ts:147

---

historySource

▸ historySource(name, version): Promise\<string>

A saved version of the model, or null.

Parameters

Name	Type
name	string
version	number

Returns

Promise\<string>

Implementation of

IModelsDatastore.historySource

Defined in

packages/bpmn-server/src/datastore/ModelsDatastore.ts:151

---

deleteVersion

▸ deleteVersion(name, version): Promise\<boolean>

Removes one saved version of the model; false when there is none.

Parameters

Name	Type
name	string
version	number

Returns

Promise\<boolean>

Implementation of

IModelsDatastore.deleteVersion

Defined in

packages/bpmn-server/src/datastore/ModelsDatastore.ts:155

---

purgeHistory

▸ purgeHistory(name): Promise\<number>

Removes the model's history; returns how many versions it had.

Parameters

Name	Type
name	string

Returns

Promise\<number>

Implementation of

IModelsDatastore.purgeHistory

Defined in

packages/bpmn-server/src/datastore/ModelsDatastore.ts:159

---

deleteModel

▸ deleteModel(name, owner?): Promise\<void>

Parameters

Name	Type	Default value
name	any	undefined
owner	any	null

Returns

Promise\<void>

Implementation of

IModelsDatastore.deleteModel

Overrides

ModelsDatastoreDB.deleteModel

Defined in

packages/bpmn-server/src/datastore/ModelsDatastore.ts:163

---

renameModel

▸ renameModel(name, newName, owner?): Promise\<boolean>

Parameters

Name	Type	Default value
name	any	undefined
newName	any	undefined
owner	any	null

Returns

Promise\<boolean>

Implementation of

IModelsDatastore.renameModel

Overrides

ModelsDatastoreDB.renameModel

Defined in

packages/bpmn-server/src/datastore/ModelsDatastore.ts:172

---

rebuild

▸ rebuild(model?): Promise\<void>

reconstruct the models database from files

use when modifying the files manually or importing new environment

Parameters

Name	Type	Default value
model	any	null

Returns

Promise\<void>

Implementation of

IModelsDatastore.rebuild

Overrides

ModelsDatastoreDB.rebuild

Defined in

packages/bpmn-server/src/datastore/ModelsDatastore.ts:189

---

rebuildModel

▸ rebuildModel(name): Promise\<void>

Parameters

Name	Type
name	any

Returns

Promise\<void>

Defined in

packages/bpmn-server/src/datastore/ModelsDatastore.ts:231

---

close

▸ close(): Promise\<void>

Returns

Promise\<void>

Inherited from

ModelsDatastoreDB.close

Defined in

packages/bpmn-server/src/datastore/ModelsDatastoreDB.ts:34

---

backup

▸ backup(): Promise\<Record\<string, any[]>>

Every document of the models and events collections, by collection name: for a backup.

Returns

Promise\<Record\<string, any[]>>

Implementation of

IModelsDatastore.backup

Inherited from

ModelsDatastoreDB.backup

Defined in

packages/bpmn-server/src/datastore/ModelsDatastoreDB.ts:38

---

get

▸ get(query?): Promise\<object[]>

Parameters

Name	Type
query	Object

Returns

Promise\<object[]>

Implementation of

IModelsDatastore.get

Inherited from

ModelsDatastoreDB.get

Defined in

packages/bpmn-server/src/datastore/ModelsDatastoreDB.ts:44

---

loadFromInstance

▸ loadFromInstance(instance, owner?): Promise\<Definition>

load definition for instance

Parameters

Name	Type	Default value
instance	any	undefined
owner	any	null

Returns

Promise\<Definition>

Inherited from

ModelsDatastoreDB.loadFromInstance

Defined in

packages/bpmn-server/src/datastore/ModelsDatastoreDB.ts:67

---

load

▸ load(name, owner?): Promise\<Definition>

Parameters

Name	Type	Default value
name	any	undefined
owner	any	null

Returns

Promise\<Definition>

Implementation of

IModelsDatastore.load

Inherited from

ModelsDatastoreDB.load

Defined in

packages/bpmn-server/src/datastore/ModelsDatastoreDB.ts:80

---

loadDefinition

▸ loadDefinition(name, source): Promise\<Definition>

Parameters

Name	Type
name	any
source	any

Returns

Promise\<Definition>

Inherited from

ModelsDatastoreDB.loadDefinition

Defined in

packages/bpmn-server/src/datastore/ModelsDatastoreDB.ts:86

---

loadModel

▸ loadModel(name, owner?): Promise\<BpmnModelData>

Parameters

Name	Type	Default value
name	any	undefined
owner	any	null

Returns

Promise\<BpmnModelData>

Implementation of

IModelsDatastore.loadModel

Inherited from

ModelsDatastoreDB.loadModel

Defined in

packages/bpmn-server/src/datastore/ModelsDatastoreDB.ts:107

---

findEvents

▸ findEvents(query, owner?): Promise\<IEventData[]>

Parameters

Name	Type	Default value
query	any	undefined
owner	any	null

Returns

Promise\<IEventData[]>

Implementation of

IModelsDatastore.findEvents

Inherited from

ModelsDatastoreDB.findEvents

Defined in

packages/bpmn-server/src/datastore/ModelsDatastoreDB.ts:137

---

install

▸ install(): Promise\<any>

first time installation of DB

creates a new collection and add an index

Returns

Promise\<any>

Implementation of

IModelsDatastore.install

Inherited from

ModelsDatastoreDB.install

Defined in

packages/bpmn-server/src/datastore/ModelsDatastoreDB.ts:197

---

updateTimer

▸ updateTimer(name, owner?): Promise\<boolean>

Parameters

Name	Type	Default value
name	any	undefined
owner	any	null

Returns

Promise\<boolean>

Inherited from

ModelsDatastoreDB.updateTimer

Defined in

packages/bpmn-server/src/datastore/ModelsDatastoreDB.ts:204

---

saveModel

▸ saveModel(model, owner?): Promise\<boolean>

Parameters

Name	Type	Default value
model	IBpmnModelData	undefined
owner	any	null

Returns

Promise\<boolean>

Implementation of

IModelsDatastore.saveModel

Inherited from

ModelsDatastoreDB.saveModel

Defined in

packages/bpmn-server/src/datastore/ModelsDatastoreDB.ts:230

---

export

▸ export(name, folderPath, owner?): Promise\<void>

Parameters

Name	Type	Default value
name	any	undefined
folderPath	any	undefined
owner	any	null

Returns

Promise\<void>

Inherited from

ModelsDatastoreDB.export

Defined in

packages/bpmn-server/src/datastore/ModelsDatastoreDB.ts:273

Comments