@ecopages/core 0.2.0-alpha.3 → 0.2.0-alpha.30

package/src/router/client/navigation-coordinator.js

@@ -0,0 +1,215 @@
+const ECO_DOCUMENT_OWNER_ATTRIBUTE = "data-eco-document-owner";
+function getEcoDocumentOwner(doc) {
+  const owner = doc.documentElement.getAttribute(ECO_DOCUMENT_OWNER_ATTRIBUTE);
+  return owner && owner.length > 0 ? owner : null;
+}
+function getCandidateOwners(currentOwner, registrations, excludedOwner) {
+  const owners = [];
+  if (currentOwner !== "none" && currentOwner !== excludedOwner) {
+    owners.push(currentOwner);
+  }
+  for (const owner of registrations.keys()) {
+    if (owner === currentOwner || owner === excludedOwner) {
+      continue;
+    }
+    owners.push(owner);
+  }
+  return owners;
+}
+function createEcoNavigationRuntime() {
+  const registrations = /* @__PURE__ */ new Map();
+  const listeners = /* @__PURE__ */ new Set();
+  let owner = "none";
+  let navigationSequence = 0;
+  let navigationAbortController = null;
+  const emit = (event) => {
+    for (const listener of listeners) {
+      listener(event);
+    }
+  };
+  const updateOwner = (nextOwner, reason) => {
+    if (owner === nextOwner) {
+      return;
+    }
+    const previousOwner = owner;
+    owner = nextOwner;
+    emit({
+      type: "owner-change",
+      owner: nextOwner,
+      previousOwner,
+      reason
+    });
+  };
+  const cancelNavigationTransaction = (navigationId, abortController) => {
+    if (navigationSequence !== navigationId || navigationAbortController !== abortController) {
+      return;
+    }
+    navigationSequence += 1;
+    navigationAbortController = null;
+    abortController.abort();
+  };
+  const completeNavigationTransaction = (navigationId, abortController) => {
+    if (navigationSequence !== navigationId || navigationAbortController !== abortController) {
+      return;
+    }
+    navigationAbortController = null;
+  };
+  const runtime = {
+    getOwnerState() {
+      const activeRuntime = registrations.get(owner);
+      return {
+        owner,
+        canHandleSpaNavigation: typeof activeRuntime?.navigate === "function"
+      };
+    },
+    hasPendingNavigationTransaction() {
+      return navigationAbortController !== null;
+    },
+    beginNavigationTransaction() {
+      navigationAbortController?.abort();
+      const abortController = new AbortController();
+      const navigationId = ++navigationSequence;
+      navigationAbortController = abortController;
+      return {
+        id: navigationId,
+        signal: abortController.signal,
+        isCurrent: () => navigationSequence === navigationId && navigationAbortController === abortController,
+        cancel: () => {
+          cancelNavigationTransaction(navigationId, abortController);
+        },
+        complete: () => {
+          completeNavigationTransaction(navigationId, abortController);
+        }
+      };
+    },
+    cancelCurrentNavigationTransaction() {
+      if (!navigationAbortController) {
+        return;
+      }
+      cancelNavigationTransaction(navigationSequence, navigationAbortController);
+    },
+    setOwner(nextOwner) {
+      updateOwner(nextOwner, "set");
+    },
+    claimOwnership(nextOwner) {
+      updateOwner(nextOwner, "claim");
+    },
+    releaseOwnership(currentOwner) {
+      if (owner !== currentOwner) {
+        return;
+      }
+      updateOwner("none", "release");
+    },
+    resolveDocumentOwner(doc, fallbackOwner = "none") {
+      return getEcoDocumentOwner(doc) ?? fallbackOwner;
+    },
+    adoptDocumentOwner(doc, fallbackOwner = "none") {
+      const nextOwner = runtime.resolveDocumentOwner(doc, fallbackOwner);
+      updateOwner(nextOwner, "document");
+      return nextOwner;
+    },
+    isOwnedByAnotherRuntime(candidateOwner) {
+      return owner !== "none" && owner !== candidateOwner;
+    },
+    subscribe(listener) {
+      listeners.add(listener);
+      return () => {
+        listeners.delete(listener);
+      };
+    },
+    register(registration) {
+      registrations.set(registration.owner, registration);
+      emit({
+        type: "registration-change",
+        owner: registration.owner,
+        status: "registered"
+      });
+      return () => {
+        const currentRegistration = registrations.get(registration.owner);
+        if (currentRegistration !== registration) {
+          return;
+        }
+        registrations.delete(registration.owner);
+        emit({
+          type: "registration-change",
+          owner: registration.owner,
+          status: "unregistered"
+        });
+        if (owner === registration.owner) {
+          updateOwner("none", "unregister");
+        }
+      };
+    },
+    async requestNavigation(request) {
+      for (const candidateOwner of getCandidateOwners(owner, registrations, request.source)) {
+        const registration = registrations.get(candidateOwner);
+        if (!registration?.navigate) {
+          continue;
+        }
+        const handled = await registration.navigate(request);
+        if (handled !== false) {
+          return true;
+        }
+      }
+      return false;
+    },
+    async requestHandoff(request) {
+      if (request.targetOwner === "none") {
+        return false;
+      }
+      if (request.isStaleSourceNavigation?.()) {
+        return true;
+      }
+      const registration = registrations.get(request.targetOwner);
+      if (!registration?.handoffNavigation) {
+        return false;
+      }
+      if (request.isStaleSourceNavigation?.()) {
+        return true;
+      }
+      const handled = await registration.handoffNavigation(request);
+      return handled !== false;
+    },
+    async reloadCurrentPage(request) {
+      for (const candidateOwner of getCandidateOwners(owner, registrations)) {
+        const registration = registrations.get(candidateOwner);
+        if (!registration?.reloadCurrentPage) {
+          continue;
+        }
+        await registration.reloadCurrentPage(request);
+        return true;
+      }
+      return false;
+    },
+    async cleanupOwner(targetOwner) {
+      if (targetOwner === "none") {
+        return;
+      }
+      const registration = registrations.get(targetOwner);
+      if (!registration?.cleanupBeforeHandoff) {
+        return;
+      }
+      await registration.cleanupBeforeHandoff();
+      if (owner === targetOwner) {
+        updateOwner("none", "release");
+      }
+    },
+    async cleanupCurrentOwner() {
+      await runtime.cleanupOwner(owner);
+    }
+  };
+  return runtime;
+}
+function getEcoNavigationRuntime(windowObject = window) {
+  const runtimeWindow = windowObject;
+  runtimeWindow.__ECO_PAGES__ = runtimeWindow.__ECO_PAGES__ || {};
+  if (!runtimeWindow.__ECO_PAGES__.navigation) {
+    runtimeWindow.__ECO_PAGES__.navigation = createEcoNavigationRuntime();
+  }
+  return runtimeWindow.__ECO_PAGES__.navigation;
+}
+export {
+  ECO_DOCUMENT_OWNER_ATTRIBUTE,
+  getEcoDocumentOwner,
+  getEcoNavigationRuntime
+};

