ProductivityEstimation

Type parameters

▪ T: SuperConstructor

Hierarchy

Process
↳ ProductivityEstimation

Implements

Controller
Stateful
Definable
Hookable
Ejsonable
Statusful
Entity
EventSourceable

Index

Constructors

constructor

Properties

Accessors

Methods

Object literals

STATES

Constructors

constructor

+ new ProductivityEstimation(arg: History | Command‹object› | Event‹object› | Props): ProductivityEstimation

Inherited from CancelingEmployment.constructor

Overrides void

Creates an instance of Process. Flows:

Replay History - Process is recreated from History instance - list of Events(manual initialization and replay is required before running Aggregate.prototype.replayHistory!).
Command|Event - Command or Event instance is passed as initializing message and Process has assigned id from it.
Properties - Process is deserialized, so props as object are passed.

example

new Process(
 new History([
   new Event({targetId: 'my-id', key: 'value'})
 ])
);
new Process(new Command({targetId: 'my-id', key: 'value'}));
new Process(new Event({targetId: 'my-id', key: 'value'}));
new Process({id: 'my-id'}); // 3
new Process({id: 'my-id', key: 'value'}); // 3

throws {InvalidInitializingMessageError} Thrown if provided initializing message is not instance of Command or Event.

Parameters:

Name	Type	Description
`arg`	History \| Command‹object› \| Event‹object› \| Props	Instance of: `History`, `Command`, `Event` or properties.

Returns: ProductivityEstimation

Properties

[COMMANDS_KEY]

• [COMMANDS_KEY]: Command[]

Inherited from CancelingEmployment.[COMMANDS_KEY]

Overrides void

[EVENTS_KEY]

• [EVENTS_KEY]: Event[]

Inherited from CancelingEmployment.[EVENTS_KEY]

Overrides void

employeeId

• employeeId: Guid

estimatedPoints

• estimatedPoints: number

id

• id: string | Guid

Inherited from CancelingEmployment.id

Overrides void

`Optional` metadata

• metadata? : Record‹string, any›

Inherited from CancelingEmployment.metadata

Overrides void

`Optional` schemaVersion

• schemaVersion? : number

Inherited from CancelingEmployment.schemaVersion

Overrides void

state

• state: State

Inherited from CancelingEmployment.state

Overrides void

status

• status: Status

Inherited from CancelingEmployment.status

Overrides void

taskId

• taskId: Guid

version

• version: number

Inherited from CancelingEmployment.version

Overrides void

`Static` `Optional` correlationKey

▪ correlationKey? : string

Inherited from CancelingEmployment.correlationKey

Accessors

ableTo

• get ableTo(): this

Inherited from Task.ableTo

Method to enforce TypeScript compliance with Asserter and AbilityAssertion.

Returns: this

can

• get can(): any

Inherited from Task.can

Evaluates if action can be taken on Entity. Prior to invocation of any non-assertion methods snapshot of current state is done - that will be automatically rollbacked after method execution. Proxified instance wraps the executed method and ensures that boolean is returned as result indicating if method indeed can be executed(true) - or fail with thrown error(false)

Returns: any

Proxified instance of Entity.

ensure

• get ensure(): this & object

Inherited from Task.ensure

Exposes the ensure BDD assertion for Entity.

remarks The entity.ensure getter-method will return a Proxified instance of the Entity. This proxified instance listens to all get methods and catches the requested method name.

If the requested get method/property name matches exactly or partially one of registered apis on Asserter(like: is) it returns associated object assigned to that assertion. Like for example - for registered AbilityAssertion, calling entity with:

entity.ensure.is

Will result with returned object:

{ableTo: ...}

That can be called like:

entity.ensure.is.ableTo.doAction(...)

Same rules of behavior will apply to other assertions like: StatefulAssertion, StatusfulAssertion.

However, since we want to enable an expressive apis on Entities - we allow users to defined their own apis. By calling:

entity.ensure.myMethod()

A backup of the entity state will be created that will be rollbacked directly * after the invocation of the method(and that will happen automatically) (it behaves exactly like ensure.is.ableTo assertion from AbilityAssertion)

This allows for evaluation of state change on command handlers directly without writing unnecessary duplicated code that would ensure that state indeed can be changed(first method) and then actually change it(second method).

Returns: this & object

Proxified instance of Entity.

is

• get is(): this & object

Inherited from Task.is

Method to enforce TypeScript compliance with Asserter and AbilityAssertion.

Returns: this & object

Methods

DomainException

▸ DomainException(exception: DomainException): void

Parameters:

Name	Type
`exception`	DomainException

Returns: void

EmployeeProductivityEstimated

▸ EmployeeProductivityEstimated(_event: EmployeeProductivityEstimated): void

Parameters:

Name	Type
`_event`	EmployeeProductivityEstimated

Returns: void

ProductivityEstimationCompleted

▸ ProductivityEstimationCompleted(_event: ProductivityEstimationCompleted): void

Parameters:

Name	Type
`_event`	ProductivityEstimationCompleted

Returns: void

ProductivityEstimationFailed

▸ ProductivityEstimationFailed(_event: ProductivityEstimationFailed): void

Parameters:

Name	Type
`_event`	ProductivityEstimationFailed

Returns: void

ProductivityEstimationInitiated

▸ ProductivityEstimationInitiated(event: ProductivityEstimationInitiated): void

Parameters:

Name	Type
`event`	ProductivityEstimationInitiated

Returns: void

TaskCompleted

▸ TaskCompleted(event: TaskCompleted): void

Parameters:

Name	Type
`event`	TaskCompleted

Returns: void

[ROLLBACK_STATE_METHOD_KEY]

▸ [ROLLBACK_STATE_METHOD_KEY](): void

