@awesomeness-js/server 1.1.10 → 1.1.13

package/tests/fixtures/site-and-components/components/scrollSpy/observerPoolUnsubscribe.js

@@ -0,0 +1,44 @@
+export default ({
+	registry,
+	poolEntry,
+	targetElm,
+	subscriber
+} = {}) => {
+
+	if (!poolEntry || !targetElm || !subscriber) {
+
+		return;
+
+	}
+
+	const subscribers = poolEntry.targets.get(targetElm);
+
+	if (!subscribers) {
+
+		return;
+
+	}
+
+	subscribers.delete(subscriber);
+
+	if (subscribers.size === 0) {
+
+		poolEntry.targets.delete(targetElm);
+		poolEntry.observer.unobserve(targetElm);
+
+	}
+
+	if (poolEntry.targets.size === 0) {
+
+		poolEntry.observer.disconnect();
+
+		if (registry?.pools) {
+
+			registry.pools.delete(poolEntry.key);
+
+		}
+
+	
+	}
+
+};

package/tests/fixtures/site-and-components/components/scrollSpy/top.js

@@ -0,0 +1,86 @@
+export default ({
+	$spyOn,
+	$applyTo,
+	threshold = 100,   // X px
+	deadZone = 0,      // optional hysteresis to avoid flicker
+	className = 'spy-past-threshold'
+} = {}) => {
+
+	const $classEl = ($applyTo && $applyTo.length)
+		? $applyTo
+		: $('body');
+
+	const spyTarget = ($spyOn && $spyOn.length)
+		? $spyOn.get(0)
+		: window;
+
+	const isWindow = (spyTarget === window);
+
+	let ticking = false;
+	let isApplied = null; // unknown at start
+
+	function readTop() {
+
+		return isWindow
+			? (window.pageYOffset || document.documentElement.scrollTop || 0)
+			: (spyTarget.scrollTop || 0);
+	
+	}
+
+	function apply(shouldApply) {
+
+		if (shouldApply) $classEl.addClass(className);
+		else $classEl.removeClass(className);
+	
+	}
+
+	function onRaf() {
+
+		ticking = false;
+
+		const topNow = readTop();
+
+		// deadZone gives you hysteresis:
+		// once applied, it won't unapply until threshold - deadZone
+		// once unapplied, it won't apply until threshold + deadZone
+		let shouldApply;
+
+		if (isApplied === true) {
+
+			shouldApply = topNow >= (threshold - deadZone);
+		
+		} else if (isApplied === false) {
+
+			shouldApply = topNow >= (threshold + deadZone);
+		
+		} else {
+
+			// first run
+			shouldApply = topNow >= threshold;
+		
+		}
+
+		if (shouldApply === isApplied) return;
+
+		isApplied = shouldApply;
+		apply(shouldApply);
+	
+	}
+
+	function onScroll() {
+
+		if (ticking) return;
+		ticking = true;
+		requestAnimationFrame(onRaf);
+	
+	}
+
+	spyTarget.addEventListener('scroll', onScroll, { passive: true });
+
+	// run once immediately so the class is correct on load
+	onRaf();
+
+	// optional cleanup if you want it
+	return () => spyTarget.removeEventListener('scroll', onScroll);
+
+};

package/tests/fixtures/site-and-components/sites/site-a/pages/home/init.js

