sb-mig 4.1.0-beta.9 → 5.0.3

package/README.md

@@ -10,6 +10,21 @@ If you've found an issue or you have feature request - <a href="https://github.c
 [![GitHub issues](https://img.shields.io/github/issues/sb-mig/sb-mig.svg?style=flat-square&v=1)](https://github.com/sb-mig/sb-mig/issues?q=is%3Aopen+is%3Aissue)
 ![npm](https://img.shields.io/npms-io/maintenance-score/sb-mig)
 
+https://docs.sb-mig.com/
+
+
+# Requirements: 
+
+|               |               |
+| ------------- | ------------- |
+| Node          | LTS (18.x.x)  |
+
+
+# Requirements:
+
+|               |               |
+| ------------- | ------------- |
+| Node          | LTS (18.x.x)  |
 
 # 4.x.x version released!
 

package/dist/api/assets/assets.d.ts

@@ -0,0 +1,6 @@
+import type { GetAllAssets, GetAssetById, GetAssetByName, MigrateAsset } from "./assets.types.js";
+export declare const getAllAssets: GetAllAssets;
+export declare const getAssetByName: GetAssetByName;
+export declare const migrateAsset: MigrateAsset;
+export declare const getAssetById: GetAssetById;
+export declare const getAsset: (assetName: string | undefined) => Promise<void>;

package/dist/api/assets/assets.js

@@ -0,0 +1,166 @@
+import fs from "fs";
+import https from "https";
+import path from "path";
+import FormData from "form-data";
+import storyblokConfig from "../../config/config.js";
+import { createDir, isDirectoryExists } from "../../utils/files.js";
+import Logger from "../../utils/logger.js";
+// GET
+export const getAllAssets = async ({ spaceId, search }, config) => {
+    const { sbApi } = config;
+    return sbApi
+        .get(`spaces/${spaceId}/assets/`, {
+        // @ts-ignore TODO: have to submit ISSUE to storyblok-js-client (in documentation it is search, in typescript its search_term STORYBLOK_ISSUE
+        search: search ? search : "",
+        per_page: 100, // need to do pagination here probably
+    })
+        .then(({ data }) => data)
+        .catch((err) => {
+        if (err.response.status === 404) {
+            Logger.error(`There is no assets in your Storyblok ${spaceId} space.`);
+            return true;
+        }
+        else {
+            Logger.error(err);
+            return false;
+        }
+    });
+};
+export const getAssetByName = async ({ spaceId, fileName }, config) => {
+    const result = await getAllAssets({ spaceId, search: fileName }, config);
+    if (result.assets.length === 1) {
+        return result.assets[0];
+    }
+    else {
+        return undefined;
+    }
+};
+const requestSignedUploadUrl = ({ spaceId, payload }, config) => {
+    const { sbApi } = config;
+    const { filename: _1, asset_folder_id, ext_id, space_id, ...restPayload } = payload;
+    const filename = getFileName(payload.filename);
+    const size = getSizeFromURL(payload.filename);
+    return sbApi
+        .post(`spaces/${spaceId}/assets/`, {
+        filename,
+        size,
+        ...restPayload,
+    })
+        .then((signedResponseObject) => {
+        if (storyblokConfig.debug) {
+            Logger.log(`Signed upload URL has been requested for ${filename}.`);
+        }
+        return signedResponseObject.data; // this is very bad... but storyblok-js-client types are pretty broken
+    })
+        .catch((err) => {
+        console.log(err);
+    });
+};
+const uploadFile = ({ signedResponseObject, pathToFile }) => {
+    const file = pathToFile;
+    const form = new FormData();
+    // apply all fields from the signed response object to the second request
+    for (const key in signedResponseObject.fields) {
+        form.append(key, signedResponseObject.fields[key]);
+    }
+    // also append the file read stream
+    form.append("file", fs.createReadStream(file));
+    // submit your form
+    form.submit(signedResponseObject.post_url, async (err, res) => {
+        const statusCode = res.statusCode;
+        if (statusCode === 204) {
+            Logger.upload(`Asset uploaded ${getFileName(file)}`);
+        }
+        else {
+            if (err)
+                throw err;
+        }
+    });
+};
+const getFileName = (fileUrl) => {
+    const fileName = fileUrl.split("/").pop();
+    if (fileName) {
+        return fileName;
+    }
+    else {
+        throw Error("File name couldn't be extracted from URL.");
+    }
+};
+const getSizeFromURL = (fileUrl) => {
+    const data = fileUrl.split("/");
+    const sizePos = data.length - 3;
+    return data[sizePos];
+};
+const downloadAsset = async ({ payload }) => {
+    const fileName = getFileName(payload.filename);
+    const fileUrl = payload.filename;
+    const downloadedAssetsFolder = path.join(storyblokConfig.sbmigWorkingDirectory, "downloadedAssets");
+    Logger.log(`Downloading ${fileName} asset ${storyblokConfig.debug
+        ? `from ${fileUrl} to ${downloadedAssetsFolder}`
+        : ""}`);
+    if (!isDirectoryExists(downloadedAssetsFolder)) {
+        await createDir(downloadedAssetsFolder);
+    }
+    return new Promise((resolve, reject) => {
+        const file = fs.createWriteStream(path.join(downloadedAssetsFolder, fileName));
+        https
+            .get(fileUrl, (response) => {
+            response.pipe(file);
+            file.on("finish", () => {
+                file.close();
+                Logger.download(`Asset downloaded to ${path.join(downloadedAssetsFolder, fileName)}`);
+                resolve(path.join(downloadedAssetsFolder, fileName));
+            });
+        })
+            .on("error", (error) => {
+            Logger.error(`Error downloading image: ${error.message}`);
+            reject("error");
+        });
+    });
+};
+export const migrateAsset = async ({ migrateTo, payload, syncDirection }, config) => {
+    const pathToFile = await downloadAsset({ payload });
+    if (syncDirection === "fromSpaceToSpace") {
+        const signedResponseObject = await requestSignedUploadUrl({
+            spaceId: migrateTo,
+            payload,
+        }, config);
+        if (pathToFile) {
+            await uploadFile({ signedResponseObject, pathToFile });
+        }
+    }
+    return true;
+};
+// GET
+export const getAssetById = async ({ spaceId, assetId }, config) => {
+    const { sbApi } = config;
+    Logger.log(`Trying to get '${assetId}' asset.`);
+    return sbApi
+        .get(`spaces/${spaceId}/assets/${assetId}`)
+        .then(({ data }) => data)
+        .catch((err) => {
+        if (err.response.status === 404) {
+            Logger.error(`There is no assets in your Storyblok ${spaceId} space.`);
+            return true;
+        }
+        else {
+            Logger.error(err);
+            return false;
+        }
+    });
+};
+export const getAsset = async (assetName) => {
+    Logger.log(`Trying to get '${assetName}' asset.`);
+    // return getAllAssets()
+    //     .then((res) =>
+    //         res.space_roles.filter((role: any) => role.role === assetName)
+    //     )
+    //     .then((res) => {
+    //         if (Array.isArray(res) && res.length === 0) {
+    //             Logger.warning(`There is no role named '${assetName}'`);
+    //             return false;
+    //         }
+    //         return res;
+    //     })
+    //     .catch((err) => Logger.error(err));
+};

package/dist/api/assets/assets.types.d.ts

@@ -0,0 +1,65 @@
+import type { SyncDirection } from "../../cli/sync.types.js";
+import type { RequestBaseConfig } from "../utils/request.js";
+export type AssetTypes = "image/png" | "image/jpg" | `${string}/${string}`;
+export interface SBAsset {
+    id: number;
+    filename: string;
+    space_id: number;
+    created_at: string;
+    updated_at: string;
+    asset_folder_id?: null;
+    deleted_at: null;
+    content_length: number;
+    content_type: AssetTypes;
+    alt: string;
+    copyright: string;
+    title: string;
+    focus: string;
+    ext_id: any | null;
+    expire_at: any | null;
+    source: string;
+    internal_tag_ids: any[];
+    locked: boolean;
+    is_private: boolean;
+    publish_at: any | null;
+    meta_data: any;
+    internal_tags_list: any[];
+}
+export interface SBAssetById {
+    file: any | null;
+    short_file_name: string;
+    permanently_deleted: boolean;
+}
+export interface SBAllAssetRequestResult {
+    assets: SBAsset[];
+}
+export type SignedResponseObject = any;
+export type AssetPayload = Omit<SBAsset, "updated_at" | "created_at" | "id">;
+export type GetAllAssets = ({ spaceId, }: {
+    spaceId: string;
+    search?: string;
+}, config: RequestBaseConfig) => Promise<SBAllAssetRequestResult>;
+export type GetAssetByName = ({ spaceId, fileName, }: {
+    spaceId: string;
+    fileName: string;
+}, config: RequestBaseConfig) => Promise<SBAsset | undefined>;
+export type GetAssetById = ({ spaceId, assetId, }: {
+    spaceId: string;
+    assetId: number;
+}, config: RequestBaseConfig) => Promise<(SBAsset & SBAssetById) | undefined>;
+export type MigrateAsset = ({ migrateTo, payload, syncDirection, }: {
+    migrateTo: string;
+    payload: AssetPayload;
+    syncDirection: SyncDirection;
+}, config: RequestBaseConfig) => Promise<boolean>;
+export type UploadFile = ({ signedResponseObject, pathToFile, }: {
+    signedResponseObject: SignedResponseObject;
+    pathToFile: string;
+}) => void;
+export type FinalizeUpload = ({ signedResponseObject, }: {
+    signedResponseObject: SignedResponseObject;
+}) => void;
+export type RequestSignedUploadUrl = ({ spaceId, payload, }: {
+    spaceId: string;
+    payload: AssetPayload;
+}, config: RequestBaseConfig) => Promise<any>;

package/dist/api/assets/assets.types.js

@@ -0,0 +1 @@
+export {};

package/dist/api/assets/index.d.ts

@@ -0,0 +1 @@
+export { getAllAssets, migrateAsset, getAsset, getAssetById, getAssetByName, } from "./assets.js";

package/dist/api/assets/index.js

@@ -0,0 +1 @@
+export { getAllAssets, migrateAsset, getAsset, getAssetById, getAssetByName, } from "./assets.js";

package/dist/api/auth/auth.d.ts

@@ -0,0 +1,3 @@
+import type { GetCurrentUser, HasAccessToSpace } from "./auth.types.js";
+export declare const getCurrentUser: GetCurrentUser;
+export declare const hasAccessToSpace: HasAccessToSpace;

package/dist/api/auth/auth.js

@@ -0,0 +1,23 @@
+import { getAllSpaces } from "../spaces/spaces.js";
+export const getCurrentUser = async (config) => {
+    const { sbApi } = config;
+    console.log("Trying to get current user current OAuthToken");
+    const currentUser = await sbApi
+        .get(`users/me`, {
+        per_page: 100,
+    })
+        .then((res) => {
+        return res.data.user;
+    })
+        .catch((err) => {
+        console.error(err);
+        return err;
+    });
+    return currentUser;
+};
+export const hasAccessToSpace = async (args, config) => {
+    const { spaceId } = args;
+    const allSpaces = await getAllSpaces(config);
+    const hasAccess = allSpaces.find((space) => Number(space.id) === Number(spaceId));
+    return !!hasAccess;
+};

package/dist/api/auth/auth.types.d.ts

@@ -0,0 +1,43 @@
+import type { RequestBaseConfig } from "../utils/request.js";
+import type { ISbResult } from "storyblok-js-client/src/interfaces";
+export interface Org {
+}
+export interface CurrentUserResult extends ISbResult {
+    data: {
+        user: {
+            userid: string;
+            email: string;
+            organization: string;
+            username?: string;
+            use_username: boolean;
+            alt_email: string;
+            firstname: string;
+            lastname: string;
+            phone?: number;
+            id: number;
+            login_strategy: "password" | string;
+            created_at: string;
+            org_role: "member" | string;
+            has_org: boolean;
+            has_partner: boolean;
+            org: Org[];
+            timezone: "UTC" | string;
+            avatar?: any;
+            friendly_name: string;
+            notified: any[];
+            lang: string;
+            partner_role: "partner_owner" | string;
+            favourite_spaces: any[];
+            role: "sso" | string;
+            beta_user: boolean;
+            track_statistics: boolean;
+            is_editor: boolean;
+            sso: boolean;
+            job_role?: any;
+        };
+    };
+}
+export type GetCurrentUser = (config: RequestBaseConfig) => Promise<any>;
+export type HasAccessToSpace = (args: {
+    spaceId: string;
+}, config: RequestBaseConfig) => Promise<boolean>;

package/dist/api/auth/auth.types.js

@@ -0,0 +1 @@
+export {};

package/dist/api/auth/index.d.ts

@@ -0,0 +1 @@
+export { getCurrentUser, hasAccessToSpace } from "./auth.js";

package/dist/api/auth/index.js

@@ -0,0 +1 @@
+export { getCurrentUser, hasAccessToSpace } from "./auth.js";

package/dist/api/components/components.d.ts

@@ -0,0 +1,10 @@
+import type { CreateComponent, CreateComponentsGroup, GetAllComponents, GetAllComponentsGroups, GetComponent, GetComponentsGroup, RemoveComponent, RemoveComponentGroup, UpdateComponent } from "./components.types.js";
+export declare const getAllComponents: GetAllComponents;
+export declare const getComponent: GetComponent;
+export declare const createComponent: CreateComponent;
+export declare const updateComponent: UpdateComponent;
+export declare const removeComponent: RemoveComponent;
+export declare const getAllComponentsGroups: GetAllComponentsGroups;
+export declare const getComponentsGroup: GetComponentsGroup;
+export declare const removeComponentGroup: RemoveComponentGroup;
+export declare const createComponentsGroup: CreateComponentsGroup;

package/dist/api/components/components.js

@@ -0,0 +1,170 @@
+import Logger from "../../utils/logger.js";
+import _resolvePresets from "../presets/resolvePresets.js";
+import { getAllItemsWithPagination } from "../utils/request.js";
+/*
+ *
+ * GET ALL components
+ *
+ * */
+export const getAllComponents = (config) => {
+    const { spaceId, sbApi } = config;
+    Logger.log("Trying to get all components.");
+    return getAllItemsWithPagination({
+        apiFn: ({ per_page, page }) => sbApi
+            .get(`spaces/${spaceId}/components/`, { per_page, page })
+            .then((res) => {
+            Logger.log(`Amount of components: ${res.total}`);
+            return res;
+        })
+            .catch((err) => console.error(err)),
+        params: {
+            spaceId,
+        },
+        itemsKey: "components",
+    });
+};
+/*
+ *
+ * GET ONE component
+ *
+ * */
+export const getComponent = (componentName, config) => {
+    Logger.log(`Trying to get '${componentName}' component.`);
+    return getAllComponents(config)
+        .then((res) => res.filter((component) => component.name === componentName))
+        .then((res) => {
+        if (Array.isArray(res) && res.length === 0) {
+            console.info(`There is no component named '${componentName}'`);
+            return false;
+        }
+        return res;
+    })
+        .catch((err) => console.error(err));
+};
+// CREATE
+export const createComponent = (component, presets, config) => {
+    const { spaceId, sbApi } = config;
+    Logger.log(`Trying to create '${component.name}'`);
+    const componentWithPresets = component;
+    const { all_presets, ...componentWithoutPresets } = componentWithPresets;
+    sbApi
+        .post(`spaces/${spaceId}/components/`, {
+        component: componentWithoutPresets,
+    })
+        .then((res) => {
+        Logger.success(`Component '${component.name}' has been created.`);
+        if (presets) {
+            _resolvePresets(res, all_presets, component, config);
+        }
+    })
+        .catch((err) => {
+        Logger.error(`${err.message} in migration of ${component.name} in createComponent function`);
+    });
+};
+/*
+ *
+ * PUT ONE Component
+ *
+ * */
+export const updateComponent = (component, presets, config) => {
+    const { spaceId, sbApi } = config;
+    Logger.log(`Trying to update '${component.name}' with id ${component.id}`);
+    const componentWithPresets = component;
+    const { all_presets, ...componentWithoutPresets } = componentWithPresets;
+    return sbApi
+        .put(`spaces/${spaceId}/components/${component.id}`, {
+        component: componentWithoutPresets,
+    })
+        .then(async (res) => {
+        Logger.success(`Component '${component.name}' has been updated.`);
+        if (presets) {
+            return await _resolvePresets(res, all_presets, component, config);
+        }
+        else {
+            return [];
+        }
+    })
+        .catch((err) => {
+        Logger.error(`${err.message} in migration of ${component.name} in updateComponent function`);
+    });
+};
+/*
+ *
+ * DEL one Component
+ *
+ * */
+export const removeComponent = (component, config) => {
+    const { id, name } = component;
+    const { spaceId, sbApi } = config;
+    console.log(`Removing '${name}' component.`);
+    return sbApi
+        .delete(`spaces/${spaceId}/components/${id}`, {})
+        .then((res) => res.data)
+        .catch((err) => console.error(err));
+};
+/*
+ *
+ * GET All Component Groups
+ *
+ * */
+export const getAllComponentsGroups = async (config) => {
+    const { spaceId, sbApi } = config;
+    Logger.log("Trying to get all groups.");
+    // TODO: All Components Groups doesnt support pagination...
+    // https://github.com/storyblok/storyblok-js-client/issues/535
+    return getAllItemsWithPagination({
+        apiFn: ({ per_page, page }) => sbApi
+            .get(`spaces/${spaceId}/component_groups/`, { per_page, page })
+            .then((res) => {
+            Logger.log(`Amount of component groups: ${res.total}`);
+            return res;
+        })
+            .catch((err) => console.error(err)),
+        params: {
+            spaceId,
+        },
+        itemsKey: "component_groups",
+    });
+};
+export const getComponentsGroup = (groupName, config) => {
+    console.log(`Trying to get '${groupName}' group.`);
+    return getAllComponentsGroups(config)
+        .then((res) => {
+        return res.filter((group) => group.name === groupName);
+    })
+        .then((res) => {
+        if (Array.isArray(res) && res.length === 0) {
+            console.info(`There is no group named '${groupName}'`);
+            return false;
+        }
+        return res;
+    })
+        .catch((err) => console.error(err));
+};
+export const removeComponentGroup = (componentGroup, config) => {
+    const { id, name } = componentGroup;
+    const { spaceId, sbApi } = config;
+    console.log(`Removing '${name}' component group.`);
+    return sbApi
+        .delete(`spaces/${spaceId}/component_groups/${id}`, {})
+        .then((res) => res.data)
+        .catch((err) => console.error(err));
+};
+export const createComponentsGroup = (groupName, config) => {
+    const { spaceId, sbApi } = config;
+    console.log(`Trying to create '${groupName}' group`);
+    return sbApi
+        .post(`spaces/${spaceId}/component_groups/`, {
+        component_group: {
+            name: groupName,
+        },
+    })
+        .then((res) => {
+        console.info(`'${groupName}' created with uuid: ${res.data.component_group.uuid}`);
+        return res.data;
+    })
+        .catch((err) => {
+        console.log(err.message);
+        console.error("Error happened :()");
+    });
+};

package/dist/api/components/components.types.d.ts

@@ -0,0 +1,13 @@
+import type { RequestBaseConfig } from "../utils/request.js";
+export type GetAllComponents = (config: RequestBaseConfig) => Promise<any>;
+export type GetComponent = (componentName: string | undefined, config: RequestBaseConfig) => Promise<any>;
+export type UpdateComponent = (component: any, preset: boolean, config: RequestBaseConfig) => Promise<any>;
+export type CreateComponent = (component: any, preset: boolean, config: RequestBaseConfig) => Promise<any> | void;
+export type RemoveComponent = (component: any, config: RequestBaseConfig) => Promise<any>;
+export type GetAllComponentsGroups = (config: RequestBaseConfig) => Promise<any>;
+export type GetComponentsGroup = (groupName: string | undefined, config: RequestBaseConfig) => Promise<any>;
+export type RemoveComponentGroup = (componentGroup: any, config: RequestBaseConfig) => Promise<any>;
+export type CreateComponentsGroup = (groupName: string | undefined, config: RequestBaseConfig) => Promise<any>;
+export type RemoveSpecificComponents = (components: any, config: RequestBaseConfig) => Promise<any>;
+export type CheckAndPrepareGroups = (groupName: any, config: RequestBaseConfig) => Promise<any>;
+export type ResolveGroups = (component: any, existedGroups: any, remoteComponentsGroups: any, config: RequestBaseConfig) => Promise<any>;

package/dist/api/components/components.types.js

@@ -0,0 +1 @@
+export {};

package/dist/api/components/index.d.ts

@@ -0,0 +1 @@
+export { getAllComponents, getComponent, getAllComponentsGroups, createComponentsGroup, getComponentsGroup, removeComponentGroup, removeComponent, updateComponent, createComponent, } from "./components.js";

package/dist/api/components/index.js

@@ -0,0 +1 @@
+export { getAllComponents, getComponent, getAllComponentsGroups, createComponentsGroup, getComponentsGroup, removeComponentGroup, removeComponent, updateComponent, createComponent, } from "./components.js";

package/dist/api/contentHubApi.d.ts

@@ -0,0 +1,9 @@
+import type { RequestBaseConfig } from "./utils/request.js";
+type GetAllStories = (args: {
+    spaceId: string;
+    storiesFilename?: string;
+}, config: RequestBaseConfig) => Promise<any>;
+export declare const contentHubApi: {
+    getAllStories: GetAllStories;
+};
+export {};

package/dist/api/contentHubApi.js

@@ -0,0 +1,29 @@
+import Logger from "../utils/logger.js";
+const getAllStories = async (args, config) => {
+    const { spaceId, storiesFilename } = args;
+    Logger.warning("Trying to get all stories from Content Hub...");
+    const queryParams = `spaceId=${spaceId}&storiesFilename=${storiesFilename}`;
+    const url = `${config.contentHubOriginUrl}/getStories?${queryParams}`;
+    const authorizationToken = config.contentHubAuthorizationToken;
+    if (config.debug) {
+        console.log("This is url: ", url);
+    }
+    try {
+        const response = await fetch(url, {
+            method: "GET",
+            headers: {
+                Authorization: authorizationToken,
+            },
+        });
+        if (!response.ok) {
+            throw new Error(`Error fetching stories: ${response.statusText}`);
+        }
+        const data = await response.json();
+        return data;
+    }
+    catch (error) {
+        console.error("Error fetching stories:", error);
+        throw error;
+    }
+};
+export const contentHubApi = { getAllStories };

package/dist/api/data-migration/component-data-migration.d.ts

@@ -0,0 +1,16 @@
+import type { RequestBaseConfig } from "../utils/request.js";
+export type MigrateFrom = "file" | "space";
+interface MigrateStories {
+    from: string;
+    to: string;
+    migrateFrom: MigrateFrom;
+    migrationConfig: string;
+    componentsToMigrate: string[];
+}
+export type MapperDefinition = (data: any) => any;
+export declare const prepareStoriesFromLocalFile: ({ from }: any) => any;
+export declare const prepareMigrationConfig: ({ migrationConfig }: any) => any;
+export declare const migrateAllComponentsDataInStories: ({ migrationConfig, migrateFrom, from, to, }: Omit<MigrateStories, "componentsToMigrate">, config: RequestBaseConfig) => Promise<void>;
+export declare const doTheMigration: ({ from, storiesToMigrate, componentsToMigrate, migrationConfigFileContent, migrationConfig, to, }: any, config: RequestBaseConfig) => Promise<void>;
+export declare const migrateProvidedComponentsDataInStories: ({ migrationConfig, migrateFrom, from, to, componentsToMigrate, }: MigrateStories, config: RequestBaseConfig) => Promise<void>;
+export {};