Inherited from Task.[ROLLBACK_STATE_METHOD_KEY]

Rollbacks entity to previous state.

throws {SavedStateNotFoundError} Thrown if rollback is done on Entity without prior saved state.

Returns: void

[SAVE_STATE_METHOD_KEY]

▸ [SAVE_STATE_METHOD_KEY](): void

Inherited from Task.[SAVE_STATE_METHOD_KEY]

Saves current entity state.

Returns: void

assignMetadata

▸ assignMetadata(metadata: Record‹string, any›): void

Inherited from CancelingEmployment.assignMetadata

Attaches metadata to EventSourceable.

Parameters:

Name	Type
`metadata`	Record‹string, any›

Returns: void

commandProps

▸ commandProps(): object

Inherited from CancelingEmployment.commandProps

Picks base properties(timestamp & metadata) for new Command instance.

example

this.trigger(new MyCommand({
  ...this.commandProps(),
  customerName: command.customerName,
}));

Returns: object

Returns properties for Command instance.

metadata: Record‹string, any›
timestamp: Date

ensureHandleability

▸ ensureHandleability(messageType: MessageType‹Message›, handleableTypes: MessageType‹Message› | MessageType‹Message›[]): boolean

Inherited from CancelingEmployment.ensureHandleability

Ensures that provided type can be handled by verifying it against handleable types.

throws {UnhandleableTypeError} Thrown if message type is not one of handleable types.

Parameters:

Name	Type	Default	Description
`messageType`	MessageType‹Message›	-	Type implementing `MessageableType` interface.
`handleableTypes`	MessageType‹Message› \| MessageType‹Message›[]	this.getHandleableTypes()	Optional handleable types to be verified against on runtime.

Returns: boolean

Returns true if type is handleable, else false.

equals

▸ equals(otherEntity: Entity): boolean

Inherited from Task.equals

Overrides CreateEmployee.equals

Evaluates if one entity is equal to other by its constructor and identifier.

Parameters:

Name	Type	Description
`otherEntity`	Entity	Other `Entity` instance.

Returns: boolean

Returns true if both Entities instances are equal, else false.

eventProps

▸ eventProps(): object

Inherited from CancelingEmployment.eventProps

Picks base properties(sourceId, timestamp, metadata, version) for new Event instance.

example

this.record(new MyEvent({
  ...this.eventProps(),
  customerName: command.customerName,
}));

Returns: object

Returns properties for Event instance.

metadata: Record‹string, any›
sourceId: Guid | string
timestamp: Date
version: number

getActions

▸ getActions(): Actions

Inherited from CreateEmployee.getActions

Returns a collection of all available actions with matching registered hooks as nested collection.

Returns: Actions

Collection of actions(key) with matching registered hooks as nested collection(value).

getCommands

▸ getCommands(): Command[]

Inherited from CancelingEmployment.getCommands

Returns triggered commands on EventSourceable.

Returns: Command[]

List of recorded Commands.

getCorrelationKey

▸ getCorrelationKey(): string

Inherited from CancelingEmployment.getCorrelationKey

Returns correlation key for Process.

Returns: string

Custom predefined correlation key or Process type name.

getEvents

▸ getEvents(): Event[]

Inherited from CancelingEmployment.getEvents

Returns recorded events on EventSourceable.

Returns: Event[]

List of recorded Events.

getHandleableTypes

▸ getHandleableTypes(): MessageType‹Message›[]

Inherited from CancelingEmployment.getHandleableTypes

Returns handleable message types.

Returns: MessageType‹Message›[]

Returns handleable message types as a list with message types.

getHandled

▸ getHandled(messageType: MessageType‹Message›): MessageType‹Message›[]

Inherited from CancelingEmployment.getHandled

Returns all message types that matches evaluated one by equal constructor or subclassing.

Parameters:

Name	Type	Description
`messageType`	MessageType‹Message›	Type implementing `MessageableType` interface.

Returns: MessageType‹Message›[]

List of all handled types matching evaluated one.

getHandledCommands

▸ getHandledCommands(): MessageType‹Command›[]

Inherited from CancelingEmployment.getHandledCommands

Returns all commands that can be handled.

Returns: MessageType‹Command›[]

List of all handled types matching Command.

getHandledEvents

▸ getHandledEvents(): MessageType‹Event›[]

Inherited from CancelingEmployment.getHandledEvents

Returns all commands that can be handled.

Returns: MessageType‹Event›[]

List of all handled types matching Event.

getHandledMessages

▸ getHandledMessages(): MessageType‹Message›[]

Inherited from CancelingEmployment.getHandledMessages

Returns all messages that can be handled.

Returns: MessageType‹Message›[]

List of all handled types matching Message.

getHandledTypes

▸ getHandledTypes(): MessageType‹Message›[]

Inherited from CancelingEmployment.getHandledTypes

Returns all handled message types.

Returns: MessageType‹Message›[]

List of all handled message types.

getHandledTypesNames

▸ getHandledTypesNames(): TypeName[]

Inherited from CancelingEmployment.getHandledTypesNames

Returns all type names that can be handled.

Returns: TypeName[]

List of all handled type names

getHandler

▸ getHandler(messageType: MessageType‹Message›): Handler | undefined

Inherited from CancelingEmployment.getHandler

Returns handler for message type.

throws {InvalidMessageableType} Thrown if the message type argument is not implementing Messageable interface.

Parameters:

Name	Type	Description
`messageType`	MessageType‹Message›	Type implementing `MessageableType` interface.

Returns: Handler | undefined

Handler as a function if found, else undefined.

getHandlerOrThrow

▸ getHandlerOrThrow(messageType: MessageType‹Message›): Handler

Inherited from CancelingEmployment.getHandlerOrThrow

Return handler for message type or throws error if not found.

