@contentstorage/core 0.4.0 → 0.5.0

package/dist/lib/contentManagement.d.ts

@@ -5,6 +5,8 @@ export declare let appConfig: Pick<AppConfig, 'contentKey' | 'languageCodes'> |
  * 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;
@@ -21,10 +23,10 @@ export declare function initContentStorage(config: Pick<AppConfig, 'contentKey'
  * 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>(contentKey: Path, variables?: ContentStructure[Path] extends {
+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(contentKey: keyof ContentStructure): GetImageReturn | undefined;
-export declare function getVariation<Path extends keyof ContentStructure>(contentKey: Path, variationKey?: ContentStructure[Path] extends {
+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;

package/dist/lib/contentManagement.js

@@ -10,6 +10,8 @@ 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') {
@@ -53,24 +55,24 @@ export function initContentStorage(config) {
  * 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(contentKey, variables) {
+export function getText(contentId, variables) {
     const defaultVal = {
-        contentKey,
+        contentId,
         text: '',
     };
     if (!activeContent) {
-        const msg = `[Contentstorage] getText: Content not loaded (Key: "${String(contentKey)}"). Ensure setContentLanguage() was called and completed successfully.`;
+        const msg = `[Contentstorage] getText: Content not loaded (Key: "${String(contentId)}"). Ensure setContentLanguage() was called and completed successfully.`;
         console.warn(msg);
         return defaultVal;
     }
-    const keys = contentKey.split('.');
+    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(contentKey)}" not found in loaded content.`;
+            const msg = `[Contentstorage] getText: Path "${String(contentId)}" not found in loaded content.`;
             console.warn(msg);
             return defaultVal;
         }
@@ -80,7 +82,7 @@ export function getText(contentKey, variables) {
             const key = current;
             const existingEntry = window.memoryMap.get(key);
             const idSet = existingEntry ? existingEntry.ids : new Set();
-            idSet.add(contentKey); // Add the current ID to the set.
+            idSet.add(contentId); // Add the current ID to the set.
             window.memoryMap.set(key, {
                 ids: idSet,
                 type: 'text',
@@ -88,42 +90,42 @@ export function getText(contentKey, variables) {
         }
         if (!variables || Object.keys(variables).length === 0) {
             return {
-                contentKey,
+                contentId,
                 text: current,
             };
         }
         return {
-            contentKey,
-            text: populateTextWithVariables(current, variables, contentKey),
+            contentId,
+            text: populateTextWithVariables(current, variables, contentId),
         };
     }
     else {
-        const msg = `[Contentstorage] getText: Value at path "${String(contentKey)}" is not a string (actual type: ${typeof current}).`;
+        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(contentKey) {
+export function getImage(contentId) {
     const defaultVal = {
-        contentKey,
+        contentId,
         data: { url: '', altText: '', contentstorage_type: 'image' },
     };
     if (!activeContent) {
-        const msg = `[Contentstorage] getImage: Content not loaded (Key: "${contentKey}"). Ensure setContentLanguage() was called and completed successfully.`;
+        const msg = `[Contentstorage] getImage: Content not loaded (Content Id: "${contentId}"). Ensure setContentLanguage() was called and completed successfully.`;
         console.warn(msg);
         return {
-            contentKey,
+            contentId,
             data: { url: '', altText: '', contentstorage_type: 'image' },
         };
     }
-    const keys = contentKey.split('.');
+    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 "${contentKey}" not found in loaded content.`;
+            const msg = `[Contentstorage] getImage: Path "${contentId}" not found in loaded content.`;
             console.warn(msg);
             return defaultVal;
         }
@@ -137,7 +139,7 @@ export function getImage(contentKey) {
         if (window.parent && window.parent !== window) {
             const existingEntry = window.memoryMap.get(key);
             const idSet = existingEntry ? existingEntry.ids : new Set();
-            idSet.add(contentKey); // Add the current ID to the set.
+            idSet.add(contentId); // Add the current ID to the set.
             window.memoryMap.set(key, {
                 ids: idSet,
                 type: 'image',
@@ -145,7 +147,7 @@ export function getImage(contentKey) {
         }
         console.log('currentData.url', currentData.url);
         return {
-            contentKey,
+            contentId,
             data: {
                 ...currentData,
                 url: key,
@@ -153,29 +155,29 @@ export function getImage(contentKey) {
         };
     }
     else {
-        const msg = `[Contentstorage] getImage: Value at path "${contentKey}" is not a valid image object (actual value: ${JSON.stringify(current)}).`;
+        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(contentKey, variationKey, variables) {
+export function getVariation(contentId, variationKey, variables) {
     const defaultVal = {
-        contentKey,
+        contentId,
         text: '',
     };
     if (!activeContent) {
-        const msg = `[Contentstorage] getVariation: Content not loaded (Key: "${contentKey}", Variation: "${variationKey?.toString()}"). Ensure setContentLanguage() was called and completed successfully.`;
+        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 = contentKey.split('.');
+    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 "${contentKey}" for variation object not found in loaded content.`;
+            const msg = `[Contentstorage] getVariation: Path "${contentId}" for variation object not found in loaded content.`;
             console.warn(msg);
             return defaultVal;
         }
@@ -195,7 +197,7 @@ export function getVariation(contentKey, variationKey, variables) {
                     const key = current;
                     const existingEntry = window.memoryMap.get(key);
                     const idSet = existingEntry ? existingEntry.ids : new Set();
-                    idSet.add(contentKey); // Add the current ID to the set.
+                    idSet.add(contentId); // Add the current ID to the set.
                     window.memoryMap.set(key, {
                         ids: idSet,
                         type: 'variation',
@@ -204,17 +206,17 @@ export function getVariation(contentKey, variationKey, variables) {
                 }
                 if (!variables || Object.keys(variables).length === 0) {
                     return {
-                        contentKey,
+                        contentId,
                         text: current,
                     };
                 }
                 return {
-                    contentKey,
-                    text: populateTextWithVariables(current, variables, contentKey),
+                    contentId,
+                    text: populateTextWithVariables(current, variables, contentId),
                 };
             }
             else {
-                const msg = `[Contentstorage] getVariation: Variation value for key "${variationKey}" at path "${contentKey}" is not a string (actual type: ${typeof variationObject.data[variationKey]}).`;
+                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);
             }
         }
@@ -222,13 +224,13 @@ export function getVariation(contentKey, variationKey, variables) {
         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 "${contentKey}". Returning 'default' variation.`);
+                    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(contentKey); // Add the current ID to the set.
+                    idSet.add(contentId); // Add the current ID to the set.
                     window.memoryMap.set(key, {
                         ids: idSet,
                         type: 'variation',
@@ -236,20 +238,20 @@ export function getVariation(contentKey, variationKey, variables) {
                     });
                 }
                 return {
-                    contentKey,
+                    contentId,
                     text: variationObject.data.default,
                 };
             }
             else {
-                console.warn(`[Contentstorage] getVariation: 'default' variation value at path "${contentKey}" is not a string (actual type: ${typeof variationObject.data.default}).`);
+                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 "${contentKey}".`);
+        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 "${contentKey}" is not a valid variation object (actual value: ${JSON.stringify(current)}).`);
+        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.js

@@ -24,7 +24,10 @@ export async function fetchContent(language) {
             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(jsonData);
+        setContentLanguage({
+            languageCode: languageToFetch,
+            contentJson: jsonData,
+        });
     }
     catch (error) {
         // Catch errors related to fetching or saving a single language file

package/dist/types.d.ts

@@ -23,15 +23,15 @@ export type LanguageCode = 'SQ' | 'BE' | 'BS' | 'BG' | 'HR' | 'CS' | 'DA' | 'NL'
 export interface ContentStructure {
 }
 export type GetTextReturn = {
-    contentKey: string;
+    contentId: string;
     text: string;
 };
 export type GetImageReturn = {
-    contentKey: string;
+    contentId: string;
     data: ImageObject;
 };
 export type GetVariationReturn = {
-    contentKey: string;
+    contentId: string;
     text: string;
 };
 export interface ImageObject {

package/package.json

@@ -2,7 +2,7 @@
   "name": "@contentstorage/core",
   "author": "Kaido Hussar <kaidohus@gmail.com>",
   "homepage": "https://contentstorage.app",
-  "version": "0.4.0",
+  "version": "0.5.0",
   "type": "module",
   "description": "Fetch content from contentstorage and generate TypeScript types",
   "module": "dist/index.js",