@bonsae/nrg 0.2.0 → 0.3.0

package/build/index.js

@@ -0,0 +1,7 @@
+// src/utils.ts
+function defineRuntimeSettings(settings) {
+  return settings;
+}
+export {
+  defineRuntimeSettings
+};

package/build/vite/index.js

@@ -111,9 +111,6 @@ function mergeOptions(defaults, overrides) {
   }
   return result;
 }
-function defineRuntimeSettings(settings) {
-  return settings;
-}
 
 // src/vite/node-red-launcher.ts
 import { spawn } from "child_process";
@@ -1917,6 +1914,5 @@ function nodeRed(options = {}) {
   ];
 }
 export {
-  defineRuntimeSettings,
   nodeRed
 };

package/build/vite/utils.js

@@ -48,13 +48,9 @@ function mergeOptions(defaults, overrides) {
   }
   return result;
 }
-function defineRuntimeSettings(settings) {
-  return settings;
-}
 export {
   cleanDir,
   copyFiles,
-  defineRuntimeSettings,
   getPackageName,
   mergeOptions
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bonsae/nrg",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "description": "NRG framework — build Node-RED nodes with Vue 3, TypeScript, and JSON Schema",
   "author": "Allan Oricil <allanoricil@duck.com>",
   "license": "MIT",
@@ -33,6 +33,10 @@
     "build/"
   ],
   "exports": {
+    ".": {
+      "types": "./src/index.ts",
+      "default": "./build/index.js"
+    },
     "./server": {
       "types": "./src/core/server/index.ts",
       "require": "./build/server/index.cjs",

package/src/index.ts

@@ -0,0 +1,2 @@
+export { defineRuntimeSettings } from "./utils";
+export type { NodeRedRuntimeSettings } from "./types";

package/src/types.ts

@@ -0,0 +1,189 @@
+import type { Http2ServerRequest } from "http2";
+
+export interface NodeRedRuntimeSettings {
+  userDir?: string;
+  nodesDir?: string | string[];
+  flowFile?: string;
+  flowFilePretty?: boolean;
+  credentialSecret?: string | false;
+  requireHttps?: boolean;
+  https?:
+    | { key: string; cert: string }
+    | (() =>
+        | Promise<{ key: string; cert: string }>
+        | { key: string; cert: string });
+  httpsRefreshInterval?: number;
+  httpAdminRoot?: string;
+  httpNodeRoot?: string;
+  httpNodeCors?: { origin: string; methods: string };
+  httpStatic?: string | { path: string; root: string }[];
+  httpStaticRoot?: string;
+  httpAdminMiddleware?: (req: unknown, res: unknown, next: () => void) => void;
+  httpNodeMiddleware?: (req: unknown, res: unknown, next: () => void) => void;
+  httpServerOptions?: Record<string, unknown>;
+  adminAuth?: {
+    type?: "credentials" | "strategy";
+    users?: {
+      username: string;
+      password: string;
+      permissions?: string | string[];
+    }[];
+    default?: {
+      permissions?: string | string[];
+    };
+    tokens?: (
+      token: string,
+    ) => Promise<{ user: string; permissions: string | string[] } | null>;
+    tokenHeader: "string";
+    sessionExpiryTime?: number;
+    [key: string]: unknown;
+  };
+  httpNodeAuth?: {
+    user?: string;
+    pass?: string;
+  };
+  httpStaticAuth?: {
+    user?: string;
+    pass?: string;
+  };
+  lang?:
+    | "en-US"
+    | "de"
+    | "es-ES"
+    | "fr"
+    | "ko"
+    | "pt-BR"
+    | "ru"
+    | "ja"
+    | "zh-CN"
+    | "zh-TW";
+  diagnostics?: {
+    enabled?: boolean;
+    ui?: boolean;
+  };
+  runtimeState?: {
+    enabled?: boolean;
+    ui?: boolean;
+  };
+  disableEditor?: boolean;
+  editorTheme?: {
+    page?: {
+      title?: string;
+      favicon?: string;
+      css?: string | string[];
+      scripts?: string | string[];
+    };
+    header?: {
+      title?: string;
+      image?: string;
+      url?: string;
+    };
+    deployButton?: {
+      type?: "simple" | "default";
+      label?: string;
+      icon?: string;
+    };
+    menu?: {
+      "menu-item-import-library"?: boolean;
+      "menu-item-export-library"?: boolean;
+      "menu-item-keyboard-shortcuts"?: boolean;
+      "menu-item-help"?: {
+        label?: string;
+        url?: string;
+      };
+      [menuItem: string]:
+        | boolean
+        | { label?: string; url?: string }
+        | undefined;
+    };
+    userMenu?: boolean;
+    login?: {
+      image?: string;
+    };
+    logout?: {
+      redirect?: string;
+    };
+    palette?: {
+      catalogues?: string[];
+      categories?: string[];
+      theme?: { category: string; type: string; color: string }[];
+    };
+    projects?: {
+      enabled?: boolean;
+      workflow?: {
+        mode: "manual" | "auto";
+      };
+    };
+    codeEditor?: {
+      lib?: "monaco" | "ace";
+      options?: Record<string, unknown>;
+    };
+    mermaid?: {
+      theme?: string;
+    };
+    tours?: boolean;
+    theme?: string;
+    [key: string]: unknown;
+  };
+  contextStorage?: {
+    default?: {
+      module?: "memory" | "localfilesystem" | object;
+      config?: Record<string, unknown>;
+    };
+    [store: string]:
+      | {
+          module?: "memory" | "localfilesystem" | object;
+          config?: Record<string, unknown>;
+        }
+      | undefined;
+  };
+  exportGlobalContextKeys?: boolean;
+  logging?: {
+    console?: {
+      level?: "fatal" | "error" | "warn" | "info" | "debug" | "trace" | "off";
+      metrics?: boolean;
+      audit?: boolean;
+    };
+  };
+  fileWorkingDirectory?: string;
+  functionExternalModules?: boolean;
+  functionGlobalContext?: Record<string, unknown>;
+  nodeMessageBufferMaxLength?: number;
+  functionTimeout?: number;
+  externalModules?: {
+    autoInstall?: boolean;
+    autoInstallRetry?: number;
+    palette?: {
+      allowInstall?: boolean;
+      allowUpdate?: boolean;
+      allowUpload?: boolean;
+      allowList?: string[];
+      denyList?: string[];
+      allowUpdateList?: string[];
+      denyUpdateList?: string[];
+    };
+    modules?: {
+      allowInstall?: boolean;
+      allowList?: string[];
+      denyList?: string[];
+    };
+  };
+  execMaxBufferSize?: number;
+  debugMaxLength?: number;
+  debugUseColors?: boolean;
+  httpRequestTimeout?: number;
+  mqttReconnectTime?: number;
+  serialReconnectTime?: number;
+  socketReconnectTime?: number;
+  socketTimeout?: number;
+  tcpMsgQueueSize?: number;
+  inboundWebSocketTimeout?: number;
+  tlsConfigDisableLocalFiles?: boolean;
+  webSocketNodeVerifyClient?: (info: {
+    origin: string;
+    req: Http2ServerRequest;
+    secure: boolean;
+  }) => boolean;
+  apiMaxLength?: string;
+  [key: string]: unknown;
+}

package/src/utils.ts

@@ -0,0 +1,20 @@
+import type { NodeRedRuntimeSettings } from "./types";
+
+/**
+ * Type-safe helper for defining Node-RED runtime settings.
+ *
+ * @example
+ * ```typescript
+ * import { defineRuntimeSettings } from "@bonsae/nrg";
+ *
+ * export default defineRuntimeSettings({
+ *   flowFile: "flows.json",
+ *   flowFilePretty: true,
+ * });
+ * ```
+ */
+export function defineRuntimeSettings(
+  settings: NodeRedRuntimeSettings,
+): NodeRedRuntimeSettings {
+  return settings;
+}

package/src/vite/index.ts

@@ -1,3 +1,2 @@
 export { nodeRed } from "./plugin";
-export { defineRuntimeSettings } from "./utils";
-export type { NodeRedPluginOptions, NodeRedRuntimeSettings } from "./types";
+export type { NodeRedPluginOptions } from "./types";

package/src/vite/types.ts

@@ -1,6 +1,5 @@
 import type { Plugin } from "vite";
 import type { NodeRedLauncher } from "./node-red-launcher";
-import type { Http2ServerRequest } from "http2";
 
 interface BuildContext {
   outDir: string;
@@ -105,199 +104,6 @@ interface NodeRedPluginOptions {
   extraFilesCopyTargets?: CopyTarget[];
 }
 
-interface NodeRedRuntimeSettings {
-  // NOTE: commented out because the preferred port must be set using NodeRedLauncherOptions.runtime.port
-  // uiPort?: number;
-  // NOTE: commented out because the plugin set it to 127.0.0.1
-  // uiHost?: string;
-  userDir?: string;
-  nodesDir?: string | string[];
-  flowFile?: string;
-  flowFilePretty?: boolean;
-  credentialSecret?: string | false;
-  requireHttps?: boolean;
-  https?:
-    | { key: string; cert: string }
-    | (() =>
-        | Promise<{ key: string; cert: string }>
-        | { key: string; cert: string });
-  httpsRefreshInterval?: number;
-  httpAdminRoot?: string;
-  httpNodeRoot?: string;
-  httpNodeCors?: { origin: string; methods: string };
-  httpStatic?: string | { path: string; root: string }[];
-  httpStaticRoot?: string;
-  httpAdminMiddleware?: (req: unknown, res: unknown, next: () => void) => void;
-  httpNodeMiddleware?: (req: unknown, res: unknown, next: () => void) => void;
-  httpServerOptions?: Record<string, unknown>;
-  adminAuth?: {
-    type?: "credentials" | "strategy";
-    users?: {
-      username: string;
-      password: string;
-      permissions?: string | string[];
-    }[];
-    default?: {
-      permissions?: string | string[];
-    };
-    tokens?: (
-      token: string,
-    ) => Promise<{ user: string; permissions: string | string[] } | null>;
-    tokenHeader: "string";
-    sessionExpiryTime?: number;
-    [key: string]: unknown;
-  };
-  httpNodeAuth?: {
-    user?: string;
-    pass?: string;
-  };
-  httpStaticAuth?: {
-    user?: string;
-    pass?: string;
-  };
-  lang?:
-    | "en-US"
-    | "de"
-    | "es-ES"
-    | "fr"
-    | "ko"
-    | "pt-BR"
-    | "ru"
-    | "ja"
-    | "zh-CN"
-    | "zh-TW";
-  diagnostics?: {
-    enabled?: boolean;
-    ui?: boolean;
-  };
-  runtimeState?: {
-    enabled?: boolean;
-    ui?: boolean;
-  };
-  disableEditor?: boolean;
-  editorTheme?: {
-    page?: {
-      title?: string;
-      favicon?: string;
-      css?: string | string[];
-      scripts?: string | string[];
-    };
-    header?: {
-      title?: string;
-      image?: string;
-      url?: string;
-    };
-    deployButton?: {
-      type?: "simple" | "default";
-      label?: string;
-      icon?: string;
-    };
-    menu?: {
-      "menu-item-import-library"?: boolean;
-      "menu-item-export-library"?: boolean;
-      "menu-item-keyboard-shortcuts"?: boolean;
-      "menu-item-help"?: {
-        label?: string;
-        url?: string;
-      };
-      [menuItem: string]:
-        | boolean
-        | { label?: string; url?: string }
-        | undefined;
-    };
-    userMenu?: boolean;
-    login?: {
-      image?: string;
-    };
-    logout?: {
-      redirect?: string;
-    };
-    palette?: {
-      catalogues?: string[];
-      categories?: string[];
-      theme?: { category: string; type: string; color: string }[];
-    };
-    projects?: {
-      enabled?: boolean;
-      workflow?: {
-        mode: "manual" | "auto";
-      };
-    };
-    codeEditor?: {
-      lib?: "monaco" | "ace";
-      // TODO: add monaco option types
-      options?: Record<string, unknown>;
-    };
-    mermaid?: {
-      theme?: string;
-    };
-    tours?: boolean;
-    theme?: string;
-    [key: string]: unknown;
-  };
-  contextStorage?: {
-    default?: {
-      module?: "memory" | "localfilesystem" | object;
-      config?: Record<string, unknown>;
-    };
-    [store: string]:
-      | {
-          module?: "memory" | "localfilesystem" | object;
-          config?: Record<string, unknown>;
-        }
-      | undefined;
-  };
-  exportGlobalContextKeys?: boolean;
-  logging?: {
-    console?: {
-      level?: "fatal" | "error" | "warn" | "info" | "debug" | "trace" | "off";
-      metrics?: boolean;
-      audit?: boolean;
-    };
-  };
-  fileWorkingDirectory?: string;
-  functionExternalModules?: boolean;
-  functionGlobalContext?: Record<string, unknown>;
-  nodeMessageBufferMaxLength?: number;
-  functionTimeout?: number;
-  externalModules?: {
-    autoInstall?: boolean;
-    autoInstallRetry?: number;
-    palette?: {
-      allowInstall?: boolean;
-      allowUpdate?: boolean;
-      allowUpload?: boolean;
-      allowList?: string[];
-      denyList?: string[];
-      allowUpdateList?: string[];
-      denyUpdateList?: string[];
-    };
-    modules?: {
-      allowInstall?: boolean;
-      allowList?: string[];
-      denyList?: string[];
-    };
-  };
-  execMaxBufferSize?: number;
-  debugMaxLength?: number;
-  debugUseColors?: boolean;
-  httpRequestTimeout?: number;
-  mqttReconnectTime?: number;
-  serialReconnectTime?: number;
-  socketReconnectTime?: number;
-  socketTimeout?: number;
-  tcpMsgQueueSize?: number;
-  inboundWebSocketTimeout?: number;
-  tlsConfigDisableLocalFiles?: boolean;
-  webSocketNodeVerifyClient?: (info: {
-    origin: string;
-    req: Http2ServerRequest;
-    secure: boolean;
-  }) => boolean;
-  apiMaxLength?: string;
-  [key: string]: unknown;
-}
-
 interface PackageJson {
   name: string;
   version: string;
@@ -362,7 +168,6 @@ export {
   LoggerOptions,
   NodeRedLauncherOptions,
   NodeRedPluginOptions,
-  NodeRedRuntimeSettings,
   PackageJson,
   ServerBuildOptions,
   ServerPluginOptions,

package/src/vite/utils.ts

@@ -1,6 +1,6 @@
 import fs from "fs";
 import path from "path";
-import type { NodeRedRuntimeSettings, PackageJson } from "./types";
+import type { PackageJson } from "./types";
 
 function cleanDir(dir: string) {
   if (fs.existsSync(dir)) {
@@ -69,35 +69,4 @@ function mergeOptions<T extends Record<string, unknown>>(
   return result;
 }
 
-/**
- * Define Node-RED runtime settings with full type support.
- *
- * Note: All paths should be absolute. Use `import.meta.dirname` or `__dirname` to resolve relative paths.
- *
- * @example
- * ```typescript
- * import { defineRuntimeSettings } from "./vite/utils";
- * import path from "path";
- *
- * const __dirname = import.meta.dirname;
- *
- * export default defineRuntimeSettings({
- *   userDir: path.resolve(__dirname, ".node-red"),
- *   flowFile: "flows.json",
- *   httpStatic: path.resolve(__dirname, "public"),
- * });
- * ```
- */
-function defineRuntimeSettings(
-  settings: NodeRedRuntimeSettings,
-): NodeRedRuntimeSettings {
-  return settings;
-}
-
-export {
-  cleanDir,
-  copyFiles,
-  defineRuntimeSettings,
-  getPackageName,
-  mergeOptions,
-};
+export { cleanDir, copyFiles, getPackageName, mergeOptions };