package/src/router/server/route-registry.d.ts

@@ -0,0 +1,78 @@
+import type { EcoPagesAppConfig, RouteKind } from '../../types/internal-types.js';
+export type RouteParams = Record<string, string | string[]>;
+export type RouteQuery = Record<string, string>;
+export type TemplateRoute = {
+    readonly pathname: string;
+    readonly kind: RouteKind;
+    readonly filePath: string;
+    readonly paramNames: readonly string[];
+};
+export type RouteMatch = {
+    readonly requestedPathname: string;
+    readonly templateRoute: TemplateRoute;
+    readonly params: RouteParams;
+    readonly query: RouteQuery;
+};
+export type StaticPathExpansion = {
+    readonly pathname: string;
+    readonly templateRoute: TemplateRoute;
+    readonly params: RouteParams;
+};
+export type StaticGenerationRoute = {
+    readonly requestUrl: string;
+    readonly pathname: string;
+    readonly templateRoute: TemplateRoute;
+    readonly params: RouteParams;
+};
+export type StaticPathsContext = {
+    readonly appConfig: EcoPagesAppConfig;
+    readonly runtimeOrigin: string;
+};
+export type RouteRegistryPageModule = {
+    readonly staticPaths?: (context: StaticPathsContext) => Promise<{
+        paths: Array<{
+            params: RouteParams;
+        }>;
+    }>;
+    readonly staticProps?: unknown;
+};
+export interface RouteRegistryPageModuleAdapter {
+    loadPageModule(filePath: string): Promise<RouteRegistryPageModule>;
+}
+export type RouteRegistryOptions = {
+    pagesDir: string;
+    appConfig: EcoPagesAppConfig;
+    origin: string;
+    templatesExt: readonly string[];
+    buildMode: boolean;
+    pageModuleAdapter: RouteRegistryPageModuleAdapter;
+};
+export declare class RouteRegistry {
+    readonly origin: string;
+    readonly appConfig: EcoPagesAppConfig;
+    readonly pagesDir: string;
+    readonly templatesExt: readonly string[];
+    readonly buildMode: boolean;
+    private readonly pageModuleAdapter;
+    private templateRouteList;
+    private readonly reloadListeners;
+    constructor(options: RouteRegistryOptions);
+    get templateRoutes(): readonly TemplateRoute[];
+    init(): Promise<void>;
+    reload(): Promise<void>;
+    onReload(listener: () => void): () => void;
+    matchRequest(requestUrl: string): RouteMatch | null;
+    listStaticPathExpansions(input: {
+        runtimeOrigin: string;
+    }): Promise<readonly StaticPathExpansion[]>;
+    listStaticGenerationRoutes(input: {
+        runtimeOrigin: string;
+    }): Promise<readonly StaticGenerationRoute[]>;
+    private scanTemplateRoutes;
+    private getRoutePath;
+    private classifyRouteKind;
+    private getParamNames;
+    private tryExtractParams;
+    private getSearchParams;
+    private resolveTemplatePath;
+}

