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

package/lib/strapi/remote/index.js

@@ -0,0 +1,30 @@
+"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.constants = exports.routes = exports.controllers = void 0;
+exports.controllers = __importStar(require("./controllers"));
+exports.routes = __importStar(require("./routes"));
+exports.constants = __importStar(require("./constants"));
+//# sourceMappingURL=index.js.map

package/lib/strapi/remote/routes.d.ts

@@ -0,0 +1,21 @@
+import type { Context } from 'koa';
+declare module '@strapi/strapi' {
+    interface Strapi {
+        admin: {
+            routes: {
+                method: string;
+                path: string;
+                handler: (ctx: Context) => Promise<void>;
+                config: unknown;
+            }[];
+        };
+    }
+}
+/**
+ * Register a transfer route in the Strapi admin router.
+ *
+ * It exposes a WS server that can be used to run and manage transfer processes.
+ *
+ * @param strapi - A Strapi instance
+ */
+export declare const registerAdminTransferRoute: (strapi: Strapi.Strapi) => void;

package/lib/strapi/remote/routes.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.registerAdminTransferRoute = void 0;
+const constants_1 = require("./constants");
+const handlers_1 = require("./handlers");
+/**
+ * Register a transfer route in the Strapi admin router.
+ *
+ * It exposes a WS server that can be used to run and manage transfer processes.
+ *
+ * @param strapi - A Strapi instance
+ */
+const registerAdminTransferRoute = (strapi) => {
+    strapi.admin.routes.push({
+        method: 'GET',
+        path: constants_1.TRANSFER_PATH,
+        handler: (0, handlers_1.createTransferHandler)(),
+        config: { auth: false },
+    });
+};
+exports.registerAdminTransferRoute = registerAdminTransferRoute;
+//# sourceMappingURL=routes.js.map

package/lib/utils/encryption/decrypt.d.ts

@@ -0,0 +1,11 @@
+import { Cipher } from 'crypto';
+import { Algorithm } from '../../../types';
+/**
+ * It creates a cipher instance used for decryption
+ *
+ * @param key - The decryption key
+ * @param algorithm - The algorithm to use to create the Cipher
+ *
+ * @returns A {@link Cipher} instance created with the given key & algorithm
+ */
+export declare const createDecryptionCipher: (key: string, algorithm?: Algorithm) => Cipher;

package/{dist → lib/utils}/encryption/decrypt.js

@@ -32,6 +32,14 @@ const getDecryptionStrategy = (algorithm) => {
     };
     return strategies[algorithm];
 };
+/**
+ * It creates a cipher instance used for decryption
+ *
+ * @param key - The decryption key
+ * @param algorithm - The algorithm to use to create the Cipher
+ *
+ * @returns A {@link Cipher} instance created with the given key & algorithm
+ */
 const createDecryptionCipher = (key, algorithm = 'aes-128-ecb') => {
     return getDecryptionStrategy(algorithm)(key);
 };

package/lib/utils/encryption/encrypt.d.ts

@@ -0,0 +1,11 @@
+import { Cipher } from 'crypto';
+import { Algorithm } from '../../../types';
+/**
+ * It creates a cipher instance used for encryption
+ *
+ * @param key - The encryption key
+ * @param algorithm - The algorithm to use to create the Cipher
+ *
+ * @returns A {@link Cipher} instance created with the given key & algorithm
+ */
+export declare const createEncryptionCipher: (key: string, algorithm?: Algorithm) => Cipher;

package/{dist → lib/utils}/encryption/encrypt.js

@@ -32,6 +32,14 @@ const getEncryptionStrategy = (algorithm) => {
     };
     return strategies[algorithm];
 };
+/**
+ * It creates a cipher instance used for encryption
+ *
+ * @param key - The encryption key
+ * @param algorithm - The algorithm to use to create the Cipher
+ *
+ * @returns A {@link Cipher} instance created with the given key & algorithm
+ */
 const createEncryptionCipher = (key, algorithm = 'aes-128-ecb') => {
     return getEncryptionStrategy(algorithm)(key);
 };

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

@@ -1,3 +1,4 @@
+export * as encryption from './encryption';
 export * as stream from './stream';
 export * as json from './json';
 export * as schema from './schema';

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

