feat: support replugged store (#456)

* feat: support replugged store

* fix: install links support store

* fix: prod url

* Use API URL

* Update src/main/ipc/installer.ts

Co-authored-by: Alyxia Sother <[email protected]>

---------

Co-authored-by: Alyxia Sother <[email protected]>

Author: asportnoy

src/main/ipc/installer.ts

@@ -1,6 +1,5 @@
 import { ipcMain } from "electron";
 import {
-  AnyAddonManifest,
   CheckResultFailure,
   CheckResultSuccess,
   InstallResultFailure,
@@ -13,7 +12,8 @@ import { CONFIG_PATH, CONFIG_PATHS } from "../../util.mjs";
 import { readFile, writeFile } from "fs/promises";
 import fetch from "node-fetch";
 import { join } from "path";
-import { RepluggedManifest, anyAddon } from "src/types/addon";
+import { AnyAddonManifestOrReplugged, anyAddonOrReplugged } from "src/types/addon";
+import { readTransaction } from "./settings";
 
 const octokit = new Octokit();
 
@@ -59,33 +59,21 @@ async function github(
     (manifestAsset) => manifestAsset.name === asset.name.replace(/\.asar$/, ".json"),
   );
 
-  if (!manifestAsset && identifier !== "replugged-org/replugged") {
+  if (!manifestAsset) {
     return {
       success: false,
       error: "No manifest asset found",
     };
   }
 
-  let manifest: AnyAddonManifest | RepluggedManifest;
-  if (manifestAsset) {
-    try {
-      const json = await fetch(manifestAsset.browser_download_url).then((res) => res.json());
-      manifest = anyAddon.parse(json);
-    } catch {
-      return {
-        success: false,
-        error: "Failed to parse manifest",
-      };
-    }
-  } else {
-    // For Replugged itself
-    manifest = {
-      version: res.data.tag_name.replace(/^v/, ""),
-      updater: {
-        id: identifier,
-        type: "github",
-      },
-      type: "replugged",
+  let manifest: AnyAddonManifestOrReplugged;
+  try {
+    const json = await fetch(manifestAsset.browser_download_url).then((res) => res.json());
+    manifest = anyAddonOrReplugged.parse(json);
+  } catch {
+    return {
+      success: false,
+      error: "Failed to parse manifest",
     };
   }
 
@@ -98,11 +86,47 @@ async function github(
   };
 }
 
+async function store(id: string): Promise<CheckResultSuccess | CheckResultFailure> {
+  const apiUrl =
+    ((await readTransaction("dev.replugged.Settings", (settings) => settings.get("apiUrl"))) as
+      | string
+      | undefined) ?? "https://replugged.dev";
+  const STORE_BASE_URL = `${apiUrl}/api/v1/store`;
+  const manifestUrl = `${STORE_BASE_URL}/${id}`;
+  const asarUrl = `${manifestUrl}.asar`;
+
+  const res = await fetch(manifestUrl);
+  if (!res.ok) {
+    return {
+      success: false,
+      error: "Failed to fetch manifest",
+    };
+  }
+
+  let manifest;
+  try {
+    manifest = anyAddonOrReplugged.parse(await res.json());
+  } catch {
+    return {
+      success: false,
+      error: "Failed to parse manifest",
+    };
+  }
+
+  return {
+    success: true,
+    manifest,
+    name: `${id}.asar`,
+    url: asarUrl,
+  };
+}
+
 const handlers: Record<
   string,
   (identifier: string, id?: string) => Promise<CheckResultSuccess | CheckResultFailure>
 > = {
   github,
+  store,
 };
 
 ipcMain.handle(

src/main/ipc/settings.ts

@@ -39,7 +39,7 @@ async function transaction<T>(namespace: string, handler: TransactionHandler<T>)
   return result;
 }
 
-async function readTransaction<T>(
+export async function readTransaction<T>(
   namespace: string,
   handler: SettingsTransactionHandler<T>,
 ): Promise<T> {
@@ -49,7 +49,7 @@ async function readTransaction<T>(
   });
 }
 
-async function writeTransaction<T>(
+export async function writeTransaction<T>(
   namespace: string,
   handler: SettingsTransactionHandler<T>,
 ): Promise<T> {

src/preload.ts

@@ -44,10 +44,10 @@ const RepluggedNative = {
   updater: {
     check: async (
       type: string,
-      repo: string,
+      identifier: string,
       id: string,
     ): Promise<CheckResultSuccess | CheckResultFailure> =>
-      ipcRenderer.invoke(RepluggedIpcChannels.GET_ADDON_INFO, type, repo, id),
+      ipcRenderer.invoke(RepluggedIpcChannels.GET_ADDON_INFO, type, identifier, id),
     install: async (
       type: InstallerType | "replugged",
       path: string,

src/renderer/coremods/installer/util.ts

@@ -28,13 +28,6 @@ export async function getInfo(
   id?: string,
 ): Promise<CheckResultSuccess | null> {
   source ??= INSTALLER_SOURCES[0];
-  // TODO: remove this once store is supported
-  // Need to make sure GitHub install links will have the type specified
-  // so they won't break once store is available (since that will be the default)
-  if (source === "store") {
-    logger.error('Store installers are not supported yet. Please specify "github" as the type.');
-    return null;
-  }
 
   const cacheIdentifier = `${source}:${identifier}:${id ?? ""}`;
   const cached = cache.get(cacheIdentifier);

src/renderer/managers/updater.ts

@@ -3,7 +3,7 @@ import * as pluginManager from "./plugins";
 import * as themeManager from "./themes";
 import { Logger } from "../modules/logger";
 import type { RepluggedPlugin, RepluggedTheme } from "src/types";
-import type { RepluggedManifest } from "src/types/addon";
+import { RepluggedEntity } from "src/types/addon";
 
 const logger = Logger.coremod("Updater");
 
@@ -16,10 +16,27 @@ export type UpdateSettings = {
   lastChecked: number;
 };
 
-interface RepluggedEntity {
-  manifest: RepluggedManifest;
-  path: string;
-}
+const REPLUGGED_ID = "dev.replugged.Replugged";
+const REPLUGGED_ENTITY: RepluggedEntity = {
+  manifest: {
+    id: REPLUGGED_ID,
+    name: "Replugged",
+    description: "Replugged itself",
+    author: {
+      name: "replugged",
+      discordID: "1000992611840049192",
+      github: "replugged-org",
+    },
+    type: "replugged",
+    updater: {
+      type: "store",
+      id: REPLUGGED_ID,
+    },
+    version: window.RepluggedNative.getVersion(),
+    license: "MIT",
+  },
+  path: "replugged.asar",
+};
 
 // eslint-disable-next-line @typescript-eslint/consistent-type-definitions
 type MainUpdaterSettings = {
@@ -28,8 +45,6 @@ type MainUpdaterSettings = {
   lastChecked?: number;
 };
 
-const REPLUGGED_ID = "dev.replugged.Replugged";
-
 const mainUpdaterDefaultSettings: Partial<MainUpdaterSettings> = {
   checkInterval: 1000 * 60 * 60,
 };
@@ -78,17 +93,7 @@ async function getAddonFromManager(
   if (id === REPLUGGED_ID) {
     const version = window.RepluggedNative.getVersion();
     if (version === "dev") return undefined;
-    return {
-      manifest: {
-        version,
-        updater: {
-          type: "github",
-          id: "replugged-org/replugged",
-        },
-        type: "replugged",
-      },
-      path: "replugged.asar",
-    };
+    return REPLUGGED_ENTITY;
   }
 
   return pluginManager.plugins.get(id) || (await themeManager.get(id));

src/types/addon.ts

@@ -26,7 +26,7 @@ export const common = z.object({
   version: z.string(),
   updater: z
     .object({
-      type: z.literal("github"),
+      type: z.enum(["store", "github"]),
       id: z.string(),
     })
     .optional(),
@@ -35,6 +35,17 @@ export const common = z.object({
 
 export type Common = z.infer<typeof common>;
 
+export const repluggedManifest = common.extend({
+  type: z.literal("replugged"),
+});
+
+export type RepluggedManifest = z.infer<typeof repluggedManifest>;
+
+export interface RepluggedEntity {
+  manifest: RepluggedManifest;
+  path: string;
+}
+
 export const theme = common.extend({
   type: z.literal("replugged-theme"),
   main: z.string(),
@@ -56,14 +67,9 @@ export const anyAddon = z.discriminatedUnion("type", [theme, plugin]);
 
 export type AnyAddonManifest = z.infer<typeof anyAddon>;
 
-export interface RepluggedManifest {
-  version: string;
-  updater: {
-    id: string;
-    type: "github";
-  };
-  type: "replugged";
-}
+export const anyAddonOrReplugged = z.discriminatedUnion("type", [repluggedManifest, theme, plugin]);
+
+export type AnyAddonManifestOrReplugged = z.infer<typeof anyAddonOrReplugged>;
 
 export interface PluginExports {
   start?: () => Promisable<void>;

src/types/installer.ts

@@ -7,7 +7,7 @@ export interface CheckResultSuccess {
   manifest: AnyAddonManifest | RepluggedManifest;
   name: string;
   url: string;
-  webUrl: string;
+  webUrl?: string;
 }
 
 export interface CheckResultFailure {