sb-mig 2.9.13 → 3.0.0-beta.1

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; } });

package/lib/types/storyblokTypes.d.ts

@@ -1,171 +0,0 @@
-declare global {
-    interface StoryblokBridgeConfig {
-        initOnlyOnce?: boolean;
-        accessToken?: string;
-    }
-    interface StoryblokEventPayload<S extends StoryblokComponent<string> = any> {
-        action: 'customEvent' | 'published' | 'input' | 'change' | 'unpublished' | 'enterEditmode';
-        event?: string;
-        story?: S;
-        slug?: string;
-        storyId?: string;
-        reload?: boolean;
-    }
-    interface StoryblokBridge {
-        init: (config?: StoryblokBridgeConfig) => void;
-        pingEditor: (callback: (instance: StoryblokBridge) => void) => void;
-        isInEditor: () => boolean;
-        enterEditmode: () => void;
-        on: (event: 'customEvent' | 'published' | 'input' | 'change' | 'unpublished' | 'enterEditmode' | string[], callback: (payload?: StoryblokEventPayload) => void) => void;
-        addComments: (tree: StoryblokComponent<string>, storyId: string) => StoryblokComponent<string>;
-    }
-    interface Window {
-        storyblok: StoryblokBridge;
-        StoryblokCacheVersion: number;
-    }
-}
-import { AxiosInstance, AxiosProxyConfig } from 'axios';
-export interface StoryblokConfig {
-    accessToken?: string;
-    oauthToken?: string;
-    cache?: StoryblokCache;
-    timeout?: number;
-    headers?: any;
-    region?: string;
-    maxRetries?: number;
-    https?: boolean;
-    rateLimit?: number;
-    proxy?: AxiosProxyConfig;
-    componentResolver?: (component: string, data: any) => void;
-}
-export interface StoryblokCache {
-    type?: 'memory';
-    clear?: 'auto' | 'manual';
-}
-export interface StoryblokCacheProvider {
-    get: (key: string) => Promise<StoryblokResult | null> | (StoryblokResult | null);
-    set: (key: string, content: StoryblokResult) => Promise<void> | any;
-    flush: () => Promise<void> | void;
-}
-export interface StoryblokResult {
-    data: any;
-    perPage: number;
-    total: number;
-    headers: any;
-}
-export interface StoryblokManagmentApiResult {
-    data: any;
-    headers: any;
-}
-export interface StoryblokComponent<TComp extends string> {
-    _uid: string;
-    component: TComp;
-    _editable?: string;
-}
-export interface StoryData<Content = StoryblokComponent<string> & {
-    [index: string]: any;
-}> {
-    content: Content;
-    created_at: string;
-    full_slug: string;
-    group_id: string;
-    id: number;
-    is_startpage: boolean;
-    meta_data: any;
-    name: string;
-    parent_id: number;
-    position: number;
-    published_at: string | null;
-    first_published_at: string | null;
-    slug: string;
-    sort_by_date: string | null;
-    tag_list: string[];
-    uuid: string;
-}
-export interface AlternateObject {
-    id: number;
-    name: string;
-    slug: string;
-    published: boolean;
-    full_slug: string;
-    is_folder: boolean;
-    parent_id: number;
-}
-export interface Stories {
-    data: {
-        stories: StoryData[];
-    };
-    perPage: number;
-    total: number;
-    headers: any;
-}
-export interface Story {
-    data: {
-        story: StoryData;
-    };
-    headers: any;
-}
-export interface StoriesParams {
-    token?: string;
-    with_tag?: string;
-    is_startpage?: 0 | 1;
-    starts_with?: string;
-    by_uuids?: string;
-    by_uuids_ordered?: string;
-    excluding_ids?: string;
-    excluding_fields?: string;
-    resolve_links?: 'url' | 'story' | '0' | '1';
-    version?: 'draft' | 'published';
-    resolve_relations?: string;
-    cv?: number;
-    sort_by?: string;
-    search_term?: string;
-    filter_query?: any;
-    per_page?: number;
-    page?: string;
-    from_release?: string;
-    fallback_language?: string;
-    first_published_at_gt?: string;
-    first_published_at_lt?: string;
-    published_at_gt?: string;
-    published_at_lt?: string;
-}
-export interface StoryParams {
-    token?: string;
-    find_by?: 'uuid';
-    version?: 'draft' | 'published';
-    resolve_links?: 'url' | 'story' | '0' | '1';
-    resolve_relations?: string;
-    cv?: number;
-    from_release?: string;
-}
-export interface Richtext {
-    content: Array<Object>;
-}
-export interface RichtextInstance {
-    render: (data: Richtext) => string;
-}
-declare class Storyblok {
-    throttle: any;
-    cacheVersion: number;
-    accessToken: string;
-    cache: StoryblokCache;
-    client: AxiosInstance;
-    richTextResolver: RichtextInstance;
-    constructor(config: StoryblokConfig, endpoint?: string);
-    get(slug: string, params?: any): Promise<StoryblokResult>;
-    getAll(slug: string, params?: any, entity?: string): Promise<any[]>;
-    post(slug: string, params?: any): Promise<StoryblokManagmentApiResult>;
-    put(slug: string, params?: any): Promise<StoryblokManagmentApiResult>;
-    delete(slug: string, params?: any): Promise<StoryblokManagmentApiResult>;
-    getStories(params?: StoriesParams): Promise<Stories>;
-    getStory(slug: string, params?: StoryParams): Promise<Story>;
-    setToken(token: string): void;
-    getToken(): string;
-    cacheResponse(url: string, params: any): Promise<StoryblokResult>;
-    newVersion(): number;
-    cacheProvider(): StoryblokCacheProvider;
-    flushCache(): Promise<this>;
-    setComponentResolver(renderFunction: (component: string, data: any) => void): void;
-}
-export default Storyblok;