@@ -23,7 +23,8 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.schema = exports.json = exports.stream = void 0;
+exports.schema = exports.json = exports.stream = exports.encryption = void 0;
+exports.encryption = __importStar(require("./encryption"));
 exports.stream = __importStar(require("./stream"));
 exports.json = __importStar(require("./json"));
 exports.schema = __importStar(require("./schema"));

package/{dist → lib}/utils/json.d.ts

@@ -1,3 +1,10 @@
+/**
+ * Compute differences between two JSON objects and returns them
+ *
+ * @param a - First object
+ * @param b - Second object
+ * @param ctx - Context used to keep track of the current path during recursion
+ */
 export declare const diff: (a: unknown, b: unknown, ctx?: Context) => Diff[];
 export interface AddedDiff<T = unknown> {
     kind: 'added';

package/{dist → lib}/utils/json.js

@@ -3,6 +3,13 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.diff = void 0;
 const fp_1 = require("lodash/fp");
 const createContext = () => ({ path: [] });
+/**
+ * Compute differences between two JSON objects and returns them
+ *
+ * @param a - First object
+ * @param b - Second object
+ * @param ctx - Context used to keep track of the current path during recursion
+ */
 const diff = (a, b, ctx = createContext()) => {
     const diffs = [];
     const { path } = ctx;
@@ -53,7 +60,7 @@ const diff = (a, b, ctx = createContext()) => {
         return diffs;
     }
     if (!(0, fp_1.isEqual)(a, b)) {
-        modified();
+        return modified();
     }
     return diffs;
 };

package/{dist → lib}/utils/schema.d.ts

@@ -1,3 +1,7 @@
 /// <reference types="lodash" />
 import type { Schema } from '@strapi/strapi';
+/**
+ * Sanitize a schemas dictionnary by omiting unwanted properties
+ * The list of allowed properties can be found here: {@link VALID_SCHEMA_PROPERTIES}
+ */
 export declare const mapSchemasValues: (schemas: Record<string, Schema>) => import("lodash").Dictionary<Partial<Schema>>;

package/{dist → lib}/utils/schema.js

@@ -2,7 +2,10 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.mapSchemasValues = void 0;
 const fp_1 = require("lodash/fp");
-const schemaSelectedKeys = [
+/**
+ * List of schema properties that should be kept when sanitizing schemas
+ */
+const VALID_SCHEMA_PROPERTIES = [
     'collectionName',
     'info',
     'options',
@@ -15,8 +18,12 @@ const schemaSelectedKeys = [
     'plugin',
     'globalId',
 ];
+/**
+ * Sanitize a schemas dictionnary by omiting unwanted properties
+ * The list of allowed properties can be found here: {@link VALID_SCHEMA_PROPERTIES}
+ */
 const mapSchemasValues = (schemas) => {
-    return (0, fp_1.mapValues)((0, fp_1.pick)(schemaSelectedKeys), schemas);
+    return (0, fp_1.mapValues)((0, fp_1.pick)(VALID_SCHEMA_PROPERTIES), schemas);
 };
 exports.mapSchemasValues = mapSchemasValues;
 //# sourceMappingURL=schema.js.map

package/lib/utils/stream.d.ts

@@ -0,0 +1,27 @@
+/// <reference types="node" />
+import { Transform, Readable } from 'stream';
+declare type TransformOptions = ConstructorParameters<typeof Transform>[0];
+/**
+ * Create a filter stream that discard chunks which doesn't satisfies the given predicate
+ *
+ * @param predicate - A filter predicate, takes a stream data chunk as parameter and returns a boolean value
+ * @param options - Transform stream options
+ */
+export declare const filter: <T>(predicate: (value: T) => boolean | Promise<boolean>, options?: TransformOptions) => Transform;
+/**
+ * Create a map stream that transform chunks using the given predicate
+ *
+ * @param predicate - A map predicate, takes a stream data chunk as parameter and returns a mapped value
+ * @param options - Transform stream options
+ */
+export declare const map: <T, U = T>(predicate: (value: T) => U | Promise<U>, options?: TransformOptions) => Transform;
+/**
+ * Collect every chunks from a Readable stream.
+ *
+ * @param stream - The redable stream to collect data from
+ * @param options.destroy - If set to true, it automatically calls `destroy()` on the given stream upon receiving the 'end' event
+ */
+export declare const collect: <T = unknown>(stream: Readable, options?: {
+    destroy: boolean;
+}) => Promise<T[]>;
+export {};

package/lib/utils/stream.js

@@ -0,0 +1,59 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.collect = exports.map = exports.filter = void 0;
+const stream_1 = require("stream");
+/**
+ * Create a filter stream that discard chunks which doesn't satisfies the given predicate
+ *
+ * @param predicate - A filter predicate, takes a stream data chunk as parameter and returns a boolean value
+ * @param options - Transform stream options
+ */
+const filter = (predicate, options = { objectMode: true }) => {
+    return new stream_1.Transform({
+        ...options,
+        async transform(chunk, _encoding, callback) {
+            const keep = await predicate(chunk);
+            callback(null, keep ? chunk : undefined);
+        },
+    });
+};
+exports.filter = filter;
+/**
+ * Create a map stream that transform chunks using the given predicate
+ *
+ * @param predicate - A map predicate, takes a stream data chunk as parameter and returns a mapped value
+ * @param options - Transform stream options
+ */
+const map = (predicate, options = { objectMode: true }) => {
+    return new stream_1.Transform({
+        ...options,
+        async transform(chunk, _encoding, callback) {
+            const mappedValue = await predicate(chunk);
+            callback(null, mappedValue);
+        },
+    });
+};
+exports.map = map;
+/**
+ * Collect every chunks from a Readable stream.
+ *
+ * @param stream - The redable stream to collect data from
+ * @param options.destroy - If set to true, it automatically calls `destroy()` on the given stream upon receiving the 'end' event
+ */
+const collect = (stream, options = { destroy: true }) => {
+    const chunks = [];
+    return new Promise((resolve, reject) => {
+        stream
+            .on('close', () => resolve(chunks))
+            .on('error', reject)
+            .on('data', (chunk) => chunks.push(chunk))
+            .on('end', () => {
+            if (options.destroy) {
+                stream.destroy();
+            }
+            resolve(chunks);
+        });
+    });
+};
+exports.collect = collect;
+//# sourceMappingURL=stream.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@strapi/data-transfer",
-  "version": "4.6.0-beta.1",
+  "version": "4.6.0-beta.2",
   "description": "Data transfer capabilities for Strapi",
   "keywords": [
     "strapi",
@@ -24,21 +24,23 @@
       "url": "https://strapi.io"
     }
   ],
-  "main": "./dist/index.js",
-  "types": "./dist/index.d.ts",
+  "main": "./lib/index.js",
+  "types": "./lib/index.d.ts",
   "scripts": {
-    "build": "tsc -p tsconfig.json",
-    "clean": "rimraf ./dist",
+    "build": "yarn build:ts",
+    "build:ts": "tsc -p tsconfig.json",
     "build:clean": "yarn clean && yarn build",
-    "watch": "yarn build -w",
-    "test:unit": "jest --verbose"
+    "clean": "rimraf ./dist",
+    "prepublishOnly": "yarn build:clean",
+    "test:unit": "jest --verbose",
+    "watch": "yarn build:ts -w --preserveWatchOutput"
   },
   "directories": {
-    "lib": "./dist"
+    "lib": "./lib"
   },
   "dependencies": {
-    "@strapi/logger": "4.6.0-beta.1",
-    "@strapi/strapi": "4.6.0-beta.1",
+    "@strapi/logger": "4.6.0-beta.2",
+    "@strapi/strapi": "4.6.0-beta.2",
     "chalk": "4.1.2",
     "fs-extra": "10.0.0",
     "lodash": "4.17.21",
@@ -47,17 +49,22 @@
     "stream-chain": "2.2.5",
     "stream-json": "1.7.4",
     "tar": "6.1.12",
-    "tar-stream": "2.2.0"
+    "tar-stream": "2.2.0",
+    "uuid": "9.0.0",
+    "ws": "8.11.0"
   },
   "devDependencies": {
     "@tsconfig/node16": "1.0.3",
     "@types/fs-extra": "9.0.13",
     "@types/jest": "29.2.0",
+    "@types/koa": "2.13.4",
     "@types/semver": "7.3.13",
     "@types/stream-chain": "2.0.1",
     "@types/stream-json": "1.7.2",
     "@types/tar": "6.1.3",
     "@types/tar-stream": "2.2.2",
+    "@types/uuid": "9.0.0",
+    "koa": "2.13.4",
     "rimraf": "3.0.2",
     "typescript": "4.6.2"
   },
@@ -65,5 +72,5 @@
     "node": ">=14.19.1 <=18.x.x",
     "npm": ">=6.0.0"
   },
-  "gitHead": "2c0bcabdf0bf2a269fed50c6f23ba777845968a0"
+  "gitHead": "b852090f931cd21868c4016f24db2f9fdfc7a7ab"
 }

