@antelopejs/dms-frontend 0.9.3 → 0.10.1

package/templates/vue/sfc-global-types.mjs

@@ -1,6 +1,7 @@
 import { readFileSync, renameSync, writeFileSync } from "node:fs";
 import { createRequire } from "node:module";
 import { pathToFileURL } from "node:url";
+import { isFunction, isObjectLike, isString } from "./server/type-guards.mjs";
 
 /**
  * The very unimport the auto-import plugin scans with, so both read the
@@ -12,14 +13,83 @@ const unimportUrl = pathToFileURL(
     createRequire(import.meta.url).resolve("unplugin-auto-import/package.json"),
   ).resolve("unimport"),
 );
-const { builtinPresets, resolvePreset, scanDirExports } = await import(
-  unimportUrl.href
-);
+/** @type {unknown} */
+const unimport = await import(unimportUrl.href);
+
+/**
+ * An export of unimport, which this package does not depend on and so has no
+ * types for.
+ *
+ * @param {string} name
+ * @returns {unknown}
+ */
+function unimportExport(name) {
+  return isObjectLike(unimport) ? unimport[name] : undefined;
+}
+
+/**
+ * The function unimport exports as `name`.
+ *
+ * @param {string} name
+ * @returns {Function}
+ */
+function unimportFunction(name) {
+  const exported = unimportExport(name);
+  if (!isFunction(exported))
+    throw new Error(`unimport exports no function ${name}`);
+  return exported;
+}
+
+/**
+ * A name unimport scanned or resolved: where it comes from, what it is called
+ * and whether it is only a type.
+ *
+ * @typedef {object} ImportedName
+ * @property {string} name
+ * @property {string} from
+ * @property {string} [as]
+ */
+
+/**
+ * @param {unknown} entry
+ * @returns {entry is ImportedName}
+ */
+function isImportedName(entry) {
+  return (
+    isObjectLike(entry) &&
+    isString(entry.name) &&
+    isString(entry.from) &&
+    (entry.as === undefined || isString(entry.as))
+  );
+}
+
+/**
+ * The names of type declarations among `entries`, as unimport lists them.
+ *
+ * @param {unknown} entries
+ * @returns {ImportedName[]}
+ */
+function typeNames(entries) {
+  if (!Array.isArray(entries)) throw new Error("unimport listed no names");
+  /** @type {unknown[]} */
+  const listed = entries;
+  /** @type {ImportedName[]} */
+  const names = [];
+  for (const entry of listed) {
+    if (!isObjectLike(entry)) throw new Error("unimport listed a non-name");
+    if (!entry.type) continue;
+    if (!isImportedName(entry))
+      throw new Error("unimport listed a type without a name and a source");
+    names.push(entry);
+  }
+  return names;
+}
 
 const HEADER =
   "// Generated by @antelopejs/dms-frontend from the auto-imported types, for\n" +
   "// Vue's SFC compiler (script.globalTypeFiles). Not read by TypeScript.\n";
 
