sb-mig 5.6.0-beta.1 → 5.6.0-beta.2

package/dist-cjs/api/roles/roles.js

@@ -0,0 +1,131 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.syncRolesData = exports.getRole = exports.getAllRoles = exports.updateRole = exports.createRole = void 0;
+const logger_js_1 = __importDefault(require("../../utils/logger.js"));
+const request_js_1 = require("../utils/request.js");
+// POST
+const createRole = (role, config) => {
+    const { sbApi, spaceId } = config;
+    return sbApi
+        .post(`spaces/${spaceId}/space_roles/`, {
+        space_role: role,
+    })
+        .then(() => {
+        logger_js_1.default.success(`Role '${role.role}' has been created.`);
+    })
+        .catch((err) => {
+        logger_js_1.default.error("error happened... :(");
+        console.log(`${err.message} in migration of ${role.role} in createRole function`);
+        throw err;
+    });
+};
+exports.createRole = createRole;
+// PUT
+const updateRole = (role, config) => {
+    const { sbApi, spaceId } = config;
+    return sbApi
+        .put(`spaces/${spaceId}/space_roles/${role.id}`, {
+        space_role: role,
+    })
+        .then(() => {
+        logger_js_1.default.success(`Role '${role.role}' has been updated.`);
+    })
+        .catch((err) => {
+        logger_js_1.default.error("error happened... :(");
+        console.log(`${err.message} in migration of ${role.role} in updateRole function`);
+        throw err;
+    });
+};
+exports.updateRole = updateRole;
+// GET
+const getAllRoles = async (config) => {
+    const { sbApi, spaceId } = config;
+    logger_js_1.default.log("Trying to get all roles.");
+    // TODO: All Roles doesnt support pagination...
+    // https://github.com/storyblok/storyblok-js-client/issues/535
+    return (0, request_js_1.getAllItemsWithPagination)({
+        apiFn: ({ per_page, page }) => sbApi
+            .get(`spaces/${spaceId}/space_roles/`, { per_page, page })
+            .then((res) => {
+            logger_js_1.default.log(`Amount of roles: ${res.total}`);
+            return res;
+        })
+            .catch((err) => {
+            if (err.response.status === 404) {
+                logger_js_1.default.error(`There is no roles in your Storyblok ${spaceId} space.`);
+                return true;
+            }
+            else {
+                logger_js_1.default.error(err);
+                return false;
+            }
+        }),
+        params: {
+            spaceId,
+        },
+        itemsKey: "space_roles",
+    });
+};
+exports.getAllRoles = getAllRoles;
+// GET
+const getRole = async (roleName, config) => {
+    logger_js_1.default.log(`Trying to get '${roleName}' role.`);
+    return (0, exports.getAllRoles)(config)
+        .then((res) => res.filter((role) => role.role === roleName))
+        .then((res) => {
+        if (Array.isArray(res) && res.length === 0) {
+            logger_js_1.default.warning(`There is no role named '${roleName}'`);
+            return false;
+        }
+        return res;
+    })
+        .catch((err) => logger_js_1.default.error(err));
+};
+exports.getRole = getRole;
+const syncRolesData = async ({ roles }, config) => {
+    const result = {
+        created: [],
+        updated: [],
+        skipped: [],
+        errors: [],
+    };
+    const space_roles_raw = await (0, exports.getAllRoles)(config);
+    const space_roles = Array.isArray(space_roles_raw) ? space_roles_raw : [];
+    const rolesToUpdate = [];
+    const rolesToCreate = [];
+    for (const role of roles) {
+        if (!role || typeof role !== "object" || !("role" in role)) {
+            result.skipped.push(String(role?.role ?? "unknown"));
+            continue;
+        }
+        const shouldBeUpdated = space_roles.find((remoteRole) => role.role === remoteRole.role);
+        if (shouldBeUpdated) {
+            rolesToUpdate.push({ id: shouldBeUpdated.id, ...role });
+        }
+        else {
+            rolesToCreate.push(role);
+        }
+    }
+    const updateResults = await Promise.allSettled(rolesToUpdate.map((role) => (0, exports.updateRole)(role, config)));
+    updateResults.forEach((r, idx) => {
+        const name = String(rolesToUpdate[idx]?.role ?? "unknown");
+        if (r.status === "fulfilled")
+            result.updated.push(name);
+        else
+            result.errors.push({ name, message: String(r.reason) });
+    });
+    const createResults = await Promise.allSettled(rolesToCreate.map((role) => (0, exports.createRole)(role, config)));
+    createResults.forEach((r, idx) => {
+        const name = String(rolesToCreate[idx]?.role ?? "unknown");
+        if (r.status === "fulfilled")
+            result.created.push(name);
+        else
+            result.errors.push({ name, message: String(r.reason) });
+    });
+    return result;
+};
+exports.syncRolesData = syncRolesData;
+// File-based sync wrapper lives in `roles.sync.ts` to keep this module CJS-safe.

