@jungvonmatt/sb-migrate/dist/src/handlers/component/update.d.ts

CLI tool for managing Storyblok schema and content migrations

import { ComponentMigration } from "../../types/migration";
import { RunMigrationOptions } from "../../utils/migration";
/**
 * Handles the update of an existing component based on the provided migration schema.
 * This function performs the following operations:
 * 1. Checks if the component exists before updating
 * 2. Updates the component schema fields and tabs if provided
 * 3. Updates other properties like display name, root status, and nestable status
 * 4. Associates the component with a component group if specified
 * 5. Saves the updated component to the API
 * 6. Creates a rollback file for the component
 *
 * @param {Object} migration - The migration object containing the component schema
 * @param {Partial<ComponentMigration>} migration.schema - The schema defining the component properties
 * @param {RunMigrationOptions} options - Configuration options for the migration
 * @param {boolean} [options.isDryrun] - Whether to perform a dry run without making actual changes
 * @throws {Error} If the component update fails
 */
export declare const handleUpdateComponent: (migration: {
    schema: Partial<ComponentMigration>;
}, options: RunMigrationOptions) => Promise<void>;