@cratis/chronicle 6.54.0 → 6.56.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 (170) hide show
  1. package/ChronicleClient.ts +16 -3
  2. package/ChronicleOptions.ts +11 -0
  3. package/EventStore.ts +8 -3
  4. package/WellKnownTelemetryNames.ts +2 -0
  5. package/artifacts/refuseClientHostedObservers.ts +16 -0
  6. package/connection/ChronicleConnection.auth.spec.ts +2 -0
  7. package/connection/ChronicleConnection.ts +21 -9
  8. package/connection/ChronicleConnectionString.ts +26 -1
  9. package/connection/ClientObserversRequireKeepAlive.ts +10 -0
  10. package/connection/for_ChronicleConnection/when_deferring_client_creation/and_connecting.spec.ts +83 -0
  11. package/connection/for_TraceContextMiddleware/when_calling/with_active_context.spec.ts +1 -0
  12. package/connection/for_TraceContextMiddleware/when_calling/with_grpc_instrumentation.spec.ts +1 -0
  13. package/dist/ChronicleClient.d.ts +1 -0
  14. package/dist/ChronicleClient.d.ts.map +1 -1
  15. package/dist/ChronicleClient.js +16 -3
  16. package/dist/ChronicleClient.js.map +1 -1
  17. package/dist/ChronicleOptions.d.ts +4 -0
  18. package/dist/ChronicleOptions.d.ts.map +1 -1
  19. package/dist/ChronicleOptions.js +7 -0
  20. package/dist/ChronicleOptions.js.map +1 -1
  21. package/dist/EventStore.d.ts +2 -1
  22. package/dist/EventStore.d.ts.map +1 -1
  23. package/dist/EventStore.js +10 -3
  24. package/dist/EventStore.js.map +1 -1
  25. package/dist/WellKnownTelemetryNames.d.ts +2 -0
  26. package/dist/WellKnownTelemetryNames.d.ts.map +1 -1
  27. package/dist/WellKnownTelemetryNames.js +2 -0
  28. package/dist/WellKnownTelemetryNames.js.map +1 -1
  29. package/dist/artifacts/refuseClientHostedObservers.d.ts +4 -0
  30. package/dist/artifacts/refuseClientHostedObservers.d.ts.map +1 -0
  31. package/dist/artifacts/refuseClientHostedObservers.js +15 -0
  32. package/dist/artifacts/refuseClientHostedObservers.js.map +1 -0
  33. package/dist/connection/ChronicleConnection.d.ts +7 -1
  34. package/dist/connection/ChronicleConnection.d.ts.map +1 -1
  35. package/dist/connection/ChronicleConnection.js +13 -8
  36. package/dist/connection/ChronicleConnection.js.map +1 -1
  37. package/dist/connection/ChronicleConnectionString.d.ts +8 -0
  38. package/dist/connection/ChronicleConnectionString.d.ts.map +1 -1
  39. package/dist/connection/ChronicleConnectionString.js +21 -1
  40. package/dist/connection/ChronicleConnectionString.js.map +1 -1
  41. package/dist/connection/ClientObserversRequireKeepAlive.d.ts +7 -0
  42. package/dist/connection/ClientObserversRequireKeepAlive.d.ts.map +1 -0
  43. package/dist/connection/ClientObserversRequireKeepAlive.js +14 -0
  44. package/dist/connection/ClientObserversRequireKeepAlive.js.map +1 -0
  45. package/dist/eventSequences/EventSequence.d.ts +3 -0
  46. package/dist/eventSequences/EventSequence.d.ts.map +1 -1
  47. package/dist/eventSequences/EventSequence.js +29 -1
  48. package/dist/eventSequences/EventSequence.js.map +1 -1
  49. package/dist/eventSequences/IEventSequence.d.ts +12 -0
  50. package/dist/eventSequences/IEventSequence.d.ts.map +1 -1
  51. package/dist/eventSequences/ITransactionalEventSequence.d.ts +6 -0
  52. package/dist/eventSequences/ITransactionalEventSequence.d.ts.map +1 -1
  53. package/dist/eventSequences/TransactionalEventSequence.d.ts.map +1 -1
  54. package/dist/eventSequences/TransactionalEventSequence.js +3 -1
  55. package/dist/eventSequences/TransactionalEventSequence.js.map +1 -1
  56. package/dist/externalServices/ExternalServiceBuilder.js +1 -1
  57. package/dist/externalServices/ExternalServiceBuilder.js.map +1 -1
  58. package/dist/for_ChronicleClient/when_skipping_keep_alive/native-exit-probe.d.ts +2 -0
  59. package/dist/for_ChronicleClient/when_skipping_keep_alive/native-exit-probe.d.ts.map +1 -0
  60. package/dist/for_ChronicleClient/when_skipping_keep_alive/native-exit-probe.js +107 -0
  61. package/dist/for_ChronicleClient/when_skipping_keep_alive/native-exit-probe.js.map +1 -0
  62. package/dist/index.d.ts +1 -0
  63. package/dist/index.d.ts.map +1 -1
  64. package/dist/index.js +1 -0
  65. package/dist/index.js.map +1 -1
  66. package/dist/reactors/Reactors.d.ts +2 -1
  67. package/dist/reactors/Reactors.d.ts.map +1 -1
  68. package/dist/reactors/Reactors.js +12 -3
  69. package/dist/reactors/Reactors.js.map +1 -1
  70. package/dist/readModels/for_ReadModels/given/a_stored_read_model.d.ts.map +1 -1
  71. package/dist/readModels/for_ReadModels/given/a_stored_read_model.js +1 -1
  72. package/dist/readModels/for_ReadModels/given/a_stored_read_model.js.map +1 -1
  73. package/dist/readModels/indexDecorator.js +1 -1
  74. package/dist/readModels/indexDecorator.js.map +1 -1
  75. package/dist/reducers/Reducers.d.ts +2 -1
  76. package/dist/reducers/Reducers.d.ts.map +1 -1
  77. package/dist/reducers/Reducers.js +8 -2
  78. package/dist/reducers/Reducers.js.map +1 -1
  79. package/dist/reducers/ReductionOutcome.d.ts.map +1 -1
  80. package/dist/reducers/ReductionOutcome.js +4 -1
  81. package/dist/reducers/ReductionOutcome.js.map +1 -1
  82. package/dist/testing/InProcessEventSequence.d.ts +2 -1
  83. package/dist/testing/InProcessEventSequence.d.ts.map +1 -1
  84. package/dist/testing/InProcessEventSequence.js +1 -0
  85. package/dist/testing/InProcessEventSequence.js.map +1 -1
  86. package/dist/transactions/AppendOptionNotSupportedInUnitOfWork.d.ts +13 -0
  87. package/dist/transactions/AppendOptionNotSupportedInUnitOfWork.d.ts.map +1 -0
  88. package/dist/transactions/AppendOptionNotSupportedInUnitOfWork.js +19 -0
  89. package/dist/transactions/AppendOptionNotSupportedInUnitOfWork.js.map +1 -0
  90. package/dist/transactions/ConflictingAppendOptionNamesInUnitOfWork.d.ts +14 -0
  91. package/dist/transactions/ConflictingAppendOptionNamesInUnitOfWork.d.ts.map +1 -0
  92. package/dist/transactions/ConflictingAppendOptionNamesInUnitOfWork.js +21 -0
  93. package/dist/transactions/ConflictingAppendOptionNamesInUnitOfWork.js.map +1 -0
  94. package/dist/transactions/IUnitOfWork.d.ts +3 -0
  95. package/dist/transactions/IUnitOfWork.d.ts.map +1 -1
  96. package/dist/transactions/TransactionalAppendOptions.d.ts +8 -0
  97. package/dist/transactions/TransactionalAppendOptions.d.ts.map +1 -1
  98. package/dist/transactions/UnitOfWork.d.ts.map +1 -1
  99. package/dist/transactions/UnitOfWork.js +4 -2
  100. package/dist/transactions/UnitOfWork.js.map +1 -1
  101. package/dist/transactions/concurrencyScopesAreEqual.d.ts.map +1 -1
  102. package/dist/transactions/concurrencyScopesAreEqual.js +4 -3
  103. package/dist/transactions/concurrencyScopesAreEqual.js.map +1 -1
  104. package/dist/transactions/index.d.ts +2 -0
  105. package/dist/transactions/index.d.ts.map +1 -1
  106. package/dist/transactions/index.js +2 -0
  107. package/dist/transactions/index.js.map +1 -1
  108. package/dist/transactions/resolveTransactionalAppendOptions.d.ts +8 -0
  109. package/dist/transactions/resolveTransactionalAppendOptions.d.ts.map +1 -0
  110. package/dist/transactions/resolveTransactionalAppendOptions.js +58 -0
  111. package/dist/transactions/resolveTransactionalAppendOptions.js.map +1 -0
  112. package/dist/tsconfig.tsbuildinfo +1 -1
  113. package/dist/webhooks/WebhookDefinitionBuilder.d.ts.map +1 -1
  114. package/dist/webhooks/WebhookDefinitionBuilder.js +4 -2
  115. package/dist/webhooks/WebhookDefinitionBuilder.js.map +1 -1
  116. package/dist/webhooks/Webhooks.d.ts.map +1 -1
  117. package/dist/webhooks/Webhooks.js +2 -1
  118. package/dist/webhooks/Webhooks.js.map +1 -1
  119. package/eventSequences/EventSequence.spec.ts +55 -0
  120. package/eventSequences/EventSequence.ts +30 -1
  121. package/eventSequences/IEventSequence.ts +13 -0
  122. package/eventSequences/ITransactionalEventSequence.ts +6 -0
  123. package/eventSequences/TransactionalEventSequence.ts +3 -1
  124. package/eventSequences/for_TransactionalEventSequence/when_appending_many_with_append_option_names.spec.ts +26 -0
  125. package/eventSequences/for_TransactionalEventSequence/when_appending_many_with_unsupported_options.spec.ts +35 -0
  126. package/externalServices/ExternalServiceBuilder.ts +1 -1
  127. package/externalServices/ExternalServices.spec.ts +1 -1
  128. package/for_ChronicleClient/against_a_kernel/when_skipping_keep_alive.integration.spec.ts +80 -0
  129. package/for_ChronicleClient/when_skipping_keep_alive/and_connecting.spec.ts +158 -0
  130. package/for_ChronicleClient/when_skipping_keep_alive/native-exit-probe.ts +84 -0
  131. package/for_ChronicleClient/when_starting_background_work/with_a_correlated_caller.spec.ts +1 -0
  132. package/for_ChronicleOptions/when_configuring_keep_alive/with_skip_keep_alive.spec.ts +35 -0
  133. package/for_EventStore/when_skipping_keep_alive/when_registering_artifacts.spec.ts +51 -0
  134. package/index.ts +1 -0
  135. package/package.json +2 -2
  136. package/reactors/Reactors.ts +10 -3
  137. package/reactors/for_Reactors/when_skipping_keep_alive/with_a_reactor.spec.ts +48 -0
  138. package/readModels/for_ReadModels/given/a_stored_read_model.ts +1 -1
  139. package/readModels/indexDecorator.legacy.spec.ts +7 -7
  140. package/readModels/indexDecorator.ts +1 -1
  141. package/readModels/indexRegistration.spec.ts +4 -4
  142. package/readModels/standardFallbacks.standard.spec.ts +2 -2
  143. package/reducers/Reducers.ts +6 -2
  144. package/reducers/ReductionOutcome.ts +4 -1
  145. package/reducers/for_Reducers/when_skipping_keep_alive/with_a_reducer.spec.ts +53 -0
  146. package/telemetry/for_ChronicleTelemetry/given/a_client.fixture.ts +1 -0
  147. package/telemetry/for_ChronicleTelemetry/given/a_span_name_registry.fixture.ts +2 -0
  148. package/telemetry/for_ChronicleTelemetry/given/an_event_sequence.fixture.ts +2 -1
  149. package/telemetry/for_ChronicleTelemetry/when_naming_spans/with_convention_names.spec.ts +1 -0
  150. package/telemetry/for_ChronicleTelemetry/when_recording_identifiers/with_per_client_privacy.spec.ts +2 -1
  151. package/testing/InProcessEventSequence.ts +1 -0
  152. package/transactions/AppendOptionNotSupportedInUnitOfWork.ts +17 -0
  153. package/transactions/ConflictingAppendOptionNamesInUnitOfWork.ts +17 -0
  154. package/transactions/IUnitOfWork.ts +3 -0
  155. package/transactions/TransactionalAppendOptions.ts +11 -0
  156. package/transactions/UnitOfWork.ts +4 -2
  157. package/transactions/concurrencyScopesAreEqual.ts +4 -3
  158. package/transactions/for_UnitOfWork/when_adding_events_with_append_option_names/and_both_names_have_different_values.spec.ts +65 -0
  159. package/transactions/for_UnitOfWork/when_adding_events_with_append_option_names/and_both_names_have_the_same_value.spec.ts +22 -0
  160. package/transactions/for_UnitOfWork/when_adding_events_with_append_option_names/and_the_append_option_names_are_used.spec.ts +25 -0
  161. package/transactions/for_UnitOfWork/when_adding_events_with_concurrency_scopes/and_a_routing_field_is_empty_versus_named.spec.ts +40 -0
  162. package/transactions/for_UnitOfWork/when_adding_events_with_concurrency_scopes/and_routing_fields_are_undefined_or_empty.spec.ts +39 -0
  163. package/transactions/for_UnitOfWork/when_adding_events_with_unsupported_append_options/and_a_correlation_id_is_given.spec.ts +38 -0
  164. package/transactions/for_UnitOfWork/when_adding_events_with_unsupported_append_options/and_an_event_source_id_is_given.spec.ts +38 -0
  165. package/transactions/for_UnitOfWork/when_adding_events_with_unsupported_append_options/and_concurrency_scopes_are_given.spec.ts +38 -0
  166. package/transactions/for_UnitOfWork/when_adding_events_with_unsupported_append_options/and_the_option_is_undefined.spec.ts +24 -0
  167. package/transactions/index.ts +2 -0
  168. package/transactions/resolveTransactionalAppendOptions.ts +68 -0
  169. package/webhooks/WebhookDefinitionBuilder.ts +4 -2
  170. package/webhooks/Webhooks.ts +2 -1