@@ -0,0 +1,78 @@
+export default function home() {
+
+	ui.pageInit();
+	ui.cardMain();
+
+	const renderRef = ui.pageWidget.render();
+	const mountRef = ui.cardMount.mount();
+	const sections = [
+		{ id: "hero", title: "Hero", enabled: true },
+		{ id: "features", title: "Features", enabled: true },
+		{ id: "pricing", title: "Pricing", enabled: true },
+		{ id: "faq", title: "FAQ", enabled: true },
+		{ id: "footer", title: "Footer", enabled: true },
+	];
+
+	const metrics = {
+		visitors: 10234,
+		signups: 789,
+		conversionRate: 0.077,
+		avgSessionMs: 184000,
+	};
+
+	const user = {
+		id: "user-42",
+		name: "Fixture User",
+		roles: [ "viewer", "editor" ],
+		preferences: {
+			theme: "light",
+			language: "en-US",
+			notifications: true,
+		},
+	};
+
+	const model = sections
+		.filter((section) => section.enabled)
+		.map((section, index) => ({
+			...section,
+			order: index + 1,
+			slug: `${section.id}-${index + 1}`,
+			updatedAt: new Date(2024, 0, index + 1).toISOString(),
+		}));
+
+	for (let i = 0; i < model.length; i++) {
+
+		if (i % 2 === 0) {
+
+			ui.pageInit();
+		
+		}
+
+		if (model[i].id === "features") {
+
+			ui.pageWidget.render();
+		
+		}
+	
+	}
+
+	const summary = {
+		sectionCount: model.length,
+		metrics,
+		user,
+		flags: {
+			hasHero: model.some((section) => section.id === "hero"),
+			hasPricing: model.some((section) => section.id === "pricing"),
+			showFooter: true,
+		},
+	};
+
+	const payload = {
+		renderRef,
+		mountRef,
+		summary,
+		model,
+	};
+
+	return payload;
+}

package/tests/fixtures/site-and-components/sites/site-a/pages/home/js/index.js

@@ -0,0 +1,93 @@
+export default function homePage() {
+
+	ui.pageScript();
+
+	ui.app.start();
+
+	const cards = [
+		{
+			id: "a",
+			label: "Analytics",
+			value: 132 
+		},
+		{
+			id: "b",
+			label: "Sales",
+			value: 98 
+		},
+		{
+			id: "c",
+			label: "Leads",
+			value: 211 
+		},
+		{
+			id: "d",
+			label: "Retention",
+			value: 87 
+		},
+		{
+			id: "e",
+			label: "Support",
+			value: 56 
+		},
+		{
+			id: "f",
+			label: "Backlog",
+			value: 23 
+		},
+	];
+
+	const rows = [];
+
+	for (let i = 0; i < cards.length; i++) {
+
+		const card = cards[i];
+		const ratio = card.value / 250;
+
+		rows.push({
+			index: i,
+			id: card.id,
+			label: card.label,
+			value: card.value,
+			ratio,
+			status: ratio > 0.6 ? "high" : ratio > 0.3 ? "medium" : "low",
+		});
+	
+	}
+
+	const totals = rows.reduce(
+		(acc, row) => {
+
+			acc.total += row.value;
+			acc.high += row.status === "high" ? 1 : 0;
+			acc.medium += row.status === "medium" ? 1 : 0;
+			acc.low += row.status === "low" ? 1 : 0;
+
+			return acc;
+		
+		},
+		{
+			total: 0,
+			high: 0,
+			medium: 0,
+			low: 0 
+		}
+	);
+
+	const report = {
+		generatedAt: new Date(2024, 6, 4, 9, 30, 0).toISOString(),
+		rows,
+		totals,
+		meta: {
+			source: "fixture",
+			version: "1.0.0",
+			notes: [
+				"This fixture intentionally has larger content for benchmark-style tests.",
+				"ui references in this file: ui.pageScript(), ui.app.start().",
+			],
+		},
+	};
+
+	return report;
+
+}

package/tests/setup.js

@@ -0,0 +1 @@
+process.env.NODE_ENV = "test";

package/tsconfig.json

@@ -0,0 +1,18 @@
+{
+	"compilerOptions": {
+		"declaration": true, // Generates .d.ts files
+		"emitDeclarationOnly": true, // Only output .d.ts files
+		"allowJs": true, // Allows JS files
+		"outDir": "types", // Output directory for type files
+		"moduleResolution": "node",
+		"skipLibCheck": true,
+		"esModuleInterop": true,
+		"types": [
+			"vitest/globals"
+		]
+	},
+	"include": [
+		"src/**/*"
+	],
+	"exclude": []
+}

package/types/index.d.ts

