sb-mig 4.1.0-beta.2 → 4.1.0-beta.3

package/dist/api/components.d.ts

@@ -5,6 +5,7 @@ export declare const removeComponentGroup: ({ componentGroup, }: {
     componentGroup: any;
 }) => Promise<any>;
 export declare const getAllComponents: () => Promise<any>;
+export declare const getAllPlugins: () => Promise<any>;
 export declare const getComponent: (componentName: string | undefined) => Promise<any>;
 export declare const getComponentsGroup: (groupName: string | undefined) => Promise<any>;
 export declare const getAllComponentsGroups: () => Promise<any>;

package/dist/api/components.js

@@ -26,6 +26,14 @@ export const getAllComponents = () => {
         .then((res) => res.data)
         .catch((err) => console.error(err));
 };
+// GET
+export const getAllPlugins = () => {
+    console.log("Trying to get all plugins.");
+    return sbApi
+        .get(`field_types`)
+        .then((res) => res.data)
+        .catch((err) => console.error(err));
+};
 export const getComponent = (componentName) => {
     console.log(`Trying to get '${componentName}' component.`);
     return getAllComponents()

package/dist/api/migrate.d.ts

@@ -12,6 +12,9 @@ interface SyncProvidedComponents {
     components: string[];
     packageName: boolean;
 }
+interface SyncProvidedPlugins {
+    plugins: string[];
+}
 export declare const syncProvidedComponents: ({ components, presets, packageName, }: SyncProvidedComponents) => void;
 export declare const syncAllComponents: ({ presets }: SyncAllComponents) => void;
 export declare const removeAllComponents: () => Promise<any[]>;
@@ -25,4 +28,5 @@ export declare const syncContent: ({ from, to, }: {
 export declare const removeAllStories: ({ spaceId }: {
     spaceId: number;
 }) => Promise<any[]>;
+export declare const syncProvidedPlugins: ({ plugins }: SyncProvidedPlugins) => Promise<any>;
 export {};

package/dist/api/migrate.js

@@ -4,6 +4,8 @@ import { updateComponent, createComponent } from "./mutateComponents.js";
 import { discoverManyByPackageName, LOOKUP_TYPE, SCOPE, compare, discover, discoverMany, } from "../utils/discover.js";
 import { getFileContentWithRequire } from "../utils/main.js";
 import { createStory, getAllStories, removeStory } from "./stories.js";
+import { createPlugin, getPlugin, updatePlugin } from "./plugins.js";
+import { readFile } from "../utils/files.js";
 const _uniqueValuesFrom = (array) => [...new Set(array)];
 const _checkAndPrepareGroups = async (groupsToCheck) => {
     const componentsGroups = await getAllComponentsGroups();
@@ -175,3 +177,21 @@ export const removeAllStories = async ({ spaceId }) => {
     const allResponses = Promise.all(stories.map(async (story) => await removeStory({ spaceId, storyId: story.story.id })));
     return allResponses;
 };
+export const syncProvidedPlugins = async ({ plugins }) => {
+    const body = await readFile("dist/export.js");
+    if (plugins.length === 1) {
+        const pluginName = plugins[0];
+        const plugin = await getPlugin(pluginName);
+        if (plugin) {
+            console.log("Plugin exist.");
+            console.log("Start updating plugin...");
+            return await updatePlugin({ plugin: plugin.field_type, body });
+        }
+        else {
+            console.log("Start creating plugin...");
+            const { field_type } = await createPlugin(pluginName);
+            console.log("Start updating plugin...");
+            return await updatePlugin({ plugin: field_type, body });
+        }
+    }
+};

package/dist/api/plugins.d.ts

@@ -0,0 +1,13 @@
+export declare const getAllPlugins: () => Promise<any>;
+export declare const getPlugin: (pluginName: string | undefined) => Promise<any>;
+export declare const getPluginDetails: (plugin: any) => Promise<any>;
+interface UpdatePlugin {
+    plugin: {
+        id: number;
+        name: string;
+    };
+    body?: string;
+}
+export declare const updatePlugin: ({ plugin, body }: UpdatePlugin) => Promise<any>;
+export declare const createPlugin: (pluginName: string) => Promise<any>;
+export {};

package/dist/api/plugins.js

@@ -0,0 +1,76 @@
+// GET
+import { sbApi } from "./config.js";
+import Logger from "../utils/logger.js";
+export const getAllPlugins = () => {
+    console.log("Trying to get all plugins.");
+    return sbApi
+        .get(`field_types?per_page=100`)
+        .then((res) => {
+        console.log(`Amount of field typess: ${res.data.field_types.length}`);
+        return res.data;
+    })
+        .catch((err) => console.error(err));
+};
+export const getPlugin = (pluginName) => {
+    return getAllPlugins()
+        .then((res) => res.field_types.find((plugin) => plugin.name === pluginName))
+        .then((res) => {
+        if (!res) {
+            throw Error("Not Found - plugins does not exist");
+        }
+        if (Array.isArray(res) && res.length === 0) {
+            console.info(`There is no plugin named '${pluginName}'`);
+            return false;
+        }
+        return res;
+    })
+        .then((plugin) => {
+        return getPluginDetails(plugin)
+            .then((res) => res)
+            .catch((err) => console.error(err));
+    })
+        .catch((err) => {
+        Logger.warning(err.message);
+        return false;
+    });
+};
+export const getPluginDetails = (plugin) => {
+    console.log(`Trying to get ${plugin.name} details `);
+    return sbApi
+        .get(`field_types/${plugin.id}`)
+        .then((res) => res.data)
+        .catch((err) => console.error(err));
+};
+export const updatePlugin = ({ plugin, body }) => {
+    return sbApi
+        .put(`field_types/${plugin.id}`, {
+        field_type: {
+            body,
+            compiled_body: "",
+        },
+    })
+        .then((res) => {
+        Logger.success(`'${plugin.name}' plugin updated!`);
+        return res.data;
+    })
+        .catch((err) => {
+        console.log(err);
+        console.error("Error happened :()");
+    });
+};
+export const createPlugin = (pluginName) => {
+    return sbApi
+        .post(`field_types`, {
+        field_type: {
+            name: pluginName,
+        },
+    })
+        .then((res) => {
+        Logger.success(`'${pluginName}' plugin created!`);
+        return res.data;
+    })
+        .catch((err) => {
+        console.log(err);
+        console.error("Error happened :()");
+    });
+};

package/dist/cli-descriptions.d.ts

@@ -1,5 +1,5 @@
 export declare const mainDescription = "\n    USAGE\n      $ sb-mig [command]\n    \n    COMMANDS\n        sync    Synchronize components, datasources or roles with Storyblok space.\n        backup  Command for backing up anything related to Storyblok\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] [space separated file names] or --all --packageName\n        \n    Description\n        Synchronize components or roles with Storyblok space.\n        \n    COMMANDS\n        components     - sync components\n        roles          - sync roles\n        datasources    - sync datasources\n     \n    FLAGS\n        --all          - Sync all components\n        --packageName  - Sync based on package name, instead of file name (package can have multiple schema files to sync)\n        --presets      - Pass it, if u want to sync also with presets (will take longer) \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        $ sb-mig sync components @storyblok-components/accordion --packageName\n        $ sb-mig sync components @storyblok-components/accordion --packageName --presets\n        $ sb-mig sync roles --all\n        $ sb-mig sync datasources --all\n";
+export declare const syncDescription = "\n    Usage\n        $ sb-mig sync [components|roles|datasources|plugins] [space separated file names] or --all --packageName\n        \n    Description\n        Synchronize components or roles with Storyblok space.\n        \n    COMMANDS\n        components     - sync components\n        roles          - sync roles\n        datasources    - sync datasources\n        plugins        - sync plugins\n     \n    FLAGS\n        --all          - Sync all components, roles, datasources \n        --packageName  - Sync based on package name, instead of file name (package can have multiple schema files to sync) *for components only\n        --presets      - Pass it, if u want to sync also with presets (will take longer) *for components 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        $ sb-mig sync components @storyblok-components/accordion --packageName\n        $ sb-mig sync components @storyblok-components/accordion --packageName --presets\n        $ sb-mig sync roles --all\n        $ sb-mig sync datasources --all\n        $ sb-mig sync plugins my-awesome-plugin - (you have to be in catalog which has ./dist/export.js file with compiled plugin)\n";
 export declare const removeDescription = "\n    Usage\n        $ sb-mig remove [components|roles|datasources] [space separated file names] or --all \n        \n    Description\n        Remove components or roles with Storyblok space.\n        \n    COMMANDS\n        components     - remove components\n        roles          - remove roles\n        datasources    - remove datasources\n     \n    FLAGS\n        --all          - Remove all components \n    \n    EXAMPLES\n        $ sb-mig remove components --all\n        $ sb-mig remove components accordion accordion-item\n        $ sb-mig remove roles --all\n        $ sb-mig remove datasources --all\n";
-export declare const backupDescription = "\n    Usage\n        $ sb-mig backup [components|component-groups|roles|datasources|presets|component-presets] component-name --one or --all\n    Description\n        Command for backing up anything related to Storyblok\n        \n    COMMANDS\n        components        - backup components\n        component-groups  - backup component-groups\n        roles             - backup components\n        datasources       - backup components\n        presets           - backup presets\n        component-presets - backup component presets\n     \n    FLAGS\n        --all   - Backup all \n        --one   - Backup one \n    \n    EXAMPLES\n        $ sb-mig backup components --all\n        $ sb-mig backup components accordion --one  \n        $ sb-mig backup datasources --all\n        $ sb-mig backup roles admin --one\n";
+export declare const backupDescription = "\n    Usage\n        $ sb-mig backup [components|component-groups|roles|datasources|presets|component-presets] component-name --one or --all\n    Description\n        Command for backing up anything related to Storyblok\n        \n    COMMANDS\n        components        - backup components\n        component-groups  - backup component-groups\n        roles             - backup components\n        datasources       - backup components\n        presets           - backup presets\n        component-presets - backup component presets\n        plugins           - backup plugins\n\n     \n    FLAGS\n        --all   - Backup all \n        --one   - Backup one \n    \n    EXAMPLES\n        $ sb-mig backup components --all\n        $ sb-mig backup components accordion --one  \n        $ sb-mig backup datasources --all\n        $ sb-mig backup roles admin --one\n        $ sb-mig backup plugins --all\n        $ sb-mig backup plugins my-awesome-plugin --one\n";
 export declare const debugDescription = "\n    Usage\n        $ sb-mig debug\n    Description\n        Output extra debugging information\n";

package/dist/cli-descriptions.js

@@ -14,7 +14,7 @@ export const mainDescription = `
 `;
 export const syncDescription = `
     Usage
-        $ sb-mig sync [components|roles|datasources] [space separated file names] or --all --packageName
+        $ sb-mig sync [components|roles|datasources|plugins] [space separated file names] or --all --packageName
         
     Description
         Synchronize components or roles with Storyblok space.
@@ -23,11 +23,12 @@ export const syncDescription = `
         components     - sync components
         roles          - sync roles
         datasources    - sync datasources
+        plugins        - sync plugins
      
     FLAGS
-        --all          - Sync all components
-        --packageName  - Sync based on package name, instead of file name (package can have multiple schema files to sync)
-        --presets      - Pass it, if u want to sync also with presets (will take longer) 
+        --all          - Sync all components, roles, datasources 
+        --packageName  - Sync based on package name, instead of file name (package can have multiple schema files to sync) *for components only
+        --presets      - Pass it, if u want to sync also with presets (will take longer) *for components only
     
     EXAMPLES
         $ sb-mig sync components --all
@@ -38,6 +39,7 @@ export const syncDescription = `
         $ sb-mig sync components @storyblok-components/accordion --packageName --presets
         $ sb-mig sync roles --all
         $ sb-mig sync datasources --all
+        $ sb-mig sync plugins my-awesome-plugin - (you have to be in catalog which has ./dist/export.js file with compiled plugin)
 `;
 export const removeDescription = `
     Usage
@@ -73,6 +75,8 @@ export const backupDescription = `
         datasources       - backup components
         presets           - backup presets
         component-presets - backup component presets
+        plugins           - backup plugins
+
      
     FLAGS
         --all   - Backup all 
@@ -83,6 +87,8 @@ export const backupDescription = `
         $ sb-mig backup components accordion --one  
         $ sb-mig backup datasources --all
         $ sb-mig backup roles admin --one
+        $ sb-mig backup plugins --all
+        $ sb-mig backup plugins my-awesome-plugin --one
 `;
 export const debugDescription = `
     Usage

package/dist/commands/backup.js

@@ -6,6 +6,7 @@ import { getAllDatasources, getDatasource } from "../api/datasources.js";
 import { getAllRoles, getRole } from "../api/roles.js";
 import { getComponentPresets } from "../api/componentPresets.js";
 import { getAllPresets, getPreset } from "../api/presets.js";
+import { getAllPlugins, getPlugin } from "../api/plugins.js";
 const BACKUP_COMMANDS = {
     components: "components",
     componentGroups: "component-groups",
@@ -13,6 +14,7 @@ const BACKUP_COMMANDS = {
     presets: "presets",
     componentPresets: "component-presets",
     roles: "roles",
+    plugins: "plugins",
 };
 export const backup = (props) => {
     const { input, flags } = props;
@@ -38,14 +40,13 @@ export const backup = (props) => {
                 const componentToBackup = unpackOne(input);
                 getComponent(componentToBackup)
                     .then(async (res) => {
-                    console.log("############");
-                    console.log(res);
-                    console.log("############");
-                    await createAndSaveToFile({
-                        prefix: "component-",
-                        folder: "components",
-                        res,
-                    });
+                    if (res) {
+                        await createAndSaveToFile({
+                            prefix: "component-",
+                            folder: "components",
+                            res,
+                        });
+                    }
                 })
                     .catch((err) => {
                     console.log(err);
@@ -198,6 +199,40 @@ export const backup = (props) => {
                 });
             }
             break;
+        case BACKUP_COMMANDS.plugins:
+            if (flags["one"]) {
+                const pluginToBackup = unpackOne(input);
+                getPlugin(pluginToBackup)
+                    .then(async (res) => {
+                    if (res) {
+                        await createAndSaveToFile({
+                            prefix: `plugin-${pluginToBackup}-`,
+                            folder: "plugins",
+                            res,
+                        });
+                    }
+                })
+                    .catch((err) => {
+                    console.log(err);
+                    Logger.error("error happened... :(");
+                });
+            }
+            if (flags["all"]) {
+                getAllPlugins()
+                    .then(async (res) => {
+                    await createAndSaveToFile({
+                        prefix: "all-plugins-",
+                        folder: "plugins",
+                        res,
+                    });
+                })
+                    .catch((err) => {
+                    console.log(err);
+                    Logger.error("error happened... :(");
+                });
+                return;
+            }
+            break;
         default:
             console.log(`no command like that: ${command}`);
     }

package/dist/commands/sync.js

@@ -1,7 +1,7 @@
 import Logger from "../utils/logger.js";
 import { unpackElements } from "../utils/main.js";
 import storyblokConfig from "../config/config.js";
-import { removeAllComponents, syncAllComponents, syncContent, syncProvidedComponents, } from "../api/migrate.js";
+import { removeAllComponents, syncAllComponents, syncContent, syncProvidedComponents, removeAllStories, syncProvidedPlugins, } from "../api/migrate.js";
 import { syncAllRoles, syncProvidedRoles } from "../api/roles.js";
 import { syncAllDatasources, syncProvidedDatasources, } from "../api/datasources.js";
 const SYNC_COMMANDS = {
@@ -9,6 +9,7 @@ const SYNC_COMMANDS = {
     components: "components",
     roles: "roles",
     datasources: "datasources",
+    plugins: "plugins",
 };
 export const sync = async (props) => {
     const { input, flags } = props;
@@ -61,10 +62,44 @@ export const sync = async (props) => {
             break;
         case SYNC_COMMANDS.story:
             Logger.log(`Syncing story with command: ${command}`);
-            if (flags["from"] && flags["to"]) {
-                Logger.warning(`sync story... from space-id: ${flags.from} to space-id: ${flags.to} with command: ${command}`);
-                console.log(await syncContent({ from: flags.from, to: flags.to }));
-                // await removeAllStories({spaceId: flags.to})
+            if (flags["all"]) {
+                if (!flags["from"] && !flags["to"]) {
+                    Logger.warning(`sync story... from boilerplateSpaceId: ${storyblokConfig.boilerplateSpaceId} to working dir spaceid: ${storyblokConfig.spaceId} with command: ${command}`);
+                    await removeAllStories({
+                        spaceId: storyblokConfig.spaceId,
+                    });
+                    await syncContent({
+                        from: storyblokConfig.boilerplateSpaceId,
+                        to: storyblokConfig.spaceId,
+                    });
+                }
+                if (flags["from"] && !flags["to"]) {
+                    Logger.warning(`sync story... from: ${flags.from} to working dir spaceid: ${storyblokConfig.spaceId} with command: ${command}`);
+                    await removeAllStories({
+                        spaceId: storyblokConfig.spaceId,
+                    });
+                    await syncContent({
+                        from: flags.from,
+                        to: storyblokConfig.spaceId,
+                    });
+                }
+                if (flags["from"] && flags["to"]) {
+                    Logger.warning(`sync story... from space-id: ${flags.from} to space-id: ${flags.to} with command: ${command}`);
+                    await removeAllStories({
+                        spaceId: storyblokConfig.spaceId,
+                    });
+                    await syncContent({ from: flags.from, to: flags.to });
+                }
+            }
+            break;
+        case SYNC_COMMANDS.plugins:
+            Logger.warning(`sync plugins... with command: ${command}`);
+            if (!flags["all"]) {
+                Logger.warning("Synchronizing PROVIDED plugins...");
+                const pluginsToSync = unpackElements(input);
+                syncProvidedPlugins({
+                    plugins: pluginsToSync,
+                });
             }
             break;
         default:

package/dist/config/config.js

@@ -31,13 +31,13 @@ const defaultConfig = {
     schemaFileExt: pkg.type === "module" ? "sb.js" : "sb.cjs",
     datasourceExt: pkg.type === "module" ? "sb.datasource.js" : "sb.datasource.cjs",
     rolesExt: pkg.type === "module" ? "sb.roles.js" : "sb.roles.cjs",
-    storyblokApiUrl: "https://api.storyblok.com/v1",
+    storyblokApiUrl: "https://mapi.storyblok.com/v1",
     oauthToken: process.env["STORYBLOK_OAUTH_TOKEN"] ?? "",
     spaceId: process.env["STORYBLOK_SPACE_ID"] ?? "",
     accessToken: process.env["GATSBY_STORYBLOK_ACCESS_TOKEN"] ||
         process.env["NEXT_PUBLIC_STORYBLOK_ACCESS_TOKEN"] ||
         "",
-    boilerplateSpaceId: 108084, // this is id of nextjs-web-ui-sb-boilerplate
+    boilerplateSpaceId: 172677, // this is id of Content seed for nextjs boilerplate space
 };
 const filePath = path.resolve(process.cwd(), "storyblok.config");
 const customConfig = await getStoryblokConfigContent({

package/dist/utils/files.d.ts

@@ -9,4 +9,5 @@ interface CreateAndSaveToFile {
     res: any;
 }
 export declare const createAndSaveToFile: ({ prefix, folder, res, }: CreateAndSaveToFile) => Promise<void>;
+export declare const readFile: (path: string) => Promise<string | undefined>;
 export {};

package/dist/utils/files.js

@@ -52,3 +52,15 @@ export const createAndSaveToFile = async ({ prefix, folder, res, }) => {
     await createJsonFile(JSON.stringify(res, undefined, 2), `${storyblokConfig.sbmigWorkingDirectory}/${folder}/${filename}.json`);
     Logger.success(`All groups written to a file:  ${filename}`);
 };
+export const readFile = async (path) => {
+    const absolutePath = `${process.cwd()}/${path}`;
+    try {
+        const result = await fs.promises.readFile(absolutePath);
+        return result.toString();
+    }
+    catch (e) {
+        console.log(e);
+        console.error("Error happened while reading file.");
+        return;
+    }
+};

package/dist/utils/others.js

@@ -1 +1 @@
-export const generateDatestamp = (datestamp) => `${datestamp.getFullYear()}-${datestamp.getMonth()}-${datestamp.getDay()}_${datestamp.getTime()}`;
+export const generateDatestamp = (datestamp) => `${datestamp.getFullYear()}-${datestamp.getMonth()}-${datestamp.getDay()}_${datestamp.getHours()}-${datestamp.getMinutes()}-${datestamp.getSeconds()}`;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sb-mig",
-  "version": "4.1.0-beta.2",
+  "version": "4.1.0-beta.3",
   "description": "CLI to rule the world. (and handle stuff related to Storyblok CMS)",
   "author": "Marcin Krawczyk <marckraw@icloud.com>",
   "license": "MIT",
@@ -52,7 +52,7 @@
     "glob": "^8.0.3",
     "meow": "^10.1.3",
     "ncp": "^2.0.0",
-    "storyblok-js-client": "^4.5.2"
+    "storyblok-js-client": "^4.5.7"
   },
   "devDependencies": {
     "@commitlint/cli": "^17.0.3",