throws {HandlerNotFoundError} Thrown if handler for message type is not found.

Parameters:

Name	Type	Description
`messageType`	MessageType‹Message›	Type implementing `MessageableType` interface.

Returns: Handler

Handler as a function if found, else throws.

getHandlers

▸ getHandlers(): Map‹MessageType‹Message›, Handler | Handler[]›

Inherited from CancelingEmployment.getHandlers

Returns all available handler mappings.

Returns: Map‹MessageType‹Message›, Handler | Handler[]›

Returns mappings of all available handlers by message type: handler(s) relation.

getHook

▸ getHook(action: string, id: string): Hook | undefined

Inherited from CreateEmployee.getHook

Returns hook for action and id.

example

class MyClass extends HookableMixin {}

const hook = sinon.spy();
MyClass.prototype.registerHook('onConstruction', 'my-hook', hook);

expect(MyClass.prototype.getHook('onConstruction', 'my-hook')).to.be.equal(hook);

Parameters:

Name	Type	Description
`action`	string	Action for which hook is resolved.
`id`	string	Identifier under which hook was was registered.

Returns: Hook | undefined

Hook as a function matching declaration, else undefined.

getHookOrThrow

▸ getHookOrThrow(action: string, id: string): Hook

Inherited from CreateEmployee.getHookOrThrow

Returns hook for action and id or throws.

throws {HandlerNotFoundError} Thrown if there is no hook registered for action with id.

Parameters:

Name	Type	Description
`action`	string	Action for which hook is resolved.
`id`	string	Identifier under which hook was was registered.

Returns: Hook

Hook as a function matching declaration, else throws.

getHooks

▸ getHooks(action: string): Mappings

Inherited from CreateEmployee.getHooks

Returns a collection of all available hooks registered for action.

Parameters:

Name	Type	Description
`action`	string	Action for which hooks are resolved.

Returns: Mappings

Collection of hooks.

getId

▸ getId(): string | Guid

Inherited from Task.getId

Returns identifier for Entity.

Returns: string | Guid

Entities identifier as Guid instance or string.

getLegacyTransformer

▸ getLegacyTransformer(schemaVersion: number): Hook

Inherited from CreateEmployee.getLegacyTransformer

Returns legacy transformer for schema version.

throws {LegacyTransformerNotFoundError} Thrown if transformer for schema version can't be found.

Parameters:

Name	Type	Description
`schemaVersion`	number	Schema version.

Returns: Hook

Legacy transformer for schema version.

getLegacyTransformers

▸ getLegacyTransformers(): LegacyTransformers

Inherited from CreateEmployee.getLegacyTransformers

Returns all available legacy transformers.

Returns: LegacyTransformers

Map instance of all registered legacy transformers with number version as a key and transformer function as a value.

getPropTypes

▸ getPropTypes(): Props

Inherited from CreateEmployee.getPropTypes

Returns class properties types from whole inheritance tree.

example

@define()
class MyClass extends DefinableMixin {
  stringKey: string

  constructor(props: Record<keyof any, any>) {
    super()
    Object.assign(this, props);
  }
}

expect(new MyClass({stringKey: 'my-string'}).getPropTypes()).to.be.eql({
  stringKey: PropTypes.instanceOf(String)
})

Returns: Props

Plain object representation of properties types.

getPropertyInitializers

▸ getPropertyInitializers(): Props

Inherited from CreateEmployee.getPropertyInitializers

Returns default values metadata from property initializers conversion for whole inheritance tree.

example

@define()
class MyClass extends Struct {
  stringKey = 'my-string';

  numberKey = 1337;

  constructor(props: Partial<MyClass>) {
    super();
    Object.assign(this, this.processProps(props));
  }
}

expect(new MyClass().getPropertyInitializers()).to.be.eql({
  stringKey: 'my-string',
  numberKey: 1337
})

Returns: Props

Default values for properties.

getSchemaVersion

▸ getSchemaVersion(): number | undefined

Inherited from CreateEmployee.getSchemaVersion

Returns current instance schema version.

Returns: number | undefined

Schema version as a number, else undefined.

getSelectableStates

▸ getSelectableStates(): Record‹string, State›

Inherited from Task.getSelectableStates

Returns all selectable states.

Returns: Record‹string, State›

Collection of available states.

getSelectableStatuses

▸ getSelectableStatuses(): Record‹string, Status›

Inherited from Task.getSelectableStatuses

Returns all selectable status.

Returns: Record‹string, Status›

Collection of available status.

getState

▸ getState(): State

Inherited from Task.getState

Returns current state of instance.

Returns: State

Current state of instance as string.

getStatus

▸ getStatus(): Status

Inherited from Task.getStatus

Returns current status of instance.

Returns: Status

Current status of instance as string.

getTypeByHandler

▸ getTypeByHandler(handlerReference: Handler): any | undefined

Inherited from CancelingEmployment.getTypeByHandler

Resolves message type by handler reference.

Parameters:

Name	Type	Description
`handlerReference`	Handler	Reference to handler function.

Returns: any | undefined

Message type if handler is matching one of handlers on class, else undefined.

getTypeName

▸ getTypeName(): TypeName

Inherited from CreateEmployee.getTypeName

Returns definable type name.

Returns: TypeName

Type name as a string.

getVersion

▸ getVersion(): number

Inherited from CancelingEmployment.getVersion

Returns current version of EventSourceable.

Returns: number

Current number version of instance.

handle

▸ handle(message: Command | Event): Promise‹any›

Inherited from CancelingEmployment.handle

Overrides void

Handles message.

async

throws {HandlerNotFoundError} Thrown if handler for type is not found.

Parameters:

Name	Type
`message`	Command \| Event

Returns: Promise‹any›

Instance of EventSourceable.

