@strapi/data-transfer 4.12.2 → 4.13.0-beta.0

package/dist/strapi/remote/flows/index.d.ts

@@ -0,0 +1,18 @@
+import type { TransferStage } from '../../../../types';
+export type Step = {
+    kind: 'action';
+    action: string;
+} | {
+    kind: 'transfer';
+    stage: TransferStage;
+    locked?: boolean;
+};
+export { default as DEFAULT_TRANSFER_FLOW } from './default';
+export interface TransferFlow {
+    has(step: Step): boolean;
+    can(step: Step): boolean;
+    cannot(step: Step): boolean;
+    set(step: Step): this;
+    get(): Step | null;
+}
+export declare const createFlow: (flow: readonly Step[]) => TransferFlow;

package/dist/strapi/remote/flows/index.js

@@ -0,0 +1,59 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createFlow = exports.DEFAULT_TRANSFER_FLOW = void 0;
+var default_1 = require("./default");
+Object.defineProperty(exports, "DEFAULT_TRANSFER_FLOW", { enumerable: true, get: function () { return __importDefault(default_1).default; } });
+const createFlow = (flow) => {
+    const state = { step: null };
+    /**
+     * Equality check between two steps
+     */
+    const stepEqual = (stepA, stepB) => {
+        if (stepA.kind === 'action' && stepB.kind === 'action') {
+            return stepA.action === stepB.action;
+        }
+        if (stepA.kind === 'transfer' && stepB.kind === 'transfer') {
+            return stepA.stage === stepB.stage;
+        }
+        return false;
+    };
+    /**
+     * Find the index for a given step
+     */
+    const findStepIndex = (step) => flow.findIndex((flowStep) => stepEqual(step, flowStep));
+    return {
+        has(step) {
+            return findStepIndex(step) !== -1;
+        },
+        can(step) {
+            if (state.step === null) {
+                return true;
+            }
+            const indexesDifference = findStepIndex(step) - findStepIndex(state.step);
+            // It's possible to send multiple time the same transfer step in a row
+            if (indexesDifference === 0 && step.kind === 'transfer') {
+                return true;
+            }
+            return indexesDifference > 0;
+        },
+        cannot(step) {
+            return !this.can(step);
+        },
+        set(step) {
+            const canSwitch = this.can(step);
+            if (!canSwitch) {
+                throw new Error('Impossible to proceed to the given step');
+            }
+            state.step = step;
+            return this;
+        },
+        get() {
+            return state.step;
+        },
+    };
+};
+exports.createFlow = createFlow;
+//# sourceMappingURL=index.js.map

package/dist/strapi/remote/flows/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/strapi/remote/flows/index.ts"],"names":[],"mappings":";;;;;;AAMA,qCAA6D;AAApD,iIAAA,OAAO,OAAyB;AAclC,MAAM,UAAU,GAAG,CAAC,IAAqB,EAAgB,EAAE;IAChE,MAAM,KAAK,GAAW,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC;IAErC;;OAEG;IACH,MAAM,SAAS,GAAG,CAAC,KAAW,EAAE,KAAW,EAAW,EAAE;QACtD,IAAI,KAAK,CAAC,IAAI,KAAK,QAAQ,IAAI,KAAK,CAAC,IAAI,KAAK,QAAQ,EAAE;YACtD,OAAO,KAAK,CAAC,MAAM,KAAK,KAAK,CAAC,MAAM,CAAC;SACtC;QAED,IAAI,KAAK,CAAC,IAAI,KAAK,UAAU,IAAI,KAAK,CAAC,IAAI,KAAK,UAAU,EAAE;YAC1D,OAAO,KAAK,CAAC,KAAK,KAAK,KAAK,CAAC,KAAK,CAAC;SACpC;QAED,OAAO,KAAK,CAAC;IACf,CAAC,CAAC;IAEF;;OAEG;IACH,MAAM,aAAa,GAAG,CAAC,IAAU,EAAE,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,SAAS,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC,CAAC;IAE9F,OAAO;QACL,GAAG,CAAC,IAAU;YACZ,OAAO,aAAa,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;QACpC,CAAC;QAED,GAAG,CAAC,IAAU;YACZ,IAAI,KAAK,CAAC,IAAI,KAAK,IAAI,EAAE;gBACvB,OAAO,IAAI,CAAC;aACb;YAED,MAAM,iBAAiB,GAAG,aAAa,CAAC,IAAI,CAAC,GAAG,aAAa,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;YAE1E,sEAAsE;YACtE,IAAI,iBAAiB,KAAK,CAAC,IAAI,IAAI,CAAC,IAAI,KAAK,UAAU,EAAE;gBACvD,OAAO,IAAI,CAAC;aACb;YAED,OAAO,iBAAiB,GAAG,CAAC,CAAC;QAC/B,CAAC;QAED,MAAM,CAAC,IAAU;YACf,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QACzB,CAAC;QAED,GAAG,CAAC,IAAU;YACZ,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;YAEjC,IAAI,CAAC,SAAS,EAAE;gBACd,MAAM,IAAI,KAAK,CAAC,yCAAyC,CAAC,CAAC;aAC5D;YAED,KAAK,CAAC,IAAI,GAAG,IAAI,CAAC;YAElB,OAAO,IAAI,CAAC;QACd,CAAC;QAED,GAAG;YACD,OAAO,KAAK,CAAC,IAAI,CAAC;QACpB,CAAC;KACF,CAAC;AACJ,CAAC,CAAC;AA/DW,QAAA,UAAU,cA+DrB"}

