sb-mig 3.1.2 → 3.1.6

package/dist/api/roles.js

@@ -0,0 +1,125 @@
+import Logger from "../utils/logger.js";
+import storyblokConfig from "../config/config.js";
+import { sbApi } from "./config.js";
+import { LOOKUP_TYPE, SCOPE, compare, discoverRoles, discoverManyRoles, } from "../utils/discover.js";
+import { getFileContent } from "../utils/main.js";
+const { spaceId } = storyblokConfig;
+// POST
+export const createRole = (role) => {
+    sbApi
+        .post(`spaces/${spaceId}/space_roles/`, {
+        space_role: role,
+    })
+        .then(() => {
+        Logger.success(`Role '${role.role}' has been created.`);
+    })
+        .catch((err) => {
+        Logger.error("error happened... :(");
+        console.log(`${err.message} in migration of ${role.role} in createRole function`);
+    });
+};
+// PUT
+export const updateRole = (role) => {
+    sbApi
+        .put(`spaces/${spaceId}/space_roles/${role.id}`, {
+        space_role: role,
+    })
+        .then(() => {
+        Logger.success(`Role '${role.role}' has been updated.`);
+    })
+        .catch((err) => {
+        Logger.error("error happened... :(");
+        console.log(`${err.message} in migration of ${role.role} in updateRole function`);
+    });
+};
+// GET
+export const getAllRoles = async () => {
+    return sbApi
+        .get(`spaces/${spaceId}/space_roles/`)
+        .then(({ data }) => data)
+        .catch((err) => {
+        if (err.response.status === 404) {
+            Logger.error(`There is no roles in your Storyblok ${spaceId} space.`);
+            return true;
+        }
+        else {
+            Logger.error(err);
+            return false;
+        }
+    });
+};
+// GET
+export const getRole = async (roleName) => {
+    Logger.log(`Trying to get '${roleName}' role.`);
+    return getAllRoles()
+        .then((res) => res.space_roles.filter((role) => role.role === roleName))
+        .then((res) => {
+        if (Array.isArray(res) && res.length === 0) {
+            Logger.warning(`There is no role named '${roleName}'`);
+            return false;
+        }
+        return res;
+    })
+        .catch((err) => Logger.error(err));
+};
+export const syncRoles = async ({ specifiedRoles }) => {
+    const specifiedRolesContent = await Promise.all(specifiedRoles.map((roles) => getFileContent({ file: roles.path })));
+    const { space_roles } = await getAllRoles();
+    const rolesToUpdate = [];
+    const rolesToCreate = [];
+    for (const role of specifiedRolesContent) {
+        const shouldBeUpdated = space_roles.find((remoteRole) => role.role === remoteRole.role);
+        if (shouldBeUpdated) {
+            rolesToUpdate.push({ id: shouldBeUpdated.id, ...role });
+        }
+        else {
+            rolesToCreate.push(role);
+        }
+    }
+    rolesToUpdate.map(async (role) => {
+        await updateRole(role);
+    });
+    rolesToCreate.map(async (role) => {
+        await createRole(role);
+    });
+};
+export const syncAllRoles = async () => {
+    // #1: discover all external .roles.sb.js files
+    const allLocalSbComponentsSchemaFiles = discoverRoles({
+        scope: SCOPE.local,
+        type: LOOKUP_TYPE.fileName,
+    });
+    // #2: discover all local .roles.sb.js files
+    const allExternalSbComponentsSchemaFiles = discoverRoles({
+        scope: SCOPE.external,
+        type: LOOKUP_TYPE.fileName,
+    });
+    // #3: compare results, prefare local ones (so we have to create final external paths array and local array of things to sync from where)
+    const { local, external } = compare({
+        local: allLocalSbComponentsSchemaFiles,
+        external: allExternalSbComponentsSchemaFiles,
+    });
+    // #4: sync - do all stuff already done (groups resolving, and so on)
+    syncRoles({ specifiedRoles: [...local, ...external] });
+};
+export const syncProvidedRoles = ({ roles }) => {
+    // #1: discover all external .sb.js files
+    const allLocalSbComponentsSchemaFiles = discoverManyRoles({
+        scope: SCOPE.local,
+        type: LOOKUP_TYPE.fileName,
+        fileNames: roles,
+    });
+    // #2: discover all local .sb.js files
+    const allExternalSbComponentsSchemaFiles = discoverManyRoles({
+        scope: SCOPE.external,
+        type: LOOKUP_TYPE.fileName,
+        fileNames: roles,
+    });
+    // #3: compare results, prefer local ones (so we have to create final external paths array and local array of things to sync from where)
+    const { local, external } = compare({
+        local: allLocalSbComponentsSchemaFiles,
+        external: allExternalSbComponentsSchemaFiles,
+    });
+    // #4: sync - do all stuff already done (groups resolving, and so on)
+    syncRoles({ specifiedRoles: [...local, ...external] });
+};