package/dist-cjs/api/roles/roles.types.js

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

package/dist-cjs/api/spaces/spaces.js

@@ -0,0 +1,34 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.updateSpace = exports.getAllSpaces = exports.getSpace = void 0;
+const getSpace = (args, config) => {
+    const { sbApi } = config;
+    const { spaceId } = args;
+    return sbApi
+        .get(`spaces/${spaceId}`)
+        .then((res) => res.data)
+        .catch((err) => console.error(err));
+};
+exports.getSpace = getSpace;
+const getAllSpaces = (config) => {
+    const { sbApi } = config;
+    return sbApi
+        .get(`spaces/`)
+        .then((res) => res.data.spaces)
+        .catch((err) => {
+        console.error(err);
+        return [];
+    });
+};
+exports.getAllSpaces = getAllSpaces;
+const updateSpace = (args, config) => {
+    const { sbApi } = config;
+    const { spaceId, params } = args;
+    return sbApi
+        .put(`spaces/${spaceId}`, {
+        ...params,
+    })
+        .then((res) => res.data)
+        .catch((err) => console.error(err));
+};
+exports.updateSpace = updateSpace;

package/dist-cjs/api/spaces/spaces.types.js

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

package/dist-cjs/api/stories/stories.js

@@ -0,0 +1,214 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.deepUpsertStory = exports.upsertStory = exports.updateStories = exports.updateStory = exports.createStory = exports.getStoryBySlug = exports.getStoryById = exports.getAllStories = exports.removeAllStories = exports.removeStory = void 0;
+const chalk_1 = __importDefault(require("chalk"));
+const logger_js_1 = __importDefault(require("../../utils/logger.js"));
+const object_utils_js_1 = require("../../utils/object-utils.js");
+const request_js_1 = require("../utils/request.js");
+const removeStory = (args, config) => {
+    const { storyId } = args;
+    const { spaceId, sbApi } = config;
+    logger_js_1.default.log(`Removing ${storyId} from ${spaceId}`);
+    return sbApi
+        .delete(`spaces/${spaceId}/stories/${storyId}`, {})
+        .then((res) => {
+        logger_js_1.default.success(`Successfully removed: ${res.data.story.name} with ${res.data.story.id} id.`);
+        return res;
+    })
+        .catch(() => {
+        logger_js_1.default.error(`Unable to remove: ${storyId}`);
+    });
+};
+exports.removeStory = removeStory;
+const removeAllStories = async (config) => {
+    const { spaceId } = config;
+    logger_js_1.default.warning(`Trying to remove all stories from space with spaceId: ${spaceId}`);
+    const stories = await (0, exports.getAllStories)({}, config);
+    const onlyRootStories = (story) => story.story.parent_id === 0 || story.story.parent_id === null;
+    const allResponses = Promise.all(stories
+        .filter(onlyRootStories)
+        .map(async (story) => await (0, exports.removeStory)({ storyId: story?.story?.id }, config)));
+    return allResponses;
+};
+exports.removeAllStories = removeAllStories;
+// GET
+const getAllStories = async (args, config) => {
+    const { options } = args;
+    const { spaceId, sbApi } = config;
+    logger_js_1.default.log(`Trying to get all Stories from: ${spaceId}`);
+    const params = (0, object_utils_js_1.notNullish)({
+        with_slug: options?.with_slug,
+        starts_with: options?.starts_with,
+        language: options?.language,
+    });
+    console.log("These are params i will use: ");
+    console.log(params);
+    const allStoriesWithoutContent = await (0, request_js_1.getAllItemsWithPagination)({
+        apiFn: ({ per_page, page }) => sbApi.get(`spaces/${spaceId}/stories/`, {
+            ...params,
+            per_page,
+            page,
+        }),
+        params: {
+            spaceId,
+        },
+        itemsKey: "stories",
+    });
+    logger_js_1.default.success(`Successfully pre-fetched ${allStoriesWithoutContent.length} stories.`);
+    let heartBeat = 0;
+    const allStories = await Promise.all(allStoriesWithoutContent.map(async (story) => {
+        const result = await (0, exports.getStoryById)(story.id, config);
+        heartBeat++;
+        if (heartBeat % 10 === 0 ||
+            heartBeat === allStoriesWithoutContent.length) {
+            logger_js_1.default.success(`Successfully fetched ${heartBeat} stories with full content.`);
+        }
+        return result;
+    }));
+    return allStories;
+};
+exports.getAllStories = getAllStories;
+// GET
+const getStoryById = (storyId, config) => {
+    const { spaceId, sbApi, debug } = config;
+    if (debug) {
+        console.log(`Trying to get Story with id: ${storyId} from space: ${spaceId}, to fill content field.`);
+    }
+    return sbApi
+        .get(`spaces/${spaceId}/stories/${storyId}`)
+        .then((res) => {
+        if (debug) {
+            logger_js_1.default.success(`Successfuly fetched story with content, with id: ${storyId} from space: ${spaceId}.`);
+        }
+        return res.data;
+    })
+        .catch((err) => logger_js_1.default.error(err));
+};
+exports.getStoryById = getStoryById;
+const getStoryBySlug = async (slug, config) => {
+    const { spaceId, sbApi } = config;
+    const storiesWithoutContent = await sbApi
+        .get(`spaces/${spaceId}/stories/`, {
+        per_page: 100,
+        // @ts-ignore
+        with_slug: slug,
+    })
+        .then((res) => res.data.stories)
+        .catch((err) => console.error(err));
+    const storiesWithContent = await Promise.all(storiesWithoutContent.map(async (story) => await (0, exports.getStoryById)(story.id, config)));
+    return storiesWithContent[0];
+};
+exports.getStoryBySlug = getStoryBySlug;
+// CREATE
+const createStory = (content, config) => {
+    const { spaceId, sbApi } = config;
+    logger_js_1.default.log(`Creating story with name: ${content.name} in space: ${spaceId}`);
+    return sbApi
+        .post(`spaces/${spaceId}/stories/`, {
+        story: content,
+        publish: 1,
+    })
+        .then((res) => res.data)
+        .catch((err) => console.error(err));
+};
+exports.createStory = createStory;
+// UPDATE
+const updateStory = (content, storyId, options, config) => {
+    const { spaceId, sbApi } = config;
+    logger_js_1.default.warning("Trying to update Story...");
+    logger_js_1.default.log(`Updating story with name: ${content.name} in space: ${spaceId}`);
+    // console.log("THis is content to update: ");
+    // console.log(JSON.stringify(content, null, 2));
+    return sbApi
+        .put(`spaces/${spaceId}/stories/${storyId}`, {
+        story: content,
+        publish: options.publish ? 1 : 0,
+        force_update: options.force_update ? 1 : 0,
+    })
+        .then((res) => {
+        console.log(`${chalk_1.default.green(res.data.story.full_slug)} updated.`);
+        return res.data;
+    })
+        .catch((err) => console.error(err));
+};
+exports.updateStory = updateStory;
+const updateStories = (args, config) => {
+    const { stories, options, spaceId } = args;
+    return Promise.allSettled(
+    // Run through stories, and update the space with migrated version of stories
+    stories.map(async (stories) => {
+        return (0, exports.updateStory)(stories.story, stories.story.id, { publish: options.publish }, { ...config, spaceId });
+    }));
+};
+exports.updateStories = updateStories;
+const upsertStory = async (args, config) => {
+    console.log("Modifying story... in space with id:");
+    console.log(config.spaceId);
+    const { storyId, storySlug, content } = args;
+    console.log("This are args passed: ");
+    console.log(args);
+    if (storyId) {
+        // if this exist than we update story with this id
+        console.log("You've selected storyid!");
+    }
+    else if (storySlug) {
+        // if this exist than we update story with this slug (probably when we try to add story from one space to another,
+        console.log("You've selected slug!");
+        const foundStory = await (0, exports.getStoryBySlug)(storySlug, config);
+        console.log("This is story");
+        console.log(foundStory);
+        if (foundStory) {
+            // then update the story
+        }
+        else {
+            const { story: { parent_id, id, parent, ...rest }, } = content;
+            console.log("We are going to create story");
+            const response = await (0, exports.createStory)(rest, config);
+            console.log("This is response");
+            console.log(response);
+        }
+    }
+    else {
+        // if this exist than we create new story
+        console.log("Nothing passed, creating story...");
+    }
+};
+exports.upsertStory = upsertStory;
+const deepUpsertStory = async (args, config) => {
+    console.log("Modifying story... in space with id:");
+    console.log(config.spaceId);
+    const { storyId, storySlug, content } = args;
+    console.log("This are args passed: ");
+    console.log(args);
+    if (storyId) {
+        // if this exist than we update story with this id
+        console.log("You've selected storyid!");
+    }
+    else if (storySlug) {
+        // if this exist than we update story with this slug (probably when we try to add story from one space to another,
+        console.log("You've selected slug!");
+        const slugs = storySlug.split("/");
+        console.log("Slugs for which we need to check for existence of stories");
+        console.log(slugs);
+        // const foundStory = await managementApi.stories.getStoryBySlug(storySlug, config)
+        // console.log("This is story")
+        // console.log(foundStory)
+        // if(foundStory) {
+        //     // then update the story
+        // } else {
+        //     const {story: {parent_id, id, parent,...rest}} = content
+        //     console.log("We are going to create story")
+        //     const response = await managementApi.stories.createStory(rest, config)
+        //     console.log("This is response")
+        //     console.log(response)
+        // }
+    }
+    else {
+        // if this exist than we create new story
+        console.log("Nothing passed, creating story...");
+    }
+};
+exports.deepUpsertStory = deepUpsertStory;

