@timeax/digital-service-engine 0.3.5 → 0.3.6

package/dist/react/index.d.cts

@@ -187,7 +187,7 @@ type NodeRef$1 = {
 };
 type NodeMap = Map<string, NodeRef$1>;
 
-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;
@@ -463,6 +463,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;
@@ -516,6 +532,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;
@@ -611,6 +628,12 @@ type CommentThread = {
     _sync?: "pending" | "synced" | "error";
 };
 
+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;
@@ -636,6 +659,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) */
@@ -716,6 +741,8 @@ type VisibleGroup = {
     tag?: Tag;
     fields: Field[];
     fieldIds: string[];
+    optionsByFieldId?: Record<string, string[]>;
+    forcedFieldIds?: string[];
     parentTags?: Tag[];
     childrenTags?: Tag[];
     /** In order of selection: tag base (unless overridden) then selected options */
@@ -765,11 +792,10 @@ declare class Selection {
      * What counts as a "button selection" (trigger key):
      * - field key where the field has button === true (e.g. "f:dripfeed")
      * - option key (e.g. "o:fast")
-     * - composite key "fieldId::optionId" (e.g. "f:speed::o:fast")
      *
      * Grouping:
      * - button-field trigger groups under its own fieldId
-     * - option/composite groups under the option's owning fieldId (from nodeMap)
+     * - option trigger groups under the option's owning fieldId (from nodeMap)
      *
      * Deterministic:
      * - preserves selection insertion order
@@ -780,7 +806,6 @@ declare class Selection {
      * Returns only selection keys that are valid "trigger buttons":
      * - field keys where field.button === true
      * - option keys
-     * - composite keys "fieldId::optionId" (validated by optionId)
      * Excludes tags and non-button fields.
      */
     selectedButtons(): string[];
@@ -790,6 +815,7 @@ declare class Selection {
     private computeGroupForTag;
     private addServiceByRole;
     private findOptionById;
+    private isSelectedOptionVisible;
 }
 
 type CatalogId = string;
@@ -1531,11 +1557,18 @@ type Adapter = {
     getInputPropsFromField?: (props: AdapterCtx) => any;
     toValue?: (value: any) => any;
 };
+type InputChildOptionCapability = {
+    supported?: boolean;
+    autoCreate?: boolean;
+    defaultLabel?: string;
+    defaultValue?: string | number;
+};
 type InputOptionCapability = {
     supported?: boolean;
     autoCreate?: boolean;
     defaultLabel?: string;
     defaultValue?: string | number;
+    children?: InputChildOptionCapability;
 };
 type InputMultiCapability = {
     supported?: boolean;
@@ -1679,6 +1712,14 @@ declare class Editor {
     clearFieldQuantityRule(id: string): void;
     include(receiverId: string, idOrIds: string | string[]): void;
     exclude(receiverId: string, idOrIds: string | string[]): void;
+    setOptionEffect(triggerId: string, targetFieldId: string, effect: OptionEffectForButton | undefined | null): void;
+    patchOptionEffect(triggerId: string, targetFieldId: string, patch: OptionEffectForButton): void;
+    clearOptionEffect(triggerId: string, targetFieldId: string): void;
+    clearOptionEffectsForTrigger(triggerId: string): void;
+    clearOptionEffectsForTarget(targetFieldId: string): void;
+    addOptionEffectOptions(triggerId: string, targetFieldId: string, kind: "include" | "exclude", optionIds: readonly string[]): void;
+    removeOptionEffectOptions(triggerId: string, targetFieldId: string, kind: "include" | "exclude", optionIds: readonly string[]): void;
+    setOptionEffectForceVisible(triggerId: string, targetFieldId: string, forceVisible: boolean | undefined): void;
     connect(kind: WireKind, fromId: string, toId: string): void;
     disconnect(kind: WireKind, fromId: string, toId: string): void;
     setConstraint(tagId: string, flag: string, value: boolean | undefined): void;
@@ -2039,6 +2080,8 @@ type UseOrderFlowReturn = {
     raw: ServiceProps;
     /** visibility is Selection-only */
     visibleGroup: VisibleGroup | null;
+    visibleOptionsByFieldId: Record<string, string[]>;
+    forcedFieldIds: string[];
     /**
      * Values are from form-palette (values()) and are already "visible-only"
      * because your UI mounts only visible fields.
@@ -2297,4 +2340,4 @@ type Props = {
 };
 declare function FallbackAddRegistrationDialog({ open, onClose, onSelect, }: Props): react_jsx_runtime.JSX.Element | null;
 
-export { type Adapter, type AdapterCtx, CanvasAPI, type EditorSettings, EventBus, type EventMap, FallbackAddCandidatesDialog, FallbackAddRegistrationDialog, FallbackDetailsPanel, FallbackEditor, type FallbackEditorData, FallbackEditorHeader, FallbackEditorProvider, type FallbackEditorProviderProps, FallbackRegistrationsPanel, FallbackServiceSidebar, FallbackSettingsPanel, type FormApi, FormProvider, type FormProviderProps, type FormSnapshot, type InputDescriptor, type InputKind, type InputMultiCapability, type InputOptionCapability, type InputVariant, type InputWrapperProps, OrderFlowProvider, Provider, type RegistrationItem, type RegistrationScope, type Registry, type ServiceSummary, type ValidationMessage, type ValidationTone, VirtualServiceList, Wrapper, createInputRegistry, registerEntries, resolveInputDescriptor, useActiveFallbackRegistrations, useEligibleServiceList, useFallbackEditor, useFallbackEditorContext, useFormApi, useInputs, useInputsMaybe, useOptionalFormApi, useOrderFlow, useOrderFlowContext, usePrimaryServiceList };
+export { type Adapter, type AdapterCtx, CanvasAPI, type EditorSettings, EventBus, type EventMap, FallbackAddCandidatesDialog, FallbackAddRegistrationDialog, FallbackDetailsPanel, FallbackEditor, type FallbackEditorData, FallbackEditorHeader, FallbackEditorProvider, type FallbackEditorProviderProps, FallbackRegistrationsPanel, FallbackServiceSidebar, FallbackSettingsPanel, type FormApi, FormProvider, type FormProviderProps, type FormSnapshot, type InputChildOptionCapability, type InputDescriptor, type InputKind, type InputMultiCapability, type InputOptionCapability, type InputVariant, type InputWrapperProps, OrderFlowProvider, Provider, type RegistrationItem, type RegistrationScope, type Registry, type ServiceSummary, type ValidationMessage, type ValidationTone, VirtualServiceList, Wrapper, createInputRegistry, registerEntries, resolveInputDescriptor, useActiveFallbackRegistrations, useEligibleServiceList, useFallbackEditor, useFallbackEditorContext, useFormApi, useInputs, useInputsMaybe, useOptionalFormApi, useOrderFlow, useOrderFlowContext, usePrimaryServiceList };

package/dist/react/index.d.ts

@@ -187,7 +187,7 @@ type NodeRef$1 = {
 };
 type NodeMap = Map<string, NodeRef$1>;
 
-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;
@@ -463,6 +463,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;
@@ -516,6 +532,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;
@@ -611,6 +628,12 @@ type CommentThread = {
     _sync?: "pending" | "synced" | "error";
 };
 
+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;
@@ -636,6 +659,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) */
@@ -716,6 +741,8 @@ type VisibleGroup = {
     tag?: Tag;
     fields: Field[];
     fieldIds: string[];
+    optionsByFieldId?: Record<string, string[]>;
+    forcedFieldIds?: string[];
     parentTags?: Tag[];
     childrenTags?: Tag[];
     /** In order of selection: tag base (unless overridden) then selected options */
@@ -765,11 +792,10 @@ declare class Selection {
      * What counts as a "button selection" (trigger key):
      * - field key where the field has button === true (e.g. "f:dripfeed")
      * - option key (e.g. "o:fast")
-     * - composite key "fieldId::optionId" (e.g. "f:speed::o:fast")
      *
      * Grouping:
      * - button-field trigger groups under its own fieldId
-     * - option/composite groups under the option's owning fieldId (from nodeMap)
+     * - option trigger groups under the option's owning fieldId (from nodeMap)
      *
      * Deterministic:
      * - preserves selection insertion order
@@ -780,7 +806,6 @@ declare class Selection {
      * Returns only selection keys that are valid "trigger buttons":
      * - field keys where field.button === true
      * - option keys
-     * - composite keys "fieldId::optionId" (validated by optionId)
      * Excludes tags and non-button fields.
      */
     selectedButtons(): string[];
@@ -790,6 +815,7 @@ declare class Selection {
     private computeGroupForTag;
     private addServiceByRole;
     private findOptionById;
+    private isSelectedOptionVisible;
 }
 
 type CatalogId = string;
@@ -1531,11 +1557,18 @@ type Adapter = {
     getInputPropsFromField?: (props: AdapterCtx) => any;
     toValue?: (value: any) => any;
 };
+type InputChildOptionCapability = {
+    supported?: boolean;
+    autoCreate?: boolean;
+    defaultLabel?: string;
+    defaultValue?: string | number;
+};
 type InputOptionCapability = {
     supported?: boolean;
     autoCreate?: boolean;
     defaultLabel?: string;
     defaultValue?: string | number;
+    children?: InputChildOptionCapability;
 };
 type InputMultiCapability = {
     supported?: boolean;
@@ -1679,6 +1712,14 @@ declare class Editor {
     clearFieldQuantityRule(id: string): void;
     include(receiverId: string, idOrIds: string | string[]): void;
     exclude(receiverId: string, idOrIds: string | string[]): void;
+    setOptionEffect(triggerId: string, targetFieldId: string, effect: OptionEffectForButton | undefined | null): void;
+    patchOptionEffect(triggerId: string, targetFieldId: string, patch: OptionEffectForButton): void;
+    clearOptionEffect(triggerId: string, targetFieldId: string): void;
+    clearOptionEffectsForTrigger(triggerId: string): void;
+    clearOptionEffectsForTarget(targetFieldId: string): void;
+    addOptionEffectOptions(triggerId: string, targetFieldId: string, kind: "include" | "exclude", optionIds: readonly string[]): void;
+    removeOptionEffectOptions(triggerId: string, targetFieldId: string, kind: "include" | "exclude", optionIds: readonly string[]): void;
+    setOptionEffectForceVisible(triggerId: string, targetFieldId: string, forceVisible: boolean | undefined): void;
     connect(kind: WireKind, fromId: string, toId: string): void;
     disconnect(kind: WireKind, fromId: string, toId: string): void;
     setConstraint(tagId: string, flag: string, value: boolean | undefined): void;
@@ -2039,6 +2080,8 @@ type UseOrderFlowReturn = {
     raw: ServiceProps;
     /** visibility is Selection-only */
     visibleGroup: VisibleGroup | null;
+    visibleOptionsByFieldId: Record<string, string[]>;
+    forcedFieldIds: string[];
     /**
      * Values are from form-palette (values()) and are already "visible-only"
      * because your UI mounts only visible fields.
@@ -2297,4 +2340,4 @@ type Props = {
 };
 declare function FallbackAddRegistrationDialog({ open, onClose, onSelect, }: Props): react_jsx_runtime.JSX.Element | null;
 
-export { type Adapter, type AdapterCtx, CanvasAPI, type EditorSettings, EventBus, type EventMap, FallbackAddCandidatesDialog, FallbackAddRegistrationDialog, FallbackDetailsPanel, FallbackEditor, type FallbackEditorData, FallbackEditorHeader, FallbackEditorProvider, type FallbackEditorProviderProps, FallbackRegistrationsPanel, FallbackServiceSidebar, FallbackSettingsPanel, type FormApi, FormProvider, type FormProviderProps, type FormSnapshot, type InputDescriptor, type InputKind, type InputMultiCapability, type InputOptionCapability, type InputVariant, type InputWrapperProps, OrderFlowProvider, Provider, type RegistrationItem, type RegistrationScope, type Registry, type ServiceSummary, type ValidationMessage, type ValidationTone, VirtualServiceList, Wrapper, createInputRegistry, registerEntries, resolveInputDescriptor, useActiveFallbackRegistrations, useEligibleServiceList, useFallbackEditor, useFallbackEditorContext, useFormApi, useInputs, useInputsMaybe, useOptionalFormApi, useOrderFlow, useOrderFlowContext, usePrimaryServiceList };
+export { type Adapter, type AdapterCtx, CanvasAPI, type EditorSettings, EventBus, type EventMap, FallbackAddCandidatesDialog, FallbackAddRegistrationDialog, FallbackDetailsPanel, FallbackEditor, type FallbackEditorData, FallbackEditorHeader, FallbackEditorProvider, type FallbackEditorProviderProps, FallbackRegistrationsPanel, FallbackServiceSidebar, FallbackSettingsPanel, type FormApi, FormProvider, type FormProviderProps, type FormSnapshot, type InputChildOptionCapability, type InputDescriptor, type InputKind, type InputMultiCapability, type InputOptionCapability, type InputVariant, type InputWrapperProps, OrderFlowProvider, Provider, type RegistrationItem, type RegistrationScope, type Registry, type ServiceSummary, type ValidationMessage, type ValidationTone, VirtualServiceList, Wrapper, createInputRegistry, registerEntries, resolveInputDescriptor, useActiveFallbackRegistrations, useEligibleServiceList, useFallbackEditor, useFallbackEditorContext, useFormApi, useInputs, useInputsMaybe, useOptionalFormApi, useOrderFlow, useOrderFlowContext, usePrimaryServiceList };