package/src/router/server/route-registry.js

@@ -0,0 +1,262 @@
+import path from "node:path";
+import { existsSync } from "node:fs";
+import { fileSystem } from "@ecopages/file-system";
+import { appLogger } from "../../global/app-logger.js";
+import { invariant } from "../../utils/invariant.js";
+const ROUTE_PRIORITY = {
+  exact: 0,
+  dynamic: 1,
+  "catch-all": 2
+};
+class RouteRegistry {
+  origin;
+  appConfig;
+  pagesDir;
+  templatesExt;
+  buildMode;
+  pageModuleAdapter;
+  templateRouteList = [];
+  reloadListeners = /* @__PURE__ */ new Set();
+  constructor(options) {
+    this.origin = options.origin;
+    this.appConfig = options.appConfig;
+    this.pagesDir = options.pagesDir;
+    this.templatesExt = options.templatesExt;
+    this.buildMode = options.buildMode;
+    this.pageModuleAdapter = options.pageModuleAdapter;
+  }
+  get templateRoutes() {
+    return this.templateRouteList;
+  }
+  async init() {
+    this.templateRouteList = await this.scanTemplateRoutes();
+    appLogger.debug("RouteRegistry initialized", this.templateRouteList);
+  }
+  async reload() {
+    await this.init();
+    for (const listener of this.reloadListeners) {
+      listener();
+    }
+  }
+  onReload(listener) {
+    this.reloadListeners.add(listener);
+    return () => {
+      this.reloadListeners.delete(listener);
+    };
+  }
+  matchRequest(requestUrl) {
+    const url = new URL(requestUrl);
+    const requestedPathname = normalizePathname(url.pathname);
+    const query = this.getSearchParams(url);
+    for (const route of this.templateRouteList) {
+      if (route.kind !== "exact") {
+        continue;
+      }
+      if (requestedPathname === route.pathname || requestedPathname === `${route.pathname}/`) {
+        return {
+          requestedPathname,
+          templateRoute: route,
+          params: {},
+          query
+        };
+      }
+    }
+    for (const route of this.templateRouteList) {
+      if (route.kind !== "dynamic") {
+        continue;
+      }
+      const params = this.tryExtractParams(route, requestedPathname);
+      if (!params) {
+        continue;
+      }
+      return {
+        requestedPathname,
+        templateRoute: route,
+        params,
+        query
+      };
+    }
+    for (const route of this.templateRouteList) {
+      if (route.kind !== "catch-all") {
+        continue;
+      }
+      const params = this.tryExtractParams(route, requestedPathname);
+      if (!params) {
+        continue;
+      }
+      return {
+        requestedPathname,
+        templateRoute: route,
+        params,
+        query
+      };
+    }
+    return null;
+  }
+  async listStaticPathExpansions(input) {
+    const expansions = [];
+    for (const route of this.templateRouteList) {
+      if (route.kind === "exact") {
+        continue;
+      }
+      const pageModule = await this.pageModuleAdapter.loadPageModule(route.filePath);
+      const staticPaths = pageModule.staticPaths;
+      if (this.buildMode) {
+        invariant(staticPaths !== void 0, `[ecopages] Missing getStaticPaths in ${route.filePath}`);
+        invariant(
+          pageModule.staticProps !== void 0,
+          `[ecopages] Missing getStaticProps in ${route.filePath}`
+        );
+      }
+      if (!staticPaths) {
+        continue;
+      }
+      const result = await staticPaths({
+        appConfig: this.appConfig,
+        runtimeOrigin: input.runtimeOrigin
+      });
+      for (const { params } of result.paths) {
+        expansions.push({
+          pathname: this.resolveTemplatePath(route.pathname, params),
+          templateRoute: route,
+          params
+        });
+      }
+    }
+    return expansions;
+  }
+  async listStaticGenerationRoutes(input) {
+    const staticPathExpansions = await this.listStaticPathExpansions(input);
+    return [
+      ...this.templateRouteList.filter((route) => route.kind === "exact").map((route) => ({
+        requestUrl: `${input.runtimeOrigin}${route.pathname}`,
+        pathname: route.pathname,
+        templateRoute: route,
+        params: {}
+      })),
+      ...staticPathExpansions.map((route) => ({
+        requestUrl: `${input.runtimeOrigin}${route.pathname}`,
+        pathname: route.pathname,
+        templateRoute: route.templateRoute,
+        params: route.params
+      }))
+    ];
+  }
+  async scanTemplateRoutes() {
+    if (!existsSync(this.pagesDir)) {
+      return [];
+    }
+    const scannedFiles = await fileSystem.glob(
+      this.templatesExt.map((ext) => `**/*${ext}`),
+      {
+        cwd: this.pagesDir
+      }
+    );
+    const templateRoutes = [];
+    for await (const file of scannedFiles) {
+      if (file.includes(".ecopages-node.")) {
+        continue;
+      }
+      const routePathname = this.getRoutePath(file);
+      const filePath = path.join(this.pagesDir, file);
+      const kind = this.classifyRouteKind(filePath);
+      templateRoutes.push({
+        pathname: routePathname,
+        kind,
+        filePath,
+        paramNames: this.getParamNames(routePathname)
+      });
+    }
+    return templateRoutes.sort((left, right) => {
+      const priorityDifference = ROUTE_PRIORITY[left.kind] - ROUTE_PRIORITY[right.kind];
+      if (priorityDifference !== 0) {
+        return priorityDifference;
+      }
+      if (left.pathname === "/") {
+        return -1;
+      }
+      if (right.pathname === "/") {
+        return 1;
+      }
+      return left.pathname.localeCompare(right.pathname);
+    });
+  }
+  getRoutePath(file) {
+    const cleanedRoute = this.templatesExt.reduce((route, ext) => route.replace(ext, ""), file).replace(/\/?index$/, "");
+    return normalizePathname(`/${cleanedRoute}`);
+  }
+  classifyRouteKind(filePath) {
+    if (filePath.includes("[...")) {
+      return "catch-all";
+    }
+    if (filePath.includes("[") && filePath.includes("]")) {
+      return "dynamic";
+    }
+    return "exact";
+  }
+  getParamNames(routePathname) {
+    const matches = routePathname.match(/\[(?:\.\.\.)?([^\]]+)\]/g);
+    return matches ? matches.map((match) => match.replace(/^\[(?:\.\.\.)?/, "").replace(/\]$/, "")) : [];
+  }
+  tryExtractParams(route, requestedPathname) {
+    const routeParts = route.pathname.split("/");
+    const pathnameParts = requestedPathname.split("/");
+    if (route.kind === "dynamic" && routeParts.length !== pathnameParts.length) {
+      return null;
+    }
+    const params = {};
+    for (let i = 0; i < routeParts.length; i++) {
+      const routePart = routeParts[i];
+      const pathnamePart = pathnameParts[i];
+      if (!routePart) {
+        continue;
+      }
+      if (routePart.startsWith("[...") && routePart.endsWith("]")) {
+        const paramName = routePart.slice(4, -1);
+        params[paramName] = pathnameParts.slice(i).filter(Boolean);
+        return params;
+      }
+      if (routePart.startsWith("[") && routePart.endsWith("]")) {
+        if (pathnamePart === void 0) {
+          return null;
+        }
+        params[routePart.slice(1, -1)] = pathnamePart;
+        continue;
+      }
+      if (routePart !== pathnamePart) {
+        return null;
+      }
+    }
+    if (route.kind === "catch-all") {
+      const cleanPathname = route.pathname.replace(/\[.*?\]/g, "");
+      return requestedPathname.includes(cleanPathname) ? params : null;
+    }
+    return params;
+  }
+  getSearchParams(url) {
+    const query = {};
+    for (const [key, value] of url.searchParams) {
+      query[key] = value;
+    }
+    return query;
+  }
+  resolveTemplatePath(pathname, params) {
+    let resolvedPath = pathname;
+    for (const [key, value] of Object.entries(params)) {
+      const serializedValue = Array.isArray(value) ? value.join("/") : value;
+      resolvedPath = resolvedPath.replace(`[...${key}]`, serializedValue);
+      resolvedPath = resolvedPath.replace(`[${key}]`, serializedValue);
+    }
+    return normalizePathname(resolvedPath);
+  }
+}
+function normalizePathname(pathname) {
+  if (!pathname || pathname === "/") {
+    return "/";
+  }
+  const normalized = pathname.startsWith("/") ? pathname : `/${pathname}`;
+  return normalized.endsWith("/") ? normalized.slice(0, -1) : normalized;
+}
+export {
+  RouteRegistry
+};

