Skip to content

AI-native design editor. Open-source Figma alternative.

2.8 KB
Raw Blame
export { materializeFigFragment, type FragmentMaterializationOptions } from './document/fragment'
export {
  materializeDocument,
  materializeFigArchive,
  figCheckpointRecords,
  type FigSessionCheckpoint,
  type FigSessionResume,
  createFigDocumentSession,
  type DocumentAssemblyOptions
} from './document/materialize'
export { figArchiveMetaSchema, type FigArchiveMetaJSON } from './schema'
export {
  compressFigDataSync,
  figArchiveKind,
  figArchiveMetaJSON,
  parseFigBuffer,
  readFigArchiveMeta,
  renameFigArchive,
  writeFigArchive,
  type FigArchiveMeta,
  type FigImageEntry,
  type FigParseResult,
  type WriteFigArchiveInput
} from './archive'
export {
  figArchiveComponentUsePages,
  figArchiveRecordInfo,
  figArchiveRecordPages,
  figComponentUsePages,
  figRecordPages,
  patchFigArchive,
  patchFigRecords,
  type FigArchiveRecordInfo,
  type FigPatchedArchiveInput,
  entryPathKey,
  type FigEntryListPatch,
  type FigEntryPatch,
  type FigRecordFieldPatch,
  type FigRecordPatch
} from './record-patch'
export {
  extractFigThumbnailFromReader,
  type FigRangeReader,
  type FigThumbnailLimits
} from './thumbnail'
export {
  effectiveFigmaRawNodeFields,
  effectiveFigmaSourcePayload,
  readEffectiveFigmaRawField,
  staleFigmaRawFields
} from './source-metadata'

import {
  FIG_KIWI_DEFAULT_VERSION,
  buildFigKiwi,
  decompressFigKiwiData,
  parseFigKiwiChunks
} from '@open-pencil/kiwi/fig/container'

export interface FigDocumentSource {
  readonly bytes?: Uint8Array
  readonly fileName?: string
}

export interface FigDocument<Graph = unknown> {
  readonly graph: Graph
  readonly source?: FigDocumentSource
}

export interface ReadFigOptions {
  readonly preserveRawMetadata?: boolean
}

export interface WriteFigOptions {
  readonly source?: FigDocumentSource
}

export interface FigContainerDocument {
  readonly schemaDeflated: Uint8Array
  readonly dataRaw: Uint8Array
  readonly source?: FigDocumentSource
}

export interface ReadFigContainerOptions {
  readonly fileName?: string
}

export interface WriteFigContainerOptions {
  readonly version?: number
}

export const FIG_PACKAGE_STATUS = 'document-reader' as const

export function readFigContainer(
  bytes: Uint8Array,
  options: ReadFigContainerOptions = {}
): FigContainerDocument {
  const chunks = parseFigKiwiChunks(bytes)
  if (!chunks) throw new Error('Invalid fig-kiwi container')
  const [schemaDeflated, dataDeflated] = chunks
  return {
    schemaDeflated,
    dataRaw: decompressFigKiwiData(dataDeflated),
    source: { bytes, fileName: options.fileName }
  }
}

export function writeFigContainer(
  document: FigContainerDocument,
  options: WriteFigContainerOptions = {}
): Uint8Array {
  return buildFigKiwi(
    document.schemaDeflated,
    document.dataRaw,
    options.version ?? FIG_KIWI_DEFAULT_VERSION
  )
}