@contentstorage/core 2.1.1 → 2.2.1

package/dist/lib/contentManagement.js

@@ -1,257 +0,0 @@
-import { populateTextWithVariables } from '../helpers/populateTextWithVariables.js';
-export let activeContent = null;
-export let appConfig = null;
-/**
- * NB! Only used when live editor mode is on
- */
-window.memoryMap = new Map();
-window.currentLanguageCode = null;
-/**
- * Loads and sets the content for a specific language.
- * It will internally ensure the application configuration (for contentDir) is loaded.
- * @param contentJson
- * Language code which is used for live editor to manage pending changes
- * @param languageCode
- */
-export function setContentLanguage({ languageCode, contentJson, }) {
-    if (!contentJson || typeof contentJson !== 'object') {
-        throw new Error('[Contentstorage] Invalid contentJson might be provided which caused setContentLanguage to fail.');
-    }
-    try {
-        activeContent = contentJson; // Relies on augmentation
-        if (typeof window !== 'undefined') {
-            window.currentLanguageCode = languageCode;
-        }
-        console.log(`[Contentstorage] Content loaded.`);
-    }
-    catch (error) {
-        activeContent = null; // Reset on failure
-        window.currentLanguageCode = null;
-        console.error(`[Contentstorage] Failed to load content. Error: ${error.message}`);
-    }
-}
-export function initContentStorage(config) {
-    if (!config ||
-        typeof config !== 'object' ||
-        !config.contentKey ||
-        !Array.isArray(config.languageCodes)) {
-        if (!config.contentKey) {
-            throw new Error('[Contentstorage] No contentKey provided in initContentStorage function.');
-        }
-        if (!Array.isArray(config.languageCodes)) {
-            throw new Error('[Contentstorage] No languageCodes provided in initContentStorage function.');
-        }
-        throw new Error('[Contentstorage] Invalid config.');
-    }
-    appConfig = config;
-}
-/**
- * Retrieves the text string from the loaded JSON content for the given path.
- * Autocompletion for pathString is enabled via module augmentation of CustomContentStructure.
- * `setContentLanguage()` must be called successfully before using this.
- *
- * @param contentId A dot-notation path string (e.g., 'HomePage.Login'). Autocompletion is provided.
- * @param variables Variables help to render dynamic content inside text strings
- * If not provided, and path is not found/value not string, undefined is returned.
- * @returns The text string from the JSON, or the fallbackValue, or undefined.
- */
-export function getText(contentId, variables) {
-    const defaultVal = {
-        contentId,
-        text: '',
-    };
-    if (!activeContent) {
-        const msg = `[Contentstorage] getText: Content not loaded (Key: "${String(contentId)}"). Ensure setContentLanguage() was called and completed successfully.`;
-        console.warn(msg);
-        return defaultVal;
-    }
-    const keys = contentId.split('.');
-    let current = activeContent;
-    for (const key of keys) {
-        if (current && typeof current === 'object' && key in current) {
-            current = current[key];
-        }
-        else {
-            const msg = `[Contentstorage] getText: Path "${String(contentId)}" not found in loaded content.`;
-            console.warn(msg);
-            return defaultVal;
-        }
-    }
-    if (typeof current === 'string') {
-        if (window.parent && window.parent !== window) {
-            const key = current;
-            const existingEntry = window.memoryMap.get(key);
-            const idSet = existingEntry ? existingEntry.ids : new Set();
-            idSet.add(contentId); // Add the current ID to the set.
-            window.memoryMap.set(key, {
-                ids: idSet,
-                type: 'text',
-            });
-        }
-        if (!variables || Object.keys(variables).length === 0) {
-            return {
-                contentId,
-                text: current,
-            };
-        }
-        return {
-            contentId,
-            text: populateTextWithVariables(current, variables, contentId),
-        };
-    }
-    else {
-        const msg = `[Contentstorage] getText: Value at path "${String(contentId)}" is not a string (actual type: ${typeof current}).`;
-        console.warn(msg);
-        return defaultVal;
-    }
-}
-export function getImage(contentId) {
-    const defaultVal = {
-        contentId,
-        data: { url: '', altText: '', contentstorage_type: 'image' },
-    };
-    if (!activeContent) {
-        const msg = `[Contentstorage] getImage: Content not loaded (Content Id: "${contentId}"). Ensure setContentLanguage() was called and completed successfully.`;
-        console.warn(msg);
-        return {
-            contentId,
-            data: { url: '', altText: '', contentstorage_type: 'image' },
-        };
-    }
-    const keys = contentId.split('.');
-    let current = activeContent;
-    for (const key of keys) {
-        if (current && typeof current === 'object' && key in current) {
-            current = current[key];
-        }
-        else {
-            const msg = `[Contentstorage] getImage: Path "${contentId}" not found in loaded content.`;
-            console.warn(msg);
-            return defaultVal;
-        }
-    }
-    if (current &&
-        typeof current === 'object' &&
-        current.contentstorage_type === 'image' &&
-        typeof current.url === 'string') {
-        const currentData = current;
-        const key = `https://cdn.contentstorage.app/${currentData.url}`;
-        if (window.parent && window.parent !== window) {
-            const existingEntry = window.memoryMap.get(key);
-            const idSet = existingEntry ? existingEntry.ids : new Set();
-            idSet.add(contentId); // Add the current ID to the set.
-            window.memoryMap.set(key, {
-                ids: idSet,
-                type: 'image',
-            });
-        }
-        console.log('currentData.url', currentData.url);
-        return {
-            contentId,
-            data: {
-                ...currentData,
-                url: key,
-            },
-        };
-    }
-    else {
-        const msg = `[Contentstorage] getImage: Value at path "${contentId}" is not a valid image object (actual value: ${JSON.stringify(current)}).`;
-        console.warn(msg);
-        return defaultVal;
-    }
-}
-export function getVariation(contentId, variationKey, variables) {
-    const defaultVal = {
-        contentId,
-        text: '',
-    };
-    if (!activeContent) {
-        const msg = `[Contentstorage] getVariation: Content not loaded (Content Id: "${contentId}", Variation: "${variationKey?.toString()}"). Ensure setContentLanguage() was called and completed successfully.`;
-        console.warn(msg);
-        return defaultVal;
-    }
-    const keys = contentId.split('.');
-    let current = activeContent;
-    for (const key of keys) {
-        if (current && typeof current === 'object' && key in current) {
-            current = current[key];
-        }
-        else {
-            const msg = `[Contentstorage] getVariation: Path "${contentId}" for variation object not found in loaded content.`;
-            console.warn(msg);
-            return defaultVal;
-        }
-    }
-    if (current &&
-        typeof current === 'object' &&
-        current.contentstorage_type === 'variation' &&
-        typeof current.data === 'object' &&
-        current.data !== null) {
-        const variationObject = current;
-        if (variationKey &&
-            typeof variationKey === 'string' &&
-            variationKey in variationObject.data) {
-            if (typeof variationObject.data[variationKey] === 'string') {
-                const current = variationObject.data[variationKey];
-                if (window.parent && window.parent !== window) {
-                    const key = current;
-                    const existingEntry = window.memoryMap.get(key);
-                    const idSet = existingEntry ? existingEntry.ids : new Set();
-                    idSet.add(contentId); // Add the current ID to the set.
-                    window.memoryMap.set(key, {
-                        ids: idSet,
-                        type: 'variation',
-                        variation: variationKey,
-                    });
-                }
-                if (!variables || Object.keys(variables).length === 0) {
-                    return {
-                        contentId,
-                        text: current,
-                    };
-                }
-                return {
-                    contentId,
-                    text: populateTextWithVariables(current, variables, contentId),
-                };
-            }
-            else {
-                const msg = `[Contentstorage] getVariation: Variation value for key "${variationKey}" at path "${contentId}" is not a string (actual type: ${typeof variationObject.data[variationKey]}).`;
-                console.warn(msg);
-            }
-        }
-        // If specific variationKey is not found or not provided, try to return the 'default' variation
-        if ('default' in variationObject.data && typeof variationKey === 'string') {
-            if (typeof variationObject.data.default === 'string') {
-                if (variationKey && variationKey !== 'default') {
-                    console.warn(`[Contentstorage] getVariation: Variation key "${variationKey}" not found at path "${contentId}". Returning 'default' variation.`);
-                }
-                if (window.parent && window.parent !== window) {
-                    const key = current;
-                    const existingEntry = window.memoryMap.get(key);
-                    const idSet = existingEntry ? existingEntry.ids : new Set();
-                    idSet.add(contentId); // Add the current ID to the set.
-                    window.memoryMap.set(key, {
-                        ids: idSet,
-                        type: 'variation',
-                        variation: 'default',
-                    });
-                }
-                return {
-                    contentId,
-                    text: variationObject.data.default,
-                };
-            }
-            else {
-                console.warn(`[Contentstorage] getVariation: 'default' variation value at path "${contentId}" is not a string (actual type: ${typeof variationObject.data.default}).`);
-            }
-        }
-        // If neither specific key nor 'default' is found or valid
-        console.warn(`[Contentstorage] getVariation: Neither variation key "${variationKey?.toString()}" nor 'default' variation found or valid at path "${contentId}".`);
-        return defaultVal;
-    }
-    else {
-        console.warn(`[Contentstorage] getVariation: Value at path "${contentId}" is not a valid variation object (actual value: ${JSON.stringify(current)}).`);
-        return defaultVal;
-    }
-}