package/dist-cjs/api/stories/stories.types.js

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

package/dist-cjs/api/sync/sync.types.js

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

package/dist-cjs/api/utils/request.js

@@ -0,0 +1,48 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getAllItemsWithPagination = void 0;
+const logger_js_1 = __importDefault(require("../../utils/logger.js"));
+const getAllItemsWithPagination = async ({ apiFn, params, itemsKey, }) => {
+    const per_page = 100;
+    const allItems = [];
+    let page = 1;
+    let totalPages;
+    let amountOfFetchedItems = 0;
+    do {
+        const response = await apiFn({ per_page, page, ...params });
+        // Handle case where API call failed and returned undefined
+        if (!response || !response.data) {
+            logger_js_1.default.warning(`API returned no data for ${itemsKey}`);
+            return allItems;
+        }
+        if (!totalPages) {
+            totalPages =
+                Math.ceil((response.total ?? 0) / (response.perPage ?? per_page)) || 1;
+        }
+        /**
+         *
+         * Not every endpoint in storyblok give us pagination...
+         * so only for this who paginate we want to calculate values to show
+         *
+         * */
+        if (response.total) {
+            amountOfFetchedItems +=
+                response.total - amountOfFetchedItems > per_page
+                    ? per_page
+                    : response.total - amountOfFetchedItems;
+            if (amountOfFetchedItems && !Number.isNaN(amountOfFetchedItems)) {
+                logger_js_1.default.success(`${amountOfFetchedItems} of ${response.total} items fetched.`);
+            }
+        }
+        const items = response.data?.[itemsKey];
+        if (Array.isArray(items)) {
+            allItems.push(...items);
+        }
+        page++;
+    } while (page <= totalPages);
+    return allItems;
+};
+exports.getAllItemsWithPagination = getAllItemsWithPagination;