package/dist/encryption/decrypt.d.ts

@@ -1,3 +0,0 @@
-import { Cipher } from 'crypto';
-import { Algorithm } from '../../types';
-export declare const createDecryptionCipher: (key: string, algorithm?: Algorithm) => Cipher;

package/dist/encryption/encrypt.d.ts

@@ -1,3 +0,0 @@
-import { Cipher } from 'crypto';
-import { Algorithm } from '../../types';
-export declare const createEncryptionCipher: (key: string, algorithm?: Algorithm) => Cipher;

package/dist/index.d.ts

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

package/dist/providers/index.d.ts

@@ -1,4 +0,0 @@
-export * from './local-file-source-provider';
-export * from './local-strapi-source-provider';
-export * from './local-file-destination-provider';
-export * from './local-strapi-destination-provider';

package/dist/providers/shared/index.d.ts

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

package/dist/providers/test-utils/index.d.ts

@@ -1,111 +0,0 @@
-/// <reference types="node" />
-/// <reference types="jest" />
-import { Readable } from 'stream';
-/**
- * Collect every entity in a Readable stream
- */
-export declare const collect: <T = unknown>(stream: Readable) => Promise<T[]>;
-/**
- * Create a "Strapi" like object factory based on the
- * given params and cast it to the correct type
- */
-export declare const getStrapiFactory: <T extends {
-    readonly EE?: unknown;
-    readonly config?: unknown;
-    readonly auth?: unknown;
-    readonly contentAPI?: unknown;
-    readonly sanitizers?: unknown;
-    readonly services?: unknown;
-    service?: unknown;
-    readonly controllers?: unknown;
-    controller?: unknown;
-    readonly contentTypes?: unknown;
-    contentType?: unknown;
-    readonly components?: unknown;
-    readonly customFields?: unknown;
-    readonly policies?: unknown;
-    policy?: unknown;
-    readonly middlewares?: unknown;
-    middleware?: unknown;
-    readonly plugins?: unknown;
-    plugin?: unknown;
-    readonly hooks?: unknown;
-    hook?: unknown;
-    readonly api?: unknown;
-    register?: unknown;
-    bootstrap?: unknown;
-    destroy?: unknown;
-    runLifecyclesFunctions?: unknown;
-    start?: unknown;
-    stopWithError?: unknown;
-    stop?: unknown;
-    load?: unknown;
-    reload?: unknown;
-    startWebhooks?: unknown;
-    postListen?: unknown;
-    listen?: unknown;
-    openAdmin?: unknown;
-    loadAdmin?: unknown;
-    loadPlugins?: unknown;
-    loadPolicies?: unknown;
-    loadAPIs?: unknown;
-    loadComponents?: unknown;
-    loadMiddlewares?: unknown;
-    loadApp?: unknown;
-    registerInternalHooks?: unknown;
-    getModel?: unknown;
-    query?: unknown;
-    container?: unknown;
-    dirs?: unknown;
-    isLoaded?: unknown;
-    server?: unknown;
-    fs?: unknown;
-    eventHub?: unknown;
-    startupLogger?: unknown;
-    log?: unknown;
-    cron?: unknown;
-    telemetry?: unknown;
-    db?: unknown;
-    store?: unknown;
-    entityValidator?: unknown;
-    entityService?: unknown;
-}>(properties?: T | undefined) => () => import("@strapi/strapi").Strapi;
-/**
- * Union type used to represent the default content types available
- */
-export declare type ContentType = 'foo' | 'bar';
-/**
- * Factory to get default content types test values
- */
-export declare const getContentTypes: () => {
-    foo: {
-        uid: "foo";
-        attributes: {
-            [attribute: string]: unknown;
-        };
-    };
-    bar: {
-        uid: "bar";
-        attributes: {
-            [attribute: string]: unknown;
-        };
-    };
-};
-/**
- * Create a factory of readable streams (wrapped with a jest mock function)
- */
-export declare const createMockedReadableFactory: <T extends string = ContentType>(source: { [ct in T]: {
-    [key: string]: unknown;
-    id: number;
-}[]; }) => jest.Mock<Readable, [uid: T]>;
-/**
- * Create a factory of mocked query builders
- */
-export declare const createMockedQueryBuilder: <T extends string = ContentType>(data: { [key in T]: unknown[]; }) => jest.Mock<{
-    populate(populate: unknown): any;
-    stream(): Readable;
-}, [uid: T]>;
-/**
- * Update the global store with the given strapi value
- */
-export declare const setGlobalStrapi: (strapi: Strapi.Strapi) => void;