handles

▸ handles(): Map‹MessageType‹Command›, Handler›

Inherited from CancelingEmployment.handles

Returns all handled Command mappings.

example

class MyController extends HandlingMixin {
  initialize(): void {
    this.setupHandlers({
      handlers: this.handles(),
    });
  }
  // ...
  MyCommandHandlerMethod(@handle command: MyCommand): boolean {
    return command.key === 'my-string';
  }
}
const controller = new MyController();
controller.registerHandler = sinon.stub();
controller.initialize();

expect(controller.registerHandler).to.be.calledOnce;
expect(controller.registerHandler).to.be.calledWithExactly(
  MyCommand,
  controller.MyCommandHandlerMethod
);

Returns: Map‹MessageType‹Command›, Handler›

Returns all handled Command(s) defined with @handle annotation or allows developer to define manually handlers.

hasAction

▸ hasAction(action: string): boolean

Inherited from CreateEmployee.hasAction

Evaluates if hooks for action are registered.

Parameters:

Name	Type	Description
`action`	string	Action for which hook is existence is evaluated.

Returns: boolean

Returns true if hooks for action exists, else false.

hasHandler

▸ hasHandler(messageType: MessageType‹Message›): boolean

Inherited from CancelingEmployment.hasHandler

Evaluates if handler for message type is registered.

Parameters:

Name	Type	Description
`messageType`	MessageType‹Message›	Type implementing `MessageableType` interface.

Returns: boolean

Returns true if handler for message type is registered, else false.

hasHook

▸ hasHook(action: string, id: string): boolean

Inherited from CreateEmployee.hasHook

Evaluates if hook for action with id is registered.

Parameters:

Name	Type	Description
`action`	string	Action for which hook is existence is evaluated.
`id`	string	Identifier under which hook was was registered.

Returns: boolean

Returns true if hook exists, else false.

hasLegacyTransformer

▸ hasLegacyTransformer(schemaVersion: number): boolean

Inherited from CreateEmployee.hasLegacyTransformer

Evaluates is there is registered legacy transformer for schema version.

Parameters:

Name	Type	Description
`schemaVersion`	number	Schema version.

Returns: boolean

Returns true if legacy transformer for schema version is registered, else false.

hasState

▸ hasState(): boolean

Inherited from Task.hasState

Evaluates if target has state set on instance(is not nil).

Returns: boolean

Returns true if instance has state set(not nil), else false.

hasStatus

▸ hasStatus(): boolean

Inherited from Task.hasStatus

Evaluates if target has status set on instance(is not nil).

Returns: boolean

Returns true if instance has status set(not nil), else false.

in

▸ in‹T›(listName: string): List‹T›

Inherited from CreateEmployee.in

Returns List for Serializable array.

throws {InvalidListError} Thrown if the provided container name does not point to list of supported Serializables.

example

@define('Employee')
class Employee extends Serializable {
  id: string;
}
@define('Company')
class Company extends Serializable {
  employees: Employee[];
}

 const employees = [
  new Employee({ id: 'first' }),
  new Employee({ id: 'second' }),
];
const company = new Company({ employees });
expect(company.in<Employee>('employees')).to.be.instanceof(List);
expect(company.in<Employee>('employees')).to.have.length(2);
expect(company.in<Employee>('employees')).to.have.members(employees);

Type parameters:

▪ T

Parameters:

Name	Type	Description
`listName`	string	Property name of the `Serializable` list on this instance.

Returns: List‹T›

Instance of List implementation.

incrementVersion

▸ incrementVersion(): void

Inherited from CancelingEmployment.incrementVersion

Increments version of event sourceable.

Returns: void

initialize

▸ initialize(): Promise‹void›

Inherited from CancelingEmployment.initialize

Overrides void

Initializes EventSourceable.

Returns: Promise‹void›

isHandleabe

▸ isHandleabe(messageType: MessageType‹Message›, handleableTypes: MessageType‹Message› | MessageType‹Message›[]): boolean

Inherited from CancelingEmployment.isHandleabe

Evaluates if type can be handled.

Parameters:

Name	Type	Default	Description
`messageType`	MessageType‹Message›	-	Type implementing `MessageableType` interface.
`handleableTypes`	MessageType‹Message› \| MessageType‹Message›[]	this.getHandleableTypes()	Optional handleable types to be verified against on runtime.

Returns: boolean

Returns true if message type can be handled, else false.

isInOneOfStates

▸ isInOneOfStates(states: State | State[]): boolean

Inherited from Task.isInOneOfStates

Evaluates if target is in one of expected state.

Parameters:

Name	Type	Description
`states`	State \| State[]	Expected states in which one of instance should be.

Returns: boolean

Returns true if instance is in one of states, else false.

isInOneOfStatuses

▸ isInOneOfStatuses(status: Status | Status[]): boolean

Inherited from Task.isInOneOfStatuses

Evaluates if target is in one of expected status.

Parameters:

Name	Type	Description
`status`	Status \| Status[]	Expected status in which one of instance should be.

Returns: boolean

Returns true if instance is in one of status, else false.

isInState

▸ isInState(state: State | State[]): boolean

Inherited from Task.isInState

Evaluates if target is in expected state.

Parameters:

Name	Type	Description
`state`	State \| State[]	Expected state in which instance should be.

Returns: boolean

Returns true if instance is in state, else false.

isInStatus

▸ isInStatus(status: Status | Status[]): boolean

Inherited from Task.isInStatus

Evaluates if target is in expected status.

Parameters:

Name	Type	Description
`status`	Status \| Status[]	Expected status in which instance should be.

Returns: boolean

Returns true if instance is in status, else false.

isStateSaved

▸ isStateSaved(): boolean

Inherited from Task.isStateSaved

