electron-types 0.0.1

package/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) Electron contributors
+Copyright (c) 2024 electron-types contributors
+
+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,78 @@
+# electron-types
+
+TypeScript type definitions extracted from the [electron](https://www.electronjs.org/) package.
+
+## Why?
+
+The official `electron` package is ~200MB because it includes the Electron binary. If you only need TypeScript types (e.g., for type-checking code that will run in an Electron context), this package provides just the type definitions (~1MB).
+
+## Installation
+
+Since this package only provides TypeScript types, install it as a dev dependency:
+
+```bash
+npm install -D electron-types
+# or
+yarn add -D electron-types
+# or
+pnpm add -D electron-types
+```
+
+## Usage
+
+The types are available via the `Electron` namespace:
+
+```typescript
+// Types are available via the Electron namespace
+const win: Electron.BrowserWindow = /* ... */;
+const app: Electron.App = /* ... */;
+```
+
+For projects that need to reference the types in a `.d.ts` file:
+
+```typescript
+/// <reference types="electron-types" />
+
+declare const myWindow: Electron.BrowserWindow;
+```
+
+## Version Matching
+
+This package's version matches the electron version it was extracted from. For example, `electron-types@39.2.7` contains types from `electron@39.2.7`.
+
+## How It Works
+
+This package is automatically updated via CI:
+
+1. A scheduled GitHub Action checks for new electron releases every 6 hours
+2. When a new version is detected, it downloads the electron package
+3. Extracts the `electron.d.ts` type definitions
+4. Publishes to npm using [Trusted Publisher](https://docs.npmjs.com/generating-provenance-statements#publishing-packages-with-provenance-via-github-actions) (OIDC) with provenance attestation
+
+## Development
+
+```bash
+# Install dependencies
+yarn install
+
+# Extract types from latest electron
+yarn extract
+
+# Extract types from a specific version
+yarn extract 39.2.7
+
+# Build package for a specific version (extract + update version)
+yarn build 39.2.7
+
+# Test that types work correctly
+yarn test
+
+# Check if a new version needs to be published
+yarn check-versions
+```
+
+## License
+
+MIT - Same as Electron
+
+The type definitions are extracted from the Electron project, which is licensed under the MIT license.

package/package.json

@@ -0,0 +1,45 @@
+{
+  "name": "electron-types",
+  "version": "0.0.1",
+  "type": "module",
+  "description": "TypeScript type definitions extracted from the electron package",
+  "types": "./dist/electron.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "extract": "tsx scripts/extract-types.ts",
+    "build": "tsx scripts/build.ts",
+    "test": "vitest --typecheck.only --run",
+    "test:watch": "vitest --typecheck.only",
+    "check-versions": "tsx scripts/check-versions.ts"
+  },
+  "keywords": [
+    "electron",
+    "types",
+    "typescript",
+    "definitions"
+  ],
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/biw/electron-types.git"
+  },
+  "bugs": {
+    "url": "https://github.com/biw/electron-types/issues"
+  },
+  "homepage": "https://github.com/biw/electron-types#readme",
+  "dependencies": {
+    "@types/node": "^22.0.0"
+  },
+  "devDependencies": {
+    "expect-type": "^1.3.0",
+    "tsx": "^4.0.0",
+    "typescript": "^5.0.0",
+    "vitest": "^4.0.16"
+  },
+  "packageManager": "yarn@4.12.0",
+  "engines": {
+    "node": ">=18.0.0"
+  }
+}