@genesislcap/foundation-utils 15.50.3 → 15.51.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (13) hide show
  1. package/dist/custom-elements.json +537 -405
  2. package/dist/dts/error-monitoring/error-monitoring.d.ts +177 -0
  3. package/dist/dts/error-monitoring/error-monitoring.d.ts.map +1 -0
  4. package/dist/dts/error-monitoring/index.d.ts +2 -0
  5. package/dist/dts/error-monitoring/index.d.ts.map +1 -0
  6. package/dist/dts/index.d.ts +1 -0
  7. package/dist/dts/index.d.ts.map +1 -1
  8. package/dist/esm/error-monitoring/error-monitoring.js +259 -0
  9. package/dist/esm/error-monitoring/index.js +1 -0
  10. package/dist/esm/index.js +1 -0
  11. package/dist/foundation-utils.api.json +1307 -99
  12. package/dist/foundation-utils.d.ts +188 -0
  13. package/package.json +9 -9
package/dist/foundation-utils.api.json CHANGED
@@ -670,6 +670,79 @@
670
670
  ],
671
671
  "name": "createErrorMap"
672
672
  },
673
+ {
674
+ "kind": "Function",
675
+ "canonicalReference": "@genesislcap/foundation-utils!createErrorMonitoringReporter:function(1)",
676
+ "docComment": "/**\n * Creates a global log reporter that sends foundation logger output to a monitoring client.\n *\n * @remarks\n *\n * No logged data is sent: a report carries only the logger name, the level, the log's message (its first argument, when that is a string) and, for errors, the exception. Objects and any further arguments are left out, so credentials, personal or business data passed to a logger never reach the monitoring service. `error` and `fatal` logs become events: an exception when an `Error` was logged, with the message as `extra.message`, otherwise a message event. A logged `Error` with its own fields or a cause is sent as a copy that keeps only its name, message, stack and `Error` cause. Other logs become breadcrumbs unless `breadcrumbs` is `false`. A failing client never breaks logging.\n *\n * This covers only what the reporter sends. SDKs that record console calls, such as the Sentry browser SDKs by default, also record foundation logger output as console breadcrumbs with the logged arguments as data. When wiring a client by hand, drop those in the SDK's `beforeBreadcrumb` with {@link isFoundationLoggerConsoleBreadcrumb}.\n *\n * {@link setupErrorMonitoring} does both for you; use this directly to wire a client by hand.\n *\n * @param client - The monitoring client.\n *\n * @param options - Set `breadcrumbs: false` to skip breadcrumbs.\n *\n * @public\n */\n",
677
+ "excerptTokens": [
678
+ {
679
+ "kind": "Content",
680
+ "text": "createErrorMonitoringReporter: (client: "
681
+ },
682
+ {
683
+ "kind": "Reference",
684
+ "text": "ErrorMonitoringClient",
685
+ "canonicalReference": "@genesislcap/foundation-utils!ErrorMonitoringClient:interface"
686
+ },
687
+ {
688
+ "kind": "Content",
689
+ "text": ", { breadcrumbs }?: "
690
+ },
691
+ {
692
+ "kind": "Reference",
693
+ "text": "Pick",
694
+ "canonicalReference": "!Pick:type"
695
+ },
696
+ {
697
+ "kind": "Content",
698
+ "text": "<"
699
+ },
700
+ {
701
+ "kind": "Reference",
702
+ "text": "ErrorMonitoringOptions",
703
+ "canonicalReference": "@genesislcap/foundation-utils!ErrorMonitoringOptions:interface"
704
+ },
705
+ {
706
+ "kind": "Content",
707
+ "text": ", \"breadcrumbs\">"
708
+ },
709
+ {
710
+ "kind": "Content",
711
+ "text": ") => "
712
+ },
713
+ {
714
+ "kind": "Reference",
715
+ "text": "ConsolaReporter",
716
+ "canonicalReference": "consola!ConsolaReporter:interface"
717
+ }
718
+ ],
719
+ "fileUrlPath": "src/error-monitoring/error-monitoring.ts",
720
+ "returnTypeTokenRange": {
721
+ "startIndex": 8,
722
+ "endIndex": 9
723
+ },
724
+ "releaseTag": "Public",
725
+ "overloadIndex": 1,
726
+ "parameters": [
727
+ {
728
+ "parameterName": "client",
729
+ "parameterTypeTokenRange": {
730
+ "startIndex": 1,
731
+ "endIndex": 2
732
+ },
733
+ "isOptional": false
734
+ },
735
+ {
736
+ "parameterName": "{ breadcrumbs }",
737
+ "parameterTypeTokenRange": {
738
+ "startIndex": 3,
739
+ "endIndex": 7
740
+ },
741
+ "isOptional": true
742
+ }
743
+ ],
744
+ "name": "createErrorMonitoringReporter"
745
+ },
673
746
  {
674
747
  "kind": "Function",
675
748
  "canonicalReference": "@genesislcap/foundation-utils!createLogger:function(1)",
@@ -4875,63 +4948,1085 @@
4875
4948
  },
