@strapi/data-transfer 4.12.2 → 4.12.5

package/dist/engine/diagnostic.d.ts

@@ -0,0 +1,40 @@
+export interface IDiagnosticReporterOptions {
+    stackSize?: number;
+}
+export type GenericDiagnostic<K extends DiagnosticKind, T = unknown> = {
+    kind: K;
+    details: {
+        message: string;
+        createdAt: Date;
+    } & T;
+};
+export type DiagnosticKind = 'error' | 'warning' | 'info';
+export type DiagnosticListener<T extends DiagnosticKind = DiagnosticKind> = (diagnostic: {
+    kind: T;
+} & Diagnostic extends infer U ? U : never) => void | Promise<void>;
+export type DiagnosticEvent = 'diagnostic' | `diagnostic.${DiagnosticKind}`;
+export type GetEventListener<E extends DiagnosticEvent> = E extends 'diagnostic' ? DiagnosticListener : E extends `diagnostic.${infer K}` ? K extends DiagnosticKind ? DiagnosticListener<K> : never : never;
+export type Diagnostic = ErrorDiagnostic | WarningDiagnostic | InfoDiagnostic;
+export type ErrorDiagnosticSeverity = 'fatal' | 'error' | 'silly';
+export type ErrorDiagnostic = GenericDiagnostic<'error', {
+    name: string;
+    severity: ErrorDiagnosticSeverity;
+    error: Error;
+}>;
+export type WarningDiagnostic = GenericDiagnostic<'warning', {
+    origin?: string;
+}>;
+export type InfoDiagnostic<T = unknown> = GenericDiagnostic<'info', {
+    params?: T;
+}>;
+export interface IDiagnosticReporter {
+    stack: {
+        readonly size: number;
+        readonly items: Diagnostic[];
+    };
+    report(diagnostic: Diagnostic): IDiagnosticReporter;
+    onDiagnostic(listener: DiagnosticListener): IDiagnosticReporter;
+    on<T extends DiagnosticKind>(kind: T, listener: DiagnosticListener<T>): IDiagnosticReporter;
+}
+declare const createDiagnosticReporter: (options?: IDiagnosticReporterOptions) => IDiagnosticReporter;
+export { createDiagnosticReporter };

package/dist/engine/diagnostic.js

@@ -0,0 +1,50 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createDiagnosticReporter = void 0;
+const events_1 = require("events");
+const createDiagnosticReporter = (options = {}) => {
+    const { stackSize = -1 } = options;
+    const emitter = new events_1.EventEmitter();
+    const stack = [];
+    const addListener = (event, listener) => {
+        emitter.on(event, listener);
+    };
+    const isDiagnosticValid = (diagnostic) => {
+        if (!diagnostic.kind || !diagnostic.details || !diagnostic.details.message) {
+            return false;
+        }
+        return true;
+    };
+    return {
+        stack: {
+            get size() {
+                return stack.length;
+            },
+            get items() {
+                return stack;
+            },
+        },
+        report(diagnostic) {
+            if (!isDiagnosticValid(diagnostic)) {
+                return this;
+            }
+            emitter.emit('diagnostic', diagnostic);
+            emitter.emit(`diagnostic.${diagnostic.kind}`, diagnostic);
+            if (stackSize !== -1 && stack.length >= stackSize) {
+                stack.shift();
+            }
+            stack.push(diagnostic);
+            return this;
+        },
+        onDiagnostic(listener) {
+            addListener('diagnostic', listener);
+            return this;
+        },
+        on(kind, listener) {
+            addListener(`diagnostic.${kind}`, listener);
+            return this;
+        },
+    };
+};
+exports.createDiagnosticReporter = createDiagnosticReporter;
+//# sourceMappingURL=diagnostic.js.map

