sb-mig 2.9.3 → 3.1.2

package/lib/commands/sync.js

@@ -1,93 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const command_1 = require("@oclif/command");
-const core_1 = require("../core");
-const config_1 = require("../config/config");
-const logger_1 = require("../utils/logger");
-const migrate_1 = require("../api/migrate");
-const datasources_1 = require("../api/datasources");
-const roles_1 = require("../api/roles");
-class Sync extends core_1.default {
-    async run() {
-        const { argv, args, flags } = this.parse(Sync);
-        const components = argv.splice(1, argv.length);
-        if (args.type === 'roles' && flags.all && flags.ext) {
-            logger_1.default.log('Syncing all roles...');
-            (0, roles_1.syncAllRoles)();
-        }
-        if (args.type === 'roles' && !flags.all && flags.ext) {
-            const roles = components;
-            logger_1.default.log('Syncing provided roles...');
-            (0, roles_1.syncProvidedRoles)({ roles });
-        }
-        if (args.type === 'components' && flags.all && flags.ext) {
-            logger_1.default.log(`Syncing all components with ${config_1.default.schemaFileExt} extension...`);
-            (0, migrate_1.sync2AllComponents)({ presets: flags.presets });
-        }
-        if (args.type === 'components' && flags.all && !flags.ext) {
-            logger_1.default.warning('### DEPRECATED method. Method of syncing files without .sb.js extension, will be removed in version 4.0.0 ###');
-            logger_1.default.warning('Use sb-mig sync components --all --ext instead (you need to update your schema files to be named with .sb.js extension)');
-            logger_1.default.log(`Syncing all components from ${config_1.default.componentDirectory} directory...`);
-            (0, migrate_1.syncAllComponents)(Boolean(flags.ext), Boolean(flags.presets));
-        }
-        if (args.type === 'components' && !flags.all && flags.ext) {
-            logger_1.default.log(`Syncing provided components with ${config_1.default.schemaFileExt} extension...`);
-            if (components.length === 0) {
-                logger_1.default.warning('You have to provide some components separated with empty space. For exmaple: \'row column card\'');
-            }
-            else {
-                (0, migrate_1.syncProvidedComponents)({ components, presets: Boolean(flags.presets), packageName: flags.packageName });
-            }
-        }
-        if (args.type === 'components' && !flags.all && !flags.ext && !flags.lock) {
-            logger_1.default.warning('### DEPRECATED method. Method of syncing files without .sb.js extension, will be removed in version 4.0.0 ###');
-            logger_1.default.warning('Use sb-mig sync components --ext instead (you need to update your schema files to be named with .sb.js extension)');
-            logger_1.default.log('Syncing provided components...');
-            if (components.length === 0) {
-                logger_1.default.warning('You have to provide some components separated with empty space. For exmaple: \'row column card\'');
-            }
-            else {
-                (0, migrate_1.syncComponents)(components, Boolean(flags.ext), Boolean(flags.presets), flags.packageName);
-            }
-        }
-        if (args.type === 'datasources' && flags.all && !flags.ext) {
-            this.error('Datasources are only synced while using --ext optioon. use sb-mig sync datasources --all --ext to sync all datasources with extension (default: .sb.datasources.js)');
-        }
-        if (args.type === 'datasources' && !flags.all && !flags.ext) {
-            const datasources = components;
-            this.error(`Datasources are only synced while using --ext optioon. use sb-mig sync datasources ${datasources.join(' ')} --ext to sync provided datasources with extension (default: .sb.datasources.js)`);
-        }
-        if (args.type === 'datasources' && flags.all && flags.ext) {
-            logger_1.default.log('Syncing all datasources with extension...');
-            (0, datasources_1.syncAllDatasources)();
-        }
-        if (args.type === 'datasources' && !flags.all && flags.ext) {
-            const datasources = components;
-            logger_1.default.log('Syncing provided datasources with extension...');
-            (0, datasources_1.syncProvidedDatasources)({ datasources });
-        }
-    }
-}
-exports.default = Sync;
-Sync.description = 'Synchronize components, datasources or roles with Storyblok space.';
-Sync.examples = [
-    '$ sb-mig sync components --all --ext',
-    '$ sb-mig sync components @storyblok-components/text-block --ext --packageName',
-    '$ sb-mig sync components @storyblok-components/text-block @storyblok-components/button --ext --packageName',
-    '$ sb-mig sync components text-block button --ext',
-    '$ sb-mig sync components text-block button',
-    '$ sb-mig sync roles',
-];
-Sync.flags = {
-    help: command_1.flags.help({ char: 'h' }),
-    all: command_1.flags.boolean({ char: 'a', description: 'Synchronize all components.' }),
-    ext: command_1.flags.boolean({ char: 'e', description: "Synchronize with file extension. Default extension: '.sb.js'" }),
-    packageName: command_1.flags.boolean({ char: 'n', description: 'Synchronize based on installed package name.' }),
-    presets: command_1.flags.boolean({ char: 'p', description: 'Synchronize components with presets.' }),
-    lock: command_1.flags.boolean({ char: 'l', description: 'Synchronize based on storyblok.components.lock.js file' }),
-};
-Sync.strict = false;
-Sync.args = [
-    { name: 'type', description: 'What to synchronize', options: ['components', 'datasources', 'roles'], required: true },
-    { name: 'list', description: 'Space separated list of component names. Example: card product-card row layout' },
-];

