cc-everywhere

Type Alias: MigrateAssetsMapping

type MigrateAssetsMapping = 
  | {
  inputDocumentId: string;
  status: "success";
  outputDocumentId: string;
  error?: undefined;
}
  | {
  inputDocumentId: string;
  status: "failure";
  outputDocumentId?: undefined;
  error: ErrorData<ErrorCode>;
};

One input-document migration outcome. Migration is per-document: each entry reports its own MigrateAssetsStatus, so a mixed result (some documents migrated, others failed) is expressed as a mix of 'success' and 'failure' entries rather than failing the whole workflow.

This is a discriminated union on status:

• 'success' → outputDocumentId is the migrated signed-in document id, and error is absent.
• 'failure' → error describes why this document could not be migrated, and outputDocumentId is absent.

Union Members

Type Literal

{
  inputDocumentId: string;
  status: "success";
  outputDocumentId: string;
  error?: undefined;
}

inputDocumentId

inputDocumentId: string;

The client-supplied guest document id.

status

status: "success";

outputDocumentId

outputDocumentId: string;

The migrated signed-in document id.

error?

optional error?: undefined;

Type Literal

{
  inputDocumentId: string;
  status: "failure";
  outputDocumentId?: undefined;
  error: ErrorData<ErrorCode>;
}

inputDocumentId

inputDocumentId: string;

The client-supplied guest document id.

status

status: "failure";

outputDocumentId?

optional outputDocumentId?: undefined;

error

error: ErrorData<ErrorCode>;

Why this specific document could not be migrated.

See

ErrorData for the transported per-document error shape.