@revealui/core 0.0.1-pre.0

package/dist/core/utils/index.ts

@@ -0,0 +1,31 @@
+// Utils needed by all runtimes:
+//  - runtime of server
+//  - runtime of client (Server Routing)
+//  - runtime of client (Client Routing)
+
+export * from "../targets/url/parseUrl.js";
+export * from "../gaurds/assertions/assert/index.js";
+export * from "../gaurds/assertions/assertWarning/index.js";
+export * from "../gaurds/assertions/assertUsage/index.js";
+export * from "../gaurds/assertions/assertCast.js";
+export * from "../gaurds/assertions/checkType.js";
+export * from "../gaurds/validators/hasProp.js";
+export * from "../gaurds/validators/isArray.js";
+export * from "../gaurds/validators/isBrowser.js";
+export * from "../gaurds/validators/isCallable.js";
+export * from "../gaurds/validators/isNotNullish.js";
+export * from "../gaurds/validators/isObject.js";
+export * from "../gaurds/validators/isPlainObject.js";
+export * from "../gaurds/validators/isPromise.js";
+export * from "../gaurds/validators/isPropertyGetter.js";
+export * from "../processing/getters/getValuePrintable.js";
+export * from "./array/slice.js";
+export * from "./array/sorter.js";
+export * from "./array/stringifyStringArray.js";
+export * from "./array/unique.js";
+export * from "../files/file-system/filesystemPath.js";
+export * from "./object/changeEnumerable.js";
+export * from "./object/objectAssign.js";
+export * from "./object/objectDefineProperty.js";
+export * from "./string/compareString.js";
+export * from "./string/escapeRegex.js";

package/dist/core/utils/object/changeEnumerable.ts

@@ -0,0 +1,9 @@
+/** Change enumerability of an object property. */
+export function changeEnumerable(
+  obj: Object,
+  prop: string,
+  enumerable: boolean,
+) {
+  const descriptor = Object.getOwnPropertyDescriptor(obj, prop);
+  Object.defineProperty(obj, prop, { ...descriptor, enumerable });
+}

package/dist/core/utils/object/deepEqual.ts

@@ -0,0 +1,10 @@
+// https://stackoverflow.com/questions/201183/how-to-determine-equality-for-two-javascript-objects/32922084#32922084
+export function deepEqual(x: any, y: any): boolean {
+  const ok = Object.keys,
+    tx = typeof x,
+    ty = typeof y;
+  return x && y && tx === "object" && tx === ty
+    ? ok(x).length === ok(y).length &&
+        ok(x).every((key) => deepEqual(x[key], y[key]))
+    : x === y;
+}

package/dist/core/utils/object/objectAssign.ts

@@ -0,0 +1,16 @@
+import { assert } from "../../gaurds/assertions/assert";
+
+export { objectAssign };
+
+// Same as Object.assign() but:
+//  - With type inference
+//  - Preserves property descriptors, which we need for preserving the getters added by getPageContextUrlComputed()
+function objectAssign<Obj extends object, ObjAddendum extends object | null>(
+  obj: Obj,
+  objAddendum: ObjAddendum,
+): asserts obj is Obj & ObjAddendum {
+  if (objAddendum) {
+    assert(!("_isPageContextObject" in objAddendum));
+    Object.defineProperties(obj, Object.getOwnPropertyDescriptors(objAddendum));
+  }
+}

package/dist/core/utils/object/objectDefineProperty.ts

@@ -0,0 +1,15 @@
+/** Like Object.defineProperty() but with type inference */
+export function objectDefineProperty<
+  Obj extends object,
+  Prop extends PropertyKey,
+  PropertyType,
+>(
+  obj: Obj,
+  prop: Prop,
+  {
+    get,
+    ...args
+  }: { get: () => PropertyType } & Omit<PropertyDescriptor, "set" | "get">,
+): asserts obj is Obj & Record<Prop, PropertyType> {
+  Object.defineProperty(obj, prop, { ...args, get });
+}