package/dist/engine/diagnostic.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"diagnostic.js","sourceRoot":"","sources":["../../src/engine/diagnostic.ts"],"names":[],"mappings":";;;AAAA,mCAAsC;AAoEtC,MAAM,wBAAwB,GAAG,CAC/B,UAAsC,EAAE,EACnB,EAAE;IACvB,MAAM,EAAE,SAAS,GAAG,CAAC,CAAC,EAAE,GAAG,OAAO,CAAC;IAEnC,MAAM,OAAO,GAAG,IAAI,qBAAY,EAAE,CAAC;IACnC,MAAM,KAAK,GAAiB,EAAE,CAAC;IAE/B,MAAM,WAAW,GAAG,CAA4B,KAAQ,EAAE,QAA6B,EAAE,EAAE;QACzF,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;IAC9B,CAAC,CAAC;IAEF,MAAM,iBAAiB,GAAG,CAAC,UAAsB,EAAE,EAAE;QACnD,IAAI,CAAC,UAAU,CAAC,IAAI,IAAI,CAAC,UAAU,CAAC,OAAO,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,OAAO,EAAE;YAC1E,OAAO,KAAK,CAAC;SACd;QACD,OAAO,IAAI,CAAC;IACd,CAAC,CAAC;IAEF,OAAO;QACL,KAAK,EAAE;YACL,IAAI,IAAI;gBACN,OAAO,KAAK,CAAC,MAAM,CAAC;YACtB,CAAC;YAED,IAAI,KAAK;gBACP,OAAO,KAAK,CAAC;YACf,CAAC;SACF;QAED,MAAM,CAAC,UAAsB;YAC3B,IAAI,CAAC,iBAAiB,CAAC,UAAU,CAAC,EAAE;gBAClC,OAAO,IAAI,CAAC;aACb;YAED,OAAO,CAAC,IAAI,CAAC,YAAY,EAAE,UAAU,CAAC,CAAC;YACvC,OAAO,CAAC,IAAI,CAAC,cAAc,UAAU,CAAC,IAAI,EAAE,EAAE,UAAU,CAAC,CAAC;YAE1D,IAAI,SAAS,KAAK,CAAC,CAAC,IAAI,KAAK,CAAC,MAAM,IAAI,SAAS,EAAE;gBACjD,KAAK,CAAC,KAAK,EAAE,CAAC;aACf;YAED,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;YAEvB,OAAO,IAAI,CAAC;QACd,CAAC;QAED,YAAY,CAAC,QAA4B;YACvC,WAAW,CAAC,YAAY,EAAE,QAAQ,CAAC,CAAC;YAEpC,OAAO,IAAI,CAAC;QACd,CAAC;QAED,EAAE,CAA2B,IAAO,EAAE,QAA+B;YACnE,WAAW,CAAC,cAAc,IAAI,EAAE,EAAE,QAAiB,CAAC,CAAC;YAErD,OAAO,IAAI,CAAC;QACd,CAAC;KACF,CAAC;AACJ,CAAC,CAAC;AAEO,4DAAwB"}

package/dist/engine/errors.d.ts

@@ -0,0 +1,28 @@
+import { DataTransferError, Severity } from '../errors';
+type TransferEngineStep = 'initialization' | 'validation' | 'transfer';
+type TransferEngineErrorDetails<P extends TransferEngineStep = TransferEngineStep, U = never> = {
+    step: P;
+} & ([U] extends [never] ? unknown : {
+    details?: U;
+});
+declare class TransferEngineError<P extends TransferEngineStep = TransferEngineStep, U = never, T extends TransferEngineErrorDetails<P, U> = TransferEngineErrorDetails<P, U>> extends DataTransferError<T> {
+    constructor(severity: Severity, message?: string, details?: T | null);
+}
+declare class TransferEngineInitializationError extends TransferEngineError<'initialization'> {
+    constructor(message?: string);
+}
+declare class TransferEngineValidationError<T extends {
+    check: string;
+} = {
+    check: string;
+}> extends TransferEngineError<'validation', T> {
+    constructor(message?: string, details?: T);
+}
+declare class TransferEngineTransferError<T extends {
+    check: string;
+} = {
+    check: string;
+}> extends TransferEngineError<'transfer', T> {
+    constructor(message?: string, details?: T);
+}
+export { TransferEngineError, TransferEngineInitializationError, TransferEngineValidationError, TransferEngineTransferError, };

package/dist/engine/errors.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TransferEngineTransferError = exports.TransferEngineValidationError = exports.TransferEngineInitializationError = exports.TransferEngineError = void 0;
+const errors_1 = require("../errors");
+class TransferEngineError extends errors_1.DataTransferError {
+    constructor(severity, message, details) {
+        super('engine', severity, message, details);
+    }
+}
+exports.TransferEngineError = TransferEngineError;
+class TransferEngineInitializationError extends TransferEngineError {
+    constructor(message) {
+        super(errors_1.SeverityKind.FATAL, message, { step: 'initialization' });
+    }
+}
+exports.TransferEngineInitializationError = TransferEngineInitializationError;
+class TransferEngineValidationError extends TransferEngineError {
+    constructor(message, details) {
+        super(errors_1.SeverityKind.FATAL, message, { step: 'validation', details });
+    }
+}
+exports.TransferEngineValidationError = TransferEngineValidationError;
+class TransferEngineTransferError extends TransferEngineError {
+    constructor(message, details) {
+        super(errors_1.SeverityKind.FATAL, message, { step: 'transfer', details });
+    }
+}
+exports.TransferEngineTransferError = TransferEngineTransferError;
+//# sourceMappingURL=errors.js.map