package/lib/config/StoryblokComponentsConfig.d.ts

@@ -1,68 +0,0 @@
-export interface IStoryblokComponentConfig {
-    name: string;
-    version: string;
-    modified: boolean;
-    location: string;
-    locationPath: string;
-    scope: string;
-    isLinkedInComponentFile: boolean;
-    isComponentStyleImported: boolean;
-    links: {
-        [name: string]: {
-            [name: string]: string;
-        };
-    };
-}
-export interface IStoryblokComponentsConfig {
-    [name: string]: IStoryblokComponentConfig;
-}
-export interface IInstalledComponents {
-    scope: string | undefined;
-    name: string | undefined;
-}
-export declare enum SWAP_TOKEN {
-    componentImports = "componentImports",
-    componentLists = "componentLists",
-    styleImports = "styleImports"
-}
-interface CreateCrumb {
-    to: string;
-    token: SWAP_TOKEN;
-}
-export declare class StoryblokComponentsConfig {
-    private componentImportsToken;
-    private componentComponentsListToken;
-    private componentStylesImportsToken;
-    private data;
-    private storyblokComponentsConfigUrl;
-    constructor(data: IStoryblokComponentsConfig);
-    updateComponentsConfigFile(): boolean;
-    addComponentsToComponentsConfigFile({ installedComponents, local, }: {
-        installedComponents: IInstalledComponents[];
-        local: boolean;
-    }): IStoryblokComponentsConfig;
-    getAllData(): IStoryblokComponentsConfig;
-    getSingleData(componentName: string): IStoryblokComponentConfig;
-    setAllData(data: IStoryblokComponentsConfig): void;
-    setSingleData(singleComponentData: IStoryblokComponentConfig): void;
-    /**
-     *
-     * Based on storyblok.componnets.lock.js file,
-     * return proper content of specific files
-     * (storyblok-components.componentList.js and storyblok-componnets-styles.scss)
-     */
-    createCrumb({ to, token }: CreateCrumb): any;
-    /**
-     * This updates storyblok components file with imports and
-     * exports of componentList part of the component, based on
-     * storyblok.components.lock file links property
-     */
-    updateStoryblokComponentsFile(): void;
-    /**
-     * This updates storyblok components styles file with style imports
-     * based on storyblok.components.lock file links property
-     */
-    updateStoryblokComponentStylesFile(): void;
-}
-declare const _default: StoryblokComponentsConfig;
-export default _default;

package/lib/config/StoryblokComponentsConfig.js