Evaluates if state of entity is saved.

Returns: boolean

Returns true if state of entity is saved, else false.

on

▸ on(action: string | Stringifiable): this

Inherited from Task.on

Sets current action for asserting state of Entity.

Parameters:

Name	Type	Description
`action`	string \| Stringifiable	Name of action to be taken or `Command` that is handled.

Returns: this

Instance implementing Asserter interface.

overrideHandler

▸ overrideHandler(messageType: MessageType‹Message›, handler: Handler): void

Inherited from CancelingEmployment.overrideHandler

Overrides already existing handler for message type.

Parameters:

Name	Type	Description
`messageType`	MessageType‹Message›	Type implementing `MessageableType` interface.
`handler`	Handler	Handler function that will executed upon handling message type.

Returns: void

overrideHook

▸ overrideHook(action: string, id: string, hook: Hook): void

Inherited from CreateEmployee.overrideHook

Overrides registered hook by action and id or registers a new one.

throws {InvalidHookActionError} Thrown if the the action argument is not a string.

throws {InvalidHookIdError} Thrown if the the id argument is not a string.

Parameters:

Name	Type	Description
`action`	string	Action for which hook will be registered(like `onConstruction`, `onSend`, `onPublish` etc.)
`id`	string	Identifier under which hook will be registered for further reference.
`hook`	Hook	Hook as a `function` matching declaration for required action that will be invoked upon action.

Returns: void

overrideLegacyTransformer

▸ overrideLegacyTransformer(schemaVersion: number, transformer: Hook): void

Inherited from CreateEmployee.overrideLegacyTransformer

Overrides registered transformer by schema version or registers a new one.

throws {InvalidSchemaVersionError} Thrown if the the schema version argument is not a number.

Parameters:

Name	Type	Description
`schemaVersion`	number	Schema version.
`transformer`	Hook	Transformer function.

Returns: void

processSerializableList

▸ processSerializableList(props: Props): Props

Inherited from CreateEmployee.processSerializableList

Processes properties for Serializable by wrapping each serializable list property with List .

Parameters:

Name	Type	Default	Description
`props`	Props	{}	Properties of the type required for construction.

Returns: Props

Processed properties with any registered onConstruction hooks and validates them against prop types.

record

▸ record(event: Event): void

Inherited from CancelingEmployment.record

Records state change of EventSourceable as Event and updates event sourceable version.

example