package/dist/core/utils/object/objectEntries.ts

@@ -0,0 +1,7 @@
+// https://stackoverflow.com/questions/60141960/typescript-key-value-relation-preserving-object-entries-type/75337277#75337277
+/** Same as Object.entries() but with type inference */
+export function objectEntries<T extends object>(
+  obj: T,
+): [keyof T, T[keyof T]][] {
+  return Object.entries(obj) as any;
+}

package/dist/core/utils/object/objectEntriesForEach.ts

@@ -0,0 +1,7 @@
+/** Same as Object.entries().forEach() but with type inference */
+export function objectEntriesForEach<Obj extends object>(
+  obj: Obj,
+  iterator: <Key extends keyof Obj>(key: Key, val: Obj[Key]) => void,
+): void {
+  Object.entries(obj).forEach(([key, val]) => iterator(key as keyof Obj, val));
+}

package/dist/core/utils/object/objectFromEntries.ts

@@ -0,0 +1,6 @@
+/** Same as Object.fromEntries() but with type inference */
+export function objectFromEntries<T extends [PropertyKey, unknown][]>(
+  arr: T,
+): Record<T[number][0], T[number][1]> {
+  return Object.fromEntries(arr) as any;
+}

package/dist/core/utils/string/addWhitespace.ts

@@ -0,0 +1,9 @@
+export { addWhitespace };
+
+function addWhitespace(msg: string) {
+  if (msg.startsWith("[")) {
+    return msg;
+  } else {
+    return ` ${msg}`;
+  }
+}

package/dist/core/utils/string/capitalizeFirstLetter.ts

@@ -0,0 +1,8 @@
+export { capitalizeFirstLetter };
+
+function capitalizeFirstLetter(word: string): string {
+  if (!word[0]) {
+    return word;
+  }
+  return word[0].toUpperCase() + word.slice(1);
+}

package/dist/core/utils/string/compareString.ts

@@ -0,0 +1,7 @@
+export { compareString };
+
+function compareString(str1: string, str2: string): number {
+  if (str1.toLowerCase() < str2.toLowerCase()) return -1;
+  if (str1.toLowerCase() > str2.toLowerCase()) return 1;
+  return 0;
+}

package/dist/core/utils/string/escapeHtml.ts

