@codesoul-co/hypha-adapters-local / legacy-tool-artifact-migration-report

• Package index: @codesoul-co/hypha-adapters-local
• Source: packages/adapters-local/src/legacy-tool-artifact-migration-report.ts
• Exports: 9

Using this module

Use the Legacy tool artifact migration report module for defining or implementing provider-neutral ports. It exports 6 functions, 3 interfaces.

Import from the package entrypoint

import {
  isLegacyToolArtifactMigrationExecutionReportId,
  isLegacyToolArtifactMigrationPlanHash,
  isLegacyToolArtifactMigrationRollbackReportId,
  legacyToolArtifactMigrationExecutionReportId,
  legacyToolArtifactMigrationPlanHash,
  legacyToolArtifactMigrationRollbackReportId,
} from '@codesoul-co/hypha-adapters-local';

import type {
  LegacyToolArtifactMigrationExecutionEvidence,
  LegacyToolArtifactMigrationPlanEvidence,
  LegacyToolArtifactMigrationRollbackEvidence,
} from '@codesoul-co/hypha-adapters-local';

Usage patterns

• Use the 3 type/interface exports as static contracts in application code, adapters, or tests. Import them with import type; they do not exist at runtime.
• The module exposes 6 functions as direct operation entrypoints. Every overload, required/optional parameter, and return type is documented below.

Public exports

Symbol	Kind	Signature	Description
isLegacyToolArtifactMigrationExecutionReportId	function	isLegacyToolArtifactMigrationExecutionReportId(value: unknown): value is string	Is Legacy Tool Artifact Migration Execution Report ID function with 1 public call signature; parameters and return types are listed below.
isLegacyToolArtifactMigrationPlanHash	function	isLegacyToolArtifactMigrationPlanHash(value: unknown): value is string	Is Legacy Tool Artifact Migration Plan Hash function with 1 public call signature; parameters and return types are listed below.
isLegacyToolArtifactMigrationRollbackReportId	function	isLegacyToolArtifactMigrationRollbackReportId(value: unknown): value is string	Is Legacy Tool Artifact Migration Rollback Report ID function with 1 public call signature; parameters and return types are listed below.
legacyToolArtifactMigrationExecutionReportId	function	legacyToolArtifactMigrationExecutionReportId(report: LegacyToolArtifactMigrationExecutionEvidence): string	Legacy Tool Artifact Migration Execution Report ID function with 1 public call signature; parameters and return types are listed below.
legacyToolArtifactMigrationPlanHash	function	legacyToolArtifactMigrationPlanHash(plan: LegacyToolArtifactMigrationPlanEvidence): string	Legacy Tool Artifact Migration Plan Hash function with 1 public call signature; parameters and return types are listed below.
legacyToolArtifactMigrationRollbackReportId	function	legacyToolArtifactMigrationRollbackReportId(report: LegacyToolArtifactMigrationRollbackEvidence): string	Legacy Tool Artifact Migration Rollback Report ID function with 1 public call signature; parameters and return types are listed below.
LegacyToolArtifactMigrationExecutionEvidence	interface	interface LegacyToolArtifactMigrationExecutionEvidence	Legacy Tool Artifact Migration Execution Evidence interface with 6 public fields or methods.
LegacyToolArtifactMigrationPlanEvidence	interface	interface LegacyToolArtifactMigrationPlanEvidence	Legacy Tool Artifact Migration Plan Evidence interface with 5 public fields or methods.
LegacyToolArtifactMigrationRollbackEvidence	interface	interface LegacyToolArtifactMigrationRollbackEvidence	Legacy Tool Artifact Migration Rollback Evidence interface with 6 public fields or methods.

isLegacyToolArtifactMigrationExecutionReportId

Is Legacy Tool Artifact Migration Execution Report ID function with 1 public call signature; parameters and return types are listed below.

• Kind: function
• Import: import { isLegacyToolArtifactMigrationExecutionReportId } from '@codesoul-co/hypha-adapters-local';
• Source module: legacy-tool-artifact-migration-report

