@contentstorage/core 1.0.1 → 1.1.0

package/dist/contentstorage-config.d.ts

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

package/dist/contentstorage-config.js

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

package/dist/index.d.ts

@@ -2,5 +2,5 @@ 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, };
-export declare let isInContentstorageIframe: boolean;
+export { initContentStorage, fetchContent, setContentLanguage, getText, getImage, getVariation, liveEditorReady, };
+declare function liveEditorReady(retries?: number, delay?: number): Promise<boolean>;

package/dist/index.js

@@ -1,7 +1,8 @@
+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, };
-export let isInContentstorageIframe = false;
+export { initContentStorage, fetchContent, setContentLanguage, getText, getImage, getVariation, liveEditorReady, };
+let liveEditorReadyPromise = null;
 async function isLiveEditorMode() {
     try {
         const inIframe = window.self !== window.top;
@@ -10,44 +11,52 @@ async function isLiveEditorMode() {
         return !!(inIframe && iframeMarkerFromParent);
     }
     catch (e) {
-        // This catch block is for rare edge cases or highly sandboxed environments
-        // where accessing window.top might throw an error.
-        // If an error occurs, it's safer to assume it might be in an iframe.
-        console.warn('Error accessing window.top, assuming iframe context:', e);
+        console.warn('Error accessing window.top:', e);
         return false;
     }
 }
-isLiveEditorMode().then(async (isLiveMode) => {
-    console.log('isLiveMode', isLiveMode);
-    if (!isLiveMode) {
-        return;
+function liveEditorReady(retries = 2, delay = 3000) {
+    if (liveEditorReadyPromise) {
+        return liveEditorReadyPromise;
     }
-    isInContentstorageIframe = true;
-    const cdnScriptUrl = `https://cdn.contentstorage.app/live-editor.js?contentstorage-live-editor=true`;
-    return new Promise((resolve, reject) => {
-        console.log(`Attempting to load script from: ${cdnScriptUrl}`);
-        // 1. Create a new <script> element
-        const scriptElement = document.createElement('script');
-        scriptElement.type = 'text/javascript';
-        // 2. Set the src attribute to your script's URL
-        // The browser will fetch and execute it.
-        scriptElement.src = cdnScriptUrl;
-        // 3. Handle successful loading
-        scriptElement.onload = () => {
-            console.log(`Script loaded successfully from: ${cdnScriptUrl}`);
-            // The script has been fetched and executed by the browser.
-            // If it's an IIFE, it has already run.
-            resolve(true); // Resolve the promise indicating success
+    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);
         };
-        // 4. Handle errors during loading (e.g., network error, 404)
-        scriptElement.onerror = (error) => {
-            console.error(`Failed to load script from: ${cdnScriptUrl}`, error);
-            reject(new Error(`Failed to load script: ${cdnScriptUrl}`)); // Reject the promise
-        };
-        // 5. Append the script element to the document's head (or body)
-        // This triggers the browser to start loading the script.
-        document.head.appendChild(scriptElement);
-        // Or: document.body.appendChild(scriptElement);
+        loadScript();
+    });
+    return liveEditorReadyPromise;
+}
+if (typeof window !== 'undefined') {
+    liveEditorReady().then((result) => {
+        if (result === true) {
+            console.log('Contentstorage live editor script loaded!');
+        }
     });
-    // fetch script to handle iframe communication
-});
+}

package/dist/lib/contentManagement.d.ts

@@ -1,6 +1,6 @@
 import { AppConfig, ContentStructure, GetImageReturn, GetTextReturn, GetVariationReturn, LanguageCode } from '../types.js';
 export declare let activeContent: object | null;
-export declare let appConfig: Pick<AppConfig, 'contentKey' | 'languageCodes'> | 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.

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

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

package/dist/lib/functions/fetchContent.js

@@ -1,8 +1,10 @@
 import axios from 'axios';
 import { CONTENTSTORAGE_CONFIG } from '../../contentstorage-config.js';
 import { appConfig, setContentLanguage } from '../contentManagement.js';
-export async function fetchContent(language) {
+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`);
@@ -10,10 +12,24 @@ export async function fetchContent(language) {
     if (!appConfig) {
         throw Error(`No app config found`);
     }
-    const fileUrl = `${CONTENTSTORAGE_CONFIG.BASE_URL}/${appConfig.contentKey}/content/${languageToFetch}.json`;
+    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,
+        };
+    }
+    else {
+        fileUrl = `${CONTENTSTORAGE_CONFIG.BASE_URL}/${effectiveContentKey}/content/${languageToFetch}.json`;
+    }
     try {
         // Fetch data for the current language
-        const response = await axios.get(fileUrl);
+        const response = await axios.get(fileUrl, requestConfig);
         const jsonData = response.data;
         if (jsonData === undefined || jsonData === null) {
             throw new Error(`No data received from ${fileUrl} for language ${languageToFetch}.`);

package/dist/scripts/generate-types.js

@@ -17,7 +17,10 @@ export async function generateTypes() {
         if (arg.startsWith('--')) {
             const key = arg.substring(2);
             const value = args[i + 1];
-            if (value && !value.startsWith('--')) {
+            if (key === 'pending-changes') {
+                cliConfig.pendingChanges = true;
+            }
+            else if (value && !value.startsWith('--')) {
                 if (key === 'lang') {
                     cliConfig.languageCodes = [value.toUpperCase()];
                 }
@@ -103,11 +106,21 @@ export async function generateTypes() {
             if (!config.contentKey) {
                 throw new Error('Cannot generate types: contentKey is missing');
             }
-            const fileUrl = `${CONTENTSTORAGE_CONFIG.BASE_URL}/${config.contentKey}/content/${firstLanguageCode}.json`; // Adjust URL construction if necessary
+            let fileUrl;
+            const requestConfig = { responseType: 'json' };
+            if (config.pendingChanges) {
+                fileUrl = `${CONTENTSTORAGE_CONFIG.API_URL}/pending-changes/get-json?languageCode=${firstLanguageCode}`;
+                requestConfig.headers = {
+                    'X-Content-Key': config.contentKey,
+                };
+            }
+            else {
+                fileUrl = `${CONTENTSTORAGE_CONFIG.BASE_URL}/${config.contentKey}/content/${firstLanguageCode}.json`;
+            }
             dataSourceDescription = `remote URL (${fileUrl})`;
             console.log(chalk.blue(`Attempting to fetch JSON from: ${fileUrl}`));
             try {
-                const response = await axios.get(fileUrl, { responseType: 'json' });
+                const response = await axios.get(fileUrl, requestConfig);
                 const jsonResponse = response.data;
                 console.log(chalk.blue('Flattening JSON for type generation'));
                 jsonObject = flattenJson(jsonResponse);

package/dist/scripts/pull-content.js

@@ -7,13 +7,48 @@ import { loadConfig } from '../lib/configLoader.js';
 import { CONTENTSTORAGE_CONFIG } from '../contentstorage-config.js';
 export async function pullContent() {
     console.log(chalk.blue('Starting content pull...'));
-    // Load configuration (assuming this function is defined elsewhere and works)
-    const config = await loadConfig();
+    const args = process.argv.slice(2);
+    const cliConfig = {};
+    for (let i = 0; i < args.length; i++) {
+        const arg = args[i];
+        if (arg.startsWith('--')) {
+            const key = arg.substring(2);
+            const value = args[i + 1];
+            if (key === 'pending-changes') {
+                cliConfig.pendingChanges = true;
+            }
+            else if (value && !value.startsWith('--')) {
+                if (key === 'lang') {
+                    cliConfig.languageCodes = [value.toUpperCase()];
+                }
+                else if (key === 'content-key') {
+                    cliConfig.contentKey = value;
+                }
+                else if (key === 'content-dir') {
+                    cliConfig.contentDir = value;
+                }
+                // Skip the value in the next iteration
+                i++;
+            }
+        }
+    }
+    let fileConfig = {};
+    try {
+        fileConfig = await loadConfig();
+    }
+    catch {
+        console.log(chalk.yellow('Could not load a configuration file. Proceeding with CLI arguments.'));
+    }
+    const config = { ...fileConfig, ...cliConfig };
     // Validate required fields
     if (!config.contentKey) {
         console.error(chalk.red('Error: Configuration is missing the required "contentKey" property.'));
         process.exit(1);
     }
+    if (!config.contentDir) {
+        console.error(chalk.red('Error: Configuration is missing the required "contentDir" property.'));
+        process.exit(1);
+    }
     console.log(chalk.blue(`Content key: ${config.contentKey}`));
     console.log(chalk.blue(`Saving content to: ${config.contentDir}`));
     try {
@@ -30,14 +65,24 @@ export async function pullContent() {
         await fs.mkdir(config.contentDir, { recursive: true });
         // Process each language code
         for (const languageCode of config.languageCodes) {
-            const fileUrl = `${CONTENTSTORAGE_CONFIG.BASE_URL}/${config.contentKey}/content/${languageCode}.json`;
+            let fileUrl;
+            const requestConfig = {};
+            if (config.pendingChanges) {
+                fileUrl = `${CONTENTSTORAGE_CONFIG.API_URL}/pending-changes/get-json?languageCode=${languageCode}`;
+                requestConfig.headers = {
+                    'X-Content-Key': config.contentKey
+                };
+            }
+            else {
+                fileUrl = `${CONTENTSTORAGE_CONFIG.BASE_URL}/${config.contentKey}/content/${languageCode}.json`;
+            }
             const filename = `${languageCode}.json`;
             const outputPath = path.join(config.contentDir, filename);
             console.log(chalk.blue(`\nProcessing language: ${languageCode}`));
             console.log(chalk.blue(`Using following contentKey to fetch json: ${config.contentKey}`));
             try {
                 // Fetch data for the current language
-                const response = await axios.get(fileUrl);
+                const response = await axios.get(fileUrl, requestConfig);
                 const jsonData = response.data;
                 // Basic check for data existence, although axios usually throws for non-2xx responses
                 if (jsonData === undefined || jsonData === null) {

package/dist/types.d.ts

@@ -3,6 +3,7 @@ export type AppConfig = {
     contentKey: string;
     contentDir: string;
     typesOutputFile: string;
+    pendingChanges?: 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';
 /**
@@ -11,14 +12,6 @@ export type LanguageCode = 'SQ' | 'BE' | 'BS' | 'BG' | 'HR' | 'CS' | 'DA' | 'NL'
  * consumers enable type-safe autocompletion for localization path strings
  * used with functions like `getText`.
  *
- * @example
- * // In consumer's project (e.g., in a .d.ts file):
- * import 'your-library-name'; // Your library's package name
- * import type { RootContentItem as AppSpecificRootItem } from './generated_content_types';
- *
- * declare module 'your-library-name' {
- * export interface ContentStructure extends AppSpecificRootItem {}
- * }
  */
 export interface ContentStructure {
 }

package/package.json

@@ -2,7 +2,7 @@
   "name": "@contentstorage/core",
   "author": "Kaido Hussar <kaidohus@gmail.com>",
   "homepage": "https://contentstorage.app",
-  "version": "1.0.1",
+  "version": "1.1.0",
   "type": "module",
   "description": "Fetch content from contentstorage and generate TypeScript types",
   "module": "dist/index.js",
@@ -45,6 +45,9 @@
   "engines": {
     "node": ">=18.0.0"
   },
+  "sideEffects": [
+    "./dist/index.js"
+  ],
   "publishConfig": {
     "access": "public"
   },