package/dist/engine/errors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.js","sourceRoot":"","sources":["../../src/engine/errors.ts"],"names":[],"mappings":";;;AAAA,sCAAsE;AAQtE,MAAM,mBAIJ,SAAQ,0BAAoB;IAC5B,YAAY,QAAkB,EAAE,OAAgB,EAAE,OAAkB;QAClE,KAAK,CAAC,QAAQ,EAAE,QAAQ,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;IAC9C,CAAC;CACF;AAyBC,kDAAmB;AAvBrB,MAAM,iCAAkC,SAAQ,mBAAqC;IACnF,YAAY,OAAgB;QAC1B,KAAK,CAAC,qBAAY,CAAC,KAAK,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,gBAAgB,EAAE,CAAC,CAAC;IACjE,CAAC;CACF;AAoBC,8EAAiC;AAlBnC,MAAM,6BAEJ,SAAQ,mBAAoC;IAC5C,YAAY,OAAgB,EAAE,OAAW;QACvC,KAAK,CAAC,qBAAY,CAAC,KAAK,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,YAAY,EAAE,OAAO,EAAE,CAAC,CAAC;IACtE,CAAC;CACF;AAaC,sEAA6B;AAX/B,MAAM,2BAEJ,SAAQ,mBAAkC;IAC1C,YAAY,OAAgB,EAAE,OAAW;QACvC,KAAK,CAAC,qBAAY,CAAC,KAAK,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,UAAU,EAAE,OAAO,EAAE,CAAC,CAAC;IACpE,CAAC;CACF;AAMC,kEAA2B"}

package/dist/engine/index.d.ts

@@ -0,0 +1,64 @@
+/// <reference types="node" />
+import { PassThrough } from 'stream';
+import type { IDestinationProvider, ISourceProvider, ITransferEngine, ITransferEngineOptions, TransferProgress, ITransferResults, TransferStage, TransferFilters, TransferFilterPreset, SchemaDiffHandler, ErrorHandler, ErrorCode } from '../../types';
+import { IDiagnosticReporter, ErrorDiagnosticSeverity } from './diagnostic';
+export declare const TRANSFER_STAGES: ReadonlyArray<TransferStage>;
+export type TransferGroupFilter = Record<TransferFilterPreset, TransferFilters>;
+/**
+ * Preset filters for only/exclude options
+ * */
+export declare const TransferGroupPresets: TransferGroupFilter;
+export declare const DEFAULT_VERSION_STRATEGY = "ignore";
+export declare const DEFAULT_SCHEMA_STRATEGY = "strict";
+declare class TransferEngine<S extends ISourceProvider = ISourceProvider, D extends IDestinationProvider = IDestinationProvider> implements ITransferEngine {
+    #private;
+    sourceProvider: ISourceProvider;
+    destinationProvider: IDestinationProvider;
+    options: ITransferEngineOptions;
+    progress: {
+        data: TransferProgress;
+        stream: PassThrough;
+    };
+    diagnostics: IDiagnosticReporter;
+    onSchemaDiff(handler: SchemaDiffHandler): void;
+    addErrorHandler(handlerName: ErrorCode, handler: ErrorHandler): void;
+    attemptResolveError(error: Error): Promise<boolean>;
+    constructor(sourceProvider: S, destinationProvider: D, options: ITransferEngineOptions);
+    /**
+     * Report a fatal error and throw it
+     */
+    panic(error: Error): void;
+    /**
+     * Report an error diagnostic
+     */
+    reportError(error: Error, severity: ErrorDiagnosticSeverity): void;
+    /**
+     * Report a warning diagnostic
+     */
+    reportWarning(message: string, origin?: string): void;
+    /**
+     * Report an info diagnostic
+     */
+    reportInfo(message: string, params?: unknown): void;
+    shouldSkipStage(stage: TransferStage): boolean;
+    abortTransfer(): Promise<void>;
+    init(): Promise<void>;
+    /**
+     * Run the bootstrap method in both source and destination providers
+     */
+    bootstrap(): Promise<void>;
+    /**
+     * Run the close method in both source and destination providers
+     */
+    close(): Promise<void>;
+    integrityCheck(): Promise<void>;
+    transfer(): Promise<ITransferResults<S, D>>;
+    beforeTransfer(): Promise<void>;
+    transferSchemas(): Promise<void>;
+    transferEntities(): Promise<void>;
+    transferLinks(): Promise<void>;
+    transferAssets(): Promise<void>;
+    transferConfiguration(): Promise<void>;
+}
+export declare const createTransferEngine: <S extends ISourceProvider, D extends IDestinationProvider>(sourceProvider: S, destinationProvider: D, options: ITransferEngineOptions) => TransferEngine<S, D>;
+export * as errors from './errors';