@archastro/sdk
    Preparing search index...

    Interface SolutionImportResult

    The machine-readable outcome of a Solution import attempt, indicating whether the import succeeded or requires an upgrade flow to resolve a version conflict.

    interface SolutionImportResult {
        code?: string;
        dry_run: boolean;
        existing_solution_version?: string;
        incoming_solution_version?: string;
        message?: string;
        status: string;
        upgrade_required: boolean;
    }
    Index

    Properties

    code? dry_run existing_solution_version? incoming_solution_version? message? status upgrade_required

    Properties

    code?: string

    Machine-readable conflict code present when status is "conflict", identifying the specific conflict reason. null when status is "ready".

    dry_run: boolean

    Whether this result was produced by a dry-run check. true when the import was validated without persisting any changes.

    existing_solution_version?: string

    Semver string of the Solution version already present in the library. null when no prior version exists.

    incoming_solution_version?: string

    Semver string of the Solution version in the bundle being imported. null when the bundle does not declare a version.

    message?: string

    Human-readable description of the import status or conflict reason, suitable for display in a confirmation dialog. null when no detail is available.

    status: string

    Outcome of the import check. "ready" means the import can proceed as a normal create or update. "conflict" means a version conflict was detected and the upgrade flow must be used instead.

    upgrade_required: boolean

    Whether the caller must invoke the dedicated upgrade flow to complete the import. Mirrors status == "conflict" as a convenience boolean.

    Settings

    Member Visibility

    On This Page

    Properties