@genesislcap/foundation-comms 14.107.0-auth-mf.27 → 14.107.1-alpha-afbc4d7.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (33) hide show
  1. package/dist/dts/datasource/entityDatasource.d.ts +0 -2
  2. package/dist/dts/datasource/entityDatasource.d.ts.map +1 -1
  3. package/dist/dts/testing/mocks/connect/socket.d.ts +1 -1
  4. package/dist/dts/testing/mocks/connect/socket.d.ts.map +1 -1
  5. package/dist/dts/tsdoc-metadata.json +1 -1
  6. package/dist/esm/datasource/datasource.types.js +2 -1
  7. package/dist/foundation-comms.api.json +888 -107
  8. package/dist/foundation-comms.d.ts +1 -3
  9. package/docs/api/foundation-comms.defaultentitydatasource.cache.md +19 -0
  10. package/docs/api/foundation-comms.defaultentitydatasource.disconnect.md +19 -0
  11. package/docs/api/foundation-comms.defaultentitydatasource.entitycache.md +14 -0
  12. package/docs/api/foundation-comms.defaultentitydatasource.entitymap.md +14 -0
  13. package/docs/api/foundation-comms.defaultentitydatasource.initialize.md +19 -0
  14. package/docs/api/foundation-comms.defaultentitydatasource.isempty.md +19 -0
  15. package/docs/api/foundation-comms.defaultentitydatasource.mapper.md +14 -0
  16. package/docs/api/foundation-comms.defaultentitydatasource.md +36 -0
  17. package/docs/api/foundation-comms.defaultentitydatasource.rowid.md +14 -0
  18. package/docs/api/foundation-comms.defaultentitydatasource.sourceref.md +14 -0
  19. package/docs/api/foundation-comms.defaultentitydatasource.subscription.md +14 -0
  20. package/docs/api/foundation-comms.defaultentitydatasource.subscriptionloggedoff.md +14 -0
  21. package/docs/api/foundation-comms.entitydatasource.cache.md +19 -0
  22. package/docs/api/foundation-comms.entitydatasource.disconnect.md +22 -0
  23. package/docs/api/foundation-comms.entitydatasource.initialize.md +29 -0
  24. package/docs/api/foundation-comms.entitydatasource.initialized.md +19 -0
  25. package/docs/api/foundation-comms.entitydatasource.isempty.md +19 -0
  26. package/docs/api/foundation-comms.entitydatasource.md +81 -0
  27. package/docs/api/foundation-comms.entitydatasourceinit.fetchmeta.md +14 -0
  28. package/docs/api/foundation-comms.entitydatasourceinit.mapper.md +14 -0
  29. package/docs/api/foundation-comms.entitydatasourceinit.md +25 -0
  30. package/docs/api/foundation-comms.entitydatasourceinit.options.md +14 -0
  31. package/docs/api/foundation-comms.md +3 -0
  32. package/docs/api-report.md +1 -5
  33. package/package.json +7 -7
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "metadata": {
3
3
  "toolPackage": "@microsoft/api-extractor",
4
- "toolVersion": "7.34.9",
4
+ "toolVersion": "7.38.0",
5
5
  "schemaVersion": 1011,
6
6
  "oldestForwardsCompatibleVersion": 1001,
7
7
  "tsdocConfig": {
@@ -9261,6 +9261,439 @@
9261
9261
  "endIndex": 2
9262
9262
  }
9263
9263
  },
