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

package/dist/utils/path-utils.js

@@ -0,0 +1,106 @@
+/**
+ * Path and glob pattern utilities for file discovery
+ */
+import path from "path";
+/**
+ * Normalizes an array of directory segments for glob pattern usage.
+ * Handles the glob.sync quirk where single segments don't need braces,
+ * but multiple segments need {segment1,segment2} format.
+ *
+ * @param segments - Array of directory path segments
+ * @returns Normalized string for glob pattern
+ *
+ * @example
+ * normalizeDiscover({ segments: [] }) // => ""
+ * normalizeDiscover({ segments: ["src"] }) // => "src"
+ * normalizeDiscover({ segments: ["src", "lib"] }) // => "{src,lib}"
+ */
+export const normalizeDiscover = ({ segments, }) => {
+    if (segments.length === 0) {
+        return "";
+    }
+    if (segments.length === 1) {
+        return segments[0];
+    }
+    return `{${segments.join(",")}}`;
+};
+/**
+ * Builds a glob file pattern for discovering files with a specific extension.
+ * Automatically handles single vs multiple directory paths.
+ *
+ * @param mainDirectory - The root directory to search from
+ * @param componentDirectories - Array of subdirectories to search in
+ * @param ext - File extension to match (without leading dot)
+ * @returns A glob pattern string
+ *
+ * @example
+ * filesPattern({
+ *   mainDirectory: "/project",
+ *   componentDirectories: ["src"],
+ *   ext: "sb.js"
+ * })
+ * // => "/project/src/**\/[^_]*.sb.js"
+ *
+ * filesPattern({
+ *   mainDirectory: "/project",
+ *   componentDirectories: ["src", "lib"],
+ *   ext: "sb.js"
+ * })
+ * // => "/project/{src,lib}/**\/[^_]*.sb.js"
+ */
+export const filesPattern = ({ mainDirectory, componentDirectories, ext, }) => {
+    return componentDirectories.length === 1
+        ? path.join(`${mainDirectory}`, `${componentDirectories[0]}`, "**", `[^_]*.${ext}`)
+        : path.join(`${mainDirectory}`, `{${componentDirectories.join(",")}}`, "**", `[^_]*.${ext}`);
+};
+/**
+ * Compares local and external file path arrays.
+ * Splits paths to extract file names, filters out duplicates from external
+ * (preferring local files), and filters out nested node_modules.
+ *
+ * @param request - Object containing local and external path arrays
+ * @returns CompareResult with processed local and external file elements
+ *
+ * @example
+ * compare({
+ *   local: ["/project/src/hero.sb.js"],
+ *   external: ["/project/node_modules/pkg/hero.sb.js", "/project/node_modules/pkg/card.sb.js"]
+ * })
+ * // => {
+ * //   local: [{ name: "hero.sb.js", p: "/project/src/hero.sb.js" }],
+ * //   external: [{ name: "card.sb.js", p: "/project/node_modules/pkg/card.sb.js" }]
+ * // }
+ */
+export const compare = (request) => {
+    const { local, external } = request;
+    const splittedLocal = local.map((p) => {
+        return {
+            name: p.split(path.sep)[p.split(path.sep).length - 1], // last element of split array - file name
+            p,
+        };
+    });
+    const splittedExternal = external
+        .map((p) => {
+        return {
+            name: p.split(path.sep)[p.split(path.sep).length - 1], // last element of split array - file name
+            p,
+        };
+    })
+        .filter((file) => {
+        // Filter out files from nested node_modules (node_modules within node_modules)
+        const nodeModulesCount = (file.p.match(/node_modules/g) || [])
+            .length;
+        return nodeModulesCount <= 1;
+    });
+    // Filter external array to remove items that exist locally (local takes priority)
+    const result = {
+        local: splittedLocal,
+        external: splittedExternal.filter((externalComponent) => {
+            if (splittedLocal.find((localComponent) => externalComponent.name === localComponent.name)) {
+                return false;
+            }
+            return true;
+        }),
+    };
+    return result;
+};

