packages/core/src/resources/Migrations.ts
import { BaseResource } from '@gitbeaker/requester-utils';
import { RequestHelper, endpoint } from '../infrastructure';
import type {
GitlabAPIResponse,
PaginationRequestOptions,
PaginationTypes,
ShowExpanded,
Sudo,
} from '../infrastructure';
export type MigrationStatus = 'created' | 'started' | 'finished' | 'failed';
export interface MigrationEntityFailure {
pipeline_class: string;
pipeline_step: string;
exception_class: string;
correlation_id_value: string;
created_at: string;
}
export interface MigrationEntitySchema extends Record<string, unknown> {
id: number;
bulk_import_id: number;
status: string;
source_full_path: string;
destination_name: string;
destination_namespace: string;
parent_id?: number;
namespace_id: number;
project_id?: string | number;
created_at: string;
updated_at: string;
failures?: MigrationEntityFailure[];
}
export interface MigrationStatusSchema extends Record<string, unknown> {
id: number;
status: string;
source_type: string;
created_at: string;
updated_at: string;
}
export type MigrationEntityOptions = {
sourceType: string;
sourceFullPath: string;
destinationSlug: string;
destinationNamespace: string;
};
export class Migrations<C extends boolean = false> extends BaseResource<C> {
all<E extends boolean = false, P extends PaginationTypes = 'offset'>(
options?: {
status?: MigrationStatus;
} & PaginationRequestOptions<P> &
Sudo &
ShowExpanded<E>,
): Promise<GitlabAPIResponse<MigrationStatusSchema[], C, E, P>> {
return RequestHelper.get<MigrationStatusSchema[]>()(this, 'bulk_imports', options);
}
create<E extends boolean = false>(
configuration: { url: string; access_token: string },
entities: MigrationEntityOptions[],
options?: Sudo & ShowExpanded<E>,
): Promise<GitlabAPIResponse<MigrationStatusSchema, C, E, void>> {
return RequestHelper.post<MigrationStatusSchema>()(this, 'bulk_imports', {
configuration,
entities,
...options,
});
}
allEntities<E extends boolean = false>({
bulkImportId,
...options
}: {
status?: MigrationStatus;
bulkImportId?: number;
} & PaginationRequestOptions<'offset'> &
Sudo &
ShowExpanded<E> = {}): Promise<GitlabAPIResponse<MigrationEntitySchema[], C, E, 'offset'>> {
const url = bulkImportId
? endpoint`bulk_imports/${bulkImportId}/entities`
: 'bulk_imports/entities';
return RequestHelper.get<MigrationEntitySchema[]>()(this, url, options);
}
show<E extends boolean = false>(
bulkImportId: number,
options?: Sudo & ShowExpanded<E>,
): Promise<GitlabAPIResponse<MigrationStatusSchema, C, E, void>> {
return RequestHelper.get<MigrationStatusSchema>()(
this,
`bulk_imports/${bulkImportId}`,
options,
);
}
showEntity<E extends boolean = false>(
bulkImportId: number,
entitityId: number,
options?: Sudo & ShowExpanded<E>,
): Promise<GitlabAPIResponse<MigrationEntitySchema, C, E, void>> {
return RequestHelper.get<MigrationEntitySchema>()(
this,
`bulk_imports/${bulkImportId}/entities/${entitityId}`,
options,
);
}
}