package/dist/strapi/remote/handlers/abstract.d.ts

@@ -0,0 +1,71 @@
+/// <reference types="node" />
+import type { WebSocket, RawData } from 'ws';
+import type { ValidTransferCommand } from './constants';
+import type { TransferMethod } from '../constants';
+type BufferLike = Parameters<WebSocket['send']>[0];
+export interface TransferState {
+    id?: string;
+    startedAt?: number;
+    response?: {
+        uuid?: string;
+        e?: Error | null;
+        data?: unknown;
+    };
+}
+export interface Handler {
+    get transferID(): TransferState['id'];
+    set transferID(id: TransferState['id']);
+    get startedAt(): TransferState['startedAt'];
+    set startedAt(id: TransferState['startedAt']);
+    get response(): TransferState['response'];
+    set response(response: TransferState['response']);
+    addUUID(uuid: string): void;
+    hasUUID(uuid: string): boolean;
+    /**
+     * Returns whether a transfer is currently in progress or not
+     */
+    isTransferStarted(): boolean;
+    /**
+     * Make sure the current transfer is started and initialized
+     */
+    assertValidTransfer(): void;
+    /**
+     * Checks that the given string is a valid transfer command
+     */
+    assertValidTransferCommand(command: string): asserts command is ValidTransferCommand;
+    /**
+     * Respond to a specific message
+     */
+    respond<T = unknown>(uuid?: string, e?: Error | null, data?: T): Promise<void>;
+    /**
+     * It sends a message to the client
+     */
+    send<T extends BufferLike>(message: T, cb?: (err?: Error) => void): void;
+    /**
+     * It sends a message to the client and waits for a confirmation
+     */
+    confirm<T = unknown>(message: T): Promise<void>;
+    /**
+     * Check the current auth has the permission for the given scope
+     */
+    verifyAuth(scope?: TransferMethod): Promise<void>;
+    /**
+     * Invoke a function and return its result to the client
+     */
+    executeAndRespond<T = unknown>(uuid: string, fn: () => T): Promise<void>;
+    /**
+     * Lifecycle called on error or when the ws connection is closed
+     */
+    teardown(): Promise<void> | void;
+    /**
+     * Lifecycle called to cleanup the transfer state
+     */
+    cleanup(): Promise<void> | void;
+    init(...args: unknown[]): unknown;
+    end(...args: unknown[]): unknown;
+    status(...args: unknown[]): unknown;
+    onMessage(message: RawData, isBinary: boolean): Promise<void> | void;
+    onClose(code: number, reason: Buffer): Promise<void> | void;
+    onError(err: Error): Promise<void> | void;
+}
+export {};

package/dist/strapi/remote/handlers/abstract.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=abstract.js.map

package/dist/strapi/remote/handlers/abstract.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"abstract.js","sourceRoot":"","sources":["../../../../src/strapi/remote/handlers/abstract.ts"],"names":[],"mappings":""}

package/dist/strapi/remote/handlers/constants.d.ts

@@ -0,0 +1,2 @@
+export declare const VALID_TRANSFER_COMMANDS: readonly ["init", "end", "status"];
+export type ValidTransferCommand = (typeof VALID_TRANSFER_COMMANDS)[number];

package/dist/strapi/remote/handlers/constants.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.VALID_TRANSFER_COMMANDS = void 0;
+exports.VALID_TRANSFER_COMMANDS = ['init', 'end', 'status'];
+//# sourceMappingURL=constants.js.map

package/dist/strapi/remote/handlers/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../../../src/strapi/remote/handlers/constants.ts"],"names":[],"mappings":";;;AAAa,QAAA,uBAAuB,GAAG,CAAC,MAAM,EAAE,KAAK,EAAE,QAAQ,CAAU,CAAC"}

package/dist/strapi/remote/handlers/index.d.ts