package/lib/types/storyblokTypes.js

@@ -1,3 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.default = Storyblok;

package/lib/utils/discover.d.ts

@@ -1,4 +0,0 @@
-export declare const findComponents: (componentDirectory: string) => any[];
-export declare const findComponentsWithExt: (ext: string | boolean) => any[];
-export declare const findComponentsByPackageName: (ext: string | boolean, specifiedComponents: string[], local?: boolean | undefined) => any[];
-export declare const findDatasources: () => any[];

package/lib/utils/discover.js

@@ -1,96 +0,0 @@
-"use strict";
-// component resolution file borrowed from great storyblok-migrate
-// https://github.com/maoberlehner/storyblok-migrate
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.findDatasources = exports.findComponentsByPackageName = exports.findComponentsWithExt = exports.findComponents = void 0;
-const glob = require("glob");
-const path = require("path");
-const config_1 = require("../config/config");
-const findComponents = (componentDirectory) => {
-    const directory = path.resolve(process.cwd(), componentDirectory);
-    return glob
-        .sync(path.join(directory, '**', '!(_*|*.datasource)*.js'))
-        .map(file => require(path.resolve(directory, file)));
-};
-exports.findComponents = findComponents;
-const findComponentsWithExt = (ext) => {
-    const rootDirectory = './';
-    const directory = path.resolve(process.cwd(), rootDirectory);
-    const files = glob
-        .sync(path.join(`${directory}/{${config_1.default.componentsDirectories.join(',')}}`, '**', `[^_]*.${ext}`), {
-        follow: true,
-    })
-        .map(file => require(path.resolve(directory, file)));
-    const fileNames = files.map(file => file.name);
-    return files;
-};
-exports.findComponentsWithExt = findComponentsWithExt;
-const findComponentsByPackageName = (ext, specifiedComponents, local) => {
-    const rootDirectory = './';
-    const directory = path.resolve(process.cwd(), rootDirectory);
-    // @ts-ignore
-    if (local === true) {
-        const onlyLocalComponentsDirectories = config_1.default.componentsDirectories.filter(dir => !dir.includes('node_modules'));
-        const onlyLocalPackages = glob.sync(path.join(`${directory}/{${onlyLocalComponentsDirectories.join(',')}}`, '**', 'package.json'), {
-            follow: true,
-        });
-        return onlyLocalPackages
-            .filter(file => {
-            return specifiedComponents.includes(require(path.resolve(directory, file)).name);
-        })
-            .map(file => {
-            const fileFolderPath = file.split('/').slice(0, -1).join('/');
-            return glob
-                .sync(path.join(`${fileFolderPath}`, '**', `[^_]*.${ext}`), {
-                follow: true,
-            })
-                .map(file => require(path.resolve(directory, file)).name);
-        })
-            .flat();
-    }
-    if (local === false) {
-        const onlyNodeModulesPackagesComponentsDirectories = config_1.default.componentsDirectories.filter(dir => dir.includes('node_modules'));
-        const onlyNodeModulesPackages = glob.sync(path.join(`${directory}/{${onlyNodeModulesPackagesComponentsDirectories.join(',')}}`, '**', 'package.json'), {
-            follow: true,
-        });
-        return onlyNodeModulesPackages
-            .filter(file => {
-            return specifiedComponents.includes(require(path.resolve(directory, file)).name);
-        })
-            .map(file => {
-            const fileFolderPath = file.split('/').slice(0, -1).join('/');
-            return glob
-                .sync(path.join(`${fileFolderPath}`, '**', `[^_]*.${ext}`), {
-                follow: true,
-            })
-                .map(file => require(path.resolve(directory, file)).name);
-        })
-            .flat();
-    }
-    return glob
-        .sync(path.join(`${directory}/{${config_1.default.componentsDirectories.join(',')}}`, '**', 'package.json'), {
-        follow: true,
-    })
-        .filter(file => {
-        return specifiedComponents.includes(require(path.resolve(directory, file)).name);
-    })
-        .map(file => {
-        const fileFolderPath = file.split('/').slice(0, -1).join('/');
-        return glob
-            .sync(path.join(`${fileFolderPath}`, '**', `[^_]*.${ext}`), {
-            follow: true,
-        })
-            .map(file => require(path.resolve(directory, file)).name);
-    })
-        .flat();
-};
-exports.findComponentsByPackageName = findComponentsByPackageName;
-const findDatasources = () => {
-    const rootDirectory = './';
-    const directory = path.resolve(process.cwd(), rootDirectory);
-    return (glob
-        .sync(path.join(`${directory}/${config_1.default.datasourcesDirectory}`, '**', '[^_]*.sb.datasource.js'))
-        // eslint-disable-next-line global-require, import/no-dynamic-require
-        .map(file => require(path.resolve(directory, file))));
-};
-exports.findDatasources = findDatasources;

