@3dsource/metabox-modular-configurator-api
    Preparing search index...

    Interface InitialModularConfigurator

    Represents the modular configurator API with its components, component types, and environments.

    Defines payload structures for different message types. Contains data models for various command responses.

    Full configurator definition loaded at init — contains all available components, component types, environments, materials, and metadata. Nested inside ModularConfiguratorEnvelope.configurator. This is your catalog of everything the configurator supports.

    Access via envelope.configurator from configuratorDataUpdated. This is your source of truth for ALL available options. Iterate its component types, components, environments, and material collections to build dynamic selection UIs. Only changes if the configurator definition is updated in MetaBox admin.

    interface InitialModularConfigurator {
        __typename: "ModularConfigurator";
        components: ModularConfiguratorComponent[];
        componentTypes: ModularConfiguratorComponentType[];
        connectors: ModularConfiguratorConnector[];
        ctaEnabled: boolean;
        environments: ModularConfiguratorEnvironment[];
        id: string;
        isActive: boolean;
        name: string;
    }
    Index

    Properties

    __typename: "ModularConfigurator"

    Represents object typename for the Modular Configurator.

    A list of components for the configurator.

    A list of a component type for the configurator.

    A list of available connectors shows connections between all component types.

    ctaEnabled: boolean

    Indicates if the cta in ecom configurator is enabled or not.

    A list of available environments.

    id: string

    Unique identifier for the configurator.

    isActive: boolean

    Indicates if the configurator is active.

    name: string

    The name of the configurator.