@@ -0,0 +1,3 @@
+export { createPushController, PushHandler } from './push';
+export { createPullController, PullHandler } from './pull';
+export { handlerControllerFactory, HandlerOptions } from './utils';

package/dist/strapi/remote/handlers/index.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.handlerControllerFactory = exports.createPullController = exports.createPushController = void 0;
+var push_1 = require("./push");
+Object.defineProperty(exports, "createPushController", { enumerable: true, get: function () { return push_1.createPushController; } });
+var pull_1 = require("./pull");
+Object.defineProperty(exports, "createPullController", { enumerable: true, get: function () { return pull_1.createPullController; } });
+var utils_1 = require("./utils");
+Object.defineProperty(exports, "handlerControllerFactory", { enumerable: true, get: function () { return utils_1.handlerControllerFactory; } });
+//# sourceMappingURL=index.js.map

package/dist/strapi/remote/handlers/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/strapi/remote/handlers/index.ts"],"names":[],"mappings":";;;AAAA,+BAA2D;AAAlD,4GAAA,oBAAoB,OAAA;AAC7B,+BAA2D;AAAlD,4GAAA,oBAAoB,OAAA;AAC7B,iCAAmE;AAA1D,iHAAA,wBAAwB,OAAA"}

package/dist/strapi/remote/handlers/pull.d.ts

@@ -0,0 +1,22 @@
+/// <reference types="node" />
+/// <reference types="koa" />
+import { Readable } from 'stream';
+import { Handler } from './abstract';
+import { ILocalStrapiSourceProvider } from '../../providers';
+import type { TransferStage, Protocol } from '../../../../types';
+declare const VALID_TRANSFER_ACTIONS: readonly ["bootstrap", "close", "getMetadata", "getSchemas"];
+type PullTransferAction = (typeof VALID_TRANSFER_ACTIONS)[number];
+export interface PullHandler extends Handler {
+    provider?: ILocalStrapiSourceProvider;
+    streams?: {
+        [stage in TransferStage]?: Readable;
+    };
+    assertValidTransferAction(action: string): asserts action is PullTransferAction;
+    onTransferMessage(msg: Protocol.Client.TransferMessage): Promise<unknown> | unknown;
+    onTransferAction(msg: Protocol.Client.Action): Promise<unknown> | unknown;
+    onTransferStep(msg: Protocol.Client.TransferPullMessage): Promise<unknown> | unknown;
+    createReadableStreamForStep(step: TransferStage): Promise<void>;
+    flush(stage: TransferStage, id: string): Promise<void> | void;
+}
+export declare const createPullController: (options: import("./utils").HandlerOptions) => (ctx: import("koa").Context) => Promise<void>;
+export {};

package/dist/strapi/remote/handlers/pull.js