9264
+ {
9265
+ "kind": "Class",
9266
+ "canonicalReference": "@genesislcap/foundation-comms!DefaultEntityDatasource:class",
9267
+ "docComment": "/**\n * Default EntityDatasource DI implementation.\n *\n * @alpha\n */\n",
9268
+ "excerptTokens": [
9269
+ {
9270
+ "kind": "Content",
9271
+ "text": "export declare class DefaultEntityDatasource<TDTO, TEntity> extends "
9272
+ },
9273
+ {
9274
+ "kind": "Reference",
9275
+ "text": "DefaultDatasource",
9276
+ "canonicalReference": "@genesislcap/foundation-comms!DefaultDatasource:class"
9277
+ },
9278
+ {
9279
+ "kind": "Content",
9280
+ "text": " implements "
9281
+ },
9282
+ {
9283
+ "kind": "Reference",
9284
+ "text": "EntityDatasource",
9285
+ "canonicalReference": "@genesislcap/foundation-comms!EntityDatasource:interface"
9286
+ },
9287
+ {
9288
+ "kind": "Content",
9289
+ "text": "<TDTO, TEntity>"
9290
+ },
9291
+ {
9292
+ "kind": "Content",
9293
+ "text": " "
9294
+ }
9295
+ ],
9296
+ "fileUrlPath": "src/datasource/entityDatasource.ts",
9297
+ "releaseTag": "Alpha",
9298
+ "typeParameters": [
9299
+ {
9300
+ "typeParameterName": "TDTO",
9301
+ "constraintTokenRange": {
9302
+ "startIndex": 0,
9303
+ "endIndex": 0
9304
+ },
9305
+ "defaultTypeTokenRange": {
9306
+ "startIndex": 0,
9307
+ "endIndex": 0
9308
+ }
9309
+ },
9310
+ {
9311
+ "typeParameterName": "TEntity",
9312
+ "constraintTokenRange": {
9313
+ "startIndex": 0,
9314
+ "endIndex": 0
9315
+ },
9316
+ "defaultTypeTokenRange": {
9317
+ "startIndex": 0,
9318
+ "endIndex": 0
9319
+ }
9320
+ }
9321
+ ],
9322
+ "isAbstract": false,
9323
+ "name": "DefaultEntityDatasource",
9324
+ "preserveMemberOrder": false,
9325
+ "members": [
9326
+ {
9327
+ "kind": "Property",
9328
+ "canonicalReference": "@genesislcap/foundation-comms!DefaultEntityDatasource#cache:member",
9329
+ "docComment": "/**\n * {@inheritDoc EntityDatasource.cache}\n */\n",
9330
+ "excerptTokens": [
9331
+ {
9332
+ "kind": "Content",
9333
+ "text": "get cache(): "
9334
+ },
9335
+ {
9336
+ "kind": "Content",
9337
+ "text": "TEntity[]"
9338
+ },
9339
+ {
9340
+ "kind": "Content",
9341
+ "text": ";"
9342
+ }
9343
+ ],
9344
+ "isReadonly": true,
9345
+ "isOptional": false,
9346
+ "releaseTag": "Alpha",
9347
+ "name": "cache",
9348
+ "propertyTypeTokenRange": {
9349
+ "startIndex": 1,
9350
+ "endIndex": 2
9351
+ },
9352
+ "isStatic": false,
9353
+ "isProtected": false,
9354
+ "isAbstract": false
9355
+ },
9356
+ {
9357
+ "kind": "Property",
9358
+ "canonicalReference": "@genesislcap/foundation-comms!DefaultEntityDatasource#disconnect:member",
9359
+ "docComment": "/**\n * {@inheritDoc EntityDatasource.disconnect}\n */\n",
9360
+ "excerptTokens": [
9361
+ {
9362
+ "kind": "Content",
9363
+ "text": "disconnect: "
9364
+ },
9365
+ {
9366
+ "kind": "Content",
9367
+ "text": "() => void"
9368
+ },
9369
+ {
9370
+ "kind": "Content",
9371
+ "text": ";"
9372
+ }
9373
+ ],
9374
+ "isReadonly": false,
9375
+ "isOptional": false,
9376
+ "releaseTag": "Alpha",
9377
+ "name": "disconnect",
9378
+ "propertyTypeTokenRange": {
9379
+ "startIndex": 1,
9380
+ "endIndex": 2
9381
+ },
9382
+ "isStatic": false,
9383
+ "isProtected": false,
9384
+ "isAbstract": false
9385
+ },
9386
+ {
9387
+ "kind": "Property",
9388
+ "canonicalReference": "@genesislcap/foundation-comms!DefaultEntityDatasource#entityCache:member",
9389
+ "docComment": "",
9390
+ "excerptTokens": [
9391
+ {
9392
+ "kind": "Content",
9393
+ "text": "protected entityCache: "
9394
+ },
9395
+ {
9396
+ "kind": "Content",
9397
+ "text": "TEntity[]"
9398
+ },
9399
+ {
9400
+ "kind": "Content",
9401
+ "text": ";"
9402
+ }
9403
+ ],
9404
+ "isReadonly": false,
9405
+ "isOptional": false,
9406
+ "releaseTag": "Alpha",
9407
+ "name": "entityCache",
9408
+ "propertyTypeTokenRange": {
9409
+ "startIndex": 1,
9410
+ "endIndex": 2
9411
+ },
9412
+ "isStatic": false,
9413
+ "isProtected": true,
9414
+ "isAbstract": false
9415
+ },
9416
+ {
9417
+ "kind": "Property",
9418
+ "canonicalReference": "@genesislcap/foundation-comms!DefaultEntityDatasource#entityMap:member",
9419
+ "docComment": "",
9420
+ "excerptTokens": [
9421
+ {
9422
+ "kind": "Content",
9423
+ "text": "protected entityMap: "
9424
+ },
9425
+ {
9426
+ "kind": "Reference",
9427
+ "text": "Map",
9428
+ "canonicalReference": "!Map:interface"
9429
+ },
9430
+ {
9431
+ "kind": "Content",
9432
+ "text": "<string, TEntity>"
9433
+ },
9434
+ {
9435
+ "kind": "Content",
9436
+ "text": ";"
9437
+ }
9438
+ ],
9439
+ "isReadonly": false,
9440
+ "isOptional": false,
9441
+ "releaseTag": "Alpha",
9442
+ "name": "entityMap",
9443
+ "propertyTypeTokenRange": {
9444
+ "startIndex": 1,
9445
+ "endIndex": 3
9446
+ },
9447
+ "isStatic": false,
9448
+ "isProtected": true,
9449
+ "isAbstract": false
9450
+ },
9451
+ {
9452
+ "kind": "Property",
9453
+ "canonicalReference": "@genesislcap/foundation-comms!DefaultEntityDatasource#initialize:member",
9454
+ "docComment": "/**\n * {@inheritDoc EntityDatasource.initialize}\n */\n",
9455
+ "excerptTokens": [
9456
+ {
9457
+ "kind": "Content",
9458
+ "text": "initialize: "
9459
+ },
9460
+ {
9461
+ "kind": "Content",
9462
+ "text": "(init: "
9463
+ },
9464
+ {
9465
+ "kind": "Reference",
9466
+ "text": "EntityDatasourceInit",
9467
+ "canonicalReference": "@genesislcap/foundation-comms!EntityDatasourceInit:interface"
9468
+ },
9469
+ {
9470
+ "kind": "Content",
9471
+ "text": "<TDTO, TEntity>) => "
9472
+ },
9473
+ {
9474
+ "kind": "Reference",
9475
+ "text": "Promise",
9476
+ "canonicalReference": "!Promise:interface"
9477
+ },
9478
+ {
9479
+ "kind": "Content",
9480
+ "text": "<boolean>"
9481
+ },
9482
+ {
9483
+ "kind": "Content",
9484
+ "text": ";"
9485
+ }
9486
+ ],
9487
+ "isReadonly": false,
9488
+ "isOptional": false,
9489
+ "releaseTag": "Alpha",
9490
+ "name": "initialize",
9491
+ "propertyTypeTokenRange": {
9492
+ "startIndex": 1,
9493
+ "endIndex": 6
9494
+ },
9495
+ "isStatic": false,
9496
+ "isProtected": false,
9497
+ "isAbstract": false
9498
+ },
9499
+ {
9500
+ "kind": "Property",
9501
+ "canonicalReference": "@genesislcap/foundation-comms!DefaultEntityDatasource#isEmpty:member",
9502
+ "docComment": "/**\n * {@inheritDoc EntityDatasource.isEmpty}\n */\n",
9503
+ "excerptTokens": [
9504
+ {
9505
+ "kind": "Content",
9506
+ "text": "get isEmpty(): "
9507
+ },
9508
+ {
9509
+ "kind": "Content",
9510
+ "text": "boolean"
9511
+ },
9512
+ {
9513
+ "kind": "Content",
9514
+ "text": ";"
9515
+ }
9516
+ ],
9517
+ "isReadonly": true,
9518
+ "isOptional": false,
9519
+ "releaseTag": "Alpha",
9520
+ "name": "isEmpty",
9521
+ "propertyTypeTokenRange": {
9522
+ "startIndex": 1,
9523
+ "endIndex": 2
9524
+ },
9525
+ "isStatic": false,
9526
+ "isProtected": false,
9527
+ "isAbstract": false
9528
+ },
9529
+ {
9530
+ "kind": "Property",
9531
+ "canonicalReference": "@genesislcap/foundation-comms!DefaultEntityDatasource#mapper:member",
9532
+ "docComment": "",
9533
+ "excerptTokens": [
9534
+ {
9535
+ "kind": "Content",
9536
+ "text": "protected mapper: "
9537
+ },
9538
+ {
9539
+ "kind": "Reference",
9540
+ "text": "DTOMapper",
9541
+ "canonicalReference": "@genesislcap/foundation-utils!DTOMapper:interface"
9542
+ },
9543
+ {
9544
+ "kind": "Content",
9545
+ "text": "<TDTO, TEntity>"
9546
+ },
9547
+ {
9548
+ "kind": "Content",
9549
+ "text": ";"
9550
+ }
9551
+ ],
9552
+ "isReadonly": false,
9553
+ "isOptional": false,
9554
+ "releaseTag": "Alpha",
9555
+ "name": "mapper",
9556
+ "propertyTypeTokenRange": {
9557
+ "startIndex": 1,
9558
+ "endIndex": 3
9559
+ },
9560
+ "isStatic": false,
9561
+ "isProtected": true,
9562
+ "isAbstract": false
9563
+ },
9564
+ {
9565
+ "kind": "Property",
9566
+ "canonicalReference": "@genesislcap/foundation-comms!DefaultEntityDatasource#rowId:member",
9567
+ "docComment": "",
9568
+ "excerptTokens": [
9569
+ {
9570
+ "kind": "Content",
9571
+ "text": "protected rowId: "
9572
+ },
9573
+ {
9574
+ "kind": "Content",
9575
+ "text": "string"
9576
+ },
9577
+ {
9578
+ "kind": "Content",
9579
+ "text": ";"
9580
+ }
9581
+ ],
9582
+ "isReadonly": false,
9583
+ "isOptional": false,
9584
+ "releaseTag": "Alpha",
9585
+ "name": "rowId",
9586
+ "propertyTypeTokenRange": {
9587
+ "startIndex": 1,
9588
+ "endIndex": 2
9589
+ },
9590
+ "isStatic": false,
9591
+ "isProtected": true,
9592
+ "isAbstract": false
9593
+ },
9594
+ {
9595
+ "kind": "Property",
9596
+ "canonicalReference": "@genesislcap/foundation-comms!DefaultEntityDatasource#sourceRef:member",
9597
+ "docComment": "",
9598
+ "excerptTokens": [
9599
+ {
9600
+ "kind": "Content",
9601
+ "text": "protected sourceRef: "
9602
+ },
9603
+ {
9604
+ "kind": "Content",
9605
+ "text": "string"
9606
+ },
9607
+ {
9608
+ "kind": "Content",
9609
+ "text": ";"
9610
+ }
9611
+ ],
9612
+ "isReadonly": false,
9613
+ "isOptional": false,
9614
+ "releaseTag": "Alpha",
9615
+ "name": "sourceRef",
9616
+ "propertyTypeTokenRange": {
9617
+ "startIndex": 1,
9618
+ "endIndex": 2
9619
+ },
9620
+ "isStatic": false,
9621
+ "isProtected": true,
9622
+ "isAbstract": false
9623
+ },
9624
+ {
9625
+ "kind": "Property",
9626
+ "canonicalReference": "@genesislcap/foundation-comms!DefaultEntityDatasource#subscription:member",
9627
+ "docComment": "",
9628
+ "excerptTokens": [
9629
+ {
9630
+ "kind": "Content",
9631
+ "text": "protected subscription: "
9632
+ },
9633
+ {
9634
+ "kind": "Reference",
9635
+ "text": "SocketSubscription",
9636
+ "canonicalReference": "rxjs!Subscription:class"
9637
+ },
9638
+ {
9639
+ "kind": "Content",
9640
+ "text": ";"
9641
+ }
9642
+ ],
9643
+ "isReadonly": false,
9644
+ "isOptional": false,
9645
+ "releaseTag": "Alpha",
9646
+ "name": "subscription",
9647
+ "propertyTypeTokenRange": {
9648
+ "startIndex": 1,
9649
+ "endIndex": 2
9650
+ },
9651
+ "isStatic": false,
9652
+ "isProtected": true,
9653
+ "isAbstract": false
9654
+ },
9655
+ {
9656
+ "kind": "Property",
9657
+ "canonicalReference": "@genesislcap/foundation-comms!DefaultEntityDatasource#subscriptionLoggedOff:member",
9658
+ "docComment": "",
9659
+ "excerptTokens": [
9660
+ {
9661
+ "kind": "Content",
9662
+ "text": "protected subscriptionLoggedOff: "
9663
+ },
9664
+ {
9665
+ "kind": "Content",
9666
+ "text": "boolean"
9667
+ },
9668
+ {
9669
+ "kind": "Content",
9670
+ "text": ";"
9671
+ }
9672
+ ],
9673
+ "isReadonly": false,
9674
+ "isOptional": false,
9675
+ "releaseTag": "Alpha",
9676
+ "name": "subscriptionLoggedOff",
9677
+ "propertyTypeTokenRange": {
9678
+ "startIndex": 1,
9679
+ "endIndex": 2
9680
+ },
9681
+ "isStatic": false,
9682
+ "isProtected": true,
9683
+ "isAbstract": false
9684
+ }
9685
+ ],
9686
+ "extendsTokenRange": {
9687
+ "startIndex": 1,
9688
+ "endIndex": 2
9689
+ },
9690
+ "implementsTokenRanges": [
9691
+ {
9692
+ "startIndex": 3,
9693
+ "endIndex": 5
9694
+ }
9695
+ ]
9696
+ },
9264
9697
  {
9265
9698
  "kind": "Class",
9266
9699
  "canonicalReference": "@genesislcap/foundation-comms!DefaultFoundationAnalytics:class",
@@ -11955,211 +12388,559 @@
11955
12388
  "isOptional": false
11956
12389
  },