@@ -0,0 +1,109 @@
+/**
+ * This file is auto-generated by the build script.
+ * It consolidates API type declarations for use in the application.
+ * Do not edit manually.
+ */
+import type _applicationMap from './applicationMap';
+import type _awesomenessNormalizeRequest from './awesomenessNormalizeRequest';
+import type _brotliJsonResponse from './brotliJsonResponse';
+import type _checkAccess from './checkAccess';
+import type _componentAndPageMemory from './componentAndPageMemory';
+import type _componentDependencies from './componentDependencies';
+import type _config from './config';
+import type _extractUiComponentRefs from './extractUiComponentRefs';
+import type _fetchPage from './fetchPage';
+import type _getConfig from './getConfig';
+import type _getMD from './getMD';
+import type _init from './init';
+import type _koa_attachAwesomenessRequest from './koa/attachAwesomenessRequest';
+import type _koa_cors from './koa/cors';
+import type _koa_errorHandler from './koa/errorHandler';
+import type _koa_finalFormat from './koa/finalFormat';
+import type _koa_jsonBodyParser from './koa/jsonBodyParser';
+import type _koa_routeRequest from './koa/routeRequest';
+import type _koa_serverUp from './koa/serverUp';
+import type _koa_staticFiles from './koa/staticFiles';
+import type _koa_timeout from './koa/timeout';
+import type _pageInfo from './pageInfo';
+import type _reRoute from './reRoute';
+import type _resolveRealCasePath from './resolveRealCasePath';
+import type _specialPaths from './specialPaths';
+import type _start from './start';
+import type _validateRequest from './validateRequest';
+import type _ws_handlers from './ws/handlers';
+import type _ws_index from './ws/index';
+
+export declare const applicationMap: typeof _applicationMap;
+export declare const awesomenessNormalizeRequest: typeof _awesomenessNormalizeRequest;
+export declare const brotliJsonResponse: typeof _brotliJsonResponse;
+export declare const checkAccess: typeof _checkAccess;
+export declare const componentAndPageMemory: typeof _componentAndPageMemory;
+export declare const componentDependencies: typeof _componentDependencies;
+export declare const config: typeof _config;
+export declare const extractUiComponentRefs: typeof _extractUiComponentRefs;
+export declare const fetchPage: typeof _fetchPage;
+export declare const getConfig: typeof _getConfig;
+export declare const getMD: typeof _getMD;
+export declare const init: typeof _init;
+export declare const pageInfo: typeof _pageInfo;
+export declare const reRoute: typeof _reRoute;
+export declare const resolveRealCasePath: typeof _resolveRealCasePath;
+export declare const specialPaths: typeof _specialPaths;
+export declare const start: typeof _start;
+export declare const validateRequest: typeof _validateRequest;
+
+export declare const koa: {
+	attachAwesomenessRequest: typeof _koa_attachAwesomenessRequest;
+	cors: typeof _koa_cors;
+	errorHandler: typeof _koa_errorHandler;
+	finalFormat: typeof _koa_finalFormat;
+	jsonBodyParser: typeof _koa_jsonBodyParser;
+	routeRequest: typeof _koa_routeRequest;
+	serverUp: typeof _koa_serverUp;
+	staticFiles: typeof _koa_staticFiles;
+	timeout: typeof _koa_timeout;
+};
+
+export declare const ws: {
+	handlers: typeof _ws_handlers;
+	index: typeof _ws_index;
+};
+
+
+declare const _default: {
+	applicationMap: typeof _applicationMap;
+	awesomenessNormalizeRequest: typeof _awesomenessNormalizeRequest;
+	brotliJsonResponse: typeof _brotliJsonResponse;
+	checkAccess: typeof _checkAccess;
+	componentAndPageMemory: typeof _componentAndPageMemory;
+	componentDependencies: typeof _componentDependencies;
+	config: typeof _config;
+	extractUiComponentRefs: typeof _extractUiComponentRefs;
+	fetchPage: typeof _fetchPage;
+	getConfig: typeof _getConfig;
+	getMD: typeof _getMD;
+	init: typeof _init;
+	pageInfo: typeof _pageInfo;
+	reRoute: typeof _reRoute;
+	resolveRealCasePath: typeof _resolveRealCasePath;
+	specialPaths: typeof _specialPaths;
+	start: typeof _start;
+	validateRequest: typeof _validateRequest;
+	koa: {
+		attachAwesomenessRequest: typeof _koa_attachAwesomenessRequest,
+		cors: typeof _koa_cors,
+		errorHandler: typeof _koa_errorHandler,
+		finalFormat: typeof _koa_finalFormat,
+		jsonBodyParser: typeof _koa_jsonBodyParser,
+		routeRequest: typeof _koa_routeRequest,
+		serverUp: typeof _koa_serverUp,
+		staticFiles: typeof _koa_staticFiles,
+		timeout: typeof _koa_timeout,
+	},
+	ws: {
+		handlers: typeof _ws_handlers,
+		index: typeof _ws_index,
+	},
+};
+
+export default _default;

