@bonsae/nrg 0.6.0 → 0.6.2

package/src/vite/server/plugins/type-generator.ts

@@ -1,285 +0,0 @@
-import type { Plugin } from "vite";
-import dts from "vite-plugin-dts";
-import fs from "fs";
-import path from "path";
-import ts from "typescript";
-
-/**
- * Recursively collect all .ts files under a directory, excluding .d.ts files.
- */
-function collectTsFiles(dir: string): string[] {
-  if (!fs.existsSync(dir)) return [];
-  return fs.readdirSync(dir, { withFileTypes: true }).flatMap((dirent) => {
-    const full = path.join(dir, dirent.name);
-    if (dirent.isDirectory()) return collectTsFiles(full);
-    if (
-      dirent.isFile() &&
-      dirent.name.endsWith(".ts") &&
-      !dirent.name.endsWith(".d.ts")
-    )
-      return [full];
-    return [];
-  });
-}
-
-/**
- * Convert a file basename (without extension) to PascalCase.
- * E.g. "your-node" → "YourNode", "remote_server" → "RemoteServer"
- */
-function toPascalCase(name: string): string {
-  return name
-    .split(/[-_]/)
-    .map((part) => part.charAt(0).toUpperCase() + part.slice(1))
-    .join("");
-}
-
-/**
- * Positional semantic names for each framework base class.
- * Position i in the generic corresponds to the i-th semantic slot.
- * Users can name their types anything — the position determines meaning.
- */
-const BASE_CLASS_SLOTS: Record<string, string[]> = {
-  IONode: ["Config", "Credentials", "Input", "Output", "Settings"],
-  ConfigNode: ["Config", "Credentials", "Settings"],
-};
-
-/**
- * Parse a node source file and return `{ localName, semanticName }` pairs for
- * types that should be exported from the package.
- *
- * The semantic name is derived from the generic POSITION in the base class, so
- * a user can name their types anything:
- *
- *   export default class MyNode extends IONode<Bananas, MyCreds, …>
- *   export type Bananas = { … }   → exported as {Ns}Config  (position 0)
- *   export type MyCreds = { … }   → exported as {Ns}Credentials (position 1)
- *
- * Only types that appear as generic args AND are exported from the file are
- * included, so unrelated helper types are never leaked.
- */
-function getNodeTypeExports(
-  filePath: string,
-): Array<{ localName: string; semanticName: string }> {
-  const content = fs.readFileSync(filePath, "utf-8");
-  const source = ts.createSourceFile(
-    filePath,
-    content,
-    ts.ScriptTarget.ESNext,
-    /* setParentNodes */ true,
-  );
-
-  const hasModifier = (node: ts.HasModifiers, kind: ts.SyntaxKind) =>
-    (node.modifiers ?? []).some((m) => m.kind === kind);
-
-  // Collect names of exported type aliases and interfaces.
-  const exportedTypeNames = new Set<string>();
-  for (const stmt of source.statements) {
-    if (
-      ts.isTypeAliasDeclaration(stmt) &&
-      hasModifier(stmt, ts.SyntaxKind.ExportKeyword)
-    ) {
-      exportedTypeNames.add(stmt.name.text);
-    }
-    if (
-      ts.isInterfaceDeclaration(stmt) &&
-      hasModifier(stmt, ts.SyntaxKind.ExportKeyword)
-    ) {
-      exportedTypeNames.add(stmt.name.text);
-    }
-  }
-
-  if (exportedTypeNames.size === 0) return [];
-
-  // Find `export default class … extends BaseClass<T0, T1, …>` and extract
-  // the base class name and its generic type argument names by position.
-  let baseClassName = "";
-  const genericArgNames: string[] = [];
-
-  for (const stmt of source.statements) {
-    if (
-      !ts.isClassDeclaration(stmt) ||
-      !hasModifier(stmt, ts.SyntaxKind.DefaultKeyword)
-    ) {
-      continue;
-    }
-    for (const clause of stmt.heritageClauses ?? []) {
-      if (clause.token !== ts.SyntaxKind.ExtendsKeyword) continue;
-      for (const type of clause.types) {
-        if (ts.isIdentifier(type.expression)) {
-          baseClassName = type.expression.text;
-        }
-        for (const arg of type.typeArguments ?? []) {
-          if (ts.isTypeReferenceNode(arg) && ts.isIdentifier(arg.typeName)) {
-            genericArgNames.push(arg.typeName.text);
-          } else {
-            // Unknown / complex type arg — push empty string to preserve positions.
-            genericArgNames.push("");
-          }
-        }
-      }
-    }
-    break;
-  }
-
-  const slots = BASE_CLASS_SLOTS[baseClassName];
-  if (!slots) return [];
-
-  // Build pairs: for each position, if the arg is exported AND we have a
-  // semantic name for that slot, include it.
-  const result: Array<{ localName: string; semanticName: string }> = [];
-  for (let i = 0; i < genericArgNames.length; i++) {
-    const localName = genericArgNames[i];
-    const semanticName = slots[i];
-    if (localName && semanticName && exportedTypeNames.has(localName)) {
-      result.push({ localName, semanticName });
-    }
-  }
-  return result;
-}
-
-/**
- * Build re-export statements for every file in {srcDir}/nodes/, relative to
- * the given entry file path.
- *
- * Per node file two kinds of statements are generated:
- *
- *   // 1. Class re-export — so api-extractor includes the class declaration
- *   //    in the bundled .d.ts, enabling `import { YourNode }`, `instanceof`,
- *   //    type assertions `as YourNode`, and `resolveTypedInput<YourNode>()`.
- *   export { default as YourNode } from "./nodes/your-node";
- *
- *   // 2. Type-only exports — one per exported type alias/interface, prefixed
- *   //    with the namespace name to avoid collisions across node files.
- *   //    Enables `import type { YourNodeConfig, YourNodeCredentials }`.
- *   export type { Config as YourNodeConfig, Credentials as YourNodeCredentials,
- *                 Input as YourNodeInput, Output as YourNodeOutput,
- *                 Settings as YourNodeSettings } from "./nodes/your-node";
- *
- * These statements are appended in memory to the entry file content served to
- * the TypeScript compiler via a `ts.sys.readFile` patch, so api-extractor
- * includes them in the final bundled `.d.ts` without touching any source file.
- * Runtime class values are exposed by `cjsDefaultExportPlugin` dynamically
- * via the `nodes` array on the package function.
- */
-function buildNodeReexports(srcDir: string, entryFile: string): string {
-  const nodesDir = path.join(srcDir, "nodes");
-  const nodeFiles = collectTsFiles(nodesDir);
-  return nodeFiles
-    .map((file) => {
-      const rel = path
-        .relative(path.dirname(entryFile), file)
-        .replace(/\\/g, "/");
-      const relPath = rel.startsWith(".") ? rel : `./${rel}`;
-      const specifier = relPath.replace(/\.ts$/, "");
-      const ns = toPascalCase(path.basename(file, ".ts"));
-
-      const lines = [`export { default as ${ns} } from "${specifier}";`];
-
-      const typePairs = getNodeTypeExports(file);
-      if (typePairs.length > 0) {
-        const prefixed = typePairs
-          .map(
-            ({ localName, semanticName }) =>
-              `${localName} as ${ns}${semanticName}`,
-          )
-          .join(", ");
-        lines.push(`export type { ${prefixed} } from "${specifier}";`);
-      }
-
-      return lines.join("\n");
-    })
-    .join("\n");
-}
-
-function typeGenerator(options: {
-  srcDir: string;
-  outDir: string;
-  /** Absolute paths of entry files (values from the entryPoints record). */
-  entryFiles: string[];
-}): Plugin[] {
-  const { srcDir, outDir, entryFiles } = options;
-
-  // Prefer the server-specific tsconfig (inside srcDir) over the root one.
-  // The root tsconfig typically only includes vite.config.ts, while the server
-  // tsconfig includes the actual source files needed for declaration emit.
-  const serverTsconfig = path.resolve(srcDir, "tsconfig.json");
-  const rootTsconfig = path.resolve("tsconfig.json");
-  const userTsconfig = fs.existsSync(serverTsconfig)
-    ? serverTsconfig
-    : rootTsconfig;
-  // Exclude the user's client dir (sibling of srcDir), any nested client dirs,
-  // and the vite/ build-tooling dir — none of these should appear in the
-  // published type declarations.
-  const clientDir = path.relative(
-    process.cwd(),
-    path.join(path.dirname(srcDir), "client"),
-  );
-
-  // Absolute resolved path → augmented source content (in-memory only).
-  const augmentedContents = new Map<string, string>();
-  // Original ts.sys.readFile — restored in closeBundle.
-  let origReadFile: typeof ts.sys.readFile | null = null;
-
-  const nodeTypeExporter: Plugin = {
-    name: "vite-plugin-node-red:server:type-exporter",
-    enforce: "pre",
-    buildStart() {
-      augmentedContents.clear();
-      for (const entryFile of entryFiles) {
-        const reexports = buildNodeReexports(srcDir, entryFile);
-        if (!reexports) continue;
-        const original = fs.readFileSync(entryFile, "utf-8");
-        augmentedContents.set(
-          path.resolve(entryFile),
-          `${original}\n${reexports}\n`,
-        );
-      }
-      if (augmentedContents.size === 0) return;
-      origReadFile = ts.sys.readFile.bind(ts.sys);
-      ts.sys.readFile = (fileName, encoding) => {
-        const resolved = path.resolve(fileName);
-        return (
-          augmentedContents.get(resolved) ?? origReadFile!(fileName, encoding)
-        );
-      };
-    },
-    closeBundle() {
-      if (origReadFile) {
-        ts.sys.readFile = origReadFile;
-        origReadFile = null;
-      }
-      augmentedContents.clear();
-    },
-  };
-
-  return [
-    nodeTypeExporter,
-    dts({
-      rollupTypes: true,
-      rollupOptions: {
-        messageCallback(message) {
-          if (message.messageId === "console-preamble") {
-            message.logLevel = "none";
-          }
-        },
-      },
-      outDir,
-      ...(fs.existsSync(userTsconfig) && { tsconfigPath: userTsconfig }),
-      compilerOptions: {
-        noEmit: false,
-        declaration: true,
-        emitDeclarationOnly: true,
-        noCheck: true,
-      },
-      exclude: [
-        `${clientDir}/**`,
-        "**/client/**",
-        "vite/**",
-        "node_modules/**",
-        "dist/**",
-      ],
-    }),
-  ].flat();
-}
-
-export { typeGenerator };

