AI-native design editor. Open-source Figma alternative.
import type { NodeChange } from '@open-pencil/kiwi/fig/codec'
import {
CODE_SYNTAX_PLATFORMS,
VARIABLE_SCOPES,
type CodeSyntaxPlatform,
type PluginDataEntry,
type Variable,
type VariableCollection,
type VariableScope
} from '@open-pencil/scene-graph'
import { extractPluginData, mergePluginData } from '../plugin-data'
import {
modeAttributePluginData,
modeConditionsPluginData,
tokenPluginData,
withoutTokenPluginData
} from './token'
type VariableMetadata = Pick<
Variable,
| 'description'
| 'hiddenFromPublishing'
| 'scopes'
| 'codeSyntax'
| 'pluginData'
| 'key'
| 'version'
>
type ModeKey = (modeId: string) => string
const isScope = (value: string): value is VariableScope =>
(VARIABLE_SCOPES as readonly string[]).includes(value)
const isPlatform = (value: string): value is CodeSyntaxPlatform =>
(CODE_SYNTAX_PLATFORMS as readonly string[]).includes(value)
function readCodeSyntax(nc: NodeChange): Variable['codeSyntax'] {
const entries = (nc.codeSyntax?.entries ?? []).flatMap(({ platform, value }) =>
isPlatform(platform) && value ? [[platform, value] as const] : []
)
return entries.length > 0 ? Object.fromEntries(entries) : undefined
}
/** Figma keeps the description twice, as `description` and `symbolDescription`. */
export function readVariableMetadata(nc: NodeChange): VariableMetadata {
const scopes = nc.variableScopes?.filter(isScope)
const pluginData = withoutTokenPluginData(extractPluginData(nc))
const metadata: VariableMetadata = {
description: nc.description ?? nc.symbolDescription ?? '',
hiddenFromPublishing: nc.isPublishable === false,
scopes: scopes?.length ? scopes : undefined,
codeSyntax: readCodeSyntax(nc),
pluginData: pluginData.length > 0 ? pluginData : undefined
}
// A library variable's identity, which records naming it use in place of its GUID.
if (typeof nc.key === 'string') metadata.key = nc.key
if (typeof nc.version === 'string') metadata.version = nc.version
return metadata
}
export function variableMetadataNodeChange(
variable: Variable,
modeKey: ModeKey
): Partial<NodeChange> {
const codeSyntax = Object.entries(variable.codeSyntax ?? {}).flatMap(([platform, value]) =>
value ? [{ platform, value }] : []
)
const token = tokenPluginData(variable, modeKey)
const nc: Partial<NodeChange> = {
isPublishable: !variable.hiddenFromPublishing,
variableScopes: variable.scopes?.length ? variable.scopes : ['ALL_SCOPES'],
pluginData: pluginDataNodeChange([
...withoutTokenPluginData(variable.pluginData ?? []),
...(token ? [token] : [])
])
}
if (variable.description) {
nc.description = variable.description
nc.symbolDescription = variable.description
}
if (codeSyntax.length > 0) nc.codeSyntax = { entries: codeSyntax }
return nc
}
export function collectionPluginDataNodeChange(
collection: VariableCollection,
modeKey: ModeKey
): NodeChange['pluginData'] {
const conditions = modeConditionsPluginData(collection, modeKey)
const attribute = modeAttributePluginData(collection)
return pluginDataNodeChange([
...withoutTokenPluginData(collection.pluginData ?? []),
...(conditions ? [conditions] : []),
...(attribute ? [attribute] : [])
])
}
export function pluginDataNodeChange(
pluginData: PluginDataEntry[] | undefined
): NodeChange['pluginData'] {
return pluginData?.length ? mergePluginData(pluginData) : undefined
}