package/dist-cjs/api/utils/resolvers.types.js

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

package/dist-cjs/api-v2/assets/index.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getAllAssets = getAllAssets;
+exports.getAssetById = getAssetById;
+exports.getAssetByName = getAssetByName;
+async function getAllAssets(client, args) {
+    const { spaceId, search } = args;
+    return client.sbApi
+        .get(`spaces/${spaceId}/assets/`, {
+        // @ts-ignore storyblok-js-client mismatch: documentation uses `search`
+        search: search ?? "",
+        per_page: 100,
+    })
+        .then(({ data }) => data);
+}
+async function getAssetById(client, args) {
+    const { spaceId, assetId } = args;
+    return client.sbApi
+        .get(`spaces/${spaceId}/assets/${assetId}`)
+        .then(({ data }) => data);
+}
+async function getAssetByName(client, args) {
+    const result = await getAllAssets(client, {
+        spaceId: args.spaceId,
+        search: args.fileName,
+    });
+    if (result?.assets?.length === 1)
+        return result.assets[0];
+    return undefined;
+}

package/dist-cjs/api-v2/auth/index.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getCurrentUser = getCurrentUser;
+exports.hasAccessToSpace = hasAccessToSpace;
+const auth_js_1 = require("../../api/auth/auth.js");
+const requestConfig_js_1 = require("../requestConfig.js");
+async function getCurrentUser(client) {
+    return await (0, auth_js_1.getCurrentUser)((0, requestConfig_js_1.toRequestConfig)(client));
+}
+async function hasAccessToSpace(client, spaceId) {
+    return await (0, auth_js_1.hasAccessToSpace)({ spaceId }, (0, requestConfig_js_1.toRequestConfig)(client));
+}