package/dist/providers/test-utils/index.js

@@ -1,64 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.setGlobalStrapi = exports.createMockedQueryBuilder = exports.createMockedReadableFactory = exports.getContentTypes = exports.getStrapiFactory = exports.collect = void 0;
-const stream_1 = require("stream");
-/**
- * Collect every entity in a Readable stream
- */
-const collect = (stream) => {
-    const chunks = [];
-    return new Promise((resolve, reject) => {
-        stream
-            .on('data', (chunk) => chunks.push(chunk))
-            .on('close', () => resolve(chunks))
-            .on('error', reject);
-    });
-};
-exports.collect = collect;
-/**
- * Create a "Strapi" like object factory based on the
- * given params and cast it to the correct type
- */
-const getStrapiFactory = (properties) => () => {
-    return { ...properties };
-};
-exports.getStrapiFactory = getStrapiFactory;
-/**
- * Factory to get default content types test values
- */
-const getContentTypes = () => ({
-    foo: { uid: 'foo', attributes: { title: { type: 'string' } } },
-    bar: { uid: 'bar', attributes: { age: { type: 'number' } } },
-});
-exports.getContentTypes = getContentTypes;
-/**
- * Create a factory of readable streams (wrapped with a jest mock function)
- */
-const createMockedReadableFactory = (source) => jest.fn((uid) => {
-    return stream_1.Readable.from(source[uid] || []);
-});
-exports.createMockedReadableFactory = createMockedReadableFactory;
-/**
- * Create a factory of mocked query builders
- */
-const createMockedQueryBuilder = (data) => jest.fn((uid) => {
-    const state = { populate: undefined };
-    return {
-        populate(populate) {
-            state.populate = populate;
-            return this;
-        },
-        stream() {
-            return stream_1.Readable.from(data[uid]);
-        },
-    };
-});
-exports.createMockedQueryBuilder = createMockedQueryBuilder;
-/**
- * Update the global store with the given strapi value
- */
-const setGlobalStrapi = (strapi) => {
-    global.strapi = strapi;
-};
-exports.setGlobalStrapi = setGlobalStrapi;
-//# sourceMappingURL=index.js.map

