handoff-app/src/transformers/types.ts

Automated documentation toolchain for building client side documentation from figma

import { Types as CoreTypes } from 'handoff-core';
import { Plugin } from 'vite';
import { SlotMetadata } from './preview/component';
import { TransformComponentTokensResult } from './preview/types';

/**
 * Configuration for react-docgen-typescript parser
 */
export interface DocgenParserConfig {
  savePropValueAsString: boolean;
  shouldExtractLiteralValuesFromEnum: boolean;
  shouldRemoveUndefinedFromOptional: boolean;
  propFilter: (prop: any) => boolean;
}

/**
 * Result from react-docgen-typescript parsing
 */
export interface DocgenResult {
  props: { [key: string]: any };
  [key: string]: any;
}

/**
 * Module evaluation result
 */
export interface ModuleEvaluationResult {
  exports: any;
}

/**
 * Build configuration for esbuild
 */
export interface BuildConfig {
  entryPoints?: string[];
  stdin?: {
    contents: string;
    resolveDir: string;
    loader: string;
  };
  bundle: boolean;
  write: boolean;
  format: 'cjs' | 'esm';
  platform: 'node' | 'browser';
  jsx: 'automatic' | 'transform' | 'preserve';
  external?: string[];
  sourcemap?: boolean;
  minify?: boolean;
  plugins?: any[];
}

/**
 * Plugin factory function signature
 */
export type PluginFactory = (
  data: TransformComponentTokensResult,
  components: CoreTypes.IDocumentationObject['components'],
  handoff: any
) => Plugin;

/**
 * Schema loading options
 */
export interface SchemaLoadOptions {
  exportKey: 'default' | 'schema';
  handoff: any;
}

/**
 * Preview rendering options
 */
export interface PreviewRenderOptions {
  inspect: boolean;
  injectFieldWrappers: boolean;
}

/**
 * Handlebars template context
 */
export interface HandlebarsContext {
  style: string;
  script: string;
  properties: any;
  fields: { [key: string]: SlotMetadata };
  title: string;
}