package/dist/cli-descriptions.d.ts

@@ -0,0 +1,4 @@
+export declare const mainDescription = "\n    CLI to rule the world. (and handle stuff related to Storyblok CMS)\n    \n    VERSION\n        sb-mig/3.0.0@beta\n    \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-migv-3 sync\n      $ sb-mig-v3 debug  \n";
+export declare const syncDescription = "\n    Usage\n        $ sb-mig-v3 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 accordion accordion-item\n        $ sb-mig sync components @storyblok-components/accordion --packageName\n    \n";
+export declare const backupDescription = "\n    Usage\n        $ sb-mig-v3 backup [components|component-groups|roles|datasources|presets|component-presets] [space separated file names ] or --all\n    Description\n        Command for backing up anything related to Storyblok\n        \n    COMMANDS\n        components - backup components\n        component-groups - backuo 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 accordion-item carousel text-block\n        $ sb-mig backup datasources --all\n        $ sb-mig backup roles admin normal-user\n";
+export declare const debugDescription = "\n    Usage\n        $ sb-mig-v3 debug\n    Description\n        Output extra debugging information\n";

package/dist/cli-descriptions.js

@@ -0,0 +1,72 @@
+export const mainDescription = `
+    CLI to rule the world. (and handle stuff related to Storyblok CMS)
+    
+    VERSION
+        sb-mig/3.0.0@beta
+    
+    USAGE
+      $ sb-mig [command]
+    
+    COMMANDS
+        sync Synchronize components, datasources or roles with Storyblok space.
+        backup  Command for backing up anything related to Storyblok
+        debug   Output extra debugging information
+        help    This screen
+    
+    Examples
+      $ sb-migv-3 sync
+      $ sb-mig-v3 debug  
+`;
+export const syncDescription = `
+    Usage
+        $ sb-mig-v3 sync [components|roles|datasources] [space separated file names] or --all --packageName
+        
+    Description
+        Synchronize components or roles with Storyblok space.
+        
+    COMMANDS
+        components  - sync components
+        roles       - sync roles
+        datasources - sync datasources
+     
+    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) 
+    
+    EXAMPLES
+        $ sb-mig sync components --all
+        $ sb-mig sync components accordion accordion-item
+        $ sb-mig sync components @storyblok-components/accordion --packageName
+    
+`;
+export const backupDescription = `
+    Usage
+        $ sb-mig-v3 backup [components|component-groups|roles|datasources|presets|component-presets] [space separated file names ] or --all
+    Description
+        Command for backing up anything related to Storyblok
+        
+    COMMANDS
+        components - backup components
+        component-groups - backuo component-groups
+        roles - backup components
+        datasources - backup components
+        presets - backup presets
+        component-presets - backup component presets
+     
+    FLAGS
+        --all  - Backup all 
+        --one - Backup one 
+    
+    EXAMPLES
+        $ sb-mig backup components --all
+        $ sb-mig backup components accordion accordion-item carousel text-block
+        $ sb-mig backup datasources --all
+        $ sb-mig backup roles admin normal-user
+`;
+export const debugDescription = `
+    Usage
+        $ sb-mig-v3 debug
+    Description
+        Output extra debugging information
+`;

package/dist/commands/backup.d.ts

@@ -0,0 +1,2 @@
+import { CLIOptions } from "../utils/interfaces.js";
+export declare const backup: (props: CLIOptions) => void;

package/dist/commands/backup.js