@@ -1,220 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.StoryblokComponentsConfig = exports.SWAP_TOKEN = void 0;
-const path = require("path");
-const dotenv = require("dotenv");
-const fs_1 = require("fs");
-const camelcase = require("camelcase");
-const config_1 = require("./config");
-const discover2_1 = require("../utils/discover2");
-dotenv.config();
-var SWAP_TOKEN;
-(function (SWAP_TOKEN) {
-    SWAP_TOKEN["componentImports"] = "componentImports";
-    SWAP_TOKEN["componentLists"] = "componentLists";
-    SWAP_TOKEN["styleImports"] = "styleImports";
-})(SWAP_TOKEN = exports.SWAP_TOKEN || (exports.SWAP_TOKEN = {}));
-class StoryblokComponentsConfig {
-    constructor(data) {
-        this.componentImportsToken = '// --- sb-mig scoped component imports ---';
-        this.componentComponentsListToken = '// --- sb-mig scoped component list ---';
-        this.componentStylesImportsToken = '// --- sb-mig scoped component styles imports ---';
-        this.storyblokComponentsConfigUrl = path.resolve(process.cwd(), 'storyblok.components.lock.js');
-        this.data = data;
-    }
-    updateComponentsConfigFile() {
-        const content = `module.exports = ${JSON.stringify(this.data, undefined, 2)}`;
-        fs_1.promises.writeFile(this.storyblokComponentsConfigUrl, content, {
-            encoding: 'utf-8',
-        })
-            .then(result => {
-            console.log('Done');
-            console.log(result);
-            return true;
-        })
-            .catch((err) => {
-            console.log('error, wtf ?');
-            console.log(err.message);
-            return false;
-        });
-        return true;
-    }
-    addComponentsToComponentsConfigFile({ installedComponents, local, }) {
-        return {
-            ...this.data,
-            ...installedComponents.reduce((prev, curr) => {
-                if (!this.getSingleData(`${curr.scope}/${curr.name}`)) {
-                    const stylesFileAvailable = (0, discover2_1.discoverManyStyles)({
-                        fileNames: [curr.name],
-                        scope: discover2_1.SCOPE.all,
-                        type: discover2_1.LOOKUP_TYPE.fileName,
-                    }).length > 0;
-                    return {
-                        ...prev,
-                        [`${curr.scope}/${curr.name}`]: {
-                            name: `${curr.scope}/${curr.name}`,
-                            scope: curr.scope,
-                            location: local ? 'local' : 'node_modules',
-                            locationPath: local ?
-                                `${config_1.default.storyblokComponentsLocalDirectory}/${curr.name}` :
-                                `node_modules/${curr.scope}/${curr.name}`,
-                            links: {
-                                [config_1.default.storyblokComponentsListfile]: {
-                                    '// --- sb-mig scoped component imports ---': local ?
-                                        `import * as Scoped${camelcase(curr.name, { pascalCase: true })} from "./${curr.name}";` :
-                                        `import * as Scoped${camelcase(curr.name, { pascalCase: true })} from "${curr.scope}/${curr.name}";`,
-                                    '// --- sb-mig scoped component list ---': `Scoped${camelcase(curr.name, { pascalCase: true })}.ComponentList`,
-                                },
-                                [config_1.default.componentsStylesMatchFile]: {
-                                    '// --- sb-mig scoped component styles imports ---': stylesFileAvailable ?
-                                        local ?
-                                            `@import './${curr.name}/${curr.name}.scss';` :
-                                            `@import '${curr.scope}/${curr.name}/src/${curr.name}.scss';` :
-                                        '',
-                                },
-                            },
-                        },
-                    };
-                }
-            }, {}),
-        };
-    }
-    getAllData() {
-        return this.data;
-    }
-    getSingleData(componentName) {
-        return this.data[componentName];
-    }
-    setAllData(data) {
-        this.data = {
-            ...data,
-        };
-    }
-    setSingleData(singleComponentData) {
-        this.data[singleComponentData.name] = singleComponentData;
-    }
-    /**
-     *
-     * Based on storyblok.componnets.lock.js file,
-     * return proper content of specific files
-     * (storyblok-components.componentList.js and storyblok-componnets-styles.scss)
-     */
-    createCrumb({ to, token }) {
-        const dataEntries = Object.entries(this.data);
-        let temp;
-        switch (token) {
-            case SWAP_TOKEN.componentImports:
-                temp = dataEntries
-                    .map(component => component[1].links)
-                    .map(component => component[to] !== undefined && component[to])
-                    .filter(elements => elements !== false)
-                    .reduce(
-                // @ts-ignore
-                (acc, curr) => {
-                    return [...acc, curr[this.componentImportsToken]];
-                }, [this.componentImportsToken]);
-                break;
-            case SWAP_TOKEN.componentLists:
-                temp = dataEntries
-                    .map(component => component[1].links)
-                    .map(component => component[to] !== undefined && component[to])
-                    .filter(elements => elements !== false)
-                    .reduce(
-                // @ts-ignore
-                (acc, curr) => {
-                    return [
-                        ...acc,
-                        curr[this.componentComponentsListToken],
-                    ];
-                }, [this.componentComponentsListToken]);
-                break;
-            case SWAP_TOKEN.styleImports:
-                temp = dataEntries
-                    .map(component => component[1].links)
-                    .map(component => component[to] !== undefined && component[to])
-                    .filter(elements => elements !== false)
-                    .reduce(
-                // @ts-ignore
-                (acc, curr) => {
-                    return [
-                        ...acc,
-                        curr[this.componentStylesImportsToken],
-                    ];
-                }, [this.componentStylesImportsToken]);
-                break;
-            default:
-                break;
-        }
-        return temp === null || temp === void 0 ? void 0 : temp.filter((element) => element);
-    }
-    /**
-     * This updates storyblok components file with imports and
-     * exports of componentList part of the component, based on
-     * storyblok.components.lock file links property
-     */
-    updateStoryblokComponentsFile() {
-        // one file
-        const crumb1 = this.createCrumb({
-            to: config_1.default.storyblokComponentsListfile,
-            token: SWAP_TOKEN.componentImports,
-        });
-        const crumb2 = this.createCrumb({
-            to: config_1.default.storyblokComponentsListfile,
-            token: SWAP_TOKEN.componentLists,
-        });
-        let content = `${crumb1.join('\n')}\n`;
-        content = `${content}\nexport default [
-            ${crumb2.shift()}
-            ${crumb2.map((partial) => `${partial},`).join('\n')}
-        ]\n`;
-        // update actual file
-        fs_1.promises.writeFile(config_1.default.storyblokComponentsListfile, content, {
-            encoding: 'utf-8',
-        })
-            .then(result => {
-            console.log('Done');
-            console.log(result);
-            return true;
-        })
-            .catch((err) => {
-            console.log('error, wtf ?');
-            console.log(err.message);
-            return false;
-        });
-    }
-    /**
-     * This updates storyblok components styles file with style imports
-     * based on storyblok.components.lock file links property
-     */
-    updateStoryblokComponentStylesFile() {
-        // one file
-        const crumb1 = this.createCrumb({
-            to: config_1.default.componentsStylesMatchFile,
-            token: SWAP_TOKEN.styleImports,
-        });
-        const content = `${crumb1.join('\n')}\n`;
-        // update actual file
-        fs_1.promises.writeFile(config_1.default.componentsStylesMatchFile, content, {
-            encoding: 'utf-8',
-        })
-            .then(result => {
-            console.log('Done');
-            console.log(result);
-            return true;
-        })
-            .catch((err) => {
-            console.log('error, wtf ?');
-            console.log(err.message);
-            return false;
-        });
-    }
-}
-exports.StoryblokComponentsConfig = StoryblokComponentsConfig;
-let fileContent;
-try {
-    fileContent = require(path.resolve(process.cwd(), 'storyblok.components.lock.js'));
-}
-catch (err) {
-    fileContent = {};
-}
-exports.default = new StoryblokComponentsConfig(fileContent);