@@ -0,0 +1,10 @@
+// Copied from https://stackoverflow.com/questions/6234773/can-i-escape-html-special-chars-in-javascript/6234804#6234804
+export function escapeHtml(unsafeString: string): string {
+  const safe = unsafeString
+    .replace(/&/g, "&")
+    .replace(/</g, "&lt;")
+    .replace(/>/g, "&gt;")
+    .replace(/"/g, "&quot;")
+    .replace(/'/g, "&#039;");
+  return safe;
+}

package/dist/core/utils/string/escapeRegex.ts

@@ -0,0 +1,4 @@
+export function escapeRegex(str: string): string {
+  // https://stackoverflow.com/questions/3561493/is-there-a-regexp-escape-function-in-javascript/3561711#3561711
+  return str.replace(/[/\-\\^$*+?.()|[\]{}]/g, "\\$&");
+}

package/dist/core/utils/string/joinEnglish.ts

@@ -0,0 +1,18 @@
+import { assert } from "../../gaurds/assertions/assert/base";
+
+export { joinEnglish };
+
+// https://stackoverflow.com/questions/53879088/join-an-array-by-commas-and-and/53879103#53879103
+function joinEnglish(
+  arr: string[] | readonly string[],
+  conjunction: "or" | "and",
+  colorizer: (s: string) => string = (s) => s,
+): string {
+  assert(arr.length > 0);
+  if (arr.length === 1) return colorizer(arr[0]!);
+  const firsts = arr.slice(0, arr.length - 1);
+  const last = arr[arr.length - 1]!;
+  return (
+    firsts.map(colorizer).join(", ") + `, ${conjunction} ` + colorizer(last)
+  );
+}

package/dist/core/utils/string/removeEmptyLines.ts

@@ -0,0 +1,6 @@
+export function removeEmptyLines(msg: string): string {
+  return msg
+    .split("\n")
+    .filter((line) => line.trim() !== "")
+    .join("\n");
+}

package/dist/core/utils/string/stripAnsi.ts

@@ -0,0 +1,24 @@
+import { assertIsNotBrowser } from "../../gaurds/assertions/assertIsNotBrowser";
+
+export { stripAnsi };
+
+assertIsNotBrowser();
+
+const ansiRegex = getAnsiRegex();
+
+// Copied from https://github.com/chalk/strip-ansi/blob/1fdc531d4046cbaa830460f5c74452bf1f0a0884/index.js
+function stripAnsi(string: string) {
+  // Even though the regex is global, we don't need to reset the `.lastIndex`
+  // because unlike `.exec()` and `.test()`, `.replace()` does it automatically
+  // and doing it manually has a performance penalty.
+  return string.replace(ansiRegex, "");
+}
+
+// Copied from https://github.com/chalk/ansi-regex/blob/02fa893d619d3da85411acc8fd4e2eea0e95a9d9/index.js
+function getAnsiRegex() {
+  const pattern = [
+    "[\\u001B\\u009B][[\\]()#;?]*(?:(?:(?:(?:;[-a-zA-Z\\d\\/#&.:=?%@~_]+)*|[a-zA-Z\\d]+(?:;[-a-zA-Z\\d\\/#&.:=?%@~_]*)*)?\\u0007)",
+    "(?:(?:\\d{1,4}(?:;\\d{0,4})*)?[\\dA-PR-TZcf-nq-uy=><~]))",
+  ].join("|");
+  return new RegExp(pattern, "g");
+}

package/dist/core/utils/string/trimWithAnsi.ts

@@ -0,0 +1,40 @@
+export { trimWithAnsi, trimWithAnsiTrailOnly };
+
+import { assert } from "../../gaurds/assertions/assert/index.js";
+import { stripAnsi } from "./stripAnsi.js";
+
+const whitespaceRegex = /(\s+)/; // Capturing parathesis so that split preserves seperator
+
+/* Same as trim() but works with ANSI escape codes */
+function trimWithAnsi(str: string): string {
+  str = trimWithAnsiHead(str);
+  str = trimWithAnsiTrailOnly(str);
+  return str;
+}
+
+function trimWithAnsiHead(str: string) {
+  return trim(str, false);
+}
+function trimWithAnsiTrailOnly(str: string): string {
+  return trim(str, true);
+}
+
+function trim(str: string, trail?: boolean) {
+  let parts = str.split(whitespaceRegex);
+  if (trail) parts.reverse();
+  let visible = false;
+  parts = parts.map((line): string => {
+    if (visible) return line;
+    const lineTrimmed = line.trim();
+    const lineTrimmedAndStripped = stripAnsi(lineTrimmed);
+    assert(lineTrimmedAndStripped.trim() === lineTrimmedAndStripped);
+    if (lineTrimmedAndStripped !== "") visible = true;
+    return lineTrimmed;
+  });
+  if (trail) parts.reverse();
+
+  assert(str.split(whitespaceRegex).join("") === str);
+  const strTrimmed = parts.join("");
+
+  return strTrimmed;
+}

package/dist/core/utils/string/truncateString.ts

@@ -0,0 +1,19 @@
+export { truncateString };
+
+import pc from "@brillout/picocolors";
+import { assert } from "../../gaurds/assertions/assert/base";
+
+function truncateString(str: string, lenMax: number) {
+  const lenMaxReal = lenMax - 3;
+  assert(lenMaxReal >= 1); // Show at least one character before the ellipsis
+  if (str.length < lenMax) {
+    return str;
+  } else {
+    // Breaks ANSI codes.
+    //  - So far, the `str` we pass to truncateString(str) is always expected to not contain any ANSI code
+    str = str.substring(0, lenMaxReal);
+    const ellipsis = pc.dim("...");
+    str = str + ellipsis;
+    return str;
+  }
+}

package/dist/core/utils/time/humanizeTime.ts

@@ -0,0 +1,24 @@
+export { humanizeTime };
+
+function humanizeTime(milliseconds: number): string {
+  const seconds = milliseconds / 1000;
+  if (seconds < 120) {
+    const n = round(seconds);
+    return `${n} second${plural(n)}`;
+  }
+  {
+    const minutes = seconds / 60;
+    const n = round(minutes);
+    return `${n} minute${plural(n)}`;
+  }
+}
+
+function round(n: number): string {
+  let rounded = n.toFixed(1);
+  if (rounded.endsWith(".0")) rounded = rounded.slice(0, -2);
+  return rounded;
+}
+
+function plural(n: string): string {
+  return n === "1" ? "" : "s";
+}

package/dist/exports/RenderErrorPage.js

@@ -0,0 +1,3 @@
+// eslint doesn't seem to support `package.json#exports`.
+export * from "./dist/shared/RenderErrorPage.mjs";
+export { default } from "./dist/shared/RenderErrorPage.mjs";

package/dist/exports/__internal.js

@@ -0,0 +1,3 @@
+// eslint doesn't seem to support `package.json#exports`.
+export * from "./dist/__internal/index.mjs";
+export { default } from "./dist/__internal/index.mjs";

package/dist/exports/abort.js

@@ -0,0 +1,3 @@
+// eslint doesn't seem to support `package.json#exports`.
+export * from "./dist/shared/abort.mjs";
+export { default } from "./dist/shared/abort.mjs";

package/dist/exports/bin-entry.js

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+
+import "../../dist/node/cli/bin.js";

package/dist/exports/cli.js

@@ -0,0 +1,3 @@
+// eslint doesn't seem to support `package.json#exports`.
+export * from "./dist/node/cli/index.mjs";
+export { default } from "./dist/node/cli/index.mjs";

package/dist/exports/client.js

@@ -0,0 +1,3 @@
+// eslint doesn't seem to support `package.json#exports`.
+export * from "./dist/client/server-routing-runtime";
+export { default } from "./dist/client/server-routing-runtime";

package/dist/exports/config.js

@@ -0,0 +1 @@
+export * from "../integration/dist/+config.js";

package/dist/exports/helpers.js

@@ -0,0 +1 @@
+export * from "./dist/templates/helpers.js";

package/dist/exports/index.js

@@ -0,0 +1,33 @@
+import { default as __internal } from "./__internal.js"
+import { default as abort } from "./abort.js"
+import { default as bin } from "./bin-entry.js"
+import { default as cli } from "./cli.js"
+import { default as client } from "./client.js"
+import { default as config } from "./config.js"
+import { default as helpers } from "./helpers.js"
+import { default as plugin } from "./plugin.js"
+import { default as prerender } from "./prerender.js"
+import { default as RenderErrorPage } from "./RenderErrorPage.js"
+import { default as router } from "./router.js"
+import { default as routing } from "./routing.js"
+import { default as server } from "./server.js"
+import { default as setup } from "./setup.js"
+import { default as types } from "./types.js"
+
+export {
+  __internal,
+  abort,
+  bin,
+  cli,
+  client,
+  config,
+  helpers,
+  plugin,
+  prerender,
+  RenderErrorPage,
+  router,
+  routing,
+  server,
+  setup,
+  types,
+}

package/dist/exports/plugin.js

@@ -0,0 +1,3 @@
+// eslint doesn't seem to support `package.json#exports`.
+export * from "./dist/node/plugin/index.mjs";
+export { default } from "./dist/node/plugin/index.mjs";

package/dist/exports/prerender.js

@@ -0,0 +1,3 @@
+// eslint doesn't seem to support `package.json#exports`.
+export * from "./dist/node/prerender/index.mjs";
+export { default } from "./dist/node/prerender/index.mjs";

package/dist/exports/router.js

@@ -0,0 +1,3 @@
+// eslint doesn't seem to support `package.json#exports`.
+export * from "../dist/client/client-routing-runtime";
+export { default } from "../dist/client/client-routing-runtime";

package/dist/exports/routing.js

@@ -0,0 +1,3 @@
+// eslint doesn't seem to support `package.json#exports`.
+export * from "./dist/shared/route/routing.mjs";
+export { default } from "./dist/router/route/routing.mjs";

package/dist/exports/server.js

@@ -0,0 +1,3 @@
+// eslint doesn't seem to support `package.json#exports`.
+export * from "./dist/node/runtime/index.mjs";
+export { default } from "./dist/node/runtime/index.mjs";

package/dist/exports/setup.js

@@ -0,0 +1,3 @@
+// eslint doesn't seem to support `package.json#exports`.
+export * from "../dist/node/runtime/setup.mjs";
+export { default } from "../dist/node/runtime/setup.mjs";

package/dist/exports/types.js

@@ -0,0 +1 @@
+export * from "../../types/index.js";

package/dist/index.d.ts

@@ -0,0 +1 @@
+export * from "./exports/index.js";

package/dist/index.js

@@ -0,0 +1,33 @@
+import { default as __internal } from "./__internal.js"
+import { default as abort } from "./abort.js"
+import { default as bin } from "./bin-entry.js"
+import { default as cli } from "./cli.js"
+import { default as client } from "./client.js"
+import { default as config } from "./config.js"
+import { default as helpers } from "./helpers.js"
+import { default as plugin } from "./plugin.js"
+import { default as prerender } from "./prerender.js"
+import { default as RenderErrorPage } from "./RenderErrorPage.js"
+import { default as router } from "./router.js"
+import { default as routing } from "./routing.js"
+import { default as server } from "./server.js"
+import { default as setup } from "./setup.js"
+import { default as types } from "./types.js"
+
+export {
+  __internal,
+  abort,
+  bin,
+  cli,
+  client,
+  config,
+  helpers,
+  plugin,
+  prerender,
+  RenderErrorPage,
+  router,
+  routing,
+  server,
+  setup,
+  types,
+}

package/dist/integration/hydration.ts

@@ -0,0 +1,52 @@
+/**
+ * Integration layer for progressive hydration
+ * Connects progressive hydration with Vike's rendering system
+ */
+
+import type { PageContextServer } from "../types/interfaces/context.js";
+import {
+  getHydrationScript,
+  setupProgressiveHydration,
+  type HydrationStrategy,
+} from "../core/hydration/progressive.js";
+
+/**
+ * Configures progressive hydration for a page
+ */
+export function configureProgressiveHydration(
+  pageContext: PageContextServer,
+  strategy: HydrationStrategy
+): void {
+  const route = pageContext.urlPathname || "/";
+  setupProgressiveHydration(route, strategy);
+}
+
+/**
+ * Injects hydration script into HTML
+ */
+export function injectHydrationScript(html: string): string {
+  const script = getHydrationScript();
+  // Inject before closing body tag
+  return html.replace("</body>", `${script}\n</body>`);
+}
+
+/**
+ * Adds hydration data attributes to HTML elements
+ */
+export function addHydrationAttributes(
+  html: string,
+  selector: string,
+  strategy: HydrationStrategy
+): string {
+  // This is a simplified version - in production, use a proper HTML parser
+  const dataAttribute = `data-hydrate="${strategy.type}"`;
+  const regex = new RegExp(`<([^>]+)${selector}([^>]*)>`, "g");
+
+  return html.replace(regex, (match, before, after) => {
+    if (before.includes(dataAttribute) || after.includes(dataAttribute)) {
+      return match;
+    }
+    return `<${before}${selector}${after} ${dataAttribute}>`;
+  });
+}
+