@static-suite/static-suite-data-server 1.0.18 → 1.0.20

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 (10) hide show
  1. package/README.md +30 -20
  2. package/dist/http/README.md +30 -20
  3. package/dist/lib/store/hook/hook.types.d.ts +12 -5
  4. package/dist/lib/store/hook/hook.types.d.ts.map +1 -1
  5. package/dist/lib/store/hook/hookManager.d.ts.map +1 -1
  6. package/dist/lib/store/hook/hookManager.js +11 -0
  7. package/dist/lib/tsdoc-metadata.json +1 -1
  8. package/package.json +1 -1
  9. package/src/lib/store/hook/hook.types.ts +17 -9
  10. package/src/lib/store/hook/hookManager.ts +11 -0
package/README.md CHANGED
@@ -29,16 +29,16 @@ Data Server supports static JSON includes (`entityInclude`, `configInclude`, `lo
29
29
  - [Hooks](#hooks)
30
30
  - [Available hooks](#available-hooks)
31
31
  - [`onModuleLoad({config, store, logger }): void`](#onmoduleloadconfig-store-logger--void)
32
- - [`onStoreLoadStart({ store, logger, dependencyTagger }): void`](#onstoreloadstart-store-logger-dependencytagger--void)
33
- - [`onProcessFile({ store, logger, dependencyTagger, relativeFilepath, fileContent }): fileContent`](#onprocessfile-store-logger-dependencytagger-relativefilepath-filecontent--filecontent)
34
- - [`onStoreItemAdd({ store, logger, dependencyTagger, relativeFilepath, storeItem }): void`](#onstoreitemadd-store-logger-dependencytagger-relativefilepath-storeitem--void)
35
- - [`onStoreLoadDone({ store, logger, dependencyTagger }): void`](#onstoreloaddone-store-logger-dependencytagger--void)
36
- - [`onStoreChangeStart({ store, logger, dependencyTagger, changedFiles }): void`](#onstorechangestart-store-logger-dependencytagger-changedfiles--void)
37
- - [`onStoreItemBeforeUpdate({ store, logger, dependencyTagger, relativeFilepath, storeItem }): void`](#onstoreitembeforeupdate-store-logger-dependencytagger-relativefilepath-storeitem--void)
38
- - [`onStoreItemAfterUpdate({ store, logger, dependencyTagger, relativeFilepath, storeItem, previousStoreItem }): void`](#onstoreitemafterupdate-store-logger-dependencytagger-relativefilepath-storeitem-previousstoreitem--void)
39
- - [`onStoreItemDelete({ store, logger, dependencyTagger, relativeFilepath, storeItem }): void`](#onstoreitemdelete-store-logger-dependencytagger-relativefilepath-storeitem--void)
40
- - [`onStoreChangeDone({ store, logger, dependencyTagger, changedFiles }): void`](#onstorechangedone-store-logger-dependencytagger-changedfiles--void)
41
- - [`onDumpCreate(options: OnDumpHookOptions): Dump`](#ondumpcreateoptions-ondumphookoptions-dump)
32
+ - [`onStoreLoadStart({ config, store, logger, dependencyTagger }): void`](#onstoreloadstart-config-store-logger-dependencytagger--void)
33
+ - [`onProcessFile({ config, store, logger, dependencyTagger, relativeFilepath, fileContent }): fileContent`](#onprocessfile-config-store-logger-dependencytagger-relativefilepath-filecontent--filecontent)
34
+ - [`onStoreItemAdd({ config, store, logger, dependencyTagger, relativeFilepath, storeItem }): void`](#onstoreitemadd-config-store-logger-dependencytagger-relativefilepath-storeitem--void)
35
+ - [`onStoreLoadDone({ config, store, logger, dependencyTagger }): void`](#onstoreloaddone-config-store-logger-dependencytagger--void)
36
+ - [`onStoreChangeStart({ config, store, logger, dependencyTagger, changedFiles }): void`](#onstorechangestart-config-store-logger-dependencytagger-changedfiles--void)
37
+ - [`onStoreItemBeforeUpdate({ config, store, logger, dependencyTagger, relativeFilepath, storeItem }): void`](#onstoreitembeforeupdate-config-store-logger-dependencytagger-relativefilepath-storeitem--void)
38
+ - [`onStoreItemAfterUpdate({ config, store, logger, dependencyTagger, relativeFilepath, storeItem, previousStoreItem }): void`](#onstoreitemafterupdate-config-store-logger-dependencytagger-relativefilepath-storeitem-previousstoreitem--void)
39
+ - [`onStoreItemDelete({ config, store, logger, dependencyTagger, relativeFilepath, storeItem }): void`](#onstoreitemdelete-config-store-logger-dependencytagger-relativefilepath-storeitem--void)
40
+ - [`onStoreChangeDone({ config, store, logger, dependencyTagger, changedFiles }): void`](#onstorechangedone-config-store-logger-dependencytagger-changedfiles--void)
41
+ - [`onDumpCreate({ config, store, dumpDir, dump }): Dump`](#ondumpcreate-config-store-dumpdir-dump--dump)
42
42
  - [Hook example](#hook-example)
43
43
  - [`File taxonomy.hook.js`](#file-taxonomyhookjs)
44
44
  - [`File listContentsByTermId.query.js`](#file-listcontentsbytermidqueryjs)
@@ -396,22 +396,24 @@ Received parameters:
396
396
  - `store`: the object that holds all data. See [store internal structure](#store-internal-structure).
397
397
  - `logger`: the logger service with several functions to log messages: `error()`, `warn()`, `info()`, `error()`
398
398
 
399
- #### `onStoreLoadStart({ store, logger, dependencyTagger }): void`
399
+ #### `onStoreLoadStart({ config, store, logger, dependencyTagger }): void`
400
400
 
401
401
  Called before the store starts loading for the first time.
402
402
 
403
403
  Received parameters:
404
404
 
405
+ - `config`: object with configuration options defined at Data Server start: `dataDir`, `workDir`, `queryDir`, etc
405
406
  - `store`: the object that holds all data. See [store internal structure](#store-internal-structure).
406
407
  - `logger`: the logger service with several functions to log messages: `error()`, `warn()`, `info()`, `error()`
407
408
  - `dependencyTagger`: the dependency tagger service. See [Dependency Tags](#dependency-tags) section.
408
409
 
409
- #### `onProcessFile({ store, logger, dependencyTagger, relativeFilepath, fileContent }): fileContent`
410
+ #### `onProcessFile({ config, store, logger, dependencyTagger, relativeFilepath, fileContent }): fileContent`
410
411
 
411
412
  Called after a file is read from disk, before adding it to the store. It is aimed at altering the contents of the file before adding it to the store.
412
413
 
413
414
  Received parameters:
414
415
 
416
+ - `config`: object with configuration options defined at Data Server start: `dataDir`, `workDir`, `queryDir`, etc
415
417
  - `store`: the object that holds all data. See [store internal structure](#store-internal-structure).
416
418
  - `logger`: the logger service with several functions to log messages: `error()`, `warn()`, `info()`, `error()`
417
419
  - `dependencyTagger`: the dependency tagger service. See [Dependency Tags](#dependency-tags) section.
@@ -422,34 +424,37 @@ Return value:
422
424
 
423
425
  - The passed `fileContent` object (an object with "raw" and "json" members) with any modification applied.
424
426
 
425
- #### `onStoreItemAdd({ store, logger, dependencyTagger, relativeFilepath, storeItem }): void`
427
+ #### `onStoreItemAdd({ config, store, logger, dependencyTagger, relativeFilepath, storeItem }): void`
426
428
 
427
429
  Called after a file is added into the store for the first time.
428
430
 
429
431
  Received parameters:
430
432
 
433
+ - `config`: object with configuration options defined at Data Server start: `dataDir`, `workDir`, `queryDir`, etc
431
434
  - `store`: the object that holds all data. See [store internal structure](#store-internal-structure).
432
435
  - `logger`: the logger service with several functions to log messages: `error()`, `warn()`, `info()`, `error()`
433
436
  - `dependencyTagger`: the dependency tagger service. See [Dependency Tags](#dependency-tags) section.
434
437
  - `relativeFilepath`: relative file path inside the data dir.
435
438
  - `storeItem`: contents of the store item.
436
439
 
437
- #### `onStoreLoadDone({ store, logger, dependencyTagger }): void`
440
+ #### `onStoreLoadDone({ config, store, logger, dependencyTagger }): void`
438
441
 
439
442
  Called after the store finishes loading for the first time.
440
443
 
441
444
  Received parameters:
442
445
 
446
+ - `config`: object with configuration options defined at Data Server start: `dataDir`, `workDir`, `queryDir`, etc
443
447
  - `store`: the object that holds all data. See [store internal structure](#store-internal-structure).
444
448
  - `logger`: the logger service with several functions to log messages: `error()`, `warn()`, `info()`, `error()`
445
449
  - `dependencyTagger`: the dependency tagger service. See [Dependency Tags](#dependency-tags) section.
446
450
 
447
- #### `onStoreChangeStart({ store, logger, dependencyTagger, changedFiles }): void`
451
+ #### `onStoreChangeStart({ config, store, logger, dependencyTagger, changedFiles }): void`
448
452
 
449
453
  Called before the store starts updating.
450
454
 
451
455
  Received parameters:
452
456
 
457
+ - `config`: object with configuration options defined at Data Server start: `dataDir`, `workDir`, `queryDir`, etc
453
458
  - `store`: the object that holds all data. See [store internal structure](#store-internal-structure).
454
459
  - `logger`: the logger service with several functions to log messages: `error()`, `warn()`, `info()`, `error()`
455
460
  - `dependencyTagger`: the dependency tagger service. See [Dependency Tags](#dependency-tags) section.
@@ -460,24 +465,26 @@ Received parameters:
460
465
  - `deleted`: a list of deleted files.
461
466
  - `all`: a list of all updated and deleted files, sorted by its unique id.
462
467
 
463
- #### `onStoreItemBeforeUpdate({ store, logger, dependencyTagger, relativeFilepath, storeItem }): void`
468
+ #### `onStoreItemBeforeUpdate({ config, store, logger, dependencyTagger, relativeFilepath, storeItem }): void`
464
469
 
465
470
  Called before a file is updated in the store.
466
471
 
467
472
  Received parameters:
468
473
 
474
+ - `config`: object with configuration options defined at Data Server start: `dataDir`, `workDir`, `queryDir`, etc
469
475
  - `store`: the object that holds all data. See [store internal structure](#store-internal-structure).
470
476
  - `logger`: the logger service with several functions to log messages: `error()`, `warn()`, `info()`, `error()`
471
477
  - `dependencyTagger`: the dependency tagger service. See [Dependency Tags](#dependency-tags) section.
472
478
  - `relativeFilepath`: relative file path inside the data dir.
473
479
  - `storeItem`: contents of the store item.
474
480
 
475
- #### `onStoreItemAfterUpdate({ store, logger, dependencyTagger, relativeFilepath, storeItem, previousStoreItem }): void`
481
+ #### `onStoreItemAfterUpdate({ config, store, logger, dependencyTagger, relativeFilepath, storeItem, previousStoreItem }): void`
476
482
 
477
483
  Called after a file is updated in the store.
478
484
 
479
485
  Received parameters:
480
486
 
487
+ - `config`: object with configuration options defined at Data Server start: `dataDir`, `workDir`, `queryDir`, etc
481
488
  - `store`: the object that holds all data. See [store internal structure](#store-internal-structure).
482
489
  - `logger`: the logger service with several functions to log messages: `error()`, `warn()`, `info()`, `error()`
483
490
  - `dependencyTagger`: the dependency tagger service. See [Dependency Tags](#dependency-tags) section.
@@ -485,24 +492,26 @@ Received parameters:
485
492
  - `storeItem`: contents of the store item.
486
493
  - `previousStoreItem`: contents of the previous store item before store was updated
487
494
 
488
- #### `onStoreItemDelete({ store, logger, dependencyTagger, relativeFilepath, storeItem }): void`
495
+ #### `onStoreItemDelete({ config, store, logger, dependencyTagger, relativeFilepath, storeItem }): void`
489
496
 
490
497
  Called after a file is deleted from the store.
491
498
 
492
499
  Received parameters:
493
500
 
501
+ - `config`: object with configuration options defined at Data Server start: `dataDir`, `workDir`, `queryDir`, etc
494
502
  - `store`: the object that holds all data. See [store internal structure](#store-internal-structure).
495
503
  - `logger`: the logger service with several functions to log messages: `error()`, `warn()`, `info()`, `error()`
496
504
  - `dependencyTagger`: the dependency tagger service. See [Dependency Tags](#dependency-tags) section.
497
505
  - `relativeFilepath`: relative file path inside the data dir.
498
506
  - `storeItem`: contents of the store item.
499
507
 
500
- #### `onStoreChangeDone({ store, logger, dependencyTagger, changedFiles }): void`
508
+ #### `onStoreChangeDone({ config, store, logger, dependencyTagger, changedFiles }): void`
501
509
 
502
510
  Called after the store ends updating.
503
511
 
504
512
  Received parameters:
505
513
 
514
+ - `config`: object with configuration options defined at Data Server start: `dataDir`, `workDir`, `queryDir`, etc
506
515
  - `store`: the object that holds all data. See [store internal structure](#store-internal-structure).
507
516
  - `logger`: the logger service with several functions to log messages: `error()`, `warn()`, `info()`, `error()`
508
517
  - `dependencyTagger`: the dependency tagger service. See [Dependency Tags](#dependency-tags) section.
@@ -513,12 +522,13 @@ Received parameters:
513
522
  - `deleted`: a list of deleted files.
514
523
  - `all`: a list of all updated and deleted files, sorted by its unique id.
515
524
 
516
- #### `onDumpCreate(options: OnDumpHookOptions): Dump`
525
+ #### `onDumpCreate({ config, store, dumpDir, dump }): Dump`
517
526
 
518
527
  Called after a dump object is created, aimed at altering the contents of the dump being saved, and adding/removing items.
519
528
 
520
529
  Received parameters:
521
530
 
531
+ - `config`: object with configuration options defined at Data Server start: `dataDir`, `workDir`, `queryDir`, etc
522
532
  - `store`: the object that holds all data. See [store internal structure](#store-internal-structure).
523
533
  - `dumpDir`: path to the dump directory.
524
534
  - `dump`: the dump to be processed. See [Dumps section](#dumps) for more information.
package/dist/http/README.md CHANGED
@@ -29,16 +29,16 @@ Data Server supports static JSON includes (`entityInclude`, `configInclude`, `lo
29
29
  - [Hooks](#hooks)
30
30
  - [Available hooks](#available-hooks)
31
31
  - [`onModuleLoad({config, store, logger }): void`](#onmoduleloadconfig-store-logger--void)
32
- - [`onStoreLoadStart({ store, logger, dependencyTagger }): void`](#onstoreloadstart-store-logger-dependencytagger--void)
33
- - [`onProcessFile({ store, logger, dependencyTagger, relativeFilepath, fileContent }): fileContent`](#onprocessfile-store-logger-dependencytagger-relativefilepath-filecontent--filecontent)
34
- - [`onStoreItemAdd({ store, logger, dependencyTagger, relativeFilepath, storeItem }): void`](#onstoreitemadd-store-logger-dependencytagger-relativefilepath-storeitem--void)
35
- - [`onStoreLoadDone({ store, logger, dependencyTagger }): void`](#onstoreloaddone-store-logger-dependencytagger--void)
36
- - [`onStoreChangeStart({ store, logger, dependencyTagger, changedFiles }): void`](#onstorechangestart-store-logger-dependencytagger-changedfiles--void)
37
- - [`onStoreItemBeforeUpdate({ store, logger, dependencyTagger, relativeFilepath, storeItem }): void`](#onstoreitembeforeupdate-store-logger-dependencytagger-relativefilepath-storeitem--void)
38
- - [`onStoreItemAfterUpdate({ store, logger, dependencyTagger, relativeFilepath, storeItem, previousStoreItem }): void`](#onstoreitemafterupdate-store-logger-dependencytagger-relativefilepath-storeitem-previousstoreitem--void)
39
- - [`onStoreItemDelete({ store, logger, dependencyTagger, relativeFilepath, storeItem }): void`](#onstoreitemdelete-store-logger-dependencytagger-relativefilepath-storeitem--void)
40
- - [`onStoreChangeDone({ store, logger, dependencyTagger, changedFiles }): void`](#onstorechangedone-store-logger-dependencytagger-changedfiles--void)
41
- - [`onDumpCreate(options: OnDumpHookOptions): Dump`](#ondumpcreateoptions-ondumphookoptions-dump)
32
+ - [`onStoreLoadStart({ config, store, logger, dependencyTagger }): void`](#onstoreloadstart-config-store-logger-dependencytagger--void)
33
+ - [`onProcessFile({ config, store, logger, dependencyTagger, relativeFilepath, fileContent }): fileContent`](#onprocessfile-config-store-logger-dependencytagger-relativefilepath-filecontent--filecontent)
34
+ - [`onStoreItemAdd({ config, store, logger, dependencyTagger, relativeFilepath, storeItem }): void`](#onstoreitemadd-config-store-logger-dependencytagger-relativefilepath-storeitem--void)
35
+ - [`onStoreLoadDone({ config, store, logger, dependencyTagger }): void`](#onstoreloaddone-config-store-logger-dependencytagger--void)
36
+ - [`onStoreChangeStart({ config, store, logger, dependencyTagger, changedFiles }): void`](#onstorechangestart-config-store-logger-dependencytagger-changedfiles--void)
37
+ - [`onStoreItemBeforeUpdate({ config, store, logger, dependencyTagger, relativeFilepath, storeItem }): void`](#onstoreitembeforeupdate-config-store-logger-dependencytagger-relativefilepath-storeitem--void)
38
+ - [`onStoreItemAfterUpdate({ config, store, logger, dependencyTagger, relativeFilepath, storeItem, previousStoreItem }): void`](#onstoreitemafterupdate-config-store-logger-dependencytagger-relativefilepath-storeitem-previousstoreitem--void)
39
+ - [`onStoreItemDelete({ config, store, logger, dependencyTagger, relativeFilepath, storeItem }): void`](#onstoreitemdelete-config-store-logger-dependencytagger-relativefilepath-storeitem--void)
40
+ - [`onStoreChangeDone({ config, store, logger, dependencyTagger, changedFiles }): void`](#onstorechangedone-config-store-logger-dependencytagger-changedfiles--void)
41
+ - [`onDumpCreate({ config, store, dumpDir, dump }): Dump`](#ondumpcreate-config-store-dumpdir-dump--dump)
42
42
  - [Hook example](#hook-example)
43
43
  - [`File taxonomy.hook.js`](#file-taxonomyhookjs)
44
44
  - [`File listContentsByTermId.query.js`](#file-listcontentsbytermidqueryjs)
@@ -396,22 +396,24 @@ Received parameters:
396
396
  - `store`: the object that holds all data. See [store internal structure](#store-internal-structure).
397
397
  - `logger`: the logger service with several functions to log messages: `error()`, `warn()`, `info()`, `error()`
398
398
 
399
- #### `onStoreLoadStart({ store, logger, dependencyTagger }): void`
399
+ #### `onStoreLoadStart({ config, store, logger, dependencyTagger }): void`
400
400
 
401
401
  Called before the store starts loading for the first time.
402
402
 
403
403
  Received parameters:
404
404
 
405
+ - `config`: object with configuration options defined at Data Server start: `dataDir`, `workDir`, `queryDir`, etc
405
406
  - `store`: the object that holds all data. See [store internal structure](#store-internal-structure).
406
407
  - `logger`: the logger service with several functions to log messages: `error()`, `warn()`, `info()`, `error()`
407
408
  - `dependencyTagger`: the dependency tagger service. See [Dependency Tags](#dependency-tags) section.
408
409
 
409
- #### `onProcessFile({ store, logger, dependencyTagger, relativeFilepath, fileContent }): fileContent`
410
+ #### `onProcessFile({ config, store, logger, dependencyTagger, relativeFilepath, fileContent }): fileContent`
410
411
 
411
412
  Called after a file is read from disk, before adding it to the store. It is aimed at altering the contents of the file before adding it to the store.
412
413
 
413
414
  Received parameters:
414
415
 
416
+ - `config`: object with configuration options defined at Data Server start: `dataDir`, `workDir`, `queryDir`, etc
415
417
  - `store`: the object that holds all data. See [store internal structure](#store-internal-structure).
416
418
  - `logger`: the logger service with several functions to log messages: `error()`, `warn()`, `info()`, `error()`
417
419
  - `dependencyTagger`: the dependency tagger service. See [Dependency Tags](#dependency-tags) section.
@@ -422,34 +424,37 @@ Return value:
422
424
 
423
425
  - The passed `fileContent` object (an object with "raw" and "json" members) with any modification applied.
424
426
 
425
- #### `onStoreItemAdd({ store, logger, dependencyTagger, relativeFilepath, storeItem }): void`
427
+ #### `onStoreItemAdd({ config, store, logger, dependencyTagger, relativeFilepath, storeItem }): void`
426
428
 
427
429
  Called after a file is added into the store for the first time.
428
430
 
429
431
  Received parameters:
430
432
 
433
+ - `config`: object with configuration options defined at Data Server start: `dataDir`, `workDir`, `queryDir`, etc
431
434
  - `store`: the object that holds all data. See [store internal structure](#store-internal-structure).
432
435
  - `logger`: the logger service with several functions to log messages: `error()`, `warn()`, `info()`, `error()`
433
436
  - `dependencyTagger`: the dependency tagger service. See [Dependency Tags](#dependency-tags) section.
434
437
  - `relativeFilepath`: relative file path inside the data dir.
435
438
  - `storeItem`: contents of the store item.
436
439
 
437
- #### `onStoreLoadDone({ store, logger, dependencyTagger }): void`
440
+ #### `onStoreLoadDone({ config, store, logger, dependencyTagger }): void`
438
441
 
439
442
  Called after the store finishes loading for the first time.
440
443
 
441
444
  Received parameters:
442
445
 
446
+ - `config`: object with configuration options defined at Data Server start: `dataDir`, `workDir`, `queryDir`, etc
443
447
  - `store`: the object that holds all data. See [store internal structure](#store-internal-structure).
444
448
  - `logger`: the logger service with several functions to log messages: `error()`, `warn()`, `info()`, `error()`
445
449
  - `dependencyTagger`: the dependency tagger service. See [Dependency Tags](#dependency-tags) section.
446
450
 
447
- #### `onStoreChangeStart({ store, logger, dependencyTagger, changedFiles }): void`
451
+ #### `onStoreChangeStart({ config, store, logger, dependencyTagger, changedFiles }): void`
448
452
 
449
453
  Called before the store starts updating.
450
454
 
451
455
  Received parameters:
452
456
 
457
+ - `config`: object with configuration options defined at Data Server start: `dataDir`, `workDir`, `queryDir`, etc
453
458
  - `store`: the object that holds all data. See [store internal structure](#store-internal-structure).
454
459
  - `logger`: the logger service with several functions to log messages: `error()`, `warn()`, `info()`, `error()`
455
460
  - `dependencyTagger`: the dependency tagger service. See [Dependency Tags](#dependency-tags) section.
@@ -460,24 +465,26 @@ Received parameters:
460
465
  - `deleted`: a list of deleted files.
461
466
  - `all`: a list of all updated and deleted files, sorted by its unique id.
462
467
 
463
- #### `onStoreItemBeforeUpdate({ store, logger, dependencyTagger, relativeFilepath, storeItem }): void`
468
+ #### `onStoreItemBeforeUpdate({ config, store, logger, dependencyTagger, relativeFilepath, storeItem }): void`
464
469
 
465
470
  Called before a file is updated in the store.
466
471
 
467
472
  Received parameters:
468
473
 
474
+ - `config`: object with configuration options defined at Data Server start: `dataDir`, `workDir`, `queryDir`, etc
469
475
  - `store`: the object that holds all data. See [store internal structure](#store-internal-structure).
470
476
  - `logger`: the logger service with several functions to log messages: `error()`, `warn()`, `info()`, `error()`
471
477
  - `dependencyTagger`: the dependency tagger service. See [Dependency Tags](#dependency-tags) section.
472
478
  - `relativeFilepath`: relative file path inside the data dir.
473
479
  - `storeItem`: contents of the store item.
474
480
 
475
- #### `onStoreItemAfterUpdate({ store, logger, dependencyTagger, relativeFilepath, storeItem, previousStoreItem }): void`
481
+ #### `onStoreItemAfterUpdate({ config, store, logger, dependencyTagger, relativeFilepath, storeItem, previousStoreItem }): void`
476
482
 
477
483
  Called after a file is updated in the store.
478
484
 
479
485
  Received parameters:
480
486
 
487
+ - `config`: object with configuration options defined at Data Server start: `dataDir`, `workDir`, `queryDir`, etc
481
488
  - `store`: the object that holds all data. See [store internal structure](#store-internal-structure).
482
489
  - `logger`: the logger service with several functions to log messages: `error()`, `warn()`, `info()`, `error()`
483
490
  - `dependencyTagger`: the dependency tagger service. See [Dependency Tags](#dependency-tags) section.
@@ -485,24 +492,26 @@ Received parameters:
485
492
  - `storeItem`: contents of the store item.
486
493
  - `previousStoreItem`: contents of the previous store item before store was updated
487
494
 
488
- #### `onStoreItemDelete({ store, logger, dependencyTagger, relativeFilepath, storeItem }): void`
495
+ #### `onStoreItemDelete({ config, store, logger, dependencyTagger, relativeFilepath, storeItem }): void`
489
496
 
490
497
  Called after a file is deleted from the store.
491
498
 
492
499
  Received parameters:
493
500
 
501
+ - `config`: object with configuration options defined at Data Server start: `dataDir`, `workDir`, `queryDir`, etc
494
502
  - `store`: the object that holds all data. See [store internal structure](#store-internal-structure).
495
503
  - `logger`: the logger service with several functions to log messages: `error()`, `warn()`, `info()`, `error()`
496
504
  - `dependencyTagger`: the dependency tagger service. See [Dependency Tags](#dependency-tags) section.
497
505
  - `relativeFilepath`: relative file path inside the data dir.
498
506
  - `storeItem`: contents of the store item.
499
507
 
500
- #### `onStoreChangeDone({ store, logger, dependencyTagger, changedFiles }): void`
508
+ #### `onStoreChangeDone({ config, store, logger, dependencyTagger, changedFiles }): void`
501
509
 
502
510
  Called after the store ends updating.
503
511
 
504
512
  Received parameters:
505
513
 
514
+ - `config`: object with configuration options defined at Data Server start: `dataDir`, `workDir`, `queryDir`, etc
506
515
  - `store`: the object that holds all data. See [store internal structure](#store-internal-structure).
507
516
  - `logger`: the logger service with several functions to log messages: `error()`, `warn()`, `info()`, `error()`
508
517
  - `dependencyTagger`: the dependency tagger service. See [Dependency Tags](#dependency-tags) section.
@@ -513,12 +522,13 @@ Received parameters:
513
522
  - `deleted`: a list of deleted files.
514
523
  - `all`: a list of all updated and deleted files, sorted by its unique id.
515
524
 
516
- #### `onDumpCreate(options: OnDumpHookOptions): Dump`
525
+ #### `onDumpCreate({ config, store, dumpDir, dump }): Dump`
517
526
 
518
527
  Called after a dump object is created, aimed at altering the contents of the dump being saved, and adding/removing items.
519
528
 
520
529
  Received parameters:
521
530
 
531
+ - `config`: object with configuration options defined at Data Server start: `dataDir`, `workDir`, `queryDir`, etc
522
532
  - `store`: the object that holds all data. See [store internal structure](#store-internal-structure).
523
533
  - `dumpDir`: path to the dump directory.
524
534
  - `dump`: the dump to be processed. See [Dumps section](#dumps) for more information.
package/dist/lib/store/hook/hook.types.d.ts CHANGED
@@ -43,13 +43,12 @@ export interface OnModuleLoadHookOptions {
43
43
  }
44
44
  /**
45
45
  * Options passed to a hook.
46
- *
47
- * @remarks
48
- * Since hooks are user-land modules, they do not have access to configuration
49
- * or any other part of the Data Server. All data they need to function must be
50
- * passed as parameters.
51
46
  */
52
47
  export interface BaseHookOptions {
48
+ /**
49
+ * Configuration options.
50
+ */
51
+ config: ConfigOptions;
53
52
  /**
54
53
  * The data store.
55
54
  */
@@ -104,6 +103,10 @@ export interface ChangedFilesHookOptions extends BaseHookOptions {
104
103
  changedFiles: ChangedFiles;
105
104
  }
106
105
  export interface OnDumpHookOptions {
106
+ /**
107
+ * Configuration options.
108
+ */
109
+ config: ConfigOptions;
107
110
  /**
108
111
  * Path to the dump directory.
109
112
  */
@@ -116,6 +119,10 @@ export interface OnDumpHookOptions {
116
119
  * The dump to be processed.
117
120
  */
118
121
  dump: Dump;
122
+ /**
123
+ * The logger service.
124
+ */
125
+ logger: Logger;
119
126
  }
120
127
  /**
121
128
  * A module that defines several hooks.
package/dist/lib/store/hook/hook.types.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"hook.types.d.ts","sourceRoot":"","sources":["../../../../src/lib/store/hook/hook.types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAC;AAC1D,OAAO,EAAE,KAAK,EAAE,MAAM,gBAAgB,CAAC;AACvC,OAAO,EAAE,QAAQ,EAAE,MAAM,yBAAyB,CAAC;AACnD,OAAO,EAAE,MAAM,EAAE,MAAM,iCAAiC,CAAC;AACzD,OAAO,EAAE,IAAI,EAAE,MAAM,iCAAiC,CAAC;AACvD,OAAO,EAAE,gBAAgB,EAAE,MAAM,gCAAgC,CAAC;AAClE,OAAO,EAAE,IAAI,EAAE,MAAM,oBAAoB,CAAC;AAC1C,OAAO,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAC;AAExD;;;;GAIG;AACH,MAAM,MAAM,WAAW,GAAG;IACxB,KAAK,IAAI,IAAI,CAAC;IAGd,sBAAsB,IAAI,IAAI,CAAC;IAC/B,mBAAmB,CAAC,OAAO,EAAE,mBAAmB,GAAG,QAAQ,CAAC;IAC5D,oBAAoB,CAAC,OAAO,EAAE,oBAAoB,GAAG,IAAI,CAAC;IAC1D,qBAAqB,IAAI,IAAI,CAAC;IAG9B,wBAAwB,CAAC,YAAY,EAAE,YAAY,GAAG,IAAI,CAAC;IAC3D,6BAA6B,CAAC,OAAO,EAAE,oBAAoB,GAAG,IAAI,CAAC;IACnE,4BAA4B,CAAC,OAAO,EAAE,oBAAoB,GAAG,IAAI,CAAC;IAClE,uBAAuB,CAAC,OAAO,EAAE,oBAAoB,GAAG,IAAI,CAAC;IAC7D,uBAAuB,CAAC,YAAY,EAAE,YAAY,GAAG,IAAI,CAAC;IAG1D,kBAAkB,CAAC,IAAI,EAAE,IAAI,GAAG,IAAI,CAAC;CACtC,CAAC;AAEF;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,MAAM,EAAE,aAAa,CAAC;IAEtB;;OAEG;IACH,KAAK,EAAE,KAAK,CAAC;IAEb;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,KAAK,EAAE,KAAK,CAAC;IAEb;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,gBAAgB,EAAE,gBAAgB,CAAC;CACpC;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,SAAS,EAAE,IAAI,GAAG,MAAM,GAAG,IAAI,CAAC;IAEhC;;OAEG;IACH,iBAAiB,CAAC,EAAE,IAAI,GAAG,MAAM,GAAG,IAAI,CAAC;CAC1C;AAED,MAAM,WAAW,wBACf,SAAQ,oBAAoB,EAC1B,eAAe;CAAG;AAEtB;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,WAAW,EAAE,QAAQ,CAAC;CACvB;AAED,MAAM,WAAW,uBACf,SAAQ,mBAAmB,EACzB,eAAe;CAAG;AAEtB,MAAM,WAAW,uBAAwB,SAAQ,eAAe;IAC9D;;OAEG;IACH,YAAY,EAAE,YAAY,CAAC;CAC5B;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,KAAK,EAAE,KAAK,CAAC;IAEb;;OAEG;IACH,IAAI,EAAE,IAAI,CAAC;CACZ;AAED;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG;IACvB;;;;;;OAMG;IACH,YAAY,CAAC,CAAC,OAAO,EAAE,uBAAuB,GAAG,IAAI,CAAC;IAEtD;;;;;;;;OAQG;IACH,gBAAgB,CAAC,CAAC,OAAO,EAAE,eAAe,GAAG,IAAI,CAAC;IAElD;;;;;;;;;OASG;IACH,aAAa,CAAC,CAAC,OAAO,EAAE,uBAAuB,GAAG,QAAQ,CAAC;IAE3D;;;;;;;;OAQG;IACH,cAAc,CAAC,CAAC,OAAO,EAAE,wBAAwB,GAAG,IAAI,CAAC;IAEzD;;;;;;;OAOG;IACH,eAAe,CAAC,CAAC,OAAO,EAAE,eAAe,GAAG,IAAI,CAAC;IAEjD;;;;;;;;OAQG;IACH,kBAAkB,CAAC,CAAC,OAAO,EAAE,uBAAuB,GAAG,IAAI,CAAC;IAE5D;;;;;;;;OAQG;IACH,uBAAuB,CAAC,CAAC,OAAO,EAAE,wBAAwB,GAAG,IAAI,CAAC;IAElE;;;;;;;;OAQG;IACH,sBAAsB,CAAC,CAAC,OAAO,EAAE,wBAAwB,GAAG,IAAI,CAAC;IAEjE;;;;;;;;OAQG;IACH,iBAAiB,CAAC,CAAC,OAAO,EAAE,wBAAwB,GAAG,IAAI,CAAC;IAE5D;;;;;;;OAOG;IACH,iBAAiB,CAAC,CAAC,OAAO,EAAE,uBAAuB,GAAG,IAAI,CAAC;IAE3D;;;;;;;OAOG;IACH,YAAY,CAAC,CAAC,OAAO,EAAE,iBAAiB,GAAG,IAAI,CAAC;CACjD,CAAC"}
1
+ {"version":3,"file":"hook.types.d.ts","sourceRoot":"","sources":["../../../../src/lib/store/hook/hook.types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAC;AAC1D,OAAO,EAAE,KAAK,EAAE,MAAM,gBAAgB,CAAC;AACvC,OAAO,EAAE,QAAQ,EAAE,MAAM,yBAAyB,CAAC;AACnD,OAAO,EAAE,MAAM,EAAE,MAAM,iCAAiC,CAAC;AACzD,OAAO,EAAE,IAAI,EAAE,MAAM,iCAAiC,CAAC;AACvD,OAAO,EAAE,gBAAgB,EAAE,MAAM,gCAAgC,CAAC;AAClE,OAAO,EAAE,IAAI,EAAE,MAAM,oBAAoB,CAAC;AAC1C,OAAO,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAC;AAExD;;;;GAIG;AACH,MAAM,MAAM,WAAW,GAAG;IACxB,KAAK,IAAI,IAAI,CAAC;IAGd,sBAAsB,IAAI,IAAI,CAAC;IAC/B,mBAAmB,CAAC,OAAO,EAAE,mBAAmB,GAAG,QAAQ,CAAC;IAC5D,oBAAoB,CAAC,OAAO,EAAE,oBAAoB,GAAG,IAAI,CAAC;IAC1D,qBAAqB,IAAI,IAAI,CAAC;IAG9B,wBAAwB,CAAC,YAAY,EAAE,YAAY,GAAG,IAAI,CAAC;IAC3D,6BAA6B,CAAC,OAAO,EAAE,oBAAoB,GAAG,IAAI,CAAC;IACnE,4BAA4B,CAAC,OAAO,EAAE,oBAAoB,GAAG,IAAI,CAAC;IAClE,uBAAuB,CAAC,OAAO,EAAE,oBAAoB,GAAG,IAAI,CAAC;IAC7D,uBAAuB,CAAC,YAAY,EAAE,YAAY,GAAG,IAAI,CAAC;IAG1D,kBAAkB,CAAC,IAAI,EAAE,IAAI,GAAG,IAAI,CAAC;CACtC,CAAC;AAEF;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,MAAM,EAAE,aAAa,CAAC;IAEtB;;OAEG;IACH,KAAK,EAAE,KAAK,CAAC;IAEb;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,MAAM,EAAE,aAAa,CAAC;IAEtB;;OAEG;IACH,KAAK,EAAE,KAAK,CAAC;IAEb;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,gBAAgB,EAAE,gBAAgB,CAAC;CACpC;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,SAAS,EAAE,IAAI,GAAG,MAAM,GAAG,IAAI,CAAC;IAEhC;;OAEG;IACH,iBAAiB,CAAC,EAAE,IAAI,GAAG,MAAM,GAAG,IAAI,CAAC;CAC1C;AAED,MAAM,WAAW,wBACf,SAAQ,oBAAoB,EAAE,eAAe;CAAG;AAElD;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,WAAW,EAAE,QAAQ,CAAC;CACvB;AAED,MAAM,WAAW,uBACf,SAAQ,mBAAmB,EAAE,eAAe;CAAG;AAEjD,MAAM,WAAW,uBAAwB,SAAQ,eAAe;IAC9D;;OAEG;IACH,YAAY,EAAE,YAAY,CAAC;CAC5B;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,MAAM,EAAE,aAAa,CAAC;IAEtB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,KAAK,EAAE,KAAK,CAAC;IAEb;;OAEG;IACH,IAAI,EAAE,IAAI,CAAC;IAEX;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG;IACvB;;;;;;OAMG;IACH,YAAY,CAAC,CAAC,OAAO,EAAE,uBAAuB,GAAG,IAAI,CAAC;IAEtD;;;;;;;;OAQG;IACH,gBAAgB,CAAC,CAAC,OAAO,EAAE,eAAe,GAAG,IAAI,CAAC;IAElD;;;;;;;;;OASG;IACH,aAAa,CAAC,CAAC,OAAO,EAAE,uBAAuB,GAAG,QAAQ,CAAC;IAE3D;;;;;;;;OAQG;IACH,cAAc,CAAC,CAAC,OAAO,EAAE,wBAAwB,GAAG,IAAI,CAAC;IAEzD;;;;;;;OAOG;IACH,eAAe,CAAC,CAAC,OAAO,EAAE,eAAe,GAAG,IAAI,CAAC;IAEjD;;;;;;;;OAQG;IACH,kBAAkB,CAAC,CAAC,OAAO,EAAE,uBAAuB,GAAG,IAAI,CAAC;IAE5D;;;;;;;;OAQG;IACH,uBAAuB,CAAC,CAAC,OAAO,EAAE,wBAAwB,GAAG,IAAI,CAAC;IAElE;;;;;;;;OAQG;IACH,sBAAsB,CAAC,CAAC,OAAO,EAAE,wBAAwB,GAAG,IAAI,CAAC;IAEjE;;;;;;;;OAQG;IACH,iBAAiB,CAAC,CAAC,OAAO,EAAE,wBAAwB,GAAG,IAAI,CAAC;IAE5D;;;;;;;OAOG;IACH,iBAAiB,CAAC,CAAC,OAAO,EAAE,uBAAuB,GAAG,IAAI,CAAC;IAE3D;;;;;;;OAOG;IACH,YAAY,CAAC,CAAC,OAAO,EAAE,iBAAiB,GAAG,IAAI,CAAC;CACjD,CAAC"}
package/dist/lib/store/hook/hookManager.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"hookManager.d.ts","sourceRoot":"","sources":["../../../../src/lib/store/hook/hookManager.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,WAAW,EAAc,MAAM,cAAc,CAAC;AAYvD;;GAEG;AACH,eAAO,MAAM,WAAW,EAAE,WA6KzB,CAAC"}
1
+ {"version":3,"file":"hookManager.d.ts","sourceRoot":"","sources":["../../../../src/lib/store/hook/hookManager.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,WAAW,EAAc,MAAM,cAAc,CAAC;AAYvD;;GAEG;AACH,eAAO,MAAM,WAAW,EAAE,WAwLzB,CAAC"}
package/dist/lib/store/hook/hookManager.js CHANGED
@@ -27,6 +27,7 @@ exports.hookManager = {
27
27
  const hookModule = hookInfo.getModule();
28
28
  if (hookModule.onStoreLoadStart) {
29
29
  hookModule.onStoreLoadStart({
30
+ config: config_1.config,
30
31
  store: store_1.store,
31
32
  logger: logger_1.logger,
32
33
  dependencyTagger: dependencyTagger_1.dependencyTagger,
@@ -42,6 +43,7 @@ exports.hookManager = {
42
43
  const hookModule = hookInfo.getModule();
43
44
  if (hookModule.onProcessFile) {
44
45
  returnValue = hookModule.onProcessFile({
46
+ config: config_1.config,
45
47
  relativeFilepath,
46
48
  fileContent: processedFileContent,
47
49
  store: store_1.store,
@@ -61,6 +63,7 @@ exports.hookManager = {
61
63
  const hookModule = hookInfo.getModule();
62
64
  if (hookModule.onStoreItemAdd) {
63
65
  hookModule.onStoreItemAdd({
66
+ config: config_1.config,
64
67
  relativeFilepath,
65
68
  store: store_1.store,
66
69
  logger: logger_1.logger,
@@ -76,6 +79,7 @@ exports.hookManager = {
76
79
  const hookModule = hookInfo.getModule();
77
80
  if (hookModule.onStoreLoadDone) {
78
81
  hookModule.onStoreLoadDone({
82
+ config: config_1.config,
79
83
  store: store_1.store,
80
84
  logger: logger_1.logger,
81
85
  dependencyTagger: dependencyTagger_1.dependencyTagger,
@@ -89,6 +93,7 @@ exports.hookManager = {
89
93
  const hookModule = hookInfo.getModule();
90
94
  if (hookModule.onStoreChangeStart) {
91
95
  hookModule.onStoreChangeStart({
96
+ config: config_1.config,
92
97
  store: store_1.store,
93
98
  logger: logger_1.logger,
94
99
  dependencyTagger: dependencyTagger_1.dependencyTagger,
@@ -103,6 +108,7 @@ exports.hookManager = {
103
108
  const hookModule = hookInfo.getModule();
104
109
  if (hookModule.onStoreItemBeforeUpdate) {
105
110
  hookModule.onStoreItemBeforeUpdate({
111
+ config: config_1.config,
106
112
  store: store_1.store,
107
113
  logger: logger_1.logger,
108
114
  dependencyTagger: dependencyTagger_1.dependencyTagger,
@@ -118,6 +124,7 @@ exports.hookManager = {
118
124
  const hookModule = hookInfo.getModule();
119
125
  if (hookModule.onStoreItemAfterUpdate) {
120
126
  hookModule.onStoreItemAfterUpdate({
127
+ config: config_1.config,
121
128
  store: store_1.store,
122
129
  logger: logger_1.logger,
123
130
  dependencyTagger: dependencyTagger_1.dependencyTagger,
@@ -134,6 +141,7 @@ exports.hookManager = {
134
141
  const hookModule = hookInfo.getModule();
135
142
  if (hookModule.onStoreItemDelete) {
136
143
  hookModule.onStoreItemDelete({
144
+ config: config_1.config,
137
145
  store: store_1.store,
138
146
  logger: logger_1.logger,
139
147
  dependencyTagger: dependencyTagger_1.dependencyTagger,
@@ -149,6 +157,7 @@ exports.hookManager = {
149
157
  const hookModule = hookInfo.getModule();
150
158
  if (hookModule.onStoreChangeDone) {
151
159
  hookModule.onStoreChangeDone({
160
+ config: config_1.config,
152
161
  store: store_1.store,
153
162
  logger: logger_1.logger,
154
163
  dependencyTagger: dependencyTagger_1.dependencyTagger,
@@ -165,9 +174,11 @@ exports.hookManager = {
165
174
  const hookModule = hookInfo.getModule();
166
175
  if (config_1.config.dumpDir && hookModule.onDumpCreate) {
167
176
  returnValue = hookModule.onDumpCreate({
177
+ config: config_1.config,
168
178
  dumpDir: config_1.config.dumpDir,
169
179
  store: store_1.store,
170
180
  dump: processedDump,
181
+ logger: logger_1.logger,
171
182
  });
172
183
  if (returnValue) {
173
184
  processedDump = returnValue;
package/dist/lib/tsdoc-metadata.json CHANGED
@@ -5,7 +5,7 @@
5
5
  "toolPackages": [
6
6
  {
7
7
  "packageName": "@microsoft/api-extractor",
8
- "packageVersion": "7.59.0"
8
+ "packageVersion": "7.59.1"
9
9
  }
10
10
  ]
11
11
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@static-suite/static-suite-data-server",
3
- "version": "1.0.18",
3
+ "version": "1.0.20",
4
4
  "description": "A flexible, fast and developer friendly Data Server for Static Suite",
5
5
  "main": "./dist/lib/index.js",
6
6
  "typings": "./dist/lib/index.d.ts",
package/src/lib/store/hook/hook.types.ts CHANGED
@@ -54,13 +54,13 @@ export interface OnModuleLoadHookOptions {
54
54
 
55
55
  /**
56
56
  * Options passed to a hook.
57
- *
58
- * @remarks
59
- * Since hooks are user-land modules, they do not have access to configuration
60
- * or any other part of the Data Server. All data they need to function must be
61
- * passed as parameters.
62
57
  */
63
58
  export interface BaseHookOptions {
59
+ /**
60
+ * Configuration options.
61
+ */
62
+ config: ConfigOptions;
63
+
64
64
  /**
65
65
  * The data store.
66
66
  */
@@ -98,8 +98,7 @@ export interface StoreItemHookOptions {
98
98
  }
99
99
 
100
100
  export interface FullStoreItemHookOptions
101
- extends StoreItemHookOptions,
102
- BaseHookOptions {}
101
+ extends StoreItemHookOptions, BaseHookOptions {}
103
102
 
104
103
  /**
105
104
  * Options passed to a file type hook.
@@ -117,8 +116,7 @@ export interface FileTypeHookOptions {
117
116
  }
118
117
 
119
118
  export interface FullFileTypeHookOptions
120
- extends FileTypeHookOptions,
121
- BaseHookOptions {}
119
+ extends FileTypeHookOptions, BaseHookOptions {}
122
120
 
123
121
  export interface ChangedFilesHookOptions extends BaseHookOptions {
124
122
  /**
@@ -128,6 +126,11 @@ export interface ChangedFilesHookOptions extends BaseHookOptions {
128
126
  }
129
127
 
130
128
  export interface OnDumpHookOptions {
129
+ /**
130
+ * Configuration options.
131
+ */
132
+ config: ConfigOptions;
133
+
131
134
  /**
132
135
  * Path to the dump directory.
133
136
  */
@@ -142,6 +145,11 @@ export interface OnDumpHookOptions {
142
145
  * The dump to be processed.
143
146
  */
144
147
  dump: Dump;
148
+
149
+ /**
150
+ * The logger service.
151
+ */
152
+ logger: Logger;
145
153
  }
146
154
 
147
155
  /**
package/src/lib/store/hook/hookManager.ts CHANGED
@@ -30,6 +30,7 @@ export const hookManager: HookManager = {
30
30
  const hookModule = hookInfo.getModule();
31
31
  if (hookModule.onStoreLoadStart) {
32
32
  hookModule.onStoreLoadStart({
33
+ config,
33
34
  store,
34
35
  logger,
35
36
  dependencyTagger,
@@ -46,6 +47,7 @@ export const hookManager: HookManager = {
46
47
  const hookModule = hookInfo.getModule();
47
48
  if (hookModule.onProcessFile) {
48
49
  returnValue = hookModule.onProcessFile({
50
+ config,
49
51
  relativeFilepath,
50
52
  fileContent: processedFileContent,
51
53
  store,
@@ -66,6 +68,7 @@ export const hookManager: HookManager = {
66
68
  const hookModule = hookInfo.getModule();
67
69
  if (hookModule.onStoreItemAdd) {
68
70
  hookModule.onStoreItemAdd({
71
+ config,
69
72
  relativeFilepath,
70
73
  store,
71
74
  logger,
@@ -82,6 +85,7 @@ export const hookManager: HookManager = {
82
85
  const hookModule = hookInfo.getModule();
83
86
  if (hookModule.onStoreLoadDone) {
84
87
  hookModule.onStoreLoadDone({
88
+ config,
85
89
  store,
86
90
  logger,
87
91
  dependencyTagger,
@@ -96,6 +100,7 @@ export const hookManager: HookManager = {
96
100
  const hookModule = hookInfo.getModule();
97
101
  if (hookModule.onStoreChangeStart) {
98
102
  hookModule.onStoreChangeStart({
103
+ config,
99
104
  store,
100
105
  logger,
101
106
  dependencyTagger,
@@ -111,6 +116,7 @@ export const hookManager: HookManager = {
111
116
  const hookModule = hookInfo.getModule();
112
117
  if (hookModule.onStoreItemBeforeUpdate) {
113
118
  hookModule.onStoreItemBeforeUpdate({
119
+ config,
114
120
  store,
115
121
  logger,
116
122
  dependencyTagger,
@@ -131,6 +137,7 @@ export const hookManager: HookManager = {
131
137
  const hookModule = hookInfo.getModule();
132
138
  if (hookModule.onStoreItemAfterUpdate) {
133
139
  hookModule.onStoreItemAfterUpdate({
140
+ config,
134
141
  store,
135
142
  logger,
136
143
  dependencyTagger,
@@ -148,6 +155,7 @@ export const hookManager: HookManager = {
148
155
  const hookModule = hookInfo.getModule();
149
156
  if (hookModule.onStoreItemDelete) {
150
157
  hookModule.onStoreItemDelete({
158
+ config,
151
159
  store,
152
160
  logger,
153
161
  dependencyTagger,
@@ -164,6 +172,7 @@ export const hookManager: HookManager = {
164
172
  const hookModule = hookInfo.getModule();
165
173
  if (hookModule.onStoreChangeDone) {
166
174
  hookModule.onStoreChangeDone({
175
+ config,
167
176
  store,
168
177
  logger,
169
178
  dependencyTagger,
@@ -181,9 +190,11 @@ export const hookManager: HookManager = {
181
190
  const hookModule = hookInfo.getModule();
182
191
  if (config.dumpDir && hookModule.onDumpCreate) {
183
192
  returnValue = hookModule.onDumpCreate({
193
+ config,
184
194
  dumpDir: config.dumpDir,
185
195
  store,
186
196
  dump: processedDump,
197
+ logger,
187
198
  });
188
199
  if (returnValue) {
189
200
  processedDump = returnValue;