@@ -0,0 +1,201 @@
+import { getAllComponents, getAllComponentsGroups, getComponent, getComponentsGroup, } from "../api/components.js";
+import { createAndSaveToFile } from "../utils/files.js";
+import Logger from "../utils/logger.js";
+import { unpackOne } from "../utils/main.js";
+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";
+const BACKUP_COMMANDS = {
+    components: "components",
+    componentGroups: "component-groups",
+    datasources: "datasources",
+    presets: "presets",
+    componentPresets: "component-presets",
+    roles: "roles",
+};
+export const backup = (props) => {
+    const { input, flags } = props;
+    const command = input[1];
+    switch (command) {
+        case BACKUP_COMMANDS.components:
+            Logger.warning(`back up components... with command: ${command}`);
+            if (flags["all"]) {
+                getAllComponents()
+                    .then(async (res) => {
+                    await createAndSaveToFile({
+                        prefix: "all-components-",
+                        folder: "components",
+                        res,
+                    });
+                })
+                    .catch((err) => {
+                    console.log(err);
+                    console.error("error happened... :(");
+                });
+            }
+            if (flags["one"]) {
+                const componentToBackup = unpackOne(input);
+                getComponent(componentToBackup)
+                    .then(async (res) => {
+                    await createAndSaveToFile({
+                        prefix: "component-",
+                        folder: "components",
+                        res,
+                    });
+                })
+                    .catch((err) => {
+                    console.log(err);
+                    Logger.error("error happened... :(");
+                });
+            }
+            break;
+        case BACKUP_COMMANDS.componentGroups:
+            if (flags["all"]) {
+                getAllComponentsGroups()
+                    .then(async (res) => {
+                    await createAndSaveToFile({
+                        prefix: "all-component_groups-",
+                        folder: "component_groups",
+                        res,
+                    });
+                })
+                    .catch((err) => {
+                    console.log(err);
+                    Logger.error("error happened... :(");
+                });
+            }
+            if (flags["one"]) {
+                const componentGroupToBackup = unpackOne(input);
+                getComponentsGroup(componentGroupToBackup)
+                    .then(async (res) => {
+                    await createAndSaveToFile({
+                        prefix: "components_group-",
+                        folder: "component_groups",
+                        res,
+                    });
+                })
+                    .catch((err) => {
+                    console.log(err);
+                    Logger.error("error happened... :(");
+                });
+            }
+            break;
+        case BACKUP_COMMANDS.datasources:
+            if (flags["all"]) {
+                getAllDatasources()
+                    .then(async (res) => {
+                    await createAndSaveToFile({
+                        prefix: "all-datasources-",
+                        folder: "datasources",
+                        res,
+                    });
+                })
+                    .catch((err) => {
+                    console.log(err);
+                    Logger.error("error happened... :(");
+                });
+            }
+            if (flags["one"]) {
+                const datasourceToBackup = unpackOne(input);
+                getDatasource(datasourceToBackup)
+                    .then(async (res) => {
+                    if (res) {
+                        await createAndSaveToFile({
+                            prefix: `datasource-${datasourceToBackup}-`,
+                            folder: "datasources",
+                            res,
+                        });
+                    }
+                })
+                    .catch((err) => {
+                    console.log(err);
+                    Logger.error("error happened... :(");
+                });
+            }
+            break;
+        case BACKUP_COMMANDS.roles:
+            if (flags["all"]) {
+                getAllRoles()
+                    .then(async (res) => {
+                    await createAndSaveToFile({
+                        prefix: "all-roles-",
+                        folder: "roles",
+                        res,
+                    });
+                })
+                    .catch((err) => {
+                    console.log(err);
+                    Logger.error("error happened... :(");
+                });
+            }
+            if (flags["one"]) {
+                const roleToBackup = unpackOne(input);
+                getRole(roleToBackup)
+                    .then(async (res) => {
+                    if (res) {
+                        await createAndSaveToFile({
+                            prefix: `role-${roleToBackup}`,
+                            folder: "roles",
+                            res,
+                        });
+                    }
+                })
+                    .catch((err) => {
+                    console.log(err);
+                    Logger.error("error happened... :(");
+                });
+            }
+            break;
+        case BACKUP_COMMANDS.presets:
+            if (flags["all"]) {
+                getAllPresets()
+                    .then(async (res) => {
+                    await createAndSaveToFile({
+                        prefix: "all-presets-",
+                        folder: "presets",
+                        res,
+                    });
+                })
+                    .catch((err) => {
+                    console.log(err);
+                    Logger.error("error happened... :(");
+                });
+            }
+            if (flags["one"]) {
+                const presetToBackup = unpackOne(input);
+                getPreset(presetToBackup)
+                    .then(async (res) => {
+                    await createAndSaveToFile({
+                        prefix: `preset-${presetToBackup}-`,
+                        folder: "presets",
+                        res,
+                    });
+                })
+                    .catch((err) => {
+                    console.log(err);
+                    Logger.error("error happened... :(");
+                });
+            }
+            break;
+        case BACKUP_COMMANDS.componentPresets:
+            if (flags["one"]) {
+                const componentPresetToBackup = unpackOne(input);
+                getComponentPresets(componentPresetToBackup)
+                    .then(async (res) => {
+                    await createAndSaveToFile({
+                        prefix: `component-preset-${componentPresetToBackup}-`,
+                        folder: "component-presets",
+                        res,
+                    });
+                })
+                    .catch((err) => {
+                    console.log(err);
+                    Logger.error("error happened... :(");
+                });
+            }
+            break;
+        default:
+            console.log(`no command like that: ${command}`);
+    }
+};

