@electrojs/config 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Anton Ryuben
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,119 @@
+# @electrojs/config
+
+Typed configuration contracts for Electro applications.
+
+Electro supports a monorepo-style application layout with:
+
+- one root `electro.config.ts`
+- one `runtime/` package with `runtime.config.ts`
+- one package per renderer view with `view.config.ts`
+
+## Installation
+
+```bash
+pnpm add -D @electrojs/config vite typescript
+```
+
+## Exports
+
+```ts
+import { defineElectroConfig, defineRuntimeConfig, defineViewConfig } from "@electrojs/config";
+
+import type { AppConfig, RuntimeConfig, ViewConfig } from "@electrojs/config";
+```
+
+## `electro.config.ts`
+
+```ts
+import { defineElectroConfig } from "@electrojs/config";
+
+export default defineElectroConfig({
+    runtime: "runtime",
+    views: ["@views/main", "@views/settings"],
+});
+```
+
+`AppConfig`:
+
+```ts
+interface AppConfig {
+    readonly runtime: string;
+    readonly views: readonly string[];
+}
+```
+
+- `runtime` is the package specifier for the runtime package
+- `views` is the explicit list of renderer view package specifiers
+
+Electro no longer documents single-repo auto-discovery as a supported setup.
+
+## `runtime.config.ts`
+
+```ts
+import { defineRuntimeConfig } from "@electrojs/config";
+
+export default defineRuntimeConfig({
+    entry: "./src/main.ts",
+});
+```
+
+`RuntimeConfig` extends Vite user config and adds:
+
+```ts
+interface RuntimeConfig extends ViteUserConfig {
+    readonly entry: string;
+}
+```
+
+- `entry` points at the Electron main-process entry file inside the runtime package
+
+## `view.config.ts`
+
+```ts
+import { defineViewConfig } from "@electrojs/config";
+import react from "@vitejs/plugin-react";
+
+export default defineViewConfig({
+    viewId: "main",
+    entry: "./index.html",
+    plugins: [react()],
+});
+```
+
+`ViewConfig` extends Vite user config and adds:
+
+```ts
+interface ViewConfig extends ViteUserConfig {
+    readonly viewId: string;
+    readonly entry?: string;
+    readonly preload?: string;
+}
+```
+
+- `viewId` is the bundled renderer id used by runtime `@View({ source: "view:<id>" })`
+- `entry` defaults to `./index.html`
+- `preload` is optional because Electro usually generates preload entrypoints automatically
+
+## Layout
+
+```txt
+my-app/
+├── electro.config.ts
+├── pnpm-workspace.yaml
+├── package.json
+├── runtime/
+│   ├── runtime.config.ts
+│   └── src/main.ts
+└── views/
+    ├── main/
+    │   ├── view.config.ts
+    │   ├── index.html
+    │   └── src/main.tsx
+    └── settings/
+```
+
+## Related Packages
+
+- `@electrojs/cli` runs `dev`, `generate`, `build`, and `preview`
+- `@electrojs/runtime` powers the Electron runtime
+- `@electrojs/renderer` powers the renderer bridge and signals APIs

package/dist/index.d.mts