package/dist/utils/pkg.d.ts

@@ -1,2 +1,16 @@
-declare const pkg: (path: string) => any;
-export { pkg };
+/**
+ * Package loading utilities
+ * ESM-compatible require wrapper for loading JSON/JS files dynamically
+ */
+/**
+ * Load a package/module from the given path using require
+ * Works in ESM context by using createRequire
+ *
+ * @param path - Path to the package/module to load
+ * @returns The loaded module content
+ *
+ * @example
+ * const packageJson = pkg('./package.json');
+ * const config = pkg('some-config-file');
+ */
+export declare const pkg: (path: string) => any;

package/dist/utils/pkg.js

@@ -1,7 +1,20 @@
+/**
+ * Package loading utilities
+ * ESM-compatible require wrapper for loading JSON/JS files dynamically
+ */
 import { createRequire } from "module";
 const require = createRequire(import.meta.url);
-// return require(`${process.cwd()}/package.json`);
-const pkg = (path) => {
+/**
+ * Load a package/module from the given path using require
+ * Works in ESM context by using createRequire
+ *
+ * @param path - Path to the package/module to load
+ * @returns The loaded module content
+ *
+ * @example
+ * const packageJson = pkg('./package.json');
+ * const config = pkg('some-config-file');
+ */
+export const pkg = (path) => {
     return require(path);
 };
-export { pkg };

package/dist/utils/string-utils.d.ts

@@ -0,0 +1,33 @@
+/**
+ * String manipulation utilities
+ */
+/**
+ * Extracts the filename from a file URL or path.
+ * Returns the last segment after splitting by "/".
+ *
+ * @param fileUrl - The URL or path string to extract filename from
+ * @returns The extracted filename
+ * @throws Error if filename cannot be extracted (empty string or no segments)
+ *
+ * @example
+ * getFileName("https://example.com/assets/image.png") // => "image.png"
+ * getFileName("/path/to/file.txt") // => "file.txt"
+ * getFileName("simple.js") // => "simple.js"
+ */
+export declare const getFileName: (fileUrl: string) => string;
+/**
+ * Extracts the size segment from a Storyblok asset URL.
+ * Storyblok asset URLs have the format: .../size/hash/filename
+ * This function extracts the size segment (3 positions before the end).
+ *
+ * @param fileUrl - The Storyblok asset URL
+ * @returns The size segment from the URL
+ *
+ * @example
+ * getSizeFromURL("https://a.storyblok.com/f/12345/1920x1080/abc123/image.png")
+ * // => "1920x1080"
+ *
+ * getSizeFromURL("https://a.storyblok.com/f/12345/100x100/xyz789/thumb.jpg")
+ * // => "100x100"
+ */
+export declare const getSizeFromURL: (fileUrl: string) => string;

package/dist/utils/string-utils.js

@@ -0,0 +1,45 @@
+/**
+ * String manipulation utilities
+ */
+/**
+ * Extracts the filename from a file URL or path.
+ * Returns the last segment after splitting by "/".
+ *
+ * @param fileUrl - The URL or path string to extract filename from
+ * @returns The extracted filename
+ * @throws Error if filename cannot be extracted (empty string or no segments)
+ *
+ * @example
+ * getFileName("https://example.com/assets/image.png") // => "image.png"
+ * getFileName("/path/to/file.txt") // => "file.txt"
+ * getFileName("simple.js") // => "simple.js"
+ */
+export const getFileName = (fileUrl) => {
+    const fileName = fileUrl.split("/").pop();
+    if (fileName) {
+        return fileName;
+    }
+    else {
+        throw Error("File name couldn't be extracted from URL.");
+    }
+};
+/**
+ * Extracts the size segment from a Storyblok asset URL.
+ * Storyblok asset URLs have the format: .../size/hash/filename
+ * This function extracts the size segment (3 positions before the end).
+ *
+ * @param fileUrl - The Storyblok asset URL
+ * @returns The size segment from the URL
+ *
+ * @example
+ * getSizeFromURL("https://a.storyblok.com/f/12345/1920x1080/abc123/image.png")
+ * // => "1920x1080"
+ *
+ * getSizeFromURL("https://a.storyblok.com/f/12345/100x100/xyz789/thumb.jpg")
+ * // => "100x100"
+ */
+export const getSizeFromURL = (fileUrl) => {
+    const data = fileUrl.split("/");
+    const sizePos = data.length - 3;
+    return data[sizePos];
+};

package/dist/utils/transform-utils.d.ts

@@ -0,0 +1,62 @@
+/**
+ * Object transformation utilities
+ * Pure functions for deep object manipulation
+ */
+/**
+ * Recursively extend a field in a nested object
+ * If the field is an array, appends unique values
+ * If the field is an object, merges properties
+ *
+ * @param obj - The object to search and extend
+ * @param targetField - The field name to find and extend
+ * @param newValue - The value(s) to add
+ * @returns true if field was found and extended, false otherwise
+ *
+ * @example
+ * const obj = { schema: { items: ['a', 'b'] } };
+ * extendField(obj, 'items', ['c', 'd']);
+ * // obj.schema.items is now ['a', 'b', 'c', 'd']
+ */
+export declare const extendField: (obj: any, targetField: string, newValue: any) => boolean;
+/**
+ * Deep transform an object using a transformer specification
+ * Supports function transformers, nested object transformers, and literal values
+ *
+ * @param obj - The source object to transform
+ * @param transformers - Specification object where:
+ *   - function values: called with current value, result used as new value
+ *   - object values: recursively applied to nested objects
+ *   - other values: used directly as the new value
+ * @returns New transformed object (original is not mutated)
+ *
+ * @example
+ * const obj = { name: 'hero', count: 5 };
+ * const result = deepTransform(obj, {
+ *   name: (v) => v.toUpperCase(),
+ *   count: (v) => v * 2,
+ * });
+ * // result: { name: 'HERO', count: 10 }
+ *
+ * @example
+ * // Nested transformation
+ * const obj = { schema: { title: 'old' } };
+ * const result = deepTransform(obj, {
+ *   schema: { title: 'new' }
+ * });
+ * // result: { schema: { title: 'new' } }
+ */
+export declare function deepTransform(obj: any, transformers: any): any;
+/**
+ * Check if a component has content available as bloks
+ *
+ * @param component - Storyblok component schema
+ * @returns true if component.schema.content is a bloks field with whitelist
+ */
+export declare const isContentAvailableAsBloks: (component: any) => boolean;
+/**
+ * Check if a component has items available as bloks
+ *
+ * @param component - Storyblok component schema
+ * @returns true if component.schema.items is a bloks field with whitelist
+ */
+export declare const isItemsAvailableAsBloks: (component: any) => boolean;

package/dist/utils/transform-utils.js

@@ -0,0 +1,113 @@
+/**
+ * Object transformation utilities
+ * Pure functions for deep object manipulation
+ */
+/**
+ * Recursively extend a field in a nested object
+ * If the field is an array, appends unique values
+ * If the field is an object, merges properties
+ *
+ * @param obj - The object to search and extend
+ * @param targetField - The field name to find and extend
+ * @param newValue - The value(s) to add
+ * @returns true if field was found and extended, false otherwise
+ *
+ * @example
+ * const obj = { schema: { items: ['a', 'b'] } };
+ * extendField(obj, 'items', ['c', 'd']);
+ * // obj.schema.items is now ['a', 'b', 'c', 'd']
+ */
+export const extendField = (obj, targetField, newValue) => {
+    if (typeof obj !== "object" || obj === null) {
+        return false;
+    }
+    if (obj.hasOwnProperty(targetField)) {
+        if (Array.isArray(obj[targetField])) {
+            for (const element of newValue) {
+                if (!obj[targetField].includes(element)) {
+                    obj[targetField] = [...obj[targetField], element];
+                }
+            }
+        }
+        else if (typeof obj[targetField] === "object") {
+            obj[targetField] = { ...obj[targetField], ...newValue };
+        }
+        return true;
+    }
+    for (const key in obj) {
+        if (extendField(obj[key], targetField, newValue)) {
+            return true;
+        }
+    }
+    return false;
+};
+/**
+ * Deep transform an object using a transformer specification
+ * Supports function transformers, nested object transformers, and literal values
+ *
+ * @param obj - The source object to transform
+ * @param transformers - Specification object where:
+ *   - function values: called with current value, result used as new value
+ *   - object values: recursively applied to nested objects
+ *   - other values: used directly as the new value
+ * @returns New transformed object (original is not mutated)
+ *
+ * @example
+ * const obj = { name: 'hero', count: 5 };
+ * const result = deepTransform(obj, {
+ *   name: (v) => v.toUpperCase(),
+ *   count: (v) => v * 2,
+ * });
+ * // result: { name: 'HERO', count: 10 }
+ *
+ * @example
+ * // Nested transformation
+ * const obj = { schema: { title: 'old' } };
+ * const result = deepTransform(obj, {
+ *   schema: { title: 'new' }
+ * });
+ * // result: { schema: { title: 'new' } }
+ */
+export function deepTransform(obj, transformers) {
+    if (typeof obj !== "object" || obj === null) {
+        return obj;
+    }
+    const result = Array.isArray(obj) ? [...obj] : { ...obj };
+    for (const key in transformers) {
+        if (typeof transformers[key] === "function") {
+            result[key] = transformers[key](obj[key]);
+        }
+        else if (typeof transformers[key] === "object" &&
+            transformers[key] !== null) {
+            result[key] = deepTransform(obj[key] || {}, transformers[key]);
+        }
+        else {
+            result[key] = transformers[key];
+        }
+    }
+    // Preserve untransformed properties
+    for (const key in obj) {
+        if (!(key in transformers)) {
+            result[key] = obj[key];
+        }
+    }
+    return result;
+}
+/**
+ * Check if a component has content available as bloks
+ *
+ * @param component - Storyblok component schema
+ * @returns true if component.schema.content is a bloks field with whitelist
+ */
+export const isContentAvailableAsBloks = (component) => "content" in component.schema &&
+    component.schema.content.component_whitelist &&
+    component.schema.content.type === "bloks";
+/**
+ * Check if a component has items available as bloks
+ *
+ * @param component - Storyblok component schema
+ * @returns true if component.schema.items is a bloks field with whitelist
+ */
+export const isItemsAvailableAsBloks = (component) => "items" in component.schema &&
+    component.schema.items.component_whitelist &&
+    component.schema.items.type === "bloks";

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

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.hasAccessToSpace = exports.getCurrentUser = void 0;
+const spaces_js_1 = require("../spaces/spaces.js");
+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;
+};
+exports.getCurrentUser = getCurrentUser;
+const hasAccessToSpace = async (args, config) => {
+    const { spaceId } = args;
+    const allSpaces = await (0, spaces_js_1.getAllSpaces)(config);
+    const hasAccess = allSpaces.find((space) => Number(space.id) === Number(spaceId));
+    return !!hasAccess;
+};
+exports.hasAccessToSpace = hasAccessToSpace;

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

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

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

