sb-mig 5.5.4-beta.1 → 5.6.0-beta.1

package/dist/api/data-migration/component-data-migration.d.ts

@@ -7,11 +7,15 @@ interface MigrateItems {
     migrateFrom: MigrateFrom;
     migrationConfig: string;
     componentsToMigrate: string[];
+    filters?: {
+        withSlug?: string[];
+        startsWith?: string;
+    };
 }
 export type MapperDefinition = (data: any) => any;
 export declare const prepareStoriesFromLocalFile: ({ from }: any) => any;
 export declare const prepareMigrationConfig: ({ migrationConfig }: any) => any;
-export declare const migrateAllComponentsDataInStories: ({ itemType, migrationConfig, migrateFrom, from, to, }: Omit<MigrateItems, "componentsToMigrate">, config: RequestBaseConfig) => Promise<void>;
+export declare const migrateAllComponentsDataInStories: ({ itemType, migrationConfig, migrateFrom, from, to, filters, }: Omit<MigrateItems, "componentsToMigrate">, config: RequestBaseConfig) => Promise<void>;
 export declare const doTheMigration: ({ itemType, from, itemsToMigrate, componentsToMigrate, migrationConfigFileContent, migrationConfig, to, }: any, config: RequestBaseConfig) => Promise<void>;
-export declare const migrateProvidedComponentsDataInStories: ({ itemType, migrationConfig, migrateFrom, from, to, componentsToMigrate, }: MigrateItems, config: RequestBaseConfig) => Promise<void>;
+export declare const migrateProvidedComponentsDataInStories: ({ itemType, migrationConfig, migrateFrom, from, to, componentsToMigrate, filters, }: MigrateItems, config: RequestBaseConfig) => Promise<void>;
 export {};

package/dist/api/data-migration/component-data-migration.js

@@ -101,7 +101,7 @@ export const prepareMigrationConfig = ({ migrationConfig }) => {
     Logger.success(`Migration config loaded.`);
     return migrationConfigFileContent;
 };
