@strapi/data-transfer 4.6.0-beta.1 → 4.6.0-beta.2

package/{dist → lib}/engine/index.d.ts

@@ -1,7 +1,12 @@
 /// <reference types="node" />
 import { PassThrough } from 'stream';
-import type { IDestinationProvider, ISourceProvider, ITransferEngine, ITransferEngineOptions, TransferProgress, ITransferResults, TransferStage } from '../../types';
+import type { IDestinationProvider, ISourceProvider, ITransferEngine, ITransferEngineOptions, TransferProgress, ITransferResults, TransferStage, TransferFilters, TransferFilterPreset } from '../../types';
 export declare const TRANSFER_STAGES: ReadonlyArray<TransferStage>;
+export declare 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 {
@@ -14,6 +19,7 @@ declare class TransferEngine<S extends ISourceProvider = ISourceProvider, D exte
         stream: PassThrough;
     };
     constructor(sourceProvider: ISourceProvider, destinationProvider: IDestinationProvider, options: ITransferEngineOptions);
+    shouldSkipStage(stage: TransferStage): boolean;
     init(): Promise<void>;
     bootstrap(): Promise<void>;
     close(): Promise<void>;

package/{dist → lib}/engine/index.js

@@ -4,17 +4,14 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
     if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
     return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
 };
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 var _TransferEngine_instances, _TransferEngine_metadata, _TransferEngine_createStageTransformStream, _TransferEngine_updateTransferProgress, _TransferEngine_progressTracker, _TransferEngine_emitTransferUpdate, _TransferEngine_emitStageUpdate, _TransferEngine_assertStrapiVersionIntegrity, _TransferEngine_assertSchemasMatching, _TransferEngine_transferStage, _TransferEngine_resolveProviderResource;
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createTransferEngine = exports.DEFAULT_SCHEMA_STRATEGY = exports.DEFAULT_VERSION_STRATEGY = exports.TRANSFER_STAGES = void 0;
+exports.createTransferEngine = exports.DEFAULT_SCHEMA_STRATEGY = exports.DEFAULT_VERSION_STRATEGY = exports.TransferGroupPresets = exports.TRANSFER_STAGES = void 0;
 const stream_1 = require("stream");
 const path_1 = require("path");
 const fp_1 = require("lodash/fp");
 const semver_1 = require("semver");
