dc_figma_import 0.38.3

Figma document serialization toolkit
Documentation
/*
 * Copyright 2024 Google LLC
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

use crate::figma_schema;
use dc_bundle::color::FloatColor;
use dc_bundle::variable::num_or_var::{NumOrVarType, NumVar};
use dc_bundle::variable::variable::{VariableType, VariableValueMap};
use dc_bundle::variable::{
    color_or_var, variable_value, ColorOrVar, NumOrVar, Variable, VariableValue,
};
use log::warn;
use std::collections::HashMap;

// Trait to create a XOrVar from Figma data
pub(crate) trait FromFigmaVar<VarType> {
    fn from_var(
        bound_variables: &figma_schema::BoundVariables,
        var_name: &str,
        var_value: VarType,
        key_to_global_id_map: &mut HashMap<String, String>,
    ) -> Self;

    fn from_var_hash(
        bound_variables: &figma_schema::BoundVariables,
        hash_name: &str,
        var_name: &str,
        var_value: VarType,
        key_to_global_id_map: &mut HashMap<String, String>,
    ) -> Self;
}
// Create a NumOrVar from Figma variable name and number value
impl FromFigmaVar<f32> for NumOrVarType {
    fn from_var(
        bound_variables: &figma_schema::BoundVariables,
        var_name: &str,
        var_value: f32,
        key_to_global_id_map: &mut HashMap<String, String>,
    ) -> Self {
        let var = bound_variables.get_variable(var_name);
        if let Some(var) = var {
            let key_part = var.strip_prefix("VariableID:").unwrap_or(&var);
            let key = key_part.split('/').next().unwrap_or(key_part);
            key_to_global_id_map.insert(key.to_string(), var.clone());
            NumOrVarType::Var(NumVar { id: var, fallback: var_value, ..Default::default() })
        } else {
            NumOrVarType::Num(var_value)
        }
    }
    fn from_var_hash(
        bound_variables: &figma_schema::BoundVariables,
        hash_name: &str,
        var_name: &str,
        var_value: f32,
        key_to_global_id_map: &mut HashMap<String, String>,
    ) -> Self {
        let var = bound_variables.get_var_from_hash(hash_name, var_name);
        if let Some(var) = var {
            let key_part = var.strip_prefix("VariableID:").unwrap_or(&var);
            let key = key_part.split('/').next().unwrap_or(key_part);
            key_to_global_id_map.insert(key.to_string(), var.clone());
            NumOrVarType::Var(NumVar { id: var, fallback: var_value, ..Default::default() })
        } else {
            NumOrVarType::Num(var_value)
        }
    }
}

impl FromFigmaVar<f32> for NumOrVar {
    fn from_var(
        bound_variables: &figma_schema::BoundVariables,
        var_name: &str,
        var_value: f32,
        key_to_global_id_map: &mut HashMap<String, String>,
    ) -> NumOrVar {
        NumOrVar {
            NumOrVarType: Some(NumOrVarType::from_var(
                bound_variables,
                var_name,
                var_value,
                key_to_global_id_map,
            )),
            ..Default::default()
        }
    }
    fn from_var_hash(
        bound_variables: &figma_schema::BoundVariables,
        hash_name: &str,
        var_name: &str,
        var_value: f32,
        key_to_global_id_map: &mut HashMap<String, String>,
    ) -> NumOrVar {
        NumOrVar {
            NumOrVarType: Some(NumOrVarType::from_var_hash(
                bound_variables,
                hash_name,
                var_name,
                var_value,
                key_to_global_id_map,
            )),
            ..Default::default()
        }
    }
}

// Create a ColorOrVar from Figma variable name and color value
impl FromFigmaVar<&FloatColor> for ColorOrVar {
    fn from_var(
        bound_variables: &figma_schema::BoundVariables,
        var_name: &str,
        color: &FloatColor,
        key_to_global_id_map: &mut HashMap<String, String>,
    ) -> Self {
        let var = bound_variables.get_variable(var_name);
        if let Some(var) = var {
            let key_part = var.strip_prefix("VariableID:").unwrap_or(&var);
            let key = key_part.split('/').next().unwrap_or(key_part);
            key_to_global_id_map.insert(key.to_string(), var.clone());
            ColorOrVar::new_var(var, Some(color.into()))
        } else {
            ColorOrVar::new_color(color.into())
        }
    }
    fn from_var_hash(
        _bound_variables: &figma_schema::BoundVariables,
        _hash_name: &str,
        _var_name: &str,
        color: &FloatColor,
        _key_to_global_id_map: &mut HashMap<String, String>,
    ) -> Self {
        // Currently, no color variables from a hash are yet supported
        ColorOrVar::new_color(color.into())
    }
}

// Create a VariableValue from figma_schema::VariableValue
fn create_variable_value(v: &figma_schema::VariableValue) -> VariableValue {
    match v {
        figma_schema::VariableValue::Boolean(b) => VariableValue {
            Value: Some(variable_value::Value::Bool(b.clone())),
            ..Default::default()
        },
        figma_schema::VariableValue::Float(f) => VariableValue {
            Value: Some(variable_value::Value::Number(f.clone())),
            ..Default::default()
        },
        figma_schema::VariableValue::String(s) => VariableValue {
            Value: Some(variable_value::Value::Text(s.clone())),
            ..Default::default()
        },
        figma_schema::VariableValue::Color(c) => VariableValue {
            Value: Some(variable_value::Value::Color(c.into())),
            ..Default::default()
        },
        figma_schema::VariableValue::Alias(a) => {
            warn!(
                "Variable alias found: {}. Full definition not available; using fallback value. Cross-library variable aliases are not fully supported.",
                a.id
            );
            VariableValue {
                Value: Some(variable_value::Value::Alias(a.id.clone())),
                ..Default::default()
            }
        }
    }
}

// Create a VariableValueMap from a hash of mode IDs to Figma VariableValues
fn create_variable_value_map(
    map: &HashMap<String, figma_schema::VariableValue>,
) -> Option<VariableValueMap> {
    let mut values_by_mode: HashMap<String, VariableValue> = HashMap::new();
    for (mode_id, value) in map.iter() {
        values_by_mode.insert(mode_id.clone(), create_variable_value(value));
    }
    Some(VariableValueMap { values_by_mode, ..Default::default() })
}

// Helper function to create a Variable
fn create_variable_helper(
    var_type: VariableType,
    common: &figma_schema::VariableCommon,
    values_by_mode: &HashMap<String, figma_schema::VariableValue>,
) -> Variable {
    Variable {
        id: common.id.clone(),
        name: common.name.clone(),
        remote: common.remote,
        key: common.key.clone(),
        variable_collection_id: common.variable_collection_id.clone(),
        var_type: var_type.into(),
        values_by_mode: create_variable_value_map(values_by_mode).into(),
        ..Default::default()
    }
}

// Create a variable from figma_schema::Variable
pub(crate) fn create_variable(v: &figma_schema::Variable) -> Variable {
    match v {
        figma_schema::Variable::Boolean { common, values_by_mode } => {
            create_variable_helper(VariableType::VARIABLE_TYPE_BOOL, common, values_by_mode)
        }
        figma_schema::Variable::Float { common, values_by_mode } => {
            create_variable_helper(VariableType::VARIABLE_TYPE_NUMBER, common, values_by_mode)
        }
        figma_schema::Variable::String { common, values_by_mode } => {
            create_variable_helper(VariableType::VARIABLE_TYPE_TEXT, common, values_by_mode)
        }
        figma_schema::Variable::Color { common, values_by_mode } => {
            create_variable_helper(VariableType::VARIABLE_TYPE_COLOR, common, values_by_mode)
        }
    }
}

// Extract the color out of bound_variables if it exists, or use the default color if not.
// Convert the color into a ColorOrVar.
pub(crate) fn bound_variables_color(
    bound_variables: &Option<figma_schema::BoundVariables>,
    default_color: &figma_schema::FigmaColor,
    last_opacity: f32,
    key_to_global_id_map: &mut HashMap<String, String>,
) -> ColorOrVar {
    if let Some(vars) = bound_variables {
        ColorOrVar::from_var(vars, "color", &default_color.into(), key_to_global_id_map)
    } else {
        ColorOrVar {
            ColorOrVarType: Some(color_or_var::ColorOrVarType::Color(crate::Color::from_f32s(
                default_color.r,
                default_color.g,
                default_color.b,
                default_color.a * last_opacity,
            ))),
            ..Default::default()
        }
    }
}