package/dist/utils/stream.d.ts

@@ -1,10 +0,0 @@
-/// <reference types="node" />
-import { Transform, Readable } from 'stream';
-declare type TransformOptions = ConstructorParameters<typeof Transform>[0];
-export declare const filter: <T>(predicate: (value: T) => boolean | Promise<boolean>, options?: TransformOptions) => Transform;
-export declare const map: <T>(predicate: (value: T) => T | Promise<T>, options?: TransformOptions) => Transform;
-/**
- * Collect every entity in a Readable stream
- */
-export declare const collect: <T = unknown>(stream: Readable) => Promise<T[]>;
-export {};

package/dist/utils/stream.js

@@ -1,39 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.collect = exports.map = exports.filter = void 0;
-const stream_1 = require("stream");
-const filter = (predicate, options = { objectMode: true }) => {
-    return new stream_1.Transform({
-        ...options,
-        async transform(chunk, _encoding, callback) {
-            const keep = await predicate(chunk);
-            callback(null, keep ? chunk : undefined);
-        },
-    });
-};
-exports.filter = filter;
-const map = (predicate, options = { objectMode: true }) => {
-    return new stream_1.Transform({
-        ...options,
-        async transform(chunk, _encoding, callback) {
-            const mappedValue = await predicate(chunk);
-            callback(null, mappedValue);
-        },
-    });
-};
-exports.map = map;
-/**
- * Collect every entity in a Readable stream
- */
-const collect = (stream) => {
-    const chunks = [];
-    return new Promise((resolve) => {
-        stream.on('data', (chunk) => chunks.push(chunk));
-        stream.on('end', () => {
-            stream.destroy();
-            resolve(chunks);
-        });
-    });
-};
-exports.collect = collect;
-//# sourceMappingURL=stream.js.map