-const strategies_1 = __importDefault(require("../strategies"));
+const schemas_1 = require("./validation/schemas");
 const stream_2 = require("../utils/stream");
 exports.TRANSFER_STAGES = Object.freeze([
     'entities',
@@ -23,6 +20,31 @@ exports.TRANSFER_STAGES = Object.freeze([
     'schemas',
     'configuration',
 ]);
+/**
+ * Preset filters for only/exclude options
+ * */
+exports.TransferGroupPresets = {
+    content: {
+        links: true,
+        entities: true,
+        // TODO: If we need to implement filtering on a running stage, it would be done like this, but we still need to implement it
+        // [
+        //   // Example: content processes the entities stage, but filters individual entities
+        //   {
+        //     filter(data) {
+        //       return shouldIncludeThisData(data);
+        //     },
+        //   },
+        // ],
+    },
+    files: {
+        assets: true,
+        links: true,
+    },
+    config: {
+        configuration: true,
+    },
+};
 exports.DEFAULT_VERSION_STRATEGY = 'ignore';
 exports.DEFAULT_SCHEMA_STRATEGY = 'strict';
 class TransferEngine {
@@ -40,6 +62,28 @@ class TransferEngine {
         this.options = options;
         this.progress = { data: {}, stream: new stream_1.PassThrough({ objectMode: true }) };
     }
+    shouldSkipStage(stage) {
+        const { exclude, only } = this.options;
+        // schemas must always be included
+        if (stage === 'schemas') {
+            return false;
+        }
+        // everything is included by default unless 'only' has been set
+        let included = (0, fp_1.isEmpty)(only);
+        if (only?.length > 0) {
+            included = only.some((transferGroup) => {
+                return exports.TransferGroupPresets[transferGroup][stage];
+            });
+        }
+        if (exclude?.length > 0) {
+            if (included) {
+                included = !exclude.some((transferGroup) => {
+                    return exports.TransferGroupPresets[transferGroup][stage];
+                });
+            }
+        }
+        return !included;
+    }
     async init() {
         // Resolve providers' resource and store
         // them in the engine's internal state
@@ -77,8 +121,8 @@ class TransferEngine {
     async transfer() {
         // reset data between transfers
         this.progress.data = {};
-        __classPrivateFieldGet(this, _TransferEngine_instances, "m", _TransferEngine_emitTransferUpdate).call(this, 'start');
         try {
+            __classPrivateFieldGet(this, _TransferEngine_instances, "m", _TransferEngine_emitTransferUpdate).call(this, 'init');
             await this.bootstrap();
             await this.init();
             const isValidTransfer = await this.integrityCheck();
@@ -86,6 +130,7 @@ class TransferEngine {
                 // TODO: provide the log from the integrity check
                 throw new Error(`Unable to transfer the data between ${this.sourceProvider.name} and ${this.destinationProvider.name}.\nPlease refer to the log above for more information.`);
             }
+            __classPrivateFieldGet(this, _TransferEngine_instances, "m", _TransferEngine_emitTransferUpdate).call(this, 'start');
             await this.beforeTransfer();
             // Run the transfer stages
             await this.transferSchemas();
@@ -116,32 +161,32 @@ class TransferEngine {
     }
     async transferSchemas() {
         const stage = 'schemas';
-        const source = await this.sourceProvider.streamSchemas?.();
-        const destination = await this.destinationProvider.getSchemasStream?.();
+        const source = await this.sourceProvider.createSchemasReadStream?.();
+        const destination = await this.destinationProvider.createSchemasWriteStream?.();
         const transform = __classPrivateFieldGet(this, _TransferEngine_instances, "m", _TransferEngine_createStageTransformStream).call(this, stage);
         const tracker = __classPrivateFieldGet(this, _TransferEngine_instances, "m", _TransferEngine_progressTracker).call(this, stage, { key: (value) => value.modelType });
         await __classPrivateFieldGet(this, _TransferEngine_instances, "m", _TransferEngine_transferStage).call(this, { stage, source, destination, transform, tracker });
     }
     async transferEntities() {
         const stage = 'entities';
-        const source = await this.sourceProvider.streamEntities?.();
-        const destination = await this.destinationProvider.getEntitiesStream?.();
+        const source = await this.sourceProvider.createEntitiesReadStream?.();
+        const destination = await this.destinationProvider.createEntitiesWriteStream?.();
         const transform = __classPrivateFieldGet(this, _TransferEngine_instances, "m", _TransferEngine_createStageTransformStream).call(this, stage);
         const tracker = __classPrivateFieldGet(this, _TransferEngine_instances, "m", _TransferEngine_progressTracker).call(this, stage, { key: (value) => value.type });
         await __classPrivateFieldGet(this, _TransferEngine_instances, "m", _TransferEngine_transferStage).call(this, { stage, source, destination, transform, tracker });
     }
     async transferLinks() {
         const stage = 'links';
-        const source = await this.sourceProvider.streamLinks?.();
-        const destination = await this.destinationProvider.getLinksStream?.();
+        const source = await this.sourceProvider.createLinksReadStream?.();
+        const destination = await this.destinationProvider.createLinksWriteStream?.();
         const transform = __classPrivateFieldGet(this, _TransferEngine_instances, "m", _TransferEngine_createStageTransformStream).call(this, stage);
         const tracker = __classPrivateFieldGet(this, _TransferEngine_instances, "m", _TransferEngine_progressTracker).call(this, stage);
         await __classPrivateFieldGet(this, _TransferEngine_instances, "m", _TransferEngine_transferStage).call(this, { stage, source, destination, transform, tracker });
     }
     async transferAssets() {
         const stage = 'assets';
-        const source = await this.sourceProvider.streamAssets?.();
-        const destination = await this.destinationProvider.getAssetsStream?.();
+        const source = await this.sourceProvider.createAssetsReadStream?.();
+        const destination = await this.destinationProvider.createAssetsWriteStream?.();
         const transform = __classPrivateFieldGet(this, _TransferEngine_instances, "m", _TransferEngine_createStageTransformStream).call(this, stage);
         const tracker = __classPrivateFieldGet(this, _TransferEngine_instances, "m", _TransferEngine_progressTracker).call(this, stage, {
             size: (value) => value.stats.size,
@@ -151,8 +196,8 @@ class TransferEngine {
     }
     async transferConfiguration() {
         const stage = 'configuration';
-        const source = await this.sourceProvider.streamConfiguration?.();
-        const destination = await this.destinationProvider.getConfigurationStream?.();
+        const source = await this.sourceProvider.createConfigurationReadStream?.();
+        const destination = await this.destinationProvider.createConfigurationWriteStream?.();
         const transform = __classPrivateFieldGet(this, _TransferEngine_instances, "m", _TransferEngine_createStageTransformStream).call(this, stage);
         const tracker = __classPrivateFieldGet(this, _TransferEngine_instances, "m", _TransferEngine_progressTracker).call(this, stage);
         await __classPrivateFieldGet(this, _TransferEngine_instances, "m", _TransferEngine_transferStage).call(this, { stage, source, destination, transform, tracker });
@@ -258,7 +303,7 @@ _TransferEngine_metadata = new WeakMap(), _TransferEngine_instances = new WeakSe
     keys.forEach((key) => {
         const sourceSchema = sourceSchemas[key];
         const destinationSchema = destinationSchemas[key];
-        const schemaDiffs = (0, strategies_1.default)(sourceSchema, destinationSchema, strategy);
+        const schemaDiffs = (0, schemas_1.compareSchemas)(sourceSchema, destinationSchema, strategy);
         if (schemaDiffs.length) {
             diffs[key] = schemaDiffs;
         }
@@ -270,7 +315,18 @@ _TransferEngine_metadata = new WeakMap(), _TransferEngine_instances = new WeakSe
     }
 }, _TransferEngine_transferStage = async function _TransferEngine_transferStage(options) {
     const { stage, source, destination, transform, tracker } = options;
-    if (!source || !destination) {
+    if (!source || !destination || this.shouldSkipStage(stage)) {
+        // Wait until source and destination are closed
+        await Promise.allSettled([source, destination].map((stream) => {
+            // if stream is undefined or already closed, resolve immediately
+            if (!stream || stream.destroyed) {
+                return Promise.resolve();
+            }
+            // Wait until the close event is produced and then destroy the stream and resolve
+            return new Promise((resolve, reject) => {
+                stream.on('close', resolve).on('error', reject).destroy();
+            });
+        }));
         __classPrivateFieldGet(this, _TransferEngine_instances, "m", _TransferEngine_emitStageUpdate).call(this, 'skip', stage);
         return;
     }

package/lib/engine/validation/index.d.ts

@@ -0,0 +1 @@
+export * as schemas from './schemas';

package/{dist/providers/shared → lib/engine/validation}/index.js

@@ -23,6 +23,6 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.strapi = void 0;
-exports.strapi = __importStar(require("./strapi"));
+exports.schemas = void 0;
+exports.schemas = __importStar(require("./schemas"));
 //# sourceMappingURL=index.js.map

package/{dist/strategies → lib/engine/validation/schemas}/index.d.ts

@@ -1,7 +1,7 @@
-import type { Diff } from '../utils/json';
+import type { Diff } from '../../../utils/json';
 declare const strategies: {
     exact(diffs: Diff[]): Diff[];
     strict(diffs: Diff[]): Diff[];
 };
 declare const compareSchemas: <T, P>(a: T, b: P, strategy: keyof typeof strategies) => Diff[];
-export default compareSchemas;
+export { compareSchemas };

package/{dist/strategies → lib/engine/validation/schemas}/index.js

@@ -23,7 +23,8 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-const utils = __importStar(require("../utils"));
+exports.compareSchemas = void 0;
+const utils = __importStar(require("../../../utils"));
 const strategies = {
     // No diffs
     exact(diffs) {
@@ -48,5 +49,5 @@ const compareSchemas = (a, b, strategy) => {
     const diffs = utils.json.diff(a, b);
     return strategies[strategy](diffs);
 };
-exports.default = compareSchemas;
+exports.compareSchemas = compareSchemas;
 //# sourceMappingURL=index.js.map

package/lib/file/index.d.ts

@@ -0,0 +1 @@
+export * as providers from './providers';

package/lib/file/index.js

@@ -0,0 +1,28 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.providers = void 0;
+exports.providers = __importStar(require("./providers"));
+//# sourceMappingURL=index.js.map

package/{dist/providers/local-file-destination-provider → lib/file/providers/destination}/index.d.ts

@@ -2,7 +2,7 @@
 /// <reference types="stream-chain" />
 import zlib from 'zlib';
 import { Writable } from 'stream';
-import type { IDestinationProvider, IDestinationProviderTransferResults, IMetadata, ProviderType } from '../../../types';
+import type { IDestinationProvider, IDestinationProviderTransferResults, IMetadata, ProviderType } from '../../../../types';
 export interface ILocalFileDestinationProviderOptions {
     encryption: {
         enabled: boolean;
@@ -36,10 +36,10 @@ declare class LocalFileDestinationProvider implements IDestinationProvider {
     close(): Promise<void>;
     rollback(): Promise<void>;
     getMetadata(): null;
-    getSchemasStream(): import("stream-chain");
-    getEntitiesStream(): Writable;
-    getLinksStream(): Writable;
-    getConfigurationStream(): Writable;
-    getAssetsStream(): Writable;
+    createSchemasWriteStream(): import("stream-chain");
+    createEntitiesWriteStream(): Writable;
+    createLinksWriteStream(): Writable;
+    createConfigurationWriteStream(): Writable;
+    createAssetsWriteStream(): Writable;
 }
 export {};

package/{dist/providers/local-file-destination-provider → lib/file/providers/destination}/index.js

@@ -17,7 +17,7 @@ const zlib_1 = __importDefault(require("zlib"));
 const Stringer_1 = require("stream-json/jsonl/Stringer");
 const stream_chain_1 = require("stream-chain");
 const stream_1 = require("stream");
-const encrypt_1 = require("../../encryption/encrypt");
+const encryption_1 = require("../../../utils/encryption");
 const utils_1 = require("./utils");
 const createLocalFileDestinationProvider = (options) => {
     return new LocalFileDestinationProvider(options);
@@ -52,7 +52,7 @@ class LocalFileDestinationProvider {
             archiveTransforms.push(this.createGzip());
         }
         if (encryption.enabled && encryption.key) {
-            archiveTransforms.push((0, encrypt_1.createEncryptionCipher)(encryption.key));
+            archiveTransforms.push((0, encryption_1.createEncryptionCipher)(encryption.key));
         }
         __classPrivateFieldGet(this, _LocalFileDestinationProvider_archive, "f").pipeline = (0, stream_chain_1.chain)([__classPrivateFieldGet(this, _LocalFileDestinationProvider_archive, "f").stream, ...archiveTransforms, outStream]);
         this.results.file = { path: __classPrivateFieldGet(this, _LocalFileDestinationProvider_instances, "a", _LocalFileDestinationProvider_archivePath_get) };
@@ -77,7 +77,7 @@ class LocalFileDestinationProvider {
     getMetadata() {
         return null;
     }
-    getSchemasStream() {
+    createSchemasWriteStream() {
         if (!__classPrivateFieldGet(this, _LocalFileDestinationProvider_archive, "f").stream) {
             throw new Error('Archive stream is unavailable');
         }
@@ -85,7 +85,7 @@ class LocalFileDestinationProvider {
         const entryStream = (0, utils_1.createTarEntryStream)(__classPrivateFieldGet(this, _LocalFileDestinationProvider_archive, "f").stream, filePathFactory, this.options.file.maxSizeJsonl);
         return (0, stream_chain_1.chain)([(0, Stringer_1.stringer)(), entryStream]);
     }
-    getEntitiesStream() {
+    createEntitiesWriteStream() {
         if (!__classPrivateFieldGet(this, _LocalFileDestinationProvider_archive, "f").stream) {
             throw new Error('Archive stream is unavailable');
         }
@@ -93,7 +93,7 @@ class LocalFileDestinationProvider {
         const entryStream = (0, utils_1.createTarEntryStream)(__classPrivateFieldGet(this, _LocalFileDestinationProvider_archive, "f").stream, filePathFactory, this.options.file.maxSizeJsonl);
         return (0, stream_chain_1.chain)([(0, Stringer_1.stringer)(), entryStream]);
     }
-    getLinksStream() {
+    createLinksWriteStream() {
         if (!__classPrivateFieldGet(this, _LocalFileDestinationProvider_archive, "f").stream) {
             throw new Error('Archive stream is unavailable');
         }
@@ -101,7 +101,7 @@ class LocalFileDestinationProvider {
         const entryStream = (0, utils_1.createTarEntryStream)(__classPrivateFieldGet(this, _LocalFileDestinationProvider_archive, "f").stream, filePathFactory, this.options.file.maxSizeJsonl);
         return (0, stream_chain_1.chain)([(0, Stringer_1.stringer)(), entryStream]);
     }
-    getConfigurationStream() {
+    createConfigurationWriteStream() {
         if (!__classPrivateFieldGet(this, _LocalFileDestinationProvider_archive, "f").stream) {
             throw new Error('Archive stream is unavailable');
         }
@@ -109,7 +109,7 @@ class LocalFileDestinationProvider {
         const entryStream = (0, utils_1.createTarEntryStream)(__classPrivateFieldGet(this, _LocalFileDestinationProvider_archive, "f").stream, filePathFactory, this.options.file.maxSizeJsonl);
         return (0, stream_chain_1.chain)([(0, Stringer_1.stringer)(), entryStream]);
     }
-    getAssetsStream() {
+    createAssetsWriteStream() {
         const { stream: archiveStream } = __classPrivateFieldGet(this, _LocalFileDestinationProvider_archive, "f");
         if (!archiveStream) {
             throw new Error('Archive stream is unavailable');

package/lib/file/providers/index.d.ts

@@ -0,0 +1,2 @@
+export * from './source';
+export * from './destination';

package/{dist → lib/file}/providers/index.js

@@ -14,10 +14,6 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-// source providers
-__exportStar(require("./local-file-source-provider"), exports);
-__exportStar(require("./local-strapi-source-provider"), exports);
-// destination providers
-__exportStar(require("./local-file-destination-provider"), exports);
-__exportStar(require("./local-strapi-destination-provider"), exports);
+__exportStar(require("./source"), exports);
+__exportStar(require("./destination"), exports);
 //# sourceMappingURL=index.js.map

package/{dist/providers/local-file-source-provider → lib/file/providers/source}/index.d.ts

@@ -1,7 +1,8 @@
 /// <reference types="lodash" />
 /// <reference types="node" />
 import type { Readable } from 'stream';
-import type { IMetadata, ISourceProvider, ProviderType } from '../../../types';
+import type { Schema } from '@strapi/strapi';
+import type { IMetadata, ISourceProvider, ProviderType } from '../../../../types';
 /**
  * Provider options
  */
@@ -25,15 +26,15 @@ declare class LocalFileSourceProvider implements ISourceProvider {
     options: ILocalFileSourceProviderOptions;
     constructor(options: ILocalFileSourceProviderOptions);
     /**
-     * Pre flight checks regarding the provided options (making sure that the provided path is correct, etc...)
+     * Pre flight checks regarding the provided options, making sure that the file can be opened (decrypted, decompressed), etc.
      */
     bootstrap(): Promise<void>;
     getMetadata(): Promise<IMetadata>;
-    getSchemas(): Promise<import("lodash").Dictionary<unknown>>;
-    streamEntities(): Readable;
-    streamSchemas(): Readable;
-    streamLinks(): Readable;
-    streamConfiguration(): Readable;
-    streamAssets(): Readable | Promise<Readable>;
+    getSchemas(): Promise<import("lodash").Dictionary<Schema>>;
+    createEntitiesReadStream(): Readable;
+    createSchemasReadStream(): Readable;
+    createLinksReadStream(): Readable;
+    createConfigurationReadStream(): Readable;
+    createAssetsReadStream(): Readable | Promise<Readable>;
 }
 export {};

package/{dist/providers/local-file-source-provider → lib/file/providers/source}/index.js

@@ -1,26 +1,9 @@
 "use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
+var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
+    if (kind === "m") throw new TypeError("Private method is not writable");
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
+    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
 };
 var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
     if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
@@ -30,7 +13,7 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
-var _LocalFileSourceProvider_instances, _LocalFileSourceProvider_getBackupStream, _LocalFileSourceProvider_streamJsonlDirectory, _LocalFileSourceProvider_parseJSONFile;
+var _LocalFileSourceProvider_instances, _LocalFileSourceProvider_metadata, _LocalFileSourceProvider_getBackupStream, _LocalFileSourceProvider_streamJsonlDirectory, _LocalFileSourceProvider_parseJSONFile;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createLocalFileSourceProvider = void 0;
 const fs_extra_1 = __importDefault(require("fs-extra"));
@@ -41,8 +24,8 @@ const fp_1 = require("lodash/fp");
 const stream_chain_1 = require("stream-chain");
 const stream_1 = require("stream");
 const Parser_1 = require("stream-json/jsonl/Parser");
-const encryption_1 = require("../../encryption");
-const utils = __importStar(require("../../utils"));
+const encryption_1 = require("../../../utils/encryption");
+const stream_2 = require("../../../utils/stream");
 /**
  * Constant for the metadata file path
  */
@@ -56,6 +39,7 @@ class LocalFileSourceProvider {
         _LocalFileSourceProvider_instances.add(this);
         this.type = 'source';
         this.name = 'source::local-file';
+        _LocalFileSourceProvider_metadata.set(this, void 0);
         this.options = options;
         const { encryption } = this.options;
         if (encryption.enabled && encryption.key === undefined) {
@@ -63,16 +47,16 @@ class LocalFileSourceProvider {
         }
     }
     /**
-     * Pre flight checks regarding the provided options (making sure that the provided path is correct, etc...)
+     * Pre flight checks regarding the provided options, making sure that the file can be opened (decrypted, decompressed), etc.
      */
     async bootstrap() {
         const { path: filePath } = this.options.file;
         try {
-            // This is only to show a nicer error, it doesn't ensure the file will still exist when we try to open it later
-            await fs_extra_1.default.access(filePath, fs_extra_1.default.constants.R_OK);
+            // Read the metadata to ensure the file can be parsed
+            __classPrivateFieldSet(this, _LocalFileSourceProvider_metadata, await this.getMetadata(), "f");
         }
         catch (e) {
-            throw new Error(`Can't access file "${filePath}".`);
+            throw new Error(`Can't read file "${filePath}".`);
         }
     }
     getMetadata() {
@@ -82,23 +66,23 @@ class LocalFileSourceProvider {
         return __classPrivateFieldGet(this, _LocalFileSourceProvider_instances, "m", _LocalFileSourceProvider_parseJSONFile).call(this, backupStream, METADATA_FILE_PATH);
     }
     async getSchemas() {
-        const schemas = await utils.stream.collect(this.streamSchemas());
+        const schemas = await (0, stream_2.collect)(this.createSchemasReadStream());
         return (0, fp_1.keyBy)('uid', schemas);
     }
-    streamEntities() {
+    createEntitiesReadStream() {
         return __classPrivateFieldGet(this, _LocalFileSourceProvider_instances, "m", _LocalFileSourceProvider_streamJsonlDirectory).call(this, 'entities');
     }
-    streamSchemas() {
+    createSchemasReadStream() {
         return __classPrivateFieldGet(this, _LocalFileSourceProvider_instances, "m", _LocalFileSourceProvider_streamJsonlDirectory).call(this, 'schemas');
     }
-    streamLinks() {
+    createLinksReadStream() {
         return __classPrivateFieldGet(this, _LocalFileSourceProvider_instances, "m", _LocalFileSourceProvider_streamJsonlDirectory).call(this, 'links');
     }
-    streamConfiguration() {
+    createConfigurationReadStream() {
         // NOTE: TBD
         return __classPrivateFieldGet(this, _LocalFileSourceProvider_instances, "m", _LocalFileSourceProvider_streamJsonlDirectory).call(this, 'configuration');
     }
-    streamAssets() {
+    createAssetsReadStream() {
         const inStream = __classPrivateFieldGet(this, _LocalFileSourceProvider_instances, "m", _LocalFileSourceProvider_getBackupStream).call(this);
         const outStream = new stream_1.PassThrough({ objectMode: true });
         (0, stream_1.pipeline)([
@@ -127,7 +111,7 @@ class LocalFileSourceProvider {
         return outStream;
     }
 }
-_LocalFileSourceProvider_instances = new WeakSet(), _LocalFileSourceProvider_getBackupStream = function _LocalFileSourceProvider_getBackupStream() {
+_LocalFileSourceProvider_metadata = new WeakMap(), _LocalFileSourceProvider_instances = new WeakSet(), _LocalFileSourceProvider_getBackupStream = function _LocalFileSourceProvider_getBackupStream() {
     const { file, encryption, compression } = this.options;
     const streams = [];
     try {
@@ -193,18 +177,22 @@ _LocalFileSourceProvider_instances = new WeakSet(), _LocalFileSourceProvider_get
                 filter(entryPath, entry) {
                     return entryPath === filePath && entry.type === 'File';
                 },
-                /**
-                 * Whenever an entry passes the filter method, process it
-                 */
                 async onentry(entry) {
                     // Collect all the content of the entry file
                     const content = await entry.collect();
-                    // Parse from buffer to string to JSON
-                    const parsedContent = JSON.parse(content.toString());
-                    // Resolve the Promise with the parsed content
-                    resolve(parsedContent);
-                    // Cleanup (close the stream associated to the entry)
-                    entry.destroy();
+                    try {
+                        // Parse from buffer to string to JSON
+                        const parsedContent = JSON.parse(content.toString());
+                        // Resolve the Promise with the parsed content
+                        resolve(parsedContent);
+                    }
+                    catch (e) {
+                        reject(e);
+                    }
+                    finally {
+                        // Cleanup (close the stream associated to the entry)
+                        entry.destroy();
+                    }
                 },
             }),
         ], () => {

package/lib/index.d.ts

@@ -0,0 +1,4 @@
+export * as engine from './engine';
+export * as strapi from './strapi';
+export * as file from './file';
+export * as utils from './utils';

package/lib/index.js

@@ -0,0 +1,31 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.utils = exports.file = exports.strapi = exports.engine = void 0;
+exports.engine = __importStar(require("./engine"));
+exports.strapi = __importStar(require("./strapi"));
+exports.file = __importStar(require("./file"));
+exports.utils = __importStar(require("./utils"));
+//# sourceMappingURL=index.js.map

package/lib/strapi/index.d.ts

@@ -0,0 +1,4 @@
+export * as providers from './providers';
+export * as queries from './queries';
+export * as remote from './remote';
+export { default as register } from './register';