goblin-desktop 4.2.0 → 4.2.2

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.
Files changed (144) hide show
  1. package/.editorconfig +9 -9
  2. package/.zou-flow +2 -2
  3. package/LICENSE +21 -21
  4. package/README.md +108 -108
  5. package/builders/builders.js +3 -3
  6. package/builders/wizard.js +462 -462
  7. package/contexts.js +13 -13
  8. package/desktop-manager.js +10 -10
  9. package/desktop-window.js +13 -13
  10. package/desktop.js +13 -13
  11. package/eslint.config.js +65 -65
  12. package/lib/service.js +137 -137
  13. package/package.json +48 -48
  14. package/password-wizard.js +24 -24
  15. package/quest-run-wizard.js +24 -24
  16. package/taskbar.js +13 -13
  17. package/widgets/audio/sfx.js +177 -177
  18. package/widgets/board/view.js +37 -37
  19. package/widgets/board/widget.js +65 -65
  20. package/widgets/contexts/logic-handlers.js +36 -36
  21. package/widgets/contexts/service.js +40 -40
  22. package/widgets/contexts/view.js +21 -21
  23. package/widgets/contexts/widget.js +147 -147
  24. package/widgets/datagrid/datagrid-entity.js +82 -82
  25. package/widgets/datagrid/datagrid-headers.js +274 -274
  26. package/widgets/datagrid/styles.js +13 -13
  27. package/widgets/datagrid/widget.js +192 -192
  28. package/widgets/datagrid-cell/styles.js +52 -52
  29. package/widgets/datagrid-cell/widget.js +41 -41
  30. package/widgets/datagrid-item/styles.js +15 -15
  31. package/widgets/datagrid-item/widget.js +74 -74
  32. package/widgets/default/view.js +160 -160
  33. package/widgets/desktop/compensator.js +9 -9
  34. package/widgets/desktop/logic-handlers.js +243 -243
  35. package/widgets/desktop/reducer.js +35 -35
  36. package/widgets/desktop/service.js +858 -858
  37. package/widgets/desktop/styles.js +28 -28
  38. package/widgets/desktop/widget.js +191 -191
  39. package/widgets/desktop-clock/styles.js +69 -69
  40. package/widgets/desktop-clock/widget.js +387 -387
  41. package/widgets/desktop-clock-clock/styles.js +56 -56
  42. package/widgets/desktop-clock-clock/widget.js +96 -96
  43. package/widgets/desktop-clock-menu/styles.js +129 -129
  44. package/widgets/desktop-clock-menu/widget.js +63 -63
  45. package/widgets/desktop-connection-status/reducer.js +15 -15
  46. package/widgets/desktop-connection-status/styles.js +44 -44
  47. package/widgets/desktop-connection-status/widget.js +134 -134
  48. package/widgets/desktop-content/widget.js +68 -68
  49. package/widgets/desktop-footer/reducer.js +31 -31
  50. package/widgets/desktop-footer/styles.js +36 -36
  51. package/widgets/desktop-footer/widget.js +52 -52
  52. package/widgets/desktop-monitors/styles.js +155 -155
  53. package/widgets/desktop-monitors/widget.js +272 -272
  54. package/widgets/desktop-notebook/styles.js +155 -155
  55. package/widgets/desktop-notebook/widget.js +252 -252
  56. package/widgets/desktop-notifications/styles.js +147 -147
  57. package/widgets/desktop-notifications/widget.js +231 -231
  58. package/widgets/desktop-scale/reducer.js +15 -15
  59. package/widgets/desktop-scale/styles.js +49 -49
  60. package/widgets/desktop-scale/widget.js +173 -172
  61. package/widgets/desktop-state-monitor/styles.js +72 -72
  62. package/widgets/desktop-state-monitor/widget.js +123 -123
  63. package/widgets/desktop-taskbar/widget.js +57 -57
  64. package/widgets/desktop-themes-menu/widget.js +121 -121
  65. package/widgets/desktop-topbar/widget.js +201 -201
  66. package/widgets/desktop-window/service.js +56 -56
  67. package/widgets/desktop-window/styles.js +22 -22
  68. package/widgets/desktop-window/widget.js +70 -70
  69. package/widgets/detail/compensator.js +17 -17
  70. package/widgets/detail/view.js +40 -40
  71. package/widgets/detail/widget.js +119 -119
  72. package/widgets/editor/widget.js +82 -82
  73. package/widgets/entity-alerts/styles.js +77 -77
  74. package/widgets/entity-alerts/widget.js +328 -328
  75. package/widgets/entity-list/styles.js +66 -66
  76. package/widgets/entity-list/view.js +36 -36
  77. package/widgets/entity-list/widget.js +209 -209
  78. package/widgets/entity-list-item/widget.js +68 -68
  79. package/widgets/entity-row/styles.js +105 -105
  80. package/widgets/entity-row/widget.js +524 -524
  81. package/widgets/entity-row-button/styles.js +46 -46
  82. package/widgets/entity-row-button/widget.js +57 -57
  83. package/widgets/entity-view/reducer.js +20 -20
  84. package/widgets/entity-view/styles.js +90 -90
  85. package/widgets/entity-view/widget.js +601 -601
  86. package/widgets/facet-checkbox/styles.js +17 -17
  87. package/widgets/facet-checkbox/widget.js +43 -43
  88. package/widgets/facet-filter/widget.js +94 -94
  89. package/widgets/facet-filter-add/styles.js +30 -30
  90. package/widgets/facet-filter-add/widget.js +105 -105
  91. package/widgets/facet-filter-button/styles.js +74 -74
  92. package/widgets/facet-filter-button/widget.js +214 -214
  93. package/widgets/facet-filter-list-dialog/styles.js +59 -59
  94. package/widgets/facet-filter-list-dialog/widget.js +273 -273
  95. package/widgets/facet-filter-list-dialog-footer/styles.js +22 -22
  96. package/widgets/facet-filter-list-dialog-footer/widget.js +105 -105
  97. package/widgets/facet-filter-range-dialog/styles.js +82 -82
  98. package/widgets/facet-filter-range-dialog/widget.js +399 -399
  99. package/widgets/facet-filter-range-dialog-footer/styles.js +22 -22
  100. package/widgets/facet-filter-range-dialog-footer/widget.js +182 -182
  101. package/widgets/gamepad/widget.js +75 -75
  102. package/widgets/helpers/facet-helpers.js +105 -105
  103. package/widgets/hinter/reducer.js +35 -35
  104. package/widgets/hinter/styles.js +79 -79
  105. package/widgets/hinter/view.js +32 -32
  106. package/widgets/hinter/widget.js +289 -291
  107. package/widgets/junction/styles.js +22 -22
  108. package/widgets/junction/widget.js +50 -50
  109. package/widgets/main-tab-menu/styles.js +17 -17
  110. package/widgets/main-tab-menu/widget.js +130 -130
  111. package/widgets/map/view.js +49 -49
  112. package/widgets/map/widget.js +64 -64
  113. package/widgets/monitor/reducer.js +15 -15
  114. package/widgets/monitor/widget.js +60 -60
  115. package/widgets/navigating-layer/widget.js +25 -25
  116. package/widgets/notifications-button/widget.js +44 -44
  117. package/widgets/password-wizard/service.js +53 -53
  118. package/widgets/password-wizard/ui.js +66 -66
  119. package/widgets/plugin/reducer.js +19 -19
  120. package/widgets/plugin/styles.js +294 -294
  121. package/widgets/plugin/widget.js +622 -622
  122. package/widgets/quest-run-wizard/service.js +49 -49
  123. package/widgets/quest-run-wizard/ui.js +25 -25
  124. package/widgets/search/styles.js +80 -80
  125. package/widgets/search/widget.js +283 -285
  126. package/widgets/simple/view.js +28 -28
  127. package/widgets/status-filters/widget.js +121 -121
  128. package/widgets/tab/styles.js +16 -16
  129. package/widgets/tab/widget.js +89 -89
  130. package/widgets/tab-content/widget.js +35 -35
  131. package/widgets/tabs/widget.js +48 -48
  132. package/widgets/taskbar/service.js +99 -99
  133. package/widgets/taskbar/view.js +27 -27
  134. package/widgets/taskbar/widget.js +167 -167
  135. package/widgets/widget-doc-caller/reducer.js +15 -15
  136. package/widgets/widget-doc-caller/styles.js +20 -20
  137. package/widgets/widget-doc-caller/widget.js +55 -55
  138. package/widgets/wizard/widget.js +298 -298
  139. package/widgets/wizard-buttons/widget.js +111 -111
  140. package/widgets/workitem/styles.js +286 -286
  141. package/widgets/workitem/view.js +62 -62
  142. package/widgets/workitem/widget.js +988 -988
  143. package/widgets/workitem-dialog/widget.js +86 -86
  144. package/widgets/workitem-fields/widget.js +64 -64