@@ -0,0 +1,24 @@
1
+ // Copyright (c) Cratis. All rights reserved.
2
+ // Licensed under the MIT license. See LICENSE file in the project root for full license information.
3
+
4
+ import { beforeEach, chai, describe, it } from 'vitest';
5
+ import type { AppendOptions } from '../../../eventSequences/AppendOptions.js';
6
+ import type { EventForEventSourceId } from '../../../eventSequences/EventForEventSourceId.js';
7
+ import { EventSequenceId } from '../../../eventSequences/EventSequenceId.js';
8
+ import { a_unit_of_work_with_a_recording_store } from '../given/a_unit_of_work_with_a_recording_store.js';
9
+
10
+ chai.should();
11
+
12
+ describe('when adding events and unsupported options are undefined', () => {
13
+ let entry: EventForEventSourceId;
14
+
15
+ beforeEach(async () => {
16
+ const { unitOfWork, appends } = a_unit_of_work_with_a_recording_store();
17
+ const options: AppendOptions = { correlationId: undefined, concurrencyScopes: undefined, eventSourceId: undefined, subject: 's' };
18
+ unitOfWork.addEvent(EventSequenceId.eventLog, 'a-1', {}, options);
19
+ await unitOfWork.commit();
20
+ entry = appends[0].events[0];
21
+ });
22
+
23
+ it('should keep the subject', () => entry.subject!.should.equal('s'));
24
+ });
@@ -9,3 +9,5 @@ export { UnitOfWorkManager } from './UnitOfWorkManager.js';
9
9
  export type { TransactionalEventRouting } from './TransactionalEventRouting.js';