package/types/src/applicationMap.d.ts

@@ -0,0 +1 @@
+export default function _default(host: any): any;

package/types/src/awesomenessNormalizeRequest.d.ts

@@ -0,0 +1,27 @@
+export default awesomenessNormalizeRequest;
+export function awesomenessNormalizeRequest({ req }?: {
+    req?: {};
+}): Promise<{
+    headers: any;
+    ip: any;
+    userAgent: any;
+    method: any;
+    host: any;
+    mainDomain: any;
+    domain: any;
+    subDomain: string;
+    site: any;
+    application: any;
+    path: any;
+    pageRoute: any;
+    slug: any;
+    meta: any;
+    testing: any;
+    device: any;
+    data: {};
+    awesomenessType: any;
+    urlParams: {};
+    _RAW: {};
+    log: (message: any, data?: {}) => void;
+    logData: any[];
+}>;

package/types/src/brotliJsonResponse.d.ts

@@ -0,0 +1,10 @@
+export default brotliJsonResponse;
+export function brotliJsonResponse(data: any, {}?: {}): {
+    statusCode: number;
+    isBase64Encoded: boolean;
+    headers: {
+        'Content-Type': string;
+        'Content-Encoding': string;
+    };
+    body: any;
+};

package/types/src/checkAccess.d.ts

@@ -0,0 +1,5 @@
+declare function _default({ permissionsAllowed, awesomenessRequest, }: {
+    permissionsAllowed: any;
+    awesomenessRequest: any;
+}): Promise<boolean>;
+export default _default;

package/types/src/componentAndPageMemory.d.ts

@@ -0,0 +1,75 @@
+export function readFileMemoized(filePath: any): any;
+export function extractUiRefsMemoized(content: any, options?: {}): any;
+export function extractUiRefsFromFileMemoized(filePath: any, options?: {}): any;
+export function clearComponentAndPageMemory(): void;
+export function getComponentAndPageMemoryStatus({ includeKeys, sampleSize, }?: {
+    includeKeys?: boolean;
+    sampleSize?: number;
+}): {
+    limits: {
+        fileCacheLimit: number;
+        refsCacheLimit: number;
+    };
+    counts: {
+        fileCacheEntries: any;
+        refsCacheEntries: any;
+    };
+    approximateBytes: {
+        fileCacheBytes: number;
+        refsCacheBytes: number;
+        totalCacheBytes: number;
+    };
+    approximateMemory: {
+        fileCache: {
+            bytes: any;
+            mb: number;
+            gb: number;
+        };
+        refsCache: {
+            bytes: any;
+            mb: number;
+            gb: number;
+        };
+        totalCache: {
+            bytes: any;
+            mb: number;
+            gb: number;
+        };
+    };
+    processMemoryUsage: any;
+    processMemoryUsageWithUnits: {
+        rss: {
+            bytes: any;
+            mb: number;
+            gb: number;
+        };
+        heapTotal: {
+            bytes: any;
+            mb: number;
+            gb: number;
+        };
+        heapUsed: {
+            bytes: any;
+            mb: number;
+            gb: number;
+        };
+        external: {
+            bytes: any;
+            mb: number;
+            gb: number;
+        };
+        arrayBuffers: {
+            bytes: any;
+            mb: number;
+            gb: number;
+        };
+    };
+};
+export default componentAndPageMemory;
+declare namespace componentAndPageMemory {
+    export { readFileMemoized };
+    export { extractUiRefsMemoized };
+    export { extractUiRefsFromFileMemoized };
+    export { clearComponentAndPageMemory };
+    export { getComponentAndPageMemoryStatus };
+}

package/types/src/componentDependencies.d.ts

@@ -0,0 +1,6 @@
+export default function componentDependencies(allComponents: any, { componentLocations, namespace, showDetails, ignore, }?: {
+    componentLocations?: any[];
+    namespace?: string;
+    showDetails?: boolean;
+    ignore?: string[];
+}): {};

package/types/src/config.d.ts