package/lib/utils/files.js

@@ -1,54 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.copyFile = exports.copyFolder = exports.createJsonFile = exports.createDir = exports.isDirectoryExists = exports.getCurrentDirectoryBase = void 0;
-const fs = require("fs");
-const ncp_1 = require("ncp");
-const path = require("path");
-const logger_1 = require("./logger");
-const getCurrentDirectoryBase = () => path.basename(process.cwd());
-exports.getCurrentDirectoryBase = getCurrentDirectoryBase;
-const isDirectoryExists = (path) => fs.existsSync(path);
-exports.isDirectoryExists = isDirectoryExists;
-const createDir = async (dirPath) => {
-    await fs.promises.mkdir(`${process.cwd()}/${dirPath}`, {
-        recursive: true,
-    });
-};
-exports.createDir = createDir;
-const createJsonFile = async (content, pathWithFilename) => {
-    await fs.promises.writeFile(pathWithFilename, content, { flag: 'w' });
-};
-exports.createJsonFile = createJsonFile;
-const copyFolder = async (src, dest) => {
-    return new Promise((resolve, reject) => {
-        (0, ncp_1.ncp)(src, dest, function (err) {
-            if (err) {
-                reject({
-                    failed: true,
-                    message: `${src} copied unsuccessfully.`,
-                });
-            }
-            resolve({
-                failed: false,
-                message: `${src} copied successfully.`,
-            });
-        });
-    });
-};
-exports.copyFolder = copyFolder;
-const copyFile = async (src, dest) => {
-    const directory = dest.split('/').slice(0, dest.split('/').length - 1);
-    const fileName = src.split('/')[src.split('/').length - 1];
-    if (!(0, exports.isDirectoryExists)(directory.join('/'))) {
-        await (0, exports.createDir)(directory.join('/'));
-    }
-    fs.copyFile(src, dest, err => {
-        if (err) {
-            logger_1.default.error(`There is no file to copy, named ${fileName}`);
-            console.log(err);
-            return false;
-        }
-        console.log(`${fileName} was copied to ${dest}`);
-    });
-};
-exports.copyFile = copyFile;