-export const migrateAllComponentsDataInStories = async ({ itemType, migrationConfig, migrateFrom, from, to, }, config) => {
+export const migrateAllComponentsDataInStories = async ({ itemType, migrationConfig, migrateFrom, from, to, filters, }, config) => {
     Logger.warning(`Trying to migrate all ${itemType} from ${migrateFrom}, ${from} to ${to}...`);
     const migrationConfigFileContent = prepareMigrationConfig({
         migrationConfig,
@@ -119,6 +119,7 @@ export const migrateAllComponentsDataInStories = async ({ itemType, migrationCon
         from,
         to,
         componentsToMigrate,
+        filters,
     }, config);
 };
 export const doTheMigration = async ({ itemType = "story", from, itemsToMigrate, componentsToMigrate, migrationConfigFileContent, migrationConfig, to, }, config) => {
@@ -128,9 +129,10 @@ export const doTheMigration = async ({ itemType = "story", from, itemsToMigrate,
         if (storyblokConfig.debug) {
             Logger.success(`#   ${index}   #`);
         }
-        const json = itemType === "story" ? item[itemType].content : item[itemType];
+        let json = itemType === "story" ? item[itemType].content : item[itemType];
+        const rootWrapper = { root: json };
         const maxDepth = replaceComponentData({
-            parent: { root: json },
+            parent: rootWrapper,
             key: "root",
             components: componentsToMigrate,
             mapper: migrationConfigFileContent,
@@ -138,6 +140,8 @@ export const doTheMigration = async ({ itemType = "story", from, itemsToMigrate,
             maxDepth: 0,
             sumOfReplacing,
         });
+        // After replacement, take potentially new root (root may be reassigned inside)
+        json = rootWrapper.root;
         arrayOfMaxDepths.push(maxDepth);
         if (Object.keys(sumOfReplacing).length > 0) {
             console.log("  ");
@@ -220,14 +224,17 @@ const saveBackupToFile = async ({ itemType, res, folder, filename }, config) =>
         res: res,
     }, config);
 };
-export const migrateProvidedComponentsDataInStories = async ({ itemType, migrationConfig, migrateFrom, from, to, componentsToMigrate, }, config) => {
+export const migrateProvidedComponentsDataInStories = async ({ itemType, migrationConfig, migrateFrom, from, to, componentsToMigrate, filters, }, config) => {
     const migrationConfigFileContent = prepareMigrationConfig({
         migrationConfig,
     });
     if (migrateFrom === "file") {
         Logger.log("Migrating using file....");
         // Get all stories to be migrated from file
-        const itemsToMigrate = prepareStoriesFromLocalFile({ from });
+        const itemsFromFile = prepareStoriesFromLocalFile({ from });
+        const itemsToMigrate = Array.isArray(itemsFromFile)
+            ? itemsFromFile.filter((it) => !(it?.story?.is_folder === true))
+            : itemsFromFile;
         await doTheMigration({
             itemsToMigrate,
             componentsToMigrate,
@@ -239,10 +246,27 @@ export const migrateProvidedComponentsDataInStories = async ({ itemType, migrati
         // Get all stories to be migrated from storyblok space
         let itemsToMigrate = [];
         if (itemType === "story") {
-            itemsToMigrate = await managementApi.stories.getAllStories({}, {
-                ...config,
-                spaceId: from,
-            });
+            if (filters?.withSlug && filters.withSlug.length > 0) {
+                const results = await Promise.all(filters.withSlug.map((slug) => managementApi.stories.getStoryBySlug(slug, {
+                    ...config,
+                    spaceId: from,
+                })));
+                itemsToMigrate = results.filter(Boolean).filter((it) => !(it?.story?.is_folder === true));
+            }
+            else if (filters?.startsWith) {
+                itemsToMigrate = await managementApi.stories.getAllStories({ options: { starts_with: filters.startsWith } }, {
+                    ...config,
+                    spaceId: from,
+                });
+                itemsToMigrate = itemsToMigrate.filter((it) => !(it?.story?.is_folder === true));
+            }
+            else {
+                itemsToMigrate = await managementApi.stories.getAllStories({}, {
+                    ...config,
+                    spaceId: from,
+                });
+                itemsToMigrate = itemsToMigrate.filter((it) => !(it?.story?.is_folder === true));
+            }
         }
         else if (itemType === "preset") {
             itemsToMigrate = await managementApi.presets.getAllPresets({

package/dist/api/stories/stories.js

@@ -116,8 +116,8 @@ export const updateStory = (content, storyId, options, config) => {
     const { spaceId, sbApi } = config;
     Logger.warning("Trying to update Story...");
     Logger.log(`Updating story with name: ${content.name} in space: ${spaceId}`);
-    console.log("THis is content to update: ");
-    console.log(JSON.stringify(content, null, 2));
+    // console.log("THis is content to update: ");
+    // console.log(JSON.stringify(content, null, 2));
     return sbApi
         .put(`spaces/${spaceId}/stories/${storyId}`, {
         story: content,

package/dist/cli/cli-descriptions.d.ts

@@ -1,7 +1,7 @@
 export declare const mainDescription = "\n    USAGE\n      $ sb-mig [command]\n    \n    COMMANDS\n        sync      Synchronize components, datasources, roles, stories, assets with Storyblok space.\n        discover  Discover components and write to file or stdout.\n        backup    Command for backing up anything related to Storyblok\n        migrate   Migrate content from space to space, or from file to space.\n        debug     Output extra debugging information\n        help      This screen\n    \n    Examples\n      $ sb-mig sync components --all\n      $ sb-mig debug  \n";
 export declare const syncDescription = "\n    Usage\n        $ sb-mig sync [components|roles|datasources|plugins|content] [space separated file names] or --all\n        \n    Description\n        Synchronize components, roles, datasources, plugins, content with Storyblok space.\n        \n    COMMANDS\n        components      - sync components\n        roles           - sync roles\n        datasources     - sync datasources\n        plugins         - sync plugins\n        content         - sync content (stories, assets) - ! right now destructive, it will move content from 1 space to another, completelly overwriting it\n     \n    FLAGS\n        --all           - Sync all components, roles, datasources                            [components, roles, datasources]\n        --presets       - Pass it, if u want to sync also with presets (will take longer)    [components only]\n        \n        --yes           - Skip ask for confirmation (dangerous, but useful in CI/CD)         [content only]\n        --from          - Space ID from which you want to sync content                       [content only]\n        --to            - Space ID to which you want to sync content                         [content only]\n        --syncDirection [fromSpaceToFile|fromFileToSpace|fromSpaceToSpace|fromAWStoSpace]               \n                        - Sync direction (from, to)                                          [content only]\n    \n    EXAMPLES\n        $ sb-mig sync components --all\n        $ sb-mig sync components --all --presets\n        $ sb-mig sync components accordion accordion-item\n        $ sb-mig sync components accordion accordion-item --presets\n        \n        $ sb-mig sync roles --all\n        \n        $ sb-mig sync datasources --all\n        \n        $ sb-mig sync plugins my-awesome-plugin - (you have to be in catalog which has ./dist/export.js file with compiled plugin)\n        \n        $ sb-mig sync content --all --from 12345 --to 12345\n        $ sb-mig sync content --stories --from 12345 --to 12345\n        $ sb-mig sync content --assets --from 12345 --to 12345\n";
 export declare const copyDescription = "\n    Usage\n        $ sb-mig copy\n        \n    Description\n        Copy stuff\n        \n    COMMANDS\n        ?\n     \n    FLAGS\n        ?\n    \n    EXAMPLES\n        $ sb-mig copy ?\n";
-export declare const migrateDescription = "\n    Usage\n        $ sb-mig migrate [content] [space separated file names] or --all --from [spaceId] --to [spaceId] --migration [migration-config-filename]\n        \n    Description\n        Migrate content from space to space, or from file to space. It's potentially dangerous command, so it will ask for confirmation.\n        Use with care.\n        \n    COMMANDS\n        content           - migrate content \n     \n    FLAGS\n        --from            - Space ID from which you want to migrate / or file name if passed '--migrate-from file'\n        --to              - Space ID to which you want to migrate\n        --migrate-from    - Migrate from (space, file) default: space\n        --migration       - File name of migration file (without extension)\n        --yes             - Skip ask for confirmation (dangerous, but useful in CI/CD) \n    \n    EXAMPLES\n        $ sb-mig migrate content --all --from 12345 --to 12345 --migration file-with-migration\n        $ sb-mig migrate content --all --migrate-from file --from file-with-stories --to 12345 --migration file-with-migration\n        $ sb-mig migrate content my-component-1 my-component-2 --from 12345 --to 12345 --migration file-with-migration\n        $ sb-mig migrate content my-component-1 my-component-2 --migrate-from file --from file-with-stories --to 12345 --migration file-with-migration        \n";
+export declare const migrateDescription = "\n    Usage\n        $ sb-mig migrate [content] [space separated file names] or --all --from [spaceId] --to [spaceId] --migration [migration-config-filename]\n        \n    Description\n        Migrate content from space to space, or from file to space. It's potentially dangerous command, so it will ask for confirmation.\n        Use with care.\n        \n    COMMANDS\n        content           - migrate content \n     \n    FLAGS\n        --from            - Space ID from which you want to migrate / or file name if passed '--migrate-from file'\n        --to              - Space ID to which you want to migrate\n        --migrate-from    - Migrate from (space, file) default: space\n        --migration       - File name of migration file (without extension)\n        --withSlug        - Filter stories by full slug (can be repeated)\n        --startsWith      - Filter stories by starts_with prefix\n        --yes             - Skip ask for confirmation (dangerous, but useful in CI/CD) \n    \n    EXAMPLES\n        $ sb-mig migrate content --all --from 12345 --to 12345 --migration file-with-migration\n        $ sb-mig migrate content --all --from 12345 --to 12345 --migration file-with-migration --withSlug blog/home --withSlug docs/getting-started\n        $ sb-mig migrate content --all --from 12345 --to 12345 --migration file-with-migration --startsWith blog/\n        $ sb-mig migrate content --all --migrate-from file --from file-with-stories --to 12345 --migration file-with-migration\n        $ sb-mig migrate content my-component-1 my-component-2 --from 12345 --to 12345 --migration file-with-migration\n        $ sb-mig migrate content my-component-1 my-component-2 --migrate-from file --from file-with-stories --to 12345 --migration file-with-migration        \n";
 export declare const revertDescription = "\n    Usage\n        $ sb-mig revert [content] --migration\n        \n    Description\n        Revert content migration\n        \n    COMMANDS\n        content           - revert content migration \n     \n    FLAGS\n        --migration       - ???\n        --yes             - Skip ask for confirmation (dangerous, but useful in CI/CD) \n    \n    EXAMPLES\n        $ sb-mig revert content --migration        \n";
 export declare const discoverDescription = "\n    Usage\n        $ sb-mig discover [components] --all --write\n        \n    Description\n        Discover all component and write to file or stdout\n        \n    COMMANDS\n        components     - discover components\n     \n    FLAGS\n        --all          - Discover all components\n        --write        - Write to file \n    \n    EXAMPLES\n        $ sb-mig discover components --all\n        $ sb-mig discover components --all -- write\n";
 export declare const migrationsDescription = "\n    Usage\n        $ sb-mig migrations recognize\n        \n    Description\n        Recognize migrations you need to apply\n        \n    COMMANDS\n        recognize      - recognize migrations\n     \n    FLAGS \n    \n    EXAMPLES\n        $ sb-mig migrations recognize\n\n";

package/dist/cli/cli-descriptions.js

@@ -86,10 +86,14 @@ export const migrateDescription = `
         --to              - Space ID to which you want to migrate
         --migrate-from    - Migrate from (space, file) default: space
         --migration       - File name of migration file (without extension)
+        --withSlug        - Filter stories by full slug (can be repeated)
+        --startsWith      - Filter stories by starts_with prefix
         --yes             - Skip ask for confirmation (dangerous, but useful in CI/CD) 
     
     EXAMPLES
         $ sb-mig migrate content --all --from 12345 --to 12345 --migration file-with-migration
+        $ sb-mig migrate content --all --from 12345 --to 12345 --migration file-with-migration --withSlug blog/home --withSlug docs/getting-started
+        $ sb-mig migrate content --all --from 12345 --to 12345 --migration file-with-migration --startsWith blog/
         $ sb-mig migrate content --all --migrate-from file --from file-with-stories --to 12345 --migration file-with-migration
         $ sb-mig migrate content my-component-1 my-component-2 --from 12345 --to 12345 --migration file-with-migration
         $ sb-mig migrate content my-component-1 my-component-2 --migrate-from file --from file-with-stories --to 12345 --migration file-with-migration        

package/dist/cli/commands/migrate.js

@@ -24,6 +24,9 @@ export const migrate = async (props) => {
         "pageId",
         "migration",
         "yes",
+        "withSlug",
+        "startsWith",
+        "dryRun",
     ]);
     Logger.warning(`This feature is in BETA. Use it at your own risk. The API might change in the future. (Probably in a standard Prisma like migration way)`);
     switch (command) {
@@ -32,6 +35,13 @@ export const migrate = async (props) => {
             const from = getFrom(flags, apiConfig);
             const to = getTo(flags, apiConfig);
             const migrationConfig = flags["migration"];
+            const withSlugFlag = flags["withSlug"];
+            const withSlug = Array.isArray(withSlugFlag)
+                ? withSlugFlag
+                : withSlugFlag
+                    ? [withSlugFlag]
+                    : undefined;
+            const startsWith = flags["startsWith"] || undefined;
             if (isIt("empty")) {
                 const componentsToMigrate = unpackElements(input) || [""];
                 const migrateFrom = "space";
@@ -50,6 +60,7 @@ export const migrate = async (props) => {
                         migrateFrom,
                         componentsToMigrate,
                         migrationConfig,
+                        filters: { withSlug, startsWith },
                     }, apiConfig);
                 }, () => {
                     Logger.warning("Migration not started, exiting the program...");
@@ -66,6 +77,7 @@ export const migrate = async (props) => {
                         to,
                         migrateFrom,
                         migrationConfig,
+                        filters: { withSlug, startsWith },
                     }, apiConfig);
                 }, () => {
                     Logger.warning("Migration not started, exiting the program...");

package/dist/cli/index.js

@@ -54,6 +54,13 @@ app.migrate = () => ({
                 default: "space",
                 isRequired: true,
             },
+            withSlug: {
+                type: "string",
+                isMultiple: true,
+            },
+            startsWith: {
+                type: "string",
+            },
         },
     }),
     action: (cli) => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sb-mig",
-  "version": "5.5.4-beta.1",
+  "version": "5.6.0-beta.1",
   "description": "CLI to rule the world. (and handle stuff related to Storyblok CMS)",
   "author": "Marcin Krawczyk <marckraw@icloud.com>",
   "license": "MIT",