@reldens/skills 0.21.0 → 0.23.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/lib/class-path.js CHANGED
@@ -38,8 +38,9 @@ class ClassPath extends LevelsSet
38
38
 
39
39
  getCurrentLabel()
40
40
  {
41
- return sc.hasOwn(this.labelsByLevel, this.currentLevel) ?
42
- this.labelsByLevel[this.currentLevel] : this.loopLevelsForLabel();
41
+ return sc.hasOwn(this.labelsByLevel, this.currentLevel)
42
+ ? this.labelsByLevel[this.currentLevel]
43
+ : this.loopLevelsForLabel();
43
44
  }
44
45
 
45
46
  loopLevelsForLabel()
@@ -100,7 +101,7 @@ class ClassPath extends LevelsSet
100
101
 
101
102
  async setOwnerSkills(skills)
102
103
  {
103
- if(skills) {
104
+ if(skills){
104
105
  this.currentSkills = skills;
105
106
  return;
106
107
  }
@@ -68,8 +68,8 @@ class Receiver
68
68
  Logger.error('Skills action not found', message.act);
69
69
  return false;
70
70
  }
71
- if('function' !== typeof this[this.actions[message.act]]){
72
- // for now I'm leaving this a silent return (will probably end up making the error log configurable):
71
+ if(!sc.isFunction(this[this.actions[message.act]])){
72
+ // for now, I'm leaving this a silent return (will probably end up making the error log configurable):
73
73
  Logger.error('Skills action is not a function', message.act);
74
74
  return false;
75
75
  }
package/lib/levels-set.js CHANGED
@@ -233,10 +233,16 @@ class LevelsSet
233
233
  return sc.get(this.owner, 'eventsPrefix', 'skills.ownerId.'+this.getOwnerId());
234
234
  }
235
235
 
236
+ getOwnerUniqueEventKey(suffix)
237
+ {
238
+ let uniqueKey = sc.isFunction(this.owner.eventUniqueKey)
239
+ ? this.owner.eventUniqueKey()
240
+ : 'skills.ownerId.'+this.getOwnerId()+'.uKey.'+sc.getTime();
241
+ return uniqueKey+(suffix ? '.'+suffix : '');
242
+ }
243
+
236
244
  async fireEvent(eventName, ...args)
237
245
  {
238
- // @NOTE: we append the current level set owner ID to the event name so we can pick up this event only for this
239
- // owner automatically:
240
246
  return await this.events.emit(this.eventFullName(eventName), ...args);
241
247
  }
242
248
 
@@ -247,6 +253,8 @@ class LevelsSet
247
253
 
248
254
  eventFullName(eventName)
249
255
  {
256
+ // @NOTE: appending the level set owner ID to the event name, so we can pick up this event only for this
257
+ // owner automatically:
250
258
  return this.getOwnerEventKey()+'.'+eventName;
251
259
  }
252
260
 
@@ -11,12 +11,11 @@ class DataServerValidator
11
11
 
12
12
  static getValidDataServer(props)
13
13
  {
14
- // @TODO - BETA - When moving to ES or TS dataServer will be typed and an interface.
15
14
  let dataServer = sc.get(props, 'dataServer', false);
16
15
  if(false === dataServer){
17
16
  ErrorManager.error('Data Server instance not found.', props);
18
17
  }
19
- if('function' !== typeof dataServer.connect || 'function' !== typeof dataServer.generateEntities){
18
+ if(!sc.isFunction(dataServer.connect) || !sc.isFunction(dataServer.generateEntities)){
20
19
  ErrorManager.error(
21
20
  'Data Server property found but the instance required methods are not available.',
22
21
  dataServer
@@ -6,41 +6,66 @@
6
6
 
7
7
  const SkillsConst = require('../constants');
8
8
  const SkillsEvents = require('../skills-events');
9
- const { ErrorManager } = require('@reldens/utils');
9
+ const { Logger, sc } = require('@reldens/utils');
10
10
 
11
11
  class Sender
12
12
  {
13
13
 
14
14
  constructor(classPath, client = false)
15
15
  {
16
- if(!client){
17
- ErrorManager.error('Undefined client for Sender.');
18
- }
19
16
  this.classPath = classPath;
20
17
  this.client = client;
21
18
  }
22
19
 
20
+ validateClient()
21
+ {
22
+ if(!this.client){
23
+ Logger.critical('Undefined client for Sender.');
24
+ return false;
25
+ }
26
+ return true;
27
+ }
28
+
23
29
  registerListeners()
24
30
  {
25
- this.classPath.listenEvent(SkillsEvents.INIT_CLASS_PATH_END, async (classPath) => {
26
- await this.onInitClassPathEndSend(classPath);
27
- }, 'initClassPathEndSender', this.getEventMasterKey());
28
- this.classPath.listenEvent(SkillsEvents.LEVEL_UP, async (classPath) => {
29
- await this.onLevelUpSend(classPath);
30
- }, 'levelUpSender', this.getEventMasterKey());
31
- this.classPath.listenEvent(SkillsEvents.LEVEL_EXPERIENCE_ADDED, async (classPath) => {
32
- await this.onLevelExperienceAddedSend(classPath);
33
- }, 'expAddSender', this.getEventMasterKey());
34
- this.classPath.listenEvent(SkillsEvents.SKILL_BEFORE_CAST, async (skill, target) => {
35
- await this.onSkillBeforeCastSend(skill, target);
36
- }, 'skillBeforeCastSender', this.getEventMasterKey());
37
- this.classPath.listenEvent(SkillsEvents.SKILL_ATTACK_APPLY_DAMAGE, async (skill, target, damage, newValue) => {
38
- await this.onSkillAttachApplyDamage(skill, target, damage, newValue);
39
- }, 'skillAttackApplyDamageSender', this.getEventMasterKey());
31
+ if(!this.validateClient()){
32
+ return;
33
+ }
34
+ let ownerEventKey = this.classPath.getOwnerEventKey();
35
+ this.classPath.listenEvent(
36
+ SkillsEvents.INIT_CLASS_PATH_END,
37
+ this.sendInitClassPathData.bind(this),
38
+ this.classPath.getOwnerUniqueEventKey('initClassPathEndSender'),
39
+ ownerEventKey
40
+ );
41
+ this.classPath.listenEvent(
42
+ SkillsEvents.LEVEL_UP,
43
+ this.sendLevelUpData.bind(this),
44
+ this.classPath.getOwnerUniqueEventKey('levelUpSender'),
45
+ ownerEventKey
46
+ );
47
+ this.classPath.listenEvent(
48
+ SkillsEvents.LEVEL_EXPERIENCE_ADDED,
49
+ this.sendLevelExperienceAdded.bind(this),
50
+ this.classPath.getOwnerUniqueEventKey('expAddSender'),
51
+ ownerEventKey
52
+ );
53
+ this.classPath.listenEvent(
54
+ SkillsEvents.SKILL_BEFORE_CAST,
55
+ this.sendSkillBeforeCastData.bind(this),
56
+ this.classPath.getOwnerUniqueEventKey('skillBeforeCastSender'),
57
+ ownerEventKey
58
+ );
59
+ this.classPath.listenEvent(
60
+ SkillsEvents.SKILL_ATTACK_APPLY_DAMAGE,
61
+ this.sendSkillAttackApplyDamage.bind(this),
62
+ this.classPath.getOwnerUniqueEventKey('skillAttackApplyDamageSender'),
63
+ ownerEventKey
64
+ );
40
65
  // @TODO - BETA - Skill cast and damage were missing, do we need to include other events?
41
66
  }
42
67
 
43
- async onInitClassPathEndSend(classPath)
68
+ async sendInitClassPathData(classPath)
44
69
  {
45
70
  let messageData = {
46
71
  lvl: classPath.currentLevel,
@@ -65,7 +90,7 @@ class Sender
65
90
  );
66
91
  }
67
92
 
68
- async onLevelUpSend(classPath)
93
+ async sendLevelUpData(classPath)
69
94
  {
70
95
  let messageData = {
71
96
  lvl: classPath.currentLevel,
@@ -88,7 +113,7 @@ class Sender
88
113
  );
89
114
  }
90
115
 
91
- async onLevelExperienceAddedSend(classPath)
116
+ async sendLevelExperienceAdded(classPath)
92
117
  {
93
118
  let messageData = {
94
119
  exp: classPath.currentExp
@@ -101,14 +126,14 @@ class Sender
101
126
  );
102
127
  }
103
128
 
104
- async onSkillBeforeCastSend(skill, target)
129
+ async sendSkillBeforeCastData(skill, target)
105
130
  {
106
131
  let messageData = Object.assign({
107
132
  skillKey: skill.key
108
133
  },
109
134
  skill.owner.getPosition()
110
135
  );
111
- if(typeof skill.owner.getSkillExtraData === 'function'){
136
+ if(sc.isFunction(skill.owner.getSkillExtraData)){
112
137
  Object.assign(messageData, {extraData: skill.owner.getSkillExtraData({skill, target})});
113
138
  }
114
139
  await this.runBehaviors(
@@ -119,10 +144,10 @@ class Sender
119
144
  );
120
145
  }
121
146
 
122
- async onSkillAttachApplyDamage(skill, target, damage, newValue)
147
+ async sendSkillAttackApplyDamage(skill, target, damage, newValue)
123
148
  {
124
149
  let messageData = {d: damage};
125
- if(typeof skill.owner.getSkillExtraData === 'function'){
150
+ if(sc.isFunction(skill.owner.getSkillExtraData)){
126
151
  Object.assign(messageData, {extraData: skill.owner.getSkillExtraData({skill, target})});
127
152
  }
128
153
  await this.runBehaviors(
@@ -139,7 +164,7 @@ class Sender
139
164
  // which fires the event for every player then we need to check if the current event fired was related to the
140
165
  // current player.
141
166
  if(this.classPath.getOwnerId() !== ownerId){
142
- ErrorManager.error('IF YOU SEE THIS, SOMETHING IS REALLY WRONG WITH THE SKILL EVENTS.');
167
+ Logger.critical('Skill owners miss match, please review.');
143
168
  return false;
144
169
  }
145
170
  if(behavior === SkillsConst.BEHAVIOR_BROADCAST || behavior === SkillsConst.BEHAVIOR_BOTH){
@@ -150,11 +175,6 @@ class Sender
150
175
  }
151
176
  }
152
177
 
153
- getEventMasterKey()
154
- {
155
- return this.classPath.getOwnerEventKey();
156
- }
157
-
158
178
  }
159
179
 
160
180
  module.exports = Sender;
@@ -13,7 +13,7 @@ class ClassPathGenerator
13
13
 
14
14
  static fromClassPathModels(classPathModels, classPathClasses)
15
15
  {
16
- if(!sc.isArray(classPathModels) || 0 === classPathModels.length) {
16
+ if(!sc.isArray(classPathModels) || 0 === classPathModels.length){
17
17
  return {};
18
18
  }
19
19
  let classPathsById = {};
@@ -16,7 +16,7 @@ class ConditionsGenerator
16
16
  return [];
17
17
  }
18
18
  let conditions = [];
19
- for (let conditionModel of conditionsModels) {
19
+ for(let conditionModel of conditionsModels){
20
20
  conditionModel['propertyKey'] = conditionModel['property_key'];
21
21
  let condition = new Condition(conditionModel);
22
22
  conditions.push(condition);
@@ -20,7 +20,7 @@ class ClassPathLevelLabelsModel extends ObjectionJsRawModel
20
20
  const { ClassPathModel } = require('./class-path-model');
21
21
  const { LevelModel } = require('./level-model');
22
22
  return {
23
- class_path_id: {
23
+ class_path: {
24
24
  relation: this.BelongsToOneRelation,
25
25
  modelClass: ClassPathModel,
26
26
  join: {
@@ -21,7 +21,7 @@ class ClassPathLevelSkillsModel extends ObjectionJsRawModel
21
21
  const { LevelModel } = require('./level-model');
22
22
  const { SkillModel } = require('./skill-model');
23
23
  return {
24
- class_path_id: {
24
+ class_path: {
25
25
  relation: this.BelongsToOneRelation,
26
26
  modelClass: ClassPathModel,
27
27
  join: {
@@ -20,7 +20,7 @@ class LevelModel extends ObjectionJsRawModel
20
20
  const { LevelsSetModel } = require('./levels-set-model');
21
21
  const { LevelModifiersModel } = require('./level-modifiers-model');
22
22
  return {
23
- level_set_id: {
23
+ level_set: {
24
24
  relation: this.BelongsToOneRelation,
25
25
  modelClass: LevelsSetModel,
26
26
  join: {
@@ -20,7 +20,7 @@ class LevelsSetModel extends ObjectionJsRawModel
20
20
  const { ClassPathModel } = require('./class-path-model');
21
21
  const { LevelModel } = require('./level-model');
22
22
  return {
23
- class_path_id: {
23
+ class_path: {
24
24
  relation: this.BelongsToOneRelation,
25
25
  modelClass: ClassPathModel,
26
26
  join: {
@@ -20,7 +20,7 @@ class SkillGroupRelationModel extends ObjectionJsRawModel
20
20
  const { SkillModel } = require('./skill-model');
21
21
  const { SkillsGroupsModel } = require('./skills-groups-model');
22
22
  return {
23
- skill_id: {
23
+ parent_skill: {
24
24
  relation: this.BelongsToOneRelation,
25
25
  modelClass: SkillModel,
26
26
  join: {
@@ -28,7 +28,7 @@ class SkillGroupRelationModel extends ObjectionJsRawModel
28
28
  to: SkillModel.tableName+'.id'
29
29
  }
30
30
  },
31
- group_id: {
31
+ parent_group: {
32
32
  relation: this.BelongsToOneRelation,
33
33
  modelClass: SkillsGroupsModel,
34
34
  join: {
@@ -19,7 +19,7 @@ class SkillOwnerConditionsModel extends ObjectionJsRawModel
19
19
  {
20
20
  const { SkillModel } = require('./skill-model');
21
21
  return {
22
- level_id: {
22
+ parent_level: {
23
23
  relation: this.BelongsToOneRelation,
24
24
  modelClass: SkillModel,
25
25
  join: {
@@ -19,7 +19,7 @@ class SkillOwnerEffectsModel extends ObjectionJsRawModel
19
19
  {
20
20
  const { SkillModel } = require('./skill-model');
21
21
  return {
22
- level_id: {
22
+ parent_level: {
23
23
  relation: this.BelongsToOneRelation,
24
24
  modelClass: SkillModel,
25
25
  join: {
@@ -19,7 +19,7 @@ class SkillTargetEffectsModel extends ObjectionJsRawModel
19
19
  {
20
20
  const { SkillModel } = require('./skill-model');
21
21
  return {
22
- skill_id: {
22
+ parent_skill: {
23
23
  relation: this.BelongsToOneRelation,
24
24
  modelClass: SkillModel,
25
25
  join: {
@@ -19,7 +19,7 @@ class SkillsGroupsModel extends ObjectionJsRawModel
19
19
  {
20
20
  const { SkillGroupRelationModel } = require('./skill-group-relation-model');
21
21
  return {
22
- group_id: {
22
+ parent_group: {
23
23
  relation: this.BelongsToOneRelation,
24
24
  modelClass: SkillGroupRelationModel,
25
25
  join: {
@@ -14,7 +14,7 @@ class ModelsManager
14
14
 
15
15
  constructor(props)
16
16
  {
17
- this.dataServer = DataServerValidator.getValidDataServer(props, this);
17
+ this.dataServer = DataServerValidator.getValidDataServer(props);
18
18
  this.events = (props && sc.hasOwn(props, 'events')) ? props.events : EventsManagerSingleton;
19
19
  }
20
20
 
@@ -16,7 +16,7 @@ class ModifiersGenerator
16
16
  return [];
17
17
  }
18
18
  let modifiers = [];
19
- for (let modifierModel of modifiersModels) {
19
+ for(let modifierModel of modifiersModels){
20
20
  let modifier = new Modifier(modifierModel);
21
21
  modifiers.push(modifier);
22
22
  }
@@ -22,7 +22,7 @@ class StorageObserver
22
22
  if(this.classPath.events){
23
23
  modelsManagerConfig['events'] = this.classPath.events;
24
24
  }
25
- this.dataServer = DataServerValidator.getValidDataServer(props, this);
25
+ this.dataServer = DataServerValidator.getValidDataServer(props);
26
26
  modelsManagerConfig['dataServer'] = this.dataServer;
27
27
  this.modelsManager = sc.isTrue(props, 'modelsManager') // @NOTE: can't use getDef because it could be false.
28
28
  ? props.modelsManager
@@ -35,24 +35,55 @@ class StorageObserver
35
35
  registerListeners()
36
36
  {
37
37
  let ownerEventKey = this.classPath.getOwnerEventKey();
38
- this.classPath.listenEvent(SkillsEvents.LEVEL_UP, async (levelsSet) => {
39
- await this.modelsManager.updateLevel(levelsSet);
40
- await levelsSet.owner.persistData();
41
- }, 'levelUpStorage', ownerEventKey);
42
- this.classPath.listenEvent(SkillsEvents.LEVEL_EXPERIENCE_ADDED, async (levelsSet) => {
43
- return this.modelsManager.updateExperience(levelsSet);
44
- }, 'expAddStorage', ownerEventKey);
45
- // eslint-disable-next-line no-unused-vars
46
- this.classPath.listenEvent(SkillsEvents.SKILL_APPLY_OWNER_EFFECTS, async (skill, target) => {
47
- await skill.owner.persistData();
48
- }, 'applyOwnerEffectsStorage', ownerEventKey);
49
- this.classPath.listenEvent(SkillsEvents.SKILL_EFFECT_TARGET_MODIFIERS, async (skill) => {
50
- if(skill.target && typeof skill.target.persistData === 'function'){
51
- await skill.target.persistData();
52
- }
53
- }, 'applyTargetEffectsStorage', ownerEventKey);
38
+ this.classPath.listenEvent(
39
+ SkillsEvents.LEVEL_UP,
40
+ this.saveLevelUpData.bind(this),
41
+ this.classPath.getOwnerUniqueEventKey('levelUpStorage'),
42
+ ownerEventKey
43
+ );
44
+ this.classPath.listenEvent(
45
+ SkillsEvents.LEVEL_EXPERIENCE_ADDED,
46
+ this.updateExperience.bind(this),
47
+ this.classPath.getOwnerUniqueEventKey('expAddStorage'),
48
+ ownerEventKey
49
+ );
50
+ this.classPath.listenEvent(
51
+ SkillsEvents.SKILL_APPLY_OWNER_EFFECTS,
52
+ this.saveOwnerData.bind(this),
53
+ this.classPath.getOwnerUniqueEventKey('applyOwnerEffectsStorage'),
54
+ ownerEventKey
55
+ );
56
+ this.classPath.listenEvent(
57
+ SkillsEvents.SKILL_EFFECT_TARGET_MODIFIERS,
58
+ this.saveTargetData.bind(this),
59
+ this.classPath.getOwnerUniqueEventKey('applyTargetEffectsStorage'),
60
+ ownerEventKey
61
+ );
54
62
  }
55
63
 
64
+ async saveTargetData(skill)
65
+ {
66
+ if(!sc.isFunction(skill?.target?.persistData)){
67
+ return false;
68
+ }
69
+ return await skill.target.persistData();
70
+ }
71
+
72
+ async saveOwnerData(skill)
73
+ {
74
+ return await skill.owner.persistData();
75
+ }
76
+
77
+ async updateExperience(levelsSet)
78
+ {
79
+ return await this.modelsManager.updateExperience(levelsSet);
80
+ }
81
+
82
+ async saveLevelUpData(levelsSet)
83
+ {
84
+ await this.modelsManager.updateLevel(levelsSet);
85
+ return await levelsSet.owner.persistData();
86
+ }
56
87
  }
57
88
 
58
89
  module.exports.StorageObserver = StorageObserver;
package/lib/server.js CHANGED
@@ -8,18 +8,29 @@ const ClassPath = require('./class-path');
8
8
  const Sender = require('./server/sender');
9
9
  const { StorageObserver } = require('./server/storage-observer');
10
10
  const { DataServerValidator } = require('./server/data-server-validator');
11
- const { ErrorManager, sc, Logger} = require('@reldens/utils');
11
+ const { Logger, sc } = require('@reldens/utils');
12
12
 
13
13
  class SkillsServer
14
14
  {
15
15
 
16
16
  constructor(props)
17
+ {
18
+ this.classPath = false;
19
+ this.dataServer = false;
20
+ this.storageObserver = false;
21
+ this.client = false;
22
+ this.setupServer(props);
23
+ }
24
+
25
+ setupServer(props)
17
26
  {
18
27
  if(!sc.hasOwn(props, 'owner')){
19
- ErrorManager.error('Undefined owner.');
28
+ Logger.critical('Undefined owner.');
29
+ return false;
20
30
  }
21
31
  if(typeof props.owner.getPosition !== 'function'){
22
- ErrorManager.error('Undefined owner position method.');
32
+ Logger.critical('Undefined owner position method.');
33
+ return false;
23
34
  }
24
35
  this.classPath = sc.hasOwn(props, 'classPath') ? props.classPath : new ClassPath(props);
25
36
  this.classPath.setOwner(props);
@@ -27,9 +38,10 @@ class SkillsServer
27
38
  if(sc.isTrue(props, 'persistence')){
28
39
  // check if the owner has the required persisData methods in the case the storage is active:
29
40
  if(!sc.hasOwn(props.owner, 'persistData') || typeof props.owner.persistData !== 'function'){
30
- ErrorManager.error('Required method "persistData" not found in SkillsServer props.owner.');
41
+ Logger.critical('Required method "persistData" not found in SkillsServer props.owner.');
42
+ return false;
31
43
  }
32
- this.dataServer = DataServerValidator.getValidDataServer(props, this);
44
+ this.dataServer = DataServerValidator.getValidDataServer(props);
33
45
  let storageObserverProps = {
34
46
  classPath: this.classPath,
35
47
  dataServer: this.dataServer
@@ -42,21 +54,23 @@ class SkillsServer
42
54
  this.storageObserver.registerListeners();
43
55
  }
44
56
  if(sc.hasOwn(props, 'client')){
45
- // @NOTE: client must implement the sent method with will be used to send the current action parameters.
57
+ // @NOTE: client must implement the "send" method which will be used to send the current action data.
46
58
  if(typeof props.client.send !== 'function'){
47
- ErrorManager.error('Required method "send" not found in SkillsServer props.client.');
59
+ Logger.critical('Required method "send" not found in SkillsServer props.client.');
60
+ return false;
48
61
  }
49
62
  if(typeof props.client.broadcast !== 'function'){
50
- ErrorManager.error('Property "broadcast" found in SkillsServer props.client but is not a function.');
63
+ Logger.critical('Property "broadcast" found in SkillsServer props.client but is not a function.');
64
+ return false;
51
65
  }
52
66
  this.client = new Sender(this.classPath, props.client);
53
67
  this.client.registerListeners();
54
68
  }
55
69
  this.classPath.init(props).catch((err) => {
56
- ErrorManager.error('Broken class. '+err);
70
+ Logger.critical('Broken class. '+err);
71
+ return false;
57
72
  });
58
73
  }
59
-
60
74
  }
61
75
 
62
76
  module.exports = SkillsServer;
package/lib/skill.js CHANGED
@@ -294,6 +294,15 @@ class Skill
294
294
  return sc.get(this.owner, 'eventsPrefix', 'skill.ownerId.'+this.getOwnerId());
295
295
  }
296
296
 
297
+ getOwnerUniqueEventKey(suffix)
298
+ {
299
+ let uniqueKey = sc.isFunction(this.owner.eventUniqueKey)
300
+ ? this.owner.eventUniqueKey()
301
+ : 'skills.ownerId.' + this.getOwnerId() + '.uKey.' + sc.getTime();
302
+ return uniqueKey+(suffix ? '.'+suffix : '');
303
+ }
304
+
305
+
297
306
  async fireEvent(eventName, ...args)
298
307
  {
299
308
  // @NOTE: we append the current level set owner ID to the event name, so we can pick up this event only for
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@reldens/skills",
3
3
  "scope": "@reldens",
4
- "version": "0.21.0",
4
+ "version": "0.23.0",
5
5
  "description": "Reldens - Skills",
6
6
  "author": "Damian A. Pastorini",
7
7
  "license": "MIT",
@@ -42,6 +42,6 @@
42
42
  "dependencies": {
43
43
  "@reldens/modifiers": "^0.21.0",
44
44
  "@reldens/storage": "^0.19.0",
45
- "@reldens/utils": "^0.22.0"
45
+ "@reldens/utils": "^0.23.0"
46
46
  }
47
47
  }