11957
12390
  {
11958
- "parameterName": "storage",
11959
- "parameterTypeTokenRange": {
11960
- "startIndex": 6,
11961
- "endIndex": 7
11962
- },
11963
- "isOptional": false
12391
+ "parameterName": "storage",
12392
+ "parameterTypeTokenRange": {
12393
+ "startIndex": 6,
12394
+ "endIndex": 7
12395
+ },
12396
+ "isOptional": false
12397
+ }
12398
+ ],
12399
+ "isOptional": false,
12400
+ "isAbstract": false,
12401
+ "name": "setItem"
12402
+ },
12403
+ {
12404
+ "kind": "Method",
12405
+ "canonicalReference": "@genesislcap/foundation-comms!DefaultSession#setLocalStorageItem:member(1)",
12406
+ "docComment": "",
12407
+ "excerptTokens": [
12408
+ {
12409
+ "kind": "Content",
12410
+ "text": "setLocalStorageItem(key: "
12411
+ },
12412
+ {
12413
+ "kind": "Content",
12414
+ "text": "string | "
12415
+ },
12416
+ {
12417
+ "kind": "Reference",
12418
+ "text": "UserInfoKeys",
12419
+ "canonicalReference": "@genesislcap/foundation-comms!~UserInfoKeys:type"
12420
+ },
12421
+ {
12422
+ "kind": "Content",
12423
+ "text": ", value: "
12424
+ },
12425
+ {
12426
+ "kind": "Content",
12427
+ "text": "string"
12428
+ },
12429
+ {
12430
+ "kind": "Content",
12431
+ "text": "): "
12432
+ },
12433
+ {
12434
+ "kind": "Content",
12435
+ "text": "void"
12436
+ },
12437
+ {
12438
+ "kind": "Content",
12439
+ "text": ";"
12440
+ }
12441
+ ],
12442
+ "isStatic": false,
12443
+ "returnTypeTokenRange": {
12444
+ "startIndex": 6,
12445
+ "endIndex": 7
12446
+ },
12447
+ "releaseTag": "Public",
12448
+ "isProtected": false,
12449
+ "overloadIndex": 1,
12450
+ "parameters": [
12451
+ {
12452
+ "parameterName": "key",
12453
+ "parameterTypeTokenRange": {
12454
+ "startIndex": 1,
12455
+ "endIndex": 3
12456
+ },
12457
+ "isOptional": false
12458
+ },
12459
+ {
12460
+ "parameterName": "value",
12461
+ "parameterTypeTokenRange": {
12462
+ "startIndex": 4,
12463
+ "endIndex": 5
12464
+ },
12465
+ "isOptional": false
12466
+ }
12467
+ ],
12468
+ "isOptional": false,
12469
+ "isAbstract": false,
12470
+ "name": "setLocalStorageItem"
12471
+ },
12472
+ {
12473
+ "kind": "Method",
12474
+ "canonicalReference": "@genesislcap/foundation-comms!DefaultSession#setSessionStorageItem:member(1)",
12475
+ "docComment": "",
12476
+ "excerptTokens": [
12477
+ {
12478
+ "kind": "Content",
12479
+ "text": "setSessionStorageItem(key: "
12480
+ },
12481
+ {
12482
+ "kind": "Content",
12483
+ "text": "string | "
12484
+ },
12485
+ {
12486
+ "kind": "Reference",
12487
+ "text": "UserInfoKeys",
12488
+ "canonicalReference": "@genesislcap/foundation-comms!~UserInfoKeys:type"
12489
+ },
12490
+ {
12491
+ "kind": "Content",
12492
+ "text": ", value: "
12493
+ },
12494
+ {
12495
+ "kind": "Content",
12496
+ "text": "string"
12497
+ },
12498
+ {
12499
+ "kind": "Content",
12500
+ "text": "): "
12501
+ },
12502
+ {
12503
+ "kind": "Content",
12504
+ "text": "void"
12505
+ },
12506
+ {
12507
+ "kind": "Content",
12508
+ "text": ";"
12509
+ }
12510
+ ],
12511
+ "isStatic": false,
12512
+ "returnTypeTokenRange": {
12513
+ "startIndex": 6,
12514
+ "endIndex": 7
12515
+ },
12516
+ "releaseTag": "Public",
12517
+ "isProtected": false,
12518
+ "overloadIndex": 1,
12519
+ "parameters": [
12520
+ {
12521
+ "parameterName": "key",
12522
+ "parameterTypeTokenRange": {
12523
+ "startIndex": 1,
12524
+ "endIndex": 3
12525
+ },
12526
+ "isOptional": false
12527
+ },
12528
+ {
12529
+ "parameterName": "value",
12530
+ "parameterTypeTokenRange": {
12531
+ "startIndex": 4,
12532
+ "endIndex": 5
12533
+ },
12534
+ "isOptional": false
12535
+ }
12536
+ ],
12537
+ "isOptional": false,
12538
+ "isAbstract": false,
12539
+ "name": "setSessionStorageItem"
12540
+ },
12541
+ {
12542
+ "kind": "Method",
12543
+ "canonicalReference": "@genesislcap/foundation-comms!DefaultSession#setStorageKeyPrefix:member(1)",
12544
+ "docComment": "",
12545
+ "excerptTokens": [
12546
+ {
12547
+ "kind": "Content",
12548
+ "text": "setStorageKeyPrefix(prefix: "
12549
+ },
12550
+ {
12551
+ "kind": "Content",
12552
+ "text": "string"
12553
+ },
12554
+ {
12555
+ "kind": "Content",
12556
+ "text": "): "
12557
+ },
12558
+ {
12559
+ "kind": "Content",
12560
+ "text": "void"
12561
+ },
12562
+ {
12563
+ "kind": "Content",
12564
+ "text": ";"
12565
+ }
12566
+ ],
12567
+ "isStatic": false,
12568
+ "returnTypeTokenRange": {
12569
+ "startIndex": 3,
12570
+ "endIndex": 4
12571
+ },
12572
+ "releaseTag": "Public",
12573
+ "isProtected": false,
12574
+ "overloadIndex": 1,
12575
+ "parameters": [
12576
+ {
12577
+ "parameterName": "prefix",
12578
+ "parameterTypeTokenRange": {
12579
+ "startIndex": 1,
12580
+ "endIndex": 2
12581
+ },
12582
+ "isOptional": false
12583
+ }
12584
+ ],
12585
+ "isOptional": false,
12586
+ "isAbstract": false,
12587
+ "name": "setStorageKeyPrefix"
12588
+ }
12589
+ ],
12590
+ "implementsTokenRanges": [
12591
+ {
12592
+ "startIndex": 1,
12593
+ "endIndex": 2
12594
+ }
12595
+ ]
12596
+ },
12597
+ {
12598
+ "kind": "Interface",
12599
+ "canonicalReference": "@genesislcap/foundation-comms!EntityDatasource:interface",
12600
+ "docComment": "/**\n * EntityDatasource DI interface.\n *\n * @remarks\n *\n * A simple streaming datasource cache used mainly by services that employ DTO mappers.\n *\n * @example\n *\n * An example service using an underlying EntityDatasource:\n * ```ts\n * export class DefaultDomainService implements DomainService {\n * constructor(\n * @EntityDatasource protected datasource: EntityDatasource<DomainDTO, DomainEntity>,\n * @DomainDTOMapper protected mapper: DomainDTOMapper,\n * @optional(DomainServiceConfig) private config = defaultConfig\n * ) {}\n *\n * get initialized = () {\n * return this.datasource.initialized;\n * }\n *\n * initialize = async (init) => {\n * await this.datasource.initialize({\n * mapper: this.mapper,\n * options: {\n * resourceName: this.config.resourceName,\n * ...init,\n * },\n * });\n * return this.initialized;\n * };\n *\n * list = () => this.datasource.cache;\n *\n * get = async (id: string) => this.datasource.cache.find((entity) => entity.id === id);\n *\n * action = async (id: string, message?: string): Promise<Message> => {\n * return this.commitEvent('EVENT_DOMAIN_ACTION', { id, message });\n * };\n *\n * private async commitEvent(event: string, entity: Partial<DomainEntity>) {\n * const msg = await this.connect.commitEvent(event, {\n * DETAILS: this.mapper.toDTO(entity),\n * IGNORE_WARNINGS: true,\n * VALIDATE: false,\n * });\n * return messageOrThrow(msg);\n * }\n * ```\n *\n * @alpha\n */\n",
12601
+ "excerptTokens": [
12602
+ {
12603
+ "kind": "Content",
12604
+ "text": "export interface EntityDatasource<TDTO, TEntity> "
12605
+ }
12606
+ ],
12607
+ "fileUrlPath": "src/datasource/entityDatasource.ts",
12608
+ "releaseTag": "Alpha",
12609
+ "typeParameters": [
12610
+ {
12611
+ "typeParameterName": "TDTO",
12612
+ "constraintTokenRange": {
12613
+ "startIndex": 0,
12614
+ "endIndex": 0
12615
+ },
12616
+ "defaultTypeTokenRange": {
12617
+ "startIndex": 0,
12618
+ "endIndex": 0
12619
+ }
12620
+ },
12621
+ {
12622
+ "typeParameterName": "TEntity",
12623
+ "constraintTokenRange": {
12624
+ "startIndex": 0,
12625
+ "endIndex": 0
12626
+ },
12627
+ "defaultTypeTokenRange": {
12628
+ "startIndex": 0,
12629
+ "endIndex": 0
12630
+ }
12631
+ }
12632
+ ],
12633
+ "name": "EntityDatasource",
12634
+ "preserveMemberOrder": false,
12635
+ "members": [
12636
+ {
12637
+ "kind": "PropertySignature",
12638
+ "canonicalReference": "@genesislcap/foundation-comms!EntityDatasource#cache:member",
12639
+ "docComment": "/**\n * @remarks\n *\n * In-memory entity cache.\n */\n",
12640
+ "excerptTokens": [
12641
+ {
12642
+ "kind": "Content",
12643
+ "text": "readonly cache: "
12644
+ },
12645
+ {
12646
+ "kind": "Content",
12647
+ "text": "TEntity[]"
12648
+ },
12649
+ {
12650
+ "kind": "Content",
12651
+ "text": ";"
11964
12652
  }
11965
12653
  ],
12654
+ "isReadonly": true,
11966
12655
  "isOptional": false,
11967
- "isAbstract": false,
11968
- "name": "setItem"
12656
+ "releaseTag": "Alpha",
12657
+ "name": "cache",
12658
+ "propertyTypeTokenRange": {
12659
+ "startIndex": 1,
12660
+ "endIndex": 2
12661
+ }
11969
12662
  },
11970
12663
  {
11971
- "kind": "Method",
11972
- "canonicalReference": "@genesislcap/foundation-comms!DefaultSession#setLocalStorageItem:member(1)",
11973
- "docComment": "",
12664
+ "kind": "MethodSignature",
12665
+ "canonicalReference": "@genesislcap/foundation-comms!EntityDatasource#disconnect:member(1)",
12666
+ "docComment": "/**\n * @remarks\n *\n * Disconnect and reset cache.\n */\n",
11974
12667
  "excerptTokens": [
11975
12668
  {
11976
12669
  "kind": "Content",
11977
- "text": "setLocalStorageItem(key: "
12670
+ "text": "disconnect(): "
11978
12671
  },
11979
12672
  {
11980
12673
  "kind": "Content",
11981
- "text": "string | "
12674
+ "text": "void"
11982
12675
  },
11983
12676
  {
11984
- "kind": "Reference",
11985
- "text": "UserInfoKeys",
11986
- "canonicalReference": "@genesislcap/foundation-comms!~UserInfoKeys:type"
11987
- },
12677
+ "kind": "Content",
12678
+ "text": ";"
12679
+ }
12680
+ ],
12681
+ "isOptional": false,
12682
+ "returnTypeTokenRange": {
12683
+ "startIndex": 1,
12684
+ "endIndex": 2
12685
+ },
12686
+ "releaseTag": "Alpha",
12687
+ "overloadIndex": 1,
12688
+ "parameters": [],
12689
+ "name": "disconnect"
12690
+ },
12691
+ {
12692
+ "kind": "MethodSignature",
12693
+ "canonicalReference": "@genesislcap/foundation-comms!EntityDatasource#initialize:member(1)",
12694
+ "docComment": "/**\n * @remarks\n *\n * Initialize datasource.\n */\n",
12695
+ "excerptTokens": [
11988
12696
  {
11989
12697
  "kind": "Content",
11990
- "text": ", value: "
12698
+ "text": "initialize(init: "
12699
+ },
12700
+ {
12701
+ "kind": "Reference",
12702
+ "text": "EntityDatasourceInit",
12703
+ "canonicalReference": "@genesislcap/foundation-comms!EntityDatasourceInit:interface"
11991
12704
  },
11992
12705
  {
11993
12706
  "kind": "Content",
11994
- "text": "string"
12707
+ "text": "<TDTO, TEntity>"
11995
12708
  },
11996
12709
  {
11997
12710
  "kind": "Content",
11998
12711
  "text": "): "
11999
12712
  },
12713
+ {
12714
+ "kind": "Reference",
12715
+ "text": "Promise",
12716
+ "canonicalReference": "!Promise:interface"
12717
+ },
12000
12718
  {
12001
12719
  "kind": "Content",
12002
- "text": "void"
12720
+ "text": "<boolean>"
12003
12721
  },
12004
12722
  {
12005
12723
  "kind": "Content",
12006
12724
  "text": ";"
12007
12725
  }
12008
12726
  ],
12009
- "isStatic": false,
12727
+ "isOptional": false,
12010
12728
  "returnTypeTokenRange": {
12011
- "startIndex": 6,
12012
- "endIndex": 7
12729
+ "startIndex": 4,
12730
+ "endIndex": 6
12013
12731
  },
12014
- "releaseTag": "Public",
12015
- "isProtected": false,
12732
+ "releaseTag": "Alpha",
12016
12733
  "overloadIndex": 1,
12017
12734
  "parameters": [
12018
12735
  {
12019
- "parameterName": "key",
12736
+ "parameterName": "init",
12020
12737
  "parameterTypeTokenRange": {
12021
12738
  "startIndex": 1,
12022
12739
  "endIndex": 3
12023
12740
  },
12024
12741
  "isOptional": false
12025
- },
12026
- {
12027
- "parameterName": "value",
12028
- "parameterTypeTokenRange": {
12029
- "startIndex": 4,
12030
- "endIndex": 5
12031
- },
12032
- "isOptional": false
12033
12742
  }
12034
12743
  ],
12035
- "isOptional": false,
12036
- "isAbstract": false,
12037
- "name": "setLocalStorageItem"
12744
+ "name": "initialize"
12038
12745
  },
12039
12746
  {
12040
- "kind": "Method",
12041
- "canonicalReference": "@genesislcap/foundation-comms!DefaultSession#setSessionStorageItem:member(1)",
12042
- "docComment": "",
12747
+ "kind": "PropertySignature",
12748
+ "canonicalReference": "@genesislcap/foundation-comms!EntityDatasource#initialized:member",
12749
+ "docComment": "/**\n * @remarks\n *\n * Datasource initialized.\n */\n",
12043
12750
  "excerptTokens": [
12044
12751
  {
12045
12752
  "kind": "Content",
12046
- "text": "setSessionStorageItem(key: "
12753
+ "text": "readonly initialized: "
12047
12754
  },
12048
12755
  {
12049
12756
  "kind": "Content",
12050
- "text": "string | "
12757
+ "text": "boolean"
12051
12758
  },
12052
12759
  {
12053
- "kind": "Reference",
12054
- "text": "UserInfoKeys",
12055
- "canonicalReference": "@genesislcap/foundation-comms!~UserInfoKeys:type"
12056
- },
12760
+ "kind": "Content",
12761
+ "text": ";"
12762
+ }
12763
+ ],
12764
+ "isReadonly": true,
12765
+ "isOptional": false,
12766
+ "releaseTag": "Alpha",
12767
+ "name": "initialized",
12768
+ "propertyTypeTokenRange": {
12769
+ "startIndex": 1,
12770
+ "endIndex": 2
12771
+ }
12772
+ },
12773
+ {
12774
+ "kind": "PropertySignature",
12775
+ "canonicalReference": "@genesislcap/foundation-comms!EntityDatasource#isEmpty:member",
12776
+ "docComment": "/**\n * @remarks\n *\n * Cache is empty / awaiting first result.\n */\n",
12777
+ "excerptTokens": [
12057
12778
  {
12058
12779
  "kind": "Content",
12059
- "text": ", value: "
12780
+ "text": "readonly isEmpty: "
12060
12781
  },
12061
12782
  {
12062
12783
  "kind": "Content",
12063
- "text": "string"
12784
+ "text": "boolean"
12064
12785
  },
12065
12786
  {
12066
12787
  "kind": "Content",
12067
- "text": "): "
12788
+ "text": ";"
12789
+ }
12790
+ ],
12791
+ "isReadonly": true,
12792
+ "isOptional": false,
12793
+ "releaseTag": "Alpha",
12794
+ "name": "isEmpty",
12795
+ "propertyTypeTokenRange": {
12796
+ "startIndex": 1,
12797
+ "endIndex": 2
12798
+ }
12799
+ }
12800
+ ],
12801
+ "extendsTokenRanges": []
12802
+ },
12803
+ {
12804
+ "kind": "Interface",
12805
+ "canonicalReference": "@genesislcap/foundation-comms!EntityDatasourceInit:interface",
12806
+ "docComment": "/**\n * EntityDatasourceInit interface.\n *\n * @alpha\n */\n",
12807
+ "excerptTokens": [
12808
+ {
12809
+ "kind": "Content",
12810
+ "text": "export interface EntityDatasourceInit<TDTO, TEntity> "
12811
+ }
12812
+ ],
12813
+ "fileUrlPath": "src/datasource/entityDatasource.ts",
12814
+ "releaseTag": "Alpha",
12815
+ "typeParameters": [
12816
+ {
12817
+ "typeParameterName": "TDTO",
12818
+ "constraintTokenRange": {
12819
+ "startIndex": 0,
12820
+ "endIndex": 0
12821
+ },
12822
+ "defaultTypeTokenRange": {
12823
+ "startIndex": 0,
12824
+ "endIndex": 0
12825
+ }
12826
+ },
12827
+ {
12828
+ "typeParameterName": "TEntity",
12829
+ "constraintTokenRange": {
12830
+ "startIndex": 0,
12831
+ "endIndex": 0
12832
+ },
12833
+ "defaultTypeTokenRange": {
12834
+ "startIndex": 0,
12835
+ "endIndex": 0
12836
+ }
12837
+ }
12838
+ ],
12839
+ "name": "EntityDatasourceInit",
12840
+ "preserveMemberOrder": false,
12841
+ "members": [
12842
+ {
12843
+ "kind": "PropertySignature",
12844
+ "canonicalReference": "@genesislcap/foundation-comms!EntityDatasourceInit#fetchMeta:member",
12845
+ "docComment": "",
12846
+ "excerptTokens": [
12847
+ {
12848
+ "kind": "Content",
12849
+ "text": "fetchMeta?: "
12068
12850
  },
12069
12851
  {
12070
12852
  "kind": "Content",
12071
- "text": "void"
12853
+ "text": "boolean"
12072
12854
  },
12073
12855
  {
12074
12856
  "kind": "Content",
12075
12857
  "text": ";"
12076
12858
  }
12077
12859
  ],
12078
- "isStatic": false,
12079
- "returnTypeTokenRange": {
12080
- "startIndex": 6,
12081
- "endIndex": 7
12082
- },
12083
- "releaseTag": "Public",
12084
- "isProtected": false,
12085
- "overloadIndex": 1,
12086
- "parameters": [
12860
+ "isReadonly": false,
12861
+ "isOptional": true,
12862
+ "releaseTag": "Alpha",
12863
+ "name": "fetchMeta",
12864
+ "propertyTypeTokenRange": {
12865
+ "startIndex": 1,
12866
+ "endIndex": 2
12867
+ }
12868
+ },
12869
+ {
12870
+ "kind": "PropertySignature",
12871
+ "canonicalReference": "@genesislcap/foundation-comms!EntityDatasourceInit#mapper:member",
12872
+ "docComment": "",
12873
+ "excerptTokens": [
12087
12874
  {
12088
- "parameterName": "key",
12089
- "parameterTypeTokenRange": {
12090
- "startIndex": 1,
12091
- "endIndex": 3
12092
- },
12093
- "isOptional": false
12875
+ "kind": "Content",
12876
+ "text": "mapper: "
12094
12877
  },
12095
12878
  {
12096
- "parameterName": "value",
12097
- "parameterTypeTokenRange": {
12098
- "startIndex": 4,
12099
- "endIndex": 5
12100
- },
12101
- "isOptional": false
12879
+ "kind": "Reference",
12880
+ "text": "DTOMapper",
12881
+ "canonicalReference": "@genesislcap/foundation-utils!DTOMapper:interface"
12882
+ },
12883
+ {
12884
+ "kind": "Content",
12885
+ "text": "<TDTO, TEntity>"
12886
+ },
12887
+ {
12888
+ "kind": "Content",
12889
+ "text": ";"
12102
12890
  }
12103
12891
  ],
12892
+ "isReadonly": false,
12104
12893
  "isOptional": false,
12105
- "isAbstract": false,
12106
- "name": "setSessionStorageItem"
12894
+ "releaseTag": "Alpha",
12895
+ "name": "mapper",
12896
+ "propertyTypeTokenRange": {
12897
+ "startIndex": 1,
12898
+ "endIndex": 3
12899
+ }
12107
12900
  },
12108
12901
  {
12109
- "kind": "Method",
12110
- "canonicalReference": "@genesislcap/foundation-comms!DefaultSession#setStorageKeyPrefix:member(1)",
12902
+ "kind": "PropertySignature",
12903
+ "canonicalReference": "@genesislcap/foundation-comms!EntityDatasourceInit#options:member",
12111
12904
  "docComment": "",
12112
12905
  "excerptTokens": [
12113
12906
  {
12114
12907
  "kind": "Content",
12115
- "text": "setStorageKeyPrefix(prefix: "
12908
+ "text": "options: "
12116
12909
  },
12117
12910
  {
12118
- "kind": "Content",
12119
- "text": "string"
12911
+ "kind": "Reference",
12912
+ "text": "Omit",
12913
+ "canonicalReference": "!Omit:type"
12120
12914
  },
12121
12915
  {
12122
12916
  "kind": "Content",
12123
- "text": "): "
12917
+ "text": "<"
12918
+ },
12919
+ {
12920
+ "kind": "Reference",
12921
+ "text": "DatasourceOptions",
12922
+ "canonicalReference": "@genesislcap/foundation-comms!DatasourceOptions:interface"
12124
12923
  },
12125
12924
  {
12126
12925
  "kind": "Content",
12127
- "text": "void"
12926
+ "text": ", 'isSnapshot'>"
12128
12927
  },
12129
12928
  {
12130
12929
  "kind": "Content",
12131
12930
  "text": ";"
12132
12931
  }
12133
12932
  ],
12134
- "isStatic": false,
12135
- "returnTypeTokenRange": {
12136
- "startIndex": 3,
12137
- "endIndex": 4
12138
- },
12139
- "releaseTag": "Public",
12140
- "isProtected": false,
12141
- "overloadIndex": 1,
12142
- "parameters": [
12143
- {
12144
- "parameterName": "prefix",
12145
- "parameterTypeTokenRange": {
12146
- "startIndex": 1,
12147
- "endIndex": 2
12148
- },
12149
- "isOptional": false
12150
- }
12151
- ],
12933
+ "isReadonly": false,
12152
12934
  "isOptional": false,
12153
- "isAbstract": false,
12154
- "name": "setStorageKeyPrefix"
12935
+ "releaseTag": "Alpha",
12936
+ "name": "options",
12937
+ "propertyTypeTokenRange": {
12938
+ "startIndex": 1,
12939
+ "endIndex": 5
12940
+ }
12155
12941
  }
12156
12942
  ],
12157
- "implementsTokenRanges": [
12158
- {
12159
- "startIndex": 1,
12160
- "endIndex": 2
12161
- }
12162
- ]
12943
+ "extendsTokenRanges": []
12163
12944
  },
12164
12945
  {
12165
12946
  "kind": "Enum",