change default versionjson path, modify LocalDevProvider

Author: subframe7536

README.md

@@ -352,7 +352,10 @@ updater.provider = new GitHubProvider({
 })
 ```
 
-Or use built-in `LocalDevProvider`
+Or use built-in `LocalDevProvider`:
+
+- download update json from `{baseDir}/{versionPath}`
+- download update asar from `{baseDir}/{name}-{version}.asar.gz`
 
 ```ts
 const provider = new LocalDevProvider({

src/entry/updater.ts

@@ -2,12 +2,7 @@ import { app } from 'electron'
 import { EventEmitter } from 'node:events'
 import fs from 'node:fs'
 
-import type {
-  DownloadingInfo,
-  IProvider,
-  UpdateInfoWithURL,
-  UpdateJSONWithURL,
-} from '../provider/types'
+import type { DownloadingInfo, IProvider, UpdateInfoWithURL, VersionJSON } from '../provider/types'
 import type {
   Logger,
   UpdateInfoWithExtraVersion,
@@ -92,10 +87,7 @@ export class Updater<
    * if data is absent, download URL from provider and return it,
    * else if data is `UpdateJSON`, return it
    */
-  private async fetch(
-    format: 'json',
-    data?: UpdateJSONWithURL,
-  ): Promise<UpdateJSONWithURL | undefined>
+  private async fetch(format: 'json', data?: VersionJSON): Promise<VersionJSON | undefined>
   /**
    * This function is used to parse download data.
    *
@@ -105,7 +97,7 @@ export class Updater<
    * @param data download URL or update json or buffer
    */
   private async fetch(format: 'buffer', data?: Buffer): Promise<Buffer | undefined>
-  private async fetch(format: 'json' | 'buffer', data?: Buffer | UpdateJSONWithURL): Promise<any> {
+  private async fetch(format: 'json' | 'buffer', data?: Buffer | VersionJSON): Promise<any> {
     if (typeof data === 'object') {
       if (
         (format === 'json' && isUpdateJSON(data)) ||

src/provider/base.ts

@@ -1,4 +1,4 @@
-import type { DownloadingInfo, IProvider, UpdateInfoWithURL, UpdateJSONWithURL } from './types'
+import type { DownloadingInfo, IProvider, UpdateInfoWithURL, VersionJSON } from './types'
 
 import { defaultVerifySignature } from '../utils/crypto'
 import { defaultIsLowerVersion } from '../utils/version'
@@ -26,7 +26,7 @@ export abstract class BaseProvider implements IProvider {
     name: string,
     versionPath: string,
     signal: AbortSignal,
-  ): Promise<UpdateJSONWithURL>
+  ): Promise<VersionJSON>
 
   /**
    * @inheritdoc

src/provider/github/base.ts

@@ -2,7 +2,7 @@ import type { Promisable } from '@subframe7536/type-utils'
 
 import { URL } from 'node:url'
 
-import type { DownloadingInfo, UpdateInfoWithURL, UpdateJSONWithURL, URLHandler } from '../types'
+import type { DownloadingInfo, UpdateInfoWithURL, VersionJSON, URLHandler } from '../types'
 
 import { defaultDownloadAsar, defaultDownloadUpdateJSON } from '../../utils/download'
 import { BaseProvider } from '../base'
@@ -63,7 +63,7 @@ export abstract class BaseGitHubProvider<
     name: string,
     versionPath: string,
     signal: AbortSignal,
-  ): Promise<UpdateJSONWithURL> {
+  ): Promise<VersionJSON> {
     const { beta, version, ...info } = await defaultDownloadUpdateJSON(
       await this.parseURL(await this.getVersionURL(versionPath, signal)),
       this.getHeaders('json'),

src/provider/local.ts

@@ -3,7 +3,7 @@ import type { Buffer } from 'node:buffer'
 import fs from 'node:fs/promises'
 import path from 'node:path'
 
-import type { DownloadingInfo, UpdateInfoWithURL, UpdateJSONWithURL } from './types'
+import type { DownloadingInfo, UpdateInfoWithURL, VersionJSON } from './types'
 
 import { isUpdateJSON } from '../utils'
 import { BaseProvider } from './base'
@@ -13,17 +13,12 @@ export interface LocalDevProviderOptions {
    * Base directory for update files
    */
   baseDir: string
-  /**
-   * App name (used for constructing file paths)
-   */
-  appName?: string
 }
 
 /**
  * Update Provider for local development
- * - check update from local file system
- * - download update json and get version and download url
- * - download update asar from local file system
+ * - download update json from `{baseDir}/{versionPath}`
+ * - download update asar from `{baseDir}/{name}-{version}.asar.gz`
  *
  * This provider is useful for testing updates during development without
  * needing to deploy to a remote server.
@@ -43,14 +38,15 @@ export class LocalDevProvider extends BaseProvider {
     name: string,
     versionPath: string,
     signal: AbortSignal,
-  ): Promise<UpdateJSONWithURL> {
+  ): Promise<VersionJSON> {
     signal.throwIfAborted()
 
-    const { beta, version, ...info } = await this.readJSON(versionPath)
+    const { beta, version, ...info } = await this.readJSON(
+      path.join(this.options.baseDir, versionPath),
+    )
 
-    const getAppName = this.options.appName || name
     const getURL = (ver: string): string =>
-      path.join(this.options.baseDir, `${getAppName}-${ver}.asar.gz`)
+      path.join(this.options.baseDir, `${name}-${ver}.asar.gz`)
 
     return {
       ...info,

src/provider/types.ts

@@ -31,7 +31,7 @@ export interface DownloadingInfo {
   bps: number
 }
 
-export type UpdateJSONWithURL = UpdateInfoWithURL & { beta: UpdateInfoWithURL }
+export type VersionJSON = UpdateInfoWithURL & { beta: UpdateInfoWithURL }
 
 export interface IProvider {
   /**
@@ -44,11 +44,7 @@ export interface IProvider {
    * @param versionPath normalized version path in project
    * @param signal abort signal
    */
-  downloadJSON: (
-    name: string,
-    versionPath: string,
-    signal: AbortSignal,
-  ) => Promise<UpdateJSONWithURL>
+  downloadJSON: (name: string, versionPath: string, signal: AbortSignal) => Promise<VersionJSON>
   /**
    * Download update asar buffer
    * @param updateInfo existing update info

src/vite/option.ts

@@ -348,7 +348,7 @@ export async function parseUpdaterOption(
       entryOutDir = 'dist-entry',
       electronDistPath = 'dist-electron',
       rendererDistPath = 'dist',
-      versionPath = 'version.json',
+      versionPath = 'release/version.json',
     } = {},
     keys: {
       privateKeyPath = 'keys/private.pem',