package/dist/commands/debug.d.ts

@@ -0,0 +1 @@
+export declare const debug: (props: any) => void;

package/dist/commands/debug.js

@@ -0,0 +1,5 @@
+import config from "../config/config.js";
+export const debug = (props) => {
+    const { input, flags, unnormalizedFlags, pkg, help, showHelp, showVersion, } = props;
+    console.log("storyblok.config.js: ", config, "\n");
+};

package/dist/commands/sync.d.ts

@@ -0,0 +1,2 @@
+import { CLIOptions } from "../utils/interfaces.js";
+export declare const sync: (props: CLIOptions) => Promise<void>;

package/dist/commands/sync.js

@@ -0,0 +1,58 @@
+import Logger from "../utils/logger.js";
+import { unpackElements } from "../utils/main.js";
+import storyblokConfig from "../config/config.js";
+import { syncAllComponents, syncProvidedComponents } from "../api/migrate.js";
+import { syncAllRoles, syncProvidedRoles } from "../api/roles.js";
+import { syncAllDatasources, syncProvidedDatasources, } from "../api/datasources.js";
+const SYNC_COMMANDS = {
+    components: "components",
+    roles: "roles",
+    datasources: "datasources",
+};
+export const sync = async (props) => {
+    const { input, flags } = props;
+    const command = input[1];
+    switch (command) {
+        case SYNC_COMMANDS.components:
+            Logger.warning(`sync components... with command: ${command}`);
+            if (flags["all"]) {
+                Logger.log(`Syncing ALL components with ${storyblokConfig.schemaFileExt} extension...`);
+                const presets = flags["presets"] || false;
+                syncAllComponents({ presets });
+            }
+            if (!flags["all"]) {
+                Logger.warning("Synchronizing PROVIDED componensdt...");
+                const componentsToSync = unpackElements(input);
+                syncProvidedComponents({
+                    components: componentsToSync,
+                    presets: Boolean(flags.presets),
+                    packageName: flags.packageName,
+                });
+            }
+            break;
+        case SYNC_COMMANDS.roles:
+            if (flags["all"]) {
+                Logger.log("Syncing all roles...");
+                syncAllRoles();
+            }
+            if (!flags["all"]) {
+                Logger.log("Syncing provided roles...");
+                const rolesToSync = unpackElements(input);
+                syncProvidedRoles({ roles: rolesToSync });
+            }
+            break;
+        case SYNC_COMMANDS.datasources:
+            if (flags["all"]) {
+                Logger.log("Syncing all datasources with extension...");
+                syncAllDatasources();
+            }
+            if (!flags["all"]) {
+                Logger.log("Syncing provided datasources with extension...");
+                const datasourcesToSync = unpackElements(input);
+                syncProvidedDatasources({ datasources: datasourcesToSync });
+            }
+            break;
+        default:
+            console.log(`no command like that: ${command}`);
+    }
+};

package/dist/config/config.d.ts

@@ -0,0 +1,20 @@
+export interface IStoryblokConfig {
+    componentsMatchFile: string;
+    storyblokComponentsListfile: string;
+    storyblokComponentsLocalDirectory: string;
+    componentsStylesMatchFile: string;
+    boilerplateUrl: string;
+    sbmigWorkingDirectory: string;
+    componentDirectory: string;
+    datasourcesDirectory: string;
+    componentsDirectories: string[];
+    schemaFileExt: string;
+    datasourceExt: string;
+    rolesExt: string;
+    storyblokApiUrl: string;
+    oauthToken: string;
+    spaceId: string;
+    accessToken: string;
+}
+declare const _default: any;
+export default _default;

