handoff-app
Version:
Automated documentation toolchain for building client side documentation from figma
26 lines (25 loc) • 849 B
TypeScript
import { Types as HandoffTypes } from 'handoff-core';
export interface ChangelogRecord {
timestamp: string;
design?: {
colors?: ChangelogObject<HandoffTypes.IColorObject>[];
typography?: ChangelogObject<HandoffTypes.ITypographyObject>[];
};
assets?: {
icons?: ChangelogObject<HandoffTypes.IAssetObject>[];
logos?: ChangelogObject<HandoffTypes.IAssetObject>[];
};
}
export interface ChangeLogEntry {
type: string;
}
export type ChangelogObject<ObjectType> = {
type: 'add' | 'delete';
object: ObjectType;
} | {
type: 'change';
old: ObjectType;
new: ObjectType;
};
declare const generateChangelogRecord: (prevDoc: HandoffTypes.IDocumentationObject | undefined, newDoc: HandoffTypes.IDocumentationObject) => ChangelogRecord | undefined;
export default generateChangelogRecord;