Declaration

export declare function isLegacyToolArtifactMigrationExecutionReportId(value: unknown): value is string;

Call signature

isLegacyToolArtifactMigrationExecutionReportId(value: unknown): value is string

Parameters

Parameter	Type	Required	Description
value	unknown	Yes	Required parameter; accepted values are defined by the type column.

Returns

• Type: value is string
• Description: The return contract is defined by the type shown above.

isLegacyToolArtifactMigrationPlanHash

Is Legacy Tool Artifact Migration Plan Hash function with 1 public call signature; parameters and return types are listed below.

• Kind: function
• Import: import { isLegacyToolArtifactMigrationPlanHash } from '@codesoul-co/hypha-adapters-local';
• Source module: legacy-tool-artifact-migration-report

Declaration

export declare function isLegacyToolArtifactMigrationPlanHash(value: unknown): value is string;

Call signature

isLegacyToolArtifactMigrationPlanHash(value: unknown): value is string

Parameters

Parameter	Type	Required	Description
value	unknown	Yes	Required parameter; accepted values are defined by the type column.

Returns

• Type: value is string
• Description: The return contract is defined by the type shown above.

isLegacyToolArtifactMigrationRollbackReportId

Is Legacy Tool Artifact Migration Rollback Report ID function with 1 public call signature; parameters and return types are listed below.

• Kind: function
• Import: import { isLegacyToolArtifactMigrationRollbackReportId } from '@codesoul-co/hypha-adapters-local';
• Source module: legacy-tool-artifact-migration-report

Declaration

export declare function isLegacyToolArtifactMigrationRollbackReportId(value: unknown): value is string;

Call signature

isLegacyToolArtifactMigrationRollbackReportId(value: unknown): value is string

Parameters

Parameter	Type	Required	Description
value	unknown	Yes	Required parameter; accepted values are defined by the type column.

Returns

• Type: value is string
• Description: The return contract is defined by the type shown above.

legacyToolArtifactMigrationExecutionReportId

Legacy Tool Artifact Migration Execution Report ID function with 1 public call signature; parameters and return types are listed below.

• Kind: function
• Import: import { legacyToolArtifactMigrationExecutionReportId } from '@codesoul-co/hypha-adapters-local';
• Source module: legacy-tool-artifact-migration-report

Declaration

export declare function legacyToolArtifactMigrationExecutionReportId(report: LegacyToolArtifactMigrationExecutionEvidence): string;

Call signature

legacyToolArtifactMigrationExecutionReportId(report: LegacyToolArtifactMigrationExecutionEvidence): string

Parameters

Parameter	Type	Required	Description
report	LegacyToolArtifactMigrationExecutionEvidence	Yes	Required parameter; accepted values are defined by the type column.

Returns

• Type: string
• Description: The return contract is defined by the type shown above.

legacyToolArtifactMigrationPlanHash

Legacy Tool Artifact Migration Plan Hash function with 1 public call signature; parameters and return types are listed below.

• Kind: function
• Import: import { legacyToolArtifactMigrationPlanHash } from '@codesoul-co/hypha-adapters-local';
• Source module: legacy-tool-artifact-migration-report

Declaration

export declare function legacyToolArtifactMigrationPlanHash(plan: LegacyToolArtifactMigrationPlanEvidence): string;

Call signature

legacyToolArtifactMigrationPlanHash(plan: LegacyToolArtifactMigrationPlanEvidence): string

Parameters

Parameter	Type	Required	Description
plan	LegacyToolArtifactMigrationPlanEvidence	Yes	Required parameter; accepted values are defined by the type column.

Returns

• Type: string
• Description: The return contract is defined by the type shown above.

legacyToolArtifactMigrationRollbackReportId

Legacy Tool Artifact Migration Rollback Report ID function with 1 public call signature; parameters and return types are listed below.

• Kind: function
• Import: import { legacyToolArtifactMigrationRollbackReportId } from '@codesoul-co/hypha-adapters-local';
• Source module: legacy-tool-artifact-migration-report