package/dist/config/config.js

@@ -0,0 +1,32 @@
+var _a, _b;
+import path from "path";
+import dotenv from "dotenv";
+import { getFileContent } from "../utils/main.js";
+dotenv.config();
+const defaultConfig = {
+    componentsMatchFile: "src/components/components.js",
+    storyblokComponentsListfile: "src/components/storyblok-components.componentList.js",
+    storyblokComponentsLocalDirectory: "src/@storyblok-components",
+    componentsStylesMatchFile: "src/@storyblok-components/_storyblok-components.scss",
+    boilerplateUrl: "git@github.com:storyblok-components/gatsby-storyblok-boilerplate.git",
+    sbmigWorkingDirectory: "sbmig",
+    componentDirectory: "storyblok",
+    datasourcesDirectory: "storyblok",
+    componentsDirectories: ["src", "storyblok"],
+    schemaFileExt: "sb.js",
+    datasourceExt: "sb.datasource.js",
+    rolesExt: "sb.roles.js",
+    storyblokApiUrl: "https://api.storyblok.com/v1",
+    oauthToken: (_a = process.env["STORYBLOK_OAUTH_TOKEN"]) !== null && _a !== void 0 ? _a : "",
+    spaceId: (_b = process.env["STORYBLOK_SPACE_ID"]) !== null && _b !== void 0 ? _b : "",
+    accessToken: process.env["GATSBY_STORYBLOK_ACCESS_TOKEN"] ||
+        process.env["NEXT_PUBLIC_STORYBLOK_ACCESS_TOKEN"] ||
+        "",
+};
+const customConfig = await getFileContent({
+    file: path.resolve(process.cwd(), "storyblok.config") + ".js",
+});
+export default {
+    ...defaultConfig,
+    ...customConfig,
+};

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+#! /usr/bin/env node
+export {};

package/dist/utils/discover.d.ts

@@ -0,0 +1,57 @@
+export declare enum SCOPE {
+    local = "local",
+    external = "external",
+    lock = "lock",
+    all = "all"
+}
+export declare enum LOOKUP_TYPE {
+    packagName = "packageName",
+    fileName = "fileName"
+}
+interface DiscoverRequest {
+    scope: SCOPE;
+    type: LOOKUP_TYPE;
+}
+interface DiscoverOneRequest {
+    fileName: string;
+    scope: SCOPE;
+    type: LOOKUP_TYPE;
+}
+interface DiscoverManyRequest {
+    fileNames: string[];
+    scope: SCOPE;
+    type: LOOKUP_TYPE;
+}
+interface DiscoverOneByPackageNameRequest {
+    packageName: string;
+    scope: SCOPE;
+}
+interface DiscoverManyByPackageNameRequest {
+    packageNames: string[];
+    scope: SCOPE;
+}
+interface CompareRequest {
+    local: string[];
+    external: string[];
+}
+export interface OneComponent {
+    name: string;
+    path: string;
+}
+export interface CompareResult {
+    local: OneComponent[];
+    external: OneComponent[];
+}
+declare type DiscoverResult = string[];
+export declare const compare: (request: CompareRequest) => any;
+export declare const discoverManyByPackageName: (request: DiscoverManyByPackageNameRequest) => DiscoverResult;
+export declare const discoverOneByPackageName: (request: DiscoverOneByPackageNameRequest) => DiscoverResult;
+export declare const discoverMany: (request: DiscoverManyRequest) => DiscoverResult;
+export declare const discoverManyDatasources: (request: DiscoverManyRequest) => DiscoverResult;
+export declare const discoverDatasources: (request: DiscoverRequest) => DiscoverResult;
+export declare const discoverOne: (request: DiscoverOneRequest) => DiscoverResult;
+export declare const discover: (request: DiscoverRequest) => DiscoverResult;
+export declare const discoverManyStyles: (request: DiscoverManyRequest) => DiscoverResult;
+export declare const discoverRoles: (request: DiscoverRequest) => DiscoverResult;
+export declare const discoverManyRoles: (request: DiscoverManyRequest) => DiscoverResult;
+export {};