@cordy/electro 1.1.3 → 1.2.0

package/dist/index.d.mts

@@ -1,4 +1,4 @@
-import { BaseWindow, BaseWindowConstructorOptions, WebContentsView, WebPreferences } from "electron";
+import { BaseWindow, BaseWindowConstructorOptions, WebContentsView } from "electron";
 import { UserConfig } from "vite";
 
 //#region src/core/feature/enums.d.ts
@@ -18,25 +18,18 @@ declare enum FeatureStatus {
 //#endregion
 //#region src/core/view/types.d.ts
 type ViewId = string;
-/** Config for renderer-linked views (built by Vite). */
-interface RendererViewConfig {
+/** Runtime view registry entry — injected by CLI via __ELECTRO_VIEW_REGISTRY__. */
+interface ViewRegistryEntry {
   id: ViewId;
-  /** Link to a defineView() name. `true` = use `id` as the renderer name. */
-  renderer: true | string;
-  webPreferences?: WebPreferences;
-}
-/** Config for dynamic views (no renderer entry, programmatic). */
-interface DynamicViewConfig {
-  id: ViewId;
-  webPreferences?: WebPreferences;
+  hasRenderer: boolean;
+  webPreferences?: Record<string, unknown>;
 }
-type ViewConfig = RendererViewConfig | DynamicViewConfig;
 /** A WebContentsView augmented with `load()` for renderer-linked views. */
 type ElectroView = WebContentsView & {
   load(): Promise<void>;
 };
 /** Public interface — hides the View class. */
-interface CreatedView {
+interface ViewInstance {
   readonly id: ViewId;
   /** Create the WebContentsView. Idempotent: returns existing if alive. */
   create(): ElectroView;
@@ -45,13 +38,6 @@ interface CreatedView {
   /** Destroy the WebContentsView and clear refs. */
   destroy(): void;
 }
-/** Type-erased interface for managers. */
-interface ViewInstance {
-  readonly id: ViewId;
-  create(): ElectroView;
-  view(): ElectroView | null;
-  destroy(): void;
-}
 //#endregion
 //#region src/core/view/manager.d.ts
 /**
@@ -74,24 +60,28 @@ interface WindowConfig<TApi = void> {
   options?: BaseWindowConstructorOptions;
   api?: (window: BaseWindow) => TApi;
 }
-/** Public interface — hides the Window class. */
-interface CreatedWindow<TApi = void> {
+/** Base window interface (without API methods). */
+interface WindowBase {
   readonly id: WindowId;
   /** Create the BaseWindow. Idempotent: returns existing if alive. */
   create(): BaseWindow;
   /** The live BaseWindow, or null if not yet created / destroyed. */
   readonly window: BaseWindow | null;
-  /** The typed API, or null if not yet created / destroyed. */
-  readonly api: TApi | null;
   /** Destroy the BaseWindow and clear refs. */
   destroy(): void;
 }
+/**
+* Public interface — API methods are mixed directly onto the object.
+* Access API methods directly: `window.show()` instead of `window.api?.show()`.
+*/
+type CreatedWindow<TApi = void> = WindowBase & (TApi extends void ? {} : TApi) & {
+  /** @internal Phantom type for API type inference. */readonly __apiType?: TApi;
+};
 /** Type-erased interface for managers. */
 interface WindowInstance {
   readonly id: WindowId;
   create(): BaseWindow;
   readonly window: BaseWindow | null;
-  readonly api: unknown;
   destroy(): void;
 }
 //#endregion
@@ -631,7 +621,7 @@ interface RuntimeDefinition {
 interface ViewDefinition {
   readonly [VIEW_BRAND]: true;
   readonly name: string;
-  readonly entry: string;
+  readonly entry?: string;
   readonly features?: readonly string[];
   readonly vite?: UserConfig;
   readonly preload?: string;
@@ -652,7 +642,7 @@ interface DefineRuntimeInput {
 type SuggestFeatureId = (keyof FeatureMap & string) | (string & {});
 interface DefineViewInput {
   name: string;
-  entry: string;
+  entry?: string;
   features?: readonly SuggestFeatureId[];
   vite?: UserConfig;
   preload?: string;
@@ -743,7 +733,6 @@ declare class Logger implements LoggerContext {
 type RuntimeConfig = {
   features?: FeatureConfig<any>[];
   windows?: WindowInstance[];
-  views?: ViewInstance[];
   logger?: {
     handlers?: LogHandler[];
   };
@@ -793,16 +782,6 @@ declare function createTask<TId extends TaskId, TPayload = void>(config: TaskCon
 */
 declare function createWindow<TApi = void>(config: WindowConfig<TApi>): CreatedWindow<TApi>;
 //#endregion
-//#region src/core/view/helpers.d.ts
-/**
-* Creates a {@link View} instance from a configuration object.
-*
-* @param config - View configuration with `id`, and either `renderer` (for Vite-built views) or `webPreferences` (for dynamic views).
-* @returns A new `View` instance ready for registration.
-* @throws If `config.id` is empty.
-*/
-declare function createView(config: ViewConfig): CreatedView;
-//#endregion
 //#region src/policy/types.d.ts
 /** Outcome of a policy check. */
 declare enum PolicyDecision {
@@ -841,4 +820,4 @@ declare class PolicyEngine {
   getViewNames(): string[];
 }
 //#endregion
-export { type BaseContext, type CreatedEvent, type CreatedService, type CreatedTask, type CreatedView, type CreatedWindow, type DefineConfigInput, type DefineRuntimeInput, type DefineViewInput, type ElectroConfig, type ElectroView, EventAccessor, type EventHandler, type EventId, type EventInstance, type EventSubscription, type FeatureConfig, type FeatureContext, type FeatureHandle, type FeatureId, type FeatureMap, FeatureStatus, type LogEntry, type LogHandler, type LoggerContext, PolicyDecision, PolicyEngine, type PolicyResult, Runtime, type RuntimeConfig, type RuntimeDefinition, RuntimeState, type ServiceConfig, type ServiceId, type ServiceInfo, type ServiceOwnerMap, ServiceScope, ServiceStatus, type StopMode, type TaskConfig, type TaskExecutionContext, type TaskHandle, type TaskId, TaskOverlapStrategy, type TaskOwnerMap, TaskRetryStrategy, TaskStatus, type TaskStatusInfo, type TypedContext, type ViewConfig, type ViewDefinition, type ViewId, type ViewInstance, type ViewMap, type WindowApiMap, type WindowConfig, type WindowId, type WindowInstance, createEvent, createFeature, createRuntime, createService, createTask, createView, createWindow, defineConfig, defineRuntime, defineView };
+export { type BaseContext, type CreatedEvent, type CreatedService, type CreatedTask, type CreatedWindow, type DefineConfigInput, type DefineRuntimeInput, type DefineViewInput, type ElectroConfig, type ElectroView, EventAccessor, type EventHandler, type EventId, type EventInstance, type EventSubscription, type FeatureConfig, type FeatureContext, type FeatureHandle, type FeatureId, type FeatureMap, FeatureStatus, type LogEntry, type LogHandler, type LoggerContext, PolicyDecision, PolicyEngine, type PolicyResult, Runtime, type RuntimeConfig, type RuntimeDefinition, RuntimeState, type ServiceConfig, type ServiceId, type ServiceInfo, type ServiceOwnerMap, ServiceScope, ServiceStatus, type StopMode, type TaskConfig, type TaskExecutionContext, type TaskHandle, type TaskId, TaskOverlapStrategy, type TaskOwnerMap, TaskRetryStrategy, TaskStatus, type TaskStatusInfo, type TypedContext, type ViewDefinition, type ViewId, type ViewInstance, type ViewMap, type ViewRegistryEntry, type WindowApiMap, type WindowConfig, type WindowId, type WindowInstance, createEvent, createFeature, createRuntime, createService, createTask, createWindow, defineConfig, defineRuntime, defineView };

package/dist/index.mjs

@@ -1,6 +1,6 @@
 import { createRequire } from "node:module";
-import { Cron } from "croner";
 import { join } from "node:path";
+import { Cron } from "croner";
 
 //#region \0rolldown/runtime.js
 var __require = /* @__PURE__ */ createRequire(import.meta.url);
@@ -58,7 +58,6 @@ const VIEW_NAME_PATTERN = /^[a-zA-Z0-9][a-zA-Z0-9_-]*$/;
 function defineView(input) {
 	if (!input.name || input.name.trim().length === 0) throw new Error("[electro] defineView: name must be a non-empty string");
 	if (!VIEW_NAME_PATTERN.test(input.name)) throw new Error(`[electro] defineView: name "${input.name}" is invalid. Must match ${VIEW_NAME_PATTERN.toString()}`);
-	if (!input.entry || input.entry.trim().length === 0) throw new Error("[electro] defineView: entry must be a non-empty string");
 	return {
 		name: input.name,
 		entry: input.entry,
@@ -900,6 +899,55 @@ var ViewManager = class {
 	}
 };
 
+//#endregion
+//#region src/core/view/view.ts
+/**
+* View — manages a single WebContentsView instance.
+*
+* `create()` is idempotent: calling it while an alive view exists returns
+* the existing instance. After the view is destroyed, calling `create()`
+* spawns a fresh one.
+*
+* For renderer-linked views, `load()` resolves the dev URL or production
+* file path automatically.
+*/
+var View = class {
+	_view = null;
+	constructor(entry) {
+		this.entry = entry;
+	}
+	get id() {
+		return this.entry.id;
+	}
+	create() {
+		if (this._view && !this._view.webContents.isDestroyed()) return this._view;
+		const { WebContentsView: WCV } = __require("electron");
+		const view = new WCV({ webPreferences: { ...this.entry.webPreferences ?? {} } });
+		if (this.entry.hasRenderer) {
+			const viewId = this.entry.id;
+			view.load = async () => {
+				const devUrl = process.env[`ELECTRO_DEV_URL_${viewId}`];
+				if (devUrl) {
+					await view.webContents.loadURL(devUrl);
+					return;
+				}
+				const { app } = await import("electron");
+				await view.webContents.loadFile(join(app.getAppPath(), ".electro", "out", "renderer", viewId, "index.html"));
+			};
+		} else view.load = async () => {};
+		this._view = view;
+		return view;
+	}
+	view() {
+		if (this._view?.webContents.isDestroyed()) this._view = null;
+		return this._view;
+	}
+	destroy() {
+		if (this._view && !this._view.webContents.isDestroyed()) this._view.webContents.close();
+		this._view = null;
+	}
+};
+
 //#endregion
 //#region src/core/window/manager.ts
 /**
@@ -952,7 +1000,8 @@ var Runtime = class {
 		this.windowManager = new WindowManager();
 		for (const win of config?.windows ?? []) this.windowManager.register(win);
 		this.viewManager = new ViewManager();
-		for (const view of config?.views ?? []) this.viewManager.register(view);
+		const viewRegistry = typeof __ELECTRO_VIEW_REGISTRY__ !== "undefined" ? __ELECTRO_VIEW_REGISTRY__ : [];
+		for (const entry of viewRegistry) this.viewManager.register(new View(entry));
 		this.featureManager.setWindowManager(this.windowManager);
 		this.featureManager.setViewManager(this.viewManager);
 		if (config?.features) this.featureManager.register(config.features);
@@ -1451,10 +1500,13 @@ function createTask(config) {
 * `create()` is idempotent: calling it while an alive window exists returns
 * the existing instance. After the window is destroyed (user close, etc.),
 * calling `create()` again spawns a fresh one.
+*
+* API methods from `config.api()` are mixed directly onto the instance
+* via Object.assign, so callers can do `window.show()` instead of `window.api?.show()`.
 */
 var Window = class {
 	_window = null;
-	_api = null;
+	_apiKeys = null;
 	constructor(config) {
 		this.config = config;
 	}
@@ -1468,27 +1520,30 @@ var Window = class {
 			show: false,
 			...this.config.options ?? {}
 		});
-		if (this.config.api) this._api = this.config.api(this._window);
+		if (this.config.api) {
+			const api = this.config.api(this._window);
+			this._apiKeys = Object.keys(api);
+			Object.assign(this, api);
+		}
 		return this._window;
 	}
 	get window() {
 		if (this._window?.isDestroyed()) {
 			this._window = null;
-			this._api = null;
+			this.clearApi();
 		}
 		return this._window;
 	}
-	get api() {
-		if (this._window?.isDestroyed()) {
-			this._window = null;
-			this._api = null;
-		}
-		return this._api;
-	}
 	destroy() {
 		if (this._window && !this._window.isDestroyed()) this._window.destroy();
 		this._window = null;
-		this._api = null;
+		this.clearApi();
+	}
+	clearApi() {
+		if (this._apiKeys) {
+			for (const key of this._apiKeys) delete this[key];
+			this._apiKeys = null;
+		}
 	}
 };
 
@@ -1506,75 +1561,6 @@ function createWindow(config) {
 	return new Window(config);
 }
 
-//#endregion
-//#region src/core/view/view.ts
-function isRendererConfig(config) {
-	return "renderer" in config;
-}
-function resolveRendererName(config) {
-	return config.renderer === true ? config.id : config.renderer;
-}
-/**
-* View — manages a single WebContentsView instance.
-*
-* `create()` is idempotent: calling it while an alive view exists returns
-* the existing instance. After the view is destroyed, calling `create()`
-* spawns a fresh one.
-*
-* For renderer-linked views, `load()` resolves the dev URL or production
-* file path automatically.
-*/
-var View = class {
-	_view = null;
-	constructor(config) {
-		this.config = config;
-	}
-	get id() {
-		return this.config.id;
-	}
-	create() {
-		if (this._view && !this._view.webContents.isDestroyed()) return this._view;
-		const { WebContentsView: WCV } = __require("electron");
-		const view = new WCV({ webPreferences: { ...this.config.webPreferences ?? {} } });
-		if (isRendererConfig(this.config)) {
-			const rendererName = resolveRendererName(this.config);
-			view.load = async () => {
-				const devUrl = process.env[`ELECTRO_DEV_URL_${rendererName}`];
-				if (devUrl) {
-					await view.webContents.loadURL(devUrl);
-					return;
-				}
-				const { app } = await import("electron");
-				await view.webContents.loadFile(join(app.getAppPath(), ".electro", "out", "renderer", rendererName, "index.html"));
-			};
-		} else view.load = async () => {};
-		this._view = view;
-		return view;
-	}
-	view() {
-		if (this._view?.webContents.isDestroyed()) this._view = null;
-		return this._view;
-	}
-	destroy() {
-		if (this._view && !this._view.webContents.isDestroyed()) this._view.webContents.close();
-		this._view = null;
-	}
-};
-
-//#endregion
-//#region src/core/view/helpers.ts
-/**
-* Creates a {@link View} instance from a configuration object.
-*
-* @param config - View configuration with `id`, and either `renderer` (for Vite-built views) or `webPreferences` (for dynamic views).
-* @returns A new `View` instance ready for registration.
-* @throws If `config.id` is empty.
-*/
-function createView(config) {
-	if (!config.id) throw new Error("View must have an id");
-	return new View(config);
-}
-
 //#endregion
 //#region src/policy/types.ts
 /** Outcome of a policy check. */
@@ -1633,4 +1619,4 @@ var PolicyEngine = class {
 };
 
 //#endregion
-export { EventAccessor, FeatureStatus, PolicyDecision, PolicyEngine, Runtime, RuntimeState, ServiceScope, ServiceStatus, TaskOverlapStrategy, TaskRetryStrategy, TaskStatus, createEvent, createFeature, createRuntime, createService, createTask, createView, createWindow, defineConfig, defineRuntime, defineView };
+export { EventAccessor, FeatureStatus, PolicyDecision, PolicyEngine, Runtime, RuntimeState, ServiceScope, ServiceStatus, TaskOverlapStrategy, TaskRetryStrategy, TaskStatus, createEvent, createFeature, createRuntime, createService, createTask, createWindow, defineConfig, defineRuntime, defineView };

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@cordy/electro",
-    "version": "1.1.3",
+    "version": "1.2.0",
     "description": "Electron framework — feature-first runtime, codegen, and Vite-based build system",
     "license": "MIT",
     "type": "module",