10
10
  export type { TransactionalAppendOptions } from './TransactionalAppendOptions.js';
11
11
  export { ConflictingConcurrencyScopesInUnitOfWork } from './ConflictingConcurrencyScopesInUnitOfWork.js';
12
+ export { ConflictingAppendOptionNamesInUnitOfWork } from './ConflictingAppendOptionNamesInUnitOfWork.js';
13
+ export { AppendOptionNotSupportedInUnitOfWork } from './AppendOptionNotSupportedInUnitOfWork.js';
@@ -0,0 +1,68 @@
1
+ // Copyright (c) Cratis. All rights reserved.
2
+ // Licensed under the MIT license. See LICENSE file in the project root for full license information.
3
+
4
+ import type { TransactionalAppendOptions } from './TransactionalAppendOptions.js';
5
+ import { AppendOptionNotSupportedInUnitOfWork } from './AppendOptionNotSupportedInUnitOfWork.js';
6
+ import { ConflictingAppendOptionNamesInUnitOfWork } from './ConflictingAppendOptionNamesInUnitOfWork.js';
7
+
8
+ const unsupportedOptions = [
9
+ ['correlationId', 'The unit of work appends with its own correlation identifier; begin the unit of work with it instead: unitOfWorkManager.begin(correlationId).'],
10
+ ['concurrencyScopes', 'Give each event its own concurrencyScope; the unit of work combines them per event source identifier.'],
11
+ ['eventSourceId', 'The event source identifier is the append argument.']
12
+ ] as const;
13
+
14
+ const aliases = [
15
+ ['streamType', 'eventStreamType'],
16
+ ['streamId', 'eventStreamId'],
17
+ ['sourceType', 'eventSourceType']
18
+ ] as const;
19
+
20
+ type OptionValues = Record<string, unknown>;
21
+
22
+ function throwIfUnsupported(values: Readonly<OptionValues>): void {
23
+ const unsupported = unsupportedOptions.find(([optionName]) => values[optionName] !== undefined);
24
+ if (unsupported) {
25
+ throw new AppendOptionNotSupportedInUnitOfWork(unsupported[0], unsupported[1]);
26
+ }
27
+ }
28
+
29
+ function isConflicting(values: Readonly<OptionValues>, appendOptionName: string, transactionalOptionName: string): boolean {
30
+ const appendValue = values[appendOptionName];
31
+ const transactionalValue = values[transactionalOptionName];
32
+ return appendValue !== undefined && transactionalValue !== undefined && appendValue !== transactionalValue;
33
+ }
34
+
35
+ function throwIfConflicting(values: Readonly<OptionValues>): void {
36
+ const conflict = aliases.find(([appendOptionName, transactionalOptionName]) => isConflicting(values, appendOptionName, transactionalOptionName));
37
+ if (conflict) {
38
+ throw new ConflictingAppendOptionNamesInUnitOfWork(conflict[0], conflict[1]);
39
+ }
40
+ }
41
+
42
+ function normalizeAliases(values: Readonly<OptionValues>): OptionValues {
43
+ const normalized: OptionValues = { ...values };
44
+ for (const [appendOptionName, transactionalOptionName] of aliases) {
45
+ const value = values[transactionalOptionName] ?? values[appendOptionName];
46
+ delete normalized[appendOptionName];
47
+ delete normalized[transactionalOptionName];
48
+ if (value !== undefined) {
49
+ normalized[transactionalOptionName] = value;
50
+ }
51
+ }
52
+ return normalized;
53
+ }
54
+
55
+ /**
56
+ * Validates transactional append options and normalizes ordinary append option aliases.
57
+ * @param options - Optional metadata for an event added to a unit of work.
58
+ * @returns The options with aliases replaced by their transactional names.
59
+ */
60
+ export function resolveTransactionalAppendOptions(options?: TransactionalAppendOptions): TransactionalAppendOptions | undefined {
61
+ if (options === undefined) {
62
+ return undefined;
63
+ }
64
+ const values = options as Readonly<OptionValues>;
65
+ throwIfUnsupported(values);
66
+ throwIfConflicting(values);
67
+ return normalizeAliases(values) as TransactionalAppendOptions;
68
+ }
@@ -70,7 +70,8 @@ export class WebhookDefinitionBuilder implements IWebhookDefinitionBuilder {
70
70
  const value: OAuthAuthorization = {
71
71
  Authority: authority,
72
72
  ClientId: clientId,
73
- ClientSecret: clientSecret
73
+ ClientSecret: clientSecret,
74
+ Scope: ''
74
75
  };
75
76
  this._authorization = {
76
77
  Value0: undefined,
@@ -136,7 +137,8 @@ export class WebhookDefinitionBuilder implements IWebhookDefinitionBuilder {
136
137
  Target: {
137
138
  Url: targetUrl.value,
138
139
  Authorization: this._authorization,
139
- Headers: Object.fromEntries(this._headers)
140
+ Headers: Object.fromEntries(this._headers),
141
+ ManagedIdentity: undefined
140
142
  },
141
143
  IsReplayable: this._isReplayable,
142
144
  IsActive: this._isActive,
@@ -99,7 +99,8 @@ export class Webhooks implements IWebhooks {
99
99
  Target: {
100
100
  Url: webhook.Url,
101
101
  Authorization: undefined,
102
- Headers: webhook.Headers
102
+ Headers: webhook.Headers,
103
+ ManagedIdentity: undefined
103
104
  },
104
105
  IsReplayable: webhook.IsReplayable,
105
106
  IsActive: webhook.IsActive,