package/src/vite/types.ts

@@ -1,174 +0,0 @@
-import type { Plugin } from "vite";
-import type { NodeRedLauncher } from "./node-red-launcher";
-
-interface BuildContext {
-  outDir: string;
-  packageName: string;
-  isDev: boolean;
-}
-
-interface BuildPluginOptions {
-  serverBuildOptions: ServerBuildOptions;
-  clientBuildOptions: ClientBuildOptions;
-  extraFilesCopyTargets: CopyTarget[];
-  buildContext: BuildContext;
-}
-
-interface ClientBuildOptions {
-  /** Source directory for client code. @default "./src/client" */
-  srcDir?: string;
-  /** Entry filename relative to srcDir. @default "index.ts" */
-  entry?: string;
-  /** Subdirectory name for node definition files. @default "nodes" */
-  nodesSubdir?: string;
-  /** Pattern to match node definition files. */
-  nodeFilePattern?: RegExp;
-  /** Global variable name for the UMD/IIFE bundle. @default "NodeRedNodes" */
-  name?: string;
-  /** Output format for the client bundle. @default "es" */
-  format?: "es" | "iife" | "umd";
-  /** Base public path for serving resources. */
-  base?: string;
-  /** Path to LICENSE file to include in the HTML output. @default "./LICENSE" */
-  licensePath?: string;
-  /** Internationalization options for labels and docs. */
-  locales?: LocalesOptions;
-  /** Directories for static assets (icons, public files). */
-  staticDirs?: {
-    /** Directory containing node icons ({type}.png). @default "./src/icons" */
-    icons?: string;
-    /** Directory for public static files copied to dist/resources/. @default "./src/client/public" */
-    public?: string;
-  };
-  /** Modules to treat as external (not bundled). @default ["jquery", "node-red", "vue", "@bonsae/nrg/client"] */
-  external?: string[];
-  /** Global variable mappings for external modules. */
-  globals?: Record<string, string>;
-  /** Custom chunk splitting function for Rollup. */
-  manualChunks?: (id: string) => string | undefined;
-  /** Additional Vite plugins for the client build. */
-  plugins: Plugin[];
-}
-
-interface CopyTarget {
-  /** Source file or directory path. */
-  src: string;
-  /** Destination path relative to the output directory. */
-  dest: string;
-}
-
-interface LocalesOptions {
-  /** Directory containing documentation files ({type}/{lang}.md or .html). @default "./src/locales/docs" */
-  docsDir?: string;
-  /** Directory containing label files ({type}/{lang}.json). @default "./src/locales/labels" */
-  labelsDir?: string;
-  /** Supported languages. @default ["en-US", "de", "es-ES", "fr", "ko", "pt-BR", "ru", "ja", "zh-CN", "zh-TW"] */
-  languages?: string[];
-}
-
-interface LoggerOptions {
-  name: string;
-  prefix?: string;
-}
-
-interface NodeRedLauncherOptions {
-  runtime?: {
-    /** Port for Node-RED to listen on. @default 1880 */
-    port?: number;
-    /** Path to the Node-RED settings file (TypeScript supported). @default "./node-red.settings.ts" */
-    settingsFilepath?: string;
-    /** Node-RED version to install for the dev server. @default "latest" */
-    version?: string;
-  };
-  /** Delay in ms before restarting Node-RED after a file change. @default 1000 */
-  restartDelay?: number;
-  /** Additional CLI arguments passed to the Node-RED process. */
-  args?: string[];
-}
-
-/**
- * Options for the `nodeRed()` Vite plugin.
- *
- * All options are optional — defaults work for the standard `src/` directory layout.
- */
-interface NodeRedPluginOptions {
-  /** Output directory for the built Node-RED package. @default "./dist" */
-  outDir?: string;
-  /** Options for building the client-side editor UI. */
-  clientBuildOptions?: ClientBuildOptions;
-  /** Options for building the server-side node runtime. */
-  serverBuildOptions?: ServerBuildOptions;
-  /** Options for the Node-RED dev server launcher. */
-  nodeRedLauncherOptions?: NodeRedLauncherOptions;
-  /** Extra files to copy into the output directory (e.g., LICENSE, README). */
-  extraFilesCopyTargets?: CopyTarget[];
-}
-
-interface PackageJson {
-  name: string;
-  version: string;
-  description?: string;
-  type?: "commonjs" | "module";
-  main?: string;
-  types?: string;
-  exports?: Record<string, unknown>;
-  scripts?: Record<string, string>;
-  dependencies?: Record<string, string>;
-  devDependencies?: Record<string, string>;
-  peerDependencies?: Record<string, string>;
-  optionalDependencies?: Record<string, string>;
-  keywords?: string[];
-  author?: string | { name: string; email?: string; url?: string };
-  license?: string;
-  repository?: string | { type: string; url: string };
-  bugs?: string | { url: string; email?: string };
-  homepage?: string;
-  engines?: Record<string, string>;
-  files?: string[];
-  private?: boolean;
-  publishConfig?: Record<string, unknown>;
-  "node-red"?: {
-    nodes?: Record<string, string>;
-    version?: string;
-  };
-  [key: string]: unknown;
-}
-
-interface ServerBuildOptions {
-  /** Source directory for server code. @default "./src/server" */
-  srcDir?: string;
-  /** Entry filename relative to srcDir. @default "index.ts" */
-  entry?: string;
-  /** Output format. "esm" builds to .mjs with a CJS bridge for Node-RED. @default "esm" */
-  format?: "cjs" | "esm";
-  /** Dependencies to bundle into the output instead of keeping as external. @default [] */
-  bundled?: string[];
-  /** Generate rolled-up .d.ts type declarations (production only). @default true */
-  types?: boolean;
-  /** esbuild target for the server bundle. @default "node22" */
-  nodeTarget?: string;
-  /** Additional Vite plugins for the server build. */
-  plugins: Plugin[];
-}
-
-interface ServerPluginOptions {
-  nodeRedLauncher: NodeRedLauncher;
-  serverBuildOptions: ServerBuildOptions;
-  clientBuildOptions: ClientBuildOptions;
-  extraFilesCopyTargets: CopyTarget[];
-  buildContext: BuildContext;
-}
-
-export {
-  BuildContext,
-  BuildPluginOptions,
-  ClientBuildOptions,
-  CopyTarget,
-  LocalesOptions,
-  LoggerOptions,
-  NodeRedLauncherOptions,
-  NodeRedPluginOptions,
-  PackageJson,
-  ServerBuildOptions,
-  ServerPluginOptions,
-};

