@timeax/digital-service-engine 0.3.5 → 0.3.6

package/dist/core/index.d.cts

@@ -175,7 +175,7 @@ type NodeRef = {
 };
 type NodeMap = Map<string, NodeRef>;
 
-type ValidationCode = "root_missing" | "cycle_in_tags" | "bad_bind_reference" | "duplicate_id" | "duplicate_tag_label" | "duplicate_field_name" | "label_missing" | "duplicate_visible_label" | "bad_option_key" | "option_include_exclude_conflict" | "service_field_missing_service_id" | "user_input_field_has_service_option" | "rate_mismatch_across_base" | "rate_coherence_violation" | "utility_without_base" | "unsupported_constraint" | "constraint_contradiction" | "custom_component_missing" | "policy_violation" | "field_unbound" | "constraint_overridden" | "unsupported_constraint_option" | "custom_component_unresolvable" | "quantity_multiple_markers" | "utility_with_service_id" | "utility_missing_rate" | "utility_invalid_mode" | "fallback_bad_node" | "fallback_unknown_service" | "fallback_cycle" | "fallback_no_primary" | "fallback_rate_violation" | "fallback_constraint_mismatch" | "fallback_no_tag_context" | "field_validation_invalid_rule" | "field_validation_invalid_op" | "field_validation_eval_missing_code" | "field_validation_between_missing_bounds" | "field_validation_match_missing_pattern" | "multiple_order_kinds_selected";
+type ValidationCode = "root_missing" | "cycle_in_tags" | "bad_bind_reference" | "duplicate_id" | "duplicate_tag_label" | "duplicate_field_name" | "label_missing" | "duplicate_visible_label" | "bad_option_key" | "bad_option_effect_key" | "bad_option_effect_target" | "bad_option_effect_option" | "option_include_exclude_conflict" | "visibility_dependency_cycle" | "service_field_missing_service_id" | "user_input_field_has_service_option" | "rate_mismatch_across_base" | "rate_coherence_violation" | "utility_without_base" | "unsupported_constraint" | "constraint_contradiction" | "custom_component_missing" | "policy_violation" | "field_unbound" | "constraint_overridden" | "unsupported_constraint_option" | "custom_component_unresolvable" | "quantity_multiple_markers" | "utility_with_service_id" | "utility_missing_rate" | "utility_invalid_mode" | "fallback_bad_node" | "fallback_unknown_service" | "fallback_cycle" | "fallback_no_primary" | "fallback_rate_violation" | "fallback_constraint_mismatch" | "fallback_no_tag_context" | "field_validation_invalid_rule" | "field_validation_invalid_op" | "field_validation_eval_missing_code" | "field_validation_between_missing_bounds" | "field_validation_match_missing_pattern" | "multiple_order_kinds_selected";
 type ValidationError = {
     code: ValidationCode;
     message: string;
@@ -408,6 +408,22 @@ type FieldOption = {
     service_id?: ServiceIdRef;
     pricing_role?: PricingRole;
     meta?: Record<string, unknown> & UtilityMark & WithQuantityDefault;
+    children?: FieldOption[];
+};
+type OptionEffectForButton = {
+    /**
+     * If true, selecting this button/option may force the target field visible.
+     * If false/missing, the option filter only applies when the target field is already visible.
+     */
+    forceVisible?: boolean;
+    /**
+     * If present, only these option ids remain visible.
+     */
+    include?: string[];
+    /**
+     * Removed after include is applied.
+     */
+    exclude?: string[];
 };
 type Field = BaseFieldUI & {
     id: string;
@@ -461,6 +477,7 @@ type ServiceProps = {
     fields: Field[];
     includes_for_buttons?: Record<string, string[]>;
     excludes_for_buttons?: Record<string, string[]>;
+    option_effects_for_buttons?: Record<string, Record<string, OptionEffectForButton>>;
     schema_version?: string;
     fallbacks?: ServiceFallback;
     name?: string;
@@ -535,6 +552,12 @@ declare function validate(props: ServiceProps, ctx?: ValidatorOptions): Validati
  */
 declare function validateAsync(props: ServiceProps, ctx?: ValidatorOptions): Promise<ValidationError[]>;
 
+type ResolvedVisibility = {
+    fieldIds: string[];
+    optionsByFieldId: Record<string, string[]>;
+    forcedFieldIds: string[];
+};
+
 /** Options you can set on the builder (used for validation/visibility) */
 type BuilderOptions = Omit<ValidatorOptions, "serviceMap"> & {
     serviceMap?: DgpServiceMap;
@@ -560,6 +583,8 @@ interface Builder {
      * NOTE: keys are “button ids”: either option.id or field.id for option-less buttons.
      */
     visibleFields(tagId: string, selectedOptionKeys?: string[]): string[];
+    /** Compute field ids plus option visibility under a tag. */
+    resolveVisibility(tagId: string, selectedOptionKeys?: string[]): ResolvedVisibility;
     /** Update builder options (validator context etc.) */
     setOptions(patch: Partial<BuilderOptions>): void;
     /** Access the current props (already normalised) */
@@ -580,6 +605,26 @@ interface Builder {
 }
 declare function createBuilder(opts?: BuilderOptions): Builder;
 
+type OptionVisit = {
+    field: Field;
+    fieldId: string;
+    option: FieldOption;
+    optionId: string;
+    depth: number;
+    parentId?: string;
+};
+declare function walkFieldOptions(field: Field): OptionVisit[];
+declare function walkOptions(props: ServiceProps): OptionVisit[];
+declare function fieldOptionIds(field: Field): string[];
+declare function fieldOptionIdSet(field: Field): Set<string>;
+declare function findFieldOption(field: Field | undefined, optionId: string): FieldOption | undefined;
+declare function findOptionOwnerField(fields: Iterable<Field>, optionId: string): Field | undefined;
+declare function optionOwnerMap(fields: Iterable<Field>): Map<string, {
+    fieldId: string;
+    option: FieldOption;
+}>;
+declare function filterFieldOptionsById(options: readonly FieldOption[] | undefined, allowed: ReadonlySet<string>): FieldOption[] | undefined;
+
 type FailedFallbackContext = {
     scope: "node" | "global";
     nodeId?: string;
@@ -820,10 +865,7 @@ type BuildOrderSelection = {
     formValuesByFieldId: Record<string, Scalar | Scalar[]>;
     optionSelectionsByFieldId: Record<string, string[]>;
     selectedKeys?: string[];
-    optionTraversalOrder?: Array<{
-        fieldId: string;
-        optionId: string;
-    }>;
+    optionTraversalOrder?: string[];
 };
 
 declare function buildOrderSnapshot(props: ServiceProps, builder: Builder, selection: BuildOrderSelection, services: DgpServiceMap, settings?: BuildOrderSnapshotSettings): OrderSnapshot;
@@ -863,4 +905,4 @@ interface FallbackEditor {
 }
 declare function createFallbackEditor(options?: FallbackEditorOptions): FallbackEditor;
 
-export { type AncestryHit, type AnyNode, type Builder, type BuilderOptions, type FailedFallbackContext, type FallbackEditor, type FieldNode, type FilterServicesForVisibleGroupInput, type FilterServicesForVisibleGroupResult, type NodeIndex, type NodeKind, type NormaliseOptions, type OptionNode, type RateCoherenceDiagnostic, type RelKind, type ServiceCheck, type TagNode, type TriggerEffectMap, type TriggerEffects, type UnknownNode, type WithAncestry, buildOrderSnapshot, buildTriggerEffectMap, collectFailedFallbacks, createBuilder, createFallbackEditor, createNodeIndex, filterServicesForVisibleGroup, getAssignedServiceIds, getEligibleFallbacks, getFallbackRegistrationInfo, isRefExcludedBySelectedKeys, normalise, normalizeFieldValidation, resolveServiceFallback, validate, validateAsync, validateRateCoherenceDeep };
+export { type AncestryHit, type AnyNode, type Builder, type BuilderOptions, type FailedFallbackContext, type FallbackEditor, type FieldNode, type FilterServicesForVisibleGroupInput, type FilterServicesForVisibleGroupResult, type NodeIndex, type NodeKind, type NormaliseOptions, type OptionNode, type OptionVisit, type RateCoherenceDiagnostic, type RelKind, type ServiceCheck, type TagNode, type TriggerEffectMap, type TriggerEffects, type UnknownNode, type WithAncestry, buildOrderSnapshot, buildTriggerEffectMap, collectFailedFallbacks, createBuilder, createFallbackEditor, createNodeIndex, fieldOptionIdSet, fieldOptionIds, filterFieldOptionsById, filterServicesForVisibleGroup, findFieldOption, findOptionOwnerField, getAssignedServiceIds, getEligibleFallbacks, getFallbackRegistrationInfo, isRefExcludedBySelectedKeys, normalise, normalizeFieldValidation, optionOwnerMap, resolveServiceFallback, validate, validateAsync, validateRateCoherenceDeep, walkFieldOptions, walkOptions };

package/dist/core/index.d.ts

@@ -175,7 +175,7 @@ type NodeRef = {
 };
 type NodeMap = Map<string, NodeRef>;
 
-type ValidationCode = "root_missing" | "cycle_in_tags" | "bad_bind_reference" | "duplicate_id" | "duplicate_tag_label" | "duplicate_field_name" | "label_missing" | "duplicate_visible_label" | "bad_option_key" | "option_include_exclude_conflict" | "service_field_missing_service_id" | "user_input_field_has_service_option" | "rate_mismatch_across_base" | "rate_coherence_violation" | "utility_without_base" | "unsupported_constraint" | "constraint_contradiction" | "custom_component_missing" | "policy_violation" | "field_unbound" | "constraint_overridden" | "unsupported_constraint_option" | "custom_component_unresolvable" | "quantity_multiple_markers" | "utility_with_service_id" | "utility_missing_rate" | "utility_invalid_mode" | "fallback_bad_node" | "fallback_unknown_service" | "fallback_cycle" | "fallback_no_primary" | "fallback_rate_violation" | "fallback_constraint_mismatch" | "fallback_no_tag_context" | "field_validation_invalid_rule" | "field_validation_invalid_op" | "field_validation_eval_missing_code" | "field_validation_between_missing_bounds" | "field_validation_match_missing_pattern" | "multiple_order_kinds_selected";
+type ValidationCode = "root_missing" | "cycle_in_tags" | "bad_bind_reference" | "duplicate_id" | "duplicate_tag_label" | "duplicate_field_name" | "label_missing" | "duplicate_visible_label" | "bad_option_key" | "bad_option_effect_key" | "bad_option_effect_target" | "bad_option_effect_option" | "option_include_exclude_conflict" | "visibility_dependency_cycle" | "service_field_missing_service_id" | "user_input_field_has_service_option" | "rate_mismatch_across_base" | "rate_coherence_violation" | "utility_without_base" | "unsupported_constraint" | "constraint_contradiction" | "custom_component_missing" | "policy_violation" | "field_unbound" | "constraint_overridden" | "unsupported_constraint_option" | "custom_component_unresolvable" | "quantity_multiple_markers" | "utility_with_service_id" | "utility_missing_rate" | "utility_invalid_mode" | "fallback_bad_node" | "fallback_unknown_service" | "fallback_cycle" | "fallback_no_primary" | "fallback_rate_violation" | "fallback_constraint_mismatch" | "fallback_no_tag_context" | "field_validation_invalid_rule" | "field_validation_invalid_op" | "field_validation_eval_missing_code" | "field_validation_between_missing_bounds" | "field_validation_match_missing_pattern" | "multiple_order_kinds_selected";
 type ValidationError = {
     code: ValidationCode;
     message: string;
@@ -408,6 +408,22 @@ type FieldOption = {
     service_id?: ServiceIdRef;
     pricing_role?: PricingRole;
     meta?: Record<string, unknown> & UtilityMark & WithQuantityDefault;
+    children?: FieldOption[];
+};
+type OptionEffectForButton = {
+    /**
+     * If true, selecting this button/option may force the target field visible.
+     * If false/missing, the option filter only applies when the target field is already visible.
+     */
+    forceVisible?: boolean;
+    /**
+     * If present, only these option ids remain visible.
+     */
+    include?: string[];
+    /**
+     * Removed after include is applied.
+     */
+    exclude?: string[];
 };
 type Field = BaseFieldUI & {
     id: string;
@@ -461,6 +477,7 @@ type ServiceProps = {
     fields: Field[];
     includes_for_buttons?: Record<string, string[]>;
     excludes_for_buttons?: Record<string, string[]>;
+    option_effects_for_buttons?: Record<string, Record<string, OptionEffectForButton>>;
     schema_version?: string;
     fallbacks?: ServiceFallback;
     name?: string;
@@ -535,6 +552,12 @@ declare function validate(props: ServiceProps, ctx?: ValidatorOptions): Validati
  */
 declare function validateAsync(props: ServiceProps, ctx?: ValidatorOptions): Promise<ValidationError[]>;
 
+type ResolvedVisibility = {
+    fieldIds: string[];
+    optionsByFieldId: Record<string, string[]>;
+    forcedFieldIds: string[];
+};
+
 /** Options you can set on the builder (used for validation/visibility) */
 type BuilderOptions = Omit<ValidatorOptions, "serviceMap"> & {
     serviceMap?: DgpServiceMap;
@@ -560,6 +583,8 @@ interface Builder {
      * NOTE: keys are “button ids”: either option.id or field.id for option-less buttons.
      */
     visibleFields(tagId: string, selectedOptionKeys?: string[]): string[];
+    /** Compute field ids plus option visibility under a tag. */
+    resolveVisibility(tagId: string, selectedOptionKeys?: string[]): ResolvedVisibility;
     /** Update builder options (validator context etc.) */
     setOptions(patch: Partial<BuilderOptions>): void;
     /** Access the current props (already normalised) */
@@ -580,6 +605,26 @@ interface Builder {
 }
 declare function createBuilder(opts?: BuilderOptions): Builder;
 
+type OptionVisit = {
+    field: Field;
+    fieldId: string;
+    option: FieldOption;
+    optionId: string;
+    depth: number;
+    parentId?: string;
+};
+declare function walkFieldOptions(field: Field): OptionVisit[];
+declare function walkOptions(props: ServiceProps): OptionVisit[];
+declare function fieldOptionIds(field: Field): string[];
+declare function fieldOptionIdSet(field: Field): Set<string>;
+declare function findFieldOption(field: Field | undefined, optionId: string): FieldOption | undefined;
+declare function findOptionOwnerField(fields: Iterable<Field>, optionId: string): Field | undefined;
+declare function optionOwnerMap(fields: Iterable<Field>): Map<string, {
+    fieldId: string;
+    option: FieldOption;
+}>;
+declare function filterFieldOptionsById(options: readonly FieldOption[] | undefined, allowed: ReadonlySet<string>): FieldOption[] | undefined;
+
 type FailedFallbackContext = {
     scope: "node" | "global";
     nodeId?: string;
@@ -820,10 +865,7 @@ type BuildOrderSelection = {
     formValuesByFieldId: Record<string, Scalar | Scalar[]>;
     optionSelectionsByFieldId: Record<string, string[]>;
     selectedKeys?: string[];
-    optionTraversalOrder?: Array<{
-        fieldId: string;
-        optionId: string;
-    }>;
+    optionTraversalOrder?: string[];
 };
 
 declare function buildOrderSnapshot(props: ServiceProps, builder: Builder, selection: BuildOrderSelection, services: DgpServiceMap, settings?: BuildOrderSnapshotSettings): OrderSnapshot;
@@ -863,4 +905,4 @@ interface FallbackEditor {
 }
 declare function createFallbackEditor(options?: FallbackEditorOptions): FallbackEditor;
 
-export { type AncestryHit, type AnyNode, type Builder, type BuilderOptions, type FailedFallbackContext, type FallbackEditor, type FieldNode, type FilterServicesForVisibleGroupInput, type FilterServicesForVisibleGroupResult, type NodeIndex, type NodeKind, type NormaliseOptions, type OptionNode, type RateCoherenceDiagnostic, type RelKind, type ServiceCheck, type TagNode, type TriggerEffectMap, type TriggerEffects, type UnknownNode, type WithAncestry, buildOrderSnapshot, buildTriggerEffectMap, collectFailedFallbacks, createBuilder, createFallbackEditor, createNodeIndex, filterServicesForVisibleGroup, getAssignedServiceIds, getEligibleFallbacks, getFallbackRegistrationInfo, isRefExcludedBySelectedKeys, normalise, normalizeFieldValidation, resolveServiceFallback, validate, validateAsync, validateRateCoherenceDeep };
+export { type AncestryHit, type AnyNode, type Builder, type BuilderOptions, type FailedFallbackContext, type FallbackEditor, type FieldNode, type FilterServicesForVisibleGroupInput, type FilterServicesForVisibleGroupResult, type NodeIndex, type NodeKind, type NormaliseOptions, type OptionNode, type OptionVisit, type RateCoherenceDiagnostic, type RelKind, type ServiceCheck, type TagNode, type TriggerEffectMap, type TriggerEffects, type UnknownNode, type WithAncestry, buildOrderSnapshot, buildTriggerEffectMap, collectFailedFallbacks, createBuilder, createFallbackEditor, createNodeIndex, fieldOptionIdSet, fieldOptionIds, filterFieldOptionsById, filterServicesForVisibleGroup, findFieldOption, findOptionOwnerField, getAssignedServiceIds, getEligibleFallbacks, getFallbackRegistrationInfo, isRefExcludedBySelectedKeys, normalise, normalizeFieldValidation, optionOwnerMap, resolveServiceFallback, validate, validateAsync, validateRateCoherenceDeep, walkFieldOptions, walkOptions };