@fabricorg/platform 0.3.2 → 0.4.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.
package/dist/index.d.cts CHANGED
@@ -4,7 +4,7 @@ export { AssetEventActorType, AssetEventEnvelope, AssetEventSubjectType, AssetEv
4
4
  export { FABRIC_ID_PREFIXES, FabricIdPrefix, createFabricId, isFabricId, parseFabricId } from './ids/index.cjs';
5
5
  export { EventTypeRegistration, EventTypeRegistrationInput, FabricModule, IdPrefixRegistration, ModuleDependency, ModuleDependencyInput, ModuleDisplayRendererRegistration, ModuleRegistry, ObjectTypeRegistration, ObjectTypeRegistrationInput, PolicyRegistration, StateMachineRegistration, createModuleRegistry, getEventTypeName, getModuleDependencyNamespace, getObjectTypeName, registerFabricModule, registerFabricModules, validateModuleNamespace } from './modules/index.cjs';
6
6
  export { FabricObjectType, assertObjectType, getRegisteredObjectTypes, isValidObjectType, registerObjectType } from './objects/index.cjs';
7
- export { DataPolicyComparisonOperator, DataPolicyCondition, DataPolicyConditionResult, DataPolicyDefinition, DataPolicyLiteral, DataPolicySource, DataPolicySourceReference, DataPolicyValidationResult, PolicyContext, PolicyDispatchEvidence, PolicyEvaluationMode, PolicyEvaluationResult, PolicyEvaluator, PolicyFallbackDefinition, PolicyFallbackTrigger, PolicyId, PolicyKind, PolicyOutcome, RuntimePolicyDefinition, aggregatePolicyOutcomes, assertPolicyId, evaluatePolicyDefinition, evaluatePolicyDefinitions, evaluateRegisteredPolicies, getRegisteredPolicyIds, registerPolicy, registerPolicyIfMissing, resolvePolicy, validateDataPolicyDefinition } from './policies/index.cjs';
7
+ export { DataPolicyComparisonOperator, DataPolicyCondition, DataPolicyConditionResult, DataPolicyDefinition, DataPolicyLiteral, DataPolicySource, DataPolicySourceReference, DataPolicyValidationResult, PolicyContext, PolicyCorrectiveAction, PolicyDispatchEvidence, PolicyEvaluationMode, PolicyEvaluationResult, PolicyEvaluator, PolicyFact, PolicyFallbackDefinition, PolicyFallbackTrigger, PolicyGuidance, PolicyId, PolicyKind, PolicyOutcome, RuntimePolicyDefinition, aggregatePolicyOutcomes, assertPolicyId, evaluatePolicyDefinition, evaluatePolicyDefinitions, evaluateRegisteredPolicies, getRegisteredPolicyIds, registerPolicy, registerPolicyIfMissing, resolvePolicy, validateDataPolicyDefinition } from './policies/index.cjs';
8
8
  export { StateClass, StateDefinition, StateMachineDatabaseClient, StateMachineDefinition, TransitionContext, getAllowedTransitions, getEntityStateClass, registerStateMachine, registerStateMachineIfMissing, resolveStateMachine, validateTransition } from './state-machines/index.cjs';
9
9
  export { ReplayEventsOptions, ReplayEventsResult, ReplayScope, ReplaySnapshot, ReplayWarning, ReplayWarningCode, ReplayableAssetEvent, replayEvents } from './projections/index.cjs';
10
10
  export { CachedDisplayDescriptor, DisplayContext, DisplayDatabaseClient, DisplayDescriptor, DisplayRenderer, DisplayRendererRegistration, denormalizeDisplaySnapshot, registerDisplayRenderer, renderEventDisplay, resolveDisplayRenderer } from './displays/index.cjs';
package/dist/index.d.ts CHANGED
@@ -4,7 +4,7 @@ export { AssetEventActorType, AssetEventEnvelope, AssetEventSubjectType, AssetEv
4
4
  export { FABRIC_ID_PREFIXES, FabricIdPrefix, createFabricId, isFabricId, parseFabricId } from './ids/index.js';
5
5
  export { EventTypeRegistration, EventTypeRegistrationInput, FabricModule, IdPrefixRegistration, ModuleDependency, ModuleDependencyInput, ModuleDisplayRendererRegistration, ModuleRegistry, ObjectTypeRegistration, ObjectTypeRegistrationInput, PolicyRegistration, StateMachineRegistration, createModuleRegistry, getEventTypeName, getModuleDependencyNamespace, getObjectTypeName, registerFabricModule, registerFabricModules, validateModuleNamespace } from './modules/index.js';
6
6
  export { FabricObjectType, assertObjectType, getRegisteredObjectTypes, isValidObjectType, registerObjectType } from './objects/index.js';
7
- export { DataPolicyComparisonOperator, DataPolicyCondition, DataPolicyConditionResult, DataPolicyDefinition, DataPolicyLiteral, DataPolicySource, DataPolicySourceReference, DataPolicyValidationResult, PolicyContext, PolicyDispatchEvidence, PolicyEvaluationMode, PolicyEvaluationResult, PolicyEvaluator, PolicyFallbackDefinition, PolicyFallbackTrigger, PolicyId, PolicyKind, PolicyOutcome, RuntimePolicyDefinition, aggregatePolicyOutcomes, assertPolicyId, evaluatePolicyDefinition, evaluatePolicyDefinitions, evaluateRegisteredPolicies, getRegisteredPolicyIds, registerPolicy, registerPolicyIfMissing, resolvePolicy, validateDataPolicyDefinition } from './policies/index.js';
7
+ export { DataPolicyComparisonOperator, DataPolicyCondition, DataPolicyConditionResult, DataPolicyDefinition, DataPolicyLiteral, DataPolicySource, DataPolicySourceReference, DataPolicyValidationResult, PolicyContext, PolicyCorrectiveAction, PolicyDispatchEvidence, PolicyEvaluationMode, PolicyEvaluationResult, PolicyEvaluator, PolicyFact, PolicyFallbackDefinition, PolicyFallbackTrigger, PolicyGuidance, PolicyId, PolicyKind, PolicyOutcome, RuntimePolicyDefinition, aggregatePolicyOutcomes, assertPolicyId, evaluatePolicyDefinition, evaluatePolicyDefinitions, evaluateRegisteredPolicies, getRegisteredPolicyIds, registerPolicy, registerPolicyIfMissing, resolvePolicy, validateDataPolicyDefinition } from './policies/index.js';
8
8
  export { StateClass, StateDefinition, StateMachineDatabaseClient, StateMachineDefinition, TransitionContext, getAllowedTransitions, getEntityStateClass, registerStateMachine, registerStateMachineIfMissing, resolveStateMachine, validateTransition } from './state-machines/index.js';
9
9
  export { ReplayEventsOptions, ReplayEventsResult, ReplayScope, ReplaySnapshot, ReplayWarning, ReplayWarningCode, ReplayableAssetEvent, replayEvents } from './projections/index.js';
10
10
  export { CachedDisplayDescriptor, DisplayContext, DisplayDatabaseClient, DisplayDescriptor, DisplayRenderer, DisplayRendererRegistration, denormalizeDisplaySnapshot, registerDisplayRenderer, renderEventDisplay, resolveDisplayRenderer } from './displays/index.js';
package/dist/index.js CHANGED
@@ -4,9 +4,9 @@ export { createDeterministicIdFactory, createFakeActionContext, createInMemoryAd
4
4
  export { AdapterRegistry, MissingAdapterRegistrationError, executeWithAdapterRetry, getRetryDelayMs, resolveAdapterRetryPolicy } from './chunk-3ZW5USXF.js';
5
5
  import './chunk-OZLZHISS.js';
6
6
  export { FABRIC_ID_PREFIXES, createFabricId, isFabricId, parseFabricId } from './chunk-RALMUSOX.js';
7
- export { createModuleRegistry, getEventTypeName, getModuleDependencyNamespace, getObjectTypeName, registerFabricModule, registerFabricModules, validateModuleNamespace } from './chunk-D75BI4XU.js';
7
+ export { createModuleRegistry, getEventTypeName, getModuleDependencyNamespace, getObjectTypeName, registerFabricModule, registerFabricModules, validateModuleNamespace } from './chunk-CSZXUX5V.js';
8
8
  export { assertObjectType, getRegisteredObjectTypes, isValidObjectType, registerObjectType } from './chunk-I35B576X.js';
9
- export { aggregatePolicyOutcomes, assertPolicyId, evaluatePolicyDefinition, evaluatePolicyDefinitions, evaluateRegisteredPolicies, getRegisteredPolicyIds, registerPolicy, registerPolicyIfMissing, resolvePolicy, validateDataPolicyDefinition } from './chunk-KU22MNH7.js';
9
+ export { aggregatePolicyOutcomes, assertPolicyId, evaluatePolicyDefinition, evaluatePolicyDefinitions, evaluateRegisteredPolicies, getRegisteredPolicyIds, registerPolicy, registerPolicyIfMissing, resolvePolicy, validateDataPolicyDefinition } from './chunk-I3BMSYDF.js';
10
10
  export { getAllowedTransitions, getEntityStateClass, registerStateMachine, registerStateMachineIfMissing, resolveStateMachine, validateTransition } from './chunk-T2JLSZN6.js';
11
11
  export { ACTOR_TYPES, assertActionId, assertActorType, getRegisteredActionIds, isActorType, isRegisteredActionId, registerAction, registerActionIfMissing, resolveAction, resolveRegisteredAction } from './chunk-BJYRMUN2.js';
12
12
  export { denormalizeDisplaySnapshot, registerDisplayRenderer, renderEventDisplay, resolveDisplayRenderer } from './chunk-O5WVBQ7P.js';
@@ -1,8 +1,8 @@
1
1
  'use strict';
2
2
 
3
- var chunkE7HPD4N3_cjs = require('../chunk-E7HPD4N3.cjs');
3
+ var chunkP76WWJIJ_cjs = require('../chunk-P76WWJIJ.cjs');
4
4
  require('../chunk-QETQGAXJ.cjs');
5
- require('../chunk-5UAKU3LH.cjs');
5
+ require('../chunk-DBZRPM72.cjs');
6
6
  require('../chunk-UV252FLT.cjs');
7
7
  require('../chunk-RMI3BIND.cjs');
8
8
  require('../chunk-EO4VSB2O.cjs');
@@ -12,31 +12,31 @@ require('../chunk-JAXDEK5Z.cjs');
12
12
 
13
13
  Object.defineProperty(exports, "createModuleRegistry", {
14
14
  enumerable: true,
15
- get: function () { return chunkE7HPD4N3_cjs.createModuleRegistry; }
15
+ get: function () { return chunkP76WWJIJ_cjs.createModuleRegistry; }
16
16
  });
17
17
  Object.defineProperty(exports, "getEventTypeName", {
18
18
  enumerable: true,
19
- get: function () { return chunkE7HPD4N3_cjs.getEventTypeName; }
19
+ get: function () { return chunkP76WWJIJ_cjs.getEventTypeName; }
20
20
  });
21
21
  Object.defineProperty(exports, "getModuleDependencyNamespace", {
22
22
  enumerable: true,
23
- get: function () { return chunkE7HPD4N3_cjs.getModuleDependencyNamespace; }
23
+ get: function () { return chunkP76WWJIJ_cjs.getModuleDependencyNamespace; }
24
24
  });
25
25
  Object.defineProperty(exports, "getObjectTypeName", {
26
26
  enumerable: true,
27
- get: function () { return chunkE7HPD4N3_cjs.getObjectTypeName; }
27
+ get: function () { return chunkP76WWJIJ_cjs.getObjectTypeName; }
28
28
  });
29
29
  Object.defineProperty(exports, "registerFabricModule", {
30
30
  enumerable: true,
31
- get: function () { return chunkE7HPD4N3_cjs.registerFabricModule; }
31
+ get: function () { return chunkP76WWJIJ_cjs.registerFabricModule; }
32
32
  });
33
33
  Object.defineProperty(exports, "registerFabricModules", {
34
34
  enumerable: true,
35
- get: function () { return chunkE7HPD4N3_cjs.registerFabricModules; }
35
+ get: function () { return chunkP76WWJIJ_cjs.registerFabricModules; }
36
36
  });
37
37
  Object.defineProperty(exports, "validateModuleNamespace", {
38
38
  enumerable: true,
39
- get: function () { return chunkE7HPD4N3_cjs.validateModuleNamespace; }
39
+ get: function () { return chunkP76WWJIJ_cjs.validateModuleNamespace; }
40
40
  });
41
41
  //# sourceMappingURL=index.cjs.map
42
42
  //# sourceMappingURL=index.cjs.map
@@ -1,6 +1,6 @@
1
- export { createModuleRegistry, getEventTypeName, getModuleDependencyNamespace, getObjectTypeName, registerFabricModule, registerFabricModules, validateModuleNamespace } from '../chunk-D75BI4XU.js';
1
+ export { createModuleRegistry, getEventTypeName, getModuleDependencyNamespace, getObjectTypeName, registerFabricModule, registerFabricModules, validateModuleNamespace } from '../chunk-CSZXUX5V.js';
2
2
  import '../chunk-I35B576X.js';
3
- import '../chunk-KU22MNH7.js';
3
+ import '../chunk-I3BMSYDF.js';
4
4
  import '../chunk-T2JLSZN6.js';
5
5
  import '../chunk-BJYRMUN2.js';
6
6
  import '../chunk-O5WVBQ7P.js';
@@ -1,48 +1,48 @@
1
1
  'use strict';
2
2
 
3
- var chunk5UAKU3LH_cjs = require('../chunk-5UAKU3LH.cjs');
3
+ var chunkDBZRPM72_cjs = require('../chunk-DBZRPM72.cjs');
4
4
 
5
5
 
6
6
 
7
7
  Object.defineProperty(exports, "aggregatePolicyOutcomes", {
8
8
  enumerable: true,
9
- get: function () { return chunk5UAKU3LH_cjs.aggregatePolicyOutcomes; }
9
+ get: function () { return chunkDBZRPM72_cjs.aggregatePolicyOutcomes; }
10
10
  });
11
11
  Object.defineProperty(exports, "assertPolicyId", {
12
12
  enumerable: true,
13
- get: function () { return chunk5UAKU3LH_cjs.assertPolicyId; }
13
+ get: function () { return chunkDBZRPM72_cjs.assertPolicyId; }
14
14
  });
15
15
  Object.defineProperty(exports, "evaluatePolicyDefinition", {
16
16
  enumerable: true,
17
- get: function () { return chunk5UAKU3LH_cjs.evaluatePolicyDefinition; }
17
+ get: function () { return chunkDBZRPM72_cjs.evaluatePolicyDefinition; }
18
18
  });
19
19
  Object.defineProperty(exports, "evaluatePolicyDefinitions", {
20
20
  enumerable: true,
21
- get: function () { return chunk5UAKU3LH_cjs.evaluatePolicyDefinitions; }
21
+ get: function () { return chunkDBZRPM72_cjs.evaluatePolicyDefinitions; }
22
22
  });
23
23
  Object.defineProperty(exports, "evaluateRegisteredPolicies", {
24
24
  enumerable: true,
25
- get: function () { return chunk5UAKU3LH_cjs.evaluateRegisteredPolicies; }
25
+ get: function () { return chunkDBZRPM72_cjs.evaluateRegisteredPolicies; }
26
26
  });
27
27
  Object.defineProperty(exports, "getRegisteredPolicyIds", {
28
28
  enumerable: true,
29
- get: function () { return chunk5UAKU3LH_cjs.getRegisteredPolicyIds; }
29
+ get: function () { return chunkDBZRPM72_cjs.getRegisteredPolicyIds; }
30
30
  });
31
31
  Object.defineProperty(exports, "registerPolicy", {
32
32
  enumerable: true,
33
- get: function () { return chunk5UAKU3LH_cjs.registerPolicy; }
33
+ get: function () { return chunkDBZRPM72_cjs.registerPolicy; }
34
34
  });
35
35
  Object.defineProperty(exports, "registerPolicyIfMissing", {
36
36
  enumerable: true,
37
- get: function () { return chunk5UAKU3LH_cjs.registerPolicyIfMissing; }
37
+ get: function () { return chunkDBZRPM72_cjs.registerPolicyIfMissing; }
38
38
  });
39
39
  Object.defineProperty(exports, "resolvePolicy", {
40
40
  enumerable: true,
41
- get: function () { return chunk5UAKU3LH_cjs.resolvePolicy; }
41
+ get: function () { return chunkDBZRPM72_cjs.resolvePolicy; }
42
42
  });
43
43
  Object.defineProperty(exports, "validateDataPolicyDefinition", {
44
44
  enumerable: true,
45
- get: function () { return chunk5UAKU3LH_cjs.validateDataPolicyDefinition; }
45
+ get: function () { return chunkDBZRPM72_cjs.validateDataPolicyDefinition; }
46
46
  });
47
47
  //# sourceMappingURL=index.cjs.map
48
48
  //# sourceMappingURL=index.cjs.map
@@ -23,12 +23,35 @@ interface PolicyContext<TDb = unknown> {
23
23
  */
24
24
  services?: FabricRuntimeServices;
25
25
  }
26
+ interface PolicyFact {
27
+ name: string;
28
+ value: unknown;
29
+ label?: string;
30
+ }
31
+ interface PolicyCorrectiveAction {
32
+ label: string;
33
+ description?: string;
34
+ actionId?: string;
35
+ parameters?: Record<string, unknown>;
36
+ target?: {
37
+ surface?: string;
38
+ tab?: string;
39
+ field?: string;
40
+ };
41
+ requiresConfirmation?: boolean;
42
+ }
43
+ interface PolicyGuidance {
44
+ summary?: string;
45
+ factsUsed: PolicyFact[];
46
+ correctiveActions: PolicyCorrectiveAction[];
47
+ }
26
48
  interface PolicyOutcome {
27
49
  policyId: PolicyId;
28
50
  policyVersion: number;
29
51
  policyKind?: PolicyKind;
30
52
  result: PolicyEvaluationResult;
31
53
  reason?: string;
54
+ guidance?: PolicyGuidance;
32
55
  metadata?: Record<string, unknown>;
33
56
  dispatchEvidence?: PolicyDispatchEvidence;
34
57
  }
@@ -166,4 +189,4 @@ declare function evaluatePolicyDefinition(policy: RuntimePolicyDefinition, ctx:
166
189
  declare function validateDataPolicyDefinition(definition: DataPolicyDefinition): DataPolicyValidationResult;
167
190
  declare function aggregatePolicyOutcomes(outcomes: PolicyOutcome[]): PolicyOutcome | undefined;
168
191
 
169
- export { type DataPolicyComparisonOperator, type DataPolicyCondition, type DataPolicyConditionResult, type DataPolicyDefinition, type DataPolicyLiteral, type DataPolicySource, type DataPolicySourceReference, type DataPolicyValidationResult, type PolicyContext, type PolicyDispatchEvidence, type PolicyEvaluationMode, type PolicyEvaluationResult, type PolicyEvaluator, type PolicyFallbackDefinition, type PolicyFallbackTrigger, type PolicyId, type PolicyKind, type PolicyOutcome, type RuntimePolicyDefinition, aggregatePolicyOutcomes, assertPolicyId, evaluatePolicyDefinition, evaluatePolicyDefinitions, evaluateRegisteredPolicies, getRegisteredPolicyIds, registerPolicy, registerPolicyIfMissing, resolvePolicy, validateDataPolicyDefinition };
192
+ export { type DataPolicyComparisonOperator, type DataPolicyCondition, type DataPolicyConditionResult, type DataPolicyDefinition, type DataPolicyLiteral, type DataPolicySource, type DataPolicySourceReference, type DataPolicyValidationResult, type PolicyContext, type PolicyCorrectiveAction, type PolicyDispatchEvidence, type PolicyEvaluationMode, type PolicyEvaluationResult, type PolicyEvaluator, type PolicyFact, type PolicyFallbackDefinition, type PolicyFallbackTrigger, type PolicyGuidance, type PolicyId, type PolicyKind, type PolicyOutcome, type RuntimePolicyDefinition, aggregatePolicyOutcomes, assertPolicyId, evaluatePolicyDefinition, evaluatePolicyDefinitions, evaluateRegisteredPolicies, getRegisteredPolicyIds, registerPolicy, registerPolicyIfMissing, resolvePolicy, validateDataPolicyDefinition };
@@ -23,12 +23,35 @@ interface PolicyContext<TDb = unknown> {
23
23
  */
24
24
  services?: FabricRuntimeServices;
25
25
  }
26
+ interface PolicyFact {
27
+ name: string;
28
+ value: unknown;
29
+ label?: string;
30
+ }
31
+ interface PolicyCorrectiveAction {
32
+ label: string;
33
+ description?: string;
34
+ actionId?: string;
35
+ parameters?: Record<string, unknown>;
36
+ target?: {
37
+ surface?: string;
38
+ tab?: string;
39
+ field?: string;
40
+ };
41
+ requiresConfirmation?: boolean;
42
+ }
43
+ interface PolicyGuidance {
44
+ summary?: string;
45
+ factsUsed: PolicyFact[];
46
+ correctiveActions: PolicyCorrectiveAction[];
47
+ }
26
48
  interface PolicyOutcome {
27
49
  policyId: PolicyId;
28
50
  policyVersion: number;
29
51
  policyKind?: PolicyKind;
30
52
  result: PolicyEvaluationResult;
31
53
  reason?: string;
54
+ guidance?: PolicyGuidance;
32
55
  metadata?: Record<string, unknown>;
33
56
  dispatchEvidence?: PolicyDispatchEvidence;
34
57
  }
@@ -166,4 +189,4 @@ declare function evaluatePolicyDefinition(policy: RuntimePolicyDefinition, ctx:
166
189
  declare function validateDataPolicyDefinition(definition: DataPolicyDefinition): DataPolicyValidationResult;
167
190
  declare function aggregatePolicyOutcomes(outcomes: PolicyOutcome[]): PolicyOutcome | undefined;
168
191
 
169
- export { type DataPolicyComparisonOperator, type DataPolicyCondition, type DataPolicyConditionResult, type DataPolicyDefinition, type DataPolicyLiteral, type DataPolicySource, type DataPolicySourceReference, type DataPolicyValidationResult, type PolicyContext, type PolicyDispatchEvidence, type PolicyEvaluationMode, type PolicyEvaluationResult, type PolicyEvaluator, type PolicyFallbackDefinition, type PolicyFallbackTrigger, type PolicyId, type PolicyKind, type PolicyOutcome, type RuntimePolicyDefinition, aggregatePolicyOutcomes, assertPolicyId, evaluatePolicyDefinition, evaluatePolicyDefinitions, evaluateRegisteredPolicies, getRegisteredPolicyIds, registerPolicy, registerPolicyIfMissing, resolvePolicy, validateDataPolicyDefinition };
192
+ export { type DataPolicyComparisonOperator, type DataPolicyCondition, type DataPolicyConditionResult, type DataPolicyDefinition, type DataPolicyLiteral, type DataPolicySource, type DataPolicySourceReference, type DataPolicyValidationResult, type PolicyContext, type PolicyCorrectiveAction, type PolicyDispatchEvidence, type PolicyEvaluationMode, type PolicyEvaluationResult, type PolicyEvaluator, type PolicyFact, type PolicyFallbackDefinition, type PolicyFallbackTrigger, type PolicyGuidance, type PolicyId, type PolicyKind, type PolicyOutcome, type RuntimePolicyDefinition, aggregatePolicyOutcomes, assertPolicyId, evaluatePolicyDefinition, evaluatePolicyDefinitions, evaluateRegisteredPolicies, getRegisteredPolicyIds, registerPolicy, registerPolicyIfMissing, resolvePolicy, validateDataPolicyDefinition };
@@ -1,3 +1,3 @@
1
- export { aggregatePolicyOutcomes, assertPolicyId, evaluatePolicyDefinition, evaluatePolicyDefinitions, evaluateRegisteredPolicies, getRegisteredPolicyIds, registerPolicy, registerPolicyIfMissing, resolvePolicy, validateDataPolicyDefinition } from '../chunk-KU22MNH7.js';
1
+ export { aggregatePolicyOutcomes, assertPolicyId, evaluatePolicyDefinition, evaluatePolicyDefinitions, evaluateRegisteredPolicies, getRegisteredPolicyIds, registerPolicy, registerPolicyIfMissing, resolvePolicy, validateDataPolicyDefinition } from '../chunk-I3BMSYDF.js';
2
2
  //# sourceMappingURL=index.js.map
3
3
  //# sourceMappingURL=index.js.map