Declaration

export declare function legacyToolArtifactMigrationRollbackReportId(report: LegacyToolArtifactMigrationRollbackEvidence): string;

Call signature

legacyToolArtifactMigrationRollbackReportId(report: LegacyToolArtifactMigrationRollbackEvidence): string

Parameters

Parameter	Type	Required	Description
report	LegacyToolArtifactMigrationRollbackEvidence	Yes	Required parameter; accepted values are defined by the type column.

Returns

• Type: string
• Description: The return contract is defined by the type shown above.

LegacyToolArtifactMigrationExecutionEvidence

Legacy Tool Artifact Migration Execution Evidence interface with 6 public fields or methods.

• Kind: interface
• Import: import type { LegacyToolArtifactMigrationExecutionEvidence } from '@codesoul-co/hypha-adapters-local';
• Source module: legacy-tool-artifact-migration-report

Declaration

export interface LegacyToolArtifactMigrationExecutionEvidence {
    planHash: string;
    mode: 'dry_run' | 'execute';
    items: unknown[];
    skipped: unknown[];
    summary: unknown;
    reportId?: string;
}

Contract members

Member	Kind	Signature	Description
items	property	items: unknown[]	Public property; its type, readonly modifier and optionality are shown in the signature.
mode	property	mode: "execute" | "dry_run"	Public property; its type, readonly modifier and optionality are shown in the signature.
planHash	property	planHash: string	Public property; its type, readonly modifier and optionality are shown in the signature.
reportId	property	reportId?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
skipped	property	skipped: unknown[]	Public property; its type, readonly modifier and optionality are shown in the signature.
summary	property	summary: unknown	Public property; its type, readonly modifier and optionality are shown in the signature.

LegacyToolArtifactMigrationPlanEvidence

Legacy Tool Artifact Migration Plan Evidence interface with 5 public fields or methods.

• Kind: interface
• Import: import type { LegacyToolArtifactMigrationPlanEvidence } from '@codesoul-co/hypha-adapters-local';
• Source module: legacy-tool-artifact-migration-report

Declaration

export interface LegacyToolArtifactMigrationPlanEvidence {
    imports: unknown[];
    skipped: unknown[];
    totalEntries: number;
    totalBytes: number;
    planHash?: string;
}

Contract members

Member	Kind	Signature	Description
imports	property	imports: unknown[]	Public property; its type, readonly modifier and optionality are shown in the signature.
planHash	property	planHash?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
skipped	property	skipped: unknown[]	Public property; its type, readonly modifier and optionality are shown in the signature.
totalBytes	property	totalBytes: number	Public property; its type, readonly modifier and optionality are shown in the signature.
totalEntries	property	totalEntries: number	Public property; its type, readonly modifier and optionality are shown in the signature.

LegacyToolArtifactMigrationRollbackEvidence

Legacy Tool Artifact Migration Rollback Evidence interface with 6 public fields or methods.

• Kind: interface
• Import: import type { LegacyToolArtifactMigrationRollbackEvidence } from '@codesoul-co/hypha-adapters-local';
• Source module: legacy-tool-artifact-migration-report

Declaration

export interface LegacyToolArtifactMigrationRollbackEvidence {
    planHash: string;
    executionReportId: string;
    mode: 'dry_run' | 'rollback';
    items: unknown[];
    summary: unknown;
    reportId?: string;
}

Contract members

Member	Kind	Signature	Description
executionReportId	property	executionReportId: string	Public property; its type, readonly modifier and optionality are shown in the signature.
items	property	items: unknown[]	Public property; its type, readonly modifier and optionality are shown in the signature.
mode	property	mode: "rollback" | "dry_run"	Public property; its type, readonly modifier and optionality are shown in the signature.
planHash	property	planHash: string	Public property; its type, readonly modifier and optionality are shown in the signature.
reportId	property	reportId?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
summary	property	summary: unknown	Public property; its type, readonly modifier and optionality are shown in the signature.