package/dist-cjs/api-v2/client.js

@@ -0,0 +1,23 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createClient = createClient;
+const storyblok_js_client_1 = __importDefault(require("storyblok-js-client"));
+function createClient(options) {
+    const sbApi = new storyblok_js_client_1.default({
+        oauthToken: options.oauthToken,
+        accessToken: options.accessToken,
+        rateLimit: options.rateLimit ?? 3,
+        cache: {
+            clear: "auto",
+            type: "none",
+        },
+    }, "https://mapi.storyblok.com/v1");
+    return {
+        config: options,
+        sbApi,
+        spaceId: options.spaceId,
+    };
+}

package/dist-cjs/api-v2/components/index.js

@@ -0,0 +1,40 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getAllComponents = getAllComponents;
+exports.getComponent = getComponent;
+exports.getAllComponentsGroups = getAllComponentsGroups;
+exports.getComponentsGroup = getComponentsGroup;
+exports.createComponentsGroup = createComponentsGroup;
+exports.removeComponentGroup = removeComponentGroup;
+exports.removeComponent = removeComponent;
+exports.createComponent = createComponent;
+exports.updateComponent = updateComponent;
+const components_js_1 = require("../../api/components/components.js");
+const requestConfig_js_1 = require("../requestConfig.js");
+async function getAllComponents(client) {
+    return await (0, components_js_1.getAllComponents)((0, requestConfig_js_1.toRequestConfig)(client));
+}
+async function getComponent(client, componentName) {
+    return await (0, components_js_1.getComponent)(componentName, (0, requestConfig_js_1.toRequestConfig)(client));
+}
+async function getAllComponentsGroups(client) {
+    return await (0, components_js_1.getAllComponentsGroups)((0, requestConfig_js_1.toRequestConfig)(client));
+}
+async function getComponentsGroup(client, groupName) {
+    return await (0, components_js_1.getComponentsGroup)(groupName, (0, requestConfig_js_1.toRequestConfig)(client));
+}
+async function createComponentsGroup(client, groupName) {
+    return await (0, components_js_1.createComponentsGroup)(groupName, (0, requestConfig_js_1.toRequestConfig)(client));
+}
+async function removeComponentGroup(client, componentGroup) {
+    return await (0, components_js_1.removeComponentGroup)(componentGroup, (0, requestConfig_js_1.toRequestConfig)(client));
+}
+async function removeComponent(client, component) {
+    return await (0, components_js_1.removeComponent)(component, (0, requestConfig_js_1.toRequestConfig)(client));
+}
+async function createComponent(client, component, presets = false) {
+    return await (0, components_js_1.createComponent)(component, presets, (0, requestConfig_js_1.toRequestConfig)(client));
+}
+async function updateComponent(client, component, presets = false) {
+    return await (0, components_js_1.updateComponent)(component, presets, (0, requestConfig_js_1.toRequestConfig)(client));
+}