this.record(new MyEvent({
  sourceId: this.getId(),
  key: 'value'
});
this.record(new MyEvent({
  ...this.eventProps(),
  customerName: command.customerName,
}));

Parameters:

Name	Type	Description
`event`	Event	Instance of `Event`.

Returns: void

registerHandler

▸ registerHandler(messageType: MessageType‹Message›, handler: Handler, shouldOverride: boolean): void

Inherited from CancelingEmployment.registerHandler

Overrides void

Registers handler for message type.

throws {UnhandleableTypeError} Thrown if the type argument is not one of handleable types.

throws {InvalidHandlerError} Thrown if the handler argument is not a function.

throws {HandlerExistError} Thrown if handler would overridden without explicit call.

example

@define('MyCommand')
class MyCommand extends Command<MyCommand> {
  key: string;
}
define('MyOtherCommand')
class MyOtherCommand extends Command<MyOtherCommand> {
  key: string;
}

class MyClass extends OneToOneHandlingMixin {
  MyCommand(command: MyCommand): void {
    // ...
  }

  @handles()
  MyOtherCommand(command: MyOtherCommand): void {
    // ...
  }
}
const myClass = new MyClass();
// Defined externally or during construction
myClass.registerHandler(MyCommand, myClass.MyCommand);

Parameters:

Name	Type	Default	Description
`messageType`	MessageType‹Message›	-	Type implementing `MessageableType` interface.
`handler`	Handler	-	Handler function that will executed upon handling message type.
`shouldOverride`	boolean	false	Flag indicating that handler should be overridden if exist.

Returns: void

registerHook

▸ registerHook(action: string, id: string, hook: Hook, shouldOverride: boolean): void

Inherited from CreateEmployee.registerHook

Registers hook by action type and id.

throws {InvalidHookActionError} Thrown if the the action argument is not a string.

throws {InvalidHookIdError} Thrown if the the id argument is not a string.

throws {HookAlreadyExistsError} Thrown if the existing hook with id would be overridden.

example

import {expect} from 'chai';
import {HookableMixin} from 'eveble'

class Document extends HookableMixin {
  content: string;

  version: number;

  constructor(props: Record<keyof any, any>) {
    super();
    const processedProps = { ...props };

    const hooks = this.getHooks('onConstruction');
    for (const hook of Object.values(hooks)) {
      hook.bind(this)(processedProps);
    }
    Object.assign(this, processedProps);
  }
}

const versionable = (props: Record<keyof any, any>) => {
  if (props.version === undefined) {
    props.version = 0;
  }
  return props;
};
Document.prototype.registerHook('onConstruction', 'versionable', versionable);

const newDoc = new Document({ content: 'My document content' });
expect(newDoc.version).to.be.equal(0);

Parameters:

Name	Type	Default	Description
`action`	string	-	Action for which hook will be registered(like `onConstruction`, `onSend`, `onPublish` etc.)
`id`	string	-	Identifier under which hook will be registered for further reference.
`hook`	Hook	-	Hook as a `function` matching declaration for required action that will be invoked upon action.
`shouldOverride`	boolean	false	Flag indicating that hook should be overridden if exist.

Returns: void

registerLegacyTransformer

▸ registerLegacyTransformer(schemaVersion: number, transformer: Hook, shouldOverride: boolean): void

Inherited from CreateEmployee.registerLegacyTransformer

Registers legacy transformer for version.

throws {InvalidSchemaVersionError} Thrown if the the schema version argument is not a number.

throws {LegacyTransformerAlreadyExistsError} Thrown if transformer for version would overridden without explicit call.

Parameters:

Name	Type	Default	Description
`schemaVersion`	number	-	Schema version.
`transformer`	Hook	-	Transformer function.
`shouldOverride`	boolean	false	Flag indicating that transformer should be overridden if exist.

Returns: void

removeHandler

▸ removeHandler(messageType: MessageType‹Message›): void

Inherited from CancelingEmployment.removeHandler

Removes handler by type.

Parameters:

Name	Type	Description
`messageType`	MessageType‹Message›	Type implementing `MessageableType` interface.

Returns: void

removeHook

▸ removeHook(action: string, id: string): void

Inherited from CreateEmployee.removeHook

Removes a hook by action and id.

example

class MyClass extends HookableMixin {}

const hook = sinon.spy();
MyClass.prototype.registerHook('onConstruction', 'my-hook', hook);

MyClass.prototype.removeHook('onConstruction', 'my-hook')
expect(MyClass.prototype.getHook('onConstruction', 'my-hook')).to.be.undefined;

Parameters:

Name	Type	Description
`action`	string	Action for which hook is removed.
`id`	string	Identifier under which hook was was registered.

Returns: void

replay

▸ replay(event: Event): void

Inherited from CancelingEmployment.replay

Replies event and updates EventSourceable version.

Parameters:

Name	Type	Description
`event`	Event	Instance of `Event`.

Returns: void

replayHistory

▸ replayHistory(history: History): void

Inherited from CancelingEmployment.replayHistory

Replies history from list of events.

Parameters:

Name	Type	Description
`history`	History	Instance of `History` containing `Event` list.

Returns: void

schedule

▸ schedule(command: Command, deliverAt: Date, assignmentId: string | Guid): void

Inherited from CancelingEmployment.schedule

Schedules command to be delivered at specific time.

Parameters:

Name	Type	Default	Description
`command`	Command	-	`Command` instance.
`deliverAt`	Date	-	`Date` instance on which command should be delivered.
`assignmentId`	string \| Guid	this.getId()	Scheduling assignment identifer.

Returns: void

setHandleableTypes

▸ setHandleableTypes(handleableTypes: MessageType‹Message› | MessageType‹Message›[]): void

Inherited from CancelingEmployment.setHandleableTypes

Sets the only allowed handleable message types.

Parameters:

Name	Type	Description
`handleableTypes`	MessageType‹Message› \| MessageType‹Message›[]	List of allowed types for handling.

Returns: void

setState

▸ setState(state: State): void

Inherited from Task.setState

Sets instance state.

throws {ValidationError} Thrown if the provided state does not match one of the selectable states.

throws {UndefinedStatesError} Thrown if the instance does not have any states assigned.

Parameters:

Name	Type	Description
`state`	State	State to which instance should be set.

Returns: void

setStatus

▸ setStatus(status: Status): void

Inherited from Task.setStatus

Sets instance status.

throws {ValidationError} Thrown if the provided status does not match one of the selectable status.

throws {UndefinedStatusesError} Thrown if the instance does not have any status assigned.

Parameters:

Name	Type	Description
`status`	Status	Status to which instance should be set.

Returns: void

setVersion

▸ setVersion(version: number): void

Inherited from CancelingEmployment.setVersion

Sets version of EventSourceable.

Parameters:

Name	Type	Description
`version`	number	Version number.

Returns: void

Current number version of instance.

subscribes

▸ subscribes(): Map‹MessageType‹Event›, Handler›

Inherited from CancelingEmployment.subscribes

Returns all handled Event mappings.

example

class MyController extends HandlingMixin {
  initialize(): void {
    this.setupHandlers({
      handlers: this.subscribes(),
    });
  }
  // ...
  MyEventHandlerMethod(@subscribe event: MyEvent): boolean {
    return event.key === 'my-string';
  }
}
const controller = new MyController();
controller.registerHandler = sinon.stub();
controller.initialize();

expect(controller.registerHandler).to.be.calledOnce;
expect(controller.registerHandler).to.be.calledWithExactly(
  MyEvent,
  controller.MyEventHandlerMethod
);

Returns: Map‹MessageType‹Event›, Handler›

Returns all handled Events(s) defined with @subscribe annotation or allows developer to define manually handlers.

toJSONValue

▸ toJSONValue(): Record‹string, any›

Inherited from CreateEmployee.toJSONValue

Serializes value into a JSON-compatible value. It preserves all custom field types, however the initial value type is not saved.

example

@define('Address')
class Address extends Serializable {
  city: string;

  street: string;
}

@define('Person')
class Person extends Serializable {
  firstName: string;

  lastName: string;

  address?: Address;
}

const person = new Person({
  firstName: 'Jane',
  lastName: 'Doe',
  address: new Address({
    city: 'New York',
    street: 'Wall Street',
  }),
});

expect(person.toJSONValue()).to.be.eql({
  firstName: 'Jane',
  lastName: 'Doe',
  address: {
    city: 'New York',
    street: 'Wall Street',
  },
});

**Returns:** *Record‹string, any›*

Normalized value as JSON-compatible without type identifers.

___

###  toPlainObject

▸ **toPlainObject**(): *[Props](../modules/types.md#props)*

*Inherited from [CreateEmployee](createemployee.md).[toPlainObject](createemployee.md#toplainobject)*

Converts properties to plain object.

**`remarks`** 
**Loosing object references is required** since in scenarios when properties resolved
from `toPlainObject` are transformed - in such changes to the modified plain object
will cascade to original instance(**THIS** instance, since properties are **referenced**).

**`example`** 
```ts
@define()
class Point extends DefinableMixin {
  x: number;
  y: number;
  z: number;
}

const point = new Point({x: 1, y: 2, z: 3})
expect(point.toPlainObject()).to.be.eql({x: 1, y: 2, z: 3});

Returns: Props

Public properties with assigned values as plain object.

toString

▸ toString(): TypeName

Inherited from CreateEmployee.toString

Returns definable type name

Returns: TypeName

Type name as a string.

transformLegacyProps

▸ transformLegacyProps(props: Props): Props

Inherited from CreateEmployee.transformLegacyProps

Registrable hook for transforming legacy schema.

Parameters:

Name	Type	Description
`props`	Props	Properties object to be transformed.

Returns: Props

Transformed legacy properties or their unchanged state if up to date.

trigger

▸ trigger(command: Command): void

Inherited from CancelingEmployment.trigger

Adds Command instance to command that should be triggered.

Parameters:

Name	Type	Description
`command`	Command	Instance of `Command`.

Returns: void

typeName

▸ typeName(): TypeName

Inherited from CreateEmployee.typeName

alias getTypeName

remarks Compatibility for EJSON serializer: @eveble/ejson

Returns: TypeName

unschedule

▸ unschedule(assignmentId: string | Guid, commandType: MessageType‹Command›): void

Inherited from CancelingEmployment.unschedule

Unschedule delivery of a specific command by assignment specification.

Parameters:

Name	Type	Description
`assignmentId`	string \| Guid	Scheduling assignment identifer.
`commandType`	MessageType‹Command›	A `Command` type that should be unscheduled.

Returns: void

validateProps

▸ validateProps(props: Props, propTypes: PropTypes, isStrict: boolean): boolean

Inherited from CreateEmployee.validateProps

Validates if provided properties matches prop types.

throws {ValidationError} Thrown if the passed properties do not match prop types.

remarks Disabling of runtime validation is possible via Kernel's configuration(and by that env flags also) or by annotating class with @validable(false).

This is useful when there is external layer(like transportation) that does all the heavy lifting of validation and there are no other sources of incoming data beside points that is handled by layer.

Use env EVEBLE_VALIDATION_TYPE set to manual to disable validation on initialization. You ca re-enable it again on your application configuration via path validation.type set to runtime before staring application.

example

@define()
class MyClass extends DefinableMixin {
  stringKey: string

  constructor(props: Record<keyof any, any>) {
    super()
    Object.assign(this, props);
  }
}

const instance = new MyClass({stringKey: 'my-string'});
expect(
  () => instance.validateProps({stringKey: 1337}, this.getPropTypes())
).to.throw(ValidationError)

Parameters:

Name	Type	Default	Description
`props`	Props	{}	Properties to validate.
`propTypes`	PropTypes	-	Properties types.
`isStrict`	boolean	true	Flag indicating that validation should be done in strict mode.

Returns: boolean

Returns true if properties are valid, else throws.

validateState

▸ validateState(stateOrStates: State | State[], error?: Error): boolean

Inherited from Task.validateState

Validates if instance is in allowed state(s).

throws {InvalidStateError} Thrown if target is not in correct(one of allowed) state.

Parameters:

Name	Type	Description
`stateOrStates`	State \| State[]	Expected states list in one of which instance should be.
`error?`	Error	Optional error instance for case where state does not match expected one.

Returns: boolean

Returns true if instance is in correct state, else throws.

validateStatus

▸ validateStatus(statusOrStatuses: Status | Status[], error?: Error): boolean

Inherited from Task.validateStatus

Validates if instance is in allowed status(s).

throws {InvalidStatusError} Thrown if target is not in correct(one of allowed) status.

Parameters:

Name	Type	Description
`statusOrStatuses`	Status \| Status[]	Expected status list in one of which instance should be.
`error?`	Error	Optional error instance for case where status does not match expected one.

Returns: boolean

Returns true if instance is in correct status, else throws.

`Static` disableSerializableLists

▸ disableSerializableLists(): void

Inherited from CreateEmployee.disableSerializableLists

Disables conversion of serializable lists to List instances.

Returns: void

`Static` enableSerializableLists

▸ enableSerializableLists(): void

Inherited from CreateEmployee.enableSerializableLists

Enables conversion of serializable lists to List instances.

remarks Since using mixins with polytype on extendable classes like: Serializable, Entity, EventSourceable, ValueObject will result in loosing all registered hooks on metadata

this ensures that hook can be easily re-applied.

Returns: void

`Static` from

▸ from(...sources: Record‹string, any›[]): any

Inherited from CreateEmployee.from

Create an Serializable from multiple property sources. Have similar api like Object.assign.

throws {ValidationError} Thrown if the passed properties does not match serializeble's property types.

example

const props1 = {
  firstName: 'Jane',
  age: 28,
};
const props2 = {
  lastName: 'Doe',
  favoriteColor: 'black',
};
const props3 = {
  hobby: 'martial arts',
};
const person = Person.from(props1, props2, props3);
expect(person).to.be.instanceof(Person);
expect(person).to.be.eql({
  firstName: 'Jane',
  lastName: 'Doe',
});

Parameters:

Name	Type	Description
`...sources`	Record‹string, any›[]	One or more source of properties.

Returns: any

New instance of Serializable with assigned properties.

`Static` getCorrelationKey

▸ getCorrelationKey(): string

Inherited from CancelingEmployment.getCorrelationKey

Returns correlation key.

Returns: string

Custom predefined correlation key or Process type name.

`Static` getPropTypes

▸ getPropTypes(): Props

Inherited from CreateEmployee.getPropTypes

Returns class properties types from whole inheritance tree.

example

@define()
class MyClass extends DefinableMixin {
  stringKey: string

  constructor(props: Record<keyof any, any>) {
    super()
    Object.assign(this, props);
  }
}

expect(MyClass.getPropTypes()).to.be.eql({
  stringKey: PropTypes.instanceOf(String)
})

Returns: Props

Plain object representation of properties types.

`Static` getPropertyInitializers

▸ getPropertyInitializers(): Props

Inherited from CreateEmployee.getPropertyInitializers

Returns class property initializers for whole inheritance tree.

example

@define()
class MyClass extends Struct {
  stringKey = 'my-string';

  numberKey = 1337;

  constructor(props: Partial<MyClass>) {
    super();
    Object.assign(this, this.processProps(props));
  }
}

expect(MyClass.getPropertyInitializers()).to.be.eql({
  stringKey: 'my-string',
  numberKey: 1337
})

Returns: Props

Plain object representation of property initializers.

`Static` getTypeName

▸ getTypeName(): TypeName

Inherited from CreateEmployee.getTypeName

Returns definable type name.

Returns: TypeName

Type name as a string.

`Static` resolveInitializingMessage

▸ resolveInitializingMessage(): MessageType‹Command | Event› | undefined

Inherited from CancelingEmployment.resolveInitializingMessage

Resolves initializing message on EventSourceable.

Returns: MessageType‹Command | Event› | undefined

Command or Event type.

`Static` resolveRoutedCommands

▸ resolveRoutedCommands(): MessageType‹Command›[]

Inherited from CancelingEmployment.resolveRoutedCommands

Resolves routed commands.

Returns: MessageType‹Command›[]

List of all routed Command types.

`Static` resolveRoutedEvents

▸ resolveRoutedEvents(): MessageType‹Event›[]

Inherited from CancelingEmployment.resolveRoutedEvents

Resolves routed events.

Returns: MessageType‹Event›[]

List of all routed Event types.

`Static` resolveRoutedMessages

▸ resolveRoutedMessages(): MessageType‹Command | Event›[]

Inherited from CancelingEmployment.resolveRoutedMessages

Resolves routed messages.

Returns: MessageType‹Command | Event›[]

List of all routed messages types.

`Static` setCorrelationKey

▸ setCorrelationKey(key: string): void

Inherited from CancelingEmployment.setCorrelationKey

Sets correlation key.

Parameters:

Name	Type	Description
`key`	string	Key under which correlation will be set for `Process`.

Returns: void

`Static` toString

▸ toString(): TypeName

Inherited from CreateEmployee.toString

Returns definable type name

Returns: TypeName

Type name as a string.

`Static` typeName

▸ typeName(): TypeName

Inherited from CreateEmployee.typeName

alias getTypeName

remarks Compatibility for EJSON serializer: @eveble/ejson

Returns: TypeName

Object literals

`Static` STATES

▪ STATES: object

completed

• completed: string = "completed"

failed

• failed: string = "failed"

initiated

• initiated: string = "initiated"

Type parameters#

Hierarchy#

Implements#

Index#

Constructors#

Properties#

Accessors#

Methods#

Object literals#

Constructors#

constructor#

Properties#

[COMMANDS_KEY]#

[EVENTS_KEY]#

employeeId#

estimatedPoints#

id#

Optional metadata#

Optional schemaVersion#

state#

status#

taskId#

version#

Static Optional correlationKey#

Accessors#

ableTo#

can#

ensure#

is#

Methods#

DomainException#

EmployeeProductivityEstimated#

ProductivityEstimationCompleted#

ProductivityEstimationFailed#

ProductivityEstimationInitiated#

TaskCompleted#

[ROLLBACK_STATE_METHOD_KEY]#

[SAVE_STATE_METHOD_KEY]#

assignMetadata#

commandProps#

ensureHandleability#

equals#

eventProps#

getActions#

getCommands#

getCorrelationKey#

getEvents#

getHandleableTypes#

getHandled#

getHandledCommands#

getHandledEvents#

getHandledMessages#

getHandledTypes#

getHandledTypesNames#

getHandler#

getHandlerOrThrow#

getHandlers#

getHook#

getHookOrThrow#

getHooks#

getId#

getLegacyTransformer#

getLegacyTransformers#

getPropTypes#

getPropertyInitializers#

getSchemaVersion#

getSelectableStates#

getSelectableStatuses#

getState#

getStatus#

getTypeByHandler#

getTypeName#

getVersion#

handle#

handles#

hasAction#

hasHandler#

hasHook#

hasLegacyTransformer#

hasState#

Type parameters

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Object literals

Constructors

constructor

Properties

[COMMANDS_KEY]

[EVENTS_KEY]

employeeId

estimatedPoints

id

`Optional` metadata

`Optional` schemaVersion

state

status

taskId

version

`Static` `Optional` correlationKey

Accessors

ableTo

can

ensure

is

Methods

DomainException

EmployeeProductivityEstimated

ProductivityEstimationCompleted

ProductivityEstimationFailed

ProductivityEstimationInitiated

TaskCompleted

[ROLLBACK_STATE_METHOD_KEY]

[SAVE_STATE_METHOD_KEY]

assignMetadata

commandProps

ensureHandleability

equals

eventProps

getActions

getCommands

getCorrelationKey

getEvents

getHandleableTypes

getHandled

getHandledCommands

getHandledEvents

getHandledMessages

getHandledTypes

getHandledTypesNames

getHandler

getHandlerOrThrow

getHandlers

getHook

getHookOrThrow

getHooks

getId

getLegacyTransformer

getLegacyTransformers

getPropTypes

getPropertyInitializers

getSchemaVersion

getSelectableStates

getSelectableStatuses

getState

getStatus

getTypeByHandler

getTypeName

getVersion

handle

handles

hasAction

hasHandler

hasHook

hasLegacyTransformer

hasState