package/lib/config/config.d.ts

@@ -1,37 +0,0 @@
-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 | undefined;
-    spaceId: string | undefined;
-    accessToken: string | undefined;
-}
-declare const _default: {
-    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 | undefined;
-    spaceId: string | undefined;
-    accessToken: string | undefined;
-};
-export default _default;

package/lib/config/config.js

@@ -1,36 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const path = require("path");
-const dotenv = require("dotenv");
-dotenv.config();
-let customConfig = {};
-try {
-    customConfig = require(path.resolve(process.cwd(), 'storyblok.config'));
-}
-catch (error) {
-    // default config will be used
-    if (error.code !== 'MODULE_NOT_FOUND')
-        throw error;
-}
-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: process.env.STORYBLOK_OAUTH_TOKEN,
-    spaceId: process.env.STORYBLOK_SPACE_ID,
-    accessToken: process.env.GATSBY_STORYBLOK_ACCESS_TOKEN || process.env.NEXT_STORYBLOK_ACCESS_TOKEN,
-};
-exports.default = {
-    ...defaultConfig,
-    ...customConfig,
-};

package/lib/core.d.ts

@@ -1,16 +0,0 @@
-import Command from '@oclif/command';
-import { IStoryblokConfig } from './config/config';
-import { StoryblokComponentsConfig } from './config/StoryblokComponentsConfig';
-export default abstract class extends Command {
-    storyblokConfig(): IStoryblokConfig;
-    storyblokComponentsConfig(): StoryblokComponentsConfig;
-    files(): {
-        getCurrentDirectoryBase: () => string;
-        isDirectoryExists: (path: string) => boolean;
-        createDir: (dirPath: string) => Promise<void>;
-        createJsonFile: (content: string, pathWithFilename: string) => Promise<void>;
-        copyFolder: (src: string, dest: string) => Promise<unknown>;
-        copyFile: (src: string, dest: string) => Promise<void>;
-    };
-    api(): any;
-}