@@ -0,0 +1,164 @@
+import { UserConfig } from "vite";
+
+//#region src/app-config.d.ts
+/**
+ * Application-level configuration.
+ *
+ * Exported from `electro.config.ts` at the project root.
+ * Consumed by the Electro CLI for build, dev, preview, and code generation.
+ */
+interface AppConfig {
+  /**
+   * Workspace package name of the runtime package.
+   *
+   * @example "runtime"
+   */
+  readonly runtime: string;
+  /**
+   * Workspace package names of view packages.
+   *
+   * @example ["@views/main", "@views/settings"]
+   */
+  readonly views: readonly string[];
+}
+//#endregion
+//#region src/runtime-config.d.ts
+/**
+ * Runtime build configuration.
+ *
+ * Exported from `runtime.config.ts` inside the runtime package.
+ * Extends Vite's `UserConfig` (minus fields Electro manages) with
+ * the Electron main-process–specific `entry` field.
+ *
+ * Users have full access to: `resolve`, `plugins`, `define`,
+ * `esbuild`, `ssr`, `css`, `assetsInclude`, `worker`, etc.
+ *
+ * @example
+ * ```ts
+ * // runtime/runtime.config.ts
+ * import { defineRuntimeConfig } from "@electrojs/config";
+ * import { resolve } from "node:path";
+ *
+ * export default defineRuntimeConfig({
+ *     entry: "./src/main.ts",
+ *     resolve: {
+ *         alias: { "@": resolve(import.meta.dirname, "./") },
+ *     },
+ *     ssr: {
+ *         noExternal: ["better-sqlite3"],
+ *     },
+ * });
+ * ```
+ */
+interface RuntimeConfig extends UserConfig {
+  /**
+   * Entry point for the Electron main process.
+   * Relative to the runtime package root.
+   *
+   * @example "./src/main.ts"
+   */
+  readonly entry: string;
+}
+//#endregion
+//#region src/view-config.d.ts
+/**
+ * View build configuration.
+ *
+ * Exported from `view.config.ts` inside each view package.
+ * Extends Vite's `UserConfig` (minus fields Electro manages) with
+ * view-specific fields.
+ *
+ * Users have full access to: `resolve`, `plugins`, `define`,
+ * `esbuild`, `css`, `assetsInclude`, `optimizeDeps`, `worker`, etc.
+ *
+ * @example
+ * ```ts
+ * // renderer/views/main/view.config.ts
+ * import { defineViewConfig } from "@electrojs/config";
+ * import { resolve } from "node:path";
+ * import react from "@vitejs/plugin-react";
+ *
+ * export default defineViewConfig({
+ *     viewId: "main",
+ *     entry: "./index.html",
+ *     plugins: [react()],
+ *     resolve: {
+ *         alias: { "@": resolve(import.meta.dirname, "../../") },
+ *     },
+ * });
+ * ```
+ */
+interface ViewConfig extends UserConfig {
+  /**
+   * The unique identifier of this view.
+   * Must match the `id` of the corresponding runtime `@View` class
+   * (derived from `resource: "view:<id>"`).
+   *
+   * @example "main"
+   */
+  readonly viewId: string;
+  /**
+   * Path to the HTML entry file for this view.
+   * Relative to the view config file location.
+   *
+   * @example "./index.html"
+   */
+  readonly entry: string;
+}
+//#endregion
+//#region src/define-config.d.ts
+/**
+ * Defines an application-level configuration with full type safety.
+ *
+ * Use in `electro.config.ts` at the project root.
+ *
+ * @example
+ * ```ts
+ * // electro.config.ts
+ * import { defineElectroConfig } from "@electrojs/config";
+ *
+ * export default defineElectroConfig({
+ *     runtime: "runtime",
+ *     views: ["@views/main"],
+ * });
+ * ```
+ */
+declare function defineElectroConfig(config: AppConfig): AppConfig;
+/**
+ * Defines a runtime build configuration with full type safety.
+ *
+ * Use in `runtime.config.ts` inside the runtime package.
+ *
+ * @example
+ * ```ts
+ * // runtime/runtime.config.ts
+ * import { defineRuntimeConfig } from "@electrojs/config";
+ *
+ * export default defineRuntimeConfig({
+ *     entry: "./src/main.ts",
+ *     ssr: { noExternal: ["better-sqlite3"] },
+ * });
+ * ```
+ */
+declare function defineRuntimeConfig(config: RuntimeConfig): RuntimeConfig;
+/**
+ * Defines a view build configuration with full type safety.
+ *
+ * Use in `view.config.ts` inside each view package.
+ *
+ * @example
+ * ```ts
+ * // renderer/views/main/view.config.ts
+ * import { defineViewConfig } from "@electrojs/config";
+ * import react from "@vitejs/plugin-react";
+ *
+ * export default defineViewConfig({
+ *     viewId: "main",
+ *     entry: "./index.html",
+ *     plugins: [react()],
+ * });
+ * ```
+ */
+declare function defineViewConfig(config: ViewConfig): ViewConfig;
+//#endregion
+export { type AppConfig, type RuntimeConfig, type ViewConfig, defineElectroConfig, defineRuntimeConfig, defineViewConfig };

package/dist/index.mjs

@@ -0,0 +1 @@
+function e(e){return e}function t(e){return e}function n(e){return e}export{e as defineElectroConfig,t as defineRuntimeConfig,n as defineViewConfig};

package/package.json

@@ -0,0 +1,48 @@
+{
+  "name": "@electrojs/config",
+  "version": "1.0.0",
+  "description": "Shared configuration presets for Electro",
+  "keywords": [
+    "config",
+    "electro",
+    "tsconfig",
+    "typescript"
+  ],
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/MyraxByte/electrojs.git",
+    "directory": "packages/config"
+  },
+  "files": [
+    "tsconfig/*.json",
+    "dist",
+    "README.md"
+  ],
+  "type": "module",
+  "sideEffects": false,
+  "main": "./dist/index.mjs",
+  "types": "./dist/index.d.mts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.mts",
+      "import": "./dist/index.mjs"
+    },
+    "./tsconfig/base.json": "./tsconfig/base.json",
+    "./tsconfig/library.json": "./tsconfig/library.json"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "devDependencies": {
+    "publint": "^0.3.18",
+    "tsdown": "^0.21.4"
+  },
+  "peerDependencies": {
+    "typescript": ">=6.0.2",
+    "vite": ">=8"
+  },
+  "scripts": {
+    "build": "tsdown"
+  }
+}

package/tsconfig/base.json

@@ -0,0 +1,12 @@
+{
+    "$schema": "https://json.schemastore.org/tsconfig",
+    "compilerOptions": {
+        "noImplicitOverride": true,
+        "noUncheckedIndexedAccess": true,
+        "skipLibCheck": true,
+        "forceConsistentCasingInFileNames": true,
+        "emitDecoratorMetadata": true,
+        "experimentalDecorators": true
+    },
+    "exclude": ["node_modules", "dist"]
+}

package/tsconfig/library.json

@@ -0,0 +1,6 @@
+{
+    "$schema": "https://json.schemastore.org/tsconfig",
+    "extends": "./base.json",
+    "compilerOptions": {},
+    "exclude": ["node_modules", "dist"]
+}