nodoku-core 0.2.6 → 0.3.0

package/README.md

@@ -23,6 +23,12 @@
   * [Schema for Nodoku skin Yaml file](#schema-for-nodoku-skin-yaml-file)
   * [Customizing Nodoku page appearance](#customizing-nodoku-page-appearance)
 * [Nodoku generation scripts](#nodoku-generation-scripts)
+* [Nodoku license](#nodoku-license)
+  * [Use for private, educational or commercial needs, excluding applications for webpage or website building tools](#use-for-private-educational-or-commercial-needs-excluding-applications-for-webpage-or-website-building-tools)
+  * [Use as part of website or webpage builders](#use-as-part-of-website-or-webpage-builders)
+* [Examples](#examples)
+  * [Proper use, free of charge, under the MIT License](#proper-use-free-of-charge-under-the-mit-license)
+  * [Prohibited use](#prohibited-use)
 <!-- TOC -->
 
 GitHub link: https://github.com/nodoku/nodoku-core
@@ -901,3 +907,54 @@ To simplify the use of these script it is recommended to add them in the project
 }
 ```
 
+
+# Nodoku license
+
+The Nodoku License to be used depends on the use case you plan to use Nodoku for:
+
+- using Nodoku to build an End Product, which is a webpage or a website for private or commercial use
+  - in short, in this case Nodoku **_is free_** to use under the MIT License (see below for more details)
+- using Nodoku to build an End Product, which is a webpage or a website builder (online or offline)
+  - in short, in this case the use of Nodoku **_is prohibited_**
+
+
+Note, that
+> in any case of the allowed, free-of-charge use of Nodoku, **_the present Nodoku license should be included in all copies of the Software, using Nodoku_**.
+
+
+
+## Use for private, educational or commercial needs, excluding applications for webpage or website building tools
+
+Any use of Nodoku, **_except for webpage and website builder applications_**, is allowed free of charge, under the **_MIT license_** ( see the [LICENSE](./blob/main/LICENSE) )
+
+
+
+## Use as part of website or webpage builders
+
+The use of Nodoku for the purposes to provide a solution for online (or offline) website or webpage builders is **_prohibited_**.
+
+This prohibition includes the direct or indirect use of the Nodoku library as part of webpage builder solution.
+
+Indirect use of Nodoku library would include building a software or a framework that would then be used as part of webpage or website builder.
+
+Webpage or Website builder application is any tool, online or offline, that would allow the End User to build a publishable webpage or website, using no code or low amount of code.
+
+This is prohibited under this license term since that would constitute a direct competition to Nodoku lo-code site builder.
+
+# Examples
+
+## Proper use, free of charge, under the MIT License
+
+- building a webpage or a website for a private non-commercial project
+- building a webpage or a website for a private commercial project
+- building a webpage or a website for a public commercial or non-commercial blog
+- building a webpage or a website for a client, that would use it for commercial or non-commercial purposes
+- creating and distributing non-commercially (free of charge) custom Nodoku components
+- creating and distributing commercially custom Nodoku components (developing and selling out new Nodoku-compatible UI components)
+- developing new UI components and selling them out either as a Nodoku component, or a standalone component, or a component compatible with another website builder
+
+## Prohibited use
+
+- building a website builder, that would use the Nodoku engine to provide the End User with a tool, that would allow them building their own webpages or websites
+- using Nodoku engine to provide the End User with an automatic, semi-automatic or manual framework, that would allow them building their own webpages or websites
+- using Nodoku libraries to use it as part of the solution that would allow the End User to build a webpage or a website

package/esm/content/nd-content.js

@@ -41,14 +41,6 @@ export class NdCode {
         this.code = code;
     }
 }
-export class NdLink {
-    urlText;
-    url;
-    constructor(text, url) {
-        this.urlText = text;
-        this.url = url;
-    }
-}
 export class NdContentBlock {
     id;
     lng;

package/esm/core/dummy-comp.jsx

@@ -1,5 +1,4 @@
 import { NdCode, NdTranslatableText } from "../content/nd-content";
-import { NdLink } from "../content/nd-content";
 export async function DummyComp(props) {
     // console.log("content dummy comp", props.theme)
     const { content, i18nextTrustedHtmlProvider, lng, rowIndex, componentIndex } = props;
@@ -75,18 +74,20 @@ async function render(rowIndex, componentIndex, block, t) {
                                     <code lang={code.lang} className={"hljs"} dangerouslySetInnerHTML={{ __html: code.code }}/>
                                 </pre>
                 </div>);
-        }
-        else if (p instanceof NdLink) {
-            const link = p;
-            return (<div>
-                    link
-                    <div key={ip} className={"mb-3 font-normal text-gray-700 dark:text-gray-400"}>
-                        urlText: {link.urlText && showTranslatableText(link.urlText)}
-                        url: {showTranslatableText(link.url)}
-                    </div>
-
-                </div>);
-        }
+        } /*else if (p instanceof NdLink) {
+            const link: NdLink = p as NdLink
+            return (
+                <div>
+                    link
+                    <div key={ip} className={"mb-3 font-normal text-gray-700 dark:text-gray-400"}>
+                        urlText: {link.urlText && showTranslatableText(link.urlText)}
+                        url: {showTranslatableText(link.url)}
+                    </div>
+
+                </div>
+
+            )
+        } */
         else {
             const list = p;
             if (list.ordered) {
@@ -112,7 +113,8 @@ function showTranslatableText(text) {
     return <span>{text.text} <small>(<i>{text.key}</i>)</small></span>;
 }
 function showListItem(i) {
-    return i.text instanceof NdTranslatableText ?
-        showTranslatableText(i.text) :
-        <span>link item {(i.text.urlText ? showTranslatableText(i.text.urlText) : "link text n/a")} : {showTranslatableText(i.text.url)}</span>;
+    // return i.text instanceof NdTranslatableText ?
+    //     showTranslatableText(i.text) :
+    //     <span>link item {(i.text.urlText ? showTranslatableText(i.text.urlText) : "link text n/a")} : {showTranslatableText(i.text.url)}</span>;
+    return showTranslatableText(i.text);
 }

package/esm/index.js

@@ -1,10 +1,12 @@
-import { NdContentImage, NdTranslatableText, NdList, NdLink, NdCode, NdCallToAction, NdContentBlock } from "./content/nd-content";
+import { NdContentImage, NdTranslatableText, NdList, NdCode, NdCallToAction, NdContentBlock } from "./content/nd-content";
 import { NdSkinComponent, NdRow, NdPageSkin, NdSkinComponentProps, NdContentSelector, NdComponentDefinition, NdThemeHierarchy } from "./skin/nd-skin";
 import { RenderingPageProps, RenderingPriority } from "./core/rendering-page-props";
 import { RenderingPage } from "./core/rendering-page";
 import { mergeTheme } from "./theme-utils/theme-merger";
 import { defaultRowThemeImpl } from "./theme-utils/row-style";
-export { NdContentImage, NdTranslatableText, NdList, NdLink, NdCode, NdCallToAction, NdContentBlock, NdSkinComponent, NdRow, NdPageSkin, NdSkinComponentProps, NdContentSelector, NdComponentDefinition, NdThemeHierarchy };
+export { NdContentImage, NdTranslatableText, NdList, 
+// NdLink,
+NdCode, NdCallToAction, NdContentBlock, NdSkinComponent, NdRow, NdPageSkin, NdSkinComponentProps, NdContentSelector, NdComponentDefinition, NdThemeHierarchy };
 export { RenderingPageProps, RenderingPriority, RenderingPage };
 export { mergeTheme };
 export { DummyComp } from "./core/dummy-comp";

package/esm/providers/content/content-markdown-provider.js

@@ -3,7 +3,6 @@ import { Marked } from '@ts-stack/markdown';
 import { parse, TextNode } from 'node-html-parser';
 import yaml from "js-yaml";
 import { NdCallToAction } from "../../content/nd-content";
-import { NdLink } from "../../content/nd-content";
 const nsRegex = /.*\/(.*)\.md/;
 export async function contentMarkdownProvider(mdFileUrl, contentLng, ns = undefined) {
     return await fetch(mdFileUrl)
@@ -224,7 +223,12 @@ class BlockHolder {
                             img = new NdContentImage();
                             img.url = new NdTranslatableText(this.ns, `${blockId}.images.${imi}.url`, imgHtmlElem.attributes["src"], true);
                             img.alt = new NdTranslatableText(this.ns, `${blockId}.images.${imi}.alt`, imgHtmlElem.attributes["alt"]);
-                            img.title = new NdTranslatableText(this.ns, `${blockId}.images.${imi}.title`, imgHtmlElem.attributes["title"]);
+                            if (imgHtmlElem.attributes["title"] && imgHtmlElem.attributes["title"].length > 0) {
+                                img.title = new NdTranslatableText(this.ns, `${blockId}.images.${imi}.title`, imgHtmlElem.attributes["title"]);
+                            }
+                            else {
+                                img.title = new NdTranslatableText(this.ns, `${blockId}.images.${imi}.title`, imgHtmlElem.attributes["alt"]);
+                            }
                         }
                     });
                     if (img) {
@@ -243,7 +247,12 @@ class BlockHolder {
                     img = new NdContentImage();
                     img.url = new NdTranslatableText(this.ns, `${blockId}.images.${imi}.url`, htmlElem.attributes["src"], true);
                     img.alt = new NdTranslatableText(this.ns, `${blockId}.images.${imi}.alt`, htmlElem.attributes["alt"]);
-                    img.title = new NdTranslatableText(this.ns, `${blockId}.images.${imi}.title`, htmlElem.attributes["title"]);
+                    if (htmlElem.attributes["title"] && htmlElem.attributes["title"].length > 0) {
+                        img.title = new NdTranslatableText(this.ns, `${blockId}.images.${imi}.title`, htmlElem.attributes["title"]);
+                    }
+                    else {
+                        img.title = new NdTranslatableText(this.ns, `${blockId}.images.${imi}.title`, htmlElem.attributes["alt"]);
+                    }
                 }
                 if (img) {
                     newBlock.images.push(img);
@@ -290,20 +299,22 @@ class BlockHolder {
         if (!cn) {
             return undefined;
         }
-        if (cn instanceof TextNode) {
+        if (cn instanceof TextNode && cn.text.length > 0) {
             return new NdTranslatableText(this.ns, `${idPrefix}`, cn.text);
         }
         const p = cn;
         if (!p.rawTagName) {
             return undefined;
         }
-        // console.log("parsing paragraph", p.innerHTML);
+        // console.log("parsing paragraph", p.rawTagName, p.innerHTML);
         if (p.rawTagName === "p" || p.rawTagName === "blockquote") {
             return new NdTranslatableText(this.ns, `${idPrefix}`, p.innerHTML);
-        }
-        else if (p.rawTagName === "a") {
-            return new NdLink(new NdTranslatableText(this.ns, `${idPrefix}.urlText`, p.innerHTML), new NdTranslatableText(this.ns, `${idPrefix}.url`, p.attributes["href"], true));
-        }
+        } /*else if (p.rawTagName === "a") {
+            return new NdLink(
+                new NdTranslatableText(this.ns, `${idPrefix}.urlText`, p.innerHTML),
+                new NdTranslatableText(this.ns, `${idPrefix}.url`, p.attributes["href"], true)
+            );
+        } */
         else if (p.rawTagName === "pre") {
             const codeHtml = p.childNodes[0];
             const rawText = codeHtml.text;
@@ -320,19 +331,32 @@ class BlockHolder {
         }
         else if (p.rawTagName === "ul") {
             return NdList.createUnOrdered(this.parseListItems(idPrefix, p));
-        } /*else {
-            return new NdTranslatableText(this.ns, `${idPrefix}`, p.innerHTML);
-        }*/
-        console.log("couldn't parse paragraph: ", p.innerHTML);
-        return undefined;
+        }
+        else {
+            // const pItems: NdTranslatableText[] = []
+            // pItems.push(new NdTranslatableText(this.ns, idPrefix, p.innerHTML))
+            // p.childNodes
+            //     .filter(cn => cn.textContent.length > 0)
+            //     .forEach(cn => pItems.push(new NdTranslatableText(this.ns, idPrefix, cn.rawText)))
+            // console.log("reducing inner nodes of paragraph", pItems)
+            // return  pItems.reduce((prev, current) => new NdTranslatableText(this.ns, prev.key, prev.text + "\n" + current.text) )
+            return new NdTranslatableText(this.ns, idPrefix, p.toString());
+        }
+        // console.log("couldn't parse paragraph: ", p.innerHTML)
+        //
+        // return undefined;
     }
     parseListItems(idPrefix, p) {
+        // console.log("parsing list items ", p)
         return p.childNodes
             .filter(lin => lin.innerText && lin.innerText.trim().length > 0)
             .map((lin, k) => {
             const li = lin;
             let innerList = undefined;
-            let liText; //TextNode | undefined;
+            let liText = []; // /*| NdLink*/ | undefined;//TextNode | undefined;
+            if (li.innerHTML && li.innerHTML.length > 0) {
+                liText?.push(new NdTranslatableText(this.ns, `${idPrefix}.items.${k}`, li.innerHTML));
+            }
             if (li.childNodes.length > 0) {
                 // console.log("found inner item", li.childNodes.length, (li.childNodes.map(i => i as HTMLElement)
                 //     .map((i1: HTMLElement) => i1.rawTagName ? i1.rawTagName : "N.A")), "<<<");
@@ -343,17 +367,22 @@ class BlockHolder {
                     .find((p) => p != undefined && p instanceof NdList);
                 liText = li.childNodes
                     .map(cn => this.parseParagraph(`${idPrefix}.items.${k}.text`, cn))
-                    .find((p) => p != undefined && (p instanceof NdLink || p instanceof NdTranslatableText));
+                    .filter((p) => p != undefined && ( /*p instanceof NdLink || */p instanceof NdTranslatableText));
                 // innerList = innerNodes.find((p: NdParagraph | undefined) => p != undefined && p instanceof NdList)
                 // if (li.childNodes[0].rawTagName in ["ol", "ul"]) {
                 // }
                 // liText = li.childNodes.filter(cn => cn instanceof TextNode).find(t => t && t.text.length > 0);
                 // liText = innerNodes.find((p: NdParagraph | undefined) => p != undefined && (p instanceof NdLink || p instanceof NdTranslatableText))
             }
+            let itemText = new NdTranslatableText(this.ns, `${idPrefix}.items.${k}`, "n/a");
+            if (liText.length > 0) {
+                // console.log("reducing inner item", liText)
+                itemText = liText.reduce((prev, current) => new NdTranslatableText(this.ns, prev.key, prev.text + "\n" + current.text));
+            }
             // type l = keyof HTMLElement
             // console.log("found list", li.childNodes.filter(cn => Object.keys(cn).map(k => k == "parentNode" ? "parent" : (cn as HTMLElement)[k as l])), "<<", lin.innerText, "<<")
             // const foundList = {text: new NdTranslatableText(this.ns, `${idPrefix}.items.${k}`, liText)/*liText*/, subList: innerList};
-            const foundList = { text: liText ? liText : new NdTranslatableText(this.ns, `${idPrefix}.items.${k}`, "n/a"), subList: innerList };
+            const foundList = { text: itemText, subList: innerList };
             // console.log("found list", ">>", foundList, "<<")
             return foundList;
             // const listItem = this.parseParagraph(`${idPrefix}.items.${k}`, li)

package/package.json

@@ -1,7 +1,8 @@
 {
   "name": "nodoku-core",
-  "version": "0.2.6",
+  "version": "0.3.0",
   "description": "basic foundation for nodoku static site generator",
+  "license": "MIT for the use not related to website builders, commercial otherwise, contact for details",
   "exports": {
     ".": {
       "types": "./types/index.d.ts",

package/types/content/nd-content.d.ts

@@ -16,7 +16,7 @@ export declare class NdTranslatableText {
     constructor(ns: string, key?: string, text?: string, excludeFromTranslation?: boolean);
 }
 export type NdListItem = {
-    text: NdTranslatableText | NdLink;
+    text: NdTranslatableText;
     subList: NdParagraph | undefined;
 };
 export declare class NdList {
@@ -31,12 +31,7 @@ export declare class NdCode {
     code: string;
     constructor(lang: string, code: string);
 }
-export declare class NdLink {
-    urlText: NdTranslatableText | undefined;
-    url: NdTranslatableText;
-    constructor(text: NdTranslatableText, url: NdTranslatableText);
-}
-export type NdParagraph = NdTranslatableText | NdList | NdCode | NdLink;
+export type NdParagraph = NdTranslatableText | NdList | NdCode;
 export declare class NdContentBlock {
     id: string;
     lng: string;

package/types/index.d.ts

@@ -1,4 +1,4 @@
-import { NdContentImage, NdTranslatableText, NdList, NdLink, NdListItem, NdCode, NdCallToAction, NdParagraph, NdContentBlock } from "./content/nd-content";
+import { NdContentImage, NdTranslatableText, NdList, /*NdLink, */ NdListItem, NdCode, NdCallToAction, NdParagraph, NdContentBlock } from "./content/nd-content";
 import { NdSkinComponent, NdRow, NdPageSkin, NdSkinComponentProps, NdContentSelector, NdComponentDefinition, NdThemeHierarchy, NdDefaultThemeName } from "./skin/nd-skin";
 import { RenderingPageProps, RenderingPriority } from "./core/rendering-page-props";
 import { RenderingPage } from "./core/rendering-page";
@@ -8,7 +8,7 @@ import { ThemeStyle } from "./theme-utils/theme-style";
 import { ExtendedThemeStyle } from "./theme-utils/extended-theme-style";
 import { ImageStyle } from "./theme-utils/image-style";
 import { RowStyle } from "./theme-utils/row-style";
-export { NdContentImage, NdTranslatableText, NdList, type NdListItem, NdLink, NdCode, NdCallToAction, NdContentBlock, NdSkinComponent, NdRow, NdPageSkin, NdSkinComponentProps, NdContentSelector, NdComponentDefinition, NdThemeHierarchy, type NdParagraph, type NdDefaultThemeName, type NdImageProps, type NdI18nextTrustedHtmlProvider, type NdHtmlSanitizer, type NdTrustedHtml, type NdI18NextPostProcessor };
+export { NdContentImage, NdTranslatableText, NdList, type NdListItem, NdCode, NdCallToAction, NdContentBlock, NdSkinComponent, NdRow, NdPageSkin, NdSkinComponentProps, NdContentSelector, NdComponentDefinition, NdThemeHierarchy, type NdParagraph, type NdDefaultThemeName, type NdImageProps, type NdI18nextTrustedHtmlProvider, type NdHtmlSanitizer, type NdTrustedHtml, type NdI18NextPostProcessor };
 export { RenderingPageProps, RenderingPriority, RenderingPage };
 export { mergeTheme, type ThemeStyle, type ExtendedThemeStyle, type ImageStyle };
 export type { NdI18nextProvider, AsyncFunctionComponent, NdImageProvider };