@contentstorage/core 2.1.1 → 2.2.1

package/README.md

@@ -1,17 +1,17 @@
 # @contentstorage/core
 
-> CLI tool for managing translations and generating TypeScript types from ContentStorage
+> CLI tool for managing translations and generating TypeScript types from Contentstorage
 
 [![npm version](https://img.shields.io/npm/v/@contentstorage/core.svg)](https://www.npmjs.com/package/@contentstorage/core)
 [![License](https://img.shields.io/npm/l/@contentstorage/core.svg)](https://github.com/kaidohussar/contentstorage-core/blob/master/LICENSE)
 
 ## Overview
 
-ContentStorage Core is a powerful CLI tool for managing translations and content. It pulls content from ContentStorage CDN, generates TypeScript types, and integrates seamlessly with popular i18n libraries.
+Contentstorage Core is a powerful CLI tool for managing translations and content. It pulls content from Contentstorage CDN, generates TypeScript types, and integrates seamlessly with popular i18n libraries.
 
 ## Features
 
-- **Translation Management** - Pull content from ContentStorage CDN
+- **Translation Management** - Pull content from Contentstorage CDN
 - **TypeScript Generation** - Automatic type generation from your content
 - **Translation Statistics** - Analyze translation completeness across languages
 - **Multi-Language Support** - Built-in support for 40+ languages
@@ -48,7 +48,7 @@ export default {
 ### 2. Pull Content & Generate Types
 
 ```bash
-# Pull content from ContentStorage CDN
+# Pull content from Contentstorage CDN
 npx contentstorage pull
 
 # Generate TypeScript type definitions
@@ -69,7 +69,7 @@ npm install @contentstorage/plugin-react-intl
 npx contentstorage-react-intl export
 ```
 
-**With ContentStorage SDK (for advanced features like variations and images):**
+**With Contentstorage SDK (for advanced features like variations and images):**
 ```bash
 npm install @contentstorage/sdk
 ```
@@ -78,7 +78,7 @@ npm install @contentstorage/sdk
 
 ### `contentstorage pull`
 
-Pull content from ContentStorage CDN
+Pull content from Contentstorage CDN
 
 ```bash
 npx contentstorage pull [options]
@@ -193,13 +193,13 @@ EN, FR, DE, ES, IT, PT, NL, PL, RU, TR, SV, NO, DA, FI, CS, SK, HU, RO, BG, HR,
 
 ### Option 1: Use with i18n Libraries (Recommended for most projects)
 
-For standard i18n needs, use ContentStorage CLI with popular i18n libraries:
+For standard i18n needs, use Contentstorage CLI with popular i18n libraries:
 
 - **[@contentstorage/plugin-i18next](https://www.npmjs.com/package/@contentstorage/plugin-i18next)** - i18next integration
 - **[@contentstorage/plugin-react-intl](https://www.npmjs.com/package/@contentstorage/plugin-react-intl)** - react-intl (FormatJS) integration
 - **[@contentstorage/plugin-vue-i18n](https://www.npmjs.com/package/@contentstorage/plugin-vue-i18n)** - Vue i18n integration
 
-### Option 2: Use with ContentStorage SDK (Advanced features)
+### Option 2: Use with Contentstorage SDK (Advanced features)
 
 If you need advanced features like variations (A/B testing) and image management:
 
@@ -306,7 +306,7 @@ npm run content:sync    # Pull and generate in one command
 
 ## SDK Extract
 
-The `/sdk-extract` folder contains the ContentStorage SDK code ready to be moved to a separate repository. This SDK provides runtime features like:
+The `/sdk-extract` folder contains the Contentstorage SDK code ready to be moved to a separate repository. This SDK provides runtime features like:
 - getText/getImage/getVariation functions
 - Content variations (A/B testing)
 - Image management
@@ -335,4 +335,4 @@ Kaido Hussar - [kaidohus@gmail.com](mailto:kaidohus@gmail.com)
 
 ## Support
 
-For issues and questions, please [open an issue](https://github.com/kaidohussar/contentstorage-core/issues) on GitHub.
+For issues and questions, please [open an issue](https://github.com/kaidohussar/contentstorage-core/issues) on GitHub.

package/dist/commands/cli.js

@@ -13,6 +13,7 @@ const COMMANDS = {
             '  --content-dir <dir>    Directory to save content files',
             '  --lang <code>          Language code (e.g., EN, FR)',
             '  --pending-changes      Fetch pending/draft content',
+            '  --flatten              Output flattened key-value pairs',
         ],
     },
     'generate-types': {
@@ -38,7 +39,7 @@ const COMMANDS = {
     },
 };
 function showHelp() {
-    console.log(chalk.bold('\nContentStorage CLI'));
+    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');

package/dist/commands/pull.js

@@ -5,6 +5,7 @@ import path from 'path';
 import chalk from 'chalk';
 import { loadConfig } from '../core/config-loader.js';
 import { CONTENTSTORAGE_CONFIG } from '../utils/constants.js';
+import { flattenJson } from '../utils/flatten-json.js';
 export async function pullContent() {
     console.log(chalk.blue('Starting content pull...'));
     const args = process.argv.slice(2);
@@ -17,6 +18,9 @@ export async function pullContent() {
             if (key === 'pending-changes') {
                 cliConfig.pendingChanges = true;
             }
+            else if (key === 'flatten') {
+                cliConfig.flatten = true;
+            }
             else if (value && !value.startsWith('--')) {
                 if (key === 'lang') {
                     cliConfig.languageCodes = [value.toUpperCase()];
@@ -102,7 +106,8 @@ export async function pullContent() {
                     throw new Error(`Expected a single JSON object from ${fileUrl} for language ${languageCode}, but received type ${Array.isArray(jsonData) ? 'array' : typeof jsonData}. Cannot save the file.`);
                 }
                 console.log(chalk.green(`Received JSON for ${languageCode}. Saving to ${outputPath}`));
-                await fs.writeFile(outputPath, JSON.stringify(jsonData, null, 2));
+                const outputData = config.flatten ? flattenJson(jsonData) : jsonData;
+                await fs.writeFile(outputPath, JSON.stringify(outputData, null, 2));
                 console.log(chalk.green(`Successfully saved ${outputPath}`));
             }
             catch (error) {

package/dist/types.d.ts

@@ -4,6 +4,7 @@ export type AppConfig = {
     contentDir: string;
     typesOutputFile: string;
     pendingChanges?: boolean;
+    flatten?: boolean;
 };
 export type LanguageCode = 'SQ' | 'BE' | 'BS' | 'BG' | 'HR' | 'CS' | 'DA' | 'NL' | 'EN' | 'ET' | 'FI' | 'FR' | 'DE' | 'EL' | 'HU' | 'GA' | 'IT' | 'LV' | 'LT' | 'MK' | 'NO' | 'PL' | 'PT' | 'RO' | 'RU' | 'SR' | 'SK' | 'SL' | 'ES' | 'SV' | 'TR' | 'UK';
 /**

package/dist/utils/flatten-json.d.ts

@@ -1 +1 @@
-export declare function flattenJson(data: any, prefix?: string, result?: Record<string, any>): Record<string, any>;
+export declare function flattenJson(data: any, prefix?: string, result?: Record<string, string>): Record<string, string>;

package/dist/utils/flatten-json.js

@@ -1,56 +1,21 @@
 export function flattenJson(data, prefix = '', result = {}) {
-    const stopFlatteningIfKeyExists = 'contentstorage_type';
-    // Check if the current data is an object that should not be flattened further
-    if (typeof data === 'object' &&
-        data !== null &&
-        !Array.isArray(data) && // Must be an object, not an array
-        Object.prototype.hasOwnProperty.call(data, stopFlatteningIfKeyExists)) {
-        if (prefix) {
-            // If there's a prefix, this object is nested. Assign it directly.
-            result[prefix] = data;
-        }
-        else {
-            // This is the root object itself having the 'stopFlatteningIfKeyExists' key.
-            // Consistent with how root primitives are handled (result remains empty),
-            // we don't add it to the result if there's no prefix. The function's
-            // purpose is to flatten *into* key-value pairs. If the root itself
-            // is one of these "don't flatten" types, 'result' will remain empty,
-            // which is consistent with the original function's behavior for root primitives.
-        }
-    }
-    else if (typeof data === 'object' && data !== null) {
-        // It's an object or array that should be processed further
+    if (typeof data === 'object' && data !== null) {
         if (Array.isArray(data)) {
-            if (data.length === 0 && prefix) {
-                // Handle empty arrays if prefix exists
-                result[prefix] = [];
-            }
             data.forEach((item, index) => {
-                // Recursively call, the check for 'stopFlatteningIfKeyExists' will apply to 'item'
                 flattenJson(item, prefix ? `${prefix}.${index}` : `${index}`, result);
             });
         }
         else {
-            let isEmptyObject = true;
             for (const key in data) {
                 if (Object.prototype.hasOwnProperty.call(data, key)) {
-                    isEmptyObject = false;
                     const newPrefix = prefix ? `${prefix}.${key}` : key;
-                    // Recursively call, the check for 'stopFlatteningIfKeyExists' will apply to 'data[key]'
                     flattenJson(data[key], newPrefix, result);
                 }
             }
-            if (isEmptyObject && prefix) {
-                // Handle empty objects (that were not 'special') if prefix exists
-                result[prefix] = {};
-            }
         }
     }
     else if (prefix) {
-        result[prefix] = data;
+        result[prefix] = String(data);
     }
-    // If the initial data is a primitive and prefix is empty, result remains empty.
-    // If the initial data is a 'special' object (contains 'stopFlatteningIfKeyExists')
-    // and prefix is empty, result also remains empty based on the logic above.
     return result;
 }

package/package.json

@@ -2,9 +2,9 @@
   "name": "@contentstorage/core",
   "author": "Kaido Hussar <kaido@contentstorage.app>",
   "homepage": "https://contentstorage.app",
-  "version": "2.1.1",
+  "version": "2.2.1",
   "type": "module",
-  "description": "ContentStorage CLI for managing translations and generating TypeScript types",
+  "description": "Contentstorage CLI for managing translations and generating TypeScript types",
   "license": "MIT",
   "bin": {
     "contentstorage": "dist/commands/cli.js"

package/dist/contentstorage-config.d.ts

@@ -1,4 +0,0 @@
-export declare const CONTENTSTORAGE_CONFIG: {
-    BASE_URL: string;
-    API_URL: string;
-};

package/dist/contentstorage-config.js

@@ -1,4 +0,0 @@
-export const CONTENTSTORAGE_CONFIG = {
-    BASE_URL: 'https://cdn.contentstorage.app',
-    API_URL: 'https://api.contentstorage.app',
-};

package/dist/helpers/defineConfig.d.ts

@@ -1,6 +0,0 @@
-import { AppConfig } from '../types.js';
-/**
- * Helper function to define your application configuration.
- * Provides autocompletion and type-checking for contentstorage.config.js files.
- */
-export declare function defineConfig(config: AppConfig): AppConfig;

package/dist/helpers/defineConfig.js

@@ -1,19 +0,0 @@
-/**
- * Helper function to define your application configuration.
- * Provides autocompletion and type-checking for contentstorage.config.js files.
- */
-export function defineConfig(config) {
-    // You can add basic runtime validation here if desired,
-    // e.g., check if contentUrl is a valid URL format,
-    // or if languageCodes is not empty.
-    if (!config.languageCodes || config.languageCodes.length === 0) {
-        console.warn('Warning: languageCodes array is empty or missing in the configuration.');
-    }
-    if (!config.contentDir) {
-        // This would typically be a hard error, but defineConfig is more for type safety at edit time.
-        // Runtime validation (see point 3) is better for hard errors.
-        console.warn('Warning: contentDir is missing in the configuration.');
-    }
-    // ... other checks
-    return config;
-}

package/dist/helpers/flattenJson.d.ts

@@ -1 +0,0 @@
-export declare function flattenJson(data: any, prefix?: string, result?: Record<string, any>): Record<string, any>;

package/dist/helpers/flattenJson.js

@@ -1,56 +0,0 @@
-export function flattenJson(data, prefix = '', result = {}) {
-    const stopFlatteningIfKeyExists = 'contentstorage_type';
-    // Check if the current data is an object that should not be flattened further
-    if (typeof data === 'object' &&
-        data !== null &&
-        !Array.isArray(data) && // Must be an object, not an array
-        Object.prototype.hasOwnProperty.call(data, stopFlatteningIfKeyExists)) {
-        if (prefix) {
-            // If there's a prefix, this object is nested. Assign it directly.
-            result[prefix] = data;
-        }
-        else {
-            // This is the root object itself having the 'stopFlatteningIfKeyExists' key.
-            // Consistent with how root primitives are handled (result remains empty),
-            // we don't add it to the result if there's no prefix. The function's
-            // purpose is to flatten *into* key-value pairs. If the root itself
-            // is one of these "don't flatten" types, 'result' will remain empty,
-            // which is consistent with the original function's behavior for root primitives.
-        }
-    }
-    else if (typeof data === 'object' && data !== null) {
-        // It's an object or array that should be processed further
-        if (Array.isArray(data)) {
-            if (data.length === 0 && prefix) {
-                // Handle empty arrays if prefix exists
-                result[prefix] = [];
-            }
-            data.forEach((item, index) => {
-                // Recursively call, the check for 'stopFlatteningIfKeyExists' will apply to 'item'
-                flattenJson(item, prefix ? `${prefix}.${index}` : `${index}`, result);
-            });
-        }
-        else {
-            let isEmptyObject = true;
-            for (const key in data) {
-                if (Object.prototype.hasOwnProperty.call(data, key)) {
-                    isEmptyObject = false;
-                    const newPrefix = prefix ? `${prefix}.${key}` : key;
-                    // Recursively call, the check for 'stopFlatteningIfKeyExists' will apply to 'data[key]'
-                    flattenJson(data[key], newPrefix, result);
-                }
-            }
-            if (isEmptyObject && prefix) {
-                // Handle empty objects (that were not 'special') if prefix exists
-                result[prefix] = {};
-            }
-        }
-    }
-    else if (prefix) {
-        result[prefix] = data;
-    }
-    // If the initial data is a primitive and prefix is empty, result remains empty.
-    // If the initial data is a 'special' object (contains 'stopFlatteningIfKeyExists')
-    // and prefix is empty, result also remains empty based on the logic above.
-    return result;
-}

package/dist/helpers/populateTextWithVariables.d.ts

@@ -1 +0,0 @@
-export declare function populateTextWithVariables(text: string, variables: Record<string, any>, textKey: string): string;

package/dist/helpers/populateTextWithVariables.js

@@ -1,10 +0,0 @@
-export function populateTextWithVariables(text, variables, textKey) {
-    return text.replace(/\{(\w+)}/g, (placeholder, variableName) => {
-        if (Object.prototype.hasOwnProperty.call(variables, variableName)) {
-            const value = variables[variableName];
-            return String(value);
-        }
-        console.warn(`[getText] Variable "${variableName}" for text id "${textKey}" not found in provided variables. Placeholder "${placeholder}" will be replaced with an empty string.`);
-        return placeholder;
-    });
-}

package/dist/index.d.ts

@@ -1,6 +0,0 @@
-import { AppConfig, LanguageCode, ContentStructure } from './types.js';
-import { setContentLanguage, getText, getImage, getVariation, initContentStorage } from './lib/contentManagement.js';
-import { fetchContent } from './lib/functions/fetchContent.js';
-export { AppConfig, LanguageCode, ContentStructure };
-export { initContentStorage, fetchContent, setContentLanguage, getText, getImage, getVariation, liveEditorReady, };
-declare function liveEditorReady(retries?: number, delay?: number): Promise<boolean>;

package/dist/index.js

@@ -1,62 +0,0 @@
-import { CONTENTSTORAGE_CONFIG } from './contentstorage-config.js';
-import { setContentLanguage, getText, getImage, getVariation, initContentStorage, } from './lib/contentManagement.js';
-import { fetchContent } from './lib/functions/fetchContent.js';
-export { initContentStorage, fetchContent, setContentLanguage, getText, getImage, getVariation, liveEditorReady, };
-let liveEditorReadyPromise = null;
-async function isLiveEditorMode() {
-    try {
-        const inIframe = window.self !== window.top;
-        const urlParams = new URLSearchParams(window.location.search);
-        const iframeMarkerFromParent = urlParams.get('contentstorage_live_editor');
-        return !!(inIframe && iframeMarkerFromParent);
-    }
-    catch (e) {
-        console.warn('Error accessing window.top:', e);
-        return false;
-    }
-}
-function liveEditorReady(retries = 2, delay = 3000) {
-    if (liveEditorReadyPromise) {
-        return liveEditorReadyPromise;
-    }
-    liveEditorReadyPromise = new Promise(async (resolve) => {
-        const isLiveMode = await isLiveEditorMode();
-        if (!isLiveMode) {
-            resolve(false);
-            return;
-        }
-        const cdnScriptUrl = `${CONTENTSTORAGE_CONFIG.BASE_URL}/live-editor.js?contentstorage-live-editor=true`;
-        const loadScript = (attempt = 1) => {
-            console.log(`Attempting to load Contentstorage live editor script (attempt ${attempt}/${retries})`);
-            const scriptElement = document.createElement('script');
-            scriptElement.type = 'text/javascript';
-            scriptElement.src = cdnScriptUrl;
-            scriptElement.onload = () => {
-                console.log(`Script loaded successfully from: ${cdnScriptUrl}`);
-                resolve(true);
-            };
-            scriptElement.onerror = (error) => {
-                // Clean up the failed script element to avoid clutter
-                scriptElement.remove();
-                console.error(`Failed to load script (attempt ${attempt}/${retries})`, error);
-                if (attempt < retries) {
-                    setTimeout(() => loadScript(attempt + 1), delay);
-                }
-                else {
-                    console.error(`All ${retries} attempts to load the script failed.`);
-                    resolve(false);
-                }
-            };
-            document.head.appendChild(scriptElement);
-        };
-        loadScript();
-    });
-    return liveEditorReadyPromise;
-}
-if (typeof window !== 'undefined') {
-    liveEditorReady().then((result) => {
-        if (result === true) {
-            console.log('Contentstorage live editor script loaded!');
-        }
-    });
-}

package/dist/lib/configLoader.d.ts

@@ -1,2 +0,0 @@
-import { AppConfig } from '../types.js';
-export declare function loadConfig(): Promise<AppConfig>;

package/dist/lib/configLoader.js

@@ -1,42 +0,0 @@
-import path from 'path';
-import fs from 'fs';
-import chalk from 'chalk';
-const DEFAULT_CONFIG = {
-    languageCodes: [],
-    contentDir: path.join('src', 'content', 'json'),
-    typesOutputFile: path.join('src', 'content', 'content-types.ts'),
-};
-export async function loadConfig() {
-    const configPath = path.resolve(process.cwd(), 'contentstorage.config.js'); // Look in user's current working dir
-    let userConfig = {};
-    if (fs.existsSync(configPath)) {
-        try {
-            // Use require for JS config file
-            const loadedModule = await import(configPath);
-            userConfig = loadedModule.default || loadedModule;
-            console.log(chalk.blue('Loaded config', JSON.stringify(userConfig)));
-            console.log(chalk.blue(`Loaded configuration from ${configPath}`));
-        }
-        catch (error) {
-            console.error(chalk.red(`Error loading configuration from ${configPath}:`, error));
-            // Decide if you want to proceed with defaults or exit
-            // For now, we'll proceed with defaults but warn
-            console.warn(chalk.yellow('Proceeding with default configuration.'));
-            userConfig = {}; // Reset in case of partial load failure
-        }
-    }
-    else {
-        console.log(chalk.blue('No content.config.js found. Continuing.'));
-    }
-    const mergedConfig = {
-        ...DEFAULT_CONFIG,
-        ...userConfig,
-    };
-    const finalConfig = {
-        languageCodes: mergedConfig.languageCodes || [],
-        contentKey: mergedConfig.contentKey || '',
-        contentDir: path.resolve(process.cwd(), mergedConfig.contentDir),
-        typesOutputFile: path.resolve(process.cwd(), mergedConfig.typesOutputFile),
-    };
-    return finalConfig;
-}

package/dist/lib/contentManagement.d.ts

@@ -1,32 +0,0 @@
-import { AppConfig, ContentStructure, GetImageReturn, GetTextReturn, GetVariationReturn, LanguageCode } from '../types.js';
-export declare let activeContent: object | null;
-export declare let appConfig: Pick<AppConfig, 'contentKey' | 'languageCodes' | 'pendingChanges'> | 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 declare function setContentLanguage({ languageCode, contentJson, }: {
-    languageCode: LanguageCode;
-    contentJson: object;
-}): void;
-export declare function initContentStorage(config: Pick<AppConfig, 'contentKey' | 'languageCodes'>): void;
-/**
- * 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 declare function getText<Path extends keyof ContentStructure>(contentId: Path, variables?: ContentStructure[Path] extends {
-    variables: infer Vars;
-} ? keyof Vars : Record<string, any>): GetTextReturn;
-export declare function getImage(contentId: keyof ContentStructure): GetImageReturn | undefined;
-export declare function getVariation<Path extends keyof ContentStructure>(contentId: Path, variationKey?: ContentStructure[Path] extends {
-    data: infer D;
-} ? keyof D : string, variables?: Record<string, any>): GetVariationReturn;