@@ -0,0 +1,243 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createPullController = void 0;
+const stream_1 = require("stream");
+const crypto_1 = require("crypto");
+const utils_1 = require("./utils");
+const providers_1 = require("../../providers");
+const providers_2 = require("../../../errors/providers");
+const TRANSFER_KIND = 'pull';
+const VALID_TRANSFER_ACTIONS = ['bootstrap', 'close', 'getMetadata', 'getSchemas'];
+exports.createPullController = (0, utils_1.handlerControllerFactory)((proto) => ({
+    isTransferStarted() {
+        return proto.isTransferStarted.call(this) && this.provider !== undefined;
+    },
+    verifyAuth() {
+        return proto.verifyAuth.call(this, TRANSFER_KIND);
+    },
+    cleanup() {
+        proto.cleanup.call(this);
+        this.streams = {};
+        delete this.provider;
+    },
+    assertValidTransferAction(action) {
+        // Abstract the constant to string[] to allow looser check on the given action
+        const validActions = VALID_TRANSFER_ACTIONS;
+        if (validActions.includes(action)) {
+            return;
+        }
+        throw new providers_2.ProviderTransferError(`Invalid action provided: "${action}"`, {
+            action,
+            validActions: Object.keys(VALID_TRANSFER_ACTIONS),
+        });
+    },
+    async onMessage(raw) {
+        const msg = JSON.parse(raw.toString());
+        if (!(0, utils_1.isDataTransferMessage)(msg)) {
+            return;
+        }
+        if (!msg.uuid) {
+            await this.respond(undefined, new Error('Missing uuid in message'));
+        }
+        if (proto.hasUUID(msg.uuid)) {
+            const previousResponse = proto.response;
+            if (previousResponse?.uuid === msg.uuid) {
+                await this.respond(previousResponse?.uuid, previousResponse.e, previousResponse.data);
+            }
+            return;
+        }
+        const { uuid, type } = msg;
+        proto.addUUID(uuid);
+        // Regular command message (init, end, status)
+        if (type === 'command') {
+            const { command } = msg;
+            await this.executeAndRespond(uuid, () => {
+                this.assertValidTransferCommand(command);
+                // The status command don't have params
+                if (command === 'status') {
+                    return this.status();
+                }
+                return this[command](msg.params);
+            });
+        }
+        // Transfer message (the transfer must be init first)
+        else if (type === 'transfer') {
+            await this.executeAndRespond(uuid, async () => {
+                await this.verifyAuth();
+                this.assertValidTransfer();
+                return this.onTransferMessage(msg);
+            });
+        }
+        // Invalid messages
+        else {
+            await this.respond(uuid, new Error('Bad Request'));
+        }
+    },
+    async onTransferMessage(msg) {
+        const { kind } = msg;
+        if (kind === 'action') {
+            return this.onTransferAction(msg);
+        }
+        if (kind === 'step') {
+            return this.onTransferStep(msg);
+        }
+    },
+    async onTransferAction(msg) {
+        const { action } = msg;
+        this.assertValidTransferAction(action);
+        return this.provider?.[action]();
+    },
+    async flush(stage, id) {
+        const batchSize = 1024 * 1024;
+        let batch = [];
+        const stream = this.streams?.[stage];
+        const batchLength = () => Buffer.byteLength(JSON.stringify(batch));
+        const sendBatch = async () => {
+            await this.confirm({
+                type: 'transfer',
+                data: batch,
+                ended: false,
+                error: null,
+                id,
+            });
+        };
+        if (!stream) {
+            throw new providers_2.ProviderTransferError(`No available stream found for ${stage}`);
+        }
+        try {
+            for await (const chunk of stream) {
+                batch.push(chunk);
+                if (batchLength() >= batchSize) {
+                    await sendBatch();
+                    batch = [];
+                }
+            }
+            if (batch.length > 0) {
+                await sendBatch();
+                batch = [];
+            }
+            await this.confirm({ type: 'transfer', data: null, ended: true, error: null, id });
+        }
+        catch (e) {
+            await this.confirm({ type: 'transfer', data: null, ended: true, error: e, id });
+        }
+    },
+    async onTransferStep(msg) {
+        const { step, action } = msg;
+        if (action === 'start') {
+            if (this.streams?.[step] instanceof stream_1.Readable) {
+                throw new Error('Stream already created, something went wrong');
+            }
+            const flushUUID = (0, crypto_1.randomUUID)();
+            await this.createReadableStreamForStep(step);
+            this.flush(step, flushUUID);
+            return { ok: true, id: flushUUID };
+        }
+        if (action === 'end') {
+            const stream = this.streams?.[step];
+            if (stream?.readableEnded === false) {
+                await new Promise((resolve) => {
+                    stream?.on('close', resolve).destroy();
+                });
+            }
+            delete this.streams?.[step];
+            return { ok: true };
+        }
+    },
+    async createReadableStreamForStep(step) {
+        const mapper = {
+            entities: () => this.provider?.createEntitiesReadStream(),
+            links: () => this.provider?.createLinksReadStream(),
+            configuration: () => this.provider?.createConfigurationReadStream(),
+            assets: () => {
+                const assets = this.provider?.createAssetsReadStream();
+                let batch = [];
+                const batchLength = () => {
+                    return batch.reduce((acc, chunk) => (chunk.action === 'stream' ? acc + chunk.data.byteLength : acc), 0);
+                };
+                const BATCH_MAX_SIZE = 1024 * 1024; // 1MB
+                if (!assets) {
+                    throw new Error('bad');
+                }
+                /**
+                 * Generates batches of 1MB of data from the assets stream to avoid
+                 * sending too many small chunks
+                 *
+                 * @param stream Assets stream from the local source provider
+                 */
+                async function* generator(stream) {
+                    let hasStarted = false;
+                    let assetID = '';
+                    for await (const chunk of stream) {
+                        const { stream: assetStream, ...assetData } = chunk;
+                        if (!hasStarted) {
+                            assetID = (0, crypto_1.randomUUID)();
+                            // Start the transfer of a new asset
+                            batch.push({ action: 'start', assetID, data: assetData });
+                            hasStarted = true;
+                        }
+                        for await (const assetChunk of assetStream) {
+                            // Add the asset data to the batch
+                            batch.push({ action: 'stream', assetID, data: assetChunk });
+                            // if the batch size is bigger than BATCH_MAX_SIZE stream the batch
+                            if (batchLength() >= BATCH_MAX_SIZE) {
+                                yield batch;
+                                batch = [];
+                            }
+                        }
+                        // All the asset data has been streamed and gets ready for the next one
+                        hasStarted = false;
+                        batch.push({ action: 'end', assetID });
+                        yield batch;
+                        batch = [];
+                    }
+                }
+                return stream_1.Readable.from(generator(assets));
+            },
+        };
+        if (!(step in mapper)) {
+            throw new Error('Invalid transfer step, impossible to create a stream');
+        }
+        if (!this.streams) {
+            throw new Error('Invalid transfer state');
+        }
+        this.streams[step] = await mapper[step]();
+    },
+    // Commands
+    async init() {
+        if (this.transferID || this.provider) {
+            throw new Error('Transfer already in progress');
+        }
+        await this.verifyAuth();
+        this.transferID = (0, crypto_1.randomUUID)();
+        this.startedAt = Date.now();
+        this.streams = {};
+        this.provider = (0, providers_1.createLocalStrapiSourceProvider)({
+            autoDestroy: false,
+            getStrapi: () => strapi,
+        });
+        return { transferID: this.transferID };
+    },
+    async end(params) {
+        await this.verifyAuth();
+        if (this.transferID !== params.transferID) {
+            throw new providers_2.ProviderTransferError('Bad transfer ID provided');
+        }
+        this.cleanup();
+        return { ok: true };
+    },
+    async status() {
+        const isStarted = this.isTransferStarted();
+        if (!isStarted) {
+            const startedAt = this.startedAt;
+            return {
+                active: true,
+                kind: TRANSFER_KIND,
+                startedAt,
+                elapsed: Date.now() - startedAt,
+            };
+        }
+        return { active: false, kind: null, elapsed: null, startedAt: null };
+    },
+}));
+//# sourceMappingURL=pull.js.map