@@ -0,0 +1,202 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createComponentsGroup = exports.removeComponentGroup = exports.getComponentsGroup = exports.getAllComponentsGroups = exports.removeComponent = exports.updateComponent = exports.createComponent = exports.getComponent = exports.getAllComponents = void 0;
+const logger_js_1 = __importDefault(require("../../utils/logger.js"));
+const resolvePresets_js_1 = __importDefault(require("../presets/resolvePresets.js"));
+const request_js_1 = require("../utils/request.js");
+/*
+ *
+ * GET ALL components
+ *
+ * */
+const getAllComponents = (config) => {
+    const { spaceId, sbApi } = config;
+    logger_js_1.default.log("Trying to get all components.");
+    return (0, request_js_1.getAllItemsWithPagination)({
+        apiFn: ({ per_page, page }) => sbApi
+            .get(`spaces/${spaceId}/components/`, { per_page, page })
+            .then((res) => {
+            /**
+             *
+             * Not every endpoint in storyblok give us pagination...
+             * so only for this who paginate we want to console log amount found.
+             *
+             * */
+            if (res.total) {
+                logger_js_1.default.log(`Amount of components: ${res.total}`);
+            }
+            return res;
+        })
+            .catch((err) => console.error(err)),
+        params: {
+            spaceId,
+        },
+        itemsKey: "components",
+    });
+};
+exports.getAllComponents = getAllComponents;
+/*
+ *
+ * GET ONE component
+ *
+ * */
+const getComponent = (componentName, config) => {
+    logger_js_1.default.log(`Trying to get '${componentName}' component.`);
+    return (0, exports.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));
+};
+exports.getComponent = getComponent;
+// CREATE
+const createComponent = (component, presets, config) => {
+    const { spaceId, sbApi } = config;
+    logger_js_1.default.log(`Trying to create '${component.name}'`);
+    const componentWithPresets = component;
+    const { all_presets, ...componentWithoutPresets } = componentWithPresets;
+    return sbApi
+        .post(`spaces/${spaceId}/components/`, {
+        component: componentWithoutPresets,
+    })
+        .then((res) => {
+        logger_js_1.default.success(`Component '${component.name}' has been created.`);
+        if (presets) {
+            (0, resolvePresets_js_1.default)(res, all_presets, component, config);
+        }
+    })
+        .catch((err) => {
+        logger_js_1.default.error(`${err.message} in migration of ${component.name} in createComponent function`);
+        throw err;
+    });
+};
+exports.createComponent = createComponent;
+/*
+ *
+ * PUT ONE Component
+ *
+ * */
+const updateComponent = (component, presets, config) => {
+    const { spaceId, sbApi } = config;
+    logger_js_1.default.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_js_1.default.success(`Component '${component.name}' has been updated.`);
+        if (presets) {
+            return await (0, resolvePresets_js_1.default)(res, all_presets, component, config);
+        }
+        else {
+            return [];
+        }
+    })
+        .catch((err) => {
+        logger_js_1.default.error(`${err.message} in migration of ${component.name} in updateComponent function`);
+    });
+};
+exports.updateComponent = updateComponent;
+/*
+ *
+ * DEL one Component
+ *
+ * */
+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));
+};
+exports.removeComponent = removeComponent;
+/*
+ *
+ * GET All Component Groups
+ *
+ * */
+const getAllComponentsGroups = async (config) => {
+    const { spaceId, sbApi } = config;
+    logger_js_1.default.log("Trying to get all groups.");
+    // TODO: All Components Groups 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}/component_groups/`, { per_page, page })
+            .then((res) => {
+            /**
+             *
+             * Not every endpoint in storyblok give us pagination...
+             * so only for this who paginate we want to console log amount found.
+             *
+             * */
+            if (res.total) {
+                logger_js_1.default.log(`Amount of component groups: ${res.total}`);
+            }
+            return res;
+        })
+            .catch((err) => console.error(err)),
+        params: {
+            spaceId,
+        },
+        itemsKey: "component_groups",
+    });
+};
+exports.getAllComponentsGroups = getAllComponentsGroups;
+const getComponentsGroup = (groupName, config) => {
+    console.log(`Trying to get '${groupName}' group.`);
+    return (0, exports.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));
+};
+exports.getComponentsGroup = getComponentsGroup;
+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));
+};
+exports.removeComponentGroup = removeComponentGroup;
+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 :()");
+    });
+};
+exports.createComponentsGroup = createComponentsGroup;