@@ -0,0 +1,7 @@
+export function init(userConfig?: {}): Readonly<{}>;
+export function getConfig(): Readonly<{}>;
+declare namespace _default {
+    export { init };
+    export { getConfig };
+}
+export default _default;

package/types/src/extractUiComponentRefs.d.ts

@@ -0,0 +1,5 @@
+export default function extractUiComponentRefs(str: any, { namespace, includeCall, includeDotAccess, }?: {
+    namespace?: string;
+    includeCall?: boolean;
+    includeDotAccess?: boolean;
+}): any[];

package/types/src/fetchPage.d.ts

@@ -0,0 +1,4 @@
+export default function fetchPage(awesomenessRequest: any, { about, cssPath, jsPath, getData, showDetails, page }?: {
+    showDetails?: boolean;
+    page?: any;
+}): Promise<any>;

package/types/src/getConfig.d.ts

@@ -0,0 +1,2 @@
+export default getConfig;
+import { getConfig } from "./config.js";

package/types/src/getMD.d.ts

@@ -0,0 +1 @@
+export default function getMD(relativePath: any, callerUrl: any): Promise<any>;

package/types/src/init.d.ts

@@ -0,0 +1,2 @@
+export default init;
+import { init } from "./config.js";

package/types/src/koa/attachAwesomenessRequest.d.ts

@@ -0,0 +1 @@
+export default function attachAwesomenessRequest(ctx: any, next: any): Promise<void>;

package/types/src/koa/cors.d.ts

@@ -0,0 +1 @@
+export default function cors(ctx: any, next: any): Promise<void>;

package/types/src/koa/errorHandler.d.ts

@@ -0,0 +1 @@
+export default function errorHandler(ctx: any, next: any): Promise<void>;

package/types/src/koa/finalFormat.d.ts

@@ -0,0 +1 @@
+export default function finalFormat(awesomenessRequest: any, ctx: any): void;

package/types/src/koa/jsonBodyParser.d.ts

@@ -0,0 +1 @@
+export default function jsonBodyParser(ctx: any, next: any): Promise<void>;

package/types/src/koa/routeRequest.d.ts

@@ -0,0 +1 @@
+export default function routeRequest(ctx: any, next: any): Promise<void>;

package/types/src/koa/serverUp.d.ts

@@ -0,0 +1 @@
+export default function serverUp(): Promise<void>;

package/types/src/koa/staticFiles.d.ts

@@ -0,0 +1 @@
+export default function staticFiles(ctx: any, next: any): Promise<void>;

package/types/src/koa/timeout.d.ts

@@ -0,0 +1 @@
+export default function timeout(ms: any): (ctx: any, next: any) => Promise<void>;

package/types/src/pageInfo.d.ts

@@ -0,0 +1,8 @@
+export default function pageInfo(awesomenessRequest: any, { page }?: {
+    page?: any;
+}): Promise<{
+    getData: any;
+    about: any;
+    cssPath: any;
+    jsPath: any;
+}>;

package/types/src/reRoute.d.ts

@@ -0,0 +1,7 @@
+export default function reRoute({ goToPage, awesomenessRequest }: {
+    goToPage: any;
+    awesomenessRequest: any;
+}): Promise<{
+    pageData: any;
+    pageRouteFixed: any;
+}>;

package/types/src/resolveRealCasePath.d.ts

@@ -0,0 +1 @@
+export default function resolveRealCasePath(inputPath: any, returnAbsolute?: boolean): any;

package/types/src/specialPaths.d.ts

@@ -0,0 +1,3 @@
+export function matchPathSite(site: any, pattern: any, path: any): {};
+export function specialPaths(awesomenessRequest: any, routes: any): Promise<void>;
+export default specialPaths;

package/types/src/start.d.ts

@@ -0,0 +1 @@
+export default function start(): Promise<void>;

package/types/src/validateRequest.d.ts

@@ -0,0 +1,2 @@
+declare function _default(awesomenessRequest: any): Promise<boolean>;
+export default _default;

package/types/src/ws/handlers.d.ts

@@ -0,0 +1,4 @@
+export default function handleWsMessage({ socket, raw }: {
+    socket: any;
+    raw: any;
+}): void;

package/types/src/ws/index.d.ts

@@ -0,0 +1 @@
+export default function attachWs(server: any, path?: string): any;