@@ -1,462 +1,462 @@
1
- 'use strict';
2
- //T:2019-02-27
3
-
4
- const Goblin = require('xcraft-core-goblin');
5
- const T = require('goblin-nabu/widgets/helpers/t.js');
6
- const common = require('goblin-workshop').common;
7
- const Shredder = require('xcraft-core-shredder');
8
-
9
- const {OrderedMap, fromJS} = require('immutable');
10
-
11
- const defaultButtons = OrderedMap()
12
- .set(
13
- 'main',
14
- fromJS({
15
- glyph: 'solid/step-forward',
16
- text: T('Suivant', 'Bouton du wizard'),
17
- grow: '1',
18
- })
19
- )
20
- .set(
21
- 'cancel',
22
- fromJS({
23
- glyph: 'solid/times',
24
- text: T('Annuler', 'Bouton du wizard'),
25
- grow: '1',
26
- })
27
- );
28
-
29
- module.exports = (config) => {
30
- const {
31
- name,
32
- title,
33
- skills,
34
- dialog,
35
- steps,
36
- gadgets,
37
- quests,
38
- initialFormState,
39
- hinters,
40
- } = config;
41
- const goblinName = `${name}-wizard`;
42
- const wizardSteps = Object.keys(steps);
43
- const wizardFlow = ['init'].concat(wizardSteps);
44
- const hinterIdsByName = {};
45
- const hinterWidgetIdsByName = {};
46
- // Define logic handlers according rc.json
47
- const logicHandlers = {
48
- 'create': (state, action) => {
49
- const form = action.get('form');
50
- const initForm = action.get('initialFormState');
51
- const mergedInitialForm = Object.assign(initForm || {}, form || {});
52
- return state.set('', {
53
- id: action.get('id'),
54
- step: 'init',
55
- title: title,
56
- dialog: dialog || {
57
- width: '500px',
58
- },
59
- gadgets: action.get('wizardGadgets'),
60
- busy: true,
61
- buttons: defaultButtons,
62
- form: mergedInitialForm,
63
- });
64
- },
65
- 'init-wizard': (state) => {
66
- return state.set('step', '_goto').set('nextStep', wizardFlow[1]);
67
- },
68
- 'buttons': (state, action) => {
69
- return state.set('buttons', action.get('buttons'));
70
- },
71
- 'change': (state, action) => {
72
- return state.set(action.get('path'), action.get('newValue'));
73
- },
74
- 'apply': (state, action) => {
75
- return state.mergeDeep(action.get('path', ''), action.get('patch'));
76
- },
77
- 'back': (state) => {
78
- const c = state.get('step');
79
- const cIndex = wizardFlow.indexOf(c);
80
- if (cIndex === 0) {
81
- return state;
82
- }
83
- const nIndex = cIndex - 1;
84
- return state.set('step', '_goto').set('nextStep', wizardFlow[nIndex]);
85
- },
86
- 'next': (state, action) => {
87
- const c = state.get('step');
88
- if (c === 'done') {
89
- return state;
90
- }
91
-
92
- const cIndex = wizardFlow.indexOf(c);
93
- if (cIndex === wizardFlow.length - 1) {
94
- return state.set('result', action.get('result')).set('step', 'done');
95
- }
96
-
97
- const nIndex = cIndex + 1;
98
- const nextStep = wizardFlow[nIndex];
99
- return state.set('nextStep', nextStep).set('step', '_goto');
100
- },
101
- 'goto': (state, action) => {
102
- const step = action.get('step');
103
- return state.set('nextStep', step).set('step', '_goto');
104
- },
105
- '_goto': (state) => {
106
- const nextStep = state.get('nextStep');
107
- return state.set('step', nextStep).del('nextStep');
108
- },
109
- 'busy': (state) => {
110
- return state.set('busy', true);
111
- },
112
- 'idle': (state) => {
113
- return state.set('busy', false);
114
- },
115
- 'cancel': (state) => {
116
- return state.set('canceled', true).set('step', 'done');
117
- },
118
- };
119
-
120
- Goblin.registerQuest(
121
- goblinName,
122
- 'create',
123
- function* (quest, desktopId, form, isDialog) {
124
- const id = quest.goblin.id;
125
- quest.goblin.setX('desktopId', desktopId);
126
- quest.goblin.setX('isDialog', isDialog);
127
- quest.goblin.setX('isDisposing', false);
128
- const wizardGadgets = {};
129
-
130
- if (gadgets) {
131
- yield common.createGadgets(quest, goblinName, gadgets, wizardGadgets);
132
- }
133
- if (hinters) {
134
- yield quest.me.createHinters();
135
- }
136
-
137
- let running = 0;
138
-
139
- quest.goblin.defer(
140
- quest.sub.local(`*::${quest.goblin.id}.<wizard-tick>`, function* (
141
- err,
142
- {msg, resp}
143
- ) {
144
- const {calledFrom} = msg.data;
145
- const isInternal = calledFrom.split('.')[0] === quest.goblin.id;
146
- if (running > 0 && !isInternal) {
147
- return; /* Drop this tick because a step is already running */
148
- }
149
-
150
- try {
151
- ++running;
152
- const step = quest.goblin.getState().get('step');
153
- yield resp.cmd(`${goblinName}.${step}`, {id});
154
- } finally {
155
- --running;
156
- }
157
- })
158
- );
159
-
160
- quest.do({id: quest.goblin.id, initialFormState, form, wizardGadgets});
161
- yield quest.me.initWizard();
162
- yield quest.me.idle();
163
- return quest.goblin.id;
164
- },
165
- {skills: skills ?? []}
166
- );
167
-
168
- Goblin.registerQuest(goblinName, 'create-hinters', function* (quest) {
169
- if (!hinters) {
170
- return;
171
- }
172
-
173
- const desktopId = quest.goblin.getX('desktopId');
174
- const promises = [];
175
-
176
- Object.keys(hinters).forEach((h) => {
177
- let detailWidget = null;
178
- let hName = h;
179
-
180
- if (hinters[h].hinter) {
181
- hName = hinters[h].hinter;
182
- detailWidget = `${hName}-workitem`;
183
- }
184
- if (!quest.hasAPI(`${hName}-hinter`)) {
185
- return;
186
- }
187
-
188
- const id = `${hName}-hinter@${h}@${quest.goblin.id}`;
189
- const widgetId = `hinter@${hName}@${quest.goblin.id}`;
190
- hinterIdsByName[h] = id;
191
- hinterWidgetIdsByName[h] = widgetId;
192
- promises.push(
193
- quest.create(`${hName}-hinter`, {
194
- id,
195
- desktopId,
196
- hinterName: h,
197
- workitemId: quest.goblin.id,
198
- detailWidget,
199
- withDetails: true,
200
- })
201
- );
202
- });
203
-
204
- yield Promise.all(promises);
205
- });
206
-
207
- common.registerHinters(goblinName, hinters);
208
-
209
- Goblin.registerSafeQuest(goblinName, 'busy', function (quest) {
210
- quest.do();
211
- });
212
-
213
- Goblin.registerSafeQuest(goblinName, 'idle', function (quest) {
214
- quest.do();
215
- });
216
-
217
- if (gadgets) {
218
- for (const key of Object.keys(gadgets)) {
219
- //Gogo gadgeto stylo!
220
- Goblin.registerSafeQuest(goblinName, `use-${key}`, function* (
221
- quest,
222
- action,
223
- payload
224
- ) {
225
- const gadgetId = quest.goblin.getState().get(`gadgets.${key}.id`);
226
- const api = quest.getAPI(gadgetId);
227
- yield api[action](payload);
228
- });
229
-
230
- //Register gagdet quest handlers
231
-
232
- if (gadgets[key].onActions) {
233
- for (const handler of Object.keys(gadgets[key].onActions)) {
234
- const questName = common.jsifyQuestName(`${key}-${handler}`);
235
- logicHandlers[questName] = gadgets[key].onActions[handler];
236
-
237
- Goblin.registerSafeQuest(goblinName, questName, function* (quest) {
238
- quest.do();
239
- yield quest.me.update();
240
- });
241
- }
242
- }
243
- }
244
- }
245
-
246
- if (quests) {
247
- Object.keys(quests).forEach((q) => {
248
- Goblin.registerSafeQuest(goblinName, q, quests[q]);
249
- });
250
- }
251
-
252
- Goblin.registerSafeQuest(goblinName, 'init-wizard', function (quest) {
253
- quest.do();
254
- quest.evt('<wizard-tick>', {calledFrom: quest.calledFrom});
255
- });
256
-
257
- Goblin.registerSafeQuest(goblinName, 'next', function (quest, result) {
258
- quest.do();
259
- quest.evt('<wizard-tick>', {calledFrom: quest.calledFrom});
260
- return result;
261
- });
262
-
263
- Goblin.registerSafeQuest(goblinName, 'back', function (quest) {
264
- quest.do();
265
- quest.evt('<wizard-tick>', {calledFrom: quest.calledFrom});
266
- });
267
-
268
- Goblin.registerSafeQuest(goblinName, 'goto', function (quest, step) {
269
- quest.do();
270
- quest.evt('<wizard-tick>', {calledFrom: quest.calledFrom});
271
- });
272
-
273
- Goblin.registerSafeQuest(goblinName, '_goto', function* (quest) {
274
- const state = quest.goblin.getState();
275
- const form = state.get('form').toJS();
276
- const nextStep = state.get('nextStep');
277
-
278
- quest.dispatch(`init-${nextStep}`);
279
- quest.do();
280
-
281
- yield quest.me.updateButtons();
282
-
283
- if (quest.me[nextStep]) {
284
- try {
285
- yield quest.me.busy();
286
- yield quest.me[nextStep]({form});
287
- } finally {
288
- if (!quest.goblin.getX('isDisposing')) {
289
- yield quest.me.idle();
290
- }
291
- }
292
- }
293
- });
294
-
295
- Goblin.registerSafeQuest(goblinName, 'done', function* (quest) {
296
- let result = quest.goblin.getState().get('result');
297
- if (Shredder.isImmutable(result)) {
298
- result = result.toJS();
299
- }
300
- let payload = {finished: true, result};
301
- if (quest.goblin.getState().get('canceled')) {
302
- payload = quest.cancel();
303
- }
304
- quest.evt('done', payload);
305
- yield quest.me.dispose();
306
- });
307
-
308
- Goblin.registerSafeQuest(goblinName, 'cancel', function (quest) {
309
- quest.do();
310
- quest.evt('<wizard-tick>', {calledFrom: quest.calledFrom});
311
- });
312
-
313
- Goblin.registerSafeQuest(goblinName, 'change', function* (
314
- quest,
315
- path,
316
- newValue
317
- ) {
318
- if (hinters && hinters[path]) {
319
- return;
320
- }
321
- quest.do();
322
- yield quest.me.update();
323
- });
324
-
325
- Goblin.registerSafeQuest(goblinName, 'apply', function* (quest) {
326
- quest.do();
327
- yield quest.me.update();
328
- });
329
-
330
- Goblin.registerSafeQuest(goblinName, 'update', function* (quest) {
331
- const state = quest.goblin.getState();
332
- const stepName = state.get('step');
333
- const step = steps[stepName];
334
-
335
- if (step) {
336
- if (step.updateButtonsMode === 'onChange') {
337
- yield quest.me.updateButtons();
338
- }
339
- if (step.onChange) {
340
- const form = state.get('form');
341
- yield quest.me[`${stepName}OnChange`]({form});
342
- }
343
- }
344
- });
345
-
346
- Goblin.registerSafeQuest(goblinName, 'update-buttons', function* (quest) {
347
- const state = quest.goblin.getState();
348
- const stepName = state.get('step');
349
- const step = steps[stepName];
350
-
351
- if (step && step.buttons) {
352
- const form = state.get('form');
353
- const currentButtons = state.get('buttons');
354
- const newButtons = yield quest.me[`${stepName}Buttons`]({
355
- form,
356
- buttons: currentButtons,
357
- });
358
- quest.dispatch('buttons', {buttons: newButtons});
359
- }
360
- });
361
-
362
- // configure steps
363
- for (const stepName of wizardSteps) {
364
- const step = steps[stepName];
365
- logicHandlers[`init-${stepName}`] = (state) => {
366
- if (step.form) {
367
- return state.mergeDeep('form', step.form);
368
- }
369
- return state;
370
- };
371
- logicHandlers[stepName] = (state, action) => {
372
- return state.mergeDeep('form', action.get('form'));
373
- };
374
-
375
- if (step.quest) {
376
- Goblin.registerSafeQuest(goblinName, stepName, step.quest);
377
- }
378
-
379
- if (step.buttons) {
380
- Goblin.registerSafeQuest(goblinName, `${stepName}-buttons`, step.buttons);
381
- }
382
-
383
- if (step.onChange) {
384
- Goblin.registerSafeQuest(
385
- goblinName,
386
- `${stepName}-on-change`,
387
- step.onChange
388
- );
389
- }
390
-
391
- for (const action in step.actions) {
392
- const actionQuest = `${stepName}-${action}`;
393
- logicHandlers[actionQuest] = step.actions[action];
394
- Goblin.registerSafeQuest(goblinName, actionQuest, function (quest) {
395
- quest.do();
396
- });
397
- }
398
- }
399
-
400
- Goblin.registerSafeQuest(goblinName, 'get-entity', common.getEntityQuest);
401
- Goblin.registerSafeQuest(goblinName, 'load-entity', common.loadEntityQuest);
402
- Goblin.registerSafeQuest(goblinName, 'open-wizard', common.openWizard);
403
-
404
- Goblin.registerSafeQuest(goblinName, 'showHinter', function* (
405
- quest,
406
- type,
407
- withDetail = true
408
- ) {
409
- const hinterWidgetId = hinterWidgetIdsByName[type];
410
- const hinterAPI = quest.getAPI(hinterWidgetId).noThrow();
411
- yield hinterAPI.show();
412
- if (withDetail) {
413
- yield hinterAPI.showDetail();
414
- }
415
- });
416
-
417
- Goblin.registerSafeQuest(goblinName, 'hideHinter', function* (quest, type) {
418
- const hinterAPI = quest
419
- .getAPI(`${type}-hinter@${quest.goblin.id}`)
420
- .noThrow();
421
- yield hinterAPI.hide();
422
- });
423
-
424
- Goblin.registerSafeQuest(goblinName, 'setDetail', function* (
425
- quest,
426
- type,
427
- entityId
428
- ) {
429
- const hinterWidgetId = hinterWidgetIdsByName[type];
430
- const deskAPI = quest.getAPI(quest.getDesktop()).noThrow();
431
- yield deskAPI.setDetail({
432
- hinterId: hinterWidgetId,
433
- });
434
- const hinterAPI = quest.getAPI(hinterWidgetId).noThrow();
435
- yield hinterAPI.setCurrentDetailEntity({entityId});
436
- });
437
-
438
- function disposeQuest(quest) {
439
- if (quest.goblin.getX('isDisposing')) {
440
- return;
441
- }
442
-
443
- quest.goblin.setX('isDisposing', true);
444
-
445
- const desktopId = quest.goblin.getX('desktopId');
446
-
447
- quest.evt(`${desktopId}.<remove-workitem-requested>`, {
448
- workitemId: quest.goblin.id,
449
- close: false,
450
- navToLastWorkitem: true,
451
- });
452
- }
453
-
454
- Goblin.registerSafeQuest(goblinName, 'dispose', disposeQuest);
455
-
456
- Goblin.registerQuest(goblinName, 'delete', function (quest) {
457
- quest.evt('done', {finished: true});
458
- disposeQuest(quest);
459
- });
460
-
461
- return Goblin.configure(goblinName, {}, logicHandlers);
462
- };
1
+ 'use strict';
2
+ //T:2019-02-27
3
+
4
+ const Goblin = require('xcraft-core-goblin');
5
+ const T = require('goblin-nabu/widgets/helpers/t.js');
6
+ const common = require('goblin-workshop').common;
7
+ const Shredder = require('xcraft-core-shredder');
8
+
9
+ const {OrderedMap, fromJS} = require('immutable');
10
+
11
+ const defaultButtons = OrderedMap()
12
+ .set(
13
+ 'main',
14
+ fromJS({
15
+ glyph: 'solid/step-forward',
16
+ text: T('Suivant', 'Bouton du wizard'),
17
+ grow: '1',
18
+ })
19
+ )
20
+ .set(
21
+ 'cancel',
22
+ fromJS({
23
+ glyph: 'solid/times',
24
+ text: T('Annuler', 'Bouton du wizard'),
25
+ grow: '1',
26
+ })
27
+ );
28
+
29
+ module.exports = (config) => {
30
+ const {
31
+ name,
32
+ title,
33
+ skills,
34
+ dialog,
35
+ steps,
36
+ gadgets,
37
+ quests,
38
+ initialFormState,
39
+ hinters,
40
+ } = config;
41
+ const goblinName = `${name}-wizard`;
42
+ const wizardSteps = Object.keys(steps);
43
+ const wizardFlow = ['init'].concat(wizardSteps);
44
+ const hinterIdsByName = {};
45
+ const hinterWidgetIdsByName = {};
46
+ // Define logic handlers according rc.json
47
+ const logicHandlers = {
48
+ 'create': (state, action) => {
49
+ const form = action.get('form');
50
+ const initForm = action.get('initialFormState');
51
+ const mergedInitialForm = Object.assign(initForm || {}, form || {});
52
+ return state.set('', {
53
+ id: action.get('id'),
54
+ step: 'init',
55
+ title: title,
56
+ dialog: dialog || {
57
+ width: '500px',
58
+ },
59
+ gadgets: action.get('wizardGadgets'),
60
+ busy: true,
61
+ buttons: defaultButtons,
62
+ form: mergedInitialForm,
63
+ });
64
+ },
65
+ 'init-wizard': (state) => {
66
+ return state.set('step', '_goto').set('nextStep', wizardFlow[1]);
67
+ },
68
+ 'buttons': (state, action) => {
69
+ return state.set('buttons', action.get('buttons'));
70
+ },
71
+ 'change': (state, action) => {
72
+ return state.set(action.get('path'), action.get('newValue'));
73
+ },
74
+ 'apply': (state, action) => {
75
+ return state.mergeDeep(action.get('path', ''), action.get('patch'));
76
+ },
77
+ 'back': (state) => {
78
+ const c = state.get('step');
79
+ const cIndex = wizardFlow.indexOf(c);
80
+ if (cIndex === 0) {
81
+ return state;
82
+ }
83
+ const nIndex = cIndex - 1;
84
+ return state.set('step', '_goto').set('nextStep', wizardFlow[nIndex]);
85
+ },
86
+ 'next': (state, action) => {
87
+ const c = state.get('step');
88
+ if (c === 'done') {
89
+ return state;
90
+ }
91
+
92
+ const cIndex = wizardFlow.indexOf(c);
93
+ if (cIndex === wizardFlow.length - 1) {
94
+ return state.set('result', action.get('result')).set('step', 'done');
95
+ }
96
+
97
+ const nIndex = cIndex + 1;
98
+ const nextStep = wizardFlow[nIndex];
99
+ return state.set('nextStep', nextStep).set('step', '_goto');
100
+ },
101
+ 'goto': (state, action) => {
102
+ const step = action.get('step');
103
+ return state.set('nextStep', step).set('step', '_goto');
104
+ },
105
+ '_goto': (state) => {
106
+ const nextStep = state.get('nextStep');
107
+ return state.set('step', nextStep).del('nextStep');
108
+ },
109
+ 'busy': (state) => {
110
+ return state.set('busy', true);
111
+ },
112
+ 'idle': (state) => {
113
+ return state.set('busy', false);
114
+ },
115
+ 'cancel': (state) => {
116
+ return state.set('canceled', true).set('step', 'done');
117
+ },
118
+ };
119
+
120
+ Goblin.registerQuest(
121
+ goblinName,
122
+ 'create',
123
+ function* (quest, desktopId, form, isDialog) {
124
+ const id = quest.goblin.id;
125
+ quest.goblin.setX('desktopId', desktopId);
126
+ quest.goblin.setX('isDialog', isDialog);
127
+ quest.goblin.setX('isDisposing', false);
128
+ const wizardGadgets = {};
129
+
130
+ if (gadgets) {
131
+ yield common.createGadgets(quest, goblinName, gadgets, wizardGadgets);
132
+ }
133
+ if (hinters) {
134
+ yield quest.me.createHinters();
135
+ }
136
+
137
+ let running = 0;
138
+
139
+ quest.goblin.defer(
140
+ quest.sub.local(`*::${quest.goblin.id}.<wizard-tick>`, function* (
141
+ err,
142
+ {msg, resp}
143
+ ) {
144
+ const {calledFrom} = msg.data;
145
+ const isInternal = calledFrom.split('.')[0] === quest.goblin.id;
146
+ if (running > 0 && !isInternal) {
147
+ return; /* Drop this tick because a step is already running */
148
+ }
149
+
150
+ try {
151
+ ++running;
152
+ const step = quest.goblin.getState().get('step');
153
+ yield resp.cmd(`${goblinName}.${step}`, {id});
154
+ } finally {
155
+ --running;
156
+ }
157
+ })
158
+ );
159
+
160
+ quest.do({id: quest.goblin.id, initialFormState, form, wizardGadgets});
161
+ yield quest.me.initWizard();
162
+ yield quest.me.idle();
163
+ return quest.goblin.id;
164
+ },
165
+ {skills: skills ?? []}
166
+ );
167
+
168
+ Goblin.registerQuest(goblinName, 'create-hinters', function* (quest) {
169
+ if (!hinters) {
170
+ return;
171
+ }
172
+
173
+ const desktopId = quest.goblin.getX('desktopId');
174
+ const promises = [];
175
+
176
+ Object.keys(hinters).forEach((h) => {
177
+ let detailWidget = null;
178
+ let hName = h;
179
+
180
+ if (hinters[h].hinter) {
181
+ hName = hinters[h].hinter;
182
+ detailWidget = `${hName}-workitem`;
183
+ }
184
+ if (!quest.hasAPI(`${hName}-hinter`)) {
185
+ return;
186
+ }
187
+
188
+ const id = `${hName}-hinter@${h}@${quest.goblin.id}`;
189
+ const widgetId = `hinter@${hName}@${quest.goblin.id}`;
190
+ hinterIdsByName[h] = id;
191
+ hinterWidgetIdsByName[h] = widgetId;
192
+ promises.push(
193
+ quest.create(`${hName}-hinter`, {
194
+ id,
195
+ desktopId,
196
+ hinterName: h,
197
+ workitemId: quest.goblin.id,
198
+ detailWidget,
199
+ withDetails: true,
200
+ })
201
+ );
202
+ });
203
+
204
+ yield Promise.all(promises);
205
+ });
206
+
207
+ common.registerHinters(goblinName, hinters);
208
+
209
+ Goblin.registerSafeQuest(goblinName, 'busy', function (quest) {
210
+ quest.do();
211
+ });
212
+
213
+ Goblin.registerSafeQuest(goblinName, 'idle', function (quest) {
214
+ quest.do();
215
+ });
216
+
217
+ if (gadgets) {
218
+ for (const key of Object.keys(gadgets)) {
219
+ //Gogo gadgeto stylo!
220
+ Goblin.registerSafeQuest(goblinName, `use-${key}`, function* (
221
+ quest,
222
+ action,
223
+ payload
224
+ ) {
225
+ const gadgetId = quest.goblin.getState().get(`gadgets.${key}.id`);
226
+ const api = quest.getAPI(gadgetId);
227
+ yield api[action](payload);
228
+ });
229
+
230
+ //Register gagdet quest handlers
231
+
232
+ if (gadgets[key].onActions) {
233
+ for (const handler of Object.keys(gadgets[key].onActions)) {
234
+ const questName = common.jsifyQuestName(`${key}-${handler}`);
235
+ logicHandlers[questName] = gadgets[key].onActions[handler];
236
+
237
+ Goblin.registerSafeQuest(goblinName, questName, function* (quest) {
238
+ quest.do();
239
+ yield quest.me.update();
240
+ });
241
+ }
242
+ }
243
+ }
244
+ }
245
+
246
+ if (quests) {
247
+ Object.keys(quests).forEach((q) => {
248
+ Goblin.registerSafeQuest(goblinName, q, quests[q]);
249
+ });
250
+ }
251
+
252
+ Goblin.registerSafeQuest(goblinName, 'init-wizard', function (quest) {
253
+ quest.do();
254
+ quest.evt('<wizard-tick>', {calledFrom: quest.calledFrom});
255
+ });
256
+
257
+ Goblin.registerSafeQuest(goblinName, 'next', function (quest, result) {
258
+ quest.do();
259
+ quest.evt('<wizard-tick>', {calledFrom: quest.calledFrom});
260
+ return result;
261
+ });
262
+
263
+ Goblin.registerSafeQuest(goblinName, 'back', function (quest) {
264
+ quest.do();
265
+ quest.evt('<wizard-tick>', {calledFrom: quest.calledFrom});
266
+ });
267
+
268
+ Goblin.registerSafeQuest(goblinName, 'goto', function (quest, step) {
269
+ quest.do();
270
+ quest.evt('<wizard-tick>', {calledFrom: quest.calledFrom});
271
+ });
272
+
273
+ Goblin.registerSafeQuest(goblinName, '_goto', function* (quest) {
274
+ const state = quest.goblin.getState();
275
+ const form = state.get('form').toJS();
276
+ const nextStep = state.get('nextStep');
277
+
278
+ quest.dispatch(`init-${nextStep}`);
279
+ quest.do();
280
+
281
+ yield quest.me.updateButtons();
282
+
283
+ if (quest.me[nextStep]) {
284
+ try {
285
+ yield quest.me.busy();
286
+ yield quest.me[nextStep]({form});
287
+ } finally {
288
+ if (!quest.goblin.getX('isDisposing')) {
289
+ yield quest.me.idle();
290
+ }
291
+ }
292
+ }
293
+ });
294
+
295
+ Goblin.registerSafeQuest(goblinName, 'done', function* (quest) {
296
+ let result = quest.goblin.getState().get('result');
297
+ if (Shredder.isImmutable(result)) {
298
+ result = result.toJS();
299
+ }
300
+ let payload = {finished: true, result};
301
+ if (quest.goblin.getState().get('canceled')) {
302
+ payload = quest.cancel();
303
+ }
304
+ quest.evt('done', payload);
305
+ yield quest.me.dispose();
306
+ });
307
+
308
+ Goblin.registerSafeQuest(goblinName, 'cancel', function (quest) {
309
+ quest.do();
310
+ quest.evt('<wizard-tick>', {calledFrom: quest.calledFrom});
311
+ });
312
+
313
+ Goblin.registerSafeQuest(goblinName, 'change', function* (
314
+ quest,
315
+ path,
316
+ newValue
317
+ ) {
318
+ if (hinters && hinters[path]) {
319
+ return;
320
+ }
321
+ quest.do();
322
+ yield quest.me.update();
323
+ });
324
+
325
+ Goblin.registerSafeQuest(goblinName, 'apply', function* (quest) {
326
+ quest.do();
327
+ yield quest.me.update();
328
+ });
329
+
330
+ Goblin.registerSafeQuest(goblinName, 'update', function* (quest) {
331
+ const state = quest.goblin.getState();
332
+ const stepName = state.get('step');
333
+ const step = steps[stepName];
334
+
335
+ if (step) {
336
+ if (step.updateButtonsMode === 'onChange') {
337
+ yield quest.me.updateButtons();
338
+ }
339
+ if (step.onChange) {
340
+ const form = state.get('form');
341
+ yield quest.me[`${stepName}OnChange`]({form});
342
+ }
343
+ }
344
+ });
345
+
346
+ Goblin.registerSafeQuest(goblinName, 'update-buttons', function* (quest) {
347
+ const state = quest.goblin.getState();
348
+ const stepName = state.get('step');
349
+ const step = steps[stepName];
350
+
351
+ if (step && step.buttons) {
352
+ const form = state.get('form');
353
+ const currentButtons = state.get('buttons');
354
+ const newButtons = yield quest.me[`${stepName}Buttons`]({
355
+ form,
356
+ buttons: currentButtons,
357
+ });
358
+ quest.dispatch('buttons', {buttons: newButtons});
359
+ }
360
+ });
361
+
362
+ // configure steps
363
+ for (const stepName of wizardSteps) {
364
+ const step = steps[stepName];
365
+ logicHandlers[`init-${stepName}`] = (state) => {
366
+ if (step.form) {
367
+ return state.mergeDeep('form', step.form);
368
+ }
369
+ return state;
370
+ };
371
+ logicHandlers[stepName] = (state, action) => {
372
+ return state.mergeDeep('form', action.get('form'));
373
+ };
374
+
375
+ if (step.quest) {
376
+ Goblin.registerSafeQuest(goblinName, stepName, step.quest);
377
+ }
378
+
379
+ if (step.buttons) {
380
+ Goblin.registerSafeQuest(goblinName, `${stepName}-buttons`, step.buttons);
381
+ }
382
+
383
+ if (step.onChange) {
384
+ Goblin.registerSafeQuest(
385
+ goblinName,
386
+ `${stepName}-on-change`,
387
+ step.onChange
388
+ );
389
+ }
390
+
391
+ for (const action in step.actions) {
392
+ const actionQuest = `${stepName}-${action}`;
393
+ logicHandlers[actionQuest] = step.actions[action];
394
+ Goblin.registerSafeQuest(goblinName, actionQuest, function (quest) {
395
+ quest.do();
396
+ });
397
+ }
398
+ }
399
+
400
+ Goblin.registerSafeQuest(goblinName, 'get-entity', common.getEntityQuest);
401
+ Goblin.registerSafeQuest(goblinName, 'load-entity', common.loadEntityQuest);
402
+ Goblin.registerSafeQuest(goblinName, 'open-wizard', common.openWizard);
403
+
404
+ Goblin.registerSafeQuest(goblinName, 'showHinter', function* (
405
+ quest,
406
+ type,
407
+ withDetail = true
408
+ ) {
409
+ const hinterWidgetId = hinterWidgetIdsByName[type];
410
+ const hinterAPI = quest.getAPI(hinterWidgetId).noThrow();
411
+ yield hinterAPI.show();
412
+ if (withDetail) {
413
+ yield hinterAPI.showDetail();
414
+ }
415
+ });
416
+
417
+ Goblin.registerSafeQuest(goblinName, 'hideHinter', function* (quest, type) {
418
+ const hinterAPI = quest
419
+ .getAPI(`${type}-hinter@${quest.goblin.id}`)
420
+ .noThrow();
421
+ yield hinterAPI.hide();
422
+ });
423
+
424
+ Goblin.registerSafeQuest(goblinName, 'setDetail', function* (
425
+ quest,
426
+ type,
427
+ entityId
428
+ ) {
429
+ const hinterWidgetId = hinterWidgetIdsByName[type];
430
+ const deskAPI = quest.getAPI(quest.getDesktop()).noThrow();
431
+ yield deskAPI.setDetail({
432
+ hinterId: hinterWidgetId,
433
+ });
434
+ const hinterAPI = quest.getAPI(hinterWidgetId).noThrow();
435
+ yield hinterAPI.setCurrentDetailEntity({entityId});
436
+ });
437
+
438
+ function disposeQuest(quest) {
439
+ if (quest.goblin.getX('isDisposing')) {
440
+ return;
441
+ }
442
+
443
+ quest.goblin.setX('isDisposing', true);
444
+
445
+ const desktopId = quest.goblin.getX('desktopId');
446
+
447
+ quest.evt(`${desktopId}.<remove-workitem-requested>`, {
448
+ workitemId: quest.goblin.id,
449
+ close: false,
450
+ navToLastWorkitem: true,
451
+ });
452
+ }
453
+
454
+ Goblin.registerSafeQuest(goblinName, 'dispose', disposeQuest);
455
+
456
+ Goblin.registerQuest(goblinName, 'delete', function (quest) {
457
+ quest.evt('done', {finished: true});
458
+ disposeQuest(quest);
459
+ });
460
+
461
+ return Goblin.configure(goblinName, {}, logicHandlers);
462
+ };