+/** @param {string} path */
 const withoutExtension = (path) => path.replace(/\.[cm]?[jt]sx?$/, "");
 
 /**
@@ -45,13 +115,22 @@ const withoutExtension = (path) => path.replace(/\.[cm]?[jt]sx?$/, "");
  * @param {(string | { glob: string, types?: boolean })[]} dirs the auto-import
  *   directories, as handed to the auto-import plugin
  * @param {string} cwd the workspace
+ * @returns {Promise<string>}
  */
 export async function sfcGlobalTypes(dirs, cwd) {
-  const vue = await resolvePreset(builtinPresets.vue);
-  const scanned = await scanDirExports(dirs, { cwd, types: true });
+  const presets = unimportExport("builtinPresets");
+  /** @type {unknown} */
+  const vue = await unimportFunction("resolvePreset")(
+    isObjectLike(presets) ? presets.vue : undefined,
+  );
+  /** @type {unknown} */
+  const scanned = await unimportFunction("scanDirExports")(dirs, {
+    cwd,
+    types: true,
+  });
+  /** @type {Map<string, string>} */
   const aliases = new Map();
-  for (const entry of [...vue, ...scanned]) {
-    if (!entry.type) continue;
+  for (const entry of [...typeNames(vue), ...typeNames(scanned)]) {
     const name = entry.as ?? entry.name;
     const source = JSON.stringify(withoutExtension(entry.from));
     aliases.set(
@@ -66,8 +145,13 @@ export async function sfcGlobalTypes(dirs, cwd) {
  * Written through a temporary file: a build starting meanwhile reads the
  * previous declarations or the new ones, never a half-written file the
  * compiler would then keep in its cache.
+ *
+ * @param {string} file
+ * @param {string} content
+ * @returns {boolean}
  */
 function writeIfChanged(file, content) {
+  /** @type {string | undefined} */
   let current;
   try {
     current = readFileSync(file, "utf8");
@@ -81,7 +165,14 @@ function writeIfChanged(file, content) {
   return true;
 }
 
-/** Writes the declarations once, before Vite's config is returned. */
+/**
+ * Writes the declarations once, before Vite's config is returned.
+ *
+ * @param {(string | { glob: string, types?: boolean })[]} dirs
+ * @param {string} cwd
+ * @param {string} file
+ * @returns {Promise<void>}
+ */
 export async function writeSfcGlobalTypes(dirs, cwd, file) {
   writeIfChanged(file, await sfcGlobalTypes(dirs, cwd));
 }
@@ -94,24 +185,32 @@ export async function writeSfcGlobalTypes(dirs, cwd, file) {
  * The file is under the workspace, which Vite watches: rewriting it is the
  * change the Vue plugin reloads the dependent components on. A failed scan or
  * write keeps the previous declarations, since it must not end the dev server.
+ *
+ * @param {(string | { glob: string, types?: boolean })[]} dirs
+ * @param {string} cwd
+ * @param {string} file
+ * @returns {import("vite").Plugin}
  */
 export function sfcGlobalTypesWatcher(dirs, cwd, file) {
   return {
     name: "dms-sfc-global-types",
     apply: "serve",
     configureServer(server) {
+      /** @type {ReturnType<typeof setTimeout> | undefined} */
       let pending;
+      /** @param {string} path */
       const refresh = (path) => {
         if (!/\.[cm]?[jt]sx?$/.test(path) || path === file) return;
         clearTimeout(pending);
         pending = setTimeout(() => {
           sfcGlobalTypes(dirs, cwd)
             .then((content) => writeIfChanged(file, content))
-            .catch((error) =>
-              server.config.logger.warn(
-                `Could not update ${file}, the types Vue's SFC compiler ` +
-                  `reads: ${error instanceof Error ? error.message : error}`,
-              ),
+            .catch(
+              /** @param {unknown} error */ (error) =>
+                server.config.logger.warn(
+                  `Could not update ${file}, the types Vue's SFC compiler ` +
+                    `reads: ${error instanceof Error ? error.message : String(error)}`,
+                ),
             );
         }, 100);
       };

package/templates/vue/ssr-renderer.ts

@@ -7,7 +7,6 @@ import { createSSRApp, h, readonly } from "vue";
 import { appConfigs } from "./app-configs.generated";
 import {
   DMS_PAYLOAD_ID,
-  type DmsServerFetch,
   SSR_ASYNC_COMPONENTS_ID,
   configureDmsApp,
   resolveDmsInertiaPage,
@@ -19,6 +18,7 @@ import {
   type DmsInertiaPage,
   type DmsPageProps,
   type DmsPayload,
+  type DmsServerFetch,
   createDmsFrontendRuntime,
   hasDmsPage,
   pageErrorData,
@@ -166,7 +166,7 @@ export async function renderDmsPage(
   requestCookies?: string,
 ): Promise<DmsSsrResult> {
   const runtime = createDmsFrontendRuntime(
-    serverFetch as typeof import("ofetch").ofetch,
+    serverFetch,
     {},
     true,
     requestCookies,

package/templates/vue/ui-inertia-page.mjs

@@ -6,6 +6,20 @@ const DMS_PAGE_IMPORT =
 const ANY_INERTIA_PAGE_IMPORT =
   /import\s*\{[^}]*\busePage\b[^}]*\}\s*from\s*["']@inertiajs\/vue3["']|import\s*\*\s*as\s+\w+\s+from\s*["']@inertiajs\/vue3["']/;
 
+/**
+ * A Vite plugin that rewrites the source of Nuxt UI files.
+ *
+ * @typedef {{
+ *   name: string,
+ *   enforce: "pre",
+ *   transform: (
+ *     this: Pick<import("vite").Rollup.TransformPluginContext, "error">,
+ *     code: string,
+ *     id: string,
+ *   ) => { code: string, map: null } | null,
+ * }} NuxtUiRewrite
+ */
+
 /**
  * The rewrite, as a Vite plugin.
  *
@@ -16,7 +30,8 @@ const ANY_INERTIA_PAGE_IMPORT =
  * a form this rewrite does not know, rather than letting the leak come back
  * unnoticed with a Nuxt UI release.
  *
- * @param isNuxtUiFile `(id) => boolean`, whether a module is Nuxt UI's
+ * @param {(id: string) => boolean} isNuxtUiFile whether a module is Nuxt UI's
+ * @returns {NuxtUiRewrite}
  */
 export function uiInertiaPage(isNuxtUiFile) {
   return {

package/templates/vue/ui-kbd.mjs

@@ -21,7 +21,8 @@ const ROUTED_EXPORT =
  * changes the form rewritten here, rather than letting the mismatch come back
  * unnoticed.
  *
- * @param isNuxtUiFile `(id) => boolean`, whether a module is Nuxt UI's
+ * @param {(id: string) => boolean} isNuxtUiFile whether a module is Nuxt UI's
+ * @returns {import("./ui-inertia-page.mjs").NuxtUiRewrite}
  */
 export function uiKbd(isNuxtUiFile) {
   return {

package/templates/vue/ui-request-state.mjs

@@ -21,7 +21,8 @@ const APPLICATION_STATE =
  * UI file defines `useState`, rather than letting the leak come back unnoticed
  * with a Nuxt UI release.
  *
- * @param isNuxtUiFile `(id) => boolean`, whether a module is Nuxt UI's
+ * @param {(id: string) => boolean} isNuxtUiFile whether a module is Nuxt UI's
+ * @returns {import("./ui-inertia-page.mjs").NuxtUiRewrite}
  */
 export function uiRequestState(isNuxtUiFile) {
   return {

package/templates/vue/vite.config.ts

@@ -11,6 +11,7 @@ import {
 } from "vite";
 import { clientCodeSplitting, onBuildLog } from "./client-chunking.mjs";
 import { recordEntryWeight } from "./entry-weight.mjs";
+import { rejectBackendSources } from "./backend-boundary.mjs";
 import { rejectServerSourcesInClient } from "./client-server-guard.mjs";
 import { uiInertiaPage } from "./ui-inertia-page.mjs";
 import { uiKbd } from "./ui-kbd.mjs";
@@ -29,6 +30,7 @@ interface FrontendModuleRegistryEntry {
   id: string;
   name?: string;
   packageName?: string;
+  backendPackage?: string;
   root: string;
   priority: number;
 }
@@ -45,6 +47,9 @@ const registry = JSON.parse(
   readFileSync(registryPath, "utf8"),
 ) as FrontendModuleRegistry;
 const moduleRoots = registry.modules.map((module) => module.root);
+const backendPackages = registry.modules.flatMap((module) =>
+  module.backendPackage === undefined ? [] : [module.backendPackage],
+);
 const frontendSourceRoots = moduleRoots.flatMap((root) => {
   const layersRoot = resolve(root, "layers");
   if (!existsSync(layersRoot)) return [root];
@@ -175,6 +180,9 @@ export default defineConfig({
     // Fails a client build that imports a dms.server.ts or a file under a
     // module's server/ directory, however it is imported.
     rejectServerSourcesInClient(moduleRoots),
+    // Fails a build, a worker build or a dev request that resolves a file
+    // under the src of the package that ships a module.
+    rejectBackendSources(backendPackages),
     // What each module adds to the client entry, which `ajs dms build` reports.
     recordEntryWeight(registry.modules),
     {
@@ -267,6 +275,7 @@ export default defineConfig({
     paintBeforeHydrate(),
     ...vitePlugins(registry.modules, frontendBuilds),
   ],
+  worker: { plugins: () => vitePlugins(registry.modules, frontendBuilds) },
   resolve: {
     // `@iconify/vue` keeps its API providers in module state: `main.ts` and
     // Nuxt UI's `Icon` must share one copy for the same-origin provider to apply.