@uniformdev/transformer 1.0.0

package/dist/index.d.ts

@@ -0,0 +1,320 @@
+interface Parameter {
+    id: string;
+    name: string;
+    type: string;
+    typeConfig?: {
+        childrenParams?: string[];
+        [key: string]: unknown;
+    };
+    [key: string]: unknown;
+}
+interface SlotDefinition {
+    id: string;
+    name: string;
+    allowedComponents?: string[];
+    [key: string]: unknown;
+}
+interface ComponentDefinition {
+    id: string;
+    name: string;
+    parameters?: Parameter[];
+    slots?: SlotDefinition[];
+    [key: string]: unknown;
+}
+
+interface ParameterValue {
+    type: string;
+    value?: unknown;
+    [key: string]: unknown;
+}
+interface ComponentInstance {
+    type: string;
+    _id?: string;
+    parameters?: Record<string, ParameterValue>;
+    slots?: Record<string, ComponentInstance[]>;
+    [key: string]: unknown;
+}
+interface CompositionOverrides {
+    parameters?: Record<string, ParameterValue>;
+    [key: string]: unknown;
+}
+interface CompositionRoot {
+    _id: string;
+    type: string;
+    parameters?: Record<string, ParameterValue>;
+    _overrides?: Record<string, CompositionOverrides>;
+    slots?: Record<string, ComponentInstance[]>;
+    [key: string]: unknown;
+}
+interface Composition {
+    composition: CompositionRoot;
+    [key: string]: unknown;
+}
+
+interface GlobalOptions {
+    rootDir: string;
+    whatIf?: boolean;
+    strict?: boolean;
+    compositionsDir: string;
+    componentsDir: string;
+    contentTypesDir: string;
+    assetsDir: string;
+    categoriesDir: string;
+    componentPatternsDir: string;
+    compositionPatternsDir: string;
+    dataTypesDir: string;
+    entriesDir: string;
+    filesDir: string;
+    previewUrlsDir: string;
+    previewViewportsDir: string;
+    projectMapDefinitionsDir: string;
+    projectMapNodesDir: string;
+    quirksDir: string;
+}
+interface PropagateRootComponentPropertyOptions extends GlobalOptions {
+    compositionType: string;
+    property: string;
+    targetComponentType: string;
+    targetGroup: string;
+    deleteSourceParameter?: boolean;
+}
+interface CompositionPatternCandidatesOptions extends GlobalOptions {
+    minGroupSize: number;
+    depth: number;
+    threshold: number;
+    format: 'text' | 'json';
+    brief?: boolean;
+}
+interface UnpackSerializationOptions extends GlobalOptions {
+    sourceDir?: string;
+    file?: string;
+    outputDir?: string;
+    format: 'yaml' | 'json';
+}
+interface PackSerializationOptions extends GlobalOptions {
+    sourceDir?: string;
+    file?: string;
+    outputDir?: string;
+    keepFragments?: boolean;
+    format: 'yaml' | 'json';
+}
+interface RenameComponentOptions extends GlobalOptions {
+    componentType: string;
+    newComponentType: string;
+    newComponentName?: string;
+}
+interface RenameSlotOptions extends GlobalOptions {
+    componentType: string;
+    slotId: string;
+    newSlotId: string;
+    newSlotName?: string;
+}
+
+declare class TransformError extends Error {
+    constructor(message: string);
+}
+declare class ComponentNotFoundError extends TransformError {
+    constructor(componentType: string, path?: string);
+}
+declare class PropertyNotFoundError extends TransformError {
+    constructor(propertyName: string, componentType: string);
+}
+declare class InvalidYamlError extends TransformError {
+    constructor(filePath: string, details?: string);
+}
+declare class FileNotFoundError extends TransformError {
+    constructor(filePath: string);
+}
+declare class DuplicateIdError extends TransformError {
+    constructor(id: string, arrayProperty: string, filePath: string);
+}
+declare class ComponentAlreadyExistsError extends TransformError {
+    constructor(componentType: string, path?: string);
+}
+declare class SlotNotFoundError extends TransformError {
+    constructor(slotId: string, componentType: string);
+}
+declare class SlotAlreadyExistsError extends TransformError {
+    constructor(slotId: string, componentType: string);
+}
+
+declare class FileSystemService {
+    private isJsonFile;
+    readFile<T>(filePath: string): Promise<T>;
+    writeFile<T>(filePath: string, data: T): Promise<void>;
+    readYamlFile<T>(filePath: string): Promise<T>;
+    writeYamlFile<T>(filePath: string, data: T): Promise<void>;
+    findFiles(directory: string, pattern: string): Promise<string[]>;
+    fileExists(filePath: string): Promise<boolean>;
+    resolvePath(...segments: string[]): string;
+    joinPath(...segments: string[]): string;
+    getBasename(filePath: string, ext?: string): string;
+    renameFile(oldPath: string, newPath: string): Promise<void>;
+    deleteFile(filePath: string): void;
+    getExtension(filePath: string): string;
+    getDirname(filePath: string): string;
+}
+
+interface FindOptions$1 {
+    strict?: boolean;
+}
+declare class ComponentService {
+    private fileSystem;
+    constructor(fileSystem: FileSystemService);
+    private compareIds;
+    loadComponent(componentsDir: string, componentType: string, options?: FindOptions$1): Promise<{
+        component: ComponentDefinition;
+        filePath: string;
+    }>;
+    saveComponent(filePath: string, component: ComponentDefinition): Promise<void>;
+    findParameter(component: ComponentDefinition, parameterName: string, options?: FindOptions$1): Parameter | undefined;
+    isGroupParameter(parameter: Parameter): boolean;
+    resolveGroupParameters(component: ComponentDefinition, groupParameter: Parameter, options?: FindOptions$1): Parameter[];
+    resolveProperties(component: ComponentDefinition, propertyNames: string[], options?: FindOptions$1): {
+        parameters: Parameter[];
+        notFound: string[];
+    };
+    addParameterToComponent(component: ComponentDefinition, parameter: Parameter, options?: FindOptions$1): ComponentDefinition;
+    ensureGroupExists(component: ComponentDefinition, groupId: string, groupName?: string, options?: FindOptions$1): ComponentDefinition;
+    addParameterToGroup(component: ComponentDefinition, groupId: string, parameterId: string, options?: FindOptions$1): ComponentDefinition;
+    removeParameter(component: ComponentDefinition, parameterId: string, options?: FindOptions$1): ComponentDefinition;
+    removeEmptyGroups(component: ComponentDefinition): ComponentDefinition;
+}
+
+interface FindOptions {
+    strict?: boolean;
+}
+interface FoundComponentInstance {
+    instance: ComponentInstance;
+    instanceId: string;
+    path: string[];
+}
+declare class CompositionService {
+    private fileSystem;
+    constructor(fileSystem: FileSystemService);
+    private compareTypes;
+    loadComposition(filePath: string): Promise<Composition>;
+    saveComposition(filePath: string, composition: Composition): Promise<void>;
+    findCompositionsByType(compositionsDir: string, compositionType: string, options?: FindOptions): Promise<{
+        composition: Composition;
+        filePath: string;
+    }[]>;
+    findComponentInstances(composition: Composition, componentType: string, options?: FindOptions): FoundComponentInstance[];
+    private searchSlots;
+    getRootOverrides(composition: Composition): Record<string, ParameterValue>;
+    getInstanceOverrides(composition: Composition, instanceId: string): Record<string, ParameterValue>;
+    setInstanceOverride(composition: Composition, instanceId: string, parameterId: string, value: ParameterValue): Composition;
+    setInstanceOverrides(composition: Composition, instanceId: string, parameters: Record<string, ParameterValue>): Composition;
+    /**
+     * Sets parameters directly on a component instance (preferred approach).
+     * This modifies the instance object in-place.
+     */
+    setInstanceParameters(instance: ComponentInstance, parameters: Record<string, ParameterValue>): void;
+    /**
+     * Deletes parameters from root overrides.
+     * Returns true if any parameters were deleted.
+     */
+    deleteRootOverrides(composition: Composition, parameterIds: string[], options?: FindOptions): boolean;
+}
+
+declare class Logger {
+    info(message: string): void;
+    success(message: string): void;
+    error(message: string): void;
+    warn(message: string): void;
+    action(whatIf: boolean, actionType: string, message: string): void;
+    detail(message: string): void;
+}
+
+interface PropagateOptions {
+    rootDir: string;
+    componentsDir: string;
+    compositionsDir: string;
+    compositionType: string;
+    property: string;
+    targetComponentType: string;
+    targetGroup: string;
+    whatIf: boolean;
+    strict: boolean;
+    deleteSourceParameter: boolean;
+}
+interface PropagateResult {
+    modifiedComponents: number;
+    modifiedCompositions: number;
+    propagatedInstances: number;
+}
+declare class PropertyPropagatorService {
+    private fileSystem;
+    private componentService;
+    private compositionService;
+    private logger;
+    constructor(fileSystem: FileSystemService, componentService: ComponentService, compositionService: CompositionService, logger: Logger);
+    propagate(options: PropagateOptions): Promise<PropagateResult>;
+}
+
+interface RenameSlotInternalOptions {
+    rootDir: string;
+    componentsDir: string;
+    compositionsDir: string;
+    compositionPatternsDir: string;
+    componentPatternsDir: string;
+    componentType: string;
+    slotId: string;
+    newSlotId: string;
+    newSlotName?: string;
+    whatIf: boolean;
+    strict: boolean;
+}
+interface RenameSlotResult {
+    componentDefinitionUpdated: boolean;
+    compositionsModified: number;
+    compositionPatternsModified: number;
+    componentPatternsModified: number;
+    instancesRenamed: number;
+}
+declare class SlotRenamerService {
+    private fileSystem;
+    private componentService;
+    private logger;
+    constructor(fileSystem: FileSystemService, componentService: ComponentService, logger: Logger);
+    private compareIds;
+    rename(options: RenameSlotInternalOptions): Promise<RenameSlotResult>;
+    private renameSlotInDirectory;
+    private renameSlotInTree;
+    private renameSlotKey;
+}
+
+interface RenameComponentInternalOptions {
+    rootDir: string;
+    componentsDir: string;
+    compositionsDir: string;
+    compositionPatternsDir: string;
+    componentPatternsDir: string;
+    componentType: string;
+    newComponentType: string;
+    newComponentName?: string;
+    whatIf: boolean;
+    strict: boolean;
+}
+interface RenameComponentResult {
+    componentRenamed: boolean;
+    fileRenamed: boolean;
+    allowedComponentsUpdated: number;
+    compositionsModified: number;
+    compositionPatternsModified: number;
+    componentPatternsModified: number;
+    instancesRenamed: number;
+}
+declare class ComponentRenamerService {
+    private fileSystem;
+    private componentService;
+    private logger;
+    constructor(fileSystem: FileSystemService, componentService: ComponentService, logger: Logger);
+    private compareIds;
+    rename(options: RenameComponentInternalOptions): Promise<RenameComponentResult>;
+    private updateAllowedComponents;
+    private renameTypeInDirectory;
+    private renameTypeInTree;
+}
+
+export { ComponentAlreadyExistsError, type ComponentDefinition, type ComponentInstance, ComponentNotFoundError, ComponentRenamerService, ComponentService, type Composition, type CompositionOverrides, type CompositionPatternCandidatesOptions, type CompositionRoot, CompositionService, DuplicateIdError, FileNotFoundError, FileSystemService, type GlobalOptions, InvalidYamlError, Logger, type PackSerializationOptions, type Parameter, type ParameterValue, type PropagateRootComponentPropertyOptions, PropertyNotFoundError, PropertyPropagatorService, type RenameComponentOptions, type RenameSlotOptions, SlotAlreadyExistsError, type SlotDefinition, SlotNotFoundError, SlotRenamerService, TransformError, type UnpackSerializationOptions };