4876
4949
  {
4877
4950
  "kind": "Content",
4878
- "text": "<keyof TErrorDetailMap, "
4879
- },
4880
- {
4881
- "kind": "Reference",
4882
- "text": "Error",
4883
- "canonicalReference": "!Error:interface"
4951
+ "text": "<keyof TErrorDetailMap, "
4952
+ },
4953
+ {
4954
+ "kind": "Reference",
4955
+ "text": "Error",
4956
+ "canonicalReference": "!Error:interface"
4957
+ },
4958
+ {
4959
+ "kind": "Content",
4960
+ "text": ">, 'get' | 'has' | 'delete' | 'clear' | 'size' | 'values'>"
4961
+ },
4962
+ {
4963
+ "kind": "Content",
4964
+ "text": " "
4965
+ }
4966
+ ],
4967
+ "fileUrlPath": "src/error/errorMap.ts",
4968
+ "releaseTag": "Public",
4969
+ "typeParameters": [
4970
+ {
4971
+ "typeParameterName": "TErrorDetailMap",
4972
+ "constraintTokenRange": {
4973
+ "startIndex": 1,
4974
+ "endIndex": 2
4975
+ },
4976
+ "defaultTypeTokenRange": {
4977
+ "startIndex": 0,
4978
+ "endIndex": 0
4979
+ }
4980
+ }
4981
+ ],
4982
+ "name": "ErrorMap",
4983
+ "preserveMemberOrder": false,
4984
+ "members": [
4985
+ {
4986
+ "kind": "PropertySignature",
4987
+ "canonicalReference": "@genesislcap/foundation-utils!ErrorMap#lastError:member",
4988
+ "docComment": "/**\n * The last set error if any.\n *\n * @returns Error\n *\n * @public\n */\n",
4989
+ "excerptTokens": [
4990
+ {
4991
+ "kind": "Content",
4992
+ "text": "readonly lastError: "
4993
+ },
4994
+ {
4995
+ "kind": "Reference",
4996
+ "text": "Error",
4997
+ "canonicalReference": "!Error:interface"
4998
+ },
4999
+ {
5000
+ "kind": "Content",
5001
+ "text": ";"
5002
+ }
5003
+ ],
5004
+ "isReadonly": true,
5005
+ "isOptional": false,
5006
+ "releaseTag": "Public",
5007
+ "name": "lastError",
5008
+ "propertyTypeTokenRange": {
5009
+ "startIndex": 1,
5010
+ "endIndex": 2
5011
+ }
5012
+ },
5013
+ {
5014
+ "kind": "PropertySignature",
5015
+ "canonicalReference": "@genesislcap/foundation-utils!ErrorMap#messages:member",
5016
+ "docComment": "/**\n * Error map as messages.\n *\n * @returns string\n *\n * @public\n */\n",
5017
+ "excerptTokens": [
5018
+ {
5019
+ "kind": "Content",
5020
+ "text": "readonly messages: "
5021
+ },
5022
+ {
5023
+ "kind": "Content",
5024
+ "text": "string"
5025
+ },
5026
+ {
5027
+ "kind": "Content",
5028
+ "text": ";"
5029
+ }
5030
+ ],
5031
+ "isReadonly": true,
5032
+ "isOptional": false,
5033
+ "releaseTag": "Public",
5034
+ "name": "messages",
5035
+ "propertyTypeTokenRange": {
5036
+ "startIndex": 1,
5037
+ "endIndex": 2
5038
+ }
5039
+ },
5040
+ {
5041
+ "kind": "MethodSignature",
5042
+ "canonicalReference": "@genesislcap/foundation-utils!ErrorMap#set:member(1)",
5043
+ "docComment": "/**\n * Set an error by key.\n *\n * @param key - The key.\n *\n * @param error - The error.\n *\n * @public\n */\n",
5044
+ "excerptTokens": [
5045
+ {
5046
+ "kind": "Content",
5047
+ "text": "set(key: "
5048
+ },
5049
+ {
5050
+ "kind": "Content",
5051
+ "text": "keyof TErrorDetailMap"
5052
+ },
5053
+ {
5054
+ "kind": "Content",
5055
+ "text": ", error: "
5056
+ },
5057
+ {
5058
+ "kind": "Reference",
5059
+ "text": "Error",
5060
+ "canonicalReference": "!Error:interface"
5061
+ },
5062
+ {
5063
+ "kind": "Content",
5064
+ "text": "): "
5065
+ },
5066
+ {
5067
+ "kind": "Content",
5068
+ "text": "void"
5069
+ },
5070
+ {
5071
+ "kind": "Content",
5072
+ "text": ";"
5073
+ }
5074
+ ],
5075
+ "isOptional": false,
5076
+ "returnTypeTokenRange": {
5077
+ "startIndex": 5,
5078
+ "endIndex": 6
5079
+ },
5080
+ "releaseTag": "Public",
5081
+ "overloadIndex": 1,
5082
+ "parameters": [
5083
+ {
5084
+ "parameterName": "key",
5085
+ "parameterTypeTokenRange": {
5086
+ "startIndex": 1,
5087
+ "endIndex": 2
5088
+ },
5089
+ "isOptional": false
5090
+ },
5091
+ {
5092
+ "parameterName": "error",
5093
+ "parameterTypeTokenRange": {
5094
+ "startIndex": 3,
5095
+ "endIndex": 4
5096
+ },
5097
+ "isOptional": false
5098
+ }
5099
+ ],
5100
+ "name": "set"
5101
+ }
5102
+ ],
5103
+ "extendsTokenRanges": [
5104
+ {
5105
+ "startIndex": 3,
5106
+ "endIndex": 9
5107
+ }
5108
+ ]
5109
+ },
5110
+ {
5111
+ "kind": "TypeAlias",
5112
+ "canonicalReference": "@genesislcap/foundation-utils!ErrorMapLogger:type",
5113
+ "docComment": "/**\n * @public\n */\n",
5114
+ "excerptTokens": [
5115
+ {
5116
+ "kind": "Content",
5117
+ "text": "export type ErrorMapLogger = "
5118
+ },
5119
+ {
5120
+ "kind": "Content",
5121
+ "text": "(...args: any[]) => void"
5122
+ },
5123
+ {
5124
+ "kind": "Content",
5125
+ "text": ";"
5126
+ }
5127
+ ],
5128
+ "fileUrlPath": "src/error/errorMap.ts",
5129
+ "releaseTag": "Public",
5130
+ "name": "ErrorMapLogger",
5131
+ "typeTokenRange": {
5132
+ "startIndex": 1,
5133
+ "endIndex": 2
5134
+ }
5135
+ },
5136
+ {
5137
+ "kind": "Interface",
5138
+ "canonicalReference": "@genesislcap/foundation-utils!ErrorMonitoringBreadcrumb:interface",
5139
+ "docComment": "/**\n * A breadcrumb: a record of something that happened before an event.\n *\n * @public\n */\n",
5140
+ "excerptTokens": [
5141
+ {
5142
+ "kind": "Content",
5143
+ "text": "export interface ErrorMonitoringBreadcrumb "
5144
+ }
5145
+ ],
5146
+ "fileUrlPath": "src/error-monitoring/error-monitoring.ts",
5147
+ "releaseTag": "Public",
5148
+ "name": "ErrorMonitoringBreadcrumb",
5149
+ "preserveMemberOrder": false,
5150
+ "members": [
5151
+ {
5152
+ "kind": "PropertySignature",
5153
+ "canonicalReference": "@genesislcap/foundation-utils!ErrorMonitoringBreadcrumb#category:member",
5154
+ "docComment": "",
5155
+ "excerptTokens": [
5156
+ {
5157
+ "kind": "Content",
5158
+ "text": "category?: "
5159
+ },
5160
+ {
5161
+ "kind": "Content",
5162
+ "text": "string"
5163
+ },
5164
+ {
5165
+ "kind": "Content",
5166
+ "text": ";"
5167
+ }
5168
+ ],
5169
+ "isReadonly": false,
5170
+ "isOptional": true,
5171
+ "releaseTag": "Public",
5172
+ "name": "category",
5173
+ "propertyTypeTokenRange": {
5174
+ "startIndex": 1,
5175
+ "endIndex": 2
5176
+ }
5177
+ },
5178
+ {
5179
+ "kind": "PropertySignature",
5180
+ "canonicalReference": "@genesislcap/foundation-utils!ErrorMonitoringBreadcrumb#data:member",
5181
+ "docComment": "",
5182
+ "excerptTokens": [
5183
+ {
5184
+ "kind": "Content",
5185
+ "text": "data?: "
5186
+ },
5187
+ {
5188
+ "kind": "Reference",
5189
+ "text": "Record",
5190
+ "canonicalReference": "!Record:type"
5191
+ },
5192
+ {
5193
+ "kind": "Content",
5194
+ "text": "<string, unknown>"
5195
+ },
5196
+ {
5197
+ "kind": "Content",
5198
+ "text": ";"
5199
+ }
5200
+ ],
5201
+ "isReadonly": false,
5202
+ "isOptional": true,
5203
+ "releaseTag": "Public",
5204
+ "name": "data",
5205
+ "propertyTypeTokenRange": {
5206
+ "startIndex": 1,
5207
+ "endIndex": 3
5208
+ }
5209
+ },
5210
+ {
5211
+ "kind": "PropertySignature",
5212
+ "canonicalReference": "@genesislcap/foundation-utils!ErrorMonitoringBreadcrumb#level:member",
5213
+ "docComment": "",
5214
+ "excerptTokens": [
5215
+ {
5216
+ "kind": "Content",
5217
+ "text": "level?: "
5218
+ },
5219
+ {
5220
+ "kind": "Content",
5221
+ "text": "string"
5222
+ },
5223
+ {
5224
+ "kind": "Content",
5225
+ "text": ";"
5226
+ }
5227
+ ],
5228
+ "isReadonly": false,
5229
+ "isOptional": true,
5230
+ "releaseTag": "Public",
5231
+ "name": "level",
5232
+ "propertyTypeTokenRange": {
5233
+ "startIndex": 1,
5234
+ "endIndex": 2
5235
+ }
5236
+ },
5237
+ {
5238
+ "kind": "PropertySignature",
5239
+ "canonicalReference": "@genesislcap/foundation-utils!ErrorMonitoringBreadcrumb#message:member",
5240
+ "docComment": "",
5241
+ "excerptTokens": [
5242
+ {
5243
+ "kind": "Content",
5244
+ "text": "message?: "
5245
+ },
5246
+ {
5247
+ "kind": "Content",
5248
+ "text": "string"
5249
+ },
5250
+ {
5251
+ "kind": "Content",
5252
+ "text": ";"
5253
+ }
5254
+ ],
5255
+ "isReadonly": false,
5256
+ "isOptional": true,
5257
+ "releaseTag": "Public",
5258
+ "name": "message",
5259
+ "propertyTypeTokenRange": {
5260
+ "startIndex": 1,
5261
+ "endIndex": 2
5262
+ }
5263
+ }
5264
+ ],
5265
+ "extendsTokenRanges": []
5266
+ },
5267
+ {
5268
+ "kind": "TypeAlias",
5269
+ "canonicalReference": "@genesislcap/foundation-utils!ErrorMonitoringBreadcrumbHint:type",
5270
+ "docComment": "/**\n * Extra information an SDK passes with a breadcrumb, such as the DOM event or the console arguments.\n *\n * @public\n */\n",
5271
+ "excerptTokens": [
5272
+ {
5273
+ "kind": "Content",
5274
+ "text": "export type ErrorMonitoringBreadcrumbHint = "
5275
+ },
5276
+ {
5277
+ "kind": "Reference",
5278
+ "text": "Record",
5279
+ "canonicalReference": "!Record:type"
5280
+ },
5281
+ {
5282
+ "kind": "Content",
5283
+ "text": "<string, unknown>"
5284
+ },
5285
+ {
5286
+ "kind": "Content",
5287
+ "text": ";"
5288
+ }
5289
+ ],
5290
+ "fileUrlPath": "src/error-monitoring/error-monitoring.ts",
5291
+ "releaseTag": "Public",
5292
+ "name": "ErrorMonitoringBreadcrumbHint",
5293
+ "typeTokenRange": {
5294
+ "startIndex": 1,
5295
+ "endIndex": 3
5296
+ }
5297
+ },
5298
+ {
5299
+ "kind": "Interface",
5300
+ "canonicalReference": "@genesislcap/foundation-utils!ErrorMonitoringClient:interface",
5301
+ "docComment": "/**\n * An error-monitoring SDK, or an adapter for one. The method names and shapes match the Sentry browser SDKs, so `import * as Sentry from '@sentry/react'` can be passed as is.\n *\n * @public\n */\n",
5302
+ "excerptTokens": [
5303
+ {
5304
+ "kind": "Content",
5305
+ "text": "export interface ErrorMonitoringClient "
5306
+ }
5307
+ ],
5308
+ "fileUrlPath": "src/error-monitoring/error-monitoring.ts",
5309
+ "releaseTag": "Public",
5310
+ "name": "ErrorMonitoringClient",
5311
+ "preserveMemberOrder": false,
5312
+ "members": [
5313
+ {
5314
+ "kind": "MethodSignature",
5315
+ "canonicalReference": "@genesislcap/foundation-utils!ErrorMonitoringClient#addBreadcrumb:member(1)",
5316
+ "docComment": "",
5317
+ "excerptTokens": [
5318
+ {
5319
+ "kind": "Content",
5320
+ "text": "addBreadcrumb?(breadcrumb: "
5321
+ },
5322
+ {
5323
+ "kind": "Reference",
5324
+ "text": "ErrorMonitoringBreadcrumb",
5325
+ "canonicalReference": "@genesislcap/foundation-utils!ErrorMonitoringBreadcrumb:interface"
5326
+ },
5327
+ {
5328
+ "kind": "Content",
5329
+ "text": " & {\n level?: "
5330
+ },
5331
+ {
5332
+ "kind": "Reference",
5333
+ "text": "ErrorMonitoringLevel",
5334
+ "canonicalReference": "@genesislcap/foundation-utils!ErrorMonitoringLevel:type"
5335
+ },
5336
+ {
5337
+ "kind": "Content",
5338
+ "text": ";\n }"
5339
+ },
5340
+ {
5341
+ "kind": "Content",
5342
+ "text": "): "
5343
+ },
5344
+ {
5345
+ "kind": "Content",
5346
+ "text": "unknown"
5347
+ },
5348
+ {
5349
+ "kind": "Content",
5350
+ "text": ";"
5351
+ }
5352
+ ],
5353
+ "isOptional": true,
5354
+ "returnTypeTokenRange": {
5355
+ "startIndex": 6,
5356
+ "endIndex": 7
5357
+ },
5358
+ "releaseTag": "Public",
5359
+ "overloadIndex": 1,
5360
+ "parameters": [
5361
+ {
5362
+ "parameterName": "breadcrumb",
5363
+ "parameterTypeTokenRange": {
5364
+ "startIndex": 1,
5365
+ "endIndex": 5
5366
+ },
5367
+ "isOptional": false
5368
+ }
5369
+ ],
5370
+ "name": "addBreadcrumb"
5371
+ },
5372
+ {
5373
+ "kind": "MethodSignature",
5374
+ "canonicalReference": "@genesislcap/foundation-utils!ErrorMonitoringClient#captureException:member(1)",
5375
+ "docComment": "",
5376
+ "excerptTokens": [
5377
+ {
5378
+ "kind": "Content",
5379
+ "text": "captureException(error: "
5380
+ },
5381
+ {
5382
+ "kind": "Content",
5383
+ "text": "unknown"
5384
+ },
5385
+ {
5386
+ "kind": "Content",
5387
+ "text": ", context?: "
5388
+ },
5389
+ {
5390
+ "kind": "Reference",
5391
+ "text": "ErrorMonitoringContext",
5392
+ "canonicalReference": "@genesislcap/foundation-utils!ErrorMonitoringContext:interface"
5393
+ },
5394
+ {
5395
+ "kind": "Content",
5396
+ "text": "): "
5397
+ },
5398
+ {
5399
+ "kind": "Content",
5400
+ "text": "unknown"
5401
+ },
5402
+ {
5403
+ "kind": "Content",
5404
+ "text": ";"
5405
+ }
5406
+ ],
5407
+ "isOptional": false,
5408
+ "returnTypeTokenRange": {
5409
+ "startIndex": 5,
5410
+ "endIndex": 6
5411
+ },
5412
+ "releaseTag": "Public",
5413
+ "overloadIndex": 1,
5414
+ "parameters": [
5415
+ {
5416
+ "parameterName": "error",
5417
+ "parameterTypeTokenRange": {
5418
+ "startIndex": 1,
5419
+ "endIndex": 2
5420
+ },
5421
+ "isOptional": false
5422
+ },
5423
+ {
5424
+ "parameterName": "context",
5425
+ "parameterTypeTokenRange": {
5426
+ "startIndex": 3,
5427
+ "endIndex": 4
5428
+ },
5429
+ "isOptional": true
5430
+ }
5431
+ ],
5432
+ "name": "captureException"
5433
+ },
5434
+ {
5435
+ "kind": "MethodSignature",
5436
+ "canonicalReference": "@genesislcap/foundation-utils!ErrorMonitoringClient#captureMessage:member(1)",
5437
+ "docComment": "",
5438
+ "excerptTokens": [
5439
+ {
5440
+ "kind": "Content",
5441
+ "text": "captureMessage(message: "
5442
+ },
5443
+ {
5444
+ "kind": "Content",
5445
+ "text": "string"
5446
+ },
5447
+ {
5448
+ "kind": "Content",
5449
+ "text": ", context?: "
5450
+ },
5451
+ {
5452
+ "kind": "Reference",
5453
+ "text": "ErrorMonitoringContext",
5454
+ "canonicalReference": "@genesislcap/foundation-utils!ErrorMonitoringContext:interface"
5455
+ },
5456
+ {
5457
+ "kind": "Content",
5458
+ "text": "): "
5459
+ },
5460
+ {
5461
+ "kind": "Content",
5462
+ "text": "unknown"
5463
+ },
5464
+ {
5465
+ "kind": "Content",
5466
+ "text": ";"
5467
+ }
5468
+ ],
5469
+ "isOptional": false,
5470
+ "returnTypeTokenRange": {
5471
+ "startIndex": 5,
5472
+ "endIndex": 6
5473
+ },
5474
+ "releaseTag": "Public",
5475
+ "overloadIndex": 1,
5476
+ "parameters": [
5477
+ {
5478
+ "parameterName": "message",
5479
+ "parameterTypeTokenRange": {
5480
+ "startIndex": 1,
5481
+ "endIndex": 2
5482
+ },
5483
+ "isOptional": false
5484
+ },
5485
+ {
5486
+ "parameterName": "context",
5487
+ "parameterTypeTokenRange": {
5488
+ "startIndex": 3,
5489
+ "endIndex": 4
5490
+ },
5491
+ "isOptional": true
5492
+ }
5493
+ ],
5494
+ "name": "captureMessage"
5495
+ },
5496
+ {
5497
+ "kind": "MethodSignature",
5498
+ "canonicalReference": "@genesislcap/foundation-utils!ErrorMonitoringClient#init:member(1)",
5499
+ "docComment": "",
5500
+ "excerptTokens": [
5501
+ {
5502
+ "kind": "Content",
5503
+ "text": "init?(options: "
5504
+ },
5505
+ {
5506
+ "kind": "Reference",
5507
+ "text": "ErrorMonitoringInitOptions",
5508
+ "canonicalReference": "@genesislcap/foundation-utils!ErrorMonitoringInitOptions:interface"
5509
+ },
5510
+ {
5511
+ "kind": "Content",
5512
+ "text": "): "
5513
+ },
5514
+ {
5515
+ "kind": "Content",
5516
+ "text": "unknown"
5517
+ },
5518
+ {
5519
+ "kind": "Content",
5520
+ "text": ";"
5521
+ }
5522
+ ],
5523
+ "isOptional": true,
5524
+ "returnTypeTokenRange": {
5525
+ "startIndex": 3,
5526
+ "endIndex": 4
5527
+ },
5528
+ "releaseTag": "Public",
5529
+ "overloadIndex": 1,
5530
+ "parameters": [
5531
+ {
5532
+ "parameterName": "options",
5533
+ "parameterTypeTokenRange": {
5534
+ "startIndex": 1,
5535
+ "endIndex": 2
5536
+ },
5537
+ "isOptional": false
5538
+ }
5539
+ ],
5540
+ "name": "init"
5541
+ }
5542
+ ],
5543
+ "extendsTokenRanges": []
5544
+ },
5545
+ {
5546
+ "kind": "Interface",
5547
+ "canonicalReference": "@genesislcap/foundation-utils!ErrorMonitoringContext:interface",
5548
+ "docComment": "/**\n * Context sent with a captured exception or message.\n *\n * @public\n */\n",
5549
+ "excerptTokens": [
5550
+ {
5551
+ "kind": "Content",
5552
+ "text": "export interface ErrorMonitoringContext "
5553
+ }
5554
+ ],
5555
+ "fileUrlPath": "src/error-monitoring/error-monitoring.ts",
5556
+ "releaseTag": "Public",
5557
+ "name": "ErrorMonitoringContext",
5558
+ "preserveMemberOrder": false,
5559
+ "members": [
5560
+ {
5561
+ "kind": "PropertySignature",
5562
+ "canonicalReference": "@genesislcap/foundation-utils!ErrorMonitoringContext#extra:member",
5563
+ "docComment": "",
5564
+ "excerptTokens": [
5565
+ {
5566
+ "kind": "Content",
5567
+ "text": "extra?: "
5568
+ },
5569
+ {
5570
+ "kind": "Reference",
5571
+ "text": "Record",
5572
+ "canonicalReference": "!Record:type"
5573
+ },
5574
+ {
5575
+ "kind": "Content",
5576
+ "text": "<string, unknown>"
5577
+ },
5578
+ {
5579
+ "kind": "Content",
5580
+ "text": ";"
5581
+ }
5582
+ ],
5583
+ "isReadonly": false,
5584
+ "isOptional": true,
5585
+ "releaseTag": "Public",
5586
+ "name": "extra",
5587
+ "propertyTypeTokenRange": {
5588
+ "startIndex": 1,
5589
+ "endIndex": 3
5590
+ }
5591
+ },
5592
+ {
5593
+ "kind": "PropertySignature",
5594
+ "canonicalReference": "@genesislcap/foundation-utils!ErrorMonitoringContext#level:member",
5595
+ "docComment": "",
5596
+ "excerptTokens": [
5597
+ {
5598
+ "kind": "Content",
5599
+ "text": "level?: "
5600
+ },
5601
+ {
5602
+ "kind": "Reference",
5603
+ "text": "ErrorMonitoringLevel",
5604
+ "canonicalReference": "@genesislcap/foundation-utils!ErrorMonitoringLevel:type"
5605
+ },
5606
+ {
5607
+ "kind": "Content",
5608
+ "text": ";"
5609
+ }
5610
+ ],
5611
+ "isReadonly": false,
5612
+ "isOptional": true,
5613
+ "releaseTag": "Public",
5614
+ "name": "level",
5615
+ "propertyTypeTokenRange": {
5616
+ "startIndex": 1,
5617
+ "endIndex": 2
5618
+ }
5619
+ },
5620
+ {
5621
+ "kind": "PropertySignature",
5622
+ "canonicalReference": "@genesislcap/foundation-utils!ErrorMonitoringContext#tags:member",
5623
+ "docComment": "",
5624
+ "excerptTokens": [
5625
+ {
5626
+ "kind": "Content",
5627
+ "text": "tags?: "
5628
+ },
5629
+ {
5630
+ "kind": "Reference",
5631
+ "text": "Record",
5632
+ "canonicalReference": "!Record:type"
5633
+ },
5634
+ {
5635
+ "kind": "Content",
5636
+ "text": "<string, string>"
5637
+ },
5638
+ {
5639
+ "kind": "Content",
5640
+ "text": ";"
5641
+ }
5642
+ ],
5643
+ "isReadonly": false,
5644
+ "isOptional": true,
5645
+ "releaseTag": "Public",
5646
+ "name": "tags",
5647
+ "propertyTypeTokenRange": {
5648
+ "startIndex": 1,
5649
+ "endIndex": 3
5650
+ }
5651
+ }
5652
+ ],
5653
+ "extendsTokenRanges": []
5654
+ },
5655
+ {
5656
+ "kind": "TypeAlias",
5657
+ "canonicalReference": "@genesislcap/foundation-utils!ErrorMonitoringEnvironmentResolver:type",
5658
+ "docComment": "/**\n * Picks the monitoring environment from the page's location, or returns `undefined` to leave monitoring off.\n *\n * @public\n */\n",
5659
+ "excerptTokens": [
5660
+ {
5661
+ "kind": "Content",
5662
+ "text": "export type ErrorMonitoringEnvironmentResolver = "
5663
+ },
5664
+ {
5665
+ "kind": "Content",
5666
+ "text": "(location: "
5667
+ },
5668
+ {
5669
+ "kind": "Reference",
5670
+ "text": "Location",
5671
+ "canonicalReference": "!Location:interface"
5672
+ },
5673
+ {
5674
+ "kind": "Content",
5675
+ "text": ") => string | undefined"
5676
+ },
5677
+ {
5678
+ "kind": "Content",
5679
+ "text": ";"
5680
+ }
5681
+ ],
5682
+ "fileUrlPath": "src/error-monitoring/error-monitoring.ts",
5683
+ "releaseTag": "Public",
5684
+ "name": "ErrorMonitoringEnvironmentResolver",
5685
+ "typeTokenRange": {
5686
+ "startIndex": 1,
5687
+ "endIndex": 4
5688
+ }
5689
+ },
5690
+ {
5691
+ "kind": "Interface",
5692
+ "canonicalReference": "@genesislcap/foundation-utils!ErrorMonitoringExtraInitOptions:interface",
5693
+ "docComment": "/**\n * Extra options for the client's `init`, merged into what {@link setupErrorMonitoring} passes.\n *\n * @public\n */\n",
5694
+ "excerptTokens": [
5695
+ {
5696
+ "kind": "Content",
5697
+ "text": "export interface ErrorMonitoringExtraInitOptions "
5698
+ }
5699
+ ],
5700
+ "fileUrlPath": "src/error-monitoring/error-monitoring.ts",
5701
+ "releaseTag": "Public",
5702
+ "name": "ErrorMonitoringExtraInitOptions",
5703
+ "preserveMemberOrder": false,
5704
+ "members": [
5705
+ {
5706
+ "kind": "IndexSignature",
5707
+ "canonicalReference": "@genesislcap/foundation-utils!ErrorMonitoringExtraInitOptions:index(1)",
5708
+ "docComment": "",
5709
+ "excerptTokens": [
5710
+ {
5711
+ "kind": "Content",
5712
+ "text": "[key: "
5713
+ },
5714
+ {
5715
+ "kind": "Content",
5716
+ "text": "string"
5717
+ },
5718
+ {
5719
+ "kind": "Content",
5720
+ "text": "]: "
5721
+ },
5722
+ {
5723
+ "kind": "Content",
5724
+ "text": "unknown"
5725
+ },
5726
+ {
5727
+ "kind": "Content",
5728
+ "text": ";"
5729
+ }
5730
+ ],
5731
+ "isReadonly": false,
5732
+ "returnTypeTokenRange": {
5733
+ "startIndex": 3,
5734
+ "endIndex": 4
5735
+ },
5736
+ "releaseTag": "Public",
5737
+ "overloadIndex": 1,
5738
+ "parameters": [
5739
+ {
5740
+ "parameterName": "key",
5741
+ "parameterTypeTokenRange": {
5742
+ "startIndex": 1,
5743
+ "endIndex": 2
5744
+ },
5745
+ "isOptional": false
5746
+ }
5747
+ ]
5748
+ },
5749
+ {
5750
+ "kind": "PropertySignature",
5751
+ "canonicalReference": "@genesislcap/foundation-utils!ErrorMonitoringExtraInitOptions#beforeBreadcrumb:member",
5752
+ "docComment": "/**\n * Runs after the built-in filter, for breadcrumbs it keeps, with the SDK's hint.\n */\n",
5753
+ "excerptTokens": [
5754
+ {
5755
+ "kind": "Content",
5756
+ "text": "beforeBreadcrumb?: "
5757
+ },
5758
+ {
5759
+ "kind": "Content",
5760
+ "text": "(breadcrumb: "
5761
+ },
5762
+ {
5763
+ "kind": "Reference",
5764
+ "text": "ErrorMonitoringBreadcrumb",
5765
+ "canonicalReference": "@genesislcap/foundation-utils!ErrorMonitoringBreadcrumb:interface"
5766
+ },
5767
+ {
5768
+ "kind": "Content",
5769
+ "text": ", hint?: "
5770
+ },
5771
+ {
5772
+ "kind": "Reference",
5773
+ "text": "ErrorMonitoringBreadcrumbHint",
5774
+ "canonicalReference": "@genesislcap/foundation-utils!ErrorMonitoringBreadcrumbHint:type"
5775
+ },
5776
+ {
5777
+ "kind": "Content",
5778
+ "text": ") => "
5779
+ },
5780
+ {
5781
+ "kind": "Reference",
5782
+ "text": "ErrorMonitoringBreadcrumb",
5783
+ "canonicalReference": "@genesislcap/foundation-utils!ErrorMonitoringBreadcrumb:interface"
5784
+ },
5785
+ {
5786
+ "kind": "Content",
5787
+ "text": " | null"
5788
+ },
5789
+ {
5790
+ "kind": "Content",
5791
+ "text": ";"
5792
+ }
5793
+ ],
5794
+ "isReadonly": false,
5795
+ "isOptional": true,
5796
+ "releaseTag": "Public",
5797
+ "name": "beforeBreadcrumb",
5798
+ "propertyTypeTokenRange": {
5799
+ "startIndex": 1,
5800
+ "endIndex": 8
5801
+ }
5802
+ }
5803
+ ],
5804
+ "extendsTokenRanges": []
5805
+ },
5806
+ {
5807
+ "kind": "Interface",
5808
+ "canonicalReference": "@genesislcap/foundation-utils!ErrorMonitoringInitOptions:interface",
5809
+ "docComment": "/**\n * Options {@link setupErrorMonitoring} passes to the client's `init`.\n *\n * @remarks\n *\n * The names match Sentry's `init` options. Any other keys from `initOptions` are passed through.\n *\n * @public\n */\n",
5810
+ "excerptTokens": [
5811
+ {
5812
+ "kind": "Content",
5813
+ "text": "export interface ErrorMonitoringInitOptions "
5814
+ }
5815
+ ],
5816
+ "fileUrlPath": "src/error-monitoring/error-monitoring.ts",
5817
+ "releaseTag": "Public",
5818
+ "name": "ErrorMonitoringInitOptions",
5819
+ "preserveMemberOrder": false,
5820
+ "members": [
5821
+ {
5822
+ "kind": "IndexSignature",
5823
+ "canonicalReference": "@genesislcap/foundation-utils!ErrorMonitoringInitOptions:index(1)",
5824
+ "docComment": "",
5825
+ "excerptTokens": [
5826
+ {
5827
+ "kind": "Content",
5828
+ "text": "[key: "
5829
+ },
5830
+ {
5831
+ "kind": "Content",
5832
+ "text": "string"
5833
+ },
5834
+ {
5835
+ "kind": "Content",
5836
+ "text": "]: "
5837
+ },
5838
+ {
5839
+ "kind": "Content",
5840
+ "text": "unknown"
5841
+ },
5842
+ {
5843
+ "kind": "Content",
5844
+ "text": ";"
5845
+ }
5846
+ ],
5847
+ "isReadonly": false,
5848
+ "returnTypeTokenRange": {
5849
+ "startIndex": 3,
5850
+ "endIndex": 4
5851
+ },
5852
+ "releaseTag": "Public",
5853
+ "overloadIndex": 1,
5854
+ "parameters": [
5855
+ {
5856
+ "parameterName": "key",
5857
+ "parameterTypeTokenRange": {
5858
+ "startIndex": 1,
5859
+ "endIndex": 2
5860
+ },
5861
+ "isOptional": false
5862
+ }
5863
+ ]
5864
+ },
5865
+ {
5866
+ "kind": "PropertySignature",
5867
+ "canonicalReference": "@genesislcap/foundation-utils!ErrorMonitoringInitOptions#beforeBreadcrumb:member",
5868
+ "docComment": "/**\n * Drops the console breadcrumbs foundation loggers write; see {@link isFoundationLoggerConsoleBreadcrumb}.\n */\n",
5869
+ "excerptTokens": [
5870
+ {
5871
+ "kind": "Content",
5872
+ "text": "beforeBreadcrumb?: "
5873
+ },
5874
+ {
5875
+ "kind": "Content",
5876
+ "text": "<B extends "
5877
+ },
5878
+ {
5879
+ "kind": "Reference",
5880
+ "text": "ErrorMonitoringBreadcrumb",
5881
+ "canonicalReference": "@genesislcap/foundation-utils!ErrorMonitoringBreadcrumb:interface"
5882
+ },
5883
+ {
5884
+ "kind": "Content",
5885
+ "text": ">(breadcrumb: B, hint?: "
5886
+ },
5887
+ {
5888
+ "kind": "Reference",
5889
+ "text": "ErrorMonitoringBreadcrumbHint",
5890
+ "canonicalReference": "@genesislcap/foundation-utils!ErrorMonitoringBreadcrumbHint:type"
5891
+ },
5892
+ {
5893
+ "kind": "Content",
5894
+ "text": ") => B | null"
5895
+ },
5896
+ {
5897
+ "kind": "Content",
5898
+ "text": ";"
5899
+ }
5900
+ ],
5901
+ "isReadonly": false,
5902
+ "isOptional": true,
5903
+ "releaseTag": "Public",
5904
+ "name": "beforeBreadcrumb",
5905
+ "propertyTypeTokenRange": {
5906
+ "startIndex": 1,
5907
+ "endIndex": 6
5908
+ }
5909
+ },
5910
+ {
5911
+ "kind": "PropertySignature",
5912
+ "canonicalReference": "@genesislcap/foundation-utils!ErrorMonitoringInitOptions#dsn:member",
5913
+ "docComment": "",
5914
+ "excerptTokens": [
5915
+ {
5916
+ "kind": "Content",
5917
+ "text": "dsn: "
5918
+ },
5919
+ {
5920
+ "kind": "Content",
5921
+ "text": "string"
5922
+ },
5923
+ {
5924
+ "kind": "Content",
5925
+ "text": ";"
5926
+ }
5927
+ ],
5928
+ "isReadonly": false,
5929
+ "isOptional": false,
5930
+ "releaseTag": "Public",
5931
+ "name": "dsn",
5932
+ "propertyTypeTokenRange": {
5933
+ "startIndex": 1,
5934
+ "endIndex": 2
5935
+ }
5936
+ },
5937
+ {
5938
+ "kind": "PropertySignature",
5939
+ "canonicalReference": "@genesislcap/foundation-utils!ErrorMonitoringInitOptions#environment:member",
5940
+ "docComment": "",
5941
+ "excerptTokens": [
5942
+ {
5943
+ "kind": "Content",
5944
+ "text": "environment: "
5945
+ },
5946
+ {
5947
+ "kind": "Content",
5948
+ "text": "string"
5949
+ },
5950
+ {
5951
+ "kind": "Content",
5952
+ "text": ";"
5953
+ }
5954
+ ],
5955
+ "isReadonly": false,
5956
+ "isOptional": false,
5957
+ "releaseTag": "Public",
5958
+ "name": "environment",
5959
+ "propertyTypeTokenRange": {
5960
+ "startIndex": 1,
5961
+ "endIndex": 2
5962
+ }
5963
+ }
5964
+ ],
5965
+ "extendsTokenRanges": []
5966
+ },
5967
+ {
5968
+ "kind": "TypeAlias",
5969
+ "canonicalReference": "@genesislcap/foundation-utils!ErrorMonitoringLevel:type",
5970
+ "docComment": "/**\n * Severity of a monitoring event or breadcrumb.\n *\n * @public\n */\n",
5971
+ "excerptTokens": [
5972
+ {
5973
+ "kind": "Content",
5974
+ "text": "export type ErrorMonitoringLevel = "
4884
5975
  },
4885
5976
  {
4886
5977
  "kind": "Content",
4887
- "text": ">, 'get' | 'has' | 'delete' | 'clear' | 'size' | 'values'>"
5978
+ "text": "'fatal' | 'error' | 'warning' | 'info' | 'debug'"
4888
5979
  },
4889
5980
  {
4890
5981
  "kind": "Content",
4891
- "text": " "
5982
+ "text": ";"
4892
5983
  }
4893
5984
  ],
4894
- "fileUrlPath": "src/error/errorMap.ts",
5985
+ "fileUrlPath": "src/error-monitoring/error-monitoring.ts",
4895
5986
  "releaseTag": "Public",
4896
- "typeParameters": [
5987
+ "name": "ErrorMonitoringLevel",
5988
+ "typeTokenRange": {
5989
+ "startIndex": 1,
5990
+ "endIndex": 2
5991
+ }
5992
+ },
5993
+ {
5994
+ "kind": "Interface",
5995
+ "canonicalReference": "@genesislcap/foundation-utils!ErrorMonitoringOptions:interface",
5996
+ "docComment": "/**\n * Options for {@link setupErrorMonitoring}.\n *\n * @public\n */\n",
5997
+ "excerptTokens": [
4897
5998
  {
4898
- "typeParameterName": "TErrorDetailMap",
4899
- "constraintTokenRange": {
4900
- "startIndex": 1,
4901
- "endIndex": 2
4902
- },
4903
- "defaultTypeTokenRange": {
4904
- "startIndex": 0,
4905
- "endIndex": 0
4906
- }
5999
+ "kind": "Content",
6000
+ "text": "export interface ErrorMonitoringOptions "
4907
6001
  }
4908
6002
  ],
4909
- "name": "ErrorMap",
6003
+ "fileUrlPath": "src/error-monitoring/error-monitoring.ts",
6004
+ "releaseTag": "Public",
6005
+ "name": "ErrorMonitoringOptions",
4910
6006
  "preserveMemberOrder": false,
4911
6007
  "members": [
4912
6008
  {
4913
6009
  "kind": "PropertySignature",
4914
- "canonicalReference": "@genesislcap/foundation-utils!ErrorMap#lastError:member",
4915
- "docComment": "/**\n * The last set error if any.\n *\n * @returns Error\n *\n * @public\n */\n",
6010
+ "canonicalReference": "@genesislcap/foundation-utils!ErrorMonitoringOptions#breadcrumbs:member",
6011
+ "docComment": "/**\n * Records non-error foundation logs as breadcrumbs. Defaults to `true`.\n */\n",
4916
6012
  "excerptTokens": [
4917
6013
  {
4918
6014
  "kind": "Content",
4919
- "text": "readonly lastError: "
6015
+ "text": "breadcrumbs?: "
4920
6016
  },
4921
6017
  {
4922
- "kind": "Reference",
4923
- "text": "Error",
4924
- "canonicalReference": "!Error:interface"
6018
+ "kind": "Content",
6019
+ "text": "boolean"
4925
6020
  },
4926
6021
  {
4927
6022
  "kind": "Content",
4928
6023
  "text": ";"
4929
6024
  }
4930
6025
  ],
4931
- "isReadonly": true,
4932
- "isOptional": false,
6026
+ "isReadonly": false,
6027
+ "isOptional": true,
4933
6028
  "releaseTag": "Public",
4934
- "name": "lastError",
6029
+ "name": "breadcrumbs",
4935
6030
  "propertyTypeTokenRange": {
4936
6031
  "startIndex": 1,
4937
6032
  "endIndex": 2
@@ -4939,126 +6034,129 @@
4939
6034
  },
4940
6035
  {
4941
6036
  "kind": "PropertySignature",
4942
- "canonicalReference": "@genesislcap/foundation-utils!ErrorMap#messages:member",
4943
- "docComment": "/**\n * Error map as messages.\n *\n * @returns string\n *\n * @public\n */\n",
6037
+ "canonicalReference": "@genesislcap/foundation-utils!ErrorMonitoringOptions#dsn:member",
6038
+ "docComment": "/**\n * The DSN events are sent to. Without one, monitoring stays off.\n */\n",
4944
6039
  "excerptTokens": [
4945
6040
  {
4946
6041
  "kind": "Content",
4947
- "text": "readonly messages: "
6042
+ "text": "dsn: "
4948
6043
  },
4949
6044
  {
4950
6045
  "kind": "Content",
4951
- "text": "string"
6046
+ "text": "string | undefined"
4952
6047
  },
4953
6048
  {
4954
6049
  "kind": "Content",
4955
6050
  "text": ";"
4956
6051
  }
4957
6052
  ],
4958
- "isReadonly": true,
6053
+ "isReadonly": false,
4959
6054
  "isOptional": false,
4960
6055
  "releaseTag": "Public",
4961
- "name": "messages",
6056
+ "name": "dsn",
4962
6057
  "propertyTypeTokenRange": {
4963
6058
  "startIndex": 1,
4964
6059
  "endIndex": 2
4965
6060
  }
4966
6061
  },
4967
6062
  {
4968
- "kind": "MethodSignature",
4969
- "canonicalReference": "@genesislcap/foundation-utils!ErrorMap#set:member(1)",
4970
- "docComment": "/**\n * Set an error by key.\n *\n * @param key - The key.\n *\n * @param error - The error.\n *\n * @public\n */\n",
6063
+ "kind": "PropertySignature",
6064
+ "canonicalReference": "@genesislcap/foundation-utils!ErrorMonitoringOptions#environment:member",
6065
+ "docComment": "/**\n * The environment events are tagged with, or a function that picks it from the page's location. Defaults to the page's hostname, and leaves monitoring off on local hosts: `localhost`, `*.localhost`, `*.local`, `0.0.0.0`, `host.docker.internal`, and loopback, private, link-local and shared (`100.64.0.0/10`, as Tailscale uses) IP addresses, IPv4-mapped IPv6 included.\n */\n",
4971
6066
  "excerptTokens": [
4972
6067
  {
4973
6068
  "kind": "Content",
4974
- "text": "set(key: "
6069
+ "text": "environment?: "
4975
6070
  },
4976
6071
  {
4977
6072
  "kind": "Content",
4978
- "text": "keyof TErrorDetailMap"
6073
+ "text": "string | "
4979
6074
  },
4980
6075
  {
4981
- "kind": "Content",
4982
- "text": ", error: "
6076
+ "kind": "Reference",
6077
+ "text": "ErrorMonitoringEnvironmentResolver",
6078
+ "canonicalReference": "@genesislcap/foundation-utils!ErrorMonitoringEnvironmentResolver:type"
4983
6079
  },
4984
6080
  {
4985
- "kind": "Reference",
4986
- "text": "Error",
4987
- "canonicalReference": "!Error:interface"
6081
+ "kind": "Content",
6082
+ "text": ";"
6083
+ }
6084
+ ],
6085
+ "isReadonly": false,
6086
+ "isOptional": true,
6087
+ "releaseTag": "Public",
6088
+ "name": "environment",
6089
+ "propertyTypeTokenRange": {
6090
+ "startIndex": 1,
6091
+ "endIndex": 3
6092
+ }
6093
+ },
6094
+ {
6095
+ "kind": "PropertySignature",
6096
+ "canonicalReference": "@genesislcap/foundation-utils!ErrorMonitoringOptions#init:member",
6097
+ "docComment": "/**\n * Initialises the client in place of calling `client.init`.\n */\n",
6098
+ "excerptTokens": [
6099
+ {
6100
+ "kind": "Content",
6101
+ "text": "init?: "
4988
6102
  },
4989
6103
  {
4990
6104
  "kind": "Content",
4991
- "text": "): "
6105
+ "text": "(options: "
6106
+ },
6107
+ {
6108
+ "kind": "Reference",
6109
+ "text": "ErrorMonitoringInitOptions",
6110
+ "canonicalReference": "@genesislcap/foundation-utils!ErrorMonitoringInitOptions:interface"
4992
6111
  },
4993
6112
  {
4994
6113
  "kind": "Content",
4995
- "text": "void"
6114
+ "text": ") => unknown"
4996
6115
  },
4997
6116
  {
4998
6117
  "kind": "Content",
4999
6118
  "text": ";"
5000
6119
  }
5001
6120
  ],
5002
- "isOptional": false,
5003
- "returnTypeTokenRange": {
5004
- "startIndex": 5,
5005
- "endIndex": 6
5006
- },
6121
+ "isReadonly": false,
6122
+ "isOptional": true,
5007
6123
  "releaseTag": "Public",
5008
- "overloadIndex": 1,
5009
- "parameters": [
6124
+ "name": "init",
6125
+ "propertyTypeTokenRange": {
6126
+ "startIndex": 1,
6127
+ "endIndex": 4
6128
+ }
6129
+ },
6130
+ {
6131
+ "kind": "PropertySignature",
6132
+ "canonicalReference": "@genesislcap/foundation-utils!ErrorMonitoringOptions#initOptions:member",
6133
+ "docComment": "/**\n * Extra options merged into what the client's `init` receives, e.g. Sentry's `dataCollection`.\n */\n",
6134
+ "excerptTokens": [
5010
6135
  {
5011
- "parameterName": "key",
5012
- "parameterTypeTokenRange": {
5013
- "startIndex": 1,
5014
- "endIndex": 2
5015
- },
5016
- "isOptional": false
6136
+ "kind": "Content",
6137
+ "text": "initOptions?: "
5017
6138
  },
5018
6139
  {
5019
- "parameterName": "error",
5020
- "parameterTypeTokenRange": {
5021
- "startIndex": 3,
5022
- "endIndex": 4
5023
- },
5024
- "isOptional": false
6140
+ "kind": "Reference",
6141
+ "text": "ErrorMonitoringExtraInitOptions",
6142
+ "canonicalReference": "@genesislcap/foundation-utils!ErrorMonitoringExtraInitOptions:interface"
6143
+ },
6144
+ {
6145
+ "kind": "Content",
6146
+ "text": ";"
5025
6147
  }
5026
6148
  ],
5027
- "name": "set"
5028
- }
5029
- ],
5030
- "extendsTokenRanges": [
5031
- {
5032
- "startIndex": 3,
5033
- "endIndex": 9
5034
- }
5035
- ]
5036
- },
5037
- {
5038
- "kind": "TypeAlias",
5039
- "canonicalReference": "@genesislcap/foundation-utils!ErrorMapLogger:type",
5040
- "docComment": "/**\n * @public\n */\n",
5041
- "excerptTokens": [
5042
- {
5043
- "kind": "Content",
5044
- "text": "export type ErrorMapLogger = "
5045
- },
5046
- {
5047
- "kind": "Content",
5048
- "text": "(...args: any[]) => void"
5049
- },
5050
- {
5051
- "kind": "Content",
5052
- "text": ";"
6149
+ "isReadonly": false,
6150
+ "isOptional": true,
6151
+ "releaseTag": "Public",
6152
+ "name": "initOptions",
6153
+ "propertyTypeTokenRange": {
6154
+ "startIndex": 1,
6155
+ "endIndex": 2
6156
+ }
5053
6157
  }
5054
6158
  ],
5055
- "fileUrlPath": "src/error/errorMap.ts",
5056
- "releaseTag": "Public",
5057
- "name": "ErrorMapLogger",
5058
- "typeTokenRange": {
5059
- "startIndex": 1,
5060
- "endIndex": 2
5061
- }
6159
+ "extendsTokenRanges": []
5062
6160
  },
5063
6161
  {
5064
6162
  "kind": "TypeAlias",
@@ -8331,6 +9429,48 @@
8331
9429
  ],
8332
9430
  "name": "isFeatureActivated"
8333
9431
  },
9432
+ {
9433
+ "kind": "Function",
9434
+ "canonicalReference": "@genesislcap/foundation-utils!isFoundationLoggerConsoleBreadcrumb:function(1)",
9435
+ "docComment": "/**\n * True for a console breadcrumb written by a foundation logger.\n *\n * @remarks\n *\n * consola's browser output starts with a `%c` badge (after a timestamp, when timestamps are on) styled as a pill, and SDKs that record console calls join the arguments with `String()`, so these breadcrumbs arrive as CSS and `[object Object]`, and they carry the logged arguments as data. The reporter from {@link createErrorMonitoringReporter} records the same logs' messages without the data. Other `%c`-styled console output doesn't match.\n *\n * @public\n */\n",
9436
+ "excerptTokens": [
9437
+ {
9438
+ "kind": "Content",
9439
+ "text": "isFoundationLoggerConsoleBreadcrumb: (breadcrumb: "
9440
+ },
9441
+ {
9442
+ "kind": "Reference",
9443
+ "text": "ErrorMonitoringBreadcrumb",
9444
+ "canonicalReference": "@genesislcap/foundation-utils!ErrorMonitoringBreadcrumb:interface"
9445
+ },
9446
+ {
9447
+ "kind": "Content",
9448
+ "text": ") => "
9449
+ },
9450
+ {
9451
+ "kind": "Content",
9452
+ "text": "boolean"
9453
+ }
9454
+ ],
9455
+ "fileUrlPath": "src/error-monitoring/error-monitoring.ts",
9456
+ "returnTypeTokenRange": {
9457
+ "startIndex": 3,
9458
+ "endIndex": 4
9459
+ },
9460
+ "releaseTag": "Public",
9461
+ "overloadIndex": 1,
9462
+ "parameters": [
9463
+ {
9464
+ "parameterName": "breadcrumb",
9465
+ "parameterTypeTokenRange": {
9466
+ "startIndex": 1,
9467
+ "endIndex": 2
9468
+ },
9469
+ "isOptional": false
9470
+ }
9471
+ ],
9472
+ "name": "isFoundationLoggerConsoleBreadcrumb"
9473
+ },
8334
9474
  {
8335
9475
  "kind": "Function",
8336
9476
  "canonicalReference": "@genesislcap/foundation-utils!JSONReplacer:function(1)",
@@ -18010,6 +19150,74 @@
18010
19150
  "endIndex": 2
18011
19151
  }
18012
19152
  },
19153
+ {
19154
+ "kind": "Function",
19155
+ "canonicalReference": "@genesislcap/foundation-utils!setupErrorMonitoring:function(1)",
19156
+ "docComment": "/**\n * Sets up error monitoring for a Genesis app in one call.\n *\n * @remarks\n *\n * Without a DSN, or when no environment applies (by default on local hosts such as `localhost` or a private IP address), it does nothing and resolves `false`. The environment defaults to the page's hostname, so one image promoted across environments reports each under its own name; pass a function to map hostnames to names such as `uat`. Otherwise it:\n *\n * - initialises the client (`client.init`, or `options.init`) with the DSN, environment, a `beforeBreadcrumb` that drops the SDK's console breadcrumbs for foundation logger output (they carry the logged arguments), and any `initOptions`; - registers a global log reporter ({@link createErrorMonitoringReporter}), so errors logged by every foundation logger, including those Genesis packages create at import time, are reported, and other logs become breadcrumbs. Only log messages and exceptions are sent, never logged data.\n *\n * Logs written while an asynchronous `init` runs (the last 100) are reported once it finishes. If `init` throws or rejects, for example when a lazily loaded SDK fails to download, it warns on the console and resolves `false` rather than rejecting.\n *\n * Errors caught by the foundation-react-utils `AppErrorBoundary` and `TileErrorBoundary` are logged with their reference ID and component stack in the message, so they are reported too without an `onError`. Pair them with `onCaughtError` on the React root.\n *\n * Calling it again replaces the previous reporter, or removes it if the new call has no DSN or environment. When calls overlap, only the last one takes effect, and the earlier ones resolve `false`.\n *\n * @param client - The monitoring SDK (for example the Sentry namespace) or an adapter for one.\n *\n * @param options - The DSN, the environment, and extra init options.\n *\n * @returns Whether this call enabled monitoring.\n *\n * @example\n * ```ts\n * import * as Sentry from '@sentry/react';\n * import { setupErrorMonitoring } from '@genesislcap/foundation-utils';\n *\n * setupErrorMonitoring(Sentry, {\n * dsn: 'https://<key>@<org>.ingest.sentry.io/<project>',\n * environment: ({ hostname }) => ({ 'app-uat.example.com': 'uat', 'app.example.com': 'prod' })[hostname],\n * });\n * ```\n *\n * @public\n */\n",
19157
+ "excerptTokens": [
19158
+ {
19159
+ "kind": "Content",
19160
+ "text": "export declare function setupErrorMonitoring(client: "
19161
+ },
19162
+ {
19163
+ "kind": "Reference",
19164
+ "text": "ErrorMonitoringClient",
19165
+ "canonicalReference": "@genesislcap/foundation-utils!ErrorMonitoringClient:interface"
19166
+ },
19167
+ {
19168
+ "kind": "Content",
19169
+ "text": ", options: "
19170
+ },
19171
+ {
19172
+ "kind": "Reference",
19173
+ "text": "ErrorMonitoringOptions",
19174
+ "canonicalReference": "@genesislcap/foundation-utils!ErrorMonitoringOptions:interface"
19175
+ },
19176
+ {
19177
+ "kind": "Content",
19178
+ "text": "): "
19179
+ },
19180
+ {
19181
+ "kind": "Reference",
19182
+ "text": "Promise",
19183
+ "canonicalReference": "!Promise:interface"
19184
+ },
19185
+ {
19186
+ "kind": "Content",
19187
+ "text": "<boolean>"
19188
+ },
19189
+ {
19190
+ "kind": "Content",
19191
+ "text": ";"
19192
+ }
19193
+ ],
19194
+ "fileUrlPath": "src/error-monitoring/error-monitoring.ts",
19195
+ "returnTypeTokenRange": {
19196
+ "startIndex": 5,
19197
+ "endIndex": 7
19198
+ },
19199
+ "releaseTag": "Public",
19200
+ "overloadIndex": 1,
19201
+ "parameters": [
19202
+ {
19203
+ "parameterName": "client",
19204
+ "parameterTypeTokenRange": {
19205
+ "startIndex": 1,
19206
+ "endIndex": 2
19207
+ },
19208
+ "isOptional": false
19209
+ },
19210
+ {
19211
+ "parameterName": "options",
19212
+ "parameterTypeTokenRange": {
19213
+ "startIndex": 3,
19214
+ "endIndex": 4
19215
+ },
19216
+ "isOptional": false
19217
+ }
19218
+ ],
19219
+ "name": "setupErrorMonitoring"
19220
+ },
18013
19221
  {
18014
19222
  "kind": "Variable",
18015
19223
  "canonicalReference": "@genesislcap/foundation-utils!SHORTCUT_BLOCKED_DEFAULT_MESSAGE:var",