package/src/services/README.md

@@ -0,0 +1,28 @@
+# Core Services
+
+This directory contains the app-owned service layer used by runtime startup, rendering, asset processing, browser bundling, and development invalidation.
+
+## Purpose
+
+Services in this directory exist to keep cross-cutting framework logic out of adapters, integrations, and processors.
+
+Typical responsibilities include:
+
+- server-module loading and transpilation
+- browser bundle coordination
+- asset processing and runtime asset declaration helpers
+- server invalidation state and entrypoint dependency graphs
+- HTML finalization and dependency injection
+
+## Main Areas
+
+- `module-loading/`: framework-owned config/app bootstrap loading and server-side source loading
+- `assets/`: shared browser build coordination and processed asset pipelines
+- `invalidation/`: file-change classification and invalidation policy
+- `runtime-state/`: app-owned invalidation state and dependency graphs
+- `runtime-manifest/`: node runtime manifest derivation and persistence
+- `html/`: final HTML dependency injection and rewriter selection
+
+## Design Rule
+
+If a concern affects more than one integration or more than one runtime adapter, it usually belongs here instead of in a package-specific implementation.

package/src/services/assets/asset-processing-service/asset-dependency-keys.d.ts

@@ -0,0 +1,3 @@
+import type { AssetDefinition } from './assets.types.js';
+export declare function getAssetDependencyKey(dep: AssetDefinition): string;
+export declare function deduplicateAssetDependencies(deps: AssetDefinition[]): AssetDefinition[];