package/dist/lib/functions/fetchContent.d.ts

@@ -1,7 +0,0 @@
-import { LanguageCode } from '../../types.js';
-interface FetchContentOptions {
-    withPendingChanges?: boolean;
-    contentKey?: string;
-}
-export declare function fetchContent(language?: LanguageCode, options?: FetchContentOptions): Promise<void>;
-export {};

package/dist/lib/functions/fetchContent.js

@@ -1,141 +0,0 @@
-import axios from 'axios';
-import { CONTENTSTORAGE_CONFIG } from '../../contentstorage-config.js';
-import { appConfig, setContentLanguage } from '../contentManagement.js';
-// Map of request keys to their debounce timers
-const debounceTimers = new Map();
-// Map of request keys to their cancel token sources
-const cancelTokenSources = new Map();
-// Fixed debounce delay in milliseconds
-const DEBOUNCE_MS = 200;
-export async function fetchContent(language, options = {}) {
-    const { withPendingChanges, contentKey } = options;
-    const languageToFetch = language || appConfig?.languageCodes?.[0];
-    const usePendingChangesToFetch = withPendingChanges || appConfig?.pendingChanges;
-    console.log(`Starting content fetch for language ${language}...`);
-    if (!languageToFetch) {
-        throw Error(`No language found`);
-    }
-    if (!appConfig) {
-        throw Error(`No app config found`);
-    }
-    const effectiveContentKey = contentKey || appConfig.contentKey;
-    let fileUrl;
-    let requestConfig = {};
-    if (usePendingChangesToFetch) {
-        if (!effectiveContentKey) {
-            throw Error(`No contentKey found`);
-        }
-        fileUrl = `${CONTENTSTORAGE_CONFIG.API_URL}/pending-changes/get-json?languageCode=${languageToFetch}`;
-        requestConfig.headers = {
-            'X-Content-Key': effectiveContentKey,
-        };
-        // Apply debouncing and cancellation only for pending-changes API endpoint
-        const requestKey = `${languageToFetch}:${effectiveContentKey}`;
-        // Cancel any existing in-flight request for the same parameters
-        const existingCancelSource = cancelTokenSources.get(requestKey);
-        if (existingCancelSource) {
-            existingCancelSource.cancel('Request cancelled due to new request');
-            cancelTokenSources.delete(requestKey);
-        }
-        // Clear any existing debounce timer for the same parameters
-        const existingTimer = debounceTimers.get(requestKey);
-        if (existingTimer) {
-            clearTimeout(existingTimer);
-            debounceTimers.delete(requestKey);
-        }
-        // Return a promise that will resolve after debouncing
-        return new Promise((resolve, reject) => {
-            const timer = setTimeout(async () => {
-                debounceTimers.delete(requestKey);
-                // Create a cancel token for this request
-                const cancelTokenSource = axios.CancelToken.source();
-                requestConfig.cancelToken = cancelTokenSource.token;
-                cancelTokenSources.set(requestKey, cancelTokenSource);
-                try {
-                    // Fetch data for the current language
-                    const response = await axios.get(fileUrl, requestConfig);
-                    let jsonData = response.data;
-                    // Handle API response structure - only for pending changes API
-                    if (jsonData && typeof jsonData === 'object' && 'data' in jsonData) {
-                        jsonData = jsonData.data;
-                    }
-                    if (jsonData === undefined || jsonData === null) {
-                        throw new Error(`No data received from ${fileUrl} for language ${languageToFetch}.`);
-                    }
-                    // Validate that jsonData is a single, non-null JSON object (not an array)
-                    if (typeof jsonData !== 'object') {
-                        throw new Error(`Expected a single JSON object from ${fileUrl} for language ${languageToFetch}, but received type ${typeof jsonData}. Cannot proceed.`);
-                    }
-                    console.log(`Received JSON for ${languageToFetch}`);
-                    setContentLanguage({
-                        languageCode: languageToFetch,
-                        contentJson: jsonData,
-                    });
-                    // Clean up cancel token source
-                    cancelTokenSources.delete(requestKey);
-                    resolve();
-                }
-                catch (error) {
-                    // Clean up cancel token source
-                    cancelTokenSources.delete(requestKey);
-                    // Don't log cancelled requests as errors
-                    if (axios.isCancel(error)) {
-                        console.log(`Request cancelled for language ${languageToFetch}`);
-                        resolve();
-                        return;
-                    }
-                    // Catch errors related to fetching or saving a single language file
-                    console.error(`\nError processing language ${languageToFetch} from ${fileUrl}:`);
-                    if (axios.isAxiosError(error)) {
-                        console.error(`  Status: ${error.response?.status}`);
-                        console.error(`Response Data: ${error.response?.data ? JSON.stringify(error.response.data) : 'N/A'}`);
-                        console.error(`  Message: ${error.message}`);
-                    }
-                    else {
-                        console.error(`  Error: ${error.message}`);
-                    }
-                    reject(error);
-                }
-            }, DEBOUNCE_MS);
-            debounceTimers.set(requestKey, timer);
-        });
-    }
-    else {
-        fileUrl = `${CONTENTSTORAGE_CONFIG.BASE_URL}/${effectiveContentKey}/content/${languageToFetch}.json`;
-    }
-    try {
-        // Fetch data for the current language (CDN endpoint - no debouncing)
-        const response = await axios.get(fileUrl, requestConfig);
-        let jsonData = response.data;
-        // Handle API response structure - only for pending changes API
-        if (usePendingChangesToFetch && jsonData && typeof jsonData === 'object' && 'data' in jsonData) {
-            jsonData = jsonData.data;
-        }
-        if (jsonData === undefined || jsonData === null) {
-            throw new Error(`No data received from ${fileUrl} for language ${languageToFetch}.`);
-        }
-        // Validate that jsonData is a single, non-null JSON object (not an array)
-        // This check mirrors the original code's expectation for the content of a JSON file.
-        if (typeof jsonData !== 'object') {
-            throw new Error(`Expected a single JSON object from ${fileUrl} for language ${languageToFetch}, but received type ${typeof jsonData}. Cannot proceed.`);
-        }
-        console.log(`Received JSON for ${languageToFetch}`);
-        setContentLanguage({
-            languageCode: languageToFetch,
-            contentJson: jsonData,
-        });
-    }
-    catch (error) {
-        // Catch errors related to fetching or saving a single language file
-        console.error(`\nError processing language ${languageToFetch} from ${fileUrl}:`);
-        if (axios.isAxiosError(error)) {
-            console.error(`  Status: ${error.response?.status}`);
-            console.error(`Response Data: ${error.response?.data ? JSON.stringify(error.response.data) : 'N/A'}`);
-            console.error(`  Message: ${error.message}`); // Axios error message
-        }
-        else {
-            // For non-Axios errors (e.g., manually thrown errors, fs errors)
-            console.error(`  Error: ${error.message}`);
-        }
-    }
-}