package/lib/utils/others.js

@@ -1,5 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.generateDatestamp = void 0;
-const generateDatestamp = (datestamp) => `${datestamp.getFullYear()}-${datestamp.getMonth()}-${datestamp.getDay()}_${datestamp.getTime()}`;
-exports.generateDatestamp = generateDatestamp;

package/oclif.manifest.json

@@ -1 +0,0 @@
-{"version":"2.9.13","commands":{"backup":{"id":"backup","description":"Command for backing up anything related to Storyblok","pluginName":"sb-mig","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false},"allComponents":{"name":"allComponents","type":"boolean","char":"a","description":"Backup all components.","allowNo":false},"oneComponent":{"name":"oneComponent","type":"option","char":"o","description":"Backup one component by name."},"allComponentsGroups":{"name":"allComponentsGroups","type":"boolean","char":"g","description":"Backup all components groups.","allowNo":false},"oneComponentsGroup":{"name":"oneComponentsGroup","type":"option","char":"f","description":"Backup one components group by name."},"oneComponentPresets":{"name":"oneComponentPresets","type":"option","char":"p","description":"Backup all presets for one component"},"allPresets":{"name":"allPresets","type":"boolean","char":"l","description":"Backup all presets.","allowNo":false},"onePreset":{"name":"onePreset","type":"option","char":"i","description":"Backup one preset by id."},"allDatasources":{"name":"allDatasources","type":"boolean","char":"d","description":"Backup all datasources.","allowNo":false},"oneDatasource":{"name":"oneDatasource","type":"option","char":"x","description":"Backup one datasource by name."},"datasourceEntries":{"name":"datasourceEntries","type":"option","char":"e","description":"Backup one datasource entries by datasource name."},"allRoles":{"name":"allRoles","type":"boolean","char":"R","description":"Backup all roles and permissions.","allowNo":false},"oneRole":{"name":"oneRole","type":"option","char":"r","description":"Backup one role by name."}},"args":[]},"debug":{"id":"debug","description":"Output extra debugging","pluginName":"sb-mig","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false}},"args":[]},"sync":{"id":"sync","description":"Synchronize components, datasources or roles with Storyblok space.","pluginName":"sb-mig","pluginType":"core","aliases":[],"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"],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false},"all":{"name":"all","type":"boolean","char":"a","description":"Synchronize all components.","allowNo":false},"ext":{"name":"ext","type":"boolean","char":"e","description":"Synchronize with file extension. Default extension: '.sb.js'","allowNo":false},"packageName":{"name":"packageName","type":"boolean","char":"n","description":"Synchronize based on installed package name.","allowNo":false},"presets":{"name":"presets","type":"boolean","char":"p","description":"Synchronize components with presets.","allowNo":false},"lock":{"name":"lock","type":"boolean","char":"l","description":"Synchronize based on storyblok.components.lock.js file","allowNo":false}},"args":[{"name":"type","description":"What to synchronize","required":true,"options":["components","datasources","roles"]},{"name":"list","description":"Space separated list of component names. Example: card product-card row layout"}]}}}