package/src/vite/utils.ts

@@ -1,72 +0,0 @@
-import fs from "fs";
-import path from "path";
-import type { PackageJson } from "./types";
-
-function cleanDir(dir: string) {
-  if (fs.existsSync(dir)) {
-    fs.rmSync(dir, { recursive: true });
-  }
-  fs.mkdirSync(dir, { recursive: true });
-}
-
-function copyFiles(targets: CopyTarget[], outDir: string): void {
-  for (const { src, dest } of targets) {
-    const srcPath = path.resolve(src);
-    const destPath = path.join(outDir, dest);
-
-    if (!fs.existsSync(srcPath)) {
-      continue;
-    }
-
-    const stat = fs.statSync(srcPath);
-
-    if (stat.isDirectory()) {
-      fs.cpSync(srcPath, destPath, { recursive: true });
-    } else {
-      fs.mkdirSync(path.dirname(destPath), { recursive: true });
-      fs.copyFileSync(srcPath, destPath);
-    }
-  }
-}
-
-function getPackageName(): string {
-  const pkgPath = path.resolve("./package.json");
-  if (fs.existsSync(pkgPath)) {
-    const pkg = JSON.parse(fs.readFileSync(pkgPath, "utf-8")) as PackageJson;
-    return pkg.name;
-  }
-
-  return "node-red-nodes";
-}
-
-function mergeOptions<T extends Record<string, unknown>>(
-  defaults: T,
-  overrides?: Partial<T>,
-): T {
-  if (!overrides) return { ...defaults };
-
-  const result = { ...defaults };
-  for (const key of Object.keys(overrides) as (keyof T)[]) {
-    const overrideVal = overrides[key];
-    const defaultVal = defaults[key];
-    if (
-      overrideVal !== undefined &&
-      !Array.isArray(overrideVal) &&
-      !Array.isArray(defaultVal) &&
-      typeof overrideVal === "object" &&
-      typeof defaultVal === "object" &&
-      overrideVal !== null &&
-      defaultVal !== null
-    ) {
-      result[key] = mergeOptions(
-        defaultVal as Record<string, unknown>,
-        overrideVal as Record<string, unknown>,
-      ) as T[keyof T];
-    } else if (overrideVal !== undefined) {
-      result[key] = overrideVal as T[keyof T];
-    }
-  }
-  return result;
-}
-
-export { cleanDir, copyFiles, getPackageName, mergeOptions };