sb-mig 2.9.0 → 2.9.13

package/README.md

@@ -302,6 +302,7 @@ COMMANDS
 * [`sb-mig debug`](#sb-mig-debug)
 * [`sb-mig help [COMMAND]`](#sb-mig-help-command)
 * [`sb-mig plugins`](#sb-mig-plugins)
+* [`sb-mig plugins:inspect PLUGIN...`](#sb-mig-pluginsinspect-plugin)
 * [`sb-mig plugins:install PLUGIN...`](#sb-mig-pluginsinstall-plugin)
 * [`sb-mig plugins:link PLUGIN`](#sb-mig-pluginslink-plugin)
 * [`sb-mig plugins:uninstall PLUGIN...`](#sb-mig-pluginsuninstall-plugin)
@@ -313,6 +314,8 @@ COMMANDS
 Command for backing up anything related to Storyblok
 
 ```
+Command for backing up anything related to Storyblok
+
 USAGE
   $ sb-mig backup
 
@@ -332,13 +335,15 @@ OPTIONS
   -x, --oneDatasource=oneDatasource              Backup one datasource by name.
 ```
 
-_See code: [src/commands/backup.ts](https://github.com/sb-mig/sb-mig/blob/v2.9.0/src/commands/backup.ts)_
+_See code: [lib/commands/backup.js](https://github.com/sb-mig/sb-mig/blob/v2.9.13/lib/commands/backup.js)_
 
 ## `sb-mig debug`
 
 Output extra debugging
 
 ```
+Output extra debugging
+
 USAGE
   $ sb-mig debug
 
@@ -346,13 +351,15 @@ OPTIONS
   -h, --help  show CLI help
 ```
 
-_See code: [src/commands/debug.ts](https://github.com/sb-mig/sb-mig/blob/v2.9.0/src/commands/debug.ts)_
+_See code: [lib/commands/debug.js](https://github.com/sb-mig/sb-mig/blob/v2.9.13/lib/commands/debug.js)_
 
 ## `sb-mig help [COMMAND]`
 
 display help for sb-mig
 
 ```
+display help for <%= config.bin %>
+
 USAGE
   $ sb-mig help [COMMAND]
 
@@ -367,35 +374,68 @@ _See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v2.2.3
 
 ## `sb-mig plugins`
 
-list installed plugins
+List installed plugins.
 
 ```
+List installed plugins.
+
 USAGE
   $ sb-mig plugins
 
 OPTIONS
-  --core  show core plugins
+  --core  Show core plugins.
 
 EXAMPLE
   $ sb-mig plugins
 ```
 
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v1.9.0/src/commands/plugins/index.ts)_
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v2.0.11/src/commands/plugins/index.ts)_
+
+## `sb-mig plugins:inspect PLUGIN...`
+
+Displays installation properties of a plugin.
+
+```
+Displays installation properties of a plugin.
+
+USAGE
+  $ sb-mig plugins:inspect PLUGIN...
+
+ARGUMENTS
+  PLUGIN  [default: .] Plugin to inspect.
+
+OPTIONS
+  -h, --help     Show CLI help.
+  -v, --verbose
+
+EXAMPLE
+  $ sb-mig plugins:inspect myplugin
+```
+
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v2.0.11/src/commands/plugins/inspect.ts)_
 
 ## `sb-mig plugins:install PLUGIN...`
 
-installs a plugin into the CLI
+Installs a plugin into the CLI.
 
 ```
+Installs a plugin into the CLI.
+Can be installed from npm or a git url.
+
+Installation of a user-installed plugin will override a core plugin.
+
+e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in the CLI without the need to patch and update the whole CLI.
+
+
 USAGE
   $ sb-mig plugins:install PLUGIN...
 
 ARGUMENTS
-  PLUGIN  plugin to install
+  PLUGIN  Plugin to install.
 
 OPTIONS
-  -f, --force    yarn install with force flag
-  -h, --help     show CLI help
+  -f, --force    Run yarn install with force flag.
+  -h, --help     Show CLI help.
   -v, --verbose
 
 DESCRIPTION
@@ -416,13 +456,19 @@ EXAMPLES
   $ sb-mig plugins:install someuser/someplugin
 ```
 
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v1.9.0/src/commands/plugins/install.ts)_
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v2.0.11/src/commands/plugins/install.ts)_
 
 ## `sb-mig plugins:link PLUGIN`
 
-links a plugin into the CLI for development
+Links a plugin into the CLI for development.
 
 ```
+Links a plugin into the CLI for development.
+Installation of a linked plugin will override a user-installed or core plugin.
+
+e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello' command will override the user-installed or core plugin implementation. This is useful for development work.
+
+
 USAGE
   $ sb-mig plugins:link PLUGIN
 
@@ -430,7 +476,7 @@ ARGUMENTS
   PATH  [default: .] path to plugin
 
 OPTIONS
-  -h, --help     show CLI help
+  -h, --help     Show CLI help.
   -v, --verbose
 
 DESCRIPTION
@@ -443,13 +489,15 @@ EXAMPLE
   $ sb-mig plugins:link myplugin
 ```
 
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v1.9.0/src/commands/plugins/link.ts)_
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v2.0.11/src/commands/plugins/link.ts)_
 
 ## `sb-mig plugins:uninstall PLUGIN...`
 
-removes a plugin from the CLI
+Removes a plugin from the CLI.
 
 ```
+Removes a plugin from the CLI.
+
 USAGE
   $ sb-mig plugins:uninstall PLUGIN...
 
@@ -457,7 +505,7 @@ ARGUMENTS
   PLUGIN  plugin to uninstall
 
 OPTIONS
-  -h, --help     show CLI help
+  -h, --help     Show CLI help.
   -v, --verbose
 
 ALIASES
@@ -465,28 +513,32 @@ ALIASES
   $ sb-mig plugins:remove
 ```
 
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v1.9.0/src/commands/plugins/uninstall.ts)_
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v2.0.11/src/commands/plugins/uninstall.ts)_
 
 ## `sb-mig plugins:update`
 
-update installed plugins
+Update installed plugins.
 
 ```
+Update installed plugins.
+
 USAGE
   $ sb-mig plugins:update
 
 OPTIONS
-  -h, --help     show CLI help
+  -h, --help     Show CLI help.
   -v, --verbose
 ```
 
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v1.9.0/src/commands/plugins/update.ts)_
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v2.0.11/src/commands/plugins/update.ts)_
 
 ## `sb-mig sync TYPE [LIST]`
 
 Synchronize components, datasources or roles with Storyblok space.
 
 ```
+Synchronize components, datasources or roles with Storyblok space.
+
 USAGE
   $ sb-mig sync TYPE [LIST]
 
@@ -511,7 +563,7 @@ EXAMPLES
   $ sb-mig sync roles
 ```
 
-_See code: [src/commands/sync.ts](https://github.com/sb-mig/sb-mig/blob/v2.9.0/src/commands/sync.ts)_
+_See code: [lib/commands/sync.js](https://github.com/sb-mig/sb-mig/blob/v2.9.13/lib/commands/sync.js)_
 <!-- commandsstop -->
 
 # Plugins

package/lib/api/componentPresets.d.ts

@@ -1 +1 @@
-export declare const getComponentPresets: (componentName: string) => Promise<false | [unknown, unknown, unknown, unknown, unknown, unknown, unknown, unknown, unknown, unknown]>;
+export declare const getComponentPresets: (componentName: string) => Promise<false | any[]>;

package/lib/api/componentPresets.js

@@ -4,22 +4,19 @@ exports.getComponentPresets = void 0;
 const logger_1 = require("../utils/logger");
 const components_1 = require("./components");
 const presets_1 = require("./presets");
-exports.getComponentPresets = (componentName) => {
+const getComponentPresets = (componentName) => {
     logger_1.default.log(`Trying to get all '${componentName}' presets.`);
-    return components_1.getAllComponents().then(async (res) => {
+    return (0, components_1.getAllComponents)().then(async (res) => {
         const componentPresets = res.components.filter((component) => component.name === componentName);
         if (componentPresets.length > 0) {
             if (componentPresets[0].all_presets.length === 0) {
                 logger_1.default.warning(`There is no presets for: '${componentName}' component`);
                 return false;
             }
-            else {
-                return Promise.all(componentPresets[0].all_presets.map((preset) => presets_1.getPreset(preset.id).catch((err) => logger_1.default.error(err))));
-            }
-        }
-        else {
-            logger_1.default.warning(`There is no '${componentName}' component`);
-            return false;
+            return Promise.all(componentPresets[0].all_presets.map((preset) => (0, presets_1.getPreset)(preset.id).catch((err) => logger_1.default.error(err))));
         }
+        logger_1.default.warning(`There is no '${componentName}' component`);
+        return false;
     });
 };
+exports.getComponentPresets = getComponentPresets;

package/lib/api/components.js

@@ -6,49 +6,53 @@ const config_1 = require("../config/config");
 const apiConfig_1 = require("./apiConfig");
 const { spaceId } = config_1.default;
 // GET
-exports.getAllComponents = () => {
-    logger_1.default.log("Trying to get all components.");
+const getAllComponents = () => {
+    logger_1.default.log('Trying to get all components.');
     return apiConfig_1.sbApi
         .get(`spaces/${spaceId}/components/`)
         .then((res) => res.data)
         .catch((err) => logger_1.default.error(err));
 };
-exports.getComponent = (componentName) => {
+exports.getAllComponents = getAllComponents;
+const getComponent = (componentName) => {
     logger_1.default.log(`Trying to get '${componentName}' component.`);
-    return exports.getAllComponents()
-        .then((res) => res.components.filter((component) => component.name === componentName))
-        .then((res) => {
+    return (0, exports.getAllComponents)()
+        .then(res => res.components.filter((component) => component.name === componentName))
+        .then(res => {
         if (Array.isArray(res) && res.length === 0) {
             logger_1.default.warning(`There is no component named '${componentName}'`);
             return false;
         }
         return res;
     })
-        .catch((err) => logger_1.default.error(err));
+        .catch(err => logger_1.default.error(err));
 };
-exports.getComponentsGroup = (groupName) => {
+exports.getComponent = getComponent;
+const getComponentsGroup = (groupName) => {
     logger_1.default.log(`Trying to get '${groupName}' group.`);
-    return exports.getAllComponentsGroups()
-        .then((res) => {
+    return (0, exports.getAllComponentsGroups)()
+        .then(res => {
         return res.component_groups.filter((group) => group.name === groupName);
     })
-        .then((res) => {
+        .then(res => {
         if (Array.isArray(res) && res.length === 0) {
             logger_1.default.warning(`There is no group named '${groupName}'`);
             return false;
         }
         return res;
     })
-        .catch((err) => logger_1.default.error(err));
+        .catch(err => logger_1.default.error(err));
 };
-exports.getAllComponentsGroups = async () => {
-    logger_1.default.log("Trying to get all groups.");
+exports.getComponentsGroup = getComponentsGroup;
+const getAllComponentsGroups = async () => {
+    logger_1.default.log('Trying to get all groups.');
     return apiConfig_1.sbApi
         .get(`spaces/${spaceId}/component_groups/`)
-        .then((response) => response.data)
-        .catch((err) => logger_1.default.error(err));
+        .then(response => response.data)
+        .catch(err => logger_1.default.error(err));
 };
-exports.createComponentsGroup = (groupName) => {
+exports.getAllComponentsGroups = getAllComponentsGroups;
+const createComponentsGroup = (groupName) => {
     logger_1.default.log(`Trying to create '${groupName}' group`);
     return apiConfig_1.sbApi
         .post(`spaces/${spaceId}/component_groups/`, {
@@ -56,11 +60,12 @@ exports.createComponentsGroup = (groupName) => {
             name: groupName,
         },
     })
-        .then((res) => {
+        .then(res => {
         logger_1.default.warning(`'${groupName}' created with uuid: ${res.data.component_group.uuid}`);
         return res.data;
     })
-        .catch((err) => {
-        logger_1.default.error(`Error happened :()`);
+        .catch(err => {
+        logger_1.default.error('Error happened :()');
     });
 };
+exports.createComponentsGroup = createComponentsGroup;

package/lib/api/datasources.js

@@ -7,12 +7,12 @@ const apiConfig_1 = require("./apiConfig");
 const discover2_1 = require("../utils/discover2");
 const { spaceId } = config_1.default;
 // GET
-exports.getAllDatasources = () => {
-    logger_1.default.log("Trying to get all Datasources.");
+const getAllDatasources = () => {
+    logger_1.default.log('Trying to get all Datasources.');
     return apiConfig_1.sbApi
         .get(`spaces/${spaceId}/datasources/`)
         .then(({ data }) => data)
-        .catch((err) => {
+        .catch(err => {
         if (err.response.status === 404) {
             logger_1.default.error(`There is no datasources in your Storyblok ${spaceId} space.`);
         }
@@ -22,34 +22,37 @@ exports.getAllDatasources = () => {
         }
     });
 };
-exports.getDatasource = (datasourceName) => {
+exports.getAllDatasources = getAllDatasources;
+const getDatasource = (datasourceName) => {
     logger_1.default.log(`Trying to get '${datasourceName}' datasource.`);
-    return exports.getAllDatasources()
-        .then((res) => {
+    return (0, exports.getAllDatasources)()
+        .then(res => {
         if (res) {
             return res.datasources.filter((datasource) => datasource.name === datasourceName);
         }
     })
-        .then((res) => {
+        .then(res => {
         if (Array.isArray(res) && res.length === 0) {
             logger_1.default.warning(`There is no datasource named '${datasourceName}'`);
             return false;
         }
         return res;
     })
-        .catch((err) => logger_1.default.error(err));
+        .catch(err => logger_1.default.error(err));
 };
-exports.getDatasourceEntries = async (datasourceName) => {
+exports.getDatasource = getDatasource;
+const getDatasourceEntries = async (datasourceName) => {
     logger_1.default.log(`Trying to get '${datasourceName}' datasource entries.`);
-    const data = await exports.getDatasource(datasourceName);
+    const data = await (0, exports.getDatasource)(datasourceName);
     if (data) {
         return apiConfig_1.sbApi
             .get(`spaces/${spaceId}/datasource_entries/?datasource_id=${data[0].id}`)
             .then(async ({ data }) => data)
-            .catch((err) => logger_1.default.error(err));
+            .catch(err => logger_1.default.error(err));
     }
 };
-exports.createDatasource = (datasource) => apiConfig_1.sbApi
+exports.getDatasourceEntries = getDatasourceEntries;
+const createDatasource = (datasource) => apiConfig_1.sbApi
     .post(`spaces/${spaceId}/datasources/`, {
     datasource: {
         name: datasource.name,
@@ -60,8 +63,9 @@ exports.createDatasource = (datasource) => apiConfig_1.sbApi
     data,
     datasource_entries: datasource.datasource_entries,
 }))
-    .catch((err) => logger_1.default.error(err));
-exports.createDatasourceEntry = (datasourceEntry, datasourceId) => {
+    .catch(err => logger_1.default.error(err));
+exports.createDatasource = createDatasource;
+const createDatasourceEntry = (datasourceEntry, datasourceId) => {
     return apiConfig_1.sbApi
         .post(`spaces/${spaceId}/datasource_entries/`, {
         datasource_entry: {
@@ -73,9 +77,10 @@ exports.createDatasourceEntry = (datasourceEntry, datasourceId) => {
         .then(({ data }) => {
         return data;
     })
-        .catch((err) => logger_1.default.error(err));
+        .catch(err => logger_1.default.error(err));
 };
-exports.updateDatasourceEntry = (datasourceEntry, datasourceId, datasourceToBeUpdated) => {
+exports.createDatasourceEntry = createDatasourceEntry;
+const updateDatasourceEntry = (datasourceEntry, datasourceId, datasourceToBeUpdated) => {
     return apiConfig_1.sbApi
         .put(`spaces/${spaceId}/datasource_entries/${datasourceToBeUpdated.id}`, {
         datasource_entry: {
@@ -88,9 +93,10 @@ exports.updateDatasourceEntry = (datasourceEntry, datasourceId, datasourceToBeUp
         .then(({ data }) => {
         return data;
     })
-        .catch((err) => logger_1.default.error(err));
+        .catch(err => logger_1.default.error(err));
 };
-exports.updateDatasource = (datasource, temp) => apiConfig_1.sbApi
+exports.updateDatasourceEntry = updateDatasourceEntry;
+const updateDatasource = (datasource, temp) => apiConfig_1.sbApi
     .put(`spaces/${spaceId}/datasources/${temp.id}`, {
     datasource: {
         id: temp.id,
@@ -104,83 +110,84 @@ exports.updateDatasource = (datasource, temp) => apiConfig_1.sbApi
         datasource_entries: datasource.datasource_entries,
     };
 })
-    .catch((err) => logger_1.default.error(err));
-exports.createDatasourceEntries = (datasourceId, datasource_entries, remoteDatasourceEntries) => {
+    .catch(err => logger_1.default.error(err));
+exports.updateDatasource = updateDatasource;
+const createDatasourceEntries = (datasourceId, datasource_entries, remoteDatasourceEntries) => {
     Promise.all(datasource_entries.map((datasourceEntry) => {
         const datasourceEntriesToBeUpdated = remoteDatasourceEntries.datasource_entries.find((remoteDatasourceEntry) => remoteDatasourceEntry.name ===
             Object.values(datasourceEntry)[0]);
         if (datasourceEntriesToBeUpdated) {
-            return exports.updateDatasourceEntry(datasourceEntry, datasourceId, datasourceEntriesToBeUpdated);
-        }
-        else {
-            return exports.createDatasourceEntry(datasourceEntry, datasourceId);
+            return (0, exports.updateDatasourceEntry)(datasourceEntry, datasourceId, datasourceEntriesToBeUpdated);
         }
+        return (0, exports.createDatasourceEntry)(datasourceEntry, datasourceId);
     }))
         .then(({ data }) => {
         logger_1.default.success(`Datasource entries for ${datasourceId} datasource id has been successfully synced.`);
         return data;
     })
-        .catch((err) => logger_1.default.error(err));
+        .catch(err => logger_1.default.error(err));
 };
-exports.syncDatasources = async ({ providedDatasources, }) => {
+exports.createDatasourceEntries = createDatasourceEntries;
+const syncDatasources = async ({ providedDatasources, }) => {
     logger_1.default.log(`Trying to sync provided datasources: ${providedDatasources}`);
-    const providedDatasourcesContent = discover2_1.getFilesContent({
+    const providedDatasourcesContent = (0, discover2_1.getFilesContent)({
         files: providedDatasources,
     });
-    const remoteDatasources = await exports.getAllDatasources();
-    Promise.all(providedDatasourcesContent.map((datasource) => {
+    const remoteDatasources = await (0, exports.getAllDatasources)();
+    Promise.all(providedDatasourcesContent.map(datasource => {
         const datasourceToBeUpdated = remoteDatasources.datasources.find((remoteDatasource) => datasource.name === remoteDatasource.name);
         if (datasourceToBeUpdated) {
-            return exports.updateDatasource(datasource, datasourceToBeUpdated);
-        }
-        else {
-            return exports.createDatasource(datasource);
+            return (0, exports.updateDatasource)(datasource, datasourceToBeUpdated);
         }
+        return (0, exports.createDatasource)(datasource);
     }))
-        .then((res) => {
+        .then(res => {
         res.map(async ({ data, datasource_entries }) => {
-            const remoteDatasourceEntries = await exports.getDatasourceEntries(data.datasource.name);
-            exports.createDatasourceEntries(data.datasource.id, datasource_entries, remoteDatasourceEntries);
+            const remoteDatasourceEntries = await (0, exports.getDatasourceEntries)(data.datasource.name);
+            (0, exports.createDatasourceEntries)(data.datasource.id, datasource_entries, remoteDatasourceEntries);
         });
         return res;
     })
-        .catch((err) => {
+        .catch(err => {
         console.log(err);
-        logger_1.default.warning("There is error inside promise.all from datasource");
+        logger_1.default.warning('There is error inside promise.all from datasource');
         return false;
     });
 };
-exports.syncProvidedDatasources = ({ datasources, }) => {
-    const allLocalDatasources = discover2_1.discoverManyDatasources({
+exports.syncDatasources = syncDatasources;
+const syncProvidedDatasources = ({ datasources, }) => {
+    const allLocalDatasources = (0, discover2_1.discoverManyDatasources)({
         scope: discover2_1.SCOPE.local,
         type: discover2_1.LOOKUP_TYPE.fileName,
         fileNames: datasources,
     });
-    const allExternalDatasources = discover2_1.discoverManyDatasources({
+    const allExternalDatasources = (0, discover2_1.discoverManyDatasources)({
         scope: discover2_1.SCOPE.external,
         type: discover2_1.LOOKUP_TYPE.fileName,
         fileNames: datasources,
     });
-    exports.syncDatasources({
+    (0, exports.syncDatasources)({
         providedDatasources: [
             ...allLocalDatasources,
             ...allExternalDatasources,
         ],
     });
 };
-exports.syncAllDatasources = () => {
-    const allLocalDatasources = discover2_1.discoverDatasources({
+exports.syncProvidedDatasources = syncProvidedDatasources;
+const syncAllDatasources = () => {
+    const allLocalDatasources = (0, discover2_1.discoverDatasources)({
         scope: discover2_1.SCOPE.local,
         type: discover2_1.LOOKUP_TYPE.fileName,
     });
-    const allExternalDatasources = discover2_1.discoverDatasources({
+    const allExternalDatasources = (0, discover2_1.discoverDatasources)({
         scope: discover2_1.SCOPE.external,
         type: discover2_1.LOOKUP_TYPE.fileName,
     });
-    exports.syncDatasources({
+    (0, exports.syncDatasources)({
         providedDatasources: [
             ...allLocalDatasources,
             ...allExternalDatasources,
         ],
     });
 };
+exports.syncAllDatasources = syncAllDatasources;

package/lib/api/migrate.d.ts

@@ -4,7 +4,7 @@ interface SyncComponents {
     presets: boolean;
 }
 export declare const sync2Components: ({ specifiedComponents, presets }: SyncComponents) => Promise<void>;
-export declare const syncComponents: (specifiedComponents: string[], ext: string | false, presets: boolean, packageName: boolean, local?: boolean | undefined) => Promise<void>;
+export declare const syncComponents: (specifiedComponents: string[], ext: string | boolean, presets: boolean, packageName: boolean, local?: boolean | undefined) => Promise<void>;
 interface SyncAllComponents {
     presets: boolean;
 }
@@ -15,5 +15,5 @@ interface SyncProvidedComponents {
 }
 export declare const syncProvidedComponents: ({ components, presets, packageName }: SyncProvidedComponents) => void;
 export declare const sync2AllComponents: ({ presets }: SyncAllComponents) => void;
-export declare const syncAllComponents: (ext: string | false, presets: boolean) => void;
+export declare const syncAllComponents: (ext: string | boolean, presets: boolean) => void;
 export {};