package/lib/core.js

@@ -1,75 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const command_1 = require("@oclif/command");
-const config_1 = require("./config/config");
-const StoryblokComponentsConfig_1 = require("./config/StoryblokComponentsConfig");
-const files_1 = require("./utils/files");
-const discover_1 = require("./utils/discover");
-const components_1 = require("./api/components");
-const datasources_1 = require("./api/datasources");
-const componentPresets_1 = require("./api/componentPresets");
-const presets_1 = require("./api/presets");
-const migrate_1 = require("./api/migrate");
-const mutateComponents_1 = require("./api/mutateComponents");
-const spaces_1 = require("./api/spaces");
-class default_1 extends command_1.default {
-    storyblokConfig() {
-        return config_1.default;
-    }
-    storyblokComponentsConfig() {
-        return StoryblokComponentsConfig_1.default;
-    }
-    files() {
-        return {
-            getCurrentDirectoryBase: files_1.getCurrentDirectoryBase,
-            isDirectoryExists: files_1.isDirectoryExists,
-            createDir: files_1.createDir,
-            createJsonFile: files_1.createJsonFile,
-            copyFolder: files_1.copyFolder,
-            copyFile: files_1.copyFile,
-        };
-    }
-    api() {
-        return {
-            discover: {
-                findComponents: discover_1.findComponents,
-                findComponentsWithExt: discover_1.findComponentsWithExt,
-                findDatasources: discover_1.findDatasources,
-            },
-            datasources: {
-                getAllDatasources: datasources_1.getAllDatasources,
-                getDatasource: datasources_1.getDatasource,
-                getDatasourceEntries: datasources_1.getDatasourceEntries,
-                createDatasource: datasources_1.createDatasource,
-                createDatasourceEntry: datasources_1.createDatasourceEntry,
-                updateDatasourceEntry: datasources_1.updateDatasourceEntry,
-                updateDatasource: datasources_1.updateDatasource,
-                createDatasourceEntries: datasources_1.createDatasourceEntries,
-                syncDatasources: datasources_1.syncDatasources,
-            },
-            components: {
-                getAllComponents: components_1.getAllComponents,
-                getComponent: components_1.getComponent,
-                getComponentsGroup: components_1.getComponentsGroup,
-                getAllComponentsGroups: components_1.getAllComponentsGroups,
-                createComponentsGroup: components_1.createComponentsGroup,
-                syncComponents: migrate_1.syncComponents,
-                syncAllComponents: migrate_1.syncAllComponents,
-                updateComponent: mutateComponents_1.updateComponent,
-                createComponent: mutateComponents_1.createComponent,
-            },
-            presets: {
-                getComponentPresets: componentPresets_1.getComponentPresets,
-                getPreset: presets_1.getPreset,
-                getAllPresets: presets_1.getAllPresets,
-                createPreset: presets_1.createPreset,
-                updatePreset: presets_1.updatePreset,
-            },
-            spaces: {
-                createSpace: spaces_1.createSpace,
-                getSpace: spaces_1.getSpace,
-            },
-        };
-    }
-}
-exports.default = default_1;

package/lib/index.d.ts

@@ -1 +0,0 @@
-export { run } from "@oclif/command";

package/lib/index.js

@@ -1,5 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.run = void 0;
-var command_1 = require("@oclif/command");
-Object.defineProperty(exports, "run", { enumerable: true, get: function () { return command_1.run; } });