package/dist-cjs/api-v2/datasources/index.js

@@ -0,0 +1,64 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getAllDatasources = getAllDatasources;
+exports.getDatasource = getDatasource;
+exports.createDatasource = createDatasource;
+exports.updateDatasource = updateDatasource;
+const request_js_1 = require("../../api/utils/request.js");
+async function getAllDatasources(client) {
+    const spaceId = client.spaceId;
+    return (0, request_js_1.getAllItemsWithPagination)({
+        apiFn: ({ per_page, page }) => client.sbApi.get(`spaces/${spaceId}/datasources/`, {
+            per_page,
+            page,
+        }),
+        params: { spaceId },
+        itemsKey: "datasources",
+    });
+}
+async function getDatasource(client, datasourceName) {
+    const datasources = await getAllDatasources(client);
+    const match = datasources.filter((d) => d.name === datasourceName);
+    if (Array.isArray(match) && match.length === 0)
+        return false;
+    return match;
+}
+async function createDatasource(client, datasource) {
+    const spaceId = client.spaceId;
+    const finalDatasource = {
+        name: datasource.name,
+        slug: datasource.slug,
+        dimensions: [...(datasource.dimensions ?? [])],
+        dimensions_attributes: [...(datasource.dimensions ?? [])],
+    };
+    return client.sbApi
+        .post(`spaces/${spaceId}/datasources/`, {
+        datasource: finalDatasource,
+    })
+        .then((res) => res.data);
+}
+async function updateDatasource(client, args) {
+    const spaceId = client.spaceId;
+    const { datasource, datasourceToBeUpdated } = args;
+    const dimensionsToCreate = (datasource.dimensions ?? []).filter((dimension) => {
+        const isDimensionInRemoteDatasource = datasourceToBeUpdated.dimensions?.find((d) => dimension.name === d.name);
+        return !isDimensionInRemoteDatasource;
+    });
+    return client.sbApi
+        .put(`spaces/${spaceId}/datasources/${datasourceToBeUpdated.id}`, {
+        datasource: {
+            id: datasourceToBeUpdated.id,
+            name: datasource.name,
+            slug: datasource.slug,
+            dimensions: [
+                ...(datasourceToBeUpdated.dimensions ?? []),
+                ...dimensionsToCreate,
+            ],
+            dimensions_attributes: [
+                ...(datasourceToBeUpdated.dimensions ?? []),
+                ...dimensionsToCreate,
+            ],
+        },
+    })
+        .then((res) => res.data);
+}