package/src/services/assets/asset-processing-service/asset-dependency-keys.js

@@ -0,0 +1,56 @@
+import { rapidhash } from "../../../utils/hash.js";
+function generateHash(content) {
+  return rapidhash(content).toString();
+}
+function getScriptDependencyBuildSignature(dep) {
+  if (dep.kind !== "script") {
+    return void 0;
+  }
+  const pluginNames = dep.bundleOptions?.plugins?.map((plugin) => plugin.name) ?? [];
+  const signature = {
+    bundle: dep.bundle,
+    inline: dep.inline,
+    excludeFromHtml: dep.excludeFromHtml,
+    groupedBundle: dep.groupedBundle,
+    naming: dep.bundleOptions?.naming,
+    external: dep.bundleOptions?.external,
+    minify: dep.bundleOptions?.minify,
+    plugins: pluginNames
+  };
+  return generateHash(JSON.stringify(signature));
+}
+function getAssetDependencyKey(dep) {
+  const parts = [dep.kind, dep.source];
+  if ("filepath" in dep) {
+    parts.push(dep.filepath);
+  } else if ("content" in dep) {
+    parts.push(`content:${generateHash(dep.content)}`);
+  } else if ("importPath" in dep) {
+    parts.push(dep.importPath);
+  }
+  if ("position" in dep && dep.position) {
+    parts.push(dep.position);
+  }
+  if ("packageRole" in dep && dep.packageRole) {
+    parts.push(`package:${dep.packageRole}`);
+  }
+  const scriptBuildSignature = getScriptDependencyBuildSignature(dep);
+  if (scriptBuildSignature) {
+    parts.push(`build:${scriptBuildSignature}`);
+  }
+  return parts.join(":");
+}
+function deduplicateAssetDependencies(deps) {
+  const seen = /* @__PURE__ */ new Map();
+  for (const dep of deps) {
+    const key = getAssetDependencyKey(dep);
+    if (!seen.has(key)) {
+      seen.set(key, dep);
+    }
+  }
+  return Array.from(seen.values());
+}
+export {
+  deduplicateAssetDependencies,
+  getAssetDependencyKey
+};