@awesomeness-js/server 1.0.2 → 1.1.0

package/README.md

@@ -8,6 +8,67 @@ The `./awesomeness/` folder and you can customize the location by modifying the
 
 [@awesomeness-js/app-template](https://github.com/awesomeness-js/app-template)
 
+# Underlying Request Flow
+
+## Pre Routing
+- start
+- attachAwesomenessRequest
+  - gets awesomenessRequest.awesomenessType [page, api, generic]
+- [staticFiles](#Static-Files)
+- beforeRouteMiddleware
+- routeRequest
+
+## Routing
+- needs to be valid route for [page, api]
+  - /[^a-zA-Z0-9\/\_\-]/ -> make sure there is no dots in the path -> 404
+
+## API Routing ( needs awesomenessType in post body `api`)
+- try /api/routes/${awesomenessRequest.pageRoute}
+  - try site specific first
+  - then try common routes (needs to be edited uses URL and not passed config)
+- validateRequest
+- route index.js
+
+## Page Routing ( needs awesomenessType in post body `page`)
+- pageInfo
+- validateRequest
+- fetchPage
+- finalFormat
+
+## Generic Routing ( has no defined awesomenessType in post body)
+- method must be get or 405 is thrown
+- /test -> returns awesomeness is working
+- routes to staticFiles
+- awesomenessRequest.awesomenessType is not set in POST body
+- request is treated as a static file request
+- static file served is it exists in the public folder
+  - site specific first
+  - then common files
+
+If a public static file is not found
+- public/index.html is served
+- You DO NOT need your own public/index.html file
+  - The awesomeness-ui framework provides a default one
+  - this calls app.init()
+
+# From the Browser 
+
+## What happens
+
+1. User visits a page
+- Server receives request
+
+
+## Static Files
+- site specific files first
+  - /${awesomenessConfig.siteDir__URL}/${awesomenessRequest.site}/public/index.html
+- then common files
+  - [/${awesomenessConfig.commonPublicDir__URL}/${awesomenessRequest.site}/public/index.html](/example-site/example.awesomenessjs.com/public/index.html)
+  
+[index.html](/example-site/example.awesomenessjs.com/public/index.html)
+
+
+
 ## License
 
 This project is licensed under the Apache License 2.0.

package/build/build.js

@@ -0,0 +1,7 @@
+import { build } from '@awesomeness-js/utils';
+
+build({
+	src: './src',
+	dest: './index.js',
+	dts: false
+});

package/build/postBuild.js

@@ -0,0 +1,7 @@
+import { build } from '@awesomeness-js/utils';
+
+build({ 
+	src: './src', 
+	dest: './types/index.d.ts', 
+	dts: true
+});

package/example-.awesomeness/componentLocations.js

@@ -0,0 +1,15 @@
+export default (awesomenessRequest) => {
+
+	const siteSpecific__URL = new URL(`../sites/${awesomenessRequest.site}/`, import.meta.url);
+
+	return [
+
+		// first match wins (site first)
+		new URL('./components/', siteSpecific__URL),
+
+		// last item is the default
+		new URL('../awesomeness-ui/components/', import.meta.url),
+		
+	];
+
+};

package/example-.awesomeness/config.js

@@ -5,31 +5,15 @@ import wsHandler from './wsHandler.js';
 import beforeRouteMiddleware from './beforeRouteMiddleware.js';
 import checkSession from './checkSession.js';
 import applicationMap from './applicationMap.js';
+import componentLocations from './componentLocations.js';
 
 export default {
-
-	configURL: new URL(import.meta.url),
-	siteURL: new URL("../sites/", import.meta.url),
-	commonPublicDir: new URL("../awesomeness-ui/core/public/", import.meta.url),
-
-	componentLocations: (awesomenessRequest) => {
-
-		const siteURL = new URL(`../sites/${awesomenessRequest.site}/`, import.meta.url);
-
-		return [
-
-			// first match wins (site first)
-			new URL('./components/', siteURL),
-
-			// last item is the default
-			new URL('../awesomeness-ui/components/', import.meta.url),
-		];
-
-	},
-
+	siteDir__URL: new URL("../sites/", import.meta.url),
+	commonPublicDir__URL: new URL("../awesomeness-ui/core/public/", import.meta.url),
+	commonApiDir__URL: new URL("../api/", import.meta.url),
+	componentLocations,
 	debug: true,
 	byPassAccessRequirementsInDev: true,
-
 	applicationMap,
 	beforeRouteMiddleware,
 	checkSession,

package/example-site/example.awesomenessjs.com/api/readme.md

@@ -0,0 +1 @@
+custom routes can be added here.

package/example-site/example.awesomenessjs.com/components/example/index.js

@@ -0,0 +1,3 @@
+export default () => {
+ console.log('This example component over-wrote the common example component');
+}

package/example-site/example.awesomenessjs.com/components/notCommonExample/_.css

@@ -0,0 +1 @@
+/* test */

package/example-site/example.awesomenessjs.com/components/notCommonExample/index.js

@@ -0,0 +1,3 @@
+export default () => {
+ console.log('This is not a common example');
+}

package/example-site/example.awesomenessjs.com/pages/_md/_info.js

@@ -0,0 +1,15 @@
+export default {
+	version: 1,
+	name: '',
+	description: 'this allows for any url to be treated as a blog post, if the slug matches a blog post, all post are simple md format',
+	permissions: [ '*' ],
+	components: [
+		'blogPage',
+		'blogPost',
+		'prism',
+		'statusPage',
+		'video',
+		'riskDisclosure',
+		'bibleVerse'
+	]
+};

package/example-site/example.awesomenessjs.com/pages/_md/css/example.css

@@ -0,0 +1,4 @@
+/*
+these classes are loaded dynamically ...
+If a class can be re-used it is better to be created in /api/ui/common-css/
+*/

package/example-site/example.awesomenessjs.com/pages/_md/drafts/example.md

@@ -0,0 +1,32 @@
+---
+title: Example Post
+subTitle: This post wont show up because its in drafts.
+image: /tools/images/posts/investing-101.webp
+published: 2025-10-10
+priority: null
+url: /test-post
+tags: [ faith, life hacks, spiritual freedom, christianity ]
+tagColor: bg-stone-900
+author: 
+  name: Scott Forte
+  title: Pilot, Investor, Realtor ®
+  image: /tools/images/scott-forte-america-small-40.webp
+  url: https://scottmforte.com
+---
+
+<break-50>
+
+<youTube>ek_RodYzUCI</youTube>
+
+![](/tools/images/posts/c172-glide-distance.webp)
+
+<div class="blogPost-next-reads">
+
+### Next Reads
+
+- [Investing 101: Planting a Money Tree](/investing-101)
+- [🏔️ Moving to NH: The Freest State on Planet Earth](/moving-to-new-hampshire)
+- [Alternative Investments: Beyond Stocks, bonds, 401ks and IRAs](/alternative-investments)
+- [👨‍✈️ Spiritual Freedom: When Jesus Becomes Your Co-Pilot](/spiritual-freedom)
+
+</div>

package/example-site/example.awesomenessjs.com/pages/_md/getBlogData.js

@@ -0,0 +1,117 @@
+import fs from 'fs';
+import parseMd from '#utils/parseMd.js';
+import path from 'path';
+import { fileURLToPath } from 'url';
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+
+function tagToFilename(tag) {
+
+	return tag.toLowerCase().replace(/\s+/g, '-').replace(/[^\w-]/g, '');
+
+}
+
+export default async function getBlogData(folder = 'pages') {
+
+	const folderPath = path.resolve(__dirname, folder);
+	const files = fs.readdirSync(folderPath).filter((f) => f.endsWith('.md'));
+
+	const tagImagePath = path.resolve(__dirname, '../../public/tools/images/tags');
+	const tagImageFiles = fs.existsSync(tagImagePath) ? fs.readdirSync(tagImagePath) : [];
+
+	const tagMap = Object.create(null);
+
+
+	const result = {
+		tags: [],    // now array of { name, count }
+		links: [],   // array of urls
+		posts: []    // array of metadata objects
+	};
+
+	const linkRegex = /\[([^\]]+)\]\(([^)\s]+)\)/g;
+
+	for (const file of files) {
+
+		try {
+
+			const filePath = path.join(folderPath, file);
+			const mdContent = fs.readFileSync(filePath, 'utf-8');
+
+			const {
+				metadata,
+				cleanedMDContent
+			} = await parseMd(mdContent);
+
+			if (!metadata || !metadata.published) continue;
+
+			// collect tags
+			if (Array.isArray(metadata.tags)) {
+
+				for (const tag of metadata.tags) {
+
+					if (!tag) continue;
+					tagMap[tag] = (tagMap[tag] || 0) + 1;
+			
+				}
+		
+			}
+
+			// collect links
+			let match;
+
+
+			while ((match = linkRegex.exec(cleanedMDContent)) !== null) {
+
+				const url = match[2];
+
+				result.links.push(url);
+		
+			}
+
+			// collect post metadata
+			result.posts.push({
+				file,
+				...metadata
+			});
+
+		} catch(err){
+
+			console.error(`Error processing file ${file}:`, err);
+
+		}
+
+
+	
+	}
+
+	// build tag array
+	result.tags = Object.entries(tagMap)
+		.map(([ name, count ]) => ({
+			name,
+			count,
+			image: tagImageFiles.includes(tagToFilename(name) + '.webp') ? `/tools/images/tags/${tagToFilename(name)}.webp` : null	
+		}))
+		.sort((a, b) => a.name.localeCompare(b.name));
+
+	// sort posts by priority (asc), then date (desc), fallback to title
+	result.posts.sort((a, b) => {
+
+		const ap = (typeof a.priority === 'number') ? a.priority : Infinity;
+		const bp = (typeof b.priority === 'number') ? b.priority : Infinity;
+
+		if (ap !== bp) return ap - bp;
+
+		const ad = new Date(a.published);
+		const bd = new Date(b.published);
+
+		if (!isNaN(ad) && !isNaN(bd)) return bd - ad;
+		
+		return (a.title || '').localeCompare(b.title || '');
+	
+	});
+
+
+	return result;
+
+}

package/example-site/example.awesomenessjs.com/pages/_md/getData.js

@@ -0,0 +1,36 @@
+import parseMd from '#utils/parseMd.js';
+import checkAccess from '#server/checkAccess.js';
+
+// @awesomenessRequest
+export default async function getData(awesomenessRequest) {
+
+	let mdContent = 
+		awesomenessRequest.mdContent 
+		|| awesomenessRequest.data.mdContent 
+		|| '## No Content Found\n\nSorry, no content could be found for this post.';
+
+	let {
+		metadata,
+		cleanedMDContent,
+	} = await parseMd(mdContent);
+
+	mdContent = cleanedMDContent;
+
+	awesomenessRequest.pageInit = '_md';
+
+	// check permissions?
+	if(metadata?.permissions?.length){
+
+		await checkAccess({
+			permissionsAllowed: metadata.permissions,
+			awesomenessRequest,
+		});
+
+	}
+
+	return { 
+		mdContent,
+		metadata,
+	};
+
+}

package/example-site/example.awesomenessjs.com/pages/_md/js/callToAction.js

@@ -0,0 +1,43 @@
+import ui from '#ui';
+
+app.pages._md.callToAction = async function(){
+
+	$(`.custom-callToAction-real-estate`).each(function(){
+
+		const $container = $(this);
+
+		$container.empty();
+
+		const $break = $(`<div class="break height-100"></div>`)
+			.appendTo($container);
+
+		const $h1 = $(`<h1 class="">Ready to start investing?</h1>`)
+			.appendTo($container);
+
+		const $break2 = $(`<div class="break height-25"></div>`)
+			.appendTo($container);
+
+		const $p = $(`<p class="lead">
+			I turn down about 200 deals a year <b>because I do the math</b>. 
+			They simply don't pencil out.
+			I also have an extremely conservative investment criteria.
+			That said, 
+			Ive flipped over 40 units
+			from single family homes, 
+			to office condos and hotels.
+			I currently own over 150 units. 
+			You need me, or someone like me, as your copilot.
+			If you are interested in learning more about investment real estate, 
+			no matter where in the world you live,
+			text me
+			</p>`).appendTo($container);
+
+		const $link = $(`<a href="sms:855.SCOTT.40" class="">855.SCOTT.40</a>`)
+			.appendTo($p);
+
+		const $break3 = $(`<div class="break height-100"></div>`)
+			.appendTo($container);
+	
+	});
+
+};

package/example-site/example.awesomenessjs.com/pages/_md/js/init.js

@@ -0,0 +1,88 @@
+import ui from '#ui';
+
+app.pages._md.init = async function(pageData){
+
+	ui.cleanMain();
+	
+	if(
+		pageData.metadata.breadcrumbs 
+		&& !pageData.metadata.image
+	){
+
+		ui.breadcrumbs({
+			data: pageData.metadata.breadcrumbs,
+			color: pageData.metadata.breadcrumbColor ?? 'stone'
+		}).appendTo(app.$main);
+
+	}
+
+	const $page = ui.blogPost.md(pageData,{
+		tagBase: '/tag',
+		customRules: [
+			(mdContent)=>{
+
+				return mdContent.replace(/<cta-realEstate>/g, '<div class="custom-callToAction-real-estate"></div>');
+
+			},
+			(mdContent)=>{
+
+				// find <bibleVerse> tags and replace with divs
+				return mdContent.replace(/<bibleVerse>/g, '<div class="data-bible-verse">').replace(/<\/bibleVerse>/g, '</div>');
+
+			}
+		]
+	}).appendTo(app.$main);
+
+	$page.find('a').click(function(event){
+
+		event.preventDefault();
+		event.stopPropagation();
+
+		const href = $(this).attr('href');
+
+		if(href && href.startsWith('http')){
+
+			// open target blank
+			window.open(href, '_blank');
+		
+		} else {
+
+			// does this a tag have any awesomeness-* class
+			if($(this).attr('class') && $(this).attr('class').match(/awesomeness-/)){
+
+				// do nothing, let awesomeness-ui handle it
+
+			} else {
+
+				// internal links
+				app.page(href);
+			
+			}
+
+		}
+
+	});
+
+	// find code blocks that have only a string inside and add class .simple-code-string
+	$page.find('code').each(function(){
+
+		const $code = $(this);
+		const codeText = $code.text().trim();
+
+
+		if(codeText && !codeText.includes('\n')){
+
+			$code.addClass('simple-code-string');
+		
+		}
+	
+	});
+
+	Prism.highlightAll();
+
+	app.pages._md.callToAction();
+
+	ui.bibleVerse.init();
+
+
+};

package/example-site/example.awesomenessjs.com/pages/_md/meta.template.md

@@ -0,0 +1,33 @@
+---
+title: Some Example Blog Post
+subTitle: This is a subtitle of a blog post
+readTime: null
+image: /tools/images/posts/investing-101.png
+published: 2025-10-10
+priority: null
+url: /test-post
+tags: [ faith, life hacks, spiritual freedom, christianity ]
+tagColor: bg-stone-900
+author: 
+  name: Scott Forte
+  title: Pilot, Investor, Realtor ®
+  image: /tools/images/scott-forte-america-small-40.webp
+  url: https://scottmforte.com
+---
+
+<break-50>
+
+<youTube>5guXs-675KI</youTube>
+
+![](/tools/images/posts/c172-glide-distance.webp)
+
+<div class="blogPost-next-reads">
+
+### Next Reads
+
+- [👨‍✈️ Spiritual Freedom: When Jesus Becomes Your Co-Pilot](/spiritual-freedom)
+- [💸 Financial Freedom: What does it mean?](/financial-freedom)  
+- [🗽 Political Freedom](/political-freedom)
+- [🧠 Mental Freedom: The Basis of Freedom](/mental-freedom)
+
+</div>