package/dist/strapi/remote/handlers/pull.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"pull.js","sourceRoot":"","sources":["../../../../src/strapi/remote/handlers/pull.ts"],"names":[],"mappings":";;;AAAA,mCAAkC;AAClC,mCAAoC;AAGpC,mCAA0E;AAC1E,+CAA8F;AAC9F,yDAAkE;AAIlE,MAAM,aAAa,GAAG,MAAM,CAAC;AAC7B,MAAM,sBAAsB,GAAG,CAAC,WAAW,EAAE,OAAO,EAAE,aAAa,EAAE,YAAY,CAAU,CAAC;AAoB/E,QAAA,oBAAoB,GAAG,IAAA,gCAAwB,EAAuB,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;IAC7F,iBAAiB;QACf,OAAO,KAAK,CAAC,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,QAAQ,KAAK,SAAS,CAAC;IAC3E,CAAC;IAED,UAAU;QACR,OAAO,KAAK,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,EAAE,aAAa,CAAC,CAAC;IACpD,CAAC;IAED,OAAO;QACL,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAEzB,IAAI,CAAC,OAAO,GAAG,EAAE,CAAC;QAElB,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAED,yBAAyB,CAAoB,MAAM;QACjD,8EAA8E;QAC9E,MAAM,YAAY,GAAG,sBAA6C,CAAC;QAEnE,IAAI,YAAY,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE;YACjC,OAAO;SACR;QAED,MAAM,IAAI,iCAAqB,CAAC,6BAA6B,MAAM,GAAG,EAAE;YACtE,MAAM;YACN,YAAY,EAAE,MAAM,CAAC,IAAI,CAAC,sBAAsB,CAAC;SAClD,CAAC,CAAC;IACL,CAAC;IAED,KAAK,CAAC,SAAS,CAAoB,GAAG;QACpC,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC,CAAC;QAEvC,IAAI,CAAC,IAAA,6BAAqB,EAAC,GAAG,CAAC,EAAE;YAC/B,OAAO;SACR;QAED,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE;YACb,MAAM,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC,CAAC;SACrE;QAED,IAAI,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE;YAC3B,MAAM,gBAAgB,GAAG,KAAK,CAAC,QAAQ,CAAC;YACxC,IAAI,gBAAgB,EAAE,IAAI,KAAK,GAAG,CAAC,IAAI,EAAE;gBACvC,MAAM,IAAI,CAAC,OAAO,CAAC,gBAAgB,EAAE,IAAI,EAAE,gBAAgB,CAAC,CAAC,EAAE,gBAAgB,CAAC,IAAI,CAAC,CAAC;aACvF;YACD,OAAO;SACR;QAED,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,GAAG,CAAC;QAC3B,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QACpB,8CAA8C;QAC9C,IAAI,IAAI,KAAK,SAAS,EAAE;YACtB,MAAM,EAAE,OAAO,EAAE,GAAG,GAAG,CAAC;YAExB,MAAM,IAAI,CAAC,iBAAiB,CAAC,IAAI,EAAE,GAAG,EAAE;gBACtC,IAAI,CAAC,0BAA0B,CAAC,OAAO,CAAC,CAAC;gBAEzC,uCAAuC;gBACvC,IAAI,OAAO,KAAK,QAAQ,EAAE;oBACxB,OAAO,IAAI,CAAC,MAAM,EAAE,CAAC;iBACtB;gBAED,OAAO,IAAI,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;YACnC,CAAC,CAAC,CAAC;SACJ;QAED,qDAAqD;aAChD,IAAI,IAAI,KAAK,UAAU,EAAE;YAC5B,MAAM,IAAI,CAAC,iBAAiB,CAAC,IAAI,EAAE,KAAK,IAAI,EAAE;gBAC5C,MAAM,IAAI,CAAC,UAAU,EAAE,CAAC;gBAExB,IAAI,CAAC,mBAAmB,EAAE,CAAC;gBAE3B,OAAO,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,CAAC;YACrC,CAAC,CAAC,CAAC;SACJ;QAED,mBAAmB;aACd;YACH,MAAM,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,IAAI,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC;SACpD;IACH,CAAC;IAED,KAAK,CAAC,iBAAiB,CAAoB,GAAG;QAC5C,MAAM,EAAE,IAAI,EAAE,GAAG,GAAG,CAAC;QAErB,IAAI,IAAI,KAAK,QAAQ,EAAE;YACrB,OAAO,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC;SACnC;QAED,IAAI,IAAI,KAAK,MAAM,EAAE;YACnB,OAAO,IAAI,CAAC,cAAc,CAAC,GAA0C,CAAC,CAAC;SACxE;IACH,CAAC;IAED,KAAK,CAAC,gBAAgB,CAAoB,GAAG;QAC3C,MAAM,EAAE,MAAM,EAAE,GAAG,GAAG,CAAC;QAEvB,IAAI,CAAC,yBAAyB,CAAC,MAAM,CAAC,CAAC;QAEvC,OAAO,IAAI,CAAC,QAAQ,EAAE,CAAC,MAAM,CAAC,EAAE,CAAC;IACnC,CAAC;IAED,KAAK,CAAC,KAAK,CAAoB,KAAiD,EAAE,EAAE;QAElF,MAAM,SAAS,GAAG,IAAI,GAAG,IAAI,CAAC;QAC9B,IAAI,KAAK,GAAG,EAA6C,CAAC;QAC1D,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,EAAE,CAAC,KAAK,CAAC,CAAC;QAErC,MAAM,WAAW,GAAG,GAAG,EAAE,CAAC,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC;QACnE,MAAM,SAAS,GAAG,KAAK,IAAI,EAAE;YAC3B,MAAM,IAAI,CAAC,OAAO,CAAC;gBACjB,IAAI,EAAE,UAAU;gBAChB,IAAI,EAAE,KAAK;gBACX,KAAK,EAAE,KAAK;gBACZ,KAAK,EAAE,IAAI;gBACX,EAAE;aACH,CAAC,CAAC;QACL,CAAC,CAAC;QAEF,IAAI,CAAC,MAAM,EAAE;YACX,MAAM,IAAI,iCAAqB,CAAC,iCAAiC,KAAK,EAAE,CAAC,CAAC;SAC3E;QAED,IAAI;YACF,IAAI,KAAK,EAAE,MAAM,KAAK,IAAI,MAAM,EAAE;gBAChC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;gBAClB,IAAI,WAAW,EAAE,IAAI,SAAS,EAAE;oBAC9B,MAAM,SAAS,EAAE,CAAC;oBAClB,KAAK,GAAG,EAAE,CAAC;iBACZ;aACF;YAED,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE;gBACpB,MAAM,SAAS,EAAE,CAAC;gBAClB,KAAK,GAAG,EAAE,CAAC;aACZ;YACD,MAAM,IAAI,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,CAAC;SACpF;QAAC,OAAO,CAAC,EAAE;YACV,MAAM,IAAI,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;SACjF;IACH,CAAC;IAED,KAAK,CAAC,cAAc,CAAoB,GAAG;QACzC,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,GAAG,CAAC;QAE7B,IAAI,MAAM,KAAK,OAAO,EAAE;YACtB,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC,IAAI,CAAC,YAAY,iBAAQ,EAAE;gBAC5C,MAAM,IAAI,KAAK,CAAC,8CAA8C,CAAC,CAAC;aACjE;YAED,MAAM,SAAS,GAAG,IAAA,mBAAU,GAAE,CAAC;YAE/B,MAAM,IAAI,CAAC,2BAA2B,CAAC,IAAI,CAAC,CAAC;YAC7C,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;YAE5B,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE,SAAS,EAAE,CAAC;SACpC;QAED,IAAI,MAAM,KAAK,KAAK,EAAE;YACpB,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,EAAE,CAAC,IAAI,CAAC,CAAC;YAEpC,IAAI,MAAM,EAAE,aAAa,KAAK,KAAK,EAAE;gBACnC,MAAM,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;oBAC5B,MAAM,EAAE,EAAE,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,OAAO,EAAE,CAAC;gBACzC,CAAC,CAAC,CAAC;aACJ;YAED,OAAO,IAAI,CAAC,OAAO,EAAE,CAAC,IAAI,CAAC,CAAC;YAE5B,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,CAAC;SACrB;IACH,CAAC;IAED,KAAK,CAAC,2BAA2B,CAAoB,IAAuC;QAC1F,MAAM,MAAM,GAAG;YACb,QAAQ,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,QAAQ,EAAE,wBAAwB,EAAE;YACzD,KAAK,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,QAAQ,EAAE,qBAAqB,EAAE;YACnD,aAAa,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,QAAQ,EAAE,6BAA6B,EAAE;YACnE,MAAM,EAAE,GAAG,EAAE;gBACX,MAAM,MAAM,GAAG,IAAI,CAAC,QAAQ,EAAE,sBAAsB,EAAE,CAAC;gBACvD,IAAI,KAAK,GAAwC,EAAE,CAAC;gBAEpD,MAAM,WAAW,GAAG,GAAG,EAAE;oBACvB,OAAO,KAAK,CAAC,MAAM,CACjB,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,MAAM,KAAK,QAAQ,CAAC,CAAC,CAAC,GAAG,GAAG,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,GAAG,CAAC,EAC/E,CAAC,CACF,CAAC;gBACJ,CAAC,CAAC;gBAEF,MAAM,cAAc,GAAG,IAAI,GAAG,IAAI,CAAC,CAAC,MAAM;gBAE1C,IAAI,CAAC,MAAM,EAAE;oBACX,MAAM,IAAI,KAAK,CAAC,KAAK,CAAC,CAAC;iBACxB;gBACD;;;;;mBAKG;gBACH,KAAK,SAAS,CAAC,CAAC,SAAS,CAAC,MAAgB;oBACxC,IAAI,UAAU,GAAG,KAAK,CAAC;oBACvB,IAAI,OAAO,GAAG,EAAE,CAAC;oBAEjB,IAAI,KAAK,EAAE,MAAM,KAAK,IAAI,MAAM,EAAE;wBAChC,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,GAAG,SAAS,EAAE,GAAG,KAAe,CAAC;wBAC9D,IAAI,CAAC,UAAU,EAAE;4BACf,OAAO,GAAG,IAAA,mBAAU,GAAE,CAAC;4BACvB,oCAAoC;4BACpC,KAAK,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC,CAAC;4BAC1D,UAAU,GAAG,IAAI,CAAC;yBACnB;wBAED,IAAI,KAAK,EAAE,MAAM,UAAU,IAAI,WAAW,EAAE;4BAC1C,kCAAkC;4BAClC,KAAK,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC,CAAC;4BAE5D,mEAAmE;4BACnE,IAAI,WAAW,EAAE,IAAI,cAAc,EAAE;gCACnC,MAAM,KAAK,CAAC;gCACZ,KAAK,GAAG,EAAE,CAAC;6BACZ;yBACF;wBAED,uEAAuE;wBACvE,UAAU,GAAG,KAAK,CAAC;wBACnB,KAAK,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC,CAAC;wBACvC,MAAM,KAAK,CAAC;wBACZ,KAAK,GAAG,EAAE,CAAC;qBACZ;gBACH,CAAC;gBAED,OAAO,iBAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC;YAC1C,CAAC;SACF,CAAC;QAEF,IAAI,CAAC,CAAC,IAAI,IAAI,MAAM,CAAC,EAAE;YACrB,MAAM,IAAI,KAAK,CAAC,sDAAsD,CAAC,CAAC;SACzE;QAED,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE;YACjB,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAC;SAC3C;QAED,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,MAAM,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC;IAC5C,CAAC;IAED,WAAW;IACX,KAAK,CAAC,IAAI;QACR,IAAI,IAAI,CAAC,UAAU,IAAI,IAAI,CAAC,QAAQ,EAAE;YACpC,MAAM,IAAI,KAAK,CAAC,8BAA8B,CAAC,CAAC;SACjD;QACD,MAAM,IAAI,CAAC,UAAU,EAAE,CAAC;QAExB,IAAI,CAAC,UAAU,GAAG,IAAA,mBAAU,GAAE,CAAC;QAC/B,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QAE5B,IAAI,CAAC,OAAO,GAAG,EAAE,CAAC;QAElB,IAAI,CAAC,QAAQ,GAAG,IAAA,2CAA+B,EAAC;YAC9C,WAAW,EAAE,KAAK;YAClB,SAAS,EAAE,GAAG,EAAE,CAAC,MAAM;SACxB,CAAC,CAAC;QAEH,OAAO,EAAE,UAAU,EAAE,IAAI,CAAC,UAAU,EAAE,CAAC;IACzC,CAAC;IAED,KAAK,CAAC,GAAG,CAEP,MAA+C;QAE/C,MAAM,IAAI,CAAC,UAAU,EAAE,CAAC;QAExB,IAAI,IAAI,CAAC,UAAU,KAAK,MAAM,CAAC,UAAU,EAAE;YACzC,MAAM,IAAI,iCAAqB,CAAC,0BAA0B,CAAC,CAAC;SAC7D;QAED,IAAI,CAAC,OAAO,EAAE,CAAC;QAEf,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,CAAC;IACtB,CAAC;IAED,KAAK,CAAC,MAAM;QACV,MAAM,SAAS,GAAG,IAAI,CAAC,iBAAiB,EAAE,CAAC;QAE3C,IAAI,CAAC,SAAS,EAAE;YACd,MAAM,SAAS,GAAG,IAAI,CAAC,SAAmB,CAAC;YAC3C,OAAO;gBACL,MAAM,EAAE,IAAI;gBACZ,IAAI,EAAE,aAAa;gBACnB,SAAS;gBACT,OAAO,EAAE,IAAI,CAAC,GAAG,EAAE,GAAG,SAAS;aAChC,CAAC;SACH;QACD,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC;IACvE,CAAC;CACF,CAAC,CAAC,CAAC"}

