@prismicio/client/dist/lib/resolveMigrationDocumentData.d.ts

The official JavaScript + TypeScript client library for Prismic

import type { MigrationLinkToMediaField } from "../types/migration/Asset";
import { type MigrationImage, type MigrationLinkToMedia, type MigrationRTImageNode } from "../types/migration/Asset";
import type { MigrationContentRelationship, MigrationContentRelationshipField } from "../types/migration/ContentRelationship";
import type { MaybeLink } from "../types/migration/Link";
import type { FilledImageFieldImage } from "../types/value/image";
import type { OptionalLinkProperties } from "../types/value/link";
import type { RTImageNode } from "../types/value/richText";
import type { Migration } from "../Migration";
/**
 * Resolves a migration content relationship to a content relationship field.
 *
 * @param relation - Content relationship to resolve.
 *
 * @returns Resolved content relationship field.
 */
export declare function resolveMigrationContentRelationship(relation: MaybeLink<MigrationContentRelationship>): Promise<MigrationContentRelationshipField & OptionalLinkProperties>;
/**
 * Resolves a migration image to an image field.
 *
 * @param migrationAsset - Asset to resolve.
 * @param migration - Migration instance.
 * @param withThumbnails - Whether to include thumbnails.
 *
 * @returns Resolved image field.
 */
export declare const resolveMigrationImage: (image: MigrationImage, migration: Migration, withThumbnails?: boolean) => FilledImageFieldImage | undefined;
/**
 * Resolves a migration rich text image node to a regular rich text image node.
 *
 * @param rtImageNode - Migration rich text image node to resolve.
 * @param migration - Migration instance.
 *
 * @returns Resolved rich text image node.
 */
export declare const resolveMigrationRTImageNode: (rtImageNode: MigrationRTImageNode, migration: Migration) => Promise<RTImageNode | undefined>;
/**
 * Resolves a migration link to media to a regular link to media field.
 *
 * @param linkToMedia - Migration link to media to resolve.
 * @param migration - Migration instance.
 *
 * @returns Resolved link to media field.
 */
export declare const resolveMigrationLinkToMedia: (linkToMedia: MaybeLink<MigrationLinkToMedia>, migration: Migration) => MigrationLinkToMediaField;
/**
 * Resolves a migration document data to actual data ready to be sent to the
 * Migration API.
 *
 * @param input - Migration link to media to resolve.
 * @param migration - Migration instance.
 *
 * @returns Resolved data.
 */
export declare function resolveMigrationDocumentData(input: unknown, migration: Migration): Promise<unknown>;