package/dist/scripts/cli.d.ts

@@ -1,2 +0,0 @@
-#!/usr/bin/env node
-export {};

package/dist/scripts/cli.js

@@ -1,96 +0,0 @@
-#!/usr/bin/env node
-import chalk from 'chalk';
-import { pullContent } from './pull-content.js';
-import { generateTypes } from './generate-types.js';
-const COMMANDS = {
-    pull: {
-        name: 'pull',
-        description: 'Pull content from Contentstorage CDN',
-        usage: 'contentstorage pull [options]',
-        options: [
-            '  --content-key <key>    Content key for your project',
-            '  --content-dir <dir>    Directory to save content files',
-            '  --lang <code>          Language code (e.g., EN, FR)',
-            '  --pending-changes      Fetch pending/draft content',
-        ],
-    },
-    'generate-types': {
-        name: 'generate-types',
-        description: 'Generate TypeScript type definitions from content',
-        usage: 'contentstorage generate-types [options]',
-        options: [
-            '  --output <file>        Output file for generated types',
-            '  --content-key <key>    Content key for your project',
-            '  --lang <code>          Language code (e.g., EN, FR)',
-            '  --pending-changes      Use pending/draft content',
-        ],
-    },
-};
-function showHelp() {
-    console.log(chalk.bold('\nContentStorage CLI'));
-    console.log(chalk.dim('Manage content and generate TypeScript types\n'));
-    console.log(chalk.bold('Usage:'));
-    console.log('  contentstorage <command> [options]\n');
-    console.log(chalk.bold('Commands:'));
-    Object.values(COMMANDS).forEach((cmd) => {
-        console.log(`  ${chalk.cyan(cmd.name.padEnd(20))} ${cmd.description}`);
-    });
-    console.log(chalk.bold('\nOptions:'));
-    console.log('  --help                 Show help for a command\n');
-    console.log(chalk.dim('Examples:'));
-    console.log(chalk.dim('  contentstorage pull --content-key abc123'));
-    console.log(chalk.dim('  contentstorage generate-types --output types.ts'));
-    console.log(chalk.dim('  contentstorage pull --help    # Show help for pull command\n'));
-}
-function showCommandHelp(commandName) {
-    const cmd = COMMANDS[commandName];
-    if (!cmd) {
-        console.error(chalk.red(`Unknown command: ${commandName}`));
-        process.exit(1);
-    }
-    console.log(chalk.bold(`\n${cmd.name}`));
-    console.log(chalk.dim(cmd.description + '\n'));
-    console.log(chalk.bold('Usage:'));
-    console.log(`  ${cmd.usage}\n`);
-    if (cmd.options.length > 0) {
-        console.log(chalk.bold('Options:'));
-        cmd.options.forEach((opt) => console.log(opt));
-        console.log('');
-    }
-}
-async function main() {
-    const args = process.argv.slice(2);
-    // No arguments - show help
-    if (args.length === 0) {
-        showHelp();
-        process.exit(0);
-    }
-    const command = args[0];
-    // Global --help flag
-    if (command === '--help' || command === '-h') {
-        showHelp();
-        process.exit(0);
-    }
-    // Command-specific --help
-    if (args.includes('--help') || args.includes('-h')) {
-        showCommandHelp(command);
-        process.exit(0);
-    }
-    // Route to commands
-    switch (command) {
-        case 'pull':
-            await pullContent();
-            break;
-        case 'generate-types':
-            await generateTypes();
-            break;
-        default:
-            console.error(chalk.red(`Unknown command: ${command}\n`));
-            console.log(chalk.dim('Run "contentstorage --help" for usage'));
-            process.exit(1);
-    }
-}
-main().catch((error) => {
-    console.error(chalk.red('Unexpected error:'), error);
-    process.exit(1);
-});

package/dist/scripts/generate-types.d.ts

@@ -1,2 +0,0 @@
-#!/usr/bin/env node
-export declare function generateTypes(): Promise<void>;