package/dist/strapi/remote/handlers/push.d.ts

@@ -0,0 +1,75 @@
+/// <reference types="node" />
+/// <reference types="koa" />
+import { Writable, PassThrough } from 'stream';
+import type { TransferFlow } from '../flows';
+import type { TransferStage, IAsset, Protocol } from '../../../../types';
+import { createLocalStrapiDestinationProvider } from '../../providers';
+import { Handler } from './abstract';
+declare const VALID_TRANSFER_ACTIONS: readonly ["bootstrap", "close", "rollback", "beforeTransfer", "getMetadata", "getSchemas"];
+type PushTransferAction = (typeof VALID_TRANSFER_ACTIONS)[number];
+export interface PushHandler extends Handler {
+    /**
+     * Local Strapi Destination Provider used to write data to the current Strapi instance
+     */
+    provider?: ReturnType<typeof createLocalStrapiDestinationProvider>;
+    /**
+     * Holds all the stages' stream for the current transfer handler (one registry per connection)
+     */
+    streams?: {
+        [stage in TransferStage]?: Writable;
+    };
+    /**
+     * Holds all the transferred assets for the current transfer handler (one registry per connection)
+     */
+    assets: {
+        [filepath: string]: IAsset & {
+            stream: PassThrough;
+        };
+    };
+    /**
+     * Ochestrate and manage the transfer messages' ordering
+     */
+    flow?: TransferFlow;
+    /**
+     * Checks that the given action is a valid push transfer action
+     */
+    assertValidTransferAction(action: string): asserts action is PushTransferAction;
+    /**
+     * Create a new writable stream for the given step in the handler's stream registry
+     */
+    createWritableStreamForStep(step: TransferStage): Promise<void>;
+    /**
+     * Simple override of the auth verification
+     */
+    verifyAuth(): Promise<void>;
+    /**
+     * Callback when receiving a regular transfer message
+     */
+    onTransferMessage(msg: Protocol.Client.TransferMessage): Promise<unknown> | unknown;
+    /**
+     * Callback when receiving a transfer action message
+     */
+    onTransferAction(msg: Protocol.Client.Action): Promise<unknown> | unknown;
+    /**
+     * Callback when receiving a transfer step message
+     */
+    onTransferStep(msg: Protocol.Client.TransferPushMessage): Promise<unknown> | unknown;
+    /**
+     * Start streaming an asset
+     */
+    streamAsset(this: PushHandler, payload: Protocol.Client.GetTransferPushStreamData<'assets'>): Promise<void>;
+    /**
+     * Try to move to a specific transfer stage & lock the step
+     */
+    lockTransferStep(stage: TransferStage): void;
+    /**
+     * Try to move to unlock the current step
+     */
+    unlockTransferStep(stage: TransferStage): void;
+    /**
+     * Checks whether it's possible to stream a chunk for the given stage
+     */
+    assertValidStreamTransferStep(stage: TransferStage): void;
+}
+export declare const createPushController: (options: import("./utils").HandlerOptions) => (ctx: import("koa").Context) => Promise<void>;
+export {};